Differential D1989 Diff 5781 plugins/qml/kwinqml/kwinqml.cpp

Changeset View

Standalone View

View Options

plugins/qml/kwinqml/kwinqml.cpp

  • This file was added.
1​/********************************************************************
2​Copyright (C) 2016 Bhavisha Dhruve <bhavishadhruve@gmail.com>
3​
4​This program is free software; you can redistribute it and/or modify
5​it under the terms of the GNU General Public License as published by
6​the Free Software Foundation; either version 2 of the License, or
7​(at your option) any later version.
8​
9​This program is distributed in the hope that it will be useful,
10​but WITHOUT ANY WARRANTY; without even the implied warranty of
11​MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12​GNU General Public License for more details.
13​
14​You should have received a copy of the GNU General Public License
15​along with this program. If not, see <http://www.gnu.org/licenses/>.
16​*********************************************************************/
17​
18​#include "config-kwin.h"
19​#include "kwinqml.h"
20​#include <KWayland/Server/display.h>
21​#include <KWayland/Server/seat_interface.h>
22​#include <KWayland/Server/compositor_interface.h>
23​#include <KWayland/Server/shell_interface.h>
24​#include <KWayland/Server/surface_interface.h>
25​#include <KWayland/Server/buffer_interface.h>
26​
27​#include <QCoreApplication>
28​#include <QElapsedTimer>
29​#include <QTimer>
30​#include <QProcess>
31​#include <QSGSimpleTextureNode>
32​#include <QQuickWindow>
bshahUnsubmitted
Done

Coding style.

bshah: Coding style.
33​
34​// system
35​#include <unistd.h>
36​#include <sys/types.h>
graesslinUnsubmitted
Done

the call to the parent class is missing

graesslin: the call to the parent class is missing
37​#include <sys/socket.h>
38​#include <kwindowsystem.h>
39​
40​using namespace KWayland::Server;
41​
42​KWinQml::KWinQml(QQuickItem *parent)
43​ : QQuickItem(parent)
44​ , m_timeSinceStart(new QElapsedTimer)
davidedmundsonUnsubmitted
Not Done

this timer doesn't do anything, it's not started.

davidedmundson: this timer doesn't do anything, it's not started.
45​{
46​ setFlag(QQuickItem::ItemHasContents, true);
47​ this->setAcceptedMouseButtons(Qt::AllButtons);
48​ setFlag(QQuickItem::ItemAcceptsInputMethod, true);
graesslinUnsubmitted
Done

why check isNull and isEmpty?

graesslin: why check isNull and isEmpty?
49​ setFlag(QQuickItem::ItemIsFocusScope, true);
50​ this->setAcceptHoverEvents(true);
graesslinUnsubmitted
Done

actually we don't need that. The socketName is for the kwin process which we start. Our Display in this class is set to ConnectClientsOnly, thus it won't create a socket.

graesslin: actually we don't need that. The socketName is for the kwin process which we start. Our Display…
51​
52​}
53​
54​KWinQml::~KWinQml()
55​{
56​ stop();
57​}
graesslinUnsubmitted
Done

you also need to call create on m_shell.

