[PATCH 0/2] MR10452: Comctl32/test print WM_NOTIFY codes on failure

[Piotr Pawłowski (＠DEATH)]

Makes debugging of WM_NOTIFY message sequence errors much easier.

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

[PATCH 1/2] comctl32/tests: Enabled test_select() for comctl32 v6, made test for TVN_ITEMCHANGING

[Piotr Pawłowski]

From: Piotr Pawłowski <[e-mail]>

---
 dlls/comctl32/tests/treeview.c | 173 ++++++++++++++++++++++++++++++---
 1 file changed, 162 insertions(+), 11 deletions(-)

diff --git a/dlls/comctl32/tests/treeview.c b/dlls/comctl32/tests/treeview.c
index 997efa01a9d..da8568af94c 100644
--- a/dlls/comctl32/tests/treeview.c
+++ b/dlls/comctl32/tests/treeview.c
@@ -58,6 +58,7 @@ static HFONT g_customdraw_font;
 static BOOL g_v6;
 static int g_reject_tvn_itemexpanding = 0;
 static int g_click_delete_test = 0;
+static BOOL g_skip_paint_messages = FALSE;
 
 #define NUM_MSG_SEQUENCES   3
 #define TREEVIEW_SEQ_INDEX  0
@@ -104,6 +105,76 @@ static const struct message rootnone_select_seq[] = {
     { 0 }
 };
 
