Blame glib/gvariant-serialiser.c

Packit ae235b
/*
Packit ae235b
 * Copyright © 2007, 2008 Ryan Lortie
Packit ae235b
 * Copyright © 2010 Codethink Limited
Packit ae235b
 *
Packit ae235b
 * This library is free software; you can redistribute it and/or
Packit ae235b
 * modify it under the terms of the GNU Lesser General Public
Packit ae235b
 * License as published by the Free Software Foundation; either
Packit ae235b
 * version 2.1 of the License, or (at your option) any later version.
Packit ae235b
 *
Packit ae235b
 * This library is distributed in the hope that it will be useful,
Packit ae235b
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
Packit ae235b
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
Packit ae235b
 * Lesser General Public License for more details.
Packit ae235b
 *
Packit ae235b
 * You should have received a copy of the GNU Lesser General Public
Packit ae235b
 * License along with this library; if not, see <http://www.gnu.org/licenses/>.
Packit ae235b
 *
Packit ae235b
 * Author: Ryan Lortie <desrt@desrt.ca>
Packit ae235b
 */
Packit ae235b
Packit ae235b
/* Prologue {{{1 */
Packit ae235b
#include "config.h"
Packit ae235b
Packit ae235b
#include "gvariant-serialiser.h"
Packit ae235b
Packit ae235b
#include <glib/gtestutils.h>
Packit ae235b
#include <glib/gstrfuncs.h>
Packit ae235b
#include <glib/gtypes.h>
Packit ae235b
Packit ae235b
#include <string.h>
Packit ae235b
Packit ae235b
Packit ae235b
/* GVariantSerialiser
Packit ae235b
 *
Packit ae235b
 * After this prologue section, this file has roughly 2 parts.
Packit ae235b
 *
Packit ae235b
 * The first part is split up into sections according to various
Packit ae235b
 * container types.  Maybe, Array, Tuple, Variant.  The Maybe and Array
Packit ae235b
 * sections are subdivided for element types being fixed or
Packit ae235b
 * variable-sized types.
Packit ae235b
 *
Packit ae235b
 * Each section documents the format of that particular type of
Packit ae235b
 * container and implements 5 functions for dealing with it:
Packit ae235b
 *
Packit ae235b
 *  n_children:
Packit ae235b
 *    - determines (according to serialised data) how many child values
Packit ae235b
 *      are inside a particular container value.
Packit ae235b
 *
Packit ae235b
 *  get_child:
Packit ae235b
 *    - gets the type of and the serialised data corresponding to a
Packit ae235b
 *      given child value within the container value.
Packit ae235b
 *
Packit ae235b
 *  needed_size:
Packit ae235b
 *    - determines how much space would be required to serialise a
Packit ae235b
 *      container of this type, containing the given children so that
Packit ae235b
 *      buffers can be preallocated before serialising.
Packit ae235b
 *
Packit ae235b
 *  serialise:
Packit ae235b
 *    - write the serialised data for a container of this type,
Packit ae235b
 *      containing the given children, to a buffer.
Packit ae235b
 *
Packit ae235b
 *  is_normal:
Packit ae235b
 *    - check the given data to ensure that it is in normal form.  For a
Packit ae235b
 *      given set of child values, there is exactly one normal form for
Packit ae235b
 *      the serialised data of a container.  Other forms are possible
Packit ae235b
 *      while maintaining the same children (for example, by inserting
Packit ae235b
 *      something other than zero bytes as padding) but only one form is
Packit ae235b
 *      the normal form.
Packit ae235b
 *
Packit ae235b
 * The second part contains the main entry point for each of the above 5
Packit ae235b
 * functions and logic to dispatch it to the handler for the appropriate
Packit ae235b
 * container type code.
Packit ae235b
 *
Packit ae235b
 * The second part also contains a routine to byteswap serialised
Packit ae235b
 * values.  This code makes use of the n_children() and get_child()
Packit ae235b
 * functions above to do its work so no extra support is needed on a
Packit ae235b
 * per-container-type basis.
Packit ae235b
 *
Packit ae235b
 * There is also additional code for checking for normal form.  All
Packit ae235b
 * numeric types are always in normal form since the full range of
Packit ae235b
 * values is permitted (eg: 0 to 255 is a valid byte).  Special checks
Packit ae235b
 * need to be performed for booleans (only 0 or 1 allowed), strings
Packit ae235b
 * (properly nul-terminated) and object paths and signature strings
Packit ae235b
 * (meeting the D-Bus specification requirements).
Packit ae235b
 */
Packit ae235b
Packit ae235b
/* < private >
Packit ae235b
 * GVariantSerialised:
Packit ae235b
 * @type_info: the #GVariantTypeInfo of this value
Packit ae235b
 * @data: (nullable): the serialised data of this value, or %NULL
Packit ae235b
 * @size: the size of this value
Packit ae235b
 *
Packit ae235b
 * A structure representing a GVariant in serialised form.  This
Packit ae235b
 * structure is used with #GVariantSerialisedFiller functions and as the
Packit ae235b
 * primary interface to the serialiser.  See #GVariantSerialisedFiller
Packit ae235b
 * for a description of its use there.
Packit ae235b
 *
Packit ae235b
 * When used with the serialiser API functions, the following invariants
Packit ae235b
 * apply to all #GVariantTypeSerialised structures passed to and
Packit ae235b
 * returned from the serialiser.
Packit ae235b
 *
Packit ae235b
 * @type_info must be non-%NULL.
Packit ae235b
 *
Packit ae235b
 * @data must be properly aligned for the type described by @type_info.
Packit ae235b
 *
Packit ae235b
 * If @type_info describes a fixed-sized type then @size must always be
Packit ae235b
 * equal to the fixed size of that type.
Packit ae235b
 *
Packit ae235b
 * For fixed-sized types (and only fixed-sized types), @data may be
Packit ae235b
 * %NULL even if @size is non-zero.  This happens when a framing error
Packit ae235b
 * occurs while attempting to extract a fixed-sized value out of a
Packit ae235b
 * variable-sized container.  There is no data to return for the
Packit ae235b
 * fixed-sized type, yet @size must be non-zero.  The effect of this
Packit ae235b
 * combination should be as if @data were a pointer to an
Packit ae235b
 * appropriately-sized zero-filled region.
Packit ae235b
 */
Packit ae235b
Packit ae235b
/* < private >
Packit ae235b
 * g_variant_serialised_check:
Packit ae235b
 * @serialised: a #GVariantSerialised struct
Packit ae235b
 *
Packit ae235b
 * Checks @serialised for validity according to the invariants described
Packit ae235b
 * above.
Packit ae235b
 */
Packit ae235b
static void
Packit ae235b
g_variant_serialised_check (GVariantSerialised serialised)
Packit ae235b
{
Packit ae235b
  gsize fixed_size;
Packit ae235b
  guint alignment;
Packit ae235b
Packit ae235b
  g_assert (serialised.type_info != NULL);
Packit ae235b
  g_variant_type_info_query (serialised.type_info, &alignment, &fixed_size);
Packit ae235b
Packit ae235b
  if (fixed_size)
Packit ae235b
    g_assert_cmpint (serialised.size, ==, fixed_size);
Packit ae235b
  else
Packit ae235b
    g_assert (serialised.size == 0 || serialised.data != NULL);
Packit ae235b
Packit ae235b
  /* Depending on the native alignment requirements of the machine, the
Packit ae235b
   * compiler will insert either 3 or 7 padding bytes after the char.
Packit ae235b
   * This will result in the sizeof() the struct being 12 or 16.
Packit ae235b
   * Subtract 9 to get 3 or 7 which is a nice bitmask to apply to get
Packit ae235b
   * the alignment bits that we "care about" being zero: in the
Packit ae235b
   * 4-aligned case, we care about 2 bits, and in the 8-aligned case, we
Packit ae235b
   * care about 3 bits.
Packit ae235b
   */
Packit ae235b
  alignment &= sizeof (struct {
Packit ae235b
                         char a;
Packit ae235b
                         union {
Packit ae235b
                           guint64 x;
Packit ae235b
                           void *y;
Packit ae235b
                           gdouble z;
Packit ae235b
                         } b;
Packit ae235b
                       }
Packit ae235b
                      ) - 9;
Packit ae235b
Packit ae235b
  /* Some OSes (FreeBSD is a known example) have a malloc() that returns
Packit ae235b
   * unaligned memory if you request small sizes.  'malloc (1);', for
Packit ae235b
   * example, has been seen to return pointers aligned to 6 mod 16.
Packit ae235b
   *
Packit ae235b
   * Check if this is a small allocation and return without enforcing
Packit ae235b
   * the alignment assertion if this is the case.
Packit ae235b
   */
Packit ae235b
  if (serialised.size <= alignment)
Packit ae235b
    return;
Packit ae235b
Packit ae235b
  g_assert_cmpint (alignment & (gsize) serialised.data, ==, 0);
Packit ae235b
}
Packit ae235b
Packit ae235b
/* < private >
Packit ae235b
 * GVariantSerialisedFiller:
Packit ae235b
 * @serialised: a #GVariantSerialised instance to fill
Packit ae235b
 * @data: data from the children array
Packit ae235b
 *
Packit ae235b
 * This function is called back from g_variant_serialiser_needed_size()
Packit ae235b
 * and g_variant_serialiser_serialise().  It fills in missing details
Packit ae235b
 * from a partially-complete #GVariantSerialised.
Packit ae235b
 *
Packit ae235b
 * The @data parameter passed back to the function is one of the items
Packit ae235b
 * that was passed to the serialiser in the @children array.  It
Packit ae235b
 * represents a single child item of the container that is being
Packit ae235b
 * serialised.  The information filled in to @serialised is the
Packit ae235b
 * information for this child.
Packit ae235b
 *
Packit ae235b
 * If the @type_info field of @serialised is %NULL then the callback
Packit ae235b
 * function must set it to the type information corresponding to the
Packit ae235b
 * type of the child.  No reference should be added.  If it is non-%NULL
Packit ae235b
 * then the callback should assert that it is equal to the actual type
Packit ae235b
 * of the child.
Packit ae235b
 *
Packit ae235b
 * If the @size field is zero then the callback must fill it in with the
Packit ae235b
 * required amount of space to store the serialised form of the child.
Packit ae235b
 * If it is non-zero then the callback should assert that it is equal to
Packit ae235b
 * the needed size of the child.
Packit ae235b
 *
Packit ae235b
 * If @data is non-%NULL then it points to a space that is properly
Packit ae235b
 * aligned for and large enough to store the serialised data of the
Packit ae235b
 * child.  The callback must store the serialised form of the child at
Packit ae235b
 * @data.
Packit ae235b
 *
Packit ae235b
 * If the child value is another container then the callback will likely
Packit ae235b
 * recurse back into the serialiser by calling
Packit ae235b
 * g_variant_serialiser_needed_size() to determine @size and
Packit ae235b
 * g_variant_serialiser_serialise() to write to @data.
Packit ae235b
 */
