org.jruby.ast.visitor

Class InstanceVariableFinder

java.lang.Object

org.jruby.ast.visitor.AbstractNodeVisitor

org.jruby.ast.visitor.InstanceVariableFinder

All Implemented Interfaces:

NodeVisitor

public class InstanceVariableFinder
extends AbstractNodeVisitor

Visitor to search AST nodes for instance variables. Certain nodes are ignored during walking since they always create a new context with a new self. Example usage: Node node = getNodeFromSomewhere(); InstanceVariableFinder finder = new InstanceVariableFinder(); node.accept(finder); System.out.println("found: " + finder.getFoundVariables);

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.Set<java.lang.String>	foundVariables The set of instance variables found during walking.

Constructor Summary

Constructors

Constructor and Description
InstanceVariableFinder()

Method Summary

Modifier and Type	Method and Description
static java.util.Set<java.lang.String>	findVariables(Node node) Walk a node and its children looking for instance variables using a new InstanceVariableFinder.
java.util.Set<java.lang.String>	getFoundVariables() Return the Set of all instance variables found during walking.
java.lang.Object	visitClassNode(ClassNode iVisited) ClassNode creates a new scope and self, so do not search for ivars.
java.lang.Object	visitInstAsgnNode(InstAsgnNode iVisited) Add the name of the instance variable being assigned to our set of instance variable names and continue to walk child nodes.
java.lang.Object	visitInstVarNode(InstVarNode iVisited) Add the name of the instance variable being retrieved to our set of instance variable names and continue to walk child nodes.
java.lang.Object	visitModuleNode(ModuleNode iVisited) ModuleNode creates a new scope and self, so do not search for ivars.
java.lang.Object	visitPostExeNode(PostExeNode iVisited) PostExeNode can't appear in methods, so do not search for ivars.
java.lang.Object	visitPreExeNode(PreExeNode iVisited) PreExeNode can't appear in methods, so do not search for ivars.

Methods inherited from class org.jruby.ast.visitor.AbstractNodeVisitor

visitAliasNode, visitAndNode, visitArgsCatNode, visitArgsNode, visitArgsPushNode, visitArrayNode, visitAttrAssignNode, visitBackRefNode, visitBeginNode, visitBignumNode, visitBlockArg18Node, visitBlockArgNode, visitBlockNode, visitBlockPassNode, visitBreakNode, visitCallNode, visitCaseNode, visitClassVarAsgnNode, visitClassVarDeclNode, visitClassVarNode, visitColon2Node, visitColon3Node, visitConstDeclNode, visitConstNode, visitDAsgnNode, visitDefinedNode, visitDefnNode, visitDefsNode, visitDotNode, visitDRegxNode, visitDStrNode, visitDSymbolNode, visitDVarNode, visitDXStrNode, visitEncodingNode, visitEnsureNode, visitEvStrNode, visitFalseNode, visitFCallNode, visitFixnumNode, visitFlipNode, visitFloatNode, visitForNode, visitGlobalAsgnNode, visitGlobalVarNode, visitHashNode, visitIfNode, visitIterNode, visitKeywordArgNode, visitKeywordRestArgNode, visitLambdaNode, visitListNode, visitLiteralNode, visitLocalAsgnNode, visitLocalVarNode, visitMatch2Node, visitMatch3Node, visitMatchNode, visitMultipleAsgnNode, visitMultipleAsgnNode, visitNewlineNode, visitNextNode, visitNilNode, visitNotNode, visitNthRefNode, visitOpAsgnAndNode, visitOpAsgnNode, visitOpAsgnOrNode, visitOpElementAsgnNode, visitOptArgNode, visitOrNode, visitRedoNode, visitRegexpNode, visitRescueBodyNode, visitRescueNode, visitRestArgNode, visitRetryNode, visitReturnNode, visitRootNode, visitSClassNode, visitSelfNode, visitSplatNode, visitStrNode, visitSuperNode, visitSValueNode, visitSymbolNode, visitToAryNode, visitTrueNode, visitUndefNode, visitUntilNode, visitVAliasNode, visitVCallNode, visitWhenNode, visitWhileNode, visitXStrNode, visitYieldNode, visitZArrayNode, visitZSuperNode

Methods inherited from class java.lang.Object

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

Field Detail

foundVariables

private final java.util.Set<java.lang.String> foundVariables

The set of instance variables found during walking.

Constructor Detail

InstanceVariableFinder

public InstanceVariableFinder()

Method Detail

findVariables

public static java.util.Set<java.lang.String> findVariables(Node node)

Walk a node and its children looking for instance variables using a new InstanceVariableFinder. Return an array of the variable names found.

Parameters:

node - the node to walk

Returns:

an array of instance variable names found

getFoundVariables

public java.util.Set<java.lang.String> getFoundVariables()

Return the Set of all instance variables found during walking.

Overrides:

getFoundVariables in class AbstractNodeVisitor

Returns:

a Set of all instance variable names found

visitClassNode

public java.lang.Object visitClassNode(ClassNode iVisited)

ClassNode creates a new scope and self, so do not search for ivars.

Specified by:

visitClassNode in interface NodeVisitor

Overrides:

visitClassNode in class AbstractNodeVisitor

Returns:

null

visitInstAsgnNode

public java.lang.Object visitInstAsgnNode(InstAsgnNode iVisited)

Add the name of the instance variable being assigned to our set of instance variable names and continue to walk child nodes.

Specified by:

visitInstAsgnNode in interface NodeVisitor

Overrides:

visitInstAsgnNode in class AbstractNodeVisitor

Returns:

null

visitInstVarNode

public java.lang.Object visitInstVarNode(InstVarNode iVisited)

Add the name of the instance variable being retrieved to our set of instance variable names and continue to walk child nodes.

Specified by:

visitInstVarNode in interface NodeVisitor

Overrides:

visitInstVarNode in class AbstractNodeVisitor

Returns:

null

visitModuleNode

public java.lang.Object visitModuleNode(ModuleNode iVisited)

ModuleNode creates a new scope and self, so do not search for ivars.

Specified by:

visitModuleNode in interface NodeVisitor

Overrides:

visitModuleNode in class AbstractNodeVisitor

Returns:

null

visitPreExeNode

public java.lang.Object visitPreExeNode(PreExeNode iVisited)

PreExeNode can't appear in methods, so do not search for ivars.

Specified by:

visitPreExeNode in interface NodeVisitor

Overrides:

visitPreExeNode in class AbstractNodeVisitor

Returns:

null

visitPostExeNode

public java.lang.Object visitPostExeNode(PostExeNode iVisited)

PostExeNode can't appear in methods, so do not search for ivars.

Specified by:

visitPostExeNode in interface NodeVisitor

Overrides:

visitPostExeNode in class AbstractNodeVisitor

Returns:

null