X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=kernel%2Fsrc%2FbbtkFactory.cxx;h=6b4079344912f2c976bba2e3e209c044990f6d7e;hb=82e313bf816718c345b45c48be70746343e8619a;hp=eb0b829339d9e4e6330f7071e70bf995c9efa629;hpb=a26195c366a89795288009cf7e20f11afa494970;p=bbtk.git diff --git a/kernel/src/bbtkFactory.cxx b/kernel/src/bbtkFactory.cxx index eb0b829..6b40793 100644 --- a/kernel/src/bbtkFactory.cxx +++ b/kernel/src/bbtkFactory.cxx @@ -4,8 +4,8 @@ Program: bbtk Module: $RCSfile: bbtkFactory.cxx,v $ Language: C++ -Date: $Date: 2008/01/22 15:02:00 $ -Version: $Revision: 1.1 $ +Date: $Date: 2008/03/11 12:27:21 $ +Version: $Revision: 1.30 $ Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de @@ -27,6 +27,7 @@ PURPOSE. See the above copyright notices for more information. #include "bbtkMessageManager.h" #include "bbtkConnection.h" #include "bbtkConfigurationFile.h" +#include "bbtkUtilities.h" #include // for struct stat stFileInfo @@ -34,20 +35,7 @@ PURPOSE. See the above copyright notices for more information. #include // for getcwd #endif - -// was in gdcm ... -/* -#ifdef _MSC_VER -# define getcwd _getcwd -#endif - -#if defined(_MSC_VER) || defined(__BORLANDC__) -# include -#else -# include -#endif - -*/ +#include // std::toupper namespace bbtk @@ -59,8 +47,9 @@ namespace bbtk //=================================================================== /// Default ctor Factory::Factory() + : mExecuter(0) { - bbtkDebugMessage("Core",7,"Factory::Factory()"< usefull in many places (at least : ConfigurationFile, Factory, Interpreter) -// should be factorized ( "bbtk::Util class ?) -/* -bool Factory::FileExists(std::string strFilename) -bool Factory::IsAtRoot(std::string cwd) -std::string Factory::ExtractPackageName(const std::string &name) -std::string Factory::ExpandLibName(const std::string &name, bool verbose) -std::string Factory::MakeLibnameFromPath(std::string path, std::string pkgname) -bool Factory::CheckIfLibraryContainsPackage(std::string libname,std::string pkgname, bool verbose) -*/ - -// See : http://www.techbytes.ca/techbyte103.html for more O.S. -bool Factory::FileExists(std::string strFilename) { - struct stat stFileInfo; - bool blnReturn; - int intStat; - - // Attempt to get the file attributes - intStat = stat(strFilename.c_str(),&stFileInfo); - if(intStat == 0) { - // We were able to get the file attributes - // so the file obviously exists. - blnReturn = true; - } else { - // We were not able to get the file attributes. - // This may mean that we don't have permission to - // access the folder which contains this file. If you - // need to do that level of checking, lookup the - // return values of stat which will give you - // more details on why stat failed. - blnReturn = false; - } - return(blnReturn); -} - -// =================================================================================== - - std::string Factory::ExtractPackageName(const std::string &name, - std::string& path) + // =================================================================== + bool Factory::DoLoadPackage(std::string libname, + std::string pkgname, + std::string path) { - std::string pkgname; - path = ""; - - std::string::size_type slash_position = name.find_last_of("/\\"); - if (slash_position != std::string::npos) - { - pkgname = name.substr(slash_position+1,std::string::npos); - path = name.substr(0,slash_position); - // std::cout << "F:P='"<.so - - // remove {libbb} if any - if (memcmp ( pkgname.c_str(), "libbb", 5) == 0) { - pkgname = pkgname.substr(5, pkgname.length()); - } - /* - /// \ \todo what would happen if (stupid) user names his package 'libbb' ?!? - /// \ --> Should be forbidden! - */ -#elif defined(_WIN32) - - // WIN 32 mechanism - // shared lib name = .dll - - // remove {bb} if any - if (memcmp (pkgname.c_str(), "bb", 2) == 0) { - pkgname = pkgname.substr(2, pkgname.length()); - } - - /* - /// \ \todo what would happen if (stupid) user names his package 'bb' ?!? - /// \ --> Should be forbidden! - */ -#else - bbtkError("neither __GNUC__ nor _WIN32 ?!? How did you compile ?"); -#endif - return pkgname; - } - -// =================================================================================== - - std::string Factory::ExpandLibName(const std::string &name, bool verbose) - { - // ----- Think of expanding path name ( ./ ../ ../../ ) - - char buf[2048]; // for getcwd - char * currentDir = getcwd(buf, 2048); - std::string cwd(currentDir); - std::string libname(name); + 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. + bbtkError("Could not open shared library [" < hopeless - if (verbose) - std::cout << " File path [" << name << "] doesn't exist" << std::endl; - tooHigh = true; + // The following is *NOT* a debug time message : + // It's a user intended message. + // Please don't remove it. + bbtkMessage("Output",2," -->[" <[" <[" <[" <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()); - } + if ( pack.mPackage->GetBBTKVersion() != bbtk::GetVersion() ) + { + std::string v(pack.mPackage->GetBBTKVersion()); + UnLoadPackage(pkgname); + bbtkError("Cannot load package ["<SetDocURL(doc); - pack.mPackage->SetDocRelativeURL(reldoc); - + pack.mPackage->AddFactory(this); + mPackageMap[pkgname] = pack; + + std::string separator = + ConfigurationFile::GetInstance().Get_file_separator (); + //BBTK_STRINGIFY_SYMBOL(BBTK_DOC_REL_PATH) + std::string docreldoc = + separator + "bbdoc" + separator + pkgname + separator + "index.html"; + std::string reldoc = + ".." + 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()<<" " - <GetVersion() - <<" (bbtk " - <GetBBTKVersion()<<") " - <GetAuthor() - <GetDescription()<GetName()<<" " + <GetVersion() + <<" (bbtk " + <GetBBTKVersion()<<") " + <GetAuthor() << " Category(s) :" + <GetCategory() + <GetDescription()<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 + - /// 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 - // - abreviated name e.g. pkg pkg.so libbpkg libbbpkg.so - // - relative full name e.g. ./libbbpkg.so ../../libbbpkg.so + // 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: ... // - bbtkDebugMessageInc("Core",7,"Factory::LoadPackage(\""< package_paths; std::string libname; // full path library name std::string pkgname; // e.g. libbb.so - + std::string upath; - pkgname = ExtractPackageName(name,upath); + pkgname = Utilities::ExtractPackageName(name,upath); bbtkMessage("Debug",1,"Package name ["<0) package_paths.push_back(upath); - // Add the path of config file - if (use_configuration_file) +// ================================================= +// The following structure was checked to work +// with any type of relative/absolute path. +// Please don't modify it without checking +// *all* the cases. JP +//================================================== + +//std::cout << "upath [" << upath << "]" << std::endl; + + bool ok = false; + bool foundFile = false; + + // If path provided by user will be the first scanned : + // push it into vector of paths + if (upath.length()>0) // ------------------------------------- check user supplied location { - std::vector::const_iterator pi; - for (pi =ConfigurationFile::GetInstance().Get_package_paths().begin(); - pi!=ConfigurationFile::GetInstance().Get_package_paths().end(); - ++pi) - package_paths.push_back(*pi); + 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; - std::string path = *i; - - // we *really* want '.' to be the current working directory - if (path == ".") { + { + 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); + std::string cwd(currentDir); path = currentDir; } - - libname = MakeLibnameFromPath(path, pkgname); - - bbtkMessage("Debug",2,"-> Trying to load ["< Trying to load [" << libname << "]" <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 "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(\"" + bbtkDebugMessageInc("Kernel",7,"Factory::ClosePackage(\"" <second.mPackage->GetName() <<"\")"<second.mDynamicLibraryHandler) - { - - // If it is a dynamically loaded package - // Loads the Package delete function - - std::string delfname(i->second.mPackage->GetName()); - delfname += "DeletePackage"; + + // Removes this from the set of factories which use the package + i->second.mPackage->RemoveFactory(this); + + // If no more factory which use it + if (i->second.mPackage->GetFactorySet().empty()) + { + // If it is a dynamically loaded package + if (i->second.mDynamicLibraryHandler) + { + + + // 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 \"" - <second.mPackage->GetName() - <<"\" :"<second.mDynamicLibraryHandler, delfname.c_str()); + if (!delf) + { + bbtkError("could not close package \"" + <second.mPackage->GetName() + <<"\" :"<second.mDynamicLibraryHandler, - delfname.c_str()); - if (!delf) - { - bbtkError("could not close package \"" - <second.mPackage->GetName() - <<"\" : "<second.mDynamicLibraryHandler, + delfname.c_str()); + if (!delf) + { + bbtkError("could not close package \"" + <second.mPackage->GetName() + <<"\" : "<second.mDynamicLibraryHandler); + dlclose(i->second.mDynamicLibraryHandler); #elif defined(_WIN32) - - FreeLibrary(i->second.mDynamicLibraryHandler); + + FreeLibrary(i->second.mDynamicLibraryHandler); #endif - } - else - { - // If it is a manually inserted package - delete i->second.mPackage; - } + } + + else + { + // If it is a manually inserted package : delete it normally + delete i->second.mPackage; + } + } + + // in any cases remove the entry in the map + mPackageMap.erase(i); - // remove the entry in the map - mPackageMap.erase(i); - bbtkDebugDecTab("Core",7); - } + bbtkDebugDecTab("Kernel",7); + } //=================================================================== - + //=================================================================== /// Displays the list of packages loaded void Factory::PrintPackages(bool details, bool adaptors) const { - bbtkDebugMessageInc("Core",9,"Factory::PrintPackages"<first<<" "); + if (i->second.mPackage->GetVersion().length()>0) bbtkMessageCont("Help",1,"v" <second.mPackage->GetVersion()); + if (i->second.mPackage->GetAuthor().length()>0) bbtkMessageCont("Help",1,"- "<second.mPackage->GetAuthor()); + + if (i->second.mPackage->GetCategory().length()>0) + bbtkMessageCont("Help",1,"- "<second.mPackage->GetCategory()); + bbtkMessageCont("Help",1,std::endl); bbtkIncTab("Help",1); bbtkMessage("Help",1,i->second.mPackage->GetDescription()< - 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(\""<second.mPackage->ContainsBlackBox(name)) { i->second.mPackage->HelpBlackBox(name,full); + package = i->second.mPackage->GetName(); found = true; } } - bbtkDebugDecTab("Core",9); + bbtkDebugDecTab("Kernel",9); if (!found) { bbtkError("No package of the factory contains any black box <" @@ -760,16 +621,16 @@ bool Factory::FileExists(std::string strFilename) { /// Inserts a package in the factory void Factory::InsertPackage( Package* p ) { - bbtkDebugMessageInc("Core",9,"Factory::InsertPackage(\""<< + bbtkDebugMessageInc("Kernel",9,"Factory::InsertPackage(\""<< p->GetName()<<"\")"<AddFactory(this); PackageInfoType pack; pack.mDynamicLibraryHandler = 0; - pack.mPackage = p; - mPackageMap[p->GetName()] = pack; - bbtkDebugDecTab("Core",9); + + bbtkDebugDecTab("Kernel",9); } //=================================================================== @@ -777,7 +638,7 @@ bool Factory::FileExists(std::string strFilename) { /// Removes a package from the factory (and deletes it) void Factory::RemovePackage( Package* p ) { - bbtkDebugMessageInc("Core",9,"Factory::RemovePackage(\""<< + bbtkDebugMessageInc("Kernel",9,"Factory::RemovePackage(\""<< p->GetName()<<"\")"<GetName()<<"\") : package absent from factory"); + bbtkError("Factory::RemovePackage(\""<< + p->GetName()<<"\") : package absent from factory"); } - bbtkDebugDecTab("Core",9); + bbtkDebugDecTab("Kernel",9); } //=================================================================== @@ -806,7 +667,7 @@ bool Factory::FileExists(std::string strFilename) { BlackBox* Factory::NewBlackBox(const std::string& type, const std::string& name) const { - bbtkDebugMessageInc("Core",7,"Factory::NewBlackBox(\"" + bbtkDebugMessageInc("Kernel",7,"Factory::NewBlackBox(\"" <,<" <,\"" < adaptor available"); } - bbtkDebugDecTab("Core",7); + bbtkDebugDecTab("Kernel",7); return b; } //=================================================================== @@ -865,58 +726,12 @@ bool Factory::FileExists(std::string strFilename) { BlackBox* to, const std::string& input) const { - bbtkDebugMessage("Core",7,"Factory::NewConnection(\"" + bbtkDebugMessage("Kernel",7,"Factory::NewConnection(\"" <bbGetName()<<"\",\""<bbGetName()<<"\",\""<bbGetOutputType(output).name() ); - std::string t2 ( to->bbGetInputType(input).name() ); - - - if ( t1 == t2 ) - //from->bbGetOutputType(output) == - // to->bbGetInputType(input) ) - { - c = new Connection(from,output,to,input); - } - else - { - // std::cout << "Adaptive connection "<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 <" - <bbGetOutputType(output)) - <<"> to <" - <bbGetInputType(input)) - <<"> adaptor"); - } - c = new AdaptiveConnection(from,output,to,input,b); - } - bbtkDebugDecTab("Core",7); - - return c; - */ + return new Connection(from,output,to,input,this); } //=================================================================== @@ -925,51 +740,52 @@ bool Factory::FileExists(std::string strFilename) { //=================================================================== const Package* Factory::GetPackage(const std::string& name) const { - bbtkDebugMessageInc("Core",9,"Factory::GetPackage(\""<second.mPackage; } else { - bbtkDebugDecTab("Core",9); + bbtkDebugDecTab("Kernel",9); bbtkError("package \""<second.mPackage; } else { - bbtkDebugDecTab("Core",9); + bbtkDebugDecTab("Kernel",9); bbtkError("package \""<first)->GetDocURL(); - fprintf(ff," %s [shape=ellipse, URL=\"%s\"]%s\n", - i->first.c_str(), - url.c_str(),";" ); + url=GetPackage(i->first)->GetDocURL(); + 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 + 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)) + { + 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.mPackage->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) { - bool found = false; + bbtkDebugMessageInc("Kernel",9,"Factory::CreateHtmlIndex(\"" + < > IndexType; + IndexType index; + // Builds the index map PackageMapType::const_iterator i; for (i = mPackageMap.begin(); i!=mPackageMap.end(); ++i ) { - if (i->second.mPackage->ContainsBlackBox(name)) + Package* pack = i->second.mPackage; + if (pack->GetName()=="user") continue; + Package::BlackBoxMapType::const_iterator j; + for (j = pack->GetBlackBoxMap().begin(); + j!= pack->GetBlackBoxMap().end(); + ++j) { - 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"; - -#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"); + // 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; + } + } - //fprintf(ff, "Link\n", i->second.mPackage->GetDocURL().c_str(),name.c_str() ); - fclose(ff); - system( command.c_str() ); - found = true; } - } + } + // 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) { - bbtkError("No package of the factory contains any black box <" - <"); + s << "


\n"; + s << "

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

first<<"/index.html\">" + << ii->first<<"\n"; + + s << "  -  \n"; + + s << "\n"; + 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 bbi 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); } + }