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 #if !defined (__GLIB_H_INSIDE__) && !defined (GLIB_COMPILATION)
27 #error "Only <glib.h> can be included directly."
30 #include <glib/gvarianttype.h>
31 #include <glib/gstring.h>
32 #include <glib/gbytes.h>
36 typedef struct _GVariant GVariant
;
40 G_VARIANT_CLASS_BOOLEAN
= 'b',
41 G_VARIANT_CLASS_BYTE
= 'y',
42 G_VARIANT_CLASS_INT16
= 'n',
43 G_VARIANT_CLASS_UINT16
= 'q',
44 G_VARIANT_CLASS_INT32
= 'i',
45 G_VARIANT_CLASS_UINT32
= 'u',
46 G_VARIANT_CLASS_INT64
= 'x',
47 G_VARIANT_CLASS_UINT64
= 't',
48 G_VARIANT_CLASS_HANDLE
= 'h',
49 G_VARIANT_CLASS_DOUBLE
= 'd',
50 G_VARIANT_CLASS_STRING
= 's',
51 G_VARIANT_CLASS_OBJECT_PATH
= 'o',
52 G_VARIANT_CLASS_SIGNATURE
= 'g',
53 G_VARIANT_CLASS_VARIANT
= 'v',
54 G_VARIANT_CLASS_MAYBE
= 'm',
55 G_VARIANT_CLASS_ARRAY
= 'a',
56 G_VARIANT_CLASS_TUPLE
= '(',
57 G_VARIANT_CLASS_DICT_ENTRY
= '{'
61 void g_variant_unref (GVariant
*value
);
63 GVariant
* g_variant_ref (GVariant
*value
);
65 GVariant
* g_variant_ref_sink (GVariant
*value
);
67 gboolean
g_variant_is_floating (GVariant
*value
);
69 GVariant
* g_variant_take_ref (GVariant
*value
);
72 const GVariantType
* g_variant_get_type (GVariant
*value
);
74 const gchar
* g_variant_get_type_string (GVariant
*value
);
76 gboolean
g_variant_is_of_type (GVariant
*value
,
77 const GVariantType
*type
);
79 gboolean
g_variant_is_container (GVariant
*value
);
81 GVariantClass
g_variant_classify (GVariant
*value
);
83 GVariant
* g_variant_new_boolean (gboolean value
);
85 GVariant
* g_variant_new_byte (guchar value
);
87 GVariant
* g_variant_new_int16 (gint16 value
);
89 GVariant
* g_variant_new_uint16 (guint16 value
);
91 GVariant
* g_variant_new_int32 (gint32 value
);
93 GVariant
* g_variant_new_uint32 (guint32 value
);
95 GVariant
* g_variant_new_int64 (gint64 value
);
97 GVariant
* g_variant_new_uint64 (guint64 value
);
99 GVariant
* g_variant_new_handle (gint32 value
);
100 GLIB_AVAILABLE_IN_ALL
101 GVariant
* g_variant_new_double (gdouble value
);
102 GLIB_AVAILABLE_IN_ALL
103 GVariant
* g_variant_new_string (const gchar
*string
);
104 GLIB_AVAILABLE_IN_2_38
105 GVariant
* g_variant_new_take_string (gchar
*string
);
106 GLIB_AVAILABLE_IN_2_38
107 GVariant
* g_variant_new_printf (const gchar
*format_string
,
108 ...) G_GNUC_PRINTF (1, 2);
109 GLIB_AVAILABLE_IN_ALL
110 GVariant
* g_variant_new_object_path (const gchar
*object_path
);
111 GLIB_AVAILABLE_IN_ALL
112 gboolean
g_variant_is_object_path (const gchar
*string
);
113 GLIB_AVAILABLE_IN_ALL
114 GVariant
* g_variant_new_signature (const gchar
*signature
);
115 GLIB_AVAILABLE_IN_ALL
116 gboolean
g_variant_is_signature (const gchar
*string
);
117 GLIB_AVAILABLE_IN_ALL
118 GVariant
* g_variant_new_variant (GVariant
*value
);
119 GLIB_AVAILABLE_IN_ALL
120 GVariant
* g_variant_new_strv (const gchar
* const *strv
,
122 GLIB_AVAILABLE_IN_2_30
123 GVariant
* g_variant_new_objv (const gchar
* const *strv
,
125 GLIB_AVAILABLE_IN_ALL
126 GVariant
* g_variant_new_bytestring (const gchar
*string
);
127 GLIB_AVAILABLE_IN_ALL
128 GVariant
* g_variant_new_bytestring_array (const gchar
* const *strv
,
130 GLIB_AVAILABLE_IN_ALL
131 GVariant
* g_variant_new_fixed_array (const GVariantType
*element_type
,
132 gconstpointer elements
,
135 GLIB_AVAILABLE_IN_ALL
136 gboolean
g_variant_get_boolean (GVariant
*value
);
137 GLIB_AVAILABLE_IN_ALL
138 guchar
g_variant_get_byte (GVariant
*value
);
139 GLIB_AVAILABLE_IN_ALL
140 gint16
g_variant_get_int16 (GVariant
*value
);
141 GLIB_AVAILABLE_IN_ALL
142 guint16
g_variant_get_uint16 (GVariant
*value
);
143 GLIB_AVAILABLE_IN_ALL
144 gint32
g_variant_get_int32 (GVariant
*value
);
145 GLIB_AVAILABLE_IN_ALL
146 guint32
g_variant_get_uint32 (GVariant
*value
);
147 GLIB_AVAILABLE_IN_ALL
148 gint64
g_variant_get_int64 (GVariant
*value
);
149 GLIB_AVAILABLE_IN_ALL
150 guint64
g_variant_get_uint64 (GVariant
*value
);
151 GLIB_AVAILABLE_IN_ALL
152 gint32
g_variant_get_handle (GVariant
*value
);
153 GLIB_AVAILABLE_IN_ALL
154 gdouble
g_variant_get_double (GVariant
*value
);
155 GLIB_AVAILABLE_IN_ALL
156 GVariant
* g_variant_get_variant (GVariant
*value
);
157 GLIB_AVAILABLE_IN_ALL
158 const gchar
* g_variant_get_string (GVariant
*value
,
160 GLIB_AVAILABLE_IN_ALL
161 gchar
* g_variant_dup_string (GVariant
*value
,
163 GLIB_AVAILABLE_IN_ALL
164 const gchar
** g_variant_get_strv (GVariant
*value
,
166 GLIB_AVAILABLE_IN_ALL
167 gchar
** g_variant_dup_strv (GVariant
*value
,
169 GLIB_AVAILABLE_IN_2_30
170 const gchar
** g_variant_get_objv (GVariant
*value
,
172 GLIB_AVAILABLE_IN_ALL
173 gchar
** g_variant_dup_objv (GVariant
*value
,
175 GLIB_AVAILABLE_IN_ALL
176 const gchar
* g_variant_get_bytestring (GVariant
*value
);
177 GLIB_AVAILABLE_IN_ALL
178 gchar
* g_variant_dup_bytestring (GVariant
*value
,
180 GLIB_AVAILABLE_IN_ALL
181 const gchar
** g_variant_get_bytestring_array (GVariant
*value
,
183 GLIB_AVAILABLE_IN_ALL
184 gchar
** g_variant_dup_bytestring_array (GVariant
*value
,
187 GLIB_AVAILABLE_IN_ALL
188 GVariant
* g_variant_new_maybe (const GVariantType
*child_type
,
190 GLIB_AVAILABLE_IN_ALL
191 GVariant
* g_variant_new_array (const GVariantType
*child_type
,
192 GVariant
* const *children
,
194 GLIB_AVAILABLE_IN_ALL
195 GVariant
* g_variant_new_tuple (GVariant
* const *children
,
197 GLIB_AVAILABLE_IN_ALL
198 GVariant
* g_variant_new_dict_entry (GVariant
*key
,
201 GLIB_AVAILABLE_IN_ALL
202 GVariant
* g_variant_get_maybe (GVariant
*value
);
203 GLIB_AVAILABLE_IN_ALL
204 gsize
g_variant_n_children (GVariant
*value
);
205 GLIB_AVAILABLE_IN_ALL
206 void g_variant_get_child (GVariant
*value
,
208 const gchar
*format_string
,
210 GLIB_AVAILABLE_IN_ALL
211 GVariant
* g_variant_get_child_value (GVariant
*value
,
213 GLIB_AVAILABLE_IN_ALL
214 gboolean
g_variant_lookup (GVariant
*dictionary
,
216 const gchar
*format_string
,
218 GLIB_AVAILABLE_IN_ALL
219 GVariant
* g_variant_lookup_value (GVariant
*dictionary
,
221 const GVariantType
*expected_type
);
222 GLIB_AVAILABLE_IN_ALL
223 gconstpointer
g_variant_get_fixed_array (GVariant
*value
,
227 GLIB_AVAILABLE_IN_ALL
228 gsize
g_variant_get_size (GVariant
*value
);
229 GLIB_AVAILABLE_IN_ALL
230 gconstpointer
g_variant_get_data (GVariant
*value
);
231 GLIB_AVAILABLE_IN_2_36
232 GBytes
* g_variant_get_data_as_bytes (GVariant
*value
);
233 GLIB_AVAILABLE_IN_ALL
234 void g_variant_store (GVariant
*value
,
237 GLIB_AVAILABLE_IN_ALL
238 gchar
* g_variant_print (GVariant
*value
,
239 gboolean type_annotate
);
240 GLIB_AVAILABLE_IN_ALL
241 GString
* g_variant_print_string (GVariant
*value
,
243 gboolean type_annotate
);
245 GLIB_AVAILABLE_IN_ALL
246 guint
g_variant_hash (gconstpointer value
);
247 GLIB_AVAILABLE_IN_ALL
248 gboolean
g_variant_equal (gconstpointer one
,
251 GLIB_AVAILABLE_IN_ALL
252 GVariant
* g_variant_get_normal_form (GVariant
*value
);
253 GLIB_AVAILABLE_IN_ALL
254 gboolean
g_variant_is_normal_form (GVariant
*value
);
255 GLIB_AVAILABLE_IN_ALL
256 GVariant
* g_variant_byteswap (GVariant
*value
);
258 GLIB_AVAILABLE_IN_2_36
259 GVariant
* g_variant_new_from_bytes (const GVariantType
*type
,
262 GLIB_AVAILABLE_IN_ALL
263 GVariant
* g_variant_new_from_data (const GVariantType
*type
,
267 GDestroyNotify notify
,
270 typedef struct _GVariantIter GVariantIter
;
271 struct _GVariantIter
{
276 GLIB_AVAILABLE_IN_ALL
277 GVariantIter
* g_variant_iter_new (GVariant
*value
);
278 GLIB_AVAILABLE_IN_ALL
279 gsize
g_variant_iter_init (GVariantIter
*iter
,
281 GLIB_AVAILABLE_IN_ALL
282 GVariantIter
* g_variant_iter_copy (GVariantIter
*iter
);
283 GLIB_AVAILABLE_IN_ALL
284 gsize
g_variant_iter_n_children (GVariantIter
*iter
);
285 GLIB_AVAILABLE_IN_ALL
286 void g_variant_iter_free (GVariantIter
*iter
);
287 GLIB_AVAILABLE_IN_ALL
288 GVariant
* g_variant_iter_next_value (GVariantIter
*iter
);
289 GLIB_AVAILABLE_IN_ALL
290 gboolean
g_variant_iter_next (GVariantIter
*iter
,
291 const gchar
*format_string
,
293 GLIB_AVAILABLE_IN_ALL
294 gboolean
g_variant_iter_loop (GVariantIter
*iter
,
295 const gchar
*format_string
,
299 typedef struct _GVariantBuilder GVariantBuilder
;
300 struct _GVariantBuilder
{
307 G_VARIANT_PARSE_ERROR_FAILED
,
308 G_VARIANT_PARSE_ERROR_BASIC_TYPE_EXPECTED
,
309 G_VARIANT_PARSE_ERROR_CANNOT_INFER_TYPE
,
310 G_VARIANT_PARSE_ERROR_DEFINITE_TYPE_EXPECTED
,
311 G_VARIANT_PARSE_ERROR_INPUT_NOT_AT_END
,
312 G_VARIANT_PARSE_ERROR_INVALID_CHARACTER
,
313 G_VARIANT_PARSE_ERROR_INVALID_FORMAT_STRING
,
314 G_VARIANT_PARSE_ERROR_INVALID_OBJECT_PATH
,
315 G_VARIANT_PARSE_ERROR_INVALID_SIGNATURE
,
316 G_VARIANT_PARSE_ERROR_INVALID_TYPE_STRING
,
317 G_VARIANT_PARSE_ERROR_NO_COMMON_TYPE
,
318 G_VARIANT_PARSE_ERROR_NUMBER_OUT_OF_RANGE
,
319 G_VARIANT_PARSE_ERROR_NUMBER_TOO_BIG
,
320 G_VARIANT_PARSE_ERROR_TYPE_ERROR
,
321 G_VARIANT_PARSE_ERROR_UNEXPECTED_TOKEN
,
322 G_VARIANT_PARSE_ERROR_UNKNOWN_KEYWORD
,
323 G_VARIANT_PARSE_ERROR_UNTERMINATED_STRING_CONSTANT
,
324 G_VARIANT_PARSE_ERROR_VALUE_EXPECTED
325 } GVariantParseError
;
326 #define G_VARIANT_PARSE_ERROR (g_variant_parser_get_error_quark ())
328 GLIB_AVAILABLE_IN_ALL
329 GQuark
g_variant_parser_get_error_quark (void);
331 GLIB_AVAILABLE_IN_ALL
332 GVariantBuilder
* g_variant_builder_new (const GVariantType
*type
);
333 GLIB_AVAILABLE_IN_ALL
334 void g_variant_builder_unref (GVariantBuilder
*builder
);
335 GLIB_AVAILABLE_IN_ALL
336 GVariantBuilder
* g_variant_builder_ref (GVariantBuilder
*builder
);
337 GLIB_AVAILABLE_IN_ALL
338 void g_variant_builder_init (GVariantBuilder
*builder
,
339 const GVariantType
*type
);
340 GLIB_AVAILABLE_IN_ALL
341 GVariant
* g_variant_builder_end (GVariantBuilder
*builder
);
342 GLIB_AVAILABLE_IN_ALL
343 void g_variant_builder_clear (GVariantBuilder
*builder
);
344 GLIB_AVAILABLE_IN_ALL
345 void g_variant_builder_open (GVariantBuilder
*builder
,
346 const GVariantType
*type
);
347 GLIB_AVAILABLE_IN_ALL
348 void g_variant_builder_close (GVariantBuilder
*builder
);
349 GLIB_AVAILABLE_IN_ALL
350 void g_variant_builder_add_value (GVariantBuilder
*builder
,
352 GLIB_AVAILABLE_IN_ALL
353 void g_variant_builder_add (GVariantBuilder
*builder
,
354 const gchar
*format_string
,
356 GLIB_AVAILABLE_IN_ALL
357 void g_variant_builder_add_parsed (GVariantBuilder
*builder
,
361 GLIB_AVAILABLE_IN_ALL
362 GVariant
* g_variant_new (const gchar
*format_string
,
364 GLIB_AVAILABLE_IN_ALL
365 void g_variant_get (GVariant
*value
,
366 const gchar
*format_string
,
368 GLIB_AVAILABLE_IN_ALL
369 GVariant
* g_variant_new_va (const gchar
*format_string
,
370 const gchar
**endptr
,
372 GLIB_AVAILABLE_IN_ALL
373 void g_variant_get_va (GVariant
*value
,
374 const gchar
*format_string
,
375 const gchar
**endptr
,
377 GLIB_AVAILABLE_IN_2_34
378 gboolean
g_variant_check_format_string (GVariant
*value
,
379 const gchar
*format_string
,
382 GLIB_AVAILABLE_IN_ALL
383 GVariant
* g_variant_parse (const GVariantType
*type
,
386 const gchar
**endptr
,
388 GLIB_AVAILABLE_IN_ALL
389 GVariant
* g_variant_new_parsed (const gchar
*format
,
391 GLIB_AVAILABLE_IN_ALL
392 GVariant
* g_variant_new_parsed_va (const gchar
*format
,
395 GLIB_AVAILABLE_IN_ALL
396 gint
g_variant_compare (gconstpointer one
,
400 #endif /* __G_VARIANT_H__ */