/*=========================================================================
                                                                                
  Program:   bbtk
  Module:    $RCSfile: bbtkVirtualExec.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 VirtualExec: level 0 of script execution (header)
 */
/**
 *  \class bbtk::VirtualExec 
 *  \brief class VirtualExec: level 0 of script execution 
 */
  
#ifndef __bbtkVirtualExec_h__
#define __bbtkVirtualExec_h__

#include "bbtkSystem.h"
#include "bbtkComplexBlackBox.h"
#include "bbtkFactory.h"
#include <string>
#include <deque>

namespace bbtk
{

  class /*BBTK_EXPORT*/ VirtualExec   // All methods are pure virtual
  {

  public:
    typedef enum 
    {
       NoDialog,
       TextDialog,
       GraphicalDialog
    }
    DialogModeType;
    
/*
    /// Constructor
    VirtualExec();

    /// 
    //  void SetFactory(Factory* f);
      
    /// Destructor
    virtual ~VirtualExec() = 0;
*/    
    /// Sets the inputs of the workspace : 
    virtual void SetInputs(const std::map<std::string,std::string>& m) = 0;

    /// Puts the executer in "no exec" mode, 
    /// which creates but does not execute pipelines 
    virtual void SetNoExecMode(bool b) = 0;

    virtual bool GetNoExecMode() const = 0;

    /// Sets the mode of dialog of the executer for Root inputs 
    virtual void SetDialogMode(DialogModeType t) = 0;

    /// Starts the definition of a new ComplexBlackBox in package pack
    /// scriptfilename is the file from which the def is read
    virtual void Define (const std::string &name,
		 const std::string& pack,
		 const std::string &scriptfilename) = 0;

    /// End the definition of a ComplexBlackBox
    virtual void EndDefine () = 0;

    /// Creates a new black box in current complex box
    virtual void Create ( const std::string& boxType, const std::string&
    boxName) = 0;

    /// Destroys a black box
    //virtual void Destroy (const std::string &boxName) = 0;

    /// Connects the output boxOutput to the input boxInput
    virtual void Connect (const std::string &boxfrom,
		  const std::string &output,
		  const std::string &boxto,
		  const std::string &input) = 0;

    /// Updates the box 
    /// would 'Execute' be more meaningfull ?
    virtual void Update (const std::string &box) = 0;

    /// Defines an input of the current complex box
    virtual void DefineInput (const std::string &name,
		      const std::string &box,
		      const std::string &input,
		      const std::string &help) = 0;

    /// Defines an output of the current complex box
    virtual void DefineOutput (const std::string &name,
		       const std::string &box,
		       const std::string &output,
		       const std::string &help) = 0;     
  
    /// sets the input of the box with the value
    virtual void Set (const std::string &box, 
	      const std::string &input, 
	      const std::string &value) = 0;

   /// gets the output of the box
    virtual std::string Get (const std::string &box, 
		     const std::string &output) = 0;

    /// changes the workspace name
    virtual void SetWorkspaceName( const std::string& n ) = 0;

    ///Adds the authorName to the Box's author list
    virtual void Author(const std::string &authorName) = 0;

    /// The description string which explains what does the ComplexBox
    virtual void Description(const std::string & d) = 0;

    /// prints the list off the boxes of the current box
    virtual void PrintBoxes() = 0;

   /// Generate a HTML with a gif file with the actual pipeline (Graphviz-dot needed). Returns the file path
    virtual std::string ShowGraph(const std::string &nameblackbox, 
			  const std::string &detailStr, 
			  const std::string &levelStr,
			  const std::string &output_file,
			  const std::string &custom_header,
			  const std::string &custom_title,
			  bool system_display = true) = 0;

	/// Generate a HTML with a gif file with the actual pipeline (Graphviz-dot needed). Returns the file path
    virtual std::string ShowGraphInstances(const std::string &nameblackbox, int detail, int level, bool system_display=true) = 0;

/// Description of the actual pipeline
	virtual void ShowRelations(const std::string &nameblackbox, const std::string &detailStr, const std::string &levelStr) = 0;

	virtual void Reset() = 0;
/*
  //  static const std::string& GetObjectDescription() = 0;
  //  { static std::string s("VirtualExec"); return s; }
*/
  protected:

  private:

    /// Gets the current working black box 
    virtual ComplexBlackBoxDescriptor* Current() = 0;
    
    /// Returns true when we are inside a define/endefine block
    //    virtual bool InDefinitionBlock() = 0;

    //==================================================================
    // ATTRIBUTES
     
    /// The factory used
    //   Factory* mFactory;

    /// The Root Package
    Package* mPackage;
    
    /// The root ComplexBlackBox, in which operations are done when outside a define/endefine block
    /// Its name in bbi is 'workspace'  
    ComplexBlackBoxDescriptor* mRoot;
    
    /// Struct that stores info on user defined complex black boxes
    struct CBBDefinition
    {
      ComplexBlackBoxDescriptor* box;
      std::string package;
      CBBDefinition(ComplexBlackBoxDescriptor* d, const std::string& p )
        : box(d), package(p) {}
    };

    /// The stack of current working ComplexBlackBox
    /// (is a stack for nested definitions)
    /// only contains the root when outside a define/endefine block
    std::deque<CBBDefinition> mCurrent;

    /// flag which is true when we are inside a Define/EndDefine block
    //    bool mDefineFlag;
    
    /// The input values of the Root ComplexBlackBox
    std::map<std::string,std::string> mInputs;
    
    /// no exec mode flag
    bool mNoExecMode;

    /// Dialog mode
    DialogModeType mDialogMode;
  };
}
#endif