Fix numerous bugs (#162)

SineStriker

2025-02-11 3e942c3dc8955be577079fbc028ce216e1c594b2

 src/core/contexts/win32windowcontext.cpp

@@ -33,6 +33,10 @@
#include "qwkglobal_p.h"
#include "qwkwindowsextra_p.h"

#if (QT_VERSION >= QT_VERSION_CHECK(6, 6, 0)) && (QT_VERSION <= QT_VERSION_CHECK(6, 6, 1))
#  error Current Qt version has a critical bug which will break QWK functionality. Please upgrade to > 6.6.1 or downgrade to < 6.6.0
#endif

namespace QWK {

    enum IconButtonClickLevelFlag {
@@ -82,7 +86,10 @@
    static void setInternalWindowFrameMargins(QWindow *window, const QMargins &margins) {
        const QVariant marginsVar = QVariant::fromValue(margins);

        // TODO: Add comments
        // We need to tell Qt we have set a custom margin, because we are hiding
        // the title bar by pretending the whole window is filled by client area,
        // this however confuses Qt's internal logic. We need to do the following
        // hack to let Qt consider the extra margin when changing window geometry.
        window->setProperty("_q_windowsCustomMargins", marginsVar);
#if QT_VERSION < QT_VERSION_CHECK(6, 0, 0)
        if (QPlatformWindow *platformWindow = window->handle()) {
@@ -193,8 +200,8 @@

        [[maybe_unused]] const auto &cleaner =
            qScopeGuard([windowThreadProcessId, currentThreadId]() {
                ::AttachThreadInput(windowThreadProcessId, currentThreadId, FALSE); //
            }); // TODO: Remove it
                ::AttachThreadInput(windowThreadProcessId, currentThreadId, FALSE);
            });

        ::BringWindowToTop(hwnd);
        // Activate the window too. This will force us to the virtual desktop this
@@ -202,51 +209,6 @@
        ::SetActiveWindow(hwnd);
        // Throw us on the active monitor.
        moveWindowToMonitor(hwnd, activeMonitor);
    }

    static void syncPaintEventWithDwm() {
        // No need to sync with DWM if DWM composition is disabled.
        if (!isDwmCompositionEnabled()) {
            return;
        }
        const DynamicApis &apis = DynamicApis::instance();
        // Dirty hack to workaround the resize flicker caused by DWM.
        LARGE_INTEGER freq{};
        ::QueryPerformanceFrequency(&freq);
        TIMECAPS tc{};
        apis.ptimeGetDevCaps(&tc, sizeof(tc));
        const UINT ms_granularity = tc.wPeriodMin;
        apis.ptimeBeginPeriod(ms_granularity);
        LARGE_INTEGER now0{};
        ::QueryPerformanceCounter(&now0);
        // ask DWM where the vertical blank falls
        DWM_TIMING_INFO dti{};
        dti.cbSize = sizeof(dti);
        apis.pDwmGetCompositionTimingInfo(nullptr, &dti);
        LARGE_INTEGER now1{};
        ::QueryPerformanceCounter(&now1);
        // - DWM told us about SOME vertical blank
        //   - past or future, possibly many frames away
        // - convert that into the NEXT vertical blank
        const auto period = qreal(dti.qpcRefreshPeriod);
        const auto dt = qreal(dti.qpcVBlank - now1.QuadPart);
        const qreal ratio = (dt / period);
        auto w = qreal(0);
        auto m = qreal(0);
        if ((dt > qreal(0)) || qFuzzyIsNull(dt)) {
            w = ratio;
        } else {
            // reach back to previous period
            // - so m represents consistent position within phase
            w = (ratio - qreal(1));
        }
        m = (dt - (period * w));
        if ((m < qreal(0)) || qFuzzyCompare(m, period) || (m > period)) {
            return;
        }
        const qreal m_ms = (qreal(1000) * m / qreal(freq.QuadPart));
        ::Sleep(static_cast<DWORD>(std::round(m_ms)));
        apis.ptimeEndPeriod(ms_granularity);
    }

    // Returns false if the menu is canceled
@@ -260,12 +222,20 @@
            return true;
        }

        const auto windowStyles = ::GetWindowLongPtrW(hWnd, GWL_STYLE);
        const bool allowMaximize = windowStyles & WS_MAXIMIZEBOX;
        const bool allowMinimize = windowStyles & WS_MINIMIZEBOX;

        const bool maxOrFull = isMaximized(hWnd) || isFullScreen(hWnd);
        ::EnableMenuItem(hMenu, SC_CLOSE, (MF_BYCOMMAND | MFS_ENABLED));
        ::EnableMenuItem(hMenu, SC_MAXIMIZE,
                         (MF_BYCOMMAND | ((maxOrFull || fixedSize) ? MFS_DISABLED : MFS_ENABLED)));
        ::EnableMenuItem(hMenu, SC_RESTORE,
                         (MF_BYCOMMAND | ((maxOrFull && !fixedSize) ? MFS_ENABLED : MFS_DISABLED)));
        ::EnableMenuItem(
            hMenu, SC_MAXIMIZE,
            (MF_BYCOMMAND |
             ((maxOrFull || fixedSize || !allowMaximize) ? MFS_DISABLED : MFS_ENABLED)));
        ::EnableMenuItem(
            hMenu, SC_RESTORE,
            (MF_BYCOMMAND |
             ((maxOrFull && !fixedSize && allowMaximize) ? MFS_ENABLED : MFS_DISABLED)));
        // The first menu item should be selected by default if the menu is brought
        // up by keyboard. I don't know how to pre-select a menu item but it seems
        // highlight can do the job. However, there's an annoying issue if we do
@@ -277,7 +247,8 @@
        // the menu look kind of weird. Currently I don't know how to fix this issue.
        ::HiliteMenuItem(hWnd, hMenu, SC_RESTORE,
                         (MF_BYCOMMAND | (selectFirstEntry ? MFS_HILITE : MFS_UNHILITE)));
        ::EnableMenuItem(hMenu, SC_MINIMIZE, (MF_BYCOMMAND | MFS_ENABLED));
        ::EnableMenuItem(hMenu, SC_MINIMIZE,
                         (MF_BYCOMMAND | (allowMinimize ? MFS_ENABLED : MFS_DISABLED)));
        ::EnableMenuItem(hMenu, SC_SIZE,
                         (MF_BYCOMMAND | ((maxOrFull || fixedSize) ? MFS_DISABLED : MFS_ENABLED)));
        ::EnableMenuItem(hMenu, SC_MOVE, (MF_BYCOMMAND | (maxOrFull ? MFS_DISABLED : MFS_ENABLED)));
@@ -396,8 +367,8 @@

    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.hwnd = hWnd;
        msg.message = message;
        msg.wParam = wParam;
        msg.lParam = lParam;

@@ -407,6 +378,8 @@
        if (!isNonClientMessage(message)) {
            ::ScreenToClient(hWnd, &msg.pt);
        }

        msg.time = ::GetMessageTime();
        return msg;
    }

