You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 

249 lines
18 KiB

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