1 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> |
---|
2 | <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> |
---|
3 | <title>G4VBasicShell.hh Source File</title> |
---|
4 | <link href="doxygen.css" rel="stylesheet" type="text/css"> |
---|
5 | </head><body> |
---|
6 | <!-- Generated by Doxygen 1.3.4 --> |
---|
7 | <div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="hierarchy.html">Class Hierarchy</a> | <a class="qindex" href="annotated.html">Class List</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Class Members</a> | <a class="qindex" href="globals.html">File Members</a></div> |
---|
8 | <h1>G4VBasicShell.hh</h1><a href="G4VBasicShell_8hh.html">Go to the documentation of this file.</a><div class="fragment"><pre>00001 <span class="comment">//</span> |
---|
9 | 00002 <span class="comment">// ********************************************************************</span> |
---|
10 | 00003 <span class="comment">// * License and Disclaimer *</span> |
---|
11 | 00004 <span class="comment">// * *</span> |
---|
12 | 00005 <span class="comment">// * The Geant4 software is copyright of the Copyright Holders of *</span> |
---|
13 | 00006 <span class="comment">// * the Geant4 Collaboration. It is provided under the terms and *</span> |
---|
14 | 00007 <span class="comment">// * conditions of the Geant4 Software License, included in the file *</span> |
---|
15 | 00008 <span class="comment">// * LICENSE and available at http://cern.ch/geant4/license . These *</span> |
---|
16 | 00009 <span class="comment">// * include a list of copyright holders. *</span> |
---|
17 | 00010 <span class="comment">// * *</span> |
---|
18 | 00011 <span class="comment">// * Neither the authors of this software system, nor their employing *</span> |
---|
19 | 00012 <span class="comment">// * institutes,nor the agencies providing financial support for this *</span> |
---|
20 | 00013 <span class="comment">// * work make any representation or warranty, express or implied, *</span> |
---|
21 | 00014 <span class="comment">// * regarding this software system or assume any liability for its *</span> |
---|
22 | 00015 <span class="comment">// * use. Please see the license in the file LICENSE and URL above *</span> |
---|
23 | 00016 <span class="comment">// * for the full disclaimer and the limitation of liability. *</span> |
---|
24 | 00017 <span class="comment">// * *</span> |
---|
25 | 00018 <span class="comment">// * This code implementation is the result of the scientific and *</span> |
---|
26 | 00019 <span class="comment">// * technical work of the GEANT4 collaboration. *</span> |
---|
27 | 00020 <span class="comment">// * By using, copying, modifying or distributing the software (or *</span> |
---|
28 | 00021 <span class="comment">// * any work based on the software) you agree to acknowledge its *</span> |
---|
29 | 00022 <span class="comment">// * use in resulting scientific publications, and indicate your *</span> |
---|
30 | 00023 <span class="comment">// * acceptance of all terms of the Geant4 Software license. *</span> |
---|
31 | 00024 <span class="comment">// ********************************************************************</span> |
---|
32 | 00025 <span class="comment">//</span> |
---|
33 | 00026 <span class="comment">//</span> |
---|
34 | 00027 <span class="comment">// $Id: G4VBasicShell.hh,v 1.7 2006/06/29 19:10:03 gunter Exp $</span> |
---|
35 | 00028 <span class="comment">// GEANT4 tag $Name: geant4-08-01-patch-01 $</span> |
---|
36 | 00029 <span class="comment">//</span> |
---|
37 | 00030 |
---|
38 | 00031 <span class="preprocessor">#ifndef G4VBasicShell_H</span> |
---|
39 | 00032 <span class="preprocessor"></span><span class="preprocessor">#define G4VBasicShell_H 1</span> |
---|
40 | 00033 <span class="preprocessor"></span> |
---|
41 | 00034 <span class="keyword">class </span>G4UIcommandTree; |
---|
42 | 00035 <span class="keyword">class </span>G4UIcommand; |
---|
43 | 00036 |
---|
44 | 00037 <span class="preprocessor">#include "G4UIsession.hh"</span> |
---|
45 | 00038 <span class="preprocessor">#include "globals.hh"</span> |
---|
46 | 00039 |
---|
47 | 00040 <span class="comment">// Class description :</span> |
---|
48 | 00041 <span class="comment">//</span> |
---|
49 | 00042 <span class="comment">// G4VBasicShell : a base class to extract common things to various</span> |
---|
50 | 00043 <span class="comment">// sessions. </span> |
---|
51 | 00044 <span class="comment">//</span> |
---|
52 | 00045 <span class="comment">// It handles "seek" completion logic, help logic.</span> |
---|
53 | 00046 <span class="comment">// VBasicShell handles also commands like "cd, ls, pwd"</span> |
---|
54 | 00047 <span class="comment">// without passing by a Geant4 "intercom" command. This feature,</span> |
---|
55 | 00048 <span class="comment">// which is similar to a UNIX shell one, had given.</span> |
---|
56 | 00049 <span class="comment">// its name to the class.</span> |
---|
57 | 00050 <span class="comment">//</span> |
---|
58 | 00051 <span class="comment">// Class description - end :</span> |
---|
59 | 00052 |
---|
60 | <a name="l00053"></a><a class="code" href="classG4VBasicShell.html">00053</a> <span class="keyword">class </span><a class="code" href="classG4VBasicShell.html">G4VBasicShell</a> : <span class="keyword">public</span> G4UIsession |
---|
61 | 00054 { |
---|
62 | 00055 <span class="keyword">public</span>: |
---|
63 | 00056 <a class="code" href="classG4VBasicShell.html#a0">G4VBasicShell</a>(); |
---|
64 | 00057 <span class="keyword">virtual</span> <a class="code" href="classG4VBasicShell.html#a1">~G4VBasicShell</a>(); |
---|
65 | 00058 |
---|
66 | 00059 <span class="keyword">virtual</span> G4UIsession* <a class="code" href="classG4VBasicShell.html#a2">SessionStart</a>() = 0; |
---|
67 | 00060 <span class="comment">// null should be returned for interactive session</span> |
---|
68 | 00061 |
---|
69 | 00062 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classG4VBasicShell.html#a3">PauseSessionStart</a>(G4String Prompt) = 0; |
---|
70 | 00063 <span class="comment">// Prompt string can be ignored</span> |
---|
71 | 00064 |
---|
72 | 00065 <span class="keyword">protected</span>: |
---|
73 | 00066 G4String <a class="code" href="classG4VBasicShell.html#b0">ModifyToFullPathCommand</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* aCommandLine); |
---|
74 | 00067 <span class="comment">// convert "BeamOn 10" to "/run/BeamOn 10" if the</span> |
---|
75 | 00068 <span class="comment">// current working directory is "/run/"</span> |
---|
76 | 00069 |
---|
77 | 00070 G4String <a class="code" href="classG4VBasicShell.html#b1">GetCurrentWorkingDirectory</a>(); |
---|
78 | 00071 <span class="comment">// directory string starts with '/' and ends with '/'</span> |
---|
79 | 00072 |
---|
80 | 00073 G4bool <a class="code" href="classG4VBasicShell.html#b2">ChangeDirectory</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* newDir); |
---|
81 | 00074 <span class="comment">// change directory to newDir</span> |
---|
82 | 00075 <span class="comment">// false will be returned if the target directory doesn't exist</span> |
---|
83 | 00076 |
---|
84 | 00077 G4UIcommandTree* <a class="code" href="classG4VBasicShell.html#b3">FindDirectory</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* dirName); |
---|
85 | 00078 <span class="comment">// find G4UIcommandTree object</span> |
---|
86 | 00079 <span class="comment">// null returned if the taregt does not exist</span> |
---|
87 | 00080 |
---|
88 | 00081 G4UIcommand* <a class="code" href="classG4VBasicShell.html#b4">FindCommand</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* commandName); |
---|
89 | 00082 <span class="comment">// find G4UIcommand object</span> |
---|
90 | 00083 <span class="comment">// null returned if the target does not exist</span> |
---|
91 | 00084 |
---|
92 | 00085 G4String <a class="code" href="classG4VBasicShell.html#b5">Complete</a>(G4String); |
---|
93 | 00086 <span class="comment">// command completion</span> |
---|
94 | 00087 G4String <a class="code" href="classG4VBasicShell.html#b6">FindMatchingPath</a>(G4UIcommandTree*,G4String); |
---|
95 | 00088 |
---|
96 | 00090 <span class="comment">// Methods involving an interactive G4cout //</span> |
---|
97 | 00092 <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classG4VBasicShell.html#b7">ExecuteCommand</a>(G4String); |
---|
98 | 00093 <span class="keyword">virtual</span> G4bool <a class="code" href="classG4VBasicShell.html#b8">GetHelpChoice</a>(G4int&) = 0; |
---|
99 | 00094 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classG4VBasicShell.html#b9">ExitHelp</a>() = 0; |
---|
100 | 00095 <span class="keywordtype">void</span> <a class="code" href="classG4VBasicShell.html#b10">ApplyShellCommand</a>(G4String,G4bool&,G4bool&); |
---|
101 | 00096 <span class="keywordtype">void</span> <a class="code" href="classG4VBasicShell.html#b11">ShowCurrent</a>(G4String); |
---|
102 | 00097 <span class="keywordtype">void</span> <a class="code" href="classG4VBasicShell.html#b12">ChangeDirectoryCommand</a>(G4String); |
---|
103 | 00098 <span class="keywordtype">void</span> <a class="code" href="classG4VBasicShell.html#b13">ListDirectory</a>(G4String); |
---|
104 | 00099 <span class="keywordtype">void</span> <a class="code" href="classG4VBasicShell.html#b14">TerminalHelp</a>(G4String); |
---|
105 | 00100 |
---|
106 | 00101 <span class="keyword">private</span>: |
---|
107 | <a name="l00102"></a><a class="code" href="classG4VBasicShell.html#r0">00102</a> G4String <a class="code" href="classG4VBasicShell.html#r0">currentDirectory</a>; |
---|
108 | 00103 |
---|
109 | 00104 G4String <a class="code" href="classG4VBasicShell.html#d0">ModifyPath</a>(G4String tempPath); |
---|
110 | 00105 }; |
---|
111 | 00106 |
---|
112 | 00107 <span class="preprocessor">#endif</span> |
---|
113 | 00108 <span class="preprocessor"></span> |
---|
114 | </pre></div><hr size="1"><address style="align: right;"><small>Generated on Fri Jun 22 11:07:02 2007 by |
---|
115 | <a href="http://www.doxygen.org/index.html"> |
---|
116 | <img src="doxygen.png" alt="doxygen" align="middle" border=0 > |
---|
117 | </a>1.3.4 </small></address> |
---|
118 | </body> |
---|
119 | </html> |
---|