net.termer.rtflc.runtime

Class Scope

java.lang.Object

net.termer.rtflc.runtime.Scope

public class Scope
extends java.lang.Object

Class to store information about the current scope of executing instructions

Since:

1.0

Constructor Summary

Constructors

Constructor and Description
Scope(RtflRuntime runtime, java.util.HashMap<java.lang.String,java.lang.Integer> localAliases, java.util.ArrayList<java.lang.String> restrictedFunctions, RtflInstruction causeInstruction, Scope parentScope) Instantiates a new Scope object
Scope(RtflRuntime runtime, java.util.HashMap<java.lang.String,java.lang.Integer> localAliases, RtflInstruction causeInstruction) Instantiates a new Scope object
Scope(RtflRuntime runtime, java.util.HashMap<java.lang.String,java.lang.Integer> localAliases, RtflInstruction causeInstruction, Scope parentScope) Instantiates a new Scope object

Method Summary

Modifier and Type	Method and Description
boolean	assignVar(java.lang.String varName, RtflType value) Assigns the provided value to a variable with the specified name.
RtflInstruction	cause() Returns the instruction that caused the creation of this scope
int	createLocalVar(java.lang.String varName, RtflType value) Creates a new local variable with the specified name and value.
Scope	descend(RtflInstruction causeInstruction) Descends a level and provides a new (non-reference) Scope for that level
RtflFunction	function(java.lang.String funcName) Returns the function with the specified name.
Scope	parent() Returns the parent of this Scope, null if it has none
void	restrictFunc(java.lang.String funcName) Restricts a function from being executed in this Scope
RtflRuntime	runtime() Returns this scope's Runtime
Scope[]	scopeStack() Returns the full scope stack, starting from the top level scope down to the current scope
void	undefineFunc(java.lang.String funcName) Undefines the specified function
int	undefineVar(java.lang.String varName) Undefines the variable with the specified name.
java.util.HashMap<java.lang.String,java.lang.Integer>	variableAliases() Returns a map of local variable name aliases to their internal IDs
RtflType	varValue(java.lang.String varName) Returns the value of the provided variable name.

Methods inherited from class java.lang.Object

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

Constructor Detail

Scope

public Scope(RtflRuntime runtime,
             java.util.HashMap<java.lang.String,java.lang.Integer> localAliases,
             RtflInstruction causeInstruction)

Instantiates a new Scope object

Parameters:

runtime - the Runtime associated with this scope

localAliases - all aliases to local variables visible to this scope

causeInstruction - the instruction that caused this new scope

Since:

1.0

Scope

public Scope(RtflRuntime runtime,
             java.util.HashMap<java.lang.String,java.lang.Integer> localAliases,
             RtflInstruction causeInstruction,
             Scope parentScope)

Instantiates a new Scope object

Parameters:

runtime - the Runtime associated with this scope

localAliases - all aliases to local variables visible to this scope

causeInstruction - the instruction that caused this new scope

parentScope - the scope above this scope

Since:

1.0

Scope

public Scope(RtflRuntime runtime,
             java.util.HashMap<java.lang.String,java.lang.Integer> localAliases,
             java.util.ArrayList<java.lang.String> restrictedFunctions,
             RtflInstruction causeInstruction,
             Scope parentScope)

Instantiates a new Scope object

Parameters:

runtime - the Runtime associated with this scope

localAliases - all aliases to local variables visible to this scope

restrictedFunctions - a list of functions that cannot be called in this scope or any of its children

causeInstruction - the instruction that caused this new scope

parentScope - the scope above this scope

Since:

1.0

Method Detail

parent

public Scope parent()

Returns the parent of this Scope, null if it has none

Returns:

The parent of this scope if any

Since:

1.0

runtime

public RtflRuntime runtime()

Returns this scope's Runtime

Returns:

this scope's Runtime

Since:

1.0

cause

public RtflInstruction cause()

Returns the instruction that caused the creation of this scope

Returns:

the instruction that caused this scope

Since:

1.0

variableAliases

public java.util.HashMap<java.lang.String,java.lang.Integer> variableAliases()

Returns a map of local variable name aliases to their internal IDs

Returns:

a map of local variable aliases

Since:

1.0

assignVar

public boolean assignVar(java.lang.String varName,
                         RtflType value)
                  throws RuntimeException

Assigns the provided value to a variable with the specified name. If no local variable with the specified name is found, then globals will be checked. If no variable with the give name exists, then a RuntimeException will be thrown.

Parameters:

varName - the name of the variable

value - the value to assign

Returns:

Whether this variable assignment was to a local variable

Throws:

RuntimeException - if the specified variable does not exist

Since:

1.0

createLocalVar

public int createLocalVar(java.lang.String varName,
                          RtflType value)

Creates a new local variable with the specified name and value. Assigns the provided value to an existing local variable with the same name if it exists.

Parameters:

varName - the variable name

value - the value to assign

Returns:

The ID of the newly created local variable

Since:

1.0

undefineVar

public int undefineVar(java.lang.String varName)
                throws RuntimeException

Undefines the variable with the specified name. Local variables have priority; global variables are only undefined if no local variable with the provided name exists. Throws a RuntimeException if no variable with the specified name exists

Parameters:

varName - the name of the variable to undefine

Returns:

The ID of the local variable that was undefined. -1 if it was global.

Throws:

RuntimeException - if no variable with the specified name exists

Since:

1.0

undefineFunc

public void undefineFunc(java.lang.String funcName)

Undefines the specified function

Parameters:

funcName - The Name of the function to undefine

Since:

1.0

restrictFunc

public void restrictFunc(java.lang.String funcName)

Restricts a function from being executed in this Scope

Parameters:

funcName - The name of the function to restrict

Since:

1.0

varValue

public RtflType varValue(java.lang.String varName)
                  throws RuntimeException

Returns the value of the provided variable name. Local variables have priority; global variables are only accessed if no local variable with the provided name exists. Throws a RuntimeException if no variable with the specified name exists.

Parameters:

varName - the variable name

Returns:

the variable's value

Throws:

RuntimeException - if no variable with the specified name exists

Since:

1.0

function

public RtflFunction function(java.lang.String funcName)
                      throws RuntimeException

Returns the function with the specified name.

Parameters:

funcName - the function name

Returns:

the function corresponding to the provided name

Throws:

RuntimeException - if the function does not exist or is restricted

Since:

1.0

scopeStack

public Scope[] scopeStack()

Returns the full scope stack, starting from the top level scope down to the current scope

Returns:

the full scope stack

Since:

1.0

descend

public Scope descend(RtflInstruction causeInstruction)

Descends a level and provides a new (non-reference) Scope for that level

Parameters:

causeInstruction - the instruction that caused this new scope

Returns:

the new Scope for a lower level

Since:

1.0