Packit ae235b
Packit ae235b
/* PART 1: Container types {{{1
Packit ae235b
 *
Packit ae235b
 * This section contains the serialiser implementation functions for
Packit ae235b
 * each container type.
Packit ae235b
 */
Packit ae235b
Packit ae235b
/* Maybe {{{2
Packit ae235b
 *
Packit ae235b
 * Maybe types are handled depending on if the element type of the maybe
Packit ae235b
 * type is a fixed-sized or variable-sized type.  Although all maybe
Packit ae235b
 * types themselves are variable-sized types, herein, a maybe value with
Packit ae235b
 * a fixed-sized element type is called a "fixed-sized maybe" for
Packit ae235b
 * convenience and a maybe value with a variable-sized element type is
Packit ae235b
 * called a "variable-sized maybe".
Packit ae235b
 */
Packit ae235b
Packit ae235b
/* Fixed-sized Maybe {{{3
Packit ae235b
 *
Packit ae235b
 * The size of a maybe value with a fixed-sized element type is either 0
Packit ae235b
 * or equal to the fixed size of its element type.  The case where the
Packit ae235b
 * size of the maybe value is zero corresponds to the "Nothing" case and
Packit ae235b
 * the case where the size of the maybe value is equal to the fixed size
Packit ae235b
 * of the element type corresponds to the "Just" case; in that case, the
Packit ae235b
 * serialised data of the child value forms the entire serialised data
Packit ae235b
 * of the maybe value.
Packit ae235b
 *
Packit ae235b
 * In the event that a fixed-sized maybe value is presented with a size
Packit ae235b
 * that is not equal to the fixed size of the element type then the
Packit ae235b
 * value must be taken to be "Nothing".
Packit ae235b
 */
Packit ae235b
Packit ae235b
static gsize
Packit ae235b
gvs_fixed_sized_maybe_n_children (GVariantSerialised value)
Packit ae235b
{
Packit ae235b
  gsize element_fixed_size;
Packit ae235b
Packit ae235b
  g_variant_type_info_query_element (value.type_info, NULL,
Packit ae235b
                                     &element_fixed_size);
Packit ae235b
Packit ae235b
  return (element_fixed_size == value.size) ? 1 : 0;
Packit ae235b
}
Packit ae235b
Packit ae235b
static GVariantSerialised
Packit ae235b
gvs_fixed_sized_maybe_get_child (GVariantSerialised value,
Packit ae235b
                                 gsize              index_)
Packit ae235b
{
Packit ae235b
  /* the child has the same bounds as the
Packit ae235b
   * container, so just update the type.
Packit ae235b
   */
Packit ae235b
  value.type_info = g_variant_type_info_element (value.type_info);
Packit ae235b
  g_variant_type_info_ref (value.type_info);
Packit ae235b
Packit ae235b
  return value;
Packit ae235b
}
Packit ae235b
Packit ae235b
static gsize
Packit ae235b
gvs_fixed_sized_maybe_needed_size (GVariantTypeInfo         *type_info,
Packit ae235b
                                   GVariantSerialisedFiller  gvs_filler,
Packit ae235b
                                   const gpointer           *children,
Packit ae235b
                                   gsize                     n_children)
Packit ae235b
{
Packit ae235b
  if (n_children)
Packit ae235b
    {
Packit ae235b
      gsize element_fixed_size;
Packit ae235b
Packit ae235b
      g_variant_type_info_query_element (type_info, NULL,
Packit ae235b
                                         &element_fixed_size);
Packit ae235b
Packit ae235b
      return element_fixed_size;
Packit ae235b
    }
Packit ae235b
  else
Packit ae235b
    return 0;
Packit ae235b
}
Packit ae235b
Packit ae235b
static void
Packit ae235b
gvs_fixed_sized_maybe_serialise (GVariantSerialised        value,
Packit ae235b
                                 GVariantSerialisedFiller  gvs_filler,
Packit ae235b
                                 const gpointer           *children,
Packit ae235b
                                 gsize                     n_children)
Packit ae235b
{
Packit ae235b
  if (n_children)
Packit ae235b
    {
Packit ae235b
      GVariantSerialised child = { NULL, value.data, value.size };
Packit ae235b
Packit ae235b
      gvs_filler (&child, children[0]);
Packit ae235b
    }
Packit ae235b
}
Packit ae235b
Packit ae235b
static gboolean
Packit ae235b
gvs_fixed_sized_maybe_is_normal (GVariantSerialised value)
Packit ae235b
{
Packit ae235b
  if (value.size > 0)
Packit ae235b
    {
Packit ae235b
      gsize element_fixed_size;
Packit ae235b
Packit ae235b
      g_variant_type_info_query_element (value.type_info,
Packit ae235b
                                         NULL, &element_fixed_size);
Packit ae235b
Packit ae235b
      if (value.size != element_fixed_size)
Packit ae235b
        return FALSE;
Packit ae235b
Packit ae235b
      /* proper element size: "Just".  recurse to the child. */
Packit ae235b
      value.type_info = g_variant_type_info_element (value.type_info);
Packit ae235b
Packit ae235b
      return g_variant_serialised_is_normal (value);
Packit ae235b
    }
Packit ae235b
Packit ae235b
  /* size of 0: "Nothing" */
Packit ae235b
  return TRUE;
Packit ae235b
}
Packit ae235b
Packit ae235b
/* Variable-sized Maybe
Packit ae235b
 *
Packit ae235b
 * The size of a maybe value with a variable-sized element type is
Packit ae235b
 * either 0 or strictly greater than 0.  The case where the size of the
Packit ae235b
 * maybe value is zero corresponds to the "Nothing" case and the case
Packit ae235b
 * where the size of the maybe value is greater than zero corresponds to
Packit ae235b
 * the "Just" case; in that case, the serialised data of the child value
Packit ae235b
 * forms the first part of the serialised data of the maybe value and is
Packit ae235b
 * followed by a single zero byte.  This zero byte is always appended,
Packit ae235b
 * regardless of any zero bytes that may already be at the end of the
Packit ae235b
 * serialised ata of the child value.
Packit ae235b
 */
Packit ae235b
Packit ae235b
static gsize
Packit ae235b
gvs_variable_sized_maybe_n_children (GVariantSerialised value)
Packit ae235b
{
Packit ae235b
  return (value.size > 0) ? 1 : 0;
Packit ae235b
}
Packit ae235b
Packit ae235b
static GVariantSerialised
Packit ae235b
gvs_variable_sized_maybe_get_child (GVariantSerialised value,
Packit ae235b
                                    gsize              index_)
Packit ae235b
{
Packit ae235b
  /* remove the padding byte and update the type. */
Packit ae235b
  value.type_info = g_variant_type_info_element (value.type_info);
Packit ae235b
  g_variant_type_info_ref (value.type_info);
Packit ae235b
  value.size--;
Packit ae235b
Packit ae235b
  /* if it's zero-sized then it may as well be NULL */
Packit ae235b
  if (value.size == 0)
Packit ae235b
    value.data = NULL;
Packit ae235b
Packit ae235b
  return value;
Packit ae235b
}
Packit ae235b
Packit ae235b
static gsize
Packit ae235b
gvs_variable_sized_maybe_needed_size (GVariantTypeInfo         *type_info,
Packit ae235b
                                      GVariantSerialisedFiller  gvs_filler,
Packit ae235b
                                      const gpointer           *children,
Packit ae235b
                                      gsize                     n_children)
Packit ae235b
{
Packit ae235b
  if (n_children)
Packit ae235b
    {
Packit ae235b
      GVariantSerialised child = { 0, };
Packit ae235b
Packit ae235b
      gvs_filler (&child, children[0]);
Packit ae235b
Packit ae235b
      return child.size + 1;
Packit ae235b
    }
Packit ae235b
  else
Packit ae235b
    return 0;
Packit ae235b
}
Packit ae235b
Packit ae235b
static void
Packit ae235b
gvs_variable_sized_maybe_serialise (GVariantSerialised        value,
Packit ae235b
                                    GVariantSerialisedFiller  gvs_filler,
Packit ae235b
                                    const gpointer           *children,
Packit ae235b
                                    gsize                     n_children)
Packit ae235b
{
Packit ae235b
  if (n_children)
Packit ae235b
    {
Packit ae235b
      GVariantSerialised child = { NULL, value.data, value.size - 1 };
Packit ae235b
Packit ae235b
      /* write the data for the child.  */
Packit ae235b
      gvs_filler (&child, children[0]);
Packit ae235b
      value.data[child.size] = '\0';
Packit ae235b
    }
Packit ae235b
}
Packit ae235b
Packit ae235b
static gboolean
Packit ae235b
gvs_variable_sized_maybe_is_normal (GVariantSerialised value)
Packit ae235b
{
Packit ae235b
  if (value.size == 0)
Packit ae235b
    return TRUE;
Packit ae235b
Packit ae235b
  if (value.data[value.size - 1] != '\0')
Packit ae235b
    return FALSE;
Packit ae235b
Packit ae235b
  value.type_info = g_variant_type_info_element (value.type_info);
Packit ae235b
  value.size--;
Packit ae235b
Packit ae235b
  return g_variant_serialised_is_normal (value);
Packit ae235b
}
Packit ae235b
Packit ae235b
/* Arrays {{{2
Packit ae235b
 *
Packit ae235b
 * Just as with maybe types, array types are handled depending on if the
Packit ae235b
 * element type of the array type is a fixed-sized or variable-sized
Packit ae235b
 * type.  Similar to maybe types, for convenience, an array value with a
Packit ae235b
 * fixed-sized element type is called a "fixed-sized array" and an array
Packit ae235b
 * value with a variable-sized element type is called a "variable sized
Packit ae235b
 * array".
Packit ae235b
 */
