From 449f4eeebc1f2c1e82c7e1f7d265398a9dd3e91d Mon Sep 17 00:00:00 2001
From: Jimmy <jimmyxgong@google.com>
Date: Fri, 20 Sep 2024 22:47:52 +0000
Subject: [PATCH] mouse: Add preference toggle for Mouse swap primary button

Bug: 359349392
Bug: 352598211
Test: Local DUT with aconfig flags enabled, verified settings
      appeared and swaps the mouse primary button

Flag: com.android.hardware.input.mouse_swap_primary_button

Change-Id: Ib762240c10e2cadcfa4a23cd78df81fcad8197dd
---
 res/values/strings.xml                        |   4 +
 res/xml/trackpad_settings.xml                 |   7 +
 ...SwapPrimaryButtonPreferenceController.java |  57 ++++++++
 ...PrimaryButtonPreferenceControllerTest.java | 122 ++++++++++++++++++
 4 files changed, 190 insertions(+)
 create mode 100644 src/com/android/settings/inputmethod/MouseSwapPrimaryButtonPreferenceController.java
 create mode 100644 tests/robotests/src/com/android/settings/inputmethod/MouseSwapPrimaryButtonPreferenceControllerTest.java

diff --git a/res/values/strings.xml b/res/values/strings.xml
index 9f1dbb75501..a87fecb9c98 100644
--- a/res/values/strings.xml
+++ b/res/values/strings.xml
@@ -4547,6 +4547,10 @@
     <string name="mouse_reverse_vertical_scrolling">Mouse reverse scrolling</string>
     <!-- Summary text for the 'Mouse reverse scrolling' preference switch indicating to users that when the setting is enabled that scrolling up with their mouse wheel will move the page content down. [CHAR LIMIT=NONE] -->
     <string name="mouse_reverse_vertical_scrolling_summary">Scroll up to move the page down</string>
+    <!-- Title for the 'Swap buttons' preference switch, which swaps the left and right buttons of connected mice so that right click will be the primary action button and left clicking will be the secondary action, for example showing the context menu. [CHAR LIMIT=60] -->
+    <string name="mouse_swap_primary_button">Swap left and right buttons</string>
+    <!-- Summary text for the 'Swap buttons' preference switch indicating to users that when this switch is enabled, their left click will behave as though it is the right click (secondary action) and that the right click will be the primary action. [CHAR LIMIT=NONE] -->
+    <string name="mouse_swap_primary_button_summary">Use the left mouse button as your right</string>
     <!-- Title for the button to trigger the 'keyboard shortcuts helper' dialog. [CHAR LIMIT=35] -->
     <string name="keyboard_shortcuts_helper">Keyboard shortcuts</string>
     <!-- Summary text for the 'keyboard shortcuts helper' dialog. [CHAR LIMIT=100] -->
diff --git a/res/xml/trackpad_settings.xml b/res/xml/trackpad_settings.xml
index 862a48a9603..2f7c7fcdd4a 100644
--- a/res/xml/trackpad_settings.xml
+++ b/res/xml/trackpad_settings.xml
@@ -69,6 +69,13 @@
         settings:controller="com.android.settings.inputmethod.MouseReverseVerticalScrollingPreferenceController"
         android:order="45"/>
 
+    <SwitchPreferenceCompat
+        android:key="mouse_swap_primary_button"
+        android:title="@string/mouse_swap_primary_button"
+        android:summary="@string/mouse_swap_primary_button_summary"
+        settings:controller="com.android.settings.inputmethod.MouseSwapPrimaryButtonPreferenceController"
+        android:order="47"/>
+
     <Preference
         android:fragment="com.android.settings.inputmethod.PointerTouchpadFragment"
         android:key="pointer_and_touchpad"
