paulb@57 | 1 | #!/usr/bin/env python |
paulb@57 | 2 | |
paulb@57 | 3 | """ |
paulb@57 | 4 | View annotated sources. |
paulb@57 | 5 | |
paulb@171 | 6 | Copyright (C) 2006, 2007 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@157 | 41 | 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@177 | 46 | .class { margin-top: 1em; margin-bottom: 1em; } |
paulb@177 | 47 | .function { margin-top: 1em; margin-bottom: 1em; } |
paulb@78 | 48 | .body { padding-left: 2em; } |
paulb@78 | 49 | .keyword { color: yellow; } |
paulb@78 | 50 | .comment { color: blue; } |
paulb@216 | 51 | .class-name { color: cyan; } |
paulb@211 | 52 | .function-name { color: cyan; } |
paulb@83 | 53 | .str { color: #FF00FF; } |
paulb@177 | 54 | .doc { color: #FF00FF; margin-top: 1em; margin-bottom: 1em; } |
paulb@119 | 55 | .invocation a { color: white; text-decoration: none; } |
paulb@78 | 56 | |
paulb@84 | 57 | .popup { |
paulb@78 | 58 | display: none; z-index: 2; |
paulb@84 | 59 | position: absolute; top: 1em; left: 0.5em; |
paulb@214 | 60 | padding: 0.2em; background-color: #000000; color: white; |
paulb@136 | 61 | border: 2px solid #dddddd; |
paulb@84 | 62 | } |
paulb@84 | 63 | |
paulb@102 | 64 | .invocations { |
paulb@102 | 65 | padding: 0.5em; background-color: #770000; |
paulb@102 | 66 | clear: all; |
paulb@102 | 67 | } |
paulb@102 | 68 | |
paulb@84 | 69 | .types { |
paulb@78 | 70 | padding: 0.5em; background-color: #0000FF; |
paulb@84 | 71 | float: right; |
paulb@78 | 72 | } |
paulb@78 | 73 | |
paulb@119 | 74 | .raises { |
paulb@119 | 75 | padding: 0.5em; background-color: #7700FF; |
paulb@119 | 76 | float: right; |
paulb@119 | 77 | } |
paulb@119 | 78 | |
paulb@79 | 79 | .scopes { |
paulb@79 | 80 | padding: 0.5em; background-color: #007700; |
paulb@84 | 81 | float: left; |
paulb@79 | 82 | } |
paulb@79 | 83 | |
paulb@125 | 84 | .non-writes, .non-accesses { |
paulb@124 | 85 | padding: 0.5em; background-color: #FF0000; |
paulb@124 | 86 | float: right; |
paulb@124 | 87 | } |
paulb@124 | 88 | |
paulb@102 | 89 | .op, |
paulb@83 | 90 | .name, |
paulb@119 | 91 | .attr, |
paulb@134 | 92 | .conditional, |
paulb@135 | 93 | .operator, |
paulb@135 | 94 | .iterator, |
paulb@147 | 95 | .call, |
paulb@202 | 96 | .returns, |
paulb@202 | 97 | .failure |
paulb@83 | 98 | { |
paulb@83 | 99 | position: relative; |
paulb@83 | 100 | } |
paulb@83 | 101 | |
paulb@102 | 102 | .op:hover > .popup, |
paulb@84 | 103 | .name:hover > .popup, |
paulb@119 | 104 | .attr:hover > .popup, |
paulb@134 | 105 | .conditional:hover > .popup, |
paulb@135 | 106 | .operator:hover > .popup, |
paulb@135 | 107 | .iterator:hover > .popup, |
paulb@147 | 108 | .call:hover > .popup, |
paulb@202 | 109 | .returns:hover > .popup, |
paulb@202 | 110 | .failure:hover > .popup |
paulb@78 | 111 | { |
paulb@78 | 112 | display: block; |
paulb@78 | 113 | } |
paulb@78 | 114 | |
paulb@78 | 115 | </style> |
paulb@78 | 116 | </head> |
paulb@78 | 117 | <body> |
paulb@78 | 118 | """ |
paulb@78 | 119 | |
paulb@78 | 120 | html_footer = """</body> |
paulb@78 | 121 | </html> |
paulb@78 | 122 | """ |
paulb@78 | 123 | |
paulb@87 | 124 | # Browser classes. |
paulb@87 | 125 | |
paulb@78 | 126 | class Browser(ASTVisitor): |
paulb@78 | 127 | |
paulb@78 | 128 | """ |
paulb@78 | 129 | A browsing visitor for AST nodes. |
paulb@102 | 130 | |
paulb@202 | 131 | Covered: Add, And, Assert, AssAttr, AssList, AssName, AssTuple, Assign, |
paulb@203 | 132 | AugAssign, Bitand, Break, CallFunc, Class, Compare, Const, |
paulb@203 | 133 | Continue, Dict, Discard, Div, FloorDiv, For, From, Function, |
paulb@203 | 134 | Getattr, Global, If, Import, Keyword, Lambda, List, ListComp, |
paulb@203 | 135 | ListCompFor, ListCompIf, Mod, Module, Mul, Name, Not, Or, Pass, |
paulb@203 | 136 | Power, Print, Printnl, Raise, Return, Slice, Sliceobj, Stmt, Sub, |
paulb@203 | 137 | Subscript, TryExcept, TryFinally, Tuple, UnaryAdd, UnarySub, While. |
paulb@102 | 138 | |
paulb@203 | 139 | Missing: Backquote, Bitor, Bitxor, Decorators, Ellipsis, |
paulb@201 | 140 | Exec, Invert, LeftShift, RightShift, Yield. |
paulb@78 | 141 | """ |
paulb@78 | 142 | |
paulb@78 | 143 | def __init__(self, stream): |
paulb@78 | 144 | ASTVisitor.__init__(self) |
paulb@78 | 145 | self.visitor = self |
paulb@78 | 146 | self.stream = stream |
paulb@78 | 147 | |
paulb@78 | 148 | def process(self, module): |
paulb@78 | 149 | self.stream.write(html_header) |
paulb@78 | 150 | self.dispatch(module) |
paulb@78 | 151 | self.stream.write(html_footer) |
paulb@78 | 152 | |
paulb@78 | 153 | def visitModule(self, node): |
paulb@78 | 154 | self.default(node) |
paulb@78 | 155 | |
paulb@79 | 156 | # Statements. |
paulb@79 | 157 | |
paulb@202 | 158 | def visitAssert(self, node): |
paulb@202 | 159 | self.stream.write("<div class='assert'>\n") |
paulb@202 | 160 | self.stream.write("<span class='failure'>\n") |
paulb@202 | 161 | self._keyword("assert") |
paulb@202 | 162 | self._popup( |
paulb@202 | 163 | self._types(node._raises.active()) |
paulb@202 | 164 | ) |
paulb@202 | 165 | self.stream.write("</span>\n") |
paulb@202 | 166 | self.dispatch(node.test) |
paulb@202 | 167 | if node.fail: |
paulb@202 | 168 | self.stream.write(", ") |
paulb@202 | 169 | self.dispatch(node.fail) |
paulb@202 | 170 | self.stream.write("</div>\n") |
paulb@202 | 171 | |
paulb@87 | 172 | def visitAssign(self, node): |
paulb@87 | 173 | self.stream.write("<div class='assign'>\n") |
paulb@87 | 174 | for lvalue in node.nodes: |
paulb@87 | 175 | self.dispatch(lvalue) |
paulb@87 | 176 | self.stream.write("=\n") |
paulb@87 | 177 | self.dispatch(node.expr) |
paulb@87 | 178 | self.stream.write("</div>\n") |
paulb@78 | 179 | |
paulb@94 | 180 | def visitAugAssign(self, node): |
paulb@94 | 181 | self.stream.write("<div class='augassign'>\n") |
paulb@94 | 182 | self.dispatch(node.node) |
paulb@173 | 183 | self.stream.write("<span class='operator'>\n") |
paulb@94 | 184 | self.stream.write("%s\n" % node.op) |
paulb@201 | 185 | self._popup( |
paulb@201 | 186 | self._invocations(node._op_call.active()) |
paulb@201 | 187 | ) |
paulb@173 | 188 | self.stream.write("</span>\n") |
paulb@94 | 189 | self.dispatch(node.expr) |
paulb@94 | 190 | self.stream.write("</div>\n") |
paulb@94 | 191 | |
paulb@102 | 192 | def visitBreak(self, node): |
paulb@102 | 193 | self.stream.write("<div class='break'>\n") |
paulb@102 | 194 | self._keyword("break") |
paulb@102 | 195 | self.stream.write("</div>\n") |
paulb@102 | 196 | |
paulb@78 | 197 | def visitClass(self, node): |
paulb@79 | 198 | definition = node._node |
paulb@196 | 199 | definitions = definition.active() |
paulb@83 | 200 | structure = definition.expr.ref |
paulb@79 | 201 | self.stream.write("<div class='class' id='%s'>\n" % self._url(structure.full_name())) |
paulb@94 | 202 | self.stream.write("<div>\n") |
paulb@78 | 203 | self._keyword("class") |
paulb@216 | 204 | self._name_start(structure.name, "class-name") |
paulb@201 | 205 | self._popup( |
paulb@201 | 206 | self._scopes(definitions) |
paulb@201 | 207 | ) |
paulb@79 | 208 | self._name_end() |
paulb@78 | 209 | bases = structure.bases |
paulb@129 | 210 | |
paulb@129 | 211 | # Suppress the "object" class appearing alone. |
paulb@129 | 212 | |
paulb@129 | 213 | if bases and not (len(bases) == 1 and bases[0].name == "object"): |
paulb@79 | 214 | self.stream.write("(") |
paulb@78 | 215 | first = 1 |
paulb@78 | 216 | for base in bases: |
paulb@78 | 217 | if not first: |
paulb@78 | 218 | self.stream.write(",\n") |
paulb@83 | 219 | self._name_start(base.name) |
paulb@201 | 220 | self._popup( |
paulb@201 | 221 | self._scopes([base]) + |
paulb@201 | 222 | self._types([base]) |
paulb@201 | 223 | ) |
paulb@79 | 224 | self._name_end() |
paulb@78 | 225 | first = 0 |
paulb@78 | 226 | self.stream.write(")") |
paulb@129 | 227 | |
paulb@78 | 228 | self.stream.write(":\n") |
paulb@79 | 229 | self._comment(self._text(structure.full_name())) |
paulb@94 | 230 | self.stream.write("</div>\n") |
paulb@78 | 231 | |
paulb@78 | 232 | self.stream.write("<div class='body'>\n") |
paulb@79 | 233 | self._doc(node) |
paulb@79 | 234 | self.dispatch(node.code) |
paulb@78 | 235 | self.stream.write("</div>\n") |
paulb@78 | 236 | self.stream.write("</div>\n") |
paulb@78 | 237 | |
paulb@102 | 238 | def visitContinue(self, node): |
paulb@102 | 239 | self.stream.write("<div class='continue'>\n") |
paulb@102 | 240 | self._keyword("continue") |
paulb@102 | 241 | self.stream.write("</div>\n") |
paulb@102 | 242 | |
paulb@119 | 243 | def visitDiscard(self, node): |
paulb@119 | 244 | self.stream.write("<div class='discard'>\n") |
paulb@119 | 245 | self.default(node) |
paulb@119 | 246 | self.stream.write("</div>\n") |
paulb@119 | 247 | |
paulb@94 | 248 | def visitFor(self, node): |
paulb@94 | 249 | self.stream.write("<div class='if'>\n") |
paulb@94 | 250 | self.stream.write("<div>\n") |
paulb@135 | 251 | self.stream.write("<span class='iterator'>\n") |
paulb@94 | 252 | self._keyword("for") |
paulb@201 | 253 | self._popup( |
paulb@201 | 254 | self._invocations(node._next_call.active()) |
paulb@201 | 255 | ) |
paulb@135 | 256 | self.stream.write("</span>\n") |
paulb@94 | 257 | self.dispatch(node.assign) |
paulb@135 | 258 | self.stream.write("<span class='iterator'>\n") |
paulb@94 | 259 | self._keyword("in") |
paulb@201 | 260 | self._popup( |
paulb@201 | 261 | self._invocations(node._iter_call.active()) |
paulb@201 | 262 | ) |
paulb@135 | 263 | self.stream.write("</span>\n") |
paulb@94 | 264 | self.dispatch(node.list) |
paulb@94 | 265 | self.stream.write(":\n") |
paulb@94 | 266 | self.stream.write("</div>\n") |
paulb@94 | 267 | self.stream.write("<div class='body'>\n") |
paulb@94 | 268 | self.dispatch(node.body) |
paulb@94 | 269 | self.stream.write("</div>\n") |
paulb@94 | 270 | if node.else_ is not None: |
paulb@94 | 271 | self.stream.write("<div>\n") |
paulb@94 | 272 | self._keyword("else") |
paulb@94 | 273 | self.stream.write(":\n") |
paulb@94 | 274 | self.stream.write("</div>\n") |
paulb@94 | 275 | self.stream.write("<div class='body'>\n") |
paulb@94 | 276 | self.dispatch(node.else_) |
paulb@94 | 277 | self.stream.write("</div>\n") |
paulb@94 | 278 | self.stream.write("</div>\n") |
paulb@87 | 279 | |
paulb@157 | 280 | def visitFrom(self, node): |
paulb@157 | 281 | self.stream.write("<div class='from'>\n") |
paulb@157 | 282 | self._keyword("from") |
paulb@157 | 283 | self.stream.write("<span class='name'>\n") |
paulb@157 | 284 | self.stream.write(node.modname) |
paulb@201 | 285 | self._popup( |
paulb@201 | 286 | self._types(node._modname.active()) |
paulb@201 | 287 | ) |
paulb@157 | 288 | self.stream.write("</span>\n") |
paulb@157 | 289 | self._keyword("import") |
paulb@157 | 290 | first = 1 |
paulb@157 | 291 | for (name, alias), _name in map(None, node.names, node._names): |
paulb@157 | 292 | if not first: |
paulb@157 | 293 | self.stream.write(",\n") |
paulb@157 | 294 | if alias: |
paulb@157 | 295 | self.stream.write(name + " ") |
paulb@157 | 296 | self._keyword("as") |
paulb@157 | 297 | self.stream.write("<span class='name'>\n") |
paulb@157 | 298 | self.stream.write(alias or name) |
paulb@201 | 299 | self._popup( |
paulb@201 | 300 | self._types([_name]) |
paulb@201 | 301 | ) |
paulb@157 | 302 | self.stream.write("</span>\n") |
paulb@157 | 303 | first = 0 |
paulb@157 | 304 | self.stream.write("</div>\n") |
paulb@157 | 305 | |
paulb@83 | 306 | def visitFunction(self, node): |
paulb@83 | 307 | definition = node._node |
paulb@196 | 308 | definitions = [n for n in definition.active() if not isinstance(n, Subprogram)] |
paulb@196 | 309 | subprogram = node._subprogram |
paulb@196 | 310 | subprograms = subprogram.active() |
paulb@94 | 311 | self.stream.write("<div class='function' id='%s'>\n" % self._url(subprogram.full_name())) |
paulb@94 | 312 | self.stream.write("<div>\n") |
paulb@83 | 313 | self._keyword("def") |
paulb@211 | 314 | self._name_start(subprogram.name, "function-name") |
paulb@201 | 315 | self._popup( |
paulb@201 | 316 | self._scopes([definition]) + # not dependent on subprograms |
paulb@201 | 317 | self._raises(subprograms) |
paulb@201 | 318 | ) |
paulb@83 | 319 | self._name_end() |
paulb@83 | 320 | self.stream.write("(") |
paulb@189 | 321 | self._parameters(subprogram, subprograms) |
paulb@83 | 322 | self.stream.write(")") |
paulb@83 | 323 | self.stream.write(":\n") |
paulb@83 | 324 | self._comment(self._text(subprogram.full_name())) |
paulb@94 | 325 | self.stream.write("</div>\n") |
paulb@83 | 326 | |
paulb@83 | 327 | self.stream.write("<div class='body'>\n") |
paulb@83 | 328 | self._doc(node) |
paulb@83 | 329 | self.dispatch(node.code) |
paulb@83 | 330 | self.stream.write("</div>\n") |
paulb@83 | 331 | self.stream.write("</div>\n") |
paulb@83 | 332 | |
paulb@155 | 333 | def visitGlobal(self, node): |
paulb@155 | 334 | self.stream.write("<div class='global'>\n") |
paulb@155 | 335 | self._keyword("global") |
paulb@155 | 336 | first = 1 |
paulb@155 | 337 | for name in node.names: |
paulb@155 | 338 | if not first: |
paulb@155 | 339 | self.stream.write(",\n") |
paulb@155 | 340 | self.stream.write(name) |
paulb@155 | 341 | first = 0 |
paulb@155 | 342 | self.stream.write("</div>\n") |
paulb@155 | 343 | |
paulb@94 | 344 | def visitIf(self, node): |
paulb@94 | 345 | self.stream.write("<div class='if'>\n") |
paulb@94 | 346 | first = 1 |
paulb@119 | 347 | conditional = node._node |
paulb@196 | 348 | conditionals = conditional.active() |
paulb@94 | 349 | for compare, stmt in node.tests: |
paulb@94 | 350 | self.stream.write("<div>\n") |
paulb@119 | 351 | self.stream.write("<span class='conditional'>\n") |
paulb@94 | 352 | if first: |
paulb@94 | 353 | self._keyword("if") |
paulb@94 | 354 | else: |
paulb@94 | 355 | self._keyword("elif") |
paulb@201 | 356 | self._popup( |
paulb@201 | 357 | self._invocations([c.test for c in conditionals]) |
paulb@201 | 358 | ) |
paulb@120 | 359 | self.stream.write("</span>\n") |
paulb@94 | 360 | self.dispatch(compare) |
paulb@94 | 361 | self.stream.write(":\n") |
paulb@94 | 362 | self.stream.write("</div>\n") |
paulb@94 | 363 | self.stream.write("<div class='body'>\n") |
paulb@94 | 364 | self.dispatch(stmt) |
paulb@94 | 365 | self.stream.write("</div>\n") |
paulb@119 | 366 | if conditional.else_: |
paulb@119 | 367 | conditional = conditional.else_[0] |
paulb@201 | 368 | conditionals = conditional.active() |
paulb@119 | 369 | else: |
paulb@119 | 370 | conditional = None |
paulb@201 | 371 | conditionals = [] |
paulb@94 | 372 | first = 0 |
paulb@94 | 373 | if node.else_ is not None: |
paulb@94 | 374 | self.stream.write("<div>\n") |
paulb@94 | 375 | self._keyword("else") |
paulb@94 | 376 | self.stream.write(":\n") |
paulb@94 | 377 | self.stream.write("</div>\n") |
paulb@94 | 378 | self.stream.write("<div class='body'>\n") |
paulb@94 | 379 | self.dispatch(node.else_) |
paulb@94 | 380 | self.stream.write("</div>\n") |
paulb@94 | 381 | self.stream.write("</div>\n") |
paulb@87 | 382 | |
paulb@157 | 383 | def visitImport(self, node): |
paulb@157 | 384 | self.stream.write("<div class='import'>\n") |
paulb@157 | 385 | self._keyword("import") |
paulb@157 | 386 | first = 1 |
paulb@157 | 387 | for (name, alias), _name in map(None, node.names, node._names): |
paulb@157 | 388 | if not first: |
paulb@157 | 389 | self.stream.write(",\n") |
paulb@157 | 390 | if alias: |
paulb@157 | 391 | self.stream.write(name + " ") |
paulb@157 | 392 | self._keyword("as") |
paulb@157 | 393 | self.stream.write("<span class='name'>\n") |
paulb@157 | 394 | self.stream.write(alias or name) |
paulb@201 | 395 | self._popup( |
paulb@201 | 396 | self._types([_name]) |
paulb@201 | 397 | ) |
paulb@157 | 398 | self.stream.write("</span>\n") |
paulb@157 | 399 | first = 0 |
paulb@157 | 400 | self.stream.write("</div>\n") |
paulb@157 | 401 | |
paulb@87 | 402 | def visitPass(self, node): |
paulb@94 | 403 | self.stream.write("<div class='pass'>\n") |
paulb@87 | 404 | self._keyword("pass") |
paulb@94 | 405 | self.stream.write("</div>\n") |
paulb@94 | 406 | |
paulb@147 | 407 | def visitPrint(self, node): |
paulb@147 | 408 | self.stream.write("<div class='print'>\n") |
paulb@147 | 409 | self._keyword("print") |
paulb@147 | 410 | if node.dest is not None: |
paulb@147 | 411 | self.stream.write(">>\n") |
paulb@147 | 412 | self.dispatch(node.dest) |
paulb@147 | 413 | for n in node.nodes: |
paulb@147 | 414 | self.dispatch(n) |
paulb@147 | 415 | self.stream.write(",\n") |
paulb@147 | 416 | self.stream.write("</div>\n") |
paulb@147 | 417 | |
paulb@147 | 418 | def visitPrintnl(self, node): |
paulb@147 | 419 | self.stream.write("<div class='printnl'>\n") |
paulb@147 | 420 | self._keyword("print") |
paulb@147 | 421 | if node.dest is not None: |
paulb@147 | 422 | self.stream.write(">>\n") |
paulb@147 | 423 | self.dispatch(node.dest) |
paulb@147 | 424 | first = 1 |
paulb@147 | 425 | for n in node.nodes: |
paulb@147 | 426 | if not first: |
paulb@147 | 427 | self.stream.write(",\n") |
paulb@147 | 428 | self.dispatch(n) |
paulb@147 | 429 | first = 0 |
paulb@147 | 430 | self.stream.write("</div>\n") |
paulb@147 | 431 | |
paulb@94 | 432 | def visitRaise(self, node): |
paulb@216 | 433 | target = node._node.expr |
paulb@216 | 434 | targets = target.active() |
paulb@94 | 435 | self.stream.write("<div class='raise'>\n") |
paulb@216 | 436 | self.stream.write("<span class='call'>\n") |
paulb@94 | 437 | self._keyword("raise") |
paulb@216 | 438 | self._popup( |
paulb@216 | 439 | self._invocations(targets) |
paulb@216 | 440 | ) |
paulb@216 | 441 | self.stream.write("</span>\n") |
paulb@94 | 442 | self.dispatch(node.expr1) |
paulb@94 | 443 | if node.expr2 is not None: |
paulb@94 | 444 | self.stream.write(",\n") |
paulb@94 | 445 | self.dispatch(node.expr2) |
paulb@94 | 446 | if node.expr3 is not None: |
paulb@94 | 447 | self.stream.write(",\n") |
paulb@94 | 448 | self.dispatch(node.expr3) |
paulb@94 | 449 | self.stream.write("</div>\n") |
paulb@87 | 450 | |
paulb@87 | 451 | def visitReturn(self, node): |
paulb@189 | 452 | value = node._node |
paulb@196 | 453 | values = value.active() |
paulb@94 | 454 | self.stream.write("<div class='return'>\n") |
paulb@135 | 455 | self.stream.write("<span class='returns'>\n") |
paulb@87 | 456 | self._keyword("return") |
paulb@201 | 457 | self._popup( |
paulb@201 | 458 | self._types(values) |
paulb@201 | 459 | ) |
paulb@135 | 460 | self.stream.write("</span>\n") |
paulb@87 | 461 | self.dispatch(node.value) |
paulb@94 | 462 | self.stream.write("</div>\n") |
paulb@87 | 463 | |
paulb@83 | 464 | def visitStmt(self, node): |
paulb@83 | 465 | self.stream.write("<div class='stmt'>\n") |
paulb@83 | 466 | self.default(node) |
paulb@83 | 467 | self.stream.write("</div>\n") |
paulb@83 | 468 | |
paulb@108 | 469 | def visitTryExcept(self, node): |
paulb@108 | 470 | self.stream.write("<div class='tryexcept'>\n") |
paulb@108 | 471 | self.stream.write("<div>\n") |
paulb@108 | 472 | self._keyword("try") |
paulb@108 | 473 | self.stream.write(":\n") |
paulb@108 | 474 | self.stream.write("</div>\n") |
paulb@108 | 475 | self.stream.write("<div class='body'>\n") |
paulb@108 | 476 | self.dispatch(node.body) |
paulb@108 | 477 | self.stream.write("</div>\n") |
paulb@108 | 478 | for spec, assign, statement in node.handlers: |
paulb@108 | 479 | self.stream.write("<div>\n") |
paulb@108 | 480 | self._keyword("except") |
paulb@108 | 481 | if spec is not None: |
paulb@108 | 482 | self.dispatch(spec) |
paulb@108 | 483 | if assign is not None: |
paulb@108 | 484 | self.stream.write(",\n") |
paulb@108 | 485 | self.dispatch(assign) |
paulb@108 | 486 | self.stream.write(":\n") |
paulb@108 | 487 | self.stream.write("</div>\n") |
paulb@108 | 488 | self.stream.write("<div class='body'>\n") |
paulb@108 | 489 | self.dispatch(statement) |
paulb@108 | 490 | self.stream.write("</div>\n") |
paulb@108 | 491 | if node.else_ is not None: |
paulb@108 | 492 | self.stream.write("<div>\n") |
paulb@108 | 493 | self._keyword("else") |
paulb@108 | 494 | self.stream.write(":\n") |
paulb@108 | 495 | self.stream.write("</div>\n") |
paulb@108 | 496 | self.stream.write("<div class='body'>\n") |
paulb@108 | 497 | self.dispatch(node.else_) |
paulb@108 | 498 | self.stream.write("</div>\n") |
paulb@108 | 499 | self.stream.write("</div>\n") |
paulb@108 | 500 | |
paulb@108 | 501 | def visitTryFinally(self, node): |
paulb@108 | 502 | self.stream.write("<div class='tryfinally'>\n") |
paulb@108 | 503 | self.stream.write("<div>\n") |
paulb@108 | 504 | self._keyword("try") |
paulb@108 | 505 | self.stream.write(":\n") |
paulb@108 | 506 | self.stream.write("</div>\n") |
paulb@108 | 507 | self.stream.write("<div class='body'>\n") |
paulb@108 | 508 | self.dispatch(node.body) |
paulb@108 | 509 | self.stream.write("</div>\n") |
paulb@108 | 510 | self.stream.write("<div>\n") |
paulb@108 | 511 | self._keyword("finally") |
paulb@108 | 512 | self.stream.write(":\n") |
paulb@108 | 513 | self.stream.write("</div>\n") |
paulb@108 | 514 | self.stream.write("<div class='body'>\n") |
paulb@108 | 515 | self.dispatch(node.final) |
paulb@108 | 516 | self.stream.write("</div>\n") |
paulb@108 | 517 | self.stream.write("</div>\n") |
paulb@108 | 518 | |
paulb@102 | 519 | def visitWhile(self, node): |
paulb@102 | 520 | self.stream.write("<div class='while'>\n") |
paulb@102 | 521 | self.stream.write("<div>\n") |
paulb@120 | 522 | self.stream.write("<span class='conditional'>\n") |
paulb@102 | 523 | self._keyword("while") |
paulb@201 | 524 | self._popup( |
paulb@201 | 525 | self._invocations(node._test_call.active()) |
paulb@201 | 526 | ) |
paulb@120 | 527 | self.stream.write("</span>\n") |
paulb@102 | 528 | self.dispatch(node.test) |
paulb@102 | 529 | self.stream.write(":\n") |
paulb@102 | 530 | self.stream.write("</div>\n") |
paulb@102 | 531 | self.stream.write("<div class='body'>\n") |
paulb@102 | 532 | self.dispatch(node.body) |
paulb@102 | 533 | self.stream.write("</div>\n") |
paulb@102 | 534 | if node.else_ is not None: |
paulb@102 | 535 | self.stream.write("<div>\n") |
paulb@102 | 536 | self._keyword("else") |
paulb@102 | 537 | self.stream.write(":\n") |
paulb@102 | 538 | self.stream.write("</div>\n") |
paulb@102 | 539 | self.stream.write("<div class='body'>\n") |
paulb@102 | 540 | self.dispatch(node.else_) |
paulb@102 | 541 | self.stream.write("</div>\n") |
paulb@102 | 542 | self.stream.write("</div>\n") |
paulb@102 | 543 | |
paulb@136 | 544 | # Expression-related helper methods. |
paulb@79 | 545 | |
paulb@135 | 546 | def _visitBinary(self, node, name, symbol): |
paulb@135 | 547 | self.stream.write("<span class='%s'>\n" % name) |
paulb@134 | 548 | self.dispatch(node.left) |
paulb@134 | 549 | self.stream.write("<span class='operator'>\n") |
paulb@216 | 550 | self.stream.write(self._text(symbol)) |
paulb@201 | 551 | self._popup( |
paulb@201 | 552 | self._invocations(node._left_call.active() + node._right_call.active()) |
paulb@201 | 553 | ) |
paulb@134 | 554 | self.stream.write("</span>\n") |
paulb@134 | 555 | self.dispatch(node.right) |
paulb@134 | 556 | self.stream.write("</span>") |
paulb@134 | 557 | |
paulb@136 | 558 | def _visitUnary(self, node, name, symbol): |
paulb@136 | 559 | self.stream.write("<span class='%s'>\n" % name) |
paulb@136 | 560 | self.stream.write("<span class='operator'>\n") |
paulb@136 | 561 | self.stream.write(symbol) |
paulb@201 | 562 | self._popup( |
paulb@201 | 563 | self._invocations(node._unary_call.active()) |
paulb@201 | 564 | ) |
paulb@136 | 565 | self.stream.write("</span>\n") |
paulb@136 | 566 | self.dispatch(node.expr) |
paulb@136 | 567 | self.stream.write("</span>") |
paulb@136 | 568 | |
paulb@136 | 569 | # Expressions. |
paulb@136 | 570 | |
paulb@135 | 571 | def visitAdd(self, node): |
paulb@135 | 572 | self._visitBinary(node, "add", "+") |
paulb@135 | 573 | |
paulb@127 | 574 | def visitAnd(self, node): |
paulb@127 | 575 | self.stream.write("<span class='and'>\n") |
paulb@127 | 576 | first = 1 |
paulb@127 | 577 | for n in node.nodes: |
paulb@127 | 578 | if not first: |
paulb@127 | 579 | self._keyword("and") |
paulb@127 | 580 | self.dispatch(n) |
paulb@127 | 581 | first = 0 |
paulb@127 | 582 | self.stream.write("</span>") |
paulb@127 | 583 | |
paulb@94 | 584 | def visitAssAttr(self, node): |
paulb@189 | 585 | target = node._node |
paulb@196 | 586 | targets = target.active() |
paulb@94 | 587 | self.stream.write("<span class='assattr'>\n") |
paulb@94 | 588 | self.dispatch(node.expr) |
paulb@94 | 589 | self.stream.write("<span class='attr'>\n") |
paulb@94 | 590 | self.stream.write(".%s\n" % self._text(node.attrname)) |
paulb@201 | 591 | self._popup( |
paulb@201 | 592 | self._scopes(targets) + |
paulb@201 | 593 | self._types(targets) |
paulb@201 | 594 | ) |
paulb@94 | 595 | self.stream.write("</span>\n") |
paulb@94 | 596 | self.stream.write("</span>\n") |
paulb@94 | 597 | |
paulb@94 | 598 | def visitAssList(self, node): |
paulb@94 | 599 | self.stream.write("<span class='list'>\n") |
paulb@94 | 600 | self.stream.write("[") |
paulb@94 | 601 | self._sequence(node) |
paulb@94 | 602 | self.stream.write("]\n") |
paulb@94 | 603 | self.stream.write("</span>\n") |
paulb@94 | 604 | |
paulb@94 | 605 | def visitAssName(self, node): |
paulb@189 | 606 | target = node._node |
paulb@196 | 607 | targets = target.active() |
paulb@189 | 608 | self._name_start(target.name) |
paulb@201 | 609 | self._popup( |
paulb@201 | 610 | self._scopes(targets) + |
paulb@201 | 611 | self._types(targets) |
paulb@201 | 612 | ) |
paulb@149 | 613 | self._name_end() |
paulb@94 | 614 | |
paulb@94 | 615 | def visitAssTuple(self, node): |
paulb@94 | 616 | self.stream.write("<span class='tuple'>\n") |
paulb@94 | 617 | self.stream.write("(") |
paulb@94 | 618 | self._sequence(node) |
paulb@94 | 619 | self.stream.write(")\n") |
paulb@94 | 620 | self.stream.write("</span>\n") |
paulb@94 | 621 | |
paulb@203 | 622 | def visitBitand(self, node): |
paulb@203 | 623 | self.stream.write("<span class='bitand'>\n") |
paulb@203 | 624 | self.dispatch(node.nodes[0]) |
paulb@203 | 625 | for op in node._ops: |
paulb@203 | 626 | self.stream.write("<span class='op'>\n") |
paulb@216 | 627 | self.stream.write(self._text(op.name)) |
paulb@203 | 628 | self._popup( |
paulb@203 | 629 | self._op(op) |
paulb@203 | 630 | ) |
paulb@203 | 631 | self.stream.write("</span>\n") |
paulb@203 | 632 | self.dispatch(op.expr) |
paulb@203 | 633 | self.stream.write("</span>") |
paulb@203 | 634 | |
paulb@85 | 635 | def visitCallFunc(self, node): |
paulb@189 | 636 | target = node._node |
paulb@196 | 637 | targets = target.active() |
paulb@85 | 638 | self.stream.write("<span class='callfunc'>\n") |
paulb@85 | 639 | self.dispatch(node.node) |
paulb@147 | 640 | self.stream.write("<span class='call'>\n") |
paulb@85 | 641 | self.stream.write("(") |
paulb@201 | 642 | self._popup( |
paulb@201 | 643 | self._invocations(targets) |
paulb@201 | 644 | ) |
paulb@147 | 645 | self.stream.write("</span>\n") |
paulb@85 | 646 | first = 1 |
paulb@85 | 647 | for arg in node.args: |
paulb@85 | 648 | if not first: |
paulb@85 | 649 | self.stream.write(",\n") |
paulb@85 | 650 | self.dispatch(arg) |
paulb@85 | 651 | first = 0 |
paulb@85 | 652 | if node.star_args is not None: |
paulb@85 | 653 | if not first: |
paulb@85 | 654 | self.stream.write(", *\n") |
paulb@85 | 655 | self.dispatch(node.star_args) |
paulb@85 | 656 | first = 0 |
paulb@85 | 657 | if node.dstar_args is not None: |
paulb@85 | 658 | if not first: |
paulb@85 | 659 | self.stream.write(", **\n") |
paulb@85 | 660 | self.dispatch(node.dstar_args) |
paulb@85 | 661 | first = 0 |
paulb@85 | 662 | self.stream.write(")\n") |
paulb@85 | 663 | self.stream.write("</span>\n") |
paulb@85 | 664 | |
paulb@94 | 665 | def visitCompare(self, node): |
paulb@94 | 666 | self.stream.write("<span class='compare'>\n") |
paulb@94 | 667 | self.dispatch(node.expr) |
paulb@192 | 668 | for op in node._ops: |
paulb@102 | 669 | self.stream.write("<span class='op'>\n") |
paulb@216 | 670 | self.stream.write(self._text(op.name)) |
paulb@201 | 671 | self._popup( |
paulb@201 | 672 | self._op(op) |
paulb@201 | 673 | ) |
paulb@102 | 674 | self.stream.write("</span>\n") |
paulb@192 | 675 | self.dispatch(op.expr) |
paulb@79 | 676 | self.stream.write("</span>\n") |
paulb@79 | 677 | |
paulb@79 | 678 | def visitConst(self, node): |
paulb@217 | 679 | if isinstance(node.value, (str, unicode)): |
paulb@217 | 680 | self.stream.write("<span class='str'>\n") |
paulb@79 | 681 | self.stream.write(repr(node.value)) |
paulb@217 | 682 | if isinstance(node.value, (str, unicode)): |
paulb@217 | 683 | self.stream.write("</span>\n") |
paulb@79 | 684 | |
paulb@189 | 685 | def visitDict(self, node): |
paulb@189 | 686 | self.stream.write("<span class='dict'>\n") |
paulb@189 | 687 | self.stream.write("{") |
paulb@189 | 688 | self._mapping(node) |
paulb@189 | 689 | self.stream.write("}\n") |
paulb@189 | 690 | self.stream.write("</span>\n") |
paulb@189 | 691 | |
paulb@135 | 692 | def visitDiv(self, node): |
paulb@135 | 693 | self._visitBinary(node, "div", "/") |
paulb@135 | 694 | |
paulb@136 | 695 | def visitFloorDiv(self, node): |
paulb@136 | 696 | self._visitBinary(node, "floordiv", "//") |
paulb@136 | 697 | |
paulb@83 | 698 | def visitGetattr(self, node): |
paulb@189 | 699 | target = node._node |
paulb@196 | 700 | targets = target.active() |
paulb@83 | 701 | self.stream.write("<span class='getattr'>\n") |
paulb@83 | 702 | self.dispatch(node.expr) |
paulb@83 | 703 | self.stream.write("<span class='attr'>\n") |
paulb@83 | 704 | self.stream.write(".%s\n" % self._text(node.attrname)) |
paulb@201 | 705 | self._popup( |
paulb@201 | 706 | self._scopes(targets) + |
paulb@201 | 707 | self._types(targets) |
paulb@201 | 708 | ) |
paulb@83 | 709 | self.stream.write("</span>\n") |
paulb@83 | 710 | self.stream.write("</span>\n") |
paulb@83 | 711 | |
paulb@94 | 712 | def visitKeyword(self, node): |
paulb@154 | 713 | self.stream.write("<span class='keyword-arg'>\n") |
paulb@94 | 714 | self.stream.write(node.name) |
paulb@94 | 715 | self.stream.write("=") |
paulb@83 | 716 | self.dispatch(node.expr) |
paulb@94 | 717 | self.stream.write("</span>\n") |
paulb@94 | 718 | |
paulb@102 | 719 | def visitLambda(self, node): |
paulb@102 | 720 | definition = node._node |
paulb@196 | 721 | definitions = [n for n in definition.active() if not isinstance(n, Subprogram)] |
paulb@196 | 722 | subprogram = node._subprogram |
paulb@196 | 723 | subprograms = subprogram.active() |
paulb@102 | 724 | self.stream.write("<span class='lambda'>\n") |
paulb@102 | 725 | self._keyword("lambda") |
paulb@189 | 726 | self._parameters(subprogram, subprograms) |
paulb@102 | 727 | self.dispatch(node.code) |
paulb@102 | 728 | self.stream.write("</span>\n") |
paulb@102 | 729 | |
paulb@94 | 730 | visitList = visitAssList |
paulb@94 | 731 | |
paulb@201 | 732 | def visitListComp(self, node): |
paulb@201 | 733 | self.stream.write("<span class='listcomp'>\n") |
paulb@201 | 734 | self.stream.write("[") |
paulb@201 | 735 | self.dispatch(node.expr) |
paulb@201 | 736 | for qual in node.quals: |
paulb@201 | 737 | self.dispatch(qual) |
paulb@201 | 738 | self.stream.write("]\n") |
paulb@201 | 739 | self.stream.write("</span>\n") |
paulb@201 | 740 | |
paulb@201 | 741 | def visitListCompFor(self, node): |
paulb@201 | 742 | self.stream.write("<span class='listcompfor'>\n") |
paulb@201 | 743 | self.stream.write("<span class='iterator'>\n") |
paulb@201 | 744 | self._keyword("for") |
paulb@201 | 745 | self._popup( |
paulb@201 | 746 | self._invocations(node._next_call.active()) |
paulb@201 | 747 | ) |
paulb@201 | 748 | self.stream.write("</span>\n") |
paulb@201 | 749 | self.dispatch(node.assign) |
paulb@201 | 750 | self.stream.write("<span class='iterator'>\n") |
paulb@201 | 751 | self._keyword("in") |
paulb@201 | 752 | self._popup( |
paulb@201 | 753 | self._invocations(node._iter_call.active()) |
paulb@201 | 754 | ) |
paulb@201 | 755 | self.stream.write("</span>\n") |
paulb@201 | 756 | self.dispatch(node.list) |
paulb@201 | 757 | for if_ in node.ifs: |
paulb@201 | 758 | self.dispatch(if_) |
paulb@201 | 759 | self.stream.write("</span>\n") |
paulb@201 | 760 | |
paulb@201 | 761 | def visitListCompIf(self, node): |
paulb@201 | 762 | conditional = node._node |
paulb@201 | 763 | conditionals = conditional.active() |
paulb@201 | 764 | self.stream.write("<span class='listcompif'>\n") |
paulb@201 | 765 | self.stream.write("<span class='conditional'>\n") |
paulb@201 | 766 | self._keyword("if") |
paulb@201 | 767 | self._popup( |
paulb@201 | 768 | self._invocations([c.test for c in conditionals]) |
paulb@201 | 769 | ) |
paulb@201 | 770 | self.stream.write("</span>\n") |
paulb@201 | 771 | self.dispatch(node.test) |
paulb@201 | 772 | self.stream.write("</span>\n") |
paulb@201 | 773 | |
paulb@157 | 774 | def visitMod(self, node): |
paulb@157 | 775 | self._visitBinary(node, "mod", "%") |
paulb@157 | 776 | |
paulb@135 | 777 | def visitMul(self, node): |
paulb@135 | 778 | self._visitBinary(node, "mul", "*") |
paulb@135 | 779 | |
paulb@94 | 780 | def visitName(self, node): |
paulb@189 | 781 | target = node._node |
paulb@196 | 782 | targets = target.active() |
paulb@189 | 783 | self._name_start(target.name) |
paulb@201 | 784 | self._popup( |
paulb@201 | 785 | self._scopes(targets) + |
paulb@201 | 786 | self._types(targets) |
paulb@201 | 787 | ) |
paulb@149 | 788 | self._name_end() |
paulb@94 | 789 | |
paulb@127 | 790 | def visitNot(self, node): |
paulb@127 | 791 | self.stream.write("<span class='not'>\n") |
paulb@127 | 792 | self._keyword("not") |
paulb@127 | 793 | self.dispatch(node.expr) |
paulb@127 | 794 | self.stream.write("</span>") |
paulb@127 | 795 | |
paulb@127 | 796 | def visitOr(self, node): |
paulb@127 | 797 | self.stream.write("<span class='or'>\n") |
paulb@127 | 798 | first = 1 |
paulb@127 | 799 | for n in node.nodes: |
paulb@127 | 800 | if not first: |
paulb@127 | 801 | self._keyword("or") |
paulb@127 | 802 | self.dispatch(n) |
paulb@127 | 803 | first = 0 |
paulb@127 | 804 | self.stream.write("</span>") |
paulb@127 | 805 | |
paulb@141 | 806 | def visitPower(self, node): |
paulb@141 | 807 | self._visitBinary(node, "power", "**") |
paulb@141 | 808 | |
paulb@94 | 809 | def visitSlice(self, node): |
paulb@216 | 810 | target = node._node |
paulb@216 | 811 | targets = target.active() |
paulb@94 | 812 | self.stream.write("<span class='slice'>\n") |
paulb@94 | 813 | self.dispatch(node.expr) |
paulb@216 | 814 | self.stream.write("<span class='call'>\n") |
paulb@94 | 815 | self.stream.write("[") |
paulb@216 | 816 | self._popup( |
paulb@216 | 817 | self._invocations(targets) |
paulb@216 | 818 | ) |
paulb@216 | 819 | self.stream.write("</span>\n") |
paulb@94 | 820 | if node.lower: |
paulb@94 | 821 | self.dispatch(node.lower) |
paulb@94 | 822 | self.stream.write(":") |
paulb@94 | 823 | if node.upper: |
paulb@94 | 824 | self.dispatch(node.upper) |
paulb@94 | 825 | # NOTE: Step? |
paulb@94 | 826 | self.stream.write("]") |
paulb@83 | 827 | self.stream.write("</span>\n") |
paulb@94 | 828 | |
paulb@201 | 829 | def visitSliceobj(self, node): |
paulb@201 | 830 | self.stream.write("<span class='sliceobj'>\n") |
paulb@201 | 831 | first = 1 |
paulb@201 | 832 | for n in node.nodes: |
paulb@201 | 833 | if not first: |
paulb@201 | 834 | self.stream.write(":") |
paulb@201 | 835 | self.dispatch(n) |
paulb@201 | 836 | self.stream.write("</span>\n") |
paulb@201 | 837 | |
paulb@135 | 838 | def visitSub(self, node): |
paulb@135 | 839 | self._visitBinary(node, "sub", "-") |
paulb@135 | 840 | |
paulb@94 | 841 | def visitSubscript(self, node): |
paulb@216 | 842 | target = node._node |
paulb@216 | 843 | targets = target.active() |
paulb@94 | 844 | self.stream.write("<span class='subscript'>\n") |
paulb@94 | 845 | self.dispatch(node.expr) |
paulb@216 | 846 | self.stream.write("<span class='call'>\n") |
paulb@94 | 847 | self.stream.write("[") |
paulb@216 | 848 | self._popup( |
paulb@216 | 849 | self._invocations(targets) |
paulb@216 | 850 | ) |
paulb@216 | 851 | self.stream.write("</span>\n") |
paulb@94 | 852 | first = 1 |
paulb@94 | 853 | for sub in node.subs: |
paulb@94 | 854 | if not first: |
paulb@94 | 855 | self.stream.write(", ") |
paulb@94 | 856 | self.dispatch(sub) |
paulb@94 | 857 | first = 0 |
paulb@94 | 858 | self.stream.write("]") |
paulb@83 | 859 | self.stream.write("</span>\n") |
paulb@83 | 860 | |
paulb@94 | 861 | visitTuple = visitAssTuple |
paulb@94 | 862 | |
paulb@136 | 863 | def visitUnaryAdd(self, node): |
paulb@136 | 864 | self._visitUnary(node, "add", "+") |
paulb@136 | 865 | |
paulb@136 | 866 | def visitUnarySub(self, node): |
paulb@136 | 867 | self._visitUnary(node, "sub", "-") |
paulb@136 | 868 | |
paulb@78 | 869 | # Output preparation methods. |
paulb@78 | 870 | |
paulb@78 | 871 | def _text(self, text): |
paulb@78 | 872 | return text.replace("&", "&").replace("<", "<").replace(">", ">") |
paulb@78 | 873 | |
paulb@78 | 874 | def _attr(self, attr): |
paulb@78 | 875 | return self._text(attr).replace("'", "'").replace('"', """) |
paulb@78 | 876 | |
paulb@78 | 877 | def _url(self, url): |
paulb@78 | 878 | return self._attr(url).replace("#", "%23").replace("-", "%2d") |
paulb@78 | 879 | |
paulb@78 | 880 | def _comment(self, comment): |
paulb@78 | 881 | self.stream.write("<span class='comment'># %s</span>\n" % comment) |
paulb@78 | 882 | |
paulb@78 | 883 | def _keyword(self, kw): |
paulb@78 | 884 | self.stream.write("<span class='keyword'>%s</span> " % kw) |
paulb@78 | 885 | |
paulb@79 | 886 | def _doc(self, node): |
paulb@79 | 887 | if node.doc is not None: |
paulb@87 | 888 | self.stream.write("<pre class='doc'>\n") |
paulb@87 | 889 | self.stream.write('"""') |
paulb@87 | 890 | output = textwrap.dedent(node.doc.replace('"""', '\\"\\"\\"')) |
paulb@87 | 891 | self.stream.write(self._text(output)) |
paulb@87 | 892 | self.stream.write('"""') |
paulb@87 | 893 | self.stream.write("</pre>\n") |
paulb@79 | 894 | |
paulb@79 | 895 | def _sequence(self, node): |
paulb@79 | 896 | first = 1 |
paulb@79 | 897 | for n in node.nodes: |
paulb@79 | 898 | if not first: |
paulb@79 | 899 | self.stream.write(",\n") |
paulb@79 | 900 | self.dispatch(n) |
paulb@79 | 901 | first = 0 |
paulb@78 | 902 | |
paulb@189 | 903 | def _mapping(self, node): |
paulb@102 | 904 | first = 1 |
paulb@189 | 905 | for k, v in node.items: |
paulb@102 | 906 | if not first: |
paulb@102 | 907 | self.stream.write(",\n") |
paulb@189 | 908 | self.dispatch(k) |
paulb@189 | 909 | self.stream.write(":\n") |
paulb@189 | 910 | self.dispatch(v) |
paulb@102 | 911 | first = 0 |
paulb@189 | 912 | |
paulb@189 | 913 | def _parameters(self, subprogram, subprograms): |
paulb@189 | 914 | |
paulb@189 | 915 | # Get all the parameter lists. |
paulb@189 | 916 | |
paulb@189 | 917 | params = [] |
paulb@189 | 918 | nparams = 0 |
paulb@189 | 919 | for sub in subprograms: |
paulb@189 | 920 | params.append(sub.params) |
paulb@189 | 921 | nparams = max(nparams, len(sub.params)) |
paulb@189 | 922 | stars = [] |
paulb@189 | 923 | have_star = 0 |
paulb@189 | 924 | for sub in subprograms: |
paulb@189 | 925 | stars.append(sub.star) |
paulb@189 | 926 | if sub.star is not None: |
paulb@189 | 927 | have_star = 1 |
paulb@189 | 928 | dstars = [] |
paulb@189 | 929 | have_dstar = 0 |
paulb@189 | 930 | for sub in subprograms: |
paulb@189 | 931 | dstars.append(sub.dstar) |
paulb@189 | 932 | if sub.dstar is not None: |
paulb@189 | 933 | have_dstar = 1 |
paulb@189 | 934 | |
paulb@189 | 935 | # Traverse the parameter lists, choosing a "column" at a time. |
paulb@189 | 936 | |
paulb@189 | 937 | first = 1 |
paulb@189 | 938 | for n in range(0, nparams): |
paulb@189 | 939 | if not first: |
paulb@189 | 940 | self.stream.write(",\n") |
paulb@189 | 941 | main_param, main_default = subprogram.params[n] |
paulb@189 | 942 | self._name_start(main_param) |
paulb@201 | 943 | self._popup( |
paulb@201 | 944 | self._parameter(subprograms, params, n) |
paulb@201 | 945 | ) |
paulb@189 | 946 | self._name_end() |
paulb@189 | 947 | self._default(main_default) |
paulb@189 | 948 | first = 0 |
paulb@189 | 949 | |
paulb@189 | 950 | if have_star: |
paulb@102 | 951 | if not first: |
paulb@102 | 952 | self.stream.write(", *\n") |
paulb@189 | 953 | main_param, main_default = subprogram.star |
paulb@189 | 954 | self._name_start(main_param) |
paulb@201 | 955 | self._popup( |
paulb@201 | 956 | self._parameter(subprograms, stars) |
paulb@201 | 957 | ) |
paulb@189 | 958 | self._name_end() |
paulb@189 | 959 | self._default(main_default) |
paulb@102 | 960 | first = 0 |
paulb@189 | 961 | |
paulb@189 | 962 | if have_dstar: |
paulb@102 | 963 | if not first: |
paulb@102 | 964 | self.stream.write(", **\n") |
paulb@189 | 965 | main_param, main_default = subprogram.dstar |
paulb@189 | 966 | self._name_start(main_param) |
paulb@201 | 967 | self._popup( |
paulb@201 | 968 | self._parameter(subprograms, dstars) |
paulb@201 | 969 | ) |
paulb@189 | 970 | self._name_end() |
paulb@189 | 971 | self._default(main_default) |
paulb@102 | 972 | first = 0 |
paulb@102 | 973 | |
paulb@197 | 974 | def _parameter(self, subprograms, params, n=None): |
paulb@215 | 975 | types = set() |
paulb@197 | 976 | for i in range(0, len(subprograms)): |
paulb@197 | 977 | subprogram = subprograms[i] |
paulb@197 | 978 | if n is not None: |
paulb@197 | 979 | param, default = params[i][n] |
paulb@197 | 980 | else: |
paulb@197 | 981 | param, default = params[i] |
paulb@197 | 982 | if hasattr(subprogram, "paramtypes"): |
paulb@215 | 983 | types.update(subprogram.paramtypes[param]) |
paulb@201 | 984 | return self._types_container(types, "types") |
paulb@189 | 985 | |
paulb@189 | 986 | def _default(self, default): |
paulb@94 | 987 | if default is not None and default.original is not None: |
paulb@94 | 988 | self.stream.write("=\n") |
paulb@94 | 989 | self.dispatch(default.original) |
paulb@85 | 990 | |
paulb@83 | 991 | def _name(self, name): |
paulb@83 | 992 | self.stream.write("<span class='name'>%s</span>\n" % name) |
paulb@79 | 993 | |
paulb@211 | 994 | def _name_start(self, name, classes=None): |
paulb@211 | 995 | if classes is not None: |
paulb@211 | 996 | classes = " " + classes |
paulb@211 | 997 | else: |
paulb@211 | 998 | classes = "" |
paulb@211 | 999 | self.stream.write("<span class='name%s'>%s\n" % (classes, name)) |
paulb@79 | 1000 | |
paulb@79 | 1001 | def _name_end(self): |
paulb@79 | 1002 | self.stream.write("</span>\n") |
paulb@79 | 1003 | |
paulb@201 | 1004 | def _popup(self, info): |
paulb@201 | 1005 | if info: |
paulb@201 | 1006 | self.stream.write("<span class='popup'>\n") |
paulb@201 | 1007 | for section, subsection, labels in info: |
paulb@201 | 1008 | self.stream.write("<div class='%s'>\n" % section) |
paulb@201 | 1009 | for label in labels: |
paulb@201 | 1010 | self.stream.write("<div class='%s'>\n" % subsection) |
paulb@201 | 1011 | self.stream.write(label) |
paulb@201 | 1012 | self.stream.write("</div>\n") |
paulb@201 | 1013 | self.stream.write("</div>\n") |
paulb@201 | 1014 | self.stream.write("</span>\n") |
paulb@84 | 1015 | |
paulb@192 | 1016 | def _op(self, node): |
paulb@192 | 1017 | if hasattr(node, "_left_call") and hasattr(node, "_right_call"): |
paulb@201 | 1018 | return self._invocations(node._left_call.active() + node._right_call.active()) |
paulb@192 | 1019 | else: |
paulb@192 | 1020 | _node = node._node |
paulb@192 | 1021 | if isinstance(_node, Not): |
paulb@192 | 1022 | _node = _node.expr |
paulb@201 | 1023 | return self._invocations(_node.active()) |
paulb@102 | 1024 | |
paulb@196 | 1025 | def _invocations(self, nodes): |
paulb@196 | 1026 | invocations = [] |
paulb@196 | 1027 | for node in nodes: |
paulb@196 | 1028 | if hasattr(node, "invocations"): |
paulb@196 | 1029 | invocations += node.invocations |
paulb@199 | 1030 | |
paulb@199 | 1031 | # Record each link, avoiding duplicates. |
paulb@199 | 1032 | |
paulb@199 | 1033 | links = {} |
paulb@199 | 1034 | for invocation in invocations: |
paulb@196 | 1035 | fn = getattr(invocation, "copy_of", invocation).full_name() |
paulb@196 | 1036 | module = invocation.module.name |
paulb@196 | 1037 | name = invocation.name |
paulb@196 | 1038 | structures = [x.name for x in invocation.structures] |
paulb@196 | 1039 | qualified_name = ".".join([module] + structures + [name]) |
paulb@199 | 1040 | |
paulb@199 | 1041 | # Record the label and the link texts. |
paulb@199 | 1042 | |
paulb@199 | 1043 | label = self._text(qualified_name) |
paulb@199 | 1044 | link = (self._url(module), self._url(fn)) |
paulb@199 | 1045 | links[label] = link |
paulb@199 | 1046 | |
paulb@199 | 1047 | # Produce the list. |
paulb@199 | 1048 | |
paulb@201 | 1049 | if links: |
paulb@201 | 1050 | popup_labels = [] |
paulb@201 | 1051 | for label, link in links.items(): |
paulb@201 | 1052 | popup_labels.append("<a href='%s.html#%s'>%s</a>" % (link + (label,))) |
paulb@201 | 1053 | else: |
paulb@201 | 1054 | popup_labels = [] |
paulb@201 | 1055 | |
paulb@201 | 1056 | if popup_labels: |
paulb@201 | 1057 | return [("invocations", "invocation", popup_labels)] |
paulb@201 | 1058 | else: |
paulb@201 | 1059 | return [] |
paulb@102 | 1060 | |
paulb@189 | 1061 | def _types(self, nodes): |
paulb@197 | 1062 | all_types = [(getattr(n, "types", []) or flatten(getattr(n, "writes", {}).values())) for n in nodes] |
paulb@197 | 1063 | types = flatten(all_types) |
paulb@201 | 1064 | return self._types_container(types, "types") |
paulb@148 | 1065 | |
paulb@189 | 1066 | def _types_container(self, types, style_class): |
paulb@201 | 1067 | labels = {} |
paulb@83 | 1068 | for type in types: |
paulb@79 | 1069 | fn = type.type.full_name() |
paulb@201 | 1070 | labels[self._text(fn)] = None |
paulb@201 | 1071 | |
paulb@201 | 1072 | if labels: |
paulb@201 | 1073 | return [(style_class, 'type', labels.keys())] |
paulb@201 | 1074 | else: |
paulb@201 | 1075 | return [] |
paulb@189 | 1076 | |
paulb@189 | 1077 | def _raises(self, nodes): |
paulb@189 | 1078 | |
paulb@189 | 1079 | "Output the exception information for the given simplified 'nodes'." |
paulb@189 | 1080 | |
paulb@215 | 1081 | raises = set() |
paulb@189 | 1082 | for node in nodes: |
paulb@195 | 1083 | if hasattr(node, "raises") and node.raises: |
paulb@215 | 1084 | raises.update(node.raises) |
paulb@201 | 1085 | return self._types_container(raises, "raises") |
paulb@79 | 1086 | |
paulb@189 | 1087 | def _scopes(self, nodes): |
paulb@189 | 1088 | |
paulb@189 | 1089 | "Output the scope information for the given simplified 'nodes'." |
paulb@119 | 1090 | |
paulb@201 | 1091 | labels = {} |
paulb@189 | 1092 | for node in nodes: |
paulb@189 | 1093 | |
paulb@201 | 1094 | # Straightforward name loading/storing involves the local scope. |
paulb@171 | 1095 | |
paulb@201 | 1096 | if isinstance(node, StoreName) or isinstance(node, LoadName): |
paulb@201 | 1097 | labels["(local)"] = None |
paulb@171 | 1098 | |
paulb@201 | 1099 | # Other loading/storing involves attributes accessed on modules, classes |
paulb@201 | 1100 | # and objects. |
paulb@171 | 1101 | |
paulb@201 | 1102 | else: |
paulb@171 | 1103 | |
paulb@201 | 1104 | # Loading... |
paulb@171 | 1105 | |
paulb@201 | 1106 | if hasattr(node, "accesses") and node.accesses: |
paulb@201 | 1107 | for ref, accesses in node.accesses.items(): |
paulb@201 | 1108 | fn = ref.full_name() |
paulb@201 | 1109 | for attr, access in accesses: |
paulb@201 | 1110 | access_fn = access.full_name() |
paulb@201 | 1111 | label = self._text(fn) |
paulb@201 | 1112 | if ref != access: |
paulb@201 | 1113 | label += " (via " + self._text(access_fn) + ")" |
paulb@201 | 1114 | labels[label] = None |
paulb@171 | 1115 | |
paulb@201 | 1116 | # Storing... |
paulb@171 | 1117 | |
paulb@201 | 1118 | if hasattr(node, "writes") and node.writes: |
paulb@201 | 1119 | for ref in node.writes.keys(): |
paulb@201 | 1120 | fn = ref.full_name() |
paulb@201 | 1121 | labels[self._text(fn)] = None |
paulb@201 | 1122 | |
paulb@201 | 1123 | # Non-loading... |
paulb@201 | 1124 | |
paulb@201 | 1125 | if hasattr(node, "non_accesses") and node.non_accesses: |
paulb@201 | 1126 | self._types_container(node.non_accesses, "non-accesses") |
paulb@171 | 1127 | |
paulb@201 | 1128 | # Non-storing... |
paulb@171 | 1129 | |
paulb@201 | 1130 | if hasattr(node, "non_writes") and node.non_writes: |
paulb@201 | 1131 | self._types_container(node.non_writes, "non-writes") |
paulb@171 | 1132 | |
paulb@201 | 1133 | if labels: |
paulb@201 | 1134 | return [("scopes", "scope", labels.keys())] |
paulb@201 | 1135 | else: |
paulb@201 | 1136 | return [] |
paulb@78 | 1137 | |
paulb@84 | 1138 | # Utility functions. |
paulb@84 | 1139 | |
paulb@84 | 1140 | def flatten(lists): |
paulb@215 | 1141 | result = set() |
paulb@84 | 1142 | for l in lists: |
paulb@215 | 1143 | result.update(l) |
paulb@84 | 1144 | return result |
paulb@84 | 1145 | |
paulb@57 | 1146 | # Convenience functions. |
paulb@57 | 1147 | |
paulb@78 | 1148 | def browse(module, stream=None): |
paulb@78 | 1149 | browser = Browser(stream or sys.stdout) |
paulb@78 | 1150 | browser.process(module.original) |
paulb@78 | 1151 | |
paulb@78 | 1152 | def makedoc(module, filename): |
paulb@78 | 1153 | stream = open(filename, "wb") |
paulb@78 | 1154 | try: |
paulb@78 | 1155 | browser = Browser(stream) |
paulb@78 | 1156 | browser.process(module.original) |
paulb@78 | 1157 | finally: |
paulb@78 | 1158 | stream.close() |
paulb@78 | 1159 | |
paulb@156 | 1160 | def makedocs(module, modules, builtins): |
paulb@148 | 1161 | dirname = "%s-docs" % module.name |
paulb@148 | 1162 | if not os.path.exists(dirname): |
paulb@148 | 1163 | os.mkdir(dirname) |
paulb@156 | 1164 | for m in [module, builtins] + modules: |
paulb@156 | 1165 | makedoc(m, os.path.join(dirname, "%s%shtml" % (m.name, os.path.extsep))) |
paulb@143 | 1166 | |
paulb@57 | 1167 | # vim: tabstop=4 expandtab shiftwidth=4 |