io.warp10.script.functions

Class VARS

java.lang.Object

io.warp10.script.NamedWarpScriptFunction

io.warp10.script.functions.VARS

All Implemented Interfaces:

WarpScriptStackFunction

public class VARS
extends NamedWarpScriptFunction
implements WarpScriptStackFunction

Extract all used variables in a macro. If a STORE/CSTORE or LOAD operation is found with a parameter which is not a string, then an error is raised. This function can also be restricted to return only variables which are used by STORE/CSTORE and POPR. This avoid returning variables only used by LOAD which are typical of "global" variables. This behaviour is particularly useful for ASREGS because it should avoid replacing those "global" variables by registers. Indeed, the STORE would still be called on the original variable name while the PUSHR will be done on an empty register.

Constructor Summary

Constructors

Constructor and Description
VARS(java.lang.String name)

Method Summary

Modifier and Type	Method and Description
java.lang.Object	apply(WarpScriptStack stack)
static java.util.List<java.lang.Object>	getVars(WarpScriptStack.Macro macro)
static java.util.List<java.lang.Object>	getVars(WarpScriptStack.Macro macro, boolean onlyStoreAndPopr) Loop over the macro statements, in a recursive manner, extracting all variable names.

Methods inherited from class io.warp10.script.NamedWarpScriptFunction

getName, refSnapshot, setName, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

VARS

public VARS(java.lang.String name)

Method Detail

apply

public java.lang.Object apply(WarpScriptStack stack)
                       throws WarpScriptException

Specified by:

apply in interface WarpScriptStackFunction

Throws:

WarpScriptException

getVars

public static java.util.List<java.lang.Object> getVars(WarpScriptStack.Macro macro)
                                                throws WarpScriptException

Throws:

WarpScriptException

getVars

public static java.util.List<java.lang.Object> getVars(WarpScriptStack.Macro macro,
                                                       boolean onlyStoreAndPopr)
                                                throws WarpScriptException

Loop over the macro statements, in a recursive manner, extracting all variable names.

Parameters:

macro - The root macro to extract the variable names from.

onlyStoreAndPopr - Return only variables used for storage. Useful for ASREGS to avoid replacing "global" variables.

Returns:

The list of variable names.

Throws:

WarpScriptException - If a STORE call is found to be using neither a String, Long or a list thereof.