| Geant4 Cross Reference |
1 // 1 //
2 // ******************************************* 2 // ********************************************************************
3 // * License and Disclaimer 3 // * License and Disclaimer *
4 // * 4 // * *
5 // * The Geant4 software is copyright of th 5 // * The Geant4 software is copyright of the Copyright Holders of *
6 // * the Geant4 Collaboration. It is provided 6 // * the Geant4 Collaboration. It is provided under the terms and *
7 // * conditions of the Geant4 Software License 7 // * conditions of the Geant4 Software License, included in the file *
8 // * LICENSE and available at http://cern.ch/ 8 // * LICENSE and available at http://cern.ch/geant4/license . These *
9 // * include a list of copyright holders. 9 // * include a list of copyright holders. *
10 // * 10 // * *
11 // * Neither the authors of this software syst 11 // * Neither the authors of this software system, nor their employing *
12 // * institutes,nor the agencies providing fin 12 // * institutes,nor the agencies providing financial support for this *
13 // * work make any representation or warran 13 // * work make any representation or warranty, express or implied, *
14 // * regarding this software system or assum 14 // * regarding this software system or assume any liability for its *
15 // * use. Please see the license in the file 15 // * use. Please see the license in the file LICENSE and URL above *
16 // * for the full disclaimer and the limitatio 16 // * for the full disclaimer and the limitation of liability. *
17 // * 17 // * *
18 // * This code implementation is the result 18 // * This code implementation is the result of the scientific and *
19 // * technical work of the GEANT4 collaboratio 19 // * technical work of the GEANT4 collaboration. *
20 // * By using, copying, modifying or distri 20 // * By using, copying, modifying or distributing the software (or *
21 // * any work based on the software) you ag 21 // * any work based on the software) you agree to acknowledge its *
22 // * use in resulting scientific publicati 22 // * use in resulting scientific publications, and indicate your *
23 // * acceptance of all terms of the Geant4 Sof 23 // * acceptance of all terms of the Geant4 Software license. *
24 // ******************************************* 24 // ********************************************************************
25 // 25 //
26 // 26 //
27 // 27 //
28 28
29 #ifndef G4VBasicShell_H 29 #ifndef G4VBasicShell_H
30 #define G4VBasicShell_H 1 30 #define G4VBasicShell_H 1
31 31
32 class G4UIcommandTree; 32 class G4UIcommandTree;
33 class G4UIcommand; 33 class G4UIcommand;
34 34
35 #include "G4UIsession.hh" 35 #include "G4UIsession.hh"
36 #include "globals.hh" 36 #include "globals.hh"
37 37
38 // Class description : 38 // Class description :
39 // 39 //
40 // G4VBasicShell : a base class to extract co 40 // G4VBasicShell : a base class to extract common things to various
41 // sessions. 41 // sessions.
42 // 42 //
43 // It handles "seek" completion logic, help l 43 // It handles "seek" completion logic, help logic.
44 // VBasicShell handles also commands like "cd 44 // VBasicShell handles also commands like "cd, ls, pwd"
45 // without passing by a Geant4 "intercom" comm 45 // without passing by a Geant4 "intercom" command. This feature,
46 // which is similar to a UNIX shell one, had g 46 // which is similar to a UNIX shell one, had given.
47 // its name to the class. 47 // its name to the class.
48 // 48 //
49 // Class description - end : 49 // Class description - end :
50 50
51 class G4VBasicShell : public G4UIsession 51 class G4VBasicShell : public G4UIsession
52 { 52 {
53 public: 53 public:
54 G4VBasicShell(); 54 G4VBasicShell();
55 ~G4VBasicShell() override; 55 ~G4VBasicShell() override;
56 56
57 G4UIsession* SessionStart() override = 0; 57 G4UIsession* SessionStart() override = 0;
58 // null should be returned for interactive s 58 // null should be returned for interactive session
59 59
60 void PauseSessionStart(const G4String& Promp 60 void PauseSessionStart(const G4String& Prompt) override = 0;
61 // Prompt string can be ignored 61 // Prompt string can be ignored
62 62
63 protected: 63 protected:
64 // convert "BeamOn 10" to "/run/BeamOn 10" i 64 // convert "BeamOn 10" to "/run/BeamOn 10" if the
65 // current working directory is "/run/" 65 // current working directory is "/run/"
66 G4String ModifyToFullPathCommand(const char* 66 G4String ModifyToFullPathCommand(const char* aCommandLine) const;
67 67
68 // directory string starts with '/' and ends 68 // directory string starts with '/' and ends with '/'
69 G4String GetCurrentWorkingDirectory() const; 69 G4String GetCurrentWorkingDirectory() const;
70 70
71 // change directory to newDir 71 // change directory to newDir
72 // false will be returned if the target dire 72 // false will be returned if the target directory doesn't exist
73 G4bool ChangeDirectory(const char* newDir); 73 G4bool ChangeDirectory(const char* newDir);
74 74
75 // find G4UIcommandTree object 75 // find G4UIcommandTree object
76 // null returned if the taregt does not exis 76 // null returned if the taregt does not exist
77 G4UIcommandTree* FindDirectory(const char* d 77 G4UIcommandTree* FindDirectory(const char* dirName) const;
78 78
79 // find G4UIcommand object 79 // find G4UIcommand object
80 // null returned if the target does not exis 80 // null returned if the target does not exist
81 G4UIcommand* FindCommand(const char* command 81 G4UIcommand* FindCommand(const char* commandName) const;
82 82
83 // command completion 83 // command completion
84 G4String Complete(const G4String&); 84 G4String Complete(const G4String&);
85 85
86 G4String FindMatchingPath(G4UIcommandTree*, 86 G4String FindMatchingPath(G4UIcommandTree*, const G4String&);
87 87
88 //////////////////////////////////////////// 88 /////////////////////////////////////////////
89 // Methods involving an interactive G4cout / 89 // Methods involving an interactive G4cout //
90 //////////////////////////////////////////// 90 /////////////////////////////////////////////
91 virtual void ExecuteCommand(const G4String&) 91 virtual void ExecuteCommand(const G4String&);
92 virtual G4bool GetHelpChoice(G4int&) = 0; 92 virtual G4bool GetHelpChoice(G4int&) = 0;
93 virtual void ExitHelp() const = 0; 93 virtual void ExitHelp() const = 0;
94 void ApplyShellCommand(const G4String&, G4bo 94 void ApplyShellCommand(const G4String&, G4bool&, G4bool&);
95 void ShowCurrent(const G4String&) const; 95 void ShowCurrent(const G4String&) const;
96 void ChangeDirectoryCommand(const G4String&) 96 void ChangeDirectoryCommand(const G4String&);
97 void ListDirectory(const G4String&) const; 97 void ListDirectory(const G4String&) const;
98 void TerminalHelp(const G4String&); 98 void TerminalHelp(const G4String&);
99 99
100 private: 100 private:
101 G4String ModifyPath(const G4String& tempPath 101 G4String ModifyPath(const G4String& tempPath) const;
102 102
103 G4String currentDirectory; 103 G4String currentDirectory;
104 }; 104 };
105 105
106 #endif 106 #endif
107 107