MultiXmlConfigDocument.hpp

 
//
//  Copyright Phoenix Contact GmbH & Co. KG
//
#pragma once
#include "Arp/System/Core/Arp.h"
#include "Arp/System/Commons/Xml/XmlConfigDocument.hpp"
#include "Arp/System/Commons/Xml/DocumentTraits.hpp"
#include "Arp/System/Commons/Diagnostics/Logging/Logger.hxx"
#include "Arp/System/Commons/Configuration/ConfigurationSettings.hpp"
#include <deque>
#include <list>
 
namespace Arp { namespace System { namespace Commons { namespace Xml
{
 
// TContent policy: implement IXmlSerializable and default contructable
class MultiXmlConfigDocument : public XmlConfigDocument
{
private:
    struct FileItem
    {
        explicit FileItem(const String& path, const DocumentTraits& traits = DocumentTraits()) : Path(path), Traits(traits)
        {
        }
 
        String Path;
        DocumentTraits Traits;
    };
 
public: // typedef/usings
    using Base = XmlConfigDocument;
    using Files = std::deque<FileItem>;
    using IncludedFiles = std::list<String>;
    using Logger = Arp::System::Commons::Diagnostics::Logging::Logger<>;
 
public: // construction/destruction
    MultiXmlConfigDocument(const String& documentXmlElementName, IXmlSerializable& content);
    virtual ~MultiXmlConfigDocument(void) = default;
 
public: // operations
    void    AddFile(const String& filePath, const DocumentTraits& fileTraits);
    void    Load(const String& documentPath);
    void    Load(const String& documentPath, const DocumentTraits& documentTraits);
    void    Load(const ConfigurationSettings& configSettings);
    bool    TryLoad(const String& documentPath);
    bool    TryLoad(const String& documentPath, const DocumentTraits& documentTraits);
 
    bool    TryLoad(const ConfigurationSettings& configSettings);
 
protected: // overridden methods
    void    ReadDocument(XmlReader& reader)override;
 
    Files& GetFiles();
    IncludedFiles& GetIncludedFiles();
 
private: // static methods
    static bool ContainsFile(const Files& files, const String& file);
    static bool ContainsFile(const IncludedFiles& files, const String& file);
 
private: // methods
    bool    TryLoad(const String& documentPath, const DocumentTraits& documentTraits, String& errorMessage);
    bool    TryLoad(const ConfigurationSettings& configSettings, String& errorMessage);
 
private: // deleted methods
    MultiXmlConfigDocument(const MultiXmlConfigDocument& arg) = delete;
    MultiXmlConfigDocument& operator=(const MultiXmlConfigDocument& arg) = delete;
 
private: // fields
    Files         files;
    IncludedFiles includedFiles;
};
 
}}}} // end of namespace Arp::System::Commons::Xml