Package org.eclipse.xtext.xbase.typesystem.internal

Class CompoundTypeComputationState

java.lang.Object

org.eclipse.xtext.xbase.typesystem.internal.CompoundTypeComputationState

All Implemented Interfaces:

ITypeComputationState

public class CompoundTypeComputationState
extends java.lang.Object
implements ITypeComputationState

Constructor Summary

Constructors

Constructor	Description
CompoundTypeComputationState(ITypeReferenceOwner owner, AbstractTypeComputationState... components)

Method Summary

Modifier and Type	Method	Description
void	acceptActualType(LightweightTypeReference type)	Annotates the currently considered expression(s) with the given type.
void	acceptActualType(LightweightTypeReference type, int flags)	Annotates the currently considered expression(s) with the given type.
void	acceptActualType(LightweightTypeReference type, java.util.EnumSet<ConformanceHint> hints)	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.
void	acceptCandidate(XExpression expression, IApplicableCandidate candidate)	Allows to register a candidate that gets the chance to validate or change the state of the AST in a subsequent processing step.
void	addDiagnostic(org.eclipse.xtext.diagnostics.AbstractDiagnostic diagnostic)	Adds the given diagnostic to the current state.
void	addExtensionsToCurrentScope(java.util.List<? extends org.eclipse.xtext.common.types.JvmIdentifiableElement> extensionProviders)	Adds the given elements as extension providers to the current scope.
void	addExtensionToCurrentScope(org.eclipse.xtext.common.types.JvmIdentifiableElement extensionProvider)	Adds the given element as an extension provider to the current scope.
void	addImports(ITypeImporter.Client importer)	Allows to add several imports in a bulk operation on a fine grained basis, e.g.
void	addLocalToCurrentScope(org.eclipse.xtext.common.types.JvmIdentifiableElement element)	Adds the given element as a local variable.
void	addTypeToStaticExtensionImportScope(org.eclipse.xtext.common.types.JvmDeclaredType type)	Adds the given type to the static extension scope.
void	addTypeToStaticImportScope(org.eclipse.xtext.common.types.JvmDeclaredType type)	Adds the given type to the static scope.
void	afterScope(org.eclipse.emf.ecore.EObject context)	If the expression tree contains intermediate objects, e.g.
ITypeComputationState	assignType(org.eclipse.xtext.common.types.JvmIdentifiableElement element, LightweightTypeReference type)	Assigns the type to the given element and makes the element available in the scope.
ITypeComputationState	assignType(org.eclipse.xtext.common.types.JvmIdentifiableElement element, LightweightTypeReference type, boolean addToChildScope)	Assigns the given type to the given element and optionally adds the element to the scope.
void	assignType(org.eclipse.xtext.naming.QualifiedName name, org.eclipse.xtext.common.types.JvmType rawType, LightweightTypeReference actualType)	Assigns the given actual type to the raw type which shall be reachable with the given name.
ITypeAssigner	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.
UnboundTypeReference	createUnboundTypeReference(XExpression expression, org.eclipse.xtext.common.types.JvmTypeParameter typeParameter)	Create a new, managed UnboundTypeReference for the given type parameter which was first encountered for the given expression.
void	discardReassignedTypes(org.eclipse.xtext.common.types.JvmIdentifiableElement refinable)	A reassigned type may become obsolete due to assignments.
java.util.List<? extends ITypeExpectation>	getExpectations()	The result is never empty.
java.util.List<LightweightTypeReference>	getExpectedExceptions()
java.util.List<? extends IFeatureLinkingCandidate>	getLinkingCandidates(XAbstractFeatureCall featureCall)	The result is never empty.
java.util.List<? extends IConstructorLinkingCandidate>	getLinkingCandidates(XConstructorCall constructorCall)	The result is never empty.
ITypeReferenceOwner	getReferenceOwner()	The current type reference owner for newly converted type references.
org.eclipse.xtext.diagnostics.Severity	getSeverity(java.lang.String issueCode)	Returns the severity for the given issueCode.
boolean	isIgnored(java.lang.String issueCode)	Returns false if no issues have to be produced for the given issueCode.
void	reassignType(org.eclipse.xtext.common.types.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.
void	rewriteScope(org.eclipse.emf.ecore.EObject context)	If the container of an expression decides to alter the scope after the expression was typed, its AFTER scope may be rewritten.
LightweightTypeReference	toLightweightTypeReference(org.eclipse.xtext.common.types.JvmTypeReference reference)
ITypeComputationState	withExpectation(LightweightTypeReference expectation)	The given expectation will be resolved if it contains unresolved type arguments, e.g.
ITypeComputationState	withExpectedExceptions(java.util.List<LightweightTypeReference> declaredExceptionTypes)
void	withinScope(org.eclipse.emf.ecore.EObject context)	If the expression tree contains expressions that define a new scope, e.g.
ITypeComputationState	withNonVoidExpectation()	Keep the current return expectation and assume an actual expectation that is not void.
ITypeComputationState	withoutExpectation()	Keeps the return type expectation.
ITypeComputationState	withoutRootExpectation()	The outer context is ignored for child expressions and the newly produced context does not impose any restrictions on the expectation.
ITypeComputationState	withReturnExpectation()	Transfers the available return type expectation to the actual expectation of this computation step.
ITypeComputationState	withRootExpectation(LightweightTypeReference expectation)	The given expectation becomes the expected return type and the expected type for the current context.
ITypeComputationState	withTypeCheckpoint(org.eclipse.emf.ecore.EObject context)	A type checkpoint allows to re-specify the type of an identifiable that was already type-computed.

Methods inherited from class java.lang.Object

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

Constructor Detail

CompoundTypeComputationState

public CompoundTypeComputationState(ITypeReferenceOwner owner,
                                    AbstractTypeComputationState... components)

Method Detail

getLinkingCandidates

public java.util.List<? extends IConstructorLinkingCandidate> getLinkingCandidates(XConstructorCall constructorCall)

Description copied from interface: ITypeComputationState

The result is never empty.

Specified by:

getLinkingCandidates in interface ITypeComputationState

getLinkingCandidates

public java.util.List<? extends IFeatureLinkingCandidate> getLinkingCandidates(XAbstractFeatureCall featureCall)

Description copied from interface: ITypeComputationState

The result is never empty.

Specified by:

getLinkingCandidates in interface ITypeComputationState

withExpectation

public ITypeComputationState withExpectation(LightweightTypeReference expectation)

Description copied from interface: ITypeComputationState

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. <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'.

Specified by:

withExpectation in interface ITypeComputationState

refineExpectedType

public void refineExpectedType(XExpression expression,
                               LightweightTypeReference expectation)

Description copied from interface: ITypeComputationState

After the fact refinement of the expected type. The expected type of a given expression may be changed after the real type of that expression is known. Example:

 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.

Specified by:

refineExpectedType in interface ITypeComputationState

withRootExpectation

public ITypeComputationState withRootExpectation(LightweightTypeReference expectation)

Description copied from interface: ITypeComputationState

The given expectation becomes the expected return type and the expected type for the current context. Outer context is ignored for child expressions.

Specified by:

withRootExpectation in interface ITypeComputationState

withoutRootExpectation

public ITypeComputationState withoutRootExpectation()

Description copied from interface: ITypeComputationState

The outer context is ignored for child expressions and the newly produced context does not impose any restrictions on the expectation.

Specified by:

withoutRootExpectation in interface ITypeComputationState

withNonVoidExpectation

public ITypeComputationState withNonVoidExpectation()

Description copied from interface: ITypeComputationState

Keep the current return expectation and assume an actual expectation that is not void. Example:

 val x = someExpression
 

The expectation for the call to someExpression is anything but void.

Specified by:

withNonVoidExpectation in interface ITypeComputationState

withReturnExpectation

public ITypeComputationState withReturnExpectation()

Description copied from interface: ITypeComputationState

Transfers the available return type expectation to the actual expectation of this computation step.

 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.

Specified by:

withReturnExpectation in interface ITypeComputationState

withoutExpectation

public ITypeComputationState withoutExpectation()

Description copied from interface: ITypeComputationState

Keeps the return type expectation. Otherwise the new state does not have any expectations. Example:

 {
   someExpression
   subsequent 
 }
 

The expectation for the call to someExpression does not have any actual expectations.

Specified by:

withoutExpectation in interface ITypeComputationState

withTypeCheckpoint

public ITypeComputationState withTypeCheckpoint(org.eclipse.emf.ecore.EObject context)

Description copied from interface: ITypeComputationState

A type checkpoint allows to re-specify the type of an identifiable that was already type-computed. The refined type is discarded as soon as the state is left. In that sense, the type checkpoint describes the scope of certain type specializations.

Specified by:

withTypeCheckpoint in interface ITypeComputationState

Parameters:

context - an indicator that describes the context of this type checkpoint, e.g. an XCasePart.

computeTypes

public ITypeComputationResult computeTypes(XExpression expression)

Description copied from interface: ITypeComputationState

Triggers type computation for a child expression of the currently considered expression.

Specified by:

computeTypes in interface ITypeComputationState

assignType

public ITypeComputationState assignType(org.eclipse.xtext.common.types.JvmIdentifiableElement element,
                                        LightweightTypeReference type)

Description copied from interface: ITypeComputationState

Assigns the type to the given element and makes the element available in the scope. This is fully equivalent to assignType(element, type, true). Each element may only be typed once.

Specified by:

assignType in interface ITypeComputationState

Parameters:

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.

See Also:

ITypeComputationState.assignType(JvmIdentifiableElement, LightweightTypeReference, boolean), ITypeComputationState.addLocalToCurrentScope(JvmIdentifiableElement), ITypeComputationState.assignTypes(), ITypeAssigner

assignType

public ITypeComputationState assignType(org.eclipse.xtext.common.types.JvmIdentifiableElement element,
                                        LightweightTypeReference type,
                                        boolean addToChildScope)

Description copied from interface: ITypeComputationState

Assigns the given type to the given element and optionally adds the element to the scope. Each element may only be typed once.

Specified by:

assignType in interface ITypeComputationState

Parameters:

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.

See Also:

ITypeAssigner, ITypeComputationState.assignTypes(), ITypeComputationState.addLocalToCurrentScope(JvmIdentifiableElement)

addExtensionToCurrentScope

public void addExtensionToCurrentScope(org.eclipse.xtext.common.types.JvmIdentifiableElement extensionProvider)

Description copied from interface: ITypeComputationState

Adds the given element as an extension provider to the current scope.

Specified by:

addExtensionToCurrentScope in interface ITypeComputationState

Parameters:

extensionProvider - the identifiable that points to the extension provider

addTypeToStaticImportScope

public void addTypeToStaticImportScope(org.eclipse.xtext.common.types.JvmDeclaredType type)

Description copied from interface: ITypeComputationState

Adds the given type to the static scope.

Specified by:

addTypeToStaticImportScope in interface ITypeComputationState

Parameters:

type - the type that is added to the static scope.

addImports

public void addImports(ITypeImporter.Client importer)

Description copied from interface: ITypeComputationState

Allows to add several imports in a bulk operation on a fine grained basis, e.g. it supports to import only a subset of the members of a type.

Specified by:

addImports in interface ITypeComputationState

addTypeToStaticExtensionImportScope

public void addTypeToStaticExtensionImportScope(org.eclipse.xtext.common.types.JvmDeclaredType type)

Description copied from interface: ITypeComputationState

Adds the given type to the static extension scope.

Specified by:

addTypeToStaticExtensionImportScope in interface ITypeComputationState

Parameters:

type - the type that is added to the static extension scope.

addExtensionsToCurrentScope

public void addExtensionsToCurrentScope(java.util.List<? extends org.eclipse.xtext.common.types.JvmIdentifiableElement> extensionProviders)

Description copied from interface: ITypeComputationState

Adds the given elements as extension providers to the current scope. The elements are all treated with equal priority, e.g. their contributed extensions may be ambiguous.

Specified by:

addExtensionsToCurrentScope in interface ITypeComputationState

Parameters:

extensionProviders - the identifiables that contribute to the extension scope

assignTypes

public ITypeAssigner assignTypes()

Description copied from interface: ITypeComputationState

Obtain a new ITypeAssigner that allows to add a bulk of elements to this computation state.

Specified by:

assignTypes in interface ITypeComputationState

addDiagnostic

public void addDiagnostic(org.eclipse.xtext.diagnostics.AbstractDiagnostic diagnostic)

Description copied from interface: ITypeComputationState

Adds the given diagnostic to the current state. If this state is later discarded in favor of a better solution, the diagnostic is discarded, too.

Specified by:

addDiagnostic in interface ITypeComputationState

getReferenceOwner

public ITypeReferenceOwner getReferenceOwner()

Description copied from interface: ITypeComputationState

The current type reference owner for newly converted type references.

Specified by:

getReferenceOwner in interface ITypeComputationState

toLightweightTypeReference

public LightweightTypeReference toLightweightTypeReference(org.eclipse.xtext.common.types.JvmTypeReference reference)

addLocalToCurrentScope

public void addLocalToCurrentScope(org.eclipse.xtext.common.types.JvmIdentifiableElement element)

Description copied from interface: ITypeComputationState

Adds the given element as a local variable. An issue is recorded if the new element will shadow an existing element. If the new element has a disallowed name, it will not be added to the scope.

Specified by:

addLocalToCurrentScope in interface ITypeComputationState

Parameters:

element - the newly added element (e.g. a variable or parameter.

See Also:

FeatureNameValidator

assignType

public void assignType(org.eclipse.xtext.naming.QualifiedName name,
                       org.eclipse.xtext.common.types.JvmType rawType,
                       LightweightTypeReference actualType)

Description copied from interface: ITypeComputationState

Assigns the given actual type to the raw type which shall be reachable with the given name. This is useful to refine the context of certain expression children, e.g. the body of a lambda expression shall use the visibility constraints of the implemented SAM type.

        assignType(IFeatureNames.SELF, 'java.util.Comparator', 'java.util.Comparator<String>');
 

Specified by:

assignType in interface ITypeComputationState

Parameters:

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).

getExpectations

public java.util.List<? extends ITypeExpectation> getExpectations()

Description copied from interface: ITypeComputationState

The result is never empty.

Specified by:

getExpectations in interface ITypeComputationState

acceptCandidate

public void acceptCandidate(XExpression expression,
                            IApplicableCandidate candidate)

Description copied from interface: ITypeComputationState

Allows to register a candidate that gets the chance to validate or change the state of the AST in a subsequent processing step.

Specified by:

acceptCandidate in interface ITypeComputationState

Parameters:

expression - the expression that the given candidate is associated with.

candidate - the candidate to validate if it is still present at the root of the decision tree.

See Also:

IClosureCandidate

acceptActualType

public void acceptActualType(LightweightTypeReference type)

Description copied from interface: ITypeComputationState

Annotates the currently considered expression(s) with the given type. It is assumed that the type does not depend on the expectation.

Specified by:

acceptActualType in interface ITypeComputationState

acceptActualType

public void acceptActualType(LightweightTypeReference type,
                             int flags)

Description copied from interface: ITypeComputationState

Annotates the currently considered expression(s) with the given type. It is assumed that the type does not depend on the expectation. The flags are used to decide which variant will be finally chosen, if more than one type was given.

Specified by:

acceptActualType in interface ITypeComputationState

See Also:

ConformanceFlags

acceptActualType

public void acceptActualType(LightweightTypeReference type,
                             ConformanceHint... hints)

Description copied from interface: ITypeComputationState

Annotates the currently considered expression(s) with the given type. It is assumed that the type does not depend on the expectation. The conformance hints are used to decide which variant will be finally chosen, if more than one type was given.

Specified by:

acceptActualType in interface ITypeComputationState

acceptActualType

public void acceptActualType(LightweightTypeReference type,
                             java.util.EnumSet<ConformanceHint> hints)

Description copied from interface: ITypeComputationState

Annotates the currently considered expression(s) with the given type. It is assumed that the type does not depend on the expectation. The conformance hints are used to decide which variant will be finally chosen, if more than one type was given.

Specified by:

acceptActualType in interface ITypeComputationState

reassignType

public void reassignType(org.eclipse.xtext.common.types.JvmIdentifiableElement refinable,
                         LightweightTypeReference type)

Description copied from interface: ITypeComputationState

Allows to specialize the known type of an identifiable, that was already annotated with a type. Type refinements may be used to save casts. Usually only simple identifiables should be refined, e.g. 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.

Specified by:

reassignType in interface ITypeComputationState

discardReassignedTypes

public void discardReassignedTypes(org.eclipse.xtext.common.types.JvmIdentifiableElement refinable)

Description copied from interface: ITypeComputationState

A reassigned type may become obsolete due to assignments. Those should discard the reassign information. Example:

 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.

Specified by:

discardReassignedTypes in interface ITypeComputationState

createUnboundTypeReference

public UnboundTypeReference createUnboundTypeReference(XExpression expression,
                                                       org.eclipse.xtext.common.types.JvmTypeParameter typeParameter)

Description copied from interface: ITypeComputationState

Create a new, managed UnboundTypeReference for the given type parameter which was first encountered for the given expression.

Specified by:

createUnboundTypeReference in interface ITypeComputationState

Parameters:

expression - the expression that used / referenced the type parameter

typeParameter - the type parameter

getExpectedExceptions

public java.util.List<LightweightTypeReference> getExpectedExceptions()

Specified by:

getExpectedExceptions in interface ITypeComputationState

withExpectedExceptions

public ITypeComputationState withExpectedExceptions(java.util.List<LightweightTypeReference> declaredExceptionTypes)

Specified by:

withExpectedExceptions in interface ITypeComputationState

getSeverity

public org.eclipse.xtext.diagnostics.Severity getSeverity(java.lang.String issueCode)

Description copied from interface: ITypeComputationState

Returns the severity for the given issueCode.

Specified by:

getSeverity in interface ITypeComputationState

isIgnored

public boolean isIgnored(java.lang.String issueCode)

Description copied from interface: ITypeComputationState

Returns false if no issues have to be produced for the given issueCode.

Specified by:

isIgnored in interface ITypeComputationState

withinScope

public void withinScope(org.eclipse.emf.ecore.EObject context)

Description copied from interface: ITypeComputationState

If the expression tree contains expressions that define a new scope, e.g. add local variables to the scope as a XForLoopExpression would do, the scope for contained expressions may be explicitly recorded by announcing that the inference is now done within that newly created scope.

Specified by:

withinScope in interface ITypeComputationState

afterScope

public void afterScope(org.eclipse.emf.ecore.EObject context)

Description copied from interface: ITypeComputationState

If the expression tree contains intermediate objects, e.g. XCasePart or XCatchClause, one can explicitly record the scope of these objects as these won't be processed by the inference infrastructure.

Specified by:

afterScope in interface ITypeComputationState

rewriteScope

public void rewriteScope(org.eclipse.emf.ecore.EObject context)

Description copied from interface: ITypeComputationState

If the container of an expression decides to alter the scope after the expression was typed, its AFTER scope may be rewritten.

Specified by:

rewriteScope in interface ITypeComputationState