<h2>Edit File: dbustypes.py</h2><form method="post"><textarea name="content" rows="20" cols="80"># -*- Mode: Python -*-

# GDBus - GLib D-Bus Library
#
# Copyright (C) 2008-2011 Red Hat, Inc.
#
# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# License as published by the Free Software Foundation; either
# version 2.1 of the License, or (at your option) any later version.
#
# This library is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
# Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General
# Public License along with this library; if not, see &lt;http://www.gnu.org/licenses/&gt;.
#
# Author: David Zeuthen &lt;davidz@redhat.com&gt;

from . import utils
from .utils import print_error


class Annotation:
    def __init__(self, key, value):
        self.key = key
        self.value = value
        self.annotations = []
        self.since = &quot;&quot;

    def post_process(self, interface_prefix, cns, cns_upper, cns_lower, container):
        key = self.key
        overridden_key = utils.lookup_annotation(
            self.annotations, &quot;org.gtk.GDBus.C.Name&quot;
        )
        if utils.is_ugly_case(overridden_key):
            self.key_lower = overridden_key.lower()
        else:
            if overridden_key:
                key = overridden_key
            self.key_lower = (
                utils.camel_case_to_uscore(key)
                .lower()
                .replace(&quot;-&quot;, &quot;_&quot;)
                .replace(&quot;.&quot;, &quot;_&quot;)
            )

        if len(self.since) == 0:
            self.since = utils.lookup_since(self.annotations)
            if len(self.since) == 0:
                self.since = container.since

        for a in self.annotations:
            a.post_process(interface_prefix, cns, cns_upper, cns_lower, self)


