refactor: move wlr_layershell to its own subdirectory

src/wayland/wlr_layershell/CMakeLists.txt

@@ -0,0 +1,12 @@
+qt_add_library(quickshell-wayland-layershell STATIC
+	shell_integration.cpp
+	surface.cpp
+	window.cpp
+)
+
+qt_add_qml_module(quickshell-wayland-layershell URI Quickshell.Wayland._WlrLayerShell)
+
+wl_proto(quickshell-wayland-layershell wlr-layer-shell-unstable-v1 "${CMAKE_CURRENT_SOURCE_DIR}/wlr-layer-shell-unstable-v1.xml")
+target_link_libraries(quickshell-wayland-layershell PRIVATE ${QT_DEPS} wayland-client)
+
+target_link_libraries(quickshell-wayland PRIVATE quickshell-wayland-layershellplugin)

src/wayland/wlr_layershell/shell_integration.cpp

@@ -0,0 +1,22 @@
+#include "shell_integration.hpp"
+
+#include <private/qwaylandshellintegration_p.h>
+#include <private/qwaylandshellsurface_p.h>
+#include <private/qwaylandwindow_p.h>
+
+#include "surface.hpp"
+#include "wayland-wlr-layer-shell-unstable-v1-client-protocol.h"
+
+QSWaylandLayerShellIntegration::QSWaylandLayerShellIntegration()
+    : QtWaylandClient::QWaylandShellIntegrationTemplate<QSWaylandLayerShellIntegration>(4) {}
+
+QSWaylandLayerShellIntegration::~QSWaylandLayerShellIntegration() {
+	if (this->object() != nullptr) {
+		zwlr_layer_shell_v1_destroy(this->object());
+	}
+}
+
+QtWaylandClient::QWaylandShellSurface*
+QSWaylandLayerShellIntegration::createShellSurface(QtWaylandClient::QWaylandWindow* window) {
+	return new QSWaylandLayerSurface(this, window);
+}

src/wayland/wlr_layershell/shell_integration.hpp

@@ -0,0 +1,21 @@
+#pragma once
+
+#include <private/qwaylandshellintegration_p.h>
+#include <private/qwaylandshellsurface_p.h>
+#include <qtwaylandclientexports.h>
+#include <qwayland-wlr-layer-shell-unstable-v1.h>
+
+class QSWaylandLayerShellIntegration
+    : public QtWaylandClient::QWaylandShellIntegrationTemplate<QSWaylandLayerShellIntegration>
+    , public QtWayland::zwlr_layer_shell_v1 {
+public:
+	QSWaylandLayerShellIntegration();
+	~QSWaylandLayerShellIntegration() override;
+	QSWaylandLayerShellIntegration(QSWaylandLayerShellIntegration&&) = delete;
+	QSWaylandLayerShellIntegration(const QSWaylandLayerShellIntegration&) = delete;
+	void operator=(QSWaylandLayerShellIntegration&&) = delete;
+	void operator=(const QSWaylandLayerShellIntegration&) = delete;
+
+	QtWaylandClient::QWaylandShellSurface* createShellSurface(QtWaylandClient::QWaylandWindow* window
+	) override;
+};

src/wayland/wlr_layershell/surface.cpp

