| 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 // This example is provided by the Geant4-DNA collaboration
27 // Any report or published results obtained using the Geant4-DNA software
28 // shall cite the following Geant4-DNA collaboration publication:
29 // Med. Phys. 37 (2010) 4692-4708
30 // The Geant4-DNA web site is available at http://geant4-dna.org
31 //
32 // Author: Mathieu Karamitros
33 //
34 //
35 /// \file CommandLineParser.hh
36 /// \brief Definition of the CommandLineParser class
37
38 #ifndef COMMANDLINEPARSER_HH
39 #define COMMANDLINEPARSER_HH
40
41 #include "globals.hh"
42
43 #include <map>
44
45 namespace G4DNAPARSER
46 {
47 class Command
48 {
49 public:
50 enum Type
51 {
52 WithOption,
53 WithoutOption,
54 OptionNotCompulsory
55 };
56
57 virtual const G4String& GetOption() { return fNoOption; }
58 Command::Type GetType() { return fType; }
59 G4bool IsActive() { return fActive; }
60 const G4String& GetDescription() { return fDescription; }
61 virtual const G4String& GetOptionName() { return fNoOption; }
62 virtual const G4String& GetDefaultOption() { return fNoOption; }
63
64 virtual void SetOption(const G4String&) { ; }
65 virtual void SetOptionName(const G4String&) { ; }
66 virtual void SetDefaultOption(const G4String&) { ; }
67
68 protected:
69 friend class CommandLineParser;
70 Type fType;
71 G4bool fActive;
72 G4String fDescription;
73 static G4String fNoOption;
74
75 Command(Type, const G4String& description = "");
76 virtual ~Command() { ; }
77 };
78
79 class CommandWithOption : public Command
80 {
81 public:
82 virtual const G4String& GetOption() { return fOption; }
83 virtual const G4String& GetOptionName() { return fOptionName; }
84 virtual const G4String& GetDefaultOption() { return fDefaultOption; }
85
86 virtual void SetOption(const G4String& in_op) { fOption = in_op; }
87 virtual void SetOptionName(const G4String& in_op) { fOptionName = in_op; }
88 virtual void SetDefaultOption(const G4String& in_op) { fDefaultOption = in_op; }
89
90 private:
91 friend class CommandLineParser;
92 CommandWithOption(Type, const G4String& description = "", const G4String& defaultOption = "",
93 const G4String& optionName = "optionName");
94
95 virtual ~CommandWithOption() { ; }
96
97 G4String fOption;
98 G4String fDefaultOption;
99 G4String fOptionName;
100 };
101
102 class CommandLineParser
103 {
104 public:
105 static CommandLineParser* GetParser();
106 CommandLineParser();
107 ~CommandLineParser();
108 static void DeleteInstance();
109 int Parse(int& argc, char** argv);
110 void PrintHelp();
111 bool CheckIfNotHandledOptionsExists(int& argc, char** argv);
112 void CorrectRemainingOptions(int& argc, char** argv);
113 void AddCommand(const G4String& marker, Command::Type, const G4String& description = "",
114 const G4String& defaultOption = "", const G4String& optionName = "");
115 Command* FindCommand(const G4String& marker);
116 Command* GetCommandIfActive(const G4String& marker);
117 G4bool WereOptionsSetup() { return fOptionsWereSetup; }
118
119 private:
120 static CommandLineParser* fpInstance;
121 std::map<G4String, Command*> fCommandMap;
122 G4bool fOptionsWereSetup;
123 G4int fMaxMarkerLength;
124 G4int fMaxOptionNameLength;
125 G4int fVerbose;
126 };
127 } // namespace G4DNAPARSER
128 #endif // PARSER_HH
129