X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=kernel%2Fsrc%2FbbtkInterpreter.h;h=e518cfdc4eae35d3966ea80ea0a14a3971215298;hb=16993e9f411c62e9a73d13c40f3748bdd232ce09;hp=bc60dd33d67d1eca728e226d9f1ff220eedbf990;hpb=fb4178612a6d5b670bb5991d4427ddd7b7bcd6ae;p=bbtk.git diff --git a/kernel/src/bbtkInterpreter.h b/kernel/src/bbtkInterpreter.h index bc60dd3..e518cfd 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/01/28 10:50:54 $ - Version: $Revision: 1.3 $ - - 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: 2012/11/16 08:49:01 $ + Version: $Revision: 1.46 $ =========================================================================*/ + + + /** * \file * \brief class Interpreter : The bbtk language interpreter @@ -23,182 +43,169 @@ * \class bbtk::Interpreter * \brief The bbtk language interpreter */ - + #ifndef __bbtkInterpreter_h__ #define __bbtkInterpreter_h__ #include "bbtkVirtualExec.h" #include "bbtkExecuter.h" -#include "bbtkTranscriptor.h" +#include "bbtkInterpreterVirtual.h" #include #include + namespace bbtk { - class BBTK_EXPORT Interpreter - { - private: - - /// The enumeration of command codes == Command name - typedef enum - { - cNew, - cDelete, - cConnect, - cExec, - cDefine, - cEndDefine, - cInput, - cOutput, - cSet, - cConfig, // JPR - cReset, // EED - cAuthor, - cDescription, - cHelp, - cMessage, - cInclude, - cQuit, - cLoad, - cUnload, - cGraph, - cPrint, - cWorkspace // 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; +#ifdef USE_WXWIDGETS + class WxConsole; +#endif + + + + + + //======================================================================= + class BBTK_EXPORT Interpreter : public InterpreterVirtual + { + BBTK_OBJECT_INTERFACE_NO_CONDES(Interpreter); + typedef Object InterpreterVirtual; public: - /// Constructor - Interpreter(); - - /// Destructor - ~Interpreter(); - - static Interpreter* mGlobalInterpreter; - - /// Launches a command line interpreter (with a prompt) - void CommandLineInterpreter(); - - /// Sets the inputs of the workspace : + static Pointer New(const std::string& cpp_file = ""); + static Pointer New(VirtualExec::Pointer); + + + /// 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, + { 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);} - /// 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 ); + /// Gets the Executer + VirtualExec::Pointer GetExecuter() const { return mVirtualExecuter; } - /// Reads a line from prompt - void GetLineFromPrompt( std::string& line ); + /* + // 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 ); + */ - /// Splits a line into words - void SplitLine ( const std::string& line, - std::vector& words ); + protected: - /// 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 ); - - /// Closes the currently open file - void CloseCurrentFile(); - - /// 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 ); - - /// - void Graph(const std::vector& words); - - /// - void Config(bool verbose) const; // JPR - /// - void Print(const std::string&); + virtual void commandHelp( const std::string& command ); /// - void FindCommandsWithPrefix( char* buf, - int n, - std::vector& commands ); + virtual void commandGraph(const std::vector& words); - /// Sets the bool that indicates wether we are in command line context - void SetCommandLine(bool v = true) { mCommandLine = v; } + /// + virtual void commandConfig() const; + /// + // void Print(const std::string&); + + virtual void commandIndex(const std::string& filename, + const std::string& type = "Initials"); + + + /// 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: - private: + + void Init(VirtualExec::Pointer, const std::string& cpp_file); - private: //================================================================== // ATTRIBUTES - /// The factory - // bbtk::Factory* mFactory; - - /// The command executer - bbtk::VirtualExec* mExecuter; - - /// Vector of opened files - std::vector mFile; - - /// Vector of names of open files - std::vector mFileName; + /// The command executer used + bbtk::VirtualExec::Pointer mVirtualExecuter; + bbtk::Executer::WeakPointer mRealExecuter; - /// Stores the current line number in each open file - std::vector mLine; - /// The dictionnary of commands - CommandDictType mCommandDict; + protected: + ~Interpreter(); - /// Are we in a command line context ? - bool mCommandLine; - - /// The history of commands - std::deque< char* > mHistory; - - bool verbose; // true -> displays the search results (for packages) + /// + 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("","","") {} - }; } #endif