/*=========================================================================
                                                                                
Program:   bbtk
Module:    $RCSfile: bbtkFactory.cxx,v $
Language:  C++

Date:      $Date: 2008/03/04 08:09:04 $
Version:   $Revision: 1.26 $
                                                                                

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::Factory : can load and unload dynamic libraries containing 
 *        black boxes packages and create instances of the black boxes registered 
 *       in the packages loaded.
 */
#include "bbtkFactory.h"
#include "bbtkMessageManager.h"
#include "bbtkConnection.h"
#include "bbtkConfigurationFile.h"
#include "bbtkUtilities.h"

#include <sys/stat.h> // for struct stat stFileInfo

#if defined(_WIN32)
#include <direct.h> // for getcwd
#endif

#include <cctype>    // std::toupper

// was in gdcm ...
/*
#ifdef _MSC_VER
#   define getcwd _getcwd
#endif

#if defined(_MSC_VER) || defined(__BORLANDC__)
#   include <direct.h>
#else
#   include <unistd.h>
#endif

*/


namespace bbtk
{
  typedef Package* (*PackageAccessor)();
  typedef void (*PackageDeleteFunction)();


  //===================================================================
  /// Default ctor
  Factory::Factory()
  {
    bbtkDebugMessage("Kernel",7,"Factory::Factory()"<<std::endl);
  }
  //===================================================================

  //===================================================================
  /// Dtor
  Factory::~Factory()
  {
    bbtkDebugMessageInc("Kernel",7,"Factory::~Factory()"<<std::endl);
    CloseAllPackages();
    bbtkDebugDecTab("Kernel",7);
  }
  //===================================================================


  //===================================================================
  void Factory::CloseAllPackages()
  {
    bbtkDebugMessageInc("Kernel",7,"Factory::CloseAllPackages()"<<std::endl);
    while (mPackageMap.begin() != mPackageMap.end())
      {
        PackageMapType::iterator i = mPackageMap.begin();
        ClosePackage(i);
      }
    bbtkDebugDecTab("Kernel",7);
  }
  //===================================================================

  //===================================================================
  void Factory::Reset()
  {
    bbtkDebugMessageInc("Kernel",7,"Factory::Reset()"<<std::endl);
    CloseAllPackages();
    bbtkDebugDecTab("Kernel",7);
  }
  //===================================================================


