Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 678e187b authored by Ady Abraham's avatar Ady Abraham
Browse files

Settings: add a new developer menu entry to show refresh rate overlay 

The refresh rate overlay will be shown on screen if the option is
selected from the developer option.

Test: enable show refresh rate from developer menu
Bug: 129297325
Change-Id: Ic7b59fa93e1ca1e5649501eb87bda64c7a868fa1
parent 01cf29b9

res/values/strings.xml

+5 −0
Original line number Diff line number Diff line
@@ -1774,6 +1774,11 @@ 
    <!-- Debugging developer settings: Enable ART verifier for Debuggable Apps [CHAR LIMIT=NONE] -->

    <string name="art_verifier_for_debuggable_summary">Allow ART to verify bytecode for debuggable apps</string>









    <!-- Debugging developer settings: show refresh rate? [CHAR LIMIT=25] -->









    <string name="show_refresh_rate">Show refresh rate</string>









    <!-- Debugging developer settings: show refresh rate summary [CHAR LIMIT=50] -->









    <string name="show_refresh_rate_summary">Show the current display refresh rate</string>

















    <!-- NFC settings -->









    <!-- Used in the 1st-level settings screen to turn on NFC -->









    <string name="nfc_quick_toggle_title">NFC</string>
































res/xml/development_settings.xml



+5
−0






























Original line number
Diff line number
Diff line







@@ -222,6 +222,11 @@







            android:fragment="com.android.settings.development.compat.PlatformCompatDashboard"









            />



















        <SwitchPreference









            android:key="show_refresh_rate"









            android:title="@string/show_refresh_rate"









            android:summary="@string/show_refresh_rate_summary" />



















    </PreferenceCategory>



















    <PreferenceCategory
































src/com/android/settings/development/DevelopmentSettingsDashboardFragment.java



+1
−0






























Original line number
Diff line number
Diff line







@@ -469,6 +469,7 @@ public class DevelopmentSettingsDashboardFragment extends RestrictedDashboardFra







        controllers.add(new PointerLocationPreferenceController(context));









        controllers.add(new ShowSurfaceUpdatesPreferenceController(context));









        controllers.add(new ShowLayoutBoundsPreferenceController(context));









        controllers.add(new ShowRefreshRatePreferenceController(context));









        controllers.add(new RtlLayoutPreferenceController(context));









        controllers.add(new WindowAnimationScalePreferenceController(context));









        controllers.add(new EmulateDisplayCutoutPreferenceController(context));
































src/com/android/settings/development/ShowRefreshRatePreferenceController.java
0 → 100644



+124
−0






























Original line number
Diff line number
Diff line









/*









 * Copyright 2019 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.development;



















import android.content.Context;









import android.os.IBinder;









import android.os.Parcel;









import android.os.RemoteException;









import android.os.ServiceManager;



















import androidx.annotation.VisibleForTesting;









import androidx.preference.Preference;









import androidx.preference.SwitchPreference;



















import com.android.settings.core.PreferenceControllerMixin;









import com.android.settingslib.development.DeveloperOptionsPreferenceController;



















/**









 * Controller class for controlling the refresh rate overlay on SurfaceFlinger









 */









public class ShowRefreshRatePreferenceController extends DeveloperOptionsPreferenceController









        implements Preference.OnPreferenceChangeListener, PreferenceControllerMixin {



















    private static final String SHOW_REFRESH_RATE_KEY = "show_refresh_rate";



















    private static final int SETTING_VALUE_QUERY = 2;









    private static final int SETTING_VALUE_ON = 1;









    private static final int SETTING_VALUE_OFF = 0;



















    @VisibleForTesting









    static final String SURFACE_FLINGER_SERVICE_KEY = "SurfaceFlinger";









    @VisibleForTesting









    static final int SURFACE_FLINGER_CODE = 1034;



















    private static final String SURFACE_COMPOSER_INTERFACE_KEY = "android.ui.ISurfaceComposer";



















    private final IBinder mSurfaceFlinger;



















    public ShowRefreshRatePreferenceController(Context context) {









        super(context);









        mSurfaceFlinger = ServiceManager.getService(SURFACE_FLINGER_SERVICE_KEY);









    }



















    @Override









    public String getPreferenceKey() {









        return SHOW_REFRESH_RATE_KEY;









    }



















    @Override









    public boolean onPreferenceChange(Preference preference, Object newValue) {









        final boolean isEnabled = (Boolean) newValue;









        writeShowRefreshRateSetting(isEnabled);









        return true;









    }



















    @Override









    public void updateState(Preference preference) {









        updateShowRefreshRateSetting();









    }



















    @Override









    protected void onDeveloperOptionsSwitchDisabled() {









        super.onDeveloperOptionsSwitchDisabled();









        final SwitchPreference preference = (SwitchPreference) mPreference;









        if (preference.isChecked()) {









            // Writing false to the preference when the setting is already off will have a









            // side effect of turning on the preference that we wish to avoid









            writeShowRefreshRateSetting(false);









            preference.setChecked(false);









        }









    }



















    @VisibleForTesting









    void updateShowRefreshRateSetting() {









        // magic communication with surface flinger.









        try {









            if (mSurfaceFlinger != null) {









                final Parcel data = Parcel.obtain();









                final Parcel reply = Parcel.obtain();









                data.writeInterfaceToken(SURFACE_COMPOSER_INTERFACE_KEY);









                data.writeInt(SETTING_VALUE_QUERY);









                mSurfaceFlinger.transact(SURFACE_FLINGER_CODE, data, reply, 0 /* flags */);









                final boolean enabled = reply.readBoolean();









                ((SwitchPreference) mPreference).setChecked(enabled);









                reply.recycle();









                data.recycle();









            }









        } catch (RemoteException ex) {









            // intentional no-op









        }









    }



















    @VisibleForTesting









    void writeShowRefreshRateSetting(boolean isEnabled) {









        try {









            if (mSurfaceFlinger != null) {









                final Parcel data = Parcel.obtain();









                data.writeInterfaceToken(SURFACE_COMPOSER_INTERFACE_KEY);









                final int showRefreshRate = isEnabled ? SETTING_VALUE_ON : SETTING_VALUE_OFF;









                data.writeInt(showRefreshRate);









                mSurfaceFlinger.transact(SURFACE_FLINGER_CODE, data,









                        null /* reply */, 0 /* flags */);









                data.recycle();









            }









        } catch (RemoteException ex) {









            // intentional no-op









        }









        updateShowRefreshRateSetting();









    }









}
























