gololang.ir

Class Block

java.lang.Object

gololang.ir.GoloElement<T>

gololang.ir.GoloStatement<T>

gololang.ir.ExpressionStatement<Block>

gololang.ir.Block

All Implemented Interfaces:

java.lang.Iterable<GoloStatement<?>>

public class Block
extends ExpressionStatement<Block>
implements java.lang.Iterable<GoloStatement<?>>

Represent a block, that is a sequence of statements.

A block defines a scope, and as such maintains its local reference table.

Method Summary

Modifier and Type	Method and Description
void	accept(GoloIrVisitor visitor) Accept the visitor.
Block	add(java.lang.Object statement) Add a statement to this block.
static Block	block(java.lang.Object... statements) Creates a block containing the given statements.
java.util.List<GoloElement<?>>	children() Returns a list of all the direct children of this node.
static Block	empty() Create an empty block.
void	flatten() Merge nested blocks with this one if they don't define local variables.
java.util.Optional<ReferenceTable>	getLocalReferenceTable()
ReferenceTable	getReferenceTable()
java.util.List<GoloStatement<?>>	getStatements()
boolean	hasOnlyExpression() Checks if this blocks contains only an expression.
boolean	hasOnlyReturn() Checks if this block contains only a return statement.
boolean	hasReturn()
void	internReferenceTable() Internal method.
boolean	isEmpty()
java.util.Iterator<GoloStatement<?>>	iterator()
Block	map(FunctionReference fun) Creates a new block by applying the given function to the elements of this block.
void	merge(Block other) Merge two blocks.
static Block	nullBlock() Return the null block.
static Block	of(java.lang.Object block) Block coercion.
Block	prepend(java.lang.Object statement)
Block	ref(java.lang.Object referenceTable) Define the reference table of this block.
protected void	replaceElement(GoloElement<?> original, GoloElement<?> newElement) Replace a child.
protected Block	self()
int	size()
java.lang.String	toString()
void	walk(GoloIrVisitor visitor) Walk the visitor through this node children.

Methods inherited from class gololang.ir.ExpressionStatement

call, clearDeclarations, declarations, hasLocalDeclarations, with

Methods inherited from class gololang.ir.GoloElement

ancestor, ancestor, ancestorOfType, cantConvert, cantReplace, cantReplace, children, children, descendants, descendants, descendants, documentation, documentation, doesNotContain, enclosingModule, hasParent, hasPosition, inheritedMetadata, makeParentOf, metadata, metadata, next, next, next, ofAST, parent, positionInSourceCode, positionInSourceCode, previous, previous, previous, replaceInParentBy

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

self

protected Block self()

Specified by:

self in class GoloElement<Block>

empty

public static Block empty()

Create an empty block.

nullBlock

public static Block nullBlock()

Return the null block. Null Object that does nothing.

of

public static Block of(java.lang.Object block)

Block coercion.

if the argument is null, returns an empty block, otherwise, tries to convert it into a block, wrapping it in an empty block if necessary.

block

public static Block block(java.lang.Object... statements)

Creates a block containing the given statements.

If the only argument is already a block, returns it unchanged. If no arguments are given, returns an empty block.

Parameters:

statements - the GoloStatements composing the block.

merge

public void merge(Block other)

Merge two blocks.

Warning:the statements contained in the other block being move to this one and not copied, the other block references statements but is no more their parent. Therefore, the other block is not in a consistent state and should be dropped, since no more needed.

getReferenceTable

public ReferenceTable getReferenceTable()

getLocalReferenceTable

public java.util.Optional<ReferenceTable> getLocalReferenceTable()

Overrides:

getLocalReferenceTable in class GoloElement<Block>

ref

public Block ref(java.lang.Object referenceTable)

Define the reference table of this block.

This is a builder method.

Parameters:

referenceTable - the ReferenceTable to use in this block.

Returns:

this block

internReferenceTable

public void internReferenceTable()

Internal method.

getStatements

public java.util.List<GoloStatement<?>> getStatements()

iterator

public java.util.Iterator<GoloStatement<?>> iterator()

Specified by:

iterator in interface java.lang.Iterable<GoloStatement<?>>

map

public Block map(FunctionReference fun)
          throws java.lang.Throwable

Creates a new block by applying the given function to the elements of this block.

Throws:

java.lang.Throwable

add

public Block add(java.lang.Object statement)

Add a statement to this block.

This is a builder method.

Parameters:

statement - the statement to add to this block

Returns:

this block

Throws:

java.lang.ClassCastException - if the statement can't be converted into a GoloStatement

See Also:

GoloStatement.of(Object)

prepend

public Block prepend(java.lang.Object statement)

flatten

public void flatten()

Merge nested blocks with this one if they don't define local variables.

hasReturn

public boolean hasReturn()

size

public int size()

hasOnlyReturn

public boolean hasOnlyReturn()

Checks if this block contains only a return statement.

hasOnlyExpression

public boolean hasOnlyExpression()

Checks if this blocks contains only an expression.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

isEmpty

public boolean isEmpty()

accept

public void accept(GoloIrVisitor visitor)

Accept the visitor.

This method should only call the visitor visitXXXX method. The children of this node will be visited by the GoloElement.walk(GoloIrVisitor) method.

Specified by:

accept in class GoloElement<Block>

walk

public void walk(GoloIrVisitor visitor)

Walk the visitor through this node children.

Overrides:

walk in class GoloElement<Block>

children

public java.util.List<GoloElement<?>> children()

Returns a list of all the direct children of this node.

Overrides:

children in class GoloElement<Block>

replaceElement

protected void replaceElement(GoloElement<?> original,
                              GoloElement<?> newElement)

Replace a child.

Replace original with newElement if original is a child of this node and type matches.

Specified by:

replaceElement in class GoloElement<Block>

Parameters:

original - the original value to replace. Must be a child of this node

newElement - the element to replace with. Type must match.

See Also:

GoloElement.cantReplace(), GoloElement.cantReplace(GoloElement, GoloElement), GoloElement.doesNotContain(GoloElement), GoloElement.cantConvert(String, Object)