extlibs/cjson/cJSON.h

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