kwin/src/placementtracker.cpp

/*
    KWin - the KDE window manager
    This file is part of the KDE project.

    SPDX-FileCopyrightText: 2022 Xaver Hugl <xaver.hugl@gmail.com>

    SPDX-License-Identifier: GPL-2.0-or-later
*/
#include "placementtracker.h"
#include "output.h"
#include "platform.h"
#include "window.h"
#include "workspace.h"

namespace KWin
{

PlacementTracker::PlacementTracker(Workspace *workspace)
    : m_workspace(workspace)
{
}

PlacementTracker::WindowData PlacementTracker::dataForWindow(Window *window) const
{
    return WindowData{
        .outputUuid = workspace()->outputAt(window->moveResizeGeometry().center())->uuid(),
        .geometry = window->moveResizeGeometry(),
        .maximize = window->requestedMaximizeMode(),
        .quickTile = window->quickTileMode(),
        .geometryRestore = window->geometryRestore(),
        .fullscreen = window->isFullScreen(),
        .fullscreenGeometryRestore = window->fullscreenGeometryRestore(),
        .interactiveMoveResizeCount = window->interactiveMoveResizeCount(),
    };
}

void PlacementTracker::add(Window *window)
{
    if (window->isUnmanaged() || window->isAppletPopup() || window->isSpecialWindow()) {
        return;
    }
    connect(window, &Window::frameGeometryChanged, this, &PlacementTracker::saveGeometry);
    connect(window, qOverload<Window *, MaximizeMode>(&Window::clientMaximizedStateChanged), this, &PlacementTracker::saveMaximize);
    connect(window, &Window::quickTileModeChanged, this, &PlacementTracker::saveQuickTile);
    connect(window, &Window::fullScreenChanged, this, &PlacementTracker::saveFullscreen);
    connect(window, &Window::clientFinishUserMovedResized, this, &PlacementTracker::saveInteractionCounter);
    WindowData data = dataForWindow(window);
    m_data[m_currentKey][window] = data;
    m_lastRestoreData[window] = data;
    m_savedWindows.push_back(window);
}

void PlacementTracker::remove(Window *window)
{
    if (m_savedWindows.contains(window)) {
        disconnect(window, &Window::frameGeometryChanged, this, &PlacementTracker::saveGeometry);
        disconnect(window, qOverload<Window *, MaximizeMode>(&Window::clientMaximizedStateChanged), this, &PlacementTracker::saveMaximize);
        disconnect(window, &Window::quickTileModeChanged, this, &PlacementTracker::saveQuickTile);
        disconnect(window, &Window::fullScreenChanged, this, &PlacementTracker::saveFullscreen);
        disconnect(window, &Window::clientFinishUserMovedResized, this, &PlacementTracker::saveInteractionCounter);
        for (auto &dataMap : m_data) {
            dataMap.remove(window);
        }
        m_lastRestoreData.remove(window);
        m_savedWindows.removeOne(window);
    }
}

void PlacementTracker::restore(const QString &key)
{
    if (key == m_currentKey) {
        return;
    }
    auto &dataMap = m_data[key];
    auto &oldDataMap = m_data[m_currentKey];
    const auto outputs = m_workspace->outputs();

    inhibit();
    for (const auto window : std::as_const(m_savedWindows)) {
        bool restore = true;
        if (auto lastRestoreData = m_lastRestoreData.constFind(window); lastRestoreData != m_lastRestoreData.constEnd()) {
            // don't touch windows where the user intentionally changed their state
            restore = window->interactiveMoveResizeCount() == lastRestoreData->interactiveMoveResizeCount
                && window->requestedMaximizeMode() == lastRestoreData->maximize
                && window->quickTileMode() == lastRestoreData->quickTile
                && window->isFullScreen() == lastRestoreData->fullscreen;
            if (!restore) {
                // restore anyways if the output the window was on got removed
                if (const auto oldData = oldDataMap.find(window); oldData != oldDataMap.end()) {
                    restore |= std::none_of(outputs.begin(), outputs.end(), [&oldData](const auto output) {
                        return output->uuid() == oldData->outputUuid;
                    });
                }
            }
        }
        if (restore) {
            const auto it = dataMap.find(window);
            if (it != dataMap.end()) {
                const WindowData &newData = it.value();
                window->setFullScreen(false);
                window->setQuickTileMode(QuickTileFlag::None, true);
                window->setMaximize(false, false);
                if (newData.quickTile || newData.maximize) {
                    window->moveResize(newData.geometryRestore);
                    window->setQuickTileMode(newData.quickTile, true);
                    window->setMaximize(newData.maximize & MaximizeMode::MaximizeVertical, newData.maximize & MaximizeMode::MaximizeHorizontal);
                }
                if (newData.fullscreen) {
                    window->moveResize(newData.fullscreenGeometryRestore);
                    window->setFullScreen(newData.fullscreen);
                }
                if (newData.quickTile || newData.maximize || newData.fullscreen) {
                    // restore geometry isn't necessarily on the output the window was, so explicitly restore it
                    const auto outputIt = std::find_if(outputs.begin(), outputs.end(), [&newData](const auto output) {
                        return output->uuid() == newData.outputUuid;
                    });
                    if (outputIt != outputs.end()) {
                        window->sendToOutput(*outputIt);
                    }
                } else {
                    window->moveResize(newData.geometry);
                }
            }
            // if the window got restored or would've been restored if data was available,
            // make sure the current state counts as being not touched by the user
            m_lastRestoreData[window] = dataForWindow(window);
        }
        // ensure data in current map is always up to date
        dataMap[window] = dataForWindow(window);
    }
    uninhibit();
    m_currentKey = key;
}

void PlacementTracker::init(const QString &key)
{
    m_currentKey = key;
}

void PlacementTracker::saveGeometry(Window *window)
{
    if (m_inhibitCount == 0) {
        auto &data = m_data[m_currentKey][window];
        data.geometry = window->moveResizeGeometry();
        data.outputUuid = workspace()->outputAt(window->moveResizeGeometry().center())->uuid();
    }
}

void PlacementTracker::saveInteractionCounter(Window *window)
{
    if (m_inhibitCount == 0) {
        m_data[m_currentKey][window].interactiveMoveResizeCount = window->interactiveMoveResizeCount();
    }
}

void PlacementTracker::saveMaximize(Window *window, MaximizeMode mode)
{
    if (m_inhibitCount == 0) {
        auto &data = m_data[m_currentKey][window];
        data.maximize = mode;
        data.geometryRestore = window->geometryRestore();
    }
}

void PlacementTracker::saveQuickTile()
{
    Window *window = qobject_cast<Window *>(QObject::sender());
    Q_ASSERT(window);
    if (m_inhibitCount == 0) {
        auto &data = m_data[m_currentKey][window];
        data.quickTile = window->quickTileMode();
        data.geometryRestore = window->geometryRestore();
    }
}

void PlacementTracker::saveFullscreen()
{
    Window *window = qobject_cast<Window *>(QObject::sender());
    Q_ASSERT(window);
    if (m_inhibitCount == 0) {
        auto &data = m_data[m_currentKey][window];
        data.fullscreen = window->isFullScreen();
        data.fullscreenGeometryRestore = window->fullscreenGeometryRestore();
    }
}

void PlacementTracker::inhibit()
{
    m_inhibitCount++;
}

void PlacementTracker::uninhibit()
{
    Q_ASSERT(m_inhibitCount > 0);
    m_inhibitCount--;
}
}