@NonNullByDefault public abstract class AbstractTypeComputationState extends java.lang.Object implements ITypeComputationState
Modifier and Type | Field and Description |
---|---|
protected ResolvedTypes |
resolvedTypes |
Modifier | Constructor and Description |
---|---|
protected |
AbstractTypeComputationState(ResolvedTypes resolvedTypes,
IFeatureScopeSession featureScopeSession) |
Modifier and Type | Method and Description |
---|---|
void |
acceptActualType(LightweightTypeReference type)
Annotates the currently considered expression(s) with the given type.
|
void |
acceptActualType(LightweightTypeReference type,
ConformanceHint... hints)
Annotates the currently considered expression(s) with the given type.
|
protected abstract LightweightTypeReference |
acceptType(ResolvedTypes types,
AbstractTypeExpectation expectation,
LightweightTypeReference type,
boolean returnType,
ConformanceHint... conformanceHint) |
protected abstract LightweightTypeReference |
acceptType(XExpression alreadyHandled,
ResolvedTypes types,
AbstractTypeExpectation expectation,
LightweightTypeReference type,
boolean returnType,
ConformanceHint... conformanceHint) |
void |
addDiagnostic(AbstractDiagnostic diagnostic) |
void |
addExtensionsToCurrentScope(java.util.List<? extends JvmIdentifiableElement> extensionProviders)
Adds the given elements as extension providers to the current scope.
|
void |
addExtensionToCurrentScope(JvmIdentifiableElement extensionProvider)
Adds the given element as an extension provider to the current scope.
|
void |
addLocalToCurrentScope(JvmIdentifiableElement element)
Adds the given element as a local variable.
|
protected void |
addLocalToCurrentScope(QualifiedName elementName,
JvmIdentifiableElement element,
boolean raiseIssueIfShadowing) |
void |
addTypeToStaticImportScope(JvmDeclaredType type)
Adds the given type to the static scope.
|
AbstractTypeComputationState |
assignType(JvmIdentifiableElement element,
LightweightTypeReference type)
Assigns the type to the given element and makes the element available in the scope.
|
AbstractTypeComputationState |
assignType(JvmIdentifiableElement element,
LightweightTypeReference type,
boolean addToChildScope)
Assigns the given type to the given element and optionally adds the element to the scope.
|
void |
assignType(QualifiedName name,
JvmType rawType,
LightweightTypeReference actualType)
Assigns the given actual type to the raw type which shall be reachable with the given name.
|
TypeAssigner |
assignTypes()
Obtain a new
ITypeAssigner that allows to add a bulk of elements to this computation state. |
ITypeComputationResult |
computeTypes(XExpression expression)
Triggers type computation for a child expression of the currently considered expression.
|
protected IFeatureLinkingCandidate |
createCandidate(XAbstractFeatureCall featureCall,
StackedResolvedTypes demandComputedTypes,
IIdentifiableElementDescription description) |
protected IConstructorLinkingCandidate |
createCandidate(XConstructorCall constructorCall,
IIdentifiableElementDescription description) |
protected IFeatureLinkingCandidate |
createCandidateWithReceiverType(XAbstractFeatureCall featureCall,
StackedResolvedTypes demandComputedTypes,
IIdentifiableElementDescription description) |
protected ExpressionTypeComputationState |
createExpressionComputationState(XExpression expression,
StackedResolvedTypes typeResolution) |
protected IFeatureLinkingCandidate |
createResolvedLink(XAbstractFeatureCall featureCall,
JvmIdentifiableElement resolvedTo) |
protected IConstructorLinkingCandidate |
createResolvedLink(XConstructorCall constructorCall,
JvmConstructor resolvedTo) |
protected TypeAssigner |
createTypeAssigner(AbstractTypeComputationState state) |
UnboundTypeReference |
createUnboundTypeReference(XExpression expression,
JvmTypeParameter typeParameter)
Create a new, managed
UnboundTypeReference for the given type parameter which was
first encountered for the given expression. |
void |
discardReassignedTypes(JvmIdentifiableElement refinable)
A reassigned type may become obsolete due to assignments.
|
protected ExpressionAwareStackedResolvedTypes |
doComputeTypes(XExpression expression) |
OwnedConverter |
getConverter()
Provides access to a configured
converter . |
java.util.List<? extends ITypeExpectation> |
getExpectations()
The result is never empty.
|
protected abstract java.util.List<AbstractTypeExpectation> |
getExpectations(AbstractTypeComputationState actualState) |
java.util.List<LightweightTypeReference> |
getExpectedExceptions() |
protected IFeatureScopeSession |
getFeatureScopeSession() |
java.util.List<IFeatureLinkingCandidate> |
getLinkingCandidates(XAbstractFeatureCall featureCall)
The result is never empty.
|
java.util.List<IConstructorLinkingCandidate> |
getLinkingCandidates(XConstructorCall constructorCall)
The result is never empty.
|
ITypeReferenceOwner |
getReferenceOwner()
The current type reference owner for newly converted type references.
|
protected ResolvedTypes |
getResolvedTypes() |
protected DefaultReentrantTypeResolver |
getResolver() |
protected java.util.List<? extends ITypeExpectation> |
getReturnExpectations() |
protected abstract java.util.List<AbstractTypeExpectation> |
getReturnExpectations(AbstractTypeComputationState actualState,
boolean asActualExpectation) |
protected IssueSeverities |
getSeverities() |
Severity |
getSeverity(java.lang.String issueCode) |
protected ITypeExpectation |
getSingleExpectation(ITypeComputationState state) |
protected ITypeComputer |
getTypeComputer() |
protected TypeReferences |
getTypeReferences() |
boolean |
isIgnored(java.lang.String issueCode) |
protected ExpressionAwareStackedResolvedTypes |
pushTypes(XExpression expression) |
void |
reassignType(JvmIdentifiableElement refinable,
LightweightTypeReference type)
Allows to specialize the known type of an identifiable, that was already annotated
with a type.
|
void |
refineExpectedType(XExpression expression,
LightweightTypeReference expectation)
After the fact refinement of the expected type.
|
protected IIdentifiableElementDescription |
toIdentifiableDescription(IEObjectDescription description) |
java.lang.String |
toString() |
TypeComputationStateWithExpectation |
withExpectation(LightweightTypeReference expectation)
The given expectation will be resolved if it contains unresolved type
arguments, e.g. an operation that declares two parameters of the very
same type argument will yield a more detailed expectation if possible.
|
AbstractTypeComputationState |
withExpectedExceptions(java.util.List<LightweightTypeReference> declaredExceptionTypes) |
AbstractTypeComputationState |
withNonVoidExpectation()
Keep the current return expectation and assume an actual expectation that is not void.
|
protected AbstractTypeComputationState |
withNonVoidExpectation(ResolvedTypes resolvedTypes) |
AbstractTypeComputationState |
withoutExpectation()
Keeps the return type expectation.
|
TypeComputationStateWithRootExpectation |
withoutRootExpectation()
The outer context is ignored for child expressions and the newly produced context
does not impose any restrictions on the expectation.
|
AbstractTypeComputationState |
withReturnExpectation()
Transfers the available return type expectation to the actual expectation of this
computation step.
|
TypeComputationStateWithRootExpectation |
withRootExpectation(LightweightTypeReference expectation)
The given expectation becomes the expected return type and the expected type for
the current context.
|
TypeCheckpointComputationState |
withTypeCheckpoint(org.eclipse.emf.ecore.EObject context)
A type checkpoint allows to re-specify the type of an identifiable that was already
type-computed.
|
protected final ResolvedTypes resolvedTypes
protected AbstractTypeComputationState(ResolvedTypes resolvedTypes, IFeatureScopeSession featureScopeSession)
protected ResolvedTypes getResolvedTypes()
protected IFeatureScopeSession getFeatureScopeSession()
protected TypeReferences getTypeReferences()
protected ITypeComputer getTypeComputer()
protected DefaultReentrantTypeResolver getResolver()
protected abstract LightweightTypeReference acceptType(ResolvedTypes types, AbstractTypeExpectation expectation, LightweightTypeReference type, boolean returnType, ConformanceHint... conformanceHint)
protected abstract LightweightTypeReference acceptType(XExpression alreadyHandled, ResolvedTypes types, AbstractTypeExpectation expectation, LightweightTypeReference type, boolean returnType, ConformanceHint... conformanceHint)
public final ITypeComputationResult computeTypes(@Nullable XExpression expression)
ITypeComputationState
computeTypes
in interface ITypeComputationState
protected ExpressionAwareStackedResolvedTypes doComputeTypes(XExpression expression)
protected ExpressionAwareStackedResolvedTypes pushTypes(XExpression expression)
protected ExpressionTypeComputationState createExpressionComputationState(XExpression expression, StackedResolvedTypes typeResolution)
public TypeComputationStateWithExpectation withExpectation(@Nullable LightweightTypeReference expectation)
ITypeComputationState
<T> T foo(T, T)
with
foo<String>(null, 'string')
will allow to pass the unresolved T
as expectation
where clients would be invoked with the better candidate 'string'.withExpectation
in interface ITypeComputationState
public void refineExpectedType(XExpression expression, LightweightTypeReference expectation)
ITypeComputationState
for(double d: produceIntArray) { }Expressions are resolved in the context of an expected type, which may or may not exist (e.g. it may be
null
).
The expectation for the call to produceIntArray
is double[]
.
However, the method returns an array of int. The tricky part is, that an int[]
is not assignable to a double[]
which would lead to incompatible types. Nevertheless,
the expression is valid, since the component type is relevant for the compatibility
in the context of a for-loop. Therefore, the expectation is refined after the fact to
int[]
because the conformance could be validated.refineExpectedType
in interface ITypeComputationState
public TypeComputationStateWithRootExpectation withRootExpectation(@Nullable LightweightTypeReference expectation)
ITypeComputationState
withRootExpectation
in interface ITypeComputationState
public TypeComputationStateWithRootExpectation withoutRootExpectation()
ITypeComputationState
withoutRootExpectation
in interface ITypeComputationState
public AbstractTypeComputationState withNonVoidExpectation()
ITypeComputationState
val x = someExpressionThe expectation for the call to
someExpression
is anything but void
.withNonVoidExpectation
in interface ITypeComputationState
protected AbstractTypeComputationState withNonVoidExpectation(ResolvedTypes resolvedTypes)
public AbstractTypeComputationState withReturnExpectation()
ITypeComputationState
op someMethod: String { return someExpression }The actual expectation of the child
someExpression
is the return expectation
in that context, e.g. java.lang.String
in the given example.withReturnExpectation
in interface ITypeComputationState
public AbstractTypeComputationState withoutExpectation()
ITypeComputationState
{ someExpression subsequent }The expectation for the call to
someExpression
does not have any actual expectations.withoutExpectation
in interface ITypeComputationState
public TypeCheckpointComputationState withTypeCheckpoint(@Nullable org.eclipse.emf.ecore.EObject context)
ITypeComputationState
withTypeCheckpoint
in interface ITypeComputationState
context
- an indicator that describes the context of this type checkpoint, e.g. an XCasePart
.public AbstractTypeComputationState withExpectedExceptions(java.util.List<LightweightTypeReference> declaredExceptionTypes)
withExpectedExceptions
in interface ITypeComputationState
public AbstractTypeComputationState assignType(JvmIdentifiableElement element, @Nullable LightweightTypeReference type)
ITypeComputationState
assignType(element, type, true)
.
Each element may only be typed once.assignType
in interface ITypeComputationState
element
- the identifiable that will be annotated with the given type.type
- the type of the element. null
or other invalid types will be treated as error types.ITypeComputationState.assignType(JvmIdentifiableElement, LightweightTypeReference, boolean)
,
ITypeComputationState.addLocalToCurrentScope(JvmIdentifiableElement)
,
ITypeComputationState.assignTypes()
,
ITypeAssigner
public AbstractTypeComputationState assignType(JvmIdentifiableElement element, @Nullable LightweightTypeReference type, boolean addToChildScope)
ITypeComputationState
assignType
in interface ITypeComputationState
element
- the identifiable that will be annotated with the given type.type
- the type of the element. null
or other invalid types will be treated as error types.addToChildScope
- true
if the element should be added to the child scope, false
if only the type
information should be recorded.ITypeAssigner
,
ITypeComputationState.assignTypes()
,
ITypeComputationState.addLocalToCurrentScope(JvmIdentifiableElement)
public void addLocalToCurrentScope(JvmIdentifiableElement element)
ITypeComputationState
addLocalToCurrentScope
in interface ITypeComputationState
element
- the newly added element (e.g. a variable
or parameter
.FeatureNameValidator
public void addExtensionToCurrentScope(JvmIdentifiableElement extensionProvider)
ITypeComputationState
addExtensionToCurrentScope
in interface ITypeComputationState
extensionProvider
- the identifiable that points to the extension providerpublic void addTypeToStaticImportScope(JvmDeclaredType type)
ITypeComputationState
addTypeToStaticImportScope
in interface ITypeComputationState
type
- the type that is added to the static scope.public void addExtensionsToCurrentScope(java.util.List<? extends JvmIdentifiableElement> extensionProviders)
ITypeComputationState
addExtensionsToCurrentScope
in interface ITypeComputationState
extensionProviders
- the identifiables that contribute to the extension scopeprotected void addLocalToCurrentScope(QualifiedName elementName, JvmIdentifiableElement element, boolean raiseIssueIfShadowing)
public void assignType(QualifiedName name, JvmType rawType, LightweightTypeReference actualType)
ITypeComputationState
assignType(IFeatureNames.SELF, 'java.util.Comparator', 'java.util.Comparator<String>');
assignType
in interface ITypeComputationState
name
- the name of the feature that should point to the given type, e.g. IFeatureNames.THIS
rawType
- the type that declares the context of the expression.actualType
- the context type with bound type arguments (possibly unresolved).public TypeAssigner assignTypes()
ITypeComputationState
ITypeAssigner
that allows to add a bulk of elements
to this computation state.assignTypes
in interface ITypeComputationState
public void addDiagnostic(AbstractDiagnostic diagnostic)
addDiagnostic
in interface ITypeComputationState
protected TypeAssigner createTypeAssigner(AbstractTypeComputationState state)
public final java.util.List<? extends ITypeExpectation> getExpectations()
ITypeComputationState
getExpectations
in interface ITypeComputationState
protected final java.util.List<? extends ITypeExpectation> getReturnExpectations()
protected abstract java.util.List<AbstractTypeExpectation> getExpectations(AbstractTypeComputationState actualState)
protected abstract java.util.List<AbstractTypeExpectation> getReturnExpectations(AbstractTypeComputationState actualState, boolean asActualExpectation)
public void acceptActualType(LightweightTypeReference type)
ITypeComputationState
acceptActualType
in interface ITypeComputationState
public void acceptActualType(LightweightTypeReference type, ConformanceHint... hints)
ITypeComputationState
acceptActualType
in interface ITypeComputationState
public void reassignType(JvmIdentifiableElement refinable, LightweightTypeReference type)
ITypeComputationState
local variables
.
It's the clients responsibility to decide about that.
Example:
val Object x = obtainInstance if (x instanceof String && x.length > 0) { x.substring(1) }The instanceof expression may refine the type for subsequent expressions, e.g. in boolean conditions or blocks.
reassignType
in interface ITypeComputationState
public void discardReassignedTypes(JvmIdentifiableElement refinable)
ITypeComputationState
var node = someNode; while(node instanceof ContainerNode) { node = node.container node.container // type error }After the assignment in the while loop, the node is no longer considered to be a ContainerNode.
discardReassignedTypes
in interface ITypeComputationState
public java.util.List<IFeatureLinkingCandidate> getLinkingCandidates(XAbstractFeatureCall featureCall)
ITypeComputationState
getLinkingCandidates
in interface ITypeComputationState
protected IFeatureLinkingCandidate createResolvedLink(XAbstractFeatureCall featureCall, JvmIdentifiableElement resolvedTo)
protected IFeatureLinkingCandidate createCandidate(XAbstractFeatureCall featureCall, StackedResolvedTypes demandComputedTypes, IIdentifiableElementDescription description)
protected ITypeExpectation getSingleExpectation(ITypeComputationState state)
protected IFeatureLinkingCandidate createCandidateWithReceiverType(XAbstractFeatureCall featureCall, StackedResolvedTypes demandComputedTypes, IIdentifiableElementDescription description)
public java.util.List<IConstructorLinkingCandidate> getLinkingCandidates(XConstructorCall constructorCall)
ITypeComputationState
getLinkingCandidates
in interface ITypeComputationState
protected IIdentifiableElementDescription toIdentifiableDescription(IEObjectDescription description)
protected IConstructorLinkingCandidate createResolvedLink(XConstructorCall constructorCall, JvmConstructor resolvedTo)
protected IConstructorLinkingCandidate createCandidate(XConstructorCall constructorCall, IIdentifiableElementDescription description)
public java.lang.String toString()
toString
in class java.lang.Object
public ITypeReferenceOwner getReferenceOwner()
ITypeComputationState
getReferenceOwner
in interface ITypeComputationState
public UnboundTypeReference createUnboundTypeReference(XExpression expression, JvmTypeParameter typeParameter)
ITypeComputationState
UnboundTypeReference
for the given type parameter which was
first encountered for the given expression.createUnboundTypeReference
in interface ITypeComputationState
expression
- the expression that used / referenced the type parametertypeParameter
- the type parameterpublic OwnedConverter getConverter()
ITypeComputationState
converter
.getConverter
in interface ITypeComputationState
public java.util.List<LightweightTypeReference> getExpectedExceptions()
getExpectedExceptions
in interface ITypeComputationState
protected IssueSeverities getSeverities()
public Severity getSeverity(java.lang.String issueCode)
getSeverity
in interface ITypeComputationState
public boolean isIgnored(java.lang.String issueCode)
isIgnored
in interface ITypeComputationState