kernel/src/bbtkFactory.h

   1 /*=========================================================================
   2
   3   Program:   bbtk
   4   Module:    $RCSfile: bbtkFactory.h,v $
   5   Language:  C++
   6   Date:      $Date: 2008/02/05 11:39:32 $
   7   Version:   $Revision: 1.4 $
   8
   9   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
  10   l'Image). All rights reserved. See doc/license.txt or
  11   http://www.creatis.insa-lyon.fr/Public/bbtk/License.html for details.
  12
  13      This software is distributed WITHOUT ANY WARRANTY; without even
  14      the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  15      PURPOSE.  See the above copyright notices for more information.
  16
  17 =========================================================================*/
  18 /**
  19  *\file
  20  *\brief Class bbtk::Factory : can load and unload dynamic libraries containing black boxes packages and create instances of the black boxes registered in the packages loaded.
  21  */
  22 /**
  23  *\class bbtk::Factory
  24  *\brief Can load and unload dynamic libraries containing black boxes packages and create instances of the black boxes registered in the packages loaded.
  25  *
  26  */
  27
  28
  29 #ifndef __bbtkFactory_h__
  30 #define __bbtkFactory_h__
  31
  32 //#include "bbtkBlackBox.h"
  33 #include "bbtkPackage.h"
  34 #include "bbtkDynamicLibraryHandling.h"
  35
  36 namespace bbtk
  37 {
  38   class BBTK_EXPORT Factory
  39   {
  40
  41   public:
  42
  43     Factory();
  44     ~Factory();
  45
  46     void LoadPackage( const std::string& name,
  47                       bool use_configuration_file = true,
  48                       bool verbose = false );
  49     void UnLoadPackage( const std::string& name );
  50     void PrintPackages(bool details = true, bool adaptors = false) const;
  51     void HelpPackage(const std::string& name, bool adaptors = false) const;
  52     void HelpBlackBox(const std::string& name, bool full=true) const;
  53     void ShowGraphTypes(const std::string& name) const;
  54     void InsertPackage( Package* );
  55     void RemovePackage( Package* );
  56
  57     const Package* GetPackage(const std::string& name) const;
  58     Package* GetPackage(const std::string& name);
  59
  60     BlackBox* NewBlackBox(const std::string& type,
  61                           const std::string& name) const;
  62
  63     BlackBox* NewAdaptor(TypeInfo typein,
  64                          TypeInfo typeout,
  65                          const std::string& name) const;
  66
  67     Connection* NewConnection(BlackBox* from,
  68                               const std::string& output,
  69                               BlackBox* to,
  70                               const std::string& input) const;
  71
  72     void WriteDotFilePackagesList(FILE *ff);
  73
  74     void Reset();
  75
  76     typedef enum
  77       {
  78         Packages,
  79         Categories,
  80         Initials
  81       }
  82       IndexEntryType;
  83     void CreateHtmlIndex(IndexEntryType type, const std::string& filename);
  84
  85   private:
  86
  87     bool DoLoadPackage(std::string libname,
  88                        std::string pkgname,
  89                        std::string path,
  90                        bool v);
  91
  92     /// The structure storing info on a package
  93     class PackageInfoType
  94     {
  95     public :
  96       /// Ctor
  97       PackageInfoType() {}
  98       /// Dtor
  99       ~PackageInfoType() {}
 100       /// The pointer on the package
 101       Package* mPackage;
 102       /// The handler of the dynamic library
 103       DynamicLibraryHandler mDynamicLibraryHandler;
 104     };
 105     /// The type of map of packages
 106     typedef std::map< std::string, PackageInfoType > PackageMapType;
 107     /// The map of packages
 108     PackageMapType mPackageMap;
 109
 110     void CloseAllPackages();
 111     void ClosePackage(PackageMapType::iterator& i);
 112
 113   };
 114   // class Factory
 115
 116
 117   /// SYSTEM METHOD : Global method returning the global factory object pointer
 118   inline Factory*& GlobalFactoryPointer()
 119   {
 120     static Factory* f = 0;
 121     return f;
 122   }
 123
 124   /// SYSTEM METHOD : Global method returning the global factory object
 125   inline Factory* GetGlobalFactory()
 126   {
 127     if (!GlobalFactoryPointer())
 128     {
 129        GlobalFactoryPointer() = new Factory;
 130     }
 131     return GlobalFactoryPointer();
 132   }
 133
 134   /// SYSTEM METHOD : Deletes the global factory pointer
 135   inline void DeleteGlobalFactory()
 136   {
 137     if (GlobalFactoryPointer())
 138     {
 139       delete GlobalFactoryPointer();
 140     }
 141   }
 142
 143   inline void LoadPackage( const std::string& name,
 144                            bool use_configuration_file = true, bool verbose = false )
 145   {
 146     GetGlobalFactory()->LoadPackage(name,use_configuration_file, verbose);
 147   }
 148
 149   inline void UnLoadPackage( const std::string& name )
 150   {
 151     GetGlobalFactory()->UnLoadPackage(name);
 152   }
 153
 154   inline void PrintPackages(bool details = true, bool adaptors = false)
 155   {
 156     GetGlobalFactory()->PrintPackages(details,adaptors);
 157   }
 158
 159   inline void HelpPackage(const std::string& name, bool adaptors = false)
 160   {
 161     GetGlobalFactory()->HelpPackage(name,adaptors);
 162   }
 163
 164   inline void HelpBlackBox(const std::string& name, bool full=true)
 165   {
 166     GetGlobalFactory()->HelpBlackBox(name,full);
 167   }
 168
 169
 170   inline void ShowGraphTypes(const std::string& name)
 171   {
 172     GetGlobalFactory()->ShowGraphTypes(name);
 173   }
 174
 175   inline void InsertPackage( Package* p)
 176   {
 177     GetGlobalFactory()->InsertPackage(p);
 178   }
 179
 180   inline void RemovePackage( Package* p)
 181   {
 182     GetGlobalFactory()->RemovePackage(p);
 183   }
 184
 185   inline const Package* GetPackage(const std::string& name)
 186   {
 187     return GetGlobalFactory()->GetPackage(name);
 188   }
 189
 190   inline BlackBox* NewBlackBox(const std::string& type,
 191                                const std::string& name)
 192   {
 193     return GetGlobalFactory()->NewBlackBox(type,name);
 194   }
 195
 196   inline BlackBox* NewAdaptor(TypeInfo typein,
 197                               TypeInfo typeout,
 198                               const std::string& name)
 199   {
 200     return GetGlobalFactory()->NewAdaptor(typein,typeout,name);
 201   }
 202
 203   inline Connection* NewConnection(BlackBox* from,
 204                                    const std::string& output,
 205                                    BlackBox* to,
 206                                    const std::string& input)
 207   {
 208     return GetGlobalFactory()->NewConnection(from,output,to,input);
 209   }
 210
 211   inline void WriteDotFilePackagesList(FILE *ff)
 212   {
 213     GetGlobalFactory()->WriteDotFilePackagesList(ff);
 214   }
 215
 216 }// namespace bbtk
 217
 218
 219
 220 #endif
 221