DecorationManager.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2026 fuddlesworth
// SPDX-License-Identifier: LGPL-2.1-or-later
 
#pragma once
 
#include <phosphorcompositor_export.h>
 
#include <PhosphorCompositor/ICompositorBridge.h>
 
#include <QHash>
#include <QObject>
#include <QPointer>
#include <QSet>
#include <QString>
#include <QVector>
 
#include <functional>
#include <memory>
#include <optional>
 
class QTimer;
 
namespace PhosphorCompositor {
 
class PHOSPHORCOMPOSITOR_EXPORT DecorationManager : public QObject
{
    Q_OBJECT
 
public:
    enum class OwnerKind {
        Autotile,
        Snap,
        Rule
    };
 
    struct Owner
    {
        OwnerKind kind;
        QString screenId;
        bool operator==(const Owner&) const = default;
    };
    static Owner autotile(const QString& screenId)
    {
        return {OwnerKind::Autotile, screenId};
    }
    static Owner snap(const QString& screenId)
    {
        return {OwnerKind::Snap, screenId};
    }
    static Owner rule()
    {
        return {OwnerKind::Rule, QString()};
    }
 
    enum class Placement {
        CallerWillPlace,
        AlreadyPlaced,
    };
 
    enum class Restore {
        Immediate, 
        Deferred, 
    };
 
    explicit DecorationManager(ICompositorBridge& bridge, QObject* parent = nullptr);
    ~DecorationManager() override;
 
    // ── Ownership ──────────────────────────────────────────────────────
    void acquire(const QString& windowId, const Owner& owner, Placement placement = Placement::AlreadyPlaced);
    void release(const QString& windowId, const Owner& owner, Restore restore = Restore::Immediate);
    void releaseKind(const QString& windowId, OwnerKind kind, Restore restore = Restore::Immediate);
    void releaseOthersOfKind(const QString& windowId, OwnerKind kind, const QString& keepScreenId);
 
    // ── Bulk operations ────────────────────────────────────────────────
    void releaseAllOfKind(OwnerKind kind, Restore restore = Restore::Immediate);
    void restoreAll();
    void forgetWindow(const QString& windowId);
 
    // ── Window-rule layer (tri-state) ──────────────────────────────────
    void setRuleOverride(const QString& windowId, std::optional<bool> ruleValue);
    void clearAllRuleOverrides();
 
    // ── Deferred restore drain ─────────────────────────────────────────
    void drainPendingRestores();
    void setFallbackIntervalForTesting(int ms);
    void setRestoreVeto(std::function<bool(const QString& windowId)> veto);
 
    // ── External-reset resync ──────────────────────────────────────────
    void resyncWindow(const QString& windowId);
 
    // ── Queries ────────────────────────────────────────────────────────
    // The state-observation surface: production code expresses everything
    // through the ownership calls above, so these exist for the behavioral
    // test spec (and future render-layer integration) to assert manager
    // state without reaching into internals.
    bool isBorderless(const QString& windowId) const;
    bool isOwned(const QString& windowId) const;
    bool isOwnedBy(const QString& windowId, const Owner& owner) const;
    bool isVetoed(const QString& windowId) const;
 
Q_SIGNALS:
    void windowDecorationRestored(const QString& windowId);
    void drainFinished();
 
private:
    struct Entry
    {
        QVector<Owner> owners; // small-N linear scan
        bool vetoed = false;
        bool evaluated = false; 
        bool eligible = false; 
        bool priorNoBorder = false; 
        bool physicallyHidden = false;
        bool pendingRestore = false;
        int vetoRetries = 0;
    };
 
    void reconcile(const QString& windowId, Entry& entry, Placement placement);
    void finishRelease(const QString& windowId, Entry& entry, Restore restore);
    void cancelPendingRestore(const QString& windowId, Entry& entry);
    void drainPendingRestoresInternal(bool fromFallback);
    WindowHandle resolveExact(const QString& windowId) const;
    void hideNow(WindowHandle w, Placement placement);
    bool restoreNow(const QString& windowId, Entry& entry, bool reassertGeometry);
    void pruneIfEmpty(const QString& windowId);
    void armFallbackTimer();
    void cancelFallbackTimer();
 
    QHash<QString, Entry> m_windows;
    QSet<QString> m_pendingRestore;
    QPointer<QTimer> m_pendingFallback;
    int m_fallbackIntervalMs; // FallbackDrainMs unless shrunk for tests
    std::function<bool(const QString&)> m_restoreVeto;
    QVector<std::shared_ptr<std::function<void()>>> m_liveDrainChains;
    ICompositorBridge& m_bridge;
};
 
} // namespace PhosphorCompositor