API: EmojiInformation#visualLength to get text length respecting that…

… an Emoji can consist of multiple characters.

emoji-ios/src/commonTest/kotlin/com/vanniktech/emoji/ios/EmojiInformationTest.kt

@@ -0,0 +1,114 @@
+package com.vanniktech.emoji.ios
+
+import com.vanniktech.emoji.EmojiManager
+import com.vanniktech.emoji.emojiInformation
+import kotlin.test.BeforeTest
+import kotlin.test.Test
+import kotlin.test.assertEquals
+import kotlin.test.assertNotEquals
+
+class EmojiInformationTest {
+  @BeforeTest fun setUp() {
+    EmojiManager.install(emojiProvider())
+  }
+
+  @Test fun empty() {
+    val text = " "
+    val emojiInformation = text.emojiInformation()
+    assertEquals(expected = text.length, actual = emojiInformation.visualLength)
+    assertEquals(expected = false, actual = emojiInformation.isOnlyEmojis)
+    assertEquals(expected = 0, actual = emojiInformation.emojis.size)
+  }
+
+  @Test fun plain() {
+    val text = "Hello World!"
+    val emojiInformation = text.emojiInformation()
+    assertEquals(expected = text.length, actual = emojiInformation.visualLength)
+    assertEquals(expected = false, actual = emojiInformation.isOnlyEmojis)
+    assertEquals(expected = 0, actual = emojiInformation.emojis.size)
+  }
+
+  @Test fun femaleTinted() {
+    val mage1 = """🧙‍♀️"""
+    val mage2 = """🧙🏿‍♀️"""
+    val text = "$mage1$mage2"
+    val emojiInformation = text.emojiInformation()
+    assertEquals(expected = 2, actual = emojiInformation.visualLength)
+    assertEquals(expected = true, actual = emojiInformation.isOnlyEmojis)
+    assertEquals(expected = 2, actual = emojiInformation.emojis.size)
+
+    assertEquals(expected = 0..4, actual = emojiInformation.emojis[0].range)
+    assertEquals(expected = mage1, actual = text.substring(emojiInformation.emojis[0].range))
+    assertEquals(expected = mage1, actual = emojiInformation.emojis[0].emoji.unicode)
+
+    assertEquals(expected = 5..11, actual = emojiInformation.emojis[1].range)
+    assertEquals(expected = mage2, actual = text.substring(emojiInformation.emojis[1].range))
+    assertEquals(expected = mage2, actual = emojiInformation.emojis[1].emoji.unicode)
+  }
+
+  @Test fun mixed() {
+    val hamburger = """🍔"""
+    val cheese = """🧀"""
+    val text = """I like $hamburger with lots of $cheese"""
+    val emojiInformation = text.emojiInformation()
+    assertEquals(expected = 23, actual = emojiInformation.visualLength)
+    assertEquals(expected = false, actual = emojiInformation.isOnlyEmojis)
+    assertEquals(expected = 2, actual = emojiInformation.emojis.size)
+
+    assertEquals(expected = 7..8, actual = emojiInformation.emojis[0].range)
+    assertEquals(expected = hamburger, actual = text.substring(emojiInformation.emojis[0].range))
+    assertEquals(expected = hamburger, actual = emojiInformation.emojis[0].emoji.unicode)
+
+    assertEquals(expected = 23..24, actual = emojiInformation.emojis[1].range)
+    assertEquals(expected = cheese, actual = text.substring(emojiInformation.emojis[1].range))
+    assertEquals(expected = cheese, actual = emojiInformation.emojis[1].emoji.unicode)
+  }
+
+  @Test fun single() {
+    val emojis = listOf(
+      """⭐""",
+      """🗯""",
+      """🗨""",
+      """🕳""",
+      """❤️""",
+      """❣️""",
+      """🧑‍🎤""",
+      """🎗️""",
+      """🎟️""",
+      """⛸️""",
+    )
+
+    emojis.forEach {
+      val prefixed = "f$it".emojiInformation()
+      assertEquals(message = it, expected = 2, actual = prefixed.visualLength)
+      assertEquals(message = it, expected = 1, actual = prefixed.emojis.size)
+      assertEquals(message = it, expected = false, actual = prefixed.isOnlyEmojis)
+
+      val postfixed = "${it}f".emojiInformation()
+      assertEquals(message = it, expected = 2, actual = postfixed.visualLength)
+      assertEquals(message = it, expected = 1, actual = postfixed.emojis.size)
+      assertEquals(message = it, expected = false, actual = postfixed.isOnlyEmojis)
+
+      val single = it.emojiInformation()
+      assertEquals(message = it, expected = 1, actual = single.visualLength)
+      assertEquals(message = it, expected = 1, actual = single.emojis.size)
+      assertEquals(message = it, expected = true, actual = single.isOnlyEmojis)
+
+      val triple = "$it$it$it".emojiInformation()
+      assertEquals(message = it, expected = 3, actual = triple.visualLength)
+      assertEquals(message = it, expected = 3, actual = triple.emojis.size)
+      assertEquals(message = it, expected = true, actual = triple.isOnlyEmojis)
+
+      val spaces = "$it $it".emojiInformation()
+      assertEquals(message = it, expected = 3, actual = spaces.visualLength)
+      assertEquals(message = it, expected = 2, actual = spaces.emojis.size)
+      assertEquals(message = it, expected = true, actual = spaces.isOnlyEmojis)
+
+      assertEquals(expected = triple, actual = triple)
+      assertEquals(expected = triple.hashCode(), actual = triple.hashCode())
+
+      assertNotEquals(illegal = single, actual = triple)
+      assertNotEquals(illegal = single.hashCode(), actual = triple.hashCode())
+    }
+  }
+}

emoji/src/commonMain/kotlin/com/vanniktech/emoji/EmojiInformation.kt

@@ -19,6 +19,11 @@ package com.vanniktech.emoji
 import kotlin.jvm.JvmField
 
 data class EmojiInformation internal constructor(
+  /**
+   * The visual length with respect to the found [emojis].
+   * One [Emoji] can be made up of a bunch of characters but still displayed as a single one.
+   */
+  @JvmField val visualLength: Int,
   @JvmField val isOnlyEmojis: Boolean,
   @JvmField val emojis: List<EmojiRange>,
 )

emoji/src/commonMain/kotlin/com/vanniktech/emoji/Emojis.kt

@@ -33,14 +33,12 @@ fun CharSequence?.isOnlyEmojis(): Boolean {
     return false
   }
 
-  EmojiManager.verifyInstalled()
   val inputWithoutSpaces = replace(SPACE_REMOVAL, "")
   return EmojiManager.emojiPattern!!.findAll(inputWithoutSpaces)
     .map { it.range }
     .toList()
     .reversed()
     .fold(inputWithoutSpaces) { string, range -> string.removeRange(range) }
-    .filterNot { it == VARIANT_SELECTOR_16 }
     .isEmpty()
 }
 
@@ -53,9 +51,12 @@ fun CharSequence?.emojisCount() = emojis().size
 /** Returns a class that contains all of the emoji information that was found in the given text. */
 fun CharSequence?.emojiInformation(): EmojiInformation {
   val emojis = emojis()
-  val isOnlyEmojis = isOnlyEmojis()
   return EmojiInformation(
-    isOnlyEmojis = isOnlyEmojis,
+    visualLength = (this?.length ?: 0) - emojis.sumOf { it.range.last + 1 - it.range.first } + emojis.size,
+    isOnlyEmojis = when (isNullOrBlank()) {
+      true -> false
+      false -> emojis.reversed().fold(this) { string, emojiRange -> string.removeRange(emojiRange.range) }.isBlank()
+    },
     emojis = emojis,
   )
 }