org.classdump.luna.compiler

Class CompilerSettings

java.lang.Object

org.classdump.luna.compiler.CompilerSettings

public final class CompilerSettings
extends Object

An immutable class encapsulating the settings of the compilation of Lua to Java bytecode by LuaCompiler.

The settings are the following

• CPU accounting (CompilerSettings.CPUAccountingMode): controls whether and how the functions generated by the compiler account for number of ticks spent in execution and pause when their time slice has expired;
• const folding (boolean): when true, constants are folded at compile time (note that this does not have an influence on the number of ticks counted);
• const caching (boolean): when true, boxed numeric constants are stored as static fields rather than being instantiated (and boxed) at execution time;
• node size limit (int): when positive, long functions are split up into smaller Java methods (each containing at most the specified number of IR nodes); otherwise, a single method containing the entire function code is generated. Java class files impose a strict limit of 64 kB per method: this setting allows the compilation of arbitrarily-long Lua functions.

To obtain the settings with sensible defaults, use defaultSettings(). To obtain the default settings with CPU accounting disabled, use defaultNoAccountingSettings().

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CompilerSettings.CPUAccountingMode CPU accounting mode.

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_BYTE_STRING_MODE The default byte string mode.
static boolean	DEFAULT_CONST_CACHING_MODE The default const caching mode.
static boolean	DEFAULT_CONST_FOLDING_MODE The default const folding mode.
static CompilerSettings.CPUAccountingMode	DEFAULT_CPU_ACCOUNTING_MODE The default CPU accounting mode.
static int	DEFAULT_NODE_SIZE_LIMIT The default method size limit.

Method Summary

Modifier and Type	Method and Description
boolean	byteStrings()
boolean	constCaching() Returns the const caching mode.
boolean	constFolding() Returns the const folding mode.
CompilerSettings.CPUAccountingMode	cpuAccountingMode() Returns the CPU accounting mode.
static CompilerSettings	defaultNoAccountingSettings() Returns the default compiler settings without CPU accounting.
static CompilerSettings	defaultSettings() Returns the default compiler settings.
boolean	equals(Object o)
int	hashCode()
int	nodeSizeLimit() Returns the node size limit.
static CompilerSettings	of(CompilerSettings.CPUAccountingMode cpuAccountingMode, boolean constFolding, boolean constCaching, boolean byteStrings, int nodeSizeLimit) Returns the compiler settings with the given parameters.
CompilerSettings	withByteStrings(boolean mode) Returns compiler settings derived from this compiler settings by updating the byte string mode to mode.
CompilerSettings	withConstCaching(boolean mode) Returns compiler settings derived from this compiler settings by updating the const caching mode to mode.
CompilerSettings	withConstFolding(boolean mode) Returns compiler settings derived from this compiler settings by updating the const folding mode to mode.
CompilerSettings	withCPUAccountingMode(CompilerSettings.CPUAccountingMode mode) Returns compiler settings derived from this compiler settings by updating the CPU accounting mode to mode.
CompilerSettings	withNodeSizeLimit(int limit) Returns compiler settings derived from this compiler settings by updating the node size limit to limit.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_CPU_ACCOUNTING_MODE

public static final CompilerSettings.CPUAccountingMode DEFAULT_CPU_ACCOUNTING_MODE

The default CPU accounting mode.

DEFAULT_CONST_FOLDING_MODE

public static final boolean DEFAULT_CONST_FOLDING_MODE

The default const folding mode.

See Also:

Constant Field Values

DEFAULT_CONST_CACHING_MODE

public static final boolean DEFAULT_CONST_CACHING_MODE

The default const caching mode.

See Also:

Constant Field Values

DEFAULT_BYTE_STRING_MODE

public static final boolean DEFAULT_BYTE_STRING_MODE

The default byte string mode.

See Also:

Constant Field Values

DEFAULT_NODE_SIZE_LIMIT

public static final int DEFAULT_NODE_SIZE_LIMIT

The default method size limit.

See Also:

Constant Field Values

Method Detail

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

of

public static CompilerSettings of(CompilerSettings.CPUAccountingMode cpuAccountingMode,
                                  boolean constFolding,
                                  boolean constCaching,
                                  boolean byteStrings,
                                  int nodeSizeLimit)

Returns the compiler settings with the given parameters.

When nodeSizeLimit is non-positive, no chunking of the body method will be performed.

Parameters:

cpuAccountingMode - CPU accounting mode, must not be null

constFolding - const folding mode

constCaching - const caching mode

byteStrings - byte string mode

nodeSizeLimit - node size limit

Returns:

the corresponding compiler settings

Throws:

NullPointerException - if cpuAccountingMode is null

defaultSettings

public static CompilerSettings defaultSettings()

Returns the default compiler settings.

Returns:

the default compiler settings

defaultNoAccountingSettings

public static CompilerSettings defaultNoAccountingSettings()

Returns the default compiler settings without CPU accounting.

Returns:

the default compiler settings without CPU accounting

cpuAccountingMode

public CompilerSettings.CPUAccountingMode cpuAccountingMode()

Returns the CPU accounting mode.

Returns:

the CPU accounting mode

constFolding

public boolean constFolding()

Returns the const folding mode.

Returns:

the const folding mode

constCaching

public boolean constCaching()

Returns the const caching mode.

Returns:

the const caching mode

byteStrings

public boolean byteStrings()

nodeSizeLimit

public int nodeSizeLimit()

Returns the node size limit.

Returns:

the node size limit

withCPUAccountingMode

public CompilerSettings withCPUAccountingMode(CompilerSettings.CPUAccountingMode mode)

Returns compiler settings derived from this compiler settings by updating the CPU accounting mode to mode.

Parameters:

mode - new CPU accounting mode, must not be null

Returns:

settings derived from this by updating the CPU accounting mode to mode

Throws:

NullPointerException - if mode is null

withConstFolding

public CompilerSettings withConstFolding(boolean mode)

Returns compiler settings derived from this compiler settings by updating the const folding mode to mode.

Parameters:

mode - new const folding mode

Returns:

settings derived from this by updating the const folding mode to mode

withConstCaching

public CompilerSettings withConstCaching(boolean mode)

Returns compiler settings derived from this compiler settings by updating the const caching mode to mode.

Parameters:

mode - new const caching mode

Returns:

settings derived from this by updating the const caching mode to mode

withByteStrings

public CompilerSettings withByteStrings(boolean mode)

Returns compiler settings derived from this compiler settings by updating the byte string mode to mode.

Parameters:

mode - new byte string mode

Returns:

settings derived from this by updating the byte string mode to mode

withNodeSizeLimit

public CompilerSettings withNodeSizeLimit(int limit)

Returns compiler settings derived from this compiler settings by updating the node size limit to limit.

Parameters:

limit - new node size limit

Returns:

settings derived from this by updating the node size limit to limit