mirror of
https://github.com/eledio-devices/thirdparty-ArduinoJson.git
synced 2025-11-01 16:14:05 +01:00
95 lines
3.2 KiB
C++
95 lines
3.2 KiB
C++
// Copyright Benoit Blanchon 2014-2015
|
|
// MIT License
|
|
//
|
|
// Arduino JSON library
|
|
// https://github.com/bblanchon/ArduinoJson
|
|
|
|
#pragma once
|
|
|
|
#include "Internals/JsonBufferAllocated.hpp"
|
|
#include "Internals/JsonPrintable.hpp"
|
|
#include "Internals/List.hpp"
|
|
#include "Internals/ReferenceType.hpp"
|
|
#include "JsonVariant.hpp"
|
|
|
|
// Returns the size (in bytes) of an array with n elements.
|
|
// Can be very handy to determine the size of a StaticJsonBuffer.
|
|
#define JSON_ARRAY_SIZE(NUMBER_OF_ELEMENTS) \
|
|
(sizeof(JsonArray) + (NUMBER_OF_ELEMENTS) * sizeof(JsonArray::node_type))
|
|
|
|
namespace ArduinoJson {
|
|
|
|
// Forward declarations
|
|
class JsonObject;
|
|
class JsonBuffer;
|
|
class JsonArraySubscript;
|
|
|
|
// An array of JsonVariant.
|
|
//
|
|
// The constructor is private, instances must be created via
|
|
// JsonBuffer::createArray() or JsonBuffer::parseArray().
|
|
// A JsonArray can be serialized to a JSON string via JsonArray::printTo().
|
|
// It can also be deserialized from a JSON string via JsonBuffer::parseArray().
|
|
class JsonArray : public Internals::JsonPrintable<JsonArray>,
|
|
public Internals::ReferenceType,
|
|
public Internals::List<JsonVariant>,
|
|
public Internals::JsonBufferAllocated {
|
|
public:
|
|
// Create an empty JsonArray attached to the specified JsonBuffer.
|
|
// You should not call this constructor directly.
|
|
// Instead, use JsonBuffer::createArray() or JsonBuffer::parseArray().
|
|
explicit JsonArray(JsonBuffer *buffer)
|
|
: Internals::List<JsonVariant>(buffer) {}
|
|
|
|
// Gets the value at the specified index
|
|
JSON_FORCE_INLINE const JsonArraySubscript operator[](size_t index) const;
|
|
|
|
// Gets or sets the value at specified index
|
|
JSON_FORCE_INLINE JsonArraySubscript operator[](size_t index);
|
|
|
|
// Adds the specified value at the end of the array.
|
|
JSON_FORCE_INLINE bool add(const JsonVariant value);
|
|
|
|
// Sets the value at specified index.
|
|
JSON_FORCE_INLINE void set(size_t index, const JsonVariant value);
|
|
|
|
// Gets the value at the specified index.
|
|
JSON_FORCE_INLINE JsonVariant get(size_t index) const;
|
|
|
|
// Gets the value at the specified index.
|
|
template <typename T>
|
|
JSON_FORCE_INLINE T get(size_t index) const;
|
|
|
|
// Check the type of the value at specified index.
|
|
template <typename T>
|
|
JSON_FORCE_INLINE T is(size_t index) const;
|
|
|
|
// Creates a JsonArray and adds a reference at the end of the array.
|
|
// It's a shortcut for JsonBuffer::createArray() and JsonArray::add()
|
|
JsonArray &createNestedArray();
|
|
|
|
// Creates a JsonObject and adds a reference at the end of the array.
|
|
// It's a shortcut for JsonBuffer::createObject() and JsonArray::add()
|
|
JsonObject &createNestedObject();
|
|
|
|
// Removes element at specified index.
|
|
void removeAt(size_t index);
|
|
|
|
// Returns a reference an invalid JsonArray.
|
|
// This object is meant to replace a NULL pointer.
|
|
// This is used when memory allocation or JSON parsing fail.
|
|
static JsonArray &invalid() { return _invalid; }
|
|
|
|
// Serialize the array to the specified JsonWriter.
|
|
void writeTo(Internals::JsonWriter &writer) const;
|
|
|
|
private:
|
|
node_type *getNodeAt(size_t index) const;
|
|
|
|
// The instance returned by JsonArray::invalid()
|
|
static JsonArray _invalid;
|
|
};
|
|
}
|
|
|
|
#include "JsonArray.ipp"
|