  // ===================================================================
  bool Factory::DoLoadPackage(std::string libname,
                              std::string pkgname,
                              std::string path)
  {
    
#if defined(__GNUC__)
    
    void *handler;
    handler = dlopen(libname.c_str(),
		     BBTK_RTLD_TIME | BBTK_RTLD_SCOPE );
    if (!handler)
      {
        // The following is *NOT* a debug time message :
        // It's a user intended message.
        // Please don't remove it.
	bbtkError("Could not open shared library [" <<libname<<"] : "
		  <<dlerror() << std::endl);
	
	return false; // try next path
      }
    
    // The following is *NOT* a debug time message :
    // It's a user intended message.
    // Please don't remove it.
    bbtkMessage("Output",2,"   -->[" <<libname<<"] found" << std::endl);
    
    // Loads the Package accessor
    
    std::string getpackname(pkgname);
    getpackname += "GetPackage";
    void *getpack = dlsym(handler, getpackname.c_str());
    if (!getpack)
      {
	dlclose(handler);
	bbtkError("Shared library ["<<libname<<"] is not a valid bbtk package."
		  <<" Symbol ["<<getpackname<<"] :"<<dlerror());
      }
    
    // Verifies that the Package delete function is present
    std::string delfname(pkgname);
    delfname += "DeletePackage";
    void *delf = dlsym(handler, delfname.c_str());
    if (!delf)
      {
	dlclose(handler);
	bbtkError("Shared library ["<<libname<<"] is not a valid bbtk package."
		  <<" Symbol ["<<delfname<<"] :"<<dlerror());
      }
    
#elif defined(_WIN32)
    
    HINSTANCE handler;
    
    SetErrorMode(0);
    handler = LoadLibrary(libname.c_str());
    if (!handler)
      {
	// The following is *NOT* a debug time message :
	// It's a user intended message.
	// Please don't remove it.
	bbtkError("Error loading library [" <<libname<<"]" << std::endl);
	return false;// Problem with the found library
      }
    
    bbtkMessage("Output",2,"   --->[" <<libname<<"] found" << std::endl);
    
    // Loads the Package accessor
    
    std::string getpackname(pkgname);
    getpackname += "GetPackage";
    void *getpack = GetProcAddress(handler, getpackname.c_str());
    if (!getpack)
      {
	FreeLibrary(handler);
	bbtkError("[1] Could not load package \""<<pkgname
		  <<"\" : "<<getpackname<<" symbol not found (is it a bbtk package lib ?)");
	// look how to get the error message on win
	//<<dlerror());
      }
    // Verifies that the Package delete function is present
    std::string delfname(pkgname);
    delfname += "DeletePackage";
    void *delf = GetProcAddress(handler, delfname.c_str());
    if (!delf)
      {
	FreeLibrary(handler);
	bbtkError("[2] Could not load package \""<<pkgname
		  <<"\" : "<<delfname<<" symbol not found (is it a bbtk package lib ?)");
	// look how to get the error message on win
	//<<dlerror());
      }
#else
    bbtkError("neither __GNUC__ nor _WIN32 ?!? How did you compile ?");
#endif
    
    // Stores the package
    PackageInfoType pack;
    pack.mDynamicLibraryHandler = handler;
    // Invokes the accessor to the PackageUnit pointer
    pack.mPackage = ((PackageAccessor)getpack)();
    
    mPackageMap[pkgname] = pack;
    
    // Test bbtk build version ok
    if ( pack.mPackage->GetBBTKVersion() != bbtk::GetVersion() )
      {
	std::string v(pack.mPackage->GetBBTKVersion());
	UnLoadPackage(pkgname);
	bbtkError("Cannot load package ["<<libname<<"]. "
		  <<"Package build with bbtk version "
		  << v
		  << " whereas application build with version "
		  << bbtk::GetVersion());
      }
    
    std::string separator =
      ConfigurationFile::GetInstance().Get_file_separator ();
    //BBTK_STRINGIFY_SYMBOL(BBTK_DOC_REL_PATH)
    std::string docreldoc = 
      separator + "bbdoc" + separator + pkgname + separator + "index.html";
    std::string reldoc = 
      ".." + separator + ".." + docreldoc;
    std::string doc = path + separator + ".." + separator
      + BBTK_STRINGIFY_SYMBOL(BBTK_DOC_REL_PATH)
      + docreldoc;
    
    pack.mPackage->SetDocURL(doc);
    pack.mPackage->SetDocRelativeURL(reldoc);
    
    //===================================================================
    bbtkMessage("Output",2,pack.mPackage->GetName()<<" "
		<<pack.mPackage->GetVersion()
		<<" (bbtk "
		<<pack.mPackage->GetBBTKVersion()<<") "
		<<pack.mPackage->GetAuthor() << " Category(s) :"
		<<pack.mPackage->GetCategory()
		<<std::endl);
    bbtkMessage("Output",2,pack.mPackage->GetDescription()<<std::endl);
    //===================================================================
    
    bbtkDebugDecTab("Kernel",7);
    return true;
  }
  
  //===================================================================
  /// \brief Loads a package.
  ///
  /// The name is the system-independant name of the package (the name of the instance of bbtk::Package).
  /// Tries to open the dynamic library :
  /// - "libbb<name>.so" for linux systems,
  /// - "bb<name>.dll" for windows systems.
  /// If it succeeds, then tries to load the symbols "<name>GetPackage" and "<name>DeletePackage".
  /// "<name>GetPackage" is called to get the pointer on the bbtk::Package of the library
  /// ("<name>DeletePackage" is not used, its presence is just checked before loading the package).
  
