FreeSWITCH API Documentation  1.7.0
switch_json.h
Go to the documentation of this file.
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 "switch.h"
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 /* The cJSON structure: */
43 typedef struct cJSON {
44  struct cJSON *next,*prev; /* next/prev allow you to walk array/object chains. Alternatively, use GetArraySize/GetArrayItem/GetObjectItem */
45  struct cJSON *child; /* An array or object item will have a child pointer pointing to a chain of the items in the array/object. */
46 
47  int type; /* The type of the item, as above. */
48 
49  char *valuestring; /* The item's string, if type==cJSON_String */
50  int valueint; /* The item's number, if type==cJSON_Number */
51  double valuedouble; /* The item's number, if type==cJSON_Number */
52 
53  char *string; /* The item's name string, if this item is the child of, or is in the list of subitems of an object. */
54 } cJSON;
55 
56 typedef struct cJSON_Hooks {
57  void *(*malloc_fn)(size_t sz);
58  void (*free_fn)(void *ptr);
59 } cJSON_Hooks;
60 
61 /* Supply malloc, realloc and free functions to cJSON */
63 
64 
65 /* Supply a block of JSON, and this returns a cJSON object you can interrogate. Call cJSON_Delete when finished. */
66 SWITCH_DECLARE(cJSON *)cJSON_Parse(const char *value);
67 /* Render a cJSON entity to text for transfer/storage. Free the char* when finished. */
68 SWITCH_DECLARE(char *)cJSON_Print(cJSON *item);
69 /* Render a cJSON entity to text for transfer/storage without any formatting. Free the char* when finished. */
71 /* Delete a cJSON entity and all subentities. */
73 
74 /* Returns the number of items in an array (or object). */
76 /* Retrieve item number "item" from array "array". Returns NULL if unsuccessful. */
77 SWITCH_DECLARE(cJSON *)cJSON_GetArrayItem(cJSON *array,int item);
78 /* Get item "string" from object. Case insensitive. */
79 SWITCH_DECLARE(cJSON *)cJSON_GetObjectItem(const cJSON *object,const char *string);
80 SWITCH_DECLARE(const char *)cJSON_GetObjectCstr(const cJSON *object, const char *string);
81 
82 /* 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. */
83 SWITCH_DECLARE(const char *)cJSON_GetErrorPtr(void);
84 
85 /* These calls create a cJSON item of the appropriate type. */
91 SWITCH_DECLARE(cJSON *)cJSON_CreateString(const char *string);
94 
95 /* These utilities create an Array of count items. */
96 SWITCH_DECLARE(cJSON *)cJSON_CreateIntArray(int *numbers,int count);
97 SWITCH_DECLARE(cJSON *)cJSON_CreateFloatArray(float *numbers,int count);
98 SWITCH_DECLARE(cJSON *)cJSON_CreateDoubleArray(double *numbers,int count);
99 SWITCH_DECLARE(cJSON *)cJSON_CreateStringArray(const char **strings,int count);
100 
101 /* Append item to the specified array/object. */
102 SWITCH_DECLARE(void) cJSON_AddItemToArray(cJSON *array, cJSON *item);
103 SWITCH_DECLARE(void) cJSON_AddItemToObject(cJSON *object,const char *string,cJSON *item);
104 /* 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. */
106 SWITCH_DECLARE(void) cJSON_AddItemReferenceToObject(cJSON *object,const char *string,cJSON *item);
107 
108 /* Remove/Detatch items from Arrays/Objects. */
110 SWITCH_DECLARE(void) cJSON_DeleteItemFromArray(cJSON *array,int which);
111 SWITCH_DECLARE(cJSON *)cJSON_DetachItemFromObject(cJSON *object,const char *string);
112 SWITCH_DECLARE(void) cJSON_DeleteItemFromObject(cJSON *object,const char *string);
113 
114 /* Update array items. */
115 SWITCH_DECLARE(void) cJSON_ReplaceItemInArray(cJSON *array,int which,cJSON *newitem);
116 SWITCH_DECLARE(void) cJSON_ReplaceItemInObject(cJSON *object,const char *string,cJSON *newitem);
117 
118 /* Duplicate a cJSON item */
119 SWITCH_DECLARE(cJSON *) cJSON_Duplicate(cJSON *item,int recurse);
120 /* Duplicate will create a new, identical cJSON item to the one you pass, in new memory that will
121  need to be released. With recurse!=0, it will duplicate any children connected to the item.
122  The item->next and ->prev pointers are always zero on return from Duplicate. */
123 
124 
125 #define cJSON_AddNullToObject(object,name) cJSON_AddItemToObject(object, name, cJSON_CreateNull())
126 #define cJSON_AddTrueToObject(object,name) cJSON_AddItemToObject(object, name, cJSON_CreateTrue())
127 #define cJSON_AddFalseToObject(object,name) cJSON_AddItemToObject(object, name, cJSON_CreateFalse())
128 #define cJSON_AddNumberToObject(object,name,n) cJSON_AddItemToObject(object, name, cJSON_CreateNumber(n))
129 #define cJSON_AddStringToObject(object,name,s) cJSON_AddItemToObject(object, name, cJSON_CreateString(s))
130 
131 SWITCH_DECLARE(cJSON *) cJSON_CreateStringPrintf(const char *fmt, ...);
132 
133 static inline cJSON *json_add_child_obj(cJSON *json, const char *name, cJSON *obj)
134 {
135  cJSON *new_json = NULL;
136 
137  switch_assert(json);
138 
139  if (obj) {
140  new_json = obj;
141  } else {
142  new_json = cJSON_CreateObject();
143  }
144 
145  switch_assert(new_json);
146 
147  cJSON_AddItemToObject(json, name, new_json);
148 
149  return new_json;
150 }
151 
152 static inline cJSON *json_add_child_array(cJSON *json, const char *name)
153 {
154  cJSON *new_json = NULL;
155 
156  switch_assert(json);
157 
158  new_json = cJSON_CreateArray();
159  switch_assert(new_json);
160 
161  cJSON_AddItemToObject(json, name, new_json);
162 
163  return new_json;
164 }
165 
166 static inline cJSON *json_add_child_string(cJSON *json, const char *name, const char *val)
167 {
168  cJSON *new_json = NULL;
169 
170  switch_assert(json);
171 
172  new_json = cJSON_CreateString(val);
173  switch_assert(new_json);
174 
175  cJSON_AddItemToObject(json, name, new_json);
176 
177  return new_json;
178 }
179 
180 #ifdef __cplusplus
181 }
182 #endif
183 
184 #endif
cJSON * cJSON_CreateObject(void)
Definition: switch_json.c:544
cJSON * cJSON_CreateNumber(double num)
Definition: switch_json.c:541
cJSON * cJSON_CreateStringArray(const char **strings, int count)
Definition: switch_json.c:550
cJSON * cJSON_CreateNull(void)
Definition: switch_json.c:537
void cJSON_DeleteItemFromArray(cJSON *array, int which)
Definition: switch_json.c:526
cJSON * cJSON_CreateStringPrintf(const char *fmt,...)
Definition: switch_json.c:580
char * cJSON_Print(cJSON *item)
Definition: switch_json.c:284
int valueint
Definition: switch_json.h:50
void cJSON_ReplaceItemInObject(cJSON *object, const char *string, cJSON *newitem)
Definition: switch_json.c:534
char * valuestring
Definition: switch_json.h:49
int cJSON_GetArraySize(cJSON *array)
Definition: switch_json.c:496
void cJSON_InitHooks(cJSON_Hooks *hooks)
Definition: switch_json.c:72
static cJSON * json_add_child_array(cJSON *json, const char *name)
Definition: switch_json.h:152
void cJSON_ReplaceItemInArray(cJSON *array, int which, cJSON *newitem)
Definition: switch_json.c:531
void cJSON_DeleteItemFromObject(cJSON *object, const char *string)
Definition: switch_json.c:528
cJSON * cJSON_CreateTrue(void)
Definition: switch_json.c:538
cJSON * cJSON_CreateBool(int b)
Definition: switch_json.c:540
cJSON * cJSON_CreateIntArray(int *numbers, int count)
Definition: switch_json.c:547
void(* free_fn)(void *ptr)
Definition: switch_json.h:58
cJSON * cJSON_CreateDoubleArray(double *numbers, int count)
Definition: switch_json.c:549
cJSON * cJSON_CreateFalse(void)
Definition: switch_json.c:539
struct cJSON * child
Definition: switch_json.h:45
static cJSON * json_add_child_obj(cJSON *json, const char *name, cJSON *obj)
Definition: switch_json.h:133
char * string
Definition: switch_json.h:53
cJSON * cJSON_GetArrayItem(cJSON *array, int item)
Definition: switch_json.c:497
void cJSON_AddItemToArray(cJSON *array, cJSON *item)
Definition: switch_json.c:519
struct cJSON_Hooks cJSON_Hooks
struct cJSON * next
Definition: switch_json.h:44
void cJSON_AddItemReferenceToObject(cJSON *object, const char *string, cJSON *item)
Definition: switch_json.c:522
const char * cJSON_GetObjectCstr(const cJSON *object, const char *string)
Definition: switch_json.c:501
void cJSON_AddItemToObject(cJSON *object, const char *string, cJSON *item)
Definition: switch_json.c:520
cJSON * cJSON_GetObjectItem(const cJSON *object, const char *string)
Definition: switch_json.c:498
const char * cJSON_GetErrorPtr(void)
Definition: switch_json.c:38
cJSON * cJSON_CreateString(const char *string)
Definition: switch_json.c:542
cJSON * cJSON_Parse(const char *value)
Definition: switch_json.c:273
Main Library Header.
#define SWITCH_DECLARE(type)
struct cJSON * prev
Definition: switch_json.h:44
cJSON * cJSON_DetachItemFromArray(cJSON *array, int which)
Definition: switch_json.c:524
cJSON * cJSON_Duplicate(cJSON *item, int recurse)
Definition: switch_json.c:553
struct cJSON cJSON
cJSON * cJSON_CreateArray(void)
Definition: switch_json.c:543
int type
Definition: switch_json.h:47
cJSON * cJSON_DetachItemFromObject(cJSON *object, const char *string)
Definition: switch_json.c:527
cJSON * cJSON_CreateFloatArray(float *numbers, int count)
Definition: switch_json.c:548
#define switch_assert(expr)
double valuedouble
Definition: switch_json.h:51
void cJSON_Delete(cJSON *c)
Definition: switch_json.c:93
void cJSON_AddItemReferenceToArray(cJSON *array, cJSON *item)
Definition: switch_json.c:521
static cJSON * json_add_child_string(cJSON *json, const char *name, const char *val)
Definition: switch_json.h:166
char * cJSON_PrintUnformatted(cJSON *item)
Definition: switch_json.c:285