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 | // $Id: G4UIterminal.hh,v 1.10 2007/05/22 01:51:05 kmura Exp $ |
---|
27 | // GEANT4 tag $Name: HEAD $ |
---|
28 | // |
---|
29 | // ==================================================================== |
---|
30 | // G4UIterminal.cc |
---|
31 | // |
---|
32 | // Description: |
---|
33 | // |
---|
34 | // This class inherits the class G4UIsession. |
---|
35 | // This is the class to use a character-terminal sesion. |
---|
36 | // |
---|
37 | // Usage: |
---|
38 | // G4UIsession* terminalSession = new G4UIterminal; |
---|
39 | // or G4UIsession* terminalSession = new G4UIterminal(new your-shell); |
---|
40 | // |
---|
41 | // A character-terminal session "terminalSession" is instantiated. |
---|
42 | // G4cout stream is redirected by default to the constructed instance. |
---|
43 | // |
---|
44 | // terminalSession-> SessionStart(); // "terminalSession" is started. |
---|
45 | // delete terminalSession; // "terminalSession" is deleted. |
---|
46 | // |
---|
47 | // |
---|
48 | // In default(no arguments are given), csh-like shell is instantiated. |
---|
49 | // If you want to use another shell (e.g. tcsh-like), you can give |
---|
50 | // your favorite shell in an argument of the constructor. |
---|
51 | // |
---|
52 | // Which shell? / How to define your own shell? |
---|
53 | // Currently two kinds of shells, |
---|
54 | // G4UIcsh / G4UItcsh |
---|
55 | // , are presented. |
---|
56 | // They inherit the abstract base class, G4VUIshell. |
---|
57 | // In order to define your own shell, |
---|
58 | // - Define your own shell class derived from G4VUIshell. |
---|
59 | // - Implement GetCommandLine() method (pure virtual). |
---|
60 | // - Add more functionality, if need. |
---|
61 | // |
---|
62 | // For more detail, see source codes. |
---|
63 | // ==================================================================== |
---|
64 | #ifndef G4UIterminal_h |
---|
65 | #define G4UIterminal_h 1 |
---|
66 | |
---|
67 | #include <fstream> |
---|
68 | #include "G4UImanager.hh" |
---|
69 | #include "G4VBasicShell.hh" |
---|
70 | #include "G4VUIshell.hh" |
---|
71 | |
---|
72 | class G4UIterminal : public G4VBasicShell { |
---|
73 | private: |
---|
74 | G4UImanager* UI; |
---|
75 | // shell |
---|
76 | G4VUIshell* shell; |
---|
77 | |
---|
78 | // program states |
---|
79 | G4bool iExit; |
---|
80 | G4bool iCont; |
---|
81 | |
---|
82 | public: |
---|
83 | G4UIterminal(G4VUIshell* aShell=0, G4bool qsig=true); |
---|
84 | ~G4UIterminal(); |
---|
85 | |
---|
86 | void SetPrompt(const G4String& prompt); |
---|
87 | |
---|
88 | private: |
---|
89 | void ExecuteCommand(G4String aCommand); |
---|
90 | G4String GetCommand(const char* msg=0); |
---|
91 | G4bool GetHelpChoice(G4int& aInt); |
---|
92 | void ExitHelp(); |
---|
93 | |
---|
94 | public: |
---|
95 | // These methods are implementation of corresponding virtual methods |
---|
96 | // of G4UIsession class. |
---|
97 | virtual G4UIsession* SessionStart(); |
---|
98 | virtual void PauseSessionStart(G4String msg); |
---|
99 | virtual G4int ReceiveG4cout(G4String coutString); |
---|
100 | virtual G4int ReceiveG4cerr(G4String cerrString); |
---|
101 | |
---|
102 | }; |
---|
103 | |
---|
104 | #endif |
---|
105 | |
---|