JsonWriter.h

Go to the documentation of this file.

#ifndef ZSERIO_JSON_WRITER_H_INC
#define ZSERIO_JSON_WRITER_H_INC
 
#include <ostream>
#include <string_view>
 
#include "zserio/AllocatorHolder.h"
#include "zserio/IWalkObserver.h"
#include "zserio/JsonEncoder.h"
#include "zserio/Optional.h"
#include "zserio/String.h"
#include "zserio/TypeInfoUtil.h"
 
namespace zserio
{
using namespace std::literals::string_view_literals;
 
template <typename ALLOC = std::allocator<uint8_t>>
class BasicJsonWriter : public IBasicWalkObserver<ALLOC>, public AllocatorHolder<ALLOC>
{
public:
    using AllocatorHolder<ALLOC>::get_allocator;
 
    static constexpr const char* DEFAULT_ITEM_SEPARATOR = ", ";
 
    static constexpr const char* DEFAULT_ITEM_SEPARATOR_WITH_INDENT = ",";
 
    static constexpr const char* DEFAULT_KEY_SEPARATOR = ": ";
 
    enum class EnumerableFormat
    {
        NUMBER,
        STRING
    };
    static constexpr EnumerableFormat DEFAULT_ENUMERABLE_FORMAT = EnumerableFormat::STRING;
 
    explicit BasicJsonWriter(std::ostream& out, const ALLOC& allocator = ALLOC());
 
    BasicJsonWriter(std::ostream& out, uint8_t indent, const ALLOC& allocator = ALLOC());
 
    BasicJsonWriter(std::ostream& out, const BasicString<RebindAlloc<ALLOC, char>>& indent,
            const ALLOC& allocator = ALLOC());
 
    ~BasicJsonWriter() override = default;
 
    BasicJsonWriter(const BasicJsonWriter& other) = delete;
    BasicJsonWriter& operator=(const BasicJsonWriter& other) = delete;
 
    BasicJsonWriter(BasicJsonWriter&& other) = delete;
    BasicJsonWriter& operator=(BasicJsonWriter&& other) = delete;
    void setItemSeparator(const BasicString<RebindAlloc<ALLOC, char>>& itemSeparator);
 
    void setKeySeparator(const BasicString<RebindAlloc<ALLOC, char>>& keySeparator);
 
    void setEnumerableFormat(EnumerableFormat enumerableFormat);
 
    void beginRoot(const IBasicReflectableDataConstPtr<ALLOC>& compound) override;
    void endRoot(const IBasicReflectableDataConstPtr<ALLOC>& compound) override;
 
    void beginArray(
            const IBasicReflectableDataConstPtr<ALLOC>& array, const BasicFieldInfo<ALLOC>& fieldInfo) override;
    void endArray(
            const IBasicReflectableDataConstPtr<ALLOC>& array, const BasicFieldInfo<ALLOC>& fieldInfo) override;
 
    void beginCompound(const IBasicReflectableDataConstPtr<ALLOC>& compound,
            const BasicFieldInfo<ALLOC>& fieldInfo, size_t elementIndex) override;
    void endCompound(const IBasicReflectableDataConstPtr<ALLOC>& compound,
            const BasicFieldInfo<ALLOC>& fieldInfo, size_t elementIndex) override;
 
    void visitValue(const IBasicReflectableDataConstPtr<ALLOC>& value, const BasicFieldInfo<ALLOC>& fieldInfo,
            size_t elementIndex) override;
 
private:
    BasicJsonWriter(std::ostream& out, Optional<BasicString<RebindAlloc<ALLOC, char>>>&& optionalIndent,
            const ALLOC& allocator = ALLOC());
 
    void beginItem();
    void endItem();
    void beginObject();
    void endObject();
    void beginArray();
    void endArray();
 
    void writeIndent();
    void writeKey(std::string_view key);
    void writeValue(const IBasicReflectableDataConstPtr<ALLOC>& reflectable);
    void writeBitBuffer(const BasicBitBuffer<ALLOC>& bitBuffer);
    void writeBytes(Span<const uint8_t> value);
    void writeStringifiedEnum(const IBasicReflectableDataConstPtr<ALLOC>& reflectable);
    void writeStringifiedBitmask(const IBasicReflectableDataConstPtr<ALLOC>& reflectable);
 
