Merge branch 'develop' into copilot/refactor-volume-actions

Author: sds100

app/version.properties

@@ -1,3 +1,3 @@
 VERSION_NAME=4.0.0-beta.1
-VERSION_CODE=175
+VERSION_CODE=176
 VERSION_NUM=01

base/src/main/java/io/github/sds100/keymapper/base/actions/ActionsScreen.kt

@@ -42,6 +42,8 @@ import io.github.sds100.keymapper.base.actions.keyevent.FixKeyEventActionBottomS
 import io.github.sds100.keymapper.base.compose.KeyMapperTheme
 import io.github.sds100.keymapper.base.keymaps.ShortcutModel
 import io.github.sds100.keymapper.base.keymaps.ShortcutRow
+import io.github.sds100.keymapper.base.onboarding.OnboardingTipModel
+import io.github.sds100.keymapper.base.onboarding.TipCard
 import io.github.sds100.keymapper.base.utils.ui.LinkType
 import io.github.sds100.keymapper.base.utils.ui.compose.ComposeIconInfo
 import io.github.sds100.keymapper.base.utils.ui.compose.DraggableItem
@@ -56,6 +58,7 @@ fun ActionsScreen(modifier: Modifier = Modifier, viewModel: ConfigActionsViewMod
     val sheetState = rememberModalBottomSheetState(skipPartiallyExpanded = true)
     val state by viewModel.state.collectAsStateWithLifecycle()
     val optionsState by viewModel.actionOptionsState.collectAsStateWithLifecycle()
+    val actionTipModel by viewModel.actionsTip.collectAsStateWithLifecycle()
 
     if (optionsState != null) {
         ActionOptionsBottomSheet(
@@ -91,27 +94,33 @@ fun ActionsScreen(modifier: Modifier = Modifier, viewModel: ConfigActionsViewMod
     ActionsScreen(
         modifier = modifier,
         state = state,
+        tipModel = actionTipModel,
         onRemoveClick = viewModel::onRemoveClick,
         onEditClick = viewModel::onEditClick,
         onMoveAction = viewModel::onMoveAction,
         onFixErrorClick = viewModel::onFixError,
         onClickShortcut = viewModel::onClickShortcut,
         onTestClick = viewModel::onTestClick,
         onAddClick = viewModel::onAddActionClick,
+        onActionTipDismiss = viewModel::onActionTipDismissClick,
+        onTipButtonClick = viewModel::onTipButtonClick,
     )
 }
 
 @Composable
 private fun ActionsScreen(
     modifier: Modifier = Modifier,
     state: State<ConfigActionsState>,
+    tipModel: OnboardingTipModel? = null,
     onAddClick: () -> Unit = {},
     onRemoveClick: (String) -> Unit = {},
     onEditClick: (String) -> Unit = {},
     onMoveAction: (fromIndex: Int, toIndex: Int) -> Unit = { _, _ -> },
     onFixErrorClick: (String) -> Unit = {},
     onTestClick: (String) -> Unit = {},
     onClickShortcut: (ActionData) -> Unit = {},
+    onActionTipDismiss: () -> Unit = {},
+    onTipButtonClick: (String) -> Unit = {},
 ) {
     var showDeleteDialog by rememberSaveable { mutableStateOf(false) }
     var actionToDelete by rememberSaveable { mutableStateOf<String?>(null) }
@@ -143,6 +152,25 @@ private fun ActionsScreen(
         State.Loading -> Loading()
         is State.Data<ConfigActionsState> -> Surface(modifier = modifier) {
             Column {
+                Spacer(Modifier.height(8.dp))
+
+                // Display action tip if available
+                tipModel?.let { tip ->
+                    TipCard(
+                        modifier = Modifier
+                            .fillMaxWidth()
+                            .padding(horizontal = 16.dp),
+                        title = tip.title,
+                        message = tip.message,
+                        isDismissable = tip.isDismissable,
+                        onDismiss = onActionTipDismiss,
+                        buttonText = tip.buttonText,
+                        onButtonClick = { onTipButtonClick(tip.id) },
+                    )
+
+                    Spacer(Modifier.height(8.dp))
+                }
+
                 when (val data = state.data) {
                     is ConfigActionsState.Empty -> {
                         Column(
@@ -178,8 +206,6 @@ private fun ActionsScreen(
                     }
 
                     is ConfigActionsState.Loaded -> {
-                        Spacer(Modifier.height(8.dp))
-
                         if (data.actions.isNotEmpty()) {
                             Spacer(Modifier.height(8.dp))
 

base/src/main/java/io/github/sds100/keymapper/base/actions/ConfigActionsViewModel.kt

@@ -7,6 +7,7 @@ import io.github.sds100.keymapper.base.R
 import io.github.sds100.keymapper.base.actions.keyevent.FixKeyEventActionDelegate
 import io.github.sds100.keymapper.base.keymaps.KeyMap
 import io.github.sds100.keymapper.base.keymaps.ShortcutModel
+import io.github.sds100.keymapper.base.onboarding.OnboardingTipDelegate
 import io.github.sds100.keymapper.base.onboarding.SetupAccessibilityServiceDelegate
 import io.github.sds100.keymapper.base.utils.getFullMessage
 import io.github.sds100.keymapper.base.utils.isFixable
@@ -48,6 +49,7 @@ class ConfigActionsViewModel @Inject constructor(
     private val config: ConfigActionsUseCase,
     setupAccessibilityServiceDelegate: SetupAccessibilityServiceDelegate,
     fixKeyEventActionDelegate: FixKeyEventActionDelegate,
+    onboardingTipDelegate: OnboardingTipDelegate,
     resourceProvider: ResourceProvider,
     navigationProvider: NavigationProvider,
     dialogProvider: DialogProvider,
@@ -57,7 +59,8 @@ class ConfigActionsViewModel @Inject constructor(
     ResourceProvider by resourceProvider,
     DialogProvider by dialogProvider,
     NavigationProvider by navigationProvider,
-    FixKeyEventActionDelegate by fixKeyEventActionDelegate {
+    FixKeyEventActionDelegate by fixKeyEventActionDelegate,
+    OnboardingTipDelegate by onboardingTipDelegate {
 
     val createActionDelegate =
         CreateActionDelegate(viewModelScope, createAction, this, this, this)

base/src/main/java/io/github/sds100/keymapper/base/onboarding/OnboardingTipDelegate.kt

@@ -1,14 +1,21 @@
 package io.github.sds100.keymapper.base.onboarding
 
+import android.os.Build
 import dagger.hilt.android.scopes.ViewModelScoped
 import io.github.sds100.keymapper.base.R
-import io.github.sds100.keymapper.base.keymaps.DisplayKeyMapUseCase
+import io.github.sds100.keymapper.base.actions.Action
+import io.github.sds100.keymapper.base.actions.ActionData
+import io.github.sds100.keymapper.base.actions.ConfigActionsUseCase
 import io.github.sds100.keymapper.base.trigger.ConfigTriggerUseCase
 import io.github.sds100.keymapper.base.trigger.KeyCodeTriggerKey
 import io.github.sds100.keymapper.base.trigger.KeyEventTriggerKey
 import io.github.sds100.keymapper.base.trigger.Trigger
 import io.github.sds100.keymapper.base.trigger.TriggerMode
+import io.github.sds100.keymapper.base.utils.navigation.NavDestination
+import io.github.sds100.keymapper.base.utils.navigation.NavigationProvider
+import io.github.sds100.keymapper.base.utils.navigation.navigate
 import io.github.sds100.keymapper.base.utils.ui.ResourceProvider
+import io.github.sds100.keymapper.common.utils.Constants
 import io.github.sds100.keymapper.common.utils.dataOrNull
 import io.github.sds100.keymapper.data.Keys
 import io.github.sds100.keymapper.data.repositories.PreferenceRepository
@@ -28,9 +35,11 @@ class OnboardingTipDelegateImpl @Inject constructor(
     private val viewModelScope: CoroutineScope,
     private val preferenceRepository: PreferenceRepository,
     private val configTriggerUseCase: ConfigTriggerUseCase,
-    private val displayKeyMap: DisplayKeyMapUseCase,
+    private val configActionsUseCase: ConfigActionsUseCase,
     resourceProvider: ResourceProvider,
+    navigationProvider: NavigationProvider
 ) : OnboardingTipDelegate,
+    NavigationProvider by navigationProvider,
     PreferenceRepository by preferenceRepository,
     ResourceProvider by resourceProvider {
 
@@ -42,9 +51,11 @@ class OnboardingTipDelegateImpl @Inject constructor(
         const val CAPS_LOCK_TIP_ID = "caps_lock_tip"
         const val SCREEN_PINNING_TIP_ID = "screen_pinning_tip"
         const val IME_DETECTION_TIP_ID = "ime_detection_tip"
+        const val RINGER_MODE_TIP_ID = "ringer_mode_tip"
     }
 
     override val triggerTip: MutableStateFlow<OnboardingTipModel?> = MutableStateFlow(null)
+    override val actionsTip: MutableStateFlow<OnboardingTipModel?> = MutableStateFlow(null)
 
     private var shownParallelTriggerOrderExplanation: Boolean by PrefDelegate(
         Keys.shownParallelTriggerOrderExplanation,
@@ -76,6 +87,11 @@ class OnboardingTipDelegateImpl @Inject constructor(
         false,
     )
 
+    private var shownRingerModeTip: Boolean by PrefDelegate(
+        Keys.shownRingerModeTip,
+        false,
+    )
+
     init {
         viewModelScope.launch {
             configTriggerUseCase.keyMap
@@ -84,9 +100,17 @@ class OnboardingTipDelegateImpl @Inject constructor(
                     onCollectTrigger(trigger)
                 }
         }
+
+        viewModelScope.launch {
+            configActionsUseCase.keyMap
+                .mapNotNull { it.dataOrNull()?.actionList }
+                .collect { actionList ->
+                    onCollectActions(actionList)
+                }
+        }
     }
 
-    override fun onDismissClick() {
+    override fun onTriggerTipDismissClick() {
         val currentTip = triggerTip.value
 
         when (currentTip?.id) {
@@ -120,7 +144,29 @@ class OnboardingTipDelegateImpl @Inject constructor(
         triggerTip.value = null
     }
 
-    private suspend fun onCollectTrigger(trigger: Trigger) {
+    override fun onActionTipDismissClick() {
+        val currentTip = actionsTip.value
+
+        when (currentTip?.id) {
+            RINGER_MODE_TIP_ID -> {
+                shownRingerModeTip = true
+            }
+        }
+
+        actionsTip.value = null
+    }
+
+    override fun onTipButtonClick(tipId: String) {
+        when (tipId) {
+            RINGER_MODE_TIP_ID -> {
+                viewModelScope.launch {
+                    navigate("ringer_mode_tip_pro_mode", NavDestination.ProMode)
+                }
+            }
+        }
+    }
+
+    private fun onCollectTrigger(trigger: Trigger) {
         val showPowerButtonEmergencyTip = trigger.keys.any {
             it is KeyCodeTriggerKey && KeyEventUtils.isPowerButtonKey(
                 it.keyCode,
@@ -214,10 +260,36 @@ class OnboardingTipDelegateImpl @Inject constructor(
             }
         }
     }
+
+    private fun onCollectActions(actionList: List<Action>) {
+        val hasRingerModeAction = actionList.any { action ->
+            when (action.data) {
+                is ActionData.Volume.SetRingerMode,
+                is ActionData.Volume.CycleRingerMode,
+                is ActionData.Volume.CycleVibrateRing -> true
+
+                else -> false
+            }
+        }
+
+        if (hasRingerModeAction && !shownRingerModeTip && Build.VERSION.SDK_INT >= Constants.SYSTEM_BRIDGE_MIN_API) {
+            val tip = OnboardingTipModel(
+                id = RINGER_MODE_TIP_ID,
+                title = getString(R.string.tip_ringer_mode_title),
+                message = getString(R.string.tip_ringer_mode_text),
+                isDismissable = true,
+                buttonText = getString(R.string.tip_ringer_mode_button),
+            )
+            actionsTip.value = tip
+        }
+    }
 }
 
 interface OnboardingTipDelegate {
     val triggerTip: StateFlow<OnboardingTipModel?>
+    val actionsTip: StateFlow<OnboardingTipModel?>
 
-    fun onDismissClick()
+    fun onTriggerTipDismissClick()
+    fun onActionTipDismissClick()
+    fun onTipButtonClick(tipId: String)
 }

base/src/main/java/io/github/sds100/keymapper/base/onboarding/OnboardingTipModel.kt

@@ -5,4 +5,5 @@ data class OnboardingTipModel(
     val title: String,
     val message: String,
     val isDismissable: Boolean,
+    val buttonText: String? = null,
 )

base/src/main/java/io/github/sds100/keymapper/base/onboarding/TipCard.kt

@@ -12,12 +12,14 @@ import androidx.compose.foundation.layout.width
 import androidx.compose.material.icons.Icons
 import androidx.compose.material.icons.rounded.Close
 import androidx.compose.material.icons.rounded.Info
+import androidx.compose.material3.ButtonDefaults
 import androidx.compose.material3.CardDefaults
 import androidx.compose.material3.Icon
 import androidx.compose.material3.IconButton
 import androidx.compose.material3.MaterialTheme
 import androidx.compose.material3.OutlinedCard
 import androidx.compose.material3.Text
+import androidx.compose.material3.TextButton
 import androidx.compose.runtime.Composable
 import androidx.compose.ui.Alignment
 import androidx.compose.ui.Modifier
@@ -30,8 +32,10 @@ fun TipCard(
     modifier: Modifier = Modifier,
     title: String,
     message: String,
+    buttonText: String? = null,
     isDismissable: Boolean = true,
     onDismiss: () -> Unit = {},
+    onButtonClick: () -> Unit = {},
 ) {
     OutlinedCard(
         modifier = modifier,
@@ -70,7 +74,21 @@ fun TipCard(
                     style = MaterialTheme.typography.bodyMedium,
                 )
 
-                Spacer(modifier = Modifier.height(16.dp))
+                if (buttonText != null) {
+                    Spacer(modifier = Modifier.height(8.dp))
+
+                    TextButton(
+                        modifier = Modifier
+                            .padding(horizontal = 16.dp)
+                            .align(Alignment.End),
+                        onClick = onButtonClick,
+                        colors = ButtonDefaults.textButtonColors(contentColor = MaterialTheme.colorScheme.tertiary)
+                    ) {
+                        Text(buttonText)
+                    }
+                }
+
+                Spacer(modifier = Modifier.height(8.dp))
             }
 
             if (isDismissable) {
@@ -86,8 +104,8 @@ fun TipCard(
                         tint = MaterialTheme.colorScheme.onSurfaceVariant,
                     )
                 }
+                }
             }
-        }
     }
 }
 
@@ -98,6 +116,7 @@ private fun TipCardPreview() {
         TipCard(
             title = "Tip Title",
             message = "This is a helpful tip message that explains something important to the user. It can be multiple lines long and provides useful information.",
+            buttonText = "Button"
         )
     }
 }

base/src/main/java/io/github/sds100/keymapper/base/trigger/BaseTriggerScreen.kt

@@ -118,7 +118,9 @@ fun BaseTriggerScreen(
                         title = tip.title,
                         message = tip.message,
                         isDismissable = tip.isDismissable,
-                        onDismiss = viewModel::onDismissClick,
+                        onDismiss = viewModel::onTriggerTipDismissClick,
+                        buttonText = tip.buttonText,
+                        onButtonClick = { viewModel.onTipButtonClick(tip.id) },
                     )
 
                     Spacer(Modifier.height(8.dp))

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

@@ -1362,6 +1362,9 @@
     <string name="tip_screen_pinning_text">Using the back button as a trigger may conflict with app pinning, causing a black screen on unlock. A reboot will fix it.</string>
     <string name="tip_ime_detection_title">Keyboard icon</string>
     <string name="tip_ime_detection_text">The ⌨ symbol means you must use the Key Mapper input method for this trigger to work due to an Android restriction.</string>
+    <string name="tip_ringer_mode_title">Ringer mode actions</string>
+    <string name="tip_ringer_mode_text">Consider using PRO mode for ringer mode actions to avoid conflicts with Do Not Disturb settings.</string>
+    <string name="tip_ringer_mode_button">Use PRO mode</string>
     <string name="trigger_constraints_tip_title">Limit to specific apps?</string>
     <string name="trigger_constraints_tip_text">Add constraints in the Constraints tab.</string>
     <string name="choose_floating_layout_title">Choose a layout</string>

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

@@ -59,6 +59,8 @@ object Keys {
         booleanPreferencesKey("key_shown_caps_lock_tip")
     val shownScreenPinningTip =
         booleanPreferencesKey("key_shown_screen_pinning_tip")
+    val shownRingerModeTip =
+        booleanPreferencesKey("key_shown_ringer_mode_tip")
     val lastInstalledVersionCodeHomeScreen =
         intPreferencesKey("last_installed_version_home_screen")
     val lastInstalledVersionCodeBackground =

sysbridge/src/main/aidl/io/github/sds100/keymapper/sysbridge/ISystemBridge.aidl

@@ -40,4 +40,6 @@ interface ISystemBridge {
    void forceStopPackage(String packageName) = 16;
 
    void removeTasks(String packageName) = 17;
+
+   void setRingerMode(int ringerMode) = 18;
 }