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,8 +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

CMakeLists.txt

@@ -4,13 +4,13 @@
 cmake_minimum_required(VERSION 3.16)
 
 project(layershellqt)
-set(PROJECT_VERSION "5.27.6")
+set(PROJECT_VERSION "5.25.80")
 set(PROJECT_VERSION_MAJOR 5)
 
 set(CMAKE_C_STANDARD 99)
 
 set(QT_MIN_VERSION "5.15.2")
-set(KF5_MIN_VERSION "5.102.0")
+set(KF5_MIN_VERSION "5.94")
 set(KDE_COMPILERSETTINGS_LEVEL "5.82")
 
 set(CMAKE_CXX_STANDARD 17)
@@ -23,16 +23,13 @@ include(KDEInstallDirs)
 include(KDECMakeSettings)
 include(KDECompilerSettings NO_POLICY_SCOPE)
 include(ECMSetupVersion)
-include(ECMDeprecationSettings)
 include(ECMGenerateHeaders)
 include(CMakePackageConfigHelpers)
 include(FeatureSummary)
 include(GenerateExportHeader)
 include(KDEClangFormat)
-include(ECMQmlModule)
 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)
@@ -56,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/CMakeLists.txt

@@ -24,8 +24,7 @@ ecm_qt_declare_logging_category(LAYER_SHELL_SOURCES
 )
 
 target_sources(LayerShellQtInterface PRIVATE qwaylandlayersurface.cpp interfaces/window.cpp interfaces/shell.cpp qwaylandlayershellintegration.cpp qwaylandlayershell.cpp ${LAYER_SHELL_SOURCES})
-target_link_libraries(LayerShellQtInterface PUBLIC Qt::Gui)
-target_link_libraries(LayerShellQtInterface PRIVATE Qt::WaylandClientPrivate Wayland::Client PkgConfig::XKBCOMMON)
+target_link_libraries(LayerShellQtInterface PRIVATE Qt::Gui Qt::WaylandClientPrivate Wayland::Client PkgConfig::XKBCOMMON)
 if (TARGET Qt::XkbCommonSupportPrivate)
     target_link_libraries(LayerShellQtInterface PRIVATE Qt::XkbCommonSupportPrivate)
 endif()
@@ -69,5 +68,3 @@ install(FILES
     ${CMAKE_CURRENT_BINARY_DIR}/LayerShellQt/layershellqt_export.h
     DESTINATION ${KDE_INSTALL_INCLUDEDIR}/LayerShellQt COMPONENT Devel
 )
-
-add_subdirectory(declarative)

src/declarative/CMakeLists.txt

@@ -1,8 +0,0 @@
-# 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")
-target_sources(LayerShellQtQml PRIVATE layershellqtplugin.cpp)
-target_link_libraries(LayerShellQtQml PRIVATE Qt::Qml LayerShellQtInterface)
-
-ecm_finalize_qml_module(LayerShellQtQml DESTINATION ${KDE_INSTALL_QMLDIR})

src/declarative/layershellqtplugin.cpp

@@ -1,24 +0,0 @@
-/*
- *   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/window.cpp

@@ -5,10 +5,11 @@
  */
 
 #include "window.h"
+#include "../qwaylandlayersurface_p.h"
+#include "../qwaylandlayershellintegration_p.h"
 #include <layershellqt_logging.h>
-
-#include <QPointer>
-#include <optional>
+#include <private/qwaylandshellsurface_p.h>
+#include <private/qwaylandwindow_p.h>
 
 using namespace LayerShellQt;
 
@@ -27,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;
@@ -104,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)
@@ -122,22 +118,30 @@ Window::Window(QWindow *window)
     , d(new WindowPrivate(window))
 {
     s_map.insert(d->parentWindow, this);
+
+    //BEGIN Compat mode
+    window->winId();
+    window->setFlag(Qt::BypassWindowManagerHint);
+
+    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)
 {
-    if (!window) {
-        return nullptr;
-    }
-
     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

@@ -21,15 +21,7 @@ class WindowPrivate;
 class LAYERSHELLQT_EXPORT Window : public QObject
 {
     Q_OBJECT
-    Q_PROPERTY(int anchors READ anchors WRITE setAnchorsInt 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)
-
 public:
-    Window(QWindow *window = nullptr);
     ~Window() override;
 
     enum Anchor {
@@ -95,17 +87,12 @@ public:
     void setScope(const QString &scope);
     QString scope() const;
 
-    /// Workaround needed for Qt 5 not to get confused with types, not necessary on Qt 6
-    void setAnchorsInt(int x) { setAnchors(Anchors(x)); }
-
     /**
      * 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();
@@ -114,6 +101,7 @@ Q_SIGNALS:
     void layerChanged();
 
 private:
+    Window(QWindow *window);
     QScopedPointer<WindowPrivate> d;
 };
 

src/qwaylandlayersurface.cpp

@@ -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

@@ -51,7 +51,8 @@ class BasicWindow : public QRasterWindow
 
 int main(int argc, char **argv)
 {
-    Shell::useLayerShell();
+//    Shell::useLayerShell();
+    qputenv("QT_WAYLAND_USE_BYPASSWINDOWMANAGERHINT", "1");
 
     QGuiApplication app(argc, argv);
 

tests/quicktest.qml

@@ -1,115 +0,0 @@
-/*
- *   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 QtQuick.Window 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
-
-        Component.onCompleted: {
-            console.log("xxxx", LayerShell.Window.AnchorLeft, LayerShell.Window.anchors)
-        }
-
-        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
-    }
-}