support multi shells within Qt5

QWaylandLayerSurface pulled data from the Window on startup. The Window
pushed data into the QWaylandLayerSurface on changes. Having two
patterns is a bit off.

This moves everything to a single design, pulling from the public
interface. This allows us to drop a code path that meddles with
QWaylandWindow internals.

.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/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

.kde-ci.yml

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

CMakeLists.txt

@@ -4,26 +4,25 @@
 cmake_minimum_required(VERSION 3.16)
 
 project(layershellqt)
-set(PROJECT_VERSION "5.27.80")
+set(PROJECT_VERSION "5.25.80")
 set(PROJECT_VERSION_MAJOR 5)
 
 set(CMAKE_C_STANDARD 99)
 
-set(QT_MIN_VERSION "6.5.0")
-set(KF6_MIN_VERSION "5.240.0")
+set(QT_MIN_VERSION "5.15.2")
+set(KF5_MIN_VERSION "5.94")
 set(KDE_COMPILERSETTINGS_LEVEL "5.82")
 
 set(CMAKE_CXX_STANDARD 17)
 set(CMAKE_CXX_STANDARD_REQUIRED ON)
 
-find_package(ECM ${KF6_MIN_VERSION} REQUIRED NO_MODULE)
+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)
@@ -31,7 +30,6 @@ 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)
@@ -55,15 +53,10 @@ 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_CMAKEPACKAGEDIR}/LayerShellQt)
+set(CMAKECONFIG_INSTALL_DIR ${KDE_INSTALL_LIBDIR}/cmake/LayerShellQt)
 install(EXPORT LayerShellQtTargets
         NAMESPACE LayerShellQt::
         DESTINATION ${CMAKECONFIG_INSTALL_DIR}

metainfo.yaml

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

src/interfaces/window.cpp

@@ -5,17 +5,11 @@
  */
 
 #include "window.h"
-#include "../qwaylandlayershellintegration_p.h"
-#if QT_VERSION < QT_VERSION_CHECK(6, 6, 0)
 #include "../qwaylandlayersurface_p.h"
-#endif
-
+#include "../qwaylandlayershellintegration_p.h"
 #include <layershellqt_logging.h>
-
-#include <QPointer>
-#include <optional>
-
-#include <QtWaylandClient/private/qwaylandwindow_p.h>
+#include <private/qwaylandshellsurface_p.h>
+#include <private/qwaylandwindow_p.h>
 
 using namespace LayerShellQt;
 
@@ -34,7 +28,7 @@ public:
     Window::KeyboardInteractivity keyboardInteractivity = Window::KeyboardInteractivityExclusive;
     Window::Layer layer = Window::LayerTop;
     QMargins margins;
-    std::optional<QPointer<QScreen>> desiredOutput;
+    QPointer<QScreen> desiredOutput;
 };
 
 static QMap<QWindow *, Window *> s_map;
@@ -111,12 +105,7 @@ Window::Layer Window::layer() const
 
 QScreen *Window::desiredOutput() const
 {
-    // Don't use .value_or here to avoid a temporary QPointer
-    if (d->desiredOutput.has_value()) {
-        return d->desiredOutput.value();
-    }
-
-    return d->parentWindow->screen();
+    return d->desiredOutput;
 }
 
 void Window::setDesiredOutput(QScreen *output)
@@ -124,33 +113,28 @@ void Window::setDesiredOutput(QScreen *output)
     d->desiredOutput = output;
 }
 
