qwindowstabletsupport.cpp

Go to the documentation of this file.

// Copyright (C) 2020 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only
 
#include "qwindowstabletsupport.h"
 
#include "qwindowscontext.h"
#include "qwindowskeymapper.h"
#include "qwindowswindow.h"
#include "qwindowsscreen.h"
 
#include <qpa/qwindowsysteminterface.h>
 
#include <QtGui/qevent.h>
#include <QtGui/qscreen.h>
#include <QtGui/qguiapplication.h>
#include <QtGui/qwindow.h>
#include <QtCore/qdebug.h>
#include <QtCore/qvarlengtharray.h>
#include <QtCore/qmath.h>
 
#include <private/qguiapplication_p.h>
#include <QtCore/private/qsystemlibrary_p.h>
 
// Note: The definition of the PACKET structure in pktdef.h depends on this define.
#define PACKETDATA (PK_X | PK_Y | PK_BUTTONS | PK_NORMAL_PRESSURE | PK_TANGENT_PRESSURE | PK_ORIENTATION | PK_CURSOR | PK_Z | PK_TIME)
#include <pktdef.h>
 
QT_BEGIN_NAMESPACE
 
enum {
    PacketMode = 0,
    TabletPacketQSize = 128,
    DeviceIdMask = 0xFF6, // device type mask && device color mask
    CursorTypeBitMask = 0x0F06 // bitmask to find the specific cursor type (see Wacom FAQ)
};
 
LRESULT QT_WIN_CALLBACK qWindowsTabletSupportWndProc(HWND hwnd, UINT message, WPARAM wParam, LPARAM lParam)
{
    switch (message) {
    case WT_PROXIMITY:
        if (QWindowsContext::instance()->tabletSupport()->translateTabletProximityEvent(wParam, lParam))
            return 0;
        break;
    case WT_PACKET:
        if (QWindowsContext::instance()->tabletSupport()->translateTabletPacketEvent())
            return 0;
        break;
    }
    return DefWindowProc(hwnd, message, wParam, lParam);
}
 
 
// Scale tablet coordinates to screen coordinates.
 
static inline int sign(int x)
{
    return x >= 0 ? 1 : -1;
}
 
inline QPointF QWindowsTabletDeviceData::scaleCoordinates(int coordX, int coordY, const QRect &targetArea) const
{
    const int targetX = targetArea.x();
    const int targetY = targetArea.y();
    const int targetWidth = targetArea.width();
    const int targetHeight = targetArea.height();
 
    const qreal x = sign(targetWidth) == sign(maxX) ?
        ((coordX - minX) * qAbs(targetWidth) / qAbs(qreal(maxX - minX))) + targetX :
        ((qAbs(maxX) - (coordX - minX)) * qAbs(targetWidth) / qAbs(qreal(maxX - minX))) + targetX;
 
    const qreal y = sign(targetHeight) == sign(maxY) ?
        ((coordY - minY) * qAbs(targetHeight) / qAbs(qreal(maxY - minY))) + targetY :
        ((qAbs(maxY) - (coordY - minY)) * qAbs(targetHeight) / qAbs(qreal(maxY - minY))) + targetY;
 
    return {x, y};
}
 
template <class Stream>
static void formatOptions(Stream &str, unsigned options)
{
    if (options & CXO_SYSTEM)
        str << " CXO_SYSTEM";
    if (options & CXO_PEN)
        str << " CXO_PEN";
    if (options & CXO_MESSAGES)
        str << " CXO_MESSAGES";
    if (options & CXO_MARGIN)
        str << " CXO_MARGIN";
    if (options & CXO_MGNINSIDE)
        str << " CXO_MGNINSIDE";
    if (options & CXO_CSRMESSAGES)
        str << " CXO_CSRMESSAGES";
}
 
#ifndef QT_NO_DEBUG_STREAM
QDebug operator<<(QDebug d, const QWindowsTabletDeviceData &t)
{
    QDebugStateSaver saver(d);
    d.nospace();
    d << "TabletDevice id:" << t.systemId << " pressure: " << t.minPressure
      << ".." << t.maxPressure << " tan pressure: " << t.minTanPressure << ".."
      << t.maxTanPressure << " area: (" << t.minX << ',' << t.minY << ',' << t.minZ
      << ")..(" << t.maxX << ',' << t.maxY << ',' << t.maxZ << ')';
    return d;
}
 
