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