Packit ae235b
Packit ae235b
/* Fixed-sized Array {{{3
Packit ae235b
 *
Packit ae235b
 * For fixed sized arrays, the serialised data is simply a concatenation
Packit ae235b
 * of the serialised data of each element, in order.  Since fixed-sized
Packit ae235b
 * values always have a fixed size that is a multiple of their alignment
Packit ae235b
 * requirement no extra padding is required.
Packit ae235b
 *
Packit ae235b
 * In the event that a fixed-sized array is presented with a size that
Packit ae235b
 * is not an integer multiple of the element size then the value of the
Packit ae235b
 * array must be taken as being empty.
Packit ae235b
 */
Packit ae235b
Packit ae235b
static gsize
Packit ae235b
gvs_fixed_sized_array_n_children (GVariantSerialised value)
Packit ae235b
{
Packit ae235b
  gsize element_fixed_size;
Packit ae235b
Packit ae235b
  g_variant_type_info_query_element (value.type_info, NULL,
Packit ae235b
                                     &element_fixed_size);
Packit ae235b
Packit ae235b
  if (value.size % element_fixed_size == 0)
Packit ae235b
    return value.size / element_fixed_size;
Packit ae235b
Packit ae235b
  return 0;
Packit ae235b
}
Packit ae235b
Packit ae235b
static GVariantSerialised
Packit ae235b
gvs_fixed_sized_array_get_child (GVariantSerialised value,
Packit ae235b
                                 gsize              index_)
Packit ae235b
{
Packit ae235b
  GVariantSerialised child = { 0, };
Packit ae235b
Packit ae235b
  child.type_info = g_variant_type_info_element (value.type_info);
Packit ae235b
  g_variant_type_info_query (child.type_info, NULL, &child.size);
Packit ae235b
  child.data = value.data + (child.size * index_);
Packit ae235b
  g_variant_type_info_ref (child.type_info);
Packit ae235b
Packit ae235b
  return child;
Packit ae235b
}
Packit ae235b
Packit ae235b
static gsize
Packit ae235b
gvs_fixed_sized_array_needed_size (GVariantTypeInfo         *type_info,
Packit ae235b
                                   GVariantSerialisedFiller  gvs_filler,
Packit ae235b
                                   const gpointer           *children,
Packit ae235b
                                   gsize                     n_children)
Packit ae235b
{
Packit ae235b
  gsize element_fixed_size;
Packit ae235b
Packit ae235b
  g_variant_type_info_query_element (type_info, NULL, &element_fixed_size);
Packit ae235b
Packit ae235b
  return element_fixed_size * n_children;
Packit ae235b
}
Packit ae235b
Packit ae235b
static void
Packit ae235b
gvs_fixed_sized_array_serialise (GVariantSerialised        value,
Packit ae235b
                                 GVariantSerialisedFiller  gvs_filler,
Packit ae235b
                                 const gpointer           *children,
Packit ae235b
                                 gsize                     n_children)
Packit ae235b
{
Packit ae235b
  GVariantSerialised child = { 0, };
Packit ae235b
  gsize i;
Packit ae235b
Packit ae235b
  child.type_info = g_variant_type_info_element (value.type_info);
Packit ae235b
  g_variant_type_info_query (child.type_info, NULL, &child.size);
Packit ae235b
  child.data = value.data;
Packit ae235b
Packit ae235b
  for (i = 0; i < n_children; i++)
Packit ae235b
    {
Packit ae235b
      gvs_filler (&child, children[i]);
Packit ae235b
      child.data += child.size;
Packit ae235b
    }
Packit ae235b
}
Packit ae235b
Packit ae235b
static gboolean
Packit ae235b
gvs_fixed_sized_array_is_normal (GVariantSerialised value)
Packit ae235b
{
Packit ae235b
  GVariantSerialised child = { 0, };
Packit ae235b
Packit ae235b
  child.type_info = g_variant_type_info_element (value.type_info);
Packit ae235b
  g_variant_type_info_query (child.type_info, NULL, &child.size);
Packit ae235b
Packit ae235b
  if (value.size % child.size != 0)
Packit ae235b
    return FALSE;
Packit ae235b
Packit ae235b
  for (child.data = value.data;
Packit ae235b
       child.data < value.data + value.size;
Packit ae235b
       child.data += child.size)
Packit ae235b
    {
Packit ae235b
      if (!g_variant_serialised_is_normal (child))
Packit ae235b
        return FALSE;
Packit ae235b
    }
Packit ae235b
Packit ae235b
  return TRUE;
Packit ae235b
}
Packit ae235b
Packit ae235b
/* Variable-sized Array {{{3
Packit ae235b
 *
Packit ae235b
 * Variable sized arrays, containing variable-sized elements, must be
Packit ae235b
 * able to determine the boundaries between the elements.  The items
Packit ae235b
 * cannot simply be concatenated.  Additionally, we are faced with the
Packit ae235b
 * fact that non-fixed-sized values do not necessarily have a size that
Packit ae235b
 * is a multiple of their alignment requirement, so we may need to
Packit ae235b
 * insert zero-filled padding.
Packit ae235b
 *
Packit ae235b
 * While it is possible to find the start of an item by starting from
Packit ae235b
 * the end of the item before it and padding for alignment, it is not
Packit ae235b
 * generally possible to do the reverse operation.  For this reason, we
Packit ae235b
 * record the end point of each element in the array.
Packit ae235b
 *
Packit ae235b
 * GVariant works in terms of "offsets".  An offset is a pointer to a
Packit ae235b
 * boundary between two bytes.  In 4 bytes of serialised data, there
Packit ae235b
 * would be 5 possible offsets: one at the start ('0'), one between each
Packit ae235b
 * pair of adjacent bytes ('1', '2', '3') and one at the end ('4').
Packit ae235b
 *
Packit ae235b
 * The numeric value of an offset is an unsigned integer given relative
Packit ae235b
 * to the start of the serialised data of the array.  Offsets are always
Packit ae235b
 * stored in little endian byte order and are always only as big as they
Packit ae235b
 * need to be.  For example, in 255 bytes of serialised data, there are
Packit ae235b
 * 256 offsets.  All possibilities can be stored in an 8 bit unsigned
Packit ae235b
 * integer.  In 256 bytes of serialised data, however, there are 257
Packit ae235b
 * possible offsets so 16 bit integers must be used.  The size of an
Packit ae235b
 * offset is always a power of 2.
Packit ae235b
 *
Packit ae235b
 * The offsets are stored at the end of the serialised data of the
Packit ae235b
 * array.  They are simply concatenated on without any particular
Packit ae235b
 * alignment.  The size of the offsets is included in the size of the
Packit ae235b
 * serialised data for purposes of determining the size of the offsets.
Packit ae235b
 * This presents a possibly ambiguity; in certain cases, a particular
Packit ae235b
 * value of array could have two different serialised forms.
Packit ae235b
 *
Packit ae235b
 * Imagine an array containing a single string of 253 bytes in length
Packit ae235b
 * (so, 254 bytes including the nul terminator).  Now the offset must be
Packit ae235b
 * written.  If an 8 bit offset is written, it will bring the size of
Packit ae235b
 * the array's serialised data to 255 -- which means that the use of an
Packit ae235b
 * 8 bit offset was valid.  If a 16 bit offset is used then the total
Packit ae235b
 * size of the array will be 256 -- which means that the use of a 16 bit
Packit ae235b
 * offset was valid.  Although both of these will be accepted by the
Packit ae235b
 * deserialiser, only the smaller of the two is considered to be in
Packit ae235b
 * normal form and that is the one that the serialiser must produce.
Packit ae235b
 */
Packit ae235b
Packit ae235b
/* bytes may be NULL if (size == 0). */
Packit ae235b
static inline gsize
Packit ae235b
gvs_read_unaligned_le (guchar *bytes,
Packit ae235b
                       guint   size)
Packit ae235b
{
Packit ae235b
  union
Packit ae235b
  {
Packit ae235b
    guchar bytes[GLIB_SIZEOF_SIZE_T];
Packit ae235b
    gsize integer;
Packit ae235b
  } tmpvalue;
Packit ae235b
Packit ae235b
  tmpvalue.integer = 0;
Packit ae235b
  if (bytes != NULL)
Packit ae235b
    memcpy (&tmpvalue.bytes, bytes, size);
Packit ae235b
Packit ae235b
  return GSIZE_FROM_LE (tmpvalue.integer);
Packit ae235b
}
Packit ae235b
Packit ae235b
static inline void
Packit ae235b
gvs_write_unaligned_le (guchar *bytes,
Packit ae235b
                        gsize   value,
Packit ae235b
                        guint   size)
Packit ae235b
{
Packit ae235b
  union
Packit ae235b
  {
Packit ae235b
    guchar bytes[GLIB_SIZEOF_SIZE_T];
Packit ae235b
    gsize integer;
Packit ae235b
  } tmpvalue;
Packit ae235b
Packit ae235b
  tmpvalue.integer = GSIZE_TO_LE (value);
Packit ae235b
  memcpy (bytes, &tmpvalue.bytes, size);
Packit ae235b
}
Packit ae235b
Packit ae235b
static guint
Packit ae235b
gvs_get_offset_size (gsize size)
Packit ae235b
{
Packit ae235b
  if (size > G_MAXUINT32)
Packit ae235b
    return 8;
Packit ae235b
Packit ae235b
  else if (size > G_MAXUINT16)
Packit ae235b
    return 4;
Packit ae235b
Packit ae235b
  else if (size > G_MAXUINT8)
Packit ae235b
    return 2;
Packit ae235b
Packit ae235b
  else if (size > 0)
Packit ae235b
    return 1;
Packit ae235b
Packit ae235b
  return 0;
Packit ae235b
}
Packit ae235b
Packit ae235b
static gsize
Packit ae235b
gvs_calculate_total_size (gsize body_size,
Packit ae235b
                          gsize offsets)
