• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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.1 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 
26 typedef struct
27 {
28   GVariantTypeInfo *type_info;
29   guchar           *data;
30   gsize             size;
31   gsize             depth;  /* same semantics as GVariant.depth */
32 } GVariantSerialised;
33 
34 /* deserialisation */
35 GLIB_AVAILABLE_IN_ALL
36 gsize                           g_variant_serialised_n_children         (GVariantSerialised        container);
37 GLIB_AVAILABLE_IN_ALL
38 GVariantSerialised              g_variant_serialised_get_child          (GVariantSerialised        container,
39                                                                          gsize                     index);
40 
41 /* serialisation */
42 typedef void                  (*GVariantSerialisedFiller)               (GVariantSerialised       *serialised,
43                                                                          gpointer                  data);
44 
45 GLIB_AVAILABLE_IN_ALL
46 gsize                           g_variant_serialiser_needed_size        (GVariantTypeInfo         *info,
47                                                                          GVariantSerialisedFiller  gsv_filler,
48                                                                          const gpointer           *children,
49                                                                          gsize                     n_children);
50 
51 GLIB_AVAILABLE_IN_ALL
52 void                            g_variant_serialiser_serialise          (GVariantSerialised        container,
53                                                                          GVariantSerialisedFiller  gsv_filler,
54                                                                          const gpointer           *children,
55                                                                          gsize                     n_children);
56 
57 /* misc */
58 GLIB_AVAILABLE_IN_2_60
59 gboolean                        g_variant_serialised_check              (GVariantSerialised        serialised);
60 GLIB_AVAILABLE_IN_ALL
61 gboolean                        g_variant_serialised_is_normal          (GVariantSerialised        value);
62 GLIB_AVAILABLE_IN_ALL
63 void                            g_variant_serialised_byteswap           (GVariantSerialised        value);
64 
65 /* validation of strings */
66 GLIB_AVAILABLE_IN_ALL
67 gboolean                        g_variant_serialiser_is_string          (gconstpointer             data,
68                                                                          gsize                     size);
69 GLIB_AVAILABLE_IN_ALL
70 gboolean                        g_variant_serialiser_is_object_path     (gconstpointer             data,
71                                                                          gsize                     size);
72 GLIB_AVAILABLE_IN_ALL
73 gboolean                        g_variant_serialiser_is_signature       (gconstpointer             data,
74                                                                          gsize                     size);
75 
76 #endif /* __G_VARIANT_SERIALISER_H__ */
77