ScriptBasic (ScriptBasic for Java 1.0.5 API)

```
public interface ScriptBasic
```
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

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`void`	`eval(java.io.File sourceFile)`	Evaluate the content of a file.
`void`	`eval(java.io.Reader reader)`	Read the content of a stream provided by the reader and interpret this as a BASIC program.
`void`	`eval(java.lang.String sourceCode)`	Evaluate a string as a BASIC program.
`void`	`eval(java.lang.String sourceFileName, com.scriptbasic.interfaces.SourcePath path)`	Read the content of the file and execute it.
`void`	`eval(java.lang.String sourceName, com.scriptbasic.interfaces.SourceProvider provider)`	Read the content of the source from the file, db...
`void`	`eval(java.lang.String sourceFileName, java.lang.String... path)`	Read the content of the file and execute it.
`void`	`execute()`	Execute a previously loaded code.
`static ScriptBasic`	`getEngine()`
`java.io.Writer`	`getError()`	Get the output writer used to write the error output of the BASIC program.
`java.io.Reader`	`getInput()`	Get the reader from where the BASIC program reads the standard input characters.
`java.io.Writer`	`getOutput()`	Get the output writer used to write the standard output of the BASIC program.
`Subroutine`	`getSubroutine(java.lang.String subroutineName)`	Get the subroutine object of a named subroutine.
`java.lang.Iterable<Subroutine>`	`getSubroutines()`	Get all the subroutine objects in an iterator.
`java.lang.Object`	`getVariable(java.lang.String name)`	Get the value of a global variable after the BASIC program was executed.
`java.lang.Iterable<java.lang.String>`	`getVariablesIterator()`	Get an iterator that iterates through the names of the global variables.
`void`	`load(java.io.File sourceFile)`	Evaluate the content of a file.
`void`	`load(java.io.Reader reader)`	Read the content of a stream provided by the reader and interpret this as a BASIC program.
`void`	`load(java.lang.String sourceCode)`	Load a string as a BASIC program.
`void`	`load(java.lang.String sourceFileName, com.scriptbasic.interfaces.SourcePath path)`	Read the content of the file and execute it.
`void`	`load(java.lang.String sourceName, com.scriptbasic.interfaces.SourceProvider provider)`	Read the content of the source from the file, db...
`void`	`load(java.lang.String sourceFileName, java.lang.String... path)`	Read the content of the file and execute it.
`void`	`registerExtension(java.lang.Class<?> klass)`	Register the static methods of the class as BASIC functions.
`void`	`registerFunctions(java.lang.Class<?> klass)`	Register all annotated methods of the class `klass` so that they can be accessed from BASIC.
`void`	`setError(java.io.Writer error)`	Set the output writer used to write the error output of the BASIC program.
`void`	`setInput(java.io.Reader input)`	Set the reader from where the BASIC program reads the standard input characters.
`void`	`setOutput(java.io.Writer output)`	Set the output writer used to write the standard output of the BASIC program.
`void`	`setVariable(java.lang.String name, java.lang.Object value)`	Set the value of a global variable of the BASIC program.

- Method Detail
  - getEngine
```
static ScriptBasic getEngine()
```
  - registerFunctions
```
void registerFunctions(java.lang.Class<?> klass)
                throws ScriptBasicException
```
    Register all annotated methods of the class klass so that they can be accessed from BASIC.
    
    Parameters:
    
    klass - the class that contains the static methods to register
    
    Throws:
    
    ScriptBasicException - when a function is double defined and not an identical manner
  - getInput
```
java.io.Reader getInput()
```
    Get the reader from where the BASIC program reads the standard input characters.
    
    Returns:
  - setInput
```
void setInput(java.io.Reader input)
```
    Set the reader from where the BASIC program reads the standard input characters.
    
    Parameters:
    
    input -
  - getOutput
```
java.io.Writer getOutput()
```
    Get the output writer used to write the standard output of the BASIC program.
    
    Returns:
  - setOutput
