X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=kernel%2Fsrc%2FbbtkFactory.cxx;h=d541db35b9203e89b984a63daa7c2dd1a7760eb5;hb=72e1281cc66954975acc2414264239dcf055c15f;hp=ad64151ba1696592f5611f2095d42125f86b6155;hpb=98e18224b83c6955a804d79d4e7083626ea8afcd;p=bbtk.git diff --git a/kernel/src/bbtkFactory.cxx b/kernel/src/bbtkFactory.cxx index ad64151..d541db3 100644 --- a/kernel/src/bbtkFactory.cxx +++ b/kernel/src/bbtkFactory.cxx @@ -1,32 +1,39 @@ -/*========================================================================= +/* + # --------------------------------------------------------------------- + # + # Copyright (c) CREATIS (Centre de Recherche en Acquisition et Traitement de l'Image + # pour la SantÈ) + # Authors : Eduardo Davila, Frederic Cervenansky, Claire Mouton + # Previous Authors : Laurent Guigues, Jean-Pierre Roux + # CreaTools website : www.creatis.insa-lyon.fr/site/fr/creatools_accueil + # + # 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. + # ------------------------------------------------------------------------ */ + + +/*========================================================================= Program: bbtk Module: $RCSfile: bbtkFactory.cxx,v $ Language: C++ - Date: $Date: 2009/03/30 15:22:51 $ - Version: $Revision: 1.42 $ + Date: $Date: 2012/11/16 08:49:01 $ + Version: $Revision: 1.55 $ =========================================================================*/ -/* --------------------------------------------------------------------- - -* 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 @@ -58,7 +65,7 @@ namespace bbtk /// Default ctor Factory::Pointer Factory::New() { - bbtkDebugMessage("Kernel",9,"Factory::New()"< ~Factory()"< Factory::Reset()"<GetName()<<" " + bbtkMessage("output",2,p->GetName()<<" " <GetVersion() <<" " <GetAuthor() << " Category(s) :" <GetCategory() <GetDescription()<GetDescription()<AddFactory(GetThisPointer()); mPackageMap[pkgname] = p; @@ -140,6 +147,8 @@ namespace bbtk 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 @@ -148,153 +157,168 @@ namespace bbtk // 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 << "]" < 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; - - // we *really* want '.' to be the current working directory - if (path == ".") - { - char buf[2048]; // for getcwd - char * currentDir = getcwd(buf, 2048); - std::string cwd(currentDir); - path = currentDir; - } - - libname = Utilities::MakeLibnameFromPath(path, pkgname); - - bbtkMessage("debug",2,"-> Trying to load [" << libname << "]" < mAlive; do { @@ -342,7 +366,7 @@ namespace bbtk // If not dead : reinsert if (i->lock()) { - bbtkDebugMessage("Kernel",7,"Package "<lock()->GetName() + bbtkDebugMessage("kernel",7,"Package "<lock()->GetName() <<" still alive"<lock()); } @@ -350,7 +374,7 @@ namespace bbtk } while (mPackageMap.size()>0); - bbtkDebugDecTab("Kernel",7); + bbtkDebugDecTab("kernel",7); } //=================================================================== @@ -368,7 +392,7 @@ namespace bbtk /// Finally erases the package entry in the packages map void Factory::ClosePackage(PackageMapType::iterator& i) { - bbtkDebugMessageInc("Kernel",7,"Factory::ClosePackage(\"" + bbtkDebugMessageInc("kernel",7,"Factory::ClosePackage(\"" <second->GetName() <<"\")"<first << std::endl); + bbtkMessage("help",1, i->first << std::endl); if (details) { - i->second->PrintBlackBoxes(false,adaptors); + i->second->PrintHelpListDescriptors(false,adaptors); } } - bbtkDebugDecTab("Kernel",9); + bbtkDebugDecTab("kernel",9); } //=================================================================== //=================================================================== /// Displays help on a package - void Factory::HelpPackage(const std::string& name, bool adaptors) const + void Factory::PrintHelpPackage(const std::string& name, bool adaptors) const { - bbtkDebugMessageInc("Kernel",9,"Factory::HelpPackage(\""<first<<" "); + bbtkMessage("help",1, "Package "<first<<" "); if (i->second->GetVersion().length()>0) - bbtkMessageCont("Help",1,"v" <second->GetVersion()); + bbtkMessageCont("help",1,"v" <second->GetVersion()); if (i->second->GetAuthor().length()>0) - bbtkMessageCont("Help",1,"- "<second->GetAuthor()); + bbtkMessageCont("help",1,"- "<second->GetAuthor()); if (i->second->GetCategory().length()>0) - bbtkMessageCont("Help",1,"- "<second->GetCategory()); + bbtkMessageCont("help",1,"- "<second->GetCategory()); - bbtkMessageCont("Help",1,std::endl); - bbtkIncTab("Help",1); - bbtkMessage("Help",1,i->second->GetDescription()<second->GetNumberOfBlackBoxes()>0) + bbtkMessageCont("help",1,std::endl); + bbtkIncTab("help",1); + bbtkMessage("help",1,i->second->GetDescription()<second->GetNumberOfDescriptors()>0) { - bbtkMessage("Help",1, "Black boxes : "<second->PrintBlackBoxes(true,adaptors); + 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::HelpBlackBox(const std::string& name, + void Factory::PrintHelpDescriptor(const std::string& name, std::string& package, bool full) const { - bbtkDebugMessageInc("Kernel",9,"Factory::HelpBlackBox(\""<second->ContainsBlackBox(name)) + if (i->second->ContainsDescriptor(name)) { - i->second->HelpBlackBox(name,full); + i->second->PrintHelpDescriptor(name,full); package = i->second->GetName(); found = true; } } - bbtkDebugDecTab("Kernel",9); + bbtkDebugDecTab("kernel",9); if (!found) { bbtkError("No package of the factory contains any black box <" @@ -489,13 +514,12 @@ namespace bbtk /// Inserts a package in the factory void Factory::InsertPackage( Package::Pointer p ) { - bbtkDebugMessageInc("Kernel",9,"Factory::InsertPackage(\""<< + bbtkDebugMessageInc("kernel",9,"Factory::InsertPackage(\""<< p->GetName()<<"\")"<AddFactory(GetThisPointer()); + p->AddFactory(GetThisPointer()); mPackageMap[p->GetName()] = p; - - bbtkDebugDecTab("Kernel",9); + bbtkDebugDecTab("kernel",9); } //=================================================================== @@ -503,7 +527,7 @@ namespace bbtk /// Removes a package from the factory (and deletes it) void Factory::RemovePackage( Package::Pointer p ) { - bbtkDebugMessageInc("Kernel",9,"Factory::RemovePackage(\""<< + bbtkDebugMessageInc("kernel",9,"Factory::RemovePackage(\""<< p->GetName()<<"\")"<GetName()<<"\") : package absent from factory"); } - bbtkDebugDecTab("Kernel",9); + bbtkDebugDecTab("kernel",9); } - //=================================================================== + //=================================================================== + std::string Factory::GetPackageNameOfaBlackBox(std::string boxType) + { + std::string packageName=""; + PackageMapType::const_iterator i; + + std::size_t found = boxType.find(":"); + if (found!=std::string::npos) + { + packageName = boxType.substr(0,found); + } else { + for (i = mPackageMap.begin(); i!=mPackageMap.end(); ++i ) + { + if ( i->second->ifBoxExist( boxType ) == true) + { + packageName = i->first; + } // if ifBoxExist + } // for i + + } // if found + return packageName; + } + + //=================================================================== + std::string Factory::GetTypeNameOfaBlackBox(std::string boxType) + { + std::string typeName=""; + + std::size_t found = boxType.find(":"); + if (found!=std::string::npos) + { + typeName = boxType.substr(found+1); + } else { + typeName=boxType; + } // if found + return typeName; + } + + + + //=================================================================== /// 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(\"" + bbtkDebugMessageInc("kernel",7,"Factory::NewBlackBox(\"" <second->NewBlackBox(type,name); - if (b) break; - } + + std::string tmp = type; + std::string packageName = ((bbtk::Factory*)this)->GetPackageNameOfaBlackBox(tmp); + std::string type2 = ((bbtk::Factory*)this)->GetTypeNameOfaBlackBox(tmp); + i = mPackageMap.find(packageName); + if (i != mPackageMap.end()) + { + b = i->second->NewBlackBox(type2,name); + } else { + b =BlackBox::Pointer(); + } + +/* + std::size_t found = type.find(":"); + if (found!=std::string::npos) + { + std::string packageName = type.substr(0,found); + std::string type2 = type.substr(found+1); + i = mPackageMap.find(packageName); + if (i != mPackageMap.end()) + { + b = i->second->NewBlackBox(type2,name); + } else { + b =BlackBox::Pointer(); + } + } else { + for (i = mPackageMap.begin(); i!=mPackageMap.end(); ++i ) + { + b = i->second->NewBlackBox(type,name); + if (b) break; + } // for i + + } // if found : +*/ + + if (!b) - { - bbtkError("black box type \""<,<" <,\"" < widget adaptor available"); } - bbtkDebugDecTab("Kernel",7); + bbtkDebugDecTab("kernel",7); return b; } //=================================================================== @@ -621,7 +717,7 @@ namespace bbtk const DataInfo& typeout, std::string& adaptor) const { - bbtkDebugMessageInc("Kernel",8,"Factory::FindAdaptor(<" + bbtkDebugMessageInc("kernel",8,"Factory::FindAdaptor(<" <,<" <)"<,<" <)"<,<" <)"<"<second.lock()->GetTypeName(); - bbtkMessage("Kernel",5, + bbtkMessage("kernel",5, "===> Found first part : "<first.mTypeIn<<"->" <first.mTypeOut< Found second part : "< No second part found"<bbGetName()<<"\",\""<bbGetName()<<"\",\""<second; } else { - bbtkDebugDecTab("Kernel",9); + bbtkDebugDecTab("kernel",9); bbtkError("package \""<second->CheckBoxes(); + i->second->Check(); } bbtkMessage("debug",1,"****** Checking Factory "<<(void*)this <<" ... OK"<first.c_str(),url.c_str(),";" ); } fprintf( ff , "}\n\n"); - bbtkDebugDecTab("Kernel",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->ContainsBlackBox(name)) - { + if (i->second->ContainsDescriptor(name)) + { std::string separator = ConfigurationFile::GetInstance().Get_file_separator (); - - // Don't pollute the file store with "temp_dir" directories ... + + // 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 "); + std::string command("start \"Titre\" /D "); #else - std::string command("gnome-open "); + 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; - } + 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); + + bbtkDebugDecTab("kernel",9); if (!found) { - bbtkError("No package of the factory contains any black box <" - <"); + bbtkError("No package of the factory contains any black box <" + <"); } } @@ -876,82 +971,80 @@ namespace bbtk void Factory::CreateHtmlIndex(IndexEntryType type, const std::string& filename) { - bbtkDebugMessageInc("Kernel",9,"Factory::CreateHtmlIndex(\"" + bbtkDebugMessageInc("kernel",9,"Factory::CreateHtmlIndex(\"" < > IndexType; + std::vector > 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) - { + { + 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; - } - } - - } - } + 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 @@ -996,7 +1089,7 @@ namespace bbtk IndexType::iterator ii; for (ii=index.begin();ii!=index.end();++ii) { - s << "first<<"\">"<first<<"  "; + s << "first<<"\">"<first<<"  "; } for (ii=index.begin();ii!=index.end();++ii) @@ -1012,9 +1105,14 @@ namespace bbtk s << "  -  \n"; s << "\n"; -//EED 26Mars2009 + +//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 { @@ -1062,7 +1160,7 @@ namespace bbtk //---------------------- // End - bbtkDebugDecTab("Kernel",9); + bbtkDebugDecTab("kernel",9); } //==========================================================================