]> Creatis software - bbtk.git/blobdiff - kernel/src/bbtkFactory.cxx
We can now use absolute/realtive path for scripts, as well as the '* notation'
[bbtk.git] / kernel / src / bbtkFactory.cxx
index 2accdca393e67717daa9060a1185a12e6e67bc6e..61b7e3266a3f92b3d9ecbd2b0141d61177e072d4 100644 (file)
@@ -4,8 +4,8 @@ Program:   bbtk
 Module:    $RCSfile: bbtkFactory.cxx,v $
 Language:  C++
 
-Date:      $Date: 2008/01/22 16:55:04 $
-Version:   $Revision: 1.2 $
+Date:      $Date: 2008/01/29 10:12:45 $
+Version:   $Revision: 1.4 $
                                                                                 
 
 Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
@@ -102,25 +102,31 @@ namespace bbtk
 // ===================================================================================
 
   bool Factory::DoLoadPackage(std::string libname,
-                             std::string pkgname, 
-                             std::string path, 
-                             bool verbose)
+                              std::string pkgname,
+                              std::string path,
+                              bool verbose)
   {
 
 #if defined(__GNUC__)
 
-        void *handler;            
-        handler = dlopen(libname.c_str(), 
+        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;
 
@@ -145,17 +151,20 @@ namespace bbtk
           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)
-            std::cout <<"   no handler for [" <<libname<<"];" << std::endl;     
+        // 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)
@@ -173,7 +182,6 @@ namespace bbtk
           <<"\" : "<<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);
@@ -186,11 +194,11 @@ namespace bbtk
                      <<"\" : "<<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   
-  
+#endif
+
     // Stores the package
         PackageInfoType pack;
         pack.mDynamicLibraryHandler = handler;
@@ -205,33 +213,31 @@ namespace bbtk
           std::string v(pack.mPackage->GetBBTKVersion());
           UnLoadPackage(pkgname);
           bbtkError(" package build with bbtk version "
-                   << v
-                   << " whereas application build with version "
-                   << bbtk::GetVersion());
+                    << 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;
-     
-       //std::cout << "doc='"<<doc<<"'"<<std::endl;
-       
-       pack.mPackage->SetDocURL(doc);
-       pack.mPackage->SetDocRelativeURL(reldoc);
-       
+        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() 
+           <<pack.mPackage->GetAuthor()
            <<std::endl);
         bbtkMessage("Output",2,pack.mPackage->GetDescription()<<std::endl);
     //===================================================================
@@ -240,7 +246,7 @@ namespace bbtk
         return true;
   }
 
- //===================================================================
 //===================================================================
   /// \brief Loads a package.
   ///
   /// The name is the system-independant name of the package (the name of the instance of bbtk::Package).
@@ -255,25 +261,28 @@ namespace bbtk
   /// 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)
   {
   // 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(\""<<name<<"\")"<<std::endl);    
-    bbtkMessage("Debug",1,"Factory::LoadPackage(\""<<name<<"\")"<<std::endl);    
-    bbtkMessage("Debug",1,"use_configuration_file [" 
-               << use_configuration_file << "]" << std::endl);
-  
+  // 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);
+
     std::vector<std::string> package_paths;
     std::string libname;  // full path library name
     std::string pkgname;  // e.g. libbb<pkgname>.so
-    
+
     std::string upath;
     pkgname = Utilities::ExtractPackageName(name,upath);
 
@@ -283,47 +292,86 @@ namespace bbtk
     // no loading package if already loaded
     PackageMapType::iterator iUnload;
     iUnload = mPackageMap.find(pkgname);
-    if (iUnload != mPackageMap.end()) 
+    if (iUnload != mPackageMap.end())
     {
-      bbtkMessage("Output",2,"["<<pkgname<<"] already loaded"<<std::endl);
-      return; 
+      bbtkMessage("Output",2,"["<< pkgname <<"] already loaded" << std::endl);
+      return;
     }
-    
-   // If path provided by user will be the first scanned : 
-    // push it into vector of paths
-    if (upath.length()>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<std::string>::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! ["<<name<<"] is an illegal name");
+          return;
+       }
+       
+      // std::string path = Utilities::ExpandLibName(upath, verbose);
+       std::string path = Utilities::ExpandLibName(name, verbose); // keep last item, here.
+       if (path != "")
+       {
+          std::string p2;
+          Utilities::ExtractPackageName(path,p2);
+          //libname = Utilities::MakeLibnameFromPath(path, pkgname);
+          libname = Utilities::MakeLibnameFromPath(p2, pkgname); // remove last item
+          // 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;
+          }
+          else
+          {
+             ok = DoLoadPackage( libname, pkgname, path, verbose);         
+          }
+       }
+       else
+       {
+          bbtkError("Path ["<<upath<<"] doesn't exist");
+          return;
+       }
     }
-   
-    bool ok = false; 
-    bool foundFile = false;    
+    else     // ----------------------------------------------------- iterate on the paths  
+    {
 
+    std::string path;
+    package_paths = ConfigurationFile::GetInstance().Get_package_paths();
     std::vector<std::string>::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 = 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) )
