Convert non-exhaustive enum classes [187055290]

Fixed

Bug

Status Update

No update yet.

Description

ad...@google.com

created issue #1

May 3, 2021 04:26PM

Exhaustive when statements can pose a versioning challenge over time as adding an enum class value is a breaking change for existing code. Document patterns around using inline/value classes to provide versionable constants that explicitly do not permit use of exhaustive when.

Comments

ap...@google.com <ap...@google.com> #2May 6, 2021 11:54PM

Project: platform/frameworks/support
Branch: androidx-main

commit bbe1d83f1c87167b0da0104a8cc997db7b00f498
Author: Anastasia Soboleva <soboleva@google.com>
Date: Mon Sep 25 09:38:18 2023

Add Uspecified to Hyphens, LineBreak, TextAlign, TextDirection

ParagraphStyle and TextStyle takes these as non-null params in ctors, copy and merge to avoid boxing.

Deprecated getTextAlign and similar public getters nullable for binary compat. Introduced non-null counterparts that compile into primitives.

Before:
5,150 ns 5 allocs Trace Method Trace EMULATOR_AllAppsWithSpans.draw[size=2, spanCount=4]
18,965 ns 99 allocs Trace Method Trace EMULATOR_AllAppsWithSpans.recomposeOnly[size=2, spanCount=4]
44,769 ns 208 allocs Trace Method Trace EMULATOR_AllAppsWithSpans.recomposeMeasureLayout[size=2, spanCount=4]

After:
5,265 ns 5 allocs Trace Method Trace EMULATOR_AllAppsWithSpans.draw[size=2, spanCount=4]
19,054 ns 99 allocs Trace Method Trace EMULATOR_AllAppsWithSpans.recomposeOnly[size=2, spanCount=4]
44,617 ns 201 allocs Trace Method Trace EMULATOR_AllAppsWithSpans.recomposeMeasureLayout[size=2, spanCount=4]

Before:
159,575 ns 647 allocs Trace Method Trace EMULATOR_TextInColumnBenchmark.toggleRectangleColor_measure[10]
138,596 ns 580 allocs Trace Method Trace EMULATOR_TextInColumnBenchmark.layout[10]
191,924 ns 715 allocs Trace Method Trace EMULATOR_TextInColumnBenchmark.first_measure[10]
1,653,166 ns 6220 allocs Trace Method Trace EMULATOR_TextInColumnBenchmark.toggleRectangleColor_measure[100]
1,246,603 ns 5490 allocs Trace Method Trace EMULATOR_TextInColumnBenchmark.layout[100]
1,529,656 ns 6859 allocs Trace Method Trace EMULATOR_TextInColumnBenchmark.first_measure[100]

After:
177,292 ns 597 allocs Trace Method Trace EMULATOR_TextInColumnBenchmark.toggleRectangleColor_measure[10]
139,119 ns 550 allocs Trace Method Trace EMULATOR_TextInColumnBenchmark.layout[10]
186,741 ns 645 allocs Trace Method Trace EMULATOR_TextInColumnBenchmark.first_measure[10]
1,642,789 ns 5500 allocs Trace Method Trace EMULATOR_TextInColumnBenchmark.toggleRectangleColor_measure[100]
1,352,991 ns 5231 allocs Trace Method Trace EMULATOR_TextInColumnBenchmark.layout[100]
1,570,829 ns 6159 allocs Trace Method Trace EMULATOR_TextInColumnBenchmark.first_measure[100]

Test: ui:ui-text:test, ui:ui-text:cC
Test: benchmarks
Bug: 299490814

Relnote: "Introduced a special Unspecified value for TextAlign, TextDirection, Hyphens and LineBreak fields of the ParagraphTextStyle to replace “null”. Because these classes are inline classes, by replacing nullable with the Unspecified, we avoid primitive type boxing.
Constructors, getters and other methods in TextStyle and Paragraph style were update to accept the mentioned parameters as non-null types."

Change-Id: I4197ea85db556846ecad27ca8f561955e2370951

