update description from kwin

Add a new method that tells the surface whether to accomodate
exclusive zones set by other surfaces or not.
right until now this was possible by setting the eclusive zone of
this surface to the value of -1.
Besides being a magic number, it makes impossible for this surface to
set an exclusive zone by itself if we want to ignore other exclusive zones

src/interfaces/window.cpp

@@ -34,6 +34,7 @@ public:
     QMargins margins;
     Window::ScreenConfiguration screenConfiguration = Window::ScreenFromQWindow;
     bool closeOnDismissed = true;
+    Window::AnchorRect anchorRect = Window::AnchorRectWorkArea;
 };
 
 static QMap<QWindow *, Window *> s_map;
@@ -84,6 +85,21 @@ Window::Anchor Window::exclusiveEdge() const
     return d->exclusiveEdge;
 }
 
+Window::AnchorRect Window::anchorRect() const
+{
+    return d->anchorRect;
+}
+
+void Window::setAnchorRect(Window::AnchorRect anchorRect)
+{
+    if (d->anchorRect == anchorRect) {
+        return;
+    }
+
+    d->anchorRect = anchorRect;
+    Q_EMIT anchorRectChanged();
+}
+
 void Window::setMargins(const QMargins &margins)
 {
     if (d->margins != margins) {

src/interfaces/window.h

@@ -25,6 +25,7 @@ class LAYERSHELLQT_EXPORT Window : public QObject
     Q_PROPERTY(QString scope READ scope WRITE setScope)
     Q_PROPERTY(QMargins margins READ margins WRITE setMargins NOTIFY marginsChanged)
     Q_PROPERTY(qint32 exclusionZone READ exclusionZone WRITE setExclusiveZone NOTIFY exclusionZoneChanged)
+    Q_PROPERTY(AnchorRect anchorRect READ anchorRect WRITE setAnchorRect NOTIFY anchorRectChanged)
     Q_PROPERTY(Layer layer READ layer WRITE setLayer NOTIFY layerChanged)
     Q_PROPERTY(KeyboardInteractivity keyboardInteractivity READ keyboardInteractivity WRITE setKeyboardInteractivity NOTIFY keyboardInteractivityChanged)
     Q_PROPERTY(ScreenConfiguration screenConfiguration READ screenConfiguration WRITE setScreenConfiguration)
@@ -42,6 +43,12 @@ public:
     Q_ENUM(Anchor);
     Q_DECLARE_FLAGS(Anchors, Anchor)
 
+    /**
+     * This enum is used to choose between anchoring to work area or screen area
+     */
+    enum AnchorRect { AnchorRectWorkArea = 0, AnchorRectFullArea = 1 };
+    Q_ENUM(AnchorRect);
+
     /**
      * This enum type is used to specify the layer where a surface can be put in.
      */
@@ -83,6 +90,9 @@ public:
     void setExclusiveEdge(Window::Anchor edge);
     Window::Anchor exclusiveEdge() const;
 
+    AnchorRect anchorRect() const;
+    void setAnchorRect(AnchorRect anchorRect);
+
     void setMargins(const QMargins &margins);
     QMargins margins() const;
 
@@ -126,6 +136,7 @@ Q_SIGNALS:
     void anchorsChanged();
     void exclusionZoneChanged();
     void exclusiveEdgeChanged();
+    void anchorRectChanged();
     void marginsChanged();
     void keyboardInteractivityChanged();
     void layerChanged();

src/qwaylandlayersurface.cpp

@@ -56,6 +56,11 @@ QWaylandLayerSurface::QWaylandLayerSurface(QWaylandLayerShellIntegration *shell,
         setExclusiveEdge(m_interface->exclusiveEdge());
     });
 
+    setAnchorRect(m_interface->anchorRect());
+    connect(m_interface, &Window::anchorRectChanged, this, [this]() {
+        setAnchorRect(m_interface->anchorRect());
+    });
+
     setMargins(m_interface->margins());
     connect(m_interface, &Window::marginsChanged, this, [this]() {
         setMargins(m_interface->margins());
@@ -74,11 +79,6 @@ QWaylandLayerSurface::~QWaylandLayerSurface()
     destroy();
 }
 
-bool QWaylandLayerSurface::isExposed() const
-{
-    return m_configured && !m_waitingForRearrange;
-}
-
 void QWaylandLayerSurface::zwlr_layer_surface_v1_closed()
 {
     if (m_interface->closeOnDismissed()) {
@@ -86,15 +86,6 @@ void QWaylandLayerSurface::zwlr_layer_surface_v1_closed()
     }
 }
 
-void QWaylandLayerSurface::zwlr_layer_surface_v1_rearranged(uint32_t serial)
-{
-    qDebug() << serial << m_arrangeSerial;
-    if (m_arrangeSerial == serial) {
-        qDebug() << "unset rearrange";
-        m_waitingForRearrange = false;
-    }
-}
-
 void QWaylandLayerSurface::zwlr_layer_surface_v1_configure(uint32_t serial, uint32_t width, uint32_t height)
 {
     ack_configure(serial);
@@ -103,6 +94,7 @@ void QWaylandLayerSurface::zwlr_layer_surface_v1_configure(uint32_t serial, uint
     if (!m_configured) {
         m_configured = true;
         applyConfigure();
+        sendExpose();
     } else {
         // Later configures are resizes, so we have to queue them up for a time when we
         // are not painting to the window.
@@ -130,7 +122,6 @@ void QWaylandLayerSurface::applyConfigure()
 #if QT_VERSION < QT_VERSION_CHECK(6, 9, 0)
     m_configuring = false;
 #endif
-    window()->updateExposure();
 }
 
 void QWaylandLayerSurface::setDesiredSize(const QSize &size)
@@ -146,16 +137,6 @@ void QWaylandLayerSurface::setDesiredSize(const QSize &size)
         effectiveSize.setHeight(0);
     }
     set_size(effectiveSize.width(), effectiveSize.height());
-
-    static quint32 token = 0;
-    m_waitingForRearrange = true;
-    m_arrangeSerial = ++token;
-    set_arrange_token(m_arrangeSerial);
-    window()->updateExposure();
-    if (!window()->isExposed()) {
-        window()->commit(); // FIXME: ugly
-    }
-    qDebug() << "request reposition" << m_arrangeSerial;
 }
 
 void QWaylandLayerSurface::setAnchor(uint anchor)
@@ -175,6 +156,13 @@ void QWaylandLayerSurface::setExclusiveEdge(uint32_t edge)
     }
 }
 
