qwaylandclientextension.h

Go to the documentation of this file.

// Copyright (C) 2017 Erik Larsson.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only
// Qt-Security score:significant reason:default
 
#ifndef QWAYLANDCLIENTEXTENSION_H
#define QWAYLANDCLIENTEXTENSION_H
 
#include <QtCore/QObject>
#include <QtWaylandClient/qtwaylandclientglobal.h>
 
struct wl_interface;
struct wl_registry;
 
QT_BEGIN_NAMESPACE
 
namespace QtWaylandClient {
class QWaylandIntegration;
}
 
class QWaylandClientExtensionPrivate;
class QWaylandClientExtensionTemplatePrivate;
 
class Q_WAYLANDCLIENT_EXPORT QWaylandClientExtension : public QObject
{
    Q_OBJECT
    Q_DECLARE_PRIVATE(QWaylandClientExtension)
    Q_PROPERTY(int protocolVersion READ version NOTIFY versionChanged)
    Q_PROPERTY(bool active READ isActive NOTIFY activeChanged)
public:
    QWaylandClientExtension(const int version);
    ~QWaylandClientExtension();
 
    QtWaylandClient::QWaylandIntegration *integration() const;
    int version() const;
    bool isActive() const;
 
    virtual const struct wl_interface *extensionInterface() const = 0;
    virtual void bind(struct ::wl_registry *registry, int id, int version) = 0;
protected:
    void setVersion(const int version);
Q_SIGNALS:
    void versionChanged();
    void activeChanged();
 
protected Q_SLOTS:
    void initialize();
};
 
 
template<typename T, auto destruct = nullptr>
class Q_WAYLANDCLIENT_EXPORT QWaylandClientExtensionTemplate : public QWaylandClientExtension
{
    Q_DECLARE_PRIVATE(QWaylandClientExtensionTemplate)
 
public:
    QWaylandClientExtensionTemplate(const int ver) : QWaylandClientExtension(ver)
    {
        if constexpr (destruct != nullptr) {
            connect(this, &QWaylandClientExtensionTemplate::activeChanged, this, [this] {
                if (!isActive()) {
                    std::invoke(destruct, static_cast<T *>(this));
                }
            });
        }
    }
 
    ~QWaylandClientExtensionTemplate()
    {
        if constexpr (destruct != nullptr) {
            if (isActive()) {
                std::invoke(destruct, static_cast<T *>(this));
            }
        }
    }
 
    const struct wl_interface *extensionInterface() const override
    {
        return T::interface();
    }
 
    void bind(struct ::wl_registry *registry, int id, int ver) override
    {
        T* instance = static_cast<T *>(this);
        // Make sure lowest version is used of the supplied version from the
        // developer and the version specified in the protocol and also the
        // compositor version.
        if (this->version() > T::interface()->version) {
            qWarning("Supplied protocol version to QWaylandClientExtensionTemplate is higher "
                     "than the version of the protocol, using protocol version instead.\n"
                     " interface.name: %s",
                     T::interface()->name);
        }
        int minVersion = qMin(ver, qMin(T::interface()->version, this->version()));
        setVersion(minVersion);
        instance->init(registry, id, minVersion);
    }
};
 
QT_END_NAMESPACE
 
#endif // QWAYLANDCLIENTEXTENSION_H