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

Author: bblanchon

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
 >

extras/tests/JsonVariant/as.cpp

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

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");
   }

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,39 +38,39 @@ TEST_CASE("adaptString()") {
 
     CHECK(s.isNull() == false);
     CHECK(s.size() == 5);
-    CHECK(s.isLinked() == false);
+    CHECK(s.isStatic() == false);
     CHECK(s.data() == p);
   }
 
   SECTION("null const char* + size") {
     auto s = adaptString(static_cast<const char*>(0), 10);
 
     CHECK(s.isNull() == true);
-    CHECK(s.isLinked() == false);
+    CHECK(s.isStatic() == false);
   }
 
   SECTION("non-null const char* + size") {
     auto s = adaptString("bravo", 5);
 
     CHECK(s.isNull() == false);
     CHECK(s.size() == 5);
-    CHECK(s.isLinked() == false);
+    CHECK(s.isStatic() == false);
   }
 
   SECTION("null Flash string") {
     auto s = adaptString(static_cast<const __FlashStringHelper*>(0));
 
     CHECK(s.isNull() == true);
     CHECK(s.size() == 0);
-    CHECK(s.isLinked() == false);
+    CHECK(s.isStatic() == false);
   }
 
   SECTION("non-null Flash string") {
     auto s = adaptString(F("bravo"));
 
     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);
   }
 }
 

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;
   }
 

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
 };
 

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.

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;
   }