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_listitem(self, indent, marker, space): 78 self.out("%s%s%s" % (indent * " ", marker, space)) 79 80 def end_listitem(self, indent, marker): 81 pass 82 83 def start_monospace(self): 84 self.out("`") 85 86 def end_monospace(self): 87 self.out("`") 88 89 def start_strong(self): 90 self.out("'''") 91 92 def end_strong(self): 93 self.out("'''") 94 95 def break_(self): 96 self.out("\n") 97 98 def rule(self, length): 99 self.out("-" * length) 100 101 def text(self, s): 102 self.out(s) 103 104 class HTMLSerialiser(Serialiser): 105 106 "Serialisation of the page." 107 108 def start_region(self, level, indent, type): 109 l = [] 110 out = l.append 111 if level: 112 out("level-%d" % level) 113 114 if indent: 115 out("indent-%d" % indent) 116 117 # NOTE: Encode type details for CSS. 118 119 if type: 120 out("type-%s" % escape(type, True)) 121 122 self.out("<span class='%s'>" % " ".join(l)) 123 124 def end_region(self, level, indent, type): 125 self.out("</span>") 126 127 def start_block(self): 128 self.out("<p>") 129 130 def end_block(self): 131 self.out("</p>") 132 133 def start_defitem(self, pad, extra): 134 self.out("<dd>") 135 136 def end_defitem(self, pad, extra): 137 self.out("</dd>") 138 139 def start_defterm(self, pad): 140 self.out("<dt>") 141 142 def end_defterm(self, pad): 143 self.out("</dt>") 144 145 def start_emphasis(self): 146 self.out("<em>") 147 148 def end_emphasis(self): 149 self.out("</em>") 150 151 def start_heading(self, level, extra, pad): 152 self.out("<h%d>" % level) 153 154 def end_heading(self, level, pad, extra): 155 self.out("</h%d>" % level) 156 157 def start_listitem(self, indent, marker, space): 158 self.out("<li>") 159 160 def end_listitem(self, indent, marker): 161 self.out("</li>") 162 163 def start_monospace(self): 164 self.out("<tt>") 165 166 def end_monospace(self): 167 self.out("</tt>") 168 169 def start_strong(self): 170 self.out("<strong>") 171 172 def end_strong(self): 173 self.out("</strong>") 174 175 def break_(self): 176 pass 177 178 def rule(self, length): 179 self.out("<hr style='height: %dpt' />" % min(length, 10)) 180 181 def text(self, s): 182 self.out(escape(s)) 183 184 # Top-level functions. 185 186 def serialise(doc, serialiser=MoinSerialiser): 187 l = [] 188 doc.to_string(serialiser(l.append)) 189 return "".join(l) 190 191 # vim: tabstop=4 expandtab shiftwidth=4