1 /*=========================================================================
4 Module: $RCSfile: bbtkInterpreter.h,v $ $
6 Date: $Date: 2008/02/12 12:55:16 $
7 Version: $Revision: 1.11 $
9 Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
10 l'Image). All rights reserved. See Doc/License.txt or
11 http://www.creatis.insa-lyon.fr/Public/bbtk/License.html for details.
13 This software is distributed WITHOUT ANY WARRANTY; without even
14 the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
15 PURPOSE. See the above copyright notices for more information.
17 =========================================================================*/
20 * \brief class Interpreter : The bbtk language interpreter
23 * \class bbtk::Interpreter
24 * \brief The bbtk language interpreter
27 #ifndef __bbtkInterpreter_h__
28 #define __bbtkInterpreter_h__
30 #include "bbtkVirtualExec.h"
31 #include "bbtkExecuter.h"
32 #include "bbtkTranscriptor.h"
41 class BBTK_EXPORT Interpreter
46 /// The enumeration of command codes == Command name
77 /// The structure storing the informations on a command
87 /// The type of dictionnary of commands
88 typedef std::map<std::string,CommandInfoType> CommandDictType;
97 static Interpreter* mGlobalInterpreter;
99 /// Launches a command line interpreter (with a prompt)
100 void CommandLineInterpreter();
102 /// Sets the inputs of the workspace :
103 /// the map is passed as is to the Executer
104 void SetInputs(const std::map<std::string,std::string>& m)
105 { mExecuter->SetInputs(m); }
107 /// Puts the executer in "no exec" mode,
108 /// which creates but does not execute pipelines.
109 void SetNoExecMode(bool b) { mExecuter->SetNoExecMode(b); }
112 //typedef Executer::DialogModeType DialogModeType;
113 typedef VirtualExec::DialogModeType DialogModeType;
115 void SetDialogMode(DialogModeType t) { mExecuter->SetDialogMode(t); }
117 /// Runs the interpretation of a file
118 void InterpretFile( const std::string& filename,
119 bool use_configuration_file=true);
121 /// Interprets a line (either from a file or typed interactively)
122 void InterpretLine( const std::string& line, bool &insideComment );
124 /// Reads a line from prompt
125 void GetLineFromPrompt( std::string& line );
127 /// Splits a line into words
128 void SplitLine ( const std::string& line,
129 std::vector<std::string>& words );
131 /// Executes the right action depending on the command name
132 void InterpretCommand( const std::vector<std::string>& words,
133 CommandInfoType& info );
135 /// Switch to the interpretation of a file
136 void SwitchToFile( const std::string& filename,
137 bool use_configuration_file=true);
139 /// Closes the currently open file
140 void CloseCurrentFile();
142 /// Closes all open files
143 void CloseAllFiles();
145 /// Displays help (entry point of any help)
146 void Help(const std::vector<std::string>& words);
148 /// Displays help on all the commands
151 /// Displays help on a particular command
152 void HelpCommand( const std::string& command );
155 void Graph(const std::vector<std::string>& words);
160 void Print(const std::string&);
162 void Index(const std::string& filename,
163 const std::string& type = "Initials");
165 void FindCommandsWithPrefix( char* buf,
167 std::vector<std::string>& commands );
169 /// Sets the bool that indicates wether we are in command line context
170 void SetCommandLine(bool v = true) { mCommandLine = v; }
175 /// Opens the file fullPathScriptName
176 /// includeScriptName is the name as given to the include command
177 void LoadScript( std::string fullPathScriptName,
178 std::string includeScriptName);
182 //==================================================================
186 // bbtk::Factory* mFactory;
188 /// The command executer
189 bbtk::VirtualExec* mExecuter;
191 /// Vector of open files
192 std::vector<std::ifstream*> mFile;
194 /// Vector of names of open files with full path (as open)
195 std::vector<std::string> mFileName;
197 /// Vector of names of open files as given to the include command
198 std::vector<std::string> mIncludeFileName;
200 /// Stores the current line number in each open file
201 std::vector<int> mLine;
203 /// The dictionnary of commands
204 CommandDictType mCommandDict;
206 /// Are we in a command line context ?
209 /// The history of commands
210 std::deque< char* > mHistory;
215 // The "Quit" exception
216 struct QuitException : public bbtk::Exception
218 QuitException() : bbtk::Exception("","","") {}