paul@11 | 1 | #!/usr/bin/env python |
paul@11 | 2 | |
paul@11 | 3 | """ |
paul@11 | 4 | Moin wiki serialisers. |
paul@11 | 5 | |
paul@11 | 6 | Copyright (C) 2017 Paul Boddie <paul@boddie.org.uk> |
paul@11 | 7 | |
paul@11 | 8 | This program is free software; you can redistribute it and/or modify it under |
paul@11 | 9 | the terms of the GNU General Public License as published by the Free Software |
paul@11 | 10 | Foundation; either version 3 of the License, or (at your option) any later |
paul@11 | 11 | version. |
paul@11 | 12 | |
paul@11 | 13 | This program is distributed in the hope that it will be useful, but WITHOUT |
paul@11 | 14 | ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS |
paul@11 | 15 | FOR A PARTICULAR PURPOSE. See the GNU General Public License for more |
paul@11 | 16 | details. |
paul@11 | 17 | |
paul@11 | 18 | You should have received a copy of the GNU General Public License along with |
paul@11 | 19 | this program. If not, see <http://www.gnu.org/licenses/>. |
paul@11 | 20 | """ |
paul@11 | 21 | |
paul@25 | 22 | def escape_text(s): |
paul@25 | 23 | |
paul@25 | 24 | "Escape XML document text." |
paul@25 | 25 | |
paul@25 | 26 | return s.replace("&", "&").replace("<", "<").replace(">", ">") |
paul@25 | 27 | |
paul@25 | 28 | def escape_attr(s): |
paul@25 | 29 | |
paul@25 | 30 | "Escape XML document attribute." |
paul@25 | 31 | |
paul@25 | 32 | return escape_text(s).replace("'", "'").replace('"', """) |
paul@11 | 33 | |
paul@11 | 34 | class Serialiser: |
paul@11 | 35 | |
paul@11 | 36 | "General serialisation support." |
paul@11 | 37 | |
paul@11 | 38 | def __init__(self, out): |
paul@11 | 39 | self.out = out |
paul@11 | 40 | |
paul@11 | 41 | class MoinSerialiser(Serialiser): |
paul@11 | 42 | |
paul@11 | 43 | "Serialisation of the page." |
paul@11 | 44 | |
paul@11 | 45 | def start_region(self, level, indent, type): |
paul@11 | 46 | out = self.out |
paul@11 | 47 | if level: |
paul@11 | 48 | out(" " * indent + "{" * level) |
paul@11 | 49 | if type and level: |
paul@11 | 50 | out("#!%s\n" % type) |
paul@11 | 51 | |
paul@11 | 52 | def end_region(self, level, indent, type): |
paul@11 | 53 | out = self.out |
paul@11 | 54 | if level: |
paul@11 | 55 | out("}" * level) |
paul@11 | 56 | |
paul@15 | 57 | def start_block(self): |
paul@11 | 58 | pass |
paul@11 | 59 | |
paul@15 | 60 | def end_block(self): |
paul@15 | 61 | pass |
paul@11 | 62 | |
paul@16 | 63 | def start_defitem(self, pad, extra): |
paul@16 | 64 | self.out((extra and "\n" + extra + "::" or "") + pad) |
paul@16 | 65 | |
paul@16 | 66 | def end_defitem(self, pad, extra): |
paul@16 | 67 | pass |
paul@16 | 68 | |
paul@16 | 69 | def start_defterm(self, pad): |
paul@16 | 70 | self.out(pad) |
paul@16 | 71 | |
paul@16 | 72 | def end_defterm(self, pad): |
paul@16 | 73 | self.out("::") |
paul@16 | 74 | |
paul@17 | 75 | def start_emphasis(self): |
paul@17 | 76 | self.out("''") |
paul@17 | 77 | |
paul@17 | 78 | def end_emphasis(self): |
paul@17 | 79 | self.out("''") |
paul@17 | 80 | |
paul@13 | 81 | def start_heading(self, level, extra, pad): |
paul@13 | 82 | self.out(extra + "=" * level + pad) |
paul@13 | 83 | |
paul@13 | 84 | def end_heading(self, level, pad, extra): |
paul@13 | 85 | self.out(pad + "=" * level + extra) |
paul@13 | 86 | |
paul@23 | 87 | def start_larger(self): |
paul@23 | 88 | self.out("~+") |
paul@23 | 89 | |
paul@23 | 90 | def end_larger(self): |
paul@23 | 91 | self.out("+~") |
paul@23 | 92 | |
paul@14 | 93 | def start_listitem(self, indent, marker, space): |
paul@14 | 94 | self.out("%s%s%s" % (indent * " ", marker, space)) |
paul@11 | 95 | |
paul@14 | 96 | def end_listitem(self, indent, marker): |
paul@11 | 97 | pass |
paul@11 | 98 | |
paul@18 | 99 | def start_monospace(self): |
paul@18 | 100 | self.out("`") |
paul@18 | 101 | |
paul@18 | 102 | def end_monospace(self): |
paul@18 | 103 | self.out("`") |
paul@18 | 104 | |
paul@23 | 105 | def start_smaller(self): |
paul@23 | 106 | self.out("~-") |
paul@23 | 107 | |
paul@23 | 108 | def end_smaller(self): |
paul@23 | 109 | self.out("-~") |
paul@23 | 110 | |
paul@17 | 111 | def start_strong(self): |
paul@17 | 112 | self.out("'''") |
paul@17 | 113 | |
paul@17 | 114 | def end_strong(self): |
paul@17 | 115 | self.out("'''") |
paul@17 | 116 | |
paul@20 | 117 | def start_subscript(self): |
paul@20 | 118 | self.out(",,") |
paul@20 | 119 | |
paul@20 | 120 | def end_subscript(self): |
paul@20 | 121 | self.out(",,") |
paul@20 | 122 | |
paul@20 | 123 | def start_superscript(self): |
paul@20 | 124 | self.out("^") |
paul@20 | 125 | |
paul@20 | 126 | def end_superscript(self): |
paul@20 | 127 | self.out("^") |
paul@20 | 128 | |
paul@25 | 129 | def start_table_attrs(self): |
paul@25 | 130 | self.out("<") |
paul@25 | 131 | |
paul@25 | 132 | def end_table_attrs(self): |
paul@25 | 133 | self.out(">") |
paul@25 | 134 | |
paul@25 | 135 | def start_table_cell(self, attrs): |
paul@28 | 136 | self.out("||") |
paul@25 | 137 | if attrs and not attrs.empty(): |
paul@25 | 138 | attrs.to_string(self) |
paul@24 | 139 | |
paul@24 | 140 | def end_table_cell(self): |
paul@28 | 141 | pass |
paul@24 | 142 | |
paul@24 | 143 | def start_table_row(self): |
paul@28 | 144 | pass |
paul@24 | 145 | |
paul@24 | 146 | def end_table_row(self, trailing): |
paul@28 | 147 | self.out("||") |
paul@24 | 148 | self.out(trailing) |
paul@24 | 149 | |
paul@19 | 150 | def start_underline(self): |
paul@19 | 151 | self.out("__") |
paul@19 | 152 | |
paul@19 | 153 | def end_underline(self): |
paul@19 | 154 | self.out("__") |
paul@19 | 155 | |
paul@15 | 156 | def break_(self): |
paul@15 | 157 | self.out("\n") |
paul@15 | 158 | |
paul@12 | 159 | def rule(self, length): |
paul@12 | 160 | self.out("-" * length) |
paul@12 | 161 | |
paul@27 | 162 | def table_attr(self, name, value, concise, quote): |
paul@25 | 163 | if concise: |
paul@25 | 164 | if name == "colour": self.out(value) |
paul@25 | 165 | elif name == "colspan": self.out("-%s" % value) |
paul@25 | 166 | elif name == "halign" : self.out(value == "left" and "(" or value == "right" and ")" or ":") |
paul@25 | 167 | elif name == "rowspan": self.out("|%s" % value) |
paul@25 | 168 | elif name == "valign" : self.out(value == "top" and "^" or "v") |
paul@25 | 169 | elif name == "width" : self.out(value) |
paul@25 | 170 | else: |
paul@27 | 171 | self.out("%s%s" % (escape_text(name), value is not None and |
paul@27 | 172 | "=%s%s%s" % (quote or '"', escape_attr(value), quote or '"') or "")) |
paul@25 | 173 | |
paul@11 | 174 | def text(self, s): |
paul@11 | 175 | self.out(s) |
paul@11 | 176 | |
paul@11 | 177 | class HTMLSerialiser(Serialiser): |
paul@11 | 178 | |
paul@11 | 179 | "Serialisation of the page." |
paul@11 | 180 | |
paul@11 | 181 | def start_region(self, level, indent, type): |
paul@11 | 182 | l = [] |
paul@11 | 183 | out = l.append |
paul@11 | 184 | if level: |
paul@11 | 185 | out("level-%d" % level) |
paul@11 | 186 | |
paul@11 | 187 | if indent: |
paul@11 | 188 | out("indent-%d" % indent) |
paul@11 | 189 | |
paul@11 | 190 | # NOTE: Encode type details for CSS. |
paul@11 | 191 | |
paul@11 | 192 | if type: |
paul@25 | 193 | out("type-%s" % escape_attr(type)) |
paul@11 | 194 | |
paul@11 | 195 | self.out("<span class='%s'>" % " ".join(l)) |
paul@11 | 196 | |
paul@11 | 197 | def end_region(self, level, indent, type): |
paul@11 | 198 | self.out("</span>") |
paul@11 | 199 | |
paul@15 | 200 | def start_block(self): |
paul@11 | 201 | self.out("<p>") |
paul@11 | 202 | |
paul@15 | 203 | def end_block(self): |
paul@11 | 204 | self.out("</p>") |
paul@11 | 205 | |
paul@16 | 206 | def start_defitem(self, pad, extra): |
paul@16 | 207 | self.out("<dd>") |
paul@16 | 208 | |
paul@16 | 209 | def end_defitem(self, pad, extra): |
paul@16 | 210 | self.out("</dd>") |
paul@16 | 211 | |
paul@16 | 212 | def start_defterm(self, pad): |
paul@16 | 213 | self.out("<dt>") |
paul@16 | 214 | |
paul@16 | 215 | def end_defterm(self, pad): |
paul@16 | 216 | self.out("</dt>") |
paul@16 | 217 | |
paul@17 | 218 | def start_emphasis(self): |
paul@17 | 219 | self.out("<em>") |
paul@17 | 220 | |
paul@17 | 221 | def end_emphasis(self): |
paul@17 | 222 | self.out("</em>") |
paul@17 | 223 | |
paul@13 | 224 | def start_heading(self, level, extra, pad): |
paul@13 | 225 | self.out("<h%d>" % level) |
paul@13 | 226 | |
paul@13 | 227 | def end_heading(self, level, pad, extra): |
paul@13 | 228 | self.out("</h%d>" % level) |
paul@13 | 229 | |
paul@23 | 230 | def start_larger(self): |
paul@23 | 231 | self.out("<big>") |
paul@23 | 232 | |
paul@23 | 233 | def end_larger(self): |
paul@23 | 234 | self.out("</big>") |
paul@23 | 235 | |
paul@14 | 236 | def start_listitem(self, indent, marker, space): |
paul@11 | 237 | self.out("<li>") |
paul@11 | 238 | |
paul@14 | 239 | def end_listitem(self, indent, marker): |
paul@11 | 240 | self.out("</li>") |
paul@11 | 241 | |
paul@18 | 242 | def start_monospace(self): |
paul@18 | 243 | self.out("<tt>") |
paul@18 | 244 | |
paul@18 | 245 | def end_monospace(self): |
paul@18 | 246 | self.out("</tt>") |
paul@18 | 247 | |
paul@23 | 248 | def start_smaller(self): |
paul@23 | 249 | self.out("<small>") |
paul@23 | 250 | |
paul@23 | 251 | def end_smaller(self): |
paul@23 | 252 | self.out("</small>") |
paul@23 | 253 | |
paul@17 | 254 | def start_strong(self): |
paul@17 | 255 | self.out("<strong>") |
paul@17 | 256 | |
paul@17 | 257 | def end_strong(self): |
paul@17 | 258 | self.out("</strong>") |
paul@17 | 259 | |
paul@20 | 260 | def start_subscript(self): |
paul@20 | 261 | self.out("<sub>") |
paul@20 | 262 | |
paul@20 | 263 | def end_subscript(self): |
paul@20 | 264 | self.out("</sub>") |
paul@20 | 265 | |
paul@20 | 266 | def start_superscript(self): |
paul@20 | 267 | self.out("<sup>") |
paul@20 | 268 | |
paul@20 | 269 | def end_superscript(self): |
paul@20 | 270 | self.out("</sup>") |
paul@20 | 271 | |
paul@25 | 272 | def start_table_attrs(self): |
paul@25 | 273 | pass |
paul@25 | 274 | |
paul@25 | 275 | def end_table_attrs(self): |
paul@25 | 276 | pass |
paul@25 | 277 | |
paul@25 | 278 | def start_table_cell(self, attrs): |
paul@25 | 279 | self.out("<td") |
paul@25 | 280 | if attrs and not attrs.empty(): |
paul@25 | 281 | attrs.to_string(self) |
paul@25 | 282 | self.out(">") |
paul@24 | 283 | |
paul@24 | 284 | def end_table_cell(self): |
paul@24 | 285 | self.out("</td>") |
paul@24 | 286 | |
paul@24 | 287 | def start_table_row(self): |
paul@24 | 288 | self.out("<tr>") |
paul@24 | 289 | |
paul@24 | 290 | def end_table_row(self, trailing): |
paul@24 | 291 | self.out("</tr>") |
paul@24 | 292 | |
paul@19 | 293 | def start_underline(self): |
paul@19 | 294 | self.out("<span style='text-decoration: underline'>") |
paul@19 | 295 | |
paul@19 | 296 | def end_underline(self): |
paul@19 | 297 | self.out("</span>") |
paul@19 | 298 | |
paul@15 | 299 | def break_(self): |
paul@15 | 300 | pass |
paul@15 | 301 | |
paul@12 | 302 | def rule(self, length): |
paul@12 | 303 | self.out("<hr style='height: %dpt' />" % min(length, 10)) |
paul@12 | 304 | |
paul@27 | 305 | def table_attr(self, name, value, concise, quote): |
paul@27 | 306 | self.out(" %s%s" % (escape_text(name), value is not None and |
paul@27 | 307 | "='%s'" % escape_attr(value) or "")) |
paul@25 | 308 | |
paul@11 | 309 | def text(self, s): |
paul@25 | 310 | self.out(escape_text(s)) |
paul@11 | 311 | |
paul@11 | 312 | # Top-level functions. |
paul@11 | 313 | |
paul@11 | 314 | def serialise(doc, serialiser=MoinSerialiser): |
paul@11 | 315 | l = [] |
paul@11 | 316 | doc.to_string(serialiser(l.append)) |
paul@11 | 317 | return "".join(l) |
paul@11 | 318 | |
paul@11 | 319 | # vim: tabstop=4 expandtab shiftwidth=4 |