Port to QWaylandShellSurface::attachPopup()

If the Window::setDesiredOutput API was not called for the QWindow, use
QWindow::screen(). This allows assigning QWindows to specific screens using
the plain Qt API.

Passing nullptr to Window::setDesiredOutput explicitly results in nil as
desired output for the layer, which lets the compositor select a screen.

.gitlab-ci.yml

@@ -2,6 +2,6 @@
 # SPDX-License-Identifier: CC0-1.0
 
 include:
-  - https://invent.kde.org/sysadmin/ci-utilities/raw/master/gitlab-templates/linux.yml
+  - 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/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

.kde-ci.yml

@@ -4,4 +4,4 @@
 Dependencies:
 - 'on': ['@all']
   'require':
-    'frameworks/extra-cmake-modules': '@latest'
+    'frameworks/extra-cmake-modules': '@latest-kf6'

CMakeLists.txt

@@ -4,25 +4,26 @@
 cmake_minimum_required(VERSION 3.16)
 
 project(layershellqt)
-set(PROJECT_VERSION "5.25.2")
+set(PROJECT_VERSION "5.27.80")
 set(PROJECT_VERSION_MAJOR 5)
 
 set(CMAKE_C_STANDARD 99)
 
-set(QT_MIN_VERSION "5.15.2")
+set(QT_MIN_VERSION "6.4.0")
-set(KF5_MIN_VERSION "5.94")
+set(KF6_MIN_VERSION "5.240.0")
 set(KDE_COMPILERSETTINGS_LEVEL "5.82")
 
 set(CMAKE_CXX_STANDARD 17)
 set(CMAKE_CXX_STANDARD_REQUIRED ON)
 
-find_package(ECM ${KF5_MIN_VERSION} REQUIRED NO_MODULE)
+find_package(ECM ${KF6_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)
@@ -30,6 +31,7 @@ include(GenerateExportHeader)
 include(KDEClangFormat)
 include(ECMQtDeclareLoggingCategory)
 
+
 find_package(Qt${QT_MAJOR_VERSION} ${QT_MIN_VERSION} CONFIG REQUIRED COMPONENTS WaylandClient Qml)
 if (QT_MAJOR_VERSION EQUAL "5")
     find_package(Qt5XkbCommonSupport REQUIRED PRIVATE)
@@ -53,10 +55,15 @@ ecm_setup_version(${PROJECT_VERSION} VARIABLE_PREFIX LAYERSHELLQT
 
 file(GLOB_RECURSE ALL_CLANG_FORMAT_SOURCE_FILES *.cpp *.h)
 kde_clang_format(${ALL_CLANG_FORMAT_SOURCE_FILES})
+
+ecm_set_disabled_deprecation_versions(QT 5.15.2
+    KF 5.101
+)
+
 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}

metainfo.yaml

@@ -1,3 +1,6 @@
+# SPDX-FileCopyrightText: None
+# SPDX-License-Identifier: CC0-1.0
+
 maintainer:
 - vladz
 description: Layer Shell Qt

src/CMakeLists.txt

@@ -51,7 +51,6 @@ ecm_generate_headers(LayerShellQt_HEADERS
     REQUIRED_HEADERS LayerShellQt_HEADERS
 )
 
-
 generate_export_header(LayerShellQtInterface
     BASE_NAME LayerShellQtInterface
     EXPORT_MACRO_NAME LAYERSHELLQT_EXPORT

src/interfaces/window.cpp

@@ -5,10 +5,14 @@
  */
 
 #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;
 
@@ -27,8 +31,7 @@ public:
     Window::KeyboardInteractivity keyboardInteractivity = Window::KeyboardInteractivityExclusive;
     Window::Layer layer = Window::LayerTop;
     QMargins margins;
-    QWaylandLayerSurface *getSurface() const;
+    std::optional<QPointer<QScreen>> desiredOutput;
-    QPointer<QScreen> desiredOutput;
 };
 
 static QMap<QWindow *, Window *> s_map;
@@ -41,9 +44,7 @@ Window::~Window()
 void Window::setAnchors(Anchors anchors)
 {
     d->anchors = anchors;
-    if (auto surface = d->getSurface()) {
+    Q_EMIT anchorsChanged();
-        surface->setAnchor(anchors);
-    }
 }
 
 Window::Anchors Window::anchors() const
@@ -54,9 +55,7 @@ Window::Anchors Window::anchors() const
 void Window::setExclusiveZone(int32_t zone)
 {
     d->exclusionZone = zone;
-    if (auto surface = d->getSurface()) {
+    Q_EMIT exclusionZoneChanged();
-        surface->setExclusiveZone(zone);
-    }
 }
 
 int32_t Window::exclusionZone() const
@@ -67,9 +66,7 @@ int32_t Window::exclusionZone() const
 void Window::setMargins(const QMargins &margins)
 {
     d->margins = margins;
-    if (auto surface = d->getSurface()) {
+    Q_EMIT marginsChanged();
-        surface->setMargins(margins);
-    }
 }
 
 QMargins Window::margins() const
@@ -80,9 +77,7 @@ QMargins Window::margins() const
 void Window::setKeyboardInteractivity(KeyboardInteractivity interactivity)
 {
     d->keyboardInteractivity = interactivity;
-    if (auto surface = d->getSurface()) {
+    Q_EMIT keyboardInteractivityChanged();
-        surface->setKeyboardInteractivity(interactivity);
-    }
 }
 
 Window::KeyboardInteractivity Window::keyboardInteractivity() const
@@ -93,9 +88,6 @@ 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)
@@ -116,7 +108,12 @@ Window::Layer Window::layer() const
 
 QScreen *Window::desiredOutput() const
 {
-    return d->desiredOutput;
+    // Don't use .value_or here to avoid a temporary QPointer
+    if (d->desiredOutput.has_value()) {
+        return d->desiredOutput.value();
+    }
+
+    return d->parentWindow->screen();
 }
 
 void Window::setDesiredOutput(QScreen *output)
