| 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 G4VUIshell_h 29 #ifndef G4VUIshell_h
30 #define G4VUIshell_h 1 30 #define G4VUIshell_h 1
31 31
32 #include "globals.hh" 32 #include "globals.hh"
33 33
34 // =========================================== 34 // ====================================================================
35 // Description: 35 // Description:
36 // This class is the abstract base class for 36 // This class is the abstract base class for various UI shells.
37 // 37 //
38 // GetCommadLineString() (virtual) returns a 38 // GetCommadLineString() (virtual) returns a command string input from
39 // a commad line. 39 // a commad line.
40 // 40 //
41 // Two pre-inplemented shell commands(still 41 // Two pre-inplemented shell commands(still virtual) are also included,
42 // (somewhat differnt flavor from ones provi 42 // (somewhat differnt flavor from ones provided by G4VBasicShell)
43 // ShowCurrentDirectory() ... show curre 43 // ShowCurrentDirectory() ... show current directory
44 // ListCommand() ... list comma 44 // ListCommand() ... list commands
45 // 45 //
46 // [prompt string substitution] (default) 46 // [prompt string substitution] (default)
47 // %s ... current application status 47 // %s ... current application status
48 // %/ ... current working directory 48 // %/ ... current working directory
49 // 49 //
50 // =========================================== 50 // ====================================================================
51 51
52 // terminal color index 52 // terminal color index
53 enum TermColorIndex 53 enum TermColorIndex
54 { 54 {
55 BLACK = 0, 55 BLACK = 0,
56 RED, 56 RED,
57 GREEN, 57 GREEN,
58 YELLOW, 58 YELLOW,
59 BLUE, 59 BLUE,
60 PURPLE, 60 PURPLE,
61 CYAN, 61 CYAN,
62 WHITE 62 WHITE
63 }; 63 };
64 64
65 class G4UIcommandTree; 65 class G4UIcommandTree;
66 66
67 class G4VUIshell 67 class G4VUIshell
68 { 68 {
69 public: 69 public:
70 G4VUIshell(const G4String& prompt = "> "); 70 G4VUIshell(const G4String& prompt = "> ");
71 virtual ~G4VUIshell(); 71 virtual ~G4VUIshell();
72 72
73 void SetNColumn(G4int ncol); 73 void SetNColumn(G4int ncol);
74 void SetPrompt(const G4String& prompt); 74 void SetPrompt(const G4String& prompt);
75 void SetCurrentDirectory(const G4String& ccd 75 void SetCurrentDirectory(const G4String& ccd);
76 virtual void SetLsColor(TermColorIndex, Term 76 virtual void SetLsColor(TermColorIndex, TermColorIndex);
77 77
78 // shell commands 78 // shell commands
79 virtual void ShowCurrentDirectory() const; 79 virtual void ShowCurrentDirectory() const;
80 80
81 // "candidate" is specified with full path. 81 // "candidate" is specified with full path.
82 virtual void ListCommand(const G4String& inp 82 virtual void ListCommand(const G4String& input, const G4String& candidate = "") const;
83 83
84 // get command string from a command line 84 // get command string from a command line
85 virtual G4String GetCommandLineString(const 85 virtual G4String GetCommandLineString(const char* msg = nullptr) = 0;
86 86
87 virtual void ResetTerminal(); 87 virtual void ResetTerminal();
88 88
89 protected: 89 protected:
90 // make prompt string 90 // make prompt string
91 virtual void MakePrompt(const char* msg = nu 91 virtual void MakePrompt(const char* msg = nullptr);
92 92
93 // get tree node 93 // get tree node
94 G4UIcommandTree* GetCommandTree(const G4Stri 94 G4UIcommandTree* GetCommandTree(const G4String& dir) const;
95 95
96 // absolute path name (ignore command) 96 // absolute path name (ignore command)
97 G4String GetAbsCommandDirPath(const G4String 97 G4String GetAbsCommandDirPath(const G4String& apath) const;
98 98
99 // tail of path ( xxx/xxx/zzz -> zzz, tranca 99 // tail of path ( xxx/xxx/zzz -> zzz, trancated //// -> /)
100 G4String GetCommandPathTail(const G4String& 100 G4String GetCommandPathTail(const G4String& apath) const;
101 101
102 G4String promptSetting; // including %-dire 102 G4String promptSetting; // including %-directive
103 G4String promptString; 103 G4String promptString;
104 G4int nColumn; // column size of terminal ( 104 G4int nColumn; // column size of terminal (default=80)
105 105
106 // color code support (effective if your ter 106 // color code support (effective if your terminal supports color code.)
107 // default setting is off. 107 // default setting is off.
108 G4bool lsColorFlag; // color flag for list 108 G4bool lsColorFlag; // color flag for list command
109 TermColorIndex directoryColor; 109 TermColorIndex directoryColor;
110 TermColorIndex commandColor; 110 TermColorIndex commandColor;
111 111
112 // for treating G4 command tree... 112 // for treating G4 command tree...
113 G4String currentCommandDir; // current comm 113 G4String currentCommandDir; // current command directory (absolute path)
114 }; 114 };
115 115
116 // =========================================== 116 // ====================================================================
117 // inline functions 117 // inline functions
118 // =========================================== 118 // ====================================================================
119 inline void G4VUIshell::SetNColumn(G4int ncol) 119 inline void G4VUIshell::SetNColumn(G4int ncol) { nColumn = ncol; }
120 120
121 inline void G4VUIshell::SetPrompt(const G4Stri 121 inline void G4VUIshell::SetPrompt(const G4String& prompt) { promptSetting = prompt; }
122 122
123 inline void G4VUIshell::SetCurrentDirectory(co 123 inline void G4VUIshell::SetCurrentDirectory(const G4String& dir) { currentCommandDir = dir; }
124 124
125 inline void G4VUIshell::SetLsColor(TermColorIn 125 inline void G4VUIshell::SetLsColor(TermColorIndex, TermColorIndex) {}
126 126
127 inline void G4VUIshell::ShowCurrentDirectory() 127 inline void G4VUIshell::ShowCurrentDirectory() const { G4cout << currentCommandDir << G4endl; }
128 128
129 #endif 129 #endif
130 130