XmlWriter.hpp

//
//  Copyright PHOENIX CONTACT Electronics GmbH
//
#pragma once
#include "Arp/System/Core/Arp.h"
#include "Arp/System/Core/TypeName.hxx"
#include "Arp/System/Commons/Logging.h"
#include "Arp/System/Commons/Exceptions/InvalidFormatException.hpp"

#include "cppformat/format.h"

namespace Arp { namespace System { namespace Commons { namespace Xml
{

class XmlBuffer;

class XmlWriter
{
public: // typedefs

public: // construction/destruction
    XmlWriter(XmlWriter&& arg);
    ~XmlWriter(void);

private: //  construction/destruction
    XmlWriter(const String& filename, bool indent, const char* encoding = "UTF-8");
    XmlWriter(XmlBuffer& buffer, bool indent, const char* encoding);
    XmlWriter(const XmlWriter& arg) = delete;
    XmlWriter& operator=(const XmlWriter& arg) = delete;

public: // static operations
    static XmlWriter Create(const String& filename, bool indent, const char* encoding = "UTF-8");

    static XmlWriter Create(XmlBuffer& buffer, bool indent, const char* encoding = "UTF-8");

public: // setter/getter operations
    bool        GetIndent(void)const;
    const char* GetEncoding(void)const;

public: // operations
    void    WriteStartDocument(void);
    void    WriteEndDocument(void);

    void    WriteStartElement(const char* elementName);
    void    WriteEndElement(void);
    void    WriteElementContent(const String& value);
    void    WriteElementContentCData(const String& text);

    //see http://zverovich.net/2013/09/07/integer-to-string-conversion-in-cplusplus.html
    //for a speed comparison of integer to string conversion operations

    template<class T>
    void SetAttributeValue(const char* attributeName, const T& value)
    {
        try
        {
            fmt::MemoryWriter tmpWriter;
            tmpWriter << value;
            SetAttributeValueInternal(attributeName, tmpWriter.c_str());
        }
        catch(std::exception& e)
        {
            throw InvalidFormatException("Could not format Xml attribute '{0}': {1}", e.what());
        }
    }
    //overload for const char* to improve performance in this case
    void SetAttributeValue(const char* attributeName, const char* value);
    //fmt::MemoryWriter does not support String, so overload for String
    void SetAttributeValue(const char* attributeName, const String& value);
    //fmt::MemoryWriter writes true as 1 so overload for bool
    void SetAttributeValue(const char* attributeName, boolean value);

protected: // operations

private: // static methods

private: // methods
    void SetAttributeValueInternal(const char* attributeName, const char *value);
private: // fields

    void *writer;
    String encoding;

private: // static fields

};

// inline methods of class XmlWriter

}}}} // end of namesapce Arp::System::Commons::Xml