[PATCH v6 0/3] MR8258: comctl32/treeview: Return from TREEVIEW_LButtonDown when the treeview handle is invalid.

[Jacob Czekalla (＠JacobCzekalla)]

comctl32/treeview: Return from TREEVIEW_LButtonDown when the treeview handle is invalid.

LButtonDown should return when the treeview handle is invalid (e.g. destroyed) after NM_CLICK to prevent further message processing.

Wine-Bug: https://bugs.winehq.org/show_bug.cgi?id=58211

--
  v6: comctl32/treeview: Return from TREEVIEW_LButtonDown when the treeview handle is invalid.
      comctl32/treeview: Add a function for sending notifications that also checks for invalid treeview.
      comctl32/tests: Add a test for treeview deletion during NM_CLICK in LBUTTONDOWN.

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

[PATCH v6 1/3] comctl32/tests: Add a test for treeview deletion during NM_CLICK in LBUTTONDOWN.

[Jacob Czekalla]

From: Jacob Czekalla

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

diff --git a/dlls/comctl32/tests/treeview.c b/dlls/comctl32/tests/treeview.c
index 5b53a32f51b..1b743a0a23c 100644
--- a/dlls/comctl32/tests/treeview.c
+++ b/dlls/comctl32/tests/treeview.c
@@ -52,6 +52,7 @@ static char *g_endedit_overwrite_ptr;
 static HFONT g_customdraw_font;
 static BOOL g_v6;
 static int g_reject_tvn_itemexpanding = 0;
+static int g_click_delete_test = 0;

#define NUM_MSG_SEQUENCES   3
 #define TREEVIEW_SEQ_INDEX  0
@@ -243,6 +244,20 @@ static const struct message test_right_click_seq[] = {
     { 0 }
 };

+static const struct message test_click_delete_seq[] = {
+    { WM_LBUTTONDOWN, sent|wparam, MK_LBUTTON },
+    { WM_CAPTURECHANGED, sent|defwinproc },
+    { 0x90, sent|defwinproc|optional },
+    { WM_SHOWWINDOW, sent|defwinproc|wparam|lparam,  0, 0 },
+    { WM_WINDOWPOSCHANGING, sent|defwinproc },
+    { WM_WINDOWPOSCHANGED, sent|defwinproc },
+    { WM_KILLFOCUS, sent|defwinproc },
+    { WM_IME_SETCONTEXT, sent|defwinproc|wparam, 0 },
+    { WM_DESTROY, sent|defwinproc },
+    { WM_NCDESTROY, sent|defwinproc },
+    { 0 }
+};
+
 static const struct message parent_expand_seq[] = {
     { WM_NOTIFY, sent|id, 0, 0, TVN_ITEMEXPANDINGA },
     { WM_NOTIFY, sent|id, 0, 0, TVN_ITEMEXPANDEDA },
@@ -1478,6 +1493,15 @@ static LRESULT CALLBACK parent_wnd_proc(HWND hWnd, UINT message, WPARAM wParam,
                 ok(selected == hChild, "child item should still be selected\n");
                 break;
             }
+            case NM_CLICK:
+            {
+                if (g_click_delete_test)
+                {
+                    DestroyWindow(pHdr->hwndFrom);
+                    return FALSE;
+                }
+                break;
+            }
             }
         }
         break;
@@ -3123,6 +3147,53 @@ static void test_right_click(void)
     DestroyWindow(hTree);
 }

