org.classdump.luna.lib

Class OsLib

java.lang.Object

org.classdump.luna.lib.OsLib

public final class OsLib
extends Object

This library is implemented through table os.

Method Summary

Modifier and Type	Method and Description
static org.classdump.luna.runtime.LuaFunction	clock(RuntimeEnvironment runtimeEnvironment) Returns a function os.clock that uses the runtime environment runtimeEnvironment.
static org.classdump.luna.runtime.LuaFunction	getenv(RuntimeEnvironment runtimeEnvironment) Returns a function os.getenv that uses the runtime environment runtimeEnvironment.
static void	installInto(org.classdump.luna.StateContext context, org.classdump.luna.Table env, RuntimeEnvironment runtimeEnvironment) Installs the coroutine library to the global environment env in the state context context.

Methods inherited from class java.lang.Object

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

Method Detail

clock

public static org.classdump.luna.runtime.LuaFunction clock(RuntimeEnvironment runtimeEnvironment)

Returns a function os.clock that uses the runtime environment runtimeEnvironment.

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

os.clock ()

Returns an approximation of the amount in seconds of CPU time used by the program.

Parameters:

runtimeEnvironment - the runtime environment, must not be null

Returns:

the os.clock function

Throws:

NullPointerException - if runtimeEnvironment is null

See Also:

the Lua 5.3 Reference Manual entry for os.clock

getenv

public static org.classdump.luna.runtime.LuaFunction getenv(RuntimeEnvironment runtimeEnvironment)

Returns a function os.getenv that uses the runtime environment runtimeEnvironment.

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

os.getenv (varname)

Returns the value of the process environment variable varname, or nil if the variable is not defined.

Parameters:

runtimeEnvironment - the runtime environment, must not be null

Returns:

the os.getenv function

Throws:

NullPointerException - if runtimeEnvironment is null

See Also:

the Lua 5.3 Reference Manual entry for os.getenv

installInto

public static void installInto(org.classdump.luna.StateContext context,
                               org.classdump.luna.Table env,
                               RuntimeEnvironment runtimeEnvironment)

Installs the coroutine library to the global environment env in the state context context. The library will use the runtime environment runtimeEnvironment.

If runtimeEnvironment is null, then no functions will be installed by this method (i.e., the global table os will be empty).

If env.package.loaded is a table, adds the library table to it with the key "os", using raw access.

Parameters:

context - the state context, must not be null

env - the global environment, must not be null

runtimeEnvironment - the runtime environment, may be null

Throws:

NullPointerException - if context or env is null