Port to QtWaylandClient's shell surface api

.gitlab-ci.yml

@@ -2,8 +2,5 @@
 # SPDX-License-Identifier: CC0-1.0
 
 include:
-  - https://invent.kde.org/sysadmin/ci-utilities/raw/master/gitlab-templates/reuse-lint.yml
   - https://invent.kde.org/sysadmin/ci-utilities/raw/master/gitlab-templates/linux.yml
   - https://invent.kde.org/sysadmin/ci-utilities/raw/master/gitlab-templates/freebsd.yml
-  - https://invent.kde.org/sysadmin/ci-utilities/raw/master/gitlab-templates/linux-qt6.yml
-  - https://invent.kde.org/sysadmin/ci-utilities/raw/master/gitlab-templates/freebsd-qt6.yml

CMakeLists.txt

@@ -4,18 +4,19 @@
 cmake_minimum_required(VERSION 3.16)
 
 project(layershellqt)
-set(PROJECT_VERSION "5.26.5")
+set(PROJECT_VERSION "6.0.0")
-set(PROJECT_VERSION_MAJOR 5)
+set(PROJECT_VERSION_MAJOR 6)
 
 set(CMAKE_C_STANDARD 99)
 
-set(QT_MIN_VERSION "5.15.2")
+set(QT_MIN_VERSION "6.2.0")
-set(KF5_MIN_VERSION "5.102.0")
+set(KF5_MIN_VERSION "5.86")
 set(KDE_COMPILERSETTINGS_LEVEL "5.82")
 
 set(CMAKE_CXX_STANDARD 17)
 set(CMAKE_CXX_STANDARD_REQUIRED ON)
 
+find_package(Qt6 ${QT_MIN_VERSION} CONFIG REQUIRED COMPONENTS WaylandClient Qml)
 find_package(ECM ${KF5_MIN_VERSION} REQUIRED NO_MODULE)
 set(CMAKE_MODULE_PATH ${CMAKE_CURRENT_SOURCE_DIR}/cmake ${ECM_MODULE_PATH})
 
@@ -30,18 +31,12 @@ include(GenerateExportHeader)
 include(KDEClangFormat)
 include(ECMQtDeclareLoggingCategory)
 
-find_package(Qt${QT_MAJOR_VERSION} ${QT_MIN_VERSION} CONFIG REQUIRED COMPONENTS WaylandClient Qml)
+find_package(WaylandScanner)
-if (QT_MAJOR_VERSION EQUAL "5")
+find_package(QtWaylandScanner)
-    find_package(Qt5XkbCommonSupport REQUIRED PRIVATE)
-    find_package(QtWaylandScanner REQUIRED)
-endif()
-find_package(WaylandScanner REQUIRED)
 find_package(Wayland 1.3 COMPONENTS Client Server)
-find_package(WaylandProtocols REQUIRED)
+find_package(WaylandProtocols)
 find_package(PkgConfig REQUIRED)
 
-pkg_check_modules(XKBCOMMON xkbcommon REQUIRED IMPORTED_TARGET)
-
 set_package_properties(Wayland PROPERTIES
                        TYPE REQUIRED)
 set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -std=gnu90")

LayerShellQtConfig.cmake.in

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

metainfo.yaml

@@ -1,17 +0,0 @@
-# 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,16 +3,8 @@
 
 remove_definitions(-DQT_NO_SIGNALS_SLOTS_KEYWORDS)
 
-add_library(LayerShellQtInterface)
+ecm_add_qtwayland_client_protocol(LAYER_SHELL_SOURCES PROTOCOL ${WaylandProtocols_DATADIR}/stable/xdg-shell/xdg-shell.xml BASENAME xdg-shell)
-if (QT_MAJOR_VERSION EQUAL "5")
+ecm_add_qtwayland_client_protocol(LAYER_SHELL_SOURCES PROTOCOL wlr-layer-shell-unstable-v1.xml BASENAME wlr-layer-shell-unstable-v1)
-    ecm_add_qtwayland_client_protocol(LAYER_SHELL_SOURCES PROTOCOL ${WaylandProtocols_DATADIR}/stable/xdg-shell/xdg-shell.xml BASENAME xdg-shell)
-    ecm_add_qtwayland_client_protocol(LAYER_SHELL_SOURCES PROTOCOL wlr-layer-shell-unstable-v1.xml BASENAME wlr-layer-shell-unstable-v1)
-else()
-    qt6_generate_wayland_protocol_client_sources(LayerShellQtInterface FILES
-        ${WaylandProtocols_DATADIR}/stable/xdg-shell/xdg-shell.xml
-        ${CMAKE_CURRENT_SOURCE_DIR}/wlr-layer-shell-unstable-v1.xml
-    )
-endif()
 
 ecm_qt_declare_logging_category(LAYER_SHELL_SOURCES
     HEADER
@@ -23,11 +15,8 @@ ecm_qt_declare_logging_category(LAYER_SHELL_SOURCES
         layershellqt
 )
 
-target_sources(LayerShellQtInterface PRIVATE qwaylandlayersurface.cpp interfaces/window.cpp interfaces/shell.cpp qwaylandlayershellintegration.cpp qwaylandlayershell.cpp ${LAYER_SHELL_SOURCES})
+add_library(LayerShellQtInterface SHARED qwaylandlayersurface.cpp interfaces/window.cpp interfaces/shell.cpp qwaylandlayershellintegration.cpp qwaylandlayershell.cpp ${LAYER_SHELL_SOURCES})
-target_link_libraries(LayerShellQtInterface PRIVATE Qt::Gui Qt::WaylandClientPrivate Wayland::Client PkgConfig::XKBCOMMON)
+target_link_libraries(LayerShellQtInterface PRIVATE Qt::Gui Qt::WaylandClientPrivate Wayland::Client)
-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}/>"
 )
