path: root/src/manager-lib/qmlinprocapplicationmanagerwindowimpl.cpp

// Copyright (C) 2023 The Qt Company Ltd.
// Copyright (C) 2019 Luxoft Sweden AB
// Copyright (C) 2018 Pelagicore AG
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only

#include <memory>

#include <QQuickWindow>
#include <QScopedValueRollback>
#include <QtQuick/private/qquickitem_p.h>
#include <QtQuick/private/qquickevents_p_p.h>

#include "logging.h"
#include "qml-utilities.h"
#include "applicationmanagerwindow.h"
#include "qmlinprocapplicationmanagerwindowimpl.h"
#include "inprocesssurfaceitem.h"
#include "qmlinprocruntime.h"
#include <private/qqmlcomponentattached_p.h>


QT_BEGIN_NAMESPACE_AM

QVector<QmlInProcApplicationManagerWindowImpl *> QmlInProcApplicationManagerWindowImpl::s_inCompleteWindows;

QmlInProcApplicationManagerWindowImpl::QmlInProcApplicationManagerWindowImpl(ApplicationManagerWindow *window)
    : ApplicationManagerWindowImpl(window)
    , m_surfaceItem(new InProcessSurfaceItem)
{
    m_surfaceItem->setApplicationManagerWindow(window);
    m_surfaceItem->setColor(QColorConstants::White);

    QObject::connect(m_surfaceItem.data(), &QQuickItem::widthChanged,
                     window, &ApplicationManagerWindow::widthChanged);

    QObject::connect(m_surfaceItem.data(), &QQuickItem::heightChanged,
                     window, &ApplicationManagerWindow::heightChanged);

    QObject::connect(m_surfaceItem.data(), &InProcessSurfaceItem::windowPropertyChanged,
                     window, &ApplicationManagerWindow::windowPropertyChanged);

    QObject::connect(m_surfaceItem.data(), &InProcessSurfaceItem::closeRequested,
                     window, &ApplicationManagerWindow::close);

    auto connectWindowSignals = [this, window](QQuickWindow *qwindow) {
        if (!qwindow)
            return;

        connectActiveFocusItem();

        // pass-through signals from the actual QQuickWindow
        QObject::connect(qwindow, &QQuickWindow::frameSwapped,
                         window, &ApplicationManagerWindow::frameSwapped);
        QObject::connect(qwindow, &QQuickWindow::afterAnimating,
                         window, &ApplicationManagerWindow::afterAnimating);
        QObject::connect(qwindow, &QQuickWindow::sceneGraphError,
                         window, &ApplicationManagerWindow::sceneGraphError);
    };

    connectWindowSignals(m_surfaceItem->window());

    QObject::connect(m_surfaceItem.data(), &InProcessSurfaceItem::windowChanged,
                     window, connectWindowSignals);
}
void QmlInProcApplicationManagerWindowImpl::connectActiveFocusItem()
{
    QObject::disconnect(m_activeFocusItemConnection);

    if (m_surfaceItem->window()) {
        // We can only track the AFI of our Window directly, but we keep a pointer to the AFI,
        // if it is a child of our InProcessSurfaceItem

        m_activeFocusItemConnection = QObject::connect(m_surfaceItem->window(), &QQuickWindow::activeFocusItemChanged,
                                                       amWindow(), [this]() {
            auto *afi = m_surfaceItem->window() ? m_surfaceItem->window()->activeFocusItem()
                                                : nullptr;
            if (afi) {
                bool found = false;
                QQuickItem *p = afi->parentItem();
                while (p) {
                    if (p == m_surfaceItem) {
                        found = true;
                        break;
                    }
                    p = p->parentItem();
                }
                if (!found)
                    afi = nullptr;
            }
            if (afi != m_activeFocusItem) {
                bool activeChanged = (bool(afi) != bool(m_activeFocusItem));
                m_activeFocusItem = afi;

                if (activeChanged)
                    emit amWindow()->activeChanged();
                emit amWindow()->activeFocusItemChanged();
            }
        });
    }
}

QmlInProcApplicationManagerWindowImpl::~QmlInProcApplicationManagerWindowImpl()
{
    m_surfaceItem->setDeadClientSide();
}

bool QmlInProcApplicationManagerWindowImpl::isSingleProcess() const
{
    return true;
}

QObject *QmlInProcApplicationManagerWindowImpl::backingObject() const
{
    return m_surfaceItem.get();
}