@@ -0,0 +1,165 @@
+#include "surface.hpp"
+
+#include <private/qwaylanddisplay_p.h>
+#include <private/qwaylandscreen_p.h>
+#include <private/qwaylandshellsurface_p.h>
+#include <private/qwaylandsurface_p.h>
+#include <private/qwaylandwindow_p.h>
+#include <qlogging.h>
+#include <qpoint.h>
+#include <qrect.h>
+#include <qsize.h>
+#include <qtypes.h>
+#include <qwayland-wlr-layer-shell-unstable-v1.h>
+
+#include "../../core/panelinterface.hpp"
+#include "shell_integration.hpp"
+#include "window.hpp"
+
+// clang-format off
+[[nodiscard]] QtWayland::zwlr_layer_shell_v1::layer toWaylandLayer(const Layer::Enum& layer) noexcept;
+[[nodiscard]] QtWayland::zwlr_layer_surface_v1::anchor toWaylandAnchors(const Anchors& anchors) noexcept;
+[[nodiscard]] QtWayland::zwlr_layer_surface_v1::keyboard_interactivity toWaylandKeyboardFocus(const KeyboardFocus::Enum& focus) noexcept;
+[[nodiscard]] QSize constrainedSize(const Anchors& anchors, const QSize& size) noexcept;
+// clang-format on
+
+// clang-format off
+QSWaylandLayerSurface::QSWaylandLayerSurface(
+    QSWaylandLayerShellIntegration* shell,
+    QtWaylandClient::QWaylandWindow* window
+): QtWaylandClient::QWaylandShellSurface(window) {
+	// clang-format on
+
+	auto* qwindow = window->window();
+	this->ext = LayershellWindowExtension::get(qwindow);
+
+	if (this->ext == nullptr) {
+		throw "QSWaylandLayerSurface created with null LayershellWindowExtension";
+	}
+
+	wl_output* output = nullptr; // NOLINT (import)
+	if (this->ext->useWindowScreen) {
+		auto* waylandScreen =
+		    dynamic_cast<QtWaylandClient::QWaylandScreen*>(qwindow->screen()->handle());
+
+		if (waylandScreen != nullptr) {
+			output = waylandScreen->output();
+		} else {
+			qWarning() << "Layershell screen is set but does not corrospond to a real screen. Letting "
+			              "the compositor pick.";
+		}
+	}
+
+	this->init(shell->get_layer_surface(
+	    window->waylandSurface()->object(),
+	    output,
+	    toWaylandLayer(this->ext->mLayer),
+	    this->ext->mNamespace
+	));
+
+	this->updateAnchors();
+	this->updateLayer();
+	this->updateMargins();
+	this->updateExclusiveZone();
+	this->updateKeyboardFocus();
+
+	// new updates will be sent from the extension
+	this->ext->surface = this;
+
+	auto size = constrainedSize(this->ext->mAnchors, qwindow->size());
+	this->set_size(size.width(), size.height());
+}
+
+QSWaylandLayerSurface::~QSWaylandLayerSurface() { this->destroy(); }
+
+void QSWaylandLayerSurface::zwlr_layer_surface_v1_configure(
+    quint32 serial,
+    quint32 width,
+    quint32 height
+) {
+	this->ack_configure(serial);
+
+	this->size = QSize(static_cast<qint32>(width), static_cast<qint32>(height));
+	if (!this->configured) {
+		this->configured = true;
+		this->window()->resizeFromApplyConfigure(this->size);
+		this->window()->handleExpose(QRect(QPoint(), this->size));
+	} else {
+		this->window()->applyConfigureWhenPossible();
+	}
+}
+
+void QSWaylandLayerSurface::zwlr_layer_surface_v1_closed() { this->window()->window()->close(); }
+
+bool QSWaylandLayerSurface::isExposed() const { return this->configured; }
+
+void QSWaylandLayerSurface::applyConfigure() {
+	this->window()->resizeFromApplyConfigure(this->size);
+}
+
+void QSWaylandLayerSurface::setWindowGeometry(const QRect& geometry) {
+	auto size = constrainedSize(this->ext->mAnchors, geometry.size());
+	this->set_size(size.width(), size.height());
+}
+
+QWindow* QSWaylandLayerSurface::qwindow() { return this->window()->window(); }
+
+void QSWaylandLayerSurface::updateLayer() { this->set_layer(toWaylandLayer(this->ext->mLayer)); }
+
+void QSWaylandLayerSurface::updateAnchors() {
+	this->set_anchor(toWaylandAnchors(this->ext->mAnchors));
+	this->setWindowGeometry(this->window()->windowContentGeometry());
+}
+
+void QSWaylandLayerSurface::updateMargins() {
+	auto& margins = this->ext->mMargins;
+	this->set_margin(margins.mTop, margins.mRight, margins.mBottom, margins.mLeft);
+}
+
+void QSWaylandLayerSurface::updateExclusiveZone() {
+	this->set_exclusive_zone(this->ext->mExclusiveZone);
+}
+
+void QSWaylandLayerSurface::updateKeyboardFocus() {
+	this->set_keyboard_interactivity(toWaylandKeyboardFocus(this->ext->mKeyboardFocus));
+}
+
+QtWayland::zwlr_layer_shell_v1::layer toWaylandLayer(const Layer::Enum& layer) noexcept {
+	switch (layer) {
+	case Layer::Background: return QtWayland::zwlr_layer_shell_v1::layer_background;
+	case Layer::Bottom: return QtWayland::zwlr_layer_shell_v1::layer_bottom;
+	case Layer::Top: return QtWayland::zwlr_layer_shell_v1::layer_top;
+	case Layer::Overlay: return QtWayland::zwlr_layer_shell_v1::layer_overlay;
+	}
+
+	return QtWayland::zwlr_layer_shell_v1::layer_top;
+}
+
+QtWayland::zwlr_layer_surface_v1::anchor toWaylandAnchors(const Anchors& anchors) noexcept {
+	quint32 wl = 0;
+	if (anchors.mLeft) wl |= QtWayland::zwlr_layer_surface_v1::anchor_left;
+	if (anchors.mRight) wl |= QtWayland::zwlr_layer_surface_v1::anchor_right;
+	if (anchors.mTop) wl |= QtWayland::zwlr_layer_surface_v1::anchor_top;
+	if (anchors.mBottom) wl |= QtWayland::zwlr_layer_surface_v1::anchor_bottom;
+	return static_cast<QtWayland::zwlr_layer_surface_v1::anchor>(wl);
+}
+
+QtWayland::zwlr_layer_surface_v1::keyboard_interactivity
+toWaylandKeyboardFocus(const KeyboardFocus::Enum& focus) noexcept {
+	switch (focus) {
+	case KeyboardFocus::None: return QtWayland::zwlr_layer_surface_v1::keyboard_interactivity_none;
+	case KeyboardFocus::Exclusive:
+		return QtWayland::zwlr_layer_surface_v1::keyboard_interactivity_exclusive;
+	case KeyboardFocus::OnDemand:
+		return QtWayland::zwlr_layer_surface_v1::keyboard_interactivity_on_demand;
+	}
+
+	return QtWayland::zwlr_layer_surface_v1::keyboard_interactivity_none;
+}
+
+QSize constrainedSize(const Anchors& anchors, const QSize& size) noexcept {
+	return QSize(
+	    anchors.horizontalConstraint() ? 0 : size.width(),
+	    anchors.verticalConstraint() ? 0 : size.height()
+	);
+}

