MoinLight

Annotated moinformat/serialisers/moin.py

77:d1ff325fc3f9
2018-07-23 Paul Boddie Added initial support for macro elements.
paul@38 1
#!/usr/bin/env python
paul@38 2
paul@38 3
"""
paul@38 4
Moin wiki text serialiser.
paul@38 5
paul@47 6
Copyright (C) 2017, 2018 Paul Boddie <paul@boddie.org.uk>
paul@38 7
paul@38 8
This program is free software; you can redistribute it and/or modify it under
paul@38 9
the terms of the GNU General Public License as published by the Free Software
paul@38 10
Foundation; either version 3 of the License, or (at your option) any later
paul@38 11
version.
paul@38 12
paul@38 13
This program is distributed in the hope that it will be useful, but WITHOUT
paul@38 14
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
paul@38 15
FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
paul@38 16
details.
paul@38 17
paul@38 18
You should have received a copy of the GNU General Public License along with
paul@38 19
this program.  If not, see <http://www.gnu.org/licenses/>.
paul@38 20
"""
paul@38 21
paul@38 22
from moinformat.serialisers.common import escape_attr, escape_text, Serialiser
paul@38 23
paul@38 24
class MoinSerialiser(Serialiser):
paul@38 25
paul@38 26
    "Serialisation of the page."
paul@38 27
paul@67 28
    def start_region(self, level, indent, type, extra):
paul@38 29
        out = self.out
paul@38 30
        if level:
paul@38 31
            out(" " * indent + "{" * level)
paul@52 32
paul@52 33
        # Produce a header for regions within a top-level region.
paul@52 34
paul@52 35
        if type and type != "inline" and level:
paul@38 36
            out("#!%s\n" % type)
paul@38 37
paul@67 38
    def end_region(self, level, indent, type, extra):
paul@38 39
        out = self.out
paul@38 40
        if level:
paul@67 41
            out("%s%s" % ("}" * level, extra or ""))
paul@38 42
paul@38 43
    def start_block(self):
paul@38 44
        pass
paul@38 45
paul@38 46
    def end_block(self):
paul@38 47
        pass
paul@38 48
paul@38 49
    def start_defitem(self, pad, extra):
paul@38 50
        self.out((extra and "\n" + extra + "::" or "") + pad)
paul@38 51
paul@38 52
    def end_defitem(self, pad, extra):
paul@38 53
        pass
paul@38 54
paul@38 55
    def start_defterm(self, pad):
paul@38 56
        self.out(pad)
paul@38 57
paul@38 58
    def end_defterm(self, pad):
paul@38 59
        self.out("::")
paul@38 60
paul@38 61
    def start_emphasis(self):
paul@38 62
        self.out("''")
paul@38 63
paul@38 64
    def end_emphasis(self):
paul@38 65
        self.out("''")
paul@38 66
paul@38 67
    def start_heading(self, level, extra, pad):
paul@38 68
        self.out(extra + "=" * level + pad)
paul@38 69
paul@38 70
    def end_heading(self, level, pad, extra):
paul@38 71
        self.out(pad + "=" * level + extra)
paul@38 72
paul@38 73
    def start_larger(self):
paul@38 74
        self.out("~+")
paul@38 75
paul@38 76
    def end_larger(self):
paul@38 77
        self.out("+~")
paul@38 78
paul@47 79
    def start_link(self, target):
paul@47 80
        self.out("[[%s" % target)
paul@47 81
paul@47 82
    def end_link(self):
paul@47 83
        self.out("]]")
paul@47 84
paul@47 85
    def start_linktext(self):
paul@47 86
        self.out("|")
paul@47 87
paul@47 88
    def end_linktext(self):
paul@47 89
        pass
paul@47 90
paul@51 91
    def start_list(self, indent, marker, num):
paul@43 92
        pass
paul@43 93
paul@51 94
    def end_list(self, indent, marker, num):
paul@43 95
        pass
paul@43 96
paul@51 97
    def start_listitem(self, indent, marker, space, num):
paul@55 98
        self.out("%s%s%s%s" % (indent * " ", marker, num and "#%s" % num or "", space))
