[PATCH v9 0/2] MR6218: comctl32/treeview: Allow treeview parent to deny treeview expansion.

[Jacob Czekalla (＠JacobCzekalla)]

When the listview expands or collapses an item it notifies the parent using the TVN_ITEMEXPANDING message. The parent can return true on this message and it prevents the treeview from expanding or collapsing the item. WINE does not let you deny TVN_ITEMEXPANDING by returning true.

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

--
  v9: comctl32/treeview: Allow treeview parent to deny treeview expansion.

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

[PATCH v9 1/2] comctl32/tests: Add test to check if treeview expansion can be denied.

[Jacob Czekalla]

From: Jacob Czekalla

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

diff --git a/dlls/comctl32/tests/treeview.c b/dlls/comctl32/tests/treeview.c
index db4cc4fda71..b0407f8d6a8 100644
--- a/dlls/comctl32/tests/treeview.c
+++ b/dlls/comctl32/tests/treeview.c
@@ -51,6 +51,7 @@ static const char *g_endedit_overwrite_contents;
 static char *g_endedit_overwrite_ptr;
 static HFONT g_customdraw_font;
 static BOOL g_v6;
+static int g_reject_tvn_itemexpanding = 0;

#define NUM_MSG_SEQUENCES   3
 #define TREEVIEW_SEQ_INDEX  0
