feat: add ASCII mode switch indicator

ENOA-ANSUL-EDEN · ENOA-ANSUL-EDEN · commit f6e391f2057b · 2025-11-05T19:33:51.000+08:00
diff --git a/app/src/main/java/com/osfans/trime/data/prefs/AppPrefs.kt b/app/src/main/java/com/osfans/trime/data/prefs/AppPrefs.kt
@@ -199,11 +199,13 @@ class AppPrefs(
             const val MODE = "show_candidates_window"
             const val LAYOUT = "candidates_layout"
             const val POSITION = "candidates_window_position"
+            const val ASCII_INDICATOR = "show_ascii_indicator"
         }
 
         val mode = enum(R.string.show_candidates_window, MODE, PopupCandidatesMode.DISABLED)
         val layout = enum(R.string.candidates_layout, LAYOUT, PopupCandidatesLayout.AUTOMATIC)
         val position = enum(R.string.candidates_window_position, POSITION, PopupPosition.BOTTOM_LEFT)
+        val asciiIndicator = switch(R.string.show_ascii_indicator, ASCII_INDICATOR, true)
     }
 
     /**
diff --git a/app/src/main/java/com/osfans/trime/ime/composition/CandidatesView.kt b/app/src/main/java/com/osfans/trime/ime/composition/CandidatesView.kt
@@ -56,6 +56,7 @@ class CandidatesView(
 
     private val layout by AppPrefs.defaultInstance().candidates.layout
     private val position by AppPrefs.defaultInstance().candidates.position
+    private val showAsciiIndicator by AppPrefs.defaultInstance().candidates.asciiIndicator
 
     private val composingTextMode by AppPrefs.defaultInstance().general.composingTextMode
 
@@ -110,6 +111,8 @@ class CandidatesView(
 
     private var bottomInsets = 0
 
+    private var shouldShowAsciiIndicator = false
+
     override fun handleRimeMessage(it: RimeMessage<*>) {
         when (it) {
             is RimeMessage.CompositionMessage -> {
@@ -124,12 +127,28 @@ class CandidatesView(
                 menu = it.data
                 updateUi()
             }
+            is RimeMessage.OptionMessage -> {
+                if (!showAsciiIndicator || it.data.option != "ascii_mode") return
+                val text = if (it.data.value) "En" else rime.run { statusCached }.schemaName.take(2)
+                preeditUi.root.post {
+                    shouldShowAsciiIndicator = true
+                    visibility = VISIBLE
+                    candidatesUi.root.visibility = GONE
+                    preeditUi.show(text) {
+                        shouldShowAsciiIndicator = false
+                        visibility = INVISIBLE
+                        candidatesUi.root.visibility = VISIBLE
+                    }
+                }
+            }
+
             else -> {}
         }
     }
 
     private fun evaluateVisibility(): Boolean = !composition.preedit.isNullOrEmpty() ||
-        menu.candidates.isNotEmpty()
+        menu.candidates.isNotEmpty() ||
+        shouldShowAsciiIndicator
 
     private fun updateUi() {
         preeditUi.update(composition)
diff --git a/app/src/main/java/com/osfans/trime/ime/composition/PreeditModule.kt b/app/src/main/java/com/osfans/trime/ime/composition/PreeditModule.kt
@@ -9,12 +9,15 @@ import android.content.Context
 import android.graphics.drawable.GradientDrawable
 import android.view.View
 import android.view.ViewOutlineProvider
+import com.osfans.trime.core.RimeMessage
 import com.osfans.trime.core.RimeProto
 import com.osfans.trime.daemon.RimeSession
 import com.osfans.trime.daemon.launchOnReady
+import com.osfans.trime.data.prefs.AppPrefs
 import com.osfans.trime.data.theme.ColorManager
 import com.osfans.trime.data.theme.Theme
 import com.osfans.trime.ime.broadcast.InputBroadcastReceiver
+import com.osfans.trime.ime.candidates.popup.PopupCandidatesMode
 import com.osfans.trime.ime.core.TouchEventReceiverWindow
 import com.osfans.trime.ime.dependency.InputScope
 import me.tatarka.inject.annotations.Inject
@@ -26,7 +29,7 @@ import splitties.views.horizontalPadding
 class PreeditModule(
     context: Context,
     theme: Theme,
-    rime: RimeSession,
+    private val rime: RimeSession,
 ) : InputBroadcastReceiver {
 
     val ui =
@@ -66,4 +69,13 @@ class PreeditModule(
             touchEventReceiverWindow.dismiss()
         }
     }
+
+    private val showAsciiIndicator by AppPrefs.defaultInstance().candidates.asciiIndicator
+    private val candidatesViewMode by AppPrefs.defaultInstance().candidates.mode
+
+    override fun onRimeOptionUpdated(value: RimeMessage.OptionMessage.Data) {
+        if (!showAsciiIndicator || candidatesViewMode == PopupCandidatesMode.ALWAYS_SHOW || value.option != "ascii_mode") return
+        val text = if (value.value) "En" else rime.run { statusCached }.schemaName.take(2)
+        ui.root.post { ui.show(text) }
+    }
 }
diff --git a/app/src/main/java/com/osfans/trime/ime/composition/PreeditUi.kt b/app/src/main/java/com/osfans/trime/ime/composition/PreeditUi.kt
@@ -14,10 +14,15 @@ import android.view.View
 import android.widget.LinearLayout
 import android.widget.TextView
 import androidx.core.text.buildSpannedString
+import androidx.lifecycle.findViewTreeLifecycleOwner
+import androidx.lifecycle.lifecycleScope
 import com.osfans.trime.core.RimeProto
 import com.osfans.trime.data.theme.ColorManager
 import com.osfans.trime.data.theme.FontManager
 import com.osfans.trime.data.theme.Theme
+import com.osfans.trime.util.CancellableDelay
+import kotlinx.coroutines.Job
+import kotlinx.coroutines.launch
 import splitties.views.dsl.core.Ui
 import splitties.views.dsl.core.add
 import splitties.views.dsl.core.lParams
@@ -71,15 +76,23 @@ open class PreeditUi(
         visibility = if (visible) View.VISIBLE else View.GONE
     }
 
+    private var autoHideJob: Job? = null
+    private val delayControl = CancellableDelay()
+
     fun update(inputComposition: RimeProto.Context.Composition) {
         val string = inputComposition.toSpannedString()
         val cursorPos = inputComposition.cursorPos
         val hasPreedit = inputComposition.length > 0
-        visible = hasPreedit
-        if (!visible) {
+
+        if (!hasPreedit) {
+            if (autoHideJob?.isActive == true) return
+            visible = false
             updateTextView("", false)
             return
         }
+        delayControl.skipDelay()
+        visible = true
+
         val stringWithCursor =
             if (cursorPos == 0 || cursorPos == string.length) {
                 string
@@ -89,6 +102,24 @@ open class PreeditUi(
                     append(string, cursorPos, string.length)
                 }
             }
-        updateTextView(stringWithCursor, hasPreedit)
+        updateTextView(stringWithCursor, true)
+    }
+
+    fun show(
+        text: String,
+        onIndicatorHidden: (() -> Unit)? = null,
+    ) {
+        autoHideJob?.cancel()
+        updateTextView(text, true)
+        root.visibility = View.VISIBLE
+        visible = true
+        autoHideJob = root.findViewTreeLifecycleOwner()?.lifecycleScope?.launch {
+            if (!delayControl.delay(1000)) {
+                updateTextView("", false)
+                root.visibility = View.INVISIBLE
+                visible = false
+                onIndicatorHidden?.invoke()
+            }
+        }
     }
 }
diff --git a/app/src/main/java/com/osfans/trime/util/CancellableDelay.kt b/app/src/main/java/com/osfans/trime/util/CancellableDelay.kt
@@ -0,0 +1,36 @@
+/*
+ * SPDX-FileCopyrightText: 2015 - 2025 Rime community
+ * SPDX-License-Identifier: GPL-3.0-or-later
+ */
+
+package com.osfans.trime.util
+
+import kotlinx.coroutines.CancellationException
+import kotlinx.coroutines.CompletableDeferred
+import kotlinx.coroutines.TimeoutCancellationException
+import kotlinx.coroutines.withTimeout
+
+class CancellableDelay {
+    private var deferred: CompletableDeferred<Unit>? = null
+
+    suspend fun delay(timeMillis: Long): Boolean {
+        deferred = CompletableDeferred()
+
+        return try {
+            withTimeout(timeMillis) {
+                deferred?.await()
+            }
+            false
+        } catch (e: TimeoutCancellationException) {
+            false
+        } catch (e: CancellationException) {
+            true
+        } finally {
+            deferred = null
+        }
+    }
+
+    fun skipDelay() {
+        deferred?.complete(Unit)
+    }
+}
diff --git a/app/src/main/res/values-zh-rCN/strings.xml b/app/src/main/res/values-zh-rCN/strings.xml
@@ -228,4 +228,5 @@ SPDX-License-Identifier: GPL-3.0-or-later
     <string name="automatic">自动</string>
     <string name="horizontal">横向</string>
     <string name="vertical">纵向</string>
