/*=========================================================================
                                                                                
  Program:   bbtk
  Module:    $RCSfile: bbtkInterpreter.h,v $ $
  Language:  C++
  Date:      $Date: 2008/01/22 15:02:00 $
  Version:   $Revision: 1.1.1.1 $
                                                                                
  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 : The bbtk language interpreter
 */
/**
 *  \class bbtk::Interpreter 
 *  \brief The bbtk language interpreter
 */
  
#ifndef __bbtkInterpreter_h__
#define __bbtkInterpreter_h__


#include "bbtkExecuter.h"
#include <fstream>
#include <deque>

namespace bbtk
{
 
 
  class BBTK_EXPORT Interpreter
  {

  private:
    
    /// The enumeration of command codes == Command name
    typedef enum 
    {
      cNew, 
      cDelete,
      cConnect,
      cExec,
      cDefine,
      cEndDefine,
      cInput,
      cOutput,
      cSet,
      cConfig,  // JPR
      cReset,   // EED
      cAuthor,
      cDescription,
      cHelp,
      cMessage,
      cInclude,
      cQuit,
      cLoad,
      cUnload,
      cGraph,
      cPrint,
      cWorkspace // LG 
    } CommandCodeType;
    
    /// The structure storing the informations on a command 
    typedef struct 
    {
      std::string keyword;
      int argmin, argmax;
      CommandCodeType code;
      std::string syntax;
      std::string help;
    } CommandInfoType;



    /// The type of dictionnary of commands 
    typedef std::map<std::string,CommandInfoType> CommandDictType;

  public:
    /// Constructor
    Interpreter();  
    /// Destructor
    ~Interpreter();
      
   static Interpreter* mGlobalInterpreter;

    /// Launches a command line interpreter (with a prompt)
    void CommandLineInterpreter();
    
    /// Sets the inputs of the workspace : 
    /// the map is passed as is to the Executer
    void SetInputs(const std::map<std::string,std::string>& m)
    { mExecuter->SetInputs(m); }
 
    /// Puts the executer in "no exec" mode, 
    /// which creates but does not execute pipelines.
    void SetNoExecMode(bool b) { mExecuter->SetNoExecMode(b); }

    /// 
    typedef Executer::DialogModeType DialogModeType;

    void SetDialogMode(DialogModeType t) { mExecuter->SetDialogMode(t); }

    /// Runs the interpretation of a file
    void InterpretFile( const std::string& filename, bool use_configuration_file=true, bool verbose=false);

    /// Interprets a line (either from a file or typed interactively)
    void InterpretLine( const std::string& line, bool &insideComment );

    /// Reads a line from prompt
    void GetLineFromPrompt( std::string& line );

    /// Splits a line into words
    void SplitLine ( const std::string& line,
                     std::vector<std::string>& words );

    /// Executes the right action depending on the command name  
    void InterpretCommand( const std::vector<std::string>& words, 
                           CommandInfoType& info );
    
    /// Switch to the interpretation of a file
    void SwitchToFile( const std::string& filename, bool use_configuration_file=true, bool verbose=false );
    
    /// Closes the currently open file
    void CloseCurrentFile();
    
    /// Closes all open files
    void CloseAllFiles();

    /// Displays help (entry point of any help)
    void Help(const std::vector<std::string>& words);
    
    /// Displays help on all the commands
    void HelpCommands();
    
    /// Displays help on a particular command 
    void HelpCommand( const std::string& command );
    
    ///
    void Graph(const std::vector<std::string>& words);
    
    ///
    void Config(bool verbose) const; // JPR
    /// 
    void Print(const std::string&);
    
    /// Splits the string in around the first dot encountered
    void SplitAroundFirstDot( const std::string& in,
                              std::string& left,
                              std::string& right);
    ///
    void FindCommandsWithPrefix( char* buf,
				 int n,
				 std::vector<std::string>& commands );
             
    /// Sets the bool that indicates wether we are in command line context
    void SetCommandLine(bool v = true) { mCommandLine = v; }

  private:
  /// the methods for include bbs
  bool FileExists(std::string strFilename);
  std::string ExtractScriptName(const std::string &name);
  std::string ExpandLibName(const std::string &name, bool v);  
  std::string MakeLibnameFromPath(std::string path, std::string pkgname);
  bool IsAtRoot(std::string cwd);       
    
  private:
  
    //==================================================================
    // ATTRIBUTES
    /// The factory
    //    bbtk::Factory* mFactory;
    /// The command executer  
    bbtk::Executer* mExecuter;
    /// Vector of opened files  
    std::vector<std::ifstream*> mFile; 
    /// Vector of names of open files  
    std::vector<std::string> mFileName; 
    /// Stores the current line number in each open file
    std::vector<int> mLine; 
    /// The dictionnary of commands
    CommandDictType mCommandDict;
    /// Are we in a command line context ?
    bool mCommandLine;
    /// The history of commands 
    std::deque< char* > mHistory; 
    
    bool verbose; // true -> displays the search results (for packages)
  };


  // The "Quit" exception
  struct QuitException : public bbtk::Exception
  {
    QuitException() : bbtk::Exception("","","") {}
  };



}
#endif