Package com.prineside.luaj.lib.jse

Class JseBaseLib

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

com.prineside.luaj.lib.BaseLib

com.prineside.luaj.lib.jse.JseBaseLib

All Implemented Interfaces:

com.esotericsoftware.kryo.KryoSerializable, ResourceFinder

public final class JseBaseLib
extends BaseLib

Subclass of BaseLib and LibFunction which implements the lua basic library functions and provides a directory based ResourceFinder as the Globals.finder.

Since JME has no file system by default, BaseLib implements ResourceFinder using Class.getResource(String). first, then falling back to Class.getResource(String) if that fails. Otherwise, the behavior is the same as that of BaseLib.

Typically, this library is included as part of a call to

 
 Globals globals = JsePlatform.standardGlobals();
 globals.get("print").call(LuaValue.valueOf("hello, world"));
  

For special cases where the smallest possible footprint is desired, a minimal set of libraries could be loaded directly via LuaValue.load(LuaValue) using code such as:

 
 Globals globals = new Globals();
 globals.load(new JseBaseLib());
 globals.get("print").call(LuaValue.valueOf("hello, world"));
  

However, other libraries such as PackageLib are not loaded in this case.

This is a direct port of the corresponding library in C.

See Also:

• Globals
• BaseLib
• ResourceFinder
• Globals.finder
• LibFunction
• Lua 5.2 Base Lib Reference

Nested Class Summary

Nested classes/interfaces inherited from class com.prineside.luaj.lib.BaseLib

BaseLib._assert, BaseLib.collectgarbage, BaseLib.dofile, BaseLib.error, BaseLib.getmetatable, BaseLib.inext, BaseLib.ipairs, BaseLib.load, BaseLib.loadfile, BaseLib.next, BaseLib.pairs, BaseLib.pcall, BaseLib.print, BaseLib.rawequal, BaseLib.rawget, BaseLib.rawlen, BaseLib.rawset, BaseLib.select, BaseLib.setmetatable, BaseLib.tonumber, BaseLib.tostring, BaseLib.type, BaseLib.xpcall

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

Method Summary

Modifier and Type	Method	Description
LuaValue	call(LuaValue modname, LuaValue env)	Perform one-time initialization on the library by creating a table containing the library functions, adding that table to the supplied environment, adding the table to package.loaded, and returning table as the return value.

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

findResource, loadFile, loadStream, read, write

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

call, call, call, invoke

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

bind, bind, call, newupe, newupl, newupn, tojstring

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

JseBaseLib

public JseBaseLib()

Method Details

call

public LuaValue call(LuaValue modname,
 LuaValue env)

Perform one-time initialization on the library by creating a table containing the library functions, adding that table to the supplied environment, adding the table to package.loaded, and returning table as the return value.

Specifically, extend the library loading to set the default value for Globals.STDIN

Overrides:

call in class BaseLib

Parameters:

modname - the module name supplied if this is loaded via 'require'.

env - the environment to load into, which must be a Globals instance.

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)