gnu.mapping

Class CallContext

java.lang.Object

gnu.mapping.ArgListImpl

gnu.mapping.CallContext

All Implemented Interfaces:

ArgList, ArgListBuilder

public class CallContext
extends ArgListImpl
implements ArgList, ArgListBuilder

A procedure activation stack (when compiled with explicit stacks).

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.invoke.MethodHandle	applyMethod
Consumer	consumer Function results are written to this Consumer.
java.lang.Object[][]	evalFrames Current stack of evaluation frames for interpreter.
static int	MATCH_CHECK Request to on failure return error code.
static int	MATCH_CHECK_ONLY Request to on failure return error code; on failure return 0.
static int	MATCH_THROW_ON_EXCEPTION Request to throw an exception on a match failure.
int	next Index of next argument.
Procedure	proc

Fields inherited from class gnu.mapping.ArgListImpl

count

Constructor Summary

Constructors

Constructor and Description
CallContext()

Method Summary

Modifier and Type	Method and Description
void	addArg(java.lang.Object arg)
void	addArg(java.lang.Object arg0, java.lang.Object arg1, java.lang.Object arg2, java.lang.Object arg3)
int	checkDone()
void	checkKeywordsDone()
void	cleanupFromContext(int saved) Cleanup-only part of getFromContext.
java.lang.Object	getArgAsObject(int i) Index into arguments, not counting keywords.
int	getArgCount()
java.lang.Object[]	getArgs()
java.lang.Object	getFromContext(int saved) Routine to extract result and restore state after startFromContext.
static CallContext	getInstance() Get or create a CallContext for the current thread.
int	getMode()
java.lang.Object	getNextArg() Get the next incoming argument.
java.lang.Object	getNextArg(java.lang.Object defaultValue) Get the next incoming argument.
static CallContext	getOnlyInstance() Get but don't create a CallContext for the current thread.
java.lang.Object[]	getRestArgsArray()
java.lang.Object[]	getRestArgsArray(int next) Get remaining arguments as an array.
LList	getRestArgsList()
LList	getRestArgsList(int next) Get remaining arguments as a list.
ArgListVector	getRestArgsVector()
ArgListVector	getRestArgsVector(int next) Get remaining arguments are an ArgListVector.
java.lang.Object[]	getRestPlainArray()
LList	getRestPlainList(int next)
static short[]	getSortedKeywords(java.lang.String[] keywords, int nkeys)
boolean	haveArg()
void	lastArg() Note that we are done with the input arguments.
void	matchError(int code)
int	nextKeyword(java.lang.String keyword) Return index of matching keyword argument.
java.lang.Object	nextKeyword(java.lang.String keyword, java.lang.Object dfault)
int	nextKeywordAllowOthers(java.lang.String keyword)
java.lang.Object	nextKeywordAllowOthers(java.lang.String keyword, java.lang.Object dfault)
int	nextKeywordIndex(java.lang.String keyword, boolean allowOthers)
LList	peekRestArgsList()
void	popArgState()
void	pushArgState()
void	reset()
void	rewind()
void	rewind(int mode)
void	runUntilDone()
java.lang.Object	runUntilValue() Run until no more continuations, returning final result.
void	runUntilValue(Consumer out) Run until no more continuations, sending result to a COnsumer.
static void	setInstance(CallContext ctx)
void	setNextProcedure(Procedure proc)
void	setNextProcedure(Procedure proc, java.lang.invoke.MethodHandle apply)
void	setupApply(Procedure proc)
void	setupApply(Procedure proc, java.lang.Object arg0)
void	setupApply(Procedure proc, java.lang.Object arg0, java.lang.Object arg1)
void	setupApply(Procedure proc, java.lang.Object arg0, java.lang.Object arg1, java.lang.Object arg2)
void	setupApply(Procedure proc, java.lang.Object arg0, java.lang.Object arg1, java.lang.Object arg2, java.lang.Object arg3)
void	setupApplyAll(Procedure proc, java.lang.Object[] args)
void	setupApplyAll(Procedure proc, java.lang.Object[] args, int fromIndex, int toIndex)
void	shiftArgs(Procedure proc, int toDrop)
int	startFromContext() Setup routine before calling a method that takes a CallContext.
boolean	throwOnException()
void	writeValue(java.lang.Object value) Write values (of function result) to current consumer.

