Modifier and Type	Class and Description
pack-priv static class	NNode.DeepestOverlappingNodeFinder Assumes nodes are always traversed in increasing order of their start positions.

Modifier and Type	Field and Description
private int	end
protected NNode	parent
pack-priv static final long	serialVersionUID
private int	start
private transient NType	type This is marked transient to prevent serialization.

Access	Constructor and Description
public	NNode()
public	NNode(int start, int end)

Method Summary

Modifier and Type	Method and Description
public void	addChildren(NNode... nodes)
public void	addChildren(List<? extends NNode> nodes)
protected void	addError(String msg)
protected void	addError(NNode loc, String msg)
public NType	Returns: the resulting type for the node addType(NType the new type newType) Adds a new type for the node, creating a union of the previous type and the new type.
protected void	addWarning(String msg)
protected void	addWarning(NNode loc, String msg)
protected void	bindNames(Scope s) Called by resolver to bind names into the passed scope.
public boolean	bindsName() Returns `true` if this is a name-binding node.
public int	end()
public NNode	getAstRoot()
public NNode	Returns: the deepest AST node whose start is greater than or equal to the offset, and whose end is less than or equal to the offset. Returns `null` if no node overlaps `sourceOffset`. getDeepestNodeAtOffset(int the spot at which to look for a node sourceOffset) Searches the AST for the deepest node that overlaps the specified source offset.
public Scope	Returns: the enclosing function, class, instance, module or builtin scope. If this node has not yet been resolved, returns the builtin namespace. getEnclosingNamespace() Returns the innermost enclosing scope for doing (non-attribute) name lookups.
public String	Returns: the path to the code that generated this AST getFile()
public NNode	getParent()
public Scope	getTable() Utility alias for `getType().getTable()`.
public NType	getType() Returns the type for this node.
private static NType	handleExceptionInResolve(NNode n, Throwable t)
public boolean	isCall()
public boolean	isClassDef()
public boolean	isFunctionDef()
public boolean	isLambda()
public boolean	isModule()
public boolean	isName()
public int	length()
public NType	resolve(Scope s) Node should set the resolved type in its `type` field and also return it.
public static NType	resolveExpr(NNode n, Scope s)
protected void	resolveList(List<? extends NNode> nodes, Scope s) Resolves each element of a node list in the passed scope.
protected NType	resolveListAsUnion(List<? extends NNode> nodes, Scope s) Utility method to resolve every node in `nodes` and return the union of their types.
public void	setEnd(int end)
public void	setParent(NNode parent)
public void	setStart(int start)
public NType	Returns: `newType` setType(NType the new type newType) Sets the type for the node.
public int	start()
public abstract void	visit(NNodeVisitor the object to call with this node. If the visitor returns `true`, the node also passes its children to the visitor. visitor) Visits this node and optionally its children.
protected void	visitNode(NNode n, NNodeVisitor v)
protected void	visitNodeList(List<? extends NNode> nodes, NNodeVisitor v)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

end	back to summary
private int end

parent	back to summary
protected NNode parent

serialVersionUID	back to summary
pack-priv static final long serialVersionUID

start	back to summary
private int start

type	back to summary
private transient NType type This is marked transient to prevent serialization. We re-resolve ASTs after deserializing them. It is private to ensure that the type is never `null`, as much code in the indexer assumes this precondition.

Constructor Detail

NNode	back to summary
public NNode()

NNode	back to summary
public NNode(int start, int end)

Method Detail

addChildren	back to summary
public void addChildren(NNode... nodes)

addChildren	back to summary
public void addChildren(List<? extends NNode> nodes)

addError	back to summary
protected void addError(String msg)

addError	back to summary
protected void addError(NNode loc, String msg)

addType back to summary

addType	back to summary
public NType addType(NType newType) Adds a new type for the node, creating a union of the previous type and the new type. Parameters newType:NType the new type Returns:NType the resulting type for the node Exceptions IllegalArgumentException: if `newType` is `null`

public NType addType(NType newType)

Adds a new type for the node, creating a union of the previous type and the new type.

Parameters

newType:NType: the new type

Returns:NType

the resulting type for the node

Exceptions

IllegalArgumentException:: if newType is null

addWarning	back to summary
protected void addWarning(String msg)

addWarning	back to summary
protected void addWarning(NNode loc, String msg)

bindNames	back to summary
protected void bindNames(Scope s) throws Exception Called by resolver to bind names into the passed scope.

bindsName back to summary

bindsName	back to summary
public boolean bindsName() Returns `true` if this is a name-binding node. Includes functions/lambdas, function/lambda params, classes, assignments, imports, and implicit assignment via for statements and except clauses. See Also PEP 227

public boolean bindsName()

Returns true if this is a name-binding node. Includes functions/lambdas, function/lambda params, classes, assignments, imports, and implicit assignment via for statements and except clauses.

See Also: PEP 227

end	back to summary
public int end()

getAstRoot	back to summary
public NNode getAstRoot()

getDeepestNodeAtOffset back to summary

getDeepestNodeAtOffset	back to summary
public NNode getDeepestNodeAtOffset(int sourceOffset) Searches the AST for the deepest node that overlaps the specified source offset. Can be called from any node in the AST, as it traverses to the parent before beginning the search. Parameters sourceOffset:int the spot at which to look for a node Returns:NNode the deepest AST node whose start is greater than or equal to the offset, and whose end is less than or equal to the offset. Returns `null` if no node overlaps `sourceOffset`.

public NNode getDeepestNodeAtOffset(int sourceOffset)

