paul@318 | 1 | #!/usr/bin/env python |
paul@318 | 2 | |
paul@318 | 3 | """ |
paul@318 | 4 | View annotated sources. |
paul@318 | 5 | |
paul@480 | 6 | Copyright (C) 2006, 2007, 2010, 2011 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@480 | 37 | <title>%(title)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@360 | 47 | margin-top: 2em; |
paul@318 | 48 | } |
paul@318 | 49 | |
paul@353 | 50 | a { |
paul@353 | 51 | text-decoration: none; |
paul@353 | 52 | } |
paul@353 | 53 | |
paul@318 | 54 | .nowrap { white-space: nowrap; } |
paul@354 | 55 | .label { font-size: smaller; } |
paul@318 | 56 | |
paul@318 | 57 | .class { margin-top: 1em; margin-bottom: 1em; } |
paul@318 | 58 | .function { margin-top: 1em; margin-bottom: 1em; } |
paul@318 | 59 | .body { padding-left: 2em; } |
paul@370 | 60 | .for, .if, .tryexcept, .tryfinally, .while { margin-bottom: 1em; } |
paul@318 | 61 | .keyword { color: yellow; } |
paul@318 | 62 | .comment { color: blue; } |
paul@318 | 63 | .class-name { color: cyan; } |
paul@318 | 64 | .function-name { color: cyan; } |
paul@358 | 65 | .specific-ref { color: #07F; } |
paul@318 | 66 | .str { color: #FF00FF; } |
paul@318 | 67 | .doc { color: #FF00FF; margin-top: 1em; margin-bottom: 1em; } |
paul@353 | 68 | |
paul@353 | 69 | .popup { |
paul@353 | 70 | display: none; |
paul@353 | 71 | position: absolute; |
paul@353 | 72 | top: 3ex; left: 0; |
paul@353 | 73 | color: white; |
paul@354 | 74 | border-bottom: 0.5ex solid #000; |
paul@354 | 75 | border-right: 0.5ex solid #000; |
paul@353 | 76 | z-index: 3; |
paul@353 | 77 | } |
paul@353 | 78 | |
paul@357 | 79 | .types-popup { |
paul@357 | 80 | display: none; |
paul@357 | 81 | position: absolute; |
paul@357 | 82 | bottom: 3ex; left: 0; |
paul@357 | 83 | color: white; |
paul@357 | 84 | border-bottom: 0.5ex solid #000; |
paul@357 | 85 | border-right: 0.5ex solid #000; |
paul@357 | 86 | z-index: 3; |
paul@357 | 87 | } |
paul@357 | 88 | |
paul@357 | 89 | .accessor, |
paul@371 | 90 | .name, |
paul@371 | 91 | .operation { |
paul@353 | 92 | position: relative; |
paul@354 | 93 | background-color: #300; |
paul@353 | 94 | color: white; |
paul@353 | 95 | } |
paul@353 | 96 | |
paul@357 | 97 | .accessor:hover, |
paul@371 | 98 | .name:hover, |
paul@371 | 99 | .operation:hover { |
paul@354 | 100 | background-color: #500; |
paul@354 | 101 | padding-top: 0.5ex; |
paul@354 | 102 | padding-bottom: 0.5ex; |
paul@353 | 103 | z-index: 2; |
paul@353 | 104 | } |
paul@353 | 105 | |
paul@357 | 106 | .accessor:hover .types-popup, |
paul@371 | 107 | .name:hover .popup, |
paul@371 | 108 | .operation:hover .popup { |
paul@353 | 109 | display: block; |
paul@353 | 110 | } |
paul@318 | 111 | |
paul@354 | 112 | .attrnames, |
paul@371 | 113 | .opnames, |
paul@371 | 114 | .scope, |
paul@371 | 115 | .typenames { |
paul@354 | 116 | padding: 0.5em; |
paul@354 | 117 | background-color: #700; |
paul@354 | 118 | } |
paul@354 | 119 | |
paul@371 | 120 | .opnames a { |
paul@371 | 121 | color: white; |
paul@371 | 122 | } |
paul@371 | 123 | |
paul@318 | 124 | .summary-class { |
paul@361 | 125 | vertical-align: top; |
paul@318 | 126 | } |
paul@318 | 127 | |
paul@480 | 128 | th.summary-class { |
paul@480 | 129 | font-weight: normal; |
paul@480 | 130 | } |
paul@480 | 131 | |
paul@318 | 132 | .summary-attr { |
paul@354 | 133 | background-color: #070; |
paul@480 | 134 | } |
paul@480 | 135 | |
paul@480 | 136 | .summary-interface, |
paul@480 | 137 | .summary-attr { |
paul@361 | 138 | font-size: smaller; |
paul@361 | 139 | } |
paul@361 | 140 | |
paul@480 | 141 | .summary-interface.complete { |
paul@480 | 142 | background-color: #050; |
paul@480 | 143 | } |
paul@480 | 144 | |
paul@480 | 145 | .summary-interface.partial { |
paul@480 | 146 | background-color: #005; |
paul@480 | 147 | } |
paul@480 | 148 | |
paul@361 | 149 | .summary-attr-absent { |
paul@361 | 150 | border-left: 0.2em solid #070; |
paul@361 | 151 | font-size: small; |
paul@361 | 152 | } |
paul@361 | 153 | |
paul@361 | 154 | .summary-class-attr { |
paul@361 | 155 | background-color: #007; |
paul@361 | 156 | font-size: smaller; |
paul@361 | 157 | } |
paul@361 | 158 | |
paul@361 | 159 | .summary-class-attr-absent { |
paul@361 | 160 | border-left: 0.2em solid #007; |
paul@361 | 161 | font-size: small; |
paul@361 | 162 | } |
paul@361 | 163 | |
paul@361 | 164 | .summary-ref { |
paul@361 | 165 | color: white; |
paul@318 | 166 | } |
paul@318 | 167 | |
paul@318 | 168 | </style> |
paul@318 | 169 | </head> |
paul@318 | 170 | <body> |
paul@318 | 171 | """ |
paul@318 | 172 | |
paul@318 | 173 | html_footer = """</body> |
paul@318 | 174 | </html> |
paul@318 | 175 | """ |
paul@318 | 176 | |
paul@318 | 177 | # Utility classes. |
paul@318 | 178 | |
paul@318 | 179 | class Writer: |
paul@318 | 180 | |
paul@318 | 181 | "A utility class providing useful HTML output methods." |
paul@318 | 182 | |
paul@318 | 183 | # Methods which return strings. |
paul@318 | 184 | |
paul@318 | 185 | def _text(self, text): |
paul@318 | 186 | return text.replace("&", "&").replace("<", "<").replace(">", ">") |
paul@318 | 187 | |
paul@318 | 188 | def _attr(self, attr): |
paul@318 | 189 | return self._text(attr).replace("'", "'").replace('"', """) |
paul@318 | 190 | |
paul@318 | 191 | def _url(self, url): |
paul@318 | 192 | return self._attr(url).replace("#", "%23").replace("-", "%2d") |
paul@318 | 193 | |
paul@318 | 194 | # Methods which write to the stream. |
paul@318 | 195 | |
paul@355 | 196 | def _span_start(self, classes=None): |
paul@355 | 197 | self.stream.write("<span class='%s'>" % (classes or "")) |
paul@355 | 198 | |
paul@353 | 199 | def _span_end(self): |
paul@353 | 200 | self.stream.write("</span>") |
paul@353 | 201 | |
paul@355 | 202 | def _span(self, value, classes=None): |
paul@355 | 203 | self._span_start(classes) |
paul@355 | 204 | self.stream.write(self._text(value)) |
paul@355 | 205 | self._span_end() |
paul@355 | 206 | |
paul@355 | 207 | def _name_start(self, classes=None): |
paul@355 | 208 | self._span_start(classes or "name") |
paul@355 | 209 | |
paul@355 | 210 | _name_end = _span_end |
paul@355 | 211 | |
paul@355 | 212 | def _name(self, name, classes=None): |
paul@355 | 213 | self._name_start(classes) |
paul@355 | 214 | self.stream.write(self._text(name)) |
paul@355 | 215 | self._name_end() |
paul@355 | 216 | |
paul@357 | 217 | def _popup_start(self, classes=None): |
paul@357 | 218 | self._span_start(classes or "popup") |
paul@355 | 219 | |
paul@355 | 220 | _popup_end = _span_end |
paul@355 | 221 | |
paul@318 | 222 | def _comment(self, comment): |
paul@355 | 223 | self._span("# %s" % comment, "comment") |
paul@355 | 224 | self.stream.write("\n") |
paul@318 | 225 | |
paul@353 | 226 | def _reserved(self, token, classes, leading=0, trailing=1): |
paul@353 | 227 | if leading: |
paul@353 | 228 | self.stream.write(" ") |
paul@355 | 229 | self._span(token, classes) |
paul@353 | 230 | if trailing: |
paul@353 | 231 | self.stream.write(" ") |
paul@353 | 232 | |
paul@353 | 233 | def _keyword(self, kw, leading=0, trailing=1): |
paul@353 | 234 | self._reserved(kw, "keyword", leading, trailing) |
paul@353 | 235 | |
paul@318 | 236 | def _doc(self, node): |
paul@318 | 237 | if node.doc is not None: |
paul@370 | 238 | self._docstring(node.doc) |
paul@370 | 239 | |
paul@370 | 240 | def _docstring(self, s): |
paul@370 | 241 | self.stream.write("<pre class='doc'>") |
paul@370 | 242 | self.stream.write('"""') |
paul@370 | 243 | output = textwrap.dedent(s.replace('"""', '\\"\\"\\"')) |
paul@370 | 244 | self.stream.write(self._text(output)) |
paul@370 | 245 | self.stream.write('"""') |
paul@370 | 246 | self.stream.write("</pre>\n") |
paul@318 | 247 | |
paul@321 | 248 | def _object_name_def(self, module, obj, classes=None): |
paul@320 | 249 | |
paul@320 | 250 | """ |
paul@321 | 251 | Link to the summary for 'module' using 'obj'. The optional 'classes' |
paul@321 | 252 | can be used to customise the CSS classes employed. |
paul@320 | 253 | """ |
paul@320 | 254 | |
paul@437 | 255 | if isinstance(obj, Class) or (isinstance(obj, Function) and obj.is_method()): |
paul@437 | 256 | self._summary_link(module.full_name(), obj.full_name(), obj.name, classes) |
paul@437 | 257 | else: |
paul@437 | 258 | self._span(obj.name, classes) |
paul@320 | 259 | |
paul@365 | 260 | def _object_name_ref(self, module, obj, name=None, classes=None): |
paul@358 | 261 | |
paul@358 | 262 | """ |
paul@365 | 263 | Link to the definition for 'module' using 'obj' with the optional 'name' |
paul@365 | 264 | used as the label (instead of the name of 'obj'). The optional 'classes' |
paul@358 | 265 | can be used to customise the CSS classes employed. |
paul@358 | 266 | """ |
paul@358 | 267 | |
paul@365 | 268 | self._name_link(module.full_name(), obj.full_name(), name or obj.name, classes) |
paul@358 | 269 | |
paul@358 | 270 | def _summary_link(self, module_name, full_name, name, classes=None): |
paul@358 | 271 | self._name_link("%s-summary" % module_name, full_name, name, classes) |
paul@358 | 272 | |
paul@353 | 273 | def _name_link(self, module_name, full_name, name, classes=None): |
paul@353 | 274 | self.stream.write("<a class='%s' href='%s%sxhtml#%s'>%s</a>" % ( |
paul@358 | 275 | classes or "specific-ref", module_name, os.path.extsep, |
paul@353 | 276 | self._attr(full_name), self._text(name))) |
paul@353 | 277 | |
paul@353 | 278 | def _scope(self, scope): |
paul@354 | 279 | self.stream.write("<div class='scope'><span class='label'>scope</span><br />%s</div>\n" % scope) |
paul@354 | 280 | |
paul@354 | 281 | def _assname(self, name, node): |
paul@355 | 282 | self._span_start("assname") |
paul@383 | 283 | if not self._attrcombined(name, node): |
paul@355 | 284 | self._span(name) |
paul@355 | 285 | self._span_end() |
paul@354 | 286 | |
paul@371 | 287 | def _op(self, symbol, name=None, leading=0, trailing=1): |
paul@371 | 288 | if leading: |
paul@371 | 289 | self.stream.write(" ") |
paul@437 | 290 | self._span_start(name and "operation" or None) |
paul@371 | 291 | self._span(symbol, "operator") |
paul@371 | 292 | if name is not None: |
paul@371 | 293 | self._popup_start() |
paul@371 | 294 | self.stream.write("<div class='opnames'>") |
paul@371 | 295 | self._name_link("operator", "operator.%s" % name, name) |
paul@371 | 296 | self.stream.write("</div>\n") |
paul@371 | 297 | self._popup_end() |
paul@371 | 298 | self._span_end() |
paul@371 | 299 | if trailing: |
paul@371 | 300 | self.stream.write(" ") |
paul@371 | 301 | |
paul@357 | 302 | def _names_list(self, names, label, classes): |
paul@357 | 303 | if not names: |
paul@354 | 304 | return |
paul@357 | 305 | names = list(names) |
paul@357 | 306 | names.sort() |
paul@354 | 307 | |
paul@357 | 308 | self.stream.write("<div class='%s'><span class='label'>%s</span><br />" % (classes, label)) |
paul@354 | 309 | first = 1 |
paul@357 | 310 | for name in names: |
paul@354 | 311 | if not first: |
paul@354 | 312 | self.stream.write("<br />") |
paul@357 | 313 | self.stream.write(name) |
paul@354 | 314 | first = 0 |
paul@354 | 315 | self.stream.write("</div>\n") |
paul@353 | 316 | |
paul@383 | 317 | def _attrcombined(self, name, node): |
paul@383 | 318 | attrcombined = hasattr(node, "_attrcombined") and node._attrcombined.get(name) or [] |
paul@383 | 319 | |
paul@383 | 320 | for attrnames in attrcombined: |
paul@383 | 321 | if attrnames: |
paul@383 | 322 | break |
paul@383 | 323 | else: |
paul@383 | 324 | return 0 |
paul@383 | 325 | |
paul@383 | 326 | self._name_start() |
paul@383 | 327 | self.stream.write(name) |
paul@383 | 328 | self._popup_start() |
paul@383 | 329 | for attrnames in attrcombined: |
paul@383 | 330 | self._attrnames(attrnames) |
paul@383 | 331 | self._popup_end() |
paul@383 | 332 | self._name_end() |
paul@383 | 333 | return 1 |
paul@383 | 334 | |
paul@357 | 335 | def _attrnames(self, attrnames): |
paul@357 | 336 | self._names_list(attrnames, "attributes", "attrnames") |
paul@357 | 337 | |
paul@357 | 338 | def _typenames(self, typenames): |
paul@357 | 339 | self._names_list(typenames, "types", "typenames") |
paul@357 | 340 | |
paul@357 | 341 | def _accessor_start(self, target_names): |
paul@365 | 342 | if target_names: |
paul@357 | 343 | self._span_start("accessor") |
paul@357 | 344 | self._popup_start("types-popup") |
paul@357 | 345 | self._typenames(target_names) |
paul@357 | 346 | self._popup_end() |
paul@357 | 347 | |
paul@357 | 348 | def _accessor_end(self, target_names): |
paul@365 | 349 | if target_names: |
paul@357 | 350 | self._span_end() |
paul@357 | 351 | |
paul@318 | 352 | # Summary classes. |
paul@318 | 353 | |
paul@320 | 354 | class Summary(Writer): |
paul@318 | 355 | |
paul@319 | 356 | "Summarise classes and attributes in modules." |
paul@319 | 357 | |
paul@357 | 358 | def __init__(self, module, program): |
paul@319 | 359 | self.module = module |
paul@357 | 360 | self.program = program |
paul@318 | 361 | |
paul@319 | 362 | def to_stream(self, stream): |
paul@319 | 363 | |
paul@319 | 364 | "Write the summary to the given 'stream'." |
paul@319 | 365 | |
paul@319 | 366 | self.stream = stream |
paul@480 | 367 | self.stream.write(html_header % { |
paul@480 | 368 | "title" : "Module: %s" % self.module.full_name() |
paul@480 | 369 | }) |
paul@319 | 370 | self._write_classes(self.module) |
paul@318 | 371 | self.stream.write(html_footer) |
paul@318 | 372 | |
paul@318 | 373 | def _write_classes(self, module): |
paul@318 | 374 | |
paul@318 | 375 | all_classes = {} |
paul@318 | 376 | |
paul@318 | 377 | for obj in self.module.all_objects: |
paul@318 | 378 | if isinstance(obj, Class): |
paul@318 | 379 | all_classes[obj.name] = obj |
paul@318 | 380 | |
paul@361 | 381 | if all_classes: |
paul@361 | 382 | |
paul@361 | 383 | all_class_names = all_classes.keys() |
paul@361 | 384 | all_class_names.sort() |
paul@318 | 385 | |
paul@361 | 386 | self.stream.write("<table cellspacing='5' cellpadding='5'>\n") |
paul@361 | 387 | self.stream.write("<thead>\n") |
paul@361 | 388 | self.stream.write("<tr>\n") |
paul@361 | 389 | self.stream.write("<th>Classes</th><th>Attributes</th>\n") |
paul@361 | 390 | self.stream.write("</tr>\n") |
paul@361 | 391 | self.stream.write("</thead>\n") |
paul@318 | 392 | |
paul@361 | 393 | for name in all_class_names: |
paul@361 | 394 | self._write_class(all_classes[name]) |
paul@361 | 395 | |
paul@361 | 396 | self.stream.write("</table>\n") |
paul@318 | 397 | |
paul@318 | 398 | def _write_class(self, obj): |
paul@318 | 399 | |
paul@318 | 400 | # Write the class... |
paul@318 | 401 | |
paul@318 | 402 | self.stream.write("<tbody class='class'>\n") |
paul@318 | 403 | self.stream.write("<tr>\n") |
paul@361 | 404 | self.stream.write("<th class='summary-class' id='%s' rowspan='2'>" % self._attr(obj.full_name())) |
paul@361 | 405 | self._object_name_ref(self.module, obj, classes="class-name") |
paul@318 | 406 | self.stream.write("</th>\n") |
paul@318 | 407 | |
paul@361 | 408 | # ...and instance attribute names in order... |
paul@318 | 409 | |
paul@358 | 410 | attrs = obj.instance_attributes().values() |
paul@358 | 411 | attrs.sort(cmp=lambda x, y: cmp(x.position, y.position)) |
paul@318 | 412 | |
paul@361 | 413 | if attrs: |
paul@361 | 414 | for attr in attrs: |
paul@361 | 415 | self.stream.write("<td class='summary-attr'>%s</td>\n" % self._text(attr.name)) |
paul@361 | 416 | else: |
paul@361 | 417 | self.stream.write("<td class='summary-attr-absent'>None</td>\n") |
paul@361 | 418 | |
paul@361 | 419 | self.stream.write("</tr>\n") |
paul@361 | 420 | self.stream.write("<tr>\n") |
paul@361 | 421 | |
paul@361 | 422 | # ...and class attribute names in order. |
paul@361 | 423 | |
paul@361 | 424 | attrs = obj.class_attributes().values() |
paul@361 | 425 | attrs.sort(cmp=lambda x, y: cmp(x.position, y.position)) |
paul@361 | 426 | |
paul@361 | 427 | if attrs: |
paul@361 | 428 | for attr in attrs: |
paul@363 | 429 | if attr.is_strict_constant(): |
paul@363 | 430 | value = attr.get_value() |
paul@473 | 431 | if not isinstance(value, Const): |
paul@473 | 432 | self.stream.write("<td class='summary-class-attr' id='%s'>" % self._attr(value.full_name())) |
paul@473 | 433 | self._object_name_ref(self.module, value, attr.name, classes="summary-ref") |
paul@473 | 434 | self.stream.write("</td>\n") |
paul@473 | 435 | else: |
paul@473 | 436 | self.stream.write("<td class='summary-class-attr'>%s</td>\n" % self._text(attr.name)) |
paul@361 | 437 | else: |
paul@361 | 438 | self.stream.write("<td class='summary-class-attr'>%s</td>\n" % self._text(attr.name)) |
paul@361 | 439 | else: |
paul@361 | 440 | self.stream.write("<td class='summary-class-attr-absent'>None</td>\n") |
paul@358 | 441 | |
paul@318 | 442 | self.stream.write("</tr>\n") |
paul@318 | 443 | self.stream.write("</tbody>\n") |
paul@318 | 444 | |
paul@480 | 445 | class Interfaces(Writer): |
paul@480 | 446 | |
paul@480 | 447 | "Summarise the interfaces used by reading the object table cache." |
paul@480 | 448 | |
paul@480 | 449 | def __init__(self, program): |
paul@480 | 450 | self.program = program |
paul@480 | 451 | |
paul@480 | 452 | def to_stream(self, stream): |
paul@480 | 453 | |
paul@480 | 454 | "Write the summary to the given 'stream'." |
paul@480 | 455 | |
paul@480 | 456 | self.stream = stream |
paul@480 | 457 | self.stream.write(html_header % { |
paul@480 | 458 | "title" : "Interfaces" |
paul@480 | 459 | }) |
paul@480 | 460 | self._write_interfaces() |
paul@480 | 461 | self.stream.write(html_footer) |
paul@480 | 462 | |
paul@480 | 463 | def _write_interfaces(self): |
paul@480 | 464 | objtable = self.program.get_object_table() |
paul@480 | 465 | all_interfaces = objtable.all_cache.items() |
paul@480 | 466 | any_interfaces = objtable.any_cache.items() |
paul@480 | 467 | all_interfaces.sort() |
paul@480 | 468 | any_interfaces.sort() |
paul@480 | 469 | |
paul@480 | 470 | self.stream.write("<table cellspacing='5' cellpadding='5'>\n") |
paul@480 | 471 | self.stream.write("<thead>\n") |
paul@480 | 472 | self.stream.write("<tr>\n") |
paul@480 | 473 | self.stream.write("<th>Complete Interfaces</th>\n") |
paul@480 | 474 | self.stream.write("</tr>\n") |
paul@480 | 475 | self.stream.write("</thead>\n") |
paul@480 | 476 | self._write_interface_type(all_interfaces, "complete") |
paul@480 | 477 | self.stream.write("<thead>\n") |
paul@480 | 478 | self.stream.write("<tr>\n") |
paul@480 | 479 | self.stream.write("<th>Partial Interfaces</th>\n") |
paul@480 | 480 | self.stream.write("</tr>\n") |
paul@480 | 481 | self.stream.write("</thead>\n") |
paul@480 | 482 | self._write_interface_type(any_interfaces, "partial") |
paul@480 | 483 | self.stream.write("</table>\n") |
paul@480 | 484 | |
paul@480 | 485 | def _write_interface_type(self, interfaces, classes=""): |
paul@480 | 486 | self.stream.write("<tbody>\n") |
paul@480 | 487 | |
paul@480 | 488 | for names, objects in interfaces: |
paul@480 | 489 | if names: |
paul@481 | 490 | names = list(names) |
paul@480 | 491 | names.sort() |
paul@480 | 492 | self.stream.write("<tr>\n") |
paul@480 | 493 | self.stream.write("<td class='summary-interface %s'>%s</td>" % (classes, ", ".join(names))) |
paul@480 | 494 | self.stream.write("</tr>\n") |
paul@480 | 495 | |
paul@480 | 496 | self.stream.write("</tbody>\n") |
paul@480 | 497 | |
paul@320 | 498 | # Source code classes. |
paul@320 | 499 | |
paul@320 | 500 | class AnnotatedSource(ASTVisitor, Writer): |
paul@320 | 501 | |
paul@320 | 502 | "A module source code browser." |
paul@320 | 503 | |
paul@357 | 504 | def __init__(self, module, program): |
paul@320 | 505 | self.visitor = self |
paul@320 | 506 | self.module = module |
paul@357 | 507 | self.program = program |
paul@357 | 508 | self.objtable = self.program.get_object_table() |
paul@357 | 509 | self.paramtable = self.program.get_parameter_table() |
paul@320 | 510 | |
paul@320 | 511 | def to_stream(self, stream): |
paul@320 | 512 | |
paul@320 | 513 | "Write the annotated code to the given 'stream'." |
paul@320 | 514 | |
paul@320 | 515 | self.stream = stream |
paul@480 | 516 | self.stream.write(html_header % { |
paul@480 | 517 | "title" : "Module: %s" % self.module.full_name() |
paul@480 | 518 | }) |
paul@353 | 519 | self.dispatch(self.module.astnode) |
paul@320 | 520 | self.stream.write(html_footer) |
paul@320 | 521 | |
paul@320 | 522 | def visitModule(self, node): |
paul@320 | 523 | self.default(node) |
paul@320 | 524 | |
paul@320 | 525 | # Statements. |
paul@320 | 526 | |
paul@320 | 527 | def visitAssert(self, node): |
paul@320 | 528 | self.stream.write("<div class='assert nowrap'>\n") |
paul@320 | 529 | self._keyword("assert") |
paul@320 | 530 | self.dispatch(node.test) |
paul@320 | 531 | if node.fail: |
paul@320 | 532 | self.stream.write(", ") |
paul@320 | 533 | self.dispatch(node.fail) |
paul@320 | 534 | self.stream.write("</div>\n") |
paul@320 | 535 | |
paul@320 | 536 | def visitAssign(self, node): |
paul@320 | 537 | self.stream.write("<div class='assign nowrap'>\n") |
paul@320 | 538 | for lvalue in node.nodes: |
paul@320 | 539 | self.dispatch(lvalue) |
paul@353 | 540 | self.stream.write(" = ") |
paul@320 | 541 | self.dispatch(node.expr) |
paul@320 | 542 | self.stream.write("</div>\n") |
paul@320 | 543 | |
paul@320 | 544 | def visitAugAssign(self, node): |
paul@320 | 545 | self.stream.write("<div class='augassign nowrap'>\n") |
paul@320 | 546 | self.dispatch(node.node) |
paul@371 | 547 | self._op(node.op, operator_functions[node.op], 1) |
paul@320 | 548 | self.dispatch(node.expr) |
paul@320 | 549 | self.stream.write("</div>\n") |
paul@320 | 550 | |
paul@320 | 551 | def visitBreak(self, node): |
paul@320 | 552 | self.stream.write("<div class='break nowrap'>\n") |
paul@320 | 553 | self._keyword("break") |
paul@320 | 554 | self.stream.write("</div>\n") |
paul@320 | 555 | |
paul@320 | 556 | def visitClass(self, node): |
paul@353 | 557 | if not used_by_unit(node): |
paul@370 | 558 | self._docstring('"Class %s not generated."' % node.name) |
paul@353 | 559 | return |
paul@320 | 560 | |
paul@320 | 561 | # Use inspected details where possible. |
paul@320 | 562 | |
paul@354 | 563 | if hasattr(node, "unit"): |
paul@354 | 564 | cls = node.unit |
paul@320 | 565 | bases = cls.bases |
paul@320 | 566 | self.stream.write("<div class='class nowrap' id='%s'>\n" % cls.full_name()) |
paul@320 | 567 | else: |
paul@320 | 568 | print "Warning: class %s not recognised!" % node.name |
paul@320 | 569 | return |
paul@320 | 570 | |
paul@320 | 571 | # Write the declaration line. |
paul@320 | 572 | |
paul@320 | 573 | self.stream.write("<div>\n") |
paul@320 | 574 | self._keyword("class") |
paul@321 | 575 | self._object_name_def(self.module, cls, "class-name") |
paul@320 | 576 | |
paul@320 | 577 | # Suppress the "object" class appearing alone. |
paul@320 | 578 | |
paul@320 | 579 | if bases and not (len(bases) == 1 and bases[0].name == "object"): |
paul@320 | 580 | self.stream.write("(") |
paul@320 | 581 | first = 1 |
paul@320 | 582 | for base in bases: |
paul@320 | 583 | if not first: |
paul@321 | 584 | self.stream.write(", ") |
paul@320 | 585 | |
paul@358 | 586 | self._object_name_ref(base.module, base) |
paul@320 | 587 | |
paul@320 | 588 | first = 0 |
paul@320 | 589 | self.stream.write(")") |
paul@320 | 590 | |
paul@320 | 591 | self.stream.write(":\n") |
paul@320 | 592 | self.stream.write("</div>\n") |
paul@320 | 593 | |
paul@320 | 594 | # Write the docstring and class body. |
paul@320 | 595 | |
paul@320 | 596 | self.stream.write("<div class='body nowrap'>\n") |
paul@320 | 597 | self._doc(node) |
paul@358 | 598 | |
paul@358 | 599 | # NOTE: Some streams may not support tell. |
paul@358 | 600 | |
paul@358 | 601 | x = self.stream.tell() |
paul@358 | 602 | |
paul@358 | 603 | self.default(node.code) |
paul@358 | 604 | |
paul@358 | 605 | # Check for no output. |
paul@358 | 606 | |
paul@358 | 607 | if x == self.stream.tell(): |
paul@358 | 608 | self.visitPass(None) |
paul@358 | 609 | |
paul@320 | 610 | self.stream.write("</div>\n") |
paul@320 | 611 | self.stream.write("</div>\n") |
paul@320 | 612 | |
paul@320 | 613 | def visitContinue(self, node): |
paul@320 | 614 | self.stream.write("<div class='continue nowrap'>\n") |
paul@320 | 615 | self._keyword("continue") |
paul@320 | 616 | self.stream.write("</div>\n") |
paul@320 | 617 | |
paul@320 | 618 | def visitDiscard(self, node): |
paul@320 | 619 | self.stream.write("<div class='discard nowrap'>\n") |
paul@320 | 620 | self.default(node) |
paul@320 | 621 | self.stream.write("</div>\n") |
paul@320 | 622 | |
paul@320 | 623 | def visitFor(self, node): |
paul@320 | 624 | self.stream.write("<div class='if nowrap'>\n") |
paul@320 | 625 | self.stream.write("<div>\n") |
paul@320 | 626 | self._keyword("for") |
paul@320 | 627 | self.dispatch(node.assign) |
paul@353 | 628 | self._keyword("in", 1) |
paul@320 | 629 | self.dispatch(node.list) |
paul@320 | 630 | self.stream.write(":\n") |
paul@320 | 631 | self.stream.write("</div>\n") |
paul@320 | 632 | self.stream.write("<div class='body nowrap'>\n") |
paul@320 | 633 | self.dispatch(node.body) |
paul@320 | 634 | self.stream.write("</div>\n") |
paul@320 | 635 | if node.else_ is not None: |
paul@320 | 636 | self.stream.write("<div>\n") |
paul@353 | 637 | self._keyword("else", trailing=0) |
paul@320 | 638 | self.stream.write(":\n") |
paul@320 | 639 | self.stream.write("</div>\n") |
paul@320 | 640 | self.stream.write("<div class='body nowrap'>\n") |
paul@320 | 641 | self.dispatch(node.else_) |
paul@320 | 642 | self.stream.write("</div>\n") |
paul@320 | 643 | self.stream.write("</div>\n") |
paul@320 | 644 | |
paul@320 | 645 | def visitFrom(self, node): |
paul@320 | 646 | self.stream.write("<div class='from nowrap'>\n") |
paul@320 | 647 | self._keyword("from") |
paul@320 | 648 | self._name(node.modname) |
paul@353 | 649 | self._keyword("import", 1) |
paul@320 | 650 | first = 1 |
paul@363 | 651 | for name, alias in node.names: |
paul@320 | 652 | if not first: |
paul@321 | 653 | self.stream.write(", ") |
paul@320 | 654 | if alias: |
paul@320 | 655 | self.stream.write(name + " ") |
paul@353 | 656 | self._keyword("as", 1) |
paul@320 | 657 | self._name(alias or name) |
paul@320 | 658 | first = 0 |
paul@320 | 659 | self.stream.write("</div>\n") |
paul@320 | 660 | |
paul@320 | 661 | def visitFunction(self, node): |
paul@353 | 662 | if not used_by_unit(node): |
paul@370 | 663 | self._docstring('"Function %s not generated."' % node.name) |
paul@353 | 664 | return |
paul@353 | 665 | |
paul@354 | 666 | if hasattr(node, "unit"): |
paul@354 | 667 | fn = node.unit |
paul@320 | 668 | self.stream.write("<div class='function nowrap' id='%s'>\n" % fn.full_name()) |
paul@320 | 669 | else: |
paul@320 | 670 | print "Warning: function %s not recognised!" % node.name |
paul@320 | 671 | return |
paul@320 | 672 | |
paul@320 | 673 | # Write the declaration line. |
paul@320 | 674 | |
paul@320 | 675 | self.stream.write("<div>\n") |
paul@320 | 676 | self._keyword("def") |
paul@321 | 677 | self._object_name_def(self.module, fn, "function-name") |
paul@320 | 678 | |
paul@320 | 679 | self.stream.write("(") |
paul@354 | 680 | self._parameters(fn, node) |
paul@320 | 681 | self.stream.write(")") |
paul@320 | 682 | self.stream.write(":\n") |
paul@320 | 683 | self.stream.write("</div>\n") |
paul@320 | 684 | |
paul@320 | 685 | self.stream.write("<div class='body nowrap'>\n") |
paul@320 | 686 | self._doc(node) |
paul@320 | 687 | self.dispatch(node.code) |
paul@320 | 688 | self.stream.write("</div>\n") |
paul@320 | 689 | self.stream.write("</div>\n") |
paul@320 | 690 | |
paul@320 | 691 | def visitGlobal(self, node): |
paul@320 | 692 | self.stream.write("<div class='global nowrap'>\n") |
paul@320 | 693 | self._keyword("global") |
paul@320 | 694 | first = 1 |
paul@320 | 695 | for name in node.names: |
paul@320 | 696 | if not first: |
paul@321 | 697 | self.stream.write(", ") |
paul@320 | 698 | self.stream.write(name) |
paul@320 | 699 | first = 0 |
paul@320 | 700 | self.stream.write("</div>\n") |
paul@320 | 701 | |
paul@320 | 702 | def visitIf(self, node): |
paul@320 | 703 | self.stream.write("<div class='if nowrap'>\n") |
paul@320 | 704 | first = 1 |
paul@320 | 705 | for compare, stmt in node.tests: |
paul@320 | 706 | self.stream.write("<div>\n") |
paul@320 | 707 | if first: |
paul@320 | 708 | self._keyword("if") |
paul@320 | 709 | else: |
paul@320 | 710 | self._keyword("elif") |
paul@320 | 711 | self.dispatch(compare) |
paul@320 | 712 | self.stream.write(":\n") |
paul@320 | 713 | self.stream.write("</div>\n") |
paul@320 | 714 | self.stream.write("<div class='body nowrap'>\n") |
paul@320 | 715 | self.dispatch(stmt) |
paul@320 | 716 | self.stream.write("</div>\n") |
paul@320 | 717 | first = 0 |
paul@320 | 718 | if node.else_ is not None: |
paul@320 | 719 | self.stream.write("<div>\n") |
paul@353 | 720 | self._keyword("else", trailing=0) |
paul@353 | 721 | self.stream.write(":\n") |
paul@353 | 722 | self.stream.write("</div>\n") |
paul@353 | 723 | self.stream.write("<div class='body nowrap'>\n") |
paul@353 | 724 | self.dispatch(node.else_) |
paul@353 | 725 | self.stream.write("</div>\n") |
paul@353 | 726 | self.stream.write("</div>\n") |
paul@353 | 727 | |
paul@353 | 728 | def visitImport(self, node): |
paul@353 | 729 | self.stream.write("<div class='import nowrap'>\n") |
paul@353 | 730 | self._keyword("import") |
paul@353 | 731 | first = 1 |
paul@353 | 732 | for name, alias in node.names: |
paul@353 | 733 | if not first: |
paul@353 | 734 | self.stream.write(",\n") |
paul@353 | 735 | if alias: |
paul@353 | 736 | self.stream.write(name + " ") |
paul@353 | 737 | self._keyword("as", 1) |
paul@353 | 738 | self._name(alias or name) |
paul@353 | 739 | first = 0 |
paul@353 | 740 | self.stream.write("</div>\n") |
paul@353 | 741 | |
paul@353 | 742 | def visitPass(self, node): |
paul@353 | 743 | self.stream.write("<div class='pass nowrap'>\n") |
paul@353 | 744 | self._keyword("pass") |
paul@353 | 745 | self.stream.write("</div>\n") |
paul@353 | 746 | |
paul@353 | 747 | def visitPrint(self, node): |
paul@353 | 748 | self.stream.write("<div class='print nowrap'>\n") |
paul@353 | 749 | self._keyword("print") |
paul@353 | 750 | if node.dest is not None: |
paul@353 | 751 | self.stream.write(">>\n") |
paul@353 | 752 | self.dispatch(node.dest) |
paul@353 | 753 | for n in node.nodes: |
paul@353 | 754 | self.dispatch(n) |
paul@353 | 755 | self.stream.write(",\n") |
paul@353 | 756 | self.stream.write("</div>\n") |
paul@353 | 757 | |
paul@353 | 758 | def visitPrintnl(self, node): |
paul@353 | 759 | self.stream.write("<div class='printnl nowrap'>\n") |
paul@353 | 760 | self._keyword("print") |
paul@353 | 761 | if node.dest is not None: |
paul@353 | 762 | self.stream.write(">>\n") |
paul@353 | 763 | self.dispatch(node.dest) |
paul@353 | 764 | first = 1 |
paul@353 | 765 | for n in node.nodes: |
paul@353 | 766 | if not first: |
paul@353 | 767 | self.stream.write(",\n") |
paul@353 | 768 | self.dispatch(n) |
paul@353 | 769 | first = 0 |
paul@353 | 770 | self.stream.write("</div>\n") |
paul@353 | 771 | |
paul@353 | 772 | def visitRaise(self, node): |
paul@353 | 773 | self.stream.write("<div class='raise nowrap'>\n") |
paul@353 | 774 | self._keyword("raise") |
paul@363 | 775 | if node.expr1 is not None: |
paul@363 | 776 | self.dispatch(node.expr1) |
paul@353 | 777 | if node.expr2 is not None: |
paul@353 | 778 | self.stream.write(",\n") |
paul@353 | 779 | self.dispatch(node.expr2) |
paul@353 | 780 | if node.expr3 is not None: |
paul@353 | 781 | self.stream.write(",\n") |
paul@353 | 782 | self.dispatch(node.expr3) |
paul@353 | 783 | self.stream.write("</div>\n") |
paul@353 | 784 | |
paul@353 | 785 | def visitReturn(self, node): |
paul@353 | 786 | self.stream.write("<div class='return nowrap'>\n") |
paul@353 | 787 | self._keyword("return") |
paul@353 | 788 | self.dispatch(node.value) |
paul@353 | 789 | self.stream.write("</div>\n") |
paul@353 | 790 | |
paul@353 | 791 | def visitStmt(self, node): |
paul@353 | 792 | self.stream.write("<div class='stmt nowrap'>\n") |
paul@353 | 793 | self.default(node) |
paul@353 | 794 | self.stream.write("</div>\n") |
paul@353 | 795 | |
paul@353 | 796 | def visitTryExcept(self, node): |
paul@353 | 797 | self.stream.write("<div class='tryexcept nowrap'>\n") |
paul@353 | 798 | self.stream.write("<div>\n") |
paul@353 | 799 | self._keyword("try", trailing=0) |
paul@353 | 800 | self.stream.write(":\n") |
paul@353 | 801 | self.stream.write("</div>\n") |
paul@353 | 802 | self.stream.write("<div class='body nowrap'>\n") |
paul@353 | 803 | self.dispatch(node.body) |
paul@353 | 804 | self.stream.write("</div>\n") |
paul@353 | 805 | for spec, assign, statement in node.handlers: |
paul@353 | 806 | self.stream.write("<div>\n") |
paul@353 | 807 | self._keyword("except") |
paul@353 | 808 | if spec is not None: |
paul@353 | 809 | self.dispatch(spec) |
paul@353 | 810 | if assign is not None: |
paul@353 | 811 | self.stream.write(",\n") |
paul@353 | 812 | self.dispatch(assign) |
paul@353 | 813 | self.stream.write(":\n") |
paul@353 | 814 | self.stream.write("</div>\n") |
paul@353 | 815 | self.stream.write("<div class='body nowrap'>\n") |
paul@353 | 816 | self.dispatch(statement) |
paul@353 | 817 | self.stream.write("</div>\n") |
paul@353 | 818 | if node.else_ is not None: |
paul@353 | 819 | self.stream.write("<div>\n") |
paul@353 | 820 | self._keyword("else", trailing=0) |
paul@353 | 821 | self.stream.write(":\n") |
paul@353 | 822 | self.stream.write("</div>\n") |
paul@353 | 823 | self.stream.write("<div class='body nowrap'>\n") |
paul@353 | 824 | self.dispatch(node.else_) |
paul@353 | 825 | self.stream.write("</div>\n") |
paul@353 | 826 | self.stream.write("</div>\n") |
paul@353 | 827 | |
paul@353 | 828 | def visitTryFinally(self, node): |
paul@353 | 829 | self.stream.write("<div class='tryfinally nowrap'>\n") |
paul@353 | 830 | self.stream.write("<div>\n") |
paul@353 | 831 | self._keyword("try", trailing=0) |
paul@353 | 832 | self.stream.write(":\n") |
paul@353 | 833 | self.stream.write("</div>\n") |
paul@353 | 834 | self.stream.write("<div class='body nowrap'>\n") |
paul@353 | 835 | self.dispatch(node.body) |
paul@353 | 836 | self.stream.write("</div>\n") |
paul@353 | 837 | self.stream.write("<div>\n") |
paul@353 | 838 | self._keyword("finally", trailing=0) |
paul@353 | 839 | self.stream.write(":\n") |
paul@353 | 840 | self.stream.write("</div>\n") |
paul@353 | 841 | self.stream.write("<div class='body nowrap'>\n") |
paul@353 | 842 | self.dispatch(node.final) |
paul@353 | 843 | self.stream.write("</div>\n") |
paul@353 | 844 | self.stream.write("</div>\n") |
paul@353 | 845 | |
paul@353 | 846 | def visitWhile(self, node): |
paul@353 | 847 | self.stream.write("<div class='while nowrap'>\n") |
paul@353 | 848 | self.stream.write("<div>\n") |
paul@353 | 849 | self._keyword("while") |
paul@353 | 850 | self.dispatch(node.test) |
paul@353 | 851 | self.stream.write(":\n") |
paul@353 | 852 | self.stream.write("</div>\n") |
paul@353 | 853 | self.stream.write("<div class='body nowrap'>\n") |
paul@353 | 854 | self.dispatch(node.body) |
paul@353 | 855 | self.stream.write("</div>\n") |
paul@353 | 856 | if node.else_ is not None: |
paul@353 | 857 | self.stream.write("<div>\n") |
paul@353 | 858 | self._keyword("else", trailing=0) |
paul@320 | 859 | self.stream.write(":\n") |
paul@320 | 860 | self.stream.write("</div>\n") |
paul@320 | 861 | self.stream.write("<div class='body nowrap'>\n") |
paul@320 | 862 | self.dispatch(node.else_) |
paul@320 | 863 | self.stream.write("</div>\n") |
paul@320 | 864 | self.stream.write("</div>\n") |
paul@320 | 865 | |
paul@496 | 866 | def visitYield(self, node): |
paul@496 | 867 | self.stream.write("<div class='yield nowrap'>\n") |
paul@496 | 868 | self._keyword("yield") |
paul@496 | 869 | self.dispatch(node.value) |
paul@496 | 870 | self.stream.write("</div>\n") |
paul@496 | 871 | |
paul@353 | 872 | # Expression-related helper methods. |
paul@353 | 873 | |
paul@353 | 874 | def _visitBitBinary(self, node, name, symbol): |
paul@355 | 875 | self._span_start(name) |
paul@353 | 876 | first = 1 |
paul@353 | 877 | for node in node.nodes: |
paul@353 | 878 | if not first: |
paul@371 | 879 | self._op(symbol, name, 1) |
paul@353 | 880 | self.dispatch(node) |
paul@353 | 881 | first = 0 |
paul@355 | 882 | self._span_end() |
paul@353 | 883 | |
paul@353 | 884 | def _visitBinary(self, node, name, symbol): |
paul@355 | 885 | self._span_start(name) |
paul@353 | 886 | self.dispatch(node.left) |
paul@371 | 887 | self._op(symbol, name, 1) |
paul@353 | 888 | self.dispatch(node.right) |
paul@355 | 889 | self._span_end() |
paul@353 | 890 | |
paul@353 | 891 | def _visitUnary(self, node, name, symbol): |
paul@355 | 892 | self._span_start(name) |
paul@371 | 893 | self._op(symbol, name) |
paul@353 | 894 | self.dispatch(node.expr) |
paul@355 | 895 | self._span_end() |
paul@353 | 896 | |
paul@353 | 897 | # Expressions. |
paul@353 | 898 | |
paul@353 | 899 | def visitAdd(self, node): |
paul@353 | 900 | self._visitBinary(node, "add", "+") |
paul@353 | 901 | |
paul@353 | 902 | def visitAnd(self, node): |
paul@355 | 903 | self._span_start("and") |
paul@353 | 904 | first = 1 |
paul@353 | 905 | for n in node.nodes: |
paul@353 | 906 | if not first: |
paul@353 | 907 | self._keyword("and", 1) |
paul@353 | 908 | self.dispatch(n) |
paul@353 | 909 | first = 0 |
paul@355 | 910 | self._span_end() |
paul@353 | 911 | |
paul@353 | 912 | def visitAssAttr(self, node): |
paul@409 | 913 | target_names = ["%s%s" % (is_static and "class " or "", target_name) |
paul@488 | 914 | for target_name, is_static in self.possible_accessor_types(node, defining_users=0)] |
paul@355 | 915 | self._span_start("assattr") |
paul@359 | 916 | self._accessor_start(target_names) |
paul@353 | 917 | self.dispatch(node.expr) |
paul@359 | 918 | self._accessor_end(target_names) |
paul@355 | 919 | self._span_start("attr") |
paul@353 | 920 | self.stream.write(".") |
paul@437 | 921 | self._span(node.attrname, "attrname") |
paul@355 | 922 | self._span_end() |
paul@355 | 923 | self._span_end() |
paul@353 | 924 | |
paul@353 | 925 | def visitAssList(self, node): |
paul@355 | 926 | self._span_start("list") |
paul@353 | 927 | self.stream.write("[") |
paul@353 | 928 | self._sequence(node) |
paul@353 | 929 | self.stream.write("]") |
paul@355 | 930 | self._span_end() |
paul@353 | 931 | |
paul@353 | 932 | def visitAssName(self, node): |
paul@354 | 933 | self._assname(node.name, node) |
paul@353 | 934 | |
paul@353 | 935 | def visitAssTuple(self, node): |
paul@355 | 936 | self._span_start("tuple") |
paul@353 | 937 | self.stream.write("(") |
paul@353 | 938 | self._sequence(node) |
paul@353 | 939 | self.stream.write(")") |
paul@355 | 940 | self._span_end() |
paul@353 | 941 | |
paul@353 | 942 | def visitBitand(self, node): |
paul@353 | 943 | self._visitBitBinary(node, "bitand", "&") |
paul@353 | 944 | |
paul@437 | 945 | def visitBitor(self, node): |
paul@437 | 946 | self._visitBitBinary(node, "bitor", "|") |
paul@437 | 947 | |
paul@437 | 948 | def visitBitxor(self, node): |
paul@437 | 949 | self._visitBitBinary(node, "bitxor", "^") |
paul@437 | 950 | |
paul@353 | 951 | def visitCallFunc(self, node): |
paul@355 | 952 | self._span_start("callfunc") |
paul@353 | 953 | self.dispatch(node.node) |
paul@355 | 954 | self._span_start("call") |
paul@353 | 955 | self.stream.write("(") |
paul@353 | 956 | first = 1 |
paul@353 | 957 | for arg in node.args: |
paul@353 | 958 | if not first: |
paul@353 | 959 | self.stream.write(", ") |
paul@353 | 960 | self.dispatch(arg) |
paul@353 | 961 | first = 0 |
paul@353 | 962 | if node.star_args is not None: |
paul@353 | 963 | if not first: |
paul@353 | 964 | self.stream.write(", *") |
paul@353 | 965 | self.dispatch(node.star_args) |
paul@353 | 966 | first = 0 |
paul@353 | 967 | if node.dstar_args is not None: |
paul@353 | 968 | if not first: |
paul@353 | 969 | self.stream.write(", **") |
paul@353 | 970 | self.dispatch(node.dstar_args) |
paul@353 | 971 | first = 0 |
paul@353 | 972 | self.stream.write(")") |
paul@355 | 973 | self._span_end() |
paul@355 | 974 | self._span_end() |
paul@353 | 975 | |
paul@353 | 976 | def visitCompare(self, node): |
paul@355 | 977 | self._span_start("compare") |
paul@353 | 978 | self.dispatch(node.expr) |
paul@353 | 979 | for op_name, expr in node.ops: |
paul@371 | 980 | self._op(op_name, operator_functions.get(op_name), 1) |
paul@353 | 981 | self.dispatch(expr) |
paul@355 | 982 | self._span_end() |
paul@353 | 983 | |
paul@353 | 984 | def visitConst(self, node): |
paul@353 | 985 | if isinstance(node.value, (str, unicode)): |
paul@355 | 986 | self._span_start("str") |
paul@353 | 987 | self.stream.write(self._text(repr(node.value))) |
paul@353 | 988 | if isinstance(node.value, (str, unicode)): |
paul@355 | 989 | self._span_end() |
paul@353 | 990 | |
paul@353 | 991 | def visitDict(self, node): |
paul@355 | 992 | self._span_start("dict") |
paul@353 | 993 | self.stream.write("{") |
paul@353 | 994 | self._mapping(node) |
paul@353 | 995 | self.stream.write("}") |
paul@355 | 996 | self._span_end() |
paul@353 | 997 | |
paul@353 | 998 | def visitDiv(self, node): |
paul@353 | 999 | self._visitBinary(node, "div", "/") |
paul@353 | 1000 | |
paul@353 | 1001 | def visitFloorDiv(self, node): |
paul@353 | 1002 | self._visitBinary(node, "floordiv", "//") |
paul@353 | 1003 | |
paul@353 | 1004 | def visitGetattr(self, node): |
paul@409 | 1005 | target_names = ["%s%s" % (is_static and "class " or "", target_name) |
paul@488 | 1006 | for target_name, is_static in self.possible_accessor_types(node, defining_users=0)] |
paul@355 | 1007 | self._span_start("getattr") |
paul@357 | 1008 | self._accessor_start(target_names) |
paul@353 | 1009 | self.dispatch(node.expr) |
paul@357 | 1010 | self._accessor_end(target_names) |
paul@355 | 1011 | self._span_start("attr") |
paul@353 | 1012 | self.stream.write(".") |
paul@356 | 1013 | self._span(node.attrname, "attrname") |
paul@355 | 1014 | self._span_end() |
paul@355 | 1015 | self._span_end() |
paul@353 | 1016 | |
paul@496 | 1017 | def visitIfExp(self, node): |
paul@496 | 1018 | self._span_start("ifexp") |
paul@496 | 1019 | self.dispatch(node.then) |
paul@496 | 1020 | self._keyword("if") |
paul@496 | 1021 | self.dispatch(node.test) |
paul@496 | 1022 | self._keyword("else") |
paul@496 | 1023 | self.dispatch(node.else_) |
paul@496 | 1024 | self._span_end() |
paul@496 | 1025 | |
paul@353 | 1026 | def visitKeyword(self, node): |
paul@355 | 1027 | self._span_start("keyword-arg") |
paul@353 | 1028 | self.stream.write(node.name) |
paul@353 | 1029 | self.stream.write("=") |
paul@353 | 1030 | self.dispatch(node.expr) |
paul@355 | 1031 | self._span_end() |
paul@353 | 1032 | |
paul@353 | 1033 | def visitLambda(self, node): |
paul@354 | 1034 | if hasattr(node, "unit"): |
paul@354 | 1035 | fn = node.unit |
paul@353 | 1036 | else: |
paul@353 | 1037 | print "Warning: function %s not recognised!" % node.name |
paul@353 | 1038 | return |
paul@353 | 1039 | |
paul@355 | 1040 | self._span_start("lambda") |
paul@353 | 1041 | self._keyword("lambda") |
paul@354 | 1042 | self._parameters(fn, node) |
paul@355 | 1043 | self.stream.write(": ") |
paul@355 | 1044 | self._span_start("code") |
paul@353 | 1045 | self.dispatch(node.code) |
paul@355 | 1046 | self._span_end() |
paul@355 | 1047 | self._span_end() |
paul@353 | 1048 | |
paul@481 | 1049 | def visitLeftShift(self, node): |
paul@481 | 1050 | self._visitBinary(node, "lshift", "<<") |
paul@481 | 1051 | |
paul@353 | 1052 | visitList = visitAssList |
paul@353 | 1053 | |
paul@353 | 1054 | def visitListComp(self, node): |
paul@355 | 1055 | self._span_start("listcomp") |
paul@353 | 1056 | self.stream.write("[") |
paul@353 | 1057 | self.dispatch(node.expr) |
paul@353 | 1058 | for qual in node.quals: |
paul@353 | 1059 | self.dispatch(qual) |
paul@353 | 1060 | self.stream.write("]") |
paul@355 | 1061 | self._span_end() |
paul@353 | 1062 | |
paul@353 | 1063 | def visitListCompFor(self, node): |
paul@355 | 1064 | self._span_start("listcompfor") |
paul@365 | 1065 | self._keyword("for", 1) |
paul@355 | 1066 | self._span_start("item") |
paul@353 | 1067 | self.dispatch(node.assign) |
paul@355 | 1068 | self._span_end() |
paul@353 | 1069 | self._keyword("in", 1) |
paul@355 | 1070 | self._span_start("collection") |
paul@353 | 1071 | self.dispatch(node.list) |
paul@355 | 1072 | self._span_end() |
paul@353 | 1073 | for if_ in node.ifs: |
paul@353 | 1074 | self.dispatch(if_) |
paul@355 | 1075 | self._span_end() |
paul@353 | 1076 | |
paul@353 | 1077 | def visitListCompIf(self, node): |
paul@355 | 1078 | self._span_start("listcompif") |
paul@355 | 1079 | self._span_start("conditional") |
paul@353 | 1080 | self._keyword("if", 1) |
paul@353 | 1081 | self.dispatch(node.test) |
paul@355 | 1082 | self._span_end() |
paul@355 | 1083 | self._span_end() |
paul@353 | 1084 | |
paul@353 | 1085 | def visitMod(self, node): |
paul@353 | 1086 | self._visitBinary(node, "mod", "%") |
paul@353 | 1087 | |
paul@353 | 1088 | def visitMul(self, node): |
paul@353 | 1089 | self._visitBinary(node, "mul", "*") |
paul@353 | 1090 | |
paul@353 | 1091 | def visitName(self, node): |
paul@353 | 1092 | if hasattr(node, "_scope"): |
paul@353 | 1093 | scope = node._scope |
paul@353 | 1094 | self._name_start() |
paul@353 | 1095 | self.stream.write(node.name) |
paul@353 | 1096 | self._popup_start() |
paul@353 | 1097 | self._scope(scope) |
paul@353 | 1098 | self._popup_end() |
paul@353 | 1099 | self._name_end() |
paul@353 | 1100 | else: |
paul@355 | 1101 | self._span(node.name) |
paul@353 | 1102 | |
paul@358 | 1103 | def visitNot(self, node): |
paul@358 | 1104 | self._span_start("not") |
paul@358 | 1105 | self._keyword("not") |
paul@358 | 1106 | self.dispatch(node.expr) |
paul@358 | 1107 | self._span_end() |
paul@358 | 1108 | |
paul@358 | 1109 | def visitOr(self, node): |
paul@358 | 1110 | self._span_start("or") |
paul@358 | 1111 | first = 1 |
paul@358 | 1112 | for n in node.nodes: |
paul@358 | 1113 | if not first: |
paul@358 | 1114 | self._keyword("or", 1) |
paul@358 | 1115 | self.dispatch(n) |
paul@358 | 1116 | first = 0 |
paul@358 | 1117 | self._span_end() |
paul@358 | 1118 | |
paul@358 | 1119 | def visitPower(self, node): |
paul@371 | 1120 | self._visitBinary(node, "pow", "**") |
paul@358 | 1121 | |
paul@481 | 1122 | def visitRightShift(self, node): |
paul@481 | 1123 | self._visitBinary(node, "rshift", ">>") |
paul@481 | 1124 | |
paul@358 | 1125 | def visitSlice(self, node): |
paul@358 | 1126 | self._span_start("slice") |
paul@358 | 1127 | self.dispatch(node.expr) |
paul@358 | 1128 | self.stream.write("[") |
paul@358 | 1129 | if node.lower: |
paul@358 | 1130 | self.dispatch(node.lower) |
paul@358 | 1131 | self.stream.write(":") |
paul@358 | 1132 | if node.upper: |
paul@358 | 1133 | self.dispatch(node.upper) |
paul@358 | 1134 | # NOTE: Step? |
paul@358 | 1135 | self.stream.write("]") |
paul@358 | 1136 | self._span_end() |
paul@358 | 1137 | |
paul@358 | 1138 | def visitSliceobj(self, node): |
paul@358 | 1139 | self._span_start("sliceobj") |
paul@358 | 1140 | first = 1 |
paul@358 | 1141 | for n in node.nodes: |
paul@358 | 1142 | if not first: |
paul@358 | 1143 | self.stream.write(":") |
paul@358 | 1144 | self.dispatch(n) |
paul@358 | 1145 | self._span_end() |
paul@358 | 1146 | |
paul@358 | 1147 | def visitSub(self, node): |
paul@358 | 1148 | self._visitBinary(node, "sub", "-") |
paul@358 | 1149 | |
paul@358 | 1150 | def visitSubscript(self, node): |
paul@358 | 1151 | self._span_start("subscript") |
paul@358 | 1152 | self.dispatch(node.expr) |
paul@358 | 1153 | self.stream.write("[") |
paul@358 | 1154 | first = 1 |
paul@358 | 1155 | for sub in node.subs: |
paul@358 | 1156 | if not first: |
paul@358 | 1157 | self.stream.write(", ") |
paul@358 | 1158 | self.dispatch(sub) |
paul@358 | 1159 | first = 0 |
paul@358 | 1160 | self.stream.write("]") |
paul@358 | 1161 | self._span_end() |
paul@358 | 1162 | |
paul@358 | 1163 | visitTuple = visitAssTuple |
paul@358 | 1164 | |
paul@358 | 1165 | def visitUnaryAdd(self, node): |
paul@358 | 1166 | self._visitUnary(node, "add", "+") |
paul@358 | 1167 | |
paul@358 | 1168 | def visitUnarySub(self, node): |
paul@358 | 1169 | self._visitUnary(node, "sub", "-") |
paul@358 | 1170 | |
paul@320 | 1171 | # Output preparation methods. |
paul@320 | 1172 | |
paul@320 | 1173 | def _sequence(self, node): |
paul@320 | 1174 | first = 1 |
paul@320 | 1175 | for n in node.nodes: |
paul@320 | 1176 | if not first: |
paul@321 | 1177 | self.stream.write(", ") |
paul@320 | 1178 | self.dispatch(n) |
paul@320 | 1179 | first = 0 |
paul@320 | 1180 | |
paul@320 | 1181 | def _mapping(self, node): |
paul@320 | 1182 | first = 1 |
paul@320 | 1183 | for k, v in node.items: |
paul@320 | 1184 | if not first: |
paul@321 | 1185 | self.stream.write(", ") |
paul@320 | 1186 | self.dispatch(k) |
paul@321 | 1187 | self.stream.write(" : ") |
paul@320 | 1188 | self.dispatch(v) |
paul@320 | 1189 | first = 0 |
paul@320 | 1190 | |
paul@354 | 1191 | def _parameters(self, fn, node): |
paul@320 | 1192 | nparams = len(fn.positional_names) |
paul@320 | 1193 | ndefaults = len(fn.defaults) |
paul@320 | 1194 | first_with_default = nparams - ndefaults |
paul@320 | 1195 | |
paul@321 | 1196 | first = 1 |
paul@320 | 1197 | for n, param in enumerate(fn.positional_names): |
paul@320 | 1198 | if not first: |
paul@321 | 1199 | self.stream.write(", ") |
paul@370 | 1200 | |
paul@370 | 1201 | # Handle tuple parameters. |
paul@370 | 1202 | |
paul@370 | 1203 | if isinstance(param, tuple): |
paul@370 | 1204 | self._tuple_parameter(param, node) |
paul@370 | 1205 | else: |
paul@370 | 1206 | self._assname(param, node) |
paul@370 | 1207 | |
paul@320 | 1208 | n_default = n - first_with_default |
paul@320 | 1209 | if n_default >= 0: |
paul@320 | 1210 | self._default(fn.defaults[n_default]) |
paul@321 | 1211 | first = 0 |
paul@320 | 1212 | |
paul@320 | 1213 | if fn.has_star: |
paul@320 | 1214 | if not first: |
paul@321 | 1215 | self.stream.write(", *") |
paul@320 | 1216 | self._name(fn.star_name) |
paul@320 | 1217 | |
paul@320 | 1218 | if fn.has_dstar: |
paul@320 | 1219 | if not first: |
paul@321 | 1220 | self.stream.write(", **") |
paul@320 | 1221 | self._name(fn.dstar_name) |
paul@320 | 1222 | |
paul@370 | 1223 | def _tuple_parameter(self, parameters, node): |
paul@370 | 1224 | self.stream.write("(") |
paul@370 | 1225 | |
paul@370 | 1226 | first = 1 |
paul@370 | 1227 | for param in parameters: |
paul@370 | 1228 | if not first: |
paul@370 | 1229 | self.stream.write(", ") |
paul@370 | 1230 | |
paul@370 | 1231 | # Handle tuples. |
paul@370 | 1232 | |
paul@370 | 1233 | if isinstance(param, tuple): |
paul@370 | 1234 | self._tuple_parameter(param, node) |
paul@370 | 1235 | else: |
paul@370 | 1236 | self._assname(param, node) |
paul@370 | 1237 | |
paul@370 | 1238 | first = 0 |
paul@370 | 1239 | |
paul@370 | 1240 | self.stream.write(")") |
paul@370 | 1241 | |
paul@320 | 1242 | def _default(self, default): |
paul@321 | 1243 | self.stream.write("=") |
paul@320 | 1244 | self.dispatch(default) |
paul@320 | 1245 | |
paul@318 | 1246 | # Convenience functions. |
paul@318 | 1247 | |
paul@357 | 1248 | def summarise(module, program, filename): |
paul@318 | 1249 | stream = open(filename, "wb") |
paul@318 | 1250 | try: |
paul@357 | 1251 | summary = Summary(module, program) |
paul@320 | 1252 | summary.to_stream(stream) |
paul@320 | 1253 | finally: |
paul@320 | 1254 | stream.close() |
paul@320 | 1255 | |
paul@357 | 1256 | def annotate(module, program, filename): |
paul@320 | 1257 | stream = open(filename, "wb") |
paul@320 | 1258 | try: |
paul@357 | 1259 | source = AnnotatedSource(module, program) |
paul@320 | 1260 | source.to_stream(stream) |
paul@318 | 1261 | finally: |
paul@318 | 1262 | stream.close() |
paul@318 | 1263 | |
paul@480 | 1264 | def interfaces(program, filename): |
paul@480 | 1265 | stream = open(filename, "wb") |
paul@480 | 1266 | try: |
paul@480 | 1267 | source = Interfaces(program) |
paul@480 | 1268 | source.to_stream(stream) |
paul@480 | 1269 | finally: |
paul@480 | 1270 | stream.close() |
paul@480 | 1271 | |
paul@357 | 1272 | def report(program, directory): |
paul@353 | 1273 | if not exists(directory): |
paul@353 | 1274 | os.mkdir(directory) |
paul@353 | 1275 | |
paul@357 | 1276 | for module in program.get_importer().get_modules(): |
paul@357 | 1277 | annotate(module, program, join(directory, "%s%sxhtml" % (module.full_name(), extsep))) |
paul@357 | 1278 | summarise(module, program, join(directory, "%s-summary%sxhtml" % (module.full_name(), extsep))) |
paul@353 | 1279 | |
paul@480 | 1280 | interfaces(program, join(directory, "-interfaces%sxhtml" % extsep)) |
paul@480 | 1281 | |
paul@318 | 1282 | # vim: tabstop=4 expandtab shiftwidth=4 |