glib/gvariant.h

   1 /*
   2  * Copyright © 2007, 2008 Ryan Lortie
   3  * Copyright © 2009, 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 licence, 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, write to the
  17  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  18  * Boston, MA 02111-1307, USA.
  19  *
  20  * Author: Ryan Lortie <desrt@desrt.ca>
  21  */
  22
  23 #ifndef __G_VARIANT_H__
  24 #define __G_VARIANT_H__
  25
  26 #include <glib/gvarianttype.h>
  27 #include <glib/gstring.h>
  28
  29 G_BEGIN_DECLS
  30
  31 typedef struct _GVariant        GVariant;
  32
  33 typedef enum
  34 {
  35   G_VARIANT_CLASS_BOOLEAN       = 'b',
  36   G_VARIANT_CLASS_BYTE          = 'y',
  37   G_VARIANT_CLASS_INT16         = 'n',
  38   G_VARIANT_CLASS_UINT16        = 'q',
  39   G_VARIANT_CLASS_INT32         = 'i',
  40   G_VARIANT_CLASS_UINT32        = 'u',
  41   G_VARIANT_CLASS_INT64         = 'x',
  42   G_VARIANT_CLASS_UINT64        = 't',
  43   G_VARIANT_CLASS_HANDLE        = 'h',
  44   G_VARIANT_CLASS_DOUBLE        = 'd',
  45   G_VARIANT_CLASS_STRING        = 's',
  46   G_VARIANT_CLASS_OBJECT_PATH   = 'o',
  47   G_VARIANT_CLASS_SIGNATURE     = 'g',
  48   G_VARIANT_CLASS_VARIANT       = 'v',
  49   G_VARIANT_CLASS_MAYBE         = 'm',
  50   G_VARIANT_CLASS_ARRAY         = 'a',
  51   G_VARIANT_CLASS_TUPLE         = '(',
  52   G_VARIANT_CLASS_DICT_ENTRY    = '{'
  53 } GVariantClass;
  54
  55 void                            g_variant_unref                         (GVariant             *value);
  56 GVariant *                      g_variant_ref                           (GVariant             *value);
  57 GVariant *                      g_variant_ref_sink                      (GVariant             *value);
  58
  59 const GVariantType *            g_variant_get_type                      (GVariant             *value);
  60 const gchar *                   g_variant_get_type_string               (GVariant             *value);
  61 gboolean                        g_variant_is_of_type                    (GVariant             *value,
  62                                                                          const GVariantType   *type);
  63 gboolean                        g_variant_is_container                  (GVariant             *value);
  64 GVariantClass                   g_variant_classify                      (GVariant             *value);
  65 GVariant *                      g_variant_new_boolean                   (gboolean              boolean);
  66 GVariant *                      g_variant_new_byte                      (guchar                byte);
  67 GVariant *                      g_variant_new_int16                     (gint16                int16);
  68 GVariant *                      g_variant_new_uint16                    (guint16               uint16);
  69 GVariant *                      g_variant_new_int32                     (gint32                int32);
  70 GVariant *                      g_variant_new_uint32                    (guint32               uint32);
  71 GVariant *                      g_variant_new_int64                     (gint64                int64);
  72 GVariant *                      g_variant_new_uint64                    (guint64               uint64);
  73 GVariant *                      g_variant_new_handle                    (gint32                handle);
  74 GVariant *                      g_variant_new_double                    (gdouble               floating);
  75 GVariant *                      g_variant_new_string                    (const gchar          *string);
  76 GVariant *                      g_variant_new_object_path               (const gchar          *object_path);
  77 gboolean                        g_variant_is_object_path                (const gchar          *string);
  78 GVariant *                      g_variant_new_signature                 (const gchar          *signature);
  79 gboolean                        g_variant_is_signature                  (const gchar          *string);
  80 GVariant *                      g_variant_new_variant                   (GVariant             *value);
  81 GVariant *                      g_variant_new_byte_array                (gconstpointer         array,
  82                                                                          gssize                length);
  83 GVariant *                      g_variant_new_strv                      (const gchar * const  *strv,
  84                                                                          gssize                length);
  85
  86 gboolean                        g_variant_get_boolean                   (GVariant             *value);
  87 guchar                          g_variant_get_byte                      (GVariant             *value);
  88 gint16                          g_variant_get_int16                     (GVariant             *value);
  89 guint16                         g_variant_get_uint16                    (GVariant             *value);
  90 gint32                          g_variant_get_int32                     (GVariant             *value);
  91 guint32                         g_variant_get_uint32                    (GVariant             *value);
  92 gint64                          g_variant_get_int64                     (GVariant             *value);
  93 guint64                         g_variant_get_uint64                    (GVariant             *value);
  94 gint32                          g_variant_get_handle                    (GVariant             *value);
  95 gdouble                         g_variant_get_double                    (GVariant             *value);
  96 GVariant *                      g_variant_get_variant                   (GVariant             *value);
  97 const gchar *                   g_variant_get_string                    (GVariant             *value,
  98                                                                          gsize                *length);
  99 gchar *                         g_variant_dup_string                    (GVariant             *value,
 100                                                                          gsize                *length);
 101 gconstpointer                   g_variant_get_byte_array                (GVariant             *value,
 102                                                                          gsize                *length);
 103 const gchar **                  g_variant_get_strv                      (GVariant             *value,
 104                                                                          gsize                *length);
 105 gchar **                        g_variant_dup_strv                      (GVariant             *value,
 106                                                                          gsize                *length);
 107
 108 GVariant *                      g_variant_new_maybe                     (const GVariantType   *child_type,
 109                                                                          GVariant             *child);
 110 GVariant *                      g_variant_new_array                     (const GVariantType   *child_type,
 111                                                                          GVariant * const     *children,
 112                                                                          gsize                 n_children);
 113 GVariant *                      g_variant_new_tuple                     (GVariant * const     *children,
 114                                                                          gsize                 n_children);
 115 GVariant *                      g_variant_new_dict_entry                (GVariant             *key,
 116                                                                          GVariant             *value);
 117
 118 GVariant *                      g_variant_get_maybe                     (GVariant             *value);
 119 gsize                           g_variant_n_children                    (GVariant             *value);
 120 void                            g_variant_get_child                     (GVariant             *value,
 121                                                                          gsize                 index_,
 122                                                                          const gchar          *format_string,
 123                                                                          ...);
 124 GVariant *                      g_variant_get_child_value               (GVariant             *value,
 125                                                                          gsize                 index_);
 126 gconstpointer                   g_variant_get_fixed_array               (GVariant             *value,
 127                                                                          gsize                *n_elements,
 128                                                                          gsize                 element_size);
 129
 130 gsize                           g_variant_get_size                      (GVariant             *value);
 131 gconstpointer                   g_variant_get_data                      (GVariant             *value);
 132 void                            g_variant_store                         (GVariant             *value,
 133                                                                          gpointer              data);
 134
 135 gchar *                         g_variant_print                         (GVariant             *value,
 136                                                                          gboolean              type_annotate);
 137 GString *                       g_variant_print_string                  (GVariant             *value,
 138                                                                          GString              *string,
 139                                                                          gboolean              type_annotate);
 140
 141 guint                           g_variant_hash                          (gconstpointer         value);
 142 gboolean                        g_variant_equal                         (gconstpointer         one,
 143                                                                          gconstpointer         two);
 144
 145 GVariant *                      g_variant_get_normal_form               (GVariant             *value);
 146 gboolean                        g_variant_is_normal_form                (GVariant             *value);
 147 GVariant *                      g_variant_byteswap                      (GVariant             *value);
 148 GVariant *                      g_variant_new_from_data                 (const GVariantType   *type,
 149                                                                          gconstpointer         data,
 150                                                                          gsize                 size,
 151                                                                          gboolean              trusted,
 152                                                                          GDestroyNotify        notify,
 153                                                                          gpointer              user_data);
 154
 155 typedef struct _GVariantIter GVariantIter;
 156 struct _GVariantIter {
 157   /*< private >*/
 158   gsize x[16];
 159 };
 160
 161 GVariantIter *                  g_variant_iter_new                      (GVariant             *value);
 162 gsize                           g_variant_iter_init                     (GVariantIter         *iter,
 163                                                                          GVariant             *value);
 164 GVariantIter *                  g_variant_iter_copy                     (GVariantIter         *iter);
 165 gsize                           g_variant_iter_n_children               (GVariantIter         *iter);
 166 void                            g_variant_iter_free                     (GVariantIter         *iter);
 167 GVariant *                      g_variant_iter_next_value               (GVariantIter         *iter);
 168 gboolean                        g_variant_iter_next                     (GVariantIter         *iter,
 169                                                                          const gchar          *format_string,
 170                                                                          ...);
 171 gboolean                        g_variant_iter_loop                     (GVariantIter         *iter,
 172                                                                          const gchar          *format_string,
 173                                                                          ...);
 174
 175
 176 typedef struct _GVariantBuilder GVariantBuilder;
 177 struct _GVariantBuilder {
 178   /*< private >*/
 179   gsize x[16];
 180 };
 181
 182 #define G_VARIANT_PARSE_ERROR (g_variant_parser_get_error_quark ())
 183 GQuark                          g_variant_parser_get_error_quark        (void);
 184
 185 GVariantBuilder *               g_variant_builder_new                   (const GVariantType   *type);
 186 void                            g_variant_builder_unref                 (GVariantBuilder      *builder);
 187 GVariantBuilder *               g_variant_builder_ref                   (GVariantBuilder      *builder);
 188 void                            g_variant_builder_init                  (GVariantBuilder      *builder,
 189                                                                          const GVariantType   *type);
 190 GVariant *                      g_variant_builder_end                   (GVariantBuilder      *builder);
 191 void                            g_variant_builder_clear                 (GVariantBuilder      *builder);
 192 void                            g_variant_builder_open                  (GVariantBuilder      *builder,
 193                                                                          const GVariantType   *type);
 194 void                            g_variant_builder_close                 (GVariantBuilder      *builder);
 195 void                            g_variant_builder_add_value             (GVariantBuilder      *builder,
 196                                                                          GVariant             *value);
 197 void                            g_variant_builder_add                   (GVariantBuilder      *builder,
 198                                                                          const gchar          *format_string,
 199                                                                          ...);
 200 void                            g_variant_builder_add_parsed            (GVariantBuilder      *builder,
 201                                                                          const gchar          *format,
 202                                                                          ...);
 203
 204 GVariant *                      g_variant_new                           (const gchar          *format_string,
 205                                                                          ...);
 206 void                            g_variant_get                           (GVariant             *value,
 207                                                                          const gchar          *format_string,
 208                                                                          ...);
 209 GVariant *                      g_variant_new_va                        (const gchar          *format_string,
 210                                                                          const gchar         **endptr,
 211                                                                          va_list              *app);
 212 void                            g_variant_get_va                        (GVariant             *value,
 213                                                                          const gchar          *format_string,
 214                                                                          const gchar         **endptr,
 215                                                                          va_list              *app);
 216
 217
 218 GVariant *                      g_variant_parse                         (const GVariantType   *type,
 219                                                                          const gchar          *text,
 220                                                                          const gchar          *limit,
 221                                                                          const gchar         **endptr,
 222                                                                          GError              **error);
 223 GVariant *                      g_variant_new_parsed                    (const gchar          *format,
 224                                                                          ...);
 225 GVariant *                      g_variant_new_parsed_va                 (const gchar          *format,
 226                                                                          va_list              *app);
 227
 228 gint                            g_variant_compare                       (gconstpointer one,
 229                                                                          gconstpointer two);
 230 G_END_DECLS
 231
 232 #endif /* __G_VARIANT_H__ */