X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=kernel%2Fsrc%2FbbtkInterpreter.h;h=5325e568013ebbb94485bb6da5251a0f036d96f6;hb=70db75992e0ccf5ad1fab5ccf9cec013877ea3d5;hp=4d81c655d54406aa42dc5ee63510e0abe9b38bfa;hpb=6990a8aeeaf98fc901ed193b95365b2eee2fb950;p=bbtk.git diff --git a/kernel/src/bbtkInterpreter.h b/kernel/src/bbtkInterpreter.h index 4d81c65..5325e56 100644 --- a/kernel/src/bbtkInterpreter.h +++ b/kernel/src/bbtkInterpreter.h @@ -1,20 +1,33 @@ -/*========================================================================= - +/*========================================================================= Program: bbtk - Module: $RCSfile: bbtkInterpreter.h,v $ $ + Module: $RCSfile: bbtkInterpreter.h,v $ Language: C++ - Date: $Date: 2008/01/22 16:55:04 $ - Version: $Revision: 1.2 $ - - 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. - + Date: $Date: 2008/12/11 15:30:04 $ + Version: $Revision: 1.37 $ =========================================================================*/ + +/* --------------------------------------------------------------------- + +* 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 @@ -23,32 +36,146 @@ * \class bbtk::Interpreter * \brief The bbtk language interpreter */ - + #ifndef __bbtkInterpreter_h__ #define __bbtkInterpreter_h__ #include "bbtkVirtualExec.h" #include "bbtkExecuter.h" -#include "bbtkTranscriptor.h" #include #include 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 InterpreterError : public Exception { + public: + InterpreterError( const std::string& message, + bool in_script_file, + const std::string& script_file, + int script_line + ); + InterpreterError( const Exception& excep, + bool in_script_file, + const std::string& script_file, + int script_line + ); + ~InterpreterError() throw() {} + bool IsInScriptFile() const { return mInScriptFile; } + const std::string& GetScriptFile() const { return mScriptFile; } + int GetScriptLine() const { return mScriptLine; } private: - - /// The enumeration of command codes == Command name + bool mInScriptFile; + std::string mScriptFile; + int mScriptLine; + }; + //======================================================================= + + + //======================================================================= + 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 + } + 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 ); + + + /// 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& 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; } + + + protected: + + /// The enumeration of command codes == Command name + typedef enum { - cNew, + cNew, cDelete, cConnect, cExec, + cPackage, + cEndPackage, cDefine, cEndDefine, cInput, @@ -56,7 +183,8 @@ namespace bbtk cSet, cConfig, // JPR cReset, // EED - cAuthor, + cAuthor, + cCategory, // JPR cDescription, cHelp, cMessage, @@ -66,7 +194,11 @@ namespace bbtk cUnload, cGraph, cPrint, - cWorkspace // LG + cIndex, + cKind, // LG + cNewGUI, // LG + cWorkspace, // LG + cDebug // LG } CommandCodeType; /// The structure storing the informations on a command @@ -82,37 +214,8 @@ namespace bbtk /// The type of dictionnary of commands typedef std::map 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& 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) + /// Interprets a line void InterpretLine( const std::string& line, bool &insideComment ); /// Reads a line from prompt @@ -122,64 +225,105 @@ namespace bbtk void SplitLine ( const std::string& line, std::vector& words ); - /// Executes the right action depending on the command name - void InterpretCommand( const 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 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& words); - + /// Displays help on all the commands void HelpCommands(); - + /// Displays help on a particular command void HelpCommand( const std::string& command ); - + /// void Graph(const std::vector& 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"); /// void FindCommandsWithPrefix( char* buf, int n, std::vector& commands ); - - /// Sets the bool that indicates wether we are in command line context - void SetCommandLine(bool v = true) { mCommandLine = v; } - private: - + /// 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: + + /// 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 InterpreterError& 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::Executer* mExecuter; - bbtk::VirtualExec* mExecuter; + /// The user of the interpreter (0 if none) + bbtk::InterpreterUser* mUser; - /// Vector of opened files - std::vector mFile; + /// Vector of open files / buffers (can be stringstream) + std::vector mFile; - /// Vector of names of open files + /// 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; @@ -188,21 +332,26 @@ namespace bbtk /// Are we in a command line context ? bool mCommandLine; + + /// The history of commands + std::deque< char* > mHistory; + + int bufferNb; - /// The history of commands - std::deque< char* > mHistory; - - bool verbose; // true -> displays the search results (for packages) + bool mThrow; + + protected: + ~Interpreter(); + }; + // EO class Interpreter // The "Quit" exception struct QuitException : public bbtk::Exception { - QuitException() : bbtk::Exception("","","") {} + QuitException() : bbtk::Exception("Interpreter","","Quit") {} }; - - } #endif