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