|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectmurlen.util.fscript.FScript
Femto Script - This is the main FScript package class
Copyright (C) 2000-2003 murlen.
This library is free software; you can redistribute it and/or modify it under the terms of the GNU Library General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public License for more details.
You should have received a copy of the GNU Library General Public License along with this library; if not, write to the Free Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA
Constructor Summary | |
FScript()
Constructor |
Method Summary | |
java.lang.Object |
callFunction(java.lang.String name,
java.util.ArrayList params)
Override this call to implement custom functions See the BasicIO class for an example |
java.lang.Object |
callScriptFunction(java.lang.String name,
java.util.ArrayList params)
Calls a function in the script - note that if the function is not defined calls will be made to the subclass callFunction methods - therefore this method should be used with caution from within an overriden callFunction. |
java.lang.Object |
cont()
Continues execution from current point - only really useful in a document processing application where you may wish to add code, execute, add some more code..etc.. |
java.lang.Object |
evaluateExpression(java.lang.String expr)
|
java.lang.String |
getContext()
get the current context (executed line, variables etc) |
java.lang.String[] |
getError()
Returns more details on any error states, indicated by FSExceptions. |
java.lang.Object |
getScriptVar(java.lang.String name)
Gets a variable in script space note that if the varialble is not defined in the script, calls will be made to subclass getVar methods - therefore this method should be used with caution from within an overriden getVar. |
java.lang.Object |
getVar(java.lang.String name)
Override this method to allow external access to variables in your code. |
java.lang.Object |
getVar(java.lang.String name,
java.lang.Object index)
Override this method to allow external access to variables in your code. |
void |
load(java.io.Reader is)
Loads FScript parser with text from an InputStreamReader |
void |
loadLine(java.lang.String line)
Load an individual line into the parser, intended for document processing applications |
void |
registerExtension(FSExtension extension)
Registers language extensions |
void |
reset()
Resets the internal code store |
java.lang.Object |
run()
Run the parser over currently loaded code |
void |
setScriptVar(java.lang.String name,
java.lang.Object value)
Sets a variable in script space = the value passed in - the variable must be have the correct type - note that if the varialble is not defined in the script, calls will be made to subclass setVar methods - therefore this method should be used with caution from within an overriden setVar. |
void |
setVar(java.lang.String name,
java.lang.Object value)
Logical inverse of getVar |
void |
setVar(java.lang.String name,
java.lang.Object index,
java.lang.Object value)
Logical inverse of getVar (with index) |
void |
unRegisterExtension(FSExtension extension)
Removes a previously registered extenison |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public FScript()
Method Detail |
public void load(java.io.Reader is) throws java.io.IOException
is
- the input stream
java.io.IOException
public void loadLine(java.lang.String line)
line
- the line to loadpublic void registerExtension(FSExtension extension)
extension
- the extension to registerpublic void unRegisterExtension(FSExtension extension)
extension
- the extension to removepublic java.lang.Object run() throws java.io.IOException, FSException
java.io.IOException
FSException
public java.lang.Object evaluateExpression(java.lang.String expr) throws java.io.IOException, FSException
java.io.IOException
FSException
public void reset()
public java.lang.Object cont() throws java.io.IOException, FSException
java.io.IOException
FSException
public java.lang.String[] getError()
public java.lang.Object getVar(java.lang.String name) throws FSException
getVar
in interface FSVarExtension
name
- the name of the variable the parser is requesting
e.g
add this...
FSException
public java.lang.Object getVar(java.lang.String name, java.lang.Object index) throws FSException
As getVar(String name) but allows an index variable to be passed so code such as : name=list[2] is possible
getVar
in interface FSArrayExtension
name
- the name of the variable the parser is requestingindex
- the index
FSException
public void setVar(java.lang.String name, java.lang.Object value) throws FSException
setVar
in interface FSVarExtension
name
- the variable namevalue
- the value to set it to
FSException
public void setVar(java.lang.String name, java.lang.Object index, java.lang.Object value) throws FSException
setVar
in interface FSArrayExtension
name
- the variable nameindex
- the index into the 'array'value
- the value to set it to
FSException
public java.lang.Object callFunction(java.lang.String name, java.util.ArrayList params) throws FSException
callFunction
in interface FSFunctionExtension
name
- the function nameparams
- an ArrayList of parameter values
FSException
public final void setScriptVar(java.lang.String name, java.lang.Object value) throws FSException
name
- the name of the variablevalue
- the value to set variable to (String,Integer)
FSException
public final java.lang.Object getScriptVar(java.lang.String name) throws FSException
name
- the name of the variable
FSException
public final java.lang.Object callScriptFunction(java.lang.String name, java.util.ArrayList params) throws java.io.IOException, FSException
name
- the name of the functionparams
- the parameters to pass (must be correct type and number)
java.io.IOException
FSException
public java.lang.String getContext()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |