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 if attrs and not attrs.empty(): 137 attrs.to_string(self) 138 139 def end_table_cell(self): 140 self.out("||") 141 142 def start_table_row(self): 143 self.out("||") 144 145 def end_table_row(self, trailing): 146 self.out(trailing) 147 148 def start_underline(self): 149 self.out("__") 150 151 def end_underline(self): 152 self.out("__") 153 154 def break_(self): 155 self.out("\n") 156 157 def rule(self, length): 158 self.out("-" * length) 159 160 def table_attr(self, name, value, concise, quote): 161 if concise: 162 if name == "colour": self.out(value) 163 elif name == "colspan": self.out("-%s" % value) 164 elif name == "halign" : self.out(value == "left" and "(" or value == "right" and ")" or ":") 165 elif name == "rowspan": self.out("|%s" % value) 166 elif name == "valign" : self.out(value == "top" and "^" or "v") 167 elif name == "width" : self.out(value) 168 else: 169 self.out("%s%s" % (escape_text(name), value is not None and 170 "=%s%s%s" % (quote or '"', escape_attr(value), quote or '"') or "")) 171 172 def text(self, s): 173 self.out(s) 174 175 class HTMLSerialiser(Serialiser): 176 177 "Serialisation of the page." 178 179 def start_region(self, level, indent, type): 180 l = [] 181 out = l.append 182 if level: 183 out("level-%d" % level) 184 185 if indent: 186 out("indent-%d" % indent) 187 188 # NOTE: Encode type details for CSS. 189 190 if type: 191 out("type-%s" % escape_attr(type)) 192 193 self.out("<span class='%s'>" % " ".join(l)) 194 195 def end_region(self, level, indent, type): 196 self.out("</span>") 197 198 def start_block(self): 199 self.out("<p>") 200 201 def end_block(self): 202 self.out("</p>") 203 204 def start_defitem(self, pad, extra): 205 self.out("<dd>") 206 207 def end_defitem(self, pad, extra): 208 self.out("</dd>") 209 210 def start_defterm(self, pad): 211 self.out("<dt>") 212 213 def end_defterm(self, pad): 214 self.out("</dt>") 215 216 def start_emphasis(self): 217 self.out("<em>") 218 219 def end_emphasis(self): 220 self.out("</em>") 221 222 def start_heading(self, level, extra, pad): 223 self.out("<h%d>" % level) 224 225 def end_heading(self, level, pad, extra): 226 self.out("</h%d>" % level) 227 228 def start_larger(self): 229 self.out("<big>") 230 231 def end_larger(self): 232 self.out("</big>") 233 234 def start_listitem(self, indent, marker, space): 235 self.out("<li>") 236 237 def end_listitem(self, indent, marker): 238 self.out("</li>") 239 240 def start_monospace(self): 241 self.out("<tt>") 242 243 def end_monospace(self): 244 self.out("</tt>") 245 246 def start_smaller(self): 247 self.out("<small>") 248 249 def end_smaller(self): 250 self.out("</small>") 251 252 def start_strong(self): 253 self.out("<strong>") 254 255 def end_strong(self): 256 self.out("</strong>") 257 258 def start_subscript(self): 259 self.out("<sub>") 260 261 def end_subscript(self): 262 self.out("</sub>") 263 264 def start_superscript(self): 265 self.out("<sup>") 266 267 def end_superscript(self): 268 self.out("</sup>") 269 270 def start_table_attrs(self): 271 pass 272 273 def end_table_attrs(self): 274 pass 275 276 def start_table_cell(self, attrs): 277 self.out("<td") 278 if attrs and not attrs.empty(): 279 attrs.to_string(self) 280 self.out(">") 281 282 def end_table_cell(self): 283 self.out("</td>") 284 285 def start_table_row(self): 286 self.out("<tr>") 287 288 def end_table_row(self, trailing): 289 self.out("</tr>") 290 291 def start_underline(self): 292 self.out("<span style='text-decoration: underline'>") 293 294 def end_underline(self): 295 self.out("</span>") 296 297 def break_(self): 298 pass 299 300 def rule(self, length): 301 self.out("<hr style='height: %dpt' />" % min(length, 10)) 302 303 def table_attr(self, name, value, concise, quote): 304 self.out(" %s%s" % (escape_text(name), value is not None and 305 "='%s'" % escape_attr(value) or "")) 306 307 def text(self, s): 308 self.out(escape_text(s)) 309 310 # Top-level functions. 311 312 def serialise(doc, serialiser=MoinSerialiser): 313 l = [] 314 doc.to_string(serialiser(l.append)) 315 return "".join(l) 316 317 # vim: tabstop=4 expandtab shiftwidth=4