/*=========================================================================
                                                                                
  Program:   bbtk
  Module:    $RCSfile: bbtkInterpreter.cxx,v $ $
  Language:  C++
  Date:      $Date: 2008/02/04 13:02:58 $
  Version:   $Revision: 1.18 $
                                                                                
  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 
 *  \brief class Interpreter : 
 */

#include "bbtkInterpreter.h" 
#include "bbtkMessageManager.h"
#include "bbtkConfigurationFile.h"
#include "bbtkWxConsole.h"
#include "bbtkUtilities.h"
#include <sys/stat.h>
#ifdef CMAKE_HAVE_TERMIOS_H
#include <termios.h>
#define BBTK_USE_TERMIOS_BASED_PROMPT
#endif

#include <string>

namespace bbtk
{

Interpreter* Interpreter::mGlobalInterpreter = NULL;

 //=======================================================================
 /**
   *  
   */
  Interpreter::Interpreter() 
    :
    mCommandLine(false), verbose(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);
    bbtkDebugMessageInc("Interpreter",9,"Interpreter::Interpreter()" <<std::endl);
 
    mGlobalInterpreter = this;

    //    mFactory = new bbtk::Factory();
    mExecuter = new bbtk::Executer();
    //mExecuter->SetFactory(mFactory);

    // Builds the commands dict
    CommandInfoType info;
   
    info.keyword = "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;
    
    info.keyword = "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;

    info.keyword = "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;

    info.keyword = "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;

    info.keyword = "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.keyword = "package";
    info.argmin = 1;
    info.argmax = 1;
    info.code = cPackage;
    info.syntax = "package <name>";
    info.help = "Begins the definition of a package.";
    mCommandDict[info.keyword] = info;
    
    info.keyword = "endpackage";
    info.argmin = 0;
    info.argmax = 0;
    info.code = cEndPackage;
    info.syntax = "endpackage";
    info.help = "Ends the definition of a package.";
    mCommandDict[info.keyword] = info;

    info.keyword = "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;
    
    info.keyword = "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;

    info.keyword = "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;

    info.keyword = "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;

    info.keyword = "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;
   
    info.keyword = "config";  // JPR
    info.argmin = 0;
    info.argmax = 1;
    info.code = cConfig;
    info.syntax = "config [<verbose>|<v>]";
    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;
    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;

    info.keyword = "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;
    
    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;
    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;

    info.keyword = "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;

    info.keyword = "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.keyword = "include";
    info.argmin = 1;
    info.argmax = 1;
    info.code = cInclude;
    info.syntax = "include <filename>";
    info.help = "Includes the file <filename>";
    mCommandDict[info.keyword] = info;

    info.keyword = "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;

    info.keyword = "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;

    info.keyword = "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;

    info.keyword = "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;

    /*
    info.keyword = "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;
    */

