com.cloudbees.groovy.cps.impl

Class FunctionCallEnv

java.lang.Object

com.cloudbees.groovy.cps.impl.FunctionCallEnv

All Implemented Interfaces:

Env, Serializable

public class FunctionCallEnv
extends Object

Author:

Kohsuke Kawaguchi

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
FunctionCallEnv(Env caller, Continuation returnAddress, SourceLocation loc, Object _this)

Method Summary

Methods

Modifier and Type	Method and Description
void	buildStackTraceElements(List<StackTraceElement> stack, int depth) Builds the current call stack information for Throwable.getStackTrace().
Object	closureOwner() Closure or 'this' object that surrounds the currently executing code.
void	declareVariable(Class type, String name)
Continuation	getBreakAddress(String label) If we see a break statement, where should we go?
Continuation	getContinueAddress(String label) If we see a continue statement, where should we go?
Continuation	getExceptionHandler(Class<? extends Throwable> type) Finds the exception handler that catches a Throwable instance of this type.
Invoker	getInvoker() Invoker is typically scoped at the whole execution.
Object	getLocalVariable(String name)
Continuation	getReturnAddress() Where should the return statement return to?
void	setInvoker(Invoker invoker) Sets the Invoker, which gets inherited through the call chain.
void	setLocalVariable(String name, Object value)

Methods inherited from class java.lang.Object

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

Constructor Detail

FunctionCallEnv

public FunctionCallEnv(Env caller,
               Continuation returnAddress,
               SourceLocation loc,
               Object _this)

Parameters:

caller - The environment of the call site. Can be null but only if the caller is outside CPS execution.

Method Detail

declareVariable

public void declareVariable(Class type,
                   String name)

getLocalVariable

public Object getLocalVariable(String name)

setLocalVariable

public void setLocalVariable(String name,
                    Object value)

closureOwner

public Object closureOwner()

Description copied from interface: Env

Closure or 'this' object that surrounds the currently executing code. If a new closure instantiation is encountered, this is th object that becomes the owner of that closure.

setInvoker

public void setInvoker(Invoker invoker)

Sets the Invoker, which gets inherited through the call chain.

getInvoker

public Invoker getInvoker()

Description copied from interface: Env

Invoker is typically scoped at the whole execution.

Specified by:

getInvoker in interface Env

Returns:

never null

getReturnAddress

public final Continuation getReturnAddress()

Description copied from interface: Env

Where should the return statement return to?

Specified by:

getReturnAddress in interface Env

getBreakAddress

public final Continuation getBreakAddress(String label)

Description copied from interface: Env

If we see a break statement, where should we go?

Specified by:

getBreakAddress in interface Env

Parameters:

label - Specifies the loop to break from. null for nearest loop.

Returns:

For semantically correct Groovy code, the return value is never null, because not having the matching label is a compile-time error.

getContinueAddress

public final Continuation getContinueAddress(String label)

Description copied from interface: Env

If we see a continue statement, where should we go?

Specified by:

getContinueAddress in interface Env

Parameters:

label - Specifies the loop to repeat. null for nearest loop.

Returns:

For semantically correct Groovy code, the return value is never null, because not having the matching label is a compile-time error.

getExceptionHandler

public final Continuation getExceptionHandler(Class<? extends Throwable> type)

Description copied from interface: Env

Finds the exception handler that catches a Throwable instance of this type.

Specified by:

getExceptionHandler in interface Env

Returns:

never null. Even if there's no user-specified exception handler, the default 'unhandled exception handler' must be returned.

buildStackTraceElements

public void buildStackTraceElements(List<StackTraceElement> stack,
                           int depth)

Description copied from interface: Env

Builds the current call stack information for Throwable.getStackTrace().

Specified by:

buildStackTraceElements in interface Env

depth - Maximum depth of stack trace to obtain.