Merge branch 'copilot/add-key-map-constraint' into develop

sds100 · sds100 · commit 1196d0c12487 · 2025-11-15T13:11:36.000+01:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,6 +6,7 @@
 - #1871 action to modify any system settings
 - #1221 action to show a custom notification
 - #1491 action to toggle/enable/disable hotspot
+- #1414 constraint for when the keyboard is showing
 
 ## [4.0.0 Beta 2](https://github.com/sds100/KeyMapper/releases/tag/v4.0.0-beta.02)
 
diff --git a/base/src/main/java/io/github/sds100/keymapper/base/constraints/ChooseConstraintViewModel.kt b/base/src/main/java/io/github/sds100/keymapper/base/constraints/ChooseConstraintViewModel.kt
@@ -77,6 +77,9 @@ class ChooseConstraintViewModel @Inject constructor(
             ConstraintId.IME_CHOSEN,
             ConstraintId.IME_NOT_CHOSEN,
 
+            ConstraintId.KEYBOARD_SHOWING,
+            ConstraintId.KEYBOARD_NOT_SHOWING,
+
             ConstraintId.DEVICE_IS_LOCKED,
             ConstraintId.DEVICE_IS_UNLOCKED,
             ConstraintId.LOCK_SCREEN_SHOWING,
@@ -204,6 +207,12 @@ class ChooseConstraintViewModel @Inject constructor(
                 ConstraintId.IME_NOT_CHOSEN,
                     -> onSelectImeChosenConstraint(constraintType)
 
+                ConstraintId.KEYBOARD_SHOWING ->
+                    returnResult.emit(ConstraintData.KeyboardShowing)
+
+                ConstraintId.KEYBOARD_NOT_SHOWING ->
+                    returnResult.emit(ConstraintData.KeyboardNotShowing)
+
                 ConstraintId.DEVICE_IS_LOCKED ->
                     returnResult.emit(ConstraintData.DeviceIsLocked)
 
diff --git a/base/src/main/java/io/github/sds100/keymapper/base/constraints/Constraint.kt b/base/src/main/java/io/github/sds100/keymapper/base/constraints/Constraint.kt
@@ -127,6 +127,16 @@ sealed class ConstraintData {
         override val id: ConstraintId = ConstraintId.IME_NOT_CHOSEN
     }
 
+    @Serializable
+    data object KeyboardShowing : ConstraintData() {
+        override val id: ConstraintId = ConstraintId.KEYBOARD_SHOWING
+    }
+
+    @Serializable
+    data object KeyboardNotShowing : ConstraintData() {
+        override val id: ConstraintId = ConstraintId.KEYBOARD_NOT_SHOWING
+    }
+
     @Serializable
     data object DeviceIsLocked : ConstraintData() {
         override val id: ConstraintId = ConstraintId.DEVICE_IS_LOCKED
@@ -334,6 +344,9 @@ object ConstraintEntityMapper {
                 getImeLabel(),
             )
 
+            ConstraintEntity.KEYBOARD_SHOWING -> ConstraintData.KeyboardShowing
+            ConstraintEntity.KEYBOARD_NOT_SHOWING -> ConstraintData.KeyboardNotShowing
+
             ConstraintEntity.DEVICE_IS_UNLOCKED -> ConstraintData.DeviceIsUnlocked
             ConstraintEntity.DEVICE_IS_LOCKED -> ConstraintData.DeviceIsLocked
             ConstraintEntity.LOCK_SCREEN_SHOWING -> ConstraintData.LockScreenShowing
@@ -570,6 +583,16 @@ object ConstraintEntityMapper {
             )
         }
 
+        is ConstraintData.KeyboardShowing -> ConstraintEntity(
+            uid = constraint.uid,
+            ConstraintEntity.KEYBOARD_SHOWING,
+        )
+
+        is ConstraintData.KeyboardNotShowing -> ConstraintEntity(
+            uid = constraint.uid,
+            ConstraintEntity.KEYBOARD_NOT_SHOWING,
+        )
+
         is ConstraintData.DeviceIsLocked -> ConstraintEntity(
             uid = constraint.uid,
             ConstraintEntity.DEVICE_IS_LOCKED,
diff --git a/base/src/main/java/io/github/sds100/keymapper/base/constraints/ConstraintDependency.kt b/base/src/main/java/io/github/sds100/keymapper/base/constraints/ConstraintDependency.kt
@@ -11,6 +11,7 @@ enum class ConstraintDependency {
     WIFI_SSID,
     WIFI_STATE,
     CHOSEN_IME,
+    KEYBOARD_VISIBLE,
     DEVICE_LOCKED_STATE,
     LOCK_SCREEN_SHOWING,
     PHONE_STATE,
diff --git a/base/src/main/java/io/github/sds100/keymapper/base/constraints/ConstraintId.kt b/base/src/main/java/io/github/sds100/keymapper/base/constraints/ConstraintId.kt
@@ -37,6 +37,9 @@ enum class ConstraintId {
     IME_CHOSEN,
     IME_NOT_CHOSEN,
 
+    KEYBOARD_SHOWING,
+    KEYBOARD_NOT_SHOWING,
+
     DEVICE_IS_LOCKED,
     DEVICE_IS_UNLOCKED,
     LOCK_SCREEN_SHOWING,
diff --git a/base/src/main/java/io/github/sds100/keymapper/base/constraints/ConstraintSnapshot.kt b/base/src/main/java/io/github/sds100/keymapper/base/constraints/ConstraintSnapshot.kt
@@ -57,6 +57,9 @@ class LazyConstraintSnapshot(
         networkAdapter.connectedWifiSSIDFlow.firstBlocking()
     }
     private val chosenImeId: String? by lazy { inputMethodAdapter.chosenIme.value?.id }
+    private val isKeyboardShowing: Boolean by lazy {
+        accessibilityService.isInputMethodVisible.firstBlocking()
+    }
     private val callState: CallState by lazy { phoneAdapter.getCallState() }
     private val isCharging: Boolean by lazy { powerAdapter.isCharging.value }
 
@@ -139,6 +142,8 @@ class LazyConstraintSnapshot(
             is ConstraintData.WifiOn -> isWifiEnabled
             is ConstraintData.ImeChosen -> chosenImeId == constraint.data.imeId
             is ConstraintData.ImeNotChosen -> chosenImeId != constraint.data.imeId
+            is ConstraintData.KeyboardShowing -> isKeyboardShowing
+            is ConstraintData.KeyboardNotShowing -> !isKeyboardShowing
             is ConstraintData.DeviceIsLocked -> isLocked
             is ConstraintData.DeviceIsUnlocked -> !isLocked
             is ConstraintData.InPhoneCall ->
diff --git a/base/src/main/java/io/github/sds100/keymapper/base/constraints/ConstraintUiHelper.kt b/base/src/main/java/io/github/sds100/keymapper/base/constraints/ConstraintUiHelper.kt
@@ -135,6 +135,13 @@ class ConstraintUiHelper(
             getString(R.string.constraint_ime_not_chosen_description, label)
         }
 
+        is ConstraintData.KeyboardShowing -> getString(
+            R.string.constraint_keyboard_showing_description,
+        )
+        is ConstraintData.KeyboardNotShowing -> getString(
+            R.string.constraint_keyboard_not_showing_description,
+        )
+
         is ConstraintData.DeviceIsLocked -> getString(R.string.constraint_device_is_locked)
         is ConstraintData.DeviceIsUnlocked -> getString(R.string.constraint_device_is_unlocked)
         is ConstraintData.InPhoneCall -> getString(R.string.constraint_in_phone_call)
diff --git a/base/src/main/java/io/github/sds100/keymapper/base/constraints/ConstraintUtils.kt b/base/src/main/java/io/github/sds100/keymapper/base/constraints/ConstraintUtils.kt
@@ -10,6 +10,7 @@ import androidx.compose.material.icons.outlined.CallEnd
 import androidx.compose.material.icons.outlined.FlashlightOff
 import androidx.compose.material.icons.outlined.FlashlightOn
 import androidx.compose.material.icons.outlined.Keyboard
+import androidx.compose.material.icons.outlined.KeyboardHide
 import androidx.compose.material.icons.outlined.Lock
 import androidx.compose.material.icons.outlined.LockOpen
 import androidx.compose.material.icons.outlined.MobileOff
@@ -78,6 +79,9 @@ object ConstraintUtils {
         ConstraintId.IME_NOT_CHOSEN,
             -> ComposeIconInfo.Vector(Icons.Outlined.Keyboard)
 
+        ConstraintId.KEYBOARD_SHOWING -> ComposeIconInfo.Vector(Icons.Outlined.Keyboard)
+        ConstraintId.KEYBOARD_NOT_SHOWING -> ComposeIconInfo.Vector(Icons.Outlined.KeyboardHide)
+
         ConstraintId.DEVICE_IS_LOCKED -> ComposeIconInfo.Vector(Icons.Outlined.Lock)
         ConstraintId.DEVICE_IS_UNLOCKED -> ComposeIconInfo.Vector(Icons.Outlined.LockOpen)
 
@@ -124,6 +128,8 @@ object ConstraintUtils {
         ConstraintId.WIFI_DISCONNECTED -> R.string.constraint_wifi_disconnected
         ConstraintId.IME_CHOSEN -> R.string.constraint_ime_chosen
         ConstraintId.IME_NOT_CHOSEN -> R.string.constraint_ime_not_chosen
+        ConstraintId.KEYBOARD_SHOWING -> R.string.constraint_keyboard_showing
+        ConstraintId.KEYBOARD_NOT_SHOWING -> R.string.constraint_keyboard_not_showing
         ConstraintId.DEVICE_IS_LOCKED -> R.string.constraint_device_is_locked
         ConstraintId.DEVICE_IS_UNLOCKED -> R.string.constraint_device_is_unlocked
         ConstraintId.IN_PHONE_CALL -> R.string.constraint_in_phone_call
diff --git a/base/src/main/java/io/github/sds100/keymapper/base/constraints/DetectConstraintsUseCase.kt b/base/src/main/java/io/github/sds100/keymapper/base/constraints/DetectConstraintsUseCase.kt
@@ -1,5 +1,6 @@
 package io.github.sds100.keymapper.base.constraints
 
+import android.os.Build
 import dagger.assisted.Assisted
 import dagger.assisted.AssistedFactory
 import dagger.assisted.AssistedInject
@@ -16,6 +17,7 @@ import io.github.sds100.keymapper.system.network.NetworkAdapter
 import io.github.sds100.keymapper.system.phone.PhoneAdapter
 import io.github.sds100.keymapper.system.power.PowerAdapter
 import kotlinx.coroutines.flow.Flow
+import kotlinx.coroutines.flow.emptyFlow
 import kotlinx.coroutines.flow.map
 import kotlinx.coroutines.flow.merge
 
@@ -89,7 +91,14 @@ class DetectConstraintsUseCaseImpl @AssistedInject constructor(
 
             ConstraintDependency.PHONE_STATE -> phoneAdapter.callStateFlow.map { dependency }
             ConstraintDependency.CHARGING_STATE -> powerAdapter.isCharging.map { dependency }
-            ConstraintDependency.HINGE_STATE -> foldableAdapter.hingeState.map { dependency }
+            ConstraintDependency.HINGE_STATE ->
+                if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.R) {
+                    foldableAdapter.hingeState.map { dependency }
+                } else {
+                    emptyFlow()
+                }
+            ConstraintDependency.KEYBOARD_VISIBLE ->
+                accessibilityService.isInputMethodVisible.map { dependency }
         }
     }
 }
diff --git a/base/src/main/java/io/github/sds100/keymapper/base/sorting/comparators/KeyMapConstraintsComparator.kt b/base/src/main/java/io/github/sds100/keymapper/base/sorting/comparators/KeyMapConstraintsComparator.kt
@@ -138,6 +138,8 @@ class KeyMapConstraintsComparator(
 
             ConstraintData.HingeClosed -> Success("")
             ConstraintData.HingeOpen -> Success("")
+            ConstraintData.KeyboardNotShowing -> Success("")
+            ConstraintData.KeyboardShowing -> Success("")
         }
     }
 }
diff --git a/base/src/main/java/io/github/sds100/keymapper/base/system/accessibility/BaseAccessibilityService.kt b/base/src/main/java/io/github/sds100/keymapper/base/system/accessibility/BaseAccessibilityService.kt
@@ -16,6 +16,7 @@ import android.os.HandlerThread
 import android.view.KeyEvent
 import android.view.accessibility.AccessibilityEvent
 import android.view.accessibility.AccessibilityNodeInfo
+import android.view.accessibility.AccessibilityWindowInfo
 import android.view.inputmethod.EditorInfo
 import androidx.annotation.RequiresApi
 import androidx.core.content.getSystemService
@@ -113,6 +114,13 @@ abstract class BaseAccessibilityService :
     override val isKeyboardHidden: Flow<Boolean>
         get() = _isKeyboardHidden
 
+    private val _isInputMethodVisible by lazy {
+        MutableStateFlow(isImeWindowVisible())
+    }
+
+    override val isInputMethodVisible: Flow<Boolean>
+        get() = _isInputMethodVisible
+
     override var serviceFlags: Int?
         get() = serviceInfo?.flags
         set(value) {
@@ -273,6 +281,7 @@ abstract class BaseAccessibilityService :
             }
 
             _activeWindowPackage.update { rootNode?.packageName?.toString() }
+            _isInputMethodVisible.update { isImeWindowVisible() }
         }
 
         getController()?.onAccessibilityEvent(event)
@@ -540,4 +549,11 @@ abstract class BaseAccessibilityService :
 
         return Success(Unit)
     }
+
+    fun isImeWindowVisible(): Boolean {
+        val imeWindow: AccessibilityWindowInfo? =
+            windows.find { it.type == AccessibilityWindowInfo.TYPE_INPUT_METHOD }
+
+        return imeWindow != null && imeWindow.root?.isVisibleToUser == true
+    }
 }