+/*
+ * TVN_ITEMCHANGINGW and TVN_ITEMCHANGEDW intended!
+ * Verified against Windows versions from 7 up.
+ */
+static const struct message parent_rootnone_select_seq_v6[] = {
+    { WM_NOTIFY, sent|id, 0, 0, TVN_SELCHANGINGA },
+    { WM_NOTIFY, sent|id, 0, 0, TVN_ITEMCHANGINGW },
+    { WM_NOTIFY, sent|id, 0, 0, TVN_ITEMCHANGEDW },
+    { WM_NOTIFY, sent|id, 0, 0, TVN_SELCHANGEDA },
+    { WM_NOTIFY, sent|id, 0, 0, TVN_SELCHANGINGA },
+    { WM_NOTIFY, sent|id, 0, 0, TVN_ITEMCHANGINGW },
+    { WM_NOTIFY, sent|id, 0, 0, TVN_ITEMCHANGEDW },
+    { WM_NOTIFY, sent|id, 0, 0, TVN_SELCHANGEDA },
+    { WM_NOTIFY, sent|id, 0, 0, TVN_SELCHANGINGA },
+    { WM_NOTIFY, sent|id, 0, 0, TVN_ITEMCHANGINGW },
+    { WM_NOTIFY, sent|id, 0, 0, TVN_ITEMCHANGEDW },
+    { WM_NOTIFY, sent|id, 0, 0, TVN_SELCHANGEDA },
+    { 0 }
+};
+
+static const struct message parent_rootnone_select_seq[] = {
+    { WM_NOTIFY, sent|id, 0, 0, TVN_SELCHANGINGA },
+    { WM_NOTIFY, sent|id, 0, 0, TVN_SELCHANGEDA },
+    { WM_NOTIFY, sent|id, 0, 0, TVN_SELCHANGINGA },
+    { WM_NOTIFY, sent|id, 0, 0, TVN_SELCHANGEDA },
+    { WM_NOTIFY, sent|id, 0, 0, TVN_SELCHANGINGA },
+    { WM_NOTIFY, sent|id, 0, 0, TVN_SELCHANGEDA },
+    { 0 }
+};
+
+static const struct message parent_rootchild_select_seq_v6[] = {
+    { WM_NOTIFY, sent|id, 0, 0, TVN_SELCHANGINGA },
+    { WM_NOTIFY, sent|id, 0, 0, TVN_ITEMCHANGINGW },
+    { WM_NOTIFY, sent|id, 0, 0, TVN_ITEMCHANGEDW },
+    { WM_NOTIFY, sent|id, 0, 0, TVN_SELCHANGEDA },
+    { WM_NOTIFY, sent|id, 0, 0, TVN_SELCHANGINGA },
+    { WM_NOTIFY, sent|id, 0, 0, TVN_ITEMCHANGINGW },
+    { WM_NOTIFY, sent|id, 0, 0, TVN_ITEMCHANGEDW },
+    { WM_NOTIFY, sent|id, 0, 0, TVN_SELCHANGEDA },
+    { WM_NOTIFY, sent|id, 0, 0, TVN_SELCHANGINGA },
+    { WM_NOTIFY, sent|id, 0, 0, TVN_ITEMCHANGINGW },
+    { WM_NOTIFY, sent|id, 0, 0, TVN_ITEMCHANGEDW },
+    { WM_NOTIFY, sent|id, 0, 0, TVN_ITEMCHANGINGW },
+    { WM_NOTIFY, sent|id, 0, 0, TVN_ITEMCHANGEDW },
+    { WM_NOTIFY, sent|id, 0, 0, TVN_ITEMEXPANDINGA },
+    { WM_NOTIFY, sent|id, 0, 0, TVN_ITEMEXPANDEDA },
+    { WM_NOTIFY, sent|id, 0, 0, TVN_SELCHANGEDA },
+    { WM_NOTIFY, sent|id, 0, 0, TVN_SELCHANGINGA },
+    { WM_NOTIFY, sent|id, 0, 0, TVN_ITEMCHANGINGW },
+    { WM_NOTIFY, sent|id, 0, 0, TVN_ITEMCHANGEDW },
+    { WM_NOTIFY, sent|id, 0, 0, TVN_ITEMCHANGINGW },
+    { WM_NOTIFY, sent|id, 0, 0, TVN_ITEMCHANGEDW },
+    { WM_NOTIFY, sent|id, 0, 0, TVN_SELCHANGEDA },
+    { 0 }
+};
+
+static const struct message parent_rootchild_select_seq[] = {
+    { WM_NOTIFY, sent|id, 0, 0, TVN_SELCHANGINGA },
+    { WM_NOTIFY, sent|id, 0, 0, TVN_SELCHANGEDA },
+    { WM_NOTIFY, sent|id, 0, 0, TVN_SELCHANGINGA },
+    { WM_NOTIFY, sent|id, 0, 0, TVN_SELCHANGEDA },
+    { WM_NOTIFY, sent|id, 0, 0, TVN_SELCHANGINGA },
+    { WM_NOTIFY, sent|id, 0, 0, TVN_ITEMEXPANDINGA },
+    { WM_NOTIFY, sent|id, 0, 0, TVN_ITEMEXPANDEDA },
+    { WM_NOTIFY, sent|id, 0, 0, TVN_SELCHANGEDA },
+    { WM_NOTIFY, sent|id, 0, 0, TVN_SELCHANGINGA },
+    { WM_NOTIFY, sent|id, 0, 0, TVN_SELCHANGEDA },
+    { 0 }
+};
+
 static const struct message rootchild_select_seq[] = {
     { TVM_SELECTITEM, sent|wparam, 9 },
     { TVM_SELECTITEM, sent|wparam, 9 },
@@ -425,7 +496,7 @@ static const struct message parent_right_click_seq[] = {
 
 static HWND hMainWnd;
 
-static HTREEITEM hRoot, hChild;
+static HTREEITEM hRoot, hChild, hBlockChange;
 
 static int pos = 0;
 static char sequence[256];
@@ -459,20 +530,29 @@ static void IdentifyItem(HTREEITEM hItem)
     AddItem('?');
 }
 
+static BOOL IsPaintMessage(UINT message)
+{
+    return message == WM_PAINT || message == WM_NCPAINT || message == WM_ERASEBKGND;
+}
+
 /* This function hooks in and records all messages to the treeview control */
 static LRESULT WINAPI TreeviewWndProc(HWND hwnd, UINT message, WPARAM wParam, LPARAM lParam)
 {
     static LONG defwndproc_counter = 0;
     LRESULT ret;
     WNDPROC lpOldProc = (WNDPROC)GetWindowLongPtrA(hwnd, GWLP_USERDATA);
-    struct message msg = { 0 };
 
-    msg.message = message;
-    msg.flags = sent|wparam|lparam;
-    if (defwndproc_counter) msg.flags |= defwinproc;
-    msg.wParam = wParam;
-    msg.lParam = lParam;
-    add_message(sequences, TREEVIEW_SEQ_INDEX, &msg);
+    if (!(g_skip_paint_messages && IsPaintMessage(message)))
+    {
+        struct message msg = { 0 };
+
+        msg.message = message;
+        msg.flags = sent|wparam|lparam;
+        if (defwndproc_counter) msg.flags |= defwinproc;
+        msg.wParam = wParam;
+        msg.lParam = lParam;
+        add_message(sequences, TREEVIEW_SEQ_INDEX, &msg);
+    }
 
     defwndproc_counter++;
     ret = CallWindowProcA(lpOldProc, hwnd, message, wParam, lParam);
@@ -688,6 +768,9 @@ static void test_select(void)
     BOOL r;
     HWND hTree;
 
+    /* suppress logging of painting related messages in this test */
+    g_skip_paint_messages = TRUE;
+
     hTree = create_treeview_control(0);
     fill_tree(hTree);
 
@@ -713,8 +796,17 @@ static void test_select(void)
     expect(TRUE, r);
     AddItem('.');
     ok(!strcmp(sequence, "1(nR)nR23(Rn)Rn45(nR)nR."), "root-none select test\n");
-    ok_sequence(sequences, TREEVIEW_SEQ_INDEX, rootnone_select_seq,
-                "root-none select seq", FALSE);
+
+    ok_sequence(sequences, TREEVIEW_SEQ_INDEX, rootnone_select_seq, "root-none select seq", FALSE);
+
+    if (g_v6)
+    {
+        ok_sequence(sequences, PARENT_SEQ_INDEX, parent_rootnone_select_seq_v6, "root-none parent select seq v6", TRUE);
+    }
+    else
+    {
+        ok_sequence(sequences, PARENT_SEQ_INDEX, parent_rootnone_select_seq, "root-none parent select seq", FALSE);
+    }
 
     /* root-child select tests */
     flush_sequences(sequences, NUM_MSG_SEQUENCES);
@@ -742,7 +834,42 @@ static void test_select(void)
     ok_sequence(sequences, TREEVIEW_SEQ_INDEX, rootchild_select_seq,
                 "root-child select seq", FALSE);
 
+    if (g_v6)
+    {
+        ok_sequence(sequences, PARENT_SEQ_INDEX, parent_rootchild_select_seq_v6, "root-child parent select seq v6", TRUE);
+    }
+    else
+    {
+        ok_sequence(sequences, PARENT_SEQ_INDEX, parent_rootchild_select_seq, "root-child parent select seq", FALSE);
+    }
+
+    if (g_v6)
+    {
+        /* TVN_ITEMCHANGING logic only in v6 */
+        r = SendMessageA(hTree, TVM_SELECTITEM, TVGN_CARET, (LPARAM)hRoot);
+        expect(TRUE, r);
+        r = SendMessageA(hTree, TVM_GETITEMSTATE, (WPARAM)hRoot, TVIS_SELECTED) & TVIS_SELECTED;
+        expect(TVIS_SELECTED, r);
+        hBlockChange = hChild;
+        r = SendMessageA(hTree, TVM_SELECTITEM, TVGN_CARET, (LPARAM)hChild);
+        expect(TRUE, r);
+        r = SendMessageA(hTree, TVM_GETITEMSTATE, (WPARAM)hChild, TVIS_SELECTED) & TVIS_SELECTED;
+        todo_wine expect(0, r);
+        r = SendMessageA(hTree, TVM_GETITEMSTATE, (WPARAM)hRoot, TVIS_SELECTED) & TVIS_SELECTED;
+        expect(0, r);
+        hBlockChange = NULL;
+        r = SendMessageA(hTree, TVM_SELECTITEM, TVGN_CARET, (LPARAM)hChild);
+        expect(TRUE, r);
+        r = SendMessageA(hTree, TVM_GETITEMSTATE, (WPARAM)hChild, TVIS_SELECTED) & TVIS_SELECTED;
+        todo_wine expect(0, r);
+        r = SendMessageA(hTree, TVM_GETITEMSTATE, (WPARAM)hRoot, TVIS_SELECTED) & TVIS_SELECTED;
+        expect(0, r);
+    }
+    
+    
     DestroyWindow(hTree);
+
+    g_skip_paint_messages = FALSE;
 }
 
 static void test_getitemtext(void)
@@ -1271,6 +1398,16 @@ static void test_get_set_unicodeformat(void)
     DestroyWindow(hTree);
 }
 
