Skip to content

Commit

Permalink
Implement MsgPackBinary using raw strings and converters
Browse files Browse the repository at this point in the history
  • Loading branch information
@bblanchon
bblanchon committed May 1, 2024
1 parent ece4d03 commit 5fbd229
Show file tree
Hide file tree
Showing 13 changed files with 132 additions and 134 deletions.
14 changes: 13 additions & 1 deletion extras/tests/JsonVariant/as.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ TEST_CASE("JsonVariant::as()") {
REQUIRE(0 == variant.as<const char*>());
REQUIRE("null" == variant.as<std::string>());
REQUIRE(variant.as<JsonString>().isNull());
REQUIRE(variant.as<MsgPackBinary>().data() == nullptr);
}

SECTION("set(4.2)") {
Expand All @@ -36,6 +37,7 @@ TEST_CASE("JsonVariant::as()") {
REQUIRE(variant.as<long>() == 4L);
REQUIRE(variant.as<unsigned>() == 4U);
REQUIRE(variant.as<JsonString>().isNull());
REQUIRE(variant.as<MsgPackBinary>().data() == nullptr);
}

SECTION("set(0.0)") {
Expand All @@ -44,6 +46,7 @@ TEST_CASE("JsonVariant::as()") {
REQUIRE(variant.as<bool>() == false);
REQUIRE(variant.as<long>() == 0L);
REQUIRE(variant.as<JsonString>().isNull());
REQUIRE(variant.as<MsgPackBinary>().data() == nullptr);
}

SECTION("set(false)") {
Expand All @@ -54,6 +57,7 @@ TEST_CASE("JsonVariant::as()") {
REQUIRE(variant.as<long>() == 0L);
REQUIRE(variant.as<std::string>() == "false");
REQUIRE(variant.as<JsonString>().isNull());
REQUIRE(variant.as<MsgPackBinary>().data() == nullptr);
}

SECTION("set(true)") {
Expand All @@ -64,6 +68,7 @@ TEST_CASE("JsonVariant::as()") {
REQUIRE(variant.as<long>() == 1L);
REQUIRE(variant.as<std::string>() == "true");
REQUIRE(variant.as<JsonString>().isNull());
REQUIRE(variant.as<MsgPackBinary>().data() == nullptr);
}

SECTION("set(42)") {
Expand All @@ -75,6 +80,7 @@ TEST_CASE("JsonVariant::as()") {
REQUIRE(variant.as<unsigned int>() == 42U); // issue #1601
REQUIRE(variant.as<std::string>() == "42");
REQUIRE(variant.as<JsonString>().isNull());
REQUIRE(variant.as<MsgPackBinary>().data() == nullptr);
}

SECTION("set(42L)") {
Expand Down Expand Up @@ -245,7 +251,7 @@ TEST_CASE("JsonVariant::as()") {
REQUIRE(variant.as<long long>() == -9223372036854775807 - 1);
}

SECTION("Biggerst int64 positive") {
SECTION("Biggest int64 positive") {
variant.set("9223372036854775807");
REQUIRE(variant.as<long long>() == 9223372036854775807);
}
Expand All @@ -256,4 +262,10 @@ TEST_CASE("JsonVariant::as()") {

REQUIRE(variant.as<MY_ENUM>() == ONE);
}

SECTION("SerializedValue as MsgPackBinary") {
variant.set(serialized("hello"));

REQUIRE(variant.as<MsgPackBinary>().data() == nullptr);
}
}
16 changes: 8 additions & 8 deletions extras/tests/MixedConfiguration/string_length_size_1.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,16 +21,16 @@ TEST_CASE("ARDUINOJSON_STRING_LENGTH_SIZE == 1") {
REQUIRE(doc.overflowed() == true);
}

SECTION("set() returns true if binary has 255 characters") {
auto str = std::string(255, '?');
SECTION("set() returns true if binary has 253 characters") {
auto str = std::string(253, '?');
auto result = doc.set(MsgPackBinary(str.data(), str.size()));

REQUIRE(result == true);
REQUIRE(doc.overflowed() == false);
}

SECTION("set() returns false if binary has 256 characters") {
auto str = std::string(256, '?');
SECTION("set() returns false if binary has 254 characters") {
auto str = std::string(254, '?');
auto result = doc.set(MsgPackBinary(str.data(), str.size()));

REQUIRE(result == false);
Expand Down Expand Up @@ -70,17 +70,17 @@ TEST_CASE("ARDUINOJSON_STRING_LENGTH_SIZE == 1") {
REQUIRE(err == DeserializationError::NoMemory);
}

SECTION("deserializeMsgPack() returns Ok if binary has 255 characters") {
auto input = "\xc4\xff" + std::string(255, '?');
SECTION("deserializeMsgPack() returns Ok if binary has 253 characters") {
auto input = "\xc4\xfd" + std::string(253, '?');

auto err = deserializeMsgPack(doc, input);

REQUIRE(err == DeserializationError::Ok);
}

SECTION(
"deserializeMsgPack() returns NoMemory if binary has 256 characters") {
auto input = std::string("\xc5\x01\x00", 3) + std::string(256, '?');
"deserializeMsgPack() returns NoMemory if binary has 254 characters") {
auto input = "\xc4\xfe" + std::string(254, '?');

auto err = deserializeMsgPack(doc, input);

Expand Down
17 changes: 8 additions & 9 deletions extras/tests/MixedConfiguration/string_length_size_2.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,16 +21,16 @@ TEST_CASE("ARDUINOJSON_STRING_LENGTH_SIZE == 2") {
REQUIRE(doc.overflowed() == true);
}

SECTION("set() returns true if string has 65535 characters") {
auto str = std::string(65535, '?');
SECTION("set() returns true if string has 65532 characters") {
auto str = std::string(65532, '?');
auto result = doc.set(MsgPackBinary(str.data(), str.size()));

REQUIRE(result == true);
REQUIRE(doc.overflowed() == false);
}

SECTION("set() returns false if string has 65536 characters") {
auto str = std::string(65536, '?');
SECTION("set() returns false if string has 65533 characters") {
auto str = std::string(65533, '?');
auto result = doc.set(MsgPackBinary(str.data(), str.size()));

REQUIRE(result == false);
Expand Down Expand Up @@ -71,18 +71,17 @@ TEST_CASE("ARDUINOJSON_STRING_LENGTH_SIZE == 2") {
REQUIRE(err == DeserializationError::NoMemory);
}

SECTION("deserializeMsgPack() returns Ok if binary has 65535 characters") {
auto input = "\xc5\xff\xff" + std::string(65535, '?');
SECTION("deserializeMsgPack() returns Ok if binary has 65532 characters") {
auto input = "\xc5\xff\xfc" + std::string(65532, '?');

auto err = deserializeMsgPack(doc, input);

REQUIRE(err == DeserializationError::Ok);
}

SECTION(
"deserializeMsgPack() returns NoMemory of binary has 65536 characters") {
auto input =
std::string("\xc6\x00\x01\x00\x00", 5) + std::string(65536, '?');
"deserializeMsgPack() returns NoMemory of binary has 65534 characters") {
auto input = "\xc5\xff\xfd" + std::string(65534, '?');

auto err = deserializeMsgPack(doc, input);

Expand Down
12 changes: 0 additions & 12 deletions extras/tests/MsgPackDeserializer/errors.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -190,18 +190,6 @@ static std::string msgPackToJson(const char* input, size_t inputSize) {
}

TEST_CASE("deserializeMsgPack() replaces unsupported types by null") {
SECTION("bin 8") {
REQUIRE(msgPackToJson("\x92\xc4\x01X\x2A", 5) == "[null,42]");
}

SECTION("bin 16") {
REQUIRE(msgPackToJson("\x92\xc5\x00\x01X\x2A", 6) == "[null,42]");
}

SECTION("bin 32") {
REQUIRE(msgPackToJson("\x92\xc6\x00\x00\x00\x01X\x2A", 8) == "[null,42]");
}

SECTION("ext 8") {
REQUIRE(msgPackToJson("\x92\xc7\x01\x01\x01\x2A", 6) == "[null,42]");
}
Expand Down
1 change: 1 addition & 0 deletions src/ArduinoJson.hpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@
#include "ArduinoJson/Json/JsonDeserializer.hpp"
#include "ArduinoJson/Json/JsonSerializer.hpp"
#include "ArduinoJson/Json/PrettyJsonSerializer.hpp"
#include "ArduinoJson/MsgPack/MsgPackBinary.hpp"
#include "ArduinoJson/MsgPack/MsgPackDeserializer.hpp"
#include "ArduinoJson/MsgPack/MsgPackSerializer.hpp"

Expand Down
4 changes: 0 additions & 4 deletions src/ArduinoJson/Json/JsonSerializer.hpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -81,10 +81,6 @@ class JsonSerializer : public VariantDataVisitor<size_t> {
return bytesWritten();
}

size_t visit(MsgPackBinary) {
return visit(nullptr);
}

size_t visit(JsonInteger value) {
formatter_.writeInteger(value);
return bytesWritten();
Expand Down
72 changes: 72 additions & 0 deletions src/ArduinoJson/MsgPack/MsgPackBinary.hpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,76 @@ class MsgPackBinary {
size_t size_;
};

template <>
struct Converter<MsgPackBinary> : private detail::VariantAttorney {
static void toJson(MsgPackBinary src, JsonVariant dst) {
auto data = VariantAttorney::getData(dst);
if (!data)
return;
auto resources = getResourceManager(dst);
if (src.data()) {
size_t headerSize = src.size() >= 0x10000 ? 5
: src.size() >= 0x100 ? 3
: 2;
auto str = resources->createString(src.size() + headerSize);
if (str) {
resources->saveString(str);
auto ptr = reinterpret_cast<uint8_t*>(str->data);
switch (headerSize) {
case 2:
ptr[0] = uint8_t(0xc4);
ptr[1] = uint8_t(src.size() & 0xff);
break;
case 3:
ptr[0] = uint8_t(0xc5);
ptr[1] = uint8_t(src.size() >> 8 & 0xff);
ptr[2] = uint8_t(src.size() & 0xff);
break;
case 5:
ptr[0] = uint8_t(0xc6);
ptr[1] = uint8_t(src.size() >> 24 & 0xff);
ptr[2] = uint8_t(src.size() >> 16 & 0xff);
ptr[3] = uint8_t(src.size() >> 8 & 0xff);
ptr[4] = uint8_t(src.size() & 0xff);
break;
default:
ARDUINOJSON_ASSERT(false);
}
memcpy(ptr + headerSize, src.data(), src.size());
data->setRawString(str);
return;
}
}
data->setNull();
}

static MsgPackBinary fromJson(JsonVariantConst src) {
auto data = getData(src);
if (!data)
return {};
auto rawstr = data->asRawString();
auto p = reinterpret_cast<const uint8_t*>(rawstr.c_str());
auto n = rawstr.size();
if (n >= 2 && p[0] == 0xc4) { // bin 8
size_t size = p[1];
if (size + 2 == n)
return MsgPackBinary(p + 2, size);
} else if (n >= 3 && p[0] == 0xc5) { // bin 16
size_t size = size_t(p[1] << 8) | p[2];
if (size + 3 == n)
return MsgPackBinary(p + 3, size);
} else if (n >= 5 && p[0] == 0xc6) { // bin 32
size_t size =
size_t(p[1] << 24) | size_t(p[2] << 16) | size_t(p[3] << 8) | p[4];
if (size + 5 == n)
return MsgPackBinary(p + 5, size);
}
return {};
}

static bool checkJson(JsonVariantConst src) {
return fromJson(src).data() != nullptr;
}
};

ARDUINOJSON_END_PUBLIC_NAMESPACE
34 changes: 30 additions & 4 deletions src/ArduinoJson/MsgPack/MsgPackDeserializer.hpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -418,11 +418,37 @@ class MsgPackDeserializer {
DeserializationError::Code readBinary(VariantData* variant, size_t n) {
DeserializationError::Code err;

err = readString(n);
if (err)
return err;
stringBuilder_.startString();

if (n <= 0xFF) {
stringBuilder_.append('\xc4');
stringBuilder_.append(char(n & 0xFF));
} else if (n <= 0xFFFF) {
stringBuilder_.append('\xc5');
stringBuilder_.append(char(n >> 8 & 0xFF));
stringBuilder_.append(char(n & 0xFF));
} else if (n <= 0xFFFFFFFF) {
stringBuilder_.append('\xc6');
stringBuilder_.append(char(n >> 24 & 0xFF));
stringBuilder_.append(char(n >> 16 & 0xFF));
stringBuilder_.append(char(n >> 8 & 0xFF));
stringBuilder_.append(char(n & 0xFF));
}

for (; n; --n) {
uint8_t c;

err = readBytes(c);
if (err)
return err;

stringBuilder_.append(static_cast<char>(c));
}

if (!stringBuilder_.isValid())
return DeserializationError::NoMemory;

variant->setBinary(stringBuilder_.save());
variant->setRawString(stringBuilder_.save());
return DeserializationError::Ok;
}

Expand Down
15 changes: 0 additions & 15 deletions src/ArduinoJson/MsgPack/MsgPackSerializer.hpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -123,21 +123,6 @@ class MsgPackSerializer : public VariantDataVisitor<size_t> {
return bytesWritten();
}

size_t visit(MsgPackBinary value) {
if (value.size() <= 0xFF) {
writeByte(0xC4);
writeInteger(uint8_t(value.size()));
} else if (value.size() <= 0xFFFF) {
writeByte(0xC5);
writeInteger(uint16_t(value.size()));
} else {
writeByte(0xC6);
writeInteger(uint32_t(value.size()));
}
writeBytes(reinterpret_cast<const uint8_t*>(value.data()), value.size());
return bytesWritten();
}

size_t visit(JsonInteger value) {
if (value > 0) {
visit(static_cast<JsonUInt>(value));
Expand Down
15 changes: 0 additions & 15 deletions src/ArduinoJson/Variant/ConverterImpl.hpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -192,21 +192,6 @@ struct Converter<SerializedValue<T>> : private detail::VariantAttorney {
}
};

template <>
struct Converter<MsgPackBinary> : private detail::VariantAttorney {
static void toJson(MsgPackBinary src, JsonVariant dst) {
detail::VariantData::setBinary(getData(dst), src, getResourceManager(dst));
}
static MsgPackBinary fromJson(JsonVariantConst src) {
auto data = getData(src);
return data ? data->asBinary() : MsgPackBinary();
}
static bool checkJson(JsonVariantConst src) {
auto data = getData(src);
return data && data->isBinary();
}
};

template <>
struct Converter<detail::nullptr_t> : private detail::VariantAttorney {
static void toJson(detail::nullptr_t, JsonVariant dst) {
Expand Down
24 changes: 0 additions & 24 deletions src/ArduinoJson/Variant/VariantCompare.hpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -134,25 +134,6 @@ struct RawComparer : ComparerBase {
using ComparerBase::visit;
};

struct MsgPackBinaryComparer : ComparerBase {
MsgPackBinary rhs_;

explicit MsgPackBinaryComparer(MsgPackBinary rhs) : rhs_(rhs) {}

CompareResult visit(MsgPackBinary lhs) {
size_t size = rhs_.size() < lhs.size() ? rhs_.size() : lhs.size();
int n = memcmp(lhs.data(), rhs_.data(), size);
if (n < 0)
return COMPARE_RESULT_LESS;
else if (n > 0)
return COMPARE_RESULT_GREATER;
else
return COMPARE_RESULT_EQUAL;
}

using ComparerBase::visit;
};

struct VariantComparer : ComparerBase {
JsonVariantConst rhs;

Expand Down Expand Up @@ -183,11 +164,6 @@ struct VariantComparer : ComparerBase {
return reverseResult(comparer);
}

CompareResult visit(MsgPackBinary value) {
MsgPackBinaryComparer comparer(value);
return reverseResult(comparer);
}

CompareResult visit(JsonInteger lhs) {
Comparer<JsonInteger> comparer(lhs);
return reverseResult(comparer);
Expand Down

0 comments on commit 5fbd229

Please sign in to comment.