bbtkPackage.h

Go to the documentation of this file.

/*=========================================================================                                                                               
  Program:   bbtk
  Module:    $RCSfile: bbtkPackage.h,v $
  Language:  C++
  Date:      $Date: 2008/10/17 08:18:14 $
  Version:   $Revision: 1.11 $
=========================================================================*/

/* ---------------------------------------------------------------------

* 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.
* ------------------------------------------------------------------------ */                                                                         

#ifndef __bbtkPackage_h__
#define __bbtkPackage_h__

#include "bbtkBlackBox.h"
#include "bbtkDynamicLibraryHandling.h"

namespace bbtk
{

  class Factory;
  BBTK_FORWARD_DECLARE_POINTER(Factory);

  class BBTK_EXPORT Package : public Object
  {
    BBTK_OBJECT_INTERFACE(Package);
    typedef Object Superclass;
  public:
    static Pointer New(const std::string& name,
                       const std::string& author,
                       const std::string& description,
                       const std::string& version,
                       const std::string& BBTKVersion);
    static Pointer CreateFromDynamicLibrary(const std::string& libname,
                                            const std::string& pkgname,
                                            const std::string& path);

    static void UnLoadDynamicLibrary(Package::WeakPointer p, bool doit = true);

    static void UnLoadReleasedDynamicallyLoadedPackages();

    static void Release(Package::WeakPointer p);
    static void ReleaseBlackBoxDescriptor(Package::WeakPointer p,
                                          BlackBoxDescriptor::WeakPointer d);
    
    
    typedef Package::Pointer (*DLGetPackageFunction)();
    typedef void (*DLDeletePackageFunction)();
    typedef const std::string& (*DLGetPackageBBTKVersionFunction)();

    static DynamicLibraryHandler OpenDynamicLibrary
    ( const std::string& dynamic_library_path,
      const std::string& package_name,
      DLGetPackageFunction&,
      DLDeletePackageFunction&);

 
    const std::string& GetName() const { return mName; }

    const std::string& GetAuthor() const { return mAuthor; }

    const std::string& GetCategory() const { return mCategory; }

    const std::string& GetDescription() const { return mDescription; }

    const std::string& GetVersion() const { return mVersion; }

    bool ContainsBlackBox(const std::string& boxname) const;

 
    BlackBox::Pointer NewBlackBox(const std::string& type,
                             const std::string& name) const;
  
    BlackBox::Pointer NewAdaptor(const DataInfo& typein,
                         const DataInfo& typeout,
                         const std::string& name) const;
    
    BlackBox::Pointer NewWidgetAdaptor(const DataInfo& typein,
                              const DataInfo& typeout,
                              const std::string& name) const;
    bool FindAdaptor(const DataInfo& typein,
                           const DataInfo& typeout,
                           std::string& adaptor) const;
    bool FindWidgetAdaptor(const DataInfo& typein,
                           const DataInfo& typeout,
                           std::string& adaptor) const;

    bool RegisterBlackBox(BlackBoxDescriptor::Pointer); 

    void PrintBlackBoxes(bool description = false, 
                         bool adaptors = false) const;
    void PrintAdaptors(bool description = false) const;
    void HelpBlackBox(const std::string& name, bool full=true) const;
    
    void CreateHtmlPage(const std::string& filename,
                        const std::string& caller = "?",
                        const std::string& source = "?",
                        const std::string& custom_header = "",
                        const std::string& custom_title = "",
                        int detail = 1, 
                        int level = 0,
                        bool relative_link = false ) const;

    void  SetDocURL(std::string url){ mDocURL=url; }
    const std::string& GetDocURL() const { return mDocURL; }
    
    void  SetDocRelativeURL(std::string url){ mDocRelativeURL=url; }
    const std::string& GetDocRelativeURL() const { return mDocRelativeURL; }


    unsigned int GetNumberOfBlackBoxes() const { return mBlackBoxMap.size(); }
    
    void ChangeBlackBoxName( const std::string& oldname, 
                             const std::string& newname );
    typedef std::map< std::string, BlackBoxDescriptor::Pointer> 
    BlackBoxMapType;
    const BlackBoxMapType& GetBlackBoxMap() const { return mBlackBoxMap; }
    BlackBoxMapType& GetBlackBoxMap() { return mBlackBoxMap; }

    class AdaptorKey 
    {
    public:
      AdaptorKey( const DataInfo& typein, const DataInfo& typeout, 
                  BlackBoxDescriptor::Kind kind ) 
        : mTypeIn(typein), mTypeOut(typeout), mKind(kind) {}
      
      bool operator< ( const AdaptorKey& k ) const
      {
        return ( ( mKind < k.mKind ) ||
                 ( ( mKind == k.mKind ) &&
                   ( ( mTypeIn < k.mTypeIn ) ||
                     ( ( mTypeIn == k.mTypeIn ) && 
                       ( mTypeOut < k.mTypeOut ) ) ) ) );
      }
      
      bool operator== ( const AdaptorKey& k ) const
      {
        return ( ( mKind == k.mKind ) && 
                 ( mTypeIn == k.mTypeIn ) && 
                 ( mTypeOut == k.mTypeOut ) );
      }
      DataInfo mTypeIn;
      DataInfo mTypeOut; 
      BlackBoxDescriptor::Kind mKind;
    };
    
    typedef std::map< AdaptorKey, BlackBoxDescriptor::WeakPointer> AdaptorMapType;

 
   const AdaptorMapType& GetAdaptorMap() const { return mAdaptorMap; }

    
    // Factories management
    void AddFactory(FactoryPointer f) { mFactorySet.insert(f); }
    void RemoveFactory(FactoryPointer f) { mFactorySet.erase(f); }

    
    typedef std::set<FactoryWeakPointer> FactorySet;
    FactorySet& GetFactorySet() { return mFactorySet; }
    const FactorySet& GetFactorySet() const { return mFactorySet; }
    
