]> Creatis software - bbtk.git/blobdiff - kernel/src/bbtkInterpreter.cxx
No longer 'Categories', only 'Kinds'!
[bbtk.git] / kernel / src / bbtkInterpreter.cxx
index ca1bd896e3d918bbc82a4f77c881c10f889fadb5..d5f08d28d644f82a03b86a4d5b2ec15de1e4e3c7 100644 (file)
@@ -3,8 +3,8 @@
   Program:   bbtk
   Module:    $RCSfile: bbtkInterpreter.cxx,v $ $
   Language:  C++
-  Date:      $Date: 2008/01/28 15:08:53 $
-  Version:   $Revision: 1.6 $
+  Date:      $Date: 2008/02/05 11:07:42 $
+  Version:   $Revision: 1.22 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -44,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);
@@ -157,12 +157,20 @@ Interpreter* Interpreter::mGlobalInterpreter = NULL;
    
     info.keyword = "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;
 
+    info.keyword = "index";  // LG
+    info.argmin = 0;
+    info.argmax = 2;
+    info.code = cIndex;
+    info.syntax = "index [<filename> ['Initials'(default)|'Packages'|'Keywords']]";
+    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 'Keywords' is provided then the entries are either the package names or the keywords";
+    mCommandDict[info.keyword] = info;
+
     info.keyword = "reset";  //EED
     info.argmin = 0;
     info.argmax = 0;
@@ -178,6 +186,14 @@ Interpreter* Interpreter::mGlobalInterpreter = NULL;
     info.syntax = "author <string>";
     info.help = "Adds the string <string> to the author information of the black box being defined";
     mCommandDict[info.keyword] = info;
+    
+    info.keyword = "keyword"; //JP
+    info.argmin = 1;
+    info.argmax = 1;
+    info.code = cKeyword;
+    info.syntax = "keyword <list of items, separated by ;>";
+    info.help = "Adds the string <string> to the keyword information of the black box being defined";
+    mCommandDict[info.keyword] = info;
 
     info.keyword = "description";
     info.argmin = 1;
@@ -200,9 +216,8 @@ Interpreter* Interpreter::mGlobalInterpreter = NULL;
     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.keyword] = info;
 
     info.keyword = "include";
     info.argmin = 1;
@@ -271,7 +286,6 @@ Interpreter* Interpreter::mGlobalInterpreter = NULL;
     delete mExecuter;
     //delete mFactory;
 
-    //    std::cout <<"EO Interpreter::~Interpreter()"<<std::endl;
     bbtkDebugDecTab("Interpreter",9);
   }
   //=======================================================================
@@ -281,7 +295,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);
 
@@ -290,7 +305,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) 
       {
@@ -494,9 +509,21 @@ void Interpreter::InterpretLine( const std::string& line, bool &insideComment )
       case cAuthor :
         mExecuter->Author(words[1]);
         break;
-        
-      case cDescription :
-        mExecuter->Description(words[1]);
+
+    case cKeyword :
+      mExecuter->Keyword(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 :
@@ -520,11 +547,7 @@ void Interpreter::InterpretLine( const std::string& line, bool &insideComment )
         break;
         
       case cConfig :
-        if (words.size()>1) // any param for config means verbose = true
-          verbose = true;
-        else
-          verbose = false;
-        Config(verbose);            
+        Config();            
         break;
         
       case cReset :  // EED
@@ -534,16 +557,16 @@ void Interpreter::InterpretLine( const std::string& line, bool &insideComment )
       case cInclude :
         if (mCommandLine) 
         {
-           InterpretFile(words[1], true, verbose); // true : better pass use_config_file
+           InterpretFile(words[1], true ); // true : better pass use_config_file
         }
         else 
         {
-            SwitchToFile(words[1], true, verbose); // true : better pass use_config_file
+            SwitchToFile(words[1], true ); // true : better pass use_config_file
         }
         break;
         
       case cLoad:
-        LoadPackage(words[1], true, verbose); // true : better pass use_config_file
+        LoadPackage(words[1], true ); // true : better pass use_config_file
         break;
         
       case cUnload:
@@ -576,28 +599,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);
-      }
-    
-  }
-  //=======================================================================
-
 
 
   //=======================================================================
