X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=kernel%2Fsrc%2FbbtkFactory.cxx;h=ab82b885600f5583cb2f412fb7c77492f2785bb1;hb=cb1a201cc6e6ab05f0c5063f6fc368681571a64e;hp=d2d893c289472a00759da2b5dff0d0a90e1c34e2;hpb=d74933e88492b90684ad0648d9ca7eb9d6ecb720;p=bbtk.git

diff --git a/kernel/src/bbtkFactory.cxx b/kernel/src/bbtkFactory.cxx
index d2d893c..ab82b88 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/30 12:14:43 $
-Version:   $Revision: 1.8 $
+Date:      $Date: 2008/02/12 12:55:16 $
+Version:   $Revision: 1.18 $
                                                                                 
 
 Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
@@ -35,6 +35,7 @@ PURPOSE.  See the above copyright notices for more information.
 #include <direct.h> // for getcwd
 #endif
 
+#include <cctype>    // std::toupper
 
 // was in gdcm ...
 /*
@@ -61,7 +62,7 @@ namespace bbtk
   /// Default ctor
   Factory::Factory()
   {
-    bbtkDebugMessage("Core",7,"Factory::Factory()"<<std::endl);
+    bbtkDebugMessage("Kernel",7,"Factory::Factory()"<<std::endl);
   }
   //===================================================================
 
@@ -69,9 +70,9 @@ namespace bbtk
   /// Dtor
   Factory::~Factory()
   {
-    bbtkDebugMessageInc("Core",7,"Factory::~Factory()"<<std::endl);
+    bbtkDebugMessageInc("Kernel",7,"Factory::~Factory()"<<std::endl);
     CloseAllPackages();
-    bbtkDebugDecTab("Core",7);
+    bbtkDebugDecTab("Kernel",7);
   }
   //===================================================================
 
@@ -79,22 +80,22 @@ namespace bbtk
   //===================================================================
   void Factory::CloseAllPackages()
   {
-    bbtkDebugMessageInc("Core",7,"Factory::CloseAllPackages()"<<std::endl);
+    bbtkDebugMessageInc("Kernel",7,"Factory::CloseAllPackages()"<<std::endl);
     while (mPackageMap.begin() != mPackageMap.end())
       {
         PackageMapType::iterator i = mPackageMap.begin();
         ClosePackage(i);
       }
-    bbtkDebugDecTab("Core",7);
+    bbtkDebugDecTab("Kernel",7);
   }
   //===================================================================
 
   //===================================================================
   void Factory::Reset()
   {
-    bbtkDebugMessageInc("Core",7,"Factory::Reset()"<<std::endl);
+    bbtkDebugMessageInc("Kernel",7,"Factory::Reset()"<<std::endl);
     CloseAllPackages();
-    bbtkDebugDecTab("Core",7);
+    bbtkDebugDecTab("Kernel",7);
   }
   //===================================================================
 
@@ -221,10 +222,10 @@ namespace bbtk
         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 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;
@@ -237,13 +238,13 @@ namespace bbtk
            <<pack.mPackage->GetVersion()
            <<" (bbtk "
            <<pack.mPackage->GetBBTKVersion()<<") "
-           <<pack.mPackage->GetAuthor() << " Keyword(s) :"
-           <<pack.mPackage->GetKeyword()
+           <<pack.mPackage->GetAuthor() << " Category(s) :"
+           <<pack.mPackage->GetCategory()
            <<std::endl);
         bbtkMessage("Output",2,pack.mPackage->GetDescription()<<std::endl);
     //===================================================================
 
-        bbtkDebugDecTab("Core",7);
+        bbtkDebugDecTab("Kernel",7);
         return true;
   }
 
@@ -275,7 +276,7 @@ namespace bbtk
   //
   // lastname : string before the last / (if any), or user supplied name
 
-    bbtkDebugMessageInc("Core",7,"Factory::LoadPackage(\""<<name<<"\")"<<std::endl);
+    bbtkDebugMessageInc("Kernel",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);
@@ -431,7 +432,7 @@ namespace bbtk
   /// If the entry is found in the map, calls ClosePackage
  void Factory::UnLoadPackage( const std::string& name )
  {
-    bbtkDebugMessageInc("Core",7,"Factory::UnLoadPackage(\""
+    bbtkDebugMessageInc("Kernel",7,"Factory::UnLoadPackage(\""
                        <<name<<"\")"<<std::endl);
   
     PackageMapType::iterator i;
@@ -442,7 +443,7 @@ namespace bbtk
                 <<"\" : package not loaded !");
     }
     ClosePackage(i);
-    bbtkDebugDecTab("Core",7);
+    bbtkDebugDecTab("Kernel",7);
   }
   //===================================================================
 
@@ -458,7 +459,7 @@ namespace bbtk
   /// Else simply erases the package entry in the packages map
   void Factory::ClosePackage(PackageMapType::iterator& i) 
   {   
-     bbtkDebugMessageInc("Core",7,"Factory::ClosePackage(\""
+     bbtkDebugMessageInc("Kernel",7,"Factory::ClosePackage(\""
                          <<i->second.mPackage->GetName()
                         <<"\")"<<std::endl);
 
@@ -510,7 +511,7 @@ namespace bbtk
 
     // remove the entry in the map
     mPackageMap.erase(i);
-    bbtkDebugDecTab("Core",7);
+    bbtkDebugDecTab("Kernel",7);
  }
   //===================================================================
 
@@ -520,7 +521,7 @@ namespace bbtk
   /// Displays the list of packages loaded
   void Factory::PrintPackages(bool details, bool adaptors) const
   {
-    bbtkDebugMessageInc("Core",9,"Factory::PrintPackages"<<std::endl);
+    bbtkDebugMessageInc("Kernel",9,"Factory::PrintPackages"<<std::endl);
 
     PackageMapType::const_iterator i;
     for (i = mPackageMap.begin(); i!=mPackageMap.end(); ++i )
@@ -531,7 +532,7 @@ namespace bbtk
       }
     }
 
-    bbtkDebugDecTab("Core",9);
+    bbtkDebugDecTab("Kernel",9);
   }
   //===================================================================
 
@@ -539,7 +540,7 @@ namespace bbtk
   /// Displays help on a package
   void Factory::HelpPackage(const std::string& name, bool adaptors) const
   {
-    bbtkDebugMessageInc("Core",9,"Factory::HelpPackage(\""<<name<<"\")"
+    bbtkDebugMessageInc("Kernel",9,"Factory::HelpPackage(\""<<name<<"\")"
                         <<std::endl);
 
     PackageMapType::const_iterator i = mPackageMap.find(name);
@@ -553,8 +554,8 @@ namespace bbtk
       if (i->second.mPackage->GetAuthor().length()>0)
         bbtkMessageCont("Help",1,"- "<<i->second.mPackage->GetAuthor());
         
-      if (i->second.mPackage->GetKeyword().length()>0)
-        bbtkMessageCont("Help",1,"- "<<i->second.mPackage->GetKeyword());        
+      if (i->second.mPackage->GetCategory().length()>0)
+        bbtkMessageCont("Help",1,"- "<<i->second.mPackage->GetCategory());        
         
       bbtkMessageCont("Help",1,std::endl);
       bbtkIncTab("Help",1);
@@ -572,19 +573,22 @@ namespace bbtk
       }
     else 
       {
-      bbtkDebugDecTab("Core",9);
+      bbtkDebugDecTab("Kernel",9);
       bbtkError("package \""<<name<<"\" unknown");
       }
     
-    bbtkDebugDecTab("Core",9);
+    bbtkDebugDecTab("Kernel",9);
   }
   //===================================================================
 
   //===================================================================
-  /// Prints help on the black box of type <name>
-  void Factory::HelpBlackBox(const std::string& name, bool full) const
+  /// Prints help on the black box of type <name> 
+  /// 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(\""<<name<<"\")"
+    bbtkDebugMessageInc("Kernel",9,"Factory::HelpBlackBox(\""<<name<<"\")"
                         <<std::endl);
 
     bool found = false;
@@ -594,11 +598,12 @@ namespace bbtk
       if (i->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 <"
@@ -612,7 +617,7 @@ namespace bbtk
   /// Inserts a package in the factory
   void Factory::InsertPackage( Package* p )
   {
-    bbtkDebugMessageInc("Core",9,"Factory::InsertPackage(\""<<
+    bbtkDebugMessageInc("Kernel",9,"Factory::InsertPackage(\""<<
                         p->GetName()<<"\")"<<std::endl);
 
     PackageInfoType pack;
@@ -621,7 +626,7 @@ namespace bbtk
     pack.mPackage = p;
 
     mPackageMap[p->GetName()] = pack;
-    bbtkDebugDecTab("Core",9);
+    bbtkDebugDecTab("Kernel",9);
   }
   //===================================================================
   
@@ -629,7 +634,7 @@ namespace bbtk
   /// 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()<<"\")"<<std::endl);
 
     PackageMapType::iterator i;
@@ -648,7 +653,7 @@ namespace bbtk
                  p->GetName()<<"\") : package absent from factory");
       }
 
-    bbtkDebugDecTab("Core",9);
+    bbtkDebugDecTab("Kernel",9);
   }
   //===================================================================
   
@@ -658,7 +663,7 @@ namespace bbtk
   BlackBox* Factory::NewBlackBox(const std::string& type, 
                                  const std::string& name) const
   {
-    bbtkDebugMessageInc("Core",7,"Factory::NewBlackBox(\""
+    bbtkDebugMessageInc("Kernel",7,"Factory::NewBlackBox(\""
                         <<type<<"\",\""<<name<<"\")"<<std::endl);
 
     BlackBox* b = 0; 
@@ -673,7 +678,7 @@ namespace bbtk
        bbtkError("black box type \""<<type<<"\" unknown");
       } 
 
-    bbtkDebugDecTab("Core",7);
+    bbtkDebugDecTab("Kernel",7);
     return b;
   }
   //===================================================================
@@ -684,7 +689,7 @@ namespace bbtk
                      TypeInfo typeout,
                      const std::string& name) const
   {
-    bbtkDebugMessageInc("Core",8,"Factory::NewAdaptor(<"
+    bbtkDebugMessageInc("Kernel",8,"Factory::NewAdaptor(<"
                         <<TypeName(typein)<<">,<"
                         <<TypeName(typeout)<<">,\""
                         <<name<<"\")"<<bbtkendl);
@@ -705,7 +710,7 @@ namespace bbtk
           <<"> adaptor available");
       } 
     
-    bbtkDebugDecTab("Core",7);
+    bbtkDebugDecTab("Kernel",7);
     return b; 
   }
   //===================================================================
@@ -717,7 +722,7 @@ namespace bbtk
                                      BlackBox* to,
                                      const std::string& input) const
   {
-    bbtkDebugMessage("Core",7,"Factory::NewConnection(\""
+    bbtkDebugMessage("Kernel",7,"Factory::NewConnection(\""
                       <<from->bbGetName()<<"\",\""<<output<<"\",\""
                       <<to->bbGetName()<<"\",\""<<input
                       <<"\")"<<std::endl);
@@ -765,7 +770,7 @@ namespace bbtk
          } 
          c = new AdaptiveConnection(from,output,to,input,b);
       }
-      bbtkDebugDecTab("Core",7);
+      bbtkDebugDecTab("Kernel",7);
     
       return c;
     */
