LayoutRegistry.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2026 fuddlesworth
// SPDX-License-Identifier: LGPL-2.1-or-later
 
#pragma once
 
#include <PhosphorZones/AssignmentEntry.h>
#include <PhosphorZones/IZoneLayoutRegistry.h>
#include <PhosphorZones/Layout.h>
 
#include <PhosphorConfig/IBackend.h>
 
#include <QHash>
#include <QPair>
#include <QString>
#include <QUuid>
#include <functional>
#include <memory>
 
namespace PhosphorZones {
 
class PHOSPHORZONES_EXPORT LayoutRegistry : public IZoneLayoutRegistry
{
    Q_OBJECT
 
    Q_PROPERTY(int layoutCount READ layoutCount NOTIFY layoutsChanged)
    // `activeLayout` Q_PROPERTY moved to IZoneLayoutRegistry alongside its
    // NOTIFY signal so the contract is visible to interface consumers.
    Q_PROPERTY(QString layoutDirectory READ layoutDirectory WRITE setLayoutDirectory NOTIFY layoutDirectoryChanged)
 
public:
    LayoutRegistry(std::unique_ptr<PhosphorConfig::IBackend> backend, QString layoutSubdirectory,
                   QObject* parent = nullptr);
    ~LayoutRegistry() override;
 
    // ─── IZoneLayoutRegistry ──────────────────────────────────────────────
 
    int layoutCount() const override
    {
        return m_layouts.size();
    }
    QVector<Layout*> layouts() const override
    {
        return m_layouts;
    }
    Layout* layout(int index) const override;
    Layout* layoutById(const QUuid& id) const override;
    Layout* layoutByName(const QString& name) const override;
 
    Q_INVOKABLE void addLayout(Layout* layout) override;
    Q_INVOKABLE void removeLayout(Layout* layout) override;
    Q_INVOKABLE void removeLayoutById(const QUuid& id) override;
    Q_INVOKABLE Layout* duplicateLayout(Layout* source) override;
 
    Layout* activeLayout() const override
    {
        return m_activeLayout;
    }
    Q_INVOKABLE void setActiveLayout(Layout* layout) override;
    Q_INVOKABLE void setActiveLayoutById(const QUuid& id) override;
 
    // ─── Layout persistence (disk JSON) ───────────────────────────────────
 
    QString layoutDirectory() const
    {
        return m_layoutDirectory;
    }
    void setLayoutDirectory(const QString& directory);
 
    Q_INVOKABLE void loadLayouts();
    Q_INVOKABLE void saveLayouts();
    void saveLayout(Layout* layout);
 
    Q_INVOKABLE void importLayout(const QString& filePath);
    Q_INVOKABLE void exportLayout(Layout* layout, const QString& filePath);
 
    // ─── Assignment persistence (via config backend) ──────────────────────
 
    Q_INVOKABLE void loadAssignments();
    Q_INVOKABLE void saveAssignments();
 
    // ─── Default-layout resolution ────────────────────────────────────────
 
    Q_INVOKABLE Layout* defaultLayout() const override;
 
    void setDefaultLayoutIdProvider(std::function<QString()> provider);
 
    void setDefaultAutotileAlgorithmProvider(std::function<QString()> provider);
 
    void setSnappingPreferredProvider(std::function<bool()> provider);
 
    // ─── Assignments (per-context routing) ────────────────────────────────
 
    Layout* previousLayout() const
    {
        return m_previousLayout;
    }
 
    Q_INVOKABLE void assignLayout(const QString& screenId, int virtualDesktop, const QString& activity, Layout* layout);
    Q_INVOKABLE void assignLayoutById(const QString& screenId, int virtualDesktop, const QString& activity,
                                      const QString& layoutId);
 
    void setAssignmentEntryDirect(const QString& screenId, int virtualDesktop, const QString& activity,
                                  const AssignmentEntry& entry);
 
    void setSnappingLayoutPreservingMode(const QString& screenId, int virtualDesktop, const QString& activity,
                                         const QString& layoutId);
 
    void setTilingAlgorithmPreservingMode(const QString& screenId, int virtualDesktop, const QString& activity,
                                          const QString& algorithmId);
 
    void setSnappingLayoutPromoting(const QString& screenId, int virtualDesktop, const QString& activity,
                                    const QString& layoutId);
 
    void setTilingAlgorithmPromoting(const QString& screenId, int virtualDesktop, const QString& activity,
                                     const QString& algorithmId);
 
    Q_INVOKABLE Layout* layoutForScreen(const QString& screenId, int virtualDesktop = 0,
                                        const QString& activity = QString()) const override;
 
    Q_INVOKABLE Layout* resolveLayoutForScreen(const QString& screenId) const override
    {
        return layoutForScreen(screenId, m_currentVirtualDesktop, m_currentActivity);
    }
 
    Q_INVOKABLE void clearAssignment(const QString& screenId, int virtualDesktop = 0,
                                     const QString& activity = QString());
    Q_INVOKABLE bool hasExplicitAssignment(const QString& screenId, int virtualDesktop = 0,
                                           const QString& activity = QString()) const;
 
    Q_INVOKABLE QString assignmentIdForScreen(const QString& screenId, int virtualDesktop = 0,
                                              const QString& activity = QString()) const override;
 
