]> Creatis software - bbtk.git/blobdiff - kernel/src/bbtkFactory.cxx
#2536 BBTK Feature New Normal - wt-version Package
[bbtk.git] / kernel / src / bbtkFactory.cxx
index 37563de8e3523386c3d7076837e0d32c0bf15a2c..d541db35b9203e89b984a63daa7c2dd1a7760eb5 100644 (file)
@@ -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/06/08 14:50:03 $
-  Version:   $Revision: 1.45 $
+  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
@@ -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(\""<<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 pkgname;  // e.g. libbb<pkgname>.so
+
+               std::string upath;
+
+               pkgname = Utilities::ExtractPackageName(name,upath);
+                               
+               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;
+               iUnload = mPackageMap.find(pkgname);
+
+//EED Debuging message
+//     std::cout << "EED Factory::LoadPackage " <<  std::endl;
+//             PackageMapType::iterator it;
+//             for ( it=mPackageMap.begin() ; it != mPackageMap.end(); it++ )
+//                     std::cout << (*it).first << " ";
+//             std::cout << std::endl;
+
+               
+               if (iUnload != mPackageMap.end())
+               {
+                 bbtkMessage("output",2,"["<< pkgname <<"] already loaded" << std::endl);
+                 return;
+               }
+
+       // =================================================
+       // 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
+       //==================================================
+
+               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
+               {
+                  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, false);
+
+                  std::string path = Utilities::ExpandLibName(name,false); // 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.
+                       bbtkMessage("output",3,"   [" <<libname 
+                               <<"] : doesn't exist" <<std::endl);
+                         }
+                         else
+                         {
+                                ok = DoLoadPackage( libname, pkgname, path);         
+                         }
+                  }
+                  else
+                  {
+                         bbtkError("Path ["<<upath<<"] doesn't exist");
+                         return;
+                  }
+               }
+               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;
+                       path = *i;
+//std::cout<<"JCP bbtkFactory.cxx void Factory::LoadPackage = path "<<path<<std::endl;
+                       // 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::cout<<"JCP  bbtkFactory.cxx void Factory::LoadPackage = currentDir "<<currentDir<<std::endl;
+                         path = currentDir;
+                       }
+//std::cout<<"JCP bbtkFactory.cxx void Factory::LoadPackage = path "<<path<<" pkgnam="<<pkgname<<std::endl;             
+                       libname = Utilities::MakeLibnameFromPath(path, pkgname);
+
+                       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.
+                         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);
+                       if (ok)
+                       {
+                          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() )
 
-    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 pkgname;  // e.g. libbb<pkgname>.so
-
-    std::string upath;
-    pkgname = Utilities::ExtractPackageName(name,upath);
-
-    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;
-    iUnload = mPackageMap.find(pkgname);
-    if (iUnload != mPackageMap.end())
-    {
-      bbtkMessage("output",2,"["<< pkgname <<"] already loaded" << std::endl);
-      return;
-    }
-
-// =================================================
-// 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
-    {
-       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, false);
-       std::string path = Utilities::ExpandLibName(name,false); // 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.
-           bbtkMessage("output",3,"   [" <<libname 
-                       <<"] : doesn't exist" <<std::endl);
-          }
-          else
-          {
-             ok = DoLoadPackage( libname, pkgname, path);         
-          }
-       }
-       else
-       {
-          bbtkError("Path ["<<upath<<"] doesn't exist");
-          return;
-       }
-    }
-    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;
-        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 << "]" <<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.
-          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);
-        if (ok)
-        {
-           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( !ok )  // nothing was loaded
+               {
+                 if (!foundFile)
+                 {
+                       bbtkError("Could not find package ["<<pkgname<< "]");
+                 }
+                 else
+                 {
+       #if defined(__GNUC__)
+                       bbtkError("Could not load package ["<< pkgname
+                                         <<"] :" << std::endl 
+                         << "  Opening "<<libname<<" failed"
+                         << "  Reason: "<< dlerror());
+       #elif defined(_WIN32)
+                       bbtkError("Could not load package ["<<pkgname
+                         <<"] :"<< std::endl << "   Error loading " <<libname);
+
+               // look how to get the error message on win
+               //<<dlerror());
+               // it is the bordel !! (the bloody fucking bordel, you mean?)
+               // look : http://msdn2.microsoft.com/en-us/library/ms680582.aspx
+       #endif
+                 }
+               }       
+               bbtkMessage("output",2,"[" << libname << "] loaded" << std::endl);
+       }
 
