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 | 278 ++++++++++++++++++++++++++++++++++---------------------
1 files changed, 172 insertions(+), 106 deletions(-)
diff --git a/src/core/contexts/win32windowcontext.cpp b/src/core/contexts/win32windowcontext.cpp
index bf25bdb..841273a 100644
--- a/src/core/contexts/win32windowcontext.cpp
+++ b/src/core/contexts/win32windowcontext.cpp
@@ -1,3 +1,7 @@
+// Copyright (C) 2023-2024 Stdware Collections (https://www.github.com/stdware)
+// Copyright (C) 2021-2023 wangwenx190 (Yuhang Zhao)
+// SPDX-License-Identifier: Apache-2.0
+
#include "win32windowcontext_p.h"
#include <optional>
@@ -9,7 +13,6 @@
#include <QtGui/QGuiApplication>
#include <QtGui/QPainter>
#include <QtGui/QPalette>
-#include <QtGui/QStyleHints>
#include <QtGui/private/qhighdpiscaling_p.h>
#if QT_VERSION >= QT_VERSION_CHECK(6, 0, 0)
@@ -47,13 +50,13 @@
static WNDPROC g_qtWindowProc = nullptr;
static inline bool
-#if !QWINDOWKIT_CONFIG(ENABLE_WINDOWS_SYSTEM_BORDER)
+#if !QWINDOWKIT_CONFIG(ENABLE_WINDOWS_SYSTEM_BORDERS)
constexpr
#endif
isSystemBorderEnabled() {
return
-#if QWINDOWKIT_CONFIG(ENABLE_WINDOWS_SYSTEM_BORDER)
+#if QWINDOWKIT_CONFIG(ENABLE_WINDOWS_SYSTEM_BORDERS)
isWin10OrGreater()
#else
false
@@ -93,18 +96,6 @@
monitorInfo.cbSize = sizeof(monitorInfo);
::GetMonitorInfoW(monitor, &monitorInfo);
return monitorInfo;
- }
-
- static inline void moveWindowToDesktopCenter(HWND hwnd) {
- MONITORINFOEXW monitorInfo = getMonitorForWindow(hwnd);
- RECT windowRect{};
- ::GetWindowRect(hwnd, &windowRect);
- const auto newX = monitorInfo.rcMonitor.left +
- (RECT_WIDTH(monitorInfo.rcMonitor) - RECT_WIDTH(windowRect)) / 2;
- const auto newY = monitorInfo.rcMonitor.top +
- (RECT_HEIGHT(monitorInfo.rcMonitor) - RECT_HEIGHT(windowRect)) / 2;
- ::SetWindowPos(hwnd, nullptr, newX, newY, 0, 0,
- SWP_NOACTIVATE | SWP_NOSIZE | SWP_NOZORDER | SWP_NOOWNERZORDER);
}
static inline void moveWindowToMonitor(HWND hwnd, const MONITORINFOEXW &activeMonitor) {
@@ -330,7 +321,7 @@
case HTBORDER:
return Win32WindowContext::FixedBorder;
default:
- // unreachable
+ Q_UNREACHABLE();
break;
}
return Win32WindowContext::Outside;
@@ -368,6 +359,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
// In QWindowsContext::windowsProc(), the messages will be passed to all global native event
// filters, but because we have already filtered the messages in the hook WndProc function for
@@ -402,8 +491,8 @@
return false;
}
- static WindowsNativeEventFilter *instance;
- static Win32WindowContext *lastMessageContext;
+ static inline WindowsNativeEventFilter *instance = nullptr;
+ static inline Win32WindowContext *lastMessageContext = nullptr;
static inline void install() {
if (instance) {
@@ -420,9 +509,6 @@
instance = nullptr;
}
};
-
- WindowsNativeEventFilter *WindowsNativeEventFilter::instance = nullptr;
- Win32WindowContext *WindowsNativeEventFilter::lastMessageContext = nullptr;
// https://github.com/qt/qtbase/blob/e26a87f1ecc40bc8c6aa5b889fce67410a57a702/src/plugins/platforms/windows/qwindowscontext.cpp#L1025
// We can see from the source code that Qt will filter out some messages first and then send the
@@ -501,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;
}
@@ -552,8 +642,8 @@
}
Win32WindowContext::~Win32WindowContext() {
- if (windowId) {
- removeManagedWindow(reinterpret_cast<HWND>(windowId));
+ if (m_windowId) {
+ removeManagedWindow(reinterpret_cast<HWND>(m_windowId));
}
}
@@ -563,27 +653,20 @@
void Win32WindowContext::virtual_hook(int id, void *data) {
switch (id) {
- case CentralizeHook: {
- if (!windowId)
- return;
- const auto hwnd = reinterpret_cast<HWND>(windowId);
- moveWindowToDesktopCenter(hwnd);
- return;
- }
-
case RaiseWindowHook: {
- if (!windowId)
+ if (!m_windowId)
return;
- const auto hwnd = reinterpret_cast<HWND>(windowId);
+ m_delegate->setWindowVisible(m_host, true);
+ 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);
@@ -605,16 +688,16 @@
return;
}
+#if QWINDOWKIT_CONFIG(ENABLE_WINDOWS_SYSTEM_BORDERS)
case DrawWindows10BorderHook: {
-#if QWINDOWKIT_CONFIG(ENABLE_WINDOWS_SYSTEM_BORDER)
- 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 ®ion = *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);
@@ -646,20 +729,18 @@
QPoint{m_windowHandle->width(), 0}
});
painter.restore();
-#endif
return;
}
case DrawWindows10BorderHook2: {
-#if QWINDOWKIT_CONFIG(ENABLE_WINDOWS_SYSTEM_BORDER)
- 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);
@@ -672,9 +753,9 @@
::FillRect(hdc, &rcTopBorder,
reinterpret_cast<HBRUSH>(::GetStockObject(BLACK_BRUSH)));
::ReleaseDC(hWnd, hdc);
-#endif
return;
}
+#endif
default:
break;
@@ -683,14 +764,22 @@
}
QVariant Win32WindowContext::windowAttribute(const QString &key) const {
- if (key == QStringLiteral("title-bar-rect")) {
- if (!m_windowHandle)
+ if (key == QStringLiteral("window-rect")) {
+ if (!m_windowId)
return {};
- auto hwnd = reinterpret_cast<HWND>(windowId);
RECT frame{};
- ::AdjustWindowRectExForDpi(&frame, ::GetWindowLongPtrW(hwnd, GWL_STYLE), FALSE, 0,
- getDpiForWindow(hwnd));
+ 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));
+ const DynamicApis &apis = DynamicApis::instance();
+ if (apis.pAdjustWindowRectExForDpi) {
+ apis.pAdjustWindowRectExForDpi(&frame, style, FALSE, exStyle,
+ getDpiForWindow(hwnd));
+ } else {
+ ::AdjustWindowRectEx(&frame, style, FALSE, exStyle);
+ }
return QVariant::fromValue(rect2qrect(frame));
}
@@ -699,49 +788,53 @@
}
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()) {
- setWindowAttribute(QStringLiteral("extra-margins"),
- QVariant::fromValue(QMargins(1, 1, 1, 1)));
+ static auto margins = QVariant::fromValue(QMargins(1, 1, 1, 1));
+
+ // If we remove the system border, the window will lose its shadow. If dwm is enabled,
+ // then we need to set at least 1px margins, otherwise the following operation will
+ // fail with no effect.
+ setWindowAttribute(QStringLiteral("extra-margins"), margins);
}
+ // We should disable WS_SYSMENU, otherwise the system button icons will be visible if mica
+ // is enabled and the title bar is transparent.
{
auto style = ::GetWindowLongPtrW(hWnd, GWL_STYLE);
-#if QWINDOWKIT_CONFIG(ENABLE_WINDOWS_SYSTEM_BORDER)
- ::SetWindowLongPtrW(hWnd, GWL_STYLE, style & (~WS_SYSMENU));
-#else
- ::SetWindowLongPtrW(hWnd, GWL_STYLE,
- (style | WS_THICKFRAME | WS_CAPTION) & (~WS_SYSMENU));
-#endif
+ if (isSystemBorderEnabled()) {
+ ::SetWindowLongPtrW(hWnd, GWL_STYLE, style & (~WS_SYSMENU));
+ } else {
+ ::SetWindowLongPtrW(hWnd, GWL_STYLE,
+ (style | WS_THICKFRAME | WS_CAPTION) & (~WS_SYSMENU));
+ }
}
// Add managed window
addManagedWindow(m_windowHandle, hWnd, this);
-
- // Cache win id
- windowId = winId;
}
bool Win32WindowContext::windowProc(HWND hWnd, UINT message, WPARAM wParam, LPARAM lParam,
@@ -751,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:
@@ -783,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;
}
@@ -801,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]() {
@@ -812,8 +901,7 @@
if (key == QStringLiteral("extra-margins")) {
auto margins = qmargins2margins(attribute.value<QMargins>());
- DynamicApis::instance().pDwmExtendFrameIntoClientArea(hwnd, &margins);
- return true;
+ return apis.pDwmExtendFrameIntoClientArea(hwnd, &margins) == S_OK;
}
if (key == QStringLiteral("dark-mode")) {
@@ -943,12 +1031,9 @@
}
if (key == QStringLiteral("dwm-blur")) {
- // TODO: Optimize
- // Currently not available!!!
if (attribute.toBool()) {
- // We need to extend the window frame into the whole client area to be able
- // to see the blurred window background.
- apis.pDwmExtendFrameIntoClientArea(hwnd, &extendedMargins);
+ // We can't extend the window frame for this effect.
+ restoreMargins();
if (isWin8OrGreater()) {
ACCENT_POLICY policy{};
policy.dwAccentState = ACCENT_ENABLE_BLURBEHIND;
@@ -980,7 +1065,6 @@
bb.dwFlags = DWM_BB_ENABLE;
apis.pDwmEnableBlurBehindWindow(hwnd, &bb);
}
- restoreMargins();
}
return true;
}
@@ -1240,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) {
@@ -1284,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);
@@ -1318,19 +1397,6 @@
bool Win32WindowContext::customWindowHandler(HWND hWnd, UINT message, WPARAM wParam,
LPARAM lParam, LRESULT *result) {
switch (message) {
- case WM_SHOWWINDOW: {
- if (!centered) {
- // If wParam is TRUE, the window is being shown.
- // If lParam is zero, the message was sent because of a call to the ShowWindow
- // function.
- if (wParam && !lParam) {
- centered = true;
- moveWindowToDesktopCenter(hWnd);
- }
- }
- break;
- }
-
case WM_NCHITTEST: {
// 鍘熺敓Win32绐楀彛鍙湁椤惰竟鏄湪绐楀彛鍐呴儴resize鐨勶紝鍏朵綑涓夎竟閮芥槸鍦ㄧ獥鍙�
// 澶栭儴杩涜resize鐨勶紝鍏跺師鐞嗘槸锛學S_THICKFRAME杩欎釜绐楀彛鏍峰紡浼氬湪绐�
--
Gitblit v1.9.1