summaryrefslogtreecommitdiff
path: root/lib/gir.py
blob: 8ec786fe9bc1a0048c0e5a72b0027abe94154b17 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
"""
Vala's generated gir does not contain comments,
so we use valadoc to generate them. However, they are formatted
for valadoc and not gi-docgen so we need to fix it.
"""

import xml.etree.ElementTree as ET
import html
import sys
import subprocess


def fix_gir(gir: str):
    namespaces = {
        "": "http://www.gtk.org/introspection/core/1.0",
        "c": "http://www.gtk.org/introspection/c/1.0",
        "glib": "http://www.gtk.org/introspection/glib/1.0",
    }
    for prefix, uri in namespaces.items():
        ET.register_namespace(prefix, uri)

    tree = ET.parse(gir)
    root = tree.getroot()

    for doc in root.findall(".//doc", namespaces):
        if doc.text:
            doc.text = (
                html.unescape(doc.text).replace("<para>", "").replace("</para>", "")
            )

    tree.write(gir, encoding="utf-8", xml_declaration=True)


def valadoc(gir: str, args: list[str]):
    subprocess.run(["valadoc", "-o", "docs", "--gir", gir, *args])


if __name__ == "__main__":
    gir = sys.argv[1]
    args = sys.argv[2:]

    valadoc(gir, args)
    fix_gir(gir)