kwin/autotests/integration/globalshortcuts_test.cpp
2024-01-24 13:20:58 +00:00

457 lines
18 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 "input.h"
#include "internalwindow.h"
#include "keyboard_input.h"
#include "pointer_input.h"
#include "useractions.h"
#include "wayland/keyboard.h"
#include "wayland/seat.h"
#include "wayland_server.h"
#include "workspace.h"
#include "x11window.h"
#include "xkb.h"
#include <KWayland/Client/surface.h>
#include <KGlobalAccel>
#include <QAction>
#include <linux/input.h>
#include <netwm.h>
#include <xcb/xcb_icccm.h>
using namespace KWin;
static const QString s_socketName = QStringLiteral("wayland_test_kwin_globalshortcuts-0");
class GlobalShortcutsTest : public QObject
{
Q_OBJECT
private Q_SLOTS:
void initTestCase();
void init();
void cleanup();
void testNonLatinLayout_data();
void testNonLatinLayout();
void testConsumedShift();
void testRepeatedTrigger();
void testUserActionsMenu();
void testMetaShiftW();
void testComponseKey();
void testKeypad();
void testX11WindowShortcut();
void testWaylandWindowShortcut();
void testSetupWindowShortcut();
};
void GlobalShortcutsTest::initTestCase()
{
qRegisterMetaType<KWin::Window *>();
qRegisterMetaType<KWin::InternalWindow *>();
QSignalSpy applicationStartedSpy(kwinApp(), &Application::started);
QVERIFY(waylandServer()->init(s_socketName));
Test::setOutputConfig({
QRect(0, 0, 1280, 1024),
QRect(1280, 0, 1280, 1024),
});
kwinApp()->setConfig(KSharedConfig::openConfig(QString(), KConfig::SimpleConfig));
qputenv("KWIN_XKB_DEFAULT_KEYMAP", "1");
qputenv("XKB_DEFAULT_RULES", "evdev");
qputenv("XKB_DEFAULT_LAYOUT", "us,ru");
kwinApp()->start();
QVERIFY(applicationStartedSpy.wait());
}
void GlobalShortcutsTest::init()
{
QVERIFY(Test::setupWaylandConnection());
workspace()->setActiveOutput(QPoint(640, 512));
KWin::input()->pointer()->warp(QPoint(640, 512));
auto xkb = input()->keyboard()->xkb();
xkb->switchToLayout(0);
}
void GlobalShortcutsTest::cleanup()
{
Test::destroyWaylandConnection();
}
Q_DECLARE_METATYPE(Qt::Modifier)
void GlobalShortcutsTest::testNonLatinLayout_data()
{
QTest::addColumn<int>("modifierKey");
QTest::addColumn<Qt::Modifier>("qtModifier");
QTest::addColumn<int>("key");
QTest::addColumn<Qt::Key>("qtKey");
// KEY_W is "ц" in the RU layout and "w" in the US layout
// KEY_GRAVE is "ё" in the RU layout and "`" in the US layout
// TAB_KEY is the same both in the US and RU layout
QTest::newRow("Left Ctrl + Tab") << KEY_LEFTCTRL << Qt::CTRL << KEY_TAB << Qt::Key_Tab;
QTest::newRow("Left Ctrl + W") << KEY_LEFTCTRL << Qt::CTRL << KEY_W << Qt::Key_W;
QTest::newRow("Left Ctrl + `") << KEY_LEFTCTRL << Qt::CTRL << KEY_GRAVE << Qt::Key_QuoteLeft;
QTest::newRow("Left Alt + Tab") << KEY_LEFTALT << Qt::ALT << KEY_TAB << Qt::Key_Tab;
QTest::newRow("Left Alt + W") << KEY_LEFTALT << Qt::ALT << KEY_W << Qt::Key_W;
QTest::newRow("Left Alt + `") << KEY_LEFTALT << Qt::ALT << KEY_GRAVE << Qt::Key_QuoteLeft;
QTest::newRow("Left Shift + Tab") << KEY_LEFTSHIFT << Qt::SHIFT << KEY_TAB << Qt::Key_Tab;
QTest::newRow("Left Meta + Tab") << KEY_LEFTMETA << Qt::META << KEY_TAB << Qt::Key_Tab;
QTest::newRow("Left Meta + W") << KEY_LEFTMETA << Qt::META << KEY_W << Qt::Key_W;
QTest::newRow("Left Meta + `") << KEY_LEFTMETA << Qt::META << KEY_GRAVE << Qt::Key_QuoteLeft;
}
void GlobalShortcutsTest::testNonLatinLayout()
{
// Shortcuts on non-Latin layouts should still work, see BUG 375518
auto xkb = input()->keyboard()->xkb();
xkb->switchToLayout(1);
QCOMPARE(xkb->layoutName(), QStringLiteral("Russian"));
QFETCH(int, modifierKey);
QFETCH(Qt::Modifier, qtModifier);
QFETCH(int, key);
QFETCH(Qt::Key, qtKey);
const QKeySequence seq(qtModifier + qtKey);
std::unique_ptr<QAction> action(new QAction(nullptr));
action->setProperty("componentName", QStringLiteral("kwin"));
action->setObjectName("globalshortcuts-test-non-latin-layout");
QSignalSpy triggeredSpy(action.get(), &QAction::triggered);
KGlobalAccel::self()->stealShortcutSystemwide(seq);
KGlobalAccel::self()->setShortcut(action.get(), {seq}, KGlobalAccel::NoAutoloading);
quint32 timestamp = 0;
Test::keyboardKeyPressed(modifierKey, timestamp++);
QCOMPARE(input()->keyboardModifiers(), qtModifier);
Test::keyboardKeyPressed(key, timestamp++);
Test::keyboardKeyReleased(key, timestamp++);
Test::keyboardKeyReleased(modifierKey, timestamp++);
QTRY_COMPARE_WITH_TIMEOUT(triggeredSpy.count(), 1, 100);
}
void GlobalShortcutsTest::testConsumedShift()
{
// this test verifies that a shortcut with a consumed shift modifier triggers
// create the action
std::unique_ptr<QAction> action(new QAction(nullptr));
action->setProperty("componentName", QStringLiteral("kwin"));
action->setObjectName(QStringLiteral("globalshortcuts-test-consumed-shift"));
QSignalSpy triggeredSpy(action.get(), &QAction::triggered);
KGlobalAccel::self()->setShortcut(action.get(), QList<QKeySequence>{Qt::Key_Percent}, KGlobalAccel::NoAutoloading);
// press shift+5
quint32 timestamp = 0;
Test::keyboardKeyPressed(KEY_LEFTSHIFT, timestamp++);
QCOMPARE(input()->keyboardModifiers(), Qt::ShiftModifier);
Test::keyboardKeyPressed(KEY_5, timestamp++);
QTRY_COMPARE(triggeredSpy.count(), 1);
Test::keyboardKeyReleased(KEY_5, timestamp++);
// release shift
Test::keyboardKeyReleased(KEY_LEFTSHIFT, timestamp++);
}
void GlobalShortcutsTest::testRepeatedTrigger()
{
// this test verifies that holding a key, triggers repeated global shortcut
// in addition pressing another key should stop triggering the shortcut
std::unique_ptr<QAction> action(new QAction(nullptr));
action->setProperty("componentName", QStringLiteral("kwin"));
action->setObjectName(QStringLiteral("globalshortcuts-test-consumed-shift"));
QSignalSpy triggeredSpy(action.get(), &QAction::triggered);
KGlobalAccel::self()->setShortcut(action.get(), QList<QKeySequence>{Qt::Key_Percent}, KGlobalAccel::NoAutoloading);
// we need to configure the key repeat first. It is only enabled on libinput
waylandServer()->seat()->keyboard()->setRepeatInfo(25, 300);
// press shift+5
quint32 timestamp = 0;
Test::keyboardKeyPressed(KEY_WAKEUP, timestamp++);
Test::keyboardKeyPressed(KEY_LEFTSHIFT, timestamp++);
QCOMPARE(input()->keyboardModifiers(), Qt::ShiftModifier);
Test::keyboardKeyPressed(KEY_5, timestamp++);
QTRY_COMPARE(triggeredSpy.count(), 1);
// and should repeat
QVERIFY(triggeredSpy.wait());
QVERIFY(triggeredSpy.wait());
// now release the key
Test::keyboardKeyReleased(KEY_5, timestamp++);
QVERIFY(!triggeredSpy.wait(50));
Test::keyboardKeyReleased(KEY_WAKEUP, timestamp++);
QVERIFY(!triggeredSpy.wait(50));
// release shift
Test::keyboardKeyReleased(KEY_LEFTSHIFT, timestamp++);
}
void GlobalShortcutsTest::testUserActionsMenu()
{
// this test tries to trigger the user actions menu with Alt+F3
// the problem here is that pressing F3 consumes modifiers as it's part of the
// Ctrl+alt+F3 keysym for vt switching. xkbcommon considers all modifiers as consumed
// which a transformation to any keysym would cause
// for more information see:
// https://bugs.freedesktop.org/show_bug.cgi?id=92818
// https://github.com/xkbcommon/libxkbcommon/issues/17
// first create a window
std::unique_ptr<KWayland::Client::Surface> surface(Test::createSurface());
std::unique_ptr<Test::XdgToplevel> shellSurface(Test::createXdgToplevelSurface(surface.get()));
auto window = Test::renderAndWaitForShown(surface.get(), QSize(100, 50), Qt::blue);
QVERIFY(window);
QVERIFY(window->isActive());
quint32 timestamp = 0;
QVERIFY(!workspace()->userActionsMenu()->isShown());
Test::keyboardKeyPressed(KEY_LEFTALT, timestamp++);
Test::keyboardKeyPressed(KEY_F3, timestamp++);
Test::keyboardKeyReleased(KEY_F3, timestamp++);
QTRY_VERIFY(workspace()->userActionsMenu()->isShown());
Test::keyboardKeyReleased(KEY_LEFTALT, timestamp++);
}
void GlobalShortcutsTest::testMetaShiftW()
{
// BUG 370341
std::unique_ptr<QAction> action(new QAction(nullptr));
action->setProperty("componentName", QStringLiteral("kwin"));
action->setObjectName(QStringLiteral("globalshortcuts-test-meta-shift-w"));
QSignalSpy triggeredSpy(action.get(), &QAction::triggered);
KGlobalAccel::self()->setShortcut(action.get(), QList<QKeySequence>{Qt::META | Qt::SHIFT | Qt::Key_W}, KGlobalAccel::NoAutoloading);
// press meta+shift+w
quint32 timestamp = 0;
Test::keyboardKeyPressed(KEY_LEFTMETA, timestamp++);
QCOMPARE(input()->keyboardModifiers(), Qt::MetaModifier);
Test::keyboardKeyPressed(KEY_LEFTSHIFT, timestamp++);
QCOMPARE(input()->keyboardModifiers(), Qt::ShiftModifier | Qt::MetaModifier);
Test::keyboardKeyPressed(KEY_W, timestamp++);
QTRY_COMPARE(triggeredSpy.count(), 1);
Test::keyboardKeyReleased(KEY_W, timestamp++);
// release meta+shift
Test::keyboardKeyReleased(KEY_LEFTSHIFT, timestamp++);
Test::keyboardKeyReleased(KEY_LEFTMETA, timestamp++);
}
void GlobalShortcutsTest::testComponseKey()
{
// BUG 390110
std::unique_ptr<QAction> action(new QAction(nullptr));
action->setProperty("componentName", QStringLiteral("kwin"));
action->setObjectName(QStringLiteral("globalshortcuts-accent"));
QSignalSpy triggeredSpy(action.get(), &QAction::triggered);
KGlobalAccel::self()->setShortcut(action.get(), QList<QKeySequence>{Qt::NoModifier}, KGlobalAccel::NoAutoloading);
// press & release `
quint32 timestamp = 0;
Test::keyboardKeyPressed(KEY_RESERVED, timestamp++);
Test::keyboardKeyReleased(KEY_RESERVED, timestamp++);
QTRY_COMPARE(triggeredSpy.count(), 0);
}
void GlobalShortcutsTest::testKeypad()
{
auto zeroAction = std::make_unique<QAction>();
zeroAction->setProperty("componentName", QStringLiteral("kwin"));
zeroAction->setObjectName(QStringLiteral("globalshortcuts-test-keypad-0"));
QSignalSpy zeroActionTriggeredSpy(zeroAction.get(), &QAction::triggered);
KGlobalAccel::self()->setShortcut(zeroAction.get(), QList<QKeySequence>{Qt::MetaModifier | Qt::KeypadModifier | Qt::Key_0}, KGlobalAccel::NoAutoloading);
auto insertAction = std::make_unique<QAction>();
insertAction->setProperty("componentName", QStringLiteral("kwin"));
insertAction->setObjectName(QStringLiteral("globalshortcuts-test-keypad-ins"));
QSignalSpy insertActionTriggeredSpy(insertAction.get(), &QAction::triggered);
KGlobalAccel::self()->setShortcut(insertAction.get(), QList<QKeySequence>{Qt::MetaModifier | Qt::KeypadModifier | Qt::Key_Insert}, KGlobalAccel::NoAutoloading);
// Turn on numlock
quint32 timestamp = 0;
Test::keyboardKeyPressed(KEY_NUMLOCK, timestamp++);
Test::keyboardKeyReleased(KEY_NUMLOCK, timestamp++);
Test::keyboardKeyPressed(KEY_LEFTMETA, timestamp++);
Test::keyboardKeyPressed(KEY_KP0, timestamp++);
Test::keyboardKeyReleased(KEY_KP0, timestamp++);
Test::keyboardKeyReleased(KEY_LEFTMETA, timestamp++);
QTRY_COMPARE(zeroActionTriggeredSpy.count(), 1);
QCOMPARE(insertActionTriggeredSpy.count(), 0);
// Turn off numlock
Test::keyboardKeyPressed(KEY_NUMLOCK, timestamp++);
Test::keyboardKeyReleased(KEY_NUMLOCK, timestamp++);
Test::keyboardKeyPressed(KEY_LEFTMETA, timestamp++);
Test::keyboardKeyPressed(KEY_KP0, timestamp++);
Test::keyboardKeyReleased(KEY_KP0, timestamp++);
Test::keyboardKeyReleased(KEY_LEFTMETA, timestamp++);
QTRY_COMPARE(insertActionTriggeredSpy.count(), 1);
QCOMPARE(zeroActionTriggeredSpy.count(), 1);
}
void GlobalShortcutsTest::testX11WindowShortcut()
{
// create an X11 window
Test::XcbConnectionPtr c = Test::createX11Connection();
QVERIFY(!xcb_connection_has_error(c.get()));
xcb_window_t windowId = xcb_generate_id(c.get());
const QRect windowGeometry = QRect(0, 0, 10, 20);
const uint32_t values[] = {
XCB_EVENT_MASK_ENTER_WINDOW | XCB_EVENT_MASK_LEAVE_WINDOW};
xcb_create_window(c.get(), XCB_COPY_FROM_PARENT, windowId, 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.get(), windowId, &hints);
NETWinInfo info(c.get(), windowId, rootWindow(), NET::WMAllProperties, NET::WM2AllProperties);
info.setWindowType(NET::Normal);
xcb_map_window(c.get(), windowId);
xcb_flush(c.get());
QSignalSpy windowCreatedSpy(workspace(), &Workspace::windowAdded);
QVERIFY(windowCreatedSpy.wait());
X11Window *window = windowCreatedSpy.last().first().value<X11Window *>();
QVERIFY(window);
QCOMPARE(workspace()->activeWindow(), window);
QVERIFY(window->isActive());
QCOMPARE(window->shortcut(), QKeySequence());
const QKeySequence seq(Qt::META | Qt::SHIFT | Qt::Key_Y);
QVERIFY(workspace()->shortcutAvailable(seq));
window->setShortcut(seq.toString());
QCOMPARE(window->shortcut(), seq);
QVERIFY(!workspace()->shortcutAvailable(seq));
QCOMPARE(window->caption(), QStringLiteral(" {Meta+Shift+Y}"));
// it's delayed
QCoreApplication::processEvents();
workspace()->activateWindow(nullptr);
QVERIFY(!workspace()->activeWindow());
QVERIFY(!window->isActive());
// now let's trigger the shortcut
quint32 timestamp = 0;
Test::keyboardKeyPressed(KEY_LEFTMETA, timestamp++);
Test::keyboardKeyPressed(KEY_LEFTSHIFT, timestamp++);
Test::keyboardKeyPressed(KEY_Y, timestamp++);
QTRY_COMPARE(workspace()->activeWindow(), window);
Test::keyboardKeyReleased(KEY_Y, timestamp++);
Test::keyboardKeyReleased(KEY_LEFTSHIFT, timestamp++);
Test::keyboardKeyReleased(KEY_LEFTMETA, timestamp++);
// destroy window again
QSignalSpy windowClosedSpy(window, &X11Window::closed);
xcb_unmap_window(c.get(), windowId);
xcb_destroy_window(c.get(), windowId);
xcb_flush(c.get());
QVERIFY(windowClosedSpy.wait());
}
void GlobalShortcutsTest::testWaylandWindowShortcut()
{
std::unique_ptr<KWayland::Client::Surface> surface(Test::createSurface());
std::unique_ptr<Test::XdgToplevel> shellSurface(Test::createXdgToplevelSurface(surface.get()));
auto window = Test::renderAndWaitForShown(surface.get(), QSize(100, 50), Qt::blue);
QCOMPARE(workspace()->activeWindow(), window);
QVERIFY(window->isActive());
QCOMPARE(window->shortcut(), QKeySequence());
const QKeySequence seq(Qt::META | Qt::SHIFT | Qt::Key_Y);
QVERIFY(workspace()->shortcutAvailable(seq));
window->setShortcut(seq.toString());
QCOMPARE(window->shortcut(), seq);
QVERIFY(!workspace()->shortcutAvailable(seq));
QCOMPARE(window->caption(), QStringLiteral(" {Meta+Shift+Y}"));
workspace()->activateWindow(nullptr);
QVERIFY(!workspace()->activeWindow());
QVERIFY(!window->isActive());
// now let's trigger the shortcut
quint32 timestamp = 0;
Test::keyboardKeyPressed(KEY_LEFTMETA, timestamp++);
Test::keyboardKeyPressed(KEY_LEFTSHIFT, timestamp++);
Test::keyboardKeyPressed(KEY_Y, timestamp++);
QTRY_COMPARE(workspace()->activeWindow(), window);
Test::keyboardKeyReleased(KEY_Y, timestamp++);
Test::keyboardKeyReleased(KEY_LEFTSHIFT, timestamp++);
Test::keyboardKeyReleased(KEY_LEFTMETA, timestamp++);
shellSurface.reset();
surface.reset();
QVERIFY(Test::waitForWindowClosed(window));
QTRY_VERIFY_WITH_TIMEOUT(workspace()->shortcutAvailable(seq), 500); // we need the try since KGlobalAccelPrivate::unregister is async
}
void GlobalShortcutsTest::testSetupWindowShortcut()
{
// QTBUG-62102
std::unique_ptr<KWayland::Client::Surface> surface(Test::createSurface());
std::unique_ptr<Test::XdgToplevel> shellSurface(Test::createXdgToplevelSurface(surface.get()));
auto window = Test::renderAndWaitForShown(surface.get(), QSize(100, 50), Qt::blue);
QCOMPARE(workspace()->activeWindow(), window);
QVERIFY(window->isActive());
QCOMPARE(window->shortcut(), QKeySequence());
QSignalSpy shortcutDialogAddedSpy(workspace(), &Workspace::windowAdded);
workspace()->slotSetupWindowShortcut();
QTRY_COMPARE(shortcutDialogAddedSpy.count(), 1);
auto dialog = shortcutDialogAddedSpy.first().first().value<InternalWindow *>();
QVERIFY(dialog);
QVERIFY(dialog->isInternal());
auto sequenceEdit = workspace()->shortcutDialog()->findChild<QKeySequenceEdit *>();
QVERIFY(sequenceEdit);
QTRY_VERIFY(sequenceEdit->hasFocus());
quint32 timestamp = 0;
Test::keyboardKeyPressed(KEY_LEFTMETA, timestamp++);
Test::keyboardKeyPressed(KEY_LEFTSHIFT, timestamp++);
Test::keyboardKeyPressed(KEY_Y, timestamp++);
Test::keyboardKeyReleased(KEY_Y, timestamp++);
Test::keyboardKeyReleased(KEY_LEFTSHIFT, timestamp++);
Test::keyboardKeyReleased(KEY_LEFTMETA, timestamp++);
// the sequence gets accepted after one second, so wait a bit longer
QTest::qWait(2000);
// now send in enter
Test::keyboardKeyPressed(KEY_ENTER, timestamp++);
Test::keyboardKeyReleased(KEY_ENTER, timestamp++);
QTRY_COMPARE(window->shortcut(), QKeySequence(Qt::META | Qt::SHIFT | Qt::Key_Y));
}
WAYLANDTEST_MAIN(GlobalShortcutsTest)
#include "globalshortcuts_test.moc"