kernel/src/bbtkPackage.cxx

   1
   2 /*=========================================================================
   3   Program:   bbtk
   4   Module:    $RCSfile: bbtkPackage.cxx,v $
   5   Language:  C++
   6   Date:      $Date: 2012/11/14 07:12:00 $
   7   Version:   $Revision: 1.36 $
   8 =========================================================================*/
   9
  10 /* ---------------------------------------------------------------------
  11
  12 * Copyright (c) CREATIS-LRMN (Centre de Recherche en Imagerie Medicale)
  13 * Authors : Eduardo Davila, Laurent Guigues, Jean-Pierre Roux
  14 *
  15 *  This software is governed by the CeCILL-B license under French law and
  16 *  abiding by the rules of distribution of free software. You can  use,
  17 *  modify and/ or redistribute the software under the terms of the CeCILL-B
  18 *  license as circulated by CEA, CNRS and INRIA at the following URL
  19 *  http://www.cecill.info/licences/Licence_CeCILL-B_V1-en.html
  20 *  or in the file LICENSE.txt.
  21 *
  22 *  As a counterpart to the access to the source code and  rights to copy,
  23 *  modify and redistribute granted by the license, users are provided only
  24 *  with a limited warranty  and the software's author,  the holder of the
  25 *  economic rights,  and the successive licensors  have only  limited
  26 *  liability.
  27 *
  28 *  The fact that you are presently reading this means that you have had
  29 *  knowledge of the CeCILL-B license and that you accept its terms.
  30 * ------------------------------------------------------------------------ */
  31
  32 /**
  33  *\file
  34  *\brief Class bbtk::Package : registers black boxes descriptors and is able to create instances of the black boxes registered.
  35  */
  36 #include "bbtkPackage.h"
  37 #include "bbtkComplexBlackBoxDescriptor.h"
  38 #include "bbtkMessageManager.h"
  39 #include "bbtkConfigurationFile.h"
  40 #include <fstream>
  41 #include <time.h>
  42 #include "bbtkUtilities.h"
  43
  44 namespace bbtk
  45 {
  46
  47
  48
  49   //==========================================================================
  50   /// Creates a new package
  51   Package::Pointer Package::New(const std::string& name,
  52                                 const std::string& author,
  53                                 const std::string& description,
  54                                 const std::string& version)
  55   {
  56     bbtkDebugMessage("object",1,"##> Package::New('"<<name<<"',...)"
  57                      <<bbtkendl);
  58     Package::Pointer p = MakePointer(new Package(name,
  59                                                author,
  60                                                description,
  61                                                version));
  62     bbtkDebugMessage("object",2,"<## Package::New('"<<name<<"',...)"
  63                      <<bbtkendl);
  64     return p;
  65   }
  66   //==========================================================================
  67
  68   //==========================================================================
  69   /// Ctor with the name of the package
  70   Package::Package(const std::string& name,
  71                    const std::string& author,
  72                    const std::string& description,
  73                    const std::string& version)
  74     :
  75     mDynamicLibraryHandler(0),
  76     mName(name),
  77     mAuthor(author),
  78     mDescription(description),
  79     mVersion(version)
  80   {
  81     bbtkDebugMessage("object",2,"==> Package('"<<name<<"',...)"
  82                      <<bbtkendl);
  83     std::string default_doc_dir = ConfigurationFile::GetInstance().Get_default_temp_dir();
  84     char c = default_doc_dir.c_str()[strlen(default_doc_dir.c_str())-1];
  85     std::string url = default_doc_dir;
  86     if (c != '/' && c !='\\') url = url + "/";
  87     url = url +  "temp_dir/" + name + "/index.html";
  88
  89     SetDocURL(url);
  90     SetDocRelativeURL("Relative url not set");
  91
  92     /*
  93     std::string relurl(BBTK_STRINGIFY_SYMBOL(BBTK_DOC_REL_PATH));
  94     relurl += "/packages/"+name+"/bbdoc/index.html";
  95     std::string url = ConfigurationFile::GetInstance().Get_url()
  96       + relurl;
  97     SetDocURL(url);
  98     SetDocRelativeURL(relurl);
  99     */
 100
 101     //    std::cout  << "   url=["<<url<<"]"<<std::endl;
 102     //    std::cout  << "relurl=["<<relurl<<"]"<<std::endl;
 103     bbtkDebugMessage("object",2,"<== Package::Package('"<<name<<"',...) OK"
 104                      <<bbtkendl);
 105
 106   }
 107   //==========================================================================
 108
 109
 110
 111   //==========================================================================
 112   /// Dtor
 113   Package::~Package()
 114   {
 115     bbtkDebugMessage("object",2,"==> ~Package(\""<<mName<<"\")"<<bbtkendl);
 116   }
 117   //==========================================================================
 118
 119
 120   //==========================================================================
 121   void PackageReleaseBlackBoxDescriptorInternal(Package::WeakPointer pack,
 122                                                 const std::string& descname)
 123   {
 124     // Try to release descriptor
 125     std::string packname = pack.lock()->GetName();
 126
 127     bbtkDebugMessage("package",5,"--- Releasing descriptor '"
 128                      <<packname<<"::"<<descname<<"'"<<bbtkendl);
 129
 130
 131     Package::DescriptorMapType::iterator desc =
 132       pack.lock()->GetDescriptorMap().find(descname);
 133     if (desc ==  pack.lock()->GetDescriptorMap().end())
 134       {
 135         bbtkDebugMessage("package",5,
 136                          "    Descriptor has already been released"
 137                         <<bbtkendl);
 138         return;
 139                   }
 140     //    bbtkDebugMessage("package",3,
 141     //               "    Trying unreferencing it ... "<<std::endl);
 142     BlackBoxDescriptor::WeakPointer pdesc = desc->second;
 143     desc->second.reset();
 144     // if it is dead : remove it
 145     if (pdesc.expired())
 146       {
 147         bbtkDebugMessage("package",2," ==> '"<<packname<<"::"<<descname<<"' Descriptor expired"<<bbtkendl);
 148         if (pack.expired())
 149           {
 150             bbtkDebugMessage("package",2,
 151                              "     ... and caused its package death"
 152                              <<bbtkendl);
 153             return;
 154           } // pack.expired
 155         desc = pack.lock()->GetDescriptorMap().find(descname);
 156         if (desc !=  pack.lock()->GetDescriptorMap().end())       pack.lock()->GetDescriptorMap().erase(desc);
 157       }   else    {  //pdesc.expired
 158       bbtkDebugMessage("package",5,"    ... Descriptor still alive ("
 159                        <<pdesc.use_count()<<" refs)"
 160                        <<bbtkendl);
 161       pack.lock()->GetDescriptorMap()[descname] = pdesc.lock();
 162     } // pdesc.expired
 163   }
 164   //==========================================================================
 165
 166
 167   //==========================================================================
 168   /// Release
 169   void Package::Release(Package::WeakPointer pack)
 170   {
 171     std::string packname = pack.lock()->mName;
 172     bbtkDebugMessage("package",1,"==> Package::Release('"<<
 173                      packname<<"')"<<bbtkendl);
 174
 175     long dyn = pack.lock()->mDynamicLibraryHandler ? 1:0;
 176     long ndesc = pack.lock()->GetDescriptorMap().size();
 177     long nrefs = pack.use_count();
 178
 179     bbtkDebugMessage("package",5," "<<nrefs<<" refs / "
 180                      <<ndesc<<" descr / dyn="
 181                      <<dyn<<std::endl);
 182
 183     // A package is "free" from any external reference iff :
 184     // i) It is not dynamically loaded and nrefs == ndesc
 185     // (each desc references its package) or
 186     // ii) It is dynamically loaded and nrefs == ndesc + 1
 187     // (A dynamic library holds a static pointer on the package it contains
 188     //  which is allocated when the PACKAGENAMEGetPackage() func is called,
 189     //  and descallocated (reset) by PACKAGENAMEDeletePackage())
 190     if (nrefs == ndesc + dyn)
 191       {
 192         bbtkDebugMessage("package",5,
 193                          " -> No more external ref : checking descriptors"
 194                          <<bbtkendl);
 195         // We must take care that removing refs on descriptors
 196         // can lead to their deletion which can in turn unref
 197         // internal boxes which can release their descriptors hence
 198         // call Package::ReleaseBlackBoxDescriptor
 199         // As a consequence during descriptors release :
 200         // 1) The map can change dynamically : we cannot iterate over it
 201         //    as any iterator can become invalid
 202         // 2) The package can auto-destruct : we must test its existence
 203         //    after each release
 204         // We must also take care of not locking the package pointer
 205         // or any ref count check in Package::ReleaseBlackBoxDescriptor
 206         // would be wrong
 207
 208         // The list of descriptors names at start
 209         std::vector<std::string> descnamelist;
 210         DescriptorMapType::iterator i;
 211         for (i=pack.lock()->mDescriptorMap.begin();
 212              i!= pack.lock()->mDescriptorMap.end();
 213              ++i)
 214           descnamelist.push_back(i->first);
 215
 216         // Iterator over the initial names
 217         std::vector<std::string>::iterator descname;
 218         for (descname=descnamelist.begin();
 219              descname!=descnamelist.end();
 220              ++descname)
 221           {
 222             // Is package still alive ?
 223             if (pack.expired())
 224               {
 225                 bbtkDebugMessage("package",1,"--- Package::Release('"<<
 226                                  packname
 227                                  <<"') : package expired during release : bailing out"<<bbtkendl);
 228                 break;
 229               }
 230
 231 #if defined(MACOSX)
 232                   BlackBoxDescriptor::Pointer desc = pack.lock()->mDescriptorMap[*descname];
 233                   if ( (dyn==0) || (boost::dynamic_pointer_cast<ComplexBlackBoxDescriptor>(desc)) )
 234                   {
 235                           PackageReleaseBlackBoxDescriptorInternal(pack,*descname);
 236                   }
 237 #else
 238                   PackageReleaseBlackBoxDescriptorInternal(pack,*descname);
 239 #endif
 240
 241           }
 242
 243         //
 244         UnLoadDynamicLibrary(pack);
 245         // Unload orphan dl packages
 246         Package::UnLoadReleasedDynamicallyLoadedPackages();
 247
 248       }
 249
 250 #ifdef BBTK_COMPILE_DEBUG_MESSAGES
 251
 252     bbtkDebugMessage("package",2,"<== Package::Release('"<<
 253                      packname<<"')"<<bbtkendl);
 254
 255     if (!pack.expired())
 256       {
 257         long dyn = pack.lock()->mDynamicLibraryHandler ? 1:0;
 258         long ndesc = pack.lock()->GetDescriptorMap().size();
 259         long nrefs = pack.use_count();
 260
 261         bbtkDebugMessage("package",1," ... Package still alive ("
 262                          <<nrefs<<" refs / "
 263                          <<ndesc<<" descr / dyn="
 264                          <<dyn<<")"<<std::endl);
 265       }
 266     else
 267       {
 268         bbtkDebugMessage("package",1," ... Package has been released"
 269                          <<std::endl);
 270       }
 271 #endif
 272   }
 273   //==========================================================================
 274
 275   //==========================================================================
 276   /// "Releases" the package
 277   /// Signals the package that it can free the given descriptor
 278   /// if they are no more used and free itself if it is no
 279   /// more used
 280   /// Note : Any non-weak pointer on the package must have been freed
 281   void Package::ReleaseBlackBoxDescriptor(Package::WeakPointer pack,
 282                                           BlackBoxDescriptor::WeakPointer descr)
 283   {
 284     std::string packname = pack.lock()->mName;
 285     std::string dname = descr.lock()->GetTypeName();
 286     bbtkDebugMessage("package",3,"==> Package::ReleaseBlackBoxDescriptor('"<<
 287                      packname<<"','"<<dname<<"') : refs="
 288                      <<descr.use_count()<<bbtkendl);
 289
 290     long dyn = pack.lock()->mDynamicLibraryHandler ? 1:0;
 291     long ndesc = pack.lock()->GetDescriptorMap().size();
 292     long nrefs = pack.use_count();
 293
 294     bbtkDebugMessage("package",5," "<<nrefs<<" refs / "
 295                      <<ndesc<<" descr / dynamically loaded = "
 296                      <<dyn<<std::endl);
 297
 298     // A package is "free" from any external reference iff :
 299     // i) It is not dynamically loaded and nrefs == ndesc
 300     // (each desc references its package) or
 301     // ii) It is dynamically loaded and nrefs == ndesc + 1
 302     // (A dynamic library holds a static pointer on the package it contains
 303     //  which is allocated when the PACKAGENAMEGetPackage() func is called,
 304     //  and descallocated (reset) by PACKAGENAMEDeletePackage())
 305     if (nrefs == ndesc + dyn)
 306       {
 307 #if defined(MACOSX)
 308                   //
 309                   if (dyn==0)
 310                           PackageReleaseBlackBoxDescriptorInternal(pack,dname);
 311 #else
 312                   PackageReleaseBlackBoxDescriptorInternal(pack,dname);
 313 #endif
 314       }
 315
 316     // If the package is released and dynamically loaded
 317     // then put it in the static list mReleasedDynamicallyLoadedPackages
 318     UnLoadDynamicLibrary(pack,false);
 319
 320     bbtkDebugMessage("package",4,"<== Package::ReleaseBlackBoxDescriptor('"<<
 321                      packname<<"','"<<dname<<"'): refs="
 322                      <<descr.use_count()<<bbtkendl);
 323     /*
 324     if (!pack.expired())
 325       {
 326         long dyn = pack.lock()->mDynamicLibraryHandler ? 1:0;
 327         long ndesc = pack.lock()->GetDescriptorMap().size();
 328         long nrefs = pack.use_count();
 329
 330         bbtkDebugMessage("package",3," ... Package still alive ("
 331                          <<nrefs<<" refs / "
 332                          <<ndesc<<" descr / dyn="
 333                          <<dyn<<")"<<std::endl);
 334       }
 335     else
 336       {
 337         bbtkDebugMessage("package",3,"   ... Package has been released"
 338                          <<std::endl);
 339       }
 340     */
 341   }
 342   //==========================================================================
 343
 344   //==========================================================================
 345   /// Opens a dynamic library which contains a bbtk package
 346   /// Returns the handler
 347   /// Load the package management symbols from the lib
 348   /// returns false if a problem occured hence can be used
 349   /// to test that a dyn lib is a valid bbtk package lib
 350   /// NB : The BBTK version exported from the library
 351   ///      is tested against the current bbtk version
 352   DynamicLibraryHandler Package::OpenDynamicLibrary( const std::string& libname,const std::string& package_name,
 353                                                                                                          DLGetPackageFunction& getpack, DLDeletePackageFunction& delpack)
 354   {
 355     bbtkDebugMessage("package",3,"==> Package::OpenDynamicLibrary("
 356                      <<libname<<")"<<std::endl);
 357 #if defined(__GNUC__)
 358
 359     // Open shared lib
 360     void *handler;
 361     handler = dlopen(libname.c_str(), BBTK_RTLD_TIME | BBTK_RTLD_SCOPE );
 362 //EED     handler = dlopen(libname.c_str(), RTLD_LAZY | RTLD_LOCAL );
 363
 364     if (!handler)
 365       {
 366         bbtkMessage("package",0,
 367                     "BBTK ..ERROR.. loading could not open shared library [" <<libname<<"] : "
 368                     <<dlerror() << std::endl);
 369         return 0;
 370       }
 371
 372     bbtkDebugMessage("package",3,"* Shared lib ["<<libname<<"] open"<<std::endl);
 373
 374     // Loads the Package bbtk version function
 375     std::string getvername(package_name);
 376     getvername += BBTK_STRINGIFY_SYMBOL(BBTK_GET_PACKAGE_BBTK_VERSION_FUNCTION_NAME);
 377     DLGetPackageBBTKVersionFunction getbbtkversion  = (DLGetPackageBBTKVersionFunction)(dlsym(handler,getvername.c_str()));
 378     if (!getbbtkversion)
 379       {
 380         bbtkDebugMessage("package",3,"***"<<std::endl);
 381         bbtkMessage("package",0,
 382                     "BBTK ..ERROR.. loading shared library ["<<libname
 383                     <<"] is not a valid bbtk package."
 384                     <<" Symbol ["<<getvername<<"] :"<<dlerror()<< std::endl);
 385         dlclose(handler);
 386         return 0;
 387       }
 388
 389     bbtkDebugMessage("package",3,"* Symbol ["<<getvername
 390                      <<"] found"<<std::endl);
 391     // version matches ?
 392     if (getbbtkversion() != bbtk::GetVersion())
 393       {
 394         bbtkMessage("package",0,
 395                     "BBTK ..ERROR.. loading: "<<package_name
 396                         <<" - Shared library ["<<libname
 397                     <<"] was build with bbtk version "
 398                     <<getbbtkversion()
 399                     <<" but the current program runs with version "
 400                     <<bbtk::GetVersion()<<" : cannot load it. You have to recompile your BBTK-Package."<<std::endl);
 401         dlclose(handler);
 402         return 0;
 403
 404       }
 405
 406     bbtkDebugMessage("package",3,"* Package bbtk version '"<<getbbtkversion()<<"' matches"<<std::endl);
 407             // Loads the Package get function
 408     std::string getpackname(package_name);
 409     getpackname += BBTK_STRINGIFY_SYMBOL(BBTK_GET_PACKAGE_FUNCTION_NAME);
 410     getpack = (DLGetPackageFunction)(dlsym(handler, getpackname.c_str()));
 411     if (!getpack)
 412       {
 413         bbtkMessage("package",0,
 414                     "BBTK ..ERROR.. loading shared library ["<<libname
 415                     <<"] is not a valid bbtk package."
 416                     <<" Symbol ["<<getpackname<<"] :"<<dlerror()<< std::endl);
 417         dlclose(handler);
 418         return 0;
 419       }
 420
 421     bbtkDebugMessage("package",3,"* Symbol ["<<getpackname<<"] found"<<std::endl);
 422     // Loads the Package delete function
 423
 424     std::string delpackname(package_name);
 425     delpackname += BBTK_STRINGIFY_SYMBOL(BBTK_DEL_PACKAGE_FUNCTION_NAME);
 426     delpack = (DLDeletePackageFunction)(dlsym(handler, delpackname.c_str()));
 427     if (!delpack)
 428       {
 429         bbtkMessage("package",0,
 430                     "BBTK ..ERROR.. loading shared library ["<<libname
 431                     <<"] is not a valid bbtk package."
 432                     <<" Symbol ["<<delpackname<<"] :"<<dlerror()<< std::endl);
 433         dlclose(handler);
 434         return 0;
 435       }
 436     bbtkDebugMessage("package",3,"* Symbol ["<<delpackname<<"] found"<<std::endl);
 437 #elif defined(_WIN32)
 438
 439     HINSTANCE handler;
 440
 441     SetErrorMode(0);
 442     // Open shared lib
 443     handler = LoadLibrary(libname.c_str());
 444     if (!handler)
 445       {
 446         bbtkMessage("package",0,
 447                     "BBTK ..ERROR..  could not open shared library [" <<libname<<"]"
 448                     << std::endl);
 449         DWORD dwErrorCode = 0;
 450         dwErrorCode = GetLastError();
 451         bbtkMessage("package",2,
 452                 "Windows Error: [" << dwErrorCode <<"]"
 453                 << std::endl);
 454
 455         return 0;
 456       }
 457
 458     // Loads the Package bbtk version function
 459     std::string getvername(package_name);
 460     getvername += BBTK_STRINGIFY_SYMBOL(BBTK_GET_PACKAGE_BBTK_VERSION_FUNCTION_NAME);
 461     DLGetPackageBBTKVersionFunction getbbtkversion = (DLGetPackageBBTKVersionFunction)(GetProcAddress(handler, getvername.c_str()));
 462
 463     if (!getbbtkversion)
 464       {
 465         FreeLibrary(handler);
 466         bbtkMessage("package",0,
 467                     "BBTK ..ERROR.. loading shared library ["<<libname
 468                     <<"] is not a valid bbtk package."
 469                     <<" Symbol ["<<getbbtkversion<<"] not found"<< std::endl);
 470         return 0;
 471       }
 472
 473     // version matches ?
 474     if (getbbtkversion() != bbtk::GetVersion())
 475       {
 476                   FreeLibrary(handler);
 477                   bbtkMessage("package",0,
 478                                 "BBTK ..ERROR.. loading: "<<package_name
 479                                 <<" - Shared library ["<<libname
 480                                 <<"] was build with bbtk version "
 481                                 <<getbbtkversion()
 482                                 <<" but the current program runs with version "
 483                                 <<bbtk::GetVersion()<<" : cannot load it. You have to recompile your BBTK-Package."<<std::endl);
 484                   return 0;
 485       }
 486
 487      // Loads the Package get function
 488     std::string getpackname(package_name);
 489     getpackname += BBTK_STRINGIFY_SYMBOL(BBTK_GET_PACKAGE_FUNCTION_NAME);
 490     getpack = (DLGetPackageFunction)(GetProcAddress(handler, getpackname.c_str()));
 491     if (!getpack)
 492       {
 493         FreeLibrary(handler);
 494         bbtkMessage("package",0,
 495                     "BBTK ..ERROR.. loading shared library ["<<libname
 496                     <<"] is not a valid bbtk package."
 497                     <<" Symbol ["<<getpackname<<"] not found"<< std::endl);
 498         return 0;
 499       }
 500
 501     // Loads the Package delete function
 502     std::string delpackname(package_name);
 503     delpackname += BBTK_STRINGIFY_SYMBOL(BBTK_DEL_PACKAGE_FUNCTION_NAME);
 504     delpack = (DLDeletePackageFunction)(GetProcAddress(handler, delpackname.c_str()));
 505     if (!delpack)
 506       {
 507         FreeLibrary(handler);
 508         bbtkMessage("package",0,
 509                     "BBTK ..ERROR.. loading shared library ["<<libname
 510                     <<"] is not a valid bbtk package."
 511                     <<" Symbol ["<<delpackname<<"] not found"<< std::endl);
 512         return 0;
 513       }
 514
 515 #else
 516     bbtkError("neither __GNUC__ nor _WIN32 ?!? How did you compile ?");
 517 #endif
 518
 519     return handler;
 520   }
 521   //==========================================================================
 522
 523   //==========================================================================
 524   /// Loads a package from a dynamic library
 525   Package::Pointer Package::CreateFromDynamicLibrary(const std::string& libname,
 526                                                      const std::string& pkgname,
 527                                                      const std::string& path)
 528   {
 529     bbtkDebugMessage("package",1,"==> Package::CreateFromDynamicLibrary("
 530                      <<libname<<")"<<std::endl);
 531
 532     DLGetPackageFunction gf;
 533     DLDeletePackageFunction df;
 534     DynamicLibraryHandler h = Package::OpenDynamicLibrary(libname,
 535                                                           pkgname,
 536                                                           gf,df);
 537     if (h==0) return Package::Pointer();
 538     Package::Pointer p = gf();
 539     p->mDynamicLibraryHandler = h;
 540     p->mDLDeletePackageFunction = df;
 541
 542     std::string separator =
 543       ConfigurationFile::GetInstance().Get_file_separator ();
 544     //BBTK_STRINGIFY_SYMBOL(BBTK_DOC_REL_PATH)
 545     std::string docreldoc =
 546       separator + "bbdoc" + separator + pkgname + separator + "index.html";
 547     std::string reldoc =
 548       ".." + separator + ".." + docreldoc;
 549     std::string doc = path + separator + ".." + separator
 550       + BBTK_STRINGIFY_SYMBOL(BBTK_DOC_REL_PATH)
 551       + docreldoc;
 552
 553     p->SetDocURL(doc);
 554     p->SetDocRelativeURL(reldoc);
 555
 556     bbtkDebugMessage("package",2,"<== Package::CreateFromDynamicLibrary("
 557                      <<libname<<") .. OK"<<std::endl);
 558     return p;
 559   }
 560   //==========================================================================
 561
 562
 563
 564
 565   //==========================================================================
 566   /// UnLoads the package dynamic library (if any)
 567   void Package::UnLoadDynamicLibrary(Package::WeakPointer pack, bool doit)
 568   {
 569     if (pack.expired() || (!pack.lock()->mDynamicLibraryHandler))
 570       return;
 571
 572     std::string packname = pack.lock()->GetName();
 573     bbtkDebugMessage("package",5,"==> Package::UnLoadDynamicLibrary('"
 574                      <<packname<<"')"
 575                      <<std::endl);
 576
 577     if (!pack.lock()->GetDescriptorMap().empty())
 578       {
 579
 580         bbtkDebugMessage("package",5,"   Package not empty ... abort"
 581                          <<std::endl);
 582         return;
 583         /*
 584         bbtkGlobalError("Package::UnLoadDynamicLibrary('"<<packname<<") : "
 585                         <<"DescriptorMap not empty "
 586                         <<BBTK_INTERNAL_ERROR_MESSAGE);
 587         */
 588       }
 589
 590     if (pack.use_count()!=1)
 591       {
 592         bbtkGlobalError("Package::UnLoadDynamicLibrary('"<<packname<<") : "
 593                         <<"empty dl package with external refs"
 594                         <<BBTK_INTERNAL_ERROR_MESSAGE);
 595       }
 596
 597     if (doit)
 598       {
 599         UnLoad(pack);
 600         bbtkDebugMessage("package",5,"==> dynamic library for package '"
 601                          <<packname<<"' closed"
 602                          <<std::endl);
 603       }
 604     else
 605       {
 606         mReleasedDynamicallyLoadedPackages.insert(pack);
 607         bbtkDebugMessage("package",1,"==> package '"<<packname
 608                          <<"' put in the 'to unload' list"
 609                          <<std::endl);
 610       }
 611
 612     bbtkDebugMessage("package",5,"<== Package::UnLoadDynamicLibrary('"
 613                      <<packname<<"')"
 614                      <<std::endl);
 615   }
 616   //==========================================================================
 617
 618   //==========================================================================
 619   /// UnLoads released packages that were loaded dynamically
 620   /// see UnLoadDynamicLibrary and ReleaseBlackBoxDescriptor
 621   void Package::UnLoadReleasedDynamicallyLoadedPackages()
 622   {
 623     bbtkDebugMessage("package",5,"==> Package::UnLoadReleasedDynamicallyLoadedPackages()"<<std::endl);
 624
 625     std::set<Package::WeakPointer>::iterator i;
 626
 627 //JCP- 21-04-09
 628         if(mReleasedDynamicallyLoadedPackages.size()>0){
 629                 for (i=mReleasedDynamicallyLoadedPackages.begin();
 630                 i!=mReleasedDynamicallyLoadedPackages.end();
 631                 ++i)
 632                 {
 633                 if (!i->expired()) UnLoad(*i);
 634                 }
 635         }
 636 //JCP- 21-04-09
 637     bbtkDebugMessage("package",5,"<== Package::UnLoadReleasedDynamicallyLoadedPackages()"<<std::endl);
 638   }
 639   //==========================================================================
 640
 641   //==========================================================================
 642   void Package::UnLoad(Package::WeakPointer pack)
 643   {
 644     std::string packname = pack.lock()->GetName();
 645     bbtkDebugMessage("package",6,"==> Package::UnLoad("<<packname<<")"<<std::endl);
 646
 647     Package* p = pack.lock().get();
 648
 649     DynamicLibraryHandler h = p->mDynamicLibraryHandler;
 650
 651     // deletes the package
 652     p->mDLDeletePackageFunction();
 653
 654     // closes the dl handler
 655 #if defined(__GNUC__)
 656           if (dlclose(h)!=0)
 657           {
 658                   printf("EED Package::UnLoad ERROR %s\n", packname.c_str() );
 659                   bbtkWarning("Failed to close dynamic library for package '"<<packname
 660                                           <<"'"<<std::endl);
 661           }
 662
 663 #elif defined(_WIN32)
 664     FreeLibrary(h);
 665 #endif
 666
 667     bbtkDebugMessage("package",1,"==> dynamic library for package '"
 668                      <<packname<<"' closed"
 669                      <<std::endl);
 670     bbtkDebugMessage("package",6,"   ... dynamic library unloaded"<<std::endl);
 671   }
 672   //==========================================================================
 673
 674         bool Package::ifBoxExist( std::string type)
 675     {
 676                 bool ok=false;
 677                 DescriptorMapType::const_iterator i = mDescriptorMap.find(type);
 678                 if (i != mDescriptorMap.end())
 679                 {
 680                         ok=true;
 681                 }
 682                 return ok;
 683     }
 684
 685   //==========================================================================
 686   /// Creates an instance of a black box of type <type> with name <name>
 687   BlackBox::Pointer Package::NewBlackBox(const std::string& type,
 688                                          const std::string& name) const
 689   {
 690     bbtkDebugMessageInc("kernel",8,"Package<"<<GetName()<<">::NewBlackBox(\""<<type<<"\",\""<<name<<"\")"<<bbtkendl);
 691
 692     DescriptorMapType::const_iterator i = mDescriptorMap.find(type);
 693     if (i == mDescriptorMap.end())
 694     {
 695            bbtkDebugDecTab("kernel",8);
 696            return BlackBox::Pointer();
 697     }
 698     BlackBox::Pointer bb =i->second->NewBlackBox(name);
 699     bbtkDebugDecTab("kernel",8);
 700     return bb;
 701
 702   }
 703   //==========================================================================
 704
 705
 706
 707   //==========================================================================
 708   /// Creates an instance of an adaptor of input type <typein> and
 709   /// output type <typeout>  with name <name>
 710   BlackBox::Pointer Package::NewAdaptor(const DataInfo& typein,
 711                                 const DataInfo& typeout,
 712                                 const std::string& name) const
 713   {
 714     bbtkDebugMessageInc("kernel",8,"Package<"<<GetName()<<
 715                         ">::NewAdaptor("
 716                         <<typein<<","
 717                         <<typeout<<",\""
 718                         <<name<<"\")"<<bbtkendl);
 719
 720     AdaptorKey key(typein,typeout,
 721                    BlackBoxDescriptor::DEFAULT_ADAPTOR);
 722     AdaptorMapType::const_iterator i = mAdaptorMap.find(key);
 723     if (i == mAdaptorMap.end())
 724       {
 725         bbtkDebugDecTab("kernel",8);
 726         return BlackBox::Pointer();
 727       }
 728     BlackBox::Pointer bb =i->second.lock()->NewBlackBox(name);
 729     bbtkDebugDecTab("kernel",8);
 730     return bb;
 731
 732   }
 733   //==========================================================================
 734
 735   //==========================================================================
 736   /// Creates an instance of an adaptor of input type <typein> and
 737   /// output type <typeout>  with name <name>
 738   BlackBox::Pointer Package::NewWidgetAdaptor(const DataInfo& typein,
 739                                       const DataInfo& typeout,
 740                                       const std::string& name) const
 741   {
 742     bbtkDebugMessageInc("kernel",8,"Package<"<<GetName()<<
 743                         ">::NewWidgetAdaptor("
 744                         <<typein<<","
 745                         <<typeout<<",\""
 746                         <<name<<"\")"<<bbtkendl);
 747
 748     AdaptorKey key(typein,typeout,
 749                    BlackBoxDescriptor::DEFAULT_GUI);
 750     AdaptorMapType::const_iterator i = mAdaptorMap.find(key);
 751     if (i == mAdaptorMap.end())
 752       {
 753         bbtkDebugDecTab("kernel",8);
 754         return BlackBox::Pointer();
 755       }
 756     BlackBox::Pointer bb =i->second.lock()->NewBlackBox(name);
 757     bbtkDebugDecTab("kernel",8);
 758     return bb;
 759
 760   }
 761   //==========================================================================
 762
 763
 764
 765   //==========================================================================
 766   /// Returns true is the package contains
 767   /// an adaptor of input type <typein> and
 768   /// output type <typeout>
 769   /// If successfull then adaptor contains the black box type name
 770   bool Package::FindWidgetAdaptor(const DataInfo& typein,
 771                                   const DataInfo& typeout,
 772                                   std::string& adaptor) const
 773   {
 774     bbtkDebugMessageInc("kernel",8,"Package<"<<GetName()<<
 775                         ">::FindWidgetAdaptor("
 776                         <<typein<<","
 777                         <<typeout<<")"<<bbtkendl);
 778
 779     AdaptorKey key(/*typein*/
 780                    DataInfo(typeid(void),""),
 781                    typeout,
 782                    BlackBoxDescriptor::DEFAULT_GUI);
 783     // First try to find a single widget adaptor
 784     AdaptorMapType::const_iterator i = mAdaptorMap.find(key);
 785     if (i == mAdaptorMap.end())
 786       {
 787         bbtkDebugDecTab("kernel",8);
 788         return false;
 789       }
 790     adaptor = i->second.lock()->GetTypeName();
 791     bbtkDebugDecTab("kernel",8);
 792     return true;
 793
 794   }
 795   //==========================================================================
 796
 797
 798
 799   //==========================================================================
 800   /// Returns true is the package contains
 801   /// an adaptor of input type <typein> and
 802   /// output type <typeout>
 803   /// If successfull then adaptor contains the black box type name
 804   bool Package::FindAdaptor(const DataInfo& typein,
 805                             const DataInfo& typeout,
 806                             std::string& adaptor) const
 807   {
 808     bbtkDebugMessageInc("kernel",8,"Package<"<<GetName()<<
 809                         ">::FindAdaptor("
 810                         <<typein<<","
 811                         <<typeout<<")"<<bbtkendl);
 812
 813     AdaptorKey key(typein,typeout,
 814                    BlackBoxDescriptor::DEFAULT_ADAPTOR);
 815     AdaptorMapType::const_iterator i = mAdaptorMap.find(key);
 816     if (i == mAdaptorMap.end())
 817       {
 818         bbtkDebugDecTab("kernel",8);
 819         return false;
 820       }
 821     adaptor = i->second.lock()->GetTypeName();
 822     bbtkDebugDecTab("kernel",8);
 823     return true;
 824
 825   }
 826   //==========================================================================
 827
 828
 829   //==========================================================================
 830   /// Registers a black box descriptor in the package
 831   bool Package::Register(BlackBoxDescriptor::Pointer d)
 832   {
 833     bbtkDebugMessageInc("kernel",8,"Package<"<<GetName()<<">::Register(\""<<d->GetTypeName()<<"\")"<<std::endl);
 834
 835     DescriptorMapType::iterator i = mDescriptorMap.find(d->GetTypeName());
 836     if (i!=mDescriptorMap.end())
 837       {
 838         bbtkWarning("Package<"<<GetName()<<"> : Trying to register box type <"
 839                     <<d->GetTypeName()<<"> which is already in the package");
 840         return false;
 841       }
 842
 843     mDescriptorMap[d->GetTypeName()] = d;
 844     //    d->Reference();
 845     d->SetPackage(GetThisPointer<Package>());
 846
 847     // If it is a default adaptor, also register it in the adaptors map
 848     if ( d->GetKind() == BlackBoxDescriptor::DEFAULT_ADAPTOR )
 849       {
 850         bbtkDebugMessage("kernel",8,"Package<"<<GetName()<<">::Register(\""<<d->GetTypeName()<<"\") : The box is an adaptor, inserting it in adaptors map ..."<<std::endl);
 851
 852         TypeInfo typein = d->GetInputDescriptor("In")->GetTypeInfo();
 853         TypeInfo typeout = d->GetOutputDescriptor("Out")->GetTypeInfo();
 854         DataInfo infoin(typein,d->GetInputDescriptor("In")->GetNature());
 855         DataInfo infoout(typeout,d->GetOutputDescriptor("Out")->GetNature());
 856         AdaptorKey key(infoin,infoout,d->GetKind());
 857
 858         AdaptorMapType::const_iterator i;
 859         i = mAdaptorMap.find(key);
 860         if (i == mAdaptorMap.end())
 861           {
 862             mAdaptorMap[key] = d;
 863           }
 864         // If already an adaptor registered : error
 865         else
 866           {
 867             if (i->second.lock()->GetTypeName() != d->GetTypeName())
 868               {
 869                 bbtkError("Package <"<<GetName()<<
 870                           "> : trying to register black box <"
 871                           <<d->GetTypeName()
 872                           <<"> as default adaptor but there is already a default adaptor registered (<"
 873                           <<i->second.lock()->GetTypeName()<<">)");
 874               }
 875           }
 876       }
 877     // If it is a default adaptor, also register it in the adaptors map
 878     else if ( d->GetKind() == BlackBoxDescriptor::DEFAULT_GUI)
 879       {
 880         bbtkDebugMessage("kernel",8,"Package<"<<GetName()<<">::Register(\""<<d->GetTypeName()<<"\") : The box is a widget adaptor, inserting it in adaptors map ..."<<std::endl);
 881
 882         TypeInfo typeout = d->GetOutputDescriptor("Out")->GetTypeInfo();
 883         DataInfo infoin(typeid(void),"");
 884         DataInfo infoout(typeout,d->GetOutputDescriptor("Out")->GetNature());
 885         AdaptorKey key(infoin,infoout,d->GetKind());
 886
 887         AdaptorMapType::const_iterator i;
 888         i = mAdaptorMap.find(key);
 889         if (i == mAdaptorMap.end())
 890           {
 891             mAdaptorMap[key] = d;
 892           }
 893         // If already an adaptor registered : error
 894         else
 895           {
 896             if (i->second.lock()->GetTypeName() != d->GetTypeName())
 897               {
 898                 bbtkError("Package <"<<GetName()<<
 899                           "> : trying to register black box <"
 900                           <<d->GetTypeName()
 901                           <<"> as default widget adaptor but there is already a default adaptor registered (<"
 902                           <<i->second.lock()->GetTypeName()<<">)");
 903               }
 904           }
 905       }
 906
 907
 908     bbtkDebugDecTab("kernel",8);
 909
 910     return true;
 911   }
 912   //==========================================================================
 913
 914   //===================================================================
 915   void Package::Check() const
 916   {
 917     bbtkMessage("debug",1,"****** Checking Package "<<(void*)this
 918                 <<" ["<<GetName()<<"]"<<std::endl);
 919     DescriptorMapType::const_iterator i;
 920     for (i=mDescriptorMap.begin();
 921          i!=mDescriptorMap.end();
 922          ++i)
 923       {
 924         i->second->Check(true);
 925       }
 926     bbtkMessage("debug",1,"****** Checking Package "<<(void*)this
 927                 <<" ["<<GetName()<<"] ... OK"<<std::endl);
 928   }
 929   //===================================================================
 930
 931
 932   //==========================================================================
 933   /// Changes the name of a black box type
 934   void Package::ChangeDescriptorName( const std::string& oldname, const std::string& newname )
 935   {
 936     bbtkDebugMessageInc("kernel",8,"Package<"<<GetName()
 937                         <<">::ChangeDescriptorName(\""<<oldname
 938                         <<"\",\""<<newname<<"\")"<<std::endl);
 939     // Looking into the bb map
 940     DescriptorMapType::iterator i = mDescriptorMap.find(oldname);
 941     if (i == mDescriptorMap.end())
 942       {
 943          bbtkDebugDecTab("kernel",8);
 944          bbtkError("ChangeDescriptorName : The package <"<<GetName()<<"> does not contains the black box <"<<oldname<<">");
 945       }
 946
 947     i->second->SetTypeName(newname);
 948     mDescriptorMap[newname] = i->second;
 949     mDescriptorMap.erase(i);
 950
 951     bbtkDebugDecTab("kernel",8);
 952   }
 953   //==========================================================================
 954
 955
 956
 957   //==========================================================================
 958   void Package::PrintHelpListDescriptors(bool description, bool adaptors) const
 959   {
 960     unsigned int lmax = 0;
 961     std::vector<std::string> names;
 962     std::vector<std::string> kinds;
 963     std::vector<std::string> descrs;
 964
 965     DescriptorMapType::const_iterator i;
 966     for (i=mDescriptorMap.begin();
 967          i!=mDescriptorMap.end();
 968          ++i)
 969       {
 970         if ( adaptors ||
 971              ( i->second->GetKind() == BlackBoxDescriptor::STANDARD) )
 972           {
 973             std::string name("  ");
 974             name += i->second->GetTypeName();
 975             names.push_back(name);
 976
 977             std::string kind;
 978             if ( i->second->GetKind() == BlackBoxDescriptor::ADAPTOR )
 979               {
 980                 kind = std::string("[A]");
 981               }
 982             else if ( i->second->GetKind() ==
 983                       BlackBoxDescriptor::DEFAULT_ADAPTOR )
 984               {
 985                 kind = std::string("[DA]");
 986               }
 987             kinds.push_back(kind);
 988
 989             unsigned int l = name.size()+kind.size();
 990             if (l>lmax) lmax = l;
 991
 992             std::string descr;
 993             if (description)
 994               {
 995                 descr += " : ";
 996                 descr += i->second->GetDescription();
 997               }
 998             descrs.push_back(descr);
 999           }
1000       }
1001
1002
1003     std::string offs;
1004     offs.append(lmax+3,' ');
1005     std::vector<std::string>::iterator ni,ci,di;
1006     for (ni = names.begin(), ci = kinds.begin(), di = descrs.begin();
1007          ni != names.end(); ++ni, ++ci, ++di)
1008       {
1009         std::string space;
1010         space.append(lmax - ni->size() - ci->size(),' ');
1011         bbtkMessage("help",1,*ni << space << *ci );
1012         std::string d(*di);
1013         unsigned int dmax = 75 - lmax;
1014         //      while (d.size() > dmax )
1015         //  {
1016         if (d.size()>dmax)
1017           bbtkMessage("help",1,d.substr(0,dmax) << "..." << std::endl);
1018         else
1019           bbtkMessage("help",1,d << std::endl);
1020         //    d = d.substr(dmax,d.size());
1021         //  }
1022       }
1023
1024   }
1025   //==========================================================================
1026
1027   //==========================================================================
1028   /// Displays the list of adaptors of the package
1029   void Package::PrintHelpListAdaptors(bool description) const
1030   {
1031     DescriptorMapType::const_iterator i;
1032     for (i=mDescriptorMap.begin();
1033          i!=mDescriptorMap.end();
1034          ++i)
1035       {
1036         if ( i->second->GetKind() != BlackBoxDescriptor::STANDARD )
1037           {
1038             bbtkMessage("help",1,
1039                         "  "<<i->second->GetTypeName());
1040             if ( i->second->GetKind() ==
1041                  BlackBoxDescriptor::DEFAULT_ADAPTOR )
1042               {
1043                 bbtkMessage("help",1,
1044                             " [default]");
1045               }
1046             if (description)
1047               {
1048                 bbtkMessage("help",1,
1049                             " : "<<i->second->GetDescription());
1050
1051               }
1052             bbtkMessage("help",1,std::endl);
1053           }
1054       }
1055     /*
1056     AdaptorMapType::const_iterator i;
1057     for (i=mAdaptorMap.begin();
1058          i!=mAdaptorMap.end();
1059          ++i)
1060       {
1061         bbtkMessage("help",1,
1062                     "  "<<i->second->GetTypeName());
1063         if (detail_level>0)
1064           {
1065             bbtkMessage("help",1,
1066                         " : "<<i->second->GetDescription());
1067
1068           }
1069         bbtkMessage("help",1,std::endl);
1070       }
1071     */
1072   }
1073   //==========================================================================
1074
1075   //==========================================================================
1076   /// Prints help on a black box descriptor
1077   void Package::PrintHelpDescriptor(const std::string& name, bool full) const
1078   {
1079     bbtkDebugMessageInc("kernel",8,"Package<"<<GetName()
1080                         <<">::PrintHelpDescriptor(\""
1081                         <<name<<"\")"<<bbtkendl);
1082
1083     DescriptorMapType::const_iterator i = mDescriptorMap.find(name);
1084     if (i == mDescriptorMap.end())
1085       {
1086         bbtkDebugDecTab("kernel",8);
1087         bbtkError("The package <"<<GetName()<<"> does not contains the black box <"<<name<<">");
1088       }
1089     //    bbtkMessage("help",1,"["<<GetName()<<"] ");
1090     i->second->GetHelp(full);
1091     bbtkDebugDecTab("kernel",8);
1092
1093   }
1094   //==========================================================================
1095
1096
1097   //==========================================================================
1098   /// Returns true iff the package contains the box of name boxname
1099   bool Package::ContainsDescriptor(const std::string& name) const
1100   {
1101     bbtkDebugMessageInc("kernel",8,"Package<"<<GetName()
1102                         <<">::ContainsDescriptor(\""
1103                         <<name<<"\")"<<bbtkendl);
1104
1105     DescriptorMapType::const_iterator i = mDescriptorMap.find(name);
1106     if (i == mDescriptorMap.end())
1107     {
1108       bbtkDebugDecTab("kernel",8);
1109       return false;
1110     }
1111     bbtkDebugDecTab("kernel",8);
1112     return true;
1113   }
1114   //==========================================================================
1115
1116
1117
1118   //==========================================================================
1119   void Package::CreateHtmlPage(const std::string& filename,
1120                                const std::string& caller,
1121                                const std::string& source,
1122                                const std::string& custom_header,
1123                                const std::string& custom_title,
1124                                int detail,
1125                                int level,
1126                                bool relative_link ) const
1127   {
1128     bbtkDebugMessageInc("kernel",9,"Package<"<<GetName()<<">::CreateHtmlPage(\""
1129                         <<filename<<"\")"<<bbtkendl);
1130
1131 //std::cout<<"JCP bbtkPackage.cxx void Package::CreateHtmlPage() ln 1133"<<std::endl;
1132
1133     //---------------------
1134     // Open output file
1135     std::ofstream s;
1136     s.open(filename.c_str());
1137     if (!s.good())
1138     {
1139        bbtkError("Package "<<GetName()<<" : CreateHtmlPage : could not open file '"<<filename<<"'");
1140     }
1141
1142     //----------------------
1143     // Html head
1144     std::string title = "BBTK Package "+GetName()+" "+GetVersion();
1145
1146     if (custom_title.length() != 0) title = custom_title;
1147
1148     s << "<html lang=\"en\">\n";
1149     s << "<head>\n";
1150     s << "<title>" << title << "</title>\n";
1151     s << "<meta http-equiv=\"Content-Type\" content=\"text/html\">\n";
1152     s << "<meta name=\"description\" content=\""<<title<<"\">\n";
1153     s << "<meta name=\"generator\" content=\"\">\n";
1154     s << "<link title=\"Top\" rel=\"top\" href=\"#Top\">\n";
1155     //<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
1156     s << "<meta http-equiv=\"Content-Style-Type\" content=\"text/css\"><style type=\"text/css\"><!--\n";
1157     s << "pre.display { font-family:inherit }\n";
1158     s << "pre.format  { font-family:inherit }\n";
1159     s << "pre.smalldisplay { font-family:inherit; font-size:smaller }\n";
1160     s << "pre.smallformat  { font-family:inherit; font-size:smaller }\n";
1161     s << "pre.smallexample { font-size:smaller }\n";
1162     s << "pre.smalllisp    { font-size:smaller }\n";
1163     s << "span.sc    { font-variant:small-caps }\n";
1164     s << "span.roman { font-family:serif; font-weight:normal; } \n";
1165     s << "span.sansserif { font-family:sans-serif; font-weight:normal; }\n";
1166     s << "--></style>\n";
1167     s << "</head>\n";
1168     //----------------------
1169
1170     //----------------------
1171     // Html body
1172     s << "<body>\n";
1173     s << "<a name=\"Top\"></a>\n";
1174
1175     //----------------------
1176     // Header
1177     if ( custom_header.length() != 0)
1178       {
1179         if ( custom_header != "none" )
1180           {
1181             std::ifstream in;
1182             in.open(custom_header.c_str());
1183             if (!in.good())
1184               {
1185                 bbtkError("Could not open file \""<<custom_header<<"\"");
1186               }
1187             char buffer[512];
1188             while (!in.eof())
1189               {
1190                 in.getline(buffer,512);
1191                 std::string line(buffer);
1192                 s << line;
1193               }
1194             in.close();
1195             s << "<hr>\n";
1196
1197             /*
1198             s << "<object data=\"" << custom_header
1199               << "\" type = \"text/html\"\"style=\"width: 1200px; height: 400px;\"> Warning: "
1200               << custom_header <<" could not be embedded.</object>\n";
1201
1202             s << "<hr>\n";
1203             */
1204           }
1205       }
1206
1207     else
1208       {
1209         s << "<h1 class=\"settitle\">"<<title<<"</h1>\n";
1210         s << "<p><TABLE cellspacing=0  cellpadding=3>\n";
1211         s << "<TR><TD style='vertical-align: top;'><b> Description </b></TD><TD style='vertical-align: top;'> : </TD><TD style='vertical-align: top;'> "
1212           << GetDescription() << "</TD></TR>\n";
1213         s << "<TR><TD style='vertical-align: top;'><b> Author(s) </b></TD><TD style='vertical-align: top;'> : </TD><TD style='vertical-align: top;'>  "
1214           << GetAuthor() << "</TD></TR>\n";
1215         s << "<TR><TD style='vertical-align: top;'><b> Author(s) </b></TD><TD style='vertical-align: top;'> : </TD><TD style='vertical-align: top;'>  "
1216           << GetCategory() << "</TD></TR>\n";
1217         s << "<TR><TD style='vertical-align: top;'><b> Version </b></TD><TD style='vertical-align: top;'> : </TD><TD style='vertical-align: top;'> "
1218           << GetVersion() << "</TD></TR>\n";
1219         s << "<TR><TD style='vertical-align: top;'><b> bbtk Version </b></TD><TD style='vertical-align: top;'> : </TD><TD style='vertical-align: top;'> "
1220           << bbtk::GetVersion() << "</TD></TR>\n";
1221         s << "</TABLE>\n";
1222       }
1223 //std::cout<<"JCP bbtkPackage.cxx void Package::CreateHtmlPage() ln 1225"<<std::endl;
1224     //-------------------
1225     // Table of contents
1226     // Black boxes list
1227     //  s << "<div class=\"contents\">\n";
1228     s << "<p><b> Black Boxes : </b>\n";
1229     s << "<ul>\n";
1230
1231     s << "<p><TABLE cellspacing=0  cellpadding=3>\n";
1232
1233     DescriptorMapType::const_iterator i;
1234 //std::cout<<"JCP bbtkPackage.cxx void Package::CreateHtmlPage() ln 1236"<<std::endl;
1235     for (i=mDescriptorMap.begin(); i!=mDescriptorMap.end(); ++i) {
1236                 if ( i->second->GetKind() != BlackBoxDescriptor::STANDARD)
1237                         continue;
1238
1239                 std::string name = i->second->GetTypeName();
1240                 Utilities::html_format(name);
1241                 std::string descr = i->second->GetDescription();
1242                 //Utilities::html_format(descr);
1243 //std::cout<<"JCP bbtkPackage.cxx void Package::CreateHtmlPage() ln 1246"<<std::endl;
1244                 s << "<TR>";
1245                 s << "<TD style='vertical-align: top;'>";
1246                 s << "&nbsp;&nbsp;&nbsp;<a name=\"toc_"<<name
1247                 <<"\" href=\"#"<<name<<"\">"
1248                 <<name<<"</a>";
1249                 s << "</TD> ";
1250                 s << " <TD style='vertical-align: top;'>" << descr << " </TD>";
1251                 s << "</TR>\n";
1252                 }
1253                 s << "</TABLE>\n";
1254
1255
1256                 s << "</ul>\n";
1257                 s << "</div>\n";
1258
1259                 //-------------------
1260                 // Adaptors list
1261                 if (mAdaptorMap.size()>0)
1262                 {
1263                         //  s << "<div class=\"contents\">\n";
1264                         s << "<p><b> Adaptors : </b>\n";
1265                         s << "<ul>\n";
1266 //std::cout<<"JCP bbtkPackage.cxx void Package::CreateHtmlPage() ln 1268"<<std::endl;
1267                         //    DescriptorMapType::const_iterator i;
1268                         s << "<p><TABLE cellspacing=0  cellpadding=3>\n";
1269                         for (i=mDescriptorMap.begin(); i!=mDescriptorMap.end();++i)
1270                         {
1271                                 if ( i->second->GetKind() == BlackBoxDescriptor::STANDARD)
1272                                         continue;
1273
1274                                 std::string name = i->second->GetTypeName();
1275                                 Utilities::html_format(name);
1276                                 std::string descr = i->second->GetDescription();
1277
1278                                 s << "<TR>";
1279                                 s << "<TD style='vertical-align: top;'>";
1280                                 s << "&nbsp;&nbsp;&nbsp;<a name=\"toc_"<<name
1281                                   <<"\" href=\"#"<<name<<"\">"
1282                                   <<name<<"</a>";
1283                                 s << "</TD> ";
1284                                 s << " <TD style='vertical-align: top;'>" << descr << " </TD>";
1285                                 s << "</TR>\n";
1286                         }
1287                         s << "</TABLE>\n";
1288
1289                         s << "</ul>\n";
1290                         s << "</div>\n";
1291                 }
1292
1293
1294     //  s << "<div class=\"node\">\n";
1295
1296     //    s << "<p><hr>\n";
1297     //    s << "<a name=\"Top\"></a>\n";
1298     //  s << "Top:&nbsp;<a rel=\"top\" accesskey=\"t\" href=\"#Top\">Top</a>\n";
1299     // s << "Previous:&nbsp;<a rel="previous" accesskey="p" href="#dir">(dir)</a>,
1300     // s << "Up:&nbsp;<a rel="up" accesskey="u" href="#dir">(dir)</a>
1301
1302     //    s << "</div>\n";
1303
1304     //----------------------
1305     // Boxes doc
1306
1307     //-------------------
1308     // Computes output directory from filename to pass it to
1309     // BlackBoxDescriptor::InsertHtmlHelp
1310                 std::string dir;
1311
1312                 std::string::size_type slash_position = filename.find_last_of("/\\");
1313
1314
1315                 if (slash_position != std::string::npos) {
1316                         if (slash_position == 0)
1317                          slash_position = 1;
1318                         dir = filename.substr(0,slash_position);
1319                 }
1320
1321                 for (i=mDescriptorMap.begin();
1322                  i!=mDescriptorMap.end();
1323                  ++i)
1324                 {
1325                         i->second->InsertHtmlHelp(s,detail,level,dir,relative_link);
1326                 }
1327
1328     //----------------------
1329     // Footer
1330     time_t rawtime;
1331     tm * ptm;
1332     time ( &rawtime );
1333     ptm = gmtime ( &rawtime );
1334
1335     s << "<p><hr>\n";
1336     s << "Automatically generated by <b>"<<caller<<"</b> "//from <b>"
1337       //      <<source<<"</b>
1338       <<"on "
1339       << ptm->tm_mday << "/" << ptm->tm_mon << "/" << ptm->tm_year+1900
1340       << " - " << ptm->tm_hour << ":" << ptm->tm_min << " GMT\n";
1341     s << "</body></html>\n";
1342     s.close();
1343     //----------------------
1344
1345     // End
1346     bbtkDebugDecTab("kernel",9);
1347   }
1348   //==========================================================================
1349
1350   //==========================================================================
1351   std::string  Package::GetObjectName() const
1352   {
1353     return std::string("Package '")+mName+std::string("'");
1354   }
1355   //==========================================================================
1356
1357   //==========================================================================
1358   std::string Package::GetObjectInfo() const
1359   {
1360     std::stringstream i;
1361     i << "  - "<<mDescriptorMap.size() << " boxes" << std::endl;
1362     if (mDynamicLibraryHandler)
1363       {
1364         i<< "  - Loaded from dynamic library"<<std::endl;
1365       }
1366     return i.str();
1367   }
1368   //==========================================================================
1369
1370
1371   //==========================================================================
1372   size_t  Package::GetObjectSize() const
1373   {
1374     size_t s = Superclass::GetObjectSize();
1375     s += Package::GetObjectInternalSize();
1376     return s;
1377   }
1378   //==========================================================================
1379   //==========================================================================
1380   size_t  Package::GetObjectInternalSize() const
1381   {
1382     size_t s = sizeof(Package);
1383     return s;
1384   }
1385   //==========================================================================
1386   //==========================================================================
1387   size_t  Package::GetObjectRecursiveSize() const
1388   {
1389     size_t s = Superclass::GetObjectRecursiveSize();
1390     s += Package::GetObjectInternalSize();
1391
1392     DescriptorMapType::const_iterator i;
1393     for (i = mDescriptorMap.begin(); i!=mDescriptorMap.end(); ++i )
1394       {
1395         s += i->second->GetObjectRecursiveSize();
1396       }
1397     return s;
1398   }
1399   //==========================================================================
1400
1401   //==========================================================================
1402   std::set<Package::WeakPointer>
1403   Package::mReleasedDynamicallyLoadedPackages;
1404   //==========================================================================
1405 }
1406