com.scriptbasic

Class Engine

java.lang.Object

com.scriptbasic.Engine

All Implemented Interfaces:

EngineApi

public class Engine
extends Object
implements EngineApi

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Engine.Sub

Constructor Summary

Constructors

Constructor and Description
Engine()

Method Summary

Methods

Modifier and Type	Method and Description
Object	call(String subroutineName, Object... args)
void	eval(File sourceFile) Evaluate the content of a file.
void	eval(Reader reader) Read the content of a stream provided by the reader and interpret this as a BASIC program.
void	eval(String sourceCode) Evaluate a string as a BASIC program.
void	eval(String sourceFileName, SourcePath path) Read the content of the file and execute it.
void	eval(String sourceName, SourceProvider provider) Read the content of the source from the file, db...
void	eval(String sourceFileName, String... path) Read the content of the file and execute it.
void	execute() Execute a previously loaded code.
Factory	getBasicFactory() Get the factory used to create the different parts of the execution environment for this engine.
Writer	getError() Get the output writer used to write the error output of the BASIC program.
Reader	getInput() Get the reader from where the BASIC program reads the standard input characters.
int	getNumberOfArguments(String subroutineName)
Writer	getOutput() Get the output writer used to write the standard output of the BASIC program.
Subroutine	getSubroutine(String subroutineName)
Iterable<String>	getSubroutineNames()
Iterable<Subroutine>	getSubroutines()
Object	getVariable(String name)
Iterable<String>	getVariablesIterator()
void	load(File sourceFile) Evaluate the content of a file.
void	load(Reader reader) Read the content of a stream provided by the reader and interpret this as a BASIC program.
void	load(String sourceCode) Load a string as a BASIC program.
void	load(String sourceFileName, SourcePath path) Read the content of the file and execute it.
void	load(String sourceName, SourceProvider provider) Read the content of the source from the file, db...
void	load(String sourceFileName, String... path) Read the content of the file and execute it.
void	setError(Writer error) Set the output writer used to write the error output of the BASIC program.
void	setInput(Reader input) Set the reader from where the BASIC program reads the standard input characters.
void	setOutput(Writer output) Set the output writer used to write the standard output of the BASIC program.
void	setVariable(String name, Object value)

Methods inherited from class java.lang.Object

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

Constructor Detail

Engine

public Engine()

Method Detail

getBasicFactory

public Factory getBasicFactory()

Description copied from interface: EngineApi

Get the factory used to create the different parts of the execution environment for this engine. The factory can be requested to return the reader, lexical analyzer and other objects that are used internally to manage the execution of the program. To use the ScriptBasic Engine there is no need for this method This method provides a way to access the objects that are below this facade and is available for advanced programmers who are not satisfied with the features provided with this facade.

If ever you need to use this method, do use it at your own risk, and inform the developers of your need so that they may consider extending this facade to accommodate your needs.

Specified by:

getBasicFactory in interface EngineApi

Returns:

the factory instance

getInput

public Reader getInput()

Description copied from interface: EngineApi

Get the reader from where the BASIC program reads the standard input characters.

Specified by:

getInput in interface EngineApi

Returns:

setInput

public void setInput(Reader input)

Description copied from interface: EngineApi

Set the reader from where the BASIC program reads the standard input characters.

Specified by:

setInput in interface EngineApi

getOutput

public Writer getOutput()

Description copied from interface: EngineApi

Get the output writer used to write the standard output of the BASIC program.

Specified by:

getOutput in interface EngineApi

Returns:

setOutput

public void setOutput(Writer output)

Description copied from interface: EngineApi

Set the output writer used to write the standard output of the BASIC program.

Specified by:

setOutput in interface EngineApi

getError

public Writer getError()

Description copied from interface: EngineApi

Get the output writer used to write the error output of the BASIC program.

Specified by:

getError in interface EngineApi

Returns:

setError

public void setError(Writer error)

Description copied from interface: EngineApi

Set the output writer used to write the error output of the BASIC program.

Specified by:

setError in interface EngineApi

execute

public void execute()
             throws ScriptBasicException

Description copied from interface: EngineApi

Execute a previously loaded code.

Specified by:

execute in interface EngineApi

Throws:

ScriptBasicException

load

public void load(String sourceCode)
          throws ScriptBasicException

Description copied from interface: EngineApi

Load a string as a BASIC program.

Specified by:

load in interface EngineApi

Parameters:

sourceCode - contains the source code as string

Throws:

ScriptBasicException

eval

public void eval(String sourceCode)
          throws ScriptBasicException

Description copied from interface: EngineApi

Evaluate a string as a BASIC program.

Specified by:

eval in interface EngineApi

Parameters:

sourceCode - contains the source code as string

Throws:

ScriptBasicException

load

public void load(Reader reader)
          throws ScriptBasicException

Description copied from interface: EngineApi

