kernel/src/bbtkPackage.cxx

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