    bbtkDebugDecTab("Interpreter",9);

  } 
  //=======================================================================
  
  
  
  //=======================================================================  
  /**
   *  
   */
  Interpreter::~Interpreter()
  {
    bbtkDebugMessageInc("Interpreter",9,"Interpreter::~Interpreter()" <<std::endl);
    delete mExecuter;
    //delete mFactory;

    //    std::cout <<"EO Interpreter::~Interpreter()"<<std::endl;
    bbtkDebugDecTab("Interpreter",9);
  }
  //=======================================================================


  //=======================================================================
  /**
   *  
   */
  void Interpreter::InterpretFile( const std::string& filename,  bool use_configuration_file, bool verbose)
  {
    bbtkDebugMessageInc("Interpreter",9,"Interpreter::InterpretFile(\""<<filename<<"\")"<<std::endl);

    bool exm = mCommandLine;
    mCommandLine = false;

    try 
    {
      SwitchToFile(filename, use_configuration_file, verbose);
      bool insideComment = false; // for multiline comment
      while (mFile.size()>0) 
      {
         while ((mFile.size()>0) && 
                (!mFile.back()->eof()))
         {
            mLine.back()++;
            char buf[500];
            mFile.back()->getline(buf,500);
      
            std::string str(buf);
            int size=str.length();
            if ( str[ size-1 ]==13  )
            {
               str.erase(size-1,1);
            }
      
            InterpretLine(str, insideComment);
         }
        //if (mFile.size()>0) 
        CloseCurrentFile();
      }
    }
    catch (QuitException e) 
    {
    }
    catch (bbtk::Exception e) 
    {
      std::cerr << "* ERROR : "<<e.GetMessage()<<std::endl;
      if (mFileName.size()) {
         std::cerr << "* FILE  : \""<<mFileName.back()<<"\""<<std::endl;
         std::cerr << "* LINE  : "<<mLine.back()<<std::endl;
      }    
    }
    catch (std::exception& e) 
    {
       std::cerr << "* ERROR : "<<e.what()<<" (not in bbtk)"<<std::endl;
       if (mFileName.size()) {
          std::cerr << "* FILE  : \""<<mFileName.back()<<"\""<<std::endl;
          std::cerr << "* LINE  : "<<mLine.back()<<std::endl;
       }    
    }  
    catch (...)
    {
       std::cout << "* UNDEFINED ERROR (not a bbtk nor a std exception)"<<std::endl;
       if (mFileName.size()) {
          std::cout << "* FILE  : \""<<mFileName.back()<<"\""<<std::endl;
          std::cout << "* LINE  : "<<mLine.back()<<std::endl;
      }    
    }

    CloseAllFiles();
    bbtkDebugMessage("Interpreter",9,"EO Interpreter::InterpretFile(\""<<filename<<"\")"<<std::endl);
    bbtkDecTab("Interpreter",9);

    mCommandLine = exm;
  }
  //=======================================================================



  //=======================================================================  
  /**
   *
   */
void Interpreter::InterpretLine( const std::string& line, bool &insideComment )
{

    bbtkDebugMessageInc("Interpreter",9,"Interpreter::InterpretLine(\""<<line<<"\")"<<std::endl);
    bbtkMessage("Echo",2,"\""<<line<<"\""<<std::endl);

    std::vector<std::string> words;
    SplitLine(line,words);

    // Empty line
    if (words.size()<1) 
    {
       bbtkDebugDecTab("Interpreter",9);
       return;
    }

    // Single line comment : # or //
    if ( words[0][0]=='#' || (words[0][0]=='/' && words[0][1]=='/') ) 
    {  
       bbtkDebugDecTab("Interpreter",9);
       bbtkMessage("Interpreter",9,"Comment"<<std::endl);
       return;
    }

    // Multi line comment ( /* ... */ ) -delimiters on different lines !-
    
    if (words[0][0]=='/' && words[0][1]=='*') 
    {  
       bbtkDebugDecTab("Interpreter",9);
       bbtkMessage("Interpreter",9,"In multiline comment"<<std::endl);
       insideComment = true;
       return;
    }

    if (words[0][0]=='*' && words[0][1]=='/') 
    {  
       bbtkDebugDecTab("Interpreter",9);
       bbtkMessage("Interpreter",9,"Out multiline comment"<<std::endl);
       if ( !insideComment ) {
          bbtkDebugDecTab("Interpreter",9);
          bbtkMessage("Interpreter",9,"Comment mismatch : '*/' with no matching '/*'"<<std::endl);       
       }
       insideComment = false;
       return;
    }

    if (insideComment) 
    {  
       bbtkDebugDecTab("Interpreter",9);
       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); 
    int level=0;
    std::string left,right,left2,right2;
    std::string filename;
    switch (command.code) 
    {
      case cNew :
        mExecuter->Create(words[1],words[2]);
        break;
        
      case cDelete :
        // 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;
        
      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],"",filename);
        }
        else 
        {
           mExecuter->Define(words[1],words[2],filename);
        }
        break;
        
      case cEndDefine :
        mExecuter->EndDefine();
        break;
        
      case cPrint :
        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;
        
      case cInput :
        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;
        
      case cSet :
        Utilities::SplitAroundFirstDot(words[1],left,right);
        mExecuter->Set(left,right,words[2]);
        break;
        
      case cAuthor :
        mExecuter->Author(words[1]);
        break;

    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 :
        Help(words);
        break;
        
      case cMessage : 
        if (words.size()<3) 
        {
            bbtk::MessageManager::PrintInfo();
        }
        else 
        {
           sscanf(words[2].c_str(),"%d",&level);
           bbtk::MessageManager::SetMessageLevel(words[1],level);
        }
        break;
        
      case cGraph : 
        Graph(words);
        break;
        
      case cConfig :
        if (words.size()>1) // any param for config means verbose = true
          verbose = true;
        else
          verbose = false;
        Config(verbose);            
        break;
        
      case cReset :  // EED
        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;
        
      case cLoad:
        LoadPackage(words[1], true, verbose); // true : better pass use_config_file
        break;
        
      case cUnload:
        UnLoadPackage(words[1]);
        break;
        
      case cQuit :
        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;
        
      default:
        bbtkInternalError("should not reach here !!!");
   }
    
   bbtkDecTab("Interpreter",9);
}
  //=======================================================================  





  //=======================================================================
  /**
   *  
   */
