[kdbus] KDBUS_ITEM_PAYLOAD_OFF items are (once again) relative to msg header
[platform/upstream/glib.git] / gio / gdbusintrospection.h
index 2c02421..edaf63e 100644 (file)
  * Lesser General Public License for more details.
  *
  * You should have received a copy of the GNU Lesser General
- * Public License along with this library; if not, write to the
- * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
- * Boston, MA 02111-1307, USA.
+ * Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
  *
  * Author: David Zeuthen <davidz@redhat.com>
  */
 
+#ifndef __G_DBUS_INTROSPECTION_H__
+#define __G_DBUS_INTROSPECTION_H__
+
 #if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
 #error "Only <gio/gio.h> can be included directly."
 #endif
 
-#ifndef __G_DBUS_INTROSPECTION_H__
-#define __G_DBUS_INTROSPECTION_H__
-
 #include <gio/giotypes.h>
 
 G_BEGIN_DECLS
@@ -36,7 +34,7 @@ G_BEGIN_DECLS
  * @ref_count: The reference count or -1 if statically allocated.
  * @key: The name of the annotation, e.g. "org.freedesktop.DBus.Deprecated".
  * @value: The value of the annotation.
- * @annotations: A pointer to a %NULL-terminated array of pointers to #GDBusAnnotationInfo structures or %NULL if there are no annotations.
+ * @annotations: (array zero-terminated=1): A pointer to a %NULL-terminated array of pointers to #GDBusAnnotationInfo structures or %NULL if there are no annotations.
  *
  * Information about an annotation.
  *