M compose/material/material/src/commonMain/kotlin/androidx/compose/material/Text.kt
M compose/material3/material3/src/commonMain/kotlin/androidx/compose/material3/Text.kt
M compose/ui/ui-inspection/src/androidTest/java/androidx/compose/ui/inspection/inspector/ParameterFactoryTest.kt
M compose/ui/ui-text/api/current.ignore
M compose/ui/ui-text/api/current.txt
M compose/ui/ui-text/api/restricted_current.ignore
M compose/ui/ui-text/api/restricted_current.txt
M compose/ui/ui-text/src/androidInstrumentedTest/kotlin/androidx/compose/ui/text/AndroidParagraphTest.kt
M compose/ui/ui-text/src/androidInstrumentedTest/kotlin/androidx/compose/ui/text/AndroidParagraphTextDirectionTest.kt
M compose/ui/ui-text/src/androidInstrumentedTest/kotlin/androidx/compose/ui/text/MultiParagraphIntegrationTextDirectionTest.kt
M compose/ui/ui-text/src/androidInstrumentedTest/kotlin/androidx/compose/ui/text/ParagraphIntegrationTextDirectionTest.kt
M compose/ui/ui-text/src/androidMain/kotlin/androidx/compose/ui/text/AndroidParagraph.android.kt
M compose/ui/ui-text/src/androidMain/kotlin/androidx/compose/ui/text/platform/AndroidParagraphIntrinsics.android.kt
M compose/ui/ui-text/src/androidMain/kotlin/androidx/compose/ui/text/style/LineBreak.android.kt
M compose/ui/ui-text/src/androidUnitTest/kotlin/androidx/compose/ui/text/ParagraphStyleTest.kt
M compose/ui/ui-text/src/androidUnitTest/kotlin/androidx/compose/ui/text/TextStyleLayoutAttributesTest.kt
M compose/ui/ui-text/src/androidUnitTest/kotlin/androidx/compose/ui/text/TextStyleTest.kt
M compose/ui/ui-text/src/commonMain/kotlin/androidx/compose/ui/text/MultiParagraphIntrinsics.kt
M compose/ui/ui-text/src/commonMain/kotlin/androidx/compose/ui/text/ParagraphStyle.kt
M compose/ui/ui-text/src/commonMain/kotlin/androidx/compose/ui/text/Savers.kt
M compose/ui/ui-text/src/commonMain/kotlin/androidx/compose/ui/text/SpanStyle.kt
M compose/ui/ui-text/src/commonMain/kotlin/androidx/compose/ui/text/TextStyle.kt
M compose/ui/ui-text/src/commonMain/kotlin/androidx/compose/ui/text/style/Hyphens.kt
M compose/ui/ui-text/src/commonMain/kotlin/androidx/compose/ui/text/style/LineBreak.kt
M compose/ui/ui-text/src/commonMain/kotlin/androidx/compose/ui/text/style/TextAlign.kt
M compose/ui/ui-text/src/commonMain/kotlin/androidx/compose/ui/text/style/TextDirection.kt
M compose/ui/ui-text/src/skikoMain/kotlin/androidx/compose/ui/text/platform/SkiaParagraph.skiko.kt
M compose/ui/ui-text/src/skikoMain/kotlin/androidx/compose/ui/text/style/LineBreak.skiko.kt
M tv/tv-material/src/main/java/androidx/tv/material3/Text.kt
M wear/compose/compose-material-core/src/main/java/androidx/wear/compose/materialcore/Text.kt

https://android-review.googlesource.com/2763568

ap...@google.com <ap...@google.com> #3May 7, 2021 09:18PM

Project: platform/frameworks/support
Branch: androidx-main

commit e21f04493c5ee666dc8fc472ff3e085e4ab88945
Author: Anastasia Soboleva <soboleva@google.com>
Date: Mon Oct 09 12:16:50 2023

Replace TextAlign? parameter with TextAlign in tv Text

Since tv's Text is still experimental, we better replace nullable with non-null to avoid primitive type boxing

Bug: 299490814
Test: TextTest
Relnote: "TV Text component's TextAlign parameter is now non-null"

Change-Id: Ib73b136b5d997de3869ca63e7c6dcad5e513ec1e

M tv/tv-material/api/current.txt
M tv/tv-material/api/restricted_current.txt
M tv/tv-material/src/main/java/androidx/tv/material3/Text.kt

https://android-review.googlesource.com/2775146

si...@google.com <si...@google.com> #4May 13, 2021 05:32PM

The following release(s) address this bug.It is possible this bug has only been partially addressed:

androidx.compose.material:material:1.6.0-alpha08
androidx.compose.material:material-android:1.6.0-alpha08
androidx.compose.material:material-desktop:1.6.0-alpha08
androidx.compose.material3:material3:1.2.0-alpha10
androidx.compose.material3:material3-android:1.2.0-alpha10
androidx.compose.material3:material3-desktop:1.2.0-alpha10
androidx.compose.ui:ui-text:1.6.0-alpha08
androidx.compose.ui:ui-text-android:1.6.0-alpha08
androidx.compose.ui:ui-text-desktop:1.6.0-alpha08
androidx.wear.compose:compose-material-core:1.3.0-alpha08

Message last modified on May 13, 2021 05:32PM

ap...@google.com <ap...@google.com> #5May 13, 2021 06:50PM

Project: platform/frameworks/support
Branch: androidx-main

commit 418ea57305dd992e1b9471dfb8efd38db5664fe6
Author: Ralston Da Silva <ralu@google.com>
Date: Tue May 11 14:15:13 2021

Replacing ImeAction enum with an inline class

Bug: 187055290
Relnote: ImeAction enum is replaced by an inline class.
Test: ./gradlew compose:foundation:foundation:connectedCheck -P android.testInstrumentationRunnerArguments.class=androidx.compose.foundation.text.KeyboardActionsTest
Change-Id: I18be51ba64f20257859ae634720b367ae7510e33

M compose/foundation/foundation/api/1.0.0-beta08.txt
M compose/foundation/foundation/api/current.ignore
M compose/foundation/foundation/api/current.txt
M compose/foundation/foundation/api/public_plus_experimental_1.0.0-beta08.txt
M compose/foundation/foundation/api/public_plus_experimental_current.txt
M compose/foundation/foundation/api/restricted_1.0.0-beta08.txt
M compose/foundation/foundation/api/restricted_current.ignore
M compose/foundation/foundation/api/restricted_current.txt
M compose/foundation/foundation/integration-tests/foundation-demos/src/main/java/androidx/compose/foundation/demos/text/TextFieldImeActionDemo.kt
M compose/foundation/foundation/src/androidAndroidTest/kotlin/androidx/compose/foundation/text/DefaultKeyboardActionsTest.kt
M compose/foundation/foundation/src/androidAndroidTest/kotlin/androidx/compose/foundation/text/KeyboardActionsTest.kt
M compose/foundation/foundation/src/commonMain/kotlin/androidx/compose/foundation/text/KeyboardActionRunner.kt
M compose/ui/ui-test/api/1.0.0-beta08.txt
A compose/ui/ui-test/api/current.ignore
M compose/ui/ui-test/api/current.txt
M compose/ui/ui-test/api/public_plus_experimental_1.0.0-beta08.txt
M compose/ui/ui-test/api/public_plus_experimental_current.txt
M compose/ui/ui-test/api/restricted_1.0.0-beta08.txt
A compose/ui/ui-test/api/restricted_current.ignore
M compose/ui/ui-test/api/restricted_current.txt
M compose/ui/ui-text/api/1.0.0-beta08.txt
A compose/ui/ui-text/api/current.ignore
M compose/ui/ui-text/api/current.txt
M compose/ui/ui-text/api/public_plus_experimental_1.0.0-beta08.txt
M compose/ui/ui-text/api/public_plus_experimental_current.txt
M compose/ui/ui-text/api/restricted_1.0.0-beta08.txt
A compose/ui/ui-text/api/restricted_current.ignore
M compose/ui/ui-text/api/restricted_current.txt
M compose/ui/ui-text/src/commonMain/kotlin/androidx/compose/ui/text/input/ImeAction.kt
M compose/ui/ui-text/src/commonMain/kotlin/androidx/compose/ui/text/input/InputEventCallback.kt
M compose/ui/ui/api/1.0.0-beta08.txt
M compose/ui/ui/api/current.ignore
M compose/ui/ui/api/current.txt
M compose/ui/ui/api/public_plus_experimental_1.0.0-beta08.txt
M compose/ui/ui/api/public_plus_experimental_current.txt
M compose/ui/ui/api/restricted_1.0.0-beta08.txt
M compose/ui/ui/api/restricted_current.ignore
M compose/ui/ui/api/restricted_current.txt
M compose/ui/ui/src/androidMain/kotlin/androidx/compose/ui/text/input/TextInputServiceAndroid.android.kt

https://android-review.googlesource.com/1704689

ap...@google.com <ap...@google.com> #6May 14, 2021 01:50AM

Project: platform/frameworks/support
Branch: androidx-main

commit 2cfa51635d05d62cbc08cb3abf333155c994fb16
Author: Ralston Da Silva <ralu@google.com>
Date: Wed Apr 28 18:55:47 2021

Changing FocusState to an Interface

FocusState stores the internal focus state of a FocusModifier. However since it is public API, we can't add values to this enum without breaking compatibility. This CL makes FocusState an interface.

Bug: 186763298
Bug: 187055290
Test: ./gradlew compose:ui:ui:connectedCheck -P android.testInstrumentationRunnerArguments.class=androidx.compose.ui.focus.FocusRequesterTest
Relnote: Replaced FocusState enum with a FocusState interface
Change-Id: Iccc1a7306fe886969b3a5c74359f53250b3901d9

M compose/androidview/androidview/integration-tests/androidview-demos/src/main/java/androidx/compose/androidview/demos/FocusTransferDemo.kt
M compose/foundation/foundation/integration-tests/foundation-demos/src/main/java/androidx/compose/foundation/demos/text/ComposeInputFieldFocusTransition.kt
M compose/foundation/foundation/src/androidAndroidTest/kotlin/androidx/compose/foundation/text/CoreTextFieldInputServiceIntegrationTest.kt
M compose/foundation/foundation/src/androidAndroidTest/kotlin/androidx/compose/foundation/text/DefaultKeyboardActionsTest.kt
M compose/foundation/foundation/src/androidAndroidTest/kotlin/androidx/compose/foundation/textfield/TextFieldCursorTest.kt
M compose/foundation/foundation/src/androidAndroidTest/kotlin/androidx/compose/foundation/textfield/TextFieldFocusTest.kt
M compose/foundation/foundation/src/androidAndroidTest/kotlin/androidx/compose/foundation/textfield/TextFieldTest.kt
M compose/foundation/foundation/src/commonMain/kotlin/androidx/compose/foundation/Focusable.kt
M compose/foundation/foundation/src/commonMain/kotlin/androidx/compose/foundation/text/CoreTextField.kt
M compose/foundation/foundation/src/commonMain/kotlin/androidx/compose/foundation/text/selection/SelectionManager.kt
M compose/material/material/src/androidAndroidTest/kotlin/androidx/compose/material/textfield/OutlinedTextFieldTest.kt
M compose/ui/ui/api/1.0.0-beta08.txt
M compose/ui/ui/api/current.ignore
M compose/ui/ui/api/current.txt
M compose/ui/ui/api/public_plus_experimental_1.0.0-beta08.txt
M compose/ui/ui/api/public_plus_experimental_current.txt
M compose/ui/ui/api/restricted_1.0.0-beta08.txt
M compose/ui/ui/api/restricted_current.ignore
M compose/ui/ui/api/restricted_current.txt
M compose/ui/ui/integration-tests/ui-demos/src/main/java/androidx/compose/ui/demos/autofill/ExplicitAutofillTypesDemo.kt
M compose/ui/ui/integration-tests/ui-demos/src/main/java/androidx/compose/ui/demos/focus/CustomFocusOrderDemo.kt
M compose/ui/ui/integration-tests/ui-demos/src/main/java/androidx/compose/ui/demos/focus/FocusManagerMoveFocusDemo.kt
M compose/ui/ui/integration-tests/ui-demos/src/main/java/androidx/compose/ui/demos/focus/FocusSearchDemo.kt
M compose/ui/ui/integration-tests/ui-demos/src/main/java/androidx/compose/ui/demos/focus/FocusableDemo.kt
M compose/ui/ui/integration-tests/ui-demos/src/main/java/androidx/compose/ui/demos/focus/ReuseFocusReference.kt
M compose/ui/ui/integration-tests/ui-demos/src/main/java/androidx/compose/ui/demos/keyinput/KeyInputDemo.kt
M compose/ui/ui/src/androidAndroidTest/kotlin/androidx/compose/ui/focus/CaptureFocusTest.kt
M compose/ui/ui/src/androidAndroidTest/kotlin/androidx/compose/ui/focus/ClearFocusTest.kt
M compose/ui/ui/src/androidAndroidTest/kotlin/androidx/compose/ui/focus/FindFocusableChildrenTest.kt
M compose/ui/ui/src/androidAndroidTest/kotlin/androidx/compose/ui/focus/FindParentFocusNodeTest.kt
M compose/ui/ui/src/androidAndroidTest/kotlin/androidx/compose/ui/focus/FocusChangedCountTest.kt
M compose/ui/ui/src/androidAndroidTest/kotlin/androidx/compose/ui/focus/FocusChangedTest.kt
M compose/ui/ui/src/androidAndroidTest/kotlin/androidx/compose/ui/focus/FocusEventCountTest.kt
M compose/ui/ui/src/androidAndroidTest/kotlin/androidx/compose/ui/focus/FocusManagerCompositionLocalTest.kt
M compose/ui/ui/src/androidAndroidTest/kotlin/androidx/compose/ui/focus/FocusModifierAttachDetachTest.kt
M compose/ui/ui/src/androidAndroidTest/kotlin/androidx/compose/ui/focus/FocusRequesterTest.kt
M compose/ui/ui/src/androidAndroidTest/kotlin/androidx/compose/ui/focus/FreeFocusTest.kt
M compose/ui/ui/src/androidAndroidTest/kotlin/androidx/compose/ui/focus/OwnerFocusTest.kt
M compose/ui/ui/src/androidAndroidTest/kotlin/androidx/compose/ui/focus/RequestFocusTest.kt
M compose/ui/ui/src/androidAndroidTest/kotlin/androidx/compose/ui/focus/ReusedFocusRequesterCaptureFocusTest.kt
M compose/ui/ui/src/androidAndroidTest/kotlin/androidx/compose/ui/focus/ReusedFocusRequesterFreeFocusTest.kt
M compose/ui/ui/src/androidAndroidTest/kotlin/androidx/compose/ui/focus/ReusedFocusRequesterTest.kt
M compose/ui/ui/src/commonMain/kotlin/androidx/compose/ui/focus/FocusManager.kt
M compose/ui/ui/src/commonMain/kotlin/androidx/compose/ui/focus/FocusModifier.kt
M compose/ui/ui/src/commonMain/kotlin/androidx/compose/ui/focus/FocusState.kt
M compose/ui/ui/src/commonMain/kotlin/androidx/compose/ui/focus/FocusTransactions.kt
M compose/ui/ui/src/commonMain/kotlin/androidx/compose/ui/focus/FocusTraversal.kt
M compose/ui/ui/src/commonMain/kotlin/androidx/compose/ui/focus/TwoDimensionalFocusSearch.kt
M compose/ui/ui/src/commonMain/kotlin/androidx/compose/ui/node/ModifiedFocusEventNode.kt
M compose/ui/ui/src/commonMain/kotlin/androidx/compose/ui/node/ModifiedFocusNode.kt
M compose/ui/ui/src/test/kotlin/androidx/compose/ui/focus/FocusManagerTest.kt

