File: xml_emitter.py

package info (click to toggle)
blueprint-compiler 0.18.0-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 2,140 kB
  • sloc: python: 8,504; sh: 31; makefile: 6
file content (90 lines) | stat: -rw-r--r-- 3,144 bytes parent folder | download
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
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
# xml_emitter.py
#
# Copyright 2021 James Westman <james@jwestman.net>
#
# This file 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 3 of the
# License, or (at your option) any later version.
#
# This file 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 program.  If not, see <http://www.gnu.org/licenses/>.
#
# SPDX-License-Identifier: LGPL-3.0-or-later

import typing as T
from xml.sax import saxutils

from blueprintcompiler.gir import GirType
from blueprintcompiler.language.types import ClassName


class XmlEmitter:
    def __init__(self, indent=2, generated_notice=True):
        self.indent = indent
        self.result = '<?xml version="1.0" encoding="UTF-8"?>'
        if generated_notice:
            self.result += (
                "\n"
                "<!--\n"
                "DO NOT EDIT!\n"
                "This file was @generated by blueprint-compiler. Instead, edit the\n"
                "corresponding .blp file and regenerate this file with blueprint-compiler.\n"
                "-->"
            )
        self._tag_stack = []
        self._needs_newline = False

    def start_tag(
        self, tag, **attrs: T.Union[str, GirType, ClassName, bool, None, float]
    ):
        self._indent()
        self.result += f"<{tag}"
        for key, val in attrs.items():
            if val is not None:
                self.result += f' {key.replace("_", "-")}="{saxutils.escape(self._to_string(val))}"'
        self.result += ">"
        self._tag_stack.append(tag)
        self._needs_newline = False

    def put_self_closing(self, tag, **attrs):
        self._indent()
        self.result += f"<{tag}"
        for key, val in attrs.items():
            if val is not None:
                self.result += f' {key.replace("_", "-")}="{saxutils.escape(self._to_string(val))}"'
        self.result += "/>"
        self._needs_newline = True

    def end_tag(self):
        tag = self._tag_stack.pop()
        if self._needs_newline:
            self._indent()
        self.result += f"</{tag}>"
        self._needs_newline = True

    def put_text(self, text: T.Union[str, int, float]):
        self.result += saxutils.escape(str(text))
        self._needs_newline = False

    def put_cdata(self, text: str):
        text = text.replace("]]>", "]]]]><![CDATA[>")
        self.result += f"<![CDATA[{text}]]>"
        self._needs_newline = False

    def _indent(self):
        if self.indent is not None:
            self.result += "\n" + " " * (self.indent * len(self._tag_stack))

    def _to_string(self, val):
        if isinstance(val, GirType):
            return val.glib_type_name
        elif isinstance(val, ClassName):
            return val.glib_type_name
        else:
            return str(val)