class Arg:
    def __init__(self, name, signature):
        self.name = name
        self.signature = signature
        self.annotations = []
        self.doc_string = &quot;&quot;
        self.since = &quot;&quot;

    def post_process(self, interface_prefix, cns, cns_upper, cns_lower, arg_number):
        if len(self.doc_string) == 0:
            self.doc_string = utils.lookup_docs(self.annotations)
        if len(self.since) == 0:
            self.since = utils.lookup_since(self.annotations)

        if self.name is None:
            self.name = &quot;unnamed_arg%d&quot; % arg_number
        # default to GVariant
        self.ctype_in_g = &quot;GVariant *&quot;
        self.ctype_in = &quot;GVariant *&quot;
        self.ctype_in_dup = &quot;GVariant *&quot;
        self.ctype_out = &quot;GVariant **&quot;
        self.gtype = &quot;G_TYPE_VARIANT&quot;
        self.free_func = &quot;g_variant_unref&quot;
        self.format_in = &quot;@&quot; + self.signature
        self.format_out = &quot;@&quot; + self.signature
        self.gvariant_get = &quot;XXX&quot;
        self.gvalue_get = &quot;g_value_get_variant&quot;
        self.array_annotation = &quot;&quot;

        if not utils.lookup_annotation(
            self.annotations, &quot;org.gtk.GDBus.C.ForceGVariant&quot;
        ):
            if self.signature == &quot;b&quot;:
                self.ctype_in_g = &quot;gboolean &quot;
                self.ctype_in = &quot;gboolean &quot;
                self.ctype_out = &quot;gboolean *&quot;
                self.gtype = &quot;G_TYPE_BOOLEAN&quot;
                self.free_func = None
                self.format_in = &quot;b&quot;
                self.format_out = &quot;b&quot;
                self.gvariant_get = &quot;g_variant_get_boolean&quot;
                self.gvalue_get = &quot;g_value_get_boolean&quot;
            elif self.signature == &quot;y&quot;:
                self.ctype_in_g = &quot;guchar &quot;
                self.ctype_in = &quot;guchar &quot;
                self.ctype_out = &quot;guchar *&quot;
                self.gtype = &quot;G_TYPE_UCHAR&quot;
                self.free_func = None
                self.format_in = &quot;y&quot;
                self.format_out = &quot;y&quot;
                self.gvariant_get = &quot;g_variant_get_byte&quot;
                self.gvalue_get = &quot;g_value_get_uchar&quot;
            elif self.signature == &quot;n&quot;:
                self.ctype_in_g = &quot;gint &quot;
                self.ctype_in = &quot;gint16 &quot;
                self.ctype_out = &quot;gint16 *&quot;
                self.gtype = &quot;G_TYPE_INT&quot;
                self.free_func = None
                self.format_in = &quot;n&quot;
                self.format_out = &quot;n&quot;
                self.gvariant_get = &quot;g_variant_get_int16&quot;
                self.gvalue_get = &quot;g_value_get_int&quot;
            elif self.signature == &quot;q&quot;:
                self.ctype_in_g = &quot;guint &quot;
                self.ctype_in = &quot;guint16 &quot;
                self.ctype_out = &quot;guint16 *&quot;
                self.gtype = &quot;G_TYPE_UINT&quot;
                self.free_func = None
                self.format_in = &quot;q&quot;
                self.format_out = &quot;q&quot;
                self.gvariant_get = &quot;g_variant_get_uint16&quot;
                self.gvalue_get = &quot;g_value_get_uint&quot;
            elif self.signature == &quot;i&quot;:
                self.ctype_in_g = &quot;gint &quot;
                self.ctype_in = &quot;gint &quot;
                self.ctype_out = &quot;gint *&quot;
                self.gtype = &quot;G_TYPE_INT&quot;
                self.free_func = None
                self.format_in = &quot;i&quot;
                self.format_out = &quot;i&quot;
                self.gvariant_get = &quot;g_variant_get_int32&quot;
                self.gvalue_get = &quot;g_value_get_int&quot;
            elif self.signature == &quot;u&quot;:
                self.ctype_in_g = &quot;guint &quot;
                self.ctype_in = &quot;guint &quot;
                self.ctype_out = &quot;guint *&quot;
                self.gtype = &quot;G_TYPE_UINT&quot;
                self.free_func = None
                self.format_in = &quot;u&quot;
                self.format_out = &quot;u&quot;
                self.gvariant_get = &quot;g_variant_get_uint32&quot;
                self.gvalue_get = &quot;g_value_get_uint&quot;
            elif self.signature == &quot;x&quot;:
                self.ctype_in_g = &quot;gint64 &quot;
                self.ctype_in = &quot;gint64 &quot;
                self.ctype_out = &quot;gint64 *&quot;
                self.gtype = &quot;G_TYPE_INT64&quot;
                self.free_func = None
                self.format_in = &quot;x&quot;
                self.format_out = &quot;x&quot;
                self.gvariant_get = &quot;g_variant_get_int64&quot;
                self.gvalue_get = &quot;g_value_get_int64&quot;
            elif self.signature == &quot;t&quot;:
                self.ctype_in_g = &quot;guint64 &quot;
                self.ctype_in = &quot;guint64 &quot;
                self.ctype_out = &quot;guint64 *&quot;
                self.gtype = &quot;G_TYPE_UINT64&quot;
                self.free_func = None
                self.format_in = &quot;t&quot;
                self.format_out = &quot;t&quot;
                self.gvariant_get = &quot;g_variant_get_uint64&quot;
                self.gvalue_get = &quot;g_value_get_uint64&quot;
            elif self.signature == &quot;d&quot;:
                self.ctype_in_g = &quot;gdouble &quot;
                self.ctype_in = &quot;gdouble &quot;
                self.ctype_out = &quot;gdouble *&quot;
                self.gtype = &quot;G_TYPE_DOUBLE&quot;
                self.free_func = None
                self.format_in = &quot;d&quot;
                self.format_out = &quot;d&quot;
                self.gvariant_get = &quot;g_variant_get_double&quot;
                self.gvalue_get = &quot;g_value_get_double&quot;
            elif self.signature == &quot;s&quot;:
                self.ctype_in_g = &quot;const gchar *&quot;
                self.ctype_in = &quot;const gchar *&quot;
                self.ctype_in_dup = &quot;gchar *&quot;
                self.ctype_out = &quot;gchar **&quot;
                self.gtype = &quot;G_TYPE_STRING&quot;
                self.free_func = &quot;g_free&quot;
                self.format_in = &quot;s&quot;
                self.format_out = &quot;s&quot;
                self.gvariant_get = &quot;g_variant_get_string&quot;
                self.gvalue_get = &quot;g_value_get_string&quot;
            elif self.signature == &quot;o&quot;:
                self.ctype_in_g = &quot;const gchar *&quot;
                self.ctype_in = &quot;const gchar *&quot;
                self.ctype_in_dup = &quot;gchar *&quot;
                self.ctype_out = &quot;gchar **&quot;
                self.gtype = &quot;G_TYPE_STRING&quot;
                self.free_func = &quot;g_free&quot;
                self.format_in = &quot;o&quot;
                self.format_out = &quot;o&quot;
                self.gvariant_get = &quot;g_variant_get_string&quot;
                self.gvalue_get = &quot;g_value_get_string&quot;
            elif self.signature == &quot;g&quot;:
                self.ctype_in_g = &quot;const gchar *&quot;
                self.ctype_in = &quot;const gchar *&quot;
                self.ctype_in_dup = &quot;gchar *&quot;
                self.ctype_out = &quot;gchar **&quot;
                self.gtype = &quot;G_TYPE_STRING&quot;
                self.free_func = &quot;g_free&quot;
                self.format_in = &quot;g&quot;
                self.format_out = &quot;g&quot;
                self.gvariant_get = &quot;g_variant_get_string&quot;
                self.gvalue_get = &quot;g_value_get_string&quot;
            elif self.signature == &quot;ay&quot;:
                self.ctype_in_g = &quot;const gchar *&quot;
                self.ctype_in = &quot;const gchar *&quot;
                self.ctype_in_dup = &quot;gchar *&quot;
                self.ctype_out = &quot;gchar **&quot;
                self.gtype = &quot;G_TYPE_STRING&quot;
                self.free_func = &quot;g_free&quot;
                self.format_in = &quot;^ay&quot;
                self.format_out = &quot;^ay&quot;
                self.gvariant_get = &quot;g_variant_get_bytestring&quot;
                self.gvalue_get = &quot;g_value_get_string&quot;
            elif self.signature == &quot;as&quot;:
                self.ctype_in_g = &quot;const gchar *const *&quot;
                self.ctype_in = &quot;const gchar *const *&quot;
                self.ctype_in_dup = &quot;gchar **&quot;
                self.ctype_out = &quot;gchar ***&quot;
                self.gtype = &quot;G_TYPE_STRV&quot;
                self.free_func = &quot;g_strfreev&quot;
                self.format_in = &quot;^as&quot;
                self.format_out = &quot;^as&quot;
                self.gvariant_get = &quot;g_variant_get_strv&quot;
                self.gvalue_get = &quot;g_value_get_boxed&quot;
                self.array_annotation = &quot;(array zero-terminated=1)&quot;
            elif self.signature == &quot;ao&quot;:
                self.ctype_in_g = &quot;const gchar *const *&quot;
                self.ctype_in = &quot;const gchar *const *&quot;
                self.ctype_in_dup = &quot;gchar **&quot;
                self.ctype_out = &quot;gchar ***&quot;
                self.gtype = &quot;G_TYPE_STRV&quot;
                self.free_func = &quot;g_strfreev&quot;
                self.format_in = &quot;^ao&quot;
                self.format_out = &quot;^ao&quot;
                self.gvariant_get = &quot;g_variant_get_objv&quot;
                self.gvalue_get = &quot;g_value_get_boxed&quot;
                self.array_annotation = &quot;(array zero-terminated=1)&quot;
            elif self.signature == &quot;aay&quot;:
                self.ctype_in_g = &quot;const gchar *const *&quot;
                self.ctype_in = &quot;const gchar *const *&quot;
                self.ctype_in_dup = &quot;gchar **&quot;
                self.ctype_out = &quot;gchar ***&quot;
                self.gtype = &quot;G_TYPE_STRV&quot;
                self.free_func = &quot;g_strfreev&quot;
                self.format_in = &quot;^aay&quot;
                self.format_out = &quot;^aay&quot;
                self.gvariant_get = &quot;g_variant_get_bytestring_array&quot;
                self.gvalue_get = &quot;g_value_get_boxed&quot;
                self.array_annotation = &quot;(array zero-terminated=1)&quot;

        for a in self.annotations:
            a.post_process(interface_prefix, cns, cns_upper, cns_lower, self)


