paul@318 | 1 | #!/usr/bin/env python |
paul@318 | 2 | |
paul@318 | 3 | """ |
paul@318 | 4 | View annotated sources. |
paul@318 | 5 | |
paul@318 | 6 | Copyright (C) 2006, 2007, 2010 Paul Boddie <paul@boddie.org.uk> |
paul@318 | 7 | |
paul@318 | 8 | This program is free software; you can redistribute it and/or modify it under |
paul@318 | 9 | the terms of the GNU General Public License as published by the Free Software |
paul@318 | 10 | Foundation; either version 3 of the License, or (at your option) any later |
paul@318 | 11 | version. |
paul@318 | 12 | |
paul@318 | 13 | This program is distributed in the hope that it will be useful, but WITHOUT |
paul@318 | 14 | ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS |
paul@318 | 15 | FOR A PARTICULAR PURPOSE. See the GNU General Public License for more |
paul@318 | 16 | details. |
paul@318 | 17 | |
paul@318 | 18 | You should have received a copy of the GNU General Public License along with |
paul@318 | 19 | this program. If not, see <http://www.gnu.org/licenses/>. |
paul@318 | 20 | """ |
paul@318 | 21 | |
paul@353 | 22 | from micropython.common import * |
paul@318 | 23 | from micropython.data import * |
paul@353 | 24 | from os.path import exists, extsep, join |
paul@318 | 25 | import sys |
paul@318 | 26 | import os |
paul@318 | 27 | import textwrap |
paul@318 | 28 | |
paul@318 | 29 | # Classes. |
paul@318 | 30 | |
paul@318 | 31 | # HTML-related output production. |
paul@318 | 32 | |
paul@318 | 33 | html_header = """<?xml version="1.0" encoding="iso-8859-15"?> |
paul@318 | 34 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
paul@318 | 35 | <html xmlns="http://www.w3.org/1999/xhtml"> |
paul@318 | 36 | <head> |
paul@353 | 37 | <title>Module: %(full_name)s</title> |
paul@318 | 38 | <style type="text/css"> |
paul@318 | 39 | html { |
paul@318 | 40 | background-color: black; color: white; |
paul@318 | 41 | } |
paul@318 | 42 | |
paul@318 | 43 | body { |
paul@318 | 44 | padding-bottom: 4em; |
paul@318 | 45 | font-size: 14pt; font-family: monospace; |
paul@318 | 46 | background-color: black; color: white; |
paul@318 | 47 | } |
paul@318 | 48 | |
paul@353 | 49 | a { |
paul@353 | 50 | text-decoration: none; |
paul@353 | 51 | } |
paul@353 | 52 | |
paul@318 | 53 | .nowrap { white-space: nowrap; } |
paul@354 | 54 | .label { font-size: smaller; } |
paul@318 | 55 | |
paul@318 | 56 | .class { margin-top: 1em; margin-bottom: 1em; } |
paul@318 | 57 | .function { margin-top: 1em; margin-bottom: 1em; } |
paul@318 | 58 | .body { padding-left: 2em; } |
paul@318 | 59 | .keyword { color: yellow; } |
paul@318 | 60 | .comment { color: blue; } |
paul@318 | 61 | .class-name { color: cyan; } |
paul@318 | 62 | .function-name { color: cyan; } |
paul@318 | 63 | .str { color: #FF00FF; } |
paul@318 | 64 | .doc { color: #FF00FF; margin-top: 1em; margin-bottom: 1em; } |
paul@353 | 65 | |
paul@353 | 66 | .popup { |
paul@353 | 67 | display: none; |
paul@353 | 68 | position: absolute; |
paul@353 | 69 | top: 3ex; left: 0; |
paul@353 | 70 | color: white; |
paul@354 | 71 | border-bottom: 0.5ex solid #000; |
paul@354 | 72 | border-right: 0.5ex solid #000; |
paul@353 | 73 | z-index: 3; |
paul@353 | 74 | } |
paul@353 | 75 | |
paul@354 | 76 | .assname, |
paul@353 | 77 | .name { |
paul@353 | 78 | position: relative; |
paul@354 | 79 | background-color: #300; |
paul@353 | 80 | color: white; |
paul@353 | 81 | } |
paul@353 | 82 | |
paul@354 | 83 | .assname:hover, |
paul@353 | 84 | .name:hover { |
paul@354 | 85 | background-color: #500; |
paul@354 | 86 | padding-top: 0.5ex; |
paul@354 | 87 | padding-bottom: 0.5ex; |
paul@353 | 88 | z-index: 2; |
paul@353 | 89 | } |
paul@353 | 90 | |
paul@354 | 91 | .assname:hover .popup, |
paul@353 | 92 | .name:hover .popup { |
paul@353 | 93 | display: block; |
paul@353 | 94 | } |
paul@318 | 95 | |
paul@354 | 96 | .attrnames, |
paul@354 | 97 | .scope { |
paul@354 | 98 | padding: 0.5em; |
paul@354 | 99 | background-color: #700; |
paul@354 | 100 | } |
paul@354 | 101 | |
paul@318 | 102 | .summary-class { |
paul@354 | 103 | background-color: #040; |
paul@318 | 104 | } |
paul@318 | 105 | |
paul@318 | 106 | .summary-instance { |
paul@354 | 107 | background-color: #00F; |
paul@318 | 108 | } |
paul@318 | 109 | |
paul@318 | 110 | .summary-attr { |
paul@354 | 111 | background-color: #070; |
paul@318 | 112 | } |
paul@318 | 113 | |
paul@318 | 114 | </style> |
paul@318 | 115 | </head> |
paul@318 | 116 | <body> |
paul@318 | 117 | """ |
paul@318 | 118 | |
paul@318 | 119 | html_footer = """</body> |
paul@318 | 120 | </html> |
paul@318 | 121 | """ |
paul@318 | 122 | |
paul@318 | 123 | # Utility classes. |
paul@318 | 124 | |
paul@318 | 125 | class Writer: |
paul@318 | 126 | |
paul@318 | 127 | "A utility class providing useful HTML output methods." |
paul@318 | 128 | |
paul@318 | 129 | # Methods which return strings. |
paul@318 | 130 | |
paul@318 | 131 | def _text(self, text): |
paul@318 | 132 | return text.replace("&", "&").replace("<", "<").replace(">", ">") |
paul@318 | 133 | |
paul@318 | 134 | def _attr(self, attr): |
paul@318 | 135 | return self._text(attr).replace("'", "'").replace('"', """) |
paul@318 | 136 | |
paul@318 | 137 | def _url(self, url): |
paul@318 | 138 | return self._attr(url).replace("#", "%23").replace("-", "%2d") |
paul@318 | 139 | |
paul@318 | 140 | # Methods which write to the stream. |
paul@318 | 141 | |
paul@353 | 142 | def _span_end(self): |
paul@353 | 143 | self.stream.write("</span>") |
paul@353 | 144 | |
paul@318 | 145 | def _comment(self, comment): |
paul@318 | 146 | self.stream.write("<span class='comment'># %s</span>\n" % comment) |
paul@318 | 147 | |
paul@353 | 148 | def _reserved(self, token, classes, leading=0, trailing=1): |
paul@353 | 149 | if leading: |
paul@353 | 150 | self.stream.write(" ") |
paul@353 | 151 | self.stream.write("<span class='%s'>%s</span>" % (classes, self._text(token))) |
paul@353 | 152 | if trailing: |
paul@353 | 153 | self.stream.write(" ") |
paul@353 | 154 | |
paul@353 | 155 | def _keyword(self, kw, leading=0, trailing=1): |
paul@353 | 156 | self._reserved(kw, "keyword", leading, trailing) |
paul@353 | 157 | |
paul@353 | 158 | def _op(self, symbol, leading=0, trailing=1): |
paul@353 | 159 | self._reserved(symbol, "operator", leading, trailing) |
paul@318 | 160 | |
paul@318 | 161 | def _doc(self, node): |
paul@318 | 162 | if node.doc is not None: |
paul@353 | 163 | self.stream.write("<pre class='doc'>") |
paul@318 | 164 | self.stream.write('"""') |
paul@318 | 165 | output = textwrap.dedent(node.doc.replace('"""', '\\"\\"\\"')) |
paul@318 | 166 | self.stream.write(self._text(output)) |
paul@318 | 167 | self.stream.write('"""') |
paul@318 | 168 | self.stream.write("</pre>\n") |
paul@318 | 169 | |
paul@321 | 170 | def _summary_link(self, module_name, full_name, name, classes=None): |
paul@321 | 171 | self._name_link("%s-summary" % module_name, full_name, name, classes) |
paul@320 | 172 | |
paul@321 | 173 | def _object_name_def(self, module, obj, classes=None): |
paul@320 | 174 | |
paul@320 | 175 | """ |
paul@321 | 176 | Link to the summary for 'module' using 'obj'. The optional 'classes' |
paul@321 | 177 | can be used to customise the CSS classes employed. |
paul@320 | 178 | """ |
paul@320 | 179 | |
paul@321 | 180 | self._summary_link(module.full_name(), obj.full_name(), obj.name, classes) |
paul@320 | 181 | |
paul@353 | 182 | def _name_start(self, classes=None): |
paul@353 | 183 | self.stream.write("<span class='%s'>" % (classes or "name")) |
paul@353 | 184 | |
paul@353 | 185 | _name_end = _span_end |
paul@353 | 186 | |
paul@353 | 187 | def _name(self, name, classes=None): |
paul@353 | 188 | self._name_start(classes) |
paul@353 | 189 | self.stream.write(name) |
paul@353 | 190 | self._name_end() |
paul@353 | 191 | |
paul@353 | 192 | def _name_link(self, module_name, full_name, name, classes=None): |
paul@353 | 193 | self.stream.write("<a class='%s' href='%s%sxhtml#%s'>%s</a>" % ( |
paul@353 | 194 | classes or "name", module_name, os.path.extsep, |
paul@353 | 195 | self._attr(full_name), self._text(name))) |
paul@353 | 196 | |
paul@353 | 197 | def _popup_start(self): |
paul@353 | 198 | self.stream.write("<span class='popup'>") |
paul@353 | 199 | |
paul@353 | 200 | _popup_end = _span_end |
paul@353 | 201 | |
paul@353 | 202 | def _scope(self, scope): |
paul@354 | 203 | self.stream.write("<div class='scope'><span class='label'>scope</span><br />%s</div>\n" % scope) |
paul@354 | 204 | |
paul@354 | 205 | def _assname(self, name, node): |
paul@354 | 206 | self.stream.write("<span class='assname'>") |
paul@354 | 207 | if hasattr(node, "_attrnames"): |
paul@354 | 208 | attrnames = node._attrnames |
paul@354 | 209 | self._name_start() |
paul@354 | 210 | self.stream.write(name) |
paul@354 | 211 | self._popup_start() |
paul@354 | 212 | self._attrnames(attrnames[name]) |
paul@354 | 213 | self._popup_end() |
paul@354 | 214 | self._name_end() |
paul@354 | 215 | else: |
paul@354 | 216 | self._name(node.name) |
paul@354 | 217 | self.stream.write("</span>") |
paul@354 | 218 | |
paul@354 | 219 | def _attrnames(self, attrnames): |
paul@354 | 220 | if not attrnames: |
paul@354 | 221 | return |
paul@354 | 222 | |
paul@354 | 223 | self.stream.write("<div class='attrnames'><span class='label'>attributes</span><br />") |
paul@354 | 224 | first = 1 |
paul@354 | 225 | for attrname in attrnames: |
paul@354 | 226 | if not first: |
paul@354 | 227 | self.stream.write("<br />") |
paul@354 | 228 | self.stream.write(attrname) |
paul@354 | 229 | first = 0 |
paul@354 | 230 | self.stream.write("</div>\n") |
paul@353 | 231 | |
paul@318 | 232 | # Summary classes. |
paul@318 | 233 | |
paul@320 | 234 | class Summary(Writer): |
paul@318 | 235 | |
paul@319 | 236 | "Summarise classes and attributes in modules." |
paul@319 | 237 | |
paul@319 | 238 | def __init__(self, module): |
paul@319 | 239 | self.module = module |
paul@318 | 240 | |
paul@319 | 241 | def to_stream(self, stream): |
paul@319 | 242 | |
paul@319 | 243 | "Write the summary to the given 'stream'." |
paul@319 | 244 | |
paul@319 | 245 | self.stream = stream |
paul@318 | 246 | self._init_details() |
paul@353 | 247 | self.stream.write(html_header % {"full_name" : self.module.full_name()}) |
paul@319 | 248 | self._write_classes(self.module) |
paul@318 | 249 | self.stream.write(html_footer) |
paul@318 | 250 | |
paul@318 | 251 | def _write_classes(self, module): |
paul@318 | 252 | self.stream.write("<table cellspacing='5' cellpadding='5'>\n") |
paul@318 | 253 | |
paul@318 | 254 | all_classes = {} |
paul@318 | 255 | |
paul@318 | 256 | for obj in self.module.all_objects: |
paul@318 | 257 | if isinstance(obj, Class): |
paul@318 | 258 | all_classes[obj.name] = obj |
paul@318 | 259 | |
paul@318 | 260 | all_class_names = all_classes.keys() |
paul@318 | 261 | all_class_names.sort() |
paul@318 | 262 | |
paul@318 | 263 | for name in all_class_names: |
paul@318 | 264 | self._write_class(all_classes[name]) |
paul@318 | 265 | |
paul@318 | 266 | self.stream.write("</table>\n") |
paul@318 | 267 | |
paul@318 | 268 | def _write_class(self, obj): |
paul@318 | 269 | |
paul@318 | 270 | # Write the class... |
paul@318 | 271 | |
paul@318 | 272 | self.stream.write("<tbody class='class'>\n") |
paul@318 | 273 | self.stream.write("<tr>\n") |
paul@318 | 274 | self.stream.write("<th class='summary-class' id='%s'>\n" % obj.full_name()) |
paul@318 | 275 | self._keyword("class") |
paul@318 | 276 | self.stream.write(obj.name) |
paul@318 | 277 | self.stream.write("</th>\n") |
paul@318 | 278 | |
paul@318 | 279 | # ...and all known attribute names. |
paul@318 | 280 | |
paul@318 | 281 | obj_attributes = obj.all_attribute_names() |
paul@318 | 282 | |
paul@318 | 283 | for name in self.attribute_names: |
paul@318 | 284 | if name in obj_attributes: |
paul@318 | 285 | self.stream.write("<th class='summary-attr'>%s</th>\n" % self._text(name)) |
paul@318 | 286 | else: |
paul@318 | 287 | self.stream.write("<th></th>\n") |
paul@318 | 288 | self.stream.write("</tr>\n") |
paul@318 | 289 | |
paul@318 | 290 | self.stream.write("</tbody>\n") |
paul@318 | 291 | |
paul@318 | 292 | def _init_details(self): |
paul@318 | 293 | names = set() |
paul@318 | 294 | |
paul@318 | 295 | # Visit all classes. |
paul@318 | 296 | |
paul@318 | 297 | for obj in self.module.all_objects: |
paul@318 | 298 | if isinstance(obj, Class): |
paul@318 | 299 | names.update(obj.all_attribute_names()) |
paul@318 | 300 | |
paul@318 | 301 | self.attribute_names = list(names) |
paul@318 | 302 | self.attribute_names.sort() |
paul@318 | 303 | |
paul@320 | 304 | # Source code classes. |
paul@320 | 305 | |
paul@320 | 306 | class AnnotatedSource(ASTVisitor, Writer): |
paul@320 | 307 | |
paul@320 | 308 | "A module source code browser." |
paul@320 | 309 | |
paul@320 | 310 | def __init__(self, module): |
paul@320 | 311 | ASTVisitor.__init__(self) |
paul@320 | 312 | self.visitor = self |
paul@320 | 313 | self.module = module |
paul@320 | 314 | |
paul@320 | 315 | def to_stream(self, stream): |
paul@320 | 316 | |
paul@320 | 317 | "Write the annotated code to the given 'stream'." |
paul@320 | 318 | |
paul@320 | 319 | self.stream = stream |
paul@353 | 320 | self.stream.write(html_header % {"full_name" : self.module.full_name()}) |
paul@353 | 321 | self.dispatch(self.module.astnode) |
paul@320 | 322 | self.stream.write(html_footer) |
paul@320 | 323 | |
paul@320 | 324 | def visitModule(self, node): |
paul@320 | 325 | self.default(node) |
paul@320 | 326 | |
paul@320 | 327 | # Statements. |
paul@320 | 328 | |
paul@320 | 329 | def visitAssert(self, node): |
paul@320 | 330 | self.stream.write("<div class='assert nowrap'>\n") |
paul@320 | 331 | self._keyword("assert") |
paul@320 | 332 | self.dispatch(node.test) |
paul@320 | 333 | if node.fail: |
paul@320 | 334 | self.stream.write(", ") |
paul@320 | 335 | self.dispatch(node.fail) |
paul@320 | 336 | self.stream.write("</div>\n") |
paul@320 | 337 | |
paul@320 | 338 | def visitAssign(self, node): |
paul@320 | 339 | self.stream.write("<div class='assign nowrap'>\n") |
paul@320 | 340 | for lvalue in node.nodes: |
paul@320 | 341 | self.dispatch(lvalue) |
paul@353 | 342 | self.stream.write(" = ") |
paul@320 | 343 | self.dispatch(node.expr) |
paul@320 | 344 | self.stream.write("</div>\n") |
paul@320 | 345 | |
paul@320 | 346 | def visitAugAssign(self, node): |
paul@320 | 347 | self.stream.write("<div class='augassign nowrap'>\n") |
paul@320 | 348 | self.dispatch(node.node) |
paul@353 | 349 | self.stream.write(" %s " % node.op) |
paul@320 | 350 | self.dispatch(node.expr) |
paul@320 | 351 | self.stream.write("</div>\n") |
paul@320 | 352 | |
paul@320 | 353 | def visitBreak(self, node): |
paul@320 | 354 | self.stream.write("<div class='break nowrap'>\n") |
paul@320 | 355 | self._keyword("break") |
paul@320 | 356 | self.stream.write("</div>\n") |
paul@320 | 357 | |
paul@320 | 358 | def visitClass(self, node): |
paul@353 | 359 | if not used_by_unit(node): |
paul@353 | 360 | return |
paul@320 | 361 | |
paul@320 | 362 | # Use inspected details where possible. |
paul@320 | 363 | |
paul@354 | 364 | if hasattr(node, "unit"): |
paul@354 | 365 | cls = node.unit |
paul@320 | 366 | bases = cls.bases |
paul@320 | 367 | self.stream.write("<div class='class nowrap' id='%s'>\n" % cls.full_name()) |
paul@320 | 368 | else: |
paul@320 | 369 | print "Warning: class %s not recognised!" % node.name |
paul@320 | 370 | return |
paul@320 | 371 | |
paul@320 | 372 | # Write the declaration line. |
paul@320 | 373 | |
paul@320 | 374 | self.stream.write("<div>\n") |
paul@320 | 375 | self._keyword("class") |
paul@321 | 376 | self._object_name_def(self.module, cls, "class-name") |
paul@320 | 377 | |
paul@320 | 378 | # Suppress the "object" class appearing alone. |
paul@320 | 379 | |
paul@320 | 380 | if bases and not (len(bases) == 1 and bases[0].name == "object"): |
paul@320 | 381 | self.stream.write("(") |
paul@320 | 382 | first = 1 |
paul@320 | 383 | for base in bases: |
paul@320 | 384 | if not first: |
paul@321 | 385 | self.stream.write(", ") |
paul@320 | 386 | |
paul@320 | 387 | self._object_name_def(base.module, base) |
paul@320 | 388 | |
paul@320 | 389 | first = 0 |
paul@320 | 390 | self.stream.write(")") |
paul@320 | 391 | |
paul@320 | 392 | self.stream.write(":\n") |
paul@320 | 393 | self.stream.write("</div>\n") |
paul@320 | 394 | |
paul@320 | 395 | # Write the docstring and class body. |
paul@320 | 396 | |
paul@320 | 397 | self.stream.write("<div class='body nowrap'>\n") |
paul@320 | 398 | self._doc(node) |
paul@320 | 399 | self.dispatch(node.code) |
paul@320 | 400 | self.stream.write("</div>\n") |
paul@320 | 401 | self.stream.write("</div>\n") |
paul@320 | 402 | |
paul@320 | 403 | def visitContinue(self, node): |
paul@320 | 404 | self.stream.write("<div class='continue nowrap'>\n") |
paul@320 | 405 | self._keyword("continue") |
paul@320 | 406 | self.stream.write("</div>\n") |
paul@320 | 407 | |
paul@320 | 408 | def visitDiscard(self, node): |
paul@320 | 409 | self.stream.write("<div class='discard nowrap'>\n") |
paul@320 | 410 | self.default(node) |
paul@320 | 411 | self.stream.write("</div>\n") |
paul@320 | 412 | |
paul@320 | 413 | def visitFor(self, node): |
paul@320 | 414 | self.stream.write("<div class='if nowrap'>\n") |
paul@320 | 415 | self.stream.write("<div>\n") |
paul@320 | 416 | self._keyword("for") |
paul@320 | 417 | self.dispatch(node.assign) |
paul@353 | 418 | self._keyword("in", 1) |
paul@320 | 419 | self.dispatch(node.list) |
paul@320 | 420 | self.stream.write(":\n") |
paul@320 | 421 | self.stream.write("</div>\n") |
paul@320 | 422 | self.stream.write("<div class='body nowrap'>\n") |
paul@320 | 423 | self.dispatch(node.body) |
paul@320 | 424 | self.stream.write("</div>\n") |
paul@320 | 425 | if node.else_ is not None: |
paul@320 | 426 | self.stream.write("<div>\n") |
paul@353 | 427 | self._keyword("else", trailing=0) |
paul@320 | 428 | self.stream.write(":\n") |
paul@320 | 429 | self.stream.write("</div>\n") |
paul@320 | 430 | self.stream.write("<div class='body nowrap'>\n") |
paul@320 | 431 | self.dispatch(node.else_) |
paul@320 | 432 | self.stream.write("</div>\n") |
paul@320 | 433 | self.stream.write("</div>\n") |
paul@320 | 434 | |
paul@320 | 435 | def visitFrom(self, node): |
paul@320 | 436 | self.stream.write("<div class='from nowrap'>\n") |
paul@320 | 437 | self._keyword("from") |
paul@320 | 438 | self._name(node.modname) |
paul@353 | 439 | self._keyword("import", 1) |
paul@320 | 440 | first = 1 |
paul@320 | 441 | for (name, alias), _name in map(None, node.names, node._names): |
paul@320 | 442 | if not first: |
paul@321 | 443 | self.stream.write(", ") |
paul@320 | 444 | if alias: |
paul@320 | 445 | self.stream.write(name + " ") |
paul@353 | 446 | self._keyword("as", 1) |
paul@320 | 447 | self._name(alias or name) |
paul@320 | 448 | first = 0 |
paul@320 | 449 | self.stream.write("</div>\n") |
paul@320 | 450 | |
paul@320 | 451 | def visitFunction(self, node): |
paul@353 | 452 | if not used_by_unit(node): |
paul@353 | 453 | return |
paul@353 | 454 | |
paul@354 | 455 | if hasattr(node, "unit"): |
paul@354 | 456 | fn = node.unit |
paul@320 | 457 | self.stream.write("<div class='function nowrap' id='%s'>\n" % fn.full_name()) |
paul@320 | 458 | else: |
paul@320 | 459 | print "Warning: function %s not recognised!" % node.name |
paul@320 | 460 | return |
paul@320 | 461 | |
paul@320 | 462 | # Write the declaration line. |
paul@320 | 463 | |
paul@320 | 464 | self.stream.write("<div>\n") |
paul@320 | 465 | self._keyword("def") |
paul@321 | 466 | self._object_name_def(self.module, fn, "function-name") |
paul@320 | 467 | |
paul@320 | 468 | self.stream.write("(") |
paul@354 | 469 | self._parameters(fn, node) |
paul@320 | 470 | self.stream.write(")") |
paul@320 | 471 | self.stream.write(":\n") |
paul@320 | 472 | self.stream.write("</div>\n") |
paul@320 | 473 | |
paul@320 | 474 | self.stream.write("<div class='body nowrap'>\n") |
paul@320 | 475 | self._doc(node) |
paul@320 | 476 | self.dispatch(node.code) |
paul@320 | 477 | self.stream.write("</div>\n") |
paul@320 | 478 | self.stream.write("</div>\n") |
paul@320 | 479 | |
paul@320 | 480 | def visitGlobal(self, node): |
paul@320 | 481 | self.stream.write("<div class='global nowrap'>\n") |
paul@320 | 482 | self._keyword("global") |
paul@320 | 483 | first = 1 |
paul@320 | 484 | for name in node.names: |
paul@320 | 485 | if not first: |
paul@321 | 486 | self.stream.write(", ") |
paul@320 | 487 | self.stream.write(name) |
paul@320 | 488 | first = 0 |
paul@320 | 489 | self.stream.write("</div>\n") |
paul@320 | 490 | |
paul@320 | 491 | def visitIf(self, node): |
paul@320 | 492 | self.stream.write("<div class='if nowrap'>\n") |
paul@320 | 493 | first = 1 |
paul@320 | 494 | for compare, stmt in node.tests: |
paul@320 | 495 | self.stream.write("<div>\n") |
paul@320 | 496 | if first: |
paul@320 | 497 | self._keyword("if") |
paul@320 | 498 | else: |
paul@320 | 499 | self._keyword("elif") |
paul@320 | 500 | self.dispatch(compare) |
paul@320 | 501 | self.stream.write(":\n") |
paul@320 | 502 | self.stream.write("</div>\n") |
paul@320 | 503 | self.stream.write("<div class='body nowrap'>\n") |
paul@320 | 504 | self.dispatch(stmt) |
paul@320 | 505 | self.stream.write("</div>\n") |
paul@320 | 506 | first = 0 |
paul@320 | 507 | if node.else_ is not None: |
paul@320 | 508 | self.stream.write("<div>\n") |
paul@353 | 509 | self._keyword("else", trailing=0) |
paul@353 | 510 | self.stream.write(":\n") |
paul@353 | 511 | self.stream.write("</div>\n") |
paul@353 | 512 | self.stream.write("<div class='body nowrap'>\n") |
paul@353 | 513 | self.dispatch(node.else_) |
paul@353 | 514 | self.stream.write("</div>\n") |
paul@353 | 515 | self.stream.write("</div>\n") |
paul@353 | 516 | |
paul@353 | 517 | def visitImport(self, node): |
paul@353 | 518 | self.stream.write("<div class='import nowrap'>\n") |
paul@353 | 519 | self._keyword("import") |
paul@353 | 520 | first = 1 |
paul@353 | 521 | for name, alias in node.names: |
paul@353 | 522 | if not first: |
paul@353 | 523 | self.stream.write(",\n") |
paul@353 | 524 | if alias: |
paul@353 | 525 | self.stream.write(name + " ") |
paul@353 | 526 | self._keyword("as", 1) |
paul@353 | 527 | self._name(alias or name) |
paul@353 | 528 | first = 0 |
paul@353 | 529 | self.stream.write("</div>\n") |
paul@353 | 530 | |
paul@353 | 531 | def visitPass(self, node): |
paul@353 | 532 | self.stream.write("<div class='pass nowrap'>\n") |
paul@353 | 533 | self._keyword("pass") |
paul@353 | 534 | self.stream.write("</div>\n") |
paul@353 | 535 | |
paul@353 | 536 | def visitPrint(self, node): |
paul@353 | 537 | self.stream.write("<div class='print nowrap'>\n") |
paul@353 | 538 | self._keyword("print") |
paul@353 | 539 | if node.dest is not None: |
paul@353 | 540 | self.stream.write(">>\n") |
paul@353 | 541 | self.dispatch(node.dest) |
paul@353 | 542 | for n in node.nodes: |
paul@353 | 543 | self.dispatch(n) |
paul@353 | 544 | self.stream.write(",\n") |
paul@353 | 545 | self.stream.write("</div>\n") |
paul@353 | 546 | |
paul@353 | 547 | def visitPrintnl(self, node): |
paul@353 | 548 | self.stream.write("<div class='printnl nowrap'>\n") |
paul@353 | 549 | self._keyword("print") |
paul@353 | 550 | if node.dest is not None: |
paul@353 | 551 | self.stream.write(">>\n") |
paul@353 | 552 | self.dispatch(node.dest) |
paul@353 | 553 | first = 1 |
paul@353 | 554 | for n in node.nodes: |
paul@353 | 555 | if not first: |
paul@353 | 556 | self.stream.write(",\n") |
paul@353 | 557 | self.dispatch(n) |
paul@353 | 558 | first = 0 |
paul@353 | 559 | self.stream.write("</div>\n") |
paul@353 | 560 | |
paul@353 | 561 | def visitRaise(self, node): |
paul@353 | 562 | self.stream.write("<div class='raise nowrap'>\n") |
paul@353 | 563 | self._keyword("raise") |
paul@353 | 564 | self.dispatch(node.expr1) |
paul@353 | 565 | if node.expr2 is not None: |
paul@353 | 566 | self.stream.write(",\n") |
paul@353 | 567 | self.dispatch(node.expr2) |
paul@353 | 568 | if node.expr3 is not None: |
paul@353 | 569 | self.stream.write(",\n") |
paul@353 | 570 | self.dispatch(node.expr3) |
paul@353 | 571 | self.stream.write("</div>\n") |
paul@353 | 572 | |
paul@353 | 573 | def visitReturn(self, node): |
paul@353 | 574 | self.stream.write("<div class='return nowrap'>\n") |
paul@353 | 575 | self._keyword("return") |
paul@353 | 576 | self.dispatch(node.value) |
paul@353 | 577 | self.stream.write("</div>\n") |
paul@353 | 578 | |
paul@353 | 579 | def visitStmt(self, node): |
paul@353 | 580 | self.stream.write("<div class='stmt nowrap'>\n") |
paul@353 | 581 | self.default(node) |
paul@353 | 582 | self.stream.write("</div>\n") |
paul@353 | 583 | |
paul@353 | 584 | def visitTryExcept(self, node): |
paul@353 | 585 | self.stream.write("<div class='tryexcept nowrap'>\n") |
paul@353 | 586 | self.stream.write("<div>\n") |
paul@353 | 587 | self._keyword("try", trailing=0) |
paul@353 | 588 | self.stream.write(":\n") |
paul@353 | 589 | self.stream.write("</div>\n") |
paul@353 | 590 | self.stream.write("<div class='body nowrap'>\n") |
paul@353 | 591 | self.dispatch(node.body) |
paul@353 | 592 | self.stream.write("</div>\n") |
paul@353 | 593 | for spec, assign, statement in node.handlers: |
paul@353 | 594 | self.stream.write("<div>\n") |
paul@353 | 595 | self._keyword("except") |
paul@353 | 596 | if spec is not None: |
paul@353 | 597 | self.dispatch(spec) |
paul@353 | 598 | if assign is not None: |
paul@353 | 599 | self.stream.write(",\n") |
paul@353 | 600 | self.dispatch(assign) |
paul@353 | 601 | self.stream.write(":\n") |
paul@353 | 602 | self.stream.write("</div>\n") |
paul@353 | 603 | self.stream.write("<div class='body nowrap'>\n") |
paul@353 | 604 | self.dispatch(statement) |
paul@353 | 605 | self.stream.write("</div>\n") |
paul@353 | 606 | if node.else_ is not None: |
paul@353 | 607 | self.stream.write("<div>\n") |
paul@353 | 608 | self._keyword("else", trailing=0) |
paul@353 | 609 | self.stream.write(":\n") |
paul@353 | 610 | self.stream.write("</div>\n") |
paul@353 | 611 | self.stream.write("<div class='body nowrap'>\n") |
paul@353 | 612 | self.dispatch(node.else_) |
paul@353 | 613 | self.stream.write("</div>\n") |
paul@353 | 614 | self.stream.write("</div>\n") |
paul@353 | 615 | |
paul@353 | 616 | def visitTryFinally(self, node): |
paul@353 | 617 | self.stream.write("<div class='tryfinally nowrap'>\n") |
paul@353 | 618 | self.stream.write("<div>\n") |
paul@353 | 619 | self._keyword("try", trailing=0) |
paul@353 | 620 | self.stream.write(":\n") |
paul@353 | 621 | self.stream.write("</div>\n") |
paul@353 | 622 | self.stream.write("<div class='body nowrap'>\n") |
paul@353 | 623 | self.dispatch(node.body) |
paul@353 | 624 | self.stream.write("</div>\n") |
paul@353 | 625 | self.stream.write("<div>\n") |
paul@353 | 626 | self._keyword("finally", trailing=0) |
paul@353 | 627 | self.stream.write(":\n") |
paul@353 | 628 | self.stream.write("</div>\n") |
paul@353 | 629 | self.stream.write("<div class='body nowrap'>\n") |
paul@353 | 630 | self.dispatch(node.final) |
paul@353 | 631 | self.stream.write("</div>\n") |
paul@353 | 632 | self.stream.write("</div>\n") |
paul@353 | 633 | |
paul@353 | 634 | def visitWhile(self, node): |
paul@353 | 635 | self.stream.write("<div class='while nowrap'>\n") |
paul@353 | 636 | self.stream.write("<div>\n") |
paul@353 | 637 | self._keyword("while") |
paul@353 | 638 | self.dispatch(node.test) |
paul@353 | 639 | self.stream.write(":\n") |
paul@353 | 640 | self.stream.write("</div>\n") |
paul@353 | 641 | self.stream.write("<div class='body nowrap'>\n") |
paul@353 | 642 | self.dispatch(node.body) |
paul@353 | 643 | self.stream.write("</div>\n") |
paul@353 | 644 | if node.else_ is not None: |
paul@353 | 645 | self.stream.write("<div>\n") |
paul@353 | 646 | self._keyword("else", trailing=0) |
paul@320 | 647 | self.stream.write(":\n") |
paul@320 | 648 | self.stream.write("</div>\n") |
paul@320 | 649 | self.stream.write("<div class='body nowrap'>\n") |
paul@320 | 650 | self.dispatch(node.else_) |
paul@320 | 651 | self.stream.write("</div>\n") |
paul@320 | 652 | self.stream.write("</div>\n") |
paul@320 | 653 | |
paul@353 | 654 | # Expression-related helper methods. |
paul@353 | 655 | |
paul@353 | 656 | def _visitBitBinary(self, node, name, symbol): |
paul@353 | 657 | self.stream.write("<span class='%s'>" % name) |
paul@353 | 658 | first = 1 |
paul@353 | 659 | for node in node.nodes: |
paul@353 | 660 | if not first: |
paul@353 | 661 | self._op(symbol, 1) |
paul@353 | 662 | self.dispatch(node) |
paul@353 | 663 | first = 0 |
paul@353 | 664 | self.stream.write("</span>") |
paul@353 | 665 | |
paul@353 | 666 | def _visitBinary(self, node, name, symbol): |
paul@353 | 667 | self.stream.write("<span class='%s'>" % name) |
paul@353 | 668 | self.dispatch(node.left) |
paul@353 | 669 | self._op(symbol, 1) |
paul@353 | 670 | self.dispatch(node.right) |
paul@353 | 671 | self.stream.write("</span>") |
paul@353 | 672 | |
paul@353 | 673 | def _visitUnary(self, node, name, symbol): |
paul@353 | 674 | self.stream.write("<span class='%s'>" % name) |
paul@353 | 675 | self._op(symbol) |
paul@353 | 676 | self.dispatch(node.expr) |
paul@353 | 677 | self.stream.write("</span>") |
paul@353 | 678 | |
paul@353 | 679 | # Expressions. |
paul@353 | 680 | |
paul@353 | 681 | def visitAdd(self, node): |
paul@353 | 682 | self._visitBinary(node, "add", "+") |
paul@353 | 683 | |
paul@353 | 684 | def visitAnd(self, node): |
paul@353 | 685 | self.stream.write("<span class='and'>") |
paul@353 | 686 | first = 1 |
paul@353 | 687 | for n in node.nodes: |
paul@353 | 688 | if not first: |
paul@353 | 689 | self._keyword("and", 1) |
paul@353 | 690 | self.dispatch(n) |
paul@353 | 691 | first = 0 |
paul@353 | 692 | self.stream.write("</span>") |
paul@353 | 693 | |
paul@353 | 694 | def visitAssAttr(self, node): |
paul@353 | 695 | self.stream.write("<span class='assattr'>") |
paul@353 | 696 | self.dispatch(node.expr) |
paul@353 | 697 | self.stream.write("<span class='attr'>") |
paul@353 | 698 | self.stream.write(".") |
paul@353 | 699 | self._name(node.attrname) |
paul@353 | 700 | self.stream.write("</span>") |
paul@353 | 701 | self.stream.write("</span>") |
paul@353 | 702 | |
paul@353 | 703 | def visitAssList(self, node): |
paul@353 | 704 | self.stream.write("<span class='list'>") |
paul@353 | 705 | self.stream.write("[") |
paul@353 | 706 | self._sequence(node) |
paul@353 | 707 | self.stream.write("]") |
paul@353 | 708 | self.stream.write("</span>") |
paul@353 | 709 | |
paul@353 | 710 | def visitAssName(self, node): |
paul@354 | 711 | self._assname(node.name, node) |
paul@353 | 712 | |
paul@353 | 713 | def visitAssTuple(self, node): |
paul@353 | 714 | self.stream.write("<span class='tuple'>") |
paul@353 | 715 | self.stream.write("(") |
paul@353 | 716 | self._sequence(node) |
paul@353 | 717 | self.stream.write(")") |
paul@353 | 718 | self.stream.write("</span>") |
paul@353 | 719 | |
paul@353 | 720 | def visitBitand(self, node): |
paul@353 | 721 | self._visitBitBinary(node, "bitand", "&") |
paul@353 | 722 | |
paul@353 | 723 | def visitCallFunc(self, node): |
paul@353 | 724 | self.stream.write("<span class='callfunc'>") |
paul@353 | 725 | self.dispatch(node.node) |
paul@353 | 726 | self.stream.write("<span class='call'>") |
paul@353 | 727 | self.stream.write("(") |
paul@353 | 728 | first = 1 |
paul@353 | 729 | for arg in node.args: |
paul@353 | 730 | if not first: |
paul@353 | 731 | self.stream.write(", ") |
paul@353 | 732 | self.dispatch(arg) |
paul@353 | 733 | first = 0 |
paul@353 | 734 | if node.star_args is not None: |
paul@353 | 735 | if not first: |
paul@353 | 736 | self.stream.write(", *") |
paul@353 | 737 | self.dispatch(node.star_args) |
paul@353 | 738 | first = 0 |
paul@353 | 739 | if node.dstar_args is not None: |
paul@353 | 740 | if not first: |
paul@353 | 741 | self.stream.write(", **") |
paul@353 | 742 | self.dispatch(node.dstar_args) |
paul@353 | 743 | first = 0 |
paul@353 | 744 | self.stream.write(")") |
paul@353 | 745 | self.stream.write("</span>") |
paul@353 | 746 | self.stream.write("</span>") |
paul@353 | 747 | |
paul@353 | 748 | def visitCompare(self, node): |
paul@353 | 749 | self.stream.write("<span class='compare'>") |
paul@353 | 750 | self.dispatch(node.expr) |
paul@353 | 751 | for op_name, expr in node.ops: |
paul@353 | 752 | self._op(op_name, 1) |
paul@353 | 753 | self.dispatch(expr) |
paul@353 | 754 | self.stream.write("</span>") |
paul@353 | 755 | |
paul@353 | 756 | def visitConst(self, node): |
paul@353 | 757 | if isinstance(node.value, (str, unicode)): |
paul@353 | 758 | self.stream.write("<span class='str'>") |
paul@353 | 759 | self.stream.write(self._text(repr(node.value))) |
paul@353 | 760 | if isinstance(node.value, (str, unicode)): |
paul@353 | 761 | self.stream.write("</span>") |
paul@353 | 762 | |
paul@353 | 763 | def visitDict(self, node): |
paul@353 | 764 | self.stream.write("<span class='dict'>") |
paul@353 | 765 | self.stream.write("{") |
paul@353 | 766 | self._mapping(node) |
paul@353 | 767 | self.stream.write("}") |
paul@353 | 768 | self.stream.write("</span>") |
paul@353 | 769 | |
paul@353 | 770 | def visitDiv(self, node): |
paul@353 | 771 | self._visitBinary(node, "div", "/") |
paul@353 | 772 | |
paul@353 | 773 | def visitFloorDiv(self, node): |
paul@353 | 774 | self._visitBinary(node, "floordiv", "//") |
paul@353 | 775 | |
paul@353 | 776 | def visitGetattr(self, node): |
paul@353 | 777 | self.stream.write("<span class='getattr'>") |
paul@353 | 778 | self.dispatch(node.expr) |
paul@353 | 779 | self.stream.write("<span class='attr'>") |
paul@353 | 780 | self.stream.write(".") |
paul@353 | 781 | self._name(node.attrname) |
paul@353 | 782 | self.stream.write("</span>") |
paul@353 | 783 | self.stream.write("</span>") |
paul@353 | 784 | |
paul@353 | 785 | def visitKeyword(self, node): |
paul@353 | 786 | self.stream.write("<span class='keyword-arg'>") |
paul@353 | 787 | self.stream.write(node.name) |
paul@353 | 788 | self.stream.write("=") |
paul@353 | 789 | self.dispatch(node.expr) |
paul@353 | 790 | self.stream.write("</span>") |
paul@353 | 791 | |
paul@353 | 792 | def visitLambda(self, node): |
paul@354 | 793 | if hasattr(node, "unit"): |
paul@354 | 794 | fn = node.unit |
paul@353 | 795 | else: |
paul@353 | 796 | print "Warning: function %s not recognised!" % node.name |
paul@353 | 797 | return |
paul@353 | 798 | |
paul@353 | 799 | self.stream.write("<span class='lambda'>") |
paul@353 | 800 | self._keyword("lambda") |
paul@354 | 801 | self._parameters(fn, node) |
paul@353 | 802 | self.stream.write(": <span class='code'>") |
paul@353 | 803 | self.dispatch(node.code) |
paul@353 | 804 | self.stream.write("</span>") |
paul@353 | 805 | self.stream.write("</span>") |
paul@353 | 806 | |
paul@353 | 807 | visitList = visitAssList |
paul@353 | 808 | |
paul@353 | 809 | def visitListComp(self, node): |
paul@353 | 810 | self.stream.write("<span class='listcomp'>") |
paul@353 | 811 | self.stream.write("[") |
paul@353 | 812 | self.dispatch(node.expr) |
paul@353 | 813 | for qual in node.quals: |
paul@353 | 814 | self.dispatch(qual) |
paul@353 | 815 | self.stream.write("]") |
paul@353 | 816 | self.stream.write("</span>") |
paul@353 | 817 | |
paul@353 | 818 | def visitListCompFor(self, node): |
paul@353 | 819 | self.stream.write("<span class='listcompfor'>") |
paul@353 | 820 | self._keyword("for") |
paul@353 | 821 | self.stream.write("<span class='iterator'>") |
paul@353 | 822 | self.dispatch(node.assign) |
paul@353 | 823 | self.stream.write("</span>") |
paul@353 | 824 | self._keyword("in", 1) |
paul@353 | 825 | self.stream.write("<span class='collection'>") |
paul@353 | 826 | self.dispatch(node.list) |
paul@353 | 827 | self.stream.write("</span>") |
paul@353 | 828 | for if_ in node.ifs: |
paul@353 | 829 | self.dispatch(if_) |
paul@353 | 830 | self.stream.write("</span>") |
paul@353 | 831 | |
paul@353 | 832 | def visitListCompIf(self, node): |
paul@353 | 833 | self.stream.write("<span class='listcompif'>") |
paul@353 | 834 | self.stream.write("<span class='conditional'>") |
paul@353 | 835 | self._keyword("if", 1) |
paul@353 | 836 | self.dispatch(node.test) |
paul@353 | 837 | self.stream.write("</span>") |
paul@353 | 838 | self.stream.write("</span>") |
paul@353 | 839 | |
paul@353 | 840 | def visitMod(self, node): |
paul@353 | 841 | self._visitBinary(node, "mod", "%") |
paul@353 | 842 | |
paul@353 | 843 | def visitMul(self, node): |
paul@353 | 844 | self._visitBinary(node, "mul", "*") |
paul@353 | 845 | |
paul@353 | 846 | def visitName(self, node): |
paul@353 | 847 | if hasattr(node, "_scope"): |
paul@353 | 848 | scope = node._scope |
paul@353 | 849 | self._name_start() |
paul@353 | 850 | self.stream.write(node.name) |
paul@353 | 851 | self._popup_start() |
paul@353 | 852 | self._scope(scope) |
paul@353 | 853 | self._popup_end() |
paul@353 | 854 | self._name_end() |
paul@353 | 855 | else: |
paul@353 | 856 | self._name(node.name) |
paul@353 | 857 | |
paul@320 | 858 | # Output preparation methods. |
paul@320 | 859 | |
paul@320 | 860 | def _sequence(self, node): |
paul@320 | 861 | first = 1 |
paul@320 | 862 | for n in node.nodes: |
paul@320 | 863 | if not first: |
paul@321 | 864 | self.stream.write(", ") |
paul@320 | 865 | self.dispatch(n) |
paul@320 | 866 | first = 0 |
paul@320 | 867 | |
paul@320 | 868 | def _mapping(self, node): |
paul@320 | 869 | first = 1 |
paul@320 | 870 | for k, v in node.items: |
paul@320 | 871 | if not first: |
paul@321 | 872 | self.stream.write(", ") |
paul@320 | 873 | self.dispatch(k) |
paul@321 | 874 | self.stream.write(" : ") |
paul@320 | 875 | self.dispatch(v) |
paul@320 | 876 | first = 0 |
paul@320 | 877 | |
paul@354 | 878 | def _parameters(self, fn, node): |
paul@320 | 879 | nparams = len(fn.positional_names) |
paul@320 | 880 | ndefaults = len(fn.defaults) |
paul@320 | 881 | first_with_default = nparams - ndefaults |
paul@320 | 882 | |
paul@321 | 883 | first = 1 |
paul@320 | 884 | for n, param in enumerate(fn.positional_names): |
paul@320 | 885 | if not first: |
paul@321 | 886 | self.stream.write(", ") |
paul@354 | 887 | self._assname(param, node) |
paul@320 | 888 | n_default = n - first_with_default |
paul@320 | 889 | if n_default >= 0: |
paul@320 | 890 | self._default(fn.defaults[n_default]) |
paul@321 | 891 | first = 0 |
paul@320 | 892 | |
paul@320 | 893 | if fn.has_star: |
paul@320 | 894 | if not first: |
paul@321 | 895 | self.stream.write(", *") |
paul@320 | 896 | self._name(fn.star_name) |
paul@320 | 897 | |
paul@320 | 898 | if fn.has_dstar: |
paul@320 | 899 | if not first: |
paul@321 | 900 | self.stream.write(", **") |
paul@320 | 901 | self._name(fn.dstar_name) |
paul@320 | 902 | |
paul@320 | 903 | def _default(self, default): |
paul@321 | 904 | self.stream.write("=") |
paul@320 | 905 | self.dispatch(default) |
paul@320 | 906 | |
paul@318 | 907 | # Convenience functions. |
paul@318 | 908 | |
paul@320 | 909 | def summarise(module, filename): |
paul@318 | 910 | stream = open(filename, "wb") |
paul@318 | 911 | try: |
paul@320 | 912 | summary = Summary(module) |
paul@320 | 913 | summary.to_stream(stream) |
paul@320 | 914 | finally: |
paul@320 | 915 | stream.close() |
paul@320 | 916 | |
paul@320 | 917 | def annotate(module, filename): |
paul@320 | 918 | stream = open(filename, "wb") |
paul@320 | 919 | try: |
paul@320 | 920 | source = AnnotatedSource(module) |
paul@320 | 921 | source.to_stream(stream) |
paul@318 | 922 | finally: |
paul@318 | 923 | stream.close() |
paul@318 | 924 | |
paul@353 | 925 | def report(importer, directory): |
paul@353 | 926 | if not exists(directory): |
paul@353 | 927 | os.mkdir(directory) |
paul@353 | 928 | |
paul@353 | 929 | for module in importer.get_modules(): |
paul@353 | 930 | annotate(module, join(directory, "%s%sxhtml" % (module.full_name(), extsep))) |
paul@353 | 931 | summarise(module, join(directory, "%s-summary%sxhtml" % (module.full_name(), extsep))) |
paul@353 | 932 | |
paul@318 | 933 | # vim: tabstop=4 expandtab shiftwidth=4 |