com.google.javascript.jscomp

Class DefinitionUseSiteFinder

java.lang.Object

com.google.javascript.jscomp.NameBasedDefinitionProvider

com.google.javascript.jscomp.DefinitionUseSiteFinder

All Implemented Interfaces:

CompilerPass

public class DefinitionUseSiteFinder
extends NameBasedDefinitionProvider

Built on top of the NameBasedDefinitionProvider, this class additionally collects the use sites for each definition. It is useful for constructing a full reference graph of the entire ast.

Field Summary

Fields inherited from class com.google.javascript.jscomp.NameBasedDefinitionProvider

allowComplexFunctionDefs, compiler, definitionNodes, definitionsByName, definitionSitesByDefinitionSiteNode, definitionSitesByScopeNode, hasProcessBeenRun

Constructor Summary

Constructors

Constructor and Description
DefinitionUseSiteFinder(AbstractCompiler compiler)

Method Summary

Modifier and Type	Method and Description
Collection<com.google.javascript.jscomp.UseSite>	getUseSites(com.google.javascript.jscomp.DefinitionsRemover.Definition definition) Returns a collection of use sites that may refer to provided definition.
void	process(Node externs, Node source) Process the JS with root node root.
void	rebuildScopeRoots(List<Node> changedScopeRoots, List<Node> deletedScopeRoots)

Methods inherited from class com.google.javascript.jscomp.NameBasedDefinitionProvider

getDefinitionForFunction, getDefinitionSites, getDefinitionsReferencedAt, getSimplifiedName

Methods inherited from class java.lang.Object

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

Constructor Detail

DefinitionUseSiteFinder

public DefinitionUseSiteFinder(AbstractCompiler compiler)

Method Detail

process

public void process(Node externs,
                    Node source)

Description copied from interface: CompilerPass

Process the JS with root node root. Can modify the contents of each Node tree

Specified by:

process in interface CompilerPass

Overrides:

process in class NameBasedDefinitionProvider

Parameters:

externs - Top of external JS tree

source - Top of JS tree

getUseSites

public Collection<com.google.javascript.jscomp.UseSite> getUseSites(com.google.javascript.jscomp.DefinitionsRemover.Definition definition)

Returns a collection of use sites that may refer to provided definition. Returns an empty collection if the definition is not used anywhere.

Parameters:

definition - Definition of interest.

Returns:

use site collection.

rebuildScopeRoots

public void rebuildScopeRoots(List<Node> changedScopeRoots,
                              List<Node> deletedScopeRoots)

Overrides:

rebuildScopeRoots in class NameBasedDefinitionProvider