Mercurial > wgsdk

comparison include/json.h @ 12:dd427b7cc459 default tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
json: replace with nxjson library more lightweight, reduces the binary size by about 40 kb
author Paper <paper@paper.us.eu.org>
date Fri, 15 Mar 2024 20:46:18 -0400
parents e6a594f16403
children
comparison
equal deleted inserted replaced
11:e6a594f16403 12:dd427b7cc459
1 /* 1 /*
2 Copyright (c) 2009-2017 Dave Gamble and cJSON contributors 2 * Copyright (c) 2013 Yaroslav Stavnichiy <yarosla@gmail.com>
3 *
4 * This file is part of NXJSON.
5 *
6 * NXJSON is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU Lesser General Public License
8 * as published by the Free Software Foundation, either version 3
9 * of the License, or (at your option) any later version.
10 *
11 * NXJSON is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU Lesser General Public License for more details.
15 *
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with NXJSON. If not, see <http://www.gnu.org/licenses/>.
18 */
3 19
4 Permission is hereby granted, free of charge, to any person obtaining a copy 20 #ifndef NXJSON_H
5 of this software and associated documentation files (the "Software"), to deal 21 #define NXJSON_H
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 22
11 The above copyright notice and this permission notice shall be included in 23 #ifdef __cplusplus
12 all copies or substantial portions of the Software. 24 extern "C" {
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 25 #endif
30 26
31 #if !defined(__WINDOWS__) && (defined(WIN32) || defined(WIN64) || defined(_MSC_VER) || defined(_WIN32)) 27 #ifndef NXJSON_TYPE_U64
32 #define __WINDOWS__ 28
29 #include <stdint.h>
30
31 typedef uint64_t nxjson_u64;
33 #endif 32 #endif
34 33
35 #ifdef __WINDOWS__ 34 #ifndef NXJSON_TYPE_S64
36 35
37 /* When compiling for windows, we specify a specific calling convention to avoid issues where we are being called from a project with a different default calling convention. For windows you have 3 define options: 36 #include <stdint.h>
38 37
39 CJSON_HIDE_SYMBOLS - Define this in the case where you don't want to ever dllexport symbols 38 typedef uint64_t nxjson_s64;
40 CJSON_EXPORT_SYMBOLS - Define this on library build when you want to dllexport symbols (default)
41 CJSON_IMPORT_SYMBOLS - Define this if you want to dllimport symbol
42
43 For *nix builds that support visibility attribute, you can define similar behavior by
44
45 setting default visibility to hidden by adding
46 -fvisibility=hidden (for gcc)
47 or
48 -xldscope=hidden (for sun cc)
49 to CFLAGS
50
51 then using the CJSON_API_VISIBILITY flag to "export" the same symbols the way CJSON_EXPORT_SYMBOLS does
52
53 */
54
55 #define CJSON_CDECL __cdecl
56 #define CJSON_STDCALL __stdcall
57
58 /* export symbols by default, this is necessary for copy pasting the C and header file */
59 #if !defined(CJSON_HIDE_SYMBOLS) && !defined(CJSON_IMPORT_SYMBOLS) && !defined(CJSON_EXPORT_SYMBOLS)
60 #define CJSON_EXPORT_SYMBOLS
61 #endif 39 #endif
62 40
63 #if defined(CJSON_HIDE_SYMBOLS) 41 typedef enum nx_json_type {
64 #define CJSON_PUBLIC(type) type CJSON_STDCALL 42 NX_JSON_NULL, // this is null value
65 #elif defined(CJSON_EXPORT_SYMBOLS) 43 NX_JSON_OBJECT, // this is an object; properties can be found in child nodes
66 #define CJSON_PUBLIC(type) __declspec(dllexport) type CJSON_STDCALL 44 NX_JSON_ARRAY, // this is an array; items can be found in child nodes
67 #elif defined(CJSON_IMPORT_SYMBOLS) 45 NX_JSON_STRING, // this is a string; value can be found in text_value field
68 #define CJSON_PUBLIC(type) __declspec(dllimport) type CJSON_STDCALL 46 NX_JSON_INTEGER, // this is an integer; value can be found in int_value field
69 #endif 47 NX_JSON_DOUBLE, // this is a double; value can be found in dbl_value field
70 #else /* !__WINDOWS__ */ 48 NX_JSON_BOOL // this is a boolean; value can be found in int_value field
71 #define CJSON_CDECL 49 } nx_json_type;
72 #define CJSON_STDCALL
73 50
74 #if (defined(__GNUC__) || defined(__SUNPRO_CC) || defined (__SUNPRO_C)) && defined(CJSON_API_VISIBILITY) 51 typedef struct nx_json {
75 #define CJSON_PUBLIC(type) __attribute__((visibility("default"))) type 52 nx_json_type type; // type of json node, see above
76 #else 53 const char *key; // key of the property; for object's children only
77 #define CJSON_PUBLIC(type) type 54 union {
78 #endif 55 const char *text_value; // text value of STRING node
79 #endif 56 struct {
57 union {
58 nxjson_u64 u_value; // the value of INTEGER or BOOL node
59 nxjson_s64 s_value;
60 };
61 double dbl_value; // the value of DOUBLE node
62 } num;
63 struct { // children of OBJECT or ARRAY
64 int length;
65 struct nx_json *first;
66 struct nx_json *last;
67 } children;
68 };
69 struct nx_json *next; // points to next child
70 } nx_json;
80 71
81 /* project version */ 72 typedef int (*nx_json_unicode_encoder)(unsigned int codepoint, char *p, char **endp);
82 #define CJSON_VERSION_MAJOR 1
83 #define CJSON_VERSION_MINOR 7
84 #define CJSON_VERSION_PATCH 17
85 73
86 #include <stddef.h> 74 extern nx_json_unicode_encoder nx_json_unicode_to_utf8;
87 75
88 /* cJSON Types: */ 76 const nx_json *nx_json_parse(char *text, nx_json_unicode_encoder encoder);
89 #define cJSON_Invalid (0)
90 #define cJSON_False (1 << 0)
91 #define cJSON_True (1 << 1)
92 #define cJSON_NULL (1 << 2)
93 #define cJSON_Number (1 << 3)
94 #define cJSON_String (1 << 4)
95 #define cJSON_Array (1 << 5)
96 #define cJSON_Object (1 << 6)
97 #define cJSON_Raw (1 << 7) /* raw json */
98 77
99 #define cJSON_IsReference 256 78 const nx_json *nx_json_parse_utf8(char *text);
100 #define cJSON_StringIsConst 512
101 79
102 /* The cJSON structure: */ 80 void nx_json_free(const nx_json *js);
103 typedef struct cJSON
104 {
105 /* next/prev allow you to walk array/object chains. Alternatively, use GetArraySize/GetArrayItem/GetObjectItem */
106 struct cJSON *next;
107 struct cJSON *prev;
108 /* An array or object item will have a child pointer pointing to a chain of the items in the array/object. */
109 struct cJSON *child;
110 81
111 /* The type of the item, as above. */ 82 const nx_json *nx_json_get(const nx_json *json, const char *key); // get object's property by key
112 int type; 83 const nx_json *nx_json_item(const nx_json *json, int idx); // get array element by index
113 84
114 /* The item's string, if type==cJSON_String and type == cJSON_Raw */
115 char *valuestring;
116 /* writing to valueint is DEPRECATED, use cJSON_SetNumberValue instead */
117 int valueint;
118 /* The item's number, if type==cJSON_Number */
119 double valuedouble;
120 85
121 /* The item's name string, if this item is the child of, or is in the list of subitems of an object. */ 86 #ifdef __cplusplus
122 char *string;
123 } cJSON;
124
125 typedef struct cJSON_Hooks
126 {
127 /* malloc/free are CDECL on Windows regardless of the default calling convention of the compiler, so ensure the hooks allow passing those functions directly. */
128 void *(CJSON_CDECL *malloc_fn)(size_t sz);
129 void (CJSON_CDECL *free_fn)(void *ptr);
130 } cJSON_Hooks;
131
132 typedef int cJSON_bool;
133
134 /* Limits how deeply nested arrays/objects can be before cJSON rejects to parse them.
135 * This is to prevent stack overflows. */
136 #ifndef CJSON_NESTING_LIMIT
137 #define CJSON_NESTING_LIMIT 1000
138 #endif
139
140 /* returns the version of cJSON as a string */
141 CJSON_PUBLIC(const char*) cJSON_Version(void);
142
143 /* Supply malloc, realloc and free functions to cJSON */
144 CJSON_PUBLIC(void) cJSON_InitHooks(cJSON_Hooks* hooks);
145
146 /* Memory Management: the caller is always responsible to free the results from all variants of cJSON_Parse (with cJSON_Delete) and cJSON_Print (with stdlib free, cJSON_Hooks.free_fn, or cJSON_free as appropriate). The exception is cJSON_PrintPreallocated, where the caller has full responsibility of the buffer. */
147 /* Supply a block of JSON, and this returns a cJSON object you can interrogate. */
148 CJSON_PUBLIC(cJSON *) cJSON_Parse(const char *value);
149 CJSON_PUBLIC(cJSON *) cJSON_ParseWithLength(const char *value, size_t buffer_length);
150 /* ParseWithOpts allows you to require (and check) that the JSON is null terminated, and to retrieve the pointer to the final byte parsed. */
151 /* If you supply a ptr in return_parse_end and parsing fails, then return_parse_end will contain a pointer to the error so will match cJSON_GetErrorPtr(). */
152 CJSON_PUBLIC(cJSON *) cJSON_ParseWithOpts(const char *value, const char **return_parse_end, cJSON_bool require_null_terminated);
153 CJSON_PUBLIC(cJSON *) cJSON_ParseWithLengthOpts(const char *value, size_t buffer_length, const char **return_parse_end, cJSON_bool require_null_terminated);
154
155 /* Render a cJSON entity to text for transfer/storage. */
156 CJSON_PUBLIC(char *) cJSON_Print(const cJSON *item);
157 /* Render a cJSON entity to text for transfer/storage without any formatting. */
158 CJSON_PUBLIC(char *) cJSON_PrintUnformatted(const cJSON *item);
159 /* 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 */
160 CJSON_PUBLIC(char *) cJSON_PrintBuffered(const cJSON *item, int prebuffer, cJSON_bool fmt);
161 /* Render a cJSON entity to text using a buffer already allocated in memory with given length. Returns 1 on success and 0 on failure. */
162 /* NOTE: cJSON is not always 100% accurate in estimating how much memory it will use, so to be safe allocate 5 bytes more than you actually need */
163 CJSON_PUBLIC(cJSON_bool) cJSON_PrintPreallocated(cJSON *item, char *buffer, const int length, const cJSON_bool format);
164 /* Delete a cJSON entity and all subentities. */
165 CJSON_PUBLIC(void) cJSON_Delete(cJSON *item);
166
167 /* Returns the number of items in an array (or object). */
168 CJSON_PUBLIC(int) cJSON_GetArraySize(const cJSON *array);
169 /* Retrieve item number "index" from array "array". Returns NULL if unsuccessful. */
170 CJSON_PUBLIC(cJSON *) cJSON_GetArrayItem(const cJSON *array, int index);
171 /* Get item "string" from object. Case insensitive. */
172 CJSON_PUBLIC(cJSON *) cJSON_GetObjectItem(const cJSON * const object, const char * const string);
173 CJSON_PUBLIC(cJSON *) cJSON_GetObjectItemCaseSensitive(const cJSON * const object, const char * const string);
174 CJSON_PUBLIC(cJSON_bool) cJSON_HasObjectItem(const cJSON *object, const char *string);
175 /* 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. */
176 CJSON_PUBLIC(const char *) cJSON_GetErrorPtr(void);
177
178 /* Check item type and return its value */
179 CJSON_PUBLIC(char *) cJSON_GetStringValue(const cJSON * const item);
180 CJSON_PUBLIC(double) cJSON_GetNumberValue(const cJSON * const item);
181
182 /* These functions check the type of an item */
183 CJSON_PUBLIC(cJSON_bool) cJSON_IsInvalid(const cJSON * const item);
184 CJSON_PUBLIC(cJSON_bool) cJSON_IsFalse(const cJSON * const item);
185 CJSON_PUBLIC(cJSON_bool) cJSON_IsTrue(const cJSON * const item);
186 CJSON_PUBLIC(cJSON_bool) cJSON_IsBool(const cJSON * const item);
187 CJSON_PUBLIC(cJSON_bool) cJSON_IsNull(const cJSON * const item);
188 CJSON_PUBLIC(cJSON_bool) cJSON_IsNumber(const cJSON * const item);
189 CJSON_PUBLIC(cJSON_bool) cJSON_IsString(const cJSON * const item);
190 CJSON_PUBLIC(cJSON_bool) cJSON_IsArray(const cJSON * const item);
191 CJSON_PUBLIC(cJSON_bool) cJSON_IsObject(const cJSON * const item);
192 CJSON_PUBLIC(cJSON_bool) cJSON_IsRaw(const cJSON * const item);
193
194 /* These calls create a cJSON item of the appropriate type. */
195 CJSON_PUBLIC(cJSON *) cJSON_CreateNull(void);
196 CJSON_PUBLIC(cJSON *) cJSON_CreateTrue(void);
197 CJSON_PUBLIC(cJSON *) cJSON_CreateFalse(void);
198 CJSON_PUBLIC(cJSON *) cJSON_CreateBool(cJSON_bool boolean);
199 CJSON_PUBLIC(cJSON *) cJSON_CreateNumber(double num);
200 CJSON_PUBLIC(cJSON *) cJSON_CreateString(const char *string);
201 /* raw json */
202 CJSON_PUBLIC(cJSON *) cJSON_CreateRaw(const char *raw);
203 CJSON_PUBLIC(cJSON *) cJSON_CreateArray(void);
204 CJSON_PUBLIC(cJSON *) cJSON_CreateObject(void);
205
206 /* Create a string where valuestring references a string so
207 * it will not be freed by cJSON_Delete */
208 CJSON_PUBLIC(cJSON *) cJSON_CreateStringReference(const char *string);
209 /* Create an object/array that only references it's elements so
210 * they will not be freed by cJSON_Delete */
211 CJSON_PUBLIC(cJSON *) cJSON_CreateObjectReference(const cJSON *child);
212 CJSON_PUBLIC(cJSON *) cJSON_CreateArrayReference(const cJSON *child);
213
214 /* These utilities create an Array of count items.
215 * The parameter count cannot be greater than the number of elements in the number array, otherwise array access will be out of bounds.*/
216 CJSON_PUBLIC(cJSON *) cJSON_CreateIntArray(const int *numbers, int count);
217 CJSON_PUBLIC(cJSON *) cJSON_CreateFloatArray(const float *numbers, int count);
218 CJSON_PUBLIC(cJSON *) cJSON_CreateDoubleArray(const double *numbers, int count);
219 CJSON_PUBLIC(cJSON *) cJSON_CreateStringArray(const char *const *strings, int count);
220
221 /* Append item to the specified array/object. */
222 CJSON_PUBLIC(cJSON_bool) cJSON_AddItemToArray(cJSON *array, cJSON *item);
223 CJSON_PUBLIC(cJSON_bool) cJSON_AddItemToObject(cJSON *object, const char *string, cJSON *item);
224 /* Use this when string is definitely const (i.e. a literal, or as good as), and will definitely survive the cJSON object.
225 * WARNING: When this function was used, make sure to always check that (item->type & cJSON_StringIsConst) is zero before
226 * writing to `item->string` */
227 CJSON_PUBLIC(cJSON_bool) cJSON_AddItemToObjectCS(cJSON *object, const char *string, cJSON *item);
228 /* 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. */
229 CJSON_PUBLIC(cJSON_bool) cJSON_AddItemReferenceToArray(cJSON *array, cJSON *item);
230 CJSON_PUBLIC(cJSON_bool) cJSON_AddItemReferenceToObject(cJSON *object, const char *string, cJSON *item);
231
232 /* Remove/Detach items from Arrays/Objects. */
233 CJSON_PUBLIC(cJSON *) cJSON_DetachItemViaPointer(cJSON *parent, cJSON * const item);
234 CJSON_PUBLIC(cJSON *) cJSON_DetachItemFromArray(cJSON *array, int which);
235 CJSON_PUBLIC(void) cJSON_DeleteItemFromArray(cJSON *array, int which);
236 CJSON_PUBLIC(cJSON *) cJSON_DetachItemFromObject(cJSON *object, const char *string);
237 CJSON_PUBLIC(cJSON *) cJSON_DetachItemFromObjectCaseSensitive(cJSON *object, const char *string);
238 CJSON_PUBLIC(void) cJSON_DeleteItemFromObject(cJSON *object, const char *string);
239 CJSON_PUBLIC(void) cJSON_DeleteItemFromObjectCaseSensitive(cJSON *object, const char *string);
240
241 /* Update array items. */
242 CJSON_PUBLIC(cJSON_bool) cJSON_InsertItemInArray(cJSON *array, int which, cJSON *newitem); /* Shifts pre-existing items to the right. */
243 CJSON_PUBLIC(cJSON_bool) cJSON_ReplaceItemViaPointer(cJSON * const parent, cJSON * const item, cJSON * replacement);
244 CJSON_PUBLIC(cJSON_bool) cJSON_ReplaceItemInArray(cJSON *array, int which, cJSON *newitem);
245 CJSON_PUBLIC(cJSON_bool) cJSON_ReplaceItemInObject(cJSON *object,const char *string,cJSON *newitem);
246 CJSON_PUBLIC(cJSON_bool) cJSON_ReplaceItemInObjectCaseSensitive(cJSON *object,const char *string,cJSON *newitem);
247
248 /* Duplicate a cJSON item */
249 CJSON_PUBLIC(cJSON *) cJSON_Duplicate(const cJSON *item, cJSON_bool recurse);
250 /* Duplicate will create a new, identical cJSON item to the one you pass, in new memory that will
251 * need to be released. With recurse!=0, it will duplicate any children connected to the item.
252 * The item->next and ->prev pointers are always zero on return from Duplicate. */
253 /* Recursively compare two cJSON items for equality. If either a or b is NULL or invalid, they will be considered unequal.
254 * case_sensitive determines if object keys are treated case sensitive (1) or case insensitive (0) */
255 CJSON_PUBLIC(cJSON_bool) cJSON_Compare(const cJSON * const a, const cJSON * const b, const cJSON_bool case_sensitive);
256
257 /* Minify a strings, remove blank characters(such as ' ', '\t', '\r', '\n') from strings.
258 * The input pointer json cannot point to a read-only address area, such as a string constant,
259 * but should point to a readable and writable address area. */
260 CJSON_PUBLIC(void) cJSON_Minify(char *json);
261
262 /* Helper functions for creating and adding items to an object at the same time.
263 * They return the added item or NULL on failure. */
264 CJSON_PUBLIC(cJSON*) cJSON_AddNullToObject(cJSON * const object, const char * const name);
265 CJSON_PUBLIC(cJSON*) cJSON_AddTrueToObject(cJSON * const object, const char * const name);
266 CJSON_PUBLIC(cJSON*) cJSON_AddFalseToObject(cJSON * const object, const char * const name);
267 CJSON_PUBLIC(cJSON*) cJSON_AddBoolToObject(cJSON * const object, const char * const name, const cJSON_bool boolean);
268 CJSON_PUBLIC(cJSON*) cJSON_AddNumberToObject(cJSON * const object, const char * const name, const double number);
269 CJSON_PUBLIC(cJSON*) cJSON_AddStringToObject(cJSON * const object, const char * const name, const char * const string);
270 CJSON_PUBLIC(cJSON*) cJSON_AddRawToObject(cJSON * const object, const char * const name, const char * const raw);
271 CJSON_PUBLIC(cJSON*) cJSON_AddObjectToObject(cJSON * const object, const char * const name);
272 CJSON_PUBLIC(cJSON*) cJSON_AddArrayToObject(cJSON * const object, const char * const name);
273
274 /* When assigning an integer value, it needs to be propagated to valuedouble too. */
275 #define cJSON_SetIntValue(object, number) ((object) ? (object)->valueint = (object)->valuedouble = (number) : (number))
276 /* helper for the cJSON_SetNumberValue macro */
277 CJSON_PUBLIC(double) cJSON_SetNumberHelper(cJSON *object, double number);
278 #define cJSON_SetNumberValue(object, number) ((object != NULL) ? cJSON_SetNumberHelper(object, (double)number) : (number))
279 /* Change the valuestring of a cJSON_String object, only takes effect when type of object is cJSON_String */
280 CJSON_PUBLIC(char*) cJSON_SetValuestring(cJSON *object, const char *valuestring);
281
282 /* If the object is not a boolean type this does nothing and returns cJSON_Invalid else it returns the new type*/
283 #define cJSON_SetBoolValue(object, boolValue) ( \
284 (object != NULL && ((object)->type & (cJSON_False|cJSON_True))) ? \
285 (object)->type=((object)->type &(~(cJSON_False|cJSON_True)))|((boolValue)?cJSON_True:cJSON_False) : \
286 cJSON_Invalid\
287 )
288
289 /* Macro for iterating over an array or object */
290 #define cJSON_ArrayForEach(element, array) for(element = (array != NULL) ? (array)->child : NULL; element != NULL; element = element->next)
291
292 /* malloc/free objects using the malloc/free functions that have been set with cJSON_InitHooks */
293 CJSON_PUBLIC(void *) cJSON_malloc(size_t size);
294 CJSON_PUBLIC(void) cJSON_free(void *object);
295
296 #ifdef __cplusplus
297 } 87 }
298 #endif 88 #endif
299 89
300 #endif 90 #endif /* NXJSON_H */