Package com.prineside.luaj

Class LuaClosure

java.lang.Object

com.prineside.luaj.Varargs

com.prineside.luaj.LuaValue

com.prineside.luaj.LuaFunction

com.prineside.luaj.LuaClosure

public final class LuaClosure
extends LuaFunction

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	LuaClosure.Serializer

Nested classes/interfaces inherited from class com.prineside.luaj.LuaValue

LuaValue.NillableSerializer, LuaValue.None

Nested classes/interfaces inherited from class com.prineside.luaj.Varargs

Varargs.ArrayVarargs

Field Summary

Fields

Modifier and Type	Field	Description
static final DeepClassComparator<LuaClosure>	CLASS_COMPARATOR
final FPrototype	p

Fields inherited from class com.prineside.luaj.LuaValue

ADD, CALL, CONCAT, DIV, EMPTYSTRING, ENV, EQ, FALSE, INDEX, IPAIRS, LE, LEN, LT, METATABLE, MINUSONE, MOD, MODE, MUL, NEWINDEX, NIL, NILLABLE_SERIALIZER, NILS, NONE, NOVALS, ONE, PAIRS, POW, SUB, TBOOLEAN, TFUNCTION, TINT, TLIGHTUSERDATA, TNIL, TNONE, TNUMBER, TOSTRING, TRUE, TSTRING, TTABLE, TTHREAD, TUSERDATA, TVALUE, TYPE_NAMES, UNM, ZERO

Constructor Summary

Constructors

Constructor	Description
LuaClosure(FPrototype p, LuaValue env)	Create a closure around a Prototype with a specific environment.

Method Summary

Modifier and Type	Method	Description
LuaValue	call()	Call this with 0 arguments, including metatag processing, and return only the first return value.
LuaValue	call(LuaValue arg)	Call this with 1 argument, including metatag processing, and return only the first return value.
LuaValue	call(LuaValue arg1, LuaValue arg2)	Call this with 2 arguments, including metatag processing, and return only the first return value.
LuaValue	call(LuaValue arg1, LuaValue arg2, LuaValue arg3)	Call this with 3 arguments, including metatag processing, and return only the first return value.
LuaClosure	checkclosure()	Check that the value is a LuaClosure , or throw LuaError if not
Varargs	invoke(Varargs varargs)	Should not return args (must be new varargs)
boolean	isclosure()	Check if this is a function that is a closure, meaning interprets lua bytecode for its execution
String	name()	Return a human-readable name for this function.
Varargs	onInvoke(Varargs varargs)	Callback used during tail call processing to invoke the function once.
LuaClosure	optclosure(LuaClosure defval)	Check that optional argument is a closure and return as LuaClosure
String	tojstring()	Convert to human readable String for any type.

Methods inherited from class com.prineside.luaj.LuaFunction

checkfunction, classnamestub, getmetatable, isfunction, optfunction, strvalue, type, typename

Methods inherited from class com.prineside.luaj.LuaValue

add, add, add, and, arg, arg1, argerror, assert_, buffer, call, cBool, cDouble, cFloat, checkboolean, checkdouble, checkglobals, checkint, checkjstring, checklong, checknotnil, checknumber, checknumber, checkstring, checktable, checkuserdata, checkuserdata, cInt, cNcDouble, cNcFloat, cNcInt, cObject, comparemt, concat, concat, concatmt, concatTo, concatTo, concatTo, cRegObject, div, div, div, divInto, eq, eq_b, eqmtcall, equals, error, get, get, get, gt, gt, gt, gt_b, gt_b, gt_b, gteq, gteq, gteq, gteq_b, gteq_b, gteq_b, inext, initupvalue1, invoke, invoke, invoke, invoke, invokemethod, invokemethod, invokemethod, invokemethod, isboolean, isint, isinttype, islong, isnil, isnumber, isRegObject, isstring, istable, isuserdata, isuserdata, isvalidkey, len, length, listOf, listOf, load, lt, lt, lt, lt_b, lt_b, lt_b, lteq, lteq, lteq, lteq_b, lteq_b, lteq_b, metatag, method, method, method, method, method, method, mod, mod, mod, modFrom, mul, mul, mul, narg, neg, neq, neq_b, next, not, optboolean, optdouble, optint, optjstring, optlong, optnumber, optstring, opttable, optuserdata, optuserdata, optvalue, or, pow, pow, pow, powWith, powWith, presize, raweq, raweq, raweq, raweq, raweq, rawget, rawget, rawget, rawlen, rawset, rawset, rawset, rawset, rawset, rawset, rawset, rawsetlist, set, set, set, set, set, set, set, setmetatable, strcmp, strcmp, strongvalue, sub, sub, sub, subargs, subFrom, subFrom, tableOf, tableOf, tableOf, tableOf, tableOf, tableOf, tailcallOf, testfor_b, toboolean, tobyte, tochar, todouble, tofloat, toint, tolong, tonumber, toshort, tostring, toString, touserdata, touserdata, userdataOf, userdataOf, valueOf, valueOf, valueOf, valueOf, valueOf, valueOf, varargsOf, varargsOf, varargsOf, varargsOf, varargsOf, varargsOf

