Add LICENSE and a copyright note to all sources
[jansson.git] / 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 #include <stdint.h>
13
14 /* types */
15
16 typedef enum {
17     JSON_OBJECT,
18     JSON_ARRAY,
19     JSON_STRING,
20     JSON_INTEGER,
21     JSON_REAL,
22     JSON_TRUE,
23     JSON_FALSE,
24     JSON_NULL
25 } json_type;
26
27 typedef struct {
28     json_type type;
29     unsigned long refcount;
30 } json_t;
31
32 #define json_typeof(json)      ((json)->type)
33 #define json_is_object(json)   (json && json_typeof(json) == JSON_OBJECT)
34 #define json_is_array(json)    (json && json_typeof(json) == JSON_ARRAY)
35 #define json_is_string(json)   (json && json_typeof(json) == JSON_STRING)
36 #define json_is_integer(json)  (json && json_typeof(json) == JSON_INTEGER)
37 #define json_is_real(json)     (json && json_typeof(json) == JSON_REAL)
38 #define json_is_number(json)   (json_is_integer(json) || json_is_real(json))
39 #define json_is_true(json)     (json && json_typeof(json) == JSON_TRUE)
40 #define json_is_false(json)    (json && json_typeof(json) == JSON_FALSE)
41 #define json_is_null(json)     (json && json_typeof(json) == JSON_NULL)
42
43 /* construction, destruction, reference counting */
44
45 json_t *json_object(void);
46 json_t *json_array(void);
47 json_t *json_string(const char *value);
48 json_t *json_integer(int value);
49 json_t *json_real(double value);
50 json_t *json_true(void);
51 json_t *json_false(void);
52 json_t *json_null(void);
53
54 json_t *json_clone(json_t *json);
55
56 static inline json_t *json_incref(json_t *json)
57 {
58     if(json)
59         ++json->refcount;
60     return json;
61 }
62
63 /* do not call json_delete directly */
64 void json_delete(json_t *json);
65
66 static inline void json_decref(json_t *json)
67 {
68     if(json && --json->refcount == 0)
69         json_delete(json);
70 }
71
72
73 /* getters, setters, manipulation */
74
75 json_t *json_object_get(const json_t *object, const char *key);
76 int json_object_set(json_t *object, const char *key, json_t *value);
77 int json_object_del(json_t *object, const char *key);
78 void *json_object_iter(json_t *object);
79 void *json_object_iter_next(json_t *object, void *iter);
80 const char *json_object_iter_key(void *iter);
81 json_t *json_object_iter_value(void *iter);
82
83 unsigned int json_array_size(const json_t *array);
84 json_t *json_array_get(const json_t *array, unsigned int index);
85 int json_array_set(json_t *array, unsigned int index, json_t *value);
86 int json_array_append(json_t *array, json_t *value);
87
88 const char *json_string_value(const json_t *json);
89 int json_integer_value(const json_t *json);
90 double json_real_value(const json_t *json);
91 double json_number_value(const json_t *json);
92
93
94 /* loading, printing */
95
96 #define JSON_ERROR_TEXT_LENGTH  160
97
98 typedef struct {
99     char text[JSON_ERROR_TEXT_LENGTH];
100     int line;
101 } json_error_t;
102
103 json_t *json_loads(const char *input, json_error_t *error);
104 json_t *json_loadf(FILE *input, json_error_t *error);
105 json_t *json_load_file(const char *path, json_error_t *error);
106
107 #define JSON_INDENT(n)   (n & 0xFF)
108
109 char *json_dumps(const json_t *json, uint32_t flags);
110 int json_dumpf(const json_t *json, FILE *output, uint32_t flags);
111 int json_dump_file(const json_t *json, const char *path, uint32_t flags);
112
113 #endif