Packit ae235b
{
Packit ae235b
  if (body_size + 1 * offsets <= G_MAXUINT8)
Packit ae235b
    return body_size + 1 * offsets;
Packit ae235b
Packit ae235b
  if (body_size + 2 * offsets <= G_MAXUINT16)
Packit ae235b
    return body_size + 2 * offsets;
Packit ae235b
Packit ae235b
  if (body_size + 4 * offsets <= G_MAXUINT32)
Packit ae235b
    return body_size + 4 * offsets;
Packit ae235b
Packit ae235b
  return body_size + 8 * offsets;
Packit ae235b
}
Packit ae235b
Packit ae235b
static gsize
Packit ae235b
gvs_variable_sized_array_n_children (GVariantSerialised value)
Packit ae235b
{
Packit ae235b
  gsize offsets_array_size;
Packit ae235b
  gsize offset_size;
Packit ae235b
  gsize last_end;
Packit ae235b
Packit ae235b
  if (value.size == 0)
Packit ae235b
    return 0;
Packit ae235b
Packit ae235b
  offset_size = gvs_get_offset_size (value.size);
Packit ae235b
Packit ae235b
  last_end = gvs_read_unaligned_le (value.data + value.size -
Packit ae235b
                                    offset_size, offset_size);
Packit ae235b
Packit ae235b
  if (last_end > value.size)
Packit ae235b
    return 0;
Packit ae235b
Packit ae235b
  offsets_array_size = value.size - last_end;
Packit ae235b
Packit ae235b
  if (offsets_array_size % offset_size)
Packit ae235b
    return 0;
Packit ae235b
Packit ae235b
  return offsets_array_size / offset_size;
Packit ae235b
}
Packit ae235b
Packit ae235b
static GVariantSerialised
Packit ae235b
gvs_variable_sized_array_get_child (GVariantSerialised value,
Packit ae235b
                                    gsize              index_)
Packit ae235b
{
Packit ae235b
  GVariantSerialised child = { 0, };
Packit ae235b
  gsize offset_size;
Packit ae235b
  gsize last_end;
Packit ae235b
  gsize start;
Packit ae235b
  gsize end;
Packit ae235b
Packit ae235b
  child.type_info = g_variant_type_info_element (value.type_info);
Packit ae235b
  g_variant_type_info_ref (child.type_info);
Packit ae235b
Packit ae235b
  offset_size = gvs_get_offset_size (value.size);
Packit ae235b
Packit ae235b
  last_end = gvs_read_unaligned_le (value.data + value.size -
Packit ae235b
                                    offset_size, offset_size);
Packit ae235b
Packit ae235b
  if (index_ > 0)
Packit ae235b
    {
Packit ae235b
      guint alignment;
Packit ae235b
Packit ae235b
      start = gvs_read_unaligned_le (value.data + last_end +
Packit ae235b
                                     (offset_size * (index_ - 1)),
Packit ae235b
                                     offset_size);
Packit ae235b
Packit ae235b
      g_variant_type_info_query (child.type_info, &alignment, NULL);
Packit ae235b
      start += (-start) & alignment;
Packit ae235b
    }
Packit ae235b
  else
Packit ae235b
    start = 0;
Packit ae235b
Packit ae235b
  end = gvs_read_unaligned_le (value.data + last_end +
Packit ae235b
                               (offset_size * index_),
Packit ae235b
                               offset_size);
Packit ae235b
Packit ae235b
  if (start < end && end <= value.size)
Packit ae235b
    {
Packit ae235b
      child.data = value.data + start;
Packit ae235b
      child.size = end - start;
Packit ae235b
    }
Packit ae235b
Packit ae235b
  return child;
Packit ae235b
}
Packit ae235b
Packit ae235b
static gsize
Packit ae235b
gvs_variable_sized_array_needed_size (GVariantTypeInfo         *type_info,
Packit ae235b
                                      GVariantSerialisedFiller  gvs_filler,
Packit ae235b
                                      const gpointer           *children,
Packit ae235b
                                      gsize                     n_children)
Packit ae235b
{
Packit ae235b
  guint alignment;
Packit ae235b
  gsize offset;
Packit ae235b
  gsize i;
Packit ae235b
Packit ae235b
  g_variant_type_info_query (type_info, &alignment, NULL);
Packit ae235b
  offset = 0;
Packit ae235b
Packit ae235b
  for (i = 0; i < n_children; i++)
Packit ae235b
    {
Packit ae235b
      GVariantSerialised child = { 0, };
Packit ae235b
Packit ae235b
      offset += (-offset) & alignment;
Packit ae235b
      gvs_filler (&child, children[i]);
Packit ae235b
      offset += child.size;
Packit ae235b
    }
Packit ae235b
Packit ae235b
  return gvs_calculate_total_size (offset, n_children);
Packit ae235b
}
Packit ae235b
Packit ae235b
static void
Packit ae235b
gvs_variable_sized_array_serialise (GVariantSerialised        value,
Packit ae235b
                                    GVariantSerialisedFiller  gvs_filler,
Packit ae235b
                                    const gpointer           *children,
Packit ae235b
                                    gsize                     n_children)
Packit ae235b
{
Packit ae235b
  guchar *offset_ptr;
Packit ae235b
  gsize offset_size;
Packit ae235b
  guint alignment;
Packit ae235b
  gsize offset;
Packit ae235b
  gsize i;
Packit ae235b
Packit ae235b
  g_variant_type_info_query (value.type_info, &alignment, NULL);
Packit ae235b
  offset_size = gvs_get_offset_size (value.size);
Packit ae235b
  offset = 0;
Packit ae235b
Packit ae235b
  offset_ptr = value.data + value.size - offset_size * n_children;
Packit ae235b
Packit ae235b
  for (i = 0; i < n_children; i++)
Packit ae235b
    {
Packit ae235b
      GVariantSerialised child = { 0, };
Packit ae235b
Packit ae235b
      while (offset & alignment)
Packit ae235b
        value.data[offset++] = '\0';
Packit ae235b
Packit ae235b
      child.data = value.data + offset;
Packit ae235b
      gvs_filler (&child, children[i]);
Packit ae235b
      offset += child.size;
Packit ae235b
Packit ae235b
      gvs_write_unaligned_le (offset_ptr, offset, offset_size);
Packit ae235b
      offset_ptr += offset_size;
Packit ae235b
    }
Packit ae235b
}
Packit ae235b
Packit ae235b
static gboolean
Packit ae235b
gvs_variable_sized_array_is_normal (GVariantSerialised value)
Packit ae235b
{
Packit ae235b
  GVariantSerialised child = { 0, };
Packit ae235b
  gsize offsets_array_size;
Packit ae235b
  guchar *offsets_array;
Packit ae235b
  guint offset_size;
Packit ae235b
  guint alignment;
Packit ae235b
  gsize last_end;
Packit ae235b
  gsize length;
Packit ae235b
  gsize offset;
Packit ae235b
  gsize i;
Packit ae235b
Packit ae235b
  if (value.size == 0)
Packit ae235b
    return TRUE;
Packit ae235b
Packit ae235b
  offset_size = gvs_get_offset_size (value.size);
Packit ae235b
  last_end = gvs_read_unaligned_le (value.data + value.size -
Packit ae235b
                                    offset_size, offset_size);
Packit ae235b
Packit ae235b
  if (last_end > value.size)
Packit ae235b
    return FALSE;
Packit ae235b
Packit ae235b
  offsets_array_size = value.size - last_end;
Packit ae235b
Packit ae235b
  if (offsets_array_size % offset_size)
Packit ae235b
    return FALSE;
Packit ae235b
Packit ae235b
  offsets_array = value.data + value.size - offsets_array_size;
Packit ae235b
  length = offsets_array_size / offset_size;
Packit ae235b
Packit ae235b
  if (length == 0)
Packit ae235b
    return FALSE;
Packit ae235b
Packit ae235b
  child.type_info = g_variant_type_info_element (value.type_info);
Packit ae235b
  g_variant_type_info_query (child.type_info, &alignment, NULL);
Packit ae235b
  offset = 0;
Packit ae235b
Packit ae235b
  for (i = 0; i < length; i++)
Packit ae235b
    {
Packit ae235b
      gsize this_end;
Packit ae235b
Packit ae235b
      this_end = gvs_read_unaligned_le (offsets_array + offset_size * i,
Packit ae235b
                                        offset_size);
Packit ae235b
Packit ae235b
      if (this_end < offset || this_end > last_end)
Packit ae235b
        return FALSE;
Packit ae235b
Packit ae235b
      while (offset & alignment)
Packit ae235b
        {
Packit ae235b
          if (!(offset < this_end && value.data[offset] == '\0'))
Packit ae235b
            return FALSE;
Packit ae235b
          offset++;
Packit ae235b
        }
Packit ae235b
Packit ae235b
      child.data = value.data + offset;
Packit ae235b
      child.size = this_end - offset;
Packit ae235b
Packit ae235b
      if (child.size == 0)
Packit ae235b
        child.data = NULL;
Packit ae235b
Packit ae235b
      if (!g_variant_serialised_is_normal (child))
Packit ae235b
        return FALSE;
Packit ae235b
Packit ae235b
      offset = this_end;
Packit ae235b
    }
Packit ae235b
Packit ae235b
  g_assert (offset == last_end);
Packit ae235b
Packit ae235b
  return TRUE;
Packit ae235b
}
Packit ae235b
Packit ae235b
/* Tuples {{{2
Packit ae235b
 *
Packit ae235b
 * Since tuples can contain a mix of variable- and fixed-sized items,
Packit ae235b
 * they are, in terms of serialisation, a hybrid of variable-sized and
Packit ae235b
 * fixed-sized arrays.
Packit ae235b
 *
Packit ae235b
 * Offsets are only stored for variable-sized items.  Also, since the
Packit ae235b
 * number of items in a tuple is known from its type, we are able to
Packit ae235b
 * know exactly how many offsets to expect in the serialised data (and
Packit ae235b
 * therefore how much space is taken up by the offset array).  This
Packit ae235b
 * means that we know where the end of the serialised data for the last
Packit ae235b
 * item is -- we can just subtract the size of the offset array from the
Packit ae235b
 * total size of the tuple.  For this reason, the last item in the tuple
Packit ae235b
 * doesn't need an offset stored.
Packit ae235b
 *
Packit ae235b
 * Tuple offsets are stored in reverse.  This design choice allows
Packit ae235b
 * iterator-based deserialisers to be more efficient.
Packit ae235b
 *
Packit ae235b
 * Most of the "heavy lifting" here is handled by the GVariantTypeInfo
Packit ae235b
 * for the tuple.  See the notes in gvarianttypeinfo.h.
Packit ae235b
 */
