Geant4  10.01.p01
G4VBasicShell.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 //
27 // $Id: G4VBasicShell.hh 66892 2013-01-17 10:57:59Z gunter $
28 //
29 
30 #ifndef G4VBasicShell_H
31 #define G4VBasicShell_H 1
32 
33 class G4UIcommandTree;
34 class G4UIcommand;
35 
36 #include "G4UIsession.hh"
37 #include "globals.hh"
38 
39 // Class description :
40 //
41 // G4VBasicShell : a base class to extract common things to various
42 // sessions.
43 //
44 // It handles "seek" completion logic, help logic.
45 // VBasicShell handles also commands like "cd, ls, pwd"
46 // without passing by a Geant4 "intercom" command. This feature,
47 // which is similar to a UNIX shell one, had given.
48 // its name to the class.
49 //
50 // Class description - end :
51 
52 class G4VBasicShell : public G4UIsession
53 {
54  public:
55  G4VBasicShell();
56  virtual ~G4VBasicShell();
57 
58  virtual G4UIsession* SessionStart() = 0;
59  // null should be returned for interactive session
60 
61  virtual void PauseSessionStart(const G4String& Prompt) = 0;
62  // Prompt string can be ignored
63 
64  protected:
65  G4String ModifyToFullPathCommand(const char* aCommandLine) const;
66  // convert "BeamOn 10" to "/run/BeamOn 10" if the
67  // current working directory is "/run/"
68 
70  // directory string starts with '/' and ends with '/'
71 
72  G4bool ChangeDirectory(const char* newDir);
73  // change directory to newDir
74  // false will be returned if the target directory doesn't exist
75 
76  G4UIcommandTree* FindDirectory(const char* dirName) const;
77  // find G4UIcommandTree object
78  // null returned if the taregt does not exist
79 
80  G4UIcommand* FindCommand(const char* commandName) const;
81  // find G4UIcommand object
82  // null returned if the target does not exist
83 
84  G4String Complete(const G4String&);
85  // command completion
86 
88 
90  // Methods involving an interactive G4cout //
92  virtual void ExecuteCommand(const G4String&);
93  virtual G4bool GetHelpChoice(G4int&) = 0;
94  virtual void ExitHelp() const = 0;
95  void ApplyShellCommand(const G4String&, G4bool&, G4bool&);
96  void ShowCurrent(const G4String&) const;
97  void ChangeDirectoryCommand(const G4String&);
98  void ListDirectory(const G4String&) const;
99  void TerminalHelp(const G4String&);
100 
101  private:
103 
104  G4String ModifyPath(const G4String& tempPath) const;
105 };
106 
107 #endif
G4UIcommandTree * FindDirectory(const char *dirName) const
virtual G4bool GetHelpChoice(G4int &)=0
void ChangeDirectoryCommand(const G4String &)
virtual void ExitHelp() const =0
void TerminalHelp(const G4String &)
G4String currentDirectory
G4String FindMatchingPath(G4UIcommandTree *, const G4String &)
G4String Complete(const G4String &)
int G4int
Definition: G4Types.hh:78
virtual void PauseSessionStart(const G4String &Prompt)=0
bool G4bool
Definition: G4Types.hh:79
virtual void ExecuteCommand(const G4String &)
G4bool ChangeDirectory(const char *newDir)
G4String ModifyToFullPathCommand(const char *aCommandLine) const
virtual G4UIsession * SessionStart()=0
G4String ModifyPath(const G4String &tempPath) const
void ApplyShellCommand(const G4String &, G4bool &, G4bool &)
void ShowCurrent(const G4String &) const
void ListDirectory(const G4String &) const
virtual ~G4VBasicShell()
G4String GetCurrentWorkingDirectory() const
G4UIcommand * FindCommand(const char *commandName) const