summaryrefslogtreecommitdiff
path: root/json-glib/json-types.h
blob: 1851ef0a7b2569e00ce124119ee32c011cf24db6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
/* json-types.h - JSON data types
 * 
 * This file is part of JSON-GLib
 * Copyright (C) 2007  OpenedHand Ltd.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * Author:
 *   Emmanuele Bassi  <ebassi@openedhand.com>
 */

#ifndef __JSON_TYPES_H__
#define __JSON_TYPES_H__

#include <glib-object.h>

G_BEGIN_DECLS

/**
 * JSON_NODE_TYPE:
 * @node: a #JsonNode
 *
 * Evaluates to the #JsonNodeType contained by @node
 */
#define JSON_NODE_TYPE(node)    (json_node_get_node_type ((node)))

#define JSON_TYPE_NODE          (json_node_get_type ())
#define JSON_TYPE_OBJECT        (json_object_get_type ())
#define JSON_TYPE_ARRAY         (json_array_get_type ())

/**
 * JsonObject:
 *
 * A JSON object type. The contents of the #JsonObject structure are private
 * and should only be accessed by the provided API
 */
typedef struct _JsonObject      JsonObject;

/**
 * JsonArray:
 *
 * A JSON array type. The contents of the #JsonArray structure are private
 * and should only be accessed by the provided API
 */
typedef struct _JsonArray       JsonArray;

typedef struct _JsonNode        JsonNode;

/**
 * JsonNodeType:
 * @JSON_NODE_OBJECT: The node contains a #JsonObject
 * @JSON_NODE_ARRAY: The node contains a #JsonArray
 * @JSON_NODE_VALUE: The node contains a fundamental type
 * @JSON_NODE_NULL: Special type, for nodes containing null
 *
 * Indicates the content of a #JsonNode.
 */
typedef enum {
  JSON_NODE_OBJECT,
  JSON_NODE_ARRAY,
  JSON_NODE_VALUE,
  JSON_NODE_NULL
} JsonNodeType;

/**
 * JsonNode:
 * @type: the type of node
 *
 * A generic container of JSON data types. The contents of the #JsonNode
 * structure are private and should only be accessed via the provided
 * functions and never directly.
 */
struct _JsonNode
{
  /*< private >*/
  JsonNodeType type;

  union {
    JsonObject *object;
    JsonArray *array;
    GValue value;
  } data;

  JsonNode *parent;
};

/*
 * JsonNode
 */
GType                 json_node_get_type        (void) G_GNUC_CONST;
JsonNode *            json_node_new             (JsonNodeType  type);
JsonNode *            json_node_copy            (JsonNode     *node);
void                  json_node_free            (JsonNode     *node);
JsonNodeType          json_node_get_node_type   (JsonNode     *node);
GType                 json_node_get_value_type  (JsonNode     *node);
JsonNode *            json_node_get_parent      (JsonNode     *node);
G_CONST_RETURN gchar *json_node_type_name       (JsonNode     *node);

void                  json_node_set_object      (JsonNode     *node,
                                                 JsonObject   *object);
void                  json_node_take_object     (JsonNode     *node,
                                                 JsonObject   *object);
JsonObject *          json_node_get_object      (JsonNode     *node);
JsonObject *          json_node_dup_object      (JsonNode     *node);
void                  json_node_set_array       (JsonNode     *node,
                                                 JsonArray    *array);
void                  json_node_take_array      (JsonNode     *node,
                                                 JsonArray    *array);
JsonArray *           json_node_get_array       (JsonNode     *node);
JsonArray *           json_node_dup_array       (JsonNode     *node);
void                  json_node_set_value       (JsonNode     *node,
                                                 const GValue *value);
void                  json_node_get_value       (JsonNode     *node,
                                                 GValue       *value);
void                  json_node_set_string      (JsonNode     *node,
                                                 const gchar  *value);
G_CONST_RETURN gchar *json_node_get_string      (JsonNode     *node);
gchar *               json_node_dup_string      (JsonNode     *node);
void                  json_node_set_int         (JsonNode     *node,
                                                 gint          value);
gint                  json_node_get_int         (JsonNode     *node);
void                  json_node_set_double      (JsonNode     *node,
                                                 gdouble       value);
gdouble               json_node_get_double      (JsonNode     *node);
void                  json_node_set_boolean     (JsonNode     *node,
                                                 gboolean      value);
gboolean              json_node_get_boolean     (JsonNode     *node);
gboolean              json_node_is_null         (JsonNode     *node);

/*
 * JsonObject
 */
GType                 json_object_get_type           (void) G_GNUC_CONST;
JsonObject *          json_object_new                (void);
JsonObject *          json_object_ref                (JsonObject  *object);
void                  json_object_unref              (JsonObject  *object);

