| Geant4 Cross Reference |
1 // 1 //
2 // ******************************************* 2 // ********************************************************************
3 // * License and Disclaimer 3 // * License and Disclaimer *
4 // * 4 // * *
5 // * The Geant4 software is copyright of th 5 // * The Geant4 software is copyright of the Copyright Holders of *
6 // * the Geant4 Collaboration. It is provided 6 // * the Geant4 Collaboration. It is provided under the terms and *
7 // * conditions of the Geant4 Software License 7 // * conditions of the Geant4 Software License, included in the file *
8 // * LICENSE and available at http://cern.ch/ 8 // * LICENSE and available at http://cern.ch/geant4/license . These *
9 // * include a list of copyright holders. 9 // * include a list of copyright holders. *
10 // * 10 // * *
11 // * Neither the authors of this software syst 11 // * Neither the authors of this software system, nor their employing *
12 // * institutes,nor the agencies providing fin 12 // * institutes,nor the agencies providing financial support for this *
13 // * work make any representation or warran 13 // * work make any representation or warranty, express or implied, *
14 // * regarding this software system or assum 14 // * regarding this software system or assume any liability for its *
15 // * use. Please see the license in the file 15 // * use. Please see the license in the file LICENSE and URL above *
16 // * for the full disclaimer and the limitatio 16 // * for the full disclaimer and the limitation of liability. *
17 // * 17 // * *
18 // * This code implementation is the result 18 // * This code implementation is the result of the scientific and *
19 // * technical work of the GEANT4 collaboratio 19 // * technical work of the GEANT4 collaboration. *
20 // * By using, copying, modifying or distri 20 // * By using, copying, modifying or distributing the software (or *
21 // * any work based on the software) you ag 21 // * any work based on the software) you agree to acknowledge its *
22 // * use in resulting scientific publicati 22 // * use in resulting scientific publications, and indicate your *
23 // * acceptance of all terms of the Geant4 Sof 23 // * acceptance of all terms of the Geant4 Software license. *
24 // ******************************************* 24 // ********************************************************************
25 // 25 //
26 // G4UIcommand 26 // G4UIcommand
27 // <<
28 // Class description: <<
29 // <<
30 // This G4UIcommand is the "concrete" base cla <<
31 // used by Geant4 (G)UI. The user can use this <<
32 // arguments of a command are not suitable wit <<
33 // classes. <<
34 // Some methods defined in this base class are <<
35 27
36 // Author: Makoto Asai (SLAC), 1998 << 28 // Author: Makoto Asai (SLAC)
37 // ------------------------------------------- 29 // --------------------------------------------------------------------
38 #ifndef G4UIcommand_hh 30 #ifndef G4UIcommand_hh
39 #define G4UIcommand_hh 1 31 #define G4UIcommand_hh 1
40 32
41 #include "G4ApplicationState.hh" <<
42 #include "G4ThreeVector.hh" <<
43 #include "G4UIparameter.hh" 33 #include "G4UIparameter.hh"
>> 34 class G4UImessenger;
44 #include "globals.hh" 35 #include "globals.hh"
45 << 36 #include "G4ApplicationState.hh"
46 #include <vector> 37 #include <vector>
>> 38 #include "G4UItokenNum.hh"
>> 39 #include "G4ThreeVector.hh"
47 40
48 class G4UImessenger; << 41 // class description:
>> 42 //
>> 43 // This G4UIcommand is the "concrete" base class which represents a command
>> 44 // used by Geant4 (G)UI. The user can use this class in case the parameter
>> 45 // arguments of a command are not suitable with respect to the derived command
>> 46 // classes.
>> 47 // Some methods defined in this base class are used by the derived classes.
>> 48 //
49 49
50 class G4UIcommand 50 class G4UIcommand
51 { 51 {
52 public: 52 public:
53 // Dummy default constructor << 53 G4UIcommand();
54 G4UIcommand() = default; << 54 public: // with description
>> 55 G4UIcommand(const char * theCommandPath, G4UImessenger * theMessenger,
>> 56 G4bool tBB = true);
>> 57 // Constructor. The command string with full path directory
>> 58 // and the pointer to the messenger must be given.
>> 59 // If tBB is set to false, this command won't be sent to worker threads.
>> 60 // This tBB parameter could be changed with SetToBeBroadcasted() method
>> 61 // except for G4UIdirectory.
55 62
56 // Constructor. The command string with fu << 63 public:
57 // and the pointer to the messenger must b << 64 virtual ~G4UIcommand();
58 // If tBB is set to false, this command wo <<
59 // This tBB parameter could be changed wit <<
60 // except for G4UIdirectory <<
61 G4UIcommand(const char* theCommandPath, G4 <<
62 <<
63 virtual ~G4UIcommand(); <<
64 <<
65 G4bool operator==(const G4UIcommand& right <<
66 G4bool operator!=(const G4UIcommand& right <<
67 <<
68 virtual G4int DoIt(const G4String& paramet <<
69 <<
70 G4String GetCurrentValue(); <<
71 <<
72 // These methods define the states where t <<
73 // Once one of these commands is invoked, <<
74 // be denied when Geant4 is NOT in the ass <<
75 void AvailableForStates(G4ApplicationState <<
76 void AvailableForStates(G4ApplicationState <<
77 void AvailableForStates(G4ApplicationState <<
78 void AvailableForStates(G4ApplicationState <<
79 G4ApplicationState <<
80 void AvailableForStates(G4ApplicationState <<
81 G4ApplicationState <<
82 <<
83 G4bool IsAvailable(); <<
84 <<
85 virtual void List(); <<
86 <<
87 // Static methods for conversion from valu <<
88 // These methods are to be used by GetCurr <<
89 // of concrete messengers <<
90 static G4String ConvertToString(G4bool boo <<
91 static G4String ConvertToString(G4int intV <<
92 static G4String ConvertToString(G4long lon <<
93 static G4String ConvertToString(G4double d <<
94 static G4String ConvertToString(G4double d <<
95 static G4String ConvertToString(const G4Th <<
96 static G4String ConvertToString(const G4Th <<
97 <<
98 // Static methods for conversion from a st <<
99 // type. These methods are to be used dire <<
100 // of concrete messengers, or GetNewXXXVal <<
101 // this G4UIcommand class <<
102 static G4bool ConvertToBool(const char* st <<
103 static G4int ConvertToInt(const char* st); <<
104 static G4long ConvertToLongInt(const char* <<
105 static G4double ConvertToDouble(const char <<
106 static G4double ConvertToDimensionedDouble <<
107 static G4ThreeVector ConvertTo3Vector(cons <<
108 static G4ThreeVector ConvertToDimensioned3 <<
109 <<
110 // Static methods for unit and its categor <<
111 static G4double ValueOf(const char* unitNa <<
112 static G4String CategoryOf(const char* uni <<
113 static G4String UnitsList(const char* unit <<
114 <<
115 // Defines the range the command parameter <<
116 // The variable name(s) appear in the rang <<
117 // as the name(s) of the parameter(s). <<
118 // All the C++ syntax of relational operat <<
119 // range expression <<
120 inline void SetRange(const char* rs) { ran <<
121 <<
122 inline const G4String& GetRange() const { <<
123 inline std::size_t GetGuidanceEntries() co <<
124 inline const G4String& GetGuidanceLine(G4i <<
125 inline const G4String& GetCommandPath() co <<
126 inline const G4String& GetCommandName() co <<
127 inline std::size_t GetParameterEntries() c <<
128 inline G4UIparameter* GetParameter(G4int i <<
129 inline std::vector<G4ApplicationState>* Ge <<
130 inline G4UImessenger* GetMessenger() const <<
131 <<
132 // Defines a parameter. This method is use <<
133 // classes but the user can directly use t <<
134 // a command, without using the derived cl <<
135 // of the parameters is the order of invok <<
136 inline void SetParameter(G4UIparameter* co <<
137 { <<
138 parameter.push_back(newParameter); <<
139 } <<
140 <<
141 // Adds a guidance line. Unlimited times o <<
142 // allowed. The given lines of guidance wi <<
143 // The first line of the guidance will be <<
144 // command, i.e. one line list of the comm <<
145 inline void SetGuidance(const char* aGuida <<
146 <<
147 inline const G4String GetTitle() const <<
148 { <<
149 return (commandGuidance.empty()) ? G4Str <<
150 } <<
151 <<
152 inline void SetToBeBroadcasted(G4bool val) <<
153 inline G4bool ToBeBroadcasted() const { re <<
154 inline void SetToBeFlushed(G4bool val) { t <<
155 inline G4bool ToBeFlushed() const { return <<
156 inline void SetWorkerThreadOnly(G4bool val <<
157 inline G4bool IsWorkerThreadOnly() const { <<
158 <<
159 inline void CommandFailed(G4int errCode, G <<
160 { <<
161 commandFailureCode = errCode; <<
162 failureDescription = ed.str(); <<
163 } <<
164 inline void CommandFailed(G4ExceptionDescr <<
165 { <<
166 commandFailureCode = 1; <<
167 failureDescription = ed.str(); <<
168 } <<
169 inline G4int IfCommandFailed() { return co <<
170 inline const G4String& GetFailureDescripti <<
171 inline void ResetFailure() <<
172 { <<
173 commandFailureCode = 0; <<
174 failureDescription = ""; <<
175 } <<
176 <<
177 public: <<
178 enum CommandType <<
179 { <<
180 BaseClassCmd, <<
181 WithoutParameterCmd, <<
182 WithABoolCmd, <<
183 WithAnIntegerCmd, <<
184 WithALongIntCmd, <<
185 WithADoubleCmd, <<
186 WithADoubleAndUnitCmd, <<
187 With3VectorCmd, <<
188 With3VectorAndUnitCmd, <<
189 WithAStringCmd, <<
190 CmdDirectory = -1 <<
191 }; <<
192 65
193 inline CommandType GetCommandType() const << 66 G4bool operator==(const G4UIcommand &right) const;
194 void SetCommandType(CommandType); << 67 G4bool operator!=(const G4UIcommand &right) const;
195 68
196 inline void SetDefaultSortFlag(G4bool val) << 69 virtual G4int DoIt(G4String parameterList);
>> 70 G4String GetCurrentValue();
>> 71 public: // with description
>> 72 void AvailableForStates(G4ApplicationState s1);
>> 73 void AvailableForStates(G4ApplicationState s1,G4ApplicationState s2);
>> 74 void AvailableForStates(G4ApplicationState s1,G4ApplicationState s2,
>> 75 G4ApplicationState s3);
>> 76 void AvailableForStates(G4ApplicationState s1,G4ApplicationState s2,
>> 77 G4ApplicationState s3,G4ApplicationState s4);
>> 78 void AvailableForStates(G4ApplicationState s1,G4ApplicationState s2,
>> 79 G4ApplicationState s3,G4ApplicationState s4,
>> 80 G4ApplicationState s5);
>> 81 // These methods define the states where the command is available.
>> 82 // Once one of these commands is invoked, the command application will
>> 83 // be denied when Geant4 is NOT in the assigned states.
>> 84 public:
>> 85 G4bool IsAvailable();
>> 86 virtual void List();
197 87
198 protected: << 88 public: // with description
199 G4int CheckNewValue(const char* newValue); << 89 static G4String ConvertToString(G4bool boolVal);
>> 90 static G4String ConvertToString(G4int intValue);
>> 91 static G4String ConvertToString(G4double doubleValue);
>> 92 static G4String ConvertToString(G4double doubleValue,const char* unitName);
>> 93 static G4String ConvertToString(G4ThreeVector vec);
>> 94 static G4String ConvertToString(G4ThreeVector vec,const char* unitName);
>> 95 // Static methods for conversion from value(s) to a string. These methods are to be
>> 96 // used by GetCurrentValues() methods of concrete messengers.
>> 97
>> 98 static G4bool ConvertToBool(const char* st);
>> 99 static G4int ConvertToInt(const char* st);
>> 100 static G4double ConvertToDouble(const char* st);
>> 101 static G4double ConvertToDimensionedDouble(const char* st);
>> 102 static G4ThreeVector ConvertTo3Vector(const char* st);
>> 103 static G4ThreeVector ConvertToDimensioned3Vector(const char* st);
>> 104 // Static methods for conversion from a string to a value of the returning type.
>> 105 // These methods are to be used directly by SetNewValues() methods of concrete
>> 106 // messengers, or GetNewXXXValue() of classes derived from this G4UIcommand class.
>> 107
>> 108 static G4double ValueOf(const char* unitName);
>> 109 static G4String CategoryOf(const char* unitName);
>> 110 static G4String UnitsList(const char* unitCategory);
>> 111 // Static methods for unit and its category.
200 112
201 G4bool toBeBroadcasted = false; << 113 private:
202 G4bool toBeFlushed = false; << 114 void G4UIcommandCommonConstructorCode (const char * theCommandPath);
203 G4bool workerThreadOnly = false; << 115 G4UImessenger *messenger;
>> 116 G4String commandPath;
>> 117 G4String commandName;
>> 118 G4String rangeString;
>> 119 std::vector<G4UIparameter*> parameter;
>> 120 std::vector<G4String> commandGuidance;
>> 121 std::vector<G4ApplicationState> availabelStateList;
>> 122
>> 123 public: // with description
>> 124 inline void SetRange(const char* rs)
>> 125 { rangeString = rs; }
>> 126 // Defines the range the command parameter(s) can take.
>> 127 // The variable name(s) appear in the range expression must be same
>> 128 // as the name(s) of the parameter(s).
>> 129 // All the C++ syntax of relational operators are allowed for the
>> 130 // range expression.
>> 131 public:
>> 132 inline const G4String & GetRange() const
>> 133 { return rangeString; };
>> 134 inline size_t GetGuidanceEntries() const
>> 135 { return commandGuidance.size(); }
>> 136 inline const G4String & GetGuidanceLine(G4int i) const
>> 137 { return commandGuidance[i]; }
>> 138 inline const G4String & GetCommandPath() const
>> 139 { return commandPath; }
>> 140 inline const G4String & GetCommandName() const
>> 141 { return commandName; }
>> 142 inline size_t GetParameterEntries() const
>> 143 { return parameter.size(); }
>> 144 inline G4UIparameter * GetParameter(G4int i) const
>> 145 { return parameter[i]; }
>> 146 inline std::vector<G4ApplicationState>* GetStateList()
>> 147 { return &availabelStateList; }
>> 148 inline G4UImessenger * GetMessenger() const
>> 149 { return messenger; }
>> 150 public: // with description
>> 151 inline void SetParameter(G4UIparameter *const newParameter)
>> 152 {
>> 153 parameter.push_back( newParameter );
>> 154 newVal.resize( parameter.size() );
>> 155 }
>> 156 // Defines a parameter. This method is used by the derived command classes
>> 157 // but the user can directly use this command when he/she defines a command
>> 158 // by hem(her)self without using the derived class. For this case, the order
>> 159 // of the parameters is the order of invoking this method.
>> 160 inline void SetGuidance(const char * aGuidance)
>> 161 {
>> 162 commandGuidance.push_back( G4String( aGuidance ) );
>> 163 }
>> 164 // Adds a guidance line. Unlimitted number of invokation of this method is
>> 165 // allowed. The given lines of guidance will appear for the help. The first
>> 166 // line of the guidance will be used as the title of the command, i.e. one
>> 167 // line list of the commands.
>> 168 public:
>> 169 inline const G4String GetTitle() const
>> 170 {
>> 171 if(commandGuidance.size() == 0)
>> 172 { return G4String("...Title not available..."); }
>> 173 else
>> 174 { return commandGuidance[0]; }
>> 175 }
>> 176
>> 177 protected:
>> 178 G4bool toBeBroadcasted;
>> 179 G4bool toBeFlushed;
>> 180 G4bool workerThreadOnly;
204 181
205 G4int commandFailureCode = 0; << 182 public:
206 G4String failureDescription = ""; << 183 inline void SetToBeBroadcasted(G4bool val)
>> 184 { toBeBroadcasted = val; }
>> 185 inline G4bool ToBeBroadcasted() const
>> 186 { return toBeBroadcasted; }
>> 187 inline void SetToBeFlushed(G4bool val)
>> 188 { toBeFlushed = val; }
>> 189 inline G4bool ToBeFlushed() const
>> 190 { return toBeFlushed; }
>> 191 inline void SetWorkerThreadOnly(G4bool val=true)
>> 192 { workerThreadOnly = val; }
>> 193 inline G4bool IsWorkerThreadOnly() const
>> 194 { return workerThreadOnly; }
207 195
208 G4bool ifSort = false; << 196 protected:
>> 197 G4int commandFailureCode;
>> 198 G4String failureDescription;
209 199
210 private: << 200 public:
211 void G4UIcommandCommonConstructorCode(cons << 201 inline void CommandFailed( G4int errCode, G4ExceptionDescription& ed )
>> 202 { commandFailureCode = errCode; failureDescription = ed.str(); }
>> 203 inline void CommandFailed( G4ExceptionDescription& ed )
>> 204 { commandFailureCode = 1; failureDescription = ed.str(); }
>> 205 inline G4int IfCommandFailed()
>> 206 { return commandFailureCode; }
>> 207 inline G4String& GetFailureDescription()
>> 208 { return failureDescription; }
>> 209 inline void ResetFailure()
>> 210 { commandFailureCode = 0; failureDescription = ""; }
>> 211
>> 212 protected:
>> 213 G4int CheckNewValue(const char* newValue);
212 214
>> 215 // --- the following is used by CheckNewValue() --------
>> 216 protected:
>> 217 using yystype = G4UItokenNum::yystype;
>> 218 using tokenNum = G4UItokenNum::tokenNum;
213 private: 219 private:
214 CommandType commandType = BaseClassCmd; << 220 G4int TypeCheck(const char* t);
215 G4UImessenger* messenger = nullptr; << 221 G4int RangeCheck(const char* t);
216 G4String commandPath; << 222 G4int IsInt(const char* str, short maxLength);
217 G4String commandName; << 223 G4int IsDouble(const char* str);
218 G4String rangeExpression; << 224 G4int ExpectExponent(const char* str);
219 std::vector<G4UIparameter*> parameter; << 225 // syntax nodes
220 std::vector<G4String> commandGuidance; << 226 yystype Expression( void );
221 std::vector<G4ApplicationState> availabelS << 227 yystype LogicalORExpression( void );
>> 228 yystype LogicalANDExpression( void );
>> 229 yystype EqualityExpression ( void );
>> 230 yystype RelationalExpression( void );
>> 231 yystype AdditiveExpression( void );
>> 232 yystype MultiplicativeExpression( void );
>> 233 yystype UnaryExpression( void );
>> 234 yystype PrimaryExpression( void );
>> 235 // semantics routines
>> 236 G4int Eval2( yystype arg1, G4int op, yystype arg2 );
>> 237 G4int CompareInt( G4int arg1, G4int op, G4int arg2);
>> 238 G4int CompareDouble( G4double arg1, G4int op, G4double arg2);
>> 239 // utility
>> 240 tokenNum Yylex( void ); // returns next token
>> 241 unsigned IndexOf( const char* ); // returns the index of the var name
>> 242 unsigned IsParameter( const char* ); // returns 1 or 0
>> 243 G4int G4UIpGetc( void ); // read one char from rangeBuf
>> 244 G4int G4UIpUngetc( G4int c ); // put back
>> 245 G4int Backslash( G4int c );
>> 246 G4int Follow( G4int expect, G4int ifyes, G4int ifno );
>> 247 G4String TokenToStr(G4int token);
>> 248 void PrintToken(void); // for debug
>> 249 // data
>> 250 G4String rangeBuf;
>> 251 G4int bp; // buffer pointer for rangeBuf
>> 252 tokenNum token;
>> 253 yystype yylval;
>> 254 std::vector<yystype> newVal;
>> 255 G4int paramERR;
222 }; 256 };
223 257
224 #endif 258 #endif
>> 259
225 260