-#if QT_VERSION < QT_VERSION_CHECK(6, 6, 0)
-void Window::attachPopup(QWindow *window, xdg_popup *popup)
-{
-    auto waylandWindow = dynamic_cast<QtWaylandClient::QWaylandWindow *>(window->handle());
-    if (!waylandWindow) {
-        return;
-    }
-
-    auto shellSurface = dynamic_cast<QWaylandLayerSurface *>(waylandWindow->shellSurface());
-    if (shellSurface) {
-        shellSurface->get_popup(popup);
-    }
-}
-#endif
-
 Window::Window(QWindow *window)
     : QObject(window)
     , d(new WindowPrivate(window))
 {
     s_map.insert(d->parentWindow, this);
 
-    window->create();
+    //BEGIN Compat mode
+    window->winId();
+    window->setFlag(Qt::BypassWindowManagerHint);
 
-    if (auto waylandWindow = dynamic_cast<QtWaylandClient::QWaylandWindow *>(window->handle())) {
-        static QWaylandLayerShellIntegration integration;
-        waylandWindow->setShellIntegration(&integration);
+    auto ww = dynamic_cast<QtWaylandClient::QWaylandWindow *>(d->parentWindow->handle());
+    if (!ww) {
+        qCDebug(LAYERSHELLQT) << "window not a wayland window" << d->parentWindow;
+        return;
     }
+    QWaylandLayerShellIntegration shellIntegration;
+    shellIntegration.initialize(ww->display());
+    shellIntegration.createShellSurface(ww);
+    // we can't block for configure events
+    // a round trip should mean we'll have one by the time we attach the buffer
+    ww->display()->forceRoundTrip();
+    //END compat mode
 }
 
 Window *Window::get(QWindow *window)

src/interfaces/window.h

@@ -14,10 +14,6 @@
 
 #include "layershellqt_export.h"
 
-#if QT_VERSION < QT_VERSION_CHECK(6, 6, 0)
-struct xdg_popup;
-#endif
-
 namespace LayerShellQt
 {
 class WindowPrivate;
@@ -97,10 +93,6 @@ public:
      */
     static Window *get(QWindow *window);
 
-#if QT_VERSION < QT_VERSION_CHECK(6, 6, 0)
-    static void attachPopup(QWindow *window, xdg_popup *popup);
-#endif
-
 Q_SIGNALS:
     void anchorsChanged();
     void exclusionZoneChanged();

src/qwaylandlayershell.cpp

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

src/qwaylandlayershell_p.h

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

src/qwaylandlayershellintegration.cpp

@@ -7,7 +7,6 @@
 
 #include "qwaylandlayershell_p.h"
 #include "qwaylandlayershellintegration_p.h"
-#include "qwaylandlayersurface_p.h"
 
 #include <QtWaylandClient/private/qwaylanddisplay_p.h>
 #include <QtWaylandClient/private/qwaylandwindow_p.h>
@@ -16,7 +15,6 @@
 namespace LayerShellQt
 {
 QWaylandLayerShellIntegration::QWaylandLayerShellIntegration()
-    : m_layerShell(new QWaylandLayerShell())
 {
 }
 
@@ -26,14 +24,26 @@ QWaylandLayerShellIntegration::~QWaylandLayerShellIntegration()
 
 bool QWaylandLayerShellIntegration::initialize(QtWaylandClient::QWaylandDisplay *display)
 {
-    Q_UNUSED(display)
-    return m_layerShell->isActive();
+#if QT_VERSION < QT_VERSION_CHECK(6, 0, 0)
+    QWaylandShellIntegration::initialize(display);
+#endif
+    display->addRegistryListener(registryLayer, this);
+    return m_layerShell != nullptr;
 }
 
 QtWaylandClient::QWaylandShellSurface *QWaylandLayerShellIntegration::createShellSurface(QtWaylandClient::QWaylandWindow *window)
 {
-    return new QWaylandLayerSurface(m_layerShell.get(), window);
+    return m_layerShell->createLayerSurface(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,6 +27,8 @@ 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/window.h"
+#include "interfaces/shell.h"
 #include "layershellqt_logging.h"
 #include "qwaylandlayershell_p.h"
 #include "qwaylandlayersurface_p.h"
@@ -37,7 +37,7 @@ 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]() {
-        setLayer(interface->layer());
+        set_layer(interface->layer());
     });
 
     set_anchor(interface->anchors());

tests/main.cpp

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