#ifndef JSON_DISABLE_DEPRECATED
void                  json_object_add_member         (JsonObject  *object,
                                                      const gchar *member_name,
                                                      JsonNode    *node) G_GNUC_DEPRECATED;
#endif /* JSON_DISABLE_DEPRECATED */

void                  json_object_set_member         (JsonObject  *object,
                                                      const gchar *member_name,
                                                      JsonNode    *node);
void                  json_object_set_int_member     (JsonObject  *object,
                                                      const gchar *member_name,
                                                      gint         value);
void                  json_object_set_double_member  (JsonObject  *object,
                                                      const gchar *member_name,
                                                      gdouble      value);
void                  json_object_set_boolean_member (JsonObject  *object,
                                                      const gchar *member_name,
                                                      gboolean     value);
void                  json_object_set_string_member  (JsonObject  *object,
                                                      const gchar *member_name,
                                                      const gchar *value);
void                  json_object_set_null_member    (JsonObject  *object,
                                                      const gchar *member_name);
void                  json_object_set_array_member   (JsonObject  *object,
                                                      const gchar *member_name,
                                                      JsonArray   *value);
void                  json_object_set_object_member  (JsonObject  *object,
                                                      const gchar *member_name,
                                                      JsonObject  *value);
GList *               json_object_get_members        (JsonObject  *object);
JsonNode *            json_object_get_member         (JsonObject  *object,
                                                      const gchar *member_name);
JsonNode *            json_object_dup_member         (JsonObject  *object,
                                                      const gchar *member_name);
gint                  json_object_get_int_member     (JsonObject  *object,
                                                      const gchar *member_name);
gdouble               json_object_get_double_member  (JsonObject  *object,
                                                      const gchar *member_name);
gboolean              json_object_get_boolean_member (JsonObject  *object,
                                                      const gchar *member_name);
G_CONST_RETURN gchar *json_object_get_string_member  (JsonObject  *object,
                                                      const gchar *member_name);
gboolean              json_object_get_null_member    (JsonObject  *object,
                                                      const gchar *member_name);
JsonArray *           json_object_get_array_member   (JsonObject  *object,
                                                      const gchar *member_name);
JsonObject *          json_object_get_object_member  (JsonObject  *object,
                                                      const gchar *member_name);
gboolean              json_object_has_member         (JsonObject  *object,
                                                      const gchar *member_name);
void                  json_object_remove_member      (JsonObject  *object,
                                                      const gchar *member_name);
GList *               json_object_get_values         (JsonObject  *object);
guint                 json_object_get_size           (JsonObject  *object);

GType                 json_array_get_type            (void) G_GNUC_CONST;
JsonArray *           json_array_new                 (void);
JsonArray *           json_array_sized_new           (guint        n_elements);
JsonArray *           json_array_ref                 (JsonArray   *array);
void                  json_array_unref               (JsonArray   *array);
void                  json_array_add_element         (JsonArray   *array,
                                                      JsonNode    *node);
void                  json_array_add_int_element     (JsonArray   *array,
                                                      gint         value);
void                  json_array_add_double_element  (JsonArray   *array,
                                                      gdouble      value);
void                  json_array_add_boolean_element (JsonArray   *array,
                                                      gboolean     value);
void                  json_array_add_string_element  (JsonArray   *array,
                                                      const gchar *value);
void                  json_array_add_null_element    (JsonArray   *array);
void                  json_array_add_array_element   (JsonArray   *array,
                                                      JsonArray   *value);
void                  json_array_add_object_element  (JsonArray   *array,
                                                      JsonObject  *value);
GList *               json_array_get_elements        (JsonArray   *array);
JsonNode *            json_array_get_element         (JsonArray   *array,
                                                      guint        index_);
gint                  json_array_get_int_element     (JsonArray   *array,
                                                      guint        index_);
gdouble               json_array_get_double_element  (JsonArray   *array,
                                                      guint        index_);
gboolean              json_array_get_boolean_element (JsonArray   *array,
                                                      guint        index_);
G_CONST_RETURN gchar *json_array_get_string_element  (JsonArray   *array,
                                                      guint        index_);
gboolean              json_array_get_null_element    (JsonArray   *array,
                                                      guint        index_);
JsonArray *           json_array_get_array_element   (JsonArray   *array,
                                                      guint        index_);
JsonObject *          json_array_get_object_element  (JsonArray   *array,
                                                      guint        index_);
JsonNode *            json_array_dup_element         (JsonArray   *array,
                                                      guint        index_);
void                  json_array_remove_element      (JsonArray   *array,
                                                      guint        index_);
guint                 json_array_get_length          (JsonArray   *array);

G_END_DECLS

#endif /* __JSON_TYPES_H__ */