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