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 can not 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 DBus. Almost all types of
69 * #GVariant instances can be sent over DBus. 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 refering 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 * @boolean: a #gboolean value
319 * @returns: 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 * @byte: a #guint8 value
377 * @returns: 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 * @int16: a #gint16 value
400 * @returns: 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 * @uint16: a #guint16 value
423 * @returns: 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 * @int32: a #gint32 value
446 * @returns: 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 * @uint32: a #guint32 value
469 * @returns: 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 * @int64: a #gint64 value
492 * @returns: 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 * @uint64: a #guint64 value
515 * @returns: 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 * @handle: a #gint32 value
538 * @returns: 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 DBus message. If you're not interacting
544 * with DBus, 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 DBus message. If you're not interacting
560 * with DBus, you probably don't need them.
564 NUMERIC_TYPE (HANDLE, handle, gint32)
567 * g_variant_new_double:
568 * @floating: a #gdouble floating point value
569 * @returns: 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: 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
607 g_variant_new_maybe (const GVariantType *child_type,
610 GVariantType *maybe_type;
613 g_return_val_if_fail (child_type == NULL || g_variant_type_is_definite
615 g_return_val_if_fail (child_type != NULL || child != NULL, NULL);
616 g_return_val_if_fail (child_type == NULL || child == NULL ||
617 g_variant_is_of_type (child, child_type),
620 if (child_type == NULL)
621 child_type = g_variant_get_type (child);
623 maybe_type = g_variant_type_new_maybe (child_type);
630 children = g_new (GVariant *, 1);
631 children[0] = g_variant_ref_sink (child);
632 trusted = g_variant_is_trusted (children[0]);
634 value = g_variant_new_from_children (maybe_type, children, 1, trusted);
637 value = g_variant_new_from_children (maybe_type, NULL, 0, TRUE);
639 g_variant_type_free (maybe_type);
645 * g_variant_get_maybe:
646 * @value: a maybe-typed value
647 * @returns: (allow-none): the contents of @value, or %NULL
649 * Given a maybe-typed #GVariant instance, extract its value. If the
650 * value is Nothing, then this function returns %NULL.
655 g_variant_get_maybe (GVariant *value)
657 TYPE_CHECK (value, G_VARIANT_TYPE_MAYBE, NULL);
659 if (g_variant_n_children (value))
660 return g_variant_get_child_value (value, 0);
666 * g_variant_new_variant:
667 * @value: a #GVariance instance
668 * @returns: a new variant #GVariant instance
670 * Boxes @value. The result is a #GVariant instance representing a
671 * variant containing the original value.
676 g_variant_new_variant (GVariant *value)
678 g_return_val_if_fail (value != NULL, NULL);
680 g_variant_ref_sink (value);
682 return g_variant_new_from_children (G_VARIANT_TYPE_VARIANT,
683 g_memdup (&value, sizeof value),
684 1, g_variant_is_trusted (value));
688 * g_variant_get_variant:
689 * @value: a variant #GVariance instance
690 * @returns: the item contained in the variant
692 * Unboxes @value. The result is the #GVariant instance that was
693 * contained in @value.
698 g_variant_get_variant (GVariant *value)
700 TYPE_CHECK (value, G_VARIANT_TYPE_VARIANT, NULL);
702 return g_variant_get_child_value (value, 0);
706 * g_variant_new_array:
707 * @child_type: (allow-none): the element type of the new array
708 * @children: (allow-none) (array length=n_children): an array of
709 * #GVariant pointers, the children
710 * @n_children: the length of @children
711 * @returns: a new #GVariant array
713 * Creates a new #GVariant array from @children.
715 * @child_type must be non-%NULL if @n_children is zero. Otherwise, the
716 * child type is determined by inspecting the first element of the
717 * @children array. If @child_type is non-%NULL then it must be a
720 * The items of the array are taken from the @children array. No entry
721 * in the @children array may be %NULL.
723 * All items in the array must have the same type, which must be the
724 * same as @child_type, if given.
729 g_variant_new_array (const GVariantType *child_type,
730 GVariant * const *children,
733 GVariantType *array_type;
734 GVariant **my_children;
739 g_return_val_if_fail (n_children > 0 || child_type != NULL, NULL);
740 g_return_val_if_fail (n_children == 0 || children != NULL, NULL);
741 g_return_val_if_fail (child_type == NULL ||
742 g_variant_type_is_definite (child_type), NULL);
744 my_children = g_new (GVariant *, n_children);
747 if (child_type == NULL)
748 child_type = g_variant_get_type (children[0]);
749 array_type = g_variant_type_new_array (child_type);
751 for (i = 0; i < n_children; i++)
753 TYPE_CHECK (children[i], child_type, NULL);
754 my_children[i] = g_variant_ref_sink (children[i]);
755 trusted &= g_variant_is_trusted (children[i]);
758 value = g_variant_new_from_children (array_type, my_children,
759 n_children, trusted);
760 g_variant_type_free (array_type);
766 * g_variant_make_tuple_type:
767 * @children: (array length=n_children): an array of GVariant *
768 * @n_children: the length of @children
770 * Return the type of a tuple containing @children as its items.
772 static GVariantType *
773 g_variant_make_tuple_type (GVariant * const *children,
776 const GVariantType **types;
780 types = g_new (const GVariantType *, n_children);
782 for (i = 0; i < n_children; i++)
783 types[i] = g_variant_get_type (children[i]);
785 type = g_variant_type_new_tuple (types, n_children);
792 * g_variant_new_tuple:
793 * @children: (array length=n_children): the items to make the tuple out of
794 * @n_children: the length of @children
795 * @returns: a new #GVariant tuple
797 * Creates a new tuple #GVariant out of the items in @children. The
798 * type is determined from the types of @children. No entry in the
799 * @children array may be %NULL.
801 * If @n_children is 0 then the unit tuple is constructed.
806 g_variant_new_tuple (GVariant * const *children,
809 GVariantType *tuple_type;
810 GVariant **my_children;
815 g_return_val_if_fail (n_children == 0 || children != NULL, NULL);
817 my_children = g_new (GVariant *, n_children);
820 for (i = 0; i < n_children; i++)
822 my_children[i] = g_variant_ref_sink (children[i]);
823 trusted &= g_variant_is_trusted (children[i]);
826 tuple_type = g_variant_make_tuple_type (children, n_children);
827 value = g_variant_new_from_children (tuple_type, my_children,
828 n_children, trusted);
829 g_variant_type_free (tuple_type);
835 * g_variant_make_dict_entry_type:
836 * @key: a #GVariant, the key
837 * @val: a #GVariant, the value
839 * Return the type of a dictionary entry containing @key and @val as its
842 static GVariantType *
843 g_variant_make_dict_entry_type (GVariant *key,
846 return g_variant_type_new_dict_entry (g_variant_get_type (key),
847 g_variant_get_type (val));
851 * g_variant_new_dict_entry:
852 * @key: a basic #GVariant, the key
853 * @value: a #GVariant, the value
854 * @returns: a new dictionary entry #GVariant
856 * Creates a new dictionary entry #GVariant. @key and @value must be
859 * @key must be a value of a basic type (ie: not a container).
864 g_variant_new_dict_entry (GVariant *key,
867 GVariantType *dict_type;
871 g_return_val_if_fail (key != NULL && value != NULL, NULL);
872 g_return_val_if_fail (!g_variant_is_container (key), NULL);
874 children = g_new (GVariant *, 2);
875 children[0] = g_variant_ref_sink (key);
876 children[1] = g_variant_ref_sink (value);
877 trusted = g_variant_is_trusted (key) && g_variant_is_trusted (value);
879 dict_type = g_variant_make_dict_entry_type (key, value);
880 value = g_variant_new_from_children (dict_type, children, 2, trusted);
881 g_variant_type_free (dict_type);
887 * g_variant_get_fixed_array:
888 * @value: a #GVariant array with fixed-sized elements
889 * @n_elements: a pointer to the location to store the number of items
890 * @element_size: the size of each element
891 * @returns: (array length=n_elements): a pointer to the fixed array
893 * Provides access to the serialised data for an array of fixed-sized
896 * @value must be an array with fixed-sized elements. Numeric types are
897 * fixed-size as are tuples containing only other fixed-sized types.
899 * @element_size must be the size of a single element in the array. For
900 * example, if calling this function for an array of 32 bit integers,
901 * you might say <code>sizeof (gint32)</code>. This value isn't used
902 * except for the purpose of a double-check that the form of the
903 * seralised data matches the caller's expectation.
905 * @n_elements, which must be non-%NULL is set equal to the number of
906 * items in the array.
911 g_variant_get_fixed_array (GVariant *value,
915 GVariantTypeInfo *array_info;
916 gsize array_element_size;
920 TYPE_CHECK (value, G_VARIANT_TYPE_ARRAY, NULL);
922 g_return_val_if_fail (n_elements != NULL, NULL);
923 g_return_val_if_fail (element_size > 0, NULL);
925 array_info = g_variant_get_type_info (value);
926 g_variant_type_info_query_element (array_info, NULL, &array_element_size);
928 g_return_val_if_fail (array_element_size, NULL);
930 if G_UNLIKELY (array_element_size != element_size)
932 if (array_element_size)
933 g_critical ("g_variant_get_fixed_array: assertion "
934 "`g_variant_array_has_fixed_size (value, element_size)' "
935 "failed: array size %"G_GSIZE_FORMAT" does not match "
936 "given element_size %"G_GSIZE_FORMAT".",
937 array_element_size, element_size);
939 g_critical ("g_variant_get_fixed_array: assertion "
940 "`g_variant_array_has_fixed_size (value, element_size)' "
941 "failed: array does not have fixed size.");
944 data = g_variant_get_data (value);
945 size = g_variant_get_size (value);
947 if (size % element_size)
950 *n_elements = size / element_size;
958 /* String type constructor/getters/validation {{{1 */
960 * g_variant_new_string:
961 * @string: a normal utf8 nul-terminated string
962 * @returns: a new string #GVariant instance
964 * Creates a string #GVariant with the contents of @string.
966 * @string must be valid utf8.
971 g_variant_new_string (const gchar *string)
973 g_return_val_if_fail (string != NULL, NULL);
975 return g_variant_new_from_trusted (G_VARIANT_TYPE_STRING,
976 string, strlen (string) + 1);
980 * g_variant_new_object_path:
981 * @object_path: a normal C nul-terminated string
982 * @returns: a new object path #GVariant instance
984 * Creates a DBus object path #GVariant with the contents of @string.
985 * @string must be a valid DBus object path. Use
986 * g_variant_is_object_path() if you're not sure.
991 g_variant_new_object_path (const gchar *object_path)
993 g_return_val_if_fail (g_variant_is_object_path (object_path), NULL);
995 return g_variant_new_from_trusted (G_VARIANT_TYPE_OBJECT_PATH,
996 object_path, strlen (object_path) + 1);
1000 * g_variant_is_object_path:
1001 * @string: a normal C nul-terminated string
1002 * @returns: %TRUE if @string is a DBus object path
1004 * Determines if a given string is a valid DBus object path. You
1005 * should ensure that a string is a valid DBus object path before
1006 * passing it to g_variant_new_object_path().
1008 * A valid object path starts with '/' followed by zero or more
1009 * sequences of characters separated by '/' characters. Each sequence
1010 * must contain only the characters "[A-Z][a-z][0-9]_". No sequence
1011 * (including the one following the final '/' character) may be empty.
1016 g_variant_is_object_path (const gchar *string)
1018 g_return_val_if_fail (string != NULL, FALSE);
1020 return g_variant_serialiser_is_object_path (string, strlen (string) + 1);
1024 * g_variant_new_signature:
1025 * @signature: a normal C nul-terminated string
1026 * @returns: a new signature #GVariant instance
1028 * Creates a DBus type signature #GVariant with the contents of
1029 * @string. @string must be a valid DBus type signature. Use
1030 * g_variant_is_signature() if you're not sure.
1035 g_variant_new_signature (const gchar *signature)
1037 g_return_val_if_fail (g_variant_is_signature (signature), NULL);
1039 return g_variant_new_from_trusted (G_VARIANT_TYPE_SIGNATURE,
1040 signature, strlen (signature) + 1);
1044 * g_variant_is_signature:
1045 * @string: a normal C nul-terminated string
1046 * @returns: %TRUE if @string is a DBus type signature
1048 * Determines if a given string is a valid DBus type signature. You
1049 * should ensure that a string is a valid DBus type signature before
1050 * passing it to g_variant_new_signature().
1052 * DBus type signatures consist of zero or more definite #GVariantType
1053 * strings in sequence.
1058 g_variant_is_signature (const gchar *string)
1060 g_return_val_if_fail (string != NULL, FALSE);
1062 return g_variant_serialiser_is_signature (string, strlen (string) + 1);
1066 * g_variant_get_string:
1067 * @value: a string #GVariant instance
1068 * @length: (allow-none) (default NULL): a pointer to a #gsize,
1069 * to store the length
1070 * @returns: the constant string, utf8 encoded
1072 * Returns the string value of a #GVariant instance with a string
1073 * type. This includes the types %G_VARIANT_TYPE_STRING,
1074 * %G_VARIANT_TYPE_OBJECT_PATH and %G_VARIANT_TYPE_SIGNATURE.
1076 * The string will always be utf8 encoded.
1078 * If @length is non-%NULL then the length of the string (in bytes) is
1079 * returned there. For trusted values, this information is already
1080 * known. For untrusted values, a strlen() will be performed.
1082 * It is an error to call this function with a @value of any type
1083 * other than those three.
1085 * The return value remains valid as long as @value exists.
1090 g_variant_get_string (GVariant *value,
1096 g_return_val_if_fail (value != NULL, NULL);
1097 g_return_val_if_fail (
1098 g_variant_is_of_type (value, G_VARIANT_TYPE_STRING) ||
1099 g_variant_is_of_type (value, G_VARIANT_TYPE_OBJECT_PATH) ||
1100 g_variant_is_of_type (value, G_VARIANT_TYPE_SIGNATURE), NULL);
1102 data = g_variant_get_data (value);
1103 size = g_variant_get_size (value);
1105 if (!g_variant_is_trusted (value))
1107 switch (g_variant_classify (value))
1109 case G_VARIANT_CLASS_STRING:
1110 if (g_variant_serialiser_is_string (data, size))
1117 case G_VARIANT_CLASS_OBJECT_PATH:
1118 if (g_variant_serialiser_is_object_path (data, size))
1125 case G_VARIANT_CLASS_SIGNATURE:
1126 if (g_variant_serialiser_is_signature (data, size))
1134 g_assert_not_reached ();
1145 * g_variant_dup_string:
1146 * @value: a string #GVariant instance
1147 * @length: a pointer to a #gsize, to store the length
1148 * @returns: a newly allocated string, utf8 encoded
1150 * Similar to g_variant_get_string() except that instead of returning
1151 * a constant string, the string is duplicated.
1153 * The string will always be utf8 encoded.
1155 * The return value must be freed using g_free().
1160 g_variant_dup_string (GVariant *value,
1163 return g_strdup (g_variant_get_string (value, length));
1167 * g_variant_new_strv:
1168 * @strv: (array length=length): an array of strings
1169 * @length: the length of @strv, or -1
1170 * @returns: a new floating #GVariant instance
1172 * Constructs an array of strings #GVariant from the given array of
1175 * If @length is -1 then @strv is %NULL-terminated.
1180 g_variant_new_strv (const gchar * const *strv,
1186 g_return_val_if_fail (length == 0 || strv != NULL, NULL);
1189 length = g_strv_length ((gchar **) strv);
1191 strings = g_new (GVariant *, length);
1192 for (i = 0; i < length; i++)
1193 strings[i] = g_variant_ref_sink (g_variant_new_string (strv[i]));
1195 return g_variant_new_from_children (G_VARIANT_TYPE_STRING_ARRAY,
1196 strings, length, TRUE);
1200 * g_variant_get_strv:
1201 * @value: an array of strings #GVariant
1202 * @length: (allow-none): the length of the result, or %NULL
1203 * @returns: (array length=length): an array of constant strings
1205 * Gets the contents of an array of strings #GVariant. This call
1206 * makes a shallow copy; the return result should be released with
1207 * g_free(), but the individual strings must not be modified.
1209 * If @length is non-%NULL then the number of elements in the result
1210 * is stored there. In any case, the resulting array will be
1213 * For an empty array, @length will be set to 0 and a pointer to a
1214 * %NULL pointer will be returned.
1219 g_variant_get_strv (GVariant *value,
1226 TYPE_CHECK (value, G_VARIANT_TYPE_STRING_ARRAY, NULL);
1228 g_variant_get_data (value);
1229 n = g_variant_n_children (value);
1230 strv = g_new (const gchar *, n + 1);
1232 for (i = 0; i < n; i++)
1236 string = g_variant_get_child_value (value, i);
1237 strv[i] = g_variant_get_string (string, NULL);
1238 g_variant_unref (string);
1249 * g_variant_dup_strv:
1250 * @value: an array of strings #GVariant
1251 * @length: (allow-none): the length of the result, or %NULL
1252 * @returns: (array length=length): an array of strings
1254 * Gets the contents of an array of strings #GVariant. This call
1255 * makes a deep copy; the return result should be released with
1258 * If @length is non-%NULL then the number of elements in the result
1259 * is stored there. In any case, the resulting array will be
1262 * For an empty array, @length will be set to 0 and a pointer to a
1263 * %NULL pointer will be returned.
1268 g_variant_dup_strv (GVariant *value,
1275 TYPE_CHECK (value, G_VARIANT_TYPE_STRING_ARRAY, NULL);
1277 n = g_variant_n_children (value);
1278 strv = g_new (gchar *, n + 1);
1280 for (i = 0; i < n; i++)
1284 string = g_variant_get_child_value (value, i);
1285 strv[i] = g_variant_dup_string (string, NULL);
1286 g_variant_unref (string);
1297 * g_variant_new_bytestring:
1298 * @string: a normal nul-terminated string in no particular encoding
1299 * @returns: a new bytestring #GVariant instance
1301 * Creates an array-of-bytes #GVariant with the contents of @string.
1302 * This function is just like g_variant_new_string() except that the
1303 * string need not be valid utf8.
1305 * The nul terminator character at the end of the string is stored in
1311 g_variant_new_bytestring (const gchar *string)
1313 g_return_val_if_fail (string != NULL, NULL);
1315 return g_variant_new_from_trusted (G_VARIANT_TYPE_BYTESTRING,
1316 string, strlen (string) + 1);
1320 * g_variant_get_bytestring:
1321 * @value: an array-of-bytes #GVariant instance
1322 * @returns: the constant string
1324 * Returns the string value of a #GVariant instance with an
1325 * array-of-bytes type. The string has no particular encoding.
1327 * If the array does not end with a nul terminator character, the empty
1328 * string is returned. For this reason, you can always trust that a
1329 * non-%NULL nul-terminated string will be returned by this function.
1331 * If the array contains a nul terminator character somewhere other than
1332 * the last byte then the returned string is the string, up to the first
1333 * such nul character.
1335 * It is an error to call this function with a @value that is not an
1338 * The return value remains valid as long as @value exists.
1343 g_variant_get_bytestring (GVariant *value)
1345 const gchar *string;
1348 TYPE_CHECK (value, G_VARIANT_TYPE_BYTESTRING, NULL);
1350 /* Won't be NULL since this is an array type */
1351 string = g_variant_get_data (value);
1352 size = g_variant_get_size (value);
1354 if (string[size - 1] == '\0')
1361 * g_variant_dup_bytestring:
1362 * @value: an array-of-bytes #GVariant instance
1363 * @length: (allow-none) (default NULL): a pointer to a #gsize, to store
1364 * the length (not including the nul terminator)
1365 * @returns: a newly allocated string
1367 * Similar to g_variant_get_bytestring() except that instead of
1368 * returning a constant string, the string is duplicated.
1370 * The return value must be freed using g_free().
1375 g_variant_dup_bytestring (GVariant *value,
1378 const gchar *original = g_variant_get_bytestring (value);
1381 /* don't crash in case get_bytestring() had an assert failure */
1382 if (original == NULL)
1385 size = strlen (original);
1390 return g_memdup (original, size + 1);
1394 * g_variant_new_bytestring_array:
1395 * @strv: (array length=length): an array of strings
1396 * @length: the length of @strv, or -1
1397 * @returns: a new floating #GVariant instance
1399 * Constructs an array of bytestring #GVariant from the given array of
1402 * If @length is -1 then @strv is %NULL-terminated.
1407 g_variant_new_bytestring_array (const gchar * const *strv,
1413 g_return_val_if_fail (length == 0 || strv != NULL, NULL);
1416 length = g_strv_length ((gchar **) strv);
1418 strings = g_new (GVariant *, length);
1419 for (i = 0; i < length; i++)
1420 strings[i] = g_variant_ref_sink (g_variant_new_bytestring (strv[i]));
1422 return g_variant_new_from_children (G_VARIANT_TYPE_BYTESTRING_ARRAY,
1423 strings, length, TRUE);
1427 * g_variant_get_bytestring_array:
1428 * @value: an array of array of bytes #GVariant ('aay')
1429 * @length: (allow-none): the length of the result, or %NULL
1430 * @returns: (array length=length): an array of constant strings
1432 * Gets the contents of an array of array of bytes #GVariant. This call
1433 * makes a shallow copy; the return result should be released with
1434 * g_free(), but the individual strings must not be modified.
1436 * If @length is non-%NULL then the number of elements in the result is
1437 * stored there. In any case, the resulting array will be
1440 * For an empty array, @length will be set to 0 and a pointer to a
1441 * %NULL pointer will be returned.
1446 g_variant_get_bytestring_array (GVariant *value,
1453 TYPE_CHECK (value, G_VARIANT_TYPE_BYTESTRING_ARRAY, NULL);
1455 g_variant_get_data (value);
1456 n = g_variant_n_children (value);
1457 strv = g_new (const gchar *, n + 1);
1459 for (i = 0; i < n; i++)
1463 string = g_variant_get_child_value (value, i);
1464 strv[i] = g_variant_get_bytestring (string);
1465 g_variant_unref (string);
1476 * g_variant_dup_bytestring_array:
1477 * @value: an array of array of bytes #GVariant ('aay')
1478 * @length: (allow-none): the length of the result, or %NULL
1479 * @returns: (array length=length): an array of strings
1481 * Gets the contents of an array of array of bytes #GVariant. This call
1482 * makes a deep copy; the return result should be released with
1485 * If @length is non-%NULL then the number of elements in the result is
1486 * stored there. In any case, the resulting array will be
1489 * For an empty array, @length will be set to 0 and a pointer to a
1490 * %NULL pointer will be returned.
1495 g_variant_dup_bytestring_array (GVariant *value,
1502 TYPE_CHECK (value, G_VARIANT_TYPE_BYTESTRING_ARRAY, NULL);
1504 g_variant_get_data (value);
1505 n = g_variant_n_children (value);
1506 strv = g_new (gchar *, n + 1);
1508 for (i = 0; i < n; i++)
1512 string = g_variant_get_child_value (value, i);
1513 strv[i] = g_variant_dup_bytestring (string, NULL);
1514 g_variant_unref (string);
1524 /* Type checking and querying {{{1 */
1526 * g_variant_get_type:
1527 * @value: a #GVariant
1528 * @returns: a #GVariantType
1530 * Determines the type of @value.
1532 * The return value is valid for the lifetime of @value and must not
1537 const GVariantType *
1538 g_variant_get_type (GVariant *value)
1540 GVariantTypeInfo *type_info;
1542 g_return_val_if_fail (value != NULL, NULL);
1544 type_info = g_variant_get_type_info (value);
1546 return (GVariantType *) g_variant_type_info_get_type_string (type_info);
1550 * g_variant_get_type_string:
1551 * @value: a #GVariant
1552 * @returns: the type string for the type of @value
1554 * Returns the type string of @value. Unlike the result of calling
1555 * g_variant_type_peek_string(), this string is nul-terminated. This
1556 * string belongs to #GVariant and must not be freed.
1561 g_variant_get_type_string (GVariant *value)
1563 GVariantTypeInfo *type_info;
1565 g_return_val_if_fail (value != NULL, NULL);
1567 type_info = g_variant_get_type_info (value);
1569 return g_variant_type_info_get_type_string (type_info);
1573 * g_variant_is_of_type:
1574 * @value: a #GVariant instance
1575 * @type: a #GVariantType
1576 * @returns: %TRUE if the type of @value matches @type
1578 * Checks if a value has a type matching the provided type.
1583 g_variant_is_of_type (GVariant *value,
1584 const GVariantType *type)
1586 return g_variant_type_is_subtype_of (g_variant_get_type (value), type);
1590 * g_variant_is_container:
1591 * @value: a #GVariant instance
1592 * @returns: %TRUE if @value is a container
1594 * Checks if @value is a container.
1597 g_variant_is_container (GVariant *value)
1599 return g_variant_type_is_container (g_variant_get_type (value));
1604 * g_variant_classify:
1605 * @value: a #GVariant
1606 * @returns: the #GVariantClass of @value
1608 * Classifies @value according to its top-level type.
1614 * @G_VARIANT_CLASS_BOOLEAN: The #GVariant is a boolean.
1615 * @G_VARIANT_CLASS_BYTE: The #GVariant is a byte.
1616 * @G_VARIANT_CLASS_INT16: The #GVariant is a signed 16 bit integer.
1617 * @G_VARIANT_CLASS_UINT16: The #GVariant is an unsigned 16 bit integer.
1618 * @G_VARIANT_CLASS_INT32: The #GVariant is a signed 32 bit integer.
1619 * @G_VARIANT_CLASS_UINT32: The #GVariant is an unsigned 32 bit integer.
1620 * @G_VARIANT_CLASS_INT64: The #GVariant is a signed 64 bit integer.
1621 * @G_VARIANT_CLASS_UINT64: The #GVariant is an unsigned 64 bit integer.
1622 * @G_VARIANT_CLASS_HANDLE: The #GVariant is a file handle index.
1623 * @G_VARIANT_CLASS_DOUBLE: The #GVariant is a double precision floating
1625 * @G_VARIANT_CLASS_STRING: The #GVariant is a normal string.
1626 * @G_VARIANT_CLASS_OBJECT_PATH: The #GVariant is a DBus object path
1628 * @G_VARIANT_CLASS_SIGNATURE: The #GVariant is a DBus signature string.
1629 * @G_VARIANT_CLASS_VARIANT: The #GVariant is a variant.
1630 * @G_VARIANT_CLASS_MAYBE: The #GVariant is a maybe-typed value.
1631 * @G_VARIANT_CLASS_ARRAY: The #GVariant is an array.
1632 * @G_VARIANT_CLASS_TUPLE: The #GVariant is a tuple.
1633 * @G_VARIANT_CLASS_DICT_ENTRY: The #GVariant is a dictionary entry.
1635 * The range of possible top-level types of #GVariant instances.
1640 g_variant_classify (GVariant *value)
1642 g_return_val_if_fail (value != NULL, 0);
1644 return *g_variant_get_type_string (value);
1647 /* Pretty printer {{{1 */
1649 * g_variant_print_string:
1650 * @value: a #GVariant
1651 * @string: (allow-none) (default NULL): a #GString, or %NULL
1652 * @type_annotate: %TRUE if type information should be included in
1654 * @returns: a #GString containing the string
1656 * Behaves as g_variant_print(), but operates on a #GString.
1658 * If @string is non-%NULL then it is appended to and returned. Else,
1659 * a new empty #GString is allocated and it is returned.
1664 g_variant_print_string (GVariant *value,
1666 gboolean type_annotate)
1668 if G_UNLIKELY (string == NULL)
1669 string = g_string_new (NULL);
1671 switch (g_variant_classify (value))
1673 case G_VARIANT_CLASS_MAYBE:
1675 g_string_append_printf (string, "@%s ",
1676 g_variant_get_type_string (value));
1678 if (g_variant_n_children (value))
1680 gchar *printed_child;
1685 * Consider the case of the type "mmi". In this case we could
1686 * write "just just 4", but "4" alone is totally unambiguous,
1687 * so we try to drop "just" where possible.
1689 * We have to be careful not to always drop "just", though,
1690 * since "nothing" needs to be distinguishable from "just
1691 * nothing". The case where we need to ensure we keep the
1692 * "just" is actually exactly the case where we have a nested
1695 * Instead of searching for that nested Nothing, we just print
1696 * the contained value into a separate string and see if we
1697 * end up with "nothing" at the end of it. If so, we need to
1698 * add "just" at our level.
1700 element = g_variant_get_child_value (value, 0);
1701 printed_child = g_variant_print (element, FALSE);
1702 g_variant_unref (element);
1704 if (g_str_has_suffix (printed_child, "nothing"))
1705 g_string_append (string, "just ");
1706 g_string_append (string, printed_child);
1707 g_free (printed_child);
1710 g_string_append (string, "nothing");
1714 case G_VARIANT_CLASS_ARRAY:
1715 /* it's an array so the first character of the type string is 'a'
1717 * if the first two characters are 'ay' then it's a bytestring.
1718 * under certain conditions we print those as strings.
1720 if (g_variant_get_type_string (value)[1] == 'y')
1726 /* first determine if it is a byte string.
1727 * that's when there's a single nul character: at the end.
1729 str = g_variant_get_data (value);
1730 size = g_variant_get_size (value);
1732 for (i = 0; i < size; i++)
1736 /* first nul byte is the last byte -> it's a byte string. */
1739 gchar *escaped = g_strescape (str, NULL);
1741 /* use double quotes only if a ' is in the string */
1742 if (strchr (str, '\''))
1743 g_string_append_printf (string, "b\"%s\"", escaped);
1745 g_string_append_printf (string, "b'%s'", escaped);
1752 /* fall through and handle normally... */;
1756 * if the first two characters are 'a{' then it's an array of
1757 * dictionary entries (ie: a dictionary) so we print that
1760 if (g_variant_get_type_string (value)[1] == '{')
1763 const gchar *comma = "";
1766 if ((n = g_variant_n_children (value)) == 0)
1769 g_string_append_printf (string, "@%s ",
1770 g_variant_get_type_string (value));
1771 g_string_append (string, "{}");
1775 g_string_append_c (string, '{');
1776 for (i = 0; i < n; i++)
1778 GVariant *entry, *key, *val;
1780 g_string_append (string, comma);
1783 entry = g_variant_get_child_value (value, i);
1784 key = g_variant_get_child_value (entry, 0);
1785 val = g_variant_get_child_value (entry, 1);
1786 g_variant_unref (entry);
1788 g_variant_print_string (key, string, type_annotate);
1789 g_variant_unref (key);
1790 g_string_append (string, ": ");
1791 g_variant_print_string (val, string, type_annotate);
1792 g_variant_unref (val);
1793 type_annotate = FALSE;
1795 g_string_append_c (string, '}');
1798 /* normal (non-dictionary) array */
1800 const gchar *comma = "";
1803 if ((n = g_variant_n_children (value)) == 0)
1806 g_string_append_printf (string, "@%s ",
1807 g_variant_get_type_string (value));
1808 g_string_append (string, "[]");
1812 g_string_append_c (string, '[');
1813 for (i = 0; i < n; i++)
1817 g_string_append (string, comma);
1820 element = g_variant_get_child_value (value, i);
1822 g_variant_print_string (element, string, type_annotate);
1823 g_variant_unref (element);
1824 type_annotate = FALSE;
1826 g_string_append_c (string, ']');
1831 case G_VARIANT_CLASS_TUPLE:
1835 n = g_variant_n_children (value);
1837 g_string_append_c (string, '(');
1838 for (i = 0; i < n; i++)
1842 element = g_variant_get_child_value (value, i);
1843 g_variant_print_string (element, string, type_annotate);
1844 g_string_append (string, ", ");
1845 g_variant_unref (element);
1848 /* for >1 item: remove final ", "
1849 * for 1 item: remove final " ", but leave the ","
1850 * for 0 items: there is only "(", so remove nothing
1852 g_string_truncate (string, string->len - (n > 0) - (n > 1));
1853 g_string_append_c (string, ')');
1857 case G_VARIANT_CLASS_DICT_ENTRY:
1861 g_string_append_c (string, '{');
1863 element = g_variant_get_child_value (value, 0);
1864 g_variant_print_string (element, string, type_annotate);
1865 g_variant_unref (element);
1867 g_string_append (string, ", ");
1869 element = g_variant_get_child_value (value, 1);
1870 g_variant_print_string (element, string, type_annotate);
1871 g_variant_unref (element);
1873 g_string_append_c (string, '}');
1877 case G_VARIANT_CLASS_VARIANT:
1879 GVariant *child = g_variant_get_variant (value);
1881 /* Always annotate types in nested variants, because they are
1882 * (by nature) of variable type.
1884 g_string_append_c (string, '<');
1885 g_variant_print_string (child, string, TRUE);
1886 g_string_append_c (string, '>');
1888 g_variant_unref (child);
1892 case G_VARIANT_CLASS_BOOLEAN:
1893 if (g_variant_get_boolean (value))
1894 g_string_append (string, "true");
1896 g_string_append (string, "false");
1899 case G_VARIANT_CLASS_STRING:
1901 const gchar *str = g_variant_get_string (value, NULL);
1902 gunichar quote = strchr (str, '\'') ? '"' : '\'';
1904 g_string_append_c (string, quote);
1908 gunichar c = g_utf8_get_char (str);
1910 if (c == quote || c == '\\')
1911 g_string_append_c (string, '\\');
1913 if (g_unichar_isprint (c))
1914 g_string_append_unichar (string, c);
1918 g_string_append_c (string, '\\');
1923 g_string_append_c (string, 'a');
1927 g_string_append_c (string, 'b');
1931 g_string_append_c (string, 'f');
1935 g_string_append_c (string, 'n');
1939 g_string_append_c (string, 'r');
1943 g_string_append_c (string, 't');
1947 g_string_append_c (string, 'v');
1951 g_string_append_printf (string, "u%04x", c);
1955 g_string_append_printf (string, "U%08x", c);
1958 str = g_utf8_next_char (str);
1961 g_string_append_c (string, quote);
1965 case G_VARIANT_CLASS_BYTE:
1967 g_string_append (string, "byte ");
1968 g_string_append_printf (string, "0x%02x",
1969 g_variant_get_byte (value));
1972 case G_VARIANT_CLASS_INT16:
1974 g_string_append (string, "int16 ");
1975 g_string_append_printf (string, "%"G_GINT16_FORMAT,
1976 g_variant_get_int16 (value));
1979 case G_VARIANT_CLASS_UINT16:
1981 g_string_append (string, "uint16 ");
1982 g_string_append_printf (string, "%"G_GUINT16_FORMAT,
1983 g_variant_get_uint16 (value));
1986 case G_VARIANT_CLASS_INT32:
1987 /* Never annotate this type because it is the default for numbers
1988 * (and this is a *pretty* printer)
1990 g_string_append_printf (string, "%"G_GINT32_FORMAT,
1991 g_variant_get_int32 (value));
1994 case G_VARIANT_CLASS_HANDLE:
1996 g_string_append (string, "handle ");
1997 g_string_append_printf (string, "%"G_GINT32_FORMAT,
1998 g_variant_get_handle (value));
2001 case G_VARIANT_CLASS_UINT32:
2003 g_string_append (string, "uint32 ");
2004 g_string_append_printf (string, "%"G_GUINT32_FORMAT,
2005 g_variant_get_uint32 (value));
2008 case G_VARIANT_CLASS_INT64:
2010 g_string_append (string, "int64 ");
2011 g_string_append_printf (string, "%"G_GINT64_FORMAT,
2012 g_variant_get_int64 (value));
2015 case G_VARIANT_CLASS_UINT64:
2017 g_string_append (string, "uint64 ");
2018 g_string_append_printf (string, "%"G_GUINT64_FORMAT,
2019 g_variant_get_uint64 (value));
2022 case G_VARIANT_CLASS_DOUBLE:
2027 g_ascii_dtostr (buffer, sizeof buffer, g_variant_get_double (value));
2029 for (i = 0; buffer[i]; i++)
2030 if (buffer[i] == '.' || buffer[i] == 'e' ||
2031 buffer[i] == 'n' || buffer[i] == 'N')
2034 /* if there is no '.' or 'e' in the float then add one */
2035 if (buffer[i] == '\0')
2042 g_string_append (string, buffer);
2046 case G_VARIANT_CLASS_OBJECT_PATH:
2048 g_string_append (string, "objectpath ");
2049 g_string_append_printf (string, "\'%s\'",
2050 g_variant_get_string (value, NULL));
2053 case G_VARIANT_CLASS_SIGNATURE:
2055 g_string_append (string, "signature ");
2056 g_string_append_printf (string, "\'%s\'",
2057 g_variant_get_string (value, NULL));
2061 g_assert_not_reached ();
2069 * @value: a #GVariant
2070 * @type_annotate: %TRUE if type information should be included in
2072 * @returns: a newly-allocated string holding the result.
2074 * Pretty-prints @value in the format understood by g_variant_parse().
2076 * If @type_annotate is %TRUE, then type information is included in
2080 g_variant_print (GVariant *value,
2081 gboolean type_annotate)
2083 return g_string_free (g_variant_print_string (value, NULL, type_annotate),
2087 /* Hash, Equal, Compare {{{1 */
2090 * @value: (type GVariant): a basic #GVariant value as a #gconstpointer
2091 * @returns: a hash value corresponding to @value
2093 * Generates a hash value for a #GVariant instance.
2095 * The output of this function is guaranteed to be the same for a given
2096 * value only per-process. It may change between different processor
2097 * architectures or even different versions of GLib. Do not use this
2098 * function as a basis for building protocols or file formats.
2100 * The type of @value is #gconstpointer only to allow use of this
2101 * function with #GHashTable. @value must be a #GVariant.
2106 g_variant_hash (gconstpointer value_)
2108 GVariant *value = (GVariant *) value_;
2110 switch (g_variant_classify (value))
2112 case G_VARIANT_CLASS_STRING:
2113 case G_VARIANT_CLASS_OBJECT_PATH:
2114 case G_VARIANT_CLASS_SIGNATURE:
2115 return g_str_hash (g_variant_get_string (value, NULL));
2117 case G_VARIANT_CLASS_BOOLEAN:
2118 /* this is a very odd thing to hash... */
2119 return g_variant_get_boolean (value);
2121 case G_VARIANT_CLASS_BYTE:
2122 return g_variant_get_byte (value);
2124 case G_VARIANT_CLASS_INT16:
2125 case G_VARIANT_CLASS_UINT16:
2129 ptr = g_variant_get_data (value);
2137 case G_VARIANT_CLASS_INT32:
2138 case G_VARIANT_CLASS_UINT32:
2139 case G_VARIANT_CLASS_HANDLE:
2143 ptr = g_variant_get_data (value);
2151 case G_VARIANT_CLASS_INT64:
2152 case G_VARIANT_CLASS_UINT64:
2153 case G_VARIANT_CLASS_DOUBLE:
2154 /* need a separate case for these guys because otherwise
2155 * performance could be quite bad on big endian systems
2160 ptr = g_variant_get_data (value);
2163 return ptr[0] + ptr[1];
2169 g_return_val_if_fail (!g_variant_is_container (value), 0);
2170 g_assert_not_reached ();
2176 * @one: (type GVariant): a #GVariant instance
2177 * @two: (type GVariant): a #GVariant instance
2178 * @returns: %TRUE if @one and @two are equal
2180 * Checks if @one and @two have the same type and value.
2182 * The types of @one and @two are #gconstpointer only to allow use of
2183 * this function with #GHashTable. They must each be a #GVariant.
2188 g_variant_equal (gconstpointer one,
2193 g_return_val_if_fail (one != NULL && two != NULL, FALSE);
2195 if (g_variant_get_type_info ((GVariant *) one) !=
2196 g_variant_get_type_info ((GVariant *) two))
2199 /* if both values are trusted to be in their canonical serialised form
2200 * then a simple memcmp() of their serialised data will answer the
2203 * if not, then this might generate a false negative (since it is
2204 * possible for two different byte sequences to represent the same
2205 * value). for now we solve this by pretty-printing both values and
2206 * comparing the result.
2208 if (g_variant_is_trusted ((GVariant *) one) &&
2209 g_variant_is_trusted ((GVariant *) two))
2211 gconstpointer data_one, data_two;
2212 gsize size_one, size_two;
2214 size_one = g_variant_get_size ((GVariant *) one);
2215 size_two = g_variant_get_size ((GVariant *) two);
2217 if (size_one != size_two)
2220 data_one = g_variant_get_data ((GVariant *) one);
2221 data_two = g_variant_get_data ((GVariant *) two);
2223 equal = memcmp (data_one, data_two, size_one) == 0;
2227 gchar *strone, *strtwo;
2229 strone = g_variant_print ((GVariant *) one, FALSE);
2230 strtwo = g_variant_print ((GVariant *) two, FALSE);
2231 equal = strcmp (strone, strtwo) == 0;
2240 * g_variant_compare:
2241 * @one: (type GVariant): a basic-typed #GVariant instance
2242 * @two: (type GVariant): a #GVariant instance of the same type
2243 * @returns: negative value if a < b;
2245 * positive value if a > b.
2247 * Compares @one and @two.
2249 * The types of @one and @two are #gconstpointer only to allow use of
2250 * this function with #GTree, #GPtrArray, etc. They must each be a
2253 * Comparison is only defined for basic types (ie: booleans, numbers,
2254 * strings). For booleans, %FALSE is less than %TRUE. Numbers are
2255 * ordered in the usual way. Strings are in ASCII lexographical order.
2257 * It is a programmer error to attempt to compare container values or
2258 * two values that have types that are not exactly equal. For example,
2259 * you can not compare a 32-bit signed integer with a 32-bit unsigned
2260 * integer. Also note that this function is not particularly
2261 * well-behaved when it comes to comparison of doubles; in particular,
2262 * the handling of incomparable values (ie: NaN) is undefined.
2264 * If you only require an equality comparison, g_variant_equal() is more
2270 g_variant_compare (gconstpointer one,
2273 GVariant *a = (GVariant *) one;
2274 GVariant *b = (GVariant *) two;
2276 g_return_val_if_fail (g_variant_classify (a) == g_variant_classify (b), 0);
2278 switch (g_variant_classify (a))
2280 case G_VARIANT_CLASS_BYTE:
2281 return ((gint) g_variant_get_byte (a)) -
2282 ((gint) g_variant_get_byte (b));
2284 case G_VARIANT_CLASS_INT16:
2285 return ((gint) g_variant_get_int16 (a)) -
2286 ((gint) g_variant_get_int16 (b));
2288 case G_VARIANT_CLASS_UINT16:
2289 return ((gint) g_variant_get_uint16 (a)) -
2290 ((gint) g_variant_get_uint16 (b));
2292 case G_VARIANT_CLASS_INT32:
2294 gint32 a_val = g_variant_get_int32 (a);
2295 gint32 b_val = g_variant_get_int32 (b);
2297 return (a_val == b_val) ? 0 : (a_val > b_val) ? 1 : -1;
2300 case G_VARIANT_CLASS_UINT32:
2302 guint32 a_val = g_variant_get_uint32 (a);
2303 guint32 b_val = g_variant_get_uint32 (b);
2305 return (a_val == b_val) ? 0 : (a_val > b_val) ? 1 : -1;
2308 case G_VARIANT_CLASS_INT64:
2310 gint64 a_val = g_variant_get_int64 (a);
2311 gint64 b_val = g_variant_get_int64 (b);
2313 return (a_val == b_val) ? 0 : (a_val > b_val) ? 1 : -1;
2316 case G_VARIANT_CLASS_UINT64:
2318 guint64 a_val = g_variant_get_int32 (a);
2319 guint64 b_val = g_variant_get_int32 (b);
2321 return (a_val == b_val) ? 0 : (a_val > b_val) ? 1 : -1;
2324 case G_VARIANT_CLASS_DOUBLE:
2326 gdouble a_val = g_variant_get_double (a);
2327 gdouble b_val = g_variant_get_double (b);
2329 return (a_val == b_val) ? 0 : (a_val > b_val) ? 1 : -1;
2332 case G_VARIANT_CLASS_STRING:
2333 case G_VARIANT_CLASS_OBJECT_PATH:
2334 case G_VARIANT_CLASS_SIGNATURE:
2335 return strcmp (g_variant_get_string (a, NULL),
2336 g_variant_get_string (b, NULL));
2339 g_return_val_if_fail (!g_variant_is_container (a), 0);
2340 g_assert_not_reached ();
2344 /* GVariantIter {{{1 */
2348 * #GVariantIter is an opaque data structure and can only be accessed
2349 * using the following functions.
2356 const gchar *loop_format;
2362 G_STATIC_ASSERT (sizeof (struct stack_iter) <= sizeof (GVariantIter));
2366 struct stack_iter iter;
2368 GVariant *value_ref;
2372 #define GVSI(i) ((struct stack_iter *) (i))
2373 #define GVHI(i) ((struct heap_iter *) (i))
2374 #define GVSI_MAGIC ((gsize) 3579507750u)
2375 #define GVHI_MAGIC ((gsize) 1450270775u)
2376 #define is_valid_iter(i) (i != NULL && \
2377 GVSI(i)->magic == GVSI_MAGIC)
2378 #define is_valid_heap_iter(i) (GVHI(i)->magic == GVHI_MAGIC && \
2382 * g_variant_iter_new:
2383 * @value: a container #GVariant
2384 * @returns: a new heap-allocated #GVariantIter
2386 * Creates a heap-allocated #GVariantIter for iterating over the items
2389 * Use g_variant_iter_free() to free the return value when you no longer
2392 * A reference is taken to @value and will be released only when
2393 * g_variant_iter_free() is called.
2398 g_variant_iter_new (GVariant *value)
2402 iter = (GVariantIter *) g_slice_new (struct heap_iter);
2403 GVHI(iter)->value_ref = g_variant_ref (value);
2404 GVHI(iter)->magic = GVHI_MAGIC;
2406 g_variant_iter_init (iter, value);
2412 * g_variant_iter_init:
2413 * @iter: a pointer to a #GVariantIter
2414 * @value: a container #GVariant
2415 * @returns: the number of items in @value
2417 * Initialises (without allocating) a #GVariantIter. @iter may be
2418 * completely uninitialised prior to this call; its old value is
2421 * The iterator remains valid for as long as @value exists, and need not
2422 * be freed in any way.
2427 g_variant_iter_init (GVariantIter *iter,
2430 GVSI(iter)->magic = GVSI_MAGIC;
2431 GVSI(iter)->value = value;
2432 GVSI(iter)->n = g_variant_n_children (value);
2434 GVSI(iter)->loop_format = NULL;
2436 return GVSI(iter)->n;
2440 * g_variant_iter_copy:
2441 * @iter: a #GVariantIter
2442 * @returns: a new heap-allocated #GVariantIter
2444 * Creates a new heap-allocated #GVariantIter to iterate over the
2445 * container that was being iterated over by @iter. Iteration begins on
2446 * the new iterator from the current position of the old iterator but
2447 * the two copies are independent past that point.
2449 * Use g_variant_iter_free() to free the return value when you no longer
2452 * A reference is taken to the container that @iter is iterating over
2453 * and will be releated only when g_variant_iter_free() is called.
2458 g_variant_iter_copy (GVariantIter *iter)
2462 g_return_val_if_fail (is_valid_iter (iter), 0);
2464 copy = g_variant_iter_new (GVSI(iter)->value);
2465 GVSI(copy)->i = GVSI(iter)->i;
2471 * g_variant_iter_n_children:
2472 * @iter: a #GVariantIter
2473 * @returns: the number of children in the container
2475 * Queries the number of child items in the container that we are
2476 * iterating over. This is the total number of items -- not the number
2477 * of items remaining.
2479 * This function might be useful for preallocation of arrays.
2484 g_variant_iter_n_children (GVariantIter *iter)
2486 g_return_val_if_fail (is_valid_iter (iter), 0);
2488 return GVSI(iter)->n;
2492 * g_variant_iter_free:
2493 * @iter: a heap-allocated #GVariantIter
2495 * Frees a heap-allocated #GVariantIter. Only call this function on
2496 * iterators that were returned by g_variant_iter_new() or
2497 * g_variant_iter_copy().
2502 g_variant_iter_free (GVariantIter *iter)
2504 g_return_if_fail (is_valid_heap_iter (iter));
2506 g_variant_unref (GVHI(iter)->value_ref);
2507 GVHI(iter)->magic = 0;
2509 g_slice_free (struct heap_iter, GVHI(iter));
2513 * g_variant_iter_next_value:
2514 * @iter: a #GVariantIter
2515 * @returns: (allow-none): a #GVariant, or %NULL
2517 * Gets the next item in the container. If no more items remain then
2518 * %NULL is returned.
2520 * Use g_variant_unref() to drop your reference on the return value when
2521 * you no longer need it.
2524 * <title>Iterating with g_variant_iter_next_value()</title>
2526 * /<!-- -->* recursively iterate a container *<!-- -->/
2528 * iterate_container_recursive (GVariant *container)
2530 * GVariantIter iter;
2533 * g_variant_iter_init (&iter, dictionary);
2534 * while ((child = g_variant_iter_next_value (&iter)))
2536 * g_print ("type '%s'\n", g_variant_get_type_string (child));
2538 * if (g_variant_is_container (child))
2539 * iterate_container_recursive (child);
2541 * g_variant_unref (child);
2550 g_variant_iter_next_value (GVariantIter *iter)
2552 g_return_val_if_fail (is_valid_iter (iter), FALSE);
2554 if G_UNLIKELY (GVSI(iter)->i >= GVSI(iter)->n)
2556 g_critical ("g_variant_iter_next_value: must not be called again "
2557 "after NULL has already been returned.");
2563 if (GVSI(iter)->i < GVSI(iter)->n)
2564 return g_variant_get_child_value (GVSI(iter)->value, GVSI(iter)->i);
2569 /* GVariantBuilder {{{1 */
2573 * A utility type for constructing container-type #GVariant instances.
2575 * This is an opaque structure and may only be accessed using the
2576 * following functions.
2578 * #GVariantBuilder is not threadsafe in any way. Do not attempt to
2579 * access it from more than one thread.
2582 struct stack_builder
2584 GVariantBuilder *parent;
2587 /* type constraint explicitly specified by 'type'.
2588 * for tuple types, this moves along as we add more items.
2590 const GVariantType *expected_type;
2592 /* type constraint implied by previous array item.
2594 const GVariantType *prev_item_type;
2596 /* constraints on the number of children. max = -1 for unlimited. */
2600 /* dynamically-growing pointer array */
2601 GVariant **children;
2602 gsize allocated_children;
2605 /* set to '1' if all items in the container will have the same type
2606 * (ie: maybe, array, variant) '0' if not (ie: tuple, dict entry)
2608 guint uniform_item_types : 1;
2610 /* set to '1' initially and changed to '0' if an untrusted value is
2618 G_STATIC_ASSERT (sizeof (struct stack_builder) <= sizeof (GVariantBuilder));
2622 GVariantBuilder builder;
2628 #define GVSB(b) ((struct stack_builder *) (b))
2629 #define GVHB(b) ((struct heap_builder *) (b))
2630 #define GVSB_MAGIC ((gsize) 1033660112u)
2631 #define GVHB_MAGIC ((gsize) 3087242682u)
2632 #define is_valid_builder(b) (b != NULL && \
2633 GVSB(b)->magic == GVSB_MAGIC)
2634 #define is_valid_heap_builder(b) (GVHB(b)->magic == GVHB_MAGIC)
2637 * g_variant_builder_new:
2638 * @type: a container type
2639 * @returns: a #GVariantBuilder
2641 * Allocates and initialises a new #GVariantBuilder.
2643 * You should call g_variant_builder_unref() on the return value when it
2644 * is no longer needed. The memory will not be automatically freed by
2647 * In most cases it is easier to place a #GVariantBuilder directly on
2648 * the stack of the calling function and initialise it with
2649 * g_variant_builder_init().
2654 g_variant_builder_new (const GVariantType *type)
2656 GVariantBuilder *builder;
2658 builder = (GVariantBuilder *) g_slice_new (struct heap_builder);
2659 g_variant_builder_init (builder, type);
2660 GVHB(builder)->magic = GVHB_MAGIC;
2661 GVHB(builder)->ref_count = 1;
2667 * g_variant_builder_unref:
2668 * @builder: a #GVariantBuilder allocated by g_variant_builder_new()
2670 * Decreases the reference count on @builder.
2672 * In the event that there are no more references, releases all memory
2673 * associated with the #GVariantBuilder.
2675 * Don't call this on stack-allocated #GVariantBuilder instances or bad
2676 * things will happen.
2681 g_variant_builder_unref (GVariantBuilder *builder)
2683 g_return_if_fail (is_valid_heap_builder (builder));
2685 if (--GVHB(builder)->ref_count)
2688 g_variant_builder_clear (builder);
2689 GVHB(builder)->magic = 0;
2691 g_slice_free (struct heap_builder, GVHB(builder));
2695 * g_variant_builder_ref:
2696 * @builder: a #GVariantBuilder allocated by g_variant_builder_new()
2697 * @returns: a new reference to @builder
2699 * Increases the reference count on @builder.
2701 * Don't call this on stack-allocated #GVariantBuilder instances or bad
2702 * things will happen.
2707 g_variant_builder_ref (GVariantBuilder *builder)
2709 g_return_val_if_fail (is_valid_heap_builder (builder), NULL);
2711 GVHB(builder)->ref_count++;
2717 * g_variant_builder_clear:
2718 * @builder: a #GVariantBuilder
2720 * Releases all memory associated with a #GVariantBuilder without
2721 * freeing the #GVariantBuilder structure itself.
2723 * It typically only makes sense to do this on a stack-allocated
2724 * #GVariantBuilder if you want to abort building the value part-way
2725 * through. This function need not be called if you call
2726 * g_variant_builder_end() and it also doesn't need to be called on
2727 * builders allocated with g_variant_builder_new (see
2728 * g_variant_builder_free() for that).
2730 * This function leaves the #GVariantBuilder structure set to all-zeros.
2731 * It is valid to call this function on either an initialised
2732 * #GVariantBuilder or one that is set to all-zeros but it is not valid
2733 * to call this function on uninitialised memory.
2738 g_variant_builder_clear (GVariantBuilder *builder)
2742 if (GVSB(builder)->magic == 0)
2743 /* all-zeros case */
2746 g_return_if_fail (is_valid_builder (builder));
2748 g_variant_type_free (GVSB(builder)->type);
2750 for (i = 0; i < GVSB(builder)->offset; i++)
2751 g_variant_unref (GVSB(builder)->children[i]);
2753 g_free (GVSB(builder)->children);
2755 if (GVSB(builder)->parent)
2757 g_variant_builder_clear (GVSB(builder)->parent);
2758 g_slice_free (GVariantBuilder, GVSB(builder)->parent);
2761 memset (builder, 0, sizeof (GVariantBuilder));
2765 * g_variant_builder_init:
2766 * @builder: a #GVariantBuilder
2767 * @type: a container type
2769 * Initialises a #GVariantBuilder structure.
2771 * @type must be non-%NULL. It specifies the type of container to
2772 * construct. It can be an indefinite type such as
2773 * %G_VARIANT_TYPE_ARRAY or a definite type such as "as" or "(ii)".
2774 * Maybe, array, tuple, dictionary entry and variant-typed values may be
2777 * After the builder is initialised, values are added using
2778 * g_variant_builder_add_value() or g_variant_builder_add().
2780 * After all the child values are added, g_variant_builder_end() frees
2781 * the memory associated with the builder and returns the #GVariant that
2784 * This function completely ignores the previous contents of @builder.
2785 * On one hand this means that it is valid to pass in completely
2786 * uninitialised memory. On the other hand, this means that if you are
2787 * initialising over top of an existing #GVariantBuilder you need to
2788 * first call g_variant_builder_clear() in order to avoid leaking
2791 * You must not call g_variant_builder_ref() or
2792 * g_variant_builder_unref() on a #GVariantBuilder that was initialised
2793 * with this function. If you ever pass a reference to a
2794 * #GVariantBuilder outside of the control of your own code then you
2795 * should assume that the person receiving that reference may try to use
2796 * reference counting; you should use g_variant_builder_new() instead of
2802 g_variant_builder_init (GVariantBuilder *builder,
2803 const GVariantType *type)
2805 g_return_if_fail (type != NULL);
2806 g_return_if_fail (g_variant_type_is_container (type));
2808 memset (builder, 0, sizeof (GVariantBuilder));
2810 GVSB(builder)->type = g_variant_type_copy (type);
2811 GVSB(builder)->magic = GVSB_MAGIC;
2812 GVSB(builder)->trusted = TRUE;
2814 switch (*(const gchar *) type)
2816 case G_VARIANT_CLASS_VARIANT:
2817 GVSB(builder)->uniform_item_types = TRUE;
2818 GVSB(builder)->allocated_children = 1;
2819 GVSB(builder)->expected_type = NULL;
2820 GVSB(builder)->min_items = 1;
2821 GVSB(builder)->max_items = 1;
2824 case G_VARIANT_CLASS_ARRAY:
2825 GVSB(builder)->uniform_item_types = TRUE;
2826 GVSB(builder)->allocated_children = 8;
2827 GVSB(builder)->expected_type =
2828 g_variant_type_element (GVSB(builder)->type);
2829 GVSB(builder)->min_items = 0;
2830 GVSB(builder)->max_items = -1;
2833 case G_VARIANT_CLASS_MAYBE:
2834 GVSB(builder)->uniform_item_types = TRUE;
2835 GVSB(builder)->allocated_children = 1;
2836 GVSB(builder)->expected_type =
2837 g_variant_type_element (GVSB(builder)->type);
2838 GVSB(builder)->min_items = 0;
2839 GVSB(builder)->max_items = 1;
2842 case G_VARIANT_CLASS_DICT_ENTRY:
2843 GVSB(builder)->uniform_item_types = FALSE;
2844 GVSB(builder)->allocated_children = 2;
2845 GVSB(builder)->expected_type =
2846 g_variant_type_key (GVSB(builder)->type);
2847 GVSB(builder)->min_items = 2;
2848 GVSB(builder)->max_items = 2;
2851 case 'r': /* G_VARIANT_TYPE_TUPLE was given */
2852 GVSB(builder)->uniform_item_types = FALSE;
2853 GVSB(builder)->allocated_children = 8;
2854 GVSB(builder)->expected_type = NULL;
2855 GVSB(builder)->min_items = 0;
2856 GVSB(builder)->max_items = -1;
2859 case G_VARIANT_CLASS_TUPLE: /* a definite tuple type was given */
2860 GVSB(builder)->allocated_children = g_variant_type_n_items (type);
2861 GVSB(builder)->expected_type =
2862 g_variant_type_first (GVSB(builder)->type);
2863 GVSB(builder)->min_items = GVSB(builder)->allocated_children;
2864 GVSB(builder)->max_items = GVSB(builder)->allocated_children;
2865 GVSB(builder)->uniform_item_types = FALSE;
2869 g_assert_not_reached ();
2872 GVSB(builder)->children = g_new (GVariant *,
2873 GVSB(builder)->allocated_children);
2877 g_variant_builder_make_room (struct stack_builder *builder)
2879 if (builder->offset == builder->allocated_children)
2881 builder->allocated_children *= 2;
2882 builder->children = g_renew (GVariant *, builder->children,
2883 builder->allocated_children);
2888 * g_variant_builder_add_value:
2889 * @builder: a #GVariantBuilder
2890 * @value: a #GVariant
2892 * Adds @value to @builder.
2894 * It is an error to call this function in any way that would create an
2895 * inconsistent value to be constructed. Some examples of this are
2896 * putting different types of items into an array, putting the wrong
2897 * types or number of items in a tuple, putting more than one value into
2903 g_variant_builder_add_value (GVariantBuilder *builder,
2906 g_return_if_fail (is_valid_builder (builder));
2907 g_return_if_fail (GVSB(builder)->offset < GVSB(builder)->max_items);
2908 g_return_if_fail (!GVSB(builder)->expected_type ||
2909 g_variant_is_of_type (value,
2910 GVSB(builder)->expected_type));
2911 g_return_if_fail (!GVSB(builder)->prev_item_type ||
2912 g_variant_is_of_type (value,
2913 GVSB(builder)->prev_item_type));
2915 GVSB(builder)->trusted &= g_variant_is_trusted (value);
2917 if (!GVSB(builder)->uniform_item_types)
2919 /* advance our expected type pointers */
2920 if (GVSB(builder)->expected_type)
2921 GVSB(builder)->expected_type =
2922 g_variant_type_next (GVSB(builder)->expected_type);
2924 if (GVSB(builder)->prev_item_type)
2925 GVSB(builder)->prev_item_type =
2926 g_variant_type_next (GVSB(builder)->prev_item_type);
2929 GVSB(builder)->prev_item_type = g_variant_get_type (value);
2931 g_variant_builder_make_room (GVSB(builder));
2933 GVSB(builder)->children[GVSB(builder)->offset++] =
2934 g_variant_ref_sink (value);
2938 * g_variant_builder_open:
2939 * @builder: a #GVariantBuilder
2940 * @type: a #GVariantType
2942 * Opens a subcontainer inside the given @builder. When done adding
2943 * items to the subcontainer, g_variant_builder_close() must be called.
2945 * It is an error to call this function in any way that would cause an
2946 * inconsistent value to be constructed (ie: adding too many values or
2947 * a value of an incorrect type).
2952 g_variant_builder_open (GVariantBuilder *builder,
2953 const GVariantType *type)
2955 GVariantBuilder *parent;
2957 g_return_if_fail (is_valid_builder (builder));
2958 g_return_if_fail (GVSB(builder)->offset < GVSB(builder)->max_items);
2959 g_return_if_fail (!GVSB(builder)->expected_type ||
2960 g_variant_type_is_subtype_of (type,
2961 GVSB(builder)->expected_type));
2962 g_return_if_fail (!GVSB(builder)->prev_item_type ||
2963 g_variant_type_is_subtype_of (GVSB(builder)->prev_item_type,
2966 parent = g_slice_dup (GVariantBuilder, builder);
2967 g_variant_builder_init (builder, type);
2968 GVSB(builder)->parent = parent;
2970 /* push the prev_item_type down into the subcontainer */
2971 if (GVSB(parent)->prev_item_type)
2973 if (!GVSB(builder)->uniform_item_types)
2974 /* tuples and dict entries */
2975 GVSB(builder)->prev_item_type =
2976 g_variant_type_first (GVSB(parent)->prev_item_type);
2978 else if (!g_variant_type_is_variant (GVSB(builder)->type))
2979 /* maybes and arrays */
2980 GVSB(builder)->prev_item_type =
2981 g_variant_type_element (GVSB(parent)->prev_item_type);
2986 * g_variant_builder_close:
2987 * @builder: a #GVariantBuilder
2989 * Closes the subcontainer inside the given @builder that was opened by
2990 * the most recent call to g_variant_builder_open().
2992 * It is an error to call this function in any way that would create an
2993 * inconsistent value to be constructed (ie: too few values added to the
2999 g_variant_builder_close (GVariantBuilder *builder)
3001 GVariantBuilder *parent;
3003 g_return_if_fail (is_valid_builder (builder));
3004 g_return_if_fail (GVSB(builder)->parent != NULL);
3006 parent = GVSB(builder)->parent;
3007 GVSB(builder)->parent = NULL;
3009 g_variant_builder_add_value (parent, g_variant_builder_end (builder));
3012 g_slice_free (GVariantBuilder, parent);
3016 * g_variant_make_maybe_type:
3017 * @element: a #GVariant
3019 * Return the type of a maybe containing @element.
3021 static GVariantType *
3022 g_variant_make_maybe_type (GVariant *element)
3024 return g_variant_type_new_maybe (g_variant_get_type (element));
3028 * g_variant_make_array_type:
3029 * @element: a #GVariant
3031 * Return the type of an array containing @element.
3033 static GVariantType *
3034 g_variant_make_array_type (GVariant *element)
3036 return g_variant_type_new_array (g_variant_get_type (element));
3040 * g_variant_builder_end:
3041 * @builder: a #GVariantBuilder
3042 * @returns: a new, floating, #GVariant
3044 * Ends the builder process and returns the constructed value.
3046 * It is not permissible to use @builder in any way after this call
3047 * except for reference counting operations (in the case of a
3048 * heap-allocated #GVariantBuilder) or by reinitialising it with
3049 * g_variant_builder_init() (in the case of stack-allocated).
3051 * It is an error to call this function in any way that would create an
3052 * inconsistent value to be constructed (ie: insufficient number of
3053 * items added to a container with a specific number of children
3054 * required). It is also an error to call this function if the builder
3055 * was created with an indefinite array or maybe type and no children
3056 * have been added; in this case it is impossible to infer the type of
3062 g_variant_builder_end (GVariantBuilder *builder)
3064 GVariantType *my_type;
3067 g_return_val_if_fail (is_valid_builder (builder), NULL);
3068 g_return_val_if_fail (GVSB(builder)->offset >= GVSB(builder)->min_items,
3070 g_return_val_if_fail (!GVSB(builder)->uniform_item_types ||
3071 GVSB(builder)->prev_item_type != NULL ||
3072 g_variant_type_is_definite (GVSB(builder)->type),
3075 if (g_variant_type_is_definite (GVSB(builder)->type))
3076 my_type = g_variant_type_copy (GVSB(builder)->type);
3078 else if (g_variant_type_is_maybe (GVSB(builder)->type))
3079 my_type = g_variant_make_maybe_type (GVSB(builder)->children[0]);
3081 else if (g_variant_type_is_array (GVSB(builder)->type))
3082 my_type = g_variant_make_array_type (GVSB(builder)->children[0]);
3084 else if (g_variant_type_is_tuple (GVSB(builder)->type))
3085 my_type = g_variant_make_tuple_type (GVSB(builder)->children,
3086 GVSB(builder)->offset);
3088 else if (g_variant_type_is_dict_entry (GVSB(builder)->type))
3089 my_type = g_variant_make_dict_entry_type (GVSB(builder)->children[0],
3090 GVSB(builder)->children[1]);
3092 g_assert_not_reached ();
3094 value = g_variant_new_from_children (my_type,
3095 g_renew (GVariant *,
3096 GVSB(builder)->children,
3097 GVSB(builder)->offset),
3098 GVSB(builder)->offset,
3099 GVSB(builder)->trusted);
3100 GVSB(builder)->children = NULL;
3101 GVSB(builder)->offset = 0;
3103 g_variant_builder_clear (builder);
3104 g_variant_type_free (my_type);
3109 /* Format strings {{{1 */
3111 * g_variant_format_string_scan:
3112 * @string: a string that may be prefixed with a format string
3113 * @limit: (allow-none) (default NULL): a pointer to the end of @string,
3115 * @endptr: (allow-none) (default NULL): location to store the end pointer,
3117 * @returns: %TRUE if there was a valid format string
3119 * Checks the string pointed to by @string for starting with a properly
3120 * formed #GVariant varargs format string. If no valid format string is
3121 * found then %FALSE is returned.
3123 * If @string does start with a valid format string then %TRUE is
3124 * returned. If @endptr is non-%NULL then it is updated to point to the
3125 * first character after the format string.
3127 * If @limit is non-%NULL then @limit (and any charater after it) will
3128 * not be accessed and the effect is otherwise equivalent to if the
3129 * character at @limit were nul.
3131 * See the section on <link linkend='gvariant-format-strings'>GVariant
3132 * Format Strings</link>.
3137 g_variant_format_string_scan (const gchar *string,
3139 const gchar **endptr)
3141 #define next_char() (string == limit ? '\0' : *string++)
3142 #define peek_char() (string == limit ? '\0' : *string)
3145 switch (next_char())
3147 case 'b': case 'y': case 'n': case 'q': case 'i': case 'u':
3148 case 'x': case 't': case 'h': case 'd': case 's': case 'o':
3149 case 'g': case 'v': case '*': case '?': case 'r':
3153 return g_variant_format_string_scan (string, limit, endptr);
3157 return g_variant_type_string_scan (string, limit, endptr);
3160 while (peek_char() != ')')
3161 if (!g_variant_format_string_scan (string, limit, &string))
3164 next_char(); /* consume ')' */
3174 if (c != 's' && c != 'o' && c != 'g')
3182 /* ISO/IEC 9899:1999 (C99) §7.21.5.2:
3183 * The terminating null character is considered to be
3184 * part of the string.
3186 if (c != '\0' && strchr ("bynqiuxthdsog?", c) == NULL)
3190 if (!g_variant_format_string_scan (string, limit, &string))
3193 if (next_char() != '}')
3199 if ((c = next_char()) == 'a')
3201 if ((c = next_char()) == '&')
3203 if ((c = next_char()) == 'a')
3205 if ((c = next_char()) == 'y')
3206 break; /* '^a&ay' */
3215 if ((c = next_char()) == 'y')
3227 if ((c = next_char()) == 'a')
3229 if ((c = next_char()) == 'y')
3239 if (c != 's' && c != 'o' && c != 'g')
3258 * g_variant_format_string_scan_type:
3259 * @string: a string that may be prefixed with a format string
3260 * @limit: (allow-none) (default NULL): a pointer to the end of @string,
3262 * @endptr: (allow-none) (default NULL): location to store the end pointer,
3264 * @returns: (allow-none): a #GVariantType if there was a valid format string
3266 * If @string starts with a valid format string then this function will
3267 * return the type that the format string corresponds to. Otherwise
3268 * this function returns %NULL.
3270 * Use g_variant_type_free() to free the return value when you no longer
3273 * This function is otherwise exactly like
3274 * g_variant_format_string_scan().
3279 g_variant_format_string_scan_type (const gchar *string,
3281 const gchar **endptr)
3283 const gchar *my_end;
3290 if (!g_variant_format_string_scan (string, limit, endptr))
3293 dest = new = g_malloc (*endptr - string + 1);
3294 while (string != *endptr)
3296 if (*string != '@' && *string != '&' && *string != '^')
3302 return (GVariantType *) G_VARIANT_TYPE (new);
3306 valid_format_string (const gchar *format_string,
3310 const gchar *endptr;
3313 type = g_variant_format_string_scan_type (format_string, NULL, &endptr);
3315 if G_UNLIKELY (type == NULL || (single && *endptr != '\0'))
3318 g_critical ("`%s' is not a valid GVariant format string",
3321 g_critical ("`%s' does not have a valid GVariant format "
3322 "string as a prefix", format_string);
3325 g_variant_type_free (type);
3330 if G_UNLIKELY (value && !g_variant_is_of_type (value, type))
3335 fragment = g_strndup (format_string, endptr - format_string);
3336 typestr = g_variant_type_dup_string (type);
3338 g_critical ("the GVariant format string `%s' has a type of "
3339 "`%s' but the given value has a type of `%s'",
3340 fragment, typestr, g_variant_get_type_string (value));
3342 g_variant_type_free (type);
3347 g_variant_type_free (type);
3352 /* Variable Arguments {{{1 */
3353 /* We consider 2 main classes of format strings:
3355 * - recursive format strings
3356 * these are ones that result in recursion and the collection of
3357 * possibly more than one argument. Maybe types, tuples,
3358 * dictionary entries.
3360 * - leaf format string
3361 * these result in the collection of a single argument.
3363 * Leaf format strings are further subdivided into two categories:
3365 * - single non-null pointer ("nnp")
3366 * these either collect or return a single non-null pointer.
3369 * these collect or return something else (bool, number, etc).
3371 * Based on the above, the varargs handling code is split into 4 main parts:
3373 * - nnp handling code
3374 * - leaf handling code (which may invoke nnp code)
3375 * - generic handling code (may be recursive, may invoke leaf code)
3376 * - user-facing API (which invokes the generic code)
3378 * Each section implements some of the following functions:
3381 * collect the arguments for the format string as if
3382 * g_variant_new() had been called, but do nothing with them. used
3383 * for skipping over arguments when constructing a Nothing maybe
3387 * create a GVariant *
3390 * unpack a GVariant *
3392 * - free (nnp only):
3393 * free a previously allocated item
3397 g_variant_format_string_is_leaf (const gchar *str)
3399 return str[0] != 'm' && str[0] != '(' && str[0] != '{';
3403 g_variant_format_string_is_nnp (const gchar *str)
3405 return str[0] == 'a' || str[0] == 's' || str[0] == 'o' || str[0] == 'g' ||
3406 str[0] == '^' || str[0] == '@' || str[0] == '*' || str[0] == '?' ||
3407 str[0] == 'r' || str[0] == 'v' || str[0] == '&';
3410 /* Single non-null pointer ("nnp") {{{2 */
3412 g_variant_valist_free_nnp (const gchar *str,
3418 g_variant_iter_free (ptr);
3422 if (str[2] != '&') /* '^as' */
3438 g_variant_unref (ptr);
3445 g_assert_not_reached ();
3450 g_variant_scan_convenience (const gchar **str,
3473 g_variant_valist_new_nnp (const gchar **str,
3483 const GVariantType *type;
3486 value = g_variant_builder_end (ptr);
3487 type = g_variant_get_type (value);
3489 if G_UNLIKELY (!g_variant_type_is_array (type))
3490 g_error ("g_variant_new: expected array GVariantBuilder but "
3491 "the built value has type `%s'",
3492 g_variant_get_type_string (value));
3494 type = g_variant_type_element (type);
3496 if G_UNLIKELY (!g_variant_type_is_subtype_of (type, (GVariantType *) *str))
3497 g_error ("g_variant_new: expected GVariantBuilder array element "
3498 "type `%s' but the built value has element type `%s'",
3499 g_variant_type_dup_string ((GVariantType *) *str),
3500 g_variant_get_type_string (value) + 1);
3502 g_variant_type_string_scan (*str, NULL, str);
3508 return g_variant_new_string (ptr);
3511 return g_variant_new_object_path (ptr);
3514 return g_variant_new_signature (ptr);
3521 if (g_variant_scan_convenience (str, &constant, &arrays) == 's')
3522 return g_variant_new_strv (ptr, -1);
3525 return g_variant_new_bytestring_array (ptr, -1);
3527 return g_variant_new_bytestring (ptr);
3531 if G_UNLIKELY (!g_variant_is_of_type (ptr, (GVariantType *) *str))
3532 g_error ("g_variant_new: expected GVariant of type `%s' but "
3533 "received value has type `%s'",
3534 g_variant_type_dup_string ((GVariantType *) *str),
3535 g_variant_get_type_string (ptr));
3537 g_variant_type_string_scan (*str, NULL, str);
3545 if G_UNLIKELY (!g_variant_type_is_basic (g_variant_get_type (ptr)))
3546 g_error ("g_variant_new: format string `?' expects basic-typed "
3547 "GVariant, but received value has type `%s'",
3548 g_variant_get_type_string (ptr));
3553 if G_UNLIKELY (!g_variant_type_is_tuple (g_variant_get_type (ptr)))
3554 g_error ("g_variant_new: format string `r` expects tuple-typed "
3555 "GVariant, but received value has type `%s'",
3556 g_variant_get_type_string (ptr));
3561 return g_variant_new_variant (ptr);
3564 g_assert_not_reached ();
3569 g_variant_valist_get_nnp (const gchar **str,
3575 g_variant_type_string_scan (*str, NULL, str);
3576 return g_variant_iter_new (value);
3580 return (gchar *) g_variant_get_string (value, NULL);
3585 return g_variant_dup_string (value, NULL);
3592 if (g_variant_scan_convenience (str, &constant, &arrays) == 's')
3595 return g_variant_get_strv (value, NULL);
3597 return g_variant_dup_strv (value, NULL);
3600 else if (arrays > 1)
3603 return g_variant_get_bytestring_array (value, NULL);
3605 return g_variant_dup_bytestring_array (value, NULL);
3611 return (gchar *) g_variant_get_bytestring (value);
3613 return g_variant_dup_bytestring (value, NULL);
3618 g_variant_type_string_scan (*str, NULL, str);
3624 return g_variant_ref (value);
3627 return g_variant_get_variant (value);
3630 g_assert_not_reached ();
3636 g_variant_valist_skip_leaf (const gchar **str,
3639 if (g_variant_format_string_is_nnp (*str))
3641 g_variant_format_string_scan (*str, NULL, str);
3642 va_arg (*app, gpointer);
3660 va_arg (*app, guint64);
3664 va_arg (*app, gdouble);
3668 g_assert_not_reached ();
3673 g_variant_valist_new_leaf (const gchar **str,
3676 if (g_variant_format_string_is_nnp (*str))
3677 return g_variant_valist_new_nnp (str, va_arg (*app, gpointer));
3682 return g_variant_new_boolean (va_arg (*app, gboolean));
3685 return g_variant_new_byte (va_arg (*app, guint));
3688 return g_variant_new_int16 (va_arg (*app, gint));
3691 return g_variant_new_uint16 (va_arg (*app, guint));
3694 return g_variant_new_int32 (va_arg (*app, gint));
3697 return g_variant_new_uint32 (va_arg (*app, guint));
3700 return g_variant_new_int64 (va_arg (*app, gint64));
3703 return g_variant_new_uint64 (va_arg (*app, guint64));
3706 return g_variant_new_handle (va_arg (*app, gint));
3709 return g_variant_new_double (va_arg (*app, gdouble));
3712 g_assert_not_reached ();
3716 /* The code below assumes this */
3717 G_STATIC_ASSERT (sizeof (gboolean) == sizeof (guint32));
3718 G_STATIC_ASSERT (sizeof (gdouble) == sizeof (guint64));
3721 g_variant_valist_get_leaf (const gchar **str,
3726 gpointer ptr = va_arg (*app, gpointer);
3730 g_variant_format_string_scan (*str, NULL, str);
3734 if (g_variant_format_string_is_nnp (*str))
3736 gpointer *nnp = (gpointer *) ptr;
3738 if (free && *nnp != NULL)
3739 g_variant_valist_free_nnp (*str, *nnp);
3744 *nnp = g_variant_valist_get_nnp (str, value);
3746 g_variant_format_string_scan (*str, NULL, str);
3756 *(gboolean *) ptr = g_variant_get_boolean (value);
3760 *(guchar *) ptr = g_variant_get_byte (value);
3764 *(gint16 *) ptr = g_variant_get_int16 (value);
3768 *(guint16 *) ptr = g_variant_get_uint16 (value);
3772 *(gint32 *) ptr = g_variant_get_int32 (value);
3776 *(guint32 *) ptr = g_variant_get_uint32 (value);
3780 *(gint64 *) ptr = g_variant_get_int64 (value);
3784 *(guint64 *) ptr = g_variant_get_uint64 (value);
3788 *(gint32 *) ptr = g_variant_get_handle (value);
3792 *(gdouble *) ptr = g_variant_get_double (value);
3801 *(guchar *) ptr = 0;
3806 *(guint16 *) ptr = 0;
3813 *(guint32 *) ptr = 0;
3819 *(guint64 *) ptr = 0;
3824 g_assert_not_reached ();
3827 /* Generic (recursive) {{{2 */
3829 g_variant_valist_skip (const gchar **str,
3832 if (g_variant_format_string_is_leaf (*str))
3833 g_variant_valist_skip_leaf (str, app);
3835 else if (**str == 'm') /* maybe */
3839 if (!g_variant_format_string_is_nnp (*str))
3840 va_arg (*app, gboolean);
3842 g_variant_valist_skip (str, app);
3844 else /* tuple, dictionary entry */
3846 g_assert (**str == '(' || **str == '{');
3848 while (**str != ')' && **str != '}')
3849 g_variant_valist_skip (str, app);
3855 g_variant_valist_new (const gchar **str,
3858 if (g_variant_format_string_is_leaf (*str))
3859 return g_variant_valist_new_leaf (str, app);
3861 if (**str == 'm') /* maybe */
3863 GVariantType *type = NULL;
3864 GVariant *value = NULL;
3868 if (g_variant_format_string_is_nnp (*str))
3870 gpointer nnp = va_arg (*app, gpointer);
3873 value = g_variant_valist_new_nnp (str, nnp);
3875 type = g_variant_format_string_scan_type (*str, NULL, str);
3879 gboolean just = va_arg (*app, gboolean);
3882 value = g_variant_valist_new (str, app);
3885 type = g_variant_format_string_scan_type (*str, NULL, NULL);
3886 g_variant_valist_skip (str, app);
3890 value = g_variant_new_maybe (type, value);
3893 g_variant_type_free (type);
3897 else /* tuple, dictionary entry */
3902 g_variant_builder_init (&b, G_VARIANT_TYPE_TUPLE);
3905 g_assert (**str == '{');
3906 g_variant_builder_init (&b, G_VARIANT_TYPE_DICT_ENTRY);
3910 while (**str != ')' && **str != '}')
3911 g_variant_builder_add_value (&b, g_variant_valist_new (str, app));
3914 return g_variant_builder_end (&b);
3919 g_variant_valist_get (const gchar **str,
3924 if (g_variant_format_string_is_leaf (*str))
3925 g_variant_valist_get_leaf (str, value, free, app);
3927 else if (**str == 'm')
3932 value = g_variant_get_maybe (value);
3934 if (!g_variant_format_string_is_nnp (*str))
3936 gboolean *ptr = va_arg (*app, gboolean *);
3939 *ptr = value != NULL;
3942 g_variant_valist_get (str, value, free, app);
3945 g_variant_unref (value);
3948 else /* tuple, dictionary entry */
3952 g_assert (**str == '(' || **str == '{');
3955 while (**str != ')' && **str != '}')
3959 GVariant *child = g_variant_get_child_value (value, index++);
3960 g_variant_valist_get (str, child, free, app);
3961 g_variant_unref (child);
3964 g_variant_valist_get (str, NULL, free, app);
3970 /* User-facing API {{{2 */
3973 * @format_string: a #GVariant format string
3974 * @...: arguments, as per @format_string
3975 * @returns: a new floating #GVariant instance
3977 * Creates a new #GVariant instance.
3979 * Think of this function as an analogue to g_strdup_printf().
3981 * The type of the created instance and the arguments that are
3982 * expected by this function are determined by @format_string. See the
3983 * section on <link linkend='gvariant-format-strings'>GVariant Format
3984 * Strings</link>. Please note that the syntax of the format string is
3985 * very likely to be extended in the future.
3987 * The first character of the format string must not be '*' '?' '@' or
3988 * 'r'; in essence, a new #GVariant must always be constructed by this
3989 * function (and not merely passed through it unmodified).
3994 g_variant_new (const gchar *format_string,
4000 g_return_val_if_fail (valid_format_string (format_string, TRUE, NULL) &&
4001 format_string[0] != '?' && format_string[0] != '@' &&
4002 format_string[0] != '*' && format_string[0] != 'r',
4005 va_start (ap, format_string);
4006 value = g_variant_new_va (format_string, NULL, &ap);
4014 * @format_string: a string that is prefixed with a format string
4015 * @endptr: (allow-none) (default NULL): location to store the end pointer,
4017 * @app: a pointer to a #va_list
4018 * @returns: a new, usually floating, #GVariant
4020 * This function is intended to be used by libraries based on
4021 * #GVariant that want to provide g_variant_new()-like functionality
4024 * The API is more general than g_variant_new() to allow a wider range
4027 * @format_string must still point to a valid format string, but it only
4028 * needs to be nul-terminated if @endptr is %NULL. If @endptr is
4029 * non-%NULL then it is updated to point to the first character past the
4030 * end of the format string.
4032 * @app is a pointer to a #va_list. The arguments, according to
4033 * @format_string, are collected from this #va_list and the list is left
4034 * pointing to the argument following the last.
4036 * These two generalisations allow mixing of multiple calls to
4037 * g_variant_new_va() and g_variant_get_va() within a single actual
4038 * varargs call by the user.
4040 * The return value will be floating if it was a newly created GVariant
4041 * instance (for example, if the format string was "(ii)"). In the case
4042 * that the format_string was '*', '?', 'r', or a format starting with
4043 * '@' then the collected #GVariant pointer will be returned unmodified,
4044 * without adding any additional references.
4046 * In order to behave correctly in all cases it is necessary for the
4047 * calling function to g_variant_ref_sink() the return result before
4048 * returning control to the user that originally provided the pointer.
4049 * At this point, the caller will have their own full reference to the
4050 * result. This can also be done by adding the result to a container,
4051 * or by passing it to another g_variant_new() call.
4056 g_variant_new_va (const gchar *format_string,
4057 const gchar **endptr,
4062 g_return_val_if_fail (valid_format_string (format_string, !endptr, NULL),
4064 g_return_val_if_fail (app != NULL, NULL);
4066 value = g_variant_valist_new (&format_string, app);
4069 *endptr = format_string;
4076 * @value: a #GVariant instance
4077 * @format_string: a #GVariant format string
4078 * @...: arguments, as per @format_string
4080 * Deconstructs a #GVariant instance.
4082 * Think of this function as an analogue to scanf().
4084 * The arguments that are expected by this function are entirely
4085 * determined by @format_string. @format_string also restricts the
4086 * permissible types of @value. It is an error to give a value with
4087 * an incompatible type. See the section on <link
4088 * linkend='gvariant-format-strings'>GVariant Format Strings</link>.
4089 * Please note that the syntax of the format string is very likely to be
4090 * extended in the future.
4095 g_variant_get (GVariant *value,
4096 const gchar *format_string,
4101 g_return_if_fail (valid_format_string (format_string, TRUE, value));
4103 /* if any direct-pointer-access formats are in use, flatten first */
4104 if (strchr (format_string, '&'))
4105 g_variant_get_data (value);
4107 va_start (ap, format_string);
4108 g_variant_get_va (value, format_string, NULL, &ap);
4114 * @value: a #GVariant
4115 * @format_string: a string that is prefixed with a format string
4116 * @endptr: (allow-none) (default NULL): location to store the end pointer,
4118 * @app: a pointer to a #va_list
4120 * This function is intended to be used by libraries based on #GVariant
4121 * that want to provide g_variant_get()-like functionality to their
4124 * The API is more general than g_variant_get() to allow a wider range
4127 * @format_string must still point to a valid format string, but it only
4128 * need to be nul-terminated if @endptr is %NULL. If @endptr is
4129 * non-%NULL then it is updated to point to the first character past the
4130 * end of the format string.
4132 * @app is a pointer to a #va_list. The arguments, according to
4133 * @format_string, are collected from this #va_list and the list is left
4134 * pointing to the argument following the last.
4136 * These two generalisations allow mixing of multiple calls to
4137 * g_variant_new_va() and g_variant_get_va() within a single actual
4138 * varargs call by the user.
4143 g_variant_get_va (GVariant *value,
4144 const gchar *format_string,
4145 const gchar **endptr,
4148 g_return_if_fail (valid_format_string (format_string, !endptr, value));
4149 g_return_if_fail (value != NULL);
4150 g_return_if_fail (app != NULL);
4152 /* if any direct-pointer-access formats are in use, flatten first */
4153 if (strchr (format_string, '&'))
4154 g_variant_get_data (value);
4156 g_variant_valist_get (&format_string, value, FALSE, app);
4159 *endptr = format_string;
4162 /* Varargs-enabled Utility Functions {{{1 */
4165 * g_variant_builder_add:
4166 * @builder: a #GVariantBuilder
4167 * @format_string: a #GVariant varargs format string
4168 * @...: arguments, as per @format_string
4170 * Adds to a #GVariantBuilder.
4172 * This call is a convenience wrapper that is exactly equivalent to
4173 * calling g_variant_new() followed by g_variant_builder_add_value().
4175 * This function might be used as follows:
4179 * make_pointless_dictionary (void)
4181 * GVariantBuilder *builder;
4184 * builder = g_variant_builder_new (G_VARIANT_TYPE_ARRAY);
4185 * for (i = 0; i < 16; i++)
4189 * sprintf (buf, "%d", i);
4190 * g_variant_builder_add (builder, "{is}", i, buf);
4193 * return g_variant_builder_end (builder);
4200 g_variant_builder_add (GVariantBuilder *builder,
4201 const gchar *format_string,
4207 va_start (ap, format_string);
4208 variant = g_variant_new_va (format_string, NULL, &ap);
4211 g_variant_builder_add_value (builder, variant);
4215 * g_variant_get_child:
4216 * @value: a container #GVariant
4217 * @index_: the index of the child to deconstruct
4218 * @format_string: a #GVariant format string
4219 * @...: arguments, as per @format_string
4221 * Reads a child item out of a container #GVariant instance and
4222 * deconstructs it according to @format_string. This call is
4223 * essentially a combination of g_variant_get_child_value() and
4229 g_variant_get_child (GVariant *value,
4231 const gchar *format_string,
4237 child = g_variant_get_child_value (value, index_);
4238 g_return_if_fail (valid_format_string (format_string, TRUE, child));
4240 va_start (ap, format_string);
4241 g_variant_get_va (child, format_string, NULL, &ap);
4244 g_variant_unref (child);
4248 * g_variant_iter_next:
4249 * @iter: a #GVariantIter
4250 * @format_string: a GVariant format string
4251 * @...: the arguments to unpack the value into
4252 * @returns: %TRUE if a value was unpacked, or %FALSE if there as no
4255 * Gets the next item in the container and unpacks it into the variable
4256 * argument list according to @format_string, returning %TRUE.
4258 * If no more items remain then %FALSE is returned.
4260 * All of the pointers given on the variable arguments list of this
4261 * function are assumed to point at uninitialised memory. It is the
4262 * responsibility of the caller to free all of the values returned by
4263 * the unpacking process.
4265 * See the section on <link linkend='gvariant-format-strings'>GVariant
4266 * Format Strings</link>.
4269 * <title>Memory management with g_variant_iter_next()</title>
4271 * /<!-- -->* Iterates a dictionary of type 'a{sv}' *<!-- -->/
4273 * iterate_dictionary (GVariant *dictionary)
4275 * GVariantIter iter;
4279 * g_variant_iter_init (&iter, dictionary);
4280 * while (g_variant_iter_next (&iter, "{sv}", &key, &value))
4282 * g_print ("Item '%s' has type '%s'\n", key,
4283 * g_variant_get_type_string (value));
4285 * /<!-- -->* must free data for ourselves *<!-- -->/
4286 * g_variant_unref (value);
4293 * For a solution that is likely to be more convenient to C programmers
4294 * when dealing with loops, see g_variant_iter_loop().
4299 g_variant_iter_next (GVariantIter *iter,
4300 const gchar *format_string,
4305 value = g_variant_iter_next_value (iter);
4307 g_return_val_if_fail (valid_format_string (format_string, TRUE, value),
4314 va_start (ap, format_string);
4315 g_variant_valist_get (&format_string, value, FALSE, &ap);
4318 g_variant_unref (value);
4321 return value != NULL;
4325 * g_variant_iter_loop:
4326 * @iter: a #GVariantIter
4327 * @format_string: a GVariant format string
4328 * @...: the arguments to unpack the value into
4329 * @returns: %TRUE if a value was unpacked, or %FALSE if there as no
4332 * Gets the next item in the container and unpacks it into the variable
4333 * argument list according to @format_string, returning %TRUE.
4335 * If no more items remain then %FALSE is returned.
4337 * On the first call to this function, the pointers appearing on the
4338 * variable argument list are assumed to point at uninitialised memory.
4339 * On the second and later calls, it is assumed that the same pointers
4340 * will be given and that they will point to the memory as set by the
4341 * previous call to this function. This allows the previous values to
4342 * be freed, as appropriate.
4344 * This function is intended to be used with a while loop as
4345 * demonstrated in the following example. This function can only be
4346 * used when iterating over an array. It is only valid to call this
4347 * function with a string constant for the format string and the same
4348 * string constant must be used each time. Mixing calls to this
4349 * function and g_variant_iter_next() or g_variant_iter_next_value() on
4350 * the same iterator is not recommended.
4352 * See the section on <link linkend='gvariant-format-strings'>GVariant
4353 * Format Strings</link>.
4356 * <title>Memory management with g_variant_iter_loop()</title>
4358 * /<!-- -->* Iterates a dictionary of type 'a{sv}' *<!-- -->/
4360 * iterate_dictionary (GVariant *dictionary)
4362 * GVariantIter iter;
4366 * g_variant_iter_init (&iter, dictionary);
4367 * while (g_variant_iter_loop (&iter, "{sv}", &key, &value))
4369 * g_print ("Item '%s' has type '%s'\n", key,
4370 * g_variant_get_type_string (value));
4372 * /<!-- -->* no need to free 'key' and 'value' here *<!-- -->/
4378 * If you want a slightly less magical alternative that requires more
4379 * typing, see g_variant_iter_next().
4384 g_variant_iter_loop (GVariantIter *iter,
4385 const gchar *format_string,
4388 gboolean first_time = GVSI(iter)->loop_format == NULL;
4392 g_return_val_if_fail (first_time ||
4393 format_string == GVSI(iter)->loop_format,
4398 TYPE_CHECK (GVSI(iter)->value, G_VARIANT_TYPE_ARRAY, FALSE);
4399 GVSI(iter)->loop_format = format_string;
4401 if (strchr (format_string, '&'))
4402 g_variant_get_data (GVSI(iter)->value);
4405 value = g_variant_iter_next_value (iter);
4407 g_return_val_if_fail (!first_time ||
4408 valid_format_string (format_string, TRUE, value),
4411 va_start (ap, format_string);
4412 g_variant_valist_get (&format_string, value, !first_time, &ap);
4416 g_variant_unref (value);
4418 return value != NULL;
4421 /* Serialised data {{{1 */
4423 g_variant_deep_copy (GVariant *value)
4425 switch (g_variant_classify (value))
4427 case G_VARIANT_CLASS_MAYBE:
4428 case G_VARIANT_CLASS_ARRAY:
4429 case G_VARIANT_CLASS_TUPLE:
4430 case G_VARIANT_CLASS_DICT_ENTRY:
4431 case G_VARIANT_CLASS_VARIANT:
4433 GVariantBuilder builder;
4437 g_variant_builder_init (&builder, g_variant_get_type (value));
4438 g_variant_iter_init (&iter, value);
4440 while ((child = g_variant_iter_next_value (&iter)))
4442 g_variant_builder_add_value (&builder, g_variant_deep_copy (child));
4443 g_variant_unref (child);
4446 return g_variant_builder_end (&builder);
4449 case G_VARIANT_CLASS_BOOLEAN:
4450 return g_variant_new_boolean (g_variant_get_boolean (value));
4452 case G_VARIANT_CLASS_BYTE:
4453 return g_variant_new_byte (g_variant_get_byte (value));
4455 case G_VARIANT_CLASS_INT16:
4456 return g_variant_new_int16 (g_variant_get_int16 (value));
4458 case G_VARIANT_CLASS_UINT16:
4459 return g_variant_new_uint16 (g_variant_get_uint16 (value));
4461 case G_VARIANT_CLASS_INT32:
4462 return g_variant_new_int32 (g_variant_get_int32 (value));
4464 case G_VARIANT_CLASS_UINT32:
4465 return g_variant_new_uint32 (g_variant_get_uint32 (value));
4467 case G_VARIANT_CLASS_INT64:
4468 return g_variant_new_int64 (g_variant_get_int64 (value));
4470 case G_VARIANT_CLASS_UINT64:
4471 return g_variant_new_uint64 (g_variant_get_uint64 (value));
4473 case G_VARIANT_CLASS_HANDLE:
4474 return g_variant_new_handle (g_variant_get_handle (value));
4476 case G_VARIANT_CLASS_DOUBLE:
4477 return g_variant_new_double (g_variant_get_double (value));
4479 case G_VARIANT_CLASS_STRING:
4480 return g_variant_new_string (g_variant_get_string (value, NULL));
4482 case G_VARIANT_CLASS_OBJECT_PATH:
4483 return g_variant_new_object_path (g_variant_get_string (value, NULL));
4485 case G_VARIANT_CLASS_SIGNATURE:
4486 return g_variant_new_signature (g_variant_get_string (value, NULL));
4489 g_assert_not_reached ();
4493 * g_variant_get_normal_form:
4494 * @value: a #GVariant
4495 * @returns: a trusted #GVariant
4497 * Gets a #GVariant instance that has the same value as @value and is
4498 * trusted to be in normal form.
4500 * If @value is already trusted to be in normal form then a new
4501 * reference to @value is returned.
4503 * If @value is not already trusted, then it is scanned to check if it
4504 * is in normal form. If it is found to be in normal form then it is
4505 * marked as trusted and a new reference to it is returned.
4507 * If @value is found not to be in normal form then a new trusted
4508 * #GVariant is created with the same value as @value.
4510 * It makes sense to call this function if you've received #GVariant
4511 * data from untrusted sources and you want to ensure your serialised
4512 * output is definitely in normal form.
4517 g_variant_get_normal_form (GVariant *value)
4521 if (g_variant_is_normal_form (value))
4522 return g_variant_ref (value);
4524 trusted = g_variant_deep_copy (value);
4525 g_assert (g_variant_is_trusted (trusted));
4527 return g_variant_ref_sink (trusted);
4531 * g_variant_byteswap:
4532 * @value: a #GVariant
4533 * @returns: the byteswapped form of @value
4535 * Performs a byteswapping operation on the contents of @value. The
4536 * result is that all multi-byte numeric data contained in @value is
4537 * byteswapped. That includes 16, 32, and 64bit signed and unsigned
4538 * integers as well as file handles and double precision floating point
4541 * This function is an identity mapping on any value that does not
4542 * contain multi-byte numeric data. That include strings, booleans,
4543 * bytes and containers containing only these things (recursively).
4545 * The returned value is always in normal form and is marked as trusted.
4550 g_variant_byteswap (GVariant *value)
4552 GVariantSerialised serialised;
4557 trusted = g_variant_get_normal_form (value);
4558 serialised.type_info = g_variant_get_type_info (trusted);
4559 serialised.size = g_variant_get_size (trusted);
4560 serialised.data = g_malloc (serialised.size);
4561 g_variant_store (trusted, serialised.data);
4562 g_variant_unref (trusted);
4564 g_variant_serialised_byteswap (serialised);
4566 buffer = g_buffer_new_take_data (serialised.data, serialised.size);
4567 new = g_variant_new_from_buffer (g_variant_get_type (value), buffer, TRUE);
4568 g_buffer_unref (buffer);
4570 return g_variant_ref_sink (new);
4574 * g_variant_new_from_data:
4575 * @type: a definite #GVariantType
4576 * @data: the serialised data
4577 * @size: the size of @data
4578 * @trusted: %TRUE if @data is definitely in normal form
4579 * @notify: function to call when @data is no longer needed
4580 * @user_data: data for @notify
4581 * @returns: a new floating #GVariant of type @type
4583 * Creates a new #GVariant instance from serialised data.
4585 * @type is the type of #GVariant instance that will be constructed.
4586 * The interpretation of @data depends on knowing the type.
4588 * @data is not modified by this function and must remain valid with an
4589 * unchanging value until such a time as @notify is called with
4590 * @user_data. If the contents of @data change before that time then
4591 * the result is undefined.
4593 * If @data is trusted to be serialised data in normal form then
4594 * @trusted should be %TRUE. This applies to serialised data created
4595 * within this process or read from a trusted location on the disk (such
4596 * as a file installed in /usr/lib alongside your application). You
4597 * should set trusted to %FALSE if @data is read from the network, a
4598 * file in the user's home directory, etc.
4600 * @notify will be called with @user_data when @data is no longer
4601 * needed. The exact time of this call is unspecified and might even be
4602 * before this function returns.
4607 g_variant_new_from_data (const GVariantType *type,
4611 GDestroyNotify notify,
4617 g_return_val_if_fail (g_variant_type_is_definite (type), NULL);
4618 g_return_val_if_fail (data != NULL || size == 0, NULL);
4621 buffer = g_buffer_new_from_pointer (data, size, notify, user_data);
4623 buffer = g_buffer_new_from_static_data (data, size);
4625 value = g_variant_new_from_buffer (type, buffer, trusted);
4626 g_buffer_unref (buffer);
4632 /* vim:set foldmethod=marker: */