  /// now, filename is only the last name (no longer the full name!)
  /// it will be searched within *all* the paths given in bbtk_config.xml
  

  
  void Factory::LoadPackage( const std::string& name )
  {
  // Note : in the following :
  // name : the user supplied name
  //      - abreviated name    e.g.       pkg   pkg.so   libbpkg   libbbpkg.so
  //      - relative full name e.g.       ./libbbpkg.so   ../../libbbpkg.so
  //      - absolute full name e.g.       /home/usrname/proj/lib/libbbpkg.so
  //          same for Windows, with      c:, d: ...
  //
  // lastname : string before the last / (if any), or user supplied name

    bbtkDebugMessageInc("Kernel",7,"Factory::LoadPackage(\""<<name<<"\")"<<std::endl);
    bbtkMessage("Debug",1,"Factory::LoadPackage(\""<<name<<"\")"<<std::endl);

    std::vector<std::string> package_paths;
    std::string libname;  // full path library name
    std::string pkgname;  // e.g. libbb<pkgname>.so

    std::string upath;
    pkgname = Utilities::ExtractPackageName(name,upath);

    bbtkMessage("Debug",1,"Package name ["<<pkgname<<"]"<<std::endl);
    bbtkMessage("Debug",1,"Package path ["<<upath<<"]"<<std::endl);

    // no loading package if already loaded
    PackageMapType::iterator iUnload;
    iUnload = mPackageMap.find(pkgname);
    if (iUnload != mPackageMap.end())
    {
      bbtkMessage("Output",2,"["<< pkgname <<"] already loaded" << std::endl);
      return;
    }

// =================================================
// The following structure was checked to work
// with any type of relative/absolute path.
// Please don't modify it without checking
// *all* the cases. JP
//==================================================

//std::cout << "upath [" << upath << "]" << std::endl;

    bool ok = false;
    bool foundFile = false;

    // If path provided by user will be the first scanned :
    // push it into vector of paths
    if (upath.length()>0)   // ------------------------------------- check user supplied location
    {
       if (name[0] != '.' && name[0] != '/' && name[1]!= ':')
       {
          bbtkError("Use absolute or relative path name! ["<<name<<"] is an illegal name");
          return;
       }

      // std::string path = Utilities::ExpandLibName(upath, false);
       std::string path = Utilities::ExpandLibName(name,false); // keep last item, here.
         
       if (path != "")
       {
          std::string p2;
          Utilities::ExtractPackageName(path,p2);
          //libname = Utilities::MakeLibnameFromPath(path, pkgname);
          libname = Utilities::MakeLibnameFromPath(p2, pkgname); // remove last item
          // Check if library exists
          if ( !Utilities::FileExists(libname) )
          {
          // The following is *NOT* a debug time message :
          // It's a user intended message.
          // Please don't remove it.
	    bbtkMessage("Output",3,"   [" <<libname 
			<<"] : doesn't exist" <<std::endl);
          }
          else
          {
             ok = DoLoadPackage( libname, pkgname, path);         
          }
       }
       else
       {
          bbtkError("Path ["<<upath<<"] doesn't exist");
          return;
       }
    }
    else     // ----------------------------------------------------- iterate on the paths  
    {

    std::string path;
    package_paths = ConfigurationFile::GetInstance().Get_package_paths();
    std::vector<std::string>::iterator i;
    for (i=package_paths.begin();i!=package_paths.end();++i)
    {
        foundFile = false;
        path = *i;

        // we *really* want '.' to be the current working directory
        if (path == ".")
        {
          char buf[2048]; // for getcwd
          char * currentDir = getcwd(buf, 2048);
          std::string cwd(currentDir);
          path = currentDir;
        }

        libname = Utilities::MakeLibnameFromPath(path, pkgname);

        bbtkMessage("Debug",2,"-> Trying to load [" << libname << "]" <<std::endl);

      // Check if library exists           
        if ( !Utilities::FileExists(libname) )
        {
        // The following is *NOT* a debug time message :
        // It's a user intended message.
        // Please don't remove it.
          bbtkMessage("Output",3,
		      "   [" <<libname <<"] : doesn't exist" <<std::endl);
           continue;  // try next path
        }
        foundFile = true; 

      // Try to Load the library

        ok = DoLoadPackage( libname, pkgname, path);
        if (ok)
        {
           bbtkMessage("Debug",2,"   OK"<<std::endl);
           break; // a package was found; we stop iterating
        }
    } //------------------ // end for ( package_paths.begin();i!=package_paths.end() )

}

    if( !ok )  // nothing was loaded
    {
      if (!foundFile)
      {
        bbtkError("Could not find package ["<<pkgname<< "]");
      }
      else
      {
#if defined(__GNUC__)
        bbtkError("Could not load package ["<< pkgname
                  <<"] :" << std::endl << "   " << dlerror());
#elif defined(_WIN32)
        bbtkError("Could not load package ["<<pkgname
                 <<"] : " << std::endl << "   " <<libname<<" not found");

    // look how to get the error message on win
    //<<dlerror());
    // it is the bordel !! (the bloody fucking bordel, you mean?)
    // look : http://msdn2.microsoft.com/en-us/library/ms680582.aspx
#endif
      }
    }
    bbtkMessage("Output",2,"[" << libname << "] loaded" << std::endl);

  }

