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

Commit a9b9de74 authored by Evan Laird's avatar Evan Laird
Browse files

[clock] use `tnum` instead of custom onMeasure for Clock.java 

Tabular font figures was the real friends we made along the way.

On a more serious note. The custom `onMeasure` was built to avoid the
problem that the clock would subtly change width on every minute change.
This problem is even-worse if seconds are showing.

This change requests that the Clocj use a tabular numeral style, which
is a more font-built-in method for solving the same problem.

Test: manual
Bug: 372549909
Flag: EXEMPT bugfix
Change-Id: I0a8b5fe192356e04a9704ef3e76648a4786e1b91
parent 2006374f

packages/SystemUI/multivalentTests/src/com/android/systemui/statusbar/policy/ClockTest.kt

deleted100644 → 0
+0 −130
Original line number Diff line number Diff line 
/*

 * Copyright (C) 2022 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.systemui.statusbar.policy



import android.testing.TestableLooper

import android.view.View.MeasureSpec.UNSPECIFIED

import android.view.View.MeasureSpec.makeMeasureSpec

import android.view.ViewGroup.LayoutParams.WRAP_CONTENT

import android.widget.LinearLayout

import androidx.test.ext.junit.runners.AndroidJUnit4

import androidx.test.filters.SmallTest

import com.android.systemui.SysuiTestCase

import org.junit.Before

import org.junit.runner.RunWith



import com.google.common.truth.Truth.assertThat

import org.junit.Test



@SmallTest

@RunWith(AndroidJUnit4::class)

@TestableLooper.RunWithLooper

class ClockTest : SysuiTestCase() {

    private lateinit var clockView: Clock



    @Before

    fun setUp() {

        allowTestableLooperAsMainThread()

        TestableLooper.get(this).runWithLooper {

            val container = LinearLayout(context)

            val lp = LinearLayout.LayoutParams(1000, WRAP_CONTENT)

            container.layoutParams = lp

            clockView = Clock(context, null)

            container.addView(clockView)

            measureClock()

        }

    }



    @Test

    fun testWidthDoesNotDecrease_sameCharLength() {

        // GIVEN time is narrow

        clockView.text = ONE_3

        measureClock()

        val width1 = clockView.measuredWidth



        // WHEN the text changes to be wider characters

        clockView.text = ZERO_3

        measureClock()

        val width2 = clockView.measuredWidth



        // THEN the width should be wider (or equals when using monospace font)

        assertThat(width2).isAtLeast(width1)

    }



    @Test

    fun testWidthDoesNotDecrease_narrowerFont_sameNumberOfChars() {

        // GIVEN time is wide

        clockView.text = ZERO_3

        measureClock()

        val width1 = clockView.measuredWidth



        // WHEN the text changes to a narrower font

        clockView.text = ONE_3

        measureClock()

        val width2 = clockView.measuredWidth



        // THEN the width should not have decreased, and they should in fact be the same

        assertThat(width2).isEqualTo(width1)

    }



    @Test

    fun testWidthIncreases_whenCharsChanges() {

        // GIVEN wide 3-char text

        clockView.text = ZERO_3

        measureClock()

        val width1 = clockView.measuredWidth



        // WHEN text changes to 4-char wide text

        clockView.text = ZERO_4

        measureClock()

        val width2 = clockView.measuredWidth



        // THEN the text field is wider

        assertThat(width2).isGreaterThan(width1)

    }



    @Test

    fun testWidthDecreases_whenCharsChange_longToShort() {

        // GIVEN wide 4-char text

        clockView.text = ZERO_4

        measureClock()

        val width1 = clockView.measuredWidth



        // WHEN number of characters changes to a narrow 3-char text

        clockView.text = ONE_3

        measureClock()

        val width2 = clockView.measuredWidth



        // THEN the width can shrink, because number of chars changed

        assertThat(width2).isLessThan(width1)

    }



    private fun measureClock() {

        clockView.measure(

                makeMeasureSpec(0, UNSPECIFIED),

                makeMeasureSpec(0, UNSPECIFIED)

        )

    }

}



/**

 * In a non-monospace font, it is expected that "0:00" is wider than "1:11"

 */

private const val ZERO_3 = "0:00"

private const val ZERO_4 = "00:00"

