org.python.indexer.ast

Class NNode

java.lang.Object

org.python.indexer.ast.NNode

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

NAlias, NAssert, NAssign, NAttribute, NAugAssign, NBinOp, NBlock, NBoolOp, NBreak, NCall, NClassDef, NCompare, NComprehension, NContinue, NDelete, NDict, NEllipsis, NExceptHandler, NExec, NExprStmt, NFor, NFunctionDef, NGeneratorExp, NGlobal, NIf, NIfExp, NImport, NImportFrom, NIndex, NKeyword, NListComp, NModule, NName, NNum, NPass, NPlaceHolder, NPrint, NQname, NRaise, NRepr, NReturn, NSequence, NSlice, NStr, NSubscript, NTryExcept, NTryFinally, NUnaryOp, NUrl, NWhile, NWith, NYield

public abstract class NNode
extends java.lang.Object
implements java.io.Serializable

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected NNode	parent

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	addChildren(java.util.List<? extends NNode> nodes)
void	addChildren(NNode... nodes)
protected void	addError(NNode loc, java.lang.String msg)
protected void	addError(java.lang.String msg)
NType	addType(NType newType) Adds a new type for the node, creating a union of the previous type and the new type.
protected void	addWarning(NNode loc, java.lang.String msg)
protected void	addWarning(java.lang.String msg)
protected void	bindNames(Scope s) Called by resolver to bind names into the passed scope.
boolean	bindsName() Returns true if this is a name-binding node.
int	end()
NNode	getAstRoot()
NNode	getDeepestNodeAtOffset(int sourceOffset) Searches the AST for the deepest node that overlaps the specified source offset.
Scope	getEnclosingNamespace() Returns the innermost enclosing scope for doing (non-attribute) name lookups.
java.lang.String	getFile()
NNode	getParent()
Scope	getTable() Utility alias for getType().getTable().
NType	getType() Returns the type for this node.
boolean	isCall()
boolean	isClassDef()
boolean	isFunctionDef()
boolean	isLambda()
boolean	isModule()
boolean	isName()
int	length()
NType	resolve(Scope s) Node should set the resolved type in its type field and also return it.
static NType	resolveExpr(NNode n, Scope s)
protected void	resolveList(java.util.List<? extends NNode> nodes, Scope s) Resolves each element of a node list in the passed scope.
protected NType	resolveListAsUnion(java.util.List<? extends NNode> nodes, Scope s) Utility method to resolve every node in nodes and return the union of their types.
void	setEnd(int end)
void	setParent(NNode parent)
void	setStart(int start)
NType	setType(NType newType) Sets the type for the node.
int	start()
abstract void	visit(NNodeVisitor visitor) Visits this node and optionally its children.
protected void	visitNode(NNode n, NNodeVisitor v)
protected void	visitNodeList(java.util.List<? extends NNode> nodes, NNodeVisitor v)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

parent

protected NNode parent

Constructor Detail

NNode

public NNode()

NNode

public NNode(int start,
             int end)

Method Detail

setParent

public void setParent(NNode parent)

getParent

public NNode getParent()

getAstRoot

public NNode getAstRoot()

setStart

public void setStart(int start)

setEnd

public void setEnd(int end)

start

public int start()

end

public int end()

length

public int length()

getTable

public Scope getTable()

Utility alias for getType().getTable().

getType

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.

setType

public NType setType(NType newType)

Sets the type for the node.

Parameters:

newType - the new type

Returns:

newType

Throws:

java.lang.IllegalArgumentException - if newType is null

addType

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 - the new type

Returns:

the resulting type for the node

Throws:

java.lang.IllegalArgumentException - if newType is null

bindsName

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

bindNames

protected void bindNames(Scope s)
                  throws java.lang.Exception

Called by resolver to bind names into the passed scope.

Throws:

java.lang.Exception

getFile

public java.lang.String getFile()

Returns:

the path to the code that generated this AST

addChildren

public void addChildren(NNode... nodes)

addChildren

public void addChildren(java.util.List<? extends NNode> nodes)

resolveExpr

public static NType resolveExpr(NNode n,
                                Scope s)

resolve

public NType resolve(Scope s)
              throws java.lang.Exception

Node should set the resolved type in its type field and also return it.

Throws:

java.lang.Exception

isCall

public boolean isCall()

isModule

public boolean isModule()

isClassDef

public boolean isClassDef()

isFunctionDef

public boolean isFunctionDef()

isLambda

public boolean isLambda()

isName

public boolean isName()

visitNode

protected void visitNode(NNode n,
                         NNodeVisitor v)

visitNodeList

protected void visitNodeList(java.util.List<? extends NNode> nodes,
                             NNodeVisitor v)

visit

public abstract void visit(NNodeVisitor visitor)

Visits this node and optionally its children.

Parameters:

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

getEnclosingNamespace

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:

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

addWarning

protected void addWarning(java.lang.String msg)

addWarning

protected void addWarning(NNode loc,
                          java.lang.String msg)

addError

protected void addError(java.lang.String msg)

addError

protected void addError(NNode loc,
                        java.lang.String msg)

resolveListAsUnion

protected NType resolveListAsUnion(java.util.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.

resolveList

protected void resolveList(java.util.List<? extends NNode> nodes,
                           Scope s)

Resolves each element of a node list in the passed scope. Node list may be empty or null.

getDeepestNodeAtOffset

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 - the spot at which to look for a node

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.