AWS IoT Device SDK C++ v2: crt/aws-crt-cpp/include/aws/crt/external/cJSON.h Source File

AWS IoT Device SDK C++ v2 1.14.0 AWS IoT Device SDK C++ v2

cJSON.h
Go to the documentation of this file.
1/*
2 Copyright (c) 2009-2017 Dave Gamble and cJSON contributors
3
4 Permission is hereby granted, free of charge, to any person obtaining a copy
5 of this software and associated documentation files (the "Software"), to deal
6 in the Software without restriction, including without limitation the rights
7 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8 copies of the Software, and to permit persons to whom the Software is
9 furnished to do so, subject to the following conditions:
10
11 The above copyright notice and this permission notice shall be included in
12 all copies or substantial portions of the Software.
13
14 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
20 THE SOFTWARE.
21*/
22
44#ifndef cJSON__h
45#define cJSON__h
46
47namespace Aws {
48
49#if !defined(__WINDOWS__) && (defined(WIN32) || defined(WIN64) || defined(_MSC_VER) || defined(_WIN32))
50#define __WINDOWS__
51#endif
52
53#ifdef __WINDOWS__
54
55/* When compiling for windows, we specify a specific calling convention to avoid issues where we are being called from a project with a different default calling convention. For windows you have 3 define options:
56
57CJSON_HIDE_SYMBOLS - Define this in the case where you don't want to ever dllexport symbols
58CJSON_EXPORT_SYMBOLS - Define this on library build when you want to dllexport symbols (default)
59CJSON_IMPORT_SYMBOLS - Define this if you want to dllimport symbol
60
61For *nix builds that support visibility attribute, you can define similar behavior by
62
63setting default visibility to hidden by adding
64-fvisibility=hidden (for gcc)
65or
66-xldscope=hidden (for sun cc)
67to CFLAGS
68
69then using the CJSON_API_VISIBILITY flag to "export" the same symbols the way CJSON_EXPORT_SYMBOLS does
70
71*/
72
73#define CJSON_CDECL __cdecl
74#define CJSON_STDCALL __stdcall
75
76/* export symbols by default, this is necessary for copy pasting the C and header file */
77#if !defined(CJSON_HIDE_SYMBOLS) && !defined(CJSON_IMPORT_SYMBOLS) && !defined(CJSON_EXPORT_SYMBOLS)
78#define CJSON_EXPORT_SYMBOLS
79#endif
80
81#if defined(CJSON_HIDE_SYMBOLS)
82#define CJSON_PUBLIC(type) type CJSON_STDCALL
83#elif defined(CJSON_EXPORT_SYMBOLS)
84#define CJSON_PUBLIC(type) __declspec(dllexport) type CJSON_STDCALL
85#elif defined(CJSON_IMPORT_SYMBOLS)
86#define CJSON_PUBLIC(type) __declspec(dllimport) type CJSON_STDCALL
87#endif
88#else /* !__WINDOWS__ */
89#define CJSON_CDECL
90#define CJSON_STDCALL
91
92#if (defined(__GNUC__) || defined(__SUNPRO_CC) || defined (__SUNPRO_C)) && defined(CJSON_API_VISIBILITY)
93#define CJSON_PUBLIC(type) __attribute__((visibility("default"))) type
94#else
95#define CJSON_PUBLIC(type) type
96#endif
97#endif
98
99/* project version */
100#define CJSON_VERSION_MAJOR 1
101#define CJSON_VERSION_MINOR 7
102#define CJSON_VERSION_PATCH 14
103
104#include <stddef.h>
105
106/* cJSON Types: */
107#define cJSON_Invalid (0)
108#define cJSON_False (1 << 0)
109#define cJSON_True (1 << 1)
110#define cJSON_NULL (1 << 2)
111#define cJSON_Number (1 << 3)
112#define cJSON_String (1 << 4)
113#define cJSON_Array (1 << 5)
114#define cJSON_Object (1 << 6)
115#define cJSON_Raw (1 << 7) /* raw json */
116
117#define cJSON_IsReference 256
118#define cJSON_StringIsConst 512
119
120/* The cJSON structure: */
121 typedef struct cJSON
122{
123 /* next/prev allow you to walk array/object chains. Alternatively, use GetArraySize/GetArrayItem/GetObjectItem */
124 struct cJSON *next;
125 struct cJSON *prev;
126 /* An array or object item will have a child pointer pointing to a chain of the items in the array/object. */
127 struct cJSON *child;
128
129 /* The type of the item, as above. */
130 int type;
131
132 /* writing to valueint is DEPRECATED, use cJSON_SetNumberValue instead */
133 int valueint;
134 /* The item's string, if type==cJSON_String and type == cJSON_Raw */
135 char *valuestring;
136 /* The item's number, if type==cJSON_Number */
137 double valuedouble;
138
139 /* The item's name string, if this item is the child of, or is in the list of subitems of an object. */
140 char *string;
141} cJSON;
142
143 typedef struct cJSON_Hooks
144{
145 /* malloc/free are CDECL on Windows regardless of the default calling convention of the compiler, so ensure the hooks allow passing those functions directly. */
146 void *(CJSON_CDECL *malloc_fn)(size_t sz);
147 void (CJSON_CDECL *free_fn)(void *ptr);
148} cJSON_Hooks;
149
150 typedef int cJSON_bool;
151
152/* Limits how deeply nested arrays/objects can be before cJSON rejects to parse them.
153 * This is to prevent stack overflows. */
154#ifndef CJSON_NESTING_LIMIT
155#define CJSON_NESTING_LIMIT 1000
156#endif
157
158/* returns the version of cJSON as a string */
159 CJSON_PUBLIC(const char*) cJSON_Version(void);
160
161/* Supply malloc, realloc and free functions to cJSON */
162 CJSON_PUBLIC(void) cJSON_InitHooks(cJSON_Hooks* hooks);
163
164/* Memory Management: the caller is always responsible to free the results from all variants of cJSON_Parse (with cJSON_Delete) and cJSON_Print (with stdlib free, cJSON_Hooks.free_fn, or cJSON_free as appropriate). The exception is cJSON_PrintPreallocated, where the caller has full responsibility of the buffer. */
165/* Supply a block of JSON, and this returns a cJSON object you can interrogate. */
166 CJSON_PUBLIC(cJSON *) cJSON_Parse(const char *value);
167 CJSON_PUBLIC(cJSON *) cJSON_ParseWithLength(const char *value, size_t buffer_length);
168/* ParseWithOpts allows you to require (and check) that the JSON is null terminated, and to retrieve the pointer to the final byte parsed. */
169/* If you supply a ptr in return_parse_end and parsing fails, then return_parse_end will contain a pointer to the error so will match cJSON_GetErrorPtr(). */
170 CJSON_PUBLIC(cJSON *) cJSON_ParseWithOpts(const char *value, const char **return_parse_end, cJSON_bool require_null_terminated);
171 CJSON_PUBLIC(cJSON *) cJSON_ParseWithLengthOpts(const char *value, size_t buffer_length, const char **return_parse_end, cJSON_bool require_null_terminated);
172
173/* Render a cJSON entity to text for transfer/storage. */
174 CJSON_PUBLIC(char *) cJSON_Print(const cJSON *item);
175/* Render a cJSON entity to text for transfer/storage without any formatting. */
176 CJSON_PUBLIC(char *) cJSON_PrintUnformatted(const cJSON *item);
177/* Render a cJSON entity to text using a buffered strategy. prebuffer is a guess at the final size. guessing well reduces reallocation. fmt=0 gives unformatted, =1 gives formatted */
178 CJSON_PUBLIC(char *) cJSON_PrintBuffered(const cJSON *item, int prebuffer, cJSON_bool fmt);
179/* Render a cJSON entity to text using a buffer already allocated in memory with given length. Returns 1 on success and 0 on failure. */
180/* NOTE: cJSON is not always 100% accurate in estimating how much memory it will use, so to be safe allocate 5 bytes more than you actually need */
181 CJSON_PUBLIC(cJSON_bool) cJSON_PrintPreallocated(cJSON *item, char *buffer, const int length, const cJSON_bool format);
182/* Delete a cJSON entity and all subentities. */
183 CJSON_PUBLIC(void) cJSON_Delete(cJSON *item);
184
185/* Returns the number of items in an array (or object). */
186 CJSON_PUBLIC(int) cJSON_GetArraySize(const cJSON *array);
187/* Retrieve item number "index" from array "array". Returns NULL if unsuccessful. */
188 CJSON_PUBLIC(cJSON *) cJSON_GetArrayItem(const cJSON *array, int index);
189/* Get item "string" from object. Case insensitive. */
190 CJSON_PUBLIC(cJSON *) cJSON_GetObjectItem(const cJSON * const object, const char * const string);
191 CJSON_PUBLIC(cJSON *) cJSON_GetObjectItemCaseSensitive(const cJSON * const object, const char * const string);
192 CJSON_PUBLIC(cJSON_bool) cJSON_HasObjectItem(const cJSON *object, const char *string);
193/* For analysing failed parses. This returns a pointer to the parse error. You'll probably need to look a few chars back to make sense of it. Defined when cJSON_Parse() returns 0. 0 when cJSON_Parse() succeeds. */
194 CJSON_PUBLIC(const char *) cJSON_GetErrorPtr(void);
195
196/* Check item type and return its value */
197 CJSON_PUBLIC(char *) cJSON_GetStringValue(const cJSON * const item);
198 CJSON_PUBLIC(double) cJSON_GetNumberValue(const cJSON * const item);
199
200/* These functions check the type of an item */
201 CJSON_PUBLIC(cJSON_bool) cJSON_IsInvalid(const cJSON * const item);
202 CJSON_PUBLIC(cJSON_bool) cJSON_IsFalse(const cJSON * const item);
203 CJSON_PUBLIC(cJSON_bool) cJSON_IsTrue(const cJSON * const item);
204 CJSON_PUBLIC(cJSON_bool) cJSON_IsBool(const cJSON * const item);
205 CJSON_PUBLIC(cJSON_bool) cJSON_IsNull(const cJSON * const item);
206 CJSON_PUBLIC(cJSON_bool) cJSON_IsNumber(const cJSON * const item);
207 CJSON_PUBLIC(cJSON_bool) cJSON_IsString(const cJSON * const item);
208 CJSON_PUBLIC(cJSON_bool) cJSON_IsArray(const cJSON * const item);
209 CJSON_PUBLIC(cJSON_bool) cJSON_IsObject(const cJSON * const item);
210 CJSON_PUBLIC(cJSON_bool) cJSON_IsRaw(const cJSON * const item);
211
212/* These calls create a cJSON item of the appropriate type. */
213 CJSON_PUBLIC(cJSON *) cJSON_CreateNull(void);
214 CJSON_PUBLIC(cJSON *) cJSON_CreateTrue(void);
215 CJSON_PUBLIC(cJSON *) cJSON_CreateFalse(void);
216 CJSON_PUBLIC(cJSON *) cJSON_CreateBool(cJSON_bool boolean);
217 CJSON_PUBLIC(cJSON *) cJSON_CreateNumber(double num);
218 CJSON_PUBLIC(cJSON *) cJSON_CreateString(const char *string);
219/* raw json */
220 CJSON_PUBLIC(cJSON *) cJSON_CreateRaw(const char *raw);
221 CJSON_PUBLIC(cJSON *) cJSON_CreateArray(void);
222 CJSON_PUBLIC(cJSON *) cJSON_CreateObject(void);
223
224/* Create a string where valuestring references a string so
225 * it will not be freed by cJSON_Delete */
226 CJSON_PUBLIC(cJSON *) cJSON_CreateStringReference(const char *string);
227/* Create an object/array that only references it's elements so
228 * they will not be freed by cJSON_Delete */
229 CJSON_PUBLIC(cJSON *) cJSON_CreateObjectReference(const cJSON *child);
230 CJSON_PUBLIC(cJSON *) cJSON_CreateArrayReference(const cJSON *child);
231
232/* These utilities create an Array of count items.
233 * The parameter count cannot be greater than the number of elements in the number array, otherwise array access will be out of bounds.*/
234 CJSON_PUBLIC(cJSON *) cJSON_CreateIntArray(const int *numbers, int count);
235 CJSON_PUBLIC(cJSON *) cJSON_CreateFloatArray(const float *numbers, int count);
236 CJSON_PUBLIC(cJSON *) cJSON_CreateDoubleArray(const double *numbers, int count);
237 CJSON_PUBLIC(cJSON *) cJSON_CreateStringArray(const char *const *strings, int count);
238
239/* Append item to the specified array/object. */
240 CJSON_PUBLIC(cJSON_bool) cJSON_AddItemToArray(cJSON *array, cJSON *item);
241 CJSON_PUBLIC(cJSON_bool) cJSON_AddItemToObject(cJSON *object, const char *string, cJSON *item);
242/* Use this when string is definitely const (i.e. a literal, or as good as), and will definitely survive the cJSON object.
243 * WARNING: When this function was used, make sure to always check that (item->type & cJSON_StringIsConst) is zero before
244 * writing to `item->string` */
245 CJSON_PUBLIC(cJSON_bool) cJSON_AddItemToObjectCS(cJSON *object, const char *string, cJSON *item);
246/* Append reference to item to the specified array/object. Use this when you want to add an existing cJSON to a new cJSON, but don't want to corrupt your existing cJSON. */
247 CJSON_PUBLIC(cJSON_bool) cJSON_AddItemReferenceToArray(cJSON *array, cJSON *item);
248 CJSON_PUBLIC(cJSON_bool) cJSON_AddItemReferenceToObject(cJSON *object, const char *string, cJSON *item);
249
250/* Remove/Detach items from Arrays/Objects. */
251 CJSON_PUBLIC(cJSON *) cJSON_DetachItemViaPointer(cJSON *parent, cJSON * const item);
252 CJSON_PUBLIC(cJSON *) cJSON_DetachItemFromArray(cJSON *array, int which);
253 CJSON_PUBLIC(void) cJSON_DeleteItemFromArray(cJSON *array, int which);
254 CJSON_PUBLIC(cJSON *) cJSON_DetachItemFromObject(cJSON *object, const char *string);
255 CJSON_PUBLIC(cJSON *) cJSON_DetachItemFromObjectCaseSensitive(cJSON *object, const char *string);
256 CJSON_PUBLIC(void) cJSON_DeleteItemFromObject(cJSON *object, const char *string);
257 CJSON_PUBLIC(void) cJSON_DeleteItemFromObjectCaseSensitive(cJSON *object, const char *string);
258
259/* Update array items. */
260 CJSON_PUBLIC(cJSON_bool) cJSON_InsertItemInArray(cJSON *array, int which, cJSON *newitem); /* Shifts pre-existing items to the right. */
261 CJSON_PUBLIC(cJSON_bool) cJSON_ReplaceItemViaPointer(cJSON * const parent, cJSON * const item, cJSON * replacement);
262 CJSON_PUBLIC(cJSON_bool) cJSON_ReplaceItemInArray(cJSON *array, int which, cJSON *newitem);
263 CJSON_PUBLIC(cJSON_bool) cJSON_ReplaceItemInObject(cJSON *object,const char *string,cJSON *newitem);
264 CJSON_PUBLIC(cJSON_bool) cJSON_ReplaceItemInObjectCaseSensitive(cJSON *object,const char *string,cJSON *newitem);
265
266/* Duplicate a cJSON item */
267 CJSON_PUBLIC(cJSON *) cJSON_Duplicate(const cJSON *item, cJSON_bool recurse);
268/* Duplicate will create a new, identical cJSON item to the one you pass, in new memory that will
269 * need to be released. With recurse!=0, it will duplicate any children connected to the item.
270 * The item->next and ->prev pointers are always zero on return from Duplicate. */
271/* Recursively compare two cJSON items for equality. If either a or b is NULL or invalid, they will be considered unequal.
272 * case_sensitive determines if object keys are treated case sensitive (1) or case insensitive (0) */
273 CJSON_PUBLIC(cJSON_bool) cJSON_Compare(const cJSON * const a, const cJSON * const b, const cJSON_bool case_sensitive);
274
275/* Minify a strings, remove blank characters(such as ' ', '\t', '\r', '\n') from strings.
276 * The input pointer json cannot point to a read-only address area, such as a string constant,
277 * but should point to a readable and writable adress area. */
278 CJSON_PUBLIC(void) cJSON_Minify(char *json);
279
280/* Helper functions for creating and adding items to an object at the same time.
281 * They return the added item or NULL on failure. */
282 CJSON_PUBLIC(cJSON*) cJSON_AddNullToObject(cJSON * const object, const char * const name);
283 CJSON_PUBLIC(cJSON*) cJSON_AddTrueToObject(cJSON * const object, const char * const name);
284 CJSON_PUBLIC(cJSON*) cJSON_AddFalseToObject(cJSON * const object, const char * const name);
285 CJSON_PUBLIC(cJSON*) cJSON_AddBoolToObject(cJSON * const object, const char * const name, const cJSON_bool boolean);
286 CJSON_PUBLIC(cJSON*) cJSON_AddNumberToObject(cJSON * const object, const char * const name, const double number);
287 CJSON_PUBLIC(cJSON*) cJSON_AddStringToObject(cJSON * const object, const char * const name, const char * const string);
288 CJSON_PUBLIC(cJSON*) cJSON_AddRawToObject(cJSON * const object, const char * const name, const char * const raw);
289 CJSON_PUBLIC(cJSON*) cJSON_AddObjectToObject(cJSON * const object, const char * const name);
290 CJSON_PUBLIC(cJSON*) cJSON_AddArrayToObject(cJSON * const object, const char * const name);
291
292/* When assigning an integer value, it needs to be propagated to valuedouble too. */
293#define cJSON_SetIntValue(object, number) ((object) ? (object)->valueint = (object)->valuedouble = (number) : (number))
294/* helper for the cJSON_SetNumberValue macro */
295 CJSON_PUBLIC(double) cJSON_SetNumberHelper(cJSON *object, double number);
296#define cJSON_SetNumberValue(object, number) ((object != NULL) ? cJSON_SetNumberHelper(object, (double)number) : (number))
297/* Change the valuestring of a cJSON_String object, only takes effect when type of object is cJSON_String */
298 CJSON_PUBLIC(char*) cJSON_SetValuestring(cJSON *object, const char *valuestring);
299
300/* Macro for iterating over an array or object */
301#define cJSON_ArrayForEach(element, array) for(element = (array != NULL) ? (array)->child : NULL; element != NULL; element = element->next)
302
303/* malloc/free objects using the malloc/free functions that have been set with cJSON_InitHooks */
304 CJSON_PUBLIC(void *) cJSON_malloc(size_t size);
305 CJSON_PUBLIC(void) cJSON_free(void *object);
306
307}
308
309#endif
CJSON_CDECL
#define CJSON_CDECL
Definition: cJSON.h:89
Aws
Definition: Api.h:17
Aws::case_sensitive
const cJSON *const const cJSON_bool case_sensitive
Definition: cJSON.h:273
Aws::name
const char *const name
Definition: cJSON.h:282
Aws::json
global_error json
Definition: cJSON.cpp:1118
Aws::cJSON_DetachItemViaPointer
return cJSON_DetachItemViaPointer(object, to_detach)
Aws::length
char const int length
Definition: cJSON.h:181
Aws::item
cJSON * item
Definition: cJSON.h:240
Aws::hooks
buffer hooks
Definition: cJSON.cpp:1129
Aws::format
char const int const cJSON_bool format
Definition: cJSON.h:181
Aws::a
cJSON * a
Definition: cJSON.cpp:2562
Aws::return_parse_end
const char ** return_parse_end
Definition: cJSON.h:170
Aws::child
cJSON * child
Definition: cJSON.cpp:2708
Aws::buffer_length
size_t buffer_length
Definition: cJSON.h:167
Aws::which
int which
Definition: cJSON.h:252
Aws::count
int count
Definition: cJSON.h:234
Aws::recurse
cJSON_bool recurse
Definition: cJSON.h:267
Aws::CJSON_PUBLIC
CJSON_PUBLIC(const char *) cJSON_Version(void)
Definition: cJSON.cpp:113
Aws::require_null_terminated
const char cJSON_bool require_null_terminated
Definition: cJSON.h:170
Aws::cJSON_Hooks
struct Aws::cJSON_Hooks cJSON_Hooks
Aws::buffer
char * buffer
Definition: cJSON.h:181
Aws::replacement
cJSON *const cJSON * replacement
Definition: cJSON.h:261
Aws::newitem
int cJSON * newitem
Definition: cJSON.h:260
Aws::cJSON
struct Aws::cJSON cJSON
Aws::valuestring
const char * valuestring
Definition: cJSON.h:298
Aws::raw
const char *const const char *const raw
Definition: cJSON.h:288
Aws::cJSON_ParseWithLengthOpts
return cJSON_ParseWithLengthOpts(value, buffer_length, return_parse_end, require_null_terminated)
Aws::index
int index
Definition: cJSON.h:188
Aws::b
const cJSON *const b
Definition: cJSON.h:273
Aws::cJSON_Delete
cJSON_Delete(null)
Aws::fmt
int cJSON_bool fmt
Definition: cJSON.h:178
Aws::number
const char *const const double number
Definition: cJSON.h:286
Aws::cJSON_bool
int cJSON_bool
Definition: cJSON.h:150
Aws::prebuffer
int prebuffer
Definition: cJSON.h:178
Aws::cJSON_Hooks
Definition: cJSON.h:144
Aws::cJSON_Hooks::malloc_fn
void *CJSON_CDECL * malloc_fn(size_t sz)
Aws::cJSON_Hooks::void
void(CJSON_CDECL *free_fn)(void *ptr)
Aws::cJSON
Definition: cJSON.h:122
Aws::cJSON::prev
struct cJSON * prev
Definition: cJSON.h:125
Aws::cJSON::valueint
int valueint
Definition: cJSON.h:133
Aws::cJSON::type
int type
Definition: cJSON.h:130
Aws::cJSON::string
char * string
Definition: cJSON.h:140
Aws::cJSON::valuestring
char * valuestring
Definition: cJSON.h:135
Aws::cJSON::valuedouble
double valuedouble
Definition: cJSON.h:137
Aws::cJSON::next
struct cJSON * next
Definition: cJSON.h:124
Aws::cJSON::child
struct cJSON * child
Definition: cJSON.h:127