/*=========================================================================
                                                                                
  Program:   bbtk
  Module:    $RCSfile: bbtkComplexBlackBoxDescriptor.cxx,v $
  Language:  C++
  Date:      $Date: 2008/01/22 15:02:00 $
  Version:   $Revision: 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 bbtk::ComplexBlackBoxDescriptor : describes a ComplexBlackBox (constituents, connections) and is able to create an instance of it.
 */
#include "bbtkComplexBlackBoxDescriptor.h"
#include "bbtkComplexBlackBox.h"
//#include "bbtkFactory.h"
#include "bbtkMessageManager.h"
#include "bbtkUtilities.h"

namespace bbtk
{
  

  //=======================================================================
  /// Default ctor
  ComplexBlackBoxDescriptor::ComplexBlackBoxDescriptor(const std::string& name)
    : BlackBoxDescriptor()
  {
    bbtkDebugMessageInc("Core",9,"ComplexBlackBoxDescriptor::ComplexBlackBoxDescriptor(\""<<name<<"\")"<<std::endl);
    SetTypeName(name);
    mPrototype = new ComplexBlackBox(name+std::string("Prototype"),this);
    bbtkDebugDecTab("Core",9);
  }
  //=======================================================================



  //=======================================================================
  /// Default dtor
  ComplexBlackBoxDescriptor::~ComplexBlackBoxDescriptor()
  {
    bbtkDebugMessageInc("Core",9,"ComplexBlackBoxDescriptor::~ComplexBlackBoxDescriptor(\""<<GetTypeName()<<"\")"<<std::endl);

    delete mPrototype;

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


  //=======================================================================
  /// Creates an instance of name <name> of the ComplexBlackBox of which this is the descriptor 
  BlackBox* ComplexBlackBoxDescriptor::CreateInstance(const std::string& name)
  {
    //bbtkError("ComplexBlackBoxDescriptor::CreateInstance not implemented");
    bbtkDebugMessageInc("Core",5,
			"ComplexBlackBoxDescriptor::CreateInstance(\""
			<<name<<"\") ["
			<<GetTypeName()<<"]"<<std::endl);
    
    return mPrototype->bbClone(name);

    bbtkDebugDecTab("Core",5);
  }
  //=======================================================================



  //=======================================================================
  /// Adds a black box to the complex box
  void ComplexBlackBoxDescriptor::Add ( const std::string& type,
					const std::string& name
					)
  {
    bbtkDebugMessageInc("Core",5,
			"ComplexBlackBoxDescriptor::Add(\""
			<<type<<"\",\""<<name<<"\") ["
			<<GetTypeName()<<"]"<<std::endl);
    
    
    // Verify that a box with the same name does not exist already
    if ( mPrototype->bbUnsafeGetBlackBox( name ) ) 
      {
	bbtkError("a black box \""<<name<<"\" already exists");
      }
    // ok : create new one
    mPrototype->bbAddBlackBox ( /*mFactory->Create*/ NewBlackBox(type,name) );

    bbtkDebugDecTab("Core",5);
  }
  //=======================================================================

 //=======================================================================
  /// Adds a black box to the execution list 
  void ComplexBlackBoxDescriptor::AddToExecutionList ( const std::string& box)
  {
    bbtkDebugMessageInc("Core",5,
			"ComplexBlackBoxDescriptor::AddToExecutionList(\""
			<<box<<"\" ["
			<<GetTypeName()<<"]"<<std::endl);
    // Verify that the box exists
    BlackBox* b = mPrototype->bbUnsafeGetBlackBox( box ); 
    if ( !b ) 
      {
	bbtkError("the black box \""<<box<<"\" does not exist");
      }
    // ok 
    mPrototype->bbAddToExecutionList ( box  );

    bbtkDebugDecTab("Core",5);
    }


  //=======================================================================
  /// Connects two black boxes of the complex box
  void ComplexBlackBoxDescriptor::Connect ( const std::string& from,
					    const std::string& output,
					    const std::string& to,
					    const std::string& input
					    )
  {
    bbtkDebugMessageInc("Core",5,
			"ComplexBlackBoxDescriptor::Connect(\""
			<<from<<"\",\""<<output<<"\",\""
			<<to<<"\",\""<<input
			<<"\") ["
			<<GetTypeName()<<"]"<<std::endl);
  // Verify that a box with the same name does not exist already
    BlackBox* bbfrom = mPrototype->bbGetBlackBox( from );
    if ( !bbfrom ) 
      {
	bbtkError("the black box \""<<from<<"\" does not exist");
      }
    BlackBox* bbto = mPrototype->bbGetBlackBox( to );
    if ( !bbto ) 
      {
	bbtkError("the black box \""<<to<<"\" does not exist");
      }
    
    Connection* c = /*mFactory->*/ NewConnection( bbfrom, output, bbto, input );

    mPrototype->bbAddConnection(c);

    bbtkDebugDecTab("Core",5);
  }
  //=======================================================================


  //=======================================================================
  /// Defines an input of the complex box
  void ComplexBlackBoxDescriptor::DefineInput ( const std::string& name,
						const std::string& box,
						const std::string& input,
						const std::string& help)
  {
    bbtkDebugMessageInc("Core",5,
			"ComplexBlackBoxDescriptor::DefineInput(\""
			<<name<<"\",\""<<box<<"\",\""
			<<input<<"\",\""<<help
			<<"\") ["
			<<GetTypeName()<<"]"<<std::endl);

    BlackBox* bb = mPrototype->bbGetBlackBox( box );
    if ( !bb ) 
      {
	bbtkError("the black box \""<<box<<"\" does not exist");
      }

    if (!bb->bbHasInput(input) )
      {
	bbtkError("the black box \""<<box<<"\" does not have input \""
		  <<input<<"\"");
      }
    
    AddInputDescriptor ( new ComplexBlackBoxInputDescriptor ( name,
							      help,
							      box,
							      input,
							      bb->bbGetInputType(input)));
							     
    
    bbtkDebugDecTab("Core",5);
  }
  //=======================================================================

  //=======================================================================
  /// Defines an output of the complex box
  void ComplexBlackBoxDescriptor::DefineOutput ( const std::string& name,
						 const std::string& box,
						 const std::string& output,
						 const std::string& help)
  {
    bbtkDebugMessageInc("Core",5,
			"ComplexBlackBoxDescriptor::DefineOutput(\""
			<<name<<"\",\""<<box<<"\",\""
			<<output<<"\",\""<<help
			<<"\") ["
			<<GetTypeName()<<"]"<<std::endl);

    BlackBox* bb = mPrototype->bbGetBlackBox( box );
    if ( !bb ) 
      {
	bbtkError("the black box \""<<box<<"\" does not exist");
      }

    if (!bb->bbHasOutput(output) )
      {
	bbtkError("the black box \""<<box<<"\" does not have output \""
		  <<output<<"\"");
      }
    
    AddOutputDescriptor ( new ComplexBlackBoxOutputDescriptor 
			  ( name,
			    help,
			    box,
			    output,
			    bb->bbGetOutputType(output)));
    
    
    bbtkDebugDecTab("Core",5);
  }
  //=======================================================================

  //=======================================================================
  void ComplexBlackBoxDescriptor::PrintBlackBoxes()
  {
    mPrototype->bbPrintBlackBoxes(); 
  }
  //=======================================================================


  //=======================================================================
  void ComplexBlackBoxDescriptor::InsertHTMLGraph( std::ofstream& s , 
						   int detail, int level, 
						   const std::string& output_dir, bool relative_link )   
  {
    this->mPrototype->bbInsertHTMLGraph( s, 
					 detail, level, 
					 false, 
					 output_dir,
					 relative_link );
  }
  //=======================================================================

  //=========================================================================
  void ComplexBlackBoxDescriptor::InsertHtmlHelp ( std::ofstream& s, 
						   int detail, int level,
						   const std::string& output_dir, bool relative_link)
  {
    bbtkDebugMessageInc("Core",9,
			"ComplexBlackBoxDescriptor::InsertHtmlHelp() ["
			<<GetTypeName()<<"]"<<std::endl);
    
    //-------------
    // General info 
    std::string name = GetTypeName();
    Utilities::html_format(name);

    //   std::ofstream* s = &s1;

    (s) << "<p><hr>\n";
    (s) << "<a name=\""<<name<<"\"></a>\n";
    (s) << //"Top:&nbsp;
      "<a rel=\"top\" accesskey=\"t\" href=\"#Top\">Top</a>\n";
    // (s) << "Previous:&nbsp;<a rel="previous" accesskey="p" href="#dir">(dir)</a>,
    // (s) << "Up:&nbsp;<a rel="up" accesskey="u" href="#dir">(dir)</a>
    (s) << "<h2 class=\"section\">"<<name<<"</h2>\n";


    std::string descr = GetDescription();
    //Utilities::html_format(descr);
    std::string author = GetAuthor();
    Utilities::html_format(author);
    
    (s) << "<p><TABLE cellspacing=0  cellpadding=3>\n";
    (s) << "<TR><TD style='vertical-align: top;'><b> Description </b></TD><TD style='vertical-align: top;'> : </TD><TD style='vertical-align: top;'> " 
      << descr << "</TD></TR>\n";
    (s) << "<TR><TD style='vertical-align: top;'><b> Author(s) </b></TD><TD style='vertical-align: top;'> : </TD><TD style='vertical-align: top;'>  " 
      << author << "</TD></TR>\n";
     
    std::string inc = GetScriptFileName();
    if (inc.size()>0) 
      {
    (s) << "<TR><TD style='vertical-align: top;'><b> Include </b></TD><TD style='vertical-align: top;'> : </TD><TD style='vertical-align: top;'>  " 
      << inc << "</TD></TR>\n";
	
      }
    
    const ComplexBlackBox::BlackBoxMapType& B = mPrototype->bbGetBlackBoxMap();
	
    if (B.size()) 
      {
	(s) << "<TR><TD style='vertical-align: top;'><b> Dependencies </b></TD><TD style='vertical-align: top;'> : </TD><TD style='vertical-align: top;'>  ";
 


	std::set<BlackBoxDescriptor*> pdeps;
	ComplexBlackBox::BlackBoxMapType::const_iterator b;
	for ( b = B.begin(); b != B.end(); ++b ) 
	  {
	    BlackBoxDescriptor* d = b->second->bbGetDescriptor();
	    if (pdeps.find(d) != pdeps.end()) continue;
	    pdeps.insert(d);

	    Package* p = d->GetPackage();
	    
	    std::string name = b->second->bbGetTypeName();

	    std::string url;
	    if (relative_link) 
	      url = p->GetDocRelativeURL();
	    else 
	      url = p->GetDocURL();

	    s << "<a href=\"" <<url<<"#"<<name<<"\">" 
	      << p->GetName()<<"::"<<name<<"</a>\n";
	  }	
	
	(s) << "</TD></TR>\n";

      }

    (s) << "</TABLE>\n";

 
   //-------------
    // Graph
    InsertHTMLGraph( s , detail,level, output_dir, relative_link);
    
    //-------------
    // Inputs
    std::string col("#CCCCFF");
    
    //	(s) << "<h3 class=\"subsection\">Inputs</h3>\n";
    (s) << "<p><TABLE border=1 cellspacing=0 cellpadding=3>\n";
    (s) << "<TR><TD colspan=3 align=center bgcolor=\""<<col
      <<"\">Inputs</TD></TR>\n";
    const BlackBoxDescriptor::InputDescriptorMapType& imap = 
      GetInputDescriptorMap();
    
    InputDescriptorMapType::const_iterator in;
    
    for ( in = imap.begin();  in != imap.end(); ++in ) 
      {
	std::string name(in->second->GetName());
	Utilities::html_format(name);
	
	std::string type("<");
	type += in->second->GetTypeName();    
	type += ">";
	Utilities::html_format(type);
	
	std::string descr(in->second->GetDescription());
	//Utilities::html_format(descr);

	(s) << "<TR><TD style='vertical-align: top;'><B><PRE> "<<name<<" </PRE></B></TD>"
	  << "<TD style='vertical-align: top;'><I><PRE> "<<type<<" </PRE></I></TD>"
	  << "<TD style='vertical-align: top;'>"<<descr<<"</TD></TR>\n";
	
      }
    //	(s) << "</TABLE>\n";
    
    
    //-------------
    // Outputs
    //	(s) << "<h3 class=\"subsection\">Outputs</h3>\n";
    //	(s) << "<TABLE border=1 cellspacing=0>\n";
    (s) << "<TR><TD colspan=3 align=center bgcolor=\""<<col
      <<"\">Outputs</TD></TR>\n";
    
    const BlackBoxDescriptor::OutputDescriptorMapType& omap = 
      GetOutputDescriptorMap();
    
    BlackBoxDescriptor::OutputDescriptorMapType::const_iterator o;
    
    for ( o = omap.begin();  o != omap.end(); ++o ) 
      {
	std::string name(o->second->GetName());
	Utilities::html_format(name);
	
	std::string type("<");
	type += o->second->GetTypeName();    
	type += ">";
	Utilities::html_format(type);
	
	std::string descr(o->second->GetDescription());
	//Utilities::html_format(descr);
	
	
	(s) << "<TR><TD style='vertical-align: top;'><B><PRE> "<<name<<" </PRE></B></TD>"
	  << "<TD style='vertical-align: top;'><I><PRE> "<<type<<" </PRE></I></TD>"
	  << "<TD style='vertical-align: top;'>"<<descr<<"</TD></TR>\n";
	
      }
    (s) << "</TABLE>\n";

    //------------
    // End

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

  //=======================================================================
  void ComplexBlackBoxDescriptor::GetHelp(bool full) const
  {
    if (full) bbtkMessage("Help",1,"Complex Black Box <"<<
			  GetPackage()->GetName()<<"::"
			  <<GetTypeName()<<">"<<std::endl);
    bbtkMessage("Help",1," "<<GetDescription()<<std::endl);
    bbtkMessage("Help",1," By : "<<GetAuthor()<<std::endl);
    if (mInput.size()) 
      bbtkMessage("Help",1," * Inputs : "<<std::endl);
    else 
      bbtkMessage("Help",1," * No inputs"<<std::endl);
    InputDescriptorMapType::const_iterator i;
    unsigned int namelmax = 0;
    unsigned int typelmax = 0;
    for ( i = mInput.begin();  i != mInput.end(); ++i ) 
      {
	if (i->second->GetName().size()>namelmax) 
	  namelmax = i->second->GetName().size();
	if (i->second->GetTypeName().size()>typelmax) 
	  typelmax = i->second->GetTypeName().size();
      }
    OutputDescriptorMapType::const_iterator o;
    if (full) 
      {
	for ( o = mOutput.begin();  o != mOutput.end(); ++o ) 
	  {
	    if (o->second->GetName().size()>namelmax) 
	      namelmax = o->second->GetName().size();
	    if (o->second->GetTypeName().size()>typelmax) 
	      typelmax = o->second->GetTypeName().size();
	  }
      }
    //

    for ( i = mInput.begin();  i != mInput.end(); ++i ) 
      {
	std::string name(i->second->GetName());
	name += "'";
	name.append(1+namelmax-name.size(),' ');
	std::string type(i->second->GetTypeName());
	type += ">";
	type.append(1+typelmax-type.size(),' ');
	bbtkMessage("Help",1,
		    "    '"<<name
		    <<" <"<<type
		    <<" : "<<i->second->GetDescription()<<std::endl);
      }
    if (full) 
      {
	if (mOutput.size()) 
	  bbtkMessage("Help",1," * Outputs : "<<std::endl);
	else 
	  bbtkMessage("Help",1," * No outputs"<<std::endl);
	for ( o = mOutput.begin();  o != mOutput.end(); ++o ) 
	  {
	    std::string name(o->second->GetName());
	    name += "'";
	    name.append(1+namelmax-name.size(),' ');
	    std::string type(o->second->GetTypeName());
	    type += ">";
	    type.append(1+typelmax-type.size(),' ');
	    bbtkMessage("Help",1,
			"    '"<<name
			<<" <"<<type
			<<" : "<<o->second->GetDescription()<<std::endl);
	  }
      }
    if (full) 
      {
	const ComplexBlackBox::BlackBoxMapType& B = mPrototype->bbGetBlackBoxMap();
	
	if (B.size()) 
	  bbtkMessage("Help",1," * Boxes : "<<std::endl);
	else 
	  bbtkMessage("Help",1," * No boxes"<<std::endl);
	
	ComplexBlackBox::BlackBoxMapType::const_iterator b;
	for ( b = B.begin(); b != B.end(); ++b ) 
	  {
	    bbtkMessage("Help",1,"    '"<<b->second->bbGetName()<<
			"' <"
			<< b->second->bbGetDescriptor()->GetPackage()->GetName() 
			<<"::"
			<<b->second->bbGetTypeName()<<">"<<std::endl);
	  }
      }

  }   
  //=======================================================================



}