]>
Commit | Line | Data |
---|---|---|
556826b5 OM |
1 | /* |
2 | * Copyright (c) 2009-2016 Petri Lehtinen <petri@digip.org> | |
3 | * | |
4 | * Jansson is free software; you can redistribute it and/or modify | |
5 | * it under the terms of the MIT license. See LICENSE for details. | |
6 | */ | |
7 | ||
8 | #ifndef JANSSON_H | |
9 | #define JANSSON_H | |
10 | ||
11 | #include <stdio.h> | |
556826b5 OM |
12 | #include <stdlib.h> /* for size_t */ |
13 | #include <stdarg.h> | |
14 | ||
15 | #include "jansson_config.h" | |
16 | ||
17 | #ifdef __cplusplus | |
18 | extern "C" { | |
19 | #endif | |
20 | ||
21 | /* version */ | |
22 | ||
23 | #define JANSSON_MAJOR_VERSION 2 | |
6a2bd857 | 24 | #define JANSSON_MINOR_VERSION 12 |
556826b5 OM |
25 | #define JANSSON_MICRO_VERSION 0 |
26 | ||
27 | /* Micro version is omitted if it's 0 */ | |
6a2bd857 | 28 | #define JANSSON_VERSION "2.12" |
556826b5 OM |
29 | |
30 | /* Version as a 3-byte hex number, e.g. 0x010201 == 1.2.1. Use this | |
31 | for numeric comparisons, e.g. #if JANSSON_VERSION_HEX >= ... */ | |
32 | #define JANSSON_VERSION_HEX ((JANSSON_MAJOR_VERSION << 16) | \ | |
33 | (JANSSON_MINOR_VERSION << 8) | \ | |
34 | (JANSSON_MICRO_VERSION << 0)) | |
35 | ||
36 | /* If __atomic or __sync builtins are available the library is thread | |
37 | * safe for all read-only functions plus reference counting. */ | |
38 | #if JSON_HAVE_ATOMIC_BUILTINS || JSON_HAVE_SYNC_BUILTINS | |
39 | #define JANSSON_THREAD_SAFE_REFCOUNT 1 | |
40 | #endif | |
41 | ||
6a2bd857 OM |
42 | #if defined(__GNUC__) || defined(__clang__) |
43 | #define JANSSON_ATTRS(...) __attribute__((__VA_ARGS__)) | |
44 | #else | |
45 | #define JANSSON_ATTRS(...) | |
46 | #endif | |
47 | ||
556826b5 OM |
48 | /* types */ |
49 | ||
50 | typedef enum { | |
51 | JSON_OBJECT, | |
52 | JSON_ARRAY, | |
53 | JSON_STRING, | |
54 | JSON_INTEGER, | |
55 | JSON_REAL, | |
56 | JSON_TRUE, | |
57 | JSON_FALSE, | |
58 | JSON_NULL | |
59 | } json_type; | |
60 | ||
61 | typedef struct json_t { | |
62 | json_type type; | |
63 | volatile size_t refcount; | |
64 | } json_t; | |
65 | ||
66 | #ifndef JANSSON_USING_CMAKE /* disabled if using cmake */ | |
67 | #if JSON_INTEGER_IS_LONG_LONG | |
68 | #ifdef _WIN32 | |
69 | #define JSON_INTEGER_FORMAT "I64d" | |
70 | #else | |
71 | #define JSON_INTEGER_FORMAT "lld" | |
72 | #endif | |
73 | typedef long long json_int_t; | |
74 | #else | |
75 | #define JSON_INTEGER_FORMAT "ld" | |
76 | typedef long json_int_t; | |
77 | #endif /* JSON_INTEGER_IS_LONG_LONG */ | |
78 | #endif | |
79 | ||
80 | #define json_typeof(json) ((json)->type) | |
81 | #define json_is_object(json) ((json) && json_typeof(json) == JSON_OBJECT) | |
82 | #define json_is_array(json) ((json) && json_typeof(json) == JSON_ARRAY) | |
83 | #define json_is_string(json) ((json) && json_typeof(json) == JSON_STRING) | |
84 | #define json_is_integer(json) ((json) && json_typeof(json) == JSON_INTEGER) | |
85 | #define json_is_real(json) ((json) && json_typeof(json) == JSON_REAL) | |
86 | #define json_is_number(json) (json_is_integer(json) || json_is_real(json)) | |
87 | #define json_is_true(json) ((json) && json_typeof(json) == JSON_TRUE) | |
88 | #define json_is_false(json) ((json) && json_typeof(json) == JSON_FALSE) | |
89 | #define json_boolean_value json_is_true | |
90 | #define json_is_boolean(json) (json_is_true(json) || json_is_false(json)) | |
91 | #define json_is_null(json) ((json) && json_typeof(json) == JSON_NULL) | |
92 | ||
93 | /* construction, destruction, reference counting */ | |
94 | ||
95 | json_t *json_object(void); | |
96 | json_t *json_array(void); | |
97 | json_t *json_string(const char *value); | |
98 | json_t *json_stringn(const char *value, size_t len); | |
99 | json_t *json_string_nocheck(const char *value); | |
100 | json_t *json_stringn_nocheck(const char *value, size_t len); | |
101 | json_t *json_integer(json_int_t value); | |
102 | json_t *json_real(double value); | |
103 | json_t *json_true(void); | |
104 | json_t *json_false(void); | |
105 | #define json_boolean(val) ((val) ? json_true() : json_false()) | |
106 | json_t *json_null(void); | |
107 | ||
108 | /* do not call JSON_INTERNAL_INCREF or JSON_INTERNAL_DECREF directly */ | |
109 | #if JSON_HAVE_ATOMIC_BUILTINS | |
110 | #define JSON_INTERNAL_INCREF(json) __atomic_add_fetch(&json->refcount, 1, __ATOMIC_ACQUIRE) | |
111 | #define JSON_INTERNAL_DECREF(json) __atomic_sub_fetch(&json->refcount, 1, __ATOMIC_RELEASE) | |
112 | #elif JSON_HAVE_SYNC_BUILTINS | |
113 | #define JSON_INTERNAL_INCREF(json) __sync_add_and_fetch(&json->refcount, 1) | |
114 | #define JSON_INTERNAL_DECREF(json) __sync_sub_and_fetch(&json->refcount, 1) | |
115 | #else | |
116 | #define JSON_INTERNAL_INCREF(json) (++json->refcount) | |
117 | #define JSON_INTERNAL_DECREF(json) (--json->refcount) | |
118 | #endif | |
119 | ||
120 | static JSON_INLINE | |
121 | json_t *json_incref(json_t *json) | |
122 | { | |
123 | if(json && json->refcount != (size_t)-1) | |
124 | JSON_INTERNAL_INCREF(json); | |
125 | return json; | |
126 | } | |
127 | ||
128 | /* do not call json_delete directly */ | |
129 | void json_delete(json_t *json); | |
130 | ||
131 | static JSON_INLINE | |
132 | void json_decref(json_t *json) | |
133 | { | |
134 | if(json && json->refcount != (size_t)-1 && JSON_INTERNAL_DECREF(json) == 0) | |
135 | json_delete(json); | |
136 | } | |
137 | ||
138 | #if defined(__GNUC__) || defined(__clang__) | |
139 | static JSON_INLINE | |
140 | void json_decrefp(json_t **json) | |
141 | { | |
142 | if(json) { | |
143 | json_decref(*json); | |
144 | *json = NULL; | |
145 | } | |
146 | } | |
147 | ||
148 | #define json_auto_t json_t __attribute__((cleanup(json_decrefp))) | |
149 | #endif | |
150 | ||
151 | ||
152 | /* error reporting */ | |
153 | ||
154 | #define JSON_ERROR_TEXT_LENGTH 160 | |
155 | #define JSON_ERROR_SOURCE_LENGTH 80 | |
156 | ||
157 | typedef struct json_error_t { | |
158 | int line; | |
159 | int column; | |
160 | int position; | |
161 | char source[JSON_ERROR_SOURCE_LENGTH]; | |
162 | char text[JSON_ERROR_TEXT_LENGTH]; | |
163 | } json_error_t; | |
164 | ||
165 | enum json_error_code { | |
166 | json_error_unknown, | |
167 | json_error_out_of_memory, | |
168 | json_error_stack_overflow, | |
169 | json_error_cannot_open_file, | |
170 | json_error_invalid_argument, | |
171 | json_error_invalid_utf8, | |
172 | json_error_premature_end_of_input, | |
173 | json_error_end_of_input_expected, | |
174 | json_error_invalid_syntax, | |
175 | json_error_invalid_format, | |
176 | json_error_wrong_type, | |
177 | json_error_null_character, | |
178 | json_error_null_value, | |
179 | json_error_null_byte_in_key, | |
180 | json_error_duplicate_key, | |
181 | json_error_numeric_overflow, | |
182 | json_error_item_not_found, | |
183 | json_error_index_out_of_range | |
184 | }; | |
185 | ||
186 | static JSON_INLINE enum json_error_code json_error_code(const json_error_t *e) { | |
187 | return (enum json_error_code)e->text[JSON_ERROR_TEXT_LENGTH - 1]; | |
188 | } | |
189 | ||
190 | /* getters, setters, manipulation */ | |
191 | ||
192 | void json_object_seed(size_t seed); | |
193 | size_t json_object_size(const json_t *object); | |
6a2bd857 | 194 | json_t *json_object_get(const json_t *object, const char *key) JANSSON_ATTRS(warn_unused_result); |
556826b5 OM |
195 | int json_object_set_new(json_t *object, const char *key, json_t *value); |
196 | int json_object_set_new_nocheck(json_t *object, const char *key, json_t *value); | |
197 | int json_object_del(json_t *object, const char *key); | |
198 | int json_object_clear(json_t *object); | |
199 | int json_object_update(json_t *object, json_t *other); | |
200 | int json_object_update_existing(json_t *object, json_t *other); | |
201 | int json_object_update_missing(json_t *object, json_t *other); | |
202 | void *json_object_iter(json_t *object); | |
203 | void *json_object_iter_at(json_t *object, const char *key); | |
204 | void *json_object_key_to_iter(const char *key); | |
205 | void *json_object_iter_next(json_t *object, void *iter); | |
206 | const char *json_object_iter_key(void *iter); | |
207 | json_t *json_object_iter_value(void *iter); | |
208 | int json_object_iter_set_new(json_t *object, void *iter, json_t *value); | |
209 | ||
210 | #define json_object_foreach(object, key, value) \ | |
211 | for(key = json_object_iter_key(json_object_iter(object)); \ | |
212 | key && (value = json_object_iter_value(json_object_key_to_iter(key))); \ | |
213 | key = json_object_iter_key(json_object_iter_next(object, json_object_key_to_iter(key)))) | |
214 | ||
215 | #define json_object_foreach_safe(object, n, key, value) \ | |
216 | for(key = json_object_iter_key(json_object_iter(object)), \ | |
217 | n = json_object_iter_next(object, json_object_key_to_iter(key)); \ | |
218 | key && (value = json_object_iter_value(json_object_key_to_iter(key))); \ | |
219 | key = json_object_iter_key(n), \ | |
220 | n = json_object_iter_next(object, json_object_key_to_iter(key))) | |
221 | ||
222 | #define json_array_foreach(array, index, value) \ | |
223 | for(index = 0; \ | |
224 | index < json_array_size(array) && (value = json_array_get(array, index)); \ | |
225 | index++) | |
226 | ||
227 | static JSON_INLINE | |
228 | int json_object_set(json_t *object, const char *key, json_t *value) | |
229 | { | |
230 | return json_object_set_new(object, key, json_incref(value)); | |
231 | } | |
232 | ||
233 | static JSON_INLINE | |
234 | int json_object_set_nocheck(json_t *object, const char *key, json_t *value) | |
235 | { | |
236 | return json_object_set_new_nocheck(object, key, json_incref(value)); | |
237 | } | |
238 | ||
239 | static JSON_INLINE | |
240 | int json_object_iter_set(json_t *object, void *iter, json_t *value) | |
241 | { | |
242 | return json_object_iter_set_new(object, iter, json_incref(value)); | |
243 | } | |
244 | ||
245 | size_t json_array_size(const json_t *array); | |
6a2bd857 | 246 | json_t *json_array_get(const json_t *array, size_t index) JANSSON_ATTRS(warn_unused_result); |
556826b5 OM |
247 | int json_array_set_new(json_t *array, size_t index, json_t *value); |
248 | int json_array_append_new(json_t *array, json_t *value); | |
249 | int json_array_insert_new(json_t *array, size_t index, json_t *value); | |
250 | int json_array_remove(json_t *array, size_t index); | |
251 | int json_array_clear(json_t *array); | |
252 | int json_array_extend(json_t *array, json_t *other); | |
253 | ||
254 | static JSON_INLINE | |
255 | int json_array_set(json_t *array, size_t ind, json_t *value) | |
256 | { | |
257 | return json_array_set_new(array, ind, json_incref(value)); | |
258 | } | |
259 | ||
260 | static JSON_INLINE | |
261 | int json_array_append(json_t *array, json_t *value) | |
262 | { | |
263 | return json_array_append_new(array, json_incref(value)); | |
264 | } | |
265 | ||
266 | static JSON_INLINE | |
267 | int json_array_insert(json_t *array, size_t ind, json_t *value) | |
268 | { | |
269 | return json_array_insert_new(array, ind, json_incref(value)); | |
270 | } | |
271 | ||
272 | const char *json_string_value(const json_t *string); | |
273 | size_t json_string_length(const json_t *string); | |
274 | json_int_t json_integer_value(const json_t *integer); | |
275 | double json_real_value(const json_t *real); | |
276 | double json_number_value(const json_t *json); | |
277 | ||
278 | int json_string_set(json_t *string, const char *value); | |
279 | int json_string_setn(json_t *string, const char *value, size_t len); | |
280 | int json_string_set_nocheck(json_t *string, const char *value); | |
281 | int json_string_setn_nocheck(json_t *string, const char *value, size_t len); | |
282 | int json_integer_set(json_t *integer, json_int_t value); | |
283 | int json_real_set(json_t *real, double value); | |
284 | ||
285 | /* pack, unpack */ | |
286 | ||
6a2bd857 OM |
287 | json_t *json_pack(const char *fmt, ...) JANSSON_ATTRS(warn_unused_result); |
288 | json_t *json_pack_ex(json_error_t *error, size_t flags, const char *fmt, ...) JANSSON_ATTRS(warn_unused_result); | |
289 | json_t *json_vpack_ex(json_error_t *error, size_t flags, const char *fmt, va_list ap) JANSSON_ATTRS(warn_unused_result); | |
556826b5 OM |
290 | |
291 | #define JSON_VALIDATE_ONLY 0x1 | |
292 | #define JSON_STRICT 0x2 | |
293 | ||
294 | int json_unpack(json_t *root, const char *fmt, ...); | |
295 | int json_unpack_ex(json_t *root, json_error_t *error, size_t flags, const char *fmt, ...); | |
296 | int json_vunpack_ex(json_t *root, json_error_t *error, size_t flags, const char *fmt, va_list ap); | |
297 | ||
298 | /* sprintf */ | |
299 | ||
6a2bd857 OM |
300 | json_t *json_sprintf(const char *fmt, ...) JANSSON_ATTRS(warn_unused_result, format(printf, 1, 2)); |
301 | json_t *json_vsprintf(const char *fmt, va_list ap) JANSSON_ATTRS(warn_unused_result, format(printf, 1, 0)); | |
556826b5 OM |
302 | |
303 | ||
304 | /* equality */ | |
305 | ||
306 | int json_equal(const json_t *value1, const json_t *value2); | |
307 | ||
308 | ||
309 | /* copying */ | |
310 | ||
6a2bd857 OM |
311 | json_t *json_copy(json_t *value) JANSSON_ATTRS(warn_unused_result); |
312 | json_t *json_deep_copy(const json_t *value) JANSSON_ATTRS(warn_unused_result); | |
95b697f0 OM |
313 | |
314 | json_t *json_path_get(const json_t *json, const char *path); | |
315 | int json_path_set_new(json_t *json, const char *path, json_t *value, size_t flags, json_error_t *error); | |
316 | ||
317 | static JSON_INLINE | |
318 | int json_path_set(json_t *json, const char *path, json_t *value, size_t flags, json_error_t *error) | |
319 | { | |
320 | return json_path_set_new(json, path, json_incref(value), flags, error); | |
321 | } | |
556826b5 OM |
322 | |
323 | /* decoding */ | |
324 | ||
325 | #define JSON_REJECT_DUPLICATES 0x1 | |
326 | #define JSON_DISABLE_EOF_CHECK 0x2 | |
327 | #define JSON_DECODE_ANY 0x4 | |
328 | #define JSON_DECODE_INT_AS_REAL 0x8 | |
329 | #define JSON_ALLOW_NUL 0x10 | |
330 | ||
331 | typedef size_t (*json_load_callback_t)(void *buffer, size_t buflen, void *data); | |
332 | ||
6a2bd857 OM |
333 | json_t *json_loads(const char *input, size_t flags, json_error_t *error) JANSSON_ATTRS(warn_unused_result); |
334 | json_t *json_loadb(const char *buffer, size_t buflen, size_t flags, json_error_t *error) JANSSON_ATTRS(warn_unused_result); | |
335 | json_t *json_loadf(FILE *input, size_t flags, json_error_t *error) JANSSON_ATTRS(warn_unused_result); | |
336 | json_t *json_loadfd(int input, size_t flags, json_error_t *error) JANSSON_ATTRS(warn_unused_result); | |
337 | json_t *json_load_file(const char *path, size_t flags, json_error_t *error) JANSSON_ATTRS(warn_unused_result); | |
338 | json_t *json_load_callback(json_load_callback_t callback, void *data, size_t flags, json_error_t *error) JANSSON_ATTRS(warn_unused_result); | |
556826b5 OM |
339 | |
340 | ||
341 | /* encoding */ | |
342 | ||
343 | #define JSON_MAX_INDENT 0x1F | |
344 | #define JSON_INDENT(n) ((n) & JSON_MAX_INDENT) | |
345 | #define JSON_COMPACT 0x20 | |
346 | #define JSON_ENSURE_ASCII 0x40 | |
347 | #define JSON_SORT_KEYS 0x80 | |
348 | #define JSON_PRESERVE_ORDER 0x100 | |
349 | #define JSON_ENCODE_ANY 0x200 | |
350 | #define JSON_ESCAPE_SLASH 0x400 | |
351 | #define JSON_REAL_PRECISION(n) (((n) & 0x1F) << 11) | |
352 | #define JSON_EMBED 0x10000 | |
353 | ||
354 | typedef int (*json_dump_callback_t)(const char *buffer, size_t size, void *data); | |
355 | ||
6a2bd857 | 356 | char *json_dumps(const json_t *json, size_t flags) JANSSON_ATTRS(warn_unused_result); |
556826b5 OM |
357 | size_t json_dumpb(const json_t *json, char *buffer, size_t size, size_t flags); |
358 | int json_dumpf(const json_t *json, FILE *output, size_t flags); | |
359 | int json_dumpfd(const json_t *json, int output, size_t flags); | |
360 | int json_dump_file(const json_t *json, const char *path, size_t flags); | |
361 | int json_dump_callback(const json_t *json, json_dump_callback_t callback, void *data, size_t flags); | |
362 | ||
363 | /* custom memory allocation */ | |
364 | ||
365 | typedef void *(*json_malloc_t)(size_t); | |
366 | typedef void (*json_free_t)(void *); | |
367 | ||
368 | void json_set_alloc_funcs(json_malloc_t malloc_fn, json_free_t free_fn); | |
369 | void json_get_alloc_funcs(json_malloc_t *malloc_fn, json_free_t *free_fn); | |
370 | ||
371 | #ifdef __cplusplus | |
372 | } | |
373 | #endif | |
374 | ||
375 | #endif |