Merge branch 'master' into gdbus-codegen
[platform/upstream/glib.git] / gio / gdbusutils.c
1 /* GDBus - GLib D-Bus Library
2  *
3  * Copyright (C) 2008-2010 Red Hat, Inc.
4  *
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 License, or (at your option) any later version.
9  *
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.
14  *
15  * You should have received a copy of the GNU Lesser General
16  * Public 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.
19  *
20  * Author: David Zeuthen <davidz@redhat.com>
21  */
22
23 #include "config.h"
24
25 #include <stdlib.h>
26 #include <string.h>
27
28 #include "gdbusutils.h"
29
30 #include "glibintl.h"
31
32 /**
33  * SECTION:gdbusutils
34  * @title: D-Bus Utilities
35  * @short_description: Various utilities related to D-Bus.
36  * @include: gio/gio.h
37  *
38  * Various utility routines related to D-Bus.
39  */
40
41 static gboolean
42 is_valid_bus_name_character (gint c,
43                              gboolean allow_hyphen)
44 {
45   return
46     (c >= '0' && c <= '9') ||
47     (c >= 'A' && c <= 'Z') ||
48     (c >= 'a' && c <= 'z') ||
49     (c == '_') ||
50     (allow_hyphen && c == '-');
51 }
52
53 static gboolean
54 is_valid_initial_bus_name_character (gint c,
55                                      gboolean allow_initial_digit,
56                                      gboolean allow_hyphen)
57 {
58   if (allow_initial_digit)
59     return is_valid_bus_name_character (c, allow_hyphen);
60   else
61     return
62       (c >= 'A' && c <= 'Z') ||
63       (c >= 'a' && c <= 'z') ||
64       (c == '_') ||
65       (allow_hyphen && c == '-');
66 }
67
68 static gboolean
69 is_valid_name (const gchar *start,
70                guint len,
71                gboolean allow_initial_digit,
72                gboolean allow_hyphen)
73 {
74   gboolean ret;
75   const gchar *s;
76   const gchar *end;
77   gboolean has_dot;
78
79   ret = FALSE;
80
81   if (len == 0)
82     goto out;
83
84   s = start;
85   end = s + len;
86   has_dot = FALSE;
87   while (s != end)
88     {
89       if (*s == '.')
90         {
91           s += 1;
92           if (G_UNLIKELY (!is_valid_initial_bus_name_character (*s, allow_initial_digit, allow_hyphen)))
93             goto out;
94           has_dot = TRUE;
95         }
96       else if (G_UNLIKELY (!is_valid_bus_name_character (*s, allow_hyphen)))
97         {
98           goto out;
99         }
100       s += 1;
101     }
102
103   if (G_UNLIKELY (!has_dot))
104     goto out;
105
106   ret = TRUE;
107
108  out:
109   return ret;
110 }
111
112 /**
113  * g_dbus_is_name:
114  * @string: The string to check.
115  *
116  * Checks if @string is a valid D-Bus bus name (either unique or well-known).
117  *
118  * Returns: %TRUE if valid, %FALSE otherwise.
119  *
120  * Since: 2.26
121  */
122 gboolean
123 g_dbus_is_name (const gchar *string)
124 {
125   guint len;
126   gboolean ret;
127   const gchar *s;
128
129   g_return_val_if_fail (string != NULL, FALSE);
130
131   ret = FALSE;
132
133   len = strlen (string);
134   if (G_UNLIKELY (len == 0 || len > 255))
135     goto out;
136
137   s = string;
138   if (*s == ':')
139     {
140       /* handle unique name */
141       if (!is_valid_name (s + 1, len - 1, TRUE, TRUE))
142         goto out;
143       ret = TRUE;
144       goto out;
145     }
146   else if (G_UNLIKELY (*s == '.'))
147     {
148       /* can't start with a . */
149       goto out;
150     }
151   else if (G_UNLIKELY (!is_valid_initial_bus_name_character (*s, FALSE, TRUE)))
152     goto out;
153
154   ret = is_valid_name (s + 1, len - 1, FALSE, TRUE);
155
156  out:
157   return ret;
158 }
159
160 /**
161  * g_dbus_is_unique_name:
162  * @string: The string to check.
163  *
164  * Checks if @string is a valid D-Bus unique bus name.
165  *
166  * Returns: %TRUE if valid, %FALSE otherwise.
167  *
168  * Since: 2.26
169  */
170 gboolean
171 g_dbus_is_unique_name (const gchar *string)
172 {
173   gboolean ret;
174   guint len;
175
176   g_return_val_if_fail (string != NULL, FALSE);
177
178   ret = FALSE;
179
180   len = strlen (string);
181   if (G_UNLIKELY (len == 0 || len > 255))
182     goto out;
183
184   if (G_UNLIKELY (*string != ':'))
185     goto out;
186
187   if (G_UNLIKELY (!is_valid_name (string + 1, len - 1, TRUE, TRUE)))
188     goto out;
189
190   ret = TRUE;
191
192  out:
193   return ret;
194 }
195
196 /**
197  * g_dbus_is_member_name:
198  * @string: The string to check.
199  *
200  * Checks if @string is a valid D-Bus member (e.g. signal or method) name.
201  *
202  * Returns: %TRUE if valid, %FALSE otherwise.
203  *
204  * Since: 2.26
205  */
206 gboolean
207 g_dbus_is_member_name (const gchar *string)
208 {
209   gboolean ret;
210   guint n;
211
212   ret = FALSE;
213   if (G_UNLIKELY (string == NULL))
214     goto out;
215
216   if (G_UNLIKELY (!is_valid_initial_bus_name_character (string[0], FALSE, FALSE)))
217     goto out;
218
219   for (n = 1; string[n] != '\0'; n++)
220     {
221       if (G_UNLIKELY (!is_valid_bus_name_character (string[n], FALSE)))
222         {
223           goto out;
224         }
225     }
226
227   ret = TRUE;
228
229  out:
230   return ret;
231 }
232
233 /**
234  * g_dbus_is_interface_name:
235  * @string: The string to check.
236  *
237  * Checks if @string is a valid D-Bus interface name.
238  *
239  * Returns: %TRUE if valid, %FALSE otherwise.
240  *
241  * Since: 2.26
242  */
243 gboolean
244 g_dbus_is_interface_name (const gchar *string)
245 {
246   guint len;
247   gboolean ret;
248   const gchar *s;
249
250   g_return_val_if_fail (string != NULL, FALSE);
251
252   ret = FALSE;
253
254   len = strlen (string);
255   if (G_UNLIKELY (len == 0 || len > 255))
256     goto out;
257
258   s = string;
259   if (G_UNLIKELY (*s == '.'))
260     {
261       /* can't start with a . */
262       goto out;
263     }
264   else if (G_UNLIKELY (!is_valid_initial_bus_name_character (*s, FALSE, FALSE)))
265     goto out;
266
267   ret = is_valid_name (s + 1, len - 1, FALSE, FALSE);
268
269  out:
270   return ret;
271 }
272
273 /* ---------------------------------------------------------------------------------------------------- */
274
275 /* TODO: maybe move to glib? if so, it should conform to http://en.wikipedia.org/wiki/Guid and/or
276  *       http://tools.ietf.org/html/rfc4122 - specifically it should have hyphens then.
277  */
278
279 /**
280  * g_dbus_generate_guid:
281  *
282  * Generate a D-Bus GUID that can be used with
283  * e.g. g_dbus_connection_new().
284  *
285  * See the D-Bus specification regarding what strings are valid D-Bus
286  * GUID (for example, D-Bus GUIDs are not RFC-4122 compliant).
287  *
288  * Returns: A valid D-Bus GUID. Free with g_free().
289  *
290  * Since: 2.26
291  */
292 gchar *
293 g_dbus_generate_guid (void)
294 {
295   GString *s;
296   GTimeVal now;
297   guint32 r1;
298   guint32 r2;
299   guint32 r3;
300
301   s = g_string_new (NULL);
302
303   r1 = g_random_int ();
304   r2 = g_random_int ();
305   r3 = g_random_int ();
306   g_get_current_time (&now);
307
308   g_string_append_printf (s, "%08x", r1);
309   g_string_append_printf (s, "%08x", r2);
310   g_string_append_printf (s, "%08x", r3);
311   g_string_append_printf (s, "%08x", (guint32) now.tv_sec);
312
313   return g_string_free (s, FALSE);
314 }
315
316 /**
317  * g_dbus_is_guid:
318  * @string: The string to check.
319  *
320  * Checks if @string is a D-Bus GUID.
321  *
322  * See the D-Bus specification regarding what strings are valid D-Bus
323  * GUID (for example, D-Bus GUIDs are not RFC-4122 compliant).
324  *
325  * Returns: %TRUE if @string is a guid, %FALSE otherwise.
326  *
327  * Since: 2.26
328  */
329 gboolean
330 g_dbus_is_guid (const gchar *string)
331 {
332   gboolean ret;
333   guint n;
334
335   g_return_val_if_fail (string != NULL, FALSE);
336
337   ret = FALSE;
338
339   for (n = 0; n < 32; n++)
340     {
341       if (!g_ascii_isxdigit (string[n]))
342         goto out;
343     }
344   if (string[32] != '\0')
345     goto out;
346
347   ret = TRUE;
348
349  out:
350   return ret;
351 }
352
353 /* ---------------------------------------------------------------------------------------------------- */
354
355 /**
356  * g_dbus_gvariant_to_gvalue:
357  * @value: A #GVariant.
358  * @out_gvalue: Return location pointing to a zero-filled (uninitialized) #GValue.
359  *
360  * Converts a #GVariant to a #GValue. If @value is floating, it is consumed.
361  *
362  * The rules specified in the g_dbus_gvalue_to_gvariant() function are
363  * used - this function is essentially its reverse form.
364  *
365  * The conversion never fails - a valid #GValue is always returned in
366  * @out_gvalue.
367  *
368  * Since: 2.30
369  */
370 void
371 g_dbus_gvariant_to_gvalue (GVariant  *value,
372                            GValue    *out_gvalue)
373 {
374   const GVariantType *type;
375   gchar **array;
376
377   g_return_if_fail (value != NULL);
378   g_return_if_fail (out_gvalue != NULL);
379
380   memset (out_gvalue, '\0', sizeof (GValue));
381
382   switch (g_variant_classify (value))
383     {
384     case G_VARIANT_CLASS_BOOLEAN:
385       g_value_init (out_gvalue, G_TYPE_BOOLEAN);
386       g_value_set_boolean (out_gvalue, g_variant_get_boolean (value));
387       break;
388
389     case G_VARIANT_CLASS_BYTE:
390       g_value_init (out_gvalue, G_TYPE_UCHAR);
391       g_value_set_uchar (out_gvalue, g_variant_get_byte (value));
392       break;
393
394     case G_VARIANT_CLASS_INT16:
395       g_value_init (out_gvalue, G_TYPE_INT);
396       g_value_set_int (out_gvalue, g_variant_get_int16 (value));
397       break;
398
399     case G_VARIANT_CLASS_UINT16:
400       g_value_init (out_gvalue, G_TYPE_UINT);
401       g_value_set_uint (out_gvalue, g_variant_get_uint16 (value));
402       break;
403
404     case G_VARIANT_CLASS_INT32:
405       g_value_init (out_gvalue, G_TYPE_INT);
406       g_value_set_int (out_gvalue, g_variant_get_int32 (value));
407       break;
408
409     case G_VARIANT_CLASS_UINT32:
410       g_value_init (out_gvalue, G_TYPE_UINT);
411       g_value_set_uint (out_gvalue, g_variant_get_uint32 (value));
412       break;
413
414     case G_VARIANT_CLASS_INT64:
415       g_value_init (out_gvalue, G_TYPE_INT64);
416       g_value_set_int64 (out_gvalue, g_variant_get_int64 (value));
417       break;
418
419     case G_VARIANT_CLASS_UINT64:
420       g_value_init (out_gvalue, G_TYPE_UINT64);
421       g_value_set_uint64 (out_gvalue, g_variant_get_uint64 (value));
422       break;
423
424     case G_VARIANT_CLASS_HANDLE:
425       g_value_init (out_gvalue, G_TYPE_INT);
426       g_value_set_int (out_gvalue, g_variant_get_int32 (value));
427       break;
428
429     case G_VARIANT_CLASS_DOUBLE:
430       g_value_init (out_gvalue, G_TYPE_DOUBLE);
431       g_value_set_double (out_gvalue, g_variant_get_double (value));
432       break;
433
434     case G_VARIANT_CLASS_STRING:
435       g_value_init (out_gvalue, G_TYPE_STRING);
436       g_value_set_string (out_gvalue, g_variant_get_string (value, NULL));
437       break;
438
439     case G_VARIANT_CLASS_OBJECT_PATH:
440       g_value_init (out_gvalue, G_TYPE_STRING);
441       g_value_set_string (out_gvalue, g_variant_get_string (value, NULL));
442       break;
443
444     case G_VARIANT_CLASS_SIGNATURE:
445       g_value_init (out_gvalue, G_TYPE_STRING);
446       g_value_set_string (out_gvalue, g_variant_get_string (value, NULL));
447       break;
448
449     case G_VARIANT_CLASS_ARRAY:
450       type = g_variant_get_type (value);
451       switch (g_variant_type_peek_string (type)[1])
452         {
453         case G_VARIANT_CLASS_BYTE:
454           g_value_init (out_gvalue, G_TYPE_STRING);
455           g_value_set_string (out_gvalue, g_variant_get_bytestring (value));
456           break;
457
458         case G_VARIANT_CLASS_STRING:
459           g_value_init (out_gvalue, G_TYPE_STRV);
460           array = g_variant_dup_strv (value, NULL);
461           g_value_take_boxed (out_gvalue, array);
462           break;
463
464         case G_VARIANT_CLASS_ARRAY:
465           switch (g_variant_type_peek_string (type)[2])
466             {
467             case G_VARIANT_CLASS_BYTE:
468               g_value_init (out_gvalue, G_TYPE_STRV);
469               array = g_variant_dup_bytestring_array (value, NULL);
470               g_value_take_boxed (out_gvalue, array);
471               break;
472
473             default:
474               g_value_init (out_gvalue, G_TYPE_VARIANT);
475               g_value_set_variant (out_gvalue, value);
476               break;
477             }
478           break;
479
480         default:
481           g_value_init (out_gvalue, G_TYPE_VARIANT);
482           g_value_set_variant (out_gvalue, value);
483           break;
484         }
485       break;
486
487     case G_VARIANT_CLASS_VARIANT:
488     case G_VARIANT_CLASS_MAYBE:
489     case G_VARIANT_CLASS_TUPLE:
490     case G_VARIANT_CLASS_DICT_ENTRY:
491       g_value_init (out_gvalue, G_TYPE_VARIANT);
492       g_value_set_variant (out_gvalue, value);
493       break;
494     }
495 }
496
497
498 /**
499  * g_dbus_gvalue_to_gvariant:
500  * @gvalue: A #GValue to convert to a #GVariant.
501  * @type: A #GVariantType.
502  *
503  * Converts a #GValue to a #GVariant of the type indicated by the @type parameter.
504  *
505  * The conversion is using the following rules:
506  * <table frame='all'>
507  *   <title>#GValue / #GVariant conversion rules</title>
508  *   <tgroup cols='2' align='left' colsep='1' rowsep='1'>
509  *     <thead>
510  *       <row>
511  *         <entry>If the #GType for @gvalue is...</entry>
512  *         <entry>... then @type must be</entry>
513  *       </row>
514  *     </thead>
515  *     <tbody>
516  *       <row>
517  *         <entry>#G_TYPE_STRING</entry>
518  *         <entry><link linkend="G-VARIANT-TYPE-STRING:CAPS">'s'</link>, <link linkend="G-VARIANT-TYPE-OBJECT-PATH:CAPS">'o'</link>, <link linkend="G-VARIANT-TYPE-SIGNATURE:CAPS">'g'</link> or <link linkend="G-VARIANT-TYPE-BYTESTRING:CAPS">'ay'</link></entry>
519  *       </row>
520  *       <row>
521  *         <entry>#G_TYPE_STRV</entry>
522  *         <entry><link linkend="G-VARIANT-TYPE-STRING-ARRAY:CAPS">'as'</link> or <link linkend="G-VARIANT-TYPE-BYTESTRING-ARRAY:CAPS">'aay'</link></entry>
523  *       </row>
524  *       <row>
525  *         <entry>#G_TYPE_BOOLEAN</entry>
526  *         <entry><link linkend="G-VARIANT-TYPE-BOOLEAN:CAPS">'b'</link></entry>
527  *       </row>
528  *       <row>
529  *         <entry>#G_TYPE_UCHAR</entry>
530  *         <entry><link linkend="G-VARIANT-TYPE-BYTE:CAPS">'y'</link></entry>
531  *       </row>
532  *       <row>
533  *         <entry>#G_TYPE_INT</entry>
534  *         <entry><link linkend="G-VARIANT-TYPE-INT32:CAPS">'i'</link> or <link linkend="G-VARIANT-TYPE-INT16:CAPS">'n'</link></entry>
535  *       </row>
536  *       <row>
537  *         <entry>#G_TYPE_UINT</entry>
538  *         <entry><link linkend="G-VARIANT-TYPE-UINT32:CAPS">'u'</link> or <link linkend="G-VARIANT-TYPE-UINT16:CAPS">'q'</link></entry>
539  *       </row>
540  *       <row>
541  *         <entry>#G_TYPE_INT64</entry>
542  *         <entry><link linkend="G-VARIANT-TYPE-INT64:CAPS">'x'</link></entry>
543  *       </row>
544  *       <row>
545  *         <entry>#G_TYPE_UINT64</entry>
546  *         <entry><link linkend="G-VARIANT-TYPE-UINT64:CAPS">'t'</link></entry>
547  *       </row>
548  *       <row>
549  *         <entry>#G_TYPE_INT</entry>
550  *         <entry><link linkend="G-VARIANT-TYPE-HANDLE:CAPS">'h'</link></entry>
551  *       </row>
552  *       <row>
553  *         <entry>#G_TYPE_DOUBLE</entry>
554  *         <entry><link linkend="G-VARIANT-TYPE-DOUBLE:CAPS">'d'</link></entry>
555  *       </row>
556  *       <row>
557  *         <entry>#G_TYPE_VARIANT</entry>
558  *         <entry>Any #GVariantType</entry>
559  *       </row>
560  *     </tbody>
561  *   </tgroup>
562  * </table>
563  * This can fail if e.g. @gvalue is of type #G_TYPE_STRING and @type
564  * is <link linkend="G-VARIANT-TYPE-INT32:CAPS">'i'</link>. It will
565  * also fail for any #GType (including e.g. #G_TYPE_OBJECT and
566  * #G_TYPE_BOXED derived-types) not in the table above.
567  *
568  * Note that if @gvalue is of type #G_TYPE_VARIANT and its value is
569  * %NULL, the <emphasis>empty</emphasis> #GVariant instance (never
570  * %NULL) for @type is returned (e.g. 0 for scalar types, the empty
571  * string for string types, <literal>'/'</literal> for object path
572  * types, the empty array for any array type and so on).
573  *
574  * See the g_dbus_gvariant_to_gvalue() function for how to convert a
575  * #GVariant to a #GValue.
576  *
577  * Returns: A #GVariant (never floating) of #GVariantType
578  * @type holding the data from @gvalue or %NULL in case of
579  * failure. Free with g_variant_unref().
580  *
581  * Since: 2.30
582  */
583 GVariant *
584 g_dbus_gvalue_to_gvariant (const GValue       *gvalue,
585                            const GVariantType *type)
586 {
587   GVariant *ret;
588   const gchar *s;
589   const gchar * const *as;
590   const gchar *empty_strv[1] = {NULL};
591
592   g_return_val_if_fail (gvalue != NULL, NULL);
593   g_return_val_if_fail (type != NULL, NULL);
594
595   ret = NULL;
596
597   /* @type can easily be e.g. "s" with the GValue holding a GVariant - for example this
598    * can happen when using the org.gtk.GDBus.C.ForceGVariant annotation with the
599    * gdbus-codegen(1) tool.
600    */
601   if (G_VALUE_TYPE (gvalue) == G_TYPE_VARIANT)
602     {
603       ret = g_value_dup_variant (gvalue);
604     }
605   else
606     {
607       switch (g_variant_type_peek_string (type)[0])
608         {
609         case G_VARIANT_CLASS_BOOLEAN:
610           ret = g_variant_ref_sink (g_variant_new_boolean (g_value_get_boolean (gvalue)));
611           break;
612
613         case G_VARIANT_CLASS_BYTE:
614           ret = g_variant_ref_sink (g_variant_new_byte (g_value_get_uchar (gvalue)));
615           break;
616
617         case G_VARIANT_CLASS_INT16:
618           ret = g_variant_ref_sink (g_variant_new_int16 (g_value_get_int (gvalue)));
619           break;
620
621         case G_VARIANT_CLASS_UINT16:
622           ret = g_variant_ref_sink (g_variant_new_uint16 (g_value_get_uint (gvalue)));
623           break;
624
625         case G_VARIANT_CLASS_INT32:
626           ret = g_variant_ref_sink (g_variant_new_int32 (g_value_get_int (gvalue)));
627           break;
628
629         case G_VARIANT_CLASS_UINT32:
630           ret = g_variant_ref_sink (g_variant_new_uint32 (g_value_get_uint (gvalue)));
631           break;
632
633         case G_VARIANT_CLASS_INT64:
634           ret = g_variant_ref_sink (g_variant_new_int64 (g_value_get_int64 (gvalue)));
635           break;
636
637         case G_VARIANT_CLASS_UINT64:
638           ret = g_variant_ref_sink (g_variant_new_uint64 (g_value_get_uint64 (gvalue)));
639           break;
640
641         case G_VARIANT_CLASS_HANDLE:
642           ret = g_variant_ref_sink (g_variant_new_handle (g_value_get_int (gvalue)));
643           break;
644
645         case G_VARIANT_CLASS_DOUBLE:
646           ret = g_variant_ref_sink (g_variant_new_double (g_value_get_double (gvalue)));
647           break;
648
649         case G_VARIANT_CLASS_STRING:
650           s = g_value_get_string (gvalue);
651           if (s == NULL)
652             s = "";
653           ret = g_variant_ref_sink (g_variant_new_string (s));
654           break;
655
656         case G_VARIANT_CLASS_OBJECT_PATH:
657           s = g_value_get_string (gvalue);
658           if (s == NULL)
659             s = "/";
660           ret = g_variant_ref_sink (g_variant_new_object_path (s));
661           break;
662
663         case G_VARIANT_CLASS_SIGNATURE:
664           s = g_value_get_string (gvalue);
665           if (s == NULL)
666             s = "";
667           ret = g_variant_ref_sink (g_variant_new_signature (s));
668           break;
669
670         case G_VARIANT_CLASS_ARRAY:
671           switch (g_variant_type_peek_string (type)[1])
672             {
673             case G_VARIANT_CLASS_BYTE:
674               s = g_value_get_string (gvalue);
675               if (s == NULL)
676                 s = "";
677               ret = g_variant_ref_sink (g_variant_new_bytestring (s));
678               break;
679
680             case G_VARIANT_CLASS_STRING:
681               as = g_value_get_boxed (gvalue);
682               if (as == NULL)
683                 as = empty_strv;
684               ret = g_variant_ref_sink (g_variant_new_strv (as, -1));
685               break;
686
687             case G_VARIANT_CLASS_ARRAY:
688               switch (g_variant_type_peek_string (type)[2])
689                 {
690                 case G_VARIANT_CLASS_BYTE:
691                   as = g_value_get_boxed (gvalue);
692                   if (as == NULL)
693                     as = empty_strv;
694                   ret = g_variant_ref_sink (g_variant_new_bytestring_array (as, -1));
695                   break;
696
697                 default:
698                   ret = g_value_dup_variant (gvalue);
699                   break;
700                 }
701               break;
702
703             default:
704               ret = g_value_dup_variant (gvalue);
705               break;
706             }
707           break;
708
709         default:
710         case G_VARIANT_CLASS_VARIANT:
711         case G_VARIANT_CLASS_MAYBE:
712         case G_VARIANT_CLASS_TUPLE:
713         case G_VARIANT_CLASS_DICT_ENTRY:
714           ret = g_value_dup_variant (gvalue);
715           break;
716         }
717     }
718
719   /* Could be that the GValue is holding a NULL GVariant - in that case,
720    * we return an "empty" GVariant instead of a NULL GVariant
721    */
722   if (ret == NULL)
723     {
724       GVariant *untrusted_empty;
725       untrusted_empty = g_variant_new_from_data (type, NULL, 0, FALSE, NULL, NULL);
726       ret = g_variant_ref_sink (g_variant_get_normal_form (untrusted_empty));
727       g_variant_unref (untrusted_empty);
728     }
729
730   g_assert (!g_variant_is_floating (ret));
731
732   return ret;
733 }