com.scriptbasic.interfaces

Interface EngineApi

All Known Implementing Classes:

Engine

public interface EngineApi

ScriptBasic for Java embedding interface.

This interface defines the native methods that can be used to embed ScriptBasic into applications. Using the methods of this API you can load, execute BASIC programs, define how the interpreter can get access to other sources that are included by the script, set and get global variables and call subroutines.

Author:

Peter Verhas

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)

Method Detail

getBasicFactory

Factory getBasicFactory()

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.

Returns:

the factory instance

getInput

Reader getInput()

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

Returns:

setInput

void setInput(Reader input)

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

Parameters:

input -

getOutput

Writer getOutput()

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

Returns:

setOutput

void setOutput(Writer output)

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

Parameters:

output -

getError

Writer getError()

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

Returns:

setError

void setError(Writer error)

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

Parameters:

output -

load

void load(String sourceCode)
          throws ScriptBasicException

Load a string as a BASIC program.

Parameters:

sourceCode - contains the source code as string

Throws:

ScriptBasicException

load

void load(Reader reader)
          throws ScriptBasicException

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

Parameters:

reader - the reader to supply the BASIC program characters.

Throws:

ScriptBasicException

load

void load(File sourceFile)
          throws ScriptBasicException

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

Parameters:

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

Throws:

ScriptBasicException

load

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

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.

Parameters:

sourceFileName - the file that contains the script

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

Throws:

ScriptBasicException

load

void load(String sourceFileName,
        SourcePath path)
          throws ScriptBasicException

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.

Parameters:

sourceFileName - the file that contains the script

path - the path where included files are located

Throws:

ScriptBasicException

load

void load(String sourceName,
        SourceProvider provider)
          throws ScriptBasicException

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.

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

void eval(String sourceCode)
          throws ScriptBasicException

Evaluate a string as a BASIC program.

Parameters:

sourceCode - contains the source code as string

Throws:

ScriptBasicException

eval

void eval(Reader reader)
          throws ScriptBasicException

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

Parameters:

reader - the reader to supply the BASIC program characters.

Throws:

ScriptBasicException

eval

void eval(File sourceFile)
          throws ScriptBasicException

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

Parameters:

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

Throws:

ScriptBasicException

eval

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

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.

Parameters:

sourceFileName - the file that contains the script

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

Throws:

ScriptBasicException

eval

void eval(String sourceFileName,
        SourcePath path)
          throws ScriptBasicException

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.

Parameters:

sourceFileName - the file that contains the script

path - the path where included files are located

Throws:

ScriptBasicException

eval

void eval(String sourceName,
        SourceProvider provider)
          throws ScriptBasicException

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

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

execute

void execute()
             throws ScriptBasicException

Execute a previously loaded code.

Throws:

ScriptBasicException

setVariable

void setVariable(String name,
               Object value)
                 throws ScriptBasicException

Throws:

ScriptBasicException

getVariable

Object getVariable(String name)
                   throws ScriptBasicException

Throws:

ScriptBasicException

getVariablesIterator

Iterable<String> getVariablesIterator()

getSubroutine

Subroutine getSubroutine(String subroutineName)
                         throws ScriptBasicException

Throws:

ScriptBasicException

getSubroutines

Iterable<Subroutine> getSubroutines()

call

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

Throws:

ScriptBasicException

getSubroutineNames

Iterable<String> getSubroutineNames()

getNumberOfArguments

int getNumberOfArguments(String subroutineName)
                         throws ScriptBasicException

Throws:

ScriptBasicException