QDebug operator<<(QDebug d, const LOGCONTEXT &lc)
{
    QDebugStateSaver saver(d);
    d.nospace();
    d << "LOGCONTEXT(\"" << QString::fromWCharArray(lc.lcName) << "\", options=0x"
        << Qt::hex << lc.lcOptions << Qt::dec;
    formatOptions(d, lc.lcOptions);
    d << ", status=0x" << Qt::hex << lc.lcStatus << ", device=0x" << lc.lcDevice
        << Qt::dec << ", PktRate=" << lc.lcPktRate
        << ", PktData=" << lc.lcPktData << ", PktMode=" << lc.lcPktMode
        << ", MoveMask=0x" << Qt::hex << lc.lcMoveMask << ", BtnDnMask=0x" << lc.lcBtnDnMask
        << ", BtnUpMask=0x" << lc.lcBtnUpMask << Qt::dec << ", SysMode=" << lc.lcSysMode
        << ", InOrg=(" << lc.lcInOrgX << ", " << lc.lcInOrgY << ", " << lc.lcInOrgZ
        <<  "), InExt=(" << lc.lcInExtX << ", " << lc.lcInExtY << ", " << lc.lcInExtZ
        << ") OutOrg=(" << lc.lcOutOrgX << ", " << lc.lcOutOrgY << ", "
        << lc.lcOutOrgZ <<  "), OutExt=(" << lc.lcOutExtX << ", " << lc.lcOutExtY
        << ", " << lc.lcOutExtZ
        << "), Sens=(" << lc.lcSensX << ", " << lc.lcSensX << ", " << lc.lcSensZ
        << ") SysOrg=(" << lc.lcSysOrgX << ", " << lc.lcSysOrgY
        << "), SysExt=(" << lc.lcSysExtX << ", " << lc.lcSysExtY
        << "), SysSens=(" << lc.lcSysSensX << ", " << lc.lcSysSensY << "))";
    return d;
}
#endif // !QT_NO_DEBUG_STREAM
 
QWinTabPointingDevice *createInputDevice(const QSharedPointer<QWindowsTabletDeviceData> &d,
                                         QInputDevice::DeviceType devType,
                                         QPointingDevice::PointerType pointerType)
{
    const qint64 uniqueId = d->systemId | (qint64(devType) << 32)
                            | (qint64(pointerType) << 48L);
    QInputDevice::Capabilities caps(QInputDevice::Capability::Position
                                    | QInputDevice::Capability::Pressure
                                    | QInputDevice::Capability::MouseEmulation
                                    | QInputDevice::Capability::Hover);
    if (d->zCapability)
        caps |= QInputDevice::Capability::ZPosition;
    if (d->tiltCapability) {
        caps |= QInputDevice::Capability::XTilt
                | QInputDevice::Capability::YTilt
                | QInputDevice::Capability::Rotation
                | QInputDevice::Capability::TangentialPressure;
    }
 
    auto result = new QWinTabPointingDevice(d, QStringLiteral("wintab"), d->systemId,
                                            devType, pointerType, caps, 1,
                                            d->buttonsMap.size(), QString(),
                                            QPointingDeviceUniqueId::fromNumericId(uniqueId));
    QWindowSystemInterface::registerInputDevice(result);
    return result;
}
 
QWinTabPointingDevice::QWinTabPointingDevice(const QWinTabPointingDevice::DeviceDataPtr &data,
                                             const QString &name, qint64 systemId,
                                             QInputDevice::DeviceType devType,
                                             QPointingDevice::PointerType pType,
                                             QInputDevice::Capabilities caps,
                                             int maxPoints, int buttonCount,
                                             const QString &seatName,
                                             QPointingDeviceUniqueId uniqueId,
                                             QObject *parent)
    : QPointingDevice(name, systemId, devType, pType, caps, maxPoints, buttonCount,
                      seatName, uniqueId, parent),
      m_deviceData(data)
{
}
 
