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.1 of the License, 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, see <http://www.gnu.org/licenses/>.
18 * Author: Ryan Lortie <desrt@desrt.ca>
21 #ifndef __G_VARIANT_H__
22 #define __G_VARIANT_H__
24 #if !defined (__GLIB_H_INSIDE__) && !defined (GLIB_COMPILATION)
25 #error "Only <glib.h> can be included directly."
28 #include <glib/gvarianttype.h>
29 #include <glib/gstring.h>
30 #include <glib/gbytes.h>
34 typedef struct _GVariant GVariant;
38 G_VARIANT_CLASS_BOOLEAN = 'b',
39 G_VARIANT_CLASS_BYTE = 'y',
40 G_VARIANT_CLASS_INT16 = 'n',
41 G_VARIANT_CLASS_UINT16 = 'q',
42 G_VARIANT_CLASS_INT32 = 'i',
43 G_VARIANT_CLASS_UINT32 = 'u',
44 G_VARIANT_CLASS_INT64 = 'x',
45 G_VARIANT_CLASS_UINT64 = 't',
46 G_VARIANT_CLASS_HANDLE = 'h',
47 G_VARIANT_CLASS_DOUBLE = 'd',
48 G_VARIANT_CLASS_STRING = 's',
49 G_VARIANT_CLASS_OBJECT_PATH = 'o',
50 G_VARIANT_CLASS_SIGNATURE = 'g',
51 G_VARIANT_CLASS_VARIANT = 'v',
52 G_VARIANT_CLASS_MAYBE = 'm',
53 G_VARIANT_CLASS_ARRAY = 'a',
54 G_VARIANT_CLASS_TUPLE = '(',
55 G_VARIANT_CLASS_DICT_ENTRY = '{'
59 void g_variant_unref (GVariant *value);
61 GVariant * g_variant_ref (GVariant *value);
63 GVariant * g_variant_ref_sink (GVariant *value);
65 gboolean g_variant_is_floating (GVariant *value);
67 GVariant * g_variant_take_ref (GVariant *value);
70 const GVariantType * g_variant_get_type (GVariant *value);
72 const gchar * g_variant_get_type_string (GVariant *value);
74 gboolean g_variant_is_of_type (GVariant *value,
75 const GVariantType *type);
77 gboolean g_variant_is_container (GVariant *value);
79 GVariantClass g_variant_classify (GVariant *value);
81 GVariant * g_variant_new_boolean (gboolean value);
83 GVariant * g_variant_new_byte (guint8 value);
85 GVariant * g_variant_new_int16 (gint16 value);
87 GVariant * g_variant_new_uint16 (guint16 value);
89 GVariant * g_variant_new_int32 (gint32 value);
91 GVariant * g_variant_new_uint32 (guint32 value);
93 GVariant * g_variant_new_int64 (gint64 value);
95 GVariant * g_variant_new_uint64 (guint64 value);
97 GVariant * g_variant_new_handle (gint32 value);
99 GVariant * g_variant_new_double (gdouble value);
100 GLIB_AVAILABLE_IN_ALL
101 GVariant * g_variant_new_string (const gchar *string);
102 GLIB_AVAILABLE_IN_2_38
103 GVariant * g_variant_new_take_string (gchar *string);
104 GLIB_AVAILABLE_IN_2_38
105 GVariant * g_variant_new_printf (const gchar *format_string,
106 ...) G_GNUC_PRINTF (1, 2);
107 GLIB_AVAILABLE_IN_ALL
108 GVariant * g_variant_new_object_path (const gchar *object_path);
109 GLIB_AVAILABLE_IN_ALL
110 gboolean g_variant_is_object_path (const gchar *string);
111 GLIB_AVAILABLE_IN_ALL
112 GVariant * g_variant_new_signature (const gchar *signature);
113 GLIB_AVAILABLE_IN_ALL
114 gboolean g_variant_is_signature (const gchar *string);
115 GLIB_AVAILABLE_IN_ALL
116 GVariant * g_variant_new_variant (GVariant *value);
117 GLIB_AVAILABLE_IN_ALL
118 GVariant * g_variant_new_strv (const gchar * const *strv,
120 GLIB_AVAILABLE_IN_2_30
121 GVariant * g_variant_new_objv (const gchar * const *strv,
123 GLIB_AVAILABLE_IN_ALL
124 GVariant * g_variant_new_bytestring (const gchar *string);
125 GLIB_AVAILABLE_IN_ALL
126 GVariant * g_variant_new_bytestring_array (const gchar * const *strv,
128 GLIB_AVAILABLE_IN_ALL
129 GVariant * g_variant_new_fixed_array (const GVariantType *element_type,
130 gconstpointer elements,
133 GLIB_AVAILABLE_IN_ALL
134 gboolean g_variant_get_boolean (GVariant *value);
135 GLIB_AVAILABLE_IN_ALL
136 guint8 g_variant_get_byte (GVariant *value);
137 GLIB_AVAILABLE_IN_ALL
138 gint16 g_variant_get_int16 (GVariant *value);
139 GLIB_AVAILABLE_IN_ALL
140 guint16 g_variant_get_uint16 (GVariant *value);
141 GLIB_AVAILABLE_IN_ALL
142 gint32 g_variant_get_int32 (GVariant *value);
143 GLIB_AVAILABLE_IN_ALL
144 guint32 g_variant_get_uint32 (GVariant *value);
145 GLIB_AVAILABLE_IN_ALL
146 gint64 g_variant_get_int64 (GVariant *value);
147 GLIB_AVAILABLE_IN_ALL
148 guint64 g_variant_get_uint64 (GVariant *value);
149 GLIB_AVAILABLE_IN_ALL
150 gint32 g_variant_get_handle (GVariant *value);
151 GLIB_AVAILABLE_IN_ALL
152 gdouble g_variant_get_double (GVariant *value);
153 GLIB_AVAILABLE_IN_ALL
154 GVariant * g_variant_get_variant (GVariant *value);
155 GLIB_AVAILABLE_IN_ALL
156 const gchar * g_variant_get_string (GVariant *value,
158 GLIB_AVAILABLE_IN_ALL
159 gchar * g_variant_dup_string (GVariant *value,
161 GLIB_AVAILABLE_IN_ALL
162 const gchar ** g_variant_get_strv (GVariant *value,
164 GLIB_AVAILABLE_IN_ALL
165 gchar ** g_variant_dup_strv (GVariant *value,
167 GLIB_AVAILABLE_IN_2_30
168 const gchar ** g_variant_get_objv (GVariant *value,
170 GLIB_AVAILABLE_IN_ALL
171 gchar ** g_variant_dup_objv (GVariant *value,
173 GLIB_AVAILABLE_IN_ALL
174 const gchar * g_variant_get_bytestring (GVariant *value);
175 GLIB_AVAILABLE_IN_ALL
176 gchar * g_variant_dup_bytestring (GVariant *value,
178 GLIB_AVAILABLE_IN_ALL
179 const gchar ** g_variant_get_bytestring_array (GVariant *value,
181 GLIB_AVAILABLE_IN_ALL
182 gchar ** g_variant_dup_bytestring_array (GVariant *value,
185 GLIB_AVAILABLE_IN_ALL
186 GVariant * g_variant_new_maybe (const GVariantType *child_type,
188 GLIB_AVAILABLE_IN_ALL
189 GVariant * g_variant_new_array (const GVariantType *child_type,
190 GVariant * const *children,
192 GLIB_AVAILABLE_IN_ALL
193 GVariant * g_variant_new_tuple (GVariant * const *children,
195 GLIB_AVAILABLE_IN_ALL
196 GVariant * g_variant_new_dict_entry (GVariant *key,
199 GLIB_AVAILABLE_IN_ALL
200 GVariant * g_variant_get_maybe (GVariant *value);
201 GLIB_AVAILABLE_IN_ALL
202 gsize g_variant_n_children (GVariant *value);
203 GLIB_AVAILABLE_IN_ALL
204 void g_variant_get_child (GVariant *value,
206 const gchar *format_string,
208 GLIB_AVAILABLE_IN_ALL
209 GVariant * g_variant_get_child_value (GVariant *value,
211 GLIB_AVAILABLE_IN_ALL
212 gboolean g_variant_lookup (GVariant *dictionary,
214 const gchar *format_string,
216 GLIB_AVAILABLE_IN_ALL
217 GVariant * g_variant_lookup_value (GVariant *dictionary,
219 const GVariantType *expected_type);
220 GLIB_AVAILABLE_IN_ALL
221 gconstpointer g_variant_get_fixed_array (GVariant *value,
225 GLIB_AVAILABLE_IN_ALL
226 gsize g_variant_get_size (GVariant *value);
227 GLIB_AVAILABLE_IN_ALL
228 gconstpointer g_variant_get_data (GVariant *value);
229 GLIB_AVAILABLE_IN_2_36
230 GBytes * g_variant_get_data_as_bytes (GVariant *value);
231 GLIB_AVAILABLE_IN_ALL
232 void g_variant_store (GVariant *value,
235 GLIB_AVAILABLE_IN_ALL
236 gchar * g_variant_print (GVariant *value,
237 gboolean type_annotate);
238 GLIB_AVAILABLE_IN_ALL
239 GString * g_variant_print_string (GVariant *value,
241 gboolean type_annotate);
243 GLIB_AVAILABLE_IN_ALL
244 guint g_variant_hash (gconstpointer value);
245 GLIB_AVAILABLE_IN_ALL
246 gboolean g_variant_equal (gconstpointer one,
249 GLIB_AVAILABLE_IN_ALL
250 GVariant * g_variant_get_normal_form (GVariant *value);
251 GLIB_AVAILABLE_IN_ALL
252 gboolean g_variant_is_normal_form (GVariant *value);
253 GLIB_AVAILABLE_IN_ALL
254 GVariant * g_variant_byteswap (GVariant *value);
256 GLIB_AVAILABLE_IN_2_36
257 GVariant * g_variant_new_from_bytes (const GVariantType *type,
260 GLIB_AVAILABLE_IN_ALL
261 GVariant * g_variant_new_from_data (const GVariantType *type,
265 GDestroyNotify notify,
268 typedef struct _GVariantIter GVariantIter;
269 struct _GVariantIter {
274 GLIB_AVAILABLE_IN_ALL
275 GVariantIter * g_variant_iter_new (GVariant *value);
276 GLIB_AVAILABLE_IN_ALL
277 gsize g_variant_iter_init (GVariantIter *iter,
279 GLIB_AVAILABLE_IN_ALL
280 GVariantIter * g_variant_iter_copy (GVariantIter *iter);
281 GLIB_AVAILABLE_IN_ALL
282 gsize g_variant_iter_n_children (GVariantIter *iter);
283 GLIB_AVAILABLE_IN_ALL
284 void g_variant_iter_free (GVariantIter *iter);
285 GLIB_AVAILABLE_IN_ALL
286 GVariant * g_variant_iter_next_value (GVariantIter *iter);
287 GLIB_AVAILABLE_IN_ALL
288 gboolean g_variant_iter_next (GVariantIter *iter,
289 const gchar *format_string,
291 GLIB_AVAILABLE_IN_ALL
292 gboolean g_variant_iter_loop (GVariantIter *iter,
293 const gchar *format_string,
297 typedef struct _GVariantBuilder GVariantBuilder;
298 struct _GVariantBuilder {
304 const GVariantType *type;
313 G_VARIANT_PARSE_ERROR_FAILED,
314 G_VARIANT_PARSE_ERROR_BASIC_TYPE_EXPECTED,
315 G_VARIANT_PARSE_ERROR_CANNOT_INFER_TYPE,
316 G_VARIANT_PARSE_ERROR_DEFINITE_TYPE_EXPECTED,
317 G_VARIANT_PARSE_ERROR_INPUT_NOT_AT_END,
318 G_VARIANT_PARSE_ERROR_INVALID_CHARACTER,
319 G_VARIANT_PARSE_ERROR_INVALID_FORMAT_STRING,
320 G_VARIANT_PARSE_ERROR_INVALID_OBJECT_PATH,
321 G_VARIANT_PARSE_ERROR_INVALID_SIGNATURE,
322 G_VARIANT_PARSE_ERROR_INVALID_TYPE_STRING,
323 G_VARIANT_PARSE_ERROR_NO_COMMON_TYPE,
324 G_VARIANT_PARSE_ERROR_NUMBER_OUT_OF_RANGE,
325 G_VARIANT_PARSE_ERROR_NUMBER_TOO_BIG,
326 G_VARIANT_PARSE_ERROR_TYPE_ERROR,
327 G_VARIANT_PARSE_ERROR_UNEXPECTED_TOKEN,
328 G_VARIANT_PARSE_ERROR_UNKNOWN_KEYWORD,
329 G_VARIANT_PARSE_ERROR_UNTERMINATED_STRING_CONSTANT,
330 G_VARIANT_PARSE_ERROR_VALUE_EXPECTED,
331 G_VARIANT_PARSE_ERROR_RECURSION
332 } GVariantParseError;
333 #define G_VARIANT_PARSE_ERROR (g_variant_parse_error_quark ())
335 GLIB_DEPRECATED_IN_2_38_FOR(g_variant_parse_error_quark)
336 GQuark g_variant_parser_get_error_quark (void);
338 GLIB_AVAILABLE_IN_ALL
339 GQuark g_variant_parse_error_quark (void);
342 * G_VARIANT_BUILDER_INIT:
343 * @variant_type: a const GVariantType*
345 * A stack-allocated #GVariantBuilder must be initialized if it is
346 * used together with g_auto() to avoid warnings or crashes if
347 * function returns before g_variant_builder_init() is called on the
350 * This macro can be used as initializer instead of an
351 * explicit zeroing a variable when declaring it and a following
352 * g_variant_builder_init(), but it cannot be assigned to a variable.
354 * The passed @variant_type should be a static GVariantType to avoid
355 * lifetime issues, as copying the @variant_type does not happen in
356 * the G_VARIANT_BUILDER_INIT() call, but rather in functions that
357 * make sure that #GVariantBuilder is valid.
359 * |[<!-- language="C" -->
360 * g_auto(GVariantBuilder) builder = G_VARIANT_BUILDER_INIT (G_VARIANT_TYPE_BYTESTRING);
365 #define G_VARIANT_BUILDER_INIT(variant_type) \
369 2942751021u /* == GVSB_MAGIC_PARTIAL, see gvariant.c */, variant_type, { 0, } \
374 GLIB_AVAILABLE_IN_ALL
375 GVariantBuilder * g_variant_builder_new (const GVariantType *type);
376 GLIB_AVAILABLE_IN_ALL
377 void g_variant_builder_unref (GVariantBuilder *builder);
378 GLIB_AVAILABLE_IN_ALL
379 GVariantBuilder * g_variant_builder_ref (GVariantBuilder *builder);
380 GLIB_AVAILABLE_IN_ALL
381 void g_variant_builder_init (GVariantBuilder *builder,
382 const GVariantType *type);
383 GLIB_AVAILABLE_IN_ALL
384 GVariant * g_variant_builder_end (GVariantBuilder *builder);
385 GLIB_AVAILABLE_IN_ALL
386 void g_variant_builder_clear (GVariantBuilder *builder);
387 GLIB_AVAILABLE_IN_ALL
388 void g_variant_builder_open (GVariantBuilder *builder,
389 const GVariantType *type);
390 GLIB_AVAILABLE_IN_ALL
391 void g_variant_builder_close (GVariantBuilder *builder);
392 GLIB_AVAILABLE_IN_ALL
393 void g_variant_builder_add_value (GVariantBuilder *builder,
395 GLIB_AVAILABLE_IN_ALL
396 void g_variant_builder_add (GVariantBuilder *builder,
397 const gchar *format_string,
399 GLIB_AVAILABLE_IN_ALL
400 void g_variant_builder_add_parsed (GVariantBuilder *builder,
404 GLIB_AVAILABLE_IN_ALL
405 GVariant * g_variant_new (const gchar *format_string,
407 GLIB_AVAILABLE_IN_ALL
408 void g_variant_get (GVariant *value,
409 const gchar *format_string,
411 GLIB_AVAILABLE_IN_ALL
412 GVariant * g_variant_new_va (const gchar *format_string,
413 const gchar **endptr,
415 GLIB_AVAILABLE_IN_ALL
416 void g_variant_get_va (GVariant *value,
417 const gchar *format_string,
418 const gchar **endptr,
420 GLIB_AVAILABLE_IN_2_34
421 gboolean g_variant_check_format_string (GVariant *value,
422 const gchar *format_string,
425 GLIB_AVAILABLE_IN_ALL
426 GVariant * g_variant_parse (const GVariantType *type,
429 const gchar **endptr,
431 GLIB_AVAILABLE_IN_ALL
432 GVariant * g_variant_new_parsed (const gchar *format,
434 GLIB_AVAILABLE_IN_ALL
435 GVariant * g_variant_new_parsed_va (const gchar *format,
438 GLIB_AVAILABLE_IN_2_40
439 gchar * g_variant_parse_error_print_context (GError *error,
440 const gchar *source_str);
442 GLIB_AVAILABLE_IN_ALL
443 gint g_variant_compare (gconstpointer one,
446 typedef struct _GVariantDict GVariantDict;
447 struct _GVariantDict {
461 * G_VARIANT_DICT_INIT:
462 * @asv: (nullable): a GVariant*
464 * A stack-allocated #GVariantDict must be initialized if it is used
465 * together with g_auto() to avoid warnings or crashes if function
466 * returns before g_variant_dict_init() is called on the builder.
468 * This macro can be used as initializer instead of an explicit
469 * zeroing a variable when declaring it and a following
470 * g_variant_dict_init(), but it cannot be assigned to a variable.
472 * The passed @asv has to live long enough for #GVariantDict to gather
473 * the entries from, as the gathering does not happen in the
474 * G_VARIANT_DICT_INIT() call, but rather in functions that make sure
475 * that #GVariantDict is valid. In context where the initialization
476 * value has to be a constant expression, the only possible value of
477 * @asv is %NULL. It is still possible to call g_variant_dict_init()
478 * safely with a different @asv right after the variable was
479 * initialized with G_VARIANT_DICT_INIT().
481 * |[<!-- language="C" -->
482 * g_autoptr(GVariant) variant = get_asv_variant ();
483 * g_auto(GVariantDict) dict = G_VARIANT_DICT_INIT (variant);
488 #define G_VARIANT_DICT_INIT(asv) \
492 asv, 3488698669u /* == GVSD_MAGIC_PARTIAL, see gvariant.c */, { 0, } \
497 GLIB_AVAILABLE_IN_2_40
498 GVariantDict * g_variant_dict_new (GVariant *from_asv);
500 GLIB_AVAILABLE_IN_2_40
501 void g_variant_dict_init (GVariantDict *dict,
504 GLIB_AVAILABLE_IN_2_40
505 gboolean g_variant_dict_lookup (GVariantDict *dict,
507 const gchar *format_string,
509 GLIB_AVAILABLE_IN_2_40
510 GVariant * g_variant_dict_lookup_value (GVariantDict *dict,
512 const GVariantType *expected_type);
513 GLIB_AVAILABLE_IN_2_40
514 gboolean g_variant_dict_contains (GVariantDict *dict,
516 GLIB_AVAILABLE_IN_2_40
517 void g_variant_dict_insert (GVariantDict *dict,
519 const gchar *format_string,
521 GLIB_AVAILABLE_IN_2_40
522 void g_variant_dict_insert_value (GVariantDict *dict,
525 GLIB_AVAILABLE_IN_2_40
526 gboolean g_variant_dict_remove (GVariantDict *dict,
528 GLIB_AVAILABLE_IN_2_40
529 void g_variant_dict_clear (GVariantDict *dict);
530 GLIB_AVAILABLE_IN_2_40
531 GVariant * g_variant_dict_end (GVariantDict *dict);
532 GLIB_AVAILABLE_IN_2_40
533 GVariantDict * g_variant_dict_ref (GVariantDict *dict);
534 GLIB_AVAILABLE_IN_2_40
535 void g_variant_dict_unref (GVariantDict *dict);
539 #endif /* __G_VARIANT_H__ */