org.jruby.ast

Class Node

java.lang.Object

org.jruby.ast.Node

All Implemented Interfaces:

ISourcePosition, ISourcePositionHolder, ParseResult, PositionAware

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 Object
implements ISourcePositionHolder, ParseResult, ISourcePosition

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(ISourcePosition position, boolean containsAssignment)

Method Summary

Modifier and Type	Method and Description
abstract <T> T	accept(NodeVisitor<T> visitor)
abstract List<Node>	childNodes()
boolean	containsVariableAssignment() Does this node or one of its children contain an assignment?
protected static List<Node>	createList(Node... nodes)
protected static List<Node>	createList(Node node)
protected static List<Node>	createList(Node node1, Node node2)
protected static List<Node>	createList(Node node1, Node node2, Node node3)
<T extends Node> T	findFirstChild(Class<T> nodeClass)
String	getFile() Which file does this source position live in?
int	getLine() Which is the first(start) line that this source position occurs on (zero-based)
protected String	getNodeName()
abstract NodeType	getNodeType()
ISourcePosition	getPosition() Location of this node within the source
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	setNewline()
void	setPosition(ISourcePosition position)
String	toString()
String	toString(boolean indent, int indentation)
protected String	toStringInternal() Overridden by nodes that have additional internal state to be displated in toString.

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(ISourcePosition position,
            boolean containsAssignment)

Method Detail

setNewline

public void setNewline()

isNewline

public boolean isNewline()

getPosition

public ISourcePosition getPosition()

Location of this node within the source

Specified by:

getPosition in interface ISourcePositionHolder

getLine

public int getLine()

Description copied from interface: ISourcePosition

Which is the first(start) line that this source position occurs on (zero-based)

Specified by:

getLine in interface ISourcePosition

Specified by:

getLine in interface PositionAware

Returns:

the line number for the method

getFile

public 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 PositionAware

Returns:

name of the source file.

setPosition

public void setPosition(ISourcePosition position)

Specified by:

setPosition in interface ISourcePositionHolder

accept

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

childNodes

public abstract List<Node> childNodes()

createList

protected static List<Node> createList(Node node)

createList

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

createList

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

createList

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

toString

public String toString()

Overrides:

toString in class Object

toString

public String toString(boolean indent,
                       int indentation)

toStringInternal

protected 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 String getNodeName()

findFirstChild

public <T extends Node> T findFirstChild(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?