Packit ae235b
Packit ae235b
static gsize
Packit ae235b
gvs_tuple_n_children (GVariantSerialised value)
Packit ae235b
{
Packit ae235b
  return g_variant_type_info_n_members (value.type_info);
Packit ae235b
}
Packit ae235b
Packit ae235b
static GVariantSerialised
Packit ae235b
gvs_tuple_get_child (GVariantSerialised value,
Packit ae235b
                     gsize              index_)
Packit ae235b
{
Packit ae235b
  const GVariantMemberInfo *member_info;
Packit ae235b
  GVariantSerialised child = { 0, };
Packit ae235b
  gsize offset_size;
Packit ae235b
  gsize start, end;
Packit ae235b
Packit ae235b
  member_info = g_variant_type_info_member_info (value.type_info, index_);
Packit ae235b
  child.type_info = g_variant_type_info_ref (member_info->type_info);
Packit ae235b
  offset_size = gvs_get_offset_size (value.size);
Packit ae235b
Packit ae235b
  /* tuples are the only (potentially) fixed-sized containers, so the
Packit ae235b
   * only ones that have to deal with the possibility of having %NULL
Packit ae235b
   * data with a non-zero %size if errors occurred elsewhere.
Packit ae235b
   */
Packit ae235b
  if G_UNLIKELY (value.data == NULL && value.size != 0)
Packit ae235b
    {
Packit ae235b
      g_variant_type_info_query (child.type_info, NULL, &child.size);
Packit ae235b
Packit ae235b
      /* this can only happen in fixed-sized tuples,
Packit ae235b
       * so the child must also be fixed sized.
Packit ae235b
       */
Packit ae235b
      g_assert (child.size != 0);
Packit ae235b
      child.data = NULL;
Packit ae235b
Packit ae235b
      return child;
Packit ae235b
    }
Packit ae235b
Packit ae235b
  if (member_info->ending_type == G_VARIANT_MEMBER_ENDING_OFFSET)
Packit ae235b
    {
Packit ae235b
      if (offset_size * (member_info->i + 2) > value.size)
Packit ae235b
        return child;
Packit ae235b
    }
Packit ae235b
  else
Packit ae235b
    {
Packit ae235b
      if (offset_size * (member_info->i + 1) > value.size)
Packit ae235b
        {
Packit ae235b
          /* if the child is fixed size, return its size.
Packit ae235b
           * if child is not fixed-sized, return size = 0.
Packit ae235b
           */
Packit ae235b
          g_variant_type_info_query (child.type_info, NULL, &child.size);
Packit ae235b
Packit ae235b
          return child;
Packit ae235b
        }
Packit ae235b
    }
Packit ae235b
Packit ae235b
  if (member_info->i + 1)
Packit ae235b
    start = gvs_read_unaligned_le (value.data + value.size -
Packit ae235b
                                   offset_size * (member_info->i + 1),
Packit ae235b
                                   offset_size);
Packit ae235b
  else
Packit ae235b
    start = 0;
Packit ae235b
Packit ae235b
  start += member_info->a;
Packit ae235b
  start &= member_info->b;
Packit ae235b
  start |= member_info->c;
Packit ae235b
Packit ae235b
  if (member_info->ending_type == G_VARIANT_MEMBER_ENDING_LAST)
Packit ae235b
    end = value.size - offset_size * (member_info->i + 1);
Packit ae235b
Packit ae235b
  else if (member_info->ending_type == G_VARIANT_MEMBER_ENDING_FIXED)
Packit ae235b
    {
Packit ae235b
      gsize fixed_size;
Packit ae235b
Packit ae235b
      g_variant_type_info_query (child.type_info, NULL, &fixed_size);
Packit ae235b
      end = start + fixed_size;
Packit ae235b
      child.size = fixed_size;
Packit ae235b
    }
Packit ae235b
Packit ae235b
  else /* G_VARIANT_MEMBER_ENDING_OFFSET */
Packit ae235b
    end = gvs_read_unaligned_le (value.data + value.size -
Packit ae235b
                                 offset_size * (member_info->i + 2),
Packit ae235b
                                 offset_size);
Packit ae235b
Packit ae235b
  if (start < end && end <= value.size)
Packit ae235b
    {
Packit ae235b
      child.data = value.data + start;
Packit ae235b
      child.size = end - start;
Packit ae235b
    }
Packit ae235b
Packit ae235b
  return child;
Packit ae235b
}
Packit ae235b
Packit ae235b
static gsize
Packit ae235b
gvs_tuple_needed_size (GVariantTypeInfo         *type_info,
Packit ae235b
                       GVariantSerialisedFiller  gvs_filler,
Packit ae235b
                       const gpointer           *children,
Packit ae235b
                       gsize                     n_children)
Packit ae235b
{
Packit ae235b
  const GVariantMemberInfo *member_info = NULL;
Packit ae235b
  gsize fixed_size;
Packit ae235b
  gsize offset;
Packit ae235b
  gsize i;
Packit ae235b
Packit ae235b
  g_variant_type_info_query (type_info, NULL, &fixed_size);
Packit ae235b
Packit ae235b
  if (fixed_size)
Packit ae235b
    return fixed_size;
Packit ae235b
Packit ae235b
  offset = 0;
Packit ae235b
Packit ae235b
  for (i = 0; i < n_children; i++)
Packit ae235b
    {
Packit ae235b
      guint alignment;
Packit ae235b
Packit ae235b
      member_info = g_variant_type_info_member_info (type_info, i);
Packit ae235b
      g_variant_type_info_query (member_info->type_info,
Packit ae235b
                                 &alignment, &fixed_size);
Packit ae235b
      offset += (-offset) & alignment;
Packit ae235b
Packit ae235b
      if (fixed_size)
Packit ae235b
        offset += fixed_size;
Packit ae235b
      else
Packit ae235b
        {
Packit ae235b
          GVariantSerialised child = { 0, };
Packit ae235b
Packit ae235b
          gvs_filler (&child, children[i]);
Packit ae235b
          offset += child.size;
Packit ae235b
        }
Packit ae235b
    }
Packit ae235b
Packit ae235b
  return gvs_calculate_total_size (offset, member_info->i + 1);
Packit ae235b
}
Packit ae235b
Packit ae235b
static void
Packit ae235b
gvs_tuple_serialise (GVariantSerialised        value,
Packit ae235b
                     GVariantSerialisedFiller  gvs_filler,
Packit ae235b
                     const gpointer           *children,
Packit ae235b
                     gsize                     n_children)
