client/deps/jansson/jansson.h

   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>
  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
  24 #define JANSSON_MINOR_VERSION  12
  25 #define JANSSON_MICRO_VERSION  0
  26
  27 /* Micro version is omitted if it's 0 */
  28 #define JANSSON_VERSION  "2.12"
  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
  42 #if defined(__GNUC__) || defined(__clang__)
  43 #define JANSSON_ATTRS(...) __attribute__((__VA_ARGS__))
  44 #else
  45 #define JANSSON_ATTRS(...)
  46 #endif
  47
  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     if (json && json->refcount != (size_t) - 1)
 123         JSON_INTERNAL_INCREF(json);
 124     return json;
 125 }
 126
 127 /* do not call json_delete directly */
 128 void json_delete(json_t *json);
 129
 130 static JSON_INLINE
 131 void json_decref(json_t *json) {
 132     if (json && json->refcount != (size_t) - 1 && JSON_INTERNAL_DECREF(json) == 0)
 133         json_delete(json);
 134 }
 135
 136 #if defined(__GNUC__) || defined(__clang__)
 137 static JSON_INLINE
 138 void json_decrefp(json_t **json) {
 139     if (json) {
 140         json_decref(*json);
 141         *json = NULL;
 142     }
 143 }
 144
 145 #define json_auto_t json_t __attribute__((cleanup(json_decrefp)))
 146 #endif
 147
 148
 149 /* error reporting */
 150
 151 #define JSON_ERROR_TEXT_LENGTH    160
 152 #define JSON_ERROR_SOURCE_LENGTH   80
 153
 154 typedef struct json_error_t {
 155     int line;
 156     int column;
 157     int position;
 158     char source[JSON_ERROR_SOURCE_LENGTH];
 159     char text[JSON_ERROR_TEXT_LENGTH];
 160 } json_error_t;
 161
 162 enum json_error_code {
 163     json_error_unknown,
 164     json_error_out_of_memory,
 165     json_error_stack_overflow,
 166     json_error_cannot_open_file,
 167     json_error_invalid_argument,
 168     json_error_invalid_utf8,
 169     json_error_premature_end_of_input,
 170     json_error_end_of_input_expected,
 171     json_error_invalid_syntax,
 172     json_error_invalid_format,
 173     json_error_wrong_type,
 174     json_error_null_character,
 175     json_error_null_value,
 176     json_error_null_byte_in_key,
 177     json_error_duplicate_key,
 178     json_error_numeric_overflow,
 179     json_error_item_not_found,
 180     json_error_index_out_of_range
 181 };
 182
 183 static JSON_INLINE enum json_error_code json_error_code(const json_error_t *e) {
 184     return (enum json_error_code)e->text[JSON_ERROR_TEXT_LENGTH - 1];
 185 }
 186
 187 /* getters, setters, manipulation */
 188
 189 void json_object_seed(size_t seed);
 190 size_t json_object_size(const json_t *json);
 191 json_t *json_object_get(const json_t *json, const char *key) JANSSON_ATTRS(warn_unused_result);
 192 int json_object_set_new(json_t *json, const char *key, json_t *value);
 193 int json_object_set_new_nocheck(json_t *json, const char *key, json_t *value);
 194 int json_object_del(json_t *json, const char *key);
 195 int json_object_clear(json_t *json);
 196 int json_object_update(json_t *object, json_t *other);
 197 int json_object_update_existing(json_t *object, json_t *other);
 198 int json_object_update_missing(json_t *object, json_t *other);
 199 void *json_object_iter(json_t *json);
 200 void *json_object_iter_at(json_t *json, const char *key);
 201 void *json_object_key_to_iter(const char *key);
 202 void *json_object_iter_next(json_t *json, void *iter);
 203 const char *json_object_iter_key(void *iter);
 204 json_t *json_object_iter_value(void *iter);
 205 int json_object_iter_set_new(json_t *json, void *iter, json_t *value);
 206
 207 #define json_object_foreach(object, key, value) \
 208     for(key = json_object_iter_key(json_object_iter(object)); \
 209             key && (value = json_object_iter_value(json_object_key_to_iter(key))); \
 210             key = json_object_iter_key(json_object_iter_next(object, json_object_key_to_iter(key))))
 211
 212 #define json_object_foreach_safe(object, n, key, value)     \
 213     for(key = json_object_iter_key(json_object_iter(object)), \
 214             n = json_object_iter_next(object, json_object_key_to_iter(key)); \
 215             key && (value = json_object_iter_value(json_object_key_to_iter(key))); \
 216             key = json_object_iter_key(n), \
 217             n = json_object_iter_next(object, json_object_key_to_iter(key)))
 218
 219 #define json_array_foreach(array, index, value) \
 220     for(index = 0; \
 221             index < json_array_size(array) && (value = json_array_get(array, index)); \
 222             index++)
 223
 224 static JSON_INLINE
 225 int json_object_set(json_t *object, const char *key, json_t *value) {
 226     return json_object_set_new(object, key, json_incref(value));
 227 }
 228
 229 static JSON_INLINE
 230 int json_object_set_nocheck(json_t *object, const char *key, json_t *value) {
 231     return json_object_set_new_nocheck(object, key, json_incref(value));
 232 }
 233
 234 static JSON_INLINE
 235 int json_object_iter_set(json_t *object, void *iter, json_t *value) {
 236     return json_object_iter_set_new(object, iter, json_incref(value));
 237 }
 238
 239 size_t json_array_size(const json_t *json);
 240 json_t *json_array_get(const json_t *json, size_t index) JANSSON_ATTRS(warn_unused_result);
 241 int json_array_set_new(json_t *json, size_t index, json_t *value);
 242 int json_array_append_new(json_t *json, json_t *value);
 243 int json_array_insert_new(json_t *json, size_t index, json_t *value);
 244 int json_array_remove(json_t *json, size_t index);
 245 int json_array_clear(json_t *json);
 246 int json_array_extend(json_t *json, json_t *other_json);
 247
 248 static JSON_INLINE
 249 int json_array_set(json_t *array, size_t ind, json_t *value) {
 250     return json_array_set_new(array, ind, json_incref(value));
 251 }
 252
 253 static JSON_INLINE
 254 int json_array_append(json_t *array, json_t *value) {
 255     return json_array_append_new(array, json_incref(value));
 256 }
 257
 258 static JSON_INLINE
 259 int json_array_insert(json_t *array, size_t ind, json_t *value) {
 260     return json_array_insert_new(array, ind, json_incref(value));
 261 }
 262
 263 const char *json_string_value(const json_t *json);
 264 size_t json_string_length(const json_t *json);
 265 json_int_t json_integer_value(const json_t *json);
 266 double json_real_value(const json_t *json);
 267 double json_number_value(const json_t *json);
 268
 269 int json_string_set(json_t *json, const char *value);
 270 int json_string_setn(json_t *json, const char *value, size_t len);
 271 int json_string_set_nocheck(json_t *json, const char *value);
 272 int json_string_setn_nocheck(json_t *json, const char *value, size_t len);
 273 int json_integer_set(json_t *json, json_int_t value);
 274 int json_real_set(json_t *json, double value);
 275
 276 /* pack, unpack */
 277
 278 json_t *json_pack(const char *fmt, ...) JANSSON_ATTRS(warn_unused_result);
 279 json_t *json_pack_ex(json_error_t *error, size_t flags, const char *fmt, ...) JANSSON_ATTRS(warn_unused_result);
 280 json_t *json_vpack_ex(json_error_t *error, size_t flags, const char *fmt, va_list ap) JANSSON_ATTRS(warn_unused_result);
 281
 282 #define JSON_VALIDATE_ONLY  0x1
 283 #define JSON_STRICT         0x2
 284
 285 int json_unpack(json_t *root, const char *fmt, ...);
 286 int json_unpack_ex(json_t *root, json_error_t *error, size_t flags, const char *fmt, ...);
 287 int json_vunpack_ex(json_t *root, json_error_t *error, size_t flags, const char *fmt, va_list ap);
 288
 289 /* sprintf */
 290
 291 json_t *json_sprintf(const char *fmt, ...) JANSSON_ATTRS(warn_unused_result, format(printf, 1, 2));
 292 json_t *json_vsprintf(const char *fmt, va_list ap) JANSSON_ATTRS(warn_unused_result, format(printf, 1, 0));
 293
 294
 295 /* equality */
 296
 297 int json_equal(const json_t *json1, const json_t *json2);
 298
 299
 300 /* copying */
 301
 302 json_t *json_copy(json_t *json) JANSSON_ATTRS(warn_unused_result);
 303 json_t *json_deep_copy(const json_t *json) JANSSON_ATTRS(warn_unused_result);
 304
 305 /* decoding */
 306
 307 #define JSON_REJECT_DUPLICATES  0x1
 308 #define JSON_DISABLE_EOF_CHECK  0x2
 309 #define JSON_DECODE_ANY         0x4
 310 #define JSON_DECODE_INT_AS_REAL 0x8
 311 #define JSON_ALLOW_NUL          0x10
 312
 313 typedef size_t (*json_load_callback_t)(void *buffer, size_t buflen, void *data);
 314
 315 json_t *json_loads(const char *string, size_t flags, json_error_t *error) JANSSON_ATTRS(warn_unused_result);
 316 json_t *json_loadb(const char *buffer, size_t buflen, size_t flags, json_error_t *error) JANSSON_ATTRS(warn_unused_result);
 317 json_t *json_loadf(FILE *input, size_t flags, json_error_t *error) JANSSON_ATTRS(warn_unused_result);
 318 json_t *json_loadfd(int input, size_t flags, json_error_t *error) JANSSON_ATTRS(warn_unused_result);
 319 json_t *json_load_file(const char *path, size_t flags, json_error_t *error) JANSSON_ATTRS(warn_unused_result);
 320 json_t *json_load_callback(json_load_callback_t callback, void *arg, size_t flags, json_error_t *error) JANSSON_ATTRS(warn_unused_result);
 321
 322
 323 /* encoding */
 324
 325 #define JSON_MAX_INDENT         0x1F
 326 #define JSON_INDENT(n)          ((n) & JSON_MAX_INDENT)
 327 #define JSON_COMPACT            0x20
 328 #define JSON_ENSURE_ASCII       0x40
 329 #define JSON_SORT_KEYS          0x80
 330 #define JSON_PRESERVE_ORDER     0x100
 331 #define JSON_ENCODE_ANY         0x200
 332 #define JSON_ESCAPE_SLASH       0x400
 333 #define JSON_REAL_PRECISION(n)  (((n) & 0x1F) << 11)
 334 #define JSON_EMBED              0x10000
 335
 336 typedef int (*json_dump_callback_t)(const char *buffer, size_t size, void *data);
 337
 338 char *json_dumps(const json_t *json, size_t flags) JANSSON_ATTRS(warn_unused_result);
 339 size_t json_dumpb(const json_t *json, char *buffer, size_t size, size_t flags);
 340 int json_dumpf(const json_t *json, FILE *output, size_t flags);
 341 int json_dumpfd(const json_t *json, int output, size_t flags);
 342 int json_dump_file(const json_t *json, const char *path, size_t flags);
 343 int json_dump_callback(const json_t *json, json_dump_callback_t callback, void *data, size_t flags);
 344
 345 /* custom memory allocation */
 346
 347 typedef void *(*json_malloc_t)(size_t);
 348 typedef void (*json_free_t)(void *);
 349
 350 void json_set_alloc_funcs(json_malloc_t malloc_fn, json_free_t free_fn);
 351 void json_get_alloc_funcs(json_malloc_t *malloc_fn, json_free_t *free_fn);
 352
 353 #ifdef __cplusplus
 354 }
 355 #endif
 356
 357 #endif