3 # GDBus - GLib D-Bus Library
5 # Copyright (C) 2008-2011 Red Hat, Inc.
7 # This library is free software; you can redistribute it and/or
8 # modify it under the terms of the GNU Lesser General Public
9 # License as published by the Free Software Foundation; either
10 # version 2 of the License, or (at your option) any later version.
12 # This library is distributed in the hope that it will be useful,
13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 # Lesser General Public License for more details.
17 # You should have received a copy of the GNU Lesser General
18 # Public License along with this library; if not, write to the
19 # Free Software Foundation, Inc., 59 Temple Place, Suite 330,
20 # Boston, MA 02111-1307, USA.
22 # Author: David Zeuthen <davidz@redhat.com>
30 # ----------------------------------------------------------------------------------------------------
33 def __init__(self, ifaces, namespace, interface_prefix, generate_objmanager, docbook_gen, h, c):
34 self.docbook_gen = docbook_gen
35 self.generate_objmanager = generate_objmanager
39 self.namespace = namespace
40 if len(namespace) > 1:
41 self.ns_upper = utils.camel_case_to_uscore(namespace).upper() + '_'
42 self.ns_lower = utils.camel_case_to_uscore(namespace).lower() + '_'
46 self.interface_prefix = interface_prefix
47 self.header_guard = self.h.name.upper().replace('.', '_').replace('-', '_')
49 # ----------------------------------------------------------------------------------------------------
51 def generate_intro(self):
53 ' * Generated by gdbus-codegen %s. DO NOT EDIT.\n'
55 ' * The license of this code is the same as for the source it was derived from.\n'
59 self.c.write('#ifdef HAVE_CONFIG_H\n'
60 '# include "config.h"\n'
66 self.c.write('#ifdef G_OS_UNIX\n'
67 '# include <gio/gunixfdlist.h>\n'
71 self.c.write('typedef struct\n'
73 ' GDBusArgInfo parent_struct;\n'
74 ' gboolean use_gvariant;\n'
75 '} _ExtendedGDBusArgInfo;\n'
78 self.c.write('typedef struct\n'
80 ' GDBusMethodInfo parent_struct;\n'
81 ' const gchar *signal_name;\n'
82 ' gboolean pass_fdlist;\n'
83 '} _ExtendedGDBusMethodInfo;\n'
86 self.c.write('typedef struct\n'
88 ' GDBusSignalInfo parent_struct;\n'
89 ' const gchar *signal_name;\n'
90 '} _ExtendedGDBusSignalInfo;\n'
93 self.c.write('typedef struct\n'
95 ' GDBusPropertyInfo parent_struct;\n'
96 ' const gchar *hyphen_name;\n'
97 ' gboolean use_gvariant;\n'
98 '} _ExtendedGDBusPropertyInfo;\n'
101 self.c.write('typedef struct\n'
103 ' GDBusInterfaceInfo parent_struct;\n'
104 ' const gchar *hyphen_name;\n'
105 '} _ExtendedGDBusInterfaceInfo;\n'
108 self.c.write('typedef struct\n'
110 ' const _ExtendedGDBusPropertyInfo *info;\n'
112 ' GValue orig_value; /* the value before the change */\n'
113 '} ChangedProperty;\n'
116 '_changed_property_free (ChangedProperty *data)\n'
118 ' g_value_unset (&data->orig_value);\n'
123 self.c.write('static gboolean\n'
124 '_g_strv_equal0 (gchar **a, gchar **b)\n'
126 ' gboolean ret = FALSE;\n'
128 ' if (a == NULL && b == NULL)\n'
133 ' if (a == NULL || b == NULL)\n'
135 ' if (g_strv_length (a) != g_strv_length (b))\n'
137 ' for (n = 0; a[n] != NULL; n++)\n'
138 ' if (g_strcmp0 (a[n], b[n]) != 0)\n'
146 self.c.write('static gboolean\n'
147 '_g_variant_equal0 (GVariant *a, GVariant *b)\n'
149 ' gboolean ret = FALSE;\n'
150 ' if (a == NULL && b == NULL)\n'
155 ' if (a == NULL || b == NULL)\n'
157 ' ret = g_variant_equal (a, b);\n'
163 # simplified - only supports the types we use
164 self.c.write('G_GNUC_UNUSED static gboolean\n'
165 '_g_value_equal (const GValue *a, const GValue *b)\n'
167 ' gboolean ret = FALSE;\n'
168 ' g_assert (G_VALUE_TYPE (a) == G_VALUE_TYPE (b));\n'
169 ' switch (G_VALUE_TYPE (a))\n'
171 ' case G_TYPE_BOOLEAN:\n'
172 ' ret = (g_value_get_boolean (a) == g_value_get_boolean (b));\n'
174 ' case G_TYPE_UCHAR:\n'
175 ' ret = (g_value_get_uchar (a) == g_value_get_uchar (b));\n'
177 ' case G_TYPE_INT:\n'
178 ' ret = (g_value_get_int (a) == g_value_get_int (b));\n'
180 ' case G_TYPE_UINT:\n'
181 ' ret = (g_value_get_uint (a) == g_value_get_uint (b));\n'
183 ' case G_TYPE_INT64:\n'
184 ' ret = (g_value_get_int64 (a) == g_value_get_int64 (b));\n'
186 ' case G_TYPE_UINT64:\n'
187 ' ret = (g_value_get_uint64 (a) == g_value_get_uint64 (b));\n'
189 ' case G_TYPE_DOUBLE:\n'
190 ' ret = (g_value_get_double (a) == g_value_get_double (b));\n'
192 ' case G_TYPE_STRING:\n'
193 ' ret = (g_strcmp0 (g_value_get_string (a), g_value_get_string (b)) == 0);\n'
195 ' case G_TYPE_VARIANT:\n'
196 ' ret = _g_variant_equal0 (g_value_get_variant (a), g_value_get_variant (b));\n'
199 ' if (G_VALUE_TYPE (a) == G_TYPE_STRV)\n'
200 ' ret = _g_strv_equal0 (g_value_get_boxed (a), g_value_get_boxed (b));\n'
202 ' g_critical ("_g_value_equal() does not handle type %s", g_type_name (G_VALUE_TYPE (a)));\n'
210 ' * Generated by gdbus-codegen %s. DO NOT EDIT.\n'
212 ' * The license of this code is the same as for the source it was derived from.\n'
217 '\n'%(config.VERSION, self.header_guard, self.header_guard))
218 self.h.write('#include <gio/gio.h>\n'
223 # ----------------------------------------------------------------------------------------------------
225 def declare_types(self):
226 for i in self.ifaces:
228 self.h.write('/* ------------------------------------------------------------------------ */\n')
229 self.h.write('/* Declarations for %s */\n'%i.name)
232 # First the GInterface
233 self.h.write('#define %sTYPE_%s (%s_get_type ())\n'%(i.ns_upper, i.name_upper, i.name_lower))
234 self.h.write('#define %s%s(o) (G_TYPE_CHECK_INSTANCE_CAST ((o), %sTYPE_%s, %s))\n'%(i.ns_upper, i.name_upper, i.ns_upper, i.name_upper, i.camel_name))
235 self.h.write('#define %sIS_%s(o) (G_TYPE_CHECK_INSTANCE_TYPE ((o), %sTYPE_%s))\n'%(i.ns_upper, i.name_upper, i.ns_upper, i.name_upper))
236 self.h.write('#define %s%s_GET_IFACE(o) (G_TYPE_INSTANCE_GET_INTERFACE ((o), %sTYPE_%s, %s))\n'%(i.ns_upper, i.name_upper, i.ns_upper, i.name_upper, i.camel_name))
238 self.h.write('struct _%s;\n'%(i.camel_name))
239 self.h.write('typedef struct _%s %s;\n'%(i.camel_name, i.camel_name))
240 self.h.write('typedef struct _%sIface %sIface;\n'%(i.camel_name, i.camel_name))
242 self.h.write('struct _%sIface\n'%(i.camel_name))
244 self.h.write(' GTypeInterface parent_iface;\n')
246 function_pointers = {}
248 if len(i.methods) > 0:
252 if utils.lookup_annotation(m.annotations, 'org.gtk.GDBus.C.UnixFD'):
254 key = (m.since, '_method_%s'%m.name_lower)
255 value = ' gboolean (*handle_%s) (\n'%(m.name_lower)
256 value += ' %s *object,\n'%(i.camel_name)
257 value += ' GDBusMethodInvocation *invocation'%()
259 value += ',\n GUnixFDList *fd_list'
261 value += ',\n %s%s'%(a.ctype_in, a.name)
263 function_pointers[key] = value
265 if len(i.signals) > 0:
268 key = (s.since, '_signal_%s'%s.name_lower)
269 value = ' void (*%s) (\n'%(s.name_lower)
270 value += ' %s *object'%(i.camel_name)
272 value += ',\n %s%s'%(a.ctype_in, a.name)
274 function_pointers[key] = value
276 # Sort according to @since tag, then name.. this ensures
277 # that the function pointers don't change order assuming
278 # judicious use of @since
280 # Also use a proper version comparison function so e.g.
281 # 10.0 comes after 2.0.
283 # See https://bugzilla.gnome.org/show_bug.cgi?id=647577#c5
285 keys = function_pointers.keys()
287 keys.sort(cmp=utils.my_version_cmp)
289 self.h.write('%s'%function_pointers[key])
293 self.h.write('GType %s_get_type (void) G_GNUC_CONST;\n'%(i.name_lower))
295 self.h.write('GDBusInterfaceInfo *%s_interface_info (void);\n'%(i.name_lower))
296 if len(i.properties) > 0:
297 self.h.write('guint %s_override_properties (GObjectClass *klass, guint property_id_begin);\n'%(i.name_lower))
300 # Then method call completion functions
301 if len(i.methods) > 0:
303 self.h.write('/* D-Bus method call completion functions: */\n')
306 if utils.lookup_annotation(m.annotations, 'org.gtk.GDBus.C.UnixFD'):
309 self.h.write('G_GNUC_DEPRECATED ')
310 self.h.write('void %s_complete_%s (\n'
312 ' GDBusMethodInvocation *invocation'%(i.name_lower, m.name_lower, i.camel_name))
314 self.h.write(',\n GUnixFDList *fd_list')
316 self.h.write(',\n %s%s'%(a.ctype_in, a.name))
321 # Then signal emission functions
322 if len(i.signals) > 0:
324 self.h.write('/* D-Bus signal emissions functions: */\n')
327 self.h.write('G_GNUC_DEPRECATED ')
328 self.h.write('void %s_emit_%s (\n'
329 ' %s *object'%(i.name_lower, s.name_lower, i.camel_name))
331 self.h.write(',\n %s%s'%(a.ctype_in, a.name))
336 # Then method call declarations
337 if len(i.methods) > 0:
339 self.h.write('/* D-Bus method calls: */\n')
342 if utils.lookup_annotation(m.annotations, 'org.gtk.GDBus.C.UnixFD'):
346 self.h.write('G_GNUC_DEPRECATED ')
347 self.h.write('void %s_call_%s (\n'
348 ' %s *proxy'%(i.name_lower, m.name_lower, i.camel_name))
350 self.h.write(',\n %s%s'%(a.ctype_in, a.name))
352 self.h.write(',\n GUnixFDList *fd_list')
354 ' GCancellable *cancellable,\n'
355 ' GAsyncReadyCallback callback,\n'
356 ' gpointer user_data);\n')
360 self.h.write('G_GNUC_DEPRECATED ')
361 self.h.write('gboolean %s_call_%s_finish (\n'
362 ' %s *proxy'%(i.name_lower, m.name_lower, i.camel_name))
364 self.h.write(',\n %sout_%s'%(a.ctype_out, a.name))
366 self.h.write(',\n GUnixFDList **out_fd_list')
368 ' GAsyncResult *res,\n'
369 ' GError **error);\n')
373 self.h.write('G_GNUC_DEPRECATED ')
374 self.h.write('gboolean %s_call_%s_sync (\n'
375 ' %s *proxy'%(i.name_lower, m.name_lower, i.camel_name))
377 self.h.write(',\n %s%s'%(a.ctype_in, a.name))
379 self.h.write(',\n GUnixFDList *fd_list')
381 self.h.write(',\n %sout_%s'%(a.ctype_out, a.name))
383 self.h.write(',\n GUnixFDList **out_fd_list')
385 ' GCancellable *cancellable,\n'
386 ' GError **error);\n')
390 # Then the property accessor declarations
391 if len(i.properties) > 0:
393 self.h.write('/* D-Bus property accessors: */\n')
394 for p in i.properties:
397 self.h.write('G_GNUC_DEPRECATED ')
398 self.h.write('%s%s_get_%s (%s *object);\n'%(p.arg.ctype_in, i.name_lower, p.name_lower, i.camel_name))
401 self.h.write('G_GNUC_DEPRECATED ')
402 self.h.write('void %s_set_%s (%s *object, %svalue);\n'%(i.name_lower, p.name_lower, i.camel_name, p.arg.ctype_in, ))
407 self.h.write('/* ---- */\n')
409 self.h.write('#define %sTYPE_%s_PROXY (%s_proxy_get_type ())\n'%(i.ns_upper, i.name_upper, i.name_lower))
410 self.h.write('#define %s%s_PROXY(o) (G_TYPE_CHECK_INSTANCE_CAST ((o), %sTYPE_%s_PROXY, %sProxy))\n'%(i.ns_upper, i.name_upper, i.ns_upper, i.name_upper, i.camel_name))
411 self.h.write('#define %s%s_PROXY_CLASS(k) (G_TYPE_CHECK_CLASS_CAST ((k), %sTYPE_%s_PROXY, %sProxyClass))\n'%(i.ns_upper, i.name_upper, i.ns_upper, i.name_upper, i.camel_name))
412 self.h.write('#define %s%s_PROXY_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), %sTYPE_%s_PROXY, %sProxyClass))\n'%(i.ns_upper, i.name_upper, i.ns_upper, i.name_upper, i.camel_name))
413 self.h.write('#define %sIS_%s_PROXY(o) (G_TYPE_CHECK_INSTANCE_TYPE ((o), %sTYPE_%s_PROXY))\n'%(i.ns_upper, i.name_upper, i.ns_upper, i.name_upper))
414 self.h.write('#define %sIS_%s_PROXY_CLASS(k) (G_TYPE_CHECK_CLASS_TYPE ((k), %sTYPE_%s_PROXY))\n'%(i.ns_upper, i.name_upper, i.ns_upper, i.name_upper))
416 self.h.write('typedef struct _%sProxy %sProxy;\n'%(i.camel_name, i.camel_name))
417 self.h.write('typedef struct _%sProxyClass %sProxyClass;\n'%(i.camel_name, i.camel_name))
418 self.h.write('typedef struct _%sProxyPrivate %sProxyPrivate;\n'%(i.camel_name, i.camel_name))
420 self.h.write('struct _%sProxy\n'%(i.camel_name))
422 self.h.write(' /*< private >*/\n')
423 self.h.write(' GDBusProxy parent_instance;\n')
424 self.h.write(' %sProxyPrivate *priv;\n'%(i.camel_name))
427 self.h.write('struct _%sProxyClass\n'%(i.camel_name))
429 self.h.write(' GDBusProxyClass parent_class;\n')
432 self.h.write('GType %s_proxy_get_type (void) G_GNUC_CONST;\n'%(i.name_lower))
436 self.h.write('G_GNUC_DEPRECATED ')
437 self.h.write('void %s_proxy_new (\n'
438 ' GDBusConnection *connection,\n'
439 ' GDBusProxyFlags flags,\n'
440 ' const gchar *name,\n'
441 ' const gchar *object_path,\n'
442 ' GCancellable *cancellable,\n'
443 ' GAsyncReadyCallback callback,\n'
444 ' gpointer user_data);\n'
447 self.h.write('G_GNUC_DEPRECATED ')
448 self.h.write('%s *%s_proxy_new_finish (\n'
449 ' GAsyncResult *res,\n'
450 ' GError **error);\n'
451 %(i.camel_name, i.name_lower))
453 self.h.write('G_GNUC_DEPRECATED ')
454 self.h.write('%s *%s_proxy_new_sync (\n'
455 ' GDBusConnection *connection,\n'
456 ' GDBusProxyFlags flags,\n'
457 ' const gchar *name,\n'
458 ' const gchar *object_path,\n'
459 ' GCancellable *cancellable,\n'
460 ' GError **error);\n'
461 %(i.camel_name, i.name_lower))
464 self.h.write('G_GNUC_DEPRECATED ')
465 self.h.write('void %s_proxy_new_for_bus (\n'
466 ' GBusType bus_type,\n'
467 ' GDBusProxyFlags flags,\n'
468 ' const gchar *name,\n'
469 ' const gchar *object_path,\n'
470 ' GCancellable *cancellable,\n'
471 ' GAsyncReadyCallback callback,\n'
472 ' gpointer user_data);\n'
475 self.h.write('G_GNUC_DEPRECATED ')
476 self.h.write('%s *%s_proxy_new_for_bus_finish (\n'
477 ' GAsyncResult *res,\n'
478 ' GError **error);\n'
479 %(i.camel_name, i.name_lower))
481 self.h.write('G_GNUC_DEPRECATED ')
482 self.h.write('%s *%s_proxy_new_for_bus_sync (\n'
483 ' GBusType bus_type,\n'
484 ' GDBusProxyFlags flags,\n'
485 ' const gchar *name,\n'
486 ' const gchar *object_path,\n'
487 ' GCancellable *cancellable,\n'
488 ' GError **error);\n'
489 %(i.camel_name, i.name_lower))
494 self.h.write('/* ---- */\n')
496 self.h.write('#define %sTYPE_%s_SKELETON (%s_skeleton_get_type ())\n'%(i.ns_upper, i.name_upper, i.name_lower))
497 self.h.write('#define %s%s_SKELETON(o) (G_TYPE_CHECK_INSTANCE_CAST ((o), %sTYPE_%s_SKELETON, %sSkeleton))\n'%(i.ns_upper, i.name_upper, i.ns_upper, i.name_upper, i.camel_name))
498 self.h.write('#define %s%s_SKELETON_CLASS(k) (G_TYPE_CHECK_CLASS_CAST ((k), %sTYPE_%s_SKELETON, %sSkeletonClass))\n'%(i.ns_upper, i.name_upper, i.ns_upper, i.name_upper, i.camel_name))
499 self.h.write('#define %s%s_SKELETON_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), %sTYPE_%s_SKELETON, %sSkeletonClass))\n'%(i.ns_upper, i.name_upper, i.ns_upper, i.name_upper, i.camel_name))
500 self.h.write('#define %sIS_%s_SKELETON(o) (G_TYPE_CHECK_INSTANCE_TYPE ((o), %sTYPE_%s_SKELETON))\n'%(i.ns_upper, i.name_upper, i.ns_upper, i.name_upper))
501 self.h.write('#define %sIS_%s_SKELETON_CLASS(k) (G_TYPE_CHECK_CLASS_TYPE ((k), %sTYPE_%s_SKELETON))\n'%(i.ns_upper, i.name_upper, i.ns_upper, i.name_upper))
503 self.h.write('typedef struct _%sSkeleton %sSkeleton;\n'%(i.camel_name, i.camel_name))
504 self.h.write('typedef struct _%sSkeletonClass %sSkeletonClass;\n'%(i.camel_name, i.camel_name))
505 self.h.write('typedef struct _%sSkeletonPrivate %sSkeletonPrivate;\n'%(i.camel_name, i.camel_name))
507 self.h.write('struct _%sSkeleton\n'%(i.camel_name))
509 self.h.write(' /*< private >*/\n')
510 self.h.write(' GDBusInterfaceSkeleton parent_instance;\n')
511 self.h.write(' %sSkeletonPrivate *priv;\n'%(i.camel_name))
514 self.h.write('struct _%sSkeletonClass\n'%(i.camel_name))
516 self.h.write(' GDBusInterfaceSkeletonClass parent_class;\n')
519 self.h.write('GType %s_skeleton_get_type (void) G_GNUC_CONST;\n'%(i.name_lower))
522 self.h.write('G_GNUC_DEPRECATED ')
523 self.h.write('%s *%s_skeleton_new (void);\n'%(i.camel_name, i.name_lower))
527 # Finally, the Object, ObjectProxy, ObjectSkeleton and ObjectManagerClient
528 if self.generate_objmanager:
530 self.h.write('/* ---- */\n')
532 self.h.write('#define %sTYPE_OBJECT (%sobject_get_type ())\n'%(self.ns_upper, self.ns_lower))
533 self.h.write('#define %sOBJECT(o) (G_TYPE_CHECK_INSTANCE_CAST ((o), %sTYPE_OBJECT, %sObject))\n'%(self.ns_upper, self.ns_upper, self.namespace))
534 self.h.write('#define %sIS_OBJECT(o) (G_TYPE_CHECK_INSTANCE_TYPE ((o), %sTYPE_OBJECT))\n'%(self.ns_upper, self.ns_upper))
535 self.h.write('#define %sOBJECT_GET_IFACE(o) (G_TYPE_INSTANCE_GET_INTERFACE ((o), %sTYPE_OBJECT, %sObject))\n'%(self.ns_upper, self.ns_upper, self.namespace))
537 self.h.write('struct _%sObject;\n'%(self.namespace))
538 self.h.write('typedef struct _%sObject %sObject;\n'%(self.namespace, self.namespace))
539 self.h.write('typedef struct _%sObjectIface %sObjectIface;\n'%(self.namespace, self.namespace))
541 self.h.write('struct _%sObjectIface\n'%(self.namespace))
543 ' GTypeInterface parent_iface;\n'
546 self.h.write('GType %sobject_get_type (void) G_GNUC_CONST;\n'
549 for i in self.ifaces:
551 self.h.write('G_GNUC_DEPRECATED ')
552 self.h.write ('%s *%sobject_get_%s (%sObject *object);\n'
553 %(i.camel_name, self.ns_lower, i.name_upper.lower(), self.namespace))
554 for i in self.ifaces:
556 self.h.write('G_GNUC_DEPRECATED ')
557 self.h.write ('%s *%sobject_peek_%s (%sObject *object);\n'
558 %(i.camel_name, self.ns_lower, i.name_upper.lower(), self.namespace))
560 self.h.write('#define %sTYPE_OBJECT_PROXY (%sobject_proxy_get_type ())\n'%(self.ns_upper, self.ns_lower))
561 self.h.write('#define %sOBJECT_PROXY(o) (G_TYPE_CHECK_INSTANCE_CAST ((o), %sTYPE_OBJECT_PROXY, %sObjectProxy))\n'%(self.ns_upper, self.ns_upper, self.namespace))
562 self.h.write('#define %sOBJECT_PROXY_CLASS(k) (G_TYPE_CHECK_CLASS_CAST ((k), %sTYPE_OBJECT_PROXY, %sObjectProxyClass))\n'%(self.ns_upper, self.ns_upper, self.namespace))
563 self.h.write('#define %sOBJECT_PROXY_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), %sTYPE_OBJECT_PROXY, %sObjectProxyClass))\n'%(self.ns_upper, self.ns_upper, self.namespace))
564 self.h.write('#define %sIS_OBJECT_PROXY(o) (G_TYPE_CHECK_INSTANCE_TYPE ((o), %sTYPE_OBJECT_PROXY))\n'%(self.ns_upper, self.ns_upper))
565 self.h.write('#define %sIS_OBJECT_PROXY_CLASS(k) (G_TYPE_CHECK_CLASS_TYPE ((k), %sTYPE_OBJECT_PROXY))\n'%(self.ns_upper, self.ns_upper))
567 self.h.write('typedef struct _%sObjectProxy %sObjectProxy;\n'%(self.namespace, self.namespace))
568 self.h.write('typedef struct _%sObjectProxyClass %sObjectProxyClass;\n'%(self.namespace, self.namespace))
569 self.h.write('typedef struct _%sObjectProxyPrivate %sObjectProxyPrivate;\n'%(self.namespace, self.namespace))
571 self.h.write('struct _%sObjectProxy\n'%(self.namespace))
573 self.h.write(' /*< private >*/\n')
574 self.h.write(' GDBusObjectProxy parent_instance;\n')
575 self.h.write(' %sObjectProxyPrivate *priv;\n'%(self.namespace))
578 self.h.write('struct _%sObjectProxyClass\n'%(self.namespace))
580 self.h.write(' GDBusObjectProxyClass parent_class;\n')
583 self.h.write('GType %sobject_proxy_get_type (void) G_GNUC_CONST;\n'%(self.ns_lower))
584 self.h.write('%sObjectProxy *%sobject_proxy_new (GDBusConnection *connection, const gchar *object_path);\n'%(self.namespace, self.ns_lower))
586 self.h.write('#define %sTYPE_OBJECT_SKELETON (%sobject_skeleton_get_type ())\n'%(self.ns_upper, self.ns_lower))
587 self.h.write('#define %sOBJECT_SKELETON(o) (G_TYPE_CHECK_INSTANCE_CAST ((o), %sTYPE_OBJECT_SKELETON, %sObjectSkeleton))\n'%(self.ns_upper, self.ns_upper, self.namespace))
588 self.h.write('#define %sOBJECT_SKELETON_CLASS(k) (G_TYPE_CHECK_CLASS_CAST ((k), %sTYPE_OBJECT_SKELETON, %sObjectSkeletonClass))\n'%(self.ns_upper, self.ns_upper, self.namespace))
589 self.h.write('#define %sOBJECT_SKELETON_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), %sTYPE_OBJECT_SKELETON, %sObjectSkeletonClass))\n'%(self.ns_upper, self.ns_upper, self.namespace))
590 self.h.write('#define %sIS_OBJECT_SKELETON(o) (G_TYPE_CHECK_INSTANCE_TYPE ((o), %sTYPE_OBJECT_SKELETON))\n'%(self.ns_upper, self.ns_upper))
591 self.h.write('#define %sIS_OBJECT_SKELETON_CLASS(k) (G_TYPE_CHECK_CLASS_TYPE ((k), %sTYPE_OBJECT_SKELETON))\n'%(self.ns_upper, self.ns_upper))
593 self.h.write('typedef struct _%sObjectSkeleton %sObjectSkeleton;\n'%(self.namespace, self.namespace))
594 self.h.write('typedef struct _%sObjectSkeletonClass %sObjectSkeletonClass;\n'%(self.namespace, self.namespace))
595 self.h.write('typedef struct _%sObjectSkeletonPrivate %sObjectSkeletonPrivate;\n'%(self.namespace, self.namespace))
597 self.h.write('struct _%sObjectSkeleton\n'%(self.namespace))
599 self.h.write(' /*< private >*/\n')
600 self.h.write(' GDBusObjectSkeleton parent_instance;\n')
601 self.h.write(' %sObjectSkeletonPrivate *priv;\n'%(self.namespace))
604 self.h.write('struct _%sObjectSkeletonClass\n'%(self.namespace))
606 self.h.write(' GDBusObjectSkeletonClass parent_class;\n')
609 self.h.write('GType %sobject_skeleton_get_type (void) G_GNUC_CONST;\n'%(self.ns_lower))
610 self.h.write('%sObjectSkeleton *%sobject_skeleton_new (const gchar *object_path);\n'
611 %(self.namespace, self.ns_lower))
612 for i in self.ifaces:
614 self.h.write('G_GNUC_DEPRECATED ')
615 self.h.write ('void %sobject_skeleton_set_%s (%sObjectSkeleton *object, %s *interface_);\n'
616 %(self.ns_lower, i.name_upper.lower(), self.namespace, i.camel_name))
619 self.h.write('/* ---- */\n')
621 self.h.write('#define %sTYPE_OBJECT_MANAGER_CLIENT (%sobject_manager_client_get_type ())\n'%(self.ns_upper, self.ns_lower))
622 self.h.write('#define %sOBJECT_MANAGER_CLIENT(o) (G_TYPE_CHECK_INSTANCE_CAST ((o), %sTYPE_OBJECT_MANAGER_CLIENT, %sObjectManagerClient))\n'%(self.ns_upper, self.ns_upper, self.namespace))
623 self.h.write('#define %sOBJECT_MANAGER_CLIENT_CLASS(k) (G_TYPE_CHECK_CLASS_CAST ((k), %sTYPE_OBJECT_MANAGER_CLIENT, %sObjectManagerClientClass))\n'%(self.ns_upper, self.ns_upper, self.namespace))
624 self.h.write('#define %sOBJECT_MANAGER_CLIENT_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), %sTYPE_OBJECT_MANAGER_CLIENT, %sObjectManagerClientClass))\n'%(self.ns_upper, self.ns_upper, self.namespace))
625 self.h.write('#define %sIS_OBJECT_MANAGER_CLIENT(o) (G_TYPE_CHECK_INSTANCE_TYPE ((o), %sTYPE_OBJECT_MANAGER_CLIENT))\n'%(self.ns_upper, self.ns_upper))
626 self.h.write('#define %sIS_OBJECT_MANAGER_CLIENT_CLASS(k) (G_TYPE_CHECK_CLASS_TYPE ((k), %sTYPE_OBJECT_MANAGER_CLIENT))\n'%(self.ns_upper, self.ns_upper))
628 self.h.write('typedef struct _%sObjectManagerClient %sObjectManagerClient;\n'%(self.namespace, self.namespace))
629 self.h.write('typedef struct _%sObjectManagerClientClass %sObjectManagerClientClass;\n'%(self.namespace, self.namespace))
630 self.h.write('typedef struct _%sObjectManagerClientPrivate %sObjectManagerClientPrivate;\n'%(self.namespace, self.namespace))
632 self.h.write('struct _%sObjectManagerClient\n'%(self.namespace))
634 self.h.write(' /*< private >*/\n')
635 self.h.write(' GDBusObjectManagerClient parent_instance;\n')
636 self.h.write(' %sObjectManagerClientPrivate *priv;\n'%(self.namespace))
639 self.h.write('struct _%sObjectManagerClientClass\n'%(self.namespace))
641 self.h.write(' GDBusObjectManagerClientClass parent_class;\n')
644 self.h.write('GType %sobject_manager_client_get_type (void) G_GNUC_CONST;\n'%(self.ns_lower))
646 self.h.write('GType %sobject_manager_client_get_proxy_type (GDBusObjectManagerClient *manager, const gchar *object_path, const gchar *interface_name, gpointer user_data);\n'%(self.ns_lower))
648 self.h.write('void %sobject_manager_client_new (\n'
649 ' GDBusConnection *connection,\n'
650 ' GDBusObjectManagerClientFlags flags,\n'
651 ' const gchar *name,\n'
652 ' const gchar *object_path,\n'
653 ' GCancellable *cancellable,\n'
654 ' GAsyncReadyCallback callback,\n'
655 ' gpointer user_data);\n'
657 self.h.write('GDBusObjectManager *%sobject_manager_client_new_finish (\n'
658 ' GAsyncResult *res,\n'
659 ' GError **error);\n'
661 self.h.write('GDBusObjectManager *%sobject_manager_client_new_sync (\n'
662 ' GDBusConnection *connection,\n'
663 ' GDBusObjectManagerClientFlags flags,\n'
664 ' const gchar *name,\n'
665 ' const gchar *object_path,\n'
666 ' GCancellable *cancellable,\n'
667 ' GError **error);\n'
670 self.h.write('void %sobject_manager_client_new_for_bus (\n'
671 ' GBusType bus_type,\n'
672 ' GDBusObjectManagerClientFlags flags,\n'
673 ' const gchar *name,\n'
674 ' const gchar *object_path,\n'
675 ' GCancellable *cancellable,\n'
676 ' GAsyncReadyCallback callback,\n'
677 ' gpointer user_data);\n'
679 self.h.write('GDBusObjectManager *%sobject_manager_client_new_for_bus_finish (\n'
680 ' GAsyncResult *res,\n'
681 ' GError **error);\n'
683 self.h.write('GDBusObjectManager *%sobject_manager_client_new_for_bus_sync (\n'
684 ' GBusType bus_type,\n'
685 ' GDBusObjectManagerClientFlags flags,\n'
686 ' const gchar *name,\n'
687 ' const gchar *object_path,\n'
688 ' GCancellable *cancellable,\n'
689 ' GError **error);\n'
693 # ----------------------------------------------------------------------------------------------------
695 def generate_outro(self):
699 '#endif /* __%s__ */\n'%(self.header_guard))
701 # ----------------------------------------------------------------------------------------------------
703 def generate_annotations(self, prefix, annotations):
704 if annotations == None:
708 for a in annotations:
709 #self.generate_annotations('%s_%d'%(prefix, n), a.get_annotations())
711 # skip internal annotations
712 if a.key.startswith('org.gtk.GDBus'):
715 self.c.write('static const GDBusAnnotationInfo %s_%d =\n'
719 ' "%s",\n'%(prefix, n, a.key, a.value))
720 if len(a.annotations) == 0:
721 self.c.write(' NULL\n')
723 self.c.write(' (GDBusAnnotationInfo **) &%s_%d_pointers\n'%(prefix, n))
729 self.c.write('static const GDBusAnnotationInfo * const %s_pointers[] =\n'
732 for a in annotations:
733 if a.key.startswith('org.gtk.GDBus'):
735 self.c.write(' &%s_%d,\n'%(prefix, m))
737 self.c.write(' NULL\n'
742 def generate_args(self, prefix, args):
744 num_anno = self.generate_annotations('%s_arg_%s_annotation_info'%(prefix, a.name), a.annotations)
746 self.c.write('static const _ExtendedGDBusArgInfo %s_%s =\n'
751 ' "%s",\n'%(prefix, a.name, a.name, a.signature))
753 self.c.write(' NULL\n')
755 self.c.write(' (GDBusAnnotationInfo **) &%s_arg_%s_annotation_info_pointers\n'%(prefix, a.name))
756 self.c.write(' },\n')
757 if not utils.lookup_annotation(a.annotations, 'org.gtk.GDBus.C.ForceGVariant'):
758 self.c.write(' FALSE\n')
760 self.c.write(' TRUE\n')
765 self.c.write('static const _ExtendedGDBusArgInfo * const %s_pointers[] =\n'
768 self.c.write(' &%s_%s,\n'%(prefix, a.name))
769 self.c.write(' NULL\n'
773 def generate_introspection_for_interface(self, i):
774 self.c.write('/* ---- Introspection data for %s ---- */\n'
777 if len(i.methods) > 0:
780 if utils.lookup_annotation(m.annotations, 'org.gtk.GDBus.C.UnixFD'):
782 self.generate_args('_%s_method_info_%s_IN_ARG'%(i.name_lower, m.name_lower), m.in_args)
783 self.generate_args('_%s_method_info_%s_OUT_ARG'%(i.name_lower, m.name_lower), m.out_args)
785 num_anno = self.generate_annotations('_%s_method_%s_annotation_info'%(i.name_lower, m.name_lower), m.annotations)
787 self.c.write('static const _ExtendedGDBusMethodInfo _%s_method_info_%s =\n'
791 ' "%s",\n'%(i.name_lower, m.name_lower, m.name))
792 if len(m.in_args) == 0:
793 self.c.write(' NULL,\n')
795 self.c.write(' (GDBusArgInfo **) &_%s_method_info_%s_IN_ARG_pointers,\n'%(i.name_lower, m.name_lower))
796 if len(m.out_args) == 0:
797 self.c.write(' NULL,\n')
799 self.c.write(' (GDBusArgInfo **) &_%s_method_info_%s_OUT_ARG_pointers,\n'%(i.name_lower, m.name_lower))
801 self.c.write(' NULL\n')
803 self.c.write(' (GDBusAnnotationInfo **) &_%s_method_%s_annotation_info_pointers\n'%(i.name_lower, m.name_lower))
807 %(m.name_hyphen, 'TRUE' if unix_fd else 'FALSE'))
811 self.c.write('static const _ExtendedGDBusMethodInfo * const _%s_method_info_pointers[] =\n'
812 '{\n'%(i.name_lower))
814 self.c.write(' &_%s_method_info_%s,\n'%(i.name_lower, m.name_lower))
815 self.c.write(' NULL\n'
821 if len(i.signals) > 0:
823 self.generate_args('_%s_signal_info_%s_ARG'%(i.name_lower, s.name_lower), s.args)
825 num_anno = self.generate_annotations('_%s_signal_%s_annotation_info'%(i.name_lower, s.name_lower), s.annotations)
826 self.c.write('static const _ExtendedGDBusSignalInfo _%s_signal_info_%s =\n'
830 ' "%s",\n'%(i.name_lower, s.name_lower, s.name))
832 self.c.write(' NULL,\n')
834 self.c.write(' (GDBusArgInfo **) &_%s_signal_info_%s_ARG_pointers,\n'%(i.name_lower, s.name_lower))
836 self.c.write(' NULL\n')
838 self.c.write(' (GDBusAnnotationInfo **) &_%s_signal_%s_annotation_info_pointers\n'%(i.name_lower, s.name_lower))
845 self.c.write('static const _ExtendedGDBusSignalInfo * const _%s_signal_info_pointers[] =\n'
846 '{\n'%(i.name_lower))
848 self.c.write(' &_%s_signal_info_%s,\n'%(i.name_lower, s.name_lower))
849 self.c.write(' NULL\n'
855 if len(i.properties) > 0:
856 for p in i.properties:
857 if p.readable and p.writable:
858 access = 'G_DBUS_PROPERTY_INFO_FLAGS_READABLE | G_DBUS_PROPERTY_INFO_FLAGS_WRITABLE'
860 access = 'G_DBUS_PROPERTY_INFO_FLAGS_READABLE'
862 access = 'G_DBUS_PROPERTY_INFO_FLAGS_WRITABLE'
864 access = 'G_DBUS_PROPERTY_INFO_FLAGS_NONE'
865 num_anno = self.generate_annotations('_%s_property_%s_annotation_info'%(i.name_lower, p.name_lower), p.annotations)
866 self.c.write('static const _ExtendedGDBusPropertyInfo _%s_property_info_%s =\n'
872 ' %s,\n'%(i.name_lower, p.name_lower, p.name, p.arg.signature, access))
874 self.c.write(' NULL\n')
876 self.c.write(' (GDBusAnnotationInfo **) &_%s_property_%s_annotation_info_pointers\n'%(i.name_lower, p.name_lower))
880 if not utils.lookup_annotation(p.annotations, 'org.gtk.GDBus.C.ForceGVariant'):
881 self.c.write(' FALSE\n')
883 self.c.write(' TRUE\n')
887 self.c.write('static const _ExtendedGDBusPropertyInfo * const _%s_property_info_pointers[] =\n'
888 '{\n'%(i.name_lower))
889 for p in i.properties:
890 self.c.write(' &_%s_property_info_%s,\n'%(i.name_lower, p.name_lower))
891 self.c.write(' NULL\n'
895 num_anno = self.generate_annotations('_%s_annotation_info'%(i.name_lower), i.annotations)
896 self.c.write('static const _ExtendedGDBusInterfaceInfo _%s_interface_info =\n'
900 ' "%s",\n'%(i.name_lower, i.name))
901 if len(i.methods) == 0:
902 self.c.write(' NULL,\n')
904 self.c.write(' (GDBusMethodInfo **) &_%s_method_info_pointers,\n'%(i.name_lower))
905 if len(i.signals) == 0:
906 self.c.write(' NULL,\n')
908 self.c.write(' (GDBusSignalInfo **) &_%s_signal_info_pointers,\n'%(i.name_lower))
909 if len(i.properties) == 0:
910 self.c.write(' NULL,\n')
912 self.c.write(' (GDBusPropertyInfo **) &_%s_property_info_pointers,\n'%(i.name_lower))
914 self.c.write(' NULL\n')
916 self.c.write(' (GDBusAnnotationInfo **) &_%s_annotation_info_pointers\n'%(i.name_lower))
923 self.c.write(self.docbook_gen.expand(
925 ' * %s_interface_info:\n'
927 ' * Gets a machine-readable description of the #%s D-Bus interface.\n'
929 ' * Returns: (transfer none): A #GDBusInterfaceInfo. Do not free.\n'
930 %(i.name_lower, i.name), False))
931 self.write_gtkdoc_deprecated_and_since_and_close(i, self.c, 0)
932 self.c.write('GDBusInterfaceInfo *\n'
933 '%s_interface_info (void)\n'
935 ' return (GDBusInterfaceInfo *) &_%s_interface_info;\n'
937 '\n'%(i.name_lower, i.name_lower))
939 if len(i.properties) > 0:
940 self.c.write(self.docbook_gen.expand(
942 ' * %s_override_properties:\n'
943 ' * @klass: The class structure for a #GObject<!-- -->-derived class.\n'
944 ' * @property_id_begin: The property id to assign to the first overridden property.\n'
946 ' * Overrides all #GObject properties in the #%s interface for a concrete class.\n'
947 ' * The properties are overridden in the order they are defined.\n'
949 ' * Returns: The last property id.\n'
950 %(i.name_lower, i.camel_name), False))
951 self.write_gtkdoc_deprecated_and_since_and_close(i, self.c, 0)
952 self.c.write('guint\n'
953 '%s_override_properties (GObjectClass *klass, guint property_id_begin)\n'
954 '{\n'%(i.name_lower))
955 for p in i.properties:
956 self.c.write (' g_object_class_override_property (klass, property_id_begin++, "%s");\n'%(p.name_hyphen))
957 self.c.write(' return property_id_begin - 1;\n'
962 # ----------------------------------------------------------------------------------------------------
964 def generate_interface(self, i):
967 self.c.write(self.docbook_gen.expand(
971 ' * Abstract interface type for the D-Bus interface #%s.\n'
972 %(i.camel_name, i.name), False))
973 self.write_gtkdoc_deprecated_and_since_and_close(i, self.c, 0)
976 self.c.write(self.docbook_gen.expand(
979 ' * @parent_iface: The parent interface.\n'
980 %(i.camel_name), False))
983 if len(i.methods) > 0:
985 key = (m.since, '_method_%s'%m.name_lower)
986 value = '@handle_%s: '%(m.name_lower)
987 value += 'Handler for the #%s::handle-%s signal.'%(i.camel_name, m.name_hyphen)
988 doc_bits[key] = value
989 if len(i.signals) > 0:
991 key = (s.since, '_signal_%s'%s.name_lower)
992 value = '@%s: '%(s.name_lower)
993 value += 'Handler for the #%s::%s signal.'%(i.camel_name, s.name_hyphen)
994 doc_bits[key] = value
995 keys = doc_bits.keys()
997 keys.sort(cmp=utils.my_version_cmp)
999 self.c.write(' * %s\n'%doc_bits[key])
1000 self.c.write(self.docbook_gen.expand(
1002 ' * Virtual table for the D-Bus interface #%s.\n'
1004 self.write_gtkdoc_deprecated_and_since_and_close(i, self.c, 0)
1007 self.c.write('static void\n'
1008 '%s_default_init (%sIface *iface)\n'
1009 '{\n'%(i.name_lower, i.camel_name));
1011 if len(i.methods) > 0:
1012 self.c.write(' /* GObject signals for incoming D-Bus method calls: */\n')
1015 if utils.lookup_annotation(m.annotations, 'org.gtk.GDBus.C.UnixFD'):
1017 self.c.write(self.docbook_gen.expand(
1019 ' * %s::handle-%s:\n'
1020 ' * @object: A #%s.\n'
1021 ' * @invocation: A #GDBusMethodInvocation.\n'
1022 %(i.camel_name, m.name_hyphen, i.camel_name), False))
1024 self.c.write (' * @fd_list: (allow-none): A #GUnixFDList or %NULL.\n')
1026 self.c.write (' * @%s: Argument passed by remote caller.\n'%(a.name))
1027 self.c.write(self.docbook_gen.expand(
1029 ' * Signal emitted when a remote caller is invoking the %s.%s() D-Bus method.\n'
1031 ' * If a signal handler returns %%TRUE, it means the signal handler will handle the invocation (e.g. take a reference to @invocation and eventually call %s_complete_%s() or e.g. g_dbus_method_invocation_return_error() on it) and no order signal handlers will run. If no signal handler handles the invocation, the %%G_DBUS_ERROR_UNKNOWN_METHOD error is returned.\n'
1033 ' * Returns: %%TRUE if the invocation was handled, %%FALSE to let other signal handlers run.\n'
1034 %(i.name, m.name, i.name_lower, m.name_lower), False))
1035 self.write_gtkdoc_deprecated_and_since_and_close(m, self.c, 2)
1040 self.c.write(' g_signal_new ("handle-%s",\n'
1041 ' G_TYPE_FROM_INTERFACE (iface),\n'
1042 ' G_SIGNAL_RUN_LAST,\n'
1043 ' G_STRUCT_OFFSET (%sIface, handle_%s),\n'
1044 ' g_signal_accumulator_true_handled,\n'
1045 ' NULL,\n' # accu_data
1046 ' g_cclosure_marshal_generic,\n'
1047 ' G_TYPE_BOOLEAN,\n'
1049 ' G_TYPE_DBUS_METHOD_INVOCATION'
1050 %(m.name_hyphen, i.camel_name, m.name_lower, len(m.in_args) + extra_args))
1052 self.c.write(', G_TYPE_UNIX_FD_LIST')
1054 self.c.write (', %s'%(a.gtype))
1055 self.c.write(');\n')
1058 if len(i.signals) > 0:
1059 self.c.write(' /* GObject signals for received D-Bus signals: */\n')
1061 self.c.write(self.docbook_gen.expand(
1064 ' * @object: A #%s.\n'
1065 %(i.camel_name, s.name_hyphen, i.camel_name), False))
1067 self.c.write (' * @%s: Argument.\n'%(a.name))
1068 self.c.write(self.docbook_gen.expand(
1070 ' * On the client-side, this signal is emitted whenever the D-Bus signal #%s::%s is received.\n'
1072 ' * On the service-side, this signal can be used with e.g. g_signal_emit_by_name() to make the object emit the D-Bus signal.\n'
1073 %(i.name, s.name), False))
1074 self.write_gtkdoc_deprecated_and_since_and_close(s, self.c, 2)
1075 self.c.write(' g_signal_new ("%s",\n'
1076 ' G_TYPE_FROM_INTERFACE (iface),\n'
1077 ' G_SIGNAL_RUN_LAST,\n'
1078 ' G_STRUCT_OFFSET (%sIface, %s),\n'
1079 ' NULL,\n' # accumulator
1080 ' NULL,\n' # accu_data
1081 ' g_cclosure_marshal_generic,\n'
1084 %(s.name_hyphen, i.camel_name, s.name_lower, len(s.args)))
1086 self.c.write (', %s'%(a.gtype))
1087 self.c.write(');\n')
1090 if len(i.properties) > 0:
1091 self.c.write(' /* GObject properties for D-Bus properties: */\n')
1092 for p in i.properties:
1093 if p.readable and p.writable:
1094 hint = 'Since the D-Bus property for this #GObject property is both readable and writable, it is meaningful to both read from it and write to it on both the service- and client-side.'
1096 hint = 'Since the D-Bus property for this #GObject property is readable but not writable, it is meaningful to read from it on both the client- and service-side. It is only meaningful, however, to write to it on the service-side.'
1098 hint = 'Since the D-Bus property for this #GObject property is writable but not readable, it is meaningful to write to it on both the client- and service-side. It is only meaningful, however, to read from it on the service-side.'
1100 raise RuntimeError('Cannot handle property %s that neither readable nor writable'%(p.name))
1101 self.c.write(self.docbook_gen.expand(
1105 ' * Represents the D-Bus property #%s:%s.\n'
1108 %(i.camel_name, p.name_hyphen, i.name, p.name, hint), False))
1109 self.write_gtkdoc_deprecated_and_since_and_close(p, self.c, 2)
1110 self.c.write(' g_object_interface_install_property (iface,\n')
1111 if p.arg.gtype == 'G_TYPE_VARIANT':
1112 s = 'g_param_spec_variant ("%s", "%s", "%s", G_VARIANT_TYPE ("%s"), NULL'%(p.name_hyphen, p.name, p.name, p.arg.signature)
1113 elif p.arg.signature == 'b':
1114 s = 'g_param_spec_boolean ("%s", "%s", "%s", FALSE'%(p.name_hyphen, p.name, p.name)
1115 elif p.arg.signature == 'y':
1116 s = 'g_param_spec_uchar ("%s", "%s", "%s", 0, 255, 0'%(p.name_hyphen, p.name, p.name)
1117 elif p.arg.signature == 'n':
1118 s = 'g_param_spec_int ("%s", "%s", "%s", G_MININT16, G_MAXINT16, 0'%(p.name_hyphen, p.name, p.name)
1119 elif p.arg.signature == 'q':
1120 s = 'g_param_spec_uint ("%s", "%s", "%s", 0, G_MAXUINT16, 0'%(p.name_hyphen, p.name, p.name)
1121 elif p.arg.signature == 'i':
1122 s = 'g_param_spec_int ("%s", "%s", "%s", G_MININT32, G_MAXINT32, 0'%(p.name_hyphen, p.name, p.name)
1123 elif p.arg.signature == 'u':
1124 s = 'g_param_spec_uint ("%s", "%s", "%s", 0, G_MAXUINT32, 0'%(p.name_hyphen, p.name, p.name)
1125 elif p.arg.signature == 'x':
1126 s = 'g_param_spec_int64 ("%s", "%s", "%s", G_MININT64, G_MAXINT64, 0'%(p.name_hyphen, p.name, p.name)
1127 elif p.arg.signature == 't':
1128 s = 'g_param_spec_uint64 ("%s", "%s", "%s", 0, G_MAXUINT64, 0'%(p.name_hyphen, p.name, p.name)
1129 elif p.arg.signature == 'd':
1130 s = 'g_param_spec_double ("%s", "%s", "%s", -G_MAXDOUBLE, G_MAXDOUBLE, 0.0'%(p.name_hyphen, p.name, p.name)
1131 elif p.arg.signature == 's':
1132 s = 'g_param_spec_string ("%s", "%s", "%s", NULL'%(p.name_hyphen, p.name, p.name)
1133 elif p.arg.signature == 'o':
1134 s = 'g_param_spec_string ("%s", "%s", "%s", NULL'%(p.name_hyphen, p.name, p.name)
1135 elif p.arg.signature == 'g':
1136 s = 'g_param_spec_string ("%s", "%s", "%s", NULL'%(p.name_hyphen, p.name, p.name)
1137 elif p.arg.signature == 'ay':
1138 s = 'g_param_spec_string ("%s", "%s", "%s", NULL'%(p.name_hyphen, p.name, p.name)
1139 elif p.arg.signature == 'as':
1140 s = 'g_param_spec_boxed ("%s", "%s", "%s", G_TYPE_STRV'%(p.name_hyphen, p.name, p.name)
1141 elif p.arg.signature == 'ao':
1142 s = 'g_param_spec_boxed ("%s", "%s", "%s", G_TYPE_STRV'%(p.name_hyphen, p.name, p.name)
1143 elif p.arg.signature == 'aay':
1144 s = 'g_param_spec_boxed ("%s", "%s", "%s", G_TYPE_STRV'%(p.name_hyphen, p.name, p.name)
1146 raise RuntimeError('Unsupported gtype %s for GParamSpec'%(p.arg.gtype))
1147 self.c.write(' %s, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));'%s);
1153 self.c.write('typedef %sIface %sInterface;\n'%(i.camel_name, i.camel_name))
1154 self.c.write('G_DEFINE_INTERFACE (%s, %s, G_TYPE_OBJECT);\n'%(i.camel_name, i.name_lower))
1157 # ----------------------------------------------------------------------------------------------------
1159 def generate_property_accessors(self, i):
1160 for p in i.properties:
1162 if p.readable and p.writable:
1163 hint = 'Since this D-Bus property is both readable and writable, it is meaningful to use this function on both the client- and service-side.'
1165 hint = 'Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side.'
1167 hint = 'Since this D-Bus property is not readable, it is only meaningful to use this function on the service-side.'
1169 raise RuntimeError('Cannot handle property %s that neither readable nor writable'%(p.name))
1170 self.c.write(self.docbook_gen.expand(
1173 ' * @object: A #%s.\n'
1175 ' * Gets the value of the #%s:%s D-Bus property.\n'
1179 ' * Returns: (transfer none): The property value.\n'
1180 %(i.name_lower, p.name_lower, i.camel_name, i.name, p.name, hint), False))
1181 self.write_gtkdoc_deprecated_and_since_and_close(p, self.c, 0)
1183 '%s_get_%s (%s *object)\n'
1185 ' %svalue;\n'%(p.arg.ctype_in, i.name_lower, p.name_lower, i.camel_name, p.arg.ctype_in_g))
1186 self.c.write(' g_object_get (G_OBJECT (object), "%s", &value, NULL);\n'%(p.name_hyphen))
1188 self.c.write(' if (value != NULL)\n'
1189 ' g_object_set_data_full (G_OBJECT (object), "-x-memoizing-%s", (gpointer) value, (GDestroyNotify) %s);\n'
1191 ' g_object_set_data_full (G_OBJECT (object), "-x-memoizing-%s", (gpointer) value, NULL);\n'
1192 %(p.name_hyphen, p.arg.free_func, p.name_hyphen))
1193 self.c.write(' return value;\n')
1197 if p.readable and p.writable:
1198 hint = 'Since this D-Bus property is both readable and writable, it is meaningful to use this function on both the client- and service-side.'
1200 hint = 'Since this D-Bus property is not writable, it is only meaningful to use this function on the service-side.'
1202 hint = 'Since this D-Bus property is writable, it is meaningful to use this function on both the client- and service-side.'
1204 raise RuntimeError('Cannot handle property %s that neither readable nor writable'%(p.name))
1205 self.c.write(self.docbook_gen.expand(
1208 ' * @object: A #%s.\n'
1209 ' * @value: The value to set.\n'
1211 ' * Sets the #%s:%s D-Bus property to @value.\n'
1214 %(i.name_lower, p.name_lower, i.camel_name, i.name, p.name, hint), False))
1215 self.write_gtkdoc_deprecated_and_since_and_close(p, self.c, 0)
1216 self.c.write('void\n'
1217 '%s_set_%s (%s *object, %svalue)\n'
1218 '{\n'%(i.name_lower, p.name_lower, i.camel_name, p.arg.ctype_in, ))
1219 self.c.write(' g_object_set (G_OBJECT (object), "%s", value, NULL);\n'%(p.name_hyphen))
1223 # ---------------------------------------------------------------------------------------------------
1225 def generate_signal_emitters(self, i):
1227 self.c.write(self.docbook_gen.expand(
1230 ' * @object: A #%s.\n'
1231 %(i.name_lower, s.name_lower, i.camel_name), False))
1233 self.c.write(' * @%s: Argument to pass with the signal.\n'%(a.name))
1234 self.c.write(self.docbook_gen.expand(
1236 ' * Emits the #%s::%s D-Bus signal.\n'
1237 %(i.name, s.name), False))
1238 self.write_gtkdoc_deprecated_and_since_and_close(s, self.c, 0)
1239 self.c.write('void\n'
1241 ' %s *object'%(i.name_lower, s.name_lower, i.camel_name))
1243 self.c.write(',\n %s%s'%(a.ctype_in, a.name))
1246 ' g_signal_emit_by_name (object, "%s"'%(s.name_hyphen))
1248 self.c.write(', %s'%a.name)
1249 self.c.write(');\n')
1253 # ---------------------------------------------------------------------------------------------------
1255 def generate_method_calls(self, i):
1258 if utils.lookup_annotation(m.annotations, 'org.gtk.GDBus.C.UnixFD'):
1261 self.c.write('/**\n'
1263 ' * @proxy: A #%sProxy.\n'
1264 %(i.name_lower, m.name_lower, i.camel_name))
1266 self.c.write(' * @%s: Argument to pass with the method invocation.\n'%(a.name))
1268 self.c.write(' * @fd_list: (allow-none): A #GUnixFDList or %NULL.\n')
1269 self.c.write(self.docbook_gen.expand(
1270 ' * @cancellable: (allow-none): A #GCancellable or %%NULL.\n'
1271 ' * @callback: A #GAsyncReadyCallback to call when the request is satisfied or %%NULL.\n'
1272 ' * @user_data: User data to pass to @callback.\n'
1274 ' * Asynchronously invokes the %s.%s() D-Bus method on @proxy.\n'
1275 ' * When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from.\n'
1276 ' * You can then call %s_call_%s_finish() to get the result of the operation.\n'
1278 ' * See %s_call_%s_sync() for the synchronous, blocking version of this method.\n'
1279 %(i.name, m.name, i.name_lower, m.name_lower, i.name_lower, m.name_lower), False))
1280 self.write_gtkdoc_deprecated_and_since_and_close(m, self.c, 0)
1281 self.c.write('void\n'
1283 ' %s *proxy'%(i.name_lower, m.name_lower, i.camel_name))
1285 self.c.write(',\n %s%s'%(a.ctype_in, a.name))
1287 self.c.write(',\n GUnixFDList *fd_list')
1289 ' GCancellable *cancellable,\n'
1290 ' GAsyncReadyCallback callback,\n'
1291 ' gpointer user_data)\n'
1294 self.c.write(' g_dbus_proxy_call_with_unix_fd_list (G_DBUS_PROXY (proxy),\n')
1296 self.c.write(' g_dbus_proxy_call (G_DBUS_PROXY (proxy),\n')
1297 self.c.write(' "%s",\n'
1298 ' g_variant_new ("('%(m.name))
1300 self.c.write('%s'%(a.format_in))
1303 self.c.write(',\n %s'%(a.name))
1305 ' G_DBUS_CALL_FLAGS_NONE,\n'
1308 self.c.write(' fd_list,\n')
1309 self.c.write(' cancellable,\n'
1315 self.c.write('/**\n'
1316 ' * %s_call_%s_finish:\n'
1317 ' * @proxy: A #%sProxy.\n'
1318 %(i.name_lower, m.name_lower, i.camel_name))
1319 for a in m.out_args:
1320 self.c.write(' * @out_%s: (out): Return location for return parameter or %%NULL to ignore.\n'%(a.name))
1322 self.c.write(' * @out_fd_list: (out): Return location for a #GUnixFDList or %NULL.\n')
1323 self.c.write(self.docbook_gen.expand(
1324 ' * @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to %s_call_%s().\n'
1325 ' * @error: Return location for error or %%NULL.\n'
1327 ' * Finishes an operation started with %s_call_%s().\n'
1329 ' * Returns: (skip): %%TRUE if the call succeded, %%FALSE if @error is set.\n'
1330 %(i.name_lower, m.name_lower, i.name_lower, m.name_lower), False))
1331 self.write_gtkdoc_deprecated_and_since_and_close(m, self.c, 0)
1332 self.c.write('gboolean\n'
1333 '%s_call_%s_finish (\n'
1334 ' %s *proxy'%(i.name_lower, m.name_lower, i.camel_name))
1335 for a in m.out_args:
1336 self.c.write(',\n %sout_%s'%(a.ctype_out, a.name))
1338 self.c.write(',\n GUnixFDList **out_fd_list')
1340 ' GAsyncResult *res,\n'
1341 ' GError **error)\n'
1343 ' GVariant *_ret;\n')
1345 self.c.write(' _ret = g_dbus_proxy_call_with_unix_fd_list_finish (G_DBUS_PROXY (proxy), out_fd_list, res, error);\n')
1347 self.c.write(' _ret = g_dbus_proxy_call_finish (G_DBUS_PROXY (proxy), res, error);\n')
1348 self.c.write(' if (_ret == NULL)\n'
1350 self.c.write(' g_variant_get (_ret,\n'
1352 for a in m.out_args:
1353 self.c.write('%s'%(a.format_out))
1355 for a in m.out_args:
1356 self.c.write(',\n out_%s'%(a.name))
1358 ' g_variant_unref (_ret);\n')
1359 self.c.write('_out:\n'
1360 ' return _ret != NULL;\n'
1366 self.c.write('/**\n'
1367 ' * %s_call_%s_sync:\n'
1368 ' * @proxy: A #%sProxy.\n'
1369 %(i.name_lower, m.name_lower, i.camel_name))
1371 self.c.write(' * @%s: Argument to pass with the method invocation.\n'%(a.name))
1373 self.c.write(' * @fd_list: (allow-none): A #GUnixFDList or %NULL.\n')
1374 for a in m.out_args:
1375 self.c.write(' * @out_%s: (out): Return location for return parameter or %%NULL to ignore.\n'%(a.name))
1377 self.c.write(' * @out_fd_list: (out): Return location for a #GUnixFDList or %NULL.\n')
1378 self.c.write(self.docbook_gen.expand(
1379 ' * @cancellable: (allow-none): A #GCancellable or %%NULL.\n'
1380 ' * @error: Return location for error or %%NULL.\n'
1382 ' * Synchronously invokes the %s.%s() D-Bus method on @proxy. The calling thread is blocked until a reply is received.\n'
1384 ' * See %s_call_%s() for the asynchronous version of this method.\n'
1386 ' * Returns: (skip): %%TRUE if the call succeded, %%FALSE if @error is set.\n'
1387 %(i.name, m.name, i.name_lower, m.name_lower), False))
1388 self.write_gtkdoc_deprecated_and_since_and_close(m, self.c, 0)
1389 self.c.write('gboolean\n'
1390 '%s_call_%s_sync (\n'
1391 ' %s *proxy'%(i.name_lower, m.name_lower, i.camel_name))
1393 self.c.write(',\n %s%s'%(a.ctype_in, a.name))
1395 self.c.write(',\n GUnixFDList *fd_list')
1396 for a in m.out_args:
1397 self.c.write(',\n %sout_%s'%(a.ctype_out, a.name))
1399 self.c.write(',\n GUnixFDList **out_fd_list')
1401 ' GCancellable *cancellable,\n'
1402 ' GError **error)\n'
1404 ' GVariant *_ret;\n')
1406 self.c.write(' _ret = g_dbus_proxy_call_with_unix_fd_list_sync (G_DBUS_PROXY (proxy),\n')
1408 self.c.write(' _ret = g_dbus_proxy_call_sync (G_DBUS_PROXY (proxy),\n')
1409 self.c.write(' "%s",\n'
1410 ' g_variant_new ("('%(m.name))
1412 self.c.write('%s'%(a.format_in))
1415 self.c.write(',\n %s'%(a.name))
1417 ' G_DBUS_CALL_FLAGS_NONE,\n'
1420 self.c.write(' fd_list,\n'
1422 self.c.write(' cancellable,\n'
1424 ' if (_ret == NULL)\n'
1426 self.c.write(' g_variant_get (_ret,\n'
1428 for a in m.out_args:
1429 self.c.write('%s'%(a.format_out))
1431 for a in m.out_args:
1432 self.c.write(',\n out_%s'%(a.name))
1434 ' g_variant_unref (_ret);\n')
1435 self.c.write('_out:\n'
1436 ' return _ret != NULL;\n'
1440 # ---------------------------------------------------------------------------------------------------
1442 def generate_method_completers(self, i):
1445 if utils.lookup_annotation(m.annotations, 'org.gtk.GDBus.C.UnixFD'):
1447 self.c.write('/**\n'
1448 ' * %s_complete_%s:\n'
1449 ' * @object: A #%s.\n'
1450 ' * @invocation: (transfer full): A #GDBusMethodInvocation.\n'
1451 %(i.name_lower, m.name_lower, i.camel_name))
1453 self.c.write (' * @fd_list: (allow-none): A #GUnixFDList or %NULL.\n')
1454 for a in m.out_args:
1455 self.c.write(' * @%s: Parameter to return.\n'%(a.name))
1456 self.c.write(self.docbook_gen.expand(
1458 ' * Helper function used in service implementations to finish handling invocations of the %s.%s() D-Bus method. If you instead want to finish handling an invocation by returning an error, use g_dbus_method_invocation_return_error() or similar.\n'
1460 ' * This method will free @invocation, you cannot use it afterwards.\n'
1461 %(i.name, m.name), False))
1462 self.write_gtkdoc_deprecated_and_since_and_close(m, self.c, 0)
1463 self.c.write('void\n'
1464 '%s_complete_%s (\n'
1466 ' GDBusMethodInvocation *invocation'%(i.name_lower, m.name_lower, i.camel_name))
1468 self.c.write(',\n GUnixFDList *fd_list')
1469 for a in m.out_args:
1470 self.c.write(',\n %s%s'%(a.ctype_in, a.name))
1475 self.c.write(' g_dbus_method_invocation_return_value_with_unix_fd_list (invocation,\n'
1476 ' g_variant_new ("(')
1478 self.c.write(' g_dbus_method_invocation_return_value (invocation,\n'
1479 ' g_variant_new ("(')
1480 for a in m.out_args:
1481 self.c.write('%s'%(a.format_in))
1483 for a in m.out_args:
1484 self.c.write(',\n %s'%(a.name))
1486 self.c.write('),\n fd_list);\n')
1488 self.c.write('));\n')
1492 # ---------------------------------------------------------------------------------------------------
1494 def generate_proxy(self, i):
1496 self.c.write('/* ------------------------------------------------------------------------ */\n'
1499 self.c.write(self.docbook_gen.expand(
1503 ' * The #%sProxy structure contains only private data and should only be accessed using the provided API.\n'
1504 %(i.camel_name, i.camel_name), False))
1505 self.write_gtkdoc_deprecated_and_since_and_close(i, self.c, 0)
1508 self.c.write(self.docbook_gen.expand(
1510 ' * %sProxyClass:\n'
1511 ' * @parent_class: The parent class.\n'
1513 ' * Class structure for #%sProxy.\n'
1514 %(i.camel_name, i.camel_name), False))
1515 self.write_gtkdoc_deprecated_and_since_and_close(i, self.c, 0)
1518 self.c.write('static void\n'
1519 '%s_proxy_iface_init (%sIface *iface)\n'
1522 '\n'%(i.name_lower, i.camel_name))
1523 self.c.write('#define %s_proxy_get_type %s_proxy_get_type\n'%(i.name_lower, i.name_lower))
1524 self.c.write('G_DEFINE_TYPE_WITH_CODE (%sProxy, %s_proxy, G_TYPE_DBUS_PROXY,\n'%(i.camel_name, i.name_lower))
1525 self.c.write(' G_IMPLEMENT_INTERFACE (%sTYPE_%s, %s_proxy_iface_init));\n'%(i.ns_upper, i.name_upper, i.name_lower))
1526 self.c.write('#undef %s_proxy_get_type\n'
1527 '\n'%(i.name_lower))
1529 # property accessors
1531 # Note that we are guaranteed that prop_id starts at 1 and is
1532 # laid out in the same order as introspection data pointers
1534 self.c.write('static void\n'
1535 '%s_proxy_get_property (GObject *object,\n'
1538 ' GParamSpec *pspec)\n'
1539 '{\n'%(i.name_lower))
1540 if len(i.properties) > 0:
1541 self.c.write(' const _ExtendedGDBusPropertyInfo *info;\n'
1542 ' GVariant *variant;\n'
1543 ' g_assert (prop_id != 0 && prop_id - 1 < %d);\n'
1544 ' info = _%s_property_info_pointers[prop_id - 1];\n'
1545 ' variant = g_dbus_proxy_get_cached_property (G_DBUS_PROXY (object), info->parent_struct.name);\n'
1546 ' if (info->use_gvariant)\n'
1548 ' g_value_set_variant (value, variant);\n'
1552 # could be that we don't have the value in cache - in that case, we do
1553 # nothing and the user gets the default value for the GType
1554 ' if (variant != NULL)\n'
1555 ' g_dbus_gvariant_to_gvalue (variant, value);\n'
1557 ' if (variant != NULL)\n'
1558 ' g_variant_unref (variant);\n'
1559 %(len(i.properties), i.name_lower))
1562 if len(i.properties) > 0:
1563 self.c.write('static void\n'
1564 '%s_proxy_set_property_cb (GDBusProxy *proxy,\n'
1565 ' GAsyncResult *res,\n'
1566 ' gpointer user_data)\n'
1567 '{\n'%(i.name_lower))
1568 self.c.write(' const _ExtendedGDBusPropertyInfo *info = user_data;\n'
1571 ' if (!g_dbus_proxy_call_finish (proxy, res, &error))\n'
1573 ' g_warning ("Error setting property `%%s\' on interface %s: %%s (%%s, %%d)",\n'
1574 ' info->parent_struct.name, \n'
1575 ' error->message, g_quark_to_string (error->domain), error->code);\n'
1576 ' g_error_free (error);\n'
1581 self.c.write('static void\n'
1582 '%s_proxy_set_property (GObject *object,\n'
1584 ' const GValue *value,\n'
1585 ' GParamSpec *pspec)\n'
1586 '{\n'%(i.name_lower))
1587 if len(i.properties) > 0:
1588 self.c.write(' const _ExtendedGDBusPropertyInfo *info;\n'
1589 ' GVariant *variant;\n'
1590 ' g_assert (prop_id != 0 && prop_id - 1 < %d);\n'
1591 ' info = _%s_property_info_pointers[prop_id - 1];\n'
1592 ' variant = g_dbus_gvalue_to_gvariant (value, G_VARIANT_TYPE (info->parent_struct.signature));\n'
1593 ' g_dbus_proxy_call (G_DBUS_PROXY (object),\n'
1594 ' "org.freedesktop.DBus.Properties.Set",\n'
1595 ' g_variant_new ("(ssv)", "%s", info->parent_struct.name, variant),\n'
1596 ' G_DBUS_CALL_FLAGS_NONE,\n'
1598 ' NULL, (GAsyncReadyCallback) %s_proxy_set_property_cb, (gpointer) info);\n'
1599 ' g_variant_unref (variant);\n'
1600 %(len(i.properties), i.name_lower, i.name, i.name_lower))
1605 self.c.write('static void\n'
1606 '%s_proxy_g_signal (GDBusProxy *proxy,\n'
1607 ' const gchar *sender_name,\n'
1608 ' const gchar *signal_name,\n'
1609 ' GVariant *parameters)\n'
1610 '{\n'%(i.name_lower))
1611 self.c.write(' _ExtendedGDBusSignalInfo *info;\n'
1612 ' GVariantIter iter;\n'
1613 ' GVariant *child;\n'
1614 ' GValue *paramv;\n'
1615 ' guint num_params;\n'
1617 ' guint signal_id;\n');
1618 # Note: info could be NULL if we are talking to a newer version of the interface
1619 self.c.write(' info = (_ExtendedGDBusSignalInfo *) g_dbus_interface_info_lookup_signal ((GDBusInterfaceInfo *) &_%s_interface_info, signal_name);\n'
1620 ' if (info == NULL)\n'
1623 self.c.write (' num_params = g_variant_n_children (parameters);\n'
1624 ' paramv = g_new0 (GValue, num_params + 1);\n'
1625 ' g_value_init (¶mv[0], %sTYPE_%s);\n'
1626 ' g_value_set_object (¶mv[0], proxy);\n'
1627 %(i.ns_upper, i.name_upper))
1628 self.c.write(' g_variant_iter_init (&iter, parameters);\n'
1630 ' while ((child = g_variant_iter_next_value (&iter)) != NULL)\n'
1632 ' _ExtendedGDBusArgInfo *arg_info = (_ExtendedGDBusArgInfo *) info->parent_struct.args[n - 1];\n'
1633 ' if (arg_info->use_gvariant)\n'
1635 ' g_value_init (¶mv[n], G_TYPE_VARIANT);\n'
1636 ' g_value_set_variant (¶mv[n], child);\n'
1640 ' g_dbus_gvariant_to_gvalue (child, ¶mv[n++]);\n'
1641 ' g_variant_unref (child);\n'
1644 self.c.write(' signal_id = g_signal_lookup (info->signal_name, %sTYPE_%s);\n'
1645 %(i.ns_upper, i.name_upper))
1646 self.c.write(' g_signal_emitv (paramv, signal_id, 0, NULL);\n')
1647 self.c.write(' for (n = 0; n < num_params + 1; n++)\n'
1648 ' g_value_unset (¶mv[n]);\n'
1649 ' g_free (paramv);\n')
1654 self.c.write('static void\n'
1655 '%s_proxy_g_properties_changed (GDBusProxy *proxy,\n'
1656 ' GVariant *changed_properties,\n'
1657 ' const gchar *const *invalidated_properties)\n'
1658 '{\n'%(i.name_lower))
1659 # Note: info could be NULL if we are talking to a newer version of the interface
1660 self.c.write(' guint n;\n'
1661 ' const gchar *key;\n'
1662 ' GVariantIter *iter;\n'
1663 ' _ExtendedGDBusPropertyInfo *info;\n'
1664 ' g_variant_get (changed_properties, "a{sv}", &iter);\n'
1665 ' while (g_variant_iter_next (iter, "{&sv}", &key, NULL))\n'
1667 ' info = (_ExtendedGDBusPropertyInfo *) g_dbus_interface_info_lookup_property ((GDBusInterfaceInfo *) &_%s_interface_info, key);\n'
1668 ' if (info != NULL)\n'
1669 ' g_object_notify (G_OBJECT (proxy), info->hyphen_name);\n'
1671 ' g_variant_iter_free (iter);\n'
1672 ' for (n = 0; invalidated_properties[n] != NULL; n++)\n'
1674 ' info = (_ExtendedGDBusPropertyInfo *) g_dbus_interface_info_lookup_property ((GDBusInterfaceInfo *) &_%s_interface_info, invalidated_properties[n]);\n'
1675 ' if (info != NULL)\n'
1676 ' g_object_notify (G_OBJECT (proxy), info->hyphen_name);\n'
1680 %(i.name_lower, i.name_lower))
1683 self.c.write('static void\n'
1684 '%s_proxy_init (%sProxy *proxy)\n'
1686 ' g_dbus_proxy_set_interface_info (G_DBUS_PROXY (proxy), %s_interface_info ());\n'
1688 '\n'%(i.name_lower, i.camel_name, i.name_lower))
1689 self.c.write('static void\n'
1690 '%s_proxy_class_init (%sProxyClass *klass)\n'
1692 ' GObjectClass *gobject_class;\n'
1693 ' GDBusProxyClass *proxy_class;\n'
1695 ' gobject_class = G_OBJECT_CLASS (klass);\n'
1696 ' gobject_class->get_property = %s_proxy_get_property;\n'
1697 ' gobject_class->set_property = %s_proxy_set_property;\n'
1699 ' proxy_class = G_DBUS_PROXY_CLASS (klass);\n'
1700 ' proxy_class->g_signal = %s_proxy_g_signal;\n'
1701 ' proxy_class->g_properties_changed = %s_proxy_g_properties_changed;\n'
1702 '\n'%(i.name_lower, i.camel_name, i.name_lower, i.name_lower, i.name_lower, i.name_lower))
1703 if len(i.properties) > 0:
1705 ' %s_override_properties (gobject_class, 1);\n'%(i.name_lower))
1710 self.c.write(self.docbook_gen.expand(
1712 ' * %s_proxy_new:\n'
1713 ' * @connection: A #GDBusConnection.\n'
1714 ' * @flags: Flags from the #GDBusProxyFlags enumeration.\n'
1715 ' * @name: (allow-none): A bus name (well-known or unique) or %%NULL if @connection is not a message bus connection.\n'
1716 ' * @object_path: An object path.\n'
1717 ' * @cancellable: (allow-none): A #GCancellable or %%NULL.\n'
1718 ' * @callback: A #GAsyncReadyCallback to call when the request is satisfied.\n'
1719 ' * @user_data: User data to pass to @callback.\n'
1721 ' * Asynchronously creates a proxy for the D-Bus interface #%s. See g_dbus_proxy_new() for more details.\n'
1723 ' * When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from.\n'
1724 ' * You can then call %s_proxy_new_finish() to get the result of the operation.\n'
1726 ' * See %s_proxy_new_sync() for the synchronous, blocking version of this constructor.\n'
1727 %(i.name_lower, i.name, i.name_lower, i.name_lower), False))
1728 self.write_gtkdoc_deprecated_and_since_and_close(i, self.c, 0)
1729 self.c.write('void\n'
1731 ' GDBusConnection *connection,\n'
1732 ' GDBusProxyFlags flags,\n'
1733 ' const gchar *name,\n'
1734 ' const gchar *object_path,\n'
1735 ' GCancellable *cancellable,\n'
1736 ' GAsyncReadyCallback callback,\n'
1737 ' gpointer user_data)\n'
1739 ' g_async_initable_new_async (%sTYPE_%s_PROXY, G_PRIORITY_DEFAULT, cancellable, callback, user_data, "g-flags", flags, "g-name", name, "g-connection", connection, "g-object-path", object_path, "g-interface-name", "%s", NULL);\n'
1742 %(i.name_lower, i.ns_upper, i.name_upper, i.name))
1743 self.c.write('/**\n'
1744 ' * %s_proxy_new_finish:\n'
1745 ' * @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to %s_proxy_new().\n'
1746 ' * @error: Return location for error or %%NULL\n'
1748 ' * Finishes an operation started with %s_proxy_new().\n'
1750 ' * Returns: (transfer full) (type %sProxy): The constructed proxy object or %%NULL if @error is set.\n'
1751 %(i.name_lower, i.name_lower, i.name_lower, i.camel_name))
1752 self.write_gtkdoc_deprecated_and_since_and_close(i, self.c, 0)
1753 self.c.write('%s *\n'
1754 '%s_proxy_new_finish (\n'
1755 ' GAsyncResult *res,\n'
1756 ' GError **error)\n'
1759 ' GObject *source_object;\n'
1760 ' source_object = g_async_result_get_source_object (res);\n'
1761 ' ret = g_async_initable_new_finish (G_ASYNC_INITABLE (source_object), res, error);\n'
1762 ' g_object_unref (source_object);\n'
1763 ' if (ret != NULL)\n'
1764 ' return %s%s (ret);\n'
1769 %(i.camel_name, i.name_lower, i.ns_upper, i.name_upper))
1770 self.c.write(self.docbook_gen.expand(
1772 ' * %s_proxy_new_sync:\n'
1773 ' * @connection: A #GDBusConnection.\n'
1774 ' * @flags: Flags from the #GDBusProxyFlags enumeration.\n'
1775 ' * @name: (allow-none): A bus name (well-known or unique) or %%NULL if @connection is not a message bus connection.\n'
1776 ' * @object_path: An object path.\n'
1777 ' * @cancellable: (allow-none): A #GCancellable or %%NULL.\n'
1778 ' * @error: Return location for error or %%NULL\n'
1780 ' * Synchronously creates a proxy for the D-Bus interface #%s. See g_dbus_proxy_new_sync() for more details.\n'
1782 ' * The calling thread is blocked until a reply is received.\n'
1784 ' * See %s_proxy_new() for the asynchronous version of this constructor.\n'
1786 ' * Returns: (transfer full) (type %sProxy): The constructed proxy object or %%NULL if @error is set.\n'
1787 %(i.name_lower, i.name, i.name_lower, i.camel_name), False))
1788 self.write_gtkdoc_deprecated_and_since_and_close(i, self.c, 0)
1789 self.c.write('%s *\n'
1790 '%s_proxy_new_sync (\n'
1791 ' GDBusConnection *connection,\n'
1792 ' GDBusProxyFlags flags,\n'
1793 ' const gchar *name,\n'
1794 ' const gchar *object_path,\n'
1795 ' GCancellable *cancellable,\n'
1796 ' GError **error)\n'
1798 ' GInitable *ret;\n'
1799 ' ret = g_initable_new (%sTYPE_%s_PROXY, cancellable, error, "g-flags", flags, "g-name", name, "g-connection", connection, "g-object-path", object_path, "g-interface-name", "%s", NULL);\n'
1800 ' if (ret != NULL)\n'
1801 ' return %s%s (ret);\n'
1806 %(i.camel_name, i.name_lower, i.ns_upper, i.name_upper, i.name, i.ns_upper, i.name_upper))
1808 self.c.write(self.docbook_gen.expand(
1810 ' * %s_proxy_new_for_bus:\n'
1811 ' * @bus_type: A #GBusType.\n'
1812 ' * @flags: Flags from the #GDBusProxyFlags enumeration.\n'
1813 ' * @name: A bus name (well-known or unique).\n'
1814 ' * @object_path: An object path.\n'
1815 ' * @cancellable: (allow-none): A #GCancellable or %%NULL.\n'
1816 ' * @callback: A #GAsyncReadyCallback to call when the request is satisfied.\n'
1817 ' * @user_data: User data to pass to @callback.\n'
1819 ' * Like %s_proxy_new() but takes a #GBusType instead of a #GDBusConnection.\n'
1821 ' * When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from.\n'
1822 ' * You can then call %s_proxy_new_for_bus_finish() to get the result of the operation.\n'
1824 ' * See %s_proxy_new_for_bus_sync() for the synchronous, blocking version of this constructor.\n'
1825 %(i.name_lower, i.name_lower, i.name_lower, i.name_lower), False))
1826 self.write_gtkdoc_deprecated_and_since_and_close(i, self.c, 0)
1827 self.c.write('void\n'
1828 '%s_proxy_new_for_bus (\n'
1829 ' GBusType bus_type,\n'
1830 ' GDBusProxyFlags flags,\n'
1831 ' const gchar *name,\n'
1832 ' const gchar *object_path,\n'
1833 ' GCancellable *cancellable,\n'
1834 ' GAsyncReadyCallback callback,\n'
1835 ' gpointer user_data)\n'
1837 ' g_async_initable_new_async (%sTYPE_%s_PROXY, G_PRIORITY_DEFAULT, cancellable, callback, user_data, "g-flags", flags, "g-name", name, "g-bus-type", bus_type, "g-object-path", object_path, "g-interface-name", "%s", NULL);\n'
1840 %(i.name_lower, i.ns_upper, i.name_upper, i.name))
1841 self.c.write('/**\n'
1842 ' * %s_proxy_new_for_bus_finish:\n'
1843 ' * @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to %s_proxy_new_for_bus().\n'
1844 ' * @error: Return location for error or %%NULL\n'
1846 ' * Finishes an operation started with %s_proxy_new_for_bus().\n'
1848 ' * Returns: (transfer full) (type %sProxy): The constructed proxy object or %%NULL if @error is set.\n'
1849 %(i.name_lower, i.name_lower, i.name_lower, i.camel_name))
1850 self.write_gtkdoc_deprecated_and_since_and_close(i, self.c, 0)
1851 self.c.write('%s *\n'
1852 '%s_proxy_new_for_bus_finish (\n'
1853 ' GAsyncResult *res,\n'
1854 ' GError **error)\n'
1857 ' GObject *source_object;\n'
1858 ' source_object = g_async_result_get_source_object (res);\n'
1859 ' ret = g_async_initable_new_finish (G_ASYNC_INITABLE (source_object), res, error);\n'
1860 ' g_object_unref (source_object);\n'
1861 ' if (ret != NULL)\n'
1862 ' return %s%s (ret);\n'
1867 %(i.camel_name, i.name_lower, i.ns_upper, i.name_upper))
1868 self.c.write(self.docbook_gen.expand(
1870 ' * %s_proxy_new_for_bus_sync:\n'
1871 ' * @bus_type: A #GBusType.\n'
1872 ' * @flags: Flags from the #GDBusProxyFlags enumeration.\n'
1873 ' * @name: A bus name (well-known or unique).\n'
1874 ' * @object_path: An object path.\n'
1875 ' * @cancellable: (allow-none): A #GCancellable or %%NULL.\n'
1876 ' * @error: Return location for error or %%NULL\n'
1878 ' * Like %s_proxy_new_sync() but takes a #GBusType instead of a #GDBusConnection.\n'
1880 ' * The calling thread is blocked until a reply is received.\n'
1882 ' * See %s_proxy_new_for_bus() for the asynchronous version of this constructor.\n'
1884 ' * Returns: (transfer full) (type %sProxy): The constructed proxy object or %%NULL if @error is set.\n'
1885 %(i.name_lower, i.name_lower, i.name_lower, i.camel_name), False))
1886 self.write_gtkdoc_deprecated_and_since_and_close(i, self.c, 0)
1887 self.c.write('%s *\n'
1888 '%s_proxy_new_for_bus_sync (\n'
1889 ' GBusType bus_type,\n'
1890 ' GDBusProxyFlags flags,\n'
1891 ' const gchar *name,\n'
1892 ' const gchar *object_path,\n'
1893 ' GCancellable *cancellable,\n'
1894 ' GError **error)\n'
1896 ' GInitable *ret;\n'
1897 ' ret = g_initable_new (%sTYPE_%s_PROXY, cancellable, error, "g-flags", flags, "g-name", name, "g-bus-type", bus_type, "g-object-path", object_path, "g-interface-name", "%s", NULL);\n'
1898 ' if (ret != NULL)\n'
1899 ' return %s%s (ret);\n'
1904 %(i.camel_name, i.name_lower, i.ns_upper, i.name_upper, i.name, i.ns_upper, i.name_upper))
1907 # ---------------------------------------------------------------------------------------------------
1909 def generate_skeleton(self, i):
1911 self.c.write('/* ------------------------------------------------------------------------ */\n'
1914 self.c.write(self.docbook_gen.expand(
1918 ' * The #%sSkeleton structure contains only private data and should only be accessed using the provided API.\n'
1919 %(i.camel_name, i.camel_name), False))
1920 self.write_gtkdoc_deprecated_and_since_and_close(i, self.c, 0)
1923 self.c.write(self.docbook_gen.expand(
1925 ' * %sSkeletonClass:\n'
1926 ' * @parent_class: The parent class.\n'
1928 ' * Class structure for #%sSkeleton.\n'
1929 %(i.camel_name, i.camel_name), False))
1930 self.write_gtkdoc_deprecated_and_since_and_close(i, self.c, 0)
1933 self.c.write('struct _%sSkeletonPrivate\n'
1935 ' GValueArray *properties;\n'
1936 ' GList *changed_properties;\n'
1937 ' GSource *changed_properties_idle_source;\n'
1938 ' GMainContext *context;\n'
1943 self.c.write('static void\n'
1944 '_%s_skeleton_handle_method_call (\n'
1945 ' GDBusConnection *connection,\n'
1946 ' const gchar *sender,\n'
1947 ' const gchar *object_path,\n'
1948 ' const gchar *interface_name,\n'
1949 ' const gchar *method_name,\n'
1950 ' GVariant *parameters,\n'
1951 ' GDBusMethodInvocation *invocation,\n'
1952 ' gpointer user_data)\n'
1954 ' %sSkeleton *skeleton = %s%s_SKELETON (user_data);\n'
1955 ' _ExtendedGDBusMethodInfo *info;\n'
1956 ' GVariantIter iter;\n'
1957 ' GVariant *child;\n'
1958 ' GValue *paramv;\n'
1959 ' guint num_params;\n'
1960 ' guint num_extra;\n'
1962 ' guint signal_id;\n'
1963 ' GValue return_value = {0};\n'
1964 %(i.name_lower, i.camel_name, i.ns_upper, i.name_upper))
1965 self.c.write(' info = (_ExtendedGDBusMethodInfo *) g_dbus_method_invocation_get_method_info (invocation);\n'
1966 ' g_assert (info != NULL);\n'
1968 self.c.write (' num_params = g_variant_n_children (parameters);\n'
1969 ' num_extra = info->pass_fdlist ? 3 : 2;'
1970 ' paramv = g_new0 (GValue, num_params + num_extra);\n'
1972 ' g_value_init (¶mv[n], %sTYPE_%s);\n'
1973 ' g_value_set_object (¶mv[n++], skeleton);\n'
1974 ' g_value_init (¶mv[n], G_TYPE_DBUS_METHOD_INVOCATION);\n'
1975 ' g_value_set_object (¶mv[n++], invocation);\n'
1976 ' if (info->pass_fdlist)\n'
1978 ' g_value_init (¶mv[n], G_TYPE_UNIX_FD_LIST);\n'
1979 ' g_value_set_object (¶mv[n++], g_dbus_message_get_unix_fd_list (g_dbus_method_invocation_get_message (invocation)));\n'
1981 %(i.ns_upper, i.name_upper))
1982 self.c.write(' g_variant_iter_init (&iter, parameters);\n'
1983 ' while ((child = g_variant_iter_next_value (&iter)) != NULL)\n'
1985 ' _ExtendedGDBusArgInfo *arg_info = (_ExtendedGDBusArgInfo *) info->parent_struct.in_args[n - num_extra];\n'
1986 ' if (arg_info->use_gvariant)\n'
1988 ' g_value_init (¶mv[n], G_TYPE_VARIANT);\n'
1989 ' g_value_set_variant (¶mv[n], child);\n'
1993 ' g_dbus_gvariant_to_gvalue (child, ¶mv[n++]);\n'
1994 ' g_variant_unref (child);\n'
1997 self.c.write(' signal_id = g_signal_lookup (info->signal_name, %sTYPE_%s);\n'
1998 %(i.ns_upper, i.name_upper))
1999 self.c.write(' g_value_init (&return_value, G_TYPE_BOOLEAN);\n'
2000 ' g_signal_emitv (paramv, signal_id, 0, &return_value);\n'
2001 ' if (!g_value_get_boolean (&return_value))\n'
2002 ' g_dbus_method_invocation_return_error (invocation, G_DBUS_ERROR, G_DBUS_ERROR_UNKNOWN_METHOD, "Method %s is not implemented on interface %s", method_name, interface_name);\n'
2003 ' g_value_unset (&return_value);\n'
2005 self.c.write(' for (n = 0; n < num_params + num_extra; n++)\n'
2006 ' g_value_unset (¶mv[n]);\n'
2007 ' g_free (paramv);\n')
2011 self.c.write('static GVariant *\n'
2012 '_%s_skeleton_handle_get_property (\n'
2013 ' GDBusConnection *connection,\n'
2014 ' const gchar *sender,\n'
2015 ' const gchar *object_path,\n'
2016 ' const gchar *interface_name,\n'
2017 ' const gchar *property_name,\n'
2018 ' GError **error,\n'
2019 ' gpointer user_data)\n'
2021 ' %sSkeleton *skeleton = %s%s_SKELETON (user_data);\n'
2022 ' GValue value = {0};\n'
2023 ' GParamSpec *pspec;\n'
2024 ' _ExtendedGDBusPropertyInfo *info;\n'
2026 %(i.name_lower, i.camel_name, i.ns_upper, i.name_upper))
2027 self.c.write(' ret = NULL;\n'
2028 ' info = (_ExtendedGDBusPropertyInfo *) g_dbus_interface_info_lookup_property ((GDBusInterfaceInfo *) &_%s_interface_info, property_name);\n'
2029 ' g_assert (info != NULL);\n'
2030 ' pspec = g_object_class_find_property (G_OBJECT_GET_CLASS (skeleton), info->hyphen_name);\n'
2031 ' if (pspec == NULL)\n'
2033 ' g_set_error (error, G_DBUS_ERROR, G_DBUS_ERROR_INVALID_ARGS, "No property with name %%s", property_name);\n'
2037 ' g_value_init (&value, pspec->value_type);\n'
2038 ' g_object_get_property (G_OBJECT (skeleton), info->hyphen_name, &value);\n'
2039 ' ret = g_dbus_gvalue_to_gvariant (&value, G_VARIANT_TYPE (info->parent_struct.signature));\n'
2040 ' g_value_unset (&value);\n'
2047 self.c.write('static gboolean\n'
2048 '_%s_skeleton_handle_set_property (\n'
2049 ' GDBusConnection *connection,\n'
2050 ' const gchar *sender,\n'
2051 ' const gchar *object_path,\n'
2052 ' const gchar *interface_name,\n'
2053 ' const gchar *property_name,\n'
2054 ' GVariant *variant,\n'
2055 ' GError **error,\n'
2056 ' gpointer user_data)\n'
2058 ' %sSkeleton *skeleton = %s%s_SKELETON (user_data);\n'
2059 ' GValue value = {0};\n'
2060 ' GParamSpec *pspec;\n'
2061 ' _ExtendedGDBusPropertyInfo *info;\n'
2063 %(i.name_lower, i.camel_name, i.ns_upper, i.name_upper))
2064 self.c.write(' ret = FALSE;\n'
2065 ' info = (_ExtendedGDBusPropertyInfo *) g_dbus_interface_info_lookup_property ((GDBusInterfaceInfo *) &_%s_interface_info, property_name);\n'
2066 ' g_assert (info != NULL);\n'
2067 ' pspec = g_object_class_find_property (G_OBJECT_GET_CLASS (skeleton), info->hyphen_name);\n'
2068 ' if (pspec == NULL)\n'
2070 ' g_set_error (error, G_DBUS_ERROR, G_DBUS_ERROR_INVALID_ARGS, "No property with name %%s", property_name);\n'
2074 ' if (info->use_gvariant)\n'
2075 ' g_value_set_variant (&value, variant);\n'
2077 ' g_dbus_gvariant_to_gvalue (variant, &value);\n'
2078 ' g_object_set_property (G_OBJECT (skeleton), info->hyphen_name, &value);\n'
2079 ' g_value_unset (&value);\n'
2088 self.c.write('static const GDBusInterfaceVTable _%s_skeleton_vtable =\n'
2090 ' _%s_skeleton_handle_method_call,\n'
2091 ' _%s_skeleton_handle_get_property,\n'
2092 ' _%s_skeleton_handle_set_property\n'
2094 '\n'%(i.name_lower, i.name_lower, i.name_lower, i.name_lower))
2096 self.c.write('static GDBusInterfaceInfo *\n'
2097 '%s_skeleton_dbus_interface_get_info (GDBusInterfaceSkeleton *skeleton)\n'
2099 ' return %s_interface_info ();\n'
2100 %(i.name_lower, i.name_lower))
2104 self.c.write('static GDBusInterfaceVTable *\n'
2105 '%s_skeleton_dbus_interface_get_vtable (GDBusInterfaceSkeleton *skeleton)\n'
2107 ' return (GDBusInterfaceVTable *) &_%s_skeleton_vtable;\n'
2108 %(i.name_lower, i.name_lower))
2112 self.c.write('static GVariant *\n'
2113 '%s_skeleton_dbus_interface_get_properties (GDBusInterfaceSkeleton *_skeleton)\n'
2115 ' %sSkeleton *skeleton = %s%s_SKELETON (_skeleton);\n'
2116 %(i.name_lower, i.camel_name, i.ns_upper, i.name_upper))
2118 ' GVariantBuilder builder;\n'
2120 ' g_variant_builder_init (&builder, G_VARIANT_TYPE ("a{sv}"));\n'
2121 ' if (_%s_interface_info.parent_struct.properties == NULL)\n'
2123 ' for (n = 0; _%s_interface_info.parent_struct.properties[n] != NULL; n++)\n'
2125 ' GDBusPropertyInfo *info = _%s_interface_info.parent_struct.properties[n];\n'
2126 ' if (info->flags & G_DBUS_PROPERTY_INFO_FLAGS_READABLE)\n'
2128 ' GVariant *value;\n'
2129 ' value = _%s_skeleton_handle_get_property (g_dbus_interface_skeleton_get_connection (G_DBUS_INTERFACE_SKELETON (skeleton)), NULL, g_dbus_interface_skeleton_get_object_path (G_DBUS_INTERFACE_SKELETON (skeleton)), "%s", info->name, NULL, skeleton);\n'
2130 ' if (value != NULL)\n'
2132 ' g_variant_take_ref (value);\n'
2133 ' g_variant_builder_add (&builder, "{sv}", info->name, value);\n'
2134 ' g_variant_unref (value);\n'
2139 ' return g_variant_builder_end (&builder);\n'
2142 %(i.name_lower, i.name_lower, i.name_lower, i.name_lower, i.name))
2144 if len(i.properties) > 0:
2145 self.c.write('static gboolean _%s_emit_changed (gpointer user_data);\n'
2149 self.c.write('static void\n'
2150 '%s_skeleton_dbus_interface_flush (GDBusInterfaceSkeleton *_skeleton)\n'
2153 if len(i.properties) > 0:
2154 self.c.write(' %sSkeleton *skeleton = %s%s_SKELETON (_skeleton);\n'
2155 ' gboolean emit_changed = FALSE;\n'
2157 ' g_mutex_lock (skeleton->priv->lock);\n'
2158 ' if (skeleton->priv->changed_properties_idle_source != NULL)\n'
2160 ' g_source_destroy (skeleton->priv->changed_properties_idle_source);\n'
2161 ' skeleton->priv->changed_properties_idle_source = NULL;\n'
2162 ' emit_changed = TRUE;\n'
2164 ' g_mutex_unlock (skeleton->priv->lock);\n'
2166 ' if (emit_changed)\n'
2167 ' _%s_emit_changed (skeleton);\n'
2168 %(i.camel_name, i.ns_upper, i.name_upper, i.name_lower))
2173 self.c.write('static void\n'
2174 '_%s_on_signal_%s (\n'
2175 ' %s *object'%(i.name_lower, s.name_lower, i.camel_name))
2177 self.c.write(',\n %s%s'%(a.ctype_in, a.name))
2180 ' %sSkeleton *skeleton = %s%s_SKELETON (object);\n'
2181 ' GDBusConnection *connection = g_dbus_interface_skeleton_get_connection (G_DBUS_INTERFACE_SKELETON (skeleton));\n'
2182 %(i.camel_name, i.ns_upper, i.name_upper))
2183 self.c.write(' if (connection == NULL)\n'
2185 ' g_dbus_connection_emit_signal (connection,\n'
2186 ' NULL, g_dbus_interface_skeleton_get_object_path (G_DBUS_INTERFACE_SKELETON (skeleton)), "%s", "%s",\n'
2187 ' g_variant_new ("('
2190 self.c.write('%s'%(a.format_in))
2193 self.c.write(',\n %s'%(a.name))
2194 self.c.write('), NULL);\n')
2198 self.c.write('static void\n'
2199 '%s_skeleton_iface_init (%sIface *iface)\n'
2201 %(i.name_lower, i.camel_name))
2203 self.c.write(' iface->%s = _%s_on_signal_%s;\n'
2204 %(s.name_lower, i.name_lower, s.name_lower))
2207 self.c.write('#define %s_skeleton_get_type %s_skeleton_get_type\n'%(i.name_lower, i.name_lower))
2208 self.c.write('G_DEFINE_TYPE_WITH_CODE (%sSkeleton, %s_skeleton, G_TYPE_DBUS_INTERFACE_SKELETON,\n'%(i.camel_name, i.name_lower))
2209 self.c.write(' G_IMPLEMENT_INTERFACE (%sTYPE_%s, %s_skeleton_iface_init));\n'%(i.ns_upper, i.name_upper, i.name_lower))
2210 self.c.write('#undef %s_skeleton_get_type\n'
2211 '\n'%(i.name_lower))
2214 self.c.write('static void\n'
2215 '%s_skeleton_finalize (GObject *object)\n'
2216 '{\n'%(i.name_lower))
2217 self.c.write(' %sSkeleton *skeleton = %s%s_SKELETON (object);\n'%(i.camel_name, i.ns_upper, i.name_upper))
2218 if len(i.properties) > 0:
2219 self.c.write(' g_value_array_free (skeleton->priv->properties);\n')
2220 self.c.write(' g_list_foreach (skeleton->priv->changed_properties, (GFunc) _changed_property_free, NULL);\n')
2221 self.c.write(' g_list_free (skeleton->priv->changed_properties);\n')
2222 self.c.write(' if (skeleton->priv->changed_properties_idle_source != NULL)\n')
2223 self.c.write(' g_source_destroy (skeleton->priv->changed_properties_idle_source);\n')
2224 self.c.write(' if (skeleton->priv->context != NULL)\n')
2225 self.c.write(' g_main_context_unref (skeleton->priv->context);\n')
2226 self.c.write(' g_mutex_free (skeleton->priv->lock);\n')
2227 self.c.write(' G_OBJECT_CLASS (%s_skeleton_parent_class)->finalize (object);\n'
2229 '\n'%(i.name_lower))
2231 # property accessors (TODO: generate PropertiesChanged signals in setter)
2232 if len(i.properties) > 0:
2233 self.c.write('static void\n'
2234 '%s_skeleton_get_property (GObject *object,\n'
2237 ' GParamSpec *pspec)\n'
2238 '{\n'%(i.name_lower))
2239 self.c.write(' %sSkeleton *skeleton = %s%s_SKELETON (object);\n'
2240 ' g_assert (prop_id != 0 && prop_id - 1 < %d);\n'
2241 ' g_mutex_lock (skeleton->priv->lock);\n'
2242 ' g_value_copy (&skeleton->priv->properties->values[prop_id - 1], value);\n'
2243 ' g_mutex_unlock (skeleton->priv->lock);\n'
2244 %(i.camel_name, i.ns_upper, i.name_upper, len(i.properties)))
2248 # if property is already scheduled then re-use entry.. though it could be
2251 # foo_set_prop_bar (object, "");
2252 # foo_set_prop_bar (object, "blah");
2254 # say, every update... In this case, where nothing happens, we obviously
2255 # don't want a PropertiesChanged() event. We can easily check for this
2256 # by comparing against the _original value_ recorded before the first
2257 # change event. If the latest value is not different from the original
2258 # one, we can simply ignore the ChangedProperty
2260 self.c.write('static gboolean\n'
2261 '_%s_emit_changed (gpointer user_data)\n'
2263 ' %sSkeleton *skeleton = %s%s_SKELETON (user_data);\n'
2264 %(i.name_lower, i.camel_name, i.ns_upper, i.name_upper))
2265 self.c.write(' GList *l;\n'
2266 ' GVariantBuilder builder;\n'
2267 ' GVariantBuilder invalidated_builder;\n'
2268 ' guint num_changes;\n'
2270 ' g_mutex_lock (skeleton->priv->lock);\n'
2271 ' g_variant_builder_init (&builder, G_VARIANT_TYPE ("a{sv}"));\n'
2272 ' g_variant_builder_init (&invalidated_builder, G_VARIANT_TYPE ("as"));\n'
2273 ' for (l = skeleton->priv->changed_properties, num_changes = 0; l != NULL; l = l->next)\n'
2275 ' ChangedProperty *cp = l->data;\n'
2276 ' GVariant *variant;\n'
2277 ' const GValue *cur_value;\n'
2279 ' cur_value = &skeleton->priv->properties->values[cp->prop_id - 1];\n'
2280 ' if (!_g_value_equal (cur_value, &cp->orig_value))\n'
2282 ' variant = g_dbus_gvalue_to_gvariant (cur_value, G_VARIANT_TYPE (cp->info->parent_struct.signature));\n'
2283 ' g_variant_builder_add (&builder, "{sv}", cp->info->parent_struct.name, variant);\n'
2284 ' g_variant_unref (variant);\n'
2288 ' if (num_changes > 0)\n'
2290 ' g_dbus_connection_emit_signal (g_dbus_interface_skeleton_get_connection (G_DBUS_INTERFACE_SKELETON (skeleton)),\n'
2291 ' NULL, g_dbus_interface_skeleton_get_object_path (G_DBUS_INTERFACE_SKELETON (skeleton)),\n'
2292 ' "org.freedesktop.DBus.Properties",\n'
2293 ' "PropertiesChanged",\n'
2294 ' g_variant_new ("(sa{sv}as)",\n'
2296 ' &builder, &invalidated_builder),\n'
2301 ' g_variant_builder_clear (&builder);\n'
2302 ' g_variant_builder_clear (&invalidated_builder);\n'
2305 self.c.write(' g_list_foreach (skeleton->priv->changed_properties, (GFunc) _changed_property_free, NULL);\n')
2306 self.c.write(' g_list_free (skeleton->priv->changed_properties);\n')
2307 self.c.write(' skeleton->priv->changed_properties = NULL;\n')
2308 self.c.write(' skeleton->priv->changed_properties_idle_source = NULL;\n')
2309 self.c.write(' g_mutex_unlock (skeleton->priv->lock);\n')
2310 self.c.write(' return FALSE;\n'
2313 # holding lock while being called
2314 self.c.write('static void\n'
2315 '_%s_schedule_emit_changed (%sSkeleton *skeleton, const _ExtendedGDBusPropertyInfo *info, guint prop_id, const GValue *orig_value)\n'
2317 ' ChangedProperty *cp;\n'
2320 ' for (l = skeleton->priv->changed_properties; l != NULL; l = l->next)\n'
2322 ' ChangedProperty *i_cp = l->data;\n'
2323 ' if (i_cp->info == info)\n'
2329 %(i.name_lower, i.camel_name))
2330 self.c.write(' if (cp == NULL)\n'
2332 ' cp = g_new0 (ChangedProperty, 1);\n'
2333 ' cp->prop_id = prop_id;\n'
2334 ' cp->info = info;\n'
2335 ' skeleton->priv->changed_properties = g_list_prepend (skeleton->priv->changed_properties, cp);\n'
2336 ' g_value_init (&cp->orig_value, G_VALUE_TYPE (orig_value));\n'
2337 ' g_value_copy (orig_value, &cp->orig_value);\n'
2343 # Postpone setting up the refresh source until the ::notify signal is emitted as
2344 # this allows use of g_object_freeze_notify()/g_object_thaw_notify() ...
2345 # This is useful when updating several properties from another thread than
2346 # where the idle will be emitted from
2347 self.c.write('static void\n'
2348 '%s_skeleton_notify (GObject *object,\n'
2349 ' GParamSpec *pspec)\n'
2351 ' %sSkeleton *skeleton = %s%s_SKELETON (object);\n'
2352 ' g_mutex_lock (skeleton->priv->lock);\n'
2353 ' if (skeleton->priv->changed_properties != NULL &&\n'
2354 ' skeleton->priv->changed_properties_idle_source == NULL)\n'
2356 ' skeleton->priv->changed_properties_idle_source = g_idle_source_new ();\n'
2357 ' g_source_set_priority (skeleton->priv->changed_properties_idle_source, G_PRIORITY_DEFAULT);\n'
2358 ' g_source_set_callback (skeleton->priv->changed_properties_idle_source, _%s_emit_changed, g_object_ref (skeleton), (GDestroyNotify) g_object_unref);\n'
2359 ' g_source_attach (skeleton->priv->changed_properties_idle_source, skeleton->priv->context);\n'
2360 ' g_source_unref (skeleton->priv->changed_properties_idle_source);\n'
2362 ' g_mutex_unlock (skeleton->priv->lock);\n'
2365 %(i.name_lower, i.camel_name, i.ns_upper, i.name_upper, i.name_lower))
2367 self.c.write('static void\n'
2368 '%s_skeleton_set_property (GObject *object,\n'
2370 ' const GValue *value,\n'
2371 ' GParamSpec *pspec)\n'
2372 '{\n'%(i.name_lower))
2373 self.c.write(' %sSkeleton *skeleton = %s%s_SKELETON (object);\n'
2374 ' g_assert (prop_id != 0 && prop_id - 1 < %d);\n'
2375 ' g_mutex_lock (skeleton->priv->lock);\n'
2376 ' g_object_freeze_notify (object);\n'
2377 ' if (!_g_value_equal (value, &skeleton->priv->properties->values[prop_id - 1]))\n'
2379 ' if (g_dbus_interface_skeleton_get_connection (G_DBUS_INTERFACE_SKELETON (skeleton)) != NULL)\n'
2380 ' _%s_schedule_emit_changed (skeleton, _%s_property_info_pointers[prop_id - 1], prop_id, &skeleton->priv->properties->values[prop_id - 1]);\n'
2381 ' g_value_copy (value, &skeleton->priv->properties->values[prop_id - 1]);\n'
2382 ' g_object_notify_by_pspec (object, pspec);\n'
2384 ' g_mutex_unlock (skeleton->priv->lock);\n'
2385 ' g_object_thaw_notify (object);\n'
2386 %(i.camel_name, i.ns_upper, i.name_upper, len(i.properties), i.name_lower, i.name_lower))
2390 self.c.write('static void\n'
2391 '%s_skeleton_init (%sSkeleton *skeleton)\n'
2393 ' skeleton->priv = G_TYPE_INSTANCE_GET_PRIVATE (skeleton, %sTYPE_%s_SKELETON, %sSkeletonPrivate);\n'
2394 %(i.name_lower, i.camel_name, i.ns_upper, i.name_upper, i.camel_name))
2395 self.c.write(' skeleton->priv->lock = g_mutex_new ();\n')
2396 self.c.write(' skeleton->priv->context = g_main_context_get_thread_default ();\n')
2397 self.c.write(' if (skeleton->priv->context != NULL)\n')
2398 self.c.write(' g_main_context_ref (skeleton->priv->context);\n')
2399 if len(i.properties) > 0:
2400 self.c.write(' skeleton->priv->properties = g_value_array_new (%d);\n'%(len(i.properties)))
2402 for p in i.properties:
2403 self.c.write(' g_value_array_append (skeleton->priv->properties, NULL);\n')
2404 self.c.write(' g_value_init (&skeleton->priv->properties->values[%d], %s);\n'%(n, p.arg.gtype))
2408 self.c.write('static void\n'
2409 '%s_skeleton_class_init (%sSkeletonClass *klass)\n'
2411 ' GObjectClass *gobject_class;\n'
2412 ' GDBusInterfaceSkeletonClass *skeleton_class;\n'
2414 ' g_type_class_add_private (klass, sizeof (%sSkeletonPrivate));\n'
2416 ' gobject_class = G_OBJECT_CLASS (klass);\n'
2417 ' gobject_class->finalize = %s_skeleton_finalize;\n'
2418 %(i.name_lower, i.camel_name, i.camel_name, i.name_lower))
2419 if len(i.properties) > 0:
2420 self.c.write(' gobject_class->get_property = %s_skeleton_get_property;\n'
2421 ' gobject_class->set_property = %s_skeleton_set_property;\n'
2422 ' gobject_class->notify = %s_skeleton_notify;\n'
2423 '\n'%(i.name_lower, i.name_lower, i.name_lower))
2425 ' %s_override_properties (gobject_class, 1);\n'%(i.name_lower))
2427 ' skeleton_class = G_DBUS_INTERFACE_SKELETON_CLASS (klass);\n');
2428 self.c.write(' skeleton_class->get_info = %s_skeleton_dbus_interface_get_info;\n'%(i.name_lower))
2429 self.c.write(' skeleton_class->get_properties = %s_skeleton_dbus_interface_get_properties;\n'%(i.name_lower))
2430 self.c.write(' skeleton_class->flush = %s_skeleton_dbus_interface_flush;\n'%(i.name_lower))
2431 self.c.write(' skeleton_class->get_vtable = %s_skeleton_dbus_interface_get_vtable;\n'%(i.name_lower))
2436 self.c.write(self.docbook_gen.expand(
2438 ' * %s_skeleton_new:\n'
2440 ' * Creates a skeleton object for the D-Bus interface #%s.\n'
2442 ' * Returns: (transfer full) (type %sSkeleton): The skeleton object.\n'
2443 %(i.name_lower, i.name, i.camel_name), False))
2444 self.write_gtkdoc_deprecated_and_since_and_close(i, self.c, 0)
2445 self.c.write('%s *\n'
2446 '%s_skeleton_new (void)\n'
2448 ' return %s%s (g_object_new (%sTYPE_%s_SKELETON, NULL));\n'
2450 '\n'%(i.camel_name, i.name_lower, i.ns_upper, i.name_upper, i.ns_upper, i.name_upper))
2452 # ---------------------------------------------------------------------------------------------------
2454 def generate_object(self):
2455 self.c.write('/* ------------------------------------------------------------------------\n'
2456 ' * Code for Object, ObjectProxy and ObjectSkeleton\n'
2457 ' * ------------------------------------------------------------------------\n'
2461 self.c.write(self.docbook_gen.expand(
2463 ' * SECTION:%sObject\n'
2464 ' * @title: %sObject\n'
2465 ' * @short_description: Specialized GDBusObject types\n'
2467 ' * This section contains the #%sObject, #%sObjectProxy, and #%sObjectSkeleton types which make it easier to work with objects implementing generated types for D-Bus interfaces.\n'
2469 %(self.namespace, self.namespace, self.namespace, self.namespace, self.namespace), False))
2472 self.c.write(self.docbook_gen.expand(
2476 ' * The #%sObject type is a specialized container of interfaces.\n'
2478 %(self.namespace, self.namespace), False))
2481 self.c.write(self.docbook_gen.expand(
2483 ' * %sObjectIface:\n'
2484 ' * @parent_iface: The parent interface.\n'
2486 ' * Virtual table for the #%sObject interface.\n'
2488 %(self.namespace, self.namespace), False))
2491 self.c.write('static void\n'
2492 '%sobject_default_init (%sObjectIface *iface)\n'
2494 %(self.ns_lower, self.namespace));
2495 for i in self.ifaces:
2496 self.c.write(self.docbook_gen.expand(
2500 ' * The #%s instance corresponding to the D-Bus interface #%s, if any.\n'
2502 ' * Connect to the #GObject::notify signal to get informed of property changes.\n'
2503 %(self.namespace, i.name_hyphen, i.camel_name, i.name), False))
2504 self.write_gtkdoc_deprecated_and_since_and_close(i, self.c, 2)
2505 self.c.write(' g_object_interface_install_property (iface, g_param_spec_object ("%s", "%s", "%s", %sTYPE_%s, G_PARAM_READWRITE|G_PARAM_STATIC_STRINGS));\n'
2507 %(i.name_hyphen, i.name_hyphen, i.name_hyphen, self.ns_upper, i.name_upper))
2511 self.c.write('typedef %sObjectIface %sObjectInterface;\n'%(self.namespace, self.namespace))
2512 self.c.write('G_DEFINE_INTERFACE_WITH_CODE (%sObject, %sobject, G_TYPE_OBJECT, g_type_interface_add_prerequisite (g_define_type_id, G_TYPE_DBUS_OBJECT));\n'%(self.namespace, self.ns_lower))
2515 for i in self.ifaces:
2516 self.c.write(self.docbook_gen.expand(
2518 ' * %sobject_get_%s:\n'
2519 ' * @object: A #%sObject.\n'
2521 ' * Gets the #%s instance for the D-Bus interface #%s on @object, if any.\n'
2523 ' * Returns: (transfer full): A #%s that must be freed with g_object_unref() or %%NULL if @object does not implement the interface.\n'
2524 %(self.ns_lower, i.name_upper.lower(), self.namespace, i.camel_name, i.name, i.camel_name), False))
2525 self.write_gtkdoc_deprecated_and_since_and_close(i, self.c, 0)
2526 self.c.write ('%s *%sobject_get_%s (%sObject *object)\n'
2527 %(i.camel_name, self.ns_lower, i.name_upper.lower(), self.namespace))
2529 ' GDBusInterface *ret;\n'
2530 ' ret = g_dbus_object_get_interface (G_DBUS_OBJECT (object), "%s");\n'
2531 ' if (ret == NULL)\n'
2533 ' return %s%s (ret);\n'
2536 %(i.name, self.ns_upper, i.name_upper))
2538 for i in self.ifaces:
2539 self.c.write(self.docbook_gen.expand(
2541 ' * %sobject_peek_%s: (skip)\n'
2542 ' * @object: A #%sObject.\n'
2544 ' * Like %sobject_get_%s() but doesn\' increase the reference count on the returned object.\n'
2546 ' * <warning>It is not safe to use the returned object if you are on another thread than the one where the #GDBusObjectManagerClient or #GDBusObjectManagerServer for @object is running.</warning>\n'
2548 ' * Returns: (transfer none): A #%s or %%NULL if @object does not implement the interface. Do not free the returned object, it is owned by @object.\n'
2549 %(self.ns_lower, i.name_upper.lower(), self.namespace, self.ns_lower, i.name_upper.lower(), i.camel_name), False))
2550 self.write_gtkdoc_deprecated_and_since_and_close(i, self.c, 0)
2551 self.c.write ('%s *%sobject_peek_%s (%sObject *object)\n'
2552 %(i.camel_name, self.ns_lower, i.name_upper.lower(), self.namespace))
2554 ' GDBusInterface *ret;\n'
2555 ' ret = g_dbus_object_get_interface (G_DBUS_OBJECT (object), "%s");\n'
2556 ' if (ret == NULL)\n'
2558 ' g_object_unref (ret);\n'
2559 ' return %s%s (ret);\n'
2562 %(i.name, self.ns_upper, i.name_upper))
2564 # shared by ObjectProxy and ObjectSkeleton classes
2565 self.c.write('static void\n'
2566 '%sobject_notify (GDBusObject *object, GDBusInterface *interface)\n'
2568 ' g_object_notify (G_OBJECT (object), ((_ExtendedGDBusInterfaceInfo *) g_dbus_interface_get_info (interface))->hyphen_name);\n'
2573 self.c.write(self.docbook_gen.expand(
2575 ' * %sObjectProxy:\n'
2577 ' * The #%sObjectProxy structure contains only private data and should only be accessed using the provided API.\n'
2578 %(self.namespace, self.namespace), False))
2579 self.c.write(' */\n')
2581 self.c.write(self.docbook_gen.expand(
2583 ' * %sObjectProxyClass:\n'
2584 ' * @parent_class: The parent class.\n'
2586 ' * Class structure for #%sObjectProxy.\n'
2587 %(self.namespace, self.namespace), False))
2588 self.c.write(' */\n')
2591 self.c.write('static void\n'
2592 '%sobject_proxy__%sobject_iface_init (%sObjectIface *iface)\n'
2596 %(self.ns_lower, self.ns_lower, self.namespace))
2597 self.c.write('static void\n'
2598 '%sobject_proxy__g_dbus_object_iface_init (GDBusObjectIface *iface)\n'
2600 ' iface->interface_added = %sobject_notify;\n'
2601 ' iface->interface_removed = %sobject_notify;\n'
2604 %(self.ns_lower, self.ns_lower, self.ns_lower))
2606 self.c.write('G_DEFINE_TYPE_WITH_CODE (%sObjectProxy, %sobject_proxy, G_TYPE_DBUS_OBJECT_PROXY,\n'
2607 ' G_IMPLEMENT_INTERFACE (%sTYPE_OBJECT, %sobject_proxy__%sobject_iface_init)\n'
2608 ' G_IMPLEMENT_INTERFACE (G_TYPE_DBUS_OBJECT, %sobject_proxy__g_dbus_object_iface_init));\n'
2610 %(self.namespace, self.ns_lower, self.ns_upper, self.ns_lower, self.ns_lower, self.ns_lower))
2612 self.c.write('static void\n'
2613 '%sobject_proxy_init (%sObjectProxy *object)\n'
2616 '\n'%(self.ns_lower, self.namespace))
2617 self.c.write('static void\n'
2618 '%sobject_proxy_set_property (GObject *_object,\n'
2620 ' const GValue *value,\n'
2621 ' GParamSpec *pspec)\n'
2623 ' G_OBJECT_WARN_INVALID_PROPERTY_ID (_object, prop_id, pspec);\n'
2627 self.c.write('static void\n'
2628 '%sobject_proxy_get_property (GObject *_object,\n'
2631 ' GParamSpec *pspec)\n'
2633 ' %sObjectProxy *object = %sOBJECT_PROXY (_object);\n'
2634 ' GDBusInterface *interface;\n'
2636 ' switch (prop_id)\n'
2638 %(self.ns_lower, self.namespace, self.ns_upper))
2640 for i in self.ifaces:
2641 self.c.write(' case %d:\n'
2642 ' interface = g_dbus_object_get_interface (G_DBUS_OBJECT (object), "%s");\n'
2643 ' g_value_take_object (value, interface);\n'
2648 self.c.write(' default:\n'
2649 ' G_OBJECT_WARN_INVALID_PROPERTY_ID (_object, prop_id, pspec);\n'
2654 self.c.write('static void\n'
2655 '%sobject_proxy_class_init (%sObjectProxyClass *klass)\n'
2657 ' GObjectClass *gobject_class = G_OBJECT_CLASS (klass);\n'
2659 ' gobject_class->set_property = %sobject_proxy_set_property;\n'
2660 ' gobject_class->get_property = %sobject_proxy_get_property;\n'
2662 %(self.ns_lower, self.namespace, self.ns_lower, self.ns_lower))
2664 for i in self.ifaces:
2665 self.c.write(' g_object_class_override_property (gobject_class, %d, "%s");'
2667 %(n, i.name_hyphen))
2672 self.c.write(self.docbook_gen.expand(
2674 ' * %sobject_proxy_new:\n'
2675 ' * @connection: A #GDBusConnection.\n'
2676 ' * @object_path: An object path.\n'
2678 ' * Creates a new proxy object.\n'
2680 ' * Returns: (transfer full): The proxy object.\n'
2682 %(self.ns_lower), False))
2683 self.c.write('%sObjectProxy *\n'
2684 '%sobject_proxy_new (GDBusConnection *connection,\n'
2685 ' const gchar *object_path)\n'
2687 ' g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), NULL);\n'
2688 ' g_return_val_if_fail (g_variant_is_object_path (object_path), NULL);\n'
2689 ' return %sOBJECT_PROXY (g_object_new (%sTYPE_OBJECT_PROXY, "connection", connection, "object-path", object_path, NULL));\n'
2691 '\n'%(self.namespace, self.ns_lower, self.ns_upper, self.ns_upper))
2693 self.c.write(self.docbook_gen.expand(
2695 ' * %sObjectSkeleton:\n'
2697 ' * The #%sObjectSkeleton structure contains only private data and should only be accessed using the provided API.\n'
2698 %(self.namespace, self.namespace), False))
2699 self.c.write(' */\n')
2701 self.c.write(self.docbook_gen.expand(
2703 ' * %sObjectSkeletonClass:\n'
2704 ' * @parent_class: The parent class.\n'
2706 ' * Class structure for #%sObjectSkeleton.\n'
2707 %(self.namespace, self.namespace), False))
2708 self.c.write(' */\n')
2711 self.c.write('static void\n'
2712 '%sobject_skeleton__%sobject_iface_init (%sObjectIface *iface)\n'
2716 %(self.ns_lower, self.ns_lower, self.namespace))
2718 self.c.write('static void\n'
2719 '%sobject_skeleton__g_dbus_object_iface_init (GDBusObjectIface *iface)\n'
2721 ' iface->interface_added = %sobject_notify;\n'
2722 ' iface->interface_removed = %sobject_notify;\n'
2725 %(self.ns_lower, self.ns_lower, self.ns_lower))
2726 self.c.write('G_DEFINE_TYPE_WITH_CODE (%sObjectSkeleton, %sobject_skeleton, G_TYPE_DBUS_OBJECT_SKELETON,\n'
2727 ' G_IMPLEMENT_INTERFACE (%sTYPE_OBJECT, %sobject_skeleton__%sobject_iface_init)\n'
2728 ' G_IMPLEMENT_INTERFACE (G_TYPE_DBUS_OBJECT, %sobject_skeleton__g_dbus_object_iface_init));\n'
2730 %(self.namespace, self.ns_lower, self.ns_upper, self.ns_lower, self.ns_lower, self.ns_lower))
2732 self.c.write('static void\n'
2733 '%sobject_skeleton_init (%sObjectSkeleton *object)\n'
2736 '\n'%(self.ns_lower, self.namespace))
2737 self.c.write('static void\n'
2738 '%sobject_skeleton_set_property (GObject *_object,\n'
2740 ' const GValue *value,\n'
2741 ' GParamSpec *pspec)\n'
2743 ' %sObjectSkeleton *object = %sOBJECT_SKELETON (_object);\n'
2744 ' GDBusInterfaceSkeleton *interface;\n'
2746 ' switch (prop_id)\n'
2748 %(self.ns_lower, self.namespace, self.ns_upper))
2750 for i in self.ifaces:
2751 self.c.write(' case %d:\n'
2752 ' interface = g_value_get_object (value);\n'
2753 ' if (interface != NULL)\n'
2755 ' g_warn_if_fail (%sIS_%s (interface));\n'
2756 ' g_dbus_object_skeleton_add_interface (G_DBUS_OBJECT_SKELETON (object), interface);\n'
2760 ' g_dbus_object_skeleton_remove_interface_by_name (G_DBUS_OBJECT_SKELETON (object), "%s");\n'
2764 %(n, self.ns_upper, i.name_upper, i.name))
2766 self.c.write(' default:\n'
2767 ' G_OBJECT_WARN_INVALID_PROPERTY_ID (_object, prop_id, pspec);\n'
2772 self.c.write('static void\n'
2773 '%sobject_skeleton_get_property (GObject *_object,\n'
2776 ' GParamSpec *pspec)\n'
2778 ' %sObjectSkeleton *object = %sOBJECT_SKELETON (_object);\n'
2779 ' GDBusInterface *interface;\n'
2781 ' switch (prop_id)\n'
2783 %(self.ns_lower, self.namespace, self.ns_upper))
2785 for i in self.ifaces:
2786 self.c.write(' case %d:\n'
2787 ' interface = g_dbus_object_get_interface (G_DBUS_OBJECT (object), "%s");\n'
2788 ' g_value_take_object (value, interface);\n'
2793 self.c.write(' default:\n'
2794 ' G_OBJECT_WARN_INVALID_PROPERTY_ID (_object, prop_id, pspec);\n'
2799 self.c.write('static void\n'
2800 '%sobject_skeleton_class_init (%sObjectSkeletonClass *klass)\n'
2802 ' GObjectClass *gobject_class = G_OBJECT_CLASS (klass);\n'
2804 ' gobject_class->set_property = %sobject_skeleton_set_property;\n'
2805 ' gobject_class->get_property = %sobject_skeleton_get_property;\n'
2807 %(self.ns_lower, self.namespace, self.ns_lower, self.ns_lower))
2809 for i in self.ifaces:
2810 self.c.write(' g_object_class_override_property (gobject_class, %d, "%s");'
2812 %(n, i.name_hyphen))
2816 self.c.write(self.docbook_gen.expand(
2818 ' * %sobject_skeleton_new:\n'
2819 ' * @object_path: An object path.\n'
2821 ' * Creates a new skeleton object.\n'
2823 ' * Returns: (transfer full): The skeleton object.\n'
2825 %(self.ns_lower), False))
2826 self.c.write('%sObjectSkeleton *\n'
2827 '%sobject_skeleton_new (const gchar *object_path)\n'
2829 ' g_return_val_if_fail (g_variant_is_object_path (object_path), NULL);\n'
2830 ' return %sOBJECT_SKELETON (g_object_new (%sTYPE_OBJECT_SKELETON, "object-path", object_path, NULL));\n'
2832 '\n'%(self.namespace, self.ns_lower, self.ns_upper, self.ns_upper))
2833 for i in self.ifaces:
2834 self.c.write(self.docbook_gen.expand(
2836 ' * %sobject_skeleton_set_%s:\n'
2837 ' * @object: A #%sObjectSkeleton.\n'
2838 ' * @interface_: (allow-none): A #%s or %%NULL to clear the interface.\n'
2840 ' * Sets the #%s instance for the D-Bus interface #%s on @object.\n'
2841 %(self.ns_lower, i.name_upper.lower(), self.namespace, i.camel_name, i.camel_name, i.name), False))
2842 self.write_gtkdoc_deprecated_and_since_and_close(i, self.c, 0)
2843 self.c.write ('void %sobject_skeleton_set_%s (%sObjectSkeleton *object, %s *interface_)\n'
2844 %(self.ns_lower, i.name_upper.lower(), self.namespace, i.camel_name))
2846 ' g_object_set (G_OBJECT (object), "%s", interface_, NULL);\n'
2853 def generate_object_manager_client(self):
2854 self.c.write('/* ------------------------------------------------------------------------\n'
2855 ' * Code for ObjectManager client\n'
2856 ' * ------------------------------------------------------------------------\n'
2860 self.c.write(self.docbook_gen.expand(
2862 ' * SECTION:%sObjectManagerClient\n'
2863 ' * @title: %sObjectManagerClient\n'
2864 ' * @short_description: Generated GDBusObjectManagerClient type\n'
2866 ' * This section contains a #GDBusObjectManagerClient that uses %sobject_manager_client_get_proxy_type() as the #GDBusProxyTypeFunc.\n'
2868 %(self.namespace, self.namespace, self.ns_lower), False))
2871 self.c.write(self.docbook_gen.expand(
2873 ' * %sObjectManagerClient:\n'
2875 ' * The #%sObjectManagerClient structure contains only private data and should only be accessed using the provided API.\n'
2876 %(self.namespace, self.namespace), False))
2877 self.c.write(' */\n')
2880 self.c.write(self.docbook_gen.expand(
2882 ' * %sObjectManagerClientClass:\n'
2883 ' * @parent_class: The parent class.\n'
2885 ' * Class structure for #%sObjectManagerClient.\n'
2886 %(self.namespace, self.namespace), False))
2887 self.c.write(' */\n')
2891 self.c.write('G_DEFINE_TYPE (%sObjectManagerClient, %sobject_manager_client, G_TYPE_DBUS_OBJECT_MANAGER_CLIENT);\n'
2893 %(self.namespace, self.ns_lower))
2896 self.c.write('static void\n'
2897 '%sobject_manager_client_init (%sObjectManagerClient *manager)\n'
2900 '\n'%(self.ns_lower, self.namespace))
2901 self.c.write('static void\n'
2902 '%sobject_manager_client_class_init (%sObjectManagerClientClass *klass)\n'
2905 '\n'%(self.ns_lower, self.namespace))
2907 self.c.write(self.docbook_gen.expand(
2909 ' * %sobject_manager_client_get_proxy_type:\n'
2910 ' * @manager: A #GDBusObjectManagerClient.\n'
2911 ' * @object_path: The object path of the remote object (unused).\n'
2912 ' * @interface_name: (allow-none): Interface name of the remote object or %%NULL to get the object proxy #GType.\n'
2913 ' * @user_data: User data (unused).\n'
2915 ' * A #GDBusProxyTypeFunc that maps @interface_name to the generated #GDBusObjectProxy<!-- -->- and #GDBusProxy<!-- -->-derived types.\n'
2917 ' * Returns: A #GDBusProxy<!-- -->-derived #GType if @interface_name is not %%NULL, otherwise the #GType for #%sObjectProxy.\n'
2918 %(self.ns_lower, self.namespace), False))
2919 self.c.write(' */\n')
2920 self.c.write('GType\n'
2921 '%sobject_manager_client_get_proxy_type (GDBusObjectManagerClient *manager, const gchar *object_path, const gchar *interface_name, gpointer user_data)\n'
2924 self.c.write(' static gsize once_init_value = 0;\n'
2925 ' static GHashTable *lookup_hash;\n'
2928 ' if (interface_name == NULL)\n'
2929 ' return %sTYPE_OBJECT_PROXY;\n'
2930 ' if (g_once_init_enter (&once_init_value))\n'
2932 ' lookup_hash = g_hash_table_new (g_str_hash, g_str_equal);\n'
2934 for i in self.ifaces:
2935 self.c.write(' g_hash_table_insert (lookup_hash, "%s", GSIZE_TO_POINTER (%sTYPE_%s_PROXY));\n'
2936 %(i.name, i.ns_upper, i.name_upper))
2937 self.c.write(' g_once_init_leave (&once_init_value, 1);\n'
2939 self.c.write(' ret = (GType) GPOINTER_TO_SIZE (g_hash_table_lookup (lookup_hash, interface_name));\n'
2940 ' if (ret == (GType) 0)\n'
2941 ' ret = G_TYPE_DBUS_PROXY;\n')
2942 self.c.write(' return ret;\n'
2947 self.c.write(self.docbook_gen.expand(
2949 ' * %sobject_manager_client_new:\n'
2950 ' * @connection: A #GDBusConnection.\n'
2951 ' * @flags: Flags from the #GDBusObjectManagerClientFlags enumeration.\n'
2952 ' * @name: (allow-none): A bus name (well-known or unique) or %%NULL if @connection is not a message bus connection.\n'
2953 ' * @object_path: An object path.\n'
2954 ' * @cancellable: (allow-none): A #GCancellable or %%NULL.\n'
2955 ' * @callback: A #GAsyncReadyCallback to call when the request is satisfied.\n'
2956 ' * @user_data: User data to pass to @callback.\n'
2958 ' * Asynchronously creates #GDBusObjectManagerClient using %sobject_manager_client_get_proxy_type() as the #GDBusProxyTypeFunc. See g_dbus_object_manager_client_new() for more details.\n'
2960 ' * When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from.\n'
2961 ' * You can then call %sobject_manager_client_new_finish() to get the result of the operation.\n'
2963 ' * See %sobject_manager_client_new_sync() for the synchronous, blocking version of this constructor.\n'
2964 %(self.ns_lower, self.ns_lower, self.ns_lower, self.ns_lower), False))
2965 self.c.write(' */\n')
2966 self.c.write('void\n'
2967 '%sobject_manager_client_new (\n'
2968 ' GDBusConnection *connection,\n'
2969 ' GDBusObjectManagerClientFlags flags,\n'
2970 ' const gchar *name,\n'
2971 ' const gchar *object_path,\n'
2972 ' GCancellable *cancellable,\n'
2973 ' GAsyncReadyCallback callback,\n'
2974 ' gpointer user_data)\n'
2976 ' g_async_initable_new_async (%sTYPE_OBJECT_MANAGER_CLIENT, G_PRIORITY_DEFAULT, cancellable, callback, user_data, "flags", flags, "name", name, "connection", connection, "object-path", object_path, "get-proxy-type-func", %sobject_manager_client_get_proxy_type, NULL);\n'
2979 %(self.ns_lower, self.ns_upper, self.ns_lower))
2980 self.c.write('/**\n'
2981 ' * %sobject_manager_client_new_finish:\n'
2982 ' * @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to %sobject_manager_client_new().\n'
2983 ' * @error: Return location for error or %%NULL\n'
2985 ' * Finishes an operation started with %sobject_manager_client_new().\n'
2987 ' * Returns: (transfer full) (type %sObjectManagerClient): The constructed object manager client or %%NULL if @error is set.\n'
2988 %(self.ns_lower, self.ns_lower, self.ns_lower, self.namespace))
2989 self.c.write(' */\n')
2990 self.c.write('GDBusObjectManager *\n'
2991 '%sobject_manager_client_new_finish (\n'
2992 ' GAsyncResult *res,\n'
2993 ' GError **error)\n'
2996 ' GObject *source_object;\n'
2997 ' source_object = g_async_result_get_source_object (res);\n'
2998 ' ret = g_async_initable_new_finish (G_ASYNC_INITABLE (source_object), res, error);\n'
2999 ' g_object_unref (source_object);\n'
3000 ' if (ret != NULL)\n'
3001 ' return G_DBUS_OBJECT_MANAGER (ret);\n'
3007 self.c.write(self.docbook_gen.expand(
3009 ' * %sobject_manager_client_new_sync:\n'
3010 ' * @connection: A #GDBusConnection.\n'
3011 ' * @flags: Flags from the #GDBusObjectManagerClientFlags enumeration.\n'
3012 ' * @name: (allow-none): A bus name (well-known or unique) or %%NULL if @connection is not a message bus connection.\n'
3013 ' * @object_path: An object path.\n'
3014 ' * @cancellable: (allow-none): A #GCancellable or %%NULL.\n'
3015 ' * @error: Return location for error or %%NULL\n'
3017 ' * Synchronously creates #GDBusObjectManagerClient using %sobject_manager_client_get_proxy_type() as the #GDBusProxyTypeFunc. See g_dbus_object_manager_client_new_sync() for more details.\n'
3019 ' * The calling thread is blocked until a reply is received.\n'
3021 ' * See %sobject_manager_client_new() for the asynchronous version of this constructor.\n'
3023 ' * Returns: (transfer full) (type %sObjectManagerClient): The constructed object manager client or %%NULL if @error is set.\n'
3024 %(self.ns_lower, self.ns_lower, self.ns_lower, self.namespace), False))
3025 self.c.write(' */\n')
3026 self.c.write('GDBusObjectManager *\n'
3027 '%sobject_manager_client_new_sync (\n'
3028 ' GDBusConnection *connection,\n'
3029 ' GDBusObjectManagerClientFlags flags,\n'
3030 ' const gchar *name,\n'
3031 ' const gchar *object_path,\n'
3032 ' GCancellable *cancellable,\n'
3033 ' GError **error)\n'
3035 ' GInitable *ret;\n'
3036 ' ret = g_initable_new (%sTYPE_OBJECT_MANAGER_CLIENT, cancellable, error, "flags", flags, "name", name, "connection", connection, "object-path", object_path, "get-proxy-type-func", %sobject_manager_client_get_proxy_type, NULL);\n'
3037 ' if (ret != NULL)\n'
3038 ' return G_DBUS_OBJECT_MANAGER (ret);\n'
3043 %(self.ns_lower, self.ns_upper, self.ns_lower))
3045 self.c.write(self.docbook_gen.expand(
3047 ' * %sobject_manager_client_new_for_bus:\n'
3048 ' * @bus_type: A #GBusType.\n'
3049 ' * @flags: Flags from the #GDBusObjectManagerClientFlags enumeration.\n'
3050 ' * @name: A bus name (well-known or unique).\n'
3051 ' * @object_path: An object path.\n'
3052 ' * @cancellable: (allow-none): A #GCancellable or %%NULL.\n'
3053 ' * @callback: A #GAsyncReadyCallback to call when the request is satisfied.\n'
3054 ' * @user_data: User data to pass to @callback.\n'
3056 ' * Like %sobject_manager_client_new() but takes a #GBusType instead of a #GDBusConnection.\n'
3058 ' * When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from.\n'
3059 ' * You can then call %sobject_manager_client_new_for_bus_finish() to get the result of the operation.\n'
3061 ' * See %sobject_manager_client_new_for_bus_sync() for the synchronous, blocking version of this constructor.\n'
3062 %(self.ns_lower, self.ns_lower, self.ns_lower, self.ns_lower), False))
3063 self.c.write(' */\n')
3064 self.c.write('void\n'
3065 '%sobject_manager_client_new_for_bus (\n'
3066 ' GBusType bus_type,\n'
3067 ' GDBusObjectManagerClientFlags flags,\n'
3068 ' const gchar *name,\n'
3069 ' const gchar *object_path,\n'
3070 ' GCancellable *cancellable,\n'
3071 ' GAsyncReadyCallback callback,\n'
3072 ' gpointer user_data)\n'
3074 ' g_async_initable_new_async (%sTYPE_OBJECT_MANAGER_CLIENT, G_PRIORITY_DEFAULT, cancellable, callback, user_data, "flags", flags, "name", name, "bus-type", bus_type, "object-path", object_path, "get-proxy-type-func", %sobject_manager_client_get_proxy_type, NULL);\n'
3077 %(self.ns_lower, self.ns_upper, self.ns_lower))
3078 self.c.write('/**\n'
3079 ' * %sobject_manager_client_new_for_bus_finish:\n'
3080 ' * @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to %sobject_manager_client_new_for_bus().\n'
3081 ' * @error: Return location for error or %%NULL\n'
3083 ' * Finishes an operation started with %sobject_manager_client_new_for_bus().\n'
3085 ' * Returns: (transfer full) (type %sObjectManagerClient): The constructed object manager client or %%NULL if @error is set.\n'
3086 %(self.ns_lower, self.ns_lower, self.ns_lower, self.namespace))
3087 self.c.write(' */\n')
3088 self.c.write('GDBusObjectManager *\n'
3089 '%sobject_manager_client_new_for_bus_finish (\n'
3090 ' GAsyncResult *res,\n'
3091 ' GError **error)\n'
3094 ' GObject *source_object;\n'
3095 ' source_object = g_async_result_get_source_object (res);\n'
3096 ' ret = g_async_initable_new_finish (G_ASYNC_INITABLE (source_object), res, error);\n'
3097 ' g_object_unref (source_object);\n'
3098 ' if (ret != NULL)\n'
3099 ' return G_DBUS_OBJECT_MANAGER (ret);\n'
3105 self.c.write(self.docbook_gen.expand(
3107 ' * %sobject_manager_client_new_for_bus_sync:\n'
3108 ' * @bus_type: A #GBusType.\n'
3109 ' * @flags: Flags from the #GDBusObjectManagerClientFlags enumeration.\n'
3110 ' * @name: A bus name (well-known or unique).\n'
3111 ' * @object_path: An object path.\n'
3112 ' * @cancellable: (allow-none): A #GCancellable or %%NULL.\n'
3113 ' * @error: Return location for error or %%NULL\n'
3115 ' * Like %sobject_manager_client_new_sync() but takes a #GBusType instead of a #GDBusConnection.\n'
3117 ' * The calling thread is blocked until a reply is received.\n'
3119 ' * See %sobject_manager_client_new_for_bus() for the asynchronous version of this constructor.\n'
3121 ' * Returns: (transfer full) (type %sObjectManagerClient): The constructed object manager client or %%NULL if @error is set.\n'
3122 %(self.ns_lower, self.ns_lower, self.ns_lower, self.namespace), False))
3123 self.c.write(' */\n')
3124 self.c.write('GDBusObjectManager *\n'
3125 '%sobject_manager_client_new_for_bus_sync (\n'
3126 ' GBusType bus_type,\n'
3127 ' GDBusObjectManagerClientFlags flags,\n'
3128 ' const gchar *name,\n'
3129 ' const gchar *object_path,\n'
3130 ' GCancellable *cancellable,\n'
3131 ' GError **error)\n'
3133 ' GInitable *ret;\n'
3134 ' ret = g_initable_new (%sTYPE_OBJECT_MANAGER_CLIENT, cancellable, error, "flags", flags, "name", name, "bus-type", bus_type, "object-path", object_path, "get-proxy-type-func", %sobject_manager_client_get_proxy_type, NULL);\n'
3135 ' if (ret != NULL)\n'
3136 ' return G_DBUS_OBJECT_MANAGER (ret);\n'
3141 %(self.ns_lower, self.ns_upper, self.ns_lower))
3144 # ---------------------------------------------------------------------------------------------------
3146 def write_gtkdoc_deprecated_and_since_and_close(self, obj, f, indent):
3147 if len(obj.since) > 0:
3150 %(indent, '', indent, '', obj.since))
3152 if isinstance(obj, dbustypes.Interface):
3153 thing = 'The D-Bus interface'
3154 elif isinstance(obj, dbustypes.Method):
3155 thing = 'The D-Bus method'
3156 elif isinstance(obj, dbustypes.Signal):
3157 thing = 'The D-Bus signal'
3158 elif isinstance(obj, dbustypes.Property):
3159 thing = 'The D-Bus property'
3161 raise RuntimeError('Cannot handle object ', obj)
3162 f.write(self.docbook_gen.expand(
3164 '%*s * Deprecated: %s has been deprecated.\n'
3165 %(indent, '', indent, '', thing), False))
3166 f.write('%*s */\n'%(indent, ''))
3168 # ---------------------------------------------------------------------------------------------------
3170 def generate_interface_intro(self, i):
3171 self.c.write('/* ------------------------------------------------------------------------\n'
3172 ' * Code for interface %s\n'
3173 ' * ------------------------------------------------------------------------\n'
3177 self.c.write(self.docbook_gen.expand(
3181 ' * @short_description: Generated C code for the %s D-Bus interface\n'
3183 ' * This section contains code for working with the #%s D-Bus interface in C.\n'
3185 %(i.camel_name, i.camel_name, i.name, i.name), False))
3189 self.generate_intro()
3190 self.declare_types()
3191 for i in self.ifaces:
3192 self.generate_interface_intro(i)
3193 self.generate_introspection_for_interface(i)
3194 self.generate_interface(i)
3195 self.generate_property_accessors(i)
3196 self.generate_signal_emitters(i)
3197 self.generate_method_calls(i)
3198 self.generate_method_completers(i)
3199 self.generate_proxy(i)
3200 self.generate_skeleton(i)
3201 if self.generate_objmanager:
3202 self.generate_object()
3203 self.generate_object_manager_client()
3204 self.generate_outro()