🚧 begin BON8 implementation

This commit is contained in:
Niels Lohmann 2021-08-31 15:04:06 +02:00
parent fd0aa4fb0d
commit f656f535e1
No known key found for this signature in database
GPG Key ID: 7F3CEA63AE251B69
5 changed files with 739 additions and 14 deletions

View File

@ -23,7 +23,7 @@ namespace nlohmann
namespace detail
{
/// the supported input formats
enum class input_format_t { json, cbor, msgpack, ubjson, bson };
enum class input_format_t { json, cbor, msgpack, ubjson, bson, bon8 };
////////////////////
// input adapters //

View File

@ -923,6 +923,158 @@ class binary_writer
}
}
/*!
@param[in] j JSON value to serialize
*/
void write_bon8(const BasicJsonType& j)
{
switch (j.type())
{
case value_t::null:
{
oa->write_character(to_char_type(0xFA));
break;
}
case value_t::boolean:
{
oa->write_character(j.m_value.boolean
? to_char_type(0xF9)
: to_char_type(0xF8));
break;
}
case value_t::number_float:
{
// special values
if (j.m_value.number_float == -1.0)
{
oa->write_character(to_char_type(0xFB));
break;
}
if (j.m_value.number_float == 0.0)
{
oa->write_character(to_char_type(0xFC));
break;
}
if (j.m_value.number_float == 1.0)
{
oa->write_character(to_char_type(0xFD));
break;
}
// write float with prefix
write_compact_float(j.m_value.number_float, detail::input_format_t::bon8);
break;
}
case value_t::string:
{
// empty string: use end-of-text symbol
if (j.m_value.string->empty())
{
oa->write_character(to_char_type(0xFF));
break;
}
// write strings as is
oa->write_characters(
reinterpret_cast<const CharType*>(j.m_value.string->c_str()),
j.m_value.string->size());
break;
}
case value_t::array:
{
const auto N = j.m_value.array->size();
if (N <= 4)
{
// start array with count (80..84)
oa->write_character(to_char_type(0x80 + N));
}
else
{
// start array
oa->write_character(to_char_type(0x85));
}
// write each element
for (std::size_t i = 0; i < N; ++i)
{
const auto& el = j.m_value.array->operator[](i);
// check if 0xFF after nonempty string and string is required
if (i > 0)
{
const auto& prev = j.m_value.array->operator[](i - 1);
if (el.is_string() && prev.is_string() && !prev.m_value.string->empty())
{
oa->write_character(to_char_type(0xFF));
}
}
write_bon8(el);
}
if (N > 4)
{
// end of container
oa->write_character(to_char_type(0xFE));
}
break;
}
case value_t::object:
{
const auto N = j.m_value.object->size();
if (N <= 4)
{
// start object with count (86..8A)
oa->write_character(to_char_type(0x86 + N));
}
else
{
// start object
oa->write_character(to_char_type(0x8B));
}
// write each element
for (auto it = j.m_value.object->begin(); it != j.m_value.object->end(); ++it)
{
const auto& key = it->first;
const auto& value = it->second;
write_bon8(key);
// check if we need a 0xFF separator between key and value
if (!key.empty() && value.is_string())
{
oa->write_character(to_char_type(0xFF));
}
write_bon8(value);
// check if we need a 0xFF separator between the value and the next key
if (value.is_string() && !value.m_value.string->empty() && std::next(it) != j.m_value.object->end())
{
oa->write_character(to_char_type(0xFF));
}
}
if (N > 4)
{
// end of container
oa->write_character(to_char_type(0xFE));
}
break;
}
case value_t::discarded:
default:
break;
}
}
private:
//////////
// BSON //
@ -1524,6 +1676,20 @@ class binary_writer
return 'D'; // float 64
}
//////////
// BON8 //
//////////
static constexpr CharType get_bon8_float_prefix(float /*unused*/)
{
return to_char_type(0x8E);
}
static constexpr CharType get_bon8_float_prefix(double /*unused*/)
{
return to_char_type(0x8F);
}
///////////////////////
// Utility functions //
///////////////////////
@ -1566,16 +1732,38 @@ class binary_writer
static_cast<double>(n) <= static_cast<double>((std::numeric_limits<float>::max)()) &&
static_cast<double>(static_cast<float>(n)) == static_cast<double>(n))
{
oa->write_character(format == detail::input_format_t::cbor
? get_cbor_float_prefix(static_cast<float>(n))
: get_msgpack_float_prefix(static_cast<float>(n)));
switch (format)
{
case input_format_t::cbor:
get_cbor_float_prefix(static_cast<float>(n));
break;
case input_format_t::msgpack:
get_msgpack_float_prefix(static_cast<float>(n));
break;
case input_format_t::bon8:
get_bon8_float_prefix(static_cast<float>(n));
break;
default:
break;
}
write_number(static_cast<float>(n));
}
else
{
oa->write_character(format == detail::input_format_t::cbor
? get_cbor_float_prefix(n)
: get_msgpack_float_prefix(n));
switch (format)
{
case input_format_t::cbor:
get_cbor_float_prefix(n);
break;
case input_format_t::msgpack:
get_msgpack_float_prefix(n);
break;
case input_format_t::bon8:
get_bon8_float_prefix(n);
break;
default:
break;
}
write_number(n);
}
#ifdef __GNUC__

