AppConfig.hpp

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

#ifndef __FWSERVICES_REGISTRY_APPCONFIG_HPP__
#define __FWSERVICES_REGISTRY_APPCONFIG_HPP__

#include "fwServices/config.hpp"
#include "fwServices/registry/AppInfo.hpp"

#include <fwCore/mt/types.hpp>

#include <fwData/Composite.hpp>

#include <fwRuntime/ConfigurationElement.hpp>
#include <fwRuntime/EConfigurationElement.hpp>
#include <fwRuntime/Extension.hpp>

#include <fwTools/Object.hpp>

#include <map>
#include <unordered_set>

namespace fwServices
{

namespace registry
{

class FWSERVICES_CLASS_API AppConfig : public ::fwCore::BaseObject
{

public:

    typedef std::map< std::string, std::string > FieldAdaptorType;

    fwCoreClassDefinitionsWithFactoryMacro( (AppConfig)(::fwCore::BaseObject), (()), new AppConfig);

    FWSERVICES_API virtual ~AppConfig();

    FWSERVICES_API void parseBundleInformation();

    FWSERVICES_API void parseBundleInformation(
        const std::vector< std::shared_ptr< ::fwRuntime::Extension > >& extensions);

    FWSERVICES_API void addAppInfo( const std::string& configId,
                                    const std::string& group,
                                    const std::string& desc,
                                    const AppInfo::ParametersType& parameters,
                                    const ::fwRuntime::ConfigurationElement::csptr& config,
                                    const std::string& bundleId,
                                    const std::string& bundleVersion);

    FWSERVICES_API ::fwRuntime::ConfigurationElement::csptr getAdaptedTemplateConfig( const std::string& configId,
                                                                                      const FieldAdaptorType replaceFields,
                                                                                      bool autoPrefixId ) const;

    FWSERVICES_API ::fwRuntime::ConfigurationElement::csptr getAdaptedTemplateConfig( const std::string& configId,
                                                                                      ::fwData::Composite::csptr replaceFields,
                                                                                      bool autoPrefixId )
    const;

    FWSERVICES_API std::shared_ptr< ::fwRuntime::Bundle > getBundle(const std::string& _configId);

    FWSERVICES_API std::vector< std::string > getAllConfigs() const;

    FWSERVICES_API std::vector< std::string > getConfigsFromGroup(const std::string& group) const;

    FWSERVICES_API void clearRegistry();

    FWSERVICES_API static std::string getUniqueIdentifier(const std::string& serviceUid = "" );

    FWSERVICES_API static AppConfig::sptr getDefault();

protected:

    typedef std::map< std::string, AppInfo::sptr > Registry;

    Registry m_reg;

    FWSERVICES_API AppConfig();

private:

    typedef std::unordered_set< std::string > UidParameterReplaceType;

    FieldAdaptorType compositeToFieldAdaptor( ::fwData::Composite::csptr fieldAdaptors ) const;

    static void collectUIDForParameterReplace(::fwRuntime::ConfigurationElement::csptr _cfgElem,
                                              UidParameterReplaceType& replaceMap);

    static ::fwRuntime::EConfigurationElement::sptr adaptConfig(::fwRuntime::ConfigurationElement::csptr _cfgElem,
                                                                const FieldAdaptorType& _fieldAdaptors,
                                                                const UidParameterReplaceType& _uidParameterReplace,
                                                                const std::string& _autoPrefixId );

    static std::string adaptField(const std::string& _str, const FieldAdaptorType& _variablesMap );

    mutable ::fwCore::mt::ReadWriteMutex m_registryMutex;

    static ::fwCore::mt::Mutex s_idMutex;

    static AppConfig::sptr s_currentAppConfig;

    static std::string s_mandatoryParameterIdentifier;

    typedef std::multimap< std::string, std::string > UidDefinitionType;
    static UidDefinitionType s_uidDefinitionDictionary;
};

} // namespace registry

} // namespace fwServices

#endif // __FWSERVICES_REGISTRY_APPCONFIG_HPP__