QDoc port

GIT_SILENT

.kde-ci.yml

@@ -7,3 +7,6 @@ Dependencies:
     'frameworks/extra-cmake-modules': '@latest-kf6'
     'third-party/wayland': '@latest'
     'third-party/wayland-protocols': '@latest'
+
+Options:
+  require-passing-tests-on: ['Linux', 'FreeBSD', 'Windows']

CMakeLists.txt

@@ -4,13 +4,13 @@
 cmake_minimum_required(VERSION 3.16)
 
 project(layershellqt)
-set(PROJECT_VERSION "6.0.80")
+set(PROJECT_VERSION "6.1.90")
 set(PROJECT_VERSION_MAJOR 6)
 
 set(CMAKE_C_STANDARD 99)
 
-set(QT_MIN_VERSION "6.6.0")
-set(KF6_MIN_VERSION "5.240.0")
+set(QT_MIN_VERSION "6.7.0")
+set(KF6_MIN_VERSION "6.5.0")
 set(KDE_COMPILERSETTINGS_LEVEL "5.82")
 
 set(CMAKE_CXX_STANDARD 20)
@@ -31,7 +31,8 @@ include(GenerateExportHeader)
 include(KDEClangFormat)
 include(ECMQtDeclareLoggingCategory)
 include(ECMQmlModule)
-
+include(KDEGitCommitHooks)
+include(ECMGenerateQDoc)
 
 find_package(Qt6 ${QT_MIN_VERSION} CONFIG REQUIRED COMPONENTS WaylandClient Qml)
 find_package(WaylandScanner REQUIRED)
@@ -53,6 +54,8 @@ 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})
 
+kde_configure_git_pre_commit_hook(CHECKS CLANG_FORMAT)
+
 ecm_set_disabled_deprecation_versions(QT 6.5
     KF 5.240
 )

src/CMakeLists.txt

@@ -4,10 +4,16 @@
 remove_definitions(-DQT_NO_SIGNALS_SLOTS_KEYWORDS)
 
 add_library(LayerShellQtInterface)
