paulb@57 | 1 | #!/usr/bin/env python |
paulb@57 | 2 | |
paulb@57 | 3 | """ |
paulb@57 | 4 | View annotated sources. |
paulb@57 | 5 | |
paulb@57 | 6 | Copyright (C) 2006 Paul Boddie <paul@boddie.org.uk> |
paulb@57 | 7 | |
paulb@57 | 8 | This software is free software; you can redistribute it and/or |
paulb@57 | 9 | modify it under the terms of the GNU General Public License as |
paulb@57 | 10 | published by the Free Software Foundation; either version 2 of |
paulb@57 | 11 | the License, or (at your option) any later version. |
paulb@57 | 12 | |
paulb@57 | 13 | This software is distributed in the hope that it will be useful, |
paulb@57 | 14 | but WITHOUT ANY WARRANTY; without even the implied warranty of |
paulb@57 | 15 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
paulb@57 | 16 | GNU General Public License for more details. |
paulb@57 | 17 | |
paulb@57 | 18 | You should have received a copy of the GNU General Public |
paulb@57 | 19 | License along with this library; see the file LICENCE.txt |
paulb@57 | 20 | If not, write to the Free Software Foundation, Inc., |
paulb@57 | 21 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA |
paulb@57 | 22 | """ |
paulb@57 | 23 | |
paulb@57 | 24 | from compiler.visitor import ASTVisitor |
paulb@83 | 25 | from simplified import * |
paulb@57 | 26 | import sys |
paulb@87 | 27 | import textwrap |
paulb@57 | 28 | |
paulb@83 | 29 | # Exceptions. |
paulb@83 | 30 | |
paulb@83 | 31 | class ViewerError(SimplifiedError): |
paulb@83 | 32 | |
paulb@83 | 33 | "An error in viewing." |
paulb@83 | 34 | |
paulb@83 | 35 | pass |
paulb@83 | 36 | |
paulb@83 | 37 | # Classes. |
paulb@83 | 38 | |
paulb@57 | 39 | class Viewer(ASTVisitor): |
paulb@57 | 40 | |
paulb@57 | 41 | """ |
paulb@57 | 42 | A viewing visitor for AST nodes. |
paulb@57 | 43 | """ |
paulb@57 | 44 | |
paulb@57 | 45 | def __init__(self, stream): |
paulb@57 | 46 | ASTVisitor.__init__(self) |
paulb@57 | 47 | self.cached_files = {} |
paulb@57 | 48 | self.printed_lines = {} |
paulb@57 | 49 | self.visitor = self |
paulb@57 | 50 | self.stream = stream |
paulb@57 | 51 | |
paulb@57 | 52 | def process(self, module): |
paulb@57 | 53 | self.dispatch(module) |
paulb@57 | 54 | |
paulb@57 | 55 | def dispatch(self, node): |
paulb@61 | 56 | self.dispatch_only(node) |
paulb@57 | 57 | ASTVisitor.dispatch(self, node) |
paulb@57 | 58 | |
paulb@61 | 59 | def dispatch_only(self, node, every_time=0): |
paulb@61 | 60 | self.print_line(getattr(node, "filename", None), getattr(node, "lineno", None), every_time) |
paulb@61 | 61 | |
paulb@61 | 62 | def print_line(self, filename, lineno, every_time): |
paulb@57 | 63 | last_printed = self.printed_lines.get(filename, 0) |
paulb@61 | 64 | if lineno > last_printed or every_time: |
paulb@57 | 65 | self.stream.write(self.get_line(filename, lineno)) |
paulb@57 | 66 | self.printed_lines[filename] = lineno |
paulb@57 | 67 | |
paulb@57 | 68 | def get_line(self, filename, lineno): |
paulb@57 | 69 | if filename is None or lineno is None: |
paulb@57 | 70 | return "" |
paulb@57 | 71 | |
paulb@57 | 72 | if self.cached_files.has_key(filename): |
paulb@57 | 73 | lines = self.cached_files[filename] |
paulb@57 | 74 | else: |
paulb@57 | 75 | f = open(filename) |
paulb@57 | 76 | try: |
paulb@57 | 77 | self.cached_files[filename] = lines = f.readlines() |
paulb@57 | 78 | finally: |
paulb@57 | 79 | f.close() |
paulb@57 | 80 | |
paulb@57 | 81 | try: |
paulb@57 | 82 | return lines[lineno - 1] |
paulb@57 | 83 | except IndexError: |
paulb@57 | 84 | return "" |
paulb@57 | 85 | |
paulb@61 | 86 | def report(self, exc): |
paulb@61 | 87 | self.stream.write("Exception was:\n\n" + str(exc.exc) + "\n\n") |
paulb@61 | 88 | self.stream.write("Nodes:\n\n") |
paulb@61 | 89 | for node in exc.nodes: |
paulb@61 | 90 | self.stream.write(repr(node) + "\n") |
paulb@61 | 91 | self.dispatch_only(node.original, every_time=1) |
paulb@61 | 92 | self.stream.write("\nOriginal node was:\n\n" + repr(exc.nodes[0].original) + "\n") |
paulb@61 | 93 | self.stream.write("\nSimplified node was:\n\n") |
paulb@61 | 94 | exc.nodes[0].pprint(stream=self.stream) |
paulb@61 | 95 | |
paulb@78 | 96 | # HTML-related output production. |
paulb@78 | 97 | |
paulb@78 | 98 | html_header = """<?xml version="1.0" encoding="iso-8859-15"?> |
paulb@78 | 99 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> |
paulb@78 | 100 | <html xmlns="http://www.w3.org/1999/xhtml"> |
paulb@78 | 101 | <head> |
paulb@78 | 102 | <title>Module</title> |
paulb@78 | 103 | <style type="text/css"> |
paulb@78 | 104 | body { |
paulb@78 | 105 | padding-top: 4em; padding-bottom: 4em; |
paulb@78 | 106 | font-size: 14pt; font-family: monospace; |
paulb@78 | 107 | background-color: black; color: white; |
paulb@78 | 108 | } |
paulb@78 | 109 | |
paulb@78 | 110 | .class { margin-bottom: 1em; } |
paulb@78 | 111 | .function { margin-bottom: 1em; } |
paulb@78 | 112 | .body { padding-left: 2em; } |
paulb@78 | 113 | .keyword { color: yellow; } |
paulb@78 | 114 | .comment { color: blue; } |
paulb@83 | 115 | .str { color: #FF00FF; } |
paulb@83 | 116 | .doc { color: #FF00FF; margin-bottom: 1em; } |
paulb@78 | 117 | .ref { color: cyan; } |
paulb@78 | 118 | .ref a { color: cyan; text-decoration: none; } |
paulb@78 | 119 | |
paulb@84 | 120 | .popup { |
paulb@78 | 121 | display: none; z-index: 2; |
paulb@84 | 122 | position: absolute; top: 1em; left: 0.5em; |
paulb@84 | 123 | padding: 0.5em; background-color: #000000; |
paulb@84 | 124 | } |
paulb@84 | 125 | |
paulb@84 | 126 | .types { |
paulb@78 | 127 | padding: 0.5em; background-color: #0000FF; |
paulb@84 | 128 | float: right; |
paulb@78 | 129 | } |
paulb@78 | 130 | |
paulb@79 | 131 | .scopes { |
paulb@79 | 132 | padding: 0.5em; background-color: #007700; |
paulb@84 | 133 | float: left; |
paulb@79 | 134 | } |
paulb@79 | 135 | |
paulb@83 | 136 | .name, |
paulb@83 | 137 | .attr |
paulb@83 | 138 | { |
paulb@83 | 139 | position: relative; |
paulb@83 | 140 | } |
paulb@83 | 141 | |
paulb@84 | 142 | .name:hover > .popup, |
paulb@84 | 143 | .attr:hover > .popup |
paulb@78 | 144 | { |
paulb@78 | 145 | display: block; |
paulb@78 | 146 | } |
paulb@78 | 147 | |
paulb@78 | 148 | </style> |
paulb@78 | 149 | </head> |
paulb@78 | 150 | <body> |
paulb@78 | 151 | """ |
paulb@78 | 152 | |
paulb@78 | 153 | html_footer = """</body> |
paulb@78 | 154 | </html> |
paulb@78 | 155 | """ |
paulb@78 | 156 | |
paulb@87 | 157 | # Validation functions. |
paulb@87 | 158 | |
paulb@87 | 159 | def hasnode(fn): |
paulb@87 | 160 | def _hasnode(self, node): |
paulb@87 | 161 | if not hasattr(node, "_node"): |
paulb@87 | 162 | return |
paulb@87 | 163 | else: |
paulb@87 | 164 | fn(self, node) |
paulb@87 | 165 | return _hasnode |
paulb@87 | 166 | |
paulb@87 | 167 | # Browser classes. |
paulb@87 | 168 | |
paulb@78 | 169 | class Browser(ASTVisitor): |
paulb@78 | 170 | |
paulb@78 | 171 | """ |
paulb@78 | 172 | A browsing visitor for AST nodes. |
paulb@78 | 173 | """ |
paulb@78 | 174 | |
paulb@78 | 175 | def __init__(self, stream): |
paulb@78 | 176 | ASTVisitor.__init__(self) |
paulb@78 | 177 | self.visitor = self |
paulb@78 | 178 | self.stream = stream |
paulb@78 | 179 | |
paulb@78 | 180 | def process(self, module): |
paulb@78 | 181 | self.stream.write(html_header) |
paulb@78 | 182 | self.dispatch(module) |
paulb@78 | 183 | self.stream.write(html_footer) |
paulb@78 | 184 | |
paulb@83 | 185 | def dispatch(self, node): |
paulb@83 | 186 | try: |
paulb@83 | 187 | ASTVisitor.dispatch(self, node) |
paulb@83 | 188 | except ViewerError, exc: |
paulb@83 | 189 | exc.add(node) |
paulb@83 | 190 | raise |
paulb@83 | 191 | except Exception, exc: |
paulb@83 | 192 | raise ViewerError(exc, node) |
paulb@83 | 193 | |
paulb@78 | 194 | def visitModule(self, node): |
paulb@78 | 195 | self.default(node) |
paulb@78 | 196 | |
paulb@79 | 197 | # Statements. |
paulb@79 | 198 | |
paulb@87 | 199 | def visitAssign(self, node): |
paulb@87 | 200 | self.stream.write("<div class='assign'>\n") |
paulb@87 | 201 | for lvalue in node.nodes: |
paulb@87 | 202 | self.dispatch(lvalue) |
paulb@87 | 203 | self.stream.write("=\n") |
paulb@87 | 204 | self.dispatch(node.expr) |
paulb@87 | 205 | self.stream.write("</div>\n") |
paulb@78 | 206 | |
paulb@78 | 207 | def visitClass(self, node): |
paulb@79 | 208 | definition = node._node |
paulb@83 | 209 | structure = definition.expr.ref |
paulb@79 | 210 | self.stream.write("<div class='class' id='%s'>\n" % self._url(structure.full_name())) |
paulb@78 | 211 | self.stream.write("<p>\n") |
paulb@78 | 212 | self._keyword("class") |
paulb@83 | 213 | self._name_start(structure.name) |
paulb@84 | 214 | self._popup_start() |
paulb@79 | 215 | self._scopes(definition) |
paulb@84 | 216 | self._popup_end() |
paulb@79 | 217 | self._name_end() |
paulb@78 | 218 | bases = structure.bases |
paulb@78 | 219 | if bases: |
paulb@79 | 220 | self.stream.write("(") |
paulb@78 | 221 | first = 1 |
paulb@78 | 222 | for base in bases: |
paulb@78 | 223 | if not first: |
paulb@78 | 224 | self.stream.write(",\n") |
paulb@83 | 225 | self._name_start(base.name) |
paulb@84 | 226 | self._popup_start() |
paulb@79 | 227 | self._types(base) |
paulb@79 | 228 | self._scopes(base) |
paulb@84 | 229 | self._popup_end() |
paulb@79 | 230 | self._name_end() |
paulb@78 | 231 | first = 0 |
paulb@78 | 232 | self.stream.write(")") |
paulb@78 | 233 | self.stream.write(":\n") |
paulb@79 | 234 | self._comment(self._text(structure.full_name())) |
paulb@78 | 235 | self.stream.write("</p>\n") |
paulb@78 | 236 | |
paulb@78 | 237 | self.stream.write("<div class='body'>\n") |
paulb@79 | 238 | self._doc(node) |
paulb@79 | 239 | self.dispatch(node.code) |
paulb@78 | 240 | self.stream.write("</div>\n") |
paulb@78 | 241 | self.stream.write("</div>\n") |
paulb@78 | 242 | |
paulb@87 | 243 | visitClass = hasnode(visitClass) # Remove unannotated nodes. |
paulb@87 | 244 | |
paulb@83 | 245 | def visitFunction(self, node): |
paulb@83 | 246 | definition = node._node |
paulb@83 | 247 | subprogram = definition.expr.ref |
paulb@83 | 248 | self.stream.write("<div class='def' id='%s'>\n" % self._url(subprogram.full_name())) |
paulb@83 | 249 | self.stream.write("<p>\n") |
paulb@83 | 250 | self._keyword("def") |
paulb@83 | 251 | self._name_start(subprogram.name) |
paulb@84 | 252 | self._popup_start() |
paulb@83 | 253 | self._scopes(definition) |
paulb@84 | 254 | self._popup_end() |
paulb@83 | 255 | self._name_end() |
paulb@83 | 256 | self.stream.write("(") |
paulb@83 | 257 | first = 1 |
paulb@83 | 258 | for param, default in subprogram.params: |
paulb@83 | 259 | if not first: |
paulb@83 | 260 | self.stream.write(",\n") |
paulb@85 | 261 | self._parameter(subprogram, param) |
paulb@85 | 262 | first = 0 |
paulb@85 | 263 | if subprogram.star is not None: |
paulb@85 | 264 | if not first: |
paulb@85 | 265 | self.stream.write(", *\n") |
paulb@85 | 266 | param, default = subprogram.star |
paulb@85 | 267 | self._parameter(subprogram, param) |
paulb@85 | 268 | first = 0 |
paulb@85 | 269 | if subprogram.dstar is not None: |
paulb@85 | 270 | if not first: |
paulb@85 | 271 | self.stream.write(", **\n") |
paulb@85 | 272 | param, default = subprogram.dstar |
paulb@85 | 273 | self._parameter(subprogram, param) |
paulb@83 | 274 | first = 0 |
paulb@83 | 275 | self.stream.write(")") |
paulb@83 | 276 | self.stream.write(":\n") |
paulb@83 | 277 | self._comment(self._text(subprogram.full_name())) |
paulb@83 | 278 | self.stream.write("</p>\n") |
paulb@83 | 279 | |
paulb@83 | 280 | self.stream.write("<div class='body'>\n") |
paulb@83 | 281 | self._doc(node) |
paulb@83 | 282 | self.dispatch(node.code) |
paulb@83 | 283 | self.stream.write("</div>\n") |
paulb@83 | 284 | self.stream.write("</div>\n") |
paulb@83 | 285 | |
paulb@87 | 286 | visitFunction = hasnode(visitFunction) # Remove unannotated nodes. |
paulb@87 | 287 | |
paulb@87 | 288 | def visitPass(self, node): |
paulb@87 | 289 | self._keyword("pass") |
paulb@87 | 290 | |
paulb@87 | 291 | def visitReturn(self, node): |
paulb@87 | 292 | self._keyword("return") |
paulb@87 | 293 | self.dispatch(node.value) |
paulb@87 | 294 | |
paulb@83 | 295 | def visitStmt(self, node): |
paulb@83 | 296 | self.stream.write("<div class='stmt'>\n") |
paulb@83 | 297 | self.default(node) |
paulb@83 | 298 | self.stream.write("</div>\n") |
paulb@83 | 299 | |
paulb@79 | 300 | # Expressions. |
paulb@79 | 301 | |
paulb@85 | 302 | def visitCallFunc(self, node): |
paulb@85 | 303 | self.stream.write("<span class='callfunc'>\n") |
paulb@85 | 304 | self.dispatch(node.node) |
paulb@85 | 305 | self.stream.write("(") |
paulb@85 | 306 | first = 1 |
paulb@85 | 307 | for arg in node.args: |
paulb@85 | 308 | if not first: |
paulb@85 | 309 | self.stream.write(",\n") |
paulb@85 | 310 | self.dispatch(arg) |
paulb@85 | 311 | first = 0 |
paulb@85 | 312 | if node.star_args is not None: |
paulb@85 | 313 | if not first: |
paulb@85 | 314 | self.stream.write(", *\n") |
paulb@85 | 315 | self.dispatch(node.star_args) |
paulb@85 | 316 | first = 0 |
paulb@85 | 317 | if node.dstar_args is not None: |
paulb@85 | 318 | if not first: |
paulb@85 | 319 | self.stream.write(", **\n") |
paulb@85 | 320 | self.dispatch(node.dstar_args) |
paulb@85 | 321 | first = 0 |
paulb@85 | 322 | self.stream.write(")\n") |
paulb@85 | 323 | self.stream.write("</span>\n") |
paulb@85 | 324 | |
paulb@79 | 325 | def visitTuple(self, node): |
paulb@79 | 326 | self.stream.write("<span class='tuple'>\n") |
paulb@79 | 327 | self.stream.write("(") |
paulb@79 | 328 | self._sequence(node) |
paulb@79 | 329 | self.stream.write(")\n") |
paulb@79 | 330 | self.stream.write("</span>\n") |
paulb@79 | 331 | |
paulb@79 | 332 | visitAssTuple = visitTuple |
paulb@79 | 333 | |
paulb@79 | 334 | def visitList(self, node): |
paulb@79 | 335 | self.stream.write("<span class='list'>\n") |
paulb@79 | 336 | self.stream.write("[") |
paulb@79 | 337 | self._sequence(node) |
paulb@79 | 338 | self.stream.write("]\n") |
paulb@79 | 339 | self.stream.write("</span>\n") |
paulb@79 | 340 | |
paulb@79 | 341 | visitAssList = visitList |
paulb@79 | 342 | |
paulb@79 | 343 | def visitName(self, node): |
paulb@87 | 344 | if hasattr(node, "_node"): |
paulb@87 | 345 | self._name_start(node._node.name) |
paulb@87 | 346 | self._popup_start() |
paulb@87 | 347 | self._types(node._node) |
paulb@87 | 348 | self._scopes(node._node) |
paulb@87 | 349 | self._popup_end() |
paulb@87 | 350 | self._name_end() |
paulb@87 | 351 | else: |
paulb@87 | 352 | self._name(node.name) |
paulb@79 | 353 | |
paulb@79 | 354 | def visitAssName(self, node): |
paulb@87 | 355 | if hasattr(node, "_node"): |
paulb@87 | 356 | self._name_start(node._node.name) |
paulb@87 | 357 | self._popup_start() |
paulb@87 | 358 | self._types(node._node.expr) |
paulb@87 | 359 | self._scopes(node._node) |
paulb@87 | 360 | self._popup_end() |
paulb@87 | 361 | self._name_end() |
paulb@87 | 362 | else: |
paulb@87 | 363 | self._name(node.name) |
paulb@79 | 364 | |
paulb@79 | 365 | def visitConst(self, node): |
paulb@79 | 366 | self.stream.write(repr(node.value)) |
paulb@79 | 367 | |
paulb@83 | 368 | def visitGetattr(self, node): |
paulb@83 | 369 | self.stream.write("<span class='getattr'>\n") |
paulb@83 | 370 | self.dispatch(node.expr) |
paulb@83 | 371 | self.stream.write("<span class='attr'>\n") |
paulb@83 | 372 | self.stream.write(".%s\n" % self._text(node.attrname)) |
paulb@87 | 373 | if hasattr(node, "_node"): |
paulb@87 | 374 | self._popup_start() |
paulb@87 | 375 | self._types(node._node) |
paulb@87 | 376 | self._scopes(node._node) |
paulb@87 | 377 | self._popup_end() |
paulb@83 | 378 | self.stream.write("</span>\n") |
paulb@83 | 379 | self.stream.write("</span>\n") |
paulb@83 | 380 | |
paulb@83 | 381 | def visitAssAttr(self, node): |
paulb@83 | 382 | self.stream.write("<span class='assattr'>\n") |
paulb@83 | 383 | self.dispatch(node.expr) |
paulb@83 | 384 | self.stream.write("<span class='attr'>\n") |
paulb@83 | 385 | self.stream.write(".%s\n" % self._text(node.attrname)) |
paulb@87 | 386 | if hasattr(node, "_node"): |
paulb@87 | 387 | self._popup_start() |
paulb@87 | 388 | self._types(node._node) |
paulb@87 | 389 | self._scopes(node._node) |
paulb@87 | 390 | self._popup_end() |
paulb@83 | 391 | self.stream.write("</span>\n") |
paulb@83 | 392 | self.stream.write("</span>\n") |
paulb@83 | 393 | |
paulb@78 | 394 | # Output preparation methods. |
paulb@78 | 395 | |
paulb@78 | 396 | def _text(self, text): |
paulb@78 | 397 | return text.replace("&", "&").replace("<", "<").replace(">", ">") |
paulb@78 | 398 | |
paulb@78 | 399 | def _attr(self, attr): |
paulb@78 | 400 | return self._text(attr).replace("'", "'").replace('"', """) |
paulb@78 | 401 | |
paulb@78 | 402 | def _url(self, url): |
paulb@78 | 403 | return self._attr(url).replace("#", "%23").replace("-", "%2d") |
paulb@78 | 404 | |
paulb@78 | 405 | def _comment(self, comment): |
paulb@78 | 406 | self.stream.write("<span class='comment'># %s</span>\n" % comment) |
paulb@78 | 407 | |
paulb@78 | 408 | def _keyword(self, kw): |
paulb@78 | 409 | self.stream.write("<span class='keyword'>%s</span> " % kw) |
paulb@78 | 410 | |
paulb@79 | 411 | def _doc(self, node): |
paulb@79 | 412 | if node.doc is not None: |
paulb@87 | 413 | self.stream.write("<pre class='doc'>\n") |
paulb@87 | 414 | self.stream.write('"""') |
paulb@87 | 415 | output = textwrap.dedent(node.doc.replace('"""', '\\"\\"\\"')) |
paulb@87 | 416 | self.stream.write(self._text(output)) |
paulb@87 | 417 | self.stream.write('"""') |
paulb@87 | 418 | self.stream.write("</pre>\n") |
paulb@79 | 419 | |
paulb@79 | 420 | def _sequence(self, node): |
paulb@79 | 421 | first = 1 |
paulb@79 | 422 | for n in node.nodes: |
paulb@79 | 423 | if not first: |
paulb@79 | 424 | self.stream.write(",\n") |
paulb@79 | 425 | self.dispatch(n) |
paulb@79 | 426 | first = 0 |
paulb@78 | 427 | |
paulb@85 | 428 | def _parameter(self, subprogram, param): |
paulb@85 | 429 | self._name_start(param) |
paulb@85 | 430 | if hasattr(subprogram, "paramtypes"): |
paulb@85 | 431 | self._popup_start() |
paulb@85 | 432 | self._types_list(subprogram.paramtypes[param]) |
paulb@85 | 433 | self._popup_end() |
paulb@85 | 434 | self._name_end() |
paulb@85 | 435 | |
paulb@83 | 436 | def _name(self, name): |
paulb@83 | 437 | self.stream.write("<span class='name'>%s</span>\n" % name) |
paulb@79 | 438 | |
paulb@83 | 439 | def _name_start(self, name): |
paulb@83 | 440 | self.stream.write("<span class='name'>%s\n" % name) |
paulb@79 | 441 | |
paulb@79 | 442 | def _name_end(self): |
paulb@79 | 443 | self.stream.write("</span>\n") |
paulb@79 | 444 | |
paulb@84 | 445 | def _popup_start(self): |
paulb@84 | 446 | self.stream.write("<span class='popup'>\n") |
paulb@84 | 447 | |
paulb@84 | 448 | def _popup_end(self): |
paulb@84 | 449 | self.stream.write("</span>\n") |
paulb@84 | 450 | |
paulb@79 | 451 | def _types(self, node): |
paulb@84 | 452 | if hasattr(node, "types"): |
paulb@84 | 453 | self._types_list(node.types) |
paulb@84 | 454 | elif hasattr(node, "writes"): |
paulb@84 | 455 | self._types_list(flatten(node.writes.values())) |
paulb@84 | 456 | elif hasattr(node, "accesses"): |
paulb@84 | 457 | self._types_list(flatten(node.accesses.values())) |
paulb@84 | 458 | else: |
paulb@83 | 459 | self.stream.write("<div class='types'>\n") |
paulb@83 | 460 | self.stream.write("No types!\n") |
paulb@83 | 461 | self.stream.write("</div>\n") |
paulb@83 | 462 | |
paulb@83 | 463 | def _types_list(self, types): |
paulb@79 | 464 | self.stream.write("<div class='types'>\n") |
paulb@83 | 465 | for type in types: |
paulb@79 | 466 | fn = type.type.full_name() |
paulb@79 | 467 | self.stream.write("<div class='type'>") |
paulb@78 | 468 | self.stream.write(self._text(fn)) |
paulb@78 | 469 | self.stream.write("</div>\n") |
paulb@79 | 470 | self.stream.write("</div>\n") |
paulb@79 | 471 | |
paulb@79 | 472 | def _scopes(self, node): |
paulb@83 | 473 | if not isinstance(node, LoadName): |
paulb@83 | 474 | self.stream.write("<div class='scopes'>\n") |
paulb@83 | 475 | if not hasattr(node, "writes") and not hasattr(node, "accesses"): |
paulb@83 | 476 | self.stream.write("No scopes!\n") |
paulb@83 | 477 | else: |
paulb@83 | 478 | for ref in getattr(node, "writes", getattr(node, "accesses", {})).keys(): |
paulb@83 | 479 | fn = ref.full_name() |
paulb@83 | 480 | self.stream.write("<div class='scope'>") |
paulb@83 | 481 | self.stream.write(self._text(fn)) |
paulb@83 | 482 | self.stream.write("</div>\n") |
paulb@79 | 483 | self.stream.write("</div>\n") |
paulb@78 | 484 | |
paulb@84 | 485 | # Utility functions. |
paulb@84 | 486 | |
paulb@84 | 487 | def flatten(lists): |
paulb@84 | 488 | result = [] |
paulb@84 | 489 | for l in lists: |
paulb@84 | 490 | for attr in l: |
paulb@84 | 491 | if attr not in result: |
paulb@84 | 492 | result.append(attr) |
paulb@84 | 493 | return result |
paulb@84 | 494 | |
paulb@57 | 495 | # Convenience functions. |
paulb@57 | 496 | |
paulb@57 | 497 | def view(module, stream=None): |
paulb@57 | 498 | viewer = Viewer(stream or sys.stdout) |
paulb@57 | 499 | viewer.process(module.original) |
paulb@57 | 500 | |
paulb@78 | 501 | def browse(module, stream=None): |
paulb@78 | 502 | browser = Browser(stream or sys.stdout) |
paulb@78 | 503 | browser.process(module.original) |
paulb@78 | 504 | |
paulb@78 | 505 | def makedoc(module, filename): |
paulb@78 | 506 | stream = open(filename, "wb") |
paulb@78 | 507 | try: |
paulb@78 | 508 | browser = Browser(stream) |
paulb@78 | 509 | browser.process(module.original) |
paulb@78 | 510 | finally: |
paulb@78 | 511 | stream.close() |
paulb@78 | 512 | |
paulb@57 | 513 | # vim: tabstop=4 expandtab shiftwidth=4 |