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@114 | 91 | if node is not None: |
paulb@114 | 92 | self.dispatch_only(node.original, every_time=1) |
paulb@61 | 93 | self.stream.write("\nOriginal node was:\n\n" + repr(exc.nodes[0].original) + "\n") |
paulb@61 | 94 | self.stream.write("\nSimplified node was:\n\n") |
paulb@61 | 95 | exc.nodes[0].pprint(stream=self.stream) |
paulb@61 | 96 | |
paulb@78 | 97 | # HTML-related output production. |
paulb@78 | 98 | |
paulb@78 | 99 | html_header = """<?xml version="1.0" encoding="iso-8859-15"?> |
paulb@78 | 100 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> |
paulb@78 | 101 | <html xmlns="http://www.w3.org/1999/xhtml"> |
paulb@78 | 102 | <head> |
paulb@78 | 103 | <title>Module</title> |
paulb@78 | 104 | <style type="text/css"> |
paulb@78 | 105 | body { |
paulb@78 | 106 | padding-top: 4em; padding-bottom: 4em; |
paulb@78 | 107 | font-size: 14pt; font-family: monospace; |
paulb@78 | 108 | background-color: black; color: white; |
paulb@78 | 109 | } |
paulb@78 | 110 | |
paulb@78 | 111 | .class { margin-bottom: 1em; } |
paulb@78 | 112 | .function { margin-bottom: 1em; } |
paulb@78 | 113 | .body { padding-left: 2em; } |
paulb@78 | 114 | .keyword { color: yellow; } |
paulb@78 | 115 | .comment { color: blue; } |
paulb@83 | 116 | .str { color: #FF00FF; } |
paulb@83 | 117 | .doc { color: #FF00FF; margin-bottom: 1em; } |
paulb@119 | 118 | .invocation a { color: white; 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@94 | 123 | padding: 0.2em; background-color: #000000; |
paulb@84 | 124 | } |
paulb@84 | 125 | |
paulb@102 | 126 | .invocations { |
paulb@102 | 127 | padding: 0.5em; background-color: #770000; |
paulb@102 | 128 | clear: all; |
paulb@102 | 129 | } |
paulb@102 | 130 | |
paulb@84 | 131 | .types { |
paulb@78 | 132 | padding: 0.5em; background-color: #0000FF; |
paulb@84 | 133 | float: right; |
paulb@78 | 134 | } |
paulb@78 | 135 | |
paulb@119 | 136 | .raises { |
paulb@119 | 137 | padding: 0.5em; background-color: #7700FF; |
paulb@119 | 138 | float: right; |
paulb@119 | 139 | } |
paulb@119 | 140 | |
paulb@79 | 141 | .scopes { |
paulb@79 | 142 | padding: 0.5em; background-color: #007700; |
paulb@84 | 143 | float: left; |
paulb@79 | 144 | } |
paulb@79 | 145 | |
paulb@125 | 146 | .non-writes, .non-accesses { |
paulb@124 | 147 | padding: 0.5em; background-color: #FF0000; |
paulb@124 | 148 | float: right; |
paulb@124 | 149 | } |
paulb@124 | 150 | |
paulb@102 | 151 | .op, |
paulb@83 | 152 | .name, |
paulb@119 | 153 | .attr, |
paulb@119 | 154 | .conditional |
paulb@83 | 155 | { |
paulb@83 | 156 | position: relative; |
paulb@83 | 157 | } |
paulb@83 | 158 | |
paulb@102 | 159 | .op:hover > .popup, |
paulb@84 | 160 | .name:hover > .popup, |
paulb@119 | 161 | .attr:hover > .popup, |
paulb@119 | 162 | .conditional:hover > .popup |
paulb@78 | 163 | { |
paulb@78 | 164 | display: block; |
paulb@78 | 165 | } |
paulb@78 | 166 | |
paulb@78 | 167 | </style> |
paulb@78 | 168 | </head> |
paulb@78 | 169 | <body> |
paulb@78 | 170 | """ |
paulb@78 | 171 | |
paulb@78 | 172 | html_footer = """</body> |
paulb@78 | 173 | </html> |
paulb@78 | 174 | """ |
paulb@78 | 175 | |
paulb@87 | 176 | # Browser classes. |
paulb@87 | 177 | |
paulb@78 | 178 | class Browser(ASTVisitor): |
paulb@78 | 179 | |
paulb@78 | 180 | """ |
paulb@78 | 181 | A browsing visitor for AST nodes. |
paulb@102 | 182 | |
paulb@102 | 183 | Covered: AssAttr, AssList, AssName, AssTuple, Assign, AugAssign, Break, |
paulb@102 | 184 | CallFunc, Class, Compare, Const, Continue, Dict, Discard, For, |
paulb@102 | 185 | Function, Getattr, If, Keyword, Lambda, List, Module, Name, Pass, Raise, Return, Slice, |
paulb@102 | 186 | Stmt, Subscript, Tuple, While. |
paulb@102 | 187 | |
paulb@102 | 188 | Missing: And, Add, Assert, Backquote, Bitand, Bitor, Bitxor, Decorators, Div, |
paulb@102 | 189 | Ellipsis, Exec, FloorDiv, From, Global, Import, Invert, LeftShift, ListComp, ListCompFor, |
paulb@102 | 190 | ListCompIf, Mod, Mul, Not, Or, Power, Print, Printnl, RightShift, Sliceobj, |
paulb@102 | 191 | Sub, TryExcept, TryFinally, UnaryAdd, UnarySub, Yield. |
paulb@78 | 192 | """ |
paulb@78 | 193 | |
paulb@78 | 194 | def __init__(self, stream): |
paulb@78 | 195 | ASTVisitor.__init__(self) |
paulb@78 | 196 | self.visitor = self |
paulb@78 | 197 | self.stream = stream |
paulb@78 | 198 | |
paulb@78 | 199 | def process(self, module): |
paulb@78 | 200 | self.stream.write(html_header) |
paulb@78 | 201 | self.dispatch(module) |
paulb@78 | 202 | self.stream.write(html_footer) |
paulb@78 | 203 | |
paulb@83 | 204 | def dispatch(self, node): |
paulb@83 | 205 | try: |
paulb@83 | 206 | ASTVisitor.dispatch(self, node) |
paulb@83 | 207 | except ViewerError, exc: |
paulb@83 | 208 | exc.add(node) |
paulb@83 | 209 | raise |
paulb@83 | 210 | except Exception, exc: |
paulb@83 | 211 | raise ViewerError(exc, node) |
paulb@83 | 212 | |
paulb@78 | 213 | def visitModule(self, node): |
paulb@78 | 214 | self.default(node) |
paulb@78 | 215 | |
paulb@79 | 216 | # Statements. |
paulb@79 | 217 | |
paulb@87 | 218 | def visitAssign(self, node): |
paulb@87 | 219 | self.stream.write("<div class='assign'>\n") |
paulb@87 | 220 | for lvalue in node.nodes: |
paulb@87 | 221 | self.dispatch(lvalue) |
paulb@87 | 222 | self.stream.write("=\n") |
paulb@87 | 223 | self.dispatch(node.expr) |
paulb@87 | 224 | self.stream.write("</div>\n") |
paulb@78 | 225 | |
paulb@94 | 226 | def visitAugAssign(self, node): |
paulb@94 | 227 | self.stream.write("<div class='augassign'>\n") |
paulb@94 | 228 | self.dispatch(node.node) |
paulb@94 | 229 | self.stream.write("%s\n" % node.op) |
paulb@94 | 230 | self.dispatch(node.expr) |
paulb@94 | 231 | self.stream.write("</div>\n") |
paulb@94 | 232 | |
paulb@102 | 233 | def visitBreak(self, node): |
paulb@102 | 234 | self.stream.write("<div class='break'>\n") |
paulb@102 | 235 | self._keyword("break") |
paulb@102 | 236 | self.stream.write("</div>\n") |
paulb@102 | 237 | |
paulb@78 | 238 | def visitClass(self, node): |
paulb@79 | 239 | definition = node._node |
paulb@83 | 240 | structure = definition.expr.ref |
paulb@79 | 241 | self.stream.write("<div class='class' id='%s'>\n" % self._url(structure.full_name())) |
paulb@94 | 242 | self.stream.write("<div>\n") |
paulb@78 | 243 | self._keyword("class") |
paulb@83 | 244 | self._name_start(structure.name) |
paulb@84 | 245 | self._popup_start() |
paulb@79 | 246 | self._scopes(definition) |
paulb@84 | 247 | self._popup_end() |
paulb@79 | 248 | self._name_end() |
paulb@78 | 249 | bases = structure.bases |
paulb@78 | 250 | if bases: |
paulb@79 | 251 | self.stream.write("(") |
paulb@78 | 252 | first = 1 |
paulb@78 | 253 | for base in bases: |
paulb@78 | 254 | if not first: |
paulb@78 | 255 | self.stream.write(",\n") |
paulb@83 | 256 | self._name_start(base.name) |
paulb@84 | 257 | self._popup_start() |
paulb@79 | 258 | self._types(base) |
paulb@79 | 259 | self._scopes(base) |
paulb@84 | 260 | self._popup_end() |
paulb@79 | 261 | self._name_end() |
paulb@78 | 262 | first = 0 |
paulb@78 | 263 | self.stream.write(")") |
paulb@78 | 264 | self.stream.write(":\n") |
paulb@79 | 265 | self._comment(self._text(structure.full_name())) |
paulb@94 | 266 | self.stream.write("</div>\n") |
paulb@78 | 267 | |
paulb@78 | 268 | self.stream.write("<div class='body'>\n") |
paulb@79 | 269 | self._doc(node) |
paulb@79 | 270 | self.dispatch(node.code) |
paulb@78 | 271 | self.stream.write("</div>\n") |
paulb@78 | 272 | self.stream.write("</div>\n") |
paulb@78 | 273 | |
paulb@102 | 274 | def visitContinue(self, node): |
paulb@102 | 275 | self.stream.write("<div class='continue'>\n") |
paulb@102 | 276 | self._keyword("continue") |
paulb@102 | 277 | self.stream.write("</div>\n") |
paulb@102 | 278 | |
paulb@119 | 279 | def visitDiscard(self, node): |
paulb@119 | 280 | self.stream.write("<div class='discard'>\n") |
paulb@119 | 281 | self.default(node) |
paulb@119 | 282 | self.stream.write("</div>\n") |
paulb@119 | 283 | |
paulb@94 | 284 | def visitFor(self, node): |
paulb@94 | 285 | self.stream.write("<div class='if'>\n") |
paulb@94 | 286 | self.stream.write("<div>\n") |
paulb@94 | 287 | self._keyword("for") |
paulb@94 | 288 | self.dispatch(node.assign) |
paulb@94 | 289 | self._keyword("in") |
paulb@94 | 290 | self.dispatch(node.list) |
paulb@94 | 291 | self.stream.write(":\n") |
paulb@94 | 292 | self.stream.write("</div>\n") |
paulb@94 | 293 | self.stream.write("<div class='body'>\n") |
paulb@94 | 294 | self.dispatch(node.body) |
paulb@94 | 295 | self.stream.write("</div>\n") |
paulb@94 | 296 | if node.else_ is not None: |
paulb@94 | 297 | self.stream.write("<div>\n") |
paulb@94 | 298 | self._keyword("else") |
paulb@94 | 299 | self.stream.write(":\n") |
paulb@94 | 300 | self.stream.write("</div>\n") |
paulb@94 | 301 | self.stream.write("<div class='body'>\n") |
paulb@94 | 302 | self.dispatch(node.else_) |
paulb@94 | 303 | self.stream.write("</div>\n") |
paulb@94 | 304 | self.stream.write("</div>\n") |
paulb@87 | 305 | |
paulb@83 | 306 | def visitFunction(self, node): |
paulb@83 | 307 | definition = node._node |
paulb@83 | 308 | subprogram = definition.expr.ref |
paulb@94 | 309 | self.stream.write("<div class='function' id='%s'>\n" % self._url(subprogram.full_name())) |
paulb@94 | 310 | self.stream.write("<div>\n") |
paulb@83 | 311 | self._keyword("def") |
paulb@83 | 312 | self._name_start(subprogram.name) |
paulb@84 | 313 | self._popup_start() |
paulb@83 | 314 | self._scopes(definition) |
paulb@119 | 315 | self._raises(subprogram) |
paulb@84 | 316 | self._popup_end() |
paulb@83 | 317 | self._name_end() |
paulb@83 | 318 | self.stream.write("(") |
paulb@102 | 319 | self._parameters(subprogram) |
paulb@83 | 320 | self.stream.write(")") |
paulb@83 | 321 | self.stream.write(":\n") |
paulb@83 | 322 | self._comment(self._text(subprogram.full_name())) |
paulb@94 | 323 | self.stream.write("</div>\n") |
paulb@83 | 324 | |
paulb@83 | 325 | self.stream.write("<div class='body'>\n") |
paulb@83 | 326 | self._doc(node) |
paulb@83 | 327 | self.dispatch(node.code) |
paulb@83 | 328 | self.stream.write("</div>\n") |
paulb@83 | 329 | self.stream.write("</div>\n") |
paulb@83 | 330 | |
paulb@94 | 331 | def visitIf(self, node): |
paulb@94 | 332 | self.stream.write("<div class='if'>\n") |
paulb@94 | 333 | first = 1 |
paulb@119 | 334 | conditional = node._node |
paulb@94 | 335 | for compare, stmt in node.tests: |
paulb@94 | 336 | self.stream.write("<div>\n") |
paulb@119 | 337 | self.stream.write("<span class='conditional'>\n") |
paulb@94 | 338 | if first: |
paulb@94 | 339 | self._keyword("if") |
paulb@94 | 340 | else: |
paulb@94 | 341 | self._keyword("elif") |
paulb@119 | 342 | self._popup_start() |
paulb@119 | 343 | self._invocations(conditional.test) |
paulb@119 | 344 | self._popup_end() |
paulb@120 | 345 | self.stream.write("</span>\n") |
paulb@94 | 346 | self.dispatch(compare) |
paulb@94 | 347 | self.stream.write(":\n") |
paulb@94 | 348 | self.stream.write("</div>\n") |
paulb@94 | 349 | self.stream.write("<div class='body'>\n") |
paulb@94 | 350 | self.dispatch(stmt) |
paulb@94 | 351 | self.stream.write("</div>\n") |
paulb@119 | 352 | if conditional.else_: |
paulb@119 | 353 | conditional = conditional.else_[0] |
paulb@119 | 354 | else: |
paulb@119 | 355 | conditional = None |
paulb@94 | 356 | first = 0 |
paulb@94 | 357 | if node.else_ is not None: |
paulb@94 | 358 | self.stream.write("<div>\n") |
paulb@94 | 359 | self._keyword("else") |
paulb@94 | 360 | self.stream.write(":\n") |
paulb@94 | 361 | self.stream.write("</div>\n") |
paulb@94 | 362 | self.stream.write("<div class='body'>\n") |
paulb@94 | 363 | self.dispatch(node.else_) |
paulb@94 | 364 | self.stream.write("</div>\n") |
paulb@94 | 365 | self.stream.write("</div>\n") |
paulb@87 | 366 | |
paulb@87 | 367 | def visitPass(self, node): |
paulb@94 | 368 | self.stream.write("<div class='pass'>\n") |
paulb@87 | 369 | self._keyword("pass") |
paulb@94 | 370 | self.stream.write("</div>\n") |
paulb@94 | 371 | |
paulb@94 | 372 | def visitRaise(self, node): |
paulb@94 | 373 | self.stream.write("<div class='raise'>\n") |
paulb@94 | 374 | self._keyword("raise") |
paulb@94 | 375 | self.dispatch(node.expr1) |
paulb@94 | 376 | if node.expr2 is not None: |
paulb@94 | 377 | self.stream.write(",\n") |
paulb@94 | 378 | self.dispatch(node.expr2) |
paulb@94 | 379 | if node.expr3 is not None: |
paulb@94 | 380 | self.stream.write(",\n") |
paulb@94 | 381 | self.dispatch(node.expr3) |
paulb@94 | 382 | self.stream.write("</div>\n") |
paulb@87 | 383 | |
paulb@87 | 384 | def visitReturn(self, node): |
paulb@94 | 385 | self.stream.write("<div class='return'>\n") |
paulb@87 | 386 | self._keyword("return") |
paulb@87 | 387 | self.dispatch(node.value) |
paulb@94 | 388 | self.stream.write("</div>\n") |
paulb@87 | 389 | |
paulb@83 | 390 | def visitStmt(self, node): |
paulb@83 | 391 | self.stream.write("<div class='stmt'>\n") |
paulb@83 | 392 | self.default(node) |
paulb@83 | 393 | self.stream.write("</div>\n") |
paulb@83 | 394 | |
paulb@108 | 395 | def visitTryExcept(self, node): |
paulb@108 | 396 | self.stream.write("<div class='tryexcept'>\n") |
paulb@108 | 397 | self.stream.write("<div>\n") |
paulb@108 | 398 | self._keyword("try") |
paulb@108 | 399 | self.stream.write(":\n") |
paulb@108 | 400 | self.stream.write("</div>\n") |
paulb@108 | 401 | self.stream.write("<div class='body'>\n") |
paulb@108 | 402 | self.dispatch(node.body) |
paulb@108 | 403 | self.stream.write("</div>\n") |
paulb@108 | 404 | for spec, assign, statement in node.handlers: |
paulb@108 | 405 | self.stream.write("<div>\n") |
paulb@108 | 406 | self._keyword("except") |
paulb@108 | 407 | if spec is not None: |
paulb@108 | 408 | self.dispatch(spec) |
paulb@108 | 409 | if assign is not None: |
paulb@108 | 410 | self.stream.write(",\n") |
paulb@108 | 411 | self.dispatch(assign) |
paulb@108 | 412 | self.stream.write(":\n") |
paulb@108 | 413 | self.stream.write("</div>\n") |
paulb@108 | 414 | self.stream.write("<div class='body'>\n") |
paulb@108 | 415 | self.dispatch(statement) |
paulb@108 | 416 | self.stream.write("</div>\n") |
paulb@108 | 417 | if node.else_ is not None: |
paulb@108 | 418 | self.stream.write("<div>\n") |
paulb@108 | 419 | self._keyword("else") |
paulb@108 | 420 | self.stream.write(":\n") |
paulb@108 | 421 | self.stream.write("</div>\n") |
paulb@108 | 422 | self.stream.write("<div class='body'>\n") |
paulb@108 | 423 | self.dispatch(node.else_) |
paulb@108 | 424 | self.stream.write("</div>\n") |
paulb@108 | 425 | self.stream.write("</div>\n") |
paulb@108 | 426 | |
paulb@108 | 427 | def visitTryFinally(self, node): |
paulb@108 | 428 | self.stream.write("<div class='tryfinally'>\n") |
paulb@108 | 429 | self.stream.write("<div>\n") |
paulb@108 | 430 | self._keyword("try") |
paulb@108 | 431 | self.stream.write(":\n") |
paulb@108 | 432 | self.stream.write("</div>\n") |
paulb@108 | 433 | self.stream.write("<div class='body'>\n") |
paulb@108 | 434 | self.dispatch(node.body) |
paulb@108 | 435 | self.stream.write("</div>\n") |
paulb@108 | 436 | self.stream.write("<div>\n") |
paulb@108 | 437 | self._keyword("finally") |
paulb@108 | 438 | self.stream.write(":\n") |
paulb@108 | 439 | self.stream.write("</div>\n") |
paulb@108 | 440 | self.stream.write("<div class='body'>\n") |
paulb@108 | 441 | self.dispatch(node.final) |
paulb@108 | 442 | self.stream.write("</div>\n") |
paulb@108 | 443 | self.stream.write("</div>\n") |
paulb@108 | 444 | |
paulb@102 | 445 | def visitWhile(self, node): |
paulb@102 | 446 | self.stream.write("<div class='while'>\n") |
paulb@102 | 447 | self.stream.write("<div>\n") |
paulb@120 | 448 | self.stream.write("<span class='conditional'>\n") |
paulb@102 | 449 | self._keyword("while") |
paulb@120 | 450 | self._popup_start() |
paulb@120 | 451 | self._invocations(node.test) |
paulb@120 | 452 | self._popup_end() |
paulb@120 | 453 | self.stream.write("</span>\n") |
paulb@102 | 454 | self.dispatch(node.test) |
paulb@102 | 455 | self.stream.write(":\n") |
paulb@102 | 456 | self.stream.write("</div>\n") |
paulb@102 | 457 | self.stream.write("<div class='body'>\n") |
paulb@102 | 458 | self.dispatch(node.body) |
paulb@102 | 459 | self.stream.write("</div>\n") |
paulb@102 | 460 | if node.else_ is not None: |
paulb@102 | 461 | self.stream.write("<div>\n") |
paulb@102 | 462 | self._keyword("else") |
paulb@102 | 463 | self.stream.write(":\n") |
paulb@102 | 464 | self.stream.write("</div>\n") |
paulb@102 | 465 | self.stream.write("<div class='body'>\n") |
paulb@102 | 466 | self.dispatch(node.else_) |
paulb@102 | 467 | self.stream.write("</div>\n") |
paulb@102 | 468 | self.stream.write("</div>\n") |
paulb@102 | 469 | |
paulb@79 | 470 | # Expressions. |
paulb@79 | 471 | |
paulb@94 | 472 | def visitAssAttr(self, node): |
paulb@94 | 473 | self.stream.write("<span class='assattr'>\n") |
paulb@94 | 474 | self.dispatch(node.expr) |
paulb@94 | 475 | self.stream.write("<span class='attr'>\n") |
paulb@94 | 476 | self.stream.write(".%s\n" % self._text(node.attrname)) |
paulb@94 | 477 | if hasattr(node, "_node"): |
paulb@94 | 478 | self._popup_start() |
paulb@94 | 479 | self._types(node._node) |
paulb@94 | 480 | self._scopes(node._node) |
paulb@94 | 481 | self._popup_end() |
paulb@94 | 482 | else: |
paulb@94 | 483 | raise ValueError, node |
paulb@94 | 484 | self.stream.write("</span>\n") |
paulb@94 | 485 | self.stream.write("</span>\n") |
paulb@94 | 486 | |
paulb@94 | 487 | def visitAssList(self, node): |
paulb@94 | 488 | self.stream.write("<span class='list'>\n") |
paulb@94 | 489 | self.stream.write("[") |
paulb@94 | 490 | self._sequence(node) |
paulb@94 | 491 | self.stream.write("]\n") |
paulb@94 | 492 | self.stream.write("</span>\n") |
paulb@94 | 493 | |
paulb@94 | 494 | def visitAssName(self, node): |
paulb@94 | 495 | if hasattr(node, "_node"): |
paulb@94 | 496 | self._name_start(node._node.name) |
paulb@94 | 497 | self._popup_start() |
paulb@94 | 498 | self._types(node._node.expr) |
paulb@94 | 499 | self._scopes(node._node) |
paulb@94 | 500 | self._popup_end() |
paulb@94 | 501 | self._name_end() |
paulb@94 | 502 | else: |
paulb@94 | 503 | raise ValueError, node |
paulb@94 | 504 | self._name(node.name) |
paulb@94 | 505 | |
paulb@94 | 506 | def visitAssTuple(self, node): |
paulb@94 | 507 | self.stream.write("<span class='tuple'>\n") |
paulb@94 | 508 | self.stream.write("(") |
paulb@94 | 509 | self._sequence(node) |
paulb@94 | 510 | self.stream.write(")\n") |
paulb@94 | 511 | self.stream.write("</span>\n") |
paulb@94 | 512 | |
paulb@85 | 513 | def visitCallFunc(self, node): |
paulb@85 | 514 | self.stream.write("<span class='callfunc'>\n") |
paulb@85 | 515 | self.dispatch(node.node) |
paulb@85 | 516 | self.stream.write("(") |
paulb@85 | 517 | first = 1 |
paulb@85 | 518 | for arg in node.args: |
paulb@85 | 519 | if not first: |
paulb@85 | 520 | self.stream.write(",\n") |
paulb@85 | 521 | self.dispatch(arg) |
paulb@85 | 522 | first = 0 |
paulb@85 | 523 | if node.star_args is not None: |
paulb@85 | 524 | if not first: |
paulb@85 | 525 | self.stream.write(", *\n") |
paulb@85 | 526 | self.dispatch(node.star_args) |
paulb@85 | 527 | first = 0 |
paulb@85 | 528 | if node.dstar_args is not None: |
paulb@85 | 529 | if not first: |
paulb@85 | 530 | self.stream.write(", **\n") |
paulb@85 | 531 | self.dispatch(node.dstar_args) |
paulb@85 | 532 | first = 0 |
paulb@85 | 533 | self.stream.write(")\n") |
paulb@85 | 534 | self.stream.write("</span>\n") |
paulb@85 | 535 | |
paulb@94 | 536 | def visitCompare(self, node): |
paulb@94 | 537 | self.stream.write("<span class='compare'>\n") |
paulb@94 | 538 | self.dispatch(node.expr) |
paulb@102 | 539 | for (op_name, expr), _op in map(None, node.ops, node._ops): |
paulb@102 | 540 | self.stream.write("<span class='op'>\n") |
paulb@102 | 541 | self.stream.write(op_name) |
paulb@102 | 542 | self._popup_start() |
paulb@102 | 543 | self._op(op_name, _op) |
paulb@102 | 544 | self._popup_end() |
paulb@102 | 545 | self.stream.write("</span>\n") |
paulb@102 | 546 | self.dispatch(expr) |
paulb@79 | 547 | self.stream.write("</span>\n") |
paulb@79 | 548 | |
paulb@79 | 549 | def visitConst(self, node): |
paulb@79 | 550 | self.stream.write(repr(node.value)) |
paulb@79 | 551 | |
paulb@83 | 552 | def visitGetattr(self, node): |
paulb@83 | 553 | self.stream.write("<span class='getattr'>\n") |
paulb@83 | 554 | self.dispatch(node.expr) |
paulb@83 | 555 | self.stream.write("<span class='attr'>\n") |
paulb@83 | 556 | self.stream.write(".%s\n" % self._text(node.attrname)) |
paulb@87 | 557 | if hasattr(node, "_node"): |
paulb@87 | 558 | self._popup_start() |
paulb@87 | 559 | self._types(node._node) |
paulb@87 | 560 | self._scopes(node._node) |
paulb@87 | 561 | self._popup_end() |
paulb@94 | 562 | else: |
paulb@94 | 563 | raise ValueError, node |
paulb@83 | 564 | self.stream.write("</span>\n") |
paulb@83 | 565 | self.stream.write("</span>\n") |
paulb@83 | 566 | |
paulb@94 | 567 | def visitKeyword(self, node): |
paulb@94 | 568 | self.stream.write("<span class='keyword'>\n") |
paulb@94 | 569 | self.stream.write(node.name) |
paulb@94 | 570 | self.stream.write("=") |
paulb@83 | 571 | self.dispatch(node.expr) |
paulb@94 | 572 | self.stream.write("</span>\n") |
paulb@94 | 573 | |
paulb@102 | 574 | def visitLambda(self, node): |
paulb@102 | 575 | definition = node._node |
paulb@102 | 576 | subprogram = definition.expr.ref |
paulb@102 | 577 | self.stream.write("<span class='lambda'>\n") |
paulb@102 | 578 | self._keyword("lambda") |
paulb@102 | 579 | self._parameters(subprogram) |
paulb@102 | 580 | self.dispatch(node.code) |
paulb@102 | 581 | self.stream.write("</span>\n") |
paulb@102 | 582 | |
paulb@94 | 583 | visitList = visitAssList |
paulb@94 | 584 | |
paulb@94 | 585 | def visitName(self, node): |
paulb@87 | 586 | if hasattr(node, "_node"): |
paulb@94 | 587 | self._name_start(node._node.name) |
paulb@87 | 588 | self._popup_start() |
paulb@87 | 589 | self._types(node._node) |
paulb@87 | 590 | self._scopes(node._node) |
paulb@87 | 591 | self._popup_end() |
paulb@94 | 592 | self._name_end() |
paulb@94 | 593 | else: |
paulb@94 | 594 | raise ValueError, node |
paulb@94 | 595 | self._name(node.name) |
paulb@94 | 596 | |
paulb@94 | 597 | def visitSlice(self, node): |
paulb@94 | 598 | self.stream.write("<span class='slice'>\n") |
paulb@94 | 599 | self.dispatch(node.expr) |
paulb@94 | 600 | self.stream.write("[") |
paulb@94 | 601 | if node.lower: |
paulb@94 | 602 | self.dispatch(node.lower) |
paulb@94 | 603 | self.stream.write(":") |
paulb@94 | 604 | if node.upper: |
paulb@94 | 605 | self.dispatch(node.upper) |
paulb@94 | 606 | # NOTE: Step? |
paulb@94 | 607 | self.stream.write("]") |
paulb@83 | 608 | self.stream.write("</span>\n") |
paulb@94 | 609 | |
paulb@94 | 610 | def visitSubscript(self, node): |
paulb@94 | 611 | self.stream.write("<span class='subscript'>\n") |
paulb@94 | 612 | self.dispatch(node.expr) |
paulb@94 | 613 | self.stream.write("[") |
paulb@94 | 614 | first = 1 |
paulb@94 | 615 | for sub in node.subs: |
paulb@94 | 616 | if not first: |
paulb@94 | 617 | self.stream.write(", ") |
paulb@94 | 618 | self.dispatch(sub) |
paulb@94 | 619 | first = 0 |
paulb@94 | 620 | self.stream.write("]") |
paulb@83 | 621 | self.stream.write("</span>\n") |
paulb@83 | 622 | |
paulb@94 | 623 | visitTuple = visitAssTuple |
paulb@94 | 624 | |
paulb@78 | 625 | # Output preparation methods. |
paulb@78 | 626 | |
paulb@78 | 627 | def _text(self, text): |
paulb@78 | 628 | return text.replace("&", "&").replace("<", "<").replace(">", ">") |
paulb@78 | 629 | |
paulb@78 | 630 | def _attr(self, attr): |
paulb@78 | 631 | return self._text(attr).replace("'", "'").replace('"', """) |
paulb@78 | 632 | |
paulb@78 | 633 | def _url(self, url): |
paulb@78 | 634 | return self._attr(url).replace("#", "%23").replace("-", "%2d") |
paulb@78 | 635 | |
paulb@78 | 636 | def _comment(self, comment): |
paulb@78 | 637 | self.stream.write("<span class='comment'># %s</span>\n" % comment) |
paulb@78 | 638 | |
paulb@78 | 639 | def _keyword(self, kw): |
paulb@78 | 640 | self.stream.write("<span class='keyword'>%s</span> " % kw) |
paulb@78 | 641 | |
paulb@79 | 642 | def _doc(self, node): |
paulb@79 | 643 | if node.doc is not None: |
paulb@87 | 644 | self.stream.write("<pre class='doc'>\n") |
paulb@87 | 645 | self.stream.write('"""') |
paulb@87 | 646 | output = textwrap.dedent(node.doc.replace('"""', '\\"\\"\\"')) |
paulb@87 | 647 | self.stream.write(self._text(output)) |
paulb@87 | 648 | self.stream.write('"""') |
paulb@87 | 649 | self.stream.write("</pre>\n") |
paulb@79 | 650 | |
paulb@79 | 651 | def _sequence(self, node): |
paulb@79 | 652 | first = 1 |
paulb@79 | 653 | for n in node.nodes: |
paulb@79 | 654 | if not first: |
paulb@79 | 655 | self.stream.write(",\n") |
paulb@79 | 656 | self.dispatch(n) |
paulb@79 | 657 | first = 0 |
paulb@78 | 658 | |
paulb@102 | 659 | def _parameters(self, subprogram): |
paulb@102 | 660 | first = 1 |
paulb@102 | 661 | for param, default in subprogram.params: |
paulb@102 | 662 | if not first: |
paulb@102 | 663 | self.stream.write(",\n") |
paulb@102 | 664 | self._parameter(subprogram, param, default) |
paulb@102 | 665 | first = 0 |
paulb@102 | 666 | if subprogram.star is not None: |
paulb@102 | 667 | if not first: |
paulb@102 | 668 | self.stream.write(", *\n") |
paulb@102 | 669 | param, default = subprogram.star |
paulb@102 | 670 | self._parameter(subprogram, param, default) |
paulb@102 | 671 | first = 0 |
paulb@102 | 672 | if subprogram.dstar is not None: |
paulb@102 | 673 | if not first: |
paulb@102 | 674 | self.stream.write(", **\n") |
paulb@102 | 675 | param, default = subprogram.dstar |
paulb@102 | 676 | self._parameter(subprogram, param, default) |
paulb@102 | 677 | first = 0 |
paulb@102 | 678 | |
paulb@94 | 679 | def _parameter(self, subprogram, param, default): |
paulb@85 | 680 | self._name_start(param) |
paulb@85 | 681 | if hasattr(subprogram, "paramtypes"): |
paulb@85 | 682 | self._popup_start() |
paulb@85 | 683 | self._types_list(subprogram.paramtypes[param]) |
paulb@85 | 684 | self._popup_end() |
paulb@85 | 685 | self._name_end() |
paulb@94 | 686 | if default is not None and default.original is not None: |
paulb@94 | 687 | self.stream.write("=\n") |
paulb@94 | 688 | self.dispatch(default.original) |
paulb@85 | 689 | |
paulb@83 | 690 | def _name(self, name): |
paulb@83 | 691 | self.stream.write("<span class='name'>%s</span>\n" % name) |
paulb@79 | 692 | |
paulb@83 | 693 | def _name_start(self, name): |
paulb@83 | 694 | self.stream.write("<span class='name'>%s\n" % name) |
paulb@79 | 695 | |
paulb@79 | 696 | def _name_end(self): |
paulb@79 | 697 | self.stream.write("</span>\n") |
paulb@79 | 698 | |
paulb@84 | 699 | def _popup_start(self): |
paulb@84 | 700 | self.stream.write("<span class='popup'>\n") |
paulb@84 | 701 | |
paulb@84 | 702 | def _popup_end(self): |
paulb@84 | 703 | self.stream.write("</span>\n") |
paulb@84 | 704 | |
paulb@102 | 705 | def _op(self, op_name, op): |
paulb@102 | 706 | if op is not None: |
paulb@102 | 707 | self._invocations(op) |
paulb@102 | 708 | |
paulb@102 | 709 | def _invocations(self, node): |
paulb@102 | 710 | if hasattr(node, "invocations"): |
paulb@102 | 711 | self._invocations_list(node.invocations) |
paulb@102 | 712 | |
paulb@102 | 713 | def _invocations_list(self, invocations): |
paulb@102 | 714 | self.stream.write("<div class='invocations'>\n") |
paulb@102 | 715 | for invocation in invocations: |
paulb@102 | 716 | fn = invocation.full_name() |
paulb@119 | 717 | module = invocation.module.name |
paulb@119 | 718 | name = invocation.name |
paulb@120 | 719 | structures = [x.name for x in invocation.structures] |
paulb@102 | 720 | self.stream.write("<div class='invocation'>") |
paulb@119 | 721 | self.stream.write("<a href='%s.html#%s'>" % (self._url(module), self._url(fn))) |
paulb@120 | 722 | self.stream.write(self._text(".".join([module] + structures + [name]))) |
paulb@119 | 723 | self.stream.write("</a>") |
paulb@102 | 724 | self.stream.write("</div>\n") |
paulb@102 | 725 | self.stream.write("</div>\n") |
paulb@102 | 726 | |
paulb@79 | 727 | def _types(self, node): |
paulb@84 | 728 | if hasattr(node, "types"): |
paulb@124 | 729 | if node.types: |
paulb@124 | 730 | self._types_list(node.types) |
paulb@124 | 731 | else: |
paulb@124 | 732 | self.stream.write("<div class='types'>\n") |
paulb@124 | 733 | self.stream.write("no types\n") |
paulb@124 | 734 | self.stream.write("</div>\n") |
paulb@84 | 735 | else: |
paulb@83 | 736 | self.stream.write("<div class='types'>\n") |
paulb@94 | 737 | self.stream.write("unvisited\n") |
paulb@83 | 738 | self.stream.write("</div>\n") |
paulb@83 | 739 | |
paulb@119 | 740 | def _types_list(self, types, style_class="types"): |
paulb@119 | 741 | self.stream.write("<div class='%s'>\n" % style_class) |
paulb@83 | 742 | for type in types: |
paulb@79 | 743 | fn = type.type.full_name() |
paulb@79 | 744 | self.stream.write("<div class='type'>") |
paulb@78 | 745 | self.stream.write(self._text(fn)) |
paulb@78 | 746 | self.stream.write("</div>\n") |
paulb@79 | 747 | self.stream.write("</div>\n") |
paulb@79 | 748 | |
paulb@119 | 749 | def _raises(self, node): |
paulb@119 | 750 | if hasattr(node, "namespace") and hasattr(node.namespace, "raises") and node.namespace.raises: |
paulb@119 | 751 | self._types_list(node.namespace.raises, style_class="raises") |
paulb@119 | 752 | |
paulb@79 | 753 | def _scopes(self, node): |
paulb@83 | 754 | if not isinstance(node, LoadName): |
paulb@124 | 755 | if hasattr(node, "writes") and node.writes or hasattr(node, "accesses") and node.accesses: |
paulb@94 | 756 | self.stream.write("<div class='scopes'>\n") |
paulb@83 | 757 | for ref in getattr(node, "writes", getattr(node, "accesses", {})).keys(): |
paulb@83 | 758 | fn = ref.full_name() |
paulb@83 | 759 | self.stream.write("<div class='scope'>") |
paulb@83 | 760 | self.stream.write(self._text(fn)) |
paulb@83 | 761 | self.stream.write("</div>\n") |
paulb@94 | 762 | self.stream.write("</div>\n") |
paulb@124 | 763 | if hasattr(node, "non_accesses") and node.non_accesses: |
paulb@124 | 764 | self._types_list(node.non_accesses, style_class="non-accesses") |
paulb@125 | 765 | if hasattr(node, "non_writes") and node.non_writes: |
paulb@125 | 766 | self._types_list(node.non_writes, style_class="non-writes") |
paulb@78 | 767 | |
paulb@84 | 768 | # Utility functions. |
paulb@84 | 769 | |
paulb@84 | 770 | def flatten(lists): |
paulb@84 | 771 | result = [] |
paulb@84 | 772 | for l in lists: |
paulb@84 | 773 | for attr in l: |
paulb@84 | 774 | if attr not in result: |
paulb@84 | 775 | result.append(attr) |
paulb@84 | 776 | return result |
paulb@84 | 777 | |
paulb@57 | 778 | # Convenience functions. |
paulb@57 | 779 | |
paulb@57 | 780 | def view(module, stream=None): |
paulb@57 | 781 | viewer = Viewer(stream or sys.stdout) |
paulb@57 | 782 | viewer.process(module.original) |
paulb@57 | 783 | |
paulb@78 | 784 | def browse(module, stream=None): |
paulb@78 | 785 | browser = Browser(stream or sys.stdout) |
paulb@78 | 786 | browser.process(module.original) |
paulb@78 | 787 | |
paulb@78 | 788 | def makedoc(module, filename): |
paulb@78 | 789 | stream = open(filename, "wb") |
paulb@78 | 790 | try: |
paulb@78 | 791 | browser = Browser(stream) |
paulb@78 | 792 | browser.process(module.original) |
paulb@78 | 793 | finally: |
paulb@78 | 794 | stream.close() |
paulb@78 | 795 | |
paulb@57 | 796 | # vim: tabstop=4 expandtab shiftwidth=4 |