void Interpreter::SplitLine ( const std::string& str, std::vector<std::string>& tokens)
{
    bbtkDebugMessageInc("Interpreter",9,"Interpreter::SplitLine(\""<<str<<"\")"<<std::endl);
 
    std::string delimiters = "\"";
    std::vector<std::string> quote;
    Utilities::SplitString(str,delimiters,quote);

    delimiters = " \t";
    std::vector<std::string>::iterator i;
    for (i=quote.begin(); i!=quote.end(); ) 
    {
       Utilities::SplitString(*i,delimiters,tokens);
       ++i;
       if (i!=quote.end()) 
       {
        //    bbtkDebugMessage("Interpreter",0,"\""<<*i<<"\""<<std::endl);
          tokens.push_back(*i);
          ++i;
       }
    }

    for (i=tokens.begin(); i!=tokens.end(); ++i) 
    {
       bbtkDebugMessage("Interpreter",9,"["<<*i<<"] ");
    }
    bbtkDebugMessageCont("Interpreter",9,std::endl);

    bbtkDebugDecTab("Interpreter",9);    
 }
  //=======================================================================


  //=======================================================================
  // 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;
  }
  //=======================================================================


  //=======================================================================
  /**
   *  
   */
  void Interpreter::Print( const std::string& str)
  {
    if (mExecuter->GetNoExecMode()) return;

    bbtkDebugMessageInc("Interpreter",9,"Interpreter::SplitLine(\""<<str<<"\")"<<std::endl);

    std::vector<std::string> chains;
    std::string delimiters("$");

    // Skip delimiters at beginning.
    std::string::size_type lastPos = str.find_first_not_of(delimiters, 0);
    bool is_text = true;
    if (lastPos>0) is_text = false;
  
    // Find first delimiter.
    std::string::size_type pos     = str.find_first_of(delimiters, lastPos);
    
    while (std::string::npos != pos || std::string::npos != lastPos)
    {
       if (is_text) 
       {
          // 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 
       {
       // is an output (between $$) : decode 
         std::string tok,box,output;
         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);
        // Find next delimiter
       pos = str.find_first_of(delimiters, lastPos);
    //
       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) 
     {
       //  bbtkMessage("Echo",1,*i);
       SubsBackslashN(*i);
       std::cout << *i;
     }
     std::cout << std::endl;
     bbtkDebugDecTab("Interpreter",9);    
 }

  //=======================================================================
  /**
   *  
   */

// ===================================================================================

  void Interpreter::SwitchToFile( const std::string& name,
                                  bool use_configuration_file, bool verbose)
  {
  // 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);

// to be removed in final version
// use : Config v
//verbose = true;
    std::vector<std::string> script_paths;
    std::string fullPathScriptName;  // full path script name
    std::string pkgname;             // e.g. <scriptname>.bbs
    std::vector<std::string> Filenames;
        
    if (use_configuration_file)
    {
        // The following is *NOT* a debug time message :
        // It's a user intended message.
        // Please don't remove it.
      if (verbose)
         std::cout << "look for : [" << name << "] (use_configuration_file == TRUE)"  << std::endl;
      script_paths = ConfigurationFile::GetInstance().Get_bbs_paths();
    }
    std::string upath;
    pkgname = Utilities::ExtractScriptName(name,upath);
//std::cout <<"name [" <<   name << "] pkgname [" << pkgname << "] upath [" << upath << "]" << std::endl;    
    bool fullnameGiven = false; 
    bool foundFile     = false;

    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)
           if (verbose)
              std::cout << "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);
//std::cout <<"fullpath [" <<   fullDirectoryName << "]" <<std::endl;
      // 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.
          if (verbose)
            std::cout <<"   [" <<fullDirectoryName <<"] : doesn't exist" <<std::endl;
          continue;  // try next path
        }
        foundFile = true;


        int nbFiles = Utilities::Explore(fullDirectoryName, false, Filenames);
