| 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 // This example is provided by the Geant4-DNA 26 // This example is provided by the Geant4-DNA collaboration
27 // Any report or published results obtained us 27 // Any report or published results obtained using the Geant4-DNA software
28 // shall cite the following Geant4-DNA collabo 28 // shall cite the following Geant4-DNA collaboration publication:
29 // Med. Phys. 37 (2010) 4692-4708 29 // Med. Phys. 37 (2010) 4692-4708
30 // J. Comput. Phys. 274 (2014) 841-882 30 // J. Comput. Phys. 274 (2014) 841-882
31 // The Geant4-DNA web site is available at htt 31 // The Geant4-DNA web site is available at http://geant4-dna.org
32 // 32 //
33 // Author: Mathieu Karamitros 33 // Author: Mathieu Karamitros
34 // 34 //
>> 35 // $Id$
35 // 36 //
36 /// \file CommandLineParser.cc 37 /// \file CommandLineParser.cc
37 /// \brief Implementation of the CommandLinePa 38 /// \brief Implementation of the CommandLineParser class
38 39
39 #include "CommandLineParser.hh" <<
40 <<
41 #include <iomanip> 40 #include <iomanip>
>> 41 #include "CommandLineParser.hh"
42 42
43 using namespace std; 43 using namespace std;
44 using namespace G4DNAPARSER; 44 using namespace G4DNAPARSER;
45 45
46 CommandLineParser* CommandLineParser::fpInstan 46 CommandLineParser* CommandLineParser::fpInstance(0);
47 G4String Command::fNoOption = "NoOption"; 47 G4String Command::fNoOption = "NoOption";
48 48
49 //....oooOO0OOooo........oooOO0OOooo........oo 49 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
50 50
51 inline bool MATCH(const char* a, const char* b << 51 inline bool MATCH(const char *a, const char *b)
52 { 52 {
53 return strcmp(a, b) == 0; 53 return strcmp(a, b) == 0;
54 } 54 }
55 55
56 //....oooOO0OOooo........oooOO0OOooo........oo 56 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
57 57
58 CommandLineParser::CommandLineParser() 58 CommandLineParser::CommandLineParser()
59 { 59 {
60 // G4cout << "############ NEW PARSE ####### 60 // G4cout << "############ NEW PARSE ##########" << G4endl;
61 fpInstance = this; 61 fpInstance = this;
62 fOptionsWereSetup = false; 62 fOptionsWereSetup = false;
63 fMaxMarkerLength = 0; 63 fMaxMarkerLength = 0;
64 fMaxOptionNameLength = 0; 64 fMaxOptionNameLength = 0;
65 AddCommand("--help", Command::WithoutOption, 65 AddCommand("--help", Command::WithoutOption, "Print this help");
66 AddCommand("-h", Command::WithoutOption, "Pr 66 AddCommand("-h", Command::WithoutOption, "Print this help");
67 AddCommand("&", Command::WithoutOption); 67 AddCommand("&", Command::WithoutOption);
68 68
69 fVerbose = 0; 69 fVerbose = 0;
70 } 70 }
71 71
72 //....oooOO0OOooo........oooOO0OOooo........oo 72 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
73 73
74 CommandLineParser* CommandLineParser::GetParse 74 CommandLineParser* CommandLineParser::GetParser()
75 { 75 {
76 if (!fpInstance) new CommandLineParser; 76 if (!fpInstance) new CommandLineParser;
77 return fpInstance; 77 return fpInstance;
78 } 78 }
79 79
80 //....oooOO0OOooo........oooOO0OOooo........oo 80 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
81 81
82 CommandLineParser::~CommandLineParser() 82 CommandLineParser::~CommandLineParser()
83 { 83 {
84 std::map<G4String, Command*>::iterator it = 84 std::map<G4String, Command*>::iterator it = fCommandMap.begin();
85 for (; it != fCommandMap.end(); it++) { << 85 for (; it != fCommandMap.end(); it++)
>> 86 {
86 if (it->second) delete it->second; 87 if (it->second) delete it->second;
87 } 88 }
88 } 89 }
89 90
90 //....oooOO0OOooo........oooOO0OOooo........oo 91 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
91 92
92 void CommandLineParser::DeleteInstance() 93 void CommandLineParser::DeleteInstance()
93 { 94 {
94 if (fpInstance) { << 95 if (fpInstance)
>> 96 {
95 delete fpInstance; 97 delete fpInstance;
96 fpInstance = 0; 98 fpInstance = 0;
97 } 99 }
98 } 100 }
99 101
100 //....oooOO0OOooo........oooOO0OOooo........oo 102 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
101 103
102 Command::Command(Command::Type commandType, co << 104 Command::Command(Command::Type commandType,
>> 105 const G4String& description)
103 { 106 {
104 fType = commandType; 107 fType = commandType;
105 fDescription = description; 108 fDescription = description;
106 fActive = false; 109 fActive = false;
107 } 110 }
108 111
109 //....oooOO0OOooo........oooOO0OOooo........oo 112 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
110 113
111 CommandWithOption::CommandWithOption(Command:: << 114 CommandWithOption::CommandWithOption(Command::Type commandType,
112 const G4S << 115 const G4String& description,
113 : Command(commandType, description) << 116 const G4String& defaultOption,
>> 117 const G4String& optionName) :
>> 118 Command(commandType, description)
114 { 119 {
115 fDefaultOption = defaultOption; 120 fDefaultOption = defaultOption;
116 fOptionName = optionName; 121 fOptionName = optionName;
117 fOption = ""; 122 fOption = "";
118 } 123 }
119 124
120 //....oooOO0OOooo........oooOO0OOooo........oo 125 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
121 126
122 int CommandLineParser::Parse(int& argc, char** << 127 int CommandLineParser::Parse(int& argc, char **argv)
123 { 128 {
124 // G4cout << "Parse " << G4endl; 129 // G4cout << "Parse " << G4endl;
125 static char null[1] = {""}; << 130 static char null[1] = { "" };
126 int firstArgc = argc; 131 int firstArgc = argc;
127 132
128 for (int i = 1; i < firstArgc; i++) { << 133 for (int i = 1; i < firstArgc; i++)
>> 134 {
129 Command* command = FindCommand(argv[i]); 135 Command* command = FindCommand(argv[i]);
130 if (command == 0) continue; 136 if (command == 0) continue;
131 137
132 if (fVerbose) G4cout << "Command : " << ar 138 if (fVerbose) G4cout << "Command : " << argv[i] << G4endl;
133 139
134 fOptionsWereSetup = true; 140 fOptionsWereSetup = true;
135 command->fActive = true; 141 command->fActive = true;
136 142
137 G4String marker(argv[i]); 143 G4String marker(argv[i]);
138 144
139 if (strcmp(argv[i], "-h") != 0 && strcmp(a << 145 if (strcmp(argv[i], "-h") != 0 && strcmp(argv[i], "--help") != 0)
>> 146 {
140 argv[i] = null; 147 argv[i] = null;
141 } 148 }
142 149
143 if (command->fType == Command::WithOption) << 150 if (command->fType == Command::WithOption)
>> 151 {
144 if (fVerbose) G4cout << "WithOption" << 152 if (fVerbose) G4cout << "WithOption" << G4endl;
145 153
146 if (i + 1 > firstArgc || argv[i + 1] == << 154 if(i+1 > firstArgc || argv[i+1]==0 || argv[i+1][0]=='-')
147 G4cerr << "An command line option is m << 155 {
>> 156 G4cerr << "An command line option is missing for "
>> 157 << marker << G4endl;
148 abort(); 158 abort();
149 } 159 }
150 160
151 command->SetOption((const char*)strdup(a << 161 command->SetOption( (const char*) strdup(argv[i+1]) );
152 argv[i + 1] = null; << 162 argv[i+1] = null;
153 i++; 163 i++;
154 } 164 }
155 else if (command->fType == Command::Option << 165 else if(command->fType == Command::OptionNotCompulsory)
156 if (fVerbose) G4cout << "OptionNotCompul << 166 {
157 << 167 if(fVerbose)
158 if (i + 1 < firstArgc) { << 168 G4cout <<"OptionNotCompulsory"<<G4endl;
159 G4String buffer = (const char*)strdup( <<
160 169
161 if (buffer.empty() == false) { << 170 if(i+1 < firstArgc)
162 if (buffer.at(0) != '-' && buffer.at << 171 {
163 && buffer.at(0) != '|') << 172 G4String buffer = (const char*) strdup(argv[i+1]);
>> 173
>> 174 if(buffer.empty() == false)
>> 175 {
>> 176 if(buffer.at(0) != '-'
>> 177 && buffer.at(0) != '&'
>> 178 && buffer.at(0) != '>'
>> 179 && buffer.at(0) != '|')
164 { 180 {
165 if (fVerbose) { << 181 if(fVerbose)
>> 182 {
166 G4cout << "facultative option is 183 G4cout << "facultative option is : " << buffer << G4endl;
167 } 184 }
168 185
169 command->SetOption((const char*)st << 186 command->SetOption( (const char*) strdup(argv[i+1]) );
170 argv[i + 1] = null; << 187 argv[i+1] = null;
171 i++; 188 i++;
172 continue; 189 continue;
173 } 190 }
174 } 191 }
175 } 192 }
176 193
177 if (fVerbose) G4cout << "Option not set" << 194 if(fVerbose)
>> 195 G4cout << "Option not set" << G4endl;
178 196
179 command->SetOption(""); 197 command->SetOption("");
180 } 198 }
181 } 199 }
182 CorrectRemainingOptions(argc, argv); 200 CorrectRemainingOptions(argc, argv);
183 201
184 Command* commandLine(0); 202 Command* commandLine(0);
185 if ((commandLine = GetCommandIfActive("--hel << 203 if ((commandLine = GetCommandIfActive("--help")) || (commandLine =
>> 204 GetCommandIfActive("-h")))
>> 205 {
186 G4cout << "Usage : " << argv[0] << " [OPTI 206 G4cout << "Usage : " << argv[0] << " [OPTIONS]" << G4endl;
187 PrintHelp(); 207 PrintHelp();
188 return 1; 208 return 1;
189 } 209 }
190 210
191 return 0; 211 return 0;
192 } 212 }
193 213
194 //....oooOO0OOooo........oooOO0OOooo........oo 214 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
195 215
196 void CommandLineParser::PrintHelp() 216 void CommandLineParser::PrintHelp()
197 { 217 {
198 std::map<G4String, Command*>::iterator it; 218 std::map<G4String, Command*>::iterator it;
199 219
200 int maxFieldLength = fMaxMarkerLength + fMax 220 int maxFieldLength = fMaxMarkerLength + fMaxOptionNameLength + 4;
201 221
202 G4cout << "Options: " << G4endl; 222 G4cout << "Options: " << G4endl;
203 223
204 for (it = fCommandMap.begin(); it != fComman << 224 for (it = fCommandMap.begin(); it != fCommandMap.end(); it++)
>> 225 {
205 Command* command = it->second; 226 Command* command = it->second;
206 if (command) { << 227 if (command)
>> 228 {
207 G4cout << setw(maxFieldLength) << left; 229 G4cout << setw(maxFieldLength) << left;
208 230
209 G4String toPrint = it->first; 231 G4String toPrint = it->first;
210 232
211 if (toPrint == "&") { << 233 if (toPrint == "&")
>> 234 {
212 continue; 235 continue;
213 } 236 }
214 else if (toPrint == "-h") << 237 else if (toPrint == "-h") continue;
215 continue; << 238 else if (toPrint == "--help")
216 else if (toPrint == "--help") { << 239 {
217 toPrint += ", -h"; 240 toPrint += ", -h";
218 } 241 }
219 242
220 if (command->GetDefaultOption() != "") { << 243 if (command->GetDefaultOption() != "")
>> 244 {
221 toPrint += " \"" + command->GetDefault 245 toPrint += " \"" + command->GetDefaultOption() + "\"";
222 } 246 }
223 247
224 G4cout << toPrint; 248 G4cout << toPrint;
225 249
226 G4cout << command->GetDescription() << G 250 G4cout << command->GetDescription() << G4endl;
227 } 251 }
228 } 252 }
229 } 253 }
230 254
231 //....oooOO0OOooo........oooOO0OOooo........oo 255 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
232 256
233 void CommandLineParser::CorrectRemainingOption << 257 void CommandLineParser::CorrectRemainingOptions(int& argc, char **argv)
234 { 258 {
235 // remove handled arguments from argument ar 259 // remove handled arguments from argument array
236 int j = 0; 260 int j = 0;
237 for (int i = 0; i < argc; i++) { << 261 for (int i = 0; i < argc; i++)
238 if (strcmp(argv[i], "")) { << 262 {
>> 263 if (strcmp(argv[i], ""))
>> 264 {
239 argv[j] = argv[i]; 265 argv[j] = argv[i];
240 j++; 266 j++;
241 } 267 }
242 } 268 }
243 argc = j; 269 argc = j;
244 } 270 }
245 271
246 //....oooOO0OOooo........oooOO0OOooo........oo 272 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
247 273
248 void CommandLineParser::AddCommand(const G4Str << 274 void CommandLineParser::AddCommand(const G4String& marker,
249 const G4Str << 275 Command::Type type,
>> 276 const G4String& description,
>> 277 const G4String& defaultOption,
250 const G4Str 278 const G4String& optionName)
251 { 279 {
252 // G4cout << "Add command : "<< marker << G4 280 // G4cout << "Add command : "<< marker << G4endl;
253 << 281
254 Command* command = 0; 282 Command* command = 0;
255 switch (type) { << 283 switch(type)
256 case Command::WithoutOption: << 284 {
257 command = new Command(type, description) << 285 case Command::WithoutOption:
258 break; << 286 command = new Command(type, description);
259 << 287 break;
260 default: << 288
261 command = new CommandWithOption(type, de << 289 default:
262 if ((int)defaultOption.length() > fMaxOp << 290 command = new CommandWithOption(type,
263 fMaxOptionNameLength = defaultOption.l << 291 description,
264 break; << 292 defaultOption,
>> 293 optionName);
>> 294 if ((int) defaultOption.length() > fMaxOptionNameLength)
>> 295 fMaxOptionNameLength = defaultOption.length();
>> 296 break;
265 } 297 }
266 298
267 if ((int)marker.length() > fMaxMarkerLength) << 299 if ((int) marker.length() > fMaxMarkerLength) fMaxMarkerLength =
>> 300 marker.length();
268 fCommandMap.insert(make_pair(marker, command 301 fCommandMap.insert(make_pair(marker, command));
269 } 302 }
270 303
271 //....oooOO0OOooo........oooOO0OOooo........oo 304 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
272 305
273 /* 306 /*
274 // Add one command but multiple markers 307 // Add one command but multiple markers
275 void Parser::AddCommand(vector<G4String> marke 308 void Parser::AddCommand(vector<G4String> markers,
276 CommandType type, 309 CommandType type,
277 const G4String& descri 310 const G4String& description,
278 const G4String& option 311 const G4String& optionName)
279 { 312 {
280 // G4cout << "Add command : "<< marker << G4 313 // G4cout << "Add command : "<< marker << G4endl;
281 Command* command = new Command(type, descrip 314 Command* command = new Command(type, description, optionName);
282 315
283 for (size_t i = 0; i < markers.size; i++) 316 for (size_t i = 0; i < markers.size; i++)
284 { 317 {
285 G4String marker = markers[i]; 318 G4String marker = markers[i];
286 if ((int) marker.length() > fMaxMarkerLeng 319 if ((int) marker.length() > fMaxMarkerLength)
287 { 320 {
288 fMaxMarkerLength = marker.length(); 321 fMaxMarkerLength = marker.length();
289 } 322 }
290 if ((int) optionName.length() > fMaxOption 323 if ((int) optionName.length() > fMaxOptionNameLength)
291 { 324 {
292 fMaxOptionNameLength = optionName.length 325 fMaxOptionNameLength = optionName.length();
293 } 326 }
294 fCommandMap.insert(make_pair(marker, comma 327 fCommandMap.insert(make_pair(marker, command));
295 } 328 }
296 } 329 }
297 */ 330 */
298 331
299 //....oooOO0OOooo........oooOO0OOooo........oo 332 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
300 333
301 Command* CommandLineParser::FindCommand(const 334 Command* CommandLineParser::FindCommand(const G4String& marker)
302 { 335 {
303 std::map<G4String, Command*>::iterator it = 336 std::map<G4String, Command*>::iterator it = fCommandMap.find(marker);
304 if (it == fCommandMap.end()) { << 337 if (it == fCommandMap.end())
>> 338 {
305 // G4cerr << "command not found" << G4endl 339 // G4cerr << "command not found" << G4endl;
306 return 0; 340 return 0;
307 } 341 }
308 return it->second; 342 return it->second;
309 } 343 }
310 344
311 //....oooOO0OOooo........oooOO0OOooo........oo 345 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
312 346
313 Command* CommandLineParser::GetCommandIfActive << 347 Command* CommandLineParser::GetCommandIfActive(const G4String &marker)
314 { 348 {
315 Command* command = FindCommand(marker); 349 Command* command = FindCommand(marker);
316 if (command) { << 350 if (command)
>> 351 {
317 // G4cout << "Command found : "<< marker < 352 // G4cout << "Command found : "<< marker << G4endl;
318 353
319 if (command->fActive) { << 354 if (command->fActive)
>> 355 {
320 // G4cout << "Command Active" << G4endl; 356 // G4cout << "Command Active" << G4endl;
321 return command; 357 return command;
322 } 358 }
323 // else 359 // else
324 // G4cout <<"Command not active" << G4end 360 // G4cout <<"Command not active" << G4endl;
325 } 361 }
326 else { << 362 else
>> 363 {
327 G4ExceptionDescription description; 364 G4ExceptionDescription description;
328 description << "You try to retrieve a comm << 365 description << "You try to retrieve a command that was not registered : "
329 G4Exception("CommandLineParser::GetCommand << 366 << marker << G4endl;
330 description, ""); << 367 G4Exception("CommandLineParser::GetCommandIfActive",
>> 368 "COMMAND LINE NOT DEFINED", FatalException, description, "");
331 // If you are using this class outside of 369 // If you are using this class outside of Geant4, use exit(-1) instead
332 // exit(-1); << 370 //exit(-1);
333 } 371 }
334 return 0; 372 return 0;
335 } 373 }
336 374
337 //....oooOO0OOooo........oooOO0OOooo........oo 375 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
338 376
339 bool CommandLineParser::CheckIfNotHandledOptio 377 bool CommandLineParser::CheckIfNotHandledOptionsExists(int& argc, char** argv)
340 { 378 {
341 if (argc > 0) { << 379 if (argc > 0)
>> 380 {
342 G4bool kill = false; 381 G4bool kill = false;
343 for (G4int i = 1; i < argc; i++) { << 382 for (G4int i = 1; i < argc; i++)
344 if (strcmp(argv[i], "")) { << 383 {
>> 384 if (strcmp(argv[i], ""))
>> 385 {
345 kill = true; 386 kill = true;
346 G4cerr << "Unknown argument : " << arg 387 G4cerr << "Unknown argument : " << argv[i] << "\n";
347 } 388 }
348 } 389 }
349 if (kill) { << 390 if (kill)
350 G4cerr << "The option " << argv[0] << " << 391 {
>> 392 G4cerr << "The option " << argv[0]
>> 393 << " is not handled this programme." << G4endl;
351 G4cout << "Usage : " << argv[0] << " [OP 394 G4cout << "Usage : " << argv[0] << " [OPTIONS]" << G4endl;
352 PrintHelp(); 395 PrintHelp();
353 return true; // KILL APPLICATION << 396 return true; // KILL APPLICATION
354 } 397 }
355 } 398 }
356 return false; 399 return false;
357 } 400 }
358 401