src/jansson.h

   1 /*
   2  * Copyright (c) 2009-2011 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  2
  25 #define JANSSON_MICRO_VERSION  1
  26
  27 /* Micro version is omitted if it's 0 */
  28 #define JANSSON_VERSION  "2.2.1"
  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
  37 /* types */
  38
  39 typedef enum {
  40     JSON_OBJECT,
  41     JSON_ARRAY,
  42     JSON_STRING,
  43     JSON_INTEGER,
  44     JSON_REAL,
  45     JSON_TRUE,
  46     JSON_FALSE,
  47     JSON_NULL
  48 } json_type;
  49
  50 typedef struct {
  51     json_type type;
  52     size_t refcount;
  53 } json_t;
  54
  55 #if JSON_INTEGER_IS_LONG_LONG
  56 #ifdef _WIN32
  57 #define JSON_INTEGER_FORMAT "I64d"
  58 #else
  59 #define JSON_INTEGER_FORMAT "lld"
  60 #endif
  61 typedef long long json_int_t;
  62 #else
  63 #define JSON_INTEGER_FORMAT "ld"
  64 typedef long json_int_t;
  65 #endif /* JSON_INTEGER_IS_LONG_LONG */
  66
  67 #define json_typeof(json)      ((json)->type)
  68 #define json_is_object(json)   (json && json_typeof(json) == JSON_OBJECT)
  69 #define json_is_array(json)    (json && json_typeof(json) == JSON_ARRAY)
  70 #define json_is_string(json)   (json && json_typeof(json) == JSON_STRING)
  71 #define json_is_integer(json)  (json && json_typeof(json) == JSON_INTEGER)
  72 #define json_is_real(json)     (json && json_typeof(json) == JSON_REAL)
  73 #define json_is_number(json)   (json_is_integer(json) || json_is_real(json))
  74 #define json_is_true(json)     (json && json_typeof(json) == JSON_TRUE)
  75 #define json_is_false(json)    (json && json_typeof(json) == JSON_FALSE)
  76 #define json_is_boolean(json)  (json_is_true(json) || json_is_false(json))
  77 #define json_is_null(json)     (json && json_typeof(json) == JSON_NULL)
  78
  79 /* construction, destruction, reference counting */
  80
  81 json_t *json_object(void);
  82 json_t *json_array(void);
  83 json_t *json_string(const char *value);
  84 json_t *json_string_nocheck(const char *value);
  85 json_t *json_integer(json_int_t value);
  86 json_t *json_real(double value);
  87 json_t *json_true(void);
  88 json_t *json_false(void);
  89 json_t *json_null(void);
  90
  91 static JSON_INLINE
  92 json_t *json_incref(json_t *json)
  93 {
  94     if(json && json->refcount != (size_t)-1)
  95         ++json->refcount;
  96     return json;
  97 }
  98
  99 /* do not call json_delete directly */
 100 void json_delete(json_t *json);
 101
 102 static JSON_INLINE
 103 void json_decref(json_t *json)
 104 {
 105     if(json && json->refcount != (size_t)-1 && --json->refcount == 0)
 106         json_delete(json);
 107 }
 108
 109
 110 /* error reporting */
 111
 112 #define JSON_ERROR_TEXT_LENGTH    160
 113 #define JSON_ERROR_SOURCE_LENGTH   80
 114
 115 typedef struct {
 116     int line;
 117     int column;
 118     int position;
 119     char source[JSON_ERROR_SOURCE_LENGTH];
 120     char text[JSON_ERROR_TEXT_LENGTH];
 121 } json_error_t;
 122
 123
 124 /* getters, setters, manipulation */
 125
 126 size_t json_object_size(const json_t *object);
 127 json_t *json_object_get(const json_t *object, const char *key);
 128 int json_object_set_new(json_t *object, const char *key, json_t *value);
 129 int json_object_set_new_nocheck(json_t *object, const char *key, json_t *value);
 130 int json_object_del(json_t *object, const char *key);
 131 int json_object_clear(json_t *object);
 132 int json_object_update(json_t *object, json_t *other);
 133 void *json_object_iter(json_t *object);
 134 void *json_object_iter_at(json_t *object, const char *key);
 135 void *json_object_iter_next(json_t *object, void *iter);
 136 const char *json_object_iter_key(void *iter);
 137 json_t *json_object_iter_value(void *iter);
 138 int json_object_iter_set_new(json_t *object, void *iter, json_t *value);
 139
 140 static JSON_INLINE
 141 int json_object_set(json_t *object, const char *key, json_t *value)
 142 {
 143     return json_object_set_new(object, key, json_incref(value));
 144 }
 145
 146 static JSON_INLINE
 147 int json_object_set_nocheck(json_t *object, const char *key, json_t *value)
 148 {
 149     return json_object_set_new_nocheck(object, key, json_incref(value));
 150 }
 151
 152 static JSON_INLINE
 153 int json_object_iter_set(json_t *object, void *iter, json_t *value)
 154 {
 155     return json_object_iter_set_new(object, iter, json_incref(value));
 156 }
 157
 158 size_t json_array_size(const json_t *array);
 159 json_t *json_array_get(const json_t *array, size_t index);
 160 int json_array_set_new(json_t *array, size_t index, json_t *value);
 161 int json_array_append_new(json_t *array, json_t *value);
 162 int json_array_insert_new(json_t *array, size_t index, json_t *value);
 163 int json_array_remove(json_t *array, size_t index);
 164 int json_array_clear(json_t *array);
 165 int json_array_extend(json_t *array, json_t *other);
 166
 167 static JSON_INLINE
 168 int json_array_set(json_t *array, size_t index, json_t *value)
 169 {
 170     return json_array_set_new(array, index, json_incref(value));
 171 }
 172
 173 static JSON_INLINE
 174 int json_array_append(json_t *array, json_t *value)
 175 {
 176     return json_array_append_new(array, json_incref(value));
 177 }
 178
 179 static JSON_INLINE
 180 int json_array_insert(json_t *array, size_t index, json_t *value)
 181 {
 182     return json_array_insert_new(array, index, json_incref(value));
 183 }
 184
 185 const char *json_string_value(const json_t *string);
 186 json_int_t json_integer_value(const json_t *integer);
 187 double json_real_value(const json_t *real);
 188 double json_number_value(const json_t *json);
 189
 190 int json_string_set(json_t *string, const char *value);
 191 int json_string_set_nocheck(json_t *string, const char *value);
 192 int json_integer_set(json_t *integer, json_int_t value);
 193 int json_real_set(json_t *real, double value);
 194
 195
 196 /* pack, unpack */
 197
 198 json_t *json_pack(const char *fmt, ...);
 199 json_t *json_pack_ex(json_error_t *error, size_t flags, const char *fmt, ...);
 200 json_t *json_vpack_ex(json_error_t *error, size_t flags, const char *fmt, va_list ap);
 201
 202 #define JSON_VALIDATE_ONLY  0x1
 203 #define JSON_STRICT         0x2
 204
 205 int json_unpack(json_t *root, const char *fmt, ...);
 206 int json_unpack_ex(json_t *root, json_error_t *error, size_t flags, const char *fmt, ...);
 207 int json_vunpack_ex(json_t *root, json_error_t *error, size_t flags, const char *fmt, va_list ap);
 208
 209
 210 /* equality */
 211
 212 int json_equal(json_t *value1, json_t *value2);
 213
 214
 215 /* copying */
 216
 217 json_t *json_copy(json_t *value);
 218 json_t *json_deep_copy(json_t *value);
 219
 220
 221 /* decoding */
 222
 223 #define JSON_REJECT_DUPLICATES 0x1
 224 #define JSON_DISABLE_EOF_CHECK 0x2
 225
 226 json_t *json_loads(const char *input, size_t flags, json_error_t *error);
 227 json_t *json_loadb(const char *buffer, size_t buflen, size_t flags, json_error_t *error);
 228 json_t *json_loadf(FILE *input, size_t flags, json_error_t *error);
 229 json_t *json_load_file(const char *path, size_t flags, json_error_t *error);
 230
 231
 232 /* encoding */
 233
 234 #define JSON_INDENT(n)      (n & 0x1F)
 235 #define JSON_COMPACT        0x20
 236 #define JSON_ENSURE_ASCII   0x40
 237 #define JSON_SORT_KEYS      0x80
 238 #define JSON_PRESERVE_ORDER 0x100
 239 #define JSON_ENCODE_ANY     0x200
 240
 241 typedef int (*json_dump_callback_t)(const char *buffer, size_t size, void *data);
 242
 243 char *json_dumps(const json_t *json, size_t flags);
 244 int json_dumpf(const json_t *json, FILE *output, size_t flags);
 245 int json_dump_file(const json_t *json, const char *path, size_t flags);
 246 int json_dump_callback(const json_t *json, json_dump_callback_t callback, void *data, size_t flags);
 247
 248 /* custom memory allocation */
 249
 250 typedef void *(*json_malloc_t)(size_t);
 251 typedef void (*json_free_t)(void *);
 252
 253 void json_set_alloc_funcs(json_malloc_t malloc_fn, json_free_t free_fn);
 254
 255 #ifdef __cplusplus
 256 }
 257 #endif
 258
 259 #endif