Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
org.jetbrains.kotlin.types.expressions.ControlStructureTypingUtils Maven / Gradle / Ivy
/*
* Copyright 2010-2016 JetBrains s.r.o.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.jetbrains.kotlin.types.expressions;
import com.google.common.collect.ImmutableMap;
import com.google.common.collect.Lists;
import com.google.common.collect.Maps;
import com.intellij.lang.ASTNode;
import com.intellij.openapi.diagnostic.Logger;
import com.intellij.openapi.util.Ref;
import com.intellij.psi.util.PsiTreeUtil;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import org.jetbrains.kotlin.builtins.KotlinBuiltIns;
import org.jetbrains.kotlin.descriptors.*;
import org.jetbrains.kotlin.descriptors.annotations.Annotations;
import org.jetbrains.kotlin.descriptors.impl.SimpleFunctionDescriptorImpl;
import org.jetbrains.kotlin.descriptors.impl.TypeParameterDescriptorImpl;
import org.jetbrains.kotlin.descriptors.impl.ValueParameterDescriptorImpl;
import org.jetbrains.kotlin.lexer.KtTokens;
import org.jetbrains.kotlin.name.Name;
import org.jetbrains.kotlin.psi.*;
import org.jetbrains.kotlin.resolve.BindingContextUtils;
import org.jetbrains.kotlin.resolve.BindingTrace;
import org.jetbrains.kotlin.resolve.calls.CallResolver;
import org.jetbrains.kotlin.resolve.calls.context.ResolutionContext;
import org.jetbrains.kotlin.resolve.calls.inference.ConstraintSystem;
import org.jetbrains.kotlin.resolve.calls.inference.ConstraintSystemStatus;
import org.jetbrains.kotlin.resolve.calls.inference.ConstraintsUtil;
import org.jetbrains.kotlin.resolve.calls.inference.InferenceErrorData;
import org.jetbrains.kotlin.resolve.calls.model.MutableDataFlowInfoForArguments;
import org.jetbrains.kotlin.resolve.calls.model.ResolvedCall;
import org.jetbrains.kotlin.resolve.calls.results.OverloadResolutionResults;
import org.jetbrains.kotlin.resolve.calls.smartcasts.DataFlowInfo;
import org.jetbrains.kotlin.resolve.calls.tasks.ExplicitReceiverKind;
import org.jetbrains.kotlin.resolve.calls.tasks.ResolutionCandidate;
import org.jetbrains.kotlin.resolve.calls.tasks.TracingStrategy;
import org.jetbrains.kotlin.resolve.calls.util.CallMaker;
import org.jetbrains.kotlin.resolve.descriptorUtil.AnnotationsForResolveKt;
import org.jetbrains.kotlin.resolve.scopes.receivers.ReceiverValue;
import org.jetbrains.kotlin.types.*;
import org.jetbrains.kotlin.types.typeUtil.TypeUtilsKt;
import java.util.*;
import static org.jetbrains.kotlin.diagnostics.Errors.TYPE_INFERENCE_FAILED_ON_SPECIAL_CONSTRUCT;
import static org.jetbrains.kotlin.resolve.BindingContext.CALL;
import static org.jetbrains.kotlin.resolve.BindingContext.RESOLVED_CALL;
import static org.jetbrains.kotlin.resolve.calls.inference.constraintPosition.ConstraintPositionKind.EXPECTED_TYPE_POSITION;
public class ControlStructureTypingUtils {
private static final Logger LOG = Logger.getInstance(ControlStructureTypingUtils.class);
public enum ResolveConstruct {
IF("if"), ELVIS("elvis"), EXCL_EXCL("ExclExcl"), WHEN("when");
private final String name;
ResolveConstruct(String name) {
this.name = name;
}
public String getName() {
return name;
}
}
private final CallResolver callResolver;
private final DataFlowAnalyzer dataFlowAnalyzer;
private final ModuleDescriptor moduleDescriptor;
public ControlStructureTypingUtils(
@NotNull CallResolver callResolver,
@NotNull DataFlowAnalyzer dataFlowAnalyzer,
@NotNull ModuleDescriptor moduleDescriptor
) {
this.callResolver = callResolver;
this.dataFlowAnalyzer = dataFlowAnalyzer;
this.moduleDescriptor = moduleDescriptor;
}
/*package*/ ResolvedCall resolveSpecialConstructionAsCall(
@NotNull Call call,
@NotNull ResolveConstruct construct,
@NotNull List argumentNames,
@NotNull List isArgumentNullable,
@NotNull ExpressionTypingContext context,
@Nullable MutableDataFlowInfoForArguments dataFlowInfoForArguments
) {
SimpleFunctionDescriptorImpl function = createFunctionDescriptorForSpecialConstruction(
construct, argumentNames, isArgumentNullable);
TracingStrategy tracing = createTracingForSpecialConstruction(call, construct.getName(), context);
TypeSubstitutor knownTypeParameterSubstitutor = createKnownTypeParameterSubstitutorForSpecialCall(construct, function, context.expectedType);
ResolutionCandidate resolutionCandidate =
ResolutionCandidate.create(call, function, knownTypeParameterSubstitutor);
OverloadResolutionResults results = callResolver.resolveCallWithKnownCandidate(
call, tracing, context, resolutionCandidate, dataFlowInfoForArguments);
assert results.isSingleResult() : "Not single result after resolving one known candidate";
return results.getResultingCall();
}
private static @Nullable TypeSubstitutor createKnownTypeParameterSubstitutorForSpecialCall(
@NotNull ResolveConstruct construct,
@NotNull SimpleFunctionDescriptorImpl function,
@NotNull KotlinType expectedType
) {
if (construct == ResolveConstruct.ELVIS
|| TypeUtils.noExpectedType(expectedType)
|| TypeUtils.isDontCarePlaceholder(expectedType)
|| KotlinBuiltIns.isUnitOrNullableUnit(expectedType)
|| KotlinBuiltIns.isAnyOrNullableAny(expectedType)
) {
return null;
}
TypeConstructor typeParameterConstructor = function.getTypeParameters().get(0).getTypeConstructor();
TypeProjection typeProjection = new TypeProjectionImpl(expectedType);
return TypeSubstitutor.create(ImmutableMap.of(typeParameterConstructor, typeProjection));
}
private SimpleFunctionDescriptorImpl createFunctionDescriptorForSpecialConstruction(
@NotNull ResolveConstruct construct,
@NotNull List argumentNames,
@NotNull List isArgumentNullable
) {
assert argumentNames.size() == isArgumentNullable.size();
String constructionName = construct.getName().toUpperCase();
Name specialFunctionName = Name.identifier("");
SimpleFunctionDescriptorImpl function = SimpleFunctionDescriptorImpl.create(
moduleDescriptor, Annotations.Companion.getEMPTY(), specialFunctionName, CallableMemberDescriptor.Kind.DECLARATION, SourceElement.NO_SOURCE
);
TypeParameterDescriptor typeParameter = TypeParameterDescriptorImpl.createWithDefaultBound(
function, Annotations.Companion.getEMPTY(), false, Variance.INVARIANT,
Name.identifier(""), 0);
KotlinType type = typeParameter.getDefaultType();
KotlinType nullableType = TypeUtils.makeNullable(type);
List valueParameters = new ArrayList(argumentNames.size());
for (int i = 0; i < argumentNames.size(); i++) {
KotlinType argumentType = isArgumentNullable.get(i) ? nullableType : type;
ValueParameterDescriptorImpl valueParameter = new ValueParameterDescriptorImpl(
function, null, i, Annotations.Companion.getEMPTY(), Name.identifier(argumentNames.get(i)),
argumentType,
/* declaresDefaultValue = */ false,
/* isCrossinline = */ false,
/* isNoinline = */ false,
null, SourceElement.NO_SOURCE
);
valueParameters.add(valueParameter);
}
KotlinType returnType = construct != ResolveConstruct.ELVIS ? type : TypeUtilsKt.replaceAnnotations(type, AnnotationsForResolveKt.getExactInAnnotations());
function.initialize(
null,
null,
Lists.newArrayList(typeParameter),
valueParameters,
returnType,
Modality.FINAL,
Visibilities.PUBLIC
);
return function;
}
private static MutableDataFlowInfoForArguments createIndependentDataFlowInfoForArgumentsForCall(
@NotNull DataFlowInfo initialDataFlowInfo,
final Map dataFlowInfoForArgumentsMap
) {
return new MutableDataFlowInfoForArguments(initialDataFlowInfo) {
@Override
public void updateInfo(@NotNull ValueArgument valueArgument, @NotNull DataFlowInfo dataFlowInfo) {
dataFlowInfoForArgumentsMap.put(valueArgument, dataFlowInfo);
}
@NotNull
@Override
public DataFlowInfo getInfo(@NotNull ValueArgument valueArgument) {
return dataFlowInfoForArgumentsMap.get(valueArgument);
}
};
}
public static MutableDataFlowInfoForArguments createDataFlowInfoForArgumentsForIfCall(
@NotNull Call callForIf,
@NotNull DataFlowInfo conditionInfo,
@NotNull DataFlowInfo thenInfo,
@NotNull DataFlowInfo elseInfo
) {
Map dataFlowInfoForArgumentsMap = Maps.newHashMap();
dataFlowInfoForArgumentsMap.put(callForIf.getValueArguments().get(0), thenInfo);
dataFlowInfoForArgumentsMap.put(callForIf.getValueArguments().get(1), elseInfo);
return createIndependentDataFlowInfoForArgumentsForCall(conditionInfo, dataFlowInfoForArgumentsMap);
}
public static MutableDataFlowInfoForArguments createDataFlowInfoForArgumentsOfWhenCall(
@NotNull Call callForWhen,
@NotNull DataFlowInfo subjectDataFlowInfo,
@NotNull List entryDataFlowInfos
) {
Map dataFlowInfoForArgumentsMap = Maps.newHashMap();
int i = 0;
for (ValueArgument argument : callForWhen.getValueArguments()) {
DataFlowInfo entryDataFlowInfo = entryDataFlowInfos.get(i++);
dataFlowInfoForArgumentsMap.put(argument, entryDataFlowInfo);
}
return createIndependentDataFlowInfoForArgumentsForCall(subjectDataFlowInfo, dataFlowInfoForArgumentsMap);
}
/*package*/ static Call createCallForSpecialConstruction(
@NotNull final KtExpression expression,
@NotNull final KtExpression calleeExpression,
@NotNull List arguments
) {
final List valueArguments = Lists.newArrayList();
for (KtExpression argument : arguments) {
valueArguments.add(CallMaker.makeValueArgument(argument));
}
return new Call() {
@Nullable
@Override
public ASTNode getCallOperationNode() {
return expression.getNode();
}
@Nullable
@Override
public ReceiverValue getExplicitReceiver() {
return null;
}
@Nullable
@Override
public ReceiverValue getDispatchReceiver() {
return null;
}
@Nullable
@Override
public KtExpression getCalleeExpression() {
return calleeExpression;
}
@Nullable
@Override
public KtValueArgumentList getValueArgumentList() {
return null;
}
@NotNull
@Override
public List getValueArguments() {
return valueArguments;
}
@NotNull
@Override
public List getFunctionLiteralArguments() {
return Collections.emptyList();
}
@NotNull
@Override
public List getTypeArguments() {
return Collections.emptyList();
}
@Nullable
@Override
public KtTypeArgumentList getTypeArgumentList() {
return null;
}
@NotNull
@Override
public KtElement getCallElement() {
return expression;
}
@NotNull
@Override
public CallType getCallType() {
return CallType.DEFAULT;
}
};
}
@NotNull
private TracingStrategy createTracingForSpecialConstruction(
final @NotNull Call call,
@NotNull String constructionName,
final @NotNull ExpressionTypingContext context
) {
class CheckTypeContext {
public BindingTrace trace;
public KotlinType expectedType;
CheckTypeContext(@NotNull BindingTrace trace, @NotNull KotlinType expectedType) {
this.trace = trace;
this.expectedType = expectedType;
}
CheckTypeContext makeTypeNullable() {
if (TypeUtils.noExpectedType(expectedType)) return this;
return new CheckTypeContext(trace, TypeUtils.makeNullable(expectedType));
}
}
final KtVisitor checkTypeVisitor = new KtVisitor() {
private boolean checkExpressionType(@NotNull KtExpression expression, CheckTypeContext c) {
KotlinTypeInfo typeInfo = BindingContextUtils.getRecordedTypeInfo(expression, c.trace.getBindingContext());
if (typeInfo == null) return false;
Ref hasError = Ref.create();
dataFlowAnalyzer.checkType(
typeInfo.getType(),
expression,
context
.replaceExpectedType(c.expectedType)
.replaceDataFlowInfo(typeInfo.getDataFlowInfo())
.replaceBindingTrace(c.trace),
hasError
);
return hasError.get();
}
private boolean checkExpressionTypeRecursively(@Nullable KtExpression expression, CheckTypeContext c) {
if (expression == null) return false;
return expression.accept(this, c);
}
private boolean checkSubExpressions(
KtExpression firstSub, KtExpression secondSub, KtExpression expression,
CheckTypeContext firstContext, CheckTypeContext secondContext, CheckTypeContext context
) {
boolean errorWasReported = checkExpressionTypeRecursively(firstSub, firstContext);
errorWasReported |= checkExpressionTypeRecursively(secondSub, secondContext);
return errorWasReported || checkExpressionType(expression, context);
}
@Override
public Boolean visitWhenExpression(@NotNull KtWhenExpression whenExpression, CheckTypeContext c) {
boolean errorWasReported = false;
for (KtWhenEntry whenEntry : whenExpression.getEntries()) {
KtExpression entryExpression = whenEntry.getExpression();
if (entryExpression != null) {
errorWasReported |= checkExpressionTypeRecursively(entryExpression, c);
}
}
errorWasReported |= checkExpressionType(whenExpression, c);
return errorWasReported;
}
@Override
public Boolean visitIfExpression(@NotNull KtIfExpression ifExpression, CheckTypeContext c) {
KtExpression thenBranch = ifExpression.getThen();
KtExpression elseBranch = ifExpression.getElse();
if (thenBranch == null || elseBranch == null) {
return checkExpressionType(ifExpression, c);
}
return checkSubExpressions(thenBranch, elseBranch, ifExpression, c, c, c);
}
@Override
public Boolean visitBlockExpression(@NotNull KtBlockExpression expression, CheckTypeContext c) {
if (expression.getStatements().isEmpty()) {
return checkExpressionType(expression, c);
}
KtExpression lastStatement = KtPsiUtil.getLastStatementInABlock(expression);
if (lastStatement != null) {
return checkExpressionTypeRecursively(lastStatement, c);
}
return false;
}
@Override
public Boolean visitPostfixExpression(@NotNull KtPostfixExpression expression, CheckTypeContext c) {
if (expression.getOperationReference().getReferencedNameElementType() == KtTokens.EXCLEXCL) {
return checkExpressionTypeRecursively(expression.getBaseExpression(), c.makeTypeNullable());
}
return super.visitPostfixExpression(expression, c);
}
@Override
public Boolean visitBinaryExpression(@NotNull KtBinaryExpression expression, CheckTypeContext c) {
if (expression.getOperationReference().getReferencedNameElementType() == KtTokens.ELVIS) {
return checkSubExpressions(expression.getLeft(), expression.getRight(), expression, c.makeTypeNullable(), c, c);
}
return super.visitBinaryExpression(expression, c);
}
@Override
public Boolean visitExpression(@NotNull KtExpression expression, CheckTypeContext c) {
return checkExpressionType(expression, c);
}
};
return new ThrowingOnErrorTracingStrategy("resolve " + constructionName + " as a call") {
@Override
public void bindReference(
@NotNull BindingTrace trace, @NotNull ResolvedCall resolvedCall
) {
//do nothing
}
@Override
public void bindCall(@NotNull BindingTrace trace, @NotNull Call call) {
trace.record(CALL, call.getCalleeExpression(), call);
}
@Override
public void bindResolvedCall(
@NotNull BindingTrace trace, @NotNull ResolvedCall resolvedCall
) {
trace.record(RESOLVED_CALL, call, resolvedCall);
}
@Override
public void typeInferenceFailed(
@NotNull ResolutionContext context, @NotNull InferenceErrorData data
) {
ConstraintSystem constraintSystem = data.constraintSystem;
ConstraintSystemStatus status = constraintSystem.getStatus();
assert !status.isSuccessful() : "Report error only for not successful constraint system";
if (status.hasErrorInConstrainingTypes() || status.hasUnknownParameters()) {
return;
}
KtExpression expression = (KtExpression) call.getCallElement();
if (status.hasOnlyErrorsDerivedFrom(EXPECTED_TYPE_POSITION) || status.hasConflictingConstraints()
|| status.hasTypeInferenceIncorporationError()) { // todo after KT-... remove this line
if (noTypeCheckingErrorsInExpression(expression, context.trace, data.expectedType)) {
KtExpression calleeExpression = call.getCalleeExpression();
if (calleeExpression instanceof KtWhenExpression || calleeExpression instanceof KtIfExpression) {
if (status.hasConflictingConstraints() || status.hasTypeInferenceIncorporationError()) {
// TODO provide comprehensible error report for hasConflictingConstraints() case (if possible)
context.trace.report(TYPE_INFERENCE_FAILED_ON_SPECIAL_CONSTRUCT.on(expression));
}
}
}
return;
}
KtDeclaration parentDeclaration = PsiTreeUtil.getParentOfType(expression, KtNamedDeclaration.class);
logError("Expression: " + (parentDeclaration != null ? parentDeclaration.getText() : expression.getText()) +
"\nConstraint system status: \n" + ConstraintsUtil.getDebugMessageForStatus(status));
}
private boolean noTypeCheckingErrorsInExpression(
KtExpression expression,
@NotNull BindingTrace trace,
@NotNull KotlinType expectedType
) {
return Boolean.TRUE != expression.accept(checkTypeVisitor, new CheckTypeContext(trace, expectedType));
}
};
}
private abstract static class ThrowingOnErrorTracingStrategy implements TracingStrategy {
private final String debugName;
protected ThrowingOnErrorTracingStrategy(String debugName) {
this.debugName = debugName;
}
private void logError() {
logError(null);
}
protected void logError(@Nullable String additionalInformation) {
String errorMessage = "Resolution error of this type shouldn't occur for " + debugName;
if (additionalInformation != null) {
errorMessage += ".\n" + additionalInformation;
}
LOG.error(errorMessage);
}
@Override
public void unresolvedReference(@NotNull BindingTrace trace) {
logError();
}
@Override
public void unresolvedReferenceWrongReceiver(
@NotNull BindingTrace trace, @NotNull Collection> candidates
) {
logError();
}
@Override
public void recordAmbiguity(
@NotNull BindingTrace trace, @NotNull Collection> candidates
) {
logError();
}
@Override
public void missingReceiver(
@NotNull BindingTrace trace, @NotNull ReceiverParameterDescriptor expectedReceiver
) {
logError();
}
@Override
public void wrongReceiverType(
@NotNull BindingTrace trace,
@NotNull ReceiverParameterDescriptor receiverParameter,
@NotNull ReceiverValue receiverArgument,
@NotNull ResolutionContext c
) {
logError();
}
@Override
public void noReceiverAllowed(@NotNull BindingTrace trace) {
logError();
}
@Override
public void noValueForParameter(
@NotNull BindingTrace trace, @NotNull ValueParameterDescriptor valueParameter
) {
logError();
}
@Override
public void wrongNumberOfTypeArguments(@NotNull BindingTrace trace, int expectedTypeArgumentCount, @NotNull CallableDescriptor descriptor) {
logError();
}
@Override
public void ambiguity(
@NotNull BindingTrace trace, @NotNull Collection> descriptors
) {
logError();
}
@Override
public void noneApplicable(
@NotNull BindingTrace trace, @NotNull Collection> descriptors
) {
logError();
}
@Override
public void cannotCompleteResolve(
@NotNull BindingTrace trace, @NotNull Collection> descriptors
) {
logError();
}
@Override
public void instantiationOfAbstractClass(@NotNull BindingTrace trace) {
logError();
}
@Override
public void abstractSuperCall(@NotNull BindingTrace trace) {
logError();
}
@Override
public void nestedClassAccessViaInstanceReference(
@NotNull BindingTrace trace, @NotNull ClassDescriptor classDescriptor,
@NotNull ExplicitReceiverKind explicitReceiverKind
) {
logError();
}
@Override
public void unsafeCall(
@NotNull BindingTrace trace, @NotNull KotlinType type, boolean isCallForImplicitInvoke
) {
logError();
}
@Override
public void invisibleMember(
@NotNull BindingTrace trace, @NotNull DeclarationDescriptorWithVisibility descriptor
) {
logError();
}
@Override
public void typeInferenceFailed(
@NotNull ResolutionContext context, @NotNull InferenceErrorData inferenceErrorData
) {
logError();
}
}
}