diff --git a/src/com/android/settings/inputmethod/MouseSwapPrimaryButtonPreferenceController.java b/src/com/android/settings/inputmethod/MouseSwapPrimaryButtonPreferenceController.java
new file mode 100644
index 00000000000..88199d8d64e
--- /dev/null
+++ b/src/com/android/settings/inputmethod/MouseSwapPrimaryButtonPreferenceController.java
@@ -0,0 +1,57 @@
+/*
+ * Copyright 2024 The Android Open Source Project
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.android.settings.inputmethod;
+
+import android.content.Context;
+import android.hardware.input.InputSettings;
+
+import androidx.annotation.NonNull;
+
+import com.android.settings.R;
+import com.android.settings.core.TogglePreferenceController;
+
+public class MouseSwapPrimaryButtonPreferenceController extends TogglePreferenceController {
+
+    public MouseSwapPrimaryButtonPreferenceController(
+            @NonNull Context context, @NonNull String key) {
+        super(context, key);
+    }
+
+    @Override
+    public boolean isChecked() {
+        return InputSettings.isMouseSwapPrimaryButtonEnabled(mContext);
+    }
+
+    @Override
+    public boolean setChecked(boolean isChecked) {
+        InputSettings.setMouseSwapPrimaryButton(mContext, isChecked);
+        return true;
+    }
+
+    @Override
+    public int getAvailabilityStatus() {
+        if (!InputSettings.isMouseSwapPrimaryButtonFeatureFlagEnabled()) {
+            return UNSUPPORTED_ON_DEVICE;
+        }
+        return AVAILABLE;
+    }
+
+    @Override
+    public int getSliceHighlightMenuRes() {
+        return R.string.menu_key_system;
+    }
+}
diff --git a/tests/robotests/src/com/android/settings/inputmethod/MouseSwapPrimaryButtonPreferenceControllerTest.java b/tests/robotests/src/com/android/settings/inputmethod/MouseSwapPrimaryButtonPreferenceControllerTest.java
new file mode 100644
index 00000000000..fe401f29c5a
--- /dev/null
+++ b/tests/robotests/src/com/android/settings/inputmethod/MouseSwapPrimaryButtonPreferenceControllerTest.java
@@ -0,0 +1,122 @@
+/*
+ * Copyright 2024 The Android Open Source Project
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.android.settings.inputmethod;
+
+import static com.google.common.truth.Truth.assertThat;
+
+import android.content.Context;
+import android.hardware.input.InputSettings;
+import android.os.UserHandle;
+import android.platform.test.annotations.DisableFlags;
+import android.platform.test.annotations.EnableFlags;
+import android.platform.test.flag.junit.SetFlagsRule;
+import android.provider.Settings;
+
+import androidx.test.core.app.ApplicationProvider;
+
+import com.android.hardware.input.Flags;
+import com.android.settings.core.BasePreferenceController;
+
+import org.junit.Before;
+import org.junit.Rule;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.robolectric.RobolectricTestRunner;
+import org.robolectric.annotation.Config;
+
+/** Tests for {@link MouseReverseVerticalScrollingPreferenceController} */
+@RunWith(RobolectricTestRunner.class)
+@Config(shadows = {
+        com.android.settings.testutils.shadow.ShadowSystemSettings.class,
+})
+public class MouseSwapPrimaryButtonPreferenceControllerTest {
+    @Rule
+    public final SetFlagsRule mSetFlagsRule = new SetFlagsRule();
+
+    private static final String PREFERENCE_KEY = "mouse_swap_primary_button";
+    private static final String SETTING_KEY = Settings.System.MOUSE_SWAP_PRIMARY_BUTTON;
+
+    private Context mContext;
+    private MouseSwapPrimaryButtonPreferenceController mController;
+
+    @Before
+    public void setUp() {
+        mContext = ApplicationProvider.getApplicationContext();
+        mController = new MouseSwapPrimaryButtonPreferenceController(
+                mContext, PREFERENCE_KEY);
+    }
+
+    @Test
+    @EnableFlags(Flags.FLAG_MOUSE_SWAP_PRIMARY_BUTTON)
+    public void getAvailabilityStatus_expected() {
+        assertThat(mController.getAvailabilityStatus())
+                .isEqualTo(BasePreferenceController.AVAILABLE);
+    }
+
+    @Test
+    @DisableFlags(Flags.FLAG_MOUSE_SWAP_PRIMARY_BUTTON)
+    public void getAvailabilityStatus_flagIsDisabled_notSupport() {
+        assertThat(mController.getAvailabilityStatus())
+                .isEqualTo(BasePreferenceController.UNSUPPORTED_ON_DEVICE);
+    }
+
+    @Test
+    @EnableFlags(Flags.FLAG_MOUSE_SWAP_PRIMARY_BUTTON)
+    public void setChecked_true_shouldReturn1() {
+        mController.setChecked(true);
+
+        boolean isEnabled = InputSettings.isMouseSwapPrimaryButtonEnabled(mContext);
+        assertThat(isEnabled).isTrue();
+    }
+
+    @Test
+    @EnableFlags(Flags.FLAG_MOUSE_SWAP_PRIMARY_BUTTON)
+    public void setChecked_false_shouldReturn0() {
+        mController.setChecked(false);
+
+        boolean isEnabled = InputSettings.isMouseSwapPrimaryButtonEnabled(mContext);
+        assertThat(isEnabled).isFalse();
+    }
+
+    @Test
+    @EnableFlags(Flags.FLAG_MOUSE_SWAP_PRIMARY_BUTTON)
+    public void isChecked_providerPutInt1_returnTrue() {
+        Settings.System.putIntForUser(
+                mContext.getContentResolver(),
+                SETTING_KEY,
+                1,
+                UserHandle.USER_CURRENT);
+
+        boolean result = mController.isChecked();
+
+        assertThat(result).isTrue();
+    }
+
+    @Test
+    @EnableFlags(Flags.FLAG_MOUSE_SWAP_PRIMARY_BUTTON)
+    public void isChecked_providerPutInt0_returnFalse() {
+        Settings.System.putIntForUser(
+                mContext.getContentResolver(),
+                SETTING_KEY,
+                0,
+                UserHandle.USER_CURRENT);
+
+        boolean result = mController.isChecked();
+
+        assertThat(result).isFalse();
+    }
+}