src/wayland/wlr_layershell/surface.hpp

@@ -0,0 +1,48 @@
+#pragma once
+
+#include <private/qwaylandshellsurface_p.h>
+#include <private/qwaylandwindow_p.h>
+#include <qtwaylandclientexports.h>
+#include <qtypes.h>
+#include <qwayland-wlr-layer-shell-unstable-v1.h>
+#include <qwindow.h>
+
+#include "shell_integration.hpp"
+#include "window.hpp"
+
+class QSWaylandLayerSurface
+    : public QtWaylandClient::QWaylandShellSurface
+    , public QtWayland::zwlr_layer_surface_v1 {
+public:
+	QSWaylandLayerSurface(
+	    QSWaylandLayerShellIntegration* shell,
+	    QtWaylandClient::QWaylandWindow* window
+	);
+
+	~QSWaylandLayerSurface() override;
+	QSWaylandLayerSurface(QSWaylandLayerSurface&&) = delete;
+	QSWaylandLayerSurface(const QSWaylandLayerSurface&) = delete;
+	void operator=(QSWaylandLayerSurface&&) = delete;
+	void operator=(const QSWaylandLayerSurface&) = delete;
+
+	[[nodiscard]] bool isExposed() const override;
+	void applyConfigure() override;
+	void setWindowGeometry(const QRect& geometry) override;
+
+private:
+	void zwlr_layer_surface_v1_configure(quint32 serial, quint32 width, quint32 height) override;
+	void zwlr_layer_surface_v1_closed() override;
+
+	QWindow* qwindow();
+	void updateLayer();
+	void updateAnchors();
+	void updateMargins();
+	void updateExclusiveZone();
+	void updateKeyboardFocus();
+
+	LayershellWindowExtension* ext;
+	QSize size;
+	bool configured = false;
+
+	friend class LayershellWindowExtension;
+};

src/wayland/wlr_layershell/window.cpp