@@ -610,13 +611,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()) 
        {
@@ -641,18 +642,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;
   }
   //=======================================================================
 
@@ -684,7 +682,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 
        {
@@ -693,7 +690,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);
@@ -702,7 +698,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) 
      {
@@ -722,7 +717,7 @@ 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 
@@ -731,59 +726,158 @@ void Interpreter::SplitLine ( const std::string& str, std::vector<std::string>&
   //      - 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);
-verbose = true;
+
     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 (false) //slash_position != std::string::npos)
-    {       // ------------------------------------- check user supplied location 
+
+    if(pkgname == "*") // =========================================== load all boxes (e.g. std/boxes/*)
+    {
+      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)
+        {
+           if ((*i).substr((*i).size()-4, 4) != ".bbs")
+              continue;      // ignore non .bbs files
+           LoadScript(*i);
+           nbBssFiles++;
+        }
+        if (nbBssFiles==0)
+           bbtkMessage("Interpreter",2,
+                      "WARNING : No '.bbs' file found in [" 
+                      << upath << "]" << std::endl);
+
+        return;
+      }
+      
+
+      std::string path;
+      std::vector<std::string>::iterator i;
+      std::string fullDirectoryName;
+      for (i=script_paths.begin();i!=script_paths.end();++i)// ==== relative name, iterate + load all .bbs files
+      {
+        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;
+        }
+
+        fullDirectoryName = Utilities::MakePkgnameFromPath(path, upath, false);
+
+      // Check if library exists           
+        if ( ! Utilities::IsDirectory(fullDirectoryName) )
+        {
+        // 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);
+           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;
-      libname =  Utilities::ExpandLibName(name, verbose);
+
+      
+      fullPathScriptName =  Utilities::ExpandLibName(name, false);
 
       // allow user to always forget ".bbs"
-      int l = libname.size();
-      if (l>4) 
-      {       
-         if (libname.substr(l-4, 4) != ".bbs")
+      int l = fullPathScriptName.size();
+
+      if (l!=0) {
+      
+      if (l>4)
+      {
+         if (fullPathScriptName.substr(l-4, 4) != ".bbs")
          {
-            libname = libname + ".bbs";    
+            fullPathScriptName = fullPathScriptName + ".bbs";
          }
       }
       else
       {
-         libname = libname + ".bbs";
+         fullPathScriptName = fullPathScriptName + ".bbs";   
       }
 
-      if (libname != "") {
-        if ( Utilities::FileExists(libname))
+        if ( Utilities::FileExists(fullPathScriptName))
         {
           foundFile = true;
         }
-      }
+      } // endif l != 0
     }
-    else    // ------------------------------------- iterate on the paths
-    {
+    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;
 
+        path = *i;
        // we *really* want '.' to be the current working directory
         if (path == ".") {
           char buf[2048]; // for getcwd
@@ -792,58 +886,78 @@ verbose = true;
           path = currentDir;
         }
 
-        libname = Utilities::MakePkgnameFromPath(path, name); //pkgname);
-      // Check if library exists           
-        if ( ! Utilities::FileExists(libname) )
+       // 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.
-          if (verbose)
-            std::cout <<"   [" <<libname <<"] : doesn't exist" <<std::endl;
+         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");
        return;    
     }
+    else
+       LoadScript(fullPathScriptName);
 
-    bbtkMessage("Interpreter",1,pkgname<<" loaded"<<std::endl);
-    
+    return;
+  }   
+   
+
+  //=======================================================================
+
+  void Interpreter::LoadScript( std::string fullPathScriptName)
+  {
+    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);
     mLine.push_back(0);
-  }   
-   
-
-  //=======================================================================
-
+    return;  
+  }
 
   //=======================================================================
   /**
@@ -1011,7 +1125,7 @@ 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);
     
@@ -1174,19 +1288,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)) )
          {
@@ -1279,13 +1392,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--;
-           
+    
          }
 
       }
@@ -1388,10 +1501,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_
@@ -1423,18 +1536,31 @@ 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=="Keywords") t = Factory::Keywords;
+  else if (type=="Packages") t = Factory::Packages;
+  
+  GetGlobalFactory()->CreateHtmlIndex(t,filename);
+}
+//=======================================================================
+
 }//namespace