From c70a286d01728bd2fa01103191c9da23ad3f8be2 Mon Sep 17 00:00:00 2001
From: Sine Striker <trueful@163.com>
Date: 周五, 23 2月 2024 22:03:56 +0800
Subject: [PATCH] Delay filtering the native events

---
 src/core/contexts/win32windowcontext.cpp |  175 ++++++++++++++++++++++++++++++++++++++++++++--------------
 1 files changed, 133 insertions(+), 42 deletions(-)

diff --git a/src/core/contexts/win32windowcontext.cpp b/src/core/contexts/win32windowcontext.cpp
index 4a859c7..841273a 100644
--- a/src/core/contexts/win32windowcontext.cpp
+++ b/src/core/contexts/win32windowcontext.cpp
@@ -321,7 +321,7 @@
             case HTBORDER:
                 return Win32WindowContext::FixedBorder;
             default:
-                // unreachable
+                Q_UNREACHABLE();
                 break;
         }
         return Win32WindowContext::Outside;
@@ -357,6 +357,104 @@
             }
         }
         return true;
+    }
+
+    static inline constexpr bool isNonClientMessage(const UINT message) {
+        if (((message >= WM_NCCREATE) && (message <= WM_NCACTIVATE)) ||
+            ((message >= WM_NCMOUSEMOVE) && (message <= WM_NCMBUTTONDBLCLK)) ||
+            ((message >= WM_NCXBUTTONDOWN) && (message <= WM_NCXBUTTONDBLCLK))
+#if (WINVER >= _WIN32_WINNT_WIN8)
+            || ((message >= WM_NCPOINTERUPDATE) && (message <= WM_NCPOINTERUP))
+#endif
+            || ((message == WM_NCMOUSEHOVER) || (message == WM_NCMOUSELEAVE))) {
+            return true;
+        } else {
+            return false;
+        }
+    }
+
+    static MSG createMessageBlock(HWND hWnd, UINT message, WPARAM wParam, LPARAM lParam) {
+        MSG msg;
+        msg.hwnd = hWnd;       // re-create MSG structure
+        msg.message = message; // time and pt fields ignored
+        msg.wParam = wParam;
+        msg.lParam = lParam;
+
+        const DWORD dwScreenPos = ::GetMessagePos();
+        msg.pt.x = GET_X_LPARAM(dwScreenPos);
+        msg.pt.y = GET_Y_LPARAM(dwScreenPos);
+        if (!isNonClientMessage(message)) {
+            ::ScreenToClient(hWnd, &msg.pt);
+        }
+        return msg;
+    }
+
+    static inline constexpr bool isInputMessage(UINT m) {
+        switch (m) {
+            case WM_IME_STARTCOMPOSITION:
+            case WM_IME_ENDCOMPOSITION:
+            case WM_IME_COMPOSITION:
+            case WM_INPUT:
+            case WM_TOUCH:
+            case WM_MOUSEHOVER:
+            case WM_MOUSELEAVE:
+            case WM_NCMOUSEHOVER:
+            case WM_NCMOUSELEAVE:
+            case WM_SIZING:
+            case WM_MOVING:
+            case WM_SYSCOMMAND:
+            case WM_COMMAND:
+            case WM_DWMNCRENDERINGCHANGED:
+            case WM_PAINT:
+                return true;
+            default:
+                break;
+        }
+        return (m >= WM_MOUSEFIRST && m <= WM_MOUSELAST) ||
+               (m >= WM_NCMOUSEMOVE && m <= WM_NCXBUTTONDBLCLK) ||
+               (m >= WM_KEYFIRST && m <= WM_KEYLAST);
+    }
+
+    static inline QByteArray nativeEventType() {
+        return QByteArrayLiteral("windows_generic_MSG");
+    }
+
+    // Send to QAbstractEventDispatcher
+    bool filterNativeEvent(MSG *msg, LRESULT *result) {
+        auto dispatcher = QAbstractEventDispatcher::instance();
+        QT_NATIVE_EVENT_RESULT_TYPE filterResult = *result;
+        if (dispatcher && dispatcher->filterNativeEvent(nativeEventType(), msg, &filterResult)) {
+            *result = LRESULT(filterResult);
+            return true;
+        }
+        return false;
+    }
+
+    // Send to QWindowSystemInterface
+    bool filterNativeEvent(QWindow *window, MSG *msg, LRESULT *result) {
+        QT_NATIVE_EVENT_RESULT_TYPE filterResult = *result;
+        if (QWindowSystemInterface::handleNativeEvent(window, nativeEventType(), msg,
+                                                      &filterResult)) {
+            *result = LRESULT(filterResult);
+            return true;
+        }
+        return false;
+    }
+
+    static inline bool forwardFilteredEvents(QWindow *window, HWND hWnd, UINT message,
+                                             WPARAM wParam, LPARAM lParam, LRESULT *result) {
+        MSG msg = createMessageBlock(hWnd, message, wParam, lParam);
+
+        // Run the native event filters. QTBUG-67095: Exclude input messages which are sent
+        // by QEventDispatcherWin32::processEvents()
+        if (!isInputMessage(msg.message) && filterNativeEvent(&msg, result))
+            return true;
+
+        auto platformWindow = window->handle();
+        if (platformWindow && filterNativeEvent(platformWindow->window(), &msg, result))
+            return true;
+
+        return false;
     }
 
     // https://github.com/qt/qtbase/blob/e26a87f1ecc40bc8c6aa5b889fce67410a57a702/src/plugins/platforms/windows/qwindowscontext.cpp#L1556
