Skip to content

Commit aae2a50

Browse files
author
George Mount
committed
Add public API to disable WindowInsetsRulers across Compose.
Bug: 438603965 Relnote: "ComposeView.disableWindowInsetsRulers() is added as a public API to disable WindowInsetsRulers across the application process." Test: new test Change-Id: Ibd402952333a9729211d8d103c6d40cb9e7ed98e
1 parent ae3611a commit aae2a50

7 files changed

Lines changed: 84 additions & 31 deletions

File tree

‎compose/foundation/foundation-layout/src/androidDeviceTest/kotlin/androidx/compose/foundation/layout/FitInsideTest.kt‎

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,6 @@ package androidx.compose.foundation.layout
1818
import android.view.View
1919
import androidx.activity.ComponentActivity
2020
import androidx.activity.enableEdgeToEdge
21-
import androidx.compose.ui.ComposeUiFlags
2221
import androidx.compose.ui.ExperimentalComposeUiApi
2322
import androidx.compose.ui.Modifier
2423
import androidx.compose.ui.layout.LayoutCoordinates
@@ -39,7 +38,6 @@ import androidx.test.filters.MediumTest
3938
import androidx.test.filters.SdkSuppress
4039
import com.google.common.truth.Truth.assertThat
4140
import kotlinx.coroutines.test.StandardTestDispatcher
42-
import org.junit.Assume
4341
import org.junit.Before
4442
import org.junit.Rule
4543
import org.junit.Test
@@ -60,7 +58,6 @@ class FitInsideTest {
6058

6159
@Test
6260
fun testFitWithin() {
63-
Assume.assumeTrue(ComposeUiFlags.areWindowInsetsRulersEnabled)
6461
lateinit var outsideCoordinates: LayoutCoordinates
6562
lateinit var insideCoordinates: LayoutCoordinates
6663
lateinit var view: View
@@ -85,7 +82,6 @@ class FitInsideTest {
8582

8683
@Test
8784
fun testFitWithinNoBounds() {
88-
Assume.assumeTrue(ComposeUiFlags.areWindowInsetsRulersEnabled)
8985
lateinit var outsideCoordinates: LayoutCoordinates
9086
lateinit var insideCoordinates: LayoutCoordinates
9187
lateinit var view: View

‎compose/foundation/foundation-layout/src/androidDeviceTest/kotlin/androidx/compose/foundation/layout/FitOutsideTest.kt‎

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,6 @@ package androidx.compose.foundation.layout
1818
import android.view.View
1919
import androidx.activity.ComponentActivity
2020
import androidx.activity.enableEdgeToEdge
21-
import androidx.compose.ui.ComposeUiFlags
2221
import androidx.compose.ui.ExperimentalComposeUiApi
2322
import androidx.compose.ui.Modifier
2423
import androidx.compose.ui.layout.LayoutCoordinates
@@ -42,7 +41,6 @@ import androidx.test.filters.MediumTest
4241
import androidx.test.filters.SdkSuppress
4342
import com.google.common.truth.Truth.assertThat
4443
import kotlinx.coroutines.test.StandardTestDispatcher
45-
import org.junit.Assume
4644
import org.junit.Before
4745
import org.junit.Rule
4846
import org.junit.Test
@@ -63,7 +61,6 @@ class FitOutsideTest {
6361

6462
@Test
6563
fun testFitOutsideLeft() {
66-
Assume.assumeTrue(ComposeUiFlags.areWindowInsetsRulersEnabled)
6764
lateinit var outsideCoordinates: LayoutCoordinates
6865
lateinit var insideCoordinates: LayoutCoordinates
6966
lateinit var view: View
@@ -88,7 +85,6 @@ class FitOutsideTest {
8885

8986
@Test
9087
fun testFitOutsideTop() {
91-
Assume.assumeTrue(ComposeUiFlags.areWindowInsetsRulersEnabled)
9288
lateinit var outsideCoordinates: LayoutCoordinates
9389
lateinit var insideCoordinates: LayoutCoordinates
9490
lateinit var view: View
@@ -113,7 +109,6 @@ class FitOutsideTest {
113109

114110
@Test
115111
fun testFitOutsideRight() {
116-
Assume.assumeTrue(ComposeUiFlags.areWindowInsetsRulersEnabled)
117112
lateinit var outsideCoordinates: LayoutCoordinates
118113
lateinit var insideCoordinates: LayoutCoordinates
119114
lateinit var view: View
@@ -139,7 +134,6 @@ class FitOutsideTest {
139134

140135
@Test
141136
fun testFitOutsideBottom() {
142-
Assume.assumeTrue(ComposeUiFlags.areWindowInsetsRulersEnabled)
143137
lateinit var outsideCoordinates: LayoutCoordinates
144138
lateinit var insideCoordinates: LayoutCoordinates
145139
lateinit var view: View
@@ -165,7 +159,6 @@ class FitOutsideTest {
165159

166160
@Test
167161
fun testFitOutsideNoInsets() {
168-
Assume.assumeTrue(ComposeUiFlags.areWindowInsetsRulersEnabled)
169162
lateinit var insideCoordinates: LayoutCoordinates
170163
lateinit var view: View
171164
rule.setContent {
@@ -185,7 +178,6 @@ class FitOutsideTest {
185178

186179
@Test
187180
fun testFitOutsideNoBounds() {
188-
Assume.assumeTrue(ComposeUiFlags.areWindowInsetsRulersEnabled)
189181
lateinit var insideCoordinates: LayoutCoordinates
190182
rule.setContent {
191183
Box(Modifier.fillMaxSize()) {

‎compose/ui/ui/api/current.txt‎

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -148,7 +148,7 @@ package androidx.compose.ui {
148148
}
149149

150150
@SuppressCompatibility @androidx.compose.ui.ExperimentalComposeUiApi public final class ComposeUiFlags {
151-
property public boolean areWindowInsetsRulersEnabled;
151+
property @Deprecated public boolean areWindowInsetsRulersEnabled;
152152
property public boolean isAccessibilityShowOnScreenNestedScrollingEnabled;
153153
property public boolean isAdaptiveRefreshRateEnabled;
154154
property public boolean isBypassUnfocusableComposeViewEnabled;
@@ -163,7 +163,7 @@ package androidx.compose.ui {
163163
property public boolean isTraversableDelegatesFixEnabled;
164164
property public boolean isViewFocusFixEnabled;
165165
field public static final androidx.compose.ui.ComposeUiFlags INSTANCE;
166-
field public static boolean areWindowInsetsRulersEnabled;
166+
field @Deprecated public static boolean areWindowInsetsRulersEnabled;
167167
field public static boolean isAccessibilityShowOnScreenNestedScrollingEnabled;
168168
field public static boolean isAdaptiveRefreshRateEnabled;
169169
field public static boolean isBypassUnfocusableComposeViewEnabled;
@@ -3976,6 +3976,14 @@ package androidx.compose.ui.platform {
39763976
method public void setContent(kotlin.jvm.functions.Function0<kotlin.Unit> content);
39773977
method @BytecodeOnly public void setContent(kotlin.jvm.functions.Function2<? super androidx.compose.runtime.Composer!,? super java.lang.Integer!,kotlin.Unit!>);
39783978
property protected boolean shouldCreateCompositionOnAttachedToWindow;
3979+
field public static final androidx.compose.ui.platform.ComposeView.Companion Companion;
3980+
}
3981+
3982+
public static final class ComposeView.Companion {
3983+
}
3984+
3985+
@SuppressCompatibility public final class ComposeView_androidKt {
3986+
method @SuppressCompatibility @androidx.compose.ui.ExperimentalComposeUiApi public static void disableWindowInsetsRulers(androidx.compose.ui.platform.ComposeView.Companion);
39793987
}
39803988

39813989
public final class CompositionLocalsKt {

‎compose/ui/ui/api/restricted_current.txt‎

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -148,7 +148,7 @@ package androidx.compose.ui {
148148
}
149149

150150
@SuppressCompatibility @androidx.compose.ui.ExperimentalComposeUiApi public final class ComposeUiFlags {
151-
property public boolean areWindowInsetsRulersEnabled;
151+
property @Deprecated public boolean areWindowInsetsRulersEnabled;
152152
property public boolean isAccessibilityShowOnScreenNestedScrollingEnabled;
153153
property public boolean isAdaptiveRefreshRateEnabled;
154154
property public boolean isBypassUnfocusableComposeViewEnabled;
@@ -163,7 +163,7 @@ package androidx.compose.ui {
163163
property public boolean isTraversableDelegatesFixEnabled;
164164
property public boolean isViewFocusFixEnabled;
165165
field public static final androidx.compose.ui.ComposeUiFlags INSTANCE;
166-
field public static boolean areWindowInsetsRulersEnabled;
166+
field @Deprecated public static boolean areWindowInsetsRulersEnabled;
167167
field public static boolean isAccessibilityShowOnScreenNestedScrollingEnabled;
168168
field public static boolean isAdaptiveRefreshRateEnabled;
169169
field public static boolean isBypassUnfocusableComposeViewEnabled;
@@ -4036,6 +4036,14 @@ package androidx.compose.ui.platform {
40364036
method public void setContent(kotlin.jvm.functions.Function0<kotlin.Unit> content);
40374037
method @BytecodeOnly public void setContent(kotlin.jvm.functions.Function2<? super androidx.compose.runtime.Composer!,? super java.lang.Integer!,kotlin.Unit!>);
40384038
property protected boolean shouldCreateCompositionOnAttachedToWindow;
4039+
field public static final androidx.compose.ui.platform.ComposeView.Companion Companion;
4040+
}
4041+
4042+
public static final class ComposeView.Companion {
4043+
}
4044+
4045+
@SuppressCompatibility public final class ComposeView_androidKt {
4046+
method @SuppressCompatibility @androidx.compose.ui.ExperimentalComposeUiApi public static void disableWindowInsetsRulers(androidx.compose.ui.platform.ComposeView.Companion);
40394047
}
40404048

40414049
public final class CompositionLocalsKt {

‎compose/ui/ui/src/androidDeviceTest/kotlin/androidx/compose/ui/layout/WindowInsetsRulersTest.kt‎

Lines changed: 40 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -46,9 +46,11 @@ import androidx.compose.ui.node.LayoutModifierNode
4646
import androidx.compose.ui.node.ModifierNodeElement
4747
import androidx.compose.ui.node.requestRemeasure
4848
import androidx.compose.ui.platform.AndroidComposeView
49+
import androidx.compose.ui.platform.ComposeView
4950
import androidx.compose.ui.platform.InspectorInfo
5051
import androidx.compose.ui.platform.LocalDensity
5152
import androidx.compose.ui.platform.LocalView
53+
import androidx.compose.ui.platform.disableWindowInsetsRulers
5254
import androidx.compose.ui.test.junit4.v2.createAndroidComposeRule
5355
import androidx.compose.ui.unit.Constraints
5456
import androidx.compose.ui.unit.IntRect
@@ -67,7 +69,7 @@ import com.google.common.truth.Truth.assertThat
6769
import com.google.common.truth.Truth.assertWithMessage
6870
import kotlin.math.roundToInt
6971
import kotlinx.coroutines.test.StandardTestDispatcher
70-
import org.junit.Assume
72+
import org.junit.After
7173
import org.junit.Before
7274
import org.junit.Rule
7375
import org.junit.Test
@@ -93,6 +95,8 @@ class WindowInsetsRulersTest {
9395
private var contentWidth = 0
9496
private var contentHeight = 0
9597
private val displayCutoutRects = mutableObjectListOf<IntRect?>()
98+
@Suppress("DEPRECATION")
99+
private var areWindowInsetsRulersEnabled = ComposeUiFlags.areWindowInsetsRulersEnabled
96100

97101
@Before
98102
fun setup() {
@@ -103,6 +107,12 @@ class WindowInsetsRulersTest {
103107
contentView.setOnApplyWindowInsetsListener { _, _ -> android.view.WindowInsets.CONSUMED }
104108
}
105109

110+
@After
111+
fun tearDown() {
112+
@Suppress("DEPRECATION")
113+
ComposeUiFlags.areWindowInsetsRulersEnabled = areWindowInsetsRulersEnabled
114+
}
115+
106116
private fun setContent(content: @Composable () -> Unit) {
107117
rule.setContent {
108118
composeView = LocalView.current as AndroidComposeView
@@ -206,7 +216,6 @@ class WindowInsetsRulersTest {
206216

207217
@Test
208218
fun noRulers() {
209-
Assume.assumeTrue(ComposeUiFlags.areWindowInsetsRulersEnabled)
210219
val rulerState = mutableStateOf(CaptionBar)
211220

212221
setSimpleRulerContent(rulerState)
@@ -234,7 +243,6 @@ class WindowInsetsRulersTest {
234243

235244
@Test
236245
fun onlyMaximumRulers() {
237-
Assume.assumeTrue(ComposeUiFlags.areWindowInsetsRulersEnabled)
238246
val rulerState = mutableStateOf(CaptionBar)
239247

240248
setSimpleRulerContent(rulerState)
@@ -258,7 +266,6 @@ class WindowInsetsRulersTest {
258266

259267
@Test
260268
fun startAndStopProvidingRulers() {
261-
Assume.assumeTrue(ComposeUiFlags.areWindowInsetsRulersEnabled)
262269
val rulerState = mutableStateOf(CaptionBar)
263270

264271
setSimpleRulerContent(rulerState)
@@ -283,7 +290,6 @@ class WindowInsetsRulersTest {
283290

284291
@Test
285292
fun normalRulers() {
286-
Assume.assumeTrue(ComposeUiFlags.areWindowInsetsRulersEnabled)
287293
val rulerState = mutableStateOf(CaptionBar)
288294
setSimpleRulerContent(rulerState)
289295
val normalRulersList =
@@ -329,7 +335,6 @@ class WindowInsetsRulersTest {
329335

330336
@Test
331337
fun maximum() {
332-
Assume.assumeTrue(ComposeUiFlags.areWindowInsetsRulersEnabled)
333338
val rulerState = mutableStateOf(CaptionBar)
334339
setSimpleRulerContent(rulerState)
335340
val maximumRulersList =
@@ -363,7 +368,6 @@ class WindowInsetsRulersTest {
363368

364369
@Test
365370
fun waterfallRulers() {
366-
Assume.assumeTrue(ComposeUiFlags.areWindowInsetsRulersEnabled)
367371
val rulerState = mutableStateOf(Waterfall)
368372
setSimpleRulerContent(rulerState)
369373
rule.waitForIdle()
@@ -389,7 +393,6 @@ class WindowInsetsRulersTest {
389393
/** Make sure that when the display cutout is set that it includes the rects for each side. */
390394
@Test
391395
fun displayCutoutRulers() {
392-
Assume.assumeTrue(ComposeUiFlags.areWindowInsetsRulersEnabled)
393396
setSimpleRulerContent(mutableStateOf(DisplayCutout))
394397

395398
val insets = createInsets(Type.displayCutout() to Insets.of(1, 2, 3, 5))
@@ -409,7 +412,6 @@ class WindowInsetsRulersTest {
409412

410413
@Test
411414
fun mergedRulers() {
412-
Assume.assumeTrue(ComposeUiFlags.areWindowInsetsRulersEnabled)
413415
val mergedRulersMap =
414416
mapOf(
415417
SafeGestures to
@@ -470,7 +472,6 @@ class WindowInsetsRulersTest {
470472

471473
@Test
472474
fun animatingRulers() {
473-
Assume.assumeTrue(ComposeUiFlags.areWindowInsetsRulersEnabled)
474475
val rulerState = mutableStateOf(Ime)
475476
setSimpleRulerContent(rulerState)
476477

@@ -617,7 +618,6 @@ class WindowInsetsRulersTest {
617618

618619
@Test
619620
fun animateMergedRulers() {
620-
Assume.assumeTrue(ComposeUiFlags.areWindowInsetsRulersEnabled)
621621
// display cutout and waterfall aren't animatable
622622
val mergedRulersMap =
623623
mapOf(
@@ -735,7 +735,6 @@ class WindowInsetsRulersTest {
735735

736736
@Test
737737
fun rulersInCenteredDialog() {
738-
Assume.assumeTrue(ComposeUiFlags.areWindowInsetsRulersEnabled)
739738
var boxInsetsRect: IntRect? = null
740739
var dialogInsetsRect: IntRect? = null
741740
lateinit var coordinates: LayoutCoordinates
@@ -792,7 +791,6 @@ class WindowInsetsRulersTest {
792791

793792
@Test
794793
fun rulersInFullScreenDialog() {
795-
Assume.assumeTrue(ComposeUiFlags.areWindowInsetsRulersEnabled)
796794
var boxInsetsRect: IntRect? = null
797795
var dialogInsetsRect: IntRect? = null
798796
lateinit var coordinates: LayoutCoordinates
@@ -925,7 +923,6 @@ class WindowInsetsRulersTest {
925923

926924
@Test
927925
fun innermostOf() {
928-
Assume.assumeTrue(ComposeUiFlags.areWindowInsetsRulersEnabled)
929926
val rulerState = mutableStateOf(WindowInsetsRulers.innermostOf(CaptionBar, NavigationBars))
930927
setSimpleRulerContent(rulerState)
931928
rule.waitForIdle()
@@ -975,6 +972,35 @@ class WindowInsetsRulersTest {
975972
}
976973
}
977974

975+
@Test
976+
fun disableWindowInsetsRulers() {
977+
ComposeView.disableWindowInsetsRulers()
978+
var left = 0f
979+
var top = 0f
980+
var right = 0f
981+
var bottom = 0f
982+
rule.setContent {
983+
Box(
984+
Modifier.fillMaxSize().layout { measurable, constraints ->
985+
val placeable = measurable.measure(constraints)
986+
layout(placeable.width, placeable.height) {
987+
placeable.place(0, 0)
988+
left = StatusBars.current.left.current(Float.NaN)
989+
top = StatusBars.current.top.current(Float.NaN)
990+
right = StatusBars.current.right.current(Float.NaN)
991+
bottom = StatusBars.current.bottom.current(Float.NaN)
992+
}
993+
}
994+
)
995+
}
996+
rule.waitForIdle()
997+
998+
assertThat(left).isNaN()
999+
assertThat(top).isNaN()
1000+
assertThat(right).isNaN()
1001+
assertThat(bottom).isNaN()
1002+
}
1003+
9781004
private fun createInsetsIgnoringVisibility(
9791005
vararg insetValues: Pair<Int, Insets>
9801006
): WindowInsetsCompat {

‎compose/ui/ui/src/androidMain/kotlin/androidx/compose/ui/platform/ComposeView.android.kt‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ import androidx.compose.runtime.CompositionContext
2727
import androidx.compose.runtime.Recomposer
2828
import androidx.compose.runtime.mutableStateOf
2929
import androidx.compose.ui.AndroidComposeUiFlags
30+
import androidx.compose.ui.ComposeUiFlags
3031
import androidx.compose.ui.ExperimentalComposeUiApi
3132
import androidx.compose.ui.InternalComposeUiApi
3233
import androidx.compose.ui.R
@@ -603,6 +604,22 @@ constructor(context: Context, attrs: AttributeSet? = null, defStyleAttr: Int = 0
603604
createComposition()
604605
}
605606
}
607+
608+
/** Here to allow extension functions */
609+
companion object
610+
}
611+
612+
/**
613+
* Used to disable [androidx.compose.ui.layout.WindowInsetsRulers]. This can be used when UI never
614+
* reads WindowInsets across the process and having WindowInsets callbacks cause frame generation
615+
* when no content is updated. Applications typically would not use this method, but it may be
616+
* necessary for system UI. This should be called before the first [ComposeView] is created to avoid
617+
* insets calls.
618+
*/
619+
@ExperimentalComposeUiApi
620+
fun ComposeView.Companion.disableWindowInsetsRulers() {
621+
@Suppress("DEPRECATION")
622+
ComposeUiFlags.areWindowInsetsRulersEnabled = false
606623
}
607624

608625
@OptIn(ExperimentalComposeUiApi::class)

‎compose/ui/ui/src/commonMain/kotlin/androidx/compose/ui/ComposeUiFlags.kt‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,13 @@ object ComposeUiFlags {
9292
* * `SafeContentRulers`
9393
*/
9494
// off for b/410868572
95-
@field:Suppress("MutableBareField") @JvmField var areWindowInsetsRulersEnabled = true
95+
@Deprecated(
96+
"Use ComposeView.disableWindowInsetsRulers()",
97+
replaceWith = ReplaceWith("ComposeView.disableWindowInsetsRulers()"),
98+
)
99+
@field:Suppress("MutableBareField")
100+
@JvmField
101+
var areWindowInsetsRulersEnabled = true
96102

97103
/** Enable initial focus when a focusable is added to a screen with no focusable content. */
98104
@field:Suppress("MutableBareField")

0 commit comments

Comments
 (0)