2 * Copyright © 2007, 2008 Ryan Lortie
3 * Copyright © 2009, 2010 Codethink Limited
5 * This library is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU Lesser General Public
7 * License as published by the Free Software Foundation; either
8 * version 2 of the licence, or (at your option) any later version.
10 * This library is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * Lesser General Public License for more details.
15 * You should have received a copy of the GNU Lesser General Public
16 * License along with this library; if not, write to the
17 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18 * Boston, MA 02111-1307, USA.
20 * Author: Ryan Lortie <desrt@desrt.ca>
23 #ifndef __G_VARIANT_H__
24 #define __G_VARIANT_H__
26 #include <glib/gvarianttype.h>
27 #include <glib/gstring.h>
31 typedef struct _GVariant GVariant;
35 G_VARIANT_CLASS_BOOLEAN = 'b',
36 G_VARIANT_CLASS_BYTE = 'y',
37 G_VARIANT_CLASS_INT16 = 'n',
38 G_VARIANT_CLASS_UINT16 = 'q',
39 G_VARIANT_CLASS_INT32 = 'i',
40 G_VARIANT_CLASS_UINT32 = 'u',
41 G_VARIANT_CLASS_INT64 = 'x',
42 G_VARIANT_CLASS_UINT64 = 't',
43 G_VARIANT_CLASS_HANDLE = 'h',
44 G_VARIANT_CLASS_DOUBLE = 'd',
45 G_VARIANT_CLASS_STRING = 's',
46 G_VARIANT_CLASS_OBJECT_PATH = 'o',
47 G_VARIANT_CLASS_SIGNATURE = 'g',
48 G_VARIANT_CLASS_VARIANT = 'v',
49 G_VARIANT_CLASS_MAYBE = 'm',
50 G_VARIANT_CLASS_ARRAY = 'a',
51 G_VARIANT_CLASS_TUPLE = '(',
52 G_VARIANT_CLASS_DICT_ENTRY = '{'
55 void g_variant_unref (GVariant *value);
56 GVariant * g_variant_ref (GVariant *value);
57 GVariant * g_variant_ref_sink (GVariant *value);
59 const GVariantType * g_variant_get_type (GVariant *value);
60 const gchar * g_variant_get_type_string (GVariant *value);
61 gboolean g_variant_is_of_type (GVariant *value,
62 const GVariantType *type);
63 gboolean g_variant_is_container (GVariant *value);
64 GVariantClass g_variant_classify (GVariant *value);
65 GVariant * g_variant_new_boolean (gboolean boolean);
66 GVariant * g_variant_new_byte (guchar byte);
67 GVariant * g_variant_new_int16 (gint16 int16);
68 GVariant * g_variant_new_uint16 (guint16 uint16);
69 GVariant * g_variant_new_int32 (gint32 int32);
70 GVariant * g_variant_new_uint32 (guint32 uint32);
71 GVariant * g_variant_new_int64 (gint64 int64);
72 GVariant * g_variant_new_uint64 (guint64 uint64);
73 GVariant * g_variant_new_handle (gint32 handle);
74 GVariant * g_variant_new_double (gdouble floating);
75 GVariant * g_variant_new_string (const gchar *string);
76 GVariant * g_variant_new_object_path (const gchar *object_path);
77 gboolean g_variant_is_object_path (const gchar *string);
78 GVariant * g_variant_new_signature (const gchar *signature);
79 gboolean g_variant_is_signature (const gchar *string);
80 GVariant * g_variant_new_variant (GVariant *value);
81 GVariant * g_variant_new_strv (const gchar * const *strv,
84 gboolean g_variant_get_boolean (GVariant *value);
85 guchar g_variant_get_byte (GVariant *value);
86 gint16 g_variant_get_int16 (GVariant *value);
87 guint16 g_variant_get_uint16 (GVariant *value);
88 gint32 g_variant_get_int32 (GVariant *value);
89 guint32 g_variant_get_uint32 (GVariant *value);
90 gint64 g_variant_get_int64 (GVariant *value);
91 guint64 g_variant_get_uint64 (GVariant *value);
92 gint32 g_variant_get_handle (GVariant *value);
93 gdouble g_variant_get_double (GVariant *value);
94 GVariant * g_variant_get_variant (GVariant *value);
95 const gchar * g_variant_get_string (GVariant *value,
97 gchar * g_variant_dup_string (GVariant *value,
99 const gchar ** g_variant_get_strv (GVariant *value,
101 gchar ** g_variant_dup_strv (GVariant *value,
104 GVariant * g_variant_new_maybe (const GVariantType *child_type,
106 GVariant * g_variant_new_array (const GVariantType *child_type,
107 GVariant * const *children,
109 GVariant * g_variant_new_tuple (GVariant * const *children,
111 GVariant * g_variant_new_dict_entry (GVariant *key,
114 GVariant * g_variant_get_maybe (GVariant *value);
115 gsize g_variant_n_children (GVariant *value);
116 void g_variant_get_child (GVariant *value,
118 const gchar *format_string,
120 GVariant * g_variant_get_child_value (GVariant *value,
122 gconstpointer g_variant_get_fixed_array (GVariant *value,
126 gsize g_variant_get_size (GVariant *value);
127 gconstpointer g_variant_get_data (GVariant *value);
128 void g_variant_store (GVariant *value,
131 gchar * g_variant_print (GVariant *value,
132 gboolean type_annotate);
133 GString * g_variant_print_string (GVariant *value,
135 gboolean type_annotate);
137 guint g_variant_hash (gconstpointer value);
138 gboolean g_variant_equal (gconstpointer one,
141 GVariant * g_variant_get_normal_form (GVariant *value);
142 gboolean g_variant_is_normal_form (GVariant *value);
143 GVariant * g_variant_byteswap (GVariant *value);
144 GVariant * g_variant_new_from_data (const GVariantType *type,
148 GDestroyNotify notify,
151 typedef struct _GVariantIter GVariantIter;
152 struct _GVariantIter {
157 GVariantIter * g_variant_iter_new (GVariant *value);
158 gsize g_variant_iter_init (GVariantIter *iter,
160 GVariantIter * g_variant_iter_copy (GVariantIter *iter);
161 gsize g_variant_iter_n_children (GVariantIter *iter);
162 void g_variant_iter_free (GVariantIter *iter);
163 GVariant * g_variant_iter_next_value (GVariantIter *iter);
164 gboolean g_variant_iter_next (GVariantIter *iter,
165 const gchar *format_string,
167 gboolean g_variant_iter_loop (GVariantIter *iter,
168 const gchar *format_string,
172 typedef struct _GVariantBuilder GVariantBuilder;
173 struct _GVariantBuilder {
178 #define G_VARIANT_PARSE_ERROR (g_variant_parser_get_error_quark ())
179 GQuark g_variant_parser_get_error_quark (void);
181 GVariantBuilder * g_variant_builder_new (const GVariantType *type);
182 void g_variant_builder_unref (GVariantBuilder *builder);
183 GVariantBuilder * g_variant_builder_ref (GVariantBuilder *builder);
184 void g_variant_builder_init (GVariantBuilder *builder,
185 const GVariantType *type);
186 GVariant * g_variant_builder_end (GVariantBuilder *builder);
187 void g_variant_builder_clear (GVariantBuilder *builder);
188 void g_variant_builder_open (GVariantBuilder *builder,
189 const GVariantType *type);
190 void g_variant_builder_close (GVariantBuilder *builder);
191 void g_variant_builder_add_value (GVariantBuilder *builder,
193 void g_variant_builder_add (GVariantBuilder *builder,
194 const gchar *format_string,
197 GVariant * g_variant_new (const gchar *format_string,
199 void g_variant_get (GVariant *value,
200 const gchar *format_string,
202 GVariant * g_variant_new_va (const gchar *format_string,
203 const gchar **endptr,
205 void g_variant_get_va (GVariant *value,
206 const gchar *format_string,
207 const gchar **endptr,
211 GVariant * g_variant_parse (const GVariantType *type,
214 const gchar **endptr,
216 GVariant * g_variant_new_parsed (const gchar *format,
218 GVariant * g_variant_new_parsed_va (const gchar *format,
221 gint g_variant_compare (gconstpointer one,
225 #endif /* __G_VARIANT_H__ */