+static void test_treeview_delete_midclick(void)
+{
+    HWND treeview;
+    RECT rc;
+    POINT pt, orig_pos;
+    MSG msg;
+
+    g_click_delete_test = 1;
+    treeview = create_treeview_control(0);
+    fill_tree(treeview);
+    ShowWindow(hMainWnd, SW_SHOW);
+    UpdateWindow(hMainWnd);
+
+    *(HTREEITEM *)&rc = hRoot;
+    SendMessageA(treeview, TVM_GETITEMRECT, TRUE, (LPARAM)&rc);
+
+    pt.x = (rc.left + rc.right) / 2;
+    pt.y = (rc.top + rc.bottom) / 2;
+    ClientToScreen(hMainWnd, &pt);
+    GetCursorPos(&orig_pos);
+    SetCursorPos(pt.x, pt.y);
+    ScreenToClient(treeview, &pt);
+
+    flush_events();
+    flush_sequences(sequences, NUM_MSG_SEQUENCES);
+
+    PostMessageA(treeview, WM_LBUTTONDOWN, MK_LBUTTON, MAKELPARAM(pt.x, pt.y));
+    PostMessageA(treeview, WM_LBUTTONUP, 0, MAKELPARAM(pt.x, pt.y));
+    while (GetMessageA(&msg, 0, 0, 0))
+    {
+        TranslateMessage(&msg);
+        DispatchMessageA(&msg);
+        if((msg.hwnd == treeview) && (msg.message == WM_LBUTTONDOWN))
+            break;
+    }
+
+    flush_events();
+    ok_sequence(sequences, TREEVIEW_SEQ_INDEX, test_click_delete_seq, "treeview click and destroy sequence", TRUE);
+
+    flush_sequences(sequences, NUM_MSG_SEQUENCES);
+    SetCursorPos(orig_pos.x, orig_pos.y);
+    g_click_delete_test = 0;
+
+    if (!IsWindow(treeview))
+        DestroyWindow(treeview);
+}
+
 static void init_functions(void)
 {
     HMODULE hComCtl32 = LoadLibraryA("comctl32.dll");
@@ -3206,6 +3277,7 @@ START_TEST(treeview)
     test_TVS_FULLROWSELECT();
     test_TVM_SORTCHILDREN();
     test_right_click();
+    test_treeview_delete_midclick();

if (!load_v6_module(&ctx_cookie, &hCtx))
     {

[PATCH v6 2/3] comctl32/treeview: Add a function for sending notifications that also checks for invalid treeview.

[Jacob Czekalla]

From: Jacob Czekalla

Some functions will need to check if the treeview is still valid after sending a notification to prevent further processing.
---
 dlls/comctl32/treeview.c | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/dlls/comctl32/treeview.c b/dlls/comctl32/treeview.c
index 073f62c66a2..7a427836f2f 100644
--- a/dlls/comctl32/treeview.c
+++ b/dlls/comctl32/treeview.c
@@ -522,6 +522,18 @@ TREEVIEW_SendRealNotify(const TREEVIEW_INFO *infoPtr, UINT code, NMHDR *hdr)
     return SendMessageW(infoPtr->hwndNotify, WM_NOTIFY, hdr->idFrom, (LPARAM)hdr);
 }

+static INT
+TREEVIEW_SendSafeNotify(const TREEVIEW_INFO *infoPtr, UINT code)
+{
+    NMHDR hdr;
+    INT ret = TREEVIEW_SendRealNotify(infoPtr, code, &hdr);
+    if (ret != 0)
+        ret = 1;
+    if (!IsWindow(infoPtr->hwnd))
+        ret = -1;
+    return ret;
+}
+
 static BOOL
 TREEVIEW_SendSimpleNotify(const TREEVIEW_INFO *infoPtr, UINT code)
 {

[PATCH v6 3/3] comctl32/treeview: Return from TREEVIEW_LButtonDown when the treeview handle is invalid.

[Jacob Czekalla]

From: Jacob Czekalla

LButtonDown should return when the treeview handle is invalid (e.g. destroyed) after NM_CLICK to prevent further message processing.

Wine-Bug: https://bugs.winehq.org/show_bug.cgi?id=58211
---
 dlls/comctl32/tests/treeview.c |  2 +-
 dlls/comctl32/treeview.c       | 21 +++++++++++++++++----
 2 files changed, 18 insertions(+), 5 deletions(-)

diff --git a/dlls/comctl32/tests/treeview.c b/dlls/comctl32/tests/treeview.c
index 1b743a0a23c..d7591b568e9 100644
--- a/dlls/comctl32/tests/treeview.c
+++ b/dlls/comctl32/tests/treeview.c
@@ -3184,7 +3184,7 @@ static void test_treeview_delete_midclick(void)
     }

flush_events();
-    ok_sequence(sequences, TREEVIEW_SEQ_INDEX, test_click_delete_seq, "treeview click and destroy sequence", TRUE);
+    ok_sequence(sequences, TREEVIEW_SEQ_INDEX, test_click_delete_seq, "treeview click and destroy sequence", FALSE);

flush_sequences(sequences, NUM_MSG_SEQUENCES);
     SetCursorPos(orig_pos.x, orig_pos.y);
diff --git a/dlls/comctl32/treeview.c b/dlls/comctl32/treeview.c
index 7a427836f2f..11395c97046 100644
--- a/dlls/comctl32/treeview.c
+++ b/dlls/comctl32/treeview.c
@@ -4273,6 +4273,7 @@ TREEVIEW_LButtonDown(TREEVIEW_INFO *infoPtr, LPARAM lParam)
     BOOL do_track, do_select, bDoLabelEdit;
     HWND hwnd = infoPtr->hwnd;
     TVHITTESTINFO ht;
+    INT res;

/* If Edit control is active - kill it and return.
      * The best way to do it is to set focus to itself.
@@ -4327,8 +4328,14 @@ TREEVIEW_LButtonDown(TREEVIEW_INFO *infoPtr, LPARAM lParam)
         (ht.flags & TVHT_ONITEMLABEL) && (infoPtr->selectedItem == ht.hItem);

/* Send NM_CLICK right away */
-    if (!do_track && TREEVIEW_SendSimpleNotify(infoPtr, NM_CLICK))
-        goto setfocus;
+    if (!do_track)
+    {
+        res = TREEVIEW_SendSafeNotify(infoPtr, NM_CLICK);
+        if (res == -1)
+            return 0;
+        if (res)
+            goto setfocus;
+    }

if (ht.flags & TVHT_ONITEMBUTTON)
     {
@@ -4357,8 +4364,14 @@ TREEVIEW_LButtonDown(TREEVIEW_INFO *infoPtr, LPARAM lParam)
         }
     }

-    if (do_track && TREEVIEW_SendSimpleNotify(infoPtr, NM_CLICK))
-        goto setfocus;
+    if (do_track)
+    {
+        res = TREEVIEW_SendSafeNotify(infoPtr, NM_CLICK);
+        if (res == -1)
+            return 0;
+        if (res)
+            goto setfocus;
+    }

if (TREEVIEW_IsFullRowSelect(infoPtr))
         do_select = ht.flags & (TVHT_ONITEMINDENT | TVHT_ONITEMICON | TVHT_ONITEMLABEL | TVHT_ONITEMRIGHT);