Package com.prineside.luaj.lib

Class TwoArgFunction

java.lang.Object

com.prineside.luaj.Varargs

com.prineside.luaj.LuaValue

com.prineside.luaj.LuaFunction

com.prineside.luaj.lib.LibFunction

com.prineside.luaj.lib.TwoArgFunction

All Implemented Interfaces:

com.esotericsoftware.kryo.KryoSerializable

Direct Known Subclasses:

BaseLib, BaseLib.error, Bit32Lib, Bit32Lib.Bit32Lib2, CoroutineLib, DebugLib, DebugLib.setmetatable, IoLib, JseMathLib.atan2, JseMathLib.log, MathLib, MathLib.BinaryOp, MathLib.fmod, OsLib, PackageLib, StringLib, TableLib

public abstract class TwoArgFunction
extends LibFunction

Abstract base class for Java function implementations that take two arguments and return one value.

Subclasses need only implement LuaValue.call(LuaValue,LuaValue) to complete this class, simplifying development. All other uses of call(), invoke(Varargs),etc, are routed through this method by this class, dropping or extending arguments with nil values as required.

If more or less than two arguments are required, or variable argument or variable return values, then use one of the related function ZeroArgFunction, OneArgFunction, ThreeArgFunction, or VarArgFunction.

See LibFunction for more information on implementation libraries and library functions.

See Also:

• call(LuaValue,LuaValue)
• LibFunction
• ZeroArgFunction
• OneArgFunction
• ThreeArgFunction
• VarArgFunction

Nested Class Summary

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 inherited from class com.prineside.luaj.lib.LibFunction

name, opcode

Fields inherited from class com.prineside.luaj.LuaFunction

s_metatable

Fields inherited from class com.prineside.luaj.LuaValue

ADD, CALL, CONCAT, DIV, EMPTYSTRING, ENV, EQ, FALSE, INDEX, LE, LEN, LT, METATABLE, MINUSONE, MOD, MODE, MUL, NEWINDEX, NIL, NILLABLE_SERIALIZER, NILS, NONE, NOVALS, ONE, 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
TwoArgFunction()	Default constructor

Method Summary

Modifier and Type	Method	Description
final LuaValue	call()	Call this with 0 arguments, including metatag processing, and return only the first return value.
final LuaValue	call(LuaValue arg)	Call this with 1 argument, including metatag processing, and return only the first return value.
abstract 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.
Varargs	invoke(Varargs varargs)	Should not return args (must be new varargs)

Methods inherited from class com.prineside.luaj.lib.LibFunction

bind, bind, call, newupe, newupl, newupn, read, tojstring, write

Methods inherited from class com.prineside.luaj.LuaFunction

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

Methods inherited from class com.prineside.luaj.LuaValue

add, add, add, and, arg, arg1, argerror, argerror, aritherror, aritherror, arithmt, arithmtwith, assert_, buffer, call, callmt, cBool, cDouble, cFloat, checkboolean, checkclosure, checkdouble, checkglobals, checkint, checkjstring, checklong, checkmetatag, checknotnil, checknumber, checknumber, checkstring, checktable, checkthread, checkuserdata, checkuserdata, cInt, cNcDouble, cNcFloat, cNcInt, cObject, compareerror, compareerror, comparemt, concat, concat, concatmt, concatTo, concatTo, concatTo, cRegObject, cVarargs, cVarargs, cVarargs, cVarargs, cVarargs, cVarargs, cVarargs, cVarargs, div, div, div, divInto, eq, eq_b, eqmtcall, equals, error, get, get, get, gettable, gt, gt, gt, gt_b, gt_b, gt_b, gteq, gteq, gteq, gteq_b, gteq_b, gteq_b, illegal, inext, initupvalue1, invoke, invoke, invoke, invokemethod, invokemethod, invokemethod, invokemethod, isboolean, isclosure, isint, isinttype, islong, isnil, isnumber, isRegObject, isstring, istable, isthread, isuserdata, isuserdata, isvalidkey, len, lenerror, length, listOf, listOf, load, lt, lt, lt, lt_b, lt_b, lt_b, lteq, lteq, lteq, lteq_b, lteq_b, lteq_b, markAsConst, metatableOf, metatag, method, method, method, method, method, method, mod, mod, mod, modFrom, mul, mul, mul, narg, neg, neq, neq_b, next, not, onInvoke, optboolean, optclosure, optdouble, optint, 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, 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

Methods inherited from class com.prineside.luaj.Varargs

argcheck, checkboolean, checkclosure, checkdouble, checkfunction, checkint, 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, optjstring, optlong, optnumber, optstring, opttable, optthread, optuserdata, optuserdata, optvalue, toboolean, tobyte, tochar, todouble, tofloat, toint, tojstring, tolong, toshort, touserdata, touserdata, type

Methods inherited from class java.lang.Object

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

Constructor Details

TwoArgFunction

public TwoArgFunction()

Default constructor

Method Details

call

public abstract 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 LibFunction

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 final 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 LibFunction

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 final 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 LibFunction

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,
 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 LibFunction

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 LibFunction