Uncomment androidx.annotation annotations in graphics common code [290950582]

Fixed

Bug

Status Update

No update yet.

Description

au...@google.com

created issue #1

Jul 12, 2023 06:05PM

Uncomment androidx.annotation annotations in graphics common code so developers get working lint checks:

ui/ui-graphics/src/commonMain/kotlin/androidx/compose/ui/graphics/Color.kt:fun Color(/*@ColorInt*/ color: Int): Color {
ui/ui-graphics/src/commonMain/kotlin/androidx/compose/ui/graphics/Color.kt:    /*@IntRange(from = 0, to = 0xFF)*/
ui/ui-graphics/src/commonMain/kotlin/androidx/compose/ui/graphics/Color.kt:    /*@IntRange(from = 0, to = 0xFF)*/
ui/ui-graphics/src/commonMain/kotlin/androidx/compose/ui/graphics/Color.kt:    /*@IntRange(from = 0, to = 0xFF)*/
ui/ui-graphics/src/commonMain/kotlin/androidx/compose/ui/graphics/Color.kt:    /*@IntRange(from = 0, to = 0xFF)*/
ui/ui-graphics/src/commonMain/kotlin/androidx/compose/ui/graphics/Color.kt:fun lerp(start: Color, stop: Color, /*@FloatRange(from = 0.0, to = 1.0)*/ fraction: Float): Color {
ui/ui-graphics/src/commonMain/kotlin/androidx/compose/ui/graphics/Color.kt:/*@Size(value = 4)*/
ui/ui-graphics/src/commonMain/kotlin/androidx/compose/ui/graphics/Outline.kt:    /*@FloatRange(from = 0.0, to = 1.0)*/
ui/ui-graphics/src/commonMain/kotlin/androidx/compose/ui/graphics/Outline.kt:    /*@FloatRange(from = 0.0, to = 1.0)*/
ui/ui-graphics/src/commonMain/kotlin/androidx/compose/ui/graphics/PixelMap.kt:        /*@IntRange(from = 0)*/
ui/ui-graphics/src/commonMain/kotlin/androidx/compose/ui/graphics/PixelMap.kt:        /*@IntRange(from = 0)*/
ui/ui-graphics/src/commonMain/kotlin/androidx/compose/ui/graphics/colorspace/ColorModel.kt:    /*@IntRange(from = 1, to = 4)*/
ui/ui-graphics/src/commonMain/kotlin/androidx/compose/ui/graphics/colorspace/ColorSpace.kt:        /*@IntRange(from = 1, to = 4)*/
ui/ui-graphics/src/commonMain/kotlin/androidx/compose/ui/graphics/colorspace/ColorSpace.kt:    abstract fun getMinValue(/*@IntRange(from = 0, to = 3)*/ component: Int): Float
ui/ui-graphics/src/commonMain/kotlin/androidx/compose/ui/graphics/colorspace/ColorSpace.kt:    abstract fun getMaxValue(/*@IntRange(from = 0, to = 3)*/ component: Int): Float
ui/ui-graphics/src/commonMain/kotlin/androidx/compose/ui/graphics/colorspace/ColorSpace.kt:    /*@Size(3)*/
ui/ui-graphics/src/commonMain/kotlin/androidx/compose/ui/graphics/colorspace/ColorSpace.kt:    /*@Size(min = 3)*/
ui/ui-graphics/src/commonMain/kotlin/androidx/compose/ui/graphics/colorspace/ColorSpace.kt:    abstract fun toXyz(/*@Size(min = 3)*/ v: FloatArray): FloatArray
ui/ui-graphics/src/commonMain/kotlin/androidx/compose/ui/graphics/colorspace/ColorSpace.kt:    /*@Size(min = 3)*/
ui/ui-graphics/src/commonMain/kotlin/androidx/compose/ui/graphics/colorspace/ColorSpace.kt:    /*@Size(min = 3)*/
ui/ui-graphics/src/commonMain/kotlin/androidx/compose/ui/graphics/colorspace/ColorSpace.kt:    abstract fun fromXyz(/*@Size(min = 3)*/ v: FloatArray): FloatArray
ui/ui-graphics/src/commonMain/kotlin/androidx/compose/ui/graphics/colorspace/ColorSpaces.kt:        /*@Size(9)*/
ui/ui-graphics/src/commonMain/kotlin/androidx/compose/ui/graphics/colorspace/Connector.kt:    /*@Size(3)*/
ui/ui-graphics/src/commonMain/kotlin/androidx/compose/ui/graphics/colorspace/Connector.kt:    /*@Size(min = 3)*/
ui/ui-graphics/src/commonMain/kotlin/androidx/compose/ui/graphics/colorspace/Connector.kt:    open fun transform(/*@Size(min = 3)*/ v: FloatArray): FloatArray {
ui/ui-graphics/src/commonMain/kotlin/androidx/compose/ui/graphics/colorspace/Rgb.kt:    /*@Size(6)*/
ui/ui-graphics/src/commonMain/kotlin/androidx/compose/ui/graphics/colorspace/Rgb.kt:    /*@Size(9)*/
ui/ui-graphics/src/commonMain/kotlin/androidx/compose/ui/graphics/colorspace/Rgb.kt:    /*@Size(9)*/
ui/ui-graphics/src/commonMain/kotlin/androidx/compose/ui/graphics/colorspace/Rgb.kt:        /*@Size(min = 1)*/
ui/ui-graphics/src/commonMain/kotlin/androidx/compose/ui/graphics/colorspace/Rgb.kt:        /*@Size(9)*/
ui/ui-graphics/src/commonMain/kotlin/androidx/compose/ui/graphics/colorspace/Rgb.kt:        /*@Size(min = 1)*/
ui/ui-graphics/src/commonMain/kotlin/androidx/compose/ui/graphics/colorspace/Rgb.kt:        /*@Size(min = 6, max = 9)*/
ui/ui-graphics/src/commonMain/kotlin/androidx/compose/ui/graphics/colorspace/Rgb.kt:        /*@Size(min = 1)*/
ui/ui-graphics/src/commonMain/kotlin/androidx/compose/ui/graphics/colorspace/Rgb.kt:        /*@Size(9)*/
ui/ui-graphics/src/commonMain/kotlin/androidx/compose/ui/graphics/colorspace/Rgb.kt:        /*@Size(min = 1)*/
ui/ui-graphics/src/commonMain/kotlin/androidx/compose/ui/graphics/colorspace/Rgb.kt:        /*@Size(min = 6, max = 9)*/
ui/ui-graphics/src/commonMain/kotlin/androidx/compose/ui/graphics/colorspace/Rgb.kt:        /*@Size(min = 1)*/
ui/ui-graphics/src/commonMain/kotlin/androidx/compose/ui/graphics/colorspace/Rgb.kt:        /*@Size(9)*/
ui/ui-graphics/src/commonMain/kotlin/androidx/compose/ui/graphics/colorspace/Rgb.kt:        /*@Size(min = 1)*/
ui/ui-graphics/src/commonMain/kotlin/androidx/compose/ui/graphics/colorspace/Rgb.kt:        /*@Size(min = 6, max = 9)*/
ui/ui-graphics/src/commonMain/kotlin/androidx/compose/ui/graphics/colorspace/Rgb.kt:    /*@Size(min = 6)*/
ui/ui-graphics/src/commonMain/kotlin/androidx/compose/ui/graphics/colorspace/WhitePoint.kt:    /*@Size(3)*/
ui/ui-graphics/src/commonMain/kotlin/androidx/compose/ui/graphics/drawscope/DrawScope.kt:        /*@FloatRange(from = 0.0,
 to = 1.0)*/
ui/ui-graphics/src/commonMain/kotlin/androidx/compose/ui/graphics/drawscope/DrawScope.kt:        /*@FloatRange(from = 0.0,
 to = 1.0)*/
ui/ui-graphics/src/commonMain/kotlin/androidx/compose/ui/graphics/drawscope/DrawScope.kt:        /*@FloatRange(from = 0.0,
 to = 1.0)*/
ui/ui-graphics/src/commonMain/kotlin/androidx/compose/ui/graphics/drawscope/DrawScope.kt:        /*@FloatRange(from = 0.0,
 to = 1.0)*/
ui/ui-graphics/src/commonMain/kotlin/androidx/compose/ui/graphics/drawscope/DrawScope.kt:        /*@FloatRange(from = 0.0,
 to = 1.0)*/
ui/ui-graphics/src/commonMain/kotlin/androidx/compose/ui/graphics/drawscope/DrawScope.kt:        /*@FloatRange(from = 0.0,
 to = 1.0)*/
ui/ui-graphics/src/commonMain/kotlin/androidx/compose/ui/graphics/drawscope/DrawScope.kt:        /*@FloatRange(from = 0.0,
 to = 1.0)*/
ui/ui-graphics/src/commonMain/kotlin/androidx/compose/ui/graphics/drawscope/DrawScope.kt:        /*@FloatRange(from = 0.0, to = 1.0)*/
ui/ui-graphics/src/commonMain/kotlin/androidx/compose/ui/graphics/drawscope/DrawScope.kt:        /*@FloatRange(from = 0.0, to = 1.0)*/
ui/ui-graphics/src/commonMain/kotlin/androidx/compose/ui/graphics/drawscope/DrawScope.kt:        /*@FloatRange(from = 0.0, to = 1.0)*/
ui/ui-graphics/src/commonMain/kotlin/androidx/compose/ui/graphics/drawscope/DrawScope.kt:        /*@FloatRange(from = 0.0, to = 1.0)*/
ui/ui-graphics/src/commonMain/kotlin/androidx/compose/ui/graphics/drawscope/DrawScope.kt:        /*@FloatRange(from = 0.0, to = 1.0)*/
ui/ui-graphics/src/commonMain/kotlin/androidx/compose/ui/graphics/drawscope/DrawScope.kt:        /*@FloatRange(from = 0.0, to = 1.0)*/
ui/ui-graphics/src/commonMain/kotlin/androidx/compose/ui/graphics/drawscope/DrawScope.kt:        /*@FloatRange(from = 0.0, to = 1.0)*/
ui/ui-graphics/src/commonMain/kotlin/androidx/compose/ui/graphics/drawscope/DrawScope.kt:        /*@FloatRange(from = 0.0, to = 1.0)*/
ui/ui-graphics/src/commonMain/kotlin/androidx/compose/ui/graphics/drawscope/DrawScope.kt:        /*@FloatRange(from = 0.0, to = 1.0)*/

Comments

le...@google.com <le...@google.com> Jul 21, 2023 09:57PM

Assigned to nj...@google.com.

ap...@google.com <ap...@google.com> #2Aug 11, 2023 12:14AM

Marked as fixed.

It is expected that BackHandler crashes in cases where no LocalOnBackPressedDispatcherOwner is provided.

Given that LocalOnBackPressedDispatcherOwner.current is nullable, you can certainly wrap your call to BackHandler in a null check if you'd like to specifically disable that functionality when in @Preview. Of course, you could just provide your own OnBackPressedDispatcherOwner by constructing an OnBackPressedDispatcher instance yourself as part of your @Preview.

Andrey - any thoughts on whether we should have @Preview automatically create and set a LocalOnBackPressedDispatcherOwner as we do for LocalViewModelStoreOwner? Who would be the correct assignee for that?

nj...@google.com <nj...@google.com> #3Aug 31, 2023 03:30AM

Status: Assigned (reopened)

If you think you want to provide some fake implementation for previews you probably want to provide it somewhere here:

https://cs.android.com/androidx/platform/frameworks/support/+/androidx-main:compose/ui/ui-tooling/src/androidMain/kotlin/androidx/compose/ui/tooling/preview/ComposeViewAdapter.kt;l=478;drc=38caeffe2a32b6135f231b83c54b109e30bcd474, and ask Diego for a review.
Note that in previews we do not really support ViewModels in reality. We provide a fake ViewModelStoreOwner, but this implementation just crashes when you try to create a ViewModel. It was a Sergey's idea as usually ViewModels are doing some network/database requests and we don't really support it in the preview mode.

ap...@google.com <ap...@google.com> #4Sep 8, 2023 10:19PM

Marked as fixed.

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

commit 026203513c5a704abeaa34595e7a7e7ab06876f7
Author: Ian Lake <ilake@google.com>
Date: Mon Jun 14 11:47:14 2021

Add an ActivityResultRegistry to Compose Previews

An ActivityResultRegistry is provided by default
by ComponentActivity, but using APIs that depend on
it, like rememberLauncherForActivityResult() would
crash in @Preview. By adding a fake implementation,
developers can preview those Composables.

For cases where they call `launch()` (i.e., the
`startActivityForResult()` equivalent), the fake
throws an IllegalStateException to indicate that
actually starting an activity / permission request
in Preview is not supported.

Relnote: "Compose `@Preview` now provides a
`LocalActivityResultRegistryOwner` that allows you
to preview Composables that use APIs like
`rememberLauncherForActivityResult()` that depend
on that owner existing."
Test: new ComposeViewAdapterTest test passes
BUG: 185693006

Change-Id: Ib13d12f085065adb89cfb731179b9295029e06e9

M compose/ui/ui-tooling/src/androidAndroidTest/kotlin/androidx/compose/ui/tooling/SimpleComposablePreview.kt
M compose/ui/ui-tooling/src/androidAndroidTest/kotlin/androidx/compose/ui/tooling/preview/ComposeViewAdapterTest.kt
M compose/ui/ui-tooling/src/androidMain/kotlin/androidx/compose/ui/tooling/preview/ComposeViewAdapter.kt

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

na...@google.com <na...@google.com> #5Sep 20, 2023 07:16PM

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

commit 622947a991ba924d4896965f708be022bf1b35ba
Author: Ian Lake <ilake@google.com>
Date: Mon Jun 14 11:34:13 2021

Add a fake OnBackPressedDispatcher to Compose Previews

Rather than having APIs that depend on
LocalOnBackPressedDispatcher crash in @Preview,
provide a fake implementation by default to mirror
the capabilities that are available by default
in a ComponentActivity.

Relnote: "Compose `@Preview` now provides a
`LocalOnBackPressedDispatcherOwner` that allows you
to preview Composables that use APIs like `BackHandler`
that depend on that owner existing."
Test: new ComposeViewAdapterTest test passes
BUG: 185693006

Change-Id: Ia1c05ea3cadf2fb55cef9c4b8bae0898cfb35ba9

M compose/ui/ui-tooling/src/androidAndroidTest/kotlin/androidx/compose/ui/tooling/SimpleComposablePreview.kt
M compose/ui/ui-tooling/src/androidAndroidTest/kotlin/androidx/compose/ui/tooling/preview/ComposeViewAdapterTest.kt
M compose/ui/ui-tooling/src/androidMain/kotlin/androidx/compose/ui/tooling/preview/ComposeViewAdapter.kt

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

Issue 290950582