org.jruby.ast

Class RootNode

java.lang.Object

org.jruby.ast.Node

org.jruby.ast.RootNode

All Implemented Interfaces:

ISourcePosition, ISourcePositionHolder, ParseResult, PositionAware

public class RootNode
extends Node
implements ParseResult

Represents the top of the AST. This is a node not present in MRI. It was created to hold the top-most static scope in an easy to grab way and it also exists to hold BEGIN and END nodes. These can then be interpreted/compiled in the same places as the rest of the code.

Field Summary

Fields inherited from class org.jruby.ast.Node

containsVariableAssignment, newline

Constructor Summary

Constructors

Constructor and Description
RootNode(ISourcePosition position, DynamicScope scope, Node bodyNode, java.lang.String file)
RootNode(ISourcePosition position, DynamicScope scope, Node bodyNode, java.lang.String file, int endPosition) Deprecated.
RootNode(ISourcePosition position, DynamicScope scope, Node bodyNode, java.lang.String file, int endPosition, boolean needsCodeCoverage)

Method Summary

Modifier and Type	Method and Description
<T> T	accept(NodeVisitor<T> iVisitor)
java.util.List<Node>	childNodes()
boolean	executesOnce()
Node	getBodyNode() First real AST node to be interpreted
int	getEndPosition()
java.lang.String	getFile() Which file does this source position live in?
NodeType	getNodeType()
DynamicScope	getScope() Return the dynamic scope for this AST.
StaticScope	getStaticScope() The static scoping relationships that should get set first thing before interpretation of the code represented by this AST.
boolean	hasEndPosition()
boolean	needsCoverage()

Methods inherited from class org.jruby.ast.Node

containsVariableAssignment, createList, createList, createList, createList, findFirstChild, getLine, getNodeName, getPosition, isNewline, isNil, needsDefinitionCheck, setNewline, setPosition, toString, toString, toStringInternal

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jruby.ParseResult

getLine

Constructor Detail

RootNode

public RootNode(ISourcePosition position,
                DynamicScope scope,
                Node bodyNode,
                java.lang.String file)

RootNode

public RootNode(ISourcePosition position,
                DynamicScope scope,
                Node bodyNode,
                java.lang.String file,
                int endPosition,
                boolean needsCodeCoverage)

RootNode

@Deprecated
public RootNode(ISourcePosition position,
                            DynamicScope scope,
                            Node bodyNode,
                            java.lang.String file,
                            int endPosition)

Deprecated.

Method Detail

getNodeType

public NodeType getNodeType()

Specified by:

getNodeType in class Node

Returns:

the nodeId

getScope

public DynamicScope getScope()

Return the dynamic scope for this AST. The variable backed by this is transient so for serialization this is null. In that case we use staticScope to rebuild the dynamic scope. The real reason for this method is supporting bindings+eval. We need to pass our live dynamic scope in so when we eval we can use that dynamic scope.

Returns:

dynamic scope of this AST

getStaticScope

public StaticScope getStaticScope()

The static scoping relationships that should get set first thing before interpretation of the code represented by this AST. Actually, we use getScope first since that also can contain a live dynamic scope. We rely on this method only for interpreting a root node from a serialized format.

Specified by:

getStaticScope in interface ParseResult

Returns:

the top static scope for the AST

getFile

public java.lang.String getFile()

Description copied from interface: ISourcePosition

Which file does this source position live in?

Specified by:

getFile in interface ISourcePosition

Specified by:

getFile in interface ParseResult

Specified by:

getFile in interface PositionAware

Overrides:

getFile in class Node

Returns:

name of the source file.

getBodyNode

public Node getBodyNode()

First real AST node to be interpreted

Returns:

real top AST node

accept

public <T> T accept(NodeVisitor<T> iVisitor)

Specified by:

accept in class Node

childNodes

public java.util.List<Node> childNodes()

Specified by:

childNodes in class Node

hasEndPosition

public boolean hasEndPosition()

getEndPosition

public int getEndPosition()

needsCoverage

public boolean needsCoverage()

executesOnce

public boolean executesOnce()

Overrides:

executesOnce in class Node

Returns:

is it possible this node will execute only once. Note: This is not comprehensive. It is used to look from root node down to class/module nodes to make sure that narrow case can execute once. It is possible much deeper down the tree some nodes can only execute once but it will be marked as false because that case is not what this is for.