com.google.javascript.jscomp

Class GlobalTypeInfo

java.lang.Object

com.google.javascript.jscomp.GlobalTypeInfo

All Implemented Interfaces:

TypeIRegistry, Serializable

public class GlobalTypeInfo
extends Object
implements TypeIRegistry

Contains information about all scopes; for every variable reference computes whether it is local, a formal parameter, etc.; and computes information about the class hierarchy.

Used by the new type inference. See go/jscompiler-new-type-checker for the latest updates.

Author:

blickly@google.com (Ben Lickly), dimvar@google.com (Dimitris Vardoulakis)

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
TypeI	buildRecordTypeFromObject(ObjectTypeI obj)
String	createGetterPropName(String originalPropName) For NTI, this method returns an obfuscated name that represents the getter.
TypeI	createRecordType(Map<String,? extends TypeI> props) Creates an anonymous structural type with the given properties.
String	createSetterPropName(String originalPropName) For NTI, this method returns an obfuscated name that represents the setter.
TypeI	createTypeFromCommentNode(Node n)
TypeI	createUnionType(List<? extends TypeI> members)
TypeI	evaluateTypeExpression(JSTypeExpression expr, TypeIEnv<TypeI> typeEnv) This method is only called by TTL and the typeEnv passed is the global scope.
TypeI	evaluateTypeExpressionInGlobalScope(JSTypeExpression expr)
JSType	getNativeFunctionType(JSTypeNative typeId)
JSType	getNativeObjectType(JSTypeNative typeId)
JSType	getNativeType(JSTypeNative typeId)
String	getReadableTypeName(Node n)
JSType	getType(String typeName) Returns the type represented by typeName or null if not found.
JSTypeCreatorFromJSDoc	getTypeParser()
UniqueNameGenerator	getVarNameGen()
TypeI	instantiateGenericType(ObjectTypeI genericType, com.google.common.collect.ImmutableList<? extends TypeI> typeArgs) Instantiates genericType using typeArgs.

Methods inherited from class java.lang.Object

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

Method Detail

getTypeParser

public JSTypeCreatorFromJSDoc getTypeParser()

getVarNameGen

public UniqueNameGenerator getVarNameGen()

createTypeFromCommentNode

public TypeI createTypeFromCommentNode(Node n)

Specified by:

createTypeFromCommentNode in interface TypeIRegistry

getNativeFunctionType

public JSType getNativeFunctionType(JSTypeNative typeId)

Specified by:

getNativeFunctionType in interface TypeIRegistry

getNativeObjectType

public JSType getNativeObjectType(JSTypeNative typeId)

Specified by:

getNativeObjectType in interface TypeIRegistry

getNativeType

public JSType getNativeType(JSTypeNative typeId)

Specified by:

getNativeType in interface TypeIRegistry

getReadableTypeName

public String getReadableTypeName(Node n)

Specified by:

getReadableTypeName in interface TypeIRegistry

getType

public JSType getType(String typeName)

Description copied from interface: TypeIRegistry

Returns the type represented by typeName or null if not found. If you pass Foo to this method, and Foo can be an instance or a constructor, you get the Foo instance, in contrast to TypeIEnv#getNamespaceType, where you'd get the Foo constructor. If Foo is not a nominal type, returns the namespace type.

Specified by:

getType in interface TypeIRegistry

createGetterPropName

public String createGetterPropName(String originalPropName)

Description copied from interface: TypeIRegistry

For NTI, this method returns an obfuscated name that represents the getter. For OTI, the property name is unchanged.

Specified by:

createGetterPropName in interface TypeIRegistry

createSetterPropName

public String createSetterPropName(String originalPropName)

Description copied from interface: TypeIRegistry

For NTI, this method returns an obfuscated name that represents the setter. For OTI, the property name is unchanged. This method is a bit of a hack. In the future, NTI can handle getters/setters more gracefully by having a field in the Property class. See also: https://github.com/google/closure-compiler/issues/2545.

Specified by:

createSetterPropName in interface TypeIRegistry

createUnionType

public TypeI createUnionType(List<? extends TypeI> members)

Specified by:

createUnionType in interface TypeIRegistry

evaluateTypeExpression

public TypeI evaluateTypeExpression(JSTypeExpression expr,
                                    TypeIEnv<TypeI> typeEnv)

This method is only called by TTL and the typeEnv passed is the global scope. We ignore the typeEnv here because createTypeFromCommentNode already uses the global scope.

Specified by:

evaluateTypeExpression in interface TypeIRegistry

evaluateTypeExpressionInGlobalScope

public TypeI evaluateTypeExpressionInGlobalScope(JSTypeExpression expr)

Specified by:

evaluateTypeExpressionInGlobalScope in interface TypeIRegistry

createRecordType

public TypeI createRecordType(Map<String,? extends TypeI> props)

Description copied from interface: TypeIRegistry

Creates an anonymous structural type with the given properties.

Specified by:

createRecordType in interface TypeIRegistry

instantiateGenericType

public TypeI instantiateGenericType(ObjectTypeI genericType,
                                    com.google.common.collect.ImmutableList<? extends TypeI> typeArgs)

Description copied from interface: TypeIRegistry

Instantiates genericType using typeArgs. If genericType has fewer type variables than the number of typeArgs, we pad with unknown. If it has more, we drop the extra typeArgs. TODO(dimvar): fix the callers to pass the right number of typeArgs and throw here.

Specified by:

instantiateGenericType in interface TypeIRegistry

buildRecordTypeFromObject

public TypeI buildRecordTypeFromObject(ObjectTypeI obj)

Specified by:

buildRecordTypeFromObject in interface TypeIRegistry