AWS SDK for C++  1.9.68
AWS SDK for C++
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 
23 #ifndef cJSON__h
24 #define cJSON__h
25 
26 #ifdef __cplusplus
27 extern "C"
28 {
29 #endif
30 
31 #if !defined(__WINDOWS__) && (defined(WIN32) || defined(WIN64) || defined(_MSC_VER) || defined(_WIN32))
32 #define __WINDOWS__
33 #endif
34 
35 #ifdef __WINDOWS__
36 
37 /* 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:
38 
39 CJSON_HIDE_SYMBOLS - Define this in the case where you don't want to ever dllexport symbols
40 CJSON_EXPORT_SYMBOLS - Define this on library build when you want to dllexport symbols (default)
41 CJSON_IMPORT_SYMBOLS - Define this if you want to dllimport symbol
42 
43 For *nix builds that support visibility attribute, you can define similar behavior by
44 
45 setting default visibility to hidden by adding
46 -fvisibility=hidden (for gcc)
47 or
48 -xldscope=hidden (for sun cc)
49 to CFLAGS
50 
51 then using the CJSON_API_VISIBILITY flag to "export" the same symbols the way CJSON_EXPORT_SYMBOLS does
52 
53 */
54 
55 #define CJSON_CDECL __cdecl
56 #define CJSON_STDCALL __stdcall
57 
58 /* Decide calling convention based on the cmake parameters defined in C++ SDK. */
59 #ifdef USE_IMPORT_EXPORT
60 #ifdef AWS_CORE_EXPORTS
61 #define CJSON_EXPORT_SYMBOLS
62 #else
63 #define CJSON_IMPORT_SYMBOLS
64 #endif // AWS_CORE_EXPORTS
65 #else
66 #define CJSON_HIDE_SYMBOLS
67 #endif // USE_IMPORT_EXPORT
68 
69 /* export symbols by default, this is necessary for copy pasting the C and header file */
70 #if !defined(CJSON_HIDE_SYMBOLS) && !defined(CJSON_IMPORT_SYMBOLS) && !defined(CJSON_EXPORT_SYMBOLS)
71 #define CJSON_EXPORT_SYMBOLS
72 #endif
73 
74 #if defined(CJSON_HIDE_SYMBOLS)
75 #define CJSON_PUBLIC(type) type CJSON_STDCALL
76 #elif defined(CJSON_EXPORT_SYMBOLS)
77 #define CJSON_PUBLIC(type) __declspec(dllexport) type CJSON_STDCALL
78 #elif defined(CJSON_IMPORT_SYMBOLS)
79 #define CJSON_PUBLIC(type) __declspec(dllimport) type CJSON_STDCALL
80 #endif
81 #else /* !__WINDOWS__ */
82 #define CJSON_CDECL
83 #define CJSON_STDCALL
84 
85 #if (defined(__GNUC__) || defined(__SUNPRO_CC) || defined (__SUNPRO_C)) && defined(CJSON_API_VISIBILITY)
86 #define CJSON_PUBLIC(type) __attribute__((visibility("default"))) type
87 #else
88 #define CJSON_PUBLIC(type) type
89 #endif
90 #endif
91 
92 /* project version */
93 #define CJSON_VERSION_MAJOR 1
94 #define CJSON_VERSION_MINOR 7
95 #define CJSON_VERSION_PATCH 14
96 
97 #include <stddef.h>
98 
99 /* cJSON Types: */
100 #define cJSON_Invalid (0)
101 #define cJSON_False (1 << 0)
102 #define cJSON_True (1 << 1)
103 #define cJSON_NULL (1 << 2)
104 #define cJSON_Number (1 << 3)
105 #define cJSON_String (1 << 4)
106 #define cJSON_Array (1 << 5)
107 #define cJSON_Object (1 << 6)
108 #define cJSON_Raw (1 << 7) /* raw json */
109 
110 #define cJSON_IsReference 256
111 #define cJSON_StringIsConst 512
112 
113 /* The cJSON structure: */
114 typedef struct cJSON
115 {
116  /* next/prev allow you to walk array/object chains. Alternatively, use GetArraySize/GetArrayItem/GetObjectItem */
117  struct cJSON *next;
118  struct cJSON *prev;
119  /* An array or object item will have a child pointer pointing to a chain of the items in the array/object. */
120  struct cJSON *child;
121 
122  /* The type of the item, as above. */
123  int type;
124 
125  /* The item's string, if type==cJSON_String and type == cJSON_Raw */
126  char *valuestring;
127  /* writing to valueint is DEPRECATED, use cJSON_SetNumberValue instead */
128  int valueint;
129  /* The item's number, if type==cJSON_Number */
130  double valuedouble;
131 
132  /* The item's name string, if this item is the child of, or is in the list of subitems of an object. */
133  char *string;
135 
136 typedef struct cJSON_Hooks
137 {
138  /* malloc/free are CDECL on Windows regardless of the default calling convention of the compiler, so ensure the hooks allow passing those functions directly. */
139  void *(CJSON_CDECL *malloc_fn)(size_t sz);
140  void (CJSON_CDECL *free_fn)(void *ptr);
142 
143 typedef int cJSON_bool;
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);
160 CJSON_PUBLIC(cJSON *) cJSON_ParseWithLength(const char *value, size_t buffer_length);
161 /* ParseWithOpts allows you to require (and check) that the JSON is null terminated, and to retrieve the pointer to the final byte parsed. */
162 /* 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(). */
163 CJSON_PUBLIC(cJSON *) cJSON_ParseWithOpts(const char *value, const char **return_parse_end, cJSON_bool require_null_terminated);
164 CJSON_PUBLIC(cJSON *) cJSON_ParseWithLengthOpts(const char *value, size_t buffer_length, const char **return_parse_end, cJSON_bool require_null_terminated);
165 
166 /* Render a cJSON entity to text for transfer/storage. */
167 CJSON_PUBLIC(char *) cJSON_Print(const cJSON *item);
168 /* Render a cJSON entity to text for transfer/storage without any formatting. */
169 CJSON_PUBLIC(char *) cJSON_PrintUnformatted(const cJSON *item);
170 /* 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 */
171 CJSON_PUBLIC(char *) cJSON_PrintBuffered(const cJSON *item, int prebuffer, cJSON_bool fmt);
172 /* Render a cJSON entity to text using a buffer already allocated in memory with given length. Returns 1 on success and 0 on failure. */
173 /* 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 CJSON_PUBLIC(cJSON_bool) cJSON_PrintPreallocated(cJSON *item, char *buffer, const int length, const cJSON_bool format);
175 /* Delete a cJSON entity and all subentities. */
176 CJSON_PUBLIC(void) cJSON_Delete(cJSON *item);
177 
178 /* Returns the number of items in an array (or object). */
179 CJSON_PUBLIC(int) cJSON_GetArraySize(const cJSON *array);
180 /* Retrieve item number "index" from array "array". Returns NULL if unsuccessful. */
181 CJSON_PUBLIC(cJSON *) cJSON_GetArrayItem(const cJSON *array, int index);
182 /* Get item "string" from object. Case insensitive. */
183 CJSON_PUBLIC(cJSON *) cJSON_GetObjectItem(const cJSON * const object, const char * const string);
184 CJSON_PUBLIC(cJSON *) cJSON_GetObjectItemCaseSensitive(const cJSON * const object, const char * const string);
185 CJSON_PUBLIC(cJSON_bool) cJSON_HasObjectItem(const cJSON *object, const char *string);
186 /* 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. */
187 CJSON_PUBLIC(const char *) cJSON_GetErrorPtr(void);
188 
189 /* Check item type and return its value */
190 CJSON_PUBLIC(char *) cJSON_GetStringValue(const cJSON * const item);
191 CJSON_PUBLIC(double) cJSON_GetNumberValue(const cJSON * const item);
192 
193 /* These functions check the type of an item */
194 CJSON_PUBLIC(cJSON_bool) cJSON_IsInvalid(const cJSON * const item);
195 CJSON_PUBLIC(cJSON_bool) cJSON_IsFalse(const cJSON * const item);
196 CJSON_PUBLIC(cJSON_bool) cJSON_IsTrue(const cJSON * const item);
197 CJSON_PUBLIC(cJSON_bool) cJSON_IsBool(const cJSON * const item);
198 CJSON_PUBLIC(cJSON_bool) cJSON_IsNull(const cJSON * const item);
199 CJSON_PUBLIC(cJSON_bool) cJSON_IsNumber(const cJSON * const item);
200 CJSON_PUBLIC(cJSON_bool) cJSON_IsString(const cJSON * const item);
201 CJSON_PUBLIC(cJSON_bool) cJSON_IsArray(const cJSON * const item);
202 CJSON_PUBLIC(cJSON_bool) cJSON_IsObject(const cJSON * const item);
203 CJSON_PUBLIC(cJSON_bool) cJSON_IsRaw(const cJSON * const item);
204 
205 /* These calls create a cJSON item of the appropriate type. */
206 CJSON_PUBLIC(cJSON *) cJSON_CreateNull(void);
207 CJSON_PUBLIC(cJSON *) cJSON_CreateTrue(void);
208 CJSON_PUBLIC(cJSON *) cJSON_CreateFalse(void);
209 CJSON_PUBLIC(cJSON *) cJSON_CreateBool(cJSON_bool boolean);
210 CJSON_PUBLIC(cJSON *) cJSON_CreateNumber(double num);
211 CJSON_PUBLIC(cJSON *) cJSON_CreateInt64(long long num);
212 CJSON_PUBLIC(cJSON *) cJSON_CreateString(const char *string);
213 /* raw json */
214 CJSON_PUBLIC(cJSON *) cJSON_CreateRaw(const char *raw);
215 CJSON_PUBLIC(cJSON *) cJSON_CreateArray(void);
216 CJSON_PUBLIC(cJSON *) cJSON_CreateObject(void);
217 
218 /* Create a string where valuestring references a string so
219  * it will not be freed by cJSON_Delete */
220 CJSON_PUBLIC(cJSON *) cJSON_CreateStringReference(const char *string);
221 /* Create an object/array that only references it's elements so
222  * they will not be freed by cJSON_Delete */
223 CJSON_PUBLIC(cJSON *) cJSON_CreateObjectReference(const cJSON *child);
224 CJSON_PUBLIC(cJSON *) cJSON_CreateArrayReference(const cJSON *child);
225 
226 /* These utilities create an Array of count items.
227  * The parameter count cannot be greater than the number of elements in the number array, otherwise array access will be out of bounds.*/
228 CJSON_PUBLIC(cJSON *) cJSON_CreateIntArray(const int *numbers, int count);
229 CJSON_PUBLIC(cJSON *) cJSON_CreateFloatArray(const float *numbers, int count);
230 CJSON_PUBLIC(cJSON *) cJSON_CreateDoubleArray(const double *numbers, int count);
231 CJSON_PUBLIC(cJSON *) cJSON_CreateStringArray(const char *const *strings, int count);
232 
233 /* Append item to the specified array/object. */
234 CJSON_PUBLIC(cJSON_bool) cJSON_AddItemToArray(cJSON *array, cJSON *item);
235 CJSON_PUBLIC(cJSON_bool) cJSON_AddItemToObject(cJSON *object, const char *string, cJSON *item);
236 /* Use this when string is definitely const (i.e. a literal, or as good as), and will definitely survive the cJSON object.
237  * WARNING: When this function was used, make sure to always check that (item->type & cJSON_StringIsConst) is zero before
238  * writing to `item->string` */
239 CJSON_PUBLIC(cJSON_bool) cJSON_AddItemToObjectCS(cJSON *object, const char *string, cJSON *item);
240 /* 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. */
241 CJSON_PUBLIC(cJSON_bool) cJSON_AddItemReferenceToArray(cJSON *array, cJSON *item);
242 CJSON_PUBLIC(cJSON_bool) cJSON_AddItemReferenceToObject(cJSON *object, const char *string, cJSON *item);
243 
244 /* Remove/Detach items from Arrays/Objects. */
245 CJSON_PUBLIC(cJSON *) cJSON_DetachItemViaPointer(cJSON *parent, cJSON * const item);
246 CJSON_PUBLIC(cJSON *) cJSON_DetachItemFromArray(cJSON *array, int which);
247 CJSON_PUBLIC(void) cJSON_DeleteItemFromArray(cJSON *array, int which);
248 CJSON_PUBLIC(cJSON *) cJSON_DetachItemFromObject(cJSON *object, const char *string);
249 CJSON_PUBLIC(cJSON *) cJSON_DetachItemFromObjectCaseSensitive(cJSON *object, const char *string);
250 CJSON_PUBLIC(void) cJSON_DeleteItemFromObject(cJSON *object, const char *string);
251 CJSON_PUBLIC(void) cJSON_DeleteItemFromObjectCaseSensitive(cJSON *object, const char *string);
252 
253 /* Update array items. */
254 CJSON_PUBLIC(cJSON_bool) cJSON_InsertItemInArray(cJSON *array, int which, cJSON *newitem); /* Shifts pre-existing items to the right. */
255 CJSON_PUBLIC(cJSON_bool) cJSON_ReplaceItemViaPointer(cJSON * const parent, cJSON * const item, cJSON * replacement);
256 CJSON_PUBLIC(cJSON_bool) cJSON_ReplaceItemInArray(cJSON *array, int which, cJSON *newitem);
257 CJSON_PUBLIC(cJSON_bool) cJSON_ReplaceItemInObject(cJSON *object,const char *string,cJSON *newitem);
258 CJSON_PUBLIC(cJSON_bool) cJSON_ReplaceItemInObjectCaseSensitive(cJSON *object,const char *string,cJSON *newitem);
259 
260 /* Duplicate a cJSON item */
261 CJSON_PUBLIC(cJSON *) cJSON_Duplicate(const cJSON *item, cJSON_bool recurse);
262 /* Duplicate will create a new, identical cJSON item to the one you pass, in new memory that will
263  * need to be released. With recurse!=0, it will duplicate any children connected to the item.
264  * The item->next and ->prev pointers are always zero on return from Duplicate. */
265 /* Recursively compare two cJSON items for equality. If either a or b is NULL or invalid, they will be considered unequal.
266  * case_sensitive determines if object keys are treated case sensitive (1) or case insensitive (0) */
267 CJSON_PUBLIC(cJSON_bool) cJSON_Compare(const cJSON * const a, const cJSON * const b, const cJSON_bool case_sensitive);
268 
269 /* Minify a strings, remove blank characters(such as ' ', '\t', '\r', '\n') from strings.
270  * The input pointer json cannot point to a read-only address area, such as a string constant,
271  * but should point to a readable and writable address area. */
272 CJSON_PUBLIC(void) cJSON_Minify(char *json);
273 
274 /* Helper functions for creating and adding items to an object at the same time.
275  * They return the added item or NULL on failure. */
276 CJSON_PUBLIC(cJSON*) cJSON_AddNullToObject(cJSON * const object, const char * const name);
277 CJSON_PUBLIC(cJSON*) cJSON_AddTrueToObject(cJSON * const object, const char * const name);
278 CJSON_PUBLIC(cJSON*) cJSON_AddFalseToObject(cJSON * const object, const char * const name);
279 CJSON_PUBLIC(cJSON*) cJSON_AddBoolToObject(cJSON * const object, const char * const name, const cJSON_bool boolean);
280 CJSON_PUBLIC(cJSON*) cJSON_AddNumberToObject(cJSON * const object, const char * const name, const double number);
281 CJSON_PUBLIC(cJSON*) cJSON_AddStringToObject(cJSON * const object, const char * const name, const char * const string);
282 CJSON_PUBLIC(cJSON*) cJSON_AddRawToObject(cJSON * const object, const char * const name, const char * const raw);
283 CJSON_PUBLIC(cJSON*) cJSON_AddObjectToObject(cJSON * const object, const char * const name);
284 CJSON_PUBLIC(cJSON*) cJSON_AddArrayToObject(cJSON * const object, const char * const name);
285 
286 /* When assigning an integer value, it needs to be propagated to valuedouble too. */
287 #define cJSON_SetIntValue(object, number) ((object) ? (object)->valueint = (object)->valuedouble = (number) : (number))
288 /* helper for the cJSON_SetNumberValue macro */
289 CJSON_PUBLIC(double) cJSON_SetNumberHelper(cJSON *object, double number);
290 #define cJSON_SetNumberValue(object, number) ((object != NULL) ? cJSON_SetNumberHelper(object, (double)number) : (number))
291 /* Change the valuestring of a cJSON_String object, only takes effect when type of object is cJSON_String */
292 CJSON_PUBLIC(char*) cJSON_SetValuestring(cJSON *object, const char *valuestring);
293 
294 /* Macro for iterating over an array or object */
295 #define cJSON_ArrayForEach(element, array) for(element = (array != NULL) ? (array)->child : NULL; element != NULL; element = element->next)
296 
297 /* malloc/free objects using the malloc/free functions that have been set with cJSON_InitHooks */
298 CJSON_PUBLIC(void *) cJSON_malloc(size_t size);
299 CJSON_PUBLIC(void) cJSON_free(void *object);
300 
301 #ifdef __cplusplus
302 }
303 #endif
304 
305 #endif
raw
const char *const const char *const raw
Definition: cJSON.h:282
buffer
char * buffer
Definition: cJSON.h:174
name
const char *const name
Definition: cJSON.h:276
cJSON
Definition: cJSON.h:115
return_parse_end
const char ** return_parse_end
Definition: cJSON.h:163
cJSON::next
struct cJSON * next
Definition: cJSON.h:117
cJSON::valueint
int valueint
Definition: cJSON.h:128
cJSON_Hooks::void
void(CJSON_CDECL *free_fn)(void *ptr)
case_sensitive
const cJSON *const const cJSON_bool case_sensitive
Definition: cJSON.h:267
cJSON_Hooks
struct cJSON_Hooks cJSON_Hooks
number
const char *const const double number
Definition: cJSON.h:280
format
char const int const cJSON_bool format
Definition: cJSON.h:174
which
int which
Definition: cJSON.h:246
cJSON::valuestring
char * valuestring
Definition: cJSON.h:126
cJSON_Hooks::malloc_fn
void *CJSON_CDECL * malloc_fn(size_t sz)
replacement
cJSON *const cJSON * replacement
Definition: cJSON.h:255
CJSON_CDECL
#define CJSON_CDECL
Definition: cJSON.h:82
b
const cJSON *const b
Definition: cJSON.h:267
cJSON_bool
int cJSON_bool
Definition: cJSON.h:143
fmt
int cJSON_bool fmt
Definition: cJSON.h:171
prebuffer
int prebuffer
Definition: cJSON.h:171
buffer_length
size_t buffer_length
Definition: cJSON.h:160
valuestring
const char * valuestring
Definition: cJSON.h:292
cJSON_Hooks
Definition: cJSON.h:137
cJSON::string
char * string
Definition: cJSON.h:133
cJSON::prev
struct cJSON * prev
Definition: cJSON.h:118
length
char const int length
Definition: cJSON.h:174
item
cJSON * item
Definition: cJSON.h:234
cJSON
struct cJSON cJSON
cJSON::child
struct cJSON * child
Definition: cJSON.h:120
index
int index
Definition: cJSON.h:181
CJSON_PUBLIC
#define CJSON_PUBLIC(type)
Definition: cJSON.h:88
count
int count
Definition: cJSON.h:228
require_null_terminated
const char cJSON_bool require_null_terminated
Definition: cJSON.h:163
recurse
cJSON_bool recurse
Definition: cJSON.h:261
cJSON::valuedouble
double valuedouble
Definition: cJSON.h:130
cJSON::type
int type
Definition: cJSON.h:123
newitem
int cJSON * newitem
Definition: cJSON.h:254