Geant4  10.02.p01
CommandLineParser.hh
Go to the documentation of this file.
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 // $Id$
36 //
39 
40 #ifndef COMMANDLINEPARSER_HH
41 #define COMMANDLINEPARSER_HH
42 
43 #include "globals.hh"
44 #include <map>
45 
46 namespace G4DNAPARSER
47 {
48 class Command
49 {
50 public:
51  enum Type
52  {
53  WithOption,
56  };
57 
58  virtual const G4String& GetOption() { return fNoOption;}
60  G4bool IsActive() {return fActive;}
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;
74  static G4String fNoOption;
75 
76  Command(Type,
77  const G4String &description = "");
78  virtual ~Command(){;}
79 };
80 
81 class CommandWithOption : public Command
82 {
83 public:
84  virtual const G4String& GetOption() {return fOption;}
85  virtual const G4String& GetOptionName() {return fOptionName;}
86  virtual const G4String& GetDefaultOption() { return fDefaultOption;}
87 
88  virtual void SetOption(const G4String& in_op){ fOption = in_op;}
89  virtual void SetOptionName(const G4String& in_op){ fOptionName = in_op;}
90  virtual void SetDefaultOption(const G4String& in_op){ fDefaultOption = in_op;}
91 
92 private:
93  friend class CommandLineParser;
95  const G4String &description = "",
96  const G4String &defaultOption = "",
97  const G4String &optionName ="optionName");
98 
99  virtual ~CommandWithOption(){;}
100 
104 };
105 
106 class CommandLineParser
107 {
109  std::map<G4String, Command*> fCommandMap;
113  G4int fVerbose;
114 
115 public:
116  static CommandLineParser* GetParser();
119  static void DeleteInstance();
120  int Parse(int& argc, char **argv);
121  void PrintHelp();
122  bool CheckIfNotHandledOptionsExists(int& argc, char** argv);
123  void CorrectRemainingOptions(int& argc, char **argv);
124  void AddCommand(const G4String & marker,Command::Type,
125  const G4String& description = "",
126  const G4String& defaultOption = "",
127  const G4String& optionName = "");
128  Command* FindCommand(const G4String &marker);
129  Command* GetCommandIfActive(const G4String &marker);
131 };
132 }
133 #endif // PARSER_HH
int Parse(int &argc, char **argv)
virtual const G4String & GetDefaultOption()
CommandWithOption(Type, const G4String &description="", const G4String &defaultOption="", const G4String &optionName="optionName")
void AddCommand(const G4String &marker, Command::Type, const G4String &description="", const G4String &defaultOption="", const G4String &optionName="")
Command * GetCommandIfActive(const G4String &marker)
const G4String & GetDescription()
virtual void SetOption(const G4String &)
bool CheckIfNotHandledOptionsExists(int &argc, char **argv)
virtual void SetOption(const G4String &in_op)
static CommandLineParser * fpInstance
static CommandLineParser * GetParser()
virtual const G4String & GetOption()
static G4String fNoOption
virtual void SetOptionName(const G4String &)
int G4int
Definition: G4Types.hh:78
Command::Type GetType()
virtual const G4String & GetOptionName()
virtual const G4String & GetDefaultOption()
std::map< G4String, Command * > fCommandMap
bool G4bool
Definition: G4Types.hh:79
virtual void SetDefaultOption(const G4String &in_op)
void CorrectRemainingOptions(int &argc, char **argv)
virtual void SetOptionName(const G4String &in_op)
Command(Type, const G4String &description="")
Command * FindCommand(const G4String &marker)
virtual void SetDefaultOption(const G4String &)
virtual const G4String & GetOption()
virtual const G4String & GetOptionName()