@@ -128,6 +125,18 @@ Window::Window(QWindow *window)
     : QObject(window)
     , d(new WindowPrivate(window))
 {
+    window->winId(); // ensure that the platform window is created
+
+    auto waylandWindow = dynamic_cast<QtWaylandClient::QWaylandWindow *>(window->handle());
+    if (!waylandWindow) {
+        return;
+    }
+
+    static QWaylandLayerShellIntegration *s_integration = new QWaylandLayerShellIntegration();
+    if (waylandWindow->shellIntegration() != s_integration) {
+        waylandWindow->setShellIntegration(s_integration);
+    }
+
     s_map.insert(d->parentWindow, this);
 }
 
@@ -139,21 +148,3 @@ 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

@@ -93,6 +93,13 @@ 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/qwaylandlayershell.cpp

@@ -10,9 +10,11 @@
 
 namespace LayerShellQt
 {
-QWaylandLayerShell::QWaylandLayerShell(::wl_registry *registry, uint32_t id, uint32_t version)
+QWaylandLayerShell::QWaylandLayerShell()
-    : QtWayland::zwlr_layer_shell_v1(registry, id, version)
+    : QWaylandClientExtensionTemplate<QWaylandLayerShell>(2)
+    , QtWayland::zwlr_layer_shell_v1()
 {
+    initialize();
 }
 
 QWaylandLayerShell::~QWaylandLayerShell()
@@ -21,9 +23,4 @@ QWaylandLayerShell::~QWaylandLayerShell()
         zwlr_layer_shell_v1_destroy(object());
 }
 
-QWaylandLayerSurface *QWaylandLayerShell::createLayerSurface(QtWaylandClient::QWaylandWindow *window)
-{
-    return new QWaylandLayerSurface(this, window);
-}
-
 }

src/qwaylandlayershell_p.h

@@ -8,23 +8,20 @@
 #ifndef _LAYERSHELL_H
 #define _LAYERSHELL_H
 
+#include "layershellqt_export.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
+class LAYERSHELLQT_EXPORT QWaylandLayerShell : public QWaylandClientExtensionTemplate<QWaylandLayerShell>, public QtWayland::zwlr_layer_shell_v1
 {
 public:
-    QWaylandLayerShell(::wl_registry *registry, uint32_t id, uint32_t version);
+    QWaylandLayerShell();
     ~QWaylandLayerShell() override;
-
-    QWaylandLayerSurface *createLayerSurface(QtWaylandClient::QWaylandWindow *window);
-    // TODO: Popups
 };
 
 }

src/qwaylandlayershellintegration.cpp

