update version for new release

This matches the geometry used in the setWindowGeometry() function.

(cherry picked from commit e8594be884)

.gitignore

@@ -0,0 +1,29 @@
+# SPDX-License-Identifier: CC0-1.0
+# SPDX-FileCopyrightText: none
+# Ignore the following files
+.vscode
+*~
+*.[oa]
+*.diff
+*.kate-swp
+*.kdev4
+.kdev_include_paths
+*.kdevelop.pcs
+*.moc
+*.moc.cpp
+*.orig
+*.user
+.*.swp
+.swp.*
+Doxyfile
+Makefile
+avail
+random_seed
+/build*/
+CMakeLists.txt.user*
+.clang-format
+/compile_commands.json
+.clangd
+.idea
+/cmake-build*
+.cache

.gitlab-ci.yml

@@ -0,0 +1,9 @@
+# SPDX-FileCopyrightText: None
+# SPDX-License-Identifier: CC0-1.0
+
+include:
+  - project: sysadmin/ci-utilities
+    file:
+      - /gitlab-templates/reuse-lint.yml
+      - /gitlab-templates/linux-qt6.yml
+      - /gitlab-templates/freebsd-qt6.yml

.kde-ci.yml

@@ -0,0 +1,9 @@
+# SPDX-FileCopyrightText: None
+# SPDX-License-Identifier: CC0-1.0
+
+Dependencies:
+- 'on': ['@all']
+  'require':
+    'frameworks/extra-cmake-modules': '@latest-kf6'
+    'third-party/wayland': '@latest'
+    'third-party/wayland-protocols': '@latest'

CMakeLists.txt

@@ -4,35 +4,42 @@
 cmake_minimum_required(VERSION 3.16)
 
 project(layershellqt)
-set(PROJECT_VERSION "5.21.80")
+set(PROJECT_VERSION "6.0.5")
-set(PROJECT_VERSION_MAJOR 5)
+set(PROJECT_VERSION_MAJOR 6)
 
-set(QT_MIN_VERSION "5.15.0")
+set(CMAKE_C_STANDARD 99)
-set(KF5_MIN_VERSION "5.78")
 
-set(CMAKE_CXX_STANDARD 17)
+set(QT_MIN_VERSION "6.6.0")
+set(KF6_MIN_VERSION "6.0.0")
+set(KDE_COMPILERSETTINGS_LEVEL "5.82")
+
+set(CMAKE_CXX_STANDARD 20)
 set(CMAKE_CXX_STANDARD_REQUIRED ON)
 
-find_package(Qt5 ${QT_MIN_VERSION} CONFIG REQUIRED COMPONENTS WaylandClient Qml)
+find_package(ECM ${KF6_MIN_VERSION} REQUIRED NO_MODULE)
-find_package(Qt5XkbCommonSupport REQUIRED PRIVATE)
-find_package(ECM ${KF5_MIN_VERSION} REQUIRED NO_MODULE)
 set(CMAKE_MODULE_PATH ${CMAKE_CURRENT_SOURCE_DIR}/cmake ${ECM_MODULE_PATH})
 
 include(KDEInstallDirs)
 include(KDECMakeSettings)
 include(KDECompilerSettings NO_POLICY_SCOPE)
 include(ECMSetupVersion)
+include(ECMDeprecationSettings)
 include(ECMGenerateHeaders)
 include(CMakePackageConfigHelpers)
 include(FeatureSummary)
 include(GenerateExportHeader)
 include(KDEClangFormat)
 include(ECMQtDeclareLoggingCategory)
+include(ECMQmlModule)
 
-find_package(WaylandScanner)
+
-find_package(QtWaylandScanner)
+find_package(Qt6 ${QT_MIN_VERSION} CONFIG REQUIRED COMPONENTS WaylandClient Qml)
+find_package(WaylandScanner REQUIRED)
 find_package(Wayland 1.3 COMPONENTS Client Server)
-find_package(WaylandProtocols)
+find_package(WaylandProtocols REQUIRED)
+find_package(PkgConfig REQUIRED)
+
+pkg_check_modules(XKBCOMMON xkbcommon REQUIRED IMPORTED_TARGET)
 
 set_package_properties(Wayland PROPERTIES
                        TYPE REQUIRED)
@@ -41,14 +48,19 @@ set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -std=gnu90")
 ecm_setup_version(${PROJECT_VERSION} VARIABLE_PREFIX LAYERSHELLQT
                         VERSION_HEADER "${CMAKE_CURRENT_BINARY_DIR}/layershellqt_version.h"
                         PACKAGE_VERSION_FILE "${CMAKE_CURRENT_BINARY_DIR}/LayerShellQtConfigVersion.cmake"
-                        SOVERSION 5)
+                        SOVERSION ${PROJECT_VERSION_MAJOR})
 
 file(GLOB_RECURSE ALL_CLANG_FORMAT_SOURCE_FILES *.cpp *.h)
 kde_clang_format(${ALL_CLANG_FORMAT_SOURCE_FILES})
+
+ecm_set_disabled_deprecation_versions(QT 6.5
+    KF 5.240
+)
+
 add_subdirectory(src)
 add_subdirectory(tests)
 