  //===================================================================
  /// \brief UnLoads a package.
  ///
  /// The package must have been previously loaded by LoadPackage.
  /// If the entry is found in the map, calls ClosePackage
 void Factory::UnLoadPackage( const std::string& name )
 {
    bbtkDebugMessageInc("Kernel",7,"Factory::UnLoadPackage(\""
                       <<name<<"\")"<<std::endl);
  
    PackageMapType::iterator i;
    i = mPackageMap.find(name);
    if (i == mPackageMap.end()) 
    {
      bbtkError("cannot unload package \""<<name
                <<"\" : package not loaded !");
    }
    ClosePackage(i);
    bbtkDebugDecTab("Kernel",7);
  }
  //===================================================================


  //===================================================================
  /// \brief Close the package referenced by the iterator 
  ///
  /// If it is a dynamically loaded package 
  /// - Loads and calls the function "<name>DeletePackage" of the dynamic library (responsible for package desallocation)
  /// - Closes the dynamic library
  /// - Erases the package entry in the packages map
  ///
  /// Else simply erases the package entry in the packages map
  void Factory::ClosePackage(PackageMapType::iterator& i) 
  {   
     bbtkDebugMessageInc("Kernel",7,"Factory::ClosePackage(\""
                         <<i->second.mPackage->GetName()
                        <<"\")"<<std::endl);

     if (i->second.mDynamicLibraryHandler) 
     {
 
      // If it is a dynamically loaded package
      // Loads the Package delete function

        std::string delfname(i->second.mPackage->GetName());
        delfname += "DeletePackage";
#if defined(__GNUC__)     
        void *delf = dlsym(i->second.mDynamicLibraryHandler, delfname.c_str());
        if (!delf)
        {
           bbtkError("could not close package \""
                     <<i->second.mPackage->GetName()
                     <<"\" :"<<dlerror());
        }    
#elif defined(_WIN32)
   void *delf = GetProcAddress(i->second.mDynamicLibraryHandler, 
                                 delfname.c_str());
     if (!delf)
     {  
       bbtkError("could not close package \""
                <<i->second.mPackage->GetName()
                <<"\" : "<<delfname
                <<" symbol not found (how did you open it ???");
               //<<"\" :"<<dlerror());
     }    
#endif     

   // deletes the package
   ((PackageDeleteFunction)delf)();

   // closes the dl handler
#if defined(__GNUC__)  
    dlclose(i->second.mDynamicLibraryHandler);  
#elif defined(_WIN32)

    FreeLibrary(i->second.mDynamicLibraryHandler);
#endif
    }
    else 
    {  
       // If it is a manually inserted package 
       delete i->second.mPackage;
    }

    // remove the entry in the map
    mPackageMap.erase(i);
    bbtkDebugDecTab("Kernel",7);
 }
  //===================================================================