+    <string name="show_ascii_indicator">ASCII 模式切换提示</string>
 </resources>
diff --git a/app/src/main/res/values-zh-rTW/strings.xml b/app/src/main/res/values-zh-rTW/strings.xml
@@ -229,4 +229,5 @@ SPDX-License-Identifier: GPL-3.0-or-later
     <string name="automatic">自動</string>
     <string name="horizontal">橫向</string>
     <string name="vertical">"縱向 "</string>
+    <string name="show_ascii_indicator">ASCII 模式切換提示</string>
 </resources>
diff --git a/app/src/main/res/values/strings.xml b/app/src/main/res/values/strings.xml
@@ -229,4 +229,5 @@ SPDX-License-Identifier: GPL-3.0-or-later
     <string name="automatic">Automatic</string>
     <string name="horizontal">Horizontal</string>
     <string name="vertical">Vertical</string>
+    <string name="show_ascii_indicator">ASCII mode switch indicator</string>
 </resources>

Original file line number	Diff line number	Diff line change
`@@ -199,11 +199,13 @@ class AppPrefs(`
`199`	`199`	`const val MODE = "show_candidates_window"`
`200`	`200`	`const val LAYOUT = "candidates_layout"`
`201`	`201`	`const val POSITION = "candidates_window_position"`
	`202`	`+ const val ASCII_INDICATOR = "show_ascii_indicator"`
`202`	`203`	`}`
`203`	`204`
`204`	`205`	`val mode = enum(R.string.show_candidates_window, MODE, PopupCandidatesMode.DISABLED)`
`205`	`206`	`val layout = enum(R.string.candidates_layout, LAYOUT, PopupCandidatesLayout.AUTOMATIC)`
`206`	`207`	`val position = enum(R.string.candidates_window_position, POSITION, PopupPosition.BOTTOM_LEFT)`
	`208`	`+ val asciiIndicator = switch(R.string.show_ascii_indicator, ASCII_INDICATOR, true)`
`207`	`209`	`}`
`208`	`210`
`209`	`211`	`/**`