tests/robotests/src/com/android/settings/development/ShowRefreshRatePreferenceControllerTest.java
0 → 100644



+129
−0






























Original line number
Diff line number
Diff line









/*









 * Copyright (C) 2017 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.development;



















import static com.android.settings.development.ShowRefreshRatePreferenceController









        .SURFACE_FLINGER_CODE;



















import static org.mockito.ArgumentMatchers.any;









import static org.mockito.ArgumentMatchers.anyBoolean;









import static org.mockito.ArgumentMatchers.eq;









import static org.mockito.Mockito.doNothing;









import static org.mockito.Mockito.doReturn;









import static org.mockito.Mockito.never;









import static org.mockito.Mockito.spy;









import static org.mockito.Mockito.verify;









import static org.mockito.Mockito.when;



















import android.content.Context;









import android.os.IBinder;









import android.os.RemoteException;



















import androidx.preference.PreferenceScreen;









import androidx.preference.SwitchPreference;



















import com.android.settings.testutils.shadow.ShadowParcel;



















import org.junit.Before;









import org.junit.Test;









import org.junit.runner.RunWith;









import org.mockito.Mock;









import org.mockito.MockitoAnnotations;









import org.robolectric.RobolectricTestRunner;









import org.robolectric.annotation.Config;









import org.robolectric.util.ReflectionHelpers;



















@RunWith(RobolectricTestRunner.class)









public class ShowRefreshRatePreferenceControllerTest {



















    @Mock









    private Context mContext;









    @Mock









    private PreferenceScreen mScreen;









    @Mock









    private SwitchPreference mPreference;









    @Mock









    private IBinder mSurfaceFlinger;



















    private ShowRefreshRatePreferenceController mController;



















    @Before









    public void setUp() {









        MockitoAnnotations.initMocks(this);









        mController = spy(new ShowRefreshRatePreferenceController(mContext));









        ReflectionHelpers.setField(mController, "mSurfaceFlinger", mSurfaceFlinger);









        doNothing().when(mController).writeShowRefreshRateSetting(anyBoolean());









        when(mScreen.findPreference(mController.getPreferenceKey())).thenReturn(mPreference);









        mController.displayPreference(mScreen);









    }



















    @Test









    public void onPreferenceChange_settingToggledOn_shouldWriteTrueToShowRefreshRateSetting() {









        mController.onPreferenceChange(mPreference, true /* new value */);



















        verify(mController).writeShowRefreshRateSetting(true);









    }



















    @Test









    public void onPreferenceChange_settingToggledOff_shouldWriteFalseToShowRefreshRateSetting() {









        mController.onPreferenceChange(mPreference, false /* new value */);



















        verify(mController).writeShowRefreshRateSetting(false);









    }



















    @Test









    @Config(shadows = ShadowParcel.class)









    public void updateState_settingEnabled_shouldCheckPreference() throws RemoteException {









        ShadowParcel.sReadIntResult = 1;









        doReturn(true).when(mSurfaceFlinger)









            .transact(eq(SURFACE_FLINGER_CODE), any(), any(), eq(0 /* flags */));









        mController.updateState(mPreference);



















        verify(mPreference).setChecked(true);









    }



















    @Test









    @Config(shadows = {ShadowParcel.class})









    public void updateState_settingDisabled_shouldUnCheckPreference() throws RemoteException {









        ShadowParcel.sReadIntResult = 0;









        doReturn(true).when(mSurfaceFlinger)









            .transact(eq(SURFACE_FLINGER_CODE), any(), any(), eq(0 /* flags */));









        mController.updateState(mPreference);



















        verify(mPreference).setChecked(false);









    }



















    @Test









    public void onDeveloperOptionsSwitchDisabled_preferenceUnchecked_shouldNotTurnOffPreference() {









        when(mPreference.isChecked()).thenReturn(false);









        mController.onDeveloperOptionsSwitchDisabled();



















        verify(mController, never()).writeShowRefreshRateSetting(anyBoolean());









        verify(mPreference, never()).setChecked(anyBoolean());









        verify(mPreference).setEnabled(false);









    }



















    @Test









    public void onDeveloperOptionsSwitchDisabled_preferenceChecked_shouldTurnOffPreference() {









        when(mPreference.isChecked()).thenReturn(true);









        mController.onDeveloperOptionsSwitchDisabled();



















        verify(mController).writeShowRefreshRateSetting(false);









        verify(mPreference).setChecked(false);









        verify(mPreference).setEnabled(false);









    }









}