gio/gdbusintrospection.h

   1 /* GDBus - GLib D-Bus Library
   2  *
   3  * Copyright (C) 2008-2010 Red Hat, Inc.
   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
  16  * Public 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: David Zeuthen <davidz@redhat.com>
  21  */
  22
  23 #if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
  24 #error "Only <gio/gio.h> can be included directly."
  25 #endif
  26
  27 #ifndef __G_DBUS_INTROSPECTION_H__
  28 #define __G_DBUS_INTROSPECTION_H__
  29
  30 #include <gio/giotypes.h>
  31
  32 G_BEGIN_DECLS
  33
  34 /**
  35  * GDBusAnnotationInfo:
  36  * @ref_count: The reference count or -1 if statically allocated.
  37  * @key: The name of the annotation, e.g. "org.freedesktop.DBus.Deprecated".
  38  * @value: The value of the annotation.
  39  * @annotations: (array zero-terminated=1): A pointer to a %NULL-terminated array of pointers to #GDBusAnnotationInfo structures or %NULL if there are no annotations.
  40  *
  41  * Information about an annotation.
  42  *
  43  * Since: 2.26
  44  */
  45 struct _GDBusAnnotationInfo
  46 {
  47   /*< public >*/
  48   volatile gint         ref_count;
  49   gchar                *key;
  50   gchar                *value;
  51   GDBusAnnotationInfo **annotations;
  52 };
  53
  54 /**
  55  * GDBusArgInfo:
  56  * @ref_count: The reference count or -1 if statically allocated.
  57  * @name: Name of the argument, e.g. @unix_user_id.
  58  * @signature: D-Bus signature of the argument (a single complete type).
  59  * @annotations: (array zero-terminated=1): A pointer to a %NULL-terminated array of pointers to #GDBusAnnotationInfo structures or %NULL if there are no annotations.
  60  *
  61  * Information about an argument for a method or a signal.
  62  *
  63  * Since: 2.26
  64  */
  65 struct _GDBusArgInfo
  66 {
  67   /*< public >*/
  68   volatile gint         ref_count;
  69   gchar                *name;
  70   gchar                *signature;
  71   GDBusAnnotationInfo **annotations;
  72 };
  73
  74 /**
  75  * GDBusMethodInfo:
  76  * @ref_count: The reference count or -1 if statically allocated.
  77  * @name: The name of the D-Bus method, e.g. @RequestName.
  78  * @in_args: (array zero-terminated=1): A pointer to a %NULL-terminated array of pointers to #GDBusArgInfo structures or %NULL if there are no in arguments.
  79  * @out_args: (array zero-terminated=1): A pointer to a %NULL-terminated array of pointers to #GDBusArgInfo structures or %NULL if there are no out arguments.
  80  * @annotations: (array zero-terminated=1): A pointer to a %NULL-terminated array of pointers to #GDBusAnnotationInfo structures or %NULL if there are no annotations.
  81  *
  82  * Information about a method on an D-Bus interface.
  83  *
  84  * Since: 2.26
  85  */
  86 struct _GDBusMethodInfo
  87 {
  88   /*< public >*/
  89   volatile gint         ref_count;
  90   gchar                *name;
  91   GDBusArgInfo        **in_args;
  92   GDBusArgInfo        **out_args;
  93   GDBusAnnotationInfo **annotations;
  94 };
  95
  96 /**
  97  * GDBusSignalInfo:
  98  * @ref_count: The reference count or -1 if statically allocated.
  99  * @name: The name of the D-Bus signal, e.g. "NameOwnerChanged".
 100  * @args: (array zero-terminated=1): A pointer to a %NULL-terminated array of pointers to #GDBusArgInfo structures or %NULL if there are no arguments.
 101  * @annotations: (array zero-terminated=1): A pointer to a %NULL-terminated array of pointers to #GDBusAnnotationInfo structures or %NULL if there are no annotations.
 102  *
 103  * Information about a signal on a D-Bus interface.
 104  *
 105  * Since: 2.26
 106  */
 107 struct _GDBusSignalInfo
 108 {
 109   /*< public >*/
 110   volatile gint         ref_count;
 111   gchar                *name;
 112   GDBusArgInfo        **args;
 113   GDBusAnnotationInfo **annotations;
 114 };
 115
 116 /**
 117  * GDBusPropertyInfo:
 118  * @ref_count: The reference count or -1 if statically allocated.
 119  * @name: The name of the D-Bus property, e.g. "SupportedFilesystems".
 120  * @signature: The D-Bus signature of the property (a single complete type).
 121  * @flags: Access control flags for the property.
 122  * @annotations: (array zero-terminated=1): A pointer to a %NULL-terminated array of pointers to #GDBusAnnotationInfo structures or %NULL if there are no annotations.
 123  *
 124  * Information about a D-Bus property on a D-Bus interface.
 125  *
 126  * Since: 2.26
 127  */
 128 struct _GDBusPropertyInfo
 129 {
 130   /*< public >*/
 131   volatile gint             ref_count;
 132   gchar                    *name;
 133   gchar                    *signature;
 134   GDBusPropertyInfoFlags    flags;
 135   GDBusAnnotationInfo     **annotations;
 136 };
 137
 138 /**
 139  * GDBusInterfaceInfo:
 140  * @ref_count: The reference count or -1 if statically allocated.
 141  * @name: The name of the D-Bus interface, e.g. "org.freedesktop.DBus.Properties".
 142  * @methods: (array zero-terminated=1): A pointer to a %NULL-terminated array of pointers to #GDBusMethodInfo structures or %NULL if there are no methods.
 143  * @signals: (array zero-terminated=1): A pointer to a %NULL-terminated array of pointers to #GDBusSignalInfo structures or %NULL if there are no signals.
 144  * @properties: (array zero-terminated=1): A pointer to a %NULL-terminated array of pointers to #GDBusPropertyInfo structures or %NULL if there are no properties.
 145  * @annotations: (array zero-terminated=1): A pointer to a %NULL-terminated array of pointers to #GDBusAnnotationInfo structures or %NULL if there are no annotations.
 146  *
 147  * Information about a D-Bus interface.
 148  *
 149  * Since: 2.26
 150  */
 151 struct _GDBusInterfaceInfo
 152 {
 153   /*< public >*/
 154   volatile gint         ref_count;
 155   gchar                *name;
 156   GDBusMethodInfo     **methods;
 157   GDBusSignalInfo     **signals;
 158   GDBusPropertyInfo   **properties;
 159   GDBusAnnotationInfo **annotations;
 160 };
 161
 162 /**
 163  * GDBusNodeInfo:
 164  * @ref_count: The reference count or -1 if statically allocated.
 165  * @path: The path of the node or %NULL if omitted. Note that this may be a relative path. See the D-Bus specification for more details.
 166  * @interfaces: (array zero-terminated=1): A pointer to a %NULL-terminated array of pointers to #GDBusInterfaceInfo structures or %NULL if there are no interfaces.
 167  * @nodes: (array zero-terminated=1): A pointer to a %NULL-terminated array of pointers to #GDBusNodeInfo structures or %NULL if there are no nodes.
 168  * @annotations: (array zero-terminated=1): A pointer to a %NULL-terminated array of pointers to #GDBusAnnotationInfo structures or %NULL if there are no annotations.
 169  *
 170  * Information about nodes in a remote object hierarchy.
 171  *
 172  * Since: 2.26
 173  */
 174 struct _GDBusNodeInfo
 175 {
 176   /*< public >*/
 177   volatile gint         ref_count;
 178   gchar                *path;
 179   GDBusInterfaceInfo  **interfaces;
 180   GDBusNodeInfo       **nodes;
 181   GDBusAnnotationInfo **annotations;
 182 };
 183
 184 const gchar        *g_dbus_annotation_info_lookup          (GDBusAnnotationInfo **annotations,
 185                                                             const gchar          *name);
 186 GDBusMethodInfo    *g_dbus_interface_info_lookup_method    (GDBusInterfaceInfo   *info,
 187                                                             const gchar          *name);
 188 GDBusSignalInfo    *g_dbus_interface_info_lookup_signal    (GDBusInterfaceInfo   *info,
 189                                                             const gchar          *name);
 190 GDBusPropertyInfo  *g_dbus_interface_info_lookup_property  (GDBusInterfaceInfo   *info,
 191                                                             const gchar          *name);
 192 void                g_dbus_interface_info_cache_build      (GDBusInterfaceInfo   *info);
 193 void                g_dbus_interface_info_cache_release    (GDBusInterfaceInfo   *info);
 194
 195 void                g_dbus_interface_info_generate_xml     (GDBusInterfaceInfo   *info,
 196                                                             guint                 indent,
 197                                                             GString              *string_builder);
 198
 199 GDBusNodeInfo      *g_dbus_node_info_new_for_xml           (const gchar          *xml_data,
 200                                                             GError              **error);
 201 GDBusInterfaceInfo *g_dbus_node_info_lookup_interface      (GDBusNodeInfo        *info,
 202                                                             const gchar          *name);
 203 void                g_dbus_node_info_generate_xml          (GDBusNodeInfo        *info,
 204                                                             guint                 indent,
 205                                                             GString              *string_builder);
 206
 207 GDBusNodeInfo       *g_dbus_node_info_ref                  (GDBusNodeInfo        *info);
 208 GDBusInterfaceInfo  *g_dbus_interface_info_ref             (GDBusInterfaceInfo   *info);
 209 GDBusMethodInfo     *g_dbus_method_info_ref                (GDBusMethodInfo      *info);
 210 GDBusSignalInfo     *g_dbus_signal_info_ref                (GDBusSignalInfo      *info);
 211 GDBusPropertyInfo   *g_dbus_property_info_ref              (GDBusPropertyInfo    *info);
 212 GDBusArgInfo        *g_dbus_arg_info_ref                   (GDBusArgInfo         *info);
 213 GDBusAnnotationInfo *g_dbus_annotation_info_ref            (GDBusAnnotationInfo  *info);
 214
 215 void                 g_dbus_node_info_unref                (GDBusNodeInfo        *info);
 216 void                 g_dbus_interface_info_unref           (GDBusInterfaceInfo   *info);
 217 void                 g_dbus_method_info_unref              (GDBusMethodInfo      *info);
 218 void                 g_dbus_signal_info_unref              (GDBusSignalInfo      *info);
 219 void                 g_dbus_property_info_unref            (GDBusPropertyInfo    *info);
 220 void                 g_dbus_arg_info_unref                 (GDBusArgInfo         *info);
 221 void                 g_dbus_annotation_info_unref          (GDBusAnnotationInfo  *info);
 222
 223 /**
 224  * G_TYPE_DBUS_NODE_INFO:
 225  *
 226  * The #GType for a boxed type holding a #GDBusNodeInfo.
 227  *
 228  * Since: 2.26
 229  */
 230 #define G_TYPE_DBUS_NODE_INFO       (g_dbus_node_info_get_type ())
 231
 232 /**
 233  * G_TYPE_DBUS_INTERFACE_INFO:
 234  *
 235  * The #GType for a boxed type holding a #GDBusInterfaceInfo.
 236  *
 237  * Since: 2.26
 238  */
 239 #define G_TYPE_DBUS_INTERFACE_INFO  (g_dbus_interface_info_get_type ())
 240
 241 /**
 242  * G_TYPE_DBUS_METHOD_INFO:
 243  *
 244  * The #GType for a boxed type holding a #GDBusMethodInfo.
 245  *
 246  * Since: 2.26
 247  */
 248 #define G_TYPE_DBUS_METHOD_INFO     (g_dbus_method_info_get_type ())
 249
 250 /**
 251  * G_TYPE_DBUS_SIGNAL_INFO:
 252  *
 253  * The #GType for a boxed type holding a #GDBusSignalInfo.
 254  *
 255  * Since: 2.26
 256  */
 257 #define G_TYPE_DBUS_SIGNAL_INFO     (g_dbus_signal_info_get_type ())
 258
 259 /**
 260  * G_TYPE_DBUS_PROPERTY_INFO:
 261  *
 262  * The #GType for a boxed type holding a #GDBusPropertyInfo.
 263  *
 264  * Since: 2.26
 265  */
 266 #define G_TYPE_DBUS_PROPERTY_INFO   (g_dbus_property_info_get_type ())
 267
 268 /**
 269  * G_TYPE_DBUS_ARG_INFO:
 270  *
 271  * The #GType for a boxed type holding a #GDBusArgInfo.
 272  *
 273  * Since: 2.26
 274  */
 275 #define G_TYPE_DBUS_ARG_INFO        (g_dbus_arg_info_get_type ())
 276
 277 /**
 278  * G_TYPE_DBUS_ANNOTATION_INFO:
 279  *
 280  * The #GType for a boxed type holding a #GDBusAnnotationInfo.
 281  *
 282  * Since: 2.26
 283  */
 284 #define G_TYPE_DBUS_ANNOTATION_INFO (g_dbus_annotation_info_get_type ())
 285
 286 GType g_dbus_node_info_get_type       (void) G_GNUC_CONST;
 287 GType g_dbus_interface_info_get_type  (void) G_GNUC_CONST;
 288 GType g_dbus_method_info_get_type     (void) G_GNUC_CONST;
 289 GType g_dbus_signal_info_get_type     (void) G_GNUC_CONST;
 290 GType g_dbus_property_info_get_type   (void) G_GNUC_CONST;
 291 GType g_dbus_arg_info_get_type        (void) G_GNUC_CONST;
 292 GType g_dbus_annotation_info_get_type (void) G_GNUC_CONST;
 293
 294 G_END_DECLS
 295
 296 #endif /* __G_DBUS_INTROSPECTION_H__ */