/*=========================================================================
                                                                                
  Program:   bbtk
  Module:    $RCSfile: bbtkPackage.cxx,v $
  Language:  C++
  Date:      $Date: 2008/02/05 11:07:42 $
  Version:   $Revision: 1.3 $
                                                                                
  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::Package : registers black boxes descriptors and is able to create instances of the black boxes registered.
 */
#include "bbtkPackage.h"
#include "bbtkMessageManager.h"
#include "bbtkConfigurationFile.h"
#include <fstream>
#include <time.h>
#include "bbtkUtilities.h"

namespace bbtk
{
  //==========================================================================
  /// Ctor with the name of the package
  Package::Package(const std::string& name,
		   const std::string& author,
		   const std::string& description,
		   const std::string& version,
		   const std::string& BBTKVersion) 
    : mName(name),
      mAuthor(author),
      mDescription(description),
      mVersion(version),
      mBBTKVersion(BBTKVersion)
  {
    std::string default_doc_dir = ConfigurationFile::GetInstance().Get_default_doc_tmp();
    char c = default_doc_dir.c_str()[strlen(default_doc_dir.c_str())-1];
    std::string url = default_doc_dir; 
    if (c != '/' && c !='\\') url = url + "/";
    url = url +  "doc_tmp/" + name + "/index.html";    
    
    SetDocURL(url);
    SetDocRelativeURL("Relative url not set");

    /*
    std::string relurl(BBTK_STRINGIFY_SYMBOL(BBTK_DOC_REL_PATH));
    relurl += "/packages/"+name+"/bbdoc/index.html";
    std::string url = ConfigurationFile::GetInstance().Get_url()
      + relurl; 
    SetDocURL(url);
    SetDocRelativeURL(relurl);   
    */

    //    std::cout  << "   url=["<<url<<"]"<<std::endl;
    //    std::cout  << "relurl=["<<relurl<<"]"<<std::endl;
    bbtkDebugMessage("Core",7,"Package::Package(\""<<name<<"\")"<<bbtkendl);
  }
  //==========================================================================



  //==========================================================================
  /// Dtor
  Package::~Package()
  {
    bbtkDebugMessageInc("Core",7,"Package::~Package(\""<<mName<<"\")"<<bbtkendl);
    BlackBoxMapType::const_iterator i;
    for (i=mBlackBoxMap.begin();
         i!=mBlackBoxMap.end();
       ++i) 
     {
        delete i->second;
     } 
    // Adaptors are also stored in the black box map : hence already deleted
    /*
    AdaptorMapType::const_iterator j;
    for (j=mAdaptorMap.begin();
         j!=mAdaptorMap.end();
       ++j) 
      {
         delete j->second;
      }
    */ 
    bbtkDebugDecTab("Core",7);
  }
  //==========================================================================



