From ff275c82aab78f6b563fa0a87683186ff1b4d4de Mon Sep 17 00:00:00 2001
From: Jimmy <jimmyxgong@google.com>
Date: Fri, 13 Sep 2024 20:26:25 +0000
Subject: [PATCH] Mouse: Add preference toggle for mouse reverse vertical
 scrolling

Bug: 359349392
Bug: 352598211
Test: Local DUT with aconfig flags enabled, verified settings appears
and is togglable. Verified toggle affects mouse scroll direction.

Flag: com.android.hardware.input.mouse_reverse_vertical_scrolling

Change-Id: I9620ac9bd33da7660c7a53f969426becc4f283cc
---
 res/values/strings.xml                        |   4 +
 res/xml/trackpad_settings.xml                 |   7 +
 ...VerticalScrollingPreferenceController.java |  57 ++++++++
 ...icalScrollingPreferenceControllerTest.java | 122 ++++++++++++++++++
 4 files changed, 190 insertions(+)
 create mode 100644 src/com/android/settings/inputmethod/MouseReverseVerticalScrollingPreferenceController.java
 create mode 100644 tests/robotests/src/com/android/settings/inputmethod/MouseReverseVerticalScrollingPreferenceControllerTest.java

diff --git a/res/values/strings.xml b/res/values/strings.xml
index 5326fa5d7a9..9f1dbb75501 100644
--- a/res/values/strings.xml
+++ b/res/values/strings.xml
@@ -4543,6 +4543,10 @@
     <string name="mouse_keys">Mouse keys</string>
     <!-- Summary text for the accessibility setting 'Mouse keys' preference sub-screen. [CHAR LIMIT=100] -->
     <string name="mouse_keys_summary">Use your keyboard to control the pointer</string>
+    <!-- Title for the 'Mouse reverse scrolling' preference switch, which reverses the direction of mouse scroll wheels so that moving the wheel up scrolls the content down. [CHAR LIMIT=60] -->
+    <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 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 7e9494476fe..862a48a9603 100644
--- a/res/xml/trackpad_settings.xml
+++ b/res/xml/trackpad_settings.xml
@@ -62,6 +62,13 @@
         android:selectable="false"
         settings:controller="com.android.settings.inputmethod.TrackpadPointerSpeedPreferenceController"/>
 
+    <SwitchPreferenceCompat
+        android:key="mouse_reverse_vertical_scrolling"
+        android:title="@string/mouse_reverse_vertical_scrolling"
+        android:summary="@string/mouse_reverse_vertical_scrolling_summary"
+        settings:controller="com.android.settings.inputmethod.MouseReverseVerticalScrollingPreferenceController"
+        android:order="45"/>
+
     <Preference
         android:fragment="com.android.settings.inputmethod.PointerTouchpadFragment"
         android:key="pointer_and_touchpad"
diff --git a/src/com/android/settings/inputmethod/MouseReverseVerticalScrollingPreferenceController.java b/src/com/android/settings/inputmethod/MouseReverseVerticalScrollingPreferenceController.java
new file mode 100644
index 00000000000..977e906e2a5
--- /dev/null
+++ b/src/com/android/settings/inputmethod/MouseReverseVerticalScrollingPreferenceController.java
@@ -0,0 +1,57 @@
+/*
+ * Copyright (C) 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 MouseReverseVerticalScrollingPreferenceController extends TogglePreferenceController {
+
+    public MouseReverseVerticalScrollingPreferenceController(
+            @NonNull Context context, @NonNull String key) {
+        super(context, key);
+    }
+
+    @Override
+    public boolean isChecked() {
+        return InputSettings.isMouseReverseVerticalScrollingEnabled(mContext);
+    }
+
+    @Override
+    public boolean setChecked(boolean isChecked) {
+        InputSettings.setMouseReverseVerticalScrolling(mContext, isChecked);
+        return true;
+    }
+
+    @Override
+    public int getAvailabilityStatus() {
+        if (!InputSettings.isMouseReverseVerticalScrollingFeatureFlagEnabled()) {
+            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/MouseReverseVerticalScrollingPreferenceControllerTest.java b/tests/robotests/src/com/android/settings/inputmethod/MouseReverseVerticalScrollingPreferenceControllerTest.java
new file mode 100644
index 00000000000..a962b1ade14
--- /dev/null
+++ b/tests/robotests/src/com/android/settings/inputmethod/MouseReverseVerticalScrollingPreferenceControllerTest.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 MouseReverseVerticalScrollingPreferenceControllerTest {
+    @Rule
+    public final SetFlagsRule mSetFlagsRule = new SetFlagsRule();
+
+    private static final String PREFERENCE_KEY = "mouse_reverse_vertical_scrolling";
+    private static final String SETTING_KEY = Settings.System.MOUSE_REVERSE_VERTICAL_SCROLLING;
+
+    private Context mContext;
+    private MouseReverseVerticalScrollingPreferenceController mController;
+
+    @Before
+    public void setUp() {
+        mContext = ApplicationProvider.getApplicationContext();
+        mController = new MouseReverseVerticalScrollingPreferenceController(
+                mContext, PREFERENCE_KEY);
+    }
+
+    @Test
+    @EnableFlags(Flags.FLAG_MOUSE_REVERSE_VERTICAL_SCROLLING)
+    public void getAvailabilityStatus_expected() {
+        assertThat(mController.getAvailabilityStatus())
+                .isEqualTo(BasePreferenceController.AVAILABLE);
+    }
+
+    @Test
+    @DisableFlags(Flags.FLAG_MOUSE_REVERSE_VERTICAL_SCROLLING)
+    public void getAvailabilityStatus_flagIsDisabled_notSupport() {
+        assertThat(mController.getAvailabilityStatus())
+                .isEqualTo(BasePreferenceController.UNSUPPORTED_ON_DEVICE);
+    }
+
+    @Test
+    @EnableFlags(Flags.FLAG_MOUSE_REVERSE_VERTICAL_SCROLLING)
+    public void setChecked_true_shouldReturn1() {
+        mController.setChecked(true);
+
+        boolean isEnabled = InputSettings.isMouseReverseVerticalScrollingEnabled(mContext);
+        assertThat(isEnabled).isTrue();
+    }
+
+    @Test
+    @EnableFlags(Flags.FLAG_MOUSE_REVERSE_VERTICAL_SCROLLING)
+    public void setChecked_false_shouldReturn0() {
+        mController.setChecked(false);
+
+        boolean isEnabled = InputSettings.isMouseReverseVerticalScrollingEnabled(mContext);
+        assertThat(isEnabled).isFalse();
+    }
+
+    @Test
+    @EnableFlags(Flags.FLAG_MOUSE_REVERSE_VERTICAL_SCROLLING)
+    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_REVERSE_VERTICAL_SCROLLING)
+    public void isChecked_providerPutInt0_returnFalse() {
+        Settings.System.putIntForUser(
+                mContext.getContentResolver(),
+                SETTING_KEY,
+                0,
+                UserHandle.USER_CURRENT);
+
+        boolean result = mController.isChecked();
+
+        assertThat(result).isFalse();
+    }
+}