+void QWaylandLayerSurface::setAnchorRect(int32_t anchorRect)
+{
+    if (zwlr_layer_surface_v1_get_version(object()) >= ZWLR_LAYER_SURFACE_V1_SET_ANCHOR_RECT_SINCE_VERSION) {
+        set_anchor_rect(anchorRect);
+    }
+}
+
 void QWaylandLayerSurface::setMargins(const QMargins &margins)
 {
     set_margin(margins.top(), margins.right(), margins.bottom(), margins.left());

src/qwaylandlayersurface_p.h

@@ -8,6 +8,7 @@
 #ifndef _LAYERSURFACE_H
 #define _LAYERSURFACE_H
 
+#include <cstdint>
 #include <wayland-client.h>
 
 #include "qwaylandlayershellintegration_p.h"
@@ -28,13 +29,17 @@ public:
     QWaylandLayerSurface(QWaylandLayerShellIntegration *shell, QtWaylandClient::QWaylandWindow *window);
     ~QWaylandLayerSurface() override;
 
-    bool isExposed() const override;
+    bool isExposed() const override
+    {
+        return m_configured;
+    }
     void attachPopup(QtWaylandClient::QWaylandShellSurface *popup) override;
 
     void setDesiredSize(const QSize &size);
     void setAnchor(uint32_t anchor);
     void setExclusiveZone(int32_t zone);
     void setExclusiveEdge(uint32_t edge);
+    void setAnchorRect(int32_t anchorRect);
     void setMargins(const QMargins &margins);
     void setKeyboardInteractivity(uint32_t interactivity);
     void setLayer(uint32_t layer);
@@ -54,7 +59,6 @@ private:
     void sendExpose();
     void zwlr_layer_surface_v1_configure(uint32_t serial, uint32_t width, uint32_t height) override;
     void zwlr_layer_surface_v1_closed() override;
-    void zwlr_layer_surface_v1_rearranged(uint32_t token) override;
 
     QWaylandLayerShellIntegration *m_shell;
     LayerShellQt::Window *m_interface;
@@ -66,8 +70,6 @@ private:
 #if QT_VERSION < QT_VERSION_CHECK(6, 9, 0)
     bool m_configuring = false;
 #endif
-    quint32 m_arrangeSerial = 0;
-    bool m_waitingForRearrange = false;
 };
 
 }

