X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=kernel%2Fsrc%2FbbtkInterpreter.h;h=8c0e14446bc072f3da6a7609b1eba02900144f11;hb=5d1ed845326cc292279254b1e8667cdf3c4311fc;hp=5325e568013ebbb94485bb6da5251a0f036d96f6;hpb=70db75992e0ccf5ad1fab5ccf9cec013877ea3d5;p=bbtk.git diff --git a/kernel/src/bbtkInterpreter.h b/kernel/src/bbtkInterpreter.h index 5325e56..8c0e144 100644 --- a/kernel/src/bbtkInterpreter.h +++ b/kernel/src/bbtkInterpreter.h @@ -1,32 +1,39 @@ -/*========================================================================= +/* + # --------------------------------------------------------------------- + # + # Copyright (c) CREATIS (Centre de Recherche en Acquisition et Traitement de l'Image + # pour la SantÈ) + # Authors : Eduardo Davila, Frederic Cervenansky, Claire Mouton + # Previous Authors : Laurent Guigues, Jean-Pierre Roux + # CreaTools website : www.creatis.insa-lyon.fr/site/fr/creatools_accueil + # + # 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. + # ------------------------------------------------------------------------ */ + + +/*========================================================================= Program: bbtk Module: $RCSfile: bbtkInterpreter.h,v $ Language: C++ - Date: $Date: 2008/12/11 15:30:04 $ - Version: $Revision: 1.37 $ + Date: $Date: 2012/11/16 08:49:01 $ + Version: $Revision: 1.46 $ =========================================================================*/ -/* --------------------------------------------------------------------- - -* 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 @@ -42,10 +49,15 @@ #include "bbtkVirtualExec.h" #include "bbtkExecuter.h" +#include "bbtkInterpreterVirtual.h" #include #include +// Signal/slot mechanism for 'break' commands +//#include +//#include + namespace bbtk { @@ -53,6 +65,7 @@ namespace bbtk class WxConsole; #endif +/* EED Borrame //======================================================================= class BBTK_EXPORT InterpreterUser { @@ -62,28 +75,27 @@ namespace bbtk virtual bool InterpreterUserHasOwnHtmlPageViewer() { return false; } virtual void InterpreterUserViewHtmlPage(const std::string&) {} - - }; //======================================================================= +*/ + - - +/* EED Borrame //======================================================================= - class BBTK_EXPORT InterpreterError : public Exception + class BBTK_EXPORT InterpreterException : public Exception { public: - InterpreterError( const std::string& message, + InterpreterException( const std::string& message, bool in_script_file, const std::string& script_file, int script_line ); - InterpreterError( const Exception& excep, + InterpreterException( const Exception& excep, bool in_script_file, const std::string& script_file, int script_line ); - ~InterpreterError() throw() {} + ~InterpreterException() throw() {} bool IsInScriptFile() const { return mInScriptFile; } const std::string& GetScriptFile() const { return mScriptFile; } @@ -94,22 +106,58 @@ namespace bbtk 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"<SetDialogMode(t);} +/*EED Borrame /// 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; } @@ -160,16 +211,29 @@ namespace bbtk 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 BreakSignalType; + typedef BreakSignalType::slot_function_type BreakCallbackType; + + // Adds a callback when 'break' command issued + void AddBreakObserver( BreakCallbackType ); + */ protected: +/* EED Borrame /// 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, @@ -216,7 +280,7 @@ namespace bbtk /// Interprets a line - void InterpretLine( const std::string& line, bool &insideComment ); + void DoInterpretLine( const std::string& line ); //, bool &insideComment ); /// Reads a line from prompt void GetLineFromPrompt( std::string& line ); @@ -240,66 +304,91 @@ namespace bbtk /// Closes all open files void CloseAllFiles(); - +*/ + /// Resets all - void Reset(); + virtual void commandReset(); + /// Displays help (entry point of any help) - void Help(const std::vector& words); + virtual void commandHelp(const std::vector& words); /// Displays help on all the commands void HelpCommands(); + /// Displays help on a particular command - void HelpCommand( const std::string& command ); + virtual void commandHelp( const std::string& command ); /// - void Graph(const std::vector& words); + virtual void commandGraph(const std::vector& words); /// - void Config() const; + virtual void commandConfig() const; /// // void Print(const std::string&); - void Index(const std::string& filename, + virtual void commandIndex(const std::string& filename, const std::string& type = "Initials"); + +/*EED Borrame /// void FindCommandsWithPrefix( char* buf, int n, std::vector& commands ); - +*/ + /// 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); - + virtual void commandNewGUI(const std::string& box,const std::string& instanceName); + virtual void commandDebug(const std::string& arg); + virtual void commandNew(const std::string &boxType,const std::string &boxName); + virtual void commandDelete(const std::string &boxName); + virtual void commandConnection(const std::string &nodeFrom,const std::string &outputLabel,const std::string &nodeTo,const std::string &inputLabel); + virtual void commandPackage(const std::string &packageName); + virtual void commandEndPackage(); + virtual void commandDefine(const std::string &name,const std::string &pack,const std::string &scriptfilename); + virtual void commandEndDefine(); + virtual void commandKind(const std::string &kind); + virtual void commandPrint(const std::string &value); + virtual void commandExec(const std::string &word); + virtual void commandInput(const std::string &name,const std::string &box,const std::string &input,const std::string &help); + virtual void commandOutput(const std::string &name,const std::string &box,const std::string &output,const std::string &help); + virtual void commandSet(const std::string &box,const std::string &input,const std::string &value); + virtual void commandAuthor(const std::string &author); + virtual void commandCategory(const std::string &categorytype); + virtual void commandDescription(const std::string &description); + virtual void commandClear(); + virtual void commandInclude(const std::string &word, bool ok); + virtual void commandLoad(const std::string &packageName); + virtual void commandUnload(const std::string &packageName); + virtual void commandBreak(); + virtual void commandQuit(); + virtual void commandMessage(); + virtual void commandMessage(const std::string &kind,const std::string &levelstr); + virtual void SetCurrentFileName(const std::string &fullPathScriptName); + virtual void SetTypeOfScript_Application(); + + + + /// Constructor + Interpreter(const std::string& cpp_file = ""); + Interpreter(VirtualExec::Pointer); + private: - /// Constructor - Interpreter(const std::string& cpp_file = ""); - - Interpreter(VirtualExec::Pointer); - + void Init(VirtualExec::Pointer, const std::string& cpp_file); +/*EED Borrame /// 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 InterpreterError& e ); - void CatchBbtkException( const bbtk::Exception& e ); - void CatchStdException( const std::exception& e ); - void CatchUnknownException(); - - - +*/ //================================================================== // ATTRIBUTES @@ -307,9 +396,9 @@ namespace bbtk bbtk::VirtualExec::Pointer mVirtualExecuter; bbtk::Executer::WeakPointer mRealExecuter; +/*EED Borrame /// The user of the interpreter (0 if none) bbtk::InterpreterUser* mUser; - /// Vector of open files / buffers (can be stringstream) std::vector mFile; @@ -333,25 +422,38 @@ namespace bbtk /// 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; - int bufferNb; + int bufferNb; bool mThrow; - protected: - ~Interpreter(); + /// The break signal + // BreakSignalType mBreakSignal; + + */ + protected: + ~Interpreter(); + + /// + virtual void CatchInterpreterException( const InterpreterException& e ); + virtual void CatchBbtkException( const bbtk::Exception& e ); + virtual void CatchStdException( const std::exception& e ); + virtual void CatchUnknownException(); + + }; // EO class Interpreter - // The "Quit" exception - struct QuitException : public bbtk::Exception - { - QuitException() : bbtk::Exception("Interpreter","","Quit") {} - }; } #endif