aws-crt-cpp
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 
47 namespace Aws {
48 
49 /* project version */
50 #define CJSON_VERSION_MAJOR 1
51 #define CJSON_VERSION_MINOR 7
52 #define CJSON_VERSION_PATCH 7
53 
54 #include <stddef.h>
55 
56 /* cJSON Types: */
57 #define cJSON_Invalid (0)
58 #define cJSON_False (1 << 0)
59 #define cJSON_True (1 << 1)
60 #define cJSON_NULL (1 << 2)
61 #define cJSON_Number (1 << 3)
62 #define cJSON_String (1 << 4)
63 #define cJSON_Array (1 << 5)
64 #define cJSON_Object (1 << 6)
65 #define cJSON_Raw (1 << 7) /* raw json */
66 
67 #define cJSON_IsReference 256
68 #define cJSON_StringIsConst 512
69 
70 /* The cJSON structure: */
71  typedef struct cJSON {
72  /* next/prev allow you to walk array/object chains. Alternatively, use GetArraySize/GetArrayItem/GetObjectItem */
73  struct cJSON *next;
74  struct cJSON *prev;
75  /* An array or object item will have a child pointer pointing to a chain of the items in the array/object. */
76  struct cJSON *child;
77 
78  /* The type of the item, as above. */
79  int type;
80 
81  /* writing to valueint is DEPRECATED, use cJSON_SetNumberValue instead */
82  int valueint;
83 
84  /* The item's string, if type==cJSON_String and type == cJSON_Raw */
85  char *valuestring;
86 
87  /* The item's number, if type==cJSON_Number */
88  double valuedouble;
89 
90  /* The item's name string, if this item is the child of, or is in the list of subitems of an object. */
91  char *string;
92  } cJSON;
93 
94  typedef struct cJSON_Hooks {
95  void *(*malloc_fn)(size_t sz);
96 
97  void (*free_fn)(void *ptr);
99 
100  typedef int cJSON_bool;
101 
102 #if !defined(__WINDOWS__) && (defined(WIN32) || defined(WIN64) || defined(_MSC_VER) || defined(_WIN32))
103 #define __WINDOWS__
104 #endif
105 #ifdef __WINDOWS__
106 
107  /* 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 2 define options:
108 
109  CJSON_HIDE_SYMBOLS - Define this in the case where you don't want to ever dllexport symbols
110  CJSON_EXPORT_SYMBOLS - Define this on library build when you want to dllexport symbols (default)
111  CJSON_IMPORT_SYMBOLS - Define this if you want to dllimport symbol
112 
113  For *nix builds that support visibility attribute, you can define similar behavior by
114 
115  setting default visibility to hidden by adding
116  -fvisibility=hidden (for gcc)
117  or
118  -xldscope=hidden (for sun cc)
119  to CFLAGS
120 
121  then using the CJSON_API_VISIBILITY flag to "export" the same symbols the way CJSON_EXPORT_SYMBOLS does
122 
123  */
124 
125  /* export symbols by default, this is necessary for copy pasting the C and header file */
126 #if !defined(CJSON_HIDE_SYMBOLS) && !defined(CJSON_IMPORT_SYMBOLS) && !defined(CJSON_EXPORT_SYMBOLS)
127 #define CJSON_EXPORT_SYMBOLS
128 #endif
129 
130 #if defined(CJSON_HIDE_SYMBOLS)
131 #define CJSON_PUBLIC(type) type __stdcall
132 #elif defined(CJSON_EXPORT_SYMBOLS)
133 #define CJSON_PUBLIC(type) __declspec(dllexport) type __stdcall
134 #elif defined(CJSON_IMPORT_SYMBOLS)
135 #define CJSON_PUBLIC(type) __declspec(dllimport) type __stdcall
136 #endif
137 #else /* !WIN32 */
138 #if (defined(__GNUC__) || defined(__SUNPRO_CC) || defined (__SUNPRO_C)) && defined(CJSON_API_VISIBILITY)
139 #define CJSON_PUBLIC(type) __attribute__((visibility("default"))) type
140 #else
141 #define CJSON_PUBLIC(type) type
142 #endif
143 #endif
144 
145 /* Limits how deeply nested arrays/objects can be before cJSON rejects to parse them.
146  * This is to prevent stack overflows. */
147 #ifndef CJSON_NESTING_LIMIT
148 #define CJSON_NESTING_LIMIT 1000
149 #endif
150 
151 /* returns the version of cJSON as a string */
152  CJSON_PUBLIC(const char*)cJSON_Version(void);
153 
154 /* Supply malloc, realloc and free functions to cJSON */
155  CJSON_PUBLIC(void) cJSON_InitHooks(cJSON_Hooks *hooks);
156 
157 /* 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. */
158 /* Supply a block of JSON, and this returns a cJSON object you can interrogate. */
159  CJSON_PUBLIC(cJSON *)cJSON_Parse(const char *value, size_t length);
160 /* ParseWithOpts allows you to require (and check) that the JSON is null terminated, and to retrieve the pointer to the final byte parsed. */
161 /* 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(). */
162  CJSON_PUBLIC(cJSON *)cJSON_ParseWithOpts(const char *value, size_t length, const char **return_parse_end);
163 
164 /* Render a cJSON entity to text for transfer/storage. */
165  CJSON_PUBLIC(char *)cJSON_Print(const cJSON *item);
166 /* Render a cJSON entity to text for transfer/storage without any formatting. */
167  CJSON_PUBLIC(char *)cJSON_PrintUnformatted(const cJSON *item);
168 /* 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 */
169  CJSON_PUBLIC(char *)cJSON_PrintBuffered(const cJSON *item, int prebuffer, cJSON_bool fmt);
170 /* Render a cJSON entity to text using a buffer already allocated in memory with given length. Returns 1 on success and 0 on failure. */
171 /* 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 */
174 /* Delete a cJSON entity and all subentities. */
175  CJSON_PUBLIC(void) cJSON_Delete(cJSON *c);
176 
177 /* Returns the number of items in an array (or object). */
178  CJSON_PUBLIC(int) cJSON_GetArraySize(const cJSON *array);
179 /* Retrieve item number "index" from array "array". Returns NULL if unsuccessful. */
180  CJSON_PUBLIC(cJSON *)cJSON_GetArrayItem(const cJSON *array, int index);
181 /* Get item "string" from object. Case insensitive. */
182  CJSON_PUBLIC(cJSON *)cJSON_GetObjectItem(const cJSON *const object, const char *const string);
183 
184  CJSON_PUBLIC(cJSON *)cJSON_GetObjectItemCaseSensitive(const cJSON *const object, const char *const string);
185 
186  CJSON_PUBLIC(cJSON_bool) cJSON_HasObjectItem(const cJSON *object, const char *string);
187 /* 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. */
188  CJSON_PUBLIC(const char *)cJSON_GetErrorPtr(void);
189 
190 /* Check if the item is a string and return its valuestring */
191  CJSON_PUBLIC(char *)cJSON_GetStringValue(cJSON *item);
192 
193 /* These functions check the type of an item */
194  CJSON_PUBLIC(cJSON_bool) cJSON_IsInvalid(const cJSON *const item);
195 
196  CJSON_PUBLIC(cJSON_bool) cJSON_IsFalse(const cJSON *const item);
197 
198  CJSON_PUBLIC(cJSON_bool) cJSON_IsTrue(const cJSON *const item);
199 
200  CJSON_PUBLIC(cJSON_bool) cJSON_IsBool(const cJSON *const item);
201 
202  CJSON_PUBLIC(cJSON_bool) cJSON_IsNull(const cJSON *const item);
203 
204  CJSON_PUBLIC(cJSON_bool) cJSON_IsNumber(const cJSON *const item);
205 
206  CJSON_PUBLIC(cJSON_bool) cJSON_IsString(const cJSON *const item);
207 
208  CJSON_PUBLIC(cJSON_bool) cJSON_IsArray(const cJSON *const item);
209 
210  CJSON_PUBLIC(cJSON_bool) cJSON_IsObject(const cJSON *const item);
211 
212  CJSON_PUBLIC(cJSON_bool) cJSON_IsRaw(const cJSON *const item);
213 
214 /* These calls create a cJSON item of the appropriate type. */
215  CJSON_PUBLIC(cJSON *)cJSON_CreateNull(void);
216 
217  CJSON_PUBLIC(cJSON *)cJSON_CreateTrue(void);
218 
219  CJSON_PUBLIC(cJSON *)cJSON_CreateFalse(void);
220 
221  CJSON_PUBLIC(cJSON *)cJSON_CreateBool(cJSON_bool boolean);
222 
223  CJSON_PUBLIC(cJSON *)cJSON_CreateNumber(double num);
224 
225  CJSON_PUBLIC(cJSON *)cJSON_CreateString(const char *string);
226 /* raw json */
227  CJSON_PUBLIC(cJSON *)cJSON_CreateRaw(const char *raw);
228 
229  CJSON_PUBLIC(cJSON *)cJSON_CreateArray(void);
230 
231  CJSON_PUBLIC(cJSON *)cJSON_CreateObject(void);
232 
233 /* Create a string where valuestring references a string so
234  * it will not be freed by cJSON_Delete */
235  CJSON_PUBLIC(cJSON *)cJSON_CreateStringReference(const char *string);
236 /* Create an object/arrray that only references it's elements so
237  * they will not be freed by cJSON_Delete */
238  CJSON_PUBLIC(cJSON *)cJSON_CreateObjectReference(const cJSON *child);
239 
240  CJSON_PUBLIC(cJSON *)cJSON_CreateArrayReference(const cJSON *child);
241 
242 /* These utilities create an Array of count items. */
243  CJSON_PUBLIC(cJSON *)cJSON_CreateIntArray(const int *numbers, int count);
244 
245  CJSON_PUBLIC(cJSON *)cJSON_CreateFloatArray(const float *numbers, int count);
246 
247  CJSON_PUBLIC(cJSON *)cJSON_CreateDoubleArray(const double *numbers, int count);
248 
249  CJSON_PUBLIC(cJSON *)cJSON_CreateStringArray(const char **strings, int count);
250 
251 /* Append item to the specified array/object. */
252  CJSON_PUBLIC(void) cJSON_AddItemToArray(cJSON *array, cJSON *item);
253 
254  CJSON_PUBLIC(void) cJSON_AddItemToObject(cJSON *object, const char *string, cJSON *item);
255 /* Use this when string is definitely const (i.e. a literal, or as good as), and will definitely survive the cJSON object.
256  * WARNING: When this function was used, make sure to always check that (item->type & cJSON_StringIsConst) is zero before
257  * writing to `item->string` */
258  CJSON_PUBLIC(void) cJSON_AddItemToObjectCS(cJSON *object, const char *string, cJSON *item);
259 /* 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. */
260  CJSON_PUBLIC(void) cJSON_AddItemReferenceToArray(cJSON *array, cJSON *item);
261 
262  CJSON_PUBLIC(void) cJSON_AddItemReferenceToObject(cJSON *object, const char *string, cJSON *item);
263 
264 /* Remove/Detatch items from Arrays/Objects. */
266 
267  CJSON_PUBLIC(cJSON *)cJSON_DetachItemFromArray(cJSON *array, int which);
268 
269  CJSON_PUBLIC(void) cJSON_DeleteItemFromArray(cJSON *array, int which);
270 
271  CJSON_PUBLIC(cJSON *)cJSON_DetachItemFromObject(cJSON *object, const char *string);
272 
273  CJSON_PUBLIC(cJSON *)cJSON_DetachItemFromObjectCaseSensitive(cJSON *object, const char *string);
274 
275  CJSON_PUBLIC(void) cJSON_DeleteItemFromObject(cJSON *object, const char *string);
276 
277  CJSON_PUBLIC(void) cJSON_DeleteItemFromObjectCaseSensitive(cJSON *object, const char *string);
278 
279 /* Update array items. */
280  CJSON_PUBLIC(void)
281  cJSON_InsertItemInArray(cJSON *array, int which, cJSON *newitem); /* Shifts pre-existing items to the right. */
282  CJSON_PUBLIC(cJSON_bool) cJSON_ReplaceItemViaPointer(cJSON *const parent, cJSON *const item, cJSON *replacement);
283 
284  CJSON_PUBLIC(void) cJSON_ReplaceItemInArray(cJSON *array, int which, cJSON *newitem);
285 
286  CJSON_PUBLIC(void) cJSON_ReplaceItemInObject(cJSON *object, const char *string, cJSON *newitem);
287 
288  CJSON_PUBLIC(void) cJSON_ReplaceItemInObjectCaseSensitive(cJSON *object, const char *string, cJSON *newitem);
289 
290 /* Duplicate a cJSON item */
291  CJSON_PUBLIC(cJSON *)cJSON_Duplicate(const cJSON *item, cJSON_bool recurse);
292 /* Duplicate will create a new, identical cJSON item to the one you pass, in new memory that will
293 need to be released. With recurse!=0, it will duplicate any children connected to the item.
294 The item->next and ->prev pointers are always zero on return from Duplicate. */
295 /* Recursively compare two cJSON items for equality. If either a or b is NULL or invalid, they will be considered unequal.
296  * case_sensitive determines if object keys are treated case sensitive (1) or case insensitive (0) */
298 
299 
300  CJSON_PUBLIC(void) cJSON_Minify(char *json);
301 
302 /* Helper functions for creating and adding items to an object at the same time.
303  * They return the added item or NULL on failure. */
304  CJSON_PUBLIC(cJSON*)cJSON_AddNullToObject(cJSON *const object, const char *const name);
305 
306  CJSON_PUBLIC(cJSON*)cJSON_AddTrueToObject(cJSON *const object, const char *const name);
307 
308  CJSON_PUBLIC(cJSON*)cJSON_AddFalseToObject(cJSON *const object, const char *const name);
309 
310  CJSON_PUBLIC(cJSON*)cJSON_AddBoolToObject(cJSON *const object, const char *const name, const cJSON_bool boolean);
311 
312  CJSON_PUBLIC(cJSON*)cJSON_AddNumberToObject(cJSON *const object, const char *const name, const double number);
313 
314  CJSON_PUBLIC(cJSON*)cJSON_AddStringToObject(cJSON *const object, const char *const name, const char *const string);
315 
316  CJSON_PUBLIC(cJSON*)cJSON_AddRawToObject(cJSON *const object, const char *const name, const char *const raw);
317 
318  CJSON_PUBLIC(cJSON*)cJSON_AddObjectToObject(cJSON *const object, const char *const name);
319 
320  CJSON_PUBLIC(cJSON*)cJSON_AddArrayToObject(cJSON *const object, const char *const name);
321 
322 /* When assigning an integer value, it needs to be propagated to valuedouble too. */
323 #define cJSON_SetIntValue(object, number) ((object) ? (object)->valueint = (object)->valuedouble = (number) : (number))
324 /* helper for the cJSON_SetNumberValue macro */
325  CJSON_PUBLIC(double) cJSON_SetNumberHelper(cJSON *object, double number);
326 
327 #define cJSON_SetNumberValue(object, number) ((object != NULL) ? cJSON_SetNumberHelper(object, (double)number) : (number))
328 
329 /* Macro for iterating over an array or object */
330 #define cJSON_ArrayForEach(element, array) for(element = (array != NULL) ? (array)->child : NULL; element != NULL; element = element->next)
331 
332 /* malloc/free objects using the malloc/free functions that have been set with cJSON_InitHooks */
333  CJSON_PUBLIC(void *)cJSON_malloc(size_t size);
334 
335  CJSON_PUBLIC(void) cJSON_free(void *object);
336 
337 }
338 
339 #endif
Aws::cJSON
Definition: cJSON.h:71
Aws::cJSON_Delete
cJSON_Delete(null)
Aws::json
global_error json
Definition: cJSON.cpp:899
Aws::length
size_t length
Definition: cJSON.h:159
Aws::count
int count
Definition: cJSON.h:243
Aws::cJSON_Hooks
struct Aws::cJSON_Hooks cJSON_Hooks
Aws::cJSON_Compare
cJSON_Compare(const cJSON *const a, const cJSON *const b, const cJSON_bool case_sensitive)
Definition: cJSON.cpp:2389
Aws::replacement
cJSON *const cJSON * replacement
Definition: cJSON.h:282
Aws::cJSON_PrintPreallocated
cJSON_PrintPreallocated(cJSON *item, char *buffer, const int length, const cJSON_bool format)
Aws::cJSON_InsertItemInArray
cJSON_InsertItemInArray(cJSON *array, int which, cJSON *newitem)
Aws::cJSON::type
int type
Definition: cJSON.h:79
Aws::raw
const char *const const char *const raw
Definition: cJSON.h:316
Aws::cJSON::valuedouble
double valuedouble
Definition: cJSON.h:88
Aws::cJSON
struct Aws::cJSON cJSON
Aws::buffer
p buffer
Definition: cJSON.cpp:1033
Aws::case_sensitive
const cJSON *const const cJSON_bool case_sensitive
Definition: cJSON.h:297
Aws::fmt
int cJSON_bool fmt
Definition: cJSON.h:169
Aws::name
const char *const name
Definition: cJSON.h:304
Aws::cJSON_Hooks
Definition: cJSON.h:94
Aws::cJSON::valueint
int valueint
Definition: cJSON.h:82
Aws::newitem
int cJSON * newitem
Definition: cJSON.h:284
Aws::item
cJSON * item
Definition: cJSON.h:252
Aws::cJSON_Hooks::free_fn
void(* free_fn)(void *ptr)
Definition: cJSON.h:97
Aws::cJSON::valuestring
char * valuestring
Definition: cJSON.h:85
Aws::format
p format
Definition: cJSON.cpp:1041
Aws::cJSON::string
char * string
Definition: cJSON.h:91
Aws
Definition: Api.h:25
Aws::cJSON_DetachItemViaPointer
return cJSON_DetachItemViaPointer(object, to_detach)
Aws::prebuffer
int prebuffer
Definition: cJSON.h:169
Aws::cJSON_bool
int cJSON_bool
Definition: cJSON.h:100
Aws::CJSON_PUBLIC
CJSON_PUBLIC(const char *) cJSON_Version(void)
Definition: cJSON.cpp:93
Aws::return_parse_end
size_t const char ** return_parse_end
Definition: cJSON.h:162
Aws::child
cJSON * child
Definition: cJSON.cpp:2195
Aws::a
cJSON * a
Definition: cJSON.cpp:2081
Aws::cJSON::prev
struct cJSON * prev
Definition: cJSON.h:74
Aws::b
const cJSON *const b
Definition: cJSON.h:297
Aws::cJSON::child
struct cJSON * child
Definition: cJSON.h:76
Aws::cJSON::next
struct cJSON * next
Definition: cJSON.h:73
Aws::number
const char *const const double number
Definition: cJSON.h:312
Aws::hooks
buffer hooks
Definition: cJSON.cpp:909
Aws::index
int index
Definition: cJSON.h:180
Aws::which
int which
Definition: cJSON.h:267
Aws::recurse
cJSON_bool recurse
Definition: cJSON.h:291