com.scriptbasic.interfaces

Interface Interpreter

All Superinterfaces:

FactoryManaged

All Known Subinterfaces:

ExtendedInterpreter

All Known Implementing Classes:

BasicExtendedInterpreter

public interface Interpreter
extends FactoryManaged

An interpreter instance executes a program.

Author:

Peter Verhas

Method Summary

Methods

Modifier and Type	Method and Description
Object	call(String functionName, Object[] arguments) Call a function defined by the program passing the objects as arguments.
void	execute() Execute the program.
Object	getVariable(String name) Get the value of a global variable.
void	registerFunctions(Class<?> klass) Register the functions defined in the class.
void	registerHook(InterpreterHook hook)
void	setErrorWriter(Writer writer)
void	setProgram(BuildableProgram buildableProgram) Set the program to execute.
void	setReader(Reader reader)
void	setVariable(String name, Object value) Set the value of the global variable.
void	setWriter(Writer writer)

Methods inherited from interface com.scriptbasic.interfaces.FactoryManaged

setFactory

Method Detail

registerHook

void registerHook(InterpreterHook hook)

setProgram

void setProgram(BuildableProgram buildableProgram)

Set the program to execute.

Parameters:

buildableProgram -

execute

void execute()
             throws ExecutionException

Execute the program.

Throws:

ExecutionException

setVariable

void setVariable(String name,
               Object value)
                 throws ExecutionException

Set the value of the global variable.

Parameters:

name - the name of the global variable

value - the value to be set

Throws:

ExecutionException

getVariable

Object getVariable(String name)
                   throws ExecutionException

Get the value of a global variable. Since this is not a BASIC interpreter method, but rather a method that helps the embedding of the interpreter the returned value is a raw Java object and not a RightValue. Thus if the variable value is for example a BasicDoubleValue then the implementation should return a Double.

Parameters:

name - the name of the variable

Returns:

the value of the variable

Throws:

ExecutionException

call

Object call(String functionName,
          Object[] arguments)
            throws ExecutionException

Call a function defined by the program passing the objects as arguments.

Parameters:

functionName - the name of the function in the program code

arguments - the arguments to the function

Returns:

the returned object, or null if the function does not return value

Throws:

ExecutionException

setReader

void setReader(Reader reader)

Parameters:

reader -

See Also:

ScriptContext.setReader(java.io.Reader)

setWriter

void setWriter(Writer writer)

Parameters:

writer -

See Also:

ScriptContext.setWriter(Writer)

setErrorWriter

void setErrorWriter(Writer writer)

Parameters:

writer -

See Also:

ScriptContext.setErrorWriter(Writer)

registerFunctions

void registerFunctions(Class<?> klass)

Register the functions defined in the class. Functions that can be called from a BASIC program but implemented in Java are static methods that are registered for the interpreter. The easiest way to define these methods are to create a class and annotate the methods that serve as BASIC functions with the annotation @Function

Parameters:

klass - the class the defines the functions.