| Geant4 Cross Reference |
1 //
2 // ********************************************************************
3 // * License and Disclaimer *
4 // * *
5 // * The Geant4 software is copyright of the Copyright Holders of *
6 // * the Geant4 Collaboration. It is provided under the terms and *
7 // * conditions of the Geant4 Software License, included in the file *
8 // * LICENSE and available at http://cern.ch/geant4/license . These *
9 // * include a list of copyright holders. *
10 // * *
11 // * Neither the authors of this software system, nor their employing *
12 // * institutes,nor the agencies providing financial support for this *
13 // * work make any representation or warranty, express or implied, *
14 // * regarding this software system or assume any liability for its *
15 // * use. Please see the license in the file LICENSE and URL above *
16 // * for the full disclaimer and the limitation of liability. *
17 // * *
18 // * This code implementation is the result of the scientific and *
19 // * technical work of the GEANT4 collaboration. *
20 // * By using, copying, modifying or distributing the software (or *
21 // * any work based on the software) you agree to acknowledge its *
22 // * use in resulting scientific publications, and indicate your *
23 // * acceptance of all terms of the Geant4 Software license. *
24 // ********************************************************************
25 //
26 // G4UIcommandTree
27 //
28 // Class description:
29 //
30 // This class is exclusively used by G4UImanager for handling the
31 // tree structure of the commands. The user MUST NOT construct/use
32 // this class object
33
34 // Author: Makoto Asai (SLAC), 1998
35 // --------------------------------------------------------------------
36 #ifndef G4UIcommandTree_hh
37 #define G4UIcommandTree_hh 1
38
39 #include "G4UIcommand.hh"
40 #include "globals.hh"
41
42 #include <vector>
43
44 class G4UIcommandTree
45 {
46 public:
47 G4UIcommandTree() = default;
48 G4UIcommandTree(const char* thePathName);
49
50 ~G4UIcommandTree();
51
52 G4bool operator==(const G4UIcommandTree& right) const;
53 G4bool operator!=(const G4UIcommandTree& right) const;
54
55 void AddNewCommand(G4UIcommand* newCommand, G4bool workerThreadOnly = false);
56 void RemoveCommand(G4UIcommand* aCommand, G4bool workerThreadOnly = false);
57 G4UIcommand* FindPath(const char* commandPath) const;
58 G4UIcommandTree* FindCommandTree(const char* commandPath);
59 G4String GetFirstMatchedString(const G4String&, const G4String&) const;
60
61 // Complete most available characters in common into command path in the
62 // command line given
63 G4String CompleteCommandPath(const G4String& commandPath);
64
65 void List() const;
66 void ListCurrent() const;
67 void ListCurrentWithNum() const;
68 void CreateHTML(const G4String& = "");
69
70 inline const G4UIcommand* GetGuidance() const { return guidance; }
71 inline const G4String& GetPathName() const { return pathName; }
72 inline G4int GetTreeEntry() const { return G4int(tree.size()); }
73 inline G4int GetCommandEntry() const { return G4int(command.size()); }
74 inline G4UIcommandTree* GetTree(G4int i) { return tree[i - 1]; }
75 G4UIcommandTree* GetTree(const char* comNameC);
76 inline G4UIcommand* GetCommand(G4int i) { return command[i - 1]; }
77 inline const G4String GetTitle() const
78 {
79 return (guidance == nullptr) ? G4String("...Title not available...") : guidance->GetTitle();
80 }
81
82 private:
83 G4String CreateFileName(const char* pName);
84 G4String ModStr(const char* strS);
85
86 private:
87 std::vector<G4UIcommand*> command;
88 std::vector<G4UIcommandTree*> tree;
89 G4UIcommand* guidance = nullptr;
90 G4String pathName;
91 G4bool broadcastCommands = true;
92 G4bool ifSort = false;
93 G4int createHTMLTreeLevel = 0;
94 };
95
96 #endif
97