View File

@ -7611,6 +7611,23 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
binary_writer<char>(o).write_bson(j);
}
static std::vector<std::uint8_t> to_bon8(const basic_json& j)
{
std::vector<std::uint8_t> result;
to_bon8(j, result);
return result;
}
static void to_bon8(const basic_json& j, detail::output_adapter<std::uint8_t> o)
{
binary_writer<std::uint8_t>(o).write_bon8(j);
}
static void to_bon8(const basic_json& j, detail::output_adapter<char> o)
{
binary_writer<char>(o).write_bon8(j);
}
/*!
@brief create a JSON value from an input in CBOR format

View File

@ -5354,7 +5354,7 @@ namespace nlohmann
namespace detail
{
/// the supported input formats
enum class input_format_t { json, cbor, msgpack, ubjson, bson };
enum class input_format_t { json, cbor, msgpack, ubjson, bson, bon8 };
////////////////////
// input adapters //
@ -14495,6 +14495,158 @@ class binary_writer
}
}
/*!
@param[in] j JSON value to serialize
*/
void write_bon8(const BasicJsonType& j)
{
switch (j.type())
{
case value_t::null:
{
oa->write_character(to_char_type(0xFA));
break;
}
case value_t::boolean:
{
oa->write_character(j.m_value.boolean
? to_char_type(0xF9)
: to_char_type(0xF8));
break;
}
case value_t::number_float:
{
// special values
if (j.m_value.number_float == -1.0)
{
oa->write_character(to_char_type(0xFB));
break;
}
if (j.m_value.number_float == 0.0)
{
oa->write_character(to_char_type(0xFC));
break;
}
if (j.m_value.number_float == 1.0)
{
oa->write_character(to_char_type(0xFD));
break;
}
// write float with prefix
write_compact_float(j.m_value.number_float, detail::input_format_t::bon8);
break;
}
case value_t::string:
{
// empty string: use end-of-text symbol
if (j.m_value.string->empty())
{
oa->write_character(to_char_type(0xFF));
break;
}
// write strings as is
oa->write_characters(
reinterpret_cast<const CharType*>(j.m_value.string->c_str()),
j.m_value.string->size());
break;
}
case value_t::array:
{
const auto N = j.m_value.array->size();
if (N <= 4)
{
// start array with count (80..84)
oa->write_character(to_char_type(0x80 + N));
}
else
{
// start array
oa->write_character(to_char_type(0x85));
}
// write each element
for (std::size_t i = 0; i < N; ++i)
{
const auto& el = j.m_value.array->operator[](i);
// check if 0xFF after nonempty string and string is required
if (i > 0)
{
const auto& prev = j.m_value.array->operator[](i - 1);
if (el.is_string() && prev.is_string() && !prev.m_value.string->empty())
{
oa->write_character(to_char_type(0xFF));
}
}
write_bon8(el);
}
if (N > 4)
{
// end of container
oa->write_character(to_char_type(0xFE));
}
break;
}
case value_t::object:
{
const auto N = j.m_value.object->size();
if (N <= 4)
{
// start object with count (86..8A)
oa->write_character(to_char_type(0x86 + N));
}
else
{
// start object
oa->write_character(to_char_type(0x8B));
}
// write each element
for (auto it = j.m_value.object->begin(); it != j.m_value.object->end(); ++it)
{
const auto& key = it->first;
const auto& value = it->second;
write_bon8(key);
// check if we need a 0xFF separator between key and value
if (!key.empty() && value.is_string())
{
oa->write_character(to_char_type(0xFF));
}
write_bon8(value);
// check if we need a 0xFF separator between the value and the next key
if (value.is_string() && !value.m_value.string->empty() && std::next(it) != j.m_value.object->end())
{
oa->write_character(to_char_type(0xFF));
}
}
if (N > 4)
{
// end of container
oa->write_character(to_char_type(0xFE));
}
break;
}
case value_t::discarded:
default:
break;
}
}
private:
//////////
// BSON //
@ -15096,6 +15248,20 @@ class binary_writer
return 'D'; // float 64
}
//////////
// BON8 //
//////////
static constexpr CharType get_bon8_float_prefix(float /*unused*/)
{
return to_char_type(0x8E);
}
static constexpr CharType get_bon8_float_prefix(double /*unused*/)
{
return to_char_type(0x8F);
}
///////////////////////
// Utility functions //
///////////////////////
@ -15138,16 +15304,38 @@ class binary_writer
static_cast<double>(n) <= static_cast<double>((std::numeric_limits<float>::max)()) &&
static_cast<double>(static_cast<float>(n)) == static_cast<double>(n))
{
oa->write_character(format == detail::input_format_t::cbor
? get_cbor_float_prefix(static_cast<float>(n))
: get_msgpack_float_prefix(static_cast<float>(n)));
switch (format)
{
case input_format_t::cbor:
get_cbor_float_prefix(static_cast<float>(n));
break;
case input_format_t::msgpack:
get_msgpack_float_prefix(static_cast<float>(n));
break;
case input_format_t::bon8:
get_bon8_float_prefix(static_cast<float>(n));
break;
default:
break;
}
write_number(static_cast<float>(n));
}
else
{
oa->write_character(format == detail::input_format_t::cbor
? get_cbor_float_prefix(n)
: get_msgpack_float_prefix(n));
switch (format)
{
case input_format_t::cbor:
get_cbor_float_prefix(n);
break;
case input_format_t::msgpack:
get_msgpack_float_prefix(n);
break;
case input_format_t::bon8:
get_bon8_float_prefix(n);
break;
default:
break;
}
write_number(n);
}
#ifdef __GNUC__
@ -25016,6 +25204,23 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
binary_writer<char>(o).write_bson(j);
}
static std::vector<std::uint8_t> to_bon8(const basic_json& j)
{
std::vector<std::uint8_t> result;
to_bon8(j, result);
return result;
}
static void to_bon8(const basic_json& j, detail::output_adapter<std::uint8_t> o)
{
binary_writer<std::uint8_t>(o).write_bon8(j);
}
static void to_bon8(const basic_json& j, detail::output_adapter<char> o)
{
binary_writer<char>(o).write_bon8(j);
}
/*!
@brief create a JSON value from an input in CBOR format

315
test/src/unit-bon8.cpp Normal file
View File

@ -0,0 +1,315 @@
/*
__ _____ _____ _____
__| | __| | | | JSON for Modern C++ (test suite)
| | |__ | | | | | | version 3.10.2
|_____|_____|_____|_|___| https://github.com/nlohmann/json
Licensed under the MIT License <http://opensource.org/licenses/MIT>.
SPDX-License-Identifier: MIT
Copyright (c) 2013-2019 Niels Lohmann <http://nlohmann.me>.
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
*/
#include "doctest_compatibility.h"
#include <nlohmann/json.hpp>
using nlohmann::json;
#include <iostream>
#include <fstream>
#include <set>
#include <test_data.hpp>
#include "test_utils.hpp"
namespace
{
class SaxCountdown
{
public:
explicit SaxCountdown(const int count) : events_left(count)
{}
bool null()
{
return events_left-- > 0;
}
bool boolean(bool /*unused*/)
{
return events_left-- > 0;
}
bool number_integer(json::number_integer_t /*unused*/)
{
return events_left-- > 0;
}
bool number_unsigned(json::number_unsigned_t /*unused*/)
{
return events_left-- > 0;
}
bool number_float(json::number_float_t /*unused*/, const std::string& /*unused*/)
{
return events_left-- > 0;
}
bool string(std::string& /*unused*/)
{
return events_left-- > 0;
}
bool binary(std::vector<std::uint8_t>& /*unused*/)
{
return events_left-- > 0;
}
bool start_object(std::size_t /*unused*/)
{
return events_left-- > 0;
}
bool key(std::string& /*unused*/)
{
return events_left-- > 0;
}
bool end_object()
{
return events_left-- > 0;
}
bool start_array(std::size_t /*unused*/)
{
return events_left-- > 0;
}
bool end_array()
{
return events_left-- > 0;
}
bool parse_error(std::size_t /*unused*/, const std::string& /*unused*/, const json::exception& /*unused*/) // NOLINT(readability-convert-member-functions-to-static)
{
return false;
}
private:
int events_left = 0;
};
} // namespace
TEST_CASE("BON8")
{
SECTION("individual values")
{
SECTION("discarded")
{
// discarded values are not serialized
json j = json::value_t::discarded;
const auto result = json::to_bon8(j);
CHECK(result.empty());
}
SECTION("null")
{
json j = nullptr;
std::vector<uint8_t> expected = {0xFA};
const auto result = json::to_bon8(j);
CHECK(result == expected);
}
SECTION("boolean")
{
SECTION("true")
{
json j = true;
std::vector<uint8_t> expected = {0xF9};
const auto result = json::to_bon8(j);
CHECK(result == expected);
}
SECTION("false")
{
json j = false;
std::vector<uint8_t> expected = {0xF8};
const auto result = json::to_bon8(j);
CHECK(result == expected);
}
}
SECTION("floating-point numbers")
{
SECTION("-1.0")
{
json j = -1.0;
std::vector<uint8_t> expected = {0xFB};
const auto result = json::to_bon8(j);
CHECK(result == expected);
}
SECTION("0.0")
{
json j = 0.0;
std::vector<uint8_t> expected = {0xFC};
const auto result = json::to_bon8(j);
CHECK(result == expected);
}
SECTION("1.0")
{
json j = 1.0;
std::vector<uint8_t> expected = {0xFD};
const auto result = json::to_bon8(j);
CHECK(result == expected);
}
}
SECTION("string")
{
SECTION("empty string")
{
json j = "";
std::vector<uint8_t> expected = {0xFF};
const auto result = json::to_bon8(j);
CHECK(result == expected);
}
SECTION("other strings")
{
json j = "This is a string.";
std::vector<uint8_t> expected = {'T', 'h', 'i', 's', ' ', 'i', 's', ' ', 'a', ' ', 's', 't', 'r', 'i', 'n', 'g', '.'};
const auto result = json::to_bon8(j);
CHECK(result == expected);
}
}
SECTION("array")
{
SECTION("array with count")
{
SECTION("empty array")
{
json j = json::array();
std::vector<uint8_t> expected = {0x80};
const auto result = json::to_bon8(j);
CHECK(result == expected);
}
SECTION("[false]")
{
json j = {false};
std::vector<uint8_t> expected = {0x81, 0xF8};
const auto result = json::to_bon8(j);
CHECK(result == expected);
}
SECTION("[false, null]")
{
json j = {false, nullptr};
std::vector<uint8_t> expected = {0x82, 0xF8, 0xFA};
const auto result = json::to_bon8(j);
CHECK(result == expected);
}
SECTION("[false, null, true]")
{
json j = {false, nullptr, true};
std::vector<uint8_t> expected = {0x83, 0xF8, 0xFA, 0xF9};
const auto result = json::to_bon8(j);
CHECK(result == expected);
}
SECTION("[false, null, true, 1.0]")
{
json j = {false, nullptr, true, 1.0};
std::vector<uint8_t> expected = {0x84, 0xF8, 0xFA, 0xF9, 0xFD};
const auto result = json::to_bon8(j);
CHECK(result == expected);
}
SECTION("[\"s\", \"s\"]")
{
json j = {"s", "s"};
std::vector<uint8_t> expected = {0x82, 's', 0xFF, 's'};
const auto result = json::to_bon8(j);
CHECK(result == expected);
}
SECTION("[\"\", \"s\"]")
{
json j = {"", "s"};
std::vector<uint8_t> expected = {0x82, 0xFF, 's'};
const auto result = json::to_bon8(j);
CHECK(result == expected);
}
}
SECTION("array without count")
{
SECTION("[false, null, true, 1.0, [], 0.0]")
{
json j = {false, nullptr, true, 1.0, json::array(), 0.0};
std::vector<uint8_t> expected = {0x85, 0xF8, 0xFA, 0xF9, 0xFD, 0x80, 0xFC, 0xFE};
const auto result = json::to_bon8(j);
CHECK(result == expected);
}
}
}
SECTION("object")
{
SECTION("object with count")
{
SECTION("empty object")
{
json j = json::object();
std::vector<uint8_t> expected = {0x86};
const auto result = json::to_bon8(j);
CHECK(result == expected);
}
SECTION("{\"foo\": null}")
{
json j = {{"foo", nullptr}};
std::vector<uint8_t> expected = {0x87, 'f', 'o', 'o', 0xFA};
const auto result = json::to_bon8(j);
CHECK(result == expected);
}
SECTION("{\"\": true, \"foo\": null}")
{
json j = {{"", true}, {"foo", nullptr}};
std::vector<uint8_t> expected = {0x88, 0xFF, 0xF9, 'f', 'o', 'o', 0xFA};
const auto result = json::to_bon8(j);
CHECK(result == expected);
}
SECTION("{\"a\": \"\", \"c\": \"d\"}")
{
json j = {{"a", ""}, {"c", "d"}};
std::vector<uint8_t> expected = {0x88, 'a', 0xFF, 0xFF, 'c', 0xFF, 'd'};
const auto result = json::to_bon8(j);
CHECK(result == expected);
}
}
}
}
}