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 (1 << 0)
33: #define cJSON_True (1 << 1)
34: #define cJSON_NULL (1 << 2)
35: #define cJSON_Number (1 << 3)
36: #define cJSON_String (1 << 4)
37: #define cJSON_Array (1 << 5)
38: #define cJSON_Object (1 << 6)
39:
40: #define cJSON_IsReference 256
41: #define cJSON_StringIsConst 512
42:
43: /* The cJSON structure: */
44: typedef struct cJSON {
45: struct cJSON *next,*prev; /* next/prev allow you to walk array/object chains. Alternatively, use GetArraySize/GetArrayItem/GetObjectItem */
46: struct cJSON *child; /* An array or object item will have a child pointer pointing to a chain of the items in the array/object. */
47:
48: int type; /* The type of the item, as above. */
49:
50: char *valuestring; /* The item's string, if type==cJSON_String */
51: int64_t valueint; /* The item's number, if type==cJSON_Number */
52: double valuedouble; /* The item's number, if type==cJSON_Number */
53:
54: char *string; /* The item's name string, if this item is the child of, or is in the list of subitems of an object. */
55: } cJSON;
56:
57: typedef struct cJSON_Hooks {
58: void *(*malloc_fn)(size_t sz);
59: void (*free_fn)(void *ptr);
60: } cJSON_Hooks;
61:
62: /* Supply malloc, realloc and free functions to cJSON */
63: extern void cJSON_InitHooks(cJSON_Hooks* hooks);
64:
65:
66: /* Supply a block of JSON, and this returns a cJSON object you can interrogate. Call cJSON_Delete when finished. */
67: extern cJSON *cJSON_Parse(const char *value);
68: /* Render a cJSON entity to text for transfer/storage. Free the char* when finished. */
69: extern char *cJSON_Print(cJSON *item);
70: /* Render a cJSON entity to text for transfer/storage without any formatting. Free the char* when finished. */
71: extern char *cJSON_PrintUnformatted(cJSON *item);
72: /* 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 */
73: extern char *cJSON_PrintBuffered(cJSON *item,int prebuffer,int fmt);
74: /* Delete a cJSON entity and all subentities. */
75: extern void cJSON_Delete(cJSON *c);
76:
77: /* Returns the number of items in an array (or object). */
78: extern int cJSON_GetArraySize(cJSON *array);
79: /* Retrieve item number "item" from array "array". Returns NULL if unsuccessful. */
80: extern cJSON *cJSON_GetArrayItem(cJSON *array,int item);
81: /* Get item "string" from object. Case insensitive. */
82: extern cJSON *cJSON_GetObjectItem(cJSON *object,const char *string);
83: extern int cJSON_HasObjectItem(cJSON *object,const char *string);
84: /* 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. */
85: extern const char *cJSON_GetErrorPtr(void);
86:
87: /* These calls create a cJSON item of the appropriate type. */
88: extern cJSON *cJSON_CreateNull(void);
89: extern cJSON *cJSON_CreateTrue(void);
90: extern cJSON *cJSON_CreateFalse(void);
91: extern cJSON *cJSON_CreateBool(int b);
92: extern cJSON *cJSON_CreateNumber(double num);
93: extern cJSON *cJSON_CreateString(const char *string);
94: extern cJSON *cJSON_CreateArray(void);
95: extern cJSON *cJSON_CreateObject(void);
96:
97: /* These utilities create an Array of count items. */
98: extern cJSON *cJSON_CreateIntArray(const int *numbers,int count);
99: extern cJSON *cJSON_CreateFloatArray(const float *numbers,int count);
100: extern cJSON *cJSON_CreateDoubleArray(const double *numbers,int count);
101: extern cJSON *cJSON_CreateStringArray(const char **strings,int count);
102:
103: /* Append item to the specified array/object. */
104: extern void cJSON_AddItemToArray(cJSON *array, cJSON *item);
105: extern void cJSON_AddItemToObject(cJSON *object,const char *string,cJSON *item);
106: extern void cJSON_AddItemToObjectCS(cJSON *object,const char *string,cJSON *item); /* Use this when string is definitely const (i.e. a literal, or as good as), and will definitely survive the cJSON object */
107: /* 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. */
108: extern void cJSON_AddItemReferenceToArray(cJSON *array, cJSON *item);
109: extern void cJSON_AddItemReferenceToObject(cJSON *object,const char *string,cJSON *item);
110:
111: /* Remove/Detatch items from Arrays/Objects. */
112: extern cJSON *cJSON_DetachItemFromArray(cJSON *array,int which);
113: extern void cJSON_DeleteItemFromArray(cJSON *array,int which);
114: extern cJSON *cJSON_DetachItemFromObject(cJSON *object,const char *string);
115: extern void cJSON_DeleteItemFromObject(cJSON *object,const char *string);
116:
117: /* Update array items. */
118: extern void cJSON_InsertItemInArray(cJSON *array,int which,cJSON *newitem); /* Shifts pre-existing items to the right. */
119: extern void cJSON_ReplaceItemInArray(cJSON *array,int which,cJSON *newitem);
120: extern void cJSON_ReplaceItemInObject(cJSON *object,const char *string,cJSON *newitem);
121:
122: /* Duplicate a cJSON item */
123: extern cJSON *cJSON_Duplicate(cJSON *item,int recurse);
124: /* Duplicate will create a new, identical cJSON item to the one you pass, in new memory that will
125: need to be released. With recurse!=0, it will duplicate any children connected to the item.
126: The item->next and ->prev pointers are always zero on return from Duplicate. */
127:
128: /* ParseWithOpts allows you to require (and check) that the JSON is null terminated, and to retrieve the pointer to the final byte parsed. */
129: /* 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. */
130: extern cJSON *cJSON_ParseWithOpts(const char *value,const char **return_parse_end,int require_null_terminated);
131:
132: extern void cJSON_Minify(char *json);
133:
134: /* Macros for creating things quickly. */
135: #define cJSON_AddNullToObject(object,name) cJSON_AddItemToObject(object, name, cJSON_CreateNull())
136: #define cJSON_AddTrueToObject(object,name) cJSON_AddItemToObject(object, name, cJSON_CreateTrue())
137: #define cJSON_AddFalseToObject(object,name) cJSON_AddItemToObject(object, name, cJSON_CreateFalse())
138: #define cJSON_AddBoolToObject(object,name,b) cJSON_AddItemToObject(object, name, cJSON_CreateBool(b))
139: #define cJSON_AddNumberToObject(object,name,n) cJSON_AddItemToObject(object, name, cJSON_CreateNumber(n))
140: #define cJSON_AddStringToObject(object,name,s) cJSON_AddItemToObject(object, name, cJSON_CreateString(s))
141:
142: /* When assigning an integer value, it needs to be propagated to valuedouble too. */
143: #define cJSON_SetIntValue(object,val) ((object)?(object)->valueint=(object)->valuedouble=(val):(val))
144: #define cJSON_SetNumberValue(object,val) ((object)?(object)->valueint=(object)->valuedouble=(val):(val))
145:
146: /* Macro for iterating over an array */
147: #define cJSON_ArrayForEach(pos, head) for(pos = (head)->child; pos != NULL; pos = pos->next)
148:
149: #ifdef __cplusplus
150: }
151: #endif
152:
153: #endif
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>
![[BACK]](/icons/cvsweb/back.gif){kind=icon}
Return to cjson.h CVS log ![[TXT]](/icons/cvsweb/text.gif){kind=icon}
![[DIR]](/icons/cvsweb/dir.gif){kind=icon}
Up to [ELWIX - Embedded LightWeight unIX -] / embedaddon / iperf / src