net.termer.rtflc.runtime

Class RtflRuntime

java.lang.Object

net.termer.rtflc.runtime.RtflRuntime

public class RtflRuntime
extends java.lang.Object

Main Rtfl runtime class. Contains all components necessary to execute files, source code, and raw instructions.

Since:

1.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	RtflRuntime.GarbageCollector Garbage collector daemon for local values no longer in use
static class	RtflRuntime.LocalVar
static class	RtflRuntime.RtflMetadata Utility class to store Rtfl compiled file metadata

Constructor Summary

Constructors

Constructor and Description
RtflRuntime() Instantiates a new Rtfl runtime

Method Summary

Modifier and Type	Method and Description
RtflRuntime	closeTerminal() Closes terminal input
RtflType	execute(RtflInstruction[] instructions) Executes Rtfl instructions at the top scope
RtflType	execute(RtflInstruction[] instructions, Scope scope) Executes Rtfl instructions
RtflType	execute(RtflInstruction[] instructions, Scope scope, boolean disownAll) Executes Rtfl instructions
RtflType	execute(java.lang.String code) Executes a String of Rtfl code
RtflType	execute(java.lang.String code, Scope scope) Executes a String of Rtfl code
RtflRuntime	executeAsync(RtflInstruction[] instructions, Scope scope) Executes Rtfl instructions asynchronously
RtflType	executeFile(java.io.File file) Executes an Rtfl file (script or bytecode) at top level
RtflType	executeFile(java.io.File file, Scope scope) Executes an Rtfl file (script or bytecode)
RtflRuntime	exposeMethod(java.lang.Object object, java.lang.String name, java.lang.Class<?>[] parameters) Exposes a Java method to this runtime as an Rtfl function
RtflRuntime	exposeMethodAs(java.lang.Object object, java.lang.String name, java.lang.Class<?>[] parameters, java.lang.String importName) Exposes a Java method to this runtime as an Rtfl function
RtflRuntime	exposeStaticMethod(java.lang.Class<?> clazz, java.lang.String name, java.lang.Class<?>[] parameters) Exposes a static Java method to this runtime as an Rtfl function
RtflRuntime	exposeStaticMethodAs(java.lang.Class<?> clazz, java.lang.String name, java.lang.Class<?>[] parameters, java.lang.String importName) Exposes a static Java method to this runtime as an Rtfl function
java.util.concurrent.ConcurrentHashMap<java.lang.String,RtflFunction>	functions() Returns all currently loaded functions
RtflRuntime.GarbageCollector	garbageCollector() Returns this runtime's garbage collector daemon
java.util.concurrent.ConcurrentHashMap<java.lang.String,RtflType>	globalVarables() Returns all global variables
RtflRuntime	importJavaInterop() Imports all Java interop functions into this Runtime
RtflRuntime	importStandard() Imports all Rtfl standard functions into this Runtime
static boolean	isCompiledScript(java.io.InputStream in) Returns whether the stream provided contains the four byte signature for compiled Rtfl files.
java.util.concurrent.ConcurrentHashMap<java.lang.Integer,RtflRuntime.LocalVar>	localVariables() Returns all local variables.
int	newId() Generates a new unique integer ID
RtflRuntime	openTerminal() Opens terminal input
static RtflRuntime.RtflMetadata	readCompiledMetadata(java.io.InputStream in) Returns the metadata of a compiled Rtfl file.
java.lang.String	readTerminal() Reads a line from the terminal if terminal input is open
boolean	terminalOpen() Returns if terminal input is open

Methods inherited from class java.lang.Object

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

Constructor Detail

RtflRuntime

public RtflRuntime()

Instantiates a new Rtfl runtime

Since:

1.0

Method Detail

isCompiledScript

public static boolean isCompiledScript(java.io.InputStream in)
                                throws java.io.IOException

Returns whether the stream provided contains the four byte signature for compiled Rtfl files. WARNING: Reads four bytes from the provided stream.

Parameters:

in - The InputStream to read

Returns:

Whether the stream contains a compiled Rtfl file's signature

Throws:

java.io.IOException - If reading from the stream fails

Since:

1.0

readCompiledMetadata

