yukijoou/kwin
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Support interactive window selection through the Platform

Browse source 
Summary:
A new virtual method is added to Platform:
startInteractiveWindowSelection

The interactive window selection enters a mode where the user can select
a window through the pointer or keyboard device. The cursor is turned
into a crosshair cursor, unless another cursor name is provided (e.g.
pirate for kill window).

Once a window is selected the provided callback method is invoked with
the selected Toplevel as argument. In case the user cancelled the
selection a nullptr argument is passed in.

Currently it's only implemented by the X11 standalone platform using the
logic from KillWindow. Just instead of killing the window the callback
is invoked.

KillWindow loses the X11 implementation and interacts with the new
functionality in Platform by providing a lambda function for the
killing.

Test Plan: Killing of X11 windows is still possible

Reviewers: #kwin, #plasma

Subscribers: plasma-devel, kwin

Tags: #kwin

Differential Revision: https://phabricator.kde.org/D3363
This commit is contained in:
Martin Gräßlin 2016-11-15 10:22:56 +01:00
parent 327ccffcf4
commit 7b464cf284
10 changed files with 357 additions and 194 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

185
killwindow.cpp
View file

@ -21,31 +21,14 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
*********************************************************************/
#include "killwindow.h"
#include "client.h"
#include "cursor.h"
#include "workspace.h"
#include "xcbutils.h"
// XLib
#include <X11/cursorfont.h>
#include <X11/Xutil.h>
#include <fixx11h.h>
// XCB
#include <xcb/xcb_keysyms.h>
#include "main.h"
#include "platform.h"
#include "unmanaged.h"
namespace KWin
{
KillWindow::KillWindow()
: X11EventFilter(QVector<int>{XCB_BUTTON_PRESS,
XCB_BUTTON_RELEASE,
XCB_MOTION_NOTIFY,
XCB_ENTER_NOTIFY,
XCB_LEAVE_NOTIFY,
XCB_KEY_PRESS,
XCB_KEY_RELEASE,
XCB_FOCUS_IN,
XCB_FOCUS_OUT
})
, m_active(false)
{
}
@ -55,156 +38,18 @@ KillWindow::~KillWindow()
void KillWindow::start()
{
static xcb_cursor_t kill_cursor = XCB_CURSOR_NONE;
if (kill_cursor == XCB_CURSOR_NONE) {
kill_cursor = createCursor();
}
if (m_active) {
return;
}
xcb_connection_t *c = connection();
ScopedCPointer<xcb_grab_pointer_reply_t> grabPointer(xcb_grab_pointer_reply(c, xcb_grab_pointer_unchecked(c, false, rootWindow(),
XCB_EVENT_MASK_BUTTON_PRESS | XCB_EVENT_MASK_BUTTON_RELEASE |
XCB_EVENT_MASK_POINTER_MOTION |
XCB_EVENT_MASK_ENTER_WINDOW | XCB_EVENT_MASK_LEAVE_WINDOW,
XCB_GRAB_MODE_ASYNC, XCB_GRAB_MODE_ASYNC, XCB_WINDOW_NONE,
kill_cursor, XCB_TIME_CURRENT_TIME), NULL));
if (grabPointer.isNull() || grabPointer->status != XCB_GRAB_STATUS_SUCCESS) {
return;
}
m_active = grabXKeyboard();
if (!m_active) {
xcb_ungrab_pointer(connection(), XCB_TIME_CURRENT_TIME);
return;
}
grabXServer();
}
xcb_cursor_t KillWindow::createCursor()
{
xcb_cursor_t cursor = Cursor::x11Cursor(QByteArrayLiteral("pirate"));
if (cursor != XCB_CURSOR_NONE) {
return cursor;
}
// fallback on font
xcb_connection_t *c = connection();
const xcb_font_t cursorFont = xcb_generate_id(c);
xcb_open_font(c, cursorFont, strlen ("cursor"), "cursor");
cursor = xcb_generate_id(c);
xcb_create_glyph_cursor(c, cursor, cursorFont, cursorFont,
XC_pirate, /* source character glyph */
XC_pirate + 1, /* mask character glyph */
0, 0, 0, 0, 0, 0); /* r b g r b g */
return cursor;
}
void KillWindow::processEvent(xcb_generic_event_t *event)
{
if (event->response_type == XCB_BUTTON_RELEASE) {
xcb_button_release_event_t *buttonEvent = reinterpret_cast<xcb_button_release_event_t*>(event);
handleButtonRelease(buttonEvent->detail, buttonEvent->child);
} else if (event->response_type == XCB_KEY_PRESS) {
xcb_key_press_event_t *keyEvent = reinterpret_cast<xcb_key_press_event_t*>(event);
handleKeyPress(keyEvent->detail, keyEvent->state);
}
}
bool KillWindow::event(xcb_generic_event_t *event)
{
if (!m_active) {
return false;
}
processEvent(event);
return true;
}
void KillWindow::handleButtonRelease(xcb_button_t button, xcb_window_t window)
{
if (button == XCB_BUTTON_INDEX_3) {
release();
return;
}
if (button == XCB_BUTTON_INDEX_1 || button == XCB_BUTTON_INDEX_2) {
killWindowId(window);
release();
return;
}
}
void KillWindow::handleKeyPress(xcb_keycode_t keycode, uint16_t state)
{
xcb_key_symbols_t *symbols = xcb_key_symbols_alloc(connection());
xcb_keysym_t kc = xcb_key_symbols_get_keysym(symbols, keycode, 0);
int mx = 0;
int my = 0;
const bool returnPressed = (kc == XK_Return) || (kc == XK_space);
const bool escapePressed = (kc == XK_Escape);
if (kc == XK_Left) {
mx = -10;
}
if (kc == XK_Right) {
mx = 10;
}
if (kc == XK_Up) {
my = -10;
}
if (kc == XK_Down) {
my = 10;
}
if (state & XCB_MOD_MASK_CONTROL) {
mx /= 10;
my /= 10;
}
Cursor::setPos(Cursor::pos() + QPoint(mx, my));
if (returnPressed) {
performKill();
}
if (returnPressed || escapePressed) {
release();
}
xcb_key_symbols_free(symbols);
}
void KillWindow::performKill()
{
Xcb::Pointer pointer(rootWindow());
if (!pointer.isNull() && pointer->child != XCB_WINDOW_NONE) {
killWindowId(pointer->child);
}
}
void KillWindow::release()
{
ungrabXKeyboard();
xcb_ungrab_pointer(connection(), XCB_TIME_CURRENT_TIME);
ungrabXServer();
m_active = false;
}
void KillWindow::killWindowId(xcb_window_t window_to_kill)
{
if (window_to_kill == XCB_WINDOW_NONE)
return;
xcb_window_t window = window_to_kill;
Client* client = NULL;
while (true) {
client = Workspace::self()->findClient(Predicate::FrameIdMatch, window);
if (client) {
break; // Found the client
}
Xcb::Tree tree(window);
if (window == tree->root) {
// We didn't find the client, probably an override-redirect window
break;
}
window = tree->parent; // Go up
}
if (client)
client->killWindow();
else
xcb_kill_client(connection(), window_to_kill);
kwinApp()->platform()->startInteractiveWindowSelection(
[] (KWin::Toplevel *t) {
if (!t) {
return;
}
if (Client *c = qobject_cast<Client*>(t)) {
c->killWindow();
} else if (Unmanaged *u = qobject_cast<Unmanaged*>(t)) {
xcb_kill_client(connection(), u->window());
}
}, QByteArrayLiteral("pirate")
);
}
} // namespace

