Geant4  10.03.p03
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
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 // The Geant4-DNA web site is available at http://geant4-dna.org
31 //
32 // Author: Mathieu Karamitros
33 //
34 // $Id$
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,
55  };
56 
57  virtual const G4String& GetOption() { return fNoOption;}
59  G4bool IsActive() {return fActive;}
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;
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;
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 
108 public:
109  static CommandLineParser* GetParser();
112  static void DeleteInstance();
113  int Parse(int& argc, char **argv);
114  void PrintHelp();
115  bool CheckIfNotHandledOptionsExists(int& argc, char** argv);
116  void CorrectRemainingOptions(int& argc, char **argv);
117  void AddCommand(const G4String & marker,Command::Type,
118  const G4String& description = "",
119  const G4String& defaultOption = "",
120  const G4String& optionName = "");
121  Command* FindCommand(const G4String &marker);
122  Command* GetCommandIfActive(const G4String &marker);
123  G4bool WereOptionsSetup(){return fOptionsWereSetup;}
124 
125 private:
126  static CommandLineParser* fpInstance;
127  std::map<G4String, Command*> fCommandMap;
128  G4bool fOptionsWereSetup;
129  G4int fMaxMarkerLength;
130  G4int fMaxOptionNameLength;
131  G4int fVerbose;
132 
133 };
134 }
135 #endif // PARSER_HH
int Parse(int &argc, char **argv)
virtual const G4String & GetDefaultOption()
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 * 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()
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()