    AssignmentEntry assignmentEntryForScreen(const QString& screenId, int virtualDesktop = 0,
                                             const QString& activity = QString()) const;
 
    AssignmentEntry::Mode modeForScreen(const QString& screenId, int virtualDesktop = 0,
                                        const QString& activity = QString()) const;
 
    QString snappingLayoutForScreen(const QString& screenId, int virtualDesktop = 0,
                                    const QString& activity = QString()) const;
    QString tilingAlgorithmForScreen(const QString& screenId, int virtualDesktop = 0,
                                     const QString& activity = QString()) const;
 
    void clearAutotileAssignments();
 
    void setAllScreenAssignments(const QHash<QString, QString>& assignments);
    void setAllDesktopAssignments(const QHash<QPair<QString, int>, QString>& assignments);
    void setAllActivityAssignments(const QHash<QPair<QString, QString>, QString>& assignments);
 
    QHash<QPair<QString, int>, QString> desktopAssignments() const;
    QHash<QPair<QString, QString>, QString> activityAssignments() const;
 
    // ─── Quick-layout slots (1..9) ────────────────────────────────────────
 
    Q_INVOKABLE Layout* layoutForShortcut(int number) const;
    Q_INVOKABLE void applyQuickLayout(int number, const QString& screenId);
    void setQuickLayoutSlot(int number, const QString& layoutId);
    void setAllQuickLayoutSlots(const QHash<int, QString>& slots);
    QHash<int, QString> quickLayoutSlots() const
    {
        return m_quickLayoutShortcuts;
    }
 
    // ─── Layout cycling ───────────────────────────────────────────────────
 
    Q_INVOKABLE void cycleToPreviousLayout(const QString& screenId);
    Q_INVOKABLE void cycleToNextLayout(const QString& screenId);
 
    // ─── Built-in layouts ─────────────────────────────────────────────────
 
    Q_INVOKABLE void createBuiltInLayouts();
    QVector<Layout*> builtInLayouts() const;
 
    // ─── Context (desktop / activity) ─────────────────────────────────────
 
    Q_INVOKABLE int currentVirtualDesktop() const override
    {
        return m_currentVirtualDesktop;
    }
    Q_INVOKABLE QString currentActivity() const override
    {
        return m_currentActivity;
    }
    void setCurrentVirtualDesktop(int desktop)
    {
        m_currentVirtualDesktop = desktop;
    }
    void setCurrentActivity(const QString& activity)
    {
        m_currentActivity = activity;
    }
 
    // ─── Autotile layout overrides (per-algorithm user overrides) ─────────
 
    void saveAutotileOverrides(const QString& algorithmId, const QJsonObject& overrides);
    QJsonObject loadAutotileOverrides(const QString& algorithmId) const;
 
Q_SIGNALS:
    // layoutAdded / layoutRemoved / activeLayoutChanged / layoutAssigned are
    // inherited from IZoneLayoutRegistry - declared on the interface so
    // consumers that target the contract can connect without depending on
    // the concrete class. Emit sites still live in this TU and reach the
    // inherited signal via Q_OBJECT's metaobject chain.
    void layoutsChanged();
    void layoutDirectoryChanged();
    void layoutsLoaded();
    void layoutsSaved();
 
private:
    void clearShadowsForSlot(const QString& screenId, int virtualDesktop, const QString& activity);
 
    void ensureLayoutDirectory();
    void loadLayoutsFromDirectory(const QString& directory);
    Layout* restoreSystemLayout(const QUuid& id, const QString& systemPath);
    QString layoutFilePath(const QUuid& id) const;
    void readAssignmentGroups(PhosphorConfig::IBackend* backend);
    void readQuickLayouts(PhosphorConfig::IBackend* backend);
    Layout* cycleLayoutImpl(const QString& screenId, int direction);
    bool shouldSkipLayoutAssignment(const QString& layoutId, const QString& context) const;
    void emitLayoutAssigned(const QString& screenId, int virtualDesktop, const QString& layoutId);
    void applyLayoutToScreen(const QString& screenId, Layout* layout);
    QJsonObject loadAllAutotileOverrides() const;
    void saveAllAutotileOverrides(const QJsonObject& all);
    Layout* resolveConfiguredDefault() const;
 
    AssignmentEntry resolveDefaultAssignmentEntry() const;
 
    std::function<QString()> m_defaultLayoutIdProvider; 
    std::function<QString()> m_defaultAutotileAlgorithmProvider;
    std::function<bool()> m_snappingPreferredProvider;
    std::unique_ptr<PhosphorConfig::IBackend> m_ownedBackend;
    PhosphorConfig::IBackend* m_configBackend = nullptr; 
    QString m_layoutSubdirectory; 
    QString m_layoutDirectory; 
    QVector<Layout*> m_layouts;
    Layout* m_activeLayout = nullptr;
    Layout* m_previousLayout = nullptr; 
    QHash<LayoutAssignmentKey, AssignmentEntry> m_assignments;
    QHash<int, QString> m_quickLayoutShortcuts; 
    int m_currentVirtualDesktop = 1;
    QString m_currentActivity;
};
 
} // namespace PhosphorZones