fix: return key from physical keyboard would commit whitespace (#1518)

osfans · Dec 3, 2024 · cdb435c · cdb435c
1 parent 41623f5
commit cdb435c
Show file tree

Hide file tree

Showing 5 changed files with 28 additions and 20 deletions.
diff --git a/app/src/main/java/com/osfans/trime/core/Rime.kt b/app/src/main/java/com/osfans/trime/core/Rime.kt
@@ -79,13 +79,14 @@ class Rime :
         modifiers: UInt,
         code: Int,
         up: Boolean,
+        virtual: Boolean,
     ): Boolean =
         withRimeContext {
             processRimeKey(value, modifiers.toInt()).also {
                 if (it) {
                     ipcResponseCallback()
                 } else {
-                    keyEventCallback(KeyValue(value), KeyModifiers(modifiers), code, up)
+                    keyEventCallback(KeyValue(value), KeyModifiers(modifiers), code, up, virtual)
                 }
             }
         }
@@ -95,13 +96,14 @@ class Rime :
         modifiers: KeyModifiers,
         code: Int,
         up: Boolean,
+        virtual: Boolean,
     ): Boolean =
         withRimeContext {
             processRimeKey(value.value, modifiers.toInt()).also {
                 if (it) {
                     ipcResponseCallback()
                 } else {
-                    keyEventCallback(value, modifiers, code, up)
+                    keyEventCallback(value, modifiers, code, up, virtual)
                 }
             }
         }
@@ -472,8 +474,9 @@ class Rime :
             modifiers: KeyModifiers,
             code: Int,
             up: Boolean,
+            virtual: Boolean,
         ) {
-            handleRimeEvent(RimeEvent.EventType.Key, RimeEvent.KeyEvent.Data(value, modifiers, code, up))
+            handleRimeEvent(RimeEvent.EventType.Key, RimeEvent.KeyEvent.Data(value, modifiers, code, up, virtual))
         }
 
         private fun <T> handleRimeEvent(

diff --git a/app/src/main/java/com/osfans/trime/core/RimeApi.kt b/app/src/main/java/com/osfans/trime/core/RimeApi.kt
@@ -24,13 +24,15 @@ interface RimeApi {
         modifiers: UInt = 0u,
         code: Int = 0,
         up: Boolean = false,
+        virtual: Boolean = false,
     ): Boolean
 
     suspend fun processKey(
         value: KeyValue,
         modifiers: KeyModifiers,
         code: Int = 0,
         up: Boolean = false,
+        virtual: Boolean = false,
     ): Boolean
 
     suspend fun selectCandidate(idx: Int): Boolean

diff --git a/app/src/main/java/com/osfans/trime/core/RimeEvent.kt b/app/src/main/java/com/osfans/trime/core/RimeEvent.kt
@@ -32,6 +32,7 @@ sealed class RimeEvent<T>(
             val modifiers: KeyModifiers,
             val unicode: Int,
             val up: Boolean,
+            val virtual: Boolean,
         )
     }
 

diff --git a/app/src/main/java/com/osfans/trime/ime/core/TrimeInputMethodService.kt b/app/src/main/java/com/osfans/trime/ime/core/TrimeInputMethodService.kt
@@ -239,24 +239,26 @@ open class TrimeInputMethodService : LifecycleInputMethodService() {
                 }
             is RimeEvent.KeyEvent ->
                 it.data.let event@{
-                    val keyCode = it.value.keyCode
-                    if (keyCode != KeyEvent.KEYCODE_UNKNOWN) {
-                        // TODO: look for better workaround for this
-                        if (keyCode == KeyEvent.KEYCODE_ENTER) {
-                            handleReturnKey()
-                            return@event
-                        }
-                        val eventTime = SystemClock.uptimeMillis()
-                        if (it.up) {
-                            sendUpKeyEvent(eventTime, keyCode, it.modifiers.metaState)
-                        } else {
-                            sendDownKeyEvent(eventTime, keyCode, it.modifiers.metaState)
+                    if (it.virtual) {
+                        when (it.unicode) {
+                            '\r'.code -> handleReturnKey()
+                            else -> commitText(Char(it.unicode).toString())
                         }
                     } else {
-                        if (!it.up && it.unicode > 0) {
-                            commitText(Char(it.unicode).toString())
+                        val keyCode = it.value.keyCode
+                        if (keyCode != KeyEvent.KEYCODE_UNKNOWN) {
+                            val eventTime = SystemClock.uptimeMillis()
+                            if (it.up) {
+                                sendUpKeyEvent(eventTime, keyCode, it.modifiers.metaState)
+                            } else {
+                                sendDownKeyEvent(eventTime, keyCode, it.modifiers.metaState)
+                            }
                         } else {
-                            Timber.w("Unhandled Rime KeyEvent: $it")
+                            if (!it.up && it.unicode > 0) {
+                                commitText(Char(it.unicode).toString())
+                            } else {
+                                Timber.w("Unhandled Rime KeyEvent: $it")
+                            }
                         }
                     }
                 }
@@ -722,7 +724,7 @@ open class TrimeInputMethodService : LifecycleInputMethodService() {
         val up = event.action == MotionEvent.ACTION_UP
         val modifiers = KeyModifiers.fromKeyEvent(event)
         val charCode = event.unicodeChar
-        if (charCode > 0 && charCode != '\t'.code) {
+        if (charCode > 0 && charCode != '\t'.code && charCode != '\n'.code) {
             postRimeJob {
                 processKey(charCode, modifiers.modifiers, event.scanCode, up)
             }

diff --git a/app/src/main/java/com/osfans/trime/ime/keyboard/CommonKeyboardActionListener.kt b/app/src/main/java/com/osfans/trime/ime/keyboard/CommonKeyboardActionListener.kt
@@ -263,7 +263,7 @@ class CommonKeyboardActionListener(
                 val modifiers = KeyModifiers.fromMetaState(metaState).modifiers
                 val code = ScancodeMapping.keyCodeToScancode(keyEventCode)
                 service.postRimeJob {
-                    if (processKey(value, modifiers, code)) {
+                    if (processKey(value, modifiers, code, virtual = true)) {
                         shouldReleaseKey = true
                         Timber.d("handleKey: processKey")
                         return@postRimeJob