@@ -0,0 +1,145 @@
+#include "window.hpp"
+#include <utility>
+
+#include <private/qwaylandwindow_p.h>
+#include <qlogging.h>
+#include <qobject.h>
+#include <qtmetamacros.h>
+#include <qtypes.h>
+#include <qvariant.h>
+#include <qwindow.h>
+
+#include "../../core/panelinterface.hpp"
+#include "shell_integration.hpp"
+#include "surface.hpp"
+
+LayershellWindowExtension* LayershellWindowExtension::get(QWindow* window) {
+	auto v = window->property("layershell_ext");
+
+	if (v.canConvert<LayershellWindowExtension*>()) {
+		return v.value<LayershellWindowExtension*>();
+	} else {
+		return nullptr;
+	}
+}
+
+bool LayershellWindowExtension::attach(QWindow* window) {
+	if (this->surface != nullptr)
+		throw "Cannot change the attached window of a LayershellWindowExtension";
+
+	auto* current = LayershellWindowExtension::get(window);
+
+	bool hasSurface = false;
+
+	if (current != nullptr) {
+		if (current->mNamespace != this->mNamespace) return false;
+
+		if (current->surface != nullptr) {
+			if (current->surface->qwindow()->screen() != window->screen()) return false;
+			this->surface = current->surface;
+
+			// update window with current settings, leveraging old extension's cached values
+			current->setAnchors(this->mAnchors);
+			current->setMargins(this->mMargins);
+			current->setExclusiveZone(this->mExclusiveZone);
+			current->setLayer(this->mLayer);
+			current->setKeyboardFocus(this->mKeyboardFocus);
+
+			this->surface->ext = this;
+			current->surface = nullptr;
+			current->deleteLater();
+
+			hasSurface = true;
+		}
+	}
+
+	if (!hasSurface) {
+		window->create();
+
+		auto* waylandWindow = dynamic_cast<QtWaylandClient::QWaylandWindow*>(window->handle());
+		if (waylandWindow == nullptr) {
+			qWarning() << window << "is not a wayland window. Cannot create layershell surface.";
+			return false;
+		}
+
+		static QSWaylandLayerShellIntegration* layershellIntegration = nullptr; // NOLINT
+		if (layershellIntegration == nullptr) {
+			layershellIntegration = new QSWaylandLayerShellIntegration();
+			if (!layershellIntegration->initialize(waylandWindow->display())) {
+				delete layershellIntegration;
+				layershellIntegration = nullptr;
+				qWarning() << "Failed to initialize layershell integration";
+			}
+		}
+
+		waylandWindow->setShellIntegration(layershellIntegration);
+	}
+
+	this->setParent(window);
+	window->setProperty("layershell_ext", QVariant::fromValue(this));
+	return true;
+}
+
+void LayershellWindowExtension::setAnchors(Anchors anchors) {
+	if (anchors != this->mAnchors) {
+		this->mAnchors = anchors;
+		if (this->surface != nullptr) this->surface->updateAnchors();
+		emit this->anchorsChanged();
+	}
+}
+
+Anchors LayershellWindowExtension::anchors() const { return this->mAnchors; }
+
+void LayershellWindowExtension::setMargins(Margins margins) {
+	if (margins != this->mMargins) {
+		this->mMargins = margins;
+		if (this->surface != nullptr) this->surface->updateMargins();
+		emit this->marginsChanged();
+	}
+}
+
+Margins LayershellWindowExtension::margins() const { return this->mMargins; }
+
+void LayershellWindowExtension::setExclusiveZone(qint32 exclusiveZone) {
+	if (exclusiveZone != this->mExclusiveZone) {
+		this->mExclusiveZone = exclusiveZone;
+		if (this->surface != nullptr) this->surface->updateExclusiveZone();
+		emit this->exclusiveZoneChanged();
+	}
+}
+
+qint32 LayershellWindowExtension::exclusiveZone() const { return this->mExclusiveZone; }
+
+void LayershellWindowExtension::setLayer(Layer::Enum layer) {
+	if (layer != this->mLayer) {
+		this->mLayer = layer;
+		if (this->surface != nullptr) this->surface->updateLayer();
+		emit this->layerChanged();
+	}
+}
+
+Layer::Enum LayershellWindowExtension::layer() const { return this->mLayer; }
+
+void LayershellWindowExtension::setKeyboardFocus(KeyboardFocus::Enum focus) {
+	if (focus != this->mKeyboardFocus) {
+		this->mKeyboardFocus = focus;
+		if (this->surface != nullptr) this->surface->updateKeyboardFocus();
+		emit this->keyboardFocusChanged();
+	}
+}
+
+KeyboardFocus::Enum LayershellWindowExtension::keyboardFocus() const {
+	return this->mKeyboardFocus;
+}
+
+void LayershellWindowExtension::setUseWindowScreen(bool value) {
+	this->useWindowScreen = value; // has no effect post configure
+}
+
+void LayershellWindowExtension::setNamespace(QString ns) {
+	if (!this->isConfigured()) this->mNamespace = std::move(ns);
+}
+
+QString LayershellWindowExtension::ns() const { return this->mNamespace; }
+
+bool LayershellWindowExtension::isConfigured() const { return this->surface != nullptr; }