Read the content of a stream provided by the reader and interpret this as a BASIC program. This method does not execute the code.

Specified by:

load in interface EngineApi

Parameters:

reader - the reader to supply the BASIC program characters.

Throws:

ScriptBasicException

eval

public void eval(Reader reader)
          throws ScriptBasicException

Description copied from interface: EngineApi

Read the content of a stream provided by the reader and interpret this as a BASIC program.

Specified by:

eval in interface EngineApi

Parameters:

reader - the reader to supply the BASIC program characters.

Throws:

ScriptBasicException

load

public void load(File sourceFile)
          throws ScriptBasicException

Description copied from interface: EngineApi

Evaluate the content of a file. The file has to contain the BASIC program. This method does not execute the code.

Specified by:

load in interface EngineApi

Parameters:

sourceFile - the file handler pointing to the file that the interpreter will read to get the source code.

Throws:

ScriptBasicException

eval

public void eval(File sourceFile)
          throws ScriptBasicException

Description copied from interface: EngineApi

Evaluate the content of a file. The file has to contain the BASIC program.

Specified by:

eval in interface EngineApi

Parameters:

sourceFile - the file handler pointing to the file that the interpreter will read to get the source code.

Throws:

ScriptBasicException

load

public void load(String sourceFileName,
        String... path)
          throws ScriptBasicException

Description copied from interface: EngineApi

Read the content of the file and execute it. If there is any other script included then use the path to search for the file. This method does not execute the code.

Specified by:

load in interface EngineApi

Parameters:

sourceFileName - the file that contains the script

path - the array of path elements that are searched for included files

Throws:

ScriptBasicException

eval

public void eval(String sourceFileName,
        String... path)
          throws ScriptBasicException

Description copied from interface: EngineApi

Read the content of the file and execute it. If there is any other script included then use the path to search for the file.

Specified by:

eval in interface EngineApi

Parameters:

sourceFileName - the file that contains the script

path - the array of path elements that are searched for included files

Throws:

ScriptBasicException

load

public void load(String sourceFileName,
        SourcePath path)
          throws ScriptBasicException

Description copied from interface: EngineApi

Read the content of the file and execute it. If there is any other script included then use the path to search for the file. This method does not execute the code.

Specified by:

load in interface EngineApi

Parameters:

sourceFileName - the file that contains the script

path - the path where included files are located

Throws:

ScriptBasicException

eval

public void eval(String sourceFileName,
        SourcePath path)
          throws ScriptBasicException

Description copied from interface: EngineApi

Read the content of the file and execute it. If there is any other script included then use the path to search for the file.

Specified by:

eval in interface EngineApi

Parameters:

sourceFileName - the file that contains the script

path - the path where included files are located

Throws:

ScriptBasicException

load

public void load(String sourceName,
        SourceProvider provider)
          throws ScriptBasicException

Description copied from interface: EngineApi

Read the content of the source from the file, db... whatever named by the argument sourceName using the provider. This method does not execute the code.

Specified by:

load in interface EngineApi

Parameters:

sourceName - the name of the source file where the source is. The syntax of the name depends on the provider.

provider - the source provider that helps the reader to read the content

Throws:

ScriptBasicException

eval

public void eval(String sourceName,
        SourceProvider provider)
          throws ScriptBasicException

Description copied from interface: EngineApi

Read the content of the source from the file, db... whatever named by the argument sourceName using the provider.

Specified by:

eval in interface EngineApi

Parameters:

sourceName - the name of the source file where the source is. The syntax of the name depends on the provider.

provider - the source provider that helps the reader to read the content

Throws:

ScriptBasicException

setVariable

public void setVariable(String name,
               Object value)
                 throws ScriptBasicException

Specified by:

setVariable in interface EngineApi

Throws:

ScriptBasicException

getVariable

public Object getVariable(String name)
                   throws ScriptBasicException

Specified by:

getVariable in interface EngineApi

Throws:

ScriptBasicException

getVariablesIterator

public Iterable<String> getVariablesIterator()

Specified by:

getVariablesIterator in interface EngineApi

call

public Object call(String subroutineName,
          Object... args)
            throws ScriptBasicException

Specified by:

call in interface EngineApi

Throws:

ScriptBasicException

getSubroutineNames

public Iterable<String> getSubroutineNames()

Specified by:

getSubroutineNames in interface EngineApi

getSubroutines

public Iterable<Subroutine> getSubroutines()

Specified by:

getSubroutines in interface EngineApi

getNumberOfArguments

public int getNumberOfArguments(String subroutineName)
                         throws ScriptBasicException

Specified by:

getNumberOfArguments in interface EngineApi

Throws:

ScriptBasicException

getSubroutine

public Subroutine getSubroutine(String subroutineName)
                         throws ScriptBasicException

Specified by:

getSubroutine in interface EngineApi

Throws:

ScriptBasicException