Add touch event support to qmltest

[ChangeLog][QuickTest] Add support for simulating touch events
from TestCase.

Task-number: QTBUG-23083
Change-Id: Ic045e00a91b8270b6f08d398323e06b576615e79
Reviewed-by: Shawn Rutledge <shawn.rutledge@qt.io>

3 files changed, 214 insertions, 0 deletions

diff --git a/src/imports/testlib/TestCase.qml b/src/imports/testlib/TestCase.qml
index d22ec7c44f..a874fd4fe2 100644
--- a/src/imports/testlib/TestCase.qml
+++ b/src/imports/testlib/TestCase.qml
@@ -1317,6 +1317,109 @@ Item {
             qtest_fail("window not shown", 2)
    }
 
+    /*!
+        \qmlmethod TouchEventSequence TestCase::touchEvent(object item)
+
+        \since 5.9
+
+        Begins a sequence of touch events through a simulated QTouchDevice::TouchScreen.
+        Events are delivered to the window containing \a item.
+
+        The returned object is used to enumerate events to be delivered through a single
+        QTouchEvent. Touches are delivered to the window containing the TestCase unless
+        otherwise specified.
+
+        \code
+        Rectangle {
+            width: 640; height: 480
+
+            MultiPointTouchArea {
+                id: area
+                anchors.fill: parent
+
+                property bool touched: false
+
+                onPressed: touched = true
+            }
+
+            TestCase {
+                name: "ItemTests"
+                when: area.pressed
+                id: test1
+
+                function test_touch() {
+                    var touch = touchEvent(area);
+                    touch.press(0, area, 10, 10);
+                    touch.commit();
+                    verify(area.touched);
+                }
+            }
+        }
+        \endcode
+
+        \sa TouchEventSequence::press(), TouchEventSequence::move(), TouchEventSequence::release(), TouchEventSequence::stationary(), TouchEventSequence::commit(), QTouchDevice::TouchScreen
+    */
+
+    function touchEvent(item) {
+        if (!item)
+            qtest_fail("No item given to touchEvent", 1)
+
+        return {
+            _defaultItem: item,
+            _sequence: qtest_events.touchEvent(item),
+
+            press: function (id, target, x, y) {
+                if (!target)
+                    target = this._defaultItem;
+                if (id === undefined)
+                    qtest_fail("No id given to TouchEventSequence::press", 1);
+                if (x === undefined)
+                    x = target.width / 2;
+                if (y === undefined)
+                    y = target.height / 2;
+                this._sequence.press(id, target, x, y);
+                return this;
+            },
+
+            move: function (id, target, x, y) {
+                if (!target)
+                    target = this._defaultItem;
+                if (id === undefined)
+                    qtest_fail("No id given to TouchEventSequence::move", 1);
+                if (x === undefined)
+                    x = target.width / 2;
+                if (y === undefined)
+                    y = target.height / 2;
+                this._sequence.move(id, target, x, y);
+                return this;
+            },
+
+            stationary: function (id) {
+                if (id === undefined)
+                    qtest_fail("No id given to TouchEventSequence::stationary", 1);
+                this._sequence.stationary(id);
+                return this;
+            },
+
+            release: function (id, target, x, y) {
+                if (!target)
+                    target = this._defaultItem;
+                if (id === undefined)
+                    qtest_fail("No id given to TouchEventSequence::release", 1);
+                if (x === undefined)
+                    x = target.width / 2;
+                if (y === undefined)
+                    y = target.height / 2;
+                this._sequence.release(id, target, x, y);
+                return this;
+            },
+
+            commit: function () {
+                 this._sequence.commit();
+                 return this;
+            }
+        };
+    }
 
     // Functions that can be overridden in subclasses for init/cleanup duties.
     /*!
diff --git a/src/imports/testlib/main.cpp b/src/imports/testlib/main.cpp
index 4e2bd919e9..3c28000e35 100644
--- a/src/imports/testlib/main.cpp
+++ b/src/imports/testlib/main.cpp
@@ -158,6 +158,7 @@ public:
         qmlRegisterType<QuickTestResult, 1>(uri,1,1,"TestResult");
         qmlRegisterType<QuickTestEvent>(uri,1,0,"TestEvent");
         qmlRegisterType<QuickTestUtil>(uri,1,0,"TestUtil");
+        qmlRegisterType<QQuickTouchEventSequence>();
     }
 };
 
diff --git a/src/imports/testlib/toucheventsequence.qdoc b/src/imports/testlib/toucheventsequence.qdoc
new file mode 100644
index 0000000000..f85a1cd4f9
--- /dev/null
+++ b/src/imports/testlib/toucheventsequence.qdoc
@@ -0,0 +1,110 @@
+/****************************************************************************
+**
+** Copyright (C) 2016 Jeremy Katz
+** Contact: http://www.qt.io/licensing/
+**
+** This file is part of the documentation of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:FDL$
+** 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 Free Documentation License Usage
+** Alternatively, this file may be used under the terms of the GNU Free
+** Documentation License version 1.3 as published by the Free Software
+** Foundation and appearing in the file included in the packaging of
+** this file. Please review the following information to ensure
+** the GNU Free Documentation License version 1.3 requirements
+** will be met: http://www.gnu.org/copyleft/fdl.html.
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*!
+    \qmltype TouchEventSequence
+    \inqmlmodule QtTest
+    \ingroup qtquicktest
+    \brief TouchEventSequence is used to build and dispatch touch events
+    for testing.
+
+    \since 5.9
+
+    A TouchEventSequence is created by calling \l [QML] {TestCase::touchEvent()}{TestCase.touchEvent()}.
+    The type can not be directly instantiated. Each method provided by the type returns
+    the same object, allowing chained calls.
+
+    For example:
+    \code
+        touchEvent(item).press(0).commit();
+    \endcode
+    is equivalent to:
+    \code
+        var sequence = touchEvent(item);
+        sequence.press(0);
+        sequence.commit();
+    \endcode
+
+    Events are delivered to the window which contains the item specified in touchEvent.
+
+    \sa TestCase::touchEvent(), QTest::QTouchEventSequence
+*/
+
+/*!
+    \qmlmethod TouchEventSequence TouchEventSequence::press(int touchId, object item, real x = item.width / 2, real y = item.height / 2)
+
+    Creates a new point identified as \a touchId, at the point indicated by \a x and \a y relative to \a item.
+    Further use of the same touch point should maintain the same touchId.
+
+    Item defaults to the value provided via touchEvent().
+    X and y default to the midpoint of the item.
+*/
+
+/*!
+    \qmlmethod TouchEventSequence TouchEventSequence::move(int touchId, object item, real x = item.width / 2, real y = item.height / 2)
+
+    Moves \a touchId to the point indicated by \a x and \a y relative to \a item.
+
+    Item defaults to the value provided via touchEvent().
+    X and y default to the midpoint of the item.
+*/
+
+/*!
+    \qmlmethod TouchEventSequence TouchEventSequence::release(int touchId, object item, real x = item.width / 2, real y = item.height / 2)
+
+    Removes \a touchId at the point indicated by \a x and \a y relative to \a item.
+
+    Item defaults to the value provided via touchEvent().
+    X and y default to the midpoint of the item.
+*/
+
+/*!
+    \qmlmethod TouchEventSequence TouchEventSequence::stationary(int touchId)
+
+    Indicates that \a touchId is present but otherwise unchanged from prior events.
+*/
+
+/*!
+    \qmlmethod TouchEventSequence TouchEventSequence::commit()
+
+    Sends the touch event composed by prior use of press(), move(), release(), and stationary().
+    Following commit's return, the TouchEventSequence can be used to compose a new event.
+
+    \code
+        var sequence = touchEvent(target);
+        // Touch the middle of target with 1 point
+        sequence.press(1);
+        sequence.commit();
+
+        // Begin a new event
+        // Move the point to target's upper left corner
+        sequence.move(1, target, 0, 0);
+        sequence.commit();
+    \endcode
+
+    Commit is automatically invoked when the TouchEventSequence object is destroyed.
+*/