com.google.javascript.jscomp

Class GlobalNamespace

java.lang.Object

com.google.javascript.jscomp.GlobalNamespace

All Implemented Interfaces:

StaticTypedScope<TypeI>, StaticScope, StaticSymbolTable<GlobalNamespace.Name,GlobalNamespace.Ref>

class GlobalNamespace
extends java.lang.Object
implements StaticTypedScope<TypeI>, StaticSymbolTable<GlobalNamespace.Name,GlobalNamespace.Ref>

Builds a global namespace of all the objects and their properties in the global scope. Also builds an index of all the references to those names.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) static class	GlobalNamespace.AstChange A simple data class that contains the information necessary to inspect a node for changes to the global namespace.
private class	GlobalNamespace.BuildGlobalNamespace Builds a tree representation of the global namespace.
(package private) static class	GlobalNamespace.Name A name defined in global scope (e.g.
(package private) static class	GlobalNamespace.Ref A global name reference.

Field Summary

Fields

Modifier and Type	Field and Description
private AbstractCompiler	compiler
private int	currentPreOrderIndex Each reference has an index in post-order.
private Node	externsRoot
private Scope	externsScope
private boolean	generated
private java.util.List<GlobalNamespace.Name>	globalNames Global namespace tree
private boolean	inExterns
private java.util.Map<java.lang.String,GlobalNamespace.Name>	nameMap Maps names (e.g.
private Node	root

Constructor Summary

Constructors

Constructor and Description
GlobalNamespace(AbstractCompiler compiler, Node root) Creates an instance that may emit warnings when building the namespace.
GlobalNamespace(AbstractCompiler compiler, Node externsRoot, Node root) Creates an instance that may emit warnings when building the namespace.

Method Summary

Modifier and Type	Method and Description
private void	ensureGenerated()
java.lang.Iterable<GlobalNamespace.Name>	getAllSymbols() Returns all variables in this symbol table.
(package private) java.util.List<GlobalNamespace.Name>	getNameForest() Gets a list of the roots of the forest of the global names, where the roots are the top-level names.
(package private) java.util.Map<java.lang.String,GlobalNamespace.Name>	getNameIndex() Gets an index of all the global names, indexed by full qualified name (as in "a", "a.b.c", etc.).
GlobalNamespace.Name	getOwnSlot(java.lang.String name) Like getSlot but does not recurse into parent scopes.
StaticTypedScope<TypeI>	getParentScope() Returns the scope enclosing this one or null if none.
java.lang.Iterable<GlobalNamespace.Ref>	getReferences(GlobalNamespace.Name slot) Returns the references that point to the given symbol.
Node	getRootNode() Returns the root node associated with this scope.
StaticTypedScope<TypeI>	getScope(GlobalNamespace.Name slot) Returns the scope for a given symbol.
GlobalNamespace.Name	getSlot(java.lang.String name) Returns any defined slot within this scope for this name.
private static java.lang.String	getTopVarName(java.lang.String name) Gets the top variable name from a possibly namespaced name.
TypeI	getTypeOfThis() Returns the expected type of this in the current scope.
(package private) boolean	hasExternsRoot()
private boolean	isGlobalNameReference(java.lang.String name, Scope s) Determines whether a name reference in a particular scope is a global name reference.
private boolean	isGlobalVarReference(java.lang.String name, Scope s) Determines whether a variable name reference in a particular scope is a global variable reference.
private void	process() Builds the namespace lazily.
private void	scanFromNode(GlobalNamespace.BuildGlobalNamespace builder, JSModule module, Scope scope, Node n)
(package private) void	scanNewNodes(java.util.Set<GlobalNamespace.AstChange> newNodes) If the client adds new nodes to the AST, scan these new nodes to see if they've added any references to the global namespace.

Methods inherited from class java.lang.Object

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

Field Detail

compiler

private AbstractCompiler compiler

root

private final Node root

externsRoot

private final Node externsRoot

inExterns

private boolean inExterns

externsScope

private Scope externsScope

generated

private boolean generated

currentPreOrderIndex

private int currentPreOrderIndex

Each reference has an index in post-order. Notice that some nodes are represented by 2 Ref objects, so this index is not necessarily unique.

globalNames

private java.util.List<GlobalNamespace.Name> globalNames

Global namespace tree

nameMap

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

Maps names (e.g. "a.b.c") to nodes in the global namespace tree

Constructor Detail

GlobalNamespace

GlobalNamespace(AbstractCompiler compiler,
                Node root)

Creates an instance that may emit warnings when building the namespace.

Parameters:

compiler - The AbstractCompiler, for reporting code changes

root - The root of the rest of the code to build a namespace for.

GlobalNamespace

GlobalNamespace(AbstractCompiler compiler,
                Node externsRoot,
                Node root)

Creates an instance that may emit warnings when building the namespace.

Parameters:

compiler - The AbstractCompiler, for reporting code changes

externsRoot - The root of the externs to build a namespace for. If this is null, externs and properties defined on extern types will not be included in the global namespace. If non-null, it allows user-defined function on extern types to be included in the global namespace. E.g. String.foo.

root - The root of the rest of the code to build a namespace for.

Method Detail

hasExternsRoot

boolean hasExternsRoot()

getRootNode

public Node getRootNode()

Description copied from interface: StaticScope

Returns the root node associated with this scope. May be null.

Specified by:

getRootNode in interface StaticScope

getParentScope

public StaticTypedScope<TypeI> getParentScope()

Description copied from interface: StaticTypedScope

Returns the scope enclosing this one or null if none.

Specified by:

getParentScope in interface StaticTypedScope<TypeI>

Specified by:

getParentScope in interface StaticScope

getSlot

public GlobalNamespace.Name getSlot(java.lang.String name)

Description copied from interface: StaticTypedScope

Returns any defined slot within this scope for this name. This call continues searching through parent scopes if a slot with this name is not found in the current scope.

Specified by:

getSlot in interface StaticTypedScope<TypeI>

Specified by:

getSlot in interface StaticScope

Parameters:

name - The name of the variable slot to look up.

Returns:

The defined slot for the variable, or null if no definition exists.

getOwnSlot

public GlobalNamespace.Name getOwnSlot(java.lang.String name)

Description copied from interface: StaticTypedScope

Like getSlot but does not recurse into parent scopes.

Specified by:

getOwnSlot in interface StaticTypedScope<TypeI>

Specified by:

getOwnSlot in interface StaticScope

getTypeOfThis

public TypeI getTypeOfThis()

Description copied from interface: StaticTypedScope

Returns the expected type of this in the current scope.

Specified by:

getTypeOfThis in interface StaticTypedScope<TypeI>

getReferences

public java.lang.Iterable<GlobalNamespace.Ref> getReferences(GlobalNamespace.Name slot)

Description copied from interface: StaticSymbolTable

Returns the references that point to the given symbol.

Specified by:

getReferences in interface StaticSymbolTable<GlobalNamespace.Name,GlobalNamespace.Ref>

getScope

public StaticTypedScope<TypeI> getScope(GlobalNamespace.Name slot)

Description copied from interface: StaticSymbolTable

Returns the scope for a given symbol.

Specified by:

getScope in interface StaticSymbolTable<GlobalNamespace.Name,GlobalNamespace.Ref>

getAllSymbols

public java.lang.Iterable<GlobalNamespace.Name> getAllSymbols()

Description copied from interface: StaticSymbolTable

Returns all variables in this symbol table.

Specified by:

getAllSymbols in interface StaticSymbolTable<GlobalNamespace.Name,GlobalNamespace.Ref>

ensureGenerated

private void ensureGenerated()

getNameForest

java.util.List<GlobalNamespace.Name> getNameForest()

Gets a list of the roots of the forest of the global names, where the roots are the top-level names.

getNameIndex

java.util.Map<java.lang.String,GlobalNamespace.Name> getNameIndex()

Gets an index of all the global names, indexed by full qualified name (as in "a", "a.b.c", etc.).

scanNewNodes

void scanNewNodes(java.util.Set<GlobalNamespace.AstChange> newNodes)

If the client adds new nodes to the AST, scan these new nodes to see if they've added any references to the global namespace.

Parameters:

newNodes - New nodes to check.

scanFromNode

private void scanFromNode(GlobalNamespace.BuildGlobalNamespace builder,
                          JSModule module,
                          Scope scope,
                          Node n)

process

private void process()

Builds the namespace lazily.

isGlobalNameReference

private boolean isGlobalNameReference(java.lang.String name,
                                      Scope s)

Determines whether a name reference in a particular scope is a global name reference.

Parameters:

name - A variable or property name (e.g. "a" or "a.b.c.d")

s - The scope in which the name is referenced

Returns:

Whether the name reference is a global name reference

getTopVarName

private static java.lang.String getTopVarName(java.lang.String name)

Gets the top variable name from a possibly namespaced name.

Parameters:

name - A variable or qualified property name (e.g. "a" or "a.b.c.d")

Returns:

The top variable name (e.g. "a")

isGlobalVarReference

private boolean isGlobalVarReference(java.lang.String name,
                                     Scope s)

Determines whether a variable name reference in a particular scope is a global variable reference.

Parameters:

name - A variable name (e.g. "a")

s - The scope in which the name is referenced

Returns:

Whether the name reference is a global variable reference