@@ -44,6 +42,7 @@ G_BEGIN_DECLS
  */
 struct _GDBusAnnotationInfo
 {
+  /*< public >*/
   volatile gint         ref_count;
   gchar                *key;
   gchar                *value;
@@ -55,7 +54,7 @@ struct _GDBusAnnotationInfo
  * @ref_count: The reference count or -1 if statically allocated.
  * @name: Name of the argument, e.g. @unix_user_id.
  * @signature: D-Bus signature of the argument (a single complete type).
- * @annotations: A pointer to a %NULL-terminated array of pointers to #GDBusAnnotationInfo structures or %NULL if there are no annotations.
+ * @annotations: (array zero-terminated=1): A pointer to a %NULL-terminated array of pointers to #GDBusAnnotationInfo structures or %NULL if there are no annotations.
  *
  * Information about an argument for a method or a signal.
  *
@@ -63,6 +62,7 @@ struct _GDBusAnnotationInfo
  */
 struct _GDBusArgInfo
 {
+  /*< public >*/
   volatile gint         ref_count;
   gchar                *name;
   gchar                *signature;
@@ -73,9 +73,9 @@ struct _GDBusArgInfo
  * GDBusMethodInfo:
  * @ref_count: The reference count or -1 if statically allocated.
  * @name: The name of the D-Bus method, e.g. @RequestName.
- * @in_args: A pointer to a %NULL-terminated array of pointers to #GDBusArgInfo structures or %NULL if there are no in arguments.
- * @out_args: A pointer to a %NULL-terminated array of pointers to #GDBusArgInfo structures or %NULL if there are no out arguments.
- * @annotations: A pointer to a %NULL-terminated array of pointers to #GDBusAnnotationInfo structures or %NULL if there are no annotations.
+ * @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.
+ * @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.
+ * @annotations: (array zero-terminated=1): A pointer to a %NULL-terminated array of pointers to #GDBusAnnotationInfo structures or %NULL if there are no annotations.
  *
  * Information about a method on an D-Bus interface.
  *
@@ -83,6 +83,7 @@ struct _GDBusArgInfo
  */
 struct _GDBusMethodInfo
 {
+  /*< public >*/
   volatile gint         ref_count;
   gchar                *name;
   GDBusArgInfo        **in_args;
@@ -94,8 +95,8 @@ struct _GDBusMethodInfo
  * GDBusSignalInfo:
  * @ref_count: The reference count or -1 if statically allocated.
  * @name: The name of the D-Bus signal, e.g. "NameOwnerChanged".
- * @args: A pointer to a %NULL-terminated array of pointers to #GDBusArgInfo structures or %NULL if there are no arguments.
- * @annotations: A pointer to a %NULL-terminated array of pointers to #GDBusAnnotationInfo structures or %NULL if there are no annotations.
+ * @args: (array zero-terminated=1): A pointer to a %NULL-terminated array of pointers to #GDBusArgInfo structures or %NULL if there are no arguments.
+ * @annotations: (array zero-terminated=1): A pointer to a %NULL-terminated array of pointers to #GDBusAnnotationInfo structures or %NULL if there are no annotations.
  *
  * Information about a signal on a D-Bus interface.
  *
@@ -103,6 +104,7 @@ struct _GDBusMethodInfo
  */
 struct _GDBusSignalInfo
 {
+  /*< public >*/
   volatile gint         ref_count;
   gchar                *name;
   GDBusArgInfo        **args;
@@ -115,7 +117,7 @@ struct _GDBusSignalInfo
  * @name: The name of the D-Bus property, e.g. "SupportedFilesystems".
  * @signature: The D-Bus signature of the property (a single complete type).
  * @flags: Access control flags for the property.
- * @annotations: A pointer to a %NULL-terminated array of pointers to #GDBusAnnotationInfo structures or %NULL if there are no annotations.
+ * @annotations: (array zero-terminated=1): A pointer to a %NULL-terminated array of pointers to #GDBusAnnotationInfo structures or %NULL if there are no annotations.
  *
  * Information about a D-Bus property on a D-Bus interface.
  *
@@ -123,6 +125,7 @@ struct _GDBusSignalInfo
  */
 struct _GDBusPropertyInfo
 {
+  /*< public >*/
   volatile gint             ref_count;
   gchar                    *name;
   gchar                    *signature;
@@ -134,10 +137,10 @@ struct _GDBusPropertyInfo
  * GDBusInterfaceInfo:
  * @ref_count: The reference count or -1 if statically allocated.
  * @name: The name of the D-Bus interface, e.g. "org.freedesktop.DBus.Properties".
- * @methods: A pointer to a %NULL-terminated array of pointers to #GDBusMethodInfo structures or %NULL if there are no methods.
- * @signals: A pointer to a %NULL-terminated array of pointers to #GDBusSignalInfo structures or %NULL if there are no signals.
- * @properties: A pointer to a %NULL-terminated array of pointers to #GDBusPropertyInfo structures or %NULL if there are no properties.
- * @annotations: A pointer to a %NULL-terminated array of pointers to #GDBusAnnotationInfo structures or %NULL if there are no annotations.
+ * @methods: (array zero-terminated=1): A pointer to a %NULL-terminated array of pointers to #GDBusMethodInfo structures or %NULL if there are no methods.
+ * @signals: (array zero-terminated=1): A pointer to a %NULL-terminated array of pointers to #GDBusSignalInfo structures or %NULL if there are no signals.
+ * @properties: (array zero-terminated=1): A pointer to a %NULL-terminated array of pointers to #GDBusPropertyInfo structures or %NULL if there are no properties.
+ * @annotations: (array zero-terminated=1): A pointer to a %NULL-terminated array of pointers to #GDBusAnnotationInfo structures or %NULL if there are no annotations.
  *
  * Information about a D-Bus interface.
  *
@@ -145,6 +148,7 @@ struct _GDBusPropertyInfo
  */
 struct _GDBusInterfaceInfo
 {
+  /*< public >*/
   volatile gint         ref_count;
   gchar                *name;
   GDBusMethodInfo     **methods;
@@ -157,9 +161,9 @@ struct _GDBusInterfaceInfo
  * GDBusNodeInfo:
  * @ref_count: The reference count or -1 if statically allocated.
  * @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.
- * @interfaces: A pointer to a %NULL-terminated array of pointers to #GDBusInterfaceInfo structures or %NULL if there are no interfaces.
- * @nodes: A pointer to a %NULL-terminated array of pointers to #GDBusNodeInfo structures or %NULL if there are no nodes.
- * @annotations: A pointer to a %NULL-terminated array of pointers to #GDBusAnnotationInfo structures or %NULL if there are no annotations.
+ * @interfaces: (array zero-terminated=1): A pointer to a %NULL-terminated array of pointers to #GDBusInterfaceInfo structures or %NULL if there are no interfaces.
+ * @nodes: (array zero-terminated=1): A pointer to a %NULL-terminated array of pointers to #GDBusNodeInfo structures or %NULL if there are no nodes.
+ * @annotations: (array zero-terminated=1): A pointer to a %NULL-terminated array of pointers to #GDBusAnnotationInfo structures or %NULL if there are no annotations.
  *
  * Information about nodes in a remote object hierarchy.
  *
@@ -167,6 +171,7 @@ struct _GDBusInterfaceInfo
  */
 struct _GDBusNodeInfo
 {
+  /*< public >*/
   volatile gint         ref_count;
   gchar                *path;
   GDBusInterfaceInfo  **interfaces;
@@ -174,40 +179,67 @@ struct _GDBusNodeInfo
   GDBusAnnotationInfo **annotations;
 };
 
+GLIB_AVAILABLE_IN_ALL
 const gchar        *g_dbus_annotation_info_lookup          (GDBusAnnotationInfo **annotations,
                                                             const gchar          *name);
+GLIB_AVAILABLE_IN_ALL
 GDBusMethodInfo    *g_dbus_interface_info_lookup_method    (GDBusInterfaceInfo   *info,
                                                             const gchar          *name);
+GLIB_AVAILABLE_IN_ALL
 GDBusSignalInfo    *g_dbus_interface_info_lookup_signal    (GDBusInterfaceInfo   *info,
                                                             const gchar          *name);
+GLIB_AVAILABLE_IN_ALL
 GDBusPropertyInfo  *g_dbus_interface_info_lookup_property  (GDBusInterfaceInfo   *info,
                                                             const gchar          *name);
+GLIB_AVAILABLE_IN_ALL
+void                g_dbus_interface_info_cache_build      (GDBusInterfaceInfo   *info);
+GLIB_AVAILABLE_IN_ALL
+void                g_dbus_interface_info_cache_release    (GDBusInterfaceInfo   *info);
+
+GLIB_AVAILABLE_IN_ALL
 void                g_dbus_interface_info_generate_xml     (GDBusInterfaceInfo   *info,
                                                             guint                 indent,
                                                             GString              *string_builder);
 
+GLIB_AVAILABLE_IN_ALL
 GDBusNodeInfo      *g_dbus_node_info_new_for_xml           (const gchar          *xml_data,
                                                             GError              **error);
+GLIB_AVAILABLE_IN_ALL
 GDBusInterfaceInfo *g_dbus_node_info_lookup_interface      (GDBusNodeInfo        *info,
                                                             const gchar          *name);
+GLIB_AVAILABLE_IN_ALL
 void                g_dbus_node_info_generate_xml          (GDBusNodeInfo        *info,
                                                             guint                 indent,
                                                             GString              *string_builder);
 
+GLIB_AVAILABLE_IN_ALL
 GDBusNodeInfo       *g_dbus_node_info_ref                  (GDBusNodeInfo        *info);
+GLIB_AVAILABLE_IN_ALL
 GDBusInterfaceInfo  *g_dbus_interface_info_ref             (GDBusInterfaceInfo   *info);
+GLIB_AVAILABLE_IN_ALL
 GDBusMethodInfo     *g_dbus_method_info_ref                (GDBusMethodInfo      *info);
+GLIB_AVAILABLE_IN_ALL
 GDBusSignalInfo     *g_dbus_signal_info_ref                (GDBusSignalInfo      *info);
+GLIB_AVAILABLE_IN_ALL
 GDBusPropertyInfo   *g_dbus_property_info_ref              (GDBusPropertyInfo    *info);
+GLIB_AVAILABLE_IN_ALL
 GDBusArgInfo        *g_dbus_arg_info_ref                   (GDBusArgInfo         *info);
+GLIB_AVAILABLE_IN_ALL
 GDBusAnnotationInfo *g_dbus_annotation_info_ref            (GDBusAnnotationInfo  *info);
 
+GLIB_AVAILABLE_IN_ALL
 void                 g_dbus_node_info_unref                (GDBusNodeInfo        *info);
+GLIB_AVAILABLE_IN_ALL
 void                 g_dbus_interface_info_unref           (GDBusInterfaceInfo   *info);
+GLIB_AVAILABLE_IN_ALL
 void                 g_dbus_method_info_unref              (GDBusMethodInfo      *info);
+GLIB_AVAILABLE_IN_ALL
 void                 g_dbus_signal_info_unref              (GDBusSignalInfo      *info);
+GLIB_AVAILABLE_IN_ALL
 void                 g_dbus_property_info_unref            (GDBusPropertyInfo    *info);
+GLIB_AVAILABLE_IN_ALL
 void                 g_dbus_arg_info_unref                 (GDBusArgInfo         *info);
+GLIB_AVAILABLE_IN_ALL
 void                 g_dbus_annotation_info_unref          (GDBusAnnotationInfo  *info);
 
 /**
@@ -273,12 +305,19 @@ void                 g_dbus_annotation_info_unref          (GDBusAnnotationInfo
  */
 #define G_TYPE_DBUS_ANNOTATION_INFO (g_dbus_annotation_info_get_type ())
 
+GLIB_AVAILABLE_IN_ALL
 GType g_dbus_node_info_get_type       (void) G_GNUC_CONST;
+GLIB_AVAILABLE_IN_ALL
 GType g_dbus_interface_info_get_type  (void) G_GNUC_CONST;
+GLIB_AVAILABLE_IN_ALL
 GType g_dbus_method_info_get_type     (void) G_GNUC_CONST;
+GLIB_AVAILABLE_IN_ALL
 GType g_dbus_signal_info_get_type     (void) G_GNUC_CONST;
+GLIB_AVAILABLE_IN_ALL
 GType g_dbus_property_info_get_type   (void) G_GNUC_CONST;
+GLIB_AVAILABLE_IN_ALL
 GType g_dbus_arg_info_get_type        (void) G_GNUC_CONST;
+GLIB_AVAILABLE_IN_ALL
 GType g_dbus_annotation_info_get_type (void) G_GNUC_CONST;
 
 G_END_DECLS