com.google.javascript.jscomp

Class NameReferenceGraph

java.lang.Object

com.google.javascript.jscomp.graph.Graph<N,E>

com.google.javascript.jscomp.graph.DiGraph<N,E>

com.google.javascript.jscomp.graph.LinkedDirectedGraph<NameReferenceGraph.Name,NameReferenceGraph.Reference>

com.google.javascript.jscomp.NameReferenceGraph

All Implemented Interfaces:

DefinitionProvider, AdjacencyGraph<NameReferenceGraph.Name,NameReferenceGraph.Reference>, GraphvizGraph

class NameReferenceGraph
extends LinkedDirectedGraph<NameReferenceGraph.Name,NameReferenceGraph.Reference>
implements DefinitionProvider

A graph represents all the referencing of global names in the program. In other words, it is a call and variable-name graph.

The NameReferenceGraph G for a program P is a directed graph G = (V, E) where:

V (NameReferenceGraph.Name) represents all global names in P and E = (v, v'), v and v' in V (NameReferenceGraph.Reference represents a reference use or definition from the name v to v' in P.

There are two core results we are trying to compute. The first being able to precisely identify the function body at any given call site with getReferencesAt(Node).

The second result come directly from the previous one. The directed edge provides us with dependency information. If A->B, B might be needed (in this module) if A is needed (in this module). The converse of the this result is more useful. B is not needed if A is not needed.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) class	NameReferenceGraph.Name Represents function or variable names that can be referenced globally.
(package private) static class	NameReferenceGraph.Reference A reference site for a function or a variable reference.

Nested classes/interfaces inherited from class com.google.javascript.jscomp.graph.LinkedDirectedGraph

LinkedDirectedGraph.LinkedDirectedGraphNode<N,E>

Nested classes/interfaces inherited from class com.google.javascript.jscomp.graph.DiGraph

DiGraph.DiGraphEdge<N,E>, DiGraph.DiGraphNode<N,E>

Nested classes/interfaces inherited from class com.google.javascript.jscomp.graph.Graph

Graph.GraphEdge<N,E>

Nested classes/interfaces inherited from interface com.google.javascript.jscomp.graph.GraphvizGraph

GraphvizGraph.GraphvizEdge, GraphvizGraph.GraphvizNode

Field Summary

Fields

Modifier and Type	Field and Description
(package private) AbstractCompiler	compiler
(package private) NameReferenceGraph.Name	main
private java.util.Map<java.lang.String,NameReferenceGraph.Name>	nameMap
private com.google.common.collect.Multimap<Node,NameReferenceGraph.Name>	referenceMap
(package private) NameReferenceGraph.Name	unknown
(package private) NameReferenceGraph.Name	window

Fields inherited from class com.google.javascript.jscomp.graph.LinkedDirectedGraph

nodes

Constructor Summary

Constructors

Constructor and Description
NameReferenceGraph(AbstractCompiler compiler)

Method Summary

Modifier and Type	Method and Description
void	connect(NameReferenceGraph.Name src, NameReferenceGraph.Reference ref, NameReferenceGraph.Name dest) Connects two nodes in the graph with an edge.
GraphNode<NameReferenceGraph.Name,NameReferenceGraph.Reference>	createNode(NameReferenceGraph.Name value) Gets a node from the graph given a value.
NameReferenceGraph.Name	defineNameIfNotExists(java.lang.String name, boolean isExtern)
java.util.Collection<DefinitionsRemover.Definition>	getDefinitionsReferencedAt(Node useSite) Returns a collection of definitions that characterize the possible values of a variable or property.
java.util.List<NameReferenceGraph.Name>	getReferencesAt(Node site) Retrieves a list of all possible Names that this site is referring to.
NameReferenceGraph.Name	getSymbol(java.lang.String name)

Methods inherited from class com.google.javascript.jscomp.graph.LinkedDirectedGraph

connect, connectIfNotConnectedInDirection, create, createDirectedGraphNode, createWithoutAnnotations, disconnect, disconnectInDirection, getDirectedGraphEdges, getDirectedGraphNode, getDirectedGraphNodes, getDirectedPredNodes, getDirectedPredNodes, getDirectedSuccNodes, getDirectedSuccNodes, getEdges, getEdges, getFirstEdge, getGraphvizEdges, getGraphvizNodes, getInEdges, getName, getNeighborNodes, getNode, getNodeDegree, getNodes, getOutEdges, isConnectedInDirection, isConnectedInDirection, isConnectedInDirection, isDirected, newSubGraph

Methods inherited from class com.google.javascript.jscomp.graph.DiGraph

isConnected, isConnected

Methods inherited from class com.google.javascript.jscomp.graph.Graph

clearEdgeAnnotations, clearNodeAnnotations, connectIfNotFound, getWeight, hasNode, popEdgeAnnotations, popNodeAnnotations, pushEdgeAnnotations, pushNodeAnnotations

Methods inherited from class java.lang.Object

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

Field Detail

referenceMap

private final com.google.common.collect.Multimap<Node,NameReferenceGraph.Name> referenceMap

nameMap

private java.util.Map<java.lang.String,NameReferenceGraph.Name> nameMap

unknown

final NameReferenceGraph.Name unknown

main

final NameReferenceGraph.Name main

window

final NameReferenceGraph.Name window

compiler

final AbstractCompiler compiler

Constructor Detail

NameReferenceGraph

public NameReferenceGraph(AbstractCompiler compiler)

Method Detail

defineNameIfNotExists

public NameReferenceGraph.Name defineNameIfNotExists(java.lang.String name,
                                                     boolean isExtern)

getReferencesAt

public java.util.List<NameReferenceGraph.Name> getReferencesAt(Node site)

Retrieves a list of all possible Names that this site is referring to.

getDefinitionsReferencedAt

public java.util.Collection<DefinitionsRemover.Definition> getDefinitionsReferencedAt(Node useSite)

Description copied from interface: DefinitionProvider

Returns a collection of definitions that characterize the possible values of a variable or property. If information is unavailable or incomplete, return null. This function should never return an empty collection.

Specified by:

getDefinitionsReferencedAt in interface DefinitionProvider

Returns:

non-empty definition collection, or null.

getSymbol

public NameReferenceGraph.Name getSymbol(java.lang.String name)

createNode

public GraphNode<NameReferenceGraph.Name,NameReferenceGraph.Reference> createNode(NameReferenceGraph.Name value)

Description copied from class: Graph

Gets a node from the graph given a value. New nodes are created if that value has not been assigned a graph node. Values equality are compared using Object.equals.

Overrides:

createNode in class LinkedDirectedGraph<NameReferenceGraph.Name,NameReferenceGraph.Reference>

Parameters:

value - The node's value.

Returns:

The corresponding node in the graph.

connect

public void connect(NameReferenceGraph.Name src,
                    NameReferenceGraph.Reference ref,
                    NameReferenceGraph.Name dest)

Description copied from class: Graph

Connects two nodes in the graph with an edge.

Overrides:

connect in class LinkedDirectedGraph<NameReferenceGraph.Name,NameReferenceGraph.Reference>

Parameters:

src - First node.

ref - The edge.

dest - Second node.