1 #!/usr/bin/env python 2 3 """ 4 The micropython package for processing Python source code. The code originates 5 from the simplify package but has had various details related to that package 6 removed. 7 8 Copyright (C) 2006, 2007, 2008, 2009, 2010 Paul Boddie <paul@boddie.org.uk> 9 10 This program is free software; you can redistribute it and/or modify it under 11 the terms of the GNU General Public License as published by the Free Software 12 Foundation; either version 3 of the License, or (at your option) any later 13 version. 14 15 This program is distributed in the hope that it will be useful, but WITHOUT 16 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS 17 FOR A PARTICULAR PURPOSE. See the GNU General Public License for more 18 details. 19 20 You should have received a copy of the GNU General Public License along with 21 this program. If not, see <http://www.gnu.org/licenses/>. 22 23 -------- 24 25 To use this module, an importer should be constructed. Here, the standard path 26 for module searching is employed: 27 28 importer = Importer(sys.path) 29 30 To generate programs, the above importer should be supplied in the 31 initialisation of a program instance, and then various methods are called: 32 33 program = Program(importer) 34 image = program.get_raw_image() 35 36 Such importer and program objects are the most convenient mechanism through 37 which the functionality of the micropython package may be accessed. 38 """ 39 40 from micropython.common import ProcessingError, TableGenerationError 41 import micropython.ast 42 import micropython.data 43 import micropython.opt 44 import micropython.inspect 45 import micropython.table 46 import os 47 48 try: 49 set 50 except NameError: 51 from sets import Set as set 52 53 class Program: 54 55 "This class supports the generation of a program image." 56 57 supported_optimisations = micropython.opt.Optimiser.supported_optimisations 58 59 def __init__(self, importer, optimisations=None): 60 61 """ 62 Initialise the program representation with an 'importer' which is able 63 to locate and load Python modules. 64 65 The optional 'optimisations' cause certain techniques to be used in 66 reducing program size and improving program efficiency. 67 """ 68 69 self.importer = importer 70 self.optimisations = optimisations or set() 71 72 # Remember the tables once generated. 73 74 self.objtable = None 75 self.paramtable = None 76 77 # Main program information. 78 79 self.code = None 80 self.code_location = None 81 82 def get_importer(self): 83 return self.importer 84 85 # Access to finalised program information. 86 87 def get_image(self, with_builtins=0): 88 89 """ 90 Return the program image including built-in objects if 'with_builtins' 91 is specified and set to a true value. 92 """ 93 94 if self.code is not None: 95 return self.code 96 97 objtable = self.get_object_table() 98 paramtable = self.get_parameter_table() 99 100 # Optimise and regenerate the object table. 101 102 self.importer.vacuum(objtable) 103 self.importer.finalise() 104 105 objtable = self.get_object_table(reset=1) 106 paramtable = self.get_parameter_table(reset=1) 107 108 self.code = [] 109 110 # Append constants to the image. 111 112 for const in self.importer.constants(): 113 self.code.append(const) 114 115 last_module = self.importer.modules_ordered[-1] 116 117 for module in self.importer.modules_ordered: 118 suppress_builtins = not with_builtins and module.name == "__builtins__" 119 120 # Position the module in the image and make a translation. 121 122 trans = micropython.ast.Translation(module, self) 123 124 # Add header details. 125 126 self.code.append(module) 127 128 # Append module attributes to the image. 129 130 attributes = module.module_attributes() 131 self.code += module.attributes_as_list() 132 133 # Append classes and functions to the image. 134 135 for obj in module.all_objects: 136 if isinstance(obj, micropython.inspect.Class): 137 138 # Add header details. 139 140 self.code.append(obj) 141 142 # Append class attributes to the image. 143 144 attributes = obj.class_attributes() 145 self.code += obj.attributes_as_list() 146 147 # Omit built-in function code where requested. 148 149 if suppress_builtins and obj.astnode.doc is None: 150 continue 151 152 # Generate the instantiator/initialiser. 153 # Append the function code to the image. 154 155 instantiator = obj.get_instantiator() 156 code = trans.get_instantiator_code(obj) 157 self.code += code 158 159 # Class-level code is generated separately at the module 160 # level, and the code location is set within the code 161 # generation process for the module. 162 163 elif isinstance(obj, micropython.inspect.Function): 164 165 # Add header details. 166 167 self.code.append(obj) 168 169 # Append any default values to the image. 170 # Only do this for functions which are not dynamic. 171 172 if not obj.is_dynamic(): 173 self.code += obj.default_attrs 174 175 # Omit built-in function code where requested. 176 177 if suppress_builtins and obj.astnode.doc is None: 178 pass 179 180 # Append the function code to the image. 181 182 else: 183 code = trans.get_code(obj) 184 self.code += code 185 186 # Omit built-in module code where requested. 187 188 if suppress_builtins: 189 pass 190 191 # Append the module top-level code to the image. 192 193 else: 194 code = trans.get_module_code() 195 self.code += code 196 197 return self.code 198 199 def get_raw_image(self, architecture=None, with_builtins=0): 200 201 "Return the raw image representation of the program." 202 203 architecture = architecture or micropython.rsvp 204 205 self.get_image(with_builtins) 206 207 objtable = self.get_object_table() 208 paramtable = self.get_parameter_table() 209 210 # Position the objects. 211 212 pos = 0 213 214 for item in self.code: 215 arch_item = architecture.get_object(item) 216 217 # Get the raw version for the architecture. 218 219 if arch_item is not None: 220 pos = arch_item.set_location(pos, with_builtins) 221 else: 222 pos += 1 223 224 # Generate the raw code. 225 226 self.raw_code = [] 227 228 for item in self.code: 229 arch_item = architecture.get_object(item) 230 231 # Get the raw version for the architecture. 232 233 if arch_item is not None: 234 self.raw_code += arch_item.as_raw(objtable, paramtable, with_builtins) 235 arch_item.finalise_location(with_builtins) 236 else: 237 self.raw_code.append(item) 238 239 # Fix the module locations. 240 241 for module in self.importer.modules_ordered: 242 243 if not with_builtins and module.name == "__builtins__": 244 continue 245 246 module.code_location = module.blocks[0].location 247 248 self.code_location = self.importer.modules["__main__"].code_location 249 return self.raw_code 250 251 def get_object_table(self, reset=0): 252 253 "Return a table with details of attributes for classes and modules." 254 255 if self.objtable is None or reset: 256 257 t = self.objtable = micropython.table.ObjectTable() 258 for module in self.importer.get_modules(): 259 t.add(module.full_name(), module.module_attributes()) 260 261 # Add class and instance attributes for all classes, together 262 # with descendant information. 263 264 for obj in module.all_objects: 265 if isinstance(obj, micropython.inspect.Class): 266 267 # Prevent ambiguous classes. 268 269 full_name = obj.full_name() 270 name = obj.name 271 272 if module.has_key(name) and module[name].defines_ambiguous_class(): 273 raise TableGenerationError, "Class %r in module %r is ambiguously defined." % (name, module.full_name()) 274 275 # Define a table entry for the class. 276 277 attributes = {full_name : obj} 278 attributes.update(obj.all_attributes()) 279 attributes.update(obj.all_descendants()) 280 t.add(full_name, attributes) 281 282 return self.objtable 283 284 def get_parameter_table(self, reset=0): 285 286 "Return a table with details of parameters for functions and methods." 287 288 # Need the object table to get at class details. 289 290 if self.paramtable is None or reset: 291 t = self.paramtable = micropython.table.ParameterTable() 292 293 # Visit each module, getting function and method details. 294 295 for module in self.importer.get_modules(): 296 for obj in module.all_objects: 297 if isinstance(obj, micropython.inspect.Function): 298 t.add(obj.full_name(), obj.parameters()) 299 300 # Classes are callable, too. 301 # Take details of the appropriate __init__ method to make an 302 # entry for an instantiation function for the class. 303 304 elif isinstance(obj, micropython.inspect.Class): 305 t.add(obj.get_instantiator().full_name(), obj.get_instantiator().parameters()) 306 307 # Filter out all parameter table entries not referenced by keyword 308 # arguments. 309 310 keyword_names = set() 311 312 for module in self.importer.get_modules(): 313 keyword_names.update(module.keyword_names) 314 315 for function_name, parameters in t.table.items(): 316 for name in parameters.keys(): 317 if name in keyword_names: 318 break 319 else: 320 del t.table[function_name] 321 322 return self.paramtable 323 324 class Importer: 325 326 "An import machine, searching for and loading modules." 327 328 predefined_constants = { 329 "None" : None, 330 "True" : True, 331 "False" : False, 332 #"Ellipsis" : Ellipsis, 333 "NotImplemented" : NotImplemented 334 } 335 336 names_always_used = [ 337 "bool", "__init__", "__call__", "__bool__" 338 ] 339 340 def __init__(self, path=None, verbose=0, optimisations=None): 341 342 """ 343 Initialise the importer with the given search 'path' - a list of 344 directories to search for Python modules. 345 346 The optional 'verbose' parameter causes output concerning the activities 347 of the object to be produced if set to a true value (not the default). 348 349 The optional 'optimisations' cause certain techniques to be used in 350 reducing program size and improving program efficiency. 351 """ 352 353 self.path = path or [os.getcwd()] 354 self.verbose = verbose 355 self.optimisations = optimisations or set() 356 357 self.modules = {} 358 self.modules_ordered = [] 359 self.loading = set() 360 361 # Constant records. 362 363 self.constant_values = {} 364 self.constant_list = None # cache for constants 365 self.init_predefined_constants() 366 367 # Attribute usage. 368 369 self.attributes_used = {} 370 self.name_references = {} 371 self.specific_name_references = {} 372 self.attribute_users_visited = set() 373 374 # Status information. 375 376 self.vacuumed = 0 377 self.finalised = 0 378 379 def get_modules(self): 380 381 "Return all modules known to the importer." 382 383 return self.modules.values() 384 385 def get_module(self, name): 386 387 "Return the module with the given 'name'." 388 389 return self.modules[name] 390 391 # General maintenance. 392 393 def vacuum(self, objtable): 394 395 "Tidy up the modules." 396 397 if self.vacuumed: 398 return 399 400 # Complete the list of attribute names used in the program. 401 402 self.collect_attributes(objtable) 403 404 for name, module in self.modules.items(): 405 if module.loaded: 406 module.vacuum() 407 else: 408 del self.modules[name] 409 410 self.vacuumed = 1 411 412 def finalise(self): 413 414 "Finalise the program (which should have been vacuumed first)." 415 416 if self.finalised: 417 return 418 419 # Reset any previously compiled information. 420 421 for module in self.get_modules(): 422 module.unfinalise() 423 424 # Prepare module information again. 425 426 for module in self.get_modules(): 427 module.finalise() 428 429 self.finalised = 1 430 431 # Name accounting. 432 433 def use_name(self, name, from_name): 434 435 """ 436 Register the given 'name' as being used in the program from within an 437 object with the specified 'from_name'. 438 """ 439 440 if not self.name_references.has_key(from_name): 441 self.name_references[from_name] = set() 442 self.name_references[from_name].add((name,)) 443 444 def use_names(self, names, from_name): 445 446 """ 447 Register the given 'names' as being used in the program from within an 448 object with the specified 'from_name'. 449 """ 450 451 if not self.name_references.has_key(from_name): 452 self.name_references[from_name] = set() 453 self.name_references[from_name].add(names) 454 455 def use_specific_name(self, objname, attrname, from_name): 456 457 """ 458 Register the given 'objname' (for an object) whose 'attrname' is being 459 used in the program from within an object with the specified 460 'from_name'. 461 """ 462 463 if not self.specific_name_references.has_key(from_name): 464 self.specific_name_references[from_name] = set() 465 self.specific_name_references[from_name].add((objname, attrname)) 466 467 # Name accounting products. 468 469 def uses_attribute(self, obj, name): 470 471 """ 472 Return whether the attribute of object 'obj' having the given 'name' is 473 used as an attribute in the program. 474 """ 475 476 return name in self.attributes_used.get(obj.full_name(), []) 477 478 def use_attribute(self, objname, name): 479 480 """ 481 Indicate that in the object with the given 'objname', the attribute of 482 the given 'name' is used. 483 """ 484 485 if not self.attributes_used.has_key(objname): 486 self.attributes_used[objname] = set() 487 self.attributes_used[objname].add(name) 488 489 def collect_attributes(self, objtable): 490 491 "Collect attribute references for the entire program." 492 493 # Start with the "root" modules, finding referenced objects. 494 495 self._collect_attributes("__builtins__", objtable) 496 self._collect_attributes("__main__", objtable) 497 498 # Include names which may not be explicitly used in programs. 499 # NOTE: Potentially declare these when inspecting. 500 501 for attrname in self.names_always_used: 502 for objname in objtable.all_possible_objects([attrname]): 503 self.use_attribute(objname, attrname) 504 self._collect_attributes(objname + "." + attrname, objtable) 505 506 def _collect_attributes(self, from_name, objtable): 507 508 """ 509 Given an object called 'from_name', find all names referenced from such 510 an object according to the register of names. 511 """ 512 513 if from_name in self.attribute_users_visited: 514 return 515 516 self.attribute_users_visited.add(from_name) 517 518 # Get name references and find possible objects which support such 519 # combinations of attribute names. 520 521 for names in self.name_references.get(from_name, []): 522 objnames = objtable.all_possible_objects(names) 523 if not objnames: 524 print "Warning: usage in %r finds no object supporting all attributes %r" % (from_name, names) 525 objnames = objtable.any_possible_objects(names) 526 if not objnames: 527 print "Warning: usage in %r finds no object supporting any attributes %r" % (from_name, names) 528 529 for objname in objnames: 530 for name in names: 531 self.use_attribute(objname, name) 532 self._collect_attributes(objname + "." + name, objtable) 533 534 # Get specific name references and visit the referenced objects. 535 536 for objname, attrname in self.specific_name_references.get(from_name, []): 537 self.use_attribute(objname, attrname) 538 self._collect_attributes(objname + "." + attrname, objtable) 539 540 # Where the object has an __init__ attribute, assume that it is an 541 # initialiser which is called at some point, and collect attributes used 542 # in this initialiser. 543 544 if "__init__" in objtable.table.get(from_name, []): 545 self._collect_attributes(from_name + ".__init__", objtable) 546 547 # Constant accounting. 548 549 def init_predefined_constants(self): 550 551 "Ensure the predefined constants." 552 553 for name, value in self.predefined_constants.items(): 554 self.make_constant(value) 555 556 def get_predefined_constant(self, name): 557 558 "Return the predefined constant for the given 'name'." 559 560 return self.make_constant(self.predefined_constants[name]) 561 562 def get_constant(self, value): 563 564 "Return a constant for the given 'value'." 565 566 const = micropython.data.Const(value) 567 return self.constant_values[const] 568 569 def get_constant_type_name(self, value): 570 return value.__class__.__name__ 571 572 def make_constant(self, value): 573 574 "Make and return a constant for the given 'value'." 575 576 # Ensure the presence of the constant's type. 577 578 name = self.get_constant_type_name(value) 579 if self.modules.has_key("__builtins__"): 580 attr = self.modules["__builtins__"].get(name) 581 582 # Make a constant object and return it. 583 584 const = micropython.data.Const(value) 585 if not self.constant_values.has_key(const): 586 self.constant_values[const] = const 587 return self.constant_values[const] 588 589 def constants(self): 590 591 "Return a list of constants." 592 593 if self.constant_list is None: 594 self.constant_list = list(self.constant_values.values()) 595 596 return self.constant_list 597 598 # Import methods. 599 600 def find_in_path(self, name): 601 602 """ 603 Find the given module 'name' in the search path, returning None where no 604 such module could be found, or a 2-tuple from the 'find' method 605 otherwise. 606 """ 607 608 for d in self.path: 609 m = self.find(d, name) 610 if m: return m 611 return None 612 613 def find(self, d, name): 614 615 """ 616 In the directory 'd', find the given module 'name', where 'name' can 617 either refer to a single file module or to a package. Return None if the 618 'name' cannot be associated with either a file or a package directory, 619 or a 2-tuple from '_find_package' or '_find_module' otherwise. 620 """ 621 622 m = self._find_package(d, name) 623 if m: return m 624 m = self._find_module(d, name) 625 if m: return m 626 return None 627 628 def _find_module(self, d, name): 629 630 """ 631 In the directory 'd', find the given module 'name', returning None where 632 no suitable file exists in the directory, or a 2-tuple consisting of 633 None (indicating that no package directory is involved) and a filename 634 indicating the location of the module. 635 """ 636 637 name_py = name + os.extsep + "py" 638 filename = self._find_file(d, name_py) 639 if filename: 640 return None, filename 641 return None 642 643 def _find_package(self, d, name): 644 645 """ 646 In the directory 'd', find the given package 'name', returning None 647 where no suitable package directory exists, or a 2-tuple consisting of 648 a directory (indicating the location of the package directory itself) 649 and a filename indicating the location of the __init__.py module which 650 declares the package's top-level contents. 651 """ 652 653 filename = self._find_file(d, name) 654 if filename: 655 init_py = "__init__" + os.path.extsep + "py" 656 init_py_filename = self._find_file(filename, init_py) 657 if init_py_filename: 658 return filename, init_py_filename 659 return None 660 661 def _find_file(self, d, filename): 662 663 """ 664 Return the filename obtained when searching the directory 'd' for the 665 given 'filename', or None if no actual file exists for the filename. 666 """ 667 668 filename = os.path.join(d, filename) 669 if os.path.exists(filename): 670 return filename 671 else: 672 return None 673 674 def load(self, name, return_leaf=0): 675 676 """ 677 Load the module or package with the given 'name'. Return an object 678 referencing the loaded module or package, or None if no such module or 679 package exists. 680 """ 681 682 if self.modules.has_key(name) and self.modules[name].loaded: 683 #print "Cached (%s)" % name 684 return self.modules[name] 685 if self.verbose: 686 print "Loading", name 687 688 # Split the name into path components, and try to find the uppermost in 689 # the search path. 690 691 path = name.split(".") 692 m = self.find_in_path(path[0]) 693 if not m: 694 if self.verbose: 695 print "Not found (%s)" % path[0] 696 return None # NOTE: Import error. 697 d, filename = m 698 699 # Either acquire a reference to an already-imported module, or load the 700 # module from a file. 701 702 top = module = self.load_from_file(filename, path[0]) 703 704 # For hierarchical names, traverse each path component... 705 706 if len(path) > 1: 707 if not d: 708 if self.verbose: 709 print "No package (%s)" % filename 710 return None # NOTE: Import error (package not found). 711 else: 712 self.add_submodules(d, module) 713 714 path_so_far = path[:1] 715 for p in path[1:]: 716 path_so_far.append(p) 717 718 # Find the package or module concerned. 719 720 m = self.find(d, p) 721 if not m: 722 if self.verbose: 723 print "Not found (%s)" % p 724 return None # NOTE: Import error. 725 d, filename = m 726 module_name = ".".join(path_so_far) 727 728 # Either reference an imported module or load one from a file. 729 730 submodule = self.load_from_file(filename, module_name) 731 732 if d: 733 self.add_submodules(d, module) 734 735 # Store the submodule within its parent module. 736 737 module.set_module(p, submodule) 738 module = submodule 739 740 # Return either the deepest or the uppermost module. 741 742 if return_leaf: 743 return module 744 else: 745 return top 746 747 def load_from_file(self, name, module_name=None): 748 749 """ 750 Load the module with the given 'name' (which may be a full module path). 751 """ 752 753 if module_name is None: 754 module_name = "__main__" 755 756 module = self.add_module(module_name) 757 if not module.loaded and module not in self.loading: 758 self.loading.add(module) 759 #print "Parsing", name 760 module.parse(name) 761 #print "Done", name 762 self.loading.remove(module) 763 module.loaded = 1 764 765 # Record the module. 766 767 #print "Loaded", module_name, "with namespace", module.namespace.keys() 768 return module 769 770 def add_module(self, module_name): 771 772 """ 773 Return the module with the given 'module_name', adding a new module 774 object if one does not already exist. 775 """ 776 777 if not self.modules.has_key(module_name): 778 self.modules[module_name] = module = micropython.inspect.InspectedModule(module_name, self) 779 self.modules_ordered.append(module) 780 else: 781 module = self.modules[module_name] 782 return module 783 784 def add_submodules(self, pathname, module): 785 786 """ 787 Work around insufficient __all__ declarations and examine the directory 788 with the given 'pathname', adding submodules to the given 'module'. 789 """ 790 791 for filename in os.listdir(pathname): 792 submodule, ext = os.path.splitext(filename) 793 if ext not in ("", ".py"): 794 continue 795 module.set_module(submodule, self.add_module(module.name + "." + submodule)) 796 797 # vim: tabstop=4 expandtab shiftwidth=4