net.termer.rtflc.compiler

Class RtflCompiler

java.lang.Object

net.termer.rtflc.compiler.RtflCompiler

public class RtflCompiler
extends java.lang.Object

Main Rtfl compiler class. Can compile Rtfl files using options provided.

Since:

1.0

Field Summary

Fields

Modifier and Type	Field and Description
static int	COMPILER_VERSION
static int	RTFL_VERSION

Constructor Summary

Constructors

Constructor and Description
RtflCompiler(CompilerOptions options) Instantiates a new Rtfl compiler with the provided settings

Method Summary

Modifier and Type	Method and Description
void	compile(java.io.File file, java.io.OutputStream out) Compiles the provided Rtfl file, applying all compiler options
void	compile(java.io.File file, java.io.OutputStream out, boolean writeMetadata) Compiles the provided Rtfl file, applying all compiler options
java.util.ArrayList<java.lang.String>	loadsCompiled() Returns a list of load() functions that have already been compiled
CompilerOptions	options() Returns this compiler's options.
java.util.ArrayList<java.lang.String>	requiresLoaded() Returns a list of require() functions that have already been compiled or packaged

Methods inherited from class java.lang.Object

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

Field Detail

COMPILER_VERSION

public static final int COMPILER_VERSION

See Also:

Constant Field Values

RTFL_VERSION

public static final int RTFL_VERSION

See Also:

Constant Field Values

Constructor Detail

RtflCompiler

public RtflCompiler(CompilerOptions options)

Instantiates a new Rtfl compiler with the provided settings

Parameters:

options - Compiler options

Method Detail

options

public CompilerOptions options()

Returns this compiler's options.

Returns:

This compiler's options

Since:

1.0

requiresLoaded

public java.util.ArrayList<java.lang.String> requiresLoaded()

Returns a list of require() functions that have already been compiled or packaged

Returns:

A list of compiled or packaged require()s

Since:

1.0

loadsCompiled

public java.util.ArrayList<java.lang.String> loadsCompiled()

Returns a list of load() functions that have already been compiled

Returns:

A list of compiled load()s

Since:

1.0

compile

public void compile(java.io.File file,
                    java.io.OutputStream out)
             throws java.io.IOException,
                    ProducerException,
                    RuntimeException

Compiles the provided Rtfl file, applying all compiler options

Parameters:

file - The file to read

out - The output to write

Throws:

RuntimeException - If compiling fails

ProducerException - If parsing fails

java.io.IOException - If reading the input fails

Since:

1.0

compile

public void compile(java.io.File file,
                    java.io.OutputStream out,
                    boolean writeMetadata)
             throws java.io.IOException,
                    ProducerException,
                    RuntimeException

Compiles the provided Rtfl file, applying all compiler options

Parameters:

file - The file to read

out - The output to write

writeMetadata - Whether to write metadata headers (for when compiling a new binary)

Throws:

RuntimeException - If compiling fails

ProducerException - If parsing fails

java.io.IOException - If reading the input fails

Since:

1.0