src/wlr-layer-shell-unstable-v1.xml

@@ -168,21 +168,25 @@
         Surfaces that do not wish to have an exclusive zone may instead specify
         how they should interact with surfaces that do. If set to zero, the
         surface indicates that it would like to be moved to avoid occluding
-        surfaces with a positive exclusive zone. If set to -1, the surface
-        indicates that it would not like to be moved to accommodate for other
-        surfaces, and the compositor should extend it all the way to the edges
-        it is anchored to.
+        surfaces with a positive exclusive zone.
 
         For example, a panel might set its exclusive zone to 10, so that
         maximized shell surfaces are not shown on top of it. A notification
         might set its exclusive zone to 0, so that it is moved to avoid
-        occluding the panel, but shell surfaces are shown underneath it. A
-        wallpaper or lock screen might set their exclusive zone to -1, so that
-        they stretch below or over the panel.
+        occluding the panel, but shell surfaces are shown underneath it.
 
         The default value is 0.
 
         Exclusive zone is double-buffered, see wl_surface.commit.
+
+        Since version 6 It must be a value of 0 or more, otherwise the error
+        invalid_exclusive_zone will be triggered.
+
+        Until version 5 if set to -1, the surface indicates that it would not
+        like to be moved to accommodate for other surfaces, and the compositor
+        should extend it all the way to the edges it is anchored to.
+        A wallpaper or lock screen might set their exclusive zone to -1, so that
+        they stretch below or over the panel.
       </description>
       <arg name="zone" type="int"/>
     </request>
@@ -203,21 +207,85 @@
       <arg name="left" type="int"/>
     </request>
 
+    <enum name="keyboard_interactivity">
+      <description summary="types of keyboard interaction possible for a layer shell surface">
+        Types of keyboard interaction possible for layer shell surfaces. The
+        rationale for this is twofold: (1) some applications are not interested
+        in keyboard events and not allowing them to be focused can improve the
+        desktop experience; (2) some applications will want to take exclusive
+        keyboard focus.
+      </description>
+
+      <entry name="none" value="0">
+        <description summary="no keyboard focus is possible">
+          This value indicates that this surface is not interested in keyboard
+          events and the compositor should never assign it the keyboard focus.
+
+          This is the default value, set for newly created layer shell surfaces.
+
+          This is useful for e.g. desktop widgets that display information or
+          only have interaction with non-keyboard input devices.
+        </description>
+      </entry>
+      <entry name="exclusive" value="1">
+        <description summary="request exclusive keyboard focus">
+          Request exclusive keyboard focus if this surface is above the shell surface layer.
+
+          For the top and overlay layers, the seat will always give
+          exclusive keyboard focus to the top-most layer which has keyboard
+          interactivity set to exclusive. If this layer contains multiple
+          surfaces with keyboard interactivity set to exclusive, the compositor
+          determines the one receiving keyboard events in an implementation-
+          defined manner. In this case, no guarantee is made when this surface
+          will receive keyboard focus (if ever).
+
+          For the bottom and background layers, the compositor is allowed to use
+          normal focus semantics.
+
+          This setting is mainly intended for applications that need to ensure
+          they receive all keyboard events, such as a lock screen or a password
+          prompt.
+        </description>
+      </entry>
+      <entry name="on_demand" value="2" since="4">
+        <description summary="request regular keyboard focus semantics">
+          This requests the compositor to allow this surface to be focused and
+          unfocused by the user in an implementation-defined manner. The user
+          should be able to unfocus this surface even regardless of the layer
+          it is on.
+
+          Typically, the compositor will want to use its normal mechanism to
+          manage keyboard focus between layer shell surfaces with this setting
+          and regular toplevels on the desktop layer (e.g. click to focus).
+          Nevertheless, it is possible for a compositor to require a special
+          interaction to focus or unfocus layer shell surfaces (e.g. requiring
+          a click even if focus follows the mouse normally, or providing a
+          keybinding to switch focus between layers).
+
+          This setting is mainly intended for desktop shell components (e.g.
+          panels) that allow keyboard interaction. Using this option can allow
+          implementing a desktop shell that can be fully usable without the
+          mouse.
+        </description>
+      </entry>
+    </enum>
+
     <request name="set_keyboard_interactivity">
       <description summary="requests keyboard events">