@@ -489,6 +587,10 @@
         // Try hooked procedure and save result
         LRESULT result;
         if (ctx->windowProc(hWnd, message, wParam, lParam, &result)) {
+            // Forward the event to user-defined native event filters, there may be some messages
+            // that need to be processed by the user.
+            std::ignore =
+                forwardFilteredEvents(ctx->window(), hWnd, message, wParam, lParam, &result);
             return result;
         }
 
@@ -540,8 +642,8 @@
     }
 
     Win32WindowContext::~Win32WindowContext() {
-        if (windowId) {
-            removeManagedWindow(reinterpret_cast<HWND>(windowId));
+        if (m_windowId) {
+            removeManagedWindow(reinterpret_cast<HWND>(m_windowId));
         }
     }
 
@@ -552,19 +654,19 @@
     void Win32WindowContext::virtual_hook(int id, void *data) {
         switch (id) {
             case RaiseWindowHook: {
-                if (!windowId)
+                if (!m_windowId)
                     return;
                 m_delegate->setWindowVisible(m_host, true);
-                const auto hwnd = reinterpret_cast<HWND>(windowId);
+                const auto hwnd = reinterpret_cast<HWND>(m_windowId);
                 bringWindowToFront(hwnd);
                 return;
             }
 
             case ShowSystemMenuHook: {
-                if (!windowId)
+                if (!m_windowId)
                     return;
                 const auto &pos = *static_cast<const QPoint *>(data);
-                auto hWnd = reinterpret_cast<HWND>(windowId);
+                auto hWnd = reinterpret_cast<HWND>(m_windowId);
 #if QT_VERSION >= QT_VERSION_CHECK(6, 0, 0)
                 const QPoint nativeGlobalPos =
                     QHighDpi::toNativeGlobalPosition(pos, m_windowHandle);
@@ -588,14 +690,14 @@
 
 #if QWINDOWKIT_CONFIG(ENABLE_WINDOWS_SYSTEM_BORDERS)
             case DrawWindows10BorderHook: {
-                if (!windowId)
+                if (!m_windowId)
                     return;
 
                 auto args = static_cast<void **>(data);
                 auto &painter = *static_cast<QPainter *>(args[0]);
                 const auto &rect = *static_cast<const QRect *>(args[1]);
                 const auto &region = *static_cast<const QRegion *>(args[2]);
-                const auto hwnd = reinterpret_cast<HWND>(windowId);
+                const auto hwnd = reinterpret_cast<HWND>(m_windowId);
 
                 QPen pen;
                 pen.setWidth(int(getWindowFrameBorderThickness(hwnd)) * 2);
@@ -631,14 +733,14 @@
             }
 
             case DrawWindows10BorderHook2: {
-                if (!m_windowHandle)
+                if (!m_windowId)
                     return;
 
                 // https://github.com/microsoft/terminal/blob/71a6f26e6ece656084e87de1a528c4a8072eeabd/src/cascadia/WindowsTerminal/NonClientIslandWindow.cpp#L1025
                 // https://docs.microsoft.com/en-us/windows/win32/dwm/customframe#extending-the-client-frame
                 // Draw a black rectangle to make Windows native top border show
 
-                auto hWnd = reinterpret_cast<HWND>(windowId);
+                auto hWnd = reinterpret_cast<HWND>(m_windowId);
                 HDC hdc = ::GetDC(hWnd);
                 RECT windowRect{};
                 ::GetClientRect(hWnd, &windowRect);
@@ -663,11 +765,11 @@
 
     QVariant Win32WindowContext::windowAttribute(const QString &key) const {
         if (key == QStringLiteral("window-rect")) {
-            if (!m_windowHandle)
+            if (!m_windowId)
                 return {};
 
             RECT frame{};
-            auto hwnd = reinterpret_cast<HWND>(windowId);
+            auto hwnd = reinterpret_cast<HWND>(m_windowId);
             // According to MSDN, WS_OVERLAPPED is not allowed for AdjustWindowRect.
             auto style = static_cast<DWORD>(::GetWindowLongPtrW(hwnd, GWL_STYLE) & ~WS_OVERLAPPED);
             auto exStyle = static_cast<DWORD>(::GetWindowLongPtrW(hwnd, GWL_EXSTYLE));
@@ -686,29 +788,30 @@
         }
 
         if (key == QStringLiteral("border-thickness")) {
-            return m_windowHandle
-                       ? int(getWindowFrameBorderThickness(reinterpret_cast<HWND>(windowId)))
+            return m_windowId
+                       ? int(getWindowFrameBorderThickness(reinterpret_cast<HWND>(m_windowId)))
                        : 0;
         }
 
         return AbstractWindowContext::windowAttribute(key);
     }
 
-    void Win32WindowContext::winIdChanged() {
+    void Win32WindowContext::winIdChanged(WId winId, WId oldWinId) {
+        // Reset the context data
+        mouseLeaveBlocked = false;
+        lastHitTestResult = WindowPart::Outside;
+
         // If the original window id is valid, remove all resources related
-        if (windowId) {
-            removeManagedWindow(reinterpret_cast<HWND>(windowId));
-            windowId = 0;
+        if (oldWinId) {
+            removeManagedWindow(reinterpret_cast<HWND>(oldWinId));
         }
 
-        if (!m_windowHandle) {
+        if (!winId) {
             return;
         }
 
         // Install window hook
-        auto winId = m_windowHandle->winId();
         auto hWnd = reinterpret_cast<HWND>(winId);
-
         if (!isSystemBorderEnabled()) {
             static auto margins = QVariant::fromValue(QMargins(1, 1, 1, 1));
 
@@ -732,9 +835,6 @@
 
         // Add managed window
         addManagedWindow(m_windowHandle, hWnd, this);
-
-        // Cache win id
-        windowId = winId;
     }
 
     bool Win32WindowContext::windowProc(HWND hWnd, UINT message, WPARAM wParam, LPARAM lParam,
@@ -744,8 +844,8 @@
         // We should skip these messages otherwise we will get crashes.
         // NOTE: WM_QUIT won't be posted to the WindowProc function.
         switch (message) {
-            case WM_CLOSE:
             case WM_DESTROY:
+            case WM_CLOSE:
             case WM_NCDESTROY:
             // Undocumented messages:
             case WM_UAHDESTROYWINDOW:
@@ -776,13 +876,9 @@
 
         // Forward to native event filter subscribers
         if (!m_nativeEventFilters.isEmpty()) {
-            MSG msg;
-            msg.hwnd = hWnd;
-            msg.message = message;
-            msg.wParam = wParam;
-            msg.lParam = lParam;
+            MSG msg = createMessageBlock(hWnd, message, wParam, lParam);
             QT_NATIVE_EVENT_RESULT_TYPE res = 0;
-            if (nativeDispatch(QByteArrayLiteral("windows_generic_MSG"), &msg, &res)) {
+            if (nativeDispatch(nativeEventType(), &msg, &res)) {
                 *result = LRESULT(res);
                 return true;
             }
@@ -794,7 +890,7 @@
                                                     const QVariant &oldAttribute) {
         Q_UNUSED(oldAttribute)
 
-        const auto hwnd = reinterpret_cast<HWND>(m_windowHandle->winId());
+        const auto hwnd = reinterpret_cast<HWND>(m_windowId);
         const DynamicApis &apis = DynamicApis::instance();
         static constexpr const MARGINS extendedMargins = {-1, -1, -1, -1};
         const auto &restoreMargins = [this, &apis, hwnd]() {
@@ -1228,19 +1324,14 @@
                         // the above problems would not arise.
 
                         m_delegate->resetQtGrabbedControl(m_host);
+
+                        // If the mouse moves from chrome buttons to other non-client areas, a
+                        // WM_MOUSELEAVE message should be sent.
                         if (mouseLeaveBlocked) {
                             emulateClientAreaMessage(hWnd, message, wParam, lParam,
                                                      WM_NCMOUSELEAVE);
                         }
                     }
-
-                    // We need to make sure we get the right hit-test result when a WM_NCMOUSELEAVE
-                    // comes, so we reset it when we receive a WM_NCMOUSEMOVE.
-
-                    // If the mouse is entering the client area, there must be a WM_NCHITTEST
-                    // setting it to `Client` before the WM_NCMOUSELEAVE comes; if the mouse is
-                    // leaving the window, current window part remains as `Outside`.
-                    lastHitTestResult = WindowPart::Outside;
                 }
 
                 if (currentWindowPart == WindowPart::ChromeButton) {
@@ -1272,7 +1363,7 @@
                     // pressing area as HTCLIENT which maybe because of our former retransmission of
                     // WM_NCLBUTTONDOWN, as a result, a WM_NCMOUSELEAVE will come immediately and a
                     // lot of WM_MOUSEMOVE will come if we move the mouse, we should track the mouse
-                    // in advance.
+                    // in advance. (May be redundant?)
                     if (mouseLeaveBlocked) {
                         mouseLeaveBlocked = false;
                         requestForMouseLeaveMessage(hWnd, false);

--
Gitblit v1.9.1