@@ -7,6 +7,7 @@
 
 #include "qwaylandlayershell_p.h"
 #include "qwaylandlayershellintegration_p.h"
+#include "qwaylandlayersurface_p.h"
 
 #include <QtWaylandClient/private/qwaylanddisplay_p.h>
 #include <QtWaylandClient/private/qwaylandwindow_p.h>
@@ -15,6 +16,7 @@
 namespace LayerShellQt
 {
 QWaylandLayerShellIntegration::QWaylandLayerShellIntegration()
+    : m_layerShell(new QWaylandLayerShell())
 {
 }
 
@@ -24,26 +26,14 @@ QWaylandLayerShellIntegration::~QWaylandLayerShellIntegration()
 
 bool QWaylandLayerShellIntegration::initialize(QtWaylandClient::QWaylandDisplay *display)
 {
-#if QT_VERSION < QT_VERSION_CHECK(6, 0, 0)
+    Q_UNUSED(display)
-    QWaylandShellIntegration::initialize(display);
+    return m_layerShell->isActive();
-#endif
-    display->addRegistryListener(registryLayer, this);
-    return m_layerShell != nullptr;
 }
 
 QtWaylandClient::QWaylandShellSurface *QWaylandLayerShellIntegration::createShellSurface(QtWaylandClient::QWaylandWindow *window)
 {
-    return m_layerShell->createLayerSurface(window);
+    return new QWaylandLayerSurface(m_layerShell.get(), 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.reset(new QWaylandLayerShell(registry, id, std::min(version, 4u)));
-}
 
 }
-
-//#include "qwaylandlayershellintegration.moc"

src/qwaylandlayershellintegration_p.h

@@ -27,8 +27,6 @@ public:
     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

@@ -5,7 +5,7 @@
  *   SPDX-License-Identifier: LGPL-3.0-or-later
  */
 
-#include "interfaces/shell.h"
+#include "interfaces/window.h"
 #include "layershellqt_logging.h"
 #include "qwaylandlayershell_p.h"
 #include "qwaylandlayersurface_p.h"
@@ -36,15 +36,31 @@ QWaylandLayerSurface::QWaylandLayerSurface(QWaylandLayerShell *shell, QtWaylandC
         }
     }
     init(shell->get_layer_surface(window->waylandSurface()->object(), output, interface->layer(), interface->scope()));
-
+    connect(interface, &Window::layerChanged, this, [this, interface]() {
-    Window::Anchors anchors = interface->anchors();
+        setLayer(interface->layer());
+    });
 
     set_anchor(interface->anchors());
-    setMargins(interface->margins());
+    connect(interface, &Window::anchorsChanged, this, [this, interface]() {
-    setKeyboardInteractivity(interface->keyboardInteractivity());
+        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]() {
+        setKeyboardInteractivity(interface->keyboardInteractivity());
+    });
 
     QSize size = window->surfaceSize();
+    const Window::Anchors anchors = interface->anchors();
     if ((anchors & Window::AnchorLeft) && (anchors & Window::AnchorRight)) {
         size.setWidth(0);
     }
@@ -82,6 +98,17 @@ void QWaylandLayerSurface::zwlr_layer_surface_v1_configure(uint32_t serial, uint
     }
 }
 
+void QWaylandLayerSurface::attachPopup(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()
 {
     window()->resizeFromApplyConfigure(m_pendingSize);

src/qwaylandlayersurface_p.h

@@ -36,6 +36,7 @@ public:
     void setKeyboardInteractivity(uint32_t interactivity);
     void setLayer(uint32_t layer);
 
+    void attachPopup(QWaylandShellSurface *popup) override;
     void applyConfigure() override;
 
 private:

tests/main.cpp

@@ -14,7 +14,6 @@
 
 #include <QMetaEnum>
 
-#include <interfaces/shell.h>
 #include <interfaces/window.h>
 
 using namespace LayerShellQt;
@@ -51,8 +50,6 @@ class BasicWindow : public QRasterWindow
 
 int main(int argc, char **argv)
 {
-    Shell::useLayerShell();
-
     QGuiApplication app(argc, argv);
 
     const auto layerMetaEnum = QMetaEnum::fromType<Window::Layer>();
@@ -79,6 +76,8 @@ int main(int argc, char **argv)
     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});
@@ -102,6 +101,10 @@ int main(int argc, char **argv)
 
     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();