[PATCH 0/2] MR10307: comctl32/tab: Use a clip region to protect the tab item background.

[Zhiyi Zhang (＠zhiyi)]

Use a clip region to protect the tab item background when drawing the text of an owner-draw tab
control. This partially reverts 0d173d01. Tests show that the top edge of the rcItem in DRAWITEMSTRUCT
shouldn't be added 2 pixels for a owner-draw tab, and the tab item background can't be overwritten
when painting the text, which suggests the presence of a clip region.

Fix the text position being off by 2 pixels for an application, which uses the rcItem in
DRAWITEMSTRUCT to calculate text position.

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

[PATCH 1/2] comctl32/tests: Add more tests for TCS_OWNERDRAWFIXED.

[Zhiyi Zhang]

From: Zhiyi Zhang <[e-mail]>

---
 dlls/comctl32/tests/tab.c | 29 +++++++++++++++++++++++++++++
 1 file changed, 29 insertions(+)

diff --git a/dlls/comctl32/tests/tab.c b/dlls/comctl32/tests/tab.c
index 34738b4d58c..aac2cde01a2 100644
--- a/dlls/comctl32/tests/tab.c
+++ b/dlls/comctl32/tests/tab.c
@@ -363,7 +363,12 @@ static LRESULT WINAPI parent_wnd_proc(HWND hwnd, UINT message, WPARAM wParam, LP
 
     /* dump sent structure data */
     if (message == WM_DRAWITEM)
+    {
+        HBRUSH brush = CreateSolidBrush(RGB(255, 0, 0));
         g_drawitem = *(DRAWITEMSTRUCT*)lParam;
+        FillRect(g_drawitem.hDC, &g_drawitem.rcItem, brush);
+        DeleteObject(brush);
+    }
 
     if (message == WM_NOTIFY)
     {
@@ -1385,8 +1390,10 @@ static void test_TCS_OWNERDRAWFIXED(void)
         BYTE lparam[sizeof(LPARAM)+1];
     } item;
     ULONG_PTR itemdata;
+    COLORREF color;
     HWND hTab;
     BOOL ret;
+    HDC hdc;
 
     hTab = createFilledTabControl(parent_wnd, TCS_FIXEDWIDTH|TCS_OWNERDRAWFIXED, TCIF_TEXT|TCIF_IMAGE, 4);
     ok(hTab != NULL, "Failed to create tab control\n");
@@ -1471,6 +1478,28 @@ static void test_TCS_OWNERDRAWFIXED(void)
        "got 0x%Ix, expected 0x%Ix\n", g_drawitem.itemData, itemdata);
 
     DestroyWindow(hTab);
+
+    /* Test that drawing the text of a TCS_OWNERDRAWFIXED tab shouldn't be able to overwrite the tab item background */
+    hTab = createFilledTabControl(parent_wnd, TCS_FIXEDWIDTH | TCS_OWNERDRAWFIXED | WS_VISIBLE, TCIF_TEXT | TCIF_IMAGE, 1);
+    ok(hTab != NULL, "Failed to create tab control.\n");
+
+    memset(&g_drawitem, 0, sizeof(g_drawitem));
+    RedrawWindow(hTab, NULL, 0, RDW_UPDATENOW);
+
+    /* Check the draw rect from WM_DRAWITEM */
+    todo_wine
+    ok(g_drawitem.rcItem.top == 0 && g_drawitem.rcItem.left == 0 && g_drawitem.rcItem.right > 0 &&
+       g_drawitem.rcItem.bottom > 0, "Got unexpected rect %s.\n", wine_dbgstr_rect(&g_drawitem.rcItem));
+    /* Check that tab item background is not overwritten */
+    hdc = GetDC(hTab);
+    color = GetPixel(hdc, 1, 1);
+    ok(color != RGB(255, 0, 0), "Got unexpected color %#lx.\n", color);
+    /* Check that text was drawn */
+    color = GetPixel(hdc, 2, 2);
+    ok(color == RGB(255, 0, 0), "Got unexpected color %#lx.\n", color);
+    ReleaseDC(hTab, hdc);
+
+    DestroyWindow(hTab);
 }
 
 static void test_WM_CONTEXTMENU(void)
-- 
GitLab


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

[PATCH 2/2] comctl32/tab: Use a clip region to protect the tab item background.

[Zhiyi Zhang]

From: Zhiyi Zhang <[e-mail]>

Use a clip region to protect the tab item background when drawing the text of an owner-draw tab
control. This partially reverts 0d173d01. Tests show that the top edge of the rcItem in DRAWITEMSTRUCT
shouldn't be added 2 pixels for a owner-draw tab, and the tab item background can't be overwritten
when painting the text, which suggests the presence of a clip region.

Fix the text position being off by 2 pixels for an application, which uses the rcItem in
DRAWITEMSTRUCT to calculate text position.
---
 dlls/comctl32/commctrl.c  | 20 ++++++++++++++++++++
 dlls/comctl32/tab.c       | 16 +++++++++++-----
 dlls/comctl32/tests/tab.c |  1 -
 dlls/comctl32_v6/button.c | 20 --------------------
 4 files changed, 31 insertions(+), 26 deletions(-)

diff --git a/dlls/comctl32/commctrl.c b/dlls/comctl32/commctrl.c
index e0724529fc4..3ddc3452fec 100644
--- a/dlls/comctl32/commctrl.c
+++ b/dlls/comctl32/commctrl.c
@@ -3199,3 +3199,23 @@ BOOL COMCTL32_IsThemed(HWND hwnd)
     return FALSE;
 #endif
 }
