ECCE @ EIC Software
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
CommandLineParser.hh
Go to the documentation of this file. Or view the newest version in sPHENIX GitHub for file CommandLineParser.hh
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 //
38 
39 #ifndef COMMANDLINEPARSER_HH
40 #define COMMANDLINEPARSER_HH
41 
42 #include "globals.hh"
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,
76  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,
94  const G4String &description = "",
95  const G4String &defaultOption = "",
96  const G4String &optionName ="optionName");
97 
98  virtual ~CommandWithOption(){;}
99 
100  G4String fOption;
101  G4String fDefaultOption;
102  G4String fOptionName;
103 };
104 
105 class CommandLineParser
106 {
107  static CommandLineParser* fpInstance;
108  std::map<G4String, Command*> fCommandMap;
109  G4bool fOptionsWereSetup;
110  G4int fMaxMarkerLength;
111  G4int fMaxOptionNameLength;
112  G4int fVerbose;
113 
114 public:
115  static CommandLineParser* GetParser();
116  CommandLineParser();
117  ~CommandLineParser();
118  static void DeleteInstance();
119  int Parse(int& argc, char **argv);
120  void PrintHelp();
121  bool CheckIfNotHandledOptionsExists(int& argc, char** argv);
122  void CorrectRemainingOptions(int& argc, char **argv);
123  void AddCommand(const G4String & marker,Command::Type,
124  const G4String& description = "",
125  const G4String& defaultOption = "",
126  const G4String& optionName = "");
127  Command* FindCommand(const G4String &marker);
128  Command* GetCommandIfActive(const G4String &marker);
129  G4bool WereOptionsSetup(){return fOptionsWereSetup;}
130 };
131 }
132 #endif // PARSER_HH