[PATCH v2 0/1] MR3313: gdiplus/tests: Fix mangled test output when dumping data in hex format.

[Jeffrey Smith (＠whydoubt)]

Some tests in gdiplus output hex-formatted data chunks, but it is very hard to read

EXAMPLE BEFORE FIX:
```
image.c:4831: Test marked todo: 16: data should match
image.c:4837:  40image.c:4837:  40image.c:4837:  40image.c:4837:  40image.c:4837:  40image.c:4837:  40image.c:4837:  80i
mage.c:4837:  80image.c:4837:  80image.c:4837:  80image.c:4837:  80image.c:4837:  80image.c:4837:  40image.c:4837:  40im
age.c:4837:  40image.c:4837:  40image.c:4837:  40image.c:4837:  40image.c:4837:  40image.c:4837:  40image.c:4837:  40ima
ge.c:4837:  40image.c:4837:  40image.c:4837:  40image.c:4838:
```

EXAMPLE AFTER FIX:
```
image.c:4802: Test marked todo: 16: data should match
image.c:4804:  40 40 40 40 40 40 80 80 80 80 80 80 40 40 40 40 40 40 40 40 40 40 40 40
```

--
  v2: gdiplus/tests: Fix mangled test output when dumping data in hex format.
 
https://gitlab.winehq.org/wine/wine/-/merge_requests/3313

[PATCH v2 1/1] gdiplus/tests: Fix mangled test output when dumping data in hex format.

[Jeff Smith]

From: Jeff Smith <whydoubt(a)gmail.com>

---
 dlls/gdiplus/tests/image.c | 103 ++++++++++---------------------------
 1 file changed, 27 insertions(+), 76 deletions(-)

diff --git a/dlls/gdiplus/tests/image.c b/dlls/gdiplus/tests/image.c
index e32b4c81240..97863db4278 100644
--- a/dlls/gdiplus/tests/image.c
+++ b/dlls/gdiplus/tests/image.c
@@ -112,6 +112,22 @@ static BOOL get_encoder_clsid(LPCWSTR mime, GUID *format, CLSID *clsid)
     return ret;
 }
 
+static const char * dbgstr_hexdata(const BYTE *data, UINT len)
+{
+    UINT i, offset = 0;
+    char buffer[1024] = {0};
+    const UINT max_len = 340;
+    const UINT output_len = (len <= max_len) ? len : max_len - 1;
+
+    for (i = 0; i < output_len; i++)
+        offset += sprintf(buffer + offset, " %02x", data[i]);
+
+    if (len > output_len)
+        offset += sprintf(buffer + offset, " ...");
+
+    return __wine_dbg_strdup( buffer );
+}
+
 static void test_bufferrawformat(void* buff, int size, REFGUID expected, int line, BOOL todo)
 {
     LPSTREAM stream;
@@ -4043,14 +4059,7 @@ static void test_tiff_properties(void)
             int match = memcmp(td[i].value, prop_item->value, td[i].length) == 0;
             ok(match || broken(td[i].length <= 4 && !match), "%u: data mismatch\n", i);
             if (!match)
-            {
-                UINT j;
-                BYTE *data = prop_item->value;
-                trace("id %#lx:", prop_item->id);
-                for (j = 0; j < prop_item->length; j++)
-                    trace(" %02x", data[j]);
-                trace("\n");
-            }
+                trace("id %#lx:%s\n", prop_item->id, dbgstr_hexdata(prop_item->value, prop_item->length));
         }
         HeapFree(GetProcessHeap(), 0, prop_item);
     }
@@ -4149,14 +4158,7 @@ static void test_GdipGetAllPropertyItems(void)
             int match = memcmp(td[i].value, prop_item->value, td[i].length) == 0;
             ok(match, "%u: data mismatch\n", i);
             if (!match)
-            {
-                UINT j;
-                BYTE *data = prop_item->value;
-                trace("id %#lx:", prop_item->id);
-                for (j = 0; j < prop_item->length; j++)
-                    trace(" %02x", data[j]);
-                trace("\n");
-            }
+                trace("id %#lx:%s\n", prop_item->id, dbgstr_hexdata(prop_item->value, prop_item->length));
         }
         HeapFree(GetProcessHeap(), 0, prop_item);
     }
@@ -4211,14 +4213,7 @@ static void test_GdipGetAllPropertyItems(void)
             int match = memcmp(td[i].value, prop_item[i].value, td[i].length) == 0;
             ok(match, "%u: data mismatch\n", i);
             if (!match)
-            {
-                UINT j;
-                BYTE *data = prop_item[i].value;
-                trace("id %#lx:", prop_item[i].id);
-                for (j = 0; j < prop_item[i].length; j++)
-                    trace(" %02x", data[j]);
-                trace("\n");
-            }
+                trace("id %#lx:%s\n", prop_item[i].id, dbgstr_hexdata(prop_item[i].value, prop_item[i].length));
         }
         item_data += prop_item[i].length;
     }
@@ -4444,13 +4439,8 @@ static void test_bitmapbits(void)
                 ok(match,
                    "%u: data should match\n", i);
                 if (!match)
