4 # GDBus - GLib D-Bus Library
6 # Copyright (C) 2008-2018 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} from {!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, input_files_basenames,
59 self.namespace, self.ns_upper, self.ns_lower = generate_namespace(namespace)
60 self.generate_objmanager = generate_objmanager
61 self.generate_autocleanup = generate_autocleanup
62 self.header_guard = header_name.upper().replace('.', '_').replace('-', '_').replace('/', '_').replace(':', '_')
63 self.input_files_basenames = input_files_basenames
64 self.use_pragma = use_pragma
65 self.outfile = outfile
67 # ----------------------------------------------------------------------------------------------------
69 def generate_header_preamble(self):
70 basenames = ', '.join(self.input_files_basenames)
71 self.outfile.write(LICENSE_STR.format(config.VERSION, basenames))
72 self.outfile.write('\n')
75 self.outfile.write('#pragma once\n')
77 self.outfile.write('#ifndef __{!s}__\n'.format(self.header_guard))
78 self.outfile.write('#define __{!s}__\n'.format(self.header_guard))
80 self.outfile.write('\n')
81 self.outfile.write('#include <gio/gio.h>\n')
82 self.outfile.write('\n')
83 self.outfile.write('G_BEGIN_DECLS\n')
84 self.outfile.write('\n')
86 # ----------------------------------------------------------------------------------------------------
88 def declare_types(self):
90 self.outfile.write('\n')
91 self.outfile.write('/* ------------------------------------------------------------------------ */\n')
92 self.outfile.write('/* Declarations for %s */\n'%i.name)
93 self.outfile.write('\n')
95 # First the GInterface
96 self.outfile.write('#define %sTYPE_%s (%s_get_type ())\n'%(i.ns_upper, i.name_upper, i.name_lower))
97 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))
98 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))
99 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))
100 self.outfile.write('\n')
101 self.outfile.write('struct _%s;\n'%(i.camel_name))
102 self.outfile.write('typedef struct _%s %s;\n'%(i.camel_name, i.camel_name))
103 self.outfile.write('typedef struct _%sIface %sIface;\n'%(i.camel_name, i.camel_name))
104 self.outfile.write('\n')
105 self.outfile.write('struct _%sIface\n'%(i.camel_name))
106 self.outfile.write('{\n')
107 self.outfile.write(' GTypeInterface parent_iface;\n')
109 function_pointers = {}
112 if len(i.methods) > 0:
113 self.outfile.write('\n')
116 if utils.lookup_annotation(m.annotations, 'org.gtk.GDBus.C.UnixFD'):
118 key = (m.since, '_method_%s'%m.name_lower)
119 value = ' gboolean (*handle_%s) (\n'%(m.name_lower)
120 value += ' %s *object,\n'%(i.camel_name)
121 value += ' GDBusMethodInvocation *invocation'%()
123 value += ',\n GUnixFDList *fd_list'
125 value += ',\n %sarg_%s'%(a.ctype_in, a.name)
127 function_pointers[key] = value
130 if len(i.signals) > 0:
131 self.outfile.write('\n')
133 key = (s.since, '_signal_%s'%s.name_lower)
134 value = ' void (*%s) (\n'%(s.name_lower)
135 value += ' %s *object'%(i.camel_name)
137 value += ',\n %sarg_%s'%(a.ctype_in, a.name)
139 function_pointers[key] = value
141 # vfuncs for properties
142 if len(i.properties) > 0:
143 self.outfile.write('\n')
144 for p in i.properties:
145 key = (p.since, '_prop_get_%s'%p.name_lower)
146 value = ' %s (*get_%s) (%s *object);\n\n'%(p.arg.ctype_in, p.name_lower, i.camel_name)
147 function_pointers[key] = value
149 # Sort according to @since tag, then name.. this ensures
150 # that the function pointers don't change order assuming
151 # judicious use of @since
153 # Also use a proper version comparison function so e.g.
154 # 10.0 comes after 2.0.
156 # See https://bugzilla.gnome.org/show_bug.cgi?id=647577#c5
158 for key in sorted(function_pointers.keys(), key=utils.version_cmp_key):
159 self.outfile.write('%s'%function_pointers[key])
161 self.outfile.write('};\n')
162 self.outfile.write('\n')
163 if self.generate_autocleanup == 'all':
164 self.outfile.write('#if GLIB_CHECK_VERSION(2, 44, 0)\n')
165 self.outfile.write('G_DEFINE_AUTOPTR_CLEANUP_FUNC (%s, g_object_unref)\n' % (i.camel_name))
166 self.outfile.write('#endif\n')
167 self.outfile.write('\n')
168 self.outfile.write('GType %s_get_type (void) G_GNUC_CONST;\n'%(i.name_lower))
169 self.outfile.write('\n')
170 self.outfile.write('GDBusInterfaceInfo *%s_interface_info (void);\n'%(i.name_lower))
171 self.outfile.write('guint %s_override_properties (GObjectClass *klass, guint property_id_begin);\n'%(i.name_lower))
172 self.outfile.write('\n')
174 # Then method call completion functions
175 if len(i.methods) > 0:
176 self.outfile.write('\n')
177 self.outfile.write('/* D-Bus method call completion functions: */\n')
180 if utils.lookup_annotation(m.annotations, 'org.gtk.GDBus.C.UnixFD'):
183 self.outfile.write('G_GNUC_DEPRECATED ')
184 self.outfile.write('void %s_complete_%s (\n'
186 ' GDBusMethodInvocation *invocation'%(i.name_lower, m.name_lower, i.camel_name))
188 self.outfile.write(',\n GUnixFDList *fd_list')
190 self.outfile.write(',\n %s%s'%(a.ctype_in, a.name))
191 self.outfile.write(');\n')
192 self.outfile.write('\n')
193 self.outfile.write('\n')
195 # Then signal emission functions
196 if len(i.signals) > 0:
197 self.outfile.write('\n')
198 self.outfile.write('/* D-Bus signal emissions functions: */\n')
201 self.outfile.write('G_GNUC_DEPRECATED ')
202 self.outfile.write('void %s_emit_%s (\n'
203 ' %s *object'%(i.name_lower, s.name_lower, i.camel_name))
205 self.outfile.write(',\n %sarg_%s'%(a.ctype_in, a.name))
206 self.outfile.write(');\n')
207 self.outfile.write('\n')
208 self.outfile.write('\n')
210 # Then method call declarations
211 if len(i.methods) > 0:
212 self.outfile.write('\n')
213 self.outfile.write('/* D-Bus method calls: */\n')
216 if utils.lookup_annotation(m.annotations, 'org.gtk.GDBus.C.UnixFD'):
220 self.outfile.write('G_GNUC_DEPRECATED ')
221 self.outfile.write('void %s_call_%s (\n'
222 ' %s *proxy'%(i.name_lower, m.name_lower, i.camel_name))
224 self.outfile.write(',\n %sarg_%s'%(a.ctype_in, a.name))
226 self.outfile.write(',\n GUnixFDList *fd_list')
227 self.outfile.write(',\n'
228 ' GCancellable *cancellable,\n'
229 ' GAsyncReadyCallback callback,\n'
230 ' gpointer user_data);\n')
231 self.outfile.write('\n')
234 self.outfile.write('G_GNUC_DEPRECATED ')
235 self.outfile.write('gboolean %s_call_%s_finish (\n'
236 ' %s *proxy'%(i.name_lower, m.name_lower, i.camel_name))
238 self.outfile.write(',\n %sout_%s'%(a.ctype_out, a.name))
240 self.outfile.write(',\n GUnixFDList **out_fd_list')
241 self.outfile.write(',\n'
242 ' GAsyncResult *res,\n'
243 ' GError **error);\n')
244 self.outfile.write('\n')
247 self.outfile.write('G_GNUC_DEPRECATED ')
248 self.outfile.write('gboolean %s_call_%s_sync (\n'
249 ' %s *proxy'%(i.name_lower, m.name_lower, i.camel_name))
251 self.outfile.write(',\n %sarg_%s'%(a.ctype_in, a.name))
253 self.outfile.write(',\n GUnixFDList *fd_list')
255 self.outfile.write(',\n %sout_%s'%(a.ctype_out, a.name))
257 self.outfile.write(',\n GUnixFDList **out_fd_list')
258 self.outfile.write(',\n'
259 ' GCancellable *cancellable,\n'
260 ' GError **error);\n')
261 self.outfile.write('\n')
262 self.outfile.write('\n')
264 # Then the property accessor declarations
265 if len(i.properties) > 0:
266 self.outfile.write('\n')
267 self.outfile.write('/* D-Bus property accessors: */\n')
268 for p in i.properties:
271 self.outfile.write('G_GNUC_DEPRECATED ')
272 self.outfile.write('%s%s_get_%s (%s *object);\n'%(p.arg.ctype_in, i.name_lower, p.name_lower, i.camel_name))
273 if p.arg.free_func != None:
275 self.outfile.write('G_GNUC_DEPRECATED ')
276 self.outfile.write('%s%s_dup_%s (%s *object);\n'%(p.arg.ctype_in_dup, i.name_lower, p.name_lower, i.camel_name))
279 self.outfile.write('G_GNUC_DEPRECATED ')
280 self.outfile.write('void %s_set_%s (%s *object, %svalue);\n'%(i.name_lower, p.name_lower, i.camel_name, p.arg.ctype_in, ))
281 self.outfile.write('\n')
284 self.outfile.write('\n')
285 self.outfile.write('/* ---- */\n')
286 self.outfile.write('\n')
287 self.outfile.write('#define %sTYPE_%s_PROXY (%s_proxy_get_type ())\n'%(i.ns_upper, i.name_upper, i.name_lower))
288 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))
289 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))
290 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))
291 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))
292 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))
293 self.outfile.write('\n')
294 self.outfile.write('typedef struct _%sProxy %sProxy;\n'%(i.camel_name, i.camel_name))
295 self.outfile.write('typedef struct _%sProxyClass %sProxyClass;\n'%(i.camel_name, i.camel_name))
296 self.outfile.write('typedef struct _%sProxyPrivate %sProxyPrivate;\n'%(i.camel_name, i.camel_name))
297 self.outfile.write('\n')
298 self.outfile.write('struct _%sProxy\n'%(i.camel_name))
299 self.outfile.write('{\n')
300 self.outfile.write(' /*< private >*/\n')
301 self.outfile.write(' GDBusProxy parent_instance;\n')
302 self.outfile.write(' %sProxyPrivate *priv;\n'%(i.camel_name))
303 self.outfile.write('};\n')
304 self.outfile.write('\n')
305 self.outfile.write('struct _%sProxyClass\n'%(i.camel_name))
306 self.outfile.write('{\n')
307 self.outfile.write(' GDBusProxyClass parent_class;\n')
308 self.outfile.write('};\n')
309 self.outfile.write('\n')
310 self.outfile.write('GType %s_proxy_get_type (void) G_GNUC_CONST;\n'%(i.name_lower))
311 self.outfile.write('\n')
312 if self.generate_autocleanup in ('objects', 'all'):
313 self.outfile.write('#if GLIB_CHECK_VERSION(2, 44, 0)\n')
314 self.outfile.write('G_DEFINE_AUTOPTR_CLEANUP_FUNC (%sProxy, g_object_unref)\n' % (i.camel_name))
315 self.outfile.write('#endif\n')
316 self.outfile.write('\n')
318 self.outfile.write('G_GNUC_DEPRECATED ')
319 self.outfile.write('void %s_proxy_new (\n'
320 ' GDBusConnection *connection,\n'
321 ' GDBusProxyFlags flags,\n'
322 ' const gchar *name,\n'
323 ' const gchar *object_path,\n'
324 ' GCancellable *cancellable,\n'
325 ' GAsyncReadyCallback callback,\n'
326 ' gpointer user_data);\n'
329 self.outfile.write('G_GNUC_DEPRECATED ')
330 self.outfile.write('%s *%s_proxy_new_finish (\n'
331 ' GAsyncResult *res,\n'
332 ' GError **error);\n'
333 %(i.camel_name, i.name_lower))
335 self.outfile.write('G_GNUC_DEPRECATED ')
336 self.outfile.write('%s *%s_proxy_new_sync (\n'
337 ' GDBusConnection *connection,\n'
338 ' GDBusProxyFlags flags,\n'
339 ' const gchar *name,\n'
340 ' const gchar *object_path,\n'
341 ' GCancellable *cancellable,\n'
342 ' GError **error);\n'
343 %(i.camel_name, i.name_lower))
344 self.outfile.write('\n')
346 self.outfile.write('G_GNUC_DEPRECATED ')
347 self.outfile.write('void %s_proxy_new_for_bus (\n'
348 ' GBusType bus_type,\n'
349 ' GDBusProxyFlags flags,\n'
350 ' const gchar *name,\n'
351 ' const gchar *object_path,\n'
352 ' GCancellable *cancellable,\n'
353 ' GAsyncReadyCallback callback,\n'
354 ' gpointer user_data);\n'
357 self.outfile.write('G_GNUC_DEPRECATED ')
358 self.outfile.write('%s *%s_proxy_new_for_bus_finish (\n'
359 ' GAsyncResult *res,\n'
360 ' GError **error);\n'
361 %(i.camel_name, i.name_lower))
363 self.outfile.write('G_GNUC_DEPRECATED ')
364 self.outfile.write('%s *%s_proxy_new_for_bus_sync (\n'
365 ' GBusType bus_type,\n'
366 ' GDBusProxyFlags flags,\n'
367 ' const gchar *name,\n'
368 ' const gchar *object_path,\n'
369 ' GCancellable *cancellable,\n'
370 ' GError **error);\n'
371 %(i.camel_name, i.name_lower))
372 self.outfile.write('\n')
375 self.outfile.write('\n')
376 self.outfile.write('/* ---- */\n')
377 self.outfile.write('\n')
378 self.outfile.write('#define %sTYPE_%s_SKELETON (%s_skeleton_get_type ())\n'%(i.ns_upper, i.name_upper, i.name_lower))
379 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))
380 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))
381 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))
382 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))
383 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))
384 self.outfile.write('\n')
385 self.outfile.write('typedef struct _%sSkeleton %sSkeleton;\n'%(i.camel_name, i.camel_name))
386 self.outfile.write('typedef struct _%sSkeletonClass %sSkeletonClass;\n'%(i.camel_name, i.camel_name))
387 self.outfile.write('typedef struct _%sSkeletonPrivate %sSkeletonPrivate;\n'%(i.camel_name, i.camel_name))
388 self.outfile.write('\n')
389 self.outfile.write('struct _%sSkeleton\n'%(i.camel_name))
390 self.outfile.write('{\n')
391 self.outfile.write(' /*< private >*/\n')
392 self.outfile.write(' GDBusInterfaceSkeleton parent_instance;\n')
393 self.outfile.write(' %sSkeletonPrivate *priv;\n'%(i.camel_name))
394 self.outfile.write('};\n')
395 self.outfile.write('\n')
396 self.outfile.write('struct _%sSkeletonClass\n'%(i.camel_name))
397 self.outfile.write('{\n')
398 self.outfile.write(' GDBusInterfaceSkeletonClass parent_class;\n')
399 self.outfile.write('};\n')
400 self.outfile.write('\n')
401 self.outfile.write('GType %s_skeleton_get_type (void) G_GNUC_CONST;\n'%(i.name_lower))
402 self.outfile.write('\n')
403 if self.generate_autocleanup in ('objects', 'all'):
404 self.outfile.write('#if GLIB_CHECK_VERSION(2, 44, 0)\n')
405 self.outfile.write('G_DEFINE_AUTOPTR_CLEANUP_FUNC (%sSkeleton, g_object_unref)\n' % (i.camel_name))
406 self.outfile.write('#endif\n')
407 self.outfile.write('\n')
409 self.outfile.write('G_GNUC_DEPRECATED ')
410 self.outfile.write('%s *%s_skeleton_new (void);\n'%(i.camel_name, i.name_lower))
412 self.outfile.write('\n')
414 # Finally, the Object, ObjectProxy, ObjectSkeleton and ObjectManagerClient
415 if self.generate_objmanager:
416 self.outfile.write('\n')
417 self.outfile.write('/* ---- */\n')
418 self.outfile.write('\n')
419 self.outfile.write('#define %sTYPE_OBJECT (%sobject_get_type ())\n'%(self.ns_upper, self.ns_lower))
420 self.outfile.write('#define %sOBJECT(o) (G_TYPE_CHECK_INSTANCE_CAST ((o), %sTYPE_OBJECT, %sObject))\n'%(self.ns_upper, self.ns_upper, self.namespace))
421 self.outfile.write('#define %sIS_OBJECT(o) (G_TYPE_CHECK_INSTANCE_TYPE ((o), %sTYPE_OBJECT))\n'%(self.ns_upper, self.ns_upper))
422 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))
423 self.outfile.write('\n')
424 self.outfile.write('struct _%sObject;\n'%(self.namespace))
425 self.outfile.write('typedef struct _%sObject %sObject;\n'%(self.namespace, self.namespace))
426 self.outfile.write('typedef struct _%sObjectIface %sObjectIface;\n'%(self.namespace, self.namespace))
427 self.outfile.write('\n')
428 self.outfile.write('struct _%sObjectIface\n'%(self.namespace))
429 self.outfile.write('{\n'
430 ' GTypeInterface parent_iface;\n'
433 self.outfile.write('GType %sobject_get_type (void) G_GNUC_CONST;\n'
436 if self.generate_autocleanup == 'all':
437 self.outfile.write('#if GLIB_CHECK_VERSION(2, 44, 0)\n')
438 self.outfile.write('G_DEFINE_AUTOPTR_CLEANUP_FUNC (%sObject, g_object_unref)\n' % (self.namespace))
439 self.outfile.write('#endif\n')
440 self.outfile.write('\n')
441 for i in self.ifaces:
443 self.outfile.write('G_GNUC_DEPRECATED ')
444 self.outfile.write('%s *%sobject_get_%s (%sObject *object);\n'
445 %(i.camel_name, self.ns_lower, i.name_upper.lower(), self.namespace))
446 for i in self.ifaces:
448 self.outfile.write('G_GNUC_DEPRECATED ')
449 self.outfile.write('%s *%sobject_peek_%s (%sObject *object);\n'
450 %(i.camel_name, self.ns_lower, i.name_upper.lower(), self.namespace))
451 self.outfile.write('\n')
452 self.outfile.write('#define %sTYPE_OBJECT_PROXY (%sobject_proxy_get_type ())\n'%(self.ns_upper, self.ns_lower))
453 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))
454 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))
455 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))
456 self.outfile.write('#define %sIS_OBJECT_PROXY(o) (G_TYPE_CHECK_INSTANCE_TYPE ((o), %sTYPE_OBJECT_PROXY))\n'%(self.ns_upper, self.ns_upper))
457 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))
458 self.outfile.write('\n')
459 self.outfile.write('typedef struct _%sObjectProxy %sObjectProxy;\n'%(self.namespace, self.namespace))
460 self.outfile.write('typedef struct _%sObjectProxyClass %sObjectProxyClass;\n'%(self.namespace, self.namespace))
461 self.outfile.write('typedef struct _%sObjectProxyPrivate %sObjectProxyPrivate;\n'%(self.namespace, self.namespace))
462 self.outfile.write('\n')
463 self.outfile.write('struct _%sObjectProxy\n'%(self.namespace))
464 self.outfile.write('{\n')
465 self.outfile.write(' /*< private >*/\n')
466 self.outfile.write(' GDBusObjectProxy parent_instance;\n')
467 self.outfile.write(' %sObjectProxyPrivate *priv;\n'%(self.namespace))
468 self.outfile.write('};\n')
469 self.outfile.write('\n')
470 self.outfile.write('struct _%sObjectProxyClass\n'%(self.namespace))
471 self.outfile.write('{\n')
472 self.outfile.write(' GDBusObjectProxyClass parent_class;\n')
473 self.outfile.write('};\n')
474 self.outfile.write('\n')
475 self.outfile.write('GType %sobject_proxy_get_type (void) G_GNUC_CONST;\n'%(self.ns_lower))
476 self.outfile.write('\n')
477 if self.generate_autocleanup in ('objects', 'all'):
478 self.outfile.write('#if GLIB_CHECK_VERSION(2, 44, 0)\n')
479 self.outfile.write('G_DEFINE_AUTOPTR_CLEANUP_FUNC (%sObjectProxy, g_object_unref)\n' % (self.namespace))
480 self.outfile.write('#endif\n')
481 self.outfile.write('\n')
482 self.outfile.write('%sObjectProxy *%sobject_proxy_new (GDBusConnection *connection, const gchar *object_path);\n'%(self.namespace, self.ns_lower))
483 self.outfile.write('\n')
484 self.outfile.write('#define %sTYPE_OBJECT_SKELETON (%sobject_skeleton_get_type ())\n'%(self.ns_upper, self.ns_lower))
485 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))
486 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))
487 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))
488 self.outfile.write('#define %sIS_OBJECT_SKELETON(o) (G_TYPE_CHECK_INSTANCE_TYPE ((o), %sTYPE_OBJECT_SKELETON))\n'%(self.ns_upper, self.ns_upper))
489 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))
490 self.outfile.write('\n')
491 self.outfile.write('typedef struct _%sObjectSkeleton %sObjectSkeleton;\n'%(self.namespace, self.namespace))
492 self.outfile.write('typedef struct _%sObjectSkeletonClass %sObjectSkeletonClass;\n'%(self.namespace, self.namespace))
493 self.outfile.write('typedef struct _%sObjectSkeletonPrivate %sObjectSkeletonPrivate;\n'%(self.namespace, self.namespace))
494 self.outfile.write('\n')
495 self.outfile.write('struct _%sObjectSkeleton\n'%(self.namespace))
496 self.outfile.write('{\n')
497 self.outfile.write(' /*< private >*/\n')
498 self.outfile.write(' GDBusObjectSkeleton parent_instance;\n')
499 self.outfile.write(' %sObjectSkeletonPrivate *priv;\n'%(self.namespace))
500 self.outfile.write('};\n')
501 self.outfile.write('\n')
502 self.outfile.write('struct _%sObjectSkeletonClass\n'%(self.namespace))
503 self.outfile.write('{\n')
504 self.outfile.write(' GDBusObjectSkeletonClass parent_class;\n')
505 self.outfile.write('};\n')
506 self.outfile.write('\n')
507 self.outfile.write('GType %sobject_skeleton_get_type (void) G_GNUC_CONST;\n'%(self.ns_lower))
508 self.outfile.write('\n')
509 if self.generate_autocleanup in ('objects', 'all'):
510 self.outfile.write('#if GLIB_CHECK_VERSION(2, 44, 0)\n')
511 self.outfile.write('G_DEFINE_AUTOPTR_CLEANUP_FUNC (%sObjectSkeleton, g_object_unref)\n' % (self.namespace))
512 self.outfile.write('#endif\n')
513 self.outfile.write('\n')
514 self.outfile.write('%sObjectSkeleton *%sobject_skeleton_new (const gchar *object_path);\n'
515 %(self.namespace, self.ns_lower))
516 for i in self.ifaces:
518 self.outfile.write('G_GNUC_DEPRECATED ')
519 self.outfile.write('void %sobject_skeleton_set_%s (%sObjectSkeleton *object, %s *interface_);\n'
520 %(self.ns_lower, i.name_upper.lower(), self.namespace, i.camel_name))
521 self.outfile.write('\n')
523 self.outfile.write('/* ---- */\n')
524 self.outfile.write('\n')
525 self.outfile.write('#define %sTYPE_OBJECT_MANAGER_CLIENT (%sobject_manager_client_get_type ())\n'%(self.ns_upper, self.ns_lower))
526 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))
527 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))
528 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))
529 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))
530 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))
531 self.outfile.write('\n')
532 self.outfile.write('typedef struct _%sObjectManagerClient %sObjectManagerClient;\n'%(self.namespace, self.namespace))
533 self.outfile.write('typedef struct _%sObjectManagerClientClass %sObjectManagerClientClass;\n'%(self.namespace, self.namespace))
534 self.outfile.write('typedef struct _%sObjectManagerClientPrivate %sObjectManagerClientPrivate;\n'%(self.namespace, self.namespace))
535 self.outfile.write('\n')
536 self.outfile.write('struct _%sObjectManagerClient\n'%(self.namespace))
537 self.outfile.write('{\n')
538 self.outfile.write(' /*< private >*/\n')
539 self.outfile.write(' GDBusObjectManagerClient parent_instance;\n')
540 self.outfile.write(' %sObjectManagerClientPrivate *priv;\n'%(self.namespace))
541 self.outfile.write('};\n')
542 self.outfile.write('\n')
543 self.outfile.write('struct _%sObjectManagerClientClass\n'%(self.namespace))
544 self.outfile.write('{\n')
545 self.outfile.write(' GDBusObjectManagerClientClass parent_class;\n')
546 self.outfile.write('};\n')
547 self.outfile.write('\n')
548 if self.generate_autocleanup in ('objects', 'all'):
549 self.outfile.write('#if GLIB_CHECK_VERSION(2, 44, 0)\n')
550 self.outfile.write('G_DEFINE_AUTOPTR_CLEANUP_FUNC (%sObjectManagerClient, g_object_unref)\n' % (self.namespace))
551 self.outfile.write('#endif\n')
552 self.outfile.write('\n')
553 self.outfile.write('GType %sobject_manager_client_get_type (void) G_GNUC_CONST;\n'%(self.ns_lower))
554 self.outfile.write('\n')
555 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))
556 self.outfile.write('\n')
557 self.outfile.write('void %sobject_manager_client_new (\n'
558 ' GDBusConnection *connection,\n'
559 ' GDBusObjectManagerClientFlags flags,\n'
560 ' const gchar *name,\n'
561 ' const gchar *object_path,\n'
562 ' GCancellable *cancellable,\n'
563 ' GAsyncReadyCallback callback,\n'
564 ' gpointer user_data);\n'
566 self.outfile.write('GDBusObjectManager *%sobject_manager_client_new_finish (\n'
567 ' GAsyncResult *res,\n'
568 ' GError **error);\n'
570 self.outfile.write('GDBusObjectManager *%sobject_manager_client_new_sync (\n'
571 ' GDBusConnection *connection,\n'
572 ' GDBusObjectManagerClientFlags flags,\n'
573 ' const gchar *name,\n'
574 ' const gchar *object_path,\n'
575 ' GCancellable *cancellable,\n'
576 ' GError **error);\n'
578 self.outfile.write('\n')
579 self.outfile.write('void %sobject_manager_client_new_for_bus (\n'
580 ' GBusType bus_type,\n'
581 ' GDBusObjectManagerClientFlags flags,\n'
582 ' const gchar *name,\n'
583 ' const gchar *object_path,\n'
584 ' GCancellable *cancellable,\n'
585 ' GAsyncReadyCallback callback,\n'
586 ' gpointer user_data);\n'
588 self.outfile.write('GDBusObjectManager *%sobject_manager_client_new_for_bus_finish (\n'
589 ' GAsyncResult *res,\n'
590 ' GError **error);\n'
592 self.outfile.write('GDBusObjectManager *%sobject_manager_client_new_for_bus_sync (\n'
593 ' GBusType bus_type,\n'
594 ' GDBusObjectManagerClientFlags flags,\n'
595 ' const gchar *name,\n'
596 ' const gchar *object_path,\n'
597 ' GCancellable *cancellable,\n'
598 ' GError **error);\n'
600 self.outfile.write('\n')
602 # ----------------------------------------------------------------------------------------------------
604 def generate_header_postamble(self):
605 self.outfile.write('\n')
606 self.outfile.write('G_END_DECLS\n')
608 if not self.use_pragma:
609 self.outfile.write('\n')
610 self.outfile.write('#endif /* __{!s}__ */\n'.format(self.header_guard))
612 # ----------------------------------------------------------------------------------------------------
615 self.generate_header_preamble()
617 self.generate_header_postamble()
619 # ----------------------------------------------------------------------------------------------------
621 class InterfaceInfoHeaderCodeGenerator:
622 def __init__(self, ifaces, namespace, header_name, input_files_basenames, use_pragma, outfile):
624 self.namespace, self.ns_upper, self.ns_lower = generate_namespace(namespace)
625 self.header_guard = header_name.upper().replace('.', '_').replace('-', '_').replace('/', '_').replace(':', '_')
626 self.input_files_basenames = input_files_basenames
627 self.use_pragma = use_pragma
628 self.outfile = outfile
630 # ----------------------------------------------------------------------------------------------------
632 def generate_header_preamble(self):
633 basenames = ', '.join(self.input_files_basenames)
634 self.outfile.write(LICENSE_STR.format(config.VERSION, basenames))
635 self.outfile.write('\n')
638 self.outfile.write('#pragma once\n')
640 self.outfile.write('#ifndef __{!s}__\n'.format(self.header_guard))
641 self.outfile.write('#define __{!s}__\n'.format(self.header_guard))
643 self.outfile.write('\n')
644 self.outfile.write('#include <gio/gio.h>\n')
645 self.outfile.write('\n')
646 self.outfile.write('G_BEGIN_DECLS\n')
647 self.outfile.write('\n')
649 # ----------------------------------------------------------------------------------------------------
651 def declare_infos(self):
652 for i in self.ifaces:
653 self.outfile.write('extern const GDBusInterfaceInfo %s_interface;\n' % i.name_lower)
655 # ----------------------------------------------------------------------------------------------------
657 def generate_header_postamble(self):
658 self.outfile.write('\n')
659 self.outfile.write('G_END_DECLS\n')
661 if not self.use_pragma:
662 self.outfile.write('\n')
663 self.outfile.write('#endif /* __{!s}__ */\n'.format(self.header_guard))
665 # ----------------------------------------------------------------------------------------------------
668 self.generate_header_preamble()
670 self.generate_header_postamble()
672 # ----------------------------------------------------------------------------------------------------
674 class InterfaceInfoBodyCodeGenerator:
675 def __init__(self, ifaces, namespace, header_name, input_files_basenames, outfile):
677 self.namespace, self.ns_upper, self.ns_lower = generate_namespace(namespace)
678 self.header_name = header_name
679 self.input_files_basenames = input_files_basenames
680 self.outfile = outfile
682 # ----------------------------------------------------------------------------------------------------
684 def generate_body_preamble(self):
685 basenames = ', '.join(self.input_files_basenames)
686 self.outfile.write(LICENSE_STR.format(config.VERSION, basenames))
687 self.outfile.write('\n')
688 self.outfile.write('#ifdef HAVE_CONFIG_H\n'
689 '# include "config.h"\n'
694 '#include <string.h>\n'
695 % (self.header_name))
696 self.outfile.write('\n')
698 # ----------------------------------------------------------------------------------------------------
700 def generate_array(self, array_name_lower, element_type, elements):
701 self.outfile.write('const %s * const %s[] =\n' % (element_type, array_name_lower))
702 self.outfile.write('{\n')
703 for (_, name) in elements:
704 self.outfile.write(' &%s,\n' % name)
705 self.outfile.write(' NULL,\n')
706 self.outfile.write('};\n')
707 self.outfile.write('\n')
709 def define_annotations(self, array_name_lower, annotations):
710 if len(annotations) == 0:
713 annotation_pointers = []
715 for a in annotations:
716 # Skip internal annotations.
717 if a.key.startswith('org.gtk.GDBus'):
720 self.define_annotations('%s__%s_annotations' % (array_name_lower, a.key_lower), a.annotations)
722 self.outfile.write('const GDBusAnnotationInfo %s__%s_annotation =\n' % (array_name_lower, a.key_lower))
723 self.outfile.write('{\n')
724 self.outfile.write(' -1, /* ref count */\n')
725 self.outfile.write(' (gchar *) "%s",\n' % a.key)
726 self.outfile.write(' (gchar *) "%s",\n' % a.value)
727 if len(a.annotations) > 0:
728 self.outfile.write(' (GDBusAnnotationInfo **) %s__%s_annotations,\n' % (array_name_lower, a.key_lower))
730 self.outfile.write(' NULL, /* no annotations */\n')
731 self.outfile.write('};\n')
732 self.outfile.write('\n')
734 key = (a.since, '%s__%s_annotation' % (array_name_lower, a.key_lower))
735 annotation_pointers.append(key)
737 self.generate_array(array_name_lower, 'GDBusAnnotationInfo',
740 def define_args(self, array_name_lower, args):
747 self.define_annotations('%s__%s_arg_annotations' % (array_name_lower, a.name), a.annotations)
749 self.outfile.write('const GDBusArgInfo %s__%s_arg =\n' % (array_name_lower, a.name))
750 self.outfile.write('{\n')
751 self.outfile.write(' -1, /* ref count */\n')
752 self.outfile.write(' (gchar *) "%s",\n' % a.name)
753 self.outfile.write(' (gchar *) "%s",\n' % a.signature)
754 if len(a.annotations) > 0:
755 self.outfile.write(' (GDBusAnnotationInfo **) %s__%s_arg_annotations,\n' % (array_name_lower, a.name))
757 self.outfile.write(' NULL, /* no annotations */\n')
758 self.outfile.write('};\n')
759 self.outfile.write('\n')
761 key = (a.since, '%s__%s_arg' % (array_name_lower, a.name))
762 arg_pointers.append(key)
764 self.generate_array(array_name_lower, 'GDBusArgInfo', arg_pointers)
766 def define_infos(self):
767 for i in self.ifaces:
768 self.outfile.write('/* ------------------------------------------------------------------------ */\n')
769 self.outfile.write('/* Definitions for %s */\n' % i.name)
770 self.outfile.write('\n')
773 if len(i.methods) > 0:
777 self.define_args('%s_interface__%s_method_in_args' % (i.name_lower, m.name_lower), m.in_args)
778 self.define_args('%s_interface__%s_method_out_args' % (i.name_lower, m.name_lower), m.out_args)
779 self.define_annotations('%s_interface__%s_method_annotations' % (i.name_lower, m.name_lower), m.annotations)
781 self.outfile.write('const GDBusMethodInfo %s_interface__%s_method =\n' % (i.name_lower, m.name_lower))
782 self.outfile.write('{\n')
783 self.outfile.write(' -1, /* ref count */\n')
784 self.outfile.write(' (gchar *) "%s",\n' % m.name)
785 if len(m.in_args) > 0:
786 self.outfile.write(' (GDBusArgInfo **) %s_interface__%s_method_in_args,\n' % (i.name_lower, m.name_lower))
788 self.outfile.write(' NULL, /* no in args */\n')
789 if len(m.out_args) > 0:
790 self.outfile.write(' (GDBusArgInfo **) %s_interface__%s_method_out_args,\n' % (i.name_lower, m.name_lower))
792 self.outfile.write(' NULL, /* no out args */\n')
793 if len(m.annotations) > 0:
794 self.outfile.write(' (GDBusAnnotationInfo **) %s_interface__%s_method_annotations,\n' % (i.name_lower, m.name_lower))
796 self.outfile.write(' NULL, /* no annotations */\n')
797 self.outfile.write('};\n')
798 self.outfile.write('\n')
800 key = (m.since, '%s_interface__%s_method' % (i.name_lower, m.name_lower))
801 method_pointers.append(key)
803 self.generate_array('%s_interface_methods' % i.name_lower,
804 'GDBusMethodInfo', method_pointers)
807 if len(i.signals) > 0:
811 self.define_args('%s_interface__%s_signal_args' % (i.name_lower, s.name_lower), s.args)
812 self.define_annotations('%s_interface__%s_signal_annotations' % (i.name_lower, s.name_lower), s.annotations)
814 self.outfile.write('const GDBusSignalInfo %s_interface__%s_signal =\n' % (i.name_lower, s.name_lower))
815 self.outfile.write('{\n')
816 self.outfile.write(' -1, /* ref count */\n')
817 self.outfile.write(' (gchar *) "%s",\n' % s.name)
819 self.outfile.write(' (GDBusArgInfo **) %s_interface__%s_signal_args,\n' % (i.name_lower, s.name_lower))
821 self.outfile.write(' NULL, /* no args */\n')
822 if len(s.annotations) > 0:
823 self.outfile.write(' (GDBusAnnotationInfo **) %s_interface__%s_signal_annotations,\n' % (i.name_lower, s.name_lower))
825 self.outfile.write(' NULL, /* no annotations */\n')
826 self.outfile.write('};\n')
827 self.outfile.write('\n')
829 key = (m.since, '%s_interface__%s_signal' % (i.name_lower, s.name_lower))
830 signal_pointers.append(key)
832 self.generate_array('%s_interface_signals' % i.name_lower,
833 'GDBusSignalInfo', signal_pointers)
835 # GDBusPropertyInfos.
836 if len(i.properties) > 0:
837 property_pointers = []
839 for p in i.properties:
840 if p.readable and p.writable:
841 flags = 'G_DBUS_PROPERTY_INFO_FLAGS_READABLE | G_DBUS_PROPERTY_INFO_FLAGS_WRITABLE'
843 flags = 'G_DBUS_PROPERTY_INFO_FLAGS_READABLE'
845 flags = 'G_DBUS_PROPERTY_INFO_FLAGS_WRITABLE'
847 flags = 'G_DBUS_PROPERTY_INFO_FLAGS_NONE'
849 self.define_annotations('%s_interface__%s_property_annotations' % (i.name_lower, p.name_lower), p.annotations)
851 self.outfile.write('const GDBusPropertyInfo %s_interface__%s_property =\n' % (i.name_lower, p.name_lower))
852 self.outfile.write('{\n')
853 self.outfile.write(' -1, /* ref count */\n')
854 self.outfile.write(' (gchar *) "%s",\n' % p.name)
855 self.outfile.write(' (gchar *) "%s",\n' % p.signature)
856 self.outfile.write(' %s,\n' % flags)
857 if len(p.annotations) > 0:
858 self.outfile.write(' (GDBusAnnotationInfo **) %s_interface__%s_property_annotations,\n' % (i.name_lower, p.name_lower))
860 self.outfile.write(' NULL, /* no annotations */\n')
861 self.outfile.write('};\n')
862 self.outfile.write('\n')
864 key = (m.since, '%s_interface__%s_property' % (i.name_lower, p.name_lower))
865 property_pointers.append(key)
867 self.generate_array('%s_interface_properties' % i.name_lower,
868 'GDBusPropertyInfo', property_pointers)
870 # Finally the GDBusInterfaceInfo.
871 self.define_annotations('%s_interface_annotations' % i.name_lower,
874 self.outfile.write('const GDBusInterfaceInfo %s_interface =\n' % i.name_lower)
875 self.outfile.write('{\n')
876 self.outfile.write(' -1, /* ref count */\n')
877 self.outfile.write(' (gchar *) "%s",\n' % i.name)
878 if len(i.methods) > 0:
879 self.outfile.write(' (GDBusMethodInfo **) %s_interface_methods,\n' % i.name_lower)
881 self.outfile.write(' NULL, /* no methods */\n')
882 if len(i.signals) > 0:
883 self.outfile.write(' (GDBusSignalInfo **) %s_interface_signals,\n' % i.name_lower)
885 self.outfile.write(' NULL, /* no signals */\n')
886 if len(i.properties) > 0:
887 self.outfile.write(' (GDBusPropertyInfo **) %s_interface_properties,\n' % i.name_lower)
889 self.outfile.write( 'NULL, /* no properties */\n')
890 if len(i.annotations) > 0:
891 self.outfile.write(' (GDBusAnnotationInfo **) %s_interface_annotations,\n' % i.name_lower)
893 self.outfile.write(' NULL, /* no annotations */\n')
894 self.outfile.write('};\n')
895 self.outfile.write('\n')
897 # ----------------------------------------------------------------------------------------------------
900 self.generate_body_preamble()
903 # ----------------------------------------------------------------------------------------------------
906 def __init__(self, ifaces, namespace, generate_objmanager, header_name,
907 input_files_basenames, docbook_gen, outfile):
909 self.namespace, self.ns_upper, self.ns_lower = generate_namespace(namespace)
910 self.generate_objmanager = generate_objmanager
911 self.header_name = header_name
912 self.input_files_basenames = input_files_basenames
913 self.docbook_gen = docbook_gen
914 self.outfile = outfile
916 # ----------------------------------------------------------------------------------------------------
918 def generate_body_preamble(self):
919 basenames = ', '.join(self.input_files_basenames)
920 self.outfile.write(LICENSE_STR.format(config.VERSION, basenames))
921 self.outfile.write('\n')
922 self.outfile.write('#ifdef HAVE_CONFIG_H\n'
923 '# include "config.h"\n'
928 '#include <string.h>\n'
931 self.outfile.write('#ifdef G_OS_UNIX\n'
932 '# include <gio/gunixfdlist.h>\n'
936 self.outfile.write('typedef struct\n'
938 ' GDBusArgInfo parent_struct;\n'
939 ' gboolean use_gvariant;\n'
940 '} _ExtendedGDBusArgInfo;\n'
943 self.outfile.write('typedef struct\n'
945 ' GDBusMethodInfo parent_struct;\n'
946 ' const gchar *signal_name;\n'
947 ' gboolean pass_fdlist;\n'
948 '} _ExtendedGDBusMethodInfo;\n'
951 self.outfile.write('typedef struct\n'
953 ' GDBusSignalInfo parent_struct;\n'
954 ' const gchar *signal_name;\n'
955 '} _ExtendedGDBusSignalInfo;\n'
958 self.outfile.write('typedef struct\n'
960 ' GDBusPropertyInfo parent_struct;\n'
961 ' const gchar *hyphen_name;\n'
962 ' guint use_gvariant : 1;\n'
963 ' guint emits_changed_signal : 1;\n'
964 '} _ExtendedGDBusPropertyInfo;\n'
967 self.outfile.write('typedef struct\n'
969 ' GDBusInterfaceInfo parent_struct;\n'
970 ' const gchar *hyphen_name;\n'
971 '} _ExtendedGDBusInterfaceInfo;\n'
974 self.outfile.write('typedef struct\n'
976 ' const _ExtendedGDBusPropertyInfo *info;\n'
978 ' GValue orig_value; /* the value before the change */\n'
979 '} ChangedProperty;\n'
982 '_changed_property_free (ChangedProperty *data)\n'
984 ' g_value_unset (&data->orig_value);\n'
989 self.outfile.write('static gboolean\n'
990 '_g_strv_equal0 (gchar **a, gchar **b)\n'
992 ' gboolean ret = FALSE;\n'
994 ' if (a == NULL && b == NULL)\n'
999 ' if (a == NULL || b == NULL)\n'
1001 ' if (g_strv_length (a) != g_strv_length (b))\n'
1003 ' for (n = 0; a[n] != NULL; n++)\n'
1004 ' if (g_strcmp0 (a[n], b[n]) != 0)\n'
1012 self.outfile.write('static gboolean\n'
1013 '_g_variant_equal0 (GVariant *a, GVariant *b)\n'
1015 ' gboolean ret = FALSE;\n'
1016 ' if (a == NULL && b == NULL)\n'
1021 ' if (a == NULL || b == NULL)\n'
1023 ' ret = g_variant_equal (a, b);\n'
1029 # simplified - only supports the types we use
1030 self.outfile.write('G_GNUC_UNUSED static gboolean\n'
1031 '_g_value_equal (const GValue *a, const GValue *b)\n'
1033 ' gboolean ret = FALSE;\n'
1034 ' g_assert (G_VALUE_TYPE (a) == G_VALUE_TYPE (b));\n'
1035 ' switch (G_VALUE_TYPE (a))\n'
1037 ' case G_TYPE_BOOLEAN:\n'
1038 ' ret = (g_value_get_boolean (a) == g_value_get_boolean (b));\n'
1040 ' case G_TYPE_UCHAR:\n'
1041 ' ret = (g_value_get_uchar (a) == g_value_get_uchar (b));\n'
1043 ' case G_TYPE_INT:\n'
1044 ' ret = (g_value_get_int (a) == g_value_get_int (b));\n'
1046 ' case G_TYPE_UINT:\n'
1047 ' ret = (g_value_get_uint (a) == g_value_get_uint (b));\n'
1049 ' case G_TYPE_INT64:\n'
1050 ' ret = (g_value_get_int64 (a) == g_value_get_int64 (b));\n'
1052 ' case G_TYPE_UINT64:\n'
1053 ' ret = (g_value_get_uint64 (a) == g_value_get_uint64 (b));\n'
1055 ' case G_TYPE_DOUBLE:\n'
1057 ' /* Avoid -Wfloat-equal warnings by doing a direct bit compare */\n'
1058 ' gdouble da = g_value_get_double (a);\n'
1059 ' gdouble db = g_value_get_double (b);\n'
1060 ' ret = memcmp (&da, &db, sizeof (gdouble)) == 0;\n'
1063 ' case G_TYPE_STRING:\n'
1064 ' ret = (g_strcmp0 (g_value_get_string (a), g_value_get_string (b)) == 0);\n'
1066 ' case G_TYPE_VARIANT:\n'
1067 ' ret = _g_variant_equal0 (g_value_get_variant (a), g_value_get_variant (b));\n'
1070 ' if (G_VALUE_TYPE (a) == G_TYPE_STRV)\n'
1071 ' ret = _g_strv_equal0 (g_value_get_boxed (a), g_value_get_boxed (b));\n'
1073 ' g_critical ("_g_value_equal() does not handle type %s", g_type_name (G_VALUE_TYPE (a)));\n'
1080 def generate_annotations(self, prefix, annotations):
1081 if annotations is None:
1085 for a in annotations:
1086 #self.generate_annotations('%s_%d'%(prefix, n), a.get_annotations())
1088 # skip internal annotations
1089 if a.key.startswith('org.gtk.GDBus'):
1092 self.outfile.write('static const GDBusAnnotationInfo %s_%d =\n'
1095 ' (gchar *) "%s",\n'
1096 ' (gchar *) "%s",\n'%(prefix, n, a.key, a.value))
1097 if len(a.annotations) == 0:
1098 self.outfile.write(' NULL\n')
1100 self.outfile.write(' (GDBusAnnotationInfo **) &%s_%d_pointers\n'%(prefix, n))
1101 self.outfile.write('};\n'
1106 self.outfile.write('static const GDBusAnnotationInfo * const %s_pointers[] =\n'
1109 for a in annotations:
1110 if a.key.startswith('org.gtk.GDBus'):
1112 self.outfile.write(' &%s_%d,\n'%(prefix, m))
1114 self.outfile.write(' NULL\n'
1119 def generate_args(self, prefix, args):
1121 num_anno = self.generate_annotations('%s_arg_%s_annotation_info'%(prefix, a.name), a.annotations)
1123 self.outfile.write('static const _ExtendedGDBusArgInfo %s_%s =\n'
1127 ' (gchar *) "%s",\n'
1128 ' (gchar *) "%s",\n'%(prefix, a.name, a.name, a.signature))
1130 self.outfile.write(' NULL\n')
1132 self.outfile.write(' (GDBusAnnotationInfo **) &%s_arg_%s_annotation_info_pointers\n'%(prefix, a.name))
1133 self.outfile.write(' },\n')
1134 if not utils.lookup_annotation(a.annotations, 'org.gtk.GDBus.C.ForceGVariant'):
1135 self.outfile.write(' FALSE\n')
1137 self.outfile.write(' TRUE\n')
1138 self.outfile.write('};\n'
1142 self.outfile.write('static const GDBusArgInfo * const %s_pointers[] =\n'
1145 self.outfile.write(' &%s_%s.parent_struct,\n'%(prefix, a.name))
1146 self.outfile.write(' NULL\n'
1150 def generate_introspection_for_interface(self, i):
1151 self.outfile.write('/* ---- Introspection data for %s ---- */\n'
1154 if len(i.methods) > 0:
1157 if utils.lookup_annotation(m.annotations, 'org.gtk.GDBus.C.UnixFD'):
1159 self.generate_args('_%s_method_info_%s_IN_ARG'%(i.name_lower, m.name_lower), m.in_args)
1160 self.generate_args('_%s_method_info_%s_OUT_ARG'%(i.name_lower, m.name_lower), m.out_args)
1162 num_anno = self.generate_annotations('_%s_method_%s_annotation_info'%(i.name_lower, m.name_lower), m.annotations)
1164 self.outfile.write('static const _ExtendedGDBusMethodInfo _%s_method_info_%s =\n'
1168 ' (gchar *) "%s",\n'%(i.name_lower, m.name_lower, m.name))
1169 if len(m.in_args) == 0:
1170 self.outfile.write(' NULL,\n')
1172 self.outfile.write(' (GDBusArgInfo **) &_%s_method_info_%s_IN_ARG_pointers,\n'%(i.name_lower, m.name_lower))
1173 if len(m.out_args) == 0:
1174 self.outfile.write(' NULL,\n')
1176 self.outfile.write(' (GDBusArgInfo **) &_%s_method_info_%s_OUT_ARG_pointers,\n'%(i.name_lower, m.name_lower))
1178 self.outfile.write(' NULL\n')
1180 self.outfile.write(' (GDBusAnnotationInfo **) &_%s_method_%s_annotation_info_pointers\n'%(i.name_lower, m.name_lower))
1181 self.outfile.write(' },\n'
1184 %(m.name_hyphen, 'TRUE' if unix_fd else 'FALSE'))
1185 self.outfile.write('};\n'
1188 self.outfile.write('static const GDBusMethodInfo * const _%s_method_info_pointers[] =\n'
1189 '{\n'%(i.name_lower))
1191 self.outfile.write(' &_%s_method_info_%s.parent_struct,\n'%(i.name_lower, m.name_lower))
1192 self.outfile.write(' NULL\n'
1198 if len(i.signals) > 0:
1200 self.generate_args('_%s_signal_info_%s_ARG'%(i.name_lower, s.name_lower), s.args)
1202 num_anno = self.generate_annotations('_%s_signal_%s_annotation_info'%(i.name_lower, s.name_lower), s.annotations)
1203 self.outfile.write('static const _ExtendedGDBusSignalInfo _%s_signal_info_%s =\n'
1207 ' (gchar *) "%s",\n'%(i.name_lower, s.name_lower, s.name))
1208 if len(s.args) == 0:
1209 self.outfile.write(' NULL,\n')
1211 self.outfile.write(' (GDBusArgInfo **) &_%s_signal_info_%s_ARG_pointers,\n'%(i.name_lower, s.name_lower))
1213 self.outfile.write(' NULL\n')
1215 self.outfile.write(' (GDBusAnnotationInfo **) &_%s_signal_%s_annotation_info_pointers\n'%(i.name_lower, s.name_lower))
1216 self.outfile.write(' },\n'
1219 self.outfile.write('};\n'
1222 self.outfile.write('static const GDBusSignalInfo * const _%s_signal_info_pointers[] =\n'
1223 '{\n'%(i.name_lower))
1225 self.outfile.write(' &_%s_signal_info_%s.parent_struct,\n'%(i.name_lower, s.name_lower))
1226 self.outfile.write(' NULL\n'
1232 if len(i.properties) > 0:
1233 for p in i.properties:
1234 if p.readable and p.writable:
1235 access = 'G_DBUS_PROPERTY_INFO_FLAGS_READABLE | G_DBUS_PROPERTY_INFO_FLAGS_WRITABLE'
1237 access = 'G_DBUS_PROPERTY_INFO_FLAGS_READABLE'
1239 access = 'G_DBUS_PROPERTY_INFO_FLAGS_WRITABLE'
1241 access = 'G_DBUS_PROPERTY_INFO_FLAGS_NONE'
1242 num_anno = self.generate_annotations('_%s_property_%s_annotation_info'%(i.name_lower, p.name_lower), p.annotations)
1243 self.outfile.write('static const _ExtendedGDBusPropertyInfo _%s_property_info_%s =\n'
1247 ' (gchar *) "%s",\n'
1248 ' (gchar *) "%s",\n'
1249 ' %s,\n'%(i.name_lower, p.name_lower, p.name, p.arg.signature, access))
1251 self.outfile.write(' NULL\n')
1253 self.outfile.write(' (GDBusAnnotationInfo **) &_%s_property_%s_annotation_info_pointers\n'%(i.name_lower, p.name_lower))
1254 self.outfile.write(' },\n'
1257 if not utils.lookup_annotation(p.annotations, 'org.gtk.GDBus.C.ForceGVariant'):
1258 self.outfile.write(' FALSE,\n')
1260 self.outfile.write(' TRUE,\n')
1261 if p.emits_changed_signal:
1262 self.outfile.write(' TRUE\n')
1264 self.outfile.write(' FALSE\n')
1265 self.outfile.write('};\n'
1268 self.outfile.write('static const GDBusPropertyInfo * const _%s_property_info_pointers[] =\n'
1269 '{\n'%(i.name_lower))
1270 for p in i.properties:
1271 self.outfile.write(' &_%s_property_info_%s.parent_struct,\n'%(i.name_lower, p.name_lower))
1272 self.outfile.write(' NULL\n'
1276 num_anno = self.generate_annotations('_%s_annotation_info'%(i.name_lower), i.annotations)
1277 self.outfile.write('static const _ExtendedGDBusInterfaceInfo _%s_interface_info =\n'
1281 ' (gchar *) "%s",\n'%(i.name_lower, i.name))
1282 if len(i.methods) == 0:
1283 self.outfile.write(' NULL,\n')
1285 self.outfile.write(' (GDBusMethodInfo **) &_%s_method_info_pointers,\n'%(i.name_lower))
1286 if len(i.signals) == 0:
1287 self.outfile.write(' NULL,\n')
1289 self.outfile.write(' (GDBusSignalInfo **) &_%s_signal_info_pointers,\n'%(i.name_lower))
1290 if len(i.properties) == 0:
1291 self.outfile.write(' NULL,\n')
1293 self.outfile.write(' (GDBusPropertyInfo **) &_%s_property_info_pointers,\n'%(i.name_lower))
1295 self.outfile.write(' NULL\n')
1297 self.outfile.write(' (GDBusAnnotationInfo **) &_%s_annotation_info_pointers\n'%(i.name_lower))
1298 self.outfile.write(' },\n'
1303 self.outfile.write('\n')
1304 self.outfile.write(self.docbook_gen.expand(
1306 ' * %s_interface_info:\n'
1308 ' * Gets a machine-readable description of the #%s D-Bus interface.\n'
1310 ' * Returns: (transfer none): A #GDBusInterfaceInfo. Do not free.\n'
1311 %(i.name_lower, i.name), False))
1312 self.write_gtkdoc_deprecated_and_since_and_close(i, self.outfile, 0)
1313 self.outfile.write('GDBusInterfaceInfo *\n'
1314 '%s_interface_info (void)\n'
1316 ' return (GDBusInterfaceInfo *) &_%s_interface_info.parent_struct;\n'
1318 '\n'%(i.name_lower, i.name_lower))
1320 self.outfile.write(self.docbook_gen.expand(
1322 ' * %s_override_properties:\n'
1323 ' * @klass: The class structure for a #GObject derived class.\n'
1324 ' * @property_id_begin: The property id to assign to the first overridden property.\n'
1326 ' * Overrides all #GObject properties in the #%s interface for a concrete class.\n'
1327 ' * The properties are overridden in the order they are defined.\n'
1329 ' * Returns: The last property id.\n'
1330 %(i.name_lower, i.camel_name), False))
1331 self.write_gtkdoc_deprecated_and_since_and_close(i, self.outfile, 0)
1332 self.outfile.write('guint\n'
1333 '%s_override_properties (GObjectClass *klass, guint property_id_begin)\n'
1334 '{\n'%(i.name_lower))
1335 for p in i.properties:
1336 self.outfile.write(' g_object_class_override_property (klass, property_id_begin++, "%s");\n'%(p.name_hyphen))
1337 self.outfile.write(' return property_id_begin - 1;\n'
1340 self.outfile.write('\n')
1342 # ----------------------------------------------------------------------------------------------------
1344 def generate_interface(self, i):
1345 self.outfile.write('\n')
1347 self.outfile.write(self.docbook_gen.expand(
1351 ' * Abstract interface type for the D-Bus interface #%s.\n'
1352 %(i.camel_name, i.name), False))
1353 self.write_gtkdoc_deprecated_and_since_and_close(i, self.outfile, 0)
1354 self.outfile.write('\n')
1356 self.outfile.write(self.docbook_gen.expand(
1359 ' * @parent_iface: The parent interface.\n'
1360 %(i.camel_name), False))
1363 if len(i.methods) > 0:
1365 key = (m.since, '_method_%s'%m.name_lower)
1366 value = '@handle_%s: '%(m.name_lower)
1367 value += 'Handler for the #%s::handle-%s signal.'%(i.camel_name, m.name_hyphen)
1368 doc_bits[key] = value
1369 if len(i.signals) > 0:
1371 key = (s.since, '_signal_%s'%s.name_lower)
1372 value = '@%s: '%(s.name_lower)
1373 value += 'Handler for the #%s::%s signal.'%(i.camel_name, s.name_hyphen)
1374 doc_bits[key] = value
1375 if len(i.properties) > 0:
1376 for p in i.properties:
1377 key = (p.since, '_prop_get_%s'%p.name_lower)
1378 value = '@get_%s: '%(p.name_lower)
1379 value += 'Getter for the #%s:%s property.'%(i.camel_name, p.name_hyphen)
1380 doc_bits[key] = value
1381 for key in sorted(doc_bits.keys(), key=utils.version_cmp_key):
1382 self.outfile.write(' * %s\n'%doc_bits[key])
1384 self.outfile.write(self.docbook_gen.expand(
1386 ' * Virtual table for the D-Bus interface #%s.\n'
1388 self.write_gtkdoc_deprecated_and_since_and_close(i, self.outfile, 0)
1389 self.outfile.write('\n')
1391 self.outfile.write('typedef %sIface %sInterface;\n'%(i.camel_name, i.camel_name))
1392 self.outfile.write('G_DEFINE_INTERFACE (%s, %s, G_TYPE_OBJECT)\n'%(i.camel_name, i.name_lower))
1393 self.outfile.write('\n')
1395 self.outfile.write('static void\n'
1396 '%s_default_init (%sIface *iface)\n'
1397 '{\n'%(i.name_lower, i.camel_name));
1399 if len(i.methods) > 0:
1400 self.outfile.write(' /* GObject signals for incoming D-Bus method calls: */\n')
1403 if utils.lookup_annotation(m.annotations, 'org.gtk.GDBus.C.UnixFD'):
1405 self.outfile.write(self.docbook_gen.expand(
1407 ' * %s::handle-%s:\n'
1408 ' * @object: A #%s.\n'
1409 ' * @invocation: A #GDBusMethodInvocation.\n'
1410 %(i.camel_name, m.name_hyphen, i.camel_name), False))
1412 self.outfile.write(' * @fd_list: (nullable): A #GUnixFDList or %NULL.\n')
1414 self.outfile.write(' * @arg_%s: Argument passed by remote caller.\n'%(a.name))
1415 self.outfile.write(self.docbook_gen.expand(
1417 ' * Signal emitted when a remote caller is invoking the %s.%s() D-Bus method.\n'
1419 ' * 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'
1421 ' * Returns: %%TRUE if the invocation was handled, %%FALSE to let other signal handlers run.\n'
1422 %(i.name, m.name, i.name_lower, m.name_lower), False))
1423 self.write_gtkdoc_deprecated_and_since_and_close(m, self.outfile, 2)
1428 self.outfile.write(' g_signal_new ("handle-%s",\n'
1429 ' G_TYPE_FROM_INTERFACE (iface),\n'
1430 ' G_SIGNAL_RUN_LAST,\n'
1431 ' G_STRUCT_OFFSET (%sIface, handle_%s),\n'
1432 ' g_signal_accumulator_true_handled,\n'
1433 ' NULL,\n' # accu_data
1434 ' g_cclosure_marshal_generic,\n'
1435 ' G_TYPE_BOOLEAN,\n'
1437 ' G_TYPE_DBUS_METHOD_INVOCATION'
1438 %(m.name_hyphen, i.camel_name, m.name_lower, len(m.in_args) + extra_args))
1440 self.outfile.write(', G_TYPE_UNIX_FD_LIST')
1442 self.outfile.write(', %s'%(a.gtype))
1443 self.outfile.write(');\n')
1444 self.outfile.write('\n')
1446 if len(i.signals) > 0:
1447 self.outfile.write(' /* GObject signals for received D-Bus signals: */\n')
1449 self.outfile.write(self.docbook_gen.expand(
1452 ' * @object: A #%s.\n'
1453 %(i.camel_name, s.name_hyphen, i.camel_name), False))
1455 self.outfile.write(' * @arg_%s: Argument.\n'%(a.name))
1456 self.outfile.write(self.docbook_gen.expand(
1458 ' * On the client-side, this signal is emitted whenever the D-Bus signal #%s::%s is received.\n'
1460 ' * 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'
1461 %(i.name, s.name), False))
1462 self.write_gtkdoc_deprecated_and_since_and_close(s, self.outfile, 2)
1463 self.outfile.write(' g_signal_new ("%s",\n'
1464 ' G_TYPE_FROM_INTERFACE (iface),\n'
1465 ' G_SIGNAL_RUN_LAST,\n'
1466 ' G_STRUCT_OFFSET (%sIface, %s),\n'
1467 ' NULL,\n' # accumulator
1468 ' NULL,\n' # accu_data
1469 ' g_cclosure_marshal_generic,\n'
1472 %(s.name_hyphen, i.camel_name, s.name_lower, len(s.args)))
1474 self.outfile.write(', %s'%(a.gtype))
1475 self.outfile.write(');\n')
1476 self.outfile.write('\n')
1478 if len(i.properties) > 0:
1479 self.outfile.write(' /* GObject properties for D-Bus properties: */\n')
1480 for p in i.properties:
1481 if p.readable and p.writable:
1482 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.'
1484 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.'
1486 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.'
1488 print_error('Cannot handle property "{}" that neither readable nor writable'.format(p.name))
1489 self.outfile.write(self.docbook_gen.expand(
1493 ' * Represents the D-Bus property #%s:%s.\n'
1496 %(i.camel_name, p.name_hyphen, i.name, p.name, hint), False))
1497 self.write_gtkdoc_deprecated_and_since_and_close(p, self.outfile, 2)
1498 self.outfile.write(' g_object_interface_install_property (iface,\n')
1499 if p.arg.gtype == 'G_TYPE_VARIANT':
1500 s = 'g_param_spec_variant ("%s", "%s", "%s", G_VARIANT_TYPE ("%s"), NULL'%(p.name_hyphen, p.name, p.name, p.arg.signature)
1501 elif p.arg.signature == 'b':
1502 s = 'g_param_spec_boolean ("%s", "%s", "%s", FALSE'%(p.name_hyphen, p.name, p.name)
1503 elif p.arg.signature == 'y':
1504 s = 'g_param_spec_uchar ("%s", "%s", "%s", 0, 255, 0'%(p.name_hyphen, p.name, p.name)
1505 elif p.arg.signature == 'n':
1506 s = 'g_param_spec_int ("%s", "%s", "%s", G_MININT16, G_MAXINT16, 0'%(p.name_hyphen, p.name, p.name)
1507 elif p.arg.signature == 'q':
1508 s = 'g_param_spec_uint ("%s", "%s", "%s", 0, G_MAXUINT16, 0'%(p.name_hyphen, p.name, p.name)
1509 elif p.arg.signature == 'i':
1510 s = 'g_param_spec_int ("%s", "%s", "%s", G_MININT32, G_MAXINT32, 0'%(p.name_hyphen, p.name, p.name)
1511 elif p.arg.signature == 'u':
1512 s = 'g_param_spec_uint ("%s", "%s", "%s", 0, G_MAXUINT32, 0'%(p.name_hyphen, p.name, p.name)
1513 elif p.arg.signature == 'x':
1514 s = 'g_param_spec_int64 ("%s", "%s", "%s", G_MININT64, G_MAXINT64, 0'%(p.name_hyphen, p.name, p.name)
1515 elif p.arg.signature == 't':
1516 s = 'g_param_spec_uint64 ("%s", "%s", "%s", 0, G_MAXUINT64, 0'%(p.name_hyphen, p.name, p.name)
1517 elif p.arg.signature == 'd':
1518 s = 'g_param_spec_double ("%s", "%s", "%s", -G_MAXDOUBLE, G_MAXDOUBLE, 0.0'%(p.name_hyphen, p.name, p.name)
1519 elif p.arg.signature == 's':
1520 s = 'g_param_spec_string ("%s", "%s", "%s", NULL'%(p.name_hyphen, p.name, p.name)
1521 elif p.arg.signature == 'o':
1522 s = 'g_param_spec_string ("%s", "%s", "%s", NULL'%(p.name_hyphen, p.name, p.name)
1523 elif p.arg.signature == 'g':
1524 s = 'g_param_spec_string ("%s", "%s", "%s", NULL'%(p.name_hyphen, p.name, p.name)
1525 elif p.arg.signature == 'ay':
1526 s = 'g_param_spec_string ("%s", "%s", "%s", NULL'%(p.name_hyphen, p.name, p.name)
1527 elif p.arg.signature == 'as':
1528 s = 'g_param_spec_boxed ("%s", "%s", "%s", G_TYPE_STRV'%(p.name_hyphen, p.name, p.name)
1529 elif p.arg.signature == 'ao':
1530 s = 'g_param_spec_boxed ("%s", "%s", "%s", G_TYPE_STRV'%(p.name_hyphen, p.name, p.name)
1531 elif p.arg.signature == 'aay':
1532 s = 'g_param_spec_boxed ("%s", "%s", "%s", G_TYPE_STRV'%(p.name_hyphen, p.name, p.name)
1534 print_error('Unsupported gtype "{}" for GParamSpec'.format(p.arg.gtype))
1535 flags = 'G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS'
1537 flags = 'G_PARAM_DEPRECATED | ' + flags
1538 self.outfile.write(' %s, %s));'%(s, flags));
1539 self.outfile.write('\n')
1541 self.outfile.write('}\n'
1544 # ----------------------------------------------------------------------------------------------------
1546 def generate_property_accessors(self, i):
1547 for p in i.properties:
1549 if p.readable and p.writable:
1550 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.'
1552 hint = 'Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side.'
1554 hint = 'Since this D-Bus property is not readable, it is only meaningful to use this function on the service-side.'
1556 print_error('Cannot handle property "{}" that neither readable nor writable'.format(p.name))
1557 self.outfile.write(self.docbook_gen.expand(
1559 ' * %s_get_%s: (skip)\n'
1560 ' * @object: A #%s.\n'
1562 ' * Gets the value of the #%s:%s D-Bus property.\n'
1566 %(i.name_lower, p.name_lower, i.camel_name, i.name, p.name, hint), False))
1567 if p.arg.free_func != None:
1568 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'
1570 ' * Returns: (transfer none) (nullable): The property value or %%NULL if the property is not set. Do not free the returned value, it belongs to @object.\n'
1571 %(i.name_lower, p.name_lower))
1573 self.outfile.write(' * Returns: The property value.\n')
1574 self.write_gtkdoc_deprecated_and_since_and_close(p, self.outfile, 0)
1575 self.outfile.write('%s\n'
1576 '%s_get_%s (%s *object)\n'
1577 '{\n'%(p.arg.ctype_in, i.name_lower, p.name_lower, i.camel_name))
1578 self.outfile.write(' return %s%s_GET_IFACE (object)->get_%s (object);\n'%(i.ns_upper, i.name_upper, p.name_lower))
1579 self.outfile.write('}\n')
1580 self.outfile.write('\n')
1581 if p.arg.free_func != None:
1583 self.outfile.write(self.docbook_gen.expand(
1585 ' * %s_dup_%s: (skip)\n'
1586 ' * @object: A #%s.\n'
1588 ' * Gets a copy of the #%s:%s D-Bus property.\n'
1592 ' * Returns: (transfer full) (nullable): The property value or %%NULL if the property is not set. The returned value should be freed with %s().\n'
1593 %(i.name_lower, p.name_lower, i.camel_name, i.name, p.name, hint, p.arg.free_func), False))
1594 self.write_gtkdoc_deprecated_and_since_and_close(p, self.outfile, 0)
1595 self.outfile.write('%s\n'
1596 '%s_dup_%s (%s *object)\n'
1598 ' %svalue;\n'%(p.arg.ctype_in_dup, i.name_lower, p.name_lower, i.camel_name, p.arg.ctype_in_dup))
1599 self.outfile.write(' g_object_get (G_OBJECT (object), "%s", &value, NULL);\n'%(p.name_hyphen))
1600 self.outfile.write(' return value;\n')
1601 self.outfile.write('}\n')
1602 self.outfile.write('\n')
1605 if p.readable and p.writable:
1606 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.'
1608 hint = 'Since this D-Bus property is not writable, it is only meaningful to use this function on the service-side.'
1610 hint = 'Since this D-Bus property is writable, it is meaningful to use this function on both the client- and service-side.'
1612 print_error('Cannot handle property "{}" that neither readable nor writable'.format(p.name))
1613 self.outfile.write(self.docbook_gen.expand(
1615 ' * %s_set_%s: (skip)\n'
1616 ' * @object: A #%s.\n'
1617 ' * @value: The value to set.\n'
1619 ' * Sets the #%s:%s D-Bus property to @value.\n'
1622 %(i.name_lower, p.name_lower, i.camel_name, i.name, p.name, hint), False))
1623 self.write_gtkdoc_deprecated_and_since_and_close(p, self.outfile, 0)
1624 self.outfile.write('void\n'
1625 '%s_set_%s (%s *object, %svalue)\n'
1626 '{\n'%(i.name_lower, p.name_lower, i.camel_name, p.arg.ctype_in, ))
1627 self.outfile.write(' g_object_set (G_OBJECT (object), "%s", value, NULL);\n'%(p.name_hyphen))
1628 self.outfile.write('}\n')
1629 self.outfile.write('\n')
1631 # ---------------------------------------------------------------------------------------------------
1633 def generate_signal_emitters(self, i):
1635 self.outfile.write(self.docbook_gen.expand(
1638 ' * @object: A #%s.\n'
1639 %(i.name_lower, s.name_lower, i.camel_name), False))
1641 self.outfile.write(' * @arg_%s: Argument to pass with the signal.\n'%(a.name))
1642 self.outfile.write(self.docbook_gen.expand(
1644 ' * Emits the #%s::%s D-Bus signal.\n'
1645 %(i.name, s.name), False))
1646 self.write_gtkdoc_deprecated_and_since_and_close(s, self.outfile, 0)
1647 self.outfile.write('void\n'
1649 ' %s *object'%(i.name_lower, s.name_lower, i.camel_name))
1651 self.outfile.write(',\n %sarg_%s'%(a.ctype_in, a.name))
1652 self.outfile.write(')\n'
1654 ' g_signal_emit_by_name (object, "%s"'%(s.name_hyphen))
1656 self.outfile.write(', arg_%s'%a.name)
1657 self.outfile.write(');\n')
1658 self.outfile.write('}\n'
1661 # ---------------------------------------------------------------------------------------------------
1663 def generate_method_calls(self, i):
1666 if utils.lookup_annotation(m.annotations, 'org.gtk.GDBus.C.UnixFD'):
1669 self.outfile.write('/**\n'
1671 ' * @proxy: A #%sProxy.\n'
1672 %(i.name_lower, m.name_lower, i.camel_name))
1674 self.outfile.write(' * @arg_%s: Argument to pass with the method invocation.\n'%(a.name))
1676 self.outfile.write(' * @fd_list: (nullable): A #GUnixFDList or %NULL.\n')
1677 self.outfile.write(self.docbook_gen.expand(
1678 ' * @cancellable: (nullable): A #GCancellable or %%NULL.\n'
1679 ' * @callback: A #GAsyncReadyCallback to call when the request is satisfied or %%NULL.\n'
1680 ' * @user_data: User data to pass to @callback.\n'
1682 ' * Asynchronously invokes the %s.%s() D-Bus method on @proxy.\n'
1683 ' * 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'
1684 ' * You can then call %s_call_%s_finish() to get the result of the operation.\n'
1686 ' * See %s_call_%s_sync() for the synchronous, blocking version of this method.\n'
1687 %(i.name, m.name, i.name_lower, m.name_lower, i.name_lower, m.name_lower), False))
1688 self.write_gtkdoc_deprecated_and_since_and_close(m, self.outfile, 0)
1689 self.outfile.write('void\n'
1691 ' %s *proxy'%(i.name_lower, m.name_lower, i.camel_name))
1693 self.outfile.write(',\n %sarg_%s'%(a.ctype_in, a.name))
1695 self.outfile.write(',\n GUnixFDList *fd_list')
1696 self.outfile.write(',\n'
1697 ' GCancellable *cancellable,\n'
1698 ' GAsyncReadyCallback callback,\n'
1699 ' gpointer user_data)\n'
1702 self.outfile.write(' g_dbus_proxy_call_with_unix_fd_list (G_DBUS_PROXY (proxy),\n')
1704 self.outfile.write(' g_dbus_proxy_call (G_DBUS_PROXY (proxy),\n')
1705 self.outfile.write(' "%s",\n'
1706 ' g_variant_new ("('%(m.name))
1708 self.outfile.write('%s'%(a.format_in))
1709 self.outfile.write(')"')
1711 self.outfile.write(',\n arg_%s'%(a.name))
1712 self.outfile.write('),\n'
1713 ' G_DBUS_CALL_FLAGS_NONE,\n'
1716 self.outfile.write(' fd_list,\n')
1717 self.outfile.write(' cancellable,\n'
1720 self.outfile.write('}\n'
1723 self.outfile.write('/**\n'
1724 ' * %s_call_%s_finish:\n'
1725 ' * @proxy: A #%sProxy.\n'
1726 %(i.name_lower, m.name_lower, i.camel_name))
1727 for a in m.out_args:
1728 self.outfile.write(' * @out_%s: (out) (optional)%s: Return location for return parameter or %%NULL to ignore.\n'%(a.name, ' ' + a.array_annotation if a.array_annotation else ''))
1730 self.outfile.write(' * @out_fd_list: (out) (optional): Return location for a #GUnixFDList or %NULL to ignore.\n')
1731 self.outfile.write(self.docbook_gen.expand(
1732 ' * @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to %s_call_%s().\n'
1733 ' * @error: Return location for error or %%NULL.\n'
1735 ' * Finishes an operation started with %s_call_%s().\n'
1737 ' * Returns: (skip): %%TRUE if the call succeded, %%FALSE if @error is set.\n'
1738 %(i.name_lower, m.name_lower, i.name_lower, m.name_lower), False))
1739 self.write_gtkdoc_deprecated_and_since_and_close(m, self.outfile, 0)
1740 self.outfile.write('gboolean\n'
1741 '%s_call_%s_finish (\n'
1742 ' %s *proxy'%(i.name_lower, m.name_lower, i.camel_name))
1743 for a in m.out_args:
1744 self.outfile.write(',\n %sout_%s'%(a.ctype_out, a.name))
1746 self.outfile.write(',\n GUnixFDList **out_fd_list')
1747 self.outfile.write(',\n'
1748 ' GAsyncResult *res,\n'
1749 ' GError **error)\n'
1751 ' GVariant *_ret;\n')
1753 self.outfile.write(' _ret = g_dbus_proxy_call_with_unix_fd_list_finish (G_DBUS_PROXY (proxy), out_fd_list, res, error);\n')
1755 self.outfile.write(' _ret = g_dbus_proxy_call_finish (G_DBUS_PROXY (proxy), res, error);\n')
1756 self.outfile.write(' if (_ret == NULL)\n'
1758 self.outfile.write(' g_variant_get (_ret,\n'
1760 for a in m.out_args:
1761 self.outfile.write('%s'%(a.format_out))
1762 self.outfile.write(')"')
1763 for a in m.out_args:
1764 self.outfile.write(',\n out_%s'%(a.name))
1765 self.outfile.write(');\n'
1766 ' g_variant_unref (_ret);\n')
1767 self.outfile.write('_out:\n'
1768 ' return _ret != NULL;\n'
1774 self.outfile.write('/**\n'
1775 ' * %s_call_%s_sync:\n'
1776 ' * @proxy: A #%sProxy.\n'
1777 %(i.name_lower, m.name_lower, i.camel_name))
1779 self.outfile.write(' * @arg_%s: Argument to pass with the method invocation.\n'%(a.name))
1781 self.outfile.write(' * @fd_list: (nullable): A #GUnixFDList or %NULL.\n')
1782 for a in m.out_args:
1783 self.outfile.write(' * @out_%s: (out) (optional)%s: Return location for return parameter or %%NULL to ignore.\n'%(a.name, ' ' + a.array_annotation if a.array_annotation else ''))
1785 self.outfile.write(' * @out_fd_list: (out): Return location for a #GUnixFDList or %NULL.\n')
1786 self.outfile.write(self.docbook_gen.expand(
1787 ' * @cancellable: (nullable): A #GCancellable or %%NULL.\n'
1788 ' * @error: Return location for error or %%NULL.\n'
1790 ' * Synchronously invokes the %s.%s() D-Bus method on @proxy. The calling thread is blocked until a reply is received.\n'
1792 ' * See %s_call_%s() for the asynchronous version of this method.\n'
1794 ' * Returns: (skip): %%TRUE if the call succeded, %%FALSE if @error is set.\n'
1795 %(i.name, m.name, i.name_lower, m.name_lower), False))
1796 self.write_gtkdoc_deprecated_and_since_and_close(m, self.outfile, 0)
1797 self.outfile.write('gboolean\n'
1798 '%s_call_%s_sync (\n'
1799 ' %s *proxy'%(i.name_lower, m.name_lower, i.camel_name))
1801 self.outfile.write(',\n %sarg_%s'%(a.ctype_in, a.name))
1803 self.outfile.write(',\n GUnixFDList *fd_list')
1804 for a in m.out_args:
1805 self.outfile.write(',\n %sout_%s'%(a.ctype_out, a.name))
1807 self.outfile.write(',\n GUnixFDList **out_fd_list')
1808 self.outfile.write(',\n'
1809 ' GCancellable *cancellable,\n'
1810 ' GError **error)\n'
1812 ' GVariant *_ret;\n')
1814 self.outfile.write(' _ret = g_dbus_proxy_call_with_unix_fd_list_sync (G_DBUS_PROXY (proxy),\n')
1816 self.outfile.write(' _ret = g_dbus_proxy_call_sync (G_DBUS_PROXY (proxy),\n')
1817 self.outfile.write(' "%s",\n'
1818 ' g_variant_new ("('%(m.name))
1820 self.outfile.write('%s'%(a.format_in))
1821 self.outfile.write(')"')
1823 self.outfile.write(',\n arg_%s'%(a.name))
1824 self.outfile.write('),\n'
1825 ' G_DBUS_CALL_FLAGS_NONE,\n'
1828 self.outfile.write(' fd_list,\n'
1830 self.outfile.write(' cancellable,\n'
1832 ' if (_ret == NULL)\n'
1834 self.outfile.write(' g_variant_get (_ret,\n'
1836 for a in m.out_args:
1837 self.outfile.write('%s'%(a.format_out))
1838 self.outfile.write(')"')
1839 for a in m.out_args:
1840 self.outfile.write(',\n out_%s'%(a.name))
1841 self.outfile.write(');\n'
1842 ' g_variant_unref (_ret);\n')
1843 self.outfile.write('_out:\n'
1844 ' return _ret != NULL;\n'
1848 # ---------------------------------------------------------------------------------------------------
1850 def generate_method_completers(self, i):
1853 if utils.lookup_annotation(m.annotations, 'org.gtk.GDBus.C.UnixFD'):
1855 self.outfile.write('/**\n'
1856 ' * %s_complete_%s:\n'
1857 ' * @object: A #%s.\n'
1858 ' * @invocation: (transfer full): A #GDBusMethodInvocation.\n'
1859 %(i.name_lower, m.name_lower, i.camel_name))
1861 self.outfile.write(' * @fd_list: (nullable): A #GUnixFDList or %NULL.\n')
1862 for a in m.out_args:
1863 self.outfile.write(' * @%s: Parameter to return.\n'%(a.name))
1864 self.outfile.write(self.docbook_gen.expand(
1866 ' * 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'
1868 ' * This method will free @invocation, you cannot use it afterwards.\n'
1869 %(i.name, m.name), False))
1870 self.write_gtkdoc_deprecated_and_since_and_close(m, self.outfile, 0)
1871 self.outfile.write('void\n'
1872 '%s_complete_%s (\n'
1874 ' GDBusMethodInvocation *invocation'%(i.name_lower, m.name_lower, i.camel_name))
1876 self.outfile.write(',\n GUnixFDList *fd_list')
1877 for a in m.out_args:
1878 self.outfile.write(',\n %s%s'%(a.ctype_in, a.name))
1879 self.outfile.write(')\n'
1883 self.outfile.write(' g_dbus_method_invocation_return_value_with_unix_fd_list (invocation,\n'
1884 ' g_variant_new ("(')
1886 self.outfile.write(' g_dbus_method_invocation_return_value (invocation,\n'
1887 ' g_variant_new ("(')
1888 for a in m.out_args:
1889 self.outfile.write('%s'%(a.format_in))
1890 self.outfile.write(')"')
1891 for a in m.out_args:
1892 self.outfile.write(',\n %s'%(a.name))
1894 self.outfile.write('),\n fd_list);\n')
1896 self.outfile.write('));\n')
1897 self.outfile.write('}\n'
1900 # ---------------------------------------------------------------------------------------------------
1902 def generate_proxy(self, i):
1904 self.outfile.write('/* ------------------------------------------------------------------------ */\n'
1907 self.outfile.write(self.docbook_gen.expand(
1911 ' * The #%sProxy structure contains only private data and should only be accessed using the provided API.\n'
1912 %(i.camel_name, i.camel_name), False))
1913 self.write_gtkdoc_deprecated_and_since_and_close(i, self.outfile, 0)
1914 self.outfile.write('\n')
1916 self.outfile.write(self.docbook_gen.expand(
1918 ' * %sProxyClass:\n'
1919 ' * @parent_class: The parent class.\n'
1921 ' * Class structure for #%sProxy.\n'
1922 %(i.camel_name, i.camel_name), False))
1923 self.write_gtkdoc_deprecated_and_since_and_close(i, self.outfile, 0)
1924 self.outfile.write('\n')
1926 self.outfile.write('struct _%sProxyPrivate\n'
1932 self.outfile.write('static void %s_proxy_iface_init (%sIface *iface);\n'
1933 '\n'%(i.name_lower, i.camel_name))
1934 self.outfile.write('#if GLIB_VERSION_MAX_ALLOWED >= GLIB_VERSION_2_38\n')
1935 self.outfile.write('G_DEFINE_TYPE_WITH_CODE (%sProxy, %s_proxy, G_TYPE_DBUS_PROXY,\n'%(i.camel_name, i.name_lower))
1936 self.outfile.write(' G_ADD_PRIVATE (%sProxy)\n'%(i.camel_name))
1937 self.outfile.write(' G_IMPLEMENT_INTERFACE (%sTYPE_%s, %s_proxy_iface_init))\n\n'%(i.ns_upper, i.name_upper, i.name_lower))
1938 self.outfile.write('#else\n')
1939 self.outfile.write('G_DEFINE_TYPE_WITH_CODE (%sProxy, %s_proxy, G_TYPE_DBUS_PROXY,\n'%(i.camel_name, i.name_lower))
1940 self.outfile.write(' G_IMPLEMENT_INTERFACE (%sTYPE_%s, %s_proxy_iface_init))\n\n'%(i.ns_upper, i.name_upper, i.name_lower))
1941 self.outfile.write('#endif\n')
1944 self.outfile.write('static void\n'
1945 '%s_proxy_finalize (GObject *object)\n'
1946 '{\n'%(i.name_lower))
1947 self.outfile.write(' %sProxy *proxy = %s%s_PROXY (object);\n'%(i.camel_name, i.ns_upper, i.name_upper))
1948 self.outfile.write(' g_datalist_clear (&proxy->priv->qdata);\n')
1949 self.outfile.write(' G_OBJECT_CLASS (%s_proxy_parent_class)->finalize (object);\n'
1951 '\n'%(i.name_lower))
1953 # property accessors
1955 # Note that we are guaranteed that prop_id starts at 1 and is
1956 # laid out in the same order as introspection data pointers
1958 self.outfile.write('static void\n'
1959 '%s_proxy_get_property (GObject *object,\n'
1962 ' GParamSpec *pspec G_GNUC_UNUSED)\n'
1963 '{\n'%(i.name_lower))
1964 if len(i.properties) > 0:
1965 self.outfile.write(' const _ExtendedGDBusPropertyInfo *info;\n'
1966 ' GVariant *variant;\n'
1967 ' g_assert (prop_id != 0 && prop_id - 1 < %d);\n'
1968 ' info = (const _ExtendedGDBusPropertyInfo *) _%s_property_info_pointers[prop_id - 1];\n'
1969 ' variant = g_dbus_proxy_get_cached_property (G_DBUS_PROXY (object), info->parent_struct.name);\n'
1970 ' if (info->use_gvariant)\n'
1972 ' g_value_set_variant (value, variant);\n'
1976 # could be that we don't have the value in cache - in that case, we do
1977 # nothing and the user gets the default value for the GType
1978 ' if (variant != NULL)\n'
1979 ' g_dbus_gvariant_to_gvalue (variant, value);\n'
1981 ' if (variant != NULL)\n'
1982 ' g_variant_unref (variant);\n'
1983 %(len(i.properties), i.name_lower))
1984 self.outfile.write('}\n'
1986 if len(i.properties) > 0:
1987 self.outfile.write('static void\n'
1988 '%s_proxy_set_property_cb (GDBusProxy *proxy,\n'
1989 ' GAsyncResult *res,\n'
1990 ' gpointer user_data)\n'
1991 '{\n'%(i.name_lower))
1992 self.outfile.write(' const _ExtendedGDBusPropertyInfo *info = user_data;\n'
1994 ' GVariant *_ret;\n'
1996 ' _ret = g_dbus_proxy_call_finish (proxy, res, &error);\n'
1999 ' g_warning ("Error setting property \'%%s\' on interface %s: %%s (%%s, %%d)",\n'
2000 ' info->parent_struct.name, \n'
2001 ' error->message, g_quark_to_string (error->domain), error->code);\n'
2002 ' g_error_free (error);\n'
2006 ' g_variant_unref (_ret);\n'
2009 self.outfile.write('}\n'
2011 self.outfile.write('static void\n'
2012 '%s_proxy_set_property (GObject *object,\n'
2014 ' const GValue *value,\n'
2015 ' GParamSpec *pspec G_GNUC_UNUSED)\n'
2016 '{\n'%(i.name_lower))
2017 if len(i.properties) > 0:
2018 self.outfile.write(' const _ExtendedGDBusPropertyInfo *info;\n'
2019 ' GVariant *variant;\n'
2020 ' g_assert (prop_id != 0 && prop_id - 1 < %d);\n'
2021 ' info = (const _ExtendedGDBusPropertyInfo *) _%s_property_info_pointers[prop_id - 1];\n'
2022 ' variant = g_dbus_gvalue_to_gvariant (value, G_VARIANT_TYPE (info->parent_struct.signature));\n'
2023 ' g_dbus_proxy_call (G_DBUS_PROXY (object),\n'
2024 ' "org.freedesktop.DBus.Properties.Set",\n'
2025 ' g_variant_new ("(ssv)", "%s", info->parent_struct.name, variant),\n'
2026 ' G_DBUS_CALL_FLAGS_NONE,\n'
2028 ' NULL, (GAsyncReadyCallback) %s_proxy_set_property_cb, (GDBusPropertyInfo *) &info->parent_struct);\n'
2029 ' g_variant_unref (variant);\n'
2030 %(len(i.properties), i.name_lower, i.name, i.name_lower))
2031 self.outfile.write('}\n'
2035 self.outfile.write('static void\n'
2036 '%s_proxy_g_signal (GDBusProxy *proxy,\n'
2037 ' const gchar *sender_name G_GNUC_UNUSED,\n'
2038 ' const gchar *signal_name,\n'
2039 ' GVariant *parameters)\n'
2040 '{\n'%(i.name_lower))
2041 self.outfile.write(' _ExtendedGDBusSignalInfo *info;\n'
2042 ' GVariantIter iter;\n'
2043 ' GVariant *child;\n'
2044 ' GValue *paramv;\n'
2045 ' gsize num_params;\n'
2047 ' guint signal_id;\n');
2048 # Note: info could be NULL if we are talking to a newer version of the interface
2049 self.outfile.write(' info = (_ExtendedGDBusSignalInfo *) g_dbus_interface_info_lookup_signal ((GDBusInterfaceInfo *) &_%s_interface_info.parent_struct, signal_name);\n'
2050 ' if (info == NULL)\n'
2053 self.outfile.write(' num_params = g_variant_n_children (parameters);\n'
2054 ' paramv = g_new0 (GValue, num_params + 1);\n'
2055 ' g_value_init (¶mv[0], %sTYPE_%s);\n'
2056 ' g_value_set_object (¶mv[0], proxy);\n'
2057 %(i.ns_upper, i.name_upper))
2058 self.outfile.write(' g_variant_iter_init (&iter, parameters);\n'
2060 ' while ((child = g_variant_iter_next_value (&iter)) != NULL)\n'
2062 ' _ExtendedGDBusArgInfo *arg_info = (_ExtendedGDBusArgInfo *) info->parent_struct.args[n - 1];\n'
2063 ' if (arg_info->use_gvariant)\n'
2065 ' g_value_init (¶mv[n], G_TYPE_VARIANT);\n'
2066 ' g_value_set_variant (¶mv[n], child);\n'
2070 ' g_dbus_gvariant_to_gvalue (child, ¶mv[n++]);\n'
2071 ' g_variant_unref (child);\n'
2074 self.outfile.write(' signal_id = g_signal_lookup (info->signal_name, %sTYPE_%s);\n'
2075 %(i.ns_upper, i.name_upper))
2076 self.outfile.write(' g_signal_emitv (paramv, signal_id, 0, NULL);\n')
2077 self.outfile.write(' for (n = 0; n < num_params + 1; n++)\n'
2078 ' g_value_unset (¶mv[n]);\n'
2079 ' g_free (paramv);\n')
2080 self.outfile.write('}\n'
2084 self.outfile.write('static void\n'
2085 '%s_proxy_g_properties_changed (GDBusProxy *_proxy,\n'
2086 ' GVariant *changed_properties,\n'
2087 ' const gchar *const *invalidated_properties)\n'
2088 '{\n'%(i.name_lower))
2089 # Note: info could be NULL if we are talking to a newer version of the interface
2090 self.outfile.write(' %sProxy *proxy = %s%s_PROXY (_proxy);\n'
2092 ' const gchar *key;\n'
2093 ' GVariantIter *iter;\n'
2094 ' _ExtendedGDBusPropertyInfo *info;\n'
2095 ' g_variant_get (changed_properties, "a{sv}", &iter);\n'
2096 ' while (g_variant_iter_next (iter, "{&sv}", &key, NULL))\n'
2098 ' info = (_ExtendedGDBusPropertyInfo *) g_dbus_interface_info_lookup_property ((GDBusInterfaceInfo *) &_%s_interface_info.parent_struct, key);\n'
2099 ' g_datalist_remove_data (&proxy->priv->qdata, key);\n'
2100 ' if (info != NULL)\n'
2101 ' g_object_notify (G_OBJECT (proxy), info->hyphen_name);\n'
2103 ' g_variant_iter_free (iter);\n'
2104 ' for (n = 0; invalidated_properties[n] != NULL; n++)\n'
2106 ' info = (_ExtendedGDBusPropertyInfo *) g_dbus_interface_info_lookup_property ((GDBusInterfaceInfo *) &_%s_interface_info.parent_struct, invalidated_properties[n]);\n'
2107 ' g_datalist_remove_data (&proxy->priv->qdata, invalidated_properties[n]);\n'
2108 ' if (info != NULL)\n'
2109 ' g_object_notify (G_OBJECT (proxy), info->hyphen_name);\n'
2113 %(i.camel_name, i.ns_upper, i.name_upper,
2114 i.name_lower, i.name_lower))
2117 for p in i.properties:
2119 if p.arg.free_func != None:
2121 self.outfile.write('static %s\n'
2122 '%s_proxy_get_%s (%s *object)\n'
2124 ' %sProxy *proxy = %s%s_PROXY (object);\n'
2125 ' GVariant *variant;\n'
2126 ' %svalue = %s;\n'%(p.arg.ctype_in, i.name_lower, p.name_lower, i.camel_name,
2127 i.camel_name, i.ns_upper, i.name_upper,
2128 p.arg.ctype_in, nul_value))
2129 # For some property types, we have to free the returned
2130 # value (or part of it, e.g. the container) because of how
2131 # GVariant works.. see https://bugzilla.gnome.org/show_bug.cgi?id=657100
2134 free_container = False;
2135 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':
2136 free_container = True;
2137 # If already using an old value for strv, objv, bytestring_array (see below),
2138 # then just return that... that way the result from multiple consecutive calls
2139 # to the getter are valid as long as they're freed
2142 self.outfile.write(' value = g_datalist_get_data (&proxy->priv->qdata, \"%s\");\n'
2143 ' if (value != NULL)\n'
2146 self.outfile.write(' variant = g_dbus_proxy_get_cached_property (G_DBUS_PROXY (proxy), \"%s\");\n'%(p.name))
2147 if p.arg.gtype == 'G_TYPE_VARIANT':
2148 self.outfile.write(' value = variant;\n')
2149 self.outfile.write(' if (variant != NULL)\n')
2150 self.outfile.write(' g_variant_unref (variant);\n')
2152 self.outfile.write(' if (variant != NULL)\n'
2155 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':
2156 extra_len = ', NULL'
2157 self.outfile.write(' value = %s (variant%s);\n'%(p.arg.gvariant_get, extra_len))
2159 self.outfile.write(' g_datalist_set_data_full (&proxy->priv->qdata, \"%s\", (gpointer) value, g_free);\n'
2161 self.outfile.write(' g_variant_unref (variant);\n')
2162 self.outfile.write(' }\n')
2163 self.outfile.write(' return value;\n')
2164 self.outfile.write('}\n')
2165 self.outfile.write('\n')
2168 self.outfile.write('static void\n'
2169 '%s_proxy_init (%sProxy *proxy)\n'
2171 '#if GLIB_VERSION_MAX_ALLOWED >= GLIB_VERSION_2_38\n'
2172 ' proxy->priv = %s_proxy_get_instance_private (proxy);\n'
2174 ' proxy->priv = G_TYPE_INSTANCE_GET_PRIVATE (proxy, %sTYPE_%s_PROXY, %sProxyPrivate);\n'
2176 ' g_dbus_proxy_set_interface_info (G_DBUS_PROXY (proxy), %s_interface_info ());\n'
2179 %(i.name_lower, i.camel_name,
2181 i.ns_upper, i.name_upper, i.camel_name,
2183 self.outfile.write('static void\n'
2184 '%s_proxy_class_init (%sProxyClass *klass)\n'
2186 ' GObjectClass *gobject_class;\n'
2187 ' GDBusProxyClass *proxy_class;\n'
2189 ' gobject_class = G_OBJECT_CLASS (klass);\n'
2190 ' gobject_class->finalize = %s_proxy_finalize;\n'
2191 ' gobject_class->get_property = %s_proxy_get_property;\n'
2192 ' gobject_class->set_property = %s_proxy_set_property;\n'
2194 ' proxy_class = G_DBUS_PROXY_CLASS (klass);\n'
2195 ' proxy_class->g_signal = %s_proxy_g_signal;\n'
2196 ' proxy_class->g_properties_changed = %s_proxy_g_properties_changed;\n'
2197 '\n'%(i.name_lower, i.camel_name,
2198 i.name_lower, i.name_lower, i.name_lower, i.name_lower, i.name_lower))
2199 if len(i.properties) > 0:
2200 self.outfile.write(' %s_override_properties (gobject_class, 1);\n\n'%(i.name_lower))
2201 self.outfile.write('#if GLIB_VERSION_MAX_ALLOWED < GLIB_VERSION_2_38\n'
2202 ' g_type_class_add_private (klass, sizeof (%sProxyPrivate));\n'
2203 '#endif\n'%(i.camel_name))
2204 self.outfile.write('}\n'
2207 self.outfile.write('static void\n'
2208 '%s_proxy_iface_init (%sIface *iface)\n'
2209 '{\n'%(i.name_lower, i.camel_name))
2210 for p in i.properties:
2211 self.outfile.write(' iface->get_%s = %s_proxy_get_%s;\n'%(p.name_lower, i.name_lower, p.name_lower))
2212 self.outfile.write('}\n'
2216 self.outfile.write(self.docbook_gen.expand(
2218 ' * %s_proxy_new:\n'
2219 ' * @connection: A #GDBusConnection.\n'
2220 ' * @flags: Flags from the #GDBusProxyFlags enumeration.\n'
2221 ' * @name: (nullable): A bus name (well-known or unique) or %%NULL if @connection is not a message bus connection.\n'
2222 ' * @object_path: An object path.\n'
2223 ' * @cancellable: (nullable): A #GCancellable or %%NULL.\n'
2224 ' * @callback: A #GAsyncReadyCallback to call when the request is satisfied.\n'
2225 ' * @user_data: User data to pass to @callback.\n'
2227 ' * Asynchronously creates a proxy for the D-Bus interface #%s. See g_dbus_proxy_new() for more details.\n'
2229 ' * 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'
2230 ' * You can then call %s_proxy_new_finish() to get the result of the operation.\n'
2232 ' * See %s_proxy_new_sync() for the synchronous, blocking version of this constructor.\n'
2233 %(i.name_lower, i.name, i.name_lower, i.name_lower), False))
2234 self.write_gtkdoc_deprecated_and_since_and_close(i, self.outfile, 0)
2235 self.outfile.write('void\n'
2237 ' GDBusConnection *connection,\n'
2238 ' GDBusProxyFlags flags,\n'
2239 ' const gchar *name,\n'
2240 ' const gchar *object_path,\n'
2241 ' GCancellable *cancellable,\n'
2242 ' GAsyncReadyCallback callback,\n'
2243 ' gpointer user_data)\n'
2245 ' 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'
2248 %(i.name_lower, i.ns_upper, i.name_upper, i.name))
2249 self.outfile.write('/**\n'
2250 ' * %s_proxy_new_finish:\n'
2251 ' * @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to %s_proxy_new().\n'
2252 ' * @error: Return location for error or %%NULL\n'
2254 ' * Finishes an operation started with %s_proxy_new().\n'
2256 ' * Returns: (transfer full) (type %sProxy): The constructed proxy object or %%NULL if @error is set.\n'
2257 %(i.name_lower, i.name_lower, i.name_lower, i.camel_name))
2258 self.write_gtkdoc_deprecated_and_since_and_close(i, self.outfile, 0)
2259 self.outfile.write('%s *\n'
2260 '%s_proxy_new_finish (\n'
2261 ' GAsyncResult *res,\n'
2262 ' GError **error)\n'
2265 ' GObject *source_object;\n'
2266 ' source_object = g_async_result_get_source_object (res);\n'
2267 ' ret = g_async_initable_new_finish (G_ASYNC_INITABLE (source_object), res, error);\n'
2268 ' g_object_unref (source_object);\n'
2269 ' if (ret != NULL)\n'
2270 ' return %s%s (ret);\n'
2275 %(i.camel_name, i.name_lower, i.ns_upper, i.name_upper))
2276 self.outfile.write(self.docbook_gen.expand(
2278 ' * %s_proxy_new_sync:\n'
2279 ' * @connection: A #GDBusConnection.\n'
2280 ' * @flags: Flags from the #GDBusProxyFlags enumeration.\n'
2281 ' * @name: (nullable): A bus name (well-known or unique) or %%NULL if @connection is not a message bus connection.\n'
2282 ' * @object_path: An object path.\n'
2283 ' * @cancellable: (nullable): A #GCancellable or %%NULL.\n'
2284 ' * @error: Return location for error or %%NULL\n'
2286 ' * Synchronously creates a proxy for the D-Bus interface #%s. See g_dbus_proxy_new_sync() for more details.\n'
2288 ' * The calling thread is blocked until a reply is received.\n'
2290 ' * See %s_proxy_new() for the asynchronous version of this constructor.\n'
2292 ' * Returns: (transfer full) (type %sProxy): The constructed proxy object or %%NULL if @error is set.\n'
2293 %(i.name_lower, i.name, i.name_lower, i.camel_name), False))
2294 self.write_gtkdoc_deprecated_and_since_and_close(i, self.outfile, 0)
2295 self.outfile.write('%s *\n'
2296 '%s_proxy_new_sync (\n'
2297 ' GDBusConnection *connection,\n'
2298 ' GDBusProxyFlags flags,\n'
2299 ' const gchar *name,\n'
2300 ' const gchar *object_path,\n'
2301 ' GCancellable *cancellable,\n'
2302 ' GError **error)\n'
2304 ' GInitable *ret;\n'
2305 ' 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'
2306 ' if (ret != NULL)\n'
2307 ' return %s%s (ret);\n'
2312 %(i.camel_name, i.name_lower, i.ns_upper, i.name_upper, i.name, i.ns_upper, i.name_upper))
2313 self.outfile.write('\n')
2314 self.outfile.write(self.docbook_gen.expand(
2316 ' * %s_proxy_new_for_bus:\n'
2317 ' * @bus_type: A #GBusType.\n'
2318 ' * @flags: Flags from the #GDBusProxyFlags enumeration.\n'
2319 ' * @name: A bus name (well-known or unique).\n'
2320 ' * @object_path: An object path.\n'
2321 ' * @cancellable: (nullable): A #GCancellable or %%NULL.\n'
2322 ' * @callback: A #GAsyncReadyCallback to call when the request is satisfied.\n'
2323 ' * @user_data: User data to pass to @callback.\n'
2325 ' * Like %s_proxy_new() but takes a #GBusType instead of a #GDBusConnection.\n'
2327 ' * 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'
2328 ' * You can then call %s_proxy_new_for_bus_finish() to get the result of the operation.\n'
2330 ' * See %s_proxy_new_for_bus_sync() for the synchronous, blocking version of this constructor.\n'
2331 %(i.name_lower, i.name_lower, i.name_lower, i.name_lower), False))
2332 self.write_gtkdoc_deprecated_and_since_and_close(i, self.outfile, 0)
2333 self.outfile.write('void\n'
2334 '%s_proxy_new_for_bus (\n'
2335 ' GBusType bus_type,\n'
2336 ' GDBusProxyFlags flags,\n'
2337 ' const gchar *name,\n'
2338 ' const gchar *object_path,\n'
2339 ' GCancellable *cancellable,\n'
2340 ' GAsyncReadyCallback callback,\n'
2341 ' gpointer user_data)\n'
2343 ' 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'
2346 %(i.name_lower, i.ns_upper, i.name_upper, i.name))
2347 self.outfile.write('/**\n'
2348 ' * %s_proxy_new_for_bus_finish:\n'
2349 ' * @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to %s_proxy_new_for_bus().\n'
2350 ' * @error: Return location for error or %%NULL\n'
2352 ' * Finishes an operation started with %s_proxy_new_for_bus().\n'
2354 ' * Returns: (transfer full) (type %sProxy): The constructed proxy object or %%NULL if @error is set.\n'
2355 %(i.name_lower, i.name_lower, i.name_lower, i.camel_name))
2356 self.write_gtkdoc_deprecated_and_since_and_close(i, self.outfile, 0)
2357 self.outfile.write('%s *\n'
2358 '%s_proxy_new_for_bus_finish (\n'
2359 ' GAsyncResult *res,\n'
2360 ' GError **error)\n'
2363 ' GObject *source_object;\n'
2364 ' source_object = g_async_result_get_source_object (res);\n'
2365 ' ret = g_async_initable_new_finish (G_ASYNC_INITABLE (source_object), res, error);\n'
2366 ' g_object_unref (source_object);\n'
2367 ' if (ret != NULL)\n'
2368 ' return %s%s (ret);\n'
2373 %(i.camel_name, i.name_lower, i.ns_upper, i.name_upper))
2374 self.outfile.write(self.docbook_gen.expand(
2376 ' * %s_proxy_new_for_bus_sync:\n'
2377 ' * @bus_type: A #GBusType.\n'
2378 ' * @flags: Flags from the #GDBusProxyFlags enumeration.\n'
2379 ' * @name: A bus name (well-known or unique).\n'
2380 ' * @object_path: An object path.\n'
2381 ' * @cancellable: (nullable): A #GCancellable or %%NULL.\n'
2382 ' * @error: Return location for error or %%NULL\n'
2384 ' * Like %s_proxy_new_sync() but takes a #GBusType instead of a #GDBusConnection.\n'
2386 ' * The calling thread is blocked until a reply is received.\n'
2388 ' * See %s_proxy_new_for_bus() for the asynchronous version of this constructor.\n'
2390 ' * Returns: (transfer full) (type %sProxy): The constructed proxy object or %%NULL if @error is set.\n'
2391 %(i.name_lower, i.name_lower, i.name_lower, i.camel_name), False))
2392 self.write_gtkdoc_deprecated_and_since_and_close(i, self.outfile, 0)
2393 self.outfile.write('%s *\n'
2394 '%s_proxy_new_for_bus_sync (\n'
2395 ' GBusType bus_type,\n'
2396 ' GDBusProxyFlags flags,\n'
2397 ' const gchar *name,\n'
2398 ' const gchar *object_path,\n'
2399 ' GCancellable *cancellable,\n'
2400 ' GError **error)\n'
2402 ' GInitable *ret;\n'
2403 ' 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'
2404 ' if (ret != NULL)\n'
2405 ' return %s%s (ret);\n'
2410 %(i.camel_name, i.name_lower, i.ns_upper, i.name_upper, i.name, i.ns_upper, i.name_upper))
2411 self.outfile.write('\n')
2413 # ---------------------------------------------------------------------------------------------------
2415 def generate_skeleton(self, i):
2417 self.outfile.write('/* ------------------------------------------------------------------------ */\n'
2420 self.outfile.write(self.docbook_gen.expand(
2424 ' * The #%sSkeleton structure contains only private data and should only be accessed using the provided API.\n'
2425 %(i.camel_name, i.camel_name), False))
2426 self.write_gtkdoc_deprecated_and_since_and_close(i, self.outfile, 0)
2427 self.outfile.write('\n')
2429 self.outfile.write(self.docbook_gen.expand(
2431 ' * %sSkeletonClass:\n'
2432 ' * @parent_class: The parent class.\n'
2434 ' * Class structure for #%sSkeleton.\n'
2435 %(i.camel_name, i.camel_name), False))
2436 self.write_gtkdoc_deprecated_and_since_and_close(i, self.outfile, 0)
2437 self.outfile.write('\n')
2439 self.outfile.write('struct _%sSkeletonPrivate\n'
2441 ' GValue *properties;\n'
2442 ' GList *changed_properties;\n'
2443 ' GSource *changed_properties_idle_source;\n'
2444 ' GMainContext *context;\n'
2449 self.outfile.write('static void\n'
2450 '_%s_skeleton_handle_method_call (\n'
2451 ' GDBusConnection *connection G_GNUC_UNUSED,\n'
2452 ' const gchar *sender G_GNUC_UNUSED,\n'
2453 ' const gchar *object_path G_GNUC_UNUSED,\n'
2454 ' const gchar *interface_name,\n'
2455 ' const gchar *method_name,\n'
2456 ' GVariant *parameters,\n'
2457 ' GDBusMethodInvocation *invocation,\n'
2458 ' gpointer user_data)\n'
2460 ' %sSkeleton *skeleton = %s%s_SKELETON (user_data);\n'
2461 ' _ExtendedGDBusMethodInfo *info;\n'
2462 ' GVariantIter iter;\n'
2463 ' GVariant *child;\n'
2464 ' GValue *paramv;\n'
2465 ' gsize num_params;\n'
2466 ' guint num_extra;\n'
2468 ' guint signal_id;\n'
2469 ' GValue return_value = G_VALUE_INIT;\n'
2470 %(i.name_lower, i.camel_name, i.ns_upper, i.name_upper))
2471 self.outfile.write(' info = (_ExtendedGDBusMethodInfo *) g_dbus_method_invocation_get_method_info (invocation);\n'
2472 ' g_assert (info != NULL);\n'
2474 self.outfile.write(' num_params = g_variant_n_children (parameters);\n'
2475 ' num_extra = info->pass_fdlist ? 3 : 2;'
2476 ' paramv = g_new0 (GValue, num_params + num_extra);\n'
2478 ' g_value_init (¶mv[n], %sTYPE_%s);\n'
2479 ' g_value_set_object (¶mv[n++], skeleton);\n'
2480 ' g_value_init (¶mv[n], G_TYPE_DBUS_METHOD_INVOCATION);\n'
2481 ' g_value_set_object (¶mv[n++], invocation);\n'
2482 ' if (info->pass_fdlist)\n'
2484 '#ifdef G_OS_UNIX\n'
2485 ' g_value_init (¶mv[n], G_TYPE_UNIX_FD_LIST);\n'
2486 ' g_value_set_object (¶mv[n++], g_dbus_message_get_unix_fd_list (g_dbus_method_invocation_get_message (invocation)));\n'
2488 ' g_assert_not_reached ();\n'
2491 %(i.ns_upper, i.name_upper))
2492 self.outfile.write(' g_variant_iter_init (&iter, parameters);\n'
2493 ' while ((child = g_variant_iter_next_value (&iter)) != NULL)\n'
2495 ' _ExtendedGDBusArgInfo *arg_info = (_ExtendedGDBusArgInfo *) info->parent_struct.in_args[n - num_extra];\n'
2496 ' if (arg_info->use_gvariant)\n'
2498 ' g_value_init (¶mv[n], G_TYPE_VARIANT);\n'
2499 ' g_value_set_variant (¶mv[n], child);\n'
2503 ' g_dbus_gvariant_to_gvalue (child, ¶mv[n++]);\n'
2504 ' g_variant_unref (child);\n'
2506 self.outfile.write(' signal_id = g_signal_lookup (info->signal_name, %sTYPE_%s);\n'
2507 %(i.ns_upper, i.name_upper))
2508 self.outfile.write(' g_value_init (&return_value, G_TYPE_BOOLEAN);\n'
2509 ' g_signal_emitv (paramv, signal_id, 0, &return_value);\n'
2510 ' if (!g_value_get_boolean (&return_value))\n'
2511 ' 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'
2512 ' g_value_unset (&return_value);\n')
2513 self.outfile.write(' for (n = 0; n < num_params + num_extra; n++)\n'
2514 ' g_value_unset (¶mv[n]);\n'
2515 ' g_free (paramv);\n')
2516 self.outfile.write('}\n'
2519 self.outfile.write('static GVariant *\n'
2520 '_%s_skeleton_handle_get_property (\n'
2521 ' GDBusConnection *connection G_GNUC_UNUSED,\n'
2522 ' const gchar *sender G_GNUC_UNUSED,\n'
2523 ' const gchar *object_path G_GNUC_UNUSED,\n'
2524 ' const gchar *interface_name G_GNUC_UNUSED,\n'
2525 ' const gchar *property_name,\n'
2526 ' GError **error,\n'
2527 ' gpointer user_data)\n'
2529 ' %sSkeleton *skeleton = %s%s_SKELETON (user_data);\n'
2530 ' GValue value = G_VALUE_INIT;\n'
2531 ' GParamSpec *pspec;\n'
2532 ' _ExtendedGDBusPropertyInfo *info;\n'
2534 %(i.name_lower, i.camel_name, i.ns_upper, i.name_upper))
2535 self.outfile.write(' ret = NULL;\n'
2536 ' info = (_ExtendedGDBusPropertyInfo *) g_dbus_interface_info_lookup_property ((GDBusInterfaceInfo *) &_%s_interface_info.parent_struct, property_name);\n'
2537 ' g_assert (info != NULL);\n'
2538 ' pspec = g_object_class_find_property (G_OBJECT_GET_CLASS (skeleton), info->hyphen_name);\n'
2539 ' if (pspec == NULL)\n'
2541 ' g_set_error (error, G_DBUS_ERROR, G_DBUS_ERROR_INVALID_ARGS, "No property with name %%s", property_name);\n'
2545 ' g_value_init (&value, pspec->value_type);\n'
2546 ' g_object_get_property (G_OBJECT (skeleton), info->hyphen_name, &value);\n'
2547 ' ret = g_dbus_gvalue_to_gvariant (&value, G_VARIANT_TYPE (info->parent_struct.signature));\n'
2548 ' g_value_unset (&value);\n'
2555 self.outfile.write('static gboolean\n'
2556 '_%s_skeleton_handle_set_property (\n'
2557 ' GDBusConnection *connection G_GNUC_UNUSED,\n'
2558 ' const gchar *sender G_GNUC_UNUSED,\n'
2559 ' const gchar *object_path G_GNUC_UNUSED,\n'
2560 ' const gchar *interface_name G_GNUC_UNUSED,\n'
2561 ' const gchar *property_name,\n'
2562 ' GVariant *variant,\n'
2563 ' GError **error,\n'
2564 ' gpointer user_data)\n'
2566 ' %sSkeleton *skeleton = %s%s_SKELETON (user_data);\n'
2567 ' GValue value = G_VALUE_INIT;\n'
2568 ' GParamSpec *pspec;\n'
2569 ' _ExtendedGDBusPropertyInfo *info;\n'
2571 %(i.name_lower, i.camel_name, i.ns_upper, i.name_upper))
2572 self.outfile.write(' ret = FALSE;\n'
2573 ' info = (_ExtendedGDBusPropertyInfo *) g_dbus_interface_info_lookup_property ((GDBusInterfaceInfo *) &_%s_interface_info.parent_struct, property_name);\n'
2574 ' g_assert (info != NULL);\n'
2575 ' pspec = g_object_class_find_property (G_OBJECT_GET_CLASS (skeleton), info->hyphen_name);\n'
2576 ' if (pspec == NULL)\n'
2578 ' g_set_error (error, G_DBUS_ERROR, G_DBUS_ERROR_INVALID_ARGS, "No property with name %%s", property_name);\n'
2582 ' if (info->use_gvariant)\n'
2583 ' g_value_set_variant (&value, variant);\n'
2585 ' g_dbus_gvariant_to_gvalue (variant, &value);\n'
2586 ' g_object_set_property (G_OBJECT (skeleton), info->hyphen_name, &value);\n'
2587 ' g_value_unset (&value);\n'
2596 self.outfile.write('static const GDBusInterfaceVTable _%s_skeleton_vtable =\n'
2598 ' _%s_skeleton_handle_method_call,\n'
2599 ' _%s_skeleton_handle_get_property,\n'
2600 ' _%s_skeleton_handle_set_property,\n'
2603 '\n'%(i.name_lower, i.name_lower, i.name_lower, i.name_lower))
2605 self.outfile.write('static GDBusInterfaceInfo *\n'
2606 '%s_skeleton_dbus_interface_get_info (GDBusInterfaceSkeleton *skeleton G_GNUC_UNUSED)\n'
2608 ' return %s_interface_info ();\n'
2609 %(i.name_lower, i.name_lower))
2610 self.outfile.write('}\n'
2613 self.outfile.write('static GDBusInterfaceVTable *\n'
2614 '%s_skeleton_dbus_interface_get_vtable (GDBusInterfaceSkeleton *skeleton G_GNUC_UNUSED)\n'
2616 ' return (GDBusInterfaceVTable *) &_%s_skeleton_vtable;\n'
2617 %(i.name_lower, i.name_lower))
2618 self.outfile.write('}\n'
2621 self.outfile.write('static GVariant *\n'
2622 '%s_skeleton_dbus_interface_get_properties (GDBusInterfaceSkeleton *_skeleton)\n'
2624 ' %sSkeleton *skeleton = %s%s_SKELETON (_skeleton);\n'
2625 %(i.name_lower, i.camel_name, i.ns_upper, i.name_upper))
2626 self.outfile.write('\n'
2627 ' GVariantBuilder builder;\n'
2629 ' g_variant_builder_init (&builder, G_VARIANT_TYPE ("a{sv}"));\n'
2630 ' if (_%s_interface_info.parent_struct.properties == NULL)\n'
2632 ' for (n = 0; _%s_interface_info.parent_struct.properties[n] != NULL; n++)\n'
2634 ' GDBusPropertyInfo *info = _%s_interface_info.parent_struct.properties[n];\n'
2635 ' if (info->flags & G_DBUS_PROPERTY_INFO_FLAGS_READABLE)\n'
2637 ' GVariant *value;\n'
2638 ' 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'
2639 ' if (value != NULL)\n'
2641 ' g_variant_take_ref (value);\n'
2642 ' g_variant_builder_add (&builder, "{sv}", info->name, value);\n'
2643 ' g_variant_unref (value);\n'
2648 ' return g_variant_builder_end (&builder);\n'
2651 %(i.name_lower, i.name_lower, i.name_lower, i.name_lower, i.name))
2653 if len(i.properties) > 0:
2654 self.outfile.write('static gboolean _%s_emit_changed (gpointer user_data);\n'
2658 self.outfile.write('static void\n'
2659 '%s_skeleton_dbus_interface_flush (GDBusInterfaceSkeleton *_skeleton)\n'
2662 if len(i.properties) > 0:
2663 self.outfile.write(' %sSkeleton *skeleton = %s%s_SKELETON (_skeleton);\n'
2664 ' gboolean emit_changed = FALSE;\n'
2666 ' g_mutex_lock (&skeleton->priv->lock);\n'
2667 ' if (skeleton->priv->changed_properties_idle_source != NULL)\n'
2669 ' g_source_destroy (skeleton->priv->changed_properties_idle_source);\n'
2670 ' skeleton->priv->changed_properties_idle_source = NULL;\n'
2671 ' emit_changed = TRUE;\n'
2673 ' g_mutex_unlock (&skeleton->priv->lock);\n'
2675 ' if (emit_changed)\n'
2676 ' _%s_emit_changed (skeleton);\n'
2677 %(i.camel_name, i.ns_upper, i.name_upper, i.name_lower))
2678 self.outfile.write('}\n'
2682 self.outfile.write('static void\n'
2683 '_%s_on_signal_%s (\n'
2684 ' %s *object'%(i.name_lower, s.name_lower, i.camel_name))
2686 self.outfile.write(',\n %sarg_%s'%(a.ctype_in, a.name))
2687 self.outfile.write(')\n'
2689 ' %sSkeleton *skeleton = %s%s_SKELETON (object);\n\n'
2690 ' GList *connections, *l;\n'
2691 ' GVariant *signal_variant;\n'
2692 ' connections = g_dbus_interface_skeleton_get_connections (G_DBUS_INTERFACE_SKELETON (skeleton));\n'
2693 %(i.camel_name, i.ns_upper, i.name_upper))
2694 self.outfile.write('\n'
2695 ' signal_variant = g_variant_ref_sink (g_variant_new ("(')
2697 self.outfile.write('%s'%(a.format_in))
2698 self.outfile.write(')"')
2700 self.outfile.write(',\n arg_%s'%(a.name))
2701 self.outfile.write('));\n')
2703 self.outfile.write(' for (l = connections; l != NULL; l = l->next)\n'
2705 ' GDBusConnection *connection = l->data;\n'
2706 ' g_dbus_connection_emit_signal (connection,\n'
2707 ' NULL, g_dbus_interface_skeleton_get_object_path (G_DBUS_INTERFACE_SKELETON (skeleton)), "%s", "%s",\n'
2708 ' signal_variant, NULL);\n'
2711 self.outfile.write(' g_variant_unref (signal_variant);\n')
2712 self.outfile.write(' g_list_free_full (connections, g_object_unref);\n')
2713 self.outfile.write('}\n'
2716 self.outfile.write('static void %s_skeleton_iface_init (%sIface *iface);\n'
2717 %(i.name_lower, i.camel_name))
2719 self.outfile.write('#if GLIB_VERSION_MAX_ALLOWED >= GLIB_VERSION_2_38\n')
2720 self.outfile.write('G_DEFINE_TYPE_WITH_CODE (%sSkeleton, %s_skeleton, G_TYPE_DBUS_INTERFACE_SKELETON,\n'%(i.camel_name, i.name_lower))
2721 self.outfile.write(' G_ADD_PRIVATE (%sSkeleton)\n'%(i.camel_name))
2722 self.outfile.write(' G_IMPLEMENT_INTERFACE (%sTYPE_%s, %s_skeleton_iface_init))\n\n'%(i.ns_upper, i.name_upper, i.name_lower))
2723 self.outfile.write('#else\n')
2724 self.outfile.write('G_DEFINE_TYPE_WITH_CODE (%sSkeleton, %s_skeleton, G_TYPE_DBUS_INTERFACE_SKELETON,\n'%(i.camel_name, i.name_lower))
2725 self.outfile.write(' G_IMPLEMENT_INTERFACE (%sTYPE_%s, %s_skeleton_iface_init))\n\n'%(i.ns_upper, i.name_upper, i.name_lower))
2726 self.outfile.write('#endif\n')
2729 self.outfile.write('static void\n'
2730 '%s_skeleton_finalize (GObject *object)\n'
2731 '{\n'%(i.name_lower))
2732 self.outfile.write(' %sSkeleton *skeleton = %s%s_SKELETON (object);\n'%(i.camel_name, i.ns_upper, i.name_upper))
2733 if len(i.properties) > 0:
2734 self.outfile.write(' guint n;\n'
2735 ' for (n = 0; n < %d; n++)\n'
2736 ' g_value_unset (&skeleton->priv->properties[n]);\n'%(len(i.properties)))
2737 self.outfile.write(' g_free (skeleton->priv->properties);\n')
2738 self.outfile.write(' g_list_free_full (skeleton->priv->changed_properties, (GDestroyNotify) _changed_property_free);\n')
2739 self.outfile.write(' if (skeleton->priv->changed_properties_idle_source != NULL)\n')
2740 self.outfile.write(' g_source_destroy (skeleton->priv->changed_properties_idle_source);\n')
2741 self.outfile.write(' g_main_context_unref (skeleton->priv->context);\n')
2742 self.outfile.write(' g_mutex_clear (&skeleton->priv->lock);\n')
2743 self.outfile.write(' G_OBJECT_CLASS (%s_skeleton_parent_class)->finalize (object);\n'
2745 '\n'%(i.name_lower))
2747 # property accessors (TODO: generate PropertiesChanged signals in setter)
2748 if len(i.properties) > 0:
2749 self.outfile.write('static void\n'
2750 '%s_skeleton_get_property (GObject *object,\n'
2753 ' GParamSpec *pspec G_GNUC_UNUSED)\n'
2754 '{\n'%(i.name_lower))
2755 self.outfile.write(' %sSkeleton *skeleton = %s%s_SKELETON (object);\n'
2756 ' g_assert (prop_id != 0 && prop_id - 1 < %d);\n'
2757 ' g_mutex_lock (&skeleton->priv->lock);\n'
2758 ' g_value_copy (&skeleton->priv->properties[prop_id - 1], value);\n'
2759 ' g_mutex_unlock (&skeleton->priv->lock);\n'
2760 %(i.camel_name, i.ns_upper, i.name_upper, len(i.properties)))
2761 self.outfile.write('}\n'
2764 # if property is already scheduled then re-use entry.. though it could be
2767 # foo_set_prop_bar (object, "");
2768 # foo_set_prop_bar (object, "blah");
2770 # say, every update... In this case, where nothing happens, we obviously
2771 # don't want a PropertiesChanged() event. We can easily check for this
2772 # by comparing against the _original value_ recorded before the first
2773 # change event. If the latest value is not different from the original
2774 # one, we can simply ignore the ChangedProperty
2776 self.outfile.write('static gboolean\n'
2777 '_%s_emit_changed (gpointer user_data)\n'
2779 ' %sSkeleton *skeleton = %s%s_SKELETON (user_data);\n'
2780 %(i.name_lower, i.camel_name, i.ns_upper, i.name_upper))
2781 self.outfile.write(' GList *l;\n'
2782 ' GVariantBuilder builder;\n'
2783 ' GVariantBuilder invalidated_builder;\n'
2784 ' guint num_changes;\n'
2786 ' g_mutex_lock (&skeleton->priv->lock);\n'
2787 ' g_variant_builder_init (&builder, G_VARIANT_TYPE ("a{sv}"));\n'
2788 ' g_variant_builder_init (&invalidated_builder, G_VARIANT_TYPE ("as"));\n'
2789 ' for (l = skeleton->priv->changed_properties, num_changes = 0; l != NULL; l = l->next)\n'
2791 ' ChangedProperty *cp = l->data;\n'
2792 ' GVariant *variant;\n'
2793 ' const GValue *cur_value;\n'
2795 ' cur_value = &skeleton->priv->properties[cp->prop_id - 1];\n'
2796 ' if (!_g_value_equal (cur_value, &cp->orig_value))\n'
2798 ' variant = g_dbus_gvalue_to_gvariant (cur_value, G_VARIANT_TYPE (cp->info->parent_struct.signature));\n'
2799 ' g_variant_builder_add (&builder, "{sv}", cp->info->parent_struct.name, variant);\n'
2800 ' g_variant_unref (variant);\n'
2804 ' if (num_changes > 0)\n'
2806 ' GList *connections, *ll;\n'
2807 ' GVariant *signal_variant;'
2809 ' signal_variant = g_variant_ref_sink (g_variant_new ("(sa{sv}as)", "%s",\n'
2810 ' &builder, &invalidated_builder));\n'
2811 ' connections = g_dbus_interface_skeleton_get_connections (G_DBUS_INTERFACE_SKELETON (skeleton));\n'
2812 ' for (ll = connections; ll != NULL; ll = ll->next)\n'
2814 ' GDBusConnection *connection = ll->data;\n'
2816 ' g_dbus_connection_emit_signal (connection,\n'
2817 ' NULL, g_dbus_interface_skeleton_get_object_path (G_DBUS_INTERFACE_SKELETON (skeleton)),\n'
2818 ' "org.freedesktop.DBus.Properties",\n'
2819 ' "PropertiesChanged",\n'
2820 ' signal_variant,\n'
2823 ' g_variant_unref (signal_variant);\n'
2824 ' g_list_free_full (connections, g_object_unref);\n'
2828 ' g_variant_builder_clear (&builder);\n'
2829 ' g_variant_builder_clear (&invalidated_builder);\n'
2832 self.outfile.write(' g_list_free_full (skeleton->priv->changed_properties, (GDestroyNotify) _changed_property_free);\n')
2833 self.outfile.write(' skeleton->priv->changed_properties = NULL;\n')
2834 self.outfile.write(' skeleton->priv->changed_properties_idle_source = NULL;\n')
2835 self.outfile.write(' g_mutex_unlock (&skeleton->priv->lock);\n')
2836 self.outfile.write(' return FALSE;\n'
2839 # holding lock while being called
2840 self.outfile.write('static void\n'
2841 '_%s_schedule_emit_changed (%sSkeleton *skeleton, const _ExtendedGDBusPropertyInfo *info, guint prop_id, const GValue *orig_value)\n'
2843 ' ChangedProperty *cp;\n'
2846 ' for (l = skeleton->priv->changed_properties; l != NULL; l = l->next)\n'
2848 ' ChangedProperty *i_cp = l->data;\n'
2849 ' if (i_cp->info == info)\n'
2855 %(i.name_lower, i.camel_name))
2856 self.outfile.write(' if (cp == NULL)\n'
2858 ' cp = g_new0 (ChangedProperty, 1);\n'
2859 ' cp->prop_id = prop_id;\n'
2860 ' cp->info = info;\n'
2861 ' skeleton->priv->changed_properties = g_list_prepend (skeleton->priv->changed_properties, cp);\n'
2862 ' g_value_init (&cp->orig_value, G_VALUE_TYPE (orig_value));\n'
2863 ' g_value_copy (orig_value, &cp->orig_value);\n'
2869 # Postpone setting up the refresh source until the ::notify signal is emitted as
2870 # this allows use of g_object_freeze_notify()/g_object_thaw_notify() ...
2871 # This is useful when updating several properties from another thread than
2872 # where the idle will be emitted from
2873 self.outfile.write('static void\n'
2874 '%s_skeleton_notify (GObject *object,\n'
2875 ' GParamSpec *pspec G_GNUC_UNUSED)\n'
2877 ' %sSkeleton *skeleton = %s%s_SKELETON (object);\n'
2878 ' g_mutex_lock (&skeleton->priv->lock);\n'
2879 ' if (skeleton->priv->changed_properties != NULL &&\n'
2880 ' skeleton->priv->changed_properties_idle_source == NULL)\n'
2882 ' skeleton->priv->changed_properties_idle_source = g_idle_source_new ();\n'
2883 ' g_source_set_priority (skeleton->priv->changed_properties_idle_source, G_PRIORITY_DEFAULT);\n'
2884 ' g_source_set_callback (skeleton->priv->changed_properties_idle_source, _%s_emit_changed, g_object_ref (skeleton), (GDestroyNotify) g_object_unref);\n'
2885 ' g_source_set_name (skeleton->priv->changed_properties_idle_source, "[generated] _%s_emit_changed");\n'
2886 ' g_source_attach (skeleton->priv->changed_properties_idle_source, skeleton->priv->context);\n'
2887 ' g_source_unref (skeleton->priv->changed_properties_idle_source);\n'
2889 ' g_mutex_unlock (&skeleton->priv->lock);\n'
2892 %(i.name_lower, i.camel_name, i.ns_upper, i.name_upper, i.name_lower, i.name_lower))
2894 self.outfile.write('static void\n'
2895 '%s_skeleton_set_property (GObject *object,\n'
2897 ' const GValue *value,\n'
2898 ' GParamSpec *pspec)\n'
2899 '{\n'%(i.name_lower))
2900 self.outfile.write(' const _ExtendedGDBusPropertyInfo *info;\n'
2901 ' %sSkeleton *skeleton = %s%s_SKELETON (object);\n'
2902 ' g_assert (prop_id != 0 && prop_id - 1 < %d);\n'
2903 ' info = (const _ExtendedGDBusPropertyInfo *) _%s_property_info_pointers[prop_id - 1];\n'
2904 ' g_mutex_lock (&skeleton->priv->lock);\n'
2905 ' g_object_freeze_notify (object);\n'
2906 ' if (!_g_value_equal (value, &skeleton->priv->properties[prop_id - 1]))\n'
2908 ' if (g_dbus_interface_skeleton_get_connection (G_DBUS_INTERFACE_SKELETON (skeleton)) != NULL &&\n'
2909 ' info->emits_changed_signal)\n'
2910 ' _%s_schedule_emit_changed (skeleton, info, prop_id, &skeleton->priv->properties[prop_id - 1]);\n'
2911 ' g_value_copy (value, &skeleton->priv->properties[prop_id - 1]);\n'
2912 ' g_object_notify_by_pspec (object, pspec);\n'
2914 ' g_mutex_unlock (&skeleton->priv->lock);\n'
2915 ' g_object_thaw_notify (object);\n'
2916 %(i.camel_name, i.ns_upper, i.name_upper, len(i.properties), i.name_lower, i.name_lower))
2917 self.outfile.write('}\n'
2920 self.outfile.write('static void\n'
2921 '%s_skeleton_init (%sSkeleton *skeleton)\n'
2923 '#if GLIB_VERSION_MAX_ALLOWED >= GLIB_VERSION_2_38\n'
2924 ' skeleton->priv = %s_skeleton_get_instance_private (skeleton);\n'
2926 ' skeleton->priv = G_TYPE_INSTANCE_GET_PRIVATE (skeleton, %sTYPE_%s_SKELETON, %sSkeletonPrivate);\n'
2928 %(i.name_lower, i.camel_name,
2930 i.ns_upper, i.name_upper, i.camel_name))
2931 self.outfile.write(' g_mutex_init (&skeleton->priv->lock);\n')
2932 self.outfile.write(' skeleton->priv->context = g_main_context_ref_thread_default ();\n')
2933 if len(i.properties) > 0:
2934 self.outfile.write(' skeleton->priv->properties = g_new0 (GValue, %d);\n'%(len(i.properties)))
2936 for p in i.properties:
2937 self.outfile.write(' g_value_init (&skeleton->priv->properties[%d], %s);\n'%(n, p.arg.gtype))
2939 self.outfile.write('}\n'
2944 for p in i.properties:
2945 self.outfile.write('static %s\n'
2946 '%s_skeleton_get_%s (%s *object)\n'
2948 %(p.arg.ctype_in, i.name_lower, p.name_lower, i.camel_name))
2949 self.outfile.write(' %sSkeleton *skeleton = %s%s_SKELETON (object);\n'%(i.camel_name, i.ns_upper, i.name_upper))
2950 self.outfile.write(' %svalue;\n'
2951 ' g_mutex_lock (&skeleton->priv->lock);\n'
2952 ' value = %s (&(skeleton->priv->properties[%d]));\n'
2953 ' g_mutex_unlock (&skeleton->priv->lock);\n'
2954 %(p.arg.ctype_in_g, p.arg.gvalue_get, n))
2955 self.outfile.write(' return value;\n')
2956 self.outfile.write('}\n')
2957 self.outfile.write('\n')
2960 self.outfile.write('static void\n'
2961 '%s_skeleton_class_init (%sSkeletonClass *klass)\n'
2963 ' GObjectClass *gobject_class;\n'
2964 ' GDBusInterfaceSkeletonClass *skeleton_class;\n'
2966 ' gobject_class = G_OBJECT_CLASS (klass);\n'
2967 ' gobject_class->finalize = %s_skeleton_finalize;\n'
2968 %(i.name_lower, i.camel_name, i.name_lower))
2969 if len(i.properties) > 0:
2970 self.outfile.write(' gobject_class->get_property = %s_skeleton_get_property;\n'
2971 ' gobject_class->set_property = %s_skeleton_set_property;\n'
2972 ' gobject_class->notify = %s_skeleton_notify;\n'
2973 '\n'%(i.name_lower, i.name_lower, i.name_lower))
2974 self.outfile.write('\n'
2975 ' %s_override_properties (gobject_class, 1);\n'%(i.name_lower))
2976 self.outfile.write('\n'
2977 ' skeleton_class = G_DBUS_INTERFACE_SKELETON_CLASS (klass);\n');
2978 self.outfile.write(' skeleton_class->get_info = %s_skeleton_dbus_interface_get_info;\n'%(i.name_lower))
2979 self.outfile.write(' skeleton_class->get_properties = %s_skeleton_dbus_interface_get_properties;\n'%(i.name_lower))
2980 self.outfile.write(' skeleton_class->flush = %s_skeleton_dbus_interface_flush;\n'%(i.name_lower))
2981 self.outfile.write(' skeleton_class->get_vtable = %s_skeleton_dbus_interface_get_vtable;\n'%(i.name_lower))
2983 self.outfile.write('\n'
2984 '#if GLIB_VERSION_MAX_ALLOWED < GLIB_VERSION_2_38\n'
2985 ' g_type_class_add_private (klass, sizeof (%sSkeletonPrivate));\n'
2986 '#endif\n'%(i.camel_name))
2988 self.outfile.write('}\n'
2991 self.outfile.write('static void\n'
2992 '%s_skeleton_iface_init (%sIface *iface)\n'
2994 %(i.name_lower, i.camel_name))
2996 self.outfile.write(' iface->%s = _%s_on_signal_%s;\n'
2997 %(s.name_lower, i.name_lower, s.name_lower))
2998 for p in i.properties:
2999 self.outfile.write(' iface->get_%s = %s_skeleton_get_%s;\n'%(p.name_lower, i.name_lower, p.name_lower))
3000 self.outfile.write('}\n'
3004 self.outfile.write(self.docbook_gen.expand(
3006 ' * %s_skeleton_new:\n'
3008 ' * Creates a skeleton object for the D-Bus interface #%s.\n'
3010 ' * Returns: (transfer full) (type %sSkeleton): The skeleton object.\n'
3011 %(i.name_lower, i.name, i.camel_name), False))
3012 self.write_gtkdoc_deprecated_and_since_and_close(i, self.outfile, 0)
3013 self.outfile.write('%s *\n'
3014 '%s_skeleton_new (void)\n'
3016 ' return %s%s (g_object_new (%sTYPE_%s_SKELETON, NULL));\n'
3018 '\n'%(i.camel_name, i.name_lower, i.ns_upper, i.name_upper, i.ns_upper, i.name_upper))
3020 # ---------------------------------------------------------------------------------------------------
3022 def generate_object(self):
3023 self.outfile.write('/* ------------------------------------------------------------------------\n'
3024 ' * Code for Object, ObjectProxy and ObjectSkeleton\n'
3025 ' * ------------------------------------------------------------------------\n'
3029 self.outfile.write(self.docbook_gen.expand(
3031 ' * SECTION:%sObject\n'
3032 ' * @title: %sObject\n'
3033 ' * @short_description: Specialized GDBusObject types\n'
3035 ' * 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'
3037 %(self.namespace, self.namespace, self.namespace, self.namespace, self.namespace), False))
3038 self.outfile.write('\n')
3040 self.outfile.write(self.docbook_gen.expand(
3044 ' * The #%sObject type is a specialized container of interfaces.\n'
3046 %(self.namespace, self.namespace), False))
3047 self.outfile.write('\n')
3049 self.outfile.write(self.docbook_gen.expand(
3051 ' * %sObjectIface:\n'
3052 ' * @parent_iface: The parent interface.\n'
3054 ' * Virtual table for the #%sObject interface.\n'
3056 %(self.namespace, self.namespace), False))
3057 self.outfile.write('\n')
3059 self.outfile.write('typedef %sObjectIface %sObjectInterface;\n'%(self.namespace, self.namespace))
3060 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))
3061 self.outfile.write('\n')
3062 self.outfile.write('static void\n'
3063 '%sobject_default_init (%sObjectIface *iface)\n'
3065 %(self.ns_lower, self.namespace));
3066 for i in self.ifaces:
3067 self.outfile.write(self.docbook_gen.expand(
3071 ' * The #%s instance corresponding to the D-Bus interface #%s, if any.\n'
3073 ' * Connect to the #GObject::notify signal to get informed of property changes.\n'
3074 %(self.namespace, i.name_hyphen, i.camel_name, i.name), False))
3075 self.write_gtkdoc_deprecated_and_since_and_close(i, self.outfile, 2)
3076 flags = 'G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS'
3078 flags = 'G_PARAM_DEPRECATED | ' + flags
3079 self.outfile.write(' g_object_interface_install_property (iface, g_param_spec_object ("%s", "%s", "%s", %sTYPE_%s, %s));\n'
3081 %(i.name_hyphen, i.name_hyphen, i.name_hyphen, self.ns_upper, i.name_upper, flags))
3082 self.outfile.write('}\n'
3085 for i in self.ifaces:
3086 self.outfile.write(self.docbook_gen.expand(
3088 ' * %sobject_get_%s:\n'
3089 ' * @object: A #%sObject.\n'
3091 ' * Gets the #%s instance for the D-Bus interface #%s on @object, if any.\n'
3093 ' * Returns: (transfer full) (nullable): A #%s that must be freed with g_object_unref() or %%NULL if @object does not implement the interface.\n'
3094 %(self.ns_lower, i.name_upper.lower(), self.namespace, i.camel_name, i.name, i.camel_name), False))
3095 self.write_gtkdoc_deprecated_and_since_and_close(i, self.outfile, 0)
3096 self.outfile.write('%s *%sobject_get_%s (%sObject *object)\n'
3097 %(i.camel_name, self.ns_lower, i.name_upper.lower(), self.namespace))
3098 self.outfile.write('{\n'
3099 ' GDBusInterface *ret;\n'
3100 ' ret = g_dbus_object_get_interface (G_DBUS_OBJECT (object), "%s");\n'
3101 ' if (ret == NULL)\n'
3103 ' return %s%s (ret);\n'
3106 %(i.name, self.ns_upper, i.name_upper))
3107 self.outfile.write('\n')
3108 for i in self.ifaces:
3109 self.outfile.write(self.docbook_gen.expand(
3111 ' * %sobject_peek_%s: (skip)\n'
3112 ' * @object: A #%sObject.\n'
3114 ' * Like %sobject_get_%s() but doesn\'t increase the reference count on the returned object.\n'
3116 ' * <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'
3118 ' * Returns: (transfer none) (nullable): A #%s or %%NULL if @object does not implement the interface. Do not free the returned object, it is owned by @object.\n'
3119 %(self.ns_lower, i.name_upper.lower(), self.namespace, self.ns_lower, i.name_upper.lower(), i.camel_name), False))
3120 self.write_gtkdoc_deprecated_and_since_and_close(i, self.outfile, 0)
3121 self.outfile.write('%s *%sobject_peek_%s (%sObject *object)\n'
3122 %(i.camel_name, self.ns_lower, i.name_upper.lower(), self.namespace))
3123 self.outfile.write('{\n'
3124 ' GDBusInterface *ret;\n'
3125 ' ret = g_dbus_object_get_interface (G_DBUS_OBJECT (object), "%s");\n'
3126 ' if (ret == NULL)\n'
3128 ' g_object_unref (ret);\n'
3129 ' return %s%s (ret);\n'
3132 %(i.name, self.ns_upper, i.name_upper))
3133 self.outfile.write('\n')
3134 # shared by ObjectProxy and ObjectSkeleton classes
3135 self.outfile.write('static void\n'
3136 '%sobject_notify (GDBusObject *object, GDBusInterface *interface)\n'
3138 ' _ExtendedGDBusInterfaceInfo *info = (_ExtendedGDBusInterfaceInfo *) g_dbus_interface_get_info (interface);\n'
3139 ' /* info can be NULL if the other end is using a D-Bus interface we don\'t know\n'
3140 ' * anything about, for example old generated code in this process talking to\n'
3141 ' * newer generated code in the other process. */\n'
3142 ' if (info != NULL)\n'
3143 ' g_object_notify (G_OBJECT (object), info->hyphen_name);\n'
3148 self.outfile.write(self.docbook_gen.expand(
3150 ' * %sObjectProxy:\n'
3152 ' * The #%sObjectProxy structure contains only private data and should only be accessed using the provided API.\n'
3153 %(self.namespace, self.namespace), False))
3154 self.outfile.write(' */\n')
3155 self.outfile.write('\n')
3156 self.outfile.write(self.docbook_gen.expand(
3158 ' * %sObjectProxyClass:\n'
3159 ' * @parent_class: The parent class.\n'
3161 ' * Class structure for #%sObjectProxy.\n'
3162 %(self.namespace, self.namespace), False))
3163 self.outfile.write(' */\n')
3164 self.outfile.write('\n')
3166 self.outfile.write('static void\n'
3167 '%sobject_proxy__%sobject_iface_init (%sObjectIface *iface G_GNUC_UNUSED)\n'
3171 %(self.ns_lower, self.ns_lower, self.namespace))
3172 self.outfile.write('static void\n'
3173 '%sobject_proxy__g_dbus_object_iface_init (GDBusObjectIface *iface)\n'
3175 ' iface->interface_added = %sobject_notify;\n'
3176 ' iface->interface_removed = %sobject_notify;\n'
3179 %(self.ns_lower, self.ns_lower, self.ns_lower))
3180 self.outfile.write('\n')
3181 self.outfile.write('G_DEFINE_TYPE_WITH_CODE (%sObjectProxy, %sobject_proxy, G_TYPE_DBUS_OBJECT_PROXY,\n'
3182 ' G_IMPLEMENT_INTERFACE (%sTYPE_OBJECT, %sobject_proxy__%sobject_iface_init)\n'
3183 ' G_IMPLEMENT_INTERFACE (G_TYPE_DBUS_OBJECT, %sobject_proxy__g_dbus_object_iface_init))\n'
3185 %(self.namespace, self.ns_lower, self.ns_upper, self.ns_lower, self.ns_lower, self.ns_lower))
3187 self.outfile.write('static void\n'
3188 '%sobject_proxy_init (%sObjectProxy *object G_GNUC_UNUSED)\n'
3191 '\n'%(self.ns_lower, self.namespace))
3192 self.outfile.write('static void\n'
3193 '%sobject_proxy_set_property (GObject *gobject,\n'
3195 ' const GValue *value G_GNUC_UNUSED,\n'
3196 ' GParamSpec *pspec)\n'
3198 ' G_OBJECT_WARN_INVALID_PROPERTY_ID (gobject, prop_id, pspec);\n'
3200 self.outfile.write('}\n'
3202 self.outfile.write('static void\n'
3203 '%sobject_proxy_get_property (GObject *gobject,\n'
3206 ' GParamSpec *pspec)\n'
3208 ' %sObjectProxy *object = %sOBJECT_PROXY (gobject);\n'
3209 ' GDBusInterface *interface;\n'
3211 ' switch (prop_id)\n'
3213 %(self.ns_lower, self.namespace, self.ns_upper))
3215 for i in self.ifaces:
3216 self.outfile.write(' case %d:\n'
3217 ' interface = g_dbus_object_get_interface (G_DBUS_OBJECT (object), "%s");\n'
3218 ' g_value_take_object (value, interface);\n'
3223 self.outfile.write(' default:\n'
3224 ' G_OBJECT_WARN_INVALID_PROPERTY_ID (gobject, prop_id, pspec);\n'
3229 self.outfile.write('static void\n'
3230 '%sobject_proxy_class_init (%sObjectProxyClass *klass)\n'
3232 ' GObjectClass *gobject_class = G_OBJECT_CLASS (klass);\n'
3234 ' gobject_class->set_property = %sobject_proxy_set_property;\n'
3235 ' gobject_class->get_property = %sobject_proxy_get_property;\n'
3237 %(self.ns_lower, self.namespace, self.ns_lower, self.ns_lower))
3239 for i in self.ifaces:
3240 self.outfile.write(' g_object_class_override_property (gobject_class, %d, "%s");'
3242 %(n, i.name_hyphen))
3244 self.outfile.write('}\n'
3247 self.outfile.write(self.docbook_gen.expand(
3249 ' * %sobject_proxy_new:\n'
3250 ' * @connection: A #GDBusConnection.\n'
3251 ' * @object_path: An object path.\n'
3253 ' * Creates a new proxy object.\n'
3255 ' * Returns: (transfer full): The proxy object.\n'
3257 %(self.ns_lower), False))
3258 self.outfile.write('%sObjectProxy *\n'
3259 '%sobject_proxy_new (GDBusConnection *connection,\n'
3260 ' const gchar *object_path)\n'
3262 ' g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), NULL);\n'
3263 ' g_return_val_if_fail (g_variant_is_object_path (object_path), NULL);\n'
3264 ' return %sOBJECT_PROXY (g_object_new (%sTYPE_OBJECT_PROXY, "g-connection", connection, "g-object-path", object_path, NULL));\n'
3266 '\n'%(self.namespace, self.ns_lower, self.ns_upper, self.ns_upper))
3268 self.outfile.write(self.docbook_gen.expand(
3270 ' * %sObjectSkeleton:\n'
3272 ' * The #%sObjectSkeleton structure contains only private data and should only be accessed using the provided API.\n'
3273 %(self.namespace, self.namespace), False))
3274 self.outfile.write(' */\n')
3275 self.outfile.write('\n')
3276 self.outfile.write(self.docbook_gen.expand(
3278 ' * %sObjectSkeletonClass:\n'
3279 ' * @parent_class: The parent class.\n'
3281 ' * Class structure for #%sObjectSkeleton.\n'
3282 %(self.namespace, self.namespace), False))
3283 self.outfile.write(' */\n')
3284 self.outfile.write('\n')
3286 self.outfile.write('static void\n'
3287 '%sobject_skeleton__%sobject_iface_init (%sObjectIface *iface G_GNUC_UNUSED)\n'
3291 %(self.ns_lower, self.ns_lower, self.namespace))
3292 self.outfile.write('\n')
3293 self.outfile.write('static void\n'
3294 '%sobject_skeleton__g_dbus_object_iface_init (GDBusObjectIface *iface)\n'
3296 ' iface->interface_added = %sobject_notify;\n'
3297 ' iface->interface_removed = %sobject_notify;\n'
3300 %(self.ns_lower, self.ns_lower, self.ns_lower))
3301 self.outfile.write('G_DEFINE_TYPE_WITH_CODE (%sObjectSkeleton, %sobject_skeleton, G_TYPE_DBUS_OBJECT_SKELETON,\n'
3302 ' G_IMPLEMENT_INTERFACE (%sTYPE_OBJECT, %sobject_skeleton__%sobject_iface_init)\n'
3303 ' G_IMPLEMENT_INTERFACE (G_TYPE_DBUS_OBJECT, %sobject_skeleton__g_dbus_object_iface_init))\n'
3305 %(self.namespace, self.ns_lower, self.ns_upper, self.ns_lower, self.ns_lower, self.ns_lower))
3307 self.outfile.write('static void\n'
3308 '%sobject_skeleton_init (%sObjectSkeleton *object G_GNUC_UNUSED)\n'
3311 '\n'%(self.ns_lower, self.namespace))
3312 self.outfile.write('static void\n'
3313 '%sobject_skeleton_set_property (GObject *gobject,\n'
3315 ' const GValue *value,\n'
3316 ' GParamSpec *pspec)\n'
3318 ' %sObjectSkeleton *object = %sOBJECT_SKELETON (gobject);\n'
3319 ' GDBusInterfaceSkeleton *interface;\n'
3321 ' switch (prop_id)\n'
3323 %(self.ns_lower, self.namespace, self.ns_upper))
3325 for i in self.ifaces:
3326 self.outfile.write(' case %d:\n'
3327 ' interface = g_value_get_object (value);\n'
3328 ' if (interface != NULL)\n'
3330 ' g_warn_if_fail (%sIS_%s (interface));\n'
3331 ' g_dbus_object_skeleton_add_interface (G_DBUS_OBJECT_SKELETON (object), interface);\n'
3335 ' g_dbus_object_skeleton_remove_interface_by_name (G_DBUS_OBJECT_SKELETON (object), "%s");\n'
3339 %(n, self.ns_upper, i.name_upper, i.name))
3341 self.outfile.write(' default:\n'
3342 ' G_OBJECT_WARN_INVALID_PROPERTY_ID (gobject, prop_id, pspec);\n'
3347 self.outfile.write('static void\n'
3348 '%sobject_skeleton_get_property (GObject *gobject,\n'
3351 ' GParamSpec *pspec)\n'
3353 ' %sObjectSkeleton *object = %sOBJECT_SKELETON (gobject);\n'
3354 ' GDBusInterface *interface;\n'
3356 ' switch (prop_id)\n'
3358 %(self.ns_lower, self.namespace, self.ns_upper))
3360 for i in self.ifaces:
3361 self.outfile.write(' case %d:\n'
3362 ' interface = g_dbus_object_get_interface (G_DBUS_OBJECT (object), "%s");\n'
3363 ' g_value_take_object (value, interface);\n'
3368 self.outfile.write(' default:\n'
3369 ' G_OBJECT_WARN_INVALID_PROPERTY_ID (gobject, prop_id, pspec);\n'
3374 self.outfile.write('static void\n'
3375 '%sobject_skeleton_class_init (%sObjectSkeletonClass *klass)\n'
3377 ' GObjectClass *gobject_class = G_OBJECT_CLASS (klass);\n'
3379 ' gobject_class->set_property = %sobject_skeleton_set_property;\n'
3380 ' gobject_class->get_property = %sobject_skeleton_get_property;\n'
3382 %(self.ns_lower, self.namespace, self.ns_lower, self.ns_lower))
3384 for i in self.ifaces:
3385 self.outfile.write(' g_object_class_override_property (gobject_class, %d, "%s");'
3387 %(n, i.name_hyphen))
3389 self.outfile.write('}\n'
3391 self.outfile.write(self.docbook_gen.expand(
3393 ' * %sobject_skeleton_new:\n'
3394 ' * @object_path: An object path.\n'
3396 ' * Creates a new skeleton object.\n'
3398 ' * Returns: (transfer full): The skeleton object.\n'
3400 %(self.ns_lower), False))
3401 self.outfile.write('%sObjectSkeleton *\n'
3402 '%sobject_skeleton_new (const gchar *object_path)\n'
3404 ' g_return_val_if_fail (g_variant_is_object_path (object_path), NULL);\n'
3405 ' return %sOBJECT_SKELETON (g_object_new (%sTYPE_OBJECT_SKELETON, "g-object-path", object_path, NULL));\n'
3407 '\n'%(self.namespace, self.ns_lower, self.ns_upper, self.ns_upper))
3408 for i in self.ifaces:
3409 self.outfile.write(self.docbook_gen.expand(
3411 ' * %sobject_skeleton_set_%s:\n'
3412 ' * @object: A #%sObjectSkeleton.\n'
3413 ' * @interface_: (nullable): A #%s or %%NULL to clear the interface.\n'
3415 ' * Sets the #%s instance for the D-Bus interface #%s on @object.\n'
3416 %(self.ns_lower, i.name_upper.lower(), self.namespace, i.camel_name, i.camel_name, i.name), False))
3417 self.write_gtkdoc_deprecated_and_since_and_close(i, self.outfile, 0)
3418 self.outfile.write('void %sobject_skeleton_set_%s (%sObjectSkeleton *object, %s *interface_)\n'
3419 %(self.ns_lower, i.name_upper.lower(), self.namespace, i.camel_name))
3420 self.outfile.write('{\n'
3421 ' g_object_set (G_OBJECT (object), "%s", interface_, NULL);\n'
3425 self.outfile.write('\n')
3428 def generate_object_manager_client(self):
3429 self.outfile.write('/* ------------------------------------------------------------------------\n'
3430 ' * Code for ObjectManager client\n'
3431 ' * ------------------------------------------------------------------------\n'
3435 self.outfile.write(self.docbook_gen.expand(
3437 ' * SECTION:%sObjectManagerClient\n'
3438 ' * @title: %sObjectManagerClient\n'
3439 ' * @short_description: Generated GDBusObjectManagerClient type\n'
3441 ' * This section contains a #GDBusObjectManagerClient that uses %sobject_manager_client_get_proxy_type() as the #GDBusProxyTypeFunc.\n'
3443 %(self.namespace, self.namespace, self.ns_lower), False))
3444 self.outfile.write('\n')
3446 self.outfile.write(self.docbook_gen.expand(
3448 ' * %sObjectManagerClient:\n'
3450 ' * The #%sObjectManagerClient structure contains only private data and should only be accessed using the provided API.\n'
3451 %(self.namespace, self.namespace), False))
3452 self.outfile.write(' */\n')
3453 self.outfile.write('\n')
3455 self.outfile.write(self.docbook_gen.expand(
3457 ' * %sObjectManagerClientClass:\n'
3458 ' * @parent_class: The parent class.\n'
3460 ' * Class structure for #%sObjectManagerClient.\n'
3461 %(self.namespace, self.namespace), False))
3462 self.outfile.write(' */\n')
3463 self.outfile.write('\n')
3466 self.outfile.write('G_DEFINE_TYPE (%sObjectManagerClient, %sobject_manager_client, G_TYPE_DBUS_OBJECT_MANAGER_CLIENT)\n'
3468 %(self.namespace, self.ns_lower))
3471 self.outfile.write('static void\n'
3472 '%sobject_manager_client_init (%sObjectManagerClient *manager G_GNUC_UNUSED)\n'
3475 '\n'%(self.ns_lower, self.namespace))
3476 self.outfile.write('static void\n'
3477 '%sobject_manager_client_class_init (%sObjectManagerClientClass *klass G_GNUC_UNUSED)\n'
3480 '\n'%(self.ns_lower, self.namespace))
3482 self.outfile.write(self.docbook_gen.expand(
3484 ' * %sobject_manager_client_get_proxy_type:\n'
3485 ' * @manager: A #GDBusObjectManagerClient.\n'
3486 ' * @object_path: The object path of the remote object (unused).\n'
3487 ' * @interface_name: (nullable): Interface name of the remote object or %%NULL to get the object proxy #GType.\n'
3488 ' * @user_data: User data (unused).\n'
3490 ' * A #GDBusProxyTypeFunc that maps @interface_name to the generated #GDBusObjectProxy derived and #GDBusProxy derived types.\n'
3492 ' * Returns: A #GDBusProxy derived #GType if @interface_name is not %%NULL, otherwise the #GType for #%sObjectProxy.\n'
3493 %(self.ns_lower, self.namespace), False))
3494 self.outfile.write(' */\n')
3495 self.outfile.write('GType\n'
3496 '%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'
3499 self.outfile.write(' static gsize once_init_value = 0;\n'
3500 ' static GHashTable *lookup_hash;\n'
3503 ' if (interface_name == NULL)\n'
3504 ' return %sTYPE_OBJECT_PROXY;\n'
3505 ' if (g_once_init_enter (&once_init_value))\n'
3507 ' lookup_hash = g_hash_table_new (g_str_hash, g_str_equal);\n'
3509 for i in self.ifaces:
3510 self.outfile.write(' g_hash_table_insert (lookup_hash, (gpointer) "%s", GSIZE_TO_POINTER (%sTYPE_%s_PROXY));\n'
3511 %(i.name, i.ns_upper, i.name_upper))
3512 self.outfile.write(' g_once_init_leave (&once_init_value, 1);\n'
3514 self.outfile.write(' ret = (GType) GPOINTER_TO_SIZE (g_hash_table_lookup (lookup_hash, interface_name));\n'
3515 ' if (ret == (GType) 0)\n'
3516 ' ret = G_TYPE_DBUS_PROXY;\n')
3517 self.outfile.write(' return ret;\n'
3522 self.outfile.write(self.docbook_gen.expand(
3524 ' * %sobject_manager_client_new:\n'
3525 ' * @connection: A #GDBusConnection.\n'
3526 ' * @flags: Flags from the #GDBusObjectManagerClientFlags enumeration.\n'
3527 ' * @name: (nullable): A bus name (well-known or unique) or %%NULL if @connection is not a message bus connection.\n'
3528 ' * @object_path: An object path.\n'
3529 ' * @cancellable: (nullable): A #GCancellable or %%NULL.\n'
3530 ' * @callback: A #GAsyncReadyCallback to call when the request is satisfied.\n'
3531 ' * @user_data: User data to pass to @callback.\n'
3533 ' * Asynchronously creates #GDBusObjectManagerClient using %sobject_manager_client_get_proxy_type() as the #GDBusProxyTypeFunc. See g_dbus_object_manager_client_new() for more details.\n'
3535 ' * 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'
3536 ' * You can then call %sobject_manager_client_new_finish() to get the result of the operation.\n'
3538 ' * See %sobject_manager_client_new_sync() for the synchronous, blocking version of this constructor.\n'
3539 %(self.ns_lower, self.ns_lower, self.ns_lower, self.ns_lower), False))
3540 self.outfile.write(' */\n')
3541 self.outfile.write('void\n'
3542 '%sobject_manager_client_new (\n'
3543 ' GDBusConnection *connection,\n'
3544 ' GDBusObjectManagerClientFlags flags,\n'
3545 ' const gchar *name,\n'
3546 ' const gchar *object_path,\n'
3547 ' GCancellable *cancellable,\n'
3548 ' GAsyncReadyCallback callback,\n'
3549 ' gpointer user_data)\n'
3551 ' 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'
3554 %(self.ns_lower, self.ns_upper, self.ns_lower))
3555 self.outfile.write('/**\n'
3556 ' * %sobject_manager_client_new_finish:\n'
3557 ' * @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to %sobject_manager_client_new().\n'
3558 ' * @error: Return location for error or %%NULL\n'
3560 ' * Finishes an operation started with %sobject_manager_client_new().\n'
3562 ' * Returns: (transfer full) (type %sObjectManagerClient): The constructed object manager client or %%NULL if @error is set.\n'
3563 %(self.ns_lower, self.ns_lower, self.ns_lower, self.namespace))
3564 self.outfile.write(' */\n')
3565 self.outfile.write('GDBusObjectManager *\n'
3566 '%sobject_manager_client_new_finish (\n'
3567 ' GAsyncResult *res,\n'
3568 ' GError **error)\n'
3571 ' GObject *source_object;\n'
3572 ' source_object = g_async_result_get_source_object (res);\n'
3573 ' ret = g_async_initable_new_finish (G_ASYNC_INITABLE (source_object), res, error);\n'
3574 ' g_object_unref (source_object);\n'
3575 ' if (ret != NULL)\n'
3576 ' return G_DBUS_OBJECT_MANAGER (ret);\n'
3582 self.outfile.write(self.docbook_gen.expand(
3584 ' * %sobject_manager_client_new_sync:\n'
3585 ' * @connection: A #GDBusConnection.\n'
3586 ' * @flags: Flags from the #GDBusObjectManagerClientFlags enumeration.\n'
3587 ' * @name: (nullable): A bus name (well-known or unique) or %%NULL if @connection is not a message bus connection.\n'
3588 ' * @object_path: An object path.\n'
3589 ' * @cancellable: (nullable): A #GCancellable or %%NULL.\n'
3590 ' * @error: Return location for error or %%NULL\n'
3592 ' * 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'
3594 ' * The calling thread is blocked until a reply is received.\n'
3596 ' * See %sobject_manager_client_new() for the asynchronous version of this constructor.\n'
3598 ' * Returns: (transfer full) (type %sObjectManagerClient): The constructed object manager client or %%NULL if @error is set.\n'
3599 %(self.ns_lower, self.ns_lower, self.ns_lower, self.namespace), False))
3600 self.outfile.write(' */\n')
3601 self.outfile.write('GDBusObjectManager *\n'
3602 '%sobject_manager_client_new_sync (\n'
3603 ' GDBusConnection *connection,\n'
3604 ' GDBusObjectManagerClientFlags flags,\n'
3605 ' const gchar *name,\n'
3606 ' const gchar *object_path,\n'
3607 ' GCancellable *cancellable,\n'
3608 ' GError **error)\n'
3610 ' GInitable *ret;\n'
3611 ' 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'
3612 ' if (ret != NULL)\n'
3613 ' return G_DBUS_OBJECT_MANAGER (ret);\n'
3618 %(self.ns_lower, self.ns_upper, self.ns_lower))
3619 self.outfile.write('\n')
3620 self.outfile.write(self.docbook_gen.expand(
3622 ' * %sobject_manager_client_new_for_bus:\n'
3623 ' * @bus_type: A #GBusType.\n'
3624 ' * @flags: Flags from the #GDBusObjectManagerClientFlags enumeration.\n'
3625 ' * @name: A bus name (well-known or unique).\n'
3626 ' * @object_path: An object path.\n'
3627 ' * @cancellable: (nullable): A #GCancellable or %%NULL.\n'
3628 ' * @callback: A #GAsyncReadyCallback to call when the request is satisfied.\n'
3629 ' * @user_data: User data to pass to @callback.\n'
3631 ' * Like %sobject_manager_client_new() but takes a #GBusType instead of a #GDBusConnection.\n'
3633 ' * 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'
3634 ' * You can then call %sobject_manager_client_new_for_bus_finish() to get the result of the operation.\n'
3636 ' * See %sobject_manager_client_new_for_bus_sync() for the synchronous, blocking version of this constructor.\n'
3637 %(self.ns_lower, self.ns_lower, self.ns_lower, self.ns_lower), False))
3638 self.outfile.write(' */\n')
3639 self.outfile.write('void\n'
3640 '%sobject_manager_client_new_for_bus (\n'
3641 ' GBusType bus_type,\n'
3642 ' GDBusObjectManagerClientFlags flags,\n'
3643 ' const gchar *name,\n'
3644 ' const gchar *object_path,\n'
3645 ' GCancellable *cancellable,\n'
3646 ' GAsyncReadyCallback callback,\n'
3647 ' gpointer user_data)\n'
3649 ' 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'
3652 %(self.ns_lower, self.ns_upper, self.ns_lower))
3653 self.outfile.write('/**\n'
3654 ' * %sobject_manager_client_new_for_bus_finish:\n'
3655 ' * @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to %sobject_manager_client_new_for_bus().\n'
3656 ' * @error: Return location for error or %%NULL\n'
3658 ' * Finishes an operation started with %sobject_manager_client_new_for_bus().\n'
3660 ' * Returns: (transfer full) (type %sObjectManagerClient): The constructed object manager client or %%NULL if @error is set.\n'
3661 %(self.ns_lower, self.ns_lower, self.ns_lower, self.namespace))
3662 self.outfile.write(' */\n')
3663 self.outfile.write('GDBusObjectManager *\n'
3664 '%sobject_manager_client_new_for_bus_finish (\n'
3665 ' GAsyncResult *res,\n'
3666 ' GError **error)\n'
3669 ' GObject *source_object;\n'
3670 ' source_object = g_async_result_get_source_object (res);\n'
3671 ' ret = g_async_initable_new_finish (G_ASYNC_INITABLE (source_object), res, error);\n'
3672 ' g_object_unref (source_object);\n'
3673 ' if (ret != NULL)\n'
3674 ' return G_DBUS_OBJECT_MANAGER (ret);\n'
3680 self.outfile.write(self.docbook_gen.expand(
3682 ' * %sobject_manager_client_new_for_bus_sync:\n'
3683 ' * @bus_type: A #GBusType.\n'
3684 ' * @flags: Flags from the #GDBusObjectManagerClientFlags enumeration.\n'
3685 ' * @name: A bus name (well-known or unique).\n'
3686 ' * @object_path: An object path.\n'
3687 ' * @cancellable: (nullable): A #GCancellable or %%NULL.\n'
3688 ' * @error: Return location for error or %%NULL\n'
3690 ' * Like %sobject_manager_client_new_sync() but takes a #GBusType instead of a #GDBusConnection.\n'
3692 ' * The calling thread is blocked until a reply is received.\n'
3694 ' * See %sobject_manager_client_new_for_bus() for the asynchronous version of this constructor.\n'
3696 ' * Returns: (transfer full) (type %sObjectManagerClient): The constructed object manager client or %%NULL if @error is set.\n'
3697 %(self.ns_lower, self.ns_lower, self.ns_lower, self.namespace), False))
3698 self.outfile.write(' */\n')
3699 self.outfile.write('GDBusObjectManager *\n'
3700 '%sobject_manager_client_new_for_bus_sync (\n'
3701 ' GBusType bus_type,\n'
3702 ' GDBusObjectManagerClientFlags flags,\n'
3703 ' const gchar *name,\n'
3704 ' const gchar *object_path,\n'
3705 ' GCancellable *cancellable,\n'
3706 ' GError **error)\n'
3708 ' GInitable *ret;\n'
3709 ' 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'
3710 ' if (ret != NULL)\n'
3711 ' return G_DBUS_OBJECT_MANAGER (ret);\n'
3716 %(self.ns_lower, self.ns_upper, self.ns_lower))
3717 self.outfile.write('\n')
3719 # ---------------------------------------------------------------------------------------------------
3721 def write_gtkdoc_deprecated_and_since_and_close(self, obj, f, indent):
3722 if len(obj.since) > 0:
3725 %(indent, '', indent, '', obj.since))
3727 if isinstance(obj, dbustypes.Interface):
3728 thing = 'The D-Bus interface'
3729 elif isinstance(obj, dbustypes.Method):
3730 thing = 'The D-Bus method'
3731 elif isinstance(obj, dbustypes.Signal):
3732 thing = 'The D-Bus signal'
3733 elif isinstance(obj, dbustypes.Property):
3734 thing = 'The D-Bus property'
3736 print_error('Cannot handle object "{}"'.format(obj))
3737 f.write(self.docbook_gen.expand(
3739 '%*s * Deprecated: %s has been deprecated.\n'
3740 %(indent, '', indent, '', thing), False))
3741 f.write('%*s */\n'%(indent, ''))
3743 # ---------------------------------------------------------------------------------------------------
3745 def generate_interface_intro(self, i):
3746 self.outfile.write('/* ------------------------------------------------------------------------\n'
3747 ' * Code for interface %s\n'
3748 ' * ------------------------------------------------------------------------\n'
3752 self.outfile.write(self.docbook_gen.expand(
3756 ' * @short_description: Generated C code for the %s D-Bus interface\n'
3758 ' * This section contains code for working with the #%s D-Bus interface in C.\n'
3760 %(i.camel_name, i.camel_name, i.name, i.name), False))
3761 self.outfile.write('\n')
3764 self.generate_body_preamble()
3765 for i in self.ifaces:
3766 self.generate_interface_intro(i)
3767 self.generate_introspection_for_interface(i)
3768 self.generate_interface(i)
3769 self.generate_property_accessors(i)
3770 self.generate_signal_emitters(i)
3771 self.generate_method_calls(i)
3772 self.generate_method_completers(i)
3773 self.generate_proxy(i)
3774 self.generate_skeleton(i)
3775 if self.generate_objmanager:
3776 self.generate_object()
3777 self.generate_object_manager_client()