// std::cout << "=================nbFiles " << nbFiles << std::endl;
        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)
           if (verbose)
              std::cout << "WARNING : No '.bbs' file found in [" << fullDirectoryName << "]" << std::endl;
           
        break; // a directory was found; we stop iterating
       }
       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, verbose);

      // 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);
//std::cout << "FULL PATH = "<<fullPathScriptName<<std::endl;

      // 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 <<"   [" <<fullPathScriptName <<"] : doesn't exist" <<std::endl;
          continue;  // try next path
        }
        if (verbose)
           std::cout <<"   [" <<fullPathScriptName <<"] : found" <<std::endl;        
        foundFile = true;
        break; // a script was found; we stop iterating

      } //------------------ // end for ( package_paths.begin();i!=package_paths.end() )
    }

    if (!foundFile)
    {
       if (fullnameGiven)
         if(fullPathScriptName == "")
            bbtkError("Path ["<<upath<<"] doesn't exist");
         else
            bbtkError("Script ["<<fullPathScriptName<<"] not found");
       else
          bbtkError("No ["<<pkgname<<".bbs] script found");
       return;    
    }
    else
       LoadScript(fullPathScriptName);

    return;
  }   
   

  //=======================================================================

  void Interpreter::LoadScript( std::string fullPathScriptName)
  {
    bbtkMessage("Interpreter",1,fullPathScriptName<<" found"<<std::endl);

    std::ifstream* s;      
    s = new std::ifstream;
    s->open(fullPathScriptName.c_str());
    if (!s->good()) 
    {
        bbtkError("Could not open file ["<<fullPathScriptName<<"]");
        return;     
    }
    
    if (verbose)
       std::cout << "   -->[" << fullPathScriptName << "] found" << std::endl;

    mFile.push_back(s);
    mFileName.push_back(fullPathScriptName);
    mLine.push_back(0);
    return;  
  }

  //=======================================================================
  /**
   *  
   */
  void Interpreter::CloseCurrentFile()
  {
    bbtkDebugMessage("Interpreter",9,"Interpreter::CloseCurrentFile()"
                      <<std::endl);
    
    if (mFile.size()==0) 
    {
      bbtkDebugMessage("Interpreter",9," -> no file left open"<<std::endl);
      return;
    }

    mFile.back()->close();
    delete mFile.back();
    mFile.pop_back();
    bbtkDebugMessage("Interpreter",9,
                     " Closing file '"<<mFileName.back()<<"'"<<std::endl);
    
    mFileName.pop_back();
    mLine.pop_back();
    bbtkDebugMessage("Interpreter",9," Remains "
                     <<mFile.size()
                     <<" open"<<std::endl);
    bbtkDebugMessage("Interpreter",9,"EO Interpreter::CloseCurrentFile()"
                     <<std::endl);
  }
  //=======================================================================

 //=======================================================================
  /**
   *  
   */
  void Interpreter::CloseAllFiles()
  {
    bbtkDebugMessage("Interpreter",9,"Interpreter::CloseAllFiles()"
                      <<std::endl);
    
    while (mFile.size() != 0) 
    {
      mFile.back()->close();
      delete mFile.back();
      mFile.pop_back();
      bbtkDebugMessage("Interpreter",9,
                      " Closing file '"<<mFileName.back()<<"'"<<std::endl);
      mFileName.pop_back();
      mLine.pop_back();
    }
    bbtkDebugMessage("Interpreter",9,"EO Interpreter::CloseAllFiles()"
                      <<std::endl);
  }
  //=======================================================================



  //=======================================================================
  /**
   *  
   */
  void Interpreter::InterpretCommand( const std::vector<std::string>& words,
                                      CommandInfoType& info )
  {
    bbtkDebugMessageInc("Interpreter",9,"Interpreter::InterpretCommand(...)"<<std::endl);
    
    // searches the command keyword
    CommandDictType::iterator c;
    c = mCommandDict.find(words[0]);
    if ( c == mCommandDict.end() ) {
      bbtkError(words[0]<<" : unknown command");
    }

    // tests the number of args 
    if ( ( words.size()-1 < c->second.argmin ) ||
         ( words.size()-1 > c->second.argmax ) )
    {
       HelpCommand(words[0]);
       bbtkError(words[0]<<" : wrong number of arguments");
    }

    info = c->second;
    bbtkDecTab("Interpreter",9);
  }
  //=======================================================================


  //=======================================================================
  /// Displays help on all the commands