public static RtflRuntime.RtflMetadata readCompiledMetadata(java.io.InputStream in)
                                                     throws java.io.IOException

Returns the metadata of a compiled Rtfl file. Requires isCompiledScript() to be run on the same InputStream that is provided, or have four bytes read.

Parameters:

in - The InputStream from which to read metadata

Returns:

The metadata of the compiled Rtfl file

Throws:

java.io.IOException - If reading from the stream fails

Since:

1.0

openTerminal

public RtflRuntime openTerminal()

Opens terminal input

Returns:

this, to be used fluently

Since:

1.0

closeTerminal

public RtflRuntime closeTerminal()
                          throws RuntimeException

Closes terminal input

Returns:

this, to be used fluently

Throws:

RuntimeException - If closing terminal input fails

Since:

1.0

terminalOpen

public boolean terminalOpen()

Returns if terminal input is open

Returns:

Whether terminal input is open

Since:

1.0

readTerminal

public java.lang.String readTerminal()
                              throws RuntimeException

Reads a line from the terminal if terminal input is open

Returns:

The line read from the terminal

Throws:

RuntimeException - If reading the input fails

Since:

1.0

execute

public RtflType execute(RtflInstruction[] instructions)
                 throws RuntimeException

Executes Rtfl instructions at the top scope

Parameters:

instructions - The instructions to execute

Returns:

The value returned by the executed instructions, a NullType if nothing is returned

Throws:

RuntimeException - If there is an error while executing instructions

Since:

1.0

execute

public RtflType execute(RtflInstruction[] instructions,
                        Scope scope)
                 throws RuntimeException

Executes Rtfl instructions

Parameters:

instructions - The instructions to execute

scope - The scope in which to run the instructions

Returns:

The value returned by the executed instructions, a NullType if nothing is returned

Throws:

RuntimeException - If there is an error while executing instructions

Since:

1.0

execute

public RtflType execute(java.lang.String code)
                 throws RuntimeException,
                        java.io.IOException,
                        ProducerException

Executes a String of Rtfl code

Parameters:

code - The Rtfl code to execute

Returns:

The value returned by the executed instructions, a NullType if nothing is returned

Throws:

RuntimeException - If there is an error while executing instructions

java.io.IOException - If reading the code String fails

ProducerException - If parsing/reading the instructions fails

Since:

1.0

execute

public RtflType execute(java.lang.String code,
                        Scope scope)
                 throws RuntimeException,
                        java.io.IOException,
                        ProducerException

Executes a String of Rtfl code

Parameters:

code - The Rtfl code to execute

scope - The scope in which to run the code

Returns:

The value returned by the executed instructions, a NullType if nothing is returned

Throws:

RuntimeException - If there is an error while executing instructions

java.io.IOException - If reading the code String fails

ProducerException - If parsing/reading the instructions fails

Since:

1.0

executeAsync

public RtflRuntime executeAsync(RtflInstruction[] instructions,
                                Scope scope)

Executes Rtfl instructions asynchronously

Parameters:

instructions - The instructions to execute

scope - The scope in which to run the instructions

Returns:

this, to be used fluently

Since:

1.0

executeFile

public RtflType executeFile(java.io.File file)
                     throws java.io.IOException,
                            RuntimeException,
                            ProducerException

Executes an Rtfl file (script or bytecode) at top level

Parameters:

file - The file to execute

Returns:

The RtflType value returned by the file, a NullType if nothing

Throws:

java.io.IOException - If reading the file fails

RuntimeException - If executing the file fails

ProducerException - If parsing/reading the file fails

Since:

1.0

executeFile

public RtflType executeFile(java.io.File file,
                            Scope scope)
                     throws java.io.IOException,
                            RuntimeException,
                            ProducerException

Executes an Rtfl file (script or bytecode)

Parameters:

file - The file to execute

scope - The scope in which to execute te file

Returns:

The RtflType value returned by the file, a NullType if nothing

Throws:

java.io.IOException - If reading the file fails

RuntimeException - If executing the file fails

ProducerException - If parsing/reading the file fails

Since:

1.0

execute

public RtflType execute(RtflInstruction[] instructions,
                        Scope scope,
                        boolean disownAll)
                 throws RuntimeException

