Introduce QInputDevice hierarchy; replace QTouchDevice

We have seen during the Qt 5 series that QMouseEvent::source() does
not provide enough information: if it is synthesized, it could have
come from any device for which mouse events are synthesized, not only
from a touchscreen. By providing in every QInputEvent as complete
information about the actual source device as possible, we will enable
very fine-tuned behavior in the object that handles each event.

Further, we would like to support multiple keyboards, pointing devices,
and named groups of devices that are known as "seats" in Wayland.

In Qt 5, QPA plugins registered each touchscreen as it was discovered.
Now we extend this pattern to all input devices.  This new requirement
can be implemented gradually; for now, if a QTWSI input event is
received wtihout a device pointer, a default "core" device will be
created on-the-fly, and a warning emitted.

In Qt 5, QTouchEvent::TouchPoint::id() was forced to be unique even when
multiple devices were in use simultaneously. Now that each event
identifies the device it came from, this hack is no longer needed.

A stub of the new QPointerEvent is added; it will be developed further
in subsequent patches.

[ChangeLog][QtGui][QInputEvent] Every QInputEvent now carries a pointer
to an instance of QInputDevice, or the subclass QPointingDevice in case
of mouse, touch and tablet events. Each platform plugin is expected to
create the device instances, register them, and provide valid pointers
with all input events. If this is not done, warnings are emitted and
default devices are created as necessary. When the device has accurate
information, it provides the opportunity to fine-tune behavior depending
on device type and capabilities: for example if a QMouseEvent is
synthesized from a touchscreen, the recipient can see which touchscreen
it came from. Each device also has a seatName to distinguish users on
multi-user windowing systems. Touchpoint IDs are no longer unique on
their own, but the combination of ID and device is.

Fixes: QTBUG-46412
Fixes: QTBUG-72167
Task-number: QTBUG-69433
Task-number: QTBUG-52430
Change-Id: I933fb2b86182efa722037b7a33e404c5daf5292a
Reviewed-by: Shawn Rutledge <shawn.rutledge@qt.io>

1 files changed, 30 insertions, 27 deletions

