]> Creatis software - bbtk.git/blobdiff - kernel/src/bbtkInterpreter.h
bbtk now depends on crea !
[bbtk.git] / kernel / src / bbtkInterpreter.h
index bf40302851bed3b2edff02f1ba21a41749dd7f18..5325e568013ebbb94485bb6da5251a0f036d96f6 100644 (file)
@@ -1,20 +1,33 @@
-/*=========================================================================
-
+/*=========================================================================                                                                               
   Program:   bbtk
-  Module:    $RCSfile: bbtkInterpreter.h,v $ $
+  Module:    $RCSfile: bbtkInterpreter.h,v $
   Language:  C++
-  Date:      $Date: 2008/04/08 06:59:30 $
-  Version:   $Revision: 1.24 $
-
-  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.
+  Date:      $Date: 2008/12/11 15:30:04 $
+  Version:   $Revision: 1.37 $
+=========================================================================*/
 
-     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.
+/* ---------------------------------------------------------------------
+
+* 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
@@ -28,6 +41,7 @@
 #define __bbtkInterpreter_h__
 
 #include "bbtkVirtualExec.h"
+#include "bbtkExecuter.h"
 
 #include <fstream>
 #include <deque>
 namespace bbtk
 {
 
-#ifdef _USE_WXWIDGETS_
+#ifdef USE_WXWIDGETS
   class WxConsole;
 #endif
   
+  //=======================================================================
   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
   {
   public:
@@ -75,67 +93,17 @@ namespace bbtk
     std::string mScriptFile;
     int mScriptLine;
   };
+  //=======================================================================
 
 
-  //
-  class BBTK_EXPORT Interpreter
+  //=======================================================================
+  class BBTK_EXPORT Interpreter : public Object
   {
-
-  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,
-      cKind, // LG
-      cNewGUI, // LG
-      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<std::string,CommandInfoType> CommandDictType;
-
+    BBTK_OBJECT_INTERFACE_NO_CONDES(Interpreter);
+    typedef Object Superclass;
   public:
-    /// Constructor
-    Interpreter(const std::string& cpp_file = "");
-
-    /// Destructor
-    ~Interpreter();
-
+    static Pointer New(const std::string& cpp_file = "");
+    static Pointer New(VirtualExec::Pointer);
 
     typedef enum 
       {
@@ -146,7 +114,7 @@ namespace bbtk
       ExitStatus;
 
     /// Runs the interpretation of a file
-    ExitStatus InterpretFile( const std::string& filename);
+    ExitStatus InterpretFile( const std::string& filename, bool source = false);
 
     /// Runs the interpretation of a buffer and deletes it !
     ExitStatus InterpretBuffer( std::stringstream* buffer );
@@ -163,24 +131,27 @@ namespace bbtk
     /// Sets the inputs of the workspace :
     /// the map is passed as is to the Executer
     void SetInputs(const std::map<std::string,std::string>& 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);}
 
     /// 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,12 +162,59 @@ namespace bbtk
 #endif
 
     /// Gets the Executer 
-    VirtualExec* GetExecuter() { return mExecuter; }
-    /// Gets the Executer (const)
-    const VirtualExec* GetExecuter() const { return mExecuter; }
+    VirtualExec::Pointer GetExecuter() const { return mVirtualExecuter; }
 
 
   protected:
+
+    /// 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,
+      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<std::string,CommandInfoType> CommandDictType;
+
+
     /// Interprets a line 
     void InterpretLine( const std::string& line, bool &insideComment );
 
@@ -212,7 +230,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 );
@@ -223,6 +241,9 @@ namespace bbtk
     /// Closes all open files
     void CloseAllFiles();
 
+    /// Resets all
+    void Reset();
+
     /// Displays help (entry point of any help)
     void Help(const std::vector<std::string>& words);
 
@@ -255,25 +276,36 @@ namespace bbtk
     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();
 
-  private:
 
+  
     //==================================================================
     // ATTRIBUTES
 
     /// The command executer used
-    bbtk::VirtualExec* mExecuter;
+    bbtk::VirtualExec::Pointer mVirtualExecuter;
+    bbtk::Executer::WeakPointer mRealExecuter;
 
     /// The user of  the interpreter (0 if none)
     bbtk::InterpreterUser* mUser;
@@ -284,6 +316,11 @@ namespace bbtk
     /// Vector of names of open files with full path (as open)
     std::vector<std::string> 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<std::string> mFileNameHistory;
+
     /// Vector of names of open files as given to the include command
     std::vector<std::string> mIncludeFileName;
 
@@ -303,6 +340,9 @@ namespace bbtk
     
     bool mThrow;
 
+       protected:
+       ~Interpreter();
+
   };
   // EO class Interpreter