@@ -38,10 +27,7 @@ set_target_properties(LayerShellQtInterface PROPERTIES VERSION   ${LAYERSHELLQT_
 )
 
 add_library(layer-shell SHARED qwaylandlayershellintegrationplugin.cpp)
-target_link_libraries(layer-shell LayerShellQtInterface Qt::WaylandClient Qt::WaylandClientPrivate Wayland::Client PkgConfig::XKBCOMMON)
+target_link_libraries(layer-shell LayerShellQtInterface Qt::WaylandClient Qt::WaylandClientPrivate Wayland::Client)
-if (TARGET Qt::XkbCommonSupportPrivate)
-    target_link_libraries(layer-shell Qt::XkbCommonSupportPrivate)
-endif()
 
 ecm_generate_headers(LayerShellQt_HEADERS
     HEADER_NAMES
@@ -59,7 +45,7 @@ generate_export_header(LayerShellQtInterface
 )
 
 install(TARGETS layer-shell
-        LIBRARY DESTINATION ${KDE_INSTALL_QTPLUGINDIR}/wayland-shell-integration)
+        LIBRARY DESTINATION ${QT_PLUGIN_INSTALL_DIR}/wayland-shell-integration)
 
 install(TARGETS LayerShellQtInterface EXPORT LayerShellQtTargets ${KDE_INSTALL_TARGETS_DEFAULT_ARGS})
 

src/interfaces/window.cpp

@@ -5,9 +5,10 @@
  */
 
 #include "window.h"
+#include "../qwaylandlayersurface_p.h"
 #include <layershellqt_logging.h>
-
+#include <private/qwaylandshellsurface_p.h>
-#include <QPointer>
+#include <private/qwaylandwindow_p.h>
 
 using namespace LayerShellQt;
 
@@ -26,7 +27,7 @@ public:
     Window::KeyboardInteractivity keyboardInteractivity = Window::KeyboardInteractivityExclusive;
     Window::Layer layer = Window::LayerTop;
     QMargins margins;
-    QPointer<QScreen> desiredOutput;
+    QWaylandLayerSurface *getSurface() const;
 };
 
 static QMap<QWindow *, Window *> s_map;
@@ -39,7 +40,9 @@ Window::~Window()
 void Window::setAnchors(Anchors anchors)
 {
     d->anchors = anchors;
-    Q_EMIT anchorsChanged();
+    if (auto surface = d->getSurface()) {
+        surface->setAnchor(anchors);
+    }
 }
 
 Window::Anchors Window::anchors() const
@@ -50,7 +53,9 @@ Window::Anchors Window::anchors() const
 void Window::setExclusiveZone(int32_t zone)
 {
     d->exclusionZone = zone;
-    Q_EMIT exclusionZoneChanged();
+    if (auto surface = d->getSurface()) {
+        surface->setExclusiveZone(zone);
+    }
 }
 
 int32_t Window::exclusionZone() const
@@ -61,7 +66,9 @@ int32_t Window::exclusionZone() const
 void Window::setMargins(const QMargins &margins)
 {
     d->margins = margins;
-    Q_EMIT marginsChanged();
+    if (auto surface = d->getSurface()) {
+        surface->setMargins(margins);
+    }
 }
 
 QMargins Window::margins() const
@@ -72,7 +79,9 @@ QMargins Window::margins() const
 void Window::setKeyboardInteractivity(KeyboardInteractivity interactivity)
 {
     d->keyboardInteractivity = interactivity;
-    Q_EMIT keyboardInteractivityChanged();
+    if (auto surface = d->getSurface()) {
+        surface->setKeyboardInteractivity(interactivity);
+    }
 }
 
 Window::KeyboardInteractivity Window::keyboardInteractivity() const
