Support of custom 'equals' and 'hashCode' in inline classes

'equals' from any made available for overriding in inline classes
'typed' equals made available for definition in inline classes
'typed' equals definition made compulsory if 'untyped' is overridden
'operator' keyword is allowed in 'typed' equals definition

^KT-24874: Fixed

compiler/testData/codegen/box/inlineClasses/inlineClassBothEqualsOverride.kt

@@ -0,0 +1,55 @@
+// WITH_STDLIB
+// WORKS_WHEN_VALUE_CLASS
+// LANGUAGE: +ValueClasses, +CustomEqualsInInlineClasses
+// TARGET_BACKEND: JVM_IR
+
+
+interface I {
+    fun getVal(): Int
+}
+
+OPTIONAL_JVM_INLINE_ANNOTATION
+value class IC1(val x: Int) : I {
+    override fun getVal(): Int {
+        return x
+    }
+
+    fun equals(other: IC1): Boolean {
+        return x == other.x
+    }
+
+    override fun equals(other: Any?): Boolean {
+        if (other !is I) {
+            return false
+        }
+        return getVal() == other.getVal()
+    }
+
+    override fun hashCode(): Int {
+        return getVal()
+    }
+}
+
+OPTIONAL_JVM_INLINE_ANNOTATION
+value class IC2(val y: Int) : I {
+    override fun getVal(): Int {
+        return y * 10
+    }
+
+    fun equals(other: IC2): Boolean {
+        return y == other.y
+    }
+
+    override fun equals(other: Any?): Boolean {
+        if (other !is I) {
+            return false
+        }
+        return getVal() == other.getVal()
+    }
+
+    override fun hashCode(): Int {
+        return getVal()
+    }
+}
+
+fun box(): String = if (setOf(IC1(10), IC2(1)).size == 1) "OK" else "Fail"

compiler/testData/codegen/box/inlineClasses/inlineClassEqualsConsistency.kt

@@ -0,0 +1,47 @@
+// WITH_STDLIB
+// WORKS_WHEN_VALUE_CLASS
+// LANGUAGE: +ValueClasses, +CustomEqualsInInlineClasses
+// TARGET_BACKEND: JVM_IR
+
+import java.lang.AssertionError
+import kotlin.math.abs
+
+OPTIONAL_JVM_INLINE_ANNOTATION
+value class IC1(val x: Double) {
+    fun equals(other: IC1): Boolean {
+        return abs(x - other.x) < 0.5
+    }
+}
+
+OPTIONAL_JVM_INLINE_ANNOTATION
+value class IC2(val x: Int) {
+    override fun equals(other: Any?): Boolean {
+        if (other !is IC2) {
+            return false
+        }
+        return abs(x - other.x) < 2
+    }
+}
+
+fun box(): String {
+    val a1Typed: IC1 = IC1(1.0)
+    val b1Typed: IC1 = IC1(1.1)
+    val c1Typed: IC1 = IC1(5.0)
+    val a1Untyped: Any = a1Typed
+    val b1Untyped: Any = b1Typed
+    val c1Untyped: Any = c1Typed
+
+    val a2Typed: IC2 = IC2(1)
+    val b2Typed: IC2 = IC2(2)
+    val c2Typed: IC2 = IC2(5)
+    val a2Untyped: Any = a2Typed
+    val b2Untyped: Any = b2Typed
+    val c2Untyped: Any = c2Typed
+
+    if ((a1Typed == b1Typed) != (a1Untyped == b1Untyped)) throw AssertionError()
+    if ((a1Typed == c1Typed) != (a1Untyped == c1Untyped)) throw AssertionError()
+    if ((a2Typed == b2Typed) != (a2Untyped == b2Untyped)) throw AssertionError()
+    if ((a2Typed == c2Typed) != (a2Untyped == c2Untyped)) throw AssertionError()
+
+    return "OK"
+}

compiler/testData/codegen/box/inlineClasses/inlineClassEqualsOverride.kt