void QmlInProcApplicationManagerWindowImpl::close()
{
    if (m_closing)
        return;
    QScopedValueRollback<bool> rollback(m_closing, true);

    for (const auto &child: std::as_const(m_childWindows))
        child->close();

    auto ce = std::make_unique<QQuickCloseEvent>();
    emit amWindow()->closing(ce.get());

    if (ce->isAccepted()) {
        setVisible(false);
        m_surfaceItem->setClosed(true);
        if (m_runtime) {
            // Queued because the runtime might end up deleting this object
            QMetaObject::invokeMethod(m_runtime, &QmlInProcRuntime::stopIfLastWindowClosed, Qt::QueuedConnection);
        }
    }
}

QWindow::Visibility QmlInProcApplicationManagerWindowImpl::visibility() const
{
    return m_visibility;
}

void QmlInProcApplicationManagerWindowImpl::setVisibility(QWindow::Visibility newVisibility)
{
    // copied from qwindow.cpp:
    switch (newVisibility) {
    case QWindow::Hidden:
        hide();
        break;
    case QWindow::AutomaticVisibility:
        show();
        break;
    case QWindow::Windowed:
        showNormal();
        break;
    case QWindow::Minimized:
        showMinimized();
        break;
    case QWindow::Maximized:
        showMaximized();
        break;
    case QWindow::FullScreen:
        showFullScreen();
        break;
    default:
        Q_ASSERT(false);
    }
}

void QmlInProcApplicationManagerWindowImpl::updateVisibility(QWindow::Visibility newVisibility)
{
    if (m_visibility != newVisibility) {
        m_visibility = newVisibility;
        emit amWindow()->visibilityChanged(m_visibility);
    }
}

void QmlInProcApplicationManagerWindowImpl::hide()
{
    amWindow()->setVisible(false);
    updateVisibility(QWindow::Hidden);
}

void QmlInProcApplicationManagerWindowImpl::show()
{
    showNormal();
}

void QmlInProcApplicationManagerWindowImpl::showFullScreen()
{
    amWindow()->setVisible(true);
    updateVisibility(QWindow::FullScreen);
}

void QmlInProcApplicationManagerWindowImpl::showMinimized()
{
    amWindow()->setVisible(true);
    updateVisibility(QWindow::Minimized);
}

void QmlInProcApplicationManagerWindowImpl::showMaximized()
{
    amWindow()->setVisible(true);
    updateVisibility(QWindow::Maximized);
}

void QmlInProcApplicationManagerWindowImpl::showNormal()
{
    amWindow()->setVisible(true);
    updateVisibility(QWindow::Windowed);
}

bool QmlInProcApplicationManagerWindowImpl::setWindowProperty(const QString &name, const QVariant &value)
{
    return m_surfaceItem->setWindowProperty(name, value);
}

QVariant QmlInProcApplicationManagerWindowImpl::windowProperty(const QString &name) const
{
    return m_surfaceItem->windowProperty(name);
}

QVariantMap QmlInProcApplicationManagerWindowImpl::windowProperties() const
{
    return m_surfaceItem->windowPropertiesAsVariantMap();
}

void QmlInProcApplicationManagerWindowImpl::classBegin()
{ }

void QmlInProcApplicationManagerWindowImpl::componentComplete()
{
    ensureCurrentContextIsInProcessApplication(amWindow());

    if (!m_runtime)
        m_runtime = QmlInProcRuntime::determineRuntime(amWindow());

    findParentWindow(amWindow()->parent());

    // This part is scary, but we need to make sure that all Component.onComplete: handlers on
    // the QML side have been run, before we hand this window over to the WindowManager to emit the
    // windowAdded signal. The problem here is that the C++ componentComplete() handler (this
    // function) is called *before* the QML side, plus, to make matters worse, the QML incubator
    // could switch back to the event loop a couple of times before finally calling the QML
    // onCompleted handler(s).
    // The workaround is to setup watchers for all Component.onCompleted handlers for this object
    // and wait until the last of them has been dealt with, to finally call our addSurfaceItem
    // function (we are also relying on the signal emission order, so that our lambda is called
    // after the actual QML handler).
    // We also make sure that onWindowAdded is called in the same order, as this function is
    // called, so we don't depend on the existence of onCompleted handlers (and conform to multi-
    // process mode; there is no guarantee though, since multi-process is inherently asynchronous).

    for (auto a = QQmlComponent::qmlAttachedProperties(amWindow()); a; a = a->next()) {
        auto appWindow = qobject_cast<ApplicationManagerWindow *>(a->parent());
        if (!appWindow || appWindow != amWindow())
            continue;

        m_attachedCompleteHandlers << a;

        QObject::connect(a, &QQmlComponentAttached::completed, amWindow(), [this, a]() {
            m_attachedCompleteHandlers.removeAll(a);

            if (m_attachedCompleteHandlers.isEmpty()) {
                for (auto it = s_inCompleteWindows.cbegin(); it != s_inCompleteWindows.cend(); ) {
                    QmlInProcApplicationManagerWindowImpl *win = *it;
                    if (win->m_attachedCompleteHandlers.isEmpty()) {
                        it = s_inCompleteWindows.erase(it); // clazy:exclude=strict-iterators
                        win->notifyRuntimeAboutSurface();
                    } else {
                        break;
                    }

                }
            }
        });
    }

    // If we do not even have a single Component.onCompleted handler on the QML side and no
    // previous window is waiting for onCompleted, we need to show the window immediately.
    // Otherwise we save this window and process it later in the lambda above, in the same order as
    // this function is called.
    if (m_attachedCompleteHandlers.isEmpty() && s_inCompleteWindows.isEmpty())
        notifyRuntimeAboutSurface();
    else
        s_inCompleteWindows << this;
}