@@ -83,6 +92,9 @@ Window::KeyboardInteractivity Window::keyboardInteractivity() const
 void Window::setLayer(Layer layer)
 {
     d->layer = layer;
+    if (auto surface = d->getSurface()) {
+        surface->setLayer(layer);
+    }
 }
 
 void Window::setScope(const QString &scope)
@@ -101,16 +113,6 @@ Window::Layer Window::layer() const
     return d->layer;
 }
 
-QScreen *Window::desiredOutput() const
-{
-    return d->desiredOutput;
-}
-
-void Window::setDesiredOutput(QScreen *output)
-{
-    d->desiredOutput = output;
-}
-
 Window::Window(QWindow *window)
     : QObject(window)
     , d(new WindowPrivate(window))
@@ -126,3 +128,21 @@ Window *Window::get(QWindow *window)
     }
     return new Window(window);
 }
+
+QWaylandLayerSurface *WindowPrivate::getSurface() const
+{
+    if (!parentWindow) {
+        return nullptr;
+    }
+    auto ww = dynamic_cast<QtWaylandClient::QWaylandWindow *>(parentWindow->handle());
+    if (!ww) {
+        qCDebug(LAYERSHELLQT) << "window not a wayland window" << parentWindow;
+        return nullptr;
+    }
+    QWaylandLayerSurface *s = qobject_cast<QWaylandLayerSurface *>(ww->shellSurface());
+    if (!s) {
+        qCDebug(LAYERSHELLQT) << "window not using wlr-layer-shell" << parentWindow << ww->shellSurface();
+        return nullptr;
+    }
+    return s;
+}

src/interfaces/window.h

@@ -9,7 +9,6 @@
 #define LAYERSHELLQTWINDOW_H
 
 #include <QObject>
-#include <QScreen>
 #include <QWindow>
 
 #include "layershellqt_export.h"
@@ -25,10 +24,10 @@ public:
     ~Window() override;
 
     enum Anchor {
-        AnchorTop = 1, ///< The top edge of the anchor rectangle
+        AnchorTop = 1, // the top edge of the anchor rectangle
-        AnchorBottom = 2, ///< The bottom edge of the anchor rectangle
+        AnchorBottom = 2, // the bottom edge of the anchor rectangle
-        AnchorLeft = 4, ///< The left edge of the anchor rectangle
+        AnchorLeft = 4, // the left edge of the anchor rectangle
-        AnchorRight = 8, ///< The right edge of the anchor rectangle
+        AnchorRight = 8, // the right edge of the anchor rectangle
     };
     Q_ENUM(Anchor);
     Q_DECLARE_FLAGS(Anchors, Anchor)
@@ -69,14 +68,6 @@ public:
     void setLayer(Layer layer);
     Layer layer() const;
 
-    /**
-     * If set, the compositor will try to put the window on the given screen.
-     * If its not set, then the compositor will decide where to put the window.
-     * Under normal circumstances, this should be the active output.
-     */
-    void setDesiredOutput(QScreen *output);
-    QScreen *desiredOutput() const;
-
     /**
      * Sets a string based identifier for this window.
      * This may be used by a compositor to determine stacking
@@ -93,13 +84,6 @@ public:
      */
     static Window *get(QWindow *window);
 
-Q_SIGNALS:
-    void anchorsChanged();
-    void exclusionZoneChanged();
-    void marginsChanged();
-    void keyboardInteractivityChanged();
-    void layerChanged();
-
 private:
     Window(QWindow *window);
     QScopedPointer<WindowPrivate> d;

src/qwaylandlayershellintegration.cpp

@@ -22,28 +22,30 @@ QWaylandLayerShellIntegration::~QWaylandLayerShellIntegration()
 {
 }
 
