summaryrefslogtreecommitdiff
path: root/json-glib/json-types.h
blob: 9578b1c37eedb9609bbc5dc90d66cedf3f3eff92 (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
/* 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

#define JSON_NODE_TYPE(node)    (((JsonNode *) (node))->type)
#define JSON_TYPE_OBJECT        (json_object_get_type ())
#define JSON_TYPE_ARRAY         (json_array_get_type ())

typedef struct _JsonObject      JsonObject;
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 #GValue
 * @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:
 *
 * 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;
};

JsonObject *          json_node_get_object    (JsonNode    *node);
JsonArray *           json_node_get_array     (JsonNode    *node);
void                  json_node_get_value     (JsonNode    *node,
                                               GValue      *value);
JsonNode *            json_node_get_parent    (JsonNode    *node);
G_CONST_RETURN gchar *json_node_type_name     (JsonNode    *node);

JsonObject *          json_object_ref         (JsonObject  *object);
void                  json_object_unref       (JsonObject  *object);
GList *               json_object_get_members (JsonObject  *object);
JsonNode *            json_object_get_member  (JsonObject  *object,
                                               const gchar *member_name);
gboolean              json_object_has_member  (JsonObject  *object,
                                               const gchar *member_name);
guint                 json_object_get_size    (JsonObject  *object);

JsonArray *           json_array_ref          (JsonArray   *array);
void                  json_array_unref        (JsonArray   *array);
GList *               json_array_get_elements (JsonArray   *array);
JsonNode *            json_array_get_element  (JsonArray   *array,
                                               guint        index_);
guint                 json_array_get_length   (JsonArray   *array);

G_END_DECLS

#endif /* __JSON_TYPES_H__ */