Merge branch 'feature/1818-deprecate-gui-keyboard' into develop

Author: sds100

.cursor/rules/jetpack-compose.mdc

@@ -1,9 +1,6 @@
 ---
-description: 
-globs: 
-alwaysApply: false
+alwaysApply: true
 ---
-
 # Android Native (Jetpack Compose)
 
 # Android Jetpack Compose .cursorrules
@@ -58,6 +55,9 @@ app/
 8. Use proper theming with `MaterialTheme`
 9. Follow accessibility guidelines
 10. Implement proper animation patterns
+11. Modifier is always the first parameter
+12. Use io.github.sds100.keymapper.base.compose.LocalCustomColorsPalette for non-standard colors that are not in MaterialTheme.colorScheme
+13. Check icons in io.github.sds100.keymapper.base.utils.ui.compose.icons.KeyMapperIcons.
 
 ## Performance Guidelines
 1. Minimize recomposition using proper keys

CHANGELOG.md

@@ -27,6 +27,14 @@
 - Restoring subgroups works and does not freeze Key Mapper.
 - Do not show duplicate constraint shortcuts.
 - Make WiFi connected constraints more reliable
+- #1818 auto switching of the Key Mapper keyboard when typing is more reliable and quicker on
+  Android 13+
+- #1818 auto switching of the Key Mapper keyboard now requires Android 11+. On older versions it was
+  only possible with WRITE_SECURE_SETTINGS but very few users are on these old Android versions so
+  it is not worth the extra maintenance effort.
+- #1818 the Key Mapper GUI Keyboard is no longer mentioned in the app. It still works but PRO mode
+  and the auto switching feature are the preferred way to work around the limitations of the Key
+  Mapper keyboard.
 
 ## [3.2.1](https://github.com/sds100/KeyMapper/releases/tag/v3.2.1)
 
@@ -1362,26 +1370,26 @@ This summarises the changes since 2.0.2.
 - Dark mode! 🕶
 - A keymap can have multiple actions.
 - Triggers
-  - 2 modes. The keys can all be pressed at the same time or one after another in a sequence.
-  - Keys can be limited to a specific external device, any device or the device the app is
-    installed on.
-  - Double press support.
+    - 2 modes. The keys can all be pressed at the same time or one after another in a sequence.
+    - Keys can be limited to a specific external device, any device or the device the app is
+      installed on.
+    - Double press support.
 - Constraints. Keymaps can be restricted to only work in certain situations. Constraints can be
   mixed in OR mode or AND mode.
-  - App in foreground
-  - App not in foreground
-  - Bluetooth device connected
-  - Bluetooth device not connected
-  - Screen on/off (ROOT only).
+    - App in foreground
+    - App not in foreground
+    - Bluetooth device connected
+    - Bluetooth device not connected
+    - Screen on/off (ROOT only).
 
 - Actions
-  - Toggle/enable/disable a Do Not Disturb mode (Android 6.0+).
-  - Toggle/enable/disable airplane mode (ROOT only).
-  - Switch between vibrate and ring.
-  - Launch the device assistant rather than the voice assistant.
-  - Take screenshots on rooted devices older than Pie.
-  - Can now have unique repeat options and any action is allowed to be repeated now.
-  - Show the keycode number when picking a Keycode action.
+    - Toggle/enable/disable a Do Not Disturb mode (Android 6.0+).
+    - Toggle/enable/disable airplane mode (ROOT only).
+    - Switch between vibrate and ring.
+    - Launch the device assistant rather than the voice assistant.
+    - Take screenshots on rooted devices older than Pie.
+    - Can now have unique repeat options and any action is allowed to be repeated now.
+    - Show the keycode number when picking a Keycode action.
 
 - Renamed "Repeat Delay" to "Repeat Rate".
 - Renamed "Hold Down Delay" to "Repeat Delay"
@@ -1512,16 +1520,16 @@ Significantly improved the input latency.
 
 - A keymap can have multiple actions.
 - Triggers
-  - 2 modes. The keys can all be pressed at the same time or one after another in a sequence.
-  - Keys can be limited to a specific external device, any device or the device the app is
-    installed on.
-  - Double press support.
+    - 2 modes. The keys can all be pressed at the same time or one after another in a sequence.
+    - Keys can be limited to a specific external device, any device or the device the app is
+      installed on.
+    - Double press support.
 - Constraints. Keymaps can be restricted to only work in certain situations. Constraints can be
   mixed in OR mode or AND mode.