Executes Rtfl instructions

Parameters:

instructions - The instructions to execute

scope - The scope in which to run the instructions

disownAll - Whether to delete all local variables after execution (should only be used on top-level execution)

Returns:

The value returned by the executed instructions, a NullType if nothing is returned

Throws:

RuntimeException - If there is an error while executing instructions

Since:

1.0

functions

public java.util.concurrent.ConcurrentHashMap<java.lang.String,RtflFunction> functions()

Returns all currently loaded functions

Returns:

All functions

Since:

1.0

globalVarables

public java.util.concurrent.ConcurrentHashMap<java.lang.String,RtflType> globalVarables()

Returns all global variables

Returns:

All global variables

Since:

1.0

localVariables

public java.util.concurrent.ConcurrentHashMap<java.lang.Integer,RtflRuntime.LocalVar> localVariables()

Returns all local variables. The map contains the values of the locals along with their IDs as keys.

Returns:

All local variables

Since:

1.0

garbageCollector

public RtflRuntime.GarbageCollector garbageCollector()

Returns this runtime's garbage collector daemon

Returns:

The garbage collector daemon

Since:

1.0

importStandard

public RtflRuntime importStandard()

Imports all Rtfl standard functions into this Runtime

Returns:

this, to be used fluently

Since:

1.0

importJavaInterop

public RtflRuntime importJavaInterop()

Imports all Java interop functions into this Runtime

Returns:

this, to be used fluently

Since:

1.0

exposeMethodAs

public RtflRuntime exposeMethodAs(java.lang.Object object,
                                  java.lang.String name,
                                  java.lang.Class<?>[] parameters,
                                  java.lang.String importName)
                           throws java.lang.NoSuchMethodException,
                                  java.lang.SecurityException

Exposes a Java method to this runtime as an Rtfl function

Parameters:

object - The object containing the method

name - The name of the method

parameters - The method's parameter types

importName - What the new function should be named

Returns:

This, to the used fluently

Throws:

java.lang.NoSuchMethodException - If the specified method (and its specified parameters) does not exist

java.lang.SecurityException - If the method cannot be accessed

Since:

1.0

exposeMethod

public RtflRuntime exposeMethod(java.lang.Object object,
                                java.lang.String name,
                                java.lang.Class<?>[] parameters)
                         throws java.lang.NoSuchMethodException,
                                java.lang.SecurityException

Exposes a Java method to this runtime as an Rtfl function

Parameters:

object - The object containing the method

name - The name of the method

parameters - The method's parameter types

Returns:

This, to the used fluently

Throws:

java.lang.NoSuchMethodException - If the specified method (and its specified parameters) does not exist

java.lang.SecurityException - If the method cannot be accessed

Since:

1.0

exposeStaticMethodAs

public RtflRuntime exposeStaticMethodAs(java.lang.Class<?> clazz,
                                        java.lang.String name,
                                        java.lang.Class<?>[] parameters,
                                        java.lang.String importName)
                                 throws java.lang.NoSuchMethodException,
                                        java.lang.SecurityException

Exposes a static Java method to this runtime as an Rtfl function

Parameters:

clazz - The class containing the static method

name - The name of the method

parameters - The method's parameter types

importName - What the new function should be named

Returns:

This, to the used fluently

Throws:

java.lang.NoSuchMethodException - If the specified method (and its specified parameters) does not exist

java.lang.SecurityException - If the method cannot be accessed

Since:

1.0

exposeStaticMethod

public RtflRuntime exposeStaticMethod(java.lang.Class<?> clazz,
                                      java.lang.String name,
                                      java.lang.Class<?>[] parameters)
                               throws java.lang.NoSuchMethodException,
                                      java.lang.SecurityException

Exposes a static Java method to this runtime as an Rtfl function

Parameters:

clazz - The class containing the static method

name - The name of the method

parameters - The method's parameter types

Returns:

This, to the used fluently

Throws:

java.lang.NoSuchMethodException - If the specified method (and its specified parameters) does not exist

java.lang.SecurityException - If the method cannot be accessed

Since:

1.0

newId

public int newId()

Generates a new unique integer ID

Returns:

the new ID

Since:

1.0