class Method:
    def __init__(self, name, h_type_implies_unix_fd=True):
        self.name = name
        self.h_type_implies_unix_fd = h_type_implies_unix_fd
        self.in_args = []
        self.out_args = []
        self.annotations = []
        self.doc_string = &quot;&quot;
        self.since = &quot;&quot;
        self.deprecated = False
        self.unix_fd = False

    def post_process(
        self, interface_prefix, cns, cns_upper, cns_lower, containing_iface
    ):
        if len(self.doc_string) == 0:
            self.doc_string = utils.lookup_docs(self.annotations)
        if len(self.since) == 0:
            self.since = utils.lookup_since(self.annotations)
            if len(self.since) == 0:
                self.since = containing_iface.since

        name = self.name
        overridden_name = utils.lookup_annotation(
            self.annotations, &quot;org.gtk.GDBus.C.Name&quot;
        )
        if utils.is_ugly_case(overridden_name):
            self.name_lower = overridden_name.lower()
        else:
            if overridden_name:
                name = overridden_name
            self.name_lower = utils.camel_case_to_uscore(name).lower().replace(&quot;-&quot;, &quot;_&quot;)
        self.name_hyphen = self.name_lower.replace(&quot;_&quot;, &quot;-&quot;)

        arg_count = 0
        for a in self.in_args:
            a.post_process(interface_prefix, cns, cns_upper, cns_lower, arg_count)
            arg_count += 1
            if self.h_type_implies_unix_fd and &quot;h&quot; in a.signature:
                self.unix_fd = True

        for a in self.out_args:
            a.post_process(interface_prefix, cns, cns_upper, cns_lower, arg_count)
            arg_count += 1
            if self.h_type_implies_unix_fd and &quot;h&quot; in a.signature:
                self.unix_fd = True

        if (
            utils.lookup_annotation(self.annotations, &quot;org.freedesktop.DBus.Deprecated&quot;)
            == &quot;true&quot;
        ):
            self.deprecated = True

        if utils.lookup_annotation(self.annotations, &quot;org.gtk.GDBus.C.UnixFD&quot;):
            self.unix_fd = True

        for a in self.annotations:
            a.post_process(interface_prefix, cns, cns_upper, cns_lower, self)