-  - App in foreground
-  - App not in foreground
-  - Bluetooth device connected
-  - Bluetooth device not connected
+    - App in foreground
+    - App not in foreground
+    - Bluetooth device connected
+    - Bluetooth device not connected
 - The option to show the "performing action" toast has been moved to a toggle in each keymap.
 - The long press delay, double press timeout, sequence trigger timeout, action repeat delay,
   hold-down delay until actions are repeated and vibrate delay can be changed per keymap.

app/src/ci/res/values/strings.xml

@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="utf-8"?>
 <resources>
     <string name="app_name">Key Mapper CI</string>
-    <string name="ime_service_label" translatable="false">Key Mapper CI Basic Input Method</string>
+    <string name="ime_service_label" translatable="false">Key Mapper CI Input Method</string>
 </resources>

app/src/debug/res/values/strings.xml

@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="utf-8"?>
 <resources>
     <string name="app_name" translatable="false">Key Mapper Debug</string>
-    <string name="ime_service_label" translatable="false">Key Mapper Debug Basic Input Method</string>
+    <string name="ime_service_label" translatable="false">Key Mapper Debug Input Method</string>
 </resources>

app/src/main/java/io/github/sds100/keymapper/AppHiltModule.kt

@@ -40,6 +40,8 @@ class AppHiltModule {
             get() = BuildConfig.VERSION_NAME
         override val versionCode: Int
             get() = BuildConfig.VERSION_CODE
+        override val sdkInt: Int
+            get() = Build.VERSION.SDK_INT
     }
 
     @Singleton

app/src/main/java/io/github/sds100/keymapper/home/HomeViewModel.kt

@@ -1,6 +1,7 @@
 package io.github.sds100.keymapper.home
 
 import dagger.hilt.android.lifecycle.HiltViewModel
+import io.github.sds100.keymapper.base.actions.keyevent.FixKeyEventActionDelegate
 import io.github.sds100.keymapper.base.backup.BackupRestoreMappingsUseCase
 import io.github.sds100.keymapper.base.home.BaseHomeViewModel
 import io.github.sds100.keymapper.base.home.ListKeyMapsUseCase
