X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=kernel%2Fsrc%2FbbtkInterpreter.h;h=e518cfdc4eae35d3966ea80ea0a14a3971215298;hb=16993e9f411c62e9a73d13c40f3748bdd232ce09;hp=96fe7dc56e41c58e48347e185891b1956753f96f;hpb=f3d05516965aece323133928f72d85e38c2b0b71;p=bbtk.git diff --git a/kernel/src/bbtkInterpreter.h b/kernel/src/bbtkInterpreter.h index 96fe7dc..e518cfd 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/15 09:04:47 $ - Version: $Revision: 1.39 $ + 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,13 +49,11 @@ #include "bbtkVirtualExec.h" #include "bbtkExecuter.h" +#include "bbtkInterpreterVirtual.h" #include #include -// Signal/slot mechanism for 'break' commands -//#include -//#include namespace bbtk { @@ -57,114 +62,20 @@ namespace bbtk 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"<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; } @@ -214,142 +111,79 @@ namespace bbtk 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, - 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 DoInterpretLine( const std::string& line ); //, bool &insideComment ); - - /// Reads a line from prompt - void GetLineFromPrompt( std::string& line ); - - /// Splits a line into words - void SplitLine ( const std::string& line, - std::vector& words ); - - /// Executes the right action depending on the command name - void InterpretCommand( const std::vector& words, - CommandInfoType& info ); - - /// Switch to the interpretation of a file - 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(); + 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"); - /// - 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); - /// 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 @@ -357,51 +191,17 @@ namespace bbtk bbtk::VirtualExec::Pointer mVirtualExecuter; bbtk::Executer::WeakPointer mRealExecuter; - /// 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; - - /// Stores the current line number in each open file - std::vector mLine; - - /// The dictionnary of commands - CommandDictType mCommandDict; - - /// 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; - - bool mThrow; - - /// The break signal - // BreakSignalType mBreakSignal; protected: - ~Interpreter(); - + ~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