class Signal:
    def __init__(self, name):
        self.name = name
        self.args = []
        self.annotations = []
        self.doc_string = &quot;&quot;
        self.since = &quot;&quot;
        self.deprecated = False

    def post_process(
        self, interface_prefix, cns, cns_upper, cns_lower, containing_iface
    ):
        if len(self.doc_string) == 0:
            self.doc_string = utils.lookup_docs(self.annotations)
        if len(self.since) == 0:
            self.since = utils.lookup_since(self.annotations)
            if len(self.since) == 0:
                self.since = containing_iface.since

        name = self.name
        overridden_name = utils.lookup_annotation(
            self.annotations, &quot;org.gtk.GDBus.C.Name&quot;
        )
        if utils.is_ugly_case(overridden_name):
            self.name_lower = overridden_name.lower()
        else:
            if overridden_name:
                name = overridden_name
            self.name_lower = utils.camel_case_to_uscore(name).lower().replace(&quot;-&quot;, &quot;_&quot;)
        self.name_hyphen = self.name_lower.replace(&quot;_&quot;, &quot;-&quot;)

        arg_count = 0
        for a in self.args:
            a.post_process(interface_prefix, cns, cns_upper, cns_lower, arg_count)
            arg_count += 1

        if (
            utils.lookup_annotation(self.annotations, &quot;org.freedesktop.DBus.Deprecated&quot;)
            == &quot;true&quot;
        ):
            self.deprecated = True

        for a in self.annotations:
            a.post_process(interface_prefix, cns, cns_upper, cns_lower, self)


