org.luaj.vm2.lib

类 PackageLib

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.PackageLib

public class PackageLib
extends TwoArgFunction

Subclass of LibFunction which implements the lua standard package and module library functions.

Lua Environment Variables

The following variables are available to lua scrips when this library has been loaded:

• "package.loaded" Lua table of loaded modules.
• "package.path" Search path for lua scripts.
• "package.preload" Lua table of uninitialized preload functions.
• "package.searchers" Lua table of functions that search for object to load.

Java Environment Variables

These Java environment variables affect the library behavior:

• "luaj.package.path" Initial value for "package.path". Default value is "?.lua"

Loading

Typically, this library is included as part of a call to either JsePlatform.standardGlobals() or org.luaj.vm2.lib.jme.JmePlatform#standardGlobals()

 
 Globals globals = JsePlatform.standardGlobals();
 System.out.println( globals.get("require").call"foo") );
  

To instantiate and use it directly, link it into your globals table via LuaValue.load(LuaValue) using code such as:

 
 Globals globals = new Globals();
 globals.load(new JseBaseLib());
 globals.load(new PackageLib());
 System.out.println( globals.get("require").call("foo") );
  

Limitations

This library has been implemented to match as closely as possible the behavior in the corresponding library in C. However, the default filesystem search semantics are different and delegated to the bas library as outlined in the BaseLib and JseBaseLib documentation.

另请参阅:

LibFunction, BaseLib, JseBaseLib, JsePlatform, org.luaj.vm2.lib.jme.JmePlatform, Lua 5.2 Package Lib Reference

嵌套类概要

嵌套类

限定符和类型	类和说明
class	PackageLib.class_searcher
class	PackageLib.java_searcher
static class	PackageLib.loadlib
class	PackageLib.lua_searcher
class	PackageLib.module
class	PackageLib.preload_searcher
class	PackageLib.require require (modname) Loads the given module.
class	PackageLib.searchpath

字段概要

字段

限定符和类型	字段和说明
PackageLib.class_searcher	class_searcher
static String	DEFAULT_LUA_PATH The default value to use for package.path.
PackageLib.java_searcher	java_searcher Loader that loads as a Java class.
PackageLib.lua_searcher	lua_searcher Loader that loads as a lua script using the lua path currently in path
PackageLib.module	module
PackageLib.preload_searcher	preload_searcher Loader that loads from preload table if found there
PackageLib.require	require

从类继承的字段 org.luaj.vm2.lib.LibFunction

name, opcode

从类继承的字段 org.luaj.vm2.LuaFunction

s_metatable

从类继承的字段 org.luaj.vm2.LuaValue

ADD, BAND, BNOT, BOR, BXOR, CALL, CONCAT, DIV, EMPTYSTRING, ENV, EQ, FALSE, IDIV, INDEX, LE, LEN, LT, METATABLE, MINUSONE, MOD, MODE, MUL, NEWINDEX, NIL, NILS, NONE, NOVALS, ONE, POW, SHL, SHR, SUB, TBOOLEAN, TFUNCTION, TINT, TLIGHTUSERDATA, TNIL, TNONE, TNUMBER, TOSTRING, TRUE, TSTRING, TTABLE, TTHREAD, TUSERDATA, TVALUE, TYPE_NAMES, UNM, uservalue, ZERO

构造器概要

构造器

构造器和说明
PackageLib()

方法概要

限定符和类型	方法和说明
LuaValue	call(LuaValue modname, LuaValue env) Perform one-time initialization on the library by adding package functions to the supplied environment, and returning it as the return value.
void	setIsLoaded(String name, LuaTable value) Allow packages to mark themselves as loaded
void	setLuaPath(String newLuaPath) Set the lua path used by this library instance to a new value.
static String	toClassname(String filename) Convert lua filename to valid class name
String	tojstring() Convert to human readable String for any type.

从类继承的方法 org.luaj.vm2.lib.TwoArgFunction

call, call, call, invoke

从类继承的方法 org.luaj.vm2.lib.LibFunction

bind, bind, call, newupe, newupl, newupn

从类继承的方法 org.luaj.vm2.LuaFunction

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

从类继承的方法 org.luaj.vm2.LuaValue

add, add, add, and, arg, arg1, argerror, argerror, aritherror, aritherror, arithmt, arithmtwith, assert_, band, band, bnot, bor, bor, buffer, bxor, bxor, 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, getuservalue, gt_b, gt_b, gt_b, gt, gt, gt, gteq_b, gteq_b, gteq_b, gteq, gteq, gteq, idiv, idiv, 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, jcall, jget, jset, 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, setuservalue, shl, shl, shr, shr, 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, valueOf, varargsOf, varargsOf, varargsOf, varargsOf, varargsOf, varargsOf

从类继承的方法 org.luaj.vm2.Varargs

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

从类继承的方法 java.lang.Object

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

字段详细资料

DEFAULT_LUA_PATH

public static final String DEFAULT_LUA_PATH

The default value to use for package.path. This can be set with the system property "luaj.package.path", and is "?.lua" by default.

preload_searcher

public PackageLib.preload_searcher preload_searcher

Loader that loads from preload table if found there

lua_searcher

public PackageLib.lua_searcher lua_searcher

Loader that loads as a lua script using the lua path currently in path

java_searcher

public PackageLib.java_searcher java_searcher

Loader that loads as a Java class. Class must have public constructor and be a LuaValue.

class_searcher

public PackageLib.class_searcher class_searcher

require

public PackageLib.require require

module

public PackageLib.module module

构造器详细资料

PackageLib

public PackageLib()

方法详细资料

call

public LuaValue call(LuaValue modname,
                     LuaValue env)

Perform one-time initialization on the library by adding package functions to the supplied environment, and returning it as the return value. It also creates the package.preload and package.loaded tables for use by other libraries.

指定者:

call 在类中 TwoArgFunction

参数:

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

env - the environment to load into, typically a Globals instance.

返回:

First return value (this(arg1,arg2)), or LuaValue.NIL if there were none.

另请参阅:

LuaValue.call(), LuaValue.call(LuaValue), LuaValue.call(LuaValue, LuaValue, LuaValue), LuaValue.invoke(LuaValue, Varargs), LuaValue.method(String,LuaValue,LuaValue), LuaValue.method(LuaValue,LuaValue,LuaValue)

setIsLoaded

public void setIsLoaded(String name,
                        LuaTable value)

Allow packages to mark themselves as loaded

setLuaPath

public void setLuaPath(String newLuaPath)

Set the lua path used by this library instance to a new value. Merely sets the value of path to be used in subsequent searches.

tojstring

public String tojstring()

从类复制的说明: LuaValue

Convert to human readable String for any type.

覆盖:

tojstring 在类中 LibFunction

返回:

String for use by human readers based on type.

另请参阅:

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

toClassname

public static final String toClassname(String filename)

Convert lua filename to valid class name