1 /* 2 Copyright (c) 2009 Dave Gamble 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 3 34 #define CJSON_VERSION_PATCH 1 35 36 /* returns the version of cJSON as a string */ 37 extern const char* cJSON_Version(void); 38 39 #include <stddef.h> 40 41 /* cJSON Types: */ 42 #define cJSON_Invalid (0) 43 #define cJSON_False (1 << 0) 44 #define cJSON_True (1 << 1) 45 #define cJSON_NULL (1 << 2) 46 #define cJSON_Number (1 << 3) 47 #define cJSON_String (1 << 4) 48 #define cJSON_Array (1 << 5) 49 #define cJSON_Object (1 << 6) 50 #define cJSON_Raw (1 << 7) /* raw json */ 51 52 #define cJSON_IsReference 256 53 #define cJSON_StringIsConst 512 54 55 /* The cJSON structure: */ 56 typedef struct cJSON 57 { 58 /* next/prev allow you to walk array/object chains. Alternatively, use GetArraySize/GetArrayItem/GetObjectItem */ 59 struct cJSON *next; 60 struct cJSON *prev; 61 /* An array or object item will have a child pointer pointing to a chain of the items in the array/object. */ 62 struct cJSON *child; 63 64 /* The type of the item, as above. */ 65 int type; 66 67 /* The item's string, if type==cJSON_String and type == cJSON_Raw */ 68 char *valuestring; 69 /* The item's number, if type==cJSON_Number */ 70 int valueint; 71 /* The item's number, if type==cJSON_Number */ 72 double valuedouble; 73 74 /* The item's name string, if this item is the child of, or is in the list of subitems of an object. */ 75 char *string; 76 } cJSON; 77 78 typedef struct cJSON_Hooks 79 { 80 void *(*malloc_fn)(size_t sz); 81 void (*free_fn)(void *ptr); 82 } cJSON_Hooks; 83 84 /* Supply malloc, realloc and free functions to cJSON */ 85 extern void cJSON_InitHooks(cJSON_Hooks* hooks); 86 87 88 /* Supply a block of JSON, and this returns a cJSON object you can interrogate. Call cJSON_Delete when finished. */ 89 extern cJSON *cJSON_Parse(const char *value); 90 /* Render a cJSON entity to text for transfer/storage. Free the char* when finished. */ 91 extern char *cJSON_Print(const cJSON *item); 92 /* Render a cJSON entity to text for transfer/storage without any formatting. Free the char* when finished. */ 93 extern char *cJSON_PrintUnformatted(const cJSON *item); 94 /* 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 */ 95 extern char *cJSON_PrintBuffered(const cJSON *item, int prebuffer, int fmt); 96 /* Render a cJSON entity to text using a buffer already allocated in memory with length buf_len. Returns 1 on success and 0 on failure. */ 97 extern int cJSON_PrintPreallocated(cJSON *item, char *buf, const int len, const int fmt); 98 /* Delete a cJSON entity and all subentities. */ 99 extern void cJSON_Delete(cJSON *c); 100 101 /* Returns the number of items in an array (or object). */ 102 extern int cJSON_GetArraySize(const cJSON *array); 103 /* Retrieve item number "item" from array "array". Returns NULL if unsuccessful. */ 104 extern cJSON *cJSON_GetArrayItem(const cJSON *array, int item); 105 /* Get item "string" from object. Case insensitive. */ 106 extern cJSON *cJSON_GetObjectItem(const cJSON *object, const char *string); 107 extern int cJSON_HasObjectItem(const cJSON *object, const char *string); 108 /* 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. */ 109 extern const char *cJSON_GetErrorPtr(void); 110 111 /* These calls create a cJSON item of the appropriate type. */ 112 extern cJSON *cJSON_CreateNull(void); 113 extern cJSON *cJSON_CreateTrue(void); 114 extern cJSON *cJSON_CreateFalse(void); 115 extern cJSON *cJSON_CreateBool(int b); 116 extern cJSON *cJSON_CreateNumber(double num); 117 extern cJSON *cJSON_CreateString(const char *string); 118 /* raw json */ 119 extern cJSON *cJSON_CreateRaw(const char *raw); 120 extern cJSON *cJSON_CreateArray(void); 121 extern cJSON *cJSON_CreateObject(void); 122 123 /* These utilities create an Array of count items. */ 124 extern cJSON *cJSON_CreateIntArray(const int *numbers, int count); 125 extern cJSON *cJSON_CreateFloatArray(const float *numbers, int count); 126 extern cJSON *cJSON_CreateDoubleArray(const double *numbers, int count); 127 extern cJSON *cJSON_CreateStringArray(const char **strings, int count); 128 129 /* Append item to the specified array/object. */ 130 extern void cJSON_AddItemToArray(cJSON *array, cJSON *item); 131 extern void cJSON_AddItemToObject(cJSON *object, const char *string, cJSON *item); 132 /* Use this when string is definitely const (i.e. a literal, or as good as), and will definitely survive the cJSON object. 133 * WARNING: When this function was used, make sure to always check that (item->type & cJSON_StringIsConst) is zero before 134 * writing to `item->string` */ 135 extern void cJSON_AddItemToObjectCS(cJSON *object, const char *string, cJSON *item); 136 /* 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. */ 137 extern void cJSON_AddItemReferenceToArray(cJSON *array, cJSON *item); 138 extern void cJSON_AddItemReferenceToObject(cJSON *object, const char *string, cJSON *item); 139 140 /* Remove/Detatch items from Arrays/Objects. */ 141 extern cJSON *cJSON_DetachItemFromArray(cJSON *array, int which); 142 extern void cJSON_DeleteItemFromArray(cJSON *array, int which); 143 extern cJSON *cJSON_DetachItemFromObject(cJSON *object, const char *string); 144 extern void cJSON_DeleteItemFromObject(cJSON *object, const char *string); 145 146 /* Update array items. */ 147 extern void cJSON_InsertItemInArray(cJSON *array, int which, cJSON *newitem); /* Shifts pre-existing items to the right. */ 148 extern void cJSON_ReplaceItemInArray(cJSON *array, int which, cJSON *newitem); 149 extern void cJSON_ReplaceItemInObject(cJSON *object,const char *string,cJSON *newitem); 150 151 /* Duplicate a cJSON item */ 152 extern cJSON *cJSON_Duplicate(const cJSON *item, int recurse); 153 /* Duplicate will create a new, identical cJSON item to the one you pass, in new memory that will 154 need to be released. With recurse!=0, it will duplicate any children connected 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 terminated, and to retrieve the pointer to the final byte parsed. */ 158 /* 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. */ 159 extern cJSON *cJSON_ParseWithOpts(const char *value, const char **return_parse_end, int require_null_terminated); 160 161 extern void cJSON_Minify(char *json); 162 163 /* Macros for creating things quickly. */ 164 #define cJSON_AddNullToObject(object,name) cJSON_AddItemToObject(object, name, cJSON_CreateNull()) 165 #define cJSON_AddTrueToObject(object,name) cJSON_AddItemToObject(object, name, cJSON_CreateTrue()) 166 #define cJSON_AddFalseToObject(object,name) cJSON_AddItemToObject(object, name, cJSON_CreateFalse()) 167 #define cJSON_AddBoolToObject(object,name,b) cJSON_AddItemToObject(object, name, cJSON_CreateBool(b)) 168 #define cJSON_AddNumberToObject(object,name,n) cJSON_AddItemToObject(object, name, cJSON_CreateNumber(n)) 169 #define cJSON_AddStringToObject(object,name,s) cJSON_AddItemToObject(object, name, cJSON_CreateString(s)) 170 #define cJSON_AddRawToObject(object,name,s) cJSON_AddItemToObject(object, name, cJSON_CreateRaw(s)) 171 172 /* When assigning an integer value, it needs to be propagated to valuedouble too. */ 173 #define cJSON_SetIntValue(object, number) ((object) ? (object)->valueint = (object)->valuedouble = (number) : (number)) 174 /* helper for the cJSON_SetNumberValue macro */ 175 extern double cJSON_SetNumberHelper(cJSON *object, double number); 176 #define cJSON_SetNumberValue(object, number) ((object) ? cJSON_SetNumberHelper(object, (double)number) : (number)) 177 178 /* Macro for iterating over an array */ 179 #define cJSON_ArrayForEach(pos, head) for(pos = (head)->child; pos != NULL; pos = pos->next) 180 181 #ifdef __cplusplus 182 } 183 #endif 184 185 #endif 186