  //===================================================================  
  /// Displays the list of packages loaded
  void Factory::PrintPackages(bool details, bool adaptors) const
  {
    bbtkDebugMessageInc("Kernel",9,"Factory::PrintPackages"<<std::endl);

    PackageMapType::const_iterator i;
    for (i = mPackageMap.begin(); i!=mPackageMap.end(); ++i )
    {
      bbtkMessage("Help",1, i->first << std::endl);
      if (details) {
         i->second.mPackage->PrintBlackBoxes(false,adaptors);
      }
    }

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

  //===================================================================  
  /// Displays help on a package
  void Factory::HelpPackage(const std::string& name, bool adaptors) const
  {
    bbtkDebugMessageInc("Kernel",9,"Factory::HelpPackage(\""<<name<<"\")"
                        <<std::endl);

    PackageMapType::const_iterator i = mPackageMap.find(name);
    if ( i != mPackageMap.end() ) 
      {
      bbtkMessage("Help",1, "Package "<<i->first<<" ");
      
      if (i->second.mPackage->GetVersion().length()>0)
        bbtkMessageCont("Help",1,"v" <<i->second.mPackage->GetVersion());
        
      if (i->second.mPackage->GetAuthor().length()>0)
        bbtkMessageCont("Help",1,"- "<<i->second.mPackage->GetAuthor());
        
      if (i->second.mPackage->GetCategory().length()>0)
        bbtkMessageCont("Help",1,"- "<<i->second.mPackage->GetCategory());        
        
      bbtkMessageCont("Help",1,std::endl);
      bbtkIncTab("Help",1);
      bbtkMessage("Help",1,i->second.mPackage->GetDescription()<<std::endl);
      if (i->second.mPackage->GetNumberOfBlackBoxes()>0) 
        {
          bbtkMessage("Help",1, "Black boxes : "<<std::endl);
          i->second.mPackage->PrintBlackBoxes(true,adaptors);
        }
      else 
        {
          bbtkMessage("Help",1, "No black boxes"<<std::endl);
        }
      bbtkDecTab("Help",1);
      }
    else 
      {
      bbtkDebugDecTab("Kernel",9);
      bbtkError("package \""<<name<<"\" unknown");
      }
    
    bbtkDebugDecTab("Kernel",9);
  }
  //===================================================================

  //===================================================================
  /// Prints help on the black box of type <name>
  /// Returns the package to which it belongs
  void Factory::HelpBlackBox(const std::string& name, 
			     std::string& package,
			     bool full) const
  {
    bbtkDebugMessageInc("Kernel",9,"Factory::HelpBlackBox(\""<<name<<"\")"
                        <<std::endl);

    bool found = false;
    PackageMapType::const_iterator i;
    for (i = mPackageMap.begin(); i!=mPackageMap.end(); ++i )
      {
      if (i->second.mPackage->ContainsBlackBox(name)) 
        {
          i->second.mPackage->HelpBlackBox(name,full);
	      package = i->second.mPackage->GetName();
          found = true;
        }
      }
    
    bbtkDebugDecTab("Kernel",9);
    if (!found) 
      {
      bbtkError("No package of the factory contains any black box <"
                 <<name<<">");
      }
  }  
  //===================================================================


  //=================================================================== 
  /// Inserts a package in the factory
  void Factory::InsertPackage( Package* p )
  {
    bbtkDebugMessageInc("Kernel",9,"Factory::InsertPackage(\""<<
                        p->GetName()<<"\")"<<std::endl);

    PackageInfoType pack;
    pack.mDynamicLibraryHandler = 0;
    
    pack.mPackage = p;

    mPackageMap[p->GetName()] = pack;
    bbtkDebugDecTab("Kernel",9);
  }
  //===================================================================
  
  //=================================================================== 
  /// Removes a package from the factory (and deletes it)
  void Factory::RemovePackage( Package* p )
  {
    bbtkDebugMessageInc("Kernel",9,"Factory::RemovePackage(\""<<
                        p->GetName()<<"\")"<<std::endl);

    PackageMapType::iterator i;
    for (i = mPackageMap.begin(); i!=mPackageMap.end(); ++i )
      {
         if (i->second.mPackage == p) break;
      };
    
    if (i!=mPackageMap.end())
      {
      ClosePackage(i);
      }
    else 
      {
      bbtkError("Factory::RemovePackage(\""<<
                 p->GetName()<<"\") : package absent from factory");
      }

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

  //===================================================================
  /// Creates an instance of a black box of type <type> with name <name>
  BlackBox* Factory::NewBlackBox(const std::string& type, 
                                 const std::string& name) const
  {
    bbtkDebugMessageInc("Kernel",7,"Factory::NewBlackBox(\""
                        <<type<<"\",\""<<name<<"\")"<<std::endl);

    BlackBox* b = 0; 
    PackageMapType::const_iterator i;
    for (i = mPackageMap.begin(); i!=mPackageMap.end(); ++i )
      {
      b = i->second.mPackage->NewBlackBox(type,name);
      if (b) break; 
      }
    if (!b) 
      {
       bbtkError("black box type \""<<type<<"\" unknown");
      } 

    bbtkDebugDecTab("Kernel",7);
    return b;
  }
  //===================================================================

  //===================================================================
  /// Creates an instance of a black box of type <type> with name <name>
  BlackBox* Factory::NewAdaptor(TypeInfo typein,
                     TypeInfo typeout,
                     const std::string& name) const
  {
    bbtkDebugMessageInc("Kernel",8,"Factory::NewAdaptor(<"
                        <<TypeName(typein)<<">,<"
                        <<TypeName(typeout)<<">,\""
                        <<name<<"\")"<<bbtkendl);


    BlackBox* b = 0; 
    PackageMapType::const_iterator i;
    for (i = mPackageMap.begin(); i!=mPackageMap.end(); ++i )
      {
      b = i->second.mPackage->NewAdaptor(typein,typeout,name);
      if (b) break; 
      }
    if (!b) 
      {
      bbtkError("no <"
          <<TypeName(typein)<<"> to <"
          <<TypeName(typeout)
          <<"> adaptor available");
      } 
    
    bbtkDebugDecTab("Kernel",7);
    return b; 
  }
  //===================================================================

  //===================================================================
  /// Creates an instance of a connection
  Connection* Factory::NewConnection(BlackBox* from,
                                     const std::string& output,
                                     BlackBox* to,
                                     const std::string& input) const
  {
    bbtkDebugMessage("Kernel",7,"Factory::NewConnection(\""
                      <<from->bbGetName()<<"\",\""<<output<<"\",\""
                      <<to->bbGetName()<<"\",\""<<input
                      <<"\")"<<std::endl);
    
    return new Connection(from,output,to,input);
    /*  
       Connection* c;
    // !!! WARNING : WE NEED TO TEST THE TYPE NAME EQUALITY 
    // BECAUSE IN DIFFERENT DYN LIBS THE type_info EQUALITY CAN 
    // BE FALSE (DIFFERENT INSTANCES !)
  
    std::string t1 ( from->bbGetOutputType(output).name() );
    std::string t2 ( to->bbGetInputType(input).name() );


    if ( t1 == t2 ) 
       //from->bbGetOutputType(output) ==
       // to->bbGetInputType(input) )
      {
         c = new Connection(from,output,to,input);
      }
    else 
      {
         //   std::cout << "Adaptive connection "<<std::endl;
         std::string name;
         name = from->bbGetName() + "." + output + "-" 
                                  + to->bbGetName() + "." + input; 

         BlackBox* b = 0; 
         PackageMapType::const_iterator i;
         for (i = mPackageMap.begin(); i!=mPackageMap.end(); ++i )
         {
             b = i->second.mPackage->NewAdaptor(from->bbGetOutputType(output),
                                                  to->bbGetInputType(input),
                                                  name);
             if (b) break; 
         } 
         if (!b)  
         {  
            bbtkError("did not find any <"
                       <<TypeName(from->bbGetOutputType(output))
                       <<"> to <"
                       <<TypeName(to->bbGetInputType(input))
                       <<"> adaptor");
         } 
         c = new AdaptiveConnection(from,output,to,input,b);
      }
      bbtkDebugDecTab("Kernel",7);
    
      return c;
    */
  }
  //===================================================================



  //===================================================================
  const Package* Factory::GetPackage(const std::string& name) const
  {
    bbtkDebugMessageInc("Kernel",9,"Factory::GetPackage(\""<<name<<"\")"
                         <<std::endl);

    PackageMapType::const_iterator i = mPackageMap.find(name);
    if ( i != mPackageMap.end() ) 
    {
      bbtkDebugDecTab("Kernel",9); 
      return i->second.mPackage;
    }
    else 
    {
       bbtkDebugDecTab("Kernel",9);
       bbtkError("package \""<<name<<"\" unknown");
    }
    
    bbtkDebugDecTab("Kernel",9);  
  }
  //===================================================================
  
  //===================================================================
  Package* Factory::GetPackage(const std::string& name) 
  {
    bbtkDebugMessageInc("Kernel",9,"Factory::GetPackage(\""<<name<<"\")"
                         <<std::endl);

    PackageMapType::const_iterator i = mPackageMap.find(name);
    if ( i != mPackageMap.end() ) 
    {
      bbtkDebugDecTab("Kernel",9); 
      return i->second.mPackage;
    }
    else 
    {
       bbtkDebugDecTab("Kernel",9);
       bbtkError("package \""<<name<<"\" unknown");
    }
    
    bbtkDebugDecTab("Kernel",9);  
  }
  //===================================================================

  //===================================================================
  void Factory::WriteDotFilePackagesList(FILE *ff)
  {

    bbtkDebugMessageInc("Kernel",9,"Factory::WriteDotFilePackagesList()"
                         <<std::endl);

    fprintf( ff , "\n");
    fprintf( ff , "subgraph cluster_FACTORY {\n");
    fprintf( ff , "  label = \"PACKAGES\"%s\n",  ";");
    fprintf( ff , "  style=filled%s\n",";");
    fprintf( ff , "  color=lightgrey%s\n",";");
    fprintf( ff , "  rankdir=TB%s\n",";");

    std::string url;
    PackageMapType::const_iterator i;
    for (i = mPackageMap.begin(); i!=mPackageMap.end(); ++i )
    {
       url=GetPackage(i->first)->GetDocURL();
       fprintf(ff,"  %s [shape=ellipse, URL=\"%s\"]%s\n",i->first.c_str(),url.c_str(),";" );
    }
    fprintf( ff , "}\n\n");
    bbtkDebugDecTab("Kernel",9);
  }
  //===================================================================


 void Factory::ShowGraphTypes(const std::string& name) const
 {

   bool found = false;
   PackageMapType::const_iterator i;
   for (i = mPackageMap.begin(); i!=mPackageMap.end(); ++i )
   {
      if (i->second.mPackage->ContainsBlackBox(name)) 
      {
         std::string separator = ConfigurationFile::GetInstance().Get_file_separator ();

            // Don't pollute the file store with  "temp_dir" directories ...    
         std::string default_doc_dir = ConfigurationFile::GetInstance().Get_default_temp_dir();
         std::string directory = "\"" + default_doc_dir + separator + "temp_dir"  +separator + "\"";
         std::string filename2 =  default_doc_dir + separator + "temp_dir" + separator + "tmp.html"; 

#if defined(_WIN32)  
        std::string command("start \"Titre\" /D ");
#else 
        std::string command("gnome-open ");
#endif
        command=command + directory +" tmp.html";
        FILE *ff;
        ff=fopen(filename2.c_str(),"w");

        fprintf(ff,"<html><head><title>TMP</title> <script type=\"text/javascript\"> <!--\n");
        fprintf(ff,"  window.location=\"%s#%s\";\n" , i->second.mPackage->GetDocURL().c_str(),name.c_str() );
        fprintf(ff,"//--></script></head><body></body></html>\n");


        //fprintf(ff, "<a  href=\"%s#%s\">Link</a>\n", i->second.mPackage->GetDocURL().c_str(),name.c_str() );
        fclose(ff);
        system( command.c_str() );      
        found = true;
     }
   }
    
   bbtkDebugDecTab("Kernel",9);
   if (!found) 
   {
      bbtkError("No package of the factory contains any black box <"
                <<name<<">");
   }
 }
    



  void Factory::CreateHtmlIndex(IndexEntryType type, 
				const std::string& filename)
  {
    bbtkDebugMessageInc("Kernel",9,"Factory::CreateHtmlIndex(\""
			<<filename<<"\")"<<bbtkendl);
    
    std::string title;

    typedef std::map<std::string, std::vector<BlackBoxDescriptor*> > IndexType;
    IndexType index;
    // Builds the index map
    PackageMapType::const_iterator i;
    for (i = mPackageMap.begin(); i!=mPackageMap.end(); ++i )
      {
	Package* pack = i->second.mPackage;
	if (pack->GetName()=="user") continue;
	Package::BlackBoxMapType::const_iterator j;
	for (j = pack->GetBlackBoxMap().begin(); 
	     j!= pack->GetBlackBoxMap().end(); 
	     ++j)
	  {
	    
	    // Skip adaptors 
	    if ( type==Adaptors )
	      {  
		if (j->second->GetKind() == BlackBoxDescriptor::STANDARD )
		  continue;
	      }
	    else 
	      if (j->second->GetKind() != BlackBoxDescriptor::STANDARD )
		continue;

	    std::vector<std::string> keys;
	    if (type==Packages)
	      {
		std::string k("");
		k += pack->GetName();
		keys.push_back(k);
		title = "Boxes by package";
	      }
	    else if ((type==Initials) || (type==Adaptors))
	      {
		std::string init(" ");
		init[0] =  std::toupper(j->second->GetTypeName()[0]);
		keys.push_back(init);
		title = "Alphabetical list";
	      }
	    else if (type==Categories)
	      {
		// Split the category string 
		std::string delimiters = ";,";
		Utilities::SplitString(j->second->GetCategory(),
				       delimiters,keys);
		if (keys.size()==0) 
		  keys.push_back(" NONE");
		title = "Boxes by category";
	      }
    
	    
	    std::vector<std::string>::const_iterator k;
	    for (k=keys.begin(); k!=keys.end(); ++k )
	      {
		IndexType::iterator p;
		p = index.find(*k);
		if (p != index.end()) 
		  {
		    p->second.push_back(j->second);
		  }
		else 
		  {
		    std::vector<BlackBoxDescriptor*> v;
		    v.push_back(j->second);
		    index[*k] = v;
		  }
	      }
	    
	  }
      }   
    // Creates the file 
    //---------------------
    // Open output file
    std::ofstream s;
    s.open(filename.c_str());
    if (!s.good()) 
    {
       bbtkError("Factory::CreateHtmlIndex : could not open file '"
		 <<filename<<"'");
    }
    
    //----------------------
    // Html head
    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"; 
    s << "<h1 class=\"settitle\">"<<title<<"</h1>\n";
    s << "<p>\n";
    IndexType::iterator ii;
    for (ii=index.begin();ii!=index.end();++ii)
      {
	s << "<a href=\"#"<<ii->first<<"\">"<<ii->first<<"</a>&nbsp;&nbsp;";	
      }

    for (ii=index.begin();ii!=index.end();++ii)
      {
	s << "<p><hr>\n";
	s << "<p><a href=\"#Top\">Top</a>";
	if (type==Packages)
	  {
	    s << "<a name=\""<<ii->first<<"\"></a>\n"; 
	    s << "<p><a href=\""<<ii->first<<"/index.html\">"
	      << ii->first<<"</a>\n"; 

	    s << "&nbsp;&nbsp;-&nbsp;&nbsp;\n"; 

	    s << "<a name=\"doxygen\"></a>\n"; 
	    s << "<a href=..\\doxygen\\" << ii->first << "/main.html>(Doxygen documentation of the source)</a>\n"; 
	  }
	else 
	  {
	    s << "<a name=\""<<ii->first<<"\"></a>\n"; 
	    s << "<p><b>"<<ii->first<<"</b>\n";
	  }
	s << "<ul>\n";

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

	std::vector<BlackBoxDescriptor*>::iterator di;
	for (di=ii->second.begin();di!=ii->second.end();++di)
	  {
	    std::string pack = (*di)->GetPackage()->GetName();
	    std::string name = (*di)->GetTypeName();
	    Utilities::html_format(name);
	    std::string descr = (*di)->GetDescription();
	    Utilities::html_format(descr);
	    s << "<TR>";
	    s << "<TD style='vertical-align: top;'>";
	    s << "&nbsp;&nbsp;&nbsp;<a href=\""<<pack
	      <<"/index.html#"<<name<<"\">"
	      <<pack<<"::"<<name<<"</a>";
	    s << "</TD> ";
	    s << " <TD style='vertical-align: top;'>" << descr << " </TD>";
	    s << "</TR>\n";
	  }    
	s << "</TABLE>\n";
	s << "</ul>\n";
	s << "</div>\n";
      }
    //----------------------
    // Footer 
    time_t rawtime;
    tm * ptm;
    time ( &rawtime );
    ptm = gmtime ( &rawtime );

    s << "<p><hr>\n";
    s << "Automatically generated by <b>bbi</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("Kernel",9);
  }


}