Differential D26858 Diff 77861 src/server/tablet_interface.h

Changeset View

Standalone View

View Options

src/server/tablet_interface.h

  • This file was added.
1​/********************************************************************
2​Copyright 2019 Aleix Pol Gonzalez <aleixpol@kde.org>
3​
4​This library is free software; you can redistribute it and/or
5​modify it under the terms of the GNU Lesser General Public
6​License as published by the Free Software Foundation; either
7​version 2.1 of the License, or (at your option) version 3, or any
8​later version accepted by the membership of KDE e.V. (or its
9​successor approved by the membership of KDE e.V.), which shall
10​act as a proxy defined in Section 6 of version 3 of the license.
11​
12​This library is distributed in the hope that it will be useful,
13​but WITHOUT ANY WARRANTY; without even the implied warranty of
14​MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15​Lesser General Public License for more details.
16​
17​You should have received a copy of the GNU Lesser General Public
18​License along with this library. If not, see <http://www.gnu.org/licenses/>.
19​*********************************************************************/
20​#ifndef WAYLAND_SERVER_TABLET_INTERFACE_H
21​#define WAYLAND_SERVER_TABLET_INTERFACE_H
22​
23​#include <KWayland/Server/kwaylandserver_export.h>
24​#include <QVector>
25​
26​#include "resource.h"
27​
28​namespace KWayland
29​{
30​namespace Server
31​{
32​class TabletSeatInterface;
33​class Display;
34​class SeatInterface;
35​class SurfaceInterface;
36​class TabletInterface;
37​
38​/**
39​ * This is an implementation of wayland-protocols/unstable/tablet/tablet-unstable-v2.xml
40​ *
41​ * This class is just the means to get a @class TabletSeatInterface, which is
42​ * the class that will have all of the information we need.
43​ *
44​ * @since 5.69
45​ */
46​
zzagUnsubmitted
Not Done

This revision seems to be incomplete. I don't see where TabletManagerInterface was introduced.

zzag: This revision seems to be incomplete. I don't see where `TabletManagerInterface` was introduced.
47​class KWAYLANDSERVER_EXPORT TabletManagerInterface : public QObject
48​{
49​ Q_OBJECT
50​public:
51​ virtual ~TabletManagerInterface();
52​
53​ TabletSeatInterface *seat(SeatInterface *seat) const;
zzagUnsubmitted
Done

Wrong pointer alignment.

zzag: Wrong pointer alignment.
54​
55​private:
56​ friend class Display;
57​ explicit TabletManagerInterface(Display *d, QObject *parent);
58​ class Private;
59​ QScopedPointer<Private> d;
60​};
61​
62​class KWAYLANDSERVER_EXPORT TabletToolInterface : public QObject
63​{
64​ Q_OBJECT
65​public:
66​ virtual ~TabletToolInterface();
67​
68​ enum Type {
69​ Pen = 0x140, ///< Pen
70​ Eraser = 0x141, ///< Eraser
71​ Brush = 0x142, ///< Brush
72​ Pencil = 0x143, ///< Pencil
73​ Airbrush = 0x144, ///< Airbrush
74​ Finger = 0x145, ///< Finger
75​ Mouse = 0x146, ///< Mouse
76​ Lens = 0x147, ///< Lens
77​ Totem
78​ };
79​ Q_ENUM(Type)
Lint: unknownMacro

There is an unknown macro here somewhere. Configuration is required. If Q_ENUM is a macro then please configure it.

Lint: unknownMacro: There is an unknown macro here somewhere. Configuration is required. If Q_ENUM is a macro then…
Lint: unknownMacro

There is an unknown macro here somewhere. Configuration is required. If Q_ENUM is a macro then please configure it.

Lint: unknownMacro: There is an unknown macro here somewhere. Configuration is required. If Q_ENUM is a macro then…
Lint: unknownMacro

There is an unknown macro here somewhere. Configuration is required. If Q_ENUM is a macro then please configure it.

Lint: unknownMacro: There is an unknown macro here somewhere. Configuration is required. If Q_ENUM is a macro then…
Lint: unknownMacro

There is an unknown macro here somewhere. Configuration is required. If Q_ENUM is a macro then please configure it.

Lint: unknownMacro: There is an unknown macro here somewhere. Configuration is required. If Q_ENUM is a macro then…
80​
81​ enum Capability {
82​ Tilt = 1, ///< Tilt axeis
83​ Pressure = 2, ///< Pressure axis
84​ Distance = 3, ///< Distance axis
85​ Rotation = 4, ///< Z-rotation axis
86​ Slider = 5, ///< Slider axis
87​ Wheel = 6 ///< Wheel axis
88​ };
89​ Q_ENUM(Capability)
90​
91​ /**
92​ * Sets the surface the events will be sent to.
93​ *
94​ * Make sure the surface supports being sent events to.
95​ *
96​ * @see TabletInterface::isSurfaceSupported
97​ */
98​ void setCurrentSurface(SurfaceInterface *surface);
99​ bool isClientSupported() const;
100​
101​ void sendRemoved();
102​ void sendProximityIn(TabletInterface *tablet);
103​ void sendProximityOut();
104​ void sendUp();
105​ void sendDown();
106​ void sendPressure(quint32 pressure);
107​ void sendDistance(quint32 distance);
108​ void sendTilt(qreal degreesX, qreal degreesY);
109​ void sendRotation(qreal degrees);
110​ void sendSlider(qint32 position);
111​ void sendWheel(qint32 degrees, qint32 clicks);
112​ void sendButton(quint32 button, bool pressed);
113​ void sendFrame(quint32 time);
114​ void sendMotion(const QPointF &pos);
115​
116​private:
117​ friend class TabletSeatInterface;
118​ explicit TabletToolInterface(Display *display, Type type, quint32 hsh, quint32 hsl, quint32 hih, quint32 hil, const QVector<Capability> &capability, QObject *parent);
119​ class Private;
120​ QScopedPointer<Private> d;
121​};
122​
zzagUnsubmitted
Done

This method lacks documentation. At first, I thought that it returns the wl_resource for a wl_surface. However, the best thing would be not to leak wl_resource to the public API at all.

zzag: This method lacks documentation. At first, I thought that it returns the `wl_resource` for a…
123​class KWAYLANDSERVER_EXPORT TabletInterface : public QObject
124​{
125​ Q_OBJECT
126​public:
127​ virtual ~TabletInterface();
zzagUnsubmitted
Done

Put a single space before *.

zzag: Put a single space before `*`.
128​
129​ /**
130​ * @returns true if the surface has been bound to the tablet.
131​ */
132​ bool isSurfaceSupported(SurfaceInterface *surface) const;
133​
134​ void sendRemoved();
135​
136​private:
137​ friend class TabletSeatInterface;
138​ friend class TabletToolInterface;
139​ explicit TabletInterface(quint32 vendorId, quint32 productId, const QString &name, const QStringList &paths, QObject *parent);
140​ class Private;
141​ QScopedPointer<Private> d;
142​};
143​
144​class KWAYLANDSERVER_EXPORT TabletSeatInterface : public QObject
145​{
146​ Q_OBJECT
zzagUnsubmitted
Done

Align pointers to right.

zzag: Align pointers to right.
147​public:
148​ virtual ~TabletSeatInterface();
149​
150​ TabletInterface *addTablet(quint32 vendorId, quint32 productId, const QString &sysname, const QString &name, const QStringList &paths);
151​ TabletToolInterface *addTool(TabletToolInterface::Type type, quint64 hardwareSerial, quint64 hardwareId, const QVector<TabletToolInterface::Capability> &capabilities);
152​
153​ TabletToolInterface *toolByHardwareId(quint64 hardwareId) const;
154​ TabletToolInterface *toolByHardwareSerial(quint64 hardwareSerial) const;
155​ TabletInterface *tabletByName(const QString &sysname) const;
156​
157​ void removeTablet(const QString &sysname);
158​
159​private:
160​ friend class TabletManagerInterface;
161​ explicit TabletSeatInterface(Display *display, QObject *parent);
162​ class Private;
163​ QScopedPointer<Private> d;
164​};
165​
166​}
167​}
168​
169​Q_DECLARE_METATYPE(KWayland::Server::TabletSeatInterface *)
170​
171​#endif