Rename addElement() to add()

This commit is contained in:
Benoit Blanchon
2022-07-06 10:02:29 +02:00
parent 04872b6db8
commit 758580bfb6
11 changed files with 32 additions and 27 deletions

View File

@ -8,6 +8,7 @@ HEAD
* Fix `9.22337e+18 is outside the range of representable values of type 'long'` * Fix `9.22337e+18 is outside the range of representable values of type 'long'`
* Fix comparison operators for `JsonArray`, `JsonArrayConst`, `JsonObject`, and `JsonObjectConst` * Fix comparison operators for `JsonArray`, `JsonArrayConst`, `JsonObject`, and `JsonObjectConst`
* Remove undocumented `accept()` functions * Remove undocumented `accept()` functions
* Rename `addElement()` to `add()`
v6.19.4 (2022-04-05) v6.19.4 (2022-04-05)
------- -------

View File

@ -9,7 +9,7 @@ using namespace ARDUINOJSON_NAMESPACE;
TEST_CASE("ElementProxy::add()") { TEST_CASE("ElementProxy::add()") {
DynamicJsonDocument doc(4096); DynamicJsonDocument doc(4096);
doc.addElement(); doc.add();
ElementProxy<JsonDocument &> ep = doc[0]; ElementProxy<JsonDocument &> ep = doc[0];
SECTION("add(int)") { SECTION("add(int)") {
@ -35,7 +35,7 @@ TEST_CASE("ElementProxy::add()") {
TEST_CASE("ElementProxy::clear()") { TEST_CASE("ElementProxy::clear()") {
DynamicJsonDocument doc(4096); DynamicJsonDocument doc(4096);
doc.addElement(); doc.add();
ElementProxy<JsonDocument &> ep = doc[0]; ElementProxy<JsonDocument &> ep = doc[0];
SECTION("size goes back to zero") { SECTION("size goes back to zero") {
@ -95,7 +95,7 @@ TEST_CASE("ElementProxy::operator==()") {
TEST_CASE("ElementProxy::remove()") { TEST_CASE("ElementProxy::remove()") {
DynamicJsonDocument doc(4096); DynamicJsonDocument doc(4096);
doc.addElement(); doc.add();
ElementProxy<JsonDocument &> ep = doc[0]; ElementProxy<JsonDocument &> ep = doc[0];
SECTION("remove(int)") { SECTION("remove(int)") {
@ -168,7 +168,7 @@ TEST_CASE("ElementProxy::set()") {
TEST_CASE("ElementProxy::size()") { TEST_CASE("ElementProxy::size()") {
DynamicJsonDocument doc(4096); DynamicJsonDocument doc(4096);
doc.addElement(); doc.add();
ElementProxy<JsonDocument &> ep = doc[0]; ElementProxy<JsonDocument &> ep = doc[0];
SECTION("returns 0") { SECTION("returns 0") {
@ -190,7 +190,7 @@ TEST_CASE("ElementProxy::size()") {
TEST_CASE("ElementProxy::memoryUsage()") { TEST_CASE("ElementProxy::memoryUsage()") {
DynamicJsonDocument doc(4096); DynamicJsonDocument doc(4096);
doc.addElement(); doc.add();
ElementProxy<JsonDocument &> ep = doc[0]; ElementProxy<JsonDocument &> ep = doc[0];
SECTION("returns 0 for null") { SECTION("returns 0 for null") {

View File

@ -10,7 +10,7 @@
TEST_CASE("Compare JsonVariant with value") { TEST_CASE("Compare JsonVariant with value") {
StaticJsonDocument<256> doc; StaticJsonDocument<256> doc;
JsonVariant a = doc.addElement(); JsonVariant a = doc.add();
SECTION("null vs (char*)0") { SECTION("null vs (char*)0") {
char* b = 0; char* b = 0;
@ -38,8 +38,8 @@ TEST_CASE("Compare JsonVariant with value") {
TEST_CASE("Compare JsonVariant with JsonVariant") { TEST_CASE("Compare JsonVariant with JsonVariant") {
StaticJsonDocument<256> doc; StaticJsonDocument<256> doc;
JsonVariant a = doc.addElement(); JsonVariant a = doc.add();
JsonVariant b = doc.addElement(); JsonVariant b = doc.add();
SECTION("'abc' vs 'abc'") { SECTION("'abc' vs 'abc'") {
a.set("abc"); a.set("abc");

View File

@ -11,12 +11,12 @@ namespace ARDUINOJSON_NAMESPACE {
template <typename TArray> template <typename TArray>
inline ArrayRef ArrayShortcuts<TArray>::createNestedArray() const { inline ArrayRef ArrayShortcuts<TArray>::createNestedArray() const {
return impl()->addElement().template to<ArrayRef>(); return impl()->add().template to<ArrayRef>();
} }
template <typename TArray> template <typename TArray>
inline ObjectRef ArrayShortcuts<TArray>::createNestedObject() const { inline ObjectRef ArrayShortcuts<TArray>::createNestedObject() const {
return impl()->addElement().template to<ObjectRef>(); return impl()->add().template to<ObjectRef>();
} }
template <typename TArray> template <typename TArray>

View File

@ -130,10 +130,12 @@ class ArrayRef : public ArrayRefBase<CollectionData>,
return ArrayConstRef(_data); return ArrayConstRef(_data);
} }
VariantRef addElement() const { VariantRef add() const {
return VariantRef(_pool, arrayAdd(_data, _pool)); return VariantRef(_pool, arrayAdd(_data, _pool));
} }
using ArrayShortcuts<ArrayRef>::add;
FORCE_INLINE iterator begin() const { FORCE_INLINE iterator begin() const {
if (!_data) if (!_data)
return iterator(); return iterator();

View File

@ -31,14 +31,14 @@ class ArrayShortcuts {
// std::string, String, ObjectRef // std::string, String, ObjectRef
template <typename T> template <typename T>
FORCE_INLINE bool add(const T &value) const { FORCE_INLINE bool add(const T &value) const {
return impl()->addElement().set(value); return impl()->add().set(value);
} }
// //
// bool add(TValue); // bool add(TValue);
// TValue = char*, const char*, const __FlashStringHelper* // TValue = char*, const char*, const __FlashStringHelper*
template <typename T> template <typename T>
FORCE_INLINE bool add(T *value) const { FORCE_INLINE bool add(T *value) const {
return impl()->addElement().set(value); return impl()->add().set(value);
} }
private: private:

View File

@ -165,10 +165,12 @@ class ElementProxy : public VariantOperators<ElementProxy<TArray> >,
return getOrAddUpstreamElement().getOrAddMember(key); return getOrAddUpstreamElement().getOrAddMember(key);
} }
VariantRef addElement() const { VariantRef add() const {
return getOrAddUpstreamElement().addElement(); return getOrAddUpstreamElement().add();
} }
using ArrayShortcuts<ElementProxy<TArray> >::add;
VariantRef getElement(size_t index) const { VariantRef getElement(size_t index) const {
return getOrAddUpstreamElement().getElement(index); return getOrAddUpstreamElement().getElement(index);
} }

View File

@ -31,7 +31,7 @@ inline typename enable_if<!is_base_of<JsonDocument, TDestination>::value,
copyArray(const T* src, size_t len, const TDestination& dst) { copyArray(const T* src, size_t len, const TDestination& dst) {
bool ok = true; bool ok = true;
for (size_t i = 0; i < len; i++) { for (size_t i = 0; i < len; i++) {
ok &= copyArray(src[i], dst.addElement()); ok &= copyArray(src[i], dst.add());
} }
return ok; return ok;
} }

View File

@ -92,7 +92,7 @@ class JsonDocument : public VariantOperators<const JsonDocument&> {
} }
ArrayRef createNestedArray() { ArrayRef createNestedArray() {
return addElement().to<ArrayRef>(); return add().to<ArrayRef>();
} }
// createNestedArray(char*) // createNestedArray(char*)
@ -111,7 +111,7 @@ class JsonDocument : public VariantOperators<const JsonDocument&> {
} }
ObjectRef createNestedObject() { ObjectRef createNestedObject() {
return addElement().to<ObjectRef>(); return add().to<ObjectRef>();
} }
// createNestedObject(char*) // createNestedObject(char*)
@ -254,13 +254,13 @@ class JsonDocument : public VariantOperators<const JsonDocument&> {
getStringStoragePolicy(key))); getStringStoragePolicy(key)));
} }
FORCE_INLINE VariantRef addElement() { FORCE_INLINE VariantRef add() {
return VariantRef(&_pool, _data.addElement(&_pool)); return VariantRef(&_pool, _data.addElement(&_pool));
} }
template <typename TValue> template <typename TValue>
FORCE_INLINE bool add(const TValue& value) { FORCE_INLINE bool add(const TValue& value) {
return addElement().set(value); return add().set(value);
} }
// add(char*) const // add(char*) const
@ -268,7 +268,7 @@ class JsonDocument : public VariantOperators<const JsonDocument&> {
// add(const __FlashStringHelper*) const // add(const __FlashStringHelper*) const
template <typename TChar> template <typename TChar>
FORCE_INLINE bool add(TChar* value) { FORCE_INLINE bool add(TChar* value) {
return addElement().set(value); return add().set(value);
} }
FORCE_INLINE void remove(size_t index) { FORCE_INLINE void remove(size_t index) {

View File

@ -154,10 +154,12 @@ class MemberProxy : public VariantOperators<MemberProxy<TObject, TStringRef> >,
return getOrAddUpstreamMember().set(value); return getOrAddUpstreamMember().set(value);
} }
FORCE_INLINE VariantRef addElement() const { FORCE_INLINE VariantRef add() const {
return getOrAddUpstreamMember().addElement(); return getOrAddUpstreamMember().add();
} }
using ArrayShortcuts<MemberProxy<TObject, TStringRef> >::add;
FORCE_INLINE VariantRef getElement(size_t index) const { FORCE_INLINE VariantRef getElement(size_t index) const {
return getUpstreamMember().getElement(index); return getUpstreamMember().getElement(index);
} }

View File

@ -269,13 +269,11 @@ class VariantRef : public VariantRefBase<VariantData>,
typename enable_if<is_same<T, VariantRef>::value, VariantRef>::type to() typename enable_if<is_same<T, VariantRef>::value, VariantRef>::type to()
const; const;
VariantRef addElement() const { VariantRef add() const {
return VariantRef(_pool, variantAddElement(_data, _pool)); return VariantRef(_pool, variantAddElement(_data, _pool));
} }
FORCE_INLINE VariantRef getElement(size_t index) const { using ArrayShortcuts<VariantRef>::add;
return VariantRef(_pool, _data != 0 ? _data->getElement(index) : 0);
}
FORCE_INLINE VariantConstRef getElementConst(size_t index) const { FORCE_INLINE VariantConstRef getElementConst(size_t index) const {
return VariantConstRef(_data != 0 ? _data->getElement(index) : 0); return VariantConstRef(_data != 0 ? _data->getElement(index) : 0);