org.jruby.ast

Class Node

java.lang.Object

org.jruby.ast.Node

Direct Known Subclasses:

AliasNode, AndNode, ArgsCatNode, ArgsNode, ArgsPushNode, ArgumentNode, AssignableNode, AttrAssignNode, BackRefNode, BeginNode, BlockArgNode, BlockPassNode, BreakNode, CallNode, CaseNode, ClassNode, ClassVarNode, Colon3Node, ConstNode, DefinedNode, DotNode, DVarNode, EncodingNode, EnsureNode, EvStrNode, FalseNode, FCallNode, FlipNode, GlobalVarNode, HashNode, IfNode, InstVarNode, IterNode, KeywordArgNode, ListNode, LiteralNode, LocalVarNode, Match2Node, Match3Node, MatchNode, MethodDefNode, ModuleNode, NewlineNode, NextNode, NilNode, NthRefNode, NumericNode, OpAsgnAndNode, OpAsgnConstDeclNode, OpAsgnNode, OpAsgnOrNode, OpElementAsgnNode, OptArgNode, OrNode, RedoNode, RegexpNode, RequiredKeywordArgumentValueNode, RescueBodyNode, RescueNode, RetryNode, ReturnNode, RootNode, SClassNode, SelfNode, SplatNode, StarNode, StrNode, SuperNode, SValueNode, SymbolNode, TrueNode, UndefNode, UntilNode, VAliasNode, VCallNode, WhenNode, WhileNode, XStrNode, YieldNode, ZSuperNode

public abstract class Node
extends java.lang.Object

Base class for all Nodes in the AST

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	containsVariableAssignment
protected boolean	newline

Constructor Summary

Constructors

Constructor and Description
Node(int line, boolean containsAssignment)

Method Summary

Modifier and Type	Method and Description
abstract <T> T	accept(NodeVisitor<T> visitor)
abstract java.util.List<Node>	childNodes()
boolean	containsVariableAssignment() Does this node or one of its children contain an assignment?
protected static java.util.List<Node>	createList(Node... nodes)
protected static java.util.List<Node>	createList(Node node)
protected static java.util.List<Node>	createList(Node node1, Node node2)
protected static java.util.List<Node>	createList(Node node1, Node node2, Node node3)
boolean	executesOnce()
<T extends Node> T	findFirstChild(java.lang.Class<T> nodeClass)
java.lang.String	getFile()
int	getLine()
protected java.lang.String	getNodeName()
abstract NodeType	getNodeType()
boolean	isNewline()
boolean	isNil() Whether the node evaluates to nil and has no side effects.
boolean	needsDefinitionCheck() Check whether the given node is considered always "defined" or whether it has some form of definition check.
void	setLine(int line)
void	setNewline()
java.lang.String	toString()
java.lang.String	toString(boolean indent, int indentation)
java.lang.String	toStringExtraInfo() Not all interesting info in the AST is from Node data.
protected java.lang.String	toStringInternal() Overridden by nodes that have additional internal state to be displated in toString.
void	unsetNewline()

Methods inherited from class java.lang.Object

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

Field Detail

containsVariableAssignment

protected boolean containsVariableAssignment

newline

protected boolean newline

Constructor Detail

Node

public Node(int line,
            boolean containsAssignment)

Method Detail

setNewline

public void setNewline()

unsetNewline

public void unsetNewline()

isNewline

public boolean isNewline()

getLine

public int getLine()

getFile

public java.lang.String getFile()

setLine

public void setLine(int line)

accept

public abstract <T> T accept(NodeVisitor<T> visitor)

childNodes

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

createList

protected static java.util.List<Node> createList(Node node)

createList

protected static java.util.List<Node> createList(Node node1,
                                                 Node node2)

createList

protected static java.util.List<Node> createList(Node node1,
                                                 Node node2,
                                                 Node node3)

createList

protected static java.util.List<Node> createList(Node... nodes)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

toStringExtraInfo

public java.lang.String toStringExtraInfo()

Not all interesting info in the AST is from Node data. This method will print out anything else of note (e.g. FixnumNode's long value).

Returns:

null for no extra info or something otherwise.

toString

public java.lang.String toString(boolean indent,
                                 int indentation)

toStringInternal

protected java.lang.String toStringInternal()

Overridden by nodes that have additional internal state to be displated in toString. For nodes that have it, name is handled separately, by implementing INameNode. Child nodes are handled via iterating #childNodes.

Returns:

A string representing internal node state, or null if none.

getNodeName

protected java.lang.String getNodeName()

findFirstChild

public <T extends Node> T findFirstChild(java.lang.Class<T> nodeClass)

getNodeType

public abstract NodeType getNodeType()

Returns:

the nodeId

isNil

public boolean isNil()

Whether the node evaluates to nil and has no side effects.

Returns:

true if nil, false otherwise

needsDefinitionCheck

public boolean needsDefinitionCheck()

Check whether the given node is considered always "defined" or whether it has some form of definition check.

Returns:

Whether the type of node represents a possibly undefined construct

containsVariableAssignment

public boolean containsVariableAssignment()

Does this node or one of its children contain an assignment?

executesOnce

public boolean executesOnce()

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.