/* json-types.h - JSON data types
*
* This file is part of JSON-GLib
*
* SPDX-FileCopyrightText: 2007 OpenedHand Ltd.
* SPDX-FileCopyrightText: 2009 Intel Corp.
* SPDX-License-Identifier: LGPL-2.1-or-later
*
* 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.1 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.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library. If not, see .
*
* Author:
* Emmanuele Bassi
*/
#pragma once
#if !defined(__JSON_GLIB_INSIDE__) && !defined(JSON_COMPILATION)
#error "Only can be included directly."
#endif
#include
#include
G_BEGIN_DECLS
/**
* JSON_NODE_TYPE:
* @node: (type Json.Node): the [struct@Json.Node] to check
*
* Evaluates to the [enum@Json.NodeType] value contained by the node.
*/
#define JSON_NODE_TYPE(node) (json_node_get_node_type ((node)))
/**
* JSON_NODE_HOLDS:
* @node: (type Json.Node): the [struct@Json.Node] to check
* @t: (type Json.NodeType): the desired [enum@Json.NodeType]
*
* Evaluates to `TRUE` if the node holds the given type.
*
* Since: 0.10
*/
#define JSON_NODE_HOLDS(node,t) (json_node_get_node_type ((node)) == (t))
/**
* JSON_NODE_HOLDS_VALUE:
* @node: (type Json.Node): the [struct@Json.Node] to check
*
* Evaluates to `TRUE` if the node holds a scalar value.
*
* Since: 0.10
*/
#define JSON_NODE_HOLDS_VALUE(node) (JSON_NODE_HOLDS ((node), JSON_NODE_VALUE))
/**
* JSON_NODE_HOLDS_OBJECT:
* @node: (type Json.Node): the [struct@Json.Node] to check
*
* Evaluates to `TRUE` if the node holds a JSON object.
*
* Since: 0.10
*/
#define JSON_NODE_HOLDS_OBJECT(node) (JSON_NODE_HOLDS ((node), JSON_NODE_OBJECT))
/**
* JSON_NODE_HOLDS_ARRAY:
* @node: (type Json.Node): the [struct@Json.Node] to check
*
* Evaluates to `TRUE` if the node holds a JSON array.
*
* Since: 0.10
*/
#define JSON_NODE_HOLDS_ARRAY(node) (JSON_NODE_HOLDS ((node), JSON_NODE_ARRAY))
/**
* JSON_NODE_HOLDS_NULL:
* @node: (type Json.Node): the [struct@Json.Node] to check
*
* Evaluates to `TRUE` if the node holds `null`.
*
* Since: 0.10
*/
#define JSON_NODE_HOLDS_NULL(node) (JSON_NODE_HOLDS ((node), JSON_NODE_NULL))
#define JSON_TYPE_NODE (json_node_get_type ())
#define JSON_TYPE_OBJECT (json_object_get_type ())
#define JSON_TYPE_ARRAY (json_array_get_type ())
typedef struct _JsonNode JsonNode;
typedef struct _JsonObject JsonObject;
typedef struct _JsonArray JsonArray;
/**
* JsonNodeType:
* @JSON_NODE_OBJECT: The node contains a JSON object
* @JSON_NODE_ARRAY: The node contains a JSON array
* @JSON_NODE_VALUE: The node contains a fundamental type
* @JSON_NODE_NULL: Special type, for nodes containing null
*
* Indicates the content of a node.
*/
typedef enum {
JSON_NODE_OBJECT,
JSON_NODE_ARRAY,
JSON_NODE_VALUE,
JSON_NODE_NULL
} JsonNodeType;
/**
* JsonObjectForeach:
* @object: the iterated JSON object
* @member_name: the name of the member
* @member_node: the value of the member
* @user_data: (closure): data passed to the function
*
* The function to be passed to [method@Json.Object.foreach_member].
*
* You should not add or remove members to and from @object within
* this function.
*
* It is safe to change the value of @member_node.
*
* Since: 0.8
*/
typedef void (* JsonObjectForeach) (JsonObject *object,
const gchar *member_name,
JsonNode *member_node,
gpointer user_data);
/**
* JsonArrayForeach:
* @array: the iterated JSON array
* @index_: the index of the element
* @element_node: the value of the element at the given @index_
* @user_data: (closure): data passed to the function
*
* The function to be passed to [method@Json.Array.foreach_element].
*
* You should not add or remove elements to and from @array within
* this function.
*
* It is safe to change the value of @element_node.
*
* Since: 0.8
*/
typedef void (* JsonArrayForeach) (JsonArray *array,
guint index_,
JsonNode *element_node,
gpointer user_data);
/*
* JsonNode
*/
JSON_AVAILABLE_IN_1_0
GType json_node_get_type (void) G_GNUC_CONST;
JSON_AVAILABLE_IN_1_0
JsonNode * json_node_new (JsonNodeType type);
JSON_AVAILABLE_IN_1_0
JsonNode * json_node_alloc (void);
JSON_AVAILABLE_IN_1_0
JsonNode * json_node_init (JsonNode *node,
JsonNodeType type);
JSON_AVAILABLE_IN_1_0
JsonNode * json_node_init_object (JsonNode *node,
JsonObject *object);
JSON_AVAILABLE_IN_1_0
JsonNode * json_node_init_array (JsonNode *node,
JsonArray *array);
JSON_AVAILABLE_IN_1_0
JsonNode * json_node_init_int (JsonNode *node,
gint64 value);
JSON_AVAILABLE_IN_1_0
JsonNode * json_node_init_double (JsonNode *node,
gdouble value);
JSON_AVAILABLE_IN_1_0
JsonNode * json_node_init_boolean (JsonNode *node,
gboolean value);
JSON_AVAILABLE_IN_1_0
JsonNode * json_node_init_string (JsonNode *node,
const char *value);
JSON_AVAILABLE_IN_1_0
JsonNode * json_node_init_null (JsonNode *node);
JSON_AVAILABLE_IN_1_0
JsonNode * json_node_copy (JsonNode *node);
JSON_AVAILABLE_IN_1_0
void json_node_free (JsonNode *node);
JSON_AVAILABLE_IN_1_2
JsonNode * json_node_ref (JsonNode *node);
JSON_AVAILABLE_IN_1_2
void json_node_unref (JsonNode *node);
JSON_AVAILABLE_IN_1_0
JsonNodeType json_node_get_node_type (JsonNode *node);
JSON_AVAILABLE_IN_1_0
GType json_node_get_value_type (JsonNode *node);
JSON_AVAILABLE_IN_1_0
void json_node_set_parent (JsonNode *node,
JsonNode *parent);
JSON_AVAILABLE_IN_1_0
JsonNode * json_node_get_parent (JsonNode *node);
JSON_AVAILABLE_IN_1_0
const gchar * json_node_type_name (JsonNode *node);
JSON_AVAILABLE_IN_1_0
void json_node_set_object (JsonNode *node,
JsonObject *object);
JSON_AVAILABLE_IN_1_0
void json_node_take_object (JsonNode *node,
JsonObject *object);
JSON_AVAILABLE_IN_1_0
JsonObject * json_node_get_object (JsonNode *node);
JSON_AVAILABLE_IN_1_0
JsonObject * json_node_dup_object (JsonNode *node);
JSON_AVAILABLE_IN_1_0
void json_node_set_array (JsonNode *node,
JsonArray *array);
JSON_AVAILABLE_IN_1_0
void json_node_take_array (JsonNode *node,
JsonArray *array);
JSON_AVAILABLE_IN_1_0
JsonArray * json_node_get_array (JsonNode *node);
JSON_AVAILABLE_IN_1_0
JsonArray * json_node_dup_array (JsonNode *node);
JSON_AVAILABLE_IN_1_0
void json_node_set_value (JsonNode *node,
const GValue *value);
JSON_AVAILABLE_IN_1_0
void json_node_get_value (JsonNode *node,
GValue *value);
JSON_AVAILABLE_IN_1_0
void json_node_set_string (JsonNode *node,
const gchar *value);
JSON_AVAILABLE_IN_1_0
const gchar * json_node_get_string (JsonNode *node);
JSON_AVAILABLE_IN_1_0
gchar * json_node_dup_string (JsonNode *node);
JSON_AVAILABLE_IN_1_0
void json_node_set_int (JsonNode *node,
gint64 value);
JSON_AVAILABLE_IN_1_0
gint64 json_node_get_int (JsonNode *node);
JSON_AVAILABLE_IN_1_0
void json_node_set_double (JsonNode *node,
gdouble value);
JSON_AVAILABLE_IN_1_0
gdouble json_node_get_double (JsonNode *node);
JSON_AVAILABLE_IN_1_0
void json_node_set_boolean (JsonNode *node,
gboolean value);
JSON_AVAILABLE_IN_1_0
gboolean json_node_get_boolean (JsonNode *node);
JSON_AVAILABLE_IN_1_0
gboolean json_node_is_null (JsonNode *node);
JSON_AVAILABLE_IN_1_2
void json_node_seal (JsonNode *node);
JSON_AVAILABLE_IN_1_2
gboolean json_node_is_immutable (JsonNode *node);
JSON_AVAILABLE_IN_1_2
guint json_string_hash (gconstpointer key);
JSON_AVAILABLE_IN_1_2
gboolean json_string_equal (gconstpointer a,
gconstpointer b);
JSON_AVAILABLE_IN_1_2
gint json_string_compare (gconstpointer a,
gconstpointer b);
JSON_AVAILABLE_IN_1_2
guint json_node_hash (gconstpointer key);
JSON_AVAILABLE_IN_1_2
gboolean json_node_equal (gconstpointer a,
gconstpointer b);
/*
* JsonObject
*/
JSON_AVAILABLE_IN_1_0
GType json_object_get_type (void) G_GNUC_CONST;
JSON_AVAILABLE_IN_1_0
JsonObject * json_object_new (void);
JSON_AVAILABLE_IN_1_0
JsonObject * json_object_ref (JsonObject *object);
JSON_AVAILABLE_IN_1_0
void json_object_unref (JsonObject *object);
JSON_DEPRECATED_IN_1_0_FOR(json_object_set_member)
void json_object_add_member (JsonObject *object,
const gchar *member_name,
JsonNode *node);
JSON_AVAILABLE_IN_1_0
void json_object_set_member (JsonObject *object,
const gchar *member_name,
JsonNode *node);
JSON_AVAILABLE_IN_1_0
void json_object_set_int_member (JsonObject *object,
const gchar *member_name,
gint64 value);
JSON_AVAILABLE_IN_1_0
void json_object_set_double_member (JsonObject *object,
const gchar *member_name,
gdouble value);
JSON_AVAILABLE_IN_1_0
void json_object_set_boolean_member (JsonObject *object,
const gchar *member_name,
gboolean value);
JSON_AVAILABLE_IN_1_0
void json_object_set_string_member (JsonObject *object,
const gchar *member_name,
const gchar *value);
JSON_AVAILABLE_IN_1_0
void json_object_set_null_member (JsonObject *object,
const gchar *member_name);
JSON_AVAILABLE_IN_1_0
void json_object_set_array_member (JsonObject *object,
const gchar *member_name,
JsonArray *value);
JSON_AVAILABLE_IN_1_0
void json_object_set_object_member (JsonObject *object,
const gchar *member_name,
JsonObject *value);
JSON_AVAILABLE_IN_1_0
GList * json_object_get_members (JsonObject *object);
JSON_AVAILABLE_IN_1_0
JsonNode * json_object_get_member (JsonObject *object,
const gchar *member_name);
JSON_AVAILABLE_IN_1_0
JsonNode * json_object_dup_member (JsonObject *object,
const gchar *member_name);
JSON_AVAILABLE_IN_1_0
gint64 json_object_get_int_member (JsonObject *object,
const gchar *member_name);
JSON_AVAILABLE_IN_1_6
gint64 json_object_get_int_member_with_default (JsonObject *object,
const char *member_name,
gint64 default_value);
JSON_AVAILABLE_IN_1_0
gdouble json_object_get_double_member (JsonObject *object,
const gchar *member_name);
JSON_AVAILABLE_IN_1_6
double json_object_get_double_member_with_default (JsonObject *object,
const char *member_name,
double default_value);
JSON_AVAILABLE_IN_1_0
gboolean json_object_get_boolean_member (JsonObject *object,
const gchar *member_name);
JSON_AVAILABLE_IN_1_6
gboolean json_object_get_boolean_member_with_default (JsonObject *object,
const char *member_name,
gboolean default_value);
JSON_AVAILABLE_IN_1_0
const gchar * json_object_get_string_member (JsonObject *object,
const gchar *member_name);
JSON_AVAILABLE_IN_1_6
const char * json_object_get_string_member_with_default (JsonObject *object,
const char *member_name,
const char *default_value);
JSON_AVAILABLE_IN_1_0
gboolean json_object_get_null_member (JsonObject *object,
const gchar *member_name);
JSON_AVAILABLE_IN_1_0
JsonArray * json_object_get_array_member (JsonObject *object,
const gchar *member_name);
JSON_AVAILABLE_IN_1_0
JsonObject * json_object_get_object_member (JsonObject *object,
const gchar *member_name);
JSON_AVAILABLE_IN_1_0
gboolean json_object_has_member (JsonObject *object,
const gchar *member_name);
JSON_AVAILABLE_IN_1_0
void json_object_remove_member (JsonObject *object,
const gchar *member_name);
JSON_AVAILABLE_IN_1_0
GList * json_object_get_values (JsonObject *object);
JSON_AVAILABLE_IN_1_0
guint json_object_get_size (JsonObject *object);
JSON_AVAILABLE_IN_1_0
void json_object_foreach_member (JsonObject *object,
JsonObjectForeach func,
gpointer data);
JSON_AVAILABLE_IN_1_2
void json_object_seal (JsonObject *object);
JSON_AVAILABLE_IN_1_2
gboolean json_object_is_immutable (JsonObject *object);
JSON_AVAILABLE_IN_1_2
guint json_object_hash (gconstpointer key);
JSON_AVAILABLE_IN_1_2
gboolean json_object_equal (gconstpointer a,
gconstpointer b);
/**
* JsonObjectIter:
*
* An iterator object used to iterate over the members of a JSON object.
*
* `JsonObjectIter` must be allocated on the stack and initialised using
* [method@Json.ObjectIter.init] or [method@Json.ObjectIter.init_ordered].
*
* The iterator is invalidated if the object is modified during
* iteration.
*
* All the fields in the `JsonObjectIter` structure are private and should
* never be accessed directly.
*
* Since: 1.2
*/
typedef struct {
/*< private >*/
gpointer priv_pointer[6];
int priv_int[2];
gboolean priv_boolean[1];
} JsonObjectIter;
JSON_AVAILABLE_IN_1_2
void json_object_iter_init (JsonObjectIter *iter,
JsonObject *object);
JSON_AVAILABLE_IN_1_2
gboolean json_object_iter_next (JsonObjectIter *iter,
const gchar **member_name,
JsonNode **member_node);
JSON_AVAILABLE_IN_1_6
void json_object_iter_init_ordered (JsonObjectIter *iter,
JsonObject *object);
JSON_AVAILABLE_IN_1_6
gboolean json_object_iter_next_ordered (JsonObjectIter *iter,
const char **member_name,
JsonNode **member_node);
JSON_AVAILABLE_IN_1_0
GType json_array_get_type (void) G_GNUC_CONST;
JSON_AVAILABLE_IN_1_0
JsonArray * json_array_new (void);
JSON_AVAILABLE_IN_1_0
JsonArray * json_array_sized_new (guint n_elements);
JSON_AVAILABLE_IN_1_0
JsonArray * json_array_ref (JsonArray *array);
JSON_AVAILABLE_IN_1_0
void json_array_unref (JsonArray *array);
JSON_AVAILABLE_IN_1_0
void json_array_add_element (JsonArray *array,
JsonNode *node);
JSON_AVAILABLE_IN_1_0
void json_array_add_int_element (JsonArray *array,
gint64 value);
JSON_AVAILABLE_IN_1_0
void json_array_add_double_element (JsonArray *array,
gdouble value);
JSON_AVAILABLE_IN_1_0
void json_array_add_boolean_element (JsonArray *array,
gboolean value);
JSON_AVAILABLE_IN_1_0
void json_array_add_string_element (JsonArray *array,
const gchar *value);
JSON_AVAILABLE_IN_1_0
void json_array_add_null_element (JsonArray *array);
JSON_AVAILABLE_IN_1_0
void json_array_add_array_element (JsonArray *array,
JsonArray *value);
JSON_AVAILABLE_IN_1_0
void json_array_add_object_element (JsonArray *array,
JsonObject *value);
JSON_AVAILABLE_IN_1_0
GList * json_array_get_elements (JsonArray *array);
JSON_AVAILABLE_IN_1_0
JsonNode * json_array_get_element (JsonArray *array,
guint index_);
JSON_AVAILABLE_IN_1_0
gint64 json_array_get_int_element (JsonArray *array,
guint index_);
JSON_AVAILABLE_IN_1_0
gdouble json_array_get_double_element (JsonArray *array,
guint index_);
JSON_AVAILABLE_IN_1_0
gboolean json_array_get_boolean_element (JsonArray *array,
guint index_);
JSON_AVAILABLE_IN_1_0
const gchar * json_array_get_string_element (JsonArray *array,
guint index_);
JSON_AVAILABLE_IN_1_0
gboolean json_array_get_null_element (JsonArray *array,
guint index_);
JSON_AVAILABLE_IN_1_0
JsonArray * json_array_get_array_element (JsonArray *array,
guint index_);
JSON_AVAILABLE_IN_1_0
JsonObject * json_array_get_object_element (JsonArray *array,
guint index_);
JSON_AVAILABLE_IN_1_0
JsonNode * json_array_dup_element (JsonArray *array,
guint index_);
JSON_AVAILABLE_IN_1_0
void json_array_remove_element (JsonArray *array,
guint index_);
JSON_AVAILABLE_IN_1_0
guint json_array_get_length (JsonArray *array);
JSON_AVAILABLE_IN_1_0
void json_array_foreach_element (JsonArray *array,
JsonArrayForeach func,
gpointer data);
JSON_AVAILABLE_IN_1_2
void json_array_seal (JsonArray *array);
JSON_AVAILABLE_IN_1_2
gboolean json_array_is_immutable (JsonArray *array);
JSON_AVAILABLE_IN_1_2
guint json_array_hash (gconstpointer key);
JSON_AVAILABLE_IN_1_2
gboolean json_array_equal (gconstpointer a,
gconstpointer b);
#ifdef G_DEFINE_AUTOPTR_CLEANUP_FUNC
G_DEFINE_AUTOPTR_CLEANUP_FUNC (JsonArray, json_array_unref)
G_DEFINE_AUTOPTR_CLEANUP_FUNC (JsonObject, json_object_unref)
G_DEFINE_AUTOPTR_CLEANUP_FUNC (JsonNode, json_node_unref)
#endif
G_END_DECLS