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

  Program:   bbtk
  Module:    $RCSfile: bbtkInterpreter.h,v $ $
  Language:  C++
  Date:      $Date: 2008/03/21 14:59:39 $
  Version:   $Revision: 1.20 $

  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 "bbtkVirtualExec.h"
#include "bbtkExecuter.h"
#include "bbtkTranscriptor.h"

#include <fstream>
#include <deque>

namespace bbtk
{

#ifdef _USE_WXWIDGETS_
  class WxConsole;
#endif
  
  class BBTK_EXPORT InterpreterUser
  {
  public: 
    InterpreterUser() {}
    ~InterpreterUser() {}

    virtual bool InterpreterUserHasOwnHtmlPageViewer() { return false; }
    virtual void InterpreterUserViewHtmlPage(const std::string&) {}


  };

  ///
  class BBTK_EXPORT InterpreterError : public Exception
  {
  public:
    InterpreterError( const std::string& message,
		      bool in_script_file,
		      const std::string& script_file,
		      int script_line 
		      );
    InterpreterError( const Exception& excep,
		      bool in_script_file,
		      const std::string& script_file,
		      int script_line 
		      );
    ~InterpreterError() throw() {}

    bool IsInScriptFile() const { return mInScriptFile; }
    const std::string& GetScriptFile() const { return mScriptFile; }
    int GetScriptLine() const { return mScriptLine; }
  private:
    bool mInScriptFile;
    std::string mScriptFile;
    int mScriptLine;
  };


  /// 
  class BBTK_EXPORT Interpreter
  {

  private:

    /// The enumeration of command codes == Command name
    typedef enum
    {
      cNew,
      cDelete,
      cConnect,
      cExec,
      cPackage,
      cEndPackage,
      cDefine,
      cEndDefine,
      cInput,
      cOutput,
      cSet,
      cConfig,  // JPR
      cReset,   // EED
      cAuthor, 
      cCategory, // JPR
      cDescription,
      cHelp,
      cMessage,
      cInclude,
      cQuit,
      cLoad,
      cUnload,
      cGraph,
      cPrint,
      cIndex,
      cWorkspace // LG
    } CommandCodeType;

    /// The structure storing the informations on a command 
    typedef struct 
    {
      std::string category;
      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();


    typedef enum 
      {
	Interpreter_OK,
	Interpreter_ERROR,
	Interpreter_QUIT
      }
      ExitStatus;

    /// Runs the interpretation of a file
    ExitStatus InterpretFile( const std::string& filename);

    /// Runs the interpretation of a buffer and deletes it !
    ExitStatus InterpretBuffer( std::stringstream* buffer );

    /// Runs the interpretation of a command
    ExitStatus InterpretLine( const std::string& line );


    /// 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;
    typedef VirtualExec::DialogModeType DialogModeType;

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

    /// Sets the bool that indicates wether we are in command line context
    void SetCommandLine(bool v = true) { mCommandLine = v; }

    void SetThrow(bool b) { mThrow = b; }

 
    
#ifdef _USE_WXWIDGETS_
    /// Sets the user of the interpreter (if any)
    void SetUser(InterpreterUser* c) { mUser = c; }
    /// Gets the InterpreterUser of this 
    InterpreterUser* GetUser() { return mUser; }
    /// Gets the InterpreterUser of this (const)
    const InterpreterUser* GetUser() const { return mUser; }

#endif

    /// Gets the Executer 
    VirtualExec* GetExecuter() { return mExecuter; }
    /// Gets the Executer (const)
    const VirtualExec* GetExecuter() const { return mExecuter; }


  protected:
    /// Interprets a line 
    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 );

   /// Switch to the interpretation of a stringstream
    void SwitchToStream( std::stringstream* stream );

    /// 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() const; 
    /// 
    void Print(const std::string&);

    void Index(const std::string& filename, 
	       const std::string& type = "Initials");
    ///
    void FindCommandsWithPrefix( char* buf,
				 int n,
				 std::vector<std::string>& commands );



  private:

    /// Opens the file fullPathScriptName 
    /// includeScriptName is the name as given to the include command 
    void LoadScript( std::string fullPathScriptName,
		     std::string includeScriptName);

    /// 
    void CatchBbtkException( const bbtk::Exception& e );
    void CatchStdException( const std::exception& e );
    void CatchUnknownException();

  private:

    //==================================================================
    // ATTRIBUTES

    /// The command executer used
    bbtk::VirtualExec* mExecuter;

    /// The user of  the interpreter (0 if none)
    bbtk::InterpreterUser* mUser;

    /// Vector of open files / buffers (can be stringstream)
    std::vector<std::istream*> mFile;

    /// Vector of names of open files with full path (as open)
    std::vector<std::string> mFileName;

    /// Vector of names of open files as given to the include command
    std::vector<std::string> mIncludeFileName;

    /// Stores the current line number in each open file
    std::vector<int> mLine;

    /// The dictionnary of commands
    CommandDictType mCommandDict;

    /// Are we in a command line context ?
    bool mCommandLine;

    /// The history of commands
    std::deque< char* > mHistory;

   int bufferNb;
    
    bool mThrow;

  };
  // EO class Interpreter


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

}
#endif