@@ -441,7 +414,7 @@
    }

    // Send to QAbstractEventDispatcher
    bool filterNativeEvent(MSG *msg, LRESULT *result) {
    static bool filterNativeEvent(MSG *msg, LRESULT *result) {
        auto dispatcher = QAbstractEventDispatcher::instance();
        QT_NATIVE_EVENT_RESULT_TYPE filterResult = *result;
        if (dispatcher && dispatcher->filterNativeEvent(nativeEventType(), msg, &filterResult)) {
@@ -452,7 +425,7 @@
    }

    // Send to QWindowSystemInterface
    bool filterNativeEvent(QWindow *window, MSG *msg, LRESULT *result) {
    static bool filterNativeEvent(QWindow *window, MSG *msg, LRESULT *result) {
        QT_NATIVE_EVENT_RESULT_TYPE filterResult = *result;
        if (QWindowSystemInterface::handleNativeEvent(window, nativeEventType(), msg,
                                                      &filterResult)) {
@@ -665,6 +638,11 @@

        // Save window handle mapping
        g_wndProcHash->insert(hWnd, ctx);

        // Force a WM_NCCALCSIZE message manually to avoid the title bar become visible
        // while Qt is re-creating the window (such as setWindowFlag(s) calls). It has
        // been observed by our users.
        triggerFrameChange(hWnd);
    }

    static inline void removeManagedWindow(HWND hWnd) {
@@ -729,7 +707,7 @@
            }

#if QWINDOWKIT_CONFIG(ENABLE_WINDOWS_SYSTEM_BORDERS)
            case DrawWindows10BorderHook: {
            case DrawWindows10BorderHook_Emulated: {
                if (!m_windowId)
                    return;

@@ -772,7 +750,7 @@
                return;
            }

            case DrawWindows10BorderHook2: {
            case DrawWindows10BorderHook_Native: {
                if (!m_windowId)
                    return;

@@ -827,6 +805,10 @@
            return isSystemBorderEnabled() && !isWin11OrGreater();
        }

        if (key == QStringLiteral("windows-system-border-enabled")) {
            return isSystemBorderEnabled();
        }

        if (key == QStringLiteral("border-thickness")) {
            return m_windowId
                       ? int(getWindowFrameBorderThickness(reinterpret_cast<HWND>(m_windowId)))
@@ -845,16 +827,10 @@
        lastHitTestResult = WindowPart::Outside;
        lastHitTestResultRaw = HTNOWHERE;

        if (!isSystemBorderEnabled()) {
            m_delegate->setWindowFlags(m_host, m_delegate->getWindowFlags(m_host) |
                                                   Qt::FramelessWindowHint);
        }

        // If the original window id is valid, remove all resources related
        if (oldWinId) {
            removeManagedWindow(reinterpret_cast<HWND>(oldWinId));
        }

        if (!winId) {
            return;
        }
@@ -940,17 +916,66 @@
        Q_UNUSED(oldAttribute)

        const auto hwnd = reinterpret_cast<HWND>(m_windowId);
        if (!hwnd) {
            return false;
        }

        const DynamicApis &apis = DynamicApis::instance();
        static constexpr const MARGINS extendedMargins = {-1, -1, -1, -1};
        const auto &extendMargins = [this, &apis, hwnd]() {
            // For some unknown reason, the window background is totally black when the host object
            // is a QWidget. And extending the window frame into the client area seems to fix it
            // magically.
            // We don't need the following *HACK* for QtQuick windows.
            if (!m_host->isWidgetType()) {
                return;
            }
            // After many times of trying, we found that the Acrylic/Mica/Mica Alt background
            // only appears on the native Win32 window's background, so naturally we want to
            // extend the window frame into the whole client area to be able to let the special
            // material fill the whole window. Previously we are using negative margins because
            // it's widely known that using negative margins will let the window frame fill
            // the whole window and that's indeed what we wanted to do, however, later we found
            // that doing so is causing issues. When the user enabled the "show accent color on
            // window title bar and borders" option on system personalize settings, a 30px bar
            // would appear on window top. It has the same color with the system accent color.
            // Actually it's the original title bar we've already hidden, and it magically
            // appears again when we use negative margins to extend the window frame. And again
            // after some experiments, I found that the title bar won't appear if we don't extend
            // from the top side. In the end I found that we only need to extend from the left
            // side if we extend long enough. In this way we can see the special material even
            // when the host object is a QWidget and the title bar still remain hidden. But even
            // though this solution seems perfect, I really don't know why it works. The following
            // hack is totally based on experiments.
            static constexpr const MARGINS margins = {65536, 0, 0, 0};
            apis.pDwmExtendFrameIntoClientArea(hwnd, &margins);
        };
        const auto &restoreMargins = [this, &apis, hwnd]() {
            auto margins = qmargins2margins(
                m_windowAttributes.value(QStringLiteral("extra-margins")).value<QMargins>());
                windowAttribute(QStringLiteral("extra-margins")).value<QMargins>());
            apis.pDwmExtendFrameIntoClientArea(hwnd, &margins);
        };

        const auto &effectBugWorkaround = [this, hwnd]() {
            // We don't need the following *HACK* for QWidget windows.
            if (m_host->isWidgetType()) {
                return;
            }
            static QSet<WId> bugWindowSet{};
            if (bugWindowSet.contains(m_windowId)) {
                return;
            }
            bugWindowSet.insert(m_windowId);
            RECT rect{};
            ::GetWindowRect(hwnd, &rect);
            ::MoveWindow(hwnd, rect.left, rect.top, 1, 1, FALSE);
            ::MoveWindow(hwnd, rect.right - 1, rect.bottom - 1, 1, 1, FALSE);
            ::MoveWindow(hwnd, rect.left, rect.top, rect.right - rect.left, rect.bottom - rect.top,
                         FALSE);
        };

        if (key == QStringLiteral("extra-margins")) {
            auto margins = qmargins2margins(attribute.value<QMargins>());
            return apis.pDwmExtendFrameIntoClientArea(hwnd, &margins) == S_OK;
            return SUCCEEDED(apis.pDwmExtendFrameIntoClientArea(hwnd, &margins));
        }

        if (key == QStringLiteral("dark-mode")) {
@@ -964,12 +989,9 @@
            } else {
                apis.pAllowDarkModeForApp(enable);
            }
            for (const auto attr : {
                     _DWMWA_USE_IMMERSIVE_DARK_MODE_BEFORE_20H1,
                     _DWMWA_USE_IMMERSIVE_DARK_MODE,
                 }) {
                apis.pDwmSetWindowAttribute(hwnd, attr, &enable, sizeof(enable));
            }
            const auto attr = isWin1020H1OrGreater() ? _DWMWA_USE_IMMERSIVE_DARK_MODE
                                                     : _DWMWA_USE_IMMERSIVE_DARK_MODE_BEFORE_20H1;
            apis.pDwmSetWindowAttribute(hwnd, attr, &enable, sizeof(enable));

            apis.pFlushMenuThemes();
            return true;
@@ -981,9 +1003,7 @@
                return false;
            }
            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);
                extendMargins();
                if (isWin1122H2OrGreater()) {
                    // Use official DWM API to enable Mica, available since Windows 11 22H2
                    // (10.0.22621).
@@ -1007,6 +1027,7 @@
                }
                restoreMargins();
            }
            effectBugWorkaround();
            return true;
        }

@@ -1015,9 +1036,7 @@
                return false;
            }
            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);
                extendMargins();
                // Use official DWM API to enable Mica Alt, available since Windows 11 22H2
                // (10.0.22621).
                const _DWM_SYSTEMBACKDROP_TYPE backdropType = _DWMSBT_TABBEDWINDOW;
