X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=kernel%2Fsrc%2FbbtkPackage.h;h=9a1c46a9e43b0fa42b8f99246598077d3d1e9c01;hb=d7e710c3fe8bd9c8c5fb79073bd5667b24c048f8;hp=3b4d8dcf3082ded00d4dc4cb4610964283f46db4;hpb=2d76cd309d74d5f83d701d6bb0a4140d5d122b36;p=bbtk.git diff --git a/kernel/src/bbtkPackage.h b/kernel/src/bbtkPackage.h index 3b4d8dc..9a1c46a 100644 --- a/kernel/src/bbtkPackage.h +++ b/kernel/src/bbtkPackage.h @@ -1,20 +1,33 @@ -/*========================================================================= - +/*========================================================================= Program: bbtk Module: $RCSfile: bbtkPackage.h,v $ Language: C++ - Date: $Date: 2008/01/30 09:28:15 $ - Version: $Revision: 1.2 $ - - Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de - l'Image). All rights reserved. See doc/license.txt or - http://www.creatis.insa-lyon.fr/Public/bbtk/License.html for details. - - This software is distributed WITHOUT ANY WARRANTY; without even - the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR - PURPOSE. See the above copyright notices for more information. - + Date: $Date: 2009/01/13 08:45:27 $ + Version: $Revision: 1.12 $ =========================================================================*/ + +/* --------------------------------------------------------------------- + +* 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. +* ------------------------------------------------------------------------ */ + /** * \file * \brief Class bbtk::Package : registers black boxes descriptors and is able to create instances of the black boxes registered. @@ -28,27 +41,85 @@ #define __bbtkPackage_h__ #include "bbtkBlackBox.h" +#include "bbtkDynamicLibraryHandling.h" namespace bbtk { - class BBTK_EXPORT Package + class Factory; + BBTK_FORWARD_DECLARE_POINTER(Factory); + + class BBTK_EXPORT Package : public Object { + BBTK_OBJECT_INTERFACE(Package); + typedef Object Superclass; public: - Package(const std::string& name, - const std::string& author, - const std::string& description, - const std::string& version, - const std::string& BBTKVersion); - ~Package(); + /// Creates a new package + static Pointer New(const std::string& name, + const std::string& author, + const std::string& description, + const std::string& version); + /// Creates a package from a dynamic library + static Pointer CreateFromDynamicLibrary(const std::string& libname, + const std::string& pkgname, + const std::string& path); + + /// UnLoads the package dynamic library + /// (if any and if the package is released) + /// If doit == false then does not do it but just + /// put the package in the list of ReleasedDynamicallyLoadedPackages. + /// This is because we cannot close the dl from inside a + /// package member method or the program crashes. + /// The actual dl close must be done by an external user + /// calling UnLoadReleasedDynamicallyLoadedPackages + static void UnLoadDynamicLibrary(Package::WeakPointer p, bool doit = true); + + /// UnLoads released packages that were loaded dynamically + /// see UnLoadDynamicLibrary and ReleaseBlackBoxDescriptor + static void UnLoadReleasedDynamicallyLoadedPackages(); + + /// "Releases" the package + /// Signals the package that it can free its descriptors + /// if they are no more used and frees and unloads the package + /// if it is no more used (released) + /// Note : Any non-weak pointer on the package must have been freed + static void Release(Package::WeakPointer p); + /// "Releases" a black box descriptor + /// Signals the package that it can free the given descriptor + /// if it is no more used and frees and put it the the + /// ReleasedDynamicallyLoadedPackages if it is dyn loaded + /// and no more used (released) + /// Note : Any non-weak pointer on the package must have been freed + static void ReleaseBlackBoxDescriptor(Package::WeakPointer p, + BlackBoxDescriptor::WeakPointer d); + + + typedef Package::Pointer (*DLGetPackageFunction)(); + typedef void (*DLDeletePackageFunction)(); + typedef const std::string& (*DLGetPackageBBTKVersionFunction)(); + + /// Opens a dynamic library which contains a bbtk package + /// Returns the handler + /// Load the package management symbols from the lib + /// returns false if a problem occured hence can be used + /// to test that a dyn lib is a valid bbtk package lib + /// NB : The BBTK version exported from the library + /// is tested against the current bbtk version + static DynamicLibraryHandler OpenDynamicLibrary + ( const std::string& dynamic_library_path, + const std::string& package_name, + DLGetPackageFunction&, + DLDeletePackageFunction&); + + /// Returns the name of the package const std::string& GetName() const { return mName; } /// Returns the author of the package const std::string& GetAuthor() const { return mAuthor; } - /// Returns the keyword of the package - const std::string& GetKeyword() const { return mKeyword; } + /// Returns the category of the package + const std::string& GetCategory() const { return mCategory; } /// Returns the description of the package const std::string& GetDescription() const { return mDescription; } @@ -56,23 +127,27 @@ namespace bbtk /// Returns the version of the package const std::string& GetVersion() const { return mVersion; } - /// Returns the version of bbtk used to build the package - const std::string& GetBBTKVersion() const { return mBBTKVersion; } - - bool ContainsBlackBox(const std::string& boxname) const; + bool ContainsBlackBox(const std::string& boxname) const; - BlackBox* NewBlackBox(const std::string& type, + BlackBox::Pointer NewBlackBox(const std::string& type, const std::string& name) const; - BlackBox* NewAdaptor(TypeInfo typein, - TypeInfo typeout, - const std::string& name) const; - - bool RegisterBlackBox(BlackBoxDescriptor*); - void UnRegisterBlackBox(const std::string& name); - - // bool RegisterAdaptor(BlackBoxDescriptor*); + 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; @@ -100,63 +175,113 @@ namespace bbtk /// Changes the name of a black box type void ChangeBlackBoxName( const std::string& oldname, const std::string& newname ); + /// The type of map of descriptors + typedef std::map< std::string, BlackBoxDescriptor::Pointer> + BlackBoxMapType; + const BlackBoxMapType& GetBlackBoxMap() const { return mBlackBoxMap; } + BlackBoxMapType& GetBlackBoxMap() { return mBlackBoxMap; } + + /// The type of key in the map of adaptor descriptors + 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; + }; + + /// The type of map of adaptor descriptors + typedef std::map< AdaptorKey, BlackBoxDescriptor::WeakPointer> AdaptorMapType; + + + const AdaptorMapType& GetAdaptorMap() const { return mAdaptorMap; } + + + // Factories management + /// Adds the factory to the set of factories which use the package + void AddFactory(FactoryPointer f) { mFactorySet.insert(f); } + /// Removes the factory from the set of factories which use the package + void RemoveFactory(FactoryPointer f) { mFactorySet.erase(f); } + + + typedef std::set FactorySet; + /// Gets the set of factories which use the package + FactorySet& GetFactorySet() { return mFactorySet; } + /// Gets the set of factories which use the package (const) + const FactorySet& GetFactorySet() const { return mFactorySet; } + + void CheckBoxes() const; private: + /// Default ctor is private : use the static New method + // Package() {} + /// A Package cannot be copy constructed + // Package(const Package&) {} + /// Ctor is private : use the static New method + Package(const std::string& name, + const std::string& author, + const std::string& description, + const std::string& version); + /// Does unload a package (no test) + static void UnLoad(Package::WeakPointer p); + + /// The dynamic library handler of the package if it was loaded from a dl + DynamicLibraryHandler mDynamicLibraryHandler; + /// The pointer on the delete function of the package + /// in case it was loaded from a dynamic library + DLDeletePackageFunction mDLDeletePackageFunction; + + /// The name of the package std::string mName; /// The author of the package std::string mAuthor; - /// The keywords of the package - std::string mKeyword; + /// The categories of the package + std::string mCategory; /// The description of the package std::string mDescription; /// The version of the package std::string mVersion; - /// The version of the library bbtk used to build the package - std::string mBBTKVersion; /// URL of the documentation of the Package (absolute path) std::string mDocURL; /// URL of the documentation of the Package /// (path relative to bbtk doc root) std::string mDocRelativeURL; - - /// The type of map of descriptors - typedef std::map< std::string, BlackBoxDescriptor*> BlackBoxMapType; /// The map of black boxes descriptors BlackBoxMapType mBlackBoxMap; - /// The type of key in the map of adaptor descriptors - class AdaptorKey - { - public: - AdaptorKey( TypeInfo typein, TypeInfo typeout) - : mTypeIn(typein.name()), mTypeOut(typeout.name()) {} - - bool operator< ( const AdaptorKey& k ) const - { - // return ( ( mTypeIn.before(k.mTypeIn) ) || - // ( ( mTypeIn == k.mTypeIn ) && - // ( mTypeOut.before(k.mTypeOut) ) ) ); - return ( ( mTypeIn < k.mTypeIn ) || - ( ( mTypeIn == k.mTypeIn ) && - ( mTypeOut < k.mTypeOut ) ) ); - } - - private: - // TypeInfo mTypeIn; - // TypeInfo mTypeOut; - std::string mTypeIn; - std::string mTypeOut; - }; - - //typedef std::string AdaptorKey; - - /// The type of map of adaptor descriptors - typedef std::map< AdaptorKey, BlackBoxDescriptor*> AdaptorMapType; - /// The map of adaptors descriptors AdaptorMapType mAdaptorMap; + + + /// The set of factories which contain the package + FactorySet mFactorySet; + + /// The set of released dynamically loaded packages + /// to be unloaded explicitely calling + /// UnLoadReleasedDynamicallyLoadedPackages + static std::set + mReleasedDynamicallyLoadedPackages; }; // EO class Package //==================================================================== @@ -170,13 +295,23 @@ namespace bbtk #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*& NAME ## GetPackagePointer(); \ - BBTK_PACKAGE_EXPORT void BBTK_CDECL NAME ## DeletePackage(); \ - BBTK_PACKAGE_EXPORT bbtk::Package* BBTK_CDECL NAME ## GetPackage(); \ + 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 (); \ } //==================================================================== @@ -184,64 +319,68 @@ namespace bbtk #define BBTK_IMPLEMENT_PACKAGE(NAME,AUTHOR,DESCRIPTION,VERSION) \ extern "C" \ { \ - bbtk::Package*& NAME ## GetPackagePointer() \ + bbtk::Package::Pointer& NAME ## GetPackagePointer() \ { \ - static bbtk::Package* u = 0; \ + static bbtk::Package::Pointer u; \ return u; \ } \ - BBTK_PACKAGE_EXPORT void BBTK_CDECL NAME ## DeletePackage() \ + BBTK_PACKAGE_EXPORT \ + void BBTK_CDECL NAME ## DeletePackage () \ { \ - if (NAME ## GetPackagePointer()) \ - delete NAME ## GetPackagePointer(); \ - NAME ## GetPackagePointer() = 0; \ + NAME ## GetPackagePointer().reset(); \ } \ - BBTK_PACKAGE_EXPORT bbtk::Package* BBTK_CDECL NAME ## GetPackage() \ + BBTK_PACKAGE_EXPORT \ + bbtk::Package::Pointer \ + BBTK_CDECL NAME ## GetPackage() \ { \ if (!NAME ## GetPackagePointer()) \ NAME ## GetPackagePointer() = \ - new bbtk::Package(#NAME, \ - AUTHOR, \ - DESCRIPTION, \ - VERSION, \ - BBTK_STRINGIFY_SYMBOL(BBTK_VERSION) \ - ); \ + bbtk::Package::New(#NAME, \ + AUTHOR, \ + DESCRIPTION, \ + 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::bbDescriptor()); + 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::bbDescriptor()); + bool bbDummy##NAME##CLASS##TEMPLATE_PARAM = NAME ## GetPackage () \ + ->RegisterBlackBox(CLASS ## Descriptor ::Instance()); + //==================================================================== + //==================================================================== - -//==================================================================== #define BBTK_ADD_TEMPLATE2_BLACK_BOX_TO_PACKAGE(NAME,CLASS,T1,T2) \ - bool bbDummy##NAME##CLASS##T1##T2 = NAME ## GetPackage()->RegisterBlackBox(CLASS::bbDescriptor()); + bool bbDummy##NAME##CLASS##T1##T2 = NAME ## GetPackage () \ + ->RegisterBlackBox(CLASS ## Descriptor ::Instance()); //==================================================================== -//==================================================================== -//#define BBTK_ADD_ADAPTOR_TO_PACKAGE(NAME,CLASS) \ -// bool bbDummy##NAME##CLASS = NAME ## GetPackage()->RegisterBlackBox(CLASS::bbDescriptor()); \ -// bool bbDummyAdaptor##NAME##CLASS = NAME ## GetPackage()->RegisterAdaptor(CLASS::bbDescriptor()); -//==================================================================== - -//==================================================================== -//#define BBTK_ADD_TEMPLATE_ADAPTOR_TO_PACKAGE(NAME,CLASS,TEMPLATE_PARAM) \ -// bool bbDummy##NAME##CLASS##TEMPLATE_PARAM = NAME ## GetPackage()->RegisterBlackBox(CLASS::bbDescriptor()); \ -// bool bbDummyAdaptor##NAME##CLASS##TEMPLATE_PARAM = NAME ## GetPackage()->RegisterAdaptor(CLASS::bbDescriptor()); -//==================================================================== - -//==================================================================== -//#define BBTK_ADD_TEMPLATE2_ADAPTOR_TO_PACKAGE(NAME,CLASS,T1,T2) \ -// bool bbDummy##NAME##CLASS##T1##T2 = NAME ## GetPackage()->RegisterBlackBox(CLASS::bbDescriptor()); \ -// bool bbDummyAdaptor##NAME##CLASS##T1##T2 = NAME ## GetPackage()->RegisterAdaptor(CLASS::bbDescriptor()); - //==================================================================== }// namespace bbtk