Make gestures configurable (+ breaking: swap left/right) (#5512)

* Add configurable gestures

 - Add a setting for gesture actions depending on the directions and number of pointers. (UI to follow later.)
 - Change default for left/right swipe with 3 pointers to match iOS.

* Add settings screen for gestures

 - Add a new "Gestures" screen to configure the configurable webview gestures.
 - Change gestures to a list of enums so all possible combinations are known in advance (and we can do migrations if needed).
 - Extract list subheader to SettingsSubheader composable

* Screenshot tests for new common composables

* Add another enum for GesturePointers

* Add tests for gesture defaults/none/customized

Author: jpelgrom

app/src/fullDebug/screenshotTest/reference/io/homeassistant/companion/android/settings/views/SettingsRowScreenshotTest/SettingsRow with MDI icon off_0.png

@@ -36,6 +36,7 @@ import io.homeassistant.companion.android.nfc.NfcSetupActivity
 import io.homeassistant.companion.android.onboarding.OnboardApp
 import io.homeassistant.companion.android.settings.controls.ManageControlsSettingsFragment
 import io.homeassistant.companion.android.settings.developer.DeveloperSettingsFragment
+import io.homeassistant.companion.android.settings.gestures.GesturesFragment
 import io.homeassistant.companion.android.settings.language.LanguagesProvider
 import io.homeassistant.companion.android.settings.notification.NotificationChannelFragment
 import io.homeassistant.companion.android.settings.notification.NotificationHistoryFragment
@@ -161,6 +162,14 @@ class SettingsFragment(
             }
         }
 
