/*=========================================================================
                                                                                
  Program:   bbtk
  Module:    $RCSfile: bbtkBlackBoxDescriptor.cxx,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 bbtk::BlackBoxDescriptor : (abstract) describes a BlackBox (name, description, author) and is able to create an instance of it.
 */
#include "bbtkBlackBoxDescriptor.h"
#include "bbtkMessageManager.h"
#include "bbtkPackage.h"
#include "bbtkUtilities.h"

namespace bbtk
{
  
  //=========================================================================
  /// Default ctor
  BlackBoxDescriptor::BlackBoxDescriptor()  
    : mTypeName("Unknown"), 
      mDescription(""), 
      mAuthor(""),
      mCategory(STANDARD),
      mPackage(NULL)
  {
    bbtkDebugMessage("Core",9,
		     "BlackBoxDescriptor::BlackBoxDescriptor()"<<std::endl);
  }
  //=========================================================================

  //=========================================================================
  /// Dtor
  BlackBoxDescriptor::~BlackBoxDescriptor()
  {
    bbtkDebugMessageInc("Core",9,
			"BlackBoxDescriptor::~BlackBoxDescriptor() ["
			<<mTypeName<<"]"<<std::endl);

    // deletes all I/O descriptors
    InputDescriptorMapType::iterator i;
    for (i=mInput.begin(); i!=mInput.end(); ++i) delete i->second;
    OutputDescriptorMapType::iterator o;
    for (o=mOutput.begin(); o!=mOutput.end(); ++o) delete o->second;

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

  //=========================================================================
  /// Adds the string to the BlackBox's description
  void BlackBoxDescriptor::AddToDescription( const std::string& s, bool clear)
  {
    bbtkDebugMessage("Core",9,"BlackBoxDescriptor::AddToDescription(\""<<s<<
		     "\") ["<<GetTypeName()<<"]"<<std::endl);
    if (clear) mDescription = s; 
    else mDescription += s;
   }
  /// Adds the string to the BlackBox's author list
  void BlackBoxDescriptor::AddToAuthor( const std::string& s, bool clear)
  {
    bbtkDebugMessage("Core",9,"BlackBoxDescriptor::AddToAuthor(\""<<s<<"\") ["
		     <<GetTypeName()<<"]"<<std::endl);
    if (clear) mAuthor = s;
    else mAuthor += s;
  }
  //=========================================================================

  //=========================================================================
  const BlackBoxDescriptor::InputDescriptor* 
  BlackBoxDescriptor::GetInputDescriptor(const std::string & name) const
  {
    bbtkDebugMessageInc("Core",9,"BlackBoxDescriptor::GetInputDescriptor('"
			<<name<<"') ["<<GetTypeName()<<"]"<<std::endl);

    InputDescriptorMapType::const_iterator i;
    i = mInput.find(name);
    if ( i == mInput.end() ) 
      {
	bbtkError("input '"<<name<<"' does not exist");
      }
    bbtkDebugDecTab("Core",9);
    return i->second;
  }
  //=========================================================================

  //=========================================================================
  const BlackBoxDescriptor::OutputDescriptor* 
  BlackBoxDescriptor::GetOutputDescriptor(const std::string & name) const
  {
    bbtkDebugMessageInc("Core",9,"BlackBoxDescriptor::GetOutputDescriptor('"
			<<name<<"') ["<<GetTypeName()<<"]"<<std::endl);

    OutputDescriptorMapType::const_iterator i;
    i = mOutput.find(name);
    if ( i == mOutput.end() ) 
      {
	bbtkError("output '"<<name<<"' does not exist");
      }
    bbtkDebugDecTab("Core",9);
    return i->second;
  }
  //=========================================================================

  //=========================================================================
  void BlackBoxDescriptor::GetHelp(bool full) const
  {
    bbtkDebugMessageInc("Core",9,"BlackBoxDescriptor::GetHelp() ["<<GetTypeName()<<"]"<<std::endl);
    if (GetPackage()) 
	 {
    bbtkMessage("Help",1,"Black Box <"<<
		GetPackage()->GetName()<<"::"<<GetTypeName()<<">"<<std::endl);
		}
		else 
		{
	   bbtkMessage("Help",1,"Black Box <::"<<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->GetHumanTypeName().size()>typelmax) 
	  typelmax = i->second->GetHumanTypeName().size();
      }
    OutputDescriptorMapType::const_iterator o;
    for ( o = mOutput.begin();  o != mOutput.end(); ++o ) 
      {
	if (o->second->GetName().size()>namelmax) 
	  namelmax = o->second->GetName().size();
	if (o->second->GetHumanTypeName().size()>typelmax) 
	  typelmax = o->second->GetHumanTypeName().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->GetHumanTypeName());
	type += ">";
	type.append(1+typelmax-type.size(),' ');
	bbtkMessage("Help",1,
		    "    '"<<name
		    <<" <"<<type
		    <<" : "<<i->second->GetDescription()<<std::endl);
      }
    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->GetHumanTypeName());
	type += ">";
	type.append(1+typelmax-type.size(),' ');
	bbtkMessage("Help",1,
		    "    '"<<name
		    <<" <"<<type
		    <<" : "<<o->second->GetDescription()<<std::endl);
      }
   
     bbtkDebugDecTab("Core",9);
  

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

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

    (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";
    (s) << "</TABLE>\n";
    
    //-------------
    // Graph
    //i->second->InsertHTMLGraph( &s , detail,level,dir);
    
    //-------------
    // 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);
   }
  //=========================================================================
 
}