Package org.jruby.ast.visitor

Class InstanceVariableFinder

java.lang.Object

org.jruby.ast.visitor.AbstractNodeVisitor<Void>

org.jruby.ast.visitor.InstanceVariableFinder

All Implemented Interfaces:

NodeVisitor<Void>

public class InstanceVariableFinder
extends AbstractNodeVisitor<Void>

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	Description
private final Set<RubySymbol>	foundVariables	The set of instance variables found during walking.

Constructor Summary

Constructors

Constructor	Description
InstanceVariableFinder()

Method Summary

Modifier and Type	Method	Description
protected Void	defaultVisit(Node iVisited)
static Set<RubySymbol>	findVariables(Node node)	Walk a node and its children looking for instance variables using a new InstanceVariableFinder.
Set<RubySymbol>	getFoundVariables()	Return the Set of all instance variables found during walking.
Void	visitClassNode(ClassNode iVisited)	ClassNode creates a new scope and self, so do not search for ivars.
Void	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.
Void	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.
Void	visitModuleNode(ModuleNode iVisited)	ModuleNode creates a new scope and self, so do not search for ivars.
Void	visitPostExeNode(PostExeNode iVisited)	PostExeNode can't appear in methods, so do not search for ivars.
Void	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, visitArgumentNode, visitArrayNode, visitAttrAssignNode, visitBackRefNode, visitBeginNode, visitBignumNode, visitBlockArgNode, visitBlockNode, visitBlockPassNode, visitBreakNode, visitCallNode, visitCaseNode, visitChildren, visitClassVarAsgnNode, visitClassVarDeclNode, visitClassVarNode, visitColon2Node, visitColon3Node, visitComplexNode, visitConstDeclNode, visitConstNode, visitDAsgnNode, visitDefinedNode, visitDefnNode, visitDefsNode, visitDotNode, visitDRegxNode, visitDStrNode, visitDSymbolNode, visitDVarNode, visitDXStrNode, visitEncodingNode, visitEnsureNode, visitEvStrNode, visitFalseNode, visitFCallNode, visitFirstChild, visitFixnumNode, visitFlipNode, visitFloatNode, visitForNode, visitGlobalAsgnNode, visitGlobalVarNode, visitHashNode, visitIfNode, visitIterNode, visitKeywordArgNode, visitKeywordRestArgNode, visitLambdaNode, visitListNode, visitLiteralNode, visitLocalAsgnNode, visitLocalVarNode, visitMatch2Node, visitMatch3Node, visitMatchNode, visitMultipleAsgnNode, visitNewlineNode, visitNextNode, visitNilNode, visitNthRefNode, visitOpAsgnAndNode, visitOpAsgnConstDeclNode, visitOpAsgnNode, visitOpAsgnOrNode, visitOpElementAsgnNode, visitOperatorCallNode, visitOptArgNode, visitOrNode, visitOther, visitRationalNode, visitRedoNode, visitRegexpNode, visitRequiredKeywordArgumentValueNode, visitRescueBodyNode, visitRescueNode, visitRestArgNode, visitRetryNode, visitReturnNode, visitRootNode, visitSClassNode, visitSelfNode, visitSplatNode, visitStarNode, visitStrNode, visitSuperNode, visitSValueNode, visitSymbolNode, 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 Details

foundVariables

private final Set<RubySymbol> foundVariables

The set of instance variables found during walking.

Constructor Details

InstanceVariableFinder

public InstanceVariableFinder()

Method Details

defaultVisit

protected Void defaultVisit(Node iVisited)

Specified by:

defaultVisit in class AbstractNodeVisitor<Void>

findVariables

public static Set<RubySymbol> 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 Set<RubySymbol> getFoundVariables()

Return the Set of all instance variables found during walking.

Returns:

a Set of all instance variable names found

visitClassNode

public Void visitClassNode(ClassNode iVisited)

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

Specified by:

visitClassNode in interface NodeVisitor<Void>

Overrides:

visitClassNode in class AbstractNodeVisitor<Void>

Returns:

null

visitInstAsgnNode

public Void 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<Void>

Overrides:

visitInstAsgnNode in class AbstractNodeVisitor<Void>

Returns:

null

visitInstVarNode

public Void 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<Void>

Overrides:

visitInstVarNode in class AbstractNodeVisitor<Void>

Returns:

null

visitModuleNode

public Void visitModuleNode(ModuleNode iVisited)

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

Specified by:

visitModuleNode in interface NodeVisitor<Void>

Overrides:

visitModuleNode in class AbstractNodeVisitor<Void>

Returns:

null

visitPreExeNode

public Void visitPreExeNode(PreExeNode iVisited)

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

Specified by:

visitPreExeNode in interface NodeVisitor<Void>

Overrides:

visitPreExeNode in class AbstractNodeVisitor<Void>

Returns:

null

visitPostExeNode

public Void visitPostExeNode(PostExeNode iVisited)

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

Specified by:

visitPostExeNode in interface NodeVisitor<Void>

Overrides:

visitPostExeNode in class AbstractNodeVisitor<Void>

Returns:

null