*** empty log message ***

[bbtk.git] / kernel / src / bbtkInterpreter.h

diff --git a/kernel/src/bbtkInterpreter.h b/kernel/src/bbtkInterpreter.h
index bc60dd33d67d1eca728e226d9f1ff220eedbf990..124323be80bdc9ed46abdad1984b48e18dfa303a 100644 (file)
--- a/kernel/src/bbtkInterpreter.h
+++ b/kernel/src/bbtkInterpreter.h
@@ -1,19 +1,19 @@
 /*=========================================================================
-                                                                                
+
   Program:   bbtk
   Module:    $RCSfile: bbtkInterpreter.h,v $ $
   Language:  C++
-  Date:      $Date: 2008/01/28 10:50:54 $
-  Version:   $Revision: 1.3 $
-                                                                                
+  Date:      $Date: 2008/03/03 08:06:36 $
+  Version:   $Revision: 1.12 $
+
   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 
@@ -23,7 +23,7 @@
  *  \class bbtk::Interpreter 
  *  \brief The bbtk language interpreter
  */
-  
+
 #ifndef __bbtkInterpreter_h__
 #define __bbtkInterpreter_h__
 
@@ -36,18 +36,22 @@
 
 namespace bbtk
 {
+
+
   class BBTK_EXPORT Interpreter
   {
 
   private:
-    
+
     /// The enumeration of command codes == Command name
-    typedef enum 
+    typedef enum
     {
-      cNew, 
+      cNew,
       cDelete,
       cConnect,
       cExec,
+      cPackage,
+      cEndPackage,
       cDefine,
       cEndDefine,
       cInput,
@@ -55,7 +59,8 @@ namespace bbtk
       cSet,
       cConfig,  // JPR
       cReset,   // EED
-      cAuthor,
+      cAuthor, 
+      cCategory, // JPR
       cDescription,
       cHelp,
       cMessage,
@@ -65,13 +70,14 @@ namespace bbtk
       cUnload,
       cGraph,
       cPrint,
-      cWorkspace // LG 
+      cIndex,
+      cWorkspace // LG
     } CommandCodeType;
 
     /// The structure storing the informations on a command 
     typedef struct 
     {
-      std::string keyword;
+      std::string category;
       int argmin, argmax;
       CommandCodeType code;
       std::string syntax;
@@ -84,32 +90,32 @@ namespace bbtk
   public:
     /// Constructor
     Interpreter();
- 
+
     /// Destructor
     ~Interpreter();
-      
+
    static Interpreter* mGlobalInterpreter;
 
     /// Launches a command line interpreter (with a prompt)
     void CommandLineInterpreter();
-    
-    /// Sets the inputs of the workspace : 
+
+    /// 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); }
- 
-    /// Puts the executer in "no exec" mode, 
+
+    /// 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);
+    void InterpretFile( const std::string& filename);
 
     /// Interprets a line (either from a file or typed interactively)
     void InterpretLine( const std::string& line, bool &insideComment );
@@ -121,36 +127,38 @@ namespace bbtk
     void SplitLine ( const std::string& line,
                      std::vector<std::string>& words );
 
-    /// Executes the right action depending on the command name  
-    void InterpretCommand( const std::vector<std::string>& words, 
+    /// Executes the right action depending on the command name
+    void InterpretCommand( const std::vector<std::string>& 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 );
+
     /// Closes the currently open file
     void CloseCurrentFile();
-    
+
     /// Closes all open files
     void CloseAllFiles();
 
     /// Displays help (entry point of any help)
     void Help(const std::vector<std::string>& 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<std::string>& words);
-    
+
     ///
-    void Config(bool verbose) const; // JPR
+    void Config() const; 
     /// 
     void Print(const std::string&);
 
+    void Index(const std::string& filename, 
+              const std::string& type = "Initials");
     ///
     void FindCommandsWithPrefix( char* buf,
                                 int n,
@@ -159,7 +167,13 @@ namespace bbtk
     /// Sets the bool that indicates wether we are in command line context
     void SetCommandLine(bool v = true) { mCommandLine = v; }
 
-  private: 
+
+  private:
+
+    /// Opens the file fullPathScriptName 
+    /// includeScriptName is the name as given to the include command 
+    void LoadScript( std::string fullPathScriptName,
+                    std::string includeScriptName);
 
   private:
 
@@ -172,12 +186,15 @@ namespace bbtk
     /// The command executer
     bbtk::VirtualExec* mExecuter;
 
-    /// Vector of opened files 
+    /// Vector of open files 
     std::vector<std::ifstream*> mFile;
 
-    /// Vector of names of open files
+    /// Vector of names of open files with full path (as open)
     std::vector<std::string> mFileName;
 
+    /// Vector of names of open files as given to the include command
+    std::vector<std::string> mIncludeFileName;
+
     /// Stores the current line number in each open file
     std::vector<int> mLine;
 
@@ -190,7 +207,6 @@ namespace bbtk
     /// The history of commands
     std::deque< char* > mHistory;
 
-    bool verbose; // true -> displays the search results (for packages)
   };