org.mozilla.javascript.ast

Class Name

java.lang.Object

org.mozilla.javascript.Node

org.mozilla.javascript.ast.AstNode

org.mozilla.javascript.ast.Name

All Implemented Interfaces:

java.lang.Comparable<AstNode>, java.lang.Iterable<Node>

public class Name
extends AstNode

AST node for a simple name. A simple name is an identifier that is not a keyword. Node type is Token.NAME.

This node type is also used to represent certain non-identifier names that are part of the language syntax. It's used for the "get" and "set" pseudo-keywords for object-initializer getter/setter properties, and it's also used for the "*" wildcard in E4X XML namespace and name expressions.

Nested Class Summary

Nested classes/interfaces inherited from class org.mozilla.javascript.ast.AstNode

AstNode.PositionComparator

Nested classes/interfaces inherited from class org.mozilla.javascript.Node

Node.NodeIterator

Field Summary

Fields inherited from class org.mozilla.javascript.Node

ATTRIBUTE_FLAG, BOTH, CASEARRAY_PROP, CATCH_SCOPE_PROP, CONTROL_BLOCK_PROP, DECR_FLAG, DESCENDANTS_FLAG, DESTRUCTURING_ARRAY_LENGTH, DESTRUCTURING_NAMES, DESTRUCTURING_PARAMS, DESTRUCTURING_SHORTHAND, DIRECTCALL_PROP, END_DROPS_OFF, END_RETURNS, END_RETURNS_VALUE, END_UNREACHED, END_YIELDS, EXPRESSION_CLOSURE_PROP, FUNCTION_PROP, GENERATOR_END_PROP, INCRDECR_PROP, ISNUMBER_PROP, JSDOC_PROP, LABEL_ID_PROP, LAST_PROP, LEFT, LOCAL_BLOCK_PROP, LOCAL_PROP, MEMBER_TYPE_PROP, NAME_PROP, NON_SPECIALCALL, OBJECT_IDS_PROP, PARENTHESIZED_PROP, POST_FLAG, PROPERTY_FLAG, REGEXP_PROP, RIGHT, SKIP_INDEXES_PROP, SPECIALCALL_EVAL, SPECIALCALL_PROP, SPECIALCALL_WITH, TARGETBLOCK_PROP, VARIABLE_PROP

Constructor Summary

Constructors

Constructor and Description
Name()
Name(int pos)
Name(int pos, int len)
Name(int pos, int len, java.lang.String name) Constructs a new Name
Name(int pos, java.lang.String name)

Method Summary

Modifier and Type	Method and Description
Scope	getDefiningScope() Returns the Scope in which this Name is defined.
java.lang.String	getIdentifier() Returns the node's identifier
Scope	getScope() Return the Scope associated with this node.
boolean	isLocalName() Return true if this node is known to be defined as a symbol in a lexical scope other than the top-level (global) scope.
int	length() Return the length of this node's identifier, to let you pretend it's a String.
void	setIdentifier(java.lang.String identifier) Sets the node's identifier
void	setScope(Scope s) Set the Scope associated with this node.
java.lang.String	toSource(int depth) Emits source code for this node.
void	visit(NodeVisitor v) Visits this node.

Methods inherited from class org.mozilla.javascript.ast.AstNode

addChild, codeBug, compareTo, debugPrint, depth, getAbsolutePosition, getAstRoot, getEnclosingFunction, getEnclosingScope, getLength, getLineno, getParent, getPosition, hasSideEffects, makeIndent, operatorToString, setBounds, setLength, setParent, setPosition, setRelative, shortName, toSource

Methods inherited from class org.mozilla.javascript.Node

addChildAfter, addChildBefore, addChildrenToBack, addChildrenToFront, addChildToBack, addChildToFront, getChildBefore, getDouble, getExistingIntProp, getFirstChild, getIntProp, getJsDoc, getJsDocNode, getLastChild, getLastSibling, getNext, getProp, getString, getType, hasChildren, hasConsistentReturnUsage, iterator, labelId, labelId, newNumber, newString, newString, newTarget, putIntProp, putProp, removeChild, removeChildren, removeProp, replaceChild, replaceChildAfter, resetTargets, setDouble, setJsDocNode, setLineno, setString, setType, toString, toStringTree

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

Name

public Name()

Name

public Name(int pos)

Name

public Name(int pos,
            int len)

Name

public Name(int pos,
            int len,
            java.lang.String name)

Constructs a new Name

Parameters:

pos - node start position

len - node length

name - the identifier associated with this Name node

Name

public Name(int pos,
            java.lang.String name)

Method Detail

getIdentifier

public java.lang.String getIdentifier()

Returns the node's identifier

setIdentifier

public void setIdentifier(java.lang.String identifier)

Sets the node's identifier

Throws:

java.lang.IllegalArgumentException - if identifier is null

setScope

public void setScope(Scope s)

Set the Scope associated with this node. This method does not set the scope's ast-node field to this node. The field exists only for temporary storage by the code generator. Not every name has an associated scope - typically only function and variable names (but not property names) are registered in a scope.

Overrides:

setScope in class Node

Parameters:

s - the scope. Can be null. Doesn't set any fields in the scope.

getScope

public Scope getScope()

Return the Scope associated with this node. This is only used for (and set by) the code generator, so it will always be null in frontend AST-processing code. Use getDefiningScope() to find the lexical Scope in which this Name is defined, if any.

Overrides:

getScope in class Node

getDefiningScope

public Scope getDefiningScope()

Returns the Scope in which this Name is defined.

Returns:

the scope in which this name is defined, or null if it's not defined in the current lexical scope chain

isLocalName

public boolean isLocalName()

Return true if this node is known to be defined as a symbol in a lexical scope other than the top-level (global) scope.

Returns:

true if this name appears as local variable, a let-bound variable not in the global scope, a function parameter, a loop variable, the property named in a PropertyGet, or in any other context where the node is known not to resolve to the global scope. Returns false if the node is defined in the top-level scope (i.e., its defining scope is an AstRoot object), or if its name is not defined as a symbol in the symbol table, in which case it may be an external or built-in name (or just an error of some sort.)

length

public int length()

Return the length of this node's identifier, to let you pretend it's a String. Don't confuse this method with the AstNode.getLength() method, which returns the range of characters that this node overlaps in the source input.

toSource

public java.lang.String toSource(int depth)

Description copied from class: AstNode

Emits source code for this node. Callee is responsible for calling this function recursively on children, incrementing indent as appropriate.

Note: if the parser was in error-recovery mode, some AST nodes may have null children that are expected to be non-null when no errors are present. In this situation, the behavior of the toSource method is undefined: toSource implementations may assume that the AST node is error-free, since it is intended to be invoked only at runtime after a successful parse.

Specified by:

toSource in class AstNode

Parameters:

depth - the current recursion depth, typically beginning at 0 when called on the root node.

visit

public void visit(NodeVisitor v)

Visits this node. There are no children to visit.

Specified by:

visit in class AstNode

Parameters:

v - the object to call with this node and its children