void Interpreter::Help(const std::vector<std::string>& words)
{
    unsigned int nbarg = words.size()-1;
    
    if (nbarg==0) 
    {
       HelpCommands();
    }
    else if (nbarg==1) 
    {
      if (words[1]=="packages") 
      {
         PrintPackages(true);
         return;
      }
      try 
      {
          HelpCommand(words[1]);
      }
      catch (bbtk::Exception e) 
      {
         try 
         {
            HelpPackage(words[1]);
         }
         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");
              }
           }
         }
       }
    }
    else if (nbarg==2) 
    {
      if (words[2]=="all")
      {
         if ( words[1]=="packages" )
         {
            PrintPackages(true,true);
            return;
          }
         try 
         {
            HelpPackage(words[1],true);
         }
         catch (bbtk::Exception f) 
         {
         }
     }
     else 
     {
        HelpCommand(words[0]);
        bbtkError(words[0]<<" : syntax error");
     }
  }
  else 
  {
     bbtkError("Should not reach here !!!");
  }
}
  //=======================================================================

   //===================================================================    
  /// Displays the Configuration
  void Interpreter::Config( bool verbose ) 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);
  }  

  //=======================================================================
  /// Displays help on all the commands
  void Interpreter::HelpCommands()
  {
    std::cout << "Available commands :" << std::endl;
    CommandDictType::iterator i;
    for ( i =  mCommandDict.begin();
          i != mCommandDict.end();
        ++i) {
              std::cout << " " << i->first << std::endl;
      //      std::cout << "   usage : " << i->second.syntax << std::endl;
      //     std::cout << "    " << i->second.help << std::endl;
 
    }
  }
  //=======================================================================


  //=======================================================================
  /// Displays help on a particular commands
  void Interpreter::HelpCommand(const std::string& s)
  {
    CommandDictType::iterator c;
    c = mCommandDict.find(s);
    if ( c == mCommandDict.end() ) {
      bbtkError(s<<" : Unknown command");
    }
    //    std::cout << " " << s << " : "<<  std::endl;
    //    CommandParamDictType::iterator i;
    //    for ( i =  c->second.begin();
    //      i != c->second.end();
    //      ++i) {
    std::cout << " usage : " << c->second.syntax << std::endl;
    std::cout << "  " << c->second.help << std::endl;
    
  }
  //=======================================================================


  //=======================================================================
  /// Fills the vector commands with the commands which 
  /// have the first n chars of buf for prefix
  /// TODO : skip initial spaces in buf and also return the position of first
  /// non blank char in buf
  void Interpreter::FindCommandsWithPrefix( char* buf,
                                            int n,
                                            std::vector<std::string>& commands )
  {
    CommandDictType::const_iterator i;
    for (i=mCommandDict.begin(); i!=mCommandDict.end(); ++i)
    {
      if ((i->first).find(buf,0,n) == 0) 
        commands.push_back(i->first);
    }
  }
  //=======================================================================


  
  //=======================================================================
#ifdef BBTK_USE_TERMIOS_BASED_PROMPT
  
  inline void PrintChar(char c) { write(STDOUT_FILENO,&c,1); }
  inline void BackSpace() { write(STDOUT_FILENO,"\b \b",3); }
  
  // LG : KEYBOARD CODES AS SCANNED ON MY TTY : UNIVERSAL ?
  // IF NOT THE USER SHOULD BE ABLE TO CONFIGURE IT
  // E.G. STORE THIS IN bbtk_config.xml
#define BBTK_UP_ARROW_KBCODE    0x00415B1B
#define BBTK_DOWN_ARROW_KBCODE  0x00425B1B
#define BBTK_RIGHT_ARROW_KBCODE 0x00435B1B
#define BBTK_LEFT_ARROW_KBCODE  0x00445B1B
#define BBTK_BACKSPACE_KBCODE   0x00000008
#define BBTK_DEL_KBCODE         0x0000007F
#define BBTK_SPACE_KBCODE       0x00000020 

  //=======================================================================
  void Interpreter::GetLineFromPrompt(std::string& s)
  {
    int c;
    int ind=0;
    
    int MAX_LINE_SIZE = 160;
    int MAX_HISTORY_SIZE = 100;
    
    char* newline = new char[MAX_LINE_SIZE];
    memset(newline,0,MAX_LINE_SIZE);
    char* histline = new char[MAX_LINE_SIZE];
    memset(histline,0,MAX_LINE_SIZE);
    
    char* line = newline;
    int hist = mHistory.size();
    
    
    write(1,"> ",2);
    while(1)
    {
       c=0;
       read ( STDIN_FILENO, &c, 4) ;

       bbtkDebugMessage("Debug",9,"[0x"<<std::hex<<c<<"]\n");

       // Printable character
       if ( (ind<MAX_LINE_SIZE-1) &&
            ( c >= BBTK_SPACE_KBCODE ) && 
            ( c <  BBTK_DEL_KBCODE )) 
       {
          PrintChar(c);
          line[ind++]=c;
       }
      // CR
       else if (c=='\n')
       {
       // delete the unused line
          if (line==newline)
              delete histline;
          else
              delete newline;
   
    // 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);
          }
          break;
        }
       // Backspace
        else if ( (ind>0) && 
		  ((c == BBTK_BACKSPACE_KBCODE) ||
		   (c == BBTK_DEL_KBCODE)) )
	  {
	    line[ind--]=' ';
	    BackSpace();
	  }
	// Tab 
	else if (c=='\t')
	  {
	    // TODO : Command completion  
	    std::vector<std::string> commands;
	    FindCommandsWithPrefix( line,ind,commands);
	    if (commands.size()==1) 
	      {
		std::string com = *commands.begin();
		for (; ind<com.size(); ++ind) 
		  {
		    PrintChar(com[ind]); 
		    line[ind]=com[ind];
		  }
		PrintChar(' '); 
		line[ind++]=' ';
	      }
	    else if (commands.size()>1) 
	      {
		std::vector<std::string>::iterator i;
		write(1,"\n",1);
		for (i=commands.begin();i!=commands.end();++i) 
		  {
		    write(STDOUT_FILENO,(*i).c_str(),strlen((*i).c_str()));
		    PrintChar(' ');
		  }
		write(STDOUT_FILENO,"\n> ",3);
		//for (int j=0;j<ind;++j) 
		  //{
		    write(STDOUT_FILENO,line,ind); 
		    //  }
	      }
	  }
	// Arrow up : back in history
	else if (c==BBTK_UP_ARROW_KBCODE)
	  {
	    if (hist) 
	      {
		// erase current line
		while (ind--) BackSpace();
		// 
		hist--;
		// 
		strcpy(histline,mHistory[hist]);
		line = histline;
		ind = strlen(line);
		
		write(STDOUT_FILENO,line,ind);
	      }
	  }
	// Arrow down : down in history
	else if (c==BBTK_DOWN_ARROW_KBCODE)
	  {
	    if (hist<mHistory.size()-1) 
	      {
		// erase current line
		while (ind--) BackSpace();
		// 
		hist++;
		// 
		strcpy(histline,mHistory[hist]);
		line = histline;
		ind = strlen(line);
		
		write(STDOUT_FILENO,line,ind);
	      }
	    // end of history : switch back to newline
	    else if (hist==mHistory.size()-1)
	      {
		// erase current line
		while (ind--) BackSpace();
		// 
		hist++;
		// 
		line = newline;
		ind = strlen(line);
		
		write(STDOUT_FILENO,line,ind);
	      }
	  }
	// Arrow right
	else if (line[ind]!=0 && c==BBTK_RIGHT_ARROW_KBCODE)
	  {
	    PrintChar(line[ind]);
	    ind++;
	  }

	// Arrow left
	else if (ind>0 && c==BBTK_LEFT_ARROW_KBCODE)
	  {
	    PrintChar('\b');
	    ind--;
    
	  }

      }
    write(STDOUT_FILENO,"\n\r",2);
    
    
    s = line;
    
  }