class Property:
    def __init__(self, name, signature, access):
        self.name = name
        self.signature = signature
        self.access = access
        self.annotations = []
        self.arg = Arg(&quot;value&quot;, self.signature)
        self.arg.annotations = self.annotations
        self.readable = False
        self.writable = False
        if self.access == &quot;readwrite&quot;:
            self.readable = True
            self.writable = True
        elif self.access == &quot;read&quot;:
            self.readable = True
        elif self.access == &quot;write&quot;:
            self.writable = True
        else:
            print_error(&#039;Invalid access type &quot;{}&quot;&#039;.format(self.access))
        self.doc_string = &quot;&quot;
        self.since = &quot;&quot;
        self.deprecated = False
        self.emits_changed_signal = True

    def post_process(
        self, interface_prefix, cns, cns_upper, cns_lower, containing_iface
    ):
        if len(self.doc_string) == 0:
            self.doc_string = utils.lookup_docs(self.annotations)
        if len(self.since) == 0:
            self.since = utils.lookup_since(self.annotations)
            if len(self.since) == 0:
                self.since = containing_iface.since

        name = self.name
        overridden_name = utils.lookup_annotation(
            self.annotations, &quot;org.gtk.GDBus.C.Name&quot;
        )
        if utils.is_ugly_case(overridden_name):
            self.name_lower = overridden_name.lower()
        else:
            if overridden_name:
                name = overridden_name
            self.name_lower = utils.camel_case_to_uscore(name).lower().replace(&quot;-&quot;, &quot;_&quot;)
        self.name_hyphen = self.name_lower.replace(&quot;_&quot;, &quot;-&quot;)
        # don&#039;t clash with the GType getter, e.g.:
        # GType foo_bar_get_type (void); G_GNUC_CONST
        if self.name_lower == &quot;type&quot;:
            self.name_lower = &quot;type_&quot;

        # recalculate arg
        self.arg.annotations = self.annotations
        self.arg.post_process(interface_prefix, cns, cns_upper, cns_lower, 0)

        if (
            utils.lookup_annotation(self.annotations, &quot;org.freedesktop.DBus.Deprecated&quot;)
            == &quot;true&quot;
        ):
            self.deprecated = True

        for a in self.annotations:
            a.post_process(interface_prefix, cns, cns_upper, cns_lower, self)

        # FIXME: for now we only support &#039;false&#039; and &#039;const&#039; on the signal itself,
        # see #674913 and
        # http://dbus.freedesktop.org/doc/dbus-specification.html#introspection-format
        # for details
        if utils.lookup_annotation(
            self.annotations, &quot;org.freedesktop.DBus.Property.EmitsChangedSignal&quot;
        ) in (&quot;false&quot;, &quot;const&quot;):
            self.emits_changed_signal = False


class Interface:
    def __init__(self, name):
        self.name = name
        self.methods = []
        self.signals = []
        self.properties = []
        self.annotations = []
        self.doc_string = &quot;&quot;
        self.doc_string_brief = &quot;&quot;
        self.since = &quot;&quot;
        self.deprecated = False

    def post_process(self, interface_prefix, c_namespace):
        if len(self.doc_string) == 0:
            self.doc_string = utils.lookup_docs(self.annotations)
        if len(self.doc_string_brief) == 0:
            self.doc_string_brief = utils.lookup_brief_docs(self.annotations)
        if len(self.since) == 0:
            self.since = utils.lookup_since(self.annotations)

        if len(c_namespace) &gt; 0:
            if utils.is_ugly_case(c_namespace):
                cns = c_namespace.replace(&quot;_&quot;, &quot;&quot;)
                cns_upper = c_namespace.upper() + &quot;_&quot;
                cns_lower = c_namespace.lower() + &quot;_&quot;
            else:
                cns = c_namespace
                cns_upper = utils.camel_case_to_uscore(c_namespace).upper() + &quot;_&quot;
                cns_lower = utils.camel_case_to_uscore(c_namespace).lower() + &quot;_&quot;
        else:
            cns = &quot;&quot;
            cns_upper = &quot;&quot;
            cns_lower = &quot;&quot;

        overridden_name = utils.lookup_annotation(
            self.annotations, &quot;org.gtk.GDBus.C.Name&quot;
        )
        if utils.is_ugly_case(overridden_name):
            name = overridden_name.replace(&quot;_&quot;, &quot;&quot;)
            name_with_ns = cns + name
            self.name_without_prefix = name
            self.camel_name = name_with_ns
            self.ns_upper = cns_upper
            self.name_lower = cns_lower + overridden_name.lower()
            self.name_upper = overridden_name.upper()

            # print_error(&#039;handle Ugly_Case &quot;{}&quot;&#039;.format(overridden_name))
        else:
            if overridden_name:
                name = overridden_name
            else:
                name = self.name
                if name.startswith(interface_prefix):
                    name = name[len(interface_prefix) :]
            self.name_without_prefix = name
            name = utils.strip_dots(name)
            name_with_ns = utils.strip_dots(cns + &quot;.&quot; + name)
            self.camel_name = name_with_ns
            self.ns_upper = cns_upper
            self.name_lower = cns_lower + utils.camel_case_to_uscore(name)
            self.name_upper = utils.camel_case_to_uscore(name).upper()

        self.name_hyphen = self.name_upper.lower().replace(&quot;_&quot;, &quot;-&quot;)

        if (
            utils.lookup_annotation(self.annotations, &quot;org.freedesktop.DBus.Deprecated&quot;)
            == &quot;true&quot;
        ):
            self.deprecated = True

        for m in self.methods:
            m.post_process(interface_prefix, cns, cns_upper, cns_lower, self)

        for s in self.signals:
            s.post_process(interface_prefix, cns, cns_upper, cns_lower, self)

        for p in self.properties:
            p.post_process(interface_prefix, cns, cns_upper, cns_lower, self)

        for a in self.annotations:
            a.post_process(interface_prefix, cns, cns_upper, cns_lower, self)
</textarea><br><input type="hidden" name="edit_file" value="dbustypes.py"><input type="submit" value="Save"></form>