Macro for QML extension boilerplate

defines which gives type sub-classes which adds desired functionality
for extensions in QML

Change-Id: I3973e07e0daf0c27813b3405b9188281092f4375

4 files changed, 122 insertions, 61 deletions

diff --git a/src/compositor/global/global.pri b/src/compositor/global/global.pri
index 68b385e92..6edfd9685 100644
--- a/src/compositor/global/global.pri
+++ b/src/compositor/global/global.pri
@@ -3,7 +3,8 @@ INCLUDEPATH += global/
 HEADERS += \
     global/qwaylandexport.h \
     global/qwaylandextension.h \
-    global/qwaylandextension_p.h
+    global/qwaylandextension_p.h \
+    global/qwaylandquickextension.h \
 
 SOURCES += \
     global/qwaylandextension.cpp
diff --git a/src/compositor/global/qwaylandquickextension.h b/src/compositor/global/qwaylandquickextension.h
new file mode 100644
index 000000000..183d4c23c
--- /dev/null
+++ b/src/compositor/global/qwaylandquickextension.h
@@ -0,0 +1,110 @@
+/****************************************************************************
+**
+** Copyright (C) 2015 The Qt Company Ltd.
+** 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 QWAYLANDQUICKEXTENSION_H
+#define QWAYLANDQUICKEXTENSION_H
+
+#include <QtCompositor/QWaylandExtension>
+
+QT_BEGIN_NAMESPACE
+
+#define Q_COMPOSITOR_DECLARE_QUICK_DATA_CLASS(className) \
+    class Q_COMPOSITOR_EXPORT className##QuickData : public className \
+    { \
+/* qmake ignore Q_OBJECT */ \
+        Q_OBJECT \
+        Q_PROPERTY(QQmlListProperty<QObject> data READ data DESIGNABLE false) \
+        Q_CLASSINFO("DefaultProperty", "data") \
+    public: \
+        QQmlListProperty<QObject> data() \
+        { \
+            return QQmlListProperty<QObject>(this, m_objects); \
+        } \
+    private: \
+        QList<QObject *> m_objects; \
+    };
+
+#define Q_COMPOSITOR_DECLARE_QUICK_EXTENSION_CLASS(className) \
+    class Q_COMPOSITOR_EXPORT className##QuickExtension : public className \
+    { \
+/* qmake ignore Q_OBJECT */ \
+        Q_OBJECT \
+        Q_PROPERTY(QQmlListProperty<QWaylandExtension> extensions READ extensions) \
+        Q_PROPERTY(QQmlListProperty<QObject> data READ data DESIGNABLE false) \
+        Q_CLASSINFO("DefaultProperty", "data") \
+    public: \
+        QQmlListProperty<QObject> data() \
+        { \
+            return QQmlListProperty<QObject>(this, m_objects); \
+        } \
+        QQmlListProperty<QWaylandExtension> extensions() \
+        { \
+            return QQmlListProperty<QWaylandExtension>(this, this, \
+                                                       &className##QuickExtension::append_extension, \
+                                                       &className##QuickExtension::countFunction, \
+                                                       &className##QuickExtension::atFunction, \
+                                                       &className##QuickExtension::clearFunction); \
+        } \
+        static int countFunction(QQmlListProperty<QWaylandExtension> *list) \
+        { \
+            return static_cast<className##QuickExtension *>(list->data)->extension_vector.size(); \
+        } \
+        static QWaylandExtension *atFunction(QQmlListProperty<QWaylandExtension> *list, int index) \
+        { \
+            return static_cast<className##QuickExtension *>(list->data)->extension_vector.at(index); \
+        } \
+        static void append_extension(QQmlListProperty<QWaylandExtension> *list, QWaylandExtension *extension) \
+        { \
+            className##QuickExtension *compositor = static_cast<className##QuickExtension *>(list->data); \
+            extension->setExtensionContainer(compositor); \
+        } \
+        static void clearFunction(QQmlListProperty<QWaylandExtension> *list) \
+        { \
+            static_cast<className##QuickExtension *>(list->data)->extension_vector.clear(); \
+        } \
+    protected: \
+        void componentComplete() Q_DECL_OVERRIDE \
+        { \
+            create(); \
+            QWaylandQuickCompositor::componentComplete(); \
+        }\
+    private: \
+        QList<QObject *> m_objects; \
+    };
+
+QT_END_NAMESPACE
+
+#endif  /*QWAYLANDQUICKEXTENSION_H*/
diff --git a/src/imports/compositor/qwaylandquickcompositorplugin.cpp b/src/imports/compositor/qwaylandquickcompositorplugin.cpp
index 597aa0734..2b78ccd25 100644
--- a/src/imports/compositor/qwaylandquickcompositorplugin.cpp
+++ b/src/imports/compositor/qwaylandquickcompositorplugin.cpp
@@ -46,6 +46,7 @@
 #include <QtCompositor/QWaylandOutput>
 #include <QtCompositor/QWaylandOutputSpace>
 #include <QtCompositor/QWaylandExtension>
+#include <QtCompositor/QWaylandQuickExtension>
 
 #include <QtCompositor/QWaylandShell>
 
@@ -54,63 +55,8 @@
 
 QT_BEGIN_NAMESPACE
 
-class Q_COMPOSITOR_EXPORT QWaylandQuickCompositorImpl : public QWaylandQuickCompositor
-{
-    Q_OBJECT
-    Q_PROPERTY(QQmlListProperty<QObject> data READ data DESIGNABLE false)
-    Q_PROPERTY(QQmlListProperty<QWaylandExtension> extensions READ extensions)
-    Q_CLASSINFO("DefaultProperty", "data")
-public:
-    QWaylandQuickCompositorImpl(QObject *parent = 0)
-        : QWaylandQuickCompositor(parent)
-    {
-        setInitializeLegazyQmlNames(false);
-    }
-
-    QQmlListProperty<QObject> data()
-    {
-        return QQmlListProperty<QObject>(this, m_objects);
-    }
-
-    QQmlListProperty<QWaylandExtension> extensions()
-    {
-        return QQmlListProperty<QWaylandExtension>(this, this,
-                                                   &QWaylandQuickCompositorImpl::append_extension,
-                                                   &QWaylandQuickCompositorImpl::countFunction,
-                                                   &QWaylandQuickCompositorImpl::atFunction,
-                                                   &QWaylandQuickCompositorImpl::clearFunction);
-    }
-
-    static int countFunction(QQmlListProperty<QWaylandExtension> *list)
-    {
-        return static_cast<QWaylandQuickCompositorImpl *>(list->data)->extension_vector.size();
-    }
-
-    static QWaylandExtension *atFunction(QQmlListProperty<QWaylandExtension> *list, int index)
-    {
-        return static_cast<QWaylandQuickCompositorImpl *>(list->data)->extension_vector.at(index);
-    }
-
-    static void append_extension(QQmlListProperty<QWaylandExtension> *list, QWaylandExtension *extension)
-    {
-        QWaylandQuickCompositorImpl *compositor = static_cast<QWaylandQuickCompositorImpl *>(list->data);
-        extension->setExtensionContainer(compositor);
-    }
-
-    static void clearFunction(QQmlListProperty<QWaylandExtension> *list)
-    {
-        static_cast<QWaylandQuickCompositorImpl *>(list->data)->extension_vector.clear();
-    }
-protected:
-    void componentComplete() Q_DECL_OVERRIDE
-    {
-        create();
-        QWaylandQuickCompositor::componentComplete();
-    }
-
-private:
-    QList<QObject *> m_objects;
-};
+Q_COMPOSITOR_DECLARE_QUICK_DATA_CLASS(QWaylandShell)
+Q_COMPOSITOR_DECLARE_QUICK_EXTENSION_CLASS(QWaylandQuickCompositor)
 
 class QmlUrlResolver
 {
@@ -174,19 +120,19 @@ public:
 
     static void defineModule(const char *uri)
     {
-        qmlRegisterType<QWaylandQuickCompositorImpl>(uri, 1, 0, "WaylandCompositor");
+        qmlRegisterType<QWaylandQuickCompositorQuickExtension>(uri, 1, 0, "WaylandCompositor");
         qmlRegisterType<QWaylandQuickItem>(uri, 1, 0, "WaylandQuickItem");
         qmlRegisterType<QWaylandMouseTracker>(uri, 1, 0, "WaylandMouseTracker");
 
         qmlRegisterUncreatableType<QWaylandExtension>(uri, 1, 0, "WaylandExtension", QObject::tr("Cannot create instance of WaylandExtension"));
-        qmlRegisterUncreatableType<QWaylandQuickSurface>(uri, 1, 0, "WaylandSurface", QObject::tr("Cannot create instance of WaylandQuickSurface"));
+        qmlRegisterUncreatableType<QWaylandSurface>(uri, 1, 0, "WaylandSurface", QObject::tr("Cannot create instance of WaylandQuickSurface"));
         qmlRegisterUncreatableType<QWaylandClient>(uri, 1, 0, "WaylandClient", QObject::tr("Cannot create instance of WaylandClient"));
         qmlRegisterUncreatableType<QWaylandOutput>(uri, 1, 0, "WaylandOutput", QObject::tr("Cannot create instance of WaylandOutput"));
         qmlRegisterUncreatableType<QWaylandOutputSpace>(uri, 1, 0, "WaylandOutputSpace", QObject::tr("Cannot create instance of WaylandOutputSpace"));
         qmlRegisterUncreatableType<QWaylandView>(uri, 1, 0, "WaylandView", QObject::tr("Cannot create instance of WaylandView, it can be retrieved by accessor on WaylandQuickItem"));
 
         //This should probably be somewhere else
-        qmlRegisterType<QWaylandShell>(uri, 1, 0, "DefaultShell");
+        qmlRegisterType<QWaylandShellQuickData>(uri, 1, 0, "DefaultShell");
         qmlRegisterUncreatableType<QWaylandShellSurface>(uri, 1, 0, "DefaultShellSurface", QObject::tr("Cannot create instance of DefaultShellSurface"));
     }
 };
diff --git a/sync.profile b/sync.profile
index 5bff75354..9b90e4a95 100644
--- a/sync.profile
+++ b/sync.profile
@@ -19,3 +19,7 @@
     "qtbase" => "",
     "qtdeclarative" => "",
 );
+
+%classnames = (
+    "qwaylandquickextension.h" => "QWaylandQuickExtension",
+);