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 #if !defined (__GLIB_H_INSIDE__) && !defined (GLIB_COMPILATION)
  27 #error "Only <glib.h> can be included directly."
  28 #endif
  29
  30 #include <glib/gvarianttype.h>
  31 #include <glib/gstring.h>
  32 #include <glib/gbytes.h>
  33
  34 G_BEGIN_DECLS
  35
  36 typedef struct _GVariant        GVariant;
  37
  38 typedef enum
  39 {
  40   G_VARIANT_CLASS_BOOLEAN       = 'b',
  41   G_VARIANT_CLASS_BYTE          = 'y',
  42   G_VARIANT_CLASS_INT16         = 'n',
  43   G_VARIANT_CLASS_UINT16        = 'q',
  44   G_VARIANT_CLASS_INT32         = 'i',
  45   G_VARIANT_CLASS_UINT32        = 'u',
  46   G_VARIANT_CLASS_INT64         = 'x',
  47   G_VARIANT_CLASS_UINT64        = 't',
  48   G_VARIANT_CLASS_HANDLE        = 'h',
  49   G_VARIANT_CLASS_DOUBLE        = 'd',
  50   G_VARIANT_CLASS_STRING        = 's',
  51   G_VARIANT_CLASS_OBJECT_PATH   = 'o',
  52   G_VARIANT_CLASS_SIGNATURE     = 'g',
  53   G_VARIANT_CLASS_VARIANT       = 'v',
  54   G_VARIANT_CLASS_MAYBE         = 'm',
  55   G_VARIANT_CLASS_ARRAY         = 'a',
  56   G_VARIANT_CLASS_TUPLE         = '(',
  57   G_VARIANT_CLASS_DICT_ENTRY    = '{'
  58 } GVariantClass;
  59
  60 void                            g_variant_unref                         (GVariant             *value);
  61 GVariant *                      g_variant_ref                           (GVariant             *value);
  62 GVariant *                      g_variant_ref_sink                      (GVariant             *value);
  63 gboolean                        g_variant_is_floating                   (GVariant             *value);
  64 GVariant *                      g_variant_take_ref                      (GVariant             *value);
  65
  66 const GVariantType *            g_variant_get_type                      (GVariant             *value);
  67 const gchar *                   g_variant_get_type_string               (GVariant             *value);
  68 gboolean                        g_variant_is_of_type                    (GVariant             *value,
  69                                                                          const GVariantType   *type);
  70 gboolean                        g_variant_is_container                  (GVariant             *value);
  71 GVariantClass                   g_variant_classify                      (GVariant             *value);
  72 GVariant *                      g_variant_new_boolean                   (gboolean              value);
  73 GVariant *                      g_variant_new_byte                      (guchar                value);
  74 GVariant *                      g_variant_new_int16                     (gint16                value);
  75 GVariant *                      g_variant_new_uint16                    (guint16               value);
  76 GVariant *                      g_variant_new_int32                     (gint32                value);
  77 GVariant *                      g_variant_new_uint32                    (guint32               value);
  78 GVariant *                      g_variant_new_int64                     (gint64                value);
  79 GVariant *                      g_variant_new_uint64                    (guint64               value);
  80 GVariant *                      g_variant_new_handle                    (gint32                value);
  81 GVariant *                      g_variant_new_double                    (gdouble               value);
  82 GVariant *                      g_variant_new_string                    (const gchar          *string);
  83 GVariant *                      g_variant_new_object_path               (const gchar          *object_path);
  84 gboolean                        g_variant_is_object_path                (const gchar          *string);
  85 GVariant *                      g_variant_new_signature                 (const gchar          *signature);
  86 gboolean                        g_variant_is_signature                  (const gchar          *string);
  87 GVariant *                      g_variant_new_variant                   (GVariant             *value);
  88 GVariant *                      g_variant_new_strv                      (const gchar * const  *strv,
  89                                                                          gssize                length);
  90 GLIB_AVAILABLE_IN_2_30
  91 GVariant *                      g_variant_new_objv                      (const gchar * const  *strv,
  92                                                                          gssize                length);
  93 GVariant *                      g_variant_new_bytestring                (const gchar          *string);
  94 GVariant *                      g_variant_new_bytestring_array          (const gchar * const  *strv,
  95                                                                          gssize                length);
  96 GVariant *                      g_variant_new_fixed_array               (const GVariantType   *element_type,
  97                                                                          gconstpointer         elements,
  98                                                                          gsize                 n_elements,
  99                                                                          gsize                 element_size);
 100 gboolean                        g_variant_get_boolean                   (GVariant             *value);
 101 guchar                          g_variant_get_byte                      (GVariant             *value);
 102 gint16                          g_variant_get_int16                     (GVariant             *value);
 103 guint16                         g_variant_get_uint16                    (GVariant             *value);
 104 gint32                          g_variant_get_int32                     (GVariant             *value);
 105 guint32                         g_variant_get_uint32                    (GVariant             *value);
 106 gint64                          g_variant_get_int64                     (GVariant             *value);
 107 guint64                         g_variant_get_uint64                    (GVariant             *value);
 108 gint32                          g_variant_get_handle                    (GVariant             *value);
 109 gdouble                         g_variant_get_double                    (GVariant             *value);
 110 GVariant *                      g_variant_get_variant                   (GVariant             *value);
 111 const gchar *                   g_variant_get_string                    (GVariant             *value,
 112                                                                          gsize                *length);
 113 gchar *                         g_variant_dup_string                    (GVariant             *value,
 114                                                                          gsize                *length);
 115 const gchar **                  g_variant_get_strv                      (GVariant             *value,
 116                                                                          gsize                *length);
 117 gchar **                        g_variant_dup_strv                      (GVariant             *value,
 118                                                                          gsize                *length);
 119 GLIB_AVAILABLE_IN_2_30
 120 const gchar **                  g_variant_get_objv                      (GVariant             *value,
 121                                                                          gsize                *length);
 122 gchar **                        g_variant_dup_objv                      (GVariant             *value,
 123                                                                          gsize                *length);
 124 const gchar *                   g_variant_get_bytestring                (GVariant             *value);
 125 gchar *                         g_variant_dup_bytestring                (GVariant             *value,
 126                                                                          gsize                *length);
 127 const gchar **                  g_variant_get_bytestring_array          (GVariant             *value,
 128                                                                          gsize                *length);
 129 gchar **                        g_variant_dup_bytestring_array          (GVariant             *value,
 130                                                                          gsize                *length);
 131
 132 GVariant *                      g_variant_new_maybe                     (const GVariantType   *child_type,
 133                                                                          GVariant             *child);
 134 GVariant *                      g_variant_new_array                     (const GVariantType   *child_type,
 135                                                                          GVariant * const     *children,
 136                                                                          gsize                 n_children);
 137 GVariant *                      g_variant_new_tuple                     (GVariant * const     *children,
 138                                                                          gsize                 n_children);
 139 GVariant *                      g_variant_new_dict_entry                (GVariant             *key,
 140                                                                          GVariant             *value);
 141
 142 GVariant *                      g_variant_get_maybe                     (GVariant             *value);
 143 gsize                           g_variant_n_children                    (GVariant             *value);
 144 void                            g_variant_get_child                     (GVariant             *value,
 145                                                                          gsize                 index_,
 146                                                                          const gchar          *format_string,
 147                                                                          ...);
 148 GVariant *                      g_variant_get_child_value               (GVariant             *value,
 149                                                                          gsize                 index_);
 150 gboolean                        g_variant_lookup                        (GVariant             *dictionary,
 151                                                                          const gchar          *key,
 152                                                                          const gchar          *format_string,
 153                                                                          ...);
 154 GVariant *                      g_variant_lookup_value                  (GVariant             *dictionary,
 155                                                                          const gchar          *key,
 156                                                                          const GVariantType   *expected_type);
 157 gconstpointer                   g_variant_get_fixed_array               (GVariant             *value,
 158                                                                          gsize                *n_elements,
 159                                                                          gsize                 element_size);
 160
 161 gsize                           g_variant_get_size                      (GVariant             *value);
 162 gconstpointer                   g_variant_get_data                      (GVariant             *value);
 163 GLIB_AVAILABLE_IN_2_36
 164 GBytes *                        g_variant_get_data_as_bytes             (GVariant             *value);
 165 void                            g_variant_store                         (GVariant             *value,
 166                                                                          gpointer              data);
 167
 168 gchar *                         g_variant_print                         (GVariant             *value,
 169                                                                          gboolean              type_annotate);
 170 GString *                       g_variant_print_string                  (GVariant             *value,
 171                                                                          GString              *string,
 172                                                                          gboolean              type_annotate);
 173
 174 guint                           g_variant_hash                          (gconstpointer         value);
 175 gboolean                        g_variant_equal                         (gconstpointer         one,
 176                                                                          gconstpointer         two);
 177
 178 GVariant *                      g_variant_get_normal_form               (GVariant             *value);
 179 gboolean                        g_variant_is_normal_form                (GVariant             *value);
 180 GVariant *                      g_variant_byteswap                      (GVariant             *value);
 181
 182 GLIB_AVAILABLE_IN_2_36
 183 GVariant *                      g_variant_new_from_bytes                (const GVariantType   *type,
 184                                                                          GBytes               *bytes,
 185                                                                          gboolean              trusted);
 186 GVariant *                      g_variant_new_from_data                 (const GVariantType   *type,
 187                                                                          gconstpointer         data,
 188                                                                          gsize                 size,
 189                                                                          gboolean              trusted,
 190                                                                          GDestroyNotify        notify,
 191                                                                          gpointer              user_data);
 192
 193 typedef struct _GVariantIter GVariantIter;
 194 struct _GVariantIter {
 195   /*< private >*/
 196   gsize x[16];
 197 };
 198
 199 GVariantIter *                  g_variant_iter_new                      (GVariant             *value);
 200 gsize                           g_variant_iter_init                     (GVariantIter         *iter,
 201                                                                          GVariant             *value);
 202 GVariantIter *                  g_variant_iter_copy                     (GVariantIter         *iter);
 203 gsize                           g_variant_iter_n_children               (GVariantIter         *iter);
 204 void                            g_variant_iter_free                     (GVariantIter         *iter);
 205 GVariant *                      g_variant_iter_next_value               (GVariantIter         *iter);
 206 gboolean                        g_variant_iter_next                     (GVariantIter         *iter,
 207                                                                          const gchar          *format_string,
 208                                                                          ...);
 209 gboolean                        g_variant_iter_loop                     (GVariantIter         *iter,
 210                                                                          const gchar          *format_string,
 211                                                                          ...);
 212
 213
 214 typedef struct _GVariantBuilder GVariantBuilder;
 215 struct _GVariantBuilder {
 216   /*< private >*/
 217   gsize x[16];
 218 };
 219
 220 typedef enum
 221 {
 222   G_VARIANT_PARSE_ERROR_FAILED,
 223   G_VARIANT_PARSE_ERROR_BASIC_TYPE_EXPECTED,
 224   G_VARIANT_PARSE_ERROR_CANNOT_INFER_TYPE,
 225   G_VARIANT_PARSE_ERROR_DEFINITE_TYPE_EXPECTED,
 226   G_VARIANT_PARSE_ERROR_INPUT_NOT_AT_END,
 227   G_VARIANT_PARSE_ERROR_INVALID_CHARACTER,
 228   G_VARIANT_PARSE_ERROR_INVALID_FORMAT_STRING,
 229   G_VARIANT_PARSE_ERROR_INVALID_OBJECT_PATH,
 230   G_VARIANT_PARSE_ERROR_INVALID_SIGNATURE,
 231   G_VARIANT_PARSE_ERROR_INVALID_TYPE_STRING,
 232   G_VARIANT_PARSE_ERROR_NO_COMMON_TYPE,
 233   G_VARIANT_PARSE_ERROR_NUMBER_OUT_OF_RANGE,
 234   G_VARIANT_PARSE_ERROR_NUMBER_TOO_BIG,
 235   G_VARIANT_PARSE_ERROR_TYPE_ERROR,
 236   G_VARIANT_PARSE_ERROR_UNEXPECTED_TOKEN,
 237   G_VARIANT_PARSE_ERROR_UNKNOWN_KEYWORD,
 238   G_VARIANT_PARSE_ERROR_UNTERMINATED_STRING_CONSTANT,
 239   G_VARIANT_PARSE_ERROR_VALUE_EXPECTED
 240 } GVariantParseError;
 241 #define G_VARIANT_PARSE_ERROR (g_variant_parser_get_error_quark ())
 242
 243 GQuark                          g_variant_parser_get_error_quark        (void);
 244
 245 GVariantBuilder *               g_variant_builder_new                   (const GVariantType   *type);
 246 void                            g_variant_builder_unref                 (GVariantBuilder      *builder);
 247 GVariantBuilder *               g_variant_builder_ref                   (GVariantBuilder      *builder);
 248 void                            g_variant_builder_init                  (GVariantBuilder      *builder,
 249                                                                          const GVariantType   *type);
 250 GVariant *                      g_variant_builder_end                   (GVariantBuilder      *builder);
 251 void                            g_variant_builder_clear                 (GVariantBuilder      *builder);
 252 void                            g_variant_builder_open                  (GVariantBuilder      *builder,
 253                                                                          const GVariantType   *type);
 254 void                            g_variant_builder_close                 (GVariantBuilder      *builder);
 255 void                            g_variant_builder_add_value             (GVariantBuilder      *builder,
 256                                                                          GVariant             *value);
 257 void                            g_variant_builder_add                   (GVariantBuilder      *builder,
 258                                                                          const gchar          *format_string,
 259                                                                          ...);
 260 void                            g_variant_builder_add_parsed            (GVariantBuilder      *builder,
 261                                                                          const gchar          *format,
 262                                                                          ...);
 263
 264 GVariant *                      g_variant_new                           (const gchar          *format_string,
 265                                                                          ...);
 266 void                            g_variant_get                           (GVariant             *value,
 267                                                                          const gchar          *format_string,
 268                                                                          ...);
 269 GVariant *                      g_variant_new_va                        (const gchar          *format_string,
 270                                                                          const gchar         **endptr,
 271                                                                          va_list              *app);
 272 void                            g_variant_get_va                        (GVariant             *value,
 273                                                                          const gchar          *format_string,
 274                                                                          const gchar         **endptr,
 275                                                                          va_list              *app);
 276 gboolean                        g_variant_check_format_string           (GVariant             *value,
 277                                                                          const gchar          *format_string,
 278                                                                          gboolean              copy_only);
 279
 280 GVariant *                      g_variant_parse                         (const GVariantType   *type,
 281                                                                          const gchar          *text,
 282                                                                          const gchar          *limit,
 283                                                                          const gchar         **endptr,
 284                                                                          GError              **error);
 285 GVariant *                      g_variant_new_parsed                    (const gchar          *format,
 286                                                                          ...);
 287 GVariant *                      g_variant_new_parsed_va                 (const gchar          *format,
 288                                                                          va_list              *app);
 289
 290 gint                            g_variant_compare                       (gconstpointer one,
 291                                                                          gconstpointer two);
 292 G_END_DECLS
 293
 294 #endif /* __G_VARIANT_H__ */