+static BOOL IsParentPaintMessage(UINT message, WPARAM wParam, LPARAM lParam)
+{
+    if (message >= WM_CTLCOLORMSGBOX && message <= WM_CTLCOLORSTATIC) return TRUE;
+    else if (message == WM_NOTIFY)
+    {
+        return ((LPNMHDR)lParam)->code == NM_CUSTOMDRAW;
+    }
+    else return FALSE;
+}
+
 static LRESULT CALLBACK parent_wnd_proc(HWND hWnd, UINT message, WPARAM wParam, LPARAM lParam)
 {
     static LONG defwndproc_counter = 0;
@@ -1295,7 +1432,9 @@ static LRESULT CALLBACK parent_wnd_proc(HWND hWnd, UINT message, WPARAM wParam,
         message != WM_NCHITTEST &&
         message != WM_GETTEXT &&
         message != WM_GETICON &&
-        message != WM_DEVICECHANGE)
+        message != WM_DEVICECHANGE &&
+        !(g_skip_paint_messages && IsParentPaintMessage(message, wParam, lParam))
+    )
     {
         add_message(sequences, PARENT_SEQ_INDEX, &msg);
     }
@@ -1318,6 +1457,17 @@ static LRESULT CALLBACK parent_wnd_proc(HWND hWnd, UINT message, WPARAM wParam,
             NMTREEVIEWA *pTreeView = (LPNMTREEVIEWA) lParam;
             switch(pHdr->code)
             {
+                /*
+                 * TVN_ITEMCHANGINGW (not TVN_ITEMCHANGINGA) intended.
+                 * MS implementation appears to send TVN_ITEMCHANGINGW only.
+                 * Available only in comctl32 v6.
+                 */
+            case TVN_ITEMCHANGINGW:
+                {
+                    NMTVITEMCHANGE * pChange = (NMTVITEMCHANGE*) lParam;
+                    if (pChange->hItem == hBlockChange) return TRUE;
+                }
+                break;
             case TVN_SELCHANGINGA:
                 AddItem('(');
                 IdentifyItem(pTreeView->itemOld.hItem);
@@ -3422,6 +3572,7 @@ START_TEST(treeview)
     g_v6 = TRUE;
 
     test_fillroot();
+    test_select();
     test_getitemtext();
     test_get_set_insertmark();
     test_get_set_item();
-- 
GitLab


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

[PATCH 2/2] comctl32/tests: Print WM_NOTIFY codes of logged/expected events on failure

[Piotr Pawłowski]

From: Piotr Pawłowski <[e-mail]>

---
 dlls/comctl32/tests/msg.h | 9 +++++----
 1 file changed, 5 insertions(+), 4 deletions(-)

diff --git a/dlls/comctl32/tests/msg.h b/dlls/comctl32/tests/msg.h
index 76bf5450b2f..8eb319f4889 100644
--- a/dlls/comctl32/tests/msg.h
+++ b/dlls/comctl32/tests/msg.h
@@ -115,8 +115,9 @@ static void dump_sequence( struct msg_sequence **seq, int sequence_index,
     trace_(file, line)("Failed sequence %s:\n", context );
     while (expected->message && actual->message)
     {
-        trace_(file, line)( "  %u: expected: %04x - actual: %04x wp %08Ix lp %08Ix\n",
-                            count, expected->message, actual->message, actual->wParam, actual->lParam );
+        trace_(file, line)( "  %u: expected: %04x id %i - actual: %04x wp %08Ix lp %08Ix id %i\n",
+                            count, expected->message, (int)expected->id, actual->message, actual->wParam, actual->lParam, (int)actual->id );
+
 
 	if (expected->message == actual->message)
 	{
@@ -157,8 +158,8 @@ static void dump_sequence( struct msg_sequence **seq, int sequence_index,
 
     while (actual->message)
     {
-        trace_(file, line)( "  %u: expected: nothing - actual: %04x wp %08Ix lp %08Ix\n",
-                            count, actual->message, actual->wParam, actual->lParam );
+        trace_(file, line)( "  %u: expected: nothing - actual: %04x wp %08Ix lp %08Ix id %i\n",
+                            count, actual->message, actual->wParam, actual->lParam, (int)actual->id );
         actual++;
         count++;
     }
-- 
GitLab

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