Attachment 61172 Details for Bug 49600 – 4/8] Update codegen tools from telepathy-glib, requiring GLib 2.30

[patch] 4/8] Update codegen tools from telepathy-glib, requiring GLib 2.30

0004-Update-codegen-tools-from-telepathy-glib-requiring-G.patch (text/plain), 39.50 KB, created by Simon McVittie on 2012-05-07 12:09:32 UTC

(hide)

Description:

Filename:

MIME Type:

Creator: Simon McVittie

Created: 2012-05-07 12:09:32 UTC

Size: 39.50 KB

patch

obsolete

>From 11cb78b89fe79ff4c09ba51b45dbb3e100732e1b Mon Sep 17 00:00:00 2001
>From: Simon McVittie <simon.mcvittie@collabora.co.uk>
>Date: Mon, 7 May 2012 19:56:49 +0100
>Subject: [PATCH 4/8] Update codegen tools from telepathy-glib, requiring GLib
> 2.30
>
>The updated codegen needs g_cclosure_marshal_generic.
>---
> configure.ac                 |    4 +-
> tools/Makefile.am            |    3 +-
> tools/glib-ginterface-gen.py |  348 ++++++++++++++++++++++++++++++++----------
> tools/libglibcodegen.py      |  171 +++------------------
> tools/libtpcodegen.py        |  227 +++++++++++++++++++++++++++
> 5 files changed, 520 insertions(+), 233 deletions(-)
> create mode 100644 tools/libtpcodegen.py
>
>diff --git a/configure.ac b/configure.ac
>index 61985ee..6cf1d8d 100644
>--- a/configure.ac
>+++ b/configure.ac
>@@ -72,9 +72,9 @@ AC_C_INLINE
> 
> dnl Check for Glib
> AC_DEFINE(GLIB_VERSION_MIN_REQUIRED, GLIB_VERSION_2_28, [Ignore post 2.28 deprecations])
>-AC_DEFINE(GLIB_VERSION_MAX_ALLOWED, GLIB_VERSION_2_28, [Prevent post 2.28 APIs])
>+AC_DEFINE(GLIB_VERSION_MAX_ALLOWED, GLIB_VERSION_2_30, [Prevent post 2.30 APIs])
> 
>-PKG_CHECK_MODULES(GLIB, [glib-2.0 >= 2.28.0, gobject-2.0 >= 2.28.0, gio-2.0 >= 2.28.0 ])
>+PKG_CHECK_MODULES(GLIB, [glib-2.0 >= 2.30.0, gobject-2.0 >= 2.30.0, gio-2.0 >= 2.30.0 ])
> 
> AC_SUBST(GLIB_CFLAGS)
> AC_SUBST(GLIB_LIBS)
>diff --git a/tools/Makefile.am b/tools/Makefile.am
>index 442d912..788e956 100644
>--- a/tools/Makefile.am
>+++ b/tools/Makefile.am
>@@ -6,6 +6,7 @@ EXTRA_DIST = \
>     glib-signals-marshal-gen.py \
>     identity.xsl \
>     libglibcodegen.py \
>+    libtpcodegen.py \
>     make-release-mail.py
> 
> CLEANFILES = libglibcodegen.pyc libglibcodegen.pyo
>@@ -13,5 +14,5 @@ CLEANFILES = libglibcodegen.pyc libglibcodegen.pyo
> glib-ginterface-gen.py: libglibcodegen.py
> 	touch $@
> 
>-glib-signals-marshal-gen.py: libglibcodegen.py
>+glib-ginterface-gen.py: libglibcodegen.py libtpcodegen.py
> 	touch $@
>diff --git a/tools/glib-ginterface-gen.py b/tools/glib-ginterface-gen.py
>index f806131..7843977 100644
>--- a/tools/glib-ginterface-gen.py
>+++ b/tools/glib-ginterface-gen.py
>@@ -16,23 +16,33 @@
> # This library is distributed in the hope that it will be useful,
> # but WITHOUT ANY WARRANTY; without even the implied warranty of
> # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
>-# Library General Public License for more details.
>+# Lesser General Public License for more details.
> #
> # You should have received a copy of the GNU Lesser General Public
> # License along with this library; if not, write to the Free Software
>-# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
>+# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
> 
> import sys
> import os.path
> import xml.dom.minidom
> 
>+from libtpcodegen import file_set_contents
> from libglibcodegen import Signature, type_to_gtype, cmp_by_name, \
>-        camelcase_to_lower, NS_TP, dbus_gutils_wincaps_to_uscore, \
>-        signal_to_marshal_name, method_to_glue_marshal_name
>+        NS_TP, dbus_gutils_wincaps_to_uscore
> 
> 
> NS_TP = "http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0"
> 
>+def get_emits_changed(node):
>+    try:
>+        return [
>+            annotation.getAttribute('value')
>+            for annotation in node.getElementsByTagName('annotation')
>+            if annotation.getAttribute('name') == 'org.freedesktop.DBus.Property.EmitsChangedSignal'
>+            ][0]
>+    except IndexError:
>+        return None
>+
> class Generator(object):
> 
>     def __init__(self, dom, prefix, basename, signal_marshal_prefix,
>@@ -41,6 +51,7 @@ class Generator(object):
>         self.dom = dom
>         self.__header = []
>         self.__body = []
>+        self.__docs = []
> 
>         assert prefix.endswith('_')
>         assert not signal_marshal_prefix.endswith('_')
>@@ -66,6 +77,7 @@ class Generator(object):
>         self.prefix_ = prefix.lower()
>         self.PREFIX_ = prefix.upper()
> 
>+        self.basename = basename
>         self.signal_marshal_prefix = signal_marshal_prefix
>         self.headers = headers
>         self.end_headers = end_headers
>@@ -73,11 +85,20 @@ class Generator(object):
>         self.allow_havoc = allow_havoc
> 
>     def h(self, s):
>+        if isinstance(s, unicode):
>+            s = s.encode('utf-8')
>         self.__header.append(s)
> 
>     def b(self, s):
>+        if isinstance(s, unicode):
>+            s = s.encode('utf-8')
>         self.__body.append(s)
> 
>+    def d(self, s):
>+        if isinstance(s, unicode):
>+            s = s.encode('utf-8')
>+        self.__docs.append(s)
>+
>     def do_node(self, node):
>         node_name = node.getAttribute('name').replace('/', '')
>         node_name_mixed = self.node_name_mixed = node_name.replace('_', '')
>@@ -89,16 +110,25 @@ class Generator(object):
>         interface = interfaces[0]
>         self.iface_name = interface.getAttribute('name')
> 
>-        tmp = node.getAttribute('causes-havoc')
>+        tmp = interface.getAttribute('tp:implement-service')
>+        if tmp == "no":
>+            return
>+
>+        tmp = interface.getAttribute('tp:causes-havoc')
>         if tmp and not self.allow_havoc:
>             raise AssertionError('%s is %s' % (self.iface_name, tmp))
> 
>+        iface_emits_changed = get_emits_changed(interface)
>+
>         self.b('static const DBusGObjectInfo _%s%s_object_info;'
>                % (self.prefix_, node_name_lc))
>         self.b('')
> 
>         methods = interface.getElementsByTagName('method')
>         signals = interface.getElementsByTagName('signal')
>+        properties = interface.getElementsByTagName('property')
>+        # Don't put properties in dbus-glib glue
>+        glue_properties = []
> 
>         self.b('struct _%s%sClass {' % (self.Prefix, node_name_mixed))
>         self.b('    GTypeInterface parent_class;')
>@@ -150,20 +180,55 @@ class Generator(object):
>         self.b('}')
>         self.b('')
> 
>-        self.h('/**')
>-        self.h(' * %s%s:' % (self.Prefix, node_name_mixed))
>-        self.h(' *')
>-        self.h(' * Dummy typedef representing any implementation of this '
>+        self.d('/**')
>+        self.d(' * %s%s:' % (self.Prefix, node_name_mixed))
>+        self.d(' *')
>+        self.d(' * Dummy typedef representing any implementation of this '
>                'interface.')
>-        self.h(' */')
>+        self.d(' */')
>+
>         self.h('typedef struct _%s%s %s%s;'
>                % (self.Prefix, node_name_mixed, self.Prefix, node_name_mixed))
>         self.h('')
>-        self.h('/**')
>-        self.h(' * %s%sClass:' % (self.Prefix, node_name_mixed))
>-        self.h(' *')
>-        self.h(' * The class of %s%s.' % (self.Prefix, node_name_mixed))
>-        self.h(' */')
>+
>+        self.d('/**')
>+        self.d(' * %s%sClass:' % (self.Prefix, node_name_mixed))
>+        self.d(' *')
>+        self.d(' * The class of %s%s.' % (self.Prefix, node_name_mixed))
>+
>+        if methods:
>+            self.d(' *')
>+            self.d(' * In a full implementation of this interface (i.e. all')
>+            self.d(' * methods implemented), the interface initialization')
>+            self.d(' * function used in G_IMPLEMENT_INTERFACE() would')
>+            self.d(' * typically look like this:')
>+            self.d(' *')
>+            self.d(' * <programlisting>')
>+            self.d(' * static void')
>+            self.d(' * implement_%s (gpointer klass,' % self.node_name_lc)
>+            self.d(' *     gpointer unused G_GNUC_UNUSED)')
>+            self.d(' * {')
>+            self.d(' * #define IMPLEMENT(x) %s%s_implement_&num;&num;x (\\'
>+                   % (self.prefix_, self.node_name_lc))
>+            self.d(' *   klass, my_object_&num;&num;x)')
>+
>+            for method in methods:
>+                class_member_name = method.getAttribute('tp:name-for-bindings')
>+                class_member_name = class_member_name.lower()
>+                self.d(' *   IMPLEMENT (%s);' % class_member_name)
>+
>+            self.d(' * #undef IMPLEMENT')
>+            self.d(' * }')
>+            self.d(' * </programlisting>')
>+        else:
>+            self.d(' * This interface has no D-Bus methods, so an')
>+            self.d(' * implementation can typically pass %NULL to')
>+            self.d(' * G_IMPLEMENT_INTERFACE() as the interface')
>+            self.d(' * initialization function.')
>+
>+        self.d(' */')
>+        self.d('')
>+
>         self.h('typedef struct _%s%sClass %s%sClass;'
>                % (self.Prefix, node_name_mixed, self.Prefix, node_name_mixed))
>         self.h('')
>@@ -196,23 +261,85 @@ class Generator(object):
>         for signal in signals:
>             base_init_code.extend(self.do_signal(signal))
> 
>-        self.b('static void')
>-        self.b('%s%s_base_init (gpointer klass)'
>+        self.b('static inline void')
>+        self.b('%s%s_base_init_once (gpointer klass G_GNUC_UNUSED)'
>                % (self.prefix_, node_name_lc))
>         self.b('{')
>-        self.b('  static gboolean initialized = FALSE;')
>-        self.b('')
>-        self.b('  if (initialized)')
>-        self.b('    return;')
>-        self.b('')
>-        self.b('  initialized = TRUE;')
>+
>+        if properties:
>+            self.b('  static TpDBusPropertiesMixinPropInfo properties[%d] = {'
>+                   % (len(properties) + 1))
>+
>+            for m in properties:
>+                access = m.getAttribute('access')
>+                assert access in ('read', 'write', 'readwrite')
>+
>+                if access == 'read':
>+                    flags = 'TP_DBUS_PROPERTIES_MIXIN_FLAG_READ'
>+                elif access == 'write':
>+                    flags = 'TP_DBUS_PROPERTIES_MIXIN_FLAG_WRITE'
>+                else:
>+                    flags = ('TP_DBUS_PROPERTIES_MIXIN_FLAG_READ | '
>+                             'TP_DBUS_PROPERTIES_MIXIN_FLAG_WRITE')
>+
>+                prop_emits_changed = get_emits_changed(m)
>+
>+                if prop_emits_changed is None:
>+                    prop_emits_changed = iface_emits_changed
>+
>+                if prop_emits_changed == 'true':
>+                    flags += ' | TP_DBUS_PROPERTIES_MIXIN_FLAG_EMITS_CHANGED'
>+                elif prop_emits_changed == 'invalidates':
>+                    flags += ' | TP_DBUS_PROPERTIES_MIXIN_FLAG_EMITS_INVALIDATED'
>+
>+                self.b('      { 0, %s, "%s", 0, NULL, NULL }, /* %s */'
>+                       % (flags, m.getAttribute('type'), m.getAttribute('name')))
>+
>+            self.b('      { 0, 0, NULL, 0, NULL, NULL }')
>+            self.b('  };')
>+            self.b('  static TpDBusPropertiesMixinIfaceInfo interface =')
>+            self.b('      { 0, properties, NULL, NULL };')
>+            self.b('')
>+
>+
>+        self.b('  dbus_g_object_type_install_info (%s%s_get_type (),'
>+               % (self.prefix_, node_name_lc))
>+        self.b('      &_%s%s_object_info);'
>+               % (self.prefix_, node_name_lc))
>         self.b('')
>+
>+        if properties:
>+            self.b('  interface.dbus_interface = g_quark_from_static_string '
>+                   '("%s");' % self.iface_name)
>+
>+            for i, m in enumerate(properties):
>+                self.b('  properties[%d].name = g_quark_from_static_string ("%s");'
>+                       % (i, m.getAttribute('name')))
>+                self.b('  properties[%d].type = %s;'
>+                           % (i, type_to_gtype(m.getAttribute('type'))[1]))
>+
>+            self.b('  tp_svc_interface_set_dbus_properties_info (%s, &interface);'
>+                   % self.current_gtype)
>+
>+            self.b('')
>+
>         for s in base_init_code:
>             self.b(s)
>-        self.b('  dbus_g_object_type_install_info (%s%s_get_type (),'
>+        self.b('}')
>+
>+        self.b('static void')
>+        self.b('%s%s_base_init (gpointer klass)'
>                % (self.prefix_, node_name_lc))
>-        self.b('      &_%s%s_object_info);'
>+        self.b('{')
>+        self.b('  static gboolean initialized = FALSE;')
>+        self.b('')
>+        self.b('  if (!initialized)')
>+        self.b('    {')
>+        self.b('      initialized = TRUE;')
>+        self.b('      %s%s_base_init_once (klass);'
>                % (self.prefix_, node_name_lc))
>+        self.b('    }')
>+        # insert anything we need to do per implementation here
>         self.b('}')
> 
>         self.h('')
>@@ -225,6 +352,10 @@ class Generator(object):
>         for method, offset in zip(methods, offsets):
>             self.do_method_glue(method, offset)
> 
>+        if len(methods) == 0:
>+            # empty arrays are a gcc extension, so put in a dummy member
>+            self.b("  { NULL, NULL, 0 }")
>+
>         self.b('};')
>         self.b('')
> 
>@@ -235,7 +366,9 @@ class Generator(object):
>         self.b('  %d,' % len(methods))
>         self.b('"' + method_blob.replace('\0', '\\0') + '",')
>         self.b('"' + self.get_signal_glue(signals).replace('\0', '\\0') + '",')
>-        self.b('"\\0"')
>+        self.b('"' +
>+               self.get_property_glue(glue_properties).replace('\0', '\\0') +
>+               '",')
>         self.b('};')
>         self.b('')
> 
>@@ -282,10 +415,13 @@ class Generator(object):
>         return ''.join(info) + '\0', offsets
> 
>     def do_method_glue(self, method, offset):
>-        lc_name = camelcase_to_lower(method.getAttribute('name'))
>+        lc_name = method.getAttribute('tp:name-for-bindings')
>+        if method.getAttribute('name') != lc_name.replace('_', ''):
>+            raise AssertionError('Method %s tp:name-for-bindings (%s) does '
>+                    'not match' % (method.getAttribute('name'), lc_name))
>+        lc_name = lc_name.lower()
> 
>-        marshaller = method_to_glue_marshal_name(method,
>-                self.signal_marshal_prefix)
>+        marshaller = 'g_cclosure_marshal_generic'
>         wrapper = self.prefix_ + self.node_name_lc + '_' + lc_name
> 
>         self.b("  { (GCallback) %s, %s, %d }," % (wrapper, marshaller, offset))
>@@ -299,12 +435,21 @@ class Generator(object):
> 
>         return '\0'.join(info) + '\0\0'
> 
>+    # the implementation can be the same
>+    get_property_glue = get_signal_glue
>+
>     def get_method_impl_names(self, method):
>         dbus_method_name = method.getAttribute('name')
>-        class_member_name = camelcase_to_lower(dbus_method_name)
>+
>+        class_member_name = method.getAttribute('tp:name-for-bindings')
>+        if dbus_method_name != class_member_name.replace('_', ''):
>+            raise AssertionError('Method %s tp:name-for-bindings (%s) does '
>+                    'not match' % (dbus_method_name, class_member_name))
>+        class_member_name = class_member_name.lower()
>+
>         stub_name = (self.prefix_ + self.node_name_lc + '_' +
>                      class_member_name)
>-        return (stub_name + '_impl', class_member_name)
>+        return (stub_name + '_impl', class_member_name + '_cb')
> 
>     def do_method(self, method):
>         assert self.node_name_mixed is not None
>@@ -316,7 +461,12 @@ class Generator(object):
>         # DoStuff
>         dbus_method_name = method.getAttribute('name')
>         # do_stuff
>-        class_member_name = camelcase_to_lower(dbus_method_name)
>+        class_member_name = method.getAttribute('tp:name-for-bindings')
>+        if dbus_method_name != class_member_name.replace('_', ''):
>+            raise AssertionError('Method %s tp:name-for-bindings (%s) does '
>+                    'not match' % (dbus_method_name, class_member_name))
>+        class_member_name = class_member_name.lower()
>+
>         # void tp_svc_thing_do_stuff (TpSvcThing *, const char *, guint,
>         #   DBusGMethodInvocation *);
>         stub_name = (self.prefix_ + self.node_name_lc + '_' +
>@@ -358,18 +508,19 @@ class Generator(object):
>             else:
>                 out_args.append(struct)
> 
>-        # Implementation type declaration (in header, docs in body)
>-        self.b('/**')
>-        self.b(' * %s:' % impl_name)
>-        self.b(' * @self: The object implementing this interface')
>+        # Implementation type declaration (in header, docs separated)
>+        self.d('/**')
>+        self.d(' * %s:' % impl_name)
>+        self.d(' * @self: The object implementing this interface')
>         for (ctype, name) in in_args:
>-            self.b(' * @%s: %s (FIXME, generate documentation)'
>+            self.d(' * @%s: %s (FIXME, generate documentation)'
>                    % (name, ctype))
>-        self.b(' * @context: Used to return values or throw an error')
>-        self.b(' *')
>-        self.b(' * The signature of an implementation of the D-Bus method')
>-        self.b(' * %s on interface %s.' % (dbus_method_name, self.iface_name))
>-        self.b(' */')
>+        self.d(' * @context: Used to return values or throw an error')
>+        self.d(' *')
>+        self.d(' * The signature of an implementation of the D-Bus method')
>+        self.d(' * %s on interface %s.' % (dbus_method_name, self.iface_name))
>+        self.d(' */')
>+
>         self.h('typedef void (*%s) (%s%s *self,'
>           % (impl_name, self.Prefix, self.node_name_mixed))
>         for (ctype, name) in in_args:
>@@ -387,7 +538,7 @@ class Generator(object):
>             self.b('    %s%s,' % (ctype, name))
>         self.b('    DBusGMethodInvocation *context)')
>         self.b('{')
>-        self.b('  %s impl = (%s%s_GET_CLASS (self)->%s);'
>+        self.b('  %s impl = (%s%s_GET_CLASS (self)->%s_cb);'
>           % (impl_name, self.PREFIX_, self.node_name_uc, class_member_name))
>         self.b('')
>         self.b('  if (impl != NULL)')
>@@ -414,38 +565,41 @@ class Generator(object):
>                % (self.prefix_, self.node_name_lc, class_member_name,
>                   self.Prefix, self.node_name_mixed, impl_name))
> 
>-        self.b('/**')
>-        self.b(' * %s%s_implement_%s:'
>+        self.d('/**')
>+        self.d(' * %s%s_implement_%s:'
>                % (self.prefix_, self.node_name_lc, class_member_name))
>-        self.b(' * @klass: A class whose instances implement this interface')
>-        self.b(' * @impl: A callback used to implement the %s D-Bus method'
>+        self.d(' * @klass: A class whose instances implement this interface')
>+        self.d(' * @impl: A callback used to implement the %s D-Bus method'
>                % dbus_method_name)
>-        self.b(' *')
>-        self.b(' * Register an implementation for the %s method in the vtable'
>+        self.d(' *')
>+        self.d(' * Register an implementation for the %s method in the vtable'
>                % dbus_method_name)
>-        self.b(' * of an implementation of this interface. To be called from')
>-        self.b(' * the interface init function.')
>-        self.b(' */')
>+        self.d(' * of an implementation of this interface. To be called from')
>+        self.d(' * the interface init function.')
>+        self.d(' */')
>+
>         self.b('void')
>         self.b('%s%s_implement_%s (%s%sClass *klass, %s impl)'
>                % (self.prefix_, self.node_name_lc, class_member_name,
>                   self.Prefix, self.node_name_mixed, impl_name))
>         self.b('{')
>-        self.b('  klass->%s = impl;' % class_member_name)
>+        self.b('  klass->%s_cb = impl;' % class_member_name)
>         self.b('}')
>         self.b('')
> 
>         # Return convenience function (static inline, in header)
>-        self.h('/**')
>-        self.h(' * %s:' % ret_name)
>-        self.h(' * @context: The D-Bus method invocation context')
>+        self.d('/**')
>+        self.d(' * %s:' % ret_name)
>+        self.d(' * @context: The D-Bus method invocation context')
>         for (ctype, name) in out_args:
>-            self.h(' * @%s: %s (FIXME, generate documentation)'
>+            self.d(' * @%s: %s (FIXME, generate documentation)'
>                    % (name, ctype))
>-        self.h(' *')
>-        self.h(' * Return successfully by calling dbus_g_method_return().')
>-        self.h(' * This inline function exists only to provide type-safety.')
>-        self.h(' */')
>+        self.d(' *')
>+        self.d(' * Return successfully by calling dbus_g_method_return().')
>+        self.d(' * This inline function exists only to provide type-safety.')
>+        self.d(' */')
>+        self.d('')
>+
>         tmp = (['DBusGMethodInvocation *context'] +
>                [ctype + name for (ctype, name) in out_args])
>         self.h('static inline')
>@@ -477,8 +631,15 @@ class Generator(object):
>         #    const char *arg0, guint arg1);
> 
>         dbus_name = signal.getAttribute('name')
>+
>+        ugly_name = signal.getAttribute('tp:name-for-bindings')
>+        if dbus_name != ugly_name.replace('_', ''):
>+            raise AssertionError('Signal %s tp:name-for-bindings (%s) does '
>+                    'not match' % (dbus_name, ugly_name))
>+
>         stub_name = (self.prefix_ + self.node_name_lc + '_emit_' +
>-                     camelcase_to_lower(dbus_name))
>+                     ugly_name.lower())
>+
>         const_name = self.get_signal_const_entry(signal)
> 
>         # Gather arguments
>@@ -508,17 +669,17 @@ class Generator(object):
> 
>         # FIXME: emit docs
> 
>-        self.b('/**')
>-        self.b(' * %s:' % stub_name)
>-        self.b(' * @instance: The object implementing this interface')
>+        self.d('/**')
>+        self.d(' * %s:' % stub_name)
>+        self.d(' * @instance: The object implementing this interface')
>         for (ctype, name, gtype) in args:
>-            self.b(' * @%s: %s (FIXME, generate documentation)'
>+            self.d(' * @%s: %s (FIXME, generate documentation)'
>                    % (name, ctype))
>-        self.b(' *')
>-        self.b(' * Type-safe wrapper around g_signal_emit to emit the')
>-        self.b(' * %s signal on interface %s.'
>+        self.d(' *')
>+        self.d(' * Type-safe wrapper around g_signal_emit to emit the')
>+        self.d(' * %s signal on interface %s.'
>                % (dbus_name, self.iface_name))
>-        self.b(' */')
>+        self.d(' */')
> 
>         self.b('void')
>         self.b(('%s (' % stub_name) + (',\n    '.join(tmp)) + ')')
>@@ -532,16 +693,30 @@ class Generator(object):
>         self.b('}')
>         self.b('')
> 
>+        signal_name = dbus_gutils_wincaps_to_uscore(dbus_name).replace('_',
>+                '-')
>+
>+        self.d('/**')
>+        self.d(' * %s%s::%s:'
>+                % (self.Prefix, self.node_name_mixed, signal_name))
>+        self.d(' * @self: an object')
>+        for (ctype, name, gtype) in args:
>+            self.d(' * @%s: %s (FIXME, generate documentation)'
>+                   % (name, ctype))
>+        self.d(' *')
>+        self.d(' * The %s D-Bus signal is emitted whenever '
>+                'this GObject signal is.' % dbus_name)
>+        self.d(' */')
>+        self.d('')
>+
>         in_base_init.append('  %s_signals[%s] ='
>                             % (self.node_name_lc, const_name))
>-        in_base_init.append('  g_signal_new ("%s",'
>-                % (dbus_gutils_wincaps_to_uscore(dbus_name).replace('_', '-')))
>+        in_base_init.append('  g_signal_new ("%s",' % signal_name)
>         in_base_init.append('      G_OBJECT_CLASS_TYPE (klass),')
>         in_base_init.append('      G_SIGNAL_RUN_LAST|G_SIGNAL_DETAILED,')
>         in_base_init.append('      0,')
>         in_base_init.append('      NULL, NULL,')
>-        in_base_init.append('      %s,'
>-                % signal_to_marshal_name(signal, self.signal_marshal_prefix))
>+        in_base_init.append('      g_cclosure_marshal_generic,')
>         in_base_init.append('      G_TYPE_NONE,')
>         tmp = ['%d' % len(args)] + [gtype for (ctype, name, gtype) in args]
>         in_base_init.append('      %s);' % ',\n      '.join(tmp))
>@@ -549,22 +724,33 @@ class Generator(object):
> 
>         return in_base_init
> 
>+    def have_properties(self, nodes):
>+        for node in nodes:
>+            interface =  node.getElementsByTagName('interface')[0]
>+            if interface.getElementsByTagName('property'):
>+                return True
>+        return False
>+
>     def __call__(self):
>+        nodes = self.dom.getElementsByTagName('node')
>+        nodes.sort(cmp_by_name)
>+
>         self.h('#include <glib-object.h>')
>         self.h('#include <dbus/dbus-glib.h>')
>+
>+        if self.have_properties(nodes):
>+            self.h('#include <telepathy-glib/dbus-properties-mixin.h>')
>+
>         self.h('')
>         self.h('G_BEGIN_DECLS')
>         self.h('')
> 
>-        self.b('#include "%s.h"' % basename)
>+        self.b('#include "%s.h"' % self.basename)
>         self.b('')
>         for header in self.headers:
>             self.b('#include %s' % header)
>         self.b('')
> 
>-        nodes = self.dom.getElementsByTagName('node')
>-        nodes.sort(cmp_by_name)
>-
>         for node in nodes:
>             self.do_node(node)
> 
>@@ -577,9 +763,9 @@ class Generator(object):
> 
>         self.h('')
>         self.b('')
>-        open(basename + '.h', 'w').write('\n'.join(self.__header))
>-        open(basename + '.c', 'w').write('\n'.join(self.__body))
>-
>+        file_set_contents(self.basename + '.h', '\n'.join(self.__header))
>+        file_set_contents(self.basename + '.c', '\n'.join(self.__body))
>+        file_set_contents(self.basename + '-gtk-doc.h', '\n'.join(self.__docs))
> 
> def cmdline_error():
>     print """\
>diff --git a/tools/libglibcodegen.py b/tools/libglibcodegen.py
>index 20ce455..6a9d214 100644
>--- a/tools/libglibcodegen.py
>+++ b/tools/libglibcodegen.py
>@@ -4,7 +4,7 @@ The master copy of this library is in the telepathy-glib repository -
> please make any changes there.
> """
> 
>-# Copyright (C) 2006, 2007 Collabora Limited
>+# Copyright (C) 2006-2008 Collabora Limited
> #
> # This library is free software; you can redistribute it and/or
> # modify it under the terms of the GNU Lesser General Public
>@@ -14,51 +14,22 @@ please make any changes there.
> # This library is distributed in the hope that it will be useful,
> # but WITHOUT ANY WARRANTY; without even the implied warranty of
> # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
>-# Library General Public License for more details.
>+# Lesser General Public License for more details.
> #
> # You should have received a copy of the GNU Lesser General Public
> # License along with this library; if not, write to the Free Software
>-# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
>+# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
> 
> 
>-from string import ascii_letters, digits
>-
>-
>-NS_TP = "http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0"
>-
>-_ASCII_ALNUM = ascii_letters + digits
>-
>-
>-def camelcase_to_lower(s):
>-    out ="";
>-    out += s[0].lower()
>-    last_upper=False
>-    if s[0].isupper():
>-        last_upper=True
>-    for i in range(1,len(s)):
>-        if s[i].isupper():
>-            if last_upper:
>-                if (i+1) < len(s) and  s[i+1].islower():
>-                    out += "_" + s[i].lower()
>-                else:
>-                    out += s[i].lower()
>-            else:
>-                out += "_" + s[i].lower()
>-            last_upper=True
>-        else:
>-            out += s[i]
>-            last_upper=False
>-    return out
>-
>-
>-def camelcase_to_upper(s):
>-    return camelcase_to_lower(s).upper()
>-
>-
>-def cmp_by_name(node1, node2):
>-    return cmp(node1.getAttributeNode("name").nodeValue,
>-               node2.getAttributeNode("name").nodeValue)
>-
>+from libtpcodegen import NS_TP, \
>+                         Signature, \
>+                         cmp_by_name, \
>+                         escape_as_identifier, \
>+                         get_by_path, \
>+                         get_descendant_text, \
>+                         get_docstring, \
>+                         xml_escape, \
>+                         get_deprecated
> 
> def dbus_gutils_wincaps_to_uscore(s):
>     """Bug-for-bug compatible Python port of _dbus_gutils_wincaps_to_uscore
>@@ -77,44 +48,6 @@ def dbus_gutils_wincaps_to_uscore(s):
>     return ret
> 
> 
>-def escape_as_identifier(identifier):
>-    """Escape the given string to be a valid D-Bus object path or service
>-    name component, using a reversible encoding to ensure uniqueness.
>-
>-    The reversible encoding is as follows:
>-
>-    * The empty string becomes '_'
>-    * Otherwise, each non-alphanumeric character is replaced by '_' plus
>-      two lower-case hex digits; the same replacement is carried out on
>-      the first character, if it's a digit
>-    """
>-    # '' -> '_'
>-    if not identifier:
>-        return '_'
>-
>-    # A bit of a fast path for strings which are already OK.
>-    # We deliberately omit '_' because, for reversibility, that must also
>-    # be escaped.
>-    if (identifier.strip(_ASCII_ALNUM) == '' and
>-        identifier[0] in ascii_letters):
>-        return identifier
>-
>-    # The first character may not be a digit
>-    if identifier[0] not in ascii_letters:
>-        ret = ['_%02x' % ord(identifier[0])]
>-    else:
>-        ret = [identifier[0]]
>-
>-    # Subsequent characters may be digits or ASCII letters
>-    for c in identifier[1:]:
>-        if c in _ASCII_ALNUM:
>-            ret.append(c)
>-        else:
>-            ret.append('_%02x' % ord(c))
>-
>-    return ''.join(ret)
>-
>-
> def signal_to_marshal_type(signal):
>     """
>     return a list of strings indicating the marshalling type for this signal.
>@@ -167,69 +100,6 @@ def method_to_glue_marshal_name(method, prefix):
>         return prefix + '_marshal_VOID__' + name
> 
> 
>-class _SignatureIter:
>-    """Iterator over a D-Bus signature. Copied from dbus-python 0.71 so we
>-    can run genginterface in a limited environment with only Python
>-    (like Scratchbox).
>-    """
>-    def __init__(self, string):
>-        self.remaining = string
>-
>-    def next(self):
>-        if self.remaining == '':
>-            raise StopIteration
>-
>-        signature = self.remaining
>-        block_depth = 0
>-        block_type = None
>-        end = len(signature)
>-
>-        for marker in range(0, end):
>-            cur_sig = signature[marker]
>-
>-            if cur_sig == 'a':
>-                pass
>-            elif cur_sig == '{' or cur_sig == '(':
>-                if block_type == None:
>-                    block_type = cur_sig
>-
>-                if block_type == cur_sig:
>-                    block_depth = block_depth + 1
>-
>-            elif cur_sig == '}':
>-                if block_type == '{':
>-                    block_depth = block_depth - 1
>-
>-                if block_depth == 0:
>-                    end = marker
>-                    break
>-
>-            elif cur_sig == ')':
>-                if block_type == '(':
>-                    block_depth = block_depth - 1
>-
>-                if block_depth == 0:
>-                    end = marker
>-                    break
>-
>-            else:
>-                if block_depth == 0:
>-                    end = marker
>-                    break
>-
>-        end = end + 1
>-        self.remaining = signature[end:]
>-        return Signature(signature[0:end])
>-
>-
>-class Signature(str):
>-    """A string, iteration over which is by D-Bus single complete types
>-    rather than characters.
>-    """
>-    def __iter__(self):
>-        return _SignatureIter(self)
>-
>-
> def type_to_gtype(s):
>     if s == 'y': #byte
>         return ("guchar ", "G_TYPE_UCHAR","UCHAR", False)
>@@ -244,9 +114,9 @@ def type_to_gtype(s):
>     elif s == 'u': #uint32
>         return ("guint ", "G_TYPE_UINT","UINT", False)
>     elif s == 'x': #int64
>-        return ("gint ", "G_TYPE_INT64","INT64", False)
>-    elif s == 't': #uint32
>-        return ("guint ", "G_TYPE_UINT64","UINT64", False)
>+        return ("gint64 ", "G_TYPE_INT64","INT64", False)
>+    elif s == 't': #uint64
>+        return ("guint64 ", "G_TYPE_UINT64","UINT64", False)
>     elif s == 'd': #double
>         return ("gdouble ", "G_TYPE_DOUBLE","DOUBLE", False)
>     elif s == 's': #string
>@@ -276,10 +146,10 @@ def type_to_gtype(s):
>     elif s == 'ab': #boolean array
>         return ("GArray *", "DBUS_TYPE_G_BOOLEAN_ARRAY", "BOXED", True)
>     elif s == 'ao': #object path array
>-        return ("GArray *", "DBUS_TYPE_G_OBJECT_ARRAY", "BOXED", True)
>-    elif s[:2] == 'a(': #array of structs, recurse
>-        gtype = type_to_gtype(s[1:])[1]
>-        return ("GPtrArray *", "(dbus_g_type_get_collection (\"GPtrArray\", "+gtype+"))", "BOXED", True)
>+        return ("GPtrArray *",
>+                'dbus_g_type_get_collection ("GPtrArray",'
>+                ' DBUS_TYPE_G_OBJECT_PATH)',
>+                "BOXED", True)
>     elif s == 'a{ss}': #hash table of string to string
>         return ("GHashTable *", "DBUS_TYPE_G_STRING_STRING_HASHTABLE", "BOXED", False)
>     elif s[:2] == 'a{':  #some arbitrary hash tables
>@@ -288,6 +158,9 @@ def type_to_gtype(s):
>         first = type_to_gtype(s[2])
>         second = type_to_gtype(s[3:-1])
>         return ("GHashTable *", "(dbus_g_type_get_map (\"GHashTable\", " + first[1] + ", " + second[1] + "))", "BOXED", False)
>+    elif s[:2] in ('a(', 'aa'): # array of structs or arrays, recurse
>+        gtype = type_to_gtype(s[1:])[1]
>+        return ("GPtrArray *", "(dbus_g_type_get_collection (\"GPtrArray\", "+gtype+"))", "BOXED", True)
>     elif s[:1] == '(': #struct
>         gtype = "(dbus_g_type_get_struct (\"GValueArray\", "
>         for subsig in Signature(s[1:-1]):
>diff --git a/tools/libtpcodegen.py b/tools/libtpcodegen.py
>new file mode 100644
>index 0000000..7e9eb9a
>--- /dev/null
>+++ b/tools/libtpcodegen.py
>@@ -0,0 +1,227 @@
>+"""Library code for language-independent D-Bus-related code generation.
>+
>+The master copy of this library is in the telepathy-glib repository -
>+please make any changes there.
>+"""
>+
>+# Copyright (C) 2006-2008 Collabora Limited
>+#
>+# This library is free software; you can redistribute it and/or
>+# modify it under the terms of the GNU Lesser General Public
>+# License as published by the Free Software Foundation; either
>+# version 2.1 of the License, or (at your option) any later version.
>+#
>+# This library is distributed in the hope that it will be useful,
>+# but WITHOUT ANY WARRANTY; without even the implied warranty of
>+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
>+# Lesser General Public License for more details.
>+#
>+# You should have received a copy of the GNU Lesser General Public
>+# License along with this library; if not, write to the Free Software
>+# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
>+
>+import os
>+from string import ascii_letters, digits
>+
>+
>+NS_TP = "http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0"
>+
>+_ASCII_ALNUM = ascii_letters + digits
>+
>+def file_set_contents(filename, contents):
>+    try:
>+        os.remove(filename)
>+    except OSError:
>+        pass
>+    try:
>+        os.remove(filename + '.tmp')
>+    except OSError:
>+        pass
>+
>+    open(filename + '.tmp', 'w').write(contents)
>+    os.rename(filename + '.tmp', filename)
>+
>+def cmp_by_name(node1, node2):
>+    return cmp(node1.getAttributeNode("name").nodeValue,
>+               node2.getAttributeNode("name").nodeValue)
>+
>+
>+def escape_as_identifier(identifier):
>+    """Escape the given string to be a valid D-Bus object path or service
>+    name component, using a reversible encoding to ensure uniqueness.
>+
>+    The reversible encoding is as follows:
>+
>+    * The empty string becomes '_'
>+    * Otherwise, each non-alphanumeric character is replaced by '_' plus
>+      two lower-case hex digits; the same replacement is carried out on
>+      the first character, if it's a digit
>+    """
>+    # '' -> '_'
>+    if not identifier:
>+        return '_'
>+
>+    # A bit of a fast path for strings which are already OK.
>+    # We deliberately omit '_' because, for reversibility, that must also
>+    # be escaped.
>+    if (identifier.strip(_ASCII_ALNUM) == '' and
>+        identifier[0] in ascii_letters):
>+        return identifier
>+
>+    # The first character may not be a digit
>+    if identifier[0] not in ascii_letters:
>+        ret = ['_%02x' % ord(identifier[0])]
>+    else:
>+        ret = [identifier[0]]
>+
>+    # Subsequent characters may be digits or ASCII letters
>+    for c in identifier[1:]:
>+        if c in _ASCII_ALNUM:
>+            ret.append(c)
>+        else:
>+            ret.append('_%02x' % ord(c))
>+
>+    return ''.join(ret)
>+
>+
>+def get_by_path(element, path):
>+    branches = path.split('/')
>+    branch = branches[0]
>+
>+    # Is the current branch an attribute, if so, return the attribute value
>+    if branch[0] == '@':
>+        return element.getAttribute(branch[1:])
>+
>+    # Find matching children for the branch
>+    children = []
>+    if branch == '..':
>+        children.append(element.parentNode)
>+    else:
>+        for x in element.childNodes:
>+            if x.localName == branch:
>+                children.append(x)
>+
>+    ret = []
>+    # If this is not the last path element, recursively gather results from
>+    # children
>+    if len(branches) > 1:
>+        for x in children:
>+            add = get_by_path(x, '/'.join(branches[1:]))
>+            if isinstance(add, list):
>+                ret += add
>+            else:
>+                return add
>+    else:
>+        ret = children
>+
>+    return ret
>+
>+
>+def get_docstring(element):
>+    docstring = None
>+    for x in element.childNodes:
>+        if x.namespaceURI == NS_TP and x.localName == 'docstring':
>+            docstring = x
>+    if docstring is not None:
>+        docstring = docstring.toxml().replace('\n', ' ').strip()
>+        if docstring.startswith('<tp:docstring>'):
>+            docstring = docstring[14:].lstrip()
>+        if docstring.endswith('</tp:docstring>'):
>+            docstring = docstring[:-15].rstrip()
>+        if docstring in ('<tp:docstring/>', ''):
>+            docstring = ''
>+    return docstring
>+
>+def get_deprecated(element):
>+    text = []
>+    for x in element.childNodes:
>+        if hasattr(x, 'data'):
>+            text.append(x.data.replace('\n', ' ').strip())
>+        else:
>+            # This caters for tp:dbus-ref elements, but little else.
>+            if x.childNodes and hasattr(x.childNodes[0], 'data'):
>+                text.append(x.childNodes[0].data.replace('\n', ' ').strip())
>+    return ' '.join(text)
>+
>+def get_descendant_text(element_or_elements):
>+    if not element_or_elements:
>+        return ''
>+    if isinstance(element_or_elements, list):
>+        return ''.join(map(get_descendant_text, element_or_elements))
>+    parts = []
>+    for x in element_or_elements.childNodes:
>+        if x.nodeType == x.TEXT_NODE:
>+            parts.append(x.nodeValue)
>+        elif x.nodeType == x.ELEMENT_NODE:
>+            parts.append(get_descendant_text(x))
>+        else:
>+            pass
>+    return ''.join(parts)
>+
>+
>+class _SignatureIter:
>+    """Iterator over a D-Bus signature. Copied from dbus-python 0.71 so we
>+    can run genginterface in a limited environment with only Python
>+    (like Scratchbox).
>+    """
>+    def __init__(self, string):
>+        self.remaining = string
>+
>+    def next(self):
>+        if self.remaining == '':
>+            raise StopIteration
>+
>+        signature = self.remaining
>+        block_depth = 0
>+        block_type = None
>+        end = len(signature)
>+
>+        for marker in range(0, end):
>+            cur_sig = signature[marker]
>+
>+            if cur_sig == 'a':
>+                pass
>+            elif cur_sig == '{' or cur_sig == '(':
>+                if block_type == None:
>+                    block_type = cur_sig
>+
>+                if block_type == cur_sig:
>+                    block_depth = block_depth + 1
>+
>+            elif cur_sig == '}':
>+                if block_type == '{':
>+                    block_depth = block_depth - 1
>+
>+                if block_depth == 0:
>+                    end = marker
>+                    break
>+
>+            elif cur_sig == ')':
>+                if block_type == '(':
>+                    block_depth = block_depth - 1
>+
>+                if block_depth == 0:
>+                    end = marker
>+                    break
>+
>+            else:
>+                if block_depth == 0:
>+                    end = marker
>+                    break
>+
>+        end = end + 1
>+        self.remaining = signature[end:]
>+        return Signature(signature[0:end])
>+
>+
>+class Signature(str):
>+    """A string, iteration over which is by D-Bus single complete types
>+    rather than characters.
>+    """
>+    def __iter__(self):
>+        return _SignatureIter(self)
>+
>+
>+def xml_escape(s):
>+    s = s.replace('&', '&amp;').replace("'", '&apos;').replace('"', '&quot;')
>+    return s.replace('<', '&lt;').replace('>', '&gt;')
>-- 
>1.7.10
>

Actions: View | Splinter Review

Attachments on bug 49600: 61169 | 61170 | 61171 | 61172 | 61173 | 61174 | 61175 | 61176

Use of freedesktop.org services, including Bugzilla, is subject to our Code of Conduct. How we collect and use information is described in our Privacy Policy.