#1276 refactor: display change to scanCode fallback

Author: kamilkrzyskow

app/src/main/java/io/github/sds100/keymapper/data/Keys.kt

@@ -49,6 +49,8 @@ object Keys {
         booleanPreferencesKey("key_shown_parallel_trigger_order_warning")
     val shownSequenceTriggerExplanation =
         booleanPreferencesKey("key_shown_sequence_trigger_explanation_dialog")
+    val shownKeyCodeToScanCodeTriggerExplanation =
+        booleanPreferencesKey("key_shown_keycode_to_scancode_trigger_explanation_dialog")
     val lastInstalledVersionCodeHomeScreen =
         intPreferencesKey("last_installed_version_home_screen")
     val lastInstalledVersionCodeBackground =

app/src/main/java/io/github/sds100/keymapper/mappings/keymaps/trigger/BaseConfigTriggerViewModel.kt

@@ -456,6 +456,20 @@ abstract class BaseConfigTriggerViewModel(
         // need to be dismissed before it is added.
         config.addKeyCodeTriggerKey(key.keyCode, key.device, key.detectionSource)
 
+        if (key.keyCode >= InputEventUtils.KEYCODE_TO_SCANCODE_OFFSET) {
+            if (onboarding.shownKeyCodeToScanCodeTriggerExplanation) {
+                return
+            }
+
+            val dialog = PopupUi.Ok(
+                message = getString(R.string.dialog_message_keycode_to_scancode_trigger_explanation),
+            )
+
+            showPopup("keycode_to_scancode_message", dialog)
+
+            onboarding.shownKeyCodeToScanCodeTriggerExplanation = true
+        }
+
         if (key.keyCode == KeyEvent.KEYCODE_CAPS_LOCK) {
             val dialog = PopupUi.Ok(
                 message = getString(R.string.dialog_message_enable_physical_keyboard_caps_lock_a_keyboard_layout),

app/src/main/java/io/github/sds100/keymapper/onboarding/OnboardingUseCase.kt

@@ -65,6 +65,10 @@ class OnboardingUseCaseImpl(
         Keys.shownSequenceTriggerExplanation,
         false,
     )
+    override var shownKeyCodeToScanCodeTriggerExplanation by PrefDelegate(
+        Keys.shownKeyCodeToScanCodeTriggerExplanation,
+        false,
+    )
 
     override val showWhatsNew = get(Keys.lastInstalledVersionCodeHomeScreen)
         .map { (it ?: -1) < Constants.VERSION_CODE }
@@ -171,6 +175,7 @@ interface OnboardingUseCase {
 
     var shownParallelTriggerOrderExplanation: Boolean
     var shownSequenceTriggerExplanation: Boolean
+    var shownKeyCodeToScanCodeTriggerExplanation: Boolean
 
     val showAssistantTriggerFeatureNotification: Flow<Boolean>
     fun showedAssistantTriggerFeatureNotification()

app/src/main/java/io/github/sds100/keymapper/system/inputevents/InputEventUtils.kt

@@ -686,12 +686,21 @@ object InputEventUtils {
             KeyEvent.KEYCODE_FUNCTION,
         )
 
+    /**
+     * Used for keyCode to scanCode fallback to go past possible keyCode values
+     */
+    const val KEYCODE_TO_SCANCODE_OFFSET: Int = 1000
+
     /**
      * Create a text representation of a key event. E.g if the control key was pressed,
      * "Ctrl" will be returned
      */
     fun keyCodeToString(keyCode: Int): String = NON_CHARACTER_KEY_LABELS[keyCode].let {
-        it ?: "unknown keycode $keyCode"
+        if (keyCode >= KEYCODE_TO_SCANCODE_OFFSET) {
+            "scancode $keyCode"
+        } else {
+            it ?: "unknown keycode $keyCode"
+        }
     }
 
     fun isModifierKey(keyCode: Int): Boolean = keyCode in MODIFIER_KEYCODES

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

@@ -415,6 +415,7 @@
     <string name="dialog_message_cant_find_accessibility_settings_page">Your device doesn\'t seem to have an accessibility services settings page. Tap \"guide\" to read the online guide that explains how to fix this.</string>
     <string name="dialog_message_parallel_trigger_order">The keys need to be listed from top to bottom in the order that they will be held down.</string>
     <string name="dialog_message_sequence_trigger_explanation">A \"sequence\" trigger has a timeout unlike parallel triggers. This means after you press the first key, you will have a set amount of time to input the rest of the keys in the trigger. All the keys that you have added to the trigger won\'t do their usual action until the timeout has been reached. You can change this timeout in the "Options" tab.</string>
+    <string name="dialog_message_keycode_to_scancode_trigger_explanation">The pressed button was not recognized by the input system. In the past Key Mapper detected such buttons as one and the same. Currently the app tries to distinguish the button based on the scan code, which should be more unique. However, this is a makeshift incomplete solution, which doesn\'t guarantee uniqueness.</string>
     <string name="dialog_message_bt_constraint_limitation">Android doesn\'t allow apps to get a list of connected (not paired) Bluetooth devices. Apps can only detect when they are connected and disconnected. So if your Bluetooth device is already connected to your device when the accessibility service starts, you will have to reconnect it for the app to know it is connected.</string>
     <string name="dialog_message_change_location_or_disable">Change location or turn off automatic back up?</string>
     <string name="dialog_message_screen_constraints_limitation">Screen on/off constraints will only work if you have turned on the \"detect trigger when screen is off\" key map option. This option will only show for some keys (e.g volume buttons) and if you are rooted. See a list of supported keys on the Help page.</string>

app/src/test/java/io/github/sds100/keymapper/onboarding/FakeOnboardingUseCase.kt

@@ -26,6 +26,7 @@ class FakeOnboardingUseCase : OnboardingUseCase {
 
     override var shownParallelTriggerOrderExplanation: Boolean = false
     override var shownSequenceTriggerExplanation: Boolean = false
+    override var shownKeyCodeToScanCodeTriggerExplanation: Boolean = false
     override val showAssistantTriggerFeatureNotification: Flow<Boolean> = MutableStateFlow(false)
 
     override fun showedAssistantTriggerFeatureNotification() {}