-set(CMAKECONFIG_INSTALL_DIR ${KDE_INSTALL_LIBDIR}/cmake/LayerShellQt)
+set(CMAKECONFIG_INSTALL_DIR ${KDE_INSTALL_CMAKEPACKAGEDIR}/LayerShellQt)
 install(EXPORT LayerShellQtTargets
         NAMESPACE LayerShellQt::
         DESTINATION ${CMAKECONFIG_INSTALL_DIR}

LayerShellQtConfig.cmake.in

@@ -4,6 +4,6 @@
 @PACKAGE_INIT@
 
 include(CMakeFindDependencyMacro)
-find_dependency(Qt5Gui "@QT_MIN_VERSION@")
+find_dependency(Qt6Gui "@QT_MIN_VERSION@")
 
 include("${CMAKE_CURRENT_LIST_DIR}/LayerShellQtTargets.cmake")

metainfo.yaml

@@ -0,0 +1,17 @@
+# SPDX-FileCopyrightText: None
+# SPDX-License-Identifier: CC0-1.0
+
+maintainer:
+- vladz
+description: Layer Shell Qt
+platforms:
+    - name: Linux
+    - name: FreeBSD
+portingAid: false
+deprecated: false
+release: true
+
+group: Plasma
+public_lib: true
+public_source_dirs:
+    - src/interfaces

src/CMakeLists.txt

@@ -3,10 +3,14 @@
 
 remove_definitions(-DQT_NO_SIGNALS_SLOTS_KEYWORDS)
 
-ecm_add_qtwayland_client_protocol(LAYER_SHELL_SOURCES PROTOCOL ${WaylandProtocols_DATADIR}/stable/xdg-shell/xdg-shell.xml BASENAME xdg-shell)
+add_library(LayerShellQtInterface)
-ecm_add_qtwayland_client_protocol(LAYER_SHELL_SOURCES PROTOCOL wlr-layer-shell-unstable-v1.xml BASENAME wlr-layer-shell-unstable-v1)
+qt6_generate_wayland_protocol_client_sources(LayerShellQtInterface FILES
+    ${WaylandProtocols_DATADIR}/stable/xdg-shell/xdg-shell.xml
+    ${WaylandProtocols_DATADIR}/staging/xdg-activation/xdg-activation-v1.xml
+    ${CMAKE_CURRENT_SOURCE_DIR}/wlr-layer-shell-unstable-v1.xml
+)
 
-ecm_qt_declare_logging_category(LAYER_SHELL_SOURCES
+ecm_qt_declare_logging_category(LayerShellQtInterface
     HEADER
         layershellqt_logging.h
     IDENTIFIER
@@ -15,19 +19,33 @@ ecm_qt_declare_logging_category(LAYER_SHELL_SOURCES
         layershellqt
 )
 
-add_library(LayerShellQtInterface SHARED qwaylandlayersurface.cpp interfaces/window.cpp interfaces/shell.cpp qwaylandlayershellintegration.cpp qwaylandlayershell.cpp ${LAYER_SHELL_SOURCES})
+target_sources(LayerShellQtInterface PRIVATE
-target_link_libraries(LayerShellQtInterface PRIVATE Qt::Gui Qt::WaylandClientPrivate Qt::XkbCommonSupportPrivate Wayland::Client)
+    qwaylandxdgactivationv1.cpp
+    qwaylandlayersurface.cpp
+    qwaylandlayershellintegration.cpp
+    interfaces/window.cpp
+    interfaces/shell.cpp
+)
+
+target_link_libraries(LayerShellQtInterface PUBLIC Qt::Gui)
+target_link_libraries(LayerShellQtInterface PRIVATE Qt::WaylandClientPrivate Wayland::Client PkgConfig::XKBCOMMON)
+if (TARGET Qt::XkbCommonSupportPrivate)
+    target_link_libraries(LayerShellQtInterface PRIVATE Qt::XkbCommonSupportPrivate)
+endif()
 target_include_directories(LayerShellQtInterface PUBLIC "$<BUILD_INTERFACE:${CMAKE_CURRENT_BINARY_DIR}/LayerShellQt>"
                                               INTERFACE "$<INSTALL_INTERFACE:${KDE_INSTALL_INCLUDEDIR}/>"
 )
 
-set_target_properties(LayerShellQtInterface PROPERTIES VERSION   ${LAYERSHELLQT_VERSION_STRING}
+set_target_properties(LayerShellQtInterface PROPERTIES VERSION   ${LAYERSHELLQT_VERSION}
                                                        SOVERSION ${LAYERSHELLQT_SOVERSION}
                                                        EXPORT_NAME Interface
 )
 
 add_library(layer-shell SHARED qwaylandlayershellintegrationplugin.cpp)
-target_link_libraries(layer-shell LayerShellQtInterface Qt::WaylandClient Qt::WaylandClientPrivate Qt::XkbCommonSupportPrivate Wayland::Client)
+target_link_libraries(layer-shell LayerShellQtInterface Qt::WaylandClient Qt::WaylandClientPrivate Wayland::Client PkgConfig::XKBCOMMON)
+if (TARGET Qt::XkbCommonSupportPrivate)
+    target_link_libraries(layer-shell Qt::XkbCommonSupportPrivate)
+endif()
 
 ecm_generate_headers(LayerShellQt_HEADERS
     HEADER_NAMES
@@ -45,7 +63,7 @@ generate_export_header(LayerShellQtInterface
 )
 
 install(TARGETS layer-shell
-        LIBRARY DESTINATION ${QT_PLUGIN_INSTALL_DIR}/wayland-shell-integration)
+        LIBRARY DESTINATION ${KDE_INSTALL_QTPLUGINDIR}/wayland-shell-integration)
 
 install(TARGETS LayerShellQtInterface EXPORT LayerShellQtTargets ${KDE_INSTALL_TARGETS_DEFAULT_ARGS})
 
@@ -54,3 +72,5 @@ install(FILES
     ${CMAKE_CURRENT_BINARY_DIR}/LayerShellQt/layershellqt_export.h
     DESTINATION ${KDE_INSTALL_INCLUDEDIR}/LayerShellQt COMPONENT Devel
 )
+
+add_subdirectory(declarative)

src/declarative/CMakeLists.txt

@@ -0,0 +1,10 @@
+# SPDX-FileCopyrightText: 2021 Aleix Pol Gonzalez <aleix.pol_gonzalez@mercedes-benz.com>
+# SPDX-License-Identifier: BSD-3-Clause
+
+ecm_add_qml_module(LayerShellQtQml
+                  URI "org.kde.layershell"
+                  VERSION 1.0
+                  SOURCES layershellqtplugin.cpp)
+target_link_libraries(LayerShellQtQml PRIVATE Qt::Qml LayerShellQtInterface)
+
+ecm_finalize_qml_module(LayerShellQtQml DESTINATION ${KDE_INSTALL_QMLDIR})

src/declarative/layershellqtplugin.cpp

@@ -0,0 +1,24 @@
+/*
+ *   SPDX-FileCopyrightText: 2023 Aleix Pol Gonzalez <aleix.pol_gonzalez@mercedes-benz.com>
+ *
+ *   SPDX-License-Identifier: LGPL-3.0-or-later
+ */
+
+#include <QQmlExtensionPlugin>
+#include "../interfaces/window.h"
+#include <qqml.h>
+
+QML_DECLARE_TYPEINFO(LayerShellQt::Window, QML_HAS_ATTACHED_PROPERTIES)
+
+class Plugin : public QQmlExtensionPlugin
+{
+    Q_PLUGIN_METADATA(IID "org.kde.layershellqt")
+    Q_OBJECT
+public:
+    void registerTypes(const char *uri) override {
+        Q_ASSERT(QLatin1String(uri) == QLatin1String("org.kde.layershell"));
+        qmlRegisterType<LayerShellQt::Window>(uri, 1, 0, "Window");
+    }
+};
+
+#include "layershellqtplugin.moc"

src/interfaces/shell.cpp

@@ -6,8 +6,8 @@
 
 #include "shell.h"
 #include <QByteArray>
-#include <qglobal.h>
 #include <layershellqt_logging.h>
+#include <qglobal.h>
 
 using namespace LayerShellQt;
 

src/interfaces/shell.h

@@ -8,6 +8,8 @@
 #define LAYERSHELLQTSHELL_H
 
 #include "layershellqt_export.h"
+#include "window.h"
+#include <QString>
 
 namespace LayerShellQt
 {

src/interfaces/window.cpp

@@ -5,68 +5,197 @@
  */
 
 #include "window.h"
-#include "../qwaylandlayersurface_p.h"
+#include "../qwaylandlayershellintegration_p.h"
+
 #include <layershellqt_logging.h>
-#include <private/qwaylandshellsurface_p.h>
+
-#include <private/qwaylandwindow_p.h>
+#include <QPointer>
+#include <optional>
+
+#include <QtWaylandClient/private/qwaylandwindow_p.h>
 
 using namespace LayerShellQt;
 
 class LayerShellQt::WindowPrivate
 {
 public:
-    WindowPrivate(QWaylandLayerSurface *surface)
+    WindowPrivate(QWindow *window)
-        : surface(surface)
+        : parentWindow(window)
     {
     }
 
-    QWaylandLayerSurface *const surface;
+    QWindow *parentWindow;
+    QString scope = QStringLiteral("window");
+    Window::Anchors anchors = {Window::AnchorTop | Window::AnchorBottom | Window::AnchorLeft | Window::AnchorRight};
+    int32_t exclusionZone = 0;
+    Window::Anchor exclusiveEdge = Window::AnchorNone;
+    Window::KeyboardInteractivity keyboardInteractivity = Window::KeyboardInteractivityOnDemand;
+    Window::Layer layer = Window::LayerTop;
+    QMargins margins;
+    Window::ScreenConfiguration screenConfiguration = Window::ScreenFromQWindow;
+    bool closeOnDismissed = true;
 };
 
-Window::~Window() = default;
+static QMap<QWindow *, Window *> s_map;
 
-void Window::setAnchor(Anchor anchor)
+Window::~Window()
 {
-    d->surface->setAnchor(anchor);
+    s_map.remove(d->parentWindow);
+}
+
+void Window::setAnchors(Anchors anchors)
+{
+    if (d->anchors != anchors) {
+        d->anchors = anchors;
+        Q_EMIT anchorsChanged();
+    }
+}
+
+Window::Anchors Window::anchors() const
+{
+    return d->anchors;
 }
 
 void Window::setExclusiveZone(int32_t zone)
 {
-    d->surface->setExclusiveZone(zone);
+    if (d->exclusionZone != zone) {
+        d->exclusionZone = zone;
+        Q_EMIT exclusionZoneChanged();
+    }
+}
+
+int32_t Window::exclusionZone() const
+{
+    return d->exclusionZone;
+}
+
+void Window::setExclusiveEdge(Window::Anchor edge)
+{
+    if (d->exclusiveEdge == edge) {
+        return;
+    }
+
+    d->exclusiveEdge = edge;
+    Q_EMIT exclusiveEdgeChanged();
+}
+
+Window::Anchor Window::exclusiveEdge() const
+{
+    return d->exclusiveEdge;
 }
 
 void Window::setMargins(const QMargins &margins)
 {
-    d->surface->setMargins(margins);
+    if (d->margins != margins) {
+        d->margins = margins;
+        Q_EMIT marginsChanged();
+    }
 }
 
-void Window::setKeyboardInteractivity(bool enabled)
+QMargins Window::margins() const
 {
-    d->surface->setKeyboardInteractivity(enabled);
+    return d->margins;
+}
+
+void Window::setKeyboardInteractivity(KeyboardInteractivity interactivity)
+{
+    if (d->keyboardInteractivity != interactivity) {
+        d->keyboardInteractivity = interactivity;
+        Q_EMIT keyboardInteractivityChanged();
+    }
+}
+
+Window::KeyboardInteractivity Window::keyboardInteractivity() const
+{
+    return d->keyboardInteractivity;
 }
 
 void Window::setLayer(Layer layer)
 {
-    d->surface->setLayer(layer);
+    if (d->layer != layer) {
+        d->layer = layer;
+        Q_EMIT layerChanged();
+    }
 }
 
-Window::Window(WindowPrivate *d)
+void Window::setScope(const QString &scope)
-    : d(d)
 {
+    d->scope = scope;
+    // this is static and must be set before the platform window is created
+}
+
+QString Window::scope() const
+{
+    return d->scope;
+}
+
+Window::Layer Window::layer() const
+{
+    return d->layer;
+}
+
+Window::ScreenConfiguration Window::screenConfiguration() const
+{
+    return d->screenConfiguration;
+}
+
+void Window::setScreenConfiguration(Window::ScreenConfiguration screenConfiguration)
+{
+    d->screenConfiguration = screenConfiguration;
+}
+
+bool Window::closeOnDismissed() const
+{
+    return d->closeOnDismissed;
+}
+
+void Window::setCloseOnDismissed(bool close)
+{
+    d->closeOnDismissed = close;
+}
+
+Window::Window(QWindow *window)
+    : QObject(window)
+    , d(new WindowPrivate(window))
+{
+    s_map.insert(d->parentWindow, this);
+
+    window->create();
+
+    auto waylandWindow = dynamic_cast<QtWaylandClient::QWaylandWindow *>(window->handle());
+    if (!waylandWindow) {
+        qCWarning(LAYERSHELLQT) << window << "is not a wayland window. Not creating zwlr_layer_surface";
+        return;
+    }
+
+    static QWaylandLayerShellIntegration *shellIntegration = nullptr;
+    if (!shellIntegration) {
+        shellIntegration = new QWaylandLayerShellIntegration();
+        if (!shellIntegration->initialize(waylandWindow->display())) {
+            delete shellIntegration;
+            shellIntegration = nullptr;
+            qCWarning(LAYERSHELLQT) << "Failed to initialize layer-shell integration, possibly because compositor does not support the layer-shell protocol";
+            return;
+        }
+    }
+
+    waylandWindow->setShellIntegration(shellIntegration);
 }
 
 Window *Window::get(QWindow *window)
 {
-    auto ww = dynamic_cast<QtWaylandClient::QWaylandWindow *>(window->handle());
+    if (!window) {
-    if (!ww) {
-        qCDebug(LAYERSHELLQT) << "window not a wayland window" << window;
-        return nullptr;
-    }
-    QWaylandLayerSurface *s = qobject_cast<QWaylandLayerSurface *>(ww->shellSurface());
-    if (!s) {
-        qCDebug(LAYERSHELLQT) << "window not using wlr-layer-shell" << window << ww->shellSurface();
         return nullptr;
     }
 
-    return new Window(new WindowPrivate(s));
+    auto layerShellWindow = s_map.value(window);
+    if (layerShellWindow) {
+        return layerShellWindow;
+    }
+    return new Window(window);
+}
+
+Window *Window::qmlAttachedProperties(QObject *object)
+{
+    return get(qobject_cast<QWindow *>(object));
 }

src/interfaces/window.h

@@ -9,6 +9,7 @@
 #define LAYERSHELLQTWINDOW_H
 
 #include <QObject>
+#include <QScreen>
 #include <QWindow>
 
 #include "layershellqt_export.h"
@@ -20,16 +21,26 @@ class WindowPrivate;
 class LAYERSHELLQT_EXPORT Window : public QObject
 {
     Q_OBJECT
+    Q_PROPERTY(Anchors anchors READ anchors WRITE setAnchors NOTIFY anchorsChanged)
+    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(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)
+
 public:
     ~Window() override;
 
     enum Anchor {
-        AnchorTop = 1, // the top edge of the anchor rectangle
+        AnchorNone = 0,
-        AnchorBottom = 2, // the bottom edge of the anchor rectangle
+        AnchorTop = 1, ///< The top edge of the anchor rectangle
-        AnchorLeft = 4, // the left edge of the anchor rectangle
+        AnchorBottom = 2, ///< The bottom edge of the anchor rectangle
-        AnchorRight = 8, // the right edge of the anchor rectangle
+        AnchorLeft = 4, ///< The left edge of the anchor rectangle
+        AnchorRight = 8, ///< The right edge of the anchor rectangle
     };
     Q_ENUM(Anchor);
+    Q_DECLARE_FLAGS(Anchors, Anchor)
 
     /**
      * This enum type is used to specify the layer where a surface can be put in.
@@ -42,16 +53,85 @@ public:
     };
     Q_ENUM(Layer)
 
-    void setAnchor(Anchor anchor);
+    /**
-    void setExclusiveZone(int32_t zone);
+     * This enum type is used to specify how the layer surface handles keyboard focus.
-    void setMargins(const QMargins &margins);
+     */
-    void setKeyboardInteractivity(bool enabled);
+    enum KeyboardInteractivity {
-    void setLayer(Layer layer);
+        KeyboardInteractivityNone = 0,
+        KeyboardInteractivityExclusive = 1,
+        KeyboardInteractivityOnDemand = 2,
+    };
+    Q_ENUM(KeyboardInteractivity)
 
+    /**
+     * This enum type is used to specify which screen to place the surface on.
+     * ScreenFromQWindow (the default) reads QWindow::screen() while ScreenFromCompositor
+     * passes nil and lets the compositor decide.
+     */
+    enum ScreenConfiguration {
+        ScreenFromQWindow = 0,
+        ScreenFromCompositor = 1,
+    };
+    Q_ENUM(ScreenConfiguration)
+
+    void setAnchors(Anchors anchor);
+    Anchors anchors() const;
+
+    void setExclusiveZone(int32_t zone);
+    int32_t exclusionZone() const;
+
+    void setExclusiveEdge(Window::Anchor edge);
+    Window::Anchor exclusiveEdge() const;
+
+    void setMargins(const QMargins &margins);
+    QMargins margins() const;
+
+    void setKeyboardInteractivity(KeyboardInteractivity interactivity);
+    KeyboardInteractivity keyboardInteractivity() const;
+
+    void setLayer(Layer layer);
+    Layer layer() const;
+
+    void setScreenConfiguration(ScreenConfiguration screenConfiguration);
+    ScreenConfiguration screenConfiguration() const;
+
+    /**
+     * Sets a string based identifier for this window.
+     * This may be used by a compositor to determine stacking
+     * order within a given layer.
+     *
+     * May also be referred to as a role
+     */
+    void setScope(const QString &scope);
+    QString scope() const;
+
+    /**
+     * Whether the QWindow should be closed when the layer surface is dismissed by the compositor.
+     * For example, if the associated screen has been removed.
+     *
+     * This can be used to map the window on another screen.
+     */
+    void setCloseOnDismissed(bool close);
+    bool closeOnDismissed() const;
+
+    /**
+     * Gets the LayerShell Window for a given Qt Window
+     * Ownership is not transferred
+     */
     static Window *get(QWindow *window);
 
+    static Window *qmlAttachedProperties(QObject *object);
+
+Q_SIGNALS:
+    void anchorsChanged();
+    void exclusionZoneChanged();
+    void exclusiveEdgeChanged();
+    void marginsChanged();
+    void keyboardInteractivityChanged();
+    void layerChanged();
+
 private:
-    Window(WindowPrivate *d);
+    Window(QWindow *window);
     QScopedPointer<WindowPrivate> d;
 };
 

src/qwaylandlayershell.cpp

@@ -1,29 +0,0 @@
-/*
- *   SPDX-FileCopyrightText: 2021 Aleix Pol Gonzalez <aleixpol@blue-systems.com>
- *   SPDX-FileCopyrightText: 2018 Drew DeVault <sir@cmpwn.com>
- *
- *   SPDX-License-Identifier: LGPL-3.0-or-later
- */
-
-#include "qwaylandlayershell_p.h"
-#include "qwaylandlayersurface_p.h"
-
-namespace LayerShellQt
-{
-QWaylandLayerShell::QWaylandLayerShell(QtWayland::zwlr_layer_shell_v1 *shell)
-    : QtWayland::zwlr_layer_shell_v1(shell->object())
-{
-}
-
-QWaylandLayerShell::~QWaylandLayerShell()
-{
-    if (zwlr_layer_shell_v1_get_version(object()) >= ZWLR_LAYER_SHELL_V1_DESTROY_SINCE_VERSION)
-        zwlr_layer_shell_v1_destroy(object());
-}
-
-QWaylandLayerSurface *QWaylandLayerShell::createLayerSurface(QtWaylandClient::QWaylandWindow *window)
-{
-    return new QWaylandLayerSurface(this, window);
-}
-
-}

src/qwaylandlayershell_p.h

@@ -1,32 +0,0 @@
-/*
- *   SPDX-FileCopyrightText: 2021 Aleix Pol Gonzalez <aleixpol@blue-systems.com>
- *   SPDX-FileCopyrightText: 2018 Drew DeVault <sir@cmpwn.com>
- *
- *   SPDX-License-Identifier: LGPL-3.0-or-later
- */
-
-#ifndef _LAYERSHELL_H
-#define _LAYERSHELL_H
-
-#include <wayland-client.h>
-
-#include <QtWaylandClient/private/qwaylandshellintegration_p.h>
-#include <qwayland-wlr-layer-shell-unstable-v1.h>
-
-#include "qwaylandlayersurface_p.h"
-
-namespace LayerShellQt
-{
-class LAYERSHELLQT_EXPORT QWaylandLayerShell : public QtWayland::zwlr_layer_shell_v1
-{
-public:
-    QWaylandLayerShell(QtWayland::zwlr_layer_shell_v1 *shell);
-    virtual ~QWaylandLayerShell();
-
-    QWaylandLayerSurface *createLayerSurface(QtWaylandClient::QWaylandWindow *window);
-    // TODO: Popups
-};
-
-}
-
-#endif

src/qwaylandlayershellintegration.cpp

@@ -5,39 +5,32 @@
  *   SPDX-License-Identifier: LGPL-3.0-or-later
  */
 
-#include "qwaylandlayershell_p.h"
 #include "qwaylandlayershellintegration_p.h"
+#include "qwaylandlayersurface_p.h"
+#include "qwaylandxdgactivationv1_p.h"
 
 #include <QtWaylandClient/private/qwaylanddisplay_p.h>
 #include <QtWaylandClient/private/qwaylandwindow_p.h>
-#include <qwayland-wlr-layer-shell-unstable-v1.h>
 
 namespace LayerShellQt
 {
 QWaylandLayerShellIntegration::QWaylandLayerShellIntegration()
+    : QWaylandShellIntegrationTemplate<QWaylandLayerShellIntegration>(5)
+    , m_xdgActivation(new QWaylandXdgActivationV1)
 {
 }
 
-bool QWaylandLayerShellIntegration::initialize(QtWaylandClient::QWaylandDisplay *display)
+QWaylandLayerShellIntegration::~QWaylandLayerShellIntegration()
 {
-    QWaylandShellIntegration::initialize(display);
+    if (object() && zwlr_layer_shell_v1_get_version(object()) >= ZWLR_LAYER_SHELL_V1_DESTROY_SINCE_VERSION) {
-    display->addRegistryListener(registryLayer, this);
+        zwlr_layer_shell_v1_destroy(object());
-    return m_layerShell != nullptr;
+    }
 }
 
 QtWaylandClient::QWaylandShellSurface *QWaylandLayerShellIntegration::createShellSurface(QtWaylandClient::QWaylandWindow *window)
 {
-    return m_layerShell->createLayerSurface(window);
+    return new QWaylandLayerSurface(this, window);
 }
 
-void QWaylandLayerShellIntegration::registryLayer(void *data, struct wl_registry *registry, uint32_t id, const QString &interface, uint32_t version)
-{
-    QWaylandLayerShellIntegration *shell = static_cast<QWaylandLayerShellIntegration *>(data);
-
-    if (interface == zwlr_layer_shell_v1_interface.name)
-        shell->m_layerShell = new QWaylandLayerShell(new QtWayland::zwlr_layer_shell_v1(registry, id, std::min(version, 3u)));
-}
 
 }
-
-//#include "qwaylandlayershellintegration.moc"

src/qwaylandlayershellintegration_p.h

@@ -8,27 +8,26 @@
 #ifndef _LAYERSHELLINTEGRATION_P_H
 #define _LAYERSHELLINTEGRATION_P_H
 
-#include <wayland-client.h>
-
 #include "layershellqt_export.h"
+
 #include <QtWaylandClient/private/qwaylandshellintegration_p.h>
+#include <qwayland-wlr-layer-shell-unstable-v1.h>
+
+class QWaylandXdgActivationV1;
 
 namespace LayerShellQt
 {
-class QWaylandLayerShell;
 
-class LAYERSHELLQT_EXPORT QWaylandLayerShellIntegration : public QtWaylandClient::QWaylandShellIntegration
+class LAYERSHELLQT_EXPORT QWaylandLayerShellIntegration : public QtWaylandClient::QWaylandShellIntegrationTemplate<QWaylandLayerShellIntegration>, public QtWayland::zwlr_layer_shell_v1
 {
 public:
     QWaylandLayerShellIntegration();
+    ~QWaylandLayerShellIntegration() override;
 
-    bool initialize(QtWaylandClient::QWaylandDisplay *display) override;
+    QWaylandXdgActivationV1 *activation() const { return m_xdgActivation.data(); }
     QtWaylandClient::QWaylandShellSurface *createShellSurface(QtWaylandClient::QWaylandWindow *window) override;
-
 private:
-    static void registryLayer(void *data, struct wl_registry *registry, uint32_t id, const QString &interface, uint32_t version);
+    QScopedPointer<QWaylandXdgActivationV1> m_xdgActivation;
-
-    QWaylandLayerShell *m_layerShell = nullptr;
 };
 
 }

src/qwaylandlayersurface.cpp

@@ -5,35 +5,83 @@
  *   SPDX-License-Identifier: LGPL-3.0-or-later
  */
 
-#include "qwaylandlayershell_p.h"
+#include "interfaces/window.h"
+#include "layershellqt_logging.h"
 #include "qwaylandlayersurface_p.h"
+#include "qwaylandxdgactivationv1_p.h"
 
 #include <QtWaylandClient/private/qwaylandscreen_p.h>
 #include <QtWaylandClient/private/qwaylandsurface_p.h>
 #include <QtWaylandClient/private/qwaylandwindow_p.h>
 
+#include <QGuiApplication>
+
 namespace LayerShellQt
 {
-QWaylandLayerSurface::QWaylandLayerSurface(QWaylandLayerShell *shell, QtWaylandClient::QWaylandWindow *window)
+QWaylandLayerSurface::QWaylandLayerSurface(QWaylandLayerShellIntegration *shell, QtWaylandClient::QWaylandWindow *window)
     : QtWaylandClient::QWaylandShellSurface(window)
-    , QtWayland::zwlr_layer_surface_v1(
+    , QtWayland::zwlr_layer_surface_v1()
-          // TODO: Specify namespace
+    , m_shell(shell)
-          shell->get_layer_surface(window->waylandSurface()->object(),
+    , m_interface(Window::get(window->window()))
-                                   window->waylandScreen()->output(),
+    , m_window(window)
-                                   QtWayland::zwlr_layer_shell_v1::layer_top,
-                                   QStringLiteral("qt")))
 {
-    set_anchor(anchor_top | anchor_bottom | anchor_left | anchor_right);
+    wl_output *output = nullptr;
+    if (m_interface->screenConfiguration() == Window::ScreenFromQWindow) {
+        auto waylandScreen = dynamic_cast<QtWaylandClient::QWaylandScreen *>(window->window()->screen()->handle());
+        // Qt will always assign a screen to a window, but if the compositor has no screens available a dummy QScreen object is created
+        // this will not cast to a QWaylandScreen
+        if (!waylandScreen) {
+            qCWarning(LAYERSHELLQT) << "Creating a layer shell for placeholder screen. This will be positioned incorrectly";
+        } else {
+            output = waylandScreen->output();
+        }
+    }
+    init(shell->get_layer_surface(window->waylandSurface()->object(), output, m_interface->layer(), m_interface->scope()));
+    connect(m_interface, &Window::layerChanged, this, [this]() {
+        setLayer(m_interface->layer());
+    });
+
+    setAnchor(m_interface->anchors());
+    connect(m_interface, &Window::anchorsChanged, this, [this]() {
+        setAnchor(m_interface->anchors());
+        setDesiredSize(m_window->windowContentGeometry().size());
+    });
+
+    setExclusiveZone(m_interface->exclusionZone());
+    connect(m_interface, &Window::exclusionZoneChanged, this, [this]() {
+        setExclusiveZone(m_interface->exclusionZone());
+    });
+    setExclusiveEdge(m_interface->exclusiveEdge());
+    connect(m_interface, &Window::exclusiveEdgeChanged, this, [this]() {
+        setExclusiveEdge(m_interface->exclusiveEdge());
+    });
+
+    setMargins(m_interface->margins());
+    connect(m_interface, &Window::marginsChanged, this, [this]() {
+        setMargins(m_interface->margins());
+    });
+
+    setKeyboardInteractivity(m_interface->keyboardInteractivity());
+    connect(m_interface, &Window::keyboardInteractivityChanged, this, [this]() {
+        setKeyboardInteractivity(m_interface->keyboardInteractivity());
+    });
+
+    setDesiredSize(window->windowContentGeometry().size());
 }
 
 QWaylandLayerSurface::~QWaylandLayerSurface()
 {
+    if (m_waitForSyncCallback) {
+        wl_callback_destroy(m_waitForSyncCallback);
+    }
     destroy();
 }
 
 void QWaylandLayerSurface::zwlr_layer_surface_v1_closed()
 {
-    window()->window()->close();
+    if (m_interface->closeOnDismissed()) {
+        window()->window()->close();
+    }
 }
 
 void QWaylandLayerSurface::zwlr_layer_surface_v1_configure(uint32_t serial, uint32_t width, uint32_t height)
@@ -43,8 +91,8 @@ void QWaylandLayerSurface::zwlr_layer_surface_v1_configure(uint32_t serial, uint
 
     if (!m_configured) {
         m_configured = true;
-        window()->resizeFromApplyConfigure(m_pendingSize);
+        applyConfigure();
-        window()->handleExpose(QRect(QPoint(), m_pendingSize));
+        sendExpose();
     } else {
         // Later configures are resizes, so we have to queue them up for a time when we
         // are not painting to the window.
@@ -52,9 +100,37 @@ void QWaylandLayerSurface::zwlr_layer_surface_v1_configure(uint32_t serial, uint
     }
 }
 
+void QWaylandLayerSurface::attachPopup(QtWaylandClient::QWaylandShellSurface *popup)
+{
+    std::any anyRole = popup->surfaceRole();
+
+    if (auto role = std::any_cast<::xdg_popup *>(&anyRole)) {
+        get_popup(*role);
+    } else {
+        qCWarning(LAYERSHELLQT) << "Cannot attach popup of unknown type";
+    }
+}
+
 void QWaylandLayerSurface::applyConfigure()
 {
+    m_configuring = true;
     window()->resizeFromApplyConfigure(m_pendingSize);
+    m_configuring = false;
+}
+
+void QWaylandLayerSurface::setDesiredSize(const QSize &size)
+{
+    const bool horizontallyConstrained = m_interface->anchors().testFlags({Window::AnchorLeft, Window::AnchorRight});
+    const bool verticallyConstrained = m_interface->anchors().testFlags({Window::AnchorTop, Window::AnchorBottom});
+
+    QSize effectiveSize = size;
+    if (horizontallyConstrained) {
+        effectiveSize.setWidth(0);
+    }
+    if (verticallyConstrained) {
+        effectiveSize.setHeight(0);
+    }
+    set_size(effectiveSize.width(), effectiveSize.height());
 }
 
 void QWaylandLayerSurface::setAnchor(uint anchor)
@@ -67,14 +143,21 @@ void QWaylandLayerSurface::setExclusiveZone(int32_t zone)
     set_exclusive_zone(zone);
 }
 
+void QWaylandLayerSurface::setExclusiveEdge(uint32_t edge)
+{
+    if (zwlr_layer_surface_v1_get_version(object()) >= ZWLR_LAYER_SURFACE_V1_SET_EXCLUSIVE_EDGE_SINCE_VERSION) {
+        set_exclusive_edge(edge);
+    }
+}
+
 void QWaylandLayerSurface::setMargins(const QMargins &margins)
 {
     set_margin(margins.top(), margins.right(), margins.bottom(), margins.left());
 }
 
-void QWaylandLayerSurface::setKeyboardInteractivity(bool enabled)
+void QWaylandLayerSurface::setKeyboardInteractivity(uint32_t interactivity)
 {
-    set_keyboard_interactivity(enabled);
+    set_keyboard_interactivity(interactivity);
 }
 
 void QWaylandLayerSurface::setLayer(uint32_t layer)
@@ -83,4 +166,100 @@ void QWaylandLayerSurface::setLayer(uint32_t layer)
         set_layer(layer);
 }
 
+void QWaylandLayerSurface::setWindowGeometry(const QRect &geometry)
+{
+    if (m_configuring) {
+        return;
+    }
+
+    setDesiredSize(geometry.size());
+    requestWaylandSync();
 }
+
+bool QWaylandLayerSurface::requestActivate()
+{
+    QWaylandXdgActivationV1 *activation = m_shell->activation();
+    if (!activation->isActive()) {
+        return false;
+    }
+    if (!m_activationToken.isEmpty()) {
+        activation->activate(m_activationToken, window()->wlSurface());
+        m_activationToken = {};
+        return true;
+    } else {
+        const auto focusWindow = QGuiApplication::focusWindow();
+        const auto wlWindow = focusWindow ? static_cast<QtWaylandClient::QWaylandWindow*>(focusWindow->handle()) : window();
+        if (const auto seat = wlWindow->display()->lastInputDevice()) {
+            const auto tokenProvider = activation->requestXdgActivationToken(
+                wlWindow->display(), wlWindow->wlSurface(), 0, QString());
+            connect(tokenProvider, &QWaylandXdgActivationTokenV1::done, this,
+                    [this](const QString &token) {
+                        m_shell->activation()->activate(token, window()->wlSurface());
+                    });
+            connect(tokenProvider, &QWaylandXdgActivationTokenV1::done, tokenProvider, &QObject::deleteLater);
+            return true;
+        }
+    }
+    return false;
+}
+
+void QWaylandLayerSurface::setXdgActivationToken(const QString &token)
+{
+    m_activationToken = token;
+}
+
+void QWaylandLayerSurface::requestXdgActivationToken(quint32 serial)
+{
+    QWaylandXdgActivationV1 *activation = m_shell->activation();
+    if (!activation->isActive()) {
+        return;
+    }
+    auto tokenProvider = activation->requestXdgActivationToken(
+        window()->display(), window()->wlSurface(), serial, QString());
+
+    connect(tokenProvider, &QWaylandXdgActivationTokenV1::done, this,
+            [this](const QString &token) {
+                Q_EMIT window()->xdgActivationTokenCreated(token);
+            });
+    connect(tokenProvider, &QWaylandXdgActivationTokenV1::done, tokenProvider, &QObject::deleteLater);
+}
+
+const wl_callback_listener QWaylandLayerSurface::syncCallbackListener = {
+    .done = [](void *data, struct wl_callback *callback, uint32_t time){
+        Q_UNUSED(time);
+        wl_callback_destroy(callback);
+        QWaylandLayerSurface *layerSurface = static_cast<QWaylandLayerSurface *>(data);
+        layerSurface->m_waitForSyncCallback = nullptr;
+        layerSurface->sendExpose();
+    }
+};
+
+void QWaylandLayerSurface::requestWaylandSync()
+{
+    if (m_waitForSyncCallback) {
+        return;
+    }
+
+    m_waitForSyncCallback = wl_display_sync(m_window->display()->wl_display());
+    wl_callback_add_listener(m_waitForSyncCallback, &syncCallbackListener, this);
+}
+
+void QWaylandLayerSurface::handleWaylandSyncDone()
+{
+    if (!window()->isExposed()) {
+        return;
+    }
+    sendExpose();
+}
+
+void QWaylandLayerSurface::sendExpose()
+{
+#if QT_VERSION < QT_VERSION_CHECK(6, 7, 0)
+    window()->handleExpose(QRect(QPoint(), m_pendingSize));
+#else
+    window()->sendRecursiveExposeEvent();
+#endif
+}
+
+}
+

src/qwaylandlayersurface_p.h

@@ -10,40 +10,63 @@
 
 #include <wayland-client.h>
 
+#include "qwaylandlayershellintegration_p.h"
+
 #include "layershellqt_export.h"
 #include <QtWaylandClient/private/qwaylandshellsurface_p.h>
 #include <qwayland-wlr-layer-shell-unstable-v1.h>
 
 namespace LayerShellQt
 {
-class QWaylandLayerShell;
+
+class Window;
 
 class LAYERSHELLQT_EXPORT QWaylandLayerSurface : public QtWaylandClient::QWaylandShellSurface, public QtWayland::zwlr_layer_surface_v1
 {
     Q_OBJECT
 public:
-    QWaylandLayerSurface(QWaylandLayerShell *shell, QtWaylandClient::QWaylandWindow *window);
+    QWaylandLayerSurface(QWaylandLayerShellIntegration *shell, QtWaylandClient::QWaylandWindow *window);
-    virtual ~QWaylandLayerSurface();
+    ~QWaylandLayerSurface() override;
 
     bool isExposed() const override
     {
-        return m_configured;
+        return m_configured && !m_waitForSyncCallback;
     }
+    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 setMargins(const QMargins &margins);
-    void setKeyboardInteractivity(bool enabled);
+    void setKeyboardInteractivity(uint32_t interactivity);
     void setLayer(uint32_t layer);
 
     void applyConfigure() override;
+    void setWindowGeometry(const QRect &geometry) override;
+
+    bool requestActivate() override;
+    void setXdgActivationToken(const QString &token) override;
+    void requestXdgActivationToken(quint32 serial) override;
 
 private:
+    void requestWaylandSync();
+    void handleWaylandSyncDone();
+    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;
 
+    QWaylandLayerShellIntegration *m_shell;
+    LayerShellQt::Window *m_interface;
+    QtWaylandClient::QWaylandWindow *m_window;
     QSize m_pendingSize;
+    QString m_activationToken;
+
     bool m_configured = false;
+    bool m_configuring = false;
+
+    static const wl_callback_listener syncCallbackListener;
+    struct wl_callback *m_waitForSyncCallback = nullptr;
 };
 
 }

src/qwaylandxdgactivationv1.cpp

@@ -0,0 +1,44 @@
+/** Copyright (C) 2020 Aleix Pol Gonzalez <aleixpol@kde.org>
+ *   SPDX-License-Identifier: LGPL-3.0-or-later
+ */
+
+#include "qwaylandxdgactivationv1_p.h"
+#include <QtWaylandClient/private/qwaylanddisplay_p.h>
+#include <QtWaylandClient/private/qwaylandinputdevice_p.h>
+
+QWaylandXdgActivationV1::QWaylandXdgActivationV1()
+    : QWaylandClientExtensionTemplate<QWaylandXdgActivationV1>(1)
+{
+    initialize();
+}
+
+QWaylandXdgActivationV1::~QWaylandXdgActivationV1()
+{
+    if (isActive()) {
+        destroy();
+    }
+}
+
+QWaylandXdgActivationTokenV1 *QWaylandXdgActivationV1::requestXdgActivationToken(QtWaylandClient::QWaylandDisplay *display,
+                                                                                 struct ::wl_surface *surface,
+                                                                                 std::optional<uint32_t> serial,
+                                                                                 const QString &app_id)
+{
+    auto wl = get_activation_token();
+    auto provider = new QWaylandXdgActivationTokenV1;
+    provider->init(wl);
+
+    if (surface) {
+        provider->set_surface(surface);
+    }
+    if (!app_id.isEmpty()) {
+        provider->set_app_id(app_id);
+    }
+    if (serial && display->lastInputDevice()) {
+        provider->set_serial(*serial, display->lastInputDevice()->wl_seat());
+    }
+    provider->commit();
+    return provider;
+}
+
+#include "moc_qwaylandxdgactivationv1_p.cpp"

src/qwaylandxdgactivationv1_p.h

@@ -0,0 +1,48 @@
+/** Copyright (C) 2020 Aleix Pol Gonzalez <aleixpol@kde.org>
+ *  SPDX-License-Identifier: LGPL-3.0-or-later
+ */
+
+#ifndef QWAYLANDXDGACTIVATIONV1_P_H
+#define QWAYLANDXDGACTIVATIONV1_P_H
+
+#include "qwayland-xdg-activation-v1.h"
+#include <QObject>
+
+#include <QtWaylandClient/QWaylandClientExtension>
+
+namespace QtWaylandClient
+{
+class QWaylandDisplay;
+class QWaylandSurface;
+}
+
+class QWaylandXdgActivationTokenV1 : public QObject, public QtWayland::xdg_activation_token_v1
+{
+    Q_OBJECT
+public:
+    ~QWaylandXdgActivationTokenV1() override
+    {
+        destroy();
+    }
+
+protected:
+    void xdg_activation_token_v1_done(const QString &token) override
+    {
+        Q_EMIT done(token);
+    }
+
+Q_SIGNALS:
+    void done(const QString &token);
+};
+
+class QWaylandXdgActivationV1 : public QWaylandClientExtensionTemplate<QWaylandXdgActivationV1>, public QtWayland::xdg_activation_v1
+{
+public:
+    QWaylandXdgActivationV1();
+    ~QWaylandXdgActivationV1() override;
+
+    QWaylandXdgActivationTokenV1 *
+    requestXdgActivationToken(QtWaylandClient::QWaylandDisplay *display, struct ::wl_surface *surface, std::optional<uint32_t> serial, const QString &app_id);
+};
+
+#endif // QWAYLANDXDGACTIVATIONV1_P_H

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

@@ -25,7 +25,7 @@
     THIS SOFTWARE.
   </copyright>
 
-  <interface name="zwlr_layer_shell_v1" version="3">
+  <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
@@ -100,7 +100,7 @@
     </request>
   </interface>
 
-  <interface name="zwlr_layer_surface_v1" version="3">
+  <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
@@ -203,21 +203,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
+        Set how keyboard events are delivered to this surface. By default,
-        surface. For layers below the shell surface layer, the seat will use
+        layer shell surfaces do not receive keyboard events; this request can
-        normal focus semantics. For layers above the shell surface layers, the
+        be used to change this.
-        seat will always give exclusive keyboard focus to the top-most layer
+
-        which has keyboard interactivity set to true.
+        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,6 +366,8 @@
       <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">
@@ -321,5 +387,21 @@
       </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"/>
+    </request>
   </interface>
 </protocol>

tests/main.cpp

@@ -4,35 +4,108 @@
  *   SPDX-License-Identifier: LGPL-3.0-or-later
  */
 
+#include <QCommandLineParser>
+
 #include <QGuiApplication>
-#include <QQmlApplicationEngine>
+#include <QPainter>
-#include <interfaces/shell.h>
+#include <QRasterWindow>
+#include <QTimer>
+#include <QWindow>
+
+#include <QMetaEnum>
+
 #include <interfaces/window.h>
 
+using namespace LayerShellQt;
+
+QStringList enumsToStringList(QMetaEnum metaEnum)
+{
+    QStringList ret;
+    ret.reserve(metaEnum.keyCount());
+    for (int i = 0; i < metaEnum.keyCount(); ++i) {
+        ret.append(metaEnum.key(i));
+    }
+    return ret;
+}
+
+template<typename T>
+T stringToEnum(QMetaEnum metaEnum, const QString &str)
+{
+    T ret = {};
+    const auto splitted = str.split(QLatin1Char('|'), Qt::SkipEmptyParts);
+    for (const auto &value : splitted) {
+        ret |= T(metaEnum.keyToValue(qPrintable(value)));
+    }
+    return ret;
+}
+
+class BasicWindow : public QRasterWindow
+{
+    void paintEvent(QPaintEvent *) override
+    {
+        QPainter p(this);
+        p.fillRect(QRect(0, 0, width(), height()), Qt::red);
+    }
+};
+
 int main(int argc, char **argv)
 {
-    LayerShellQt::Shell::useLayerShell();
-
     QGuiApplication app(argc, argv);
-    QQmlApplicationEngine engine;
-    engine.loadData(
-        "import QtQuick.Controls 2.10\n"
-        "import QtQuick 2.10\n"
-        "\n"
-        "ApplicationWindow {"
-        "   width: 100; height: 100\n"
-        "   visible: true\n"
-        "   Rectangle { color: 'red'; anchors.fill: parent }"
-        "}"
 
-        ,
+    const auto layerMetaEnum = QMetaEnum::fromType<Window::Layer>();
-        QStringLiteral("bananaland:/potato.qml"));
+    const auto anchorMetaEnum = QMetaEnum::fromType<Window::Anchor>();
 
-    QObject::connect(&engine, &QQmlApplicationEngine::objectCreated, &app, [](QObject *object) {
+    QCommandLineParser parser;
-        auto layerWindow = LayerShellQt::Window::get(qobject_cast<QWindow *>(object));
+    QCommandLineOption marginsOption(QStringLiteral("margins"), QStringLiteral("Window margins"), QStringLiteral("pixels"), QStringLiteral("0"));
-        Q_ASSERT(layerWindow);
+    QCommandLineOption scopeOption(QStringLiteral("scope"), QStringLiteral("Window scope"), QStringLiteral("namespace"), QStringLiteral("normal"));
-        layerWindow->setMargins({50, 50, 50, 50});
+    QCommandLineOption anchorsOption(QStringLiteral("anchors"),
-    });
+                                     QStringLiteral("Either ") + enumsToStringList(anchorMetaEnum).join(QLatin1String("|")),
+                                     QStringLiteral("anchors"),
+                                     QStringLiteral("AnchorTop|AnchorBottom|AnchorLeft|AnchorRight"));
+    QCommandLineOption layerOption(QStringLiteral("layer"),
+                                   QStringLiteral("One of ") + enumsToStringList(layerMetaEnum).join(QLatin1String("|")),
+                                   QStringLiteral("layer"),
+                                   QStringLiteral("LayerTop"));
+    QCommandLineOption widthOption(QStringLiteral("width"), QStringLiteral("Width of the window"), QStringLiteral("pixels"), QStringLiteral("0"));
+    QCommandLineOption heightOption(QStringLiteral("height"), QStringLiteral("Height of the window"), QStringLiteral("pixels"), QStringLiteral("0"));
 
+    parser.addOptions({marginsOption, scopeOption, anchorsOption, layerOption, widthOption, heightOption});
+    parser.addHelpOption();
+    parser.process(app);
+
+    BasicWindow window;
+
+    LayerShellQt::Window *layerShell = LayerShellQt::Window::get(&window);
+    layerShell->setLayer(Window::LayerBottom);
+
+    if (parser.isSet(marginsOption)) {
+        int margins = parser.value(marginsOption).toInt();
+        layerShell->setMargins({margins, margins, margins, margins});
+    }
+
+    if (parser.isSet(scopeOption)) {
+        layerShell->setScope(parser.value(scopeOption));
+    }
+    if (parser.isSet(layerOption)) {
+        layerShell->setLayer(Window::Layer(layerMetaEnum.keyToValue(qPrintable(parser.value(layerOption)))));
+    }
+    if (parser.isSet(anchorsOption)) {
+        layerShell->setAnchors(stringToEnum<Window::Anchors>(anchorMetaEnum, parser.value(anchorsOption)));
+    }
+    if (parser.isSet(widthOption)) {
+        window.setWidth(parser.value(widthOption).toInt());
+    }
+    if (parser.isSet(heightOption)) {
+        window.setHeight(parser.value(heightOption).toInt());
+    }
+
+    window.show();
+
+    BasicWindow window2;
+    window2.resize(400, 400);
+    window2.show();
+
+    // just so you don't block yourself out whilst testing
+    QTimer::singleShot(5000, &app, &QGuiApplication::quit);
     return app.exec();
 }

tests/quicktest.qml

@@ -0,0 +1,110 @@
+/*
+ *   SPDX-FileCopyrightText: 2021 Aleix Pol Gonzalez <aleix.pol_gonzalez@mercedes-benz.com>
+ *
+ *   SPDX-License-Identifier: LGPL-3.0-or-later
+ */
+
+import QtQuick 2.15
+import org.kde.layershell 1.0 as LayerShell
+
+Item
+{
+    Text {
+        text: "A normal Window"
+        anchors.centerIn: parent
+    }
+
+    Window {
+        LayerShell.Window.anchors: LayerShell.Window.AnchorLeft
+        LayerShell.Window.layer: LayerShell.Window.LayerBackground
+        LayerShell.Window.exclusionZone: -1
+
+        width: 200
+        height: 150
+        Rectangle {
+            anchors.fill: parent
+            color: "green"
+
+            Text {
+                anchors.centerIn: parent
+                text: "left bg"
+            }
+        }
+        visible: true
+    }
+
+
+    Window {
+        LayerShell.Window.scope: "dock"
+        LayerShell.Window.anchors: LayerShell.Window.AnchorLeft
+        LayerShell.Window.layer: LayerShell.Window.LayerTop
+        LayerShell.Window.exclusionZone: width
+
+        width: 100
+        height: 100
+        Rectangle {
+            anchors.fill: parent
+            color: "red"
+
+            Text {
+                anchors.centerIn: parent
+                text: "left"
+            }
+        }
+        visible: true
+    }
+
+    Window {
+        LayerShell.Window.scope: "normal"
+        LayerShell.Window.anchors: LayerShell.Window.AnchorRight
+
+        width: 100
+        height: 100
+        Rectangle {
+            anchors.fill: parent
+            color: "red"
+
+            Text {
+                anchors.centerIn: parent
+                text: "right"
+            }
+        }
+        visible: true
+    }
+
+    Window {
+        LayerShell.Window.scope: "normal"
+        LayerShell.Window.anchors: LayerShell.Window.AnchorTop
+
+        width: 100
+        height: 100
+        Rectangle {
+            anchors.fill: parent
+            color: "red"
+
+            Text {
+                anchors.centerIn: parent
+                text: "top"
+            }
+        }
+        visible: true
+    }
+
+    Window {
+        LayerShell.Window.scope: "normal"
+        LayerShell.Window.anchors: LayerShell.Window.AnchorBottom
+
+        width: 100
+        height: 100
+        Rectangle {
+            anchors.fill: parent
+            color: "red"
+
+            Text {
+                anchors.centerIn: parent
+                text: "bottom"
+            }
+        }
+        visible: true
+    }
+}