public class JSTypeRegistry extends java.lang.Object implements TypeIRegistry
This class is not thread-safe.
| Modifier and Type | Class and Description |
|---|---|
static class |
JSTypeRegistry.PropDefinitionKind
A tristate value returned from canPropertyBeDefined.
|
| Modifier and Type | Field and Description |
|---|---|
static java.lang.String |
OBJECT_ELEMENT_TEMPLATE
Deprecated.
|
| Constructor and Description |
|---|
JSTypeRegistry(ErrorReporter reporter) |
JSTypeRegistry(ErrorReporter reporter,
java.util.Set<java.lang.String> forwardDeclaredTypes)
Constructs a new type registry populated with the built-in types.
|
| Modifier and Type | Method and Description |
|---|---|
JSType |
buildRecordTypeFromObject(ObjectTypeI obj) |
JSTypeRegistry.PropDefinitionKind |
canPropertyBeDefined(JSType type,
java.lang.String propertyName)
Returns whether the given property can possibly be set on the given type.
|
void |
clearNamedTypes()
Flushes out the current resolved and unresolved Named Types from
the type registry.
|
void |
clearTemplateTypeNames()
Clears the template type name.
|
ObjectType |
createAnonymousObjectType(JSDocInfo info)
Create an anonymous object type.
|
FunctionType |
createConstructorType(java.lang.String name,
Node source,
Node parameters,
JSType returnType,
com.google.common.collect.ImmutableList<TemplateType> templateKeys,
boolean isAbstract)
Creates a constructor function type.
|
JSType |
createDefaultObjectUnion(JSType type)
Creates a type representing nullable values of the given type.
|
EnumType |
createEnumType(java.lang.String name,
Node source,
JSType elementsType)
Creates an enum type.
|
FunctionType |
createFunctionType(JSType returnType,
JSType... parameterTypes)
Creates a function type.
|
FunctionType |
createFunctionType(JSType returnType,
Node parameters) |
JSType |
createFunctionTypeWithInstanceType(ObjectType instanceType,
JSType returnType,
java.util.List<JSType> parameterTypes)
Creates a function type in which
this refers to an object instance. |
FunctionType |
createFunctionTypeWithNewReturnType(FunctionType existingFunctionType,
JSType returnType)
Creates a new function type based on an existing function type but
with a new return type.
|
FunctionType |
createFunctionTypeWithVarArgs(JSType returnType,
JSType... parameterTypes)
Creates a function type.
|
java.lang.String |
createGetterPropName(java.lang.String originalPropName)
For NTI, this method returns an obfuscated name that represents the getter.
|
FunctionType |
createInterfaceType(java.lang.String name,
Node source,
com.google.common.collect.ImmutableList<TemplateType> templateKeys,
boolean struct)
Creates an interface function type.
|
NamedType |
createNamedType(StaticTypedScope<JSType> scope,
java.lang.String reference,
java.lang.String sourceName,
int lineno,
int charno)
Creates a named type.
|
JSType |
createNullableType(JSType type)
Creates a type representing nullable values of the given type.
|
ObjectType |
createObjectType(java.lang.String name,
ObjectType implicitPrototype)
Create an object type.
|
JSType |
createOptionalNullableType(JSType type)
Creates a nullable and undefine-able value of the given type.
|
Node |
createOptionalParameters(JSType... parameterTypes)
Creates a tree hierarchy representing a typed parameter list in which
every parameter is optional.
|
JSType |
createOptionalType(JSType type)
Creates a type representing optional values of the given type.
|
Node |
createParameters(JSType... parameterTypes)
Creates a tree hierarchy representing a typed argument list.
|
Node |
createParametersWithVarArgs(JSType... parameterTypes)
Creates a tree hierarchy representing a typed argument list.
|
JSType |
createRecordType(java.util.Map<java.lang.String,? extends TypeI> props)
Creates an anonymous structural type with the given properties.
|
java.lang.String |
createSetterPropName(java.lang.String originalPropName)
For NTI, this method returns an obfuscated name that represents the setter.
|
TemplateType |
createTemplateType(java.lang.String name) |
TemplateTypeMap |
createTemplateTypeMap(com.google.common.collect.ImmutableList<TemplateType> templateKeys,
com.google.common.collect.ImmutableList<JSType> templateValues)
Creates a template type map from the specified list of template keys and
template value types.
|
TemplateType |
createTemplateTypeWithTransformation(java.lang.String name,
Node expr) |
TemplatizedType |
createTemplatizedType(ObjectType baseType,
com.google.common.collect.ImmutableList<JSType> templatizedTypes)
Creates a templatized instance of the specified type.
|
TemplatizedType |
createTemplatizedType(ObjectType baseType,
JSType... templatizedTypes)
Creates a templatized instance of the specified type.
|
TemplatizedType |
createTemplatizedType(ObjectType baseType,
java.util.Map<TemplateType,JSType> templatizedTypes)
Creates a templatized instance of the specified type.
|
JSType |
createTypeFromCommentNode(Node n) |
JSType |
createTypeFromCommentNode(Node n,
java.lang.String sourceName,
StaticTypedScope<? extends TypeI> scope)
Creates a JSType from the nodes representing a type.
|
JSType |
createUnionType(JSType... variants)
Creates a union type whose variants are the arguments.
|
JSType |
createUnionType(JSTypeNative... variants)
Creates a union type whose variants are the built-in types specified
by the arguments.
|
JSType |
createUnionType(java.util.List<? extends TypeI> variants) |
boolean |
declareType(StaticScope scope,
java.lang.String name,
JSType type)
Records declared global type names.
|
boolean |
declareTypeForExactScope(StaticScope scope,
java.lang.String name,
JSType type)
Records declared global type names.
|
JSType |
evaluateTypeExpression(JSTypeExpression expr,
TypeIEnv<TypeI> scope) |
JSType |
evaluateTypeExpressionInGlobalScope(JSTypeExpression expr) |
java.util.Collection<FunctionTypeI> |
getDirectImplementors(ObjectType interfaceInstance)
Returns a collection of types that directly implement
interfaceInstance. |
java.lang.Iterable<ObjectType> |
getEachReferenceTypeWithProperty(java.lang.String propertyName)
Returns each reference type that has a property
propertyName
defined on it. |
ErrorReporter |
getErrorReporter() |
JSType |
getGlobalType(java.lang.String jsTypeName)
Returns the type represented by typeName or null if not found.
|
JSType |
getGreatestSubtypeWithProperty(JSType type,
java.lang.String propertyName)
Gets the greatest subtype of the
type that has a property
propertyName defined on it. |
TemplateType |
getIterableTemplate() |
TemplateType |
getIteratorTemplate() |
FunctionType |
getNativeFunctionType(JSTypeNative typeId) |
ObjectType |
getNativeObjectType(JSTypeNative typeId) |
JSType |
getNativeType(JSTypeNative typeId) |
TemplateType |
getObjectElementKey() |
TemplateType |
getObjectIndexKey() |
java.lang.String |
getReadableTypeName(Node n)
The nice API for this method is a single argument; dereference is a detail.
|
java.lang.String |
getReadableTypeNameNoDeref(Node n) |
TemplateType |
getThenableValueKey() |
JSType |
getType(StaticScope scope,
java.lang.String jsTypeName)
Looks up a native type by name.
|
JSType |
getType(StaticTypedScope<JSType> scope,
java.lang.String jsTypeName,
java.lang.String sourceName,
int lineno,
int charno)
Looks up a type by name.
|
JSType |
getTypeForScope(StaticScope scope,
java.lang.String jsTypeName)
Looks up a native type by name.
|
void |
identifyNonNullableName(java.lang.String name)
Identifies the name of a typedef or enum before we actually declare it.
|
ObjectTypeI |
instantiateGenericsWithUnknown(ObjectType obj) |
TypeI |
instantiateGenericType(ObjectTypeI genericType,
com.google.common.collect.ImmutableList<? extends TypeI> typeArgs)
Instantiates genericType using typeArgs.
|
boolean |
isForwardDeclaredType(java.lang.String name)
Whether this is a forward-declared type name.
|
com.google.common.collect.ImmutableList<TemplateType> |
maybeGetTemplateTypesOfBuiltin(java.lang.String fnName) |
void |
overwriteDeclaredType(StaticScope scope,
java.lang.String name,
JSType type)
Overrides a declared global type name.
|
void |
overwriteDeclaredType(java.lang.String name,
JSType type)
Overrides a declared global type name.
|
void |
registerPropertyOnType(java.lang.String propertyName,
JSType type)
Tells the type system that
owner may have a property named
propertyName. |
void |
removeType(StaticScope scope,
java.lang.String name)
Removes a type by name.
|
void |
resetForTypeCheck()
Reset to run the TypeCheck pass.
|
void |
resetImplicitPrototype(JSType type,
ObjectType newImplicitProto)
Set the implicit prototype if it's possible to do so.
|
void |
resolveTypesInScope(StaticTypedScope<JSType> scope)
Resolve all the unresolved types in the given scope.
|
void |
restoreContents(java.io.ObjectInputStream in)
Restores the derived state.
|
void |
saveContents(java.io.ObjectOutputStream out)
Saves the derived state.
|
void |
setTemplateTypeNames(java.util.List<TemplateType> keys)
Sets the template type name.
|
void |
unregisterPropertyOnType(java.lang.String propertyName,
JSType type)
Removes the index's reference to a property on the given type (if it is
currently registered).
|
@Deprecated public static final java.lang.String OBJECT_ELEMENT_TEMPLATE
public JSTypeRegistry(ErrorReporter reporter)
public JSTypeRegistry(ErrorReporter reporter, java.util.Set<java.lang.String> forwardDeclaredTypes)
public TemplateType getObjectElementKey()
public TemplateType getObjectIndexKey()
public TemplateType getThenableValueKey()
public TemplateType getIterableTemplate()
public TemplateType getIteratorTemplate()
public com.google.common.collect.ImmutableList<TemplateType> maybeGetTemplateTypesOfBuiltin(java.lang.String fnName)
public ErrorReporter getErrorReporter()
public void resetForTypeCheck()
public void removeType(StaticScope scope, java.lang.String name)
name - The name string.public void registerPropertyOnType(java.lang.String propertyName,
JSType type)
owner may have a property named
propertyName. This allows the registry to keep track of what
types a property is defined upon.
This is NOT the same as saying that owner must have a property
named type. ObjectType#hasProperty attempts to minimize false positives
("if we're not sure, then don't type check this property"). The type
registry, on the other hand, should attempt to minimize false negatives
("if this property is assigned anywhere in the program, it must
show up in the type registry").public void unregisterPropertyOnType(java.lang.String propertyName,
JSType type)
propertyName - the name of the property to unregistertype - the type to unregister the property on.public JSType getGreatestSubtypeWithProperty(JSType type, java.lang.String propertyName)
type that has a property
propertyName defined on it.public JSTypeRegistry.PropDefinitionKind canPropertyBeDefined(JSType type, java.lang.String propertyName)
public java.lang.Iterable<ObjectType> getEachReferenceTypeWithProperty(java.lang.String propertyName)
propertyName
defined on it.
Unlike most types in our type system, the collection of types returned
will not be collapsed. This means that if a type is defined on
Object and on Array, this method must return
[Object, Array]. It would not be correct to collapse them to
[Object].public java.util.Collection<FunctionTypeI> getDirectImplementors(ObjectType interfaceInstance)
interfaceInstance. Subtypes of implementing types are not guaranteed to
be returned. interfaceInstance must be an ObjectType for the
instance of the interface.public boolean declareType(StaticScope scope, java.lang.String name, JSType type)
name - The name of the type to be recorded.type - The actual type being associated with the name.public boolean declareTypeForExactScope(StaticScope scope, java.lang.String name, JSType type)
name - The name of the type to be recorded.type - The actual type being associated with the name.public void overwriteDeclaredType(java.lang.String name,
JSType type)
public void overwriteDeclaredType(StaticScope scope, java.lang.String name, JSType type)
public boolean isForwardDeclaredType(java.lang.String name)
public java.lang.String getReadableTypeName(Node n)
getReadableTypeName in interface TypeIRegistrypublic java.lang.String getReadableTypeNameNoDeref(Node n)
public java.lang.String createGetterPropName(java.lang.String originalPropName)
TypeIRegistrycreateGetterPropName in interface TypeIRegistrypublic java.lang.String createSetterPropName(java.lang.String originalPropName)
TypeIRegistrycreateSetterPropName in interface TypeIRegistrypublic JSType getTypeForScope(StaticScope scope, java.lang.String jsTypeName)
jsTypeName - The name string.null it cannot be foundpublic JSType getGlobalType(java.lang.String jsTypeName)
TypeIRegistrygetGlobalType in interface TypeIRegistrypublic JSType getType(StaticScope scope, java.lang.String jsTypeName)
getType in interface TypeIRegistryjsTypeName - The name string.null it cannot be foundpublic JSType getType(StaticTypedScope<JSType> scope, java.lang.String jsTypeName, java.lang.String sourceName, int lineno, int charno)
scope - A scope for doing type name resolution.jsTypeName - The name string.sourceName - The name of the source file where this reference appears.lineno - The line number of the reference.public JSType getNativeType(JSTypeNative typeId)
getNativeType in interface TypeIRegistrypublic ObjectType getNativeObjectType(JSTypeNative typeId)
getNativeObjectType in interface TypeIRegistrypublic FunctionType getNativeFunctionType(JSTypeNative typeId)
getNativeFunctionType in interface TypeIRegistrypublic void clearNamedTypes()
public void resolveTypesInScope(StaticTypedScope<JSType> scope)
public JSType evaluateTypeExpressionInGlobalScope(JSTypeExpression expr)
evaluateTypeExpressionInGlobalScope in interface TypeIRegistrypublic JSType createOptionalType(JSType type)
public JSType createDefaultObjectUnion(JSType type)
public JSType createNullableType(JSType type)
public JSType createOptionalNullableType(JSType type)
public JSType createUnionType(JSType... variants)
public JSType createUnionType(java.util.List<? extends TypeI> variants)
createUnionType in interface TypeIRegistrypublic JSType createUnionType(JSTypeNative... variants)
public EnumType createEnumType(java.lang.String name, Node source, JSType elementsType)
public FunctionType createFunctionType(JSType returnType, JSType... parameterTypes)
returnType - the function's return typeparameterTypes - the parameters' typespublic FunctionType createFunctionType(JSType returnType, Node parameters)
parameters - the function's parameters or null to indicate that the parameter
types are unknown.returnType - the function's return type or null to indicate that the return type
is unknown.public FunctionType createFunctionTypeWithVarArgs(JSType returnType, JSType... parameterTypes)
returnType - the function's return typeparameterTypes - the parameters' typespublic JSType createFunctionTypeWithInstanceType(ObjectType instanceType, JSType returnType, java.util.List<JSType> parameterTypes)
this refers to an object instance.instanceType - the type of thisreturnType - the function's return typeparameterTypes - the parameters' typespublic Node createParameters(JSType... parameterTypes)
parameterTypes - the parameter types.public Node createParametersWithVarArgs(JSType... parameterTypes)
parameterTypes - the parameter types. The last element of this array
is considered a variable length argument.public Node createOptionalParameters(JSType... parameterTypes)
public FunctionType createFunctionTypeWithNewReturnType(FunctionType existingFunctionType, JSType returnType)
existingFunctionType - the existing function type.returnType - the new return type.public JSType buildRecordTypeFromObject(ObjectTypeI obj)
buildRecordTypeFromObject in interface TypeIRegistrypublic JSType createRecordType(java.util.Map<java.lang.String,? extends TypeI> props)
TypeIRegistrycreateRecordType in interface TypeIRegistrypublic ObjectType createObjectType(java.lang.String name, ObjectType implicitPrototype)
public ObjectType createAnonymousObjectType(JSDocInfo info)
info - Used to mark object literals as structs; can be nullpublic void resetImplicitPrototype(JSType type, ObjectType newImplicitProto)
public FunctionType createConstructorType(java.lang.String name, Node source, Node parameters, JSType returnType, com.google.common.collect.ImmutableList<TemplateType> templateKeys, boolean isAbstract)
name - the function's name or null to indicate that the function is anonymous.source - the node defining this function. Its type (Node.getToken() ()}) must be
Token.FUNCTION.parameters - the function's parameters or null to indicate that the parameter
types are unknown.returnType - the function's return type or null to indicate that the return type
is unknown.templateKeys - the templatized types for the class.isAbstract - whether the function type represents an abstract classpublic FunctionType createInterfaceType(java.lang.String name, Node source, com.google.common.collect.ImmutableList<TemplateType> templateKeys, boolean struct)
name - the function's namesource - the node defining this function. Its type (Node.getToken()) must be
Token.FUNCTION.templateKeys - the templatized types for the interface.public TemplateType createTemplateType(java.lang.String name)
public TemplateType createTemplateTypeWithTransformation(java.lang.String name, Node expr)
public TemplateTypeMap createTemplateTypeMap(com.google.common.collect.ImmutableList<TemplateType> templateKeys, com.google.common.collect.ImmutableList<JSType> templateValues)
public ObjectTypeI instantiateGenericsWithUnknown(ObjectType obj)
public TypeI instantiateGenericType(ObjectTypeI genericType, com.google.common.collect.ImmutableList<? extends TypeI> typeArgs)
TypeIRegistryinstantiateGenericType in interface TypeIRegistrypublic TemplatizedType createTemplatizedType(ObjectType baseType, com.google.common.collect.ImmutableList<JSType> templatizedTypes)
baseType - the type to be templatized.templatizedTypes - a list of the template JSTypes. Will be matched by
list order to the template keys on the base type.public TemplatizedType createTemplatizedType(ObjectType baseType, java.util.Map<TemplateType,JSType> templatizedTypes)
baseType - the type to be templatized.templatizedTypes - a map from TemplateType to corresponding JSType
value. Any unfilled TemplateTypes on the baseType that are *not*
contained in this map will have UNKNOWN_TYPE used as their value.public TemplatizedType createTemplatizedType(ObjectType baseType, JSType... templatizedTypes)
baseType - the type to be templatized.templatizedTypes - a list of the template JSTypes. Will be matched by
list order to the template keys on the base type.public NamedType createNamedType(StaticTypedScope<JSType> scope, java.lang.String reference, java.lang.String sourceName, int lineno, int charno)
public void identifyNonNullableName(java.lang.String name)
public JSType evaluateTypeExpression(JSTypeExpression expr, TypeIEnv<TypeI> scope)
evaluateTypeExpression in interface TypeIRegistrypublic JSType createTypeFromCommentNode(Node n)
createTypeFromCommentNode in interface TypeIRegistrypublic JSType createTypeFromCommentNode(Node n, java.lang.String sourceName, StaticTypedScope<? extends TypeI> scope)
n - The node with type info.sourceName - The source file name.scope - A scope for doing type name lookups.public void setTemplateTypeNames(java.util.List<TemplateType> keys)
public void clearTemplateTypeNames()
@GwtIncompatible(value="ObjectOutputStream")
public void saveContents(java.io.ObjectOutputStream out)
throws java.io.IOException
java.io.IOException@GwtIncompatible(value="ObjectInputStream")
public void restoreContents(java.io.ObjectInputStream in)
throws java.io.IOException,
java.lang.ClassNotFoundException
java.io.IOExceptionjava.lang.ClassNotFoundExceptionCopyright © 2009-2018 Google. All Rights Reserved.