navit  0.5.1-trunk
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Macros Groups
cJSON.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 
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 */
62 extern void cJSON_InitHooks(cJSON_Hooks* hooks);
63 
64 
65 /* Supply a block of JSON, and this returns a cJSON object you can interrogate. Call cJSON_Delete when finished. */
66 extern cJSON *cJSON_Parse(const char *value);
67 /* Render a cJSON entity to text for transfer/storage. Free the char* when finished. */
68 extern char *cJSON_Print(cJSON *item);
69 /* Render a cJSON entity to text for transfer/storage without any formatting. Free the char* when finished. */
70 extern char *cJSON_PrintUnformatted(cJSON *item);
71 /* Delete a cJSON entity and all subentities. */
72 extern void cJSON_Delete(cJSON *c);
73 
74 /* Returns the number of items in an array (or object). */
75 extern int cJSON_GetArraySize(cJSON *array);
76 /* Retrieve item number "item" from array "array". Returns NULL if unsuccessful. */
77 extern cJSON *cJSON_GetArrayItem(cJSON *array,int item);
78 /* Get item "string" from object. Case insensitive. */
79 extern cJSON *cJSON_GetObjectItem(cJSON *object,const char *string);
80 
81 /* 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. */
82 extern const char *cJSON_GetErrorPtr(void);
83 
84 /* These calls create a cJSON item of the appropriate type. */
85 extern cJSON *cJSON_CreateNull(void);
86 extern cJSON *cJSON_CreateTrue(void);
87 extern cJSON *cJSON_CreateFalse(void);
88 extern cJSON *cJSON_CreateBool(int b);
89 extern cJSON *cJSON_CreateNumber(double num);
90 extern cJSON *cJSON_CreateString(const char *string);
91 extern cJSON *cJSON_CreateArray(void);
92 extern cJSON *cJSON_CreateObject(void);
93 
94 /* These utilities create an Array of count items. */
95 extern cJSON *cJSON_CreateIntArray(int *numbers,int count);
96 extern cJSON *cJSON_CreateFloatArray(float *numbers,int count);
97 extern cJSON *cJSON_CreateDoubleArray(double *numbers,int count);
98 extern cJSON *cJSON_CreateStringArray(const char **strings,int count);
99 
100 /* Append item to the specified array/object. */
101 extern void cJSON_AddItemToArray(cJSON *array, cJSON *item);
102 extern void cJSON_AddItemToObject(cJSON *object,const char *string,cJSON *item);
103 /* 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. */
104 extern void cJSON_AddItemReferenceToArray(cJSON *array, cJSON *item);
105 extern void cJSON_AddItemReferenceToObject(cJSON *object,const char *string,cJSON *item);
106 
107 /* Remove/Detatch items from Arrays/Objects. */
108 extern cJSON *cJSON_DetachItemFromArray(cJSON *array,int which);
109 extern void cJSON_DeleteItemFromArray(cJSON *array,int which);
110 extern cJSON *cJSON_DetachItemFromObject(cJSON *object,const char *string);
111 extern void cJSON_DeleteItemFromObject(cJSON *object,const char *string);
112 
113 /* Update array items. */
114 extern void cJSON_ReplaceItemInArray(cJSON *array,int which,cJSON *newitem);
115 extern void cJSON_ReplaceItemInObject(cJSON *object,const char *string,cJSON *newitem);
116 
117 #define cJSON_AddNullToObject(object,name) cJSON_AddItemToObject(object, name, cJSON_CreateNull())
118 #define cJSON_AddTrueToObject(object,name) cJSON_AddItemToObject(object, name, cJSON_CreateTrue())
119 #define cJSON_AddFalseToObject(object,name) cJSON_AddItemToObject(object, name, cJSON_CreateFalse())
120 #define cJSON_AddNumberToObject(object,name,n) cJSON_AddItemToObject(object, name, cJSON_CreateNumber(n))
121 #define cJSON_AddStringToObject(object,name,s) cJSON_AddItemToObject(object, name, cJSON_CreateString(s))
122 
123 #ifdef __cplusplus
124 }
125 #endif
126 
127 #endif
cJSON * cJSON_CreateNumber(double num)
Definition: cJSON.c:727
void cJSON_InitHooks(cJSON_Hooks *hooks)
Definition: cJSON.c:61
cJSON * cJSON_DetachItemFromArray(cJSON *array, int which)
Definition: cJSON.c:659
void cJSON_Delete(cJSON *c)
Definition: cJSON.c:80
void cJSON_AddItemToObject(cJSON *object, const char *string, cJSON *item)
Definition: cJSON.c:646
Definition: item.h:99
cJSON * cJSON_CreateNull(void)
Definition: cJSON.c:707
int valueint
Definition: cJSON.h:50
char * valuestring
Definition: cJSON.h:49
void cJSON_DeleteItemFromArray(cJSON *array, int which)
Definition: cJSON.c:669
const char * cJSON_GetErrorPtr(void)
Definition: cJSON.c:37
cJSON * cJSON_CreateFalse(void)
Definition: cJSON.c:717
static GValue value
Definition: datawindow.c:42
char * cJSON_PrintUnformatted(cJSON *item)
Definition: cJSON.c:323
cJSON * cJSON_CreateArray(void)
Definition: cJSON.c:744
cJSON * cJSON_DetachItemFromObject(cJSON *object, const char *string)
Definition: cJSON.c:672
Definition: cJSON.h:43
void(* free_fn)(void *ptr)
Definition: cJSON.h:58
cJSON * cJSON_CreateObject(void)
Definition: cJSON.c:749
cJSON * cJSON_CreateFloatArray(float *numbers, int count)
Definition: cJSON.c:767
void cJSON_DeleteItemFromObject(cJSON *object, const char *string)
Definition: cJSON.c:679
struct cJSON * child
Definition: cJSON.h:45
char * string
Definition: cJSON.h:53
void cJSON_ReplaceItemInObject(cJSON *object, const char *string, cJSON *newitem)
Definition: cJSON.c:696
cJSON * cJSON_GetArrayItem(cJSON *array, int item)
Definition: cJSON.c:608
void cJSON_ReplaceItemInArray(cJSON *array, int which, cJSON *newitem)
Definition: cJSON.c:684
struct cJSON cJSON
cJSON * cJSON_Parse(const char *value)
Definition: cJSON.c:307
Definition: cJSON.h:56
cJSON * cJSON_CreateDoubleArray(double *numbers, int count)
Definition: cJSON.c:778
struct cJSON * next
Definition: cJSON.h:44
int cJSON_GetArraySize(cJSON *array)
Definition: cJSON.c:602
struct cJSON_Hooks cJSON_Hooks
void cJSON_AddItemReferenceToArray(cJSON *array, cJSON *item)
Definition: cJSON.c:652
cJSON * cJSON_CreateBool(int b)
Definition: cJSON.c:722
void cJSON_AddItemReferenceToObject(cJSON *object, const char *string, cJSON *item)
Definition: cJSON.c:655
char * cJSON_Print(cJSON *item)
Definition: cJSON.c:320
cJSON * cJSON_CreateString(const char *string)
Definition: cJSON.c:736
struct cJSON * prev
Definition: cJSON.h:44
int type
Definition: cJSON.h:47
cJSON * cJSON_CreateIntArray(int *numbers, int count)
Definition: cJSON.c:756
cJSON * cJSON_CreateStringArray(const char **strings, int count)
Definition: cJSON.c:789
double valuedouble
Definition: cJSON.h:51
cJSON * cJSON_CreateTrue(void)
Definition: cJSON.c:712
void cJSON_AddItemToArray(cJSON *array, cJSON *item)
Definition: cJSON.c:636
cJSON * cJSON_GetObjectItem(cJSON *object, const char *string)
Definition: cJSON.c:613