21
killwindow.h
View file

@ -23,14 +23,10 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
#ifndef KWIN_KILLWINDOW_H
#define KWIN_KILLWINDOW_H
#include "x11eventfilter.h"
#include <xcb/xcb.h>
namespace KWin
{
class KillWindow : public X11EventFilter
class KillWindow
{
public:
@ -38,21 +34,6 @@ public:
~KillWindow();
void start();
bool isActive() const {
return m_active;
}
void processEvent(xcb_generic_event_t *event);
bool event(xcb_generic_event_t *event) override;
private:
xcb_cursor_t createCursor();
void release();
void performKill();
void handleKeyPress(xcb_keycode_t keycode, uint16_t state);
void handleButtonRelease(xcb_button_t button, xcb_window_t window);
void killWindowId(xcb_window_t window_to_kill);
bool m_active;
};
} // namespace

7
platform.cpp
View file

@ -363,4 +363,11 @@ void Platform::createOpenGLSafePoint(OpenGLSafePoint safePoint)
Q_UNUSED(safePoint)
}
void Platform::startInteractiveWindowSelection(std::function<void(KWin::Toplevel*)> callback, const QByteArray &cursorName)
{
// TODO: provide a basic implementation for Wayland platforms
Q_UNUSED(cursorName)
callback(nullptr);
}
}