-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
+
+if (Qt6_VERSION VERSION_GREATER_EQUAL "6.8.0")
+    set(private_code_option  "PRIVATE_CODE")
+endif()
+qt6_generate_wayland_protocol_client_sources(LayerShellQtInterface
+    ${private_code_option}
+    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(LayerShellQtInterface
@@ -62,6 +68,8 @@ generate_export_header(LayerShellQtInterface
     EXPORT_FILE_NAME LayerShellQt/layershellqt_export.h
 )
 
+ecm_generate_qdoc(LayerShellQtInterface layershellqt.qdocconf)
+
 install(TARGETS layer-shell
         LIBRARY DESTINATION ${KDE_INSTALL_QTPLUGINDIR}/wayland-shell-integration)
 

src/declarative/layershellqtplugin.cpp

@@ -4,20 +4,47 @@
  *   SPDX-License-Identifier: LGPL-2.1-only OR LGPL-3.0-only OR LicenseRef-KDE-Accepted-LGPL
  */
 
-#include <QQmlExtensionPlugin>
 #include "../interfaces/window.h"
+#include <QQmlExtensionPlugin>
 #include <qqml.h>
 
 QML_DECLARE_TYPEINFO(LayerShellQt::Window, QML_HAS_ATTACHED_PROPERTIES)
 
+class ExtQMargins
+{
+    QMargins m_margins;
+    Q_GADGET
+    Q_PROPERTY(int left READ left WRITE setLeft FINAL)
+    Q_PROPERTY(int right READ right WRITE setRight FINAL)
+    Q_PROPERTY(int top READ top WRITE setTop FINAL)
+    Q_PROPERTY(int bottom READ bottom WRITE setBottom FINAL)
+    QML_FOREIGN(QMargins)
+    QML_EXTENDED(ExtQMargins)
+public:
+    ExtQMargins(const QMargins &margins);
+    int left() const { return m_margins.left(); }
+    void setLeft(int left) { m_margins.setLeft(left); }
+
+    int right() const { return m_margins.right(); }
+    void setRight(int right) { m_margins.setRight(right); }
+
+    int top() const { return m_margins.top(); }
+    void setTop(int top) { m_margins.setTop(top); }
+
+    int bottom() const { return m_margins.bottom(); }
+    void setBottom(int bottom) { m_margins.setBottom(bottom); }
+};
+
 class Plugin : public QQmlExtensionPlugin
 {
     Q_PLUGIN_METADATA(IID "org.kde.layershellqt")
     Q_OBJECT
 public:
-    void registerTypes(const char *uri) override {
+    void registerTypes(const char *uri) override
+    {
         Q_ASSERT(QLatin1String(uri) == QLatin1String("org.kde.layershell"));
         qmlRegisterType<LayerShellQt::Window>(uri, 1, 0, "Window");
+        qmlRegisterExtendedUncreatableType<QMargins, ExtQMargins>(uri, 1, 0, "ExtQMargins", QStringLiteral("Only created from C++"));
     }
 };
 

src/interfaces/shell.h

@@ -13,12 +13,18 @@
 
 namespace LayerShellQt
 {
-/**
- * Sets the right environment so the shells created from now on use wlr-layer-shell.
+/*!
+ * \class LayerShellQt::Shell
+ * \inmodule LayerShellQt
+ * \inheaderfile LayerShellQt/Shell
+ *
  */
 class LAYERSHELLQT_EXPORT Shell
 {
 public:
+    /*!
+     * Sets the right environment so the shells created from now on use wlr-layer-shell.
+     */
     static void useLayerShell();
 };
 

src/interfaces/window.h

@@ -18,10 +18,18 @@ namespace LayerShellQt
 {
 class WindowPrivate;
 
+/*!
+ * \class LayerShellQt::Window
+ * \inmodule LayerShellQt
+ * \inheaderfile LayerShellQt/Window
+ *
+ * \brief A window.
+ */
 class LAYERSHELLQT_EXPORT Window : public QObject
 {
     Q_OBJECT
     Q_PROPERTY(Anchors anchors READ anchors WRITE setAnchors NOTIFY anchorsChanged)
+    /*! \property LayerShellQt::Window::scope */
     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)
@@ -32,17 +40,24 @@ class LAYERSHELLQT_EXPORT Window : public QObject
 public:
     ~Window() override;
 
+    /*!
+     * \value AnchorNone
+     * \value AnchorTop The top edge of the anchor rectangle
+     * \value AnchorBottom The bottom edge of the anchor rectangle
+     * \value AnchorLeft The left edge of the anchor rectangle
+     * \value AnchorRight The right edge of the anchor rectangle
+     */
     enum Anchor {
         AnchorNone = 0,
-        AnchorTop = 1, ///< The top edge of the anchor rectangle
-        AnchorBottom = 2, ///< The bottom edge of the anchor rectangle
-        AnchorLeft = 4, ///< The left edge of the anchor rectangle
-        AnchorRight = 8, ///< The right edge of the anchor rectangle
+        AnchorTop = 1,
+        AnchorBottom = 2,
+        AnchorLeft = 4,
+        AnchorRight = 8,
     };
     Q_ENUM(Anchor);
     Q_DECLARE_FLAGS(Anchors, Anchor)
 
-    /**
+    /*!
      * This enum type is used to specify the layer where a surface can be put in.
      */
     enum Layer {
@@ -53,7 +68,7 @@ public:
     };
     Q_ENUM(Layer)
 
-    /**
+    /*!
      * This enum type is used to specify how the layer surface handles keyboard focus.
      */
     enum KeyboardInteractivity {
@@ -63,7 +78,7 @@ public:
     };
     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.
@@ -95,7 +110,7 @@ public:
     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.
@@ -103,9 +118,17 @@ public:
      * May also be referred to as a role
      */
     void setScope(const QString &scope);
+
+    /*!
+     * 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
+     */
     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.
      *
@@ -114,7 +137,7 @@ public:
     void setCloseOnDismissed(bool close);
     bool closeOnDismissed() const;
 
-    /**
+    /*!
      * Gets the LayerShell Window for a given Qt Window
      * Ownership is not transferred
      */

src/layershellqt.qdoc

@@ -0,0 +1,72 @@
+/*!
+    \module LayerShellQt
+    \title LayerShellQt C++ Classes
+
+    \cmakepackage LayerShellQt
+    \cmaketargetitem LayerShellQt::Interface
+*/
+
+/*!
+    \namespace LayerShellQt
+    \inmodule LayerShellQt
+
+    Stuff
+*/
+
+/*!
+    \qmlmodule org.kde.layershell
+    \title LayerShellQt QML Types
+*/
+
+/*!
+    \qmltype Window
+    \inqmlmodule org.kde.layershell
+
+    \nativetype LayerShellQt::Window
+*/
+
+/*!
+    \qmlproperty string Window::scope
+
+    A scope.
+*/
+
+/*!
+    \qmlproperty int Window::margins.top
+    \qmlproperty int Window::margins.bottom
+    \qmlproperty int Window::margins.left
+    \qmlproperty int Window::margins.right
+
+    Margins
+*/
+
+/*!
+    \qmlproperty int Window::exclusionZone
+*/
+
+/*!
+    \page layershellqt-index.html
+    \title LayerShellQt
+
+    Layer Shell
+
+    \section1 Using the Module
+
+    \include {module-use.qdocinc} {using the c++ api}
+
+    \section2 Building with CMake
+
+    \include {module-use.qdocinc} {building with cmake} {Widgets}
+
+    \section1 API Reference
+
+    \list
+        \li \l{LayerShellQt C++ Classes}
+        \li \l{LayerShellQt QML Types}
+    \endlist
+
+    \section1 Licenses
+
+    TODO
+*/
+

src/layershellqt.qdocconf

@@ -0,0 +1,30 @@
+include($KDE_DOCS/global/qt-module-defaults.qdocconf)
+
+project = LayerShellQt
+description = Qt component to allow applications to make use of the Wayland wl-layer-shell protocol
+
+documentationinheaders = true
+
+headerdirs = .
+
+headers.fileextensions = "*.qdoc *.h"
+
+outputdir  = doc/html
+outputformats = HTML
+
+depends += \
+    qtcore
+
+qhp.projects            = LayerShellQt
+
+qhp.LayerShellQt.file                = layershellqt.qhp
+qhp.LayerShellQt.namespace           = org.kde.layershellqt.$QT_VERSION_TAG
+qhp.LayerShellQt.virtualFolder       = layershellqt
+qhp.LayerShellQt.indexTitle          = LayerShellQt
+qhp.LayerShellQt.indexRoot           =
+
+qhp.LayerShellQt.subprojects         = classes
+qhp.LayerShellQt.subprojects.classes.title = C++ Classes
+qhp.LayerShellQt.subprojects.classes.indexTitle = LayerShellQt C++ Classes
+qhp.LayerShellQt.subprojects.classes.selectors = class fake:headerfile
+qhp.LayerShellQt.subprojects.classes.sortPages = true

src/qwaylandlayershellintegration.cpp

@@ -32,5 +32,4 @@ QtWaylandClient::QWaylandShellSurface *QWaylandLayerShellIntegration::createShel
     return new QWaylandLayerSurface(this, window);
 }
 
-
 }

src/qwaylandlayershellintegration_p.h

@@ -18,14 +18,19 @@ class QWaylandXdgActivationV1;
 namespace LayerShellQt
 {
 
-class LAYERSHELLQT_EXPORT QWaylandLayerShellIntegration : public QtWaylandClient::QWaylandShellIntegrationTemplate<QWaylandLayerShellIntegration>, public QtWayland::zwlr_layer_shell_v1
+class LAYERSHELLQT_EXPORT QWaylandLayerShellIntegration : public QtWaylandClient::QWaylandShellIntegrationTemplate<QWaylandLayerShellIntegration>,
+                                                          public QtWayland::zwlr_layer_shell_v1
 {
 public:
     QWaylandLayerShellIntegration();
     ~QWaylandLayerShellIntegration() override;
 
-    QWaylandXdgActivationV1 *activation() const { return m_xdgActivation.data(); }
+    QWaylandXdgActivationV1 *activation() const
+    {
+        return m_xdgActivation.data();
+    }
     QtWaylandClient::QWaylandShellSurface *createShellSurface(QtWaylandClient::QWaylandWindow *window) override;
+
 private:
     QScopedPointer<QWaylandXdgActivationV1> m_xdgActivation;
 };

src/qwaylandlayersurface.cpp

@@ -41,10 +41,12 @@ QWaylandLayerSurface::QWaylandLayerSurface(QWaylandLayerShellIntegration *shell,
         setLayer(m_interface->layer());
     });
 
-    set_anchor(m_interface->anchors());
+    setAnchor(m_interface->anchors());
     connect(m_interface, &Window::anchorsChanged, this, [this]() {
-        set_anchor(m_interface->anchors());
+        setAnchor(m_interface->anchors());
+        setDesiredSize(m_window->windowContentGeometry().size());
     });
+
     setExclusiveZone(m_interface->exclusionZone());
     connect(m_interface, &Window::exclusionZoneChanged, this, [this]() {
         setExclusiveZone(m_interface->exclusionZone());
@@ -64,17 +66,7 @@ QWaylandLayerSurface::QWaylandLayerSurface(QWaylandLayerShellIntegration *shell,
         setKeyboardInteractivity(m_interface->keyboardInteractivity());
     });
 
-    QSize size = window->surfaceSize();
-    const Window::Anchors anchors = m_interface->anchors();
-    if ((anchors & Window::AnchorLeft) && (anchors & Window::AnchorRight)) {
-        size.setWidth(0);
-    }
-    if ((anchors & Window::AnchorTop) && (anchors & Window::AnchorBottom)) {
-        size.setHeight(0);
-    }
-    if (size.isValid() && size != QSize(0, 0)) {
-        set_size(size.width(), size.height());
-    }
+    setDesiredSize(window->windowContentGeometry().size());
 }
 
 QWaylandLayerSurface::~QWaylandLayerSurface()
@@ -96,12 +88,8 @@ void QWaylandLayerSurface::zwlr_layer_surface_v1_configure(uint32_t serial, uint
 
     if (!m_configured) {
         m_configured = true;
-        window()->resizeFromApplyConfigure(m_pendingSize);
-#if QT_VERSION < QT_VERSION_CHECK(6, 7, 0)
-        window()->handleExpose(QRect(QPoint(), m_pendingSize));
-#else
-        window()->sendRecursiveExposeEvent();
-#endif
+        applyConfigure();
+        sendExpose();
     } else {
         // Later configures are resizes, so we have to queue them up for a time when we
         // are not painting to the window.
@@ -122,13 +110,33 @@ void QWaylandLayerSurface::attachPopup(QtWaylandClient::QWaylandShellSurface *po
 
 void QWaylandLayerSurface::applyConfigure()
 {
+#if QT_VERSION < QT_VERSION_CHECK(6, 9, 0)
+    m_configuring = true;
+#endif
     window()->resizeFromApplyConfigure(m_pendingSize);
+#if QT_VERSION < QT_VERSION_CHECK(6, 9, 0)
+    m_configuring = false;
+#endif
+}
+
+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)
 {
     set_anchor(anchor);
-    setWindowGeometry(window()->windowContentGeometry());
 }
 
 void QWaylandLayerSurface::setExclusiveZone(int32_t zone)
@@ -159,26 +167,21 @@ void QWaylandLayerSurface::setLayer(uint32_t layer)
         set_layer(layer);
 }
 
+#if QT_VERSION < QT_VERSION_CHECK(6, 9, 0)
 void QWaylandLayerSurface::setWindowGeometry(const QRect &geometry)
 {
-    // if we are setting it to the last size we were configured at, we don't need to do anything
-    if (geometry.size() == m_pendingSize) {
+    if (m_configuring) {
         return;
     }
 
-    const bool horizontallyConstrained = m_interface->anchors().testFlags({Window::AnchorLeft, Window::AnchorRight});
-    const bool verticallyConstrained = m_interface->anchors().testFlags({Window::AnchorTop, Window::AnchorBottom});
-
-    QSize size = geometry.size();
-    if (horizontallyConstrained) {
-        size.setWidth(0);
-    }
-    if (verticallyConstrained) {
-        size.setHeight(0);
-    }
-    set_size(size.width(), size.height());
-    wl_display_roundtrip(m_window->display()->wl_display());
+    setDesiredSize(geometry.size());
 }
+#else
+void QWaylandLayerSurface::setWindowSize(const QSize &size)
+{
+    setDesiredSize(size);
+}
+#endif
 
 bool QWaylandLayerSurface::requestActivate()
 {
@@ -192,14 +195,12 @@ bool QWaylandLayerSurface::requestActivate()
         return true;
     } else {
         const auto focusWindow = QGuiApplication::focusWindow();
-        const auto wlWindow = focusWindow ? static_cast<QtWaylandClient::QWaylandWindow*>(focusWindow->handle()) : window();
+        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());
-                    });
+            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;
         }
@@ -218,16 +219,23 @@ void QWaylandLayerSurface::requestXdgActivationToken(quint32 serial)
     if (!activation->isActive()) {
         return;
     }
-    auto tokenProvider = activation->requestXdgActivationToken(
-        window()->display(), window()->wlSurface(), serial, QString());
+    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, this, [this](const QString &token) {
+        Q_EMIT window()->xdgActivationTokenCreated(token);
+    });
     connect(tokenProvider, &QWaylandXdgActivationTokenV1::done, tokenProvider, &QObject::deleteLater);
+}
 
