1# -*- Mode: Python -*- 2# coding=utf-8 3 4# GDBus - GLib D-Bus Library 5# 6# Copyright (C) 2008-2018 Red Hat, Inc. 7# Copyright (C) 2018 Iñigo Martínez <inigomartinez@gmail.com> 8# 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. 13# 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. 18# 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/>. 21# 22# Author: David Zeuthen <davidz@redhat.com> 23 24import sys 25 26from . import config 27from . import utils 28from . import dbustypes 29from .utils import print_error 30 31LICENSE_STR = '''/* 32 * Generated by gdbus-codegen {!s} from {!s}. DO NOT EDIT. 33 * 34 * The license of this code is the same as for the D-Bus interface description 35 * it was derived from. 36 */\n''' 37 38def generate_namespace(namespace): 39 ns = 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() + '_' 45 else: 46 ns_upper = utils.camel_case_to_uscore(namespace).upper() + '_' 47 ns_lower = utils.camel_case_to_uscore(namespace).lower() + '_' 48 else: 49 ns_upper = '' 50 ns_lower = '' 51 52 return (ns, ns_upper, ns_lower) 53 54class HeaderCodeGenerator: 55 def __init__(self, ifaces, namespace, generate_objmanager, 56 generate_autocleanup, header_name, input_files_basenames, 57 use_pragma, outfile): 58 self.ifaces = ifaces 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 66 67 # ---------------------------------------------------------------------------------------------------- 68 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') 73 74 if self.use_pragma: 75 self.outfile.write('#pragma once\n') 76 else: 77 self.outfile.write('#ifndef __{!s}__\n'.format(self.header_guard)) 78 self.outfile.write('#define __{!s}__\n'.format(self.header_guard)) 79 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') 85 86 # ---------------------------------------------------------------------------------------------------- 87 88 def declare_types(self): 89 for i in self.ifaces: 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') 94 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') 108 109 function_pointers = {} 110 111 # vfuncs for methods 112 if len(i.methods) > 0: 113 self.outfile.write('\n') 114 for m in i.methods: 115 unix_fd = False 116 if utils.lookup_annotation(m.annotations, 'org.gtk.GDBus.C.UnixFD'): 117 unix_fd = True 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'%() 122 if unix_fd: 123 value += ',\n GUnixFDList *fd_list' 124 for a in m.in_args: 125 value += ',\n %sarg_%s'%(a.ctype_in, a.name) 126 value += ');\n\n' 127 function_pointers[key] = value 128 129 # vfuncs for signals 130 if len(i.signals) > 0: 131 self.outfile.write('\n') 132 for s in i.signals: 133 key = (s.since, '_signal_%s'%s.name_lower) 134 value = ' void (*%s) (\n'%(s.name_lower) 135 value += ' %s *object'%(i.camel_name) 136 for a in s.args: 137 value += ',\n %sarg_%s'%(a.ctype_in, a.name) 138 value += ');\n\n' 139 function_pointers[key] = value 140 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 148 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 152 # 153 # Also use a proper version comparison function so e.g. 154 # 10.0 comes after 2.0. 155 # 156 # See https://bugzilla.gnome.org/show_bug.cgi?id=647577#c5 157 # for discussion 158 for key in sorted(function_pointers.keys(), key=utils.version_cmp_key): 159 self.outfile.write('%s'%function_pointers[key]) 160 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') 173 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') 178 for m in i.methods: 179 unix_fd = False 180 if utils.lookup_annotation(m.annotations, 'org.gtk.GDBus.C.UnixFD'): 181 unix_fd = True 182 if m.deprecated: 183 self.outfile.write('G_GNUC_DEPRECATED ') 184 self.outfile.write('void %s_complete_%s (\n' 185 ' %s *object,\n' 186 ' GDBusMethodInvocation *invocation'%(i.name_lower, m.name_lower, i.camel_name)) 187 if unix_fd: 188 self.outfile.write(',\n GUnixFDList *fd_list') 189 for a in m.out_args: 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') 194 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') 199 for s in i.signals: 200 if s.deprecated: 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)) 204 for a in s.args: 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') 209 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') 214 for m in i.methods: 215 unix_fd = False 216 if utils.lookup_annotation(m.annotations, 'org.gtk.GDBus.C.UnixFD'): 217 unix_fd = True 218 # async begin 219 if m.deprecated: 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)) 223 for a in m.in_args: 224 self.outfile.write(',\n %sarg_%s'%(a.ctype_in, a.name)) 225 if unix_fd: 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') 232 # async finish 233 if m.deprecated: 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)) 237 for a in m.out_args: 238 self.outfile.write(',\n %sout_%s'%(a.ctype_out, a.name)) 239 if unix_fd: 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') 245 # sync 246 if m.deprecated: 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)) 250 for a in m.in_args: 251 self.outfile.write(',\n %sarg_%s'%(a.ctype_in, a.name)) 252 if unix_fd: 253 self.outfile.write(',\n GUnixFDList *fd_list') 254 for a in m.out_args: 255 self.outfile.write(',\n %sout_%s'%(a.ctype_out, a.name)) 256 if unix_fd: 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') 263 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: 269 # getter 270 if p.deprecated: 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: 274 if p.deprecated: 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)) 277 # setter 278 if p.deprecated: 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') 282 283 # Then the proxy 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') 317 if i.deprecated: 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' 327 %(i.name_lower)) 328 if i.deprecated: 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)) 334 if i.deprecated: 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') 345 if i.deprecated: 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' 355 %(i.name_lower)) 356 if i.deprecated: 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)) 362 if i.deprecated: 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') 373 374 # Then the skeleton 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') 408 if i.deprecated: 409 self.outfile.write('G_GNUC_DEPRECATED ') 410 self.outfile.write('%s *%s_skeleton_new (void);\n'%(i.camel_name, i.name_lower)) 411 412 self.outfile.write('\n') 413 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' 431 '};\n' 432 '\n') 433 self.outfile.write('GType %sobject_get_type (void) G_GNUC_CONST;\n' 434 '\n' 435 %(self.ns_lower)) 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: 442 if i.deprecated: 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: 447 if i.deprecated: 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: 517 if i.deprecated: 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') 522 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' 565 %(self.ns_lower)) 566 self.outfile.write('GDBusObjectManager *%sobject_manager_client_new_finish (\n' 567 ' GAsyncResult *res,\n' 568 ' GError **error);\n' 569 %(self.ns_lower)) 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' 577 %(self.ns_lower)) 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' 587 %(self.ns_lower)) 588 self.outfile.write('GDBusObjectManager *%sobject_manager_client_new_for_bus_finish (\n' 589 ' GAsyncResult *res,\n' 590 ' GError **error);\n' 591 %(self.ns_lower)) 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' 599 %(self.ns_lower)) 600 self.outfile.write('\n') 601 602 # ---------------------------------------------------------------------------------------------------- 603 604 def generate_header_postamble(self): 605 self.outfile.write('\n') 606 self.outfile.write('G_END_DECLS\n') 607 608 if not self.use_pragma: 609 self.outfile.write('\n') 610 self.outfile.write('#endif /* __{!s}__ */\n'.format(self.header_guard)) 611 612 # ---------------------------------------------------------------------------------------------------- 613 614 def generate(self): 615 self.generate_header_preamble() 616 self.declare_types() 617 self.generate_header_postamble() 618 619# ---------------------------------------------------------------------------------------------------- 620 621class InterfaceInfoHeaderCodeGenerator: 622 def __init__(self, ifaces, namespace, header_name, input_files_basenames, use_pragma, outfile): 623 self.ifaces = ifaces 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 629 630 # ---------------------------------------------------------------------------------------------------- 631 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') 636 637 if self.use_pragma: 638 self.outfile.write('#pragma once\n') 639 else: 640 self.outfile.write('#ifndef __{!s}__\n'.format(self.header_guard)) 641 self.outfile.write('#define __{!s}__\n'.format(self.header_guard)) 642 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') 648 649 # ---------------------------------------------------------------------------------------------------- 650 651 def declare_infos(self): 652 for i in self.ifaces: 653 self.outfile.write('extern const GDBusInterfaceInfo %s_interface;\n' % i.name_lower) 654 655 # ---------------------------------------------------------------------------------------------------- 656 657 def generate_header_postamble(self): 658 self.outfile.write('\n') 659 self.outfile.write('G_END_DECLS\n') 660 661 if not self.use_pragma: 662 self.outfile.write('\n') 663 self.outfile.write('#endif /* __{!s}__ */\n'.format(self.header_guard)) 664 665 # ---------------------------------------------------------------------------------------------------- 666 667 def generate(self): 668 self.generate_header_preamble() 669 self.declare_infos() 670 self.generate_header_postamble() 671 672# ---------------------------------------------------------------------------------------------------- 673 674class InterfaceInfoBodyCodeGenerator: 675 def __init__(self, ifaces, namespace, header_name, input_files_basenames, outfile): 676 self.ifaces = ifaces 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 681 682 # ---------------------------------------------------------------------------------------------------- 683 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' 690 '#endif\n' 691 '\n' 692 '#include "%s"\n' 693 '\n' 694 '#include <string.h>\n' 695 % (self.header_name)) 696 self.outfile.write('\n') 697 698 # ---------------------------------------------------------------------------------------------------- 699 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') 708 709 def define_annotations(self, array_name_lower, annotations): 710 if len(annotations) == 0: 711 return 712 713 annotation_pointers = [] 714 715 for a in annotations: 716 # Skip internal annotations. 717 if a.key.startswith('org.gtk.GDBus'): 718 continue 719 720 self.define_annotations('%s__%s_annotations' % (array_name_lower, a.key_lower), a.annotations) 721 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)) 729 else: 730 self.outfile.write(' NULL, /* no annotations */\n') 731 self.outfile.write('};\n') 732 self.outfile.write('\n') 733 734 key = (a.since, '%s__%s_annotation' % (array_name_lower, a.key_lower)) 735 annotation_pointers.append(key) 736 737 self.generate_array(array_name_lower, 'GDBusAnnotationInfo', 738 annotation_pointers) 739 740 def define_args(self, array_name_lower, args): 741 if len(args) == 0: 742 return 743 744 arg_pointers = [] 745 746 for a in args: 747 self.define_annotations('%s__%s_arg_annotations' % (array_name_lower, a.name), a.annotations) 748 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)) 756 else: 757 self.outfile.write(' NULL, /* no annotations */\n') 758 self.outfile.write('};\n') 759 self.outfile.write('\n') 760 761 key = (a.since, '%s__%s_arg' % (array_name_lower, a.name)) 762 arg_pointers.append(key) 763 764 self.generate_array(array_name_lower, 'GDBusArgInfo', arg_pointers) 765 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') 771 772 # GDBusMethodInfos. 773 if len(i.methods) > 0: 774 method_pointers = [] 775 776 for m in i.methods: 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) 780 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)) 787 else: 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)) 791 else: 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)) 795 else: 796 self.outfile.write(' NULL, /* no annotations */\n') 797 self.outfile.write('};\n') 798 self.outfile.write('\n') 799 800 key = (m.since, '%s_interface__%s_method' % (i.name_lower, m.name_lower)) 801 method_pointers.append(key) 802 803 self.generate_array('%s_interface_methods' % i.name_lower, 804 'GDBusMethodInfo', method_pointers) 805 806 # GDBusSignalInfos. 807 if len(i.signals) > 0: 808 signal_pointers = [] 809 810 for s in i.signals: 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) 813 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) 818 if len(s.args) > 0: 819 self.outfile.write(' (GDBusArgInfo **) %s_interface__%s_signal_args,\n' % (i.name_lower, s.name_lower)) 820 else: 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)) 824 else: 825 self.outfile.write(' NULL, /* no annotations */\n') 826 self.outfile.write('};\n') 827 self.outfile.write('\n') 828 829 key = (s.since, '%s_interface__%s_signal' % (i.name_lower, s.name_lower)) 830 signal_pointers.append(key) 831 832 self.generate_array('%s_interface_signals' % i.name_lower, 833 'GDBusSignalInfo', signal_pointers) 834 835 # GDBusPropertyInfos. 836 if len(i.properties) > 0: 837 property_pointers = [] 838 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' 842 elif p.readable: 843 flags = 'G_DBUS_PROPERTY_INFO_FLAGS_READABLE' 844 elif p.writable: 845 flags = 'G_DBUS_PROPERTY_INFO_FLAGS_WRITABLE' 846 else: 847 flags = 'G_DBUS_PROPERTY_INFO_FLAGS_NONE' 848 849 self.define_annotations('%s_interface__%s_property_annotations' % (i.name_lower, p.name_lower), p.annotations) 850 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)) 859 else: 860 self.outfile.write(' NULL, /* no annotations */\n') 861 self.outfile.write('};\n') 862 self.outfile.write('\n') 863 864 key = (p.since, '%s_interface__%s_property' % (i.name_lower, p.name_lower)) 865 property_pointers.append(key) 866 867 self.generate_array('%s_interface_properties' % i.name_lower, 868 'GDBusPropertyInfo', property_pointers) 869 870 # Finally the GDBusInterfaceInfo. 871 self.define_annotations('%s_interface_annotations' % i.name_lower, 872 i.annotations) 873 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) 880 else: 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) 884 else: 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) 888 else: 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) 892 else: 893 self.outfile.write(' NULL, /* no annotations */\n') 894 self.outfile.write('};\n') 895 self.outfile.write('\n') 896 897 # ---------------------------------------------------------------------------------------------------- 898 899 def generate(self): 900 self.generate_body_preamble() 901 self.define_infos() 902 903# ---------------------------------------------------------------------------------------------------- 904 905class CodeGenerator: 906 def __init__(self, ifaces, namespace, generate_objmanager, header_name, 907 input_files_basenames, docbook_gen, outfile): 908 self.ifaces = ifaces 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 915 916 # ---------------------------------------------------------------------------------------------------- 917 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' 924 '#endif\n' 925 '\n' 926 '#include "%s"\n' 927 '\n' 928 '#include <string.h>\n' 929 %(self.header_name)) 930 931 self.outfile.write('#ifdef G_OS_UNIX\n' 932 '# include <gio/gunixfdlist.h>\n' 933 '#endif\n' 934 '\n') 935 936 self.outfile.write('typedef struct\n' 937 '{\n' 938 ' GDBusArgInfo parent_struct;\n' 939 ' gboolean use_gvariant;\n' 940 '} _ExtendedGDBusArgInfo;\n' 941 '\n') 942 943 self.outfile.write('typedef struct\n' 944 '{\n' 945 ' GDBusMethodInfo parent_struct;\n' 946 ' const gchar *signal_name;\n' 947 ' gboolean pass_fdlist;\n' 948 '} _ExtendedGDBusMethodInfo;\n' 949 '\n') 950 951 self.outfile.write('typedef struct\n' 952 '{\n' 953 ' GDBusSignalInfo parent_struct;\n' 954 ' const gchar *signal_name;\n' 955 '} _ExtendedGDBusSignalInfo;\n' 956 '\n') 957 958 self.outfile.write('typedef struct\n' 959 '{\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' 965 '\n') 966 967 self.outfile.write('typedef struct\n' 968 '{\n' 969 ' GDBusInterfaceInfo parent_struct;\n' 970 ' const gchar *hyphen_name;\n' 971 '} _ExtendedGDBusInterfaceInfo;\n' 972 '\n') 973 974 self.outfile.write('typedef struct\n' 975 '{\n' 976 ' const _ExtendedGDBusPropertyInfo *info;\n' 977 ' guint prop_id;\n' 978 ' GValue orig_value; /* the value before the change */\n' 979 '} ChangedProperty;\n' 980 '\n' 981 'static void\n' 982 '_changed_property_free (ChangedProperty *data)\n' 983 '{\n' 984 ' g_value_unset (&data->orig_value);\n' 985 ' g_free (data);\n' 986 '}\n' 987 '\n') 988 989 self.outfile.write('static gboolean\n' 990 '_g_strv_equal0 (gchar **a, gchar **b)\n' 991 '{\n' 992 ' gboolean ret = FALSE;\n' 993 ' guint n;\n' 994 ' if (a == NULL && b == NULL)\n' 995 ' {\n' 996 ' ret = TRUE;\n' 997 ' goto out;\n' 998 ' }\n' 999 ' if (a == NULL || b == NULL)\n' 1000 ' goto out;\n' 1001 ' if (g_strv_length (a) != g_strv_length (b))\n' 1002 ' goto out;\n' 1003 ' for (n = 0; a[n] != NULL; n++)\n' 1004 ' if (g_strcmp0 (a[n], b[n]) != 0)\n' 1005 ' goto out;\n' 1006 ' ret = TRUE;\n' 1007 'out:\n' 1008 ' return ret;\n' 1009 '}\n' 1010 '\n') 1011 1012 self.outfile.write('static gboolean\n' 1013 '_g_variant_equal0 (GVariant *a, GVariant *b)\n' 1014 '{\n' 1015 ' gboolean ret = FALSE;\n' 1016 ' if (a == NULL && b == NULL)\n' 1017 ' {\n' 1018 ' ret = TRUE;\n' 1019 ' goto out;\n' 1020 ' }\n' 1021 ' if (a == NULL || b == NULL)\n' 1022 ' goto out;\n' 1023 ' ret = g_variant_equal (a, b);\n' 1024 'out:\n' 1025 ' return ret;\n' 1026 '}\n' 1027 '\n') 1028 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' 1032 '{\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' 1036 ' {\n' 1037 ' case G_TYPE_BOOLEAN:\n' 1038 ' ret = (g_value_get_boolean (a) == g_value_get_boolean (b));\n' 1039 ' break;\n' 1040 ' case G_TYPE_UCHAR:\n' 1041 ' ret = (g_value_get_uchar (a) == g_value_get_uchar (b));\n' 1042 ' break;\n' 1043 ' case G_TYPE_INT:\n' 1044 ' ret = (g_value_get_int (a) == g_value_get_int (b));\n' 1045 ' break;\n' 1046 ' case G_TYPE_UINT:\n' 1047 ' ret = (g_value_get_uint (a) == g_value_get_uint (b));\n' 1048 ' break;\n' 1049 ' case G_TYPE_INT64:\n' 1050 ' ret = (g_value_get_int64 (a) == g_value_get_int64 (b));\n' 1051 ' break;\n' 1052 ' case G_TYPE_UINT64:\n' 1053 ' ret = (g_value_get_uint64 (a) == g_value_get_uint64 (b));\n' 1054 ' break;\n' 1055 ' case G_TYPE_DOUBLE:\n' 1056 ' {\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' 1061 ' }\n' 1062 ' break;\n' 1063 ' case G_TYPE_STRING:\n' 1064 ' ret = (g_strcmp0 (g_value_get_string (a), g_value_get_string (b)) == 0);\n' 1065 ' break;\n' 1066 ' case G_TYPE_VARIANT:\n' 1067 ' ret = _g_variant_equal0 (g_value_get_variant (a), g_value_get_variant (b));\n' 1068 ' break;\n' 1069 ' default:\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' 1072 ' else\n' 1073 ' g_critical ("_g_value_equal() does not handle type %s", g_type_name (G_VALUE_TYPE (a)));\n' 1074 ' break;\n' 1075 ' }\n' 1076 ' return ret;\n' 1077 '}\n' 1078 '\n') 1079 1080 def generate_annotations(self, prefix, annotations): 1081 if annotations is None: 1082 return 1083 1084 n = 0 1085 for a in annotations: 1086 #self.generate_annotations('%s_%d'%(prefix, n), a.get_annotations()) 1087 1088 # skip internal annotations 1089 if a.key.startswith('org.gtk.GDBus'): 1090 continue 1091 1092 self.outfile.write('static const GDBusAnnotationInfo %s_%d =\n' 1093 '{\n' 1094 ' -1,\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') 1099 else: 1100 self.outfile.write(' (GDBusAnnotationInfo **) &%s_%d_pointers\n'%(prefix, n)) 1101 self.outfile.write('};\n' 1102 '\n') 1103 n += 1 1104 1105 if n > 0: 1106 self.outfile.write('static const GDBusAnnotationInfo * const %s_pointers[] =\n' 1107 '{\n'%(prefix)) 1108 m = 0; 1109 for a in annotations: 1110 if a.key.startswith('org.gtk.GDBus'): 1111 continue 1112 self.outfile.write(' &%s_%d,\n'%(prefix, m)) 1113 m += 1 1114 self.outfile.write(' NULL\n' 1115 '};\n' 1116 '\n') 1117 return n 1118 1119 def generate_args(self, prefix, args): 1120 for a in args: 1121 num_anno = self.generate_annotations('%s_arg_%s_annotation_info'%(prefix, a.name), a.annotations) 1122 1123 self.outfile.write('static const _ExtendedGDBusArgInfo %s_%s =\n' 1124 '{\n' 1125 ' {\n' 1126 ' -1,\n' 1127 ' (gchar *) "%s",\n' 1128 ' (gchar *) "%s",\n'%(prefix, a.name, a.name, a.signature)) 1129 if num_anno == 0: 1130 self.outfile.write(' NULL\n') 1131 else: 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') 1136 else: 1137 self.outfile.write(' TRUE\n') 1138 self.outfile.write('};\n' 1139 '\n') 1140 1141 if len(args) > 0: 1142 self.outfile.write('static const GDBusArgInfo * const %s_pointers[] =\n' 1143 '{\n'%(prefix)) 1144 for a in args: 1145 self.outfile.write(' &%s_%s.parent_struct,\n'%(prefix, a.name)) 1146 self.outfile.write(' NULL\n' 1147 '};\n' 1148 '\n') 1149 1150 def generate_introspection_for_interface(self, i): 1151 self.outfile.write('/* ---- Introspection data for %s ---- */\n' 1152 '\n'%(i.name)) 1153 1154 if len(i.methods) > 0: 1155 for m in i.methods: 1156 unix_fd = False 1157 if utils.lookup_annotation(m.annotations, 'org.gtk.GDBus.C.UnixFD'): 1158 unix_fd = True 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) 1161 1162 num_anno = self.generate_annotations('_%s_method_%s_annotation_info'%(i.name_lower, m.name_lower), m.annotations) 1163 1164 self.outfile.write('static const _ExtendedGDBusMethodInfo _%s_method_info_%s =\n' 1165 '{\n' 1166 ' {\n' 1167 ' -1,\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') 1171 else: 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') 1175 else: 1176 self.outfile.write(' (GDBusArgInfo **) &_%s_method_info_%s_OUT_ARG_pointers,\n'%(i.name_lower, m.name_lower)) 1177 if num_anno == 0: 1178 self.outfile.write(' NULL\n') 1179 else: 1180 self.outfile.write(' (GDBusAnnotationInfo **) &_%s_method_%s_annotation_info_pointers\n'%(i.name_lower, m.name_lower)) 1181 self.outfile.write(' },\n' 1182 ' "handle-%s",\n' 1183 ' %s\n' 1184 %(m.name_hyphen, 'TRUE' if unix_fd else 'FALSE')) 1185 self.outfile.write('};\n' 1186 '\n') 1187 1188 self.outfile.write('static const GDBusMethodInfo * const _%s_method_info_pointers[] =\n' 1189 '{\n'%(i.name_lower)) 1190 for m in i.methods: 1191 self.outfile.write(' &_%s_method_info_%s.parent_struct,\n'%(i.name_lower, m.name_lower)) 1192 self.outfile.write(' NULL\n' 1193 '};\n' 1194 '\n') 1195 1196 # --- 1197 1198 if len(i.signals) > 0: 1199 for s in i.signals: 1200 self.generate_args('_%s_signal_info_%s_ARG'%(i.name_lower, s.name_lower), s.args) 1201 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' 1204 '{\n' 1205 ' {\n' 1206 ' -1,\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') 1210 else: 1211 self.outfile.write(' (GDBusArgInfo **) &_%s_signal_info_%s_ARG_pointers,\n'%(i.name_lower, s.name_lower)) 1212 if num_anno == 0: 1213 self.outfile.write(' NULL\n') 1214 else: 1215 self.outfile.write(' (GDBusAnnotationInfo **) &_%s_signal_%s_annotation_info_pointers\n'%(i.name_lower, s.name_lower)) 1216 self.outfile.write(' },\n' 1217 ' "%s"\n' 1218 %(s.name_hyphen)) 1219 self.outfile.write('};\n' 1220 '\n') 1221 1222 self.outfile.write('static const GDBusSignalInfo * const _%s_signal_info_pointers[] =\n' 1223 '{\n'%(i.name_lower)) 1224 for s in i.signals: 1225 self.outfile.write(' &_%s_signal_info_%s.parent_struct,\n'%(i.name_lower, s.name_lower)) 1226 self.outfile.write(' NULL\n' 1227 '};\n' 1228 '\n') 1229 1230 # --- 1231 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' 1236 elif p.readable: 1237 access = 'G_DBUS_PROPERTY_INFO_FLAGS_READABLE' 1238 elif p.writable: 1239 access = 'G_DBUS_PROPERTY_INFO_FLAGS_WRITABLE' 1240 else: 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' 1244 '{\n' 1245 ' {\n' 1246 ' -1,\n' 1247 ' (gchar *) "%s",\n' 1248 ' (gchar *) "%s",\n' 1249 ' %s,\n'%(i.name_lower, p.name_lower, p.name, p.arg.signature, access)) 1250 if num_anno == 0: 1251 self.outfile.write(' NULL\n') 1252 else: 1253 self.outfile.write(' (GDBusAnnotationInfo **) &_%s_property_%s_annotation_info_pointers\n'%(i.name_lower, p.name_lower)) 1254 self.outfile.write(' },\n' 1255 ' "%s",\n' 1256 %(p.name_hyphen)) 1257 if not utils.lookup_annotation(p.annotations, 'org.gtk.GDBus.C.ForceGVariant'): 1258 self.outfile.write(' FALSE,\n') 1259 else: 1260 self.outfile.write(' TRUE,\n') 1261 if p.emits_changed_signal: 1262 self.outfile.write(' TRUE\n') 1263 else: 1264 self.outfile.write(' FALSE\n') 1265 self.outfile.write('};\n' 1266 '\n') 1267 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' 1273 '};\n' 1274 '\n') 1275 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' 1278 '{\n' 1279 ' {\n' 1280 ' -1,\n' 1281 ' (gchar *) "%s",\n'%(i.name_lower, i.name)) 1282 if len(i.methods) == 0: 1283 self.outfile.write(' NULL,\n') 1284 else: 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') 1288 else: 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') 1292 else: 1293 self.outfile.write(' (GDBusPropertyInfo **) &_%s_property_info_pointers,\n'%(i.name_lower)) 1294 if num_anno == 0: 1295 self.outfile.write(' NULL\n') 1296 else: 1297 self.outfile.write(' (GDBusAnnotationInfo **) &_%s_annotation_info_pointers\n'%(i.name_lower)) 1298 self.outfile.write(' },\n' 1299 ' "%s",\n' 1300 '};\n' 1301 '\n' 1302 %(i.name_hyphen)) 1303 self.outfile.write('\n') 1304 self.outfile.write(self.docbook_gen.expand( 1305 '/**\n' 1306 ' * %s_interface_info:\n' 1307 ' *\n' 1308 ' * Gets a machine-readable description of the #%s D-Bus interface.\n' 1309 ' *\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' 1315 '{\n' 1316 ' return (GDBusInterfaceInfo *) &_%s_interface_info.parent_struct;\n' 1317 '}\n' 1318 '\n'%(i.name_lower, i.name_lower)) 1319 1320 self.outfile.write(self.docbook_gen.expand( 1321 '/**\n' 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' 1325 ' *\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' 1328 ' *\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' 1338 '}\n' 1339 '\n') 1340 self.outfile.write('\n') 1341 1342 # ---------------------------------------------------------------------------------------------------- 1343 1344 def generate_interface(self, i): 1345 self.outfile.write('\n') 1346 1347 self.outfile.write(self.docbook_gen.expand( 1348 '/**\n' 1349 ' * %s:\n' 1350 ' *\n' 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') 1355 1356 self.outfile.write(self.docbook_gen.expand( 1357 '/**\n' 1358 ' * %sIface:\n' 1359 ' * @parent_iface: The parent interface.\n' 1360 %(i.camel_name), False)) 1361 1362 doc_bits = {} 1363 if len(i.methods) > 0: 1364 for m in i.methods: 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: 1370 for s in i.signals: 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]) 1383 1384 self.outfile.write(self.docbook_gen.expand( 1385 ' *\n' 1386 ' * Virtual table for the D-Bus interface #%s.\n' 1387 %(i.name), False)) 1388 self.write_gtkdoc_deprecated_and_since_and_close(i, self.outfile, 0) 1389 self.outfile.write('\n') 1390 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') 1394 1395 self.outfile.write('static void\n' 1396 '%s_default_init (%sIface *iface)\n' 1397 '{\n'%(i.name_lower, i.camel_name)); 1398 1399 if len(i.methods) > 0: 1400 self.outfile.write(' /* GObject signals for incoming D-Bus method calls: */\n') 1401 for m in i.methods: 1402 unix_fd = False 1403 if utils.lookup_annotation(m.annotations, 'org.gtk.GDBus.C.UnixFD'): 1404 unix_fd = True 1405 self.outfile.write(self.docbook_gen.expand( 1406 ' /**\n' 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)) 1411 if unix_fd: 1412 self.outfile.write(' * @fd_list: (nullable): A #GUnixFDList or %NULL.\n') 1413 for a in m.in_args: 1414 self.outfile.write(' * @arg_%s: Argument passed by remote caller.\n'%(a.name)) 1415 self.outfile.write(self.docbook_gen.expand( 1416 ' *\n' 1417 ' * Signal emitted when a remote caller is invoking the %s.%s() D-Bus method.\n' 1418 ' *\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' 1420 ' *\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) 1424 if unix_fd: 1425 extra_args = 2 1426 else: 1427 extra_args = 1 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' 1436 ' %d,\n' 1437 ' G_TYPE_DBUS_METHOD_INVOCATION' 1438 %(m.name_hyphen, i.camel_name, m.name_lower, len(m.in_args) + extra_args)) 1439 if unix_fd: 1440 self.outfile.write(', G_TYPE_UNIX_FD_LIST') 1441 for a in m.in_args: 1442 self.outfile.write(', %s'%(a.gtype)) 1443 self.outfile.write(');\n') 1444 self.outfile.write('\n') 1445 1446 if len(i.signals) > 0: 1447 self.outfile.write(' /* GObject signals for received D-Bus signals: */\n') 1448 for s in i.signals: 1449 self.outfile.write(self.docbook_gen.expand( 1450 ' /**\n' 1451 ' * %s::%s:\n' 1452 ' * @object: A #%s.\n' 1453 %(i.camel_name, s.name_hyphen, i.camel_name), False)) 1454 for a in s.args: 1455 self.outfile.write(' * @arg_%s: Argument.\n'%(a.name)) 1456 self.outfile.write(self.docbook_gen.expand( 1457 ' *\n' 1458 ' * On the client-side, this signal is emitted whenever the D-Bus signal #%s::%s is received.\n' 1459 ' *\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' 1470 ' G_TYPE_NONE,\n' 1471 ' %d' 1472 %(s.name_hyphen, i.camel_name, s.name_lower, len(s.args))) 1473 for a in s.args: 1474 self.outfile.write(', %s'%(a.gtype)) 1475 self.outfile.write(');\n') 1476 self.outfile.write('\n') 1477 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.' 1483 elif p.readable: 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.' 1485 elif p.writable: 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.' 1487 else: 1488 print_error('Cannot handle property "{}" that neither readable nor writable'.format(p.name)) 1489 self.outfile.write(self.docbook_gen.expand( 1490 ' /**\n' 1491 ' * %s:%s:\n' 1492 ' *\n' 1493 ' * Represents the D-Bus property #%s:%s.\n' 1494 ' *\n' 1495 ' * %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) 1533 else: 1534 print_error('Unsupported gtype "{}" for GParamSpec'.format(p.arg.gtype)) 1535 flags = 'G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS' 1536 if p.deprecated: 1537 flags = 'G_PARAM_DEPRECATED | ' + flags 1538 self.outfile.write(' %s, %s));'%(s, flags)); 1539 self.outfile.write('\n') 1540 1541 self.outfile.write('}\n' 1542 '\n') 1543 1544 # ---------------------------------------------------------------------------------------------------- 1545 1546 def generate_property_accessors(self, i): 1547 for p in i.properties: 1548 # getter 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.' 1551 elif p.readable: 1552 hint = 'Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side.' 1553 elif p.writable: 1554 hint = 'Since this D-Bus property is not readable, it is only meaningful to use this function on the service-side.' 1555 else: 1556 print_error('Cannot handle property "{}" that neither readable nor writable'.format(p.name)) 1557 self.outfile.write(self.docbook_gen.expand( 1558 '/**\n' 1559 ' * %s_get_%s: (skip)\n' 1560 ' * @object: A #%s.\n' 1561 ' *\n' 1562 ' * Gets the value of the #%s:%s D-Bus property.\n' 1563 ' *\n' 1564 ' * %s\n' 1565 ' *\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' 1569 ' *\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)) 1572 else: 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: 1582 1583 self.outfile.write(self.docbook_gen.expand( 1584 '/**\n' 1585 ' * %s_dup_%s: (skip)\n' 1586 ' * @object: A #%s.\n' 1587 ' *\n' 1588 ' * Gets a copy of the #%s:%s D-Bus property.\n' 1589 ' *\n' 1590 ' * %s\n' 1591 ' *\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' 1597 '{\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') 1603 1604 # setter 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.' 1607 elif p.readable: 1608 hint = 'Since this D-Bus property is not writable, it is only meaningful to use this function on the service-side.' 1609 elif p.writable: 1610 hint = 'Since this D-Bus property is writable, it is meaningful to use this function on both the client- and service-side.' 1611 else: 1612 print_error('Cannot handle property "{}" that neither readable nor writable'.format(p.name)) 1613 self.outfile.write(self.docbook_gen.expand( 1614 '/**\n' 1615 ' * %s_set_%s: (skip)\n' 1616 ' * @object: A #%s.\n' 1617 ' * @value: The value to set.\n' 1618 ' *\n' 1619 ' * Sets the #%s:%s D-Bus property to @value.\n' 1620 ' *\n' 1621 ' * %s\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') 1630 1631 # --------------------------------------------------------------------------------------------------- 1632 1633 def generate_signal_emitters(self, i): 1634 for s in i.signals: 1635 self.outfile.write(self.docbook_gen.expand( 1636 '/**\n' 1637 ' * %s_emit_%s:\n' 1638 ' * @object: A #%s.\n' 1639 %(i.name_lower, s.name_lower, i.camel_name), False)) 1640 for a in s.args: 1641 self.outfile.write(' * @arg_%s: Argument to pass with the signal.\n'%(a.name)) 1642 self.outfile.write(self.docbook_gen.expand( 1643 ' *\n' 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' 1648 '%s_emit_%s (\n' 1649 ' %s *object'%(i.name_lower, s.name_lower, i.camel_name)) 1650 for a in s.args: 1651 self.outfile.write(',\n %sarg_%s'%(a.ctype_in, a.name)) 1652 self.outfile.write(')\n' 1653 '{\n' 1654 ' g_signal_emit_by_name (object, "%s"'%(s.name_hyphen)) 1655 for a in s.args: 1656 self.outfile.write(', arg_%s'%a.name) 1657 self.outfile.write(');\n') 1658 self.outfile.write('}\n' 1659 '\n') 1660 1661 # --------------------------------------------------------------------------------------------------- 1662 1663 def generate_method_calls(self, i): 1664 for m in i.methods: 1665 unix_fd = False 1666 if utils.lookup_annotation(m.annotations, 'org.gtk.GDBus.C.UnixFD'): 1667 unix_fd = True 1668 # async begin 1669 self.outfile.write('/**\n' 1670 ' * %s_call_%s:\n' 1671 ' * @proxy: A #%sProxy.\n' 1672 %(i.name_lower, m.name_lower, i.camel_name)) 1673 for a in m.in_args: 1674 self.outfile.write(' * @arg_%s: Argument to pass with the method invocation.\n'%(a.name)) 1675 if unix_fd: 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' 1681 ' *\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' 1685 ' *\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' 1690 '%s_call_%s (\n' 1691 ' %s *proxy'%(i.name_lower, m.name_lower, i.camel_name)) 1692 for a in m.in_args: 1693 self.outfile.write(',\n %sarg_%s'%(a.ctype_in, a.name)) 1694 if unix_fd: 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' 1700 '{\n') 1701 if unix_fd: 1702 self.outfile.write(' g_dbus_proxy_call_with_unix_fd_list (G_DBUS_PROXY (proxy),\n') 1703 else: 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)) 1707 for a in m.in_args: 1708 self.outfile.write('%s'%(a.format_in)) 1709 self.outfile.write(')"') 1710 for a in m.in_args: 1711 self.outfile.write(',\n arg_%s'%(a.name)) 1712 self.outfile.write('),\n' 1713 ' G_DBUS_CALL_FLAGS_NONE,\n' 1714 ' -1,\n') 1715 if unix_fd: 1716 self.outfile.write(' fd_list,\n') 1717 self.outfile.write(' cancellable,\n' 1718 ' callback,\n' 1719 ' user_data);\n') 1720 self.outfile.write('}\n' 1721 '\n') 1722 # async finish 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 '')) 1729 if unix_fd: 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' 1734 ' *\n' 1735 ' * Finishes an operation started with %s_call_%s().\n' 1736 ' *\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)) 1745 if unix_fd: 1746 self.outfile.write(',\n GUnixFDList **out_fd_list') 1747 self.outfile.write(',\n' 1748 ' GAsyncResult *res,\n' 1749 ' GError **error)\n' 1750 '{\n' 1751 ' GVariant *_ret;\n') 1752 if unix_fd: 1753 self.outfile.write(' _ret = g_dbus_proxy_call_with_unix_fd_list_finish (G_DBUS_PROXY (proxy), out_fd_list, res, error);\n') 1754 else: 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' 1757 ' goto _out;\n') 1758 self.outfile.write(' g_variant_get (_ret,\n' 1759 ' \"(') 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' 1769 '}\n' 1770 '\n') 1771 1772 1773 # sync 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)) 1778 for a in m.in_args: 1779 self.outfile.write(' * @arg_%s: Argument to pass with the method invocation.\n'%(a.name)) 1780 if unix_fd: 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 '')) 1784 if unix_fd: 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' 1789 ' *\n' 1790 ' * Synchronously invokes the %s.%s() D-Bus method on @proxy. The calling thread is blocked until a reply is received.\n' 1791 ' *\n' 1792 ' * See %s_call_%s() for the asynchronous version of this method.\n' 1793 ' *\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)) 1800 for a in m.in_args: 1801 self.outfile.write(',\n %sarg_%s'%(a.ctype_in, a.name)) 1802 if unix_fd: 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)) 1806 if unix_fd: 1807 self.outfile.write(',\n GUnixFDList **out_fd_list') 1808 self.outfile.write(',\n' 1809 ' GCancellable *cancellable,\n' 1810 ' GError **error)\n' 1811 '{\n' 1812 ' GVariant *_ret;\n') 1813 if unix_fd: 1814 self.outfile.write(' _ret = g_dbus_proxy_call_with_unix_fd_list_sync (G_DBUS_PROXY (proxy),\n') 1815 else: 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)) 1819 for a in m.in_args: 1820 self.outfile.write('%s'%(a.format_in)) 1821 self.outfile.write(')"') 1822 for a in m.in_args: 1823 self.outfile.write(',\n arg_%s'%(a.name)) 1824 self.outfile.write('),\n' 1825 ' G_DBUS_CALL_FLAGS_NONE,\n' 1826 ' -1,\n') 1827 if unix_fd: 1828 self.outfile.write(' fd_list,\n' 1829 ' out_fd_list,\n') 1830 self.outfile.write(' cancellable,\n' 1831 ' error);\n' 1832 ' if (_ret == NULL)\n' 1833 ' goto _out;\n') 1834 self.outfile.write(' g_variant_get (_ret,\n' 1835 ' \"(') 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' 1845 '}\n' 1846 '\n') 1847 1848 # --------------------------------------------------------------------------------------------------- 1849 1850 def generate_method_completers(self, i): 1851 for m in i.methods: 1852 unix_fd = False 1853 if utils.lookup_annotation(m.annotations, 'org.gtk.GDBus.C.UnixFD'): 1854 unix_fd = True 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)) 1860 if unix_fd: 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( 1865 ' *\n' 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' 1867 ' *\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' 1873 ' %s *object,\n' 1874 ' GDBusMethodInvocation *invocation'%(i.name_lower, m.name_lower, i.camel_name)) 1875 if unix_fd: 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' 1880 '{\n') 1881 1882 if unix_fd: 1883 self.outfile.write(' g_dbus_method_invocation_return_value_with_unix_fd_list (invocation,\n' 1884 ' g_variant_new ("(') 1885 else: 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)) 1893 if unix_fd: 1894 self.outfile.write('),\n fd_list);\n') 1895 else: 1896 self.outfile.write('));\n') 1897 self.outfile.write('}\n' 1898 '\n') 1899 1900 # --------------------------------------------------------------------------------------------------- 1901 1902 def generate_proxy(self, i): 1903 # class boilerplate 1904 self.outfile.write('/* ------------------------------------------------------------------------ */\n' 1905 '\n') 1906 1907 self.outfile.write(self.docbook_gen.expand( 1908 '/**\n' 1909 ' * %sProxy:\n' 1910 ' *\n' 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') 1915 1916 self.outfile.write(self.docbook_gen.expand( 1917 '/**\n' 1918 ' * %sProxyClass:\n' 1919 ' * @parent_class: The parent class.\n' 1920 ' *\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') 1925 1926 self.outfile.write('struct _%sProxyPrivate\n' 1927 '{\n' 1928 ' GData *qdata;\n' 1929 '};\n' 1930 '\n'%i.camel_name) 1931 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') 1942 1943 # finalize 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' 1950 '}\n' 1951 '\n'%(i.name_lower)) 1952 1953 # property accessors 1954 # 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 1957 # 1958 self.outfile.write('static void\n' 1959 '%s_proxy_get_property (GObject *object,\n' 1960 ' guint prop_id,\n' 1961 ' GValue *value,\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' 1971 ' {\n' 1972 ' g_value_set_variant (value, variant);\n' 1973 ' }\n' 1974 ' else\n' 1975 ' {\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' 1980 ' }\n' 1981 ' if (variant != NULL)\n' 1982 ' g_variant_unref (variant);\n' 1983 %(len(i.properties), i.name_lower)) 1984 self.outfile.write('}\n' 1985 '\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' 1993 ' GError *error;\n' 1994 ' GVariant *_ret;\n' 1995 ' error = NULL;\n' 1996 ' _ret = g_dbus_proxy_call_finish (proxy, res, &error);\n' 1997 ' if (!_ret)\n' 1998 ' {\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' 2003 ' }\n' 2004 ' else\n' 2005 ' {\n' 2006 ' g_variant_unref (_ret);\n' 2007 ' }\n' 2008 %(i.name)) 2009 self.outfile.write('}\n' 2010 '\n') 2011 self.outfile.write('static void\n' 2012 '%s_proxy_set_property (GObject *object,\n' 2013 ' guint prop_id,\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' 2027 ' -1,\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' 2032 '\n') 2033 2034 # signal received 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' 2046 ' gsize n;\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' 2051 ' return;\n' 2052 %(i.name_lower)) 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' 2059 ' n = 1;\n' 2060 ' while ((child = g_variant_iter_next_value (&iter)) != NULL)\n' 2061 ' {\n' 2062 ' _ExtendedGDBusArgInfo *arg_info = (_ExtendedGDBusArgInfo *) info->parent_struct.args[n - 1];\n' 2063 ' if (arg_info->use_gvariant)\n' 2064 ' {\n' 2065 ' g_value_init (¶mv[n], G_TYPE_VARIANT);\n' 2066 ' g_value_set_variant (¶mv[n], child);\n' 2067 ' n++;\n' 2068 ' }\n' 2069 ' else\n' 2070 ' g_dbus_gvariant_to_gvalue (child, ¶mv[n++]);\n' 2071 ' g_variant_unref (child);\n' 2072 ' }\n' 2073 ) 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' 2081 '\n') 2082 2083 # property changed 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' 2091 ' guint n;\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' 2097 ' {\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' 2102 ' }\n' 2103 ' g_variant_iter_free (iter);\n' 2104 ' for (n = 0; invalidated_properties[n] != NULL; n++)\n' 2105 ' {\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' 2110 ' }\n' 2111 '}\n' 2112 '\n' 2113 %(i.camel_name, i.ns_upper, i.name_upper, 2114 i.name_lower, i.name_lower)) 2115 2116 # property vfuncs 2117 for p in i.properties: 2118 nul_value = '0' 2119 if p.arg.free_func != None: 2120 nul_value = 'NULL' 2121 self.outfile.write('static %s\n' 2122 '%s_proxy_get_%s (%s *object)\n' 2123 '{\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 2132 # for details 2133 # 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 2140 # 2141 if free_container: 2142 self.outfile.write(' value = g_datalist_get_data (&proxy->priv->qdata, \"%s\");\n' 2143 ' if (value != NULL)\n' 2144 ' return value;\n' 2145 %(p.name)) 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') 2151 else: 2152 self.outfile.write(' if (variant != NULL)\n' 2153 ' {\n') 2154 extra_len = '' 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)) 2158 if free_container: 2159 self.outfile.write(' g_datalist_set_data_full (&proxy->priv->qdata, \"%s\", (gpointer) value, g_free);\n' 2160 %(p.name)) 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') 2166 2167 # class boilerplate 2168 self.outfile.write('static void\n' 2169 '%s_proxy_init (%sProxy *proxy)\n' 2170 '{\n' 2171 '#if GLIB_VERSION_MAX_ALLOWED >= GLIB_VERSION_2_38\n' 2172 ' proxy->priv = %s_proxy_get_instance_private (proxy);\n' 2173 '#else\n' 2174 ' proxy->priv = G_TYPE_INSTANCE_GET_PRIVATE (proxy, %sTYPE_%s_PROXY, %sProxyPrivate);\n' 2175 '#endif\n\n' 2176 ' g_dbus_proxy_set_interface_info (G_DBUS_PROXY (proxy), %s_interface_info ());\n' 2177 '}\n' 2178 '\n' 2179 %(i.name_lower, i.camel_name, 2180 i.name_lower, 2181 i.ns_upper, i.name_upper, i.camel_name, 2182 i.name_lower)) 2183 self.outfile.write('static void\n' 2184 '%s_proxy_class_init (%sProxyClass *klass)\n' 2185 '{\n' 2186 ' GObjectClass *gobject_class;\n' 2187 ' GDBusProxyClass *proxy_class;\n' 2188 '\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' 2193 '\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' 2205 '\n') 2206 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' 2213 '\n') 2214 2215 # constructors 2216 self.outfile.write(self.docbook_gen.expand( 2217 '/**\n' 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' 2226 ' *\n' 2227 ' * Asynchronously creates a proxy for the D-Bus interface #%s. See g_dbus_proxy_new() for more details.\n' 2228 ' *\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' 2231 ' *\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' 2236 '%s_proxy_new (\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' 2244 '{\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' 2246 '}\n' 2247 '\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' 2253 ' *\n' 2254 ' * Finishes an operation started with %s_proxy_new().\n' 2255 ' *\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' 2263 '{\n' 2264 ' GObject *ret;\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' 2271 ' else\n' 2272 ' return NULL;\n' 2273 '}\n' 2274 '\n' 2275 %(i.camel_name, i.name_lower, i.ns_upper, i.name_upper)) 2276 self.outfile.write(self.docbook_gen.expand( 2277 '/**\n' 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' 2285 ' *\n' 2286 ' * Synchronously creates a proxy for the D-Bus interface #%s. See g_dbus_proxy_new_sync() for more details.\n' 2287 ' *\n' 2288 ' * The calling thread is blocked until a reply is received.\n' 2289 ' *\n' 2290 ' * See %s_proxy_new() for the asynchronous version of this constructor.\n' 2291 ' *\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' 2303 '{\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' 2308 ' else\n' 2309 ' return NULL;\n' 2310 '}\n' 2311 '\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( 2315 '/**\n' 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' 2324 ' *\n' 2325 ' * Like %s_proxy_new() but takes a #GBusType instead of a #GDBusConnection.\n' 2326 ' *\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' 2329 ' *\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' 2342 '{\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' 2344 '}\n' 2345 '\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' 2351 ' *\n' 2352 ' * Finishes an operation started with %s_proxy_new_for_bus().\n' 2353 ' *\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' 2361 '{\n' 2362 ' GObject *ret;\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' 2369 ' else\n' 2370 ' return NULL;\n' 2371 '}\n' 2372 '\n' 2373 %(i.camel_name, i.name_lower, i.ns_upper, i.name_upper)) 2374 self.outfile.write(self.docbook_gen.expand( 2375 '/**\n' 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' 2383 ' *\n' 2384 ' * Like %s_proxy_new_sync() but takes a #GBusType instead of a #GDBusConnection.\n' 2385 ' *\n' 2386 ' * The calling thread is blocked until a reply is received.\n' 2387 ' *\n' 2388 ' * See %s_proxy_new_for_bus() for the asynchronous version of this constructor.\n' 2389 ' *\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' 2401 '{\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' 2406 ' else\n' 2407 ' return NULL;\n' 2408 '}\n' 2409 '\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') 2412 2413 # --------------------------------------------------------------------------------------------------- 2414 2415 def generate_skeleton(self, i): 2416 # class boilerplate 2417 self.outfile.write('/* ------------------------------------------------------------------------ */\n' 2418 '\n') 2419 2420 self.outfile.write(self.docbook_gen.expand( 2421 '/**\n' 2422 ' * %sSkeleton:\n' 2423 ' *\n' 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') 2428 2429 self.outfile.write(self.docbook_gen.expand( 2430 '/**\n' 2431 ' * %sSkeletonClass:\n' 2432 ' * @parent_class: The parent class.\n' 2433 ' *\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') 2438 2439 self.outfile.write('struct _%sSkeletonPrivate\n' 2440 '{\n' 2441 ' GValue *properties;\n' 2442 ' GList *changed_properties;\n' 2443 ' GSource *changed_properties_idle_source;\n' 2444 ' GMainContext *context;\n' 2445 ' GMutex lock;\n' 2446 '};\n' 2447 '\n'%i.camel_name) 2448 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' 2459 '{\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' 2467 ' gsize n;\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' 2473 %()) 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' 2477 ' n = 0;\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' 2483 ' {\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' 2487 '#else\n' 2488 ' g_assert_not_reached ();\n' 2489 '#endif\n' 2490 ' }\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' 2494 ' {\n' 2495 ' _ExtendedGDBusArgInfo *arg_info = (_ExtendedGDBusArgInfo *) info->parent_struct.in_args[n - num_extra];\n' 2496 ' if (arg_info->use_gvariant)\n' 2497 ' {\n' 2498 ' g_value_init (¶mv[n], G_TYPE_VARIANT);\n' 2499 ' g_value_set_variant (¶mv[n], child);\n' 2500 ' n++;\n' 2501 ' }\n' 2502 ' else\n' 2503 ' g_dbus_gvariant_to_gvalue (child, ¶mv[n++]);\n' 2504 ' g_variant_unref (child);\n' 2505 ' }\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' 2517 '\n') 2518 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' 2528 '{\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' 2533 ' GVariant *ret;\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' 2540 ' {\n' 2541 ' g_set_error (error, G_DBUS_ERROR, G_DBUS_ERROR_INVALID_ARGS, "No property with name %%s", property_name);\n' 2542 ' }\n' 2543 ' else\n' 2544 ' {\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' 2549 ' }\n' 2550 ' return ret;\n' 2551 '}\n' 2552 '\n' 2553 %(i.name_lower)) 2554 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' 2565 '{\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' 2570 ' gboolean ret;\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' 2577 ' {\n' 2578 ' g_set_error (error, G_DBUS_ERROR, G_DBUS_ERROR_INVALID_ARGS, "No property with name %%s", property_name);\n' 2579 ' }\n' 2580 ' else\n' 2581 ' {\n' 2582 ' if (info->use_gvariant)\n' 2583 ' g_value_set_variant (&value, variant);\n' 2584 ' else\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' 2588 ' ret = TRUE;\n' 2589 ' }\n' 2590 ' return ret;\n' 2591 '}\n' 2592 '\n' 2593 %(i.name_lower)) 2594 2595 2596 self.outfile.write('static const GDBusInterfaceVTable _%s_skeleton_vtable =\n' 2597 '{\n' 2598 ' _%s_skeleton_handle_method_call,\n' 2599 ' _%s_skeleton_handle_get_property,\n' 2600 ' _%s_skeleton_handle_set_property,\n' 2601 ' {NULL}\n' 2602 '};\n' 2603 '\n'%(i.name_lower, i.name_lower, i.name_lower, i.name_lower)) 2604 2605 self.outfile.write('static GDBusInterfaceInfo *\n' 2606 '%s_skeleton_dbus_interface_get_info (GDBusInterfaceSkeleton *skeleton G_GNUC_UNUSED)\n' 2607 '{\n' 2608 ' return %s_interface_info ();\n' 2609 %(i.name_lower, i.name_lower)) 2610 self.outfile.write('}\n' 2611 '\n') 2612 2613 self.outfile.write('static GDBusInterfaceVTable *\n' 2614 '%s_skeleton_dbus_interface_get_vtable (GDBusInterfaceSkeleton *skeleton G_GNUC_UNUSED)\n' 2615 '{\n' 2616 ' return (GDBusInterfaceVTable *) &_%s_skeleton_vtable;\n' 2617 %(i.name_lower, i.name_lower)) 2618 self.outfile.write('}\n' 2619 '\n') 2620 2621 self.outfile.write('static GVariant *\n' 2622 '%s_skeleton_dbus_interface_get_properties (GDBusInterfaceSkeleton *_skeleton)\n' 2623 '{\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' 2628 ' guint n;\n' 2629 ' g_variant_builder_init (&builder, G_VARIANT_TYPE ("a{sv}"));\n' 2630 ' if (_%s_interface_info.parent_struct.properties == NULL)\n' 2631 ' goto out;\n' 2632 ' for (n = 0; _%s_interface_info.parent_struct.properties[n] != NULL; n++)\n' 2633 ' {\n' 2634 ' GDBusPropertyInfo *info = _%s_interface_info.parent_struct.properties[n];\n' 2635 ' if (info->flags & G_DBUS_PROPERTY_INFO_FLAGS_READABLE)\n' 2636 ' {\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' 2640 ' {\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' 2644 ' }\n' 2645 ' }\n' 2646 ' }\n' 2647 'out:\n' 2648 ' return g_variant_builder_end (&builder);\n' 2649 '}\n' 2650 '\n' 2651 %(i.name_lower, i.name_lower, i.name_lower, i.name_lower, i.name)) 2652 2653 if len(i.properties) > 0: 2654 self.outfile.write('static gboolean _%s_emit_changed (gpointer user_data);\n' 2655 '\n' 2656 %(i.name_lower)) 2657 2658 self.outfile.write('static void\n' 2659 '%s_skeleton_dbus_interface_flush (GDBusInterfaceSkeleton *_skeleton)\n' 2660 '{\n' 2661 %(i.name_lower)) 2662 if len(i.properties) > 0: 2663 self.outfile.write(' %sSkeleton *skeleton = %s%s_SKELETON (_skeleton);\n' 2664 ' gboolean emit_changed = FALSE;\n' 2665 '\n' 2666 ' g_mutex_lock (&skeleton->priv->lock);\n' 2667 ' if (skeleton->priv->changed_properties_idle_source != NULL)\n' 2668 ' {\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' 2672 ' }\n' 2673 ' g_mutex_unlock (&skeleton->priv->lock);\n' 2674 '\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' 2679 '\n') 2680 2681 for s in i.signals: 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)) 2685 for a in s.args: 2686 self.outfile.write(',\n %sarg_%s'%(a.ctype_in, a.name)) 2687 self.outfile.write(')\n' 2688 '{\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 ("(') 2696 for a in s.args: 2697 self.outfile.write('%s'%(a.format_in)) 2698 self.outfile.write(')"') 2699 for a in s.args: 2700 self.outfile.write(',\n arg_%s'%(a.name)) 2701 self.outfile.write('));\n') 2702 2703 self.outfile.write(' for (l = connections; l != NULL; l = l->next)\n' 2704 ' {\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' 2709 ' }\n' 2710 %(i.name, s.name)) 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' 2714 '\n') 2715 2716 self.outfile.write('static void %s_skeleton_iface_init (%sIface *iface);\n' 2717 %(i.name_lower, i.camel_name)) 2718 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') 2727 2728 # finalize 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' 2744 '}\n' 2745 '\n'%(i.name_lower)) 2746 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' 2751 ' guint prop_id,\n' 2752 ' GValue *value,\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' 2762 '\n') 2763 2764 # if property is already scheduled then re-use entry.. though it could be 2765 # that the user did 2766 # 2767 # foo_set_prop_bar (object, ""); 2768 # foo_set_prop_bar (object, "blah"); 2769 # 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 2775 # 2776 self.outfile.write('static gboolean\n' 2777 '_%s_emit_changed (gpointer user_data)\n' 2778 '{\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' 2785 '\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' 2790 ' {\n' 2791 ' ChangedProperty *cp = l->data;\n' 2792 ' GVariant *variant;\n' 2793 ' const GValue *cur_value;\n' 2794 '\n' 2795 ' cur_value = &skeleton->priv->properties[cp->prop_id - 1];\n' 2796 ' if (!_g_value_equal (cur_value, &cp->orig_value))\n' 2797 ' {\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' 2801 ' num_changes++;\n' 2802 ' }\n' 2803 ' }\n' 2804 ' if (num_changes > 0)\n' 2805 ' {\n' 2806 ' GList *connections, *ll;\n' 2807 ' GVariant *signal_variant;' 2808 '\n' 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' 2813 ' {\n' 2814 ' GDBusConnection *connection = ll->data;\n' 2815 '\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' 2821 ' NULL);\n' 2822 ' }\n' 2823 ' g_variant_unref (signal_variant);\n' 2824 ' g_list_free_full (connections, g_object_unref);\n' 2825 ' }\n' 2826 ' else\n' 2827 ' {\n' 2828 ' g_variant_builder_clear (&builder);\n' 2829 ' g_variant_builder_clear (&invalidated_builder);\n' 2830 ' }\n' 2831 %(i.name)) 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' 2837 '}\n' 2838 '\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' 2842 '{\n' 2843 ' ChangedProperty *cp;\n' 2844 ' GList *l;\n' 2845 ' cp = NULL;\n' 2846 ' for (l = skeleton->priv->changed_properties; l != NULL; l = l->next)\n' 2847 ' {\n' 2848 ' ChangedProperty *i_cp = l->data;\n' 2849 ' if (i_cp->info == info)\n' 2850 ' {\n' 2851 ' cp = i_cp;\n' 2852 ' break;\n' 2853 ' }\n' 2854 ' }\n' 2855 %(i.name_lower, i.camel_name)) 2856 self.outfile.write(' if (cp == NULL)\n' 2857 ' {\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' 2864 ' }\n' 2865 '}\n' 2866 '\n' 2867 %()) 2868 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' 2876 '{\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' 2881 ' {\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' 2888 ' }\n' 2889 ' g_mutex_unlock (&skeleton->priv->lock);\n' 2890 '}\n' 2891 '\n' 2892 %(i.name_lower, i.camel_name, i.ns_upper, i.name_upper, i.name_lower, i.name_lower)) 2893 2894 self.outfile.write('static void\n' 2895 '%s_skeleton_set_property (GObject *object,\n' 2896 ' guint prop_id,\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' 2907 ' {\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' 2913 ' }\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' 2918 '\n') 2919 2920 self.outfile.write('static void\n' 2921 '%s_skeleton_init (%sSkeleton *skeleton)\n' 2922 '{\n' 2923 '#if GLIB_VERSION_MAX_ALLOWED >= GLIB_VERSION_2_38\n' 2924 ' skeleton->priv = %s_skeleton_get_instance_private (skeleton);\n' 2925 '#else\n' 2926 ' skeleton->priv = G_TYPE_INSTANCE_GET_PRIVATE (skeleton, %sTYPE_%s_SKELETON, %sSkeletonPrivate);\n' 2927 '#endif\n\n' 2928 %(i.name_lower, i.camel_name, 2929 i.name_lower, 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))) 2935 n = 0 2936 for p in i.properties: 2937 self.outfile.write(' g_value_init (&skeleton->priv->properties[%d], %s);\n'%(n, p.arg.gtype)) 2938 n += 1 2939 self.outfile.write('}\n' 2940 '\n') 2941 2942 # property vfuncs 2943 n = 0 2944 for p in i.properties: 2945 self.outfile.write('static %s\n' 2946 '%s_skeleton_get_%s (%s *object)\n' 2947 '{\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') 2958 n += 1 2959 2960 self.outfile.write('static void\n' 2961 '%s_skeleton_class_init (%sSkeletonClass *klass)\n' 2962 '{\n' 2963 ' GObjectClass *gobject_class;\n' 2964 ' GDBusInterfaceSkeletonClass *skeleton_class;\n' 2965 '\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)) 2982 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)) 2987 2988 self.outfile.write('}\n' 2989 '\n') 2990 2991 self.outfile.write('static void\n' 2992 '%s_skeleton_iface_init (%sIface *iface)\n' 2993 '{\n' 2994 %(i.name_lower, i.camel_name)) 2995 for s in i.signals: 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' 3001 '\n') 3002 3003 # constructors 3004 self.outfile.write(self.docbook_gen.expand( 3005 '/**\n' 3006 ' * %s_skeleton_new:\n' 3007 ' *\n' 3008 ' * Creates a skeleton object for the D-Bus interface #%s.\n' 3009 ' *\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' 3015 '{\n' 3016 ' return %s%s (g_object_new (%sTYPE_%s_SKELETON, NULL));\n' 3017 '}\n' 3018 '\n'%(i.camel_name, i.name_lower, i.ns_upper, i.name_upper, i.ns_upper, i.name_upper)) 3019 3020 # --------------------------------------------------------------------------------------------------- 3021 3022 def generate_object(self): 3023 self.outfile.write('/* ------------------------------------------------------------------------\n' 3024 ' * Code for Object, ObjectProxy and ObjectSkeleton\n' 3025 ' * ------------------------------------------------------------------------\n' 3026 ' */\n' 3027 '\n') 3028 3029 self.outfile.write(self.docbook_gen.expand( 3030 '/**\n' 3031 ' * SECTION:%sObject\n' 3032 ' * @title: %sObject\n' 3033 ' * @short_description: Specialized GDBusObject types\n' 3034 ' *\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' 3036 ' */\n' 3037 %(self.namespace, self.namespace, self.namespace, self.namespace, self.namespace), False)) 3038 self.outfile.write('\n') 3039 3040 self.outfile.write(self.docbook_gen.expand( 3041 '/**\n' 3042 ' * %sObject:\n' 3043 ' *\n' 3044 ' * The #%sObject type is a specialized container of interfaces.\n' 3045 ' */\n' 3046 %(self.namespace, self.namespace), False)) 3047 self.outfile.write('\n') 3048 3049 self.outfile.write(self.docbook_gen.expand( 3050 '/**\n' 3051 ' * %sObjectIface:\n' 3052 ' * @parent_iface: The parent interface.\n' 3053 ' *\n' 3054 ' * Virtual table for the #%sObject interface.\n' 3055 ' */\n' 3056 %(self.namespace, self.namespace), False)) 3057 self.outfile.write('\n') 3058 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' 3064 '{\n' 3065 %(self.ns_lower, self.namespace)); 3066 for i in self.ifaces: 3067 self.outfile.write(self.docbook_gen.expand( 3068 ' /**\n' 3069 ' * %sObject:%s:\n' 3070 ' *\n' 3071 ' * The #%s instance corresponding to the D-Bus interface #%s, if any.\n' 3072 ' *\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' 3077 if i.deprecated: 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' 3080 '\n' 3081 %(i.name_hyphen, i.name_hyphen, i.name_hyphen, self.ns_upper, i.name_upper, flags)) 3082 self.outfile.write('}\n' 3083 '\n') 3084 3085 for i in self.ifaces: 3086 self.outfile.write(self.docbook_gen.expand( 3087 '/**\n' 3088 ' * %sobject_get_%s:\n' 3089 ' * @object: A #%sObject.\n' 3090 ' *\n' 3091 ' * Gets the #%s instance for the D-Bus interface #%s on @object, if any.\n' 3092 ' *\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' 3102 ' return NULL;\n' 3103 ' return %s%s (ret);\n' 3104 '}\n' 3105 '\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( 3110 '/**\n' 3111 ' * %sobject_peek_%s: (skip)\n' 3112 ' * @object: A #%sObject.\n' 3113 ' *\n' 3114 ' * Like %sobject_get_%s() but doesn\'t increase the reference count on the returned object.\n' 3115 ' *\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' 3117 ' *\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' 3127 ' return NULL;\n' 3128 ' g_object_unref (ret);\n' 3129 ' return %s%s (ret);\n' 3130 '}\n' 3131 '\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' 3137 '{\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' 3144 '}\n' 3145 '\n' 3146 %(self.ns_lower)) 3147 3148 self.outfile.write(self.docbook_gen.expand( 3149 '/**\n' 3150 ' * %sObjectProxy:\n' 3151 ' *\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( 3157 '/**\n' 3158 ' * %sObjectProxyClass:\n' 3159 ' * @parent_class: The parent class.\n' 3160 ' *\n' 3161 ' * Class structure for #%sObjectProxy.\n' 3162 %(self.namespace, self.namespace), False)) 3163 self.outfile.write(' */\n') 3164 self.outfile.write('\n') 3165 # class boilerplate 3166 self.outfile.write('static void\n' 3167 '%sobject_proxy__%sobject_iface_init (%sObjectIface *iface G_GNUC_UNUSED)\n' 3168 '{\n' 3169 '}\n' 3170 '\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' 3174 '{\n' 3175 ' iface->interface_added = %sobject_notify;\n' 3176 ' iface->interface_removed = %sobject_notify;\n' 3177 '}\n' 3178 '\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' 3184 '\n' 3185 %(self.namespace, self.ns_lower, self.ns_upper, self.ns_lower, self.ns_lower, self.ns_lower)) 3186 # class boilerplate 3187 self.outfile.write('static void\n' 3188 '%sobject_proxy_init (%sObjectProxy *object G_GNUC_UNUSED)\n' 3189 '{\n' 3190 '}\n' 3191 '\n'%(self.ns_lower, self.namespace)) 3192 self.outfile.write('static void\n' 3193 '%sobject_proxy_set_property (GObject *gobject,\n' 3194 ' guint prop_id,\n' 3195 ' const GValue *value G_GNUC_UNUSED,\n' 3196 ' GParamSpec *pspec)\n' 3197 '{\n' 3198 ' G_OBJECT_WARN_INVALID_PROPERTY_ID (gobject, prop_id, pspec);\n' 3199 %(self.ns_lower)) 3200 self.outfile.write('}\n' 3201 '\n'%()) 3202 self.outfile.write('static void\n' 3203 '%sobject_proxy_get_property (GObject *gobject,\n' 3204 ' guint prop_id,\n' 3205 ' GValue *value,\n' 3206 ' GParamSpec *pspec)\n' 3207 '{\n' 3208 ' %sObjectProxy *object = %sOBJECT_PROXY (gobject);\n' 3209 ' GDBusInterface *interface;\n' 3210 '\n' 3211 ' switch (prop_id)\n' 3212 ' {\n' 3213 %(self.ns_lower, self.namespace, self.ns_upper)) 3214 n = 1 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' 3219 ' break;\n' 3220 '\n' 3221 %(n, i.name)) 3222 n += 1 3223 self.outfile.write(' default:\n' 3224 ' G_OBJECT_WARN_INVALID_PROPERTY_ID (gobject, prop_id, pspec);\n' 3225 ' break;\n' 3226 ' }\n' 3227 '}\n' 3228 '\n'%()) 3229 self.outfile.write('static void\n' 3230 '%sobject_proxy_class_init (%sObjectProxyClass *klass)\n' 3231 '{\n' 3232 ' GObjectClass *gobject_class = G_OBJECT_CLASS (klass);\n' 3233 '\n' 3234 ' gobject_class->set_property = %sobject_proxy_set_property;\n' 3235 ' gobject_class->get_property = %sobject_proxy_get_property;\n' 3236 '\n' 3237 %(self.ns_lower, self.namespace, self.ns_lower, self.ns_lower)) 3238 n = 1 3239 for i in self.ifaces: 3240 self.outfile.write(' g_object_class_override_property (gobject_class, %d, "%s");' 3241 '\n' 3242 %(n, i.name_hyphen)) 3243 n += 1 3244 self.outfile.write('}\n' 3245 '\n') 3246 3247 self.outfile.write(self.docbook_gen.expand( 3248 '/**\n' 3249 ' * %sobject_proxy_new:\n' 3250 ' * @connection: A #GDBusConnection.\n' 3251 ' * @object_path: An object path.\n' 3252 ' *\n' 3253 ' * Creates a new proxy object.\n' 3254 ' *\n' 3255 ' * Returns: (transfer full): The proxy object.\n' 3256 ' */\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' 3261 '{\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' 3265 '}\n' 3266 '\n'%(self.namespace, self.ns_lower, self.ns_upper, self.ns_upper)) 3267 3268 self.outfile.write(self.docbook_gen.expand( 3269 '/**\n' 3270 ' * %sObjectSkeleton:\n' 3271 ' *\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( 3277 '/**\n' 3278 ' * %sObjectSkeletonClass:\n' 3279 ' * @parent_class: The parent class.\n' 3280 ' *\n' 3281 ' * Class structure for #%sObjectSkeleton.\n' 3282 %(self.namespace, self.namespace), False)) 3283 self.outfile.write(' */\n') 3284 self.outfile.write('\n') 3285 # class boilerplate 3286 self.outfile.write('static void\n' 3287 '%sobject_skeleton__%sobject_iface_init (%sObjectIface *iface G_GNUC_UNUSED)\n' 3288 '{\n' 3289 '}\n' 3290 '\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' 3295 '{\n' 3296 ' iface->interface_added = %sobject_notify;\n' 3297 ' iface->interface_removed = %sobject_notify;\n' 3298 '}\n' 3299 '\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' 3304 '\n' 3305 %(self.namespace, self.ns_lower, self.ns_upper, self.ns_lower, self.ns_lower, self.ns_lower)) 3306 # class boilerplate 3307 self.outfile.write('static void\n' 3308 '%sobject_skeleton_init (%sObjectSkeleton *object G_GNUC_UNUSED)\n' 3309 '{\n' 3310 '}\n' 3311 '\n'%(self.ns_lower, self.namespace)) 3312 self.outfile.write('static void\n' 3313 '%sobject_skeleton_set_property (GObject *gobject,\n' 3314 ' guint prop_id,\n' 3315 ' const GValue *value,\n' 3316 ' GParamSpec *pspec)\n' 3317 '{\n' 3318 ' %sObjectSkeleton *object = %sOBJECT_SKELETON (gobject);\n' 3319 ' GDBusInterfaceSkeleton *interface;\n' 3320 '\n' 3321 ' switch (prop_id)\n' 3322 ' {\n' 3323 %(self.ns_lower, self.namespace, self.ns_upper)) 3324 n = 1 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' 3329 ' {\n' 3330 ' g_warn_if_fail (%sIS_%s (interface));\n' 3331 ' g_dbus_object_skeleton_add_interface (G_DBUS_OBJECT_SKELETON (object), interface);\n' 3332 ' }\n' 3333 ' else\n' 3334 ' {\n' 3335 ' g_dbus_object_skeleton_remove_interface_by_name (G_DBUS_OBJECT_SKELETON (object), "%s");\n' 3336 ' }\n' 3337 ' break;\n' 3338 '\n' 3339 %(n, self.ns_upper, i.name_upper, i.name)) 3340 n += 1 3341 self.outfile.write(' default:\n' 3342 ' G_OBJECT_WARN_INVALID_PROPERTY_ID (gobject, prop_id, pspec);\n' 3343 ' break;\n' 3344 ' }\n' 3345 '}\n' 3346 '\n'%()) 3347 self.outfile.write('static void\n' 3348 '%sobject_skeleton_get_property (GObject *gobject,\n' 3349 ' guint prop_id,\n' 3350 ' GValue *value,\n' 3351 ' GParamSpec *pspec)\n' 3352 '{\n' 3353 ' %sObjectSkeleton *object = %sOBJECT_SKELETON (gobject);\n' 3354 ' GDBusInterface *interface;\n' 3355 '\n' 3356 ' switch (prop_id)\n' 3357 ' {\n' 3358 %(self.ns_lower, self.namespace, self.ns_upper)) 3359 n = 1 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' 3364 ' break;\n' 3365 '\n' 3366 %(n, i.name)) 3367 n += 1 3368 self.outfile.write(' default:\n' 3369 ' G_OBJECT_WARN_INVALID_PROPERTY_ID (gobject, prop_id, pspec);\n' 3370 ' break;\n' 3371 ' }\n' 3372 '}\n' 3373 '\n'%()) 3374 self.outfile.write('static void\n' 3375 '%sobject_skeleton_class_init (%sObjectSkeletonClass *klass)\n' 3376 '{\n' 3377 ' GObjectClass *gobject_class = G_OBJECT_CLASS (klass);\n' 3378 '\n' 3379 ' gobject_class->set_property = %sobject_skeleton_set_property;\n' 3380 ' gobject_class->get_property = %sobject_skeleton_get_property;\n' 3381 '\n' 3382 %(self.ns_lower, self.namespace, self.ns_lower, self.ns_lower)) 3383 n = 1 3384 for i in self.ifaces: 3385 self.outfile.write(' g_object_class_override_property (gobject_class, %d, "%s");' 3386 '\n' 3387 %(n, i.name_hyphen)) 3388 n += 1 3389 self.outfile.write('}\n' 3390 '\n') 3391 self.outfile.write(self.docbook_gen.expand( 3392 '/**\n' 3393 ' * %sobject_skeleton_new:\n' 3394 ' * @object_path: An object path.\n' 3395 ' *\n' 3396 ' * Creates a new skeleton object.\n' 3397 ' *\n' 3398 ' * Returns: (transfer full): The skeleton object.\n' 3399 ' */\n' 3400 %(self.ns_lower), False)) 3401 self.outfile.write('%sObjectSkeleton *\n' 3402 '%sobject_skeleton_new (const gchar *object_path)\n' 3403 '{\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' 3406 '}\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( 3410 '/**\n' 3411 ' * %sobject_skeleton_set_%s:\n' 3412 ' * @object: A #%sObjectSkeleton.\n' 3413 ' * @interface_: (nullable): A #%s or %%NULL to clear the interface.\n' 3414 ' *\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' 3422 '}\n' 3423 '\n' 3424 %(i.name_hyphen)) 3425 self.outfile.write('\n') 3426 3427 3428 def generate_object_manager_client(self): 3429 self.outfile.write('/* ------------------------------------------------------------------------\n' 3430 ' * Code for ObjectManager client\n' 3431 ' * ------------------------------------------------------------------------\n' 3432 ' */\n' 3433 '\n') 3434 3435 self.outfile.write(self.docbook_gen.expand( 3436 '/**\n' 3437 ' * SECTION:%sObjectManagerClient\n' 3438 ' * @title: %sObjectManagerClient\n' 3439 ' * @short_description: Generated GDBusObjectManagerClient type\n' 3440 ' *\n' 3441 ' * This section contains a #GDBusObjectManagerClient that uses %sobject_manager_client_get_proxy_type() as the #GDBusProxyTypeFunc.\n' 3442 ' */\n' 3443 %(self.namespace, self.namespace, self.ns_lower), False)) 3444 self.outfile.write('\n') 3445 3446 self.outfile.write(self.docbook_gen.expand( 3447 '/**\n' 3448 ' * %sObjectManagerClient:\n' 3449 ' *\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') 3454 3455 self.outfile.write(self.docbook_gen.expand( 3456 '/**\n' 3457 ' * %sObjectManagerClientClass:\n' 3458 ' * @parent_class: The parent class.\n' 3459 ' *\n' 3460 ' * Class structure for #%sObjectManagerClient.\n' 3461 %(self.namespace, self.namespace), False)) 3462 self.outfile.write(' */\n') 3463 self.outfile.write('\n') 3464 3465 # class boilerplate 3466 self.outfile.write('G_DEFINE_TYPE (%sObjectManagerClient, %sobject_manager_client, G_TYPE_DBUS_OBJECT_MANAGER_CLIENT)\n' 3467 '\n' 3468 %(self.namespace, self.ns_lower)) 3469 3470 # class boilerplate 3471 self.outfile.write('static void\n' 3472 '%sobject_manager_client_init (%sObjectManagerClient *manager G_GNUC_UNUSED)\n' 3473 '{\n' 3474 '}\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' 3478 '{\n' 3479 '}\n' 3480 '\n'%(self.ns_lower, self.namespace)) 3481 3482 self.outfile.write(self.docbook_gen.expand( 3483 '/**\n' 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' 3489 ' *\n' 3490 ' * A #GDBusProxyTypeFunc that maps @interface_name to the generated #GDBusObjectProxy derived and #GDBusProxy derived types.\n' 3491 ' *\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' 3497 '{\n' 3498 %(self.ns_lower)) 3499 self.outfile.write(' static gsize once_init_value = 0;\n' 3500 ' static GHashTable *lookup_hash;\n' 3501 ' GType ret;\n' 3502 '\n' 3503 ' if (interface_name == NULL)\n' 3504 ' return %sTYPE_OBJECT_PROXY;\n' 3505 ' if (g_once_init_enter (&once_init_value))\n' 3506 ' {\n' 3507 ' lookup_hash = g_hash_table_new (g_str_hash, g_str_equal);\n' 3508 %(self.ns_upper)) 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' 3513 ' }\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' 3518 '}\n' 3519 '\n') 3520 3521 # constructors 3522 self.outfile.write(self.docbook_gen.expand( 3523 '/**\n' 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' 3532 ' *\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' 3534 ' *\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' 3537 ' *\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' 3550 '{\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' 3552 '}\n' 3553 '\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' 3559 ' *\n' 3560 ' * Finishes an operation started with %sobject_manager_client_new().\n' 3561 ' *\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' 3569 '{\n' 3570 ' GObject *ret;\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' 3577 ' else\n' 3578 ' return NULL;\n' 3579 '}\n' 3580 '\n' 3581 %(self.ns_lower)) 3582 self.outfile.write(self.docbook_gen.expand( 3583 '/**\n' 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' 3591 ' *\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' 3593 ' *\n' 3594 ' * The calling thread is blocked until a reply is received.\n' 3595 ' *\n' 3596 ' * See %sobject_manager_client_new() for the asynchronous version of this constructor.\n' 3597 ' *\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' 3609 '{\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' 3614 ' else\n' 3615 ' return NULL;\n' 3616 '}\n' 3617 '\n' 3618 %(self.ns_lower, self.ns_upper, self.ns_lower)) 3619 self.outfile.write('\n') 3620 self.outfile.write(self.docbook_gen.expand( 3621 '/**\n' 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' 3630 ' *\n' 3631 ' * Like %sobject_manager_client_new() but takes a #GBusType instead of a #GDBusConnection.\n' 3632 ' *\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' 3635 ' *\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' 3648 '{\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' 3650 '}\n' 3651 '\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' 3657 ' *\n' 3658 ' * Finishes an operation started with %sobject_manager_client_new_for_bus().\n' 3659 ' *\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' 3667 '{\n' 3668 ' GObject *ret;\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' 3675 ' else\n' 3676 ' return NULL;\n' 3677 '}\n' 3678 '\n' 3679 %(self.ns_lower)) 3680 self.outfile.write(self.docbook_gen.expand( 3681 '/**\n' 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' 3689 ' *\n' 3690 ' * Like %sobject_manager_client_new_sync() but takes a #GBusType instead of a #GDBusConnection.\n' 3691 ' *\n' 3692 ' * The calling thread is blocked until a reply is received.\n' 3693 ' *\n' 3694 ' * See %sobject_manager_client_new_for_bus() for the asynchronous version of this constructor.\n' 3695 ' *\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' 3707 '{\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' 3712 ' else\n' 3713 ' return NULL;\n' 3714 '}\n' 3715 '\n' 3716 %(self.ns_lower, self.ns_upper, self.ns_lower)) 3717 self.outfile.write('\n') 3718 3719 # --------------------------------------------------------------------------------------------------- 3720 3721 def write_gtkdoc_deprecated_and_since_and_close(self, obj, f, indent): 3722 if len(obj.since) > 0: 3723 f.write('%*s *\n' 3724 '%*s * Since: %s\n' 3725 %(indent, '', indent, '', obj.since)) 3726 if obj.deprecated: 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' 3735 else: 3736 print_error('Cannot handle object "{}"'.format(obj)) 3737 f.write(self.docbook_gen.expand( 3738 '%*s *\n' 3739 '%*s * Deprecated: %s has been deprecated.\n' 3740 %(indent, '', indent, '', thing), False)) 3741 f.write('%*s */\n'%(indent, '')) 3742 3743 # --------------------------------------------------------------------------------------------------- 3744 3745 def generate_interface_intro(self, i): 3746 self.outfile.write('/* ------------------------------------------------------------------------\n' 3747 ' * Code for interface %s\n' 3748 ' * ------------------------------------------------------------------------\n' 3749 ' */\n' 3750 '\n'%(i.name)) 3751 3752 self.outfile.write(self.docbook_gen.expand( 3753 '/**\n' 3754 ' * SECTION:%s\n' 3755 ' * @title: %s\n' 3756 ' * @short_description: Generated C code for the %s D-Bus interface\n' 3757 ' *\n' 3758 ' * This section contains code for working with the #%s D-Bus interface in C.\n' 3759 ' */\n' 3760 %(i.camel_name, i.camel_name, i.name, i.name), False)) 3761 self.outfile.write('\n') 3762 3763 def generate(self): 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() 3778