AppConfigManager.hpp

/* ***** BEGIN LICENSE BLOCK *****
 * FW4SPL - Copyright (C) IRCAD, 2015-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 "fwServices/helper/Config.hpp"
#include "fwServices/helper/ProxyConnections.hpp"
#include "fwServices/IAppConfigManager.hpp"
#include "fwServices/IService.hpp"
#include "fwServices/IXMLParser.hpp"
#include "fwServices/registry/AppConfig.hpp"

#include <fwCom/HasSlots.hpp>
#include <fwCom/helper/SigSlotConnection.hpp>

#include <string>
#include <unordered_map>
#include <unordered_set>
#include <vector>

namespace fwData
{
class Composite;
}

namespace fwServices
{
class FWSERVICES_CLASS_API AppConfigManager :  public ::fwServices::IAppConfigManager,
                                               public ::fwCom::HasSlots
{
public:

    fwCoreClassDefinitionsWithFactoryMacro((AppConfigManager)(::fwServices::IAppConfigManager),
                                           (()),
                                           std::make_shared< AppConfigManager >)
    fwCoreAllowSharedFromThis()

    FWSERVICES_API AppConfigManager();

    FWSERVICES_API virtual ~AppConfigManager();

    FWSERVICES_API virtual void setConfig(const std::string& configId,
                                          const FieldAdaptorType& replaceFields = FieldAdaptorType()) override;
    FWSERVICES_API virtual void setConfig(const std::string& configId,
                                          const ::fwData::Composite::csptr& replaceFields) override;
    FWSERVICES_API virtual ::fwData::Object::sptr getConfigRoot() const override;
    FWSERVICES_API virtual void launch() override;
    FWSERVICES_API virtual void stopAndDestroy() override;
    FWSERVICES_API virtual void create() override;
    FWSERVICES_API virtual void start() override;
    FWSERVICES_API virtual void update() override;
    FWSERVICES_API virtual void stop() override;
    FWSERVICES_API virtual void destroy() override;

    FWSERVICES_API virtual void startBundle();

    FWSERVICES_API void setIsUnitTest(bool isUnitTest);

private:

    typedef ::std::pair< std::string, bool > ConfigAttribute;
    typedef ::fwServices::helper::ProxyConnections ProxyConnections;
    typedef ::fwServices::IService::Config ServiceConfig;

    ::fwData::Object::sptr findObject(const std::string& uid, const std::string& errMsgTail) const;

    ::fwData::Object::sptr getNewObject(ConfigAttribute type, const std::string& uid) const;

    ::fwData::Object::sptr getNewObject(ConfigAttribute type,
                                        ConfigAttribute uid = ConfigAttribute("", false)) const;

    ::fwData::Object::sptr getObject(ConfigAttribute type, const std::string& uid) const;

    ::fwServices::IService::sptr getNewService(const std::string& uid, const std::string& implType) const;

    void stopStartedServices();
    void destroyCreatedServices();

    void processStartItems();
    void processUpdateItems();

    void createObjects(::fwRuntime::ConfigurationElement::csptr cfgElem);

    void createServices(::fwRuntime::ConfigurationElement::csptr cfgElem);

    ::fwServices::IService::sptr createService(const ServiceConfig& srvConfig);

    void createConnections();

    std::string msgHead() const;

    void addObjects(::fwData::Object::sptr obj, const std::string& id);

    void removeObjects(::fwData::Object::sptr obj, const std::string& id);

    void connectProxy(const std::string& channel, const ProxyConnections& connectCfg);

    void destroyProxy(const std::string& channel, const ProxyConnections& proxyCfg, const std::string& key = "",
                      fwData::Object::csptr hintObj = nullptr);
    void destroyProxies();

    static std::string getUIDListAsString(const std::vector<std::string>& uidList);

    typedef std::pair< ::fwData::Object::sptr, ::fwServices::IXMLParser::sptr> CreatedObjectType;
    std::unordered_map<std::string, CreatedObjectType> m_createdObjects;

    struct DeferredObjectType
    {
        std::vector< ServiceConfig > m_servicesCfg;
        std::unordered_map< std::string, ProxyConnections > m_proxyCnt;
        ::fwData::Object::sptr m_object;
    };

    std::unordered_map<std::string, DeferredObjectType > m_deferredObjects;

    std::unordered_set<std::string> m_deferredServices;

    std::unordered_map<std::string, ProxyConnections> m_createdObjectsProxies;

    struct ServiceProxyType
    {
        std::unordered_map< std::string, ProxyConnections > m_proxyCnt;
    };
    std::unordered_map< std::string, ServiceProxyType > m_servicesProxies;

    std::string m_configId;

    typedef std::vector< ::fwServices::IService::wptr > ServiceContainer;

    ServiceContainer m_createdSrv;

    ServiceContainer m_startedSrv;

    std::vector<std::string> m_deferredStartSrv;

    std::vector<std::string> m_deferredUpdateSrv;

    ::fwData::Composite::sptr m_tmpRootObject;

    unsigned int m_proxyID;

    ::fwCom::Connection m_addObjectConnection;
    ::fwCom::Connection m_removeObjectConnection;

    bool m_isUnitTest;
};

// ------------------------------------------------------------------------

inline std::string AppConfigManager::msgHead() const
{
    return "[" + m_configId + "] ";
}

} // namespace fwServices