/*========================================================================= Program: bbtk Module: $RCSfile: bbtkFactory.cxx,v $ Language: C++ Date: $Date: 2010/09/12 14:59:29 $ Version: $Revision: 1.51 $ =========================================================================*/ /* --------------------------------------------------------------------- * 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 * black boxes packages and create instances of the black boxes registered * in the packages loaded. */ #include "bbtkFactory.h" #include "bbtkMessageManager.h" #include "bbtkConnection.h" #include "bbtkConfigurationFile.h" #include "bbtkUtilities.h" #include "bbtkConfigurationFile.h" #include // for struct stat stFileInfo #if defined(_WIN32) #include // for getcwd #endif #include // std::toupper #include namespace bbtk { //=================================================================== /// Default ctor Factory::Pointer Factory::New() { bbtkDebugMessage("kernel",9,"Factory::New()"< ~Factory()"< Factory::Reset()"<GetName()<<" " <GetVersion() <<" " <GetAuthor() << " Category(s) :" <GetCategory() <GetDescription()<AddFactory(GetThisPointer()); mPackageMap[pkgname] = p; return true; } return false; } //=================================================================== /// \brief Loads a package. /// /// The name is the system-independant name of the package (the name of the instance of bbtk::Package). /// Tries to open the dynamic library : /// - "libbb.so" for linux systems, /// - "bb.dll" for windows systems. /// If it succeeds, then tries to load the symbols "GetPackage" and "DeletePackage". /// "GetPackage" is called to get the pointer on the bbtk::Package of the library /// ("DeletePackage" is not used, its presence is just checked before loading the package). /// now, filename is only the last name (no longer the full name!) /// it will be searched within *all* the paths given in bbtk_config.xml void Factory::LoadPackage( const std::string& name ) { // Note : in the following : // name : the user supplied name // - abreviated name e.g. pkg pkg.so libbpkg libbbpkg.so // - relative full name e.g. ./libbbpkg.so ../../libbbpkg.so // - absolute full name e.g. /home/usrname/proj/lib/libbbpkg.so // same for Windows, with c:, d: ... // // lastname : string before the last / (if any), or user supplied name if(name != ""){ bbtkDebugMessageInc("kernel",7,"Factory::LoadPackage(\""< package_paths; std::string libname; // full path library name std::string pkgname; // e.g. libbb.so std::string upath; pkgname = Utilities::ExtractPackageName(name,upath); bbtkMessage("debug",1,"Package name ["<0) // ------------------------------------- check user supplied location { if (name[0] != '.' && name[0] != '/' && name[1]!= ':') { bbtkError("Use absolute or relative path name! ["<::iterator i; for (i=package_paths.begin();i!=package_paths.end();++i) { foundFile = false; path = *i; //std::cout<<"JCP bbtkFactory.cxx void Factory::LoadPackage = path "< Trying to load [" << libname << "]" < 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 "<lock()->GetName() <<" still alive"<lock()); } } } while (mPackageMap.size()>0); bbtkDebugDecTab("kernel",7); } //=================================================================== //=================================================================== /// \brief Close the package referenced by the iterator /// /// 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 "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("kernel",7,"Factory::ClosePackage(\"" <second->GetName() <<"\")"<second->RemoveFactory(GetThisPointer()); 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); } //=================================================================== //=================================================================== void Factory::PrintHelpListPackages(bool details, bool adaptors) const { bbtkDebugMessageInc("kernel",9,"Factory::PrintPackages"<first << std::endl); if (details) { i->second->PrintHelpListDescriptors(false,adaptors); } } bbtkDebugDecTab("kernel",9); } //=================================================================== //=================================================================== /// Displays help on a package void Factory::PrintHelpPackage(const std::string& name, bool adaptors) const { bbtkDebugMessageInc("kernel",9,"Factory::PrintHelpPackage(\"" <first<<" "); if (i->second->GetVersion().length()>0) bbtkMessageCont("help",1,"v" <second->GetVersion()); if (i->second->GetAuthor().length()>0) bbtkMessageCont("help",1,"- "<second->GetAuthor()); if (i->second->GetCategory().length()>0) bbtkMessageCont("help",1,"- "<second->GetCategory()); bbtkMessageCont("help",1,std::endl); bbtkIncTab("help",1); bbtkMessage("help",1,i->second->GetDescription()<second->GetNumberOfDescriptors()>0) { bbtkMessage("help",1, "Black boxes : "<second->PrintHelpListDescriptors(true,adaptors); } else { bbtkMessage("help",1, "No black boxes"< /// Returns the package to which it belongs void Factory::PrintHelpDescriptor(const std::string& name, std::string& package, bool full) const { bbtkDebugMessageInc("kernel",9,"Factory::PrintHelpDescriptor(\"" <second->ContainsDescriptor(name)) { i->second->PrintHelpDescriptor(name,full); package = i->second->GetName(); found = true; } } 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::Pointer p ) { bbtkDebugMessageInc("kernel",9,"Factory::InsertPackage(\""<< p->GetName()<<"\")"<AddFactory(GetThisPointer()); mPackageMap[p->GetName()] = p; bbtkDebugDecTab("kernel",9); } //=================================================================== //=================================================================== /// Removes a package from the factory (and deletes it) void Factory::RemovePackage( Package::Pointer p ) { bbtkDebugMessageInc("kernel",9,"Factory::RemovePackage(\""<< p->GetName()<<"\")"<second == p) break; }; if (i!=mPackageMap.end()) { ClosePackage(i); } else { bbtkError("Factory::RemovePackage(\""<< p->GetName()<<"\") : package absent from factory"); } bbtkDebugDecTab("kernel",9); } //=================================================================== // ups3 EED borrame std::string Factory::GetPackageNameOfaBlackBox(std::string boxType) { std::string result=""; PackageMapType::const_iterator i; for (i = mPackageMap.begin(); i!=mPackageMap.end(); ++i ) { if ( i->second->ifBoxExist( boxType ) == true) { result = i->first; } } return result; } //=================================================================== /// Creates an instance of a black box of type with name BlackBox::Pointer Factory::NewBlackBox(const std::string& type, const std::string& name) const { bbtkDebugMessageInc("kernel",7,"Factory::NewBlackBox(\"" <second->NewBlackBox(type,name); if (b) break; } if (!b) { bbtkError("black box type \""< with name BlackBox::Pointer Factory::NewAdaptor(const DataInfo& typein, const DataInfo& typeout, const std::string& name) const { bbtkDebugMessageInc("kernel",8,"Factory::NewAdaptor(" <second->NewAdaptor(typein,typeout,name); if (b) break; } if (!b) { bbtkError("no "< with name BlackBox::Pointer Factory::NewWidgetAdaptor(const DataInfo& typein, const DataInfo& typeout, const std::string& name) const { bbtkDebugMessageInc("kernel",8,"Factory::NewWidgetAdaptor(<" <,<" <,\"" <second->NewWidgetAdaptor(typein, typeout, name); if (b) break; } if (!b) { bbtkError("no "< widget adaptor available"); } bbtkDebugDecTab("kernel",7); return b; } //=================================================================== //=================================================================== /// Creates an instance of a black box of type with name bool Factory::FindAdaptor(const DataInfo& typein, const DataInfo& typeout, std::string& adaptor) const { bbtkDebugMessageInc("kernel",8,"Factory::FindAdaptor(<" <,<" <)"<second->FindAdaptor(typein, typeout, adaptor); if (b) break; } /* if (!b) { bbtkError("no "< widget adaptor available"); } */ bbtkDebugDecTab("kernel",7); return b; } //=================================================================== //=================================================================== /// Creates an instance of a black box of type with name bool Factory::FindWidgetAdaptor(const DataInfo& typein, const DataInfo& typeout, std::string& adaptor) const { bbtkDebugMessageInc("kernel",8,"Factory::FindWidgetAdaptor(<" <,<" <)"<second->FindWidgetAdaptor(typein, typeout, adaptor); if (b) break; } bbtkDebugDecTab("kernel",7); return b; } //=================================================================== //=================================================================== /// Creates an instance of a black box of type with name bool Factory::FindWidgetAdaptor2(const DataInfo& typein, const DataInfo& typeout, std::string& widget, std::string& adaptor) const { bbtkDebugMessageInc("kernel",8,"Factory::FindWidgetAdaptor(<" <,<" <)"<second->FindWidgetAdaptor(typein, typeout, widget); if (b) break; } if (!b) { // Look for a widget adaptor with good nature out bbtkMessage("kernel",5, "*** Looking for a two pieces widget adaptor for : " << typein << "->"<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 : "<first.mTypeIn<<"->" <first.mTypeOut<first.mTypeOut.GetType(), ""); DataInfo to( typeout.GetType(), ""); b = FindAdaptor( ti, to, adaptor ); if (b) { bbtkMessage("kernel",5, "===> Found second part : "< No second part found"<bbGetName()<<"\",\""<bbGetName()<<"\",\""<()); } //=================================================================== //=================================================================== Package::Pointer Factory::GetPackage(const std::string& name) const { bbtkDebugMessageInc("kernel",9,"Factory::GetPackage(\""<second; } else { bbtkDebugDecTab("kernel",9); bbtkError("package \""<second->Check(); } bbtkMessage("debug",1,"****** Checking Factory "<<(void*)this <<" ... OK"<first)->GetDocURL(); fprintf(ff," %s [shape=ellipse, URL=\"%s\"]%s\n",i->first.c_str(),url.c_str(),";" ); } fprintf( ff , "}\n\n"); bbtkDebugDecTab("kernel",9); } //=================================================================== void Factory::ShowGraphTypes(const std::string& name) const { bool found = false; PackageMapType::const_iterator i; for (i = mPackageMap.begin(); i!=mPackageMap.end(); ++i ) { if (i->second->ContainsDescriptor(name)) { std::string separator = ConfigurationFile::GetInstance().Get_file_separator (); // Don't pollute the file store with "temp_dir" directories ... std::string default_doc_dir = ConfigurationFile::GetInstance().Get_default_temp_dir(); std::string directory = "\"" + default_doc_dir + separator + "temp_dir" +separator + "\""; std::string filename2 = default_doc_dir + separator + "temp_dir" + separator + "tmp.html"; #if defined(_WIN32) std::string command("start \"Titre\" /D "); #else std::string command("gnome-open "); #endif command=command + directory +" tmp.html"; FILE *ff; ff=fopen(filename2.c_str(),"w"); fprintf(ff,"TMP \n"); //fprintf(ff, "Link\n", i->second->GetDocURL().c_str(),name.c_str() ); fclose(ff); system( command.c_str() ); found = true; } } bbtkDebugDecTab("kernel",9); if (!found) { bbtkError("No package of the factory contains any black box <" <"); } } void Factory::CreateHtmlIndex(IndexEntryType type, const std::string& filename) { bbtkDebugMessageInc("kernel",9,"Factory::CreateHtmlIndex(\"" < > 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::DescriptorMapType::const_iterator j; for (j = pack->GetDescriptorMap().begin(); j!= pack->GetDescriptorMap().end(); ++j) { // Skip adaptors if ( type==Adaptors ) { if (j->second->GetKind() == BlackBoxDescriptor::STANDARD ) continue; } else if (j->second->GetKind() != BlackBoxDescriptor::STANDARD ) continue; std::vector 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::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 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 '" <\n"; s << "\n"; s << ""<<title<<"\n"; s << "\n"; s << "\n"; s << "\n"; s << "\n"; // s << "\n"; s << "\n"; //---------------------- //---------------------- // Html body s << "\n"; s << "\n"; s << "