@@ -1361,7 +1362,11 @@ static LRESULT CALLBACK parent_wnd_proc(HWND hWnd, UINT message, WPARAM wParam,
               }
             case TVN_ITEMEXPANDINGA:
               {
-                UINT newmask = pTreeView->itemNew.mask & ~TVIF_CHILDREN;
+                UINT newmask;
+
+                if (g_reject_tvn_itemexpanding)
+                    return TRUE;
+                newmask = pTreeView->itemNew.mask & ~TVIF_CHILDREN;
                 ok(newmask ==
                    (TVIF_HANDLE | TVIF_SELECTEDIMAGE | TVIF_IMAGE | TVIF_PARAM | TVIF_STATE),
                    "got wrong mask %x\n", pTreeView->itemNew.mask);
@@ -1837,6 +1842,7 @@ static void test_expandnotify(void)
     HWND hTree;
     BOOL ret;
     TVITEMA item;
+    RECT rc;

hTree = create_treeview_control(0);
     fill_tree(hTree);
@@ -1898,6 +1904,28 @@ static void test_expandnotify(void)

DestroyWindow(hTree);

+    /* check that expansion can be denied by parent */
+    hTree = create_treeview_control(0);
+    fill_tree(hTree);
+
+    g_reject_tvn_itemexpanding = 1;
+    memset(&item, 0, sizeof(item));
+    item.mask = TVIF_STATE;
+    item.hItem = hRoot;
+    *((HTREEITEM *)&rc) = item.hItem;
+
+    /* Simulate the double-click */
+    SendMessageA(hTree, TVM_GETITEMRECT, TRUE, (LPARAM)&rc);
+    SendMessageA(hTree, WM_LBUTTONDBLCLK, MK_LBUTTON, MAKELPARAM(rc.left + ((rc.right - rc.left) / 2), rc.top + ((rc.bottom - rc.top) / 2)));
+    g_reject_tvn_itemexpanding = 0;
+
+    /* check that it's expanded */
+    item.state = TVIS_EXPANDED;
+    ret = SendMessageA(hTree, TVM_GETITEMA, 0, (LPARAM)&item);
+    todo_wine ok(!(item.state & TVIS_EXPANDED), "expected no expansion\n");
+
+    DestroyWindow(hTree);
+
     /* test TVM_GETITEMRECT inside TVN_ITEMEXPANDED notification */
     hTree = create_treeview_control(0);
     fill_tree(hTree);

[PATCH v9 2/2] comctl32/treeview: Allow treeview parent to deny treeview expansion.

[Jacob Czekalla]

From: Jacob Czekalla

Wine-Bug: https://bugs.winehq.org/show_bug.cgi?id=53727
---
 dlls/comctl32/tests/treeview.c |  2 +-
 dlls/comctl32/treeview.c       | 23 ++++++++++++-----------
 2 files changed, 13 insertions(+), 12 deletions(-)

diff --git a/dlls/comctl32/tests/treeview.c b/dlls/comctl32/tests/treeview.c
index b0407f8d6a8..447069dfd17 100644
--- a/dlls/comctl32/tests/treeview.c
+++ b/dlls/comctl32/tests/treeview.c
@@ -1922,7 +1922,7 @@ static void test_expandnotify(void)
     /* check that it's expanded */
     item.state = TVIS_EXPANDED;
     ret = SendMessageA(hTree, TVM_GETITEMA, 0, (LPARAM)&item);
-    todo_wine ok(!(item.state & TVIS_EXPANDED), "expected no expansion\n");
+    ok(!(item.state & TVIS_EXPANDED), "expected no expansion\n");

DestroyWindow(hTree);

diff --git a/dlls/comctl32/treeview.c b/dlls/comctl32/treeview.c
index e2a4280f131..d2c695f2c7b 100644
--- a/dlls/comctl32/treeview.c
+++ b/dlls/comctl32/treeview.c
@@ -3348,10 +3348,10 @@ static BOOL
 TREEVIEW_SendExpanding(const TREEVIEW_INFO *infoPtr, TREEVIEW_ITEM *item,
    	       UINT action)
 {
-    return !TREEVIEW_SendTreeviewNotify(infoPtr, TVN_ITEMEXPANDINGW, action,
-					TVIF_HANDLE | TVIF_STATE | TVIF_PARAM
-					| TVIF_IMAGE | TVIF_SELECTEDIMAGE,
-					0, item);
+    return TREEVIEW_SendTreeviewNotify(infoPtr, TVN_ITEMEXPANDINGW, action,
+                                       TVIF_HANDLE | TVIF_STATE | TVIF_PARAM
+                                       | TVIF_IMAGE | TVIF_SELECTEDIMAGE,
+                                       0, item);
 }

static VOID
@@ -3383,8 +3383,8 @@ TREEVIEW_Collapse(TREEVIEW_INFO *infoPtr, TREEVIEW_ITEM *item,
     if (!TREEVIEW_HasChildren(infoPtr, item))
    return FALSE;

-    if (bUser)
-	TREEVIEW_SendExpanding(infoPtr, item, action);
+    if (bUser && TREEVIEW_SendExpanding(infoPtr, item, action))
+        return TRUE;

if (item->firstChild == NULL)
    return FALSE;
@@ -3513,12 +3513,13 @@ TREEVIEW_Expand(TREEVIEW_INFO *infoPtr, TREEVIEW_ITEM *item,
                                     !(item->state & TVIS_EXPANDEDONCE));
     if (sendsNotifications)
     {
-	if (!TREEVIEW_SendExpanding(infoPtr, item, TVE_EXPAND))
-	{
-	    TRACE("  TVN_ITEMEXPANDING returned TRUE, exiting...\n");
-	    return FALSE;
-	}
+        if (TREEVIEW_SendExpanding(infoPtr, item, TVE_EXPAND))
+        {
+            TRACE("  TVN_ITEMEXPANDING returned TRUE, exiting...\n");
+            return TRUE;
+        }
     }
+
     if (!item->firstChild)
         return FALSE;

[PATCH v9 2/2] comctl32/treeview: Allow treeview parent to deny treeview expansion.

[Marvin]

Hi,

It looks like your patch introduced the new failures shown below.
Please investigate and fix them before resubmitting your patch.
If they are not new, fixing them anyway would help a lot. Otherwise
please ask for the known failures list to be updated.

The tests also ran into some preexisting test failures. If you know how
to fix them that would be helpful. See the TestBot job for the details:

The full results can be found at:
https://testbot.winehq.org/JobDetails.pl?Key=147715

Your paranoid android.

=== debian11b (64 bit WoW report) ===

ddraw:
ddraw2.c:3735: Test failed: Expected screen size 1024x768, got 0x0.

kernel32:
comm.c:1586: Test failed: Unexpected time 1001, expected around 500

[Zhiyi Zhang (＠zhiyi)]

Zhiyi Zhang (@zhiyi) commented about dlls/comctl32/tests/treeview.c:
>  DestroyWindow(hTree);
>
> - /* check that expansion can be denied by parent */
> - hTree = create_treeview_control(0);
> - fill_tree(hTree);
> -
> - g_reject_tvn_itemexpanding = 1;
> - memset(&item, 0, sizeof(item));
> - item.mask = TVIF_STATE;
> - item.hItem = hRoot;
> - *((HTREEITEM *)&rc) = item.hItem;
> -
> - /* Simulate the double-click */

I think using the TVM_EXPAND message to expand or collapse the item is more reliable than sending a click. Also, please test that TVN_ITEMEXPANDINGA returning TRUE can also prevent the item from collapsing.