+
+HRGN set_control_clipping( HDC hdc, const RECT *rect )
+{
+    RECT rc = *rect;
+    HRGN hrgn = CreateRectRgn( 0, 0, 0, 0 );
+
+    if (GetClipRgn( hdc, hrgn ) != 1)
+    {
+        DeleteObject( hrgn );
+        hrgn = 0;
+    }
+    DPtoLP( hdc, (POINT *)&rc, 2 );
+    if (GetLayout( hdc ) & LAYOUT_RTL)  /* compensate for the shifting done by IntersectClipRect */
+    {
+        rc.left++;
+        rc.right++;
+    }
+    IntersectClipRect( hdc, rc.left, rc.top, rc.right, rc.bottom );
+    return hrgn;
+}
diff --git a/dlls/comctl32/tab.c b/dlls/comctl32/tab.c
index 3a964c41608..352c4bf861d 100644
--- a/dlls/comctl32/tab.c
+++ b/dlls/comctl32/tab.c
@@ -1705,13 +1705,10 @@ TAB_DrawItemInterior(const TAB_INFO *infoPtr, HDC hdc, INT iItem, RECT *drawRect
   if ((infoPtr->dwStyle & TCS_OWNERDRAWFIXED) && IsWindow(infoPtr->hwndNotify))
   {
     DRAWITEMSTRUCT dis;
+    RECT clipRect;
+    HRGN hrgn;
     UINT id;
 
-    drawRect->top += 2;
-    drawRect->right -= 1;
-    if ( iItem == infoPtr->iSelected )
-        InflateRect(drawRect, -1, 0);
-
     id = (UINT)GetWindowLongPtrW( infoPtr->hwnd, GWLP_ID );
 
     /* fill DRAWITEMSTRUCT */
@@ -1739,8 +1736,17 @@ TAB_DrawItemInterior(const TAB_INFO *infoPtr, HDC hdc, INT iItem, RECT *drawRect
         memcpy(&dis.itemData, (ULONG_PTR*)TAB_GetItem(infoPtr, iItem)->extra, 4);
     }
 
+    /* Avoid overwriting the background */
+    SetRect( &clipRect, drawRect->left, drawRect->top + 2, drawRect->right - 1, drawRect->bottom );
+    if ( iItem == infoPtr->iSelected )
+        InflateRect( &clipRect, -1, 0 );
+    hrgn = set_control_clipping( hdc, &clipRect );
+
     /* draw notification */
     SendMessageW( infoPtr->hwndNotify, WM_DRAWITEM, id, (LPARAM)&dis );
+
+    SelectClipRgn( hdc, hrgn );
+    if (hrgn) DeleteObject( hrgn );
   }
   else
   {
diff --git a/dlls/comctl32/tests/tab.c b/dlls/comctl32/tests/tab.c
index aac2cde01a2..642801b2e72 100644
--- a/dlls/comctl32/tests/tab.c
+++ b/dlls/comctl32/tests/tab.c
@@ -1487,7 +1487,6 @@ static void test_TCS_OWNERDRAWFIXED(void)
     RedrawWindow(hTab, NULL, 0, RDW_UPDATENOW);
 
     /* Check the draw rect from WM_DRAWITEM */
-    todo_wine
     ok(g_drawitem.rcItem.top == 0 && g_drawitem.rcItem.left == 0 && g_drawitem.rcItem.right > 0 &&
        g_drawitem.rcItem.bottom > 0, "Got unexpected rect %s.\n", wine_dbgstr_rect(&g_drawitem.rcItem));
     /* Check that tab item background is not overwritten */
diff --git a/dlls/comctl32_v6/button.c b/dlls/comctl32_v6/button.c
index 9128e523c20..ade2a9efdcc 100644
--- a/dlls/comctl32_v6/button.c
+++ b/dlls/comctl32_v6/button.c
@@ -309,26 +309,6 @@ static void init_custom_draw(NMCUSTOMDRAW *nmcd, const BUTTON_INFO *infoPtr, HDC
     /* FIXME: Handle it properly when we support keyboard cues? */
 }
 
-HRGN set_control_clipping( HDC hdc, const RECT *rect )
-{
-    RECT rc = *rect;
-    HRGN hrgn = CreateRectRgn( 0, 0, 0, 0 );
-
-    if (GetClipRgn( hdc, hrgn ) != 1)
-    {
-        DeleteObject( hrgn );
-        hrgn = 0;
-    }
-    DPtoLP( hdc, (POINT *)&rc, 2 );
-    if (GetLayout( hdc ) & LAYOUT_RTL)  /* compensate for the shifting done by IntersectClipRect */
-    {
-        rc.left++;
-        rc.right++;
-    }
-    IntersectClipRect( hdc, rc.left, rc.top, rc.right, rc.bottom );
-    return hrgn;
-}
-
 static WCHAR *heap_strndupW(const WCHAR *src, size_t length)
 {
     size_t size = (length + 1) * sizeof(WCHAR);
-- 
GitLab

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

[PATCH 0/2] MR10307: comctl32/tab: Use a clip region to protect the tab item background. - approved

[Nikolay Sivov (＠nsivov)]

This merge request was approved by Nikolay Sivov.
-- 
https://gitlab.winehq.org/wine/wine/-/merge_requests/10307