-/*=========================================================================
-
+/*=========================================================================
Program: bbtk
- Module: $RCSfile: bbtkInterpreter.h,v $ $
+ Module: $RCSfile: bbtkInterpreter.h,v $
Language: C++
- Date: $Date: 2008/02/04 13:02:58 $
- Version: $Revision: 1.7 $
-
- Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
- l'Image). All rights reserved. See Doc/License.txt or
- http://www.creatis.insa-lyon.fr/Public/bbtk/License.html for details.
+ Date: $Date: 2008/12/15 09:04:47 $
+ Version: $Revision: 1.39 $
+=========================================================================*/
- This software is distributed WITHOUT ANY WARRANTY; without even
- the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
- PURPOSE. See the above copyright notices for more information.
+/* ---------------------------------------------------------------------
+
+* Copyright (c) CREATIS-LRMN (Centre de Recherche en Imagerie Medicale)
+* Authors : Eduardo Davila, Laurent Guigues, Jean-Pierre Roux
+*
+* This software is governed by the CeCILL-B license under French law and
+* abiding by the rules of distribution of free software. You can use,
+* modify and/ or redistribute the software under the terms of the CeCILL-B
+* license as circulated by CEA, CNRS and INRIA at the following URL
+* http://www.cecill.info/licences/Licence_CeCILL-B_V1-en.html
+* or in the file LICENSE.txt.
+*
+* As a counterpart to the access to the source code and rights to copy,
+* modify and redistribute granted by the license, users are provided only
+* with a limited warranty and the software's author, the holder of the
+* economic rights, and the successive licensors have only limited
+* liability.
+*
+* The fact that you are presently reading this means that you have had
+* knowledge of the CeCILL-B license and that you accept its terms.
+* ------------------------------------------------------------------------ */
-=========================================================================*/
/**
* \file
* \brief class Interpreter : The bbtk language interpreter
#include "bbtkVirtualExec.h"
#include "bbtkExecuter.h"
-#include "bbtkTranscriptor.h"
#include <fstream>
#include <deque>
+// Signal/slot mechanism for 'break' commands
+//#include <boost/signal.hpp>
+//#include <boost/bind.hpp>
+
namespace bbtk
{
- class BBTK_EXPORT Interpreter
+
+#ifdef USE_WXWIDGETS
+ class WxConsole;
+#endif
+
+ //=======================================================================
+ class BBTK_EXPORT InterpreterUser
{
+ public:
+ InterpreterUser() {}
+ virtual ~InterpreterUser() {}
+
+ virtual bool InterpreterUserHasOwnHtmlPageViewer() { return false; }
+ virtual void InterpreterUserViewHtmlPage(const std::string&) {}
+
+
+ };
+ //=======================================================================
+
+
+ //=======================================================================
+ class BBTK_EXPORT InterpreterException : public Exception
+ {
+ public:
+ InterpreterException( const std::string& message,
+ bool in_script_file,
+ const std::string& script_file,
+ int script_line
+ );
+ InterpreterException( const Exception& excep,
+ bool in_script_file,
+ const std::string& script_file,
+ int script_line
+ );
+ ~InterpreterException() throw() {}
+
+ bool IsInScriptFile() const { return mInScriptFile; }
+ const std::string& GetScriptFile() const { return mScriptFile; }
+ int GetScriptLine() const { return mScriptLine; }
private:
+ bool mInScriptFile;
+ std::string mScriptFile;
+ int mScriptLine;
+ };
+ //=======================================================================
+
+ /*
+ //=======================================================================
+ // The "Quit" exception
+ class BBTK_EXPORT QuitException : public InterpreterError
+ {
+ public:
+ QuitException( bool in_script_file,
+ const std::string& script_file,
+ int script_line
+ )
+ : InterpreterError("QUIT",in_script_file,script_file,script_line)
+ {}
+ ~QuitException() throw() {}
+ };
+ //=======================================================================
+ const std::string BREAK("BREAK");
+ //=======================================================================
+ // The "Break" exception
+ class BBTK_EXPORT BreakException : public InterpreterError
+ {
+ public:
+ BreakException( bool in_script_file,
+ std::string script_file,
+ int script_line
+ )
+ : InterpreterError(BREAK,in_script_file,script_file,script_line)
+ { std::cout << "BUILDING BREAK"<<std::endl; }
+ ~BreakException() throw() {}
+ };
+ //=======================================================================
+ */
+
+ //=======================================================================
+ class BBTK_EXPORT Interpreter : public Object
+ {
+ BBTK_OBJECT_INTERFACE_NO_CONDES(Interpreter);
+ typedef Object Superclass;
+ public:
+ static Pointer New(const std::string& cpp_file = "");
+ static Pointer New(VirtualExec::Pointer);
+
+ typedef enum
+ {
+ Interpreter_OK,
+ Interpreter_ERROR,
+ Interpreter_QUIT,
+ Interpreter_BREAK,
+ }
+ ExitStatus;
+
+ /// Runs the interpretation of a file
+ ExitStatus InterpretFile( const std::string& filename, bool source = false);
+
+ /// Runs the interpretation of a buffer and deletes it !
+ ExitStatus InterpretBuffer( std::stringstream* buffer );
+
+ /// Runs the interpretation of a command
+ ExitStatus InterpretLine( const std::string& line );
+
+ /// Runs the interpretation of the currently open streams
+ ExitStatus InterpretCurrentStreams();
+
+ /// Launches a command line interpreter (with a prompt)
+ void CommandLineInterpreter();
+
+
+
+ /// Sets the inputs of the workspace :
+ /// the map is passed as is to the Executer
+ void SetInputs(const std::map<std::string,std::string>& m)
+ { mVirtualExecuter->SetInputs(m); }
+
+ /// Puts the executer in "no exec" mode,
+ /// which creates but does not execute pipelines.
+ void SetNoExecMode(bool m) { mVirtualExecuter->SetNoExecMode(m); }
+
+ /// Puts the executer in "no error" mode,
+ /// Errors do not stop execution (but warnings are produced)
+ void SetNoErrorMode(bool m) { mVirtualExecuter->SetNoErrorMode(m);}
+ ///
+ //typedef Executer::DialogModeType DialogModeType;
+ typedef VirtualExec::DialogModeType DialogModeType;
+
+ void SetDialogMode(DialogModeType t) { mVirtualExecuter->SetDialogMode(t);}
+
+ /// Sets the bool that indicates wether we are in command line context
+ void SetCommandLine(bool v = true) { mCommandLine = v; }
+
+ void SetThrow(bool b) { mThrow = b; }
+
+#ifdef USE_WXWIDGETS
+ /// Sets the user of the interpreter (if any)
+ void SetUser(InterpreterUser* c) { mUser = c; }
+ /// Gets the InterpreterUser of this
+ InterpreterUser* GetUser() { return mUser; }
+ /// Gets the InterpreterUser of this (const)
+ const InterpreterUser* GetUser() const { return mUser; }
+
+#endif
+
+ /// Gets the Executer
+ VirtualExec::Pointer GetExecuter() const { return mVirtualExecuter; }
+
+ /*
+ // For 'break' commands observation
+ typedef boost::signals::trackable BreakObserverType;
+ typedef boost::signal<void ()> BreakSignalType;
+ typedef BreakSignalType::slot_function_type BreakCallbackType;
+
+ // Adds a callback when 'break' command issued
+ void AddBreakObserver( BreakCallbackType );
+ */
+
+ protected:
/// The enumeration of command codes == Command name
typedef enum
{
+ cBreak, // LG 12/12/08 : Stops the current script execution (if not exec frozen) - used in tutorial + debugging
+ cClear, // LG 12/12/08 : Clears the current complex black box (e.g. workspace) - used in tours
cNew,
cDelete,
cConnect,
cConfig, // JPR
cReset, // EED
cAuthor,
- cKeyword, // JPR
+ cCategory, // JPR
cDescription,
cHelp,
cMessage,
cGraph,
cPrint,
cIndex,
- cWorkspace // LG
+ cKind, // LG
+ cNewGUI, // LG
+ cWorkspace, // LG
+ cDebug // LG
} CommandCodeType;
/// The structure storing the informations on a command
/// The type of dictionnary of commands
typedef std::map<std::string,CommandInfoType> CommandDictType;
- public:
- /// Constructor
- Interpreter();
-
- /// Destructor
- ~Interpreter();
-
- static Interpreter* mGlobalInterpreter;
-
- /// Launches a command line interpreter (with a prompt)
- void CommandLineInterpreter();
-
- /// Sets the inputs of the workspace :
- /// the map is passed as is to the Executer
- void SetInputs(const std::map<std::string,std::string>& m)
- { mExecuter->SetInputs(m); }
-
- /// Puts the executer in "no exec" mode,
- /// which creates but does not execute pipelines.
- void SetNoExecMode(bool b) { mExecuter->SetNoExecMode(b); }
-
- ///
- //typedef Executer::DialogModeType DialogModeType;
- typedef VirtualExec::DialogModeType DialogModeType;
- void SetDialogMode(DialogModeType t) { mExecuter->SetDialogMode(t); }
-
- /// Runs the interpretation of a file
- void InterpretFile( const std::string& filename, bool use_configuration_file=true, bool verbose=false);
-
- /// Interprets a line (either from a file or typed interactively)
- void InterpretLine( const std::string& line, bool &insideComment );
+ /// Interprets a line
+ void DoInterpretLine( const std::string& line ); //, bool &insideComment );
/// Reads a line from prompt
void GetLineFromPrompt( std::string& line );
CommandInfoType& info );
/// Switch to the interpretation of a file
- void SwitchToFile( const std::string& filename, bool use_configuration_file=true, bool verbose=false );
+ void SwitchToFile( const std::string& filename, bool source = false );
+
+ /// Switch to the interpretation of a stringstream
+ void SwitchToStream( std::stringstream* stream );
/// Closes the currently open file
void CloseCurrentFile();
/// Closes all open files
void CloseAllFiles();
+ /// Resets all
+ void Reset();
+
/// Displays help (entry point of any help)
void Help(const std::vector<std::string>& words);
void Graph(const std::vector<std::string>& words);
///
- void Config(bool verbose) const; // JPR
+ void Config() const;
///
- void Print(const std::string&);
+ // void Print(const std::string&);
void Index(const std::string& filename,
const std::string& type = "Initials");
int n,
std::vector<std::string>& commands );
- /// Sets the bool that indicates wether we are in command line context
- void SetCommandLine(bool v = true) { mCommandLine = v; }
+ /// Creates and connects the piece of pipeline which defines a GUI
+ /// for the box box.
+ /// Define it as a complex box type with name instanceName+"Type"
+ /// The instance is called instanceName
+ /// and connected to the existing pipeline
+ void NewGUI(const std::string& box,
+ const std::string& instanceName);
+ void Debug(const std::string& arg);
+
+
private:
- void LoadScript( std::string fullPathScriptName);
+ /// Constructor
+ Interpreter(const std::string& cpp_file = "");
- private:
+ Interpreter(VirtualExec::Pointer);
+ void Init(VirtualExec::Pointer, const std::string& cpp_file);
+
+ /// Opens the file fullPathScriptName
+ /// includeScriptName is the name as given to the include command
+ void LoadScript( std::string fullPathScriptName,
+ std::string includeScriptName);
+
+ ///
+ void CatchInterpreterException( const InterpreterException& e );
+ void CatchBbtkException( const bbtk::Exception& e );
+ void CatchStdException( const std::exception& e );
+ void CatchUnknownException();
+
+
+
//==================================================================
// ATTRIBUTES
- /// The factory
- // bbtk::Factory* mFactory;
+ /// The command executer used
+ bbtk::VirtualExec::Pointer mVirtualExecuter;
+ bbtk::Executer::WeakPointer mRealExecuter;
- /// The command executer
- bbtk::VirtualExec* mExecuter;
+ /// The user of the interpreter (0 if none)
+ bbtk::InterpreterUser* mUser;
- /// Vector of opened files
- std::vector<std::ifstream*> mFile;
+ /// Vector of open files / buffers (can be stringstream)
+ std::vector<std::istream*> mFile;
- /// Vector of names of open files
+ /// Vector of names of open files with full path (as open)
std::vector<std::string> mFileName;
+ /// Vector of names of files which have been open
+ /// before (and may closed then which are no more in mFileName)
+ /// with full path (as open)
+ std::vector<std::string> mFileNameHistory;
+
+ /// Vector of names of open files as given to the include command
+ std::vector<std::string> mIncludeFileName;
+
/// Stores the current line number in each open file
std::vector<int> mLine;
/// Are we in a command line context ?
bool mCommandLine;
+ /// Are we inside a commented-out zone ?
+ bool mInsideComment;
+
+ /// The current interpreter status
+ ExitStatus mStatus;
+
/// The history of commands
std::deque< char* > mHistory;
- bool verbose; // true -> displays the search results (for packages)
- };
+ int bufferNb;
+
+ bool mThrow;
+ /// The break signal
+ // BreakSignalType mBreakSignal;
+
+ protected:
+ ~Interpreter();
- // The "Quit" exception
- struct QuitException : public bbtk::Exception
- {
- QuitException() : bbtk::Exception("","","") {}
};
+ // EO class Interpreter
+
+
}
#endif
git://git.creatis.insa-lyon.fr / bbtk.git / blobdiff