Implementation of KT-6399: platform types under when are now counted as not nullable but warning is generated. #KT-6399 Fixed.

A set of tests. Warning about Java enum nullable argument under when in particular situations.
This commit is contained in:
Mikhail Glukhikh
2015-05-18 19:02:58 +03:00
parent 0efaedd32c
commit babb7e58bc
18 changed files with 430 additions and 8 deletions
@@ -16,12 +16,12 @@
package org.jetbrains.kotlin.cfg;
import com.intellij.codeInsight.AnnotationUtil;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import org.jetbrains.kotlin.builtins.KotlinBuiltIns;
import org.jetbrains.kotlin.descriptors.ClassDescriptor;
import org.jetbrains.kotlin.descriptors.ClassKind;
import org.jetbrains.kotlin.descriptors.DeclarationDescriptor;
import org.jetbrains.kotlin.descriptors.*;
import org.jetbrains.kotlin.name.FqName;
import org.jetbrains.kotlin.psi.*;
import org.jetbrains.kotlin.resolve.BindingContext;
import org.jetbrains.kotlin.resolve.BindingTrace;
@@ -46,6 +46,23 @@ public final class WhenChecker {
return !isUnit && !isStatement && !isWhenExhaustive(expression, trace);
}
private static final FqName notNullAnnotationName = new FqName(AnnotationUtil.NOT_NULL);
public static boolean isExhaustiveWhenOnPlatformNullableEnum(@NotNull JetWhenExpression expression, @NotNull BindingTrace trace) {
JetType type = whenSubjectType(expression, trace.getBindingContext());
if (type == null) return false;
ClassDescriptor classDescriptor = TypeUtils.getClassDescriptor(type);
return (isPlatformEnum(type, classDescriptor)
&& isWhenOnEnumExhaustive(expression, trace, classDescriptor)
// nullable from Kotlin side
&& TypeUtils.isNullableType(type)
// and from Java side too
&& type.getAnnotations().findAnnotation(notNullAnnotationName) == null
&& type.getAnnotations().findExternalAnnotation(notNullAnnotationName) == null
// but no null case
&& !containsNullCase(expression, trace));
}
public static boolean isWhenByEnum(@NotNull JetWhenExpression expression, @NotNull BindingContext context) {
return getClassDescriptorOfTypeIfEnum(whenSubjectType(expression, context)) != null;
}
@@ -53,9 +70,8 @@ public final class WhenChecker {
@Nullable
private static ClassDescriptor getClassDescriptorOfTypeIfEnum(@Nullable JetType type) {
if (type == null) return null;
DeclarationDescriptor declarationDescriptor = type.getConstructor().getDeclarationDescriptor();
if (!(declarationDescriptor instanceof ClassDescriptor)) return null;
ClassDescriptor classDescriptor = (ClassDescriptor) declarationDescriptor;
ClassDescriptor classDescriptor = TypeUtils.getClassDescriptor(type);
if (classDescriptor == null) return null;
if (classDescriptor.getKind() != ClassKind.ENUM_CLASS || classDescriptor.getModality().isOverridable()) return null;
return classDescriptor;
@@ -98,6 +114,12 @@ public final class WhenChecker {
return notEmpty;
}
private static boolean isPlatformEnum(@NotNull JetType type, @Nullable ClassDescriptor classDescriptor) {
// instanceof JetClass are Kotlin types, as well as nullable types
return classDescriptor != null && classDescriptor.getKind() == ClassKind.ENUM_CLASS
&& !(type instanceof JetClass) && !type.isMarkedNullable();
}
public static boolean isWhenExhaustive(@NotNull JetWhenExpression expression, @NotNull BindingTrace trace) {
JetType type = whenSubjectType(expression, trace.getBindingContext());
if (type == null) return false;
@@ -116,7 +138,7 @@ public final class WhenChecker {
else {
exhaustive = isWhenOnEnumExhaustive(expression, trace, classDescriptor);
}
if (exhaustive && (!TypeUtils.isNullableType(type) || containsNullCase(expression, trace))) {
if (exhaustive && (!TypeUtils.isNullableType(type) || containsNullCase(expression, trace) || isPlatformEnum(type, classDescriptor))) {
trace.record(BindingContext.EXHAUSTIVE_WHEN, expression);
return true;
}
@@ -618,6 +618,7 @@ public interface Errors {
DiagnosticFactory0<JetWhenCondition> EXPECTED_CONDITION = DiagnosticFactory0.create(ERROR);
DiagnosticFactory0<JetWhenEntry> ELSE_MISPLACED_IN_WHEN = DiagnosticFactory0.create(ERROR, ELSE_ENTRY);
DiagnosticFactory0<JetWhenExpression> NO_ELSE_IN_WHEN = DiagnosticFactory0.create(ERROR, WHEN_EXPRESSION);
DiagnosticFactory0<JetExpression> WHEN_ENUM_CAN_BE_NULL_IN_JAVA = DiagnosticFactory0.create(WARNING);
// Type mismatch
@@ -385,6 +385,8 @@ public class DefaultErrorMessages {
MAP.put(ELSE_MISPLACED_IN_WHEN, "'else' entry must be the last one in a when-expression");
MAP.put(NO_ELSE_IN_WHEN, "'when' expression must contain 'else' branch");
MAP.put(WHEN_ENUM_CAN_BE_NULL_IN_JAVA, "Enum argument ''{0}'' can be null in Java, but exhaustive when contains no null branch");
MAP.put(TYPE_MISMATCH_IN_RANGE, "Type mismatch: incompatible types of range and element checked in it");
MAP.put(CYCLIC_INHERITANCE_HIERARCHY, "There's a cycle in the inheritance hierarchy for this type");
@@ -21,6 +21,7 @@ import com.intellij.openapi.util.Ref;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import org.jetbrains.kotlin.builtins.KotlinBuiltIns;
import org.jetbrains.kotlin.cfg.WhenChecker;
import org.jetbrains.kotlin.diagnostics.Errors;
import org.jetbrains.kotlin.psi.*;
import org.jetbrains.kotlin.resolve.BindingContext;
@@ -129,6 +130,11 @@ public class PatternMatchingTypingVisitor extends ExpressionTypingVisitor {
if (commonDataFlowInfo == null) {
commonDataFlowInfo = context.dataFlowInfo;
}
// Check for conditionally-exhaustive platform enums, see KT-6399
if (expression.getElseExpression() == null
&& WhenChecker.isExhaustiveWhenOnPlatformNullableEnum(expression, context.trace)) {
context.trace.report(WHEN_ENUM_CAN_BE_NULL_IN_JAVA.on(expression.getSubjectExpression()));
}
return TypeInfoFactoryPackage.createTypeInfo(expressionTypes.isEmpty() ? null : DataFlowUtils.checkImplicitCast(
CommonSupertypes.commonSupertype(expressionTypes), expression,
@@ -22,7 +22,7 @@ fun withNullableNothing(e: E?) = when (e) {
nullableNothing() -> null
}
fun platformType() = <!NO_ELSE_IN_WHEN!>when<!> (J.foo()) {
fun platformType() = when (<!WHEN_ENUM_CAN_BE_NULL_IN_JAVA!>J.foo()<!>) {
E.A -> 7
E.B -> 8
}
@@ -0,0 +1,21 @@
// See KT-6399: exhaustive whens on platform enums
// FILE: J.java
public enum J {
A, B;
public static J create() {
return J.A;
}
}
// FILE: K.kt
fun foo(): Int {
// When is exhaustive (count a platform enum as a special case)
return when (<!WHEN_ENUM_CAN_BE_NULL_IN_JAVA!>J.create()<!>) {
J.A -> 1
J.B -> 2
}
}
@@ -0,0 +1,38 @@
package
internal fun foo(): kotlin.Int
public final enum class J : kotlin.Enum<J!> {
public enum entry A : J {
private constructor A()
public final override /*1*/ /*fake_override*/ fun compareTo(/*0*/ other: J!): kotlin.Int
public final override /*1*/ /*fake_override*/ fun equals(/*0*/ other: kotlin.Any?): kotlin.Boolean
public final override /*1*/ /*fake_override*/ fun hashCode(): kotlin.Int
public final override /*1*/ /*fake_override*/ fun name(): kotlin.String
public final override /*1*/ /*fake_override*/ fun ordinal(): kotlin.Int
public open override /*1*/ /*fake_override*/ fun toString(): kotlin.String
}
public enum entry B : J {
private constructor B()
public final override /*1*/ /*fake_override*/ fun compareTo(/*0*/ other: J!): kotlin.Int
public final override /*1*/ /*fake_override*/ fun equals(/*0*/ other: kotlin.Any?): kotlin.Boolean
public final override /*1*/ /*fake_override*/ fun hashCode(): kotlin.Int
public final override /*1*/ /*fake_override*/ fun name(): kotlin.String
public final override /*1*/ /*fake_override*/ fun ordinal(): kotlin.Int
public open override /*1*/ /*fake_override*/ fun toString(): kotlin.String
}
public constructor J()
public final override /*1*/ /*fake_override*/ fun compareTo(/*0*/ other: J!): kotlin.Int
public final override /*1*/ /*fake_override*/ fun equals(/*0*/ other: kotlin.Any?): kotlin.Boolean
public final override /*1*/ /*fake_override*/ fun hashCode(): kotlin.Int
public final override /*1*/ /*fake_override*/ fun name(): kotlin.String
public final override /*1*/ /*fake_override*/ fun ordinal(): kotlin.Int
public open override /*1*/ /*fake_override*/ fun toString(): kotlin.String
// Static members
public open fun create(): J!
public final /*synthesized*/ fun valueOf(/*0*/ value: kotlin.String): J
public final /*synthesized*/ fun values(): kotlin.Array<J>
}
@@ -0,0 +1,23 @@
// See KT-6399: exhaustive whens on platform enums
// FILE: J.java
import org.jetbrains.annotations.*;
public enum J {
A, B;
@NotNull public static J create() {
return J.A;
}
}
// FILE: K.kt
fun foo(): Int {
// When is exhaustive (count a platform enum as a special case)
return when (J.create()) {
J.A -> 1
J.B -> 2
}
}
@@ -0,0 +1,38 @@
package
internal fun foo(): kotlin.Int
public final enum class J : kotlin.Enum<J!> {
public enum entry A : J {
private constructor A()
public final override /*1*/ /*fake_override*/ fun compareTo(/*0*/ other: J!): kotlin.Int
public final override /*1*/ /*fake_override*/ fun equals(/*0*/ other: kotlin.Any?): kotlin.Boolean
public final override /*1*/ /*fake_override*/ fun hashCode(): kotlin.Int
public final override /*1*/ /*fake_override*/ fun name(): kotlin.String
public final override /*1*/ /*fake_override*/ fun ordinal(): kotlin.Int
public open override /*1*/ /*fake_override*/ fun toString(): kotlin.String
}
public enum entry B : J {
private constructor B()
public final override /*1*/ /*fake_override*/ fun compareTo(/*0*/ other: J!): kotlin.Int
public final override /*1*/ /*fake_override*/ fun equals(/*0*/ other: kotlin.Any?): kotlin.Boolean
public final override /*1*/ /*fake_override*/ fun hashCode(): kotlin.Int
public final override /*1*/ /*fake_override*/ fun name(): kotlin.String
public final override /*1*/ /*fake_override*/ fun ordinal(): kotlin.Int
public open override /*1*/ /*fake_override*/ fun toString(): kotlin.String
}
public constructor J()
public final override /*1*/ /*fake_override*/ fun compareTo(/*0*/ other: J!): kotlin.Int
public final override /*1*/ /*fake_override*/ fun equals(/*0*/ other: kotlin.Any?): kotlin.Boolean
public final override /*1*/ /*fake_override*/ fun hashCode(): kotlin.Int
public final override /*1*/ /*fake_override*/ fun name(): kotlin.String
public final override /*1*/ /*fake_override*/ fun ordinal(): kotlin.Int
public open override /*1*/ /*fake_override*/ fun toString(): kotlin.String
// Static members
org.jetbrains.annotations.NotNull() public open fun create(): J!
public final /*synthesized*/ fun valueOf(/*0*/ value: kotlin.String): J
public final /*synthesized*/ fun values(): kotlin.Array<J>
}
@@ -0,0 +1,21 @@
// See KT-6399: exhaustive whens on platform enums
// FILE: J.java
public enum J {
A, B;
public static J create() {
return J.A;
}
}
// FILE: K.kt
fun foo(): Int {
return when (J.create()) {
J.A -> 1
J.B -> 2
else -> 0
}
}
@@ -0,0 +1,38 @@
package
internal fun foo(): kotlin.Int
public final enum class J : kotlin.Enum<J!> {
public enum entry A : J {
private constructor A()
public final override /*1*/ /*fake_override*/ fun compareTo(/*0*/ other: J!): kotlin.Int
public final override /*1*/ /*fake_override*/ fun equals(/*0*/ other: kotlin.Any?): kotlin.Boolean
public final override /*1*/ /*fake_override*/ fun hashCode(): kotlin.Int
public final override /*1*/ /*fake_override*/ fun name(): kotlin.String
public final override /*1*/ /*fake_override*/ fun ordinal(): kotlin.Int
public open override /*1*/ /*fake_override*/ fun toString(): kotlin.String
}
public enum entry B : J {
private constructor B()
public final override /*1*/ /*fake_override*/ fun compareTo(/*0*/ other: J!): kotlin.Int
public final override /*1*/ /*fake_override*/ fun equals(/*0*/ other: kotlin.Any?): kotlin.Boolean
public final override /*1*/ /*fake_override*/ fun hashCode(): kotlin.Int
public final override /*1*/ /*fake_override*/ fun name(): kotlin.String
public final override /*1*/ /*fake_override*/ fun ordinal(): kotlin.Int
public open override /*1*/ /*fake_override*/ fun toString(): kotlin.String
}
public constructor J()
public final override /*1*/ /*fake_override*/ fun compareTo(/*0*/ other: J!): kotlin.Int
public final override /*1*/ /*fake_override*/ fun equals(/*0*/ other: kotlin.Any?): kotlin.Boolean
public final override /*1*/ /*fake_override*/ fun hashCode(): kotlin.Int
public final override /*1*/ /*fake_override*/ fun name(): kotlin.String
public final override /*1*/ /*fake_override*/ fun ordinal(): kotlin.Int
public open override /*1*/ /*fake_override*/ fun toString(): kotlin.String
// Static members
public open fun create(): J!
public final /*synthesized*/ fun valueOf(/*0*/ value: kotlin.String): J
public final /*synthesized*/ fun values(): kotlin.Array<J>
}
@@ -0,0 +1,22 @@
// See KT-6399: exhaustive whens on platform enums
// FILE: J.java
public enum J {
A, B;
public static J create() {
return J.A;
}
}
// FILE: K.kt
fun foo(): Int {
// When is exhaustive including null
return when (J.create()) {
J.A -> 1
J.B -> 2
null -> 0
}
}
@@ -0,0 +1,38 @@
package
internal fun foo(): kotlin.Int
public final enum class J : kotlin.Enum<J!> {
public enum entry A : J {
private constructor A()
public final override /*1*/ /*fake_override*/ fun compareTo(/*0*/ other: J!): kotlin.Int
public final override /*1*/ /*fake_override*/ fun equals(/*0*/ other: kotlin.Any?): kotlin.Boolean
public final override /*1*/ /*fake_override*/ fun hashCode(): kotlin.Int
public final override /*1*/ /*fake_override*/ fun name(): kotlin.String
public final override /*1*/ /*fake_override*/ fun ordinal(): kotlin.Int
public open override /*1*/ /*fake_override*/ fun toString(): kotlin.String
}
public enum entry B : J {
private constructor B()
public final override /*1*/ /*fake_override*/ fun compareTo(/*0*/ other: J!): kotlin.Int
public final override /*1*/ /*fake_override*/ fun equals(/*0*/ other: kotlin.Any?): kotlin.Boolean
public final override /*1*/ /*fake_override*/ fun hashCode(): kotlin.Int
public final override /*1*/ /*fake_override*/ fun name(): kotlin.String
public final override /*1*/ /*fake_override*/ fun ordinal(): kotlin.Int
public open override /*1*/ /*fake_override*/ fun toString(): kotlin.String
}
public constructor J()
public final override /*1*/ /*fake_override*/ fun compareTo(/*0*/ other: J!): kotlin.Int
public final override /*1*/ /*fake_override*/ fun equals(/*0*/ other: kotlin.Any?): kotlin.Boolean
public final override /*1*/ /*fake_override*/ fun hashCode(): kotlin.Int
public final override /*1*/ /*fake_override*/ fun name(): kotlin.String
public final override /*1*/ /*fake_override*/ fun ordinal(): kotlin.Int
public open override /*1*/ /*fake_override*/ fun toString(): kotlin.String
// Static members
public open fun create(): J!
public final /*synthesized*/ fun valueOf(/*0*/ value: kotlin.String): J
public final /*synthesized*/ fun values(): kotlin.Array<J>
}
@@ -0,0 +1,20 @@
// See KT-6399: exhaustive whens on platform enums
// FILE: J.java
public enum J {
A, B;
public static J create() {
return J.A;
}
}
// FILE: K.kt
fun foo(): Int {
when (<!WHEN_ENUM_CAN_BE_NULL_IN_JAVA!>J.create()<!>) {
J.A -> return 1
J.B -> return 2
}
}
@@ -0,0 +1,38 @@
package
internal fun foo(): kotlin.Int
public final enum class J : kotlin.Enum<J!> {
public enum entry A : J {
private constructor A()
public final override /*1*/ /*fake_override*/ fun compareTo(/*0*/ other: J!): kotlin.Int
public final override /*1*/ /*fake_override*/ fun equals(/*0*/ other: kotlin.Any?): kotlin.Boolean
public final override /*1*/ /*fake_override*/ fun hashCode(): kotlin.Int
public final override /*1*/ /*fake_override*/ fun name(): kotlin.String
public final override /*1*/ /*fake_override*/ fun ordinal(): kotlin.Int
public open override /*1*/ /*fake_override*/ fun toString(): kotlin.String
}
public enum entry B : J {
private constructor B()
public final override /*1*/ /*fake_override*/ fun compareTo(/*0*/ other: J!): kotlin.Int
public final override /*1*/ /*fake_override*/ fun equals(/*0*/ other: kotlin.Any?): kotlin.Boolean
public final override /*1*/ /*fake_override*/ fun hashCode(): kotlin.Int
public final override /*1*/ /*fake_override*/ fun name(): kotlin.String
public final override /*1*/ /*fake_override*/ fun ordinal(): kotlin.Int
public open override /*1*/ /*fake_override*/ fun toString(): kotlin.String
}
public constructor J()
public final override /*1*/ /*fake_override*/ fun compareTo(/*0*/ other: J!): kotlin.Int
public final override /*1*/ /*fake_override*/ fun equals(/*0*/ other: kotlin.Any?): kotlin.Boolean
public final override /*1*/ /*fake_override*/ fun hashCode(): kotlin.Int
public final override /*1*/ /*fake_override*/ fun name(): kotlin.String
public final override /*1*/ /*fake_override*/ fun ordinal(): kotlin.Int
public open override /*1*/ /*fake_override*/ fun toString(): kotlin.String
// Static members
public open fun create(): J!
public final /*synthesized*/ fun valueOf(/*0*/ value: kotlin.String): J
public final /*synthesized*/ fun values(): kotlin.Array<J>
}
@@ -0,0 +1,20 @@
// See KT-6399: exhaustive whens on platform enums
// FILE: J.java
public enum J {
A, B;
public static J create() {
return J.A;
}
}
// FILE: K.kt
fun foo(): Int {
// When is not-exhaustive
return <!NO_ELSE_IN_WHEN!>when<!> (J.create()) {
J.A -> 1
}
}
@@ -0,0 +1,38 @@
package
internal fun foo(): kotlin.Int
public final enum class J : kotlin.Enum<J!> {
public enum entry A : J {
private constructor A()
public final override /*1*/ /*fake_override*/ fun compareTo(/*0*/ other: J!): kotlin.Int
public final override /*1*/ /*fake_override*/ fun equals(/*0*/ other: kotlin.Any?): kotlin.Boolean
public final override /*1*/ /*fake_override*/ fun hashCode(): kotlin.Int
public final override /*1*/ /*fake_override*/ fun name(): kotlin.String
public final override /*1*/ /*fake_override*/ fun ordinal(): kotlin.Int
public open override /*1*/ /*fake_override*/ fun toString(): kotlin.String
}
public enum entry B : J {
private constructor B()
public final override /*1*/ /*fake_override*/ fun compareTo(/*0*/ other: J!): kotlin.Int
public final override /*1*/ /*fake_override*/ fun equals(/*0*/ other: kotlin.Any?): kotlin.Boolean
public final override /*1*/ /*fake_override*/ fun hashCode(): kotlin.Int
public final override /*1*/ /*fake_override*/ fun name(): kotlin.String
public final override /*1*/ /*fake_override*/ fun ordinal(): kotlin.Int
public open override /*1*/ /*fake_override*/ fun toString(): kotlin.String
}
public constructor J()
public final override /*1*/ /*fake_override*/ fun compareTo(/*0*/ other: J!): kotlin.Int
public final override /*1*/ /*fake_override*/ fun equals(/*0*/ other: kotlin.Any?): kotlin.Boolean
public final override /*1*/ /*fake_override*/ fun hashCode(): kotlin.Int
public final override /*1*/ /*fake_override*/ fun name(): kotlin.String
public final override /*1*/ /*fake_override*/ fun ordinal(): kotlin.Int
public open override /*1*/ /*fake_override*/ fun toString(): kotlin.String
// Static members
public open fun create(): J!
public final /*synthesized*/ fun valueOf(/*0*/ value: kotlin.String): J
public final /*synthesized*/ fun values(): kotlin.Array<J>
}
@@ -13026,6 +13026,36 @@ public class JetDiagnosticsTestGenerated extends AbstractJetDiagnosticsTest {
doTest(fileName);
}
@TestMetadata("ExhaustivePlatformEnum.kt")
public void testExhaustivePlatformEnum() throws Exception {
String fileName = JetTestUtils.navigationMetadata("compiler/testData/diagnostics/tests/when/ExhaustivePlatformEnum.kt");
doTest(fileName);
}
@TestMetadata("ExhaustivePlatformEnumAnnotated.kt")
public void testExhaustivePlatformEnumAnnotated() throws Exception {
String fileName = JetTestUtils.navigationMetadata("compiler/testData/diagnostics/tests/when/ExhaustivePlatformEnumAnnotated.kt");
doTest(fileName);
}
@TestMetadata("ExhaustivePlatformEnumElse.kt")
public void testExhaustivePlatformEnumElse() throws Exception {
String fileName = JetTestUtils.navigationMetadata("compiler/testData/diagnostics/tests/when/ExhaustivePlatformEnumElse.kt");
doTest(fileName);
}
@TestMetadata("ExhaustivePlatformEnumNull.kt")
public void testExhaustivePlatformEnumNull() throws Exception {
String fileName = JetTestUtils.navigationMetadata("compiler/testData/diagnostics/tests/when/ExhaustivePlatformEnumNull.kt");
doTest(fileName);
}
@TestMetadata("ExhaustivePlatformEnumStatement.kt")
public void testExhaustivePlatformEnumStatement() throws Exception {
String fileName = JetTestUtils.navigationMetadata("compiler/testData/diagnostics/tests/when/ExhaustivePlatformEnumStatement.kt");
doTest(fileName);
}
@TestMetadata("ExhaustiveReturn.kt")
public void testExhaustiveReturn() throws Exception {
String fileName = JetTestUtils.navigationMetadata("compiler/testData/diagnostics/tests/when/ExhaustiveReturn.kt");
@@ -13086,6 +13116,12 @@ public class JetDiagnosticsTestGenerated extends AbstractJetDiagnosticsTest {
doTest(fileName);
}
@TestMetadata("NonExhaustivePlatformEnum.kt")
public void testNonExhaustivePlatformEnum() throws Exception {
String fileName = JetTestUtils.navigationMetadata("compiler/testData/diagnostics/tests/when/NonExhaustivePlatformEnum.kt");
doTest(fileName);
}
@TestMetadata("PropertyNotInitialized.kt")
public void testPropertyNotInitialized() throws Exception {
String fileName = JetTestUtils.navigationMetadata("compiler/testData/diagnostics/tests/when/PropertyNotInitialized.kt");