#1585 fix: Track changes when editing key maps and only prompt to discard changes if there were indeed changes.

Author: sds100

CHANGELOG.md

@@ -1,7 +1,15 @@
-## [3.0 Beta 1](https://github.com/sds100/KeyMapper/releases/tag/v3.0.0-beta.1)
+## [3.0 Beta 2](https://github.com/sds100/KeyMapper/releases/tag/v3.0.0-beta.2)
 
 #### TO BE RELEASED
 
+## Bug fixes
+
+- #1585 Track changes when editing key maps and only prompt to discard changes if there were indeed changes.
+
+## [3.0 Beta 1](https://github.com/sds100/KeyMapper/releases/tag/v3.0.0-beta.1)
+
+#### 26 March 2025
+
 Most of the codebase has been touched and most of the user interface has been rewritten
 in Jetpack Compose, resulting in many improvements to the user experience.
 

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

@@ -69,6 +69,18 @@ fun ConfigKeyMapScreen(
     val isKeyMapEnabled by viewModel.isEnabled.collectAsStateWithLifecycle()
     val snackbarHostState = remember { SnackbarHostState() }
 
+    var showBackDialog by rememberSaveable { mutableStateOf(false) }
+
+    if (showBackDialog) {
+        BackDialog(
+            onDismiss = { showBackDialog = false },
+            onDiscardClick = {
+                showBackDialog = false
+                navigateBack()
+            },
+        )
+    }
+
     ConfigKeyMapScreen(
         modifier = modifier,
         isKeyMapEnabled = isKeyMapEnabled,
@@ -92,7 +104,13 @@ fun ConfigKeyMapScreen(
                 viewModel.configTriggerViewModel.optionsViewModel,
             )
         },
-        navigateBack = navigateBack,
+        onBackClick = {
+            if (viewModel.isKeyMapEdited) {
+                showBackDialog = true
+            } else {
+                navigateBack()
+            }
+        },
         onDoneClick = {
             viewModel.save()
             navigateBack()
@@ -111,7 +129,7 @@ private fun ConfigKeyMapScreen(
     actionScreen: @Composable () -> Unit,
     constraintsScreen: @Composable () -> Unit,
     optionsScreen: @Composable () -> Unit,
-    navigateBack: () -> Unit = {},
+    onBackClick: () -> Unit = {},
     onDoneClick: () -> Unit = {},
     snackbarHostState: SnackbarHostState = SnackbarHostState(),
 ) {
@@ -124,21 +142,7 @@ private fun ConfigKeyMapScreen(
     var currentTab: ConfigKeyMapTab? by remember { mutableStateOf(null) }
     val uriHandler = LocalUriHandler.current
 
-    var showBackDialog by rememberSaveable { mutableStateOf(false) }
-
-    if (showBackDialog) {
-        BackDialog(
-            onDismiss = { showBackDialog = false },
-            onDiscardClick = {
-                showBackDialog = false
-                navigateBack()
-            },
-        )
-    }
-
-    BackHandler {
-        showBackDialog = true
-    }
+    BackHandler(onBack = onBackClick)
 
     Scaffold(
         modifier.displayCutoutPadding(),
@@ -147,9 +151,7 @@ private fun ConfigKeyMapScreen(
             KeyMapAppBar(
                 isKeyMapEnabled = isKeyMapEnabled,
                 onKeyMapEnabledChange = onKeyMapEnabledChange,
-                onBackClick = {
-                    showBackDialog = true
-                },
+                onBackClick = onBackClick,
                 onDoneClick = onDoneClick,
                 showHelpButton = currentTab == ConfigKeyMapTab.TRIGGER ||
                     currentTab == ConfigKeyMapTab.ACTIONS ||
@@ -602,7 +604,6 @@ private fun SmallScreenPreview() {
             actionScreen = {},
             constraintsScreen = {},
             optionsScreen = {},
-            navigateBack = {},
         )
     }
 }
@@ -618,7 +619,6 @@ private fun MediumScreenPreview() {
             actionScreen = {},
             constraintsScreen = {},
             optionsScreen = {},
-            navigateBack = {},
         )
     }
 }
@@ -634,7 +634,6 @@ private fun MediumScreenLandscapePreview() {
             actionScreen = {},
             constraintsScreen = {},
             optionsScreen = {},
-            navigateBack = {},
         )
     }
 }
@@ -650,7 +649,6 @@ private fun LargeScreenPreview() {
             actionScreen = {},
             constraintsScreen = {},
             optionsScreen = {},
-            navigateBack = {},
         )
     }
 }

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

@@ -72,6 +72,8 @@ class ConfigKeyMapUseCaseController(
         coroutineScope,
         preferenceRepository,
     ) {
+
+    private var originalKeyMap: KeyMap? = null
     override val keyMap = MutableStateFlow<State<KeyMap>>(State.Loading)
 
     override val floatingButtonToUse: MutableStateFlow<String?> = MutableStateFlow(null)
@@ -111,6 +113,15 @@ class ConfigKeyMapUseCaseController(
             emptyList(),
         )
 
+    /**
+     * Whether any changes were made to the key map.
+     */
+    override val isEdited: Boolean
+        get() = when (val keyMap = keyMap.value) {
+            is State.Data<KeyMap> -> originalKeyMap?.let { it != keyMap.data } ?: false
+            State.Loading -> false
+        }
+
     init {
         // Update button data in the key map whenever the floating buttons changes.
         coroutineScope.launch {
@@ -822,11 +833,15 @@ class ConfigKeyMapUseCaseController(
             .map { it.data }
             .first()
 
-        keyMap.update { State.Data(KeyMapEntityMapper.fromEntity(entity, floatingButtons)) }
+        val keyMap = KeyMapEntityMapper.fromEntity(entity, floatingButtons)
+        this.keyMap.update { State.Data(keyMap) }
+        originalKeyMap = keyMap
     }
 
     override fun loadNewKeyMap() {
-        keyMap.update { State.Data(KeyMap()) }
+        val keyMap = KeyMap()
+        this.keyMap.update { State.Data(keyMap) }
+        originalKeyMap = keyMap
     }
 
     override fun save() {
@@ -933,6 +948,7 @@ class ConfigKeyMapUseCaseController(
 
 interface ConfigKeyMapUseCase : GetDefaultKeyMapOptionsUseCase {
     val keyMap: Flow<State<KeyMap>>
+    val isEdited: Boolean
 
     fun save()
 

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

@@ -83,6 +83,9 @@ class ConfigKeyMapViewModel(
         .map { state -> state.dataOrNull()?.isEnabled ?: true }
         .stateIn(viewModelScope, SharingStarted.Eagerly, true)
 
+    val isKeyMapEdited: Boolean
+        get() = config.isEdited
+
     fun save() = config.save()
 
     fun saveState(outState: Bundle) {