@@ -0,0 +1,35 @@
+// WITH_STDLIB
+// WORKS_WHEN_VALUE_CLASS
+// LANGUAGE: +ValueClasses, +CustomEqualsInInlineClasses
+// TARGET_BACKEND: JVM_IR
+
+import kotlin.math.abs
+
+OPTIONAL_JVM_INLINE_ANNOTATION
+value class IC1(val value: Double) {
+    fun equals(other: IC1): Boolean {
+        return abs(value - other.value) < 0.1
+    }
+}
+
+interface I {
+    fun equals(param: IC2): Boolean
+}
+
+OPTIONAL_JVM_INLINE_ANNOTATION
+value class IC2(val value: Int) : I {
+    override fun equals(param: IC2): Boolean {
+        return abs(value - param.value) < 2
+    }
+}
+
+OPTIONAL_JVM_INLINE_ANNOTATION
+value class IC3(val value: Int) {
+
+}
+
+fun box() =
+    if (IC1(1.0) == IC1(1.05) && IC1(1.0) != IC1(1.2)
+        && IC2(5) == IC2(6) && IC2(5) != IC2(7)
+        && IC3(5) == IC3(5) && IC3(5) != IC3(6)
+        && IC1(1.0) != Any()) "OK" else "Fail"

compiler/testData/codegen/box/inlineClasses/inlineClassEqualsOverridenForCollections.kt

@@ -0,0 +1,22 @@
+// WITH_STDLIB
+// WORKS_WHEN_VALUE_CLASS
+// LANGUAGE: +ValueClasses, +CustomEqualsInInlineClasses
+// TARGET_BACKEND: JVM_IR
+
+import kotlin.math.abs
+
+OPTIONAL_JVM_INLINE_ANNOTATION
+value class IC(val x: Double) {
+    fun equals(other: IC): Boolean {
+        return abs(x - other.x) < 0.1
+    }
+
+    override fun hashCode(): Int {
+        return 0
+    }
+}
+
+fun box(): String {
+    val set = setOf(IC(1.0), IC(1.5), IC(1.501))
+    return if (set.size == 2) "OK" else "Fail"
+}

compiler/testData/codegen/box/inlineClasses/inlineClassHashCodeOverride.kt

@@ -0,0 +1,14 @@
+// WITH_STDLIB
+// WORKS_WHEN_VALUE_CLASS
+// LANGUAGE: +ValueClasses, +CustomEqualsInInlineClasses
+
+OPTIONAL_JVM_INLINE_ANNOTATION
+value class A(val value: MyClass) {
+    override fun hashCode() = 42
+}
+
+class MyClass() {
+    override fun hashCode() = -1
+}
+
+fun box(): String = if (A(MyClass()).hashCode() == 42) "OK" else "Fail"

compiler/testData/codegen/box/inlineClasses/inlineClassUntypedEqualsOverriden.kt

@@ -0,0 +1,23 @@
+// WITH_STDLIB
+// WORKS_WHEN_VALUE_CLASS
+// LANGUAGE: +ValueClasses, +CustomEqualsInInlineClasses
+// TARGET_BACKEND: JVM_IR
+
+import kotlin.math.abs
+
+OPTIONAL_JVM_INLINE_ANNOTATION
+value class IC(val x: Int) {
+    override fun equals(other: Any?): Boolean {
+        if (other !is IC) {
+            return false
+        }
+        return abs(x - other.x) < 2
+    }
+
+    override fun hashCode() = 0
+}
+
+fun box(): String {
+    val set = setOf(IC(1), IC(2), IC(5))
+    return if (set.size == 2 && IC(1) == IC(1) && IC(1) == IC(2) && IC(1) != IC(5)) "OK" else "Fail"
+}

compiler/testData/codegen/box/inlineClasses/inlineClassWithCustomEquals.kt

@@ -1,7 +1,4 @@
-// IGNORE_BACKEND_FIR: JVM_IR
-// FIR status: not supported in JVM
 // IGNORE_BACKEND: JVM
