ScreenContextTracker.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2026 fuddlesworth
// SPDX-License-Identifier: LGPL-2.1-or-later
 
#pragma once
 
#include <phosphorengine_export.h>
#include <PhosphorEngine/EngineTypes.h>
 
#include <functional>
 
#include <QHash>
#include <QString>
 
namespace PhosphorEngine {
 
struct ContextChange
{
    bool changed = false;
    bool armSwitch = false;
};
 
class PHOSPHORENGINE_EXPORT ScreenContextTracker
{
public:
    ScreenContextTracker() = default;
 
    PlacementStateKey currentKeyForScreen(const QString& screenId) const;
 
    // ── Getters ──────────────────────────────────────────────────────────────
    int currentDesktop() const noexcept
    {
        return m_currentDesktop;
    }
    const QString& currentActivity() const noexcept
    {
        return m_currentActivity;
    }
    bool desktopContextEverSet() const noexcept
    {
        return m_desktopContextEverSet;
    }
    bool activityContextEverSet() const noexcept
    {
        return m_activityContextEverSet;
    }
    int screenDesktop(const QString& screenId) const
    {
        return m_screenCurrentDesktop.value(screenId, m_currentDesktop);
    }
 
    // ── Context mutators ─────────────────────────────────────────────────────
    ContextChange setCurrentDesktop(int desktop);
    ContextChange setCurrentDesktopForScreen(const QString& screenId, int desktop);
    void clearCurrentDesktopForScreen(const QString& screenId)
    {
        m_screenCurrentDesktop.remove(screenId);
    }
    ContextChange setCurrentActivity(const QString& activity);
 
    // ── Sticky-pin override (m_screenDesktopOverride) ────────────────────────
    bool hasStickyPin(const QString& screenId) const
    {
        return m_screenDesktopOverride.contains(screenId);
    }
    void setStickyPin(const QString& screenId, int desktop)
    {
        if (desktop < 1) {
            return;
        }
        m_screenDesktopOverride.insert(screenId, desktop);
    }
    int stickyPinnedDesktop(const QString& screenId) const
    {
        return m_screenDesktopOverride.value(screenId, 0);
    }
    int takeStickyPin(const QString& screenId)
    {
        return m_screenDesktopOverride.take(screenId);
    }
 
    // ── Bulk per-screen cleanup ──────────────────────────────────────────────
    void removeScreen(const QString& screenId)
    {
        m_screenDesktopOverride.remove(screenId);
        m_screenCurrentDesktop.remove(screenId);
    }
    void releaseScreenOwnership(const QString& screenId)
    {
        m_screenDesktopOverride.remove(screenId);
    }
    void removeScreensIf(const std::function<bool(const QString&)>& pred);
    void pruneDesktop(int removedDesktop);
 
private:
    int m_currentDesktop = 1;
    QString m_currentActivity;
    bool m_desktopContextEverSet = false;
    bool m_activityContextEverSet = false;
 
    QHash<QString, int> m_screenDesktopOverride;
 
    QHash<QString, int> m_screenCurrentDesktop;
};
 
} // namespace PhosphorEngine