LayerSurface.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2026 fuddlesworth
// SPDX-License-Identifier: LGPL-2.1-or-later
 
#pragma once
 
#include <phosphorwayland_export.h>
 
#include <utility>
 
#include <QMargins>
#include <QObject>
#include <QPointer>
#include <QScreen>
#include <QWindow>
 
namespace PhosphorWayland {
 
namespace LayerSurfaceProps {
inline constexpr const char* IsLayerShell = "_ps_layer_shell";
inline constexpr const char* Surface = "_ps_layer_shell_surface";
inline constexpr const char* Layer = "_ps_layer";
inline constexpr const char* Anchors = "_ps_anchors";
inline constexpr const char* ExclusiveZone = "_ps_exclusive_zone";
inline constexpr const char* Keyboard = "_ps_keyboard";
inline constexpr const char* Scope = "_ps_scope";
inline constexpr const char* MarginsLeft = "_ps_margins_left";
inline constexpr const char* MarginsTop = "_ps_margins_top";
inline constexpr const char* MarginsRight = "_ps_margins_right";
inline constexpr const char* MarginsBottom = "_ps_margins_bottom";
inline constexpr const char* ExclusiveEdge = "_ps_exclusive_edge";
inline constexpr const char* DesiredWidth = "_ps_desired_width";
inline constexpr const char* DesiredHeight = "_ps_desired_height";
} // namespace LayerSurfaceProps
 
class PHOSPHORWAYLAND_EXPORT LayerSurface : public QObject
{
    Q_OBJECT
    Q_DISABLE_COPY_MOVE(LayerSurface)
 
    Q_PROPERTY(Layer layer READ layer WRITE setLayer NOTIFY layerChanged)
    Q_PROPERTY(Anchors anchors READ anchors WRITE setAnchors NOTIFY anchorsChanged)
    Q_PROPERTY(int32_t exclusiveZone READ exclusiveZone WRITE setExclusiveZone NOTIFY exclusiveZoneChanged)
    Q_PROPERTY(KeyboardInteractivity keyboardInteractivity READ keyboardInteractivity WRITE setKeyboardInteractivity
                   NOTIFY keyboardInteractivityChanged)
    Q_PROPERTY(QString scope READ scope WRITE setScope NOTIFY scopeChanged)
    Q_PROPERTY(QScreen* screen READ screen WRITE setScreen NOTIFY screenChanged)
    Q_PROPERTY(QMargins margins READ margins WRITE setMargins NOTIFY marginsChanged)
    Q_PROPERTY(Anchors exclusiveEdge READ exclusiveEdge WRITE setExclusiveEdge NOTIFY exclusiveEdgeChanged)
 
public:
    ~LayerSurface() override;
 
    enum Layer {
        LayerBackground = 0,
        LayerBottom = 1,
        LayerTop = 2,
        LayerOverlay = 3,
    };
    Q_ENUM(Layer)
 
    enum KeyboardInteractivity {
        KeyboardInteractivityNone = 0,
        KeyboardInteractivityExclusive = 1,
        KeyboardInteractivityOnDemand = 2,
    };
    Q_ENUM(KeyboardInteractivity)
 
    enum Anchor {
        AnchorNone = 0,
        AnchorTop = 1,
        AnchorBottom = 2,
        AnchorLeft = 4,
        AnchorRight = 8,
    };
    Q_DECLARE_FLAGS(Anchors, Anchor)
    Q_FLAG(Anchors)
 
    static constexpr Anchors AnchorAll = Anchors(AnchorTop | AnchorBottom | AnchorLeft | AnchorRight);
 
    // ── Mutable properties (can be changed after show()) ─────────────
    void setLayer(Layer layer);
    Layer layer() const;
 
    void setAnchors(Anchors anchors);
    Anchors anchors() const;
 
    void setExclusiveZone(int32_t zone);
    int32_t exclusiveZone() const;
 
    void setKeyboardInteractivity(KeyboardInteractivity interactivity);
    KeyboardInteractivity keyboardInteractivity() const;
 
    void setMargins(const QMargins& margins);
    QMargins margins() const;
 
    void setExclusiveEdge(Anchors edge);
    Anchors exclusiveEdge() const;
 
    void setDesiredSize(const QSize& size);
    QSize desiredSize() const;
 
    // ── Immutable properties (must set before show()) ────────────────
    void setScope(const QString& scope);
    QString scope() const;
 
    void setScreen(QScreen* screen);
    QScreen* screen() const;
 
    static LayerSurface* get(QWindow* window);
 
    static LayerSurface* find(QWindow* window);
 
    static bool isSupported();
 
    static std::pair<uint32_t, uint32_t> computeLayerSize(Anchors anchors, const QSize& windowSize);
 
Q_SIGNALS:
    void layerChanged();
    void anchorsChanged();
    void exclusiveZoneChanged();
    void keyboardInteractivityChanged();
    void scopeChanged();
    void marginsChanged();
    void exclusiveEdgeChanged();
    void screenChanged();
    void desiredSizeChanged();
    void propertiesChanged();
 
public:
    class BatchGuard
    {
    public:
        explicit BatchGuard(LayerSurface* surface)
            : m_surface(surface)
        {
            if (m_surface) {
                ++m_surface->m_batchDepth;
            }
        }
        ~BatchGuard()
        {
            if (m_surface) {
                Q_ASSERT(m_surface->m_batchDepth > 0);
                if (--m_surface->m_batchDepth == 0 && m_surface->m_batchDirty) {
                    m_surface->m_batchDirty = false;
                    Q_EMIT m_surface->propertiesChanged();
                }
            }
        }
        BatchGuard(const BatchGuard&) = delete;
        BatchGuard& operator=(const BatchGuard&) = delete;
        BatchGuard(BatchGuard&& other) noexcept
            : m_surface(std::exchange(other.m_surface, nullptr))
        {
        }
        BatchGuard& operator=(BatchGuard&&) = delete;
 
    private:
        QPointer<LayerSurface> m_surface;
    };
 
private:
    friend class BatchGuard;
    explicit LayerSurface(QWindow* window);
 
    void emitPropertiesChanged();
 
    QPointer<QWindow> m_window;
    int m_batchDepth = 0;
    bool m_batchDirty = false;
    Layer m_layer = LayerTop;
    Anchors m_anchors;
    int32_t m_exclusiveZone = -1;
    KeyboardInteractivity m_keyboard = KeyboardInteractivityNone;
    QString m_scope;
    QPointer<QScreen> m_screen;
    QMargins m_margins;
    Anchors m_exclusiveEdge;
    QSize m_desiredSize; 
    QMetaObject::Connection m_destroyedConnection;
};
 
Q_DECLARE_OPERATORS_FOR_FLAGS(LayerSurface::Anchors)
 
} // namespace PhosphorWayland
 
Q_DECLARE_METATYPE(PhosphorWayland::LayerSurface*)