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