JsonWriter.hpp

 
//
//  Copyright Phoenix Contact GmbH & Co. KG
//
#pragma once
#include "Arp/System/Core/Arp.h"
#include "Arp/System/Core/PimplPtr.hxx"
#include "Arp/System/Commons/Exceptions/JsonException.hpp"
 
namespace Arp { namespace System { namespace Commons { namespace Json
{
 
using Arp::System::Commons::JsonException;
 
class ARP_CXX_SYMBOL_EXPORT JsonWriter
{
public: // Impl forward declaration
    class Impl;
 
public: // usings
 
public: // construction/destruction/assignment
    JsonWriter(void);
    JsonWriter(const JsonWriter& arg) = delete;
    JsonWriter(JsonWriter&& arg)noexcept;
    JsonWriter& operator=(const JsonWriter& arg) = delete;
    JsonWriter& operator=(JsonWriter&& arg)noexcept;
    ~JsonWriter(void);
 
public: // static operations
    static JsonWriter Create(const String& filename);
    static bool TryCreate(const String& filename, JsonWriter& writer);
 
public: // setter/getter operations
    void SetPrettyPrint(bool state);
 
public: // operations
    void SaveDocument(void)const;
    bool TrySaveDocument(void) const;
 
    String SaveToText(void)const;
    bool TrySaveToText(String& text) const;
 
    // object
    void WriteRootObject(void);
    bool TryWriteRootObject(void);
    void WriteStartObject(const char* objectName);
    bool TryWriteStartObject(const char* objectName);
    void WriteEndObject(void);
    bool TryWriteEndObject(void);
 
    // complex array
    void WriteRootComplexArray(void);
    bool TryWriteRootComplexArray(void);
    void WriteStartComplexArray(const char* arrayName);
    bool TryWriteStartComplexArray(const char* arrayName);
    void WriteEndComplexArray(void);
    bool TryWriteEndComplexArray(void);
 
    // complex array item
    void WriteStartComplexArrayItem(void);
    bool TryWriteStartComplexArrayItem(void);
    void WriteEndComplexArrayItem(void);
    bool TryWriteEndComplexArrayItem(void);
 
    // write simple values
    void WriteValue(const char* valueName, const bool& value);
    void WriteValue(const char* valueName, const uint8& value);
    void WriteValue(const char* valueName, const int8& value);
    void WriteValue(const char* valueName, const uint16& value);
    void WriteValue(const char* valueName, const int16& value);
    void WriteValue(const char* valueName, const uint32& value);
    void WriteValue(const char* valueName, const int32& value);
    void WriteValue(const char* valueName, const uint64& value);
    void WriteValue(const char* valueName, const int64& value);
    void WriteValue(const char* valueName, const float32& value);
    void WriteValue(const char* valueName, const float64& value);
    void WriteValue(const char* valueName, std::nullptr_t value);
    void WriteValue(const char* valueName, const String& value);
    void WriteValue(const char* valueName, const char* value);
    void WriteValue(const char* valueName, const char* pBuffer, size_t bufferSize);
 
    // write simple array values
    void WriteSimpleArray(const char* arrayName, const std::vector<bool>& values);
    void WriteSimpleArray(const char* arrayName, const std::vector<String>& values);
    void WriteSimpleArray(const char* arrayName, const std::vector<uint8>& values);
    void WriteSimpleArray(const char* arrayName, const std::vector<int8>& values);
    void WriteSimpleArray(const char* arrayName, const std::vector<uint16>& values);
    void WriteSimpleArray(const char* arrayName, const std::vector<int16>& values);
    void WriteSimpleArray(const char* arrayName, const std::vector<uint32>& values);
    void WriteSimpleArray(const char* arrayName, const std::vector<int32>& values);
    void WriteSimpleArray(const char* arrayName, const std::vector<uint64>& values);
    void WriteSimpleArray(const char* arrayName, const std::vector<int64>& values);
    void WriteSimpleArray(const char* arrayName, const std::vector<float32>& values);
    void WriteSimpleArray(const char* arrayName, const std::vector<float64>& values);
 
public: // Impl operations
    Impl&       GetImpl(void);
    const Impl& GetImpl(void)const;
 
private: // Impl usings
    using Pimpl = PimplPtr<Impl>;
 
private: // Impl fields
    Pimpl   pimpl;
};
 
// inline methods of class JsonWriter
 
}}}} // end of namespace Arp::System::Commons::Json