QmlDebug: Add a debug service for use with native debuggers

This service provides information about the state of the
most recently used QmlEngine in a way that can be integrated
with "native" debuggers (GDB, LLDB, potentially CDB).

Unlike the existing QV4 debugger service, the data extraction
is triggered by direct calls from the native debuggers, i.e.
has the examined QmlEngine stopped at the time of inspection.

Since roundtrips through the native debuggers are expensive,
an additional goal is to minimize roundtrips.

Change-Id: Ic420129bbc15162197e35b52d92e882c027c9f6d
Reviewed-by: Ulf Hermann <ulf.hermann@theqtcompany.com>

3 files changed, 134 insertions, 1 deletions

diff --git a/tests/auto/qml/debugger/debugger.pro b/tests/auto/qml/debugger/debugger.pro
index 5a08418be1..6b47801720 100644
--- a/tests/auto/qml/debugger/debugger.pro
+++ b/tests/auto/qml/debugger/debugger.pro
@@ -8,7 +8,8 @@ PUBLICTESTS += \
     qpacketprotocol \
     qqmlenginedebuginspectorintegrationtest \
     qqmlenginecontrol \
-    qqmldebuggingenabler
+    qqmldebuggingenabler \
+    qqmlnativeconnector
 
 PRIVATETESTS += \
     qqmldebugclient \
diff --git a/tests/auto/qml/debugger/qqmlnativeconnector/qqmlnativeconnector.pro b/tests/auto/qml/debugger/qqmlnativeconnector/qqmlnativeconnector.pro
new file mode 100644
index 0000000000..757aa0306d
--- /dev/null
+++ b/tests/auto/qml/debugger/qqmlnativeconnector/qqmlnativeconnector.pro
@@ -0,0 +1,6 @@
+CONFIG += testcase qml_debug
+TARGET = tst_qqmlnativeconnector
+QT += qml testlib gui-private core-private
+osx:CONFIG -= app_bundle
+
+SOURCES +=     tst_qqmlnativeconnector.cpp
diff --git a/tests/auto/qml/debugger/qqmlnativeconnector/tst_qqmlnativeconnector.cpp b/tests/auto/qml/debugger/qqmlnativeconnector/tst_qqmlnativeconnector.cpp
new file mode 100644
index 0000000000..099b952352
--- /dev/null
+++ b/tests/auto/qml/debugger/qqmlnativeconnector/tst_qqmlnativeconnector.cpp
@@ -0,0 +1,126 @@
+/****************************************************************************
+**
+** Copyright (C) 2015 The Qt Company Ltd.
+** Contact: http://www.qt.io/licensing/
+**
+** This file is part of the test suite of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL21$
+** 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 2.1 or version 3 as published by the Free
+** Software Foundation and appearing in the file LICENSE.LGPLv21 and
+** LICENSE.LGPLv3 included in the packaging of this file. Please review the
+** following information to ensure the GNU Lesser General Public License
+** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
+** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
+**
+** As a special exception, The Qt Company gives you certain additional
+** rights. These rights are described in The Qt Company LGPL Exception
+** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#include <QtCore/qjsondocument.h>
+#include <QtCore/qjsonobject.h>
+#include <QtCore/qtimer.h>
+#include <QtTest/qtest.h>
+#include <QtQml/qqmlapplicationengine.h>
+#include <QtQml/qqmlcomponent.h>
+
+#include <private/qhooks_p.h>
+
+const char testData[] =
+"import QtQuick 2.0\n"
+"Item {\n"
+"    id: item\n"
+"    property int a: 0\n"
+"    Timer {\n"
+"        id: timer;  interval: 1; repeat: true; running: true\n"
+"        onTriggered: {\n"
+"        a++\n"
+"        }\n"
+"    }\n"
+"}\n";
+
+struct ResolvedHooks
+{
+    quintptr version;
+    quintptr numEntries;
+    const char **qt_qmlDebugMessageBuffer;
+    int *qt_qmlDebugMessageLength;
+    bool (*qt_qmlDebugSendDataToService)(const char *serviceName, const char *hexData);
+    bool (*qt_qmlDebugEnableService)(const char *data);
+    bool (*qt_qmlDebugDisableService)(const char *data);
+    void (*qt_qmlDebugObjectAvailable)();
+} *hooks;
+
+class Application : public QGuiApplication
+{
+    Q_OBJECT
+public:
+    Application(int &argc, char **argv)
+        : QGuiApplication(argc, argv),
+          component(&engine)
+    {
+        component.setData(testData, QUrl("MyStuff"));
+        mainObject = component.create();
+    }
+
+private slots:
+    void testEcho()
+    {
+        QJsonObject request;
+        QJsonObject arguments;
+        arguments.insert(QLatin1String("test"), QLatin1String("BUH"));
+        request.insert(QLatin1String("command"), QLatin1String("echo"));
+        request.insert(QLatin1String("arguments"), arguments);
+        QJsonDocument doc;
+        doc.setObject(request);
+        QByteArray hexdata = doc.toJson(QJsonDocument::Compact).toHex();
+
+        hooks = (ResolvedHooks *)qtHookData[QHooks::Startup];
+        QCOMPARE(bool(hooks), true); // Available after connector start only.
+        QCOMPARE(hooks->version, quintptr(1));
+        QCOMPARE(hooks->numEntries, quintptr(6));
+        QCOMPARE(bool(hooks->qt_qmlDebugSendDataToService), true);
+        QCOMPARE(bool(hooks->qt_qmlDebugMessageBuffer), true);
+        QCOMPARE(bool(hooks->qt_qmlDebugMessageLength), true);
+        QCOMPARE(bool(hooks->qt_qmlDebugEnableService), true);
+
+        hooks->qt_qmlDebugEnableService("NativeQmlDebugger");
+        hooks->qt_qmlDebugSendDataToService("NativeQmlDebugger", hexdata);
+        QByteArray response(*hooks->qt_qmlDebugMessageBuffer, *hooks->qt_qmlDebugMessageLength);
+
+        QCOMPARE(response, QByteArray("NativeQmlDebugger 25 {\"result\":{\"test\":\"BUH\"}}"));
+    }
+
+private:
+    QQmlApplicationEngine engine;
+    QQmlComponent component;
+    QObject *mainObject;
+};
+
+int main(int argc, char *argv[])
+{
+    char **argv2 = new char *[argc + 2];
+    for (int i = 0; i < argc; ++i)
+        argv2[i] = argv[i];
+    argv2[argc] = strdup("-qmljsdebugger=native,services:NativeQmlDebugger");
+    ++argc;
+    argv2[argc] = 0;
+    Application app(argc, argv2);
+    return QTest::qExec(&app, argc, argv);
+}
+
+#include "tst_qqmlnativeconnector.moc"