gio/gdbus-2.0/codegen/codegen.py

   1 # -*- Mode: Python -*-
   2 # coding=utf-8
   3
   4 # GDBus - GLib D-Bus Library
   5 #
   6 # Copyright (C) 2008-2011 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
  24 import sys
  25
  26 from . import config
  27 from . import utils
  28 from . import dbustypes
  29 from .utils import print_error
  30
  31 LICENSE_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
  38 def 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
  54 class 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
 621 class 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
 674 class 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 = (m.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 = (m.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
 905 class 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                            '  gboolean use_gvariant;\n'
 963                            '} _ExtendedGDBusPropertyInfo;\n'
 964                            '\n')
 965
 966         self.outfile.write('typedef struct\n'
 967                            '{\n'
 968                            '  GDBusInterfaceInfo parent_struct;\n'
 969                            '  const gchar *hyphen_name;\n'
 970                            '} _ExtendedGDBusInterfaceInfo;\n'
 971                            '\n')
 972
 973         self.outfile.write('typedef struct\n'
 974                            '{\n'
 975                            '  const _ExtendedGDBusPropertyInfo *info;\n'
 976                            '  guint prop_id;\n'
 977                            '  GValue orig_value; /* the value before the change */\n'
 978                            '} ChangedProperty;\n'
 979                            '\n'
 980                            'static void\n'
 981                            '_changed_property_free (ChangedProperty *data)\n'
 982                            '{\n'
 983                            '  g_value_unset (&data->orig_value);\n'
 984                            '  g_free (data);\n'
 985                            '}\n'
 986                            '\n')
 987
 988         self.outfile.write('static gboolean\n'
 989                            '_g_strv_equal0 (gchar **a, gchar **b)\n'
 990                            '{\n'
 991                            '  gboolean ret = FALSE;\n'
 992                            '  guint n;\n'
 993                            '  if (a == NULL && b == NULL)\n'
 994                            '    {\n'
 995                            '      ret = TRUE;\n'
 996                            '      goto out;\n'
 997                            '    }\n'
 998                            '  if (a == NULL || b == NULL)\n'
 999                            '    goto out;\n'
1000                            '  if (g_strv_length (a) != g_strv_length (b))\n'
1001                            '    goto out;\n'
1002                            '  for (n = 0; a[n] != NULL; n++)\n'
1003                            '    if (g_strcmp0 (a[n], b[n]) != 0)\n'
1004                            '      goto out;\n'
1005                            '  ret = TRUE;\n'
1006                            'out:\n'
1007                            '  return ret;\n'
1008                            '}\n'
1009                            '\n')
1010
1011         self.outfile.write('static gboolean\n'
1012                            '_g_variant_equal0 (GVariant *a, GVariant *b)\n'
1013                            '{\n'
1014                            '  gboolean ret = FALSE;\n'
1015                            '  if (a == NULL && b == NULL)\n'
1016                            '    {\n'
1017                            '      ret = TRUE;\n'
1018                            '      goto out;\n'
1019                            '    }\n'
1020                            '  if (a == NULL || b == NULL)\n'
1021                            '    goto out;\n'
1022                            '  ret = g_variant_equal (a, b);\n'
1023                            'out:\n'
1024                            '  return ret;\n'
1025                            '}\n'
1026                            '\n')
1027
1028         # simplified - only supports the types we use
1029         self.outfile.write('G_GNUC_UNUSED static gboolean\n'
1030                            '_g_value_equal (const GValue *a, const GValue *b)\n'
1031                            '{\n'
1032                            '  gboolean ret = FALSE;\n'
1033                            '  g_assert (G_VALUE_TYPE (a) == G_VALUE_TYPE (b));\n'
1034                            '  switch (G_VALUE_TYPE (a))\n'
1035                            '    {\n'
1036                            '      case G_TYPE_BOOLEAN:\n'
1037                            '        ret = (g_value_get_boolean (a) == g_value_get_boolean (b));\n'
1038                            '        break;\n'
1039                            '      case G_TYPE_UCHAR:\n'
1040                            '        ret = (g_value_get_uchar (a) == g_value_get_uchar (b));\n'
1041                            '        break;\n'
1042                            '      case G_TYPE_INT:\n'
1043                            '        ret = (g_value_get_int (a) == g_value_get_int (b));\n'
1044                            '        break;\n'
1045                            '      case G_TYPE_UINT:\n'
1046                            '        ret = (g_value_get_uint (a) == g_value_get_uint (b));\n'
1047                            '        break;\n'
1048                            '      case G_TYPE_INT64:\n'
1049                            '        ret = (g_value_get_int64 (a) == g_value_get_int64 (b));\n'
1050                            '        break;\n'
1051                            '      case G_TYPE_UINT64:\n'
1052                            '        ret = (g_value_get_uint64 (a) == g_value_get_uint64 (b));\n'
1053                            '        break;\n'
1054                            '      case G_TYPE_DOUBLE:\n'
1055                            '        {\n'
1056                            '          /* Avoid -Wfloat-equal warnings by doing a direct bit compare */\n'
1057                            '          gdouble da = g_value_get_double (a);\n'
1058                            '          gdouble db = g_value_get_double (b);\n'
1059                            '          ret = memcmp (&da, &db, sizeof (gdouble)) == 0;\n'
1060                            '        }\n'
1061                            '        break;\n'
1062                            '      case G_TYPE_STRING:\n'
1063                            '        ret = (g_strcmp0 (g_value_get_string (a), g_value_get_string (b)) == 0);\n'
1064                            '        break;\n'
1065                            '      case G_TYPE_VARIANT:\n'
1066                            '        ret = _g_variant_equal0 (g_value_get_variant (a), g_value_get_variant (b));\n'
1067                            '        break;\n'
1068                            '      default:\n'
1069                            '        if (G_VALUE_TYPE (a) == G_TYPE_STRV)\n'
1070                            '          ret = _g_strv_equal0 (g_value_get_boxed (a), g_value_get_boxed (b));\n'
1071                            '        else\n'
1072                            '          g_critical ("_g_value_equal() does not handle type %s", g_type_name (G_VALUE_TYPE (a)));\n'
1073                            '        break;\n'
1074                            '    }\n'
1075                            '  return ret;\n'
1076                            '}\n'
1077                            '\n')
1078
1079     def generate_annotations(self, prefix, annotations):
1080         if annotations is None:
1081             return
1082
1083         n = 0
1084         for a in annotations:
1085             #self.generate_annotations('%s_%d'%(prefix, n), a.get_annotations())
1086
1087             # skip internal annotations
1088             if a.key.startswith('org.gtk.GDBus'):
1089                 continue
1090
1091             self.outfile.write('static const GDBusAnnotationInfo %s_%d =\n'
1092                                '{\n'
1093                                '  -1,\n'
1094                                '  (gchar *) "%s",\n'
1095                                '  (gchar *) "%s",\n'%(prefix, n, a.key, a.value))
1096             if len(a.annotations) == 0:
1097                 self.outfile.write('  NULL\n')
1098             else:
1099                 self.outfile.write('  (GDBusAnnotationInfo **) &%s_%d_pointers\n'%(prefix, n))
1100             self.outfile.write('};\n'
1101                                '\n')
1102             n += 1
1103
1104         if n > 0:
1105             self.outfile.write('static const GDBusAnnotationInfo * const %s_pointers[] =\n'
1106                                '{\n'%(prefix))
1107             m = 0;
1108             for a in annotations:
1109                 if a.key.startswith('org.gtk.GDBus'):
1110                     continue
1111                 self.outfile.write('  &%s_%d,\n'%(prefix, m))
1112                 m += 1
1113             self.outfile.write('  NULL\n'
1114                                '};\n'
1115                                '\n')
1116         return n
1117
1118     def generate_args(self, prefix, args):
1119         for a in args:
1120             num_anno = self.generate_annotations('%s_arg_%s_annotation_info'%(prefix, a.name), a.annotations)
1121
1122             self.outfile.write('static const _ExtendedGDBusArgInfo %s_%s =\n'
1123                                '{\n'
1124                                '  {\n'
1125                                '    -1,\n'
1126                                '    (gchar *) "%s",\n'
1127                                '    (gchar *) "%s",\n'%(prefix, a.name, a.name, a.signature))
1128             if num_anno == 0:
1129                 self.outfile.write('    NULL\n')
1130             else:
1131                 self.outfile.write('    (GDBusAnnotationInfo **) &%s_arg_%s_annotation_info_pointers\n'%(prefix, a.name))
1132             self.outfile.write('  },\n')
1133             if not utils.lookup_annotation(a.annotations, 'org.gtk.GDBus.C.ForceGVariant'):
1134                 self.outfile.write('  FALSE\n')
1135             else:
1136                 self.outfile.write('  TRUE\n')
1137             self.outfile.write('};\n'
1138                                '\n')
1139
1140         if len(args) > 0:
1141             self.outfile.write('static const GDBusArgInfo * const %s_pointers[] =\n'
1142                              '{\n'%(prefix))
1143             for a in args:
1144                 self.outfile.write('  &%s_%s.parent_struct,\n'%(prefix, a.name))
1145             self.outfile.write('  NULL\n'
1146                                '};\n'
1147                                '\n')
1148
1149     def generate_introspection_for_interface(self, i):
1150             self.outfile.write('/* ---- Introspection data for %s ---- */\n'
1151                                '\n'%(i.name))
1152
1153             if len(i.methods) > 0:
1154                 for m in i.methods:
1155                     unix_fd = False
1156                     if utils.lookup_annotation(m.annotations, 'org.gtk.GDBus.C.UnixFD'):
1157                         unix_fd = True
1158                     self.generate_args('_%s_method_info_%s_IN_ARG'%(i.name_lower, m.name_lower), m.in_args)
1159                     self.generate_args('_%s_method_info_%s_OUT_ARG'%(i.name_lower, m.name_lower), m.out_args)
1160
1161                     num_anno = self.generate_annotations('_%s_method_%s_annotation_info'%(i.name_lower, m.name_lower), m.annotations)
1162
1163                     self.outfile.write('static const _ExtendedGDBusMethodInfo _%s_method_info_%s =\n'
1164                                        '{\n'
1165                                        '  {\n'
1166                                        '    -1,\n'
1167                                        '    (gchar *) "%s",\n'%(i.name_lower, m.name_lower, m.name))
1168                     if len(m.in_args) == 0:
1169                         self.outfile.write('    NULL,\n')
1170                     else:
1171                         self.outfile.write('    (GDBusArgInfo **) &_%s_method_info_%s_IN_ARG_pointers,\n'%(i.name_lower, m.name_lower))
1172                     if len(m.out_args) == 0:
1173                         self.outfile.write('    NULL,\n')
1174                     else:
1175                         self.outfile.write('    (GDBusArgInfo **) &_%s_method_info_%s_OUT_ARG_pointers,\n'%(i.name_lower, m.name_lower))
1176                     if num_anno == 0:
1177                         self.outfile.write('    NULL\n')
1178                     else:
1179                         self.outfile.write('    (GDBusAnnotationInfo **) &_%s_method_%s_annotation_info_pointers\n'%(i.name_lower, m.name_lower))
1180                     self.outfile.write('  },\n'
1181                                        '  "handle-%s",\n'
1182                                        '  %s\n'
1183                                        %(m.name_hyphen, 'TRUE' if unix_fd else 'FALSE'))
1184                     self.outfile.write('};\n'
1185                                        '\n')
1186
1187                 self.outfile.write('static const GDBusMethodInfo * const _%s_method_info_pointers[] =\n'
1188                                    '{\n'%(i.name_lower))
1189                 for m in i.methods:
1190                     self.outfile.write('  &_%s_method_info_%s.parent_struct,\n'%(i.name_lower, m.name_lower))
1191                 self.outfile.write('  NULL\n'
1192                                    '};\n'
1193                                    '\n')
1194
1195             # ---
1196
1197             if len(i.signals) > 0:
1198                 for s in i.signals:
1199                     self.generate_args('_%s_signal_info_%s_ARG'%(i.name_lower, s.name_lower), s.args)
1200
1201                     num_anno = self.generate_annotations('_%s_signal_%s_annotation_info'%(i.name_lower, s.name_lower), s.annotations)
1202                     self.outfile.write('static const _ExtendedGDBusSignalInfo _%s_signal_info_%s =\n'
1203                                        '{\n'
1204                                        '  {\n'
1205                                        '    -1,\n'
1206                                        '    (gchar *) "%s",\n'%(i.name_lower, s.name_lower, s.name))
1207                     if len(s.args) == 0:
1208                         self.outfile.write('    NULL,\n')
1209                     else:
1210                         self.outfile.write('    (GDBusArgInfo **) &_%s_signal_info_%s_ARG_pointers,\n'%(i.name_lower, s.name_lower))
1211                     if num_anno == 0:
1212                         self.outfile.write('    NULL\n')
1213                     else:
1214                         self.outfile.write('    (GDBusAnnotationInfo **) &_%s_signal_%s_annotation_info_pointers\n'%(i.name_lower, s.name_lower))
1215                     self.outfile.write('  },\n'
1216                                        '  "%s"\n'
1217                                        %(s.name_hyphen))
1218                     self.outfile.write('};\n'
1219                                        '\n')
1220
1221                 self.outfile.write('static const GDBusSignalInfo * const _%s_signal_info_pointers[] =\n'
1222                                    '{\n'%(i.name_lower))
1223                 for s in i.signals:
1224                     self.outfile.write('  &_%s_signal_info_%s.parent_struct,\n'%(i.name_lower, s.name_lower))
1225                 self.outfile.write('  NULL\n'
1226                                    '};\n'
1227                                    '\n')
1228
1229             # ---
1230
1231             if len(i.properties) > 0:
1232                 for p in i.properties:
1233                     if p.readable and p.writable:
1234                         access = 'G_DBUS_PROPERTY_INFO_FLAGS_READABLE | G_DBUS_PROPERTY_INFO_FLAGS_WRITABLE'
1235                     elif p.readable:
1236                         access = 'G_DBUS_PROPERTY_INFO_FLAGS_READABLE'
1237                     elif p.writable:
1238                         access = 'G_DBUS_PROPERTY_INFO_FLAGS_WRITABLE'
1239                     else:
1240                         access = 'G_DBUS_PROPERTY_INFO_FLAGS_NONE'
1241                     num_anno = self.generate_annotations('_%s_property_%s_annotation_info'%(i.name_lower, p.name_lower), p.annotations)
1242                     self.outfile.write('static const _ExtendedGDBusPropertyInfo _%s_property_info_%s =\n'
1243                                        '{\n'
1244                                        '  {\n'
1245                                        '    -1,\n'
1246                                        '    (gchar *) "%s",\n'
1247                                        '    (gchar *) "%s",\n'
1248                                        '    %s,\n'%(i.name_lower, p.name_lower, p.name, p.arg.signature, access))
1249                     if num_anno == 0:
1250                         self.outfile.write('    NULL\n')
1251                     else:
1252                         self.outfile.write('    (GDBusAnnotationInfo **) &_%s_property_%s_annotation_info_pointers\n'%(i.name_lower, p.name_lower))
1253                     self.outfile.write('  },\n'
1254                                        '  "%s",\n'
1255                                        %(p.name_hyphen))
1256                     if not utils.lookup_annotation(p.annotations, 'org.gtk.GDBus.C.ForceGVariant'):
1257                         self.outfile.write('  FALSE\n')
1258                     else:
1259                         self.outfile.write('  TRUE\n')
1260                     self.outfile.write('};\n'
1261                                        '\n')
1262
1263                 self.outfile.write('static const GDBusPropertyInfo * const _%s_property_info_pointers[] =\n'
1264                                    '{\n'%(i.name_lower))
1265                 for p in i.properties:
1266                     self.outfile.write('  &_%s_property_info_%s.parent_struct,\n'%(i.name_lower, p.name_lower))
1267                 self.outfile.write('  NULL\n'
1268                                    '};\n'
1269                                    '\n')
1270
1271             num_anno = self.generate_annotations('_%s_annotation_info'%(i.name_lower), i.annotations)
1272             self.outfile.write('static const _ExtendedGDBusInterfaceInfo _%s_interface_info =\n'
1273                                '{\n'
1274                                '  {\n'
1275                                '    -1,\n'
1276                                '    (gchar *) "%s",\n'%(i.name_lower, i.name))
1277             if len(i.methods) == 0:
1278                 self.outfile.write('    NULL,\n')
1279             else:
1280                 self.outfile.write('    (GDBusMethodInfo **) &_%s_method_info_pointers,\n'%(i.name_lower))
1281             if len(i.signals) == 0:
1282                 self.outfile.write('    NULL,\n')
1283             else:
1284                 self.outfile.write('    (GDBusSignalInfo **) &_%s_signal_info_pointers,\n'%(i.name_lower))
1285             if len(i.properties) == 0:
1286                 self.outfile.write('    NULL,\n')
1287             else:
1288                 self.outfile.write('    (GDBusPropertyInfo **) &_%s_property_info_pointers,\n'%(i.name_lower))
1289             if num_anno == 0:
1290                 self.outfile.write('    NULL\n')
1291             else:
1292                 self.outfile.write('    (GDBusAnnotationInfo **) &_%s_annotation_info_pointers\n'%(i.name_lower))
1293             self.outfile.write('  },\n'
1294                                '  "%s",\n'
1295                                '};\n'
1296                                '\n'
1297                                %(i.name_hyphen))
1298             self.outfile.write('\n')
1299             self.outfile.write(self.docbook_gen.expand(
1300                     '/**\n'
1301                     ' * %s_interface_info:\n'
1302                     ' *\n'
1303                     ' * Gets a machine-readable description of the #%s D-Bus interface.\n'
1304                     ' *\n'
1305                     ' * Returns: (transfer none): A #GDBusInterfaceInfo. Do not free.\n'
1306                     %(i.name_lower, i.name), False))
1307             self.write_gtkdoc_deprecated_and_since_and_close(i, self.outfile, 0)
1308             self.outfile.write('GDBusInterfaceInfo *\n'
1309                                '%s_interface_info (void)\n'
1310                                '{\n'
1311                                '  return (GDBusInterfaceInfo *) &_%s_interface_info.parent_struct;\n'
1312                                 '}\n'
1313                                 '\n'%(i.name_lower, i.name_lower))
1314
1315             self.outfile.write(self.docbook_gen.expand(
1316                     '/**\n'
1317                     ' * %s_override_properties:\n'
1318                     ' * @klass: The class structure for a #GObject derived class.\n'
1319                     ' * @property_id_begin: The property id to assign to the first overridden property.\n'
1320                     ' *\n'
1321                     ' * Overrides all #GObject properties in the #%s interface for a concrete class.\n'
1322                     ' * The properties are overridden in the order they are defined.\n'
1323                     ' *\n'
1324                     ' * Returns: The last property id.\n'
1325                     %(i.name_lower, i.camel_name), False))
1326             self.write_gtkdoc_deprecated_and_since_and_close(i, self.outfile, 0)
1327             self.outfile.write('guint\n'
1328                                '%s_override_properties (GObjectClass *klass, guint property_id_begin)\n'
1329                                '{\n'%(i.name_lower))
1330             for p in i.properties:
1331                 self.outfile.write('  g_object_class_override_property (klass, property_id_begin++, "%s");\n'%(p.name_hyphen))
1332             self.outfile.write('  return property_id_begin - 1;\n'
1333                                '}\n'
1334                                '\n')
1335             self.outfile.write('\n')
1336
1337     # ----------------------------------------------------------------------------------------------------
1338
1339     def generate_interface(self, i):
1340         self.outfile.write('\n')
1341
1342         self.outfile.write(self.docbook_gen.expand(
1343                 '/**\n'
1344                 ' * %s:\n'
1345                 ' *\n'
1346                 ' * Abstract interface type for the D-Bus interface #%s.\n'
1347                 %(i.camel_name, i.name), False))
1348         self.write_gtkdoc_deprecated_and_since_and_close(i, self.outfile, 0)
1349         self.outfile.write('\n')
1350
1351         self.outfile.write(self.docbook_gen.expand(
1352                 '/**\n'
1353                 ' * %sIface:\n'
1354                 ' * @parent_iface: The parent interface.\n'
1355                 %(i.camel_name), False))
1356
1357         doc_bits = {}
1358         if len(i.methods) > 0:
1359             for m in i.methods:
1360                 key = (m.since, '_method_%s'%m.name_lower)
1361                 value  = '@handle_%s: '%(m.name_lower)
1362                 value += 'Handler for the #%s::handle-%s signal.'%(i.camel_name, m.name_hyphen)
1363                 doc_bits[key] = value
1364         if len(i.signals) > 0:
1365             for s in i.signals:
1366                 key = (s.since, '_signal_%s'%s.name_lower)
1367                 value  = '@%s: '%(s.name_lower)
1368                 value += 'Handler for the #%s::%s signal.'%(i.camel_name, s.name_hyphen)
1369                 doc_bits[key] = value
1370         if len(i.properties) > 0:
1371             for p in i.properties:
1372                 key = (p.since, '_prop_get_%s'%p.name_lower)
1373                 value  = '@get_%s: '%(p.name_lower)
1374                 value += 'Getter for the #%s:%s property.'%(i.camel_name, p.name_hyphen)
1375                 doc_bits[key] = value
1376         for key in sorted(doc_bits.keys(), key=utils.version_cmp_key):
1377             self.outfile.write(' * %s\n'%doc_bits[key])
1378
1379         self.outfile.write(self.docbook_gen.expand(
1380                 ' *\n'
1381                 ' * Virtual table for the D-Bus interface #%s.\n'
1382                 %(i.name), False))
1383         self.write_gtkdoc_deprecated_and_since_and_close(i, self.outfile, 0)
1384         self.outfile.write('\n')
1385
1386         self.outfile.write('typedef %sIface %sInterface;\n'%(i.camel_name, i.camel_name))
1387         self.outfile.write('G_DEFINE_INTERFACE (%s, %s, G_TYPE_OBJECT)\n'%(i.camel_name, i.name_lower))
1388         self.outfile.write('\n')
1389
1390         self.outfile.write('static void\n'
1391                            '%s_default_init (%sIface *iface)\n'
1392                            '{\n'%(i.name_lower, i.camel_name));
1393
1394         if len(i.methods) > 0:
1395             self.outfile.write('  /* GObject signals for incoming D-Bus method calls: */\n')
1396             for m in i.methods:
1397                 unix_fd = False
1398                 if utils.lookup_annotation(m.annotations, 'org.gtk.GDBus.C.UnixFD'):
1399                     unix_fd = True
1400                 self.outfile.write(self.docbook_gen.expand(
1401                         '  /**\n'
1402                         '   * %s::handle-%s:\n'
1403                         '   * @object: A #%s.\n'
1404                         '   * @invocation: A #GDBusMethodInvocation.\n'
1405                         %(i.camel_name, m.name_hyphen, i.camel_name), False))
1406                 if unix_fd:
1407                     self.outfile.write('   * @fd_list: (nullable): A #GUnixFDList or %NULL.\n')
1408                 for a in m.in_args:
1409                     self.outfile.write('   * @arg_%s: Argument passed by remote caller.\n'%(a.name))
1410                 self.outfile.write(self.docbook_gen.expand(
1411                         '   *\n'
1412                         '   * Signal emitted when a remote caller is invoking the %s.%s() D-Bus method.\n'
1413                         '   *\n'
1414                         '   * 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'
1415                         '   *\n'
1416                         '   * Returns: %%TRUE if the invocation was handled, %%FALSE to let other signal handlers run.\n'
1417                         %(i.name, m.name, i.name_lower, m.name_lower), False))
1418                 self.write_gtkdoc_deprecated_and_since_and_close(m, self.outfile, 2)
1419                 if unix_fd:
1420                     extra_args = 2
1421                 else:
1422                     extra_args = 1
1423                 self.outfile.write('  g_signal_new ("handle-%s",\n'
1424                                    '    G_TYPE_FROM_INTERFACE (iface),\n'
1425                                    '    G_SIGNAL_RUN_LAST,\n'
1426                                    '    G_STRUCT_OFFSET (%sIface, handle_%s),\n'
1427                                    '    g_signal_accumulator_true_handled,\n'
1428                                    '    NULL,\n' # accu_data
1429                                    '    g_cclosure_marshal_generic,\n'
1430                                    '    G_TYPE_BOOLEAN,\n'
1431                                    '    %d,\n'
1432                                    '    G_TYPE_DBUS_METHOD_INVOCATION'
1433                                    %(m.name_hyphen, i.camel_name, m.name_lower, len(m.in_args) + extra_args))
1434                 if unix_fd:
1435                     self.outfile.write(', G_TYPE_UNIX_FD_LIST')
1436                 for a in m.in_args:
1437                     self.outfile.write(', %s'%(a.gtype))
1438                 self.outfile.write(');\n')
1439                 self.outfile.write('\n')
1440
1441         if len(i.signals) > 0:
1442             self.outfile.write('  /* GObject signals for received D-Bus signals: */\n')
1443             for s in i.signals:
1444                 self.outfile.write(self.docbook_gen.expand(
1445                         '  /**\n'
1446                         '   * %s::%s:\n'
1447                         '   * @object: A #%s.\n'
1448                         %(i.camel_name, s.name_hyphen, i.camel_name), False))
1449                 for a in s.args:
1450                     self.outfile.write('   * @arg_%s: Argument.\n'%(a.name))
1451                 self.outfile.write(self.docbook_gen.expand(
1452                         '   *\n'
1453                         '   * On the client-side, this signal is emitted whenever the D-Bus signal #%s::%s is received.\n'
1454                         '   *\n'
1455                         '   * 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'
1456                         %(i.name, s.name), False))
1457                 self.write_gtkdoc_deprecated_and_since_and_close(s, self.outfile, 2)
1458                 self.outfile.write('  g_signal_new ("%s",\n'
1459                                    '    G_TYPE_FROM_INTERFACE (iface),\n'
1460                                    '    G_SIGNAL_RUN_LAST,\n'
1461                                    '    G_STRUCT_OFFSET (%sIface, %s),\n'
1462                                    '    NULL,\n' # accumulator
1463                                    '    NULL,\n' # accu_data
1464                                    '    g_cclosure_marshal_generic,\n'
1465                                    '    G_TYPE_NONE,\n'
1466                                    '    %d'
1467                                    %(s.name_hyphen, i.camel_name, s.name_lower, len(s.args)))
1468                 for a in s.args:
1469                     self.outfile.write(', %s'%(a.gtype))
1470                 self.outfile.write(');\n')
1471                 self.outfile.write('\n')
1472
1473         if len(i.properties) > 0:
1474             self.outfile.write('  /* GObject properties for D-Bus properties: */\n')
1475             for p in i.properties:
1476                 if p.readable and p.writable:
1477                     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.'
1478                 elif p.readable:
1479                     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.'
1480                 elif p.writable:
1481                     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.'
1482                 else:
1483                     print_error('Cannot handle property "{}" that neither readable nor writable'.format(p.name))
1484                 self.outfile.write(self.docbook_gen.expand(
1485                         '  /**\n'
1486                         '   * %s:%s:\n'
1487                         '   *\n'
1488                         '   * Represents the D-Bus property #%s:%s.\n'
1489                         '   *\n'
1490                         '   * %s\n'
1491                         %(i.camel_name, p.name_hyphen, i.name, p.name, hint), False))
1492                 self.write_gtkdoc_deprecated_and_since_and_close(p, self.outfile, 2)
1493                 self.outfile.write('  g_object_interface_install_property (iface,\n')
1494                 if p.arg.gtype == 'G_TYPE_VARIANT':
1495                     s = 'g_param_spec_variant ("%s", "%s", "%s", G_VARIANT_TYPE ("%s"), NULL'%(p.name_hyphen, p.name, p.name, p.arg.signature)
1496                 elif p.arg.signature == 'b':
1497                     s = 'g_param_spec_boolean ("%s", "%s", "%s", FALSE'%(p.name_hyphen, p.name, p.name)
1498                 elif p.arg.signature == 'y':
1499                     s = 'g_param_spec_uchar ("%s", "%s", "%s", 0, 255, 0'%(p.name_hyphen, p.name, p.name)
1500                 elif p.arg.signature == 'n':
1501                     s = 'g_param_spec_int ("%s", "%s", "%s", G_MININT16, G_MAXINT16, 0'%(p.name_hyphen, p.name, p.name)
1502                 elif p.arg.signature == 'q':
1503                     s = 'g_param_spec_uint ("%s", "%s", "%s", 0, G_MAXUINT16, 0'%(p.name_hyphen, p.name, p.name)
1504                 elif p.arg.signature == 'i':
1505                     s = 'g_param_spec_int ("%s", "%s", "%s", G_MININT32, G_MAXINT32, 0'%(p.name_hyphen, p.name, p.name)
1506                 elif p.arg.signature == 'u':
1507                     s = 'g_param_spec_uint ("%s", "%s", "%s", 0, G_MAXUINT32, 0'%(p.name_hyphen, p.name, p.name)
1508                 elif p.arg.signature == 'x':
1509                     s = 'g_param_spec_int64 ("%s", "%s", "%s", G_MININT64, G_MAXINT64, 0'%(p.name_hyphen, p.name, p.name)
1510                 elif p.arg.signature == 't':
1511                     s = 'g_param_spec_uint64 ("%s", "%s", "%s", 0, G_MAXUINT64, 0'%(p.name_hyphen, p.name, p.name)
1512                 elif p.arg.signature == 'd':
1513                     s = 'g_param_spec_double ("%s", "%s", "%s", -G_MAXDOUBLE, G_MAXDOUBLE, 0.0'%(p.name_hyphen, p.name, p.name)
1514                 elif p.arg.signature == 's':
1515                     s = 'g_param_spec_string ("%s", "%s", "%s", NULL'%(p.name_hyphen, p.name, p.name)
1516                 elif p.arg.signature == 'o':
1517                     s = 'g_param_spec_string ("%s", "%s", "%s", NULL'%(p.name_hyphen, p.name, p.name)
1518                 elif p.arg.signature == 'g':
1519                     s = 'g_param_spec_string ("%s", "%s", "%s", NULL'%(p.name_hyphen, p.name, p.name)
1520                 elif p.arg.signature == 'ay':
1521                     s = 'g_param_spec_string ("%s", "%s", "%s", NULL'%(p.name_hyphen, p.name, p.name)
1522                 elif p.arg.signature == 'as':
1523                     s = 'g_param_spec_boxed ("%s", "%s", "%s", G_TYPE_STRV'%(p.name_hyphen, p.name, p.name)
1524                 elif p.arg.signature == 'ao':
1525                     s = 'g_param_spec_boxed ("%s", "%s", "%s", G_TYPE_STRV'%(p.name_hyphen, p.name, p.name)
1526                 elif p.arg.signature == 'aay':
1527                     s = 'g_param_spec_boxed ("%s", "%s", "%s", G_TYPE_STRV'%(p.name_hyphen, p.name, p.name)
1528                 else:
1529                     print_error('Unsupported gtype "{}" for GParamSpec'.format(p.arg.gtype))
1530                 self.outfile.write('    %s, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));'%s);
1531                 self.outfile.write('\n')
1532
1533         self.outfile.write('}\n'
1534                            '\n')
1535
1536     # ----------------------------------------------------------------------------------------------------
1537
1538     def generate_property_accessors(self, i):
1539         for p in i.properties:
1540             # getter
1541             if p.readable and p.writable:
1542                 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.'
1543             elif p.readable:
1544                 hint = 'Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side.'
1545             elif p.writable:
1546                 hint = 'Since this D-Bus property is not readable, it is only meaningful to use this function on the service-side.'
1547             else:
1548                 print_error('Cannot handle property "{}" that neither readable nor writable'.format(p.name))
1549             self.outfile.write(self.docbook_gen.expand(
1550                     '/**\n'
1551                     ' * %s_get_%s: (skip)\n'
1552                     ' * @object: A #%s.\n'
1553                     ' *\n'
1554                     ' * Gets the value of the #%s:%s D-Bus property.\n'
1555                     ' *\n'
1556                     ' * %s\n'
1557                     ' *\n'
1558                     %(i.name_lower, p.name_lower, i.camel_name, i.name, p.name, hint), False))
1559             if p.arg.free_func != None:
1560                 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'
1561                                    ' *\n'
1562                                    ' * Returns: (transfer none): The property value or %%NULL if the property is not set. Do not free the returned value, it belongs to @object.\n'
1563                                    %(i.name_lower, p.name_lower))
1564             else:
1565                 self.outfile.write(' * Returns: The property value.\n')
1566             self.write_gtkdoc_deprecated_and_since_and_close(p, self.outfile, 0)
1567             self.outfile.write('%s\n'
1568                                '%s_get_%s (%s *object)\n'
1569                                '{\n'%(p.arg.ctype_in, i.name_lower, p.name_lower, i.camel_name))
1570             self.outfile.write('  return %s%s_GET_IFACE (object)->get_%s (object);\n'%(i.ns_upper, i.name_upper, p.name_lower))
1571             self.outfile.write('}\n')
1572             self.outfile.write('\n')
1573             if p.arg.free_func != None:
1574
1575                 self.outfile.write(self.docbook_gen.expand(
1576                         '/**\n'
1577                         ' * %s_dup_%s: (skip)\n'
1578                         ' * @object: A #%s.\n'
1579                         ' *\n'
1580                         ' * Gets a copy of the #%s:%s D-Bus property.\n'
1581                         ' *\n'
1582                         ' * %s\n'
1583                         ' *\n'
1584                         ' * Returns: (transfer full): The property value or %%NULL if the property is not set. The returned value should be freed with %s().\n'
1585                         %(i.name_lower, p.name_lower, i.camel_name, i.name, p.name, hint, p.arg.free_func), False))
1586                 self.write_gtkdoc_deprecated_and_since_and_close(p, self.outfile, 0)
1587                 self.outfile.write('%s\n'
1588                                    '%s_dup_%s (%s *object)\n'
1589                                    '{\n'
1590                                    '  %svalue;\n'%(p.arg.ctype_in_dup, i.name_lower, p.name_lower, i.camel_name, p.arg.ctype_in_dup))
1591                 self.outfile.write('  g_object_get (G_OBJECT (object), "%s", &value, NULL);\n'%(p.name_hyphen))
1592                 self.outfile.write('  return value;\n')
1593                 self.outfile.write('}\n')
1594                 self.outfile.write('\n')
1595
1596             # setter
1597             if p.readable and p.writable:
1598                 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.'
1599             elif p.readable:
1600                 hint = 'Since this D-Bus property is not writable, it is only meaningful to use this function on the service-side.'
1601             elif p.writable:
1602                 hint = 'Since this D-Bus property is writable, it is meaningful to use this function on both the client- and service-side.'
1603             else:
1604                 print_error('Cannot handle property "{}" that neither readable nor writable'.format(p.name))
1605             self.outfile.write(self.docbook_gen.expand(
1606                     '/**\n'
1607                     ' * %s_set_%s: (skip)\n'
1608                     ' * @object: A #%s.\n'
1609                     ' * @value: The value to set.\n'
1610                     ' *\n'
1611                     ' * Sets the #%s:%s D-Bus property to @value.\n'
1612                     ' *\n'
1613                     ' * %s\n'
1614                     %(i.name_lower, p.name_lower, i.camel_name, i.name, p.name, hint), False))
1615             self.write_gtkdoc_deprecated_and_since_and_close(p, self.outfile, 0)
1616             self.outfile.write('void\n'
1617                                '%s_set_%s (%s *object, %svalue)\n'
1618                                '{\n'%(i.name_lower, p.name_lower, i.camel_name, p.arg.ctype_in, ))
1619             self.outfile.write('  g_object_set (G_OBJECT (object), "%s", value, NULL);\n'%(p.name_hyphen))
1620             self.outfile.write('}\n')
1621             self.outfile.write('\n')
1622
1623     # ---------------------------------------------------------------------------------------------------
1624
1625     def generate_signal_emitters(self, i):
1626         for s in i.signals:
1627             self.outfile.write(self.docbook_gen.expand(
1628                     '/**\n'
1629                     ' * %s_emit_%s:\n'
1630                     ' * @object: A #%s.\n'
1631                     %(i.name_lower, s.name_lower, i.camel_name), False))
1632             for a in s.args:
1633                 self.outfile.write(' * @arg_%s: Argument to pass with the signal.\n'%(a.name))
1634             self.outfile.write(self.docbook_gen.expand(
1635                     ' *\n'
1636                     ' * Emits the #%s::%s D-Bus signal.\n'
1637                     %(i.name, s.name), False))
1638             self.write_gtkdoc_deprecated_and_since_and_close(s, self.outfile, 0)
1639             self.outfile.write('void\n'
1640                                '%s_emit_%s (\n'
1641                                '    %s *object'%(i.name_lower, s.name_lower, i.camel_name))
1642             for a in s.args:
1643                 self.outfile.write(',\n    %sarg_%s'%(a.ctype_in, a.name))
1644             self.outfile.write(')\n'
1645                                '{\n'
1646                                '  g_signal_emit_by_name (object, "%s"'%(s.name_hyphen))
1647             for a in s.args:
1648                 self.outfile.write(', arg_%s'%a.name)
1649             self.outfile.write(');\n')
1650             self.outfile.write('}\n'
1651                                '\n')
1652
1653     # ---------------------------------------------------------------------------------------------------
1654
1655     def generate_method_calls(self, i):
1656         for m in i.methods:
1657             unix_fd = False
1658             if utils.lookup_annotation(m.annotations, 'org.gtk.GDBus.C.UnixFD'):
1659                 unix_fd = True
1660             # async begin
1661             self.outfile.write('/**\n'
1662                                ' * %s_call_%s:\n'
1663                                ' * @proxy: A #%sProxy.\n'
1664                                %(i.name_lower, m.name_lower, i.camel_name))
1665             for a in m.in_args:
1666                 self.outfile.write(' * @arg_%s: Argument to pass with the method invocation.\n'%(a.name))
1667             if unix_fd:
1668                 self.outfile.write(' * @fd_list: (nullable): A #GUnixFDList or %NULL.\n')
1669             self.outfile.write(self.docbook_gen.expand(
1670                     ' * @cancellable: (nullable): A #GCancellable or %%NULL.\n'
1671                     ' * @callback: A #GAsyncReadyCallback to call when the request is satisfied or %%NULL.\n'
1672                     ' * @user_data: User data to pass to @callback.\n'
1673                     ' *\n'
1674                     ' * Asynchronously invokes the %s.%s() D-Bus method on @proxy.\n'
1675                     ' * 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'
1676                     ' * You can then call %s_call_%s_finish() to get the result of the operation.\n'
1677                     ' *\n'
1678                     ' * See %s_call_%s_sync() for the synchronous, blocking version of this method.\n'
1679                     %(i.name, m.name, i.name_lower, m.name_lower, i.name_lower, m.name_lower), False))
1680             self.write_gtkdoc_deprecated_and_since_and_close(m, self.outfile, 0)
1681             self.outfile.write('void\n'
1682                                '%s_call_%s (\n'
1683                                '    %s *proxy'%(i.name_lower, m.name_lower, i.camel_name))
1684             for a in m.in_args:
1685                 self.outfile.write(',\n    %sarg_%s'%(a.ctype_in, a.name))
1686             if unix_fd:
1687                 self.outfile.write(',\n    GUnixFDList *fd_list')
1688             self.outfile.write(',\n'
1689                                '    GCancellable *cancellable,\n'
1690                                '    GAsyncReadyCallback callback,\n'
1691                                '    gpointer user_data)\n'
1692                                '{\n')
1693             if unix_fd:
1694                 self.outfile.write('  g_dbus_proxy_call_with_unix_fd_list (G_DBUS_PROXY (proxy),\n')
1695             else:
1696                 self.outfile.write('  g_dbus_proxy_call (G_DBUS_PROXY (proxy),\n')
1697             self.outfile.write('    "%s",\n'
1698                                '    g_variant_new ("('%(m.name))
1699             for a in m.in_args:
1700                 self.outfile.write('%s'%(a.format_in))
1701             self.outfile.write(')"')
1702             for a in m.in_args:
1703                 self.outfile.write(',\n                   arg_%s'%(a.name))
1704             self.outfile.write('),\n'
1705                                '    G_DBUS_CALL_FLAGS_NONE,\n'
1706                                '    -1,\n')
1707             if unix_fd:
1708                 self.outfile.write('    fd_list,\n')
1709             self.outfile.write('    cancellable,\n'
1710                                '    callback,\n'
1711                                '    user_data);\n')
1712             self.outfile.write('}\n'
1713                                '\n')
1714             # async finish
1715             self.outfile.write('/**\n'
1716                                ' * %s_call_%s_finish:\n'
1717                                ' * @proxy: A #%sProxy.\n'
1718                                %(i.name_lower, m.name_lower, i.camel_name))
1719             for a in m.out_args:
1720                 self.outfile.write(' * @out_%s: (out)%s: Return location for return parameter or %%NULL to ignore.\n'%(a.name, ' ' + a.array_annotation if a.array_annotation else ''))
1721             if unix_fd:
1722                 self.outfile.write(' * @out_fd_list: (out): Return location for a #GUnixFDList or %NULL.\n')
1723             self.outfile.write(self.docbook_gen.expand(
1724                     ' * @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to %s_call_%s().\n'
1725                     ' * @error: Return location for error or %%NULL.\n'
1726                     ' *\n'
1727                     ' * Finishes an operation started with %s_call_%s().\n'
1728                     ' *\n'
1729                     ' * Returns: (skip): %%TRUE if the call succeded, %%FALSE if @error is set.\n'
1730                     %(i.name_lower, m.name_lower, i.name_lower, m.name_lower), False))
1731             self.write_gtkdoc_deprecated_and_since_and_close(m, self.outfile, 0)
1732             self.outfile.write('gboolean\n'
1733                                '%s_call_%s_finish (\n'
1734                                '    %s *proxy'%(i.name_lower, m.name_lower, i.camel_name))
1735             for a in m.out_args:
1736                 self.outfile.write(',\n    %sout_%s'%(a.ctype_out, a.name))
1737             if unix_fd:
1738                 self.outfile.write(',\n    GUnixFDList **out_fd_list')
1739             self.outfile.write(',\n'
1740                                '    GAsyncResult *res,\n'
1741                                '    GError **error)\n'
1742                                '{\n'
1743                                '  GVariant *_ret;\n')
1744             if unix_fd:
1745                 self.outfile.write('  _ret = g_dbus_proxy_call_with_unix_fd_list_finish (G_DBUS_PROXY (proxy), out_fd_list, res, error);\n')
1746             else:
1747                 self.outfile.write('  _ret = g_dbus_proxy_call_finish (G_DBUS_PROXY (proxy), res, error);\n')
1748             self.outfile.write('  if (_ret == NULL)\n'
1749                                '    goto _out;\n')
1750             self.outfile.write('  g_variant_get (_ret,\n'
1751                                '                 \"(')
1752             for a in m.out_args:
1753                 self.outfile.write('%s'%(a.format_out))
1754             self.outfile.write(')"')
1755             for a in m.out_args:
1756                 self.outfile.write(',\n                 out_%s'%(a.name))
1757             self.outfile.write(');\n'
1758                                '  g_variant_unref (_ret);\n')
1759             self.outfile.write('_out:\n'
1760                                '  return _ret != NULL;\n'
1761                                '}\n'
1762                                '\n')
1763
1764
1765             # sync
1766             self.outfile.write('/**\n'
1767                                ' * %s_call_%s_sync:\n'
1768                                ' * @proxy: A #%sProxy.\n'
1769                                %(i.name_lower, m.name_lower, i.camel_name))
1770             for a in m.in_args:
1771                 self.outfile.write(' * @arg_%s: Argument to pass with the method invocation.\n'%(a.name))
1772             if unix_fd:
1773                 self.outfile.write(' * @fd_list: (nullable): A #GUnixFDList or %NULL.\n')
1774             for a in m.out_args:
1775                 self.outfile.write(' * @out_%s: (out)%s: Return location for return parameter or %%NULL to ignore.\n'%(a.name, ' ' + a.array_annotation if a.array_annotation else ''))
1776             if unix_fd:
1777                 self.outfile.write(' * @out_fd_list: (out): Return location for a #GUnixFDList or %NULL.\n')
1778             self.outfile.write(self.docbook_gen.expand(
1779                     ' * @cancellable: (nullable): A #GCancellable or %%NULL.\n'
1780                     ' * @error: Return location for error or %%NULL.\n'
1781                     ' *\n'
1782                     ' * Synchronously invokes the %s.%s() D-Bus method on @proxy. The calling thread is blocked until a reply is received.\n'
1783                     ' *\n'
1784                     ' * See %s_call_%s() for the asynchronous version of this method.\n'
1785                     ' *\n'
1786                     ' * Returns: (skip): %%TRUE if the call succeded, %%FALSE if @error is set.\n'
1787                     %(i.name, m.name, i.name_lower, m.name_lower), False))
1788             self.write_gtkdoc_deprecated_and_since_and_close(m, self.outfile, 0)
1789             self.outfile.write('gboolean\n'
1790                                '%s_call_%s_sync (\n'
1791                                '    %s *proxy'%(i.name_lower, m.name_lower, i.camel_name))
1792             for a in m.in_args:
1793                 self.outfile.write(',\n    %sarg_%s'%(a.ctype_in, a.name))
1794             if unix_fd:
1795                 self.outfile.write(',\n    GUnixFDList  *fd_list')
1796             for a in m.out_args:
1797                 self.outfile.write(',\n    %sout_%s'%(a.ctype_out, a.name))
1798             if unix_fd:
1799                 self.outfile.write(',\n    GUnixFDList **out_fd_list')
1800             self.outfile.write(',\n'
1801                                '    GCancellable *cancellable,\n'
1802                                '    GError **error)\n'
1803                                '{\n'
1804                                '  GVariant *_ret;\n')
1805             if unix_fd:
1806                 self.outfile.write('  _ret = g_dbus_proxy_call_with_unix_fd_list_sync (G_DBUS_PROXY (proxy),\n')
1807             else:
1808                 self.outfile.write('  _ret = g_dbus_proxy_call_sync (G_DBUS_PROXY (proxy),\n')
1809             self.outfile.write('    "%s",\n'
1810                                '    g_variant_new ("('%(m.name))
1811             for a in m.in_args:
1812                 self.outfile.write('%s'%(a.format_in))
1813             self.outfile.write(')"')
1814             for a in m.in_args:
1815                 self.outfile.write(',\n                   arg_%s'%(a.name))
1816             self.outfile.write('),\n'
1817                                '    G_DBUS_CALL_FLAGS_NONE,\n'
1818                                '    -1,\n')
1819             if unix_fd:
1820                 self.outfile.write('    fd_list,\n'
1821                                    '    out_fd_list,\n')
1822             self.outfile.write('    cancellable,\n'
1823                                '    error);\n'
1824                                '  if (_ret == NULL)\n'
1825                                '    goto _out;\n')
1826             self.outfile.write('  g_variant_get (_ret,\n'
1827                                '                 \"(')
1828             for a in m.out_args:
1829                 self.outfile.write('%s'%(a.format_out))
1830             self.outfile.write(')"')
1831             for a in m.out_args:
1832                 self.outfile.write(',\n                 out_%s'%(a.name))
1833             self.outfile.write(');\n'
1834                                '  g_variant_unref (_ret);\n')
1835             self.outfile.write('_out:\n'
1836                                '  return _ret != NULL;\n'
1837                                '}\n'
1838                                '\n')
1839
1840     # ---------------------------------------------------------------------------------------------------
1841
1842     def generate_method_completers(self, i):
1843         for m in i.methods:
1844             unix_fd = False
1845             if utils.lookup_annotation(m.annotations, 'org.gtk.GDBus.C.UnixFD'):
1846                 unix_fd = True
1847             self.outfile.write('/**\n'
1848                                ' * %s_complete_%s:\n'
1849                                ' * @object: A #%s.\n'
1850                                ' * @invocation: (transfer full): A #GDBusMethodInvocation.\n'
1851                                %(i.name_lower, m.name_lower, i.camel_name))
1852             if unix_fd:
1853                 self.outfile.write(' * @fd_list: (nullable): A #GUnixFDList or %NULL.\n')
1854             for a in m.out_args:
1855                 self.outfile.write(' * @%s: Parameter to return.\n'%(a.name))
1856             self.outfile.write(self.docbook_gen.expand(
1857                     ' *\n'
1858                     ' * 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'
1859                     ' *\n'
1860                     ' * This method will free @invocation, you cannot use it afterwards.\n'
1861                     %(i.name, m.name), False))
1862             self.write_gtkdoc_deprecated_and_since_and_close(m, self.outfile, 0)
1863             self.outfile.write('void\n'
1864                                '%s_complete_%s (\n'
1865                                '    %s *object,\n'
1866                                '    GDBusMethodInvocation *invocation'%(i.name_lower, m.name_lower, i.camel_name))
1867             if unix_fd:
1868                 self.outfile.write(',\n    GUnixFDList *fd_list')
1869             for a in m.out_args:
1870                 self.outfile.write(',\n    %s%s'%(a.ctype_in, a.name))
1871             self.outfile.write(')\n'
1872                                '{\n')
1873
1874             if unix_fd:
1875                 self.outfile.write('  g_dbus_method_invocation_return_value_with_unix_fd_list (invocation,\n'
1876                                    '    g_variant_new ("(')
1877             else:
1878                 self.outfile.write('  g_dbus_method_invocation_return_value (invocation,\n'
1879                                    '    g_variant_new ("(')
1880             for a in m.out_args:
1881                 self.outfile.write('%s'%(a.format_in))
1882             self.outfile.write(')"')
1883             for a in m.out_args:
1884                 self.outfile.write(',\n                   %s'%(a.name))
1885             if unix_fd:
1886                 self.outfile.write('),\n    fd_list);\n')
1887             else:
1888                 self.outfile.write('));\n')
1889             self.outfile.write('}\n'
1890                                '\n')
1891
1892     # ---------------------------------------------------------------------------------------------------
1893
1894     def generate_proxy(self, i):
1895         # class boilerplate
1896         self.outfile.write('/* ------------------------------------------------------------------------ */\n'
1897                            '\n')
1898
1899         self.outfile.write(self.docbook_gen.expand(
1900                 '/**\n'
1901                 ' * %sProxy:\n'
1902                 ' *\n'
1903                 ' * The #%sProxy structure contains only private data and should only be accessed using the provided API.\n'
1904                 %(i.camel_name, i.camel_name), False))
1905         self.write_gtkdoc_deprecated_and_since_and_close(i, self.outfile, 0)
1906         self.outfile.write('\n')
1907
1908         self.outfile.write(self.docbook_gen.expand(
1909                 '/**\n'
1910                 ' * %sProxyClass:\n'
1911                 ' * @parent_class: The parent class.\n'
1912                 ' *\n'
1913                 ' * Class structure for #%sProxy.\n'
1914                 %(i.camel_name, i.camel_name), False))
1915         self.write_gtkdoc_deprecated_and_since_and_close(i, self.outfile, 0)
1916         self.outfile.write('\n')
1917
1918         self.outfile.write('struct _%sProxyPrivate\n'
1919                            '{\n'
1920                            '  GData *qdata;\n'
1921                            '};\n'
1922                            '\n'%i.camel_name)
1923
1924         self.outfile.write('static void %s_proxy_iface_init (%sIface *iface);\n'
1925                            '\n'%(i.name_lower, i.camel_name))
1926         self.outfile.write('#if GLIB_VERSION_MAX_ALLOWED >= GLIB_VERSION_2_38\n')
1927         self.outfile.write('G_DEFINE_TYPE_WITH_CODE (%sProxy, %s_proxy, G_TYPE_DBUS_PROXY,\n'%(i.camel_name, i.name_lower))
1928         self.outfile.write('                         G_ADD_PRIVATE (%sProxy)\n'%(i.camel_name))
1929         self.outfile.write('                         G_IMPLEMENT_INTERFACE (%sTYPE_%s, %s_proxy_iface_init))\n\n'%(i.ns_upper, i.name_upper, i.name_lower))
1930         self.outfile.write('#else\n')
1931         self.outfile.write('G_DEFINE_TYPE_WITH_CODE (%sProxy, %s_proxy, G_TYPE_DBUS_PROXY,\n'%(i.camel_name, i.name_lower))
1932         self.outfile.write('                         G_IMPLEMENT_INTERFACE (%sTYPE_%s, %s_proxy_iface_init))\n\n'%(i.ns_upper, i.name_upper, i.name_lower))
1933         self.outfile.write('#endif\n')
1934
1935         # finalize
1936         self.outfile.write('static void\n'
1937                            '%s_proxy_finalize (GObject *object)\n'
1938                            '{\n'%(i.name_lower))
1939         self.outfile.write('  %sProxy *proxy = %s%s_PROXY (object);\n'%(i.camel_name, i.ns_upper, i.name_upper))
1940         self.outfile.write('  g_datalist_clear (&proxy->priv->qdata);\n')
1941         self.outfile.write('  G_OBJECT_CLASS (%s_proxy_parent_class)->finalize (object);\n'
1942                            '}\n'
1943                            '\n'%(i.name_lower))
1944
1945         # property accessors
1946         #
1947         # Note that we are guaranteed that prop_id starts at 1 and is
1948         # laid out in the same order as introspection data pointers
1949         #
1950         self.outfile.write('static void\n'
1951                            '%s_proxy_get_property (GObject      *object,\n'
1952                            '  guint         prop_id,\n'
1953                            '  GValue       *value,\n'
1954                            '  GParamSpec   *pspec G_GNUC_UNUSED)\n'
1955                            '{\n'%(i.name_lower))
1956         if len(i.properties) > 0:
1957             self.outfile.write('  const _ExtendedGDBusPropertyInfo *info;\n'
1958                                '  GVariant *variant;\n'
1959                                '  g_assert (prop_id != 0 && prop_id - 1 < %d);\n'
1960                                '  info = (const _ExtendedGDBusPropertyInfo *) _%s_property_info_pointers[prop_id - 1];\n'
1961                                '  variant = g_dbus_proxy_get_cached_property (G_DBUS_PROXY (object), info->parent_struct.name);\n'
1962                                '  if (info->use_gvariant)\n'
1963                                '    {\n'
1964                                '      g_value_set_variant (value, variant);\n'
1965                                '    }\n'
1966                                '  else\n'
1967                                '    {\n'
1968                                # could be that we don't have the value in cache - in that case, we do
1969                                # nothing and the user gets the default value for the GType
1970                                '      if (variant != NULL)\n'
1971                                '        g_dbus_gvariant_to_gvalue (variant, value);\n'
1972                                '    }\n'
1973                                '  if (variant != NULL)\n'
1974                                '    g_variant_unref (variant);\n'
1975                                %(len(i.properties), i.name_lower))
1976         self.outfile.write('}\n'
1977                            '\n')
1978         if len(i.properties) > 0:
1979             self.outfile.write('static void\n'
1980                                '%s_proxy_set_property_cb (GDBusProxy *proxy,\n'
1981                                '  GAsyncResult *res,\n'
1982                                '  gpointer      user_data)\n'
1983                                '{\n'%(i.name_lower))
1984             self.outfile.write('  const _ExtendedGDBusPropertyInfo *info = user_data;\n'
1985                                '  GError *error;\n'
1986                                '  GVariant *_ret;\n'
1987                                '  error = NULL;\n'
1988                                '  _ret = g_dbus_proxy_call_finish (proxy, res, &error);\n'
1989                                '  if (!_ret)\n'
1990                                '    {\n'
1991                                '      g_warning ("Error setting property \'%%s\' on interface %s: %%s (%%s, %%d)",\n'
1992                                '                 info->parent_struct.name, \n'
1993                                '                 error->message, g_quark_to_string (error->domain), error->code);\n'
1994                                '      g_error_free (error);\n'
1995                                '    }\n'
1996                                '  else\n'
1997                                '    {\n'
1998                                '      g_variant_unref (_ret);\n'
1999                                '    }\n'
2000                                %(i.name))
2001             self.outfile.write('}\n'
2002                                '\n')
2003         self.outfile.write('static void\n'
2004                            '%s_proxy_set_property (GObject      *object,\n'
2005                            '  guint         prop_id,\n'
2006                            '  const GValue *value,\n'
2007                            '  GParamSpec   *pspec G_GNUC_UNUSED)\n'
2008                            '{\n'%(i.name_lower))
2009         if len(i.properties) > 0:
2010             self.outfile.write('  const _ExtendedGDBusPropertyInfo *info;\n'
2011                                '  GVariant *variant;\n'
2012                                '  g_assert (prop_id != 0 && prop_id - 1 < %d);\n'
2013                                '  info = (const _ExtendedGDBusPropertyInfo *) _%s_property_info_pointers[prop_id - 1];\n'
2014                                '  variant = g_dbus_gvalue_to_gvariant (value, G_VARIANT_TYPE (info->parent_struct.signature));\n'
2015                                '  g_dbus_proxy_call (G_DBUS_PROXY (object),\n'
2016                                '    "org.freedesktop.DBus.Properties.Set",\n'
2017                                '    g_variant_new ("(ssv)", "%s", info->parent_struct.name, variant),\n'
2018                                '    G_DBUS_CALL_FLAGS_NONE,\n'
2019                                '    -1,\n'
2020                                '    NULL, (GAsyncReadyCallback) %s_proxy_set_property_cb, (GDBusPropertyInfo *) &info->parent_struct);\n'
2021                                '  g_variant_unref (variant);\n'
2022                                %(len(i.properties), i.name_lower, i.name, i.name_lower))
2023         self.outfile.write('}\n'
2024                            '\n')
2025
2026         # signal received
2027         self.outfile.write('static void\n'
2028                            '%s_proxy_g_signal (GDBusProxy *proxy,\n'
2029                            '  const gchar *sender_name G_GNUC_UNUSED,\n'
2030                            '  const gchar *signal_name,\n'
2031                            '  GVariant *parameters)\n'
2032                            '{\n'%(i.name_lower))
2033         self.outfile.write('  _ExtendedGDBusSignalInfo *info;\n'
2034                            '  GVariantIter iter;\n'
2035                            '  GVariant *child;\n'
2036                            '  GValue *paramv;\n'
2037                            '  gsize num_params;\n'
2038                            '  gsize n;\n'
2039                            '  guint signal_id;\n');
2040         # Note: info could be NULL if we are talking to a newer version of the interface
2041         self.outfile.write('  info = (_ExtendedGDBusSignalInfo *) g_dbus_interface_info_lookup_signal ((GDBusInterfaceInfo *) &_%s_interface_info.parent_struct, signal_name);\n'
2042                            '  if (info == NULL)\n'
2043                            '    return;\n'
2044                            %(i.name_lower))
2045         self.outfile.write('  num_params = g_variant_n_children (parameters);\n'
2046                            '  paramv = g_new0 (GValue, num_params + 1);\n'
2047                            '  g_value_init (&paramv[0], %sTYPE_%s);\n'
2048                            '  g_value_set_object (&paramv[0], proxy);\n'
2049                            %(i.ns_upper, i.name_upper))
2050         self.outfile.write('  g_variant_iter_init (&iter, parameters);\n'
2051                            '  n = 1;\n'
2052                            '  while ((child = g_variant_iter_next_value (&iter)) != NULL)\n'
2053                            '    {\n'
2054                            '      _ExtendedGDBusArgInfo *arg_info = (_ExtendedGDBusArgInfo *) info->parent_struct.args[n - 1];\n'
2055                            '      if (arg_info->use_gvariant)\n'
2056                            '        {\n'
2057                            '          g_value_init (&paramv[n], G_TYPE_VARIANT);\n'
2058                            '          g_value_set_variant (&paramv[n], child);\n'
2059                            '          n++;\n'
2060                            '        }\n'
2061                            '      else\n'
2062                            '        g_dbus_gvariant_to_gvalue (child, &paramv[n++]);\n'
2063                            '      g_variant_unref (child);\n'
2064                            '    }\n'
2065                            )
2066         self.outfile.write('  signal_id = g_signal_lookup (info->signal_name, %sTYPE_%s);\n'
2067                            %(i.ns_upper, i.name_upper))
2068         self.outfile.write('  g_signal_emitv (paramv, signal_id, 0, NULL);\n')
2069         self.outfile.write('  for (n = 0; n < num_params + 1; n++)\n'
2070                            '    g_value_unset (&paramv[n]);\n'
2071                            '  g_free (paramv);\n')
2072         self.outfile.write('}\n'
2073                            '\n')
2074
2075         # property changed
2076         self.outfile.write('static void\n'
2077                            '%s_proxy_g_properties_changed (GDBusProxy *_proxy,\n'
2078                            '  GVariant *changed_properties,\n'
2079                            '  const gchar *const *invalidated_properties)\n'
2080                            '{\n'%(i.name_lower))
2081         # Note: info could be NULL if we are talking to a newer version of the interface
2082         self.outfile.write('  %sProxy *proxy = %s%s_PROXY (_proxy);\n'
2083                            '  guint n;\n'
2084                            '  const gchar *key;\n'
2085                            '  GVariantIter *iter;\n'
2086                            '  _ExtendedGDBusPropertyInfo *info;\n'
2087                            '  g_variant_get (changed_properties, "a{sv}", &iter);\n'
2088                            '  while (g_variant_iter_next (iter, "{&sv}", &key, NULL))\n'
2089                            '    {\n'
2090                            '      info = (_ExtendedGDBusPropertyInfo *) g_dbus_interface_info_lookup_property ((GDBusInterfaceInfo *) &_%s_interface_info.parent_struct, key);\n'
2091                            '      g_datalist_remove_data (&proxy->priv->qdata, key);\n'
2092                            '      if (info != NULL)\n'
2093                            '        g_object_notify (G_OBJECT (proxy), info->hyphen_name);\n'
2094                            '    }\n'
2095                            '  g_variant_iter_free (iter);\n'
2096                            '  for (n = 0; invalidated_properties[n] != NULL; n++)\n'
2097                            '    {\n'
2098                            '      info = (_ExtendedGDBusPropertyInfo *) g_dbus_interface_info_lookup_property ((GDBusInterfaceInfo *) &_%s_interface_info.parent_struct, invalidated_properties[n]);\n'
2099                            '      g_datalist_remove_data (&proxy->priv->qdata, invalidated_properties[n]);\n'
2100                            '      if (info != NULL)\n'
2101                            '        g_object_notify (G_OBJECT (proxy), info->hyphen_name);\n'
2102                            '    }\n'
2103                            '}\n'
2104                            '\n'
2105                            %(i.camel_name, i.ns_upper, i.name_upper,
2106                              i.name_lower, i.name_lower))
2107
2108         # property vfuncs
2109         for p in i.properties:
2110             nul_value = '0'
2111             if p.arg.free_func != None:
2112                 nul_value = 'NULL'
2113             self.outfile.write('static %s\n'
2114                                '%s_proxy_get_%s (%s *object)\n'
2115                                '{\n'
2116                                '  %sProxy *proxy = %s%s_PROXY (object);\n'
2117                                '  GVariant *variant;\n'
2118                                '  %svalue = %s;\n'%(p.arg.ctype_in, i.name_lower, p.name_lower, i.camel_name,
2119                                                     i.camel_name, i.ns_upper, i.name_upper,
2120                                                     p.arg.ctype_in, nul_value))
2121             # For some property types, we have to free the returned
2122             # value (or part of it, e.g. the container) because of how
2123             # GVariant works.. see https://bugzilla.gnome.org/show_bug.cgi?id=657100
2124             # for details
2125             #
2126             free_container = False;
2127             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':
2128                 free_container = True;
2129             # If already using an old value for strv, objv, bytestring_array (see below),
2130             # then just return that... that way the result from multiple consecutive calls
2131             # to the getter are valid as long as they're freed
2132             #
2133             if free_container:
2134                 self.outfile.write('  value = g_datalist_get_data (&proxy->priv->qdata, \"%s\");\n'
2135                                    '  if (value != NULL)\n'
2136                                    '    return value;\n'
2137                                    %(p.name))
2138             self.outfile.write('  variant = g_dbus_proxy_get_cached_property (G_DBUS_PROXY (proxy), \"%s\");\n'%(p.name))
2139             if p.arg.gtype == 'G_TYPE_VARIANT':
2140                 self.outfile.write('  value = variant;\n')
2141                 self.outfile.write('  if (variant != NULL)\n')
2142                 self.outfile.write('    g_variant_unref (variant);\n')
2143             else:
2144                 self.outfile.write('  if (variant != NULL)\n'
2145                                    '    {\n')
2146                 extra_len = ''
2147                 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':
2148                     extra_len = ', NULL'
2149                 self.outfile.write('      value = %s (variant%s);\n'%(p.arg.gvariant_get, extra_len))
2150                 if free_container:
2151                     self.outfile.write('      g_datalist_set_data_full (&proxy->priv->qdata, \"%s\", (gpointer) value, g_free);\n'
2152                                        %(p.name))
2153                 self.outfile.write('      g_variant_unref (variant);\n')
2154                 self.outfile.write('    }\n')
2155             self.outfile.write('  return value;\n')
2156             self.outfile.write('}\n')
2157             self.outfile.write('\n')
2158
2159         # class boilerplate
2160         self.outfile.write('static void\n'
2161                            '%s_proxy_init (%sProxy *proxy)\n'
2162                            '{\n'
2163                            '#if GLIB_VERSION_MAX_ALLOWED >= GLIB_VERSION_2_38\n'
2164                            '  proxy->priv = %s_proxy_get_instance_private (proxy);\n'
2165                            '#else\n'
2166                            '  proxy->priv = G_TYPE_INSTANCE_GET_PRIVATE (proxy, %sTYPE_%s_PROXY, %sProxyPrivate);\n'
2167                            '#endif\n\n'
2168                            '  g_dbus_proxy_set_interface_info (G_DBUS_PROXY (proxy), %s_interface_info ());\n'
2169                            '}\n'
2170                            '\n'
2171                            %(i.name_lower, i.camel_name,
2172                              i.name_lower,
2173                              i.ns_upper, i.name_upper, i.camel_name,
2174                              i.name_lower))
2175         self.outfile.write('static void\n'
2176                            '%s_proxy_class_init (%sProxyClass *klass)\n'
2177                            '{\n'
2178                            '  GObjectClass *gobject_class;\n'
2179                            '  GDBusProxyClass *proxy_class;\n'
2180                            '\n'
2181                            '  gobject_class = G_OBJECT_CLASS (klass);\n'
2182                            '  gobject_class->finalize     = %s_proxy_finalize;\n'
2183                            '  gobject_class->get_property = %s_proxy_get_property;\n'
2184                            '  gobject_class->set_property = %s_proxy_set_property;\n'
2185                            '\n'
2186                            '  proxy_class = G_DBUS_PROXY_CLASS (klass);\n'
2187                            '  proxy_class->g_signal = %s_proxy_g_signal;\n'
2188                            '  proxy_class->g_properties_changed = %s_proxy_g_properties_changed;\n'
2189                            '\n'%(i.name_lower, i.camel_name,
2190                                  i.name_lower, i.name_lower, i.name_lower, i.name_lower, i.name_lower))
2191         if len(i.properties) > 0:
2192             self.outfile.write('  %s_override_properties (gobject_class, 1);\n\n'%(i.name_lower))
2193         self.outfile.write('#if GLIB_VERSION_MAX_ALLOWED < GLIB_VERSION_2_38\n'
2194                            '  g_type_class_add_private (klass, sizeof (%sProxyPrivate));\n'
2195                            '#endif\n'%(i.camel_name))
2196         self.outfile.write('}\n'
2197                            '\n')
2198
2199         self.outfile.write('static void\n'
2200                            '%s_proxy_iface_init (%sIface *iface)\n'
2201                            '{\n'%(i.name_lower, i.camel_name))
2202         for p in i.properties:
2203             self.outfile.write('  iface->get_%s = %s_proxy_get_%s;\n'%(p.name_lower, i.name_lower, p.name_lower))
2204         self.outfile.write('}\n'
2205                            '\n')
2206
2207         # constructors
2208         self.outfile.write(self.docbook_gen.expand(
2209                 '/**\n'
2210                 ' * %s_proxy_new:\n'
2211                 ' * @connection: A #GDBusConnection.\n'
2212                 ' * @flags: Flags from the #GDBusProxyFlags enumeration.\n'
2213                 ' * @name: (nullable): A bus name (well-known or unique) or %%NULL if @connection is not a message bus connection.\n'
2214                 ' * @object_path: An object path.\n'
2215                 ' * @cancellable: (nullable): A #GCancellable or %%NULL.\n'
2216                 ' * @callback: A #GAsyncReadyCallback to call when the request is satisfied.\n'
2217                 ' * @user_data: User data to pass to @callback.\n'
2218                 ' *\n'
2219                 ' * Asynchronously creates a proxy for the D-Bus interface #%s. See g_dbus_proxy_new() for more details.\n'
2220                 ' *\n'
2221                 ' * 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'
2222                 ' * You can then call %s_proxy_new_finish() to get the result of the operation.\n'
2223                 ' *\n'
2224                 ' * See %s_proxy_new_sync() for the synchronous, blocking version of this constructor.\n'
2225                 %(i.name_lower, i.name, i.name_lower, i.name_lower), False))
2226         self.write_gtkdoc_deprecated_and_since_and_close(i, self.outfile, 0)
2227         self.outfile.write('void\n'
2228                            '%s_proxy_new (\n'
2229                            '    GDBusConnection     *connection,\n'
2230                            '    GDBusProxyFlags      flags,\n'
2231                            '    const gchar         *name,\n'
2232                            '    const gchar         *object_path,\n'
2233                            '    GCancellable        *cancellable,\n'
2234                            '    GAsyncReadyCallback  callback,\n'
2235                            '    gpointer             user_data)\n'
2236                            '{\n'
2237                            '  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'
2238                            '}\n'
2239                            '\n'
2240                            %(i.name_lower, i.ns_upper, i.name_upper, i.name))
2241         self.outfile.write('/**\n'
2242                            ' * %s_proxy_new_finish:\n'
2243                            ' * @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to %s_proxy_new().\n'
2244                            ' * @error: Return location for error or %%NULL\n'
2245                            ' *\n'
2246                            ' * Finishes an operation started with %s_proxy_new().\n'
2247                            ' *\n'
2248                            ' * Returns: (transfer full) (type %sProxy): The constructed proxy object or %%NULL if @error is set.\n'
2249                            %(i.name_lower, i.name_lower, i.name_lower, i.camel_name))
2250         self.write_gtkdoc_deprecated_and_since_and_close(i, self.outfile, 0)
2251         self.outfile.write('%s *\n'
2252                            '%s_proxy_new_finish (\n'
2253                            '    GAsyncResult        *res,\n'
2254                            '    GError             **error)\n'
2255                            '{\n'
2256                            '  GObject *ret;\n'
2257                            '  GObject *source_object;\n'
2258                            '  source_object = g_async_result_get_source_object (res);\n'
2259                            '  ret = g_async_initable_new_finish (G_ASYNC_INITABLE (source_object), res, error);\n'
2260                            '  g_object_unref (source_object);\n'
2261                            '  if (ret != NULL)\n'
2262                            '    return %s%s (ret);\n'
2263                            '  else\n'
2264                            '    return NULL;\n'
2265                            '}\n'
2266                            '\n'
2267                            %(i.camel_name, i.name_lower, i.ns_upper, i.name_upper))
2268         self.outfile.write(self.docbook_gen.expand(
2269                 '/**\n'
2270                 ' * %s_proxy_new_sync:\n'
2271                 ' * @connection: A #GDBusConnection.\n'
2272                 ' * @flags: Flags from the #GDBusProxyFlags enumeration.\n'
2273                 ' * @name: (nullable): A bus name (well-known or unique) or %%NULL if @connection is not a message bus connection.\n'
2274                 ' * @object_path: An object path.\n'
2275                 ' * @cancellable: (nullable): A #GCancellable or %%NULL.\n'
2276                 ' * @error: Return location for error or %%NULL\n'
2277                 ' *\n'
2278                 ' * Synchronously creates a proxy for the D-Bus interface #%s. See g_dbus_proxy_new_sync() for more details.\n'
2279                 ' *\n'
2280                 ' * The calling thread is blocked until a reply is received.\n'
2281                 ' *\n'
2282                 ' * See %s_proxy_new() for the asynchronous version of this constructor.\n'
2283                 ' *\n'
2284                 ' * Returns: (transfer full) (type %sProxy): The constructed proxy object or %%NULL if @error is set.\n'
2285                 %(i.name_lower, i.name, i.name_lower, i.camel_name), False))
2286         self.write_gtkdoc_deprecated_and_since_and_close(i, self.outfile, 0)
2287         self.outfile.write('%s *\n'
2288                            '%s_proxy_new_sync (\n'
2289                            '    GDBusConnection     *connection,\n'
2290                            '    GDBusProxyFlags      flags,\n'
2291                            '    const gchar         *name,\n'
2292                            '    const gchar         *object_path,\n'
2293                            '    GCancellable        *cancellable,\n'
2294                            '    GError             **error)\n'
2295                            '{\n'
2296                            '  GInitable *ret;\n'
2297                            '  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'
2298                            '  if (ret != NULL)\n'
2299                            '    return %s%s (ret);\n'
2300                            '  else\n'
2301                            '    return NULL;\n'
2302                            '}\n'
2303                            '\n'
2304                            %(i.camel_name, i.name_lower, i.ns_upper, i.name_upper, i.name, i.ns_upper, i.name_upper))
2305         self.outfile.write('\n')
2306         self.outfile.write(self.docbook_gen.expand(
2307                 '/**\n'
2308                 ' * %s_proxy_new_for_bus:\n'
2309                 ' * @bus_type: A #GBusType.\n'
2310                 ' * @flags: Flags from the #GDBusProxyFlags enumeration.\n'
2311                 ' * @name: A bus name (well-known or unique).\n'
2312                 ' * @object_path: An object path.\n'
2313                 ' * @cancellable: (nullable): A #GCancellable or %%NULL.\n'
2314                 ' * @callback: A #GAsyncReadyCallback to call when the request is satisfied.\n'
2315                 ' * @user_data: User data to pass to @callback.\n'
2316                 ' *\n'
2317                 ' * Like %s_proxy_new() but takes a #GBusType instead of a #GDBusConnection.\n'
2318                 ' *\n'
2319                 ' * 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'
2320                 ' * You can then call %s_proxy_new_for_bus_finish() to get the result of the operation.\n'
2321                 ' *\n'
2322                 ' * See %s_proxy_new_for_bus_sync() for the synchronous, blocking version of this constructor.\n'
2323                 %(i.name_lower, i.name_lower, i.name_lower, i.name_lower), False))
2324         self.write_gtkdoc_deprecated_and_since_and_close(i, self.outfile, 0)
2325         self.outfile.write('void\n'
2326                            '%s_proxy_new_for_bus (\n'
2327                            '    GBusType             bus_type,\n'
2328                            '    GDBusProxyFlags      flags,\n'
2329                            '    const gchar         *name,\n'
2330                            '    const gchar         *object_path,\n'
2331                            '    GCancellable        *cancellable,\n'
2332                            '    GAsyncReadyCallback  callback,\n'
2333                            '    gpointer             user_data)\n'
2334                            '{\n'
2335                            '  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'
2336                            '}\n'
2337                            '\n'
2338                            %(i.name_lower, i.ns_upper, i.name_upper, i.name))
2339         self.outfile.write('/**\n'
2340                            ' * %s_proxy_new_for_bus_finish:\n'
2341                            ' * @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to %s_proxy_new_for_bus().\n'
2342                            ' * @error: Return location for error or %%NULL\n'
2343                            ' *\n'
2344                            ' * Finishes an operation started with %s_proxy_new_for_bus().\n'
2345                            ' *\n'
2346                            ' * Returns: (transfer full) (type %sProxy): The constructed proxy object or %%NULL if @error is set.\n'
2347                            %(i.name_lower, i.name_lower, i.name_lower, i.camel_name))
2348         self.write_gtkdoc_deprecated_and_since_and_close(i, self.outfile, 0)
2349         self.outfile.write('%s *\n'
2350                            '%s_proxy_new_for_bus_finish (\n'
2351                            '    GAsyncResult        *res,\n'
2352                            '    GError             **error)\n'
2353                            '{\n'
2354                            '  GObject *ret;\n'
2355                            '  GObject *source_object;\n'
2356                            '  source_object = g_async_result_get_source_object (res);\n'
2357                            '  ret = g_async_initable_new_finish (G_ASYNC_INITABLE (source_object), res, error);\n'
2358                            '  g_object_unref (source_object);\n'
2359                            '  if (ret != NULL)\n'
2360                            '    return %s%s (ret);\n'
2361                            '  else\n'
2362                            '    return NULL;\n'
2363                            '}\n'
2364                            '\n'
2365                            %(i.camel_name, i.name_lower, i.ns_upper, i.name_upper))
2366         self.outfile.write(self.docbook_gen.expand(
2367                 '/**\n'
2368                 ' * %s_proxy_new_for_bus_sync:\n'
2369                 ' * @bus_type: A #GBusType.\n'
2370                 ' * @flags: Flags from the #GDBusProxyFlags enumeration.\n'
2371                 ' * @name: A bus name (well-known or unique).\n'
2372                 ' * @object_path: An object path.\n'
2373                 ' * @cancellable: (nullable): A #GCancellable or %%NULL.\n'
2374                 ' * @error: Return location for error or %%NULL\n'
2375                 ' *\n'
2376                 ' * Like %s_proxy_new_sync() but takes a #GBusType instead of a #GDBusConnection.\n'
2377                 ' *\n'
2378                 ' * The calling thread is blocked until a reply is received.\n'
2379                 ' *\n'
2380                 ' * See %s_proxy_new_for_bus() for the asynchronous version of this constructor.\n'
2381                 ' *\n'
2382                 ' * Returns: (transfer full) (type %sProxy): The constructed proxy object or %%NULL if @error is set.\n'
2383                 %(i.name_lower, i.name_lower, i.name_lower, i.camel_name), False))
2384         self.write_gtkdoc_deprecated_and_since_and_close(i, self.outfile, 0)
2385         self.outfile.write('%s *\n'
2386                            '%s_proxy_new_for_bus_sync (\n'
2387                            '    GBusType             bus_type,\n'
2388                            '    GDBusProxyFlags      flags,\n'
2389                            '    const gchar         *name,\n'
2390                            '    const gchar         *object_path,\n'
2391                            '    GCancellable        *cancellable,\n'
2392                            '    GError             **error)\n'
2393                            '{\n'
2394                            '  GInitable *ret;\n'
2395                            '  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'
2396                            '  if (ret != NULL)\n'
2397                            '    return %s%s (ret);\n'
2398                            '  else\n'
2399                            '    return NULL;\n'
2400                            '}\n'
2401                            '\n'
2402                            %(i.camel_name, i.name_lower, i.ns_upper, i.name_upper, i.name, i.ns_upper, i.name_upper))
2403         self.outfile.write('\n')
2404
2405     # ---------------------------------------------------------------------------------------------------
2406
2407     def generate_skeleton(self, i):
2408         # class boilerplate
2409         self.outfile.write('/* ------------------------------------------------------------------------ */\n'
2410                            '\n')
2411
2412         self.outfile.write(self.docbook_gen.expand(
2413                 '/**\n'
2414                 ' * %sSkeleton:\n'
2415                 ' *\n'
2416                 ' * The #%sSkeleton structure contains only private data and should only be accessed using the provided API.\n'
2417                 %(i.camel_name, i.camel_name), False))
2418         self.write_gtkdoc_deprecated_and_since_and_close(i, self.outfile, 0)
2419         self.outfile.write('\n')
2420
2421         self.outfile.write(self.docbook_gen.expand(
2422                 '/**\n'
2423                 ' * %sSkeletonClass:\n'
2424                 ' * @parent_class: The parent class.\n'
2425                 ' *\n'
2426                 ' * Class structure for #%sSkeleton.\n'
2427                 %(i.camel_name, i.camel_name), False))
2428         self.write_gtkdoc_deprecated_and_since_and_close(i, self.outfile, 0)
2429         self.outfile.write('\n')
2430
2431         self.outfile.write('struct _%sSkeletonPrivate\n'
2432                            '{\n'
2433                            '  GValue *properties;\n'
2434                            '  GList *changed_properties;\n'
2435                            '  GSource *changed_properties_idle_source;\n'
2436                            '  GMainContext *context;\n'
2437                            '  GMutex lock;\n'
2438                            '};\n'
2439                            '\n'%i.camel_name)
2440
2441         self.outfile.write('static void\n'
2442                            '_%s_skeleton_handle_method_call (\n'
2443                            '  GDBusConnection *connection G_GNUC_UNUSED,\n'
2444                            '  const gchar *sender G_GNUC_UNUSED,\n'
2445                            '  const gchar *object_path G_GNUC_UNUSED,\n'
2446                            '  const gchar *interface_name,\n'
2447                            '  const gchar *method_name,\n'
2448                            '  GVariant *parameters,\n'
2449                            '  GDBusMethodInvocation *invocation,\n'
2450                            '  gpointer user_data)\n'
2451                            '{\n'
2452                            '  %sSkeleton *skeleton = %s%s_SKELETON (user_data);\n'
2453                            '  _ExtendedGDBusMethodInfo *info;\n'
2454                            '  GVariantIter iter;\n'
2455                            '  GVariant *child;\n'
2456                            '  GValue *paramv;\n'
2457                            '  gsize num_params;\n'
2458                            '  guint num_extra;\n'
2459                            '  gsize n;\n'
2460                            '  guint signal_id;\n'
2461                            '  GValue return_value = G_VALUE_INIT;\n'
2462                            %(i.name_lower, i.camel_name, i.ns_upper, i.name_upper))
2463         self.outfile.write('  info = (_ExtendedGDBusMethodInfo *) g_dbus_method_invocation_get_method_info (invocation);\n'
2464                            '  g_assert (info != NULL);\n'
2465                            %())
2466         self.outfile.write('  num_params = g_variant_n_children (parameters);\n'
2467                            '  num_extra = info->pass_fdlist ? 3 : 2;'
2468                            '  paramv = g_new0 (GValue, num_params + num_extra);\n'
2469                            '  n = 0;\n'
2470                            '  g_value_init (&paramv[n], %sTYPE_%s);\n'
2471                            '  g_value_set_object (&paramv[n++], skeleton);\n'
2472                            '  g_value_init (&paramv[n], G_TYPE_DBUS_METHOD_INVOCATION);\n'
2473                            '  g_value_set_object (&paramv[n++], invocation);\n'
2474                            '  if (info->pass_fdlist)\n'
2475                            '    {\n'
2476                            '#ifdef G_OS_UNIX\n'
2477                            '      g_value_init (&paramv[n], G_TYPE_UNIX_FD_LIST);\n'
2478                            '      g_value_set_object (&paramv[n++], g_dbus_message_get_unix_fd_list (g_dbus_method_invocation_get_message (invocation)));\n'
2479                            '#else\n'
2480                            '      g_assert_not_reached ();\n'
2481                            '#endif\n'
2482                            '    }\n'
2483                            %(i.ns_upper, i.name_upper))
2484         self.outfile.write('  g_variant_iter_init (&iter, parameters);\n'
2485                            '  while ((child = g_variant_iter_next_value (&iter)) != NULL)\n'
2486                            '    {\n'
2487                            '      _ExtendedGDBusArgInfo *arg_info = (_ExtendedGDBusArgInfo *) info->parent_struct.in_args[n - num_extra];\n'
2488                            '      if (arg_info->use_gvariant)\n'
2489                            '        {\n'
2490                            '          g_value_init (&paramv[n], G_TYPE_VARIANT);\n'
2491                            '          g_value_set_variant (&paramv[n], child);\n'
2492                            '          n++;\n'
2493                            '        }\n'
2494                            '      else\n'
2495                            '        g_dbus_gvariant_to_gvalue (child, &paramv[n++]);\n'
2496                            '      g_variant_unref (child);\n'
2497                            '    }\n')
2498         self.outfile.write('  signal_id = g_signal_lookup (info->signal_name, %sTYPE_%s);\n'
2499                            %(i.ns_upper, i.name_upper))
2500         self.outfile.write('  g_value_init (&return_value, G_TYPE_BOOLEAN);\n'
2501                            '  g_signal_emitv (paramv, signal_id, 0, &return_value);\n'
2502                            '  if (!g_value_get_boolean (&return_value))\n'
2503                            '    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'
2504                            '  g_value_unset (&return_value);\n')
2505         self.outfile.write('  for (n = 0; n < num_params + num_extra; n++)\n'
2506                            '    g_value_unset (&paramv[n]);\n'
2507                            '  g_free (paramv);\n')
2508         self.outfile.write('}\n'
2509                            '\n')
2510
2511         self.outfile.write('static GVariant *\n'
2512                            '_%s_skeleton_handle_get_property (\n'
2513                            '  GDBusConnection *connection G_GNUC_UNUSED,\n'
2514                            '  const gchar *sender G_GNUC_UNUSED,\n'
2515                            '  const gchar *object_path G_GNUC_UNUSED,\n'
2516                            '  const gchar *interface_name G_GNUC_UNUSED,\n'
2517                            '  const gchar *property_name,\n'
2518                            '  GError **error,\n'
2519                            '  gpointer user_data)\n'
2520                            '{\n'
2521                            '  %sSkeleton *skeleton = %s%s_SKELETON (user_data);\n'
2522                            '  GValue value = G_VALUE_INIT;\n'
2523                            '  GParamSpec *pspec;\n'
2524                            '  _ExtendedGDBusPropertyInfo *info;\n'
2525                            '  GVariant *ret;\n'
2526                            %(i.name_lower, i.camel_name, i.ns_upper, i.name_upper))
2527         self.outfile.write('  ret = NULL;\n'
2528                            '  info = (_ExtendedGDBusPropertyInfo *) g_dbus_interface_info_lookup_property ((GDBusInterfaceInfo *) &_%s_interface_info.parent_struct, property_name);\n'
2529                            '  g_assert (info != NULL);\n'
2530                            '  pspec = g_object_class_find_property (G_OBJECT_GET_CLASS (skeleton), info->hyphen_name);\n'
2531                            '  if (pspec == NULL)\n'
2532                            '    {\n'
2533                            '      g_set_error (error, G_DBUS_ERROR, G_DBUS_ERROR_INVALID_ARGS, "No property with name %%s", property_name);\n'
2534                            '    }\n'
2535                            '  else\n'
2536                            '    {\n'
2537                            '      g_value_init (&value, pspec->value_type);\n'
2538                            '      g_object_get_property (G_OBJECT (skeleton), info->hyphen_name, &value);\n'
2539                            '      ret = g_dbus_gvalue_to_gvariant (&value, G_VARIANT_TYPE (info->parent_struct.signature));\n'
2540                            '      g_value_unset (&value);\n'
2541                            '    }\n'
2542                            '  return ret;\n'
2543                            '}\n'
2544                            '\n'
2545                            %(i.name_lower))
2546
2547         self.outfile.write('static gboolean\n'
2548                            '_%s_skeleton_handle_set_property (\n'
2549                            '  GDBusConnection *connection G_GNUC_UNUSED,\n'
2550                            '  const gchar *sender G_GNUC_UNUSED,\n'
2551                            '  const gchar *object_path G_GNUC_UNUSED,\n'
2552                            '  const gchar *interface_name G_GNUC_UNUSED,\n'
2553                            '  const gchar *property_name,\n'
2554                            '  GVariant *variant,\n'
2555                            '  GError **error,\n'
2556                            '  gpointer user_data)\n'
2557                            '{\n'
2558                            '  %sSkeleton *skeleton = %s%s_SKELETON (user_data);\n'
2559                            '  GValue value = G_VALUE_INIT;\n'
2560                            '  GParamSpec *pspec;\n'
2561                            '  _ExtendedGDBusPropertyInfo *info;\n'
2562                            '  gboolean ret;\n'
2563                            %(i.name_lower, i.camel_name, i.ns_upper, i.name_upper))
2564         self.outfile.write('  ret = FALSE;\n'
2565                            '  info = (_ExtendedGDBusPropertyInfo *) g_dbus_interface_info_lookup_property ((GDBusInterfaceInfo *) &_%s_interface_info.parent_struct, property_name);\n'
2566                            '  g_assert (info != NULL);\n'
2567                            '  pspec = g_object_class_find_property (G_OBJECT_GET_CLASS (skeleton), info->hyphen_name);\n'
2568                            '  if (pspec == NULL)\n'
2569                            '    {\n'
2570                            '      g_set_error (error, G_DBUS_ERROR, G_DBUS_ERROR_INVALID_ARGS, "No property with name %%s", property_name);\n'
2571                            '    }\n'
2572                            '  else\n'
2573                            '    {\n'
2574                            '      if (info->use_gvariant)\n'
2575                            '        g_value_set_variant (&value, variant);\n'
2576                            '      else\n'
2577                            '        g_dbus_gvariant_to_gvalue (variant, &value);\n'
2578                            '      g_object_set_property (G_OBJECT (skeleton), info->hyphen_name, &value);\n'
2579                            '      g_value_unset (&value);\n'
2580                            '      ret = TRUE;\n'
2581                            '    }\n'
2582                            '  return ret;\n'
2583                            '}\n'
2584                            '\n'
2585                            %(i.name_lower))
2586
2587
2588         self.outfile.write('static const GDBusInterfaceVTable _%s_skeleton_vtable =\n'
2589                            '{\n'
2590                            '  _%s_skeleton_handle_method_call,\n'
2591                            '  _%s_skeleton_handle_get_property,\n'
2592                            '  _%s_skeleton_handle_set_property,\n'
2593                            '  {NULL}\n'
2594                            '};\n'
2595                            '\n'%(i.name_lower, i.name_lower, i.name_lower, i.name_lower))
2596
2597         self.outfile.write('static GDBusInterfaceInfo *\n'
2598                            '%s_skeleton_dbus_interface_get_info (GDBusInterfaceSkeleton *skeleton G_GNUC_UNUSED)\n'
2599                            '{\n'
2600                            '  return %s_interface_info ();\n'
2601                            %(i.name_lower, i.name_lower))
2602         self.outfile.write('}\n'
2603                            '\n')
2604
2605         self.outfile.write('static GDBusInterfaceVTable *\n'
2606                            '%s_skeleton_dbus_interface_get_vtable (GDBusInterfaceSkeleton *skeleton G_GNUC_UNUSED)\n'
2607                            '{\n'
2608                            '  return (GDBusInterfaceVTable *) &_%s_skeleton_vtable;\n'
2609                            %(i.name_lower, i.name_lower))
2610         self.outfile.write('}\n'
2611                            '\n')
2612
2613         self.outfile.write('static GVariant *\n'
2614                            '%s_skeleton_dbus_interface_get_properties (GDBusInterfaceSkeleton *_skeleton)\n'
2615                            '{\n'
2616                            '  %sSkeleton *skeleton = %s%s_SKELETON (_skeleton);\n'
2617                            %(i.name_lower, i.camel_name, i.ns_upper, i.name_upper))
2618         self.outfile.write('\n'
2619                            '  GVariantBuilder builder;\n'
2620                            '  guint n;\n'
2621                            '  g_variant_builder_init (&builder, G_VARIANT_TYPE ("a{sv}"));\n'
2622                            '  if (_%s_interface_info.parent_struct.properties == NULL)\n'
2623                            '    goto out;\n'
2624                            '  for (n = 0; _%s_interface_info.parent_struct.properties[n] != NULL; n++)\n'
2625                            '    {\n'
2626                            '      GDBusPropertyInfo *info = _%s_interface_info.parent_struct.properties[n];\n'
2627                            '      if (info->flags & G_DBUS_PROPERTY_INFO_FLAGS_READABLE)\n'
2628                            '        {\n'
2629                            '          GVariant *value;\n'
2630                            '          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'
2631                            '          if (value != NULL)\n'
2632                            '            {\n'
2633                            '              g_variant_take_ref (value);\n'
2634                            '              g_variant_builder_add (&builder, "{sv}", info->name, value);\n'
2635                            '              g_variant_unref (value);\n'
2636                            '            }\n'
2637                            '        }\n'
2638                            '    }\n'
2639                            'out:\n'
2640                            '  return g_variant_builder_end (&builder);\n'
2641                            '}\n'
2642                            '\n'
2643                            %(i.name_lower, i.name_lower, i.name_lower, i.name_lower, i.name))
2644
2645         if len(i.properties) > 0:
2646             self.outfile.write('static gboolean _%s_emit_changed (gpointer user_data);\n'
2647                                '\n'
2648                                %(i.name_lower))
2649
2650         self.outfile.write('static void\n'
2651                            '%s_skeleton_dbus_interface_flush (GDBusInterfaceSkeleton *_skeleton)\n'
2652                            '{\n'
2653                            %(i.name_lower))
2654         if len(i.properties) > 0:
2655             self.outfile.write('  %sSkeleton *skeleton = %s%s_SKELETON (_skeleton);\n'
2656                                '  gboolean emit_changed = FALSE;\n'
2657                                '\n'
2658                                '  g_mutex_lock (&skeleton->priv->lock);\n'
2659                                '  if (skeleton->priv->changed_properties_idle_source != NULL)\n'
2660                                '    {\n'
2661                                '      g_source_destroy (skeleton->priv->changed_properties_idle_source);\n'
2662                                '      skeleton->priv->changed_properties_idle_source = NULL;\n'
2663                                '      emit_changed = TRUE;\n'
2664                                '    }\n'
2665                                '  g_mutex_unlock (&skeleton->priv->lock);\n'
2666                                '\n'
2667                                '  if (emit_changed)\n'
2668                                '    _%s_emit_changed (skeleton);\n'
2669                                %(i.camel_name, i.ns_upper, i.name_upper, i.name_lower))
2670         self.outfile.write('}\n'
2671                            '\n')
2672
2673         for s in i.signals:
2674             self.outfile.write('static void\n'
2675                                '_%s_on_signal_%s (\n'
2676                                '    %s *object'%(i.name_lower, s.name_lower, i.camel_name))
2677             for a in s.args:
2678                 self.outfile.write(',\n    %sarg_%s'%(a.ctype_in, a.name))
2679             self.outfile.write(')\n'
2680                                '{\n'
2681                                '  %sSkeleton *skeleton = %s%s_SKELETON (object);\n\n'
2682                                '  GList      *connections, *l;\n'
2683                                '  GVariant   *signal_variant;\n'
2684                                '  connections = g_dbus_interface_skeleton_get_connections (G_DBUS_INTERFACE_SKELETON (skeleton));\n'
2685                                %(i.camel_name, i.ns_upper, i.name_upper))
2686             self.outfile.write('\n'
2687                                '  signal_variant = g_variant_ref_sink (g_variant_new ("(')
2688             for a in s.args:
2689                 self.outfile.write('%s'%(a.format_in))
2690             self.outfile.write(')"')
2691             for a in s.args:
2692                 self.outfile.write(',\n                   arg_%s'%(a.name))
2693             self.outfile.write('));\n')
2694
2695             self.outfile.write('  for (l = connections; l != NULL; l = l->next)\n'
2696                                '    {\n'
2697                                '      GDBusConnection *connection = l->data;\n'
2698                                '      g_dbus_connection_emit_signal (connection,\n'
2699                                '        NULL, g_dbus_interface_skeleton_get_object_path (G_DBUS_INTERFACE_SKELETON (skeleton)), "%s", "%s",\n'
2700                                '        signal_variant, NULL);\n'
2701                                '    }\n'
2702                                %(i.name, s.name))
2703             self.outfile.write('  g_variant_unref (signal_variant);\n')
2704             self.outfile.write('  g_list_free_full (connections, g_object_unref);\n')
2705             self.outfile.write('}\n'
2706                                '\n')
2707
2708         self.outfile.write('static void %s_skeleton_iface_init (%sIface *iface);\n'
2709                            %(i.name_lower, i.camel_name))
2710
2711         self.outfile.write('#if GLIB_VERSION_MAX_ALLOWED >= GLIB_VERSION_2_38\n')
2712         self.outfile.write('G_DEFINE_TYPE_WITH_CODE (%sSkeleton, %s_skeleton, G_TYPE_DBUS_INTERFACE_SKELETON,\n'%(i.camel_name, i.name_lower))
2713         self.outfile.write('                         G_ADD_PRIVATE (%sSkeleton)\n'%(i.camel_name))
2714         self.outfile.write('                         G_IMPLEMENT_INTERFACE (%sTYPE_%s, %s_skeleton_iface_init))\n\n'%(i.ns_upper, i.name_upper, i.name_lower))
2715         self.outfile.write('#else\n')
2716         self.outfile.write('G_DEFINE_TYPE_WITH_CODE (%sSkeleton, %s_skeleton, G_TYPE_DBUS_INTERFACE_SKELETON,\n'%(i.camel_name, i.name_lower))
2717         self.outfile.write('                         G_IMPLEMENT_INTERFACE (%sTYPE_%s, %s_skeleton_iface_init))\n\n'%(i.ns_upper, i.name_upper, i.name_lower))
2718         self.outfile.write('#endif\n')
2719
2720         # finalize
2721         self.outfile.write('static void\n'
2722                            '%s_skeleton_finalize (GObject *object)\n'
2723                            '{\n'%(i.name_lower))
2724         self.outfile.write('  %sSkeleton *skeleton = %s%s_SKELETON (object);\n'%(i.camel_name, i.ns_upper, i.name_upper))
2725         if len(i.properties) > 0:
2726             self.outfile.write('  guint n;\n'
2727                                '  for (n = 0; n < %d; n++)\n'
2728                                '    g_value_unset (&skeleton->priv->properties[n]);\n'%(len(i.properties)))
2729             self.outfile.write('  g_free (skeleton->priv->properties);\n')
2730         self.outfile.write('  g_list_free_full (skeleton->priv->changed_properties, (GDestroyNotify) _changed_property_free);\n')
2731         self.outfile.write('  if (skeleton->priv->changed_properties_idle_source != NULL)\n')
2732         self.outfile.write('    g_source_destroy (skeleton->priv->changed_properties_idle_source);\n')
2733         self.outfile.write('  g_main_context_unref (skeleton->priv->context);\n')
2734         self.outfile.write('  g_mutex_clear (&skeleton->priv->lock);\n')
2735         self.outfile.write('  G_OBJECT_CLASS (%s_skeleton_parent_class)->finalize (object);\n'
2736                            '}\n'
2737                            '\n'%(i.name_lower))
2738
2739         # property accessors (TODO: generate PropertiesChanged signals in setter)
2740         if len(i.properties) > 0:
2741             self.outfile.write('static void\n'
2742                                '%s_skeleton_get_property (GObject      *object,\n'
2743                                '  guint         prop_id,\n'
2744                             '  GValue       *value,\n'
2745                             '  GParamSpec   *pspec G_GNUC_UNUSED)\n'
2746                             '{\n'%(i.name_lower))
2747             self.outfile.write('  %sSkeleton *skeleton = %s%s_SKELETON (object);\n'
2748                                '  g_assert (prop_id != 0 && prop_id - 1 < %d);\n'
2749                                '  g_mutex_lock (&skeleton->priv->lock);\n'
2750                                '  g_value_copy (&skeleton->priv->properties[prop_id - 1], value);\n'
2751                                '  g_mutex_unlock (&skeleton->priv->lock);\n'
2752                                %(i.camel_name, i.ns_upper, i.name_upper, len(i.properties)))
2753             self.outfile.write('}\n'
2754                                '\n')
2755
2756             # if property is already scheduled then re-use entry.. though it could be
2757             # that the user did
2758             #
2759             #  foo_set_prop_bar (object, "");
2760             #  foo_set_prop_bar (object, "blah");
2761             #
2762             # say, every update... In this case, where nothing happens, we obviously
2763             # don't want a PropertiesChanged() event. We can easily check for this
2764             # by comparing against the _original value_ recorded before the first
2765             # change event. If the latest value is not different from the original
2766             # one, we can simply ignore the ChangedProperty
2767             #
2768             self.outfile.write('static gboolean\n'
2769                                '_%s_emit_changed (gpointer user_data)\n'
2770                                '{\n'
2771                                '  %sSkeleton *skeleton = %s%s_SKELETON (user_data);\n'
2772                                %(i.name_lower, i.camel_name, i.ns_upper, i.name_upper))
2773             self.outfile.write('  GList *l;\n'
2774                                '  GVariantBuilder builder;\n'
2775                                '  GVariantBuilder invalidated_builder;\n'
2776                                '  guint num_changes;\n'
2777                                '\n'
2778                                '  g_mutex_lock (&skeleton->priv->lock);\n'
2779                                '  g_variant_builder_init (&builder, G_VARIANT_TYPE ("a{sv}"));\n'
2780                                '  g_variant_builder_init (&invalidated_builder, G_VARIANT_TYPE ("as"));\n'
2781                                '  for (l = skeleton->priv->changed_properties, num_changes = 0; l != NULL; l = l->next)\n'
2782                                '    {\n'
2783                                '      ChangedProperty *cp = l->data;\n'
2784                                '      GVariant *variant;\n'
2785                                '      const GValue *cur_value;\n'
2786                                '\n'
2787                                '      cur_value = &skeleton->priv->properties[cp->prop_id - 1];\n'
2788                                '      if (!_g_value_equal (cur_value, &cp->orig_value))\n'
2789                                '        {\n'
2790                                '          variant = g_dbus_gvalue_to_gvariant (cur_value, G_VARIANT_TYPE (cp->info->parent_struct.signature));\n'
2791                                '          g_variant_builder_add (&builder, "{sv}", cp->info->parent_struct.name, variant);\n'
2792                                '          g_variant_unref (variant);\n'
2793                                '          num_changes++;\n'
2794                                '        }\n'
2795                                '    }\n'
2796                                '  if (num_changes > 0)\n'
2797                                '    {\n'
2798                                '      GList *connections, *ll;\n'
2799                                '      GVariant *signal_variant;'
2800                                '\n'
2801                                '      signal_variant = g_variant_ref_sink (g_variant_new ("(sa{sv}as)", "%s",\n'
2802                                '                                           &builder, &invalidated_builder));\n'
2803                                '      connections = g_dbus_interface_skeleton_get_connections (G_DBUS_INTERFACE_SKELETON (skeleton));\n'
2804                                '      for (ll = connections; ll != NULL; ll = ll->next)\n'
2805                                '        {\n'
2806                                '          GDBusConnection *connection = ll->data;\n'
2807                                '\n'
2808                                '          g_dbus_connection_emit_signal (connection,\n'
2809                                '                                         NULL, g_dbus_interface_skeleton_get_object_path (G_DBUS_INTERFACE_SKELETON (skeleton)),\n'
2810                                '                                         "org.freedesktop.DBus.Properties",\n'
2811                                '                                         "PropertiesChanged",\n'
2812                                '                                         signal_variant,\n'
2813                                '                                         NULL);\n'
2814                                '        }\n'
2815                                '      g_variant_unref (signal_variant);\n'
2816                                '      g_list_free_full (connections, g_object_unref);\n'
2817                                '    }\n'
2818                                '  else\n'
2819                                '    {\n'
2820                                '      g_variant_builder_clear (&builder);\n'
2821                                '      g_variant_builder_clear (&invalidated_builder);\n'
2822                                '    }\n'
2823                                %(i.name))
2824             self.outfile.write('  g_list_free_full (skeleton->priv->changed_properties, (GDestroyNotify) _changed_property_free);\n')
2825             self.outfile.write('  skeleton->priv->changed_properties = NULL;\n')
2826             self.outfile.write('  skeleton->priv->changed_properties_idle_source = NULL;\n')
2827             self.outfile.write('  g_mutex_unlock (&skeleton->priv->lock);\n')
2828             self.outfile.write('  return FALSE;\n'
2829                                '}\n'
2830                                '\n')
2831             # holding lock while being called
2832             self.outfile.write('static void\n'
2833                                '_%s_schedule_emit_changed (%sSkeleton *skeleton, const _ExtendedGDBusPropertyInfo *info, guint prop_id, const GValue *orig_value)\n'
2834                                '{\n'
2835                                '  ChangedProperty *cp;\n'
2836                                '  GList *l;\n'
2837                                '  cp = NULL;\n'
2838                                '  for (l = skeleton->priv->changed_properties; l != NULL; l = l->next)\n'
2839                                '    {\n'
2840                                '      ChangedProperty *i_cp = l->data;\n'
2841                                '      if (i_cp->info == info)\n'
2842                                '        {\n'
2843                                '          cp = i_cp;\n'
2844                                '          break;\n'
2845                                '        }\n'
2846                                '    }\n'
2847                                %(i.name_lower, i.camel_name))
2848             self.outfile.write('  if (cp == NULL)\n'
2849                                '    {\n'
2850                                '      cp = g_new0 (ChangedProperty, 1);\n'
2851                                '      cp->prop_id = prop_id;\n'
2852                                '      cp->info = info;\n'
2853                                '      skeleton->priv->changed_properties = g_list_prepend (skeleton->priv->changed_properties, cp);\n'
2854                                '      g_value_init (&cp->orig_value, G_VALUE_TYPE (orig_value));\n'
2855                                '      g_value_copy (orig_value, &cp->orig_value);\n'
2856                                '    }\n'
2857                                '}\n'
2858                                '\n'
2859                                %())
2860
2861             # Postpone setting up the refresh source until the ::notify signal is emitted as
2862             # this allows use of g_object_freeze_notify()/g_object_thaw_notify() ...
2863             # This is useful when updating several properties from another thread than
2864             # where the idle will be emitted from
2865             self.outfile.write('static void\n'
2866                                '%s_skeleton_notify (GObject      *object,\n'
2867                                '  GParamSpec *pspec G_GNUC_UNUSED)\n'
2868                                '{\n'
2869                                '  %sSkeleton *skeleton = %s%s_SKELETON (object);\n'
2870                                '  g_mutex_lock (&skeleton->priv->lock);\n'
2871                                '  if (skeleton->priv->changed_properties != NULL &&\n'
2872                                '      skeleton->priv->changed_properties_idle_source == NULL)\n'
2873                                '    {\n'
2874                                '      skeleton->priv->changed_properties_idle_source = g_idle_source_new ();\n'
2875                                '      g_source_set_priority (skeleton->priv->changed_properties_idle_source, G_PRIORITY_DEFAULT);\n'
2876                                '      g_source_set_callback (skeleton->priv->changed_properties_idle_source, _%s_emit_changed, g_object_ref (skeleton), (GDestroyNotify) g_object_unref);\n'
2877                                '      g_source_set_name (skeleton->priv->changed_properties_idle_source, "[generated] _%s_emit_changed");\n'
2878                                '      g_source_attach (skeleton->priv->changed_properties_idle_source, skeleton->priv->context);\n'
2879                                '      g_source_unref (skeleton->priv->changed_properties_idle_source);\n'
2880                                '    }\n'
2881                                '  g_mutex_unlock (&skeleton->priv->lock);\n'
2882                                '}\n'
2883                                '\n'
2884                                %(i.name_lower, i.camel_name, i.ns_upper, i.name_upper, i.name_lower, i.name_lower))
2885
2886             self.outfile.write('static void\n'
2887                                '%s_skeleton_set_property (GObject      *object,\n'
2888                                '  guint         prop_id,\n'
2889                                '  const GValue *value,\n'
2890                                '  GParamSpec   *pspec)\n'
2891                                '{\n'%(i.name_lower))
2892             self.outfile.write('  %sSkeleton *skeleton = %s%s_SKELETON (object);\n'
2893                                '  g_assert (prop_id != 0 && prop_id - 1 < %d);\n'
2894                                '  g_mutex_lock (&skeleton->priv->lock);\n'
2895                                '  g_object_freeze_notify (object);\n'
2896                                '  if (!_g_value_equal (value, &skeleton->priv->properties[prop_id - 1]))\n'
2897                                '    {\n'
2898                                '      if (g_dbus_interface_skeleton_get_connection (G_DBUS_INTERFACE_SKELETON (skeleton)) != NULL)\n'
2899                                '        _%s_schedule_emit_changed (skeleton, (const _ExtendedGDBusPropertyInfo *) _%s_property_info_pointers[prop_id - 1], prop_id, &skeleton->priv->properties[prop_id - 1]);\n'
2900                                '      g_value_copy (value, &skeleton->priv->properties[prop_id - 1]);\n'
2901                                '      g_object_notify_by_pspec (object, pspec);\n'
2902                                '    }\n'
2903                                '  g_mutex_unlock (&skeleton->priv->lock);\n'
2904                                '  g_object_thaw_notify (object);\n'
2905                                %(i.camel_name, i.ns_upper, i.name_upper, len(i.properties), i.name_lower, i.name_lower))
2906             self.outfile.write('}\n'
2907                                '\n')
2908
2909         self.outfile.write('static void\n'
2910                            '%s_skeleton_init (%sSkeleton *skeleton)\n'
2911                            '{\n'
2912                            '#if GLIB_VERSION_MAX_ALLOWED >= GLIB_VERSION_2_38\n'
2913                            '  skeleton->priv = %s_skeleton_get_instance_private (skeleton);\n'
2914                            '#else\n'
2915                            '  skeleton->priv = G_TYPE_INSTANCE_GET_PRIVATE (skeleton, %sTYPE_%s_SKELETON, %sSkeletonPrivate);\n'
2916                            '#endif\n\n'
2917                            %(i.name_lower, i.camel_name,
2918                              i.name_lower,
2919                              i.ns_upper, i.name_upper, i.camel_name))
2920         self.outfile.write('  g_mutex_init (&skeleton->priv->lock);\n')
2921         self.outfile.write('  skeleton->priv->context = g_main_context_ref_thread_default ();\n')
2922         if len(i.properties) > 0:
2923             self.outfile.write('  skeleton->priv->properties = g_new0 (GValue, %d);\n'%(len(i.properties)))
2924             n = 0
2925             for p in i.properties:
2926                 self.outfile.write('  g_value_init (&skeleton->priv->properties[%d], %s);\n'%(n, p.arg.gtype))
2927                 n += 1
2928         self.outfile.write('}\n'
2929                            '\n')
2930
2931         # property vfuncs
2932         n = 0
2933         for p in i.properties:
2934             self.outfile.write('static %s\n'
2935                                '%s_skeleton_get_%s (%s *object)\n'
2936                                '{\n'
2937                                %(p.arg.ctype_in, i.name_lower, p.name_lower, i.camel_name))
2938             self.outfile.write('  %sSkeleton *skeleton = %s%s_SKELETON (object);\n'%(i.camel_name, i.ns_upper, i.name_upper))
2939             self.outfile.write('  %svalue;\n'
2940                                '  g_mutex_lock (&skeleton->priv->lock);\n'
2941                                '  value = %s (&(skeleton->priv->properties[%d]));\n'
2942                                '  g_mutex_unlock (&skeleton->priv->lock);\n'
2943                                %(p.arg.ctype_in_g, p.arg.gvalue_get, n))
2944             self.outfile.write('  return value;\n')
2945             self.outfile.write('}\n')
2946             self.outfile.write('\n')
2947             n += 1
2948
2949         self.outfile.write('static void\n'
2950                            '%s_skeleton_class_init (%sSkeletonClass *klass)\n'
2951                            '{\n'
2952                            '  GObjectClass *gobject_class;\n'
2953                            '  GDBusInterfaceSkeletonClass *skeleton_class;\n'
2954                            '\n'
2955                            '  gobject_class = G_OBJECT_CLASS (klass);\n'
2956                            '  gobject_class->finalize = %s_skeleton_finalize;\n'
2957                            %(i.name_lower, i.camel_name, i.name_lower))
2958         if len(i.properties) > 0:
2959             self.outfile.write('  gobject_class->get_property = %s_skeleton_get_property;\n'
2960                                '  gobject_class->set_property = %s_skeleton_set_property;\n'
2961                                '  gobject_class->notify       = %s_skeleton_notify;\n'
2962                                '\n'%(i.name_lower, i.name_lower, i.name_lower))
2963             self.outfile.write('\n'
2964                                '  %s_override_properties (gobject_class, 1);\n'%(i.name_lower))
2965         self.outfile.write('\n'
2966                            '  skeleton_class = G_DBUS_INTERFACE_SKELETON_CLASS (klass);\n');
2967         self.outfile.write('  skeleton_class->get_info = %s_skeleton_dbus_interface_get_info;\n'%(i.name_lower))
2968         self.outfile.write('  skeleton_class->get_properties = %s_skeleton_dbus_interface_get_properties;\n'%(i.name_lower))
2969         self.outfile.write('  skeleton_class->flush = %s_skeleton_dbus_interface_flush;\n'%(i.name_lower))
2970         self.outfile.write('  skeleton_class->get_vtable = %s_skeleton_dbus_interface_get_vtable;\n'%(i.name_lower))
2971
2972         self.outfile.write('\n'
2973                            '#if GLIB_VERSION_MAX_ALLOWED < GLIB_VERSION_2_38\n'
2974                            '  g_type_class_add_private (klass, sizeof (%sSkeletonPrivate));\n'
2975                            '#endif\n'%(i.camel_name))
2976
2977         self.outfile.write('}\n'
2978                            '\n')
2979
2980         self.outfile.write('static void\n'
2981                            '%s_skeleton_iface_init (%sIface *iface)\n'
2982                            '{\n'
2983                            %(i.name_lower, i.camel_name))
2984         for s in i.signals:
2985             self.outfile.write('  iface->%s = _%s_on_signal_%s;\n'
2986                                %(s.name_lower, i.name_lower, s.name_lower))
2987         for p in i.properties:
2988             self.outfile.write('  iface->get_%s = %s_skeleton_get_%s;\n'%(p.name_lower, i.name_lower, p.name_lower))
2989         self.outfile.write('}\n'
2990                            '\n')
2991
2992         # constructors
2993         self.outfile.write(self.docbook_gen.expand(
2994                 '/**\n'
2995                 ' * %s_skeleton_new:\n'
2996                 ' *\n'
2997                 ' * Creates a skeleton object for the D-Bus interface #%s.\n'
2998                 ' *\n'
2999                 ' * Returns: (transfer full) (type %sSkeleton): The skeleton object.\n'
3000                 %(i.name_lower, i.name, i.camel_name), False))
3001         self.write_gtkdoc_deprecated_and_since_and_close(i, self.outfile, 0)
3002         self.outfile.write('%s *\n'
3003                            '%s_skeleton_new (void)\n'
3004                            '{\n'
3005                            '  return %s%s (g_object_new (%sTYPE_%s_SKELETON, NULL));\n'
3006                            '}\n'
3007                            '\n'%(i.camel_name, i.name_lower, i.ns_upper, i.name_upper, i.ns_upper, i.name_upper))
3008
3009     # ---------------------------------------------------------------------------------------------------
3010
3011     def generate_object(self):
3012         self.outfile.write('/* ------------------------------------------------------------------------\n'
3013                            ' * Code for Object, ObjectProxy and ObjectSkeleton\n'
3014                            ' * ------------------------------------------------------------------------\n'
3015                            ' */\n'
3016                            '\n')
3017
3018         self.outfile.write(self.docbook_gen.expand(
3019                 '/**\n'
3020                 ' * SECTION:%sObject\n'
3021                 ' * @title: %sObject\n'
3022                 ' * @short_description: Specialized GDBusObject types\n'
3023                 ' *\n'
3024                 ' * 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'
3025                 ' */\n'
3026                 %(self.namespace, self.namespace, self.namespace, self.namespace, self.namespace), False))
3027         self.outfile.write('\n')
3028
3029         self.outfile.write(self.docbook_gen.expand(
3030                 '/**\n'
3031                 ' * %sObject:\n'
3032                 ' *\n'
3033                 ' * The #%sObject type is a specialized container of interfaces.\n'
3034                 ' */\n'
3035                 %(self.namespace, self.namespace), False))
3036         self.outfile.write('\n')
3037
3038         self.outfile.write(self.docbook_gen.expand(
3039                 '/**\n'
3040                 ' * %sObjectIface:\n'
3041                 ' * @parent_iface: The parent interface.\n'
3042                 ' *\n'
3043                 ' * Virtual table for the #%sObject interface.\n'
3044                 ' */\n'
3045                 %(self.namespace, self.namespace), False))
3046         self.outfile.write('\n')
3047
3048         self.outfile.write('typedef %sObjectIface %sObjectInterface;\n'%(self.namespace, self.namespace))
3049         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))
3050         self.outfile.write('\n')
3051         self.outfile.write('static void\n'
3052                            '%sobject_default_init (%sObjectIface *iface)\n'
3053                            '{\n'
3054                            %(self.ns_lower, self.namespace));
3055         for i in self.ifaces:
3056             self.outfile.write(self.docbook_gen.expand(
3057                     '  /**\n'
3058                     '   * %sObject:%s:\n'
3059                     '   *\n'
3060                     '   * The #%s instance corresponding to the D-Bus interface #%s, if any.\n'
3061                     '   *\n'
3062                     '   * Connect to the #GObject::notify signal to get informed of property changes.\n'
3063                     %(self.namespace, i.name_hyphen, i.camel_name, i.name), False))
3064             self.write_gtkdoc_deprecated_and_since_and_close(i, self.outfile, 2)
3065             self.outfile.write('  g_object_interface_install_property (iface, g_param_spec_object ("%s", "%s", "%s", %sTYPE_%s, G_PARAM_READWRITE|G_PARAM_STATIC_STRINGS));\n'
3066                                '\n'
3067                                %(i.name_hyphen, i.name_hyphen, i.name_hyphen, self.ns_upper, i.name_upper))
3068         self.outfile.write('}\n'
3069                            '\n')
3070
3071         for i in self.ifaces:
3072             self.outfile.write(self.docbook_gen.expand(
3073                     '/**\n'
3074                     ' * %sobject_get_%s:\n'
3075                     ' * @object: A #%sObject.\n'
3076                     ' *\n'
3077                     ' * Gets the #%s instance for the D-Bus interface #%s on @object, if any.\n'
3078                     ' *\n'
3079                     ' * Returns: (transfer full): A #%s that must be freed with g_object_unref() or %%NULL if @object does not implement the interface.\n'
3080                     %(self.ns_lower, i.name_upper.lower(), self.namespace, i.camel_name, i.name, i.camel_name), False))
3081             self.write_gtkdoc_deprecated_and_since_and_close(i, self.outfile, 0)
3082             self.outfile.write('%s *%sobject_get_%s (%sObject *object)\n'
3083                                %(i.camel_name, self.ns_lower, i.name_upper.lower(), self.namespace))
3084             self.outfile.write('{\n'
3085                                '  GDBusInterface *ret;\n'
3086                                '  ret = g_dbus_object_get_interface (G_DBUS_OBJECT (object), "%s");\n'
3087                                '  if (ret == NULL)\n'
3088                                '    return NULL;\n'
3089                                '  return %s%s (ret);\n'
3090                                '}\n'
3091                                '\n'
3092                                %(i.name, self.ns_upper, i.name_upper))
3093         self.outfile.write('\n')
3094         for i in self.ifaces:
3095             self.outfile.write(self.docbook_gen.expand(
3096                     '/**\n'
3097                     ' * %sobject_peek_%s: (skip)\n'
3098                     ' * @object: A #%sObject.\n'
3099                     ' *\n'
3100                     ' * Like %sobject_get_%s() but doesn\'t increase the reference count on the returned object.\n'
3101                     ' *\n'
3102                     ' * <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'
3103                     ' *\n'
3104                     ' * Returns: (transfer none): A #%s or %%NULL if @object does not implement the interface. Do not free the returned object, it is owned by @object.\n'
3105                     %(self.ns_lower, i.name_upper.lower(), self.namespace, self.ns_lower, i.name_upper.lower(), i.camel_name), False))
3106             self.write_gtkdoc_deprecated_and_since_and_close(i, self.outfile, 0)
3107             self.outfile.write('%s *%sobject_peek_%s (%sObject *object)\n'
3108                                %(i.camel_name, self.ns_lower, i.name_upper.lower(), self.namespace))
3109             self.outfile.write('{\n'
3110                                '  GDBusInterface *ret;\n'
3111                                '  ret = g_dbus_object_get_interface (G_DBUS_OBJECT (object), "%s");\n'
3112                                '  if (ret == NULL)\n'
3113                                '    return NULL;\n'
3114                                '  g_object_unref (ret);\n'
3115                                '  return %s%s (ret);\n'
3116                                '}\n'
3117                                '\n'
3118                                %(i.name, self.ns_upper, i.name_upper))
3119         self.outfile.write('\n')
3120         # shared by ObjectProxy and ObjectSkeleton classes
3121         self.outfile.write('static void\n'
3122                            '%sobject_notify (GDBusObject *object, GDBusInterface *interface)\n'
3123                            '{\n'
3124                            '  _ExtendedGDBusInterfaceInfo *info = (_ExtendedGDBusInterfaceInfo *) g_dbus_interface_get_info (interface);\n'
3125                            '  /* info can be NULL if the other end is using a D-Bus interface we don\'t know\n'
3126                            '   * anything about, for example old generated code in this process talking to\n'
3127                            '   * newer generated code in the other process. */\n'
3128                            '  if (info != NULL)\n'
3129                            '    g_object_notify (G_OBJECT (object), info->hyphen_name);\n'
3130                            '}\n'
3131                            '\n'
3132                            %(self.ns_lower))
3133
3134         self.outfile.write(self.docbook_gen.expand(
3135                 '/**\n'
3136                 ' * %sObjectProxy:\n'
3137                 ' *\n'
3138                 ' * The #%sObjectProxy structure contains only private data and should only be accessed using the provided API.\n'
3139                 %(self.namespace, self.namespace), False))
3140         self.outfile.write(' */\n')
3141         self.outfile.write('\n')
3142         self.outfile.write(self.docbook_gen.expand(
3143                 '/**\n'
3144                 ' * %sObjectProxyClass:\n'
3145                 ' * @parent_class: The parent class.\n'
3146                 ' *\n'
3147                 ' * Class structure for #%sObjectProxy.\n'
3148                 %(self.namespace, self.namespace), False))
3149         self.outfile.write(' */\n')
3150         self.outfile.write('\n')
3151         # class boilerplate
3152         self.outfile.write('static void\n'
3153                            '%sobject_proxy__%sobject_iface_init (%sObjectIface *iface G_GNUC_UNUSED)\n'
3154                            '{\n'
3155                            '}\n'
3156                            '\n'
3157                            %(self.ns_lower, self.ns_lower, self.namespace))
3158         self.outfile.write('static void\n'
3159                            '%sobject_proxy__g_dbus_object_iface_init (GDBusObjectIface *iface)\n'
3160                            '{\n'
3161                            '  iface->interface_added = %sobject_notify;\n'
3162                            '  iface->interface_removed = %sobject_notify;\n'
3163                            '}\n'
3164                            '\n'
3165                            %(self.ns_lower, self.ns_lower, self.ns_lower))
3166         self.outfile.write('\n')
3167         self.outfile.write('G_DEFINE_TYPE_WITH_CODE (%sObjectProxy, %sobject_proxy, G_TYPE_DBUS_OBJECT_PROXY,\n'
3168                            '                         G_IMPLEMENT_INTERFACE (%sTYPE_OBJECT, %sobject_proxy__%sobject_iface_init)\n'
3169                            '                         G_IMPLEMENT_INTERFACE (G_TYPE_DBUS_OBJECT, %sobject_proxy__g_dbus_object_iface_init))\n'
3170                            '\n'
3171                            %(self.namespace, self.ns_lower, self.ns_upper, self.ns_lower, self.ns_lower, self.ns_lower))
3172         # class boilerplate
3173         self.outfile.write('static void\n'
3174                            '%sobject_proxy_init (%sObjectProxy *object G_GNUC_UNUSED)\n'
3175                            '{\n'
3176                            '}\n'
3177                            '\n'%(self.ns_lower, self.namespace))
3178         self.outfile.write('static void\n'
3179                            '%sobject_proxy_set_property (GObject      *gobject,\n'
3180                            '  guint         prop_id,\n'
3181                            '  const GValue *value G_GNUC_UNUSED,\n'
3182                            '  GParamSpec   *pspec)\n'
3183                            '{\n'
3184                            '  G_OBJECT_WARN_INVALID_PROPERTY_ID (gobject, prop_id, pspec);\n'
3185                            %(self.ns_lower))
3186         self.outfile.write('}\n'
3187                            '\n'%())
3188         self.outfile.write('static void\n'
3189                            '%sobject_proxy_get_property (GObject      *gobject,\n'
3190                            '  guint         prop_id,\n'
3191                            '  GValue       *value,\n'
3192                            '  GParamSpec   *pspec)\n'
3193                            '{\n'
3194                            '  %sObjectProxy *object = %sOBJECT_PROXY (gobject);\n'
3195                            '  GDBusInterface *interface;\n'
3196                            '\n'
3197                            '  switch (prop_id)\n'
3198                            '    {\n'
3199                            %(self.ns_lower, self.namespace, self.ns_upper))
3200         n = 1
3201         for i in self.ifaces:
3202             self.outfile.write('    case %d:\n'
3203                                '      interface = g_dbus_object_get_interface (G_DBUS_OBJECT (object), "%s");\n'
3204                                '      g_value_take_object (value, interface);\n'
3205                                '      break;\n'
3206                                '\n'
3207                                %(n, i.name))
3208             n += 1
3209         self.outfile.write('    default:\n'
3210                            '      G_OBJECT_WARN_INVALID_PROPERTY_ID (gobject, prop_id, pspec);\n'
3211                            '      break;\n'
3212                            '  }\n'
3213                            '}\n'
3214                            '\n'%())
3215         self.outfile.write('static void\n'
3216                            '%sobject_proxy_class_init (%sObjectProxyClass *klass)\n'
3217                            '{\n'
3218                            '  GObjectClass *gobject_class = G_OBJECT_CLASS (klass);\n'
3219                            '\n'
3220                            '  gobject_class->set_property = %sobject_proxy_set_property;\n'
3221                            '  gobject_class->get_property = %sobject_proxy_get_property;\n'
3222                            '\n'
3223                            %(self.ns_lower, self.namespace, self.ns_lower, self.ns_lower))
3224         n = 1
3225         for i in self.ifaces:
3226             self.outfile.write('  g_object_class_override_property (gobject_class, %d, "%s");'
3227                                '\n'
3228                                %(n, i.name_hyphen))
3229             n += 1
3230         self.outfile.write('}\n'
3231                            '\n')
3232
3233         self.outfile.write(self.docbook_gen.expand(
3234                 '/**\n'
3235                 ' * %sobject_proxy_new:\n'
3236                 ' * @connection: A #GDBusConnection.\n'
3237                 ' * @object_path: An object path.\n'
3238                 ' *\n'
3239                 ' * Creates a new proxy object.\n'
3240                 ' *\n'
3241                 ' * Returns: (transfer full): The proxy object.\n'
3242                 ' */\n'
3243                 %(self.ns_lower), False))
3244         self.outfile.write('%sObjectProxy *\n'
3245                      '%sobject_proxy_new (GDBusConnection *connection,\n'
3246                      '  const gchar *object_path)\n'
3247                      '{\n'
3248                      '  g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), NULL);\n'
3249                      '  g_return_val_if_fail (g_variant_is_object_path (object_path), NULL);\n'
3250                      '  return %sOBJECT_PROXY (g_object_new (%sTYPE_OBJECT_PROXY, "g-connection", connection, "g-object-path", object_path, NULL));\n'
3251                      '}\n'
3252                      '\n'%(self.namespace, self.ns_lower, self.ns_upper, self.ns_upper))
3253
3254         self.outfile.write(self.docbook_gen.expand(
3255                 '/**\n'
3256                 ' * %sObjectSkeleton:\n'
3257                 ' *\n'
3258                 ' * The #%sObjectSkeleton structure contains only private data and should only be accessed using the provided API.\n'
3259                 %(self.namespace, self.namespace), False))
3260         self.outfile.write(' */\n')
3261         self.outfile.write('\n')
3262         self.outfile.write(self.docbook_gen.expand(
3263                 '/**\n'
3264                 ' * %sObjectSkeletonClass:\n'
3265                 ' * @parent_class: The parent class.\n'
3266                 ' *\n'
3267                 ' * Class structure for #%sObjectSkeleton.\n'
3268                 %(self.namespace, self.namespace), False))
3269         self.outfile.write(' */\n')
3270         self.outfile.write('\n')
3271         # class boilerplate
3272         self.outfile.write('static void\n'
3273                            '%sobject_skeleton__%sobject_iface_init (%sObjectIface *iface G_GNUC_UNUSED)\n'
3274                            '{\n'
3275                            '}\n'
3276                            '\n'
3277                            %(self.ns_lower, self.ns_lower, self.namespace))
3278         self.outfile.write('\n')
3279         self.outfile.write('static void\n'
3280                            '%sobject_skeleton__g_dbus_object_iface_init (GDBusObjectIface *iface)\n'
3281                            '{\n'
3282                            '  iface->interface_added = %sobject_notify;\n'
3283                            '  iface->interface_removed = %sobject_notify;\n'
3284                            '}\n'
3285                            '\n'
3286                            %(self.ns_lower, self.ns_lower, self.ns_lower))
3287         self.outfile.write('G_DEFINE_TYPE_WITH_CODE (%sObjectSkeleton, %sobject_skeleton, G_TYPE_DBUS_OBJECT_SKELETON,\n'
3288                            '                         G_IMPLEMENT_INTERFACE (%sTYPE_OBJECT, %sobject_skeleton__%sobject_iface_init)\n'
3289                            '                         G_IMPLEMENT_INTERFACE (G_TYPE_DBUS_OBJECT, %sobject_skeleton__g_dbus_object_iface_init))\n'
3290                            '\n'
3291                            %(self.namespace, self.ns_lower, self.ns_upper, self.ns_lower, self.ns_lower, self.ns_lower))
3292         # class boilerplate
3293         self.outfile.write('static void\n'
3294                            '%sobject_skeleton_init (%sObjectSkeleton *object G_GNUC_UNUSED)\n'
3295                            '{\n'
3296                            '}\n'
3297                            '\n'%(self.ns_lower, self.namespace))
3298         self.outfile.write('static void\n'
3299                            '%sobject_skeleton_set_property (GObject      *gobject,\n'
3300                            '  guint         prop_id,\n'
3301                            '  const GValue *value,\n'
3302                            '  GParamSpec   *pspec)\n'
3303                            '{\n'
3304                            '  %sObjectSkeleton *object = %sOBJECT_SKELETON (gobject);\n'
3305                            '  GDBusInterfaceSkeleton *interface;\n'
3306                            '\n'
3307                            '  switch (prop_id)\n'
3308                            '    {\n'
3309                            %(self.ns_lower, self.namespace, self.ns_upper))
3310         n = 1
3311         for i in self.ifaces:
3312             self.outfile.write('    case %d:\n'
3313                                '      interface = g_value_get_object (value);\n'
3314                                '      if (interface != NULL)\n'
3315                                '        {\n'
3316                                '          g_warn_if_fail (%sIS_%s (interface));\n'
3317                                '          g_dbus_object_skeleton_add_interface (G_DBUS_OBJECT_SKELETON (object), interface);\n'
3318                                '        }\n'
3319                                '      else\n'
3320                                '        {\n'
3321                                '          g_dbus_object_skeleton_remove_interface_by_name (G_DBUS_OBJECT_SKELETON (object), "%s");\n'
3322                                '        }\n'
3323                                '      break;\n'
3324                                '\n'
3325                                %(n, self.ns_upper, i.name_upper, i.name))
3326             n += 1
3327         self.outfile.write('    default:\n'
3328                      '      G_OBJECT_WARN_INVALID_PROPERTY_ID (gobject, prop_id, pspec);\n'
3329                      '      break;\n'
3330                      '  }\n'
3331                      '}\n'
3332                      '\n'%())
3333         self.outfile.write('static void\n'
3334                            '%sobject_skeleton_get_property (GObject      *gobject,\n'
3335                            '  guint         prop_id,\n'
3336                            '  GValue       *value,\n'
3337                            '  GParamSpec   *pspec)\n'
3338                            '{\n'
3339                            '  %sObjectSkeleton *object = %sOBJECT_SKELETON (gobject);\n'
3340                            '  GDBusInterface *interface;\n'
3341                            '\n'
3342                            '  switch (prop_id)\n'
3343                            '    {\n'
3344                            %(self.ns_lower, self.namespace, self.ns_upper))
3345         n = 1
3346         for i in self.ifaces:
3347             self.outfile.write('    case %d:\n'
3348                                '      interface = g_dbus_object_get_interface (G_DBUS_OBJECT (object), "%s");\n'
3349                                '      g_value_take_object (value, interface);\n'
3350                                '      break;\n'
3351                                '\n'
3352                                %(n, i.name))
3353             n += 1
3354         self.outfile.write('    default:\n'
3355                            '      G_OBJECT_WARN_INVALID_PROPERTY_ID (gobject, prop_id, pspec);\n'
3356                            '      break;\n'
3357                            '  }\n'
3358                            '}\n'
3359                            '\n'%())
3360         self.outfile.write('static void\n'
3361                            '%sobject_skeleton_class_init (%sObjectSkeletonClass *klass)\n'
3362                            '{\n'
3363                            '  GObjectClass *gobject_class = G_OBJECT_CLASS (klass);\n'
3364                            '\n'
3365                            '  gobject_class->set_property = %sobject_skeleton_set_property;\n'
3366                            '  gobject_class->get_property = %sobject_skeleton_get_property;\n'
3367                            '\n'
3368                            %(self.ns_lower, self.namespace, self.ns_lower, self.ns_lower))
3369         n = 1
3370         for i in self.ifaces:
3371             self.outfile.write('  g_object_class_override_property (gobject_class, %d, "%s");'
3372                                '\n'
3373                                %(n, i.name_hyphen))
3374             n += 1
3375         self.outfile.write('}\n'
3376                            '\n')
3377         self.outfile.write(self.docbook_gen.expand(
3378                 '/**\n'
3379                 ' * %sobject_skeleton_new:\n'
3380                 ' * @object_path: An object path.\n'
3381                 ' *\n'
3382                 ' * Creates a new skeleton object.\n'
3383                 ' *\n'
3384                 ' * Returns: (transfer full): The skeleton object.\n'
3385                 ' */\n'
3386                 %(self.ns_lower), False))
3387         self.outfile.write('%sObjectSkeleton *\n'
3388                            '%sobject_skeleton_new (const gchar *object_path)\n'
3389                            '{\n'
3390                            '  g_return_val_if_fail (g_variant_is_object_path (object_path), NULL);\n'
3391                            '  return %sOBJECT_SKELETON (g_object_new (%sTYPE_OBJECT_SKELETON, "g-object-path", object_path, NULL));\n'
3392                            '}\n'
3393                            '\n'%(self.namespace, self.ns_lower, self.ns_upper, self.ns_upper))
3394         for i in self.ifaces:
3395             self.outfile.write(self.docbook_gen.expand(
3396                     '/**\n'
3397                     ' * %sobject_skeleton_set_%s:\n'
3398                     ' * @object: A #%sObjectSkeleton.\n'
3399                     ' * @interface_: (nullable): A #%s or %%NULL to clear the interface.\n'
3400                     ' *\n'
3401                     ' * Sets the #%s instance for the D-Bus interface #%s on @object.\n'
3402                     %(self.ns_lower, i.name_upper.lower(), self.namespace, i.camel_name, i.camel_name, i.name), False))
3403             self.write_gtkdoc_deprecated_and_since_and_close(i, self.outfile, 0)
3404             self.outfile.write('void %sobject_skeleton_set_%s (%sObjectSkeleton *object, %s *interface_)\n'
3405                                %(self.ns_lower, i.name_upper.lower(), self.namespace, i.camel_name))
3406             self.outfile.write('{\n'
3407                                '  g_object_set (G_OBJECT (object), "%s", interface_, NULL);\n'
3408                                '}\n'
3409                                '\n'
3410                                %(i.name_hyphen))
3411         self.outfile.write('\n')
3412
3413
3414     def generate_object_manager_client(self):
3415         self.outfile.write('/* ------------------------------------------------------------------------\n'
3416                            ' * Code for ObjectManager client\n'
3417                            ' * ------------------------------------------------------------------------\n'
3418                            ' */\n'
3419                            '\n')
3420
3421         self.outfile.write(self.docbook_gen.expand(
3422                 '/**\n'
3423                 ' * SECTION:%sObjectManagerClient\n'
3424                 ' * @title: %sObjectManagerClient\n'
3425                 ' * @short_description: Generated GDBusObjectManagerClient type\n'
3426                 ' *\n'
3427                 ' * This section contains a #GDBusObjectManagerClient that uses %sobject_manager_client_get_proxy_type() as the #GDBusProxyTypeFunc.\n'
3428                 ' */\n'
3429                 %(self.namespace, self.namespace, self.ns_lower), False))
3430         self.outfile.write('\n')
3431
3432         self.outfile.write(self.docbook_gen.expand(
3433                 '/**\n'
3434                 ' * %sObjectManagerClient:\n'
3435                 ' *\n'
3436                 ' * The #%sObjectManagerClient structure contains only private data and should only be accessed using the provided API.\n'
3437                 %(self.namespace, self.namespace), False))
3438         self.outfile.write(' */\n')
3439         self.outfile.write('\n')
3440
3441         self.outfile.write(self.docbook_gen.expand(
3442                 '/**\n'
3443                 ' * %sObjectManagerClientClass:\n'
3444                 ' * @parent_class: The parent class.\n'
3445                 ' *\n'
3446                 ' * Class structure for #%sObjectManagerClient.\n'
3447                 %(self.namespace, self.namespace), False))
3448         self.outfile.write(' */\n')
3449         self.outfile.write('\n')
3450
3451         # class boilerplate
3452         self.outfile.write('G_DEFINE_TYPE (%sObjectManagerClient, %sobject_manager_client, G_TYPE_DBUS_OBJECT_MANAGER_CLIENT)\n'
3453                            '\n'
3454                            %(self.namespace, self.ns_lower))
3455
3456         # class boilerplate
3457         self.outfile.write('static void\n'
3458                            '%sobject_manager_client_init (%sObjectManagerClient *manager G_GNUC_UNUSED)\n'
3459                            '{\n'
3460                            '}\n'
3461                            '\n'%(self.ns_lower, self.namespace))
3462         self.outfile.write('static void\n'
3463                            '%sobject_manager_client_class_init (%sObjectManagerClientClass *klass G_GNUC_UNUSED)\n'
3464                            '{\n'
3465                            '}\n'
3466                            '\n'%(self.ns_lower, self.namespace))
3467
3468         self.outfile.write(self.docbook_gen.expand(
3469                 '/**\n'
3470                 ' * %sobject_manager_client_get_proxy_type:\n'
3471                 ' * @manager: A #GDBusObjectManagerClient.\n'
3472                 ' * @object_path: The object path of the remote object (unused).\n'
3473                 ' * @interface_name: (nullable): Interface name of the remote object or %%NULL to get the object proxy #GType.\n'
3474                 ' * @user_data: User data (unused).\n'
3475                 ' *\n'
3476                 ' * A #GDBusProxyTypeFunc that maps @interface_name to the generated #GDBusObjectProxy derived and #GDBusProxy derived types.\n'
3477                 ' *\n'
3478                 ' * Returns: A #GDBusProxy derived #GType if @interface_name is not %%NULL, otherwise the #GType for #%sObjectProxy.\n'
3479                 %(self.ns_lower, self.namespace), False))
3480         self.outfile.write(' */\n')
3481         self.outfile.write('GType\n'
3482                            '%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'
3483                            '{\n'
3484                            %(self.ns_lower))
3485         self.outfile.write('  static gsize once_init_value = 0;\n'
3486                            '  static GHashTable *lookup_hash;\n'
3487                            '  GType ret;\n'
3488                            '\n'
3489                            '  if (interface_name == NULL)\n'
3490                            '    return %sTYPE_OBJECT_PROXY;\n'
3491                            '  if (g_once_init_enter (&once_init_value))\n'
3492                            '    {\n'
3493                            '      lookup_hash = g_hash_table_new (g_str_hash, g_str_equal);\n'
3494                            %(self.ns_upper))
3495         for i in self.ifaces:
3496             self.outfile.write('      g_hash_table_insert (lookup_hash, (gpointer) "%s", GSIZE_TO_POINTER (%sTYPE_%s_PROXY));\n'
3497                                %(i.name, i.ns_upper, i.name_upper))
3498         self.outfile.write('      g_once_init_leave (&once_init_value, 1);\n'
3499                            '    }\n')
3500         self.outfile.write('  ret = (GType) GPOINTER_TO_SIZE (g_hash_table_lookup (lookup_hash, interface_name));\n'
3501                            '  if (ret == (GType) 0)\n'
3502                            '    ret = G_TYPE_DBUS_PROXY;\n')
3503         self.outfile.write('  return ret;\n'
3504                            '}\n'
3505                            '\n')
3506
3507         # constructors
3508         self.outfile.write(self.docbook_gen.expand(
3509                 '/**\n'
3510                 ' * %sobject_manager_client_new:\n'
3511                 ' * @connection: A #GDBusConnection.\n'
3512                 ' * @flags: Flags from the #GDBusObjectManagerClientFlags enumeration.\n'
3513                 ' * @name: (nullable): A bus name (well-known or unique) or %%NULL if @connection is not a message bus connection.\n'
3514                 ' * @object_path: An object path.\n'
3515                 ' * @cancellable: (nullable): A #GCancellable or %%NULL.\n'
3516                 ' * @callback: A #GAsyncReadyCallback to call when the request is satisfied.\n'
3517                 ' * @user_data: User data to pass to @callback.\n'
3518                 ' *\n'
3519                 ' * Asynchronously creates #GDBusObjectManagerClient using %sobject_manager_client_get_proxy_type() as the #GDBusProxyTypeFunc. See g_dbus_object_manager_client_new() for more details.\n'
3520                 ' *\n'
3521                 ' * 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'
3522                 ' * You can then call %sobject_manager_client_new_finish() to get the result of the operation.\n'
3523                 ' *\n'
3524                 ' * See %sobject_manager_client_new_sync() for the synchronous, blocking version of this constructor.\n'
3525                 %(self.ns_lower, self.ns_lower, self.ns_lower, self.ns_lower), False))
3526         self.outfile.write(' */\n')
3527         self.outfile.write('void\n'
3528                            '%sobject_manager_client_new (\n'
3529                            '    GDBusConnection        *connection,\n'
3530                            '    GDBusObjectManagerClientFlags  flags,\n'
3531                            '    const gchar            *name,\n'
3532                            '    const gchar            *object_path,\n'
3533                            '    GCancellable           *cancellable,\n'
3534                            '    GAsyncReadyCallback     callback,\n'
3535                            '    gpointer                user_data)\n'
3536                            '{\n'
3537                            '  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'
3538                            '}\n'
3539                            '\n'
3540                            %(self.ns_lower, self.ns_upper, self.ns_lower))
3541         self.outfile.write('/**\n'
3542                            ' * %sobject_manager_client_new_finish:\n'
3543                            ' * @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to %sobject_manager_client_new().\n'
3544                            ' * @error: Return location for error or %%NULL\n'
3545                            ' *\n'
3546                            ' * Finishes an operation started with %sobject_manager_client_new().\n'
3547                            ' *\n'
3548                            ' * Returns: (transfer full) (type %sObjectManagerClient): The constructed object manager client or %%NULL if @error is set.\n'
3549                            %(self.ns_lower, self.ns_lower, self.ns_lower, self.namespace))
3550         self.outfile.write(' */\n')
3551         self.outfile.write('GDBusObjectManager *\n'
3552                            '%sobject_manager_client_new_finish (\n'
3553                            '    GAsyncResult        *res,\n'
3554                            '    GError             **error)\n'
3555                            '{\n'
3556                            '  GObject *ret;\n'
3557                            '  GObject *source_object;\n'
3558                            '  source_object = g_async_result_get_source_object (res);\n'
3559                            '  ret = g_async_initable_new_finish (G_ASYNC_INITABLE (source_object), res, error);\n'
3560                            '  g_object_unref (source_object);\n'
3561                            '  if (ret != NULL)\n'
3562                            '    return G_DBUS_OBJECT_MANAGER (ret);\n'
3563                            '  else\n'
3564                            '    return NULL;\n'
3565                            '}\n'
3566                            '\n'
3567                            %(self.ns_lower))
3568         self.outfile.write(self.docbook_gen.expand(
3569                 '/**\n'
3570                 ' * %sobject_manager_client_new_sync:\n'
3571                 ' * @connection: A #GDBusConnection.\n'
3572                 ' * @flags: Flags from the #GDBusObjectManagerClientFlags enumeration.\n'
3573                 ' * @name: (nullable): A bus name (well-known or unique) or %%NULL if @connection is not a message bus connection.\n'
3574                 ' * @object_path: An object path.\n'
3575                 ' * @cancellable: (nullable): A #GCancellable or %%NULL.\n'
3576                 ' * @error: Return location for error or %%NULL\n'
3577                 ' *\n'
3578                 ' * 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'
3579                 ' *\n'
3580                 ' * The calling thread is blocked until a reply is received.\n'
3581                 ' *\n'
3582                 ' * See %sobject_manager_client_new() for the asynchronous version of this constructor.\n'
3583                 ' *\n'
3584                 ' * Returns: (transfer full) (type %sObjectManagerClient): The constructed object manager client or %%NULL if @error is set.\n'
3585                 %(self.ns_lower, self.ns_lower, self.ns_lower, self.namespace), False))
3586         self.outfile.write(' */\n')
3587         self.outfile.write('GDBusObjectManager *\n'
3588                            '%sobject_manager_client_new_sync (\n'
3589                            '    GDBusConnection        *connection,\n'
3590                            '    GDBusObjectManagerClientFlags  flags,\n'
3591                            '    const gchar            *name,\n'
3592                            '    const gchar            *object_path,\n'
3593                            '    GCancellable           *cancellable,\n'
3594                            '    GError                **error)\n'
3595                            '{\n'
3596                            '  GInitable *ret;\n'
3597                            '  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'
3598                            '  if (ret != NULL)\n'
3599                            '    return G_DBUS_OBJECT_MANAGER (ret);\n'
3600                            '  else\n'
3601                            '    return NULL;\n'
3602                            '}\n'
3603                            '\n'
3604                            %(self.ns_lower, self.ns_upper, self.ns_lower))
3605         self.outfile.write('\n')
3606         self.outfile.write(self.docbook_gen.expand(
3607                 '/**\n'
3608                 ' * %sobject_manager_client_new_for_bus:\n'
3609                 ' * @bus_type: A #GBusType.\n'
3610                 ' * @flags: Flags from the #GDBusObjectManagerClientFlags enumeration.\n'
3611                 ' * @name: A bus name (well-known or unique).\n'
3612                 ' * @object_path: An object path.\n'
3613                 ' * @cancellable: (nullable): A #GCancellable or %%NULL.\n'
3614                 ' * @callback: A #GAsyncReadyCallback to call when the request is satisfied.\n'
3615                 ' * @user_data: User data to pass to @callback.\n'
3616                 ' *\n'
3617                 ' * Like %sobject_manager_client_new() but takes a #GBusType instead of a #GDBusConnection.\n'
3618                 ' *\n'
3619                 ' * 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'
3620                 ' * You can then call %sobject_manager_client_new_for_bus_finish() to get the result of the operation.\n'
3621                 ' *\n'
3622                 ' * See %sobject_manager_client_new_for_bus_sync() for the synchronous, blocking version of this constructor.\n'
3623                 %(self.ns_lower, self.ns_lower, self.ns_lower, self.ns_lower), False))
3624         self.outfile.write(' */\n')
3625         self.outfile.write('void\n'
3626                            '%sobject_manager_client_new_for_bus (\n'
3627                            '    GBusType                bus_type,\n'
3628                            '    GDBusObjectManagerClientFlags  flags,\n'
3629                            '    const gchar            *name,\n'
3630                            '    const gchar            *object_path,\n'
3631                            '    GCancellable           *cancellable,\n'
3632                            '    GAsyncReadyCallback     callback,\n'
3633                            '    gpointer                user_data)\n'
3634                            '{\n'
3635                            '  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'
3636                            '}\n'
3637                            '\n'
3638                            %(self.ns_lower, self.ns_upper, self.ns_lower))
3639         self.outfile.write('/**\n'
3640                            ' * %sobject_manager_client_new_for_bus_finish:\n'
3641                            ' * @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to %sobject_manager_client_new_for_bus().\n'
3642                            ' * @error: Return location for error or %%NULL\n'
3643                            ' *\n'
3644                            ' * Finishes an operation started with %sobject_manager_client_new_for_bus().\n'
3645                            ' *\n'
3646                            ' * Returns: (transfer full) (type %sObjectManagerClient): The constructed object manager client or %%NULL if @error is set.\n'
3647                            %(self.ns_lower, self.ns_lower, self.ns_lower, self.namespace))
3648         self.outfile.write(' */\n')
3649         self.outfile.write('GDBusObjectManager *\n'
3650                            '%sobject_manager_client_new_for_bus_finish (\n'
3651                            '    GAsyncResult        *res,\n'
3652                            '    GError             **error)\n'
3653                            '{\n'
3654                            '  GObject *ret;\n'
3655                            '  GObject *source_object;\n'
3656                            '  source_object = g_async_result_get_source_object (res);\n'
3657                            '  ret = g_async_initable_new_finish (G_ASYNC_INITABLE (source_object), res, error);\n'
3658                            '  g_object_unref (source_object);\n'
3659                            '  if (ret != NULL)\n'
3660                            '    return G_DBUS_OBJECT_MANAGER (ret);\n'
3661                            '  else\n'
3662                            '    return NULL;\n'
3663                            '}\n'
3664                            '\n'
3665                            %(self.ns_lower))
3666         self.outfile.write(self.docbook_gen.expand(
3667                 '/**\n'
3668                 ' * %sobject_manager_client_new_for_bus_sync:\n'
3669                 ' * @bus_type: A #GBusType.\n'
3670                 ' * @flags: Flags from the #GDBusObjectManagerClientFlags enumeration.\n'
3671                 ' * @name: A bus name (well-known or unique).\n'
3672                 ' * @object_path: An object path.\n'
3673                 ' * @cancellable: (nullable): A #GCancellable or %%NULL.\n'
3674                 ' * @error: Return location for error or %%NULL\n'
3675                 ' *\n'
3676                 ' * Like %sobject_manager_client_new_sync() but takes a #GBusType instead of a #GDBusConnection.\n'
3677                 ' *\n'
3678                 ' * The calling thread is blocked until a reply is received.\n'
3679                 ' *\n'
3680                 ' * See %sobject_manager_client_new_for_bus() for the asynchronous version of this constructor.\n'
3681                 ' *\n'
3682                 ' * Returns: (transfer full) (type %sObjectManagerClient): The constructed object manager client or %%NULL if @error is set.\n'
3683                 %(self.ns_lower, self.ns_lower, self.ns_lower, self.namespace), False))
3684         self.outfile.write(' */\n')
3685         self.outfile.write('GDBusObjectManager *\n'
3686                            '%sobject_manager_client_new_for_bus_sync (\n'
3687                            '    GBusType                bus_type,\n'
3688                            '    GDBusObjectManagerClientFlags  flags,\n'
3689                            '    const gchar            *name,\n'
3690                            '    const gchar            *object_path,\n'
3691                            '    GCancellable           *cancellable,\n'
3692                            '    GError                **error)\n'
3693                            '{\n'
3694                            '  GInitable *ret;\n'
3695                            '  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'
3696                            '  if (ret != NULL)\n'
3697                            '    return G_DBUS_OBJECT_MANAGER (ret);\n'
3698                            '  else\n'
3699                            '    return NULL;\n'
3700                            '}\n'
3701                            '\n'
3702                            %(self.ns_lower, self.ns_upper, self.ns_lower))
3703         self.outfile.write('\n')
3704
3705     # ---------------------------------------------------------------------------------------------------
3706
3707     def write_gtkdoc_deprecated_and_since_and_close(self, obj, f, indent):
3708         if len(obj.since) > 0:
3709             f.write('%*s *\n'
3710                     '%*s * Since: %s\n'
3711                     %(indent, '', indent, '', obj.since))
3712         if obj.deprecated:
3713             if isinstance(obj, dbustypes.Interface):
3714                 thing = 'The D-Bus interface'
3715             elif isinstance(obj, dbustypes.Method):
3716                 thing = 'The D-Bus method'
3717             elif isinstance(obj, dbustypes.Signal):
3718                 thing = 'The D-Bus signal'
3719             elif isinstance(obj, dbustypes.Property):
3720                 thing = 'The D-Bus property'
3721             else:
3722                 print_error('Cannot handle object "{}"'.format(obj))
3723             f.write(self.docbook_gen.expand(
3724                     '%*s *\n'
3725                     '%*s * Deprecated: %s has been deprecated.\n'
3726                     %(indent, '', indent, '', thing), False))
3727         f.write('%*s */\n'%(indent, ''))
3728
3729     # ---------------------------------------------------------------------------------------------------
3730
3731     def generate_interface_intro(self, i):
3732         self.outfile.write('/* ------------------------------------------------------------------------\n'
3733                            ' * Code for interface %s\n'
3734                            ' * ------------------------------------------------------------------------\n'
3735                            ' */\n'
3736                            '\n'%(i.name))
3737
3738         self.outfile.write(self.docbook_gen.expand(
3739                 '/**\n'
3740                 ' * SECTION:%s\n'
3741                 ' * @title: %s\n'
3742                 ' * @short_description: Generated C code for the %s D-Bus interface\n'
3743                 ' *\n'
3744                 ' * This section contains code for working with the #%s D-Bus interface in C.\n'
3745                 ' */\n'
3746                 %(i.camel_name, i.camel_name, i.name, i.name), False))
3747         self.outfile.write('\n')
3748
3749     def generate(self):
3750         self.generate_body_preamble()
3751         for i in self.ifaces:
3752             self.generate_interface_intro(i)
3753             self.generate_introspection_for_interface(i)
3754             self.generate_interface(i)
3755             self.generate_property_accessors(i)
3756             self.generate_signal_emitters(i)
3757             self.generate_method_calls(i)
3758             self.generate_method_completers(i)
3759             self.generate_proxy(i)
3760             self.generate_skeleton(i)
3761         if self.generate_objmanager:
3762             self.generate_object()
3763             self.generate_object_manager_client()