- Main
- Tutorials
- Library
- Samples

- File List
- Globals

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