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