Make hit-test items auto-delete

Sine Striker

2024-07-28 e9d163b1a811ee4f02e898bc7c2e6336d88e4a7f

 src/core/contexts/abstractwindowcontext.cpp

@@ -7,54 +7,10 @@
#include <QtGui/QPen>
#include <QtGui/QPainter>
#include <QtGui/QScreen>
#include <memory>

#include "qwkglobal_p.h"

namespace QWK {

    namespace {

        class WinIdChangeEventFilter : public QObject {
        public:
            explicit WinIdChangeEventFilter(QObject *widget, AbstractWindowContext *ctx,
                                            QObject *parent = nullptr)
                : QObject(parent), ctx(ctx) {
                widget->installEventFilter(this);
            }

        protected:
            bool eventFilter(QObject *obj, QEvent *event) override {
                Q_UNUSED(obj)
                if (event->type() == QEvent::WinIdChange) {
                    ctx->notifyWinIdChange();
                }
                return false;
            }

        protected:
            AbstractWindowContext *ctx;
        };

        class WindowEventFilter : public QObject {
        public:
            explicit WindowEventFilter(QWindow *window, AbstractWindowContext *ctx,
                                       QObject *parent = nullptr)
                : QObject(parent), ctx(ctx), window(window) {
                window->installEventFilter(this);
            }

        protected:
            bool eventFilter(QObject *obj, QEvent *event) override {
                return ctx->sharedDispatch(obj, event);
            }

        protected:
            AbstractWindowContext *ctx;
            QWindow *window;
        };

    }