@@ -777,51 +782,51 @@ namespace bbtk
   //===================================================================
   const Package* Factory::GetPackage(const std::string& name) const
   {
-    bbtkDebugMessageInc("Core",9,"Factory::GetPackage(\""<<name<<"\")"
+    bbtkDebugMessageInc("Kernel",9,"Factory::GetPackage(\""<<name<<"\")"
                          <<std::endl);
 
     PackageMapType::const_iterator i = mPackageMap.find(name);
     if ( i != mPackageMap.end() ) 
     {
-      bbtkDebugDecTab("Core",9); 
+      bbtkDebugDecTab("Kernel",9); 
       return i->second.mPackage;
     }
     else 
     {
-       bbtkDebugDecTab("Core",9);
+       bbtkDebugDecTab("Kernel",9);
        bbtkError("package \""<<name<<"\" unknown");
     }
     
-    bbtkDebugDecTab("Core",9);  
+    bbtkDebugDecTab("Kernel",9);  
   }
   //===================================================================
   
   //===================================================================
   Package* Factory::GetPackage(const std::string& name) 
   {
-    bbtkDebugMessageInc("Core",9,"Factory::GetPackage(\""<<name<<"\")"
+    bbtkDebugMessageInc("Kernel",9,"Factory::GetPackage(\""<<name<<"\")"
                          <<std::endl);
 
     PackageMapType::const_iterator i = mPackageMap.find(name);
     if ( i != mPackageMap.end() ) 
     {
-      bbtkDebugDecTab("Core",9); 
+      bbtkDebugDecTab("Kernel",9); 
       return i->second.mPackage;
     }
     else 
     {
-       bbtkDebugDecTab("Core",9);
+       bbtkDebugDecTab("Kernel",9);
        bbtkError("package \""<<name<<"\" unknown");
     }
     
-    bbtkDebugDecTab("Core",9);  
+    bbtkDebugDecTab("Kernel",9);  
   }
   //===================================================================
 
   //===================================================================
   void Factory::WriteDotFilePackagesList(FILE *ff)
   {
-    bbtkDebugMessageInc("Core",9,"Factory::WriteDotFilePackagesList()"
+    bbtkDebugMessageInc("Kernel",9,"Factory::WriteDotFilePackagesList()"
                          <<std::endl);
 
     fprintf( ff , "\n");
@@ -839,7 +844,7 @@ namespace bbtk
        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);
   }
   //===================================================================
 
@@ -854,10 +859,10 @@ namespace bbtk
       {
          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"; 
+            // 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 ");
@@ -880,13 +885,190 @@ namespace bbtk
      }
    }
     
-   bbtkDebugDecTab("Core",9);
+   bbtkDebugDecTab("Kernel",9);
    if (!found) 
    {
       bbtkError("No package of the factory contains any black box <"
                 <<name<<">");
    }
  }
