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