gololang.ir

Class GoloFunction

java.lang.Object

gololang.ir.GoloElement<T>

gololang.ir.GoloStatement<T>

gololang.ir.ExpressionStatement<GoloFunction>

gololang.ir.GoloFunction

All Implemented Interfaces:

BlockContainer<GoloFunction>, ToplevelGoloElement

public final class GoloFunction
extends ExpressionStatement<GoloFunction>
implements BlockContainer<GoloFunction>, ToplevelGoloElement

Represents a function declaration.

Such as

 function foo = |x| -> x + 1
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GoloFunction.Scope

Method Summary

Modifier and Type	Method and Description
void	accept(GoloIrVisitor visitor) Accept the visitor.
void	addDecorator(Decorator decorator)
void	addSyntheticParameters(java.util.Set<java.lang.String> names)
GoloFunction	asClosure()
ClosureReference	asClosureReference()
GoloFunction	block(java.lang.Object block) Defines the contained block.
void	captureClosedReference()
java.util.List<GoloElement<?>>	children() Returns a list of all the direct children of this node.
GoloFunction	createDecorator()
GoloFunction	decoratedWith(java.lang.Object... decorators) Adds decorators to this function.
GoloFunction	decorator()
GoloFunction	decorator(boolean d)
boolean	equals(java.lang.Object obj)
static GoloFunction	function(java.lang.Object name) Creates a function declaration.
int	getArity()
Block	getBlock()
java.lang.String	getDecoratorRef()
java.util.List<Decorator>	getDecorators()
java.lang.String	getName()
java.util.List<java.lang.String>	getParameterNames()
int	getSyntheticParameterCount()
java.util.Collection<java.lang.String>	getSyntheticParameterNames()
java.lang.String	getSyntheticSelfName()
LocalReference	getSyntheticSelfReference()
int	hashCode()
GoloFunction	inAugment()
GoloFunction	inAugment(boolean isInAugment)
GoloFunction	inScope(GoloFunction.Scope s)
void	insertMissingReturnStatement()
boolean	isAnonymous()
boolean	isDecorated()
boolean	isDecorator()
boolean	isInAugment()
boolean	isInModule()
boolean	isLocal()
boolean	isMain()
boolean	isModuleInit()
boolean	isSynthetic()
boolean	isVarargs()
GoloFunction	local()
GoloFunction	local(boolean isLocal)
GoloFunction	name(java.lang.String n)
java.lang.Object[]	parametersAsRefs() Return the parameters of this function wrapped in a ReferenceLookup.
void	removeDecorator(Decorator decorator)
protected void	replaceElement(GoloElement<?> original, GoloElement<?> newElement) Replace a child.
GoloFunction	returns(java.lang.Object expression)
GoloFunction	sameSignature() Return a new function with the same signature as this one.
protected GoloFunction	self()
void	setSyntheticSelfName(java.lang.String name)
GoloFunction	synthetic()
GoloFunction	synthetic(boolean s)
java.lang.String	toString()
static java.lang.String	uniqueName()
static java.lang.String	uniqueName(java.lang.Object base)
GoloFunction	varargs()
GoloFunction	varargs(boolean isVarargs)
GoloFunction	withParameters(java.util.Collection<?> names)
GoloFunction	withParameters(java.lang.Object... names)

Methods inherited from class gololang.ir.ExpressionStatement

call, clearDeclarations, declarations, hasLocalDeclarations, of, with

Methods inherited from class gololang.ir.GoloElement

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

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface gololang.ir.BlockContainer

body

Method Detail

self

protected GoloFunction self()

Specified by:

self in class GoloElement<GoloFunction>

function

public static GoloFunction function(java.lang.Object name)

Creates a function declaration.

Typical usage:

 function("foo").withParameters("x").returns(plus(ReferenceLookup.of("x"), constant(1)))
 

creates

 function foo = |x| -> x + 1
 

name

public GoloFunction name(java.lang.String n)

getName

public java.lang.String getName()

isMain

public boolean isMain()

isModuleInit

public boolean isModuleInit()

isAnonymous

public boolean isAnonymous()

synthetic

public GoloFunction synthetic(boolean s)

synthetic

public GoloFunction synthetic()

isSynthetic

public boolean isSynthetic()

decorator

public GoloFunction decorator()

decorator

public GoloFunction decorator(boolean d)

isDecorator

public boolean isDecorator()

local

public GoloFunction local()

local

public GoloFunction local(boolean isLocal)

isLocal

public boolean isLocal()

inScope

public GoloFunction inScope(GoloFunction.Scope s)

inAugment

public GoloFunction inAugment()

inAugment

public GoloFunction inAugment(boolean isInAugment)

isInAugment

public boolean isInAugment()

isInModule

public boolean isInModule()

asClosure

public GoloFunction asClosure()

block

public GoloFunction block(java.lang.Object block)

Defines the contained block.

This is a builder method.

Specified by:

block in interface BlockContainer<GoloFunction>

Parameters:

block - an object that can be converted into a Block

See Also:

Block.of(Object)

getBlock

public Block getBlock()

Specified by:

getBlock in interface BlockContainer<GoloFunction>

returns

public GoloFunction returns(java.lang.Object expression)

insertMissingReturnStatement

public void insertMissingReturnStatement()

varargs

public GoloFunction varargs(boolean isVarargs)

varargs

public GoloFunction varargs()

isVarargs

public boolean isVarargs()

getArity

public int getArity()

withParameters

public GoloFunction withParameters(java.lang.Object... names)

withParameters

public GoloFunction withParameters(java.util.Collection<?> names)

getSyntheticParameterCount

public int getSyntheticParameterCount()

getParameterNames

public java.util.List<java.lang.String> getParameterNames()

getSyntheticParameterNames

public java.util.Collection<java.lang.String> getSyntheticParameterNames()

addSyntheticParameters

public void addSyntheticParameters(java.util.Set<java.lang.String> names)

getSyntheticSelfName

public java.lang.String getSyntheticSelfName()

getSyntheticSelfReference

public LocalReference getSyntheticSelfReference()

setSyntheticSelfName

public void setSyntheticSelfName(java.lang.String name)

captureClosedReference

public void captureClosedReference()

decoratedWith

public GoloFunction decoratedWith(java.lang.Object... decorators)

Adds decorators to this function.

The objects are converted into a decorator if needed.

isDecorated

public boolean isDecorated()

getDecoratorRef

public java.lang.String getDecoratorRef()

addDecorator

public void addDecorator(Decorator decorator)

removeDecorator

public void removeDecorator(Decorator decorator)

getDecorators

public java.util.List<Decorator> getDecorators()

createDecorator

public GoloFunction createDecorator()

asClosureReference

public ClosureReference asClosureReference()

sameSignature

public GoloFunction sameSignature()

Return a new function with the same signature as this one.

Can be used to generate a wrapper for a given function for instance.

parametersAsRefs

public java.lang.Object[] parametersAsRefs()

Return the parameters of this function wrapped in a ReferenceLookup.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

accept

public void accept(GoloIrVisitor visitor)

Description copied from class: GoloElement

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<GoloFunction>

children

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

Description copied from class: GoloElement

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

Overrides:

children in class GoloElement<GoloFunction>

replaceElement

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

Description copied from class: GoloElement

Replace a child.

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

Specified by:

replaceElement in class GoloElement<GoloFunction>

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)

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

uniqueName

public static java.lang.String uniqueName()

uniqueName

public static java.lang.String uniqueName(java.lang.Object base)