  //==========================================================================
  /// Creates an instance of a black box of type <type> with name <name>
  BlackBox* Package::NewBlackBox(const std::string& type, 
				    const std::string& name) const
  {
    bbtkDebugMessageInc("Core",8,"Package<"<<GetName()<<">::NewBlackBox(\""<<type<<"\",\""<<name<<"\")"<<bbtkendl);
    
    BlackBoxMapType::const_iterator i = mBlackBoxMap.find(type);
    if (i == mBlackBoxMap.end())  
    {
	   bbtkDebugDecTab("Core",8);
	   return 0;
    }
    BlackBox* bb =i->second->CreateInstance(name);
    bbtkDebugDecTab("Core",8);
    return bb;   

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



  //==========================================================================
  /// Creates an instance of an adaptor of input type <typein> and 
  /// output type <typeout>  with name <name>
  BlackBox* Package::NewAdaptor(TypeInfo typein,
				   TypeInfo typeout,
				   const std::string& name) const
  {
    bbtkDebugMessageInc("Core",8,"Package<"<<GetName()<<
			">::NewAdaptor(<"
			<<TypeName(typein)<<">,<"
			<<TypeName(typeout)<<">,\""
			<<name<<"\")"<<bbtkendl);

    AdaptorKey key(typein,typeout);
    AdaptorMapType::const_iterator i = mAdaptorMap.find(key);
    if (i == mAdaptorMap.end())  
      {
	bbtkDebugDecTab("Core",8);
	return 0;
      }
    BlackBox* bb =i->second->CreateInstance(name);
    bbtkDebugDecTab("Core",8);
    return bb;   

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




  //==========================================================================
  /// Registers a black box descriptor in the package
  bool Package::RegisterBlackBox(BlackBoxDescriptor* d) 
  {
    bbtkDebugMessageInc("Core",8,"Package<"<<GetName()<<">::RegisterBlackBox(\""<<d->GetTypeName()<<"\")"<<std::endl);
    
    mBlackBoxMap[d->GetTypeName()] = d;
    d->SetPackage(this);
    
    // If it is a default adaptor, also register it in the adaptors map
    if ( d->GetKind() == BlackBoxDescriptor::DEFAULT_ADAPTOR) 
      {
	TypeInfo typein = d->GetInputDescriptor("In")->GetTypeInfo();
	TypeInfo typeout = d->GetOutputDescriptor("Out")->GetTypeInfo();
	AdaptorKey key(typein,typeout);
	AdaptorMapType::const_iterator i = mAdaptorMap.find(key);
	if (i == mAdaptorMap.end())  
	  {
	    bbtkDebugMessage("Core",8,"The box is an adaptor, inserting it in adaptors map ..."<<std::endl);   
	    mAdaptorMap[key] = d;
	  }
	// If already an adaptor registered : error
	else 
	  {
	    bbtkError("Package <"<<GetName()<<
		      "> : trying to register black box <"
		      <<d->GetTypeName()
		      <<"> as default adaptor but there is already a default adaptor registered (<"
		      <<i->second->GetTypeName()<<">)");
	  }
      }
    
    bbtkDebugDecTab("Core",8);
   
    return true;
  }
  //==========================================================================
  

  //==========================================================================
  /// UnRegisters a black box descriptor from the package
  void Package::UnRegisterBlackBox(const std::string& name) 
  {
    bbtkDebugMessageInc("Core",8,"Package<"<<GetName()<<">::UnRegisterBlackBox(\""<<name<<"\")"<<std::endl);
    // Looking into the bb map
    BlackBoxMapType::iterator i = mBlackBoxMap.find(name);
    if (i == mBlackBoxMap.end())  
    {
       bbtkDebugDecTab("Core",8);
       bbtkError("UnRegister : The package <"<<GetName()<<"> does not contains the black box <"<<name<<">");
     }
    mBlackBoxMap.erase(i);
    // Is it also in the adaptors map ?
    /*
    AdaptorMapType::iterator j = mAdaptorMap.find(name);
    if (j != mAdaptorMap.end())  
      {
         mAdaptorMap.erase(j);
      }
    */    
    bbtkDebugDecTab("Core",8);    
  }
  //==========================================================================

  //==========================================================================
  /// Changes the name of a black box type
  void Package::ChangeBlackBoxName( const std::string& oldname, const std::string& newname )
  { 
    bbtkDebugMessageInc("Core",8,"Package<"<<GetName()<<">::ChangeBlackBoxName(\""<<oldname<<"\",\""<<newname<<"\")"<<std::endl);
    // Looking into the bb map
    BlackBoxMapType::iterator i = mBlackBoxMap.find(oldname);
    if (i == mBlackBoxMap.end())  
      {
         bbtkDebugDecTab("Core",8);
         bbtkError("ChangeBlackBoxName : The package <"<<GetName()<<"> does not contains the black box <"<<oldname<<">");
      }

    i->second->SetTypeName(newname);
    mBlackBoxMap[newname] = i->second;
    mBlackBoxMap.erase(i);

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

  /*

  //==========================================================================
  /// Registers an adaptor descriptor in the package
  bool Package::RegisterAdaptor(BlackBoxDescriptor* d) 
  {
    bbtkDebugMessage("Core",8,"Package<"<<GetName()<<">::RegisterAdaptor(\""<<d->GetTypeName()<<"\")"<<std::endl);
    
    TypeInfo typein = d->GetInputDescriptor("In")->GetTypeInfo();
    TypeInfo typeout = d->GetOutputDescriptor("Out")->GetTypeInfo();
    AdaptorKey key(typein,typeout);
    
    mAdaptorMap[key] = d;
    return true;
  }
  //==========================================================================
  */


  //==========================================================================
  /// Displays the list of black boxes of the package
  void Package::PrintBlackBoxes(bool description, bool adaptors) const
  {
    unsigned int lmax = 0;
    std::vector<std::string> names;
    std::vector<std::string> kinds;
    std::vector<std::string> descrs;

    BlackBoxMapType::const_iterator i;
    for (i=mBlackBoxMap.begin();
	 i!=mBlackBoxMap.end();
	 ++i) 
      {
	if ( adaptors || 
	     ( i->second->GetKind() == BlackBoxDescriptor::STANDARD) ) 
	  {
	    std::string name("  ");
	    name += i->second->GetTypeName();
	    names.push_back(name);

	    std::string kind;
	    if ( i->second->GetKind() == BlackBoxDescriptor::ADAPTOR )
	      {
		kind = std::string("[A]");
	      }
	    else if ( i->second->GetKind() == 
		      BlackBoxDescriptor::DEFAULT_ADAPTOR )
	      {
		kind = std::string("[DA]");
	      }
	    kinds.push_back(kind);

	    unsigned int l = name.size()+kind.size();
	    if (l>lmax) lmax = l;

	    std::string descr;
	    if (description) 
	      {
		descr += " : ";
		descr += i->second->GetDescription();
	      } 
	    descrs.push_back(descr);
	  }
      } 
    

    std::string offs;
    offs.append(lmax+3,' ');
    std::vector<std::string>::iterator ni,ci,di;
    for (ni = names.begin(), ci = kinds.begin(), di = descrs.begin();
	 ni != names.end(); ++ni, ++ci, ++di)
      {
	std::string space;
	space.append(lmax - ni->size() - ci->size(),' ');
	bbtkMessage("Help",1,*ni << space << *ci );
	std::string d(*di);
	unsigned int dmax = 75 - lmax;
	//	while (d.size() > dmax ) 
	//  {
	if (d.size()>dmax) 
	  bbtkMessage("Help",1,d.substr(0,dmax) << "..." << std::endl);
	else 
	  bbtkMessage("Help",1,d << std::endl);
	//    d = d.substr(dmax,d.size());
	//  }
      }

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

  //==========================================================================
  /// Displays the list of adaptors of the package
  void Package::PrintAdaptors(bool description) const
  {
    BlackBoxMapType::const_iterator i;
    for (i=mBlackBoxMap.begin();
	 i!=mBlackBoxMap.end();
	 ++i) 
      {
	if ( i->second->GetKind() != BlackBoxDescriptor::STANDARD ) 
	  {
	    bbtkMessage("Help",1,
			"  "<<i->second->GetTypeName());
	    if ( i->second->GetKind() == 
		 BlackBoxDescriptor::DEFAULT_ADAPTOR )
	      {
		bbtkMessage("Help",1,
			    " [default]");
	      }  
	    if (description) 
	      {
		bbtkMessage("Help",1,
			    " : "<<i->second->GetDescription());

	      } 
	    bbtkMessage("Help",1,std::endl);
	  }
      } 
    /*
    AdaptorMapType::const_iterator i;
    for (i=mAdaptorMap.begin();
	 i!=mAdaptorMap.end();
	 ++i) 
      {
	bbtkMessage("Help",1,
		    "  "<<i->second->GetTypeName());
	if (detail_level>0) 
	  {
	    bbtkMessage("Help",1,
			" : "<<i->second->GetDescription());
  
	  } 
	bbtkMessage("Help",1,std::endl);
      }
    */ 
  }
  //==========================================================================

  //==========================================================================
  /// Prints help on a black box
  void Package::HelpBlackBox(const std::string& name, bool full) const
  {
    bbtkDebugMessageInc("Core",8,"Package<"<<GetName()<<">::HelpBlackBox(\""
			<<name<<"\")"<<bbtkendl);

    BlackBoxMapType::const_iterator i = mBlackBoxMap.find(name);
    if (i == mBlackBoxMap.end())  
      {
	bbtkDebugDecTab("Core",8);
	bbtkError("The package <"<<GetName()<<"> does not contains the black box <"<<name<<">");
      }
    //    bbtkMessage("Help",1,"["<<GetName()<<"] ");
    i->second->GetHelp(full);
    bbtkDebugDecTab("Core",8);

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


  //==========================================================================
  /// Returns true iff the package contains the box of name boxname
  bool Package::ContainsBlackBox(const std::string& name) const 
  {
    bbtkDebugMessageInc("Core",8,"Package<"<<GetName()<<">::HelpBlackBox(\""
			<<name<<"\")"<<bbtkendl);
    
    BlackBoxMapType::const_iterator i = mBlackBoxMap.find(name);
    if (i == mBlackBoxMap.end())  
    {
      bbtkDebugDecTab("Core",8);
      return false;
    }
    bbtkDebugDecTab("Core",8);
    return true;
  }
  //==========================================================================


 
  //==========================================================================
  void Package::CreateHtmlPage(const std::string& filename,
			       const std::string& caller,
			       const std::string& source,
			       const std::string& custom_header,
			       const std::string& custom_title,
			       int detail, 
			       int level,
			       bool relative_link ) const
  {
    bbtkDebugMessageInc("Core",9,"Package<"<<GetName()<<">::CreateHtmlPage(\""
			<<filename<<"\")"<<bbtkendl);

    //---------------------
    // Open output file
    std::ofstream s;
    s.open(filename.c_str());
    if (!s.good()) 
    {
       bbtkError("Package "<<GetName()<<" : CreateHtmlPage : could not open file '"<<filename<<"'");
    }
    
    //----------------------
    // Html head
    std::string title = "BBTK Package "+GetName()+" "+GetVersion(); 

    if (custom_title.length() != 0) title = custom_title;

    s << "<html lang=\"en\">\n";
    s << "<head>\n";
    s << "<title>" << title << "</title>\n";
    s << "<meta http-equiv=\"Content-Type\" content=\"text/html\">\n";
    s << "<meta name=\"description\" content=\""<<title<<"\">\n";
    s << "<meta name=\"generator\" content=\"\">\n";
    s << "<link title=\"Top\" rel=\"top\" href=\"#Top\">\n";
    //<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
    s << "<meta http-equiv=\"Content-Style-Type\" content=\"text/css\"><style type=\"text/css\"><!--\n";
    s << "pre.display { font-family:inherit }\n";
    s << "pre.format  { font-family:inherit }\n";
    s << "pre.smalldisplay { font-family:inherit; font-size:smaller }\n";
    s << "pre.smallformat  { font-family:inherit; font-size:smaller }\n";
    s << "pre.smallexample { font-size:smaller }\n";
    s << "pre.smalllisp    { font-size:smaller }\n";
    s << "span.sc    { font-variant:small-caps }\n";
    s << "span.roman { font-family:serif; font-weight:normal; } \n";
    s << "span.sansserif { font-family:sans-serif; font-weight:normal; }\n"; 
    s << "--></style>\n";
    s << "</head>\n";
    //----------------------

    //----------------------
    // Html body
    s << "<body>\n";
    s << "<a name=\"Top\"></a>\n"; 
    
    //----------------------
    // Header
    if ( custom_header.length() != 0) 
      {
	if ( custom_header != "none" )
	  { 
	    std::ifstream in;
	    in.open(custom_header.c_str());    
	    if (!in.good()) 
	      {
		bbtkError("Could not open file \""<<custom_header<<"\"");
	      }
	    char buffer[512];
	    while (!in.eof()) 
	      {
		in.getline(buffer,512);
		std::string line(buffer);
		s << line;
	      }
	    in.close();
	    s << "<hr>\n";
	   
	    /*   
	    s << "<object data=\"" << custom_header 
	      << "\" type = \"text/html\"\"style=\"width: 1200px; height: 400px;\"> Warning: "
	      << custom_header <<" could not be embedded.</object>\n";
	    
	    s << "<hr>\n";
	    */
	  }
      }

    else 
      {
	s << "<h1 class=\"settitle\">"<<title<<"</h1>\n";
	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;'> " 
	  << GetDescription() << "</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;'>  " 
	  << GetAuthor() << "</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;'>  " 
	  << GetKeyword() << "</TD></TR>\n";
  	s << "<TR><TD style='vertical-align: top;'><b> Version </b></TD><TD style='vertical-align: top;'> : </TD><TD style='vertical-align: top;'> " 
	  << GetVersion() << "</TD></TR>\n";
	s << "<TR><TD style='vertical-align: top;'><b> bbtk Version </b></TD><TD style='vertical-align: top;'> : </TD><TD style='vertical-align: top;'> " 
	  << GetBBTKVersion() << "</TD></TR>\n";
	s << "</TABLE>\n";
      }

    //-------------------
    // Table of contents
    // Black boxes list
    //  s << "<div class=\"contents\">\n";
    s << "<p><b> Black Boxes : </b>\n";
    s << "<ul>\n";

    s << "<p><TABLE cellspacing=0  cellpadding=3>\n";

    BlackBoxMapType::const_iterator i;
    for (i=mBlackBoxMap.begin(); i!=mBlackBoxMap.end(); ++i) 
      {
	if ( i->second->GetKind() != BlackBoxDescriptor::STANDARD) 
	  continue;
	
	std::string name = i->second->GetTypeName();
	Utilities::html_format(name);
	std::string descr = i->second->GetDescription();

        s << "<TR>";
	s << "<TD style='vertical-align: top;'>";
	s << "<li><a name=\"toc_"<<name
	  <<"\" href=\"#"<<name<<"\">"
	  <<name<<"</a>";
	s << "</TD> ";
	s << " <TD style='vertical-align: top;'>" << descr << " </TD>";
        s << "</TR>\n";
      }    
    s << "</TABLE>\n";
    
    
    s << "</li></ul>\n";
    s << "</div>\n";
    
    //-------------------
    // Adaptors list
    if (mAdaptorMap.size()>0) 
      {
	//  s << "<div class=\"contents\">\n";
	s << "<p><b> Adaptors : </b>\n";
	s << "<ul>\n";

	//    BlackBoxMapType::const_iterator i;
	s << "<p><TABLE cellspacing=0  cellpadding=3>\n";
	for (i=mBlackBoxMap.begin(); i!=mBlackBoxMap.end();++i) 
	  {
	    if ( i->second->GetKind() == BlackBoxDescriptor::STANDARD) 
	      continue;
    
	    std::string name = i->second->GetTypeName();
	    Utilities::html_format(name);
	    std::string descr = i->second->GetDescription();
    
	    s << "<TR>";
	    s << "<TD style='vertical-align: top;'>";
	    s << "<li><a name=\"toc_"<<name
	      <<"\" href=\"#"<<name<<"\">"
	      <<name<<"</a>";
	    s << "</TD> ";
	    s << " <TD style='vertical-align: top;'>" << descr << " </TD>";
	    s << "</TR>\n";
	  }    
	s << "</TABLE>\n";

	s << "</li></ul>\n";
	s << "</div>\n";
      }
    
    
    //  s << "<div class=\"node\">\n";

    //    s << "<p><hr>\n";
    //    s << "<a name=\"Top\"></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 << "</div>\n";

    //----------------------
    // Boxes doc

    //-------------------
    // Computes output directory from filename to pass it to 
    // BlackBoxDescriptor::InsertHtmlHelp
    std::string dir;
    std::string::size_type slash_position = 
      filename.find_last_of(ConfigurationFile::GetInstance().Get_file_separator ());
    if (slash_position != std::string::npos) {
      if (slash_position == 0)
         slash_position = 1;  
      dir = filename.substr(0,slash_position);
    }

    for (i=mBlackBoxMap.begin();
	 i!=mBlackBoxMap.end();
	 ++i) 
      {
	i->second->InsertHtmlHelp(s,detail,level,dir,relative_link);
      }    

    //----------------------
    // Footer 
    time_t rawtime;
    tm * ptm;
    time ( &rawtime );
    ptm = gmtime ( &rawtime );

    s << "<p><hr>\n";
    s << "Automatically generated by <b>"<<caller<<"</b> from <b>"
      <<source<<"</b> on "
      << ptm->tm_mday << "/" << ptm->tm_mon << "/" << ptm->tm_year+1900 
      << " - " << ptm->tm_hour << ":" << ptm->tm_min << " GMT\n";
    s << "</body></html>\n"; 
    s.close();
    //----------------------

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