paul@38 99
paul@51 100
    def end_listitem(self, indent, marker, space, num):
paul@38 101
        pass
paul@38 102
paul@38 103
    def start_monospace(self):
paul@38 104
        self.out("`")
paul@38 105
paul@38 106
    def end_monospace(self):
paul@38 107
        self.out("`")
paul@38 108
paul@38 109
    def start_smaller(self):
paul@38 110
        self.out("~-")
paul@38 111
paul@38 112
    def end_smaller(self):
paul@38 113
        self.out("-~")
paul@38 114
paul@38 115
    def start_strong(self):
paul@38 116
        self.out("'''")
paul@38 117
paul@38 118
    def end_strong(self):
paul@38 119
        self.out("'''")
paul@38 120
paul@48 121
    def start_strikethrough(self):
paul@48 122
        self.out("--(")
paul@48 123
paul@48 124
    def end_strikethrough(self):
paul@48 125
        self.out(")--")
paul@48 126
paul@38 127
    def start_subscript(self):
paul@38 128
        self.out(",,")
paul@38 129
paul@38 130
    def end_subscript(self):
paul@38 131
        self.out(",,")
paul@38 132
paul@38 133
    def start_superscript(self):
paul@38 134
        self.out("^")
paul@38 135
paul@38 136
    def end_superscript(self):
paul@38 137
        self.out("^")
paul@38 138
paul@38 139
    def start_table(self):
paul@38 140
        pass
paul@38 141
paul@38 142
    def end_table(self):
paul@38 143
        pass
paul@38 144
paul@38 145
    def start_table_attrs(self):
paul@38 146
        self.out("<")
paul@38 147
paul@38 148
    def end_table_attrs(self):
paul@38 149
        self.out(">")
paul@38 150
paul@38 151
    def start_table_cell(self, attrs):
paul@38 152
        self.out("||")
paul@38 153
        if attrs and not attrs.empty():
paul@38 154
            attrs.to_string(self)
paul@38 155
paul@38 156
    def end_table_cell(self):
paul@38 157
        pass
paul@38 158
paul@38 159
    def start_table_row(self):
paul@38 160
        pass
paul@38 161
paul@38 162
    def end_table_row(self, trailing):
paul@38 163
        self.out("||")
paul@38 164
        self.out(trailing)
paul@38 165
paul@38 166
    def start_underline(self):
paul@38 167
        self.out("__")
paul@38 168
paul@38 169
    def end_underline(self):
paul@38 170
        self.out("__")
paul@38 171
paul@38 172
    def break_(self):
paul@38 173
        self.out("\n")
paul@38 174
paul@72 175
    def continuation(self, text):
paul@72 176
        self.out(text)
paul@72 177
paul@77 178
    def macro(self, name, args):
paul@77 179
        self.out("<<%s%s>>" % (name, args and "(%s)" % ",".join(args) or ""))
paul@77 180
paul@38 181
    def rule(self, length):
paul@38 182
        self.out("-" * length)
paul@38 183
paul@38 184
    def table_attr(self, name, value, concise, quote):
paul@38 185
        if concise:
paul@38 186
            if name == "colour": self.out(value)
paul@38 187
            elif name == "colspan": self.out("-%s" % value)
paul@38 188
            elif name == "halign" : self.out(value == "left" and "(" or value == "right" and ")" or ":")
paul@38 189
            elif name == "rowspan": self.out("|%s" % value)
paul@38 190
            elif name == "valign" : self.out(value == "top" and "^" or "v")
paul@38 191
            elif name == "width" : self.out(value)
paul@38 192
        else:
paul@38 193
            self.out("%s%s" % (escape_text(name), value is not None and
paul@38 194
                               "=%s%s%s" % (quote or '"', escape_attr(value), quote or '"') or ""))
paul@38 195
paul@38 196
    def text(self, s):
paul@38 197
        self.out(s)
paul@38 198
paul@39 199
serialiser = MoinSerialiser
paul@39 200
paul@38 201
# vim: tabstop=4 expandtab shiftwidth=4