Changeset 95833 in vbox for trunk/src/VBox

Timestamp:

Jul 26, 2022 1:53:35 PM (2 years ago)

Author:

vboxsync

Message:

DnD/VBoxTray: Introduced a new and much easier way of debugging drag'n drop issues (also in release mode!) by letting VBoxTray output the current drag'n drop status (along with format information and actions) via systray popups. This allows users to pinpoint issues much easier, without having to install a separate debug build. Disabled by default -- verbose mode needs to be active for this. bugref:10267

File:

• trunk/src/VBox/Additions/WINNT/VBoxTray/VBoxDnD.cpp (modified) (12 diffs)

trunk/src/VBox/Additions/WINNT/VBoxTray/VBoxDnD.cpp

@@ -49 +49 @@
 *   Defined Constants And Macros                                                                                                 *
 *********************************************************************************************************************************/
-/* Enable this define to see the proxy window(s) when debugging
- * their behavior. Don't have this enabled in release builds! */
-#ifdef DEBUG
-//# define VBOX_DND_DEBUG_WND
-#endif
-
 /** The drag and drop window's window class. */
 #define VBOX_DND_WND_CLASS            "VBoxTrayDnDWnd"
@@ -228 +222 @@
         wc.hInstance     = hInstance;
         wc.style         = CS_NOCLOSE;
-#ifdef VBOX_DND_DEBUG_WND
-        wc.style        |= CS_HREDRAW | CS_VREDRAW;
-        wc.hbrBackground = (HBRUSH)(CreateSolidBrush(RGB(255, 0, 0)));
-#else
-        wc.hbrBackground = (HBRUSH)(COLOR_BACKGROUND + 1);
-#endif
+
+        if (g_cVerbosity)
+        {
+            /* Make it a solid red color so that we can see the window. */
+            wc.style        |= CS_HREDRAW | CS_VREDRAW;
+            wc.hbrBackground = (HBRUSH)(CreateSolidBrush(RGB(255, 0, 0)));
+        }
+        else
+            wc.hbrBackground = (HBRUSH)(COLOR_BACKGROUND + 1);
+
         if (!RegisterClassEx(&wc))
         {
@@ -244 +242 @@
     if (RT_SUCCESS(rc))
     {
-        DWORD dwExStyle = WS_EX_TOOLWINDOW | WS_EX_TRANSPARENT | WS_EX_NOACTIVATE;
-        DWORD dwStyle = WS_POPUP;
-#ifdef VBOX_DND_DEBUG_WND
-        dwExStyle &= ~WS_EX_TRANSPARENT; /* Remove transparency bit. */
-        dwStyle |= WS_VISIBLE; /* Make the window visible. */
-#endif
+        DWORD dwExStyle = WS_EX_TOOLWINDOW | WS_EX_NOACTIVATE;
+        DWORD dwStyle   = WS_POPUP;
+        if (g_cVerbosity)
+        {
+            dwStyle |= WS_VISIBLE;
+        }
+        else
+            dwExStyle |= WS_EX_TRANSPARENT;
+
         pThis->m_hWnd = CreateWindowEx(dwExStyle,
-                                     VBOX_DND_WND_CLASS, VBOX_DND_WND_CLASS,
-                                     dwStyle,
-#ifdef VBOX_DND_DEBUG_WND
-                                     CW_USEDEFAULT, CW_USEDEFAULT, 200, 200, NULL, NULL,
-#else
-                                     -200, -200, 100, 100, NULL, NULL,
-#endif
-                                     hInstance, pThis /* lParm */);
+                                       VBOX_DND_WND_CLASS, VBOX_DND_WND_CLASS,
+                                       dwStyle,
+                                       -200, -200, 100, 100, NULL, NULL,
+                                       hInstance, pThis /* lParm */);
         if (!pThis->m_hWnd)
         {
@@ -267 +264 @@
         else
         {
-#ifndef VBOX_DND_DEBUG_WND
-            SetWindowPos(pThis->m_hWnd, HWND_TOPMOST, -200, -200, 0, 0,
-                           SWP_NOACTIVATE | SWP_HIDEWINDOW
-                         | SWP_NOCOPYBITS | SWP_NOREDRAW | SWP_NOSIZE);
+            BOOL fRc = SetWindowPos(pThis->m_hWnd, HWND_TOPMOST, -200, -200, 0, 0,
+                                      SWP_NOACTIVATE | SWP_HIDEWINDOW
+                                    | SWP_NOCOPYBITS | SWP_NOREDRAW | SWP_NOSIZE);
+            AssertMsg(fRc, ("Unable to set window position, error=%ld\n", GetLastError()));
+
             LogFlowFunc(("Proxy window created, hWnd=0x%x\n", pThis->m_hWnd));
-#else
-            LogFlowFunc(("Debug proxy window created, hWnd=0x%x\n", pThis->m_hWnd));
-
-            /*
-             * Install some mouse tracking.
-             */
-            TRACKMOUSEEVENT me;
-            RT_ZERO(me);
-            me.cbSize    = sizeof(TRACKMOUSEEVENT);
-            me.dwFlags   = TME_HOVER | TME_LEAVE | TME_NONCLIENT;
-            me.hwndTrack = pThis->m_hWnd;
-            BOOL fRc = TrackMouseEvent(&me);
-            Assert(fRc);
-#endif
+
+            if (g_cVerbosity)
+            {
+                /*
+                 * Install some mouse tracking.
+                 */
+                TRACKMOUSEEVENT me;
+                RT_ZERO(me);
+                me.cbSize    = sizeof(TRACKMOUSEEVENT);
+                me.dwFlags   = TME_HOVER | TME_LEAVE | TME_NONCLIENT;
+                me.hwndTrack = pThis->m_hWnd;
+
+                fRc = TrackMouseEvent(&me);
+                AssertMsg(fRc, ("Unable to enable debug mouse tracking, error=%ld\n", GetLastError()));
+            }
         }
     }
@@ -830 +829 @@
         return rc;
 
+    if (g_cVerbosity)
+    {
+        RTCString strMsg("Enter: Host -> Guest\n\n");
+        strMsg += RTCStringFmt("Allowed actions: %#x\n", a_fDndLstActionsAllowed);
+        strMsg += "Formats:\n";
+        for (size_t i = 0; i < this->m_lstFmtSup.size(); i++)
+        {
+            if (i > 0)
+                strMsg += "\n";
+            strMsg += this->m_lstFmtSup.at(i);
+        }
+
+        hlpShowBalloonTip(g_hInstance, g_hwndToolWindow, ID_TRAYICON,
+                          strMsg.c_str(), "VirtualBox Drag'n Drop",
+                          15 * 1000 /* Time to display in msec */, NIIF_INFO);
+    }
+
     /* Save all allowed actions. */
     this->m_lstActionsAllowed = a_fDndLstActionsAllowed;
@@ -1016 +1032 @@
         return VERR_WRONG_ORDER;
 
+    if (g_cVerbosity)
+        hlpShowBalloonTip(g_hInstance, g_hwndToolWindow, ID_TRAYICON,
+                          "Leave: Host -> Guest", "VirtualBox Drag'n Drop",
+                          15 * 1000 /* Time to display in msec */, NIIF_INFO);
+
     int rc = Abort();
 
@@ -1038 +1059 @@
     if (m_enmState == Dragging)
     {
+        if (g_cVerbosity)
+            hlpShowBalloonTip(g_hInstance, g_hwndToolWindow, ID_TRAYICON,
+                              "Drop: Host -> Guest", "VirtualBox Drag'n Drop",
+                              15 * 1000 /* Time to display in msec */, NIIF_INFO);
+
         if (m_lstFmtActive.size() >= 1)
         {
@@ -1325 +1351 @@
 int VBoxDnDWnd::OnGhDrop(const RTCString &strFormat, uint32_t dndActionDefault)
 {
-    RT_NOREF(dndActionDefault);
-
     LogFlowThisFunc(("mMode=%ld, mState=%ld, pDropTarget=0x%p, strFormat=%s, dndActionDefault=0x%x\n",
                      m_enmMode, m_enmState, m_pDropTarget, strFormat.c_str(), dndActionDefault));
@@ -1332 +1356 @@
     if (m_enmMode == GH)
     {
+        if (g_cVerbosity)
+        {
+            RTCString strMsg("Drop: Guest -> Host\n\n");
+            strMsg += RTCStringFmt("Action: %#x\n", dndActionDefault);
+            strMsg += RTCStringFmt("Format: %s\n", strFormat.c_str());
+
+            hlpShowBalloonTip(g_hInstance, g_hwndToolWindow, ID_TRAYICON,
+                              strMsg.c_str(), "VirtualBox Drag'n Drop",
+                              15 * 1000 /* Time to display in msec */, NIIF_INFO);
+        }
+
         if (m_enmState == Dragging)
         {
@@ -1503 +1538 @@
         r.right  = GetSystemMetrics(SM_CXSCREEN);
         r.bottom = GetSystemMetrics(SM_CYSCREEN);
+
         rc = VINF_SUCCESS;
     }
@@ -1521 +1557 @@
                            r.right  - r.left,
                            r.bottom - r.top,
-#ifdef VBOX_DND_DEBUG_WND
-                           SWP_SHOWWINDOW | SWP_FRAMECHANGED);
-#else
-                           SWP_SHOWWINDOW | SWP_NOOWNERZORDER | SWP_NOREDRAW | SWP_NOACTIVATE);
-#endif
+                             g_cVerbosity
+                           ? SWP_SHOWWINDOW | SWP_FRAMECHANGED
+                           : SWP_SHOWWINDOW | SWP_NOOWNERZORDER | SWP_NOREDRAW | SWP_NOACTIVATE);
         if (fRc)
         {
@@ -1864 +1898 @@
         return rc;
 
+    if (g_cVerbosity)
+        hlpShowBalloonTip(g_hInstance, g_hwndToolWindow, ID_TRAYICON,
+                          RTCStringFmt("Running (worker client ID %RU32)", pCtx->cmdCtx.uClientID).c_str(),
+                          "VirtualBox Drag'n Drop",
+                          15 * 1000 /* Time to display in msec */, NIIF_INFO);
+
     /** @todo At the moment we only have one DnD proxy window. */
     Assert(pCtx->lstWnd.size() == 1);