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