QWindowsWinTab32DLL QWindowsTabletSupport::m_winTab32DLL;
 
/*!
    \class QWindowsWinTab32DLL QWindowsTabletSupport
    \brief Functions from wintabl32.dll shipped with WACOM tablets used by QWindowsTabletSupport.
 
    \internal
*/
 
bool QWindowsWinTab32DLL::init()
{
    if (wTInfo)
        return true;
    QSystemLibrary library(QStringLiteral("wintab32"));
    if (!library.load())
        return false;
    wTOpen = (PtrWTOpen)library.resolve("WTOpenW");
    wTClose = (PtrWTClose)library.resolve("WTClose");
    wTInfo = (PtrWTInfo)library.resolve("WTInfoW");
    wTEnable = (PtrWTEnable)library.resolve("WTEnable");
    wTOverlap = (PtrWTEnable)library.resolve("WTOverlap");
    wTPacketsGet = (PtrWTPacketsGet)library.resolve("WTPacketsGet");
    wTGet = (PtrWTGet)library.resolve("WTGetW");
    wTQueueSizeGet = (PtrWTQueueSizeGet)library.resolve("WTQueueSizeGet");
    wTQueueSizeSet = (PtrWTQueueSizeSet)library.resolve("WTQueueSizeSet");
    return wTOpen && wTClose && wTInfo && wTEnable && wTOverlap && wTPacketsGet && wTQueueSizeGet && wTQueueSizeSet;
}
 
/*!
    \class QWindowsTabletSupport
    \brief Tablet support for Windows.
 
    Support for WACOM tablets.
 
    \sa http://www.wacomeng.com/windows/docs/Wintab_v140.htm
 
    \internal
    \since 5.2
*/
 
int QWindowsTabletSupport::m_absoluteRange = 20;
 
QWindowsTabletSupport::QWindowsTabletSupport(HWND window, HCTX context)
    : m_window(window)
    , m_context(context)
{
     AXIS orientation[3];
    // Some tablets don't support tilt, check if it is possible,
    if (QWindowsTabletSupport::m_winTab32DLL.wTInfo(WTI_DEVICES, DVC_ORIENTATION, &orientation))
        m_tiltSupport = orientation[0].axResolution && orientation[1].axResolution;
}
 
QWindowsTabletSupport::~QWindowsTabletSupport()
{
    QWindowsTabletSupport::m_winTab32DLL.wTClose(m_context);
    DestroyWindow(m_window);
}
 
QWindowsTabletSupport *QWindowsTabletSupport::create()
{
    if (!m_winTab32DLL.init())
        return nullptr;
    const HWND window = QWindowsContext::instance()->createDummyWindow(QStringLiteral("TabletDummyWindow"),
                                                                       L"TabletDummyWindow",
                                                                       qWindowsTabletSupportWndProc);
    if (!window) {
        qCWarning(lcQpaTablet) << __FUNCTION__ << "Unable to create window for tablet.";
        return nullptr;
    }
    LOGCONTEXT lcMine;
    // build our context from the default context
    QWindowsTabletSupport::m_winTab32DLL.wTInfo(WTI_DEFSYSCTX, 0, &lcMine);
    qCDebug(lcQpaTablet) << "Default: " << lcMine;
    // Go for the raw coordinates, the tablet event will return good stuff
    lcMine.lcOptions |= CXO_MESSAGES | CXO_CSRMESSAGES;
    lcMine.lcPktData = lcMine.lcMoveMask = PACKETDATA;
    lcMine.lcPktMode = PacketMode;
    lcMine.lcOutOrgX = 0;
    lcMine.lcOutExtX = lcMine.lcInExtX;
    lcMine.lcOutOrgY = 0;
    lcMine.lcOutExtY = -lcMine.lcInExtY;
    qCDebug(lcQpaTablet) << "Requesting: " << lcMine;
    const HCTX context = QWindowsTabletSupport::m_winTab32DLL.wTOpen(window, &lcMine, true);
    if (!context) {
        qCDebug(lcQpaTablet) << __FUNCTION__ << "Unable to open tablet.";
        DestroyWindow(window);
        return nullptr;
 
    }
    // Set the size of the Packet Queue to the correct size
    const int currentQueueSize = QWindowsTabletSupport::m_winTab32DLL.wTQueueSizeGet(context);
    if (currentQueueSize != TabletPacketQSize) {
        if (!QWindowsTabletSupport::m_winTab32DLL.wTQueueSizeSet(context, TabletPacketQSize)) {
            if (!QWindowsTabletSupport::m_winTab32DLL.wTQueueSizeSet(context, currentQueueSize))  {
                qWarning("Unable to set queue size on tablet. The tablet will not work.");
                QWindowsTabletSupport::m_winTab32DLL.wTClose(context);
                DestroyWindow(window);
                return nullptr;
            } // cannot restore old size
        } // cannot set
    } // mismatch
    qCDebug(lcQpaTablet) << "Opened tablet context " << context << " on window "
        <<  window << "changed packet queue size " << currentQueueSize
        << "->" <<  TabletPacketQSize << "\nobtained: " << lcMine;
    return new QWindowsTabletSupport(window, context);
}
 
