src/cJSON.h

   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 #include <stdio.h>
  24 #include <stdlib.h>
  25 #include <stdint.h>
  26 #include <math.h>
  27 #include <ctype.h>
  28 #include <float.h>
  29 #include <memory.h>
  30
  31 #ifndef cJSON__h
  32 #define cJSON__h
  33
  34 #ifdef __cplusplus
  35 extern "C"
  36 {
  37 #endif
  38
  39 /* project version */
  40 #define CJSON_VERSION_MAJOR 1
  41 #define CJSON_VERSION_MINOR 5
  42 #define CJSON_VERSION_PATCH 9
  43
  44 #include <stddef.h>
  45
  46 /* cJSON Types: */
  47 #define cJSON_Invalid (0)
  48 #define cJSON_False  (1 << 0)
  49 #define cJSON_True   (1 << 1)
  50 #define cJSON_NULL   (1 << 2)
  51 #define cJSON_Number (1 << 3)
  52 #define cJSON_String (1 << 4)
  53 #define cJSON_Array  (1 << 5)
  54 #define cJSON_Object (1 << 6)
  55 #define cJSON_Raw    (1 << 7) /* raw json */
  56
  57 #define cJSON_IsReference 256
  58 #define cJSON_StringIsConst 512
  59
  60 /* The cJSON structure: */
  61 typedef struct cJSON
  62 {
  63     /* next/prev allow you to walk array/object chains. Alternatively, use GetArraySize/GetArrayItem/GetObjectItem */
  64     struct cJSON *next;
  65     struct cJSON *prev;
  66     /* An array or object item will have a child pointer pointing to a chain of the items in the array/object. */
  67     struct cJSON *child;
  68
  69     /* The type of the item, as above. */
  70     int type;
  71
  72     /* The item's string, if type==cJSON_String  and type == cJSON_Raw */
  73     char *valuestring;
  74     /* writing to valueint is DEPRECATED, use cJSON_SetNumberValue instead */
  75     int valueint;
  76     /* The item's number, if type==cJSON_Number */
  77     double valuedouble;
  78
  79     /* The item's name string, if this item is the child of, or is in the list of subitems of an object. */
  80     char *string;
  81 } cJSON;
  82
  83 typedef struct cJSON_Hooks
  84 {
  85       void *(*malloc_fn)(size_t sz);
  86       void (*free_fn)(void *ptr);
  87 } cJSON_Hooks;
  88
  89 typedef int cJSON_bool;
  90
  91 #if !defined(__WINDOWS__) && (defined(WIN32) || defined(WIN64) || defined(_MSC_VER) || defined(_WIN32))
  92 #define __WINDOWS__
  93 #endif
  94 #ifdef __WINDOWS__
  95
  96 /* 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 2 define options:
  97
  98 CJSON_HIDE_SYMBOLS - Define this in the case where you don't want to ever dllexport symbols
  99 CJSON_EXPORT_SYMBOLS - Define this on library build when you want to dllexport symbols (default)
 100 CJSON_IMPORT_SYMBOLS - Define this if you want to dllimport symbol
 101
 102 For *nix builds that support visibility attribute, you can define similar behavior by
 103
 104 setting default visibility to hidden by adding
 105 -fvisibility=hidden (for gcc)
 106 or
 107 -xldscope=hidden (for sun cc)
 108 to CFLAGS
 109
 110 then using the CJSON_API_VISIBILITY flag to "export" the same symbols the way CJSON_EXPORT_SYMBOLS does
 111
 112 */
 113
 114 /* export symbols by default, this is necessary for copy pasting the C and header file */
 115 #if !defined(CJSON_HIDE_SYMBOLS) && !defined(CJSON_IMPORT_SYMBOLS) && !defined(CJSON_EXPORT_SYMBOLS)
 116 #define CJSON_EXPORT_SYMBOLS
 117 #endif
 118
 119 #if defined(CJSON_HIDE_SYMBOLS)
 120 #define CJSON_PUBLIC(type)   type __stdcall
 121 #elif defined(CJSON_EXPORT_SYMBOLS)
 122 #define CJSON_PUBLIC(type)   __declspec(dllexport) type __stdcall
 123 #elif defined(CJSON_IMPORT_SYMBOLS)
 124 #define CJSON_PUBLIC(type)   __declspec(dllimport) type __stdcall
 125 #endif
 126 #else /* !WIN32 */
 127 #if (defined(__GNUC__) || defined(__SUNPRO_CC) || defined (__SUNPRO_C)) && defined(CJSON_API_VISIBILITY)
 128 #define CJSON_PUBLIC(type)   __attribute__((visibility("default"))) type
 129 #else
 130 #define CJSON_PUBLIC(type) type
 131 #endif
 132 #endif
 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 "item" 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 /* These functions check the type of an item */
 177 CJSON_PUBLIC(cJSON_bool) cJSON_IsInvalid(const cJSON * const item);
 178 CJSON_PUBLIC(cJSON_bool) cJSON_IsFalse(const cJSON * const item);
 179 CJSON_PUBLIC(cJSON_bool) cJSON_IsTrue(const cJSON * const item);
 180 CJSON_PUBLIC(cJSON_bool) cJSON_IsBool(const cJSON * const item);
 181 CJSON_PUBLIC(cJSON_bool) cJSON_IsNull(const cJSON * const item);
 182 CJSON_PUBLIC(cJSON_bool) cJSON_IsNumber(const cJSON * const item);
 183 CJSON_PUBLIC(cJSON_bool) cJSON_IsString(const cJSON * const item);
 184 CJSON_PUBLIC(cJSON_bool) cJSON_IsArray(const cJSON * const item);
 185 CJSON_PUBLIC(cJSON_bool) cJSON_IsObject(const cJSON * const item);
 186 CJSON_PUBLIC(cJSON_bool) cJSON_IsRaw(const cJSON * const item);
 187
 188 /* These calls create a cJSON item of the appropriate type. */
 189 CJSON_PUBLIC(cJSON *) cJSON_CreateNull(void);
 190 CJSON_PUBLIC(cJSON *) cJSON_CreateTrue(void);
 191 CJSON_PUBLIC(cJSON *) cJSON_CreateFalse(void);
 192 CJSON_PUBLIC(cJSON *) cJSON_CreateBool(cJSON_bool boolean);
 193 CJSON_PUBLIC(cJSON *) cJSON_CreateNumber(double num);
 194 CJSON_PUBLIC(cJSON *) cJSON_CreateString(const char *string);
 195 /* raw json */
 196 CJSON_PUBLIC(cJSON *) cJSON_CreateRaw(const char *raw);
 197 CJSON_PUBLIC(cJSON *) cJSON_CreateArray(void);
 198 CJSON_PUBLIC(cJSON *) cJSON_CreateObject(void);
 199
 200 /* These utilities create an Array of count items. */
 201 CJSON_PUBLIC(cJSON *) cJSON_CreateIntArray(const int *numbers, int count);
 202 CJSON_PUBLIC(cJSON *) cJSON_CreateFloatArray(const float *numbers, int count);
 203 CJSON_PUBLIC(cJSON *) cJSON_CreateDoubleArray(const double *numbers, int count);
 204 CJSON_PUBLIC(cJSON *) cJSON_CreateStringArray(const char **strings, int count);
 205
 206 /* Append item to the specified array/object. */
 207 CJSON_PUBLIC(void) cJSON_AddItemToArray(cJSON *array, cJSON *item);
 208 CJSON_PUBLIC(void) cJSON_AddItemToObject(cJSON *object, const char *string, cJSON *item);
 209 /* Use this when string is definitely const (i.e. a literal, or as good as), and will definitely survive the cJSON object.
 210  * WARNING: When this function was used, make sure to always check that (item->type & cJSON_StringIsConst) is zero before
 211  * writing to `item->string` */
 212 CJSON_PUBLIC(void) cJSON_AddItemToObjectCS(cJSON *object, const char *string, cJSON *item);
 213 /* 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. */
 214 CJSON_PUBLIC(void) cJSON_AddItemReferenceToArray(cJSON *array, cJSON *item);
 215 CJSON_PUBLIC(void) cJSON_AddItemReferenceToObject(cJSON *object, const char *string, cJSON *item);
 216
 217 /* Remove/Detatch items from Arrays/Objects. */
 218 CJSON_PUBLIC(cJSON *) cJSON_DetachItemViaPointer(cJSON *parent, cJSON * const item);
 219 CJSON_PUBLIC(cJSON *) cJSON_DetachItemFromArray(cJSON *array, int which);
 220 CJSON_PUBLIC(void) cJSON_DeleteItemFromArray(cJSON *array, int which);
 221 CJSON_PUBLIC(cJSON *) cJSON_DetachItemFromObject(cJSON *object, const char *string);
 222 CJSON_PUBLIC(cJSON *) cJSON_DetachItemFromObjectCaseSensitive(cJSON *object, const char *string);
 223 CJSON_PUBLIC(void) cJSON_DeleteItemFromObject(cJSON *object, const char *string);
 224 CJSON_PUBLIC(void) cJSON_DeleteItemFromObjectCaseSensitive(cJSON *object, const char *string);
 225
 226 /* Update array items. */
 227 CJSON_PUBLIC(void) cJSON_InsertItemInArray(cJSON *array, int which, cJSON *newitem); /* Shifts pre-existing items to the right. */
 228 CJSON_PUBLIC(cJSON_bool) cJSON_ReplaceItemViaPointer(cJSON * const parent, cJSON * const item, cJSON * replacement);
 229 CJSON_PUBLIC(void) cJSON_ReplaceItemInArray(cJSON *array, int which, cJSON *newitem);
 230 CJSON_PUBLIC(void) cJSON_ReplaceItemInObject(cJSON *object,const char *string,cJSON *newitem);
 231 CJSON_PUBLIC(void) cJSON_ReplaceItemInObjectCaseSensitive(cJSON *object,const char *string,cJSON *newitem);
 232
 233 /* Duplicate a cJSON item */
 234 CJSON_PUBLIC(cJSON *) cJSON_Duplicate(const cJSON *item, cJSON_bool recurse);
 235 /* Duplicate will create a new, identical cJSON item to the one you pass, in new memory that will
 236 need to be released. With recurse!=0, it will duplicate any children connected to the item.
 237 The item->next and ->prev pointers are always zero on return from Duplicate. */
 238 /* Recursively compare two cJSON items for equality. If either a or b is NULL or invalid, they will be considered unequal.
 239  * case_sensitive determines if object keys are treated case sensitive (1) or case insensitive (0) */
 240 CJSON_PUBLIC(cJSON_bool) cJSON_Compare(const cJSON * const a, const cJSON * const b, const cJSON_bool case_sensitive);
 241
 242
 243 CJSON_PUBLIC(void) cJSON_Minify(char *json);
 244
 245 /* Macros for creating things quickly. */
 246 #define cJSON_AddNullToObject(object,name) cJSON_AddItemToObject(object, name, cJSON_CreateNull())
 247 #define cJSON_AddTrueToObject(object,name) cJSON_AddItemToObject(object, name, cJSON_CreateTrue())
 248 #define cJSON_AddFalseToObject(object,name) cJSON_AddItemToObject(object, name, cJSON_CreateFalse())
 249 #define cJSON_AddBoolToObject(object,name,b) cJSON_AddItemToObject(object, name, cJSON_CreateBool(b))
 250 #define cJSON_AddNumberToObject(object,name,n) cJSON_AddItemToObject(object, name, cJSON_CreateNumber(n))
 251 #define cJSON_AddStringToObject(object,name,s) cJSON_AddItemToObject(object, name, cJSON_CreateString(s))
 252 #define cJSON_AddRawToObject(object,name,s) cJSON_AddItemToObject(object, name, cJSON_CreateRaw(s))
 253
 254 /* When assigning an integer value, it needs to be propagated to valuedouble too. */
 255 #define cJSON_SetIntValue(object, number) ((object) ? (object)->valueint = (object)->valuedouble = (number) : (number))
 256 /* helper for the cJSON_SetNumberValue macro */
 257 CJSON_PUBLIC(double) cJSON_SetNumberHelper(cJSON *object, double number);
 258 #define cJSON_SetNumberValue(object, number) ((object != NULL) ? cJSON_SetNumberHelper(object, (double)number) : (number))
 259
 260 /* Macro for iterating over an array or object */
 261 #define cJSON_ArrayForEach(element, array) for(element = (array != NULL) ? (array)->child : NULL; element != NULL; element = element->next)
 262
 263 /* malloc/free objects using the malloc/free functions that have been set with cJSON_InitHooks */
 264 CJSON_PUBLIC(void *) cJSON_malloc(size_t size);
 265 CJSON_PUBLIC(void) cJSON_free(void *object);
 266
 267 #ifdef __cplusplus
 268 }
 269 #endif
 270
 271 #endif