```
void setOutput(java.io.Writer output)
```
    Set the output writer used to write the standard output of the BASIC program.
    
    Parameters:
    
    output -
  - getError
```
java.io.Writer getError()
```
    Get the output writer used to write the error output of the BASIC program.
    
    Returns:
  - setError
```
void setError(java.io.Writer error)
```
    Set the output writer used to write the error output of the BASIC program.
    
    Parameters:
    
    error -
  - load
```
void load(java.lang.String sourceCode)
   throws ScriptBasicException
```
    Load a string as a BASIC program.
    
    Parameters:
    
    sourceCode - contains the source code as string
    
    Throws:
    
    ScriptBasicException
  - load
```
void load(java.io.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(java.io.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(java.lang.String sourceFileName,
          java.lang.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(java.lang.String sourceFileName,
          com.scriptbasic.interfaces.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(java.lang.String sourceName,
          com.scriptbasic.interfaces.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(java.lang.String sourceCode)
   throws ScriptBasicException
```
    Evaluate a string as a BASIC program.
    
    Parameters:
    
    sourceCode - contains the source code as string
    
    Throws:
    
    ScriptBasicException
  - eval
```
void eval(java.io.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(java.io.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(java.lang.String sourceFileName,
          java.lang.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(java.lang.String sourceFileName,
          com.scriptbasic.interfaces.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(java.lang.String sourceName,
          com.scriptbasic.interfaces.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(java.lang.String name,
                 java.lang.Object value)
          throws ScriptBasicException
```
    Set the value of a global variable of the BASIC program.
    
    Parameters:
    
    name - of the variable as it is used in the BASIC program
    
    value - the value of the variable. The value is converted automatically to be a BASIC value.
    
    Throws:
    
    ScriptBasicException
  - getVariable
```
java.lang.Object getVariable(java.lang.String name)
                      throws ScriptBasicException
```
    Get the value of a global variable after the BASIC program was executed.
    
    Parameters:
    
    name - of the variable
    
    Returns:
    
    the value of the variable converted to Java. Thus there is no need to deal with ScriptBasic internal classes. If the variable contains an integer then this method will return a Long, if it is a string then it will be a String and so on.
    
    Throws:
    
    ScriptBasicException
  - getVariablesIterator
```
java.lang.Iterable<java.lang.String> getVariablesIterator()
```
    Get an iterator that iterates through the names of the global variables.
    
    Returns:
    
    the iterator to fetch the names of the global variables one by one.
  - getSubroutine
```
Subroutine getSubroutine(java.lang.String subroutineName)
                  throws ScriptBasicException
```
    Get the subroutine object of a named subroutine. This object can later be used to call the subroutine after the code was executed.
    
    Parameters:
    
    subroutineName - the name of the subroutine for which the object is to be fetched.
    
    Returns:
    
    the subroutine object.
    
    Throws:
    
    ScriptBasicException
  - getSubroutines
```
java.lang.Iterable<Subroutine> getSubroutines()
```
    Get all the subroutine objects in an iterator.
    
    Returns:
    
    an iterator that can be used to access all subroutine objects.
  - registerExtension
```
void registerExtension(java.lang.Class<?> klass)
                throws ScriptBasicException
```
    Register the static methods of the class as BASIC functions. After the registration the methods can be called from BASIC just as if they were built-in functions in the language or just like if they were defined as BASIC subroutines.
    The registration process uses only the methods that are annotated as BasicFunction and only if their BasicFunction.classification() parameter is not configured in the configuration file as forbidden.
    Even though the static methods are called via reflection they have to be callable from the BASIC interpreter. Simply saying they have to be public.
    
    Parameters:
    
    klass - the class to parse.
    
    Throws:
    
    ScriptBasicException

Interface ScriptBasic

Method Summary

Method Detail

getEngine

registerFunctions

getInput

setInput

getOutput

setOutput

getError

setError

load

load

load

load

load

load

eval

eval

eval

eval

eval

eval

execute

setVariable

getVariable

getVariablesIterator

getSubroutine

getSubroutines

registerExtension