glib/gvariant-serialiser.h

   1 /*
   2  * Copyright © 2007, 2008 Ryan Lortie
   3  * Copyright © 2010 Codethink Limited
   4  *
   5  * This library is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU Lesser General Public
   7  * License as published by the Free Software Foundation; either
   8  * version 2 of the License, or (at your option) any later version.
   9  *
  10  * This library is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * Lesser General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU Lesser General Public
  16  * License along with this library; if not, see <http://www.gnu.org/licenses/>.
  17  *
  18  * Author: Ryan Lortie <desrt@desrt.ca>
  19  */
  20
  21 #ifndef __G_VARIANT_SERIALISER_H__
  22 #define __G_VARIANT_SERIALISER_H__
  23
  24 #include "gvarianttypeinfo.h"
  25 #include "gvariant-vectors.h"
  26
  27 typedef struct
  28 {
  29   GVariantTypeInfo *type_info;
  30   guchar           *data;
  31   gsize             size;
  32 } GVariantSerialised;
  33
  34 typedef struct
  35 {
  36   GVariantTypeInfo *type_info;
  37   gsize             skip;
  38   gsize             size;
  39 } GVariantUnpacked;
  40
  41 /* deserialisation */
  42 GLIB_AVAILABLE_IN_ALL
  43 gsize                           g_variant_serialised_n_children         (GVariantSerialised        container);
  44 GLIB_AVAILABLE_IN_ALL
  45 GVariantSerialised              g_variant_serialised_get_child          (GVariantSerialised        container,
  46                                                                          gsize                     index);
  47
  48 gboolean                        g_variant_serialiser_unpack_all         (GVariantTypeInfo         *type_info,
  49                                                                          const guchar             *end_pointer,
  50                                                                          gsize                     end_size,
  51                                                                          gsize                     total_size,
  52                                                                          GArray                   *unpacked_children);
  53
  54 /* serialisation */
  55 typedef void                  (*GVariantSerialisedFiller)               (GVariantSerialised       *serialised,
  56                                                                          gpointer                  data);
  57
  58 GLIB_AVAILABLE_IN_ALL
  59 gsize                           g_variant_serialiser_needed_size        (GVariantTypeInfo         *info,
  60                                                                          GVariantSerialisedFiller  gsv_filler,
  61                                                                          const gpointer           *children,
  62                                                                          gsize                     n_children);
  63
  64 GLIB_AVAILABLE_IN_ALL
  65 void                            g_variant_serialiser_serialise          (GVariantSerialised        container,
  66                                                                          GVariantSerialisedFiller  gsv_filler,
  67                                                                          const gpointer           *children,
  68                                                                          gsize                     n_children);
  69
  70 /* misc */
  71 GLIB_AVAILABLE_IN_ALL
  72 gboolean                        g_variant_serialised_is_normal          (GVariantSerialised        value);
  73 GLIB_AVAILABLE_IN_ALL
  74 void                            g_variant_serialised_byteswap           (GVariantSerialised        value);
  75
  76 /* validation of strings */
  77 GLIB_AVAILABLE_IN_ALL
  78 gboolean                        g_variant_serialiser_is_string          (gconstpointer             data,
  79                                                                          gsize                     size);
  80 GLIB_AVAILABLE_IN_ALL
  81 gboolean                        g_variant_serialiser_is_object_path     (gconstpointer             data,
  82                                                                          gsize                     size);
  83 GLIB_AVAILABLE_IN_ALL
  84 gboolean                        g_variant_serialiser_is_signature       (gconstpointer             data,
  85                                                                          gsize                     size);
  86
  87
  88 gsize                           g_variant_callback_write_to_vectors     (GVariantVectors          *vectors,
  89                                                                          gpointer                  data,
  90                                                                          GVariantTypeInfo        **type_info);
  91 void                            g_variant_serialiser_write_to_vectors   (GVariantVectors          *items,
  92                                                                          GVariantTypeInfo         *type_info,
  93                                                                          gsize                     size,
  94                                                                          const gpointer           *children,
  95                                                                          gsize                     n_children);
  96
  97 #endif /* __G_VARIANT_SERIALISER_H__ */