src/jansson.h

   1 /*
   2  * Copyright (c) 2009 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
  13 #ifdef __cplusplus
  14 extern "C" {
  15 #endif
  16
  17 /* types */
  18
  19 typedef enum {
  20     JSON_OBJECT,
  21     JSON_ARRAY,
  22     JSON_STRING,
  23     JSON_INTEGER,
  24     JSON_REAL,
  25     JSON_TRUE,
  26     JSON_FALSE,
  27     JSON_NULL
  28 } json_type;
  29
  30 typedef struct {
  31     json_type type;
  32     unsigned long refcount;
  33 } json_t;
  34
  35 #define json_typeof(json)      ((json)->type)
  36 #define json_is_object(json)   (json && json_typeof(json) == JSON_OBJECT)
  37 #define json_is_array(json)    (json && json_typeof(json) == JSON_ARRAY)
  38 #define json_is_string(json)   (json && json_typeof(json) == JSON_STRING)
  39 #define json_is_integer(json)  (json && json_typeof(json) == JSON_INTEGER)
  40 #define json_is_real(json)     (json && json_typeof(json) == JSON_REAL)
  41 #define json_is_number(json)   (json_is_integer(json) || json_is_real(json))
  42 #define json_is_true(json)     (json && json_typeof(json) == JSON_TRUE)
  43 #define json_is_false(json)    (json && json_typeof(json) == JSON_FALSE)
  44 #define json_is_boolean(json)  (json_is_true(json) || json_is_false(json))
  45 #define json_is_null(json)     (json && json_typeof(json) == JSON_NULL)
  46
  47 /* construction, destruction, reference counting */
  48
  49 json_t *json_object(void);
  50 json_t *json_array(void);
  51 json_t *json_string(const char *value);
  52 json_t *json_string_nocheck(const char *value);
  53 json_t *json_integer(int value);
  54 json_t *json_real(double value);
  55 json_t *json_true(void);
  56 json_t *json_false(void);
  57 json_t *json_null(void);
  58
  59 static inline json_t *json_incref(json_t *json)
  60 {
  61     if(json && json->refcount != (unsigned int)-1)
  62         ++json->refcount;
  63     return json;
  64 }
  65
  66 /* do not call json_delete directly */
  67 void json_delete(json_t *json);
  68
  69 static inline void json_decref(json_t *json)
  70 {
  71     if(json && json->refcount != (unsigned int)-1 && --json->refcount == 0)
  72         json_delete(json);
  73 }
  74
  75
  76 /* getters, setters, manipulation */
  77
  78 unsigned int json_object_size(const json_t *object);
  79 json_t *json_object_get(const json_t *object, const char *key);
  80 int json_object_set_new(json_t *object, const char *key, json_t *value);
  81 int json_object_set_new_nocheck(json_t *object, const char *key, json_t *value);
  82 int json_object_del(json_t *object, const char *key);
  83 int json_object_clear(json_t *object);
  84 int json_object_update(json_t *object, json_t *other);
  85 void *json_object_iter(json_t *object);
  86 void *json_object_iter_at(json_t *object, const char *key);
  87 void *json_object_iter_next(json_t *object, void *iter);
  88 const char *json_object_iter_key(void *iter);
  89 json_t *json_object_iter_value(void *iter);
  90 int json_object_iter_set_new(json_t *object, void *iter, json_t *value);
  91
  92 static inline
  93 int json_object_set(json_t *object, const char *key, json_t *value)
  94 {
  95     return json_object_set_new(object, key, json_incref(value));
  96 }
  97
  98 static inline
  99 int json_object_set_nocheck(json_t *object, const char *key, json_t *value)
 100 {
 101     return json_object_set_new_nocheck(object, key, json_incref(value));
 102 }
 103
 104 static inline
 105 int json_object_iter_set(json_t *object, void *iter, json_t *value)
 106 {
 107     return json_object_iter_set_new(object, iter, json_incref(value));
 108 }
 109
 110 unsigned int json_array_size(const json_t *array);
 111 json_t *json_array_get(const json_t *array, unsigned int index);
 112 int json_array_set_new(json_t *array, unsigned int index, json_t *value);
 113 int json_array_append_new(json_t *array, json_t *value);
 114 int json_array_insert_new(json_t *array, unsigned int index, json_t *value);
 115 int json_array_remove(json_t *array, unsigned int index);
 116 int json_array_clear(json_t *array);
 117 int json_array_extend(json_t *array, json_t *other);
 118
 119 static inline
 120 int json_array_set(json_t *array, unsigned int index, json_t *value)
 121 {
 122     return json_array_set_new(array, index, json_incref(value));
 123 }
 124
 125 static inline
 126 int json_array_append(json_t *array, json_t *value)
 127 {
 128     return json_array_append_new(array, json_incref(value));
 129 }
 130
 131 static inline
 132 int json_array_insert(json_t *array, unsigned int index, json_t *value)
 133 {
 134     return json_array_insert_new(array, index, json_incref(value));
 135 }
 136
 137 const char *json_string_value(const json_t *string);
 138 int json_integer_value(const json_t *integer);
 139 double json_real_value(const json_t *real);
 140 double json_number_value(const json_t *json);
 141
 142 int json_string_set(json_t *string, const char *value);
 143 int json_string_set_nocheck(json_t *string, const char *value);
 144 int json_integer_set(json_t *integer, int value);
 145 int json_real_set(json_t *real, double value);
 146
 147
 148 /* equality */
 149
 150 int json_equal(json_t *value1, json_t *value2);
 151
 152
 153 /* copying */
 154
 155 json_t *json_copy(json_t *value);
 156 json_t *json_deep_copy(json_t *value);
 157
 158
 159 /* loading, printing */
 160
 161 #define JSON_ERROR_TEXT_LENGTH  160
 162
 163 typedef struct {
 164     char text[JSON_ERROR_TEXT_LENGTH];
 165     int line;
 166 } json_error_t;
 167
 168 json_t *json_loads(const char *input, json_error_t *error);
 169 json_t *json_loadf(FILE *input, json_error_t *error);
 170 json_t *json_load_file(const char *path, json_error_t *error);
 171
 172 #define JSON_INDENT(n)      (n & 0xFF)
 173 #define JSON_COMPACT        0x100
 174 #define JSON_ENSURE_ASCII   0x200
 175 #define JSON_SORT_KEYS      0x400
 176
 177 char *json_dumps(const json_t *json, unsigned long flags);
 178 int json_dumpf(const json_t *json, FILE *output, unsigned long flags);
 179 int json_dump_file(const json_t *json, const char *path, unsigned long flags);
 180
 181 #ifdef __cplusplus
 182 }
 183 #endif
 184
 185 #endif