diff --git a/base/src/main/java/io/github/sds100/keymapper/base/system/accessibility/IAccessibilityService.kt b/base/src/main/java/io/github/sds100/keymapper/base/system/accessibility/IAccessibilityService.kt
@@ -49,9 +49,16 @@ interface IAccessibilityService : SwitchImeInterface {
 
     fun hideKeyboard()
     fun showKeyboard()
+
+    /**
+     * Whether the keyboard is force hidden by the accessibility service SoftKeyboardController
+     */
     val isKeyboardHidden: Flow<Boolean>
 
-    fun disableSelf()
+    /**
+     * Whether the input method is visible on the screen.
+     */
+    val isInputMethodVisible: Flow<Boolean>
 
     fun findFocussedNode(focus: Int): AccessibilityNodeModel?
 }
diff --git a/base/src/main/java/io/github/sds100/keymapper/base/system/inputmethod/AutoSwitchImeController.kt b/base/src/main/java/io/github/sds100/keymapper/base/system/inputmethod/AutoSwitchImeController.kt
@@ -2,7 +2,6 @@ package io.github.sds100.keymapper.base.system.inputmethod
 
 import android.os.Build
 import android.view.accessibility.AccessibilityEvent
-import android.view.accessibility.AccessibilityWindowInfo
 import android.view.inputmethod.EditorInfo
 import androidx.annotation.RequiresApi
 import dagger.assisted.Assisted
