[PATCH v6 0/1] MR3581: gdiplus: add support for GdipPathIterNextPathType

[Bartosz Kosiorek (＠gang65)]

I have covered implementation with additional test cases.

--
  v6: gdiplus: add support for GdipPathIterNextPathType

https://gitlab.winehq.org/wine/wine/-/merge_requests/3581

[PATCH v6 1/1] gdiplus: add support for GdipPathIterNextPathType

[Bartosz Kosiorek]

From: Bartosz Kosiorek

---
 dlls/gdiplus/pathiterator.c       |  34 +++++-
 dlls/gdiplus/tests/pathiterator.c | 171 +++++++++++++++++++++++++-----
 2 files changed, 173 insertions(+), 32 deletions(-)

diff --git a/dlls/gdiplus/pathiterator.c b/dlls/gdiplus/pathiterator.c
index 2addbc3bc57..c25f7db52a8 100644
--- a/dlls/gdiplus/pathiterator.c
+++ b/dlls/gdiplus/pathiterator.c
@@ -222,6 +222,8 @@ GpStatus WINGDIPAPI GdipPathIterNextSubpath(GpPathIterator* iterator,
     }

*startIndex = iterator->subpath_pos;
+    /* Set new pathtype position */
+    iterator->pathtype_pos = iterator->subpath_pos;

for(i = iterator->subpath_pos + 1; i < count &&
         !(iterator->pathdata.Types[i] == PathPointTypeStart); i++);
@@ -238,6 +240,7 @@ GpStatus WINGDIPAPI GdipPathIterNextSubpath(GpPathIterator* iterator,

return Ok;
 }