Methods inherited from class com.prineside.luaj.Varargs

argcheck, checkboolean, checkclosure, checkdouble, checkfunction, checkint, checkjstring, checklong, checknotnil, checknumber, checkstring, checktable, checkuserdata, checkuserdata, checkvalue, dealias, eval, isfunction, isnil, isnoneornil, isnumber, isstring, istable, isTailcall, isuserdata, isvalue, optboolean, optclosure, optdouble, optfunction, optint, optjstring, optlong, optnumber, optstring, opttable, optuserdata, optuserdata, optvalue, toboolean, tobyte, tochar, todouble, tofloat, toint, tojstring, tolong, toshort, touserdata, touserdata, type

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

p

public final FPrototype p

CLASS_COMPARATOR

public static final DeepClassComparator<LuaClosure> CLASS_COMPARATOR

Constructor Details

LuaClosure

public LuaClosure(FPrototype p,
 LuaValue env)

Create a closure around a Prototype with a specific environment. If the prototype has upvalues, the environment will be written into the first upvalue.

Parameters:

p - the Prototype to construct this Closure for.

env - the environment to associate with the closure.

Method Details

isclosure

public boolean isclosure()

Description copied from class: LuaValue

Check if this is a function that is a closure, meaning interprets lua bytecode for its execution

Overrides:

isclosure in class LuaValue

Returns:

true if this is a closure, otherwise false

See Also:

• LuaValue.isfunction()
• LuaValue.checkclosure()
• LuaValue.optclosure(LuaClosure)
• LuaValue.TFUNCTION

optclosure

public LuaClosure optclosure(LuaClosure defval)

Description copied from class: LuaValue

Check that optional argument is a closure and return as LuaClosure

A LuaClosure is a LuaFunction that executes lua byteccode.

Overrides:

optclosure in class LuaValue

Parameters:

defval - LuaClosure to return if this is nil or none

Returns:

this cast to LuaClosure if a function, defval if nil or none, throws LuaError otherwise

See Also:

• LuaValue.checkclosure()
• LuaValue.isclosure()
• LuaValue.TFUNCTION

checkclosure

public LuaClosure checkclosure()

Description copied from class: LuaValue

Check that the value is a LuaClosure , or throw LuaError if not

LuaClosure is a subclass of LuaFunction that interprets lua bytecode.

Overrides:

checkclosure in class LuaValue

Returns:

this cast as LuaClosure

See Also:

• LuaValue.checkfunction()
• LuaValue.optclosure(LuaClosure)
• LuaValue.isclosure()
• LuaValue.TFUNCTION

tojstring

public String tojstring()

Description copied from class: LuaValue

Convert to human readable String for any type.

Overrides:

tojstring in class LuaFunction

Returns:

String for use by human readers based on type.

See Also:

• LuaValue.tostring()
• LuaValue.optjstring(String)
• LuaValue.checkjstring()
• LuaValue.isstring()
• LuaValue.TSTRING

call

public LuaValue call()

Description copied from class: LuaValue

Call this with 0 arguments, including metatag processing, and return only the first return value.

If this is a LuaFunction, call it, and return only its first return value, dropping any others. Otherwise, look for the LuaValue.CALL metatag and call that.

If the return value is a Varargs, only the 1st value will be returned. To get multiple values, use LuaValue.invoke() instead.

To call this as a method call, use LuaValue.method(LuaValue) instead.

Overrides:

call in class LuaValue

Returns:

First return value (this()), or LuaValue.NIL if there were none.

See Also:

• LuaValue.call(LuaValue)
• LuaValue.call(LuaValue,LuaValue)
• LuaValue.call(LuaValue, LuaValue, LuaValue)
• LuaValue.invoke()
• LuaValue.method(String)
• LuaValue.method(LuaValue)

call

public LuaValue call(LuaValue arg)

Description copied from class: LuaValue

Call this with 1 argument, including metatag processing, and return only the first return value.

If this is a LuaFunction, call it, and return only its first return value, dropping any others. Otherwise, look for the LuaValue.CALL metatag and call that.

If the return value is a Varargs, only the 1st value will be returned. To get multiple values, use LuaValue.invoke() instead.

To call this as a method call, use LuaValue.method(LuaValue) instead.

Overrides:

call in class LuaValue

Parameters:

arg - First argument to supply to the called function

Returns:

First return value (this(arg)), or LuaValue.NIL if there were none.

See Also:

• LuaValue.call()
• LuaValue.call(LuaValue,LuaValue)
• LuaValue.call(LuaValue, LuaValue, LuaValue)
• LuaValue.invoke(Varargs)
• LuaValue.method(String,LuaValue)
• LuaValue.method(LuaValue,LuaValue)

call

public LuaValue call(LuaValue arg1,
 LuaValue arg2)

Description copied from class: LuaValue

Call this with 2 arguments, including metatag processing, and return only the first return value.

If this is a LuaFunction, call it, and return only its first return value, dropping any others. Otherwise, look for the LuaValue.CALL metatag and call that.

If the return value is a Varargs, only the 1st value will be returned. To get multiple values, use LuaValue.invoke() instead.

To call this as a method call, use LuaValue.method(LuaValue) instead.

Overrides:

call in class LuaValue

Parameters:

arg1 - First argument to supply to the called function

arg2 - Second argument to supply to the called function

Returns:

First return value (this(arg1,arg2)), or LuaValue.NIL if there were none.

See Also:

• LuaValue.call()
• LuaValue.call(LuaValue)
• LuaValue.call(LuaValue, LuaValue, LuaValue)
• LuaValue.invoke(LuaValue, Varargs)
• LuaValue.method(String,LuaValue,LuaValue)
• LuaValue.method(LuaValue,LuaValue,LuaValue)

call

public LuaValue call(LuaValue arg1,
 LuaValue arg2,
 LuaValue arg3)

Description copied from class: LuaValue

Call this with 3 arguments, including metatag processing, and return only the first return value.

If this is a LuaFunction, call it, and return only its first return value, dropping any others. Otherwise, look for the LuaValue.CALL metatag and call that.

If the return value is a Varargs, only the 1st value will be returned. To get multiple values, use LuaValue.invoke() instead.

To call this as a method call, use LuaValue.method(LuaValue) instead.

Overrides:

call in class LuaValue

Parameters:

arg1 - First argument to supply to the called function

arg2 - Second argument to supply to the called function

arg3 - Second argument to supply to the called function

Returns:

First return value (this(arg1,arg2,arg3)), or LuaValue.NIL if there were none.

See Also:

• LuaValue.call()
• LuaValue.call(LuaValue)
• LuaValue.call(LuaValue, LuaValue)
• LuaValue.invoke(LuaValue, LuaValue, Varargs)
• LuaValue.invokemethod(LuaValue,Varargs)

invoke

public Varargs invoke(Varargs varargs)

Description copied from class: LuaValue

Should not return args (must be new varargs)

Overrides:

invoke in class LuaValue

onInvoke

public Varargs onInvoke(Varargs varargs)

Description copied from class: LuaValue

Callback used during tail call processing to invoke the function once.

This may return a TailcallVarargs to be evaluated by the client.

This should not be called directly, instead use one of the call invocation functions.

Overrides:

onInvoke in class LuaValue

Parameters:

varargs - the arguments to the call invocation.

Returns:

Varargs the return values, possible a TailcallVarargs.

See Also:

• LuaValue.call()
• LuaValue.invoke()
• LuaValue.method(LuaValue)
• LuaValue.invokemethod(LuaValue)

name

public String name()

Description copied from class: LuaFunction

Return a human-readable name for this function. Returns the last part of the class name by default. Is overridden by LuaClosure to return the source file and line, and by LibFunctions to return the name.

Overrides:

name in class LuaFunction

Returns:

common name for this function.