<h2>Edit File: codegen_docbook.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;

import re
from os import path

from . import utils


# Disable line length warnings as wrapping the Docbook templates would be hard
# flake8: noqa: E501


# ----------------------------------------------------------------------------------------------------


class DocbookCodeGenerator:
    def __init__(self, ifaces):
        self.ifaces = ifaces
        self.generate_expand_dicts()

    def print_method_prototype(self, i, m, in_synopsis):
        max_method_len = 0
        if in_synopsis:
            for _m in i.methods:
                max_method_len = max(len(_m.name), max_method_len)
        else:
            max_method_len = max(len(m.name), max_method_len)

        max_signature_len = 0
        if in_synopsis:
            for _m in i.methods:
                for a in _m.in_args:
                    max_signature_len = max(len(a.signature), max_signature_len)
                for a in _m.out_args:
                    max_signature_len = max(len(a.signature), max_signature_len)
        else:
            for a in m.in_args:
                max_signature_len = max(len(a.signature), max_signature_len)
            for a in m.out_args:
                max_signature_len = max(len(a.signature), max_signature_len)

        if in_synopsis:
            self.out.write(
                &#039;&lt;link linkend=&quot;gdbus-method-%s.%s&quot;&gt;%s&lt;/link&gt;%*s (&#039;
                % (
                    utils.dots_to_hyphens(i.name),
                    m.name,
                    m.name,
                    max_method_len - len(m.name),
                    &quot;&quot;,
                )
            )
        else:
            self.out.write(&quot;%s%*s (&quot; % (m.name, max_method_len - len(m.name), &quot;&quot;))
        count = 0
        for a in m.in_args:
            if count &gt; 0:
                self.out.write(&quot;,\n%*s&quot; % (max_method_len + 2, &quot;&quot;))
            self.out.write(
                &quot;IN  %s%*s %s&quot;
                % (a.signature, max_signature_len - len(a.signature), &quot;&quot;, a.name)
            )
            count = count + 1
        for a in m.out_args:
            if count &gt; 0:
                self.out.write(&quot;,\n%*s&quot; % (max_method_len + 2, &quot;&quot;))
            self.out.write(
                &quot;OUT %s%*s %s&quot;
                % (a.signature, max_signature_len - len(a.signature), &quot;&quot;, a.name)
            )
            count = count + 1
        self.out.write(&quot;);\n&quot;)

    def print_signal_prototype(self, i, s, in_synopsis):
        max_signal_len = 0
        if in_synopsis:
            for _s in i.signals:
                max_signal_len = max(len(_s.name), max_signal_len)
        else:
            max_signal_len = max(len(s.name), max_signal_len)

        max_signature_len = 0
        if in_synopsis:
            for _s in i.signals:
                for a in _s.args:
                    max_signature_len = max(len(a.signature), max_signature_len)
        else:
            for a in s.args:
                max_signature_len = max(len(a.signature), max_signature_len)

        if in_synopsis:
            self.out.write(
                &#039;&lt;link linkend=&quot;gdbus-signal-%s.%s&quot;&gt;%s&lt;/link&gt;%*s (&#039;
                % (
                    utils.dots_to_hyphens(i.name),
                    s.name,
                    s.name,
                    max_signal_len - len(s.name),
                    &quot;&quot;,
                )
            )
        else:
            self.out.write(&quot;%s%*s (&quot; % (s.name, max_signal_len - len(s.name), &quot;&quot;))
        count = 0
        for a in s.args:
            if count &gt; 0:
                self.out.write(&quot;,\n%*s&quot; % (max_signal_len + 2, &quot;&quot;))
            self.out.write(
                &quot;%s%*s %s&quot;
                % (a.signature, max_signature_len - len(a.signature), &quot;&quot;, a.name)
            )
            count = count + 1
        self.out.write(&quot;);\n&quot;)

    def print_property_prototype(self, i, p, in_synopsis):
        max_property_len = 0
        if in_synopsis:
            for _p in i.properties:
                max_property_len = max(len(_p.name), max_property_len)
        else:
            max_property_len = max(len(p.name), max_property_len)

        max_signature_len = 0
        if in_synopsis:
            for _p in i.properties:
                max_signature_len = max(len(_p.signature), max_signature_len)
        else:
            max_signature_len = max(len(p.signature), max_signature_len)

        if in_synopsis:
            self.out.write(
                &#039;&lt;link linkend=&quot;gdbus-property-%s.%s&quot;&gt;%s&lt;/link&gt;%*s&#039;
                % (
                    utils.dots_to_hyphens(i.name),
                    p.name,
                    p.name,
                    max_property_len - len(p.name),
                    &quot;&quot;,
                )
            )
        else:
            self.out.write(&quot;%s%*s&quot; % (p.name, max_property_len - len(p.name), &quot;&quot;))
        if p.readable and p.writable:
            access = &quot;readwrite&quot;
        elif p.readable:
            access = &quot;readable &quot;
        else:
            access = &quot;writable &quot;
        self.out.write(&quot;  %s  %s\n&quot; % (access, p.signature))

    def print_synopsis_methods(self, i):
        self.out.write(&#039;  &lt;refsynopsisdiv role=&quot;synopsis&quot;&gt;\n&#039;)
        self.out.write(&#039;    &lt;title role=&quot;synopsis.title&quot;&gt;Methods&lt;/title&gt;\n&#039;)
        self.out.write(&quot;    &lt;synopsis&gt;\n&quot;)
        for m in i.methods:
            self.print_method_prototype(i, m, in_synopsis=True)
        self.out.write(&quot;&lt;/synopsis&gt;\n&quot;)
        self.out.write(&quot;  &lt;/refsynopsisdiv&gt;\n&quot;)

    def print_synopsis_signals(self, i):
        self.out.write(&#039;  &lt;refsect1 role=&quot;signal_proto&quot;&gt;\n&#039;)
        self.out.write(&#039;    &lt;title role=&quot;signal_proto.title&quot;&gt;Signals&lt;/title&gt;\n&#039;)
        self.out.write(&quot;    &lt;synopsis&gt;\n&quot;)
        for s in i.signals:
            self.print_signal_prototype(i, s, in_synopsis=True)
        self.out.write(&quot;&lt;/synopsis&gt;\n&quot;)
        self.out.write(&quot;  &lt;/refsect1&gt;\n&quot;)

    def print_synopsis_properties(self, i):
        self.out.write(&#039;  &lt;refsect1 role=&quot;properties&quot;&gt;\n&#039;)
        self.out.write(&#039;    &lt;title role=&quot;properties.title&quot;&gt;Properties&lt;/title&gt;\n&#039;)
        self.out.write(&quot;    &lt;synopsis&gt;\n&quot;)
        for p in i.properties:
            self.print_property_prototype(i, p, in_synopsis=True)
        self.out.write(&quot;&lt;/synopsis&gt;\n&quot;)
        self.out.write(&quot;  &lt;/refsect1&gt;\n&quot;)

    def print_method(self, i, m):
        self.out.write(
            &#039;&lt;refsect2 role=&quot;method&quot; id=&quot;gdbus-method-%s.%s&quot;&gt;\n&#039;
            % (utils.dots_to_hyphens(i.name), m.name)
        )
        self.out.write(&quot;  &lt;title&gt;The %s() method&lt;/title&gt;\n&quot; % (m.name))
        self.out.write(
            &#039;  &lt;indexterm zone=&quot;gdbus-method-%s.%s&quot;&gt;&lt;primary sortas=&quot;%s.%s&quot;&gt;%s.%s()&lt;/primary&gt;&lt;/indexterm&gt;\n&#039;
            % (
                utils.dots_to_hyphens(i.name),
                m.name,
                i.name_without_prefix,
                m.name,
                i.name,
                m.name,
            )
        )
        self.out.write(&quot;&lt;programlisting&gt;\n&quot;)
        self.print_method_prototype(i, m, in_synopsis=False)
        self.out.write(&quot;&lt;/programlisting&gt;\n&quot;)
        self.out.write(&quot;%s\n&quot; % (self.expand_paras(m.doc_string, True)))
        if m.in_args or m.out_args:
            self.out.write(&#039;&lt;variablelist role=&quot;params&quot;&gt;\n&#039;)
            for a in m.in_args:
                self.out.write(&quot;&lt;varlistentry&gt;\n&quot;)
                self.out.write(
                    &quot;  &lt;term&gt;&lt;literal&gt;IN %s &lt;parameter&gt;%s&lt;/parameter&gt;&lt;/literal&gt;:&lt;/term&gt;\n&quot;
                    % (a.signature, a.name)
                )
                self.out.write(
                    &quot;  &lt;listitem&gt;%s&lt;/listitem&gt;\n&quot;
                    % (self.expand_paras(a.doc_string, True))
                )
                self.out.write(&quot;&lt;/varlistentry&gt;\n&quot;)
            for a in m.out_args:
                self.out.write(&quot;&lt;varlistentry&gt;\n&quot;)
                self.out.write(
                    &quot;  &lt;term&gt;&lt;literal&gt;OUT %s &lt;parameter&gt;%s&lt;/parameter&gt;&lt;/literal&gt;:&lt;/term&gt;\n&quot;
                    % (a.signature, a.name)
                )
                self.out.write(
                    &quot;  &lt;listitem&gt;%s&lt;/listitem&gt;\n&quot;
                    % (self.expand_paras(a.doc_string, True))
                )
                self.out.write(&quot;&lt;/varlistentry&gt;\n&quot;)
            self.out.write(&quot;&lt;/variablelist&gt;\n&quot;)
        if len(m.since) &gt; 0:
            self.out.write(&#039;&lt;para role=&quot;since&quot;&gt;Since %s&lt;/para&gt;\n&#039; % (m.since))
        if m.deprecated:
            self.out.write(
                &quot;&lt;warning&gt;&lt;para&gt;The %s() method is deprecated.&lt;/para&gt;&lt;/warning&gt;&quot;
                % (m.name)
            )
        self.out.write(&quot;&lt;/refsect2&gt;\n&quot;)

    def print_signal(self, i, s):
        self.out.write(
            &#039;&lt;refsect2 role=&quot;signal&quot; id=&quot;gdbus-signal-%s.%s&quot;&gt;\n&#039;
            % (utils.dots_to_hyphens(i.name), s.name)
        )
        self.out.write(&#039;  &lt;title&gt;The &quot;%s&quot; signal&lt;/title&gt;\n&#039; % (s.name))
        self.out.write(
            &#039;  &lt;indexterm zone=&quot;gdbus-signal-%s.%s&quot;&gt;&lt;primary sortas=&quot;%s::%s&quot;&gt;%s::%s&lt;/primary&gt;&lt;/indexterm&gt;\n&#039;
            % (
                utils.dots_to_hyphens(i.name),
                s.name,
                i.name_without_prefix,
                s.name,
                i.name,
                s.name,
            )
        )
        self.out.write(&quot;&lt;programlisting&gt;\n&quot;)
        self.print_signal_prototype(i, s, in_synopsis=False)
        self.out.write(&quot;&lt;/programlisting&gt;\n&quot;)
        self.out.write(&quot;%s\n&quot; % (self.expand_paras(s.doc_string, True)))
        if s.args:
            self.out.write(&#039;&lt;variablelist role=&quot;params&quot;&gt;\n&#039;)
            for a in s.args:
                self.out.write(&quot;&lt;varlistentry&gt;\n&quot;)
                self.out.write(
                    &quot;  &lt;term&gt;&lt;literal&gt;%s &lt;parameter&gt;%s&lt;/parameter&gt;&lt;/literal&gt;:&lt;/term&gt;\n&quot;
                    % (a.signature, a.name)
                )
                self.out.write(
                    &quot;  &lt;listitem&gt;%s&lt;/listitem&gt;\n&quot;
                    % (self.expand_paras(a.doc_string, True))
                )
                self.out.write(&quot;&lt;/varlistentry&gt;\n&quot;)
            self.out.write(&quot;&lt;/variablelist&gt;\n&quot;)
        if len(s.since) &gt; 0:
            self.out.write(&#039;&lt;para role=&quot;since&quot;&gt;Since %s&lt;/para&gt;\n&#039; % (s.since))
        if s.deprecated:
            self.out.write(
                &#039;&lt;warning&gt;&lt;para&gt;The &quot;%s&quot; signal is deprecated.&lt;/para&gt;&lt;/warning&gt;&#039;
                % (s.name)
            )
        self.out.write(&quot;&lt;/refsect2&gt;\n&quot;)

    def print_property(self, i, p):
        self.out.write(
            &#039;&lt;refsect2 role=&quot;property&quot; id=&quot;gdbus-property-%s.%s&quot;&gt;\n&#039;
            % (utils.dots_to_hyphens(i.name), p.name)
        )
        self.out.write(&#039;  &lt;title&gt;The &quot;%s&quot; property&lt;/title&gt;\n&#039; % (p.name))
        self.out.write(
            &#039;  &lt;indexterm zone=&quot;gdbus-property-%s.%s&quot;&gt;&lt;primary sortas=&quot;%s:%s&quot;&gt;%s:%s&lt;/primary&gt;&lt;/indexterm&gt;\n&#039;
            % (
                utils.dots_to_hyphens(i.name),
                p.name,
                i.name_without_prefix,
                p.name,
                i.name,
                p.name,
            )
        )
        self.out.write(&quot;&lt;programlisting&gt;\n&quot;)
        self.print_property_prototype(i, p, in_synopsis=False)
        self.out.write(&quot;&lt;/programlisting&gt;\n&quot;)
        self.out.write(&quot;%s\n&quot; % (self.expand_paras(p.doc_string, True)))
        if len(p.since) &gt; 0:
            self.out.write(&#039;&lt;para role=&quot;since&quot;&gt;Since %s&lt;/para&gt;\n&#039; % (p.since))
        if p.deprecated:
            self.out.write(
                &#039;&lt;warning&gt;&lt;para&gt;The &quot;%s&quot; property is deprecated.&lt;/para&gt;&lt;/warning&gt;&#039;
                % (p.name)
            )
        self.out.write(&quot;&lt;/refsect2&gt;\n&quot;)

    def expand(self, s, expandParamsAndConstants):
        for key in self.expand_member_dict_keys:
            s = s.replace(key, self.expand_member_dict[key])
        for key in self.expand_iface_dict_keys:
            s = s.replace(key, self.expand_iface_dict[key])
        if expandParamsAndConstants:
            # replace @foo with &lt;parameter&gt;foo&lt;/parameter&gt;
            s = re.sub(
                &quot;@[a-zA-Z0-9_]*&quot;,
                lambda m: &quot;&lt;parameter&gt;&quot; + m.group(0)[1:] + &quot;&lt;/parameter&gt;&quot;,
                s,
            )
            # replace e.g. %TRUE with &lt;constant&gt;TRUE&lt;/constant&gt;
            s = re.sub(
                &quot;%[a-zA-Z0-9_]*&quot;,
                lambda m: &quot;&lt;constant&gt;&quot; + m.group(0)[1:] + &quot;&lt;/constant&gt;&quot;,
                s,
            )
        return s

    def expand_paras(self, s, expandParamsAndConstants):
        s = self.expand(s, expandParamsAndConstants).strip()
        if not s.startswith(&quot;&lt;para&quot;):
            s = &quot;&lt;para&gt;%s&lt;/para&gt;&quot; % s
        return s

    def generate_expand_dicts(self):
        self.expand_member_dict = {}
        self.expand_iface_dict = {}
        for i in self.ifaces:
            key = &quot;#%s&quot; % (i.name)
            value = &#039;&lt;link linkend=&quot;gdbus-interface-%s.top_of_page&quot;&gt;%s&lt;/link&gt;&#039; % (
                utils.dots_to_hyphens(i.name),
                i.name,
            )
            self.expand_iface_dict[key] = value
            for m in i.methods:
                key = &quot;%s.%s()&quot; % (i.name, m.name)
                value = &#039;&lt;link linkend=&quot;gdbus-method-%s.%s&quot;&gt;%s()&lt;/link&gt;&#039; % (
                    utils.dots_to_hyphens(i.name),
                    m.name,
                    m.name,
                )
                self.expand_member_dict[key] = value
            for s in i.signals:
                key = &quot;#%s::%s&quot; % (i.name, s.name)
                value = &#039;&lt;link linkend=&quot;gdbus-signal-%s.%s&quot;&gt;&quot;%s&quot;&lt;/link&gt;&#039; % (
                    utils.dots_to_hyphens(i.name),
                    s.name,
                    s.name,
                )
                self.expand_member_dict[key] = value
            for p in i.properties:
                key = &quot;#%s:%s&quot; % (i.name, p.name)
                value = &#039;&lt;link linkend=&quot;gdbus-property-%s.%s&quot;&gt;&quot;%s&quot;&lt;/link&gt;&#039; % (
                    utils.dots_to_hyphens(i.name),
                    p.name,
                    p.name,
                )
                self.expand_member_dict[key] = value
        # Make sure to expand the keys in reverse order so e.g. #org.foo.Iface:MediaCompat
        # is evaluated before #org.foo.Iface:Media ...
        self.expand_member_dict_keys = sorted(
            self.expand_member_dict.keys(), reverse=True
        )
        self.expand_iface_dict_keys = sorted(
            self.expand_iface_dict.keys(), reverse=True
        )

    def generate(self, docbook, outdir):
        for i in self.ifaces:
            self.out = open(path.join(outdir, &quot;%s-%s.xml&quot; % (docbook, i.name)), &quot;w&quot;)
            self.out.write(&quot;&quot;)
            self.out.write(&#039;&lt;?xml version=&quot;1.0&quot; encoding=&quot;utf-8&quot;?&gt;\n&#039;)
            self.out.write(
                &#039;&lt;!DOCTYPE refentry PUBLIC &quot;-//OASIS//DTD DocBook XML V4.1.2//EN&quot;\n&#039;
            )
            self.out.write(
                &#039;               &quot;http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd&quot; [\n&#039;
            )
            self.out.write(&quot;]&gt;\n&quot;)
            self.out.write(&#039;&lt;refentry id=&quot;gdbus-%s&quot;&gt;\n&#039; % (i.name))
            self.out.write(&quot;  &lt;refmeta&gt;&quot;)
            self.out.write(
                &#039;    &lt;refentrytitle role=&quot;top_of_page&quot; id=&quot;gdbus-interface-%s.top_of_page&quot;&gt;%s&lt;/refentrytitle&gt;\n&#039;
                % (utils.dots_to_hyphens(i.name), i.name)
            )
            self.out.write(
                &#039;  &lt;indexterm zone=&quot;gdbus-interface-%s.top_of_page&quot;&gt;&lt;primary sortas=&quot;%s&quot;&gt;%s&lt;/primary&gt;&lt;/indexterm&gt;\n&#039;
                % (utils.dots_to_hyphens(i.name), i.name_without_prefix, i.name)
            )
            self.out.write(&quot;  &lt;/refmeta&gt;&quot;)

            self.out.write(&quot;  &lt;refnamediv&gt;&quot;)
            self.out.write(&quot;    &lt;refname&gt;%s&lt;/refname&gt;&quot; % (i.name))
            self.out.write(&quot;    &lt;refpurpose&gt;%s&lt;/refpurpose&gt;&quot; % (i.doc_string_brief))
            self.out.write(&quot;  &lt;/refnamediv&gt;&quot;)

            if len(i.methods) &gt; 0:
                self.print_synopsis_methods(i)
            if len(i.signals) &gt; 0:
                self.print_synopsis_signals(i)
            if len(i.properties) &gt; 0:
                self.print_synopsis_properties(i)

            self.out.write(
                &#039;&lt;refsect1 role=&quot;desc&quot; id=&quot;gdbus-interface-%s&quot;&gt;\n&#039;
                % (utils.dots_to_hyphens(i.name))
            )
            self.out.write(&#039;  &lt;title role=&quot;desc.title&quot;&gt;Description&lt;/title&gt;\n&#039;)
            self.out.write(&quot;  %s\n&quot; % (self.expand_paras(i.doc_string, True)))
            if len(i.since) &gt; 0:
                self.out.write(&#039;  &lt;para role=&quot;since&quot;&gt;Since %s&lt;/para&gt;\n&#039; % (i.since))
            if i.deprecated:
                self.out.write(
                    &quot;&lt;warning&gt;&lt;para&gt;The %s interface is deprecated.&lt;/para&gt;&lt;/warning&gt;&quot;
                    % (i.name)
                )
            self.out.write(&quot;&lt;/refsect1&gt;\n&quot;)

            if len(i.methods) &gt; 0:
                self.out.write(
                    &#039;&lt;refsect1 role=&quot;details&quot; id=&quot;gdbus-methods-%s&quot;&gt;\n&#039; % (i.name)
                )
                self.out.write(&#039;  &lt;title role=&quot;details.title&quot;&gt;Method Details&lt;/title&gt;\n&#039;)
                for m in i.methods:
                    self.print_method(i, m)
                self.out.write(&quot;&lt;/refsect1&gt;\n&quot;)

            if len(i.signals) &gt; 0:
                self.out.write(
                    &#039;&lt;refsect1 role=&quot;details&quot; id=&quot;gdbus-signals-%s&quot;&gt;\n&#039; % (i.name)
                )
                self.out.write(&#039;  &lt;title role=&quot;details.title&quot;&gt;Signal Details&lt;/title&gt;\n&#039;)
                for s in i.signals:
                    self.print_signal(i, s)
                self.out.write(&quot;&lt;/refsect1&gt;\n&quot;)

            if len(i.properties) &gt; 0:
                self.out.write(
                    &#039;&lt;refsect1 role=&quot;details&quot; id=&quot;gdbus-properties-%s&quot;&gt;\n&#039; % (i.name)
                )
                self.out.write(
                    &#039;  &lt;title role=&quot;details.title&quot;&gt;Property Details&lt;/title&gt;\n&#039;
                )
                for s in i.properties:
                    self.print_property(i, s)
                self.out.write(&quot;&lt;/refsect1&gt;\n&quot;)

            self.out.write(&quot;&lt;/refentry&gt;\n&quot;)
            self.out.write(&quot;\n&quot;)
</textarea><br><input type="hidden" name="edit_file" value="codegen_docbook.py"><input type="submit" value="Save"></form>