-// IGNORE_BACKEND: JVM_IR
 // WITH_STDLIB
 // WORKS_WHEN_VALUE_CLASS
 // LANGUAGE: +ValueClasses

compiler/testData/codegen/box/inlineClasses/inlineClassWithCustomEqualsGeneric.kt

@@ -1,7 +1,4 @@
-// IGNORE_BACKEND_FIR: JVM_IR
-// FIR status: not supported in JVM
 // IGNORE_BACKEND: JVM
-// IGNORE_BACKEND: JVM_IR
 // WITH_STDLIB
 // WORKS_WHEN_VALUE_CLASS
 // LANGUAGE: +ValueClasses, +GenericInlineClassParameter

compiler/testData/diagnostics/tests/inlineClasses/illegalEqualsOverridingInInlineClass.kt

@@ -0,0 +1,28 @@
+// FIR_IDENTICAL
+// WITH_STDLIB
+// !DIAGNOSTICS: -DEBUG_INFO_SMARTCAST
+// LANGUAGE: +CustomEqualsInInlineClasses
+
+@JvmInline
+value class IC1(val x: Int) {
+    <!INEFFICIENT_EQUALS_OVERRIDING_IN_INLINE_CLASS!>override fun equals(other: Any?): Boolean<!> {
+        if (other !is IC1) {
+            return false
+        }
+        return x == other.x
+    }
+}
+
+@JvmInline
+value class IC2(val x: Int) {
+    override fun hashCode() = 0
+}
+
+@JvmInline
+value class IC3(val x: Int) {
+    override fun equals(other: Any?) = true
+
+    fun equals(other: IC3) = true
+
+    override fun hashCode() = 0
+}

compiler/testData/diagnostics/tests/inlineClasses/illegalEqualsOverridingInInlineClass.txt

@@ -0,0 +1,26 @@
+package
+
+@kotlin.jvm.JvmInline public final value class IC1 {
+    public constructor IC1(/*0*/ x: kotlin.Int)
+    public final val x: kotlin.Int
+    public open override /*1*/ fun equals(/*0*/ other: kotlin.Any?): kotlin.Boolean
+    public open override /*1*/ /*synthesized*/ fun hashCode(): kotlin.Int
+    public open override /*1*/ /*synthesized*/ fun toString(): kotlin.String
+}
+
+@kotlin.jvm.JvmInline public final value class IC2 {
+    public constructor IC2(/*0*/ x: kotlin.Int)
+    public final val x: kotlin.Int
+    public open override /*1*/ /*synthesized*/ fun equals(/*0*/ other: kotlin.Any?): kotlin.Boolean
+    public open override /*1*/ fun hashCode(): kotlin.Int
+    public open override /*1*/ /*synthesized*/ fun toString(): kotlin.String
+}
+
+@kotlin.jvm.JvmInline public final value class IC3 {
+    public constructor IC3(/*0*/ x: kotlin.Int)
+    public final val x: kotlin.Int
+    public final fun equals(/*0*/ other: IC3): kotlin.Boolean
+    public open override /*1*/ fun equals(/*0*/ other: kotlin.Any?): kotlin.Boolean
+    public open override /*1*/ fun hashCode(): kotlin.Int
+    public open override /*1*/ /*synthesized*/ fun toString(): kotlin.String
+}

compiler/testData/diagnostics/tests/inlineClasses/reservedMembersAndConstructsInsideInlineClass.fir.kt

