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