qtbase/src/plugins/platforms/wayland/global/qwaylandclientextension.h
Erik Larsson e862c2d222 Simplify client-side API for Wayland extensions
This simplifies the client-side API for Wayland extensions by
introducing QWaylandClientExtension/QWaylandClientExtensionTemplate
classes. These classes takes care of the initialization of the extension
if it matches the interface name.

Change-Id: I7c4fb34563563af4be072cdebda54954b79cddbe
Reviewed-by: Johan Helsing <johan.helsing@theqtcompany.com>
Reviewed-by: Giulio Camuffo <giulio.camuffo@kdab.com>
2016-03-18 07:38:55 +00:00

106 lines
3.8 KiB
C++

/****************************************************************************
**
** Copyright (C) 2016 Erik Larsson.
** Contact: http://www.qt.io/licensing/
**
** This file is part of the QtWaylandCompositor module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL3$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see http://www.qt.io/terms-conditions. For further
** information use the contact form at http://www.qt.io/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 3 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPLv3 included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 3 requirements
** will be met: https://www.gnu.org/licenses/lgpl.html.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 2.0 or later as published by the Free
** Software Foundation and appearing in the file LICENSE.GPL included in
** the packaging of this file. Please review the following information to
** ensure the GNU General Public License version 2.0 requirements will be
** met: http://www.gnu.org/licenses/gpl-2.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/
#ifndef QWAYLANDCLIENTEXTENSION_H
#define QWAYLANDCLIENTEXTENSION_H
#include <QObject>
#include <qpa/qwindowsysteminterface.h>
#include <QtWaylandClient/private/qwaylandclientexport_p.h>
#include <QtWaylandClient/private/qwayland-wayland.h>
QT_BEGIN_NAMESPACE
namespace QtWaylandClient {
class QWaylandIntegration;
class QWaylandClientExtensionPrivate;
class QWaylandClientExtensionTemplatePrivate;
class Q_WAYLAND_CLIENT_EXPORT QWaylandClientExtension : public QObject
{
Q_OBJECT
Q_DECLARE_PRIVATE(QWaylandClientExtension)
Q_PROPERTY(int protocolVersion READ version NOTIFY versionChanged)
public:
QWaylandClientExtension(const int version);
QWaylandIntegration *integration() const;
int version() 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();
};
template <typename T>
class Q_WAYLAND_CLIENT_EXPORT QWaylandClientExtensionTemplate : public QWaylandClientExtension
{
Q_DECLARE_PRIVATE(QWaylandClientExtensionTemplate)
public:
QWaylandClientExtensionTemplate(const int ver) :
QWaylandClientExtension(ver)
{
}
const struct wl_interface *extensionInterface() const Q_DECL_OVERRIDE
{
return T::interface();
}
void bind(struct ::wl_registry *registry, int id, int ver)
{
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.");
}
int minVersion = qMin(ver, qMin(T::interface()->version, this->version()));
setVersion(minVersion);
instance->init(registry, id, minVersion);
}
};
}
QT_END_NAMESPACE
#endif // QWAYLANDCLIENTEXTENSION_H