@@ -168,7 +167,7 @@ class AutoSwitchImeController @AssistedInject constructor(
                 return
             }
 
-            val isInputStarted = isImeWindowVisible()
+            val isInputStarted = service.isImeWindowVisible()
 
             if (isInputStarted) {
                 if (chooseIncompatibleIme()) {
@@ -182,13 +181,6 @@ class AutoSwitchImeController @AssistedInject constructor(
         }
     }
 
-    private fun isImeWindowVisible(): Boolean {
-        val imeWindow: AccessibilityWindowInfo? =
-            service.windows.find { it.type == AccessibilityWindowInfo.TYPE_INPUT_METHOD }
-
-        return imeWindow != null && imeWindow.root?.isVisibleToUser == true
-    }
-
     fun onStartInput(attribute: EditorInfo, restarting: Boolean) {
         if (!changeImeOnStartInput.value) {
             return
diff --git a/base/src/main/res/values/strings.xml b/base/src/main/res/values/strings.xml
@@ -278,6 +278,11 @@
     <string name="constraint_ime_not_chosen">Input method is not chosen</string>
     <string name="constraint_ime_not_chosen_description">%s is not chosen</string>
 
+    <string name="constraint_keyboard_showing">Keyboard is showing</string>
+    <string name="constraint_keyboard_showing_description">On-screen keyboard is visible</string>
+    <string name="constraint_keyboard_not_showing">Keyboard is not showing</string>
+    <string name="constraint_keyboard_not_showing_description">On-screen keyboard is hidden</string>
+
     <string name="constraint_device_is_locked">Device is locked</string>
     <string name="constraint_device_is_unlocked">Device is unlocked</string>
     <string name="constraint_lock_screen_showing">Lockscreen is showing</string>
diff --git a/base/src/test/java/io/github/sds100/keymapper/base/constraints/ConstraintSnapshotTest.kt b/base/src/test/java/io/github/sds100/keymapper/base/constraints/ConstraintSnapshotTest.kt
@@ -206,4 +206,36 @@ class ConstraintSnapshotTest {
         val state = ConstraintState(constraints = emptySet())
         assertThat(snapshot.isSatisfied(state), `is`(true))
     }
+
+    @Test
+    fun `When keyboard is showing and constraint is KeyboardShowing return true`() {
+        val snapshot = TestConstraintSnapshot(isKeyboardShowing = true)
+        val constraint = Constraint(data = ConstraintData.KeyboardShowing)
+        val state = ConstraintState(constraints = setOf(constraint))
+        assertThat(snapshot.isSatisfied(state), `is`(true))
+    }
+
+    @Test
+    fun `When keyboard is not showing and constraint is KeyboardShowing return false`() {
+        val snapshot = TestConstraintSnapshot(isKeyboardShowing = false)
+        val constraint = Constraint(data = ConstraintData.KeyboardShowing)
+        val state = ConstraintState(constraints = setOf(constraint))
+        assertThat(snapshot.isSatisfied(state), `is`(false))
+    }
+
+    @Test
+    fun `When keyboard is not showing and constraint is KeyboardNotShowing return true`() {
+        val snapshot = TestConstraintSnapshot(isKeyboardShowing = false)
+        val constraint = Constraint(data = ConstraintData.KeyboardNotShowing)
+        val state = ConstraintState(constraints = setOf(constraint))
+        assertThat(snapshot.isSatisfied(state), `is`(true))
+    }
+
+    @Test
+    fun `When keyboard is showing and constraint is KeyboardNotShowing return false`() {
+        val snapshot = TestConstraintSnapshot(isKeyboardShowing = true)
+        val constraint = Constraint(data = ConstraintData.KeyboardNotShowing)
+        val state = ConstraintState(constraints = setOf(constraint))
+        assertThat(snapshot.isSatisfied(state), `is`(false))
+    }
 }
diff --git a/base/src/test/java/io/github/sds100/keymapper/base/utils/TestConstraintSnapshot.kt b/base/src/test/java/io/github/sds100/keymapper/base/utils/TestConstraintSnapshot.kt
@@ -22,6 +22,7 @@ class TestConstraintSnapshot(
     val isWifiEnabled: Boolean = false,
     val connectedWifiSSID: String? = null,
     val chosenImeId: String? = null,
+    val isKeyboardShowing: Boolean = false,
     val callState: CallState = CallState.NONE,
     val isCharging: Boolean = false,
     val isLocked: Boolean = false,
@@ -94,6 +95,8 @@ class TestConstraintSnapshot(
             is ConstraintData.WifiOn -> isWifiEnabled
             is ConstraintData.ImeChosen -> chosenImeId == data.imeId
             is ConstraintData.ImeNotChosen -> chosenImeId != data.imeId
+            is ConstraintData.KeyboardShowing -> isKeyboardShowing
+            is ConstraintData.KeyboardNotShowing -> !isKeyboardShowing
             is ConstraintData.DeviceIsLocked -> isLocked
             is ConstraintData.DeviceIsUnlocked -> !isLocked
             is ConstraintData.InPhoneCall -> callState == CallState.IN_PHONE_CALL
diff --git a/data/src/main/java/io/github/sds100/keymapper/data/entities/ConstraintEntity.kt b/data/src/main/java/io/github/sds100/keymapper/data/entities/ConstraintEntity.kt
@@ -69,6 +69,9 @@ data class ConstraintEntity(
         const val IME_CHOSEN = "ime_chosen"
         const val IME_NOT_CHOSEN = "ime_not_chosen"
 
+        const val KEYBOARD_SHOWING = "keyboard_showing"
+        const val KEYBOARD_NOT_SHOWING = "keyboard_not_showing"
+
         const val DEVICE_IS_LOCKED = "is_locked"
         const val DEVICE_IS_UNLOCKED = "is_unlocked"
         const val LOCK_SCREEN_SHOWING = "lock_screen_showing"

Original file line number	Diff line number	Diff line change
`@@ -138,6 +138,8 @@ class KeyMapConstraintsComparator(`
`138`	`138`
`139`	`139`	`ConstraintData.HingeClosed -> Success("")`
`140`	`140`	`ConstraintData.HingeOpen -> Success("")`
	`141`	`+ ConstraintData.KeyboardNotShowing -> Success("")`
	`142`	`+ ConstraintData.KeyboardShowing -> Success("")`
`141`	`143`	`}`
`142`	`144`	`}`
`143`	`145`	`}`