unsigned QWindowsTabletSupport::options() const
{
    UINT result = 0;
    m_winTab32DLL.wTInfo(WTI_INTERFACE, IFC_CTXOPTIONS, &result);
    return result;
}
 
QString QWindowsTabletSupport::description() const
{
    const unsigned size = m_winTab32DLL.wTInfo(WTI_INTERFACE, IFC_WINTABID, nullptr);
    if (!size)
        return QString();
    QVarLengthArray<TCHAR> winTabId(size + 1);
    m_winTab32DLL.wTInfo(WTI_INTERFACE, IFC_WINTABID, winTabId.data());
    WORD implementationVersion = 0;
    m_winTab32DLL.wTInfo(WTI_INTERFACE, IFC_IMPLVERSION, &implementationVersion);
    WORD specificationVersion = 0;
    m_winTab32DLL.wTInfo(WTI_INTERFACE, IFC_SPECVERSION, &specificationVersion);
    const unsigned opts = options();
    WORD devices = 0;
    m_winTab32DLL.wTInfo(WTI_INTERFACE, IFC_NDEVICES, &devices);
    WORD cursors = 0;
    m_winTab32DLL.wTInfo(WTI_INTERFACE, IFC_NCURSORS, &cursors);
    WORD extensions = 0;
    m_winTab32DLL.wTInfo(WTI_INTERFACE, IFC_NEXTENSIONS, &extensions);
    QString result;
    QTextStream str(&result);
    str << '"' << QString::fromWCharArray(winTabId.data())
        << "\" specification: v" << (specificationVersion >> 8)
        << '.' << (specificationVersion & 0xFF) << " implementation: v"
        << (implementationVersion >> 8) << '.' << (implementationVersion & 0xFF)
        << ' ' << devices << " device(s), " << cursors << " cursor(s), "
        << extensions << " extensions" << ", options: 0x" << Qt::hex << opts << Qt::dec;
    formatOptions(str, opts);
    if (m_tiltSupport)
        str << " tilt";
    return result;
}
 
void QWindowsTabletSupport::notifyActivate()
{
    // Cooperate with other tablet applications, but when we get focus, I want to use the tablet.
    const bool result = QWindowsTabletSupport::m_winTab32DLL.wTEnable(m_context, true)
        && QWindowsTabletSupport::m_winTab32DLL.wTOverlap(m_context, true);
   qCDebug(lcQpaTablet) << __FUNCTION__ << result;
}
 
static inline QInputDevice::DeviceType deviceType(const UINT cursorType)
{
    if (((cursorType & 0x0006) == 0x0002) && ((cursorType & CursorTypeBitMask) != 0x0902))
        return QInputDevice::DeviceType::Stylus;
    if (cursorType == 0x4020) // Surface Pro 2 tablet device
        return QInputDevice::DeviceType::Stylus;
    switch (cursorType & CursorTypeBitMask) {
    case 0x0802:
        return QInputDevice::DeviceType::Stylus;
    case 0x0902:
        return QInputDevice::DeviceType::Airbrush;
    case 0x0004:
        return QInputDevice::DeviceType::Mouse;
    case 0x0006:
        return QInputDevice::DeviceType::Puck;
    case 0x0804:
        return QInputDevice::DeviceType::Stylus;
    default:
        break;
    }
    return QInputDevice::DeviceType::Unknown;
}
 
