Replace problematic symbols in idf_component.yml

Fixes #2131

.github/workflows/ci.yml

@@ -5,7 +5,7 @@ on: [push, pull_request]
 jobs:
   lint:
     name: Lint
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
     steps:
       - name: Install
         run: sudo apt-get install -y clang-format

.github/workflows/release.yml

@@ -76,3 +76,20 @@ jobs:
       - name: Publish
         run: bash -eux extras/scripts/publish-particle-library.sh
         timeout-minutes: 5
+
+  platformio:
+    name: PlatformIO
+    runs-on: ubuntu-latest
+    steps:
+      - name: Set up Python 3.x
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.x"
+      - name: Install PlatformIO
+        run: pip install platformio
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Publish
+        run: pio pkg publish --no-interactive --no-notify
+        env:
+          PLATFORMIO_AUTH_TOKEN: ${{ secrets.PLATFORMIO_AUTH_TOKEN }}

CHANGELOG.md

@@ -1,6 +1,19 @@
 ArduinoJson: change log
 =======================
 
+HEAD
+----
+
+* Improve error messages when using `char` or `char*` (issue #2043)
+* Make string support even more generic (PR #2084 by @d-a-v)
+
+v6.21.5 (2024-01-10)
+-------
+
+* Fix warning `function returns incomplete class type` on IAR (issue #2001)
+* Fix `volatile bool` serialized as `1` or `0` instead of `true` or `false` (issue #2029)
+* Remove unused files in the PlatformIO package
+
 v6.21.4 (2023-12-07)
 -------
 

CMakeLists.txt

@@ -10,7 +10,7 @@ if(ESP_PLATFORM)
 	return()
 endif()
 
-project(ArduinoJson VERSION 6.21.4)
+project(ArduinoJson VERSION 6.21.5)
 
 if(CMAKE_PROJECT_NAME STREQUAL PROJECT_NAME)
 	include(CTest)

README.md

@@ -8,9 +8,9 @@
 [![Continuous Integration](https://ci.appveyor.com/api/projects/status/m7s53wav1l0abssg/branch/6.x?svg=true)](https://ci.appveyor.com/project/bblanchon/arduinojson/branch/6.x)
 [![Fuzzing Status](https://oss-fuzz-build-logs.storage.googleapis.com/badges/arduinojson.svg)](https://bugs.chromium.org/p/oss-fuzz/issues/list?sort=-opened&can=1&q=proj:arduinojson)
 [![Coveralls branch](https://img.shields.io/coveralls/github/bblanchon/ArduinoJson/6.x?logo=coveralls)](https://coveralls.io/github/bblanchon/ArduinoJson?branch=6.x)  
-[![Arduino Library Manager](https://img.shields.io/static/v1?label=Arduino&message=v6.21.4&logo=arduino&logoColor=white&color=blue)](https://www.ardu-badge.com/ArduinoJson/6.21.4)
-[![PlatformIO Registry](https://badges.registry.platformio.org/packages/bblanchon/library/ArduinoJson.svg?version=6.21.4)](https://registry.platformio.org/packages/libraries/bblanchon/ArduinoJson?version=6.21.4) 
-[![ESP IDF](https://img.shields.io/static/v1?label=ESP+IDF&message=v6.21.4&logo=cpu&logoColor=white&color=blue)](https://components.espressif.com/components/bblanchon/arduinojson)  
+[![Arduino Library Manager](https://img.shields.io/static/v1?label=Arduino&message=v6.21.5&logo=arduino&logoColor=white&color=blue)](https://www.ardu-badge.com/ArduinoJson/6.21.5)
+[![PlatformIO Registry](https://badges.registry.platformio.org/packages/bblanchon/library/ArduinoJson.svg?version=6.21.5)](https://registry.platformio.org/packages/libraries/bblanchon/ArduinoJson?version=6.21.5) 
+[![ESP IDF](https://img.shields.io/static/v1?label=ESP+IDF&message=v6.21.5&logo=cpu&logoColor=white&color=blue)](https://components.espressif.com/components/bblanchon/arduinojson)  
 [![GitHub stars](https://img.shields.io/github/stars/bblanchon/ArduinoJson?style=flat&logo=github&color=orange)](https://github.com/bblanchon/ArduinoJson/stargazers)
 [![GitHub Sponsors](https://img.shields.io/github/sponsors/bblanchon?logo=github&color=orange)](https://github.com/sponsors/bblanchon)
 

appveyor.yml

@@ -1,4 +1,4 @@
-version: 6.21.4.{build}
+version: 6.21.5.{build}
 environment:
   matrix:
     - APPVEYOR_BUILD_WORKER_IMAGE: Visual Studio 2022

extras/tests/JsonVariant/converters.cpp

@@ -154,15 +154,18 @@ TEST_CASE("ConverterNeedsWriteableRef") {
 }
 
 namespace ArduinoJson {
-void convertToJson(char c, JsonVariant var) {
-  char buf[] = {c, 0};
-  var.set(buf);
-}
+template <>
+struct Converter<char> {
+  static void toJson(char c, JsonVariant var) {
+    char buf[] = {c, 0};
+    var.set(buf);
+  }
 
-void convertFromJson(JsonVariantConst src, char& dst) {
-  auto p = src.as<const char*>();
-  dst = p ? p[0] : 0;
-}
+  static char fromJson(JsonVariantConst src) {
+    auto p = src.as<const char*>();
+    return p ? p[0] : 0;
+  }
+};
 }  // namespace ArduinoJson
 
 TEST_CASE("Convert char to string") {  // issue #1922

extras/tests/JsonVariant/types.cpp

@@ -140,6 +140,13 @@ TEST_CASE("volatile") {
   DynamicJsonDocument doc(4096);
   JsonVariant variant = doc.to<JsonVariant>();
 
+  SECTION("volatile bool") {  // issue #2029
+    volatile bool f = true;
+    variant.set(f);
+    CHECK(variant.is<bool>() == true);
+    CHECK(variant.as<bool>() == true);
+  }
+
   SECTION("volatile int") {
     volatile int f = 42;
     variant.set(f);

extras/tests/MsgPackDeserializer/doubleToFloat.cpp

@@ -13,7 +13,7 @@ static void check(const char* input, T expected) {
   uint8_t* f = reinterpret_cast<uint8_t*>(&actual);
   const uint8_t* d = reinterpret_cast<const uint8_t*>(input);
   doubleToFloat(d, f);
-  fixEndianess(actual);
+  fixEndianness(actual);
   CHECK(actual == expected);
 }
 

idf_component.yml

@@ -1,8 +1,8 @@
-version: "6.21.4"
+version: "6.21.5"
 description: >-
   A simple and efficient JSON library for embedded C++.
   ArduinoJson supports ✔ serialization, ✔ deserialization, ✔ MessagePack, ✔ fixed allocation, ✔ zero-copy, ✔ streams, ✔ filtering, and more.
-  It is the most popular Arduino library on GitHub ❤❤❤❤❤.
+  It is the most popular Arduino library on GitHub ♥.
   Check out arduinojson.org for a comprehensive documentation.
 url: https://arduinojson.org/
 files:

library.json

@@ -7,16 +7,14 @@
     "type": "git",
     "url": "https://github.com/bblanchon/ArduinoJson.git"
   },
-  "version": "6.21.4",
+  "version": "6.21.5",
   "authors": {
     "name": "Benoit Blanchon",
     "url": "https://blog.benoitblanchon.fr"
   },
-  "exclude": [
-    ".devcontainer",
-    ".github",
-    "extras"
-  ],
+  "export": {
+    "include": ["src", "examples", "LICENSE.txt", "ArduinoJson.h"]
+  },
   "frameworks": "*",
   "platforms": "*",
   "build": {

library.properties

@@ -1,5 +1,5 @@
 name=ArduinoJson
-version=6.21.4
+version=6.21.5
 author=Benoit Blanchon <blog.benoitblanchon.fr>
 maintainer=Benoit Blanchon <blog.benoitblanchon.fr>
 sentence=A simple and efficient JSON library for embedded C++.

src/ArduinoJson/MsgPack/MsgPackDeserializer.hpp

@@ -6,7 +6,7 @@
 
 #include <ArduinoJson/Deserialization/deserialize.hpp>
 #include <ArduinoJson/Memory/MemoryPool.hpp>
-#include <ArduinoJson/MsgPack/endianess.hpp>
+#include <ArduinoJson/MsgPack/endianness.hpp>
 #include <ArduinoJson/MsgPack/ieee754.hpp>
 #include <ArduinoJson/Polyfills/type_traits.hpp>
 #include <ArduinoJson/Variant/VariantData.hpp>
@@ -258,7 +258,7 @@ class MsgPackDeserializer {
     if (err)
       return err;
 
-    fixEndianess(value);
+    fixEndianness(value);
 
     return DeserializationError::Ok;
   }
@@ -287,7 +287,7 @@ class MsgPackDeserializer {
     if (err)
       return err;
 
-    fixEndianess(value);
+    fixEndianness(value);
     variant->setFloat(value);
 
     return DeserializationError::Ok;
@@ -303,7 +303,7 @@ class MsgPackDeserializer {
     if (err)
       return err;
 
-    fixEndianess(value);
+    fixEndianness(value);
     variant->setFloat(value);
 
     return DeserializationError::Ok;
@@ -322,7 +322,7 @@ class MsgPackDeserializer {
       return err;
 
     doubleToFloat(i, o);
-    fixEndianess(value);
+    fixEndianness(value);
     variant->setFloat(value);
 
     return DeserializationError::Ok;

src/ArduinoJson/MsgPack/MsgPackSerializer.hpp

@@ -4,7 +4,7 @@
 
 #pragma once
 
-#include <ArduinoJson/MsgPack/endianess.hpp>
+#include <ArduinoJson/MsgPack/endianness.hpp>
 #include <ArduinoJson/Polyfills/assert.hpp>
 #include <ArduinoJson/Polyfills/type_traits.hpp>
 #include <ArduinoJson/Serialization/CountingDecorator.hpp>
@@ -190,7 +190,7 @@ class MsgPackSerializer : public Visitor<size_t> {
 
   template <typename T>
   void writeInteger(T value) {
-    fixEndianess(value);
+    fixEndianness(value);
     writeBytes(reinterpret_cast<uint8_t*>(&value), sizeof(value));
   }
 

src/ArduinoJson/MsgPack/endianness.hpp

@@ -15,32 +15,32 @@ inline void swapBytes(uint8_t& a, uint8_t& b) {
   b = t;
 }
 
-inline void fixEndianess(uint8_t* p, integral_constant<size_t, 8>) {
+inline void fixEndianness(uint8_t* p, integral_constant<size_t, 8>) {
   swapBytes(p[0], p[7]);
   swapBytes(p[1], p[6]);
   swapBytes(p[2], p[5]);
   swapBytes(p[3], p[4]);
 }
 
-inline void fixEndianess(uint8_t* p, integral_constant<size_t, 4>) {
+inline void fixEndianness(uint8_t* p, integral_constant<size_t, 4>) {
   swapBytes(p[0], p[3]);
   swapBytes(p[1], p[2]);
 }
 
-inline void fixEndianess(uint8_t* p, integral_constant<size_t, 2>) {
+inline void fixEndianness(uint8_t* p, integral_constant<size_t, 2>) {
   swapBytes(p[0], p[1]);
 }
 
-inline void fixEndianess(uint8_t*, integral_constant<size_t, 1>) {}
+inline void fixEndianness(uint8_t*, integral_constant<size_t, 1>) {}
 
 template <typename T>
-inline void fixEndianess(T& value) {
-  fixEndianess(reinterpret_cast<uint8_t*>(&value),
-               integral_constant<size_t, sizeof(T)>());
+inline void fixEndianness(T& value) {
+  fixEndianness(reinterpret_cast<uint8_t*>(&value),
+                integral_constant<size_t, sizeof(T)>());
 }
 #else
 template <typename T>
-inline void fixEndianess(T&) {}
+inline void fixEndianness(T&) {}
 #endif
 
 ARDUINOJSON_END_PRIVATE_NAMESPACE

src/ArduinoJson/Strings/StringTraits.hpp

@@ -38,16 +38,15 @@ struct has_data<T,
                                            const char*>::value>::type>
     : true_type {};
 
-// size_t length() const
+// unsigned int length() const
 // - String
 
 template <class T, class = void>
 struct has_length : false_type {};
 
 template <class T>
-struct has_length<
-    T, typename enable_if<
-           is_same<decltype(declval<const T>().length()), size_t>::value>::type>
+struct has_length<T, typename enable_if<is_unsigned<
+                         decltype(declval<const T>().length())>::value>::type>
     : true_type {};
 
 // size_t size() const

src/ArduinoJson/Variant/ConverterImpl.hpp

@@ -20,6 +20,10 @@ ARDUINOJSON_BEGIN_PUBLIC_NAMESPACE
 
 template <typename T, typename Enable>
 struct Converter {
+  static_assert(!detail::is_same<T, char>::value,
+                "type 'char' is not supported, use 'signed char', 'unsigned "
+                "char' or another integer type instead");
+
   static void toJson(const T& src, JsonVariant dst) {
     // clang-format off
     convertToJson(src, dst); // Error here? See https://arduinojson.org/v6/unsupported-set/
@@ -27,6 +31,9 @@ struct Converter {
   }
 
   static T fromJson(JsonVariantConst src) {
+    static_assert(!detail::is_same<T, char*>::value,
+                  "type 'char*' is not supported, use 'const char*' instead");
+
     // clang-format off
     T result; // Error here? See https://arduinojson.org/v6/non-default-constructible/
     convertFromJson(src, result);  // Error here? See https://arduinojson.org/v6/unsupported-as/
@@ -35,6 +42,9 @@ struct Converter {
   }
 
   static bool checkJson(JsonVariantConst src) {
+    static_assert(!detail::is_same<T, char*>::value,
+                  "type 'char*' is not supported, use 'const char*' instead");
+
     T dummy = T();
     // clang-format off
     return canConvertFromJson(src, dummy);  // Error here? See https://arduinojson.org/v6/unsupported-is/

src/ArduinoJson/Variant/VariantImpl.hpp

@@ -110,6 +110,13 @@ inline JsonVariant VariantRefBase<TDerived>::add() const {
                      variantAddElement(getOrCreateData(), getPool()));
 }
 
+template <typename TDerived>
+template <typename T>
+inline typename enable_if<ConverterNeedsWriteableRef<T>::value, T>::type
+VariantRefBase<TDerived>::as() const {
+  return Converter<T>::fromJson(getVariant());
+}
+
 template <typename TDerived>
 inline JsonVariant VariantRefBase<TDerived>::getVariant() const {
   return JsonVariant(getPool(), getData());
@@ -120,6 +127,30 @@ inline JsonVariant VariantRefBase<TDerived>::getOrCreateVariant() const {
   return JsonVariant(getPool(), getOrCreateData());
 }
 
+template <typename TDerived>
+template <typename T>
+inline typename enable_if<ConverterNeedsWriteableRef<T>::value, bool>::type
+VariantRefBase<TDerived>::is() const {
+  return Converter<T>::checkJson(getVariant());
+}
+
+template <typename TDerived>
+template <typename T>
+inline bool VariantRefBase<TDerived>::set(const T& value) const {
+  Converter<typename detail::remove_cv<T>::type>::toJson(value,
+                                                         getOrCreateVariant());
+  MemoryPool* pool = getPool();
+  return pool && !pool->overflowed();
+}
+
+template <typename TDerived>
+template <typename T>
+inline bool VariantRefBase<TDerived>::set(T* value) const {
+  Converter<T*>::toJson(value, getOrCreateVariant());
+  MemoryPool* pool = getPool();
+  return pool && !pool->overflowed();
+}
+
 template <typename TDerived>
 template <typename T>
 inline typename enable_if<is_same<T, JsonArray>::value, JsonArray>::type

src/ArduinoJson/Variant/VariantRefBase.hpp

@@ -57,9 +57,7 @@ class VariantRefBase : public VariantTag {
   // https://arduinojson.org/v6/api/jsonvariant/as/
   template <typename T>
   FORCE_INLINE typename enable_if<ConverterNeedsWriteableRef<T>::value, T>::type
-  as() const {
-    return Converter<T>::fromJson(getVariant());
-  }
+  as() const;
 
   template <typename T,
             typename = typename enable_if<!is_same<T, TDerived>::value>::type>
@@ -92,18 +90,14 @@ class VariantRefBase : public VariantTag {
   template <typename T>
   FORCE_INLINE
       typename enable_if<ConverterNeedsWriteableRef<T>::value, bool>::type
-      is() const {
-    return Converter<T>::checkJson(getVariant());
-  }
+      is() const;
 
   // Returns true if the value is of the specified type.
   // https://arduinojson.org/v6/api/jsonvariant/is/
   template <typename T>
-  FORCE_INLINE typename enable_if<!ConverterNeedsWriteableRef<T>::value &&
-                                      !is_same<T, char*>::value &&
-                                      !is_same<T, char>::value,
-                                  bool>::type
-  is() const {
+  FORCE_INLINE
+      typename enable_if<!ConverterNeedsWriteableRef<T>::value, bool>::type
+      is() const {
     return Converter<T>::checkJson(getVariantConst());
   }
 
@@ -123,20 +117,12 @@ class VariantRefBase : public VariantTag {
   // Copies the specified value.
   // https://arduinojson.org/v6/api/jsonvariant/set/
   template <typename T>
-  FORCE_INLINE bool set(const T& value) const {
-    Converter<T>::toJson(value, getOrCreateVariant());
-    MemoryPool* pool = getPool();
-    return pool && !pool->overflowed();
-  }
+  FORCE_INLINE bool set(const T& value) const;
 
   // Copies the specified value.
   // https://arduinojson.org/v6/api/jsonvariant/set/
   template <typename T>
-  FORCE_INLINE bool set(T* value) const {
-    Converter<T*>::toJson(value, getOrCreateVariant());
-    MemoryPool* pool = getPool();
-    return pool && !pool->overflowed();
-  }
+  FORCE_INLINE bool set(T* value) const;
 
   // Returns the size of the array or object.
   // https://arduinojson.org/v6/api/jsonvariant/size/

src/ArduinoJson/version.hpp

@@ -4,8 +4,8 @@
 
 #pragma once
 
-#define ARDUINOJSON_VERSION "6.21.4"
+#define ARDUINOJSON_VERSION "6.21.5"
 #define ARDUINOJSON_VERSION_MAJOR 6
 #define ARDUINOJSON_VERSION_MINOR 21
-#define ARDUINOJSON_VERSION_REVISION 4
-#define ARDUINOJSON_VERSION_MACRO V6214
+#define ARDUINOJSON_VERSION_REVISION 5
+#define ARDUINOJSON_VERSION_MACRO V6215