#else

  //=======================================================================
  void Interpreter::GetLineFromPrompt(std::string& s)
  {  
    s.clear();

    putchar('>');
    putchar(' ');

    do 
    {
      char c = getchar();
      if (c=='\n') 
      {
        putchar('\n');
        break;
      }
      if (c=='\t') 
      {
        // putchar('T');
        continue;
      }
      // putchar(c);
      s += c;
    } 
    while (true);  
    
  }
  //=======================================================================  

#endif



  //=======================================================================
  void Interpreter::CommandLineInterpreter()
  {
    bbtkDebugMessageInc("Interpreter",9,
                        "Interpreter::CommandLineInterpreter()"<<std::endl);
    
#ifdef BBTK_USE_TERMIOS_BASED_PROMPT  
    // Initialise the tty in non canonical mode with no echo
    // oter remembers the previous settings to restore them after 
    struct termios ter,oter;
    tcgetattr(0,&ter);
    oter=ter;
    ter.c_lflag &= ~ECHO;
    ter.c_lflag &= ~ICANON;
    ter.c_cc[VMIN]=1;
    ter.c_cc[VTIME]=0;
    tcsetattr(0,TCSANOW,&ter);
#endif
    
    mCommandLine = true;
    bool again = true;
    bool insideComment = false; // for multiline comment  
    do 
    {
      try
      {
        std::string line;
        GetLineFromPrompt(line);
        InterpretLine(line, insideComment);
      }
      catch (QuitException e)
      {
        again = false;
      }
      catch (bbtk::Exception e) 
      {
        e.Print();
      }
        catch (std::exception& e) 
      {
        std::cerr << "* ERROR :: "<<e.what()<<" (not in bbtk)"<<std::endl;
      }
      catch (...)
      {
        std::cerr << "* UNDEFINED ERROR (not a bbtk nor a std exception)"<<std::endl;
      }
    }
    while (again);
  
#ifdef BBTK_USE_TERMIOS_BASED_PROMPT
    tcsetattr(0,TCSANOW,&oter);
#endif
  
    std::cout << "Good bye !" << std::endl;
    
    bbtkDebugDecTab("Interpreter",9);
  }

//=======================================================================
void Interpreter::Graph(const std::vector<std::string>& words)
{
  std::string page;
    bool system_display = true;

#ifdef _USE_WXWIDGETS_
    if ( WxConsole::GetInstance() != 0 ) system_display = false; 
#endif
 
    if (words.size()==1) 
    {
      page = mExecuter->ShowGraph(".","0","0","","","",system_display);
    }
    else if (words.size()==2) 
    {
      page = mExecuter->ShowGraph(words[1],"0","0","","","",system_display);
    }
    else if (words.size()==3) 
    {
      page = mExecuter->ShowGraph(words[1],words[2],"0","","","",system_display);
    }
    else if (words.size()==4) 
    {
      page = mExecuter->ShowGraph(words[1],words[2],words[3],"","","",system_display);
    } 
    else if (words.size()==5) 
    {
      page = mExecuter->ShowGraph(words[1],words[2],words[3],words[4],"","",system_display);
    } 
    else if (words.size()==6) 
    {
      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);
      } 
    
#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