4 # GDBus - GLib D-Bus Library
6 # Copyright (C) 2008-2011 Red Hat, Inc.
7 # Copyright (C) 2018 Iñigo Martínez <inigomartinez@gmail.com>
9 # This library is free software; you can redistribute it and/or
10 # modify it under the terms of the GNU Lesser General Public
11 # License as published by the Free Software Foundation; either
12 # version 2.1 of the License, or (at your option) any later version.
14 # This library is distributed in the hope that it will be useful,
15 # but WITHOUT ANY WARRANTY; without even the implied warranty of
16 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 # Lesser General Public License for more details.
19 # You should have received a copy of the GNU Lesser General
20 # Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
22 # Author: David Zeuthen <davidz@redhat.com>
28 from . import dbustypes
29 from .utils import print_error
32 * Generated by gdbus-codegen {!s}. DO NOT EDIT.
34 * The license of this code is the same as for the D-Bus interface description
35 * it was derived from.
38 def generate_namespace(namespace):
40 if len(namespace) > 0:
41 if utils.is_ugly_case(namespace):
42 ns = namespace.replace('_', '')
43 ns_upper = namespace.upper() + '_'
44 ns_lower = namespace.lower() + '_'
46 ns_upper = utils.camel_case_to_uscore(namespace).upper() + '_'
47 ns_lower = utils.camel_case_to_uscore(namespace).lower() + '_'
52 return (ns, ns_upper, ns_lower)
54 class HeaderCodeGenerator:
55 def __init__(self, ifaces, namespace, generate_objmanager,
56 generate_autocleanup, header_name, use_pragma, outfile):
58 self.namespace, self.ns_upper, self.ns_lower = generate_namespace(namespace)
59 self.generate_objmanager = generate_objmanager
60 self.generate_autocleanup = generate_autocleanup
61 self.header_guard = header_name.upper().replace('.', '_').replace('-', '_').replace('/', '_').replace(':', '_')
62 self.use_pragma = use_pragma
63 self.outfile = outfile
65 # ----------------------------------------------------------------------------------------------------
67 def generate_header_preamble(self):
68 self.outfile.write(LICENSE_STR.format(config.VERSION))
69 self.outfile.write('\n')
72 self.outfile.write('#pragma once\n')
74 self.outfile.write('#ifndef __{!s}__\n'.format(self.header_guard))
75 self.outfile.write('#define __{!s}__\n'.format(self.header_guard))
77 self.outfile.write('\n')
78 self.outfile.write('#include <gio/gio.h>\n')
79 self.outfile.write('\n')
80 self.outfile.write('G_BEGIN_DECLS\n')
81 self.outfile.write('\n')
83 # ----------------------------------------------------------------------------------------------------
85 def declare_types(self):
87 self.outfile.write('\n')
88 self.outfile.write('/* ------------------------------------------------------------------------ */\n')
89 self.outfile.write('/* Declarations for %s */\n'%i.name)
90 self.outfile.write('\n')
92 # First the GInterface
93 self.outfile.write('#define %sTYPE_%s (%s_get_type ())\n'%(i.ns_upper, i.name_upper, i.name_lower))
94 self.outfile.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))
95 self.outfile.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))
96 self.outfile.write('#define %s%s_GET_IFACE(o) (G_TYPE_INSTANCE_GET_INTERFACE ((o), %sTYPE_%s, %sIface))\n'%(i.ns_upper, i.name_upper, i.ns_upper, i.name_upper, i.camel_name))
97 self.outfile.write('\n')
98 self.outfile.write('struct _%s;\n'%(i.camel_name))
99 self.outfile.write('typedef struct _%s %s;\n'%(i.camel_name, i.camel_name))
100 self.outfile.write('typedef struct _%sIface %sIface;\n'%(i.camel_name, i.camel_name))
101 self.outfile.write('\n')
102 self.outfile.write('struct _%sIface\n'%(i.camel_name))
103 self.outfile.write('{\n')
104 self.outfile.write(' GTypeInterface parent_iface;\n')
106 function_pointers = {}
109 if len(i.methods) > 0:
110 self.outfile.write('\n')
113 if utils.lookup_annotation(m.annotations, 'org.gtk.GDBus.C.UnixFD'):
115 key = (m.since, '_method_%s'%m.name_lower)
116 value = ' gboolean (*handle_%s) (\n'%(m.name_lower)
117 value += ' %s *object,\n'%(i.camel_name)
118 value += ' GDBusMethodInvocation *invocation'%()
120 value += ',\n GUnixFDList *fd_list'
122 value += ',\n %sarg_%s'%(a.ctype_in, a.name)
124 function_pointers[key] = value
127 if len(i.signals) > 0:
128 self.outfile.write('\n')
130 key = (s.since, '_signal_%s'%s.name_lower)
131 value = ' void (*%s) (\n'%(s.name_lower)
132 value += ' %s *object'%(i.camel_name)
134 value += ',\n %sarg_%s'%(a.ctype_in, a.name)
136 function_pointers[key] = value
138 # vfuncs for properties
139 if len(i.properties) > 0:
140 self.outfile.write('\n')
141 for p in i.properties:
142 key = (p.since, '_prop_get_%s'%p.name_lower)
143 value = ' %s (*get_%s) (%s *object);\n\n'%(p.arg.ctype_in, p.name_lower, i.camel_name)
144 function_pointers[key] = value
146 # Sort according to @since tag, then name.. this ensures
147 # that the function pointers don't change order assuming
148 # judicious use of @since
150 # Also use a proper version comparison function so e.g.
151 # 10.0 comes after 2.0.
153 # See https://bugzilla.gnome.org/show_bug.cgi?id=647577#c5
155 for key in sorted(function_pointers.keys(), key=utils.version_cmp_key):
156 self.outfile.write('%s'%function_pointers[key])
158 self.outfile.write('};\n')
159 self.outfile.write('\n')
160 if self.generate_autocleanup == 'all':
161 self.outfile.write('#if GLIB_CHECK_VERSION(2, 44, 0)\n')
162 self.outfile.write('G_DEFINE_AUTOPTR_CLEANUP_FUNC (%s, g_object_unref)\n' % (i.camel_name))
163 self.outfile.write('#endif\n')
164 self.outfile.write('\n')
165 self.outfile.write('GType %s_get_type (void) G_GNUC_CONST;\n'%(i.name_lower))
166 self.outfile.write('\n')
167 self.outfile.write('GDBusInterfaceInfo *%s_interface_info (void);\n'%(i.name_lower))
168 self.outfile.write('guint %s_override_properties (GObjectClass *klass, guint property_id_begin);\n'%(i.name_lower))
169 self.outfile.write('\n')
171 # Then method call completion functions
172 if len(i.methods) > 0:
173 self.outfile.write('\n')
174 self.outfile.write('/* D-Bus method call completion functions: */\n')
177 if utils.lookup_annotation(m.annotations, 'org.gtk.GDBus.C.UnixFD'):
180 self.outfile.write('G_GNUC_DEPRECATED ')
181 self.outfile.write('void %s_complete_%s (\n'
183 ' GDBusMethodInvocation *invocation'%(i.name_lower, m.name_lower, i.camel_name))
185 self.outfile.write(',\n GUnixFDList *fd_list')
187 self.outfile.write(',\n %s%s'%(a.ctype_in, a.name))
188 self.outfile.write(');\n')
189 self.outfile.write('\n')
190 self.outfile.write('\n')
192 # Then signal emission functions
193 if len(i.signals) > 0:
194 self.outfile.write('\n')
195 self.outfile.write('/* D-Bus signal emissions functions: */\n')
198 self.outfile.write('G_GNUC_DEPRECATED ')
199 self.outfile.write('void %s_emit_%s (\n'
200 ' %s *object'%(i.name_lower, s.name_lower, i.camel_name))
202 self.outfile.write(',\n %sarg_%s'%(a.ctype_in, a.name))
203 self.outfile.write(');\n')
204 self.outfile.write('\n')
205 self.outfile.write('\n')
207 # Then method call declarations
208 if len(i.methods) > 0:
209 self.outfile.write('\n')
210 self.outfile.write('/* D-Bus method calls: */\n')
213 if utils.lookup_annotation(m.annotations, 'org.gtk.GDBus.C.UnixFD'):
217 self.outfile.write('G_GNUC_DEPRECATED ')
218 self.outfile.write('void %s_call_%s (\n'
219 ' %s *proxy'%(i.name_lower, m.name_lower, i.camel_name))
221 self.outfile.write(',\n %sarg_%s'%(a.ctype_in, a.name))
223 self.outfile.write(',\n GUnixFDList *fd_list')
224 self.outfile.write(',\n'
225 ' GCancellable *cancellable,\n'
226 ' GAsyncReadyCallback callback,\n'
227 ' gpointer user_data);\n')
228 self.outfile.write('\n')
231 self.outfile.write('G_GNUC_DEPRECATED ')
232 self.outfile.write('gboolean %s_call_%s_finish (\n'
233 ' %s *proxy'%(i.name_lower, m.name_lower, i.camel_name))
235 self.outfile.write(',\n %sout_%s'%(a.ctype_out, a.name))
237 self.outfile.write(',\n GUnixFDList **out_fd_list')
238 self.outfile.write(',\n'
239 ' GAsyncResult *res,\n'
240 ' GError **error);\n')
241 self.outfile.write('\n')
244 self.outfile.write('G_GNUC_DEPRECATED ')
245 self.outfile.write('gboolean %s_call_%s_sync (\n'
246 ' %s *proxy'%(i.name_lower, m.name_lower, i.camel_name))
248 self.outfile.write(',\n %sarg_%s'%(a.ctype_in, a.name))
250 self.outfile.write(',\n GUnixFDList *fd_list')
252 self.outfile.write(',\n %sout_%s'%(a.ctype_out, a.name))
254 self.outfile.write(',\n GUnixFDList **out_fd_list')
255 self.outfile.write(',\n'
256 ' GCancellable *cancellable,\n'
257 ' GError **error);\n')
258 self.outfile.write('\n')
259 self.outfile.write('\n')
261 # Then the property accessor declarations
262 if len(i.properties) > 0:
263 self.outfile.write('\n')
264 self.outfile.write('/* D-Bus property accessors: */\n')
265 for p in i.properties:
268 self.outfile.write('G_GNUC_DEPRECATED ')
269 self.outfile.write('%s%s_get_%s (%s *object);\n'%(p.arg.ctype_in, i.name_lower, p.name_lower, i.camel_name))
270 if p.arg.free_func != None:
272 self.outfile.write('G_GNUC_DEPRECATED ')
273 self.outfile.write('%s%s_dup_%s (%s *object);\n'%(p.arg.ctype_in_dup, i.name_lower, p.name_lower, i.camel_name))
276 self.outfile.write('G_GNUC_DEPRECATED ')
277 self.outfile.write('void %s_set_%s (%s *object, %svalue);\n'%(i.name_lower, p.name_lower, i.camel_name, p.arg.ctype_in, ))
278 self.outfile.write('\n')
281 self.outfile.write('\n')
282 self.outfile.write('/* ---- */\n')
283 self.outfile.write('\n')
284 self.outfile.write('#define %sTYPE_%s_PROXY (%s_proxy_get_type ())\n'%(i.ns_upper, i.name_upper, i.name_lower))
285 self.outfile.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))
286 self.outfile.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))
287 self.outfile.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))
288 self.outfile.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))
289 self.outfile.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))
290 self.outfile.write('\n')
291 self.outfile.write('typedef struct _%sProxy %sProxy;\n'%(i.camel_name, i.camel_name))
292 self.outfile.write('typedef struct _%sProxyClass %sProxyClass;\n'%(i.camel_name, i.camel_name))
293 self.outfile.write('typedef struct _%sProxyPrivate %sProxyPrivate;\n'%(i.camel_name, i.camel_name))
294 self.outfile.write('\n')
295 self.outfile.write('struct _%sProxy\n'%(i.camel_name))
296 self.outfile.write('{\n')
297 self.outfile.write(' /*< private >*/\n')
298 self.outfile.write(' GDBusProxy parent_instance;\n')
299 self.outfile.write(' %sProxyPrivate *priv;\n'%(i.camel_name))
300 self.outfile.write('};\n')
301 self.outfile.write('\n')
302 self.outfile.write('struct _%sProxyClass\n'%(i.camel_name))
303 self.outfile.write('{\n')
304 self.outfile.write(' GDBusProxyClass parent_class;\n')
305 self.outfile.write('};\n')
306 self.outfile.write('\n')
307 self.outfile.write('GType %s_proxy_get_type (void) G_GNUC_CONST;\n'%(i.name_lower))
308 self.outfile.write('\n')
309 if self.generate_autocleanup in ('objects', 'all'):
310 self.outfile.write('#if GLIB_CHECK_VERSION(2, 44, 0)\n')
311 self.outfile.write('G_DEFINE_AUTOPTR_CLEANUP_FUNC (%sProxy, g_object_unref)\n' % (i.camel_name))
312 self.outfile.write('#endif\n')
313 self.outfile.write('\n')
315 self.outfile.write('G_GNUC_DEPRECATED ')
316 self.outfile.write('void %s_proxy_new (\n'
317 ' GDBusConnection *connection,\n'
318 ' GDBusProxyFlags flags,\n'
319 ' const gchar *name,\n'
320 ' const gchar *object_path,\n'
321 ' GCancellable *cancellable,\n'
322 ' GAsyncReadyCallback callback,\n'
323 ' gpointer user_data);\n'
326 self.outfile.write('G_GNUC_DEPRECATED ')
327 self.outfile.write('%s *%s_proxy_new_finish (\n'
328 ' GAsyncResult *res,\n'
329 ' GError **error);\n'
330 %(i.camel_name, i.name_lower))
332 self.outfile.write('G_GNUC_DEPRECATED ')
333 self.outfile.write('%s *%s_proxy_new_sync (\n'
334 ' GDBusConnection *connection,\n'
335 ' GDBusProxyFlags flags,\n'
336 ' const gchar *name,\n'
337 ' const gchar *object_path,\n'
338 ' GCancellable *cancellable,\n'
339 ' GError **error);\n'
340 %(i.camel_name, i.name_lower))
341 self.outfile.write('\n')
343 self.outfile.write('G_GNUC_DEPRECATED ')
344 self.outfile.write('void %s_proxy_new_for_bus (\n'
345 ' GBusType bus_type,\n'
346 ' GDBusProxyFlags flags,\n'
347 ' const gchar *name,\n'
348 ' const gchar *object_path,\n'
349 ' GCancellable *cancellable,\n'
350 ' GAsyncReadyCallback callback,\n'
351 ' gpointer user_data);\n'
354 self.outfile.write('G_GNUC_DEPRECATED ')
355 self.outfile.write('%s *%s_proxy_new_for_bus_finish (\n'
356 ' GAsyncResult *res,\n'
357 ' GError **error);\n'
358 %(i.camel_name, i.name_lower))
360 self.outfile.write('G_GNUC_DEPRECATED ')
361 self.outfile.write('%s *%s_proxy_new_for_bus_sync (\n'
362 ' GBusType bus_type,\n'
363 ' GDBusProxyFlags flags,\n'
364 ' const gchar *name,\n'
365 ' const gchar *object_path,\n'
366 ' GCancellable *cancellable,\n'
367 ' GError **error);\n'
368 %(i.camel_name, i.name_lower))
369 self.outfile.write('\n')
372 self.outfile.write('\n')
373 self.outfile.write('/* ---- */\n')
374 self.outfile.write('\n')
375 self.outfile.write('#define %sTYPE_%s_SKELETON (%s_skeleton_get_type ())\n'%(i.ns_upper, i.name_upper, i.name_lower))
376 self.outfile.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))
377 self.outfile.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))
378 self.outfile.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))
379 self.outfile.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))
380 self.outfile.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))
381 self.outfile.write('\n')
382 self.outfile.write('typedef struct _%sSkeleton %sSkeleton;\n'%(i.camel_name, i.camel_name))
383 self.outfile.write('typedef struct _%sSkeletonClass %sSkeletonClass;\n'%(i.camel_name, i.camel_name))
384 self.outfile.write('typedef struct _%sSkeletonPrivate %sSkeletonPrivate;\n'%(i.camel_name, i.camel_name))
385 self.outfile.write('\n')
386 self.outfile.write('struct _%sSkeleton\n'%(i.camel_name))
387 self.outfile.write('{\n')
388 self.outfile.write(' /*< private >*/\n')
389 self.outfile.write(' GDBusInterfaceSkeleton parent_instance;\n')
390 self.outfile.write(' %sSkeletonPrivate *priv;\n'%(i.camel_name))
391 self.outfile.write('};\n')
392 self.outfile.write('\n')
393 self.outfile.write('struct _%sSkeletonClass\n'%(i.camel_name))
394 self.outfile.write('{\n')
395 self.outfile.write(' GDBusInterfaceSkeletonClass parent_class;\n')
396 self.outfile.write('};\n')
397 self.outfile.write('\n')
398 self.outfile.write('GType %s_skeleton_get_type (void) G_GNUC_CONST;\n'%(i.name_lower))
399 self.outfile.write('\n')
400 if self.generate_autocleanup in ('objects', 'all'):
401 self.outfile.write('#if GLIB_CHECK_VERSION(2, 44, 0)\n')
402 self.outfile.write('G_DEFINE_AUTOPTR_CLEANUP_FUNC (%sSkeleton, g_object_unref)\n' % (i.camel_name))
403 self.outfile.write('#endif\n')
404 self.outfile.write('\n')
406 self.outfile.write('G_GNUC_DEPRECATED ')
407 self.outfile.write('%s *%s_skeleton_new (void);\n'%(i.camel_name, i.name_lower))
409 self.outfile.write('\n')
411 # Finally, the Object, ObjectProxy, ObjectSkeleton and ObjectManagerClient
412 if self.generate_objmanager:
413 self.outfile.write('\n')
414 self.outfile.write('/* ---- */\n')
415 self.outfile.write('\n')
416 self.outfile.write('#define %sTYPE_OBJECT (%sobject_get_type ())\n'%(self.ns_upper, self.ns_lower))
417 self.outfile.write('#define %sOBJECT(o) (G_TYPE_CHECK_INSTANCE_CAST ((o), %sTYPE_OBJECT, %sObject))\n'%(self.ns_upper, self.ns_upper, self.namespace))
418 self.outfile.write('#define %sIS_OBJECT(o) (G_TYPE_CHECK_INSTANCE_TYPE ((o), %sTYPE_OBJECT))\n'%(self.ns_upper, self.ns_upper))
419 self.outfile.write('#define %sOBJECT_GET_IFACE(o) (G_TYPE_INSTANCE_GET_INTERFACE ((o), %sTYPE_OBJECT, %sObject))\n'%(self.ns_upper, self.ns_upper, self.namespace))
420 self.outfile.write('\n')
421 self.outfile.write('struct _%sObject;\n'%(self.namespace))
422 self.outfile.write('typedef struct _%sObject %sObject;\n'%(self.namespace, self.namespace))
423 self.outfile.write('typedef struct _%sObjectIface %sObjectIface;\n'%(self.namespace, self.namespace))
424 self.outfile.write('\n')
425 self.outfile.write('struct _%sObjectIface\n'%(self.namespace))
426 self.outfile.write('{\n'
427 ' GTypeInterface parent_iface;\n'
430 self.outfile.write('GType %sobject_get_type (void) G_GNUC_CONST;\n'
433 for i in self.ifaces:
435 self.outfile.write('G_GNUC_DEPRECATED ')
436 self.outfile.write('%s *%sobject_get_%s (%sObject *object);\n'
437 %(i.camel_name, self.ns_lower, i.name_upper.lower(), self.namespace))
438 for i in self.ifaces:
440 self.outfile.write('G_GNUC_DEPRECATED ')
441 self.outfile.write('%s *%sobject_peek_%s (%sObject *object);\n'
442 %(i.camel_name, self.ns_lower, i.name_upper.lower(), self.namespace))
443 self.outfile.write('\n')
444 self.outfile.write('#define %sTYPE_OBJECT_PROXY (%sobject_proxy_get_type ())\n'%(self.ns_upper, self.ns_lower))
445 self.outfile.write('#define %sOBJECT_PROXY(o) (G_TYPE_CHECK_INSTANCE_CAST ((o), %sTYPE_OBJECT_PROXY, %sObjectProxy))\n'%(self.ns_upper, self.ns_upper, self.namespace))
446 self.outfile.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))
447 self.outfile.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))
448 self.outfile.write('#define %sIS_OBJECT_PROXY(o) (G_TYPE_CHECK_INSTANCE_TYPE ((o), %sTYPE_OBJECT_PROXY))\n'%(self.ns_upper, self.ns_upper))
449 self.outfile.write('#define %sIS_OBJECT_PROXY_CLASS(k) (G_TYPE_CHECK_CLASS_TYPE ((k), %sTYPE_OBJECT_PROXY))\n'%(self.ns_upper, self.ns_upper))
450 self.outfile.write('\n')
451 self.outfile.write('typedef struct _%sObjectProxy %sObjectProxy;\n'%(self.namespace, self.namespace))
452 self.outfile.write('typedef struct _%sObjectProxyClass %sObjectProxyClass;\n'%(self.namespace, self.namespace))
453 self.outfile.write('typedef struct _%sObjectProxyPrivate %sObjectProxyPrivate;\n'%(self.namespace, self.namespace))
454 self.outfile.write('\n')
455 self.outfile.write('struct _%sObjectProxy\n'%(self.namespace))
456 self.outfile.write('{\n')
457 self.outfile.write(' /*< private >*/\n')
458 self.outfile.write(' GDBusObjectProxy parent_instance;\n')
459 self.outfile.write(' %sObjectProxyPrivate *priv;\n'%(self.namespace))
460 self.outfile.write('};\n')
461 self.outfile.write('\n')
462 self.outfile.write('struct _%sObjectProxyClass\n'%(self.namespace))
463 self.outfile.write('{\n')
464 self.outfile.write(' GDBusObjectProxyClass parent_class;\n')
465 self.outfile.write('};\n')
466 self.outfile.write('\n')
467 self.outfile.write('GType %sobject_proxy_get_type (void) G_GNUC_CONST;\n'%(self.ns_lower))
468 self.outfile.write('\n')
469 if self.generate_autocleanup in ('objects', 'all'):
470 self.outfile.write('#if GLIB_CHECK_VERSION(2, 44, 0)\n')
471 self.outfile.write('G_DEFINE_AUTOPTR_CLEANUP_FUNC (%sObjectProxy, g_object_unref)\n' % (self.namespace))
472 self.outfile.write('#endif\n')
473 self.outfile.write('\n')
474 self.outfile.write('%sObjectProxy *%sobject_proxy_new (GDBusConnection *connection, const gchar *object_path);\n'%(self.namespace, self.ns_lower))
475 self.outfile.write('\n')
476 self.outfile.write('#define %sTYPE_OBJECT_SKELETON (%sobject_skeleton_get_type ())\n'%(self.ns_upper, self.ns_lower))
477 self.outfile.write('#define %sOBJECT_SKELETON(o) (G_TYPE_CHECK_INSTANCE_CAST ((o), %sTYPE_OBJECT_SKELETON, %sObjectSkeleton))\n'%(self.ns_upper, self.ns_upper, self.namespace))
478 self.outfile.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))
479 self.outfile.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))
480 self.outfile.write('#define %sIS_OBJECT_SKELETON(o) (G_TYPE_CHECK_INSTANCE_TYPE ((o), %sTYPE_OBJECT_SKELETON))\n'%(self.ns_upper, self.ns_upper))
481 self.outfile.write('#define %sIS_OBJECT_SKELETON_CLASS(k) (G_TYPE_CHECK_CLASS_TYPE ((k), %sTYPE_OBJECT_SKELETON))\n'%(self.ns_upper, self.ns_upper))
482 self.outfile.write('\n')
483 self.outfile.write('typedef struct _%sObjectSkeleton %sObjectSkeleton;\n'%(self.namespace, self.namespace))
484 self.outfile.write('typedef struct _%sObjectSkeletonClass %sObjectSkeletonClass;\n'%(self.namespace, self.namespace))
485 self.outfile.write('typedef struct _%sObjectSkeletonPrivate %sObjectSkeletonPrivate;\n'%(self.namespace, self.namespace))
486 self.outfile.write('\n')
487 self.outfile.write('struct _%sObjectSkeleton\n'%(self.namespace))
488 self.outfile.write('{\n')
489 self.outfile.write(' /*< private >*/\n')
490 self.outfile.write(' GDBusObjectSkeleton parent_instance;\n')
491 self.outfile.write(' %sObjectSkeletonPrivate *priv;\n'%(self.namespace))
492 self.outfile.write('};\n')
493 self.outfile.write('\n')
494 self.outfile.write('struct _%sObjectSkeletonClass\n'%(self.namespace))
495 self.outfile.write('{\n')
496 self.outfile.write(' GDBusObjectSkeletonClass parent_class;\n')
497 self.outfile.write('};\n')
498 self.outfile.write('\n')
499 self.outfile.write('GType %sobject_skeleton_get_type (void) G_GNUC_CONST;\n'%(self.ns_lower))
500 self.outfile.write('\n')
501 if self.generate_autocleanup in ('objects', 'all'):
502 self.outfile.write('#if GLIB_CHECK_VERSION(2, 44, 0)\n')
503 self.outfile.write('G_DEFINE_AUTOPTR_CLEANUP_FUNC (%sObjectSkeleton, g_object_unref)\n' % (self.namespace))
504 self.outfile.write('#endif\n')
505 self.outfile.write('\n')
506 self.outfile.write('%sObjectSkeleton *%sobject_skeleton_new (const gchar *object_path);\n'
507 %(self.namespace, self.ns_lower))
508 for i in self.ifaces:
510 self.outfile.write('G_GNUC_DEPRECATED ')
511 self.outfile.write('void %sobject_skeleton_set_%s (%sObjectSkeleton *object, %s *interface_);\n'
512 %(self.ns_lower, i.name_upper.lower(), self.namespace, i.camel_name))
513 self.outfile.write('\n')
515 self.outfile.write('/* ---- */\n')
516 self.outfile.write('\n')
517 self.outfile.write('#define %sTYPE_OBJECT_MANAGER_CLIENT (%sobject_manager_client_get_type ())\n'%(self.ns_upper, self.ns_lower))
518 self.outfile.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))
519 self.outfile.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))
520 self.outfile.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))
521 self.outfile.write('#define %sIS_OBJECT_MANAGER_CLIENT(o) (G_TYPE_CHECK_INSTANCE_TYPE ((o), %sTYPE_OBJECT_MANAGER_CLIENT))\n'%(self.ns_upper, self.ns_upper))
522 self.outfile.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))
523 self.outfile.write('\n')
524 self.outfile.write('typedef struct _%sObjectManagerClient %sObjectManagerClient;\n'%(self.namespace, self.namespace))
525 self.outfile.write('typedef struct _%sObjectManagerClientClass %sObjectManagerClientClass;\n'%(self.namespace, self.namespace))
526 self.outfile.write('typedef struct _%sObjectManagerClientPrivate %sObjectManagerClientPrivate;\n'%(self.namespace, self.namespace))
527 self.outfile.write('\n')
528 self.outfile.write('struct _%sObjectManagerClient\n'%(self.namespace))
529 self.outfile.write('{\n')
530 self.outfile.write(' /*< private >*/\n')
531 self.outfile.write(' GDBusObjectManagerClient parent_instance;\n')
532 self.outfile.write(' %sObjectManagerClientPrivate *priv;\n'%(self.namespace))
533 self.outfile.write('};\n')
534 self.outfile.write('\n')
535 self.outfile.write('struct _%sObjectManagerClientClass\n'%(self.namespace))
536 self.outfile.write('{\n')
537 self.outfile.write(' GDBusObjectManagerClientClass parent_class;\n')
538 self.outfile.write('};\n')
539 self.outfile.write('\n')
540 if self.generate_autocleanup in ('objects', 'all'):
541 self.outfile.write('#if GLIB_CHECK_VERSION(2, 44, 0)\n')
542 self.outfile.write('G_DEFINE_AUTOPTR_CLEANUP_FUNC (%sObjectManagerClient, g_object_unref)\n' % (self.namespace))
543 self.outfile.write('#endif\n')
544 self.outfile.write('\n')
545 self.outfile.write('GType %sobject_manager_client_get_type (void) G_GNUC_CONST;\n'%(self.ns_lower))
546 self.outfile.write('\n')
547 self.outfile.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))
548 self.outfile.write('\n')
549 self.outfile.write('void %sobject_manager_client_new (\n'
550 ' GDBusConnection *connection,\n'
551 ' GDBusObjectManagerClientFlags flags,\n'
552 ' const gchar *name,\n'
553 ' const gchar *object_path,\n'
554 ' GCancellable *cancellable,\n'
555 ' GAsyncReadyCallback callback,\n'
556 ' gpointer user_data);\n'
558 self.outfile.write('GDBusObjectManager *%sobject_manager_client_new_finish (\n'
559 ' GAsyncResult *res,\n'
560 ' GError **error);\n'
562 self.outfile.write('GDBusObjectManager *%sobject_manager_client_new_sync (\n'
563 ' GDBusConnection *connection,\n'
564 ' GDBusObjectManagerClientFlags flags,\n'
565 ' const gchar *name,\n'
566 ' const gchar *object_path,\n'
567 ' GCancellable *cancellable,\n'
568 ' GError **error);\n'
570 self.outfile.write('\n')
571 self.outfile.write('void %sobject_manager_client_new_for_bus (\n'
572 ' GBusType bus_type,\n'
573 ' GDBusObjectManagerClientFlags flags,\n'
574 ' const gchar *name,\n'
575 ' const gchar *object_path,\n'
576 ' GCancellable *cancellable,\n'
577 ' GAsyncReadyCallback callback,\n'
578 ' gpointer user_data);\n'
580 self.outfile.write('GDBusObjectManager *%sobject_manager_client_new_for_bus_finish (\n'
581 ' GAsyncResult *res,\n'
582 ' GError **error);\n'
584 self.outfile.write('GDBusObjectManager *%sobject_manager_client_new_for_bus_sync (\n'
585 ' GBusType bus_type,\n'
586 ' GDBusObjectManagerClientFlags flags,\n'
587 ' const gchar *name,\n'
588 ' const gchar *object_path,\n'
589 ' GCancellable *cancellable,\n'
590 ' GError **error);\n'
592 self.outfile.write('\n')
594 # ----------------------------------------------------------------------------------------------------
596 def generate_header_postamble(self):
597 self.outfile.write('\n')
598 self.outfile.write('G_END_DECLS\n')
600 if not self.use_pragma:
601 self.outfile.write('\n')
602 self.outfile.write('#endif /* __{!s}__ */\n'.format(self.header_guard))
604 # ----------------------------------------------------------------------------------------------------
607 self.generate_header_preamble()
609 self.generate_header_postamble()
611 # ----------------------------------------------------------------------------------------------------
614 def __init__(self, ifaces, namespace, generate_objmanager, header_name,
615 docbook_gen, outfile):
617 self.namespace, self.ns_upper, self.ns_lower = generate_namespace(namespace)
618 self.generate_objmanager = generate_objmanager
619 self.header_name = header_name
620 self.docbook_gen = docbook_gen
621 self.outfile = outfile
623 # ----------------------------------------------------------------------------------------------------
625 def generate_body_preamble(self):
626 self.outfile.write(LICENSE_STR.format(config.VERSION))
627 self.outfile.write('\n')
628 self.outfile.write('#ifdef HAVE_CONFIG_H\n'
629 '# include "config.h"\n'
634 '#include <string.h>\n'
637 self.outfile.write('#ifdef G_OS_UNIX\n'
638 '# include <gio/gunixfdlist.h>\n'
642 self.outfile.write('typedef struct\n'
644 ' GDBusArgInfo parent_struct;\n'
645 ' gboolean use_gvariant;\n'
646 '} _ExtendedGDBusArgInfo;\n'
649 self.outfile.write('typedef struct\n'
651 ' GDBusMethodInfo parent_struct;\n'
652 ' const gchar *signal_name;\n'
653 ' gboolean pass_fdlist;\n'
654 '} _ExtendedGDBusMethodInfo;\n'
657 self.outfile.write('typedef struct\n'
659 ' GDBusSignalInfo parent_struct;\n'
660 ' const gchar *signal_name;\n'
661 '} _ExtendedGDBusSignalInfo;\n'
664 self.outfile.write('typedef struct\n'
666 ' GDBusPropertyInfo parent_struct;\n'
667 ' const gchar *hyphen_name;\n'
668 ' gboolean use_gvariant;\n'
669 '} _ExtendedGDBusPropertyInfo;\n'
672 self.outfile.write('typedef struct\n'
674 ' GDBusInterfaceInfo parent_struct;\n'
675 ' const gchar *hyphen_name;\n'
676 '} _ExtendedGDBusInterfaceInfo;\n'
679 self.outfile.write('typedef struct\n'
681 ' const _ExtendedGDBusPropertyInfo *info;\n'
683 ' GValue orig_value; /* the value before the change */\n'
684 '} ChangedProperty;\n'
687 '_changed_property_free (ChangedProperty *data)\n'
689 ' g_value_unset (&data->orig_value);\n'
694 self.outfile.write('static gboolean\n'
695 '_g_strv_equal0 (gchar **a, gchar **b)\n'
697 ' gboolean ret = FALSE;\n'
699 ' if (a == NULL && b == NULL)\n'
704 ' if (a == NULL || b == NULL)\n'
706 ' if (g_strv_length (a) != g_strv_length (b))\n'
708 ' for (n = 0; a[n] != NULL; n++)\n'
709 ' if (g_strcmp0 (a[n], b[n]) != 0)\n'
717 self.outfile.write('static gboolean\n'
718 '_g_variant_equal0 (GVariant *a, GVariant *b)\n'
720 ' gboolean ret = FALSE;\n'
721 ' if (a == NULL && b == NULL)\n'
726 ' if (a == NULL || b == NULL)\n'
728 ' ret = g_variant_equal (a, b);\n'
734 # simplified - only supports the types we use
735 self.outfile.write('G_GNUC_UNUSED static gboolean\n'
736 '_g_value_equal (const GValue *a, const GValue *b)\n'
738 ' gboolean ret = FALSE;\n'
739 ' g_assert (G_VALUE_TYPE (a) == G_VALUE_TYPE (b));\n'
740 ' switch (G_VALUE_TYPE (a))\n'
742 ' case G_TYPE_BOOLEAN:\n'
743 ' ret = (g_value_get_boolean (a) == g_value_get_boolean (b));\n'
745 ' case G_TYPE_UCHAR:\n'
746 ' ret = (g_value_get_uchar (a) == g_value_get_uchar (b));\n'
748 ' case G_TYPE_INT:\n'
749 ' ret = (g_value_get_int (a) == g_value_get_int (b));\n'
751 ' case G_TYPE_UINT:\n'
752 ' ret = (g_value_get_uint (a) == g_value_get_uint (b));\n'
754 ' case G_TYPE_INT64:\n'
755 ' ret = (g_value_get_int64 (a) == g_value_get_int64 (b));\n'
757 ' case G_TYPE_UINT64:\n'
758 ' ret = (g_value_get_uint64 (a) == g_value_get_uint64 (b));\n'
760 ' case G_TYPE_DOUBLE:\n'
762 ' /* Avoid -Wfloat-equal warnings by doing a direct bit compare */\n'
763 ' gdouble da = g_value_get_double (a);\n'
764 ' gdouble db = g_value_get_double (b);\n'
765 ' ret = memcmp (&da, &db, sizeof (gdouble)) == 0;\n'
768 ' case G_TYPE_STRING:\n'
769 ' ret = (g_strcmp0 (g_value_get_string (a), g_value_get_string (b)) == 0);\n'
771 ' case G_TYPE_VARIANT:\n'
772 ' ret = _g_variant_equal0 (g_value_get_variant (a), g_value_get_variant (b));\n'
775 ' if (G_VALUE_TYPE (a) == G_TYPE_STRV)\n'
776 ' ret = _g_strv_equal0 (g_value_get_boxed (a), g_value_get_boxed (b));\n'
778 ' g_critical ("_g_value_equal() does not handle type %s", g_type_name (G_VALUE_TYPE (a)));\n'
785 def generate_annotations(self, prefix, annotations):
786 if annotations == None:
790 for a in annotations:
791 #self.generate_annotations('%s_%d'%(prefix, n), a.get_annotations())
793 # skip internal annotations
794 if a.key.startswith('org.gtk.GDBus'):
797 self.outfile.write('static const GDBusAnnotationInfo %s_%d =\n'
801 ' (gchar *) "%s",\n'%(prefix, n, a.key, a.value))
802 if len(a.annotations) == 0:
803 self.outfile.write(' NULL\n')
805 self.outfile.write(' (GDBusAnnotationInfo **) &%s_%d_pointers\n'%(prefix, n))
806 self.outfile.write('};\n'
811 self.outfile.write('static const GDBusAnnotationInfo * const %s_pointers[] =\n'
814 for a in annotations:
815 if a.key.startswith('org.gtk.GDBus'):
817 self.outfile.write(' &%s_%d,\n'%(prefix, m))
819 self.outfile.write(' NULL\n'
824 def generate_args(self, prefix, args):
826 num_anno = self.generate_annotations('%s_arg_%s_annotation_info'%(prefix, a.name), a.annotations)
828 self.outfile.write('static const _ExtendedGDBusArgInfo %s_%s =\n'
833 ' (gchar *) "%s",\n'%(prefix, a.name, a.name, a.signature))
835 self.outfile.write(' NULL\n')
837 self.outfile.write(' (GDBusAnnotationInfo **) &%s_arg_%s_annotation_info_pointers\n'%(prefix, a.name))
838 self.outfile.write(' },\n')
839 if not utils.lookup_annotation(a.annotations, 'org.gtk.GDBus.C.ForceGVariant'):
840 self.outfile.write(' FALSE\n')
842 self.outfile.write(' TRUE\n')
843 self.outfile.write('};\n'
847 self.outfile.write('static const _ExtendedGDBusArgInfo * const %s_pointers[] =\n'
850 self.outfile.write(' &%s_%s,\n'%(prefix, a.name))
851 self.outfile.write(' NULL\n'
855 def generate_introspection_for_interface(self, i):
856 self.outfile.write('/* ---- Introspection data for %s ---- */\n'
859 if len(i.methods) > 0:
862 if utils.lookup_annotation(m.annotations, 'org.gtk.GDBus.C.UnixFD'):
864 self.generate_args('_%s_method_info_%s_IN_ARG'%(i.name_lower, m.name_lower), m.in_args)
865 self.generate_args('_%s_method_info_%s_OUT_ARG'%(i.name_lower, m.name_lower), m.out_args)
867 num_anno = self.generate_annotations('_%s_method_%s_annotation_info'%(i.name_lower, m.name_lower), m.annotations)
869 self.outfile.write('static const _ExtendedGDBusMethodInfo _%s_method_info_%s =\n'
873 ' (gchar *) "%s",\n'%(i.name_lower, m.name_lower, m.name))
874 if len(m.in_args) == 0:
875 self.outfile.write(' NULL,\n')
877 self.outfile.write(' (GDBusArgInfo **) &_%s_method_info_%s_IN_ARG_pointers,\n'%(i.name_lower, m.name_lower))
878 if len(m.out_args) == 0:
879 self.outfile.write(' NULL,\n')
881 self.outfile.write(' (GDBusArgInfo **) &_%s_method_info_%s_OUT_ARG_pointers,\n'%(i.name_lower, m.name_lower))
883 self.outfile.write(' NULL\n')
885 self.outfile.write(' (GDBusAnnotationInfo **) &_%s_method_%s_annotation_info_pointers\n'%(i.name_lower, m.name_lower))
886 self.outfile.write(' },\n'
889 %(m.name_hyphen, 'TRUE' if unix_fd else 'FALSE'))
890 self.outfile.write('};\n'
893 self.outfile.write('static const _ExtendedGDBusMethodInfo * const _%s_method_info_pointers[] =\n'
894 '{\n'%(i.name_lower))
896 self.outfile.write(' &_%s_method_info_%s,\n'%(i.name_lower, m.name_lower))
897 self.outfile.write(' NULL\n'
903 if len(i.signals) > 0:
905 self.generate_args('_%s_signal_info_%s_ARG'%(i.name_lower, s.name_lower), s.args)
907 num_anno = self.generate_annotations('_%s_signal_%s_annotation_info'%(i.name_lower, s.name_lower), s.annotations)
908 self.outfile.write('static const _ExtendedGDBusSignalInfo _%s_signal_info_%s =\n'
912 ' (gchar *) "%s",\n'%(i.name_lower, s.name_lower, s.name))
914 self.outfile.write(' NULL,\n')
916 self.outfile.write(' (GDBusArgInfo **) &_%s_signal_info_%s_ARG_pointers,\n'%(i.name_lower, s.name_lower))
918 self.outfile.write(' NULL\n')
920 self.outfile.write(' (GDBusAnnotationInfo **) &_%s_signal_%s_annotation_info_pointers\n'%(i.name_lower, s.name_lower))
921 self.outfile.write(' },\n'
924 self.outfile.write('};\n'
927 self.outfile.write('static const _ExtendedGDBusSignalInfo * const _%s_signal_info_pointers[] =\n'
928 '{\n'%(i.name_lower))
930 self.outfile.write(' &_%s_signal_info_%s,\n'%(i.name_lower, s.name_lower))
931 self.outfile.write(' NULL\n'
937 if len(i.properties) > 0:
938 for p in i.properties:
939 if p.readable and p.writable:
940 access = 'G_DBUS_PROPERTY_INFO_FLAGS_READABLE | G_DBUS_PROPERTY_INFO_FLAGS_WRITABLE'
942 access = 'G_DBUS_PROPERTY_INFO_FLAGS_READABLE'
944 access = 'G_DBUS_PROPERTY_INFO_FLAGS_WRITABLE'
946 access = 'G_DBUS_PROPERTY_INFO_FLAGS_NONE'
947 num_anno = self.generate_annotations('_%s_property_%s_annotation_info'%(i.name_lower, p.name_lower), p.annotations)
948 self.outfile.write('static const _ExtendedGDBusPropertyInfo _%s_property_info_%s =\n'
954 ' %s,\n'%(i.name_lower, p.name_lower, p.name, p.arg.signature, access))
956 self.outfile.write(' NULL\n')
958 self.outfile.write(' (GDBusAnnotationInfo **) &_%s_property_%s_annotation_info_pointers\n'%(i.name_lower, p.name_lower))
959 self.outfile.write(' },\n'
962 if not utils.lookup_annotation(p.annotations, 'org.gtk.GDBus.C.ForceGVariant'):
963 self.outfile.write(' FALSE\n')
965 self.outfile.write(' TRUE\n')
966 self.outfile.write('};\n'
969 self.outfile.write('static const _ExtendedGDBusPropertyInfo * const _%s_property_info_pointers[] =\n'
970 '{\n'%(i.name_lower))
971 for p in i.properties:
972 self.outfile.write(' &_%s_property_info_%s,\n'%(i.name_lower, p.name_lower))
973 self.outfile.write(' NULL\n'
977 num_anno = self.generate_annotations('_%s_annotation_info'%(i.name_lower), i.annotations)
978 self.outfile.write('static const _ExtendedGDBusInterfaceInfo _%s_interface_info =\n'
982 ' (gchar *) "%s",\n'%(i.name_lower, i.name))
983 if len(i.methods) == 0:
984 self.outfile.write(' NULL,\n')
986 self.outfile.write(' (GDBusMethodInfo **) &_%s_method_info_pointers,\n'%(i.name_lower))
987 if len(i.signals) == 0:
988 self.outfile.write(' NULL,\n')
990 self.outfile.write(' (GDBusSignalInfo **) &_%s_signal_info_pointers,\n'%(i.name_lower))
991 if len(i.properties) == 0:
992 self.outfile.write(' NULL,\n')
994 self.outfile.write(' (GDBusPropertyInfo **) &_%s_property_info_pointers,\n'%(i.name_lower))
996 self.outfile.write(' NULL\n')
998 self.outfile.write(' (GDBusAnnotationInfo **) &_%s_annotation_info_pointers\n'%(i.name_lower))
999 self.outfile.write(' },\n'
1004 self.outfile.write('\n')
1005 self.outfile.write(self.docbook_gen.expand(
1007 ' * %s_interface_info:\n'
1009 ' * Gets a machine-readable description of the #%s D-Bus interface.\n'
1011 ' * Returns: (transfer none): A #GDBusInterfaceInfo. Do not free.\n'
1012 %(i.name_lower, i.name), False))
1013 self.write_gtkdoc_deprecated_and_since_and_close(i, self.outfile, 0)
1014 self.outfile.write('GDBusInterfaceInfo *\n'
1015 '%s_interface_info (void)\n'
1017 ' return (GDBusInterfaceInfo *) &_%s_interface_info.parent_struct;\n'
1019 '\n'%(i.name_lower, i.name_lower))
1021 self.outfile.write(self.docbook_gen.expand(
1023 ' * %s_override_properties:\n'
1024 ' * @klass: The class structure for a #GObject derived class.\n'
1025 ' * @property_id_begin: The property id to assign to the first overridden property.\n'
1027 ' * Overrides all #GObject properties in the #%s interface for a concrete class.\n'
1028 ' * The properties are overridden in the order they are defined.\n'
1030 ' * Returns: The last property id.\n'
1031 %(i.name_lower, i.camel_name), False))
1032 self.write_gtkdoc_deprecated_and_since_and_close(i, self.outfile, 0)
1033 self.outfile.write('guint\n'
1034 '%s_override_properties (GObjectClass *klass, guint property_id_begin)\n'
1035 '{\n'%(i.name_lower))
1036 for p in i.properties:
1037 self.outfile.write(' g_object_class_override_property (klass, property_id_begin++, "%s");\n'%(p.name_hyphen))
1038 self.outfile.write(' return property_id_begin - 1;\n'
1041 self.outfile.write('\n')
1043 # ----------------------------------------------------------------------------------------------------
1045 def generate_interface(self, i):
1046 self.outfile.write('\n')
1048 self.outfile.write(self.docbook_gen.expand(
1052 ' * Abstract interface type for the D-Bus interface #%s.\n'
1053 %(i.camel_name, i.name), False))
1054 self.write_gtkdoc_deprecated_and_since_and_close(i, self.outfile, 0)
1055 self.outfile.write('\n')
1057 self.outfile.write(self.docbook_gen.expand(
1060 ' * @parent_iface: The parent interface.\n'
1061 %(i.camel_name), False))
1064 if len(i.methods) > 0:
1066 key = (m.since, '_method_%s'%m.name_lower)
1067 value = '@handle_%s: '%(m.name_lower)
1068 value += 'Handler for the #%s::handle-%s signal.'%(i.camel_name, m.name_hyphen)
1069 doc_bits[key] = value
1070 if len(i.signals) > 0:
1072 key = (s.since, '_signal_%s'%s.name_lower)
1073 value = '@%s: '%(s.name_lower)
1074 value += 'Handler for the #%s::%s signal.'%(i.camel_name, s.name_hyphen)
1075 doc_bits[key] = value
1076 if len(i.properties) > 0:
1077 for p in i.properties:
1078 key = (p.since, '_prop_get_%s'%p.name_lower)
1079 value = '@get_%s: '%(p.name_lower)
1080 value += 'Getter for the #%s:%s property.'%(i.camel_name, p.name_hyphen)
1081 doc_bits[key] = value
1082 for key in sorted(doc_bits.keys(), key=utils.version_cmp_key):
1083 self.outfile.write(' * %s\n'%doc_bits[key])
1085 self.outfile.write(self.docbook_gen.expand(
1087 ' * Virtual table for the D-Bus interface #%s.\n'
1089 self.write_gtkdoc_deprecated_and_since_and_close(i, self.outfile, 0)
1090 self.outfile.write('\n')
1092 self.outfile.write('typedef %sIface %sInterface;\n'%(i.camel_name, i.camel_name))
1093 self.outfile.write('G_DEFINE_INTERFACE (%s, %s, G_TYPE_OBJECT)\n'%(i.camel_name, i.name_lower))
1094 self.outfile.write('\n')
1096 self.outfile.write('static void\n'
1097 '%s_default_init (%sIface *iface)\n'
1098 '{\n'%(i.name_lower, i.camel_name));
1100 if len(i.methods) > 0:
1101 self.outfile.write(' /* GObject signals for incoming D-Bus method calls: */\n')
1104 if utils.lookup_annotation(m.annotations, 'org.gtk.GDBus.C.UnixFD'):
1106 self.outfile.write(self.docbook_gen.expand(
1108 ' * %s::handle-%s:\n'
1109 ' * @object: A #%s.\n'
1110 ' * @invocation: A #GDBusMethodInvocation.\n'
1111 %(i.camel_name, m.name_hyphen, i.camel_name), False))
1113 self.outfile.write(' * @fd_list: (nullable): A #GUnixFDList or %NULL.\n')
1115 self.outfile.write(' * @arg_%s: Argument passed by remote caller.\n'%(a.name))
1116 self.outfile.write(self.docbook_gen.expand(
1118 ' * Signal emitted when a remote caller is invoking the %s.%s() D-Bus method.\n'
1120 ' * 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'
1122 ' * Returns: %%TRUE if the invocation was handled, %%FALSE to let other signal handlers run.\n'
1123 %(i.name, m.name, i.name_lower, m.name_lower), False))
1124 self.write_gtkdoc_deprecated_and_since_and_close(m, self.outfile, 2)
1129 self.outfile.write(' g_signal_new ("handle-%s",\n'
1130 ' G_TYPE_FROM_INTERFACE (iface),\n'
1131 ' G_SIGNAL_RUN_LAST,\n'
1132 ' G_STRUCT_OFFSET (%sIface, handle_%s),\n'
1133 ' g_signal_accumulator_true_handled,\n'
1134 ' NULL,\n' # accu_data
1135 ' g_cclosure_marshal_generic,\n'
1136 ' G_TYPE_BOOLEAN,\n'
1138 ' G_TYPE_DBUS_METHOD_INVOCATION'
1139 %(m.name_hyphen, i.camel_name, m.name_lower, len(m.in_args) + extra_args))
1141 self.outfile.write(', G_TYPE_UNIX_FD_LIST')
1143 self.outfile.write(', %s'%(a.gtype))
1144 self.outfile.write(');\n')
1145 self.outfile.write('\n')
1147 if len(i.signals) > 0:
1148 self.outfile.write(' /* GObject signals for received D-Bus signals: */\n')
1150 self.outfile.write(self.docbook_gen.expand(
1153 ' * @object: A #%s.\n'
1154 %(i.camel_name, s.name_hyphen, i.camel_name), False))
1156 self.outfile.write(' * @arg_%s: Argument.\n'%(a.name))
1157 self.outfile.write(self.docbook_gen.expand(
1159 ' * On the client-side, this signal is emitted whenever the D-Bus signal #%s::%s is received.\n'
1161 ' * 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'
1162 %(i.name, s.name), False))
1163 self.write_gtkdoc_deprecated_and_since_and_close(s, self.outfile, 2)
1164 self.outfile.write(' g_signal_new ("%s",\n'
1165 ' G_TYPE_FROM_INTERFACE (iface),\n'
1166 ' G_SIGNAL_RUN_LAST,\n'
1167 ' G_STRUCT_OFFSET (%sIface, %s),\n'
1168 ' NULL,\n' # accumulator
1169 ' NULL,\n' # accu_data
1170 ' g_cclosure_marshal_generic,\n'
1173 %(s.name_hyphen, i.camel_name, s.name_lower, len(s.args)))
1175 self.outfile.write(', %s'%(a.gtype))
1176 self.outfile.write(');\n')
1177 self.outfile.write('\n')
1179 if len(i.properties) > 0:
1180 self.outfile.write(' /* GObject properties for D-Bus properties: */\n')
1181 for p in i.properties:
1182 if p.readable and p.writable:
1183 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.'
1185 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.'
1187 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.'
1189 print_error('Cannot handle property "{}" that neither readable nor writable'.format(p.name))
1190 self.outfile.write(self.docbook_gen.expand(
1194 ' * Represents the D-Bus property #%s:%s.\n'
1197 %(i.camel_name, p.name_hyphen, i.name, p.name, hint), False))
1198 self.write_gtkdoc_deprecated_and_since_and_close(p, self.outfile, 2)
1199 self.outfile.write(' g_object_interface_install_property (iface,\n')
1200 if p.arg.gtype == 'G_TYPE_VARIANT':
1201 s = 'g_param_spec_variant ("%s", "%s", "%s", G_VARIANT_TYPE ("%s"), NULL'%(p.name_hyphen, p.name, p.name, p.arg.signature)
1202 elif p.arg.signature == 'b':
1203 s = 'g_param_spec_boolean ("%s", "%s", "%s", FALSE'%(p.name_hyphen, p.name, p.name)
1204 elif p.arg.signature == 'y':
1205 s = 'g_param_spec_uchar ("%s", "%s", "%s", 0, 255, 0'%(p.name_hyphen, p.name, p.name)
1206 elif p.arg.signature == 'n':
1207 s = 'g_param_spec_int ("%s", "%s", "%s", G_MININT16, G_MAXINT16, 0'%(p.name_hyphen, p.name, p.name)
1208 elif p.arg.signature == 'q':
1209 s = 'g_param_spec_uint ("%s", "%s", "%s", 0, G_MAXUINT16, 0'%(p.name_hyphen, p.name, p.name)
1210 elif p.arg.signature == 'i':
1211 s = 'g_param_spec_int ("%s", "%s", "%s", G_MININT32, G_MAXINT32, 0'%(p.name_hyphen, p.name, p.name)
1212 elif p.arg.signature == 'u':
1213 s = 'g_param_spec_uint ("%s", "%s", "%s", 0, G_MAXUINT32, 0'%(p.name_hyphen, p.name, p.name)
1214 elif p.arg.signature == 'x':
1215 s = 'g_param_spec_int64 ("%s", "%s", "%s", G_MININT64, G_MAXINT64, 0'%(p.name_hyphen, p.name, p.name)
1216 elif p.arg.signature == 't':
1217 s = 'g_param_spec_uint64 ("%s", "%s", "%s", 0, G_MAXUINT64, 0'%(p.name_hyphen, p.name, p.name)
1218 elif p.arg.signature == 'd':
1219 s = 'g_param_spec_double ("%s", "%s", "%s", -G_MAXDOUBLE, G_MAXDOUBLE, 0.0'%(p.name_hyphen, p.name, p.name)
1220 elif p.arg.signature == 's':
1221 s = 'g_param_spec_string ("%s", "%s", "%s", NULL'%(p.name_hyphen, p.name, p.name)
1222 elif p.arg.signature == 'o':
1223 s = 'g_param_spec_string ("%s", "%s", "%s", NULL'%(p.name_hyphen, p.name, p.name)
1224 elif p.arg.signature == 'g':
1225 s = 'g_param_spec_string ("%s", "%s", "%s", NULL'%(p.name_hyphen, p.name, p.name)
1226 elif p.arg.signature == 'ay':
1227 s = 'g_param_spec_string ("%s", "%s", "%s", NULL'%(p.name_hyphen, p.name, p.name)
1228 elif p.arg.signature == 'as':
1229 s = 'g_param_spec_boxed ("%s", "%s", "%s", G_TYPE_STRV'%(p.name_hyphen, p.name, p.name)
1230 elif p.arg.signature == 'ao':
1231 s = 'g_param_spec_boxed ("%s", "%s", "%s", G_TYPE_STRV'%(p.name_hyphen, p.name, p.name)
1232 elif p.arg.signature == 'aay':
1233 s = 'g_param_spec_boxed ("%s", "%s", "%s", G_TYPE_STRV'%(p.name_hyphen, p.name, p.name)
1235 print_error('Unsupported gtype "{}" for GParamSpec'.format(p.arg.gtype))
1236 self.outfile.write(' %s, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));'%s);
1237 self.outfile.write('\n')
1239 self.outfile.write('}\n'
1242 # ----------------------------------------------------------------------------------------------------
1244 def generate_property_accessors(self, i):
1245 for p in i.properties:
1247 if p.readable and p.writable:
1248 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.'
1250 hint = 'Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side.'
1252 hint = 'Since this D-Bus property is not readable, it is only meaningful to use this function on the service-side.'
1254 print_error('Cannot handle property "{}" that neither readable nor writable'.format(p.name))
1255 self.outfile.write(self.docbook_gen.expand(
1257 ' * %s_get_%s: (skip)\n'
1258 ' * @object: A #%s.\n'
1260 ' * Gets the value of the #%s:%s D-Bus property.\n'
1264 %(i.name_lower, p.name_lower, i.camel_name, i.name, p.name, hint), False))
1265 if p.arg.free_func != None:
1266 self.outfile.write(' * <warning>The returned value is only valid until the property changes so on the client-side it is only safe to use this function on the thread where @object was constructed. Use %s_dup_%s() if on another thread.</warning>\n'
1268 ' * Returns: (transfer none): The property value or %%NULL if the property is not set. Do not free the returned value, it belongs to @object.\n'
1269 %(i.name_lower, p.name_lower))
1271 self.outfile.write(' * Returns: The property value.\n')
1272 self.write_gtkdoc_deprecated_and_since_and_close(p, self.outfile, 0)
1273 self.outfile.write('%s\n'
1274 '%s_get_%s (%s *object)\n'
1275 '{\n'%(p.arg.ctype_in, i.name_lower, p.name_lower, i.camel_name))
1276 self.outfile.write(' return %s%s_GET_IFACE (object)->get_%s (object);\n'%(i.ns_upper, i.name_upper, p.name_lower))
1277 self.outfile.write('}\n')
1278 self.outfile.write('\n')
1279 if p.arg.free_func != None:
1281 self.outfile.write(self.docbook_gen.expand(
1283 ' * %s_dup_%s: (skip)\n'
1284 ' * @object: A #%s.\n'
1286 ' * Gets a copy of the #%s:%s D-Bus property.\n'
1290 ' * Returns: (transfer full): The property value or %%NULL if the property is not set. The returned value should be freed with %s().\n'
1291 %(i.name_lower, p.name_lower, i.camel_name, i.name, p.name, hint, p.arg.free_func), False))
1292 self.write_gtkdoc_deprecated_and_since_and_close(p, self.outfile, 0)
1293 self.outfile.write('%s\n'
1294 '%s_dup_%s (%s *object)\n'
1296 ' %svalue;\n'%(p.arg.ctype_in_dup, i.name_lower, p.name_lower, i.camel_name, p.arg.ctype_in_dup))
1297 self.outfile.write(' g_object_get (G_OBJECT (object), "%s", &value, NULL);\n'%(p.name_hyphen))
1298 self.outfile.write(' return value;\n')
1299 self.outfile.write('}\n')
1300 self.outfile.write('\n')
1303 if p.readable and p.writable:
1304 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.'
1306 hint = 'Since this D-Bus property is not writable, it is only meaningful to use this function on the service-side.'
1308 hint = 'Since this D-Bus property is writable, it is meaningful to use this function on both the client- and service-side.'
1310 print_error('Cannot handle property "{}" that neither readable nor writable'.format(p.name))
1311 self.outfile.write(self.docbook_gen.expand(
1313 ' * %s_set_%s: (skip)\n'
1314 ' * @object: A #%s.\n'
1315 ' * @value: The value to set.\n'
1317 ' * Sets the #%s:%s D-Bus property to @value.\n'
1320 %(i.name_lower, p.name_lower, i.camel_name, i.name, p.name, hint), False))
1321 self.write_gtkdoc_deprecated_and_since_and_close(p, self.outfile, 0)
1322 self.outfile.write('void\n'
1323 '%s_set_%s (%s *object, %svalue)\n'
1324 '{\n'%(i.name_lower, p.name_lower, i.camel_name, p.arg.ctype_in, ))
1325 self.outfile.write(' g_object_set (G_OBJECT (object), "%s", value, NULL);\n'%(p.name_hyphen))
1326 self.outfile.write('}\n')
1327 self.outfile.write('\n')
1329 # ---------------------------------------------------------------------------------------------------
1331 def generate_signal_emitters(self, i):
1333 self.outfile.write(self.docbook_gen.expand(
1336 ' * @object: A #%s.\n'
1337 %(i.name_lower, s.name_lower, i.camel_name), False))
1339 self.outfile.write(' * @arg_%s: Argument to pass with the signal.\n'%(a.name))
1340 self.outfile.write(self.docbook_gen.expand(
1342 ' * Emits the #%s::%s D-Bus signal.\n'
1343 %(i.name, s.name), False))
1344 self.write_gtkdoc_deprecated_and_since_and_close(s, self.outfile, 0)
1345 self.outfile.write('void\n'
1347 ' %s *object'%(i.name_lower, s.name_lower, i.camel_name))
1349 self.outfile.write(',\n %sarg_%s'%(a.ctype_in, a.name))
1350 self.outfile.write(')\n'
1352 ' g_signal_emit_by_name (object, "%s"'%(s.name_hyphen))
1354 self.outfile.write(', arg_%s'%a.name)
1355 self.outfile.write(');\n')
1356 self.outfile.write('}\n'
1359 # ---------------------------------------------------------------------------------------------------
1361 def generate_method_calls(self, i):
1364 if utils.lookup_annotation(m.annotations, 'org.gtk.GDBus.C.UnixFD'):
1367 self.outfile.write('/**\n'
1369 ' * @proxy: A #%sProxy.\n'
1370 %(i.name_lower, m.name_lower, i.camel_name))
1372 self.outfile.write(' * @arg_%s: Argument to pass with the method invocation.\n'%(a.name))
1374 self.outfile.write(' * @fd_list: (nullable): A #GUnixFDList or %NULL.\n')
1375 self.outfile.write(self.docbook_gen.expand(
1376 ' * @cancellable: (nullable): A #GCancellable or %%NULL.\n'
1377 ' * @callback: A #GAsyncReadyCallback to call when the request is satisfied or %%NULL.\n'
1378 ' * @user_data: User data to pass to @callback.\n'
1380 ' * Asynchronously invokes the %s.%s() D-Bus method on @proxy.\n'
1381 ' * 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'
1382 ' * You can then call %s_call_%s_finish() to get the result of the operation.\n'
1384 ' * See %s_call_%s_sync() for the synchronous, blocking version of this method.\n'
1385 %(i.name, m.name, i.name_lower, m.name_lower, i.name_lower, m.name_lower), False))
1386 self.write_gtkdoc_deprecated_and_since_and_close(m, self.outfile, 0)
1387 self.outfile.write('void\n'
1389 ' %s *proxy'%(i.name_lower, m.name_lower, i.camel_name))
1391 self.outfile.write(',\n %sarg_%s'%(a.ctype_in, a.name))
1393 self.outfile.write(',\n GUnixFDList *fd_list')
1394 self.outfile.write(',\n'
1395 ' GCancellable *cancellable,\n'
1396 ' GAsyncReadyCallback callback,\n'
1397 ' gpointer user_data)\n'
1400 self.outfile.write(' g_dbus_proxy_call_with_unix_fd_list (G_DBUS_PROXY (proxy),\n')
1402 self.outfile.write(' g_dbus_proxy_call (G_DBUS_PROXY (proxy),\n')
1403 self.outfile.write(' "%s",\n'
1404 ' g_variant_new ("('%(m.name))
1406 self.outfile.write('%s'%(a.format_in))
1407 self.outfile.write(')"')
1409 self.outfile.write(',\n arg_%s'%(a.name))
1410 self.outfile.write('),\n'
1411 ' G_DBUS_CALL_FLAGS_NONE,\n'
1414 self.outfile.write(' fd_list,\n')
1415 self.outfile.write(' cancellable,\n'
1418 self.outfile.write('}\n'
1421 self.outfile.write('/**\n'
1422 ' * %s_call_%s_finish:\n'
1423 ' * @proxy: A #%sProxy.\n'
1424 %(i.name_lower, m.name_lower, i.camel_name))
1425 for a in m.out_args:
1426 self.outfile.write(' * @out_%s: (out)%s: Return location for return parameter or %%NULL to ignore.\n'%(a.name, ' ' + a.array_annotation if a.array_annotation else ''))
1428 self.outfile.write(' * @out_fd_list: (out): Return location for a #GUnixFDList or %NULL.\n')
1429 self.outfile.write(self.docbook_gen.expand(
1430 ' * @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to %s_call_%s().\n'
1431 ' * @error: Return location for error or %%NULL.\n'
1433 ' * Finishes an operation started with %s_call_%s().\n'
1435 ' * Returns: (skip): %%TRUE if the call succeded, %%FALSE if @error is set.\n'
1436 %(i.name_lower, m.name_lower, i.name_lower, m.name_lower), False))
1437 self.write_gtkdoc_deprecated_and_since_and_close(m, self.outfile, 0)
1438 self.outfile.write('gboolean\n'
1439 '%s_call_%s_finish (\n'
1440 ' %s *proxy'%(i.name_lower, m.name_lower, i.camel_name))
1441 for a in m.out_args:
1442 self.outfile.write(',\n %sout_%s'%(a.ctype_out, a.name))
1444 self.outfile.write(',\n GUnixFDList **out_fd_list')
1445 self.outfile.write(',\n'
1446 ' GAsyncResult *res,\n'
1447 ' GError **error)\n'
1449 ' GVariant *_ret;\n')
1451 self.outfile.write(' _ret = g_dbus_proxy_call_with_unix_fd_list_finish (G_DBUS_PROXY (proxy), out_fd_list, res, error);\n')
1453 self.outfile.write(' _ret = g_dbus_proxy_call_finish (G_DBUS_PROXY (proxy), res, error);\n')
1454 self.outfile.write(' if (_ret == NULL)\n'
1456 self.outfile.write(' g_variant_get (_ret,\n'
1458 for a in m.out_args:
1459 self.outfile.write('%s'%(a.format_out))
1460 self.outfile.write(')"')
1461 for a in m.out_args:
1462 self.outfile.write(',\n out_%s'%(a.name))
1463 self.outfile.write(');\n'
1464 ' g_variant_unref (_ret);\n')
1465 self.outfile.write('_out:\n'
1466 ' return _ret != NULL;\n'
1472 self.outfile.write('/**\n'
1473 ' * %s_call_%s_sync:\n'
1474 ' * @proxy: A #%sProxy.\n'
1475 %(i.name_lower, m.name_lower, i.camel_name))
1477 self.outfile.write(' * @arg_%s: Argument to pass with the method invocation.\n'%(a.name))
1479 self.outfile.write(' * @fd_list: (nullable): A #GUnixFDList or %NULL.\n')
1480 for a in m.out_args:
1481 self.outfile.write(' * @out_%s: (out)%s: Return location for return parameter or %%NULL to ignore.\n'%(a.name, ' ' + a.array_annotation if a.array_annotation else ''))
1483 self.outfile.write(' * @out_fd_list: (out): Return location for a #GUnixFDList or %NULL.\n')
1484 self.outfile.write(self.docbook_gen.expand(
1485 ' * @cancellable: (nullable): A #GCancellable or %%NULL.\n'
1486 ' * @error: Return location for error or %%NULL.\n'
1488 ' * Synchronously invokes the %s.%s() D-Bus method on @proxy. The calling thread is blocked until a reply is received.\n'
1490 ' * See %s_call_%s() for the asynchronous version of this method.\n'
1492 ' * Returns: (skip): %%TRUE if the call succeded, %%FALSE if @error is set.\n'
1493 %(i.name, m.name, i.name_lower, m.name_lower), False))
1494 self.write_gtkdoc_deprecated_and_since_and_close(m, self.outfile, 0)
1495 self.outfile.write('gboolean\n'
1496 '%s_call_%s_sync (\n'
1497 ' %s *proxy'%(i.name_lower, m.name_lower, i.camel_name))
1499 self.outfile.write(',\n %sarg_%s'%(a.ctype_in, a.name))
1501 self.outfile.write(',\n GUnixFDList *fd_list')
1502 for a in m.out_args:
1503 self.outfile.write(',\n %sout_%s'%(a.ctype_out, a.name))
1505 self.outfile.write(',\n GUnixFDList **out_fd_list')
1506 self.outfile.write(',\n'
1507 ' GCancellable *cancellable,\n'
1508 ' GError **error)\n'
1510 ' GVariant *_ret;\n')
1512 self.outfile.write(' _ret = g_dbus_proxy_call_with_unix_fd_list_sync (G_DBUS_PROXY (proxy),\n')
1514 self.outfile.write(' _ret = g_dbus_proxy_call_sync (G_DBUS_PROXY (proxy),\n')
1515 self.outfile.write(' "%s",\n'
1516 ' g_variant_new ("('%(m.name))
1518 self.outfile.write('%s'%(a.format_in))
1519 self.outfile.write(')"')
1521 self.outfile.write(',\n arg_%s'%(a.name))
1522 self.outfile.write('),\n'
1523 ' G_DBUS_CALL_FLAGS_NONE,\n'
1526 self.outfile.write(' fd_list,\n'
1528 self.outfile.write(' cancellable,\n'
1530 ' if (_ret == NULL)\n'
1532 self.outfile.write(' g_variant_get (_ret,\n'
1534 for a in m.out_args:
1535 self.outfile.write('%s'%(a.format_out))
1536 self.outfile.write(')"')
1537 for a in m.out_args:
1538 self.outfile.write(',\n out_%s'%(a.name))
1539 self.outfile.write(');\n'
1540 ' g_variant_unref (_ret);\n')
1541 self.outfile.write('_out:\n'
1542 ' return _ret != NULL;\n'
1546 # ---------------------------------------------------------------------------------------------------
1548 def generate_method_completers(self, i):
1551 if utils.lookup_annotation(m.annotations, 'org.gtk.GDBus.C.UnixFD'):
1553 self.outfile.write('/**\n'
1554 ' * %s_complete_%s:\n'
1555 ' * @object: A #%s.\n'
1556 ' * @invocation: (transfer full): A #GDBusMethodInvocation.\n'
1557 %(i.name_lower, m.name_lower, i.camel_name))
1559 self.outfile.write(' * @fd_list: (nullable): A #GUnixFDList or %NULL.\n')
1560 for a in m.out_args:
1561 self.outfile.write(' * @%s: Parameter to return.\n'%(a.name))
1562 self.outfile.write(self.docbook_gen.expand(
1564 ' * 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'
1566 ' * This method will free @invocation, you cannot use it afterwards.\n'
1567 %(i.name, m.name), False))
1568 self.write_gtkdoc_deprecated_and_since_and_close(m, self.outfile, 0)
1569 self.outfile.write('void\n'
1570 '%s_complete_%s (\n'
1572 ' GDBusMethodInvocation *invocation'%(i.name_lower, m.name_lower, i.camel_name))
1574 self.outfile.write(',\n GUnixFDList *fd_list')
1575 for a in m.out_args:
1576 self.outfile.write(',\n %s%s'%(a.ctype_in, a.name))
1577 self.outfile.write(')\n'
1581 self.outfile.write(' g_dbus_method_invocation_return_value_with_unix_fd_list (invocation,\n'
1582 ' g_variant_new ("(')
1584 self.outfile.write(' g_dbus_method_invocation_return_value (invocation,\n'
1585 ' g_variant_new ("(')
1586 for a in m.out_args:
1587 self.outfile.write('%s'%(a.format_in))
1588 self.outfile.write(')"')
1589 for a in m.out_args:
1590 self.outfile.write(',\n %s'%(a.name))
1592 self.outfile.write('),\n fd_list);\n')
1594 self.outfile.write('));\n')
1595 self.outfile.write('}\n'
1598 # ---------------------------------------------------------------------------------------------------
1600 def generate_proxy(self, i):
1602 self.outfile.write('/* ------------------------------------------------------------------------ */\n'
1605 self.outfile.write(self.docbook_gen.expand(
1609 ' * The #%sProxy structure contains only private data and should only be accessed using the provided API.\n'
1610 %(i.camel_name, i.camel_name), False))
1611 self.write_gtkdoc_deprecated_and_since_and_close(i, self.outfile, 0)
1612 self.outfile.write('\n')
1614 self.outfile.write(self.docbook_gen.expand(
1616 ' * %sProxyClass:\n'
1617 ' * @parent_class: The parent class.\n'
1619 ' * Class structure for #%sProxy.\n'
1620 %(i.camel_name, i.camel_name), False))
1621 self.write_gtkdoc_deprecated_and_since_and_close(i, self.outfile, 0)
1622 self.outfile.write('\n')
1624 self.outfile.write('struct _%sProxyPrivate\n'
1630 self.outfile.write('static void %s_proxy_iface_init (%sIface *iface);\n'
1631 '\n'%(i.name_lower, i.camel_name))
1632 self.outfile.write('#if GLIB_VERSION_MAX_ALLOWED >= GLIB_VERSION_2_38\n')
1633 self.outfile.write('G_DEFINE_TYPE_WITH_CODE (%sProxy, %s_proxy, G_TYPE_DBUS_PROXY,\n'%(i.camel_name, i.name_lower))
1634 self.outfile.write(' G_ADD_PRIVATE (%sProxy)\n'%(i.camel_name))
1635 self.outfile.write(' G_IMPLEMENT_INTERFACE (%sTYPE_%s, %s_proxy_iface_init))\n\n'%(i.ns_upper, i.name_upper, i.name_lower))
1636 self.outfile.write('#else\n')
1637 self.outfile.write('G_DEFINE_TYPE_WITH_CODE (%sProxy, %s_proxy, G_TYPE_DBUS_PROXY,\n'%(i.camel_name, i.name_lower))
1638 self.outfile.write(' G_IMPLEMENT_INTERFACE (%sTYPE_%s, %s_proxy_iface_init))\n\n'%(i.ns_upper, i.name_upper, i.name_lower))
1639 self.outfile.write('#endif\n')
1642 self.outfile.write('static void\n'
1643 '%s_proxy_finalize (GObject *object)\n'
1644 '{\n'%(i.name_lower))
1645 self.outfile.write(' %sProxy *proxy = %s%s_PROXY (object);\n'%(i.camel_name, i.ns_upper, i.name_upper))
1646 self.outfile.write(' g_datalist_clear (&proxy->priv->qdata);\n')
1647 self.outfile.write(' G_OBJECT_CLASS (%s_proxy_parent_class)->finalize (object);\n'
1649 '\n'%(i.name_lower))
1651 # property accessors
1653 # Note that we are guaranteed that prop_id starts at 1 and is
1654 # laid out in the same order as introspection data pointers
1656 self.outfile.write('static void\n'
1657 '%s_proxy_get_property (GObject *object,\n'
1660 ' GParamSpec *pspec G_GNUC_UNUSED)\n'
1661 '{\n'%(i.name_lower))
1662 if len(i.properties) > 0:
1663 self.outfile.write(' const _ExtendedGDBusPropertyInfo *info;\n'
1664 ' GVariant *variant;\n'
1665 ' g_assert (prop_id != 0 && prop_id - 1 < %d);\n'
1666 ' info = _%s_property_info_pointers[prop_id - 1];\n'
1667 ' variant = g_dbus_proxy_get_cached_property (G_DBUS_PROXY (object), info->parent_struct.name);\n'
1668 ' if (info->use_gvariant)\n'
1670 ' g_value_set_variant (value, variant);\n'
1674 # could be that we don't have the value in cache - in that case, we do
1675 # nothing and the user gets the default value for the GType
1676 ' if (variant != NULL)\n'
1677 ' g_dbus_gvariant_to_gvalue (variant, value);\n'
1679 ' if (variant != NULL)\n'
1680 ' g_variant_unref (variant);\n'
1681 %(len(i.properties), i.name_lower))
1682 self.outfile.write('}\n'
1684 if len(i.properties) > 0:
1685 self.outfile.write('static void\n'
1686 '%s_proxy_set_property_cb (GDBusProxy *proxy,\n'
1687 ' GAsyncResult *res,\n'
1688 ' gpointer user_data)\n'
1689 '{\n'%(i.name_lower))
1690 self.outfile.write(' const _ExtendedGDBusPropertyInfo *info = user_data;\n'
1692 ' GVariant *_ret;\n'
1694 ' _ret = g_dbus_proxy_call_finish (proxy, res, &error);\n'
1697 ' g_warning ("Error setting property \'%%s\' on interface %s: %%s (%%s, %%d)",\n'
1698 ' info->parent_struct.name, \n'
1699 ' error->message, g_quark_to_string (error->domain), error->code);\n'
1700 ' g_error_free (error);\n'
1704 ' g_variant_unref (_ret);\n'
1707 self.outfile.write('}\n'
1709 self.outfile.write('static void\n'
1710 '%s_proxy_set_property (GObject *object,\n'
1712 ' const GValue *value,\n'
1713 ' GParamSpec *pspec G_GNUC_UNUSED)\n'
1714 '{\n'%(i.name_lower))
1715 if len(i.properties) > 0:
1716 self.outfile.write(' const _ExtendedGDBusPropertyInfo *info;\n'
1717 ' GVariant *variant;\n'
1718 ' g_assert (prop_id != 0 && prop_id - 1 < %d);\n'
1719 ' info = _%s_property_info_pointers[prop_id - 1];\n'
1720 ' variant = g_dbus_gvalue_to_gvariant (value, G_VARIANT_TYPE (info->parent_struct.signature));\n'
1721 ' g_dbus_proxy_call (G_DBUS_PROXY (object),\n'
1722 ' "org.freedesktop.DBus.Properties.Set",\n'
1723 ' g_variant_new ("(ssv)", "%s", info->parent_struct.name, variant),\n'
1724 ' G_DBUS_CALL_FLAGS_NONE,\n'
1726 ' NULL, (GAsyncReadyCallback) %s_proxy_set_property_cb, (GDBusPropertyInfo *) &info->parent_struct);\n'
1727 ' g_variant_unref (variant);\n'
1728 %(len(i.properties), i.name_lower, i.name, i.name_lower))
1729 self.outfile.write('}\n'
1733 self.outfile.write('static void\n'
1734 '%s_proxy_g_signal (GDBusProxy *proxy,\n'
1735 ' const gchar *sender_name G_GNUC_UNUSED,\n'
1736 ' const gchar *signal_name,\n'
1737 ' GVariant *parameters)\n'
1738 '{\n'%(i.name_lower))
1739 self.outfile.write(' _ExtendedGDBusSignalInfo *info;\n'
1740 ' GVariantIter iter;\n'
1741 ' GVariant *child;\n'
1742 ' GValue *paramv;\n'
1743 ' gsize num_params;\n'
1745 ' guint signal_id;\n');
1746 # Note: info could be NULL if we are talking to a newer version of the interface
1747 self.outfile.write(' info = (_ExtendedGDBusSignalInfo *) g_dbus_interface_info_lookup_signal ((GDBusInterfaceInfo *) &_%s_interface_info.parent_struct, signal_name);\n'
1748 ' if (info == NULL)\n'
1751 self.outfile.write(' num_params = g_variant_n_children (parameters);\n'
1752 ' paramv = g_new0 (GValue, num_params + 1);\n'
1753 ' g_value_init (¶mv[0], %sTYPE_%s);\n'
1754 ' g_value_set_object (¶mv[0], proxy);\n'
1755 %(i.ns_upper, i.name_upper))
1756 self.outfile.write(' g_variant_iter_init (&iter, parameters);\n'
1758 ' while ((child = g_variant_iter_next_value (&iter)) != NULL)\n'
1760 ' _ExtendedGDBusArgInfo *arg_info = (_ExtendedGDBusArgInfo *) info->parent_struct.args[n - 1];\n'
1761 ' if (arg_info->use_gvariant)\n'
1763 ' g_value_init (¶mv[n], G_TYPE_VARIANT);\n'
1764 ' g_value_set_variant (¶mv[n], child);\n'
1768 ' g_dbus_gvariant_to_gvalue (child, ¶mv[n++]);\n'
1769 ' g_variant_unref (child);\n'
1772 self.outfile.write(' signal_id = g_signal_lookup (info->signal_name, %sTYPE_%s);\n'
1773 %(i.ns_upper, i.name_upper))
1774 self.outfile.write(' g_signal_emitv (paramv, signal_id, 0, NULL);\n')
1775 self.outfile.write(' for (n = 0; n < num_params + 1; n++)\n'
1776 ' g_value_unset (¶mv[n]);\n'
1777 ' g_free (paramv);\n')
1778 self.outfile.write('}\n'
1782 self.outfile.write('static void\n'
1783 '%s_proxy_g_properties_changed (GDBusProxy *_proxy,\n'
1784 ' GVariant *changed_properties,\n'
1785 ' const gchar *const *invalidated_properties)\n'
1786 '{\n'%(i.name_lower))
1787 # Note: info could be NULL if we are talking to a newer version of the interface
1788 self.outfile.write(' %sProxy *proxy = %s%s_PROXY (_proxy);\n'
1790 ' const gchar *key;\n'
1791 ' GVariantIter *iter;\n'
1792 ' _ExtendedGDBusPropertyInfo *info;\n'
1793 ' g_variant_get (changed_properties, "a{sv}", &iter);\n'
1794 ' while (g_variant_iter_next (iter, "{&sv}", &key, NULL))\n'
1796 ' info = (_ExtendedGDBusPropertyInfo *) g_dbus_interface_info_lookup_property ((GDBusInterfaceInfo *) &_%s_interface_info.parent_struct, key);\n'
1797 ' g_datalist_remove_data (&proxy->priv->qdata, key);\n'
1798 ' if (info != NULL)\n'
1799 ' g_object_notify (G_OBJECT (proxy), info->hyphen_name);\n'
1801 ' g_variant_iter_free (iter);\n'
1802 ' for (n = 0; invalidated_properties[n] != NULL; n++)\n'
1804 ' info = (_ExtendedGDBusPropertyInfo *) g_dbus_interface_info_lookup_property ((GDBusInterfaceInfo *) &_%s_interface_info.parent_struct, invalidated_properties[n]);\n'
1805 ' g_datalist_remove_data (&proxy->priv->qdata, invalidated_properties[n]);\n'
1806 ' if (info != NULL)\n'
1807 ' g_object_notify (G_OBJECT (proxy), info->hyphen_name);\n'
1811 %(i.camel_name, i.ns_upper, i.name_upper,
1812 i.name_lower, i.name_lower))
1815 for p in i.properties:
1817 if p.arg.free_func != None:
1819 self.outfile.write('static %s\n'
1820 '%s_proxy_get_%s (%s *object)\n'
1822 ' %sProxy *proxy = %s%s_PROXY (object);\n'
1823 ' GVariant *variant;\n'
1824 ' %svalue = %s;\n'%(p.arg.ctype_in, i.name_lower, p.name_lower, i.camel_name,
1825 i.camel_name, i.ns_upper, i.name_upper,
1826 p.arg.ctype_in, nul_value))
1827 # For some property types, we have to free the returned
1828 # value (or part of it, e.g. the container) because of how
1829 # GVariant works.. see https://bugzilla.gnome.org/show_bug.cgi?id=657100
1832 free_container = False;
1833 if p.arg.gvariant_get == 'g_variant_get_strv' or p.arg.gvariant_get == 'g_variant_get_objv' or p.arg.gvariant_get == 'g_variant_get_bytestring_array':
1834 free_container = True;
1835 # If already using an old value for strv, objv, bytestring_array (see below),
1836 # then just return that... that way the result from multiple consecutive calls
1837 # to the getter are valid as long as they're freed
1840 self.outfile.write(' value = g_datalist_get_data (&proxy->priv->qdata, \"%s\");\n'
1841 ' if (value != NULL)\n'
1844 self.outfile.write(' variant = g_dbus_proxy_get_cached_property (G_DBUS_PROXY (proxy), \"%s\");\n'%(p.name))
1845 if p.arg.gtype == 'G_TYPE_VARIANT':
1846 self.outfile.write(' value = variant;\n')
1847 self.outfile.write(' if (variant != NULL)\n')
1848 self.outfile.write(' g_variant_unref (variant);\n')
1850 self.outfile.write(' if (variant != NULL)\n'
1853 if p.arg.gvariant_get == 'g_variant_get_string' or p.arg.gvariant_get == 'g_variant_get_strv' or p.arg.gvariant_get == 'g_variant_get_objv' or p.arg.gvariant_get == 'g_variant_get_bytestring_array':
1854 extra_len = ', NULL'
1855 self.outfile.write(' value = %s (variant%s);\n'%(p.arg.gvariant_get, extra_len))
1857 self.outfile.write(' g_datalist_set_data_full (&proxy->priv->qdata, \"%s\", (gpointer) value, g_free);\n'
1859 self.outfile.write(' g_variant_unref (variant);\n')
1860 self.outfile.write(' }\n')
1861 self.outfile.write(' return value;\n')
1862 self.outfile.write('}\n')
1863 self.outfile.write('\n')
1866 self.outfile.write('static void\n'
1867 '%s_proxy_init (%sProxy *proxy)\n'
1869 '#if GLIB_VERSION_MAX_ALLOWED >= GLIB_VERSION_2_38\n'
1870 ' proxy->priv = %s_proxy_get_instance_private (proxy);\n'
1872 ' proxy->priv = G_TYPE_INSTANCE_GET_PRIVATE (proxy, %sTYPE_%s_PROXY, %sProxyPrivate);\n'
1874 ' g_dbus_proxy_set_interface_info (G_DBUS_PROXY (proxy), %s_interface_info ());\n'
1877 %(i.name_lower, i.camel_name,
1879 i.ns_upper, i.name_upper, i.camel_name,
1881 self.outfile.write('static void\n'
1882 '%s_proxy_class_init (%sProxyClass *klass)\n'
1884 ' GObjectClass *gobject_class;\n'
1885 ' GDBusProxyClass *proxy_class;\n'
1887 ' gobject_class = G_OBJECT_CLASS (klass);\n'
1888 ' gobject_class->finalize = %s_proxy_finalize;\n'
1889 ' gobject_class->get_property = %s_proxy_get_property;\n'
1890 ' gobject_class->set_property = %s_proxy_set_property;\n'
1892 ' proxy_class = G_DBUS_PROXY_CLASS (klass);\n'
1893 ' proxy_class->g_signal = %s_proxy_g_signal;\n'
1894 ' proxy_class->g_properties_changed = %s_proxy_g_properties_changed;\n'
1895 '\n'%(i.name_lower, i.camel_name,
1896 i.name_lower, i.name_lower, i.name_lower, i.name_lower, i.name_lower))
1897 if len(i.properties) > 0:
1898 self.outfile.write(' %s_override_properties (gobject_class, 1);\n\n'%(i.name_lower))
1899 self.outfile.write('#if GLIB_VERSION_MAX_ALLOWED < GLIB_VERSION_2_38\n'
1900 ' g_type_class_add_private (klass, sizeof (%sProxyPrivate));\n'
1901 '#endif\n'%(i.camel_name))
1902 self.outfile.write('}\n'
1905 self.outfile.write('static void\n'
1906 '%s_proxy_iface_init (%sIface *iface)\n'
1907 '{\n'%(i.name_lower, i.camel_name))
1908 for p in i.properties:
1909 self.outfile.write(' iface->get_%s = %s_proxy_get_%s;\n'%(p.name_lower, i.name_lower, p.name_lower))
1910 self.outfile.write('}\n'
1914 self.outfile.write(self.docbook_gen.expand(
1916 ' * %s_proxy_new:\n'
1917 ' * @connection: A #GDBusConnection.\n'
1918 ' * @flags: Flags from the #GDBusProxyFlags enumeration.\n'
1919 ' * @name: (nullable): A bus name (well-known or unique) or %%NULL if @connection is not a message bus connection.\n'
1920 ' * @object_path: An object path.\n'
1921 ' * @cancellable: (nullable): A #GCancellable or %%NULL.\n'
1922 ' * @callback: A #GAsyncReadyCallback to call when the request is satisfied.\n'
1923 ' * @user_data: User data to pass to @callback.\n'
1925 ' * Asynchronously creates a proxy for the D-Bus interface #%s. See g_dbus_proxy_new() for more details.\n'
1927 ' * 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'
1928 ' * You can then call %s_proxy_new_finish() to get the result of the operation.\n'
1930 ' * See %s_proxy_new_sync() for the synchronous, blocking version of this constructor.\n'
1931 %(i.name_lower, i.name, i.name_lower, i.name_lower), False))
1932 self.write_gtkdoc_deprecated_and_since_and_close(i, self.outfile, 0)
1933 self.outfile.write('void\n'
1935 ' GDBusConnection *connection,\n'
1936 ' GDBusProxyFlags flags,\n'
1937 ' const gchar *name,\n'
1938 ' const gchar *object_path,\n'
1939 ' GCancellable *cancellable,\n'
1940 ' GAsyncReadyCallback callback,\n'
1941 ' gpointer user_data)\n'
1943 ' 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'
1946 %(i.name_lower, i.ns_upper, i.name_upper, i.name))
1947 self.outfile.write('/**\n'
1948 ' * %s_proxy_new_finish:\n'
1949 ' * @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to %s_proxy_new().\n'
1950 ' * @error: Return location for error or %%NULL\n'
1952 ' * Finishes an operation started with %s_proxy_new().\n'
1954 ' * Returns: (transfer full) (type %sProxy): The constructed proxy object or %%NULL if @error is set.\n'
1955 %(i.name_lower, i.name_lower, i.name_lower, i.camel_name))
1956 self.write_gtkdoc_deprecated_and_since_and_close(i, self.outfile, 0)
1957 self.outfile.write('%s *\n'
1958 '%s_proxy_new_finish (\n'
1959 ' GAsyncResult *res,\n'
1960 ' GError **error)\n'
1963 ' GObject *source_object;\n'
1964 ' source_object = g_async_result_get_source_object (res);\n'
1965 ' ret = g_async_initable_new_finish (G_ASYNC_INITABLE (source_object), res, error);\n'
1966 ' g_object_unref (source_object);\n'
1967 ' if (ret != NULL)\n'
1968 ' return %s%s (ret);\n'
1973 %(i.camel_name, i.name_lower, i.ns_upper, i.name_upper))
1974 self.outfile.write(self.docbook_gen.expand(
1976 ' * %s_proxy_new_sync:\n'
1977 ' * @connection: A #GDBusConnection.\n'
1978 ' * @flags: Flags from the #GDBusProxyFlags enumeration.\n'
1979 ' * @name: (nullable): A bus name (well-known or unique) or %%NULL if @connection is not a message bus connection.\n'
1980 ' * @object_path: An object path.\n'
1981 ' * @cancellable: (nullable): A #GCancellable or %%NULL.\n'
1982 ' * @error: Return location for error or %%NULL\n'
1984 ' * Synchronously creates a proxy for the D-Bus interface #%s. See g_dbus_proxy_new_sync() for more details.\n'
1986 ' * The calling thread is blocked until a reply is received.\n'
1988 ' * See %s_proxy_new() for the asynchronous version of this constructor.\n'
1990 ' * Returns: (transfer full) (type %sProxy): The constructed proxy object or %%NULL if @error is set.\n'
1991 %(i.name_lower, i.name, i.name_lower, i.camel_name), False))
1992 self.write_gtkdoc_deprecated_and_since_and_close(i, self.outfile, 0)
1993 self.outfile.write('%s *\n'
1994 '%s_proxy_new_sync (\n'
1995 ' GDBusConnection *connection,\n'
1996 ' GDBusProxyFlags flags,\n'
1997 ' const gchar *name,\n'
1998 ' const gchar *object_path,\n'
1999 ' GCancellable *cancellable,\n'
2000 ' GError **error)\n'
2002 ' GInitable *ret;\n'
2003 ' 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'
2004 ' if (ret != NULL)\n'
2005 ' return %s%s (ret);\n'
2010 %(i.camel_name, i.name_lower, i.ns_upper, i.name_upper, i.name, i.ns_upper, i.name_upper))
2011 self.outfile.write('\n')
2012 self.outfile.write(self.docbook_gen.expand(
2014 ' * %s_proxy_new_for_bus:\n'
2015 ' * @bus_type: A #GBusType.\n'
2016 ' * @flags: Flags from the #GDBusProxyFlags enumeration.\n'
2017 ' * @name: A bus name (well-known or unique).\n'
2018 ' * @object_path: An object path.\n'
2019 ' * @cancellable: (nullable): A #GCancellable or %%NULL.\n'
2020 ' * @callback: A #GAsyncReadyCallback to call when the request is satisfied.\n'
2021 ' * @user_data: User data to pass to @callback.\n'
2023 ' * Like %s_proxy_new() but takes a #GBusType instead of a #GDBusConnection.\n'
2025 ' * 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'
2026 ' * You can then call %s_proxy_new_for_bus_finish() to get the result of the operation.\n'
2028 ' * See %s_proxy_new_for_bus_sync() for the synchronous, blocking version of this constructor.\n'
2029 %(i.name_lower, i.name_lower, i.name_lower, i.name_lower), False))
2030 self.write_gtkdoc_deprecated_and_since_and_close(i, self.outfile, 0)
2031 self.outfile.write('void\n'
2032 '%s_proxy_new_for_bus (\n'
2033 ' GBusType bus_type,\n'
2034 ' GDBusProxyFlags flags,\n'
2035 ' const gchar *name,\n'
2036 ' const gchar *object_path,\n'
2037 ' GCancellable *cancellable,\n'
2038 ' GAsyncReadyCallback callback,\n'
2039 ' gpointer user_data)\n'
2041 ' 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'
2044 %(i.name_lower, i.ns_upper, i.name_upper, i.name))
2045 self.outfile.write('/**\n'
2046 ' * %s_proxy_new_for_bus_finish:\n'
2047 ' * @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to %s_proxy_new_for_bus().\n'
2048 ' * @error: Return location for error or %%NULL\n'
2050 ' * Finishes an operation started with %s_proxy_new_for_bus().\n'
2052 ' * Returns: (transfer full) (type %sProxy): The constructed proxy object or %%NULL if @error is set.\n'
2053 %(i.name_lower, i.name_lower, i.name_lower, i.camel_name))
2054 self.write_gtkdoc_deprecated_and_since_and_close(i, self.outfile, 0)
2055 self.outfile.write('%s *\n'
2056 '%s_proxy_new_for_bus_finish (\n'
2057 ' GAsyncResult *res,\n'
2058 ' GError **error)\n'
2061 ' GObject *source_object;\n'
2062 ' source_object = g_async_result_get_source_object (res);\n'
2063 ' ret = g_async_initable_new_finish (G_ASYNC_INITABLE (source_object), res, error);\n'
2064 ' g_object_unref (source_object);\n'
2065 ' if (ret != NULL)\n'
2066 ' return %s%s (ret);\n'
2071 %(i.camel_name, i.name_lower, i.ns_upper, i.name_upper))
2072 self.outfile.write(self.docbook_gen.expand(
2074 ' * %s_proxy_new_for_bus_sync:\n'
2075 ' * @bus_type: A #GBusType.\n'
2076 ' * @flags: Flags from the #GDBusProxyFlags enumeration.\n'
2077 ' * @name: A bus name (well-known or unique).\n'
2078 ' * @object_path: An object path.\n'
2079 ' * @cancellable: (nullable): A #GCancellable or %%NULL.\n'
2080 ' * @error: Return location for error or %%NULL\n'
2082 ' * Like %s_proxy_new_sync() but takes a #GBusType instead of a #GDBusConnection.\n'
2084 ' * The calling thread is blocked until a reply is received.\n'
2086 ' * See %s_proxy_new_for_bus() for the asynchronous version of this constructor.\n'
2088 ' * Returns: (transfer full) (type %sProxy): The constructed proxy object or %%NULL if @error is set.\n'
2089 %(i.name_lower, i.name_lower, i.name_lower, i.camel_name), False))
2090 self.write_gtkdoc_deprecated_and_since_and_close(i, self.outfile, 0)
2091 self.outfile.write('%s *\n'
2092 '%s_proxy_new_for_bus_sync (\n'
2093 ' GBusType bus_type,\n'
2094 ' GDBusProxyFlags flags,\n'
2095 ' const gchar *name,\n'
2096 ' const gchar *object_path,\n'
2097 ' GCancellable *cancellable,\n'
2098 ' GError **error)\n'
2100 ' GInitable *ret;\n'
2101 ' 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'
2102 ' if (ret != NULL)\n'
2103 ' return %s%s (ret);\n'
2108 %(i.camel_name, i.name_lower, i.ns_upper, i.name_upper, i.name, i.ns_upper, i.name_upper))
2109 self.outfile.write('\n')
2111 # ---------------------------------------------------------------------------------------------------
2113 def generate_skeleton(self, i):
2115 self.outfile.write('/* ------------------------------------------------------------------------ */\n'
2118 self.outfile.write(self.docbook_gen.expand(
2122 ' * The #%sSkeleton structure contains only private data and should only be accessed using the provided API.\n'
2123 %(i.camel_name, i.camel_name), False))
2124 self.write_gtkdoc_deprecated_and_since_and_close(i, self.outfile, 0)
2125 self.outfile.write('\n')
2127 self.outfile.write(self.docbook_gen.expand(
2129 ' * %sSkeletonClass:\n'
2130 ' * @parent_class: The parent class.\n'
2132 ' * Class structure for #%sSkeleton.\n'
2133 %(i.camel_name, i.camel_name), False))
2134 self.write_gtkdoc_deprecated_and_since_and_close(i, self.outfile, 0)
2135 self.outfile.write('\n')
2137 self.outfile.write('struct _%sSkeletonPrivate\n'
2139 ' GValue *properties;\n'
2140 ' GList *changed_properties;\n'
2141 ' GSource *changed_properties_idle_source;\n'
2142 ' GMainContext *context;\n'
2147 self.outfile.write('static void\n'
2148 '_%s_skeleton_handle_method_call (\n'
2149 ' GDBusConnection *connection G_GNUC_UNUSED,\n'
2150 ' const gchar *sender G_GNUC_UNUSED,\n'
2151 ' const gchar *object_path G_GNUC_UNUSED,\n'
2152 ' const gchar *interface_name,\n'
2153 ' const gchar *method_name,\n'
2154 ' GVariant *parameters,\n'
2155 ' GDBusMethodInvocation *invocation,\n'
2156 ' gpointer user_data)\n'
2158 ' %sSkeleton *skeleton = %s%s_SKELETON (user_data);\n'
2159 ' _ExtendedGDBusMethodInfo *info;\n'
2160 ' GVariantIter iter;\n'
2161 ' GVariant *child;\n'
2162 ' GValue *paramv;\n'
2163 ' gsize num_params;\n'
2164 ' guint num_extra;\n'
2166 ' guint signal_id;\n'
2167 ' GValue return_value = G_VALUE_INIT;\n'
2168 %(i.name_lower, i.camel_name, i.ns_upper, i.name_upper))
2169 self.outfile.write(' info = (_ExtendedGDBusMethodInfo *) g_dbus_method_invocation_get_method_info (invocation);\n'
2170 ' g_assert (info != NULL);\n'
2172 self.outfile.write(' num_params = g_variant_n_children (parameters);\n'
2173 ' num_extra = info->pass_fdlist ? 3 : 2;'
2174 ' paramv = g_new0 (GValue, num_params + num_extra);\n'
2176 ' g_value_init (¶mv[n], %sTYPE_%s);\n'
2177 ' g_value_set_object (¶mv[n++], skeleton);\n'
2178 ' g_value_init (¶mv[n], G_TYPE_DBUS_METHOD_INVOCATION);\n'
2179 ' g_value_set_object (¶mv[n++], invocation);\n'
2180 ' if (info->pass_fdlist)\n'
2182 '#ifdef G_OS_UNIX\n'
2183 ' g_value_init (¶mv[n], G_TYPE_UNIX_FD_LIST);\n'
2184 ' g_value_set_object (¶mv[n++], g_dbus_message_get_unix_fd_list (g_dbus_method_invocation_get_message (invocation)));\n'
2186 ' g_assert_not_reached ();\n'
2189 %(i.ns_upper, i.name_upper))
2190 self.outfile.write(' g_variant_iter_init (&iter, parameters);\n'
2191 ' while ((child = g_variant_iter_next_value (&iter)) != NULL)\n'
2193 ' _ExtendedGDBusArgInfo *arg_info = (_ExtendedGDBusArgInfo *) info->parent_struct.in_args[n - num_extra];\n'
2194 ' if (arg_info->use_gvariant)\n'
2196 ' g_value_init (¶mv[n], G_TYPE_VARIANT);\n'
2197 ' g_value_set_variant (¶mv[n], child);\n'
2201 ' g_dbus_gvariant_to_gvalue (child, ¶mv[n++]);\n'
2202 ' g_variant_unref (child);\n'
2204 self.outfile.write(' signal_id = g_signal_lookup (info->signal_name, %sTYPE_%s);\n'
2205 %(i.ns_upper, i.name_upper))
2206 self.outfile.write(' g_value_init (&return_value, G_TYPE_BOOLEAN);\n'
2207 ' g_signal_emitv (paramv, signal_id, 0, &return_value);\n'
2208 ' if (!g_value_get_boolean (&return_value))\n'
2209 ' 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'
2210 ' g_value_unset (&return_value);\n')
2211 self.outfile.write(' for (n = 0; n < num_params + num_extra; n++)\n'
2212 ' g_value_unset (¶mv[n]);\n'
2213 ' g_free (paramv);\n')
2214 self.outfile.write('}\n'
2217 self.outfile.write('static GVariant *\n'
2218 '_%s_skeleton_handle_get_property (\n'
2219 ' GDBusConnection *connection G_GNUC_UNUSED,\n'
2220 ' const gchar *sender G_GNUC_UNUSED,\n'
2221 ' const gchar *object_path G_GNUC_UNUSED,\n'
2222 ' const gchar *interface_name G_GNUC_UNUSED,\n'
2223 ' const gchar *property_name,\n'
2224 ' GError **error,\n'
2225 ' gpointer user_data)\n'
2227 ' %sSkeleton *skeleton = %s%s_SKELETON (user_data);\n'
2228 ' GValue value = G_VALUE_INIT;\n'
2229 ' GParamSpec *pspec;\n'
2230 ' _ExtendedGDBusPropertyInfo *info;\n'
2232 %(i.name_lower, i.camel_name, i.ns_upper, i.name_upper))
2233 self.outfile.write(' ret = NULL;\n'
2234 ' info = (_ExtendedGDBusPropertyInfo *) g_dbus_interface_info_lookup_property ((GDBusInterfaceInfo *) &_%s_interface_info.parent_struct, property_name);\n'
2235 ' g_assert (info != NULL);\n'
2236 ' pspec = g_object_class_find_property (G_OBJECT_GET_CLASS (skeleton), info->hyphen_name);\n'
2237 ' if (pspec == NULL)\n'
2239 ' g_set_error (error, G_DBUS_ERROR, G_DBUS_ERROR_INVALID_ARGS, "No property with name %%s", property_name);\n'
2243 ' g_value_init (&value, pspec->value_type);\n'
2244 ' g_object_get_property (G_OBJECT (skeleton), info->hyphen_name, &value);\n'
2245 ' ret = g_dbus_gvalue_to_gvariant (&value, G_VARIANT_TYPE (info->parent_struct.signature));\n'
2246 ' g_value_unset (&value);\n'
2253 self.outfile.write('static gboolean\n'
2254 '_%s_skeleton_handle_set_property (\n'
2255 ' GDBusConnection *connection G_GNUC_UNUSED,\n'
2256 ' const gchar *sender G_GNUC_UNUSED,\n'
2257 ' const gchar *object_path G_GNUC_UNUSED,\n'
2258 ' const gchar *interface_name G_GNUC_UNUSED,\n'
2259 ' const gchar *property_name,\n'
2260 ' GVariant *variant,\n'
2261 ' GError **error,\n'
2262 ' gpointer user_data)\n'
2264 ' %sSkeleton *skeleton = %s%s_SKELETON (user_data);\n'
2265 ' GValue value = G_VALUE_INIT;\n'
2266 ' GParamSpec *pspec;\n'
2267 ' _ExtendedGDBusPropertyInfo *info;\n'
2269 %(i.name_lower, i.camel_name, i.ns_upper, i.name_upper))
2270 self.outfile.write(' ret = FALSE;\n'
2271 ' info = (_ExtendedGDBusPropertyInfo *) g_dbus_interface_info_lookup_property ((GDBusInterfaceInfo *) &_%s_interface_info.parent_struct, property_name);\n'
2272 ' g_assert (info != NULL);\n'
2273 ' pspec = g_object_class_find_property (G_OBJECT_GET_CLASS (skeleton), info->hyphen_name);\n'
2274 ' if (pspec == NULL)\n'
2276 ' g_set_error (error, G_DBUS_ERROR, G_DBUS_ERROR_INVALID_ARGS, "No property with name %%s", property_name);\n'
2280 ' if (info->use_gvariant)\n'
2281 ' g_value_set_variant (&value, variant);\n'
2283 ' g_dbus_gvariant_to_gvalue (variant, &value);\n'
2284 ' g_object_set_property (G_OBJECT (skeleton), info->hyphen_name, &value);\n'
2285 ' g_value_unset (&value);\n'
2294 self.outfile.write('static const GDBusInterfaceVTable _%s_skeleton_vtable =\n'
2296 ' _%s_skeleton_handle_method_call,\n'
2297 ' _%s_skeleton_handle_get_property,\n'
2298 ' _%s_skeleton_handle_set_property,\n'
2301 '\n'%(i.name_lower, i.name_lower, i.name_lower, i.name_lower))
2303 self.outfile.write('static GDBusInterfaceInfo *\n'
2304 '%s_skeleton_dbus_interface_get_info (GDBusInterfaceSkeleton *skeleton G_GNUC_UNUSED)\n'
2306 ' return %s_interface_info ();\n'
2307 %(i.name_lower, i.name_lower))
2308 self.outfile.write('}\n'
2311 self.outfile.write('static GDBusInterfaceVTable *\n'
2312 '%s_skeleton_dbus_interface_get_vtable (GDBusInterfaceSkeleton *skeleton G_GNUC_UNUSED)\n'
2314 ' return (GDBusInterfaceVTable *) &_%s_skeleton_vtable;\n'
2315 %(i.name_lower, i.name_lower))
2316 self.outfile.write('}\n'
2319 self.outfile.write('static GVariant *\n'
2320 '%s_skeleton_dbus_interface_get_properties (GDBusInterfaceSkeleton *_skeleton)\n'
2322 ' %sSkeleton *skeleton = %s%s_SKELETON (_skeleton);\n'
2323 %(i.name_lower, i.camel_name, i.ns_upper, i.name_upper))
2324 self.outfile.write('\n'
2325 ' GVariantBuilder builder;\n'
2327 ' g_variant_builder_init (&builder, G_VARIANT_TYPE ("a{sv}"));\n'
2328 ' if (_%s_interface_info.parent_struct.properties == NULL)\n'
2330 ' for (n = 0; _%s_interface_info.parent_struct.properties[n] != NULL; n++)\n'
2332 ' GDBusPropertyInfo *info = _%s_interface_info.parent_struct.properties[n];\n'
2333 ' if (info->flags & G_DBUS_PROPERTY_INFO_FLAGS_READABLE)\n'
2335 ' GVariant *value;\n'
2336 ' 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'
2337 ' if (value != NULL)\n'
2339 ' g_variant_take_ref (value);\n'
2340 ' g_variant_builder_add (&builder, "{sv}", info->name, value);\n'
2341 ' g_variant_unref (value);\n'
2346 ' return g_variant_builder_end (&builder);\n'
2349 %(i.name_lower, i.name_lower, i.name_lower, i.name_lower, i.name))
2351 if len(i.properties) > 0:
2352 self.outfile.write('static gboolean _%s_emit_changed (gpointer user_data);\n'
2356 self.outfile.write('static void\n'
2357 '%s_skeleton_dbus_interface_flush (GDBusInterfaceSkeleton *_skeleton)\n'
2360 if len(i.properties) > 0:
2361 self.outfile.write(' %sSkeleton *skeleton = %s%s_SKELETON (_skeleton);\n'
2362 ' gboolean emit_changed = FALSE;\n'
2364 ' g_mutex_lock (&skeleton->priv->lock);\n'
2365 ' if (skeleton->priv->changed_properties_idle_source != NULL)\n'
2367 ' g_source_destroy (skeleton->priv->changed_properties_idle_source);\n'
2368 ' skeleton->priv->changed_properties_idle_source = NULL;\n'
2369 ' emit_changed = TRUE;\n'
2371 ' g_mutex_unlock (&skeleton->priv->lock);\n'
2373 ' if (emit_changed)\n'
2374 ' _%s_emit_changed (skeleton);\n'
2375 %(i.camel_name, i.ns_upper, i.name_upper, i.name_lower))
2376 self.outfile.write('}\n'
2380 self.outfile.write('static void\n'
2381 '_%s_on_signal_%s (\n'
2382 ' %s *object'%(i.name_lower, s.name_lower, i.camel_name))
2384 self.outfile.write(',\n %sarg_%s'%(a.ctype_in, a.name))
2385 self.outfile.write(')\n'
2387 ' %sSkeleton *skeleton = %s%s_SKELETON (object);\n\n'
2388 ' GList *connections, *l;\n'
2389 ' GVariant *signal_variant;\n'
2390 ' connections = g_dbus_interface_skeleton_get_connections (G_DBUS_INTERFACE_SKELETON (skeleton));\n'
2391 %(i.camel_name, i.ns_upper, i.name_upper))
2392 self.outfile.write('\n'
2393 ' signal_variant = g_variant_ref_sink (g_variant_new ("(')
2395 self.outfile.write('%s'%(a.format_in))
2396 self.outfile.write(')"')
2398 self.outfile.write(',\n arg_%s'%(a.name))
2399 self.outfile.write('));\n')
2401 self.outfile.write(' for (l = connections; l != NULL; l = l->next)\n'
2403 ' GDBusConnection *connection = l->data;\n'
2404 ' g_dbus_connection_emit_signal (connection,\n'
2405 ' NULL, g_dbus_interface_skeleton_get_object_path (G_DBUS_INTERFACE_SKELETON (skeleton)), "%s", "%s",\n'
2406 ' signal_variant, NULL);\n'
2409 self.outfile.write(' g_variant_unref (signal_variant);\n')
2410 self.outfile.write(' g_list_free_full (connections, g_object_unref);\n')
2411 self.outfile.write('}\n'
2414 self.outfile.write('static void %s_skeleton_iface_init (%sIface *iface);\n'
2415 %(i.name_lower, i.camel_name))
2417 self.outfile.write('#if GLIB_VERSION_MAX_ALLOWED >= GLIB_VERSION_2_38\n')
2418 self.outfile.write('G_DEFINE_TYPE_WITH_CODE (%sSkeleton, %s_skeleton, G_TYPE_DBUS_INTERFACE_SKELETON,\n'%(i.camel_name, i.name_lower))
2419 self.outfile.write(' G_ADD_PRIVATE (%sSkeleton)\n'%(i.camel_name))
2420 self.outfile.write(' G_IMPLEMENT_INTERFACE (%sTYPE_%s, %s_skeleton_iface_init))\n\n'%(i.ns_upper, i.name_upper, i.name_lower))
2421 self.outfile.write('#else\n')
2422 self.outfile.write('G_DEFINE_TYPE_WITH_CODE (%sSkeleton, %s_skeleton, G_TYPE_DBUS_INTERFACE_SKELETON,\n'%(i.camel_name, i.name_lower))
2423 self.outfile.write(' G_IMPLEMENT_INTERFACE (%sTYPE_%s, %s_skeleton_iface_init))\n\n'%(i.ns_upper, i.name_upper, i.name_lower))
2424 self.outfile.write('#endif\n')
2427 self.outfile.write('static void\n'
2428 '%s_skeleton_finalize (GObject *object)\n'
2429 '{\n'%(i.name_lower))
2430 self.outfile.write(' %sSkeleton *skeleton = %s%s_SKELETON (object);\n'%(i.camel_name, i.ns_upper, i.name_upper))
2431 if len(i.properties) > 0:
2432 self.outfile.write(' guint n;\n'
2433 ' for (n = 0; n < %d; n++)\n'
2434 ' g_value_unset (&skeleton->priv->properties[n]);\n'%(len(i.properties)))
2435 self.outfile.write(' g_free (skeleton->priv->properties);\n')
2436 self.outfile.write(' g_list_free_full (skeleton->priv->changed_properties, (GDestroyNotify) _changed_property_free);\n')
2437 self.outfile.write(' if (skeleton->priv->changed_properties_idle_source != NULL)\n')
2438 self.outfile.write(' g_source_destroy (skeleton->priv->changed_properties_idle_source);\n')
2439 self.outfile.write(' g_main_context_unref (skeleton->priv->context);\n')
2440 self.outfile.write(' g_mutex_clear (&skeleton->priv->lock);\n')
2441 self.outfile.write(' G_OBJECT_CLASS (%s_skeleton_parent_class)->finalize (object);\n'
2443 '\n'%(i.name_lower))
2445 # property accessors (TODO: generate PropertiesChanged signals in setter)
2446 if len(i.properties) > 0:
2447 self.outfile.write('static void\n'
2448 '%s_skeleton_get_property (GObject *object,\n'
2451 ' GParamSpec *pspec G_GNUC_UNUSED)\n'
2452 '{\n'%(i.name_lower))
2453 self.outfile.write(' %sSkeleton *skeleton = %s%s_SKELETON (object);\n'
2454 ' g_assert (prop_id != 0 && prop_id - 1 < %d);\n'
2455 ' g_mutex_lock (&skeleton->priv->lock);\n'
2456 ' g_value_copy (&skeleton->priv->properties[prop_id - 1], value);\n'
2457 ' g_mutex_unlock (&skeleton->priv->lock);\n'
2458 %(i.camel_name, i.ns_upper, i.name_upper, len(i.properties)))
2459 self.outfile.write('}\n'
2462 # if property is already scheduled then re-use entry.. though it could be
2465 # foo_set_prop_bar (object, "");
2466 # foo_set_prop_bar (object, "blah");
2468 # say, every update... In this case, where nothing happens, we obviously
2469 # don't want a PropertiesChanged() event. We can easily check for this
2470 # by comparing against the _original value_ recorded before the first
2471 # change event. If the latest value is not different from the original
2472 # one, we can simply ignore the ChangedProperty
2474 self.outfile.write('static gboolean\n'
2475 '_%s_emit_changed (gpointer user_data)\n'
2477 ' %sSkeleton *skeleton = %s%s_SKELETON (user_data);\n'
2478 %(i.name_lower, i.camel_name, i.ns_upper, i.name_upper))
2479 self.outfile.write(' GList *l;\n'
2480 ' GVariantBuilder builder;\n'
2481 ' GVariantBuilder invalidated_builder;\n'
2482 ' guint num_changes;\n'
2484 ' g_mutex_lock (&skeleton->priv->lock);\n'
2485 ' g_variant_builder_init (&builder, G_VARIANT_TYPE ("a{sv}"));\n'
2486 ' g_variant_builder_init (&invalidated_builder, G_VARIANT_TYPE ("as"));\n'
2487 ' for (l = skeleton->priv->changed_properties, num_changes = 0; l != NULL; l = l->next)\n'
2489 ' ChangedProperty *cp = l->data;\n'
2490 ' GVariant *variant;\n'
2491 ' const GValue *cur_value;\n'
2493 ' cur_value = &skeleton->priv->properties[cp->prop_id - 1];\n'
2494 ' if (!_g_value_equal (cur_value, &cp->orig_value))\n'
2496 ' variant = g_dbus_gvalue_to_gvariant (cur_value, G_VARIANT_TYPE (cp->info->parent_struct.signature));\n'
2497 ' g_variant_builder_add (&builder, "{sv}", cp->info->parent_struct.name, variant);\n'
2498 ' g_variant_unref (variant);\n'
2502 ' if (num_changes > 0)\n'
2504 ' GList *connections, *ll;\n'
2505 ' GVariant *signal_variant;'
2507 ' signal_variant = g_variant_ref_sink (g_variant_new ("(sa{sv}as)", "%s",\n'
2508 ' &builder, &invalidated_builder));\n'
2509 ' connections = g_dbus_interface_skeleton_get_connections (G_DBUS_INTERFACE_SKELETON (skeleton));\n'
2510 ' for (ll = connections; ll != NULL; ll = ll->next)\n'
2512 ' GDBusConnection *connection = ll->data;\n'
2514 ' g_dbus_connection_emit_signal (connection,\n'
2515 ' NULL, g_dbus_interface_skeleton_get_object_path (G_DBUS_INTERFACE_SKELETON (skeleton)),\n'
2516 ' "org.freedesktop.DBus.Properties",\n'
2517 ' "PropertiesChanged",\n'
2518 ' signal_variant,\n'
2521 ' g_variant_unref (signal_variant);\n'
2522 ' g_list_free_full (connections, g_object_unref);\n'
2526 ' g_variant_builder_clear (&builder);\n'
2527 ' g_variant_builder_clear (&invalidated_builder);\n'
2530 self.outfile.write(' g_list_free_full (skeleton->priv->changed_properties, (GDestroyNotify) _changed_property_free);\n')
2531 self.outfile.write(' skeleton->priv->changed_properties = NULL;\n')
2532 self.outfile.write(' skeleton->priv->changed_properties_idle_source = NULL;\n')
2533 self.outfile.write(' g_mutex_unlock (&skeleton->priv->lock);\n')
2534 self.outfile.write(' return FALSE;\n'
2537 # holding lock while being called
2538 self.outfile.write('static void\n'
2539 '_%s_schedule_emit_changed (%sSkeleton *skeleton, const _ExtendedGDBusPropertyInfo *info, guint prop_id, const GValue *orig_value)\n'
2541 ' ChangedProperty *cp;\n'
2544 ' for (l = skeleton->priv->changed_properties; l != NULL; l = l->next)\n'
2546 ' ChangedProperty *i_cp = l->data;\n'
2547 ' if (i_cp->info == info)\n'
2553 %(i.name_lower, i.camel_name))
2554 self.outfile.write(' if (cp == NULL)\n'
2556 ' cp = g_new0 (ChangedProperty, 1);\n'
2557 ' cp->prop_id = prop_id;\n'
2558 ' cp->info = info;\n'
2559 ' skeleton->priv->changed_properties = g_list_prepend (skeleton->priv->changed_properties, cp);\n'
2560 ' g_value_init (&cp->orig_value, G_VALUE_TYPE (orig_value));\n'
2561 ' g_value_copy (orig_value, &cp->orig_value);\n'
2567 # Postpone setting up the refresh source until the ::notify signal is emitted as
2568 # this allows use of g_object_freeze_notify()/g_object_thaw_notify() ...
2569 # This is useful when updating several properties from another thread than
2570 # where the idle will be emitted from
2571 self.outfile.write('static void\n'
2572 '%s_skeleton_notify (GObject *object,\n'
2573 ' GParamSpec *pspec G_GNUC_UNUSED)\n'
2575 ' %sSkeleton *skeleton = %s%s_SKELETON (object);\n'
2576 ' g_mutex_lock (&skeleton->priv->lock);\n'
2577 ' if (skeleton->priv->changed_properties != NULL &&\n'
2578 ' skeleton->priv->changed_properties_idle_source == NULL)\n'
2580 ' skeleton->priv->changed_properties_idle_source = g_idle_source_new ();\n'
2581 ' g_source_set_priority (skeleton->priv->changed_properties_idle_source, G_PRIORITY_DEFAULT);\n'
2582 ' g_source_set_callback (skeleton->priv->changed_properties_idle_source, _%s_emit_changed, g_object_ref (skeleton), (GDestroyNotify) g_object_unref);\n'
2583 ' g_source_set_name (skeleton->priv->changed_properties_idle_source, "[generated] _%s_emit_changed");\n'
2584 ' g_source_attach (skeleton->priv->changed_properties_idle_source, skeleton->priv->context);\n'
2585 ' g_source_unref (skeleton->priv->changed_properties_idle_source);\n'
2587 ' g_mutex_unlock (&skeleton->priv->lock);\n'
2590 %(i.name_lower, i.camel_name, i.ns_upper, i.name_upper, i.name_lower, i.name_lower))
2592 self.outfile.write('static void\n'
2593 '%s_skeleton_set_property (GObject *object,\n'
2595 ' const GValue *value,\n'
2596 ' GParamSpec *pspec)\n'
2597 '{\n'%(i.name_lower))
2598 self.outfile.write(' %sSkeleton *skeleton = %s%s_SKELETON (object);\n'
2599 ' g_assert (prop_id != 0 && prop_id - 1 < %d);\n'
2600 ' g_mutex_lock (&skeleton->priv->lock);\n'
2601 ' g_object_freeze_notify (object);\n'
2602 ' if (!_g_value_equal (value, &skeleton->priv->properties[prop_id - 1]))\n'
2604 ' if (g_dbus_interface_skeleton_get_connection (G_DBUS_INTERFACE_SKELETON (skeleton)) != NULL)\n'
2605 ' _%s_schedule_emit_changed (skeleton, _%s_property_info_pointers[prop_id - 1], prop_id, &skeleton->priv->properties[prop_id - 1]);\n'
2606 ' g_value_copy (value, &skeleton->priv->properties[prop_id - 1]);\n'
2607 ' g_object_notify_by_pspec (object, pspec);\n'
2609 ' g_mutex_unlock (&skeleton->priv->lock);\n'
2610 ' g_object_thaw_notify (object);\n'
2611 %(i.camel_name, i.ns_upper, i.name_upper, len(i.properties), i.name_lower, i.name_lower))
2612 self.outfile.write('}\n'
2615 self.outfile.write('static void\n'
2616 '%s_skeleton_init (%sSkeleton *skeleton)\n'
2618 '#if GLIB_VERSION_MAX_ALLOWED >= GLIB_VERSION_2_38\n'
2619 ' skeleton->priv = %s_skeleton_get_instance_private (skeleton);\n'
2621 ' skeleton->priv = G_TYPE_INSTANCE_GET_PRIVATE (skeleton, %sTYPE_%s_SKELETON, %sSkeletonPrivate);\n'
2623 %(i.name_lower, i.camel_name,
2625 i.ns_upper, i.name_upper, i.camel_name))
2626 self.outfile.write(' g_mutex_init (&skeleton->priv->lock);\n')
2627 self.outfile.write(' skeleton->priv->context = g_main_context_ref_thread_default ();\n')
2628 if len(i.properties) > 0:
2629 self.outfile.write(' skeleton->priv->properties = g_new0 (GValue, %d);\n'%(len(i.properties)))
2631 for p in i.properties:
2632 self.outfile.write(' g_value_init (&skeleton->priv->properties[%d], %s);\n'%(n, p.arg.gtype))
2634 self.outfile.write('}\n'
2639 for p in i.properties:
2640 self.outfile.write('static %s\n'
2641 '%s_skeleton_get_%s (%s *object)\n'
2643 %(p.arg.ctype_in, i.name_lower, p.name_lower, i.camel_name))
2644 self.outfile.write(' %sSkeleton *skeleton = %s%s_SKELETON (object);\n'%(i.camel_name, i.ns_upper, i.name_upper))
2645 self.outfile.write(' %svalue;\n'
2646 ' g_mutex_lock (&skeleton->priv->lock);\n'
2647 ' value = %s (&(skeleton->priv->properties[%d]));\n'
2648 ' g_mutex_unlock (&skeleton->priv->lock);\n'
2649 %(p.arg.ctype_in_g, p.arg.gvalue_get, n))
2650 self.outfile.write(' return value;\n')
2651 self.outfile.write('}\n')
2652 self.outfile.write('\n')
2655 self.outfile.write('static void\n'
2656 '%s_skeleton_class_init (%sSkeletonClass *klass)\n'
2658 ' GObjectClass *gobject_class;\n'
2659 ' GDBusInterfaceSkeletonClass *skeleton_class;\n'
2661 ' gobject_class = G_OBJECT_CLASS (klass);\n'
2662 ' gobject_class->finalize = %s_skeleton_finalize;\n'
2663 %(i.name_lower, i.camel_name, i.name_lower))
2664 if len(i.properties) > 0:
2665 self.outfile.write(' gobject_class->get_property = %s_skeleton_get_property;\n'
2666 ' gobject_class->set_property = %s_skeleton_set_property;\n'
2667 ' gobject_class->notify = %s_skeleton_notify;\n'
2668 '\n'%(i.name_lower, i.name_lower, i.name_lower))
2669 self.outfile.write('\n'
2670 ' %s_override_properties (gobject_class, 1);\n'%(i.name_lower))
2671 self.outfile.write('\n'
2672 ' skeleton_class = G_DBUS_INTERFACE_SKELETON_CLASS (klass);\n');
2673 self.outfile.write(' skeleton_class->get_info = %s_skeleton_dbus_interface_get_info;\n'%(i.name_lower))
2674 self.outfile.write(' skeleton_class->get_properties = %s_skeleton_dbus_interface_get_properties;\n'%(i.name_lower))
2675 self.outfile.write(' skeleton_class->flush = %s_skeleton_dbus_interface_flush;\n'%(i.name_lower))
2676 self.outfile.write(' skeleton_class->get_vtable = %s_skeleton_dbus_interface_get_vtable;\n'%(i.name_lower))
2678 self.outfile.write('\n'
2679 '#if GLIB_VERSION_MAX_ALLOWED < GLIB_VERSION_2_38\n'
2680 ' g_type_class_add_private (klass, sizeof (%sSkeletonPrivate));\n'
2681 '#endif\n'%(i.camel_name))
2683 self.outfile.write('}\n'
2686 self.outfile.write('static void\n'
2687 '%s_skeleton_iface_init (%sIface *iface)\n'
2689 %(i.name_lower, i.camel_name))
2691 self.outfile.write(' iface->%s = _%s_on_signal_%s;\n'
2692 %(s.name_lower, i.name_lower, s.name_lower))
2693 for p in i.properties:
2694 self.outfile.write(' iface->get_%s = %s_skeleton_get_%s;\n'%(p.name_lower, i.name_lower, p.name_lower))
2695 self.outfile.write('}\n'
2699 self.outfile.write(self.docbook_gen.expand(
2701 ' * %s_skeleton_new:\n'
2703 ' * Creates a skeleton object for the D-Bus interface #%s.\n'
2705 ' * Returns: (transfer full) (type %sSkeleton): The skeleton object.\n'
2706 %(i.name_lower, i.name, i.camel_name), False))
2707 self.write_gtkdoc_deprecated_and_since_and_close(i, self.outfile, 0)
2708 self.outfile.write('%s *\n'
2709 '%s_skeleton_new (void)\n'
2711 ' return %s%s (g_object_new (%sTYPE_%s_SKELETON, NULL));\n'
2713 '\n'%(i.camel_name, i.name_lower, i.ns_upper, i.name_upper, i.ns_upper, i.name_upper))
2715 # ---------------------------------------------------------------------------------------------------
2717 def generate_object(self):
2718 self.outfile.write('/* ------------------------------------------------------------------------\n'
2719 ' * Code for Object, ObjectProxy and ObjectSkeleton\n'
2720 ' * ------------------------------------------------------------------------\n'
2724 self.outfile.write(self.docbook_gen.expand(
2726 ' * SECTION:%sObject\n'
2727 ' * @title: %sObject\n'
2728 ' * @short_description: Specialized GDBusObject types\n'
2730 ' * 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'
2732 %(self.namespace, self.namespace, self.namespace, self.namespace, self.namespace), False))
2733 self.outfile.write('\n')
2735 self.outfile.write(self.docbook_gen.expand(
2739 ' * The #%sObject type is a specialized container of interfaces.\n'
2741 %(self.namespace, self.namespace), False))
2742 self.outfile.write('\n')
2744 self.outfile.write(self.docbook_gen.expand(
2746 ' * %sObjectIface:\n'
2747 ' * @parent_iface: The parent interface.\n'
2749 ' * Virtual table for the #%sObject interface.\n'
2751 %(self.namespace, self.namespace), False))
2752 self.outfile.write('\n')
2754 self.outfile.write('typedef %sObjectIface %sObjectInterface;\n'%(self.namespace, self.namespace))
2755 self.outfile.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))
2756 self.outfile.write('\n')
2757 self.outfile.write('static void\n'
2758 '%sobject_default_init (%sObjectIface *iface)\n'
2760 %(self.ns_lower, self.namespace));
2761 for i in self.ifaces:
2762 self.outfile.write(self.docbook_gen.expand(
2766 ' * The #%s instance corresponding to the D-Bus interface #%s, if any.\n'
2768 ' * Connect to the #GObject::notify signal to get informed of property changes.\n'
2769 %(self.namespace, i.name_hyphen, i.camel_name, i.name), False))
2770 self.write_gtkdoc_deprecated_and_since_and_close(i, self.outfile, 2)
2771 self.outfile.write(' g_object_interface_install_property (iface, g_param_spec_object ("%s", "%s", "%s", %sTYPE_%s, G_PARAM_READWRITE|G_PARAM_STATIC_STRINGS));\n'
2773 %(i.name_hyphen, i.name_hyphen, i.name_hyphen, self.ns_upper, i.name_upper))
2774 self.outfile.write('}\n'
2777 for i in self.ifaces:
2778 self.outfile.write(self.docbook_gen.expand(
2780 ' * %sobject_get_%s:\n'
2781 ' * @object: A #%sObject.\n'
2783 ' * Gets the #%s instance for the D-Bus interface #%s on @object, if any.\n'
2785 ' * Returns: (transfer full): A #%s that must be freed with g_object_unref() or %%NULL if @object does not implement the interface.\n'
2786 %(self.ns_lower, i.name_upper.lower(), self.namespace, i.camel_name, i.name, i.camel_name), False))
2787 self.write_gtkdoc_deprecated_and_since_and_close(i, self.outfile, 0)
2788 self.outfile.write('%s *%sobject_get_%s (%sObject *object)\n'
2789 %(i.camel_name, self.ns_lower, i.name_upper.lower(), self.namespace))
2790 self.outfile.write('{\n'
2791 ' GDBusInterface *ret;\n'
2792 ' ret = g_dbus_object_get_interface (G_DBUS_OBJECT (object), "%s");\n'
2793 ' if (ret == NULL)\n'
2795 ' return %s%s (ret);\n'
2798 %(i.name, self.ns_upper, i.name_upper))
2799 self.outfile.write('\n')
2800 for i in self.ifaces:
2801 self.outfile.write(self.docbook_gen.expand(
2803 ' * %sobject_peek_%s: (skip)\n'
2804 ' * @object: A #%sObject.\n'
2806 ' * Like %sobject_get_%s() but doesn\'t increase the reference count on the returned object.\n'
2808 ' * <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'
2810 ' * 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'
2811 %(self.ns_lower, i.name_upper.lower(), self.namespace, self.ns_lower, i.name_upper.lower(), i.camel_name), False))
2812 self.write_gtkdoc_deprecated_and_since_and_close(i, self.outfile, 0)
2813 self.outfile.write('%s *%sobject_peek_%s (%sObject *object)\n'
2814 %(i.camel_name, self.ns_lower, i.name_upper.lower(), self.namespace))
2815 self.outfile.write('{\n'
2816 ' GDBusInterface *ret;\n'
2817 ' ret = g_dbus_object_get_interface (G_DBUS_OBJECT (object), "%s");\n'
2818 ' if (ret == NULL)\n'
2820 ' g_object_unref (ret);\n'
2821 ' return %s%s (ret);\n'
2824 %(i.name, self.ns_upper, i.name_upper))
2825 self.outfile.write('\n')
2826 # shared by ObjectProxy and ObjectSkeleton classes
2827 self.outfile.write('static void\n'
2828 '%sobject_notify (GDBusObject *object, GDBusInterface *interface)\n'
2830 ' _ExtendedGDBusInterfaceInfo *info = (_ExtendedGDBusInterfaceInfo *) g_dbus_interface_get_info (interface);\n'
2831 ' /* info can be NULL if the other end is using a D-Bus interface we don\'t know\n'
2832 ' * anything about, for example old generated code in this process talking to\n'
2833 ' * newer generated code in the other process. */\n'
2834 ' if (info != NULL)\n'
2835 ' g_object_notify (G_OBJECT (object), info->hyphen_name);\n'
2840 self.outfile.write(self.docbook_gen.expand(
2842 ' * %sObjectProxy:\n'
2844 ' * The #%sObjectProxy structure contains only private data and should only be accessed using the provided API.\n'
2845 %(self.namespace, self.namespace), False))
2846 self.outfile.write(' */\n')
2847 self.outfile.write('\n')
2848 self.outfile.write(self.docbook_gen.expand(
2850 ' * %sObjectProxyClass:\n'
2851 ' * @parent_class: The parent class.\n'
2853 ' * Class structure for #%sObjectProxy.\n'
2854 %(self.namespace, self.namespace), False))
2855 self.outfile.write(' */\n')
2856 self.outfile.write('\n')
2858 self.outfile.write('static void\n'
2859 '%sobject_proxy__%sobject_iface_init (%sObjectIface *iface G_GNUC_UNUSED)\n'
2863 %(self.ns_lower, self.ns_lower, self.namespace))
2864 self.outfile.write('static void\n'
2865 '%sobject_proxy__g_dbus_object_iface_init (GDBusObjectIface *iface)\n'
2867 ' iface->interface_added = %sobject_notify;\n'
2868 ' iface->interface_removed = %sobject_notify;\n'
2871 %(self.ns_lower, self.ns_lower, self.ns_lower))
2872 self.outfile.write('\n')
2873 self.outfile.write('G_DEFINE_TYPE_WITH_CODE (%sObjectProxy, %sobject_proxy, G_TYPE_DBUS_OBJECT_PROXY,\n'
2874 ' G_IMPLEMENT_INTERFACE (%sTYPE_OBJECT, %sobject_proxy__%sobject_iface_init)\n'
2875 ' G_IMPLEMENT_INTERFACE (G_TYPE_DBUS_OBJECT, %sobject_proxy__g_dbus_object_iface_init))\n'
2877 %(self.namespace, self.ns_lower, self.ns_upper, self.ns_lower, self.ns_lower, self.ns_lower))
2879 self.outfile.write('static void\n'
2880 '%sobject_proxy_init (%sObjectProxy *object G_GNUC_UNUSED)\n'
2883 '\n'%(self.ns_lower, self.namespace))
2884 self.outfile.write('static void\n'
2885 '%sobject_proxy_set_property (GObject *gobject,\n'
2887 ' const GValue *value G_GNUC_UNUSED,\n'
2888 ' GParamSpec *pspec)\n'
2890 ' G_OBJECT_WARN_INVALID_PROPERTY_ID (gobject, prop_id, pspec);\n'
2892 self.outfile.write('}\n'
2894 self.outfile.write('static void\n'
2895 '%sobject_proxy_get_property (GObject *gobject,\n'
2898 ' GParamSpec *pspec)\n'
2900 ' %sObjectProxy *object = %sOBJECT_PROXY (gobject);\n'
2901 ' GDBusInterface *interface;\n'
2903 ' switch (prop_id)\n'
2905 %(self.ns_lower, self.namespace, self.ns_upper))
2907 for i in self.ifaces:
2908 self.outfile.write(' case %d:\n'
2909 ' interface = g_dbus_object_get_interface (G_DBUS_OBJECT (object), "%s");\n'
2910 ' g_value_take_object (value, interface);\n'
2915 self.outfile.write(' default:\n'
2916 ' G_OBJECT_WARN_INVALID_PROPERTY_ID (gobject, prop_id, pspec);\n'
2921 self.outfile.write('static void\n'
2922 '%sobject_proxy_class_init (%sObjectProxyClass *klass)\n'
2924 ' GObjectClass *gobject_class = G_OBJECT_CLASS (klass);\n'
2926 ' gobject_class->set_property = %sobject_proxy_set_property;\n'
2927 ' gobject_class->get_property = %sobject_proxy_get_property;\n'
2929 %(self.ns_lower, self.namespace, self.ns_lower, self.ns_lower))
2931 for i in self.ifaces:
2932 self.outfile.write(' g_object_class_override_property (gobject_class, %d, "%s");'
2934 %(n, i.name_hyphen))
2936 self.outfile.write('}\n'
2939 self.outfile.write(self.docbook_gen.expand(
2941 ' * %sobject_proxy_new:\n'
2942 ' * @connection: A #GDBusConnection.\n'
2943 ' * @object_path: An object path.\n'
2945 ' * Creates a new proxy object.\n'
2947 ' * Returns: (transfer full): The proxy object.\n'
2949 %(self.ns_lower), False))
2950 self.outfile.write('%sObjectProxy *\n'
2951 '%sobject_proxy_new (GDBusConnection *connection,\n'
2952 ' const gchar *object_path)\n'
2954 ' g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), NULL);\n'
2955 ' g_return_val_if_fail (g_variant_is_object_path (object_path), NULL);\n'
2956 ' return %sOBJECT_PROXY (g_object_new (%sTYPE_OBJECT_PROXY, "g-connection", connection, "g-object-path", object_path, NULL));\n'
2958 '\n'%(self.namespace, self.ns_lower, self.ns_upper, self.ns_upper))
2960 self.outfile.write(self.docbook_gen.expand(
2962 ' * %sObjectSkeleton:\n'
2964 ' * The #%sObjectSkeleton structure contains only private data and should only be accessed using the provided API.\n'
2965 %(self.namespace, self.namespace), False))
2966 self.outfile.write(' */\n')
2967 self.outfile.write('\n')
2968 self.outfile.write(self.docbook_gen.expand(
2970 ' * %sObjectSkeletonClass:\n'
2971 ' * @parent_class: The parent class.\n'
2973 ' * Class structure for #%sObjectSkeleton.\n'
2974 %(self.namespace, self.namespace), False))
2975 self.outfile.write(' */\n')
2976 self.outfile.write('\n')
2978 self.outfile.write('static void\n'
2979 '%sobject_skeleton__%sobject_iface_init (%sObjectIface *iface G_GNUC_UNUSED)\n'
2983 %(self.ns_lower, self.ns_lower, self.namespace))
2984 self.outfile.write('\n')
2985 self.outfile.write('static void\n'
2986 '%sobject_skeleton__g_dbus_object_iface_init (GDBusObjectIface *iface)\n'
2988 ' iface->interface_added = %sobject_notify;\n'
2989 ' iface->interface_removed = %sobject_notify;\n'
2992 %(self.ns_lower, self.ns_lower, self.ns_lower))
2993 self.outfile.write('G_DEFINE_TYPE_WITH_CODE (%sObjectSkeleton, %sobject_skeleton, G_TYPE_DBUS_OBJECT_SKELETON,\n'
2994 ' G_IMPLEMENT_INTERFACE (%sTYPE_OBJECT, %sobject_skeleton__%sobject_iface_init)\n'
2995 ' G_IMPLEMENT_INTERFACE (G_TYPE_DBUS_OBJECT, %sobject_skeleton__g_dbus_object_iface_init))\n'
2997 %(self.namespace, self.ns_lower, self.ns_upper, self.ns_lower, self.ns_lower, self.ns_lower))
2999 self.outfile.write('static void\n'
3000 '%sobject_skeleton_init (%sObjectSkeleton *object G_GNUC_UNUSED)\n'
3003 '\n'%(self.ns_lower, self.namespace))
3004 self.outfile.write('static void\n'
3005 '%sobject_skeleton_set_property (GObject *gobject,\n'
3007 ' const GValue *value,\n'
3008 ' GParamSpec *pspec)\n'
3010 ' %sObjectSkeleton *object = %sOBJECT_SKELETON (gobject);\n'
3011 ' GDBusInterfaceSkeleton *interface;\n'
3013 ' switch (prop_id)\n'
3015 %(self.ns_lower, self.namespace, self.ns_upper))
3017 for i in self.ifaces:
3018 self.outfile.write(' case %d:\n'
3019 ' interface = g_value_get_object (value);\n'
3020 ' if (interface != NULL)\n'
3022 ' g_warn_if_fail (%sIS_%s (interface));\n'
3023 ' g_dbus_object_skeleton_add_interface (G_DBUS_OBJECT_SKELETON (object), interface);\n'
3027 ' g_dbus_object_skeleton_remove_interface_by_name (G_DBUS_OBJECT_SKELETON (object), "%s");\n'
3031 %(n, self.ns_upper, i.name_upper, i.name))
3033 self.outfile.write(' default:\n'
3034 ' G_OBJECT_WARN_INVALID_PROPERTY_ID (gobject, prop_id, pspec);\n'
3039 self.outfile.write('static void\n'
3040 '%sobject_skeleton_get_property (GObject *gobject,\n'
3043 ' GParamSpec *pspec)\n'
3045 ' %sObjectSkeleton *object = %sOBJECT_SKELETON (gobject);\n'
3046 ' GDBusInterface *interface;\n'
3048 ' switch (prop_id)\n'
3050 %(self.ns_lower, self.namespace, self.ns_upper))
3052 for i in self.ifaces:
3053 self.outfile.write(' case %d:\n'
3054 ' interface = g_dbus_object_get_interface (G_DBUS_OBJECT (object), "%s");\n'
3055 ' g_value_take_object (value, interface);\n'
3060 self.outfile.write(' default:\n'
3061 ' G_OBJECT_WARN_INVALID_PROPERTY_ID (gobject, prop_id, pspec);\n'
3066 self.outfile.write('static void\n'
3067 '%sobject_skeleton_class_init (%sObjectSkeletonClass *klass)\n'
3069 ' GObjectClass *gobject_class = G_OBJECT_CLASS (klass);\n'
3071 ' gobject_class->set_property = %sobject_skeleton_set_property;\n'
3072 ' gobject_class->get_property = %sobject_skeleton_get_property;\n'
3074 %(self.ns_lower, self.namespace, self.ns_lower, self.ns_lower))
3076 for i in self.ifaces:
3077 self.outfile.write(' g_object_class_override_property (gobject_class, %d, "%s");'
3079 %(n, i.name_hyphen))
3081 self.outfile.write('}\n'
3083 self.outfile.write(self.docbook_gen.expand(
3085 ' * %sobject_skeleton_new:\n'
3086 ' * @object_path: An object path.\n'
3088 ' * Creates a new skeleton object.\n'
3090 ' * Returns: (transfer full): The skeleton object.\n'
3092 %(self.ns_lower), False))
3093 self.outfile.write('%sObjectSkeleton *\n'
3094 '%sobject_skeleton_new (const gchar *object_path)\n'
3096 ' g_return_val_if_fail (g_variant_is_object_path (object_path), NULL);\n'
3097 ' return %sOBJECT_SKELETON (g_object_new (%sTYPE_OBJECT_SKELETON, "g-object-path", object_path, NULL));\n'
3099 '\n'%(self.namespace, self.ns_lower, self.ns_upper, self.ns_upper))
3100 for i in self.ifaces:
3101 self.outfile.write(self.docbook_gen.expand(
3103 ' * %sobject_skeleton_set_%s:\n'
3104 ' * @object: A #%sObjectSkeleton.\n'
3105 ' * @interface_: (nullable): A #%s or %%NULL to clear the interface.\n'
3107 ' * Sets the #%s instance for the D-Bus interface #%s on @object.\n'
3108 %(self.ns_lower, i.name_upper.lower(), self.namespace, i.camel_name, i.camel_name, i.name), False))
3109 self.write_gtkdoc_deprecated_and_since_and_close(i, self.outfile, 0)
3110 self.outfile.write('void %sobject_skeleton_set_%s (%sObjectSkeleton *object, %s *interface_)\n'
3111 %(self.ns_lower, i.name_upper.lower(), self.namespace, i.camel_name))
3112 self.outfile.write('{\n'
3113 ' g_object_set (G_OBJECT (object), "%s", interface_, NULL);\n'
3117 self.outfile.write('\n')
3120 def generate_object_manager_client(self):
3121 self.outfile.write('/* ------------------------------------------------------------------------\n'
3122 ' * Code for ObjectManager client\n'
3123 ' * ------------------------------------------------------------------------\n'
3127 self.outfile.write(self.docbook_gen.expand(
3129 ' * SECTION:%sObjectManagerClient\n'
3130 ' * @title: %sObjectManagerClient\n'
3131 ' * @short_description: Generated GDBusObjectManagerClient type\n'
3133 ' * This section contains a #GDBusObjectManagerClient that uses %sobject_manager_client_get_proxy_type() as the #GDBusProxyTypeFunc.\n'
3135 %(self.namespace, self.namespace, self.ns_lower), False))
3136 self.outfile.write('\n')
3138 self.outfile.write(self.docbook_gen.expand(
3140 ' * %sObjectManagerClient:\n'
3142 ' * The #%sObjectManagerClient structure contains only private data and should only be accessed using the provided API.\n'
3143 %(self.namespace, self.namespace), False))
3144 self.outfile.write(' */\n')
3145 self.outfile.write('\n')
3147 self.outfile.write(self.docbook_gen.expand(
3149 ' * %sObjectManagerClientClass:\n'
3150 ' * @parent_class: The parent class.\n'
3152 ' * Class structure for #%sObjectManagerClient.\n'
3153 %(self.namespace, self.namespace), False))
3154 self.outfile.write(' */\n')
3155 self.outfile.write('\n')
3158 self.outfile.write('G_DEFINE_TYPE (%sObjectManagerClient, %sobject_manager_client, G_TYPE_DBUS_OBJECT_MANAGER_CLIENT)\n'
3160 %(self.namespace, self.ns_lower))
3163 self.outfile.write('static void\n'
3164 '%sobject_manager_client_init (%sObjectManagerClient *manager G_GNUC_UNUSED)\n'
3167 '\n'%(self.ns_lower, self.namespace))
3168 self.outfile.write('static void\n'
3169 '%sobject_manager_client_class_init (%sObjectManagerClientClass *klass G_GNUC_UNUSED)\n'
3172 '\n'%(self.ns_lower, self.namespace))
3174 self.outfile.write(self.docbook_gen.expand(
3176 ' * %sobject_manager_client_get_proxy_type:\n'
3177 ' * @manager: A #GDBusObjectManagerClient.\n'
3178 ' * @object_path: The object path of the remote object (unused).\n'
3179 ' * @interface_name: (nullable): Interface name of the remote object or %%NULL to get the object proxy #GType.\n'
3180 ' * @user_data: User data (unused).\n'
3182 ' * A #GDBusProxyTypeFunc that maps @interface_name to the generated #GDBusObjectProxy derived and #GDBusProxy derived types.\n'
3184 ' * Returns: A #GDBusProxy derived #GType if @interface_name is not %%NULL, otherwise the #GType for #%sObjectProxy.\n'
3185 %(self.ns_lower, self.namespace), False))
3186 self.outfile.write(' */\n')
3187 self.outfile.write('GType\n'
3188 '%sobject_manager_client_get_proxy_type (GDBusObjectManagerClient *manager G_GNUC_UNUSED, const gchar *object_path G_GNUC_UNUSED, const gchar *interface_name, gpointer user_data G_GNUC_UNUSED)\n'
3191 self.outfile.write(' static gsize once_init_value = 0;\n'
3192 ' static GHashTable *lookup_hash;\n'
3195 ' if (interface_name == NULL)\n'
3196 ' return %sTYPE_OBJECT_PROXY;\n'
3197 ' if (g_once_init_enter (&once_init_value))\n'
3199 ' lookup_hash = g_hash_table_new (g_str_hash, g_str_equal);\n'
3201 for i in self.ifaces:
3202 self.outfile.write(' g_hash_table_insert (lookup_hash, (gpointer) "%s", GSIZE_TO_POINTER (%sTYPE_%s_PROXY));\n'
3203 %(i.name, i.ns_upper, i.name_upper))
3204 self.outfile.write(' g_once_init_leave (&once_init_value, 1);\n'
3206 self.outfile.write(' ret = (GType) GPOINTER_TO_SIZE (g_hash_table_lookup (lookup_hash, interface_name));\n'
3207 ' if (ret == (GType) 0)\n'
3208 ' ret = G_TYPE_DBUS_PROXY;\n')
3209 self.outfile.write(' return ret;\n'
3214 self.outfile.write(self.docbook_gen.expand(
3216 ' * %sobject_manager_client_new:\n'
3217 ' * @connection: A #GDBusConnection.\n'
3218 ' * @flags: Flags from the #GDBusObjectManagerClientFlags enumeration.\n'
3219 ' * @name: (nullable): A bus name (well-known or unique) or %%NULL if @connection is not a message bus connection.\n'
3220 ' * @object_path: An object path.\n'
3221 ' * @cancellable: (nullable): A #GCancellable or %%NULL.\n'
3222 ' * @callback: A #GAsyncReadyCallback to call when the request is satisfied.\n'
3223 ' * @user_data: User data to pass to @callback.\n'
3225 ' * Asynchronously creates #GDBusObjectManagerClient using %sobject_manager_client_get_proxy_type() as the #GDBusProxyTypeFunc. See g_dbus_object_manager_client_new() for more details.\n'
3227 ' * 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'
3228 ' * You can then call %sobject_manager_client_new_finish() to get the result of the operation.\n'
3230 ' * See %sobject_manager_client_new_sync() for the synchronous, blocking version of this constructor.\n'
3231 %(self.ns_lower, self.ns_lower, self.ns_lower, self.ns_lower), False))
3232 self.outfile.write(' */\n')
3233 self.outfile.write('void\n'
3234 '%sobject_manager_client_new (\n'
3235 ' GDBusConnection *connection,\n'
3236 ' GDBusObjectManagerClientFlags flags,\n'
3237 ' const gchar *name,\n'
3238 ' const gchar *object_path,\n'
3239 ' GCancellable *cancellable,\n'
3240 ' GAsyncReadyCallback callback,\n'
3241 ' gpointer user_data)\n'
3243 ' 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'
3246 %(self.ns_lower, self.ns_upper, self.ns_lower))
3247 self.outfile.write('/**\n'
3248 ' * %sobject_manager_client_new_finish:\n'
3249 ' * @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to %sobject_manager_client_new().\n'
3250 ' * @error: Return location for error or %%NULL\n'
3252 ' * Finishes an operation started with %sobject_manager_client_new().\n'
3254 ' * Returns: (transfer full) (type %sObjectManagerClient): The constructed object manager client or %%NULL if @error is set.\n'
3255 %(self.ns_lower, self.ns_lower, self.ns_lower, self.namespace))
3256 self.outfile.write(' */\n')
3257 self.outfile.write('GDBusObjectManager *\n'
3258 '%sobject_manager_client_new_finish (\n'
3259 ' GAsyncResult *res,\n'
3260 ' GError **error)\n'
3263 ' GObject *source_object;\n'
3264 ' source_object = g_async_result_get_source_object (res);\n'
3265 ' ret = g_async_initable_new_finish (G_ASYNC_INITABLE (source_object), res, error);\n'
3266 ' g_object_unref (source_object);\n'
3267 ' if (ret != NULL)\n'
3268 ' return G_DBUS_OBJECT_MANAGER (ret);\n'
3274 self.outfile.write(self.docbook_gen.expand(
3276 ' * %sobject_manager_client_new_sync:\n'
3277 ' * @connection: A #GDBusConnection.\n'
3278 ' * @flags: Flags from the #GDBusObjectManagerClientFlags enumeration.\n'
3279 ' * @name: (nullable): A bus name (well-known or unique) or %%NULL if @connection is not a message bus connection.\n'
3280 ' * @object_path: An object path.\n'
3281 ' * @cancellable: (nullable): A #GCancellable or %%NULL.\n'
3282 ' * @error: Return location for error or %%NULL\n'
3284 ' * 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'
3286 ' * The calling thread is blocked until a reply is received.\n'
3288 ' * See %sobject_manager_client_new() for the asynchronous version of this constructor.\n'
3290 ' * Returns: (transfer full) (type %sObjectManagerClient): The constructed object manager client or %%NULL if @error is set.\n'
3291 %(self.ns_lower, self.ns_lower, self.ns_lower, self.namespace), False))
3292 self.outfile.write(' */\n')
3293 self.outfile.write('GDBusObjectManager *\n'
3294 '%sobject_manager_client_new_sync (\n'
3295 ' GDBusConnection *connection,\n'
3296 ' GDBusObjectManagerClientFlags flags,\n'
3297 ' const gchar *name,\n'
3298 ' const gchar *object_path,\n'
3299 ' GCancellable *cancellable,\n'
3300 ' GError **error)\n'
3302 ' GInitable *ret;\n'
3303 ' 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'
3304 ' if (ret != NULL)\n'
3305 ' return G_DBUS_OBJECT_MANAGER (ret);\n'
3310 %(self.ns_lower, self.ns_upper, self.ns_lower))
3311 self.outfile.write('\n')
3312 self.outfile.write(self.docbook_gen.expand(
3314 ' * %sobject_manager_client_new_for_bus:\n'
3315 ' * @bus_type: A #GBusType.\n'
3316 ' * @flags: Flags from the #GDBusObjectManagerClientFlags enumeration.\n'
3317 ' * @name: A bus name (well-known or unique).\n'
3318 ' * @object_path: An object path.\n'
3319 ' * @cancellable: (nullable): A #GCancellable or %%NULL.\n'
3320 ' * @callback: A #GAsyncReadyCallback to call when the request is satisfied.\n'
3321 ' * @user_data: User data to pass to @callback.\n'
3323 ' * Like %sobject_manager_client_new() but takes a #GBusType instead of a #GDBusConnection.\n'
3325 ' * 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'
3326 ' * You can then call %sobject_manager_client_new_for_bus_finish() to get the result of the operation.\n'
3328 ' * See %sobject_manager_client_new_for_bus_sync() for the synchronous, blocking version of this constructor.\n'
3329 %(self.ns_lower, self.ns_lower, self.ns_lower, self.ns_lower), False))
3330 self.outfile.write(' */\n')
3331 self.outfile.write('void\n'
3332 '%sobject_manager_client_new_for_bus (\n'
3333 ' GBusType bus_type,\n'
3334 ' GDBusObjectManagerClientFlags flags,\n'
3335 ' const gchar *name,\n'
3336 ' const gchar *object_path,\n'
3337 ' GCancellable *cancellable,\n'
3338 ' GAsyncReadyCallback callback,\n'
3339 ' gpointer user_data)\n'
3341 ' 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'
3344 %(self.ns_lower, self.ns_upper, self.ns_lower))
3345 self.outfile.write('/**\n'
3346 ' * %sobject_manager_client_new_for_bus_finish:\n'
3347 ' * @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to %sobject_manager_client_new_for_bus().\n'
3348 ' * @error: Return location for error or %%NULL\n'
3350 ' * Finishes an operation started with %sobject_manager_client_new_for_bus().\n'
3352 ' * Returns: (transfer full) (type %sObjectManagerClient): The constructed object manager client or %%NULL if @error is set.\n'
3353 %(self.ns_lower, self.ns_lower, self.ns_lower, self.namespace))
3354 self.outfile.write(' */\n')
3355 self.outfile.write('GDBusObjectManager *\n'
3356 '%sobject_manager_client_new_for_bus_finish (\n'
3357 ' GAsyncResult *res,\n'
3358 ' GError **error)\n'
3361 ' GObject *source_object;\n'
3362 ' source_object = g_async_result_get_source_object (res);\n'
3363 ' ret = g_async_initable_new_finish (G_ASYNC_INITABLE (source_object), res, error);\n'
3364 ' g_object_unref (source_object);\n'
3365 ' if (ret != NULL)\n'
3366 ' return G_DBUS_OBJECT_MANAGER (ret);\n'
3372 self.outfile.write(self.docbook_gen.expand(
3374 ' * %sobject_manager_client_new_for_bus_sync:\n'
3375 ' * @bus_type: A #GBusType.\n'
3376 ' * @flags: Flags from the #GDBusObjectManagerClientFlags enumeration.\n'
3377 ' * @name: A bus name (well-known or unique).\n'
3378 ' * @object_path: An object path.\n'
3379 ' * @cancellable: (nullable): A #GCancellable or %%NULL.\n'
3380 ' * @error: Return location for error or %%NULL\n'
3382 ' * Like %sobject_manager_client_new_sync() but takes a #GBusType instead of a #GDBusConnection.\n'
3384 ' * The calling thread is blocked until a reply is received.\n'
3386 ' * See %sobject_manager_client_new_for_bus() for the asynchronous version of this constructor.\n'
3388 ' * Returns: (transfer full) (type %sObjectManagerClient): The constructed object manager client or %%NULL if @error is set.\n'
3389 %(self.ns_lower, self.ns_lower, self.ns_lower, self.namespace), False))
3390 self.outfile.write(' */\n')
3391 self.outfile.write('GDBusObjectManager *\n'
3392 '%sobject_manager_client_new_for_bus_sync (\n'
3393 ' GBusType bus_type,\n'
3394 ' GDBusObjectManagerClientFlags flags,\n'
3395 ' const gchar *name,\n'
3396 ' const gchar *object_path,\n'
3397 ' GCancellable *cancellable,\n'
3398 ' GError **error)\n'
3400 ' GInitable *ret;\n'
3401 ' 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'
3402 ' if (ret != NULL)\n'
3403 ' return G_DBUS_OBJECT_MANAGER (ret);\n'
3408 %(self.ns_lower, self.ns_upper, self.ns_lower))
3409 self.outfile.write('\n')
3411 # ---------------------------------------------------------------------------------------------------
3413 def write_gtkdoc_deprecated_and_since_and_close(self, obj, f, indent):
3414 if len(obj.since) > 0:
3417 %(indent, '', indent, '', obj.since))
3419 if isinstance(obj, dbustypes.Interface):
3420 thing = 'The D-Bus interface'
3421 elif isinstance(obj, dbustypes.Method):
3422 thing = 'The D-Bus method'
3423 elif isinstance(obj, dbustypes.Signal):
3424 thing = 'The D-Bus signal'
3425 elif isinstance(obj, dbustypes.Property):
3426 thing = 'The D-Bus property'
3428 print_error('Cannot handle object "{}"'.format(obj))
3429 f.write(self.docbook_gen.expand(
3431 '%*s * Deprecated: %s has been deprecated.\n'
3432 %(indent, '', indent, '', thing), False))
3433 f.write('%*s */\n'%(indent, ''))
3435 # ---------------------------------------------------------------------------------------------------
3437 def generate_interface_intro(self, i):
3438 self.outfile.write('/* ------------------------------------------------------------------------\n'
3439 ' * Code for interface %s\n'
3440 ' * ------------------------------------------------------------------------\n'
3444 self.outfile.write(self.docbook_gen.expand(
3448 ' * @short_description: Generated C code for the %s D-Bus interface\n'
3450 ' * This section contains code for working with the #%s D-Bus interface in C.\n'
3452 %(i.camel_name, i.camel_name, i.name, i.name), False))
3453 self.outfile.write('\n')
3456 self.generate_body_preamble()
3457 for i in self.ifaces:
3458 self.generate_interface_intro(i)
3459 self.generate_introspection_for_interface(i)
3460 self.generate_interface(i)
3461 self.generate_property_accessors(i)
3462 self.generate_signal_emitters(i)
3463 self.generate_method_calls(i)
3464 self.generate_method_completers(i)
3465 self.generate_proxy(i)
3466 self.generate_skeleton(i)
3467 if self.generate_objmanager:
3468 self.generate_object()
3469 self.generate_object_manager_client()