PlacementEngineBase.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2026 fuddlesworth
// SPDX-License-Identifier: LGPL-2.1-or-later
 
#pragma once
 
#include <PhosphorEngine/EngineTypes.h>
#include <PhosphorEngine/IPlacementEngine.h>
#include <phosphorengine_export.h>
 
#include <QObject>
#include <QPointer>
#include <QRect>
#include <QSet>
#include <QString>
#include <QStringList>
 
namespace PhosphorEngine {
 
struct LayerSwitchResult;
 
class PHOSPHORENGINE_EXPORT PlacementEngineBase : public QObject, public IPlacementEngine
{
    Q_OBJECT
 
public:
    virtual int pruneStaleWindows(const QSet<QString>& aliveWindowIds);
 
    virtual QRect lastManagedRect(const QString& windowId) const
    {
        Q_UNUSED(windowId)
        return {};
    }
 
    // ═══════════════════════════════════════════════════════════════════════════
    // Settings — universal pattern for all engines
    //
    // The daemon calls setEngineSettings() once at startup with a QObject*
    // that implements the engine's specific settings interface (e.g.
    // IAutotileSettings, ISnapSettings). Engines qobject_cast at point of
    // use to their interface type. No caching, no bridge, no signal wiring
    // inside the engine — the daemon handles change signals externally.
    // A nullptr is REFUSED with a warning (there is deliberately no unset
    // path); lifetime is handled by the QPointer member, so a destroyed
    // settings object reads back null without a teardown-symmetry clear.
    // ═══════════════════════════════════════════════════════════════════════════
 
    void setEngineSettings(QObject* settings);
    QObject* engineSettings() const
    {
        return m_engineSettings;
    }
 
    // Public dtor required for unique_ptr<PlacementEngineBase> in Daemon.
    ~PlacementEngineBase() override;
 
protected:
    explicit PlacementEngineBase(QObject* parent = nullptr);
 
    void announceLayerSwitch(const LayerSwitchResult& result, const QString& action, const QString& screenId);
 
Q_SIGNALS:
    void geometryRestoreRequested(const QString& windowId, const QRect& geometry, const QString& screenId);
 
    void navigationFeedback(bool success, const QString& action, const QString& reason, const QString& sourceId,
                            const QString& targetId, const QString& screenId);
    void windowFloatingChanged(const QString& windowId, bool floating, const QString& screenId);
    void activateWindowRequested(const QString& windowId);
 
    void windowDesktopMoveRequested(const QString& windowId, int desktop);
 
    void windowOutputMoveExpected(const QString& windowId, const QString& targetScreenId);
 
    void crossModeMoveRequested(const QString& windowId, const QString& targetScreenId, int targetDesktop,
                                const QString& direction);
 
    void crossModeSwapRequested(const QString& windowId, const QString& targetScreenId, int targetDesktop,
                                const QString& direction);
 
    void crossModeFocusRequested(const QString& targetScreenId, const QString& direction, bool* handled);
 
    void windowFloatingStateSynced(const QString& windowId, bool floating, const QString& screenId);
 
    void windowsBatchFloated(const QStringList& windowIds, const QString& screenId);
 
    void algorithmChanged(const QString& algorithmId);
 
    void placementChanged(const QString& screenId);
 
    void windowsReleased(const QStringList& windowIds, const QSet<QString>& releasedScreenIds);
 
    void settingsPersistRequested();
 
private:
    QPointer<QObject> m_engineSettings;
};
 
} // namespace PhosphorEngine