Packit ae235b
{
Packit ae235b
  gsize offset_size;
Packit ae235b
  gsize offset;
Packit ae235b
  gsize i;
Packit ae235b
Packit ae235b
  offset_size = gvs_get_offset_size (value.size);
Packit ae235b
  offset = 0;
Packit ae235b
Packit ae235b
  for (i = 0; i < n_children; i++)
Packit ae235b
    {
Packit ae235b
      const GVariantMemberInfo *member_info;
Packit ae235b
      GVariantSerialised child = { 0, };
Packit ae235b
      guint alignment;
Packit ae235b
Packit ae235b
      member_info = g_variant_type_info_member_info (value.type_info, i);
Packit ae235b
      g_variant_type_info_query (member_info->type_info, &alignment, NULL);
Packit ae235b
Packit ae235b
      while (offset & alignment)
Packit ae235b
        value.data[offset++] = '\0';
Packit ae235b
Packit ae235b
      child.data = value.data + offset;
Packit ae235b
      gvs_filler (&child, children[i]);
Packit ae235b
      offset += child.size;
Packit ae235b
Packit ae235b
      if (member_info->ending_type == G_VARIANT_MEMBER_ENDING_OFFSET)
Packit ae235b
        {
Packit ae235b
          value.size -= offset_size;
Packit ae235b
          gvs_write_unaligned_le (value.data + value.size,
Packit ae235b
                                  offset, offset_size);
Packit ae235b
        }
Packit ae235b
    }
Packit ae235b
Packit ae235b
  while (offset < value.size)
Packit ae235b
    value.data[offset++] = '\0';
Packit ae235b
}
Packit ae235b
Packit ae235b
static gboolean
Packit ae235b
gvs_tuple_is_normal (GVariantSerialised value)
Packit ae235b
{
Packit ae235b
  guint offset_size;
Packit ae235b
  gsize offset_ptr;
Packit ae235b
  gsize length;
Packit ae235b
  gsize offset;
Packit ae235b
  gsize i;
Packit ae235b
Packit ae235b
  /* as per the comment in gvs_tuple_get_child() */
Packit ae235b
  if G_UNLIKELY (value.data == NULL && value.size != 0)
Packit ae235b
    return FALSE;
Packit ae235b
Packit ae235b
  offset_size = gvs_get_offset_size (value.size);
Packit ae235b
  length = g_variant_type_info_n_members (value.type_info);
Packit ae235b
  offset_ptr = value.size;
Packit ae235b
  offset = 0;
Packit ae235b
Packit ae235b
  for (i = 0; i < length; i++)
Packit ae235b
    {
Packit ae235b
      const GVariantMemberInfo *member_info;
Packit ae235b
      GVariantSerialised child;
Packit ae235b
      gsize fixed_size;
Packit ae235b
      guint alignment;
Packit ae235b
      gsize end;
Packit ae235b
Packit ae235b
      member_info = g_variant_type_info_member_info (value.type_info, i);
Packit ae235b
      child.type_info = member_info->type_info;
Packit ae235b
Packit ae235b
      g_variant_type_info_query (child.type_info, &alignment, &fixed_size);
Packit ae235b
Packit ae235b
      while (offset & alignment)
Packit ae235b
        {
Packit ae235b
          if (offset > value.size || value.data[offset] != '\0')
Packit ae235b
            return FALSE;
Packit ae235b
          offset++;
Packit ae235b
        }
Packit ae235b
Packit ae235b
      child.data = value.data + offset;
Packit ae235b
Packit ae235b
      switch (member_info->ending_type)
Packit ae235b
        {
Packit ae235b
        case G_VARIANT_MEMBER_ENDING_FIXED:
Packit ae235b
          end = offset + fixed_size;
Packit ae235b
          break;
Packit ae235b
Packit ae235b
        case G_VARIANT_MEMBER_ENDING_LAST:
Packit ae235b
          end = offset_ptr;
Packit ae235b
          break;
Packit ae235b
Packit ae235b
        case G_VARIANT_MEMBER_ENDING_OFFSET:
Packit ae235b
          offset_ptr -= offset_size;
Packit ae235b
Packit ae235b
          if (offset_ptr < offset)
Packit ae235b
            return FALSE;
Packit ae235b
Packit ae235b
          end = gvs_read_unaligned_le (value.data + offset_ptr, offset_size);
Packit ae235b
          break;
Packit ae235b
Packit ae235b
        default:
Packit ae235b
          g_assert_not_reached ();
Packit ae235b
        }
Packit ae235b
Packit ae235b
      if (end < offset || end > offset_ptr)
Packit ae235b
        return FALSE;
Packit ae235b
Packit ae235b
      child.size = end - offset;
Packit ae235b
Packit ae235b
      if (child.size == 0)
Packit ae235b
        child.data = NULL;
Packit ae235b
Packit ae235b
      if (!g_variant_serialised_is_normal (child))
Packit ae235b
        return FALSE;
Packit ae235b
Packit ae235b
      offset = end;
Packit ae235b
    }
Packit ae235b
Packit ae235b
  {
Packit ae235b
    gsize fixed_size;
Packit ae235b
    guint alignment;
Packit ae235b
Packit ae235b
    g_variant_type_info_query (value.type_info, &alignment, &fixed_size);
Packit ae235b
Packit ae235b
    if (fixed_size)
Packit ae235b
      {
Packit ae235b
        g_assert (fixed_size == value.size);
Packit ae235b
        g_assert (offset_ptr == value.size);
Packit ae235b
Packit ae235b
        if (i == 0)
Packit ae235b
          {
Packit ae235b
            if (value.data[offset++] != '\0')
Packit ae235b
              return FALSE;
Packit ae235b
          }
Packit ae235b
        else
Packit ae235b
          {
Packit ae235b
            while (offset & alignment)
Packit ae235b
              if (value.data[offset++] != '\0')
Packit ae235b
                return FALSE;
Packit ae235b
          }
Packit ae235b
Packit ae235b
        g_assert (offset == value.size);
Packit ae235b
      }
Packit ae235b
  }
Packit ae235b
Packit ae235b
  return offset_ptr == offset;
Packit ae235b
}
Packit ae235b
Packit ae235b
/* Variants {{{2
Packit ae235b
 *
Packit ae235b
 * Variants are stored by storing the serialised data of the child,
Packit ae235b
 * followed by a '\0' character, followed by the type string of the
Packit ae235b
 * child.
Packit ae235b
 *
Packit ae235b
 * In the case that a value is presented that contains no '\0'
Packit ae235b
 * character, or doesn't have a single well-formed definite type string
Packit ae235b
 * following that character, the variant must be taken as containing the
Packit ae235b
 * unit tuple: ().
Packit ae235b
 */
Packit ae235b
Packit ae235b
static inline gsize
Packit ae235b
gvs_variant_n_children (GVariantSerialised value)
Packit ae235b
{
Packit ae235b
  return 1;
Packit ae235b
}
Packit ae235b
Packit ae235b
static inline GVariantSerialised
Packit ae235b
gvs_variant_get_child (GVariantSerialised value,
Packit ae235b
                       gsize              index_)
Packit ae235b
{
Packit ae235b
  GVariantSerialised child = { 0, };
Packit ae235b
Packit ae235b
  /* NOTE: not O(1) and impossible for it to be... */
Packit ae235b
  if (value.size)
Packit ae235b
    {
Packit ae235b
      /* find '\0' character */
Packit ae235b
      for (child.size = value.size - 1; child.size; child.size--)
Packit ae235b
        if (value.data[child.size] == '\0')
Packit ae235b
          break;
Packit ae235b
Packit ae235b
      /* ensure we didn't just hit the start of the string */
Packit ae235b
      if (value.data[child.size] == '\0')
Packit ae235b
        {
Packit ae235b
          const gchar *type_string = (gchar *) &value.data[child.size + 1];
Packit ae235b
          const gchar *limit = (gchar *) &value.data[value.size];
Packit ae235b
          const gchar *end;
Packit ae235b
Packit ae235b
          if (g_variant_type_string_scan (type_string, limit, &end) &&
Packit ae235b
              end == limit)
Packit ae235b
            {
Packit ae235b
              const GVariantType *type = (GVariantType *) type_string;
Packit ae235b
Packit ae235b
              if (g_variant_type_is_definite (type))
Packit ae235b
                {
Packit ae235b
                  gsize fixed_size;
Packit ae235b
Packit ae235b
                  child.type_info = g_variant_type_info_get (type);
Packit ae235b
Packit ae235b
                  if (child.size != 0)
Packit ae235b
                    /* only set to non-%NULL if size > 0 */
Packit ae235b
                    child.data = value.data;
Packit ae235b
Packit ae235b
                  g_variant_type_info_query (child.type_info,
Packit ae235b
                                             NULL, &fixed_size);
Packit ae235b
Packit ae235b
                  if (!fixed_size || fixed_size == child.size)
Packit ae235b
                    return child;
Packit ae235b
Packit ae235b
                  g_variant_type_info_unref (child.type_info);
Packit ae235b
                }
Packit ae235b
            }
Packit ae235b
        }
Packit ae235b
    }
Packit ae235b
Packit ae235b
  child.type_info = g_variant_type_info_get (G_VARIANT_TYPE_UNIT);
Packit ae235b
  child.data = NULL;
Packit ae235b
  child.size = 1;
Packit ae235b
Packit ae235b
  return child;
Packit ae235b
}
Packit ae235b
Packit ae235b
static inline gsize
Packit ae235b
gvs_variant_needed_size (GVariantTypeInfo         *type_info,
Packit ae235b
                         GVariantSerialisedFiller  gvs_filler,
Packit ae235b
                         const gpointer           *children,
Packit ae235b
                         gsize                     n_children)
Packit ae235b
{
Packit ae235b
  GVariantSerialised child = { 0, };
Packit ae235b
  const gchar *type_string;
Packit ae235b
Packit ae235b
  gvs_filler (&child, children[0]);
Packit ae235b
  type_string = g_variant_type_info_get_type_string (child.type_info);
Packit ae235b
Packit ae235b
  return child.size + 1 + strlen (type_string);
Packit ae235b
}
Packit ae235b
Packit ae235b
static inline void
Packit ae235b
gvs_variant_serialise (GVariantSerialised        value,
Packit ae235b
                       GVariantSerialisedFiller  gvs_filler,
Packit ae235b
                       const gpointer           *children,
Packit ae235b
                       gsize                     n_children)
Packit ae235b
{
Packit ae235b
  GVariantSerialised child = { 0, };
Packit ae235b
  const gchar *type_string;
Packit ae235b
Packit ae235b
  child.data = value.data;
Packit ae235b
Packit ae235b
  gvs_filler (&child, children[0]);
Packit ae235b
  type_string = g_variant_type_info_get_type_string (child.type_info);
Packit ae235b
  value.data[child.size] = '\0';
Packit ae235b
  memcpy (value.data + child.size + 1, type_string, strlen (type_string));
Packit ae235b
}
Packit ae235b
Packit ae235b
static inline gboolean
Packit ae235b
gvs_variant_is_normal (GVariantSerialised value)
Packit ae235b
{
Packit ae235b
  GVariantSerialised child;
Packit ae235b
  gboolean normal;
Packit ae235b
Packit ae235b
  child = gvs_variant_get_child (value, 0);
Packit ae235b
Packit ae235b
  normal = (child.data != NULL || child.size == 0) &&
Packit ae235b
           g_variant_serialised_is_normal (child);
Packit ae235b
Packit ae235b
  g_variant_type_info_unref (child.type_info);
Packit ae235b
Packit ae235b
  return normal;
Packit ae235b
}
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
/* PART 2: Serialiser API {{{1
Packit ae235b
 *
Packit ae235b
 * This is the implementation of the API of the serialiser as advertised
Packit ae235b
 * in gvariant-serialiser.h.
Packit ae235b
 */
Packit ae235b
Packit ae235b
/* Dispatch Utilities {{{2
Packit ae235b
 *
Packit ae235b
 * These macros allow a given function (for example,
Packit ae235b
 * g_variant_serialiser_serialise) to be dispatched to the appropriate
Packit ae235b
 * type-specific function above (fixed/variable-sized maybe,
Packit ae235b
 * fixed/variable-sized array, tuple or variant).
Packit ae235b
 */
Packit ae235b
#define DISPATCH_FIXED(type_info, before, after) \
Packit ae235b
  {                                                     \
Packit ae235b
    gsize fixed_size;                                   \
Packit ae235b
                                                        \
Packit ae235b
    g_variant_type_info_query_element (type_info, NULL, \
Packit ae235b
                                       &fixed_size);    \
Packit ae235b
                                                        \
Packit ae235b
    if (fixed_size)                                     \
Packit ae235b
      {                                                 \
Packit ae235b
        before ## fixed_sized ## after                  \
Packit ae235b
      }                                                 \
Packit ae235b
    else                                                \
Packit ae235b
      {                                                 \
Packit ae235b
        before ## variable_sized ## after               \
Packit ae235b
      }                                                 \
Packit ae235b
  }