src/wayland/wlr_layershell/window.hpp

@@ -0,0 +1,114 @@
+#pragma once
+
+#include <qobject.h>
+#include <qscreen.h>
+#include <qtmetamacros.h>
+#include <qtypes.h>
+#include <qwindow.h>
+
+#include "../../core/panelinterface.hpp"
+
+namespace Layer { // NOLINT
+Q_NAMESPACE;
+QML_ELEMENT;
+
+enum Enum {
+	Background = 0,
+	/// Above background, usually below windows
+	Bottom = 1,
+	/// Commonly used for panels, app launchers, and docks.
+	/// Usually renders over normal windows and below fullscreen windows.
+	Top = 2,
+	/// Usually renders over fullscreen windows
+	Overlay = 3,
+};
+Q_ENUM_NS(Enum);
+
+} // namespace Layer
+
+/// Type of keyboard focus that will be accepted by a [ShellWindow]
+///
+/// [ShellWindow]: ../shellwindow
+namespace KeyboardFocus { // NOLINT
+Q_NAMESPACE;
+QML_ELEMENT;
+
+enum Enum {
+	/// No keyboard input will be accepted.
+	None = 0,
+	/// Exclusive access to the keyboard, locking out all other windows.
+	Exclusive = 1,
+	/// Access to the keyboard as determined by the operating system.
+	///
+	/// > [!WARNING] On some systems, `OnDemand` may cause the shell window to
+	/// > retain focus over another window unexpectedly.
+	/// > You should try `None` if you experience issues.
+	OnDemand = 2,
+};
+Q_ENUM_NS(Enum);
+
+} // namespace KeyboardFocus
+
+class QSWaylandLayerSurface;
+
+class LayershellWindowExtension: public QObject {
+	Q_OBJECT;
+
+public:
+	LayershellWindowExtension(QObject* parent = nullptr): QObject(parent) {}
+	~LayershellWindowExtension() override = default;
+	LayershellWindowExtension(LayershellWindowExtension&&) = delete;
+	LayershellWindowExtension(const LayershellWindowExtension&) = delete;
+	void operator=(LayershellWindowExtension&&) = delete;
+	void operator=(const LayershellWindowExtension&) = delete;
+
+	// returns the layershell extension if attached, otherwise nullptr
+	static LayershellWindowExtension* get(QWindow* window);
+
+	// Attach this layershell extension to the given window.
+	// The extension is reparented to the window and replaces any existing extensions.
+	// Returns false if the window cannot be used.
+	bool attach(QWindow* window);
+
+	void setAnchors(Anchors anchors);
+	[[nodiscard]] Anchors anchors() const;
+
+	void setMargins(Margins margins);
+	[[nodiscard]] Margins margins() const;
+
+	void setExclusiveZone(qint32 exclusiveZone);
+	[[nodiscard]] qint32 exclusiveZone() const;
+
+	void setLayer(Layer::Enum layer);
+	[[nodiscard]] Layer::Enum layer() const;
+
+	void setKeyboardFocus(KeyboardFocus::Enum focus);
+	[[nodiscard]] KeyboardFocus::Enum keyboardFocus() const;
+
+	// no effect if configured
+	void setUseWindowScreen(bool value);
+	void setNamespace(QString ns);
+	[[nodiscard]] QString ns() const;
+	[[nodiscard]] bool isConfigured() const;
+
+signals:
+	void anchorsChanged();
+	void marginsChanged();
+	void exclusiveZoneChanged();
+	void layerChanged();
+	void keyboardFocusChanged();
+
+private:
+	// if configured the screen cannot be changed
+	QSWaylandLayerSurface* surface = nullptr;
+
+	bool useWindowScreen = false;
+	Anchors mAnchors;
+	Margins mMargins;
+	qint32 mExclusiveZone = 0;
+	Layer::Enum mLayer = Layer::Top;
+	QString mNamespace = "quickshell";
+	KeyboardFocus::Enum mKeyboardFocus = KeyboardFocus::None;
+
+	friend class QSWaylandLayerSurface;
+};

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