+void QWaylandLayerSurface::sendExpose()
+{
+#if QT_VERSION < QT_VERSION_CHECK(6, 7, 0)
+    window()->handleExpose(QRect(QPoint(), m_pendingSize));
+#elif QT_VERSION < QT_VERSION_CHECK(6, 9, 0)
+    window()->sendRecursiveExposeEvent();
+#else
+    window()->updateExposure();
+#endif
 }
 
 }
-

src/qwaylandlayersurface_p.h

@@ -34,6 +34,7 @@ public:
     }
     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);
@@ -42,13 +43,18 @@ public:
     void setLayer(uint32_t layer);
 
     void applyConfigure() override;
+#if QT_VERSION < QT_VERSION_CHECK(6, 9, 0)
     void setWindowGeometry(const QRect &geometry) override;
+#else
+    void setWindowSize(const QSize &size) override;
+#endif
 
     bool requestActivate() override;
     void setXdgActivationToken(const QString &token) override;
     void requestXdgActivationToken(quint32 serial) override;
 
 private:
+    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;
 
@@ -57,7 +63,11 @@ private:
     QtWaylandClient::QWaylandWindow *m_window;
     QSize m_pendingSize;
     QString m_activationToken;
+
     bool m_configured = false;
+#if QT_VERSION < QT_VERSION_CHECK(6, 9, 0)
+    bool m_configuring = false;
+#endif
 };
 
 }

tests/quicktest.qml

@@ -39,6 +39,7 @@ Item
         LayerShell.Window.anchors: LayerShell.Window.AnchorLeft
         LayerShell.Window.layer: LayerShell.Window.LayerTop
         LayerShell.Window.exclusionZone: width
+        LayerShell.Window.margins.left: 100
 
         width: 100
         height: 100