Packit ae235b
Packit ae235b
#define DISPATCH_CASES(type_info, before, after) \
Packit ae235b
  switch (g_variant_type_info_get_type_char (type_info))        \
Packit ae235b
    {                                                           \
Packit ae235b
      case G_VARIANT_TYPE_INFO_CHAR_MAYBE:                      \
Packit ae235b
        DISPATCH_FIXED (type_info, before, _maybe ## after)     \
Packit ae235b
                                                                \
Packit ae235b
      case G_VARIANT_TYPE_INFO_CHAR_ARRAY:                      \
Packit ae235b
        DISPATCH_FIXED (type_info, before, _array ## after)     \
Packit ae235b
                                                                \
Packit ae235b
      case G_VARIANT_TYPE_INFO_CHAR_DICT_ENTRY:                 \
Packit ae235b
      case G_VARIANT_TYPE_INFO_CHAR_TUPLE:                      \
Packit ae235b
        {                                                       \
Packit ae235b
          before ## tuple ## after                              \
Packit ae235b
        }                                                       \
Packit ae235b
                                                                \
Packit ae235b
      case G_VARIANT_TYPE_INFO_CHAR_VARIANT:                    \
Packit ae235b
        {                                                       \
Packit ae235b
          before ## variant ## after                            \
Packit ae235b
        }                                                       \
Packit ae235b
    }
Packit ae235b
Packit ae235b
/* Serialiser entry points {{{2
Packit ae235b
 *
Packit ae235b
 * These are the functions that are called in order for the serialiser
Packit ae235b
 * to do its thing.
Packit ae235b
 */
Packit ae235b
Packit ae235b
/* < private >
Packit ae235b
 * g_variant_serialised_n_children:
Packit ae235b
 * @serialised: a #GVariantSerialised
Packit ae235b
 *
Packit ae235b
 * For serialised data that represents a container value (maybes,
Packit ae235b
 * tuples, arrays, variants), determine how many child items are inside
Packit ae235b
 * that container.
Packit ae235b
 *
Packit ae235b
 * Returns: the number of children
Packit ae235b
 */
Packit ae235b
gsize
Packit ae235b
g_variant_serialised_n_children (GVariantSerialised serialised)
Packit ae235b
{
Packit ae235b
  g_variant_serialised_check (serialised);
Packit ae235b
Packit ae235b
  DISPATCH_CASES (serialised.type_info,
Packit ae235b
Packit ae235b
                  return gvs_/**/,/**/_n_children (serialised);
Packit ae235b
Packit ae235b
                 )
Packit ae235b
  g_assert_not_reached ();
Packit ae235b
}
Packit ae235b
Packit ae235b
/* < private >
Packit ae235b
 * g_variant_serialised_get_child:
Packit ae235b
 * @serialised: a #GVariantSerialised
Packit ae235b
 * @index_: the index of the child to fetch
Packit ae235b
 *
Packit ae235b
 * Extracts a child from a serialised data representing a container
Packit ae235b
 * value.
Packit ae235b
 *
Packit ae235b
 * It is an error to call this function with an index out of bounds.
Packit ae235b
 *
Packit ae235b
 * If the result .data == %NULL and .size > 0 then there has been an
Packit ae235b
 * error extracting the requested fixed-sized value.  This number of
Packit ae235b
 * zero bytes needs to be allocated instead.
Packit ae235b
 *
Packit ae235b
 * In the case that .data == %NULL and .size == 0 then a zero-sized
Packit ae235b
 * item of a variable-sized type is being returned.
Packit ae235b
 *
Packit ae235b
 * .data is never non-%NULL if size is 0.
Packit ae235b
 *
Packit ae235b
 * Returns: a #GVariantSerialised for the child
Packit ae235b
 */
Packit ae235b
GVariantSerialised
Packit ae235b
g_variant_serialised_get_child (GVariantSerialised serialised,
Packit ae235b
                                gsize              index_)
Packit ae235b
{
Packit ae235b
  GVariantSerialised child;
Packit ae235b
Packit ae235b
  g_variant_serialised_check (serialised);
Packit ae235b
Packit ae235b
  if G_LIKELY (index_ < g_variant_serialised_n_children (serialised))
Packit ae235b
    {
Packit ae235b
      DISPATCH_CASES (serialised.type_info,
Packit ae235b
Packit ae235b
                      child = gvs_/**/,/**/_get_child (serialised, index_);
Packit ae235b
                      g_assert (child.size || child.data == NULL);
Packit ae235b
                      g_variant_serialised_check (child);
Packit ae235b
                      return child;
Packit ae235b
Packit ae235b
                     )
Packit ae235b
      g_assert_not_reached ();
Packit ae235b
    }
Packit ae235b
Packit ae235b
  g_error ("Attempt to access item %"G_GSIZE_FORMAT
Packit ae235b
           " in a container with only %"G_GSIZE_FORMAT" items",
Packit ae235b
           index_, g_variant_serialised_n_children (serialised));
Packit ae235b
}
Packit ae235b
Packit ae235b
/* < private >
Packit ae235b
 * g_variant_serialiser_serialise:
Packit ae235b
 * @serialised: a #GVariantSerialised, properly set up
Packit ae235b
 * @gvs_filler: the filler function
Packit ae235b
 * @children: an array of child items
Packit ae235b
 * @n_children: the size of @children
Packit ae235b
 *
Packit ae235b
 * Writes data in serialised form.
Packit ae235b
 *
Packit ae235b
 * The type_info field of @serialised must be filled in to type info for
Packit ae235b
 * the type that we are serialising.
Packit ae235b
 *
Packit ae235b
 * The size field of @serialised must be filled in with the value
Packit ae235b
 * returned by a previous call to g_variant_serialiser_needed_size().
Packit ae235b
 *
Packit ae235b
 * The data field of @serialised must be a pointer to a properly-aligned
Packit ae235b
 * memory region large enough to serialise into (ie: at least as big as
Packit ae235b
 * the size field).
Packit ae235b
 *
Packit ae235b
 * This function is only resonsible for serialising the top-level
Packit ae235b
 * container.  @gvs_filler is called on each child of the container in
Packit ae235b
 * order for all of the data of that child to be filled in.
Packit ae235b
 */
Packit ae235b
void
Packit ae235b
g_variant_serialiser_serialise (GVariantSerialised        serialised,
Packit ae235b
                                GVariantSerialisedFiller  gvs_filler,
Packit ae235b
                                const gpointer           *children,
Packit ae235b
                                gsize                     n_children)
Packit ae235b
{
Packit ae235b
  g_variant_serialised_check (serialised);
Packit ae235b
Packit ae235b
  DISPATCH_CASES (serialised.type_info,
Packit ae235b
Packit ae235b
                  gvs_/**/,/**/_serialise (serialised, gvs_filler,
Packit ae235b
                                           children, n_children);
Packit ae235b
                  return;
Packit ae235b
Packit ae235b
                 )
Packit ae235b
  g_assert_not_reached ();
Packit ae235b
}
Packit ae235b
Packit ae235b
/* < private >
Packit ae235b
 * g_variant_serialiser_needed_size:
Packit ae235b
 * @type_info: the type to serialise for
Packit ae235b
 * @gvs_filler: the filler function
Packit ae235b
 * @children: an array of child items
Packit ae235b
 * @n_children: the size of @children
Packit ae235b
 *
Packit ae235b
 * Determines how much memory would be needed to serialise this value.
Packit ae235b
 *
Packit ae235b
 * This function is only resonsible for performing calculations for the
Packit ae235b
 * top-level container.  @gvs_filler is called on each child of the
Packit ae235b
 * container in order to determine its size.
Packit ae235b
 */
Packit ae235b
gsize
Packit ae235b
g_variant_serialiser_needed_size (GVariantTypeInfo         *type_info,
Packit ae235b
                                  GVariantSerialisedFiller  gvs_filler,
Packit ae235b
                                  const gpointer           *children,
Packit ae235b
                                  gsize                     n_children)
Packit ae235b
{
Packit ae235b
  DISPATCH_CASES (type_info,
Packit ae235b
Packit ae235b
                  return gvs_/**/,/**/_needed_size (type_info, gvs_filler,
Packit ae235b
                                                    children, n_children);
Packit ae235b
Packit ae235b
                 )
Packit ae235b
  g_assert_not_reached ();
Packit ae235b
}
Packit ae235b
Packit ae235b
/* Byteswapping {{{2 */
Packit ae235b
Packit ae235b
/* < private >
Packit ae235b
 * g_variant_serialised_byteswap:
Packit ae235b
 * @value: a #GVariantSerialised
Packit ae235b
 *
Packit ae235b
 * Byte-swap serialised data.  The result of this function is only
Packit ae235b
 * well-defined if the data is in normal form.
Packit ae235b
 */
Packit ae235b
void
Packit ae235b
g_variant_serialised_byteswap (GVariantSerialised serialised)
Packit ae235b
{
Packit ae235b
  gsize fixed_size;
Packit ae235b
  guint alignment;
Packit ae235b
Packit ae235b
  g_variant_serialised_check (serialised);
Packit ae235b
Packit ae235b
  if (!serialised.data)
Packit ae235b
    return;
Packit ae235b
Packit ae235b
  /* the types we potentially need to byteswap are
Packit ae235b
   * exactly those with alignment requirements.
Packit ae235b
   */
Packit ae235b
  g_variant_type_info_query (serialised.type_info, &alignment, &fixed_size);
Packit ae235b
  if (!alignment)
Packit ae235b
    return;
Packit ae235b
Packit ae235b
  /* if fixed size and alignment are equal then we are down
Packit ae235b
   * to the base integer type and we should swap it.  the
Packit ae235b
   * only exception to this is if we have a tuple with a
Packit ae235b
   * single item, and then swapping it will be OK anyway.
Packit ae235b
   */
Packit ae235b
  if (alignment + 1 == fixed_size)
Packit ae235b
    {
Packit ae235b
      switch (fixed_size)
Packit ae235b
      {
Packit ae235b
        case 2:
Packit ae235b
          {
Packit ae235b
            guint16 *ptr = (guint16 *) serialised.data;
Packit ae235b
Packit ae235b
            g_assert_cmpint (serialised.size, ==, 2);
Packit ae235b
            *ptr = GUINT16_SWAP_LE_BE (*ptr);
Packit ae235b
          }
Packit ae235b
          return;
Packit ae235b
Packit ae235b
        case 4:
Packit ae235b
          {
Packit ae235b
            guint32 *ptr = (guint32 *) serialised.data;
Packit ae235b
Packit ae235b
            g_assert_cmpint (serialised.size, ==, 4);
Packit ae235b
            *ptr = GUINT32_SWAP_LE_BE (*ptr);
Packit ae235b
          }
Packit ae235b
          return;
Packit ae235b
Packit ae235b
        case 8:
Packit ae235b
          {
Packit ae235b
            guint64 *ptr = (guint64 *) serialised.data;
Packit ae235b
Packit ae235b
            g_assert_cmpint (serialised.size, ==, 8);
Packit ae235b
            *ptr = GUINT64_SWAP_LE_BE (*ptr);
Packit ae235b
          }
Packit ae235b
          return;
Packit ae235b
Packit ae235b
        default:
Packit ae235b
          g_assert_not_reached ();
Packit ae235b
      }
Packit ae235b
    }
Packit ae235b
Packit ae235b
  /* else, we have a container that potentially contains
Packit ae235b
   * some children that need to be byteswapped.
Packit ae235b
   */
Packit ae235b
  else
Packit ae235b
    {
Packit ae235b
      gsize children, i;
Packit ae235b
Packit ae235b
      children = g_variant_serialised_n_children (serialised);
Packit ae235b
      for (i = 0; i < children; i++)
Packit ae235b
        {
Packit ae235b
          GVariantSerialised child;
Packit ae235b
Packit ae235b
          child = g_variant_serialised_get_child (serialised, i);
Packit ae235b
          g_variant_serialised_byteswap (child);
Packit ae235b
          g_variant_type_info_unref (child.type_info);
Packit ae235b
        }
Packit ae235b
    }
Packit ae235b
}
Packit ae235b
Packit ae235b
/* Normal form checking {{{2 */
Packit ae235b
Packit ae235b
/* < private >
Packit ae235b
 * g_variant_serialised_is_normal:
Packit ae235b
 * @serialised: a #GVariantSerialised
Packit ae235b
 *
Packit ae235b
 * Determines, recursively if @serialised is in normal form.  There is
Packit ae235b
 * precisely one normal form of serialised data for each possible value.
Packit ae235b
 *
Packit ae235b
 * It is possible that multiple byte sequences form the serialised data
Packit ae235b
 * for a given value if, for example, the padding bytes are filled in
Packit ae235b
 * with something other than zeros, but only one form is the normal
Packit ae235b
 * form.
Packit ae235b
 */
Packit ae235b
gboolean
Packit ae235b
g_variant_serialised_is_normal (GVariantSerialised serialised)
Packit ae235b
{
Packit ae235b
  DISPATCH_CASES (serialised.type_info,
Packit ae235b
Packit ae235b
                  return gvs_/**/,/**/_is_normal (serialised);
Packit ae235b
Packit ae235b
                 )
Packit ae235b
Packit ae235b
  if (serialised.data == NULL)
Packit ae235b
    return FALSE;
Packit ae235b
Packit ae235b
  /* some hard-coded terminal cases */
Packit ae235b
  switch (g_variant_type_info_get_type_char (serialised.type_info))
Packit ae235b
    {
Packit ae235b
    case 'b': /* boolean */
Packit ae235b
      return serialised.data[0] < 2;
Packit ae235b
Packit ae235b
    case 's': /* string */
Packit ae235b
      return g_variant_serialiser_is_string (serialised.data,
Packit ae235b
                                             serialised.size);
Packit ae235b
Packit ae235b
    case 'o':
Packit ae235b
      return g_variant_serialiser_is_object_path (serialised.data,
Packit ae235b
                                                  serialised.size);
Packit ae235b
Packit ae235b
    case 'g':
Packit ae235b
      return g_variant_serialiser_is_signature (serialised.data,
Packit ae235b
                                                serialised.size);
Packit ae235b
Packit ae235b
    default:
Packit ae235b
      /* all of the other types are fixed-sized numerical types for
Packit ae235b
       * which all possible values are valid (including various NaN
Packit ae235b
       * representations for floating point values).
Packit ae235b
       */
Packit ae235b
      return TRUE;
Packit ae235b
    }
Packit ae235b
}
Packit ae235b
Packit ae235b
/* Validity-checking functions {{{2
Packit ae235b
 *
Packit ae235b
 * Checks if strings, object paths and signature strings are valid.
Packit ae235b
 */
Packit ae235b
Packit ae235b
/* < private >
Packit ae235b
 * g_variant_serialiser_is_string:
Packit ae235b
 * @data: a possible string
Packit ae235b
 * @size: the size of @data
Packit ae235b
 *
Packit ae235b
 * Ensures that @data is a valid string with a nul terminator at the end
Packit ae235b
 * and no nul bytes embedded.
Packit ae235b
 */
Packit ae235b
gboolean
Packit ae235b
g_variant_serialiser_is_string (gconstpointer data,
Packit ae235b
                                gsize         size)
Packit ae235b
{
Packit ae235b
  const gchar *expected_end;
Packit ae235b
  const gchar *end;
Packit ae235b
Packit ae235b
  if (size == 0)
Packit ae235b
    return FALSE;
Packit ae235b
Packit ae235b
  expected_end = ((gchar *) data) + size - 1;
Packit ae235b
Packit ae235b
  if (*expected_end != '\0')
Packit ae235b
    return FALSE;
Packit ae235b
Packit ae235b
  g_utf8_validate (data, size, &end;;
Packit ae235b
Packit ae235b
  return end == expected_end;
Packit ae235b
}
Packit ae235b
Packit ae235b
/* < private >
Packit ae235b
 * g_variant_serialiser_is_object_path:
Packit ae235b
 * @data: a possible D-Bus object path
Packit ae235b
 * @size: the size of @data
Packit ae235b
 *
Packit ae235b
 * Performs the checks for being a valid string.
Packit ae235b
 *
Packit ae235b
 * Also, ensures that @data is a valid DBus object path, as per the D-Bus
Packit ae235b
 * specification.
Packit ae235b
 */
Packit ae235b
gboolean
Packit ae235b
g_variant_serialiser_is_object_path (gconstpointer data,
Packit ae235b
                                     gsize         size)
Packit ae235b
{
Packit ae235b
  const gchar *string = data;
Packit ae235b
  gsize i;
Packit ae235b
Packit ae235b
  if (!g_variant_serialiser_is_string (data, size))
Packit ae235b
    return FALSE;
Packit ae235b
Packit ae235b
  /* The path must begin with an ASCII '/' (integer 47) character */
Packit ae235b
  if (string[0] != '/')
Packit ae235b
    return FALSE;
Packit ae235b
Packit ae235b
  for (i = 1; string[i]; i++)
Packit ae235b
    /* Each element must only contain the ASCII characters
Packit ae235b
     * "[A-Z][a-z][0-9]_"
Packit ae235b
     */
Packit ae235b
    if (g_ascii_isalnum (string[i]) || string[i] == '_')
Packit ae235b
      ;
Packit ae235b
Packit ae235b
    /* must consist of elements separated by slash characters. */
Packit ae235b
    else if (string[i] == '/')
Packit ae235b
      {
Packit ae235b
        /* No element may be the empty string. */
Packit ae235b
        /* Multiple '/' characters cannot occur in sequence. */
Packit ae235b
        if (string[i - 1] == '/')
Packit ae235b
          return FALSE;
Packit ae235b
      }
Packit ae235b
Packit ae235b
    else
Packit ae235b
      return FALSE;
Packit ae235b
Packit ae235b
  /* A trailing '/' character is not allowed unless the path is the
Packit ae235b
   * root path (a single '/' character).
Packit ae235b
   */
Packit ae235b
  if (i > 1 && string[i - 1] == '/')
Packit ae235b
    return FALSE;
Packit ae235b
Packit ae235b
  return TRUE;
Packit ae235b
}
Packit ae235b
Packit ae235b
/* < private >
Packit ae235b
 * g_variant_serialiser_is_signature:
Packit ae235b
 * @data: a possible D-Bus signature
Packit ae235b
 * @size: the size of @data
Packit ae235b
 *
Packit ae235b
 * Performs the checks for being a valid string.
Packit ae235b
 *
Packit ae235b
 * Also, ensures that @data is a valid D-Bus type signature, as per the
Packit ae235b
 * D-Bus specification.
Packit ae235b
 */
Packit ae235b
gboolean
Packit ae235b
g_variant_serialiser_is_signature (gconstpointer data,
Packit ae235b
                                   gsize         size)
Packit ae235b
{
Packit ae235b
  const gchar *string = data;
Packit ae235b
  gsize first_invalid;
Packit ae235b
Packit ae235b
  if (!g_variant_serialiser_is_string (data, size))
Packit ae235b
    return FALSE;
Packit ae235b
Packit ae235b
  /* make sure no non-definite characters appear */
Packit ae235b
  first_invalid = strspn (string, "ybnqiuxthdvasog(){}");
Packit ae235b
  if (string[first_invalid])
Packit ae235b
    return FALSE;
Packit ae235b
Packit ae235b
  /* make sure each type string is well-formed */
Packit ae235b
  while (*string)
Packit ae235b
    if (!g_variant_type_string_scan (string, NULL, &string))
Packit ae235b
      return FALSE;
Packit ae235b
Packit ae235b
  return TRUE;
Packit ae235b
}
Packit ae235b
Packit ae235b
/* Epilogue {{{1 */
Packit ae235b
/* vim:set foldmethod=marker: */