]> Creatis software - bbtk.git/blobdiff - kernel/src/bbtkInterpreter.cxx
*** empty log message ***
[bbtk.git] / kernel / src / bbtkInterpreter.cxx
index ef03a40f986572635709764b305897bbfb162af2..a6e4869da13ba3aa37898565273e3e165fe20cdc 100644 (file)
@@ -3,8 +3,8 @@
   Program:   bbtk
   Module:    $RCSfile: bbtkInterpreter.cxx,v $ $
   Language:  C++
-  Date:      $Date: 2008/01/22 16:55:04 $
-  Version:   $Revision: 1.2 $
+  Date:      $Date: 2008/02/14 10:47:51 $
+  Version:   $Revision: 1.30 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -31,6 +31,7 @@
 #define BBTK_USE_TERMIOS_BASED_PROMPT
 #endif
 
+#include <string>
 
 namespace bbtk
 {
@@ -43,7 +44,7 @@ Interpreter* Interpreter::mGlobalInterpreter = NULL;
    */
   Interpreter::Interpreter() 
     :
-    mCommandLine(false), verbose(false)
+    mCommandLine(false)
   {
     bbtk::MessageManager::RegisterMessageType("Echo","Level>0 : Prints the 'echo' commands of the user.\n\tLevel>1 : Prints the command being interpreted",1);
     bbtk::MessageManager::RegisterMessageType("Interpreter","Messages of the interpreter",0);
@@ -53,188 +54,221 @@ Interpreter* Interpreter::mGlobalInterpreter = NULL;
 
     //    mFactory = new bbtk::Factory();
     mExecuter = new bbtk::Executer();
+    //mExecuter = new bbtk::Transcriptor("GeneratedProgram.txt");
     //mExecuter->SetFactory(mFactory);
 
     // Builds the commands dict
     CommandInfoType info;
    
-    info.keyword = "new";
+    info.category = "new";
     info.argmin = 2;
     info.argmax = 2;
     info.code = cNew;
     info.syntax = "new <type> <name>";
     info.help = "Creates a new black box of type <type> with name <name>";
-    mCommandDict[info.keyword] = info;
+    mCommandDict[info.category] = info;
     
-    info.keyword = "delete";
+    info.category = "delete";
     info.argmin = 1;
     info.argmax = 1;
     info.code = cDelete;
     info.syntax = "delete <box>";
     info.help = "Deletes the black box of name <box>";
-    mCommandDict[info.keyword] = info;
+    mCommandDict[info.category] = info;
 
-    info.keyword = "connect";
+    info.category = "connect";
     info.argmin = 2;
     info.argmax = 2;
     info.code = cConnect;
     info.syntax = "connect <box1.output> <box2.input>";
     info.help = "Connects the ouput <output> of black box <box1> to the input <input> of black box <box2>";
-    mCommandDict[info.keyword] = info;
+    mCommandDict[info.category] = info;
 
-    info.keyword = "print";
+    info.category = "print";
     info.argmin = 1;
     info.argmax = 1;
     info.code = cPrint;
     info.syntax = "print <string>";
     info.help = "Prints the string. Substitutes any token of the form '$box.output$' by the string adaptation of the output of the box (requires the right adaptor). No carriage return is issued at the end, use '\\n' to add carriage returns. The level of 'Echo' messages must be greater than 1 (see the command 'message').";
-    mCommandDict[info.keyword] = info;
+    mCommandDict[info.category] = info;
 
-    info.keyword = "exec";
+    info.category = "exec";
     info.argmin = 1;
     info.argmax = 2;
     info.code = cExec;
     info.syntax = "exec <box | 'freeze' | 'unfreeze' >";
-    info.help = "Executes the black box of name <box> (and connected boxes if needed). If the special keyword 'freeze' is given then freezes any further execution command. 'unfreeze' reverts to normal execution mode.";
-    mCommandDict[info.keyword] = info;
+    info.help = "Executes the black box of name <box> (and connected boxes if needed). If the special category 'freeze' is given then freezes any further execution command. 'unfreeze' reverts to normal execution mode.";
+    mCommandDict[info.category] = info;
 
-    info.keyword = "define";
+    info.category = "package";
+    info.argmin = 1;
+    info.argmax = 1;
+    info.code = cPackage;
+    info.syntax = "package <name>";
+    info.help = "Begins the definition of a package.";
+    mCommandDict[info.category] = info;
+    
+    info.category = "endpackage";
+    info.argmin = 0;
+    info.argmax = 0;
+    info.code = cEndPackage;
+    info.syntax = "endpackage";
+    info.help = "Ends the definition of a package.";
+    mCommandDict[info.category] = info;
+
+    info.category = "define";
     info.argmin = 1;
     info.argmax = 2;
     info.code = cDefine;
     info.syntax = "define <type> [<package>]";
     info.help = "Begins the definition of a new type of complex black box called <type>. If <package> if provided will create it in the given package.";
-    mCommandDict[info.keyword] = info;
+    mCommandDict[info.category] = info;
     
-    info.keyword = "endefine";
+    info.category = "endefine";
     info.argmin = 0;
     info.argmax = 0;
     info.code = cEndDefine;
     info.syntax = "endefine";
     info.help = "Ends the definition of a new type of complex black box";
-    mCommandDict[info.keyword] = info;
+    mCommandDict[info.category] = info;
 
-    info.keyword = "input";
+    info.category = "input";
     info.argmin = 3;
     info.argmax = 3;
     info.code = cInput;
     info.syntax = "input <name> <box.input> <help>";
     info.help = "Defines the input <name> of the current working black box as being an alias for the input <input> of the black box <box>. <help> defines the help string for the newly created input";
-    mCommandDict[info.keyword] = info;
+    mCommandDict[info.category] = info;
 
-    info.keyword = "output";
+    info.category = "output";
     info.argmin = 3;
     info.argmax = 3;
     info.code = cOutput;
     info.syntax = "output <name> <box.output> <help>";
     info.help = "Defines the output <name> of the current working black box as being an alias for the output <output> of the black box <box>. <help> defines the help string for the newly created output";
-    mCommandDict[info.keyword] = info;
+    mCommandDict[info.category] = info;
 
-    info.keyword = "set";
+    info.category = "set";
     info.argmin = 2;
     info.argmax = 2;
     info.code = cSet;
     info.syntax = "set <box.input> <value>";
     info.help = "Sets the value of the input <input> of the black box <box> to <value>. There must exist a string to the value type adaptor";
-    mCommandDict[info.keyword] = info;
+    mCommandDict[info.category] = info;
    
-    info.keyword = "config";  // JPR
+    info.category = "config";  // JPR
     info.argmin = 0;
-    info.argmax = 1;
+    info.argmax = 0;
     info.code = cConfig;
-    info.syntax = "config [<verbose>|<v>]";
+    info.syntax = "config";
     info.help = "Prints the value of all configuration parameters";
-    mCommandDict[info.keyword] = info;
+    mCommandDict[info.category] = info;
 
-    info.keyword = "reset";  //EED
+    info.category = "index";  // LG
+    info.argmin = 0;
+    info.argmax = 2;
+    info.code = cIndex;
+
+    info.syntax = "index [<filename> ['Initials'(default)|'Packages'|'Categories']]";
+    info.help = "Creates an html index of known boxes. If filename is provided then save it to the file 'filename'. The default index entries are the initial letters of the names of the boxes. If 'Packages' or 'Categories' is provided then the entries are either the packages names or the categories";
+    mCommandDict[info.category] = info;
+
+    info.category = "reset";  //EED
     info.argmin = 0;
     info.argmax = 0;
     info.code = cReset;
     info.syntax = "reset";
     info.help = "Deletes all boxes and unloads all packages (bbi is reset to its start state)";
-    mCommandDict[info.keyword] = info;
+    mCommandDict[info.category] = info;
 
-    info.keyword = "author";
+    info.category = "author";
     info.argmin = 1;
     info.argmax = 1;
     info.code = cAuthor;
     info.syntax = "author <string>";
     info.help = "Adds the string <string> to the author information of the black box being defined";
-    mCommandDict[info.keyword] = info;
+    mCommandDict[info.category] = info;
+    
+    info.category = "category"; //JP
+    info.argmin = 1;
+    info.argmax = 1;
+    info.code = cCategory;
+    info.syntax = "category <list of items, separated by ;>";
+    info.help = "Adds the string <string> to the category information of the black box being defined";
+    mCommandDict[info.category] = info;
 
-    info.keyword = "description";
+    info.category = "description";
     info.argmin = 1;
     info.argmax = 1;
     info.code = cDescription;
     info.syntax = "description <string>";
     info.help = "Adds the string <string> to the descriptive information of the black box being defined";
-    mCommandDict[info.keyword] = info;
+    mCommandDict[info.category] = info;
 
-    info.keyword = "help";
+    info.category = "help";
     info.argmin = 0;
     info.argmax = 2;
     info.code = cHelp;
     info.syntax = "help";
     info.syntax = "\n         (1) help \n         (2) help <command name> \n         (3) help packages [all]\n         (4) help <package name> [all]\n         (5) help <black box type> \n         (6) help <black box name>";
     info.help = "Effect :\n         (1) Lists all available commands;\n         (2) Prints help on a particular command; \n         (3) Lists the packages loaded and their black boxes.\n             Add 'all' to list adaptors; \n         (4) Prints short help on the black boxes of a package.\n             Add 'all' to include adaptors; \n         (5) Prints full help on a black box type; \n         (6) Prints information on the inputs, outputs and connections of a black box instance.";
-    mCommandDict[info.keyword] = info;
+    mCommandDict[info.category] = info;
 
-    info.keyword = "message";
+    info.category = "message";
     info.argmin = 0;
     info.argmax = 2;
     info.code = cMessage;
-    info.syntax = "message <category> <level>";
-    info.help = "Sets the level of the category of messages <category> to <level>.\n  If category='All' then sets the level for all categories. If no category nor level is passed then prints info on available categories of messages and their current level.";
-    mCommandDict[info.keyword] = info;
+    info.syntax = "message <kind> <level>";
+    info.help = "Sets the level of the kind of messages <kind> to <level>.\n  If kind='All' then sets the level for all kinds. If no kind nor level is passed then prints info on available kinds of messages and their current level.";  mCommandDict[info.category] = info;
 
-    info.keyword = "include";
+    info.category = "include";
     info.argmin = 1;
-    info.argmax = 1;
+    info.argmax = 2;
     info.code = cInclude;
-    info.syntax = "include <filename>";
-    info.help = "Includes the file <filename>";
-    mCommandDict[info.keyword] = info;
+    info.syntax = "include <filename> [source]";
+    info.help = "Includes the file <filename>.\n  'source' : If the keyword 'source' is provided then informs bbi that the included file is the source of the current box definition (Advanced; used to get the right 'Include' field in html doc of packages 'appli' scripts).";
+    mCommandDict[info.category] = info;
 
-    info.keyword = "quit";
+    info.category = "quit";
     info.argmin = 0;
     info.argmax = 0;
     info.code = cQuit;
     info.syntax = "quit";
     info.help = "Quits the program (during script execution it stops the complete execution)";
-    mCommandDict[info.keyword] = info;
+    mCommandDict[info.category] = info;
 
-    info.keyword = "load";
+    info.category = "load";
     info.argmin = 1;
     info.argmax = 1;
     info.code = cLoad;
     info.syntax = "load <packagename>";
     info.help = "Loads the black box package <packagename>";
-    mCommandDict[info.keyword] = info;
+    mCommandDict[info.category] = info;
 
-    info.keyword = "unload";
+    info.category = "unload";
     info.argmin = 1;
     info.argmax = 1;
     info.code = cUnload;
     info.syntax = "unload <packagename>";
     info.help = "Unloads the black box package <packagename>";
-    mCommandDict[info.keyword] = info;
+    mCommandDict[info.category] = info;
 
-    info.keyword = "graph";
+    info.category = "graph";
     info.argmin = 0;
     info.argmax = 6;
     info.code = cGraph;
     info.syntax = "graph [ BlackBoxName [ Detail 0..1 [ Level 0..99999 [ Output html file [ Custom header [ Custom title ]]]]]] \n         graph [ BlackBoxNameType [ Detail 0..1 [ Level 0..99999 [ Output html file [ Custom header [ Custom title ]]]]]]";
     info.help = "Shows a graphical view of a bbtk pipeline.\n- BlackBoxName : name of the box to view. Default '.' : current box.\n- BlackBoxNameType : name of the type of box to view, ex : 'workspace')";
-    mCommandDict[info.keyword] = info;
+    mCommandDict[info.category] = info;
 
     /*
-    info.keyword = "workspace";
+    info.category = "workspace";
     info.argmin = 1;
     info.argmax = 2;
     info.code = cWorkspace;
     info.syntax = "workspace < ( freeze | unfreeze ) | ( rename <newname> ) >";
     info.help = "Configures the workspace.\n        'freeze' allow to block execution commands while keeping definition commands active. 'unfreeze' turns back the worspace in 'normal' mode.\n      'rename' allow to set a new name to the workspace.";
-    mCommandDict[info.keyword] = info;
+    mCommandDict[info.category] = info;
     */
 
     bbtkDebugDecTab("Interpreter",9);
@@ -254,7 +288,6 @@ Interpreter* Interpreter::mGlobalInterpreter = NULL;
     delete mExecuter;
     //delete mFactory;
 
-    //    std::cout <<"EO Interpreter::~Interpreter()"<<std::endl;
     bbtkDebugDecTab("Interpreter",9);
   }
   //=======================================================================
@@ -264,7 +297,8 @@ Interpreter* Interpreter::mGlobalInterpreter = NULL;
   /**
    *  
    */
-  void Interpreter::InterpretFile( const std::string& filename,  bool use_configuration_file, bool verbose)
+  void Interpreter::InterpretFile( const std::string& filename,  
+                                   bool use_configuration_file)
   {
     bbtkDebugMessageInc("Interpreter",9,"Interpreter::InterpretFile(\""<<filename<<"\")"<<std::endl);
 
@@ -273,7 +307,7 @@ Interpreter* Interpreter::mGlobalInterpreter = NULL;
 
     try 
     {
-      SwitchToFile(filename, use_configuration_file, verbose);
+      SwitchToFile(filename, use_configuration_file);
       bool insideComment = false; // for multiline comment
       while (mFile.size()>0) 
       {
@@ -324,7 +358,7 @@ Interpreter* Interpreter::mGlobalInterpreter = NULL;
           std::cout << "* LINE  : "<<mLine.back()<<std::endl;
       }    
     }
-    
+
     CloseAllFiles();
     bbtkDebugMessage("Interpreter",9,"EO Interpreter::InterpretFile(\""<<filename<<"\")"<<std::endl);
     bbtkDecTab("Interpreter",9);
@@ -347,7 +381,7 @@ void Interpreter::InterpretLine( const std::string& line, bool &insideComment )
 
     std::vector<std::string> words;
     SplitLine(line,words);
-    
+
     // Empty line
     if (words.size()<1) 
     {
@@ -391,158 +425,179 @@ void Interpreter::InterpretLine( const std::string& line, bool &insideComment )
        bbtkMessage("Interpreter",9,"Multiline Comment"<<std::endl);
        return;
     }
-                
+
     // Command 
     CommandInfoType command;
     InterpretCommand(words,command);
 
     bbtkDebugMessage("Interpreter",9,
-                     "Command '"<<command.keyword
-                      <<" code="<<command.code<<std::endl); 
+                     "Command='"<<command.category
+                      <<"' code="<<command.code<<std::endl); 
     int level=0;
     std::string left,right,left2,right2;
     std::string filename;
     switch (command.code) 
     {
       case cNew :
-            mExecuter->Create(words[1],words[2]);
-            break;
+        mExecuter->Create(words[1],words[2]);
+        break;
         
       case cDelete :
-            // TO DO !!
-            // mExecuter->Remove(words[1]);
-            break;
+        // TO DO !!
+        // mExecuter->Remove(words[1]);
+        break;
         
       case cConnect :
-            Utilities::SplitAroundFirstDot(words[1],left,right);
-            Utilities::SplitAroundFirstDot(words[2],left2,right2);      
-            mExecuter->Connect(left,right,left2,right2);
-            break;
+        Utilities::SplitAroundFirstDot(words[1],left,right);
+        Utilities::SplitAroundFirstDot(words[2],left2,right2);      
+        mExecuter->Connect(left,right,left2,right2);
+        break;
+        
+      case cPackage :
+        mExecuter->BeginPackage(words[1]);
+        break;
+
+      case cEndPackage :
+        mExecuter->EndPackage();
+        break;
         
       case cDefine :
-            if (mFileName.size()>0) 
-            {
-               filename = Utilities::get_file_name(mFileName.back());
-            }
-            if (words.size()==2) 
-            {
-               mExecuter->Define(words[1],"user",filename);
-            }
-            else 
-            {
-              mExecuter->Define(words[1],words[2],filename);
-            }
-            break;
+        if (mFileName.size()>0) 
+        {
+         filename = mIncludeFileName.back(); //Utilities::get_file_name(mFileName.back());
+        }
+        if (words.size()==2) 
+        {
+           mExecuter->Define(words[1],"",filename);
+        }
+        else 
+        {
+           mExecuter->Define(words[1],words[2],filename);
+        }
+        break;
         
       case cEndDefine :
-            mExecuter->EndDefine();
-            break;
+        mExecuter->EndDefine();
+        break;
         
       case cPrint :
-            Print(words[1]); /// \todo use mExecuter 
-            break;
+        Print(words[1]); /// \todo use mExecuter 
+        break;
         
       case cExec :
-            if (words[1]=="freeze") 
-           mExecuter->SetNoExecMode(true);
-            else if (words[1]=="unfreeze") 
-           mExecuter->SetNoExecMode(false);
-            else 
-           mExecuter->Update(words[1]);
-            break;
+        if (words[1]=="freeze") 
+          mExecuter->SetNoExecMode(true);
+        else if (words[1]=="unfreeze") 
+          mExecuter->SetNoExecMode(false);
+        else 
+          mExecuter->Update(words[1]);
+        break;
         
       case cInput :
-            Utilities::SplitAroundFirstDot(words[2],left,right);
-            mExecuter->DefineInput(words[1],left,right,words[3]);
-            break;
+        Utilities::SplitAroundFirstDot(words[2],left,right);
+        mExecuter->DefineInput(words[1],left,right,words[3]);
+        break;
         
       case cOutput :
-            Utilities::SplitAroundFirstDot(words[2],left,right);
-            mExecuter->DefineOutput(words[1],left,right,words[3]);
-            break;
+        Utilities::SplitAroundFirstDot(words[2],left,right);
+        mExecuter->DefineOutput(words[1],left,right,words[3]);
+        break;
         
       case cSet :
-            Utilities::SplitAroundFirstDot(words[1],left,right);
-            mExecuter->Set(left,right,words[2]);
-            break;
+        Utilities::SplitAroundFirstDot(words[1],left,right);
+        mExecuter->Set(left,right,words[2]);
+        break;
         
       case cAuthor :
-            mExecuter->Author(words[1]);
-            break;
-        
-      case cDescription :
-            mExecuter->Description(words[1]);
-            break;
+        mExecuter->Author(words[1]);
+        break;
+
+    case cCategory :
+      mExecuter->Category(words[1]);
+      break;
+      
+    case cIndex :
+      if (words.size()==1) 
+       Index("tmp_index.html");
+      else if (words.size()==2) 
+       Index(words[1]);
+      else if (words.size()==3) 
+       Index(words[1],words[2]);
+      break;
+    case cDescription :
+      mExecuter->Description(words[1]);
+        break;
         
       case cHelp :
-            Help(words);
-            break;
+        Help(words);
+        break;
         
       case cMessage : 
-            if (words.size()<3) 
-            {
+        if (words.size()<3) 
+        {
             bbtk::MessageManager::PrintInfo();
-            }
-            else 
-            {
+        }
+        else 
+        {
            sscanf(words[2].c_str(),"%d",&level);
            bbtk::MessageManager::SetMessageLevel(words[1],level);
-            }
-            break;
+        }
+        break;
         
       case cGraph : 
-            Graph(words);
-            break;
+        Graph(words);
+        break;
         
       case cConfig :
-            if (words.size()>1) // any param for config means verbose = true
-              verbose = true;
-            else
-              verbose = false;
-            Config(verbose);            
-            break;
+        Config();            
+        break;
         
       case cReset :  // EED
-            this->mExecuter->Reset();
-            break;
+        this->mExecuter->Reset();
+        break;
         
       case cInclude :
-            if (mCommandLine) 
-            {
-           InterpretFile(words[1], true, verbose); // true : better pass use_config_file
-            }
-            else 
-            {
-            SwitchToFile(words[1], true, verbose); // true : better pass use_config_file
-            }
-            break;
+        if (mCommandLine) 
+        {
+           InterpretFile(words[1], true ); // true : better pass use_config_file
+        }
+        else 
+        {
+            SwitchToFile(words[1], true ); // true : better pass use_config_file
+        }
+       // if 'source' was given
+       if (words.size()==3) 
+         {
+           this->mExecuter->SetCurrentFileName(words[1]);
+         }
+        break;
         
       case cLoad:
-            LoadPackage(words[1], true, verbose); // true : better pass use_config_file
-            break;
+        LoadPackage(words[1], true ); // true : better pass use_config_file
+        break;
         
       case cUnload:
-            UnLoadPackage(words[1]);
-            break;
+        UnLoadPackage(words[1]);
+        break;
         
       case cQuit :
-            throw QuitException();
-            break;
+        throw QuitException();
+        break;
         
-      case cWorkspace :
-            if (words.size() == 2) 
-            {
-               if (words[1]=="freeze")        mExecuter->SetNoExecMode(true);
-               else if (words[1]=="unfreeze") mExecuter->SetNoExecMode(false);
-            }
-            else 
-            {
-               mExecuter->SetWorkspaceName(words[2]);
-            }
-            break;
+         case cWorkspace :
+        if (words.size() == 2) 
+        {
+           if (words[1]=="freeze")        mExecuter->SetNoExecMode(true);
+           else if (words[1]=="unfreeze") mExecuter->SetNoExecMode(false);
+        }
+        else 
+        {
+           mExecuter->SetWorkspaceName(words[2]);
+        }
+        break;
         
       default:
-            bbtkInternalError("should not reach here !!!");
+        bbtkInternalError("should not reach here !!!");
    }
     
    bbtkDecTab("Interpreter",9);
@@ -551,28 +606,6 @@ void Interpreter::InterpretLine( const std::string& line, bool &insideComment )
 
 
 
-  //=======================================================================
-  void SplitString ( const std::string& str, const std::string& delimiters, 
-                     std::vector<std::string>& tokens)
-  {
-    // Skip delimiters at beginning.
-    std::string::size_type lastPos = str.find_first_not_of(delimiters, 0);
-    // Find first delimiter.
-    std::string::size_type pos     = str.find_first_of(delimiters, lastPos);
-    
-    while (std::string::npos != pos || std::string::npos != lastPos)
-      {
-        // Found a token, add it to the vector.
-        tokens.push_back(str.substr(lastPos, pos - lastPos));
-        // Skip delimiters.  Note the "not_of"
-        lastPos = str.find_first_not_of(delimiters, pos);
-        // Find next delimiter
-        pos = str.find_first_of(delimiters, lastPos);
-      }
-    
-  }
-  //=======================================================================
-
 
 
   //=======================================================================
@@ -585,13 +618,13 @@ void Interpreter::SplitLine ( const std::string& str, std::vector<std::string>&
  
     std::string delimiters = "\"";
     std::vector<std::string> quote;
-    SplitString(str,delimiters,quote);
+    Utilities::SplitString(str,delimiters,quote);
 
     delimiters = " \t";
     std::vector<std::string>::iterator i;
     for (i=quote.begin(); i!=quote.end(); ) 
     {
-       SplitString(*i,delimiters,tokens);
+       Utilities::SplitString(*i,delimiters,tokens);
        ++i;
        if (i!=quote.end()) 
        {
@@ -616,18 +649,15 @@ void Interpreter::SplitLine ( const std::string& str, std::vector<std::string>&
   // Replaces substrings "\\n" by a real carriage return "\n"
   void SubsBackslashN ( std::string& s )
   {
-    //   std::cout << "BEFORE=["<<s<<"]"<<std::endl;
     std::string ss("\\n");
     std::string::size_type pos = 0;
     pos = s.find(ss,0);
     char* cr = "\n";
     while ( pos != std::string::npos )
    {
-      //  std::cout << "*** find one "<<std::endl;
       s.replace(pos,2,cr,1);
       pos = s.find(ss, pos-1);
    } 
-    //    std::cout << "AFTER=["<<s<<"]"<<std::endl;
   }
   //=======================================================================
 
@@ -659,7 +689,6 @@ void Interpreter::SplitLine ( const std::string& str, std::vector<std::string>&
        {
           // Found a text token, add it to the vector.
           chains.push_back(str.substr(lastPos, pos - lastPos));
-          // std::cout << "text='"<<chains.back()<<"'"<<std::endl;
        }
        else 
        {
@@ -668,7 +697,6 @@ void Interpreter::SplitLine ( const std::string& str, std::vector<std::string>&
          tok = str.substr(lastPos, pos - lastPos);
          Utilities::SplitAroundFirstDot(tok,box,output);
          chains.push_back( mExecuter->Get(box,output) );
-    //    std::cout << "outp='"<<chains.back()<<"'"<<std::endl;
        }
         // Skip delimiters.  Note the "not_of"
        lastPos = str.find_first_not_of(delimiters, pos);
@@ -677,7 +705,6 @@ void Interpreter::SplitLine ( const std::string& str, std::vector<std::string>&
     //
        is_text = !is_text;
      }
-    //    std::cout << "nb="<<chains.size()<<std::endl;
      std::vector<std::string>::iterator i;
      for (i= chains.begin(); i!=chains.end(); ++i) 
      {
@@ -696,46 +723,71 @@ void Interpreter::SplitLine ( const std::string& str, std::vector<std::string>&
 
 // ===================================================================================
 
-
   void Interpreter::SwitchToFile( const std::string& name,
-                                  bool use_configuration_file, bool verbose)
+                                  bool use_configuration_file )
   {
+  // Note : in the following :
+  // name : the user supplied name 
+  //      - abreviated name    e.g.       scr   scr.bbs
+  //      - relative full name e.g.       ./scr.bbs   ../../scr.bbs 
+  //      - absolute full name e.g.       /home/usrname/proj/dir/scr.bbs
+  //          same for Windows, with      c:, d: ...
+  //
+  // use ./directory/subdir/scrname.bbs
+  //
+  
     bbtkDebugMessageInc("Interpreter",9,"Interpreter::SwitchToFile( \""
                          <<name<<"\")"<<std::endl);
 
     std::vector<std::string> script_paths;
-    std::string libname;  // full path library name
-    std::string pkgname;  // e.g. <scriptname>.bbs
-     
-    pkgname = Utilities::ExtractScriptName(name);
-
+    std::string fullPathScriptName;  // full path script name
+    std::string pkgname;             // e.g. <scriptname>.bbs
+    std::vector<std::string> Filenames;
+        
     if (use_configuration_file)
     {
-      if (verbose)
-         std::cout << "look for : [" << name << "] (use_configuration_file == TRUE)"  << std::endl;
+        // The following is *NOT* a debug time message :
+        // It's a user intended message.
+        // Please don't remove it.
+      bbtkMessage("Interpreter",1,
+                 "look for : [" << name
+                 << "] (use_configuration_file == TRUE)" << std::endl);
       script_paths = ConfigurationFile::GetInstance().Get_bbs_paths();
     }
+    std::string upath;
+    pkgname = Utilities::ExtractScriptName(name,upath);
 
     bool fullnameGiven = false; 
     bool foundFile     = false;
-    std::string::size_type slash_position = name.find_last_of("/\\");
-  
-    if (slash_position != std::string::npos)
+
+    if(pkgname == "*") // =========================================== load all boxes (e.g. std/boxes/*)
     {
-      fullnameGiven = true;     
-      libname =  Utilities::ExpandLibName(name, verbose);
-      if (libname != "") {
-        if ( Utilities::FileExists(libname))
+      int nbBssFiles;
+
+      if (upath[0]=='/' || upath[1] == ':' ) // ==== absolute name, load all .bbs files
+      {
+        int nbFiles = Utilities::Explore(upath, false, Filenames);
+        nbBssFiles = 0;
+        for (std::vector<std::string>::iterator i = Filenames.begin(); i!= Filenames.end(); ++i)
         {
-          foundFile = true;
+           if ((*i).substr((*i).size()-4, 4) != ".bbs")
+              continue;      // ignore non .bbs files
+           LoadScript(*i,name);
+           nbBssFiles++;
         }
+        if (nbBssFiles==0)
+           bbtkMessage("Interpreter",2,
+                      "WARNING : No '.bbs' file found in [" 
+                      << upath << "]" << std::endl);
+
+        return;
       }
-    }
-    else    // ----------------------- iterate on the paths
-    {
-      std::string path;    
+      
+
+      std::string path;
       std::vector<std::string>::iterator i;
-      for (i=script_paths.begin();i!=script_paths.end();++i)
+      std::string fullDirectoryName;
+      for (i=script_paths.begin();i!=script_paths.end();++i)// ==== relative name, iterate + load all .bbs files
       {
         path = *i;
 
@@ -743,60 +795,178 @@ void Interpreter::SplitLine ( const std::string& str, std::vector<std::string>&
         if (path == ".") {
           char buf[2048]; // for getcwd
           char * currentDir = getcwd(buf, 2048);
-          std::string cwd(currentDir);        
+          std::string cwd(currentDir);
           path = currentDir;
         }
 
-        libname = Utilities::MakePkgnameFromPath(path, pkgname);
+        fullDirectoryName = Utilities::MakePkgnameFromPath(path, upath, false);
 
       // Check if library exists           
-        if ( ! Utilities::FileExists(libname) )
+        if ( ! Utilities::IsDirectory(fullDirectoryName) )
         {
-          if (verbose)
-            std::cout <<"   [" <<libname <<"] : doesn't exist" <<std::endl;
-            continue;  // try next path
+        // The following is *NOT* a debug time message :
+        // It's a user intended message.
+        // Please don't remove it.
+         bbtkMessage("Interpreter",1,"   [" <<fullDirectoryName 
+                     <<"] : doesn't exist" <<std::endl);
+          continue;  // try next path
         }
         foundFile = true;
+
+
+        int nbFiles = Utilities::Explore(fullDirectoryName, false, Filenames);
+
+        nbBssFiles = 0;
+        for (std::vector<std::string>::iterator i = Filenames.begin(); i!= Filenames.end(); ++i)
+        {
+
+           if ((*i).substr((*i).size()-4, 4) != ".bbs")
+              continue;      // ignore non .bbs files
+           LoadScript(*i,name);
+           nbBssFiles++;
+        }
+        if (nbBssFiles==0)
+         bbtkMessage("Interpreter",1,
+                     "WARNING : No '.bbs' file found in [" 
+                     << fullDirectoryName << "]" << std::endl);
+           
+        //break; // a directory was found; we stop iterating
+       // LG : No! We want all files included !
+       }
+       return;
+    }
+
+    //std::string::size_type slash_position = name.find_last_of("/\\");
+
+    // if name starts with a / or a . or contains : user is assumed to have passed a relative/absolute name
+    // (not only a plain script name)
+    // we trust him, and try to expland the directory name
+    // WARNING : starting from current local directory :  ./whatYouWant  (./ mandatory!)
+
+    if (name[0]=='/' || name[1] == ':' || name[0]=='.')  // absolute path (linux/windows) or relative path
+    { 
+
+      // ===========================================================check user supplied location
+      fullnameGiven = true;
+
+      
+      fullPathScriptName =  Utilities::ExpandLibName(name, false);
+
+      // allow user to always forget ".bbs"
+      int l = fullPathScriptName.size();
+
+      if (l!=0) {
+      
+      if (l>4)
+      {
+         if (fullPathScriptName.substr(l-4, 4) != ".bbs")
+         {
+            fullPathScriptName = fullPathScriptName + ".bbs";
+         }
+      }
+      else
+      {
+         fullPathScriptName = fullPathScriptName + ".bbs";   
+      }
+
+        if ( Utilities::FileExists(fullPathScriptName))
+        {
+          foundFile = true;
+        }
+      } // endif l != 0
+    }
+    else 
+
+      // =============================================================== iterate on the paths
+      {
+      std::string path;
+      std::vector<std::string>::iterator i;
+      for (i=script_paths.begin();i!=script_paths.end();++i)
+      {
+
+        path = *i;
+       // we *really* want '.' to be the current working directory
+        if (path == ".") {
+          char buf[2048]; // for getcwd
+          char * currentDir = getcwd(buf, 2048);
+          std::string cwd(currentDir);
+          path = currentDir;
+        }
+
+       // fullPathScriptName = Utilities::MakePkgnameFromPath(path, name, true); //pkgname);
+
+           fullPathScriptName = Utilities::MakePkgnameFromPath(path, name, true);
+
+
+      // Check if library exists
+        if ( ! Utilities::FileExists(fullPathScriptName) )
+        {
+        // The following is *NOT* a debug time message :
+        // It's a user intended message.
+        // Please don't remove it.
+         bbtkMessage("Interpreter",2,
+                     "   [" <<fullPathScriptName <<"] : doesn't exist" 
+                     <<std::endl);
+          continue;  // try next path
+        }
+       bbtkMessage("Interpreter",2,
+                   "   [" <<fullPathScriptName 
+                   <<"] : found" <<std::endl);        
+        foundFile = true;
         break; // a script was found; we stop iterating
 
       } //------------------ // end for ( package_paths.begin();i!=package_paths.end() )
     }
 
-    std::ifstream* s;
-
     if (!foundFile)
     {
        if (fullnameGiven)
-         if(libname == "")
-            bbtkError("Path \""<<name<<"\" doesn't exist");
+         if(fullPathScriptName == "")
+            bbtkError("Path ["<<upath<<"] doesn't exist");
          else
-            bbtkError("Script \""<<libname<<"\" not found");
+            bbtkError("Script ["<<fullPathScriptName<<"] not found");
        else
-          bbtkError("No \""<<pkgname<<".bbs\" script found");
+          bbtkError("No ["<<pkgname<<".bbs] script found");
        return;    
     }
+    else
+      LoadScript(fullPathScriptName,name);
 
-    bbtkMessage("Interpreter",1,pkgname<<" loaded"<<std::endl);
-    
+    return;
+  }   
+   
+
+  //=======================================================================
+
+  void Interpreter::LoadScript( std::string fullPathScriptName,
+                               std::string includeScriptName)
+  {
+    if (find(mFileName.begin(),mFileName.end(),fullPathScriptName)
+       !=mFileName.end()) 
+      {
+       bbtkMessage("Interpreter",1,"file '"<<fullPathScriptName
+                   <<"' already open : I do not open it once more to prevent recursive inclusion"<<std::endl);
+       return;
+      }
+
+    std::ifstream* s;      
     s = new std::ifstream;
-    s->open(libname.c_str());
+    s->open(fullPathScriptName.c_str());
     if (!s->good()) 
     {
-        bbtkError("Could not open file \""<<libname<<"\"");
+        bbtkError("Could not open file ["<<fullPathScriptName<<"]");
         return;     
     }
-
-    if (verbose)
-       std::cout << "   -->[" << libname << "] found" << std::endl;
+    
+    bbtkMessage("Interpreter",1,"   -->[" << fullPathScriptName 
+               << "] found" << std::endl);
 
     mFile.push_back(s);
-    mFileName.push_back(libname);
+    mFileName.push_back(fullPathScriptName);
+    mIncludeFileName.push_back(includeScriptName);
     mLine.push_back(0);
-  }   
-   
-
-  //=======================================================================
-
+    return;  
+  }
 
   //=======================================================================
   /**
@@ -820,6 +990,7 @@ void Interpreter::SplitLine ( const std::string& str, std::vector<std::string>&
                      " Closing file '"<<mFileName.back()<<"'"<<std::endl);
     
     mFileName.pop_back();
+    mIncludeFileName.pop_back();
     mLine.pop_back();
     bbtkDebugMessage("Interpreter",9," Remains "
                      <<mFile.size()
@@ -846,6 +1017,7 @@ void Interpreter::SplitLine ( const std::string& str, std::vector<std::string>&
       bbtkDebugMessage("Interpreter",9,
                       " Closing file '"<<mFileName.back()<<"'"<<std::endl);
       mFileName.pop_back();
+      mIncludeFileName.pop_back();
       mLine.pop_back();
     }
     bbtkDebugMessage("Interpreter",9,"EO Interpreter::CloseAllFiles()"
@@ -864,7 +1036,7 @@ void Interpreter::SplitLine ( const std::string& str, std::vector<std::string>&
   {
     bbtkDebugMessageInc("Interpreter",9,"Interpreter::InterpretCommand(...)"<<std::endl);
     
-    // searches the command keyword
+    // searches the command category
     CommandDictType::iterator c;
     c = mCommandDict.find(words[0]);
     if ( c == mCommandDict.end() ) {
@@ -911,26 +1083,52 @@ void Interpreter::Help(const std::vector<std::string>& words)
          try 
          {
             HelpPackage(words[1]);
+#ifdef _USE_WXWIDGETS_
+           if ( WxConsole::GetInstance() != 0 )
+             {
+               std::string url = 
+                 ConfigurationFile::GetInstance().Get_doc_path();
+               url += "/bbdoc/" + words[1] + "/index.html";
+               if (Utilities::FileExists(url)) 
+                 {
+                   WxConsole::GetInstance()->ShowHtmlPage(url);
+                 }
+             }
+#endif     
          }
          catch (bbtk::Exception f) 
          {
             try 
             {
-               HelpBlackBox(words[1]);
-            }
-           catch (bbtk::Exception g) 
-           {
-              try
-              {
-                 this->mExecuter->ShowRelations(words[1],"0","9999");
-              }
-              catch (bbtk::Exception h){
-                bbtkError("\""<<words[1].c_str()
-                          <<"\" is not a known command, package, black box type or black box name");
-              }
-           }
+             std::string package;
+             HelpBlackBox(words[1],package);
+#ifdef _USE_WXWIDGETS_
+              if ( WxConsole::GetInstance() != 0 )
+                {
+                  std::string url = 
+                    ConfigurationFile::GetInstance().Get_doc_path();
+                  url += "/bbdoc/" + package + "/index.html";
+                  if (Utilities::FileExists(url)) 
+                    {
+                      url += "#" + words[1];
+                      WxConsole::GetInstance()->ShowHtmlPage(url);
+                    }
+                }
+#endif     
+           }
+           catch (bbtk::Exception g) 
+             {
+               try
+                 {
+                   this->mExecuter->ShowRelations(words[1],"0","9999");
+                 }
+               catch (bbtk::Exception h){
+                 bbtkError("\""<<words[1].c_str()
+                           <<"\" is not a known command, package, black box type or black box name");
+               }
+             }
          }
-       }
+      }
     }
     else if (nbarg==2) 
     {
@@ -964,46 +1162,11 @@ void Interpreter::Help(const std::vector<std::string>& words)
 
    //===================================================================    
   /// Displays the Configuration
-  void Interpreter::Config( bool verbose ) const
+  void Interpreter::Config() const
   {
-    bbtkDebugMessageInc("Core",9,"Factory::Config"<<std::endl);
-    
-    ConfigurationFile cf = ConfigurationFile::GetInstance();
-    
-    const std::string config_xml_full_path      = cf.Get_config_xml_full_path();    
-    const std::string description               = cf.Get_description();
-    const std::string url                       = cf.Get_url();
-    const std::string data_path                 = cf.Get_data_path();
-    const std::string default_doc_tmp           = cf.Get_default_doc_tmp();    
-    const std::string file_separator            = cf.Get_file_separator();    
-    const std::vector<std::string>bbs_paths     = cf.Get_bbs_paths();
-    const std::vector<std::string>package_paths = cf.Get_package_paths();
-    
-    bbtkMessage("Help",1, "============="   << std::endl);           
-    bbtkMessage("Help",1, "Configuration"   << std::endl);
-    bbtkMessage("Help",1, "============="   << std::endl);
-    bbtkMessage("Help",1, "bbtk_config.xml   : [" << config_xml_full_path  << "]" << std::endl); 
-    bbtkMessage("Help",1, "Documentation Url : [" << url             << "]" << std::endl);
-    bbtkMessage("Help",1, "Data Path         : [" << data_path       << "]" << std::endl);
-    bbtkMessage("Help",1, "Default Doc_tmp   : [" << default_doc_tmp << "]" << std::endl);
-    bbtkMessage("Help",1, "File Separator    : [" << file_separator  << "]" << std::endl);
-
-    std::vector<std::string>::const_iterator i;
-           
-    bbtkMessage("Help",1, "BBS Paths   " << std::endl);     
-    for (i = bbs_paths.begin(); i!=bbs_paths.end(); ++i )
-    {
-      bbtkMessage("Help",1,"--- ["<<*i<<"]"<<std::endl);
-    }    
-    
-    bbtkMessage("Help",1, "PACKAGE Paths : " << std::endl);     
-    for (i = package_paths.begin(); i!=package_paths.end(); ++i )
-    {
-      bbtkMessage("Help",1,"--- ["<<*i<<"]"<<std::endl);
-    }
-
-    bbtkDebugDecTab("Core",9);
+    ConfigurationFile::GetInstance().GetHelp(1);
   }  
+   //===================================================================    
 
   //=======================================================================
   /// Displays help on all the commands
@@ -1127,19 +1290,18 @@ void Interpreter::Help(const std::vector<std::string>& words)
     // empty lines are not stored in from history
           if (strlen(line)) 
           {
-               // if history too long : delete oldest command
-               if (mHistory.size()>MAX_HISTORY_SIZE) 
-                 {
-                   delete mHistory.front();
-                   mHistory.pop_front();
-                 }
-               mHistory.push_back(line);
+             // if history too long : delete oldest command
+             if (mHistory.size()>MAX_HISTORY_SIZE) 
+             {
+                delete mHistory.front();
+                mHistory.pop_front();
+             }
+             mHistory.push_back(line);
           }
-    
           break;
         }
-       // Backspace
-       else if ( (ind>0) && 
+       // Backspace
+        else if ( (ind>0) && 
                  ((c == BBTK_BACKSPACE_KBCODE) ||
                   (c == BBTK_DEL_KBCODE)) )
          {
@@ -1232,13 +1394,13 @@ void Interpreter::Help(const std::vector<std::string>& words)
            PrintChar(line[ind]);
            ind++;
          }
-       
+
        // Arrow left
        else if (ind>0 && c==BBTK_LEFT_ARROW_KBCODE)
          {
            PrintChar('\b');
            ind--;
-           
+    
          }
 
       }
@@ -1307,7 +1469,7 @@ void Interpreter::Help(const std::vector<std::string>& words)
     bool insideComment = false; // for multiline comment  
     do 
     {
-      try 
+      try
       {
         std::string line;
         GetLineFromPrompt(line);
@@ -1323,7 +1485,7 @@ void Interpreter::Help(const std::vector<std::string>& words)
       }
         catch (std::exception& e) 
       {
-        std::cerr << "* ERROR : "<<e.what()<<" (not in bbtk)"<<std::endl;
+        std::cerr << "* ERROR :: "<<e.what()<<" (not in bbtk)"<<std::endl;
       }
       catch (...)
       {
@@ -1341,10 +1503,10 @@ void Interpreter::Help(const std::vector<std::string>& words)
     bbtkDebugDecTab("Interpreter",9);
   }
 
-  //=======================================================================
-  void Interpreter::Graph(const std::vector<std::string>& words)
-  {
-    std::string page;
+//=======================================================================
+void Interpreter::Graph(const std::vector<std::string>& words)
+{
+  std::string page;
     bool system_display = true;
 
 #ifdef _USE_WXWIDGETS_
@@ -1376,17 +1538,30 @@ void Interpreter::Help(const std::vector<std::string>& words)
       page = mExecuter->ShowGraph(words[1],words[2],words[3],words[4],words[5],"",system_display);
     } 
     else if (words.size()==7) 
-    {
-      page = mExecuter->ShowGraph(words[1],words[2],words[3],words[4],words[5],words[6],system_display);
-    } 
-
+      {
+       page = mExecuter->ShowGraph(words[1],words[2],words[3],words[4],words[5],words[6],system_display);
+      
+    
 #ifdef _USE_WXWIDGETS_
     if ( WxConsole::GetInstance() != 0 )
       WxConsole::GetInstance()->ShowHtmlPage(page);
 #endif
   }
-  //=======================================================================
+//=======================================================================
+
 
+//=======================================================================
+void  Interpreter::Index(const std::string& filename, 
+                        const std::string& type)
+{
+  Factory::IndexEntryType t;
+  if (type=="Initials") t = Factory::Initials;
+  else if (type=="Categories") t = Factory::Categories;
+  else if (type=="Packages") t = Factory::Packages;
+  
+  GetGlobalFactory()->CreateHtmlIndex(t,filename);
+}
+//=======================================================================
 
 }//namespace