Factory debuging

[bbtk.git] / kernel / src / bbtkFactory.cxx

diff --git a/kernel/src/bbtkFactory.cxx b/kernel/src/bbtkFactory.cxx
index 5429d74b5a406f52724bdaca17c352ccaba08be1..138006cc7a1b01ebe7e05d6c0b309b1e6c902ac1 100644 (file)
--- 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/02/04 14:12:47 $
-Version:   $Revision: 1.11 $
+Date:      $Date: 2008/02/14 12:15:59 $
+Version:   $Revision: 1.20 $
                                                                                 
 
 Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
@@ -62,7 +62,7 @@ namespace bbtk
   /// Default ctor
   Factory::Factory()
   {
-    bbtkDebugMessage("Core",7,"Factory::Factory()"<<std::endl);
+    bbtkDebugMessage("Kernel",7,"Factory::Factory()"<<std::endl);
   }
   //===================================================================
 
@@ -70,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);
   }
   //===================================================================
 
@@ -80,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);
   }
   //===================================================================
 
@@ -109,6 +109,7 @@ namespace bbtk
   {
 
 #if defined(__GNUC__)
+       verbose = true;
 
         void *handler;
         handler = dlopen(libname.c_str(),
@@ -222,10 +223,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;
@@ -238,13 +239,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;
   }
 
@@ -276,7 +277,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);
@@ -432,7 +433,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;
@@ -443,7 +444,7 @@ namespace bbtk
                 <<"\" : package not loaded !");
     }
     ClosePackage(i);
-    bbtkDebugDecTab("Core",7);
+    bbtkDebugDecTab("Kernel",7);
   }
   //===================================================================
 
@@ -459,7 +460,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);
 
@@ -511,7 +512,7 @@ namespace bbtk
 
     // remove the entry in the map
     mPackageMap.erase(i);
-    bbtkDebugDecTab("Core",7);
+    bbtkDebugDecTab("Kernel",7);
  }
   //===================================================================
 
@@ -521,7 +522,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 )
@@ -532,7 +533,7 @@ namespace bbtk
       }
     }
 
-    bbtkDebugDecTab("Core",9);
+    bbtkDebugDecTab("Kernel",9);
   }
   //===================================================================
 
@@ -540,7 +541,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);
@@ -554,8 +555,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);
@@ -573,19 +574,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
+  /// 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;
@@ -595,11 +599,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 <"
@@ -613,7 +618,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;
@@ -622,7 +627,7 @@ namespace bbtk
     pack.mPackage = p;
 
     mPackageMap[p->GetName()] = pack;
-    bbtkDebugDecTab("Core",9);
+    bbtkDebugDecTab("Kernel",9);
   }
   //===================================================================
   
@@ -630,7 +635,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;
@@ -649,7 +654,7 @@ namespace bbtk
                  p->GetName()<<"\") : package absent from factory");
       }
 
-    bbtkDebugDecTab("Core",9);
+    bbtkDebugDecTab("Kernel",9);
   }
   //===================================================================
   
@@ -659,7 +664,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; 
@@ -674,7 +679,7 @@ namespace bbtk
        bbtkError("black box type \""<<type<<"\" unknown");
       } 
 
-    bbtkDebugDecTab("Core",7);
+    bbtkDebugDecTab("Kernel",7);
     return b;
   }
   //===================================================================
@@ -685,7 +690,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);
@@ -706,7 +711,7 @@ namespace bbtk
           <<"> adaptor available");
       } 
     
-    bbtkDebugDecTab("Core",7);
+    bbtkDebugDecTab("Kernel",7);
     return b; 
   }
   //===================================================================
@@ -718,7 +723,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);
@@ -766,7 +771,7 @@ namespace bbtk
          } 
          c = new AdaptiveConnection(from,output,to,input,b);
       }
-      bbtkDebugDecTab("Core",7);
+      bbtkDebugDecTab("Kernel",7);
     
       return c;
     */
@@ -778,51 +783,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");
@@ -840,7 +845,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);
   }
   //===================================================================
 
@@ -855,10 +860,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 ");
@@ -881,7 +886,7 @@ namespace bbtk
      }
    }
     
-   bbtkDebugDecTab("Core",9);
+   bbtkDebugDecTab("Kernel",9);
    if (!found) 
    {
       bbtkError("No package of the factory contains any black box <"
@@ -895,7 +900,7 @@ namespace bbtk
   void Factory::CreateHtmlIndex(IndexEntryType type, 
                                const std::string& filename)
   {
-    bbtkDebugMessageInc("Core",9,"Factory::CreateHtmlIndex(\""
+    bbtkDebugMessageInc("Kernel",9,"Factory::CreateHtmlIndex(\""
                        <<filename<<"\")"<<bbtkendl);
     
     std::string title;
@@ -920,28 +925,24 @@ namespace bbtk
                std::string k("");
                k += pack->GetName();
                keys.push_back(k);
-               title = "Index by package";
+               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 index";
+               title = "Alphabetical list";
              }
-           else if (type==Keywords)
+           else if (type==Categories)
              {
-               // Split the keyword string 
-               //std::vector<std::string> keywords;
+               // Split the category string 
                std::string delimiters = ";,";
-               Utilities::SplitString(j->second->GetKeyword(),
+               Utilities::SplitString(j->second->GetCategory(),
                                       delimiters,keys);
-               //std::vector<std::string>::iterator si;
-               //for (si=keywords.begin();si!=keywords.end;++si)
-               //  {
-               //    keys.push_back(*si);
-               //  }
-               title = "Index by keyword";
+               if (keys.size()==0) 
+                 keys.push_back(" NONE");
+               title = "Boxes by category";
              }
            
            std::vector<std::string>::const_iterator k;
@@ -1014,8 +1015,17 @@ namespace bbtk
       {
        s << "<p><hr>\n";
        s << "<p><a href=\"#Top\">Top</a>";
-       s << "<a name=\""<<ii->first<<"\"></a>\n"; 
-       s << "<p><b>"<<ii->first<<"</b>\n";
+       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";
@@ -1025,10 +1035,12 @@ namespace bbtk
          {
            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 << "<li><a href=\""<<pack
+           s << "&nbsp;&nbsp;&nbsp;<a href=\""<<pack
              <<"/index.html#"<<name<<"\">"
              <<pack<<"::"<<name<<"</a>";
            s << "</TD> ";
@@ -1036,7 +1048,7 @@ namespace bbtk
            s << "</TR>\n";
          }    
        s << "</TABLE>\n";
-       s << "</li></ul>\n";
+       s << "</ul>\n";
        s << "</div>\n";
       }
     //----------------------
@@ -1055,7 +1067,7 @@ namespace bbtk
     //----------------------
 
     // End
-    bbtkDebugDecTab("Core",9);
+    bbtkDebugDecTab("Kernel",9);
   }