-/*=========================================================================
-
-Program: bbtk
-Module: $RCSfile: bbtkFactory.cxx,v $
-Language: C++
-
-Date: $Date: 2008/01/30 12:14:43 $
-Version: $Revision: 1.8 $
-
-
-Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
-l'Image). All rights reserved. See doc/license.txt or
-http://www.creatis.insa-lyon.fr/Public/bbtk/License.html for details.
+/*=========================================================================
+ Program: bbtk
+ Module: $RCSfile: bbtkFactory.cxx,v $
+ Language: C++
+ Date: $Date: 2009/03/30 15:22:51 $
+ Version: $Revision: 1.42 $
+=========================================================================*/
-This software is distributed WITHOUT ANY WARRANTY; without even
-the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
-PURPOSE. See the above copyright notices for more information.
+/* ---------------------------------------------------------------------
+
+* Copyright (c) CREATIS-LRMN (Centre de Recherche en Imagerie Medicale)
+* Authors : Eduardo Davila, Laurent Guigues, Jean-Pierre Roux
+*
+* This software is governed by the CeCILL-B license under French law and
+* abiding by the rules of distribution of free software. You can use,
+* modify and/ or redistribute the software under the terms of the CeCILL-B
+* license as circulated by CEA, CNRS and INRIA at the following URL
+* http://www.cecill.info/licences/Licence_CeCILL-B_V1-en.html
+* or in the file LICENSE.txt.
+*
+* As a counterpart to the access to the source code and rights to copy,
+* modify and redistribute granted by the license, users are provided only
+* with a limited warranty and the software's author, the holder of the
+* economic rights, and the successive licensors have only limited
+* liability.
+*
+* The fact that you are presently reading this means that you have had
+* knowledge of the CeCILL-B license and that you accept its terms.
+* ------------------------------------------------------------------------ */
-=========================================================================*/
/**
*\file
*\brief Class bbtk::Factory : can load and unload dynamic libraries containing
#include "bbtkConnection.h"
#include "bbtkConfigurationFile.h"
#include "bbtkUtilities.h"
+#include "bbtkConfigurationFile.h"
#include <sys/stat.h> // for struct stat stFileInfo
#include <direct.h> // for getcwd
#endif
+#include <cctype> // std::toupper
-// was in gdcm ...
-/*
-#ifdef _MSC_VER
-# define getcwd _getcwd
-#endif
-
-#if defined(_MSC_VER) || defined(__BORLANDC__)
-# include <direct.h>
-#else
-# include <unistd.h>
-#endif
-
-*/
-
+#include <time.h>
namespace bbtk
{
- typedef Package* (*PackageAccessor)();
- typedef void (*PackageDeleteFunction)();
+ //===================================================================
+ /// Default ctor
+ Factory::Pointer Factory::New()
+ {
+ bbtkDebugMessage("Kernel",9,"Factory::New()"<<std::endl);
+ return MakePointer(new Factory());
+ }
+ //===================================================================
//===================================================================
/// Default ctor
Factory::Factory()
+ : mExecuter()
{
- bbtkDebugMessage("Core",7,"Factory::Factory()"<<std::endl);
+ bbtkDebugMessage("Kernel",7,"Factory::Factory()"<<std::endl);
}
//===================================================================
/// Dtor
Factory::~Factory()
{
- bbtkDebugMessageInc("Core",7,"Factory::~Factory()"<<std::endl);
+ bbtkDebugMessageInc("Kernel",7,"Factory::~Factory()"<<std::endl);
CloseAllPackages();
- bbtkDebugDecTab("Core",7);
+ bbtkDebugDecTab("Kernel",7);
}
//===================================================================
- //===================================================================
- void Factory::CloseAllPackages()
- {
- bbtkDebugMessageInc("Core",7,"Factory::CloseAllPackages()"<<std::endl);
- while (mPackageMap.begin() != mPackageMap.end())
- {
- PackageMapType::iterator i = mPackageMap.begin();
- ClosePackage(i);
- }
- bbtkDebugDecTab("Core",7);
- }
- //===================================================================
//===================================================================
void Factory::Reset()
{
- bbtkDebugMessageInc("Core",7,"Factory::Reset()"<<std::endl);
+ bbtkDebugMessageInc("Kernel",7,"Factory::Reset()"<<std::endl);
CloseAllPackages();
- bbtkDebugDecTab("Core",7);
+ bbtkDebugDecTab("Kernel",7);
}
//===================================================================
-// ===================================================================================
-
+ // ===================================================================
bool Factory::DoLoadPackage(std::string libname,
std::string pkgname,
- std::string path,
- bool verbose)
+ std::string path)
{
-
-#if defined(__GNUC__)
-
- void *handler;
- handler = dlopen(libname.c_str(),
- BBTK_RTLD_TIME | BBTK_RTLD_SCOPE );
- if (!handler)
- {
- // The following is *NOT* a debug time message :
- // It's a user intended message.
- // Please don't remove it.
- if (verbose) {
- std::cout <<"[" <<libname<<"] can't be open" << std::endl;
- std::cout << " " <<dlerror() << std::endl;
- }
- return false; // try next path
- }
-
- // The following is *NOT* a debug time message :
- // It's a user intended message.
- // Please don't remove it.
- if (verbose)
- std::cout <<" -->[" <<libname<<"] found" << std::endl;
-
- // Loads the Package accessor
-
- std::string getpackname(pkgname);
- getpackname += "GetPackage";
- void *getpack = dlsym(handler, getpackname.c_str());
- if (!getpack)
- {
- dlclose(handler);
- bbtkError("GetPackage : could not load package \""<<pkgname
- <<"\" [symbol "<<getpackname<<"] :"<<dlerror());
- }
-
- // Verifies that the Package delete function is present
- std::string delfname(pkgname);
- delfname += "DeletePackage";
- void *delf = dlsym(handler, delfname.c_str());
- if (!delf)
- {
- dlclose(handler);
- bbtkError("DeletePackage : could not load package \""<<pkgname
- <<"\" [symbol "<<delfname<<"] :"<<dlerror());
- }
-
-#elif defined(_WIN32)
-
- HINSTANCE handler;
-
- SetErrorMode(0);
- handler = LoadLibrary(libname.c_str());
- if (!handler){
- if (verbose)
- // The following is *NOT* a debug time message :
- // It's a user intended message.
- // Please don't remove it.
- std::cout <<" no handler for [" <<libname<<"];" << std::endl;
- return false;// Problem with the found library
- }
- if (verbose)
- std::cout <<" --->[" <<libname<<"] found" << std::endl;
-
- // Loads the Package accessor
-
- std::string getpackname(pkgname);
- getpackname += "GetPackage";
- void *getpack = GetProcAddress(handler, getpackname.c_str());
- if (!getpack)
- {
- FreeLibrary(handler);
- bbtkError("[1]could not load package \""<<pkgname
- <<"\" : "<<getpackname<<" symbol not found (is it a bbtk package lib ?)");
- // look how to get the error message on win
- //<<dlerror());
- }
- // Verifies that the Package delete function is present
- std::string delfname(pkgname);
- delfname += "DeletePackage";
- void *delf = GetProcAddress(handler, delfname.c_str());
- if (!delf)
- {
- FreeLibrary(handler);
- bbtkError("[2]could not load package \""<<pkgname
- <<"\" : "<<delfname<<" symbol not found (is it a bbtk package lib ?)");
- // look how to get the error message on win
- //<<dlerror());
- }
-#else
- bbtkError("neither __GNUC__ nor _WIN32 ?!? How did you compile ?");
-#endif
-
- // Stores the package
- PackageInfoType pack;
- pack.mDynamicLibraryHandler = handler;
- // Invokes the accessor to the PackageUnit pointer
- pack.mPackage = ((PackageAccessor)getpack)();
-
- mPackageMap[pkgname] = pack;
-
- // Test bbtk build version ok
- if ( pack.mPackage->GetBBTKVersion() != bbtk::GetVersion() )
- {
- std::string v(pack.mPackage->GetBBTKVersion());
- UnLoadPackage(pkgname);
- bbtkError(" package build with bbtk version "
- << v
- << " whereas application build with version "
- << bbtk::GetVersion());
- }
-
- std::string separator =
- ConfigurationFile::GetInstance().Get_file_separator ();
- //BBTK_STRINGIFY_SYMBOL(BBTK_DOC_REL_PATH)
- std::string docreldoc = separator + "packages" + separator + pkgname
- + separator + "bbdoc" + separator + "index.html";
- std::string reldoc = ".." + separator + ".." + separator
- + ".." + docreldoc;
- std::string doc = path + separator + ".." + separator
- + BBTK_STRINGIFY_SYMBOL(BBTK_DOC_REL_PATH)
- + docreldoc;
-
- pack.mPackage->SetDocURL(doc);
- pack.mPackage->SetDocRelativeURL(reldoc);
-
- //===================================================================
- bbtkMessage("Output",2,pack.mPackage->GetName()<<" "
- <<pack.mPackage->GetVersion()
- <<" (bbtk "
- <<pack.mPackage->GetBBTKVersion()<<") "
- <<pack.mPackage->GetAuthor() << " Keyword(s) :"
- <<pack.mPackage->GetKeyword()
- <<std::endl);
- bbtkMessage("Output",2,pack.mPackage->GetDescription()<<std::endl);
- //===================================================================
-
- bbtkDebugDecTab("Core",7);
- return true;
+
+ Package::Pointer p = Package::CreateFromDynamicLibrary(libname,
+ pkgname,
+ path);
+ if (p!=0)
+ {
+ //===================================================================
+ bbtkMessage("Output",2,p->GetName()<<" "
+ <<p->GetVersion()
+ <<" "
+ <<p->GetAuthor() << " Category(s) :"
+ <<p->GetCategory()
+ <<std::endl);
+ bbtkMessage("Output",2,p->GetDescription()<<std::endl);
+ //===================================================================
+ p->AddFactory(GetThisPointer<Factory>());
+ mPackageMap[pkgname] = p;
+ return true;
+ }
+ return false;
+
}
-
+
//===================================================================
/// \brief Loads a package.
///
/// If it succeeds, then tries to load the symbols "<name>GetPackage" and "<name>DeletePackage".
/// "<name>GetPackage" is called to get the pointer on the bbtk::Package of the library
/// ("<name>DeletePackage" is not used, its presence is just checked before loading the package).
-
+
/// now, filename is only the last name (no longer the full name!)
/// it will be searched within *all* the paths given in bbtk_config.xml
+
- /// verbose = true (set by "config v") displays the loading process
-
- void Factory::LoadPackage( const std::string& name,
- bool use_configuration_file, bool verbose)
+
+ void Factory::LoadPackage( const std::string& name )
{
// Note : in the following :
// name : the user supplied name
//
// lastname : string before the last / (if any), or user supplied name
- bbtkDebugMessageInc("Core",7,"Factory::LoadPackage(\""<<name<<"\")"<<std::endl);
- bbtkMessage("Debug",1,"Factory::LoadPackage(\""<<name<<"\")"<<std::endl);
- bbtkMessage("Debug",1,"use_configuration_file ["
- << use_configuration_file << "]" << std::endl);
+ bbtkDebugMessageInc("Kernel",7,"Factory::LoadPackage(\""<<name<<"\")"<<std::endl);
+ bbtkMessage("debug",1,"Factory::LoadPackage(\""<<name<<"\")"<<std::endl);
std::vector<std::string> package_paths;
std::string libname; // full path library name
std::string upath;
pkgname = Utilities::ExtractPackageName(name,upath);
- bbtkMessage("Debug",1,"Package name ["<<pkgname<<"]"<<std::endl);
- bbtkMessage("Debug",1,"Package path ["<<upath<<"]"<<std::endl);
+ bbtkMessage("debug",1,"Package name ["<<pkgname<<"]"<<std::endl);
+ bbtkMessage("debug",1,"Package path ["<<upath<<"]"<<std::endl);
// no loading package if already loaded
PackageMapType::iterator iUnload;
return;
}
- // std::string path = Utilities::ExpandLibName(upath, verbose);
- std::string path = Utilities::ExpandLibName(name, verbose); // keep last item, here.
+ // std::string path = Utilities::ExpandLibName(upath, false);
+ std::string path = Utilities::ExpandLibName(name,false); // keep last item, here.
if (path != "")
{
// The following is *NOT* a debug time message :
// It's a user intended message.
// Please don't remove it.
- if (verbose)
- std::cout <<" [" <<libname <<"] : doesn't exist" <<std::endl;
+ bbtkMessage("Output",3," [" <<libname
+ <<"] : doesn't exist" <<std::endl);
}
else
{
- ok = DoLoadPackage( libname, pkgname, path, verbose);
+ ok = DoLoadPackage( libname, pkgname, path);
}
}
else
libname = Utilities::MakeLibnameFromPath(path, pkgname);
- bbtkMessage("Debug",2,"-> Trying to load [" << libname << "]" <<std::endl);
+ bbtkMessage("debug",2,"-> Trying to load [" << libname << "]" <<std::endl);
// Check if library exists
if ( !Utilities::FileExists(libname) )
// The following is *NOT* a debug time message :
// It's a user intended message.
// Please don't remove it.
- if (verbose)
- std::cout <<" [" <<libname <<"] : doesn't exist" <<std::endl;
+ bbtkMessage("Output",3,
+ " [" <<libname <<"] : doesn't exist" <<std::endl);
continue; // try next path
}
foundFile = true;
// Try to Load the library
- ok = DoLoadPackage( libname, pkgname, path, verbose);
+ ok = DoLoadPackage( libname, pkgname, path);
if (ok)
{
- bbtkMessage("Debug",2," OK"<<std::endl);
- break; // a package was found; we stop iterating
+ bbtkMessage("debug",2," OK"<<std::endl);
}
+ break; // we stop iterating even if error : have to signal it to user
} //------------------ // end for ( package_paths.begin();i!=package_paths.end() )
}
{
if (!foundFile)
{
- bbtkError("could not find package ["<<pkgname<< "]");
+ bbtkError("Could not find package ["<<pkgname<< "]");
}
else
{
#if defined(__GNUC__)
- bbtkError("could not load package ["<< pkgname
- <<"] :" << std::endl << " " << dlerror());
+ bbtkError("Could not load package ["<< pkgname
+ <<"] :" << std::endl
+ << " Opening "<<libname<<" failed"
+ << " Reason: "<< dlerror());
#elif defined(_WIN32)
- bbtkError("could not load package ["<<pkgname
- <<"] : " << std::endl << " " <<libname<<" not found");
+ bbtkError("Could not load package ["<<pkgname
+ <<"] :"<< std::endl << " Error loading " <<libname);
// look how to get the error message on win
//<<dlerror());
/// If the entry is found in the map, calls ClosePackage
void Factory::UnLoadPackage( const std::string& name )
{
- bbtkDebugMessageInc("Core",7,"Factory::UnLoadPackage(\""
+ bbtkDebugMessageInc("Kernel",7,"Factory::UnLoadPackage(\""
<<name<<"\")"<<std::endl);
PackageMapType::iterator i;
<<"\" : package not loaded !");
}
ClosePackage(i);
- bbtkDebugDecTab("Core",7);
+ bbtkDebugDecTab("Kernel",7);
}
//===================================================================
+ //===================================================================
+ void Factory::CloseAllPackages()
+ {
+ bbtkDebugMessageInc("Kernel",7,"Factory::CloseAllPackages()"<<std::endl);
+
+ std::vector< Package::WeakPointer > mAlive;
+ do {
+ mAlive.clear();
+ while (mPackageMap.begin() != mPackageMap.end())
+ {
+ PackageMapType::iterator i = mPackageMap.begin();
+ Package::WeakPointer p = i->second;
+ ClosePackage(i);
+ if (p.lock()) mAlive.push_back(p);
+ }
+ std::vector< Package::WeakPointer >::iterator i;
+ for (i=mAlive.begin();i!=mAlive.end();++i)
+ {
+ // If not dead : reinsert
+ if (i->lock())
+ {
+ bbtkDebugMessage("Kernel",7,"Package "<<i->lock()->GetName()
+ <<" still alive"<<std::endl);
+ // InsertPackage(i->lock());
+ }
+ }
+ }
+ while (mPackageMap.size()>0);
+
+ bbtkDebugDecTab("Kernel",7);
+ }
+ //===================================================================
+
//===================================================================
/// \brief Close the package referenced by the iterator
- ///
- /// If it is a dynamically loaded package
- /// - Loads and calls the function "<name>DeletePackage" of the dynamic library (responsible for package desallocation)
- /// - Closes the dynamic library
- /// - Erases the package entry in the packages map
- ///
- /// Else simply erases the package entry in the packages map
- void Factory::ClosePackage(PackageMapType::iterator& i)
+ ///
+ /// First removes the factory from the set of factories which use the package
+ /// If the set is empty then :
+ /// If it is a dynamically loaded package :
+ /// - Loads and calls the function "<name>DeletePackage" of the dynamic library (responsible for package desallocation)
+ /// - Closes the dynamic library
+ /// Else :
+ /// - deletes the package normally
+ ///
+ /// Finally erases the package entry in the packages map
+ void Factory::ClosePackage(PackageMapType::iterator& i)
{
- bbtkDebugMessageInc("Core",7,"Factory::ClosePackage(\""
- <<i->second.mPackage->GetName()
+ bbtkDebugMessageInc("Kernel",7,"Factory::ClosePackage(\""
+ <<i->second->GetName()
<<"\")"<<std::endl);
- if (i->second.mDynamicLibraryHandler)
- {
-
- // If it is a dynamically loaded package
- // Loads the Package delete function
-
- std::string delfname(i->second.mPackage->GetName());
- delfname += "DeletePackage";
-#if defined(__GNUC__)
- void *delf = dlsym(i->second.mDynamicLibraryHandler, delfname.c_str());
- if (!delf)
- {
- bbtkError("could not close package \""
- <<i->second.mPackage->GetName()
- <<"\" :"<<dlerror());
- }
-#elif defined(_WIN32)
- void *delf = GetProcAddress(i->second.mDynamicLibraryHandler,
- delfname.c_str());
- if (!delf)
- {
- bbtkError("could not close package \""
- <<i->second.mPackage->GetName()
- <<"\" : "<<delfname
- <<" symbol not found (how did you open it ???");
- //<<"\" :"<<dlerror());
- }
-#endif
-
- // deletes the package
- ((PackageDeleteFunction)delf)();
-
- // closes the dl handler
-#if defined(__GNUC__)
- dlclose(i->second.mDynamicLibraryHandler);
-#elif defined(_WIN32)
-
- FreeLibrary(i->second.mDynamicLibraryHandler);
-#endif
- }
- else
- {
- // If it is a manually inserted package
- delete i->second.mPackage;
- }
-
- // remove the entry in the map
- mPackageMap.erase(i);
- bbtkDebugDecTab("Core",7);
- }
+
+ // Removes this from the set of factories which use the package
+ i->second->RemoveFactory(GetThisPointer<Factory>());
+ Package::WeakPointer p = i->second;
+ // remove the entry in the map
+ mPackageMap.erase(i);
+ // Release the package if not already destroyed
+ if (p.lock())
+ {
+ Package::Release(p);
+ }
+ bbtkDebugDecTab("Kernel",7);
+ }
//===================================================================
-
+
//===================================================================
/// Displays the list of packages loaded
void Factory::PrintPackages(bool details, bool adaptors) const
{
- bbtkDebugMessageInc("Core",9,"Factory::PrintPackages"<<std::endl);
+ bbtkDebugMessageInc("Kernel",9,"Factory::PrintPackages"<<std::endl);
PackageMapType::const_iterator i;
for (i = mPackageMap.begin(); i!=mPackageMap.end(); ++i )
{
bbtkMessage("Help",1, i->first << std::endl);
if (details) {
- i->second.mPackage->PrintBlackBoxes(false,adaptors);
+ i->second->PrintBlackBoxes(false,adaptors);
}
}
- bbtkDebugDecTab("Core",9);
+ bbtkDebugDecTab("Kernel",9);
}
//===================================================================
/// Displays help on a package
void Factory::HelpPackage(const std::string& name, bool adaptors) const
{
- bbtkDebugMessageInc("Core",9,"Factory::HelpPackage(\""<<name<<"\")"
+ bbtkDebugMessageInc("Kernel",9,"Factory::HelpPackage(\""<<name<<"\")"
<<std::endl);
PackageMapType::const_iterator i = mPackageMap.find(name);
{
bbtkMessage("Help",1, "Package "<<i->first<<" ");
- if (i->second.mPackage->GetVersion().length()>0)
- bbtkMessageCont("Help",1,"v" <<i->second.mPackage->GetVersion());
+ if (i->second->GetVersion().length()>0)
+ bbtkMessageCont("Help",1,"v" <<i->second->GetVersion());
- if (i->second.mPackage->GetAuthor().length()>0)
- bbtkMessageCont("Help",1,"- "<<i->second.mPackage->GetAuthor());
+ if (i->second->GetAuthor().length()>0)
+ bbtkMessageCont("Help",1,"- "<<i->second->GetAuthor());
- if (i->second.mPackage->GetKeyword().length()>0)
- bbtkMessageCont("Help",1,"- "<<i->second.mPackage->GetKeyword());
+ if (i->second->GetCategory().length()>0)
+ bbtkMessageCont("Help",1,"- "<<i->second->GetCategory());
bbtkMessageCont("Help",1,std::endl);
bbtkIncTab("Help",1);
- bbtkMessage("Help",1,i->second.mPackage->GetDescription()<<std::endl);
- if (i->second.mPackage->GetNumberOfBlackBoxes()>0)
+ bbtkMessage("Help",1,i->second->GetDescription()<<std::endl);
+ if (i->second->GetNumberOfBlackBoxes()>0)
{
bbtkMessage("Help",1, "Black boxes : "<<std::endl);
- i->second.mPackage->PrintBlackBoxes(true,adaptors);
+ i->second->PrintBlackBoxes(true,adaptors);
}
else
{
}
else
{
- bbtkDebugDecTab("Core",9);
+ bbtkDebugDecTab("Kernel",9);
bbtkError("package \""<<name<<"\" unknown");
}
- bbtkDebugDecTab("Core",9);
+ bbtkDebugDecTab("Kernel",9);
}
//===================================================================
//===================================================================
/// Prints help on the black box of type <name>
- void Factory::HelpBlackBox(const std::string& name, bool full) const
+ /// Returns the package to which it belongs
+ void Factory::HelpBlackBox(const std::string& name,
+ std::string& package,
+ bool full) const
{
- bbtkDebugMessageInc("Core",9,"Factory::HelpBlackBox(\""<<name<<"\")"
+ bbtkDebugMessageInc("Kernel",9,"Factory::HelpBlackBox(\""<<name<<"\")"
<<std::endl);
bool found = false;
PackageMapType::const_iterator i;
for (i = mPackageMap.begin(); i!=mPackageMap.end(); ++i )
{
- if (i->second.mPackage->ContainsBlackBox(name))
+ if (i->second->ContainsBlackBox(name))
{
- i->second.mPackage->HelpBlackBox(name,full);
+ i->second->HelpBlackBox(name,full);
+ package = i->second->GetName();
found = true;
}
}
- bbtkDebugDecTab("Core",9);
+ bbtkDebugDecTab("Kernel",9);
if (!found)
{
bbtkError("No package of the factory contains any black box <"
//===================================================================
/// Inserts a package in the factory
- void Factory::InsertPackage( Package* p )
+ void Factory::InsertPackage( Package::Pointer p )
{
- bbtkDebugMessageInc("Core",9,"Factory::InsertPackage(\""<<
+ bbtkDebugMessageInc("Kernel",9,"Factory::InsertPackage(\""<<
p->GetName()<<"\")"<<std::endl);
- PackageInfoType pack;
- pack.mDynamicLibraryHandler = 0;
-
- pack.mPackage = p;
+ p->AddFactory(GetThisPointer<Factory>());
+ mPackageMap[p->GetName()] = p;
- mPackageMap[p->GetName()] = pack;
- bbtkDebugDecTab("Core",9);
+ bbtkDebugDecTab("Kernel",9);
}
//===================================================================
//===================================================================
/// Removes a package from the factory (and deletes it)
- void Factory::RemovePackage( Package* p )
+ void Factory::RemovePackage( Package::Pointer p )
{
- bbtkDebugMessageInc("Core",9,"Factory::RemovePackage(\""<<
+ bbtkDebugMessageInc("Kernel",9,"Factory::RemovePackage(\""<<
p->GetName()<<"\")"<<std::endl);
PackageMapType::iterator i;
for (i = mPackageMap.begin(); i!=mPackageMap.end(); ++i )
{
- if (i->second.mPackage == p) break;
+ if (i->second == p) break;
};
if (i!=mPackageMap.end())
{
- ClosePackage(i);
+ ClosePackage(i);
}
else
{
- bbtkError("Factory::RemovePackage(\""<<
- p->GetName()<<"\") : package absent from factory");
+ bbtkError("Factory::RemovePackage(\""<<
+ p->GetName()<<"\") : package absent from factory");
}
- bbtkDebugDecTab("Core",9);
+ bbtkDebugDecTab("Kernel",9);
}
//===================================================================
//===================================================================
/// Creates an instance of a black box of type <type> with name <name>
- BlackBox* Factory::NewBlackBox(const std::string& type,
+ BlackBox::Pointer Factory::NewBlackBox(const std::string& type,
const std::string& name) const
{
- bbtkDebugMessageInc("Core",7,"Factory::NewBlackBox(\""
+ bbtkDebugMessageInc("Kernel",7,"Factory::NewBlackBox(\""
<<type<<"\",\""<<name<<"\")"<<std::endl);
- BlackBox* b = 0;
+ BlackBox::Pointer b;
PackageMapType::const_iterator i;
for (i = mPackageMap.begin(); i!=mPackageMap.end(); ++i )
{
- b = i->second.mPackage->NewBlackBox(type,name);
+ b = i->second->NewBlackBox(type,name);
if (b) break;
}
if (!b)
bbtkError("black box type \""<<type<<"\" unknown");
}
- bbtkDebugDecTab("Core",7);
+ bbtkDebugDecTab("Kernel",7);
return b;
}
//===================================================================
//===================================================================
/// Creates an instance of a black box of type <type> with name <name>
- BlackBox* Factory::NewAdaptor(TypeInfo typein,
- TypeInfo typeout,
- const std::string& name) const
+ BlackBox::Pointer Factory::NewAdaptor(const DataInfo& typein,
+ const DataInfo& typeout,
+ const std::string& name) const
{
- bbtkDebugMessageInc("Core",8,"Factory::NewAdaptor(<"
- <<TypeName(typein)<<">,<"
- <<TypeName(typeout)<<">,\""
+ bbtkDebugMessageInc("Kernel",8,"Factory::NewAdaptor("
+ <<typein<<","
+ <<typeout<<",\""
<<name<<"\")"<<bbtkendl);
- BlackBox* b = 0;
+ BlackBox::Pointer b;
PackageMapType::const_iterator i;
for (i = mPackageMap.begin(); i!=mPackageMap.end(); ++i )
{
- b = i->second.mPackage->NewAdaptor(typein,typeout,name);
+ b = i->second->NewAdaptor(typein,typeout,name);
if (b) break;
}
if (!b)
{
- bbtkError("no <"
- <<TypeName(typein)<<"> to <"
- <<TypeName(typeout)
- <<"> adaptor available");
+ bbtkError("no "<<typein<<" to "<<typeout
+ <<" adaptor available");
}
- bbtkDebugDecTab("Core",7);
+ bbtkDebugDecTab("Kernel",7);
return b;
}
//===================================================================
+
//===================================================================
- /// Creates an instance of a connection
- Connection* Factory::NewConnection(BlackBox* from,
- const std::string& output,
- BlackBox* to,
- const std::string& input) const
+ /// Creates an instance of a black box of type <type> with name <name>
+ BlackBox::Pointer Factory::NewWidgetAdaptor(const DataInfo& typein,
+ const DataInfo& typeout,
+ const std::string& name) const
{
- bbtkDebugMessage("Core",7,"Factory::NewConnection(\""
- <<from->bbGetName()<<"\",\""<<output<<"\",\""
- <<to->bbGetName()<<"\",\""<<input
- <<"\")"<<std::endl);
+ bbtkDebugMessageInc("Kernel",8,"Factory::NewWidgetAdaptor(<"
+ <<typein<<">,<"
+ <<typeout<<">,\""
+ <<name<<"\")"<<bbtkendl);
+
+
+ BlackBox::Pointer b;
+ PackageMapType::const_iterator i;
+ for (i = mPackageMap.begin(); i!=mPackageMap.end(); ++i )
+ {
+ b = i->second->NewWidgetAdaptor(typein,
+ typeout,
+ name);
+ if (b) break;
+ }
+ if (!b)
+ {
+ bbtkError("no "<<typein<<" to "<<typeout
+ <<"> widget adaptor available");
+ }
- return new Connection(from,output,to,input);
- /*
- Connection* c;
- // !!! WARNING : WE NEED TO TEST THE TYPE NAME EQUALITY
- // BECAUSE IN DIFFERENT DYN LIBS THE type_info EQUALITY CAN
- // BE FALSE (DIFFERENT INSTANCES !)
-
- std::string t1 ( from->bbGetOutputType(output).name() );
- std::string t2 ( to->bbGetInputType(input).name() );
+ bbtkDebugDecTab("Kernel",7);
+ return b;
+ }
+ //===================================================================
+ //===================================================================
+ /// Creates an instance of a black box of type <type> with name <name>
+ bool Factory::FindAdaptor(const DataInfo& typein,
+ const DataInfo& typeout,
+ std::string& adaptor) const
+ {
+ bbtkDebugMessageInc("Kernel",8,"Factory::FindAdaptor(<"
+ <<typein<<">,<"
+ <<typeout<<">)"<<bbtkendl);
+
+ bool b = false;
+ PackageMapType::const_iterator i;
+ for (i = mPackageMap.begin(); i!=mPackageMap.end(); ++i )
+ {
+ b = i->second->FindAdaptor(typein,
+ typeout,
+ adaptor);
+ if (b) break;
+ }
+ /*
+ if (!b)
+ {
+ bbtkError("no "<<typein<<" to "<<typeout
+ <<"> widget adaptor available");
+ }
+ */
- if ( t1 == t2 )
- //from->bbGetOutputType(output) ==
- // to->bbGetInputType(input) )
+ bbtkDebugDecTab("Kernel",7);
+ return b;
+ }
+ //===================================================================
+
+ //===================================================================
+ /// Creates an instance of a black box of type <type> with name <name>
+ bool Factory::FindWidgetAdaptor(const DataInfo& typein,
+ const DataInfo& typeout,
+ std::string& adaptor) const
+ {
+ bbtkDebugMessageInc("Kernel",8,"Factory::FindWidgetAdaptor(<"
+ <<typein<<">,<"
+ <<typeout<<">)"<<bbtkendl);
+
+ bool b = false;
+ PackageMapType::const_iterator i;
+ for (i = mPackageMap.begin(); i!=mPackageMap.end(); ++i )
{
- c = new Connection(from,output,to,input);
+ b = i->second->FindWidgetAdaptor(typein,
+ typeout,
+ adaptor);
+ if (b) break;
}
- else
+ bbtkDebugDecTab("Kernel",7);
+ return b;
+ }
+ //===================================================================
+
+ //===================================================================
+ /// Creates an instance of a black box of type <type> with name <name>
+ bool Factory::FindWidgetAdaptor2(const DataInfo& typein,
+ const DataInfo& typeout,
+ std::string& widget,
+ std::string& adaptor) const
+ {
+ bbtkDebugMessageInc("Kernel",8,"Factory::FindWidgetAdaptor(<"
+ <<typein<<">,<"
+ <<typeout<<">)"<<bbtkendl);
+
+ bool b = false;
+ adaptor = widget = "";
+ PackageMapType::const_iterator i;
+ for (i = mPackageMap.begin(); i!=mPackageMap.end(); ++i )
{
- // std::cout << "Adaptive connection "<<std::endl;
- std::string name;
- name = from->bbGetName() + "." + output + "-"
- + to->bbGetName() + "." + input;
-
- BlackBox* b = 0;
- PackageMapType::const_iterator i;
- for (i = mPackageMap.begin(); i!=mPackageMap.end(); ++i )
- {
- b = i->second.mPackage->NewAdaptor(from->bbGetOutputType(output),
- to->bbGetInputType(input),
- name);
- if (b) break;
- }
- if (!b)
- {
- bbtkError("did not find any <"
- <<TypeName(from->bbGetOutputType(output))
- <<"> to <"
- <<TypeName(to->bbGetInputType(input))
- <<"> adaptor");
- }
- c = new AdaptiveConnection(from,output,to,input,b);
+ b = i->second->FindWidgetAdaptor(typein,
+ typeout,
+ widget);
+ if (b) break;
}
- bbtkDebugDecTab("Core",7);
+ if (!b)
+ {
+ // Look for a widget adaptor with good nature out
+ bbtkMessage("Kernel",5,
+ "*** Looking for a two pieces widget adaptor for : "
+ << typein << "->"<<typeout<<std::endl);
+ for (i = mPackageMap.begin(); i!=mPackageMap.end(); ++i )
+ {
+ Package::AdaptorMapType::const_iterator j;
+ for (j=i->second->GetAdaptorMap().begin();
+ j!=i->second->GetAdaptorMap().end();
+ ++j)
+ {
+ if ( ( j->first.mKind ==
+ BlackBoxDescriptor::DEFAULT_GUI) &&
+ //(j->first.mTypeIn == typein) &&
+ (j->first.mTypeOut.GetNature() == typeout.GetNature() )
+ )
+ {
+ widget = j->second.lock()->GetTypeName();
+ bbtkMessage("Kernel",5,
+ "===> Found first part : "<<widget
+ << " "<<j->first.mTypeIn<<"->"
+ <<j->first.mTypeOut<<std::endl);
+ DataInfo ti( j->first.mTypeOut.GetType(), "");
+ DataInfo to( typeout.GetType(), "");
+ b = FindAdaptor( ti, to, adaptor );
+ if (b)
+ {
+ bbtkMessage("Kernel",5,
+ "===> Found second part : "<<adaptor
+ <<std::endl);
+ break;
+ }
+ else
+ {
+ bbtkMessage("Kernel",5,
+ "===> No second part found"<<std::endl);
+ }
+ }
+ }
+ if (b) break;
+ }
+ }
+ bbtkDebugDecTab("Kernel",7);
+ return b;
+ }
+ //===================================================================
+
+ //===================================================================
+ /// Creates an instance of a connection
+ Connection::Pointer Factory::NewConnection(BlackBox::Pointer from,
+ const std::string& output,
+ BlackBox::Pointer to,
+ const std::string& input) const
+ {
+ bbtkDebugMessage("Kernel",7,"Factory::NewConnection(\""
+ <<from->bbGetName()<<"\",\""<<output<<"\",\""
+ <<to->bbGetName()<<"\",\""<<input
+ <<"\")"<<std::endl);
- return c;
- */
+ return Connection::New(from,output,to,input,
+ GetThisPointer<Factory>());
}
//===================================================================
//===================================================================
- const Package* Factory::GetPackage(const std::string& name) const
+ Package::Pointer Factory::GetPackage(const std::string& name) const
{
- bbtkDebugMessageInc("Core",9,"Factory::GetPackage(\""<<name<<"\")"
+ bbtkDebugMessageInc("Kernel",9,"Factory::GetPackage(\""<<name<<"\")"
<<std::endl);
PackageMapType::const_iterator i = mPackageMap.find(name);
if ( i != mPackageMap.end() )
{
- bbtkDebugDecTab("Core",9);
- return i->second.mPackage;
+ bbtkDebugDecTab("Kernel",9);
+ return i->second;
}
else
{
- bbtkDebugDecTab("Core",9);
+ bbtkDebugDecTab("Kernel",9);
bbtkError("package \""<<name<<"\" unknown");
}
- bbtkDebugDecTab("Core",9);
+ bbtkDebugDecTab("Kernel",9);
}
//===================================================================
+
//===================================================================
- Package* Factory::GetPackage(const std::string& name)
+ void Factory::CheckPackages() const
{
- bbtkDebugMessageInc("Core",9,"Factory::GetPackage(\""<<name<<"\")"
- <<std::endl);
-
- PackageMapType::const_iterator i = mPackageMap.find(name);
- if ( i != mPackageMap.end() )
- {
- bbtkDebugDecTab("Core",9);
- return i->second.mPackage;
- }
- else
- {
- bbtkDebugDecTab("Core",9);
- bbtkError("package \""<<name<<"\" unknown");
- }
-
- bbtkDebugDecTab("Core",9);
+ bbtkMessage("debug",1,"****** Checking Factory "<<(void*)this
+ <<std::endl);
+ PackageMapType::const_iterator i;
+ for (i = mPackageMap.begin(); i!=mPackageMap.end(); ++i )
+ {
+ i->second->CheckBoxes();
+ }
+ bbtkMessage("debug",1,"****** Checking Factory "<<(void*)this
+ <<" ... OK"<<std::endl);
}
//===================================================================
//===================================================================
void Factory::WriteDotFilePackagesList(FILE *ff)
{
- bbtkDebugMessageInc("Core",9,"Factory::WriteDotFilePackagesList()"
+
+ bbtkDebugMessageInc("Kernel",9,"Factory::WriteDotFilePackagesList()"
<<std::endl);
fprintf( ff , "\n");
fprintf(ff," %s [shape=ellipse, URL=\"%s\"]%s\n",i->first.c_str(),url.c_str(),";" );
}
fprintf( ff , "}\n\n");
- bbtkDebugDecTab("Core",9);
+ bbtkDebugDecTab("Kernel",9);
}
//===================================================================
void Factory::ShowGraphTypes(const std::string& name) const
{
+
bool found = false;
PackageMapType::const_iterator i;
for (i = mPackageMap.begin(); i!=mPackageMap.end(); ++i )
{
- if (i->second.mPackage->ContainsBlackBox(name))
+ if (i->second->ContainsBlackBox(name))
{
std::string separator = ConfigurationFile::GetInstance().Get_file_separator ();
- // Don't pollute the file store with "doc_tmp" directories ...
- std::string default_doc_dir = ConfigurationFile::GetInstance().Get_default_doc_tmp();
- std::string directory = "\"" + default_doc_dir + separator + "doc_tmp" +separator + "\"";
- std::string filename2 = default_doc_dir + separator + "doc_tmp" + separator + "tmp.html";
+ // Don't pollute the file store with "temp_dir" directories ...
+ std::string default_doc_dir = ConfigurationFile::GetInstance().Get_default_temp_dir();
+ std::string directory = "\"" + default_doc_dir + separator + "temp_dir" +separator + "\"";
+ std::string filename2 = default_doc_dir + separator + "temp_dir" + separator + "tmp.html";
#if defined(_WIN32)
std::string command("start \"Titre\" /D ");
ff=fopen(filename2.c_str(),"w");
fprintf(ff,"<html><head><title>TMP</title> <script type=\"text/javascript\"> <!--\n");
- fprintf(ff," window.location=\"%s#%s\";\n" , i->second.mPackage->GetDocURL().c_str(),name.c_str() );
+ fprintf(ff," window.location=\"%s#%s\";\n" , i->second->GetDocURL().c_str(),name.c_str() );
fprintf(ff,"//--></script></head><body></body></html>\n");
- //fprintf(ff, "<a href=\"%s#%s\">Link</a>\n", i->second.mPackage->GetDocURL().c_str(),name.c_str() );
+ //fprintf(ff, "<a href=\"%s#%s\">Link</a>\n", i->second->GetDocURL().c_str(),name.c_str() );
fclose(ff);
system( command.c_str() );
found = true;
}
}
- bbtkDebugDecTab("Core",9);
+ bbtkDebugDecTab("Kernel",9);
if (!found)
{
bbtkError("No package of the factory contains any black box <"
<<name<<">");
}
}
+
+
+
+
+ void Factory::CreateHtmlIndex(IndexEntryType type,
+ const std::string& filename)
+ {
+ bbtkDebugMessageInc("Kernel",9,"Factory::CreateHtmlIndex(\""
+ <<filename<<"\")"<<bbtkendl);
+
+ std::string title;
+
+ typedef std::map<std::string,
+ std::vector<BlackBoxDescriptor::Pointer> > IndexType;
+ IndexType index;
+ // Builds the index map
+ PackageMapType::const_iterator i;
+ for (i = mPackageMap.begin(); i!=mPackageMap.end(); ++i )
+ {
+ Package::Pointer pack = i->second;
+ if (pack->GetName()=="user") continue;
+ Package::BlackBoxMapType::const_iterator j;
+ for (j = pack->GetBlackBoxMap().begin();
+ j!= pack->GetBlackBoxMap().end();
+ ++j)
+ {
+
+ // Skip adaptors
+ if ( type==Adaptors )
+ {
+ if (j->second->GetKind() == BlackBoxDescriptor::STANDARD )
+ continue;
+ }
+ else
+ if (j->second->GetKind() != BlackBoxDescriptor::STANDARD )
+ continue;
+
+ std::vector<std::string> keys;
+ if (type==Packages)
+ {
+ std::string k("");
+ k += pack->GetName();
+ keys.push_back(k);
+ title = "Boxes by package";
+ }
+ else if ((type==Initials) || (type==Adaptors))
+ {
+ std::string init(" ");
+ init[0] = std::toupper(j->second->GetTypeName()[0]);
+ keys.push_back(init);
+ title = "Alphabetical list";
+ }
+ else if (type==Categories)
+ {
+ // Split the category string
+ std::string delimiters = ";,";
+ Utilities::SplitString(j->second->GetCategory(),
+ delimiters,keys);
+ if (keys.size()==0)
+ keys.push_back(" NONE");
+ title = "Boxes by category";
+ }
+
+
+ std::vector<std::string>::const_iterator k;
+ for (k=keys.begin(); k!=keys.end(); ++k )
+ {
+ IndexType::iterator p;
+ p = index.find(*k);
+ if (p != index.end())
+ {
+ p->second.push_back(j->second);
+ }
+ else
+ {
+ std::vector<BlackBoxDescriptor::Pointer> v;
+ v.push_back(j->second);
+ index[*k] = v;
+ }
+ }
+
+ }
+ }
+ // Creates the file
+ //---------------------
+ // Open output file
+ std::ofstream s;
+ s.open(filename.c_str());
+ if (!s.good())
+ {
+ bbtkError("Factory::CreateHtmlIndex : could not open file '"
+ <<filename<<"'");
+ }
+
+ //----------------------
+ // Html head
+ s << "<html lang=\"en\">\n";
+ s << "<head>\n";
+ s << "<title>"<<title<<"</title>\n";
+ s << "<meta http-equiv=\"Content-Type\" content=\"text/html\">\n";
+ s << "<meta name=\"description\" content=\""<<title<<"\">\n";
+ s << "<meta name=\"generator\" content=\"\">\n";
+ s << "<link title=\"Top\" rel=\"top\" href=\"#Top\">\n";
+ //<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
+ s << "<meta http-equiv=\"Content-Style-Type\" content=\"text/css\"><style type=\"text/css\"><!--\n";
+ s << "pre.display { font-family:inherit }\n";
+ s << "pre.format { font-family:inherit }\n";
+ s << "pre.smalldisplay { font-family:inherit; font-size:smaller }\n";
+ s << "pre.smallformat { font-family:inherit; font-size:smaller }\n";
+ s << "pre.smallexample { font-size:smaller }\n";
+ s << "pre.smalllisp { font-size:smaller }\n";
+ s << "span.sc { font-variant:small-caps }\n";
+ s << "span.roman { font-family:serif; font-weight:normal; } \n";
+ s << "span.sansserif { font-family:sans-serif; font-weight:normal; }\n";
+ s << "--></style>\n";
+ s << "</head>\n";
+ //----------------------
+
+ //----------------------
+ // Html body
+ s << "<body>\n";
+ s << "<a name=\"Top\"></a>\n";
+ s << "<h1 class=\"settitle\">"<<title<<"</h1>\n";
+ s << "<p>\n";
+ IndexType::iterator ii;
+ for (ii=index.begin();ii!=index.end();++ii)
+ {
+ s << "<a href=\"#"<<ii->first<<"\">"<<ii->first<<"</a> ";
+ }
+
+ for (ii=index.begin();ii!=index.end();++ii)
+ {
+ s << "<p><hr>\n";
+ s << "<p><a href=\"#Top\">Top</a>";
+ if (type==Packages)
+ {
+ s << "<a name=\""<<ii->first<<"\"></a>\n";
+ s << "<p><a href=\""<<ii->first<<"/index.html\">"
+ << ii->first<<"</a>\n";
+
+ s << " - \n";
+
+ s << "<a name=\"doxygen\"></a>\n";
+//EED 26Mars2009
+ std::string bin_path = bbtk::ConfigurationFile::GetInstance().Get_bin_path();
+ s << "<a href=" << bin_path <<"/../share/bbtk/doc/doxygen/" << ii->first << "/main.html>(Doxygen documentation of the source)</a>\n";
+ }
+ else
+ {
+ s << "<a name=\""<<ii->first<<"\"></a>\n";
+ s << "<p><b>"<<ii->first<<"</b>\n";
+ }
+ s << "<ul>\n";
+
+ s << "<p><TABLE cellspacing=0 cellpadding=3>\n";
+
+ std::vector<BlackBoxDescriptor::Pointer>::iterator di;
+ for (di=ii->second.begin();di!=ii->second.end();++di)
+ {
+ std::string pack = (*di)->GetPackage()->GetName();
+ std::string name = (*di)->GetTypeName();
+ Utilities::html_format(name);
+ std::string descr = (*di)->GetDescription();
+ Utilities::html_format(descr);
+ s << "<TR>";
+ s << "<TD style='vertical-align: top;'>";
+ s << " <a href=\""<<pack
+ <<"/index.html#"<<name<<"\">"
+ <<pack<<"::"<<name<<"</a>";
+ s << "</TD> ";
+ s << " <TD style='vertical-align: top;'>" << descr << " </TD>";
+ s << "</TR>\n";
+ }
+ s << "</TABLE>\n";
+ s << "</ul>\n";
+ s << "</div>\n";
+ }
+ //----------------------
+ // Footer
+ time_t rawtime;
+ tm * ptm;
+ time ( &rawtime );
+ ptm = gmtime ( &rawtime );
+
+ s << "<p><hr>\n";
+ s << "Automatically generated by <b>bbtk</b> on "
+ << ptm->tm_mday << "/" << ptm->tm_mon << "/" << ptm->tm_year+1900
+ << " - " << ptm->tm_hour << ":" << ptm->tm_min << " GMT\n";
+ s << "</body></html>\n";
+ s.close();
+ //----------------------
+
+ // End
+ bbtkDebugDecTab("Kernel",9);
+ }
+
+ //==========================================================================
+ std::string Factory::GetObjectName() const
+ {
+ return std::string("Factory");
+ }
+ //==========================================================================
+
+ //==========================================================================
+ std::string Factory::GetObjectInfo() const
+ {
+ std::stringstream i;
+ return i.str();
+ }
+ //==========================================================================
+
+ //==========================================================================
+size_t Factory::GetObjectSize() const
+{
+ size_t s = Superclass::GetObjectSize();
+ s += Factory::GetObjectInternalSize();
+ return s;
+ }
+ //==========================================================================
+ //==========================================================================
+size_t Factory::GetObjectInternalSize() const
+{
+ size_t s = sizeof(Factory);
+ return s;
+ }
+ //==========================================================================
+ //==========================================================================
+ size_t Factory::GetObjectRecursiveSize() const
+ {
+ size_t s = Superclass::GetObjectRecursiveSize();
+ s += Factory::GetObjectInternalSize();
+
+ PackageMapType::const_iterator i;
+ for (i = mPackageMap.begin(); i!=mPackageMap.end(); ++i )
+ {
+ s += i->second->GetObjectRecursiveSize();
+ }
+ return s;
+ }
+ //==========================================================================
}