ServiceFactory.hpp

/* ***** BEGIN LICENSE BLOCK *****
 * FW4SPL - Copyright (C) IRCAD, 2009-2018.
 * Distributed under the terms of the GNU Lesser General Public License (LGPL) as
 * published by the Free Software Foundation.
 * ****** END LICENSE BLOCK ****** */

#pragma once

#include "fwServices/config.hpp"

#include <fwCore/mt/types.hpp>

#include <fwRuntime/Bundle.hpp>

#include <fwTools/Object.hpp>

#include <boost/unordered_map.hpp>

#include <unordered_map>

namespace fwServices
{

class IService;

namespace registry
{

class FWSERVICES_CLASS_API ServiceFactory : public ::fwCore::BaseObject
{

public:

    typedef std::string KeyType;
    typedef std::vector<KeyType> KeyVectorType;
    typedef std::pair<std::string, std::string> StringPair;

    typedef ::boost::unordered_map< StringPair, bool > SupportMapType;
    typedef std::function< SPTR(::fwServices::IService)() > FactoryType;

    fwCoreClassDefinitionsWithFactoryMacro( (ServiceFactory)(::fwCore::BaseObject), (()), new ServiceFactory)

    
    FWSERVICES_API static ServiceFactory::sptr getDefault();

    FWSERVICES_API void parseBundleInformation( );

    FWSERVICES_API void addServiceFactory( FactoryType _factory,
                                           const std::string& simpl,
                                           const std::string& stype);

    FWSERVICES_API void addObjectFactory( const std::string& simpl,
                                          const std::string& oimpl);

    FWSERVICES_API SPTR(IService) create( const std::string& _srvImpl ) const;

    FWSERVICES_API SPTR(IService) create( const std::string& _srvType, const std::string& _srvImpl ) const;

    FWSERVICES_API void clearFactory();

    FWSERVICES_API std::vector< std::string > getImplementationIdFromObjectAndType(const std::string& object,
                                                                                   const std::string& type) const;

    FWSERVICES_API std::string getDefaultImplementationIdFromObjectAndType( const std::string& object,
                                                                            const std::string& type ) const;

    FWSERVICES_API const std::vector<std::string>& getServiceObjects(const std::string& srvImpl) const;

    FWSERVICES_API std::string getServiceDescription(const std::string& srvImpl) const;

    FWSERVICES_API std::string getServiceTags(const std::string& srvImpl) const;

    FWSERVICES_API bool checkServiceValidity(const std::string& object, const std::string& srvImpl) const;

    FWSERVICES_API bool support(const std::string& object, const std::string& srvType);

    FWSERVICES_API bool support(const std::string& object, const std::string& srvType,
                                const std::string& srvImpl) const;

    FWSERVICES_API virtual KeyVectorType getFactoryKeys() const;

private:

    struct ServiceInfo
    {
        std::string serviceType;
        std::vector<std::string> objectImpl;
        std::string desc;
        std::string tags;
        std::shared_ptr< ::fwRuntime::Bundle > bundle;
        FactoryType factory;
        bool objectsSetFromBundle {false}; // True if the objects implementation are set from the bundle information
    };
    typedef std::unordered_map< KeyType, ServiceInfo > SrvRegContainer;

    void printInfoMap( const SrvRegContainer& src ) const;

    void checkServicesNotDeclaredInPluginXml() const;

    SrvRegContainer m_srvImplTosrvInfo;
    SupportMapType m_supportMap;

    mutable ::fwCore::mt::ReadWriteMutex m_srvImplTosrvInfoMutex;
    mutable ::fwCore::mt::ReadWriteMutex m_supportMapMutex;
};

} // namespace registry
} // namespace fwServices