X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=kernel%2Fsrc%2FbbtkInterpreter.h;h=8c0e14446bc072f3da6a7609b1eba02900144f11;hb=cfad95b6e08e6e53846ffcda7fbc5932065f2c47;hp=dfa4795de4604847093c1305df994a64c7fb139b;hpb=1cad1aa48a5353dc6844018dc8b756f876e17394;p=bbtk.git diff --git a/kernel/src/bbtkInterpreter.h b/kernel/src/bbtkInterpreter.h index dfa4795..8c0e144 100644 --- a/kernel/src/bbtkInterpreter.h +++ b/kernel/src/bbtkInterpreter.h @@ -1,20 +1,40 @@ -/*========================================================================= +/* + # --------------------------------------------------------------------- + # + # 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 $ $ + Module: $RCSfile: bbtkInterpreter.h,v $ Language: C++ - Date: $Date: 2008/03/25 06:22:53 $ - Version: $Revision: 1.21 $ + Date: $Date: 2012/11/16 08:49:01 $ + Version: $Revision: 1.46 $ +=========================================================================*/ - 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. - 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. -=========================================================================*/ /** * \file * \brief class Interpreter : The bbtk language interpreter @@ -29,45 +49,53 @@ #include "bbtkVirtualExec.h" #include "bbtkExecuter.h" -#include "bbtkTranscriptor.h" +#include "bbtkInterpreterVirtual.h" #include #include +// Signal/slot mechanism for 'break' commands +//#include +//#include + namespace bbtk { -#ifdef _USE_WXWIDGETS_ +#ifdef USE_WXWIDGETS class WxConsole; #endif +/* EED Borrame + //======================================================================= class BBTK_EXPORT InterpreterUser { public: InterpreterUser() {} - ~InterpreterUser() {} + virtual ~InterpreterUser() {} virtual bool InterpreterUserHasOwnHtmlPageViewer() { return false; } virtual void InterpreterUserViewHtmlPage(const std::string&) {} - - }; + //======================================================================= +*/ + - /// - class BBTK_EXPORT InterpreterError : public Exception +/* EED Borrame + //======================================================================= + 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; } @@ -77,76 +105,64 @@ namespace bbtk std::string mScriptFile; int mScriptLine; }; - - - /// - class BBTK_EXPORT Interpreter + //======================================================================= +*/ + + + + /* + //======================================================================= + // The "Quit" exception + class BBTK_EXPORT QuitException : public InterpreterError { - - private: - - /// The enumeration of command codes == Command name - typedef enum - { - cNew, - cDelete, - cConnect, - cExec, - cPackage, - cEndPackage, - cDefine, - cEndDefine, - cInput, - cOutput, - cSet, - cConfig, // JPR - cReset, // EED - cAuthor, - cCategory, // JPR - cDescription, - cHelp, - cMessage, - cInclude, - cQuit, - cLoad, - cUnload, - cGraph, - cPrint, - cIndex, - cWorkspace // LG - } CommandCodeType; - - /// The structure storing the informations on a command - typedef struct - { - std::string category; - int argmin, argmax; - CommandCodeType code; - std::string syntax; - std::string help; - } CommandInfoType; - - /// The type of dictionnary of commands - typedef std::map CommandDictType; - public: - /// Constructor - Interpreter(); - - /// Destructor - ~Interpreter(); + 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"<& m) - { mExecuter->SetInputs(m); } + { mVirtualExecuter->SetInputs(m); } /// Puts the executer in "no exec" mode, /// which creates but does not execute pipelines. - void SetNoExecMode(bool b) { mExecuter->SetNoExecMode(b); } + 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) { mExecuter->SetDialogMode(t); } + void SetDialogMode(DialogModeType t) { mVirtualExecuter->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_ +#ifdef USE_WXWIDGETS /// Sets the user of the interpreter (if any) void SetUser(InterpreterUser* c) { mUser = c; } /// Gets the InterpreterUser of this @@ -191,16 +211,76 @@ namespace bbtk const InterpreterUser* GetUser() const { return mUser; } #endif + */ /// Gets the Executer - VirtualExec* GetExecuter() { return mExecuter; } - /// Gets the Executer (const) - const VirtualExec* GetExecuter() const { return mExecuter; } + 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, + cExec, + cPackage, + cEndPackage, + cDefine, + cEndDefine, + cInput, + cOutput, + cSet, + cConfig, // JPR + cReset, // EED + cAuthor, + cCategory, // JPR + cDescription, + cHelp, + cMessage, + cInclude, + cQuit, + cLoad, + cUnload, + cGraph, + cPrint, + cIndex, + cKind, // LG + cNewGUI, // LG + cWorkspace, // LG + cDebug // LG + } CommandCodeType; + + /// The structure storing the informations on a command + typedef struct + { + std::string keyword; + int argmin, argmax; + CommandCodeType code; + std::string syntax; + std::string help; + } CommandInfoType; + + /// The type of dictionnary of commands + typedef std::map CommandDictType; + + /// 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 ); @@ -214,7 +294,7 @@ namespace bbtk CommandInfoType& info ); /// Switch to the interpretation of a file - void SwitchToFile( const std::string& filename ); + void SwitchToFile( const std::string& filename, bool source = false ); /// Switch to the interpretation of a stringstream void SwitchToStream( std::stringstream* stream ); @@ -224,62 +304,112 @@ namespace bbtk /// Closes all open files void CloseAllFiles(); +*/ + + /// Resets all + 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 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 + 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: + + 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 CatchBbtkException( const bbtk::Exception& e ); - void CatchStdException( const std::exception& e ); - void CatchUnknownException(); - - private: - +*/ //================================================================== // ATTRIBUTES /// The command executer used - bbtk::VirtualExec* mExecuter; + 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; /// Vector of names of open files with full path (as open) std::vector 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 mFileNameHistory; + /// Vector of names of open files as given to the include command std::vector mIncludeFileName; @@ -292,22 +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; + /// 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