@@ -1029,6 +1048,7 @@
                                            sizeof(backdropType));
                restoreMargins();
            }
            effectBugWorkaround();
            return true;
        }

@@ -1037,9 +1057,7 @@
                return false;
            }
            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);
                extendMargins();

                const _DWM_SYSTEMBACKDROP_TYPE backdropType = _DWMSBT_TRANSIENTWINDOW;
                apis.pDwmSetWindowAttribute(hwnd, _DWMWA_SYSTEMBACKDROP_TYPE, &backdropType,
@@ -1076,13 +1094,14 @@

                restoreMargins();
            }
            effectBugWorkaround();
            return true;
        }

        if (key == QStringLiteral("dwm-blur")) {
            // Extending window frame would break this effect for some unknown reason.
            restoreMargins();
            if (attribute.toBool()) {
                // We can't extend the window frame for this effect.
                restoreMargins();
                if (isWin8OrGreater()) {
                    ACCENT_POLICY policy{};
                    policy.dwAccentState = ACCENT_ENABLE_BLURBEHIND;
@@ -1115,6 +1134,7 @@
                    apis.pDwmEnableBlurBehindWindow(hwnd, &bb);
                }
            }
            effectBugWorkaround();
            return true;
        }
        return false;
@@ -1592,7 +1612,7 @@
                bool isInTitleBar = isInTitleBarDraggableArea(qtScenePos);
                WindowAgentBase::SystemButton sysButtonType = WindowAgentBase::Unknown;
                bool isInCaptionButtons = isInSystemButtons(qtScenePos, &sysButtonType);
                bool dontOverrideCursor = false; // ### TODO
                static constexpr bool dontOverrideCursor = false; // ### TODO

                if (isInCaptionButtons) {
                    // Firstly, we set the hit test result to a default value to be able to detect
@@ -2040,8 +2060,24 @@
        // implement an elaborate client-area preservation technique, and
        // simply return 0, which means "preserve the entire old client area
        // and align it with the upper-left corner of our new client area".

        const auto clientRect = wParam ? &(reinterpret_cast<LPNCCALCSIZE_PARAMS>(lParam))->rgrc[0]
                                       : reinterpret_cast<LPRECT>(lParam);
        [[maybe_unused]] const auto &flickerReducer = qScopeGuard([this]() {
            // When we receive this message, it means the window size has changed
            // already, and it seems this message always come before any client
            // area size notifications (eg. WM_WINDOWPOSCHANGED and WM_SIZE). Let
            // D3D/VK paint immediately to let user see the latest result as soon
            // as possible.
            const auto &isTargetSurface = [](const QSurface::SurfaceType st) {
                return st != QSurface::RasterSurface && st != QSurface::OpenGLSurface &&
                       st != QSurface::RasterGLSurface && st != QSurface::OpenVGSurface;
            };
            if (m_windowHandle && isTargetSurface(m_windowHandle->surfaceType()) &&
                isDwmCompositionEnabled() && DynamicApis::instance().pDwmFlush) {
                DynamicApis::instance().pDwmFlush();
            }
        });
        if (isSystemBorderEnabled()) {
            // Store the original top margin before the default window procedure applies the
            // default frame.
@@ -2163,8 +2199,6 @@
                }
            }
        }
        // We should call this function only before the function returns.
        syncPaintEventWithDwm();
        // By returning WVR_REDRAW we can make the window resizing look
        // less broken. But we must return 0 if wParam is FALSE, according to Microsoft
        // Docs.