kernel/src/bbtkPackage.h

   1 /*=========================================================================
   2
   3   Program:   bbtk
   4   Module:    $RCSfile: bbtkPackage.h,v $
   5   Language:  C++
   6   Date:      $Date: 2008/01/30 09:28:15 $
   7   Version:   $Revision: 1.2 $
   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::Package : registers black boxes descriptors and is able to create instances of the black boxes registered.
  21  */
  22 /**
  23  * \class bbtk::Package
  24  * \brief registers black boxes descriptors and is able to create instances of the black boxes registered.
  25  */
  26
  27 #ifndef __bbtkPackage_h__
  28 #define __bbtkPackage_h__
  29
  30 #include "bbtkBlackBox.h"
  31
  32 namespace bbtk
  33 {
  34
  35   class BBTK_EXPORT Package
  36   {
  37   public:
  38     Package(const std::string& name,
  39             const std::string& author,
  40             const std::string& description,
  41             const std::string& version,
  42             const std::string& BBTKVersion);
  43     ~Package();
  44     /// Returns the name of the package
  45     const std::string& GetName() const { return mName; }
  46
  47     /// Returns the author of the package
  48     const std::string& GetAuthor() const { return mAuthor; }
  49
  50     /// Returns the keyword of the package
  51     const std::string& GetKeyword() const { return mKeyword; }
  52
  53     /// Returns the description of the package
  54     const std::string& GetDescription() const { return mDescription; }
  55
  56     /// Returns the version of the package
  57     const std::string& GetVersion() const { return mVersion; }
  58
  59     /// Returns the version of bbtk used to build the package
  60     const std::string& GetBBTKVersion() const { return mBBTKVersion; }
  61
  62     bool ContainsBlackBox(const std::string& boxname) const;
  63
  64
  65     BlackBox* NewBlackBox(const std::string& type,
  66                              const std::string& name) const;
  67
  68     BlackBox* NewAdaptor(TypeInfo typein,
  69                             TypeInfo typeout,
  70                             const std::string& name) const;
  71
  72     bool RegisterBlackBox(BlackBoxDescriptor*);
  73     void UnRegisterBlackBox(const std::string& name);
  74
  75     //   bool RegisterAdaptor(BlackBoxDescriptor*);
  76
  77     void PrintBlackBoxes(bool description = false,
  78                          bool adaptors = false) const;
  79     void PrintAdaptors(bool description = false) const;
  80     void HelpBlackBox(const std::string& name, bool full=true) const;
  81
  82     void CreateHtmlPage(const std::string& filename,
  83                         const std::string& caller = "?",
  84                         const std::string& source = "?",
  85                         const std::string& custom_header = "",
  86                         const std::string& custom_title = "",
  87                         int detail = 1,
  88                         int level = 0,
  89                         bool relative_link = false ) const;
  90
  91     void  SetDocURL(std::string url){ mDocURL=url; }
  92     const std::string& GetDocURL() const { return mDocURL; }
  93
  94     void  SetDocRelativeURL(std::string url){ mDocRelativeURL=url; }
  95     const std::string& GetDocRelativeURL() const { return mDocRelativeURL; }
  96
  97
  98     unsigned int GetNumberOfBlackBoxes() const { return mBlackBoxMap.size(); }
  99
 100     /// Changes the name of a black box type
 101     void ChangeBlackBoxName( const std::string& oldname,
 102                              const std::string& newname );
 103
 104   private:
 105     /// The name of the package
 106     std::string mName;
 107     /// The author of the package
 108     std::string mAuthor;
 109     /// The keywords of the package
 110     std::string mKeyword;
 111     /// The description of the package
 112     std::string mDescription;
 113     /// The version of the package
 114     std::string mVersion;
 115     /// The version of the library bbtk used to build the package
 116     std::string mBBTKVersion;
 117     /// URL of the documentation of the Package (absolute path)
 118     std::string mDocURL;
 119     /// URL of the documentation of the Package
 120     /// (path relative to bbtk doc root)
 121     std::string mDocRelativeURL;
 122
 123
 124     /// The type of map of descriptors
 125     typedef std::map< std::string, BlackBoxDescriptor*> BlackBoxMapType;
 126     /// The map of black boxes descriptors
 127     BlackBoxMapType mBlackBoxMap;
 128
 129     /// The type of key in the map of adaptor descriptors
 130     class AdaptorKey
 131     {
 132     public:
 133       AdaptorKey( TypeInfo typein, TypeInfo typeout)
 134         : mTypeIn(typein.name()), mTypeOut(typeout.name()) {}
 135
 136       bool operator< ( const AdaptorKey& k ) const
 137       {
 138         //      return ( ( mTypeIn.before(k.mTypeIn) ) ||
 139         //               ( ( mTypeIn == k.mTypeIn ) &&
 140         //                 ( mTypeOut.before(k.mTypeOut) ) ) );
 141         return ( ( mTypeIn < k.mTypeIn ) ||
 142                  ( ( mTypeIn == k.mTypeIn ) &&
 143                    ( mTypeOut < k.mTypeOut ) ) );
 144       }
 145
 146     private:
 147       //      TypeInfo mTypeIn;
 148       //      TypeInfo mTypeOut;
 149       std::string mTypeIn;
 150       std::string mTypeOut;
 151     };
 152
 153     //typedef std::string AdaptorKey;
 154
 155     /// The type of map of adaptor descriptors
 156     typedef std::map< AdaptorKey, BlackBoxDescriptor*> AdaptorMapType;
 157
 158     /// The map of adaptors descriptors
 159     AdaptorMapType mAdaptorMap;
 160   };
 161   // EO class Package
 162   //====================================================================
 163
 164
 165 //====================================================================
 166 #if defined(_WIN32)
 167   #define BBTK_PACKAGE_EXPORT __declspec( dllexport )
 168 #else
 169   #define BBTK_PACKAGE_EXPORT
 170 #endif // defined(_WIN32)
 171 //====================================================================
 172
 173 //====================================================================
 174 #define BBTK_DECLARE_PACKAGE(NAME)                                      \
 175   extern "C"                                                            \
 176   {                                                                     \
 177     bbtk::Package*& NAME ## GetPackagePointer();                        \
 178     BBTK_PACKAGE_EXPORT void BBTK_CDECL NAME ## DeletePackage();        \
 179     BBTK_PACKAGE_EXPORT bbtk::Package* BBTK_CDECL NAME ## GetPackage(); \
 180   }
 181 //====================================================================
 182
 183 //====================================================================
 184 #define BBTK_IMPLEMENT_PACKAGE(NAME,AUTHOR,DESCRIPTION,VERSION)         \
 185   extern "C"                                                            \
 186   {                                                                     \
 187     bbtk::Package*& NAME ## GetPackagePointer()                         \
 188     {                                                                   \
 189       static bbtk::Package* u = 0;                                      \
 190       return u;                                                         \
 191     }                                                                   \
 192     BBTK_PACKAGE_EXPORT void BBTK_CDECL NAME ## DeletePackage()         \
 193     {                                                                   \
 194       if (NAME ## GetPackagePointer())                                  \
 195         delete NAME ## GetPackagePointer();                             \
 196       NAME ## GetPackagePointer() = 0;                                  \
 197     }                                                                   \
 198     BBTK_PACKAGE_EXPORT bbtk::Package* BBTK_CDECL NAME ## GetPackage()  \
 199     {                                                                   \
 200       if (!NAME ## GetPackagePointer())                                 \
 201         NAME ## GetPackagePointer() =                                   \
 202           new bbtk::Package(#NAME,                                      \
 203                             AUTHOR,     \
 204                             DESCRIPTION, \
 205                             VERSION,    \
 206                             BBTK_STRINGIFY_SYMBOL(BBTK_VERSION)         \
 207                             );                                          \
 208       return NAME ## GetPackagePointer();                               \
 209     }                                                                   \
 210   }
 211 //====================================================================
 212
 213 //====================================================================
 214 #define BBTK_ADD_BLACK_BOX_TO_PACKAGE(NAME,CLASS)                       \
 215   bool bbDummy##NAME##CLASS = NAME ## GetPackage()->RegisterBlackBox(CLASS::bbDescriptor());
 216   //====================================================================
 217
 218 //====================================================================
 219 #define BBTK_ADD_TEMPLATE_BLACK_BOX_TO_PACKAGE(NAME,CLASS,TEMPLATE_PARAM) \
 220   bool bbDummy##NAME##CLASS##TEMPLATE_PARAM = NAME ## GetPackage()->RegisterBlackBox(CLASS<TEMPLATE_PARAM>::bbDescriptor());
 221   //====================================================================
 222
 223 //====================================================================
 224 #define BBTK_ADD_TEMPLATE2_BLACK_BOX_TO_PACKAGE(NAME,CLASS,T1,T2)       \
 225   bool bbDummy##NAME##CLASS##T1##T2 = NAME ## GetPackage()->RegisterBlackBox(CLASS<T1,T2>::bbDescriptor());
 226   //====================================================================
 227
 228 //====================================================================
 229 //#define BBTK_ADD_ADAPTOR_TO_PACKAGE(NAME,CLASS)                       \
 230 //  bool bbDummy##NAME##CLASS = NAME ## GetPackage()->RegisterBlackBox(CLASS::bbDescriptor()); \
 231 //  bool bbDummyAdaptor##NAME##CLASS = NAME ## GetPackage()->RegisterAdaptor(CLASS::bbDescriptor());
 232 //====================================================================
 233
 234 //====================================================================
 235 //#define BBTK_ADD_TEMPLATE_ADAPTOR_TO_PACKAGE(NAME,CLASS,TEMPLATE_PARAM) \
 236 //  bool bbDummy##NAME##CLASS##TEMPLATE_PARAM = NAME ## GetPackage()->RegisterBlackBox(CLASS<TEMPLATE_PARAM>::bbDescriptor()); \
 237 //  bool bbDummyAdaptor##NAME##CLASS##TEMPLATE_PARAM = NAME ## GetPackage()->RegisterAdaptor(CLASS<TEMPLATE_PARAM>::bbDescriptor());
 238 //====================================================================
 239
 240 //====================================================================
 241 //#define BBTK_ADD_TEMPLATE2_ADAPTOR_TO_PACKAGE(NAME,CLASS,T1,T2)       \
 242 //  bool bbDummy##NAME##CLASS##T1##T2 = NAME ## GetPackage()->RegisterBlackBox(CLASS<T1,T2>::bbDescriptor()); \
 243 //    bool bbDummyAdaptor##NAME##CLASS##T1##T2 = NAME ## GetPackage()->RegisterAdaptor(CLASS<T1,T2>::bbDescriptor());
 244   //====================================================================
 245
 246 }// namespace bbtk
 247
 248
 249
 250 #endif
 251