From 0f529a3587cc70353f514b311131b1a5ea9cffe3 Mon Sep 17 00:00:00 2001 From: Benoit Blanchon Date: Thu, 16 Dec 2021 14:55:26 +0100 Subject: [PATCH] Renamed undocumented function `isUndefined()` to `isUnbound()` --- CHANGELOG.md | 2 ++ extras/tests/JsonArray/CMakeLists.txt | 2 +- .../tests/JsonArray/{undefined.cpp => unbound.cpp} | 2 +- extras/tests/JsonVariant/CMakeLists.txt | 2 +- extras/tests/JsonVariant/copy.cpp | 2 +- extras/tests/JsonVariant/is.cpp | 4 ++-- extras/tests/JsonVariant/or.cpp | 12 ++++++------ extras/tests/JsonVariant/subscript.cpp | 4 ++-- .../tests/JsonVariant/{undefined.cpp => unbound.cpp} | 2 +- extras/tests/MsgPackSerializer/serializeVariant.cpp | 2 +- src/ArduinoJson/Document/JsonDocument.hpp | 4 ++-- src/ArduinoJson/Object/ObjectImpl.hpp | 4 ++-- src/ArduinoJson/Object/ObjectRef.hpp | 4 ++-- src/ArduinoJson/Variant/VariantOperators.hpp | 2 +- src/ArduinoJson/Variant/VariantRef.hpp | 2 +- 15 files changed, 26 insertions(+), 24 deletions(-) rename extras/tests/JsonArray/{undefined.cpp => unbound.cpp} (95%) rename extras/tests/JsonVariant/{undefined.cpp => unbound.cpp} (98%) diff --git a/CHANGELOG.md b/CHANGELOG.md index e306634d..63d2558e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -12,11 +12,13 @@ HEAD * Add safe bool idiom in `JsonString` * Add support for NUL in string values (issue #1646) * Remove `DeserializationError == bool` and `DeserializationError != bool` +* Renamed undocumented function `isUndefined()` to `isUnbound()` * Fix `JsonVariant::memoryUsage()` for raw strings * Fix `call of overloaded 'swap(BasicJsonDocument&, BasicJsonDocument&)' is ambiguous` (issue #1678) * Fix inconsistent pool capacity between `BasicJsonDocument`'s copy and move constructors * Fix inconsistent pool capacity between `BasicJsonDocument`'s copy and move assignments * Fix return type of `StaticJsonDocument::operator=` +* Avoid pool reallocation in `BasicJsonDocument`'s copy assignment if capacity is the same v6.18.5 (2021-09-28) ------- diff --git a/extras/tests/JsonArray/CMakeLists.txt b/extras/tests/JsonArray/CMakeLists.txt index e0052a9a..3544f246 100644 --- a/extras/tests/JsonArray/CMakeLists.txt +++ b/extras/tests/JsonArray/CMakeLists.txt @@ -17,7 +17,7 @@ add_executable(JsonArrayTests size.cpp std_string.cpp subscript.cpp - undefined.cpp + unbound.cpp ) add_test(JsonArray JsonArrayTests) diff --git a/extras/tests/JsonArray/undefined.cpp b/extras/tests/JsonArray/unbound.cpp similarity index 95% rename from extras/tests/JsonArray/undefined.cpp rename to extras/tests/JsonArray/unbound.cpp index f33cc192..8a5ac942 100644 --- a/extras/tests/JsonArray/undefined.cpp +++ b/extras/tests/JsonArray/unbound.cpp @@ -7,7 +7,7 @@ using namespace Catch::Matchers; -TEST_CASE("Undefined JsonArray") { +TEST_CASE("Unbound JsonArray") { JsonArray array; SECTION("SubscriptFails") { diff --git a/extras/tests/JsonVariant/CMakeLists.txt b/extras/tests/JsonVariant/CMakeLists.txt index a06dc88f..5e0ad7ba 100644 --- a/extras/tests/JsonVariant/CMakeLists.txt +++ b/extras/tests/JsonVariant/CMakeLists.txt @@ -22,7 +22,7 @@ add_executable(JsonVariantTests set.cpp subscript.cpp types.cpp - undefined.cpp + unbound.cpp ) add_test(JsonVariant JsonVariantTests) diff --git a/extras/tests/JsonVariant/copy.cpp b/extras/tests/JsonVariant/copy.cpp index 75c1aeee..24309391 100644 --- a/extras/tests/JsonVariant/copy.cpp +++ b/extras/tests/JsonVariant/copy.cpp @@ -89,7 +89,7 @@ TEST_CASE("JsonVariant::set(JsonVariant)") { unboundVariant.set(var1); - REQUIRE(unboundVariant.isUndefined()); + REQUIRE(unboundVariant.isUnbound()); REQUIRE(unboundVariant.isNull()); } } diff --git a/extras/tests/JsonVariant/is.cpp b/extras/tests/JsonVariant/is.cpp index 4716c428..99cbf992 100644 --- a/extras/tests/JsonVariant/is.cpp +++ b/extras/tests/JsonVariant/is.cpp @@ -11,7 +11,7 @@ TEST_CASE("JsonVariant::is()") { DynamicJsonDocument doc(4096); JsonVariant variant = doc.to(); - SECTION("undefined") { + SECTION("unbound") { variant = JsonVariant(); CHECK(variant.is() == false); @@ -168,7 +168,7 @@ TEST_CASE("JsonVariantConst::is()") { JsonVariant variant = doc.to(); JsonVariantConst cvariant = variant; - SECTION("undefined") { + SECTION("unbound") { cvariant = JsonVariantConst(); CHECK(cvariant.is() == false); diff --git a/extras/tests/JsonVariant/or.cpp b/extras/tests/JsonVariant/or.cpp index 582c2d17..f8872b37 100644 --- a/extras/tests/JsonVariant/or.cpp +++ b/extras/tests/JsonVariant/or.cpp @@ -9,30 +9,30 @@ TEST_CASE("JsonVariant::operator|()") { DynamicJsonDocument doc(4096); JsonVariant variant = doc["value"].to(); - SECTION("undefined") { - SECTION("undefined | const char*") { + SECTION("null") { + SECTION("null | const char*") { std::string result = variant | "default"; REQUIRE(result == "default"); } - SECTION("undefined | int") { + SECTION("null | int") { int result = variant | 42; REQUIRE(result == 42); } - SECTION("undefined | bool") { + SECTION("null | bool") { bool result = variant | true; REQUIRE(result == true); } - SECTION("undefined | ElementProxy") { + SECTION("null | ElementProxy") { doc["array"][0] = 42; JsonVariantConst result = variant | doc["array"][0]; REQUIRE(result == 42); } - SECTION("undefined | MemberProxy") { + SECTION("null | MemberProxy") { doc["other"] = 42; JsonVariantConst result = variant | doc["other"]; diff --git a/extras/tests/JsonVariant/subscript.cpp b/extras/tests/JsonVariant/subscript.cpp index 91b6b78c..7e81a06a 100644 --- a/extras/tests/JsonVariant/subscript.cpp +++ b/extras/tests/JsonVariant/subscript.cpp @@ -9,7 +9,7 @@ TEST_CASE("JsonVariant::operator[]") { DynamicJsonDocument doc(4096); JsonVariant var = doc.to(); - SECTION("The JsonVariant is undefined") { + SECTION("The JsonVariant is null") { REQUIRE(0 == var.size()); REQUIRE(var["0"].isNull()); REQUIRE(var[0].isNull()); @@ -136,7 +136,7 @@ TEST_CASE("JsonVariantConst::operator[]") { JsonVariant var = doc.to(); JsonVariantConst cvar = var; - SECTION("The JsonVariant is undefined") { + SECTION("The JsonVariant is null") { REQUIRE(0 == cvar.size()); REQUIRE(cvar["0"].isNull()); REQUIRE(cvar[0].isNull()); diff --git a/extras/tests/JsonVariant/undefined.cpp b/extras/tests/JsonVariant/unbound.cpp similarity index 98% rename from extras/tests/JsonVariant/undefined.cpp rename to extras/tests/JsonVariant/unbound.cpp index ccf76762..73f90331 100644 --- a/extras/tests/JsonVariant/undefined.cpp +++ b/extras/tests/JsonVariant/unbound.cpp @@ -5,7 +5,7 @@ #include #include -TEST_CASE("JsonVariant undefined") { +TEST_CASE("Unbound JsonVariant") { JsonVariant variant; SECTION("as()") { diff --git a/extras/tests/MsgPackSerializer/serializeVariant.cpp b/extras/tests/MsgPackSerializer/serializeVariant.cpp index 9b61f533..22a4f98a 100644 --- a/extras/tests/MsgPackSerializer/serializeVariant.cpp +++ b/extras/tests/MsgPackSerializer/serializeVariant.cpp @@ -31,7 +31,7 @@ static void checkVariant(T value, const std::string& expected) { } TEST_CASE("serialize MsgPack value") { - SECTION("undefined") { + SECTION("unbound") { checkVariant(JsonVariant(), "\xC0"); // we represent undefined as nil } diff --git a/src/ArduinoJson/Document/JsonDocument.hpp b/src/ArduinoJson/Document/JsonDocument.hpp index 23ef9b66..19cd31c9 100644 --- a/src/ArduinoJson/Document/JsonDocument.hpp +++ b/src/ArduinoJson/Document/JsonDocument.hpp @@ -139,14 +139,14 @@ class JsonDocument : public Visitable { // containsKey(const __FlashStringHelper*) const template bool containsKey(TChar* key) const { - return !getMember(key).isUndefined(); + return !getMember(key).isUnbound(); } // containsKey(const std::string&) const // containsKey(const String&) const template bool containsKey(const TString& key) const { - return !getMember(key).isUndefined(); + return !getMember(key).isUnbound(); } // operator[](const std::string&) diff --git a/src/ArduinoJson/Object/ObjectImpl.hpp b/src/ArduinoJson/Object/ObjectImpl.hpp index d66b61ca..3dba862a 100644 --- a/src/ArduinoJson/Object/ObjectImpl.hpp +++ b/src/ArduinoJson/Object/ObjectImpl.hpp @@ -40,14 +40,14 @@ template template inline typename enable_if::value, bool>::type ObjectShortcuts::containsKey(const TString& key) const { - return !impl()->getMember(key).isUndefined(); + return !impl()->getMember(key).isUnbound(); } template template inline typename enable_if::value, bool>::type ObjectShortcuts::containsKey(TChar* key) const { - return !impl()->getMember(key).isUndefined(); + return !impl()->getMember(key).isUnbound(); } template diff --git a/src/ArduinoJson/Object/ObjectRef.hpp b/src/ArduinoJson/Object/ObjectRef.hpp index 8c0fd836..4390210d 100644 --- a/src/ArduinoJson/Object/ObjectRef.hpp +++ b/src/ArduinoJson/Object/ObjectRef.hpp @@ -77,7 +77,7 @@ class ObjectConstRef : public ObjectRefBase, // containsKey(const String&) const template FORCE_INLINE bool containsKey(const TString& key) const { - return !getMember(key).isUndefined(); + return !getMember(key).isUnbound(); } // containsKey(char*) const @@ -85,7 +85,7 @@ class ObjectConstRef : public ObjectRefBase, // containsKey(const __FlashStringHelper*) const template FORCE_INLINE bool containsKey(TChar* key) const { - return !getMember(key).isUndefined(); + return !getMember(key).isUnbound(); } // getMember(const std::string&) const diff --git a/src/ArduinoJson/Variant/VariantOperators.hpp b/src/ArduinoJson/Variant/VariantOperators.hpp index 54174a4c..2fe15418 100644 --- a/src/ArduinoJson/Variant/VariantOperators.hpp +++ b/src/ArduinoJson/Variant/VariantOperators.hpp @@ -17,7 +17,7 @@ CompareResult compare(const T1 &lhs, const T2 &rhs); // VariantCompare.cpp template struct VariantOperators { - // Returns the default value if the VariantRef is undefined or incompatible + // Returns the default value if the VariantRef is unbound or incompatible // // int operator|(JsonVariant, int) // float operator|(JsonVariant, float) diff --git a/src/ArduinoJson/Variant/VariantRef.hpp b/src/ArduinoJson/Variant/VariantRef.hpp index b05ed90c..a3188ad9 100644 --- a/src/ArduinoJson/Variant/VariantRef.hpp +++ b/src/ArduinoJson/Variant/VariantRef.hpp @@ -32,7 +32,7 @@ class VariantRefBase : public VariantTag { return variantIsNull(_data); } - FORCE_INLINE bool isUndefined() const { + FORCE_INLINE bool isUnbound() const { return !_data; }