Methods inherited from class gnu.mapping.ArgListImpl

add, add, addAll, addAll, addArgList, addKey, addSequence, asArgList, asFreshArgList, clear, findKeyword, findKeyword, firstKeyword, getKeyword, numArguments, numKeywords, popLast, printArgs, setArgs, setArgs, setArgs, setArgs, setArgs, setArgsAll, setArgsAll, setKeys, shiftArgs

Methods inherited from class java.lang.Object

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

Methods inherited from interface gnu.mapping.ArgList

findKeyword, firstKeyword, getKeyword, numArguments, numKeywords

Methods inherited from interface gnu.mapping.ArgListBuilder

add, addAll, addAll, addKey, asArgList, asFreshArgList, clear, setArgs, setArgs, setArgs, setArgs, setArgs, setKeys

Field Detail

applyMethod

public java.lang.invoke.MethodHandle applyMethod

proc

public Procedure proc

consumer

public Consumer consumer

Function results are written to this Consumer. This may point to vstack - or some other Consumer.

next

public int next

Index of next argument. This is used by methods like getNextArg, used by callees.

MATCH_THROW_ON_EXCEPTION

public static final int MATCH_THROW_ON_EXCEPTION

Request to throw an exception on a match failure. This is instead of setting matchState to an error value.

See Also:

Constant Field Values

MATCH_CHECK

public static final int MATCH_CHECK

Request to on failure return error code. Error is indicated by check routine returning this CallContext. Otherwise, execute actual function and return result (or null).

See Also:

Constant Field Values

MATCH_CHECK_ONLY

public static final int MATCH_CHECK_ONLY

Request to on failure return error code; on failure return 0. Regardless, don't invoke body method.

See Also:

Constant Field Values

evalFrames

public java.lang.Object[][] evalFrames

Current stack of evaluation frames for interpreter.

Constructor Detail

CallContext

public CallContext()

Method Detail

setInstance

public static void setInstance(CallContext ctx)

getOnlyInstance

public static CallContext getOnlyInstance()

Get but don't create a CallContext for the current thread.

getInstance

public static CallContext getInstance()

Get or create a CallContext for the current thread.

setNextProcedure

public final void setNextProcedure(Procedure proc,
                                   java.lang.invoke.MethodHandle apply)

setNextProcedure

public final void setNextProcedure(Procedure proc)

getArgAsObject

public java.lang.Object getArgAsObject(int i)

Description copied from interface: ArgList

Index into arguments, not counting keywords. I.e. for [a b k1: c k2: d e] the index 0 returns a, 2 returns c, 3 returns d, 4 returns e.

Specified by:

getArgAsObject in interface ArgList

Overrides:

getArgAsObject in class ArgListImpl

rewind

public void rewind(int mode)

rewind

public void rewind()

reset

public void reset()

shiftArgs

public void shiftArgs(Procedure proc,
                      int toDrop)

getMode

public int getMode()

matchError

public void matchError(int code)

throwOnException

public boolean throwOnException()

haveArg

public boolean haveArg()

checkKeywordsDone

public void checkKeywordsDone()

checkDone

public int checkDone()

getArgCount

public int getArgCount()

getNextArg

public java.lang.Object getNextArg()

Get the next incoming argument.

getNextArg

public java.lang.Object getNextArg(java.lang.Object defaultValue)

Get the next incoming argument. Return defaultValue if there are no more arguments.

getRestPlainArray

public final java.lang.Object[] getRestPlainArray()

getRestArgsArray

public final java.lang.Object[] getRestArgsArray()

getRestArgsArray

public final java.lang.Object[] getRestArgsArray(int next)

Get remaining arguments as an array.

peekRestArgsList

public final LList peekRestArgsList()

getRestArgsVector

public final ArgListVector getRestArgsVector()

