From e33e78d202d03f45a63fb8d44fae25eef1ae8bd7 Mon Sep 17 00:00:00 2001 From: Benoit Blanchon Date: Tue, 26 Nov 2024 14:32:21 +0100 Subject: [PATCH] Rename undocumented `JsonString::isLinked()` to `isStatic()` --- CHANGELOG.md | 1 + extras/tests/JsonVariant/as.cpp | 4 ++-- extras/tests/Misc/JsonString.cpp | 4 ++-- extras/tests/Misc/StringAdapters.cpp | 22 +++++++++---------- .../Strings/Adapters/FlashString.hpp | 2 +- .../Strings/Adapters/RamString.hpp | 12 +++++----- src/ArduinoJson/Strings/JsonString.hpp | 4 ++-- src/ArduinoJson/Variant/VariantImpl.hpp | 2 +- 8 files changed, 26 insertions(+), 25 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index d50b7a4d..7bea7dd9 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -9,6 +9,7 @@ HEAD * Change string copy policy: only string literal are stored by pointer * `JsonString` is now stored by copy, unless specified otherwise * Replace undocumented `JsonString::Ownership` with `bool` +* Rename undocumented `JsonString::isLinked()` to `isStatic()` > ### BREAKING CHANGES > diff --git a/extras/tests/JsonVariant/as.cpp b/extras/tests/JsonVariant/as.cpp index 2c6f54b1..bfdea044 100644 --- a/extras/tests/JsonVariant/as.cpp +++ b/extras/tests/JsonVariant/as.cpp @@ -184,7 +184,7 @@ TEST_CASE("JsonVariant::as()") { REQUIRE(variant.as() == 42L); REQUIRE(variant.as() == "42"); - REQUIRE(variant.as().isLinked() == true); + REQUIRE(variant.as().isStatic() == true); } SECTION("set(\"hello\")") { @@ -207,7 +207,7 @@ TEST_CASE("JsonVariant::as()") { REQUIRE(variant.as() == "4.2"_s); REQUIRE(variant.as() == "4.2"_s); REQUIRE(variant.as() == "4.2"); - REQUIRE(variant.as().isLinked() == false); + REQUIRE(variant.as().isStatic() == false); } SECTION("set(\"true\")") { diff --git a/extras/tests/Misc/JsonString.cpp b/extras/tests/Misc/JsonString.cpp index 50f67558..3a33677f 100644 --- a/extras/tests/Misc/JsonString.cpp +++ b/extras/tests/Misc/JsonString.cpp @@ -13,7 +13,7 @@ TEST_CASE("JsonString") { CHECK(s.isNull() == true); CHECK(s.c_str() == 0); - CHECK(s.isLinked() == true); + CHECK(s.isStatic() == true); CHECK(s == JsonString()); CHECK(s != ""); } @@ -96,7 +96,7 @@ TEST_CASE("JsonString") { JsonString s("hello world", 5); CHECK(s.size() == 5); - CHECK(s.isLinked() == false); + CHECK(s.isStatic() == false); CHECK(s == "hello"); CHECK(s != "hello world"); } diff --git a/extras/tests/Misc/StringAdapters.cpp b/extras/tests/Misc/StringAdapters.cpp index 5e344a9a..71e458bc 100644 --- a/extras/tests/Misc/StringAdapters.cpp +++ b/extras/tests/Misc/StringAdapters.cpp @@ -22,7 +22,7 @@ TEST_CASE("adaptString()") { CHECK(s.isNull() == false); CHECK(s.size() == 11); - CHECK(s.isLinked() == true); + CHECK(s.isStatic() == true); } SECTION("null const char*") { @@ -38,7 +38,7 @@ TEST_CASE("adaptString()") { CHECK(s.isNull() == false); CHECK(s.size() == 5); - CHECK(s.isLinked() == false); + CHECK(s.isStatic() == false); CHECK(s.data() == p); } @@ -46,7 +46,7 @@ TEST_CASE("adaptString()") { auto s = adaptString(static_cast(0), 10); CHECK(s.isNull() == true); - CHECK(s.isLinked() == false); + CHECK(s.isStatic() == false); } SECTION("non-null const char* + size") { @@ -54,7 +54,7 @@ TEST_CASE("adaptString()") { CHECK(s.isNull() == false); CHECK(s.size() == 5); - CHECK(s.isLinked() == false); + CHECK(s.isStatic() == false); } SECTION("null Flash string") { @@ -62,7 +62,7 @@ TEST_CASE("adaptString()") { CHECK(s.isNull() == true); CHECK(s.size() == 0); - CHECK(s.isLinked() == false); + CHECK(s.isStatic() == false); } SECTION("non-null Flash string") { @@ -70,7 +70,7 @@ TEST_CASE("adaptString()") { CHECK(s.isNull() == false); CHECK(s.size() == 5); - CHECK(s.isLinked() == false); + CHECK(s.isStatic() == false); } SECTION("std::string") { @@ -79,7 +79,7 @@ TEST_CASE("adaptString()") { CHECK(s.isNull() == false); CHECK(s.size() == 5); - CHECK(s.isLinked() == false); + CHECK(s.isStatic() == false); } SECTION("Arduino String") { @@ -88,7 +88,7 @@ TEST_CASE("adaptString()") { CHECK(s.isNull() == false); CHECK(s.size() == 5); - CHECK(s.isLinked() == false); + CHECK(s.isStatic() == false); } SECTION("custom_string") { @@ -97,7 +97,7 @@ TEST_CASE("adaptString()") { CHECK(s.isNull() == false); CHECK(s.size() == 5); - CHECK(s.isLinked() == false); + CHECK(s.isStatic() == false); } SECTION("JsonString linked") { @@ -106,7 +106,7 @@ TEST_CASE("adaptString()") { CHECK(s.isNull() == false); CHECK(s.size() == 5); - CHECK(s.isLinked() == true); + CHECK(s.isStatic() == true); } SECTION("JsonString copied") { @@ -115,7 +115,7 @@ TEST_CASE("adaptString()") { CHECK(s.isNull() == false); CHECK(s.size() == 5); - CHECK(s.isLinked() == false); + CHECK(s.isStatic() == false); } } diff --git a/src/ArduinoJson/Strings/Adapters/FlashString.hpp b/src/ArduinoJson/Strings/Adapters/FlashString.hpp index 9a25462b..29ca1c3b 100644 --- a/src/ArduinoJson/Strings/Adapters/FlashString.hpp +++ b/src/ArduinoJson/Strings/Adapters/FlashString.hpp @@ -63,7 +63,7 @@ class FlashString { ::memcpy_P(p, s.str_, n); } - bool isLinked() const { + bool isStatic() const { return false; } diff --git a/src/ArduinoJson/Strings/Adapters/RamString.hpp b/src/ArduinoJson/Strings/Adapters/RamString.hpp index b191b245..5477b232 100644 --- a/src/ArduinoJson/Strings/Adapters/RamString.hpp +++ b/src/ArduinoJson/Strings/Adapters/RamString.hpp @@ -26,8 +26,8 @@ class RamString { static constexpr size_t sizeMask = size_t(-1); #endif - RamString(const char* str, size_t sz, bool linked = false) - : str_(str), size_(sz & sizeMask), linked_(linked) { + RamString(const char* str, size_t sz, bool isStatic = false) + : str_(str), size_(sz & sizeMask), static_(isStatic) { ARDUINOJSON_ASSERT(size_ == sz); } @@ -49,8 +49,8 @@ class RamString { return str_; } - bool isLinked() const { - return linked_; + bool isStatic() const { + return static_; } protected: @@ -59,10 +59,10 @@ class RamString { #if ARDUINOJSON_SIZEOF_POINTER <= 2 // Use a bitfield only on 8-bit microcontrollers size_t size_ : sizeof(size_t) * 8 - 1; - bool linked_ : 1; + bool static_ : 1; #else size_t size_; - bool linked_; + bool static_; #endif }; diff --git a/src/ArduinoJson/Strings/JsonString.hpp b/src/ArduinoJson/Strings/JsonString.hpp index 1f1f26aa..475bda16 100644 --- a/src/ArduinoJson/Strings/JsonString.hpp +++ b/src/ArduinoJson/Strings/JsonString.hpp @@ -42,8 +42,8 @@ class JsonString { // Returns true if the string is stored by address. // Returns false if the string is stored by copy. - bool isLinked() const { - return str_.isLinked(); + bool isStatic() const { + return str_.isStatic(); } // Returns length of the string. diff --git a/src/ArduinoJson/Variant/VariantImpl.hpp b/src/ArduinoJson/Variant/VariantImpl.hpp index f6217d77..8e5b2539 100644 --- a/src/ArduinoJson/Variant/VariantImpl.hpp +++ b/src/ArduinoJson/Variant/VariantImpl.hpp @@ -26,7 +26,7 @@ inline bool VariantData::setString(TAdaptedString value, if (value.isNull()) return false; - if (value.isLinked()) { + if (value.isStatic()) { setLinkedString(value.data()); return true; }