    void CheckBoxes() const;

  private:
    //    Package() {}
    //    Package(const Package&) {}
    Package(const std::string& name,
            const std::string& author,
            const std::string& description,
            const std::string& version,
            const std::string& BBTKVersion);
    static void UnLoad(Package::WeakPointer p);

    DynamicLibraryHandler mDynamicLibraryHandler;
    DLDeletePackageFunction mDLDeletePackageFunction;


    std::string mName;
    std::string mAuthor;
    std::string mCategory;    
    std::string mDescription;
    std::string mVersion;
    std::string mDocURL;
    std::string mDocRelativeURL;

    BlackBoxMapType mBlackBoxMap;

    AdaptorMapType mAdaptorMap;


    FactorySet mFactorySet;

    static std::set<Package::WeakPointer> 
    mReleasedDynamicallyLoadedPackages;
  };
  // EO class Package
  //====================================================================


//====================================================================
#if defined(_WIN32)
  #define BBTK_PACKAGE_EXPORT __declspec( dllexport )
#else
  #define BBTK_PACKAGE_EXPORT
#endif // defined(_WIN32) 
//====================================================================

#define BBTK_GET_PACKAGE_FUNCTION_NAME GetPackage
#define BBTK_DEL_PACKAGE_FUNCTION_NAME DeletePackage
#define BBTK_GET_PACKAGE_BBTK_VERSION_FUNCTION_NAME GetPackageBBTKVersion
  


//====================================================================
#define BBTK_DECLARE_PACKAGE(NAME)                                      \
  extern "C"                                                            \
  {                                                                     \
    bbtk::Package::Pointer& NAME ## GetPackagePointer();                \
    BBTK_PACKAGE_EXPORT                                                 \
    void BBTK_CDECL NAME ## DeletePackage ();           \
    BBTK_PACKAGE_EXPORT bbtk::Package::Pointer                          \
    BBTK_CDECL NAME ## GetPackage ();           \
    BBTK_PACKAGE_EXPORT const std::string&                              \
    BBTK_CDECL NAME ## GetPackageBBTKVersion ();        \
  }
//==================================================================== 

//==================================================================== 
#define BBTK_IMPLEMENT_PACKAGE(NAME,AUTHOR,DESCRIPTION,VERSION)         \
  extern "C"                                                            \
  {                                                                     \
    bbtk::Package::Pointer& NAME ## GetPackagePointer()                 \
    {                                                                   \
      static bbtk::Package::Pointer u;                                  \
      return u;                                                         \
    }                                                                   \
    BBTK_PACKAGE_EXPORT                                                 \
    void BBTK_CDECL NAME ## DeletePackage ()                            \
    {                                                                   \
      NAME ## GetPackagePointer().reset();                              \
    }                                                                   \
    BBTK_PACKAGE_EXPORT                                                 \
    bbtk::Package::Pointer                                              \
    BBTK_CDECL NAME ## GetPackage()             \
    {                                                                   \
      if (!NAME ## GetPackagePointer())                                 \
        NAME ## GetPackagePointer() =                                   \
          bbtk::Package::New(#NAME,                                     \
                             AUTHOR,                                    \
                             DESCRIPTION,                               \
                             VERSION,                                   \
                             BBTK_STRINGIFY_SYMBOL(BBTK_VERSION)        \
                             );                                         \
      bbtk::Object::InsertInPackageList( NAME ## GetPackagePointer() ); \
      return NAME ## GetPackagePointer();                               \
    }                                                                   \
    BBTK_PACKAGE_EXPORT const std::string&                              \
    BBTK_CDECL NAME ## GetPackageBBTKVersion ()                         \
    { return bbtk::GetVersion(); }                                      \
    class NAME ## PackageAutodestructor                                 \
    {                                                                   \
    public:                                                             \
      NAME ## PackageAutodestructor() {}                                \
      ~NAME ## PackageAutodestructor()                                  \
      {                                                                 \
        if (NAME ## GetPackagePointer().use_count()>0)                  \
          {                                                             \
            bbtk::Package::WeakPointer p = NAME ## GetPackagePointer(); \
            bbtk::Package::Release(p);                                  \
          }                                                             \
      }                                                                 \
    };                                                                  \
    NAME ## PackageAutodestructor NAME ## PackageAutodestructorInstance; \
  }
//====================================================================  

//====================================================================
#define BBTK_ADD_BLACK_BOX_TO_PACKAGE(NAME,CLASS)                       \
  bool bbDummy##NAME##CLASS = NAME ## GetPackage ()     \
    ->RegisterBlackBox(CLASS ## Descriptor::Instance());
  //====================================================================
  
  //====================================================================
#define BBTK_ADD_TEMPLATE_BLACK_BOX_TO_PACKAGE(NAME,CLASS,TEMPLATE_PARAM) \
  bool bbDummy##NAME##CLASS##TEMPLATE_PARAM = NAME ## GetPackage ()     \
    ->RegisterBlackBox(CLASS ## Descriptor <TEMPLATE_PARAM>::Instance());
  //====================================================================
  
  //====================================================================
#define BBTK_ADD_TEMPLATE2_BLACK_BOX_TO_PACKAGE(NAME,CLASS,T1,T2)       \
  bool bbDummy##NAME##CLASS##T1##T2 = NAME ## GetPackage ()             \
    ->RegisterBlackBox(CLASS ## Descriptor <T1,T2>::Instance()); 
  //====================================================================
  

}// namespace bbtk



#endif