Searches the AST for the deepest node that overlaps the specified source offset. Can be called from any node in the AST, as it traverses to the parent before beginning the search.

Parameters

sourceOffset:int: the spot at which to look for a node

Returns:NNode

the deepest AST node whose start is greater than or equal to the offset, and whose end is less than or equal to the offset. Returns null if no node overlaps sourceOffset.

getEnclosingNamespace	back to summary
public Scope getEnclosingNamespace() Returns the innermost enclosing scope for doing (non-attribute) name lookups. If the current node defines a scope, it returns the parent scope for name lookups. Returns:Scope the enclosing function, class, instance, module or builtin scope. If this node has not yet been resolved, returns the builtin namespace.

getEnclosingNamespace

back to summary

public Scope getEnclosingNamespace()

Returns the innermost enclosing scope for doing (non-attribute) name lookups. If the current node defines a scope, it returns the parent scope for name lookups.

Returns:Scope: the enclosing function, class, instance, module or builtin scope. If this node has not yet been resolved, returns the builtin namespace.

getFile	back to summary
public String getFile() Returns:String the path to the code that generated this AST

getParent	back to summary
public NNode getParent()

getTable	back to summary
public Scope getTable() Utility alias for `getType().getTable()`.

getType	back to summary
public NType getType() Returns the type for this node. It is never `null`. If the node has not been resolved, the type will default to `Indexer.idx.builtins.None`.

handleExceptionInResolve	back to summary
private static NType handleExceptionInResolve(NNode n, Throwable t)

isCall	back to summary
public boolean isCall()

isClassDef	back to summary
public boolean isClassDef()

isFunctionDef	back to summary
public boolean isFunctionDef()

isLambda	back to summary
public boolean isLambda()

isModule	back to summary
public boolean isModule()

isName	back to summary
public boolean isName()

length	back to summary
public int length()

resolve	back to summary
public NType resolve(Scope s) throws Exception Node should set the resolved type in its `type` field and also return it.

resolveExpr	back to summary
public static NType resolveExpr(NNode n, Scope s)

resolveList	back to summary
protected void resolveList(List<? extends NNode> nodes, Scope s) Resolves each element of a node list in the passed scope. Node list may be empty or `null`.

resolveListAsUnion	back to summary
protected NType resolveListAsUnion(List<? extends NNode> nodes, Scope s) Utility method to resolve every node in `nodes` and return the union of their types. If `nodes` is empty or `null`, returns a new `NUnknownType`.

setEnd	back to summary
public void setEnd(int end)

setParent	back to summary
public void setParent(NNode parent)

setStart	back to summary
public void setStart(int start)

setType back to summary

setType	back to summary
public NType setType(NType newType) Sets the type for the node. Parameters newType:NType the new type Returns:NType `newType` Exceptions IllegalArgumentException: if `newType` is `null`

public NType setType(NType newType)

Sets the type for the node.

Parameters

newType:NType: the new type

Returns:NType

newType

Exceptions

IllegalArgumentException:: if newType is null

start	back to summary
public int start()

visit back to summary

visit	back to summary
public abstract void visit(NNodeVisitor visitor) Visits this node and optionally its children. Parameters visitor:NNodeVisitor the object to call with this node. If the visitor returns `true`, the node also passes its children to the visitor.

public abstract void visit(NNodeVisitor visitor)

Visits this node and optionally its children.

Parameters

visitor:NNodeVisitor: the object to call with this node. If the visitor returns true, the node also passes its children to the visitor.

visitNode	back to summary
protected void visitNode(NNode n, NNodeVisitor v)

visitNodeList	back to summary
protected void visitNodeList(List<? extends NNode> nodes, NNodeVisitor v)

org.python.indexer.ast back to summary

pack-priv Class NNode.DeepestOverlappingNodeFinder

Class Inheritance

extends GenericNodeVisitor

java.lang.Object
org.python.indexer.ast.DefaultNodeVisitor
org.python.indexer.ast.GenericNodeVisitor
org.python.indexer.ast.NNode.DeepestOverlappingNodeFinder

Assumes nodes are always traversed in increasing order of their start positions.

Field Summary

Modifier and Type	Field and Description
private NNode	deepest
private int	offset

Constructor Summary

Access	Constructor and Description
public	DeepestOverlappingNodeFinder(int offset)

Method Summary

Modifier and Type	Method and Description
public boolean	dispatch(NNode node) Overrides org.python.indexer.ast.GenericNodeVisitor.dispatch. Every visited node is passed to this method.
public NNode	Returns: the node, or `null` if no node overlaps the offset getNode() Returns the deepest node overlapping the desired source offset.

Field Detail

deepest	back to summary
private NNode deepest

offset	back to summary
private int offset

Constructor Detail

DeepestOverlappingNodeFinder	back to summary
public DeepestOverlappingNodeFinder(int offset)

Method Detail

dispatch back to summary

public boolean dispatch(NNode node)

Overrides org.python.indexer.ast.GenericNodeVisitor.dispatch.

Doc from org.python.indexer.ast.GenericNodeVisitor.dispatch.

Every visited node is passed to this method. The semantics for halting traversal are the same as for DefaultNodeVisitor.

Returns:boolean

true to traverse this node's children

Annotations

@Override

getNode back to summary

public NNode getNode()

Returns the deepest node overlapping the desired source offset.

Returns:NNode: the node, or null if no node overlaps the offset

public abstract Class NNode

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv Class NNode.DeepestOverlappingNodeFinder

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail