refactor: add targeted key appearance update mechanism

Author: ENOA-REIAH-UION

app/src/main/java/com/osfans/trime/ime/broadcast/InputBroadcastReceiver.kt

@@ -16,10 +16,7 @@ import com.osfans.trime.ime.window.BoardWindow
 interface InputBroadcastReceiver {
     fun onStartInput(info: EditorInfo) {}
 
-    fun onSelectionUpdate(
-        start: Int,
-        end: Int,
-    ) {}
+    fun onSelectionUpdate(start: Int, end: Int) {}
 
     fun onRimeSchemaUpdated(schema: SchemaItem) {}
 
@@ -31,6 +28,8 @@ interface InputBroadcastReceiver {
 
     fun onCandidateMenuUpdate(data: MenuProto) {}
 
+    fun onKeyAppearanceUpdate(composing: Boolean, menu: Boolean) {}
+
     fun onInputStatusUpdate(value: StatusProto) {}
 
     fun onWindowAttached(window: BoardWindow) {}

app/src/main/java/com/osfans/trime/ime/broadcast/InputBroadcaster.kt

@@ -66,6 +66,10 @@ class InputBroadcaster : InputBroadcastReceiver {
         receivers.forEach { it.onCandidateMenuUpdate(data) }
     }
 
+    override fun onKeyAppearanceUpdate(composing: Boolean, menu: Boolean) {
+        receivers.forEach { it.onKeyAppearanceUpdate(composing, menu) }
+    }
+
     override fun onInputStatusUpdate(value: StatusProto) {
         receivers.forEach { it.onInputStatusUpdate(value) }
     }

app/src/main/java/com/osfans/trime/ime/core/InputView.kt

@@ -117,6 +117,19 @@ class InputView(
             return dp(value)
         }
 
+    private var lastAppearanceState = Triple(false, false, false)
+
+    private fun broadcastKeyAppearanceUpdate() {
+        val composing = rime.run { statusCached.isComposing }
+        val hasMenu = rime.run { hasMenu }
+        val paging = rime.run { paging }
+        val current = Triple(composing, hasMenu, paging)
+        if (current != lastAppearanceState) {
+            lastAppearanceState = current
+            broadcaster.onKeyAppearanceUpdate(current.first, current.second)
+        }
+    }
+
     private val keyboardBottomPaddingPx: Int
         get() {
             val value =
@@ -317,6 +330,7 @@ class InputView(
             }
             else -> {}
         }
+        broadcastKeyAppearanceUpdate()
     }
 
     fun updateSelection(

app/src/main/java/com/osfans/trime/ime/keyboard/Key.kt

@@ -20,6 +20,8 @@ class Key(
 ) {
     private val rime get() = RimeDaemon.getFirstSessionOrNull()!!
 
+    var index: Int = -1
+
     val keyActions: Map<KeyBehavior, KeyAction> =
         buildMap {
             selfConfig?.behaviors?.forEach {
@@ -110,9 +112,9 @@ class Key(
 
     init {
         if (selfConfig != null) {
-            val hasComposingKey = selfConfig.behaviors.keys.any { it < KeyBehavior.COMBO }
-            if (hasComposingKey) parent.composingKeys.add(this)
-            sendBindings = selfConfig.sendBindings || hasComposingKey
+            val hasStateDependentBehavior = selfConfig.behaviors.keys.any { it < KeyBehavior.COMBO }
+            if (hasStateDependentBehavior) parent.appearanceStateKeys.add(this)
+            sendBindings = selfConfig.sendBindings || hasStateDependentBehavior
         } else {
             sendBindings = true
         }

app/src/main/java/com/osfans/trime/ime/keyboard/Keyboard.kt

@@ -83,7 +83,7 @@ class Keyboard(
 
     /** List of keys in this keyboard  */
     private val mKeys = mutableListOf<Key>()
-    val composingKeys = mutableListOf<Key>()
+    val appearanceStateKeys = mutableListOf<Key>()
     var modifier = 0
         private set
 
@@ -322,7 +322,8 @@ class Keyboard(
 
             height = yPos + currentRowHeight
 
-            for (key in mKeys) {
+            mKeys.forEachIndexed { index, key ->
+                key.index = index
                 if (key.column == 0) key.edgeFlags = key.edgeFlags or EDGE_LEFT
                 if (key.row == 0) key.edgeFlags = key.edgeFlags or EDGE_TOP
                 if (key.row == row) key.edgeFlags = key.edgeFlags or EDGE_BOTTOM

app/src/main/java/com/osfans/trime/ime/keyboard/KeyboardView.kt

@@ -88,6 +88,10 @@ class KeyboardView(
         children.forEach { it.invalidate() }
     }
 
+    fun invalidateKeyByIndex(index: Int) {
+        children.find { it.id == index }?.invalidate()
+    }
+
     val isCapsOn: Boolean
         get() = keyboard.mShiftKey?.isOn == true
 

app/src/main/java/com/osfans/trime/ime/keyboard/KeyboardWindow.kt

@@ -75,7 +75,6 @@ class KeyboardWindow :
     private var currentKeyboardId = ""
     private var lastKeyboardId = ""
     private var lastLockKeyboardId = ""
-    private var lastComposing = true
     private val cachedKeyboards = mutableMapOf<String, Pair<Keyboard, KeyboardView>>()
     private val currentKeyboard: Keyboard? get() = cachedKeyboards[currentKeyboardId]?.first
     private val currentKeyboardView: KeyboardView? get() = cachedKeyboards[currentKeyboardId]?.second
@@ -266,12 +265,11 @@ class KeyboardWindow :
         }
     }
 
-    override fun onCompositionUpdate(data: CompositionProto) {
-        val status = rime.run { statusCached }
-        val isComposing = status.isComposing
-        if (!status.isAsciiMode && lastComposing != isComposing) {
-            lastComposing = isComposing
-            currentKeyboardView?.invalidateAllKeys()
+    override fun onKeyAppearanceUpdate(composing: Boolean, menu: Boolean) {
+        if (!rime.run { statusCached }.isAsciiMode) {
+            currentKeyboard?.appearanceStateKeys?.forEach { key ->
+                currentKeyboardView?.invalidateKeyByIndex(key.index)
+            }
         }
     }