Package com.singularsys.extensions.rewrite

Class RewriteVisitor

java.lang.Object

com.singularsys.jep.walkers.GenericDoNothingVisitor<Void>

com.singularsys.jep.walkers.GenericDeepCopyVisitor<Void>

com.singularsys.extensions.rewrite.RewriteVisitor

All Implemented Interfaces:

GenericVisitor<Node,Void,ParseException>, JepComponent, Serializable

public class RewriteVisitor
extends GenericDeepCopyVisitor<Void>

A visitor which allows rewrite rules to be added and applied.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	RewriteVisitor.ConstantRuleI	Define a rule which may modify a constant node.
static interface	RewriteVisitor.VariableRuleI	Define a rule which may modify a variable node.

Field Summary

Fields

Modifier and Type	Field	Description
final List<RewriteRuleI>	rules

Fields inherited from class com.singularsys.jep.walkers.GenericDoNothingVisitor

ft, nf, ot

Constructor Summary

Constructors

Constructor	Description
RewriteVisitor()
RewriteVisitor(Jep j)	Constructor for use in standalone context

Method Summary

Modifier and Type	Method	Description
boolean	add(RewriteRuleI rule)	Add a rewriting rule
boolean	add(RewriteVisitor.ConstantRuleI rule)	Adds a rule modifying constant nodes
boolean	add(RewriteVisitor.VariableRuleI rule)	Adds a rule modifying variable nodes
void	clear()	Clear all rules of all types
List<RewriteVisitor.ConstantRuleI>	getConstantRules()
JepComponent	getLightWeightInstance()	Gets a light-weight instance suitable for using in multiple threads.
List<RewriteRuleI>	getRules()	Gets the current set of rules
List<RewriteVisitor.VariableRuleI>	getVariableRules()
void	init(Jep j)	Initialize the component.
Node	rewrite(Node node, boolean clean)	Applies the set of rules to the node
Node	visit(ASTConstant node, Void data)	Visit a constant node
Node	visit(ASTFunNode node, Void data)	Visit a function node
Node	visit(ASTOpNode node, Void data)	Visit an operator node
Node	visit(ASTVarNode node, Void data)	Visit a variable node
Node	visitFun(ASTFunNode node)

Methods inherited from class com.singularsys.jep.walkers.GenericDeepCopyVisitor

visit

Methods inherited from class com.singularsys.jep.walkers.GenericDoNothingVisitor

childrenHaveChanged, copyChildrenIfNeeded, copyChildrenIfNeeded, makeException

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.singularsys.jep.GenericVisitor

makeException, visitChildren

Field Details

rules

public final List<RewriteRuleI> rules

Constructor Details

RewriteVisitor

public RewriteVisitor()

RewriteVisitor

public RewriteVisitor(Jep j)

Constructor for use in standalone context

Parameters:

j - Jep instance to use

Method Details

init

public void init(Jep j)

Description copied from interface: JepComponent

Initialize the component. This method is called whenever a component is added to Jep. Hence, it allows components to keep track of the other components they may rely on.

Specified by:

init in interface JepComponent

Overrides:

init in class GenericDoNothingVisitor<Void>

Parameters:

j - the current Jep instance

rewrite

public Node rewrite(Node node,
 boolean clean)
             throws ParseException

Applies the set of rules to the node

Parameters:

node - node to apply rewriting to

clean - whether to clean the result

Returns:

Throws:

ParseException

visit

public Node visit(ASTOpNode node,
 Void data)
           throws ParseException

Description copied from interface: GenericVisitor

Visit an operator node

Specified by:

visit in interface GenericVisitor<Node,Void,ParseException>

Overrides:

visit in class GenericDeepCopyVisitor<Void>

Parameters:

node - current node

data - context data

Returns:

the result of visiting the node

Throws:

ParseException

visit

public Node visit(ASTFunNode node,
 Void data)
           throws ParseException

Description copied from interface: GenericVisitor

Visit a function node

Specified by:

visit in interface GenericVisitor<Node,Void,ParseException>

Overrides:

visit in class GenericDeepCopyVisitor<Void>

Parameters:

node - current node

data - context data

Returns:

the result of visiting the node

Throws:

ParseException

visitFun

public Node visitFun(ASTFunNode node)
              throws ParseException

Throws:

ParseException

visit

public Node visit(ASTConstant node,
 Void data)
           throws ParseException

Description copied from interface: GenericVisitor

Visit a constant node

Specified by:

visit in interface GenericVisitor<Node,Void,ParseException>

Overrides:

visit in class GenericDeepCopyVisitor<Void>

Parameters:

node - current node

data - context data

Returns:

the result of visiting the node

Throws:

ParseException

visit

public Node visit(ASTVarNode node,
 Void data)
           throws ParseException

Description copied from interface: GenericVisitor

Visit a variable node

Specified by:

visit in interface GenericVisitor<Node,Void,ParseException>

Overrides:

visit in class GenericDeepCopyVisitor<Void>

Parameters:

node - current node

data - context data

Returns:

the result of visiting the node

Throws:

ParseException

add

public boolean add(RewriteRuleI rule)

Add a rewriting rule

Parameters:

rule - rule to add

Returns:

getRules

public List<RewriteRuleI> getRules()

Gets the current set of rules

Returns:

add

public boolean add(RewriteVisitor.VariableRuleI rule)

Adds a rule modifying variable nodes

Parameters:

rule - the rule

Returns:

true

Since:

Jep 4.0/Extensions 2.1

add

public boolean add(RewriteVisitor.ConstantRuleI rule)

Adds a rule modifying constant nodes

Parameters:

rule - the rule

Returns:

true

Since:

Jep 4.0/Extensions 2.1

getVariableRules

public List<RewriteVisitor.VariableRuleI> getVariableRules()

getConstantRules

public List<RewriteVisitor.ConstantRuleI> getConstantRules()

clear

public void clear()

Clear all rules of all types

Since:

Jep 4.0

getLightWeightInstance

public JepComponent getLightWeightInstance()

Description copied from interface: JepComponent

Gets a light-weight instance suitable for using in multiple threads.

Specified by:

getLightWeightInstance in interface JepComponent

Overrides:

getLightWeightInstance in class GenericDeepCopyVisitor<Void>

Returns:

either a new instance, null or 'this'.