TicReader.hpp

//
//  Copyright PHOENIX CONTACT Electronics GmbH
//
#pragma once
#include "Arp/System/Core/Arp.h"
#include "Arp/System/Commons/Diagnostics/Logging/Loggable.hxx"
#include "Arp/System/Commons/Xml/XmlReader.hpp"
#include "Arp/System/Commons/Exceptions/XmlException.hpp"
#include "Arp/System/Commons/Configuration/TicNodeType.hpp"
#include "Arp/System/Commons/Configuration/TicSerializationContext.hpp"
#include <map>
#include <sstream>

namespace Arp { namespace System { namespace Commons { namespace Configuration
{

using namespace Arp::System::Commons::Diagnostics::Logging;
using namespace Arp::System::Commons::Xml;

class TicReader : private Loggable<TicReader>
{
    friend class TicSerializationContext;

private: // typedefs
    typedef std::map<TicNodeType, String>   TicNodeTypeNames;
    typedef std::map<String, TicNodeType>   TicNameNodeTypes;

public: // typedefs
    template<typename T>
    using SectionReadCallback = void (T::*)(TicReader& reader, TicSerializationContext& context);

public: // nested helper class
    template<class T>
    struct SectionReadCallbacks
    {
    public: // Static fields
        static SectionReadCallback<T> Null;
        static SectionReadCallback<T> Empty;

    private:
        void EmptySectionReadCallback(TicReader&, TicSerializationContext&) {}
    };

public: // construction/destruction
    TicReader(TicReader&& arg);
    ~TicReader(void) = default;

private: // construction/destruction
    TicReader(const String& filename);
    TicReader(const TicReader& arg) = delete;
    TicReader& operator=(const TicReader& arg) = delete;

public: // static operations
    static TicReader   Create(const String& filename);

public: // setter/getter operations
    XmlReader&  GetXmlReader(void);

public: // operations
    // read unknown tick node and determine nodeType
    void    ReadStartTicNode(TicNodeType& nodeType);
    bool    TryReadStartTicNode(TicNodeType& nodeType);
    void    ReadEndTicNode(TicNodeType nodeType);
    bool    TryReadEndTicNode(TicNodeType nodeType);

    // Read <EL> or </EL> nodes
    void    ReadStartTicElementList(void);
    bool    TryReadStartTicElementList(void);
    void    ReadEndTicElementList(void);
    bool    TryReadEndTicElementList(void);

    // Read <AL> or </AL> nodes
    void    ReadStartTicAttributeList(void);
    bool    TryReadStartTicAttributeList(void);
    void    ReadEndTicAttributeList(void);
    bool    TryReadEndTicAttributeList(void);

    // Read TIC element <E> or </E> nodes
    void    ReadStartTicElement(String& readELementName);
    bool    TryReadStartTicElement(String& readELementName);
    bool    TryReadStartTicElement(const String& elementName, String& readELementName);
    void    ReadEndTicElement(void);
    bool    TryReadEndTicElement(void);

    // Read TIC attribute <A> or </A> nodes
    void    ReadStartTicAttribute(String& readAttributeName);
    bool    TryReadStartTicAttribute(String& readAttributeName);
    bool    TryReadStartTicAttribute(const String& attributeName, String& readAttributeName);
    void    ReadEndTicAttribute(void);
    bool    TryReadEndTicAttribute(void);

    // Read TIC attribute values <V>...</V>
    void    SkipTicAttributeValue(void);
    template<class T>
    T       ReadTicAttributeValue(void);
    template<class T>
    bool    TryReadTicAttributeValue(T& result);

    // Read TIC element content containing one <AL>..</AL> (optional) and one <EL>..</EL> section (optional).
    template<class T>
    void    ReadTicElementContent(
        TicSerializationContext& context,
        T& configuration,
        SectionReadCallback<T> attributesReadMethod,
        SectionReadCallback<T> childElementsReadMethod = nullptr,
        bool attributesAreOptional = false,
        bool elementsAreOptional = false);

private: // methods
    bool    TryReadStartTicElement(const String& elementName, String& readELementName, String& errorMessage);
    bool    TryReadStartTicAttribute(const String& attributeName, String& readAttributeName, String& errorMessage);
    bool    TryReadTicAttributeContent(String& result, String& errorMessage);
    template<class T>
    bool    TryReadTicAttributeValue(T& result, String& errorMessage);
    void    SkipTicAttributeList(void);
    void    SkipTicElementList(void);

private: // fields
    XmlReader   xmlReader;

private: // static fields
    static TicNodeTypeNames    ticNodeTypeNames;
    static TicNameNodeTypes    ticNameNodeTypes;

private: // static const fields
    static const char* const ticElementNameAttributeName;
    static const char* const ticAttributeNameAttributeName;
};

// inline methods of class TicReader

inline TicReader TicReader::Create(const String& filename)
{
    return TicReader(filename);
}

inline XmlReader& TicReader::GetXmlReader()
{
    return this->xmlReader;
}

inline bool TicReader::TryReadStartTicElementList()
{
    TicNodeType nodeType = TicNodeType::None;
    return this->TryReadStartTicNode(nodeType) && nodeType == TicNodeType::ElementList;
}

inline void TicReader::ReadStartTicElementList()
{
    if (!this->TryReadStartTicElementList())
    {
        throw XmlException("Invalid Tic file format: missing StartTicElementList tag '<{0}>'.", ticNodeTypeNames[TicNodeType::ElementList]);
    }
}

inline bool TicReader::TryReadEndTicElementList()
{
    return this->TryReadEndTicNode(TicNodeType::ElementList);
}

inline void TicReader::ReadEndTicElementList()
{
    if (!this->TryReadEndTicElementList())
    {
        throw XmlException("Invalid Tic file format: missing EndTicElementList tag '</{0}>'.", ticNodeTypeNames[TicNodeType::ElementList]);
    }
}

inline bool TicReader::TryReadStartTicAttributeList()
{
    TicNodeType nodeType = TicNodeType::None;
    return this->TryReadStartTicNode(nodeType) && nodeType == TicNodeType::AttributeList;
}

inline void TicReader::ReadStartTicAttributeList()
{
    if (!this->TryReadStartTicAttributeList())
    {
        throw XmlException("Invalid Tic file format: missing StartTicAttributeList tag '<{0}>'.", ticNodeTypeNames[TicNodeType::AttributeList]);
    }
}

inline bool TicReader::TryReadEndTicAttributeList()
{
    return this->TryReadEndTicNode(TicNodeType::AttributeList);
}

inline void TicReader::ReadEndTicAttributeList()
{
    if (!this->TryReadEndTicAttributeList())
    {
        throw XmlException("Invalid Tic file format: missing EndTicAttributeList tag '</{0}>'.", ticNodeTypeNames[TicNodeType::AttributeList]);
    }
}

inline void TicReader::ReadStartTicElement(String& readELementName)
{
    String errorMessage;
    if (!this->TryReadStartTicElement(String::Empty, readELementName, errorMessage))
    {
        throw XmlException(errorMessage);
    }
}

inline bool TicReader::TryReadStartTicElement(String& readELementName)
{
    String errorMessage;
    return this->TryReadStartTicElement(String::Empty, readELementName, errorMessage);
}

inline bool TicReader::TryReadStartTicElement(const String& elementName, String& readELementName)
{
    String errorMessage;
    return this->TryReadStartTicElement(elementName, readELementName, errorMessage);
}

inline void TicReader::ReadEndTicElement()
{
    if (!this->TryReadEndTicElement())
    {
        throw XmlException("Invalid Tic file format: missing EndTicElement tag '</{0}>'.", ticNodeTypeNames[TicNodeType::Element]);
    }
}

inline bool TicReader::TryReadEndTicElement()
{
    return this->TryReadEndTicNode(TicNodeType::Element);
}

inline void TicReader::ReadStartTicAttribute(String& readAttributeName)
{
    String errorMessage;
    if (!this->TryReadStartTicAttribute(String::Empty, readAttributeName, errorMessage))
    {
        throw XmlException(errorMessage);
    }
}

inline bool TicReader::TryReadStartTicAttribute(String& readAttributeName)
{
    String errorMessage;
    return this->TryReadStartTicAttribute(String::Empty, readAttributeName, errorMessage);
}

inline bool TicReader::TryReadStartTicAttribute(const String& attributeName, String& readAttributeName)
{
    String errorMessage;
    return this->TryReadStartTicAttribute(attributeName, readAttributeName, errorMessage);
}

inline void TicReader::ReadEndTicAttribute(void)
{
    if (!this->TryReadEndTicAttribute())
    {
        throw XmlException("Invalid Tic file format: missing EndTicAttribute tag '</{0}>'.", ticNodeTypeNames[TicNodeType::Attribute]);
    }
}

inline bool TicReader::TryReadEndTicAttribute()
{
    return this->TryReadEndTicNode(TicNodeType::Attribute);
}

inline void TicReader::SkipTicAttributeValue()
{
    (void) this->ReadTicAttributeValue<String>();
}

template<class T>
inline T TicReader::ReadTicAttributeValue()
{
    T result;
    String errorMessage;
    if (!this->TryReadTicAttributeValue<T>(result, errorMessage))
    {
        throw XmlException(errorMessage);
    }
    return result;
}

template<class T>
inline bool TicReader::TryReadTicAttributeValue(T& result)
{
    String errorMessage;
    return this->TryReadTicAttributeValue<T>(result, errorMessage);
}

template<class T>
inline bool TicReader::TryReadTicAttributeValue(T& result, String& errorMessage)
{
    String attributeValue;
    if (!this->TryReadTicAttributeContent(attributeValue, errorMessage))
    {
        return false;
    }
    // else convert
    std::stringstream iss(attributeValue);
    iss >> boolalpha >> result;
    return !iss.fail();
}
template<>
inline bool TicReader::TryReadTicAttributeValue(String& result, String& errorMessage)
{
    String attributeValue;
    if (!this->TryReadTicAttributeContent(result, errorMessage))
    {
        return false;
    }
    return true;
    // else convert
    /*std::stringstream iss(attributeValue);
    iss >> boolalpha >> result;
    return !iss.fail();*/
}

template<class T>
inline void TicReader::ReadTicElementContent(
    TicSerializationContext& context,
    T& configuration,
    SectionReadCallback<T> attributesReader,
    SectionReadCallback<T> childElementsReader,
    bool attributesAreOptional,
    bool elementsAreOptional)
{
    bool hasAttributesRead = false;
    bool hasChildElementsRead = false;

    while (!(hasAttributesRead && hasChildElementsRead))
    {
        TicNodeType nodeType = TicNodeType::None;
        if (this->TryReadStartTicNode(nodeType))
        {
            bool mustReadEndTicNode = true;
            switch (nodeType)
            {
                case TicNodeType::AttributeList:
                    if (attributesReader == nullptr)
                    {
                        this->SkipTicAttributeList();
                    }
                    else
                    {
                        (configuration.*attributesReader)(*this, context);
                    }
                    hasAttributesRead = true;
                    break;
                case TicNodeType::ElementList:
                    if (childElementsReader == nullptr)
                    {
                        this->SkipTicElementList();
                        mustReadEndTicNode = false; // xmlReader.Skip() reads also EndElement of current node
                    }
                    else
                    {
                        (configuration.*childElementsReader)(*this, context);
                    }
                    hasChildElementsRead = true;
                    break;
                default:
                    throw XmlException("Invalid TIC file format: expecting attribute or element list");
                    break;
            }
            if(mustReadEndTicNode)
            {
                this->ReadEndTicNode(nodeType);
            }
        }
        else // a further start tic node could not be read
        {
            if (!hasAttributesRead && !attributesAreOptional)
            {
                throw XmlException("Invalid TIC file format: expecting attribute list");
            }
            else if (attributesReader == nullptr && attributesAreOptional)
            {
                hasAttributesRead = true;
            }

            if (!hasChildElementsRead && !elementsAreOptional)
            {
                throw XmlException("Invalid TIC file format: expecting element list");
            }
            else if (elementsAreOptional)
            {
                hasChildElementsRead = true;
            }
        }
    }
}

// initializing of static fields of class TicReader::SectionReadCallbacks
template<class T>
TicReader::SectionReadCallback<T> TicReader::SectionReadCallbacks<T>::Null = nullptr;
template<class T>
TicReader::SectionReadCallback<T> TicReader::SectionReadCallbacks<T>::Empty = &TicReader::SectionReadCallbacks<T>::EmptySectionReadCallback;

}}}} // end of namespace Arp::System::Commons::Configuration