gololang.ir

Class FunctionInvocation

java.lang.Object

gololang.ir.GoloElement<T>

gololang.ir.GoloStatement<T>

gololang.ir.ExpressionStatement<T>

gololang.ir.AbstractInvocation<FunctionInvocation>

gololang.ir.FunctionInvocation

public final class FunctionInvocation
extends AbstractInvocation<FunctionInvocation>

Represents a function call.

Field Summary

Fields inherited from class gololang.ir.AbstractInvocation

usesNamedArguments

Method Summary

Modifier and Type	Method and Description
void	accept(GoloIrVisitor visitor) Accept the visitor.
FunctionInvocation	constant()
FunctionInvocation	constant(boolean isConstant)
protected FunctionInvocation	copy()
static FunctionInvocation	create(java.lang.String name, boolean onReference, boolean onModuleState, boolean constant, java.lang.Object... args) Full function invocation creation in one call.
boolean	isAnonymous() Checks if this call is anonymous.
boolean	isConstant()
boolean	isOnModuleState()
boolean	isOnReference()
boolean	isRecursiveTailCall()
static FunctionInvocation	of(java.lang.Object name) Calls a function by name.
FunctionInvocation	onModuleState()
FunctionInvocation	onModuleState(boolean isOnModuleState)
FunctionInvocation	onReference() Define this call as being on a reference.
FunctionInvocation	onReference(boolean isOnReference) Define this call as being on a reference or not.
protected FunctionInvocation	self()
java.lang.String	toString()
FunctionInvocation	withArgs(java.lang.Object... arguments) Defines the values of the arguments for this invocation.

Methods inherited from class gololang.ir.AbstractInvocation

children, getArguments, getArity, getFunctionName, getModuleName, getName, getPackageAndClass, namedArgumentsComplete, replaceElement, setPackageAndClass, usesNamedArguments, withNamedArguments

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, getLocalReferenceTable, hasParent, hasPosition, inheritedMetadata, makeParentOf, metadata, metadata, next, next, next, ofAST, parent, positionInSourceCode, positionInSourceCode, previous, previous, previous, replaceInParentBy, walk

Methods inherited from class java.lang.Object

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

Method Detail

create

public static FunctionInvocation create(java.lang.String name,
                                        boolean onReference,
                                        boolean onModuleState,
                                        boolean constant,
                                        java.lang.Object... args)

Full function invocation creation in one call.

A lot less readable than the fluent API, but useful when doing meta-generation

Parameters:

name - the name of the function to call

onReference - tells if the call is on a reference

onModuleState - tells if the call in on a module level variable

constant - tells if the call is constant (banged)

args - the call arguments

Returns:

the fully built corresponding invocation

See Also:

of(Object)

of

public static FunctionInvocation of(java.lang.Object name)

Calls a function by name.

Typical usage:

 FunctionInvocation.of("foo").withArgs(constant("answer "), constant(42))
 

creates

 foo("answer ", 42)
 

Parameters:

name - the name of the function to call, a GoloFunction, a ReferenceLookup or a java.lang.reflect.Method

Returns:

the corresponding invocation

self

protected FunctionInvocation self()

Specified by:

self in class GoloElement<FunctionInvocation>

onReference

public FunctionInvocation onReference(boolean isOnReference)

Define this call as being on a reference or not.

For instance in:

 let f = |x| -> x + 2
 f(40)
 

the call to f is on a reference.

onReference

public FunctionInvocation onReference()

Define this call as being on a reference. Same as onReference(true).

isOnReference

public boolean isOnReference()

isAnonymous

public boolean isAnonymous()

Checks if this call is anonymous.

For instance, in:

 f("answer")(42)
 

the call with 42 is an anonymous one.

onModuleState

public FunctionInvocation onModuleState(boolean isOnModuleState)

onModuleState

public FunctionInvocation onModuleState()

isOnModuleState

public boolean isOnModuleState()

constant

public FunctionInvocation constant(boolean isConstant)

constant

public FunctionInvocation constant()

isConstant

public boolean isConstant()

isRecursiveTailCall

public boolean isRecursiveTailCall()

copy

protected FunctionInvocation copy()

withArgs

public FunctionInvocation withArgs(java.lang.Object... arguments)

Defines the values of the arguments for this invocation.

This is a builder method.

This methods appends the arguments to the existing ones, so that it can be called multiple times to create the invocation incrementally. On the other hand, it is not idempotent.

Calls AbstractInvocation.withNamedArguments() if needed.

Overrides:

withArgs in class AbstractInvocation<FunctionInvocation>

Parameters:

arguments - the arguments of the invocation. An argument can be any GoloElement, or are converted with ExpressionStatement.of(Object) otherwise, so that strings and primitives are automatically wrapped in a ConstantStatement.

Returns:

this invocation

See Also:

AbstractInvocation.withNamedArguments(), ExpressionStatement.of(Object)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

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