org.classdump.luna.lib

Class StandardLibrary

java.lang.Object

org.classdump.luna.lib.StandardLibrary

public class StandardLibrary
extends Object

The configuration of the Lua standard library.

This is an immutable class that provides transformation methods for manipulating the configuration, and the installInto(StateContext) method for installing the standard library with the specified configuration into a Lua state.

Method Summary

Modifier and Type	Method and Description
static StandardLibrary	in(RuntimeEnvironment environment) Returns a default configuration for the specified environment.
org.classdump.luna.Table	installInto(org.classdump.luna.StateContext state) Installs the standard library into state, returning a new table suitable for use as the global upvalue.
StandardLibrary	withDebug(boolean hasDebug) Returns a configuration that includes the Debug library iff hasDebug is true.
StandardLibrary	withLoader(org.classdump.luna.load.ChunkLoader chunkLoader) Returns a configuration that differs from this configuration in that it uses the chunk loader chunkLoader.
StandardLibrary	withModuleLoader(ClassLoader moduleLoader) Returns a configuration that differs from this configuration in that it uses the module loader moduleLoader.

Methods inherited from class java.lang.Object

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

Method Detail

in

public static StandardLibrary in(RuntimeEnvironment environment)

Returns a default configuration for the specified environment. The default configuration does not include the Debug library, has no chunk loader and has no module loader.

If any of the standard streams defined by the runtime environment is null, the corresponding file in the I/O library (such as io.stdin) will be undefined. Additionally, if out is null, then the global function print will be undefined.

Parameters:

environment - the runtime environment, must not be null

Returns:

the default configuration

Throws:

NullPointerException - if environment is null

withLoader

public StandardLibrary withLoader(org.classdump.luna.load.ChunkLoader chunkLoader)

Returns a configuration that differs from this configuration in that it uses the chunk loader chunkLoader. If chunkLoader is null, no chunk loader is used.

Parameters:

chunkLoader - the chunk loader, may be null

Returns:

a configuration that uses loader as its chunk loader

withModuleLoader

public StandardLibrary withModuleLoader(ClassLoader moduleLoader)

Returns a configuration that differs from this configuration in that it uses the module loader moduleLoader. If moduleLoader is null, no module loader is used.

Parameters:

moduleLoader - the chunk loader, may be null

Returns:

a configuration that uses loader as its chunk loader

withDebug

public StandardLibrary withDebug(boolean hasDebug)

Returns a configuration that includes the Debug library iff hasDebug is true.

Parameters:

hasDebug - boolean flag indicating whether to include the Debug library

Returns:

a configuration that includes the Debug library iff hasDebug is true

installInto

public org.classdump.luna.Table installInto(org.classdump.luna.StateContext state)

Installs the standard library into state, returning a new table suitable for use as the global upvalue.

The returned table is instantiated using the table factory provided by state.

Parameters:

state - the Lua state context to install into, must not be null

Returns:

a new table containing the standard library

Throws:

NullPointerException - if state is null