2 * Copyright © 2007, 2008 Ryan Lortie
3 * Copyright © 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>
27 #include <glib/gvariant-serialiser.h>
28 #include "gvariant-internal.h"
29 #include <glib/gvariant-core.h>
30 #include <glib/gtestutils.h>
31 #include <glib/gstrfuncs.h>
32 #include <glib/gslice.h>
33 #include <glib/ghash.h>
34 #include <glib/gmem.h>
42 * @short_description: strongly typed value datatype
43 * @see_also: GVariantType
45 * #GVariant is a variant datatype; it stores a value along with
46 * information about the type of that value. The range of possible
47 * values is determined by the type. The type system used by #GVariant
50 * #GVariant instances always have a type and a value (which are given
51 * at construction time). The type and value of a #GVariant instance
52 * can never change other than by the #GVariant itself being
53 * destroyed. A #GVariant cannot contain a pointer.
55 * #GVariant is reference counted using g_variant_ref() and
56 * g_variant_unref(). #GVariant also has floating reference counts --
57 * see g_variant_ref_sink().
59 * #GVariant is completely threadsafe. A #GVariant instance can be
60 * concurrently accessed in any way from any number of threads without
63 * #GVariant is heavily optimised for dealing with data in serialised
64 * form. It works particularly well with data located in memory-mapped
65 * files. It can perform nearly all deserialisation operations in a
66 * small constant time, usually touching only a single memory page.
67 * Serialised #GVariant data can also be sent over the network.
69 * #GVariant is largely compatible with D-Bus. Almost all types of
70 * #GVariant instances can be sent over D-Bus. See #GVariantType for
73 * For convenience to C programmers, #GVariant features powerful
74 * varargs-based value construction and destruction. This feature is
75 * designed to be embedded in other libraries.
77 * There is a Python-inspired text language for describing #GVariant
78 * values. #GVariant includes a printer for this language and a parser
79 * with type inferencing.
82 * <title>Memory Use</title>
84 * #GVariant tries to be quite efficient with respect to memory use.
85 * This section gives a rough idea of how much memory is used by the
86 * current implementation. The information here is subject to change
90 * The memory allocated by #GVariant can be grouped into 4 broad
91 * purposes: memory for serialised data, memory for the type
92 * information cache, buffer management memory and memory for the
93 * #GVariant structure itself.
96 * <title>Serialised Data Memory</title>
98 * This is the memory that is used for storing GVariant data in
99 * serialised form. This is what would be sent over the network or
100 * what would end up on disk.
103 * The amount of memory required to store a boolean is 1 byte. 16,
104 * 32 and 64 bit integers and double precision floating point numbers
105 * use their "natural" size. Strings (including object path and
106 * signature strings) are stored with a nul terminator, and as such
107 * use the length of the string plus 1 byte.
110 * Maybe types use no space at all to represent the null value and
111 * use the same amount of space (sometimes plus one byte) as the
112 * equivalent non-maybe-typed value to represent the non-null case.
115 * Arrays use the amount of space required to store each of their
116 * members, concatenated. Additionally, if the items stored in an
117 * array are not of a fixed-size (ie: strings, other arrays, etc)
118 * then an additional framing offset is stored for each item. The
119 * size of this offset is either 1, 2 or 4 bytes depending on the
120 * overall size of the container. Additionally, extra padding bytes
121 * are added as required for alignment of child values.
124 * Tuples (including dictionary entries) use the amount of space
125 * required to store each of their members, concatenated, plus one
126 * framing offset (as per arrays) for each non-fixed-sized item in
127 * the tuple, except for the last one. Additionally, extra padding
128 * bytes are added as required for alignment of child values.
131 * Variants use the same amount of space as the item inside of the
132 * variant, plus 1 byte, plus the length of the type string for the
133 * item inside the variant.
136 * As an example, consider a dictionary mapping strings to variants.
137 * In the case that the dictionary is empty, 0 bytes are required for
141 * If we add an item "width" that maps to the int32 value of 500 then
142 * we will use 4 byte to store the int32 (so 6 for the variant
143 * containing it) and 6 bytes for the string. The variant must be
144 * aligned to 8 after the 6 bytes of the string, so that's 2 extra
145 * bytes. 6 (string) + 2 (padding) + 6 (variant) is 14 bytes used
146 * for the dictionary entry. An additional 1 byte is added to the
147 * array as a framing offset making a total of 15 bytes.
150 * If we add another entry, "title" that maps to a nullable string
151 * that happens to have a value of null, then we use 0 bytes for the
152 * null value (and 3 bytes for the variant to contain it along with
153 * its type string) plus 6 bytes for the string. Again, we need 2
154 * padding bytes. That makes a total of 6 + 2 + 3 = 11 bytes.
157 * We now require extra padding between the two items in the array.
158 * After the 14 bytes of the first item, that's 2 bytes required. We
159 * now require 2 framing offsets for an extra two bytes. 14 + 2 + 11
160 * + 2 = 29 bytes to encode the entire two-item dictionary.
164 * <title>Type Information Cache</title>
166 * For each GVariant type that currently exists in the program a type
167 * information structure is kept in the type information cache. The
168 * type information structure is required for rapid deserialisation.
171 * Continuing with the above example, if a #GVariant exists with the
172 * type "a{sv}" then a type information struct will exist for
173 * "a{sv}", "{sv}", "s", and "v". Multiple uses of the same type
174 * will share the same type information. Additionally, all
175 * single-digit types are stored in read-only static memory and do
176 * not contribute to the writable memory footprint of a program using
180 * Aside from the type information structures stored in read-only
181 * memory, there are two forms of type information. One is used for
182 * container types where there is a single element type: arrays and
183 * maybe types. The other is used for container types where there
184 * are multiple element types: tuples and dictionary entries.
187 * Array type info structures are 6 * sizeof (void *), plus the
188 * memory required to store the type string itself. This means that
189 * on 32bit systems, the cache entry for "a{sv}" would require 30
190 * bytes of memory (plus malloc overhead).
193 * Tuple type info structures are 6 * sizeof (void *), plus 4 *
194 * sizeof (void *) for each item in the tuple, plus the memory
195 * required to store the type string itself. A 2-item tuple, for
196 * example, would have a type information structure that consumed
197 * writable memory in the size of 14 * sizeof (void *) (plus type
198 * string) This means that on 32bit systems, the cache entry for
199 * "{sv}" would require 61 bytes of memory (plus malloc overhead).
202 * This means that in total, for our "a{sv}" example, 91 bytes of
203 * type information would be allocated.
206 * The type information cache, additionally, uses a #GHashTable to
207 * store and lookup the cached items and stores a pointer to this
208 * hash table in static storage. The hash table is freed when there
209 * are zero items in the type cache.
212 * Although these sizes may seem large it is important to remember
213 * that a program will probably only have a very small number of
214 * different types of values in it and that only one type information
215 * structure is required for many different values of the same type.
219 * <title>Buffer Management Memory</title>
221 * #GVariant uses an internal buffer management structure to deal
222 * with the various different possible sources of serialised data
223 * that it uses. The buffer is responsible for ensuring that the
224 * correct call is made when the data is no longer in use by
225 * #GVariant. This may involve a g_free() or a g_slice_free() or
226 * even g_mapped_file_unref().
229 * One buffer management structure is used for each chunk of
230 * serialised data. The size of the buffer management structure is 4
231 * * (void *). On 32bit systems, that's 16 bytes.
235 * <title>GVariant structure</title>
237 * The size of a #GVariant structure is 6 * (void *). On 32 bit
238 * systems, that's 24 bytes.
241 * #GVariant structures only exist if they are explicitly created
242 * with API calls. For example, if a #GVariant is constructed out of
243 * serialised data for the example given above (with the dictionary)
244 * then although there are 9 individual values that comprise the
245 * entire dictionary (two keys, two values, two variants containing
246 * the values, two dictionary entries, plus the dictionary itself),
247 * only 1 #GVariant instance exists -- the one referring to the
251 * If calls are made to start accessing the other values then
252 * #GVariant instances will exist for those values only for as long
253 * as they are in use (ie: until you call g_variant_unref()). The
254 * type information is shared. The serialised data and the buffer
255 * management structure for that serialised data is shared by the
260 * <title>Summary</title>
262 * To put the entire example together, for our dictionary mapping
263 * strings to variants (with two entries, as given above), we are
264 * using 91 bytes of memory for type information, 29 byes of memory
265 * for the serialised data, 16 bytes for buffer management and 24
266 * bytes for the #GVariant instance, or a total of 160 bytes, plus
267 * malloc overhead. If we were to use g_variant_get_child_value() to
268 * access the two dictionary entries, we would use an additional 48
269 * bytes. If we were to have other dictionaries of the same type, we
270 * would use more memory for the serialised data and buffer
271 * management for those dictionaries, but the type information would
278 /* definition of GVariant structure is in gvariant-core.c */
280 /* this is a g_return_val_if_fail() for making
281 * sure a (GVariant *) has the required type.
283 #define TYPE_CHECK(value, TYPE, val) \
284 if G_UNLIKELY (!g_variant_is_of_type (value, TYPE)) { \
285 g_return_if_fail_warning (G_LOG_DOMAIN, G_STRFUNC, \
286 "g_variant_is_of_type (" #value \
291 /* Numeric Type Constructor/Getters {{{1 */
293 * g_variant_new_from_trusted:
294 * @type: the #GVariantType
295 * @data: the data to use
296 * @size: the size of @data
297 * @returns: a new floating #GVariant
299 * Constructs a new trusted #GVariant instance from the provided data.
300 * This is used to implement g_variant_new_* for all the basic types.
303 g_variant_new_from_trusted (const GVariantType *type,
310 buffer = g_buffer_new_from_data (data, size);
311 value = g_variant_new_from_buffer (type, buffer, TRUE);
312 g_buffer_unref (buffer);
318 * g_variant_new_boolean:
319 * @value: a #gboolean value
320 * @returns: (transfer none): a floating reference to a new boolean #GVariant instance
322 * Creates a new boolean #GVariant instance -- either %TRUE or %FALSE.
327 g_variant_new_boolean (gboolean value)
331 return g_variant_new_from_trusted (G_VARIANT_TYPE_BOOLEAN, &v, 1);
335 * g_variant_get_boolean:
336 * @value: a boolean #GVariant instance
337 * @returns: %TRUE or %FALSE
339 * Returns the boolean value of @value.
341 * It is an error to call this function with a @value of any type
342 * other than %G_VARIANT_TYPE_BOOLEAN.
347 g_variant_get_boolean (GVariant *value)
351 TYPE_CHECK (value, G_VARIANT_TYPE_BOOLEAN, FALSE);
353 data = g_variant_get_data (value);
355 return data != NULL ? *data != 0 : FALSE;
358 /* the constructors and accessors for byte, int{16,32,64}, handles and
359 * doubles all look pretty much exactly the same, so we reduce
362 #define NUMERIC_TYPE(TYPE, type, ctype) \
363 GVariant *g_variant_new_##type (ctype value) { \
364 return g_variant_new_from_trusted (G_VARIANT_TYPE_##TYPE, \
365 &value, sizeof value); \
367 ctype g_variant_get_##type (GVariant *value) { \
369 TYPE_CHECK (value, G_VARIANT_TYPE_ ## TYPE, 0); \
370 data = g_variant_get_data (value); \
371 return data != NULL ? *data : 0; \
376 * g_variant_new_byte:
377 * @value: a #guint8 value
378 * @returns: (transfer none): a floating reference to a new byte #GVariant instance
380 * Creates a new byte #GVariant instance.
385 * g_variant_get_byte:
386 * @value: a byte #GVariant instance
387 * @returns: a #guchar
389 * Returns the byte value of @value.
391 * It is an error to call this function with a @value of any type
392 * other than %G_VARIANT_TYPE_BYTE.
396 NUMERIC_TYPE (BYTE, byte, guchar)
399 * g_variant_new_int16:
400 * @value: a #gint16 value
401 * @returns: (transfer none): a floating reference to a new int16 #GVariant instance
403 * Creates a new int16 #GVariant instance.
408 * g_variant_get_int16:
409 * @value: a int16 #GVariant instance
410 * @returns: a #gint16
412 * Returns the 16-bit signed integer value of @value.
414 * It is an error to call this function with a @value of any type
415 * other than %G_VARIANT_TYPE_INT16.
419 NUMERIC_TYPE (INT16, int16, gint16)
422 * g_variant_new_uint16:
423 * @value: a #guint16 value
424 * @returns: (transfer none): a floating reference to a new uint16 #GVariant instance
426 * Creates a new uint16 #GVariant instance.
431 * g_variant_get_uint16:
432 * @value: a uint16 #GVariant instance
433 * @returns: a #guint16
435 * Returns the 16-bit unsigned integer value of @value.
437 * It is an error to call this function with a @value of any type
438 * other than %G_VARIANT_TYPE_UINT16.
442 NUMERIC_TYPE (UINT16, uint16, guint16)
445 * g_variant_new_int32:
446 * @value: a #gint32 value
447 * @returns: (transfer none): a floating reference to a new int32 #GVariant instance
449 * Creates a new int32 #GVariant instance.
454 * g_variant_get_int32:
455 * @value: a int32 #GVariant instance
456 * @returns: a #gint32
458 * Returns the 32-bit signed integer value of @value.
460 * It is an error to call this function with a @value of any type
461 * other than %G_VARIANT_TYPE_INT32.
465 NUMERIC_TYPE (INT32, int32, gint32)
468 * g_variant_new_uint32:
469 * @value: a #guint32 value
470 * @returns: (transfer none): a floating reference to a new uint32 #GVariant instance
472 * Creates a new uint32 #GVariant instance.
477 * g_variant_get_uint32:
478 * @value: a uint32 #GVariant instance
479 * @returns: a #guint32
481 * Returns the 32-bit unsigned integer value of @value.
483 * It is an error to call this function with a @value of any type
484 * other than %G_VARIANT_TYPE_UINT32.
488 NUMERIC_TYPE (UINT32, uint32, guint32)
491 * g_variant_new_int64:
492 * @value: a #gint64 value
493 * @returns: (transfer none): a floating reference to a new int64 #GVariant instance
495 * Creates a new int64 #GVariant instance.
500 * g_variant_get_int64:
501 * @value: a int64 #GVariant instance
502 * @returns: a #gint64
504 * Returns the 64-bit signed integer value of @value.
506 * It is an error to call this function with a @value of any type
507 * other than %G_VARIANT_TYPE_INT64.
511 NUMERIC_TYPE (INT64, int64, gint64)
514 * g_variant_new_uint64:
515 * @value: a #guint64 value
516 * @returns: (transfer none): a floating reference to a new uint64 #GVariant instance
518 * Creates a new uint64 #GVariant instance.
523 * g_variant_get_uint64:
524 * @value: a uint64 #GVariant instance
525 * @returns: a #guint64
527 * Returns the 64-bit unsigned integer value of @value.
529 * It is an error to call this function with a @value of any type
530 * other than %G_VARIANT_TYPE_UINT64.
534 NUMERIC_TYPE (UINT64, uint64, guint64)
537 * g_variant_new_handle:
538 * @value: a #gint32 value
539 * @returns: (transfer none): a floating reference to a new handle #GVariant instance
541 * Creates a new handle #GVariant instance.
543 * By convention, handles are indexes into an array of file descriptors
544 * that are sent alongside a D-Bus message. If you're not interacting
545 * with D-Bus, you probably don't need them.
550 * g_variant_get_handle:
551 * @value: a handle #GVariant instance
552 * @returns: a #gint32
554 * Returns the 32-bit signed integer value of @value.
556 * It is an error to call this function with a @value of any type other
557 * than %G_VARIANT_TYPE_HANDLE.
559 * By convention, handles are indexes into an array of file descriptors
560 * that are sent alongside a D-Bus message. If you're not interacting
561 * with D-Bus, you probably don't need them.
565 NUMERIC_TYPE (HANDLE, handle, gint32)
568 * g_variant_new_double:
569 * @value: a #gdouble floating point value
570 * @returns: (transfer none): a floating reference to a new double #GVariant instance
572 * Creates a new double #GVariant instance.
577 * g_variant_get_double:
578 * @value: a double #GVariant instance
579 * @returns: a #gdouble
581 * Returns the double precision floating point value of @value.
583 * It is an error to call this function with a @value of any type
584 * other than %G_VARIANT_TYPE_DOUBLE.
588 NUMERIC_TYPE (DOUBLE, double, gdouble)
590 /* Container type Constructor / Deconstructors {{{1 */
592 * g_variant_new_maybe:
593 * @child_type: (allow-none): the #GVariantType of the child, or %NULL
594 * @child: (allow-none): the child value, or %NULL
595 * @returns: (transfer none): a floating reference to a new #GVariant maybe instance
597 * Depending on if @child is %NULL, either wraps @child inside of a
598 * maybe container or creates a Nothing instance for the given @type.
600 * At least one of @child_type and @child must be non-%NULL.
601 * If @child_type is non-%NULL then it must be a definite type.
602 * If they are both non-%NULL then @child_type must be the type
605 * If @child is a floating reference (see g_variant_ref_sink()), the new
606 * instance takes ownership of @child.
611 g_variant_new_maybe (const GVariantType *child_type,
614 GVariantType *maybe_type;
617 g_return_val_if_fail (child_type == NULL || g_variant_type_is_definite
619 g_return_val_if_fail (child_type != NULL || child != NULL, NULL);
620 g_return_val_if_fail (child_type == NULL || child == NULL ||
621 g_variant_is_of_type (child, child_type),
624 if (child_type == NULL)
625 child_type = g_variant_get_type (child);
627 maybe_type = g_variant_type_new_maybe (child_type);
634 children = g_new (GVariant *, 1);
635 children[0] = g_variant_ref_sink (child);
636 trusted = g_variant_is_trusted (children[0]);
638 value = g_variant_new_from_children (maybe_type, children, 1, trusted);
641 value = g_variant_new_from_children (maybe_type, NULL, 0, TRUE);
643 g_variant_type_free (maybe_type);
649 * g_variant_get_maybe:
650 * @value: a maybe-typed value
651 * @returns: (allow-none) (transfer full): the contents of @value, or %NULL
653 * Given a maybe-typed #GVariant instance, extract its value. If the
654 * value is Nothing, then this function returns %NULL.
659 g_variant_get_maybe (GVariant *value)
661 TYPE_CHECK (value, G_VARIANT_TYPE_MAYBE, NULL);
663 if (g_variant_n_children (value))
664 return g_variant_get_child_value (value, 0);
670 * g_variant_new_variant: (constructor)
671 * @value: a #GVariant instance
672 * @returns: (transfer none): a floating reference to a new variant #GVariant instance
674 * Boxes @value. The result is a #GVariant instance representing a
675 * variant containing the original value.
677 * If @child is a floating reference (see g_variant_ref_sink()), the new
678 * instance takes ownership of @child.
683 g_variant_new_variant (GVariant *value)
685 g_return_val_if_fail (value != NULL, NULL);
687 g_variant_ref_sink (value);
689 return g_variant_new_from_children (G_VARIANT_TYPE_VARIANT,
690 g_memdup (&value, sizeof value),
691 1, g_variant_is_trusted (value));
695 * g_variant_get_variant:
696 * @value: a variant #GVariant instance
697 * @returns: (transfer full): the item contained in the variant
699 * Unboxes @value. The result is the #GVariant instance that was
700 * contained in @value.
705 g_variant_get_variant (GVariant *value)
707 TYPE_CHECK (value, G_VARIANT_TYPE_VARIANT, NULL);
709 return g_variant_get_child_value (value, 0);
713 * g_variant_new_array:
714 * @child_type: (allow-none): the element type of the new array
715 * @children: (allow-none) (array length=n_children): an array of
716 * #GVariant pointers, the children
717 * @n_children: the length of @children
718 * @returns: (transfer none): a floating reference to a new #GVariant array
720 * Creates a new #GVariant array from @children.
722 * @child_type must be non-%NULL if @n_children is zero. Otherwise, the
723 * child type is determined by inspecting the first element of the
724 * @children array. If @child_type is non-%NULL then it must be a
727 * The items of the array are taken from the @children array. No entry
728 * in the @children array may be %NULL.
730 * All items in the array must have the same type, which must be the
731 * same as @child_type, if given.
733 * If the @children are floating references (see g_variant_ref_sink()), the
734 * new instance takes ownership of them as if via g_variant_ref_sink().
739 g_variant_new_array (const GVariantType *child_type,
740 GVariant * const *children,
743 GVariantType *array_type;
744 GVariant **my_children;
749 g_return_val_if_fail (n_children > 0 || child_type != NULL, NULL);
750 g_return_val_if_fail (n_children == 0 || children != NULL, NULL);
751 g_return_val_if_fail (child_type == NULL ||
752 g_variant_type_is_definite (child_type), NULL);
754 my_children = g_new (GVariant *, n_children);
757 if (child_type == NULL)
758 child_type = g_variant_get_type (children[0]);
759 array_type = g_variant_type_new_array (child_type);
761 for (i = 0; i < n_children; i++)
763 TYPE_CHECK (children[i], child_type, NULL);
764 my_children[i] = g_variant_ref_sink (children[i]);
765 trusted &= g_variant_is_trusted (children[i]);
768 value = g_variant_new_from_children (array_type, my_children,
769 n_children, trusted);
770 g_variant_type_free (array_type);
776 * g_variant_make_tuple_type:
777 * @children: (array length=n_children): an array of GVariant *
778 * @n_children: the length of @children
780 * Return the type of a tuple containing @children as its items.
782 static GVariantType *
783 g_variant_make_tuple_type (GVariant * const *children,
786 const GVariantType **types;
790 types = g_new (const GVariantType *, n_children);
792 for (i = 0; i < n_children; i++)
793 types[i] = g_variant_get_type (children[i]);
795 type = g_variant_type_new_tuple (types, n_children);
802 * g_variant_new_tuple:
803 * @children: (array length=n_children): the items to make the tuple out of
804 * @n_children: the length of @children
805 * @returns: (transfer none): a floating reference to a new #GVariant tuple
807 * Creates a new tuple #GVariant out of the items in @children. The
808 * type is determined from the types of @children. No entry in the
809 * @children array may be %NULL.
811 * If @n_children is 0 then the unit tuple is constructed.
813 * If the @children are floating references (see g_variant_ref_sink()), the
814 * new instance takes ownership of them as if via g_variant_ref_sink().
819 g_variant_new_tuple (GVariant * const *children,
822 GVariantType *tuple_type;
823 GVariant **my_children;
828 g_return_val_if_fail (n_children == 0 || children != NULL, NULL);
830 my_children = g_new (GVariant *, n_children);
833 for (i = 0; i < n_children; i++)
835 my_children[i] = g_variant_ref_sink (children[i]);
836 trusted &= g_variant_is_trusted (children[i]);
839 tuple_type = g_variant_make_tuple_type (children, n_children);
840 value = g_variant_new_from_children (tuple_type, my_children,
841 n_children, trusted);
842 g_variant_type_free (tuple_type);
848 * g_variant_make_dict_entry_type:
849 * @key: a #GVariant, the key
850 * @val: a #GVariant, the value
852 * Return the type of a dictionary entry containing @key and @val as its
855 static GVariantType *
856 g_variant_make_dict_entry_type (GVariant *key,
859 return g_variant_type_new_dict_entry (g_variant_get_type (key),
860 g_variant_get_type (val));
864 * g_variant_new_dict_entry: (constructor)
865 * @key: a basic #GVariant, the key
866 * @value: a #GVariant, the value
867 * @returns: (transfer none): a floating reference to a new dictionary entry #GVariant
869 * Creates a new dictionary entry #GVariant. @key and @value must be
870 * non-%NULL. @key must be a value of a basic type (ie: not a container).
872 * If the @key or @value are floating references (see g_variant_ref_sink()),
873 * the new instance takes ownership of them as if via g_variant_ref_sink().
878 g_variant_new_dict_entry (GVariant *key,
881 GVariantType *dict_type;
885 g_return_val_if_fail (key != NULL && value != NULL, NULL);
886 g_return_val_if_fail (!g_variant_is_container (key), NULL);
888 children = g_new (GVariant *, 2);
889 children[0] = g_variant_ref_sink (key);
890 children[1] = g_variant_ref_sink (value);
891 trusted = g_variant_is_trusted (key) && g_variant_is_trusted (value);
893 dict_type = g_variant_make_dict_entry_type (key, value);
894 value = g_variant_new_from_children (dict_type, children, 2, trusted);
895 g_variant_type_free (dict_type);
901 * g_variant_lookup: (skip)
902 * @dictionary: a dictionary #GVariant
903 * @key: the key to lookup in the dictionary
904 * @format_string: a GVariant format string
905 * @...: the arguments to unpack the value into
907 * Looks up a value in a dictionary #GVariant.
909 * This function is a wrapper around g_variant_lookup_value() and
910 * g_variant_get(). In the case that %NULL would have been returned,
911 * this function returns %FALSE. Otherwise, it unpacks the returned
912 * value and returns %TRUE.
914 * See g_variant_get() for information about @format_string.
916 * Returns: %TRUE if a value was unpacked
921 g_variant_lookup (GVariant *dictionary,
923 const gchar *format_string,
930 g_variant_get_data (dictionary);
932 type = g_variant_format_string_scan_type (format_string, NULL, NULL);
933 value = g_variant_lookup_value (dictionary, key, type);
934 g_variant_type_free (type);
940 va_start (ap, format_string);
941 g_variant_get_va (value, format_string, NULL, &ap);
942 g_variant_unref (value);
953 * g_variant_lookup_value:
954 * @dictionary: a dictionary #GVariant
955 * @key: the key to lookup in the dictionary
956 * @expected_type: (allow-none): a #GVariantType, or %NULL
958 * Looks up a value in a dictionary #GVariant.
960 * This function works with dictionaries of the type
961 * <literal>a{s*}</literal> (and equally well with type
962 * <literal>a{o*}</literal>, but we only further discuss the string case
963 * for sake of clarity).
965 * In the event that @dictionary has the type <literal>a{sv}</literal>,
966 * the @expected_type string specifies what type of value is expected to
967 * be inside of the variant. If the value inside the variant has a
968 * different type then %NULL is returned. In the event that @dictionary
969 * has a value type other than <literal>v</literal> then @expected_type
970 * must directly match the key type and it is used to unpack the value
971 * directly or an error occurs.
973 * In either case, if @key is not found in @dictionary, %NULL is
976 * If the key is found and the value has the correct type, it is
977 * returned. If @expected_type was specified then any non-%NULL return
978 * value will have this type.
980 * Returns: (transfer full): the value of the dictionary key, or %NULL
985 g_variant_lookup_value (GVariant *dictionary,
987 const GVariantType *expected_type)
993 g_return_val_if_fail (g_variant_is_of_type (dictionary,
994 G_VARIANT_TYPE ("a{s*}")) ||
995 g_variant_is_of_type (dictionary,
996 G_VARIANT_TYPE ("a{o*}")),
999 g_variant_iter_init (&iter, dictionary);
1001 while ((entry = g_variant_iter_next_value (&iter)))
1003 GVariant *entry_key;
1006 entry_key = g_variant_get_child_value (entry, 0);
1007 matches = strcmp (g_variant_get_string (entry_key, NULL), key) == 0;
1008 g_variant_unref (entry_key);
1013 g_variant_unref (entry);
1019 value = g_variant_get_child_value (entry, 1);
1020 g_variant_unref (entry);
1022 if (g_variant_is_of_type (value, G_VARIANT_TYPE_VARIANT))
1026 tmp = g_variant_get_variant (value);
1027 g_variant_unref (value);
1029 if (expected_type && !g_variant_is_of_type (tmp, expected_type))
1031 g_variant_unref (tmp);
1038 g_return_val_if_fail (expected_type == NULL || value == NULL ||
1039 g_variant_is_of_type (value, expected_type), NULL);
1045 * g_variant_get_fixed_array:
1046 * @value: a #GVariant array with fixed-sized elements
1047 * @n_elements: (out): a pointer to the location to store the number of items
1048 * @element_size: the size of each element
1049 * @returns: (array length=n_elements) (transfer none): a pointer to
1052 * Provides access to the serialised data for an array of fixed-sized
1055 * @value must be an array with fixed-sized elements. Numeric types are
1056 * fixed-size as are tuples containing only other fixed-sized types.
1058 * @element_size must be the size of a single element in the array. For
1059 * example, if calling this function for an array of 32 bit integers,
1060 * you might say <code>sizeof (gint32)</code>. This value isn't used
1061 * except for the purpose of a double-check that the form of the
1062 * seralised data matches the caller's expectation.
1064 * @n_elements, which must be non-%NULL is set equal to the number of
1065 * items in the array.
1070 g_variant_get_fixed_array (GVariant *value,
1074 GVariantTypeInfo *array_info;
1075 gsize array_element_size;
1079 TYPE_CHECK (value, G_VARIANT_TYPE_ARRAY, NULL);
1081 g_return_val_if_fail (n_elements != NULL, NULL);
1082 g_return_val_if_fail (element_size > 0, NULL);
1084 array_info = g_variant_get_type_info (value);
1085 g_variant_type_info_query_element (array_info, NULL, &array_element_size);
1087 g_return_val_if_fail (array_element_size, NULL);
1089 if G_UNLIKELY (array_element_size != element_size)
1091 if (array_element_size)
1092 g_critical ("g_variant_get_fixed_array: assertion "
1093 "`g_variant_array_has_fixed_size (value, element_size)' "
1094 "failed: array size %"G_GSIZE_FORMAT" does not match "
1095 "given element_size %"G_GSIZE_FORMAT".",
1096 array_element_size, element_size);
1098 g_critical ("g_variant_get_fixed_array: assertion "
1099 "`g_variant_array_has_fixed_size (value, element_size)' "
1100 "failed: array does not have fixed size.");
1103 data = g_variant_get_data (value);
1104 size = g_variant_get_size (value);
1106 if (size % element_size)
1109 *n_elements = size / element_size;
1118 * g_variant_new_fixed_array:
1119 * @element_type: the #GVariantType of each element
1120 * @elements: a pointer to the fixed array of contiguous elements
1121 * @n_elements: the number of elements
1122 * @element_size: the size of each element
1123 * @returns: (transfer none): a floating reference to a new array #GVariant instance
1125 * Provides access to the serialised data for an array of fixed-sized
1128 * @value must be an array with fixed-sized elements. Numeric types are
1129 * fixed-size as are tuples containing only other fixed-sized types.
1131 * @element_size must be the size of a single element in the array. For
1132 * example, if calling this function for an array of 32 bit integers,
1133 * you might say <code>sizeof (gint32)</code>. This value isn't used
1134 * except for the purpose of a double-check that the form of the
1135 * seralised data matches the caller's expectation.
1137 * @n_elements, which must be non-%NULL is set equal to the number of
1138 * items in the array.
1143 g_variant_new_fixed_array (const GVariantType *element_type,
1144 gconstpointer elements,
1148 GVariantType *array_type;
1149 gsize array_element_size;
1150 GVariantTypeInfo *array_info;
1154 g_return_val_if_fail (g_variant_type_is_definite (element_type), NULL);
1155 g_return_val_if_fail (element_size > 0, NULL);
1157 array_type = g_variant_type_new_array (element_type);
1158 array_info = g_variant_type_info_get (array_type);
1159 g_variant_type_info_query_element (array_info, NULL, &array_element_size);
1160 if G_UNLIKELY (array_element_size != element_size)
1162 if (array_element_size)
1163 g_critical ("g_variant_new_fixed_array: array size %" G_GSIZE_FORMAT
1164 " does not match given element_size %" G_GSIZE_FORMAT ".",
1165 array_element_size, element_size);
1167 g_critical ("g_variant_get_fixed_array: array does not have fixed size.");
1171 data = g_memdup (elements, n_elements * element_size);
1172 value = g_variant_new_from_data (array_type, data,
1173 n_elements * element_size,
1174 FALSE, g_free, data);
1176 g_variant_type_free (array_type);
1177 g_variant_type_info_unref (array_info);
1182 /* String type constructor/getters/validation {{{1 */
1184 * g_variant_new_string:
1185 * @string: a normal utf8 nul-terminated string
1186 * @returns: (transfer none): a floating reference to a new string #GVariant instance
1188 * Creates a string #GVariant with the contents of @string.
1190 * @string must be valid utf8.
1195 g_variant_new_string (const gchar *string)
1197 g_return_val_if_fail (string != NULL, NULL);
1198 g_return_val_if_fail (g_utf8_validate (string, -1, NULL), NULL);
1200 return g_variant_new_from_trusted (G_VARIANT_TYPE_STRING,
1201 string, strlen (string) + 1);
1205 * g_variant_new_object_path:
1206 * @object_path: a normal C nul-terminated string
1207 * @returns: (transfer none): a floating reference to a new object path #GVariant instance
1209 * Creates a D-Bus object path #GVariant with the contents of @string.
1210 * @string must be a valid D-Bus object path. Use
1211 * g_variant_is_object_path() if you're not sure.
1216 g_variant_new_object_path (const gchar *object_path)
1218 g_return_val_if_fail (g_variant_is_object_path (object_path), NULL);
1220 return g_variant_new_from_trusted (G_VARIANT_TYPE_OBJECT_PATH,
1221 object_path, strlen (object_path) + 1);
1225 * g_variant_is_object_path:
1226 * @string: a normal C nul-terminated string
1227 * @returns: %TRUE if @string is a D-Bus object path
1229 * Determines if a given string is a valid D-Bus object path. You
1230 * should ensure that a string is a valid D-Bus object path before
1231 * passing it to g_variant_new_object_path().
1233 * A valid object path starts with '/' followed by zero or more
1234 * sequences of characters separated by '/' characters. Each sequence
1235 * must contain only the characters "[A-Z][a-z][0-9]_". No sequence
1236 * (including the one following the final '/' character) may be empty.
1241 g_variant_is_object_path (const gchar *string)
1243 g_return_val_if_fail (string != NULL, FALSE);
1245 return g_variant_serialiser_is_object_path (string, strlen (string) + 1);
1249 * g_variant_new_signature:
1250 * @signature: a normal C nul-terminated string
1251 * @returns: (transfer none): a floating reference to a new signature #GVariant instance
1253 * Creates a D-Bus type signature #GVariant with the contents of
1254 * @string. @string must be a valid D-Bus type signature. Use
1255 * g_variant_is_signature() if you're not sure.
1260 g_variant_new_signature (const gchar *signature)
1262 g_return_val_if_fail (g_variant_is_signature (signature), NULL);
1264 return g_variant_new_from_trusted (G_VARIANT_TYPE_SIGNATURE,
1265 signature, strlen (signature) + 1);
1269 * g_variant_is_signature:
1270 * @string: a normal C nul-terminated string
1271 * @returns: %TRUE if @string is a D-Bus type signature
1273 * Determines if a given string is a valid D-Bus type signature. You
1274 * should ensure that a string is a valid D-Bus type signature before
1275 * passing it to g_variant_new_signature().
1277 * D-Bus type signatures consist of zero or more definite #GVariantType
1278 * strings in sequence.
1283 g_variant_is_signature (const gchar *string)
1285 g_return_val_if_fail (string != NULL, FALSE);
1287 return g_variant_serialiser_is_signature (string, strlen (string) + 1);
1291 * g_variant_get_string:
1292 * @value: a string #GVariant instance
1293 * @length: (allow-none) (default 0) (out): a pointer to a #gsize,
1294 * to store the length
1295 * @returns: (transfer none): the constant string, utf8 encoded
1297 * Returns the string value of a #GVariant instance with a string
1298 * type. This includes the types %G_VARIANT_TYPE_STRING,
1299 * %G_VARIANT_TYPE_OBJECT_PATH and %G_VARIANT_TYPE_SIGNATURE.
1301 * The string will always be utf8 encoded.
1303 * If @length is non-%NULL then the length of the string (in bytes) is
1304 * returned there. For trusted values, this information is already
1305 * known. For untrusted values, a strlen() will be performed.
1307 * It is an error to call this function with a @value of any type
1308 * other than those three.
1310 * The return value remains valid as long as @value exists.
1315 g_variant_get_string (GVariant *value,
1321 g_return_val_if_fail (value != NULL, NULL);
1322 g_return_val_if_fail (
1323 g_variant_is_of_type (value, G_VARIANT_TYPE_STRING) ||
1324 g_variant_is_of_type (value, G_VARIANT_TYPE_OBJECT_PATH) ||
1325 g_variant_is_of_type (value, G_VARIANT_TYPE_SIGNATURE), NULL);
1327 data = g_variant_get_data (value);
1328 size = g_variant_get_size (value);
1330 if (!g_variant_is_trusted (value))
1332 switch (g_variant_classify (value))
1334 case G_VARIANT_CLASS_STRING:
1335 if (g_variant_serialiser_is_string (data, size))
1342 case G_VARIANT_CLASS_OBJECT_PATH:
1343 if (g_variant_serialiser_is_object_path (data, size))
1350 case G_VARIANT_CLASS_SIGNATURE:
1351 if (g_variant_serialiser_is_signature (data, size))
1359 g_assert_not_reached ();
1370 * g_variant_dup_string:
1371 * @value: a string #GVariant instance
1372 * @length: (out): a pointer to a #gsize, to store the length
1373 * @returns: (transfer full): a newly allocated string, utf8 encoded
1375 * Similar to g_variant_get_string() except that instead of returning
1376 * a constant string, the string is duplicated.
1378 * The string will always be utf8 encoded.
1380 * The return value must be freed using g_free().
1385 g_variant_dup_string (GVariant *value,
1388 return g_strdup (g_variant_get_string (value, length));
1392 * g_variant_new_strv:
1393 * @strv: (array length=length) (element-type utf8): an array of strings
1394 * @length: the length of @strv, or -1
1395 * @returns: (transfer none): a new floating #GVariant instance
1397 * Constructs an array of strings #GVariant from the given array of
1400 * If @length is -1 then @strv is %NULL-terminated.
1405 g_variant_new_strv (const gchar * const *strv,
1411 g_return_val_if_fail (length == 0 || strv != NULL, NULL);
1414 length = g_strv_length ((gchar **) strv);
1416 strings = g_new (GVariant *, length);
1417 for (i = 0; i < length; i++)
1418 strings[i] = g_variant_ref_sink (g_variant_new_string (strv[i]));
1420 return g_variant_new_from_children (G_VARIANT_TYPE_STRING_ARRAY,
1421 strings, length, TRUE);
1425 * g_variant_get_strv:
1426 * @value: an array of strings #GVariant
1427 * @length: (out) (allow-none): the length of the result, or %NULL
1428 * @returns: (array length=length zero-terminated=1) (transfer container): an array of constant
1431 * Gets the contents of an array of strings #GVariant. This call
1432 * makes a shallow copy; the return result should be released with
1433 * g_free(), but the individual strings must not be modified.
1435 * If @length is non-%NULL then the number of elements in the result
1436 * is stored there. In any case, the resulting array will be
1439 * For an empty array, @length will be set to 0 and a pointer to a
1440 * %NULL pointer will be returned.
1445 g_variant_get_strv (GVariant *value,
1452 TYPE_CHECK (value, G_VARIANT_TYPE_STRING_ARRAY, NULL);
1454 g_variant_get_data (value);
1455 n = g_variant_n_children (value);
1456 strv = g_new (const gchar *, n + 1);
1458 for (i = 0; i < n; i++)
1462 string = g_variant_get_child_value (value, i);
1463 strv[i] = g_variant_get_string (string, NULL);
1464 g_variant_unref (string);
1475 * g_variant_dup_strv:
1476 * @value: an array of strings #GVariant
1477 * @length: (out) (allow-none): the length of the result, or %NULL
1478 * @returns: (array length=length zero-terminated=1) (transfer full): an array of strings
1480 * Gets the contents of an array of strings #GVariant. This call
1481 * makes a deep copy; the return result should be released with
1484 * If @length is non-%NULL then the number of elements in the result
1485 * is stored there. In any case, the resulting array will be
1488 * For an empty array, @length will be set to 0 and a pointer to a
1489 * %NULL pointer will be returned.
1494 g_variant_dup_strv (GVariant *value,
1501 TYPE_CHECK (value, G_VARIANT_TYPE_STRING_ARRAY, NULL);
1503 n = g_variant_n_children (value);
1504 strv = g_new (gchar *, n + 1);
1506 for (i = 0; i < n; i++)
1510 string = g_variant_get_child_value (value, i);
1511 strv[i] = g_variant_dup_string (string, NULL);
1512 g_variant_unref (string);
1523 * g_variant_new_objv:
1524 * @strv: (array length=length) (element-type utf8): an array of strings
1525 * @length: the length of @strv, or -1
1526 * @returns: (transfer none): a new floating #GVariant instance
1528 * Constructs an array of object paths #GVariant from the given array of
1531 * Each string must be a valid #GVariant object path; see
1532 * g_variant_is_object_path().
1534 * If @length is -1 then @strv is %NULL-terminated.
1539 g_variant_new_objv (const gchar * const *strv,
1545 g_return_val_if_fail (length == 0 || strv != NULL, NULL);
1548 length = g_strv_length ((gchar **) strv);
1550 strings = g_new (GVariant *, length);
1551 for (i = 0; i < length; i++)
1552 strings[i] = g_variant_ref_sink (g_variant_new_object_path (strv[i]));
1554 return g_variant_new_from_children (G_VARIANT_TYPE_OBJECT_PATH_ARRAY,
1555 strings, length, TRUE);
1559 * g_variant_get_objv:
1560 * @value: an array of object paths #GVariant
1561 * @length: (out) (allow-none): the length of the result, or %NULL
1562 * @returns: (array length=length zero-terminated=1) (transfer container): an array of constant
1565 * Gets the contents of an array of object paths #GVariant. This call
1566 * makes a shallow copy; the return result should be released with
1567 * g_free(), but the individual strings must not be modified.
1569 * If @length is non-%NULL then the number of elements in the result
1570 * is stored there. In any case, the resulting array will be
1573 * For an empty array, @length will be set to 0 and a pointer to a
1574 * %NULL pointer will be returned.
1579 g_variant_get_objv (GVariant *value,
1586 TYPE_CHECK (value, G_VARIANT_TYPE_OBJECT_PATH_ARRAY, NULL);
1588 g_variant_get_data (value);
1589 n = g_variant_n_children (value);
1590 strv = g_new (const gchar *, n + 1);
1592 for (i = 0; i < n; i++)
1596 string = g_variant_get_child_value (value, i);
1597 strv[i] = g_variant_get_string (string, NULL);
1598 g_variant_unref (string);
1609 * g_variant_dup_objv:
1610 * @value: an array of object paths #GVariant
1611 * @length: (out) (allow-none): the length of the result, or %NULL
1612 * @returns: (array length=length zero-terminated=1) (transfer full): an array of strings
1614 * Gets the contents of an array of object paths #GVariant. This call
1615 * makes a deep copy; the return result should be released with
1618 * If @length is non-%NULL then the number of elements in the result
1619 * is stored there. In any case, the resulting array will be
1622 * For an empty array, @length will be set to 0 and a pointer to a
1623 * %NULL pointer will be returned.
1628 g_variant_dup_objv (GVariant *value,
1635 TYPE_CHECK (value, G_VARIANT_TYPE_OBJECT_PATH_ARRAY, NULL);
1637 n = g_variant_n_children (value);
1638 strv = g_new (gchar *, n + 1);
1640 for (i = 0; i < n; i++)
1644 string = g_variant_get_child_value (value, i);
1645 strv[i] = g_variant_dup_string (string, NULL);
1646 g_variant_unref (string);
1658 * g_variant_new_bytestring:
1659 * @string: (array zero-terminated=1) (element-type guint8): a normal
1660 * nul-terminated string in no particular encoding
1661 * @returns: (transfer none): a floating reference to a new bytestring #GVariant instance
1663 * Creates an array-of-bytes #GVariant with the contents of @string.
1664 * This function is just like g_variant_new_string() except that the
1665 * string need not be valid utf8.
1667 * The nul terminator character at the end of the string is stored in
1673 g_variant_new_bytestring (const gchar *string)
1675 g_return_val_if_fail (string != NULL, NULL);
1677 return g_variant_new_from_trusted (G_VARIANT_TYPE_BYTESTRING,
1678 string, strlen (string) + 1);
1682 * g_variant_get_bytestring:
1683 * @value: an array-of-bytes #GVariant instance
1684 * @returns: (transfer none) (array zero-terminated=1) (element-type guint8):
1685 * the constant string
1687 * Returns the string value of a #GVariant instance with an
1688 * array-of-bytes type. The string has no particular encoding.
1690 * If the array does not end with a nul terminator character, the empty
1691 * string is returned. For this reason, you can always trust that a
1692 * non-%NULL nul-terminated string will be returned by this function.
1694 * If the array contains a nul terminator character somewhere other than
1695 * the last byte then the returned string is the string, up to the first
1696 * such nul character.
1698 * It is an error to call this function with a @value that is not an
1701 * The return value remains valid as long as @value exists.
1706 g_variant_get_bytestring (GVariant *value)
1708 const gchar *string;
1711 TYPE_CHECK (value, G_VARIANT_TYPE_BYTESTRING, NULL);
1713 /* Won't be NULL since this is an array type */
1714 string = g_variant_get_data (value);
1715 size = g_variant_get_size (value);
1717 if (size && string[size - 1] == '\0')
1724 * g_variant_dup_bytestring:
1725 * @value: an array-of-bytes #GVariant instance
1726 * @length: (out) (allow-none) (default NULL): a pointer to a #gsize, to store
1727 * the length (not including the nul terminator)
1728 * @returns: (transfer full) (array zero-terminated=1 length=length)
1729 * (element-type guint8): a newly allocated string
1731 * Similar to g_variant_get_bytestring() except that instead of
1732 * returning a constant string, the string is duplicated.
1734 * The return value must be freed using g_free().
1739 g_variant_dup_bytestring (GVariant *value,
1742 const gchar *original = g_variant_get_bytestring (value);
1745 /* don't crash in case get_bytestring() had an assert failure */
1746 if (original == NULL)
1749 size = strlen (original);
1754 return g_memdup (original, size + 1);
1758 * g_variant_new_bytestring_array:
1759 * @strv: (array length=length): an array of strings
1760 * @length: the length of @strv, or -1
1761 * @returns: (transfer none): a new floating #GVariant instance
1763 * Constructs an array of bytestring #GVariant from the given array of
1766 * If @length is -1 then @strv is %NULL-terminated.
1771 g_variant_new_bytestring_array (const gchar * const *strv,
1777 g_return_val_if_fail (length == 0 || strv != NULL, NULL);
1780 length = g_strv_length ((gchar **) strv);
1782 strings = g_new (GVariant *, length);
1783 for (i = 0; i < length; i++)
1784 strings[i] = g_variant_ref_sink (g_variant_new_bytestring (strv[i]));
1786 return g_variant_new_from_children (G_VARIANT_TYPE_BYTESTRING_ARRAY,
1787 strings, length, TRUE);
1791 * g_variant_get_bytestring_array:
1792 * @value: an array of array of bytes #GVariant ('aay')
1793 * @length: (out) (allow-none): the length of the result, or %NULL
1794 * @returns: (array length=length) (transfer container): an array of constant strings
1796 * Gets the contents of an array of array of bytes #GVariant. This call
1797 * makes a shallow copy; the return result should be released with
1798 * g_free(), but the individual strings must not be modified.
1800 * If @length is non-%NULL then the number of elements in the result is
1801 * stored there. In any case, the resulting array will be
1804 * For an empty array, @length will be set to 0 and a pointer to a
1805 * %NULL pointer will be returned.
1810 g_variant_get_bytestring_array (GVariant *value,
1817 TYPE_CHECK (value, G_VARIANT_TYPE_BYTESTRING_ARRAY, NULL);
1819 g_variant_get_data (value);
1820 n = g_variant_n_children (value);
1821 strv = g_new (const gchar *, n + 1);
1823 for (i = 0; i < n; i++)
1827 string = g_variant_get_child_value (value, i);
1828 strv[i] = g_variant_get_bytestring (string);
1829 g_variant_unref (string);
1840 * g_variant_dup_bytestring_array:
1841 * @value: an array of array of bytes #GVariant ('aay')
1842 * @length: (out) (allow-none): the length of the result, or %NULL
1843 * @returns: (array length=length) (transfer full): an array of strings
1845 * Gets the contents of an array of array of bytes #GVariant. This call
1846 * makes a deep copy; the return result should be released with
1849 * If @length is non-%NULL then the number of elements in the result is
1850 * stored there. In any case, the resulting array will be
1853 * For an empty array, @length will be set to 0 and a pointer to a
1854 * %NULL pointer will be returned.
1859 g_variant_dup_bytestring_array (GVariant *value,
1866 TYPE_CHECK (value, G_VARIANT_TYPE_BYTESTRING_ARRAY, NULL);
1868 g_variant_get_data (value);
1869 n = g_variant_n_children (value);
1870 strv = g_new (gchar *, n + 1);
1872 for (i = 0; i < n; i++)
1876 string = g_variant_get_child_value (value, i);
1877 strv[i] = g_variant_dup_bytestring (string, NULL);
1878 g_variant_unref (string);
1888 /* Type checking and querying {{{1 */
1890 * g_variant_get_type:
1891 * @value: a #GVariant
1892 * @returns: a #GVariantType
1894 * Determines the type of @value.
1896 * The return value is valid for the lifetime of @value and must not
1901 const GVariantType *
1902 g_variant_get_type (GVariant *value)
1904 GVariantTypeInfo *type_info;
1906 g_return_val_if_fail (value != NULL, NULL);
1908 type_info = g_variant_get_type_info (value);
1910 return (GVariantType *) g_variant_type_info_get_type_string (type_info);
1914 * g_variant_get_type_string:
1915 * @value: a #GVariant
1916 * @returns: the type string for the type of @value
1918 * Returns the type string of @value. Unlike the result of calling
1919 * g_variant_type_peek_string(), this string is nul-terminated. This
1920 * string belongs to #GVariant and must not be freed.
1925 g_variant_get_type_string (GVariant *value)
1927 GVariantTypeInfo *type_info;
1929 g_return_val_if_fail (value != NULL, NULL);
1931 type_info = g_variant_get_type_info (value);
1933 return g_variant_type_info_get_type_string (type_info);
1937 * g_variant_is_of_type:
1938 * @value: a #GVariant instance
1939 * @type: a #GVariantType
1940 * @returns: %TRUE if the type of @value matches @type
1942 * Checks if a value has a type matching the provided type.
1947 g_variant_is_of_type (GVariant *value,
1948 const GVariantType *type)
1950 return g_variant_type_is_subtype_of (g_variant_get_type (value), type);
1954 * g_variant_is_container:
1955 * @value: a #GVariant instance
1956 * @returns: %TRUE if @value is a container
1958 * Checks if @value is a container.
1961 g_variant_is_container (GVariant *value)
1963 return g_variant_type_is_container (g_variant_get_type (value));
1968 * g_variant_classify:
1969 * @value: a #GVariant
1970 * @returns: the #GVariantClass of @value
1972 * Classifies @value according to its top-level type.
1978 * @G_VARIANT_CLASS_BOOLEAN: The #GVariant is a boolean.
1979 * @G_VARIANT_CLASS_BYTE: The #GVariant is a byte.
1980 * @G_VARIANT_CLASS_INT16: The #GVariant is a signed 16 bit integer.
1981 * @G_VARIANT_CLASS_UINT16: The #GVariant is an unsigned 16 bit integer.
1982 * @G_VARIANT_CLASS_INT32: The #GVariant is a signed 32 bit integer.
1983 * @G_VARIANT_CLASS_UINT32: The #GVariant is an unsigned 32 bit integer.
1984 * @G_VARIANT_CLASS_INT64: The #GVariant is a signed 64 bit integer.
1985 * @G_VARIANT_CLASS_UINT64: The #GVariant is an unsigned 64 bit integer.
1986 * @G_VARIANT_CLASS_HANDLE: The #GVariant is a file handle index.
1987 * @G_VARIANT_CLASS_DOUBLE: The #GVariant is a double precision floating
1989 * @G_VARIANT_CLASS_STRING: The #GVariant is a normal string.
1990 * @G_VARIANT_CLASS_OBJECT_PATH: The #GVariant is a D-Bus object path
1992 * @G_VARIANT_CLASS_SIGNATURE: The #GVariant is a D-Bus signature string.
1993 * @G_VARIANT_CLASS_VARIANT: The #GVariant is a variant.
1994 * @G_VARIANT_CLASS_MAYBE: The #GVariant is a maybe-typed value.
1995 * @G_VARIANT_CLASS_ARRAY: The #GVariant is an array.
1996 * @G_VARIANT_CLASS_TUPLE: The #GVariant is a tuple.
1997 * @G_VARIANT_CLASS_DICT_ENTRY: The #GVariant is a dictionary entry.
1999 * The range of possible top-level types of #GVariant instances.
2004 g_variant_classify (GVariant *value)
2006 g_return_val_if_fail (value != NULL, 0);
2008 return *g_variant_get_type_string (value);
2011 /* Pretty printer {{{1 */
2012 /* This function is not introspectable because if @string is NULL,
2013 @returns is (transfer full), otherwise it is (transfer none), which
2014 is not supported by GObjectIntrospection */
2016 * g_variant_print_string: (skip)
2017 * @value: a #GVariant
2018 * @string: (allow-none) (default NULL): a #GString, or %NULL
2019 * @type_annotate: %TRUE if type information should be included in
2021 * @returns: a #GString containing the string
2023 * Behaves as g_variant_print(), but operates on a #GString.
2025 * If @string is non-%NULL then it is appended to and returned. Else,
2026 * a new empty #GString is allocated and it is returned.
2031 g_variant_print_string (GVariant *value,
2033 gboolean type_annotate)
2035 if G_UNLIKELY (string == NULL)
2036 string = g_string_new (NULL);
2038 switch (g_variant_classify (value))
2040 case G_VARIANT_CLASS_MAYBE:
2042 g_string_append_printf (string, "@%s ",
2043 g_variant_get_type_string (value));
2045 if (g_variant_n_children (value))
2047 gchar *printed_child;
2052 * Consider the case of the type "mmi". In this case we could
2053 * write "just just 4", but "4" alone is totally unambiguous,
2054 * so we try to drop "just" where possible.
2056 * We have to be careful not to always drop "just", though,
2057 * since "nothing" needs to be distinguishable from "just
2058 * nothing". The case where we need to ensure we keep the
2059 * "just" is actually exactly the case where we have a nested
2062 * Instead of searching for that nested Nothing, we just print
2063 * the contained value into a separate string and see if we
2064 * end up with "nothing" at the end of it. If so, we need to
2065 * add "just" at our level.
2067 element = g_variant_get_child_value (value, 0);
2068 printed_child = g_variant_print (element, FALSE);
2069 g_variant_unref (element);
2071 if (g_str_has_suffix (printed_child, "nothing"))
2072 g_string_append (string, "just ");
2073 g_string_append (string, printed_child);
2074 g_free (printed_child);
2077 g_string_append (string, "nothing");
2081 case G_VARIANT_CLASS_ARRAY:
2082 /* it's an array so the first character of the type string is 'a'
2084 * if the first two characters are 'ay' then it's a bytestring.
2085 * under certain conditions we print those as strings.
2087 if (g_variant_get_type_string (value)[1] == 'y')
2093 /* first determine if it is a byte string.
2094 * that's when there's a single nul character: at the end.
2096 str = g_variant_get_data (value);
2097 size = g_variant_get_size (value);
2099 for (i = 0; i < size; i++)
2103 /* first nul byte is the last byte -> it's a byte string. */
2106 gchar *escaped = g_strescape (str, NULL);
2108 /* use double quotes only if a ' is in the string */
2109 if (strchr (str, '\''))
2110 g_string_append_printf (string, "b\"%s\"", escaped);
2112 g_string_append_printf (string, "b'%s'", escaped);
2119 /* fall through and handle normally... */;
2123 * if the first two characters are 'a{' then it's an array of
2124 * dictionary entries (ie: a dictionary) so we print that
2127 if (g_variant_get_type_string (value)[1] == '{')
2130 const gchar *comma = "";
2133 if ((n = g_variant_n_children (value)) == 0)
2136 g_string_append_printf (string, "@%s ",
2137 g_variant_get_type_string (value));
2138 g_string_append (string, "{}");
2142 g_string_append_c (string, '{');
2143 for (i = 0; i < n; i++)
2145 GVariant *entry, *key, *val;
2147 g_string_append (string, comma);
2150 entry = g_variant_get_child_value (value, i);
2151 key = g_variant_get_child_value (entry, 0);
2152 val = g_variant_get_child_value (entry, 1);
2153 g_variant_unref (entry);
2155 g_variant_print_string (key, string, type_annotate);
2156 g_variant_unref (key);
2157 g_string_append (string, ": ");
2158 g_variant_print_string (val, string, type_annotate);
2159 g_variant_unref (val);
2160 type_annotate = FALSE;
2162 g_string_append_c (string, '}');
2165 /* normal (non-dictionary) array */
2167 const gchar *comma = "";
2170 if ((n = g_variant_n_children (value)) == 0)
2173 g_string_append_printf (string, "@%s ",
2174 g_variant_get_type_string (value));
2175 g_string_append (string, "[]");
2179 g_string_append_c (string, '[');
2180 for (i = 0; i < n; i++)
2184 g_string_append (string, comma);
2187 element = g_variant_get_child_value (value, i);
2189 g_variant_print_string (element, string, type_annotate);
2190 g_variant_unref (element);
2191 type_annotate = FALSE;
2193 g_string_append_c (string, ']');
2198 case G_VARIANT_CLASS_TUPLE:
2202 n = g_variant_n_children (value);
2204 g_string_append_c (string, '(');
2205 for (i = 0; i < n; i++)
2209 element = g_variant_get_child_value (value, i);
2210 g_variant_print_string (element, string, type_annotate);
2211 g_string_append (string, ", ");
2212 g_variant_unref (element);
2215 /* for >1 item: remove final ", "
2216 * for 1 item: remove final " ", but leave the ","
2217 * for 0 items: there is only "(", so remove nothing
2219 g_string_truncate (string, string->len - (n > 0) - (n > 1));
2220 g_string_append_c (string, ')');
2224 case G_VARIANT_CLASS_DICT_ENTRY:
2228 g_string_append_c (string, '{');
2230 element = g_variant_get_child_value (value, 0);
2231 g_variant_print_string (element, string, type_annotate);
2232 g_variant_unref (element);
2234 g_string_append (string, ", ");
2236 element = g_variant_get_child_value (value, 1);
2237 g_variant_print_string (element, string, type_annotate);
2238 g_variant_unref (element);
2240 g_string_append_c (string, '}');
2244 case G_VARIANT_CLASS_VARIANT:
2246 GVariant *child = g_variant_get_variant (value);
2248 /* Always annotate types in nested variants, because they are
2249 * (by nature) of variable type.
2251 g_string_append_c (string, '<');
2252 g_variant_print_string (child, string, TRUE);
2253 g_string_append_c (string, '>');
2255 g_variant_unref (child);
2259 case G_VARIANT_CLASS_BOOLEAN:
2260 if (g_variant_get_boolean (value))
2261 g_string_append (string, "true");
2263 g_string_append (string, "false");
2266 case G_VARIANT_CLASS_STRING:
2268 const gchar *str = g_variant_get_string (value, NULL);
2269 gunichar quote = strchr (str, '\'') ? '"' : '\'';
2271 g_string_append_c (string, quote);
2275 gunichar c = g_utf8_get_char (str);
2277 if (c == quote || c == '\\')
2278 g_string_append_c (string, '\\');
2280 if (g_unichar_isprint (c))
2281 g_string_append_unichar (string, c);
2285 g_string_append_c (string, '\\');
2290 g_string_append_c (string, 'a');
2294 g_string_append_c (string, 'b');
2298 g_string_append_c (string, 'f');
2302 g_string_append_c (string, 'n');
2306 g_string_append_c (string, 'r');
2310 g_string_append_c (string, 't');
2314 g_string_append_c (string, 'v');
2318 g_string_append_printf (string, "u%04x", c);
2322 g_string_append_printf (string, "U%08x", c);
2325 str = g_utf8_next_char (str);
2328 g_string_append_c (string, quote);
2332 case G_VARIANT_CLASS_BYTE:
2334 g_string_append (string, "byte ");
2335 g_string_append_printf (string, "0x%02x",
2336 g_variant_get_byte (value));
2339 case G_VARIANT_CLASS_INT16:
2341 g_string_append (string, "int16 ");
2342 g_string_append_printf (string, "%"G_GINT16_FORMAT,
2343 g_variant_get_int16 (value));
2346 case G_VARIANT_CLASS_UINT16:
2348 g_string_append (string, "uint16 ");
2349 g_string_append_printf (string, "%"G_GUINT16_FORMAT,
2350 g_variant_get_uint16 (value));
2353 case G_VARIANT_CLASS_INT32:
2354 /* Never annotate this type because it is the default for numbers
2355 * (and this is a *pretty* printer)
2357 g_string_append_printf (string, "%"G_GINT32_FORMAT,
2358 g_variant_get_int32 (value));
2361 case G_VARIANT_CLASS_HANDLE:
2363 g_string_append (string, "handle ");
2364 g_string_append_printf (string, "%"G_GINT32_FORMAT,
2365 g_variant_get_handle (value));
2368 case G_VARIANT_CLASS_UINT32:
2370 g_string_append (string, "uint32 ");
2371 g_string_append_printf (string, "%"G_GUINT32_FORMAT,
2372 g_variant_get_uint32 (value));
2375 case G_VARIANT_CLASS_INT64:
2377 g_string_append (string, "int64 ");
2378 g_string_append_printf (string, "%"G_GINT64_FORMAT,
2379 g_variant_get_int64 (value));
2382 case G_VARIANT_CLASS_UINT64:
2384 g_string_append (string, "uint64 ");
2385 g_string_append_printf (string, "%"G_GUINT64_FORMAT,
2386 g_variant_get_uint64 (value));
2389 case G_VARIANT_CLASS_DOUBLE:
2394 g_ascii_dtostr (buffer, sizeof buffer, g_variant_get_double (value));
2396 for (i = 0; buffer[i]; i++)
2397 if (buffer[i] == '.' || buffer[i] == 'e' ||
2398 buffer[i] == 'n' || buffer[i] == 'N')
2401 /* if there is no '.' or 'e' in the float then add one */
2402 if (buffer[i] == '\0')
2409 g_string_append (string, buffer);
2413 case G_VARIANT_CLASS_OBJECT_PATH:
2415 g_string_append (string, "objectpath ");
2416 g_string_append_printf (string, "\'%s\'",
2417 g_variant_get_string (value, NULL));
2420 case G_VARIANT_CLASS_SIGNATURE:
2422 g_string_append (string, "signature ");
2423 g_string_append_printf (string, "\'%s\'",
2424 g_variant_get_string (value, NULL));
2428 g_assert_not_reached ();
2436 * @value: a #GVariant
2437 * @type_annotate: %TRUE if type information should be included in
2439 * @returns: (transfer full): a newly-allocated string holding the result.
2441 * Pretty-prints @value in the format understood by g_variant_parse().
2443 * The format is described <link linkend='gvariant-text'>here</link>.
2445 * If @type_annotate is %TRUE, then type information is included in
2449 g_variant_print (GVariant *value,
2450 gboolean type_annotate)
2452 return g_string_free (g_variant_print_string (value, NULL, type_annotate),
2456 /* Hash, Equal, Compare {{{1 */
2459 * @value: (type GVariant): a basic #GVariant value as a #gconstpointer
2460 * @returns: a hash value corresponding to @value
2462 * Generates a hash value for a #GVariant instance.
2464 * The output of this function is guaranteed to be the same for a given
2465 * value only per-process. It may change between different processor
2466 * architectures or even different versions of GLib. Do not use this
2467 * function as a basis for building protocols or file formats.
2469 * The type of @value is #gconstpointer only to allow use of this
2470 * function with #GHashTable. @value must be a #GVariant.
2475 g_variant_hash (gconstpointer value_)
2477 GVariant *value = (GVariant *) value_;
2479 switch (g_variant_classify (value))
2481 case G_VARIANT_CLASS_STRING:
2482 case G_VARIANT_CLASS_OBJECT_PATH:
2483 case G_VARIANT_CLASS_SIGNATURE:
2484 return g_str_hash (g_variant_get_string (value, NULL));
2486 case G_VARIANT_CLASS_BOOLEAN:
2487 /* this is a very odd thing to hash... */
2488 return g_variant_get_boolean (value);
2490 case G_VARIANT_CLASS_BYTE:
2491 return g_variant_get_byte (value);
2493 case G_VARIANT_CLASS_INT16:
2494 case G_VARIANT_CLASS_UINT16:
2498 ptr = g_variant_get_data (value);
2506 case G_VARIANT_CLASS_INT32:
2507 case G_VARIANT_CLASS_UINT32:
2508 case G_VARIANT_CLASS_HANDLE:
2512 ptr = g_variant_get_data (value);
2520 case G_VARIANT_CLASS_INT64:
2521 case G_VARIANT_CLASS_UINT64:
2522 case G_VARIANT_CLASS_DOUBLE:
2523 /* need a separate case for these guys because otherwise
2524 * performance could be quite bad on big endian systems
2529 ptr = g_variant_get_data (value);
2532 return ptr[0] + ptr[1];
2538 g_return_val_if_fail (!g_variant_is_container (value), 0);
2539 g_assert_not_reached ();
2545 * @one: (type GVariant): a #GVariant instance
2546 * @two: (type GVariant): a #GVariant instance
2547 * @returns: %TRUE if @one and @two are equal
2549 * Checks if @one and @two have the same type and value.
2551 * The types of @one and @two are #gconstpointer only to allow use of
2552 * this function with #GHashTable. They must each be a #GVariant.
2557 g_variant_equal (gconstpointer one,
2562 g_return_val_if_fail (one != NULL && two != NULL, FALSE);
2564 if (g_variant_get_type_info ((GVariant *) one) !=
2565 g_variant_get_type_info ((GVariant *) two))
2568 /* if both values are trusted to be in their canonical serialised form
2569 * then a simple memcmp() of their serialised data will answer the
2572 * if not, then this might generate a false negative (since it is
2573 * possible for two different byte sequences to represent the same
2574 * value). for now we solve this by pretty-printing both values and
2575 * comparing the result.
2577 if (g_variant_is_trusted ((GVariant *) one) &&
2578 g_variant_is_trusted ((GVariant *) two))
2580 gconstpointer data_one, data_two;
2581 gsize size_one, size_two;
2583 size_one = g_variant_get_size ((GVariant *) one);
2584 size_two = g_variant_get_size ((GVariant *) two);
2586 if (size_one != size_two)
2589 data_one = g_variant_get_data ((GVariant *) one);
2590 data_two = g_variant_get_data ((GVariant *) two);
2592 equal = memcmp (data_one, data_two, size_one) == 0;
2596 gchar *strone, *strtwo;
2598 strone = g_variant_print ((GVariant *) one, FALSE);
2599 strtwo = g_variant_print ((GVariant *) two, FALSE);
2600 equal = strcmp (strone, strtwo) == 0;
2609 * g_variant_compare:
2610 * @one: (type GVariant): a basic-typed #GVariant instance
2611 * @two: (type GVariant): a #GVariant instance of the same type
2612 * @returns: negative value if a < b;
2614 * positive value if a > b.
2616 * Compares @one and @two.
2618 * The types of @one and @two are #gconstpointer only to allow use of
2619 * this function with #GTree, #GPtrArray, etc. They must each be a
2622 * Comparison is only defined for basic types (ie: booleans, numbers,
2623 * strings). For booleans, %FALSE is less than %TRUE. Numbers are
2624 * ordered in the usual way. Strings are in ASCII lexographical order.
2626 * It is a programmer error to attempt to compare container values or
2627 * two values that have types that are not exactly equal. For example,
2628 * you cannot compare a 32-bit signed integer with a 32-bit unsigned
2629 * integer. Also note that this function is not particularly
2630 * well-behaved when it comes to comparison of doubles; in particular,
2631 * the handling of incomparable values (ie: NaN) is undefined.
2633 * If you only require an equality comparison, g_variant_equal() is more
2639 g_variant_compare (gconstpointer one,
2642 GVariant *a = (GVariant *) one;
2643 GVariant *b = (GVariant *) two;
2645 g_return_val_if_fail (g_variant_classify (a) == g_variant_classify (b), 0);
2647 switch (g_variant_classify (a))
2649 case G_VARIANT_CLASS_BYTE:
2650 return ((gint) g_variant_get_byte (a)) -
2651 ((gint) g_variant_get_byte (b));
2653 case G_VARIANT_CLASS_INT16:
2654 return ((gint) g_variant_get_int16 (a)) -
2655 ((gint) g_variant_get_int16 (b));
2657 case G_VARIANT_CLASS_UINT16:
2658 return ((gint) g_variant_get_uint16 (a)) -
2659 ((gint) g_variant_get_uint16 (b));
2661 case G_VARIANT_CLASS_INT32:
2663 gint32 a_val = g_variant_get_int32 (a);
2664 gint32 b_val = g_variant_get_int32 (b);
2666 return (a_val == b_val) ? 0 : (a_val > b_val) ? 1 : -1;
2669 case G_VARIANT_CLASS_UINT32:
2671 guint32 a_val = g_variant_get_uint32 (a);
2672 guint32 b_val = g_variant_get_uint32 (b);
2674 return (a_val == b_val) ? 0 : (a_val > b_val) ? 1 : -1;
2677 case G_VARIANT_CLASS_INT64:
2679 gint64 a_val = g_variant_get_int64 (a);
2680 gint64 b_val = g_variant_get_int64 (b);
2682 return (a_val == b_val) ? 0 : (a_val > b_val) ? 1 : -1;
2685 case G_VARIANT_CLASS_UINT64:
2687 guint64 a_val = g_variant_get_uint64 (a);
2688 guint64 b_val = g_variant_get_uint64 (b);
2690 return (a_val == b_val) ? 0 : (a_val > b_val) ? 1 : -1;
2693 case G_VARIANT_CLASS_DOUBLE:
2695 gdouble a_val = g_variant_get_double (a);
2696 gdouble b_val = g_variant_get_double (b);
2698 return (a_val == b_val) ? 0 : (a_val > b_val) ? 1 : -1;
2701 case G_VARIANT_CLASS_STRING:
2702 case G_VARIANT_CLASS_OBJECT_PATH:
2703 case G_VARIANT_CLASS_SIGNATURE:
2704 return strcmp (g_variant_get_string (a, NULL),
2705 g_variant_get_string (b, NULL));
2708 g_return_val_if_fail (!g_variant_is_container (a), 0);
2709 g_assert_not_reached ();
2713 /* GVariantIter {{{1 */
2715 * GVariantIter: (skip)
2717 * #GVariantIter is an opaque data structure and can only be accessed
2718 * using the following functions.
2725 const gchar *loop_format;
2731 G_STATIC_ASSERT (sizeof (struct stack_iter) <= sizeof (GVariantIter));
2735 struct stack_iter iter;
2737 GVariant *value_ref;
2741 #define GVSI(i) ((struct stack_iter *) (i))
2742 #define GVHI(i) ((struct heap_iter *) (i))
2743 #define GVSI_MAGIC ((gsize) 3579507750u)
2744 #define GVHI_MAGIC ((gsize) 1450270775u)
2745 #define is_valid_iter(i) (i != NULL && \
2746 GVSI(i)->magic == GVSI_MAGIC)
2747 #define is_valid_heap_iter(i) (GVHI(i)->magic == GVHI_MAGIC && \
2751 * g_variant_iter_new:
2752 * @value: a container #GVariant
2753 * @returns: (transfer full): a new heap-allocated #GVariantIter
2755 * Creates a heap-allocated #GVariantIter for iterating over the items
2758 * Use g_variant_iter_free() to free the return value when you no longer
2761 * A reference is taken to @value and will be released only when
2762 * g_variant_iter_free() is called.
2767 g_variant_iter_new (GVariant *value)
2771 iter = (GVariantIter *) g_slice_new (struct heap_iter);
2772 GVHI(iter)->value_ref = g_variant_ref (value);
2773 GVHI(iter)->magic = GVHI_MAGIC;
2775 g_variant_iter_init (iter, value);
2781 * g_variant_iter_init: (skip)
2782 * @iter: a pointer to a #GVariantIter
2783 * @value: a container #GVariant
2784 * @returns: the number of items in @value
2786 * Initialises (without allocating) a #GVariantIter. @iter may be
2787 * completely uninitialised prior to this call; its old value is
2790 * The iterator remains valid for as long as @value exists, and need not
2791 * be freed in any way.
2796 g_variant_iter_init (GVariantIter *iter,
2799 GVSI(iter)->magic = GVSI_MAGIC;
2800 GVSI(iter)->value = value;
2801 GVSI(iter)->n = g_variant_n_children (value);
2803 GVSI(iter)->loop_format = NULL;
2805 return GVSI(iter)->n;
2809 * g_variant_iter_copy:
2810 * @iter: a #GVariantIter
2811 * @returns: (transfer full): a new heap-allocated #GVariantIter
2813 * Creates a new heap-allocated #GVariantIter to iterate over the
2814 * container that was being iterated over by @iter. Iteration begins on
2815 * the new iterator from the current position of the old iterator but
2816 * the two copies are independent past that point.
2818 * Use g_variant_iter_free() to free the return value when you no longer
2821 * A reference is taken to the container that @iter is iterating over
2822 * and will be releated only when g_variant_iter_free() is called.
2827 g_variant_iter_copy (GVariantIter *iter)
2831 g_return_val_if_fail (is_valid_iter (iter), 0);
2833 copy = g_variant_iter_new (GVSI(iter)->value);
2834 GVSI(copy)->i = GVSI(iter)->i;
2840 * g_variant_iter_n_children:
2841 * @iter: a #GVariantIter
2842 * @returns: the number of children in the container
2844 * Queries the number of child items in the container that we are
2845 * iterating over. This is the total number of items -- not the number
2846 * of items remaining.
2848 * This function might be useful for preallocation of arrays.
2853 g_variant_iter_n_children (GVariantIter *iter)
2855 g_return_val_if_fail (is_valid_iter (iter), 0);
2857 return GVSI(iter)->n;
2861 * g_variant_iter_free:
2862 * @iter: (transfer full): a heap-allocated #GVariantIter
2864 * Frees a heap-allocated #GVariantIter. Only call this function on
2865 * iterators that were returned by g_variant_iter_new() or
2866 * g_variant_iter_copy().
2871 g_variant_iter_free (GVariantIter *iter)
2873 g_return_if_fail (is_valid_heap_iter (iter));
2875 g_variant_unref (GVHI(iter)->value_ref);
2876 GVHI(iter)->magic = 0;
2878 g_slice_free (struct heap_iter, GVHI(iter));
2882 * g_variant_iter_next_value:
2883 * @iter: a #GVariantIter
2884 * @returns: (allow-none) (transfer full): a #GVariant, or %NULL
2886 * Gets the next item in the container. If no more items remain then
2887 * %NULL is returned.
2889 * Use g_variant_unref() to drop your reference on the return value when
2890 * you no longer need it.
2893 * <title>Iterating with g_variant_iter_next_value()</title>
2895 * /<!-- -->* recursively iterate a container *<!-- -->/
2897 * iterate_container_recursive (GVariant *container)
2899 * GVariantIter iter;
2902 * g_variant_iter_init (&iter, container);
2903 * while ((child = g_variant_iter_next_value (&iter)))
2905 * g_print ("type '%s'\n", g_variant_get_type_string (child));
2907 * if (g_variant_is_container (child))
2908 * iterate_container_recursive (child);
2910 * g_variant_unref (child);
2919 g_variant_iter_next_value (GVariantIter *iter)
2921 g_return_val_if_fail (is_valid_iter (iter), FALSE);
2923 if G_UNLIKELY (GVSI(iter)->i >= GVSI(iter)->n)
2925 g_critical ("g_variant_iter_next_value: must not be called again "
2926 "after NULL has already been returned.");
2932 if (GVSI(iter)->i < GVSI(iter)->n)
2933 return g_variant_get_child_value (GVSI(iter)->value, GVSI(iter)->i);
2938 /* GVariantBuilder {{{1 */
2942 * A utility type for constructing container-type #GVariant instances.
2944 * This is an opaque structure and may only be accessed using the
2945 * following functions.
2947 * #GVariantBuilder is not threadsafe in any way. Do not attempt to
2948 * access it from more than one thread.
2951 struct stack_builder
2953 GVariantBuilder *parent;
2956 /* type constraint explicitly specified by 'type'.
2957 * for tuple types, this moves along as we add more items.
2959 const GVariantType *expected_type;
2961 /* type constraint implied by previous array item.
2963 const GVariantType *prev_item_type;
2965 /* constraints on the number of children. max = -1 for unlimited. */
2969 /* dynamically-growing pointer array */
2970 GVariant **children;
2971 gsize allocated_children;
2974 /* set to '1' if all items in the container will have the same type
2975 * (ie: maybe, array, variant) '0' if not (ie: tuple, dict entry)
2977 guint uniform_item_types : 1;
2979 /* set to '1' initially and changed to '0' if an untrusted value is
2987 G_STATIC_ASSERT (sizeof (struct stack_builder) <= sizeof (GVariantBuilder));
2991 GVariantBuilder builder;
2997 #define GVSB(b) ((struct stack_builder *) (b))
2998 #define GVHB(b) ((struct heap_builder *) (b))
2999 #define GVSB_MAGIC ((gsize) 1033660112u)
3000 #define GVHB_MAGIC ((gsize) 3087242682u)
3001 #define is_valid_builder(b) (b != NULL && \
3002 GVSB(b)->magic == GVSB_MAGIC)
3003 #define is_valid_heap_builder(b) (GVHB(b)->magic == GVHB_MAGIC)
3006 * g_variant_builder_new:
3007 * @type: a container type
3008 * @returns: (transfer full): a #GVariantBuilder
3010 * Allocates and initialises a new #GVariantBuilder.
3012 * You should call g_variant_builder_unref() on the return value when it
3013 * is no longer needed. The memory will not be automatically freed by
3016 * In most cases it is easier to place a #GVariantBuilder directly on
3017 * the stack of the calling function and initialise it with
3018 * g_variant_builder_init().
3023 g_variant_builder_new (const GVariantType *type)
3025 GVariantBuilder *builder;
3027 builder = (GVariantBuilder *) g_slice_new (struct heap_builder);
3028 g_variant_builder_init (builder, type);
3029 GVHB(builder)->magic = GVHB_MAGIC;
3030 GVHB(builder)->ref_count = 1;
3036 * g_variant_builder_unref:
3037 * @builder: (transfer full): a #GVariantBuilder allocated by g_variant_builder_new()
3039 * Decreases the reference count on @builder.
3041 * In the event that there are no more references, releases all memory
3042 * associated with the #GVariantBuilder.
3044 * Don't call this on stack-allocated #GVariantBuilder instances or bad
3045 * things will happen.
3050 g_variant_builder_unref (GVariantBuilder *builder)
3052 g_return_if_fail (is_valid_heap_builder (builder));
3054 if (--GVHB(builder)->ref_count)
3057 g_variant_builder_clear (builder);
3058 GVHB(builder)->magic = 0;
3060 g_slice_free (struct heap_builder, GVHB(builder));
3064 * g_variant_builder_ref:
3065 * @builder: a #GVariantBuilder allocated by g_variant_builder_new()
3066 * @returns: (transfer full): a new reference to @builder
3068 * Increases the reference count on @builder.
3070 * Don't call this on stack-allocated #GVariantBuilder instances or bad
3071 * things will happen.
3076 g_variant_builder_ref (GVariantBuilder *builder)
3078 g_return_val_if_fail (is_valid_heap_builder (builder), NULL);
3080 GVHB(builder)->ref_count++;
3086 * g_variant_builder_clear: (skip)
3087 * @builder: a #GVariantBuilder
3089 * Releases all memory associated with a #GVariantBuilder without
3090 * freeing the #GVariantBuilder structure itself.
3092 * It typically only makes sense to do this on a stack-allocated
3093 * #GVariantBuilder if you want to abort building the value part-way
3094 * through. This function need not be called if you call
3095 * g_variant_builder_end() and it also doesn't need to be called on
3096 * builders allocated with g_variant_builder_new (see
3097 * g_variant_builder_unref() for that).
3099 * This function leaves the #GVariantBuilder structure set to all-zeros.
3100 * It is valid to call this function on either an initialised
3101 * #GVariantBuilder or one that is set to all-zeros but it is not valid
3102 * to call this function on uninitialised memory.
3107 g_variant_builder_clear (GVariantBuilder *builder)
3111 if (GVSB(builder)->magic == 0)
3112 /* all-zeros case */
3115 g_return_if_fail (is_valid_builder (builder));
3117 g_variant_type_free (GVSB(builder)->type);
3119 for (i = 0; i < GVSB(builder)->offset; i++)
3120 g_variant_unref (GVSB(builder)->children[i]);
3122 g_free (GVSB(builder)->children);
3124 if (GVSB(builder)->parent)
3126 g_variant_builder_clear (GVSB(builder)->parent);
3127 g_slice_free (GVariantBuilder, GVSB(builder)->parent);
3130 memset (builder, 0, sizeof (GVariantBuilder));
3134 * g_variant_builder_init: (skip)
3135 * @builder: a #GVariantBuilder
3136 * @type: a container type
3138 * Initialises a #GVariantBuilder structure.
3140 * @type must be non-%NULL. It specifies the type of container to
3141 * construct. It can be an indefinite type such as
3142 * %G_VARIANT_TYPE_ARRAY or a definite type such as "as" or "(ii)".
3143 * Maybe, array, tuple, dictionary entry and variant-typed values may be
3146 * After the builder is initialised, values are added using
3147 * g_variant_builder_add_value() or g_variant_builder_add().
3149 * After all the child values are added, g_variant_builder_end() frees
3150 * the memory associated with the builder and returns the #GVariant that
3153 * This function completely ignores the previous contents of @builder.
3154 * On one hand this means that it is valid to pass in completely
3155 * uninitialised memory. On the other hand, this means that if you are
3156 * initialising over top of an existing #GVariantBuilder you need to
3157 * first call g_variant_builder_clear() in order to avoid leaking
3160 * You must not call g_variant_builder_ref() or
3161 * g_variant_builder_unref() on a #GVariantBuilder that was initialised
3162 * with this function. If you ever pass a reference to a
3163 * #GVariantBuilder outside of the control of your own code then you
3164 * should assume that the person receiving that reference may try to use
3165 * reference counting; you should use g_variant_builder_new() instead of
3171 g_variant_builder_init (GVariantBuilder *builder,
3172 const GVariantType *type)
3174 g_return_if_fail (type != NULL);
3175 g_return_if_fail (g_variant_type_is_container (type));
3177 memset (builder, 0, sizeof (GVariantBuilder));
3179 GVSB(builder)->type = g_variant_type_copy (type);
3180 GVSB(builder)->magic = GVSB_MAGIC;
3181 GVSB(builder)->trusted = TRUE;
3183 switch (*(const gchar *) type)
3185 case G_VARIANT_CLASS_VARIANT:
3186 GVSB(builder)->uniform_item_types = TRUE;
3187 GVSB(builder)->allocated_children = 1;
3188 GVSB(builder)->expected_type = NULL;
3189 GVSB(builder)->min_items = 1;
3190 GVSB(builder)->max_items = 1;
3193 case G_VARIANT_CLASS_ARRAY:
3194 GVSB(builder)->uniform_item_types = TRUE;
3195 GVSB(builder)->allocated_children = 8;
3196 GVSB(builder)->expected_type =
3197 g_variant_type_element (GVSB(builder)->type);
3198 GVSB(builder)->min_items = 0;
3199 GVSB(builder)->max_items = -1;
3202 case G_VARIANT_CLASS_MAYBE:
3203 GVSB(builder)->uniform_item_types = TRUE;
3204 GVSB(builder)->allocated_children = 1;
3205 GVSB(builder)->expected_type =
3206 g_variant_type_element (GVSB(builder)->type);
3207 GVSB(builder)->min_items = 0;
3208 GVSB(builder)->max_items = 1;
3211 case G_VARIANT_CLASS_DICT_ENTRY:
3212 GVSB(builder)->uniform_item_types = FALSE;
3213 GVSB(builder)->allocated_children = 2;
3214 GVSB(builder)->expected_type =
3215 g_variant_type_key (GVSB(builder)->type);
3216 GVSB(builder)->min_items = 2;
3217 GVSB(builder)->max_items = 2;
3220 case 'r': /* G_VARIANT_TYPE_TUPLE was given */
3221 GVSB(builder)->uniform_item_types = FALSE;
3222 GVSB(builder)->allocated_children = 8;
3223 GVSB(builder)->expected_type = NULL;
3224 GVSB(builder)->min_items = 0;
3225 GVSB(builder)->max_items = -1;
3228 case G_VARIANT_CLASS_TUPLE: /* a definite tuple type was given */
3229 GVSB(builder)->allocated_children = g_variant_type_n_items (type);
3230 GVSB(builder)->expected_type =
3231 g_variant_type_first (GVSB(builder)->type);
3232 GVSB(builder)->min_items = GVSB(builder)->allocated_children;
3233 GVSB(builder)->max_items = GVSB(builder)->allocated_children;
3234 GVSB(builder)->uniform_item_types = FALSE;
3238 g_assert_not_reached ();
3241 GVSB(builder)->children = g_new (GVariant *,
3242 GVSB(builder)->allocated_children);
3246 g_variant_builder_make_room (struct stack_builder *builder)
3248 if (builder->offset == builder->allocated_children)
3250 builder->allocated_children *= 2;
3251 builder->children = g_renew (GVariant *, builder->children,
3252 builder->allocated_children);
3257 * g_variant_builder_add_value:
3258 * @builder: a #GVariantBuilder
3259 * @value: a #GVariant
3261 * Adds @value to @builder.
3263 * It is an error to call this function in any way that would create an
3264 * inconsistent value to be constructed. Some examples of this are
3265 * putting different types of items into an array, putting the wrong
3266 * types or number of items in a tuple, putting more than one value into
3269 * If @value is a floating reference (see g_variant_ref_sink()),
3270 * the @builder instance takes ownership of @value.
3275 g_variant_builder_add_value (GVariantBuilder *builder,
3278 g_return_if_fail (is_valid_builder (builder));
3279 g_return_if_fail (GVSB(builder)->offset < GVSB(builder)->max_items);
3280 g_return_if_fail (!GVSB(builder)->expected_type ||
3281 g_variant_is_of_type (value,
3282 GVSB(builder)->expected_type));
3283 g_return_if_fail (!GVSB(builder)->prev_item_type ||
3284 g_variant_is_of_type (value,
3285 GVSB(builder)->prev_item_type));
3287 GVSB(builder)->trusted &= g_variant_is_trusted (value);
3289 if (!GVSB(builder)->uniform_item_types)
3291 /* advance our expected type pointers */
3292 if (GVSB(builder)->expected_type)
3293 GVSB(builder)->expected_type =
3294 g_variant_type_next (GVSB(builder)->expected_type);
3296 if (GVSB(builder)->prev_item_type)
3297 GVSB(builder)->prev_item_type =
3298 g_variant_type_next (GVSB(builder)->prev_item_type);
3301 GVSB(builder)->prev_item_type = g_variant_get_type (value);
3303 g_variant_builder_make_room (GVSB(builder));
3305 GVSB(builder)->children[GVSB(builder)->offset++] =
3306 g_variant_ref_sink (value);
3310 * g_variant_builder_open:
3311 * @builder: a #GVariantBuilder
3312 * @type: a #GVariantType
3314 * Opens a subcontainer inside the given @builder. When done adding
3315 * items to the subcontainer, g_variant_builder_close() must be called.
3317 * It is an error to call this function in any way that would cause an
3318 * inconsistent value to be constructed (ie: adding too many values or
3319 * a value of an incorrect type).
3324 g_variant_builder_open (GVariantBuilder *builder,
3325 const GVariantType *type)
3327 GVariantBuilder *parent;
3329 g_return_if_fail (is_valid_builder (builder));
3330 g_return_if_fail (GVSB(builder)->offset < GVSB(builder)->max_items);
3331 g_return_if_fail (!GVSB(builder)->expected_type ||
3332 g_variant_type_is_subtype_of (type,
3333 GVSB(builder)->expected_type));
3334 g_return_if_fail (!GVSB(builder)->prev_item_type ||
3335 g_variant_type_is_subtype_of (GVSB(builder)->prev_item_type,
3338 parent = g_slice_dup (GVariantBuilder, builder);
3339 g_variant_builder_init (builder, type);
3340 GVSB(builder)->parent = parent;
3342 /* push the prev_item_type down into the subcontainer */
3343 if (GVSB(parent)->prev_item_type)
3345 if (!GVSB(builder)->uniform_item_types)
3346 /* tuples and dict entries */
3347 GVSB(builder)->prev_item_type =
3348 g_variant_type_first (GVSB(parent)->prev_item_type);
3350 else if (!g_variant_type_is_variant (GVSB(builder)->type))
3351 /* maybes and arrays */
3352 GVSB(builder)->prev_item_type =
3353 g_variant_type_element (GVSB(parent)->prev_item_type);
3358 * g_variant_builder_close:
3359 * @builder: a #GVariantBuilder
3361 * Closes the subcontainer inside the given @builder that was opened by
3362 * the most recent call to g_variant_builder_open().
3364 * It is an error to call this function in any way that would create an
3365 * inconsistent value to be constructed (ie: too few values added to the
3371 g_variant_builder_close (GVariantBuilder *builder)
3373 GVariantBuilder *parent;
3375 g_return_if_fail (is_valid_builder (builder));
3376 g_return_if_fail (GVSB(builder)->parent != NULL);
3378 parent = GVSB(builder)->parent;
3379 GVSB(builder)->parent = NULL;
3381 g_variant_builder_add_value (parent, g_variant_builder_end (builder));
3384 g_slice_free (GVariantBuilder, parent);
3388 * g_variant_make_maybe_type:
3389 * @element: a #GVariant
3391 * Return the type of a maybe containing @element.
3393 static GVariantType *
3394 g_variant_make_maybe_type (GVariant *element)
3396 return g_variant_type_new_maybe (g_variant_get_type (element));
3400 * g_variant_make_array_type:
3401 * @element: a #GVariant
3403 * Return the type of an array containing @element.
3405 static GVariantType *
3406 g_variant_make_array_type (GVariant *element)
3408 return g_variant_type_new_array (g_variant_get_type (element));
3412 * g_variant_builder_end:
3413 * @builder: a #GVariantBuilder
3414 * @returns: (transfer none): a new, floating, #GVariant
3416 * Ends the builder process and returns the constructed value.
3418 * It is not permissible to use @builder in any way after this call
3419 * except for reference counting operations (in the case of a
3420 * heap-allocated #GVariantBuilder) or by reinitialising it with
3421 * g_variant_builder_init() (in the case of stack-allocated).
3423 * It is an error to call this function in any way that would create an
3424 * inconsistent value to be constructed (ie: insufficient number of
3425 * items added to a container with a specific number of children
3426 * required). It is also an error to call this function if the builder
3427 * was created with an indefinite array or maybe type and no children
3428 * have been added; in this case it is impossible to infer the type of
3434 g_variant_builder_end (GVariantBuilder *builder)
3436 GVariantType *my_type;
3439 g_return_val_if_fail (is_valid_builder (builder), NULL);
3440 g_return_val_if_fail (GVSB(builder)->offset >= GVSB(builder)->min_items,
3442 g_return_val_if_fail (!GVSB(builder)->uniform_item_types ||
3443 GVSB(builder)->prev_item_type != NULL ||
3444 g_variant_type_is_definite (GVSB(builder)->type),
3447 if (g_variant_type_is_definite (GVSB(builder)->type))
3448 my_type = g_variant_type_copy (GVSB(builder)->type);
3450 else if (g_variant_type_is_maybe (GVSB(builder)->type))
3451 my_type = g_variant_make_maybe_type (GVSB(builder)->children[0]);
3453 else if (g_variant_type_is_array (GVSB(builder)->type))
3454 my_type = g_variant_make_array_type (GVSB(builder)->children[0]);
3456 else if (g_variant_type_is_tuple (GVSB(builder)->type))
3457 my_type = g_variant_make_tuple_type (GVSB(builder)->children,
3458 GVSB(builder)->offset);
3460 else if (g_variant_type_is_dict_entry (GVSB(builder)->type))
3461 my_type = g_variant_make_dict_entry_type (GVSB(builder)->children[0],
3462 GVSB(builder)->children[1]);
3464 g_assert_not_reached ();
3466 value = g_variant_new_from_children (my_type,
3467 g_renew (GVariant *,
3468 GVSB(builder)->children,
3469 GVSB(builder)->offset),
3470 GVSB(builder)->offset,
3471 GVSB(builder)->trusted);
3472 GVSB(builder)->children = NULL;
3473 GVSB(builder)->offset = 0;
3475 g_variant_builder_clear (builder);
3476 g_variant_type_free (my_type);
3481 /* Format strings {{{1 */
3483 * g_variant_format_string_scan:
3484 * @string: a string that may be prefixed with a format string
3485 * @limit: (allow-none) (default NULL): a pointer to the end of @string,
3487 * @endptr: (allow-none) (default NULL): location to store the end pointer,
3489 * @returns: %TRUE if there was a valid format string
3491 * Checks the string pointed to by @string for starting with a properly
3492 * formed #GVariant varargs format string. If no valid format string is
3493 * found then %FALSE is returned.
3495 * If @string does start with a valid format string then %TRUE is
3496 * returned. If @endptr is non-%NULL then it is updated to point to the
3497 * first character after the format string.
3499 * If @limit is non-%NULL then @limit (and any charater after it) will
3500 * not be accessed and the effect is otherwise equivalent to if the
3501 * character at @limit were nul.
3503 * See the section on <link linkend='gvariant-format-strings'>GVariant
3504 * Format Strings</link>.
3509 g_variant_format_string_scan (const gchar *string,
3511 const gchar **endptr)
3513 #define next_char() (string == limit ? '\0' : *string++)
3514 #define peek_char() (string == limit ? '\0' : *string)
3517 switch (next_char())
3519 case 'b': case 'y': case 'n': case 'q': case 'i': case 'u':
3520 case 'x': case 't': case 'h': case 'd': case 's': case 'o':
3521 case 'g': case 'v': case '*': case '?': case 'r':
3525 return g_variant_format_string_scan (string, limit, endptr);
3529 return g_variant_type_string_scan (string, limit, endptr);
3532 while (peek_char() != ')')
3533 if (!g_variant_format_string_scan (string, limit, &string))
3536 next_char(); /* consume ')' */
3546 if (c != 's' && c != 'o' && c != 'g')
3554 /* ISO/IEC 9899:1999 (C99) §7.21.5.2:
3555 * The terminating null character is considered to be
3556 * part of the string.
3558 if (c != '\0' && strchr ("bynqiuxthdsog?", c) == NULL)
3562 if (!g_variant_format_string_scan (string, limit, &string))
3565 if (next_char() != '}')
3571 if ((c = next_char()) == 'a')
3573 if ((c = next_char()) == '&')
3575 if ((c = next_char()) == 'a')
3577 if ((c = next_char()) == 'y')
3578 break; /* '^a&ay' */
3581 else if (c == 's' || c == 'o')
3582 break; /* '^a&s', '^a&o' */
3587 if ((c = next_char()) == 'y')
3591 else if (c == 's' || c == 'o')
3592 break; /* '^as', '^ao' */
3599 if ((c = next_char()) == 'a')
3601 if ((c = next_char()) == 'y')
3611 if (c != 's' && c != 'o' && c != 'g')
3630 * g_variant_format_string_scan_type:
3631 * @string: a string that may be prefixed with a format string
3632 * @limit: (allow-none) (default NULL): a pointer to the end of @string,
3634 * @endptr: (allow-none) (default NULL): location to store the end pointer,
3636 * @returns: (allow-none): a #GVariantType if there was a valid format string
3638 * If @string starts with a valid format string then this function will
3639 * return the type that the format string corresponds to. Otherwise
3640 * this function returns %NULL.
3642 * Use g_variant_type_free() to free the return value when you no longer
3645 * This function is otherwise exactly like
3646 * g_variant_format_string_scan().
3651 g_variant_format_string_scan_type (const gchar *string,
3653 const gchar **endptr)
3655 const gchar *my_end;
3662 if (!g_variant_format_string_scan (string, limit, endptr))
3665 dest = new = g_malloc (*endptr - string + 1);
3666 while (string != *endptr)
3668 if (*string != '@' && *string != '&' && *string != '^')
3674 return (GVariantType *) G_VARIANT_TYPE (new);
3678 valid_format_string (const gchar *format_string,
3682 const gchar *endptr;
3685 type = g_variant_format_string_scan_type (format_string, NULL, &endptr);
3687 if G_UNLIKELY (type == NULL || (single && *endptr != '\0'))
3690 g_critical ("`%s' is not a valid GVariant format string",
3693 g_critical ("`%s' does not have a valid GVariant format "
3694 "string as a prefix", format_string);
3697 g_variant_type_free (type);
3702 if G_UNLIKELY (value && !g_variant_is_of_type (value, type))
3707 fragment = g_strndup (format_string, endptr - format_string);
3708 typestr = g_variant_type_dup_string (type);
3710 g_critical ("the GVariant format string `%s' has a type of "
3711 "`%s' but the given value has a type of `%s'",
3712 fragment, typestr, g_variant_get_type_string (value));
3714 g_variant_type_free (type);
3719 g_variant_type_free (type);
3724 /* Variable Arguments {{{1 */
3725 /* We consider 2 main classes of format strings:
3727 * - recursive format strings
3728 * these are ones that result in recursion and the collection of
3729 * possibly more than one argument. Maybe types, tuples,
3730 * dictionary entries.
3732 * - leaf format string
3733 * these result in the collection of a single argument.
3735 * Leaf format strings are further subdivided into two categories:
3737 * - single non-null pointer ("nnp")
3738 * these either collect or return a single non-null pointer.
3741 * these collect or return something else (bool, number, etc).
3743 * Based on the above, the varargs handling code is split into 4 main parts:
3745 * - nnp handling code
3746 * - leaf handling code (which may invoke nnp code)
3747 * - generic handling code (may be recursive, may invoke leaf code)
3748 * - user-facing API (which invokes the generic code)
3750 * Each section implements some of the following functions:
3753 * collect the arguments for the format string as if
3754 * g_variant_new() had been called, but do nothing with them. used
3755 * for skipping over arguments when constructing a Nothing maybe
3759 * create a GVariant *
3762 * unpack a GVariant *
3764 * - free (nnp only):
3765 * free a previously allocated item
3769 g_variant_format_string_is_leaf (const gchar *str)
3771 return str[0] != 'm' && str[0] != '(' && str[0] != '{';
3775 g_variant_format_string_is_nnp (const gchar *str)
3777 return str[0] == 'a' || str[0] == 's' || str[0] == 'o' || str[0] == 'g' ||
3778 str[0] == '^' || str[0] == '@' || str[0] == '*' || str[0] == '?' ||
3779 str[0] == 'r' || str[0] == 'v' || str[0] == '&';
3782 /* Single non-null pointer ("nnp") {{{2 */
3784 g_variant_valist_free_nnp (const gchar *str,
3790 g_variant_iter_free (ptr);
3794 if (str[2] != '&') /* '^as', '^ao' */
3796 else /* '^a&s', '^a&o' */
3810 g_variant_unref (ptr);
3817 g_assert_not_reached ();
3822 g_variant_scan_convenience (const gchar **str,
3845 g_variant_valist_new_nnp (const gchar **str,
3856 const GVariantType *type;
3859 value = g_variant_builder_end (ptr);
3860 type = g_variant_get_type (value);
3862 if G_UNLIKELY (!g_variant_type_is_array (type))
3863 g_error ("g_variant_new: expected array GVariantBuilder but "
3864 "the built value has type `%s'",
3865 g_variant_get_type_string (value));
3867 type = g_variant_type_element (type);
3869 if G_UNLIKELY (!g_variant_type_is_subtype_of (type, (GVariantType *) *str))
3870 g_error ("g_variant_new: expected GVariantBuilder array element "
3871 "type `%s' but the built value has element type `%s'",
3872 g_variant_type_dup_string ((GVariantType *) *str),
3873 g_variant_get_type_string (value) + 1);
3875 g_variant_type_string_scan (*str, NULL, str);
3881 /* special case: NULL pointer for empty array */
3883 const GVariantType *type = (GVariantType *) *str;
3885 g_variant_type_string_scan (*str, NULL, str);
3887 if G_UNLIKELY (!g_variant_type_is_definite (type))
3888 g_error ("g_variant_new: NULL pointer given with indefinite "
3889 "array type; unable to determine which type of empty "
3890 "array to construct.");
3892 return g_variant_new_array (type, NULL, 0);
3899 value = g_variant_new_string (ptr);
3902 value = g_variant_new_string ("[Invalid UTF-8]");
3908 return g_variant_new_object_path (ptr);
3911 return g_variant_new_signature (ptr);
3919 type = g_variant_scan_convenience (str, &constant, &arrays);
3922 return g_variant_new_strv (ptr, -1);
3925 return g_variant_new_objv (ptr, -1);
3928 return g_variant_new_bytestring_array (ptr, -1);
3930 return g_variant_new_bytestring (ptr);
3934 if G_UNLIKELY (!g_variant_is_of_type (ptr, (GVariantType *) *str))
3935 g_error ("g_variant_new: expected GVariant of type `%s' but "
3936 "received value has type `%s'",
3937 g_variant_type_dup_string ((GVariantType *) *str),
3938 g_variant_get_type_string (ptr));
3940 g_variant_type_string_scan (*str, NULL, str);
3948 if G_UNLIKELY (!g_variant_type_is_basic (g_variant_get_type (ptr)))
3949 g_error ("g_variant_new: format string `?' expects basic-typed "
3950 "GVariant, but received value has type `%s'",
3951 g_variant_get_type_string (ptr));
3956 if G_UNLIKELY (!g_variant_type_is_tuple (g_variant_get_type (ptr)))
3957 g_error ("g_variant_new: format string `r` expects tuple-typed "
3958 "GVariant, but received value has type `%s'",
3959 g_variant_get_type_string (ptr));
3964 return g_variant_new_variant (ptr);
3967 g_assert_not_reached ();
3972 g_variant_valist_get_nnp (const gchar **str,
3978 g_variant_type_string_scan (*str, NULL, str);
3979 return g_variant_iter_new (value);
3983 return (gchar *) g_variant_get_string (value, NULL);
3988 return g_variant_dup_string (value, NULL);
3996 type = g_variant_scan_convenience (str, &constant, &arrays);
4001 return g_variant_get_strv (value, NULL);
4003 return g_variant_dup_strv (value, NULL);
4006 else if (type == 'o')
4009 return g_variant_get_objv (value, NULL);
4011 return g_variant_dup_objv (value, NULL);
4014 else if (arrays > 1)
4017 return g_variant_get_bytestring_array (value, NULL);
4019 return g_variant_dup_bytestring_array (value, NULL);
4025 return (gchar *) g_variant_get_bytestring (value);
4027 return g_variant_dup_bytestring (value, NULL);
4032 g_variant_type_string_scan (*str, NULL, str);
4038 return g_variant_ref (value);
4041 return g_variant_get_variant (value);
4044 g_assert_not_reached ();
4050 g_variant_valist_skip_leaf (const gchar **str,
4053 if (g_variant_format_string_is_nnp (*str))
4055 g_variant_format_string_scan (*str, NULL, str);
4056 va_arg (*app, gpointer);
4074 va_arg (*app, guint64);
4078 va_arg (*app, gdouble);
4082 g_assert_not_reached ();
4087 g_variant_valist_new_leaf (const gchar **str,
4090 if (g_variant_format_string_is_nnp (*str))
4091 return g_variant_valist_new_nnp (str, va_arg (*app, gpointer));
4096 return g_variant_new_boolean (va_arg (*app, gboolean));
4099 return g_variant_new_byte (va_arg (*app, guint));
4102 return g_variant_new_int16 (va_arg (*app, gint));
4105 return g_variant_new_uint16 (va_arg (*app, guint));
4108 return g_variant_new_int32 (va_arg (*app, gint));
4111 return g_variant_new_uint32 (va_arg (*app, guint));
4114 return g_variant_new_int64 (va_arg (*app, gint64));
4117 return g_variant_new_uint64 (va_arg (*app, guint64));
4120 return g_variant_new_handle (va_arg (*app, gint));
4123 return g_variant_new_double (va_arg (*app, gdouble));
4126 g_assert_not_reached ();
4130 /* The code below assumes this */
4131 G_STATIC_ASSERT (sizeof (gboolean) == sizeof (guint32));
4132 G_STATIC_ASSERT (sizeof (gdouble) == sizeof (guint64));
4135 g_variant_valist_get_leaf (const gchar **str,
4140 gpointer ptr = va_arg (*app, gpointer);
4144 g_variant_format_string_scan (*str, NULL, str);
4148 if (g_variant_format_string_is_nnp (*str))
4150 gpointer *nnp = (gpointer *) ptr;
4152 if (free && *nnp != NULL)
4153 g_variant_valist_free_nnp (*str, *nnp);
4158 *nnp = g_variant_valist_get_nnp (str, value);
4160 g_variant_format_string_scan (*str, NULL, str);
4170 *(gboolean *) ptr = g_variant_get_boolean (value);
4174 *(guchar *) ptr = g_variant_get_byte (value);
4178 *(gint16 *) ptr = g_variant_get_int16 (value);
4182 *(guint16 *) ptr = g_variant_get_uint16 (value);
4186 *(gint32 *) ptr = g_variant_get_int32 (value);
4190 *(guint32 *) ptr = g_variant_get_uint32 (value);
4194 *(gint64 *) ptr = g_variant_get_int64 (value);
4198 *(guint64 *) ptr = g_variant_get_uint64 (value);
4202 *(gint32 *) ptr = g_variant_get_handle (value);
4206 *(gdouble *) ptr = g_variant_get_double (value);
4215 *(guchar *) ptr = 0;
4220 *(guint16 *) ptr = 0;
4227 *(guint32 *) ptr = 0;
4233 *(guint64 *) ptr = 0;
4238 g_assert_not_reached ();
4241 /* Generic (recursive) {{{2 */
4243 g_variant_valist_skip (const gchar **str,
4246 if (g_variant_format_string_is_leaf (*str))
4247 g_variant_valist_skip_leaf (str, app);
4249 else if (**str == 'm') /* maybe */
4253 if (!g_variant_format_string_is_nnp (*str))
4254 va_arg (*app, gboolean);
4256 g_variant_valist_skip (str, app);
4258 else /* tuple, dictionary entry */
4260 g_assert (**str == '(' || **str == '{');
4262 while (**str != ')' && **str != '}')
4263 g_variant_valist_skip (str, app);
4269 g_variant_valist_new (const gchar **str,
4272 if (g_variant_format_string_is_leaf (*str))
4273 return g_variant_valist_new_leaf (str, app);
4275 if (**str == 'm') /* maybe */
4277 GVariantType *type = NULL;
4278 GVariant *value = NULL;
4282 if (g_variant_format_string_is_nnp (*str))
4284 gpointer nnp = va_arg (*app, gpointer);
4287 value = g_variant_valist_new_nnp (str, nnp);
4289 type = g_variant_format_string_scan_type (*str, NULL, str);
4293 gboolean just = va_arg (*app, gboolean);
4296 value = g_variant_valist_new (str, app);
4299 type = g_variant_format_string_scan_type (*str, NULL, NULL);
4300 g_variant_valist_skip (str, app);
4304 value = g_variant_new_maybe (type, value);
4307 g_variant_type_free (type);
4311 else /* tuple, dictionary entry */
4316 g_variant_builder_init (&b, G_VARIANT_TYPE_TUPLE);
4319 g_assert (**str == '{');
4320 g_variant_builder_init (&b, G_VARIANT_TYPE_DICT_ENTRY);
4324 while (**str != ')' && **str != '}')
4325 g_variant_builder_add_value (&b, g_variant_valist_new (str, app));
4328 return g_variant_builder_end (&b);
4333 g_variant_valist_get (const gchar **str,
4338 if (g_variant_format_string_is_leaf (*str))
4339 g_variant_valist_get_leaf (str, value, free, app);
4341 else if (**str == 'm')
4346 value = g_variant_get_maybe (value);
4348 if (!g_variant_format_string_is_nnp (*str))
4350 gboolean *ptr = va_arg (*app, gboolean *);
4353 *ptr = value != NULL;
4356 g_variant_valist_get (str, value, free, app);
4359 g_variant_unref (value);
4362 else /* tuple, dictionary entry */
4366 g_assert (**str == '(' || **str == '{');
4369 while (**str != ')' && **str != '}')
4373 GVariant *child = g_variant_get_child_value (value, index++);
4374 g_variant_valist_get (str, child, free, app);
4375 g_variant_unref (child);
4378 g_variant_valist_get (str, NULL, free, app);
4384 /* User-facing API {{{2 */
4386 * g_variant_new: (skip)
4387 * @format_string: a #GVariant format string
4388 * @...: arguments, as per @format_string
4389 * @returns: a new floating #GVariant instance
4391 * Creates a new #GVariant instance.
4393 * Think of this function as an analogue to g_strdup_printf().
4395 * The type of the created instance and the arguments that are
4396 * expected by this function are determined by @format_string. See the
4397 * section on <link linkend='gvariant-format-strings'>GVariant Format
4398 * Strings</link>. Please note that the syntax of the format string is
4399 * very likely to be extended in the future.
4401 * The first character of the format string must not be '*' '?' '@' or
4402 * 'r'; in essence, a new #GVariant must always be constructed by this
4403 * function (and not merely passed through it unmodified).
4408 g_variant_new (const gchar *format_string,
4414 g_return_val_if_fail (valid_format_string (format_string, TRUE, NULL) &&
4415 format_string[0] != '?' && format_string[0] != '@' &&
4416 format_string[0] != '*' && format_string[0] != 'r',
4419 va_start (ap, format_string);
4420 value = g_variant_new_va (format_string, NULL, &ap);
4427 * g_variant_new_va: (skip)
4428 * @format_string: a string that is prefixed with a format string
4429 * @endptr: (allow-none) (default NULL): location to store the end pointer,
4431 * @app: a pointer to a #va_list
4432 * @returns: a new, usually floating, #GVariant
4434 * This function is intended to be used by libraries based on
4435 * #GVariant that want to provide g_variant_new()-like functionality
4438 * The API is more general than g_variant_new() to allow a wider range
4441 * @format_string must still point to a valid format string, but it only
4442 * needs to be nul-terminated if @endptr is %NULL. If @endptr is
4443 * non-%NULL then it is updated to point to the first character past the
4444 * end of the format string.
4446 * @app is a pointer to a #va_list. The arguments, according to
4447 * @format_string, are collected from this #va_list and the list is left
4448 * pointing to the argument following the last.
4450 * These two generalisations allow mixing of multiple calls to
4451 * g_variant_new_va() and g_variant_get_va() within a single actual
4452 * varargs call by the user.
4454 * The return value will be floating if it was a newly created GVariant
4455 * instance (for example, if the format string was "(ii)"). In the case
4456 * that the format_string was '*', '?', 'r', or a format starting with
4457 * '@' then the collected #GVariant pointer will be returned unmodified,
4458 * without adding any additional references.
4460 * In order to behave correctly in all cases it is necessary for the
4461 * calling function to g_variant_ref_sink() the return result before
4462 * returning control to the user that originally provided the pointer.
4463 * At this point, the caller will have their own full reference to the
4464 * result. This can also be done by adding the result to a container,
4465 * or by passing it to another g_variant_new() call.
4470 g_variant_new_va (const gchar *format_string,
4471 const gchar **endptr,
4476 g_return_val_if_fail (valid_format_string (format_string, !endptr, NULL),
4478 g_return_val_if_fail (app != NULL, NULL);
4480 value = g_variant_valist_new (&format_string, app);
4483 *endptr = format_string;
4489 * g_variant_get: (skip)
4490 * @value: a #GVariant instance
4491 * @format_string: a #GVariant format string
4492 * @...: arguments, as per @format_string
4494 * Deconstructs a #GVariant instance.
4496 * Think of this function as an analogue to scanf().
4498 * The arguments that are expected by this function are entirely
4499 * determined by @format_string. @format_string also restricts the
4500 * permissible types of @value. It is an error to give a value with
4501 * an incompatible type. See the section on <link
4502 * linkend='gvariant-format-strings'>GVariant Format Strings</link>.
4503 * Please note that the syntax of the format string is very likely to be
4504 * extended in the future.
4509 g_variant_get (GVariant *value,
4510 const gchar *format_string,
4515 g_return_if_fail (valid_format_string (format_string, TRUE, value));
4517 /* if any direct-pointer-access formats are in use, flatten first */
4518 if (strchr (format_string, '&'))
4519 g_variant_get_data (value);
4521 va_start (ap, format_string);
4522 g_variant_get_va (value, format_string, NULL, &ap);
4527 * g_variant_get_va: (skip)
4528 * @value: a #GVariant
4529 * @format_string: a string that is prefixed with a format string
4530 * @endptr: (allow-none) (default NULL): location to store the end pointer,
4532 * @app: a pointer to a #va_list
4534 * This function is intended to be used by libraries based on #GVariant
4535 * that want to provide g_variant_get()-like functionality to their
4538 * The API is more general than g_variant_get() to allow a wider range
4541 * @format_string must still point to a valid format string, but it only
4542 * need to be nul-terminated if @endptr is %NULL. If @endptr is
4543 * non-%NULL then it is updated to point to the first character past the
4544 * end of the format string.
4546 * @app is a pointer to a #va_list. The arguments, according to
4547 * @format_string, are collected from this #va_list and the list is left
4548 * pointing to the argument following the last.
4550 * These two generalisations allow mixing of multiple calls to
4551 * g_variant_new_va() and g_variant_get_va() within a single actual
4552 * varargs call by the user.
4557 g_variant_get_va (GVariant *value,
4558 const gchar *format_string,
4559 const gchar **endptr,
4562 g_return_if_fail (valid_format_string (format_string, !endptr, value));
4563 g_return_if_fail (value != NULL);
4564 g_return_if_fail (app != NULL);
4566 /* if any direct-pointer-access formats are in use, flatten first */
4567 if (strchr (format_string, '&'))
4568 g_variant_get_data (value);
4570 g_variant_valist_get (&format_string, value, FALSE, app);
4573 *endptr = format_string;
4576 /* Varargs-enabled Utility Functions {{{1 */
4579 * g_variant_builder_add: (skp)
4580 * @builder: a #GVariantBuilder
4581 * @format_string: a #GVariant varargs format string
4582 * @...: arguments, as per @format_string
4584 * Adds to a #GVariantBuilder.
4586 * This call is a convenience wrapper that is exactly equivalent to
4587 * calling g_variant_new() followed by g_variant_builder_add_value().
4589 * This function might be used as follows:
4593 * make_pointless_dictionary (void)
4595 * GVariantBuilder *builder;
4598 * builder = g_variant_builder_new (G_VARIANT_TYPE_ARRAY);
4599 * for (i = 0; i < 16; i++)
4603 * sprintf (buf, "%d", i);
4604 * g_variant_builder_add (builder, "{is}", i, buf);
4607 * return g_variant_builder_end (builder);
4614 g_variant_builder_add (GVariantBuilder *builder,
4615 const gchar *format_string,
4621 va_start (ap, format_string);
4622 variant = g_variant_new_va (format_string, NULL, &ap);
4625 g_variant_builder_add_value (builder, variant);
4629 * g_variant_get_child: (skip)
4630 * @value: a container #GVariant
4631 * @index_: the index of the child to deconstruct
4632 * @format_string: a #GVariant format string
4633 * @...: arguments, as per @format_string
4635 * Reads a child item out of a container #GVariant instance and
4636 * deconstructs it according to @format_string. This call is
4637 * essentially a combination of g_variant_get_child_value() and
4643 g_variant_get_child (GVariant *value,
4645 const gchar *format_string,
4651 child = g_variant_get_child_value (value, index_);
4652 g_return_if_fail (valid_format_string (format_string, TRUE, child));
4654 va_start (ap, format_string);
4655 g_variant_get_va (child, format_string, NULL, &ap);
4658 g_variant_unref (child);
4662 * g_variant_iter_next: (skip)
4663 * @iter: a #GVariantIter
4664 * @format_string: a GVariant format string
4665 * @...: the arguments to unpack the value into
4666 * @returns: %TRUE if a value was unpacked, or %FALSE if there as no
4669 * Gets the next item in the container and unpacks it into the variable
4670 * argument list according to @format_string, returning %TRUE.
4672 * If no more items remain then %FALSE is returned.
4674 * All of the pointers given on the variable arguments list of this
4675 * function are assumed to point at uninitialised memory. It is the
4676 * responsibility of the caller to free all of the values returned by
4677 * the unpacking process.
4679 * See the section on <link linkend='gvariant-format-strings'>GVariant
4680 * Format Strings</link>.
4683 * <title>Memory management with g_variant_iter_next()</title>
4685 * /<!-- -->* Iterates a dictionary of type 'a{sv}' *<!-- -->/
4687 * iterate_dictionary (GVariant *dictionary)
4689 * GVariantIter iter;
4693 * g_variant_iter_init (&iter, dictionary);
4694 * while (g_variant_iter_next (&iter, "{sv}", &key, &value))
4696 * g_print ("Item '%s' has type '%s'\n", key,
4697 * g_variant_get_type_string (value));
4699 * /<!-- -->* must free data for ourselves *<!-- -->/
4700 * g_variant_unref (value);
4707 * For a solution that is likely to be more convenient to C programmers
4708 * when dealing with loops, see g_variant_iter_loop().
4713 g_variant_iter_next (GVariantIter *iter,
4714 const gchar *format_string,
4719 value = g_variant_iter_next_value (iter);
4721 g_return_val_if_fail (valid_format_string (format_string, TRUE, value),
4728 va_start (ap, format_string);
4729 g_variant_valist_get (&format_string, value, FALSE, &ap);
4732 g_variant_unref (value);
4735 return value != NULL;
4739 * g_variant_iter_loop: (skip)
4740 * @iter: a #GVariantIter
4741 * @format_string: a GVariant format string
4742 * @...: the arguments to unpack the value into
4743 * @returns: %TRUE if a value was unpacked, or %FALSE if there as no
4746 * Gets the next item in the container and unpacks it into the variable
4747 * argument list according to @format_string, returning %TRUE.
4749 * If no more items remain then %FALSE is returned.
4751 * On the first call to this function, the pointers appearing on the
4752 * variable argument list are assumed to point at uninitialised memory.
4753 * On the second and later calls, it is assumed that the same pointers
4754 * will be given and that they will point to the memory as set by the
4755 * previous call to this function. This allows the previous values to
4756 * be freed, as appropriate.
4758 * This function is intended to be used with a while loop as
4759 * demonstrated in the following example. This function can only be
4760 * used when iterating over an array. It is only valid to call this
4761 * function with a string constant for the format string and the same
4762 * string constant must be used each time. Mixing calls to this
4763 * function and g_variant_iter_next() or g_variant_iter_next_value() on
4764 * the same iterator is not recommended.
4766 * See the section on <link linkend='gvariant-format-strings'>GVariant
4767 * Format Strings</link>.
4770 * <title>Memory management with g_variant_iter_loop()</title>
4772 * /<!-- -->* Iterates a dictionary of type 'a{sv}' *<!-- -->/
4774 * iterate_dictionary (GVariant *dictionary)
4776 * GVariantIter iter;
4780 * g_variant_iter_init (&iter, dictionary);
4781 * while (g_variant_iter_loop (&iter, "{sv}", &key, &value))
4783 * g_print ("Item '%s' has type '%s'\n", key,
4784 * g_variant_get_type_string (value));
4786 * /<!-- -->* no need to free 'key' and 'value' here *<!-- -->/
4792 * For most cases you should use g_variant_iter_next().
4794 * This function is really only useful when unpacking into #GVariant or
4795 * #GVariantIter in order to allow you to skip the call to
4796 * g_variant_unref() or g_variant_iter_free().
4798 * For example, if you are only looping over simple integer and string
4799 * types, g_variant_iter_next() is definitely preferred. For string
4800 * types, use the '&' prefix to avoid allocating any memory at all (and
4801 * thereby avoiding the need to free anything as well).
4806 g_variant_iter_loop (GVariantIter *iter,
4807 const gchar *format_string,
4810 gboolean first_time = GVSI(iter)->loop_format == NULL;
4814 g_return_val_if_fail (first_time ||
4815 format_string == GVSI(iter)->loop_format,
4820 TYPE_CHECK (GVSI(iter)->value, G_VARIANT_TYPE_ARRAY, FALSE);
4821 GVSI(iter)->loop_format = format_string;
4823 if (strchr (format_string, '&'))
4824 g_variant_get_data (GVSI(iter)->value);
4827 value = g_variant_iter_next_value (iter);
4829 g_return_val_if_fail (!first_time ||
4830 valid_format_string (format_string, TRUE, value),
4833 va_start (ap, format_string);
4834 g_variant_valist_get (&format_string, value, !first_time, &ap);
4838 g_variant_unref (value);
4840 return value != NULL;
4843 /* Serialised data {{{1 */
4845 g_variant_deep_copy (GVariant *value)
4847 switch (g_variant_classify (value))
4849 case G_VARIANT_CLASS_MAYBE:
4850 case G_VARIANT_CLASS_ARRAY:
4851 case G_VARIANT_CLASS_TUPLE:
4852 case G_VARIANT_CLASS_DICT_ENTRY:
4853 case G_VARIANT_CLASS_VARIANT:
4855 GVariantBuilder builder;
4859 g_variant_builder_init (&builder, g_variant_get_type (value));
4860 g_variant_iter_init (&iter, value);
4862 while ((child = g_variant_iter_next_value (&iter)))
4864 g_variant_builder_add_value (&builder, g_variant_deep_copy (child));
4865 g_variant_unref (child);
4868 return g_variant_builder_end (&builder);
4871 case G_VARIANT_CLASS_BOOLEAN:
4872 return g_variant_new_boolean (g_variant_get_boolean (value));
4874 case G_VARIANT_CLASS_BYTE:
4875 return g_variant_new_byte (g_variant_get_byte (value));
4877 case G_VARIANT_CLASS_INT16:
4878 return g_variant_new_int16 (g_variant_get_int16 (value));
4880 case G_VARIANT_CLASS_UINT16:
4881 return g_variant_new_uint16 (g_variant_get_uint16 (value));
4883 case G_VARIANT_CLASS_INT32:
4884 return g_variant_new_int32 (g_variant_get_int32 (value));
4886 case G_VARIANT_CLASS_UINT32:
4887 return g_variant_new_uint32 (g_variant_get_uint32 (value));
4889 case G_VARIANT_CLASS_INT64:
4890 return g_variant_new_int64 (g_variant_get_int64 (value));
4892 case G_VARIANT_CLASS_UINT64:
4893 return g_variant_new_uint64 (g_variant_get_uint64 (value));
4895 case G_VARIANT_CLASS_HANDLE:
4896 return g_variant_new_handle (g_variant_get_handle (value));
4898 case G_VARIANT_CLASS_DOUBLE:
4899 return g_variant_new_double (g_variant_get_double (value));
4901 case G_VARIANT_CLASS_STRING:
4902 return g_variant_new_string (g_variant_get_string (value, NULL));
4904 case G_VARIANT_CLASS_OBJECT_PATH:
4905 return g_variant_new_object_path (g_variant_get_string (value, NULL));
4907 case G_VARIANT_CLASS_SIGNATURE:
4908 return g_variant_new_signature (g_variant_get_string (value, NULL));
4911 g_assert_not_reached ();
4915 * g_variant_get_normal_form:
4916 * @value: a #GVariant
4917 * @returns: (transfer full): a trusted #GVariant
4919 * Gets a #GVariant instance that has the same value as @value and is
4920 * trusted to be in normal form.
4922 * If @value is already trusted to be in normal form then a new
4923 * reference to @value is returned.
4925 * If @value is not already trusted, then it is scanned to check if it
4926 * is in normal form. If it is found to be in normal form then it is
4927 * marked as trusted and a new reference to it is returned.
4929 * If @value is found not to be in normal form then a new trusted
4930 * #GVariant is created with the same value as @value.
4932 * It makes sense to call this function if you've received #GVariant
4933 * data from untrusted sources and you want to ensure your serialised
4934 * output is definitely in normal form.
4939 g_variant_get_normal_form (GVariant *value)
4943 if (g_variant_is_normal_form (value))
4944 return g_variant_ref (value);
4946 trusted = g_variant_deep_copy (value);
4947 g_assert (g_variant_is_trusted (trusted));
4949 return g_variant_ref_sink (trusted);
4953 * g_variant_byteswap:
4954 * @value: a #GVariant
4955 * @returns: (transfer full): the byteswapped form of @value
4957 * Performs a byteswapping operation on the contents of @value. The
4958 * result is that all multi-byte numeric data contained in @value is
4959 * byteswapped. That includes 16, 32, and 64bit signed and unsigned
4960 * integers as well as file handles and double precision floating point
4963 * This function is an identity mapping on any value that does not
4964 * contain multi-byte numeric data. That include strings, booleans,
4965 * bytes and containers containing only these things (recursively).
4967 * The returned value is always in normal form and is marked as trusted.
4972 g_variant_byteswap (GVariant *value)
4974 GVariantTypeInfo *type_info;
4978 type_info = g_variant_get_type_info (value);
4980 g_variant_type_info_query (type_info, &alignment, NULL);
4983 /* (potentially) contains multi-byte numeric data */
4985 GVariantSerialised serialised;
4989 trusted = g_variant_get_normal_form (value);
4990 serialised.type_info = g_variant_get_type_info (trusted);
4991 serialised.size = g_variant_get_size (trusted);
4992 serialised.data = g_malloc (serialised.size);
4993 g_variant_store (trusted, serialised.data);
4994 g_variant_unref (trusted);
4996 g_variant_serialised_byteswap (serialised);
4998 buffer = g_buffer_new_take_data (serialised.data, serialised.size);
4999 new = g_variant_new_from_buffer (g_variant_get_type (value), buffer, TRUE);
5000 g_buffer_unref (buffer);
5003 /* contains no multi-byte data */
5006 return g_variant_ref_sink (new);
5010 * g_variant_new_from_data:
5011 * @type: a definite #GVariantType
5012 * @data: (array length=size) (element-type guint8): the serialised data
5013 * @size: the size of @data
5014 * @trusted: %TRUE if @data is definitely in normal form
5015 * @notify: (scope async): function to call when @data is no longer needed
5016 * @user_data: data for @notify
5017 * @returns: (transfer none): a new floating #GVariant of type @type
5019 * Creates a new #GVariant instance from serialised data.
5021 * @type is the type of #GVariant instance that will be constructed.
5022 * The interpretation of @data depends on knowing the type.
5024 * @data is not modified by this function and must remain valid with an
5025 * unchanging value until such a time as @notify is called with
5026 * @user_data. If the contents of @data change before that time then
5027 * the result is undefined.
5029 * If @data is trusted to be serialised data in normal form then
5030 * @trusted should be %TRUE. This applies to serialised data created
5031 * within this process or read from a trusted location on the disk (such
5032 * as a file installed in /usr/lib alongside your application). You
5033 * should set trusted to %FALSE if @data is read from the network, a
5034 * file in the user's home directory, etc.
5036 * @notify will be called with @user_data when @data is no longer
5037 * needed. The exact time of this call is unspecified and might even be
5038 * before this function returns.
5043 g_variant_new_from_data (const GVariantType *type,
5047 GDestroyNotify notify,
5053 g_return_val_if_fail (g_variant_type_is_definite (type), NULL);
5054 g_return_val_if_fail (data != NULL || size == 0, NULL);
5057 buffer = g_buffer_new_from_pointer (data, size, notify, user_data);
5059 buffer = g_buffer_new_from_static_data (data, size);
5061 value = g_variant_new_from_buffer (type, buffer, trusted);
5062 g_buffer_unref (buffer);
5068 /* vim:set foldmethod=marker: */