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 from cgi import escape 23 24 class Serialiser: 25 26 "General serialisation support." 27 28 def __init__(self, out): 29 self.out = out 30 31 class MoinSerialiser(Serialiser): 32 33 "Serialisation of the page." 34 35 def start_region(self, level, indent, type): 36 out = self.out 37 if level: 38 out(" " * indent + "{" * level) 39 if type and level: 40 out("#!%s\n" % type) 41 42 def end_region(self, level, indent, type): 43 out = self.out 44 if level: 45 out("}" * level) 46 47 def start_block(self): 48 pass 49 50 def end_block(self): 51 pass 52 53 def start_defitem(self, pad, extra): 54 self.out((extra and "\n" + extra + "::" or "") + pad) 55 56 def end_defitem(self, pad, extra): 57 pass 58 59 def start_defterm(self, pad): 60 self.out(pad) 61 62 def end_defterm(self, pad): 63 self.out("::") 64 65 def start_emphasis(self): 66 self.out("''") 67 68 def end_emphasis(self): 69 self.out("''") 70 71 def start_heading(self, level, extra, pad): 72 self.out(extra + "=" * level + pad) 73 74 def end_heading(self, level, pad, extra): 75 self.out(pad + "=" * level + extra) 76 77 def start_larger(self): 78 self.out("~+") 79 80 def end_larger(self): 81 self.out("+~") 82 83 def start_listitem(self, indent, marker, space): 84 self.out("%s%s%s" % (indent * " ", marker, space)) 85 86 def end_listitem(self, indent, marker): 87 pass 88 89 def start_monospace(self): 90 self.out("`") 91 92 def end_monospace(self): 93 self.out("`") 94 95 def start_smaller(self): 96 self.out("~-") 97 98 def end_smaller(self): 99 self.out("-~") 100 101 def start_strong(self): 102 self.out("'''") 103 104 def end_strong(self): 105 self.out("'''") 106 107 def start_subscript(self): 108 self.out(",,") 109 110 def end_subscript(self): 111 self.out(",,") 112 113 def start_superscript(self): 114 self.out("^") 115 116 def end_superscript(self): 117 self.out("^") 118 119 def start_table_cell(self): 120 pass 121 122 def end_table_cell(self): 123 self.out("||") 124 125 def start_table_row(self): 126 self.out("||") 127 128 def end_table_row(self, trailing): 129 self.out(trailing) 130 131 def start_underline(self): 132 self.out("__") 133 134 def end_underline(self): 135 self.out("__") 136 137 def break_(self): 138 self.out("\n") 139 140 def rule(self, length): 141 self.out("-" * length) 142 143 def text(self, s): 144 self.out(s) 145 146 class HTMLSerialiser(Serialiser): 147 148 "Serialisation of the page." 149 150 def start_region(self, level, indent, type): 151 l = [] 152 out = l.append 153 if level: 154 out("level-%d" % level) 155 156 if indent: 157 out("indent-%d" % indent) 158 159 # NOTE: Encode type details for CSS. 160 161 if type: 162 out("type-%s" % escape(type, True)) 163 164 self.out("<span class='%s'>" % " ".join(l)) 165 166 def end_region(self, level, indent, type): 167 self.out("</span>") 168 169 def start_block(self): 170 self.out("<p>") 171 172 def end_block(self): 173 self.out("</p>") 174 175 def start_defitem(self, pad, extra): 176 self.out("<dd>") 177 178 def end_defitem(self, pad, extra): 179 self.out("</dd>") 180 181 def start_defterm(self, pad): 182 self.out("<dt>") 183 184 def end_defterm(self, pad): 185 self.out("</dt>") 186 187 def start_emphasis(self): 188 self.out("<em>") 189 190 def end_emphasis(self): 191 self.out("</em>") 192 193 def start_heading(self, level, extra, pad): 194 self.out("<h%d>" % level) 195 196 def end_heading(self, level, pad, extra): 197 self.out("</h%d>" % level) 198 199 def start_larger(self): 200 self.out("<big>") 201 202 def end_larger(self): 203 self.out("</big>") 204 205 def start_listitem(self, indent, marker, space): 206 self.out("<li>") 207 208 def end_listitem(self, indent, marker): 209 self.out("</li>") 210 211 def start_monospace(self): 212 self.out("<tt>") 213 214 def end_monospace(self): 215 self.out("</tt>") 216 217 def start_smaller(self): 218 self.out("<small>") 219 220 def end_smaller(self): 221 self.out("</small>") 222 223 def start_strong(self): 224 self.out("<strong>") 225 226 def end_strong(self): 227 self.out("</strong>") 228 229 def start_subscript(self): 230 self.out("<sub>") 231 232 def end_subscript(self): 233 self.out("</sub>") 234 235 def start_superscript(self): 236 self.out("<sup>") 237 238 def end_superscript(self): 239 self.out("</sup>") 240 241 def start_table_cell(self): 242 self.out("<td>") 243 244 def end_table_cell(self): 245 self.out("</td>") 246 247 def start_table_row(self): 248 self.out("<tr>") 249 250 def end_table_row(self, trailing): 251 self.out("</tr>") 252 253 def start_underline(self): 254 self.out("<span style='text-decoration: underline'>") 255 256 def end_underline(self): 257 self.out("</span>") 258 259 def break_(self): 260 pass 261 262 def rule(self, length): 263 self.out("<hr style='height: %dpt' />" % min(length, 10)) 264 265 def text(self, s): 266 self.out(escape(s)) 267 268 # Top-level functions. 269 270 def serialise(doc, serialiser=MoinSerialiser): 271 l = [] 272 doc.to_string(serialiser(l.append)) 273 return "".join(l) 274 275 # vim: tabstop=4 expandtab shiftwidth=4