-    if( !ok )  // nothing was loaded
-    {
-      if (!foundFile)
-      {
-        bbtkError("Could not find package ["<<pkgname<< "]");
-      }
-      else
-      {
-#if defined(__GNUC__)
-        bbtkError("Could not load package ["<< pkgname
-                  <<"] :" << std::endl 
-                 << "  Opening "<<libname<<" failed"
-                 << "  Reason: "<< dlerror());
-#elif defined(_WIN32)
-        bbtkError("Could not load package ["<<pkgname
-                 <<"] :"<< std::endl << "   Error loading " <<libname);
-
-    // look how to get the error message on win
-    //<<dlerror());
-    // it is the bordel !! (the bloody fucking bordel, you mean?)
-    // look : http://msdn2.microsoft.com/en-us/library/ms680582.aspx
-#endif
-      }
-    }
-    bbtkMessage("output",2,"[" << libname << "] loaded" << std::endl);
+    
 
   }
 
@@ -493,9 +517,8 @@ namespace bbtk
     bbtkDebugMessageInc("kernel",9,"Factory::InsertPackage(\""<<
                         p->GetName()<<"\")"<<std::endl);
 
-    p->AddFactory(GetThisPointer<Factory>());
+    p->AddFactory(GetThisPointer<Factory>());    
     mPackageMap[p->GetName()] = p;
-
     bbtkDebugDecTab("kernel",9);
   }
   //===================================================================
@@ -525,28 +548,100 @@ namespace bbtk
 
     bbtkDebugDecTab("kernel",9);
   }
-  //===================================================================
   
 
+  //===================================================================
+       std::string Factory::GetPackageNameOfaBlackBox(std::string boxType)
+       {
+               std::string packageName="<void bbtk package name>";
+               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="<void bbtk type name>";
+
+               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 <type> with name <name>
   BlackBox::Pointer Factory::NewBlackBox(const std::string& type, 
                                  const std::string& name) const
   {
-    bbtkDebugMessageInc("kernel",7,"Factory::NewBlackBox(\""
+       bbtkDebugMessageInc("kernel",7,"Factory::NewBlackBox(\""
                         <<type<<"\",\""<<name<<"\")"<<std::endl);
 
     BlackBox::Pointer b; 
     PackageMapType::const_iterator i;
-    for (i = mPackageMap.begin(); i!=mPackageMap.end(); ++i )
-      {
-      b = i->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 \""<<type<<"\" unknown");
-      } 
+    {
+       bbtkError("black box type \""<<type<<"\" unknown");
+    }  // if !b
+
 
     bbtkDebugDecTab("kernel",7);
     return b;
@@ -828,7 +923,6 @@ 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 )
@@ -883,76 +977,74 @@ namespace bbtk
     std::string title;
 
     typedef std::map<std::string, 
-      std::vector<BlackBoxDescriptor::Pointer> > IndexType;
+                     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::DescriptorMapType::const_iterator j;
-       for (j = pack->GetDescriptorMap().begin(); 
-            j!= pack->GetDescriptorMap().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<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;
-                 }
-             }
-           
-         }
-      }   
+                       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
@@ -997,7 +1089,7 @@ namespace bbtk
     IndexType::iterator ii;
     for (ii=index.begin();ii!=index.end();++ii)
       {
-       s << "<a href=\"#"<<ii->first<<"\">"<<ii->first<<"</a>&nbsp;&nbsp;";    
+               s << "<a href=\"#"<<ii->first<<"\">"<<ii->first<<"</a>&nbsp;&nbsp;";    
       }
 
     for (ii=index.begin();ii!=index.end();++ii)
@@ -1013,9 +1105,14 @@ namespace bbtk
            s << "&nbsp;&nbsp;-&nbsp;&nbsp;\n"; 
 
            s << "<a name=\"doxygen\"></a>\n"; 
-//EED 26Mars2009                 
+
+//EED 26Mars2009
+       /*JCP 19 Nov 2009
                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"; 
+       JCP 19 Nov 2009*/
+               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 
          {