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 17 85 86 #include <stddef.h> 87 88 /* use int64 if it is enabled and supported */ 89 #if defined(__STDC_VERSION__) && __STDC_VERSION__ >= 199901L && defined(ENABLE_INT64) 90 #define __CJSON_USE_INT64 91 #endif 92 93 /* cJSON Types: */ 94 #define cJSON_Invalid (0) 95 #define cJSON_False (1 << 0) 96 #define cJSON_True (1 << 1) 97 #define cJSON_NULL (1 << 2) 98 #define cJSON_Number (1 << 3) 99 #define cJSON_String (1 << 4) 100 #define cJSON_Array (1 << 5) 101 #define cJSON_Object (1 << 6) 102 #define cJSON_Raw (1 << 7) /* raw json */ 103 104 #define cJSON_IsReference 256 105 #define cJSON_StringIsConst 512 106 #ifdef __CJSON_USE_INT64 107 #define cJSON_IsInt64 1024 108 #endif 109 110 /* The cJSON structure: */ 111 typedef struct cJSON 112 { 113 /* next/prev allow you to walk array/object chains. Alternatively, use GetArraySize/GetArrayItem/GetObjectItem */ 114 struct cJSON *next; 115 struct cJSON *prev; 116 /* An array or object item will have a child pointer pointing to a chain of the items in the array/object. */ 117 struct cJSON *child; 118 119 /* The type of the item, as above. */ 120 int type; 121 122 /* The item's string, if type==cJSON_String and type == cJSON_Raw */ 123 char *valuestring; 124 #ifdef __CJSON_USE_INT64 125 /* use long long if int64 is enabled */ 126 long long valueint; 127 #else 128 /* writing to valueint is DEPRECATED, use cJSON_SetNumberValue instead */ 129 int valueint; 130 #endif /* __CJSON_USE_INT64 */ 131 /* The item's number, if type==cJSON_Number */ 132 double valuedouble; 133 134 /* The item's name string, if this item is the child of, or is in the list of subitems of an object. */ 135 char *string; 136 } cJSON; 137 138 typedef struct cJSON_Hooks 139 { 140 /* malloc/free are CDECL on Windows regardless of the default calling convention of the compiler, so ensure the hooks allow passing those functions directly. */ 141 void *(CJSON_CDECL *malloc_fn)(size_t sz); 142 void (CJSON_CDECL *free_fn)(void *ptr); 143 } cJSON_Hooks; 144 145 typedef int cJSON_bool; 146 147 /* Limits how deeply nested arrays/objects can be before cJSON rejects to parse them. 148 * This is to prevent stack overflows. */ 149 #ifndef CJSON_NESTING_LIMIT 150 #define CJSON_NESTING_LIMIT 1000 151 #endif 152 153 /* returns the version of cJSON as a string */ 154 CJSON_PUBLIC(const char*) cJSON_Version(void); 155 156 /* Supply malloc, realloc and free functions to cJSON */ 157 CJSON_PUBLIC(void) cJSON_InitHooks(cJSON_Hooks* hooks); 158 159 /* 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. */ 160 /* Supply a block of JSON, and this returns a cJSON object you can interrogate. */ 161 CJSON_PUBLIC(cJSON *) cJSON_Parse(const char *value); 162 CJSON_PUBLIC(cJSON *) cJSON_ParseWithLength(const char *value, size_t buffer_length); 163 /* ParseWithOpts allows you to require (and check) that the JSON is null terminated, and to retrieve the pointer to the final byte parsed. */ 164 /* 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(). */ 165 CJSON_PUBLIC(cJSON *) cJSON_ParseWithOpts(const char *value, const char **return_parse_end, cJSON_bool require_null_terminated); 166 CJSON_PUBLIC(cJSON *) cJSON_ParseWithLengthOpts(const char *value, size_t buffer_length, const char **return_parse_end, cJSON_bool require_null_terminated); 167 168 /* Render a cJSON entity to text for transfer/storage. */ 169 CJSON_PUBLIC(char *) cJSON_Print(const cJSON *item); 170 /* Render a cJSON entity to text for transfer/storage without any formatting. */ 171 CJSON_PUBLIC(char *) cJSON_PrintUnformatted(const cJSON *item); 172 /* 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 */ 173 CJSON_PUBLIC(char *) cJSON_PrintBuffered(const cJSON *item, int prebuffer, cJSON_bool fmt); 174 /* Render a cJSON entity to text using a buffer already allocated in memory with given length. Returns 1 on success and 0 on failure. */ 175 /* 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 */ 176 CJSON_PUBLIC(cJSON_bool) cJSON_PrintPreallocated(cJSON *item, char *buffer, const int length, const cJSON_bool format); 177 /* Delete a cJSON entity and all subentities. */ 178 CJSON_PUBLIC(void) cJSON_Delete(cJSON *item); 179 180 /* Returns the number of items in an array (or object). */ 181 CJSON_PUBLIC(int) cJSON_GetArraySize(const cJSON *array); 182 /* Retrieve item number "index" from array "array". Returns NULL if unsuccessful. */ 183 CJSON_PUBLIC(cJSON *) cJSON_GetArrayItem(const cJSON *array, int index); 184 /* Get item "string" from object. Case insensitive. */ 185 CJSON_PUBLIC(cJSON *) cJSON_GetObjectItem(const cJSON * const object, const char * const string); 186 CJSON_PUBLIC(cJSON *) cJSON_GetObjectItemCaseSensitive(const cJSON * const object, const char * const string); 187 CJSON_PUBLIC(cJSON_bool) cJSON_HasObjectItem(const cJSON *object, const char *string); 188 /* 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. */ 189 CJSON_PUBLIC(const char *) cJSON_GetErrorPtr(void); 190 191 /* Check item type and return its value */ 192 CJSON_PUBLIC(char *) cJSON_GetStringValue(const cJSON * const item); 193 #ifdef __CJSON_USE_INT64 194 CJSON_PUBLIC(long long *) cJSON_GetInt64NumberValue(cJSON * const item); 195 #endif 196 CJSON_PUBLIC(double) cJSON_GetNumberValue(const cJSON * const item); 197 198 /* These functions check the type of an item */ 199 CJSON_PUBLIC(cJSON_bool) cJSON_IsInvalid(const cJSON * const item); 200 CJSON_PUBLIC(cJSON_bool) cJSON_IsFalse(const cJSON * const item); 201 CJSON_PUBLIC(cJSON_bool) cJSON_IsTrue(const cJSON * const item); 202 CJSON_PUBLIC(cJSON_bool) cJSON_IsBool(const cJSON * const item); 203 CJSON_PUBLIC(cJSON_bool) cJSON_IsNull(const cJSON * const item); 204 #ifdef __CJSON_USE_INT64 205 CJSON_PUBLIC(cJSON_bool) cJSON_IsInt64Number(const cJSON * const item); 206 #endif 207 CJSON_PUBLIC(cJSON_bool) cJSON_IsNumber(const cJSON * const item); 208 CJSON_PUBLIC(cJSON_bool) cJSON_IsString(const cJSON * const item); 209 CJSON_PUBLIC(cJSON_bool) cJSON_IsArray(const cJSON * const item); 210 CJSON_PUBLIC(cJSON_bool) cJSON_IsObject(const cJSON * const item); 211 CJSON_PUBLIC(cJSON_bool) cJSON_IsRaw(const cJSON * const item); 212 213 /* These calls create a cJSON item of the appropriate type. */ 214 CJSON_PUBLIC(cJSON *) cJSON_CreateNull(void); 215 CJSON_PUBLIC(cJSON *) cJSON_CreateTrue(void); 216 CJSON_PUBLIC(cJSON *) cJSON_CreateFalse(void); 217 CJSON_PUBLIC(cJSON *) cJSON_CreateBool(cJSON_bool boolean); 218 CJSON_PUBLIC(cJSON *) cJSON_CreateNumber(double num); 219 #ifdef __CJSON_USE_INT64 220 CJSON_PUBLIC(cJSON *) cJSON_CreateInt64Number(long long integer); 221 #endif 222 CJSON_PUBLIC(cJSON *) cJSON_CreateString(const char *string); 223 /* raw json */ 224 CJSON_PUBLIC(cJSON *) cJSON_CreateRaw(const char *raw); 225 CJSON_PUBLIC(cJSON *) cJSON_CreateArray(void); 226 CJSON_PUBLIC(cJSON *) cJSON_CreateObject(void); 227 228 /* Create a string where valuestring references a string so 229 * it will not be freed by cJSON_Delete */ 230 CJSON_PUBLIC(cJSON *) cJSON_CreateStringReference(const char *string); 231 /* Create an object/array that only references it's elements so 232 * they will not be freed by cJSON_Delete */ 233 CJSON_PUBLIC(cJSON *) cJSON_CreateObjectReference(const cJSON *child); 234 CJSON_PUBLIC(cJSON *) cJSON_CreateArrayReference(const cJSON *child); 235 236 /* These utilities create an Array of count items. 237 * The parameter count cannot be greater than the number of elements in the number array, otherwise array access will be out of bounds.*/ 238 CJSON_PUBLIC(cJSON *) cJSON_CreateIntArray(const int *numbers, int count); 239 CJSON_PUBLIC(cJSON *) cJSON_CreateFloatArray(const float *numbers, int count); 240 CJSON_PUBLIC(cJSON *) cJSON_CreateDoubleArray(const double *numbers, int count); 241 CJSON_PUBLIC(cJSON *) cJSON_CreateStringArray(const char *const *strings, int count); 242 243 /* Append item to the specified array/object. */ 244 CJSON_PUBLIC(cJSON_bool) cJSON_AddItemToArray(cJSON *array, cJSON *item); 245 CJSON_PUBLIC(cJSON_bool) cJSON_AddItemToObject(cJSON *object, const char *string, cJSON *item); 246 /* Use this when string is definitely const (i.e. a literal, or as good as), and will definitely survive the cJSON object. 247 * WARNING: When this function was used, make sure to always check that (item->type & cJSON_StringIsConst) is zero before 248 * writing to `item->string` */ 249 CJSON_PUBLIC(cJSON_bool) cJSON_AddItemToObjectCS(cJSON *object, const char *string, cJSON *item); 250 /* 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. */ 251 CJSON_PUBLIC(cJSON_bool) cJSON_AddItemReferenceToArray(cJSON *array, cJSON *item); 252 CJSON_PUBLIC(cJSON_bool) cJSON_AddItemReferenceToObject(cJSON *object, const char *string, cJSON *item); 253 254 /* Remove/Detach items from Arrays/Objects. */ 255 CJSON_PUBLIC(cJSON *) cJSON_DetachItemViaPointer(cJSON *parent, cJSON * const item); 256 CJSON_PUBLIC(cJSON *) cJSON_DetachItemFromArray(cJSON *array, int which); 257 CJSON_PUBLIC(void) cJSON_DeleteItemFromArray(cJSON *array, int which); 258 CJSON_PUBLIC(cJSON *) cJSON_DetachItemFromObject(cJSON *object, const char *string); 259 CJSON_PUBLIC(cJSON *) cJSON_DetachItemFromObjectCaseSensitive(cJSON *object, const char *string); 260 CJSON_PUBLIC(void) cJSON_DeleteItemFromObject(cJSON *object, const char *string); 261 CJSON_PUBLIC(void) cJSON_DeleteItemFromObjectCaseSensitive(cJSON *object, const char *string); 262 263 /* Update array items. */ 264 CJSON_PUBLIC(cJSON_bool) cJSON_InsertItemInArray(cJSON *array, int which, cJSON *newitem); /* Shifts pre-existing items to the right. */ 265 CJSON_PUBLIC(cJSON_bool) cJSON_ReplaceItemViaPointer(cJSON * const parent, cJSON * const item, cJSON * replacement); 266 CJSON_PUBLIC(cJSON_bool) cJSON_ReplaceItemInArray(cJSON *array, int which, cJSON *newitem); 267 CJSON_PUBLIC(cJSON_bool) cJSON_ReplaceItemInObject(cJSON *object,const char *string,cJSON *newitem); 268 CJSON_PUBLIC(cJSON_bool) cJSON_ReplaceItemInObjectCaseSensitive(cJSON *object,const char *string,cJSON *newitem); 269 270 /* Duplicate a cJSON item */ 271 CJSON_PUBLIC(cJSON *) cJSON_Duplicate(const cJSON *item, cJSON_bool recurse); 272 /* Duplicate will create a new, identical cJSON item to the one you pass, in new memory that will 273 * need to be released. With recurse!=0, it will duplicate any children connected to the item. 274 * The item->next and ->prev pointers are always zero on return from Duplicate. */ 275 /* Recursively compare two cJSON items for equality. If either a or b is NULL or invalid, they will be considered unequal. 276 * case_sensitive determines if object keys are treated case sensitive (1) or case insensitive (0) */ 277 CJSON_PUBLIC(cJSON_bool) cJSON_Compare(const cJSON * const a, const cJSON * const b, const cJSON_bool case_sensitive); 278 279 /* Minify a strings, remove blank characters(such as ' ', '\t', '\r', '\n') from strings. 280 * The input pointer json cannot point to a read-only address area, such as a string constant, 281 * but should point to a readable and writable address area. */ 282 CJSON_PUBLIC(void) cJSON_Minify(char *json); 283 284 /* Helper functions for creating and adding items to an object at the same time. 285 * They return the added item or NULL on failure. */ 286 CJSON_PUBLIC(cJSON*) cJSON_AddNullToObject(cJSON * const object, const char * const name); 287 CJSON_PUBLIC(cJSON*) cJSON_AddTrueToObject(cJSON * const object, const char * const name); 288 CJSON_PUBLIC(cJSON*) cJSON_AddFalseToObject(cJSON * const object, const char * const name); 289 CJSON_PUBLIC(cJSON*) cJSON_AddBoolToObject(cJSON * const object, const char * const name, const cJSON_bool boolean); 290 #ifdef __CJSON_USE_INT64 291 CJSON_PUBLIC(cJSON*) cJSON_AddInt64NumberToObject(cJSON * const object, const char * const name, const long long integer); 292 #endif 293 CJSON_PUBLIC(cJSON*) cJSON_AddNumberToObject(cJSON * const object, const char * const name, const double number); 294 CJSON_PUBLIC(cJSON*) cJSON_AddStringToObject(cJSON * const object, const char * const name, const char * const string); 295 CJSON_PUBLIC(cJSON*) cJSON_AddRawToObject(cJSON * const object, const char * const name, const char * const raw); 296 CJSON_PUBLIC(cJSON*) cJSON_AddObjectToObject(cJSON * const object, const char * const name); 297 CJSON_PUBLIC(cJSON*) cJSON_AddArrayToObject(cJSON * const object, const char * const name); 298 299 #ifdef __CJSON_USE_INT64 300 CJSON_PUBLIC(long long) cJSON_SetInt64NumberValue(cJSON * const object, const long long integer); 301 #endif 302 /* When assigning an integer value, it needs to be propagated to valuedouble too. */ 303 #define cJSON_SetIntValue(object, number) ((object) ? (object)->valueint = (object)->valuedouble = (number) : (number)) 304 /* helper for the cJSON_SetNumberValue macro */ 305 CJSON_PUBLIC(double) cJSON_SetNumberHelper(cJSON *object, double number); 306 #define cJSON_SetNumberValue(object, number) ((object != NULL) ? cJSON_SetNumberHelper(object, (double)number) : (number)) 307 /* Change the valuestring of a cJSON_String object, only takes effect when type of object is cJSON_String */ 308 CJSON_PUBLIC(char*) cJSON_SetValuestring(cJSON *object, const char *valuestring); 309 310 /* If the object is not a boolean type this does nothing and returns cJSON_Invalid else it returns the new type*/ 311 #define cJSON_SetBoolValue(object, boolValue) ( \ 312 (object != NULL && ((object)->type & (cJSON_False|cJSON_True))) ? \ 313 (object)->type=((object)->type &(~(cJSON_False|cJSON_True)))|((boolValue)?cJSON_True:cJSON_False) : \ 314 cJSON_Invalid\ 315 ) 316 317 /* Macro for iterating over an array or object */ 318 #define cJSON_ArrayForEach(element, array) for(element = (array != NULL) ? (array)->child : NULL; element != NULL; element = element->next) 319 320 /* malloc/free objects using the malloc/free functions that have been set with cJSON_InitHooks */ 321 CJSON_PUBLIC(void *) cJSON_malloc(size_t size); 322 CJSON_PUBLIC(void) cJSON_free(void *object); 323 324 #ifdef __cplusplus 325 } 326 #endif 327 328 #endif 329