"<\n"; s << "

\n"; IndexType::iterator ii; for (ii=index.begin();ii!=index.end();++ii) { s << "first<<"\">"<first<<"  "; } for (ii=index.begin();ii!=index.end();++ii) { s << "


\n"; s << "

Top"; if (type==Packages) { s << "first<<"\">\n"; s << "

first<<"/index.html\">" << ii->first<<"\n"; s << "  -  \n"; s << "\n"; //EED 26Mars2009 /*JCP 19 Nov 2009 std::string bin_path = bbtk::ConfigurationFile::GetInstance().Get_bin_path(); s << "first << "/main.html>(Doxygen documentation of the source)\n"; JCP 19 Nov 2009*/ std::string bin_path = bbtk::ConfigurationFile::GetInstance().Get_bin_path(); s << "first << "/main.html>(Doxygen documentation of the source)\n"; } else { s << "first<<"\">\n"; s << "

"<first<<"\n"; } s << "

    \n"; s << "

    \n"; std::vector::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 << ""; s << " "; s << " "; s << "\n"; } s << "
    "; s << "   " <"; s << "" << descr << "
    \n"; s << "

\n"; s << "\n"; } //---------------------- // Footer time_t rawtime; tm * ptm; time ( &rawtime ); ptm = gmtime ( &rawtime ); s << "


\n"; s << "Automatically generated by bbtk on " << ptm->tm_mday << "/" << ptm->tm_mon << "/" << ptm->tm_year+1900 << " - " << ptm->tm_hour << ":" << ptm->tm_min << " GMT\n"; s << "\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; } //========================================================================== }