[a11y] Pass the id of the node whose layout changed to accessibility …

…controllers (#1162)
JetBrains · Mar 5, 2024 · 80eb862 · 80eb862
1 parent 586e194
commit 80eb862
Show file tree

Hide file tree

Showing 7 changed files with 45 additions and 2 deletions.
diff --git a/compose/ui/ui/api/desktop/ui.api b/compose/ui/ui/api/desktop/ui.api
@@ -3152,6 +3152,7 @@ public abstract interface class androidx/compose/ui/platform/PlatformContext$Roo
 }
 
 public abstract interface class androidx/compose/ui/platform/PlatformContext$SemanticsOwnerListener {
+	public abstract fun onLayoutChange (Landroidx/compose/ui/semantics/SemanticsOwner;I)V
 	public abstract fun onSemanticsChange (Landroidx/compose/ui/semantics/SemanticsOwner;)V
 	public abstract fun onSemanticsOwnerAppended (Landroidx/compose/ui/semantics/SemanticsOwner;)V
 	public abstract fun onSemanticsOwnerRemoved (Landroidx/compose/ui/semantics/SemanticsOwner;)V

diff --git a/...ui/ui/src/desktopMain/kotlin/androidx/compose/ui/platform/a11y/AccessibilityController.kt b/...ui/ui/src/desktopMain/kotlin/androidx/compose/ui/platform/a11y/AccessibilityController.kt
@@ -315,6 +315,16 @@ internal class AccessibilityController(
         syncNodesChannel.trySend(Unit)
     }
 
+    /**
+     * Invoked when the position and/or size of the [SemanticsNode] with the given semantics id
+     * changed.
+     */
+    fun onLayoutChanged(@Suppress("UNUSED_PARAMETER") nodeId: Int) {
+        // TODO: Only recompute the layout-related properties of the node
+        nodeMappingIsValid = false
+        syncNodesChannel.trySend(Unit)
+    }
+
     /**
      * The [SemanticsNode] that is the root of the semantics node tree.
      */

diff --git a/...se/ui/ui/src/desktopMain/kotlin/androidx/compose/ui/scene/ComposeSceneMediator.desktop.kt b/...se/ui/ui/src/desktopMain/kotlin/androidx/compose/ui/scene/ComposeSceneMediator.desktop.kt
@@ -77,7 +77,6 @@ import javax.swing.SwingUtilities
 import kotlin.coroutines.CoroutineContext
 import kotlin.math.roundToInt
 import org.jetbrains.skia.Canvas
-import org.jetbrains.skiko.ClipComponent
 import org.jetbrains.skiko.ClipRectangle
 import org.jetbrains.skiko.ExperimentalSkikoApi
 import org.jetbrains.skiko.GraphicsApi
@@ -634,6 +633,10 @@ internal class ComposeSceneMediator(
         override fun onSemanticsChange(semanticsOwner: SemanticsOwner) {
             _accessibilityControllers[semanticsOwner]?.onSemanticsChange()
         }
+
+        override fun onLayoutChange(semanticsOwner: SemanticsOwner, semanticsNodeId: Int) {
+            _accessibilityControllers[semanticsOwner]?.onLayoutChanged(nodeId = semanticsNodeId)
+        }
     }
 
     private inner class DesktopPlatformContext : PlatformContext by PlatformContext.Empty {

diff --git a/compose/ui/ui/src/skikoMain/kotlin/androidx/compose/ui/node/RootNodeOwner.skiko.kt b/compose/ui/ui/src/skikoMain/kotlin/androidx/compose/ui/node/RootNodeOwner.skiko.kt
@@ -383,7 +383,10 @@ internal class RootNodeOwner(
         }
 
         override fun onLayoutChange(layoutNode: LayoutNode) {
-            platformContext.semanticsOwnerListener?.onSemanticsChange(semanticsOwner)
+            platformContext.semanticsOwnerListener?.onLayoutChange(
+                semanticsOwner = semanticsOwner,
+                semanticsNodeId = layoutNode.semanticsId
+            )
         }
 
         override fun getFocusDirection(keyEvent: KeyEvent): FocusDirection? {

diff --git a/compose/ui/ui/src/skikoMain/kotlin/androidx/compose/ui/platform/PlatformContext.skiko.kt b/compose/ui/ui/src/skikoMain/kotlin/androidx/compose/ui/platform/PlatformContext.skiko.kt
@@ -27,6 +27,7 @@ import androidx.compose.ui.geometry.Rect
 import androidx.compose.ui.input.InputMode
 import androidx.compose.ui.input.InputModeManager
 import androidx.compose.ui.input.pointer.PointerIcon
+import androidx.compose.ui.node.LayoutNode
 import androidx.compose.ui.node.Owner
 import androidx.compose.ui.node.RootForTest
 import androidx.compose.ui.scene.ComposeScene
@@ -125,6 +126,15 @@ interface PlatformContext {
          * @see Owner.onSemanticsChange
          */
         fun onSemanticsChange(semanticsOwner: SemanticsOwner)
+
+        /**
+         * Callback method that is called when the position and/or size of the [LayoutNode] with
+         * the given semantics id changed.
+         *
+         * Note that the id, rather than the [LayoutNode] itself, is passed here because
+         * [LayoutNode] is an internal type, so it can't be exposed in a public method.
+         */
+        fun onLayoutChange(semanticsOwner: SemanticsOwner, semanticsNodeId: Int)
     }
 
     companion object {

diff --git a/compose/ui/ui/src/uikitMain/kotlin/androidx/compose/ui/platform/Accessibility.uikit.kt b/compose/ui/ui/src/uikitMain/kotlin/androidx/compose/ui/platform/Accessibility.uikit.kt
@@ -967,6 +967,14 @@ internal class AccessibilityMediator(
         isCurrentComposeAccessibleTreeDirty = true
     }
 
+    fun onLayoutChange(nodeId: Int) {
+        debugLogger?.log("onLayoutChange (nodeId=$nodeId)")
+
+        // TODO: Only recompute the layout-related properties of the node
+        isCurrentComposeAccessibleTreeDirty = true
+
+    }
+
     fun convertRectToWindowSpaceCGRect(rect: Rect): CValue<CGRect> {
         val window = view.window ?: return CGRectMake(0.0, 0.0, 0.0, 0.0)
         val density = Density(window.screen.scale.toFloat())

diff --git a/compose/ui/ui/src/uikitMain/kotlin/androidx/compose/ui/scene/ComposeSceneMediator.uikit.kt b/compose/ui/ui/src/uikitMain/kotlin/androidx/compose/ui/scene/ComposeSceneMediator.uikit.kt
@@ -156,6 +156,14 @@ private class SemanticsOwnerListenerImpl(
             current.second.onSemanticsChange()
         }
     }
+
+    override fun onLayoutChange(semanticsOwner: SemanticsOwner, semanticsNodeId: Int) {
+        val current = current ?: return
+
+        if (current.first == semanticsOwner) {
+            current.second.onLayoutChange(nodeId = semanticsNodeId)
+        }
+    }
 }
 
 private class RenderingUIViewDelegateImpl(