@@ -0,0 +1,407 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<protocol name="wlr_layer_shell_unstable_v1">
+  <copyright>
+    Copyright © 2017 Drew DeVault
+
+    Permission to use, copy, modify, distribute, and sell this
+    software and its documentation for any purpose is hereby granted
+    without fee, provided that the above copyright notice appear in
+    all copies and that both that copyright notice and this permission
+    notice appear in supporting documentation, and that the name of
+    the copyright holders not be used in advertising or publicity
+    pertaining to distribution of the software without specific,
+    written prior permission.  The copyright holders make no
+    representations about the suitability of this software for any
+    purpose.  It is provided "as is" without express or implied
+    warranty.
+
+    THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS
+    SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
+    FITNESS, IN NO EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY
+    SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+    WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
+    AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
+    ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF
+    THIS SOFTWARE.
+  </copyright>
+
+  <interface name="zwlr_layer_shell_v1" version="5">
+    <description summary="create surfaces that are layers of the desktop">
+      Clients can use this interface to assign the surface_layer role to
+      wl_surfaces. Such surfaces are assigned to a "layer" of the output and
+      rendered with a defined z-depth respective to each other. They may also be
+      anchored to the edges and corners of a screen and specify input handling
+      semantics. This interface should be suitable for the implementation of
+      many desktop shell components, and a broad number of other applications
+      that interact with the desktop.
+    </description>
+
+    <request name="get_layer_surface">
+      <description summary="create a layer_surface from a surface">
+        Create a layer surface for an existing surface. This assigns the role of
+        layer_surface, or raises a protocol error if another role is already
+        assigned.
+
+        Creating a layer surface from a wl_surface which has a buffer attached
+        or committed is a client error, and any attempts by a client to attach
+        or manipulate a buffer prior to the first layer_surface.configure call
+        must also be treated as errors.
+
+        After creating a layer_surface object and setting it up, the client
+        must perform an initial commit without any buffer attached.
+        The compositor will reply with a layer_surface.configure event.
+        The client must acknowledge it and is then allowed to attach a buffer
+        to map the surface.
+
+        You may pass NULL for output to allow the compositor to decide which
+        output to use. Generally this will be the one that the user most
+        recently interacted with.
+
+        Clients can specify a namespace that defines the purpose of the layer
+        surface.
+      </description>
+      <arg name="id" type="new_id" interface="zwlr_layer_surface_v1"/>
+      <arg name="surface" type="object" interface="wl_surface"/>
+      <arg name="output" type="object" interface="wl_output" allow-null="true"/>
+      <arg name="layer" type="uint" enum="layer" summary="layer to add this surface to"/>
+      <arg name="namespace_" type="string" summary="namespace for the layer surface"/>
+    </request>
+
+    <enum name="error">
+      <entry name="role" value="0" summary="wl_surface has another role"/>
+      <entry name="invalid_layer" value="1" summary="layer value is invalid"/>
+      <entry name="already_constructed" value="2" summary="wl_surface has a buffer attached or committed"/>
+    </enum>
+
+    <enum name="layer">
+      <description summary="available layers for surfaces">
+        These values indicate which layers a surface can be rendered in. They
+        are ordered by z depth, bottom-most first. Traditional shell surfaces
+        will typically be rendered between the bottom and top layers.
+        Fullscreen shell surfaces are typically rendered at the top layer.
+        Multiple surfaces can share a single layer, and ordering within a
+        single layer is undefined.
+      </description>
+
+      <entry name="background" value="0"/>
+      <entry name="bottom" value="1"/>
+      <entry name="top" value="2"/>
+      <entry name="overlay" value="3"/>
+    </enum>
+
+    <!-- Version 3 additions -->
+
+    <request name="destroy" type="destructor" since="3">
+      <description summary="destroy the layer_shell object">
+        This request indicates that the client will not use the layer_shell
+        object any more. Objects that have been created through this instance
+        are not affected.
+      </description>
+    </request>
+  </interface>
+
+  <interface name="zwlr_layer_surface_v1" version="5">
+    <description summary="layer metadata interface">
+      An interface that may be implemented by a wl_surface, for surfaces that
+      are designed to be rendered as a layer of a stacked desktop-like
+      environment.
+
+      Layer surface state (layer, size, anchor, exclusive zone,
+      margin, interactivity) is double-buffered, and will be applied at the
+      time wl_surface.commit of the corresponding wl_surface is called.
+
+      Attaching a null buffer to a layer surface unmaps it.
+
+      Unmapping a layer_surface means that the surface cannot be shown by the
+      compositor until it is explicitly mapped again. The layer_surface
+      returns to the state it had right after layer_shell.get_layer_surface.
+      The client can re-map the surface by performing a commit without any
+      buffer attached, waiting for a configure event and handling it as usual.
+    </description>
+
+    <request name="set_size">
+      <description summary="sets the size of the surface">
+        Sets the size of the surface in surface-local coordinates. The
+        compositor will display the surface centered with respect to its
+        anchors.
+
+        If you pass 0 for either value, the compositor will assign it and
+        inform you of the assignment in the configure event. You must set your
+        anchor to opposite edges in the dimensions you omit; not doing so is a
+        protocol error. Both values are 0 by default.
+
+        Size is double-buffered, see wl_surface.commit.
+      </description>
+      <arg name="width" type="uint"/>
+      <arg name="height" type="uint"/>
+    </request>
+
+    <request name="set_anchor">
+      <description summary="configures the anchor point of the surface">
+        Requests that the compositor anchor the surface to the specified edges
+        and corners. If two orthogonal edges are specified (e.g. 'top' and
+        'left'), then the anchor point will be the intersection of the edges
+        (e.g. the top left corner of the output); otherwise the anchor point
+        will be centered on that edge, or in the center if none is specified.
+
+        Anchor is double-buffered, see wl_surface.commit.
+      </description>
+      <arg name="anchor" type="uint" enum="anchor"/>
+    </request>
+
+    <request name="set_exclusive_zone">
+      <description summary="configures the exclusive geometry of this surface">
+        Requests that the compositor avoids occluding an area with other
+        surfaces. The compositor's use of this information is
+        implementation-dependent - do not assume that this region will not
+        actually be occluded.
+
+        A positive value is only meaningful if the surface is anchored to one
+        edge or an edge and both perpendicular edges. If the surface is not
+        anchored, anchored to only two perpendicular edges (a corner), anchored
+        to only two parallel edges or anchored to all edges, a positive value
+        will be treated the same as zero.
+
+        A positive zone is the distance from the edge in surface-local
+        coordinates to consider exclusive.
+
+        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.
+
+        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.
+
+        The default value is 0.
+
+        Exclusive zone is double-buffered, see wl_surface.commit.
+      </description>
+      <arg name="zone" type="int"/>
+    </request>
+
+    <request name="set_margin">
+      <description summary="sets a margin from the anchor point">
+        Requests that the surface be placed some distance away from the anchor
+        point on the output, in surface-local coordinates. Setting this value
+        for edges you are not anchored to has no effect.
+
+        The exclusive zone includes the margin.
+
+        Margin is double-buffered, see wl_surface.commit.
+      </description>
+      <arg name="top" type="int"/>
+      <arg name="right" type="int"/>
+      <arg name="bottom" type="int"/>
+      <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 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.
+
+        Keyboard interactivity is double-buffered, see wl_surface.commit.
+      </description>
+      <arg name="keyboard_interactivity" type="uint" enum="keyboard_interactivity"/>
+    </request>
+
+    <request name="get_popup">
+      <description summary="assign this layer_surface as an xdg_popup parent">
+        This assigns an xdg_popup's parent to this layer_surface.  This popup
+        should have been created via xdg_surface::get_popup with the parent set
+        to NULL, and this request must be invoked before committing the popup's
+        initial state.
+
+        See the documentation of xdg_popup for more details about what an
+        xdg_popup is and how it is used.
+      </description>
+      <arg name="popup" type="object" interface="xdg_popup"/>
+    </request>
+
+    <request name="ack_configure">
+      <description summary="ack a configure event">
+        When a configure event is received, if a client commits the
+        surface in response to the configure event, then the client
+        must make an ack_configure request sometime before the commit
+        request, passing along the serial of the configure event.
+
+        If the client receives multiple configure events before it
+        can respond to one, it only has to ack the last configure event.
+
+        A client is not required to commit immediately after sending
+        an ack_configure request - it may even ack_configure several times
+        before its next surface commit.
+
+        A client may send multiple ack_configure requests before committing, but
+        only the last request sent before a commit indicates which configure
+        event the client really is responding to.
+      </description>
+      <arg name="serial" type="uint" summary="the serial from the configure event"/>
+    </request>
+
+    <request name="destroy" type="destructor">
+      <description summary="destroy the layer_surface">
+        This request destroys the layer surface.
+      </description>
+    </request>
+
+    <event name="configure">
+      <description summary="suggest a surface change">
+        The configure event asks the client to resize its surface.
+
+        Clients should arrange their surface for the new states, and then send
+        an ack_configure request with the serial sent in this configure event at
+        some point before committing the new surface.
+
+        The client is free to dismiss all but the last configure event it
+        received.
+
+        The width and height arguments specify the size of the window in
+        surface-local coordinates.
+
+        The size is a hint, in the sense that the client is free to ignore it if
+        it doesn't resize, pick a smaller size (to satisfy aspect ratio or
+        resize in steps of NxM pixels). If the client picks a smaller size and
+        is anchored to two opposite anchors (e.g. 'top' and 'bottom'), the
+        surface will be centered on this axis.
+
+        If the width or height arguments are zero, it means the client should
+        decide its own window dimension.
+      </description>
+      <arg name="serial" type="uint"/>
+      <arg name="width" type="uint"/>
+      <arg name="height" type="uint"/>
+    </event>
+
+    <event name="closed">
+      <description summary="surface should be closed">
+        The closed event is sent by the compositor when the surface will no
+        longer be shown. The output may have been destroyed or the user may
+        have asked for it to be removed. Further changes to the surface will be
+        ignored. The client should destroy the resource after receiving this
+        event, and create a new surface if they so choose.
+      </description>
+    </event>
+
+    <enum name="error">
+      <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"/>
+    </enum>
+
+    <enum name="anchor" bitfield="true">
+      <entry name="top" value="1" summary="the top edge of the anchor rectangle"/>
+      <entry name="bottom" value="2" summary="the bottom edge of the anchor rectangle"/>
+      <entry name="left" value="4" summary="the left edge of the anchor rectangle"/>
+      <entry name="right" value="8" summary="the right edge of the anchor rectangle"/>
+    </enum>
+
+    <!-- Version 2 additions -->
+
+    <request name="set_layer" since="2">
+      <description summary="change the layer of the surface">
+        Change the layer that the surface is rendered on.
+
+        Layer is double-buffered, see wl_surface.commit.
+      </description>
+      <arg name="layer" type="uint" enum="zwlr_layer_shell_v1.layer" summary="layer to move this surface to"/>
+    </request>
+
+    <!-- Version 5 additions -->
+
+    <request name="set_exclusive_edge" since="5">
+      <description summary="set the edge the exclusive zone will be applied to">
+        Requests an edge for the exclusive zone to apply. The exclusive
+        edge will be automatically deduced from anchor points when possible,
+        but when the surface is anchored to a corner, it will be necessary
+        to set it explicitly to disambiguate, as it is not possible to deduce
+        which one of the two corner edges should be used.
+
+        The edge must be one the surface is anchored to, otherwise the
+        invalid_exclusive_edge protocol error will be raised.
+      </description>
+      <arg name="edge" type="uint" enum="anchor"/>
+    </request>
+  </interface>
+</protocol>