-        Set to 1 to request that the seat send keyboard events to this layer
-        surface. For layers below the shell surface layer, the seat will use
-        normal focus semantics. For layers above the shell surface layers, the
-        seat will always give exclusive keyboard focus to the top-most layer
-        which has keyboard interactivity set to true.
+        Set how keyboard events are delivered to this surface. By default,
+        layer shell surfaces do not receive keyboard events; this request can
+        be used to change this.
+
+        This setting is inherited by child surfaces set by the get_popup
+        request.
 
         Layer surfaces receive pointer, touch, and tablet events normally. If
         you do not want to receive them, set the input region on your surface
         to an empty region.
 
-        Events is double-buffered, see wl_surface.commit.
+        Keyboard interactivity is double-buffered, see wl_surface.commit.
       </description>
-      <arg name="keyboard_interactivity" type="uint"/>
+      <arg name="keyboard_interactivity" type="uint" enum="keyboard_interactivity"/>
     </request>
 
     <request name="get_popup">
@@ -302,7 +370,9 @@
       <entry name="invalid_surface_state" value="0" summary="provided surface state is invalid"/>
       <entry name="invalid_size" value="1" summary="size is invalid"/>
       <entry name="invalid_anchor" value="2" summary="anchor bitfield is invalid"/>
+      <entry name="invalid_keyboard_interactivity" value="3" summary="keyboard interactivity is invalid"/>
       <entry name="invalid_exclusive_edge" value="4" summary="exclusive edge is invalid given the surface anchors"/>
+      <entry name="invalid_exclusive_zone" value="5" summary="exclusive zone value is invalid, since version 6 it can't be less than zero"/>
     </enum>
 
     <enum name="anchor" bitfield="true">
@@ -339,12 +409,32 @@
       <arg name="edge" type="uint"/>
     </request>
 
-    <request name="set_arrange_token" since="6">
-      <arg name="token" type="uint"/>
+    <!-- Version 6 additions -->
+
+    <enum name="anchor_rect">
+      <entry name="full_area" value="0" summary="the full area anchor rect">
+        <description summary="the full area anchor rect">
+          Place the layer_surface_v1 relative to the full output area.
+        </description>
+      </entry>
+      <entry name="work_area" value="1" summary="the work area anchor rect">
+        <description summary="the work area anchor rect">
+          Place the layer_surface_v1 relative to the output area while taking
+          the exclusive zone of other surfaces into account.
+        </description>
+      </entry>
+    </enum>
+
+    <request name="set_anchor_rect" since="6">
+      <description summary="set the anchor rect">
+        Set the anchor rectangle relative to which the anchors are applied.
+
+        By default, the layer_surface_v1 is anchored to the 'work_area'.
+
+        Anchor rect is double-buffered, see wl_surface.commit.
+      </description>
+      <arg name="rect" type="uint" enum="anchor_rect"/>
     </request>
 
-    <event name="rearranged" since="6">
-      <arg name="token" type="uint"/>
-    </event>
   </interface>
 </protocol>