1 /* 2 Copyright (c) 2009 Dave Gamble 3 Copyright (c) 2015-2016 The Khronos Group Inc. 4 Copyright (c) 2015-2016 Valve Corporation 5 Copyright (c) 2015-2016 LunarG, Inc. 6 7 Permission is hereby granted, free of charge, to any person obtaining a copy 8 of this software and associated documentation files (the "Software"), to deal 9 in the Software without restriction, including without limitation the rights 10 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 11 copies of the Software, and to permit persons to whom the Software is 12 furnished to do so, subject to the following conditions: 13 14 The above copyright notice and this permission notice shall be included in 15 all copies or substantial portions of the Software. 16 17 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 18 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 19 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 20 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 21 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 22 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN 23 THE SOFTWARE. 24 */ 25 26 #ifndef cJSON__h 27 #define cJSON__h 28 29 #ifdef __cplusplus 30 extern "C" { 31 #endif 32 33 /* cJSON Types: */ 34 #define cJSON_False 0 35 #define cJSON_True 1 36 #define cJSON_NULL 2 37 #define cJSON_Number 3 38 #define cJSON_String 4 39 #define cJSON_Array 5 40 #define cJSON_Object 6 41 42 #define cJSON_IsReference 256 43 #define cJSON_StringIsConst 512 44 45 /* The cJSON structure: */ 46 typedef struct cJSON { 47 struct cJSON *next, *prev; /* next/prev allow you to walk array/object 48 chains. Alternatively, use 49 GetArraySize/GetArrayItem/GetObjectItem */ 50 struct cJSON *child; /* An array or object item will have a child pointer 51 pointing to a chain of the items in the 52 array/object. */ 53 54 int type; /* The type of the item, as above. */ 55 56 char *valuestring; /* The item's string, if type==cJSON_String */ 57 int valueint; /* The item's number, if type==cJSON_Number */ 58 double valuedouble; /* The item's number, if type==cJSON_Number */ 59 60 char *string; /* The item's name string, if this item is the child of, or is 61 in the list of subitems of an object. */ 62 } cJSON; 63 64 typedef struct cJSON_Hooks { 65 void *(*malloc_fn)(size_t sz); 66 void (*free_fn)(void *ptr); 67 } cJSON_Hooks; 68 69 /* Supply malloc, realloc and free functions to cJSON */ 70 extern void cJSON_InitHooks(cJSON_Hooks *hooks); 71 72 /* Supply a block of JSON, and this returns a cJSON object you can interrogate. 73 * Call cJSON_Delete when finished. */ 74 extern cJSON *cJSON_Parse(const char *value); 75 /* Render a cJSON entity to text for transfer/storage. Free the char* when 76 * finished. */ 77 extern char *cJSON_Print(cJSON *item); 78 /* Render a cJSON entity to text for transfer/storage without any formatting. 79 * Free the char* when finished. */ 80 extern char *cJSON_PrintUnformatted(cJSON *item); 81 /* Render a cJSON entity to text using a buffered strategy. prebuffer is a guess 82 * at the final size. guessing well reduces reallocation. fmt=0 gives 83 * unformatted, =1 gives formatted */ 84 extern char *cJSON_PrintBuffered(cJSON *item, int prebuffer, int fmt); 85 /* Delete a cJSON entity and all subentities. */ 86 extern void cJSON_Delete(cJSON *c); 87 /* Delete an item allocated inside the JSON parser*/ 88 extern void cJSON_Free(void *p); 89 90 /* Returns the number of items in an array (or object). */ 91 extern int cJSON_GetArraySize(cJSON *array); 92 /* Retrieve item number "item" from array "array". Returns NULL if unsuccessful. 93 */ 94 extern cJSON *cJSON_GetArrayItem(cJSON *array, int item); 95 /* Get item "string" from object. Case insensitive. */ 96 extern cJSON *cJSON_GetObjectItem(cJSON *object, const char *string); 97 98 /* For analysing failed parses. This returns a pointer to the parse error. 99 * You'll probably need to look a few chars back to make sense of it. Defined 100 * when cJSON_Parse() returns 0. 0 when cJSON_Parse() succeeds. */ 101 extern const char *cJSON_GetErrorPtr(void); 102 103 /* These calls create a cJSON item of the appropriate type. */ 104 extern cJSON *cJSON_CreateNull(void); 105 extern cJSON *cJSON_CreateTrue(void); 106 extern cJSON *cJSON_CreateFalse(void); 107 extern cJSON *cJSON_CreateBool(int b); 108 extern cJSON *cJSON_CreateNumber(double num); 109 extern cJSON *cJSON_CreateString(const char *string); 110 extern cJSON *cJSON_CreateArray(void); 111 extern cJSON *cJSON_CreateObject(void); 112 113 /* These utilities create an Array of count items. */ 114 extern cJSON *cJSON_CreateIntArray(const int *numbers, int count); 115 extern cJSON *cJSON_CreateFloatArray(const float *numbers, int count); 116 extern cJSON *cJSON_CreateDoubleArray(const double *numbers, int count); 117 extern cJSON *cJSON_CreateStringArray(const char **strings, int count); 118 119 /* Append item to the specified array/object. */ 120 extern void cJSON_AddItemToArray(cJSON *array, cJSON *item); 121 extern void cJSON_AddItemToObject(cJSON *object, const char *string, 122 cJSON *item); 123 extern void cJSON_AddItemToObjectCS( 124 cJSON *object, const char *string, 125 cJSON *item); /* Use this when string is definitely const (i.e. a literal, 126 or as good as), and will definitely survive the cJSON 127 object */ 128 /* Append reference to item to the specified array/object. Use this when you 129 * want to add an existing cJSON to a new cJSON, but don't want to corrupt your 130 * existing cJSON. */ 131 extern void cJSON_AddItemReferenceToArray(cJSON *array, cJSON *item); 132 extern void cJSON_AddItemReferenceToObject(cJSON *object, const char *string, 133 cJSON *item); 134 135 /* Remove/Detatch items from Arrays/Objects. */ 136 extern cJSON *cJSON_DetachItemFromArray(cJSON *array, int which); 137 extern void cJSON_DeleteItemFromArray(cJSON *array, int which); 138 extern cJSON *cJSON_DetachItemFromObject(cJSON *object, const char *string); 139 extern void cJSON_DeleteItemFromObject(cJSON *object, const char *string); 140 141 /* Update array items. */ 142 extern void cJSON_InsertItemInArray( 143 cJSON *array, int which, 144 cJSON *newitem); /* Shifts pre-existing items to the right. */ 145 extern void cJSON_ReplaceItemInArray(cJSON *array, int which, cJSON *newitem); 146 extern void cJSON_ReplaceItemInObject(cJSON *object, const char *string, 147 cJSON *newitem); 148 149 /* Duplicate a cJSON item */ 150 extern cJSON *cJSON_Duplicate(cJSON *item, int recurse); 151 /* Duplicate will create a new, identical cJSON item to the one you pass, in new 152 memory that will 153 need to be released. With recurse!=0, it will duplicate any children connected 154 to the item. 155 The item->next and ->prev pointers are always zero on return from Duplicate. */ 156 157 /* ParseWithOpts allows you to require (and check) that the JSON is null 158 * terminated, and to retrieve the pointer to the final byte parsed. */ 159 extern cJSON *cJSON_ParseWithOpts(const char *value, 160 const char **return_parse_end, 161 int require_null_terminated); 162 163 extern void cJSON_Minify(char *json); 164 165 /* Macros for creating things quickly. */ 166 #define cJSON_AddNullToObject(object, name) \ 167 cJSON_AddItemToObject(object, name, cJSON_CreateNull()) 168 #define cJSON_AddTrueToObject(object, name) \ 169 cJSON_AddItemToObject(object, name, cJSON_CreateTrue()) 170 #define cJSON_AddFalseToObject(object, name) \ 171 cJSON_AddItemToObject(object, name, cJSON_CreateFalse()) 172 #define cJSON_AddBoolToObject(object, name, b) \ 173 cJSON_AddItemToObject(object, name, cJSON_CreateBool(b)) 174 #define cJSON_AddNumberToObject(object, name, n) \ 175 cJSON_AddItemToObject(object, name, cJSON_CreateNumber(n)) 176 #define cJSON_AddStringToObject(object, name, s) \ 177 cJSON_AddItemToObject(object, name, cJSON_CreateString(s)) 178 179 /* When assigning an integer value, it needs to be propagated to valuedouble 180 * too. */ 181 #define cJSON_SetIntValue(object, val) \ 182 ((object) ? (object)->valueint = (object)->valuedouble = (val) : (val)) 183 #define cJSON_SetNumberValue(object, val) \ 184 ((object) ? (object)->valueint = (object)->valuedouble = (val) : (val)) 185 186 #ifdef __cplusplus 187 } 188 #endif 189 190 #endif 191