https://android-review.googlesource.com/1690272

ap...@google.com <ap...@google.com> #7May 14, 2021 02:22AM

Project: platform/frameworks/support
Branch: androidx-main

commit a4fc3c7398992fee23e6f6243707fee19adeca7d
Author: Ralston Da Silva <ralu@google.com>
Date: Wed May 12 15:48:42 2021

Replacing KeyboardType enum with an inline class

Bug: 187055290
Relnote: KeyboardType enum is replaced by an inline class.
Test: ./gradlew compose:foundation:foundation:connectedCheck -P android.testInstrumentationRunnerArguments.class=androidx.compose.foundation.text.CoreTextFieldInputServiceIntegrationTest
Change-Id: I73045de306c082ca8f6b11d44d252d0a63a407d3

M compose/foundation/foundation/api/1.0.0-beta08.txt
M compose/foundation/foundation/api/current.ignore
M compose/foundation/foundation/api/current.txt
M compose/foundation/foundation/api/public_plus_experimental_1.0.0-beta08.txt
M compose/foundation/foundation/api/public_plus_experimental_current.txt
M compose/foundation/foundation/api/restricted_1.0.0-beta08.txt
M compose/foundation/foundation/api/restricted_current.ignore
M compose/foundation/foundation/api/restricted_current.txt
M compose/foundation/foundation/integration-tests/foundation-demos/src/main/java/androidx/compose/foundation/demos/text/TextFieldKeyboardTypeDemo.kt
M compose/ui/ui-text/api/1.0.0-beta08.txt
M compose/ui/ui-text/api/current.ignore
M compose/ui/ui-text/api/current.txt
M compose/ui/ui-text/api/public_plus_experimental_1.0.0-beta08.txt
M compose/ui/ui-text/api/public_plus_experimental_current.txt
M compose/ui/ui-text/api/restricted_1.0.0-beta08.txt
M compose/ui/ui-text/api/restricted_current.ignore
M compose/ui/ui-text/api/restricted_current.txt
M compose/ui/ui-text/src/commonMain/kotlin/androidx/compose/ui/text/input/KeyboardType.kt
M compose/ui/ui/src/androidMain/kotlin/androidx/compose/ui/text/input/TextInputServiceAndroid.android.kt