void QmlInProcApplicationManagerWindowImpl::notifyRuntimeAboutSurface()
{
    if (!m_runtime)
        return;

    if (isVisible() && m_attachedCompleteHandlers.isEmpty() && (!m_parentWindow || m_parentWindow->isVisible()))
        m_runtime->addSurfaceItem(m_surfaceItem);
}

QQuickItem *QmlInProcApplicationManagerWindowImpl::contentItem()
{
    return m_surfaceItem.data();
}

void QmlInProcApplicationManagerWindowImpl::findParentWindow(QObject *object)
{
    if (!object)
        return;

    auto surfaceItem = qobject_cast<InProcessSurfaceItem *>(object);
    if (surfaceItem) {
        setRelations(surfaceItem->applicationManagerWindow());
    } else {
        if (auto window = qobject_cast<ApplicationManagerWindow *>(object))
            setRelations(window);
        else
            findParentWindow(object->parent());
    }
}

void QmlInProcApplicationManagerWindowImpl::setRelations(ApplicationManagerWindow *newParentWindow)
{
    // Only static window hieararchy supported
    Q_ASSERT(!m_parentWindow && !m_parentVisibleConnection);

    m_parentWindow = newParentWindow;

    if (m_parentWindow) {
        static_cast<QmlInProcApplicationManagerWindowImpl*>
            (m_parentWindow->implementation())->m_childWindows.append(amWindow());
        m_parentVisibleConnection = QObject::connect(
            m_parentWindow, &ApplicationManagerWindow::visibleChanged,
            amWindow(), [this]() { notifyRuntimeAboutSurface(); });
    }
}

void QmlInProcApplicationManagerWindowImpl::setTitle(const QString &title)
{
    if (m_title != title) {
        m_title = title;
        emit amWindow()->titleChanged();
    }
}

void QmlInProcApplicationManagerWindowImpl::setX(int x)
{
    if (m_x != x) {
        m_x = x;
        emit amWindow()->xChanged();
    }
}

void QmlInProcApplicationManagerWindowImpl::setY(int y)
{
    if (m_y != y) {
        m_y = y;
        emit amWindow()->yChanged();
    }
}

int QmlInProcApplicationManagerWindowImpl::width() const
{
    return int(m_surfaceItem->width());
}

void QmlInProcApplicationManagerWindowImpl::setWidth(int w)
{
    m_surfaceItem->setWidth(qBound(m_minimumWidth, w, m_maximumWidth));
}

int QmlInProcApplicationManagerWindowImpl::height() const
{
    return int(m_surfaceItem->height());
}

void QmlInProcApplicationManagerWindowImpl::setHeight(int h)
{
    m_surfaceItem->setHeight(qBound(m_minimumHeight, h, m_maximumHeight));
}

void QmlInProcApplicationManagerWindowImpl::setMinimumWidth(int minw)
{
    if ((minw < 0) || (minw > WindowSizeMax))
        return;

    if (m_minimumWidth != minw) {
        m_minimumWidth = minw;
        emit amWindow()->minimumWidthChanged();
        if (width() < minw)
            setWidth(minw);
    }
}