+
 GpStatus WINGDIPAPI GdipPathIterRewind(GpPathIterator *iterator)
 {
     TRACE("(%p)\n", iterator);
@@ -295,12 +298,37 @@ GpStatus WINGDIPAPI GdipPathIterIsValid(GpPathIterator* iterator, BOOL* valid)
 GpStatus WINGDIPAPI GdipPathIterNextPathType(GpPathIterator* iter, INT* result,
     BYTE* type, INT* start, INT* end)
 {
-    FIXME("(%p, %p, %p, %p, %p) stub\n", iter, result, type, start, end);
+    INT i, count, tempType;
+    TRACE("(%p, %p, %p, %p, %p)\n", iter, result, type, start, end);

-    if(!iter || !result || !type || !start || !end)
+    if (!iter || !result || !type || !start || !end)
         return InvalidParameter;

-    return NotImplemented;
+    i = iter->pathtype_pos;
+    count = iter->subpath_pos;
+    if ((i >= count) ||
+        ((iter->pathdata.Types[i] & PathPointTypePathTypeMask) != PathPointTypeStart)) {
+        *result = 0;
+        return Ok;
+    }
+
+    *start = i;
+    i++;
+    if ((i < count) &&
+       ((iter->pathdata.Types[i] & PathPointTypePathTypeMask) != PathPointTypeStart))
+    {
+        *type = iter->pathdata.Types[i] & PathPointTypePathTypeMask;
+        i++;
+        for ( ; i < count; i++) {
+            tempType = iter->pathdata.Types[i] & PathPointTypePathTypeMask;
+            if ((tempType != *type) || (tempType == PathPointTypeStart))
+                break;
+        }
+    }
+    iter->pathtype_pos = i;
+    *end = i - 1;
+    *result = *end - *start + 1;
+    return Ok;
 }

GpStatus WINGDIPAPI GdipPathIterNextSubpathPath(GpPathIterator* iter, INT* result,
diff --git a/dlls/gdiplus/tests/pathiterator.c b/dlls/gdiplus/tests/pathiterator.c
index 9bd3ac5452e..45af2cb69d6 100644
--- a/dlls/gdiplus/tests/pathiterator.c
+++ b/dlls/gdiplus/tests/pathiterator.c
@@ -464,18 +464,38 @@ static void test_nextsubpath(void)
     GpPath *path;
     GpPathIterator *iter;
     GpStatus stat;
-    INT start, end, result;
+    INT result, start, end;
     BOOL closed;

/* empty path */
     GdipCreatePath(FillModeAlternate, &path);
     GdipCreatePathIter(&iter, path);

-    result = -2;
-    closed = TRUE;
+    result = start = end = closed = (INT)0xdeadbeef;
+    stat = GdipPathIterNextSubpath(iter, &result, &start, &end, &closed);
+    expect(Ok, stat);
+    expect(0, result);
+    expect((INT)0xdeadbeef, start);
+    expect((INT)0xdeadbeef, end);
+    expect((INT)0xdeadbeef, closed);
+
+    /* four points figure */
+    GdipAddPathLine(path, 0.0, 0.0, 10.0, 30.0);
+    GdipAddPathLine(path, -10.0, 5.0, 15.0, 8.0);
+    GdipCreatePathIter(&iter, path);
+    stat = GdipPathIterNextSubpath(iter, &result, &start, &end, &closed);
+    expect(Ok, stat);
+    expect(4, result);
+    expect(0, start);
+    expect(3, end);
+    expect(FALSE, closed);
+
+    /* No more subpaths*/
     stat = GdipPathIterNextSubpath(iter, &result, &start, &end, &closed);
     expect(Ok, stat);
     expect(0, result);
+    expect(0, start);
+    expect(0, end);
     expect(TRUE, closed);

GdipDeletePathIter(iter);
@@ -487,8 +507,10 @@ static void test_nextpathtype(void)
     GpPath *path;
     GpPathIterator *iter;
     GpStatus stat;
-    INT start, end, result;
+    INT count, result, start, end;
     BYTE type;
+    BOOL closed;
+    GpPointF point;

GdipCreatePath(FillModeAlternate, &path);
     GdipCreatePathIter(&iter, path);
@@ -510,53 +532,144 @@ static void test_nextpathtype(void)
     expect(InvalidParameter, stat);

/* empty path */
-    start = end = result = (INT)0xdeadbeef;
+    result = start = end = (INT)0xdeadbeef;
+    type = 255; /* out of range */
     stat = GdipPathIterNextPathType(iter, &result, &type, &start, &end);
-    todo_wine expect(Ok, stat);
+    expect(Ok, stat);
+    expect(0, result);
+    expect(255, type);
     expect((INT)0xdeadbeef, start);
     expect((INT)0xdeadbeef, end);
-    todo_wine expect(0, result);
     GdipDeletePathIter(iter);

-    /* single figure */
-    GdipAddPathLine(path, 0.0, 0.0, 10.0, 30.0);
-    GdipCreatePathIter(&iter, path);
-    start = end = result = (INT)0xdeadbeef;
+    /* figure with three subpaths */
+    stat = GdipAddPathLine(path, 0.0, 0.0, 10.0, 30.0);
+    expect(Ok, stat);
+    stat = GdipAddPathRectangle(path, 1.0, 2.0, 3.0, 4.0);
+    expect(Ok, stat);
+    stat = GdipAddPathEllipse(path, 0.0, 0.0, 35.0, 70.0);
+    expect(Ok, stat);
+    stat = GdipCreatePathIter(&iter, path);
+    expect(Ok, stat);
+
+    /* When subPath is not set,
+       it is not possible to get Path Type */
+    result = start = end = (INT)0xdeadbeef;
     type = 255; /* out of range */
     stat = GdipPathIterNextPathType(iter, &result, &type, &start, &end);
-    todo_wine expect(Ok, stat);
+    expect(Ok, stat);
+    expect(0, result);
+    expect(255, type);
     expect((INT)0xdeadbeef, start);
     expect((INT)0xdeadbeef, end);
-    expect(255, type);
-    todo_wine expect(0, result);
-    GdipDeletePathIter(iter);

-    stat = GdipAddPathEllipse(path, 0.0, 0.0, 35.0, 70.0);
+    /* When subPath is not set,
+       it is possible to get number of path points */
+    stat = GdipPathIterGetCount(iter, &count);
     expect(Ok, stat);
-    GdipCreatePathIter(&iter, path);
+    expect(19, count);
+
+    /* Set subPath (Line) */
+    result = start = end = closed = (INT)0xdeadbeef;
+    stat = GdipPathIterNextSubpath(iter, &result, &start, &end, &closed);
+    expect(Ok, stat);
+    expect(2, result);
+    expect(0, start);
+    expect(1, end);
+    expect(FALSE, closed);
+
+    /* When subPath is set (Line), return position of points with the same type */
+    result = start = end = (INT)0xdeadbeef;
+    type = 255; /* out of range */
+    stat = GdipPathIterNextPathType(iter, &result, &type, &start, &end);
+    expect(Ok, stat);
+    expect(2, result);
+    expect(PathPointTypeLine, type);
+    expect(0, start);
+    expect(1, end);
+
+    /* When NextSubpath is running twice, without invocation NextPathType
+       (skipping Rectangle figure), make sure that PathType index is updated */
+    result = start = end = closed = (INT)0xdeadbeef;
+    stat = GdipPathIterNextSubpath(iter, &result, &start, &end, &closed);
+    expect(Ok, stat);
+    expect(4, result);
+    expect(2, start);
+    expect(5, end);
+    expect(TRUE, closed);
+
+    /* Increment subPath (to Ellipse figure) */
+    result = start = end = closed = (INT)0xdeadbeef;
+    stat = GdipPathIterNextSubpath(iter, &result, &start, &end, &closed);
+    expect(Ok, stat);
+    expect(13, result);
+    expect(6, start);
+    expect(18, end);
+    expect(TRUE, closed);
+
+    /* When subPath is set to Ellipse figure, the type is PathPointTypeBezier */
+    result = start = end = (INT)0xdeadbeef;
+    type = 255; /* out of range */
+    stat = GdipPathIterNextPathType(iter, &result, &type, &start, &end);
+    expect(Ok, stat);
+    expect(13, result);
+    expect(PathPointTypeBezier, type);
+    expect(6, start);
+    expect(18, end);
+
+    /* As there is no more subpaths, when subPath is incremented,
+       it returns zeros */
+    result = start = end = closed = (INT)0xdeadbeef;
+    stat = GdipPathIterNextSubpath(iter, &result, &start, &end, &closed);
+    expect(Ok, stat);
+    expect(0, result);
+    expect(0, start);
+    expect(0, end);
+    expect(TRUE, closed);
+
+    /* When no more elements, after invoking NextPathType
+       the output numbers are not changed */
     start = end = result = (INT)0xdeadbeef;
     type = 255; /* out of range */
     stat = GdipPathIterNextPathType(iter, &result, &type, &start, &end);
-    todo_wine expect(Ok, stat);
+    expect(Ok, stat);
+    expect(0, result);
+    expect(255, type);
     expect((INT)0xdeadbeef, start);
     expect((INT)0xdeadbeef, end);
-    expect(255, type);
-    todo_wine expect(0, result);
+
     GdipDeletePathIter(iter);
+    GdipDeletePath(path);

-    /* closed */
-    GdipClosePathFigure(path);
-    GdipCreatePathIter(&iter, path);
-    start = end = result = (INT)0xdeadbeef;
+
+    /* Single PathPointTypeStart point */
+    GdipCreatePath(FillModeAlternate, &path);
+    point.X = 1.0;
+    point.Y = 2.0;
+    stat = GdipAddPathLine2(path, &point, 1);
+    expect(Ok, stat);
+    GdipStartPathFigure(path);
+    stat = GdipCreatePathIter(&iter, path);
+    expect(Ok, stat);
+
+    result = start = end = closed = (INT)0xdeadbeef;
+    stat = GdipPathIterNextSubpath(iter, &result, &start, &end, &closed);
+    expect(Ok, stat);
+    expect(1, result);
+    expect(0, start);
+    expect(0, end);
+    expect(FALSE, closed);
+
+    result = start = end = (INT)0xdeadbeef;
     type = 255; /* out of range */
     stat = GdipPathIterNextPathType(iter, &result, &type, &start, &end);
-    todo_wine expect(Ok, stat);
-    expect((INT)0xdeadbeef, start);
-    expect((INT)0xdeadbeef, end);
+    expect(Ok, stat);
+    expect(1, result);
     expect(255, type);
-    todo_wine expect(0, result);
-    GdipDeletePathIter(iter);
+    expect(0, start);
+    expect(0, end);

+    GdipDeletePathIter(iter);
     GdipDeletePath(path);
 }

[Jeffrey Smith (＠whydoubt)]

Jeffrey Smith (@whydoubt) commented about dlls/gdiplus/tests/pathiterator.c:
> - GdipDeletePathIter(iter);
> - GdipDeletePath(path);
> - /* closed */
> - GdipClosePathFigure(path);
> - GdipCreatePathIter(&iter, path);
> - start = end = result = (INT)0xdeadbeef;
> -
> - /* Single PathPointTypeStart point */
> - GdipCreatePath(FillModeAlternate, &path);
> - point.X = 1.0;
> - point.Y = 2.0;
> - stat = GdipAddPathLine2(path, &point, 1);
> - expect(Ok, stat);
> - GdipStartPathFigure(path);

I don't believe this GdipStartPathFigure has any effect.

[Esme Povirk (＠madewokherd)]

This should probably include a test with a subpath containing multiple point types.