@@ -24,6 +25,7 @@ class HomeViewModel @Inject constructor(
     resourceProvider: ResourceProvider,
     private val sortKeyMaps: SortKeyMapsUseCase,
     private val showInputMethodPickerUseCase: ShowInputMethodPickerUseCase,
+    fixKeyEventActionDelegate: FixKeyEventActionDelegate,
     navigationProvider: NavigationProvider,
     dialogProvider: DialogProvider,
 ) : BaseHomeViewModel(
@@ -35,6 +37,7 @@ class HomeViewModel @Inject constructor(
     resourceProvider,
     sortKeyMaps,
     showInputMethodPickerUseCase,
+    fixKeyEventActionDelegate,
     navigationProvider,
     dialogProvider,
 )

app/src/main/java/io/github/sds100/keymapper/system/accessibility/AccessibilityServiceController.kt

@@ -12,6 +12,7 @@ import io.github.sds100.keymapper.base.keymaps.PauseKeyMapsUseCase
 import io.github.sds100.keymapper.base.promode.SystemBridgeSetupAssistantController
 import io.github.sds100.keymapper.base.system.accessibility.AccessibilityNodeRecorder
 import io.github.sds100.keymapper.base.system.accessibility.BaseAccessibilityServiceController
+import io.github.sds100.keymapper.base.system.inputmethod.AutoSwitchImeController
 import io.github.sds100.keymapper.base.trigger.RecordTriggerController
 import io.github.sds100.keymapper.data.repositories.PreferenceRepository
 import io.github.sds100.keymapper.system.inputmethod.KeyEventRelayServiceWrapper
@@ -30,6 +31,7 @@ class AccessibilityServiceController @AssistedInject constructor(
     inputEventHub: InputEventHub,
     recordTriggerController: RecordTriggerController,
     setupAssistantControllerFactory: SystemBridgeSetupAssistantController.Factory,
+    autoSwitchImeControllerFactory: AutoSwitchImeController.Factory,
 ) : BaseAccessibilityServiceController(
     service = service,
     accessibilityNodeRecorderFactory = accessibilityNodeRecorderFactory,
@@ -43,6 +45,7 @@ class AccessibilityServiceController @AssistedInject constructor(
     inputEventHub = inputEventHub,
     recordTriggerController = recordTriggerController,
     setupAssistantControllerFactory = setupAssistantControllerFactory,
+    autoSwitchImeControllerFactory = autoSwitchImeControllerFactory,
 ) {
     @AssistedFactory
     interface Factory {

app/version.properties

@@ -1,3 +1,3 @@
 VERSION_NAME=4.0.0-beta.1
-VERSION_CODE=158
+VERSION_CODE=161
 VERSION_NUM=0

base/src/main/java/io/github/sds100/keymapper/base/BaseKeyMapperApp.kt

@@ -20,7 +20,6 @@ import io.github.sds100.keymapper.base.logging.KeyMapperLoggingTree
 import io.github.sds100.keymapper.base.promode.SystemBridgeAutoStarter
 import io.github.sds100.keymapper.base.settings.Theme
 import io.github.sds100.keymapper.base.system.accessibility.AccessibilityServiceAdapterImpl
-import io.github.sds100.keymapper.base.system.inputmethod.AutoSwitchImeController
 import io.github.sds100.keymapper.base.system.notifications.NotificationController
 import io.github.sds100.keymapper.base.system.permissions.AutoGrantPermissionController
 import io.github.sds100.keymapper.common.utils.Constants
@@ -58,9 +57,6 @@ abstract class BaseKeyMapperApp : MultiDexApplication() {
     @Inject
     lateinit var notificationController: NotificationController
 
-    @Inject
-    lateinit var autoSwitchImeController: AutoSwitchImeController
-
     @Inject
     lateinit var packageManagerAdapter: AndroidPackageManagerAdapter
 
@@ -199,8 +195,6 @@ abstract class BaseKeyMapperApp : MultiDexApplication() {
 
         notificationController.init()
 
-        autoSwitchImeController.init()
-
         processLifecycleOwner.lifecycle.addObserver(object : LifecycleObserver {
             @Suppress("DEPRECATION")
             @OnLifecycleEvent(Lifecycle.Event.ON_RESUME)
@@ -238,6 +232,14 @@ abstract class BaseKeyMapperApp : MultiDexApplication() {
             appCoroutineScope.launch {
                 systemBridgeConnectionManager.connectionState.collect { state ->
                     if (state is SystemBridgeConnectionState.Connected) {
+                        val isUsed =
+                            settingsRepository.get(Keys.isSystemBridgeUsed).first() ?: false
+
+                        // Enable the setting to use PRO mode for key event actions the first time they use PRO mode.
+                        if (!isUsed) {
+                            settingsRepository.set(Keys.keyEventActionsUseSystemBridge, true)
+                        }
+
                         settingsRepository.set(Keys.isSystemBridgeUsed, true)
                     }
                 }

base/src/main/java/io/github/sds100/keymapper/base/BaseSingletonHiltModule.kt

@@ -35,6 +35,8 @@ import io.github.sds100.keymapper.base.system.inputmethod.ShowHideInputMethodUse
 import io.github.sds100.keymapper.base.system.inputmethod.ShowHideInputMethodUseCaseImpl
 import io.github.sds100.keymapper.base.system.inputmethod.ShowInputMethodPickerUseCase
 import io.github.sds100.keymapper.base.system.inputmethod.ShowInputMethodPickerUseCaseImpl
+import io.github.sds100.keymapper.base.system.inputmethod.SwitchImeAsyncImpl
+import io.github.sds100.keymapper.base.system.inputmethod.SwitchImeInterface
 import io.github.sds100.keymapper.base.system.inputmethod.ToggleCompatibleImeUseCase
 import io.github.sds100.keymapper.base.system.inputmethod.ToggleCompatibleImeUseCaseImpl
 import io.github.sds100.keymapper.base.system.notifications.AndroidNotificationAdapter
@@ -158,4 +160,8 @@ abstract class BaseSingletonHiltModule {
     @Binds
     @Singleton
     abstract fun bindGetDefaultKeyMapOptionsUseCas(impl: GetDefaultKeyMapOptionsUseCaseImpl): GetDefaultKeyMapOptionsUseCase
+
+    @Binds
+    @Singleton
+    abstract fun bindSwitchImeInterface(impl: SwitchImeAsyncImpl): SwitchImeInterface
 }