graesslin: you also need to call create on m_shell.
58​
59​void KWinQml::start()
60​{
61​ Q_ASSERT(!m_display);
62​ m_display = new Display(this);
63​ m_display->start(Display::StartMode::ConnectClientsOnly);
64​ m_display->createShm();
graesslinUnsubmitted
Done

don't use qDebug, please use categorized logging.

graesslin: don't use qDebug, please use categorized logging.
bshahUnsubmitted
Done

I'd say just remove this and debug statement below, they can get noisy, because it will be triggered at every frame repaint.

bshah: I'd say just remove this and debug statement below, they can get noisy, because it will be…
65​ m_display->createCompositor()->create();
66​ m_seat = m_display->createSeat(m_display);
67​ m_seat->setHasPointer(true);
68​ m_seat->setHasKeyboard(true);
69​ m_seat->setHasTouch(true);
graesslinUnsubmitted
Not Done

ideally you don't need to repaint everything, but could just update the actual changed areas (carried in the damaged signal)

graesslin: ideally you don't need to repaint everything, but could just update the actual changed areas…
bdhruveAuthorUnsubmitted
Not Done

I am not much knowledgeable about how to render only specific area in QtQuick, i tried to search for it, but couldn't find anything related to it.

bdhruve: I am not much knowledgeable about how to render only specific area in QtQuick, i tried to…
70​ m_seat->create();
71​ m_shell = m_display->createShell(m_display);
72​ m_shell->create();
73​ connect(m_shell, &ShellInterface::surfaceCreated, this,
74​ [this] (ShellSurfaceInterface *shellSurface) {
graesslinUnsubmitted
Done

There's one more env variable we should pass to the environment:
KWIN_COMPOSE=Q

In the long run we won't need that, but for the moment I think it makes our life easier. It forces the compositor to use QPainter instead of OpenGL, thus integrating the rendering will be way easier.

graesslin: There's one more env variable we should pass to the environment: KWIN_COMPOSE=Q In the long…
75​ m_surface = shellSurface->surface();
76​ m_seat->setFocusedKeyboardSurface(m_surface);
bshahUnsubmitted
Done

Somehow seems you removed code for passing socket through WAYLAND_SOCKET environment variable and passing of --xwayland argument from this code. which was in previous revisions..

bshah: Somehow seems you removed code for passing socket through WAYLAND_SOCKET environment variable…
77​ m_seat->setFocusedPointerSurface(m_surface);
78​ connect(m_surface, &SurfaceInterface::damaged, this,
79​ [this] () {
80​ update();
graesslinUnsubmitted
Done

Please parse the arguments as:

QStringList arguments{QStringLiteral("--xwayland"), QStringLiteral("--socket"), m_socketName};

That way the list can be constructed in one go and not need to be appended multiple times.

graesslin: Please parse the arguments as: ``` QStringList arguments{QStringLiteral("--xwayland")…
81​ m_surface->frameRendered(m_timeSinceStart->elapsed());
graesslinUnsubmitted
Done

I think we need to pass a few more arguments:

  • --width
  • --height

with the values set to the size of this argument.

graesslin: I think we need to pass a few more arguments: - --width - --height with the values set…
82​ }
graesslinUnsubmitted
Done

we also need to pass at least --socket with a useful name. Otherwise it cannot be started in a Wayland session.

graesslin: we also need to pass at least --socket with a useful name. Otherwise it cannot be started in a…
graesslinUnsubmitted
Done

how is this instance being terminated again?

graesslin: how is this instance being terminated again?
83​ );
84​ }
85​ );
86​ // output
87​ auto output = m_display->createOutput(m_display);
88​ const QSize size(height(), width());
89​ output->setGlobalPosition(QPoint(0, 0));
90​ output->setPhysicalSize(size / 3.8);
91​ output->addMode(size);
92​ output->create();
93​
94​ int sx[2];
95​ if (socketpair(AF_UNIX, SOCK_STREAM | SOCK_CLOEXEC, 0, sx) < 0) {
96​ return;
97​ }
98​ m_display->createClient(sx[0]);
99​ int socket = dup(sx[1]);
100​ if (socket == -1) {
101​ return;
102​ }
103​ m_kwinWaylandProcess = new QProcess(this);
104​ m_kwinWaylandProcess->setProcessChannelMode(QProcess::ForwardedChannels);
105​ QProcessEnvironment environment = QProcessEnvironment::systemEnvironment();
106​ environment.insert(QStringLiteral("WAYLAND_SOCKET"), QString::fromUtf8(QByteArray::number(socket)));
107​ environment.insert(QStringLiteral("KWIN_COMPOSE"), QStringLiteral("Q"));
graesslinUnsubmitted
Done

please watch coding style

graesslin: please watch coding style
108​ m_kwinWaylandProcess->setProcessEnvironment(environment);
109​ m_kwinWaylandProcess->setProcessChannelMode(QProcess::ForwardedChannels);
110​ QStringList arguments{QStringLiteral("--xwayland"),
111​ QStringLiteral("--socket"), m_socketName,
112​ QStringLiteral("--width"), QString::number(width()),
113​ QStringLiteral("--height"), QString::number(height())};
graesslinUnsubmitted
Done

you cannot just assume that there's a buffer attached to the surface. Please perform a nullptr check

graesslin: you cannot just assume that there's a buffer attached to the surface. Please perform a nullptr…
114​ m_kwinWaylandProcess->start(QStringLiteral(KWIN_WAYLAND_BINARY_PATH), arguments);
bshahUnsubmitted
Done

You need to move this out of the if statement, otherwise only first frame will be rendered.

bshah: You need to move this out of the if statement, otherwise only first frame will be rendered.
115​}
116​
117​QSGNode *KWinQml::updatePaintNode(QSGNode *node, UpdatePaintNodeData *)
118​{
119​ if (!m_surface) {
120​ return node;
121​ }
122​ if (m_surface->buffer() == nullptr) {
123​ return node;
124​ }
125​ QSGSimpleTextureNode *n = static_cast<QSGSimpleTextureNode *>(node);
126​ if (!n) {
127​ n = new QSGSimpleTextureNode();
128​ }
129​ delete(m_texture);
130​ m_texture = nullptr;
131​ m_texture = window()->createTextureFromImage(m_surface->buffer()->data());
davidedmundsonUnsubmitted
Not Done

This texture leaks when this item is destroyed

davidedmundson: This texture leaks when this item is destroyed
132​ n->setTexture(m_texture);
133​ n->setRect(boundingRect());
134​ return n;
135​}
136​
137​void KWinQml::mousePressEvent(QMouseEvent *event)
138​{
139​ if (m_seat != nullptr) {
140​ m_seat->pointerButtonPressed(event->button());
141​ }
142​}
143​
144​void KWinQml::mouseReleaseEvent(QMouseEvent *event)
145​{
146​ if (m_seat != nullptr) {
147​ m_seat->pointerButtonReleased(event->button());
148​ }
149​}
150​
151​void KWinQml::keyPressEvent(QKeyEvent *event)
152​{
153​ if (m_seat != nullptr) {
154​ const int magicOffset = KWindowSystem:: isPlatformX11() ? 8 : 0;
graesslinUnsubmitted
Done

only do that on X11, if we are on Wayland that would be wrong. So do something like:

const int magicOffset = KWindowSystem::isPlatformX11() ? 8 : 0;
m_seat->keyPressed(event->nativeScanCode() - magicOffset);

And I'm glad it was the 8 issue, luckily I remembered that - having stumbled over this weirdness myself in the past.

graesslin: only do that on X11, if we are on Wayland that would be wrong. So do something like: const…
155​ m_seat->keyPressed(event->nativeScanCode() - magicOffset);
156​ }
157​}
158​
159​void KWinQml::keyReleaseEvent(QKeyEvent *event)
160​{
161​ if (m_seat != nullptr) {
162​ const int magicOffset = KWindowSystem:: isPlatformX11() ? 8 : 0;
163​ m_seat->keyReleased(event->nativeScanCode() - magicOffset);
164​ }
165​}
166​
167​void KWinQml::hoverMoveEvent(QHoverEvent *event)
168​{
169​ if (m_seat != nullptr) {
170​ m_seat->setPointerPos(event->pos());
davidedmundsonUnsubmitted
Not Done

you also want:

m_seat->setTimestamp(event->timestamp());

in all of these

and there's a wheelEvent(QWheelEvent*) that should be forwarded.

davidedmundson: you also want: m_seat->setTimestamp(event->timestamp()); in all of these and there's a…
171​ }
172​}
173​
174​void KWinQml::stop()
175​{
176​ m_kwinWaylandProcess->terminate();
177​}