bblanchon/ArduinoJson
1
0
Fork 1
mirror of https://github.com/bblanchon/ArduinoJson.git synced 2025-07-30 02:37:35 +02:00
Code Issues Packages Projects Releases Wiki Activity

Rename undocumented JsonString::isLinked() to isStatic()

Browse Source
This commit is contained in:
Benoit Blanchon
2024-11-26 14:32:21 +01:00
parent ed5f890d28
commit e33e78d202
8 changed files with 26 additions and 25 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
CHANGELOG.md
View File

@ -9,6 +9,7 @@ HEAD
* Change string copy policy: only string literal are stored by pointer * Change string copy policy: only string literal are stored by pointer
* `JsonString` is now stored by copy, unless specified otherwise * `JsonString` is now stored by copy, unless specified otherwise
* Replace undocumented `JsonString::Ownership` with `bool` * Replace undocumented `JsonString::Ownership` with `bool`
* Rename undocumented `JsonString::isLinked()` to `isStatic()`
> ### BREAKING CHANGES > ### BREAKING CHANGES
> >

4
extras/tests/JsonVariant/as.cpp
View File

@ -184,7 +184,7 @@ TEST_CASE("JsonVariant::as()") {
REQUIRE(variant.as<long>() == 42L); REQUIRE(variant.as<long>() == 42L);
REQUIRE(variant.as<JsonString>() == "42"); REQUIRE(variant.as<JsonString>() == "42");
REQUIRE(variant.as<JsonString>().isLinked() == true); REQUIRE(variant.as<JsonString>().isStatic() == true);
} }
SECTION("set(\"hello\")") { SECTION("set(\"hello\")") {
@ -207,7 +207,7 @@ TEST_CASE("JsonVariant::as()") {
REQUIRE(variant.as<const char*>() == "4.2"_s); REQUIRE(variant.as<const char*>() == "4.2"_s);
REQUIRE(variant.as<std::string>() == "4.2"_s); REQUIRE(variant.as<std::string>() == "4.2"_s);
REQUIRE(variant.as<JsonString>() == "4.2"); REQUIRE(variant.as<JsonString>() == "4.2");
REQUIRE(variant.as<JsonString>().isLinked() == false); REQUIRE(variant.as<JsonString>().isStatic() == false);
} }
SECTION("set(\"true\")") { SECTION("set(\"true\")") {

4
extras/tests/Misc/JsonString.cpp
View File

@ -13,7 +13,7 @@ TEST_CASE("JsonString") {
CHECK(s.isNull() == true); CHECK(s.isNull() == true);
CHECK(s.c_str() == 0); CHECK(s.c_str() == 0);
CHECK(s.isLinked() == true); CHECK(s.isStatic() == true);
CHECK(s == JsonString()); CHECK(s == JsonString());
CHECK(s != ""); CHECK(s != "");
} }
@ -96,7 +96,7 @@ TEST_CASE("JsonString") {
JsonString s("hello world", 5); JsonString s("hello world", 5);
CHECK(s.size() == 5); CHECK(s.size() == 5);
CHECK(s.isLinked() == false); CHECK(s.isStatic() == false);
CHECK(s == "hello"); CHECK(s == "hello");
CHECK(s != "hello world"); CHECK(s != "hello world");
} }

22
extras/tests/Misc/StringAdapters.cpp
View File

@ -22,7 +22,7 @@ TEST_CASE("adaptString()") {
CHECK(s.isNull() == false); CHECK(s.isNull() == false);
CHECK(s.size() == 11); CHECK(s.size() == 11);
CHECK(s.isLinked() == true); CHECK(s.isStatic() == true);
} }
SECTION("null const char*") { SECTION("null const char*") {
@ -38,7 +38,7 @@ TEST_CASE("adaptString()") {
CHECK(s.isNull() == false); CHECK(s.isNull() == false);
CHECK(s.size() == 5); CHECK(s.size() == 5);
CHECK(s.isLinked() == false); CHECK(s.isStatic() == false);
CHECK(s.data() == p); CHECK(s.data() == p);
} }
@ -46,7 +46,7 @@ TEST_CASE("adaptString()") {
auto s = adaptString(static_cast<const char*>(0), 10); auto s = adaptString(static_cast<const char*>(0), 10);
CHECK(s.isNull() == true); CHECK(s.isNull() == true);
CHECK(s.isLinked() == false); CHECK(s.isStatic() == false);
} }
SECTION("non-null const char* + size") { SECTION("non-null const char* + size") {
@ -54,7 +54,7 @@ TEST_CASE("adaptString()") {
CHECK(s.isNull() == false); CHECK(s.isNull() == false);
CHECK(s.size() == 5); CHECK(s.size() == 5);
CHECK(s.isLinked() == false); CHECK(s.isStatic() == false);
} }
SECTION("null Flash string") { SECTION("null Flash string") {
@ -62,7 +62,7 @@ TEST_CASE("adaptString()") {
CHECK(s.isNull() == true); CHECK(s.isNull() == true);
CHECK(s.size() == 0); CHECK(s.size() == 0);
CHECK(s.isLinked() == false); CHECK(s.isStatic() == false);
} }
SECTION("non-null Flash string") { SECTION("non-null Flash string") {
@ -70,7 +70,7 @@ TEST_CASE("adaptString()") {
CHECK(s.isNull() == false); CHECK(s.isNull() == false);
CHECK(s.size() == 5); CHECK(s.size() == 5);
CHECK(s.isLinked() == false); CHECK(s.isStatic() == false);
} }
SECTION("std::string") { SECTION("std::string") {
@ -79,7 +79,7 @@ TEST_CASE("adaptString()") {
CHECK(s.isNull() == false); CHECK(s.isNull() == false);
CHECK(s.size() == 5); CHECK(s.size() == 5);
CHECK(s.isLinked() == false); CHECK(s.isStatic() == false);
} }
SECTION("Arduino String") { SECTION("Arduino String") {
@ -88,7 +88,7 @@ TEST_CASE("adaptString()") {
CHECK(s.isNull() == false); CHECK(s.isNull() == false);
CHECK(s.size() == 5); CHECK(s.size() == 5);
CHECK(s.isLinked() == false); CHECK(s.isStatic() == false);
} }
SECTION("custom_string") { SECTION("custom_string") {
@ -97,7 +97,7 @@ TEST_CASE("adaptString()") {
CHECK(s.isNull() == false); CHECK(s.isNull() == false);
CHECK(s.size() == 5); CHECK(s.size() == 5);
CHECK(s.isLinked() == false); CHECK(s.isStatic() == false);
} }
SECTION("JsonString linked") { SECTION("JsonString linked") {
@ -106,7 +106,7 @@ TEST_CASE("adaptString()") {
CHECK(s.isNull() == false); CHECK(s.isNull() == false);
CHECK(s.size() == 5); CHECK(s.size() == 5);
CHECK(s.isLinked() == true); CHECK(s.isStatic() == true);
} }
SECTION("JsonString copied") { SECTION("JsonString copied") {
@ -115,7 +115,7 @@ TEST_CASE("adaptString()") {
CHECK(s.isNull() == false); CHECK(s.isNull() == false);
CHECK(s.size() == 5); CHECK(s.size() == 5);
CHECK(s.isLinked() == false); CHECK(s.isStatic() == false);
} }
} }

2
src/ArduinoJson/Strings/Adapters/FlashString.hpp
View File

@ -63,7 +63,7 @@ class FlashString {
::memcpy_P(p, s.str_, n); ::memcpy_P(p, s.str_, n);
} }
bool isLinked() const { bool isStatic() const {
return false; return false;
} }

12
src/ArduinoJson/Strings/Adapters/RamString.hpp
View File

@ -26,8 +26,8 @@ class RamString {
static constexpr size_t sizeMask = size_t(-1); static constexpr size_t sizeMask = size_t(-1);
#endif #endif
RamString(const char* str, size_t sz, bool linked = false) RamString(const char* str, size_t sz, bool isStatic = false)
: str_(str), size_(sz & sizeMask), linked_(linked) { : str_(str), size_(sz & sizeMask), static_(isStatic) {
ARDUINOJSON_ASSERT(size_ == sz); ARDUINOJSON_ASSERT(size_ == sz);
} }
@ -49,8 +49,8 @@ class RamString {
return str_; return str_;
} }
bool isLinked() const { bool isStatic() const {
return linked_; return static_;
} }
protected: protected:
@ -59,10 +59,10 @@ class RamString {
#if ARDUINOJSON_SIZEOF_POINTER <= 2 #if ARDUINOJSON_SIZEOF_POINTER <= 2
// Use a bitfield only on 8-bit microcontrollers // Use a bitfield only on 8-bit microcontrollers
size_t size_ : sizeof(size_t) * 8 - 1; size_t size_ : sizeof(size_t) * 8 - 1;
bool linked_ : 1; bool static_ : 1;
#else #else
size_t size_; size_t size_;
bool linked_; bool static_;
#endif #endif
}; };

4
src/ArduinoJson/Strings/JsonString.hpp
View File

@ -42,8 +42,8 @@ class JsonString {
// Returns true if the string is stored by address. // Returns true if the string is stored by address.
// Returns false if the string is stored by copy. // Returns false if the string is stored by copy.
bool isLinked() const { bool isStatic() const {
return str_.isLinked(); return str_.isStatic();
} }
// Returns length of the string. // Returns length of the string.

2
src/ArduinoJson/Variant/VariantImpl.hpp
View File

@ -26,7 +26,7 @@ inline bool VariantData::setString(TAdaptedString value,
if (value.isNull()) if (value.isNull())
return false; return false;
if (value.isLinked()) { if (value.isStatic()) {
setLinkedString(value.data()); setLinkedString(value.data());
return true; return true;
} }