org.classdump.luna.lib

Class ModuleLib

java.lang.Object

org.classdump.luna.lib.ModuleLib

public final class ModuleLib
extends Object

The package library provides basic facilities for loading modules in Lua. It exports one function directly in the global environment: require. Everything else is exported in a table package.

Method Summary

Modifier and Type	Method and Description
static void	install(org.classdump.luna.Table env, String modName, Object value) Register the given module in _G and mark it as loaded in package.loaded.
static void	installInto(org.classdump.luna.StateContext context, org.classdump.luna.Table env, RuntimeEnvironment runtimeEnvironment, org.classdump.luna.load.ChunkLoader chunkLoader, ClassLoader classLoader) Installs the package library to the global environment env in the state context context.
static org.classdump.luna.runtime.LuaFunction	searchpath(FileSystem fileSystem) Returns a function package.searchpath that uses fileSystem.

Methods inherited from class java.lang.Object

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

Method Detail

searchpath

public static org.classdump.luna.runtime.LuaFunction searchpath(FileSystem fileSystem)

Returns a function package.searchpath that uses fileSystem.

The following is the corresponding entry from the Lua Reference Manual:

package.searchpath (name, path [, sep [, rep]])

Searches for the given name in the given path.

A path is a string containing a sequence of templates separated by semicolons. For each template, the function replaces each interrogation mark (if any) in the template with a copy of name wherein all occurrences of sep (a dot, by default) were replaced by rep (the system's directory separator, by default), and then tries to open the resulting file name.

For instance, if the path is the string

   "./?.lua;./?.lc;/usr/local/?/init.lua"
 

the search for the name foo.a will try to open the files ./foo/a.lua, ./foo/a.lc, and /usr/local/foo/a/init.lua, in that order.

Returns the resulting name of the first file that it can open in read mode (after closing the file), or nil plus an error message if none succeeds. (This error message lists all file names it tried to open.)

Parameters:

fileSystem - the filesystem, must not be null

Returns:

the function package.searchpath

Throws:

NullPointerException - if fileSystem is null

See Also:

the Lua 5.3 Reference Manual entry for coroutine.yield

installInto

public static void installInto(org.classdump.luna.StateContext context,
                               org.classdump.luna.Table env,
                               RuntimeEnvironment runtimeEnvironment,
                               org.classdump.luna.load.ChunkLoader chunkLoader,
                               ClassLoader classLoader)

Installs the package library to the global environment env in the state context context. The package functions will use the runtime environment runtimeEnvironment, and load modules using chunkLoader (for Lua scripts), and classLoader (for Java libraries).

The nullity of runtimeEnvironment, runtimeEnvironment.fileSystem(), chunkLoader and classLoader determines the configuration in which the package library will be installed:

• if runtimeEnvironment == null || runtimeEnvironment.fileSystem() == null, then no package.config, package.path and package.searchpath will be provided, and the searchers will not include any searchers or loaders that require access to a filesystem;
• if chunkLoader == null, then no searchers and loaders that load Lua chunks will be installed;
• if classLoader == null, then no searchers and loaders that load Java modules by examining the classpath of the virtual machine will be installed.

For instance, if runtimeEnvironment, chunkLoader and classLoader are all null, then the only way for a module to be installed using the require function will be by adding a loader to package.preload.

Installs env and the module library table to env.package.loaded with the keys "_G" and "package", respectively.

Parameters:

context - the state context, must not be null

env - the global environment, must not be null

runtimeEnvironment - the runtime environment, may be null

chunkLoader - the chunk loader, may be null

classLoader - the class loader for Java modules, may be null

Throws:

NullPointerException - if context or env is null

install

public static void install(org.classdump.luna.Table env,
                           String modName,
                           Object value)

Register the given module in _G and mark it as loaded in package.loaded.

Parameters:

env - the _ENV table

modName - the module name

value - the module's table