    std::ostream& m_out;
    Optional<BasicString<RebindAlloc<ALLOC, char>>> m_indent;
    BasicString<RebindAlloc<ALLOC, char>> m_itemSeparator;
    BasicString<RebindAlloc<ALLOC, char>> m_keySeparator;
    EnumerableFormat m_enumerableFormat = DEFAULT_ENUMERABLE_FORMAT;
 
    bool m_isFirst = true;
    size_t m_level = 0;
};
 
using JsonWriter = BasicJsonWriter<>;
template <typename ALLOC>
BasicJsonWriter<ALLOC>::BasicJsonWriter(std::ostream& out, const ALLOC& allocator) :
        BasicJsonWriter(out, std::nullopt, allocator)
{}
 
template <typename ALLOC>
BasicJsonWriter<ALLOC>::BasicJsonWriter(std::ostream& out, uint8_t indent, const ALLOC& allocator) :
        BasicJsonWriter(out, BasicString<RebindAlloc<ALLOC, char>>(indent, ' ', allocator), allocator)
{}
 
template <typename ALLOC>
BasicJsonWriter<ALLOC>::BasicJsonWriter(
        std::ostream& out, const BasicString<RebindAlloc<ALLOC, char>>& indent, const ALLOC& allocator) :
        BasicJsonWriter(out, Optional<BasicString<RebindAlloc<ALLOC, char>>>(indent), allocator)
{}
 
template <typename ALLOC>
BasicJsonWriter<ALLOC>::BasicJsonWriter(std::ostream& out,
        Optional<BasicString<RebindAlloc<ALLOC, char>>>&& optionalIndent, const ALLOC& allocator) :
        AllocatorHolder<ALLOC>(allocator),
        m_out(out),
        m_indent(optionalIndent),
        m_itemSeparator(
                m_indent.has_value() ? DEFAULT_ITEM_SEPARATOR_WITH_INDENT : DEFAULT_ITEM_SEPARATOR, allocator),
        m_keySeparator(DEFAULT_KEY_SEPARATOR, allocator)
{}
 
template <typename ALLOC>
void BasicJsonWriter<ALLOC>::setItemSeparator(const BasicString<RebindAlloc<ALLOC, char>>& itemSeparator)
{
    m_itemSeparator = itemSeparator;
}
 
template <typename ALLOC>
void BasicJsonWriter<ALLOC>::setKeySeparator(const BasicString<RebindAlloc<ALLOC, char>>& keySeparator)
{
    m_keySeparator = keySeparator;
}
 
template <typename ALLOC>
void BasicJsonWriter<ALLOC>::setEnumerableFormat(EnumerableFormat enumerableFormat)
{
    m_enumerableFormat = enumerableFormat;
}
 
template <typename ALLOC>
void BasicJsonWriter<ALLOC>::beginRoot(const IBasicReflectableDataConstPtr<ALLOC>&)
{
    beginObject();
}
 
template <typename ALLOC>
void BasicJsonWriter<ALLOC>::endRoot(const IBasicReflectableDataConstPtr<ALLOC>&)
{
    endObject();
    m_out.flush();
}
 
template <typename ALLOC>
void BasicJsonWriter<ALLOC>::beginArray(
        const IBasicReflectableDataConstPtr<ALLOC>&, const BasicFieldInfo<ALLOC>& fieldInfo)
{
    beginItem();
 
    writeKey(fieldInfo.schemaName);
 
    beginArray();
}
 
template <typename ALLOC>
void BasicJsonWriter<ALLOC>::endArray(const IBasicReflectableDataConstPtr<ALLOC>&, const BasicFieldInfo<ALLOC>&)
{
    endArray();
 
    endItem();
}
 
template <typename ALLOC>
void BasicJsonWriter<ALLOC>::beginCompound(const IBasicReflectableDataConstPtr<ALLOC>&,
        const BasicFieldInfo<ALLOC>& fieldInfo, size_t elementIndex)
{
    beginItem();
 
    if (elementIndex == WALKER_NOT_ELEMENT)
    {
        writeKey(fieldInfo.schemaName);
    }
 
    beginObject();
}
 
template <typename ALLOC>
void BasicJsonWriter<ALLOC>::endCompound(
        const IBasicReflectableDataConstPtr<ALLOC>&, const BasicFieldInfo<ALLOC>&, size_t)
{
    endObject();
 
    endItem();
}
 
template <typename ALLOC>
void BasicJsonWriter<ALLOC>::visitValue(const IBasicReflectableDataConstPtr<ALLOC>& value,
        const BasicFieldInfo<ALLOC>& fieldInfo, size_t elementIndex)
{
    beginItem();
 
    if (elementIndex == WALKER_NOT_ELEMENT)
    {
        writeKey(fieldInfo.schemaName);
    }
 
    writeValue(value);
 
    endItem();
}
 
template <typename ALLOC>
void BasicJsonWriter<ALLOC>::beginItem()
{
    if (!m_isFirst)
    {
        m_out.write(m_itemSeparator.data(), static_cast<std::streamsize>(m_itemSeparator.size()));
    }
 
    if (m_indent.has_value())
    {
        m_out.put('\n');
    }
 
    writeIndent();
}
 
template <typename ALLOC>
void BasicJsonWriter<ALLOC>::endItem()
{
    m_isFirst = false;
}
 
template <typename ALLOC>
void BasicJsonWriter<ALLOC>::beginObject()
{
    m_out.put('{');
 
    m_isFirst = true;
    m_level += 1;
}
 
template <typename ALLOC>
void BasicJsonWriter<ALLOC>::endObject()
{
    if (m_indent.has_value())
    {
        m_out.put('\n');
    }
 
    m_level -= 1;
 
    writeIndent();
 
    m_out.put('}');
}
 
template <typename ALLOC>
void BasicJsonWriter<ALLOC>::beginArray()
{
    m_out.put('[');
 
    m_isFirst = true;
    m_level += 1;
}
 
template <typename ALLOC>
void BasicJsonWriter<ALLOC>::endArray()
{
    if (m_indent.has_value())
    {
        m_out.put('\n');
    }
 
    m_level -= 1;
 
    writeIndent();
 
    m_out.put(']');
}
 
template <typename ALLOC>
void BasicJsonWriter<ALLOC>::writeIndent()
{
    if (m_indent.has_value())
    {
        const auto& indent = m_indent.value();
        if (!indent.empty())
        {
            for (size_t i = 0; i < m_level; ++i)
            {
                m_out.write(indent.data(), static_cast<std::streamsize>(indent.size()));
            }
        }
    }
}
 
template <typename ALLOC>
void BasicJsonWriter<ALLOC>::writeKey(std::string_view key)
{
    JsonEncoder::encodeString(m_out, key);
    m_out.write(m_keySeparator.data(), static_cast<std::streamsize>(m_keySeparator.size()));
    m_out.flush();
}
 
template <typename ALLOC>
void BasicJsonWriter<ALLOC>::writeValue(const IBasicReflectableDataConstPtr<ALLOC>& reflectable)
{
    if (!reflectable)
    {
        JsonEncoder::encodeNull(m_out);
        return;
    }
 
    const IBasicTypeInfo<ALLOC>& typeInfo = reflectable->getTypeInfo();
    switch (typeInfo.getCppType())
    {
    case CppType::BOOL:
        JsonEncoder::encodeBool(m_out, reflectable->getBool());
        break;
    case CppType::INT8:
    case CppType::INT16:
    case CppType::INT32:
    case CppType::INT64:
        JsonEncoder::encodeIntegral(m_out, reflectable->toInt());
        break;
    case CppType::UINT8:
    case CppType::UINT16:
    case CppType::UINT32:
    case CppType::UINT64:
        JsonEncoder::encodeIntegral(m_out, reflectable->toUInt());
        break;
    case CppType::FLOAT:
        JsonEncoder::encodeFloatingPoint(m_out, static_cast<double>(reflectable->getFloat()));
        break;
    case CppType::DOUBLE:
        JsonEncoder::encodeFloatingPoint(m_out, reflectable->getDouble());
        break;
    case CppType::BYTES:
        writeBytes(reflectable->getBytes());
        break;
    case CppType::STRING:
        JsonEncoder::encodeString(m_out, reflectable->getStringView());
        break;
    case CppType::BIT_BUFFER:
        writeBitBuffer(reflectable->getBitBuffer());
        break;
    case CppType::ENUM:
        if (m_enumerableFormat == EnumerableFormat::STRING)
        {
            writeStringifiedEnum(reflectable);
        }
        else if (TypeInfoUtil::isSigned(typeInfo.getUnderlyingType().getCppType()))
        {
            JsonEncoder::encodeIntegral(m_out, reflectable->toInt());
        }
        else
        {
            JsonEncoder::encodeIntegral(m_out, reflectable->toUInt());
        }
        break;
    case CppType::BITMASK:
        if (m_enumerableFormat == EnumerableFormat::STRING)
        {
            writeStringifiedBitmask(reflectable);
        }
        else
        {
            JsonEncoder::encodeIntegral(m_out, reflectable->toUInt());
        }
        break;
    default:
        throw CppRuntimeException("JsonWriter: Unexpected not-null value of type '")
                << typeInfo.getSchemaName() << "'!";
    }
 
    m_out.flush();
}
 
template <typename ALLOC>
void BasicJsonWriter<ALLOC>::writeBitBuffer(const BasicBitBuffer<ALLOC>& bitBuffer)
{
    beginObject();
    beginItem();
    writeKey("buffer"sv);
    beginArray();
    Span<const uint8_t> buffer = bitBuffer.getData();
    for (uint8_t element : buffer)
    {
        beginItem();
        JsonEncoder::encodeIntegral(m_out, element);
        endItem();
    }
    endArray();
    endItem();
    beginItem();
    writeKey("bitSize"sv);
    JsonEncoder::encodeIntegral(m_out, bitBuffer.getBitSize());
    endItem();
    endObject();
}
 
template <typename ALLOC>
void BasicJsonWriter<ALLOC>::writeBytes(Span<const uint8_t> value)
{
    beginObject();
    beginItem();
    writeKey("buffer"sv);
    beginArray();
    for (uint8_t byte : value)
    {
        beginItem();
        JsonEncoder::encodeIntegral(m_out, byte);
        endItem();
    }
    endArray();
    endItem();
    endObject();
}
 
template <typename ALLOC>
void BasicJsonWriter<ALLOC>::writeStringifiedEnum(const IBasicReflectableDataConstPtr<ALLOC>& reflectable)
{
    const auto& typeInfo = reflectable->getTypeInfo();
    const uint64_t enumValue = TypeInfoUtil::isSigned(typeInfo.getUnderlyingType().getCppType())
            ? static_cast<uint64_t>(reflectable->toInt())
            : reflectable->toUInt();
    for (const auto& itemInfo : typeInfo.getEnumItems())
    {
        if (itemInfo.value == enumValue)
        {
            // exact match
            JsonEncoder::encodeString(m_out, itemInfo.schemaName);
            return;
        }
    }
 
    // no match
    BasicString<RebindAlloc<ALLOC, char>> stringValue =
            TypeInfoUtil::isSigned(typeInfo.getUnderlyingType().getCppType())
            ? toString(reflectable->toInt(), get_allocator())
            : toString(reflectable->toUInt(), get_allocator());
    stringValue.append(" /* no match */");
    JsonEncoder::encodeString(m_out, stringValue);
}
 
template <typename ALLOC>
void BasicJsonWriter<ALLOC>::writeStringifiedBitmask(const IBasicReflectableDataConstPtr<ALLOC>& reflectable)
{
    BasicString<RebindAlloc<ALLOC, char>> stringValue(get_allocator());
    const auto& typeInfo = reflectable->getTypeInfo();
    const uint64_t bitmaskValue = reflectable->toUInt();
    uint64_t valueCheck = 0;
    for (const auto& itemInfo : typeInfo.getBitmaskValues())
    {
        if ((itemInfo.value != 0 && (bitmaskValue & itemInfo.value) == itemInfo.value) ||
                (itemInfo.value == 0 && bitmaskValue == 0))
        {
            valueCheck |= itemInfo.value;
            if (!stringValue.empty())
            {
                stringValue += " | ";
            }
            stringValue += toString(itemInfo.schemaName, get_allocator());
        }
    }
 
    if (stringValue.empty())
    {
        // no match
        stringValue.append(toString(bitmaskValue, get_allocator()));
        stringValue.append(" /* no match */");
    }
    else if (bitmaskValue != valueCheck)
    {
        // partial match
        stringValue =
                toString(bitmaskValue, get_allocator())
                        .append(" /* partial match: ")
                        .append(stringValue)
                        .append(" */");
    }
    // else exact match
 
    JsonEncoder::encodeString(m_out, stringValue);
}
 
} // namespace zserio
 
#endif // ZSERIO_JSON_WRITER_H_INC