Package org.mozilla.javascript

Class Node

java.lang.Object
org.mozilla.javascript.Node
All Implemented Interfaces:
Iterable<Node>
Direct Known Subclasses:
AstNode
public class Node extends Object implements Iterable<Node>
This class implements the root of the intermediate representation.
Author:
Norris Boyd, Mike McCabe

  • Field Details

    • FUNCTION_PROP

      public static final int FUNCTION_PROP
      See Also:

    • LOCAL_PROP

      public static final int LOCAL_PROP
      See Also:

    • LOCAL_BLOCK_PROP

      public static final int LOCAL_BLOCK_PROP
      See Also:

    • REGEXP_PROP

      public static final int REGEXP_PROP
      See Also:

    • CASEARRAY_PROP

      public static final int CASEARRAY_PROP
      See Also:

    • TARGETBLOCK_PROP

      public static final int TARGETBLOCK_PROP
      See Also:

    • VARIABLE_PROP

      public static final int VARIABLE_PROP
      See Also:

    • ISNUMBER_PROP

      public static final int ISNUMBER_PROP
      See Also:

    • DIRECTCALL_PROP

      public static final int DIRECTCALL_PROP
      See Also:

    • SPECIALCALL_PROP

      public static final int SPECIALCALL_PROP
      See Also:

    • SKIP_INDEXES_PROP

      public static final int SKIP_INDEXES_PROP
      See Also:

    • OBJECT_IDS_PROP

      public static final int OBJECT_IDS_PROP
      See Also:

    • INCRDECR_PROP

      public static final int INCRDECR_PROP
      See Also:

    • CATCH_SCOPE_PROP

      public static final int CATCH_SCOPE_PROP
      See Also:

    • LABEL_ID_PROP

      public static final int LABEL_ID_PROP
      See Also:

    • MEMBER_TYPE_PROP

      public static final int MEMBER_TYPE_PROP
      See Also:

    • NAME_PROP

      public static final int NAME_PROP
      See Also:

    • CONTROL_BLOCK_PROP

      public static final int CONTROL_BLOCK_PROP
      See Also:

    • PARENTHESIZED_PROP

      public static final int PARENTHESIZED_PROP
      See Also:

    • GENERATOR_END_PROP

      public static final int GENERATOR_END_PROP
      See Also:

    • DESTRUCTURING_ARRAY_LENGTH

      public static final int DESTRUCTURING_ARRAY_LENGTH
      See Also:

    • DESTRUCTURING_NAMES

      public static final int DESTRUCTURING_NAMES
      See Also:

    • DESTRUCTURING_PARAMS

      public static final int DESTRUCTURING_PARAMS
      See Also:

    • JSDOC_PROP

      public static final int JSDOC_PROP
      See Also:

    • EXPRESSION_CLOSURE_PROP

      public static final int EXPRESSION_CLOSURE_PROP
      See Also:

    • ARROW_FUNCTION_PROP

      public static final int ARROW_FUNCTION_PROP
      See Also:

    • TEMPLATE_LITERAL_PROP

      public static final int TEMPLATE_LITERAL_PROP
      See Also:

    • TRAILING_COMMA

      public static final int TRAILING_COMMA
      See Also:

    • OBJECT_LITERAL_DESTRUCTURING

      public static final int OBJECT_LITERAL_DESTRUCTURING
      See Also:

    • OPTIONAL_CHAINING

      public static final int OPTIONAL_CHAINING
      See Also:

    • LAST_PROP

      public static final int LAST_PROP
      See Also:

    • BOTH

      public static final int BOTH
      See Also:

    • LEFT

      public static final int LEFT
      See Also:

    • NON_SPECIALCALL

      public static final int NON_SPECIALCALL
      See Also:

    • SPECIALCALL_EVAL

      public static final int SPECIALCALL_EVAL
      See Also:

    • SPECIALCALL_WITH

      public static final int SPECIALCALL_WITH
      See Also:

    • DECR_FLAG

      public static final int DECR_FLAG
      See Also:

    • POST_FLAG

      public static final int POST_FLAG
      See Also:

    • PROPERTY_FLAG

      public static final int PROPERTY_FLAG
      See Also:

    • ATTRIBUTE_FLAG

      public static final int ATTRIBUTE_FLAG
      See Also:

    • DESCENDANTS_FLAG

      public static final int DESCENDANTS_FLAG
      See Also:

    • END_UNREACHED

      public static final int END_UNREACHED
      These flags enumerate the possible ways a statement/function can terminate. These flags are used by endCheck() and by the Parser to detect inconsistent return usage.

      END_UNREACHED is reserved for code paths that are assumed to always be able to execute (example: throw, continue)

      END_DROPS_OFF indicates if the statement can transfer control to the next one. Statement such as return dont. A compound statement may have some branch that drops off control to the next statement.

      END_RETURNS indicates that the statement can return (without arguments) END_RETURNS_VALUE indicates that the statement can return a value.

      A compound statement such as if (condition) { return value; } Will be detected as (END_DROPS_OFF | END_RETURN_VALUE) by endCheck()

      See Also:

    • END_DROPS_OFF

      public static final int END_DROPS_OFF
      See Also:

    • END_RETURNS

      public static final int END_RETURNS
      See Also:

    • END_RETURNS_VALUE

      public static final int END_RETURNS_VALUE
      See Also:

    • END_YIELDS

      public static final int END_YIELDS
      See Also:

    • type

      protected int type

    • next

      protected Node next

    • first

      protected Node first

    • last

      protected Node last

    • lineno

      protected int lineno

    • propListHead

      protected org.mozilla.javascript.Node.PropListItem propListHead
      Linked list of properties. Since vast majority of nodes would have no more then 2 properties, linked list saves memory and provides fast lookup. If this does not holds, propListHead can be replaced by UintMap.

  • Constructor Details

    • Node

      public Node(int nodeType)

    • Node

      public Node(int nodeType, Node child)

    • Node

      public Node(int nodeType, Node left, Node right)

    • Node

      public Node(int nodeType, Node left, Node mid, Node right)

    • Node

      public Node(int nodeType, int line, int column)

    • Node

      public Node(int nodeType, Node child, int line, int column)

    • Node

      public Node(int nodeType, Node left, Node right, int line, int column)

    • Node

      public Node(int nodeType, Node left, Node mid, Node right, int line, int column)

  • Method Details

    • newNumber

      public static Node newNumber(double number)

    • newString

      public static Node newString(String str)

    • newString

      public static Node newString(int type, String str)

    • getType

      public int getType()

    • setType

      public Node setType(int type)
      Sets the node type and returns this node.

    • getJsDoc

      public String getJsDoc()
      Gets the JsDoc comment string attached to this node.
      Returns:
      the comment string or null if no JsDoc is attached to this node

    • getJsDocNode

      public Comment getJsDocNode()
      Gets the JsDoc Comment object attached to this node.
      Returns:
      the Comment or null if no JsDoc is attached to this node

    • setJsDocNode

      public void setJsDocNode(Comment jsdocNode)
      Sets the JsDoc comment string attached to this node.

    • hasChildren

      public boolean hasChildren()

    • getFirstChild

      public Node getFirstChild()

    • getLastChild

      public Node getLastChild()

    • getNext

      public Node getNext()

    • getChildBefore

      public Node getChildBefore(Node child)

    • getLastSibling

      public Node getLastSibling()

    • addChildToFront

      public void addChildToFront(Node child)

    • addChildToBack

      public void addChildToBack(Node child)

    • addChildrenToFront

      public void addChildrenToFront(Node children)

    • addChildrenToBack

      public void addChildrenToBack(Node children)

    • addChildBefore

      public void addChildBefore(Node newChild, Node node)
      Add 'child' before 'node'.

    • addChildAfter

      public void addChildAfter(Node newChild, Node node)
      Add 'child' after 'node'.

    • removeChild

      public void removeChild(Node child)

    • replaceChild

      public void replaceChild(Node child, Node newChild)

    • replaceChildAfter

      public void replaceChildAfter(Node prevChild, Node newChild)

    • removeChildren

      public void removeChildren()

    • iterator

      public Iterator<Node> iterator()
      Returns an Iterator over the node's children.
      Specified by:
      iterator in interface Iterable<Node>

    • removeProp

      public void removeProp(int propType)

    • getProp

      public Object getProp(int propType)

    • getIntProp

      public int getIntProp(int propType, int defaultValue)

    • getExistingIntProp

      public int getExistingIntProp(int propType)

    • putProp

      public void putProp(int propType, Object prop)

    • putIntProp

      public void putIntProp(int propType, int prop)

    • getLineno

      public int getLineno()
      Return the line number recorded for this node.
      Returns:
      the line number

    • setLineColumnNumber

      public void setLineColumnNumber(int lineno, int column)

    • getDouble

      public final double getDouble()
      Can only be called when getType() == Token.NUMBER

    • setDouble

      public final void setDouble(double number)

    • getBigInt

      public BigInteger getBigInt()
      Can only be called when getType() == Token.BIGINT

    • setBigInt

      public void setBigInt(BigInteger bigInt)

    • getString

      public final String getString()
      Can only be called when node has String context.

    • setString

      public final void setString(String s)
      Can only be called when node has String context.

    • getScope

      public Scope getScope()
      Can only be called when node has String context.

    • setScope

      public void setScope(Scope s)
      Can only be called when node has String context.

    • newTarget

      public static Node newTarget()

    • labelId

      public final int labelId()

    • labelId

      public void labelId(int labelId)

    • hasConsistentReturnUsage

      public boolean hasConsistentReturnUsage()
      Checks that every return usage in a function body is consistent with the requirements of strict-mode.
      Returns:
      true if the function satisfies strict mode requirement.

    • hasSideEffects

      public boolean hasSideEffects()

    • resetTargets

      public void resetTargets()
      Recursively unlabel every TARGET or YIELD node in the tree.

      This is used and should only be used for inlining finally blocks where jsr instructions used to be. It is somewhat hackish, but implementing a clone() operation would take much, much more effort.

      This solution works for inlining finally blocks because you should never be writing any given block to the class file simultaneously. Therefore, an unlabeling will never occur in the middle of a block.

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • toStringTree

      public String toStringTree(ScriptNode treeTop)

    • getColumn

      public int getColumn()
      Returns:
      the column of where a Node is defined in source. If the column is -1, it was never initialized. One-based.

      May be overridden by sub classes