-                {
-                    BYTE *bits = data.Scan0;
-                    trace("%u: data mismatch for format %#x:", i, td[i].format);
-                    for (j = 0; j < td[i].size; j++)
-                        trace(" %02x", bits[j]);
-                    trace("\n");
-                }
+                    trace("%u: data mismatch for format %#x:%s\n", i, td[i].format,
+                            dbgstr_hexdata(data.Scan0, td[i].size));
             }
             else
                 ok(!match, "%u: data shouldn't match\n", i);
@@ -4474,14 +4464,7 @@ static void test_bitmapbits(void)
             int match = memcmp(data.Scan0, td[i].pixels_unlocked, 48) == 0;
             ok(match, "%u: data should match\n", i);
             if (!match)
-            {
-                UINT j;
-                BYTE *bits = data.Scan0;
-                trace("%u: data mismatch for format %#x:", i, td[i].format);
-                for (j = 0; j < 48; j++)
-                    trace(" %02x", bits[j]);
-                trace("\n");
-            }
+                trace("%u: data mismatch for format %#x:%s\n", i, td[i].format, dbgstr_hexdata(data.Scan0, 48));
         }
 
         status = GdipBitmapUnlockBits(bitmap, &data);
@@ -4528,13 +4511,7 @@ static void test_DrawImage(void)
     match = memcmp(white_2x2, black_2x2, sizeof(black_2x2)) == 0;
     ok(match, "data should match\n");
     if (!match)
-    {
-        UINT i, size = sizeof(white_2x2);
-        BYTE *bits = white_2x2;
-        for (i = 0; i < size; i++)
-            trace(" %02x", bits[i]);
-        trace("\n");
-    }
+        trace("%s\n", dbgstr_hexdata(white_2x2, sizeof(white_2x2)));
 
     status = GdipDeleteGraphics(graphics);
     expect(Ok, status);
@@ -4624,13 +4601,7 @@ static void test_GdipDrawImagePointRect(void)
     match = memcmp(white_2x2, black_2x2, sizeof(black_2x2)) == 0;
     ok(match, "data should match\n");
     if (!match)
-    {
-        UINT i, size = sizeof(white_2x2);
-        BYTE *bits = white_2x2;
-        for (i = 0; i < size; i++)
-            trace(" %02x", bits[i]);
-        trace("\n");
-    }
+        trace("%s\n", dbgstr_hexdata(white_2x2, sizeof(white_2x2)));
 
     status = GdipDeleteGraphics(graphics);
     expect(Ok, status);
@@ -4830,13 +4801,7 @@ static void test_DrawImage_scale(void)
         todo_wine_if (!match && td[i].todo)
             ok(match, "%d: data should match\n", i);
         if (!match)
-        {
-            UINT i, size = sizeof(dst_8x1);
-            const BYTE *bits = dst_8x1;
-            for (i = 0; i < size; i++)
-                trace(" %02x", bits[i]);
-            trace("\n");
-        }
+            trace("%s\n", dbgstr_hexdata(dst_8x1, sizeof(dst_8x1)));
     }
 
     status = GdipDeleteGraphics(graphics);
@@ -4957,14 +4922,7 @@ static void test_gif_properties(void)
             int match = memcmp(td[i].value, prop_item->value, td[i].length) == 0;
             ok(match, "%u: data mismatch\n", i);
             if (!match)
-            {
-                UINT j;
-                BYTE *data = prop_item->value;
-                trace("id %#lx:", prop_item->id);
-                for (j = 0; j < prop_item->length; j++)
-                    trace(" %02x", data[j]);
-                trace("\n");
-            }
+                trace("id %#lx:%s\n", prop_item->id, dbgstr_hexdata(prop_item->value, prop_item->length));
         }
         HeapFree(GetProcessHeap(), 0, prop_item);
     }
@@ -5019,14 +4977,7 @@ static void test_gif_properties(void)
             int match = memcmp(td[i].value, prop_item[i].value, td[i].length) == 0;
             ok(match, "%u: data mismatch\n", i);
             if (!match)
-            {
-                UINT j;
-                BYTE *data = prop_item[i].value;
-                trace("id %#lx:", prop_item[i].id);
-                for (j = 0; j < prop_item[i].length; j++)
-                    trace(" %02x", data[j]);
-                trace("\n");
-            }
+                trace("id %#lx:%s\n", prop_item[i].id, dbgstr_hexdata(prop_item[i].value, prop_item[i].length));
         }
         item_data += prop_item[i].length;
     }
-- 
GitLab

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

[Esme Povirk (＠madewokherd)]

Esme Povirk (@madewokherd) commented about dlls/gdiplus/tests/image.c:
> return ret;
>  }
>
> +static const char * dbgstr_hexdata(const BYTE *data, UINT len)
> +{
> +    UINT i, offset = 0;
> +    char buffer[1024] = {0};
> +    const UINT max_len = 340;

The buffers for holding temporary debug strings and line output are each 1020 bytes in size, so I think the maximum output here needs to be smaller.

-- 
https://gitlab.winehq.org/wine/wine/-/merge_requests/3313#note_39084