docs/reference/glib/gvariant-varargs.xml

   1 <?xml version='1.0' encoding='utf-8'?>
   2
   3 <refentry id='gvariant-format-strings'>
   4  <refmeta>
   5   <refentrytitle>GVariant Format Strings</refentrytitle>
   6  </refmeta>
   7  <refnamediv>
   8   <refname>GVariant Format Strings</refname>
   9   <refpurpose>varargs conversion of GVariants</refpurpose>
  10  </refnamediv>
  11
  12  <refsect1>
  13   <title>Variable Argument Conversions</title>
  14
  15   <para>
  16    This page attempts to document how to perform variable argument
  17    conversions with GVariant.
  18   </para>
  19   <para>
  20    Conversions occur according to format strings.  A format string is a two-way mapping between a single
  21    <link linkend='GVariant'>GVariant</link> value and one or more C values.
  22   </para>
  23   <para>
  24    A conversion from C values into a <link linkend='GVariant'>GVariant</link> value is made using the
  25    <link linkend='g-variant-new'><function>g_variant_new()</function></link> function.  A conversion from a
  26    <link linkend='GVariant'>GVariant</link> into C values is made using the
  27    <link linkend='g-variant-get'><function>g_variant_get()</function></link> function.
  28   </para>
  29  </refsect1>
  30
  31  <refsect1>
  32   <title>Syntax</title>
  33
  34   <para>
  35    This section exhaustively describes all possibilities for GVariant format strings.  There are no valid forms of
  36    format strings other than those described here.  Please note that the format string syntax is likely to expand in the
  37    future.
  38   </para>
  39   <para>
  40    Valid format strings have one of the following forms:
  41   </para>
  42   <itemizedlist>
  43    <listitem>
  44     <para>any type string</para>
  45    </listitem>
  46    <listitem>
  47     <para>
  48      a type string prefixed with a '<literal>@</literal>'
  49     </para>
  50    </listitem>
  51    <listitem>
  52     <para>
  53      '<literal>&amp;s</literal>' '<literal>&amp;o</literal>', '<literal>&amp;g</literal>', '<literal>^as</literal>',
  54      '<literal>^a&amp;s</literal>', '<literal>^ao</literal>', '<literal>^a&amp;o</literal>','<literal>^ay</literal>',
  55      '<literal>^&amp;ay</literal>', '<literal>^aay</literal>' or '<literal>^a&amp;ay</literal>'.
  56     </para>
  57    </listitem>
  58    <listitem>
  59     <para>
  60      any format string, prefixed with an '<literal>m</literal>'
  61     </para>
  62    </listitem>
  63    <listitem>
  64     <para>
  65      a sequence of zero or more format strings, concatenated and enclosed in parentheses
  66     </para>
  67    </listitem>
  68    <listitem>
  69     <para>
  70      an opening brace, followed by two format strings, followed by a closing brace (subject to the constraint that the
  71      first format string correspond to a type valid for use as the key type of a dictionary)
  72     </para>
  73    </listitem>
  74   </itemizedlist>
  75  </refsect1>
  76  <refsect1>
  77   <title>Symbols</title>
  78
  79    <para>
  80     The following table describes the rough meaning of symbols that may appear inside a GVariant format string.  Each
  81     symbol is described in detail in its own section, including usage examples.
  82   </para>
  83
  84   <informaltable>
  85    <tgroup cols='2'>
  86     <colspec colname='col_0'/>
  87     <colspec colname='col_1'/>
  88     <tbody>
  89
  90      <row rowsep='1'>
  91       <entry colsep='1' rowsep='1'>
  92        <para>
  93         <emphasis role='strong'>Symbol</emphasis>
  94        </para>
  95       </entry>
  96       <entry colsep='1' rowsep='1'>
  97        <para>
  98          <emphasis role='strong'>Meaning</emphasis>
  99        </para>
 100       </entry>
 101      </row>
 102
 103      <row rowsep='1'>
 104       <entry colsep='1' rowsep='1'>
 105        <para>
 106         <emphasis role='strong'>
 107          <literal>b</literal>, <literal>y</literal>, <literal>n</literal>, <literal>q</literal>, <literal>i</literal>,
 108          <literal>u</literal>, <literal>x</literal>, <literal>t</literal>, <literal>h</literal>, <literal>d</literal>
 109         </emphasis>
 110        </para>
 111       </entry>
 112       <entry colsep='1' rowsep='1'>
 113        <para>
 114         Used for building or deconstructing boolean, byte and numeric types.  See
 115         <link linkend='gvariant-format-strings-numeric-types'>Numeric Types</link> below.
 116        </para>
 117       </entry>
 118      </row>
 119
 120      <row rowsep='1'>
 121       <entry colsep='1' rowsep='1'>
 122        <para>
 123         <emphasis role='strong'>
 124          <literal>s</literal>, <literal>o</literal>, <literal>g</literal>
 125         </emphasis>
 126        </para>
 127       </entry>
 128       <entry colsep='1' rowsep='1'>
 129        <para>
 130         Used for building or deconstructing string types.  See
 131         <link linkend='gvariant-format-strings-strings'>Strings</link> below.
 132        </para>
 133       </entry>
 134      </row>
 135
 136      <row rowsep='1'>
 137       <entry colsep='1' rowsep='1'>
 138        <para>
 139         <emphasis role='strong'><literal>v</literal></emphasis>
 140        </para>
 141       </entry>
 142       <entry colsep='1' rowsep='1'>
 143        <para>
 144         Used for building or deconstructing variant types.  See
 145         <link linkend='gvariant-format-strings-variants'>Variants</link> below.
 146        </para>
 147       </entry>
 148      </row>
 149
 150      <row rowsep='1'>
 151       <entry colsep='1' rowsep='1'>
 152        <para>
 153         <emphasis role='strong'>
 154          <literal>a</literal>
 155         </emphasis>
 156        </para>
 157       </entry>
 158       <entry colsep='1' rowsep='1'>
 159        <para>
 160         Used for building or deconstructing arrays.  See
 161         <link linkend='gvariant-format-strings-arrays'>Arrays</link> below.
 162        </para>
 163       </entry>
 164      </row>
 165
 166      <row rowsep='1'>
 167       <entry colsep='1' rowsep='1'>
 168        <para>
 169         <emphasis role='strong'>
 170          <literal>m</literal>
 171         </emphasis>
 172        </para>
 173       </entry>
 174       <entry colsep='1' rowsep='1'>
 175        <para>
 176          Used for building or deconstructing maybe types.  See
 177          <link linkend='gvariant-format-strings-maybe-types'>Maybe Types</link> below.
 178        </para>
 179       </entry>
 180      </row>
 181
 182      <row rowsep='1'>
 183       <entry colsep='1' rowsep='1'>
 184        <para>
 185         <emphasis role='strong'>
 186          <literal>()</literal>
 187         </emphasis>
 188        </para>
 189       </entry>
 190       <entry colsep='1' rowsep='1'>
 191        <para>
 192          Used for building or deconstructing tuples.  See
 193          <link linkend='gvariant-format-strings-tuples'>Tuples</link> below.
 194        </para>
 195       </entry>
 196      </row>
 197
 198      <row rowsep='1'>
 199       <entry colsep='1' rowsep='1'>
 200        <para>
 201         <emphasis role='strong'>
 202          <literal>{}</literal>
 203         </emphasis>
 204        </para>
 205       </entry>
 206       <entry colsep='1' rowsep='1'>
 207        <para>
 208         Used for building or deconstructing dictionary entries. See
 209         <link linkend='gvariant-format-strings-dictionaries'>Dictionaries</link> below.
 210        </para>
 211       </entry>
 212      </row>
 213
 214      <row rowsep='1'>
 215       <entry colsep='1' rowsep='1'>
 216        <para>
 217         <emphasis role='strong'>
 218          <literal>@</literal>
 219         </emphasis>
 220        </para>
 221       </entry>
 222       <entry colsep='1' rowsep='1'>
 223        <para>
 224         Used as a prefix for a GVariant type string (not a prefix for a format string, so <literal>@as</literal> is
 225         a valid format string but <literal>@^as</literal> is not).  Denotes that a pointer to a
 226         <link linkend='GVariant'>GVariant</link> should be used in place of the normal C type or types.  For
 227         <link linkend='g-variant-new'><function>g_variant_new()</function></link> this means that you must pass a
 228         non-<link linkend='NULL:CAPS'><literal>NULL</literal></link> <code>(<link linkend='GVariant'>GVariant</link>
 229         *)</code>; if it is a floating reference, ownership will be taken, as
 230         if by using <link linkend="g-variant-ref-sink"><function>g_variant_ref_sink()</function></link>.
 231         For <link linkend='g-variant-get'><function>g_variant_get()</function></link> this means that you
 232         must pass a pointer to a <code>(<link linkend='GVariant'>GVariant</link> *)</code> for the value to be returned
 233         by reference or <link linkend='NULL:CAPS'><literal>NULL</literal></link> to ignore the value.  See
 234         <link linkend='gvariant-format-strings-gvariant'><code>GVariant *</code></link> below.
 235        </para>
 236       </entry>
 237      </row>
 238
 239      <row rowsep='1'>
 240       <entry colsep='1' rowsep='1'>
 241        <para>
 242         <emphasis role='strong'>
 243          <literal>*</literal>, <literal>?</literal>, <literal>r</literal>
 244         </emphasis>
 245        </para>
 246       </entry>
 247       <entry colsep='1' rowsep='1'>
 248        <para>
 249         Exactly equivalent to <literal>@*</literal>, <literal>@?</literal> and <literal>@r</literal>.  Provided only for
 250         completeness so that all GVariant type strings can be used also as format strings.  See <link
 251         linkend='gvariant-format-strings-gvariant'><code>GVariant *</code></link> below.
 252        </para>
 253       </entry>
 254      </row>
 255
 256      <row rowsep='1'>
 257       <entry colsep='1' rowsep='1'>
 258        <para>
 259         <emphasis role='strong'><literal>&amp;</literal></emphasis>
 260        </para>
 261       </entry>
 262       <entry colsep='1' rowsep='1'>
 263        <para>
 264         Used as a prefix for a GVariant type string (not a prefix for a format string, so <literal>&amp;s</literal> is
 265         a valid format string but <literal>&amp;@s</literal> is not).
 266         Denotes that a C pointer to serialised data
 267         should be used in place of the normal C type.  See
 268         <link linkend='gvariant-format-strings-pointers'>Pointers</link> below.
 269        </para>
 270       </entry>
 271      </row>
 272
 273      <row rowsep='1'>
 274       <entry colsep='1' rowsep='1'>
 275        <para>
 276         <emphasis role='strong'><literal>^</literal></emphasis>
 277        </para>
 278       </entry>
 279       <entry colsep='1' rowsep='1'>
 280        <para>
 281         Used as a prefix on some specific types of format strings.  See
 282         <link linkend='gvariant-format-strings-convenience'>Convenience Conversions</link> below.
 283        </para>
 284       </entry>
 285      </row>
 286     </tbody>
 287    </tgroup>
 288   </informaltable>
 289
 290
 291   <refsect2 id='gvariant-format-strings-numeric-types'>
 292    <title>Numeric Types</title>
 293    <para>
 294     <emphasis role='strong'>
 295      Characters: <literal>b</literal>, <literal>y</literal>, <literal>n</literal>, <literal>q</literal>,
 296      <literal>i</literal>, <literal>u</literal>, <literal>x</literal>, <literal>t</literal>, <literal>h</literal>,
 297      <literal>d</literal>
 298     </emphasis>
 299    </para>
 300
 301    <para>
 302     Variable argument conversions from numeric types work in the most obvious way possible.  Upon encountering one of
 303     these characters, <link linkend='g-variant-new'><function>g_variant_new()</function></link> takes the equivalent C
 304     type as an argument.  <link linkend='g-variant-get'><function>g_variant_get()</function></link> takes a pointer to
 305     the equivalent C type (or <link linkend='NULL:CAPS'><literal>NULL</literal></link> to ignore the value).
 306    </para>
 307
 308    <para>
 309     The equivalent C types are as follows:
 310    </para>
 311
 312    <informaltable>
 313     <tgroup cols='2'>
 314      <colspec colname='col_0'/><colspec colname='col_1'/>
 315      <tbody>
 316       <row rowsep='1'>
 317        <entry colsep='1' rowsep='1'>
 318         <para>
 319           <emphasis role='strong'>Character</emphasis>
 320         </para>
 321        </entry>
 322        <entry colsep='1' rowsep='1'>
 323         <para>
 324           <emphasis role='strong'>Equivalent C type</emphasis>
 325         </para>
 326        </entry>
 327       </row>
 328       <row rowsep='1'>
 329        <entry colsep='1' rowsep='1'>
 330         <para>
 331          <emphasis role='strong'>
 332           <literal>b</literal>
 333          </emphasis>
 334         </para>
 335        </entry>
 336        <entry colsep='1' rowsep='1'>
 337         <para>
 338          <link linkend='gboolean'><type>gboolean</type></link>
 339         </para>
 340        </entry>
 341       </row>
 342       <row rowsep='1'>
 343        <entry colsep='1' rowsep='1'>
 344         <para>
 345          <emphasis role='strong'>
 346           <literal>y</literal>
 347          </emphasis>
 348         </para>
 349        </entry>
 350        <entry colsep='1' rowsep='1'>
 351         <para>
 352          <link linkend='guchar'><type>guchar</type></link>
 353         </para>
 354        </entry>
 355       </row>
 356       <row rowsep='1'>
 357        <entry colsep='1' rowsep='1'>
 358         <para>
 359          <emphasis role='strong'>
 360           <literal>n</literal>
 361          </emphasis>
 362         </para>
 363        </entry>
 364        <entry colsep='1' rowsep='1'>
 365         <para>
 366          <link linkend='gint16'><type>gint16</type></link>
 367         </para>
 368        </entry>
 369       </row>
 370       <row rowsep='1'>
 371        <entry colsep='1' rowsep='1'>
 372         <para>
 373          <emphasis role='strong'>
 374           <literal>q</literal>
 375          </emphasis>
 376         </para>
 377        </entry>
 378        <entry colsep='1' rowsep='1'>
 379         <para>
 380          <link linkend='guint16'><type>guint16</type></link>
 381         </para>
 382        </entry>
 383       </row>
 384       <row rowsep='1'>
 385        <entry colsep='1' rowsep='1'>
 386         <para>
 387          <emphasis role='strong'>
 388           <literal>i</literal>
 389          </emphasis>
 390         </para>
 391        </entry>
 392        <entry colsep='1' rowsep='1'>
 393         <para>
 394          <link linkend='gint32'><type>gint32</type></link>
 395         </para>
 396        </entry>
 397       </row>
 398       <row rowsep='1'>
 399        <entry colsep='1' rowsep='1'>
 400         <para>
 401          <emphasis role='strong'>
 402           <literal>u</literal>
 403          </emphasis>
 404         </para>
 405        </entry>
 406        <entry colsep='1' rowsep='1'>
 407         <para>
 408          <link linkend='guint32'><type>guint32</type></link>
 409         </para>
 410        </entry>
 411       </row>
 412       <row rowsep='1'>
 413        <entry colsep='1' rowsep='1'>
 414         <para>
 415          <emphasis role='strong'>
 416           <literal>x</literal>
 417          </emphasis>
 418         </para>
 419        </entry>
 420        <entry colsep='1' rowsep='1'>
 421         <para>
 422          <link linkend='gint64'><type>gint64</type></link>
 423         </para>
 424        </entry>
 425       </row>
 426       <row rowsep='1'>
 427        <entry colsep='1' rowsep='1'>
 428         <para>
 429          <emphasis role='strong'>
 430           <literal>t</literal>
 431          </emphasis>
 432         </para>
 433        </entry>
 434        <entry colsep='1' rowsep='1'>
 435         <para>
 436          <link linkend='guint64'><type>guint64</type></link>
 437         </para>
 438        </entry>
 439       </row>
 440       <row rowsep='1'>
 441        <entry colsep='1' rowsep='1'>
 442         <para>
 443          <emphasis role='strong'>
 444           <literal>h</literal>
 445          </emphasis>
 446         </para>
 447        </entry>
 448        <entry colsep='1' rowsep='1'>
 449         <para>
 450          <link linkend='gint32'><type>gint32</type></link>
 451         </para>
 452        </entry>
 453       </row>
 454       <row rowsep='1'>
 455        <entry colsep='1' rowsep='1'>
 456         <para>
 457          <emphasis role='strong'>
 458           <literal>d</literal>
 459          </emphasis>
 460         </para>
 461        </entry>
 462        <entry colsep='1' rowsep='1'>
 463         <para>
 464          <link linkend='gdouble'><type>gdouble</type></link>
 465         </para>
 466        </entry>
 467       </row>
 468      </tbody>
 469     </tgroup>
 470    </informaltable>
 471
 472    <anchor id='gvariant-varargs'/>
 473    <para>
 474     Note that in C, small integer types in variable argument lists are promoted up to <link
 475     linkend='gint'><type>int</type></link> or <link linkend='guint'><type>unsigned int</type></link> as appropriate, and
 476     read back accordingly.  <link linkend='gint'><type>int</type></link> is 32 bits on every platform on which GLib is
 477     currently supported.  This means that you can use C expressions of type <link linkend='gint'><type>int</type></link>
 478     with <link linkend='g-variant-new'><function>g_variant_new()</function></link> and format characters
 479     '<literal>b</literal>', '<literal>y</literal>', '<literal>n</literal>', '<literal>q</literal>',
 480     '<literal>i</literal>', '<literal>u</literal>' and '<literal>h</literal>'.  Specifically, you can use integer
 481     literals with these characters.
 482    </para>
 483
 484    <para>
 485     When using the '<literal>x</literal>' and '<literal>t</literal>' characters, you must ensure that the value that you
 486     provide is 64 bit.  This means that you should use a cast or make use of the
 487     <link linkend='G-GINT64-CONSTANT:CAPS'><literal>G_GINT64_CONSTANT</literal></link> or
 488     <link linkend='G-GUINT64-CONSTANT:CAPS'><literal>G_GUINT64_CONSTANT</literal></link> macros.
 489    </para>
 490
 491    <para>
 492     No type promotion occurs when using <link linkend='g-variant-get'><function>g_variant_get()</function></link> since
 493     it operates with pointers.  The pointers must always point to a memory region of exactly the correct size.
 494    </para>
 495
 496    <refsect3>
 497     <title>Examples</title>
 498     <informalexample><programlisting>
 499 <![CDATA[GVariant *value1, *value2, *value3, *value4;
 500
 501 value1 = g_variant_new ("y", 200);
 502 value2 = g_variant_new ("b", TRUE);
 503 value3 = g_variant_new ("d", 37.5):
 504 value4 = g_variant_new ("x", G_GINT64_CONSTANT (998877665544332211));
 505
 506 {
 507   gdouble floating;
 508   gboolean truth;
 509   gint64 bignum;
 510
 511
 512   g_variant_get (value1, "y", NULL);      /* ignore the value. */
 513   g_variant_get (value2, "b", &truth);
 514   g_variant_get (value3, "d", &floating);
 515   g_variant_get (value4, "x", &bignum);
 516 }]]></programlisting></informalexample>
 517    </refsect3>
 518   </refsect2>
 519
 520   <refsect2 id='gvariant-format-strings-strings'>
 521    <title>Strings</title>
 522    <para>
 523     <emphasis role='strong'>
 524      Characters: <literal>s</literal>, <literal>o</literal>, <literal>g</literal>
 525     </emphasis>
 526    </para>
 527
 528    <para>
 529     String conversions occur to and from standard nul-terminated C strings.  Upon encountering an
 530     '<literal>s</literal>', '<literal>o</literal>' or '<literal>g</literal>' in a format string,
 531     <link linkend='g-variant-new'><function>g_variant_new()</function></link> takes a <code>(const
 532     <link linkend='gchar'>gchar</link> *)</code> and makes a copy of it.
 533     <link linkend='NULL:CAPS'><literal>NULL</literal></link> is not a valid string; use
 534     <link linkend='gvariant-format-strings-maybe-types'>maybe types</link> to encode that.  If the '<literal>o</literal>' or
 535     '<literal>g</literal>' characters are used, care must be taken to ensure that the passed string is a valid DBus
 536     object path or DBus type signature, respectively.
 537    </para>
 538    <para>
 539     Upon encounting '<literal>s</literal>', '<literal>o</literal>' or '<literal>g</literal>', <link
 540     linkend='g-variant-get'><function>g_variant_get()</function></link> takes a pointer to a
 541     <code>(<link linkend='gchar'>gchar</link> *)</code> (ie: <code>(<link linkend='gchar'>gchar</link> **)</code>) and
 542     sets it to a newly-allocated copy of the string.  It is appropriate to free this copy using
 543     <link linkend='g-free'><function>g_free()</function></link>.
 544     <link linkend='NULL:CAPS'><literal>NULL</literal></link> may also be passed to indicate that the value of the
 545     string should be ignored (in which case no copy is made).
 546    </para>
 547
 548    <refsect3>
 549     <title>Examples</title>
 550     <informalexample><programlisting>
 551 <![CDATA[GVariant *value1, *value2, *value3;
 552
 553 value1 = g_variant_new ("s", "hello world!");
 554 value2 = g_variant_new ("o", "/must/be/a/valid/path");
 555 value3 = g_variant_new ("g", "iias");
 556
 557 #if 0
 558   g_variant_new ("s", NULL);      /* not valid: NULL is not a string. */
 559 #endif
 560
 561 {
 562   gchar *result;
 563
 564   g_variant_get (value1, "s", &result);
 565   g_print ("It was '%s'\n", result);
 566   g_free (result);
 567 }]]></programlisting></informalexample>
 568    </refsect3>
 569   </refsect2>
 570
 571   <refsect2 id='gvariant-format-strings-variants'>
 572    <title>Variants</title>
 573    <para>
 574     <emphasis role='strong'>
 575      Characters: <literal>v</literal>
 576     </emphasis>
 577    </para>
 578
 579    <para>
 580     Upon encountering a '<literal>v</literal>',
 581     <link linkend='g-variant-new'><function>g_variant_new()</function></link> takes a <code>(<link
 582     linkend='GVariant'>GVariant</link> *)</code>.  The value of the
 583     <link linkend='GVariant'><type>GVariant</type></link> is used as the contents of the variant value.
 584    </para>
 585    <para>
 586     Upon encountering a '<literal>v</literal>', <link
 587     linkend='g-variant-get'><function>g_variant_get()</function></link> takes a pointer to a
 588     <code>(<link linkend='GVariant'>GVariant</link> *)</code> (ie: <code>(<link linkend='GVariant'>GVariant</link> **)
 589     </code>).  It is set to a new reference to a <link linkend='GVariant'><type>GVariant</type></link> instance
 590     containing the contents of the variant value.  It is appropriate to free this reference using
 591     <link linkend='g-variant-unref'><function>g_variant_unref()</function></link>.
 592     <link linkend='NULL:CAPS'><literal>NULL</literal></link> may also be passed to indicate that the value should be
 593     ignored (in which case no new reference is created).
 594    </para>
 595
 596    <refsect3>
 597     <title>Examples</title>
 598     <informalexample><programlisting>
 599 <![CDATA[GVariant *x, *y;
 600
 601 /* the following two lines are equivalent: */
 602 x = g_variant_new ("v", y);
 603 x = g_variant_new_variant (y);
 604
 605 /* as are these: */
 606 g_variant_get (x, "v", &y);
 607 y = g_variant_get_variant (x);]]></programlisting></informalexample>
 608    </refsect3>
 609   </refsect2>
 610
 611
 612   <refsect2 id='gvariant-format-strings-arrays'>
 613    <title>Arrays</title>
 614    <para>
 615     <emphasis role='strong'>
 616      Characters: <literal>a</literal>
 617     </emphasis>
 618    </para>
 619
 620    <para>
 621     Upon encountering an '<literal>a</literal>' character followed by a type string,
 622     <link linkend='g-variant-new'><function>g_variant_new()</function></link> will take a
 623     <code>(<link linkend='GVariantBuilder'>GVariantBuilder</link> *)</code> that has been created as an array builder
 624     for an array of the type given in the type string.  The builder will have
 625     <link linkend='g-variant-builder-end'><function>g_variant_builder_end()</function></link> called on it and the
 626     result will be used as the value.  As a special exception, if the given type string is a definite type, then
 627     <link linkend='NULL:CAPS'><literal>NULL</literal></link> may be given to mean an empty array of that type.
 628    </para>
 629
 630    <para>
 631     Upon encountering an '<literal>a</literal>' character followed by a type string,
 632     <link linkend='g-variant-get'><function>g_variant_get()</function></link> will take a pointer to a
 633     <code>(<link linkend='GVariantIter'>GVariantIter</link> *)</code> (ie:
 634     <code>(<link linkend='GVariantIter'>GVariantIter</link> **)</code>).
 635     A new heap-allocated iterator is created and returned, initialised for iterating over the elements of the array.
 636     This iterator should be freed when you are done with it, using
 637     <link linkend='g-variant-iter-free'><function>g_variant_iter_free()</function></link>.
 638     <link linkend='NULL:CAPS'><literal>NULL</literal></link> may also be given to indicate that the value of the array
 639     should be ignored.
 640    </para>
 641
 642    <refsect3>
 643     <title>Examples</title>
 644     <informalexample><programlisting>
 645 <![CDATA[GVariantBuilder *builder;
 646 GVariant *value;
 647
 648 builder = g_variant_builder_new (G_VARIANT_TYPE ("as"));
 649 g_variant_builder_add (builder, "s", "when");
 650 g_variant_builder_add (builder, "s", "in");
 651 g_variant_builder_add (builder, "s", "the");
 652 g_variant_builder_add (builder, "s", "course");
 653 value = g_variant_new ("as", builder);
 654 g_variant_builder_unref (builder);
 655
 656 {
 657   GVariantIter *iter;
 658   gchar *str;
 659
 660   g_variant_get (value, "as", &iter);
 661   while (g_variant_iter_loop (iter, "s", &str))
 662     g_print ("%s\n", str);
 663   g_variant_iter_free (iter);
 664 }
 665
 666 g_variant_unref (value);]]></programlisting></informalexample>
 667    </refsect3>
 668   </refsect2>
 669
 670   <refsect2 id='gvariant-format-strings-maybe-types'>
 671    <title>Maybe Types</title>
 672    <para>
 673     <emphasis role='strong'>
 674      Characters: <literal>m</literal>
 675     </emphasis>
 676    </para>
 677    <para>
 678     Maybe types are handled in two separate ways depending on the format string that follows the
 679     '<literal>m</literal>'.  The method that is used currently depends entirely on the character immediately following the
 680     '<literal>m</literal>'.
 681    </para>
 682
 683    <para>
 684     The first way is used with format strings starting with '<literal>a</literal>', '<literal>s</literal>',
 685     '<literal>o</literal>', '<literal>g</literal>', '<literal>v</literal>', '<literal>@</literal>',
 686     '<literal>*</literal>', '<literal>?</literal>', '<literal>r</literal>', '<literal>&amp;</literal>', or
 687     '<literal>^</literal>'.  In all of these cases, for non-maybe types,
 688     <link linkend='g-variant-new'><function>g_variant_new()</function></link> takes a pointer to a
 689     non-<link linkend='NULL:CAPS'><literal>NULL</literal></link> value and
 690     <link linkend='g-variant-get'><function>g_variant_get()</function></link> returns (by reference) a
 691     non-<link linkend='NULL:CAPS'><literal>NULL</literal></link> pointer.  When any of these format strings are
 692     prefixed with an '<literal>m</literal>', the type of arguments that are collected does not change in any way, but
 693     <link linkend='NULL:CAPS'><literal>NULL</literal></link> becomes a permissable value, to indicate the Nothing case.
 694    </para>
 695    <para>
 696     Note that the "special exception" introduced in the array section for constructing empty arrays is ignored
 697     here.  Using a <literal>NULL</literal> pointer with the format string '<literal>mas</literal>' constructs
 698     the Nothing value -- not an empty array.
 699    </para>
 700    <para>
 701     The second way is used with all other format strings.  For
 702     <link linkend='g-variant-new'><function>g_variant_new()</function></link> an additional
 703     <link linkend='gboolean'><type>gboolean</type></link> argument is collected and for
 704     <link linkend='g-variant-get'><function>g_variant_get()</function></link> an additional
 705     <code>(<link linkend='gboolean'>gboolean</link> *)</code>.  Following this argument, the arguments that are normally
 706     collected for the equivalent non-maybe type will be collected.
 707    </para>
 708    <para>
 709     If <link linkend='FALSE:CAPS'><literal>FALSE</literal></link> is given to
 710     <link linkend='g-variant-new'><function>g_variant_new()</function></link> then the Nothing value is constructed and
 711     the collected arguments are ignored.  Otherwise (if <link linkend='TRUE:CAPS'><literal>TRUE</literal></link> was
 712     given), the arguments are used in the normal way to create the Just value.
 713    </para>
 714    <para>
 715     If <link linkend='NULL:CAPS'><literal>NULL</literal></link> is given to
 716     <link linkend='g-variant-get'><function>g_variant_get()</function></link> then the value is ignored.  If a
 717     non-<link linkend='NULL:CAPS'><literal>NULL</literal></link> pointer is given then it is used to return by reference
 718     whether the value was Just.  In the case that the value was Just, the
 719     <link linkend='gboolean'><type>gboolean</type></link> will be set to
 720     <link linkend='TRUE:CAPS'><literal>TRUE</literal></link> and the value will be stored in the arguments in the usual
 721     way.  In the case that the value was Nothing, the <link linkend='gboolean'><type>gboolean</type></link> will be set to
 722     <link linkend='FALSE:CAPS'><literal>FALSE</literal></link> and the arguments will be collected in the normal way
 723     but have their values set to binary zero.
 724    </para>
 725
 726    <refsect3>
 727     <title>Examples</title>
 728     <informalexample><programlisting>
 729 <![CDATA[GVariant *value1, *value2, *value3, *value4, *value5, *value6;
 730 value1 = g_variant_new ("ms", "Hello world");
 731 value2 = g_variant_new ("ms", NULL);
 732 value3 = g_variant_new ("(m(ii)s)", TRUE, 123, 456, "Done");
 733 value4 = g_variant_new ("(m(ii)s)", FALSE, -1, -1, "Done");          /* both '-1' are ignored. */
 734 value5 = g_variant_new ("(m@(ii)s)", NULL, "Done");
 735
 736 {
 737   GVariant *contents;
 738   const gchar *cstr;
 739   gboolean just;
 740   gint32 x, y;
 741   gchar *str;
 742
 743   g_variant_get (value1, "ms", &str);
 744   if (str != NULL)
 745     g_print ("str: %s\n", str);
 746   else
 747     g_print ("it was null\n");
 748   g_free (str);
 749
 750
 751   g_variant_get (value2, "m&s", &cstr);
 752   if (cstr != NULL)
 753     g_print ("str: %s\n", cstr);
 754   else
 755     g_print ("it was null\n");
 756   /* don't free 'cstr' */
 757
 758
 759   /* NULL passed for the gboolean *, but two 'gint32 *' still collected */
 760   g_variant_get (value3, "(m(ii)s)", NULL, NULL, NULL, &str);
 761   g_print ("string is %s\n", str);
 762   g_free (str);
 763
 764   /* note: &s used, so g_free() not needed */
 765   g_variant_get (value4, "(m(ii)&s)", &just, &x, &y, &cstr);
 766   if (just)
 767     g_print ("it was (%d, %d)\n", x, y);
 768   else
 769     g_print ("it was null\n");
 770   g_print ("string is %s\n", cstr);
 771   /* don't free 'cstr' */
 772
 773
 774   g_variant_get (value5, "(m*s)", &contents, NULL); /* ignore the string. */
 775   if (contents != NULL)
 776     {
 777       g_variant_get (contents, "(ii)", &x, &y);
 778       g_print ("it was (%d, %d)\n", x, y);
 779       g_variant_unref (contents);
 780     }
 781   else
 782     g_print ("it was null\n");
 783 }]]></programlisting></informalexample>
 784    </refsect3>
 785   </refsect2>
 786
 787   <refsect2 id='gvariant-format-strings-tuples'>
 788    <title>Tuples</title>
 789    <para>
 790     <emphasis role='strong'>
 791      Characters: <code>()</code>
 792     </emphasis>
 793    </para>
 794
 795    <para>
 796     Tuples are handled by handling each item in the tuple, in sequence.  Each item is handled in the usual way.
 797    </para>
 798
 799    <refsect3>
 800     <title>Examples</title>
 801     <informalexample><programlisting>
 802 <![CDATA[GVariant *value1, *value2;
 803
 804 value1 = g_variant_new ("(s(ii))", "Hello", 55, 77);
 805 value2 = g_variant_new ("()");
 806
 807 {
 808   gchar *string;
 809   gint x, y;
 810
 811   g_variant_get (value1, "(s(ii))", &string, &x, &y);
 812   g_print ("%s, %d, %d\n", string, x, y);
 813   g_free (string);
 814
 815   g_variant_get (value2, "()");   /* do nothing... */
 816 }]]></programlisting></informalexample>
 817    </refsect3>
 818   </refsect2>
 819
 820   <refsect2 id='gvariant-format-strings-gvariant'>
 821    <title>GVariant *</title>
 822    <para>
 823     <emphasis role='strong'>
 824      Characters: <literal>@</literal>, <literal>*</literal>, <literal>?</literal>, <literal>r</literal>
 825     </emphasis>
 826
 827    </para>
 828    <para>
 829     Upon encountering a '<literal>@</literal>' in front of a type string,
 830     <link linkend='g-variant-new'><function>g_variant_new()</function></link> takes a
 831     non-<link linkend='NULL:CAPS'><literal>NULL</literal></link> pointer to a
 832     <link linkend='GVariant'><type>GVariant</type></link> and uses its value directly instead of collecting arguments to
 833     create the value.  The provided <link linkend='GVariant'><type>GVariant</type></link> must have a type that matches the
 834     type string following the '<literal>@</literal>'.  '<literal>*</literal>' is
 835     the same as '<literal>@*</literal>' (ie: take a <link linkend='GVariant'><type>GVariant</type></link> of any type).
 836     '<literal>?</literal>' is the same as '<literal>@?</literal>' (ie: take a
 837     <link linkend='GVariant'><type>GVariant</type></link> of any basic type).  '<literal>r</literal>' is the same as
 838     '<literal>@r</literal>' (ie: take a <link linkend='GVariant'><type>GVariant</type></link> of any tuple type).
 839    </para>
 840    <para>
 841     Upon encountering a '<literal>@</literal>' in front of a type string,
 842     <link linkend='g-variant-get'><function>g_variant_get()</function></link>
 843     takes a pointer to a <code>(<link linkend='GVariant'>GVariant</link> *)</code> (ie: a
 844     <code>(<link linkend='GVariant'>GVariant</link> **)</code>) and sets it to a new reference to a
 845     <link linkend='GVariant'><type>GVariant</type></link> containing the value (instead of deconstructing the value into
 846     C types in the usual way).  <link linkend='NULL:CAPS'><literal>NULL</literal></link> can be given to ignore the
 847     value.  '<literal>*</literal>', '<literal>?</literal>' and '<literal>r</literal>' are handled in a way analogous to
 848     what is stated above.
 849    </para>
 850    <para>
 851     You can always use '<literal>*</literal>' as an alternative to '<literal>?</literal>', '<literal>r</literal>' or any
 852     use of '<literal>@</literal>'.  Using the other characters where possible is recommended, however, due to the
 853     improvements in type safety and code self-documentation.
 854    </para>
 855
 856    <refsect3>
 857     <title>Examples</title>
 858     <informalexample><programlisting>
 859 <![CDATA[GVariant *value1, *value2;
 860
 861 value1 = g_variant_new ("(i@ii)", 44, g_variant_new_int32 (55), 66);
 862
 863 /* note: consumes floating reference count on 'value1' */
 864 value2 = g_variant_new ("(@(iii)*)", value1, g_variant_new_string ("foo"));
 865
 866 {
 867   const gchar *string;
 868   GVariant *tmp;
 869   gsize length;
 870   gint x, y, z;
 871
 872   g_variant_get (value2, "((iii)*)", &x, &y, &z, &tmp);
 873   string = g_variant_get_string (tmp, &length);
 874   g_print ("it is %d %d %d %s (length=%d)\n", x, y, z, string, (int) length);
 875   g_variant_unref (tmp);
 876
 877   /* quick way to skip all the values in a tuple */
 878   g_variant_get (value2, "(rs)", NULL, &string); /* or "(@(iii)s)" */
 879   g_print ("i only got the string: %s\n", string);
 880   g_free (string);
 881 }]]></programlisting></informalexample>
 882    </refsect3>
 883   </refsect2>
 884
 885   <refsect2 id='gvariant-format-strings-dictionaries'>
 886    <title>Dictionaries</title>
 887    <para>
 888     <emphasis role='strong'>
 889      Characters: <code>{}</code>
 890     </emphasis>
 891    </para>
 892
 893    <para>
 894     Dictionary entries are handled by handling first the key, then the value.  Each is handled in the usual way.
 895    </para>
 896
 897    <refsect3>
 898     <title>Examples</title>
 899     <informalexample><programlisting>
 900 <![CDATA[GVariantBuilder *b;
 901 GVariant *dict;
 902
 903 b = g_variant_builder_new (G_VARIANT_TYPE ("a{sv}"));
 904 g_variant_builder_add (b, "{sv}", "name", g_variant_new_string ("foo"));
 905 g_variant_builder_add (b, "{sv}", "timeout", g_variant_new_int32 (10));
 906 dict = g_variant_builder_end (b);]]></programlisting></informalexample>
 907    </refsect3>
 908
 909    <para>
 910     To extract data from nested dictionaries you can go through a vardict.
 911    </para>
 912
 913    <refsect3>
 914     <title>Examples</title>
 915     <informalexample><programlisting>
 916 <![CDATA[GVariant *data;
 917 gint value = 1;
 918 gint max = 3;
 919
 920 /* type (oa{sa{sv}) */
 921 data = g_variant_new_parsed ("(%o, {'brightness': {'value': <%i>, 'max': <%i>}})",
 922                              "/object/path", value, max);
 923 {
 924   GVariant *params;
 925   GVariant *p_brightness;
 926   gchar *obj
 927   gint p_max;
 928
 929   g_variant_get (data, "(o@a{?*})", &obj, &params);
 930   g_print ("object_path: %s\n", obj);
 931
 932   p_brightness = g_variant_lookup_value (params, "brightness", G_VARIANT_TYPE_VARDICT);
 933   g_variant_lookup (p_brightness, "max", "i", &p_max);
 934   g_print ("max: %d\n", p_max);
 935 }]]></programlisting></informalexample>
 936    </refsect3>
 937
 938   </refsect2>
 939
 940   <refsect2 id='gvariant-format-strings-pointers'>
 941    <title>Pointers</title>
 942    <para>
 943     <emphasis role='strong'>
 944      Characters: <code>&amp;</code>
 945     </emphasis>
 946    </para>
 947
 948    <para>
 949     The '<code>&amp;</code>' character is used to indicate that serialised data should be directly exchanged via a
 950     pointer.
 951    </para>
 952    <para>
 953     Currently, the only use for this character is when it is applied to a string (ie: '<literal>&amp;s</literal>',
 954     '<literal>&amp;o</literal>' or '<code>&amp;g</code>').  For
 955     <link linkend='g-variant-new'><function>g_variant_new()</function></link> this has absolutely no effect.  The string
 956     is collected and duplicated normally.  For <link linkend='g-variant-get'><function>g_variant_get()</function></link>
 957     it means that instead of creating a newly allocated copy of the string, a pointer to the serialised data is
 958     returned.  This pointer should not be freed.  Validity checks are performed to ensure that the string data will
 959     always be properly nul-terminated.
 960    </para>
 961
 962    <refsect3>
 963     <title>Examples</title>
 964     <informalexample><programlisting>
 965 <![CDATA[{
 966   const gchar *str;
 967   GVariant *value;
 968
 969   value = g_variant_new ("&s", "hello world");
 970   g_variant_get (value, "&s", &str);
 971   g_print ("string is: %s\n", str);
 972   /* no need to free str */
 973 }]]></programlisting></informalexample>
 974    </refsect3>
 975   </refsect2>
 976
 977   <refsect2 id='gvariant-format-strings-convenience'>
 978    <title>Convenience Conversions</title>
 979    <para>
 980     <emphasis role='strong'>
 981      Characters: <literal>^</literal>
 982     </emphasis>
 983    </para>
 984
 985    <para>
 986     The '<literal>^</literal>' character currently supports conversion to and from bytestrings or to and from arrays
 987     of strings or bytestrings.  It does not support byte arrays.  It has a number of forms.
 988    </para>
 989
 990    <para>
 991     In all forms, when used with <link linkend='g-variant-new'><function>g_variant_new()</function></link> one
 992     pointer value is collected from the variable arguments and passed to a function (as given in the table below).
 993     The result of that function is used as the value for this position.  When used with
 994     <link linkend='g-variant-get'><function>g_variant_get()</function></link> one pointer value is produced by using
 995     the function (given in the table) and returned by reference.
 996    </para>
 997
 998    <informaltable>
 999     <tgroup cols='2'>
