org.luaj.vm2

类 LuaClosure

java.lang.Object

org.luaj.vm2.Varargs

org.luaj.vm2.LuaValue

org.luaj.vm2.LuaFunction

org.luaj.vm2.LuaClosure

public class LuaClosure
extends LuaFunction

Extension of LuaFunction which executes lua bytecode.

A LuaClosure is a combination of a Prototype and a LuaValue to use as an environment for execution. Normally the LuaValue is a Globals in which case the environment will contain standard lua libraries.

There are three main ways LuaClosure instances are created:

• Construct an instance using LuaClosure(Prototype, Globals, LuaValue)
• Construct it indirectly by loading a chunk via Globals.load(java.io.Reader, String)
• Execute the lua bytecode Lua.OP_CLOSURE as part of bytecode processing

To construct it directly, the Prototype is typically created via a compiler such as LuaC:

 
 String script = "print( 'hello, world' )";
 InputStream is = new ByteArrayInputStream(script.getBytes());
 Prototype p = LuaC.instance.compile(is, "script");
 LuaValue globals = JsePlatform.standardGlobals();
 LuaClosure f = new LuaClosure(p, globals);
 f.call();
 

To construct it indirectly, the Globals.load(java.io.Reader, String) method may be used:

 
 Globals globals = JsePlatform.standardGlobals();
 LuaFunction f = globals.load(new StringReader(script), "script");
 LuaClosure c = f.checkclosure();  // This may fail if LuaJC is installed.
 c.call();
 

In this example, the "checkclosure()" may fail if direct lua-to-java-bytecode compiling using LuaJC is installed, because no LuaClosure is created in that case and the value returned is a LuaFunction but not a LuaClosure.

Since a LuaClosure is a LuaFunction which is a LuaValue, all the value operations can be used directly such as:

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

另请参阅:

LuaValue, LuaFunction, LuaValue.isclosure(), LuaValue.checkclosure(), LuaValue.optclosure(LuaClosure), LoadState, Globals.compiler

字段概要

字段

限定符和类型	字段和说明
Prototype	p
UpValue[]	upValues

从类继承的字段 org.luaj.vm2.LuaFunction

s_metatable

从类继承的字段 org.luaj.vm2.LuaValue

ADD, BAND, BNOT, BOR, BXOR, CALL, CONCAT, DIV, EMPTYSTRING, ENV, EQ, FALSE, IDIV, INDEX, LE, LEN, LT, METATABLE, MINUSONE, MOD, MODE, MUL, NEWINDEX, NIL, NILS, NONE, NOVALS, ONE, POW, SHL, SHR, SUB, TBOOLEAN, TFUNCTION, TINT, TLIGHTUSERDATA, TNIL, TNONE, TNUMBER, TOSTRING, TRUE, TSTRING, TTABLE, TTHREAD, TUSERDATA, TVALUE, TYPE_NAMES, UNM, uservalue, ZERO

构造器概要

构造器

构造器和说明
LuaClosure(Prototype p, Globals globals, LuaValue env) Create a closure around a Prototype with a specific environment.

方法概要

限定符和类型	方法和说明
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 LuaClosure is a subclass of LuaFunction that interprets lua bytecode.
protected Varargs	execute(LuaValue[] stack, Varargs varargs)
LuaValue	getmetatable() Get the metatable for this LuaValue For LuaTable and LuaUserdata instances, the metatable returned is this instance metatable.
protected LuaValue	getUpvalue(int i)
Varargs	invoke(Varargs varargs) Call this with variable arguments, including metatag processing, and retain all return values in a 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 A LuaClosure is a LuaFunction that executes lua byteccode.
protected void	setUpvalue(int i, LuaValue v)
String	tojstring() Convert to human readable String for any type.

从类继承的方法 org.luaj.vm2.LuaFunction

checkfunction, classnamestub, getfenv, isfunction, optfunction, setfenv, strvalue, type, typename

从类继承的方法 org.luaj.vm2.LuaValue

add, add, add, and, arg, arg1, argerror, argerror, aritherror, aritherror, arithmt, arithmtwith, assert_, band, band, bnot, bor, bor, buffer, bxor, bxor, call, callmt, checkboolean, checkdouble, checkglobals, checkint, checkinteger, checkjstring, checklong, checkmetatag, checknotnil, checknumber, checknumber, checkstring, checktable, checkthread, checkuserdata, checkuserdata, compareerror, compareerror, comparemt, concat, concat, concatmt, concatTo, concatTo, concatTo, div, div, div, divInto, eq_b, eq, eqmtcall, equals, error, get, get, get, gettable, getuservalue, gt_b, gt_b, gt_b, gt, gt, gt, gteq_b, gteq_b, gteq_b, gteq, gteq, gteq, idiv, idiv, illegal, inext, initupvalue1, invoke, invoke, invoke, invoke, invoke, invokemethod, invokemethod, invokemethod, invokemethod, invokemethod, invokemethod, isboolean, isint, isinttype, islong, isnil, isnumber, isstring, istable, isthread, isuserdata, isuserdata, isvalidkey, jcall, jget, jset, len, lenerror, length, listOf, listOf, load, lt_b, lt_b, lt_b, lt, lt, lt, lteq_b, lteq_b, lteq_b, lteq, lteq, lteq, metatableOf, metatag, method, method, method, method, method, method, mod, mod, mod, modFrom, mul, mul, mul, narg, neg, neq_b, neq, next, not, optboolean, optdouble, optint, optinteger, optjstring, optlong, optnumber, optstring, opttable, optthread, 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, settable, setuservalue, shl, shl, shr, shr, 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, typerror, unimplemented, userdataOf, userdataOf, valueOf, valueOf, valueOf, valueOf, valueOf, valueOf, valueOf, varargsOf, varargsOf, varargsOf, varargsOf, varargsOf, varargsOf