    AbstractWindowContext::AbstractWindowContext() = default;

@@ -66,27 +22,31 @@
        }
        m_host = host;
        m_delegate.reset(delegate);
        m_winIdChangeEventFilter = std::make_unique<WinIdChangeEventFilter>(host, this);

        m_windowHandle = m_delegate->hostWindow(m_host);
        if (m_windowHandle) {
            winIdChanged();
            m_windowEventFilter = std::make_unique<WindowEventFilter>(m_windowHandle, this);
        }
        m_winIdChangeEventFilter.reset(delegate->createWinIdEventFilter(host, this));
        notifyWinIdChange();
    }



    bool AbstractWindowContext::setHitTestVisible(const QObject *obj, bool visible) {
    bool AbstractWindowContext::setHitTestVisible(QObject *obj, bool visible) {
        Q_ASSERT(obj);
        if (!obj) {
            return false;
        }

        auto it = m_hitTestVisibleItems.find(obj);
        if (visible) {
            if (it != m_hitTestVisibleItems.end()) {
                return true;
            }
            connect(obj, &QObject::destroyed, this,
                    &AbstractWindowContext::_q_hitTestVisibleItemDestroyed);
            m_hitTestVisibleItems.insert(obj);
        } else {
            m_hitTestVisibleItems.remove(obj);
            if (it == m_hitTestVisibleItems.end()) {
                return false;
            }
            disconnect(obj, &QObject::destroyed, this,
                       &AbstractWindowContext::_q_hitTestVisibleItemDestroyed);
            m_hitTestVisibleItems.erase(it);
        }
        return true;
    }
@@ -98,8 +58,18 @@
            return false;
        }

        if (m_systemButtons[button] == obj) {
            return false;
        auto org = m_systemButtons[button];
        if (org == obj) {
            return true;
        }

        if (org) {
            disconnect(org, &QObject::destroyed, this,
                       &AbstractWindowContext::_q_systemButtonDestroyed);
        }
        if (obj) {
            connect(obj, &QObject::destroyed, this,
                    &AbstractWindowContext::_q_systemButtonDestroyed);
        }
        m_systemButtons[button] = obj;
        return true;
@@ -107,18 +77,20 @@

    bool AbstractWindowContext::setTitleBar(QObject *item) {
        Q_ASSERT(item);
        if (m_titleBar == item) {
        auto org = m_titleBar;
        if (org == item) {
            return false;
        }

        if (m_titleBar) {
        if (org) {
            // Since the title bar is changed, all items inside it should be dereferenced right away
            for (auto &button : m_systemButtons) {
                button = nullptr;
            }
            m_hitTestVisibleItems.clear();
            removeSystemButtonsAndHitTestItems();
            disconnect(org, &QObject::destroyed, this,
                       &AbstractWindowContext::_q_titleBarDistroyed);
        }

        if (item) {
            connect(item, &QObject::destroyed, this, &AbstractWindowContext::_q_titleBarDistroyed);
        }
        m_titleBar = item;
        return true;
    }
@@ -202,7 +174,7 @@
    void AbstractWindowContext::virtual_hook(int id, void *data) {
        switch (id) {
            case CentralizeHook: {
                if (!m_windowHandle)
                if (!m_windowId)
                    return;

                QRect windowGeometry = m_delegate->getGeometry(m_host);
@@ -216,7 +188,7 @@
            }

            case RaiseWindowHook: {
                if (!m_windowHandle)
                if (!m_windowId)
                    return;

                m_delegate->setWindowVisible(m_host, true);
@@ -248,14 +220,24 @@
    }

    void AbstractWindowContext::notifyWinIdChange() {
        auto oldWindow = m_windowHandle;
        m_windowHandle = m_delegate->hostWindow(m_host);
        if (oldWindow == m_windowHandle)
            return;
        m_windowEventFilter.reset();
        winIdChanged();
        auto oldWinId = m_windowId;
        m_windowId = m_winIdChangeEventFilter->winId();

        // In Qt6, after QWidget::close() is called, the related QWindow's all surfaces and the
        // platform window will be removed, and the WinId will be set to 0. After that, when the
        // QWidget is shown again, the whole things will be recreated again.
        // As a result, we must update our WindowContext each time the WinId changes.
        if (m_windowHandle) {
            m_windowEventFilter = std::make_unique<WindowEventFilter>(m_windowHandle, this);
            removeEventFilter(m_windowHandle);
        }
        m_windowHandle = m_delegate->hostWindow(m_host);

        if (oldWinId != m_windowId) {
            winIdChanged(m_windowId, oldWinId);
        }

        if (m_windowHandle) {
            m_windowHandle->installEventFilter(this);

            // Refresh window attributes
            auto attributes = m_windowAttributes;
@@ -266,6 +248,12 @@
                }
                m_windowAttributes.insert(it.key(), it.value());
            }
        }

        // Send to shared dispatchers
        if (oldWinId != m_windowId) {
            QEvent e(QEvent::WinIdChange);
            sharedDispatch(m_host, &e);
        }
    }

@@ -300,10 +288,51 @@
        return true;
    }

    bool AbstractWindowContext::eventFilter(QObject *obj, QEvent *event) {
        if (obj == m_windowHandle && sharedDispatch(obj, event)) {
            return true;
        }
        return QObject::eventFilter(obj, event);
    }

    bool AbstractWindowContext::windowAttributeChanged(const QString &key,
                                                       const QVariant &attribute,
                                                       const QVariant &oldAttribute) {
        return false;
    }

    void AbstractWindowContext::removeSystemButtonsAndHitTestItems() {
        for (auto &button : m_systemButtons) {
            if (!button) {
                continue;
            }
            disconnect(button, &QObject::destroyed, this,
                       &AbstractWindowContext::_q_systemButtonDestroyed);
            button = nullptr;
        }
        for (auto &item : m_hitTestVisibleItems) {
            disconnect(item, &QObject::destroyed, this,
                       &AbstractWindowContext::_q_hitTestVisibleItemDestroyed);
        }
        m_hitTestVisibleItems.clear();
    }

    void AbstractWindowContext::_q_titleBarDistroyed(QObject *obj) {
        Q_UNUSED(obj)
        removeSystemButtonsAndHitTestItems();
        m_titleBar = nullptr;
    }

    void AbstractWindowContext::_q_hitTestVisibleItemDestroyed(QObject *obj) {
        m_hitTestVisibleItems.remove(obj);
    }

    void AbstractWindowContext::_q_systemButtonDestroyed(QObject *obj) {
        for (auto &item : m_systemButtons) {
            if (item == obj) {
                item = nullptr;
            }
        }
    }

}