1000      <colspec colname='col_0'/>
1001      <colspec colname='col_1'/>
1002      <colspec colname='col_2'/>
1003      <tbody>
1004
1005       <row rowsep='1'>
1006        <entry colsep='1' rowsep='1'>
1007         <para>
1008          <emphasis role='strong'>Conversion</emphasis>
1009         </para>
1010        </entry>
1011        <entry colsep='1' rowsep='1'>
1012         <para>
1013           <emphasis role='strong'>
1014             Used with <link linkend='g-variant-new'><function>g_variant_new()</function></link>
1015           </emphasis>
1016         </para>
1017        </entry>
1018        <entry colsep='1' rowsep='1'>
1019         <para>
1020           <emphasis role='strong'>
1021             Used with <link linkend='g-variant-get'><function>g_variant_get()</function></link>
1022           </emphasis>
1023         </para>
1024        </entry>
1025       </row>
1026
1027       <row rowsep='1'>
1028        <entry colsep='1' rowsep='1'>
1029         <para>
1030          <emphasis role='strong'>
1031           <literal>^as</literal>
1032          </emphasis>
1033         </para>
1034        </entry>
1035        <entry colsep='1' rowsep='1' morerows='1'>
1036         <para>
1037          equivalent to <link linkend='g-variant-new-strv'><function>g_variant_new_strv()</function></link>
1038         </para>
1039        </entry>
1040        <entry colsep='1' rowsep='1'>
1041         <para>
1042          equivalent to <link linkend='g-variant-dup-strv'><function>g_variant_dup_strv()</function></link>
1043         </para>
1044        </entry>
1045       </row>
1046
1047       <row rowsep='1'>
1048        <entry colsep='1' rowsep='1'>
1049         <para>
1050          <emphasis role='strong'>
1051           <literal>^a&amp;s</literal>
1052          </emphasis>
1053         </para>
1054        </entry>
1055        <entry colsep='1' rowsep='1'>
1056         <para>
1057          equivalent to <link linkend='g-variant-get-strv'><function>g_variant_get_strv()</function></link>
1058         </para>
1059        </entry>
1060       </row>
1061
1062       <row rowsep='1'>
1063        <entry colsep='1' rowsep='1'>
1064         <para>
1065          <emphasis role='strong'>
1066           <literal>^ao</literal>
1067          </emphasis>
1068         </para>
1069        </entry>
1070        <entry colsep='1' rowsep='1' morerows='1'>
1071         <para>
1072          equivalent to <link linkend='g-variant-new-objv'><function>g_variant_new_objv()</function></link>
1073         </para>
1074        </entry>
1075        <entry colsep='1' rowsep='1'>
1076         <para>
1077          equivalent to <link linkend='g-variant-dup-objv'><function>g_variant_dup_objv()</function></link>
1078         </para>
1079        </entry>
1080       </row>
1081
1082       <row rowsep='1'>
1083        <entry colsep='1' rowsep='1'>
1084         <para>
1085          <emphasis role='strong'>
1086           <literal>^a&amp;o</literal>
1087          </emphasis>
1088         </para>
1089        </entry>
1090        <entry colsep='1' rowsep='1'>
1091         <para>
1092          equivalent to <link linkend='g-variant-get-objv'><function>g_variant_get_objv()</function></link>
1093         </para>
1094        </entry>
1095       </row>
1096
1097       <row rowsep='1'>
1098        <entry colsep='1' rowsep='1'>
1099         <para>
1100          <emphasis role='strong'>
1101           <literal>^ay</literal>
1102          </emphasis>
1103         </para>
1104        </entry>
1105        <entry colsep='1' rowsep='1' morerows='1'>
1106         <para>
1107          equivalent to <link linkend='g-variant-new-bytestring'><function>g_variant_new_bytestring()</function></link>
1108         </para>
1109        </entry>
1110        <entry colsep='1' rowsep='1'>
1111         <para>
1112          equivalent to <link linkend='g-variant-dup-bytestring'><function>g_variant_dup_bytestring()</function></link>
1113         </para>
1114        </entry>
1115       </row>
1116
1117       <row rowsep='1'>
1118        <entry colsep='1' rowsep='1'>
1119         <para>
1120          <emphasis role='strong'>
1121           <literal>^&amp;ay</literal>
1122          </emphasis>
1123         </para>
1124        </entry>
1125        <entry colsep='1' rowsep='1'>
1126         <para>
1127          equivalent to <link linkend='g-variant-get-bytestring'><function>g_variant_get_bytestring()</function></link>
1128         </para>
1129        </entry>
1130       </row>
1131
1132       <row rowsep='1'>
1133        <entry colsep='1' rowsep='1'>
1134         <para>
1135          <emphasis role='strong'>
1136           <literal>^aay</literal>
1137          </emphasis>
1138         </para>
1139        </entry>
1140        <entry colsep='1' rowsep='1' morerows='1'>
1141         <para>
1142          equivalent to <link linkend='g-variant-new-bytestring-array'><function>g_variant_new_bytestring_array()</function></link>
1143         </para>
1144        </entry>
1145        <entry colsep='1' rowsep='1'>
1146         <para>
1147          equivalent to <link linkend='g-variant-dup-bytestring-array'><function>g_variant_dup_bytestring_array()</function></link>
1148         </para>
1149        </entry>
1150       </row>
1151
1152       <row rowsep='1'>
1153        <entry colsep='1' rowsep='1'>
1154         <para>
1155          <emphasis role='strong'>
1156           <literal>^a&amp;ay</literal>
1157          </emphasis>
1158         </para>
1159        </entry>
1160        <entry colsep='1' rowsep='1'>
1161         <para>
1162          equivalent to <link linkend='g-variant-get-bytestring-array'><function>g_variant_get_bytestring_array()</function></link>
1163         </para>
1164        </entry>
1165       </row>
1166
1167      </tbody>
1168     </tgroup>
1169    </informaltable>
1170   </refsect2>
1171  </refsect1>
1172 </refentry>