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