22
platform.h
View file

@ -26,6 +26,8 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
#include <QImage>
#include <QObject>
#include <functional>
namespace KWayland {
namespace Server {
class OutputConfigurationInterface;
@ -40,6 +42,7 @@ class OpenGLBackend;
class QPainterBackend;
class Screens;
class ScreenEdges;
class Toplevel;
class WaylandCursorTheme;
class KWIN_EXPORT Platform : public QObject
@ -158,6 +161,25 @@ public:
**/
virtual void createOpenGLSafePoint(OpenGLSafePoint safePoint);
/**
* Starts an interactive window selection process.
*
* Once the user selected a window the @p callback is invoked with the selected Toplevel as
* argument. In case the user cancels the interactive window selection or selecting a window is currently
* not possible (e.g. screen locked) the @p callback is invoked with a @c nullptr argument.
*
* During the interactive window selection the cursor is turned into a crosshair cursor unless
* @p cursorName is provided. The argument @p cursorName is a QByteArray instead of Qt::CursorShape
* to support the "pirate" cursor for kill window which is not wrapped by Qt::CursorShape.
*
* The default implementation does not support selecting windows yet and only invokes the
* @p callback with @c nullptr.
*
* @param callback The function to invoke once the interactive window selection ends
* @param cursorName The optional name of the cursor shape to use, default is crosshair
**/
virtual void startInteractiveWindowSelection(std::function<void(KWin::Toplevel*)> callback, const QByteArray &cursorName = QByteArray());
bool usesSoftwareCursor() const {
return m_softWareCursor;
}

1
plugins/platforms/x11/standalone/CMakeLists.txt
View file

@ -4,6 +4,7 @@ set(X11PLATFORM_SOURCES
x11cursor.cpp
x11_platform.cpp
screens_xrandr.cpp
windowselector.cpp
)
if(X11_Xinput_FOUND)

231
plugins/platforms/x11/standalone/windowselector.cpp Normal file
View file

@ -0,0 +1,231 @@
/********************************************************************
KWin - the KDE window manager
This file is part of the KDE project.
Copyright (C) 1999, 2000 Matthias Ettrich <ettrich@kde.org>
Copyright (C) 2003 Lubos Lunak <l.lunak@kde.org>
Copyright (C) 2012 Martin Gräßlin <mgraesslin@kde.org>
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*********************************************************************/
#include "windowselector.h"
#include "client.h"
#include "cursor.h"
#include "unmanaged.h"
#include "workspace.h"
#include "xcbutils.h"
// XLib
#include <X11/cursorfont.h>
#include <X11/Xutil.h>
#include <fixx11h.h>
// XCB
#include <xcb/xcb_keysyms.h>
namespace KWin
{
WindowSelector::WindowSelector()
: X11EventFilter(QVector<int>{XCB_BUTTON_PRESS,
XCB_BUTTON_RELEASE,
XCB_MOTION_NOTIFY,
XCB_ENTER_NOTIFY,
XCB_LEAVE_NOTIFY,
XCB_KEY_PRESS,
XCB_KEY_RELEASE,
XCB_FOCUS_IN,
XCB_FOCUS_OUT
})
, m_active(false)
{
}
WindowSelector::~WindowSelector()
{
}
void WindowSelector::start(std::function<void(KWin::Toplevel*)> callback, const QByteArray &cursorName)
{
xcb_cursor_t cursor = createCursor(cursorName);
if (m_active) {
callback(nullptr);
return;
}
xcb_connection_t *c = connection();
ScopedCPointer<xcb_grab_pointer_reply_t> grabPointer(xcb_grab_pointer_reply(c, xcb_grab_pointer_unchecked(c, false, rootWindow(),
XCB_EVENT_MASK_BUTTON_PRESS | XCB_EVENT_MASK_BUTTON_RELEASE |
XCB_EVENT_MASK_POINTER_MOTION |
XCB_EVENT_MASK_ENTER_WINDOW | XCB_EVENT_MASK_LEAVE_WINDOW,
XCB_GRAB_MODE_ASYNC, XCB_GRAB_MODE_ASYNC, XCB_WINDOW_NONE,
cursor, XCB_TIME_CURRENT_TIME), NULL));
if (grabPointer.isNull() || grabPointer->status != XCB_GRAB_STATUS_SUCCESS) {
callback(nullptr);
return;
}
m_active = grabXKeyboard();
if (!m_active) {
xcb_ungrab_pointer(connection(), XCB_TIME_CURRENT_TIME);
callback(nullptr);
return;
}
grabXServer();
m_callback = callback;
}
xcb_cursor_t WindowSelector::createCursor(const QByteArray &cursorName)
{
if (cursorName.isEmpty()) {
return Cursor::x11Cursor(Qt::CrossCursor);
}
xcb_cursor_t cursor = Cursor::x11Cursor(cursorName);
if (cursor != XCB_CURSOR_NONE) {
return cursor;
}
if (cursorName == QByteArrayLiteral("pirate")) {
// special handling for font pirate cursor
static xcb_cursor_t kill_cursor = XCB_CURSOR_NONE;
if (kill_cursor != XCB_CURSOR_NONE) {
return kill_cursor;
}
// fallback on font
xcb_connection_t *c = connection();
const xcb_font_t cursorFont = xcb_generate_id(c);
xcb_open_font(c, cursorFont, strlen ("cursor"), "cursor");
cursor = xcb_generate_id(c);
xcb_create_glyph_cursor(c, cursor, cursorFont, cursorFont,
XC_pirate, /* source character glyph */
XC_pirate + 1, /* mask character glyph */
0, 0, 0, 0, 0, 0); /* r b g r b g */
kill_cursor = cursor;
}
return cursor;
}
void WindowSelector::processEvent(xcb_generic_event_t *event)
{
if (event->response_type == XCB_BUTTON_RELEASE) {
xcb_button_release_event_t *buttonEvent = reinterpret_cast<xcb_button_release_event_t*>(event);
handleButtonRelease(buttonEvent->detail, buttonEvent->child);
} else if (event->response_type == XCB_KEY_PRESS) {
xcb_key_press_event_t *keyEvent = reinterpret_cast<xcb_key_press_event_t*>(event);
handleKeyPress(keyEvent->detail, keyEvent->state);
}
}
bool WindowSelector::event(xcb_generic_event_t *event)
{
if (!m_active) {
return false;
}
processEvent(event);
return true;
}
void WindowSelector::handleButtonRelease(xcb_button_t button, xcb_window_t window)
{
if (button == XCB_BUTTON_INDEX_3) {
m_callback(nullptr);
release();
return;
}
if (button == XCB_BUTTON_INDEX_1 || button == XCB_BUTTON_INDEX_2) {
selectWindowId(window);
release();
return;
}
}
void WindowSelector::handleKeyPress(xcb_keycode_t keycode, uint16_t state)
{
xcb_key_symbols_t *symbols = xcb_key_symbols_alloc(connection());
xcb_keysym_t kc = xcb_key_symbols_get_keysym(symbols, keycode, 0);
int mx = 0;
int my = 0;
const bool returnPressed = (kc == XK_Return) || (kc == XK_space);
const bool escapePressed = (kc == XK_Escape);
if (kc == XK_Left) {
mx = -10;
}
if (kc == XK_Right) {
mx = 10;
}
if (kc == XK_Up) {
my = -10;
}
if (kc == XK_Down) {
my = 10;
}
if (state & XCB_MOD_MASK_CONTROL) {
mx /= 10;
my /= 10;
}
Cursor::setPos(Cursor::pos() + QPoint(mx, my));
if (returnPressed) {
selectWindowUnderPointer();
}
if (returnPressed || escapePressed) {
if (escapePressed) {
m_callback(nullptr);
}
release();
}
xcb_key_symbols_free(symbols);
}
void WindowSelector::selectWindowUnderPointer()
{
Xcb::Pointer pointer(rootWindow());
if (!pointer.isNull() && pointer->child != XCB_WINDOW_NONE) {
selectWindowId(pointer->child);
}
}
void WindowSelector::release()
{
ungrabXKeyboard();
xcb_ungrab_pointer(connection(), XCB_TIME_CURRENT_TIME);
ungrabXServer();
m_active = false;
m_callback = std::function<void(KWin::Toplevel*)>();
}
void WindowSelector::selectWindowId(xcb_window_t window_to_select)
{
if (window_to_select == XCB_WINDOW_NONE) {
m_callback(nullptr);
return;
}
xcb_window_t window = window_to_select;
Client* client = NULL;
while (true) {
client = Workspace::self()->findClient(Predicate::FrameIdMatch, window);
if (client) {
break; // Found the client
}
Xcb::Tree tree(window);
if (window == tree->root) {
// We didn't find the client, probably an override-redirect window
break;
}
window = tree->parent; // Go up
}
if (client) {
m_callback(client);
} else {
m_callback(Workspace::self()->findUnmanaged(window));
}
}
} // namespace

64
plugins/platforms/x11/standalone/windowselector.h Normal file
View file

@ -0,0 +1,64 @@
/********************************************************************
KWin - the KDE window manager
This file is part of the KDE project.
Copyright (C) 1999, 2000 Matthias Ettrich <ettrich@kde.org>
Copyright (C) 2003 Lubos Lunak <l.lunak@kde.org>
Copyright (C) 2012 Martin Gräßlin <mgraesslin@kde.org>
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*********************************************************************/
#ifndef KWIN_KILLWINDOW_H
#define KWIN_KILLWINDOW_H
#include "x11eventfilter.h"
#include <xcb/xcb.h>
#include <functional>
namespace KWin
{
class Toplevel;
class WindowSelector : public X11EventFilter
{
public:
WindowSelector();
~WindowSelector();
void start(std::function<void(KWin::Toplevel*)> callback, const QByteArray &cursorName);
bool isActive() const {
return m_active;
}
void processEvent(xcb_generic_event_t *event);
bool event(xcb_generic_event_t *event) override;
private:
xcb_cursor_t createCursor(const QByteArray &cursorName);
void release();
void selectWindowUnderPointer();
void handleKeyPress(xcb_keycode_t keycode, uint16_t state);
void handleButtonRelease(xcb_button_t button, xcb_window_t window);
void selectWindowId(xcb_window_t window_to_kill);
bool m_active;
std::function<void(KWin::Toplevel*)> m_callback;
};
} // namespace
#endif

9
plugins/platforms/x11/standalone/x11_platform.cpp
View file

@ -20,6 +20,7 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
#include "x11_platform.h"
#include "x11cursor.h"
#include "edge.h"
#include "windowselector.h"
#include <config-kwin.h>
#include <kwinconfig.h>
#if HAVE_EPOXY_GLX
@ -273,4 +274,12 @@ void X11StandalonePlatform::doShowCursor()
xcb_xfixes_show_cursor(kwinApp()->x11Connection(), kwinApp()->x11RootWindow());
}
void X11StandalonePlatform::startInteractiveWindowSelection(std::function<void(KWin::Toplevel*)> callback, const QByteArray &cursorName)
{
if (m_windowSelector.isNull()) {
m_windowSelector.reset(new WindowSelector);
}
m_windowSelector->start(callback, cursorName);
}
}

