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