void QmlInProcApplicationManagerWindowImpl::setMinimumHeight(int minh)
{
    if ((minh < 0) || (minh > WindowSizeMax))
        return;

    if (m_minimumHeight != minh) {
        m_minimumHeight = minh;
        emit amWindow()->minimumHeightChanged();
        if (height() < minh)
            setHeight(minh);
    }
}

void QmlInProcApplicationManagerWindowImpl::setMaximumWidth(int maxw)
{
    if ((maxw < 0) || (maxw > WindowSizeMax))
        return;

    if (m_maximumWidth != maxw) {
        m_maximumWidth = maxw;
        emit amWindow()->maximumWidthChanged();
        if (width() > maxw)
            setWidth(maxw);
    }
}

void QmlInProcApplicationManagerWindowImpl::setMaximumHeight(int maxh)
{
    if ((maxh < 0) || (maxh > WindowSizeMax))
        return;

    if (m_maximumHeight != maxh) {
        m_maximumHeight = maxh;
        emit amWindow()->maximumHeightChanged();
        if (height() > maxh)
            setHeight(maxh);
    }
}

bool QmlInProcApplicationManagerWindowImpl::isVisible() const
{
    return m_surfaceItem->visibleClientSide();
}

void QmlInProcApplicationManagerWindowImpl::setVisible(bool visible)
{
    if (visible != m_surfaceItem->visibleClientSide()) {
        m_surfaceItem->setVisibleClientSide(visible);
        emit amWindow()->visibleChanged();
        notifyRuntimeAboutSurface();
    }
}

void QmlInProcApplicationManagerWindowImpl::setOpacity(qreal opacity)
{
    if (!qFuzzyCompare(m_opacity, opacity)) {
        m_opacity = opacity;
        emit amWindow()->opacityChanged();
    }
}

QColor QmlInProcApplicationManagerWindowImpl::color() const
{
    return m_surfaceItem->color();
}

void QmlInProcApplicationManagerWindowImpl::setColor(const QColor &c)
{
    if (color() != c) {
        m_surfaceItem->setColor(c);
        emit amWindow()->colorChanged();
    }
}

bool QmlInProcApplicationManagerWindowImpl::isActive() const
{
    return (m_activeFocusItem);
}

QQuickItem *QmlInProcApplicationManagerWindowImpl::activeFocusItem() const
{
    return m_activeFocusItem;
}


///////////////////////////////////////////////////////////////////////////////////////////////////
// ApplicationManagerWindowAttached
///////////////////////////////////////////////////////////////////////////////////////////////////


QmlInProcApplicationManagerWindowAttachedImpl::QmlInProcApplicationManagerWindowAttachedImpl(ApplicationManagerWindowAttached *windowAttached, QQuickItem *attacheeItem)
    : ApplicationManagerWindowAttachedImpl(windowAttached, attacheeItem)
{ }

ApplicationManagerWindow *QmlInProcApplicationManagerWindowAttachedImpl::findApplicationManagerWindow()
{
    if (!attacheeItem())
        return nullptr;

    auto ipsurface = findInProcessSurfaceItem();
    return ipsurface ? ipsurface->applicationManagerWindow() : nullptr;
}

InProcessSurfaceItem *QmlInProcApplicationManagerWindowAttachedImpl::findInProcessSurfaceItem()
{
    // Connect to all parent items' parentChanged() signals, up to root or an InProcessSurfaceItem.
    // If one of them changes, disconnect all parentChanged connections, then find the new
    // InProcessSurfaceItem and re-connect.

    for (const auto &connection : std::as_const(m_parentChangeConnections))
        QObject::disconnect(connection);

    InProcessSurfaceItem *ipsurface = nullptr;
    QQuickItem *p = attacheeItem();
    while (p && !ipsurface) {
        ipsurface = qobject_cast<InProcessSurfaceItem *>(p);
        if (!ipsurface) {
            m_parentChangeConnections << QObject::connect(p, &QQuickItem::parentChanged,
                                                          amWindowAttached(), [this]() { onParentChanged(); });
        }
        p = p->parentItem();
    }
    return ipsurface;
}

void QmlInProcApplicationManagerWindowAttachedImpl::onParentChanged()
{
    InProcessSurfaceItem *ipsurface = findInProcessSurfaceItem();

    if (!amWindowAttached()->window()
            || (ipsurface != amWindowAttached()->window()->backingObject())) {
        onWindowChanged(ipsurface ? ipsurface->applicationManagerWindow() : nullptr);
    }
}

QT_END_NAMESPACE_AM