kwin/autotests/integration/xwayland_input_test.cpp
Vlad Zahorodnii 1fb9f6f13a Switch to SPDX license markers
The main advantage of SPDX license identifiers over the traditional
license headers is that it's more difficult to overlook inappropriate
licenses for kwin, for example GPL 3. We also don't have to copy a
lot of boilerplate text.

In order to create this change, I ran licensedigger -r -c from the
toplevel source directory.
2020-08-07 19:57:56 +00:00

302 lines
12 KiB
C++

/********************************************************************
KWin - the KDE window manager
This file is part of the KDE project.
SPDX-FileCopyrightText: 2016 Martin Gräßlin <mgraesslin@kde.org>
SPDX-License-Identifier: GPL-2.0-or-later
*********************************************************************/
#include "kwin_wayland_test.h"
#include "platform.h"
#include "x11client.h"
#include "cursor.h"
#include "deleted.h"
#include "screenedge.h"
#include "screens.h"
#include "wayland_server.h"
#include "workspace.h"
#include <KWaylandServer/seat_interface.h>
#include <QSocketNotifier>
#include <netwm.h>
#include <xcb/xcb_icccm.h>
namespace KWin
{
static const QString s_socketName = QStringLiteral("wayland_test_kwin_xwayland_input-0");
class XWaylandInputTest : public QObject
{
Q_OBJECT
private Q_SLOTS:
void initTestCase();
void init();
void testPointerEnterLeaveSsd();
void testPointerEventLeaveCsd();
};
void XWaylandInputTest::initTestCase()
{
qRegisterMetaType<KWin::AbstractClient*>();
qRegisterMetaType<KWin::Deleted*>();
QSignalSpy applicationStartedSpy(kwinApp(), &Application::started);
QVERIFY(applicationStartedSpy.isValid());
kwinApp()->platform()->setInitialWindowSize(QSize(1280, 1024));
QVERIFY(waylandServer()->init(s_socketName.toLocal8Bit()));
QMetaObject::invokeMethod(kwinApp()->platform(), "setVirtualOutputs", Qt::DirectConnection, Q_ARG(int, 2));
kwinApp()->start();
QVERIFY(applicationStartedSpy.wait());
QCOMPARE(screens()->count(), 2);
QCOMPARE(screens()->geometry(0), QRect(0, 0, 1280, 1024));
QCOMPARE(screens()->geometry(1), QRect(1280, 0, 1280, 1024));
setenv("QT_QPA_PLATFORM", "wayland", true);
waylandServer()->initWorkspace();
}
void XWaylandInputTest::init()
{
screens()->setCurrent(0);
Cursors::self()->mouse()->setPos(QPoint(640, 512));
xcb_warp_pointer(connection(), XCB_WINDOW_NONE, kwinApp()->x11RootWindow(), 0, 0, 0, 0, 640, 512);
xcb_flush(connection());
QVERIFY(waylandServer()->clients().isEmpty());
}
struct XcbConnectionDeleter
{
static inline void cleanup(xcb_connection_t *pointer)
{
xcb_disconnect(pointer);
}
};
class X11EventReaderHelper : public QObject
{
Q_OBJECT
public:
X11EventReaderHelper(xcb_connection_t *c);
Q_SIGNALS:
void entered(const QPoint &localPoint);
void left(const QPoint &localPoint);
private:
void processXcbEvents();
xcb_connection_t *m_connection;
QSocketNotifier *m_notifier;
};
X11EventReaderHelper::X11EventReaderHelper(xcb_connection_t *c)
: QObject()
, m_connection(c)
, m_notifier(new QSocketNotifier(xcb_get_file_descriptor(m_connection), QSocketNotifier::Read, this))
{
connect(m_notifier, &QSocketNotifier::activated, this, &X11EventReaderHelper::processXcbEvents);
connect(QCoreApplication::eventDispatcher(), &QAbstractEventDispatcher::aboutToBlock, this, &X11EventReaderHelper::processXcbEvents);
connect(QCoreApplication::eventDispatcher(), &QAbstractEventDispatcher::awake, this, &X11EventReaderHelper::processXcbEvents);
}
void X11EventReaderHelper::processXcbEvents()
{
while (auto event = xcb_poll_for_event(m_connection)) {
const uint8_t eventType = event->response_type & ~0x80;
switch (eventType) {
case XCB_ENTER_NOTIFY: {
auto enterEvent = reinterpret_cast<xcb_enter_notify_event_t *>(event);
emit entered(QPoint(enterEvent->event_x, enterEvent->event_y));
break; }
case XCB_LEAVE_NOTIFY: {
auto leaveEvent = reinterpret_cast<xcb_leave_notify_event_t *>(event);
emit left(QPoint(leaveEvent->event_x, leaveEvent->event_y));
break; }
}
free(event);
}
xcb_flush(m_connection);
}
void XWaylandInputTest::testPointerEnterLeaveSsd()
{
// this test simulates a pointer enter and pointer leave on a server-side decorated X11 window
// create the test window
QScopedPointer<xcb_connection_t, XcbConnectionDeleter> c(xcb_connect(nullptr, nullptr));
QVERIFY(!xcb_connection_has_error(c.data()));
if (xcb_get_setup(c.data())->release_number < 11800000) {
QSKIP("XWayland 1.18 required");
}
X11EventReaderHelper eventReader(c.data());
QSignalSpy enteredSpy(&eventReader, &X11EventReaderHelper::entered);
QVERIFY(enteredSpy.isValid());
QSignalSpy leftSpy(&eventReader, &X11EventReaderHelper::left);
QVERIFY(leftSpy.isValid());
// atom for the screenedge show hide functionality
Xcb::Atom atom(QByteArrayLiteral("_KDE_NET_WM_SCREEN_EDGE_SHOW"), false, c.data());
xcb_window_t w = xcb_generate_id(c.data());
const QRect windowGeometry = QRect(0, 0, 100, 200);
const uint32_t values[] = {
XCB_EVENT_MASK_ENTER_WINDOW |
XCB_EVENT_MASK_LEAVE_WINDOW
};
xcb_create_window(c.data(), XCB_COPY_FROM_PARENT, w, rootWindow(),
windowGeometry.x(),
windowGeometry.y(),
windowGeometry.width(),
windowGeometry.height(),
0, XCB_WINDOW_CLASS_INPUT_OUTPUT, XCB_COPY_FROM_PARENT, XCB_CW_EVENT_MASK, values);
xcb_size_hints_t hints;
memset(&hints, 0, sizeof(hints));
xcb_icccm_size_hints_set_position(&hints, 1, windowGeometry.x(), windowGeometry.y());
xcb_icccm_size_hints_set_size(&hints, 1, windowGeometry.width(), windowGeometry.height());
xcb_icccm_set_wm_normal_hints(c.data(), w, &hints);
NETWinInfo info(c.data(), w, rootWindow(), NET::WMAllProperties, NET::WM2AllProperties);
info.setWindowType(NET::Normal);
xcb_map_window(c.data(), w);
xcb_flush(c.data());
QSignalSpy windowCreatedSpy(workspace(), &Workspace::clientAdded);
QVERIFY(windowCreatedSpy.isValid());
QVERIFY(windowCreatedSpy.wait());
X11Client *client = windowCreatedSpy.last().first().value<X11Client *>();
QVERIFY(client);
QVERIFY(client->isDecorated());
QVERIFY(!client->hasStrut());
QVERIFY(!client->isHiddenInternal());
QVERIFY(!client->readyForPainting());
QMetaObject::invokeMethod(client, "setReadyForPainting");
QVERIFY(client->readyForPainting());
QVERIFY(!client->surface());
QSignalSpy surfaceChangedSpy(client, &Toplevel::surfaceChanged);
QVERIFY(surfaceChangedSpy.isValid());
QVERIFY(surfaceChangedSpy.wait());
QVERIFY(client->surface());
// move pointer into the window, should trigger an enter
QVERIFY(!client->frameGeometry().contains(Cursors::self()->mouse()->pos()));
QVERIFY(enteredSpy.isEmpty());
Cursors::self()->mouse()->setPos(client->frameGeometry().center());
QCOMPARE(waylandServer()->seat()->focusedPointerSurface(), client->surface());
QVERIFY(waylandServer()->seat()->focusedPointer());
QVERIFY(enteredSpy.wait());
QCOMPARE(enteredSpy.last().first(), client->frameGeometry().center() - client->clientPos());
// move out of window
Cursors::self()->mouse()->setPos(client->frameGeometry().bottomRight() + QPoint(10, 10));
QVERIFY(leftSpy.wait());
QCOMPARE(leftSpy.last().first(), client->frameGeometry().center() - client->clientPos());
// destroy window again
QSignalSpy windowClosedSpy(client, &X11Client::windowClosed);
QVERIFY(windowClosedSpy.isValid());
xcb_unmap_window(c.data(), w);
xcb_destroy_window(c.data(), w);
xcb_flush(c.data());
QVERIFY(windowClosedSpy.wait());
}
void XWaylandInputTest::testPointerEventLeaveCsd()
{
// this test simulates a pointer enter and pointer leave on a client-side decorated X11 window
QScopedPointer<xcb_connection_t, XcbConnectionDeleter> c(xcb_connect(nullptr, nullptr));
QVERIFY(!xcb_connection_has_error(c.data()));
if (xcb_get_setup(c.data())->release_number < 11800000) {
QSKIP("XWayland 1.18 required");
}
if (!Xcb::Extensions::self()->isShapeAvailable()) {
QSKIP("SHAPE extension is required");
}
X11EventReaderHelper eventReader(c.data());
QSignalSpy enteredSpy(&eventReader, &X11EventReaderHelper::entered);
QVERIFY(enteredSpy.isValid());
QSignalSpy leftSpy(&eventReader, &X11EventReaderHelper::left);
QVERIFY(leftSpy.isValid());
// Extents of the client-side drop-shadow.
NETStrut clientFrameExtent;
clientFrameExtent.left = 10;
clientFrameExtent.right = 10;
clientFrameExtent.top = 5;
clientFrameExtent.bottom = 20;
// Need to set the bounding shape in order to create a window without decoration.
xcb_rectangle_t boundingRect;
boundingRect.x = 0;
boundingRect.y = 0;
boundingRect.width = 100 + clientFrameExtent.left + clientFrameExtent.right;
boundingRect.height = 200 + clientFrameExtent.top + clientFrameExtent.bottom;
xcb_window_t window = xcb_generate_id(c.data());
const uint32_t values[] = {
XCB_EVENT_MASK_ENTER_WINDOW |
XCB_EVENT_MASK_LEAVE_WINDOW
};
xcb_create_window(c.data(), XCB_COPY_FROM_PARENT, window, rootWindow(),
boundingRect.x, boundingRect.y, boundingRect.width, boundingRect.height,
0, XCB_WINDOW_CLASS_INPUT_OUTPUT, XCB_COPY_FROM_PARENT, XCB_CW_EVENT_MASK, values);
xcb_size_hints_t hints;
memset(&hints, 0, sizeof(hints));
xcb_icccm_size_hints_set_position(&hints, 1, boundingRect.x, boundingRect.y);
xcb_icccm_size_hints_set_size(&hints, 1, boundingRect.width, boundingRect.height);
xcb_icccm_set_wm_normal_hints(c.data(), window, &hints);
xcb_shape_rectangles(c.data(), XCB_SHAPE_SO_SET, XCB_SHAPE_SK_BOUNDING,
XCB_CLIP_ORDERING_UNSORTED, window, 0, 0, 1, &boundingRect);
NETWinInfo info(c.data(), window, rootWindow(), NET::WMAllProperties, NET::WM2AllProperties);
info.setWindowType(NET::Normal);
info.setGtkFrameExtents(clientFrameExtent);
xcb_map_window(c.data(), window);
xcb_flush(c.data());
QSignalSpy windowCreatedSpy(workspace(), &Workspace::clientAdded);
QVERIFY(windowCreatedSpy.isValid());
QVERIFY(windowCreatedSpy.wait());
X11Client *client = windowCreatedSpy.last().first().value<X11Client *>();
QVERIFY(client);
QVERIFY(!client->isDecorated());
QVERIFY(client->isClientSideDecorated());
QCOMPARE(client->bufferGeometry(), QRect(0, 0, 120, 225));
QCOMPARE(client->frameGeometry(), QRect(10, 5, 100, 200));
QMetaObject::invokeMethod(client, "setReadyForPainting");
QVERIFY(client->readyForPainting());
QVERIFY(!client->surface());
QSignalSpy surfaceChangedSpy(client, &Toplevel::surfaceChanged);
QVERIFY(surfaceChangedSpy.isValid());
QVERIFY(surfaceChangedSpy.wait());
QVERIFY(client->surface());
// Move pointer into the window, should trigger an enter.
QVERIFY(!client->frameGeometry().contains(Cursors::self()->mouse()->pos()));
QVERIFY(enteredSpy.isEmpty());
Cursors::self()->mouse()->setPos(client->frameGeometry().center());
QCOMPARE(waylandServer()->seat()->focusedPointerSurface(), client->surface());
QVERIFY(waylandServer()->seat()->focusedPointer());
QVERIFY(enteredSpy.wait());
QCOMPARE(enteredSpy.last().first(), QPoint(59, 104));
// Move out of the window, should trigger a leave.
QVERIFY(leftSpy.isEmpty());
Cursors::self()->mouse()->setPos(client->frameGeometry().bottomRight() + QPoint(100, 100));
QVERIFY(leftSpy.wait());
QCOMPARE(leftSpy.last().first(), QPoint(59, 104));
// Destroy the window.
QSignalSpy windowClosedSpy(client, &X11Client::windowClosed);
QVERIFY(windowClosedSpy.isValid());
xcb_unmap_window(c.data(), window);
xcb_destroy_window(c.data(), window);
xcb_flush(c.data());
QVERIFY(windowClosedSpy.wait());
}
}
WAYLANDTEST_MAIN(KWin::XWaylandInputTest)
#include "xwayland_input_test.moc"