从类继承的方法 org.luaj.vm2.Varargs

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

从类继承的方法 java.lang.Object

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

字段详细资料

p

public final Prototype p

upValues

public UpValue[] upValues

构造器详细资料

LuaClosure

public LuaClosure(Prototype p,
                  Globals globals,
                  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.

参数:

p - the Prototype to construct this Closure for.

env - the environment to associate with the closure.

方法详细资料

isclosure

public boolean isclosure()

从类复制的说明: LuaValue

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

覆盖:

isclosure 在类中 LuaValue

返回:

true if this is a closure, otherwise false

另请参阅:

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

optclosure

public LuaClosure optclosure(LuaClosure defval)

从类复制的说明: LuaValue

Check that optional argument is a closure and return as LuaClosure

A LuaClosure is a LuaFunction that executes lua byteccode.

覆盖:

optclosure 在类中 LuaValue

参数:

defval - LuaClosure to return if this is nil or none

返回:

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

另请参阅:

LuaValue.checkclosure(), LuaValue.isclosure(), LuaValue.TFUNCTION

checkclosure

public LuaClosure checkclosure()

从类复制的说明: LuaValue

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

LuaClosure is a subclass of LuaFunction that interprets lua bytecode.

覆盖:

checkclosure 在类中 LuaValue

返回:

this cast as LuaClosure

另请参阅:

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

getmetatable

public LuaValue getmetatable()

从类复制的说明: LuaValue

Get the metatable for this LuaValue

For LuaTable and LuaUserdata instances, the metatable returned is this instance metatable. For all other types, the class metatable value will be returned.

覆盖:

getmetatable 在类中 LuaFunction

返回:

metatable, or null if it there is none

另请参阅:

LuaBoolean.s_metatable, LuaNumber.s_metatable, LuaNil.s_metatable, LuaFunction.s_metatable, LuaThread.s_metatable

tojstring

public String tojstring()

从类复制的说明: LuaValue

Convert to human readable String for any type.

覆盖:

tojstring 在类中 LuaFunction

返回:

String for use by human readers based on type.

另请参阅:

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

call

public final LuaValue call()

从类复制的说明: 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.

覆盖:

call 在类中 LuaValue

返回:

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

另请参阅:

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

call

public final LuaValue call(LuaValue arg)

从类复制的说明: 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.

覆盖:

call 在类中 LuaValue

参数:

arg - First argument to supply to the called function

返回:

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

另请参阅:

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

call

public final LuaValue call(LuaValue arg1,
                           LuaValue arg2)

从类复制的说明: 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.

覆盖:

call 在类中 LuaValue

参数:

arg1 - First argument to supply to the called function

arg2 - Second argument to supply to the called function

返回:

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

另请参阅:

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 final LuaValue call(LuaValue arg1,
                           LuaValue arg2,
                           LuaValue arg3)

从类复制的说明: 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.

覆盖:

call 在类中 LuaValue

参数:

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

返回:

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

另请参阅:

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

invoke

public final Varargs invoke(Varargs varargs)

从类复制的说明: LuaValue

Call this with variable arguments, including metatag processing, and retain all return values in a Varargs.

If this is a LuaFunction, call it, and return all values. Otherwise, look for the LuaValue.CALL metatag and call that.

To get a particular return value, us Varargs.arg(int)

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

覆盖:

invoke 在类中 LuaValue

参数:

varargs - Varargs containing the arguments to supply to the called function

返回:

All return values as a Varargs instance.

另请参阅:

LuaValue.varargsOf(LuaValue[]), LuaValue.call(LuaValue), LuaValue.invoke(), LuaValue.invoke(LuaValue,Varargs), LuaValue.invokemethod(String,Varargs), LuaValue.invokemethod(LuaValue,Varargs)

onInvoke

public final Varargs onInvoke(Varargs varargs)

从类复制的说明: 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.

覆盖:

onInvoke 在类中 LuaValue

参数:

varargs - the arguments to the call invocation.

返回:

Varargs the return values, possible a TailcallVarargs.

另请参阅:

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

execute

protected Varargs execute(LuaValue[] stack,
                          Varargs varargs)

getUpvalue

protected LuaValue getUpvalue(int i)

setUpvalue

protected void setUpvalue(int i,
                          LuaValue v)

name

public String name()

从类复制的说明: 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.

覆盖:

name 在类中 LuaFunction

返回:

common name for this function.