1 /* GDBus - GLib D-Bus Library
3 * Copyright (C) 2008-2010 Red Hat, Inc.
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.
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.
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.
20 * Author: David Zeuthen <davidz@redhat.com>
23 #if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
24 #error "Only <gio/gio.h> can be included directly."
27 #ifndef __G_DBUS_INTROSPECTION_H__
28 #define __G_DBUS_INTROSPECTION_H__
30 #include <gio/giotypes.h>
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: A pointer to a %NULL-terminated array of pointers to #GDBusAnnotationInfo structures or %NULL if there are no annotations.
41 * Information about an annotation.
45 struct _GDBusAnnotationInfo
47 volatile gint ref_count
;
50 GDBusAnnotationInfo
**annotations
;
55 * @ref_count: The reference count or -1 if statically allocated.
56 * @name: Name of the argument, e.g. @unix_user_id.
57 * @signature: D-Bus signature of the argument (a single complete type).
58 * @annotations: A pointer to a %NULL-terminated array of pointers to #GDBusAnnotationInfo structures or %NULL if there are no annotations.
60 * Information about an argument for a method or a signal.
66 volatile gint ref_count
;
69 GDBusAnnotationInfo
**annotations
;
74 * @ref_count: The reference count or -1 if statically allocated.
75 * @name: The name of the D-Bus method, e.g. @RequestName.
76 * @in_args: A pointer to a %NULL-terminated array of pointers to #GDBusArgInfo structures or %NULL if there are no in arguments.
77 * @out_args: A pointer to a %NULL-terminated array of pointers to #GDBusArgInfo structures or %NULL if there are no out arguments.
78 * @annotations: A pointer to a %NULL-terminated array of pointers to #GDBusAnnotationInfo structures or %NULL if there are no annotations.
80 * Information about a method on an D-Bus interface.
84 struct _GDBusMethodInfo
86 volatile gint ref_count
;
88 GDBusArgInfo
**in_args
;
89 GDBusArgInfo
**out_args
;
90 GDBusAnnotationInfo
**annotations
;
95 * @ref_count: The reference count or -1 if statically allocated.
96 * @name: The name of the D-Bus signal, e.g. "NameOwnerChanged".
97 * @args: A pointer to a %NULL-terminated array of pointers to #GDBusArgInfo structures or %NULL if there are no arguments.
98 * @annotations: A pointer to a %NULL-terminated array of pointers to #GDBusAnnotationInfo structures or %NULL if there are no annotations.
100 * Information about a signal on a D-Bus interface.
104 struct _GDBusSignalInfo
106 volatile gint ref_count
;
109 GDBusAnnotationInfo
**annotations
;
114 * @ref_count: The reference count or -1 if statically allocated.
115 * @name: The name of the D-Bus property, e.g. "SupportedFilesystems".
116 * @signature: The D-Bus signature of the property (a single complete type).
117 * @flags: Access control flags for the property.
118 * @annotations: A pointer to a %NULL-terminated array of pointers to #GDBusAnnotationInfo structures or %NULL if there are no annotations.
120 * Information about a D-Bus property on a D-Bus interface.
124 struct _GDBusPropertyInfo
126 volatile gint ref_count
;
129 GDBusPropertyInfoFlags flags
;
130 GDBusAnnotationInfo
**annotations
;
134 * GDBusInterfaceInfo:
135 * @ref_count: The reference count or -1 if statically allocated.
136 * @name: The name of the D-Bus interface, e.g. "org.freedesktop.DBus.Properties".
137 * @methods: A pointer to a %NULL-terminated array of pointers to #GDBusMethodInfo structures or %NULL if there are no methods.
138 * @signals: A pointer to a %NULL-terminated array of pointers to #GDBusSignalInfo structures or %NULL if there are no signals.
139 * @properties: A pointer to a %NULL-terminated array of pointers to #GDBusPropertyInfo structures or %NULL if there are no properties.
140 * @annotations: A pointer to a %NULL-terminated array of pointers to #GDBusAnnotationInfo structures or %NULL if there are no annotations.
142 * Information about a D-Bus interface.
146 struct _GDBusInterfaceInfo
148 volatile gint ref_count
;
150 GDBusMethodInfo
**methods
;
151 GDBusSignalInfo
**signals
;
152 GDBusPropertyInfo
**properties
;
153 GDBusAnnotationInfo
**annotations
;
158 * @ref_count: The reference count or -1 if statically allocated.
159 * @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.
160 * @interfaces: A pointer to a %NULL-terminated array of pointers to #GDBusInterfaceInfo structures or %NULL if there are no interfaces.
161 * @nodes: A pointer to a %NULL-terminated array of pointers to #GDBusNodeInfo structures or %NULL if there are no nodes.
162 * @annotations: A pointer to a %NULL-terminated array of pointers to #GDBusAnnotationInfo structures or %NULL if there are no annotations.
164 * Information about nodes in a remote object hierarchy.
168 struct _GDBusNodeInfo
170 volatile gint ref_count
;
172 GDBusInterfaceInfo
**interfaces
;
173 GDBusNodeInfo
**nodes
;
174 GDBusAnnotationInfo
**annotations
;
177 const gchar
*g_dbus_annotation_info_lookup (GDBusAnnotationInfo
**annotations
,
179 GDBusMethodInfo
*g_dbus_interface_info_lookup_method (GDBusInterfaceInfo
*info
,
181 GDBusSignalInfo
*g_dbus_interface_info_lookup_signal (GDBusInterfaceInfo
*info
,
183 GDBusPropertyInfo
*g_dbus_interface_info_lookup_property (GDBusInterfaceInfo
*info
,
185 void g_dbus_interface_info_generate_xml (GDBusInterfaceInfo
*info
,
187 GString
*string_builder
);
189 GDBusNodeInfo
*g_dbus_node_info_new_for_xml (const gchar
*xml_data
,
191 GDBusInterfaceInfo
*g_dbus_node_info_lookup_interface (GDBusNodeInfo
*info
,
193 void g_dbus_node_info_generate_xml (GDBusNodeInfo
*info
,
195 GString
*string_builder
);
197 GDBusNodeInfo
*g_dbus_node_info_ref (GDBusNodeInfo
*info
);
198 GDBusInterfaceInfo
*g_dbus_interface_info_ref (GDBusInterfaceInfo
*info
);
199 GDBusMethodInfo
*g_dbus_method_info_ref (GDBusMethodInfo
*info
);
200 GDBusSignalInfo
*g_dbus_signal_info_ref (GDBusSignalInfo
*info
);
201 GDBusPropertyInfo
*g_dbus_property_info_ref (GDBusPropertyInfo
*info
);
202 GDBusArgInfo
*g_dbus_arg_info_ref (GDBusArgInfo
*info
);
203 GDBusAnnotationInfo
*g_dbus_annotation_info_ref (GDBusAnnotationInfo
*info
);
205 void g_dbus_node_info_unref (GDBusNodeInfo
*info
);
206 void g_dbus_interface_info_unref (GDBusInterfaceInfo
*info
);
207 void g_dbus_method_info_unref (GDBusMethodInfo
*info
);
208 void g_dbus_signal_info_unref (GDBusSignalInfo
*info
);
209 void g_dbus_property_info_unref (GDBusPropertyInfo
*info
);
210 void g_dbus_arg_info_unref (GDBusArgInfo
*info
);
211 void g_dbus_annotation_info_unref (GDBusAnnotationInfo
*info
);
214 * G_TYPE_DBUS_NODE_INFO:
216 * The #GType for a boxed type holding a #GDBusNodeInfo.
220 #define G_TYPE_DBUS_NODE_INFO (g_dbus_node_info_get_type ())
223 * G_TYPE_DBUS_INTERFACE_INFO:
225 * The #GType for a boxed type holding a #GDBusInterfaceInfo.
229 #define G_TYPE_DBUS_INTERFACE_INFO (g_dbus_interface_info_get_type ())
232 * G_TYPE_DBUS_METHOD_INFO:
234 * The #GType for a boxed type holding a #GDBusMethodInfo.
238 #define G_TYPE_DBUS_METHOD_INFO (g_dbus_method_info_get_type ())
241 * G_TYPE_DBUS_SIGNAL_INFO:
243 * The #GType for a boxed type holding a #GDBusSignalInfo.
247 #define G_TYPE_DBUS_SIGNAL_INFO (g_dbus_signal_info_get_type ())
250 * G_TYPE_DBUS_PROPERTY_INFO:
252 * The #GType for a boxed type holding a #GDBusPropertyInfo.
256 #define G_TYPE_DBUS_PROPERTY_INFO (g_dbus_property_info_get_type ())
259 * G_TYPE_DBUS_ARG_INFO:
261 * The #GType for a boxed type holding a #GDBusArgInfo.
265 #define G_TYPE_DBUS_ARG_INFO (g_dbus_arg_info_get_type ())
268 * G_TYPE_DBUS_ANNOTATION_INFO:
270 * The #GType for a boxed type holding a #GDBusAnnotationInfo.
274 #define G_TYPE_DBUS_ANNOTATION_INFO (g_dbus_annotation_info_get_type ())
276 GType
g_dbus_node_info_get_type (void) G_GNUC_CONST
;
277 GType
g_dbus_interface_info_get_type (void) G_GNUC_CONST
;
278 GType
g_dbus_method_info_get_type (void) G_GNUC_CONST
;
279 GType
g_dbus_signal_info_get_type (void) G_GNUC_CONST
;
280 GType
g_dbus_property_info_get_type (void) G_GNUC_CONST
;
281 GType
g_dbus_arg_info_get_type (void) G_GNUC_CONST
;
282 GType
g_dbus_annotation_info_get_type (void) G_GNUC_CONST
;
286 #endif /* __G_DBUS_INTROSPECTION_H__ */