+        findPreference<Preference>("gestures")?.setOnPreferenceClickListener {
+            parentFragmentManager.commit {
+                replace(R.id.content, GesturesFragment::class.java, null)
+                addToBackStack(getString(commonR.string.gestures))
+            }
+            return@setOnPreferenceClickListener true
+        }
+
         findPreference<ListPreference>("page_zoom")?.let {
             // The list of percentages for iOS/Android should match
             // https://github.com/home-assistant/iOS/blob/ff66bbf2e3f9add0abb0b492499b81e824db36ed/Sources/Shared/Settings/SettingsStore.swift#L108

app/src/fullDebug/screenshotTest/reference/io/homeassistant/companion/android/settings/views/SettingsRowScreenshotTest/SettingsRow with MDI icon on_0.png

@@ -0,0 +1,42 @@
+package io.homeassistant.companion.android.settings.gestures
+
+import android.os.Bundle
+import android.view.LayoutInflater
+import android.view.View
+import android.view.ViewGroup
+import androidx.compose.ui.platform.ComposeView
+import androidx.fragment.app.Fragment
+import androidx.fragment.app.viewModels
+import dagger.hilt.android.AndroidEntryPoint
+import io.homeassistant.companion.android.common.R as commonR
+import io.homeassistant.companion.android.settings.gestures.views.GesturesView
+import io.homeassistant.companion.android.util.compose.HomeAssistantAppTheme
+import kotlin.getValue
+
+@AndroidEntryPoint
+class GesturesFragment : Fragment() {
+
+    val viewModel: GesturesViewModel by viewModels()
+
+    override fun onCreateView(
+        inflater: LayoutInflater,
+        container: ViewGroup?,
+        savedInstanceState: Bundle?,
+    ): View {
+        return ComposeView(requireContext()).apply {
+            setContent {
+                HomeAssistantAppTheme {
+                    GesturesView(
+                        gestureActions = viewModel.gestureActions,
+                        onSetAction = viewModel::setGestureAction,
+                    )
+                }
+            }
+        }
+    }
+
+    override fun onResume() {
+        super.onResume()
+        activity?.title = getString(commonR.string.gestures)
+    }
+}

app/src/fullDebug/screenshotTest/reference/io/homeassistant/companion/android/settings/views/SettingsRowScreenshotTest/SettingsRow with custom icon composable_0.png

@@ -0,0 +1,34 @@
+package io.homeassistant.companion.android.settings.gestures
+
+import androidx.compose.runtime.mutableStateMapOf
+import androidx.lifecycle.ViewModel
+import androidx.lifecycle.viewModelScope
+import dagger.hilt.android.lifecycle.HiltViewModel
+import io.homeassistant.companion.android.common.data.prefs.PrefsRepository
+import io.homeassistant.companion.android.common.util.GestureAction
+import io.homeassistant.companion.android.common.util.HAGesture
+import javax.inject.Inject
+import kotlinx.coroutines.launch
+
+@HiltViewModel
+class GesturesViewModel @Inject constructor(
+    private val prefsRepository: PrefsRepository,
+) : ViewModel() {
+
+    val gestureActions = mutableStateMapOf<HAGesture, GestureAction>()
+
+    init {
+        viewModelScope.launch {
+            HAGesture.entries.forEach {
+                gestureActions[it] = prefsRepository.getGestureAction(it)
+            }
+        }
+    }
+
+    fun setGestureAction(gesture: HAGesture, action: GestureAction) {
+        viewModelScope.launch {
+            prefsRepository.setGestureAction(gesture, action)
+            gestureActions[gesture] = action
+        }
+    }
+}

app/src/fullDebug/screenshotTest/reference/io/homeassistant/companion/android/settings/views/SettingsRowScreenshotTest/SettingsRow with only title and subtitle_0.png

@@ -0,0 +1,104 @@
+package io.homeassistant.companion.android.settings.gestures.views
+
+import androidx.compose.foundation.layout.Box
+import androidx.compose.foundation.layout.PaddingValues
+import androidx.compose.foundation.layout.padding
+import androidx.compose.foundation.lazy.LazyColumn
+import androidx.compose.foundation.lazy.items
+import androidx.compose.material.Divider
+import androidx.compose.material.DropdownMenu
+import androidx.compose.material.DropdownMenuItem
+import androidx.compose.material.Text
+import androidx.compose.runtime.Composable
+import androidx.compose.runtime.getValue
+import androidx.compose.runtime.mutableStateOf
+import androidx.compose.runtime.remember
+import androidx.compose.runtime.setValue
+import androidx.compose.ui.Modifier
+import androidx.compose.ui.res.stringResource
+import androidx.compose.ui.tooling.preview.Preview
+import androidx.compose.ui.unit.DpOffset
+import androidx.compose.ui.unit.dp
+import io.homeassistant.companion.android.common.R
+import io.homeassistant.companion.android.common.util.GestureAction
+import io.homeassistant.companion.android.common.util.HAGesture
+import io.homeassistant.companion.android.settings.views.SettingsRow
+import io.homeassistant.companion.android.settings.views.SettingsSubheader
+import io.homeassistant.companion.android.util.plus
+import io.homeassistant.companion.android.util.safeBottomPaddingValues
+
+@Composable
+fun GesturesView(
+    gestureActions: Map<HAGesture, GestureAction>,
+    onSetAction: (HAGesture, GestureAction) -> Unit,
+) {
+    LazyColumn(
+        contentPadding = PaddingValues(vertical = 16.dp) + safeBottomPaddingValues(applyHorizontal = false),
+    ) {
+        item {
+            Text(
+                text = stringResource(R.string.gestures_description),
+                modifier = Modifier.padding(horizontal = 16.dp),
+            )
+            Divider(
+                modifier = Modifier.padding(all = 16.dp),
+            )
+        }
+
+        val gesturesGrouped = HAGesture.entries.groupBy { it.direction }
+        gesturesGrouped.forEach { (direction, gestures) ->
+            item {
+                SettingsSubheader(stringResource(direction.description))
+            }
+            items(gestures) { gesture ->
+                GestureSettingRow(
+                    gesture = gesture,
+                    action = gestureActions[gesture],
+                    onSetAction = { action -> onSetAction(gesture, action) },
+                )
+            }
+        }
+    }
+}
+
+@Composable
+private fun GestureSettingRow(
+    gesture: HAGesture,
+    action: GestureAction?,
+    onSetAction: (GestureAction) -> Unit,
+) {
+    var expanded by remember { mutableStateOf(false) }
+
+    Box {
+        SettingsRow(
+            primaryText = stringResource(gesture.pointers.description),
+            secondaryText = action?.let { stringResource(it.description) } ?: "",
+            icon = null,
+            onClicked = { expanded = true },
+        )
+        DropdownMenu(
+            expanded = expanded,
+            onDismissRequest = { expanded = false },
+            // Prevent dropdown menu hitting screen edge which looks wrong
+            offset = DpOffset(x = 8.dp, y = 0.dp),
+        ) {
+            GestureAction.entries.forEach { action ->
+                DropdownMenuItem({
+                    onSetAction(action)
+                    expanded = false
+                }) {
+                    Text(stringResource(action.description))
+                }
+            }
+        }
+    }
+}
+
+@Preview
+@Composable
+private fun PreviewGesturesView() {
+    GesturesView(
+        gestureActions = HAGesture.entries.associateWith { GestureAction.NONE },
+        onSetAction = { _, _ -> },
+    )
+}