private const val ONE_3 = "1:11"

private const val ONE_4 = "11:11"

packages/SystemUI/res/layout/combined_qs_header.xml

+1 −0
Original line number Diff line number Diff line
@@ -86,6 +86,7 @@ frame when animating QS <-> QQS transition 
        android:singleLine="true"

        android:textDirection="locale"

        android:textAppearance="@style/TextAppearance.QS.Status"

        android:fontFeatureSettings="tnum"

        android:transformPivotX="0dp"

        android:transformPivotY="24dp"

        android:scaleX="1"

packages/SystemUI/res/layout/keyguard_status_bar.xml

+1 −1
Original line number Diff line number Diff line
@@ -76,7 +76,7 @@ 
        android:gravity="center_vertical"

        android:ellipsize="marquee"

        android:textDirection="locale"

        android:textAppearance="@style/TextAppearance.StatusBar.Clock"

        android:textAppearance="@style/TextAppearance.StatusBar.Carrier"

        android:textColor="?attr/wallpaperTextColorSecondary"

        android:singleLine="true"

        systemui:showMissingSim="true"

packages/SystemUI/res/values/styles.xml

+7 −0
Original line number Diff line number Diff line
@@ -21,6 +21,13 @@ 
        <item name="android:textSize">@dimen/status_bar_clock_size</item>

        <item name="android:fontFamily">@*android:string/config_headlineFontFamilyMedium</item>

        <item name="android:textColor">@color/status_bar_clock_color</item>

        <item name="android:fontFeatureSettings">tnum</item>

    </style>



    <style name="TextAppearance.StatusBar.Carrier" parent="@*android:style/TextAppearance.StatusBar.Icon">

        <item name="android:textSize">@dimen/status_bar_clock_size</item>

        <item name="android:fontFamily">@*android:string/config_headlineFontFamilyMedium</item>

        <item name="android:textColor">@color/status_bar_clock_color</item>

    </style>



    <style name="TextAppearance.StatusBar.UserChip" parent="@*android:style/TextAppearance.StatusBar.Icon">

packages/SystemUI/src/com/android/systemui/statusbar/policy/Clock.java

+0 −33
Original line number Diff line number Diff line
@@ -108,10 +108,6 @@ public class Clock extends TextView implements 
    private boolean mShowSeconds;

    private Handler mSecondsHandler;



    // Fields to cache the width so the clock remains at an approximately constant width

    private int mCharsAtCurrentWidth = -1;

    private int mCachedWidth = -1;



    /**

     * Color to be set on this {@link TextView}, when wallpaperTextColor is <b>not</b> utilized.

     */
@@ -326,32 +322,6 @@ public class Clock extends TextView implements 
        setContentDescription(mContentDescriptionFormat.format(mCalendar.getTime()));

    }



    /**

     * In order to avoid the clock growing and shrinking due to proportional fonts, we want to

     * cache the drawn width at a given number of characters (removing the cache when it changes),

     * and only use the biggest value. This means that the clock width with grow to the maximum

     * size over time, but reset whenever the number of characters changes (or the configuration

     * changes)

     */

    @Override

    protected void onMeasure(int widthMeasureSpec, int heightMeasureSpec) {

        super.onMeasure(widthMeasureSpec, heightMeasureSpec);



        int chars = getText().length();

        if (chars != mCharsAtCurrentWidth) {

            mCharsAtCurrentWidth = chars;

            mCachedWidth = getMeasuredWidth();

            return;

        }



        int measuredWidth = getMeasuredWidth();

        if (mCachedWidth > measuredWidth) {

            setMeasuredDimension(mCachedWidth, getMeasuredHeight());

        } else {

            mCachedWidth = measuredWidth;

        }

    }



    @Override

    public void onTuningChanged(String key, String newValue) {

        if (CLOCK_SECONDS.equals(key)) {
@@ -402,9 +372,6 @@ public class Clock extends TextView implements 
    }



    private void reloadDimens() {

        // reset mCachedWidth so the new width would be updated properly when next onMeasure

        mCachedWidth = -1;



        FontSizeUtils.updateFontSize(this, R.dimen.status_bar_clock_size);

        setPaddingRelative(

                mContext.getResources().getDimensionPixelSize(