+    
+
+
+
+  void Factory::CreateHtmlIndex(IndexEntryType type, 
+				const std::string& filename)
+  {
+    bbtkDebugMessageInc("Kernel",9,"Factory::CreateHtmlIndex(\""
+			<<filename<<"\")"<<bbtkendl);
+    
+    std::string title;
+
+    typedef std::map<std::string, std::vector<BlackBoxDescriptor*> > IndexType;
+    IndexType index;
+    // Builds the index map
+    PackageMapType::const_iterator i;
+    for (i = mPackageMap.begin(); i!=mPackageMap.end(); ++i )
+      {
+	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::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)
+	      {
+		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*> 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 '"
+		 <<filename<<"'");
+    }
+    
+    //----------------------
+    // Html head
+    s << "<html lang=\"en\">\n";
+    s << "<head>\n";
+    s << "<title>"<<title<<"</title>\n";
+    s << "<meta http-equiv=\"Content-Type\" content=\"text/html\">\n";
+    s << "<meta name=\"description\" content=\""<<title<<"\">\n";
+    s << "<meta name=\"generator\" content=\"\">\n";
+    s << "<link title=\"Top\" rel=\"top\" href=\"#Top\">\n";
+    //<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
+    s << "<meta http-equiv=\"Content-Style-Type\" content=\"text/css\"><style type=\"text/css\"><!--\n";
+    s << "pre.display { font-family:inherit }\n";
+    s << "pre.format  { font-family:inherit }\n";
+    s << "pre.smalldisplay { font-family:inherit; font-size:smaller }\n";
+    s << "pre.smallformat  { font-family:inherit; font-size:smaller }\n";
+    s << "pre.smallexample { font-size:smaller }\n";
+    s << "pre.smalllisp    { font-size:smaller }\n";
+    s << "span.sc    { font-variant:small-caps }\n";
+    s << "span.roman { font-family:serif; font-weight:normal; } \n";
+    s << "span.sansserif { font-family:sans-serif; font-weight:normal; }\n"; 
+    s << "--></style>\n";
+    s << "</head>\n";
+    //----------------------
+
+    //----------------------
+    // Html body
+    s << "<body>\n";
+    s << "<a name=\"Top\"></a>\n"; 
+    s << "<h1 class=\"settitle\">"<<title<<"</h1>\n";
+    s << "<p>\n";
+    IndexType::iterator ii;
+    for (ii=index.begin();ii!=index.end();++ii)
+      {
+	s << "<a href=\"#"<<ii->first<<"\">"<<ii->first<<"</a>&nbsp;";	
+      }
+
+    for (ii=index.begin();ii!=index.end();++ii)
+      {
+	s << "<p><hr>\n";
+	s << "<p><a href=\"#Top\">Top</a>";
+	if (type==Packages)
+	  {
+	    s << "<a name=\""<<ii->first<<"\"></a>\n"; 
+	    s << "<p><a href=\""<<ii->first<<"/index.html\">"
+	      << ii->first<<"</a>\n"; 
+	  }
+	else 
+	  {
+	    s << "<a name=\""<<ii->first<<"\"></a>\n"; 
+	    s << "<p><b>"<<ii->first<<"</b>\n";
+	  }
+	s << "<ul>\n";
+
+	s << "<p><TABLE cellspacing=0  cellpadding=3>\n";
+
+	std::vector<BlackBoxDescriptor*>::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 << "<TR>";
+	    s << "<TD style='vertical-align: top;'>";
+	    s << "&nbsp;&nbsp;&nbsp;<a href=\""<<pack
+	      <<"/index.html#"<<name<<"\">"
+	      <<pack<<"::"<<name<<"</a>";
+	    s << "</TD> ";
+	    s << " <TD style='vertical-align: top;'>" << descr << " </TD>";
+	    s << "</TR>\n";
+	  }    
+	s << "</TABLE>\n";
+	s << "</ul>\n";
+	s << "</div>\n";
+      }
+    //----------------------
+    // Footer 
+    time_t rawtime;
+    tm * ptm;
+    time ( &rawtime );
+    ptm = gmtime ( &rawtime );
+
+    s << "<p><hr>\n";
+    s << "Automatically generated by <b>bbi</b> on "
+      << ptm->tm_mday << "/" << ptm->tm_mon << "/" << ptm->tm_year+1900 
+      << " - " << ptm->tm_hour << ":" << ptm->tm_min << " GMT\n";
+    s << "</body></html>\n"; 
+    s.close();
+    //----------------------
+
+    // End
+    bbtkDebugDecTab("Kernel",9);
+  }
+
 
 }