https://android-review.googlesource.com/1706406

ap...@google.com <ap...@google.com> #8May 26, 2021 10:54PM

Project: platform/frameworks/support
Branch: androidx-main

commit 01363576c7b4aec2a0004c518c84d2dcbd495aea
Author: Ralston Da Silva <ralu@google.com>
Date: Thu May 13 18:05:44 2021

Replace NestedScrollSource enum with an inline class

Bug: 187055290
Relnote: NestedScrollSource enum is replaced by an inline class.
Test: ./gradlew compose:ui:ui:connectedCheck -P android.testInstrumentationRunnerArguments.class=androidx.compose.ui.input.nestedscroll.NestedScrollModifierTest
Change-Id: Ie321b5864dc617b2d6382ba5d632e8037dd5c1d5

M compose/foundation/foundation/src/commonMain/kotlin/androidx/compose/foundation/gestures/Scrollable.kt
M compose/ui/ui/api/1.0.0-beta08.txt
M compose/ui/ui/api/current.ignore
M compose/ui/ui/api/current.txt
M compose/ui/ui/api/public_plus_experimental_1.0.0-beta08.txt
M compose/ui/ui/api/public_plus_experimental_current.txt
M compose/ui/ui/api/restricted_1.0.0-beta08.txt
M compose/ui/ui/api/restricted_current.ignore
M compose/ui/ui/api/restricted_current.txt
M compose/ui/ui/src/commonMain/kotlin/androidx/compose/ui/input/nestedscroll/NestedScrollModifier.kt
M compose/ui/ui/src/commonMain/kotlin/androidx/compose/ui/layout/RelocationRequesterModifier.kt

https://android-review.googlesource.com/1707907

ad...@google.com <ad...@google.com> #9May 27, 2021 04:21PM

Reassigned to ra...@google.com.

This bug now has enough API change CLs linked against it that it can't really serve its original intent. Renaming and reassigning; I'll open a new one for the API guideline documentation.

ra...@google.com <ra...@google.com> Jun 6, 2021 06:50PM

Marked as fixed.