getRestArgsList

public final LList getRestArgsList()

getRestArgsList

public final LList getRestArgsList(int next)

Get remaining arguments as a list. Used for Scheme and Lisp rest args.

getRestPlainList

public final LList getRestPlainList(int next)

getRestArgsVector

public ArgListVector getRestArgsVector(int next)

Get remaining arguments are an ArgListVector.

Parameters:

next - The number of arguments that should be skipped. Assume either no keywords have been processed, or they all have.

lastArg

public void lastArg()

Note that we are done with the input arguments. Throw WrongArguments if there are unprocessed arguments.

getArgs

public java.lang.Object[] getArgs()

getSortedKeywords

public static short[] getSortedKeywords(java.lang.String[] keywords,
                                        int nkeys)

nextKeyword

public int nextKeyword(java.lang.String keyword)

Return index of matching keyword argument. Must be called with keywords in increasing lexicographic order.

Returns:

dfault if no matching keyword argument, or the corresponding keyword value.

nextKeywordAllowOthers

public int nextKeywordAllowOthers(java.lang.String keyword)

nextKeywordIndex

public int nextKeywordIndex(java.lang.String keyword,
                            boolean allowOthers)

nextKeyword

public java.lang.Object nextKeyword(java.lang.String keyword,
                                    java.lang.Object dfault)

nextKeywordAllowOthers

public java.lang.Object nextKeywordAllowOthers(java.lang.String keyword,
                                               java.lang.Object dfault)

setupApply

public void setupApply(Procedure proc)

setupApply

public void setupApply(Procedure proc,
                       java.lang.Object arg0)

setupApply

public void setupApply(Procedure proc,
                       java.lang.Object arg0,
                       java.lang.Object arg1)

setupApply

public void setupApply(Procedure proc,
                       java.lang.Object arg0,
                       java.lang.Object arg1,
                       java.lang.Object arg2)

setupApply

public void setupApply(Procedure proc,
                       java.lang.Object arg0,
                       java.lang.Object arg1,
                       java.lang.Object arg2,
                       java.lang.Object arg3)

setupApplyAll

public void setupApplyAll(Procedure proc,
                          java.lang.Object[] args)

setupApplyAll

public void setupApplyAll(Procedure proc,
                          java.lang.Object[] args,
                          int fromIndex,
                          int toIndex)

addArg

public void addArg(java.lang.Object arg)

addArg

public void addArg(java.lang.Object arg0,
                   java.lang.Object arg1,
                   java.lang.Object arg2,
                   java.lang.Object arg3)

runUntilDone

public void runUntilDone()
                  throws java.lang.Throwable

Throws:

java.lang.Throwable

startFromContext

public final int startFromContext()

Setup routine before calling a method that takes a CallContext. The compiler emits a call to this before a call to a method that takes a CallContext, when it wants the function result as an Object. It pushes the CallContest state so it can uses the vstack for a temporary, After the method, getFromContext extract the method's result from the vstack and restores the state.

getFromContext

public final java.lang.Object getFromContext(int saved)
                                      throws java.lang.Throwable

Routine to extract result and restore state after startFromContext.

Throws:

java.lang.Throwable

cleanupFromContext

public final void cleanupFromContext(int saved)

Cleanup-only part of getFromContext. This can be in an exception handler as an alternative to getFromContext, which is called in the non-exception case. (Alternatively, the compiler could call cleanupFromContext from a finally clause but that is less efficient, partly because the JVM stack must be empty before a finally subroutine.)

runUntilValue

public final java.lang.Object runUntilValue()
                                     throws java.lang.Throwable

Run until no more continuations, returning final result. Assume that the current applyHandle is from proc.

Throws:

java.lang.Throwable

runUntilValue

public final void runUntilValue(Consumer out)
                         throws java.lang.Throwable

Run until no more continuations, sending result to a COnsumer.

Throws:

java.lang.Throwable

writeValue

public void writeValue(java.lang.Object value)

Write values (of function result) to current consumer.

pushArgState

public final void pushArgState()

popArgState

public final void popArgState()