Basic foreign window support for QNX

Requires a screen with working context permission parsing.  Currently,
all context permission requests fail because the parsing is incorrect.
A context permission is added temporarily to prevent CLOSE/CREATE
events when Qt reparents foreign windows.  Qt does this temporarily
when a foreign window is wrapped in a widget.

Change-Id: I84c18e70d43239286fcd53715332d7015cf1a826
Reviewed-by: Rafael Roquetto <rafael@roquetto.com>

4 files changed, 315 insertions, 0 deletions

diff --git a/examples/widgets/qnx/foreignwindows/collector.cpp b/examples/widgets/qnx/foreignwindows/collector.cpp
new file mode 100644
index 0000000000..4b9e774945
--- /dev/null
+++ b/examples/widgets/qnx/foreignwindows/collector.cpp
@@ -0,0 +1,176 @@
+/***************************************************************************
+**
+** Copyright (C) 2018 QNX Software Systems. All rights reserved.
+** Contact: https://www.qt.io/licensing/
+**
+** This file is part of the plugins of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL$
+** 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 https://www.qt.io/terms-conditions. For further
+** information use the contact form at https://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.LGPL3 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-3.0.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 (at your option) the GNU General
+** Public license version 3 or any later version approved by the KDE Free
+** Qt Foundation. The licenses are as published by the Free Software
+** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
+** included in the packaging of this file. Please review the following
+** information to ensure the GNU General Public License requirements will
+** be met: https://www.gnu.org/licenses/gpl-2.0.html and
+** https://www.gnu.org/licenses/gpl-3.0.html.
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#include <QApplication>
+#include <QDebug>
+#include <QHBoxLayout>
+#include <QWindow>
+
+#include <algorithm>
+#include <screen/screen.h>
+
+#include "collector.h"
+
+constexpr int MANAGER_EVENT_NAME_SUGGESTION = 9999;
+
+Collector::Collector(QWidget *parent)
+    : QWidget(parent)
+{
+    QApplication::instance()->installNativeEventFilter(this);
+
+    QLayout *layout = new QHBoxLayout(this);
+    setLayout(layout);
+}
+
+Collector::~Collector()
+{
+    QApplication::instance()->removeNativeEventFilter(this);
+}
+
+bool Collector::nativeEventFilter(const QByteArray &eventType, void *message, long *result)
+{
+    Q_UNUSED(result);
+
+    if (eventType == QByteArrayLiteral("screen_event_t"))
+        return filterQnxScreenEvent(static_cast<screen_event_t>(message));
+
+    return false;
+}
+
+bool Collector::filterQnxScreenEvent(screen_event_t event)
+{
+    int objectType = SCREEN_OBJECT_TYPE_CONTEXT;
+    screen_get_event_property_iv(event, SCREEN_PROPERTY_OBJECT_TYPE, &objectType);
+
+    if (objectType == SCREEN_OBJECT_TYPE_WINDOW)
+        return filterQnxScreenWindowEvent(event);
+
+    return false;
+}
+
+bool Collector::filterQnxScreenWindowEvent(screen_event_t event)
+{
+    int eventType = SCREEN_EVENT_NONE;
+    screen_get_event_property_iv(event, SCREEN_PROPERTY_TYPE, &eventType);
+    screen_window_t window = nullptr;
+    screen_get_event_property_pv(event,
+                                 SCREEN_PROPERTY_WINDOW,
+                                 reinterpret_cast<void **>(&window));
+
+    if (eventType == SCREEN_EVENT_CREATE)
+        return filterQnxScreenWindowCreateEvent(window, event);
+    else if (eventType == SCREEN_EVENT_CLOSE)
+        return filterQnxScreenWindowCloseEvent(window, event);
+    else if (eventType == SCREEN_EVENT_MANAGER)
+        return filterQnxScreenWindowManagerEvent(window, event);
+
+    return false;
+}
+
+bool Collector::filterQnxScreenWindowCreateEvent(screen_window_t window, screen_event_t event)
+{
+    Q_UNUSED(event);
+    WId winId = reinterpret_cast<WId>(window);
+
+    QByteArray parentGroup(256, 0);
+    screen_get_window_property_cv(window,
+            SCREEN_PROPERTY_PARENT,
+            parentGroup.length(),
+            parentGroup.data());
+    parentGroup.resize(strlen(parentGroup.constData()));
+
+    QByteArray group(256, 0);
+    screen_get_window_property_cv(reinterpret_cast<screen_window_t>(windowHandle()->winId()),
+            SCREEN_PROPERTY_GROUP,
+            group.length(),
+            group.data());
+    group.resize(strlen(group.constData()));
+
+    if (parentGroup != group)
+        return false;
+
+    Collectible collectible;
+    collectible.window = QWindow::fromWinId(winId);
+    collectible.widget = QWidget::createWindowContainer(collectible.window, this);
+    layout()->addWidget(collectible.widget);
+    m_collectibles.append(collectible);
+
+    return false;
+}
+
+bool Collector::filterQnxScreenWindowCloseEvent(screen_window_t window, screen_event_t event)
+{
+    Q_UNUSED(event);
+    WId winId = reinterpret_cast<WId>(window);
+    auto it = std::find_if(m_collectibles.begin(), m_collectibles.end(),
+                           [winId] (const Collectible &collectible) {
+                               return collectible.window->winId() == winId;
+                           });
+    if (it != m_collectibles.end()) {
+        delete it->widget;
+        // it->window is deleted by it->widget.
+        m_collectibles.erase(it);
+    }
+
+    return false;
+}
+
+bool Collector::filterQnxScreenWindowManagerEvent(screen_window_t window, screen_event_t event)
+{
+    int managerEventType = 0;
+    screen_get_event_property_iv(event, SCREEN_PROPERTY_SUBTYPE, &managerEventType);
+
+    if (managerEventType == MANAGER_EVENT_NAME_SUGGESTION)
+        return filterQnxScreenWindowManagerNameEvent(window, event);
+
+    return false;
+}
+
+bool Collector::filterQnxScreenWindowManagerNameEvent(screen_window_t window, screen_event_t event)
+{
+    Q_UNUSED(window);
+    int dataSize = 0;
+    screen_get_event_property_iv(event, SCREEN_PROPERTY_SIZE, &dataSize);
+    if (dataSize > 0) {
+        QByteArray data(dataSize, 0);
+        screen_get_event_property_cv(event, SCREEN_PROPERTY_USER_DATA, data.size(), data.data());
+    }
+
+    return false;
+}
diff --git a/examples/widgets/qnx/foreignwindows/collector.h b/examples/widgets/qnx/foreignwindows/collector.h
new file mode 100644
index 0000000000..2b1ed499ff
--- /dev/null
+++ b/examples/widgets/qnx/foreignwindows/collector.h
@@ -0,0 +1,75 @@
+/***************************************************************************
+**
+** Copyright (C) 2018 QNX Software Systems. All rights reserved.
+** Contact: https://www.qt.io/licensing/
+**
+** This file is part of the plugins of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL$
+** 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 https://www.qt.io/terms-conditions. For further
+** information use the contact form at https://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.LGPL3 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-3.0.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 (at your option) the GNU General
+** Public license version 3 or any later version approved by the KDE Free
+** Qt Foundation. The licenses are as published by the Free Software
+** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
+** included in the packaging of this file. Please review the following
+** information to ensure the GNU General Public License requirements will
+** be met: https://www.gnu.org/licenses/gpl-2.0.html and
+** https://www.gnu.org/licenses/gpl-3.0.html.
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#ifndef COLLECTOR_H_
+#define COLLECTOR_H_
+
+#include <QAbstractNativeEventFilter>
+#include <QWidget>
+#include <QVector>
+
+#include <screen/screen.h>
+
+class Collector : public QWidget, public QAbstractNativeEventFilter
+{
+public:
+    explicit Collector(QWidget *parent = nullptr);
+    ~Collector() override;
+
+    bool nativeEventFilter(const QByteArray &eventType, void *message, long *result) override;
+
+private:
+    struct Collectible
+    {
+        QWindow *window;
+        QWidget *widget;
+    };
+    QVector<Collectible> m_collectibles;
+
+    bool filterQnxScreenEvent(screen_event_t event);
+    bool filterQnxScreenWindowEvent(screen_event_t event);
+    bool filterQnxScreenWindowCreateEvent(screen_window_t window, screen_event_t event);
+    bool filterQnxScreenWindowCloseEvent(screen_window_t window, screen_event_t event);
+    bool filterQnxScreenWindowManagerEvent(screen_window_t window, screen_event_t event);
+    bool filterQnxScreenWindowManagerNameEvent(screen_window_t window,
+                                               screen_event_t event);
+};
+
+
+#endif /* COLLECTOR_H_ */
diff --git a/examples/widgets/qnx/foreignwindows/foreignwindows.pro b/examples/widgets/qnx/foreignwindows/foreignwindows.pro
new file mode 100644
index 0000000000..09ff8633eb
--- /dev/null
+++ b/examples/widgets/qnx/foreignwindows/foreignwindows.pro
@@ -0,0 +1,11 @@
+TEMPLATE = app
+
+HEADERS += collector.h
+SOURCES += main.cpp collector.cpp
+LIBS += -lscreen
+
+QT += widgets
+
+# install
+target.path = $$[QT_INSTALL_EXAMPLES]/widgets/qnx/foreignwindows
+INSTALLS += target
diff --git a/examples/widgets/qnx/foreignwindows/main.cpp b/examples/widgets/qnx/foreignwindows/main.cpp
new file mode 100644
index 0000000000..128e93cf88
--- /dev/null
+++ b/examples/widgets/qnx/foreignwindows/main.cpp
@@ -0,0 +1,53 @@
+/***************************************************************************
+**
+** Copyright (C) 2018 QNX Software Systems. All rights reserved.
+** Contact: https://www.qt.io/licensing/
+**
+** This file is part of the plugins of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL$
+** 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 https://www.qt.io/terms-conditions. For further
+** information use the contact form at https://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.LGPL3 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-3.0.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 (at your option) the GNU General
+** Public license version 3 or any later version approved by the KDE Free
+** Qt Foundation. The licenses are as published by the Free Software
+** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
+** included in the packaging of this file. Please review the following
+** information to ensure the GNU General Public License requirements will
+** be met: https://www.gnu.org/licenses/gpl-2.0.html and
+** https://www.gnu.org/licenses/gpl-3.0.html.
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#include <QApplication>
+
+#include "collector.h"
+
+int main(int argc, char *argv[])
+{
+    QApplication app(argc, argv);
+
+    Collector collector;
+    collector.resize(640, 480);
+    collector.show();
+
+    return app.exec();
+}