org.luaj.vm2.lib
Class BaseLib

java.lang.Object
  org.luaj.vm2.Varargs
      org.luaj.vm2.LuaValue
          org.luaj.vm2.LuaFunction
              org.luaj.vm2.lib.LibFunction
                  org.luaj.vm2.lib.TwoArgFunction
                      org.luaj.vm2.lib.BaseLib

All Implemented Interfaces:

ResourceFinder

Direct Known Subclasses:

JseBaseLib

public class BaseLib
extends TwoArgFunction
implements ResourceFinder

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 directory lookup, use JseBaseLib instead.

Typically, this library is included as part of a call to either JsePlatform.standardGlobals() or JmePlatform.standardGlobals()

 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:

JseBaseLib, ResourceFinder, Globals.finder, LibFunction, JsePlatform, JmePlatform, Lua 5.2 Base Lib Reference

Field Summary

Fields inherited from class org.luaj.vm2.lib.LibFunction

name, opcode

Fields inherited from class org.luaj.vm2.LuaFunction

s_metatable

Fields inherited from class org.luaj.vm2.LuaValue

ADD, CALL, CONCAT, DIV, EMPTYSTRING, ENV, EQ, FALSE, INDEX, LE, LEN, LT, METATABLE, MINUSONE, MOD, MODE, MUL, NEWINDEX, NIL, 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

BaseLib()

Method Summary

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.
java.io.InputStream	findResource(java.lang.String filename) ResourceFinder implementation Tries to open the file as a resource, which can work for JSE and JME.
Varargs	loadFile(java.lang.String filename, java.lang.String mode, LuaValue env) Load from a named file, returning the chunk or nil,error of can't load
Varargs	loadStream(java.io.InputStream is, java.lang.String chunkname, java.lang.String mode, LuaValue env)

Methods inherited from class org.luaj.vm2.lib.TwoArgFunction

call, call, call, invoke

Methods inherited from class org.luaj.vm2.lib.LibFunction

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

Methods inherited from class org.luaj.vm2.LuaFunction

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

Methods inherited from class org.luaj.vm2.LuaValue

add, add, add, and, arg, arg1, argerror, argerror, aritherror, aritherror, arithmt, arithmtwith, assert_, buffer, call, callmt, checkboolean, checkclosure, 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, gt_b, gt_b, gt_b, gt, gt, gt, gteq_b, gteq_b, gteq_b, gteq, gteq, gteq, illegal, inext, initupvalue1, invoke, invoke, invoke, invoke, invoke, invokemethod, invokemethod, invokemethod, invokemethod, invokemethod, invokemethod, isboolean, isclosure, isint, isinttype, islong, isnil, isnumber, isstring, istable, isthread, isuserdata, isuserdata, isvalidkey, 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, onInvoke, optboolean, optclosure, 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, 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, varargsOf, varargsOf, varargsOf, varargsOf, varargsOf, varargsOf

Methods inherited from class org.luaj.vm2.Varargs

argcheck, checkboolean, checkclosure, checkdouble, checkfunction, checkint, checkinteger, checkjstring, checklong, checknotnil, checknumber, checkstring, checktable, checkthread, checkuserdata, checkuserdata, checkvalue, 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

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseLib

public BaseLib()

Method Detail

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 java.io.InputStream findResource(java.lang.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.

See Also:

BaseLib, JseBaseLib

loadFile

public Varargs loadFile(java.lang.String filename,
                        java.lang.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(java.io.InputStream is,
                          java.lang.String chunkname,
                          java.lang.String mode,
                          LuaValue env)