@@ -1,4 +1,4 @@
-// !LANGUAGE: +InlineClasses, -JvmInlineValueClasses
+// !LANGUAGE: +InlineClasses, -JvmInlineValueClasses, +CustomEqualsInInlineClasses
 // !DIAGNOSTICS: -UNUSED_PARAMETER
 
 inline class IC1(val x: Any) {
@@ -8,8 +8,8 @@ inline class IC1(val x: Any) {
     fun <!RESERVED_MEMBER_INSIDE_VALUE_CLASS!>unbox<!>() {}
     fun <!RESERVED_MEMBER_INSIDE_VALUE_CLASS!>unbox<!>(x: Any) {}
 
-    override fun <!RESERVED_MEMBER_INSIDE_VALUE_CLASS!>equals<!>(other: Any?): Boolean = true
-    override fun <!RESERVED_MEMBER_INSIDE_VALUE_CLASS!>hashCode<!>(): Int = 0
+    <!INEFFICIENT_EQUALS_OVERRIDING_IN_INLINE_CLASS!>override fun equals(other: Any?): Boolean<!> = true
+    override fun hashCode(): Int = 0
 }
 
 inline class IC2(val x: Any) {
@@ -19,15 +19,15 @@ inline class IC2(val x: Any) {
     fun <!RESERVED_MEMBER_INSIDE_VALUE_CLASS!>unbox<!>(x: Any) {}
     fun <!RESERVED_MEMBER_INSIDE_VALUE_CLASS!>unbox<!>(): Any = TODO()
 
-    fun <!RESERVED_MEMBER_INSIDE_VALUE_CLASS!>equals<!>(my: Any, other: Any): Boolean = true
-    fun <!RESERVED_MEMBER_INSIDE_VALUE_CLASS!>hashCode<!>(a: Any): Int = 0
+    fun equals(my: Any, other: Any): Boolean = true
+    fun hashCode(a: Any): Int = 0
 }
 
 inline class IC3(val x: Any) {
     fun <!RESERVED_MEMBER_INSIDE_VALUE_CLASS!>box<!>(x: Any): Any = TODO()
     fun <!RESERVED_MEMBER_INSIDE_VALUE_CLASS!>unbox<!>(x: Any): Any = TODO()
 
-    fun <!RESERVED_MEMBER_INSIDE_VALUE_CLASS!>equals<!>(): Boolean = true
+    fun equals(): Boolean = true
 }
 
 interface WithBox {

compiler/testData/diagnostics/tests/inlineClasses/reservedMembersAndConstructsInsideInlineClass.kt

@@ -1,4 +1,4 @@
-// !LANGUAGE: +InlineClasses, -JvmInlineValueClasses
+// !LANGUAGE: +InlineClasses, -JvmInlineValueClasses, +CustomEqualsInInlineClasses
 // !DIAGNOSTICS: -UNUSED_PARAMETER
 
 inline class IC1(val x: Any) {
@@ -8,8 +8,8 @@ inline class IC1(val x: Any) {
     fun <!RESERVED_MEMBER_INSIDE_VALUE_CLASS!>unbox<!>() {}
     fun <!RESERVED_MEMBER_INSIDE_VALUE_CLASS!>unbox<!>(x: Any) {}
 
-    override fun <!RESERVED_MEMBER_INSIDE_VALUE_CLASS!>equals<!>(other: Any?): Boolean = true
-    override fun <!RESERVED_MEMBER_INSIDE_VALUE_CLASS!>hashCode<!>(): Int = 0
+    <!INEFFICIENT_EQUALS_OVERRIDING_IN_INLINE_CLASS!>override fun equals(other: Any?): Boolean<!> = true
+    override fun hashCode(): Int = 0
 }
 
 inline class IC2(val x: Any) {
@@ -19,15 +19,15 @@ inline class IC2(val x: Any) {
     fun <!RESERVED_MEMBER_INSIDE_VALUE_CLASS!>unbox<!>(x: Any) {}
     fun <!RESERVED_MEMBER_INSIDE_VALUE_CLASS!>unbox<!>(): Any = TODO()
 
-    fun <!RESERVED_MEMBER_INSIDE_VALUE_CLASS!>equals<!>(my: Any, other: Any): Boolean = true
-    fun <!RESERVED_MEMBER_INSIDE_VALUE_CLASS!>hashCode<!>(a: Any): Int = 0
+    fun equals(my: Any, other: Any): Boolean = true
+    fun hashCode(a: Any): Int = 0
 }
 
 inline class IC3(val x: Any) {
     fun <!RESERVED_MEMBER_INSIDE_VALUE_CLASS!>box<!>(x: Any): Any = TODO()
     fun <!RESERVED_MEMBER_INSIDE_VALUE_CLASS!>unbox<!>(x: Any): Any = TODO()
 
-    fun <!RESERVED_MEMBER_INSIDE_VALUE_CLASS!>equals<!>(): Boolean = true
+    fun equals(): Boolean = true
 }
 
 interface WithBox {

compiler/testData/diagnostics/tests/inlineClasses/typedEqualsOperatorModifierInInlineClass.kt

@@ -0,0 +1,22 @@
+// FIR_IDENTICAL
+// WITH_STDLIB
+// !DIAGNOSTICS: -DEBUG_INFO_SMARTCAST
+// LANGUAGE: +CustomEqualsInInlineClasses
+
+
+@JvmInline
+value class IC1(val x: Int) {
+    override fun equals(other: Any?) = true
+
+    operator fun equals(other: IC1) = true
+
+    override fun hashCode() = 0
+}
+
+@JvmInline
+value class IC2(val x: Int) {
+    <!INAPPLICABLE_OPERATOR_MODIFIER!>operator<!> fun equals(other: IC1) = true
+
+    <!INAPPLICABLE_OPERATOR_MODIFIER!>operator<!> fun equals(other: IC2) {
+    }
+}

compiler/testData/diagnostics/tests/inlineClasses/typedEqualsOperatorModifierInInlineClass.txt

@@ -0,0 +1,20 @@
+package
+
+@kotlin.jvm.JvmInline public final value class IC1 {
+    public constructor IC1(/*0*/ x: kotlin.Int)
+    public final val x: kotlin.Int
+    public final operator fun equals(/*0*/ other: IC1): kotlin.Boolean
+    public open override /*1*/ fun equals(/*0*/ other: kotlin.Any?): kotlin.Boolean
+    public open override /*1*/ fun hashCode(): kotlin.Int
+    public open override /*1*/ /*synthesized*/ fun toString(): kotlin.String
+}
+
+@kotlin.jvm.JvmInline public final value class IC2 {
+    public constructor IC2(/*0*/ x: kotlin.Int)
+    public final val x: kotlin.Int
+    public final operator fun equals(/*0*/ other: IC1): kotlin.Boolean
+    public final operator fun equals(/*0*/ other: IC2): kotlin.Unit
+    public open override /*1*/ /*synthesized*/ fun equals(/*0*/ other: kotlin.Any?): kotlin.Boolean
+    public open override /*1*/ /*synthesized*/ fun hashCode(): kotlin.Int
+    public open override /*1*/ /*synthesized*/ fun toString(): kotlin.String
+}

compiler/testData/diagnostics/tests/valueClasses/reservedMembersAndConstructsInsideValueClass.fir.kt

@@ -1,5 +1,5 @@
 // !SKIP_JAVAC
-// !LANGUAGE: +InlineClasses
+// !LANGUAGE: +InlineClasses, +CustomEqualsInInlineClasses
 // ALLOW_KOTLIN_PACKAGE
 // !DIAGNOSTICS: -UNUSED_PARAMETER
 
@@ -15,8 +15,8 @@ value class IC1(val x: Any) {
     fun <!RESERVED_MEMBER_INSIDE_VALUE_CLASS!>unbox<!>() {}
     fun <!RESERVED_MEMBER_INSIDE_VALUE_CLASS!>unbox<!>(x: Any) {}
 
-    override fun <!RESERVED_MEMBER_INSIDE_VALUE_CLASS!>equals<!>(other: Any?): Boolean = true
-    override fun <!RESERVED_MEMBER_INSIDE_VALUE_CLASS!>hashCode<!>(): Int = 0
+    <!INEFFICIENT_EQUALS_OVERRIDING_IN_INLINE_CLASS!>override fun equals(other: Any?): Boolean<!> = true
+    override fun hashCode(): Int = 0
 }
 
 @JvmInline
@@ -27,8 +27,8 @@ value class IC2(val x: Any) {
     fun <!RESERVED_MEMBER_INSIDE_VALUE_CLASS!>unbox<!>(x: Any) {}
     fun <!RESERVED_MEMBER_INSIDE_VALUE_CLASS!>unbox<!>(): Any = TODO()
 
-    fun <!RESERVED_MEMBER_INSIDE_VALUE_CLASS!>equals<!>(my: Any, other: Any): Boolean = true
-    fun <!RESERVED_MEMBER_INSIDE_VALUE_CLASS!>hashCode<!>(a: Any): Int = 0
+    fun equals(my: Any, other: Any): Boolean = true
+    fun hashCode(a: Any): Int = 0
 }
 
 @JvmInline
@@ -36,7 +36,7 @@ value class IC3(val x: Any) {
     fun <!RESERVED_MEMBER_INSIDE_VALUE_CLASS!>box<!>(x: Any): Any = TODO()
     fun <!RESERVED_MEMBER_INSIDE_VALUE_CLASS!>unbox<!>(x: Any): Any = TODO()
 
-    fun <!RESERVED_MEMBER_INSIDE_VALUE_CLASS!>equals<!>(): Boolean = true
+    fun equals(): Boolean = true
 }
 
 interface WithBox {

compiler/testData/diagnostics/tests/valueClasses/reservedMembersAndConstructsInsideValueClass.kt

@@ -1,5 +1,5 @@
 // !SKIP_JAVAC
-// !LANGUAGE: +InlineClasses
+// !LANGUAGE: +InlineClasses, +CustomEqualsInInlineClasses
 // ALLOW_KOTLIN_PACKAGE
 // !DIAGNOSTICS: -UNUSED_PARAMETER
 
@@ -15,8 +15,8 @@ value class IC1(val x: Any) {
     fun <!RESERVED_MEMBER_INSIDE_VALUE_CLASS!>unbox<!>() {}
     fun <!RESERVED_MEMBER_INSIDE_VALUE_CLASS!>unbox<!>(x: Any) {}
 
-    override fun <!RESERVED_MEMBER_INSIDE_VALUE_CLASS!>equals<!>(other: Any?): Boolean = true
-    override fun <!RESERVED_MEMBER_INSIDE_VALUE_CLASS!>hashCode<!>(): Int = 0
+    <!INEFFICIENT_EQUALS_OVERRIDING_IN_INLINE_CLASS!>override fun equals(other: Any?): Boolean<!> = true
+    override fun hashCode(): Int = 0
 }
 
 @JvmInline
@@ -27,8 +27,8 @@ value class IC2(val x: Any) {
     fun <!RESERVED_MEMBER_INSIDE_VALUE_CLASS!>unbox<!>(x: Any) {}
     fun <!RESERVED_MEMBER_INSIDE_VALUE_CLASS!>unbox<!>(): Any = TODO()
 
-    fun <!RESERVED_MEMBER_INSIDE_VALUE_CLASS!>equals<!>(my: Any, other: Any): Boolean = true
-    fun <!RESERVED_MEMBER_INSIDE_VALUE_CLASS!>hashCode<!>(a: Any): Int = 0
+    fun equals(my: Any, other: Any): Boolean = true
+    fun hashCode(a: Any): Int = 0
 }
 
 @JvmInline
@@ -36,7 +36,7 @@ value class IC3(val x: Any) {
     fun <!RESERVED_MEMBER_INSIDE_VALUE_CLASS!>box<!>(x: Any): Any = TODO()
     fun <!RESERVED_MEMBER_INSIDE_VALUE_CLASS!>unbox<!>(x: Any): Any = TODO()
 
-    fun <!RESERVED_MEMBER_INSIDE_VALUE_CLASS!>equals<!>(): Boolean = true
+    fun equals(): Boolean = true
 }
 
 interface WithBox {