Package com.prineside.luaj.lib

Class BaseLib

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

All Implemented Interfaces:

com.esotericsoftware.kryo.KryoSerializable, ResourceFinder

Direct Known Subclasses:

JseBaseLib

public abstract class BaseLib
extends TwoArgFunction
implements ResourceFinder, com.esotericsoftware.kryo.KryoSerializable

Subclass of LibFunction which implements the lua basic library functions.

This contains all library functions listed as "basic functions" in the lua documentation for JME. The functions dofile and loadfile use the Globals.finder instance to find resource files. Since JME has no file system by default, BaseLib implements ResourceFinder using Class.getResource(String), which is the closest equivalent on JME. The default loader chain in PackageLib will use these as well.

To use basic library functions that include a ResourceFinder based on

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

 
 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"));
  

Doing so will ensure the library is properly initialized and loaded into the globals table.

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

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	BaseLib._assert
static final class	BaseLib.collectgarbage
static final class	BaseLib.dofile
static final class	BaseLib.error
static final class	BaseLib.getmetatable
static final class	BaseLib.inext
static final class	BaseLib.ipairs
static final class	BaseLib.load
static final class	BaseLib.loadfile
static final class	BaseLib.next
static final class	BaseLib.pairs
static final class	BaseLib.pcall
static final class	BaseLib.print
static final class	BaseLib.rawequal
static final class	BaseLib.rawget
static final class	BaseLib.rawlen
static final class	BaseLib.rawset
static final class	BaseLib.select
static final class	BaseLib.setmetatable
static final class	BaseLib.tonumber
static final class	BaseLib.tostring
static final class	BaseLib.type
static final class	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.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
BaseLib()

Method Summary

Modifier and Type	Method	Description
LuaValue	call(LuaValue modname, LuaValue env)	Perform one-time initialization on the library by adding base functions to the supplied environment, and returning it as the return value.
InputStream	findResource(String filename)	ResourceFinder implementation Tries to open the file as a resource, which can work for JSE and JME.
Varargs	loadFile(String filename, String mode, LuaValue env)	Load from a named file, returning the chunk or nil,error of can't load
Varargs	loadStream(InputStream is, String chunkname, String mode, LuaValue env)
void	read(com.esotericsoftware.kryo.Kryo kryo, com.esotericsoftware.kryo.io.Input input)
void	write(com.esotericsoftware.kryo.Kryo kryo, com.esotericsoftware.kryo.io.Output output)

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

call, call, call, invoke

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

call, 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, assert_, buffer, call, cBool, cDouble, cFloat, checkboolean, checkclosure, checkdouble, checkglobals, checkint, checkjstring, checklong, checknotnil, checknumber, checknumber, checkstring, checktable, checkthread, checkuserdata, checkuserdata, cInt, cNcDouble, cNcFloat, cNcInt, cObject, 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, gt, gt, gt, gt_b, gt_b, gt_b, gteq, gteq, gteq, gteq_b, gteq_b, gteq_b, inext, initupvalue1, invoke, invoke, invoke, invokemethod, invokemethod, invokemethod, invokemethod, isboolean, isclosure, isint, isinttype, islong, isnil, isnumber, isRegObject, isstring, istable, isthread, 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, markAsConst, 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, 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

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

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

Constructor Details

BaseLib

public BaseLib()

Method Details

write

public void write(com.esotericsoftware.kryo.Kryo kryo,
 com.esotericsoftware.kryo.io.Output output)

Specified by:

write in interface com.esotericsoftware.kryo.KryoSerializable

Overrides:

write in class LibFunction

read

public void read(com.esotericsoftware.kryo.Kryo kryo,
 com.esotericsoftware.kryo.io.Input input)

Specified by:

read in interface com.esotericsoftware.kryo.KryoSerializable

Overrides:

read in class LibFunction

call

public LuaValue call(LuaValue modname,
 LuaValue env)

Perform one-time initialization on the library by adding base functions to the supplied environment, and returning it as the return value.

Specified by:

call in class TwoArgFunction

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)

findResource

public InputStream findResource(String filename)

ResourceFinder implementation Tries to open the file as a resource, which can work for JSE and JME.

Specified by:

findResource in interface ResourceFinder

Returns:

InputStream, or null if not found.

loadFile

public Varargs loadFile(String filename,
 String mode,
 LuaValue env)

Load from a named file, returning the chunk or nil,error of can't load

Parameters:

env -

mode -

Returns:

Varargs containing chunk, or NIL,error-text on error

loadStream

public Varargs loadStream(InputStream is,
 String chunkname,
 String mode,
 LuaValue env)