3
plugins/platforms/x11/standalone/x11_platform.h
View file

@ -28,6 +28,7 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
namespace KWin
{
class XInputIntegration;
class WindowSelector;
class KWIN_EXPORT X11StandalonePlatform : public Platform
{
@ -48,6 +49,7 @@ public:
QString compositingNotPossibleReason() const override;
bool openGLCompositingIsBroken() const override;
void createOpenGLSafePoint(OpenGLSafePoint safePoint) override;
void startInteractiveWindowSelection(std::function<void (KWin::Toplevel *)> callback, const QByteArray &cursorName = QByteArray()) override;
PlatformCursorImage cursorImage() const override;
@ -71,6 +73,7 @@ private:
QThread *m_openGLFreezeProtectionThread = nullptr;
QTimer *m_openGLFreezeProtection = nullptr;
Display *m_x11Display;
QScopedPointer<WindowSelector> m_windowSelector;
};

8
utils.h
View file

@ -144,11 +144,11 @@ MaximizeMode operator^(MaximizeMode m1, MaximizeMode m2)
template <typename T> using ScopedCPointer = QScopedPointer<T, QScopedPointerPodDeleter>;
void updateXTime();
void grabXServer();
void ungrabXServer();
void KWIN_EXPORT grabXServer();
void KWIN_EXPORT ungrabXServer();
bool grabbedXServer();
bool grabXKeyboard(xcb_window_t w = rootWindow());
void ungrabXKeyboard();
bool KWIN_EXPORT grabXKeyboard(xcb_window_t w = rootWindow());
void KWIN_EXPORT ungrabXKeyboard();
/**
* Small helper class which performs @link grabXServer in the ctor and