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