#1414 feat: constraint for when the keyboard is showing

Author: sds100

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)
 

base/src/main/java/io/github/sds100/keymapper/base/constraints/ConstraintDependency.kt

@@ -11,7 +11,7 @@ enum class ConstraintDependency {
     WIFI_SSID,
     WIFI_STATE,
     CHOSEN_IME,
-    KEYBOARD_STATE,
+    KEYBOARD_VISIBLE,
     DEVICE_LOCKED_STATE,
     LOCK_SCREEN_SHOWING,
     PHONE_STATE,

base/src/main/java/io/github/sds100/keymapper/base/constraints/ConstraintSnapshot.kt

@@ -57,8 +57,9 @@ class LazyConstraintSnapshot(
         networkAdapter.connectedWifiSSIDFlow.firstBlocking()
     }
     private val chosenImeId: String? by lazy { inputMethodAdapter.chosenIme.value?.id }
-    // TODO: Implement keyboard state detection
-    private val isKeyboardShowing: Boolean by lazy { false }
+    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 }
 

base/src/main/java/io/github/sds100/keymapper/base/constraints/ConstraintUiHelper.kt

@@ -135,8 +135,12 @@ 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.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)

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,7 +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.flowOf
+import kotlinx.coroutines.flow.emptyFlow
 import kotlinx.coroutines.flow.map
 import kotlinx.coroutines.flow.merge
 
@@ -79,9 +80,6 @@ class DetectConstraintsUseCaseImpl @AssistedInject constructor(
                 networkAdapter.connectedWifiSSIDFlow.map { dependency }
             ConstraintDependency.WIFI_STATE -> networkAdapter.isWifiEnabledFlow().map { dependency }
             ConstraintDependency.CHOSEN_IME -> inputMethodAdapter.chosenIme.map { dependency }
-            ConstraintDependency.KEYBOARD_STATE -> 
-                // TODO: Implement keyboard state detection
-                flowOf(dependency)
             ConstraintDependency.DEVICE_LOCKED_STATE ->
                 lockScreenAdapter.isLockedFlow().map { dependency }
 
@@ -93,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 }
         }
     }
 }

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("")
         }
     }
 }

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
+    }
 }

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?
 }

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