wayland_server.cpp 14.2 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20
/********************************************************************
 KWin - the KDE window manager
 This file is part of the KDE project.

Copyright (C) 2015 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 "wayland_server.h"
21
#include "client.h"
22
#include "abstract_backend.h"
23
#include "composite.h"
24
#include "screens.h"
25
#include "shell_client.h"
26
#include "workspace.h"
27

28 29 30
// Client
#include <KWayland/Client/connection_thread.h>
#include <KWayland/Client/registry.h>
31
#include <KWayland/Client/surface.h>
32
// Server
33
#include <KWayland/Server/compositor_interface.h>
34
#include <KWayland/Server/datadevicemanager_interface.h>
35
#include <KWayland/Server/display.h>
36
#include <KWayland/Server/idle_interface.h>
37
#include <KWayland/Server/output_interface.h>
38
#include <KWayland/Server/plasmashell_interface.h>
39
#include <KWayland/Server/plasmawindowmanagement_interface.h>
40
#include <KWayland/Server/qtsurfaceextension_interface.h>
41
#include <KWayland/Server/seat_interface.h>
42 43
#include <KWayland/Server/shell_interface.h>

44 45 46
// Qt
#include <QWindow>

47 48 49 50
// system
#include <sys/types.h>
#include <sys/socket.h>

51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73
using namespace KWayland::Server;

namespace KWin
{

KWIN_SINGLETON_FACTORY(WaylandServer)

WaylandServer::WaylandServer(QObject *parent)
    : QObject(parent)
{
}

WaylandServer::~WaylandServer() = default;

void WaylandServer::init(const QByteArray &socketName)
{
    m_display = new KWayland::Server::Display(this);
    if (!socketName.isNull() && !socketName.isEmpty()) {
        m_display->setSocketName(QString::fromUtf8(socketName));
    }
    m_display->start();
    m_compositor = m_display->createCompositor(m_display);
    m_compositor->create();
74 75 76 77 78 79 80 81
    connect(m_compositor, &CompositorInterface::surfaceCreated, this,
        [this] (SurfaceInterface *surface) {
            // check whether we have a Toplevel with the Surface's id
            Workspace *ws = Workspace::self();
            if (!ws) {
                // it's possible that a Surface gets created before Workspace is created
                return;
            }
82 83 84 85
            if (surface->client() != xWaylandConnection()) {
                // setting surface is only relevat for Xwayland clients
                return;
            }
86 87 88 89 90 91 92 93
            auto check = [surface] (const Toplevel *t) {
                return t->surfaceId() == surface->id();
            };
            if (Toplevel *t = ws->findToplevel(check)) {
                t->setSurface(surface);
            }
        }
    );
94 95
    m_shell = m_display->createShell(m_display);
    m_shell->create();
96 97
    connect(m_shell, &ShellInterface::surfaceCreated, this,
        [this] (ShellSurfaceInterface *surface) {
98 99 100 101
            if (!Workspace::self()) {
                // it's possible that a Surface gets created before Workspace is created
                return;
            }
102 103 104 105
            if (surface->client() == m_xwaylandConnection) {
                // skip Xwayland clients, those are created using standard X11 way
                return;
            }
106 107 108 109 110 111
            if (surface->client() == m_qtConnection) {
                // one of Qt's windows
                if (m_dummyWindowSurface && (m_dummyWindowSurface->id() == surface->surface()->id())) {
                    fakeDummyQtWindowInput();
                    return;
                }
112 113 114 115 116 117 118
                // HACK: in order to get Qt to not block for frame rendered, we immediatelly emit the
                // frameRendered once we get a new damage event.
                auto s = surface->surface();
                connect(s, &SurfaceInterface::damaged, this, [this, s] {
                    s->frameRendered(0);
                    m_qtConnection->flush();
                });
119
            }
120 121 122 123
            auto client = new ShellClient(surface);
            if (auto c = Compositor::self()) {
                connect(client, &Toplevel::needsRepaint, c, &Compositor::scheduleRepaint);
            }
124 125 126 127 128
            if (client->isInternal()) {
                m_internalClients << client;
            } else {
                m_clients << client;
            }
129 130 131 132 133 134
            if (client->readyForPainting()) {
                emit shellClientAdded(client);
            } else {
                connect(client, &ShellClient::windowShown, this,
                    [this, client] {
                        emit shellClientAdded(client);
135
                    }
136 137
                );
            }
138 139
        }
    );
140
    m_display->createShm();
141 142
    m_seat = m_display->createSeat(m_display);
    m_seat->create();
143
    m_display->createDataDeviceManager(m_display)->create();
144
    m_display->createIdle(m_display)->create();
145 146 147 148 149 150 151 152 153
    m_plasmaShell = m_display->createPlasmaShell(m_display);
    m_plasmaShell->create();
    connect(m_plasmaShell, &PlasmaShellInterface::surfaceCreated,
        [this] (PlasmaShellSurfaceInterface *surface) {
            if (ShellClient *client = findClient(surface->surface())) {
                client->installPlasmaShellSurface(surface);
            }
        }
    );
154 155 156 157 158 159 160 161 162
    m_qtExtendedSurface = m_display->createQtSurfaceExtension(m_display);
    m_qtExtendedSurface->create();
    connect(m_qtExtendedSurface, &QtSurfaceExtensionInterface::surfaceCreated,
        [this] (QtExtendedSurfaceInterface *surface) {
            if (ShellClient *client = findClient(surface->surface())) {
                client->installQtExtendedSurface(surface);
            }
        }
    );
163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203
    m_windowManagement = m_display->createPlasmaWindowManagement(m_display);
    m_windowManagement->create();
    m_windowManagement->setShowingDesktopState(PlasmaWindowManagementInterface::ShowingDesktopState::Disabled);
    connect(m_windowManagement, &PlasmaWindowManagementInterface::requestChangeShowingDesktop, this,
        [] (PlasmaWindowManagementInterface::ShowingDesktopState state) {
            if (!workspace()) {
                return;
            }
            bool set = false;
            switch (state) {
            case PlasmaWindowManagementInterface::ShowingDesktopState::Disabled:
                set = false;
                break;
            case PlasmaWindowManagementInterface::ShowingDesktopState::Enabled:
                set = true;
                break;
            default:
                Q_UNREACHABLE();
                break;
            }
            if (set == workspace()->showingDesktop()) {
                return;
            }
            workspace()->setShowingDesktop(set);
        }
    );
}

void WaylandServer::initWorkspace()
{
    if (m_windowManagement) {
        connect(workspace(), &Workspace::showingDesktopChanged, this,
            [this] (bool set) {
                using namespace KWayland::Server;
                m_windowManagement->setShowingDesktopState(set ?
                    PlasmaWindowManagementInterface::ShowingDesktopState::Enabled :
                    PlasmaWindowManagementInterface::ShowingDesktopState::Disabled
                );
            }
        );
    }
204
}
205

206 207
void WaylandServer::initOutputs()
{
208 209 210
    if (m_backend && m_backend->handlesOutputs()) {
        return;
    }
211 212 213 214
    Screens *s = screens();
    Q_ASSERT(s);
    for (int i = 0; i < s->count(); ++i) {
        OutputInterface *output = m_display->createOutput(m_display);
215
        output->setPhysicalSize(s->size(i) / 3.8);
216 217 218
        output->addMode(s->size(i));
        output->create();
    }
219 220
}

221 222 223 224 225 226 227 228
int WaylandServer::createXWaylandConnection()
{
    int sx[2];
    if (socketpair(AF_UNIX, SOCK_STREAM | SOCK_CLOEXEC, 0, sx) < 0) {
        qCWarning(KWIN_CORE) << "Could not create socket";
        return -1;
    }
    m_xwaylandConnection = m_display->createClient(sx[0]);
229 230 231 232 233
    connect(m_xwaylandConnection, &KWayland::Server::ClientConnection::disconnected, this,
        [] {
            qFatal("Xwayland Connection died");
        }
    );
234 235 236
    return sx[1];
}

237 238 239 240 241 242 243 244 245 246 247
int WaylandServer::createInputMethodConnection()
{
    int sx[2];
    if (socketpair(AF_UNIX, SOCK_STREAM | SOCK_CLOEXEC, 0, sx) < 0) {
        qCWarning(KWIN_CORE) << "Could not create socket";
        return -1;
    }
    m_inputMethodServerConnection = m_display->createClient(sx[0]);
    return sx[1];
}

248 249 250 251 252 253 254 255 256 257 258
int WaylandServer::createQtConnection()
{
    int sx[2];
    if (socketpair(AF_UNIX, SOCK_STREAM | SOCK_CLOEXEC, 0, sx) < 0) {
        qCWarning(KWIN_CORE) << "Could not create socket";
        return -1;
    }
    m_qtConnection = m_display->createClient(sx[0]);
    return sx[1];
}

259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284
void WaylandServer::createInternalConnection()
{
    int sx[2];
    if (socketpair(AF_UNIX, SOCK_STREAM | SOCK_CLOEXEC, 0, sx) < 0) {
        qCWarning(KWIN_CORE) << "Could not create socket";
        return;
    }
    m_internalConnection.server = m_display->createClient(sx[0]);
    using namespace KWayland::Client;
    m_internalConnection.client = new ConnectionThread(this);
    m_internalConnection.client->setSocketFd(sx[1]);
    connect(m_internalConnection.client, &ConnectionThread::connected, this,
        [this] {
            Registry *registry = new Registry(m_internalConnection.client);
            registry->create(m_internalConnection.client);
            connect(registry, &Registry::shmAnnounced, this,
                [this, registry] (quint32 name, quint32 version) {
                    m_internalConnection.shm = registry->createShmPool(name, version, m_internalConnection.client);
                }
            );
            registry->setup();
        }
    );
    m_internalConnection.client->initConnection();
}

285 286 287 288 289 290 291 292 293 294 295 296
void WaylandServer::installBackend(AbstractBackend *backend)
{
    Q_ASSERT(!m_backend);
    m_backend = backend;
}

void WaylandServer::uninstallBackend(AbstractBackend *backend)
{
    Q_ASSERT(m_backend == backend);
    m_backend = nullptr;
}

297 298 299
void WaylandServer::removeClient(ShellClient *c)
{
    m_clients.removeAll(c);
300
    m_internalClients.removeAll(c);
301 302 303
    emit shellClientRemoved(c);
}

304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334
void WaylandServer::createDummyQtWindow()
{
    if (m_dummyWindow) {
        return;
    }
    m_dummyWindow.reset(new QWindow());
    m_dummyWindow->setSurfaceType(QSurface::RasterSurface);
    m_dummyWindow->show();
    m_dummyWindowSurface = KWayland::Client::Surface::fromWindow(m_dummyWindow.data());
}

void WaylandServer::fakeDummyQtWindowInput()
{
    // we need to fake Qt into believing it has got any seat events
    // this is done only when receiving either a key press or button.
    // we simulate by sending a button press and release
    auto surface = KWayland::Server::SurfaceInterface::get(m_dummyWindowSurface->id(), m_qtConnection);
    if (!surface) {
        return;
    }
    const auto oldSeatSurface = m_seat->focusedPointerSurface();
    const auto oldPos = m_seat->focusedPointerSurfacePosition();
    m_seat->setFocusedPointerSurface(surface, QPoint(0, 0));
    m_seat->setPointerPos(QPointF(0, 0));
    m_seat->pointerButtonPressed(Qt::LeftButton);
    m_seat->pointerButtonReleased(Qt::LeftButton);
    m_qtConnection->flush();
    m_dummyWindow->hide();
    m_seat->setFocusedPointerSurface(oldSeatSurface, oldPos);
}

335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350
void WaylandServer::dispatch()
{
    if (!m_display) {
        return;
    }
    if (!m_qtClientConnection) {
        if (m_qtConnection && QGuiApplication::instance()) {
            m_qtClientConnection = KWayland::Client::ConnectionThread::fromApplication(this);
        }
    }
    if (m_qtClientConnection) {
        m_qtClientConnection->flush();
    }
    m_display->dispatchEvents(0);
}

351
static ShellClient *findClientInList(const QList<ShellClient*> &clients, quint32 id)
352
{
353
    auto it = std::find_if(clients.begin(), clients.end(),
354 355 356 357
        [id] (ShellClient *c) {
            return c->windowId() == id;
        }
    );
358
    if (it == clients.end()) {
359 360 361 362 363
        return nullptr;
    }
    return *it;
}

364 365 366 367 368 369 370 371 372 373 374 375 376
static ShellClient *findClientInList(const QList<ShellClient*> &clients, KWayland::Server::SurfaceInterface *surface)
{
    auto it = std::find_if(clients.begin(), clients.end(),
        [surface] (ShellClient *c) {
            return c->surface() == surface;
        }
    );
    if (it == clients.end()) {
        return nullptr;
    }
    return *it;
}

377 378 379 380 381 382 383 384 385 386 387 388 389 390
ShellClient *WaylandServer::findClient(quint32 id) const
{
    if (id == 0) {
        return nullptr;
    }
    if (ShellClient *c = findClientInList(m_clients, id)) {
        return c;
    }
    if (ShellClient *c = findClientInList(m_internalClients, id)) {
        return c;
    }
    return nullptr;
}

391 392 393 394 395 396 397 398 399 400 401 402 403 404
ShellClient *WaylandServer::findClient(SurfaceInterface *surface) const
{
    if (!surface) {
        return nullptr;
    }
    if (ShellClient *c = findClientInList(m_clients, surface)) {
        return c;
    }
    if (ShellClient *c = findClientInList(m_internalClients, surface)) {
        return c;
    }
    return nullptr;
}

405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446
quint32 WaylandServer::createWindowId(SurfaceInterface *surface)
{
    auto it = m_clientIds.constFind(surface->client());
    quint16 clientId = 0;
    if (it != m_clientIds.constEnd()) {
        clientId = it.value();
    } else {
        clientId = createClientId(surface->client());
    }
    Q_ASSERT(clientId != 0);
    quint32 id = clientId;
    // TODO: this does not prevent that two surfaces of same client get same id
    id = (id << 16) | (surface->id() & 0xFFFF);
    if (findClient(id)) {
        qCWarning(KWIN_CORE) << "Invalid client windowId generated:" << id;
        return 0;
    }
    return id;
}

quint16 WaylandServer::createClientId(ClientConnection *c)
{
    auto ids = m_clientIds.values().toSet();
    quint16 id = 1;
    if (!ids.isEmpty()) {
        for (quint16 i = ids.count() + 1; i >= 1 ; i--) {
            if (!ids.contains(i)) {
                id = i;
                break;
            }
        }
    }
    Q_ASSERT(!ids.contains(id));
    m_clientIds.insert(c, id);
    connect(c, &ClientConnection::disconnected, this,
        [this] (ClientConnection *c) {
            m_clientIds.remove(c);
        }
    );
    return id;
}

447
}