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/ghash.h>
33 #include <glib/gmem.h>
41 * @short_description: strongly typed value datatype
42 * @see_also: GVariantType
44 * #GVariant is a variant datatype; it stores a value along with
45 * information about the type of that value. The range of possible
46 * values is determined by the type. The type system used by #GVariant
49 * #GVariant instances always have a type and a value (which are given
50 * at construction time). The type and value of a #GVariant instance
51 * can never change other than by the #GVariant itself being
52 * destroyed. A #GVariant cannot contain a pointer.
54 * #GVariant is reference counted using g_variant_ref() and
55 * g_variant_unref(). #GVariant also has floating reference counts --
56 * see g_variant_ref_sink().
58 * #GVariant is completely threadsafe. A #GVariant instance can be
59 * concurrently accessed in any way from any number of threads without
62 * #GVariant is heavily optimised for dealing with data in serialised
63 * form. It works particularly well with data located in memory-mapped
64 * files. It can perform nearly all deserialisation operations in a
65 * small constant time, usually touching only a single memory page.
66 * Serialised #GVariant data can also be sent over the network.
68 * #GVariant is largely compatible with D-Bus. Almost all types of
69 * #GVariant instances can be sent over D-Bus. See #GVariantType for
72 * For convenience to C programmers, #GVariant features powerful
73 * varargs-based value construction and destruction. This feature is
74 * designed to be embedded in other libraries.
76 * There is a Python-inspired text language for describing #GVariant
77 * values. #GVariant includes a printer for this language and a parser
78 * with type inferencing.
81 * <title>Memory Use</title>
83 * #GVariant tries to be quite efficient with respect to memory use.
84 * This section gives a rough idea of how much memory is used by the
85 * current implementation. The information here is subject to change
89 * The memory allocated by #GVariant can be grouped into 4 broad
90 * purposes: memory for serialised data, memory for the type
91 * information cache, buffer management memory and memory for the
92 * #GVariant structure itself.
95 * <title>Serialised Data Memory</title>
97 * This is the memory that is used for storing GVariant data in
98 * serialised form. This is what would be sent over the network or
99 * what would end up on disk.
102 * The amount of memory required to store a boolean is 1 byte. 16,
103 * 32 and 64 bit integers and double precision floating point numbers
104 * use their "natural" size. Strings (including object path and
105 * signature strings) are stored with a nul terminator, and as such
106 * use the length of the string plus 1 byte.
109 * Maybe types use no space at all to represent the null value and
110 * use the same amount of space (sometimes plus one byte) as the
111 * equivalent non-maybe-typed value to represent the non-null case.
114 * Arrays use the amount of space required to store each of their
115 * members, concatenated. Additionally, if the items stored in an
116 * array are not of a fixed-size (ie: strings, other arrays, etc)
117 * then an additional framing offset is stored for each item. The
118 * size of this offset is either 1, 2 or 4 bytes depending on the
119 * overall size of the container. Additionally, extra padding bytes
120 * are added as required for alignment of child values.
123 * Tuples (including dictionary entries) use the amount of space
124 * required to store each of their members, concatenated, plus one
125 * framing offset (as per arrays) for each non-fixed-sized item in
126 * the tuple, except for the last one. Additionally, extra padding
127 * bytes are added as required for alignment of child values.
130 * Variants use the same amount of space as the item inside of the
131 * variant, plus 1 byte, plus the length of the type string for the
132 * item inside the variant.
135 * As an example, consider a dictionary mapping strings to variants.
136 * In the case that the dictionary is empty, 0 bytes are required for
140 * If we add an item "width" that maps to the int32 value of 500 then
141 * we will use 4 byte to store the int32 (so 6 for the variant
142 * containing it) and 6 bytes for the string. The variant must be
143 * aligned to 8 after the 6 bytes of the string, so that's 2 extra
144 * bytes. 6 (string) + 2 (padding) + 6 (variant) is 14 bytes used
145 * for the dictionary entry. An additional 1 byte is added to the
146 * array as a framing offset making a total of 15 bytes.
149 * If we add another entry, "title" that maps to a nullable string
150 * that happens to have a value of null, then we use 0 bytes for the
151 * null value (and 3 bytes for the variant to contain it along with
152 * its type string) plus 6 bytes for the string. Again, we need 2
153 * padding bytes. That makes a total of 6 + 2 + 3 = 11 bytes.
156 * We now require extra padding between the two items in the array.
157 * After the 14 bytes of the first item, that's 2 bytes required. We
158 * now require 2 framing offsets for an extra two bytes. 14 + 2 + 11
159 * + 2 = 29 bytes to encode the entire two-item dictionary.
163 * <title>Type Information Cache</title>
165 * For each GVariant type that currently exists in the program a type
166 * information structure is kept in the type information cache. The
167 * type information structure is required for rapid deserialisation.
170 * Continuing with the above example, if a #GVariant exists with the
171 * type "a{sv}" then a type information struct will exist for
172 * "a{sv}", "{sv}", "s", and "v". Multiple uses of the same type
173 * will share the same type information. Additionally, all
174 * single-digit types are stored in read-only static memory and do
175 * not contribute to the writable memory footprint of a program using
179 * Aside from the type information structures stored in read-only
180 * memory, there are two forms of type information. One is used for
181 * container types where there is a single element type: arrays and
182 * maybe types. The other is used for container types where there
183 * are multiple element types: tuples and dictionary entries.
186 * Array type info structures are 6 * sizeof (void *), plus the
187 * memory required to store the type string itself. This means that
188 * on 32bit systems, the cache entry for "a{sv}" would require 30
189 * bytes of memory (plus malloc overhead).
192 * Tuple type info structures are 6 * sizeof (void *), plus 4 *
193 * sizeof (void *) for each item in the tuple, plus the memory
194 * required to store the type string itself. A 2-item tuple, for
195 * example, would have a type information structure that consumed
196 * writable memory in the size of 14 * sizeof (void *) (plus type
197 * string) This means that on 32bit systems, the cache entry for
198 * "{sv}" would require 61 bytes of memory (plus malloc overhead).
201 * This means that in total, for our "a{sv}" example, 91 bytes of
202 * type information would be allocated.
205 * The type information cache, additionally, uses a #GHashTable to
206 * store and lookup the cached items and stores a pointer to this
207 * hash table in static storage. The hash table is freed when there
208 * are zero items in the type cache.
211 * Although these sizes may seem large it is important to remember
212 * that a program will probably only have a very small number of
213 * different types of values in it and that only one type information
214 * structure is required for many different values of the same type.
218 * <title>Buffer Management Memory</title>
220 * #GVariant uses an internal buffer management structure to deal
221 * with the various different possible sources of serialised data
222 * that it uses. The buffer is responsible for ensuring that the
223 * correct call is made when the data is no longer in use by
224 * #GVariant. This may involve a g_free() or a g_slice_free() or
225 * even g_mapped_file_unref().
228 * One buffer management structure is used for each chunk of
229 * serialised data. The size of the buffer management structure is 4
230 * * (void *). On 32bit systems, that's 16 bytes.
234 * <title>GVariant structure</title>
236 * The size of a #GVariant structure is 6 * (void *). On 32 bit
237 * systems, that's 24 bytes.
240 * #GVariant structures only exist if they are explicitly created
241 * with API calls. For example, if a #GVariant is constructed out of
242 * serialised data for the example given above (with the dictionary)
243 * then although there are 9 individual values that comprise the
244 * entire dictionary (two keys, two values, two variants containing
245 * the values, two dictionary entries, plus the dictionary itself),
246 * only 1 #GVariant instance exists -- the one referring to the
250 * If calls are made to start accessing the other values then
251 * #GVariant instances will exist for those values only for as long
252 * as they are in use (ie: until you call g_variant_unref()). The
253 * type information is shared. The serialised data and the buffer
254 * management structure for that serialised data is shared by the
259 * <title>Summary</title>
261 * To put the entire example together, for our dictionary mapping
262 * strings to variants (with two entries, as given above), we are
263 * using 91 bytes of memory for type information, 29 byes of memory
264 * for the serialised data, 16 bytes for buffer management and 24
265 * bytes for the #GVariant instance, or a total of 160 bytes, plus
266 * malloc overhead. If we were to use g_variant_get_child_value() to
267 * access the two dictionary entries, we would use an additional 48
268 * bytes. If we were to have other dictionaries of the same type, we
269 * would use more memory for the serialised data and buffer
270 * management for those dictionaries, but the type information would
277 /* definition of GVariant structure is in gvariant-core.c */
279 /* this is a g_return_val_if_fail() for making
280 * sure a (GVariant *) has the required type.
282 #define TYPE_CHECK(value, TYPE, val) \
283 if G_UNLIKELY (!g_variant_is_of_type (value, TYPE)) { \
284 g_return_if_fail_warning (G_LOG_DOMAIN, G_STRFUNC, \
285 "g_variant_is_of_type (" #value \
290 /* Numeric Type Constructor/Getters {{{1 */
292 * g_variant_new_from_trusted:
293 * @type: the #GVariantType
294 * @data: the data to use
295 * @size: the size of @data
296 * @returns: a new floating #GVariant
298 * Constructs a new trusted #GVariant instance from the provided data.
299 * This is used to implement g_variant_new_* for all the basic types.
302 g_variant_new_from_trusted (const GVariantType *type,
309 buffer = g_buffer_new_from_data (data, size);
310 value = g_variant_new_from_buffer (type, buffer, TRUE);
311 g_buffer_unref (buffer);
317 * g_variant_new_boolean:
318 * @value: a #gboolean value
319 * @returns: (transfer none): a floating reference to a new boolean #GVariant instance
321 * Creates a new boolean #GVariant instance -- either %TRUE or %FALSE.
326 g_variant_new_boolean (gboolean value)
330 return g_variant_new_from_trusted (G_VARIANT_TYPE_BOOLEAN, &v, 1);
334 * g_variant_get_boolean:
335 * @value: a boolean #GVariant instance
336 * @returns: %TRUE or %FALSE
338 * Returns the boolean value of @value.
340 * It is an error to call this function with a @value of any type
341 * other than %G_VARIANT_TYPE_BOOLEAN.
346 g_variant_get_boolean (GVariant *value)
350 TYPE_CHECK (value, G_VARIANT_TYPE_BOOLEAN, FALSE);
352 data = g_variant_get_data (value);
354 return data != NULL ? *data != 0 : FALSE;
357 /* the constructors and accessors for byte, int{16,32,64}, handles and
358 * doubles all look pretty much exactly the same, so we reduce
361 #define NUMERIC_TYPE(TYPE, type, ctype) \
362 GVariant *g_variant_new_##type (ctype value) { \
363 return g_variant_new_from_trusted (G_VARIANT_TYPE_##TYPE, \
364 &value, sizeof value); \
366 ctype g_variant_get_##type (GVariant *value) { \
368 TYPE_CHECK (value, G_VARIANT_TYPE_ ## TYPE, 0); \
369 data = g_variant_get_data (value); \
370 return data != NULL ? *data : 0; \
375 * g_variant_new_byte:
376 * @value: a #guint8 value
377 * @returns: (transfer none): a floating reference to a new byte #GVariant instance
379 * Creates a new byte #GVariant instance.
384 * g_variant_get_byte:
385 * @value: a byte #GVariant instance
386 * @returns: a #guchar
388 * Returns the byte value of @value.
390 * It is an error to call this function with a @value of any type
391 * other than %G_VARIANT_TYPE_BYTE.
395 NUMERIC_TYPE (BYTE, byte, guchar)
398 * g_variant_new_int16:
399 * @value: a #gint16 value
400 * @returns: (transfer none): a floating reference to a new int16 #GVariant instance
402 * Creates a new int16 #GVariant instance.
407 * g_variant_get_int16:
408 * @value: a int16 #GVariant instance
409 * @returns: a #gint16
411 * Returns the 16-bit signed integer value of @value.
413 * It is an error to call this function with a @value of any type
414 * other than %G_VARIANT_TYPE_INT16.
418 NUMERIC_TYPE (INT16, int16, gint16)
421 * g_variant_new_uint16:
422 * @value: a #guint16 value
423 * @returns: (transfer none): a floating reference to a new uint16 #GVariant instance
425 * Creates a new uint16 #GVariant instance.
430 * g_variant_get_uint16:
431 * @value: a uint16 #GVariant instance
432 * @returns: a #guint16
434 * Returns the 16-bit unsigned integer value of @value.
436 * It is an error to call this function with a @value of any type
437 * other than %G_VARIANT_TYPE_UINT16.
441 NUMERIC_TYPE (UINT16, uint16, guint16)
444 * g_variant_new_int32:
445 * @value: a #gint32 value
446 * @returns: (transfer none): a floating reference to a new int32 #GVariant instance
448 * Creates a new int32 #GVariant instance.
453 * g_variant_get_int32:
454 * @value: a int32 #GVariant instance
455 * @returns: a #gint32
457 * Returns the 32-bit signed integer value of @value.
459 * It is an error to call this function with a @value of any type
460 * other than %G_VARIANT_TYPE_INT32.
464 NUMERIC_TYPE (INT32, int32, gint32)
467 * g_variant_new_uint32:
468 * @value: a #guint32 value
469 * @returns: (transfer none): a floating reference to a new uint32 #GVariant instance
471 * Creates a new uint32 #GVariant instance.
476 * g_variant_get_uint32:
477 * @value: a uint32 #GVariant instance
478 * @returns: a #guint32
480 * Returns the 32-bit unsigned integer value of @value.
482 * It is an error to call this function with a @value of any type
483 * other than %G_VARIANT_TYPE_UINT32.
487 NUMERIC_TYPE (UINT32, uint32, guint32)
490 * g_variant_new_int64:
491 * @value: a #gint64 value
492 * @returns: (transfer none): a floating reference to a new int64 #GVariant instance
494 * Creates a new int64 #GVariant instance.
499 * g_variant_get_int64:
500 * @value: a int64 #GVariant instance
501 * @returns: a #gint64
503 * Returns the 64-bit signed integer value of @value.
505 * It is an error to call this function with a @value of any type
506 * other than %G_VARIANT_TYPE_INT64.
510 NUMERIC_TYPE (INT64, int64, gint64)
513 * g_variant_new_uint64:
514 * @value: a #guint64 value
515 * @returns: (transfer none): a floating reference to a new uint64 #GVariant instance
517 * Creates a new uint64 #GVariant instance.
522 * g_variant_get_uint64:
523 * @value: a uint64 #GVariant instance
524 * @returns: a #guint64
526 * Returns the 64-bit unsigned integer value of @value.
528 * It is an error to call this function with a @value of any type
529 * other than %G_VARIANT_TYPE_UINT64.
533 NUMERIC_TYPE (UINT64, uint64, guint64)
536 * g_variant_new_handle:
537 * @value: a #gint32 value
538 * @returns: (transfer none): a floating reference to a new handle #GVariant instance
540 * Creates a new handle #GVariant instance.
542 * By convention, handles are indexes into an array of file descriptors
543 * that are sent alongside a D-Bus message. If you're not interacting
544 * with D-Bus, you probably don't need them.
549 * g_variant_get_handle:
550 * @value: a handle #GVariant instance
551 * @returns: a #gint32
553 * Returns the 32-bit signed integer value of @value.
555 * It is an error to call this function with a @value of any type other
556 * than %G_VARIANT_TYPE_HANDLE.
558 * By convention, handles are indexes into an array of file descriptors
559 * that are sent alongside a D-Bus message. If you're not interacting
560 * with D-Bus, you probably don't need them.
564 NUMERIC_TYPE (HANDLE, handle, gint32)
567 * g_variant_new_double:
568 * @value: a #gdouble floating point value
569 * @returns: (transfer none): a floating reference to a new double #GVariant instance
571 * Creates a new double #GVariant instance.
576 * g_variant_get_double:
577 * @value: a double #GVariant instance
578 * @returns: a #gdouble
580 * Returns the double precision floating point value of @value.
582 * It is an error to call this function with a @value of any type
583 * other than %G_VARIANT_TYPE_DOUBLE.
587 NUMERIC_TYPE (DOUBLE, double, gdouble)
589 /* Container type Constructor / Deconstructors {{{1 */
591 * g_variant_new_maybe:
592 * @child_type: (allow-none): the #GVariantType of the child, or %NULL
593 * @child: (allow-none): the child value, or %NULL
594 * @returns: (transfer none): a floating reference to a new #GVariant maybe instance
596 * Depending on if @child is %NULL, either wraps @child inside of a
597 * maybe container or creates a Nothing instance for the given @type.
599 * At least one of @child_type and @child must be non-%NULL.
600 * If @child_type is non-%NULL then it must be a definite type.
601 * If they are both non-%NULL then @child_type must be the type
604 * If @child is a floating reference (see g_variant_ref_sink()), the new
605 * instance takes ownership of @child.
610 g_variant_new_maybe (const GVariantType *child_type,
613 GVariantType *maybe_type;
616 g_return_val_if_fail (child_type == NULL || g_variant_type_is_definite
618 g_return_val_if_fail (child_type != NULL || child != NULL, NULL);
619 g_return_val_if_fail (child_type == NULL || child == NULL ||
620 g_variant_is_of_type (child, child_type),
623 if (child_type == NULL)
624 child_type = g_variant_get_type (child);
626 maybe_type = g_variant_type_new_maybe (child_type);
633 children = g_new (GVariant *, 1);
634 children[0] = g_variant_ref_sink (child);
635 trusted = g_variant_is_trusted (children[0]);
637 value = g_variant_new_from_children (maybe_type, children, 1, trusted);
640 value = g_variant_new_from_children (maybe_type, NULL, 0, TRUE);
642 g_variant_type_free (maybe_type);
648 * g_variant_get_maybe:
649 * @value: a maybe-typed value
650 * @returns: (allow-none) (transfer full): the contents of @value, or %NULL
652 * Given a maybe-typed #GVariant instance, extract its value. If the
653 * value is Nothing, then this function returns %NULL.
658 g_variant_get_maybe (GVariant *value)
660 TYPE_CHECK (value, G_VARIANT_TYPE_MAYBE, NULL);
662 if (g_variant_n_children (value))
663 return g_variant_get_child_value (value, 0);
669 * g_variant_new_variant: (constructor)
670 * @value: a #GVariant instance
671 * @returns: (transfer none): a floating reference to a new variant #GVariant instance
673 * Boxes @value. The result is a #GVariant instance representing a
674 * variant containing the original value.
676 * If @child is a floating reference (see g_variant_ref_sink()), the new
677 * instance takes ownership of @child.
682 g_variant_new_variant (GVariant *value)
684 g_return_val_if_fail (value != NULL, NULL);
686 g_variant_ref_sink (value);
688 return g_variant_new_from_children (G_VARIANT_TYPE_VARIANT,
689 g_memdup (&value, sizeof value),
690 1, g_variant_is_trusted (value));
694 * g_variant_get_variant:
695 * @value: a variant #GVariant instance
696 * @returns: (transfer full): the item contained in the variant
698 * Unboxes @value. The result is the #GVariant instance that was
699 * contained in @value.
704 g_variant_get_variant (GVariant *value)
706 TYPE_CHECK (value, G_VARIANT_TYPE_VARIANT, NULL);
708 return g_variant_get_child_value (value, 0);
712 * g_variant_new_array:
713 * @child_type: (allow-none): the element type of the new array
714 * @children: (allow-none) (array length=n_children): an array of
715 * #GVariant pointers, the children
716 * @n_children: the length of @children
717 * @returns: (transfer none): a floating reference to a new #GVariant array
719 * Creates a new #GVariant array from @children.
721 * @child_type must be non-%NULL if @n_children is zero. Otherwise, the
722 * child type is determined by inspecting the first element of the
723 * @children array. If @child_type is non-%NULL then it must be a
726 * The items of the array are taken from the @children array. No entry
727 * in the @children array may be %NULL.
729 * All items in the array must have the same type, which must be the
730 * same as @child_type, if given.
732 * If the @children are floating references (see g_variant_ref_sink()), the
733 * new instance takes ownership of them as if via g_variant_ref_sink().
738 g_variant_new_array (const GVariantType *child_type,
739 GVariant * const *children,
742 GVariantType *array_type;
743 GVariant **my_children;
748 g_return_val_if_fail (n_children > 0 || child_type != NULL, NULL);
749 g_return_val_if_fail (n_children == 0 || children != NULL, NULL);
750 g_return_val_if_fail (child_type == NULL ||
751 g_variant_type_is_definite (child_type), NULL);
753 my_children = g_new (GVariant *, n_children);
756 if (child_type == NULL)
757 child_type = g_variant_get_type (children[0]);
758 array_type = g_variant_type_new_array (child_type);
760 for (i = 0; i < n_children; i++)
762 TYPE_CHECK (children[i], child_type, NULL);
763 my_children[i] = g_variant_ref_sink (children[i]);
764 trusted &= g_variant_is_trusted (children[i]);
767 value = g_variant_new_from_children (array_type, my_children,
768 n_children, trusted);
769 g_variant_type_free (array_type);
775 * g_variant_make_tuple_type:
776 * @children: (array length=n_children): an array of GVariant *
777 * @n_children: the length of @children
779 * Return the type of a tuple containing @children as its items.
781 static GVariantType *
782 g_variant_make_tuple_type (GVariant * const *children,
785 const GVariantType **types;
789 types = g_new (const GVariantType *, n_children);
791 for (i = 0; i < n_children; i++)
792 types[i] = g_variant_get_type (children[i]);
794 type = g_variant_type_new_tuple (types, n_children);
801 * g_variant_new_tuple:
802 * @children: (array length=n_children): the items to make the tuple out of
803 * @n_children: the length of @children
804 * @returns: (transfer none): a floating reference to a new #GVariant tuple
806 * Creates a new tuple #GVariant out of the items in @children. The
807 * type is determined from the types of @children. No entry in the
808 * @children array may be %NULL.
810 * If @n_children is 0 then the unit tuple is constructed.
812 * If the @children are floating references (see g_variant_ref_sink()), the
813 * new instance takes ownership of them as if via g_variant_ref_sink().
818 g_variant_new_tuple (GVariant * const *children,
821 GVariantType *tuple_type;
822 GVariant **my_children;
827 g_return_val_if_fail (n_children == 0 || children != NULL, NULL);
829 my_children = g_new (GVariant *, n_children);
832 for (i = 0; i < n_children; i++)
834 my_children[i] = g_variant_ref_sink (children[i]);
835 trusted &= g_variant_is_trusted (children[i]);
838 tuple_type = g_variant_make_tuple_type (children, n_children);
839 value = g_variant_new_from_children (tuple_type, my_children,
840 n_children, trusted);
841 g_variant_type_free (tuple_type);
847 * g_variant_make_dict_entry_type:
848 * @key: a #GVariant, the key
849 * @val: a #GVariant, the value
851 * Return the type of a dictionary entry containing @key and @val as its
854 static GVariantType *
855 g_variant_make_dict_entry_type (GVariant *key,
858 return g_variant_type_new_dict_entry (g_variant_get_type (key),
859 g_variant_get_type (val));
863 * g_variant_new_dict_entry: (constructor)
864 * @key: a basic #GVariant, the key
865 * @value: a #GVariant, the value
866 * @returns: (transfer none): a floating reference to a new dictionary entry #GVariant
868 * Creates a new dictionary entry #GVariant. @key and @value must be
869 * non-%NULL. @key must be a value of a basic type (ie: not a container).
871 * If the @key or @value are floating references (see g_variant_ref_sink()),
872 * the new instance takes ownership of them as if via g_variant_ref_sink().
877 g_variant_new_dict_entry (GVariant *key,
880 GVariantType *dict_type;
884 g_return_val_if_fail (key != NULL && value != NULL, NULL);
885 g_return_val_if_fail (!g_variant_is_container (key), NULL);
887 children = g_new (GVariant *, 2);
888 children[0] = g_variant_ref_sink (key);
889 children[1] = g_variant_ref_sink (value);
890 trusted = g_variant_is_trusted (key) && g_variant_is_trusted (value);
892 dict_type = g_variant_make_dict_entry_type (key, value);
893 value = g_variant_new_from_children (dict_type, children, 2, trusted);
894 g_variant_type_free (dict_type);
900 * g_variant_lookup: (skip)
901 * @dictionary: a dictionary #GVariant
902 * @key: the key to lookup in the dictionary
903 * @format_string: a GVariant format string
904 * @...: the arguments to unpack the value into
906 * Looks up a value in a dictionary #GVariant.
908 * This function is a wrapper around g_variant_lookup_value() and
909 * g_variant_get(). In the case that %NULL would have been returned,
910 * this function returns %FALSE. Otherwise, it unpacks the returned
911 * value and returns %TRUE.
913 * See g_variant_get() for information about @format_string.
915 * Returns: %TRUE if a value was unpacked
920 g_variant_lookup (GVariant *dictionary,
922 const gchar *format_string,
929 g_variant_get_data (dictionary);
931 type = g_variant_format_string_scan_type (format_string, NULL, NULL);
932 value = g_variant_lookup_value (dictionary, key, type);
933 g_variant_type_free (type);
939 va_start (ap, format_string);
940 g_variant_get_va (value, format_string, NULL, &ap);
941 g_variant_unref (value);
952 * g_variant_lookup_value:
953 * @dictionary: a dictionary #GVariant
954 * @key: the key to lookup in the dictionary
955 * @expected_type: (allow-none): a #GVariantType, or %NULL
957 * Looks up a value in a dictionary #GVariant.
959 * This function works with dictionaries of the type
960 * <literal>a{s*}</literal> (and equally well with type
961 * <literal>a{o*}</literal>, but we only further discuss the string case
962 * for sake of clarity).
964 * In the event that @dictionary has the type <literal>a{sv}</literal>,
965 * the @expected_type string specifies what type of value is expected to
966 * be inside of the variant. If the value inside the variant has a
967 * different type then %NULL is returned. In the event that @dictionary
968 * has a value type other than <literal>v</literal> then @expected_type
969 * must directly match the key type and it is used to unpack the value
970 * directly or an error occurs.
972 * In either case, if @key is not found in @dictionary, %NULL is
975 * If the key is found and the value has the correct type, it is
976 * returned. If @expected_type was specified then any non-%NULL return
977 * value will have this type.
979 * Returns: (transfer full): the value of the dictionary key, or %NULL
984 g_variant_lookup_value (GVariant *dictionary,
986 const GVariantType *expected_type)
992 g_return_val_if_fail (g_variant_is_of_type (dictionary,
993 G_VARIANT_TYPE ("a{s*}")) ||
994 g_variant_is_of_type (dictionary,
995 G_VARIANT_TYPE ("a{o*}")),
998 g_variant_iter_init (&iter, dictionary);
1000 while ((entry = g_variant_iter_next_value (&iter)))
1002 GVariant *entry_key;
1005 entry_key = g_variant_get_child_value (entry, 0);
1006 matches = strcmp (g_variant_get_string (entry_key, NULL), key) == 0;
1007 g_variant_unref (entry_key);
1012 g_variant_unref (entry);
1018 value = g_variant_get_child_value (entry, 1);
1019 g_variant_unref (entry);
1021 if (g_variant_is_of_type (value, G_VARIANT_TYPE_VARIANT))
1025 tmp = g_variant_get_variant (value);
1026 g_variant_unref (value);
1028 if (expected_type && !g_variant_is_of_type (tmp, expected_type))
1030 g_variant_unref (tmp);
1037 g_return_val_if_fail (expected_type == NULL || value == NULL ||
1038 g_variant_is_of_type (value, expected_type), NULL);
1044 * g_variant_get_fixed_array:
1045 * @value: a #GVariant array with fixed-sized elements
1046 * @n_elements: (out): a pointer to the location to store the number of items
1047 * @element_size: the size of each element
1048 * @returns: (array length=n_elements) (transfer none): a pointer to
1051 * Provides access to the serialised data for an array of fixed-sized
1054 * @value must be an array with fixed-sized elements. Numeric types are
1055 * fixed-size as are tuples containing only other fixed-sized types.
1057 * @element_size must be the size of a single element in the array. For
1058 * example, if calling this function for an array of 32 bit integers,
1059 * you might say <code>sizeof (gint32)</code>. This value isn't used
1060 * except for the purpose of a double-check that the form of the
1061 * seralised data matches the caller's expectation.
1063 * @n_elements, which must be non-%NULL is set equal to the number of
1064 * items in the array.
1069 g_variant_get_fixed_array (GVariant *value,
1073 GVariantTypeInfo *array_info;
1074 gsize array_element_size;
1078 TYPE_CHECK (value, G_VARIANT_TYPE_ARRAY, NULL);
1080 g_return_val_if_fail (n_elements != NULL, NULL);
1081 g_return_val_if_fail (element_size > 0, NULL);
1083 array_info = g_variant_get_type_info (value);
1084 g_variant_type_info_query_element (array_info, NULL, &array_element_size);
1086 g_return_val_if_fail (array_element_size, NULL);
1088 if G_UNLIKELY (array_element_size != element_size)
1090 if (array_element_size)
1091 g_critical ("g_variant_get_fixed_array: assertion "
1092 "`g_variant_array_has_fixed_size (value, element_size)' "
1093 "failed: array size %"G_GSIZE_FORMAT" does not match "
1094 "given element_size %"G_GSIZE_FORMAT".",
1095 array_element_size, element_size);
1097 g_critical ("g_variant_get_fixed_array: assertion "
1098 "`g_variant_array_has_fixed_size (value, element_size)' "
1099 "failed: array does not have fixed size.");
1102 data = g_variant_get_data (value);
1103 size = g_variant_get_size (value);
1105 if (size % element_size)
1108 *n_elements = size / element_size;
1116 /* String type constructor/getters/validation {{{1 */
1118 * g_variant_new_string:
1119 * @string: a normal utf8 nul-terminated string
1120 * @returns: (transfer none): a floating reference to a new string #GVariant instance
1122 * Creates a string #GVariant with the contents of @string.
1124 * @string must be valid utf8.
1129 g_variant_new_string (const gchar *string)
1131 g_return_val_if_fail (string != NULL, NULL);
1132 g_return_val_if_fail (g_utf8_validate (string, -1, NULL), NULL);
1134 return g_variant_new_from_trusted (G_VARIANT_TYPE_STRING,
1135 string, strlen (string) + 1);
1139 * g_variant_new_object_path:
1140 * @object_path: a normal C nul-terminated string
1141 * @returns: (transfer none): a floating reference to a new object path #GVariant instance
1143 * Creates a D-Bus object path #GVariant with the contents of @string.
1144 * @string must be a valid D-Bus object path. Use
1145 * g_variant_is_object_path() if you're not sure.
1150 g_variant_new_object_path (const gchar *object_path)
1152 g_return_val_if_fail (g_variant_is_object_path (object_path), NULL);
1154 return g_variant_new_from_trusted (G_VARIANT_TYPE_OBJECT_PATH,
1155 object_path, strlen (object_path) + 1);
1159 * g_variant_is_object_path:
1160 * @string: a normal C nul-terminated string
1161 * @returns: %TRUE if @string is a D-Bus object path
1163 * Determines if a given string is a valid D-Bus object path. You
1164 * should ensure that a string is a valid D-Bus object path before
1165 * passing it to g_variant_new_object_path().
1167 * A valid object path starts with '/' followed by zero or more
1168 * sequences of characters separated by '/' characters. Each sequence
1169 * must contain only the characters "[A-Z][a-z][0-9]_". No sequence
1170 * (including the one following the final '/' character) may be empty.
1175 g_variant_is_object_path (const gchar *string)
1177 g_return_val_if_fail (string != NULL, FALSE);
1179 return g_variant_serialiser_is_object_path (string, strlen (string) + 1);
1183 * g_variant_new_signature:
1184 * @signature: a normal C nul-terminated string
1185 * @returns: (transfer none): a floating reference to a new signature #GVariant instance
1187 * Creates a D-Bus type signature #GVariant with the contents of
1188 * @string. @string must be a valid D-Bus type signature. Use
1189 * g_variant_is_signature() if you're not sure.
1194 g_variant_new_signature (const gchar *signature)
1196 g_return_val_if_fail (g_variant_is_signature (signature), NULL);
1198 return g_variant_new_from_trusted (G_VARIANT_TYPE_SIGNATURE,
1199 signature, strlen (signature) + 1);
1203 * g_variant_is_signature:
1204 * @string: a normal C nul-terminated string
1205 * @returns: %TRUE if @string is a D-Bus type signature
1207 * Determines if a given string is a valid D-Bus type signature. You
1208 * should ensure that a string is a valid D-Bus type signature before
1209 * passing it to g_variant_new_signature().
1211 * D-Bus type signatures consist of zero or more definite #GVariantType
1212 * strings in sequence.
1217 g_variant_is_signature (const gchar *string)
1219 g_return_val_if_fail (string != NULL, FALSE);
1221 return g_variant_serialiser_is_signature (string, strlen (string) + 1);
1225 * g_variant_get_string:
1226 * @value: a string #GVariant instance
1227 * @length: (allow-none) (default 0) (out): a pointer to a #gsize,
1228 * to store the length
1229 * @returns: (transfer none): the constant string, utf8 encoded
1231 * Returns the string value of a #GVariant instance with a string
1232 * type. This includes the types %G_VARIANT_TYPE_STRING,
1233 * %G_VARIANT_TYPE_OBJECT_PATH and %G_VARIANT_TYPE_SIGNATURE.
1235 * The string will always be utf8 encoded.
1237 * If @length is non-%NULL then the length of the string (in bytes) is
1238 * returned there. For trusted values, this information is already
1239 * known. For untrusted values, a strlen() will be performed.
1241 * It is an error to call this function with a @value of any type
1242 * other than those three.
1244 * The return value remains valid as long as @value exists.
1249 g_variant_get_string (GVariant *value,
1255 g_return_val_if_fail (value != NULL, NULL);
1256 g_return_val_if_fail (
1257 g_variant_is_of_type (value, G_VARIANT_TYPE_STRING) ||
1258 g_variant_is_of_type (value, G_VARIANT_TYPE_OBJECT_PATH) ||
1259 g_variant_is_of_type (value, G_VARIANT_TYPE_SIGNATURE), NULL);
1261 data = g_variant_get_data (value);
1262 size = g_variant_get_size (value);
1264 if (!g_variant_is_trusted (value))
1266 switch (g_variant_classify (value))
1268 case G_VARIANT_CLASS_STRING:
1269 if (g_variant_serialiser_is_string (data, size))
1276 case G_VARIANT_CLASS_OBJECT_PATH:
1277 if (g_variant_serialiser_is_object_path (data, size))
1284 case G_VARIANT_CLASS_SIGNATURE:
1285 if (g_variant_serialiser_is_signature (data, size))
1293 g_assert_not_reached ();
1304 * g_variant_dup_string:
1305 * @value: a string #GVariant instance
1306 * @length: (out): a pointer to a #gsize, to store the length
1307 * @returns: (transfer full): a newly allocated string, utf8 encoded
1309 * Similar to g_variant_get_string() except that instead of returning
1310 * a constant string, the string is duplicated.
1312 * The string will always be utf8 encoded.
1314 * The return value must be freed using g_free().
1319 g_variant_dup_string (GVariant *value,
1322 return g_strdup (g_variant_get_string (value, length));
1326 * g_variant_new_strv:
1327 * @strv: (array length=length) (element-type utf8): an array of strings
1328 * @length: the length of @strv, or -1
1329 * @returns: (transfer none): a new floating #GVariant instance
1331 * Constructs an array of strings #GVariant from the given array of
1334 * If @length is -1 then @strv is %NULL-terminated.
1339 g_variant_new_strv (const gchar * const *strv,
1345 g_return_val_if_fail (length == 0 || strv != NULL, NULL);
1348 length = g_strv_length ((gchar **) strv);
1350 strings = g_new (GVariant *, length);
1351 for (i = 0; i < length; i++)
1352 strings[i] = g_variant_ref_sink (g_variant_new_string (strv[i]));
1354 return g_variant_new_from_children (G_VARIANT_TYPE_STRING_ARRAY,
1355 strings, length, TRUE);
1359 * g_variant_get_strv:
1360 * @value: an array of strings #GVariant
1361 * @length: (out) (allow-none): the length of the result, or %NULL
1362 * @returns: (array length=length zero-terminated=1) (transfer container): an array of constant
1365 * Gets the contents of an array of strings #GVariant. This call
1366 * makes a shallow copy; the return result should be released with
1367 * g_free(), but the individual strings must not be modified.
1369 * If @length is non-%NULL then the number of elements in the result
1370 * is stored there. In any case, the resulting array will be
1373 * For an empty array, @length will be set to 0 and a pointer to a
1374 * %NULL pointer will be returned.
1379 g_variant_get_strv (GVariant *value,
1386 TYPE_CHECK (value, G_VARIANT_TYPE_STRING_ARRAY, NULL);
1388 g_variant_get_data (value);
1389 n = g_variant_n_children (value);
1390 strv = g_new (const gchar *, n + 1);
1392 for (i = 0; i < n; i++)
1396 string = g_variant_get_child_value (value, i);
1397 strv[i] = g_variant_get_string (string, NULL);
1398 g_variant_unref (string);
1409 * g_variant_dup_strv:
1410 * @value: an array of strings #GVariant
1411 * @length: (out) (allow-none): the length of the result, or %NULL
1412 * @returns: (array length=length zero-terminated=1) (transfer full): an array of strings
1414 * Gets the contents of an array of strings #GVariant. This call
1415 * makes a deep copy; the return result should be released with
1418 * If @length is non-%NULL then the number of elements in the result
1419 * is stored there. In any case, the resulting array will be
1422 * For an empty array, @length will be set to 0 and a pointer to a
1423 * %NULL pointer will be returned.
1428 g_variant_dup_strv (GVariant *value,
1435 TYPE_CHECK (value, G_VARIANT_TYPE_STRING_ARRAY, NULL);
1437 n = g_variant_n_children (value);
1438 strv = g_new (gchar *, n + 1);
1440 for (i = 0; i < n; i++)
1444 string = g_variant_get_child_value (value, i);
1445 strv[i] = g_variant_dup_string (string, NULL);
1446 g_variant_unref (string);
1457 * g_variant_new_objv:
1458 * @strv: (array length=length) (element-type utf8): an array of strings
1459 * @length: the length of @strv, or -1
1460 * @returns: (transfer none): a new floating #GVariant instance
1462 * Constructs an array of object paths #GVariant from the given array of
1465 * Each string must be a valid #GVariant object path; see
1466 * g_variant_is_object_path().
1468 * If @length is -1 then @strv is %NULL-terminated.
1473 g_variant_new_objv (const gchar * const *strv,
1479 g_return_val_if_fail (length == 0 || strv != NULL, NULL);
1482 length = g_strv_length ((gchar **) strv);
1484 strings = g_new (GVariant *, length);
1485 for (i = 0; i < length; i++)
1486 strings[i] = g_variant_ref_sink (g_variant_new_object_path (strv[i]));
1488 return g_variant_new_from_children (G_VARIANT_TYPE_OBJECT_PATH_ARRAY,
1489 strings, length, TRUE);
1493 * g_variant_get_objv:
1494 * @value: an array of object paths #GVariant
1495 * @length: (out) (allow-none): the length of the result, or %NULL
1496 * @returns: (array length=length zero-terminated=1) (transfer container): an array of constant
1499 * Gets the contents of an array of object paths #GVariant. This call
1500 * makes a shallow copy; the return result should be released with
1501 * g_free(), but the individual strings must not be modified.
1503 * If @length is non-%NULL then the number of elements in the result
1504 * is stored there. In any case, the resulting array will be
1507 * For an empty array, @length will be set to 0 and a pointer to a
1508 * %NULL pointer will be returned.
1513 g_variant_get_objv (GVariant *value,
1520 TYPE_CHECK (value, G_VARIANT_TYPE_OBJECT_PATH_ARRAY, NULL);
1522 g_variant_get_data (value);
1523 n = g_variant_n_children (value);
1524 strv = g_new (const gchar *, n + 1);
1526 for (i = 0; i < n; i++)
1530 string = g_variant_get_child_value (value, i);
1531 strv[i] = g_variant_get_string (string, NULL);
1532 g_variant_unref (string);
1543 * g_variant_dup_objv:
1544 * @value: an array of object paths #GVariant
1545 * @length: (out) (allow-none): the length of the result, or %NULL
1546 * @returns: (array length=length zero-terminated=1) (transfer full): an array of strings
1548 * Gets the contents of an array of object paths #GVariant. This call
1549 * makes a deep copy; the return result should be released with
1552 * If @length is non-%NULL then the number of elements in the result
1553 * is stored there. In any case, the resulting array will be
1556 * For an empty array, @length will be set to 0 and a pointer to a
1557 * %NULL pointer will be returned.
1562 g_variant_dup_objv (GVariant *value,
1569 TYPE_CHECK (value, G_VARIANT_TYPE_OBJECT_PATH_ARRAY, NULL);
1571 n = g_variant_n_children (value);
1572 strv = g_new (gchar *, n + 1);
1574 for (i = 0; i < n; i++)
1578 string = g_variant_get_child_value (value, i);
1579 strv[i] = g_variant_dup_string (string, NULL);
1580 g_variant_unref (string);
1592 * g_variant_new_bytestring:
1593 * @string: (array zero-terminated=1) (element-type guint8): a normal
1594 * nul-terminated string in no particular encoding
1595 * @returns: (transfer none): a floating reference to a new bytestring #GVariant instance
1597 * Creates an array-of-bytes #GVariant with the contents of @string.
1598 * This function is just like g_variant_new_string() except that the
1599 * string need not be valid utf8.
1601 * The nul terminator character at the end of the string is stored in
1607 g_variant_new_bytestring (const gchar *string)
1609 g_return_val_if_fail (string != NULL, NULL);
1611 return g_variant_new_from_trusted (G_VARIANT_TYPE_BYTESTRING,
1612 string, strlen (string) + 1);
1616 * g_variant_get_bytestring:
1617 * @value: an array-of-bytes #GVariant instance
1618 * @returns: (transfer none) (array zero-terminated=1) (element-type guint8):
1619 * the constant string
1621 * Returns the string value of a #GVariant instance with an
1622 * array-of-bytes type. The string has no particular encoding.
1624 * If the array does not end with a nul terminator character, the empty
1625 * string is returned. For this reason, you can always trust that a
1626 * non-%NULL nul-terminated string will be returned by this function.
1628 * If the array contains a nul terminator character somewhere other than
1629 * the last byte then the returned string is the string, up to the first
1630 * such nul character.
1632 * It is an error to call this function with a @value that is not an
1635 * The return value remains valid as long as @value exists.
1640 g_variant_get_bytestring (GVariant *value)
1642 const gchar *string;
1645 TYPE_CHECK (value, G_VARIANT_TYPE_BYTESTRING, NULL);
1647 /* Won't be NULL since this is an array type */
1648 string = g_variant_get_data (value);
1649 size = g_variant_get_size (value);
1651 if (size && string[size - 1] == '\0')
1658 * g_variant_dup_bytestring:
1659 * @value: an array-of-bytes #GVariant instance
1660 * @length: (out) (allow-none) (default NULL): a pointer to a #gsize, to store
1661 * the length (not including the nul terminator)
1662 * @returns: (transfer full) (array zero-terminated=1 length=length)
1663 * (element-type guint8): a newly allocated string
1665 * Similar to g_variant_get_bytestring() except that instead of
1666 * returning a constant string, the string is duplicated.
1668 * The return value must be freed using g_free().
1673 g_variant_dup_bytestring (GVariant *value,
1676 const gchar *original = g_variant_get_bytestring (value);
1679 /* don't crash in case get_bytestring() had an assert failure */
1680 if (original == NULL)
1683 size = strlen (original);
1688 return g_memdup (original, size + 1);
1692 * g_variant_new_bytestring_array:
1693 * @strv: (array length=length): an array of strings
1694 * @length: the length of @strv, or -1
1695 * @returns: (transfer none): a new floating #GVariant instance
1697 * Constructs an array of bytestring #GVariant from the given array of
1700 * If @length is -1 then @strv is %NULL-terminated.
1705 g_variant_new_bytestring_array (const gchar * const *strv,
1711 g_return_val_if_fail (length == 0 || strv != NULL, NULL);
1714 length = g_strv_length ((gchar **) strv);
1716 strings = g_new (GVariant *, length);
1717 for (i = 0; i < length; i++)
1718 strings[i] = g_variant_ref_sink (g_variant_new_bytestring (strv[i]));
1720 return g_variant_new_from_children (G_VARIANT_TYPE_BYTESTRING_ARRAY,
1721 strings, length, TRUE);
1725 * g_variant_get_bytestring_array:
1726 * @value: an array of array of bytes #GVariant ('aay')
1727 * @length: (out) (allow-none): the length of the result, or %NULL
1728 * @returns: (array length=length) (transfer container): an array of constant strings
1730 * Gets the contents of an array of array of bytes #GVariant. This call
1731 * makes a shallow copy; the return result should be released with
1732 * g_free(), but the individual strings must not be modified.
1734 * If @length is non-%NULL then the number of elements in the result is
1735 * stored there. In any case, the resulting array will be
1738 * For an empty array, @length will be set to 0 and a pointer to a
1739 * %NULL pointer will be returned.
1744 g_variant_get_bytestring_array (GVariant *value,
1751 TYPE_CHECK (value, G_VARIANT_TYPE_BYTESTRING_ARRAY, NULL);
1753 g_variant_get_data (value);
1754 n = g_variant_n_children (value);
1755 strv = g_new (const gchar *, n + 1);
1757 for (i = 0; i < n; i++)
1761 string = g_variant_get_child_value (value, i);
1762 strv[i] = g_variant_get_bytestring (string);
1763 g_variant_unref (string);
1774 * g_variant_dup_bytestring_array:
1775 * @value: an array of array of bytes #GVariant ('aay')
1776 * @length: (out) (allow-none): the length of the result, or %NULL
1777 * @returns: (array length=length) (transfer full): an array of strings
1779 * Gets the contents of an array of array of bytes #GVariant. This call
1780 * makes a deep copy; the return result should be released with
1783 * If @length is non-%NULL then the number of elements in the result is
1784 * stored there. In any case, the resulting array will be
1787 * For an empty array, @length will be set to 0 and a pointer to a
1788 * %NULL pointer will be returned.
1793 g_variant_dup_bytestring_array (GVariant *value,
1800 TYPE_CHECK (value, G_VARIANT_TYPE_BYTESTRING_ARRAY, NULL);
1802 g_variant_get_data (value);
1803 n = g_variant_n_children (value);
1804 strv = g_new (gchar *, n + 1);
1806 for (i = 0; i < n; i++)
1810 string = g_variant_get_child_value (value, i);
1811 strv[i] = g_variant_dup_bytestring (string, NULL);
1812 g_variant_unref (string);
1822 /* Type checking and querying {{{1 */
1824 * g_variant_get_type:
1825 * @value: a #GVariant
1826 * @returns: a #GVariantType
1828 * Determines the type of @value.
1830 * The return value is valid for the lifetime of @value and must not
1835 const GVariantType *
1836 g_variant_get_type (GVariant *value)
1838 GVariantTypeInfo *type_info;
1840 g_return_val_if_fail (value != NULL, NULL);
1842 type_info = g_variant_get_type_info (value);
1844 return (GVariantType *) g_variant_type_info_get_type_string (type_info);
1848 * g_variant_get_type_string:
1849 * @value: a #GVariant
1850 * @returns: the type string for the type of @value
1852 * Returns the type string of @value. Unlike the result of calling
1853 * g_variant_type_peek_string(), this string is nul-terminated. This
1854 * string belongs to #GVariant and must not be freed.
1859 g_variant_get_type_string (GVariant *value)
1861 GVariantTypeInfo *type_info;
1863 g_return_val_if_fail (value != NULL, NULL);
1865 type_info = g_variant_get_type_info (value);
1867 return g_variant_type_info_get_type_string (type_info);
1871 * g_variant_is_of_type:
1872 * @value: a #GVariant instance
1873 * @type: a #GVariantType
1874 * @returns: %TRUE if the type of @value matches @type
1876 * Checks if a value has a type matching the provided type.
1881 g_variant_is_of_type (GVariant *value,
1882 const GVariantType *type)
1884 return g_variant_type_is_subtype_of (g_variant_get_type (value), type);
1888 * g_variant_is_container:
1889 * @value: a #GVariant instance
1890 * @returns: %TRUE if @value is a container
1892 * Checks if @value is a container.
1895 g_variant_is_container (GVariant *value)
1897 return g_variant_type_is_container (g_variant_get_type (value));
1902 * g_variant_classify:
1903 * @value: a #GVariant
1904 * @returns: the #GVariantClass of @value
1906 * Classifies @value according to its top-level type.
1912 * @G_VARIANT_CLASS_BOOLEAN: The #GVariant is a boolean.
1913 * @G_VARIANT_CLASS_BYTE: The #GVariant is a byte.
1914 * @G_VARIANT_CLASS_INT16: The #GVariant is a signed 16 bit integer.
1915 * @G_VARIANT_CLASS_UINT16: The #GVariant is an unsigned 16 bit integer.
1916 * @G_VARIANT_CLASS_INT32: The #GVariant is a signed 32 bit integer.
1917 * @G_VARIANT_CLASS_UINT32: The #GVariant is an unsigned 32 bit integer.
1918 * @G_VARIANT_CLASS_INT64: The #GVariant is a signed 64 bit integer.
1919 * @G_VARIANT_CLASS_UINT64: The #GVariant is an unsigned 64 bit integer.
1920 * @G_VARIANT_CLASS_HANDLE: The #GVariant is a file handle index.
1921 * @G_VARIANT_CLASS_DOUBLE: The #GVariant is a double precision floating
1923 * @G_VARIANT_CLASS_STRING: The #GVariant is a normal string.
1924 * @G_VARIANT_CLASS_OBJECT_PATH: The #GVariant is a D-Bus object path
1926 * @G_VARIANT_CLASS_SIGNATURE: The #GVariant is a D-Bus signature string.
1927 * @G_VARIANT_CLASS_VARIANT: The #GVariant is a variant.
1928 * @G_VARIANT_CLASS_MAYBE: The #GVariant is a maybe-typed value.
1929 * @G_VARIANT_CLASS_ARRAY: The #GVariant is an array.
1930 * @G_VARIANT_CLASS_TUPLE: The #GVariant is a tuple.
1931 * @G_VARIANT_CLASS_DICT_ENTRY: The #GVariant is a dictionary entry.
1933 * The range of possible top-level types of #GVariant instances.
1938 g_variant_classify (GVariant *value)
1940 g_return_val_if_fail (value != NULL, 0);
1942 return *g_variant_get_type_string (value);
1945 /* Pretty printer {{{1 */
1946 /* This function is not introspectable because if @string is NULL,
1947 @returns is (transfer full), otherwise it is (transfer none), which
1948 is not supported by GObjectIntrospection */
1950 * g_variant_print_string: (skip)
1951 * @value: a #GVariant
1952 * @string: (allow-none) (default NULL): a #GString, or %NULL
1953 * @type_annotate: %TRUE if type information should be included in
1955 * @returns: a #GString containing the string
1957 * Behaves as g_variant_print(), but operates on a #GString.
1959 * If @string is non-%NULL then it is appended to and returned. Else,
1960 * a new empty #GString is allocated and it is returned.
1965 g_variant_print_string (GVariant *value,
1967 gboolean type_annotate)
1969 if G_UNLIKELY (string == NULL)
1970 string = g_string_new (NULL);
1972 switch (g_variant_classify (value))
1974 case G_VARIANT_CLASS_MAYBE:
1976 g_string_append_printf (string, "@%s ",
1977 g_variant_get_type_string (value));
1979 if (g_variant_n_children (value))
1981 gchar *printed_child;
1986 * Consider the case of the type "mmi". In this case we could
1987 * write "just just 4", but "4" alone is totally unambiguous,
1988 * so we try to drop "just" where possible.
1990 * We have to be careful not to always drop "just", though,
1991 * since "nothing" needs to be distinguishable from "just
1992 * nothing". The case where we need to ensure we keep the
1993 * "just" is actually exactly the case where we have a nested
1996 * Instead of searching for that nested Nothing, we just print
1997 * the contained value into a separate string and see if we
1998 * end up with "nothing" at the end of it. If so, we need to
1999 * add "just" at our level.
2001 element = g_variant_get_child_value (value, 0);
2002 printed_child = g_variant_print (element, FALSE);
2003 g_variant_unref (element);
2005 if (g_str_has_suffix (printed_child, "nothing"))
2006 g_string_append (string, "just ");
2007 g_string_append (string, printed_child);
2008 g_free (printed_child);
2011 g_string_append (string, "nothing");
2015 case G_VARIANT_CLASS_ARRAY:
2016 /* it's an array so the first character of the type string is 'a'
2018 * if the first two characters are 'ay' then it's a bytestring.
2019 * under certain conditions we print those as strings.
2021 if (g_variant_get_type_string (value)[1] == 'y')
2027 /* first determine if it is a byte string.
2028 * that's when there's a single nul character: at the end.
2030 str = g_variant_get_data (value);
2031 size = g_variant_get_size (value);
2033 for (i = 0; i < size; i++)
2037 /* first nul byte is the last byte -> it's a byte string. */
2040 gchar *escaped = g_strescape (str, NULL);
2042 /* use double quotes only if a ' is in the string */
2043 if (strchr (str, '\''))
2044 g_string_append_printf (string, "b\"%s\"", escaped);
2046 g_string_append_printf (string, "b'%s'", escaped);
2053 /* fall through and handle normally... */;
2057 * if the first two characters are 'a{' then it's an array of
2058 * dictionary entries (ie: a dictionary) so we print that
2061 if (g_variant_get_type_string (value)[1] == '{')
2064 const gchar *comma = "";
2067 if ((n = g_variant_n_children (value)) == 0)
2070 g_string_append_printf (string, "@%s ",
2071 g_variant_get_type_string (value));
2072 g_string_append (string, "{}");
2076 g_string_append_c (string, '{');
2077 for (i = 0; i < n; i++)
2079 GVariant *entry, *key, *val;
2081 g_string_append (string, comma);
2084 entry = g_variant_get_child_value (value, i);
2085 key = g_variant_get_child_value (entry, 0);
2086 val = g_variant_get_child_value (entry, 1);
2087 g_variant_unref (entry);
2089 g_variant_print_string (key, string, type_annotate);
2090 g_variant_unref (key);
2091 g_string_append (string, ": ");
2092 g_variant_print_string (val, string, type_annotate);
2093 g_variant_unref (val);
2094 type_annotate = FALSE;
2096 g_string_append_c (string, '}');
2099 /* normal (non-dictionary) array */
2101 const gchar *comma = "";
2104 if ((n = g_variant_n_children (value)) == 0)
2107 g_string_append_printf (string, "@%s ",
2108 g_variant_get_type_string (value));
2109 g_string_append (string, "[]");
2113 g_string_append_c (string, '[');
2114 for (i = 0; i < n; i++)
2118 g_string_append (string, comma);
2121 element = g_variant_get_child_value (value, i);
2123 g_variant_print_string (element, string, type_annotate);
2124 g_variant_unref (element);
2125 type_annotate = FALSE;
2127 g_string_append_c (string, ']');
2132 case G_VARIANT_CLASS_TUPLE:
2136 n = g_variant_n_children (value);
2138 g_string_append_c (string, '(');
2139 for (i = 0; i < n; i++)
2143 element = g_variant_get_child_value (value, i);
2144 g_variant_print_string (element, string, type_annotate);
2145 g_string_append (string, ", ");
2146 g_variant_unref (element);
2149 /* for >1 item: remove final ", "
2150 * for 1 item: remove final " ", but leave the ","
2151 * for 0 items: there is only "(", so remove nothing
2153 g_string_truncate (string, string->len - (n > 0) - (n > 1));
2154 g_string_append_c (string, ')');
2158 case G_VARIANT_CLASS_DICT_ENTRY:
2162 g_string_append_c (string, '{');
2164 element = g_variant_get_child_value (value, 0);
2165 g_variant_print_string (element, string, type_annotate);
2166 g_variant_unref (element);
2168 g_string_append (string, ", ");
2170 element = g_variant_get_child_value (value, 1);
2171 g_variant_print_string (element, string, type_annotate);
2172 g_variant_unref (element);
2174 g_string_append_c (string, '}');
2178 case G_VARIANT_CLASS_VARIANT:
2180 GVariant *child = g_variant_get_variant (value);
2182 /* Always annotate types in nested variants, because they are
2183 * (by nature) of variable type.
2185 g_string_append_c (string, '<');
2186 g_variant_print_string (child, string, TRUE);
2187 g_string_append_c (string, '>');
2189 g_variant_unref (child);
2193 case G_VARIANT_CLASS_BOOLEAN:
2194 if (g_variant_get_boolean (value))
2195 g_string_append (string, "true");
2197 g_string_append (string, "false");
2200 case G_VARIANT_CLASS_STRING:
2202 const gchar *str = g_variant_get_string (value, NULL);
2203 gunichar quote = strchr (str, '\'') ? '"' : '\'';
2205 g_string_append_c (string, quote);
2209 gunichar c = g_utf8_get_char (str);
2211 if (c == quote || c == '\\')
2212 g_string_append_c (string, '\\');
2214 if (g_unichar_isprint (c))
2215 g_string_append_unichar (string, c);
2219 g_string_append_c (string, '\\');
2224 g_string_append_c (string, 'a');
2228 g_string_append_c (string, 'b');
2232 g_string_append_c (string, 'f');
2236 g_string_append_c (string, 'n');
2240 g_string_append_c (string, 'r');
2244 g_string_append_c (string, 't');
2248 g_string_append_c (string, 'v');
2252 g_string_append_printf (string, "u%04x", c);
2256 g_string_append_printf (string, "U%08x", c);
2259 str = g_utf8_next_char (str);
2262 g_string_append_c (string, quote);
2266 case G_VARIANT_CLASS_BYTE:
2268 g_string_append (string, "byte ");
2269 g_string_append_printf (string, "0x%02x",
2270 g_variant_get_byte (value));
2273 case G_VARIANT_CLASS_INT16:
2275 g_string_append (string, "int16 ");
2276 g_string_append_printf (string, "%"G_GINT16_FORMAT,
2277 g_variant_get_int16 (value));
2280 case G_VARIANT_CLASS_UINT16:
2282 g_string_append (string, "uint16 ");
2283 g_string_append_printf (string, "%"G_GUINT16_FORMAT,
2284 g_variant_get_uint16 (value));
2287 case G_VARIANT_CLASS_INT32:
2288 /* Never annotate this type because it is the default for numbers
2289 * (and this is a *pretty* printer)
2291 g_string_append_printf (string, "%"G_GINT32_FORMAT,
2292 g_variant_get_int32 (value));
2295 case G_VARIANT_CLASS_HANDLE:
2297 g_string_append (string, "handle ");
2298 g_string_append_printf (string, "%"G_GINT32_FORMAT,
2299 g_variant_get_handle (value));
2302 case G_VARIANT_CLASS_UINT32:
2304 g_string_append (string, "uint32 ");
2305 g_string_append_printf (string, "%"G_GUINT32_FORMAT,
2306 g_variant_get_uint32 (value));
2309 case G_VARIANT_CLASS_INT64:
2311 g_string_append (string, "int64 ");
2312 g_string_append_printf (string, "%"G_GINT64_FORMAT,
2313 g_variant_get_int64 (value));
2316 case G_VARIANT_CLASS_UINT64:
2318 g_string_append (string, "uint64 ");
2319 g_string_append_printf (string, "%"G_GUINT64_FORMAT,
2320 g_variant_get_uint64 (value));
2323 case G_VARIANT_CLASS_DOUBLE:
2328 g_ascii_dtostr (buffer, sizeof buffer, g_variant_get_double (value));
2330 for (i = 0; buffer[i]; i++)
2331 if (buffer[i] == '.' || buffer[i] == 'e' ||
2332 buffer[i] == 'n' || buffer[i] == 'N')
2335 /* if there is no '.' or 'e' in the float then add one */
2336 if (buffer[i] == '\0')
2343 g_string_append (string, buffer);
2347 case G_VARIANT_CLASS_OBJECT_PATH:
2349 g_string_append (string, "objectpath ");
2350 g_string_append_printf (string, "\'%s\'",
2351 g_variant_get_string (value, NULL));
2354 case G_VARIANT_CLASS_SIGNATURE:
2356 g_string_append (string, "signature ");
2357 g_string_append_printf (string, "\'%s\'",
2358 g_variant_get_string (value, NULL));
2362 g_assert_not_reached ();
2370 * @value: a #GVariant
2371 * @type_annotate: %TRUE if type information should be included in
2373 * @returns: (transfer full): a newly-allocated string holding the result.
2375 * Pretty-prints @value in the format understood by g_variant_parse().
2377 * The format is described <link linkend='gvariant-text'>here</link>.
2379 * If @type_annotate is %TRUE, then type information is included in
2383 g_variant_print (GVariant *value,
2384 gboolean type_annotate)
2386 return g_string_free (g_variant_print_string (value, NULL, type_annotate),
2390 /* Hash, Equal, Compare {{{1 */
2393 * @value: (type GVariant): a basic #GVariant value as a #gconstpointer
2394 * @returns: a hash value corresponding to @value
2396 * Generates a hash value for a #GVariant instance.
2398 * The output of this function is guaranteed to be the same for a given
2399 * value only per-process. It may change between different processor
2400 * architectures or even different versions of GLib. Do not use this
2401 * function as a basis for building protocols or file formats.
2403 * The type of @value is #gconstpointer only to allow use of this
2404 * function with #GHashTable. @value must be a #GVariant.
2409 g_variant_hash (gconstpointer value_)
2411 GVariant *value = (GVariant *) value_;
2413 switch (g_variant_classify (value))
2415 case G_VARIANT_CLASS_STRING:
2416 case G_VARIANT_CLASS_OBJECT_PATH:
2417 case G_VARIANT_CLASS_SIGNATURE:
2418 return g_str_hash (g_variant_get_string (value, NULL));
2420 case G_VARIANT_CLASS_BOOLEAN:
2421 /* this is a very odd thing to hash... */
2422 return g_variant_get_boolean (value);
2424 case G_VARIANT_CLASS_BYTE:
2425 return g_variant_get_byte (value);
2427 case G_VARIANT_CLASS_INT16:
2428 case G_VARIANT_CLASS_UINT16:
2432 ptr = g_variant_get_data (value);
2440 case G_VARIANT_CLASS_INT32:
2441 case G_VARIANT_CLASS_UINT32:
2442 case G_VARIANT_CLASS_HANDLE:
2446 ptr = g_variant_get_data (value);
2454 case G_VARIANT_CLASS_INT64:
2455 case G_VARIANT_CLASS_UINT64:
2456 case G_VARIANT_CLASS_DOUBLE:
2457 /* need a separate case for these guys because otherwise
2458 * performance could be quite bad on big endian systems
2463 ptr = g_variant_get_data (value);
2466 return ptr[0] + ptr[1];
2472 g_return_val_if_fail (!g_variant_is_container (value), 0);
2473 g_assert_not_reached ();
2479 * @one: (type GVariant): a #GVariant instance
2480 * @two: (type GVariant): a #GVariant instance
2481 * @returns: %TRUE if @one and @two are equal
2483 * Checks if @one and @two have the same type and value.
2485 * The types of @one and @two are #gconstpointer only to allow use of
2486 * this function with #GHashTable. They must each be a #GVariant.
2491 g_variant_equal (gconstpointer one,
2496 g_return_val_if_fail (one != NULL && two != NULL, FALSE);
2498 if (g_variant_get_type_info ((GVariant *) one) !=
2499 g_variant_get_type_info ((GVariant *) two))
2502 /* if both values are trusted to be in their canonical serialised form
2503 * then a simple memcmp() of their serialised data will answer the
2506 * if not, then this might generate a false negative (since it is
2507 * possible for two different byte sequences to represent the same
2508 * value). for now we solve this by pretty-printing both values and
2509 * comparing the result.
2511 if (g_variant_is_trusted ((GVariant *) one) &&
2512 g_variant_is_trusted ((GVariant *) two))
2514 gconstpointer data_one, data_two;
2515 gsize size_one, size_two;
2517 size_one = g_variant_get_size ((GVariant *) one);
2518 size_two = g_variant_get_size ((GVariant *) two);
2520 if (size_one != size_two)
2523 data_one = g_variant_get_data ((GVariant *) one);
2524 data_two = g_variant_get_data ((GVariant *) two);
2526 equal = memcmp (data_one, data_two, size_one) == 0;
2530 gchar *strone, *strtwo;
2532 strone = g_variant_print ((GVariant *) one, FALSE);
2533 strtwo = g_variant_print ((GVariant *) two, FALSE);
2534 equal = strcmp (strone, strtwo) == 0;
2543 * g_variant_compare:
2544 * @one: (type GVariant): a basic-typed #GVariant instance
2545 * @two: (type GVariant): a #GVariant instance of the same type
2546 * @returns: negative value if a < b;
2548 * positive value if a > b.
2550 * Compares @one and @two.
2552 * The types of @one and @two are #gconstpointer only to allow use of
2553 * this function with #GTree, #GPtrArray, etc. They must each be a
2556 * Comparison is only defined for basic types (ie: booleans, numbers,
2557 * strings). For booleans, %FALSE is less than %TRUE. Numbers are
2558 * ordered in the usual way. Strings are in ASCII lexographical order.
2560 * It is a programmer error to attempt to compare container values or
2561 * two values that have types that are not exactly equal. For example,
2562 * you cannot compare a 32-bit signed integer with a 32-bit unsigned
2563 * integer. Also note that this function is not particularly
2564 * well-behaved when it comes to comparison of doubles; in particular,
2565 * the handling of incomparable values (ie: NaN) is undefined.
2567 * If you only require an equality comparison, g_variant_equal() is more
2573 g_variant_compare (gconstpointer one,
2576 GVariant *a = (GVariant *) one;
2577 GVariant *b = (GVariant *) two;
2579 g_return_val_if_fail (g_variant_classify (a) == g_variant_classify (b), 0);
2581 switch (g_variant_classify (a))
2583 case G_VARIANT_CLASS_BYTE:
2584 return ((gint) g_variant_get_byte (a)) -
2585 ((gint) g_variant_get_byte (b));
2587 case G_VARIANT_CLASS_INT16:
2588 return ((gint) g_variant_get_int16 (a)) -
2589 ((gint) g_variant_get_int16 (b));
2591 case G_VARIANT_CLASS_UINT16:
2592 return ((gint) g_variant_get_uint16 (a)) -
2593 ((gint) g_variant_get_uint16 (b));
2595 case G_VARIANT_CLASS_INT32:
2597 gint32 a_val = g_variant_get_int32 (a);
2598 gint32 b_val = g_variant_get_int32 (b);
2600 return (a_val == b_val) ? 0 : (a_val > b_val) ? 1 : -1;
2603 case G_VARIANT_CLASS_UINT32:
2605 guint32 a_val = g_variant_get_uint32 (a);
2606 guint32 b_val = g_variant_get_uint32 (b);
2608 return (a_val == b_val) ? 0 : (a_val > b_val) ? 1 : -1;
2611 case G_VARIANT_CLASS_INT64:
2613 gint64 a_val = g_variant_get_int64 (a);
2614 gint64 b_val = g_variant_get_int64 (b);
2616 return (a_val == b_val) ? 0 : (a_val > b_val) ? 1 : -1;
2619 case G_VARIANT_CLASS_UINT64:
2621 guint64 a_val = g_variant_get_uint64 (a);
2622 guint64 b_val = g_variant_get_uint64 (b);
2624 return (a_val == b_val) ? 0 : (a_val > b_val) ? 1 : -1;
2627 case G_VARIANT_CLASS_DOUBLE:
2629 gdouble a_val = g_variant_get_double (a);
2630 gdouble b_val = g_variant_get_double (b);
2632 return (a_val == b_val) ? 0 : (a_val > b_val) ? 1 : -1;
2635 case G_VARIANT_CLASS_STRING:
2636 case G_VARIANT_CLASS_OBJECT_PATH:
2637 case G_VARIANT_CLASS_SIGNATURE:
2638 return strcmp (g_variant_get_string (a, NULL),
2639 g_variant_get_string (b, NULL));
2642 g_return_val_if_fail (!g_variant_is_container (a), 0);
2643 g_assert_not_reached ();
2647 /* GVariantIter {{{1 */
2649 * GVariantIter: (skip)
2651 * #GVariantIter is an opaque data structure and can only be accessed
2652 * using the following functions.
2659 const gchar *loop_format;
2665 G_STATIC_ASSERT (sizeof (struct stack_iter) <= sizeof (GVariantIter));
2669 struct stack_iter iter;
2671 GVariant *value_ref;
2675 #define GVSI(i) ((struct stack_iter *) (i))
2676 #define GVHI(i) ((struct heap_iter *) (i))
2677 #define GVSI_MAGIC ((gsize) 3579507750u)
2678 #define GVHI_MAGIC ((gsize) 1450270775u)
2679 #define is_valid_iter(i) (i != NULL && \
2680 GVSI(i)->magic == GVSI_MAGIC)
2681 #define is_valid_heap_iter(i) (GVHI(i)->magic == GVHI_MAGIC && \
2685 * g_variant_iter_new:
2686 * @value: a container #GVariant
2687 * @returns: (transfer full): a new heap-allocated #GVariantIter
2689 * Creates a heap-allocated #GVariantIter for iterating over the items
2692 * Use g_variant_iter_free() to free the return value when you no longer
2695 * A reference is taken to @value and will be released only when
2696 * g_variant_iter_free() is called.
2701 g_variant_iter_new (GVariant *value)
2705 iter = (GVariantIter *) g_slice_new (struct heap_iter);
2706 GVHI(iter)->value_ref = g_variant_ref (value);
2707 GVHI(iter)->magic = GVHI_MAGIC;
2709 g_variant_iter_init (iter, value);
2715 * g_variant_iter_init: (skip)
2716 * @iter: a pointer to a #GVariantIter
2717 * @value: a container #GVariant
2718 * @returns: the number of items in @value
2720 * Initialises (without allocating) a #GVariantIter. @iter may be
2721 * completely uninitialised prior to this call; its old value is
2724 * The iterator remains valid for as long as @value exists, and need not
2725 * be freed in any way.
2730 g_variant_iter_init (GVariantIter *iter,
2733 GVSI(iter)->magic = GVSI_MAGIC;
2734 GVSI(iter)->value = value;
2735 GVSI(iter)->n = g_variant_n_children (value);
2737 GVSI(iter)->loop_format = NULL;
2739 return GVSI(iter)->n;
2743 * g_variant_iter_copy:
2744 * @iter: a #GVariantIter
2745 * @returns: (transfer full): a new heap-allocated #GVariantIter
2747 * Creates a new heap-allocated #GVariantIter to iterate over the
2748 * container that was being iterated over by @iter. Iteration begins on
2749 * the new iterator from the current position of the old iterator but
2750 * the two copies are independent past that point.
2752 * Use g_variant_iter_free() to free the return value when you no longer
2755 * A reference is taken to the container that @iter is iterating over
2756 * and will be releated only when g_variant_iter_free() is called.
2761 g_variant_iter_copy (GVariantIter *iter)
2765 g_return_val_if_fail (is_valid_iter (iter), 0);
2767 copy = g_variant_iter_new (GVSI(iter)->value);
2768 GVSI(copy)->i = GVSI(iter)->i;
2774 * g_variant_iter_n_children:
2775 * @iter: a #GVariantIter
2776 * @returns: the number of children in the container
2778 * Queries the number of child items in the container that we are
2779 * iterating over. This is the total number of items -- not the number
2780 * of items remaining.
2782 * This function might be useful for preallocation of arrays.
2787 g_variant_iter_n_children (GVariantIter *iter)
2789 g_return_val_if_fail (is_valid_iter (iter), 0);
2791 return GVSI(iter)->n;
2795 * g_variant_iter_free:
2796 * @iter: (transfer full): a heap-allocated #GVariantIter
2798 * Frees a heap-allocated #GVariantIter. Only call this function on
2799 * iterators that were returned by g_variant_iter_new() or
2800 * g_variant_iter_copy().
2805 g_variant_iter_free (GVariantIter *iter)
2807 g_return_if_fail (is_valid_heap_iter (iter));
2809 g_variant_unref (GVHI(iter)->value_ref);
2810 GVHI(iter)->magic = 0;
2812 g_slice_free (struct heap_iter, GVHI(iter));
2816 * g_variant_iter_next_value:
2817 * @iter: a #GVariantIter
2818 * @returns: (allow-none) (transfer full): a #GVariant, or %NULL
2820 * Gets the next item in the container. If no more items remain then
2821 * %NULL is returned.
2823 * Use g_variant_unref() to drop your reference on the return value when
2824 * you no longer need it.
2827 * <title>Iterating with g_variant_iter_next_value()</title>
2829 * /<!-- -->* recursively iterate a container *<!-- -->/
2831 * iterate_container_recursive (GVariant *container)
2833 * GVariantIter iter;
2836 * g_variant_iter_init (&iter, container);
2837 * while ((child = g_variant_iter_next_value (&iter)))
2839 * g_print ("type '%s'\n", g_variant_get_type_string (child));
2841 * if (g_variant_is_container (child))
2842 * iterate_container_recursive (child);
2844 * g_variant_unref (child);
2853 g_variant_iter_next_value (GVariantIter *iter)
2855 g_return_val_if_fail (is_valid_iter (iter), FALSE);
2857 if G_UNLIKELY (GVSI(iter)->i >= GVSI(iter)->n)
2859 g_critical ("g_variant_iter_next_value: must not be called again "
2860 "after NULL has already been returned.");
2866 if (GVSI(iter)->i < GVSI(iter)->n)
2867 return g_variant_get_child_value (GVSI(iter)->value, GVSI(iter)->i);
2872 /* GVariantBuilder {{{1 */
2876 * A utility type for constructing container-type #GVariant instances.
2878 * This is an opaque structure and may only be accessed using the
2879 * following functions.
2881 * #GVariantBuilder is not threadsafe in any way. Do not attempt to
2882 * access it from more than one thread.
2885 struct stack_builder
2887 GVariantBuilder *parent;
2890 /* type constraint explicitly specified by 'type'.
2891 * for tuple types, this moves along as we add more items.
2893 const GVariantType *expected_type;
2895 /* type constraint implied by previous array item.
2897 const GVariantType *prev_item_type;
2899 /* constraints on the number of children. max = -1 for unlimited. */
2903 /* dynamically-growing pointer array */
2904 GVariant **children;
2905 gsize allocated_children;
2908 /* set to '1' if all items in the container will have the same type
2909 * (ie: maybe, array, variant) '0' if not (ie: tuple, dict entry)
2911 guint uniform_item_types : 1;
2913 /* set to '1' initially and changed to '0' if an untrusted value is
2921 G_STATIC_ASSERT (sizeof (struct stack_builder) <= sizeof (GVariantBuilder));
2925 GVariantBuilder builder;
2931 #define GVSB(b) ((struct stack_builder *) (b))
2932 #define GVHB(b) ((struct heap_builder *) (b))
2933 #define GVSB_MAGIC ((gsize) 1033660112u)
2934 #define GVHB_MAGIC ((gsize) 3087242682u)
2935 #define is_valid_builder(b) (b != NULL && \
2936 GVSB(b)->magic == GVSB_MAGIC)
2937 #define is_valid_heap_builder(b) (GVHB(b)->magic == GVHB_MAGIC)
2940 * g_variant_builder_new:
2941 * @type: a container type
2942 * @returns: (transfer full): a #GVariantBuilder
2944 * Allocates and initialises a new #GVariantBuilder.
2946 * You should call g_variant_builder_unref() on the return value when it
2947 * is no longer needed. The memory will not be automatically freed by
2950 * In most cases it is easier to place a #GVariantBuilder directly on
2951 * the stack of the calling function and initialise it with
2952 * g_variant_builder_init().
2957 g_variant_builder_new (const GVariantType *type)
2959 GVariantBuilder *builder;
2961 builder = (GVariantBuilder *) g_slice_new (struct heap_builder);
2962 g_variant_builder_init (builder, type);
2963 GVHB(builder)->magic = GVHB_MAGIC;
2964 GVHB(builder)->ref_count = 1;
2970 * g_variant_builder_unref:
2971 * @builder: (transfer full): a #GVariantBuilder allocated by g_variant_builder_new()
2973 * Decreases the reference count on @builder.
2975 * In the event that there are no more references, releases all memory
2976 * associated with the #GVariantBuilder.
2978 * Don't call this on stack-allocated #GVariantBuilder instances or bad
2979 * things will happen.
2984 g_variant_builder_unref (GVariantBuilder *builder)
2986 g_return_if_fail (is_valid_heap_builder (builder));
2988 if (--GVHB(builder)->ref_count)
2991 g_variant_builder_clear (builder);
2992 GVHB(builder)->magic = 0;
2994 g_slice_free (struct heap_builder, GVHB(builder));
2998 * g_variant_builder_ref:
2999 * @builder: a #GVariantBuilder allocated by g_variant_builder_new()
3000 * @returns: (transfer full): a new reference to @builder
3002 * Increases the reference count on @builder.
3004 * Don't call this on stack-allocated #GVariantBuilder instances or bad
3005 * things will happen.
3010 g_variant_builder_ref (GVariantBuilder *builder)
3012 g_return_val_if_fail (is_valid_heap_builder (builder), NULL);
3014 GVHB(builder)->ref_count++;
3020 * g_variant_builder_clear: (skip)
3021 * @builder: a #GVariantBuilder
3023 * Releases all memory associated with a #GVariantBuilder without
3024 * freeing the #GVariantBuilder structure itself.
3026 * It typically only makes sense to do this on a stack-allocated
3027 * #GVariantBuilder if you want to abort building the value part-way
3028 * through. This function need not be called if you call
3029 * g_variant_builder_end() and it also doesn't need to be called on
3030 * builders allocated with g_variant_builder_new (see
3031 * g_variant_builder_unref() for that).
3033 * This function leaves the #GVariantBuilder structure set to all-zeros.
3034 * It is valid to call this function on either an initialised
3035 * #GVariantBuilder or one that is set to all-zeros but it is not valid
3036 * to call this function on uninitialised memory.
3041 g_variant_builder_clear (GVariantBuilder *builder)
3045 if (GVSB(builder)->magic == 0)
3046 /* all-zeros case */
3049 g_return_if_fail (is_valid_builder (builder));
3051 g_variant_type_free (GVSB(builder)->type);
3053 for (i = 0; i < GVSB(builder)->offset; i++)
3054 g_variant_unref (GVSB(builder)->children[i]);
3056 g_free (GVSB(builder)->children);
3058 if (GVSB(builder)->parent)
3060 g_variant_builder_clear (GVSB(builder)->parent);
3061 g_slice_free (GVariantBuilder, GVSB(builder)->parent);
3064 memset (builder, 0, sizeof (GVariantBuilder));
3068 * g_variant_builder_init: (skip)
3069 * @builder: a #GVariantBuilder
3070 * @type: a container type
3072 * Initialises a #GVariantBuilder structure.
3074 * @type must be non-%NULL. It specifies the type of container to
3075 * construct. It can be an indefinite type such as
3076 * %G_VARIANT_TYPE_ARRAY or a definite type such as "as" or "(ii)".
3077 * Maybe, array, tuple, dictionary entry and variant-typed values may be
3080 * After the builder is initialised, values are added using
3081 * g_variant_builder_add_value() or g_variant_builder_add().
3083 * After all the child values are added, g_variant_builder_end() frees
3084 * the memory associated with the builder and returns the #GVariant that
3087 * This function completely ignores the previous contents of @builder.
3088 * On one hand this means that it is valid to pass in completely
3089 * uninitialised memory. On the other hand, this means that if you are
3090 * initialising over top of an existing #GVariantBuilder you need to
3091 * first call g_variant_builder_clear() in order to avoid leaking
3094 * You must not call g_variant_builder_ref() or
3095 * g_variant_builder_unref() on a #GVariantBuilder that was initialised
3096 * with this function. If you ever pass a reference to a
3097 * #GVariantBuilder outside of the control of your own code then you
3098 * should assume that the person receiving that reference may try to use
3099 * reference counting; you should use g_variant_builder_new() instead of
3105 g_variant_builder_init (GVariantBuilder *builder,
3106 const GVariantType *type)
3108 g_return_if_fail (type != NULL);
3109 g_return_if_fail (g_variant_type_is_container (type));
3111 memset (builder, 0, sizeof (GVariantBuilder));
3113 GVSB(builder)->type = g_variant_type_copy (type);
3114 GVSB(builder)->magic = GVSB_MAGIC;
3115 GVSB(builder)->trusted = TRUE;
3117 switch (*(const gchar *) type)
3119 case G_VARIANT_CLASS_VARIANT:
3120 GVSB(builder)->uniform_item_types = TRUE;
3121 GVSB(builder)->allocated_children = 1;
3122 GVSB(builder)->expected_type = NULL;
3123 GVSB(builder)->min_items = 1;
3124 GVSB(builder)->max_items = 1;
3127 case G_VARIANT_CLASS_ARRAY:
3128 GVSB(builder)->uniform_item_types = TRUE;
3129 GVSB(builder)->allocated_children = 8;
3130 GVSB(builder)->expected_type =
3131 g_variant_type_element (GVSB(builder)->type);
3132 GVSB(builder)->min_items = 0;
3133 GVSB(builder)->max_items = -1;
3136 case G_VARIANT_CLASS_MAYBE:
3137 GVSB(builder)->uniform_item_types = TRUE;
3138 GVSB(builder)->allocated_children = 1;
3139 GVSB(builder)->expected_type =
3140 g_variant_type_element (GVSB(builder)->type);
3141 GVSB(builder)->min_items = 0;
3142 GVSB(builder)->max_items = 1;
3145 case G_VARIANT_CLASS_DICT_ENTRY:
3146 GVSB(builder)->uniform_item_types = FALSE;
3147 GVSB(builder)->allocated_children = 2;
3148 GVSB(builder)->expected_type =
3149 g_variant_type_key (GVSB(builder)->type);
3150 GVSB(builder)->min_items = 2;
3151 GVSB(builder)->max_items = 2;
3154 case 'r': /* G_VARIANT_TYPE_TUPLE was given */
3155 GVSB(builder)->uniform_item_types = FALSE;
3156 GVSB(builder)->allocated_children = 8;
3157 GVSB(builder)->expected_type = NULL;
3158 GVSB(builder)->min_items = 0;
3159 GVSB(builder)->max_items = -1;
3162 case G_VARIANT_CLASS_TUPLE: /* a definite tuple type was given */
3163 GVSB(builder)->allocated_children = g_variant_type_n_items (type);
3164 GVSB(builder)->expected_type =
3165 g_variant_type_first (GVSB(builder)->type);
3166 GVSB(builder)->min_items = GVSB(builder)->allocated_children;
3167 GVSB(builder)->max_items = GVSB(builder)->allocated_children;
3168 GVSB(builder)->uniform_item_types = FALSE;
3172 g_assert_not_reached ();
3175 GVSB(builder)->children = g_new (GVariant *,
3176 GVSB(builder)->allocated_children);
3180 g_variant_builder_make_room (struct stack_builder *builder)
3182 if (builder->offset == builder->allocated_children)
3184 builder->allocated_children *= 2;
3185 builder->children = g_renew (GVariant *, builder->children,
3186 builder->allocated_children);
3191 * g_variant_builder_add_value:
3192 * @builder: a #GVariantBuilder
3193 * @value: a #GVariant
3195 * Adds @value to @builder.
3197 * It is an error to call this function in any way that would create an
3198 * inconsistent value to be constructed. Some examples of this are
3199 * putting different types of items into an array, putting the wrong
3200 * types or number of items in a tuple, putting more than one value into
3203 * If @value is a floating reference (see g_variant_ref_sink()),
3204 * the @builder instance takes ownership of @value.
3209 g_variant_builder_add_value (GVariantBuilder *builder,
3212 g_return_if_fail (is_valid_builder (builder));
3213 g_return_if_fail (GVSB(builder)->offset < GVSB(builder)->max_items);
3214 g_return_if_fail (!GVSB(builder)->expected_type ||
3215 g_variant_is_of_type (value,
3216 GVSB(builder)->expected_type));
3217 g_return_if_fail (!GVSB(builder)->prev_item_type ||
3218 g_variant_is_of_type (value,
3219 GVSB(builder)->prev_item_type));
3221 GVSB(builder)->trusted &= g_variant_is_trusted (value);
3223 if (!GVSB(builder)->uniform_item_types)
3225 /* advance our expected type pointers */
3226 if (GVSB(builder)->expected_type)
3227 GVSB(builder)->expected_type =
3228 g_variant_type_next (GVSB(builder)->expected_type);
3230 if (GVSB(builder)->prev_item_type)
3231 GVSB(builder)->prev_item_type =
3232 g_variant_type_next (GVSB(builder)->prev_item_type);
3235 GVSB(builder)->prev_item_type = g_variant_get_type (value);
3237 g_variant_builder_make_room (GVSB(builder));
3239 GVSB(builder)->children[GVSB(builder)->offset++] =
3240 g_variant_ref_sink (value);
3244 * g_variant_builder_open:
3245 * @builder: a #GVariantBuilder
3246 * @type: a #GVariantType
3248 * Opens a subcontainer inside the given @builder. When done adding
3249 * items to the subcontainer, g_variant_builder_close() must be called.
3251 * It is an error to call this function in any way that would cause an
3252 * inconsistent value to be constructed (ie: adding too many values or
3253 * a value of an incorrect type).
3258 g_variant_builder_open (GVariantBuilder *builder,
3259 const GVariantType *type)
3261 GVariantBuilder *parent;
3263 g_return_if_fail (is_valid_builder (builder));
3264 g_return_if_fail (GVSB(builder)->offset < GVSB(builder)->max_items);
3265 g_return_if_fail (!GVSB(builder)->expected_type ||
3266 g_variant_type_is_subtype_of (type,
3267 GVSB(builder)->expected_type));
3268 g_return_if_fail (!GVSB(builder)->prev_item_type ||
3269 g_variant_type_is_subtype_of (GVSB(builder)->prev_item_type,
3272 parent = g_slice_dup (GVariantBuilder, builder);
3273 g_variant_builder_init (builder, type);
3274 GVSB(builder)->parent = parent;
3276 /* push the prev_item_type down into the subcontainer */
3277 if (GVSB(parent)->prev_item_type)
3279 if (!GVSB(builder)->uniform_item_types)
3280 /* tuples and dict entries */
3281 GVSB(builder)->prev_item_type =
3282 g_variant_type_first (GVSB(parent)->prev_item_type);
3284 else if (!g_variant_type_is_variant (GVSB(builder)->type))
3285 /* maybes and arrays */
3286 GVSB(builder)->prev_item_type =
3287 g_variant_type_element (GVSB(parent)->prev_item_type);
3292 * g_variant_builder_close:
3293 * @builder: a #GVariantBuilder
3295 * Closes the subcontainer inside the given @builder that was opened by
3296 * the most recent call to g_variant_builder_open().
3298 * It is an error to call this function in any way that would create an
3299 * inconsistent value to be constructed (ie: too few values added to the
3305 g_variant_builder_close (GVariantBuilder *builder)
3307 GVariantBuilder *parent;
3309 g_return_if_fail (is_valid_builder (builder));
3310 g_return_if_fail (GVSB(builder)->parent != NULL);
3312 parent = GVSB(builder)->parent;
3313 GVSB(builder)->parent = NULL;
3315 g_variant_builder_add_value (parent, g_variant_builder_end (builder));
3318 g_slice_free (GVariantBuilder, parent);
3322 * g_variant_make_maybe_type:
3323 * @element: a #GVariant
3325 * Return the type of a maybe containing @element.
3327 static GVariantType *
3328 g_variant_make_maybe_type (GVariant *element)
3330 return g_variant_type_new_maybe (g_variant_get_type (element));
3334 * g_variant_make_array_type:
3335 * @element: a #GVariant
3337 * Return the type of an array containing @element.
3339 static GVariantType *
3340 g_variant_make_array_type (GVariant *element)
3342 return g_variant_type_new_array (g_variant_get_type (element));
3346 * g_variant_builder_end:
3347 * @builder: a #GVariantBuilder
3348 * @returns: (transfer none): a new, floating, #GVariant
3350 * Ends the builder process and returns the constructed value.
3352 * It is not permissible to use @builder in any way after this call
3353 * except for reference counting operations (in the case of a
3354 * heap-allocated #GVariantBuilder) or by reinitialising it with
3355 * g_variant_builder_init() (in the case of stack-allocated).
3357 * It is an error to call this function in any way that would create an
3358 * inconsistent value to be constructed (ie: insufficient number of
3359 * items added to a container with a specific number of children
3360 * required). It is also an error to call this function if the builder
3361 * was created with an indefinite array or maybe type and no children
3362 * have been added; in this case it is impossible to infer the type of
3368 g_variant_builder_end (GVariantBuilder *builder)
3370 GVariantType *my_type;
3373 g_return_val_if_fail (is_valid_builder (builder), NULL);
3374 g_return_val_if_fail (GVSB(builder)->offset >= GVSB(builder)->min_items,
3376 g_return_val_if_fail (!GVSB(builder)->uniform_item_types ||
3377 GVSB(builder)->prev_item_type != NULL ||
3378 g_variant_type_is_definite (GVSB(builder)->type),
3381 if (g_variant_type_is_definite (GVSB(builder)->type))
3382 my_type = g_variant_type_copy (GVSB(builder)->type);
3384 else if (g_variant_type_is_maybe (GVSB(builder)->type))
3385 my_type = g_variant_make_maybe_type (GVSB(builder)->children[0]);
3387 else if (g_variant_type_is_array (GVSB(builder)->type))
3388 my_type = g_variant_make_array_type (GVSB(builder)->children[0]);
3390 else if (g_variant_type_is_tuple (GVSB(builder)->type))
3391 my_type = g_variant_make_tuple_type (GVSB(builder)->children,
3392 GVSB(builder)->offset);
3394 else if (g_variant_type_is_dict_entry (GVSB(builder)->type))
3395 my_type = g_variant_make_dict_entry_type (GVSB(builder)->children[0],
3396 GVSB(builder)->children[1]);
3398 g_assert_not_reached ();
3400 value = g_variant_new_from_children (my_type,
3401 g_renew (GVariant *,
3402 GVSB(builder)->children,
3403 GVSB(builder)->offset),
3404 GVSB(builder)->offset,
3405 GVSB(builder)->trusted);
3406 GVSB(builder)->children = NULL;
3407 GVSB(builder)->offset = 0;
3409 g_variant_builder_clear (builder);
3410 g_variant_type_free (my_type);
3415 /* Format strings {{{1 */
3417 * g_variant_format_string_scan:
3418 * @string: a string that may be prefixed with a format string
3419 * @limit: (allow-none) (default NULL): a pointer to the end of @string,
3421 * @endptr: (allow-none) (default NULL): location to store the end pointer,
3423 * @returns: %TRUE if there was a valid format string
3425 * Checks the string pointed to by @string for starting with a properly
3426 * formed #GVariant varargs format string. If no valid format string is
3427 * found then %FALSE is returned.
3429 * If @string does start with a valid format string then %TRUE is
3430 * returned. If @endptr is non-%NULL then it is updated to point to the
3431 * first character after the format string.
3433 * If @limit is non-%NULL then @limit (and any charater after it) will
3434 * not be accessed and the effect is otherwise equivalent to if the
3435 * character at @limit were nul.
3437 * See the section on <link linkend='gvariant-format-strings'>GVariant
3438 * Format Strings</link>.
3443 g_variant_format_string_scan (const gchar *string,
3445 const gchar **endptr)
3447 #define next_char() (string == limit ? '\0' : *string++)
3448 #define peek_char() (string == limit ? '\0' : *string)
3451 switch (next_char())
3453 case 'b': case 'y': case 'n': case 'q': case 'i': case 'u':
3454 case 'x': case 't': case 'h': case 'd': case 's': case 'o':
3455 case 'g': case 'v': case '*': case '?': case 'r':
3459 return g_variant_format_string_scan (string, limit, endptr);
3463 return g_variant_type_string_scan (string, limit, endptr);
3466 while (peek_char() != ')')
3467 if (!g_variant_format_string_scan (string, limit, &string))
3470 next_char(); /* consume ')' */
3480 if (c != 's' && c != 'o' && c != 'g')
3488 /* ISO/IEC 9899:1999 (C99) §7.21.5.2:
3489 * The terminating null character is considered to be
3490 * part of the string.
3492 if (c != '\0' && strchr ("bynqiuxthdsog?", c) == NULL)
3496 if (!g_variant_format_string_scan (string, limit, &string))
3499 if (next_char() != '}')
3505 if ((c = next_char()) == 'a')
3507 if ((c = next_char()) == '&')
3509 if ((c = next_char()) == 'a')
3511 if ((c = next_char()) == 'y')
3512 break; /* '^a&ay' */
3515 else if (c == 's' || c == 'o')
3516 break; /* '^a&s', '^a&o' */
3521 if ((c = next_char()) == 'y')
3525 else if (c == 's' || c == 'o')
3526 break; /* '^as', '^ao' */
3533 if ((c = next_char()) == 'a')
3535 if ((c = next_char()) == 'y')
3545 if (c != 's' && c != 'o' && c != 'g')
3564 * g_variant_format_string_scan_type:
3565 * @string: a string that may be prefixed with a format string
3566 * @limit: (allow-none) (default NULL): a pointer to the end of @string,
3568 * @endptr: (allow-none) (default NULL): location to store the end pointer,
3570 * @returns: (allow-none): a #GVariantType if there was a valid format string
3572 * If @string starts with a valid format string then this function will
3573 * return the type that the format string corresponds to. Otherwise
3574 * this function returns %NULL.
3576 * Use g_variant_type_free() to free the return value when you no longer
3579 * This function is otherwise exactly like
3580 * g_variant_format_string_scan().
3585 g_variant_format_string_scan_type (const gchar *string,
3587 const gchar **endptr)
3589 const gchar *my_end;
3596 if (!g_variant_format_string_scan (string, limit, endptr))
3599 dest = new = g_malloc (*endptr - string + 1);
3600 while (string != *endptr)
3602 if (*string != '@' && *string != '&' && *string != '^')
3608 return (GVariantType *) G_VARIANT_TYPE (new);
3612 valid_format_string (const gchar *format_string,
3616 const gchar *endptr;
3619 type = g_variant_format_string_scan_type (format_string, NULL, &endptr);
3621 if G_UNLIKELY (type == NULL || (single && *endptr != '\0'))
3624 g_critical ("`%s' is not a valid GVariant format string",
3627 g_critical ("`%s' does not have a valid GVariant format "
3628 "string as a prefix", format_string);
3631 g_variant_type_free (type);
3636 if G_UNLIKELY (value && !g_variant_is_of_type (value, type))
3641 fragment = g_strndup (format_string, endptr - format_string);
3642 typestr = g_variant_type_dup_string (type);
3644 g_critical ("the GVariant format string `%s' has a type of "
3645 "`%s' but the given value has a type of `%s'",
3646 fragment, typestr, g_variant_get_type_string (value));
3648 g_variant_type_free (type);
3653 g_variant_type_free (type);
3658 /* Variable Arguments {{{1 */
3659 /* We consider 2 main classes of format strings:
3661 * - recursive format strings
3662 * these are ones that result in recursion and the collection of
3663 * possibly more than one argument. Maybe types, tuples,
3664 * dictionary entries.
3666 * - leaf format string
3667 * these result in the collection of a single argument.
3669 * Leaf format strings are further subdivided into two categories:
3671 * - single non-null pointer ("nnp")
3672 * these either collect or return a single non-null pointer.
3675 * these collect or return something else (bool, number, etc).
3677 * Based on the above, the varargs handling code is split into 4 main parts:
3679 * - nnp handling code
3680 * - leaf handling code (which may invoke nnp code)
3681 * - generic handling code (may be recursive, may invoke leaf code)
3682 * - user-facing API (which invokes the generic code)
3684 * Each section implements some of the following functions:
3687 * collect the arguments for the format string as if
3688 * g_variant_new() had been called, but do nothing with them. used
3689 * for skipping over arguments when constructing a Nothing maybe
3693 * create a GVariant *
3696 * unpack a GVariant *
3698 * - free (nnp only):
3699 * free a previously allocated item
3703 g_variant_format_string_is_leaf (const gchar *str)
3705 return str[0] != 'm' && str[0] != '(' && str[0] != '{';
3709 g_variant_format_string_is_nnp (const gchar *str)
3711 return str[0] == 'a' || str[0] == 's' || str[0] == 'o' || str[0] == 'g' ||
3712 str[0] == '^' || str[0] == '@' || str[0] == '*' || str[0] == '?' ||
3713 str[0] == 'r' || str[0] == 'v' || str[0] == '&';
3716 /* Single non-null pointer ("nnp") {{{2 */
3718 g_variant_valist_free_nnp (const gchar *str,
3724 g_variant_iter_free (ptr);
3728 if (str[2] != '&') /* '^as', '^ao' */
3730 else /* '^a&s', '^a&o' */
3744 g_variant_unref (ptr);
3751 g_assert_not_reached ();
3756 g_variant_scan_convenience (const gchar **str,
3779 g_variant_valist_new_nnp (const gchar **str,
3790 const GVariantType *type;
3793 value = g_variant_builder_end (ptr);
3794 type = g_variant_get_type (value);
3796 if G_UNLIKELY (!g_variant_type_is_array (type))
3797 g_error ("g_variant_new: expected array GVariantBuilder but "
3798 "the built value has type `%s'",
3799 g_variant_get_type_string (value));
3801 type = g_variant_type_element (type);
3803 if G_UNLIKELY (!g_variant_type_is_subtype_of (type, (GVariantType *) *str))
3804 g_error ("g_variant_new: expected GVariantBuilder array element "
3805 "type `%s' but the built value has element type `%s'",
3806 g_variant_type_dup_string ((GVariantType *) *str),
3807 g_variant_get_type_string (value) + 1);
3809 g_variant_type_string_scan (*str, NULL, str);
3815 /* special case: NULL pointer for empty array */
3817 const GVariantType *type = (GVariantType *) *str;
3819 g_variant_type_string_scan (*str, NULL, str);
3821 if G_UNLIKELY (!g_variant_type_is_definite (type))
3822 g_error ("g_variant_new: NULL pointer given with indefinite "
3823 "array type; unable to determine which type of empty "
3824 "array to construct.");
3826 return g_variant_new_array (type, NULL, 0);
3833 value = g_variant_new_string (ptr);
3836 value = g_variant_new_string ("[Invalid UTF-8]");
3842 return g_variant_new_object_path (ptr);
3845 return g_variant_new_signature (ptr);
3853 type = g_variant_scan_convenience (str, &constant, &arrays);
3856 return g_variant_new_strv (ptr, -1);
3859 return g_variant_new_objv (ptr, -1);
3862 return g_variant_new_bytestring_array (ptr, -1);
3864 return g_variant_new_bytestring (ptr);
3868 if G_UNLIKELY (!g_variant_is_of_type (ptr, (GVariantType *) *str))
3869 g_error ("g_variant_new: expected GVariant of type `%s' but "
3870 "received value has type `%s'",
3871 g_variant_type_dup_string ((GVariantType *) *str),
3872 g_variant_get_type_string (ptr));
3874 g_variant_type_string_scan (*str, NULL, str);
3882 if G_UNLIKELY (!g_variant_type_is_basic (g_variant_get_type (ptr)))
3883 g_error ("g_variant_new: format string `?' expects basic-typed "
3884 "GVariant, but received value has type `%s'",
3885 g_variant_get_type_string (ptr));
3890 if G_UNLIKELY (!g_variant_type_is_tuple (g_variant_get_type (ptr)))
3891 g_error ("g_variant_new: format string `r` expects tuple-typed "
3892 "GVariant, but received value has type `%s'",
3893 g_variant_get_type_string (ptr));
3898 return g_variant_new_variant (ptr);
3901 g_assert_not_reached ();
3906 g_variant_valist_get_nnp (const gchar **str,
3912 g_variant_type_string_scan (*str, NULL, str);
3913 return g_variant_iter_new (value);
3917 return (gchar *) g_variant_get_string (value, NULL);
3922 return g_variant_dup_string (value, NULL);
3930 type = g_variant_scan_convenience (str, &constant, &arrays);
3935 return g_variant_get_strv (value, NULL);
3937 return g_variant_dup_strv (value, NULL);
3940 else if (type == 'o')
3943 return g_variant_get_objv (value, NULL);
3945 return g_variant_dup_objv (value, NULL);
3948 else if (arrays > 1)
3951 return g_variant_get_bytestring_array (value, NULL);
3953 return g_variant_dup_bytestring_array (value, NULL);
3959 return (gchar *) g_variant_get_bytestring (value);
3961 return g_variant_dup_bytestring (value, NULL);
3966 g_variant_type_string_scan (*str, NULL, str);
3972 return g_variant_ref (value);
3975 return g_variant_get_variant (value);
3978 g_assert_not_reached ();
3984 g_variant_valist_skip_leaf (const gchar **str,
3987 if (g_variant_format_string_is_nnp (*str))
3989 g_variant_format_string_scan (*str, NULL, str);
3990 va_arg (*app, gpointer);
4008 va_arg (*app, guint64);
4012 va_arg (*app, gdouble);
4016 g_assert_not_reached ();
4021 g_variant_valist_new_leaf (const gchar **str,
4024 if (g_variant_format_string_is_nnp (*str))
4025 return g_variant_valist_new_nnp (str, va_arg (*app, gpointer));
4030 return g_variant_new_boolean (va_arg (*app, gboolean));
4033 return g_variant_new_byte (va_arg (*app, guint));
4036 return g_variant_new_int16 (va_arg (*app, gint));
4039 return g_variant_new_uint16 (va_arg (*app, guint));
4042 return g_variant_new_int32 (va_arg (*app, gint));
4045 return g_variant_new_uint32 (va_arg (*app, guint));
4048 return g_variant_new_int64 (va_arg (*app, gint64));
4051 return g_variant_new_uint64 (va_arg (*app, guint64));
4054 return g_variant_new_handle (va_arg (*app, gint));
4057 return g_variant_new_double (va_arg (*app, gdouble));
4060 g_assert_not_reached ();
4064 /* The code below assumes this */
4065 G_STATIC_ASSERT (sizeof (gboolean) == sizeof (guint32));
4066 G_STATIC_ASSERT (sizeof (gdouble) == sizeof (guint64));
4069 g_variant_valist_get_leaf (const gchar **str,
4074 gpointer ptr = va_arg (*app, gpointer);
4078 g_variant_format_string_scan (*str, NULL, str);
4082 if (g_variant_format_string_is_nnp (*str))
4084 gpointer *nnp = (gpointer *) ptr;
4086 if (free && *nnp != NULL)
4087 g_variant_valist_free_nnp (*str, *nnp);
4092 *nnp = g_variant_valist_get_nnp (str, value);
4094 g_variant_format_string_scan (*str, NULL, str);
4104 *(gboolean *) ptr = g_variant_get_boolean (value);
4108 *(guchar *) ptr = g_variant_get_byte (value);
4112 *(gint16 *) ptr = g_variant_get_int16 (value);
4116 *(guint16 *) ptr = g_variant_get_uint16 (value);
4120 *(gint32 *) ptr = g_variant_get_int32 (value);
4124 *(guint32 *) ptr = g_variant_get_uint32 (value);
4128 *(gint64 *) ptr = g_variant_get_int64 (value);
4132 *(guint64 *) ptr = g_variant_get_uint64 (value);
4136 *(gint32 *) ptr = g_variant_get_handle (value);
4140 *(gdouble *) ptr = g_variant_get_double (value);
4149 *(guchar *) ptr = 0;
4154 *(guint16 *) ptr = 0;
4161 *(guint32 *) ptr = 0;
4167 *(guint64 *) ptr = 0;
4172 g_assert_not_reached ();
4175 /* Generic (recursive) {{{2 */
4177 g_variant_valist_skip (const gchar **str,
4180 if (g_variant_format_string_is_leaf (*str))
4181 g_variant_valist_skip_leaf (str, app);
4183 else if (**str == 'm') /* maybe */
4187 if (!g_variant_format_string_is_nnp (*str))
4188 va_arg (*app, gboolean);
4190 g_variant_valist_skip (str, app);
4192 else /* tuple, dictionary entry */
4194 g_assert (**str == '(' || **str == '{');
4196 while (**str != ')' && **str != '}')
4197 g_variant_valist_skip (str, app);
4203 g_variant_valist_new (const gchar **str,
4206 if (g_variant_format_string_is_leaf (*str))
4207 return g_variant_valist_new_leaf (str, app);
4209 if (**str == 'm') /* maybe */
4211 GVariantType *type = NULL;
4212 GVariant *value = NULL;
4216 if (g_variant_format_string_is_nnp (*str))
4218 gpointer nnp = va_arg (*app, gpointer);
4221 value = g_variant_valist_new_nnp (str, nnp);
4223 type = g_variant_format_string_scan_type (*str, NULL, str);
4227 gboolean just = va_arg (*app, gboolean);
4230 value = g_variant_valist_new (str, app);
4233 type = g_variant_format_string_scan_type (*str, NULL, NULL);
4234 g_variant_valist_skip (str, app);
4238 value = g_variant_new_maybe (type, value);
4241 g_variant_type_free (type);
4245 else /* tuple, dictionary entry */
4250 g_variant_builder_init (&b, G_VARIANT_TYPE_TUPLE);
4253 g_assert (**str == '{');
4254 g_variant_builder_init (&b, G_VARIANT_TYPE_DICT_ENTRY);
4258 while (**str != ')' && **str != '}')
4259 g_variant_builder_add_value (&b, g_variant_valist_new (str, app));
4262 return g_variant_builder_end (&b);
4267 g_variant_valist_get (const gchar **str,
4272 if (g_variant_format_string_is_leaf (*str))
4273 g_variant_valist_get_leaf (str, value, free, app);
4275 else if (**str == 'm')
4280 value = g_variant_get_maybe (value);
4282 if (!g_variant_format_string_is_nnp (*str))
4284 gboolean *ptr = va_arg (*app, gboolean *);
4287 *ptr = value != NULL;
4290 g_variant_valist_get (str, value, free, app);
4293 g_variant_unref (value);
4296 else /* tuple, dictionary entry */
4300 g_assert (**str == '(' || **str == '{');
4303 while (**str != ')' && **str != '}')
4307 GVariant *child = g_variant_get_child_value (value, index++);
4308 g_variant_valist_get (str, child, free, app);
4309 g_variant_unref (child);
4312 g_variant_valist_get (str, NULL, free, app);
4318 /* User-facing API {{{2 */
4320 * g_variant_new: (skip)
4321 * @format_string: a #GVariant format string
4322 * @...: arguments, as per @format_string
4323 * @returns: a new floating #GVariant instance
4325 * Creates a new #GVariant instance.
4327 * Think of this function as an analogue to g_strdup_printf().
4329 * The type of the created instance and the arguments that are
4330 * expected by this function are determined by @format_string. See the
4331 * section on <link linkend='gvariant-format-strings'>GVariant Format
4332 * Strings</link>. Please note that the syntax of the format string is
4333 * very likely to be extended in the future.
4335 * The first character of the format string must not be '*' '?' '@' or
4336 * 'r'; in essence, a new #GVariant must always be constructed by this
4337 * function (and not merely passed through it unmodified).
4342 g_variant_new (const gchar *format_string,
4348 g_return_val_if_fail (valid_format_string (format_string, TRUE, NULL) &&
4349 format_string[0] != '?' && format_string[0] != '@' &&
4350 format_string[0] != '*' && format_string[0] != 'r',
4353 va_start (ap, format_string);
4354 value = g_variant_new_va (format_string, NULL, &ap);
4361 * g_variant_new_va: (skip)
4362 * @format_string: a string that is prefixed with a format string
4363 * @endptr: (allow-none) (default NULL): location to store the end pointer,
4365 * @app: a pointer to a #va_list
4366 * @returns: a new, usually floating, #GVariant
4368 * This function is intended to be used by libraries based on
4369 * #GVariant that want to provide g_variant_new()-like functionality
4372 * The API is more general than g_variant_new() to allow a wider range
4375 * @format_string must still point to a valid format string, but it only
4376 * needs to be nul-terminated if @endptr is %NULL. If @endptr is
4377 * non-%NULL then it is updated to point to the first character past the
4378 * end of the format string.
4380 * @app is a pointer to a #va_list. The arguments, according to
4381 * @format_string, are collected from this #va_list and the list is left
4382 * pointing to the argument following the last.
4384 * These two generalisations allow mixing of multiple calls to
4385 * g_variant_new_va() and g_variant_get_va() within a single actual
4386 * varargs call by the user.
4388 * The return value will be floating if it was a newly created GVariant
4389 * instance (for example, if the format string was "(ii)"). In the case
4390 * that the format_string was '*', '?', 'r', or a format starting with
4391 * '@' then the collected #GVariant pointer will be returned unmodified,
4392 * without adding any additional references.
4394 * In order to behave correctly in all cases it is necessary for the
4395 * calling function to g_variant_ref_sink() the return result before
4396 * returning control to the user that originally provided the pointer.
4397 * At this point, the caller will have their own full reference to the
4398 * result. This can also be done by adding the result to a container,
4399 * or by passing it to another g_variant_new() call.
4404 g_variant_new_va (const gchar *format_string,
4405 const gchar **endptr,
4410 g_return_val_if_fail (valid_format_string (format_string, !endptr, NULL),
4412 g_return_val_if_fail (app != NULL, NULL);
4414 value = g_variant_valist_new (&format_string, app);
4417 *endptr = format_string;
4423 * g_variant_get: (skip)
4424 * @value: a #GVariant instance
4425 * @format_string: a #GVariant format string
4426 * @...: arguments, as per @format_string
4428 * Deconstructs a #GVariant instance.
4430 * Think of this function as an analogue to scanf().
4432 * The arguments that are expected by this function are entirely
4433 * determined by @format_string. @format_string also restricts the
4434 * permissible types of @value. It is an error to give a value with
4435 * an incompatible type. See the section on <link
4436 * linkend='gvariant-format-strings'>GVariant Format Strings</link>.
4437 * Please note that the syntax of the format string is very likely to be
4438 * extended in the future.
4443 g_variant_get (GVariant *value,
4444 const gchar *format_string,
4449 g_return_if_fail (valid_format_string (format_string, TRUE, value));
4451 /* if any direct-pointer-access formats are in use, flatten first */
4452 if (strchr (format_string, '&'))
4453 g_variant_get_data (value);
4455 va_start (ap, format_string);
4456 g_variant_get_va (value, format_string, NULL, &ap);
4461 * g_variant_get_va: (skip)
4462 * @value: a #GVariant
4463 * @format_string: a string that is prefixed with a format string
4464 * @endptr: (allow-none) (default NULL): location to store the end pointer,
4466 * @app: a pointer to a #va_list
4468 * This function is intended to be used by libraries based on #GVariant
4469 * that want to provide g_variant_get()-like functionality to their
4472 * The API is more general than g_variant_get() to allow a wider range
4475 * @format_string must still point to a valid format string, but it only
4476 * need to be nul-terminated if @endptr is %NULL. If @endptr is
4477 * non-%NULL then it is updated to point to the first character past the
4478 * end of the format string.
4480 * @app is a pointer to a #va_list. The arguments, according to
4481 * @format_string, are collected from this #va_list and the list is left
4482 * pointing to the argument following the last.
4484 * These two generalisations allow mixing of multiple calls to
4485 * g_variant_new_va() and g_variant_get_va() within a single actual
4486 * varargs call by the user.
4491 g_variant_get_va (GVariant *value,
4492 const gchar *format_string,
4493 const gchar **endptr,
4496 g_return_if_fail (valid_format_string (format_string, !endptr, value));
4497 g_return_if_fail (value != NULL);
4498 g_return_if_fail (app != NULL);
4500 /* if any direct-pointer-access formats are in use, flatten first */
4501 if (strchr (format_string, '&'))
4502 g_variant_get_data (value);
4504 g_variant_valist_get (&format_string, value, FALSE, app);
4507 *endptr = format_string;
4510 /* Varargs-enabled Utility Functions {{{1 */
4513 * g_variant_builder_add: (skp)
4514 * @builder: a #GVariantBuilder
4515 * @format_string: a #GVariant varargs format string
4516 * @...: arguments, as per @format_string
4518 * Adds to a #GVariantBuilder.
4520 * This call is a convenience wrapper that is exactly equivalent to
4521 * calling g_variant_new() followed by g_variant_builder_add_value().
4523 * This function might be used as follows:
4527 * make_pointless_dictionary (void)
4529 * GVariantBuilder *builder;
4532 * builder = g_variant_builder_new (G_VARIANT_TYPE_ARRAY);
4533 * for (i = 0; i < 16; i++)
4537 * sprintf (buf, "%d", i);
4538 * g_variant_builder_add (builder, "{is}", i, buf);
4541 * return g_variant_builder_end (builder);
4548 g_variant_builder_add (GVariantBuilder *builder,
4549 const gchar *format_string,
4555 va_start (ap, format_string);
4556 variant = g_variant_new_va (format_string, NULL, &ap);
4559 g_variant_builder_add_value (builder, variant);
4563 * g_variant_get_child: (skip)
4564 * @value: a container #GVariant
4565 * @index_: the index of the child to deconstruct
4566 * @format_string: a #GVariant format string
4567 * @...: arguments, as per @format_string
4569 * Reads a child item out of a container #GVariant instance and
4570 * deconstructs it according to @format_string. This call is
4571 * essentially a combination of g_variant_get_child_value() and
4577 g_variant_get_child (GVariant *value,
4579 const gchar *format_string,
4585 child = g_variant_get_child_value (value, index_);
4586 g_return_if_fail (valid_format_string (format_string, TRUE, child));
4588 va_start (ap, format_string);
4589 g_variant_get_va (child, format_string, NULL, &ap);
4592 g_variant_unref (child);
4596 * g_variant_iter_next: (skip)
4597 * @iter: a #GVariantIter
4598 * @format_string: a GVariant format string
4599 * @...: the arguments to unpack the value into
4600 * @returns: %TRUE if a value was unpacked, or %FALSE if there as no
4603 * Gets the next item in the container and unpacks it into the variable
4604 * argument list according to @format_string, returning %TRUE.
4606 * If no more items remain then %FALSE is returned.
4608 * All of the pointers given on the variable arguments list of this
4609 * function are assumed to point at uninitialised memory. It is the
4610 * responsibility of the caller to free all of the values returned by
4611 * the unpacking process.
4613 * See the section on <link linkend='gvariant-format-strings'>GVariant
4614 * Format Strings</link>.
4617 * <title>Memory management with g_variant_iter_next()</title>
4619 * /<!-- -->* Iterates a dictionary of type 'a{sv}' *<!-- -->/
4621 * iterate_dictionary (GVariant *dictionary)
4623 * GVariantIter iter;
4627 * g_variant_iter_init (&iter, dictionary);
4628 * while (g_variant_iter_next (&iter, "{sv}", &key, &value))
4630 * g_print ("Item '%s' has type '%s'\n", key,
4631 * g_variant_get_type_string (value));
4633 * /<!-- -->* must free data for ourselves *<!-- -->/
4634 * g_variant_unref (value);
4641 * For a solution that is likely to be more convenient to C programmers
4642 * when dealing with loops, see g_variant_iter_loop().
4647 g_variant_iter_next (GVariantIter *iter,
4648 const gchar *format_string,
4653 value = g_variant_iter_next_value (iter);
4655 g_return_val_if_fail (valid_format_string (format_string, TRUE, value),
4662 va_start (ap, format_string);
4663 g_variant_valist_get (&format_string, value, FALSE, &ap);
4666 g_variant_unref (value);
4669 return value != NULL;
4673 * g_variant_iter_loop: (skip)
4674 * @iter: a #GVariantIter
4675 * @format_string: a GVariant format string
4676 * @...: the arguments to unpack the value into
4677 * @returns: %TRUE if a value was unpacked, or %FALSE if there as no
4680 * Gets the next item in the container and unpacks it into the variable
4681 * argument list according to @format_string, returning %TRUE.
4683 * If no more items remain then %FALSE is returned.
4685 * On the first call to this function, the pointers appearing on the
4686 * variable argument list are assumed to point at uninitialised memory.
4687 * On the second and later calls, it is assumed that the same pointers
4688 * will be given and that they will point to the memory as set by the
4689 * previous call to this function. This allows the previous values to
4690 * be freed, as appropriate.
4692 * This function is intended to be used with a while loop as
4693 * demonstrated in the following example. This function can only be
4694 * used when iterating over an array. It is only valid to call this
4695 * function with a string constant for the format string and the same
4696 * string constant must be used each time. Mixing calls to this
4697 * function and g_variant_iter_next() or g_variant_iter_next_value() on
4698 * the same iterator is not recommended.
4700 * See the section on <link linkend='gvariant-format-strings'>GVariant
4701 * Format Strings</link>.
4704 * <title>Memory management with g_variant_iter_loop()</title>
4706 * /<!-- -->* Iterates a dictionary of type 'a{sv}' *<!-- -->/
4708 * iterate_dictionary (GVariant *dictionary)
4710 * GVariantIter iter;
4714 * g_variant_iter_init (&iter, dictionary);
4715 * while (g_variant_iter_loop (&iter, "{sv}", &key, &value))
4717 * g_print ("Item '%s' has type '%s'\n", key,
4718 * g_variant_get_type_string (value));
4720 * /<!-- -->* no need to free 'key' and 'value' here *<!-- -->/
4726 * For most cases you should use g_variant_iter_next().
4728 * This function is really only useful when unpacking into #GVariant or
4729 * #GVariantIter in order to allow you to skip the call to
4730 * g_variant_unref() or g_variant_iter_free().
4732 * For example, if you are only looping over simple integer and string
4733 * types, g_variant_iter_next() is definitely preferred. For string
4734 * types, use the '&' prefix to avoid allocating any memory at all (and
4735 * thereby avoiding the need to free anything as well).
4740 g_variant_iter_loop (GVariantIter *iter,
4741 const gchar *format_string,
4744 gboolean first_time = GVSI(iter)->loop_format == NULL;
4748 g_return_val_if_fail (first_time ||
4749 format_string == GVSI(iter)->loop_format,
4754 TYPE_CHECK (GVSI(iter)->value, G_VARIANT_TYPE_ARRAY, FALSE);
4755 GVSI(iter)->loop_format = format_string;
4757 if (strchr (format_string, '&'))
4758 g_variant_get_data (GVSI(iter)->value);
4761 value = g_variant_iter_next_value (iter);
4763 g_return_val_if_fail (!first_time ||
4764 valid_format_string (format_string, TRUE, value),
4767 va_start (ap, format_string);
4768 g_variant_valist_get (&format_string, value, !first_time, &ap);
4772 g_variant_unref (value);
4774 return value != NULL;
4777 /* Serialised data {{{1 */
4779 g_variant_deep_copy (GVariant *value)
4781 switch (g_variant_classify (value))
4783 case G_VARIANT_CLASS_MAYBE:
4784 case G_VARIANT_CLASS_ARRAY:
4785 case G_VARIANT_CLASS_TUPLE:
4786 case G_VARIANT_CLASS_DICT_ENTRY:
4787 case G_VARIANT_CLASS_VARIANT:
4789 GVariantBuilder builder;
4793 g_variant_builder_init (&builder, g_variant_get_type (value));
4794 g_variant_iter_init (&iter, value);
4796 while ((child = g_variant_iter_next_value (&iter)))
4798 g_variant_builder_add_value (&builder, g_variant_deep_copy (child));
4799 g_variant_unref (child);
4802 return g_variant_builder_end (&builder);
4805 case G_VARIANT_CLASS_BOOLEAN:
4806 return g_variant_new_boolean (g_variant_get_boolean (value));
4808 case G_VARIANT_CLASS_BYTE:
4809 return g_variant_new_byte (g_variant_get_byte (value));
4811 case G_VARIANT_CLASS_INT16:
4812 return g_variant_new_int16 (g_variant_get_int16 (value));
4814 case G_VARIANT_CLASS_UINT16:
4815 return g_variant_new_uint16 (g_variant_get_uint16 (value));
4817 case G_VARIANT_CLASS_INT32:
4818 return g_variant_new_int32 (g_variant_get_int32 (value));
4820 case G_VARIANT_CLASS_UINT32:
4821 return g_variant_new_uint32 (g_variant_get_uint32 (value));
4823 case G_VARIANT_CLASS_INT64:
4824 return g_variant_new_int64 (g_variant_get_int64 (value));
4826 case G_VARIANT_CLASS_UINT64:
4827 return g_variant_new_uint64 (g_variant_get_uint64 (value));
4829 case G_VARIANT_CLASS_HANDLE:
4830 return g_variant_new_handle (g_variant_get_handle (value));
4832 case G_VARIANT_CLASS_DOUBLE:
4833 return g_variant_new_double (g_variant_get_double (value));
4835 case G_VARIANT_CLASS_STRING:
4836 return g_variant_new_string (g_variant_get_string (value, NULL));
4838 case G_VARIANT_CLASS_OBJECT_PATH:
4839 return g_variant_new_object_path (g_variant_get_string (value, NULL));
4841 case G_VARIANT_CLASS_SIGNATURE:
4842 return g_variant_new_signature (g_variant_get_string (value, NULL));
4845 g_assert_not_reached ();
4849 * g_variant_get_normal_form:
4850 * @value: a #GVariant
4851 * @returns: (transfer full): a trusted #GVariant
4853 * Gets a #GVariant instance that has the same value as @value and is
4854 * trusted to be in normal form.
4856 * If @value is already trusted to be in normal form then a new
4857 * reference to @value is returned.
4859 * If @value is not already trusted, then it is scanned to check if it
4860 * is in normal form. If it is found to be in normal form then it is
4861 * marked as trusted and a new reference to it is returned.
4863 * If @value is found not to be in normal form then a new trusted
4864 * #GVariant is created with the same value as @value.
4866 * It makes sense to call this function if you've received #GVariant
4867 * data from untrusted sources and you want to ensure your serialised
4868 * output is definitely in normal form.
4873 g_variant_get_normal_form (GVariant *value)
4877 if (g_variant_is_normal_form (value))
4878 return g_variant_ref (value);
4880 trusted = g_variant_deep_copy (value);
4881 g_assert (g_variant_is_trusted (trusted));
4883 return g_variant_ref_sink (trusted);
4887 * g_variant_byteswap:
4888 * @value: a #GVariant
4889 * @returns: (transfer full): the byteswapped form of @value
4891 * Performs a byteswapping operation on the contents of @value. The
4892 * result is that all multi-byte numeric data contained in @value is
4893 * byteswapped. That includes 16, 32, and 64bit signed and unsigned
4894 * integers as well as file handles and double precision floating point
4897 * This function is an identity mapping on any value that does not
4898 * contain multi-byte numeric data. That include strings, booleans,
4899 * bytes and containers containing only these things (recursively).
4901 * The returned value is always in normal form and is marked as trusted.
4906 g_variant_byteswap (GVariant *value)
4908 GVariantTypeInfo *type_info;
4912 type_info = g_variant_get_type_info (value);
4914 g_variant_type_info_query (type_info, &alignment, NULL);
4917 /* (potentially) contains multi-byte numeric data */
4919 GVariantSerialised serialised;
4923 trusted = g_variant_get_normal_form (value);
4924 serialised.type_info = g_variant_get_type_info (trusted);
4925 serialised.size = g_variant_get_size (trusted);
4926 serialised.data = g_malloc (serialised.size);
4927 g_variant_store (trusted, serialised.data);
4928 g_variant_unref (trusted);
4930 g_variant_serialised_byteswap (serialised);
4932 buffer = g_buffer_new_take_data (serialised.data, serialised.size);
4933 new = g_variant_new_from_buffer (g_variant_get_type (value), buffer, TRUE);
4934 g_buffer_unref (buffer);
4937 /* contains no multi-byte data */
4940 return g_variant_ref_sink (new);
4944 * g_variant_new_from_data:
4945 * @type: a definite #GVariantType
4946 * @data: (array length=size) (element-type guint8): the serialised data
4947 * @size: the size of @data
4948 * @trusted: %TRUE if @data is definitely in normal form
4949 * @notify: (scope async): function to call when @data is no longer needed
4950 * @user_data: data for @notify
4951 * @returns: (transfer none): a new floating #GVariant of type @type
4953 * Creates a new #GVariant instance from serialised data.
4955 * @type is the type of #GVariant instance that will be constructed.
4956 * The interpretation of @data depends on knowing the type.
4958 * @data is not modified by this function and must remain valid with an
4959 * unchanging value until such a time as @notify is called with
4960 * @user_data. If the contents of @data change before that time then
4961 * the result is undefined.
4963 * If @data is trusted to be serialised data in normal form then
4964 * @trusted should be %TRUE. This applies to serialised data created
4965 * within this process or read from a trusted location on the disk (such
4966 * as a file installed in /usr/lib alongside your application). You
4967 * should set trusted to %FALSE if @data is read from the network, a
4968 * file in the user's home directory, etc.
4970 * @notify will be called with @user_data when @data is no longer
4971 * needed. The exact time of this call is unspecified and might even be
4972 * before this function returns.
4977 g_variant_new_from_data (const GVariantType *type,
4981 GDestroyNotify notify,
4987 g_return_val_if_fail (g_variant_type_is_definite (type), NULL);
4988 g_return_val_if_fail (data != NULL || size == 0, NULL);
4991 buffer = g_buffer_new_from_pointer (data, size, notify, user_data);
4993 buffer = g_buffer_new_from_static_data (data, size);
4995 value = g_variant_new_from_buffer (type, buffer, trusted);
4996 g_buffer_unref (buffer);
5002 /* vim:set foldmethod=marker: */