contentEquals, contentHashCode, contentToString: Add js implementation and tests

#KT-13582

libraries/stdlib/test/collections/ArraysTest.kt

@@ -23,15 +23,15 @@ import kotlin.test.*
 import org.junit.Test as test
 import kotlin.comparisons.*
 
-fun <T> assertArrayNotSameButEquals(expected: Array<out T>, actual: Array<out T>, message: String = "") { assertTrue(expected !== actual, message); assertEquals(expected.toList(), actual.toList(), message) }
-fun assertArrayNotSameButEquals(expected: IntArray, actual: IntArray, message: String = "") { assertTrue(expected !== actual, message); assertEquals(expected.toList(), actual.toList(), message) }
-fun assertArrayNotSameButEquals(expected: LongArray, actual: LongArray, message: String = "") { assertTrue(expected !== actual, message); assertEquals(expected.toList(), actual.toList(), message) }
-fun assertArrayNotSameButEquals(expected: ShortArray, actual: ShortArray, message: String = "") { assertTrue(expected !== actual, message); assertEquals(expected.toList(), actual.toList(), message) }
-fun assertArrayNotSameButEquals(expected: ByteArray, actual: ByteArray, message: String = "") { assertTrue(expected !== actual, message); assertEquals(expected.toList(), actual.toList(), message) }
-fun assertArrayNotSameButEquals(expected: DoubleArray, actual: DoubleArray, message: String = "") { assertTrue(expected !== actual, message); assertEquals(expected.toList(), actual.toList(), message) }
-fun assertArrayNotSameButEquals(expected: FloatArray, actual: FloatArray, message: String = "") { assertTrue(expected !== actual, message); assertEquals(expected.toList(), actual.toList(), message) }
-fun assertArrayNotSameButEquals(expected: CharArray, actual: CharArray, message: String = "") { assertTrue(expected !== actual, message); assertEquals(expected.toList(), actual.toList(), message) }
-fun assertArrayNotSameButEquals(expected: BooleanArray, actual: BooleanArray, message: String = "") { assertTrue(expected !== actual, message); assertEquals(expected.toList(), actual.toList(), message) }
+fun <T> assertArrayNotSameButEquals(expected: Array<out T>, actual: Array<out T>, message: String = "") { assertTrue(expected !== actual && expected contentEquals actual, message); }
+fun assertArrayNotSameButEquals(expected: IntArray, actual: IntArray, message: String = "") {             assertTrue(expected !== actual && expected contentEquals actual, message); }
+fun assertArrayNotSameButEquals(expected: LongArray, actual: LongArray, message: String = "") {           assertTrue(expected !== actual && expected contentEquals actual, message); }
+fun assertArrayNotSameButEquals(expected: ShortArray, actual: ShortArray, message: String = "") {         assertTrue(expected !== actual && expected contentEquals actual, message); }
+fun assertArrayNotSameButEquals(expected: ByteArray, actual: ByteArray, message: String = "") {           assertTrue(expected !== actual && expected contentEquals actual, message); }
+fun assertArrayNotSameButEquals(expected: DoubleArray, actual: DoubleArray, message: String = "") {       assertTrue(expected !== actual && expected contentEquals actual, message); }
+fun assertArrayNotSameButEquals(expected: FloatArray, actual: FloatArray, message: String = "") {         assertTrue(expected !== actual && expected contentEquals actual, message); }
+fun assertArrayNotSameButEquals(expected: CharArray, actual: CharArray, message: String = "") {           assertTrue(expected !== actual && expected contentEquals actual, message); }
+fun assertArrayNotSameButEquals(expected: BooleanArray, actual: BooleanArray, message: String = "") {     assertTrue(expected !== actual && expected contentEquals actual, message); }
 
 
 class ArraysTest {
@@ -203,6 +203,45 @@ class ArraysTest {
         assertEquals(false, arr[1])
     }
 
+    @test fun contentEquals() {
+        val arr1 = arrayOf("a", 1, null)
+        val arr2 = arrayOf(*arr1)
+        assertTrue(arr1 contentEquals arr2)
+        val arr3 = arr2.reversedArray()
+        assertFalse(arr1 contentEquals arr3)
+    }
+
+    @test fun contentDeepEquals() {
+        val arr1 = arrayOf("a", 1, intArrayOf(2))
+        val arr2 = arrayOf("a", 1, intArrayOf(2))
+        assertFalse(arr1 contentEquals arr2)
+        assertTrue(arr1 contentDeepEquals arr2)
+        arr2[2] = arr1
+        assertFalse(arr1 contentDeepEquals arr2)
+    }
+
+    @test fun contentToString() {
+        val arr = arrayOf("a", 1, null)
+        assertEquals(arr.asList().toString(), arr.contentToString())
+    }
+
+    @test fun contentDeepToString() {
+        val arr = arrayOf("aa", 1, null, charArrayOf('d'))
+        assertEquals("[aa, 1, null, [d]]", arr.contentDeepToString())
+    }
+
+    @test fun contentHashCode() {
+        val arr = arrayOf("a", 1, null)
+        assertEquals(arr.asList().hashCode(), arr.contentHashCode())
+    }
+
+    @test fun contentDeepHashCode() {
+        val arr = arrayOf<Any?>("aa", 1, null, charArrayOf('d'))
+        val list = arr.map { if (it is CharArray) it.asList() else it }
+        assertEquals(list.hashCode(), arr.contentDeepHashCode())
+    }
+
+
     @test fun min() {
         expect(null, { arrayOf<Int>().min() })
         expect(1, { arrayOf(1).min() })

libraries/tools/kotlin-stdlib-gen/src/templates/SpecialJS.kt

@@ -165,6 +165,85 @@ fun specialJS(): List<GenericFunction> {
         }
     }
 
+    templates add f("contentEquals(other: SELF)") {
+        only(ArraysOfObjects, ArraysOfPrimitives)
+        infix(true)
+        doc {
+            """
+            Returns `true` if the two specified arrays are *structurally* equal to one another,
+            i.e. contain the same number of the same elements in the same order.
+            """
+        }
+        annotations("""@library("arrayEquals")""")
+        returns("Boolean")
+        body { "return noImpl" }
+    }
+
+    templates add f("contentDeepEquals(other: SELF)") {
+        only(ArraysOfObjects)
+        infix(true)
+        doc {
+            """
+            Returns `true` if the two specified arrays are *deeply* equal to one another,
+            i.e. contain the same number of the same elements in the same order.
+
+            If two corresponding elements are nested arrays, they are also compared deeply.
+            If any of arrays contains itself on any nesting level the behavior is undefined.
+            """
+        }
+        annotations("""@library("arrayDeepEquals")""")
+        returns("Boolean")
+        body { "return noImpl" }
+    }
+
+    templates add f("contentToString()") {
+        only(ArraysOfObjects, ArraysOfPrimitives)
+        doc { "Returns a string representation of the contents of the specified array as if it is [List]." }
+        annotations("""@library("arrayToString")""")
+        returns("String")
+        body { "return noImpl" }
+    }
+
+    templates add f("contentDeepToString()") {
+        only(ArraysOfObjects)
+        doc {
+            """
+            Returns a string representation of the contents of this array as if it is [List].
+
+            Nested arrays are treated as lists too.
+            """
+        }
+        annotations("""@library("arrayToString")""") // arrayToString is already deep
+        returns("String")
+        body { "return noImpl" }
+    }
+
+    templates add f("contentHashCode()") {
+        only(ArraysOfObjects, ArraysOfPrimitives)
+        doc {
+            "Returns a hash code based on the contents of this array as if it is [List]."
+        }
+        annotations("""@library("arrayHashCode")""")
+        returns("Int")
+        body { "return noImpl" }
+    }
+
+    templates add f("contentDeepHashCode()") {
+        only(ArraysOfObjects)
+        doc {
+            """
+            Returns a hash code based on the contents of this array as if it is [List].
+
+            Nested arrays are treated as lists too.
+            If any of arrays contains itself on any nesting level the behavior is undefined.
+            """
+        }
+        annotations("""@library("arrayDeepHashCode")""")
+        returns("Int")
+        body { "return noImpl" }
+    }
+
+
     templates add f("sort(comparison: (T, T) -> Int)") {
         only(ArraysOfObjects, ArraysOfPrimitives)
         exclude(PrimitiveType.Boolean)