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