@@ -331,22 +379,23 @@ namespace bbtk
         // 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;
-            continue;  // try next path
+           if (verbose)
+              std::cout <<"   [" <<libname <<"] : doesn't exist" <<std::endl;
+           continue;  // try next path
         }
         foundFile = true; 
 
       // Try to Load the library
-         
+
         ok = DoLoadPackage( libname, pkgname, path, verbose);
         if (ok)
-            {
-               bbtkMessage("Debug",2,"   OK"<<std::endl);
-               break; // a package was found; we stop iterating
-            }
+        {
+           bbtkMessage("Debug",2,"   OK"<<std::endl);
+           break; // a package was found; we stop iterating
+        }
     } //------------------ // end for ( package_paths.begin();i!=package_paths.end() )
-      //  }
+
+}
 
     if( !ok )  // nothing was loaded
     {
@@ -357,11 +406,11 @@ namespace bbtk
       else
       {
 #if defined(__GNUC__)
-        bbtkError("could not load package \""<< pkgname
-                  <<"\" :" << std::endl << "   " <<dlerror());
+        bbtkError("could not load package ["<< pkgname
+                  <<"] :" << std::endl << "   " << dlerror());
 #elif defined(_WIN32)
-        bbtkError("could not load package \""<<pkgname
-                 <<"\" : " << std::endl << "   " <<libname<<" not found");
+        bbtkError("could not load package ["<<pkgname
+                 <<"] : " << std::endl << "   " <<libname<<" not found");
 
     // look how to get the error message on win
     //<<dlerror());
@@ -373,16 +422,14 @@ namespace bbtk
     bbtkMessage("Output",2,"[" << libname << "] loaded" << std::endl);
 
   }
-    
+
   //===================================================================
   /// \brief UnLoads a package.
   ///
   /// The package must have been previously loaded by LoadPackage.
   /// If the entry is found in the map, calls ClosePackage
- void Factory::UnLoadPackage( const std::string& userSuppliedName )
-  { 
-    std::string path;
-    std::string name = Utilities::ExtractPackageName(userSuppliedName,path);
+ void Factory::UnLoadPackage( const std::string& name )
+ {
     bbtkDebugMessageInc("Core",7,"Factory::UnLoadPackage(\""
                        <<name<<"\")"<<std::endl);
   
@@ -431,16 +478,16 @@ namespace bbtk
                      <<"\" :"<<dlerror());
         }    
 #elif defined(_WIN32)
-        void *delf = GetProcAddress(i->second.mDynamicLibraryHandler, 
+   void *delf = GetProcAddress(i->second.mDynamicLibraryHandler, 
                                  delfname.c_str());
-        if (!delf)
-        {  
-           bbtkError("could not close package \""
+     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
@@ -489,9 +536,8 @@ namespace bbtk
 
   //===================================================================  
   /// Displays help on a package
-  void Factory::HelpPackage(const std::string& name/* &userSuppliedName */, bool adaptors) const
+  void Factory::HelpPackage(const std::string& name, bool adaptors) const
   {
-   // std::string name = ExtractPackageName(userSuppliedName);
     bbtkDebugMessageInc("Core",9,"Factory::HelpPackage(\""<<name<<"\")"
                         <<std::endl);
 
@@ -778,13 +824,12 @@ namespace bbtk
     fprintf( ff , "  color=lightgrey%s\n",";");
     fprintf( ff , "  rankdir=TB%s\n",";");
 
+    std::string url;
     PackageMapType::const_iterator i;
     for (i = mPackageMap.begin(); i!=mPackageMap.end(); ++i )
     {
-       std::string url = GetPackage(i->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);
@@ -792,49 +837,49 @@ namespace bbtk
   //===================================================================
 
 
-  void Factory::ShowGraphTypes(const std::string& name) const
-  {
-    bool found = false;
-    PackageMapType::const_iterator i;
-    for (i = mPackageMap.begin(); i!=mPackageMap.end(); ++i )
+ 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.mPackage->ContainsBlackBox(name)) 
-         {
-           std::string separator = ConfigurationFile::GetInstance().Get_file_separator ();
-           
+         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"; 
-           
+         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 ");
+        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,"<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,"//--></script></head><body></body></html>\n");
-           
-           
-           //fprintf(ff, "<a  href=\"%s#%s\">Link</a>\n", i->second.mPackage->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,"<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,"//--></script></head><body></body></html>\n");
+
+
+        //fprintf(ff, "<a  href=\"%s#%s\">Link</a>\n", i->second.mPackage->GetDocURL().c_str(),name.c_str() );
+        fclose(ff);
+        system( command.c_str() );      
+        found = true;
+     }
+   }
     
-    bbtkDebugDecTab("Core",9);
-    if (!found) 
-      {
-       bbtkError("No package of the factory contains any black box <"
-                 <<name<<">");
-      }
 }
+   bbtkDebugDecTab("Core",9);
+   if (!found) 
+   {
+      bbtkError("No package of the factory contains any black box <"
+                <<name<<">");
+   }
+ }
 
 }