Package com.prineside.luaj

Class LuaFunction

java.lang.Object

com.prineside.luaj.Varargs

com.prineside.luaj.LuaValue

com.prineside.luaj.LuaFunction

Direct Known Subclasses:

JavaMethod.Overload, LibFunction, LuaClosure

public abstract class LuaFunction
extends LuaValue

Base class for functions implemented in Java.

Direct subclass include org.luaj.vm2.lib.LibFunction which is the base class for all built-in library functions coded in Java, and LuaClosure, which represents a lua closure whose bytecode is interpreted when the function is invoked.

See Also:

• LuaValue
• LuaClosure

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

Modifier and Type	Field	Description
static LuaValue	s_metatable	Shared static metatable for all functions and closures.

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
LuaFunction()

Method Summary

Modifier and Type	Method	Description
LuaFunction	checkfunction()	Check that the value is a function , or throw LuaError if not
String	classnamestub()	Return the last part of the class name, to be used as a function name in tojstring and elsewhere.
LuaValue	getmetatable()	Get the metatable for this LuaValue
boolean	isfunction()	Check if this is a function
String	name()	Return a human-readable name for this function.
LuaFunction	optfunction(LuaFunction defval)	Check that optional argument is a function and return as LuaFunction
LuaString	strvalue()	Convert this value to a string if it is a LuaString or LuaNumber, or throw a LuaError if it is not
String	tojstring()	Convert to human readable String for any type.
int	type()	Get the enumeration value for the type of this value.
String	typename()	Get the String name of the type of this value.

Methods inherited from class com.prineside.luaj.LuaValue

add, add, add, and, arg, arg1, argerror, argerror, aritherror, aritherror, arithmt, arithmtwith, assert_, buffer, call, call, call, call, 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, 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

Field Details

s_metatable

public static LuaValue s_metatable

Shared static metatable for all functions and closures.

Constructor Details

LuaFunction

public LuaFunction()

Method Details

type

public int type()

Description copied from class: LuaValue

Get the enumeration value for the type of this value.

Specified by:

type in class LuaValue

Returns:

value for this type, one of LuaValue.TNIL, LuaValue.TBOOLEAN, LuaValue.TNUMBER, LuaValue.TSTRING, LuaValue.TTABLE, LuaValue.TFUNCTION, LuaValue.TUSERDATA, LuaValue.TTHREAD

See Also:

• LuaValue.typename()

typename

public String typename()

Description copied from class: LuaValue

Get the String name of the type of this value.

Specified by:

typename in class LuaValue

Returns:

name from type name list LuaValue.TYPE_NAMES corresponding to the type of this value: "nil", "boolean", "number", "string", "table", "function", "userdata", "thread"

See Also:

• LuaValue.type()

isfunction

public boolean isfunction()

Description copied from class: LuaValue

Check if this is a function

Overrides:

isfunction in class LuaValue

Returns:

true if this is a function, otherwise false

See Also:

• LuaValue.isclosure()
• LuaValue.checkfunction()
• LuaValue.optfunction(LuaFunction)
• LuaValue.TFUNCTION

checkfunction

public LuaFunction checkfunction()

Description copied from class: LuaValue

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

A LuaFunction may either be a Java function that implements functionality directly in Java, or a LuaClosure which is a LuaFunction that executes lua bytecode.

Overrides:

checkfunction in class LuaValue

Returns:

this if it is a lua function or closure

See Also:

• LuaValue.checkclosure()

optfunction

public LuaFunction optfunction(LuaFunction defval)

Description copied from class: LuaValue

Check that optional argument is a function and return as LuaFunction

A LuaFunction may either be a Java function that implements functionality directly in Java, or a LuaClosure which is a LuaFunction that executes lua bytecode.

Overrides:

optfunction in class LuaValue

Parameters:

defval - LuaFunction to return if this is nil or none

Returns:

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

See Also:

• LuaValue.checkfunction()
• LuaValue.isfunction()
• LuaValue.TFUNCTION

getmetatable

public LuaValue getmetatable()

Description copied from class: 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.

Overrides:

getmetatable in class LuaValue

Returns:

metatable, or null if it there is none

tojstring

public String tojstring()

Description copied from class: LuaValue

Convert to human readable String for any type.

Overrides:

tojstring in class LuaValue

Returns:

String for use by human readers based on type.

See Also:

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

strvalue

public LuaString strvalue()

Description copied from class: LuaValue

Convert this value to a string if it is a LuaString or LuaNumber, or throw a LuaError if it is not

Overrides:

strvalue in class LuaValue

Returns:

LuaString corresponding to the value if a string or number

classnamestub

public String classnamestub()

Return the last part of the class name, to be used as a function name in tojstring and elsewhere.

Returns:

String naming the last part of the class name after the last dot (.) or dollar sign ($). If the first character is '_', it is skipped.

name

public String name()

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.

Returns:

common name for this function.