static inline QPointingDevice::PointerType pointerType(unsigned currentCursor)
{
    switch (currentCursor % 3) { // %3 for dual track
    case 0:
        return QPointingDevice::PointerType::Cursor;
    case 1:
        return QPointingDevice::PointerType::Pen;
    case 2:
        return QPointingDevice::PointerType::Eraser;
    default:
        break;
    }
    return QPointingDevice::PointerType::Unknown;
}
 
inline void QWindowsTabletSupport::enterProximity(ulong time, QWindow *window)
{
    enterLeaveProximity(true, time, window);
}
 
inline void QWindowsTabletSupport::leaveProximity(ulong time, QWindow *window)
{
    enterLeaveProximity(false, time, window);
}
 
void QWindowsTabletSupport::enterLeaveProximity(bool enter, ulong time, QWindow *window)
{
    Q_ASSERT(!m_currentDevice.isNull());
    if (time == 0) // Some leave events do not have a time associated
        ++m_eventTime;
    else
        m_eventTime = time;
    QWindowSystemInterface::handleTabletEnterLeaveProximityEvent(window, m_eventTime,
                                                                 m_currentDevice.data(),
                                                                 enter);
}
 
QWindowsTabletSupport::DevicePtr QWindowsTabletSupport::findDevice(qint64 systemId) const
{
    for (const auto &d : m_devices) {
        if (d->deviceData()->systemId == systemId)
            return d;
    }
    return {};
}
 
QWindowsTabletSupport::DevicePtr QWindowsTabletSupport::findDevice(qint64 systemId,
                                                                   QInputDevice::DeviceType deviceType,
                                                                   QPointingDevice::PointerType pointerType) const
{
    for (const auto &d : m_devices) {
        if (d->deviceData()->systemId == systemId && d->type() == deviceType
            && d->pointerType() == pointerType) {
            return d;
        }
    }
    return {};
}
 
// Clone a device for a new pointer type.
QWindowsTabletSupport::DevicePtr QWindowsTabletSupport::clonePhysicalDevice(qint64 systemId,
                                                                            QInputDevice::DeviceType deviceType,
                                                                            QPointingDevice::PointerType pointerType)
{
    auto similar = findDevice(systemId);
    if (similar.isNull())
        return {};
    DevicePtr result(createInputDevice(similar->deviceData(), deviceType, pointerType));
    m_devices.append(result);
    return result;
}
 
void QWindowsTabletSupport::updateData(QWindowsTabletDeviceData *data) const
{
    /* browse WinTab's many info items to discover pressure handling. */
    AXIS axis;
    LOGCONTEXT lc;
    /* get the current context for its device variable. */
    QWindowsTabletSupport::m_winTab32DLL.wTGet(m_context, &lc);
    /* get the size of the pressure axis. */
    QWindowsTabletSupport::m_winTab32DLL.wTInfo(WTI_DEVICES + lc.lcDevice, DVC_NPRESSURE, &axis);
    data->minPressure = int(axis.axMin);
    data->maxPressure = int(axis.axMax);
 
    QWindowsTabletSupport::m_winTab32DLL.wTInfo(WTI_DEVICES + lc.lcDevice, DVC_TPRESSURE, &axis);
    data->minTanPressure = int(axis.axMin);
    data->maxTanPressure = int(axis.axMax);
 
    LOGCONTEXT defaultLc;
    /* get default region */
    QWindowsTabletSupport::m_winTab32DLL.wTInfo(WTI_DEFCONTEXT, 0, &defaultLc);
    data->maxX = int(defaultLc.lcInExtX) - int(defaultLc.lcInOrgX);
    data->maxY = int(defaultLc.lcInExtY) - int(defaultLc.lcInOrgY);
    data->maxZ = int(defaultLc.lcInExtZ) - int(defaultLc.lcInOrgZ);
}
 
