Merge "Introduce Path#rewind" into androidx-main

Author: Treehugger Robot

Diff for: compose/ui/ui-graphics/api/current.txt

@@ -623,6 +623,7 @@ package androidx.compose.ui.graphics {
     method public void relativeMoveTo(float dx, float dy);
     method public void relativeQuadraticBezierTo(float dx1, float dy1, float dx2, float dy2);
     method public void reset();
+    method public default void rewind();
     method public void setFillType(int);
     method public void translate(long offset);
     property public abstract int fillType;

Diff for: compose/ui/ui-graphics/api/public_plus_experimental_current.txt

@@ -626,6 +626,7 @@ package androidx.compose.ui.graphics {
     method public void relativeMoveTo(float dx, float dy);
     method public void relativeQuadraticBezierTo(float dx1, float dy1, float dx2, float dy2);
     method public void reset();
+    method public default void rewind();
     method public void setFillType(int);
     method public void translate(long offset);
     property public abstract int fillType;

Diff for: compose/ui/ui-graphics/api/restricted_current.txt

@@ -658,6 +658,7 @@ package androidx.compose.ui.graphics {
     method public void relativeMoveTo(float dx, float dy);
     method public void relativeQuadraticBezierTo(float dx1, float dy1, float dx2, float dy2);
     method public void reset();
+    method public default void rewind();
     method public void setFillType(int);
     method public void translate(long offset);
     property public abstract int fillType;

Diff for: compose/ui/ui-graphics/src/androidAndroidTest/kotlin/androidx/compose/ui/graphics/PathTest.kt

@@ -25,6 +25,8 @@ import org.junit.Test
 import org.junit.runner.RunWith
 import androidx.test.ext.junit.runners.AndroidJUnit4
 import kotlin.math.PI
+import org.junit.Assert.assertFalse
+import org.junit.Assert.assertTrue
 
 @SmallTest
 @RunWith(AndroidJUnit4::class)
@@ -78,4 +80,30 @@ class PathTest {
             ]
         )
     }
+
+    @Test
+    fun testRewindPath() {
+        val androidPath = TestAndroidPath()
+        val path = androidPath.asComposePath().apply {
+            addRect(Rect(0f, 0f, 100f, 200f))
+        }
+        assertFalse(path.isEmpty)
+
+        path.rewind()
+
+        assertTrue(path.isEmpty)
+        // Reset should not be invoked as the rewind method is implemented to call into the
+        // corresponding rewind call in the framework and not call the default fallback
+        assertEquals(0, androidPath.resetCount)
+    }
+
+    class TestAndroidPath : android.graphics.Path() {
+
+        var resetCount = 0
+
+        override fun reset() {
+            resetCount++
+            super.reset()
+        }
+    }
 }

Diff for: compose/ui/ui-graphics/src/androidMain/kotlin/androidx/compose/ui/graphics/AndroidPath.android.kt

@@ -180,6 +180,10 @@ inline fun Path.asAndroidPath(): android.graphics.Path =
         internalPath.reset()
     }
 
+    override fun rewind() {
+        internalPath.rewind()
+    }
+
     override fun translate(offset: Offset) {
         mMatrix.reset()
         mMatrix.setTranslate(offset.x, offset.y)

Diff for: compose/ui/ui-graphics/src/commonMain/kotlin/androidx/compose/ui/graphics/Path.kt

@@ -217,6 +217,16 @@ expect fun Path(): Path
      */
     fun reset()
 
+    /**
+     * Rewinds the path: clears any lines and curves from the path but keeps the internal data
+     * structure for faster reuse.
+     */
+    fun rewind() {
+        // Call reset to avoid AbstractMethodAdded lint API errors. Implementations are already
+        // calling into the respective platform Path#rewind equivalent.
+        reset()
+    }
+
     /**
      * Translates all the segments of every subpath by the given offset.
      */

Diff for: compose/ui/ui-graphics/src/commonTest/kotlin/androidx/compose/ui/graphics/vector/PathParserTest.kt

@@ -179,6 +179,10 @@ class PathParserTest {
             // NO-OP
         }
 
+        override fun rewind() {
+            // NO-OP
+        }
+
         override fun translate(offset: Offset) {
             // NO-OP
         }

Diff for: compose/ui/ui-graphics/src/desktopTest/kotlin/androidx/compose/ui/graphics/DesktopPathTest.kt

@@ -20,6 +20,8 @@ import androidx.compose.ui.geometry.Rect
 import androidx.compose.ui.geometry.RoundRect
 import androidx.compose.ui.test.InternalTestApi
 import org.junit.Assert.assertEquals
+import org.junit.Assert.assertTrue
+import org.junit.Assert.assertFalse
 import org.junit.Test
 
 @OptIn(InternalTestApi::class)
@@ -211,4 +213,16 @@ class DesktopPathTest : DesktopGraphicsTest() {
 
         assertEquals(PathFillType.EvenOdd, path.fillType)
     }
+
+    @Test
+    fun testRewind() {
+        val path = Path().apply {
+            addRect(Rect(0f, 0f, 100f, 200f))
+        }
+        assertFalse(path.isEmpty)
+
+        path.rewind()
+
+        assertTrue(path.isEmpty)
+    }
 }

Diff for: compose/ui/ui-graphics/src/skikoMain/kotlin/androidx/compose/ui/graphics/SkiaBackedPath.skiko.kt

@@ -164,6 +164,10 @@ internal class SkiaBackedPath(
         this.fillType = fillType
     }
 
+    override fun rewind() {
+        internalPath.rewind()
+    }
+
     override fun translate(offset: Offset) {
         internalPath.transform(Matrix33.makeTranslate(offset.x, offset.y))
     }