From c3426d0a871c958a048c5267ecab2160f1215758 Mon Sep 17 00:00:00 2001
From: YuhanYang <yyhyyh@google.com>
Date: Fri, 13 Dec 2024 00:59:11 +0000
Subject: [PATCH] Add preference toggle for mouse scrolling acceleration

Bug: 383555305
Bug: 384795606
Test: Local DUT with aconfig flags enabled, verified settings appears
and is togglable. Verified toggle affects scrolling acceleration.

Flag: com.android.hardware.input.mouse_scrolling_acceleration
Change-Id: Ibba2bb1c3cb57b98ad34a5851bae7b9d73e48d74
---
 res/values/strings.xml                        |   3 +
 res/xml/mouse_settings.xml                    |   5 +
 res/xml/touchpad_and_mouse_settings.xml       |   6 +
 ...llingAccelerationPreferenceController.java |  57 ++++++++
 ...gAccelerationPreferenceControllerTest.java | 122 ++++++++++++++++++
 5 files changed, 193 insertions(+)
 create mode 100644 src/com/android/settings/inputmethod/MouseScrollingAccelerationPreferenceController.java
 create mode 100644 tests/robotests/src/com/android/settings/inputmethod/MouseScrollingAccelerationPreferenceControllerTest.java

diff --git a/res/values/strings.xml b/res/values/strings.xml
index 762288cc6f3..0b3330b17e3 100644
--- a/res/values/strings.xml
+++ b/res/values/strings.xml
@@ -4675,6 +4675,9 @@
     <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>
+    <!-- TODO(b/383555305): finalize these strings and mark them translatable. -->
+    <!-- Title for the 'Mouse controlled scrolling' preference switch, which disables the mouse scrolling acceleration so that the scrolling speed becomes directly proportional to the speed at which the wheel is turned. [CHAR LIMIT=60]-->
+    <string name="mouse_scrolling_acceleration" translatable="false">Controlled scrolling</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] -->
diff --git a/res/xml/mouse_settings.xml b/res/xml/mouse_settings.xml
index 0abfdd0c364..dbd87111802 100644
--- a/res/xml/mouse_settings.xml
+++ b/res/xml/mouse_settings.xml
@@ -37,4 +37,9 @@
         android:title="@string/mouse_pointer_acceleration"
         android:summary="@string/mouse_pointer_acceleration_summary"
         settings:controller="com.android.settings.inputmethod.MousePointerAccelerationPreferenceController" />
+
+    <SwitchPreferenceCompat
+        android:key="mouse_scrolling_acceleration"
+        android:title="@string/mouse_scrolling_acceleration"
+        settings:controller="com.android.settings.inputmethod.MouseScrollingAccelerationPreferenceController" />
 </PreferenceScreen>
diff --git a/res/xml/touchpad_and_mouse_settings.xml b/res/xml/touchpad_and_mouse_settings.xml
index c470a729ccb..bc9f8427e6f 100644
--- a/res/xml/touchpad_and_mouse_settings.xml
+++ b/res/xml/touchpad_and_mouse_settings.xml
@@ -75,6 +75,12 @@
         settings:controller="com.android.settings.inputmethod.MouseSwapPrimaryButtonPreferenceController"
         android:order="47"/>
 
+    <SwitchPreferenceCompat
+        android:key="mouse_scrolling_acceleration"
+        android:title="@string/mouse_scrolling_acceleration"
+        settings:controller="com.android.settings.inputmethod.MouseScrollingAccelerationPreferenceController"
+        android:order="48"/>
+
     <Preference
         android:fragment="com.android.settings.inputmethod.PointerTouchpadFragment"
         android:key="pointer_and_touchpad"
