com.google.javascript.jscomp

Class TypedScopeCreator

java.lang.Object

com.google.javascript.jscomp.TypedScopeCreator

All Implemented Interfaces:

ScopeCreator

final class TypedScopeCreator
extends java.lang.Object
implements ScopeCreator

Creates the symbol table of variables available in the current scope and their types. Scopes created by this class are very different from scopes created by the syntactic scope creator. These scopes have type information, and include some qualified names in addition to variables (like Class.staticMethod). When building scope information, also declares relevant information about types in the type registry.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	TypedScopeCreator.AbstractScopeBuilder
private class	TypedScopeCreator.DeferredSetType Defer attachment of types to nodes until all type names have been resolved.
private static class	TypedScopeCreator.DiscoverEnumsAndTypedefs
private static class	TypedScopeCreator.FirstOrderFunctionAnalyzer Does a first-order function analysis that just looks at simple things like what variables are escaped, and whether 'this' is used.
private class	TypedScopeCreator.GlobalScopeBuilder A shallow traversal of the global scope to build up all classes, functions, and methods.
private class	TypedScopeCreator.LocalScopeBuilder A shallow traversal of a local scope to find all arguments and local variables.
private static class	TypedScopeCreator.StubDeclaration A stub declaration without any type information.

Field Summary

Fields

Modifier and Type	Field and Description
(package private) static DiagnosticGroup	ALL_DIAGNOSTICS
private CodingConvention	codingConvention
private AbstractCompiler	compiler
(package private) static DiagnosticType	CONSTRUCTOR_EXPECTED
(package private) static DiagnosticType	CTOR_INITIALIZER
(package private) static java.lang.String	DELEGATE_PROXY_SUFFIX A suffix for naming delegate proxies differently from their base.
private java.util.Map<java.lang.String,java.lang.String>	delegateCallingConventions
private java.util.List<ObjectType>	delegateProxyPrototypes
(package private) static DiagnosticType	ENUM_INITIALIZER
private java.util.Map<Node,FunctionTypeBuilder.AstFunctionContents>	functionAnalysisResults
(package private) static DiagnosticType	IFACE_INITIALIZER
(package private) static DiagnosticType	LENDS_ON_NON_OBJECT
(package private) static DiagnosticType	MALFORMED_TYPEDEF
private boolean	runsAfterNTI
private ErrorReporter	typeParsingErrorReporter
private JSTypeRegistry	typeRegistry
(package private) static DiagnosticType	UNKNOWN_LENDS
private ObjectType	unknownType
private TypeValidator	validator

Constructor Summary

Constructors

Constructor and Description
TypedScopeCreator(AbstractCompiler compiler)
TypedScopeCreator(AbstractCompiler compiler, CodingConvention codingConvention)

Method Summary

Modifier and Type	Method and Description
(package private) TypedScope	createInitialScope(Node root) Create the outermost scope.
TypedScope	createScope(Node root, Scope parent) Creates a scope with all types declared.
private void	declareNativeFunctionType(TypedScope scope, JSTypeNative tId)
private static void	declareNativeType(TypedScope scope, java.lang.String name, JSType t)
private void	declareNativeValueType(TypedScope scope, java.lang.String name, JSTypeNative tId)
private FunctionTypeBuilder.AstFunctionContents	getFunctionAnalysisResults(Node n)
private JSType	getNativeType(JSTypeNative nativeType)
boolean	hasBlockScope()
(package private) void	patchGlobalScope(TypedScope globalScope, Node scriptRoot) Patches a given global scope by removing variables previously declared in a script and re-traversing a new version of that script.
private void	report(JSError error)

Methods inherited from class java.lang.Object

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

Field Detail

DELEGATE_PROXY_SUFFIX

static final java.lang.String DELEGATE_PROXY_SUFFIX

A suffix for naming delegate proxies differently from their base.

MALFORMED_TYPEDEF

static final DiagnosticType MALFORMED_TYPEDEF

ENUM_INITIALIZER

static final DiagnosticType ENUM_INITIALIZER

CTOR_INITIALIZER

static final DiagnosticType CTOR_INITIALIZER

IFACE_INITIALIZER

static final DiagnosticType IFACE_INITIALIZER

CONSTRUCTOR_EXPECTED

static final DiagnosticType CONSTRUCTOR_EXPECTED

UNKNOWN_LENDS

static final DiagnosticType UNKNOWN_LENDS

LENDS_ON_NON_OBJECT

static final DiagnosticType LENDS_ON_NON_OBJECT

ALL_DIAGNOSTICS

static final DiagnosticGroup ALL_DIAGNOSTICS

compiler

private final AbstractCompiler compiler

typeParsingErrorReporter

private final ErrorReporter typeParsingErrorReporter

validator

private final TypeValidator validator

codingConvention

private final CodingConvention codingConvention

typeRegistry

private final JSTypeRegistry typeRegistry

delegateProxyPrototypes

private final java.util.List<ObjectType> delegateProxyPrototypes

delegateCallingConventions

private final java.util.Map<java.lang.String,java.lang.String> delegateCallingConventions

runsAfterNTI

private final boolean runsAfterNTI

functionAnalysisResults

private final java.util.Map<Node,FunctionTypeBuilder.AstFunctionContents> functionAnalysisResults

unknownType

private final ObjectType unknownType

Constructor Detail

TypedScopeCreator

TypedScopeCreator(AbstractCompiler compiler)

TypedScopeCreator

TypedScopeCreator(AbstractCompiler compiler,
                  CodingConvention codingConvention)

Method Detail

report

private void report(JSError error)

createScope

public TypedScope createScope(Node root,
                              Scope parent)

Creates a scope with all types declared. Declares newly discovered types and type properties in the type registry.

Specified by:

createScope in interface ScopeCreator

Parameters:

root - the root node (either a FUNCTION node, a SCRIPT node, or a synthetic block node whose children are all SCRIPT nodes)

parent - the parent Scope object (may be null)

patchGlobalScope

void patchGlobalScope(TypedScope globalScope,
                      Node scriptRoot)

Patches a given global scope by removing variables previously declared in a script and re-traversing a new version of that script.

Parameters:

globalScope - The global scope generated by createScope.

scriptRoot - The script that is modified.

createInitialScope

TypedScope createInitialScope(Node root)

Create the outermost scope. This scope contains native binding such as Object, Date, etc.

declareNativeFunctionType

private void declareNativeFunctionType(TypedScope scope,
                                       JSTypeNative tId)

declareNativeValueType

private void declareNativeValueType(TypedScope scope,
                                    java.lang.String name,
                                    JSTypeNative tId)

declareNativeType

private static void declareNativeType(TypedScope scope,
                                      java.lang.String name,
                                      JSType t)

getNativeType

private JSType getNativeType(JSTypeNative nativeType)

getFunctionAnalysisResults

private FunctionTypeBuilder.AstFunctionContents getFunctionAnalysisResults(@Nullable
                                                                           Node n)

hasBlockScope

public boolean hasBlockScope()

Specified by:

hasBlockScope in interface ScopeCreator