void QWindowsTabletSupport::updateButtons(unsigned currentCursor, QWindowsTabletDeviceData *data) const
{
    // We should check button map for changes on every proximity event, not
    // only during initialization phase.
    // WARNING: in 2016 there were some Wacom tablet drivers, which could mess up
    //          button mapping if the remapped button was pressed, while the
    //          application **didn't have input focus**. This bug is somehow
    //          related to the fact that Wacom drivers allow user to configure
    //          per-application button-mappings. If the bug shows up again,
    //          just move this button-map fetching into initialization block.
    //
    //          See https://bugs.kde.org/show_bug.cgi?id=359561
    BYTE logicalButtons[32];
    memset(logicalButtons, 0, 32);
    m_winTab32DLL.wTInfo(WTI_CURSORS + currentCursor, CSR_SYSBTNMAP, &logicalButtons);
    data->buttonsMap.clear();
    data->buttonsMap[0x1] = logicalButtons[0];
    data->buttonsMap[0x2] = logicalButtons[1];
    data->buttonsMap[0x4] = logicalButtons[2];
}
 
bool QWindowsTabletSupport::translateTabletProximityEvent(WPARAM /* wParam */, LPARAM lParam)
{
    PACKET proximityBuffer[1]; // we are only interested in the first packet in this case
    const int totalPacks = QWindowsTabletSupport::m_winTab32DLL.wTPacketsGet(m_context, 1, proximityBuffer);
 
    if (!LOWORD(lParam)) {
        if (m_currentDevice.isNull()) // QTBUG-65120, spurious leave observed
            return false;
        qCDebug(lcQpaTablet) << "leave proximity for device #" << m_currentDevice.data();
        m_state = PenUp;
        leaveProximity(totalPacks > 0 ? proximityBuffer[0].pkTime : 0u);
        return true;
    }
 
    if (!totalPacks)
        return false;
 
    const UINT currentCursor = proximityBuffer[0].pkCursor;
    UINT physicalCursorId;
    QWindowsTabletSupport::m_winTab32DLL.wTInfo(WTI_CURSORS + currentCursor, CSR_PHYSID, &physicalCursorId);
    const qint64 systemId = physicalCursorId;
    UINT cursorType;
    QWindowsTabletSupport::m_winTab32DLL.wTInfo(WTI_CURSORS + currentCursor, CSR_TYPE, &cursorType);
 
    const QInputDevice::DeviceType currentType = deviceType(cursorType);
    const QPointingDevice::PointerType currentPointerType = pointerType(currentCursor);
    // initializing and updating the cursor should be done in response to
    // WT_CSRCHANGE. We do it in WT_PROXIMITY because some wintab never send
    // the event WT_CSRCHANGE even if asked with CXO_CSRMESSAGES
    m_currentDevice = findDevice(systemId, currentType, currentPointerType);
    if (m_currentDevice.isNull())
        m_currentDevice = clonePhysicalDevice(systemId, currentType, currentPointerType);
    if (m_currentDevice.isNull()) {
        QWinTabPointingDevice::DeviceDataPtr data(new QWindowsTabletDeviceData);
        data->systemId = systemId;
        data->tiltCapability = m_tiltSupport;
        data->zCapability = (cursorType == 0x0004);
        updateButtons(currentCursor, data.data());
        m_currentDevice.reset(createInputDevice(data, currentType, currentPointerType));
        m_devices.append(m_currentDevice);
    }
 
    // The user can switch pressure sensitivity level in the driver,which
    // will make our saved values invalid (this option is provided by Wacom
    // drivers for compatibility reasons, and it can be adjusted on the fly)
    updateData(m_currentDevice->deviceData().data());
 
    m_state = PenProximity;
    qCDebug(lcQpaTablet) << "enter proximity for device #"
        << m_currentDevice.data();
    enterProximity(proximityBuffer[0].pkTime);
    return true;
}
 
