| paul@0 | 1 | #!/usr/bin/env python |
| paul@0 | 2 | |
| paul@0 | 3 | """ |
| paul@0 | 4 | Inspect and obtain module structure. |
| paul@0 | 5 | |
| paul@0 | 6 | Copyright (C) 2007, 2008, 2009, 2010, 2011, 2012, 2013, |
| paul@0 | 7 | 2014, 2015, 2016 Paul Boddie <paul@boddie.org.uk> |
| paul@0 | 8 | |
| paul@0 | 9 | This program is free software; you can redistribute it and/or modify it under |
| paul@0 | 10 | the terms of the GNU General Public License as published by the Free Software |
| paul@0 | 11 | Foundation; either version 3 of the License, or (at your option) any later |
| paul@0 | 12 | version. |
| paul@0 | 13 | |
| paul@0 | 14 | This program is distributed in the hope that it will be useful, but WITHOUT |
| paul@0 | 15 | ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS |
| paul@0 | 16 | FOR A PARTICULAR PURPOSE. See the GNU General Public License for more |
| paul@0 | 17 | details. |
| paul@0 | 18 | |
| paul@0 | 19 | You should have received a copy of the GNU General Public License along with |
| paul@0 | 20 | this program. If not, see <http://www.gnu.org/licenses/>. |
| paul@0 | 21 | """ |
| paul@0 | 22 | |
| paul@0 | 23 | from branching import BranchTracker |
| paul@12 | 24 | from common import get_argnames, init_item, predefined_constants |
| paul@26 | 25 | from modules import BasicModule, CacheWritingModule, InspectionNaming |
| paul@3 | 26 | from errors import InspectError |
| paul@0 | 27 | from referencing import Reference |
| paul@12 | 28 | from resolving import NameResolving |
| paul@12 | 29 | from results import AccessRef, InstanceRef, InvocationRef, LiteralSequenceRef, \ |
| paul@12 | 30 | LocalNameRef, NameRef, ResolvedNameRef |
| paul@0 | 31 | import compiler |
| paul@0 | 32 | import sys |
| paul@0 | 33 | |
| paul@26 | 34 | class InspectedModule(BasicModule, CacheWritingModule, NameResolving, InspectionNaming): |
| paul@0 | 35 | |
| paul@0 | 36 | "A module inspector." |
| paul@0 | 37 | |
| paul@0 | 38 | def __init__(self, name, importer): |
| paul@13 | 39 | |
| paul@13 | 40 | "Initialise the module with basic details." |
| paul@13 | 41 | |
| paul@0 | 42 | BasicModule.__init__(self, name, importer) |
| paul@12 | 43 | |
| paul@0 | 44 | self.in_class = False |
| paul@0 | 45 | self.in_conditional = False |
| paul@0 | 46 | self.global_attr_accesses = {} |
| paul@0 | 47 | |
| paul@0 | 48 | # Usage tracking. |
| paul@0 | 49 | |
| paul@0 | 50 | self.trackers = [] |
| paul@0 | 51 | self.attr_accessor_branches = {} |
| paul@0 | 52 | |
| paul@0 | 53 | def __repr__(self): |
| paul@0 | 54 | return "InspectedModule(%r, %r)" % (self.name, self.importer) |
| paul@0 | 55 | |
| paul@27 | 56 | # Principal methods. |
| paul@27 | 57 | |
| paul@0 | 58 | def parse(self, filename): |
| paul@0 | 59 | |
| paul@0 | 60 | "Parse the file having the given 'filename'." |
| paul@0 | 61 | |
| paul@0 | 62 | self.parse_file(filename) |
| paul@0 | 63 | |
| paul@0 | 64 | # Inspect the module. |
| paul@0 | 65 | |
| paul@0 | 66 | self.start_tracking_in_module() |
| paul@0 | 67 | |
| paul@0 | 68 | # Detect and record imports and globals declared in the module. |
| paul@0 | 69 | |
| paul@0 | 70 | self.assign_general_local("__name__", self.get_constant("str", self.name)) |
| paul@0 | 71 | self.assign_general_local("__file__", self.get_constant("str", filename)) |
| paul@0 | 72 | self.process_structure(self.astnode) |
| paul@0 | 73 | |
| paul@0 | 74 | # Set the class of the module after the definition has occurred. |
| paul@0 | 75 | |
| paul@0 | 76 | ref = self.get_builtin("object") |
| paul@0 | 77 | self.set_name("__class__", ref) |
| paul@0 | 78 | |
| paul@0 | 79 | # Get module-level attribute usage details. |
| paul@0 | 80 | |
| paul@0 | 81 | self.stop_tracking_in_module() |
| paul@0 | 82 | |
| paul@27 | 83 | # Collect external name references. |
| paul@0 | 84 | |
| paul@27 | 85 | self.collect_names() |
| paul@0 | 86 | |
| paul@12 | 87 | def complete(self): |
| paul@0 | 88 | |
| paul@12 | 89 | "Complete the module inspection." |
| paul@0 | 90 | |
| paul@12 | 91 | # Resolve names not definitively mapped to objects. |
| paul@0 | 92 | |
| paul@12 | 93 | self.resolve() |
| paul@0 | 94 | |
| paul@12 | 95 | # Define the invocation requirements in each namespace. |
| paul@0 | 96 | |
| paul@12 | 97 | self.set_invocation_usage() |
| paul@0 | 98 | |
| paul@12 | 99 | # Propagate to the importer information needed in subsequent activities. |
| paul@0 | 100 | |
| paul@12 | 101 | self.propagate() |
| paul@0 | 102 | |
| paul@27 | 103 | # Accessory methods. |
| paul@0 | 104 | |
| paul@27 | 105 | def collect_names(self): |
| paul@0 | 106 | |
| paul@27 | 107 | "Collect the names used by each scope." |
| paul@0 | 108 | |
| paul@0 | 109 | for path in self.names_used.keys(): |
| paul@27 | 110 | self.collect_names_for_path(path) |
| paul@27 | 111 | |
| paul@27 | 112 | def collect_names_for_path(self, path): |
| paul@0 | 113 | |
| paul@33 | 114 | """ |
| paul@33 | 115 | Collect the names used by the given 'path'. These are propagated to the |
| paul@33 | 116 | importer in advance of any dependency resolution. |
| paul@33 | 117 | """ |
| paul@0 | 118 | |
| paul@0 | 119 | names = self.names_used.get(path) |
| paul@0 | 120 | if not names: |
| paul@0 | 121 | return |
| paul@0 | 122 | |
| paul@0 | 123 | in_function = self.function_locals.has_key(path) |
| paul@0 | 124 | |
| paul@0 | 125 | for name in names: |
| paul@0 | 126 | if name in predefined_constants or in_function and name in self.function_locals[path]: |
| paul@0 | 127 | continue |
| paul@0 | 128 | |
| paul@35 | 129 | # Find local definitions (within dynamic namespaces). |
| paul@0 | 130 | |
| paul@0 | 131 | key = "%s.%s" % (path, name) |
| paul@27 | 132 | ref = self.get_resolved_object(key) |
| paul@0 | 133 | if ref: |
| paul@40 | 134 | self.set_name_reference(key, ref) |
| paul@0 | 135 | continue |
| paul@0 | 136 | |
| paul@40 | 137 | # Find global or known built-in definitions. |
| paul@0 | 138 | |
| paul@27 | 139 | ref = self.get_resolved_global_or_builtin(name) |
| paul@27 | 140 | if ref: |
| paul@40 | 141 | self.set_name_reference(key, ref) |
| paul@0 | 142 | continue |
| paul@0 | 143 | |
| paul@40 | 144 | # Find presumed built-in definitions. |
| paul@0 | 145 | |
| paul@40 | 146 | ref = self.get_builtin(name) |
| paul@40 | 147 | self.set_name_reference(key, ref) |
| paul@0 | 148 | |
| paul@40 | 149 | def set_name_reference(self, path, ref): |
| paul@0 | 150 | |
| paul@40 | 151 | "Map the given name 'path' to 'ref'." |
| paul@0 | 152 | |
| paul@40 | 153 | self.importer.all_name_references[path] = self.name_references[path] = ref |
| paul@0 | 154 | |
| paul@27 | 155 | def get_resolved_global_or_builtin(self, name): |
| paul@0 | 156 | |
| paul@27 | 157 | "Return the resolved global or built-in object with the given 'name'." |
| paul@0 | 158 | |
| paul@40 | 159 | # In some circumstances, the name is neither global nor recognised by |
| paul@40 | 160 | # the importer. It is then assumed to be a general built-in. |
| paul@0 | 161 | |
| paul@40 | 162 | return self.get_global(name) or \ |
| paul@40 | 163 | self.importer.get_object("__builtins__.%s" % name) |
| paul@0 | 164 | |
| paul@0 | 165 | # Module structure traversal. |
| paul@0 | 166 | |
| paul@0 | 167 | def process_structure_node(self, n): |
| paul@0 | 168 | |
| paul@0 | 169 | "Process the individual node 'n'." |
| paul@0 | 170 | |
| paul@0 | 171 | # Module global detection. |
| paul@0 | 172 | |
| paul@0 | 173 | if isinstance(n, compiler.ast.Global): |
| paul@0 | 174 | self.process_global_node(n) |
| paul@0 | 175 | |
| paul@0 | 176 | # Module import declarations. |
| paul@0 | 177 | |
| paul@0 | 178 | elif isinstance(n, compiler.ast.From): |
| paul@0 | 179 | self.process_from_node(n) |
| paul@0 | 180 | |
| paul@0 | 181 | elif isinstance(n, compiler.ast.Import): |
| paul@0 | 182 | self.process_import_node(n) |
| paul@0 | 183 | |
| paul@0 | 184 | # Nodes using operator module functions. |
| paul@0 | 185 | |
| paul@0 | 186 | elif isinstance(n, compiler.ast.Operator): |
| paul@0 | 187 | return self.process_operator_node(n) |
| paul@0 | 188 | |
| paul@0 | 189 | elif isinstance(n, compiler.ast.AugAssign): |
| paul@0 | 190 | self.process_augassign_node(n) |
| paul@0 | 191 | |
| paul@0 | 192 | elif isinstance(n, compiler.ast.Compare): |
| paul@0 | 193 | return self.process_compare_node(n) |
| paul@0 | 194 | |
| paul@0 | 195 | elif isinstance(n, compiler.ast.Slice): |
| paul@0 | 196 | return self.process_slice_node(n) |
| paul@0 | 197 | |
| paul@0 | 198 | elif isinstance(n, compiler.ast.Sliceobj): |
| paul@0 | 199 | return self.process_sliceobj_node(n) |
| paul@0 | 200 | |
| paul@0 | 201 | elif isinstance(n, compiler.ast.Subscript): |
| paul@0 | 202 | return self.process_subscript_node(n) |
| paul@0 | 203 | |
| paul@0 | 204 | # Namespaces within modules. |
| paul@0 | 205 | |
| paul@0 | 206 | elif isinstance(n, compiler.ast.Class): |
| paul@0 | 207 | self.process_class_node(n) |
| paul@0 | 208 | |
| paul@0 | 209 | elif isinstance(n, compiler.ast.Function): |
| paul@0 | 210 | self.process_function_node(n, n.name) |
| paul@0 | 211 | |
| paul@0 | 212 | elif isinstance(n, compiler.ast.Lambda): |
| paul@0 | 213 | return self.process_lambda_node(n) |
| paul@0 | 214 | |
| paul@0 | 215 | # Assignments. |
| paul@0 | 216 | |
| paul@0 | 217 | elif isinstance(n, compiler.ast.Assign): |
| paul@0 | 218 | |
| paul@0 | 219 | # Handle each assignment node. |
| paul@0 | 220 | |
| paul@0 | 221 | for node in n.nodes: |
| paul@0 | 222 | self.process_assignment_node(node, n.expr) |
| paul@0 | 223 | |
| paul@0 | 224 | # Assignments within non-Assign nodes. |
| paul@0 | 225 | |
| paul@0 | 226 | elif isinstance(n, compiler.ast.AssName): |
| paul@0 | 227 | self.process_assignment_node(n, None) |
| paul@0 | 228 | |
| paul@0 | 229 | elif isinstance(n, compiler.ast.AssAttr): |
| paul@0 | 230 | self.process_attribute_access(n) |
| paul@0 | 231 | |
| paul@0 | 232 | # Accesses. |
| paul@0 | 233 | |
| paul@0 | 234 | elif isinstance(n, compiler.ast.Getattr): |
| paul@0 | 235 | return self.process_attribute_access(n) |
| paul@0 | 236 | |
| paul@0 | 237 | # Name recording for later testing. |
| paul@0 | 238 | |
| paul@0 | 239 | elif isinstance(n, compiler.ast.Name): |
| paul@0 | 240 | return self.process_name_node(n) |
| paul@0 | 241 | |
| paul@0 | 242 | # Conditional statement tracking. |
| paul@0 | 243 | |
| paul@0 | 244 | elif isinstance(n, compiler.ast.For): |
| paul@0 | 245 | self.process_for_node(n) |
| paul@0 | 246 | |
| paul@0 | 247 | elif isinstance(n, compiler.ast.While): |
| paul@0 | 248 | self.process_while_node(n) |
| paul@0 | 249 | |
| paul@0 | 250 | elif isinstance(n, compiler.ast.If): |
| paul@0 | 251 | self.process_if_node(n) |
| paul@0 | 252 | |
| paul@0 | 253 | elif isinstance(n, (compiler.ast.And, compiler.ast.Or)): |
| paul@0 | 254 | return self.process_logical_node(n) |
| paul@0 | 255 | |
| paul@0 | 256 | # Exception control-flow tracking. |
| paul@0 | 257 | |
| paul@0 | 258 | elif isinstance(n, compiler.ast.TryExcept): |
| paul@0 | 259 | self.process_try_node(n) |
| paul@0 | 260 | |
| paul@0 | 261 | elif isinstance(n, compiler.ast.TryFinally): |
| paul@0 | 262 | self.process_try_finally_node(n) |
| paul@0 | 263 | |
| paul@0 | 264 | # Control-flow modification statements. |
| paul@0 | 265 | |
| paul@0 | 266 | elif isinstance(n, compiler.ast.Break): |
| paul@0 | 267 | self.trackers[-1].suspend_broken_branch() |
| paul@0 | 268 | |
| paul@0 | 269 | elif isinstance(n, compiler.ast.Continue): |
| paul@0 | 270 | self.trackers[-1].suspend_continuing_branch() |
| paul@0 | 271 | |
| paul@0 | 272 | elif isinstance(n, compiler.ast.Raise): |
| paul@0 | 273 | self.process_structure(n) |
| paul@0 | 274 | self.trackers[-1].abandon_branch() |
| paul@0 | 275 | |
| paul@0 | 276 | elif isinstance(n, compiler.ast.Return): |
| paul@0 | 277 | self.process_structure(n) |
| paul@0 | 278 | self.trackers[-1].abandon_returning_branch() |
| paul@0 | 279 | |
| paul@0 | 280 | # Invocations. |
| paul@0 | 281 | |
| paul@0 | 282 | elif isinstance(n, compiler.ast.CallFunc): |
| paul@0 | 283 | return self.process_invocation_node(n) |
| paul@0 | 284 | |
| paul@0 | 285 | # Constant usage. |
| paul@0 | 286 | |
| paul@0 | 287 | elif isinstance(n, compiler.ast.Const): |
| paul@0 | 288 | return self.get_literal_instance(n, n.value.__class__.__name__) |
| paul@0 | 289 | |
| paul@0 | 290 | elif isinstance(n, compiler.ast.Dict): |
| paul@0 | 291 | return self.get_literal_instance(n, "dict") |
| paul@0 | 292 | |
| paul@0 | 293 | elif isinstance(n, compiler.ast.List): |
| paul@0 | 294 | return self.get_literal_instance(n, "list") |
| paul@0 | 295 | |
| paul@0 | 296 | elif isinstance(n, compiler.ast.Tuple): |
| paul@0 | 297 | return self.get_literal_instance(n, "tuple") |
| paul@0 | 298 | |
| paul@3 | 299 | # Unsupported nodes. |
| paul@3 | 300 | |
| paul@3 | 301 | elif isinstance(n, compiler.ast.GenExpr): |
| paul@3 | 302 | raise InspectError("Generator expressions are not supported.", self.get_namespace_path(), n) |
| paul@3 | 303 | |
| paul@3 | 304 | elif isinstance(n, compiler.ast.IfExp): |
| paul@3 | 305 | raise InspectError("If-else expressions are not supported.", self.get_namespace_path(), n) |
| paul@0 | 306 | |
| paul@0 | 307 | elif isinstance(n, compiler.ast.ListComp): |
| paul@3 | 308 | raise InspectError("List comprehensions are not supported.", self.get_namespace_path(), n) |
| paul@0 | 309 | |
| paul@0 | 310 | # All other nodes are processed depth-first. |
| paul@0 | 311 | |
| paul@0 | 312 | else: |
| paul@0 | 313 | self.process_structure(n) |
| paul@0 | 314 | |
| paul@0 | 315 | # By default, no expression details are returned. |
| paul@0 | 316 | |
| paul@0 | 317 | return None |
| paul@0 | 318 | |
| paul@0 | 319 | # Specific node handling. |
| paul@0 | 320 | |
| paul@0 | 321 | def process_assignment_node(self, n, expr): |
| paul@0 | 322 | |
| paul@0 | 323 | "Process the individual node 'n' to be assigned the contents of 'expr'." |
| paul@0 | 324 | |
| paul@0 | 325 | # Names and attributes are assigned the entire expression. |
| paul@0 | 326 | |
| paul@0 | 327 | if isinstance(n, compiler.ast.AssName): |
| paul@61 | 328 | if n.name == "self": |
| paul@61 | 329 | raise InspectError("Redefinition of self is not allowed.", self.get_namespace_path(), n) |
| paul@0 | 330 | |
| paul@0 | 331 | name_ref = expr and self.process_structure_node(expr) |
| paul@0 | 332 | |
| paul@0 | 333 | # Name assignments populate either function namespaces or the |
| paul@0 | 334 | # general namespace hierarchy. |
| paul@0 | 335 | |
| paul@0 | 336 | self.assign_general_local(n.name, name_ref) |
| paul@0 | 337 | |
| paul@0 | 338 | # Record usage of the name. |
| paul@0 | 339 | |
| paul@0 | 340 | self.record_name(n.name) |
| paul@0 | 341 | |
| paul@0 | 342 | elif isinstance(n, compiler.ast.AssAttr): |
| paul@0 | 343 | if expr: self.process_structure_node(expr) |
| paul@0 | 344 | self.process_attribute_access(n) |
| paul@0 | 345 | |
| paul@0 | 346 | # Lists and tuples are matched against the expression and their |
| paul@0 | 347 | # items assigned to expression items. |
| paul@0 | 348 | |
| paul@0 | 349 | elif isinstance(n, (compiler.ast.AssList, compiler.ast.AssTuple)): |
| paul@0 | 350 | self.process_assignment_node_items(n, expr) |
| paul@0 | 351 | |
| paul@0 | 352 | # Slices and subscripts are permitted within assignment nodes. |
| paul@0 | 353 | |
| paul@0 | 354 | elif isinstance(n, compiler.ast.Slice): |
| paul@0 | 355 | self.process_slice_node(n, expr) |
| paul@0 | 356 | |
| paul@0 | 357 | elif isinstance(n, compiler.ast.Subscript): |
| paul@0 | 358 | self.process_subscript_node(n, expr) |
| paul@0 | 359 | |
| paul@0 | 360 | def process_attribute_access(self, n): |
| paul@0 | 361 | |
| paul@0 | 362 | "Process the given attribute access node 'n'." |
| paul@0 | 363 | |
| paul@0 | 364 | # Obtain any completed chain and return the reference to it. |
| paul@0 | 365 | |
| paul@0 | 366 | name_ref = self.process_attribute_chain(n) |
| paul@0 | 367 | if self.have_access_expression(n): |
| paul@0 | 368 | return name_ref |
| paul@0 | 369 | |
| paul@0 | 370 | # Where the start of the chain of attributes has been reached, determine |
| paul@0 | 371 | # the complete access. |
| paul@0 | 372 | |
| paul@0 | 373 | # Given a non-access node, this chain can be handled in its entirety, |
| paul@0 | 374 | # either being name-based and thus an access rooted on a name, or being |
| paul@0 | 375 | # based on some other node and thus an anonymous access of some kind. |
| paul@0 | 376 | |
| paul@0 | 377 | path = self.get_namespace_path() |
| paul@0 | 378 | |
| paul@0 | 379 | # Start with the the full attribute chain. |
| paul@0 | 380 | |
| paul@0 | 381 | remaining = self.attrs |
| paul@0 | 382 | attrnames = ".".join(remaining) |
| paul@0 | 383 | |
| paul@0 | 384 | # If the accessor cannot be identified, or where attributes |
| paul@0 | 385 | # remain in an attribute chain, record the anonymous accesses. |
| paul@0 | 386 | |
| paul@0 | 387 | if not isinstance(name_ref, NameRef): # includes ResolvedNameRef |
| paul@0 | 388 | |
| paul@0 | 389 | assignment = isinstance(n, compiler.ast.AssAttr) |
| paul@0 | 390 | |
| paul@0 | 391 | init_item(self.attr_accesses, path, set) |
| paul@0 | 392 | self.attr_accesses[path].add(attrnames) |
| paul@0 | 393 | |
| paul@0 | 394 | self.record_access_details(None, attrnames, assignment) |
| paul@0 | 395 | del self.attrs[0] |
| paul@0 | 396 | return |
| paul@0 | 397 | |
| paul@0 | 398 | # Name-based accesses will handle the first attribute in a |
| paul@0 | 399 | # chain. |
| paul@0 | 400 | |
| paul@0 | 401 | else: |
| paul@0 | 402 | attrname = remaining[0] |
| paul@0 | 403 | |
| paul@0 | 404 | # Attribute assignments are used to identify instance attributes. |
| paul@0 | 405 | |
| paul@0 | 406 | if isinstance(n, compiler.ast.AssAttr) and \ |
| paul@0 | 407 | self.in_class and self.in_function and n.expr.name == "self": |
| paul@0 | 408 | |
| paul@0 | 409 | self.set_instance_attr(attrname) |
| paul@0 | 410 | |
| paul@0 | 411 | # Record attribute usage using any name local to this namespace, |
| paul@0 | 412 | # if assigned in the namespace, or using an external name |
| paul@0 | 413 | # (presently just globals within classes). |
| paul@0 | 414 | |
| paul@0 | 415 | name = self.get_name_for_tracking(name_ref.name, name_ref.final()) |
| paul@0 | 416 | tracker = self.trackers[-1] |
| paul@0 | 417 | |
| paul@0 | 418 | immediate_access = len(self.attrs) == 1 |
| paul@0 | 419 | assignment = immediate_access and isinstance(n, compiler.ast.AssAttr) |
| paul@0 | 420 | |
| paul@0 | 421 | del self.attrs[0] |
| paul@0 | 422 | |
| paul@0 | 423 | # Record global-based chains for subsequent resolution. |
| paul@0 | 424 | |
| paul@0 | 425 | is_global = self.in_function and not self.function_locals[path].has_key(name) or \ |
| paul@0 | 426 | not self.in_function |
| paul@0 | 427 | |
| paul@0 | 428 | if is_global: |
| paul@0 | 429 | self.record_global_access_details(name, attrnames) |
| paul@0 | 430 | |
| paul@0 | 431 | # Make sure the name is being tracked: global names will not |
| paul@0 | 432 | # already be initialised in a branch and must be added |
| paul@0 | 433 | # explicitly. |
| paul@0 | 434 | |
| paul@0 | 435 | if not tracker.have_name(name): |
| paul@0 | 436 | tracker.assign_names([name]) |
| paul@0 | 437 | if self.in_function: |
| paul@0 | 438 | self.scope_globals[path].add(name) |
| paul@0 | 439 | |
| paul@0 | 440 | # Record attribute usage in the tracker, and record the branch |
| paul@0 | 441 | # information for the access. |
| paul@0 | 442 | |
| paul@0 | 443 | branches = tracker.use_attribute(name, attrname) |
| paul@0 | 444 | |
| paul@0 | 445 | if not branches: |
| paul@0 | 446 | print >>sys.stderr, "In %s, name %s is accessed using %s before an assignment." % ( |
| paul@0 | 447 | path, name, attrname) |
| paul@0 | 448 | branches = tracker.use_attribute(name, attrname) |
| paul@0 | 449 | |
| paul@0 | 450 | self.record_branches_for_access(branches, name, attrnames) |
| paul@0 | 451 | access_number = self.record_access_details(name, attrnames, assignment) |
| paul@0 | 452 | return AccessRef(name, attrnames, access_number) |
| paul@0 | 453 | |
| paul@0 | 454 | def process_class_node(self, n): |
| paul@0 | 455 | |
| paul@0 | 456 | "Process the given class node 'n'." |
| paul@0 | 457 | |
| paul@0 | 458 | path = self.get_namespace_path() |
| paul@0 | 459 | |
| paul@0 | 460 | # To avoid notions of class "versions" where the same definition |
| paul@0 | 461 | # might be parameterised with different state and be referenced |
| paul@0 | 462 | # elsewhere (as base classes, for example), classes in functions or |
| paul@0 | 463 | # conditions are forbidden. |
| paul@0 | 464 | |
| paul@0 | 465 | if self.in_function or self.in_conditional: |
| paul@0 | 466 | print >>sys.stderr, "In %s, class %s in function or conditional statement ignored." % ( |
| paul@0 | 467 | path, n.name) |
| paul@0 | 468 | return |
| paul@0 | 469 | |
| paul@0 | 470 | # Resolve base classes. |
| paul@0 | 471 | |
| paul@0 | 472 | bases = [] |
| paul@0 | 473 | |
| paul@0 | 474 | for base in n.bases: |
| paul@0 | 475 | base_class = self.get_class(base) |
| paul@0 | 476 | |
| paul@0 | 477 | if not base_class: |
| paul@12 | 478 | print >>sys.stderr, "In %s, class %s has unidentifiable base class: %s" % ( |
| paul@12 | 479 | path, n.name, base) |
| paul@0 | 480 | return |
| paul@0 | 481 | else: |
| paul@0 | 482 | bases.append(base_class) |
| paul@0 | 483 | |
| paul@0 | 484 | # Record bases for the class and retain the class name. |
| paul@0 | 485 | |
| paul@0 | 486 | class_name = self.get_object_path(n.name) |
| paul@0 | 487 | |
| paul@0 | 488 | if not bases and class_name != "__builtins__.core.object": |
| paul@0 | 489 | ref = self.get_object("__builtins__.object") |
| paul@0 | 490 | bases.append(ref) |
| paul@0 | 491 | |
| paul@0 | 492 | self.importer.classes[class_name] = self.classes[class_name] = bases |
| paul@0 | 493 | self.importer.subclasses[class_name] = set() |
| paul@0 | 494 | self.scope_globals[class_name] = set() |
| paul@0 | 495 | |
| paul@0 | 496 | # Set the definition before entering the namespace rather than |
| paul@0 | 497 | # afterwards because methods may reference it. In normal Python, |
| paul@0 | 498 | # a class is not accessible until the definition is complete, but |
| paul@0 | 499 | # methods can generally reference it since upon being called the |
| paul@0 | 500 | # class will already exist. |
| paul@0 | 501 | |
| paul@0 | 502 | self.set_definition(n.name, "<class>") |
| paul@0 | 503 | |
| paul@0 | 504 | in_class = self.in_class |
| paul@0 | 505 | self.in_class = class_name |
| paul@0 | 506 | self.set_instance_attr("__class__", Reference("<class>", class_name)) |
| paul@0 | 507 | self.enter_namespace(n.name) |
| paul@0 | 508 | self.set_name("__fn__") # special instantiator attribute |
| paul@0 | 509 | self.set_name("__args__") # special instantiator attribute |
| paul@0 | 510 | self.assign_general_local("__name__", self.get_constant("str", class_name)) |
| paul@0 | 511 | self.process_structure_node(n.code) |
| paul@0 | 512 | self.exit_namespace() |
| paul@0 | 513 | self.in_class = in_class |
| paul@0 | 514 | |
| paul@0 | 515 | def process_from_node(self, n): |
| paul@0 | 516 | |
| paul@0 | 517 | "Process the given node 'n', importing from another module." |
| paul@0 | 518 | |
| paul@0 | 519 | path = self.get_namespace_path() |
| paul@0 | 520 | |
| paul@12 | 521 | module_name, names = self.get_module_name(n) |
| paul@12 | 522 | if module_name == self.name: |
| paul@12 | 523 | raise InspectError("Cannot import from the current module.", path, n) |
| paul@0 | 524 | |
| paul@18 | 525 | self.queue_module(module_name) |
| paul@0 | 526 | |
| paul@0 | 527 | # Attempt to obtain the referenced objects. |
| paul@0 | 528 | |
| paul@0 | 529 | for name, alias in n.names: |
| paul@0 | 530 | if name == "*": |
| paul@12 | 531 | raise InspectError("Only explicitly specified names can be imported from modules.", path, n) |
| paul@0 | 532 | |
| paul@0 | 533 | # Explicit names. |
| paul@0 | 534 | |
| paul@12 | 535 | ref = self.import_name_from_module(name, module_name) |
| paul@0 | 536 | value = ResolvedNameRef(alias or name, ref) |
| paul@0 | 537 | self.set_general_local(alias or name, value) |
| paul@0 | 538 | |
| paul@0 | 539 | def process_function_node(self, n, name): |
| paul@0 | 540 | |
| paul@0 | 541 | """ |
| paul@0 | 542 | Process the given function or lambda node 'n' with the given 'name'. |
| paul@0 | 543 | """ |
| paul@0 | 544 | |
| paul@0 | 545 | is_lambda = isinstance(n, compiler.ast.Lambda) |
| paul@0 | 546 | |
| paul@0 | 547 | # Where a function is declared conditionally, use a separate name for |
| paul@0 | 548 | # the definition, and assign the definition to the stated name. |
| paul@0 | 549 | |
| paul@0 | 550 | if (self.in_conditional or self.in_function) and not is_lambda: |
| paul@0 | 551 | original_name = name |
| paul@0 | 552 | name = self.get_lambda_name() |
| paul@0 | 553 | else: |
| paul@0 | 554 | original_name = None |
| paul@0 | 555 | |
| paul@0 | 556 | # Initialise argument and local records. |
| paul@0 | 557 | |
| paul@0 | 558 | function_name = self.get_object_path(name) |
| paul@46 | 559 | argnames = get_argnames(n.argnames) |
| paul@48 | 560 | is_method = self.in_class and not self.in_function |
| paul@0 | 561 | |
| paul@48 | 562 | # Remove explicit "self" from method parameters. |
| paul@46 | 563 | |
| paul@48 | 564 | if is_method and argnames and argnames[0] == "self": |
| paul@48 | 565 | del argnames[0] |
| paul@48 | 566 | |
| paul@48 | 567 | # Copy and propagate the parameters. |
| paul@46 | 568 | |
| paul@46 | 569 | self.importer.function_parameters[function_name] = \ |
| paul@48 | 570 | self.function_parameters[function_name] = argnames[:] |
| paul@46 | 571 | |
| paul@46 | 572 | # Define all arguments/parameters in the local namespace. |
| paul@46 | 573 | |
| paul@0 | 574 | locals = self.function_locals[function_name] = {} |
| paul@0 | 575 | |
| paul@48 | 576 | # Insert "self" into method locals. |
| paul@48 | 577 | |
| paul@48 | 578 | if is_method: |
| paul@48 | 579 | argnames.insert(0, "self") |
| paul@48 | 580 | |
| paul@47 | 581 | # Define "self" in terms of the class if in a method. |
| paul@47 | 582 | # This does not diminish the need for type-narrowing in the deducer. |
| paul@47 | 583 | |
| paul@47 | 584 | if argnames: |
| paul@48 | 585 | if self.in_class and not self.in_function and argnames[0] == "self": |
| paul@47 | 586 | locals[argnames[0]] = Reference("<instance>", self.in_class) |
| paul@47 | 587 | else: |
| paul@47 | 588 | locals[argnames[0]] = Reference("<var>") |
| paul@47 | 589 | |
| paul@47 | 590 | for argname in argnames[1:]: |
| paul@0 | 591 | locals[argname] = Reference("<var>") |
| paul@0 | 592 | |
| paul@0 | 593 | globals = self.scope_globals[function_name] = set() |
| paul@0 | 594 | |
| paul@0 | 595 | # Process the defaults. |
| paul@0 | 596 | |
| paul@0 | 597 | defaults = self.importer.function_defaults[function_name] = \ |
| paul@0 | 598 | self.function_defaults[function_name] = [] |
| paul@0 | 599 | |
| paul@0 | 600 | for argname, default in compiler.ast.get_defaults(n): |
| paul@0 | 601 | if default: |
| paul@0 | 602 | |
| paul@0 | 603 | # Obtain any reference for the default. |
| paul@0 | 604 | |
| paul@0 | 605 | name_ref = self.process_structure_node(default) |
| paul@0 | 606 | defaults.append((argname, name_ref.is_name() and name_ref.reference() or Reference("<var>"))) |
| paul@0 | 607 | |
| paul@0 | 608 | # Reset conditional tracking to focus on the function contents. |
| paul@0 | 609 | |
| paul@0 | 610 | in_conditional = self.in_conditional |
| paul@0 | 611 | self.in_conditional = False |
| paul@0 | 612 | |
| paul@0 | 613 | in_function = self.in_function |
| paul@0 | 614 | self.in_function = function_name |
| paul@0 | 615 | |
| paul@0 | 616 | self.enter_namespace(name) |
| paul@0 | 617 | |
| paul@0 | 618 | # Track attribute usage within the namespace. |
| paul@0 | 619 | |
| paul@0 | 620 | path = self.get_namespace_path() |
| paul@0 | 621 | |
| paul@0 | 622 | self.start_tracking(locals) |
| paul@0 | 623 | self.process_structure_node(n.code) |
| paul@0 | 624 | self.stop_tracking() |
| paul@0 | 625 | |
| paul@1 | 626 | # Exit to the parent. |
| paul@0 | 627 | |
| paul@0 | 628 | self.exit_namespace() |
| paul@0 | 629 | |
| paul@0 | 630 | # Update flags. |
| paul@0 | 631 | |
| paul@0 | 632 | self.in_function = in_function |
| paul@0 | 633 | self.in_conditional = in_conditional |
| paul@0 | 634 | |
| paul@0 | 635 | # Define the function using the appropriate name. |
| paul@0 | 636 | |
| paul@0 | 637 | self.set_definition(name, "<function>") |
| paul@0 | 638 | |
| paul@0 | 639 | # Where a function is set conditionally, assign the name. |
| paul@0 | 640 | |
| paul@0 | 641 | if original_name: |
| paul@0 | 642 | self.process_assignment_for_function(original_name, name) |
| paul@0 | 643 | |
| paul@0 | 644 | def process_global_node(self, n): |
| paul@0 | 645 | |
| paul@0 | 646 | """ |
| paul@0 | 647 | Process the given "global" node 'n'. |
| paul@0 | 648 | """ |
| paul@0 | 649 | |
| paul@0 | 650 | path = self.get_namespace_path() |
| paul@0 | 651 | |
| paul@0 | 652 | if path != self.name: |
| paul@0 | 653 | self.scope_globals[path].update(n.names) |
| paul@0 | 654 | |
| paul@0 | 655 | def process_if_node(self, n): |
| paul@0 | 656 | |
| paul@0 | 657 | """ |
| paul@0 | 658 | Process the given "if" node 'n'. |
| paul@0 | 659 | """ |
| paul@0 | 660 | |
| paul@0 | 661 | tracker = self.trackers[-1] |
| paul@0 | 662 | tracker.new_branchpoint() |
| paul@0 | 663 | |
| paul@0 | 664 | for test, body in n.tests: |
| paul@0 | 665 | self.process_structure_node(test) |
| paul@0 | 666 | |
| paul@0 | 667 | tracker.new_branch() |
| paul@0 | 668 | |
| paul@0 | 669 | in_conditional = self.in_conditional |
| paul@0 | 670 | self.in_conditional = True |
| paul@0 | 671 | self.process_structure_node(body) |
| paul@0 | 672 | self.in_conditional = in_conditional |
| paul@0 | 673 | |
| paul@0 | 674 | tracker.shelve_branch() |
| paul@0 | 675 | |
| paul@0 | 676 | # Maintain a branch for the else clause. |
| paul@0 | 677 | |
| paul@0 | 678 | tracker.new_branch() |
| paul@0 | 679 | if n.else_: |
| paul@0 | 680 | self.process_structure_node(n.else_) |
| paul@0 | 681 | tracker.shelve_branch() |
| paul@0 | 682 | |
| paul@0 | 683 | tracker.merge_branches() |
| paul@0 | 684 | |
| paul@0 | 685 | def process_import_node(self, n): |
| paul@0 | 686 | |
| paul@0 | 687 | "Process the given import node 'n'." |
| paul@0 | 688 | |
| paul@0 | 689 | path = self.get_namespace_path() |
| paul@0 | 690 | |
| paul@0 | 691 | # Load the mentioned module. |
| paul@0 | 692 | |
| paul@0 | 693 | for name, alias in n.names: |
| paul@12 | 694 | if name == self.name: |
| paul@12 | 695 | raise InspectError("Cannot import the current module.", path, n) |
| paul@0 | 696 | |
| paul@13 | 697 | self.set_module(alias or name.split(".")[-1], name) |
| paul@18 | 698 | self.queue_module(name, True) |
| paul@0 | 699 | |
| paul@0 | 700 | def process_invocation_node(self, n): |
| paul@0 | 701 | |
| paul@0 | 702 | "Process the given invocation node 'n'." |
| paul@0 | 703 | |
| paul@0 | 704 | path = self.get_namespace_path() |
| paul@0 | 705 | |
| paul@0 | 706 | self.allocate_arguments(path, n.args) |
| paul@0 | 707 | |
| paul@0 | 708 | try: |
| paul@0 | 709 | # Process the expression, obtaining any identified reference. |
| paul@0 | 710 | |
| paul@0 | 711 | name_ref = self.process_structure_node(n.node) |
| paul@0 | 712 | |
| paul@0 | 713 | # Process the arguments. |
| paul@0 | 714 | |
| paul@0 | 715 | for arg in n.args: |
| paul@0 | 716 | self.process_structure_node(arg) |
| paul@0 | 717 | |
| paul@0 | 718 | # Detect class invocations. |
| paul@0 | 719 | |
| paul@0 | 720 | if isinstance(name_ref, ResolvedNameRef) and name_ref.has_kind("<class>"): |
| paul@0 | 721 | return InstanceRef(name_ref.reference().instance_of()) |
| paul@0 | 722 | |
| paul@0 | 723 | elif isinstance(name_ref, NameRef): |
| paul@0 | 724 | return InvocationRef(name_ref) |
| paul@0 | 725 | |
| paul@0 | 726 | return None |
| paul@0 | 727 | |
| paul@0 | 728 | finally: |
| paul@0 | 729 | self.deallocate_arguments(path, n.args) |
| paul@0 | 730 | |
| paul@0 | 731 | def process_lambda_node(self, n): |
| paul@0 | 732 | |
| paul@0 | 733 | "Process the given lambda node 'n'." |
| paul@0 | 734 | |
| paul@0 | 735 | name = self.get_lambda_name() |
| paul@0 | 736 | self.process_function_node(n, name) |
| paul@0 | 737 | |
| paul@0 | 738 | origin = self.get_object_path(name) |
| paul@0 | 739 | return ResolvedNameRef(name, Reference("<function>", origin)) |
| paul@0 | 740 | |
| paul@0 | 741 | def process_logical_node(self, n): |
| paul@0 | 742 | |
| paul@0 | 743 | "Process the given operator node 'n'." |
| paul@0 | 744 | |
| paul@0 | 745 | self.process_operator_chain(n.nodes, self.process_structure_node) |
| paul@0 | 746 | |
| paul@0 | 747 | def process_name_node(self, n): |
| paul@0 | 748 | |
| paul@0 | 749 | "Process the given name node 'n'." |
| paul@0 | 750 | |
| paul@0 | 751 | path = self.get_namespace_path() |
| paul@0 | 752 | |
| paul@0 | 753 | # Special names. |
| paul@0 | 754 | |
| paul@0 | 755 | if n.name.startswith("$"): |
| paul@0 | 756 | value = self.get_special(n.name) |
| paul@0 | 757 | if value: |
| paul@0 | 758 | return value |
| paul@0 | 759 | |
| paul@0 | 760 | # Special case for operator functions introduced through code |
| paul@0 | 761 | # transformations. |
| paul@0 | 762 | |
| paul@0 | 763 | if n.name.startswith("$op"): |
| paul@0 | 764 | |
| paul@0 | 765 | # Obtain the location of the actual function defined in the operator |
| paul@0 | 766 | # package. |
| paul@0 | 767 | |
| paul@0 | 768 | op = n.name[len("$op"):] |
| paul@0 | 769 | |
| paul@0 | 770 | # Attempt to get a reference. |
| paul@0 | 771 | |
| paul@12 | 772 | ref = self.import_name_from_module(op, "operator") |
| paul@35 | 773 | self.add_deferred(ref) |
| paul@0 | 774 | |
| paul@0 | 775 | # Record the imported name and provide the resolved name reference. |
| paul@0 | 776 | |
| paul@0 | 777 | value = ResolvedNameRef(n.name, ref) |
| paul@0 | 778 | self.set_special(n.name, value) |
| paul@0 | 779 | return value |
| paul@0 | 780 | |
| paul@60 | 781 | # Test for self usage, which is only allowed in methods. |
| paul@60 | 782 | |
| paul@60 | 783 | if n.name == "self" and not (self.in_function and self.in_class): |
| paul@60 | 784 | raise InspectError("Use of self is only allowed in methods.", path, n) |
| paul@60 | 785 | |
| paul@0 | 786 | # Record usage of the name. |
| paul@0 | 787 | |
| paul@0 | 788 | self.record_name(n.name) |
| paul@0 | 789 | |
| paul@0 | 790 | # Search for unknown names in non-function scopes immediately. |
| paul@0 | 791 | # External names in functions are resolved later. |
| paul@0 | 792 | |
| paul@0 | 793 | ref = self.find_name(n.name) |
| paul@0 | 794 | if ref: |
| paul@0 | 795 | return ResolvedNameRef(n.name, ref) |
| paul@0 | 796 | |
| paul@40 | 797 | # Explicitly-declared global names. |
| paul@0 | 798 | |
| paul@0 | 799 | elif self.in_function and n.name in self.scope_globals[path]: |
| paul@0 | 800 | return NameRef(n.name) |
| paul@0 | 801 | |
| paul@0 | 802 | # Examine other names. |
| paul@0 | 803 | |
| paul@0 | 804 | else: |
| paul@0 | 805 | tracker = self.trackers[-1] |
| paul@0 | 806 | |
| paul@0 | 807 | # Check local names. |
| paul@0 | 808 | |
| paul@0 | 809 | branches = tracker.tracking_name(n.name) |
| paul@0 | 810 | |
| paul@1 | 811 | # Local name. |
| paul@0 | 812 | |
| paul@0 | 813 | if branches: |
| paul@0 | 814 | self.record_branches_for_access(branches, n.name, None) |
| paul@0 | 815 | access_number = self.record_access_details(n.name, None, False) |
| paul@0 | 816 | return LocalNameRef(n.name, access_number) |
| paul@0 | 817 | |
| paul@40 | 818 | # Possible global or built-in name. |
| paul@0 | 819 | |
| paul@0 | 820 | else: |
| paul@0 | 821 | return NameRef(n.name) |
| paul@0 | 822 | |
| paul@0 | 823 | def process_operator_chain(self, nodes, fn): |
| paul@0 | 824 | |
| paul@0 | 825 | """ |
| paul@0 | 826 | Process the given chain of 'nodes', applying 'fn' to each node or item. |
| paul@0 | 827 | Each node starts a new conditional region, effectively making a deeply- |
| paul@0 | 828 | nested collection of if-like statements. |
| paul@0 | 829 | """ |
| paul@0 | 830 | |
| paul@0 | 831 | tracker = self.trackers[-1] |
| paul@0 | 832 | |
| paul@0 | 833 | for item in nodes: |
| paul@0 | 834 | tracker.new_branchpoint() |
| paul@0 | 835 | tracker.new_branch() |
| paul@0 | 836 | fn(item) |
| paul@0 | 837 | |
| paul@0 | 838 | for item in nodes[:-1]: |
| paul@0 | 839 | tracker.shelve_branch() |
| paul@0 | 840 | tracker.new_branch() |
| paul@0 | 841 | tracker.shelve_branch() |
| paul@0 | 842 | tracker.merge_branches() |
| paul@0 | 843 | |
| paul@0 | 844 | tracker.shelve_branch() |
| paul@0 | 845 | tracker.merge_branches() |
| paul@0 | 846 | |
| paul@0 | 847 | def process_try_node(self, n): |
| paul@0 | 848 | |
| paul@0 | 849 | """ |
| paul@0 | 850 | Process the given "try...except" node 'n'. |
| paul@0 | 851 | """ |
| paul@0 | 852 | |
| paul@0 | 853 | tracker = self.trackers[-1] |
| paul@0 | 854 | tracker.new_branchpoint() |
| paul@0 | 855 | |
| paul@0 | 856 | self.process_structure_node(n.body) |
| paul@0 | 857 | |
| paul@0 | 858 | for name, var, handler in n.handlers: |
| paul@0 | 859 | if name is not None: |
| paul@0 | 860 | self.process_structure_node(name) |
| paul@0 | 861 | |
| paul@0 | 862 | # Any abandoned branches from the body can now be resumed in a new |
| paul@0 | 863 | # branch. |
| paul@0 | 864 | |
| paul@0 | 865 | tracker.resume_abandoned_branches() |
| paul@0 | 866 | |
| paul@0 | 867 | # Establish the local for the handler. |
| paul@0 | 868 | |
| paul@0 | 869 | if var is not None: |
| paul@0 | 870 | self.process_structure_node(var) |
| paul@0 | 871 | if handler is not None: |
| paul@0 | 872 | self.process_structure_node(handler) |
| paul@0 | 873 | |
| paul@0 | 874 | tracker.shelve_branch() |
| paul@0 | 875 | |
| paul@0 | 876 | # The else clause maintains the usage from the body but without the |
| paul@0 | 877 | # abandoned branches since they would never lead to the else clause |
| paul@0 | 878 | # being executed. |
| paul@0 | 879 | |
| paul@0 | 880 | if n.else_: |
| paul@0 | 881 | tracker.new_branch() |
| paul@0 | 882 | self.process_structure_node(n.else_) |
| paul@0 | 883 | tracker.shelve_branch() |
| paul@0 | 884 | |
| paul@0 | 885 | # Without an else clause, a null branch propagates the successful |
| paul@0 | 886 | # outcome. |
| paul@0 | 887 | |
| paul@0 | 888 | else: |
| paul@0 | 889 | tracker.new_branch() |
| paul@0 | 890 | tracker.shelve_branch() |
| paul@0 | 891 | |
| paul@0 | 892 | tracker.merge_branches() |
| paul@0 | 893 | |
| paul@0 | 894 | def process_try_finally_node(self, n): |
| paul@0 | 895 | |
| paul@0 | 896 | """ |
| paul@0 | 897 | Process the given "try...finally" node 'n'. |
| paul@0 | 898 | """ |
| paul@0 | 899 | |
| paul@0 | 900 | tracker = self.trackers[-1] |
| paul@0 | 901 | self.process_structure_node(n.body) |
| paul@0 | 902 | |
| paul@0 | 903 | # Any abandoned branches from the body can now be resumed. |
| paul@0 | 904 | |
| paul@0 | 905 | branches = tracker.resume_all_abandoned_branches() |
| paul@0 | 906 | self.process_structure_node(n.final) |
| paul@0 | 907 | |
| paul@0 | 908 | # At the end of the finally clause, abandoned branches are discarded. |
| paul@0 | 909 | |
| paul@0 | 910 | tracker.restore_active_branches(branches) |
| paul@0 | 911 | |
| paul@0 | 912 | def process_while_node(self, n): |
| paul@0 | 913 | |
| paul@0 | 914 | "Process the given while node 'n'." |
| paul@0 | 915 | |
| paul@0 | 916 | tracker = self.trackers[-1] |
| paul@0 | 917 | tracker.new_branchpoint(loop_node=True) |
| paul@0 | 918 | |
| paul@0 | 919 | # Evaluate any test or iterator outside the loop. |
| paul@0 | 920 | |
| paul@0 | 921 | self.process_structure_node(n.test) |
| paul@0 | 922 | |
| paul@0 | 923 | # Propagate attribute usage to branches. |
| paul@0 | 924 | |
| paul@0 | 925 | tracker.new_branch(loop_node=True) |
| paul@0 | 926 | |
| paul@0 | 927 | # Enter the loop. |
| paul@0 | 928 | |
| paul@0 | 929 | in_conditional = self.in_conditional |
| paul@0 | 930 | self.in_conditional = True |
| paul@0 | 931 | self.process_structure_node(n.body) |
| paul@0 | 932 | self.in_conditional = in_conditional |
| paul@0 | 933 | |
| paul@0 | 934 | # Continuing branches are resumed before any test. |
| paul@0 | 935 | |
| paul@0 | 936 | tracker.resume_continuing_branches() |
| paul@0 | 937 | |
| paul@0 | 938 | # Evaluate any continuation test within the body. |
| paul@0 | 939 | |
| paul@0 | 940 | self.process_structure_node(n.test) |
| paul@0 | 941 | |
| paul@0 | 942 | tracker.shelve_branch(loop_node=True) |
| paul@0 | 943 | |
| paul@0 | 944 | # Support the non-looping condition. |
| paul@0 | 945 | |
| paul@0 | 946 | tracker.new_branch() |
| paul@0 | 947 | tracker.shelve_branch() |
| paul@0 | 948 | |
| paul@0 | 949 | tracker.merge_branches() |
| paul@0 | 950 | |
| paul@0 | 951 | # Evaluate any else clause outside branches. |
| paul@0 | 952 | |
| paul@0 | 953 | if n.else_: |
| paul@0 | 954 | self.process_structure_node(n.else_) |
| paul@0 | 955 | |
| paul@0 | 956 | # Connect broken branches to the code after any loop. |
| paul@0 | 957 | |
| paul@0 | 958 | tracker.resume_broken_branches() |
| paul@0 | 959 | |
| paul@0 | 960 | # Branch tracking methods. |
| paul@0 | 961 | |
| paul@0 | 962 | def start_tracking(self, names): |
| paul@0 | 963 | |
| paul@0 | 964 | """ |
| paul@0 | 965 | Start tracking attribute usage for names in the current namespace, |
| paul@0 | 966 | immediately registering the given 'names'. |
| paul@0 | 967 | """ |
| paul@0 | 968 | |
| paul@0 | 969 | path = self.get_namespace_path() |
| paul@0 | 970 | parent = self.trackers[-1] |
| paul@0 | 971 | tracker = BranchTracker() |
| paul@0 | 972 | self.trackers.append(tracker) |
| paul@0 | 973 | |
| paul@0 | 974 | # Record the given names established as new branches. |
| paul@0 | 975 | |
| paul@0 | 976 | tracker.assign_names(names) |
| paul@0 | 977 | |
| paul@0 | 978 | def assign_name(self, name, name_ref): |
| paul@0 | 979 | |
| paul@0 | 980 | "Assign to 'name' the given 'name_ref' in the current namespace." |
| paul@0 | 981 | |
| paul@0 | 982 | name = self.get_name_for_tracking(name) |
| paul@0 | 983 | self.trackers[-1].assign_names([name], [name_ref]) |
| paul@0 | 984 | |
| paul@0 | 985 | def stop_tracking(self): |
| paul@0 | 986 | |
| paul@0 | 987 | """ |
| paul@0 | 988 | Stop tracking attribute usage, recording computed usage for the current |
| paul@0 | 989 | namespace. |
| paul@0 | 990 | """ |
| paul@0 | 991 | |
| paul@0 | 992 | path = self.get_namespace_path() |
| paul@0 | 993 | tracker = self.trackers.pop() |
| paul@0 | 994 | self.record_assignments_for_access(tracker) |
| paul@0 | 995 | |
| paul@0 | 996 | self.attr_usage[path] = tracker.get_all_usage() |
| paul@0 | 997 | self.name_initialisers[path] = tracker.get_all_values() |
| paul@0 | 998 | |
| paul@0 | 999 | def start_tracking_in_module(self): |
| paul@0 | 1000 | |
| paul@0 | 1001 | "Start tracking attribute usage in the module." |
| paul@0 | 1002 | |
| paul@0 | 1003 | tracker = BranchTracker() |
| paul@0 | 1004 | self.trackers.append(tracker) |
| paul@0 | 1005 | |
| paul@0 | 1006 | def stop_tracking_in_module(self): |
| paul@0 | 1007 | |
| paul@0 | 1008 | "Stop tracking attribute usage in the module." |
| paul@0 | 1009 | |
| paul@0 | 1010 | tracker = self.trackers[0] |
| paul@0 | 1011 | self.record_assignments_for_access(tracker) |
| paul@0 | 1012 | self.attr_usage[self.name] = tracker.get_all_usage() |
| paul@0 | 1013 | self.name_initialisers[self.name] = tracker.get_all_values() |
| paul@0 | 1014 | |
| paul@0 | 1015 | def record_assignments_for_access(self, tracker): |
| paul@0 | 1016 | |
| paul@0 | 1017 | """ |
| paul@0 | 1018 | For the current path, use the given 'tracker' to record assignment |
| paul@0 | 1019 | version information for attribute accesses. |
| paul@0 | 1020 | """ |
| paul@0 | 1021 | |
| paul@0 | 1022 | path = self.get_path_for_access() |
| paul@0 | 1023 | |
| paul@0 | 1024 | if not self.attr_accessor_branches.has_key(path): |
| paul@0 | 1025 | return |
| paul@0 | 1026 | |
| paul@0 | 1027 | init_item(self.attr_accessors, path, dict) |
| paul@0 | 1028 | attr_accessors = self.attr_accessors[path] |
| paul@0 | 1029 | |
| paul@0 | 1030 | # Obtain the branches applying during each access. |
| paul@0 | 1031 | |
| paul@0 | 1032 | for access, all_branches in self.attr_accessor_branches[path].items(): |
| paul@0 | 1033 | name, attrnames = access |
| paul@0 | 1034 | init_item(attr_accessors, access, list) |
| paul@0 | 1035 | |
| paul@0 | 1036 | # Obtain the assignments applying to each branch. |
| paul@0 | 1037 | |
| paul@0 | 1038 | for branches in all_branches: |
| paul@0 | 1039 | positions = tracker.get_assignment_positions_for_branches(name, branches) |
| paul@0 | 1040 | |
| paul@0 | 1041 | # Detect missing name information. |
| paul@0 | 1042 | |
| paul@0 | 1043 | if None in positions: |
| paul@0 | 1044 | globals = self.global_attr_accesses.get(path) |
| paul@0 | 1045 | accesses = globals and globals.get(name) |
| paul@0 | 1046 | if not accesses: |
| paul@0 | 1047 | print >>sys.stderr, "In %s, %s may not be defined when used." % ( |
| paul@0 | 1048 | self.get_namespace_path(), name) |
| paul@0 | 1049 | positions.remove(None) |
| paul@0 | 1050 | |
| paul@0 | 1051 | attr_accessors[access].append(positions) |
| paul@0 | 1052 | |
| paul@0 | 1053 | def record_branches_for_access(self, branches, name, attrnames): |
| paul@0 | 1054 | |
| paul@0 | 1055 | """ |
| paul@0 | 1056 | Record the given 'branches' for an access involving the given 'name' and |
| paul@0 | 1057 | 'attrnames'. |
| paul@0 | 1058 | """ |
| paul@0 | 1059 | |
| paul@0 | 1060 | access = name, attrnames |
| paul@0 | 1061 | path = self.get_path_for_access() |
| paul@0 | 1062 | |
| paul@0 | 1063 | init_item(self.attr_accessor_branches, path, dict) |
| paul@0 | 1064 | attr_accessor_branches = self.attr_accessor_branches[path] |
| paul@0 | 1065 | |
| paul@0 | 1066 | init_item(attr_accessor_branches, access, list) |
| paul@0 | 1067 | attr_accessor_branches[access].append(branches) |
| paul@0 | 1068 | |
| paul@0 | 1069 | def record_access_details(self, name, attrnames, assignment): |
| paul@0 | 1070 | |
| paul@0 | 1071 | """ |
| paul@0 | 1072 | For the given 'name' and 'attrnames', record an access indicating |
| paul@0 | 1073 | whether 'assignment' is occurring. |
| paul@0 | 1074 | |
| paul@0 | 1075 | These details correspond to accesses otherwise recorded by the attribute |
| paul@0 | 1076 | accessor and attribute access dictionaries. |
| paul@0 | 1077 | """ |
| paul@0 | 1078 | |
| paul@0 | 1079 | access = name, attrnames |
| paul@0 | 1080 | path = self.get_path_for_access() |
| paul@0 | 1081 | |
| paul@0 | 1082 | init_item(self.attr_access_modifiers, path, dict) |
| paul@0 | 1083 | init_item(self.attr_access_modifiers[path], access, list) |
| paul@0 | 1084 | |
| paul@0 | 1085 | access_number = len(self.attr_access_modifiers[path][access]) |
| paul@0 | 1086 | self.attr_access_modifiers[path][access].append(assignment) |
| paul@0 | 1087 | return access_number |
| paul@0 | 1088 | |
| paul@0 | 1089 | def record_global_access_details(self, name, attrnames): |
| paul@0 | 1090 | |
| paul@0 | 1091 | """ |
| paul@0 | 1092 | Record details of a global access via the given 'name' involving the |
| paul@0 | 1093 | indicated 'attrnames'. |
| paul@0 | 1094 | """ |
| paul@0 | 1095 | |
| paul@0 | 1096 | path = self.get_namespace_path() |
| paul@0 | 1097 | |
| paul@0 | 1098 | init_item(self.global_attr_accesses, path, dict) |
| paul@0 | 1099 | init_item(self.global_attr_accesses[path], name, set) |
| paul@0 | 1100 | self.global_attr_accesses[path][name].add(attrnames) |
| paul@0 | 1101 | |
| paul@0 | 1102 | # Namespace modification. |
| paul@0 | 1103 | |
| paul@0 | 1104 | def record_name(self, name): |
| paul@0 | 1105 | |
| paul@0 | 1106 | "Record the use of 'name' in a namespace." |
| paul@0 | 1107 | |
| paul@0 | 1108 | path = self.get_namespace_path() |
| paul@0 | 1109 | init_item(self.names_used, path, set) |
| paul@0 | 1110 | self.names_used[path].add(name) |
| paul@0 | 1111 | |
| paul@12 | 1112 | def set_module(self, name, module_name): |
| paul@0 | 1113 | |
| paul@0 | 1114 | """ |
| paul@12 | 1115 | Set a module in the current namespace using the given 'name' associated |
| paul@12 | 1116 | with the corresponding 'module_name'. |
| paul@0 | 1117 | """ |
| paul@0 | 1118 | |
| paul@0 | 1119 | if name: |
| paul@12 | 1120 | self.set_general_local(name, Reference("<module>", module_name)) |
| paul@0 | 1121 | |
| paul@0 | 1122 | def set_definition(self, name, kind): |
| paul@0 | 1123 | |
| paul@0 | 1124 | """ |
| paul@0 | 1125 | Set the definition having the given 'name' and 'kind'. |
| paul@0 | 1126 | |
| paul@0 | 1127 | Definitions are set in the static namespace hierarchy, but they can also |
| paul@0 | 1128 | be recorded for function locals. |
| paul@0 | 1129 | """ |
| paul@0 | 1130 | |
| paul@0 | 1131 | if self.is_global(name): |
| paul@0 | 1132 | print >>sys.stderr, "In %s, %s is defined as being global." % ( |
| paul@0 | 1133 | self.get_namespace_path(), name) |
| paul@0 | 1134 | |
| paul@0 | 1135 | path = self.get_object_path(name) |
| paul@0 | 1136 | self.set_object(path, kind) |
| paul@0 | 1137 | |
| paul@0 | 1138 | ref = self.get_object(path) |
| paul@0 | 1139 | if ref.get_kind() == "<var>": |
| paul@0 | 1140 | print >>sys.stderr, "In %s, %s is defined more than once." % ( |
| paul@0 | 1141 | self.get_namespace_path(), name) |
| paul@0 | 1142 | |
| paul@0 | 1143 | if not self.is_global(name) and self.in_function: |
| paul@0 | 1144 | self.set_function_local(name, ref) |
| paul@0 | 1145 | |
| paul@0 | 1146 | def set_function_local(self, name, ref=None): |
| paul@0 | 1147 | |
| paul@0 | 1148 | "Set the local with the given 'name' and optional 'ref'." |
| paul@0 | 1149 | |
| paul@0 | 1150 | locals = self.function_locals[self.get_namespace_path()] |
| paul@0 | 1151 | multiple = not ref or locals.has_key(name) and locals[name] != ref |
| paul@0 | 1152 | locals[name] = multiple and Reference("<var>") or ref |
| paul@0 | 1153 | |
| paul@0 | 1154 | def assign_general_local(self, name, name_ref): |
| paul@0 | 1155 | |
| paul@0 | 1156 | """ |
| paul@0 | 1157 | Set for 'name' the given 'name_ref', recording the name for attribute |
| paul@0 | 1158 | usage tracking. |
| paul@0 | 1159 | """ |
| paul@0 | 1160 | |
| paul@0 | 1161 | self.set_general_local(name, name_ref) |
| paul@0 | 1162 | self.assign_name(name, name_ref) |
| paul@0 | 1163 | |
| paul@0 | 1164 | def set_general_local(self, name, value=None): |
| paul@0 | 1165 | |
| paul@0 | 1166 | """ |
| paul@0 | 1167 | Set the 'name' with optional 'value' in any kind of local namespace, |
| paul@0 | 1168 | where the 'value' should be a reference if specified. |
| paul@0 | 1169 | """ |
| paul@0 | 1170 | |
| paul@0 | 1171 | init_value = self.get_initialising_value(value) |
| paul@0 | 1172 | |
| paul@0 | 1173 | # Module global names. |
| paul@0 | 1174 | |
| paul@0 | 1175 | if self.is_global(name): |
| paul@0 | 1176 | path = self.get_global_path(name) |
| paul@0 | 1177 | self.set_object(path, init_value) |
| paul@0 | 1178 | |
| paul@0 | 1179 | # Function local names. |
| paul@0 | 1180 | |
| paul@0 | 1181 | elif self.in_function: |
| paul@0 | 1182 | path = self.get_object_path(name) |
| paul@0 | 1183 | self.set_function_local(name, init_value) |
| paul@0 | 1184 | |
| paul@0 | 1185 | # Other namespaces (classes). |
| paul@0 | 1186 | |
| paul@0 | 1187 | else: |
| paul@0 | 1188 | path = self.get_object_path(name) |
| paul@0 | 1189 | self.set_name(name, init_value) |
| paul@0 | 1190 | |
| paul@0 | 1191 | def set_name(self, name, ref=None): |
| paul@0 | 1192 | |
| paul@0 | 1193 | "Attach the 'name' with optional 'ref' to the current namespace." |
| paul@0 | 1194 | |
| paul@0 | 1195 | self.set_object(self.get_object_path(name), ref) |
| paul@0 | 1196 | |
| paul@0 | 1197 | def set_instance_attr(self, name, ref=None): |
| paul@0 | 1198 | |
| paul@0 | 1199 | """ |
| paul@0 | 1200 | Add an instance attribute of the given 'name' to the current class, |
| paul@0 | 1201 | using the optional 'ref'. |
| paul@0 | 1202 | """ |
| paul@0 | 1203 | |
| paul@0 | 1204 | init_item(self.instance_attrs, self.in_class, set) |
| paul@0 | 1205 | self.instance_attrs[self.in_class].add(name) |
| paul@0 | 1206 | |
| paul@0 | 1207 | if ref: |
| paul@0 | 1208 | init_item(self.instance_attr_constants, self.in_class, dict) |
| paul@0 | 1209 | self.instance_attr_constants[self.in_class][name] = ref |
| paul@0 | 1210 | |
| paul@0 | 1211 | def get_initialising_value(self, value): |
| paul@0 | 1212 | |
| paul@0 | 1213 | "Return a suitable initialiser reference for 'value'." |
| paul@0 | 1214 | |
| paul@25 | 1215 | # Includes LiteralSequenceRef, ResolvedNameRef... |
| paul@25 | 1216 | |
| paul@25 | 1217 | if isinstance(value, (NameRef, AccessRef, InstanceRef)): |
| paul@0 | 1218 | return value.reference() |
| paul@0 | 1219 | |
| paul@0 | 1220 | # In general, invocations do not produce known results. However, the |
| paul@0 | 1221 | # name initialisers are resolved once a module has been inspected. |
| paul@0 | 1222 | |
| paul@0 | 1223 | elif isinstance(value, InvocationRef): |
| paul@27 | 1224 | return value.reference() |
| paul@0 | 1225 | |
| paul@0 | 1226 | else: |
| paul@0 | 1227 | return value |
| paul@0 | 1228 | |
| paul@0 | 1229 | # Static, program-relative naming. |
| paul@0 | 1230 | |
| paul@0 | 1231 | def find_name(self, name): |
| paul@0 | 1232 | |
| paul@0 | 1233 | """ |
| paul@0 | 1234 | Return the qualified name for the given 'name' used in the current |
| paul@0 | 1235 | non-function namespace. |
| paul@0 | 1236 | """ |
| paul@0 | 1237 | |
| paul@0 | 1238 | path = self.get_namespace_path() |
| paul@0 | 1239 | ref = None |
| paul@0 | 1240 | |
| paul@0 | 1241 | if not self.in_function and name not in predefined_constants: |
| paul@0 | 1242 | if self.in_class: |
| paul@0 | 1243 | ref = self.get_object(self.get_object_path(name)) |
| paul@0 | 1244 | if not ref: |
| paul@0 | 1245 | ref = self.get_global_or_builtin(name) |
| paul@0 | 1246 | |
| paul@0 | 1247 | return ref |
| paul@0 | 1248 | |
| paul@0 | 1249 | def get_class(self, node): |
| paul@0 | 1250 | |
| paul@0 | 1251 | """ |
| paul@0 | 1252 | Use the given 'node' to obtain the identity of a class. Return a |
| paul@0 | 1253 | reference for the class. Unresolved dependencies are permitted and must |
| paul@0 | 1254 | be resolved later. |
| paul@0 | 1255 | """ |
| paul@0 | 1256 | |
| paul@0 | 1257 | ref = self._get_class(node) |
| paul@0 | 1258 | return ref.has_kind(["<class>", "<depends>"]) and ref or None |
| paul@0 | 1259 | |
| paul@0 | 1260 | def _get_class(self, node): |
| paul@0 | 1261 | |
| paul@0 | 1262 | """ |
| paul@0 | 1263 | Use the given 'node' to find a class definition. Return a reference to |
| paul@0 | 1264 | the class. |
| paul@0 | 1265 | """ |
| paul@0 | 1266 | |
| paul@0 | 1267 | if isinstance(node, compiler.ast.Getattr): |
| paul@0 | 1268 | |
| paul@0 | 1269 | # Obtain the identity of the access target. |
| paul@0 | 1270 | |
| paul@0 | 1271 | ref = self._get_class(node.expr) |
| paul@0 | 1272 | |
| paul@0 | 1273 | # Where the target is a class or module, obtain the identity of the |
| paul@0 | 1274 | # attribute. |
| paul@0 | 1275 | |
| paul@0 | 1276 | if ref.has_kind(["<function>", "<var>"]): |
| paul@0 | 1277 | return None |
| paul@0 | 1278 | else: |
| paul@0 | 1279 | attrname = "%s.%s" % (ref.get_origin(), node.attrname) |
| paul@0 | 1280 | return self.get_object(attrname) |
| paul@0 | 1281 | |
| paul@0 | 1282 | # Names can be module-level or built-in. |
| paul@0 | 1283 | |
| paul@0 | 1284 | elif isinstance(node, compiler.ast.Name): |
| paul@0 | 1285 | |
| paul@0 | 1286 | # Record usage of the name and attempt to identify it. |
| paul@0 | 1287 | |
| paul@0 | 1288 | self.record_name(node.name) |
| paul@73 | 1289 | return self.find_name(node.name) |
| paul@0 | 1290 | else: |
| paul@0 | 1291 | return None |
| paul@0 | 1292 | |
| paul@0 | 1293 | def get_constant(self, name, value): |
| paul@0 | 1294 | |
| paul@0 | 1295 | "Return a constant reference for the given type 'name' and 'value'." |
| paul@0 | 1296 | |
| paul@12 | 1297 | ref = self.get_builtin_class(name) |
| paul@0 | 1298 | return self.get_constant_reference(ref, value) |
| paul@0 | 1299 | |
| paul@0 | 1300 | def get_literal_instance(self, n, name): |
| paul@0 | 1301 | |
| paul@0 | 1302 | "For node 'n', return a reference to an instance of 'name'." |
| paul@0 | 1303 | |
| paul@12 | 1304 | # Get a reference to the built-in class. |
| paul@0 | 1305 | |
| paul@12 | 1306 | ref = self.get_builtin_class(name) |
| paul@0 | 1307 | |
| paul@0 | 1308 | # Obtain the details of the literal itself. |
| paul@0 | 1309 | # An alias to the type is generated for sequences. |
| paul@0 | 1310 | |
| paul@0 | 1311 | if name in ("dict", "list", "tuple"): |
| paul@0 | 1312 | self.set_special_literal(name, ref) |
| paul@0 | 1313 | return self.process_literal_sequence_node(n, name, ref, LiteralSequenceRef) |
| paul@0 | 1314 | |
| paul@0 | 1315 | # Constant values are independently recorded. |
| paul@0 | 1316 | |
| paul@0 | 1317 | else: |
| paul@0 | 1318 | return self.get_constant_reference(ref, n.value) |
| paul@0 | 1319 | |
| paul@17 | 1320 | # Special names. |
| paul@0 | 1321 | |
| paul@17 | 1322 | def get_special(self, name): |
| paul@0 | 1323 | |
| paul@17 | 1324 | "Return any stored value for the given special 'name'." |
| paul@0 | 1325 | |
| paul@17 | 1326 | return self.special.get(name) |
| paul@17 | 1327 | |
| paul@17 | 1328 | def set_special(self, name, value): |
| paul@0 | 1329 | |
| paul@17 | 1330 | """ |
| paul@17 | 1331 | Set a special 'name' that merely tracks the use of an implicit object |
| paul@17 | 1332 | 'value'. |
| paul@17 | 1333 | """ |
| paul@0 | 1334 | |
| paul@17 | 1335 | self.special[name] = value |
| paul@17 | 1336 | |
| paul@17 | 1337 | def set_special_literal(self, name, ref): |
| paul@0 | 1338 | |
| paul@17 | 1339 | """ |
| paul@17 | 1340 | Set a special name for the literal type 'name' having type 'ref'. Such |
| paul@17 | 1341 | special names provide a way of referring to literal object types. |
| paul@17 | 1342 | """ |
| paul@0 | 1343 | |
| paul@17 | 1344 | literal_name = "$L%s" % name |
| paul@17 | 1345 | value = ResolvedNameRef(literal_name, ref) |
| paul@17 | 1346 | self.set_special(literal_name, value) |
| paul@0 | 1347 | |
| paul@0 | 1348 | # Functions and invocations. |
| paul@0 | 1349 | |
| paul@36 | 1350 | def set_invocation_usage(self): |
| paul@36 | 1351 | |
| paul@36 | 1352 | """ |
| paul@36 | 1353 | Discard the current invocation storage figures, retaining the maximum |
| paul@36 | 1354 | values. |
| paul@36 | 1355 | """ |
| paul@36 | 1356 | |
| paul@36 | 1357 | for path, (current, maximum) in self.function_targets.items(): |
| paul@36 | 1358 | self.importer.function_targets[path] = self.function_targets[path] = maximum |
| paul@36 | 1359 | |
| paul@36 | 1360 | for path, (current, maximum) in self.function_arguments.items(): |
| paul@36 | 1361 | self.importer.function_arguments[path] = self.function_arguments[path] = maximum |
| paul@36 | 1362 | |
| paul@0 | 1363 | def allocate_arguments(self, path, args): |
| paul@0 | 1364 | |
| paul@0 | 1365 | """ |
| paul@0 | 1366 | Allocate temporary argument storage using current and maximum |
| paul@0 | 1367 | requirements for the given 'path' and 'args'. |
| paul@0 | 1368 | """ |
| paul@0 | 1369 | |
| paul@0 | 1370 | init_item(self.function_targets, path, lambda: [0, 0]) |
| paul@0 | 1371 | t = self.function_targets[path] |
| paul@0 | 1372 | t[0] += 1 |
| paul@0 | 1373 | t[1] = max(t[0], t[1]) |
| paul@0 | 1374 | |
| paul@0 | 1375 | init_item(self.function_arguments, path, lambda: [0, 0]) |
| paul@0 | 1376 | t = self.function_arguments[path] |
| paul@0 | 1377 | t[0] += len(args) + 1 |
| paul@0 | 1378 | t[1] = max(t[0], t[1]) |
| paul@0 | 1379 | |
| paul@0 | 1380 | def deallocate_arguments(self, path, args): |
| paul@0 | 1381 | |
| paul@0 | 1382 | "Deallocate temporary argument storage for the given 'path' and 'args'." |
| paul@0 | 1383 | |
| paul@0 | 1384 | self.function_targets[path][0] -= 1 |
| paul@0 | 1385 | self.function_arguments[path][0] -= len(args) + 1 |
| paul@0 | 1386 | |
| paul@0 | 1387 | # vim: tabstop=4 expandtab shiftwidth=4 |
