Differential D26858 Diff 74241 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​
33​class TabletSeatInterface;
34​class Display;
35​class SeatInterface;
36​class SurfaceInterface;
37​class TabletInterface;
38​
39​/**
40​ * This is an implementation of wayland-protocols/unstable/tablet/tablet-unstable-v2.xml
41​ *
42​ * This class is just the means to get a @class TabletSeatInterface, which is
43​ * the class that will have all of the information we need.
44​ *
45​ * @since 5.67
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​
48​class KWAYLANDSERVER_EXPORT TabletManagerInterface : public QObject
49​{
50​ Q_OBJECT
51​public:
52​ virtual ~TabletManagerInterface();
53​
zzagUnsubmitted
Done

Wrong pointer alignment.

zzag: Wrong pointer alignment.
54​ TabletSeatInterface *seat(SeatInterface *seat) const;
55​
56​private:
57​ friend class Display;
58​ explicit TabletManagerInterface(Display *d, QObject *parent);
59​ class Private;
60​ QScopedPointer<Private> d;
61​};
62​
63​class KWAYLANDSERVER_EXPORT TabletToolInterface : public QObject
64​{
65​ Q_OBJECT
66​public:
67​ virtual ~TabletToolInterface();
68​
69​ enum Type {
70​ Pen = 0x140, ///< Pen
71​ Eraser = 0x141, ///< Eraser
72​ Brush = 0x142, ///< Brush
73​ Pencil = 0x143, ///< Pencil
74​ Airbrush = 0x144, ///< Airbrush
75​ Finger = 0x145, ///< Finger
76​ Mouse = 0x146, ///< Mouse
77​ Lens = 0x147, ///< Lens
78​ Totem
79​ };
80​ 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…
81​
82​ enum Capability {
83​ Tilt = 1, ///< Tilt axeis
84​ Pressure = 2, ///< Pressure axis
85​ Distance = 3, ///< Distance axis
86​ Rotation = 4, ///< Z-rotation axis
87​ Slider = 5, ///< Slider axis
88​ Wheel = 6 ///< Wheel axis
89​ };
90​ Q_ENUM(Capability)
91​
92​ /**
93​ * Sets the surface the events will be sent to.
94​ *
95​ * Make sure the surface supports being sent events to.
96​ *
97​ * @see TabletInterface::isSurfaceSupported
98​ */
99​ void setCurrentSurface(SurfaceInterface *surface);
100​ bool isClientSupported() const;
101​
102​ void sendRemoved();
103​ void sendProximityIn(TabletInterface *tablet);
104​ void sendProximityOut();
105​ void sendUp();
106​ void sendDown();
107​ void sendPressure(quint32 pressure);
108​ void sendDistance(quint32 distance);
109​ void sendTilt(qreal degreesX, qreal degreesY);
110​ void sendRotation(qreal degrees);
111​ void sendSlider(qint32 position);
112​ void sendWheel(qint32 degrees, qint32 clicks);
113​ void sendButton(quint32 button, bool pressed);
114​ void sendFrame(quint32 time);
115​ void sendMotion(const QPointF &pos);
116​
117​private:
118​ friend class TabletSeatInterface;
119​ explicit TabletToolInterface(Display *display, Type type, quint32 hsh, quint32 hsl, quint32 hih, quint32 hil, const QVector<Capability> &capability, QObject *parent);
120​ class Private;
121​ QScopedPointer<Private> d;
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​
124​class KWAYLANDSERVER_EXPORT TabletInterface : public QObject
125​{
126​ Q_OBJECT
127​public:
zzagUnsubmitted
Done

Put a single space before *.

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

Align pointers to right.

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