Qt::MouseButton buttonValueToEnum(DWORD button,
                                  const QWindowsTabletDeviceData &tdd) {
 
    enum : unsigned {
        leftButtonValue = 0x1,
        middleButtonValue = 0x2,
        rightButtonValue = 0x4,
        doubleClickButtonValue = 0x7
    };
 
    button = tdd.buttonsMap.value(button);
 
    return button == leftButtonValue ? Qt::LeftButton :
        button == rightButtonValue ? Qt::RightButton :
        button == doubleClickButtonValue ? Qt::MiddleButton :
        button == middleButtonValue ? Qt::MiddleButton :
        button ? Qt::LeftButton /* fallback item */ :
        Qt::NoButton;
}
 
Qt::MouseButtons convertTabletButtons(DWORD btnNew,
                                      const QWindowsTabletDeviceData &tdd) {
 
    Qt::MouseButtons buttons = Qt::NoButton;
    for (unsigned int i = 0; i < 3; i++) {
        unsigned int btn = 0x1 << i;
 
        if (btn & btnNew) {
            Qt::MouseButton convertedButton =
                buttonValueToEnum(btn, tdd);
 
            buttons |= convertedButton;
 
            /**
             * If a button that is present in hardware input is
             * mapped to a Qt::NoButton, it means that it is going
             * to be eaten by the driver, for example by its
             * "Pan/Scroll" feature. Therefore we shouldn't handle
             * any of the events associated to it. We'll just return
             * Qt::NoButtons here.
             */
        }
    }
    return buttons;
}
 
