WindowPlacementStore.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2026 fuddlesworth
// SPDX-License-Identifier: LGPL-2.1-or-later
 
#pragma once
 
#include <PhosphorEngine/WindowPlacement.h>
#include <phosphorengine_export.h>
 
#include <QHash>
#include <QJsonObject>
#include <QList>
#include <QString>
 
#include <functional>
#include <optional>
 
namespace PhosphorEngine {
 
class PHOSPHORENGINE_EXPORT WindowPlacementStore
{
public:
    WindowPlacementStore() = default;
 
    bool record(WindowPlacement placement);
 
    std::optional<WindowPlacement> take(const QString& windowId, const QString& appId,
                                        const std::function<bool(const WindowPlacement&)>& accept = {},
                                        const std::function<bool(const WindowPlacement&)>& preferred = {});
 
    std::optional<WindowPlacement> takeForReopen(const QString& engineId, const QString& windowId, const QString& appId,
                                                 const QString& screenId);
 
    std::optional<WindowPlacement> peek(const QString& windowId, const QString& appId,
                                        const std::function<bool(const WindowPlacement&)>& accept = {}) const;
 
    std::optional<WindowPlacement> peekExact(const QString& windowId) const
    {
        return peek(windowId, QString());
    }
 
    std::optional<WindowPlacement> peekForReclaim(const QString& windowId, const QString& appId,
                                                  const std::function<bool(const WindowPlacement&)>& accept = {}) const;
 
    bool contains(const QString& windowId, const QString& appId = QString()) const;
 
    void setLiveInstanceProbe(std::function<bool(const QString& windowId)> probe)
    {
        m_liveInstanceProbe = std::move(probe);
    }
 
    bool collapsePureFloatSiblings(const QString& appId, const QString& keepWindowId);
 
    bool clear(const QString& windowId);
 
    bool clearFreeGeometry(const QString& windowId);
    bool clearFreeGeometry(const QString& windowId, const QString& screenId);
 
    bool releaseEngineSlot(const QString& windowId, const QString& engineId);
 
    int transform(const std::function<bool(WindowPlacement&)>& fn);
 
    int removeIf(const std::function<bool(const WindowPlacement&)>& pred);
 
    QList<WindowPlacement> records() const;
 
    QJsonObject serialize(const std::function<bool(const WindowPlacement&)>& keep = {}) const;
    void deserialize(const QJsonObject& obj);
 
    int size() const;
 
private:
    void evictForCapacity(QList<WindowPlacement>& bucket);
 
public:
    static constexpr int MaxPerApp = 16;
 
private:
    QHash<QString, QList<WindowPlacement>> m_byApp;
    quint64 m_sequence = 0;
    std::function<bool(const QString&)> m_liveInstanceProbe;
};
 
} // namespace PhosphorEngine