def do_mapping_header(self, mapping):
members = mapping.getElementsByTagNameNS(NS_TP, 'member')
assert len(members) == 2
impl_sig = ''.join([elt.getAttribute('type')
for elt in members])
esc_impl_sig = escape_as_identifier(impl_sig)
name = (self.PREFIX_ + 'HASH_TYPE_' +
mapping.getAttribute('name').upper())
impl = self.prefix_ + 'type_dbus_hash_' + esc_impl_sig
docstring = get_docstring(mapping) or '(Undocumented)'
self.header.write('/**\n * %s:\n *\n' % name)
self.header.write(' * %s\n' % xml_escape(docstring))
self.header.write(' *\n')
self.header.write(' * This macro expands to a call to a function\n')
self.header.write(' * that returns the #GType of a #GHashTable\n')
self.header.write(' * appropriate for representing a D-Bus\n')
self.header.write(' * dictionary of signature\n')
self.header.write(' * <literal>a{%s}</literal>.\n' % impl_sig)
self.header.write(' *\n')
key, value = members
self.header.write(' * Keys (D-Bus type <literal>%s</literal>,\n'
% key.getAttribute('type'))
tp_type = key.getAttributeNS(NS_TP, 'type')
if tp_type:
self.header.write(' * type <literal>%s</literal>,\n' % tp_type)
self.header.write(' * named <literal>%s</literal>):\n'
% key.getAttribute('name'))
docstring = get_docstring(key) or '(Undocumented)'
self.header.write(' * %s\n' % xml_escape(docstring))
self.header.write(' *\n')
self.header.write(' * Values (D-Bus type <literal>%s</literal>,\n'
% value.getAttribute('type'))
tp_type = value.getAttributeNS(NS_TP, 'type')
if tp_type:
self.header.write(' * type <literal>%s</literal>,\n' % tp_type)
self.header.write(' * named <literal>%s</literal>):\n'
% value.getAttribute('name'))
docstring = get_docstring(value) or '(Undocumented)'
self.header.write(' * %s\n' % xml_escape(docstring))
self.header.write(' *\n')
self.header.write(' */\n')
self.header.write('#define %s (%s ())\n\n' % (name, impl))
self.need_mappings[impl_sig] = esc_impl_sig
def do_mapping_header(self, mapping):
members = mapping.getElementsByTagNameNS(NS_TP, 'member')
assert len(members) == 2
impl_sig = ''.join([elt.getAttribute('type') for elt in members])
esc_impl_sig = escape_as_identifier(impl_sig)
name = (self.PREFIX_ + 'HASH_TYPE_' +
mapping.getAttribute('name').upper())
impl = self.prefix_ + 'type_dbus_hash_' + esc_impl_sig
docstring = get_docstring(mapping) or '(Undocumented)'
self.header.write('/**\n * %s:\n *\n' % name)
self.header.write(' * %s\n' % xml_escape(docstring))
self.header.write(' *\n')
self.header.write(' * This macro expands to a call to a function\n')
self.header.write(' * that returns the #GType of a #GHashTable\n')
self.header.write(' * appropriate for representing a D-Bus\n')
self.header.write(' * dictionary of signature\n')
self.header.write(' * <literal>a{%s}</literal>.\n' % impl_sig)
self.header.write(' *\n')
key, value = members
self.header.write(' * Keys (D-Bus type <literal>%s</literal>,\n' %
key.getAttribute('type'))
tp_type = key.getAttributeNS(NS_TP, 'type')
if tp_type:
self.header.write(' * type <literal>%s</literal>,\n' % tp_type)
self.header.write(' * named <literal>%s</literal>):\n' %
key.getAttribute('name'))
docstring = get_docstring(key) or '(Undocumented)'
self.header.write(' * %s\n' % xml_escape(docstring))
self.header.write(' *\n')
self.header.write(' * Values (D-Bus type <literal>%s</literal>,\n' %
value.getAttribute('type'))
tp_type = value.getAttributeNS(NS_TP, 'type')
if tp_type:
self.header.write(' * type <literal>%s</literal>,\n' % tp_type)
self.header.write(' * named <literal>%s</literal>):\n' %
value.getAttribute('name'))
docstring = get_docstring(value) or '(Undocumented)'
self.header.write(' * %s\n' % xml_escape(docstring))
self.header.write(' *\n')
self.header.write(' */\n')
self.header.write('#define %s (%s ())\n\n' % (name, impl))
self.need_mappings[impl_sig] = esc_impl_sig
def do_gtkdoc(self):
for error in self.errors.getElementsByTagNameNS(NS_TP, 'error'):
ns = error.parentNode.getAttribute('namespace')
nick = error.getAttribute('name').replace(' ', '')
enum = 'TP_ERROR_' + camelcase_to_upper(nick.replace('.', ''))
print ' * @' + enum + ': ' + ns + '.' + nick + ':'
print ' * ' + get_docstring(error) + ' '
def do_gtkdoc(self):
for error in self.errors.getElementsByTagNameNS(NS_TP, 'error'):
ns = error.parentNode.getAttribute('namespace')
nick = error.getAttribute('name').replace(' ', '')
enum = 'TP_ERROR_' + camelcase_to_upper(nick.replace('.', ''))
print ' * @' + enum + ': ' + ns + '.' + nick + ':'
print ' * ' + get_docstring(error) + ' '
def do_struct_header(self, struct):
members = struct.getElementsByTagNameNS(NS_TP, 'member')
impl_sig = ''.join([elt.getAttribute('type') for elt in members])
esc_impl_sig = escape_as_identifier(impl_sig)
name = (self.PREFIX_ + 'STRUCT_TYPE_' +
struct.getAttribute('name').upper())
impl = self.prefix_ + 'type_dbus_struct_' + esc_impl_sig
docstring = struct.getElementsByTagNameNS(NS_TP, 'docstring')
if docstring:
docstring = docstring[0].toprettyxml()
if docstring.startswith('<tp:docstring>'):
docstring = docstring[14:]
if docstring.endswith('</tp:docstring>\n'):
docstring = docstring[:-16]
if docstring.strip() in ('<tp:docstring/>', ''):
docstring = '(Undocumented)'
else:
docstring = '(Undocumented)'
self.d('/**\n * %s:\n\n' % name)
self.d(' * %s\n' % xml_escape(docstring))
self.d(' *\n')
self.d(' * This macro expands to a call to a function\n')
self.d(' * that returns the #GType of a #GValueArray\n')
self.d(' * appropriate for representing a D-Bus struct\n')
self.d(' * with signature <literal>(%s)</literal>.\n'
% impl_sig)
self.d(' *\n')
for i, member in enumerate(members):
self.d(' * Member %d (D-Bus type '
'<literal>%s</literal>,\n'
% (i, member.getAttribute('type')))
tp_type = member.getAttributeNS(NS_TP, 'type')
if tp_type:
self.d(' * type <literal>%s</literal>,\n' % tp_type)
self.d(' * named <literal>%s</literal>):\n'
% member.getAttribute('name'))
docstring = get_docstring(member) or '(Undocumented)'
self.d(' * %s\n' % xml_escape(docstring))
self.d(' *\n')
self.d(' */\n\n')
self.h('#define %s (%s ())\n\n' % (name, impl))
array_name = struct.getAttribute('array-name')
if array_name != '':
array_name = (self.PREFIX_ + 'ARRAY_TYPE_' + array_name.upper())
impl = self.prefix_ + 'type_dbus_array_' + esc_impl_sig
self.d('/**\n * %s:\n\n' % array_name)
self.d(' * Expands to a call to a function\n')
self.d(' * that returns the #GType of a #GPtrArray\n')
self.d(' * of #%s.\n' % name)
self.d(' */\n\n')
self.h('#define %s (%s ())\n\n' % (array_name, impl))
self.need_struct_arrays[impl_sig] = esc_impl_sig
self.need_structs[impl_sig] = esc_impl_sig
def do_struct_header(self, struct):
members = struct.getElementsByTagNameNS(NS_TP, 'member')
impl_sig = ''.join([elt.getAttribute('type') for elt in members])
esc_impl_sig = escape_as_identifier(impl_sig)
name = (self.PREFIX_ + 'STRUCT_TYPE_' +
struct.getAttribute('name').upper())
impl = self.prefix_ + 'type_dbus_struct_' + esc_impl_sig
docstring = struct.getElementsByTagNameNS(NS_TP, 'docstring')
if docstring:
docstring = docstring[0].toprettyxml()
if docstring.startswith('<tp:docstring>'):
docstring = docstring[14:]
if docstring.endswith('</tp:docstring>\n'):
docstring = docstring[:-16]
if docstring.strip() in ('<tp:docstring/>', ''):
docstring = '(Undocumented)'
else:
docstring = '(Undocumented)'
self.d('/**\n * %s:\n\n' % name)
self.d(' * %s\n' % xml_escape(docstring))
self.d(' *\n')
self.d(' * This macro expands to a call to a function\n')
self.d(' * that returns the #GType of a #GValueArray\n')
self.d(' * appropriate for representing a D-Bus struct\n')
self.d(' * with signature <literal>(%s)</literal>.\n' % impl_sig)
self.d(' *\n')
for i, member in enumerate(members):
self.d(' * Member %d (D-Bus type '
'<literal>%s</literal>,\n' %
(i, member.getAttribute('type')))
tp_type = member.getAttributeNS(NS_TP, 'type')
if tp_type:
self.d(' * type <literal>%s</literal>,\n' % tp_type)
self.d(' * named <literal>%s</literal>):\n' %
member.getAttribute('name'))
docstring = get_docstring(member) or '(Undocumented)'
self.d(' * %s\n' % xml_escape(docstring))
self.d(' *\n')
self.d(' */\n\n')
self.h('#define %s (%s ())\n\n' % (name, impl))
array_name = struct.getAttribute('array-name')
if array_name != '':
array_name = (self.PREFIX_ + 'ARRAY_TYPE_' + array_name.upper())
impl = self.prefix_ + 'type_dbus_array_' + esc_impl_sig
self.d('/**\n * %s:\n\n' % array_name)
self.d(' * Expands to a call to a function\n')
self.d(' * that returns the #GType of a #GPtrArray\n')
self.d(' * of #%s.\n' % name)
self.d(' */\n\n')
self.h('#define %s (%s ())\n\n' % (array_name, impl))
self.need_struct_arrays[impl_sig] = esc_impl_sig
self.need_structs[impl_sig] = esc_impl_sig
def do_enum_values(self):
for error in self.errors.getElementsByTagNameNS(NS_TP, 'error'):
print ''
nick = error.getAttribute('name').replace(' ', '')
name = camelcase_to_upper(nick.replace('.', ''))
ns = error.parentNode.getAttribute('namespace')
enum = 'TP_ERROR_' + name
print ' /* ' + ns + '.' + name
print ' ' + get_docstring(error)
print ' */'
print ' { %s, "%s", "%s" },' % (enum, enum, nick)
def do_enum_values(self):
for error in self.errors.getElementsByTagNameNS(NS_TP, 'error'):
print ''
nick = error.getAttribute('name').replace(' ', '')
name = camelcase_to_upper(nick.replace('.', ''))
ns = error.parentNode.getAttribute('namespace')
enum = 'TP_ERROR_' + name
print ' /* ' + ns + '.' + name
print ' ' + get_docstring(error)
print ' */'
print ' { %s, "%s", "%s" },' % (enum, enum, nick)
def __call__(self):
errors = self.errors.getElementsByTagNameNS(NS_TP, 'error')
self.b('#include <telepathy-glib/errors.h>')
self.b('')
self.b('const gchar *')
self.b('tp_error_get_dbus_name (TpError error)')
self.b('{')
self.b(' switch (error)')
self.b(' {')
for error in errors:
ns = error.parentNode.getAttribute('namespace')
nick = error.getAttribute('name').replace(' ', '')
uc_nick = error.getAttribute('name').replace(' ', '_').replace(
'.', '_').upper()
name = 'TP_ERROR_STR_' + uc_nick
error_name = '%s.%s' % (ns, nick)
self.d('/**')
self.d(' * %s:' % name)
self.d(' *')
self.d(' * The D-Bus error name %s' % error_name)
self.d(' *')
self.d(' * %s' % xml_escape(get_docstring(error)))
self.d(' */')
self.d('')
self.h('#define %s "%s"' % (name, error_name))
self.b(' case TP_ERROR_%s:' % uc_nick)
self.b(' return %s;' % name)
self.b(' default:')
self.b(' g_return_val_if_reached (NULL);')
self.b(' }')
self.b('}')
# make both files end with a newline
self.h('')
self.b('')
file_set_contents(self.basename + '.h',
u('\n').join(self.__header).encode('utf-8'))
file_set_contents(self.basename + '.c',
u('\n').join(self.__body).encode('utf-8'))
file_set_contents(self.basename + '-gtk-doc.h',
u('\n').join(self.__docs).encode('utf-8'))
def __call__(self):
errors = self.errors.getElementsByTagNameNS(NS_TP, 'error')
self.b('#include <telepathy-glib/errors.h>')
self.b('')
self.b('const gchar *')
self.b('tp_error_get_dbus_name (TpError error)')
self.b('{')
self.b(' switch (error)')
self.b(' {')
for error in errors:
ns = error.parentNode.getAttribute('namespace')
nick = error.getAttribute('name').replace(' ', '')
uc_nick = error.getAttribute('name').replace(' ', '_').replace('.', '_').upper()
name = 'TP_ERROR_STR_' + uc_nick
error_name = '%s.%s' % (ns, nick)
self.d('/**')
self.d(' * %s:' % name)
self.d(' *')
self.d(' * The D-Bus error name %s' % error_name)
self.d(' *')
self.d(' * %s' % xml_escape(get_docstring(error)))
self.d(' */')
self.d('')
self.h('#define %s "%s"' % (name, error_name))
self.b(' case TP_ERROR_%s:' % uc_nick)
self.b(' return %s;' % name)
self.b(' default:')
self.b(' g_return_val_if_reached (NULL);')
self.b(' }')
self.b('}')
# make both files end with a newline
self.h('')
self.b('')
open(self.basename + '.h', 'w').write('\n'.join(self.__header))
open(self.basename + '.c', 'w').write('\n'.join(self.__body))
open(self.basename + '-gtk-doc.h', 'w').write('\n'.join(self.__docs))
def do_signal(self, iface, signal):
iface_lc = iface.lower()
member = signal.getAttribute('name')
member_lc = camelcase_to_lower(member)
member_uc = member_lc.upper()
arg_count = 0
args = []
out_args = []
for arg in signal.getElementsByTagName('arg'):
name = arg.getAttribute('name')
type = arg.getAttribute('type')
tp_type = arg.getAttribute('tp:type')
if not name:
name = 'arg%u' % arg_count
arg_count += 1
else:
name = 'arg_%s' % name
info = type_to_gtype(type)
args.append((name, info, tp_type, arg))
callback_name = ('%s_%s_signal_callback_%s' %
(self.prefix_lc, iface_lc, member_lc))
collect_name = ('_%s_%s_collect_args_of_%s' %
(self.prefix_lc, iface_lc, member_lc))
invoke_name = ('_%s_%s_invoke_callback_for_%s' %
(self.prefix_lc, iface_lc, member_lc))
# Example:
#
# typedef void (*tp_cli_connection_signal_callback_new_channel)
# (TpConnection *proxy, const gchar *arg_object_path,
# const gchar *arg_channel_type, guint arg_handle_type,
# guint arg_handle, gboolean arg_suppress_handler,
# gpointer user_data, GObject *weak_object);
self.b('/**')
self.b(' * %s:' % callback_name)
self.b(' * @proxy: The proxy on which %s_%s_connect_to_%s ()' %
(self.prefix_lc, iface_lc, member_lc))
self.b(' * was called')
for arg in args:
name, info, tp_type, elt = arg
ctype, gtype, marshaller, pointer = info
self.b(' * @%s: %s' %
(name, xml_escape(get_docstring(elt) or '(Undocumented)')))
self.b(' * @user_data: User-supplied data')
self.b(' * @weak_object: User-supplied weakly referenced object')
self.b(' *')
self.b(' * Represents the signature of a callback for the signal %s.' %
member)
self.b(' */')
self.h('typedef void (*%s) (%sproxy,' %
(callback_name, self.proxy_cls))
for arg in args:
name, info, tp_type, elt = arg
ctype, gtype, marshaller, pointer = info
const = pointer and 'const ' or ''
self.h(' %s%s%s,' % (const, ctype, name))
self.h(' gpointer user_data, GObject *weak_object);')
if args:
self.b('static void')
self.b('%s (DBusGProxy *proxy,' % collect_name)
for arg in args:
name, info, tp_type, elt = arg
ctype, gtype, marshaller, pointer = info
const = pointer and 'const ' or ''
self.b(' %s%s%s,' % (const, ctype, name))
self.b(' TpProxySignalConnection *sc)')
self.b('{')
self.b(' GValueArray *args = g_value_array_new (%d);' % len(args))
self.b(' GValue blank = { 0 };')
self.b(' guint i;')
self.b('')
self.b(' g_value_init (&blank, G_TYPE_INT);')
self.b('')
self.b(' for (i = 0; i < %d; i++)' % len(args))
self.b(' g_value_array_append (args, &blank);')
self.b('')
for i, arg in enumerate(args):
name, info, tp_type, elt = arg
ctype, gtype, marshaller, pointer = info
self.b(' g_value_unset (args->values + %d);' % i)
self.b(' g_value_init (args->values + %d, %s);' % (i, gtype))
if gtype == 'G_TYPE_STRING':
self.b(' g_value_set_string (args->values + %d, %s);' %
(i, name))
elif marshaller == 'BOXED':
self.b(' g_value_set_boxed (args->values + %d, %s);' %
(i, name))
elif gtype == 'G_TYPE_UCHAR':
self.b(' g_value_set_uchar (args->values + %d, %s);' %
(i, name))
elif gtype == 'G_TYPE_BOOLEAN':
self.b(' g_value_set_boolean (args->values + %d, %s);' %
(i, name))
elif gtype == 'G_TYPE_INT':
self.b(' g_value_set_int (args->values + %d, %s);' %
(i, name))
elif gtype == 'G_TYPE_UINT':
self.b(' g_value_set_uint (args->values + %d, %s);' %
(i, name))
elif gtype == 'G_TYPE_INT64':
self.b(' g_value_set_int (args->values + %d, %s);' %
(i, name))
elif gtype == 'G_TYPE_UINT64':
self.b(' g_value_set_uint (args->values + %d, %s);' %
(i, name))
elif gtype == 'G_TYPE_DOUBLE':
self.b(' g_value_set_double (args->values + %d, %s);' %
(i, name))
else:
assert False, ("Don't know how to put %s in a GValue" %
gtype)
self.b('')
self.b(' tp_proxy_signal_connection_v0_take_results (sc, args);')
self.b('}')
self.b('static void')
self.b('%s (TpProxy *tpproxy,' % invoke_name)
self.b(' GError *error,')
self.b(' GValueArray *args,')
self.b(' GCallback generic_callback,')
self.b(' gpointer user_data,')
self.b(' GObject *weak_object)')
self.b('{')
self.b(' %s callback =' % callback_name)
self.b(' (%s) generic_callback;' % callback_name)
self.b('')
self.b(' if (callback != NULL)')
self.b(' callback (g_object_ref (tpproxy),')
# FIXME: factor out into a function
for i, arg in enumerate(args):
name, info, tp_type, elt = arg
ctype, gtype, marshaller, pointer = info
if marshaller == 'BOXED':
self.b(' g_value_get_boxed (args->values + %d),' % i)
elif gtype == 'G_TYPE_STRING':
self.b(' g_value_get_string (args->values + %d),' % i)
elif gtype == 'G_TYPE_UCHAR':
self.b(' g_value_get_uchar (args->values + %d),' % i)
elif gtype == 'G_TYPE_BOOLEAN':
self.b(' g_value_get_boolean (args->values + %d),' % i)
elif gtype == 'G_TYPE_UINT':
self.b(' g_value_get_uint (args->values + %d),' % i)
elif gtype == 'G_TYPE_INT':
self.b(' g_value_get_int (args->values + %d),' % i)
elif gtype == 'G_TYPE_UINT64':
self.b(' g_value_get_uint64 (args->values + %d),' % i)
elif gtype == 'G_TYPE_INT64':
self.b(' g_value_get_int64 (args->values + %d),' % i)
elif gtype == 'G_TYPE_DOUBLE':
self.b(' g_value_get_double (args->values + %d),' % i)
else:
assert False, "Don't know how to get %s from a GValue" % gtype
self.b(' user_data,')
self.b(' weak_object);')
self.b('')
if len(args) > 0:
self.b(' g_value_array_free (args);')
else:
self.b(' if (args != NULL)')
self.b(' g_value_array_free (args);')
self.b('')
self.b(' g_object_unref (tpproxy);')
self.b('}')
# Example:
#
# TpProxySignalConnection *
# tp_cli_connection_connect_to_new_channel
# (TpConnection *proxy,
# tp_cli_connection_signal_callback_new_channel callback,
# gpointer user_data,
# GDestroyNotify destroy);
#
# destroy is invoked when the signal becomes disconnected. This
# is either because the signal has been disconnected explicitly
# by the user, because the TpProxy has become invalid and
# emitted the 'invalidated' signal, or because the weakly referenced
# object has gone away.
self.b('/**')
self.b(' * %s_%s_connect_to_%s:' %
(self.prefix_lc, iface_lc, member_lc))
self.b(' * @proxy: %s' % self.proxy_doc)
self.b(' * @callback: Callback to be called when the signal is')
self.b(' * received')
self.b(' * @user_data: User-supplied data for the callback')
self.b(' * @destroy: Destructor for the user-supplied data, which')
self.b(' * will be called when this signal is disconnected, or')
self.b(' * before this function returns %NULL')
self.b(' * @weak_object: A #GObject which will be weakly referenced; ')
self.b(' * if it is destroyed, this callback will automatically be')
self.b(' * disconnected')
self.b(' * @error: If not %NULL, used to raise an error if %NULL is')
self.b(' * returned')
self.b(' *')
self.b(' * Connect a handler to the signal %s.' % member)
self.b(' *')
self.b(' * %s' % xml_escape(get_docstring(signal) or '(Undocumented)'))
self.b(' *')
self.b(' * Returns: a #TpProxySignalConnection containing all of the')
self.b(' * above, which can be used to disconnect the signal; or')
self.b(' * %NULL if the proxy does not have the desired interface')
self.b(' * or has become invalid.')
self.b(' */')
self.h('TpProxySignalConnection *%s_%s_connect_to_%s (%sproxy,' %
(self.prefix_lc, iface_lc, member_lc, self.proxy_arg))
self.h(' %s callback,' % callback_name)
self.h(' gpointer user_data,')
self.h(' GDestroyNotify destroy,')
self.h(' GObject *weak_object,')
self.h(' GError **error);')
self.b('TpProxySignalConnection *')
self.b('%s_%s_connect_to_%s (%sproxy,' %
(self.prefix_lc, iface_lc, member_lc, self.proxy_arg))
self.b(' %s callback,' % callback_name)
self.b(' gpointer user_data,')
self.b(' GDestroyNotify destroy,')
self.b(' GObject *weak_object,')
self.b(' GError **error)')
self.b('{')
self.b(' GType expected_types[%d] = {' % (len(args) + 1))
for arg in args:
name, info, tp_type, elt = arg
ctype, gtype, marshaller, pointer = info
self.b(' %s,' % gtype)
self.b(' G_TYPE_INVALID };')
self.b('')
self.b(' g_return_val_if_fail (%s (proxy), NULL);' %
self.proxy_assert)
self.b(' g_return_val_if_fail (callback != NULL, NULL);')
self.b('')
self.b(
' return tp_proxy_signal_connection_v0_new ((TpProxy *) proxy,')
self.b(' %s, \"%s\",' % (self.get_iface_quark(), member))
self.b(' expected_types,')
if args:
self.b(' G_CALLBACK (%s),' % collect_name)
else:
self.b(' NULL, /* no args => no collector function */')
self.b(' %s,' % invoke_name)
self.b(' G_CALLBACK (callback), user_data, destroy,')
self.b(' weak_object, error);')
self.b('}')
self.b('')
self.h('')
def do_signal(self, iface, signal):
iface_lc = iface.lower()
member = signal.getAttribute('name')
member_lc = signal.getAttribute('tp:name-for-bindings')
if member != member_lc.replace('_', ''):
raise AssertionError('Signal %s tp:name-for-bindings (%s) does '
'not match' % (member, member_lc))
member_lc = member_lc.lower()
member_uc = member_lc.upper()
arg_count = 0
args = []
out_args = []
for arg in signal.getElementsByTagName('arg'):
name = arg.getAttribute('name')
type = arg.getAttribute('type')
tp_type = arg.getAttribute('tp:type')
if not name:
name = 'arg%u' % arg_count
arg_count += 1
else:
name = 'arg_%s' % name
info = type_to_gtype(type)
args.append((name, info, tp_type, arg))
callback_name = ('%s_%s_signal_callback_%s'
% (self.prefix_lc, iface_lc, member_lc))
collect_name = ('_%s_%s_collect_args_of_%s'
% (self.prefix_lc, iface_lc, member_lc))
invoke_name = ('_%s_%s_invoke_callback_for_%s'
% (self.prefix_lc, iface_lc, member_lc))
# Example:
#
# typedef void (*tp_cli_connection_signal_callback_new_channel)
# (TpConnection *proxy, const gchar *arg_object_path,
# const gchar *arg_channel_type, guint arg_handle_type,
# guint arg_handle, gboolean arg_suppress_handler,
# gpointer user_data, GObject *weak_object);
self.d('/**')
self.d(' * %s:' % callback_name)
self.d(' * @proxy: The proxy on which %s_%s_connect_to_%s ()'
% (self.prefix_lc, iface_lc, member_lc))
self.d(' * was called')
for arg in args:
name, info, tp_type, elt = arg
ctype, gtype, marshaller, pointer = info
docs = get_docstring(elt) or '(Undocumented)'
if ctype == 'guint ' and tp_type != '':
docs += ' (#%s)' % ('Tp' + tp_type.replace('_', ''))
self.d(' * @%s: %s' % (name, xml_escape(docs)))
self.d(' * @user_data: User-supplied data')
self.d(' * @weak_object: User-supplied weakly referenced object')
self.d(' *')
self.d(' * Represents the signature of a callback for the signal %s.'
% member)
self.d(' */')
self.d('')
self.h('typedef void (*%s) (%sproxy,'
% (callback_name, self.proxy_cls))
for arg in args:
name, info, tp_type, elt = arg
ctype, gtype, marshaller, pointer = info
const = pointer and 'const ' or ''
self.h(' %s%s%s,' % (const, ctype, name))
self.h(' gpointer user_data, GObject *weak_object);')
if args:
self.b('static void')
self.b('%s (DBusGProxy *proxy G_GNUC_UNUSED,' % collect_name)
for arg in args:
name, info, tp_type, elt = arg
ctype, gtype, marshaller, pointer = info
const = pointer and 'const ' or ''
self.b(' %s%s%s,' % (const, ctype, name))
self.b(' TpProxySignalConnection *sc)')
self.b('{')
self.b(' G_GNUC_BEGIN_IGNORE_DEPRECATIONS')
self.b(' GValueArray *args = g_value_array_new (%d);' % len(args))
self.b(' GValue blank = { 0 };')
self.b(' guint i;')
self.b('')
self.b(' g_value_init (&blank, G_TYPE_INT);')
self.b('')
self.b(' for (i = 0; i < %d; i++)' % len(args))
self.b(' g_value_array_append (args, &blank);')
self.b(' G_GNUC_END_IGNORE_DEPRECATIONS')
self.b('')
for i, arg in enumerate(args):
name, info, tp_type, elt = arg
ctype, gtype, marshaller, pointer = info
self.b(' g_value_unset (args->values + %d);' % i)
self.b(' g_value_init (args->values + %d, %s);' % (i, gtype))
self.b(' ' + copy_into_gvalue('args->values + %d' % i,
gtype, marshaller, name))
self.b('')
self.b(' tp_proxy_signal_connection_v0_take_results (sc, args);')
self.b('}')
self.b('static void')
self.b('%s (TpProxy *tpproxy,' % invoke_name)
self.b(' GError *error G_GNUC_UNUSED,')
self.b(' GValueArray *args,')
self.b(' GCallback generic_callback,')
self.b(' gpointer user_data,')
self.b(' GObject *weak_object)')
self.b('{')
self.b(' %s callback =' % callback_name)
self.b(' (%s) generic_callback;' % callback_name)
self.b('')
self.b(' if (callback != NULL)')
self.b(' callback (g_object_ref (tpproxy),')
# FIXME: factor out into a function
for i, arg in enumerate(args):
name, info, tp_type, elt = arg
ctype, gtype, marshaller, pointer = info
if marshaller == 'BOXED':
self.b(' g_value_get_boxed (args->values + %d),' % i)
elif gtype == 'G_TYPE_STRING':
self.b(' g_value_get_string (args->values + %d),' % i)
elif gtype == 'G_TYPE_UCHAR':
self.b(' g_value_get_uchar (args->values + %d),' % i)
elif gtype == 'G_TYPE_BOOLEAN':
self.b(' g_value_get_boolean (args->values + %d),' % i)
elif gtype == 'G_TYPE_UINT':
self.b(' g_value_get_uint (args->values + %d),' % i)
elif gtype == 'G_TYPE_INT':
self.b(' g_value_get_int (args->values + %d),' % i)
elif gtype == 'G_TYPE_UINT64':
self.b(' g_value_get_uint64 (args->values + %d),' % i)
elif gtype == 'G_TYPE_INT64':
self.b(' g_value_get_int64 (args->values + %d),' % i)
elif gtype == 'G_TYPE_DOUBLE':
self.b(' g_value_get_double (args->values + %d),' % i)
else:
assert False, "Don't know how to get %s from a GValue" % gtype
self.b(' user_data,')
self.b(' weak_object);')
self.b('')
self.b(' G_GNUC_BEGIN_IGNORE_DEPRECATIONS')
if len(args) > 0:
self.b(' g_value_array_free (args);')
else:
self.b(' if (args != NULL)')
self.b(' g_value_array_free (args);')
self.b('')
self.b(' G_GNUC_END_IGNORE_DEPRECATIONS')
self.b(' g_object_unref (tpproxy);')
self.b('}')
# Example:
#
# TpProxySignalConnection *
# tp_cli_connection_connect_to_new_channel
# (TpConnection *proxy,
# tp_cli_connection_signal_callback_new_channel callback,
# gpointer user_data,
# GDestroyNotify destroy);
#
# destroy is invoked when the signal becomes disconnected. This
# is either because the signal has been disconnected explicitly
# by the user, because the TpProxy has become invalid and
# emitted the 'invalidated' signal, or because the weakly referenced
# object has gone away.
self.d('/**')
self.d(' * %s_%s_connect_to_%s:'
% (self.prefix_lc, iface_lc, member_lc))
self.d(' * @proxy: %s' % self.proxy_doc)
self.d(' * @callback: Callback to be called when the signal is')
self.d(' * received')
self.d(' * @user_data: User-supplied data for the callback')
self.d(' * @destroy: Destructor for the user-supplied data, which')
self.d(' * will be called when this signal is disconnected, or')
self.d(' * before this function returns %NULL')
self.d(' * @weak_object: A #GObject which will be weakly referenced; ')
self.d(' * if it is destroyed, this callback will automatically be')
self.d(' * disconnected')
self.d(' * @error: If not %NULL, used to raise an error if %NULL is')
self.d(' * returned')
self.d(' *')
self.d(' * Connect a handler to the signal %s.' % member)
self.d(' *')
self.d(' * %s' % xml_escape(get_docstring(signal) or '(Undocumented)'))
self.d(' *')
self.d(' * Returns: a #TpProxySignalConnection containing all of the')
self.d(' * above, which can be used to disconnect the signal; or')
self.d(' * %NULL if the proxy does not have the desired interface')
self.d(' * or has become invalid.')
self.d(' */')
self.d('')
self.h('TpProxySignalConnection *%s_%s_connect_to_%s (%sproxy,'
% (self.prefix_lc, iface_lc, member_lc, self.proxy_arg))
self.h(' %s callback,' % callback_name)
self.h(' gpointer user_data,')
self.h(' GDestroyNotify destroy,')
self.h(' GObject *weak_object,')
self.h(' GError **error);')
self.h('')
self.b('TpProxySignalConnection *')
self.b('%s_%s_connect_to_%s (%sproxy,'
% (self.prefix_lc, iface_lc, member_lc, self.proxy_arg))
self.b(' %s callback,' % callback_name)
self.b(' gpointer user_data,')
self.b(' GDestroyNotify destroy,')
self.b(' GObject *weak_object,')
self.b(' GError **error)')
self.b('{')
self.b(' GType expected_types[%d] = {' % (len(args) + 1))
for arg in args:
name, info, tp_type, elt = arg
ctype, gtype, marshaller, pointer = info
self.b(' %s,' % gtype)
self.b(' G_TYPE_INVALID };')
self.b('')
self.b(' g_return_val_if_fail (%s (proxy), NULL);'
% self.proxy_assert)
self.b(' g_return_val_if_fail (callback != NULL, NULL);')
self.b('')
self.b(' return tp_proxy_signal_connection_v0_new ((TpProxy *) proxy,')
self.b(' %s, \"%s\",' % (self.get_iface_quark(), member))
self.b(' expected_types,')
if args:
self.b(' G_CALLBACK (%s),' % collect_name)
else:
self.b(' NULL, /* no args => no collector function */')
self.b(' %s,' % invoke_name)
self.b(' G_CALLBACK (callback), user_data, destroy,')
self.b(' weak_object, error);')
self.b('}')
self.b('')
def do_method(self, iface, method):
iface_lc = iface.lower()
member = method.getAttribute('name')
member_lc = camelcase_to_lower(member)
member_uc = member_lc.upper()
in_count = 0
ret_count = 0
in_args = []
out_args = []
for arg in method.getElementsByTagName('arg'):
name = arg.getAttribute('name')
direction = arg.getAttribute('direction')
type = arg.getAttribute('type')
tp_type = arg.getAttribute('tp:type')
if direction != 'out':
if not name:
name = 'in%u' % in_count
in_count += 1
else:
name = 'in_%s' % name
else:
if not name:
name = 'out%u' % ret_count
ret_count += 1
else:
name = 'out_%s' % name
info = type_to_gtype(type)
if direction != 'out':
in_args.append((name, info, tp_type, arg))
else:
out_args.append((name, info, tp_type, arg))
# Async reply callback type
# Example:
# void (*tp_cli_properties_interface_callback_for_get_properties)
# (TpProxy *proxy,
# const GPtrArray *out0,
# const GError *error,
# gpointer user_data,
# GObject *weak_object);
self.b('/**')
self.b(' * %s_%s_callback_for_%s:' %
(self.prefix_lc, iface_lc, member_lc))
self.b(' * @proxy: the proxy on which the call was made')
for arg in out_args:
name, info, tp_type, elt = arg
ctype, gtype, marshaller, pointer = info
self.b(' * @%s: Used to return an \'out\' argument if @error is '
'%%NULL: %s' %
(name, xml_escape(get_docstring(elt) or '(Undocumented)')))
self.b(' * @error: %NULL on success, or an error on failure')
self.b(' * @user_data: user-supplied data')
self.b(' * @weak_object: user-supplied object')
self.b(' *')
self.b(' * Signature of the callback called when a %s method call' %
member)
self.b(' * succeeds or fails.')
self.b(' */')
callback_name = '%s_%s_callback_for_%s' % (self.prefix_lc, iface_lc,
member_lc)
self.h('typedef void (*%s) (%sproxy,' %
(callback_name, self.proxy_cls))
for arg in out_args:
name, info, tp_type, elt = arg
ctype, gtype, marshaller, pointer = info
const = pointer and 'const ' or ''
self.h(' %s%s%s,' % (const, ctype, name))
self.h(' const GError *error, gpointer user_data,')
self.h(' GObject *weak_object);')
self.h('')
# Async callback implementation
invoke_callback = '_%s_%s_invoke_callback_%s' % (self.prefix_lc,
iface_lc, member_lc)
collect_callback = '_%s_%s_collect_callback_%s' % (self.prefix_lc,
iface_lc, member_lc)
# The callback called by dbus-glib; this ends the call and collects
# the results into a GValueArray.
self.b('static void')
self.b('%s (DBusGProxy *proxy,' % collect_callback)
self.b(' DBusGProxyCall *call,')
self.b(' gpointer user_data)')
self.b('{')
self.b(' GError *error = NULL;')
if len(out_args) > 0:
self.b(' GValueArray *args;')
self.b(' GValue blank = { 0 };')
self.b(' guint i;')
for arg in out_args:
name, info, tp_type, elt = arg
ctype, gtype, marshaller, pointer = info
# "We handle variants specially; the caller is expected to
# have already allocated storage for them". Thanks,
# dbus-glib...
if gtype == 'G_TYPE_VALUE':
self.b(' GValue *%s = g_new0 (GValue, 1);' % name)
else:
self.b(' %s%s;' % (ctype, name))
self.b('')
self.b(' dbus_g_proxy_end_call (proxy, call, &error,')
for arg in out_args:
name, info, tp_type, elt = arg
ctype, gtype, marshaller, pointer = info
if gtype == 'G_TYPE_VALUE':
self.b(' %s, %s,' % (gtype, name))
else:
self.b(' %s, &%s,' % (gtype, name))
self.b(' G_TYPE_INVALID);')
if len(out_args) == 0:
self.b(' tp_proxy_pending_call_v0_take_results (user_data, error,'
'NULL);')
else:
self.b('')
self.b(' if (error != NULL)')
self.b(' {')
self.b(
' tp_proxy_pending_call_v0_take_results (user_data, error,'
)
self.b(' NULL);')
for arg in out_args:
name, info, tp_type, elt = arg
ctype, gtype, marshaller, pointer = info
if gtype == 'G_TYPE_VALUE':
self.b(' g_free (%s);' % name)
self.b(' return;')
self.b(' }')
self.b('')
self.b(' args = g_value_array_new (%d);' % len(out_args))
self.b(' g_value_init (&blank, G_TYPE_INT);')
self.b('')
self.b(' for (i = 0; i < %d; i++)' % len(out_args))
self.b(' g_value_array_append (args, &blank);')
for i, arg in enumerate(out_args):
name, info, tp_type, elt = arg
ctype, gtype, marshaller, pointer = info
self.b('')
self.b(' g_value_unset (args->values + %d);' % i)
self.b(' g_value_init (args->values + %d, %s);' % (i, gtype))
if gtype == 'G_TYPE_STRING':
self.b(' g_value_take_string (args->values + %d, %s);' %
(i, name))
elif marshaller == 'BOXED':
self.b(' g_value_take_boxed (args->values + %d, %s);' %
(i, name))
elif gtype == 'G_TYPE_UCHAR':
self.b(' g_value_set_uchar (args->values + %d, %s);' %
(i, name))
elif gtype == 'G_TYPE_BOOLEAN':
self.b(' g_value_set_boolean (args->values + %d, %s);' %
(i, name))
elif gtype == 'G_TYPE_INT':
self.b(' g_value_set_int (args->values + %d, %s);' %
(i, name))
elif gtype == 'G_TYPE_UINT':
self.b(' g_value_set_uint (args->values + %d, %s);' %
(i, name))
elif gtype == 'G_TYPE_INT64':
self.b(' g_value_set_int (args->values + %d, %s);' %
(i, name))
elif gtype == 'G_TYPE_UINT64':
self.b(' g_value_set_uint (args->values + %d, %s);' %
(i, name))
elif gtype == 'G_TYPE_DOUBLE':
self.b(' g_value_set_double (args->values + %d, %s);' %
(i, name))
else:
assert False, ("Don't know how to put %s in a GValue" %
gtype)
self.b(' tp_proxy_pending_call_v0_take_results (user_data, '
'NULL, args);')
self.b('}')
self.b('static void')
self.b('%s (TpProxy *self,' % invoke_callback)
self.b(' GError *error,')
self.b(' GValueArray *args,')
self.b(' GCallback generic_callback,')
self.b(' gpointer user_data,')
self.b(' GObject *weak_object)')
self.b('{')
self.b(' %s callback = (%s) generic_callback;' %
(callback_name, callback_name))
self.b('')
self.b(' if (error != NULL)')
self.b(' {')
self.b(' callback ((%s) self,' % self.proxy_cls)
for arg in out_args:
name, info, tp_type, elt = arg
ctype, gtype, marshaller, pointer = info
if marshaller == 'BOXED' or pointer:
self.b(' NULL,')
elif gtype == 'G_TYPE_DOUBLE':
self.b(' 0.0,')
else:
self.b(' 0,')
self.b(' error, user_data, weak_object);')
self.b(' g_error_free (error);')
self.b(' return;')
self.b(' }')
self.b(' callback ((%s) self,' % self.proxy_cls)
# FIXME: factor out into a function
for i, arg in enumerate(out_args):
name, info, tp_type, elt = arg
ctype, gtype, marshaller, pointer = info
if marshaller == 'BOXED':
self.b(' g_value_get_boxed (args->values + %d),' % i)
elif gtype == 'G_TYPE_STRING':
self.b(' g_value_get_string (args->values + %d),' % i)
elif gtype == 'G_TYPE_UCHAR':
self.b(' g_value_get_uchar (args->values + %d),' % i)
elif gtype == 'G_TYPE_BOOLEAN':
self.b(' g_value_get_boolean (args->values + %d),' % i)
elif gtype == 'G_TYPE_UINT':
self.b(' g_value_get_uint (args->values + %d),' % i)
elif gtype == 'G_TYPE_INT':
self.b(' g_value_get_int (args->values + %d),' % i)
elif gtype == 'G_TYPE_UINT64':
self.b(' g_value_get_uint64 (args->values + %d),' % i)
elif gtype == 'G_TYPE_INT64':
self.b(' g_value_get_int64 (args->values + %d),' % i)
elif gtype == 'G_TYPE_DOUBLE':
self.b(' g_value_get_double (args->values + %d),' % i)
else:
assert False, "Don't know how to get %s from a GValue" % gtype
self.b(' error, user_data, weak_object);')
self.b('')
if len(out_args) > 0:
self.b(' g_value_array_free (args);')
else:
self.b(' if (args != NULL)')
self.b(' g_value_array_free (args);')
self.b('}')
self.b('')
# Async stub
# Example:
# TpProxyPendingCall *
# tp_cli_properties_interface_call_get_properties
# (gpointer proxy,
# gint timeout_ms,
# const GArray *in_properties,
# tp_cli_properties_interface_callback_for_get_properties callback,
# gpointer user_data,
# GDestroyNotify *destructor);
self.h('TpProxyPendingCall *%s_%s_call_%s (%sproxy,' %
(self.prefix_lc, iface_lc, member_lc, self.proxy_arg))
self.h(' gint timeout_ms,')
self.b('/**')
self.b(' * %s_%s_call_%s:' % (self.prefix_lc, iface_lc, member_lc))
self.b(' * @proxy: the #TpProxy')
self.b(' * @timeout_ms: the timeout in milliseconds, or -1 to use the')
self.b(' * default')
for arg in in_args:
name, info, tp_type, elt = arg
ctype, gtype, marshaller, pointer = info
self.b(' * @%s: Used to pass an \'in\' argument: %s' %
(name, xml_escape(get_docstring(elt) or '(Undocumented)')))
self.b(' * @callback: called when the method call succeeds or fails')
self.b(' * @user_data: user-supplied data passed to the callback')
self.b(' * @destroy: called with the user_data as argument, after the')
self.b(' * call has succeeded, failed or been cancelled')
self.b(' * @weak_object: A #GObject which will be weakly referenced; ')
self.b(' * if it is destroyed, this callback will automatically be')
self.b(' * disconnected')
self.b(' *')
self.b(' * Start a %s method call.' % member)
self.b(' *')
self.b(' * %s' % xml_escape(get_docstring(method) or '(Undocumented)'))
self.b(' *')
self.b(' * Returns: a #TpProxyPendingCall representing the call in')
self.b(' * progress. It is borrowed from the object, and will become')
self.b(' * invalid when the callback is called, the call is')
self.b(' * cancelled or the #TpProxy becomes invalid.')
self.b(' */')
self.b('TpProxyPendingCall *\n%s_%s_call_%s (%sproxy,' %
(self.prefix_lc, iface_lc, member_lc, self.proxy_arg))
self.b(' gint timeout_ms,')
for arg in in_args:
name, info, tp_type, elt = arg
ctype, gtype, marshaller, pointer = info
const = pointer and 'const ' or ''
self.h(' %s%s%s,' % (const, ctype, name))
self.b(' %s%s%s,' % (const, ctype, name))
self.h(' %s callback,' % callback_name)
self.h(' gpointer user_data,')
self.h(' GDestroyNotify destroy,')
self.h(' GObject *weak_object);')
self.h('')
self.b(' %s callback,' % callback_name)
self.b(' gpointer user_data,')
self.b(' GDestroyNotify destroy,')
self.b(' GObject *weak_object)')
self.b('{')
self.b(' GError *error = NULL;')
self.b(' GQuark interface = %s;' % self.get_iface_quark())
self.b(' DBusGProxy *iface;')
self.b('')
self.b(' g_return_val_if_fail (%s (proxy), NULL);' %
self.proxy_assert)
self.b('')
self.b(' iface = tp_proxy_borrow_interface_by_id (')
self.b(' (TpProxy *) proxy,')
self.b(' interface, &error);')
self.b('')
self.b(' if (iface == NULL)')
self.b(' {')
self.b(' if (callback != NULL)')
self.b(' callback (proxy,')
for arg in out_args:
name, info, tp_type, elt = arg
ctype, gtype, marshaller, pointer = info
if pointer:
self.b(' NULL,')
else:
self.b(' 0,')
self.b(' error, user_data, weak_object);')
self.b(' return NULL;')
self.b(' }')
self.b('')
self.b(' if (callback == NULL)')
self.b(' {')
self.b(' dbus_g_proxy_call_no_reply (iface, "%s",' % member)
for arg in in_args:
name, info, tp_type, elt = arg
ctype, gtype, marshaller, pointer = info
const = pointer and 'const ' or ''
self.b(' %s, %s,' % (gtype, name))
self.b(' G_TYPE_INVALID);')
self.b(' return NULL;')
self.b(' }')
self.b(' else')
self.b(' {')
self.b(' TpProxyPendingCall *data;')
self.b('')
self.b(' data = tp_proxy_pending_call_v0_new ((TpProxy *) proxy,')
self.b(' interface, "%s", iface,' % member)
self.b(' %s,' % invoke_callback)
self.b(' G_CALLBACK (callback), user_data, destroy,')
self.b(' weak_object, FALSE);')
self.b(' tp_proxy_pending_call_v0_take_pending_call (data,')
self.b(' dbus_g_proxy_begin_call_with_timeout (iface,')
self.b(' "%s",' % member)
self.b(' %s,' % collect_callback)
self.b(' data,')
self.b(' tp_proxy_pending_call_v0_completed,')
self.b(' timeout_ms,')
for arg in in_args:
name, info, tp_type, elt = arg
ctype, gtype, marshaller, pointer = info
const = pointer and 'const ' or ''
self.b(' %s, %s,' % (gtype, name))
self.b(' G_TYPE_INVALID));')
self.b('')
self.b(' return data;')
self.b(' }')
self.b('}')
self.b('')
# Reentrant blocking calls
# Example:
# gboolean tp_cli_properties_interface_run_get_properties
# (gpointer proxy,
# gint timeout_ms,
# const GArray *in_properties,
# GPtrArray **out0,
# GError **error,
# GMainLoop **loop);
self.b('typedef struct {')
self.b(' GMainLoop *loop;')
self.b(' GError **error;')
for arg in out_args:
name, info, tp_type, elt = arg
ctype, gtype, marshaller, pointer = info
self.b(' %s*%s;' % (ctype, name))
self.b(' gboolean success:1;')
self.b(' gboolean completed:1;')
self.b('} _%s_%s_run_state_%s;' %
(self.prefix_lc, iface_lc, member_lc))
reentrant_invoke = '_%s_%s_finish_running_%s' % (self.prefix_lc,
iface_lc, member_lc)
self.b('static void')
self.b('%s (TpProxy *self,' % reentrant_invoke)
self.b(' GError *error,')
self.b(' GValueArray *args,')
self.b(' GCallback unused,')
self.b(' gpointer user_data,')
self.b(' GObject *unused2)')
self.b('{')
self.b(' _%s_%s_run_state_%s *state = user_data;' %
(self.prefix_lc, iface_lc, member_lc))
self.b('')
self.b(' state->success = (error == NULL);')
self.b(' state->completed = TRUE;')
self.b(' g_main_loop_quit (state->loop);')
self.b('')
self.b(' if (error != NULL)')
self.b(' {')
self.b(' if (state->error != NULL)')
self.b(' *state->error = error;')
self.b(' else')
self.b(' g_error_free (error);')
self.b('')
self.b(' return;')
self.b(' }')
self.b('')
for i, arg in enumerate(out_args):
name, info, tp_type, elt = arg
ctype, gtype, marshaller, pointer = info
self.b(' if (state->%s != NULL)' % name)
if marshaller == 'BOXED':
self.b(' *state->%s = g_value_dup_boxed ('
'args->values + %d);' % (name, i))
elif marshaller == 'STRING':
self.b(' *state->%s = g_value_dup_string '
'(args->values + %d);' % (name, i))
elif marshaller in ('UCHAR', 'BOOLEAN', 'INT', 'UINT', 'INT64',
'UINT64', 'DOUBLE'):
self.b(' *state->%s = g_value_get_%s (args->values + %d);' %
(name, marshaller.lower(), i))
else:
assert False, "Don't know how to copy %s" % gtype
self.b('')
if len(out_args) > 0:
self.b(' g_value_array_free (args);')
else:
self.b(' if (args != NULL)')
self.b(' g_value_array_free (args);')
self.b('}')
self.b('')
self.h('gboolean %s_%s_run_%s (%sproxy,' %
(self.prefix_lc, iface_lc, member_lc, self.proxy_arg))
self.h(' gint timeout_ms,')
self.b('/**')
self.b(' * %s_%s_run_%s:' % (self.prefix_lc, iface_lc, member_lc))
self.b(' * @proxy: %s' % self.proxy_doc)
self.b(' * @timeout_ms: Timeout in milliseconds, or -1 for default')
for arg in in_args:
name, info, tp_type, elt = arg
ctype, gtype, marshaller, pointer = info
self.b(' * @%s: Used to pass an \'in\' argument: %s' %
(name, xml_escape(get_docstring(elt) or '(Undocumented)')))
for arg in out_args:
name, info, tp_type, elt = arg
ctype, gtype, marshaller, pointer = info
self.b(' * @%s: Used to return an \'out\' argument if %%TRUE is '
'returned: %s' %
(name, xml_escape(get_docstring(elt) or '(Undocumented)')))
self.b(' * @error: If not %NULL, used to return errors if %FALSE ')
self.b(' * is returned')
self.b(' * @loop: If not %NULL, set before re-entering ')
self.b(' * the main loop, to point to a #GMainLoop ')
self.b(' * which can be used to cancel this call with ')
self.b(' * g_main_loop_quit(), causing a return of ')
self.b(' * %FALSE with @error set to %TP_DBUS_ERROR_CANCELLED')
self.b(' *')
self.b(' * Call the method %s and run the main loop' % member)
self.b(' * until it returns. Before calling this method, you must')
self.b(' * add a reference to any borrowed objects you need to keep,')
self.b(' * and generally ensure that everything is in a consistent')
self.b(' * state.')
self.b(' *')
self.b(' * %s' % xml_escape(get_docstring(method) or '(Undocumented)'))
self.b(' *')
self.b(' * Returns: TRUE on success, FALSE and sets @error on error')
self.b(' */')
self.b('gboolean\n%s_%s_run_%s (%sproxy,' %
(self.prefix_lc, iface_lc, member_lc, self.proxy_arg))
self.b(' gint timeout_ms,')
for arg in in_args:
name, info, tp_type, elt = arg
ctype, gtype, marshaller, pointer = info
const = pointer and 'const ' or ''
self.h(' %s%s%s,' % (const, ctype, name))
self.b(' %s%s%s,' % (const, ctype, name))
for arg in out_args:
name, info, tp_type, elt = arg
ctype, gtype, marshaller, pointer = info
self.h(' %s*%s,' % (ctype, name))
self.b(' %s*%s,' % (ctype, name))
self.h(' GError **error,')
self.h(' GMainLoop **loop);')
self.h('')
self.b(' GError **error,')
self.b(' GMainLoop **loop)')
self.b('{')
self.b(' DBusGProxy *iface;')
self.b(' GQuark interface = %s;' % self.get_iface_quark())
self.b(' TpProxyPendingCall *pc;')
self.b(' _%s_%s_run_state_%s state = {' %
(self.prefix_lc, iface_lc, member_lc))
self.b(' NULL /* loop */, error,')
for arg in out_args:
name, info, tp_type, elt = arg
self.b(' %s,' % name)
self.b(' FALSE /* completed */, FALSE /* success */ };')
self.b('')
self.b(' g_return_val_if_fail (%s (proxy), FALSE);' %
self.proxy_assert)
self.b('')
self.b(' iface = tp_proxy_borrow_interface_by_id')
self.b(' ((TpProxy *) proxy, interface, error);')
self.b('')
self.b(' if (iface == NULL)')
self.b(' return FALSE;')
self.b('')
self.b(' state.loop = g_main_loop_new (NULL, FALSE);')
self.b('')
self.b(' pc = tp_proxy_pending_call_v0_new ((TpProxy *) proxy,')
self.b(' interface, "%s", iface,' % member)
self.b(' %s,' % reentrant_invoke)
self.b(' NULL, &state, NULL, NULL, TRUE);')
self.b('')
self.b(' if (loop != NULL)')
self.b(' *loop = state.loop;')
self.b('')
self.b(' tp_proxy_pending_call_v0_take_pending_call (pc,')
self.b(' dbus_g_proxy_begin_call_with_timeout (iface,')
self.b(' "%s",' % member)
self.b(' %s,' % collect_callback)
self.b(' pc,')
self.b(' tp_proxy_pending_call_v0_completed,')
self.b(' timeout_ms,')
for arg in in_args:
name, info, tp_type, elt = arg
ctype, gtype, marshaller, pointer = info
const = pointer and 'const ' or ''
self.b(' %s, %s,' % (gtype, name))
self.b(' G_TYPE_INVALID));')
self.b('')
self.b(' if (!state.completed)')
self.b(' g_main_loop_run (state.loop);')
self.b('')
self.b(' if (!state.completed)')
self.b(' tp_proxy_pending_call_cancel (pc);')
self.b('')
self.b(' if (loop != NULL)')
self.b(' *loop = NULL;')
self.b('')
self.b(' g_main_loop_unref (state.loop);')
self.b('')
self.b(' return state.success;')
self.b('}')
self.b('')
# leave a gap for the end of the method
self.b('')
self.h('')
def do_method_reentrant(self, method, iface_lc, member, member_lc, in_args,
out_args, collect_callback):
# Reentrant blocking calls
# Example:
# gboolean tp_cli_properties_interface_run_get_properties
# (gpointer proxy,
# gint timeout_ms,
# const GArray *in_properties,
# GPtrArray **out0,
# GError **error,
# GMainLoop **loop);
run_method_name = '%s_%s_run_%s' % (self.prefix_lc, iface_lc, member_lc)
if run_method_name not in self.reentrant_symbols:
return
self.b('typedef struct {')
self.b(' GMainLoop *loop;')
self.b(' GError **error;')
for arg in out_args:
name, info, tp_type, elt = arg
ctype, gtype, marshaller, pointer = info
self.b(' %s*%s;' % (ctype, name))
self.b(' unsigned success:1;')
self.b(' unsigned completed:1;')
self.b('} _%s_%s_run_state_%s;'
% (self.prefix_lc, iface_lc, member_lc))
reentrant_invoke = '_%s_%s_finish_running_%s' % (self.prefix_lc,
iface_lc,
member_lc)
self.b('static void')
self.b('%s (TpProxy *self G_GNUC_UNUSED,' % reentrant_invoke)
self.b(' GError *error,')
self.b(' GValueArray *args,')
self.b(' GCallback unused G_GNUC_UNUSED,')
self.b(' gpointer user_data G_GNUC_UNUSED,')
self.b(' GObject *unused2 G_GNUC_UNUSED)')
self.b('{')
self.b(' _%s_%s_run_state_%s *state = user_data;'
% (self.prefix_lc, iface_lc, member_lc))
self.b('')
self.b(' state->success = (error == NULL);')
self.b(' state->completed = TRUE;')
self.b(' g_main_loop_quit (state->loop);')
self.b('')
self.b(' if (error != NULL)')
self.b(' {')
self.b(' if (state->error != NULL)')
self.b(' *state->error = error;')
self.b(' else')
self.b(' g_error_free (error);')
self.b('')
self.b(' return;')
self.b(' }')
self.b('')
for i, arg in enumerate(out_args):
name, info, tp_type, elt = arg
ctype, gtype, marshaller, pointer = info
self.b(' if (state->%s != NULL)' % name)
if marshaller == 'BOXED':
self.b(' *state->%s = g_value_dup_boxed ('
'args->values + %d);' % (name, i))
elif marshaller == 'STRING':
self.b(' *state->%s = g_value_dup_string '
'(args->values + %d);' % (name, i))
elif marshaller in ('UCHAR', 'BOOLEAN', 'INT', 'UINT',
'INT64', 'UINT64', 'DOUBLE'):
self.b(' *state->%s = g_value_get_%s (args->values + %d);'
% (name, marshaller.lower(), i))
else:
assert False, "Don't know how to copy %s" % gtype
self.b('')
self.b(' G_GNUC_BEGIN_IGNORE_DEPRECATIONS')
if len(out_args) > 0:
self.b(' g_value_array_free (args);')
else:
self.b(' if (args != NULL)')
self.b(' g_value_array_free (args);')
self.b(' G_GNUC_END_IGNORE_DEPRECATIONS')
self.b('}')
self.b('')
if self.deprecate_reentrant:
self.h('#ifndef %s' % self.deprecate_reentrant)
self.h('gboolean %s (%sproxy,'
% (run_method_name, self.proxy_arg))
self.h(' gint timeout_ms,')
self.d('/**')
self.d(' * %s:' % run_method_name)
self.d(' * @proxy: %s' % self.proxy_doc)
self.d(' * @timeout_ms: Timeout in milliseconds, or -1 for default')
for arg in in_args:
name, info, tp_type, elt = arg
ctype, gtype, marshaller, pointer = info
docs = xml_escape(get_docstring(elt) or '(Undocumented)')
if ctype == 'guint ' and tp_type != '':
docs += ' (#%s)' % ('Tp' + tp_type.replace('_', ''))
self.d(' * @%s: Used to pass an \'in\' argument: %s'
% (name, docs))
for arg in out_args:
name, info, tp_type, elt = arg
ctype, gtype, marshaller, pointer = info
self.d(' * @%s: Used to return an \'out\' argument if %%TRUE is '
'returned: %s'
% (name, xml_escape(get_docstring(elt) or '(Undocumented)')))
self.d(' * @error: If not %NULL, used to return errors if %FALSE ')
self.d(' * is returned')
self.d(' * @loop: If not %NULL, set before re-entering ')
self.d(' * the main loop, to point to a #GMainLoop ')
self.d(' * which can be used to cancel this call with ')
self.d(' * g_main_loop_quit(), causing a return of ')
self.d(' * %FALSE with @error set to %TP_DBUS_ERROR_CANCELLED')
self.d(' *')
self.d(' * Call the method %s and run the main loop' % member)
self.d(' * until it returns. Before calling this method, you must')
self.d(' * add a reference to any borrowed objects you need to keep,')
self.d(' * and generally ensure that everything is in a consistent')
self.d(' * state.')
self.d(' *')
self.d(' * %s' % xml_escape(get_docstring(method) or '(Undocumented)'))
self.d(' *')
self.d(' * Returns: TRUE on success, FALSE and sets @error on error')
deprecated = method.getElementsByTagName('tp:deprecated')
if deprecated:
d = deprecated[0]
self.d(' *')
self.d(' * Deprecated: %s' % xml_escape(get_deprecated(d)))
self.d(' */')
self.d('')
self.b('gboolean\n%s (%sproxy,'
% (run_method_name, self.proxy_arg))
self.b(' gint timeout_ms,')
for arg in in_args:
name, info, tp_type, elt = arg
ctype, gtype, marshaller, pointer = info
const = pointer and 'const ' or ''
self.h(' %s%s%s,' % (const, ctype, name))
self.b(' %s%s%s,' % (const, ctype, name))
for arg in out_args:
name, info, tp_type, elt = arg
ctype, gtype, marshaller, pointer = info
self.h(' %s*%s,' % (ctype, name))
self.b(' %s*%s,' % (ctype, name))
self.h(' GError **error,')
if self.deprecate_reentrant:
self.h(' GMainLoop **loop) %s;' % self.deprecation_attribute)
self.h('#endif /* not %s */' % self.deprecate_reentrant)
else:
self.h(' GMainLoop **loop);')
self.h('')
self.b(' GError **error,')
self.b(' GMainLoop **loop)')
self.b('{')
self.b(' DBusGProxy *iface;')
self.b(' GQuark interface = %s;' % self.get_iface_quark())
self.b(' TpProxyPendingCall *pc;')
self.b(' _%s_%s_run_state_%s state = {'
% (self.prefix_lc, iface_lc, member_lc))
self.b(' NULL /* loop */, error,')
for arg in out_args:
name, info, tp_type, elt = arg
self.b(' %s,' % name)
self.b(' FALSE /* completed */, FALSE /* success */ };')
self.b('')
self.b(' g_return_val_if_fail (%s (proxy), FALSE);'
% self.proxy_assert)
self.b('')
self.b(' G_GNUC_BEGIN_IGNORE_DEPRECATIONS')
self.b(' iface = tp_proxy_borrow_interface_by_id')
self.b(' ((TpProxy *) proxy, interface, error);')
self.b(' G_GNUC_END_IGNORE_DEPRECATIONS')
self.b('')
self.b(' if (iface == NULL)')
self.b(' return FALSE;')
self.b('')
self.b(' state.loop = g_main_loop_new (NULL, FALSE);')
self.b('')
self.b(' pc = tp_proxy_pending_call_v0_new ((TpProxy *) proxy,')
self.b(' interface, "%s", iface,' % member)
self.b(' %s,' % reentrant_invoke)
self.b(' NULL, &state, NULL, NULL, TRUE);')
self.b('')
self.b(' if (loop != NULL)')
self.b(' *loop = state.loop;')
self.b('')
self.b(' tp_proxy_pending_call_v0_take_pending_call (pc,')
self.b(' dbus_g_proxy_begin_call_with_timeout (iface,')
self.b(' "%s",' % member)
self.b(' %s,' % collect_callback)
self.b(' pc,')
self.b(' tp_proxy_pending_call_v0_completed,')
self.b(' timeout_ms,')
for arg in in_args:
name, info, tp_type, elt = arg
ctype, gtype, marshaller, pointer = info
const = pointer and 'const ' or ''
self.b(' %s, %s,' % (gtype, name))
self.b(' G_TYPE_INVALID));')
self.b('')
self.b(' if (!state.completed)')
self.b(' g_main_loop_run (state.loop);')
self.b('')
self.b(' if (!state.completed)')
self.b(' tp_proxy_pending_call_cancel (pc);')
self.b('')
self.b(' if (loop != NULL)')
self.b(' *loop = NULL;')
self.b('')
self.b(' g_main_loop_unref (state.loop);')
self.b('')
self.b(' return state.success;')
self.b('}')
self.b('')
def do_method(self, iface, method):
iface_lc = iface.lower()
member = method.getAttribute('name')
member_lc = method.getAttribute('tp:name-for-bindings')
if member != member_lc.replace('_', ''):
raise AssertionError('Method %s tp:name-for-bindings (%s) does '
'not match' % (member, member_lc))
member_lc = member_lc.lower()
member_uc = member_lc.upper()
in_count = 0
ret_count = 0
in_args = []
out_args = []
for arg in method.getElementsByTagName('arg'):
name = arg.getAttribute('name')
direction = arg.getAttribute('direction')
type = arg.getAttribute('type')
tp_type = arg.getAttribute('tp:type')
if direction != 'out':
if not name:
name = 'in%u' % in_count
in_count += 1
else:
name = 'in_%s' % name
else:
if not name:
name = 'out%u' % ret_count
ret_count += 1
else:
name = 'out_%s' % name
info = type_to_gtype(type)
if direction != 'out':
in_args.append((name, info, tp_type, arg))
else:
out_args.append((name, info, tp_type, arg))
# Async reply callback type
# Example:
# void (*tp_cli_properties_interface_callback_for_get_properties)
# (TpProxy *proxy,
# const GPtrArray *out0,
# const GError *error,
# gpointer user_data,
# GObject *weak_object);
self.d('/**')
self.d(' * %s_%s_callback_for_%s:'
% (self.prefix_lc, iface_lc, member_lc))
self.d(' * @proxy: the proxy on which the call was made')
for arg in out_args:
name, info, tp_type, elt = arg
ctype, gtype, marshaller, pointer = info
docs = xml_escape(get_docstring(elt) or '(Undocumented)')
if ctype == 'guint ' and tp_type != '':
docs += ' (#%s)' % ('Tp' + tp_type.replace('_', ''))
self.d(' * @%s: Used to return an \'out\' argument if @error is '
'%%NULL: %s'
% (name, docs))
self.d(' * @error: %NULL on success, or an error on failure')
self.d(' * @user_data: user-supplied data')
self.d(' * @weak_object: user-supplied object')
self.d(' *')
self.d(' * Signature of the callback called when a %s method call'
% member)
self.d(' * succeeds or fails.')
deprecated = method.getElementsByTagName('tp:deprecated')
if deprecated:
d = deprecated[0]
self.d(' *')
self.d(' * Deprecated: %s' % xml_escape(get_deprecated(d)))
self.d(' */')
self.d('')
callback_name = '%s_%s_callback_for_%s' % (self.prefix_lc, iface_lc,
member_lc)
self.h('typedef void (*%s) (%sproxy,'
% (callback_name, self.proxy_cls))
for arg in out_args:
name, info, tp_type, elt = arg
ctype, gtype, marshaller, pointer = info
const = pointer and 'const ' or ''
self.h(' %s%s%s,' % (const, ctype, name))
self.h(' const GError *error, gpointer user_data,')
self.h(' GObject *weak_object);')
self.h('')
# Async callback implementation
invoke_callback = '_%s_%s_invoke_callback_%s' % (self.prefix_lc,
iface_lc,
member_lc)
collect_callback = '_%s_%s_collect_callback_%s' % (self.prefix_lc,
iface_lc,
member_lc)
# The callback called by dbus-glib; this ends the call and collects
# the results into a GValueArray.
self.b('static void')
self.b('%s (DBusGProxy *proxy,' % collect_callback)
self.b(' DBusGProxyCall *call,')
self.b(' gpointer user_data)')
self.b('{')
self.b(' GError *error = NULL;')
if len(out_args) > 0:
self.b(' GValueArray *args;')
self.b(' GValue blank = { 0 };')
self.b(' guint i;')
for arg in out_args:
name, info, tp_type, elt = arg
ctype, gtype, marshaller, pointer = info
# "We handle variants specially; the caller is expected to
# have already allocated storage for them". Thanks,
# dbus-glib...
if gtype == 'G_TYPE_VALUE':
self.b(' GValue *%s = g_new0 (GValue, 1);' % name)
else:
self.b(' %s%s;' % (ctype, name))
self.b('')
self.b(' dbus_g_proxy_end_call (proxy, call, &error,')
for arg in out_args:
name, info, tp_type, elt = arg
ctype, gtype, marshaller, pointer = info
if gtype == 'G_TYPE_VALUE':
self.b(' %s, %s,' % (gtype, name))
else:
self.b(' %s, &%s,' % (gtype, name))
self.b(' G_TYPE_INVALID);')
if len(out_args) == 0:
self.b(' tp_proxy_pending_call_v0_take_results (user_data, error,'
'NULL);')
else:
self.b('')
self.b(' if (error != NULL)')
self.b(' {')
self.b(' tp_proxy_pending_call_v0_take_results (user_data, error,')
self.b(' NULL);')
for arg in out_args:
name, info, tp_type, elt = arg
ctype, gtype, marshaller, pointer = info
if gtype == 'G_TYPE_VALUE':
self.b(' g_free (%s);' % name)
self.b(' return;')
self.b(' }')
self.b('')
self.b(' G_GNUC_BEGIN_IGNORE_DEPRECATIONS')
self.b(' args = g_value_array_new (%d);' % len(out_args))
self.b(' g_value_init (&blank, G_TYPE_INT);')
self.b('')
self.b(' for (i = 0; i < %d; i++)' % len(out_args))
self.b(' g_value_array_append (args, &blank);')
self.b(' G_GNUC_END_IGNORE_DEPRECATIONS')
for i, arg in enumerate(out_args):
name, info, tp_type, elt = arg
ctype, gtype, marshaller, pointer = info
self.b('')
self.b(' g_value_unset (args->values + %d);' % i)
self.b(' g_value_init (args->values + %d, %s);' % (i, gtype))
self.b(' ' + move_into_gvalue('args->values + %d' % i,
gtype, marshaller, name))
self.b(' tp_proxy_pending_call_v0_take_results (user_data, '
'NULL, args);')
self.b('}')
self.b('static void')
self.b('%s (TpProxy *self,' % invoke_callback)
self.b(' GError *error,')
self.b(' GValueArray *args,')
self.b(' GCallback generic_callback,')
self.b(' gpointer user_data,')
self.b(' GObject *weak_object)')
self.b('{')
self.b(' %s callback = (%s) generic_callback;'
% (callback_name, callback_name))
self.b('')
self.b(' if (error != NULL)')
self.b(' {')
self.b(' callback ((%s) self,' % self.proxy_cls)
for arg in out_args:
name, info, tp_type, elt = arg
ctype, gtype, marshaller, pointer = info
if marshaller == 'BOXED' or pointer:
self.b(' NULL,')
elif gtype == 'G_TYPE_DOUBLE':
self.b(' 0.0,')
else:
self.b(' 0,')
self.b(' error, user_data, weak_object);')
self.b(' g_error_free (error);')
self.b(' return;')
self.b(' }')
self.b(' callback ((%s) self,' % self.proxy_cls)
# FIXME: factor out into a function
for i, arg in enumerate(out_args):
name, info, tp_type, elt = arg
ctype, gtype, marshaller, pointer = info
if marshaller == 'BOXED':
self.b(' g_value_get_boxed (args->values + %d),' % i)
elif gtype == 'G_TYPE_STRING':
self.b(' g_value_get_string (args->values + %d),' % i)
elif gtype == 'G_TYPE_UCHAR':
self.b(' g_value_get_uchar (args->values + %d),' % i)
elif gtype == 'G_TYPE_BOOLEAN':
self.b(' g_value_get_boolean (args->values + %d),' % i)
elif gtype == 'G_TYPE_UINT':
self.b(' g_value_get_uint (args->values + %d),' % i)
elif gtype == 'G_TYPE_INT':
self.b(' g_value_get_int (args->values + %d),' % i)
elif gtype == 'G_TYPE_UINT64':
self.b(' g_value_get_uint64 (args->values + %d),' % i)
elif gtype == 'G_TYPE_INT64':
self.b(' g_value_get_int64 (args->values + %d),' % i)
elif gtype == 'G_TYPE_DOUBLE':
self.b(' g_value_get_double (args->values + %d),' % i)
else:
assert False, "Don't know how to get %s from a GValue" % gtype
self.b(' error, user_data, weak_object);')
self.b('')
self.b(' G_GNUC_BEGIN_IGNORE_DEPRECATIONS')
if len(out_args) > 0:
self.b(' g_value_array_free (args);')
else:
self.b(' if (args != NULL)')
self.b(' g_value_array_free (args);')
self.b(' G_GNUC_END_IGNORE_DEPRECATIONS')
self.b('}')
self.b('')
# Async stub
# Example:
# TpProxyPendingCall *
# tp_cli_properties_interface_call_get_properties
# (gpointer proxy,
# gint timeout_ms,
# const GArray *in_properties,
# tp_cli_properties_interface_callback_for_get_properties callback,
# gpointer user_data,
# GDestroyNotify *destructor);
self.h('TpProxyPendingCall *%s_%s_call_%s (%sproxy,'
% (self.prefix_lc, iface_lc, member_lc, self.proxy_arg))
self.h(' gint timeout_ms,')
self.d('/**')
self.d(' * %s_%s_call_%s:'
% (self.prefix_lc, iface_lc, member_lc))
self.d(' * @proxy: the #TpProxy')
self.d(' * @timeout_ms: the timeout in milliseconds, or -1 to use the')
self.d(' * default')
for arg in in_args:
name, info, tp_type, elt = arg
ctype, gtype, marshaller, pointer = info
docs = xml_escape(get_docstring(elt) or '(Undocumented)')
if ctype == 'guint ' and tp_type != '':
docs += ' (#%s)' % ('Tp' + tp_type.replace('_', ''))
self.d(' * @%s: Used to pass an \'in\' argument: %s'
% (name, docs))
self.d(' * @callback: called when the method call succeeds or fails;')
self.d(' * may be %NULL to make a "fire and forget" call with no ')
self.d(' * reply tracking')
self.d(' * @user_data: user-supplied data passed to the callback;')
self.d(' * must be %NULL if @callback is %NULL')
self.d(' * @destroy: called with the user_data as argument, after the')
self.d(' * call has succeeded, failed or been cancelled;')
self.d(' * must be %NULL if @callback is %NULL')
self.d(' * @weak_object: If not %NULL, a #GObject which will be ')
self.d(' * weakly referenced; if it is destroyed, this call ')
self.d(' * will automatically be cancelled. Must be %NULL if ')
self.d(' * @callback is %NULL')
self.d(' *')
self.d(' * Start a %s method call.' % member)
self.d(' *')
self.d(' * %s' % xml_escape(get_docstring(method) or '(Undocumented)'))
self.d(' *')
self.d(' * Returns: a #TpProxyPendingCall representing the call in')
self.d(' * progress. It is borrowed from the object, and will become')
self.d(' * invalid when the callback is called, the call is')
self.d(' * cancelled or the #TpProxy becomes invalid.')
deprecated = method.getElementsByTagName('tp:deprecated')
if deprecated:
d = deprecated[0]
self.d(' *')
self.d(' * Deprecated: %s' % xml_escape(get_deprecated(d)))
self.d(' */')
self.d('')
self.b('TpProxyPendingCall *\n%s_%s_call_%s (%sproxy,'
% (self.prefix_lc, iface_lc, member_lc, self.proxy_arg))
self.b(' gint timeout_ms,')
for arg in in_args:
name, info, tp_type, elt = arg
ctype, gtype, marshaller, pointer = info
const = pointer and 'const ' or ''
self.h(' %s%s%s,' % (const, ctype, name))
self.b(' %s%s%s,' % (const, ctype, name))
self.h(' %s callback,' % callback_name)
self.h(' gpointer user_data,')
self.h(' GDestroyNotify destroy,')
self.h(' GObject *weak_object);')
self.h('')
self.b(' %s callback,' % callback_name)
self.b(' gpointer user_data,')
self.b(' GDestroyNotify destroy,')
self.b(' GObject *weak_object)')
self.b('{')
self.b(' GError *error = NULL;')
self.b(' GQuark interface = %s;' % self.get_iface_quark())
self.b(' DBusGProxy *iface;')
self.b('')
self.b(' g_return_val_if_fail (%s (proxy), NULL);'
% self.proxy_assert)
self.b(' g_return_val_if_fail (callback != NULL || '
'user_data == NULL, NULL);')
self.b(' g_return_val_if_fail (callback != NULL || '
'destroy == NULL, NULL);')
self.b(' g_return_val_if_fail (callback != NULL || '
'weak_object == NULL, NULL);')
self.b('')
self.b(' G_GNUC_BEGIN_IGNORE_DEPRECATIONS')
self.b(' iface = tp_proxy_borrow_interface_by_id (')
self.b(' (TpProxy *) proxy,')
self.b(' interface, &error);')
self.b(' G_GNUC_END_IGNORE_DEPRECATIONS')
self.b('')
self.b(' if (iface == NULL)')
self.b(' {')
self.b(' if (callback != NULL)')
self.b(' callback (proxy,')
for arg in out_args:
name, info, tp_type, elt = arg
ctype, gtype, marshaller, pointer = info
if pointer:
self.b(' NULL,')
else:
self.b(' 0,')
self.b(' error, user_data, weak_object);')
self.b('')
self.b(' if (destroy != NULL)')
self.b(' destroy (user_data);')
self.b('')
self.b(' g_error_free (error);')
self.b(' return NULL;')
self.b(' }')
self.b('')
self.b(' if (callback == NULL)')
self.b(' {')
self.b(' dbus_g_proxy_call_no_reply (iface, "%s",' % member)
for arg in in_args:
name, info, tp_type, elt = arg
ctype, gtype, marshaller, pointer = info
const = pointer and 'const ' or ''
self.b(' %s, %s,' % (gtype, name))
self.b(' G_TYPE_INVALID);')
self.b(' return NULL;')
self.b(' }')
self.b(' else')
self.b(' {')
self.b(' TpProxyPendingCall *data;')
self.b('')
self.b(' data = tp_proxy_pending_call_v0_new ((TpProxy *) proxy,')
self.b(' interface, "%s", iface,' % member)
self.b(' %s,' % invoke_callback)
self.b(' G_CALLBACK (callback), user_data, destroy,')
self.b(' weak_object, FALSE);')
self.b(' tp_proxy_pending_call_v0_take_pending_call (data,')
self.b(' dbus_g_proxy_begin_call_with_timeout (iface,')
self.b(' "%s",' % member)
self.b(' %s,' % collect_callback)
self.b(' data,')
self.b(' tp_proxy_pending_call_v0_completed,')
self.b(' timeout_ms,')
for arg in in_args:
name, info, tp_type, elt = arg
ctype, gtype, marshaller, pointer = info
const = pointer and 'const ' or ''
self.b(' %s, %s,' % (gtype, name))
self.b(' G_TYPE_INVALID));')
self.b('')
self.b(' return data;')
self.b(' }')
self.b('}')
self.b('')
self.do_method_reentrant(method, iface_lc, member, member_lc,
in_args, out_args, collect_callback)
# leave a gap for the end of the method
self.d('')
self.b('')
self.h('')
def do_method(self, iface, method):
iface_lc = iface.lower()
member = method.getAttribute('name')
member_lc = camelcase_to_lower(member)
member_uc = member_lc.upper()
in_count = 0
ret_count = 0
in_args = []
out_args = []
for arg in method.getElementsByTagName('arg'):
name = arg.getAttribute('name')
direction = arg.getAttribute('direction')
type = arg.getAttribute('type')
tp_type = arg.getAttribute('tp:type')
if direction != 'out':
if not name:
name = 'in%u' % in_count
in_count += 1
else:
name = 'in_%s' % name
else:
if not name:
name = 'out%u' % ret_count
ret_count += 1
else:
name = 'out_%s' % name
info = type_to_gtype(type)
if direction != 'out':
in_args.append((name, info, tp_type, arg))
else:
out_args.append((name, info, tp_type, arg))
# Async reply callback type
# Example:
# void (*tp_cli_properties_interface_callback_for_get_properties)
# (TpProxy *proxy,
# const GPtrArray *out0,
# const GError *error,
# gpointer user_data,
# GObject *weak_object);
self.b('/**')
self.b(' * %s_%s_callback_for_%s:'
% (self.prefix_lc, iface_lc, member_lc))
self.b(' * @proxy: the proxy on which the call was made')
for arg in out_args:
name, info, tp_type, elt = arg
ctype, gtype, marshaller, pointer = info
self.b(' * @%s: Used to return an \'out\' argument if @error is '
'%%NULL: %s'
% (name, xml_escape(get_docstring(elt) or '(Undocumented)')))
self.b(' * @error: %NULL on success, or an error on failure')
self.b(' * @user_data: user-supplied data')
self.b(' * @weak_object: user-supplied object')
self.b(' *')
self.b(' * Signature of the callback called when a %s method call'
% member)
self.b(' * succeeds or fails.')
self.b(' */')
callback_name = '%s_%s_callback_for_%s' % (self.prefix_lc, iface_lc,
member_lc)
self.h('typedef void (*%s) (%sproxy,'
% (callback_name, self.proxy_cls))
for arg in out_args:
name, info, tp_type, elt = arg
ctype, gtype, marshaller, pointer = info
const = pointer and 'const ' or ''
self.h(' %s%s%s,' % (const, ctype, name))
self.h(' const GError *error, gpointer user_data,')
self.h(' GObject *weak_object);')
self.h('')
# Async callback implementation
invoke_callback = '_%s_%s_invoke_callback_%s' % (self.prefix_lc,
iface_lc,
member_lc)
collect_callback = '_%s_%s_collect_callback_%s' % (self.prefix_lc,
iface_lc,
member_lc)
# The callback called by dbus-glib; this ends the call and collects
# the results into a GValueArray.
self.b('static void')
self.b('%s (DBusGProxy *proxy,' % collect_callback)
self.b(' DBusGProxyCall *call,')
self.b(' gpointer user_data)')
self.b('{')
self.b(' GError *error = NULL;')
if len(out_args) > 0:
self.b(' GValueArray *args;')
self.b(' GValue blank = { 0 };')
self.b(' guint i;')
for arg in out_args:
name, info, tp_type, elt = arg
ctype, gtype, marshaller, pointer = info
# "We handle variants specially; the caller is expected to
# have already allocated storage for them". Thanks,
# dbus-glib...
if gtype == 'G_TYPE_VALUE':
self.b(' GValue *%s = g_new0 (GValue, 1);' % name)
else:
self.b(' %s%s;' % (ctype, name))
self.b('')
self.b(' dbus_g_proxy_end_call (proxy, call, &error,')
for arg in out_args:
name, info, tp_type, elt = arg
ctype, gtype, marshaller, pointer = info
if gtype == 'G_TYPE_VALUE':
self.b(' %s, %s,' % (gtype, name))
else:
self.b(' %s, &%s,' % (gtype, name))
self.b(' G_TYPE_INVALID);')
if len(out_args) == 0:
self.b(' tp_proxy_pending_call_v0_take_results (user_data, error,'
'NULL);')
else:
self.b('')
self.b(' if (error != NULL)')
self.b(' {')
self.b(' tp_proxy_pending_call_v0_take_results (user_data, error,')
self.b(' NULL);')
for arg in out_args:
name, info, tp_type, elt = arg
ctype, gtype, marshaller, pointer = info
if gtype == 'G_TYPE_VALUE':
self.b(' g_free (%s);' % name)
self.b(' return;')
self.b(' }')
self.b('')
self.b(' args = g_value_array_new (%d);' % len(out_args))
self.b(' g_value_init (&blank, G_TYPE_INT);')
self.b('')
self.b(' for (i = 0; i < %d; i++)' % len(out_args))
self.b(' g_value_array_append (args, &blank);')
for i, arg in enumerate(out_args):
name, info, tp_type, elt = arg
ctype, gtype, marshaller, pointer = info
self.b('')
self.b(' g_value_unset (args->values + %d);' % i)
self.b(' g_value_init (args->values + %d, %s);' % (i, gtype))
if gtype == 'G_TYPE_STRING':
self.b(' g_value_take_string (args->values + %d, %s);'
% (i, name))
elif marshaller == 'BOXED':
self.b(' g_value_take_boxed (args->values + %d, %s);'
% (i, name))
elif gtype == 'G_TYPE_UCHAR':
self.b(' g_value_set_uchar (args->values + %d, %s);'
% (i, name))
elif gtype == 'G_TYPE_BOOLEAN':
self.b(' g_value_set_boolean (args->values + %d, %s);'
% (i, name))
elif gtype == 'G_TYPE_INT':
self.b(' g_value_set_int (args->values + %d, %s);'
% (i, name))
elif gtype == 'G_TYPE_UINT':
self.b(' g_value_set_uint (args->values + %d, %s);'
% (i, name))
elif gtype == 'G_TYPE_INT64':
self.b(' g_value_set_int (args->values + %d, %s);'
% (i, name))
elif gtype == 'G_TYPE_UINT64':
self.b(' g_value_set_uint (args->values + %d, %s);'
% (i, name))
elif gtype == 'G_TYPE_DOUBLE':
self.b(' g_value_set_double (args->values + %d, %s);'
% (i, name))
else:
assert False, ("Don't know how to put %s in a GValue"
% gtype)
self.b(' tp_proxy_pending_call_v0_take_results (user_data, '
'NULL, args);')
self.b('}')
self.b('static void')
self.b('%s (TpProxy *self,' % invoke_callback)
self.b(' GError *error,')
self.b(' GValueArray *args,')
self.b(' GCallback generic_callback,')
self.b(' gpointer user_data,')
self.b(' GObject *weak_object)')
self.b('{')
self.b(' %s callback = (%s) generic_callback;'
% (callback_name, callback_name))
self.b('')
self.b(' if (error != NULL)')
self.b(' {')
self.b(' callback ((%s) self,' % self.proxy_cls)
for arg in out_args:
name, info, tp_type, elt = arg
ctype, gtype, marshaller, pointer = info
if marshaller == 'BOXED' or pointer:
self.b(' NULL,')
elif gtype == 'G_TYPE_DOUBLE':
self.b(' 0.0,')
else:
self.b(' 0,')
self.b(' error, user_data, weak_object);')
self.b(' g_error_free (error);')
self.b(' return;')
self.b(' }')
self.b(' callback ((%s) self,' % self.proxy_cls)
# FIXME: factor out into a function
for i, arg in enumerate(out_args):
name, info, tp_type, elt = arg
ctype, gtype, marshaller, pointer = info
if marshaller == 'BOXED':
self.b(' g_value_get_boxed (args->values + %d),' % i)
elif gtype == 'G_TYPE_STRING':
self.b(' g_value_get_string (args->values + %d),' % i)
elif gtype == 'G_TYPE_UCHAR':
self.b(' g_value_get_uchar (args->values + %d),' % i)
elif gtype == 'G_TYPE_BOOLEAN':
self.b(' g_value_get_boolean (args->values + %d),' % i)
elif gtype == 'G_TYPE_UINT':
self.b(' g_value_get_uint (args->values + %d),' % i)
elif gtype == 'G_TYPE_INT':
self.b(' g_value_get_int (args->values + %d),' % i)
elif gtype == 'G_TYPE_UINT64':
self.b(' g_value_get_uint64 (args->values + %d),' % i)
elif gtype == 'G_TYPE_INT64':
self.b(' g_value_get_int64 (args->values + %d),' % i)
elif gtype == 'G_TYPE_DOUBLE':
self.b(' g_value_get_double (args->values + %d),' % i)
else:
assert False, "Don't know how to get %s from a GValue" % gtype
self.b(' error, user_data, weak_object);')
self.b('')
if len(out_args) > 0:
self.b(' g_value_array_free (args);')
else:
self.b(' if (args != NULL)')
self.b(' g_value_array_free (args);')
self.b('}')
self.b('')
# Async stub
# Example:
# TpProxyPendingCall *
# tp_cli_properties_interface_call_get_properties
# (gpointer proxy,
# gint timeout_ms,
# const GArray *in_properties,
# tp_cli_properties_interface_callback_for_get_properties callback,
# gpointer user_data,
# GDestroyNotify *destructor);
self.h('TpProxyPendingCall *%s_%s_call_%s (%sproxy,'
% (self.prefix_lc, iface_lc, member_lc, self.proxy_arg))
self.h(' gint timeout_ms,')
self.b('/**')
self.b(' * %s_%s_call_%s:'
% (self.prefix_lc, iface_lc, member_lc))
self.b(' * @proxy: the #TpProxy')
self.b(' * @timeout_ms: the timeout in milliseconds, or -1 to use the')
self.b(' * default')
for arg in in_args:
name, info, tp_type, elt = arg
ctype, gtype, marshaller, pointer = info
self.b(' * @%s: Used to pass an \'in\' argument: %s'
% (name, xml_escape(get_docstring(elt) or '(Undocumented)')))
self.b(' * @callback: called when the method call succeeds or fails')
self.b(' * @user_data: user-supplied data passed to the callback')
self.b(' * @destroy: called with the user_data as argument, after the')
self.b(' * call has succeeded, failed or been cancelled')
self.b(' * @weak_object: A #GObject which will be weakly referenced; ')
self.b(' * if it is destroyed, this callback will automatically be')
self.b(' * disconnected')
self.b(' *')
self.b(' * Start a %s method call.' % member)
self.b(' *')
self.b(' * %s' % xml_escape(get_docstring(method) or '(Undocumented)'))
self.b(' *')
self.b(' * Returns: a #TpProxyPendingCall representing the call in')
self.b(' * progress. It is borrowed from the object, and will become')
self.b(' * invalid when the callback is called, the call is')
self.b(' * cancelled or the #TpProxy becomes invalid.')
self.b(' */')
self.b('TpProxyPendingCall *\n%s_%s_call_%s (%sproxy,'
% (self.prefix_lc, iface_lc, member_lc, self.proxy_arg))
self.b(' gint timeout_ms,')
for arg in in_args:
name, info, tp_type, elt = arg
ctype, gtype, marshaller, pointer = info
const = pointer and 'const ' or ''
self.h(' %s%s%s,' % (const, ctype, name))
self.b(' %s%s%s,' % (const, ctype, name))
self.h(' %s callback,' % callback_name)
self.h(' gpointer user_data,')
self.h(' GDestroyNotify destroy,')
self.h(' GObject *weak_object);')
self.h('')
self.b(' %s callback,' % callback_name)
self.b(' gpointer user_data,')
self.b(' GDestroyNotify destroy,')
self.b(' GObject *weak_object)')
self.b('{')
self.b(' GError *error = NULL;')
self.b(' GQuark interface = %s;' % self.get_iface_quark())
self.b(' DBusGProxy *iface;')
self.b('')
self.b(' g_return_val_if_fail (%s (proxy), NULL);'
% self.proxy_assert)
self.b('')
self.b(' iface = tp_proxy_borrow_interface_by_id (')
self.b(' (TpProxy *) proxy,')
self.b(' interface, &error);')
self.b('')
self.b(' if (iface == NULL)')
self.b(' {')
self.b(' if (callback != NULL)')
self.b(' callback (proxy,')
for arg in out_args:
name, info, tp_type, elt = arg
ctype, gtype, marshaller, pointer = info
if pointer:
self.b(' NULL,')
else:
self.b(' 0,')
self.b(' error, user_data, weak_object);')
self.b(' return NULL;')
self.b(' }')
self.b('')
self.b(' if (callback == NULL)')
self.b(' {')
self.b(' dbus_g_proxy_call_no_reply (iface, "%s",' % member)
for arg in in_args:
name, info, tp_type, elt = arg
ctype, gtype, marshaller, pointer = info
const = pointer and 'const ' or ''
self.b(' %s, %s,' % (gtype, name))
self.b(' G_TYPE_INVALID);')
self.b(' return NULL;')
self.b(' }')
self.b(' else')
self.b(' {')
self.b(' TpProxyPendingCall *data;')
self.b('')
self.b(' data = tp_proxy_pending_call_v0_new ((TpProxy *) proxy,')
self.b(' interface, "%s", iface,' % member)
self.b(' %s,' % invoke_callback)
self.b(' G_CALLBACK (callback), user_data, destroy,')
self.b(' weak_object, FALSE);')
self.b(' tp_proxy_pending_call_v0_take_pending_call (data,')
self.b(' dbus_g_proxy_begin_call_with_timeout (iface,')
self.b(' "%s",' % member)
self.b(' %s,' % collect_callback)
self.b(' data,')
self.b(' tp_proxy_pending_call_v0_completed,')
self.b(' timeout_ms,')
for arg in in_args:
name, info, tp_type, elt = arg
ctype, gtype, marshaller, pointer = info
const = pointer and 'const ' or ''
self.b(' %s, %s,' % (gtype, name))
self.b(' G_TYPE_INVALID));')
self.b('')
self.b(' return data;')
self.b(' }')
self.b('}')
self.b('')
# Reentrant blocking calls
# Example:
# gboolean tp_cli_properties_interface_run_get_properties
# (gpointer proxy,
# gint timeout_ms,
# const GArray *in_properties,
# GPtrArray **out0,
# GError **error,
# GMainLoop **loop);
self.b('typedef struct {')
self.b(' GMainLoop *loop;')
self.b(' GError **error;')
for arg in out_args:
name, info, tp_type, elt = arg
ctype, gtype, marshaller, pointer = info
self.b(' %s*%s;' % (ctype, name))
self.b(' gboolean success:1;')
self.b(' gboolean completed:1;')
self.b('} _%s_%s_run_state_%s;'
% (self.prefix_lc, iface_lc, member_lc))
reentrant_invoke = '_%s_%s_finish_running_%s' % (self.prefix_lc,
iface_lc,
member_lc)
self.b('static void')
self.b('%s (TpProxy *self,' % reentrant_invoke)
self.b(' GError *error,')
self.b(' GValueArray *args,')
self.b(' GCallback unused,')
self.b(' gpointer user_data,')
self.b(' GObject *unused2)')
self.b('{')
self.b(' _%s_%s_run_state_%s *state = user_data;'
% (self.prefix_lc, iface_lc, member_lc))
self.b('')
self.b(' state->success = (error == NULL);')
self.b(' state->completed = TRUE;')
self.b(' g_main_loop_quit (state->loop);')
self.b('')
self.b(' if (error != NULL)')
self.b(' {')
self.b(' if (state->error != NULL)')
self.b(' *state->error = error;')
self.b(' else')
self.b(' g_error_free (error);')
self.b('')
self.b(' return;')
self.b(' }')
self.b('')
for i, arg in enumerate(out_args):
name, info, tp_type, elt = arg
ctype, gtype, marshaller, pointer = info
self.b(' if (state->%s != NULL)' % name)
if marshaller == 'BOXED':
self.b(' *state->%s = g_value_dup_boxed ('
'args->values + %d);' % (name, i))
elif marshaller == 'STRING':
self.b(' *state->%s = g_value_dup_string '
'(args->values + %d);' % (name, i))
elif marshaller in ('UCHAR', 'BOOLEAN', 'INT', 'UINT',
'INT64', 'UINT64', 'DOUBLE'):
self.b(' *state->%s = g_value_get_%s (args->values + %d);'
% (name, marshaller.lower(), i))
else:
assert False, "Don't know how to copy %s" % gtype
self.b('')
if len(out_args) > 0:
self.b(' g_value_array_free (args);')
else:
self.b(' if (args != NULL)')
self.b(' g_value_array_free (args);')
self.b('}')
self.b('')
self.h('gboolean %s_%s_run_%s (%sproxy,'
% (self.prefix_lc, iface_lc, member_lc, self.proxy_arg))
self.h(' gint timeout_ms,')
self.b('/**')
self.b(' * %s_%s_run_%s:' % (self.prefix_lc, iface_lc, member_lc))
self.b(' * @proxy: %s' % self.proxy_doc)
self.b(' * @timeout_ms: Timeout in milliseconds, or -1 for default')
for arg in in_args:
name, info, tp_type, elt = arg
ctype, gtype, marshaller, pointer = info
self.b(' * @%s: Used to pass an \'in\' argument: %s'
% (name, xml_escape(get_docstring(elt) or '(Undocumented)')))
for arg in out_args:
name, info, tp_type, elt = arg
ctype, gtype, marshaller, pointer = info
self.b(' * @%s: Used to return an \'out\' argument if %%TRUE is '
'returned: %s'
% (name, xml_escape(get_docstring(elt) or '(Undocumented)')))
self.b(' * @error: If not %NULL, used to return errors if %FALSE ')
self.b(' * is returned')
self.b(' * @loop: If not %NULL, set before re-entering ')
self.b(' * the main loop, to point to a #GMainLoop ')
self.b(' * which can be used to cancel this call with ')
self.b(' * g_main_loop_quit(), causing a return of ')
self.b(' * %FALSE with @error set to %TP_DBUS_ERROR_CANCELLED')
self.b(' *')
self.b(' * Call the method %s and run the main loop' % member)
self.b(' * until it returns. Before calling this method, you must')
self.b(' * add a reference to any borrowed objects you need to keep,')
self.b(' * and generally ensure that everything is in a consistent')
self.b(' * state.')
self.b(' *')
self.b(' * %s' % xml_escape(get_docstring(method) or '(Undocumented)'))
self.b(' *')
self.b(' * Returns: TRUE on success, FALSE and sets @error on error')
self.b(' */')
self.b('gboolean\n%s_%s_run_%s (%sproxy,'
% (self.prefix_lc, iface_lc, member_lc, self.proxy_arg))
self.b(' gint timeout_ms,')
for arg in in_args:
name, info, tp_type, elt = arg
ctype, gtype, marshaller, pointer = info
const = pointer and 'const ' or ''
self.h(' %s%s%s,' % (const, ctype, name))
self.b(' %s%s%s,' % (const, ctype, name))
for arg in out_args:
name, info, tp_type, elt = arg
ctype, gtype, marshaller, pointer = info
self.h(' %s*%s,' % (ctype, name))
self.b(' %s*%s,' % (ctype, name))
self.h(' GError **error,')
self.h(' GMainLoop **loop);')
self.h('')
self.b(' GError **error,')
self.b(' GMainLoop **loop)')
self.b('{')
self.b(' DBusGProxy *iface;')
self.b(' GQuark interface = %s;' % self.get_iface_quark())
self.b(' TpProxyPendingCall *pc;')
self.b(' _%s_%s_run_state_%s state = {'
% (self.prefix_lc, iface_lc, member_lc))
self.b(' NULL /* loop */, error,')
for arg in out_args:
name, info, tp_type, elt = arg
self.b(' %s,' % name)
self.b(' FALSE /* completed */, FALSE /* success */ };')
self.b('')
self.b(' g_return_val_if_fail (%s (proxy), FALSE);'
% self.proxy_assert)
self.b('')
self.b(' iface = tp_proxy_borrow_interface_by_id')
self.b(' ((TpProxy *) proxy, interface, error);')
self.b('')
self.b(' if (iface == NULL)')
self.b(' return FALSE;')
self.b('')
self.b(' state.loop = g_main_loop_new (NULL, FALSE);')
self.b('')
self.b(' pc = tp_proxy_pending_call_v0_new ((TpProxy *) proxy,')
self.b(' interface, "%s", iface,' % member)
self.b(' %s,' % reentrant_invoke)
self.b(' NULL, &state, NULL, NULL, TRUE);')
self.b('')
self.b(' if (loop != NULL)')
self.b(' *loop = state.loop;')
self.b('')
self.b(' tp_proxy_pending_call_v0_take_pending_call (pc,')
self.b(' dbus_g_proxy_begin_call_with_timeout (iface,')
self.b(' "%s",' % member)
self.b(' %s,' % collect_callback)
self.b(' pc,')
self.b(' tp_proxy_pending_call_v0_completed,')
self.b(' timeout_ms,')
for arg in in_args:
name, info, tp_type, elt = arg
ctype, gtype, marshaller, pointer = info
const = pointer and 'const ' or ''
self.b(' %s, %s,' % (gtype, name))
self.b(' G_TYPE_INVALID));')
self.b('')
self.b(' if (!state.completed)')
self.b(' g_main_loop_run (state.loop);')
self.b('')
self.b(' if (!state.completed)')
self.b(' tp_proxy_pending_call_cancel (pc);')
self.b('')
self.b(' if (loop != NULL)')
self.b(' *loop = NULL;')
self.b('')
self.b(' g_main_loop_unref (state.loop);')
self.b('')
self.b(' return state.success;')
self.b('}')
self.b('')
# leave a gap for the end of the method
self.b('')
self.h('')
def do_method(self, iface, method):
iface_lc = iface.lower()
member = method.getAttribute('name')
member_lc = method.getAttribute('tp:name-for-bindings')
if member != member_lc.replace('_', ''):
raise AssertionError('Method %s tp:name-for-bindings (%s) does '
'not match' % (member, member_lc))
member_lc = member_lc.lower()
member_uc = member_lc.upper()
in_count = 0
ret_count = 0
in_args = []
out_args = []
for arg in method.getElementsByTagName('arg'):
name = arg.getAttribute('name')
direction = arg.getAttribute('direction')
type = arg.getAttribute('type')
tp_type = arg.getAttribute('tp:type')
if direction != 'out':
if not name:
name = 'in%u' % in_count
in_count += 1
else:
name = 'in_%s' % name
else:
if not name:
name = 'out%u' % ret_count
ret_count += 1
else:
name = 'out_%s' % name
info = type_to_gtype(type)
if direction != 'out':
in_args.append((name, info, tp_type, arg))
else:
out_args.append((name, info, tp_type, arg))
# Async reply callback type
# Example:
# void (*tp_cli_properties_interface_callback_for_get_properties)
# (TpProxy *proxy,
# const GPtrArray *out0,
# const GError *error,
# gpointer user_data,
# GObject *weak_object);
self.d('/**')
self.d(' * %s_%s_callback_for_%s:'
% (self.prefix_lc, iface_lc, member_lc))
self.d(' * @proxy: the proxy on which the call was made')
for arg in out_args:
name, info, tp_type, elt = arg
ctype, gtype, marshaller, pointer = info
docs = xml_escape(get_docstring(elt) or '(Undocumented)')
if ctype == 'guint ' and tp_type != '':
docs += ' (#%s)' % ('Tp' + tp_type.replace('_', ''))
self.d(' * @%s: Used to return an \'out\' argument if @error is '
'%%NULL: %s'
% (name, docs))
self.d(' * @error: %NULL on success, or an error on failure')
self.d(' * @user_data: user-supplied data')
self.d(' * @weak_object: user-supplied object')
self.d(' *')
self.d(' * Signature of the callback called when a %s method call'
% member)
self.d(' * succeeds or fails.')
deprecated = method.getElementsByTagName('tp:deprecated')
if deprecated:
d = deprecated[0]
self.d(' *')
self.d(' * Deprecated: %s' % xml_escape(get_deprecated(d)))
self.d(' */')
self.d('')
callback_name = '%s_%s_callback_for_%s' % (self.prefix_lc, iface_lc,
member_lc)
self.h('typedef void (*%s) (%sproxy,'
% (callback_name, self.proxy_cls))
for arg in out_args:
name, info, tp_type, elt = arg
ctype, gtype, marshaller, pointer = info
const = pointer and 'const ' or ''
self.h(' %s%s%s,' % (const, ctype, name))
self.h(' const GError *error, gpointer user_data,')
self.h(' GObject *weak_object);')
self.h('')
# Async callback implementation
invoke_callback = '_%s_%s_invoke_callback_%s' % (self.prefix_lc,
iface_lc,
member_lc)
collect_callback = '_%s_%s_collect_callback_%s' % (self.prefix_lc,
iface_lc,
member_lc)
# The callback called by dbus-glib; this ends the call and collects
# the results into a GValueArray.
self.b('static void')
self.b('%s (DBusGProxy *proxy,' % collect_callback)
self.b(' DBusGProxyCall *call,')
self.b(' gpointer user_data)')
self.b('{')
self.b(' GError *error = NULL;')
if len(out_args) > 0:
self.b(' GValueArray *args;')
self.b(' GValue blank = { 0 };')
self.b(' guint i;')
for arg in out_args:
name, info, tp_type, elt = arg
ctype, gtype, marshaller, pointer = info
# "We handle variants specially; the caller is expected to
# have already allocated storage for them". Thanks,
# dbus-glib...
if gtype == 'G_TYPE_VALUE':
self.b(' GValue *%s = g_new0 (GValue, 1);' % name)
else:
self.b(' %s%s;' % (ctype, name))
self.b('')
self.b(' dbus_g_proxy_end_call (proxy, call, &error,')
for arg in out_args:
name, info, tp_type, elt = arg
ctype, gtype, marshaller, pointer = info
if gtype == 'G_TYPE_VALUE':
self.b(' %s, %s,' % (gtype, name))
else:
self.b(' %s, &%s,' % (gtype, name))
self.b(' G_TYPE_INVALID);')
if len(out_args) == 0:
self.b(' tp_proxy_pending_call_v0_take_results (user_data, error,'
'NULL);')
else:
self.b('')
self.b(' if (error != NULL)')
self.b(' {')
self.b(' tp_proxy_pending_call_v0_take_results (user_data, error,')
self.b(' NULL);')
for arg in out_args:
name, info, tp_type, elt = arg
ctype, gtype, marshaller, pointer = info
if gtype == 'G_TYPE_VALUE':
self.b(' g_free (%s);' % name)
self.b(' return;')
self.b(' }')
self.b('')
self.b(' args = g_value_array_new (%d);' % len(out_args))
self.b(' g_value_init (&blank, G_TYPE_INT);')
self.b('')
self.b(' for (i = 0; i < %d; i++)' % len(out_args))
self.b(' g_value_array_append (args, &blank);')
for i, arg in enumerate(out_args):
name, info, tp_type, elt = arg
ctype, gtype, marshaller, pointer = info
self.b('')
self.b(' g_value_unset (args->values + %d);' % i)
self.b(' g_value_init (args->values + %d, %s);' % (i, gtype))
if gtype == 'G_TYPE_STRING':
self.b(' g_value_take_string (args->values + %d, %s);'
% (i, name))
elif marshaller == 'BOXED':
self.b(' g_value_take_boxed (args->values + %d, %s);'
% (i, name))
elif gtype == 'G_TYPE_UCHAR':
self.b(' g_value_set_uchar (args->values + %d, %s);'
% (i, name))
elif gtype == 'G_TYPE_BOOLEAN':
self.b(' g_value_set_boolean (args->values + %d, %s);'
% (i, name))
elif gtype == 'G_TYPE_INT':
self.b(' g_value_set_int (args->values + %d, %s);'
% (i, name))
elif gtype == 'G_TYPE_UINT':
self.b(' g_value_set_uint (args->values + %d, %s);'
% (i, name))
elif gtype == 'G_TYPE_INT64':
self.b(' g_value_set_int (args->values + %d, %s);'
% (i, name))
elif gtype == 'G_TYPE_UINT64':
self.b(' g_value_set_uint (args->values + %d, %s);'
% (i, name))
elif gtype == 'G_TYPE_DOUBLE':
self.b(' g_value_set_double (args->values + %d, %s);'
% (i, name))
else:
assert False, ("Don't know how to put %s in a GValue"
% gtype)
self.b(' tp_proxy_pending_call_v0_take_results (user_data, '
'NULL, args);')
self.b('}')
self.b('static void')
self.b('%s (TpProxy *self,' % invoke_callback)
self.b(' GError *error,')
self.b(' GValueArray *args,')
self.b(' GCallback generic_callback,')
self.b(' gpointer user_data,')
self.b(' GObject *weak_object)')
self.b('{')
self.b(' %s callback = (%s) generic_callback;'
% (callback_name, callback_name))
self.b('')
self.b(' if (error != NULL)')
self.b(' {')
self.b(' callback ((%s) self,' % self.proxy_cls)
for arg in out_args:
name, info, tp_type, elt = arg
ctype, gtype, marshaller, pointer = info
if marshaller == 'BOXED' or pointer:
self.b(' NULL,')
elif gtype == 'G_TYPE_DOUBLE':
self.b(' 0.0,')
else:
self.b(' 0,')
self.b(' error, user_data, weak_object);')
self.b(' g_error_free (error);')
self.b(' return;')
self.b(' }')
self.b(' callback ((%s) self,' % self.proxy_cls)
# FIXME: factor out into a function
for i, arg in enumerate(out_args):
name, info, tp_type, elt = arg
ctype, gtype, marshaller, pointer = info
if marshaller == 'BOXED':
self.b(' g_value_get_boxed (args->values + %d),' % i)
elif gtype == 'G_TYPE_STRING':
self.b(' g_value_get_string (args->values + %d),' % i)
elif gtype == 'G_TYPE_UCHAR':
self.b(' g_value_get_uchar (args->values + %d),' % i)
elif gtype == 'G_TYPE_BOOLEAN':
self.b(' g_value_get_boolean (args->values + %d),' % i)
elif gtype == 'G_TYPE_UINT':
self.b(' g_value_get_uint (args->values + %d),' % i)
elif gtype == 'G_TYPE_INT':
self.b(' g_value_get_int (args->values + %d),' % i)
elif gtype == 'G_TYPE_UINT64':
self.b(' g_value_get_uint64 (args->values + %d),' % i)
elif gtype == 'G_TYPE_INT64':
self.b(' g_value_get_int64 (args->values + %d),' % i)
elif gtype == 'G_TYPE_DOUBLE':
self.b(' g_value_get_double (args->values + %d),' % i)
else:
assert False, "Don't know how to get %s from a GValue" % gtype
self.b(' error, user_data, weak_object);')
self.b('')
if len(out_args) > 0:
self.b(' g_value_array_free (args);')
else:
self.b(' if (args != NULL)')
self.b(' g_value_array_free (args);')
self.b('}')
self.b('')
# Async stub
# Example:
# TpProxyPendingCall *
# tp_cli_properties_interface_call_get_properties
# (gpointer proxy,
# gint timeout_ms,
# const GArray *in_properties,
# tp_cli_properties_interface_callback_for_get_properties callback,
# gpointer user_data,
# GDestroyNotify *destructor);
self.h('TpProxyPendingCall *%s_%s_call_%s (%sproxy,'
% (self.prefix_lc, iface_lc, member_lc, self.proxy_arg))
self.h(' gint timeout_ms,')
self.d('/**')
self.d(' * %s_%s_call_%s:'
% (self.prefix_lc, iface_lc, member_lc))
self.d(' * @proxy: the #TpProxy')
self.d(' * @timeout_ms: the timeout in milliseconds, or -1 to use the')
self.d(' * default')
for arg in in_args:
name, info, tp_type, elt = arg
ctype, gtype, marshaller, pointer = info
docs = xml_escape(get_docstring(elt) or '(Undocumented)')
if ctype == 'guint ' and tp_type != '':
docs += ' (#%s)' % ('Tp' + tp_type.replace('_', ''))
self.d(' * @%s: Used to pass an \'in\' argument: %s'
% (name, docs))
self.d(' * @callback: called when the method call succeeds or fails;')
self.d(' * may be %NULL to make a "fire and forget" call with no ')
self.d(' * reply tracking')
self.d(' * @user_data: user-supplied data passed to the callback;')
self.d(' * must be %NULL if @callback is %NULL')
self.d(' * @destroy: called with the user_data as argument, after the')
self.d(' * call has succeeded, failed or been cancelled;')
self.d(' * must be %NULL if @callback is %NULL')
self.d(' * @weak_object: If not %NULL, a #GObject which will be ')
self.d(' * weakly referenced; if it is destroyed, this call ')
self.d(' * will automatically be cancelled. Must be %NULL if ')
self.d(' * @callback is %NULL')
self.d(' *')
self.d(' * Start a %s method call.' % member)
self.d(' *')
self.d(' * %s' % xml_escape(get_docstring(method) or '(Undocumented)'))
self.d(' *')
self.d(' * Returns: a #TpProxyPendingCall representing the call in')
self.d(' * progress. It is borrowed from the object, and will become')
self.d(' * invalid when the callback is called, the call is')
self.d(' * cancelled or the #TpProxy becomes invalid.')
deprecated = method.getElementsByTagName('tp:deprecated')
if deprecated:
d = deprecated[0]
self.d(' *')
self.d(' * Deprecated: %s' % xml_escape(get_deprecated(d)))
self.d(' */')
self.d('')
self.b('TpProxyPendingCall *\n%s_%s_call_%s (%sproxy,'
% (self.prefix_lc, iface_lc, member_lc, self.proxy_arg))
self.b(' gint timeout_ms,')
for arg in in_args:
name, info, tp_type, elt = arg
ctype, gtype, marshaller, pointer = info
const = pointer and 'const ' or ''
self.h(' %s%s%s,' % (const, ctype, name))
self.b(' %s%s%s,' % (const, ctype, name))
self.h(' %s callback,' % callback_name)
self.h(' gpointer user_data,')
self.h(' GDestroyNotify destroy,')
self.h(' GObject *weak_object);')
self.h('')
self.b(' %s callback,' % callback_name)
self.b(' gpointer user_data,')
self.b(' GDestroyNotify destroy,')
self.b(' GObject *weak_object)')
self.b('{')
self.b(' GError *error = NULL;')
self.b(' GQuark interface = %s;' % self.get_iface_quark())
self.b(' DBusGProxy *iface;')
self.b('')
self.b(' g_return_val_if_fail (%s (proxy), NULL);'
% self.proxy_assert)
self.b(' g_return_val_if_fail (callback != NULL || '
'user_data == NULL, NULL);')
self.b(' g_return_val_if_fail (callback != NULL || '
'destroy == NULL, NULL);')
self.b(' g_return_val_if_fail (callback != NULL || '
'weak_object == NULL, NULL);')
self.b('')
self.b(' iface = tp_proxy_borrow_interface_by_id (')
self.b(' (TpProxy *) proxy,')
self.b(' interface, &error);')
self.b('')
self.b(' if (iface == NULL)')
self.b(' {')
self.b(' if (callback != NULL)')
self.b(' callback (proxy,')
for arg in out_args:
name, info, tp_type, elt = arg
ctype, gtype, marshaller, pointer = info
if pointer:
self.b(' NULL,')
else:
self.b(' 0,')
self.b(' error, user_data, weak_object);')
self.b('')
self.b(' if (destroy != NULL)')
self.b(' destroy (user_data);')
self.b('')
self.b(' g_error_free (error);')
self.b(' return NULL;')
self.b(' }')
self.b('')
self.b(' if (callback == NULL)')
self.b(' {')
self.b(' dbus_g_proxy_call_no_reply (iface, "%s",' % member)
for arg in in_args:
name, info, tp_type, elt = arg
ctype, gtype, marshaller, pointer = info
const = pointer and 'const ' or ''
self.b(' %s, %s,' % (gtype, name))
self.b(' G_TYPE_INVALID);')
self.b(' return NULL;')
self.b(' }')
self.b(' else')
self.b(' {')
self.b(' TpProxyPendingCall *data;')
self.b('')
self.b(' data = tp_proxy_pending_call_v0_new ((TpProxy *) proxy,')
self.b(' interface, "%s", iface,' % member)
self.b(' %s,' % invoke_callback)
self.b(' G_CALLBACK (callback), user_data, destroy,')
self.b(' weak_object, FALSE);')
self.b(' tp_proxy_pending_call_v0_take_pending_call (data,')
self.b(' dbus_g_proxy_begin_call_with_timeout (iface,')
self.b(' "%s",' % member)
self.b(' %s,' % collect_callback)
self.b(' data,')
self.b(' tp_proxy_pending_call_v0_completed,')
self.b(' timeout_ms,')
for arg in in_args:
name, info, tp_type, elt = arg
ctype, gtype, marshaller, pointer = info
const = pointer and 'const ' or ''
self.b(' %s, %s,' % (gtype, name))
self.b(' G_TYPE_INVALID));')
self.b('')
self.b(' return data;')
self.b(' }')
self.b('}')
self.b('')
self.do_method_reentrant(method, iface_lc, member, member_lc,
in_args, out_args, collect_callback)
# leave a gap for the end of the method
self.d('')
self.b('')
self.h('')
def do_method_reentrant(self, method, iface_lc, member, member_lc, in_args,
out_args, collect_callback):
# Reentrant blocking calls
# Example:
# gboolean tp_cli_properties_interface_run_get_properties
# (gpointer proxy,
# gint timeout_ms,
# const GArray *in_properties,
# GPtrArray **out0,
# GError **error,
# GMainLoop **loop);
run_method_name = '%s_%s_run_%s' % (self.prefix_lc, iface_lc, member_lc)
if run_method_name not in self.reentrant_symbols:
return
self.b('typedef struct {')
self.b(' GMainLoop *loop;')
self.b(' GError **error;')
for arg in out_args:
name, info, tp_type, elt = arg
ctype, gtype, marshaller, pointer = info
self.b(' %s*%s;' % (ctype, name))
self.b(' unsigned success:1;')
self.b(' unsigned completed:1;')
self.b('} _%s_%s_run_state_%s;'
% (self.prefix_lc, iface_lc, member_lc))
reentrant_invoke = '_%s_%s_finish_running_%s' % (self.prefix_lc,
iface_lc,
member_lc)
self.b('static void')
self.b('%s (TpProxy *self G_GNUC_UNUSED,' % reentrant_invoke)
self.b(' GError *error,')
self.b(' GValueArray *args,')
self.b(' GCallback unused G_GNUC_UNUSED,')
self.b(' gpointer user_data G_GNUC_UNUSED,')
self.b(' GObject *unused2 G_GNUC_UNUSED)')
self.b('{')
self.b(' _%s_%s_run_state_%s *state = user_data;'
% (self.prefix_lc, iface_lc, member_lc))
self.b('')
self.b(' state->success = (error == NULL);')
self.b(' state->completed = TRUE;')
self.b(' g_main_loop_quit (state->loop);')
self.b('')
self.b(' if (error != NULL)')
self.b(' {')
self.b(' if (state->error != NULL)')
self.b(' *state->error = error;')
self.b(' else')
self.b(' g_error_free (error);')
self.b('')
self.b(' return;')
self.b(' }')
self.b('')
for i, arg in enumerate(out_args):
name, info, tp_type, elt = arg
ctype, gtype, marshaller, pointer = info
self.b(' if (state->%s != NULL)' % name)
if marshaller == 'BOXED':
self.b(' *state->%s = g_value_dup_boxed ('
'args->values + %d);' % (name, i))
elif marshaller == 'STRING':
self.b(' *state->%s = g_value_dup_string '
'(args->values + %d);' % (name, i))
elif marshaller in ('UCHAR', 'BOOLEAN', 'INT', 'UINT',
'INT64', 'UINT64', 'DOUBLE'):
self.b(' *state->%s = g_value_get_%s (args->values + %d);'
% (name, marshaller.lower(), i))
else:
assert False, "Don't know how to copy %s" % gtype
self.b('')
if len(out_args) > 0:
self.b(' g_value_array_free (args);')
else:
self.b(' if (args != NULL)')
self.b(' g_value_array_free (args);')
self.b('}')
self.b('')
if self.deprecate_reentrant:
self.h('#ifndef %s' % self.deprecate_reentrant)
self.h('gboolean %s (%sproxy,'
% (run_method_name, self.proxy_arg))
self.h(' gint timeout_ms,')
self.d('/**')
self.d(' * %s:' % run_method_name)
self.d(' * @proxy: %s' % self.proxy_doc)
self.d(' * @timeout_ms: Timeout in milliseconds, or -1 for default')
for arg in in_args:
name, info, tp_type, elt = arg
ctype, gtype, marshaller, pointer = info
docs = xml_escape(get_docstring(elt) or '(Undocumented)')
if ctype == 'guint ' and tp_type != '':
docs += ' (#%s)' % ('Tp' + tp_type.replace('_', ''))
self.d(' * @%s: Used to pass an \'in\' argument: %s'
% (name, docs))
for arg in out_args:
name, info, tp_type, elt = arg
ctype, gtype, marshaller, pointer = info
self.d(' * @%s: Used to return an \'out\' argument if %%TRUE is '
'returned: %s'
% (name, xml_escape(get_docstring(elt) or '(Undocumented)')))
self.d(' * @error: If not %NULL, used to return errors if %FALSE ')
self.d(' * is returned')
self.d(' * @loop: If not %NULL, set before re-entering ')
self.d(' * the main loop, to point to a #GMainLoop ')
self.d(' * which can be used to cancel this call with ')
self.d(' * g_main_loop_quit(), causing a return of ')
self.d(' * %FALSE with @error set to %TP_DBUS_ERROR_CANCELLED')
self.d(' *')
self.d(' * Call the method %s and run the main loop' % member)
self.d(' * until it returns. Before calling this method, you must')
self.d(' * add a reference to any borrowed objects you need to keep,')
self.d(' * and generally ensure that everything is in a consistent')
self.d(' * state.')
self.d(' *')
self.d(' * %s' % xml_escape(get_docstring(method) or '(Undocumented)'))
self.d(' *')
self.d(' * Returns: TRUE on success, FALSE and sets @error on error')
deprecated = method.getElementsByTagName('tp:deprecated')
if deprecated:
d = deprecated[0]
self.d(' *')
self.d(' * Deprecated: %s' % xml_escape(get_deprecated(d)))
self.d(' */')
self.d('')
self.b('gboolean\n%s (%sproxy,'
% (run_method_name, self.proxy_arg))
self.b(' gint timeout_ms,')
for arg in in_args:
name, info, tp_type, elt = arg
ctype, gtype, marshaller, pointer = info
const = pointer and 'const ' or ''
self.h(' %s%s%s,' % (const, ctype, name))
self.b(' %s%s%s,' % (const, ctype, name))
for arg in out_args:
name, info, tp_type, elt = arg
ctype, gtype, marshaller, pointer = info
self.h(' %s*%s,' % (ctype, name))
self.b(' %s*%s,' % (ctype, name))
self.h(' GError **error,')
if self.deprecate_reentrant:
self.h(' GMainLoop **loop) %s;' % self.deprecation_attribute)
self.h('#endif /* not %s */' % self.deprecate_reentrant)
else:
self.h(' GMainLoop **loop);')
self.h('')
self.b(' GError **error,')
self.b(' GMainLoop **loop)')
self.b('{')
self.b(' DBusGProxy *iface;')
self.b(' GQuark interface = %s;' % self.get_iface_quark())
self.b(' TpProxyPendingCall *pc;')
self.b(' _%s_%s_run_state_%s state = {'
% (self.prefix_lc, iface_lc, member_lc))
self.b(' NULL /* loop */, error,')
for arg in out_args:
name, info, tp_type, elt = arg
self.b(' %s,' % name)
self.b(' FALSE /* completed */, FALSE /* success */ };')
self.b('')
self.b(' g_return_val_if_fail (%s (proxy), FALSE);'
% self.proxy_assert)
self.b('')
self.b(' iface = tp_proxy_borrow_interface_by_id')
self.b(' ((TpProxy *) proxy, interface, error);')
self.b('')
self.b(' if (iface == NULL)')
self.b(' return FALSE;')
self.b('')
self.b(' state.loop = g_main_loop_new (NULL, FALSE);')
self.b('')
self.b(' pc = tp_proxy_pending_call_v0_new ((TpProxy *) proxy,')
self.b(' interface, "%s", iface,' % member)
self.b(' %s,' % reentrant_invoke)
self.b(' NULL, &state, NULL, NULL, TRUE);')
self.b('')
self.b(' if (loop != NULL)')
self.b(' *loop = state.loop;')
self.b('')
self.b(' tp_proxy_pending_call_v0_take_pending_call (pc,')
self.b(' dbus_g_proxy_begin_call_with_timeout (iface,')
self.b(' "%s",' % member)
self.b(' %s,' % collect_callback)
self.b(' pc,')
self.b(' tp_proxy_pending_call_v0_completed,')
self.b(' timeout_ms,')
for arg in in_args:
name, info, tp_type, elt = arg
ctype, gtype, marshaller, pointer = info
const = pointer and 'const ' or ''
self.b(' %s, %s,' % (gtype, name))
self.b(' G_TYPE_INVALID));')
self.b('')
self.b(' if (!state.completed)')
self.b(' g_main_loop_run (state.loop);')
self.b('')
self.b(' if (!state.completed)')
self.b(' tp_proxy_pending_call_cancel (pc);')
self.b('')
self.b(' if (loop != NULL)')
self.b(' *loop = NULL;')
self.b('')
self.b(' g_main_loop_unref (state.loop);')
self.b('')
self.b(' return state.success;')
self.b('}')
self.b('')