bool QWindowsTabletSupport::translateTabletPacketEvent()
{
    static PACKET localPacketBuf[TabletPacketQSize];  // our own tablet packet queue.
    const int packetCount = QWindowsTabletSupport::m_winTab32DLL.wTPacketsGet(m_context, TabletPacketQSize, &localPacketBuf);
    if (!packetCount || m_currentDevice.isNull())
        return false;
 
    const QWindowsTabletDeviceData &current = *m_currentDevice->deviceData();
 
    // The tablet can be used in 2 different modes (reflected in enum Mode),
    // depending on its settings:
    // 1) Absolute (pen) mode:
    //    The coordinates are scaled to the virtual desktop (by default). The user
    //    can also choose to scale to the monitor or a region of the screen.
    //    When entering proximity, the tablet driver snaps the mouse pointer to the
    //    tablet position scaled to that area and keeps it in sync.
    // 2) Relative (mouse) mode:
    //    The pen follows the mouse. The constant 'absoluteRange' specifies the
    //    manhattanLength difference for detecting if a tablet input device is in this mode,
    //    in which case we snap the position to the mouse position.
    // It seems there is no way to find out the mode programmatically, the LOGCONTEXT orgX/Y/Ext
    // area is always the virtual desktop.
    const QRect virtualDesktopArea =
        QWindowsScreen::virtualGeometry(QGuiApplication::primaryScreen()->handle());
 
    if (QWindowsContext::verbose > 1)  {
        qCDebug(lcQpaTablet) << __FUNCTION__ << "processing" << packetCount
            << "mode=" << m_mode;
    }
 
    const auto *keyMapper = QWindowsContext::instance()->keyMapper();
    const Qt::KeyboardModifiers keyboardModifiers = keyMapper->queryKeyboardModifiers();
 
    for (int i = 0; i < packetCount ; ++i) {
        const PACKET &packet = localPacketBuf[i];
 
        const int z = current.zCapability ? int(packet.pkZ) : 0;
 
        const auto packetPointerType = pointerType(packet.pkCursor);
 
        const Qt::MouseButtons buttons =
            convertTabletButtons(packet.pkButtons, current);
 
        if (buttons == Qt::NoButton && packetPointerType != m_currentDevice->pointerType()) {
            leaveProximity(packet.pkTime);
            Q_ASSERT(!m_currentDevice.isNull());
            // Pointer type changed, find or clone a new device for this physical cursor.
            const qint64 systemId = m_currentDevice->systemId();
            const QInputDevice::DeviceType type = m_currentDevice->type();
            m_currentDevice = findDevice(systemId, type, packetPointerType);
            if (m_currentDevice.isNull())
                m_currentDevice = clonePhysicalDevice(systemId, type, packetPointerType);
            Q_ASSERT(!m_currentDevice.isNull());
            enterProximity(packet.pkTime);
        }
 
        QPointF globalPosF =
            current.scaleCoordinates(packet.pkX, packet.pkY, virtualDesktopArea);
 
        // Pass to window that grabbed it.
        QWindow *target = QGuiApplicationPrivate::tabletDevicePoint(m_currentDevice->uniqueId().numericId()).target;
 
        // Get Mouse Position and compare to tablet info
        const QPoint mouseLocation = QWindowsCursor::mousePosition();
        if (m_state == PenProximity) {
            m_state = PenDown;
            m_mode = (mouseLocation - globalPosF).manhattanLength() > m_absoluteRange
                ? MouseMode : PenMode;
            qCDebug(lcQpaTablet) << __FUNCTION__ << "mode=" << m_mode << "pen:"
                << globalPosF << "mouse:" << mouseLocation;
        }
        if (m_mode == MouseMode)
            globalPosF = mouseLocation;
        const QPoint globalPos = globalPosF.toPoint();
 
        if (!target)
            target = QWindowsScreen::windowAt(globalPos, CWP_SKIPINVISIBLE | CWP_SKIPTRANSPARENT);
        if (!target)
            continue;
 
        const QPlatformWindow *platformWindow = target->handle();
        Q_ASSERT(platformWindow);
        const QPoint localPos = platformWindow->mapFromGlobal(globalPos);
 
        const qreal pressureNew = packet.pkButtons
            && (m_currentDevice->pointerType() == QPointingDevice::PointerType::Pen
                || m_currentDevice->pointerType() == QPointingDevice::PointerType::Eraser)
            ? current.scalePressure(packet.pkNormalPressure) : qreal(0);
        const qreal tangentialPressure = m_currentDevice->type() == QInputDevice::DeviceType::Airbrush
            ? current.scaleTangentialPressure(packet.pkTangentPressure) : qreal(0);
 
        qreal tiltX = 0;
        qreal tiltY = 0;
        qreal rotation = 0;
        if (m_tiltSupport) {
            // Convert from azimuth and altitude to x tilt and y tilt. What
            // follows is the optimized version. Here are the equations used:
            // X = sin(azimuth) * cos(altitude)
            // Y = cos(azimuth) * cos(altitude)
            // Z = sin(altitude)
            // X Tilt = arctan(X / Z)
            // Y Tilt = arctan(Y / Z)
            const double radAzim = qDegreesToRadians(packet.pkOrientation.orAzimuth / 10.0);
            const double tanAlt = std::tan(qDegreesToRadians(std::abs(packet.pkOrientation.orAltitude / 10.0)));
 
            const double radX = std::atan(std::sin(radAzim) / tanAlt);
            const double radY = std::atan(std::cos(radAzim) / tanAlt);
            tiltX = qRadiansToDegrees(radX);
            tiltY = qRadiansToDegrees(-radY);
            rotation = 360.0 - (packet.pkOrientation.orTwist / 10.0);
            if (rotation > 180.0)
                rotation -= 360.0;
        }
 
        if (QWindowsContext::verbose > 1)  {
            qCDebug(lcQpaTablet)
                << "Packet #" << i << '/' << packetCount << "button:" << packet.pkButtons
                << globalPosF << z << "to:" << target << localPos << "(packet" << packet.pkX
                << packet.pkY << ") dev:" << m_currentDevice->type() << "pointer:"
                << m_currentDevice->pointerType() << "P:" << pressureNew << "tilt:" << tiltX << ','
                << tiltY << "tanP:" << tangentialPressure << "rotation:" << rotation
                << " target=" << target;
        }
 
        m_eventTime = packet.pkTime;
        QWindowSystemInterface::handleTabletEvent(target, packet.pkTime,
                                                  m_currentDevice.data(),
                                                  QPointF(localPos), globalPosF,
                                                  buttons, pressureNew, tiltX, tiltY,
                                                  tangentialPressure, rotation, z,
                                                  keyboardModifiers);
    }
    return true;
}
 
QT_END_NAMESPACE