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 /* cJSON Types: */
32 #define cJSON_False 0
33 #define cJSON_True 1
34 #define cJSON_NULL 2
35 #define cJSON_Number 3
36 #define cJSON_String 4
37 #define cJSON_Array 5
38 #define cJSON_Object 6
39 
40 #define cJSON_IsReference 256
41 
42 typedef struct cJSON_PoolBlock {
43     struct cJSON_PoolBlock * next;
44 
45     /* Not visible here, however the allocation system
46         will allocate this structure along with all the
47         elements at once, where the elements will follow
48         this structure */
49 } cJSON_PoolBlock;
50 
51 typedef struct cJSON_Pool {
52     /* linked list of allocation blocks */
53     cJSON_PoolBlock * blocks;
54 
55     /* the number of references to this pool */
56     unsigned int refcount;
57 
58     /* linked list of available cJSON allocations */
59     struct cJSON * free_items;
60 } cJSON_Pool;
61 
62 /* The cJSON structure: */
63 typedef struct cJSON {
64         struct cJSON *next,*prev; /* next/prev allow you to walk
65                                      array/object
66                                      chains. Alternatively, use
67                                      GetArraySize/GetArrayItem/GetObjectItem */
68         struct cJSON *child; /* An array or object item will have a
69                                 child pointer pointing to a chain of
70                                 the items in the array/object. */
71 
72         int type; /* The type of the item, as above. */
73 
74         char *valuestring; /* The item's string, if type==cJSON_String */
75         int valueint; /* The item's number, if type==cJSON_Number */
76         double valuedouble; /* The item's number, if type==cJSON_Number */
77 
78         char *string; /* The item's name string, if this item is the
79                          child of, or is in the list of subitems of an
80                          object. */
81 
82         struct cJSON_Pool *alloc_pool;
83 } cJSON;
84 
85 typedef struct cJSON_Hooks {
86       void *(*malloc_fn)(size_t sz);
87       void (*free_fn)(void *ptr);
88 } cJSON_Hooks;
89 
90 /* Supply malloc, realloc and free functions to cJSON */
91 extern void cJSON_InitHooks(cJSON_Hooks* hooks);
92 
93 
94 /* Supply a block of JSON, and this returns a cJSON object you can
95    interrogate. Call cJSON_Delete when finished. */
96 extern cJSON *cJSON_Parse(const char *value);
97 /* Render a cJSON entity to text for transfer/storage. Free the char*
98    when finished. */
99 extern char  *cJSON_Print(cJSON *item);
100 /* Render a cJSON entity to text for transfer/storage without any
101    formatting. Free the char* when finished. */
102 extern char  *cJSON_PrintUnformatted(cJSON *item);
103 /* Delete a cJSON entity and all subentities. */
104 extern void   cJSON_Delete(cJSON *c);
105 
106 /* Returns the number of items in an array (or object). */
107 extern int        cJSON_GetArraySize(cJSON *array);
108 /* Retrieve item number "item" from array "array". Returns NULL if
109    unsuccessful. */
110 extern cJSON *cJSON_GetArrayItem(cJSON *array,int item);
111 /* Get item "string" from object. Case insensitive. */
112 extern cJSON *cJSON_GetObjectItem(cJSON *object,const char *string);
113 
114 /* These calls create a cJSON item of the appropriate type. */
115 extern cJSON *cJSON_CreateNull(void);
116 extern cJSON *cJSON_CreateTrue(void);
117 extern cJSON *cJSON_CreateFalse(void);
118 extern cJSON *cJSON_CreateNumber(double num);
119 extern cJSON *cJSON_CreateString(const char *string);
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(int *numbers,int count);
125 extern cJSON *cJSON_CreateFloatArray(float *numbers,int count);
126 extern cJSON *cJSON_CreateDoubleArray(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 /* Append reference to item to the specified array/object. Use this
133    when you want to add an existing cJSON to a new cJSON, but don't
134    want to corrupt your existing cJSON. */
135 extern void cJSON_AddItemReferenceToArray(cJSON *array, cJSON *item);
136 extern void cJSON_AddItemReferenceToObject(cJSON *object,const char *string,cJSON *item);
137 
138 /* Remove/Detatch items from Arrays/Objects. */
139 extern cJSON *cJSON_DetachItemFromArray(cJSON *array,int which);
140 extern void   cJSON_DeleteItemFromArray(cJSON *array,int which);
141 extern cJSON *cJSON_DetachItemFromObject(cJSON *object,const char *string);
142 extern void   cJSON_DeleteItemFromObject(cJSON *object,const char *string);
143 
144 /* Update array items. */
145 extern void cJSON_ReplaceItemInArray(cJSON *array,int which,cJSON *newitem);
146 extern void cJSON_ReplaceItemInObject(cJSON *object,const char *string,cJSON *newitem);
147 
148 #define cJSON_AddNullToObject(object,name)      cJSON_AddItemToObject(object, name, cJSON_CreateNull())
149 #define cJSON_AddTrueToObject(object,name)      cJSON_AddItemToObject(object, name, cJSON_CreateTrue())
150 #define cJSON_AddFalseToObject(object,name)             cJSON_AddItemToObject(object, name, cJSON_CreateFalse())
151 #define cJSON_AddNumberToObject(object,name,n)  cJSON_AddItemToObject(object, name, cJSON_CreateNumber(n))
152 #define cJSON_AddStringToObject(object,name,s)  cJSON_AddItemToObject(object, name, cJSON_CreateString(s))
153 
154 #ifdef __cplusplus
155 }
156 #endif
157 
158 #endif
159