diff --git a/src/plugins/platforms/windows/qwindowstabletsupport.cpp b/src/plugins/platforms/windows/qwindowstabletsupport.cpp
index 287ba931d9..f2c82f3247 100644
--- a/src/plugins/platforms/windows/qwindowstabletsupport.cpp
+++ b/src/plugins/platforms/windows/qwindowstabletsupport.cpp
@@ -1,6 +1,6 @@
 /****************************************************************************
 **
-** Copyright (C) 2016 The Qt Company Ltd.
+** Copyright (C) 2020 The Qt Company Ltd.
 ** Contact: https://www.qt.io/licensing/
 **
 ** This file is part of the plugins of the Qt Toolkit.
@@ -326,42 +326,42 @@ static inline int indexOfDevice(const QVector<QWindowsTabletDeviceData> &devices
     return -1;
 }
 
-static inline QTabletEvent::TabletDevice deviceType(const UINT cursorType)
+static inline QInputDevice::DeviceType deviceType(const UINT cursorType)
 {
     if (((cursorType & 0x0006) == 0x0002) && ((cursorType & CursorTypeBitMask) != 0x0902))
-        return QTabletEvent::Stylus;
+        return QInputDevice::DeviceType::Stylus;
     if (cursorType == 0x4020) // Surface Pro 2 tablet device
-        return QTabletEvent::Stylus;
+        return QInputDevice::DeviceType::Stylus;
     switch (cursorType & CursorTypeBitMask) {
     case 0x0802:
-        return QTabletEvent::Stylus;
+        return QInputDevice::DeviceType::Stylus;
     case 0x0902:
-        return QTabletEvent::Airbrush;
+        return QInputDevice::DeviceType::Airbrush;
     case 0x0004:
-        return QTabletEvent::FourDMouse;
+        return QInputDevice::DeviceType::Mouse;
     case 0x0006:
-        return QTabletEvent::Puck;
+        return QInputDevice::DeviceType::Puck;
     case 0x0804:
-        return QTabletEvent::RotationStylus;
+        return QInputDevice::DeviceType::Stylus;
     default:
         break;
     }
-    return QTabletEvent::NoDevice;
+    return QInputDevice::DeviceType::Unknown;
 }
 
-static inline QTabletEvent::PointerType pointerType(unsigned currentCursor)
+static inline QPointingDevice::PointerType pointerType(unsigned currentCursor)
 {
     switch (currentCursor % 3) { // %3 for dual track
     case 0:
-        return QTabletEvent::Cursor;
+        return QPointingDevice::PointerType::Cursor;
     case 1:
-        return QTabletEvent::Pen;
+        return QPointingDevice::PointerType::Pen;
     case 2:
-        return QTabletEvent::Eraser;
+        return QPointingDevice::PointerType::Eraser;
     default:
         break;
     }
-    return QTabletEvent::UnknownPointer;
+    return QPointingDevice::PointerType::Unknown;
 }
 
 QWindowsTabletDeviceData QWindowsTabletSupport::tabletInit(qint64 uniqueId, UINT cursorType) const
@@ -389,6 +389,7 @@ QWindowsTabletDeviceData QWindowsTabletSupport::tabletInit(qint64 uniqueId, UINT
     result.maxY = int(defaultLc.lcInExtY) - int(defaultLc.lcInOrgY);
     result.maxZ = int(defaultLc.lcInExtZ) - int(defaultLc.lcInOrgZ);
     result.currentDevice = deviceType(cursorType);
+    result.zCapability = (cursorType == 0x0004);
     return result;
 }
 
@@ -404,12 +405,12 @@ bool QWindowsTabletSupport::translateTabletProximityEvent(WPARAM /* wParam */, L
         m_state = PenUp;
         if (totalPacks > 0) {
             QWindowSystemInterface::handleTabletLeaveProximityEvent(proximityBuffer[0].pkTime,
-                                                                    m_devices.at(m_currentDevice).currentDevice,
-                                                                    m_devices.at(m_currentDevice).currentPointerType,
+                                                                    int(m_devices.at(m_currentDevice).currentDevice),
+                                                                    int(m_devices.at(m_currentDevice).currentPointerType),
                                                                     m_devices.at(m_currentDevice).uniqueId);
         } else {
-            QWindowSystemInterface::handleTabletLeaveProximityEvent(m_devices.at(m_currentDevice).currentDevice,
-                                                                    m_devices.at(m_currentDevice).currentPointerType,
+            QWindowSystemInterface::handleTabletLeaveProximityEvent(int(m_devices.at(m_currentDevice).currentDevice),
+                                                                    int(m_devices.at(m_currentDevice).currentPointerType),
                                                                     m_devices.at(m_currentDevice).uniqueId);
 
         }
@@ -458,9 +459,11 @@ bool QWindowsTabletSupport::translateTabletProximityEvent(WPARAM /* wParam */, L
     m_state = PenProximity;
     qCDebug(lcQpaTablet) << "enter proximity for device #"
         << m_currentDevice << m_devices.at(m_currentDevice);
+    // TODO use the version taking a QPointingDevice, and own those instances; replace QWindowsTabletDeviceData
+    // TODO QWindowSystemInterface::registerInputDevice() as early as possible, and before sending any events from it
     QWindowSystemInterface::handleTabletEnterProximityEvent(proximityBuffer[0].pkTime,
-                                                            m_devices.at(m_currentDevice).currentDevice,
-                                                            m_devices.at(m_currentDevice).currentPointerType,
+                                                            int(m_devices.at(m_currentDevice).currentDevice),
+                                                            int(m_devices.at(m_currentDevice).currentPointerType),
                                                             m_devices.at(m_currentDevice).uniqueId);
     return true;
 }
@@ -518,8 +521,8 @@ bool QWindowsTabletSupport::translateTabletPacketEvent()
     if (!packetCount || m_currentDevice < 0)
         return false;
 
-    const int currentDevice = m_devices.at(m_currentDevice).currentDevice;
-    const int currentPointer = m_devices.at(m_currentDevice).currentPointerType;
+    const auto currentDevice = m_devices.at(m_currentDevice).currentDevice;
+    const auto currentPointer = m_devices.at(m_currentDevice).currentPointerType;
     const qint64 uniqueId = m_devices.at(m_currentDevice).uniqueId;
 
     // The tablet can be used in 2 different modes (reflected in enum Mode),
@@ -549,7 +552,7 @@ bool QWindowsTabletSupport::translateTabletPacketEvent()
     for (int i = 0; i < packetCount ; ++i) {
         const PACKET &packet = localPacketBuf[i];
 
-        const int z = currentDevice == QTabletEvent::FourDMouse ? int(packet.pkZ) : 0;
+        const int z = m_devices.at(m_currentDevice).zCapability ? int(packet.pkZ) : 0;
 
         QPointF globalPosF =
             m_devices.at(m_currentDevice).scaleCoordinates(packet.pkX, packet.pkY, virtualDesktopArea);
@@ -578,10 +581,10 @@ bool QWindowsTabletSupport::translateTabletPacketEvent()
         Q_ASSERT(platformWindow);
         const QPoint localPos = platformWindow->mapFromGlobal(globalPos);
 
-        const qreal pressureNew = packet.pkButtons && (currentPointer == QTabletEvent::Pen || currentPointer == QTabletEvent::Eraser) ?
+        const qreal pressureNew = packet.pkButtons && (currentPointer == QPointingDevice::PointerType::Pen || currentPointer == QPointingDevice::PointerType::Eraser) ?
             m_devices.at(m_currentDevice).scalePressure(packet.pkNormalPressure) :
             qreal(0);
-        const qreal tangentialPressure = currentDevice == QTabletEvent::Airbrush ?
+        const qreal tangentialPressure = currentDevice == QInputDevice::DeviceType::Airbrush ?
             m_devices.at(m_currentDevice).scaleTangentialPressure(packet.pkTangentPressure) :
             qreal(0);
 
@@ -621,7 +624,7 @@ bool QWindowsTabletSupport::translateTabletPacketEvent()
             convertTabletButtons(packet.pkButtons, m_devices.at(m_currentDevice));
 
         QWindowSystemInterface::handleTabletEvent(target, packet.pkTime, QPointF(localPos), globalPosF,
-                                                  currentDevice, currentPointer,
+                                                  int(currentDevice), int(currentPointer),
                                                   buttons,
                                                   pressureNew, tiltX, tiltY,
                                                   tangentialPressure, rotation, z,