diff --git a/src/com/android/settings/inputmethod/MouseScrollingAccelerationPreferenceController.java b/src/com/android/settings/inputmethod/MouseScrollingAccelerationPreferenceController.java
new file mode 100644
index 00000000000..7c9ff2aefe8
--- /dev/null
+++ b/src/com/android/settings/inputmethod/MouseScrollingAccelerationPreferenceController.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 MouseScrollingAccelerationPreferenceController extends TogglePreferenceController {
+
+    public MouseScrollingAccelerationPreferenceController(
+            @NonNull Context context, @NonNull String key) {
+        super(context, key);
+    }
+
+    @Override
+    public boolean isChecked() {
+        return !InputSettings.isMouseScrollingAccelerationEnabled(mContext);
+    }
+
+    @Override
+    public boolean setChecked(boolean isChecked) {
+        InputSettings.setMouseScrollingAcceleration(mContext, !isChecked);
+        return true;
+    }
+
+    @Override
+    public int getAvailabilityStatus() {
+        if (!InputSettings.isMouseScrollingAccelerationFeatureFlagEnabled()) {
+            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/MouseScrollingAccelerationPreferenceControllerTest.java b/tests/robotests/src/com/android/settings/inputmethod/MouseScrollingAccelerationPreferenceControllerTest.java
new file mode 100644
index 00000000000..08a7392bcb2
--- /dev/null
+++ b/tests/robotests/src/com/android/settings/inputmethod/MouseScrollingAccelerationPreferenceControllerTest.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 MouseScrollingAccelerationPreferenceController} */
+@RunWith(RobolectricTestRunner.class)
+@Config(shadows = {
+        com.android.settings.testutils.shadow.ShadowSystemSettings.class,
+})
+public class MouseScrollingAccelerationPreferenceControllerTest {
+    @Rule
+    public final SetFlagsRule mSetFlagsRule = new SetFlagsRule();
+
+    private static final String PREFERENCE_KEY = "mouse_scrolling_acceleration";
+    private static final String SETTING_KEY = Settings.System.MOUSE_SCROLLING_ACCELERATION;
+
+    private Context mContext;
+    private MouseScrollingAccelerationPreferenceController mController;
+
+    @Before
+    public void setUp() {
+        mContext = ApplicationProvider.getApplicationContext();
+        mController = new MouseScrollingAccelerationPreferenceController(
+                mContext, PREFERENCE_KEY);
+    }
+
+    @Test
+    @EnableFlags(Flags.FLAG_MOUSE_SCROLLING_ACCELERATION)
+    public void getAvailabilityStatus_expected() {
+        assertThat(mController.getAvailabilityStatus())
+                .isEqualTo(BasePreferenceController.AVAILABLE);
+    }
+
+    @Test
+    @DisableFlags(Flags.FLAG_MOUSE_SCROLLING_ACCELERATION)
+    public void getAvailabilityStatus_flagIsDisabled_notSupport() {
+        assertThat(mController.getAvailabilityStatus())
+                .isEqualTo(BasePreferenceController.UNSUPPORTED_ON_DEVICE);
+    }
+
+    @Test
+    @EnableFlags(Flags.FLAG_MOUSE_SCROLLING_ACCELERATION)
+    public void setChecked_false_shouldReturnTrue() {
+        mController.setChecked(false);
+
+        boolean isEnabled = InputSettings.isMouseScrollingAccelerationEnabled(mContext);
+        assertThat(isEnabled).isTrue();
+    }
+
+    @Test
+    @EnableFlags(Flags.FLAG_MOUSE_SCROLLING_ACCELERATION)
+    public void setChecked_false_shouldReturnFalse() {
+        mController.setChecked(true);
+
+        boolean isEnabled = InputSettings.isMouseScrollingAccelerationEnabled(mContext);
+        assertThat(isEnabled).isFalse();
+    }
+
+    @Test
+    @EnableFlags(Flags.FLAG_MOUSE_SCROLLING_ACCELERATION)
+    public void isChecked_providerPutInt1_returnFalse() {
+        Settings.System.putIntForUser(
+                mContext.getContentResolver(),
+                SETTING_KEY,
+                1,
+                UserHandle.USER_CURRENT);
+
+        boolean result = mController.isChecked();
+
+        assertThat(result).isFalse();
+    }
+
+    @Test
+    @EnableFlags(Flags.FLAG_MOUSE_SCROLLING_ACCELERATION)
+    public void isChecked_providerPutInt0_returnTrue() {
+        Settings.System.putIntForUser(
+                mContext.getContentResolver(),
+                SETTING_KEY,
+                0,
+                UserHandle.USER_CURRENT);
+
+        boolean result = mController.isChecked();
+
+        assertThat(result).isTrue();
+    }
+}