-bool QWaylandLayerShellIntegration::initialize(QtWaylandClient::QWaylandDisplay *display)
+bool QWaylandLayerShellIntegration::initialize()
 {
-#if QT_VERSION < QT_VERSION_CHECK(6, 0, 0)
+    if (m_layerShell) {
-    QWaylandShellIntegration::initialize(display);
+        return true;
-#endif
+    }
-    display->addRegistryListener(registryLayer, this);
+    wl_registry *registry;
-    return m_layerShell != nullptr;
+    uint32_t id;
+    uint32_t version;
+    const bool found = findGlobal(QLatin1String("zwlr_layer_shell_v1"), &registry, &id, &version);
+    if (!found) {
+        qWarning() << "Could not find the zwlr_layer_shell_v1 global. Compositor does not support the layer shell protocol?";
+        return false;
+    }
+
+    m_layerShell.reset(new QWaylandLayerShell(registry, id, std::min(version, 4u)));
+    return true;
 }
 
 QtWaylandClient::QWaylandShellSurface *QWaylandLayerShellIntegration::createShellSurface(QtWaylandClient::QWaylandWindow *window)
 {
-    return m_layerShell->createLayerSurface(window);
+    if (m_layerShell) {
-}
+        return m_layerShell->createLayerSurface(window);
-
+    }
-void QWaylandLayerShellIntegration::registryLayer(void *data, struct wl_registry *registry, uint32_t id, const QString &interface, uint32_t version)
+    return nullptr;
-{
-    QWaylandLayerShellIntegration *shell = static_cast<QWaylandLayerShellIntegration *>(data);
-
-    if (interface == zwlr_layer_shell_v1_interface.name)
-        shell->m_layerShell.reset(new QWaylandLayerShell(registry, id, std::min(version, 4u)));
 }
 
 }
-
-//#include "qwaylandlayershellintegration.moc"

src/qwaylandlayershellintegration_p.h

@@ -8,10 +8,9 @@
 #ifndef _LAYERSHELLINTEGRATION_P_H
 #define _LAYERSHELLINTEGRATION_P_H
 
-#include <wayland-client.h>
-
 #include "layershellqt_export.h"
-#include <QtWaylandClient/private/qwaylandshellintegration_p.h>
+
+#include <QtWaylandClient/private/qwaylandclientshellapi_p.h>
 
 namespace LayerShellQt
 {
@@ -23,12 +22,10 @@ public:
     QWaylandLayerShellIntegration();
     ~QWaylandLayerShellIntegration() override;
 
-    bool initialize(QtWaylandClient::QWaylandDisplay *display) override;
+    bool initialize() override;
     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<QWaylandLayerShell> m_layerShell;
 };
 

src/qwaylandlayersurface.cpp

@@ -6,9 +6,9 @@
  */
 
 #include "interfaces/shell.h"
-#include "layershellqt_logging.h"
 #include "qwaylandlayershell_p.h"
 #include "qwaylandlayersurface_p.h"
+#include "layershellqt_logging.h"
 
 #include <QtWaylandClient/private/qwaylandscreen_p.h>
 #include <QtWaylandClient/private/qwaylandsurface_p.h>
@@ -23,44 +23,23 @@ QWaylandLayerSurface::QWaylandLayerSurface(QWaylandLayerShell *shell, QtWaylandC
     LayerShellQt::Window *interface = Window::get(window->window());
     Q_ASSERT(interface);
 
-    wl_output *output = nullptr;
+    // Qt will always assign a screen to a window, but if the compositor has no screens available a dummy QScreen object is created
-    QScreen *screen = interface->desiredOutput();
+    // this will not cast to a QWaylandScreen
-    if (screen) {
+    QtWaylandClient::QWaylandScreen *screen = window->waylandScreen();
-        auto waylandScreen = dynamic_cast<QtWaylandClient::QWaylandScreen *>(screen->handle());
+    if (screen->isPlaceholder()) {
-        // Qt will always assign a screen to a window, but if the compositor has no screens available a dummy QScreen object is created
+        qCWarning(LAYERSHELLQT) << "Creating a layer shell for placeholder screen. This will be positioned incorrectly";
-        // 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, interface->layer(), interface->scope()));
+
-    connect(interface, &Window::layerChanged, this, [this, interface]() {
+    init(shell->get_layer_surface(window->waylandSurface()->object(), screen->isPlaceholder() ? nullptr : screen->output(), interface->layer(), interface->scope()));
-        setLayer(interface->layer());
+
-    });
+    Window::Anchors anchors = interface->anchors();
 
     set_anchor(interface->anchors());
-    connect(interface, &Window::anchorsChanged, this, [this, interface]() {
-        set_anchor(interface->anchors());
-    });
-    setExclusiveZone(interface->exclusionZone());
-    connect(interface, &Window::exclusionZoneChanged, this, [this, interface]() {
-        setExclusiveZone(interface->exclusionZone());
-    });
-
     setMargins(interface->margins());
-    connect(interface, &Window::marginsChanged, this, [this, interface]() {
-        setMargins(interface->margins());
-    });
-
     setKeyboardInteractivity(interface->keyboardInteractivity());
-    connect(interface, &Window::keyboardInteractivityChanged, this, [this, interface]() {
+    setExclusiveZone(interface->exclusionZone());
-        setKeyboardInteractivity(interface->keyboardInteractivity());
-    });
 
     QSize size = window->surfaceSize();
-    const Window::Anchors anchors = interface->anchors();
     if ((anchors & Window::AnchorLeft) && (anchors & Window::AnchorRight)) {
         size.setWidth(0);
     }