ConfigurationElement.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 "fwRuntime/config.hpp"
#include "fwRuntime/ConfigurationElementContainer.hpp"
#include "fwRuntime/RuntimeException.hpp"

#include <fwCore/base.hpp>

#include <map>
#include <memory>
#include <string>
#include <utility>
#include <vector>

namespace fwRuntime
{
struct Bundle;
struct Executable;

namespace io
{
struct BundleDescriptorReader;
}
}

namespace fwRuntime
{

struct FWRUNTIME_CLASS_API ConfigurationElement :   public ConfigurationElementContainer,
                                                    public std::enable_shared_from_this< ConfigurationElement >
{

    friend struct ::fwRuntime::io::BundleDescriptorReader;

    fwCoreClassFactoryMacro((ConfigurationElement),
                            ((( const std::shared_ptr< Bundle > ))(( const std::string ))),
                            new ConfigurationElement)
    __FWCORE_GENERATE_CAST(__FWCORE_GET_CLASSNAME((ConfigurationElement)), __FWCORE_TYPEDEF_ROOTCLASS_NAME)
    fwCoreInterfaceMacro()
    fwCoreInterfaceIsTypeOfMacro((ConfigurationElement))

    typedef std::pair< bool, std::string > AttributePair;

    struct NoSuchAttribute : public ::fwCore::Exception
    {
        NoSuchAttribute(const std::string& attr) :
            ::fwCore::Exception(std::string("No such attribute: ") + attr)
        {
        }
    };

    FWRUNTIME_API const std::shared_ptr< Bundle > getBundle() const noexcept;

    FWRUNTIME_API const std::string getAttributeValue(const std::string& name) const noexcept;

    FWRUNTIME_API const std::string getExistingAttributeValue(const std::string& name) const;

    FWRUNTIME_API const AttributePair getSafeAttributeValue(const std::string& name) const noexcept;

    FWRUNTIME_API const std::string getName() const noexcept;

    FWRUNTIME_API const std::string getValue() const noexcept;

    FWRUNTIME_API bool hasAttribute(const std::string& name) const noexcept;

    FWRUNTIME_API const std::map<std::string, std::string> getAttributes() const noexcept;

    FWRUNTIME_API friend std::ostream& operator<<(std::ostream& _sstream,
                                                  ConfigurationElement& _configurationElement);

    FWRUNTIME_API std::vector < ConfigurationElement::sptr > find(
        std::string name           = "",
        std::string attribute      = "",
        std::string attributeValue = "",
        int depth                  = 1
        );

    FWRUNTIME_API virtual ~ConfigurationElement();

    protected:

        FWRUNTIME_API ConfigurationElement(const std::shared_ptr<Bundle> bundle, const std::string& name);

        FWRUNTIME_API void setAttributeValue(const std::string& name, const std::string& value) noexcept;

        FWRUNTIME_API void setValue(const std::string& value) noexcept;

    private:

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

        const std::string m_name;

        std::string m_value;

        AttributeContainer m_attributes;

        void operator=(const ConfigurationElement&) noexcept;

        const std::weak_ptr<Bundle> m_bundle;
};

} // namespace fwRuntime