summaryrefslogtreecommitdiffstats
path: root/src/input/inputEvent.h
blob: f9d32255f58b111e745b706a00f55a04e292cde5 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
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
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
/*
 # Copyright (c) 2009 - OpenSLX Project, Computer Center University of Freiburg
 #
 # This program is free software distributed under the GPL version 2.
 # See http://openslx.org/COPYING
 #
 # If you have any feedback please consult http://openslx.org/feedback and
 # send your suggestions, praise, or complaints to feedback@openslx.org
 #
 # General information about OpenSLX can be found at http://openslx.org/
 # --------------------------------------------------------------------------
 # inputEvent.h:
 #  - Definition of an input event
 # --------------------------------------------------------------------------
 */

#ifndef INPUTEVENT_H_
#define INPUTEVENT_H_

#include <cassert>
#include <QCoreApplication> // for translation
#include <QString>

#ifndef __linux
# error "This will only run on a Linux system. Porting is required for other systems."
#endif

struct QDataStream;
struct QString;
struct QMouseEvent;
struct QKeyEvent;

class InputEvent
{
private:
	friend QDataStream& operator<<(QDataStream&, InputEvent const&);
	friend QDataStream& operator>>(QDataStream&, InputEvent&);

	friend void eventToString(InputEvent const& evt, QString& str);
	friend bool eventFromString(QString const& str, InputEvent& evt);

	quint16 _type;
	quint16 _code;
	quint32 _value;

	// InputEvents are immutable. Prohibit assignment:
	InputEvent& operator=(InputEvent const&); // There intentionally is no implementation.

public:
	InputEvent(quint16 type, quint16 code, quint32 value = 0) : _type(type), _code(code), _value(value)
	{
	}

	InputEvent(InputEvent const& other) : _type(other._type), _code(other._code), _value(other._value)
	{
	}

	InputEvent()
	{
	}

	static InputEvent mouseMotion(quint16 x, quint16 y)
	{
		return InputEvent(ET_POINTER, 0, ((quint32)x << 16) | y);
	}

	static quint16 mouseButtonsFromQt(int b);

	static InputEvent mousePressRelease(int button, int buttons);
	static InputEvent keyboardPress(int key, int mods);
	static InputEvent keyboardRelease(int key, int mods);

	static const quint16 ET_KEY = 0;
	static const quint16 ET_BUTTON = 1;
	static const quint16 ET_POINTER = 2;
	static const quint16 ET_SPECIAL = 3;

	static const quint16 EC_PRESS = 0;
	static const quint16 EC_RELEASE = 1;
	static const quint16 EC_REBOOT = 2;
	static const quint16 EC_SYSRQ = 3;
	static const quint16 EC_KILL_X = 4;
	static const quint16 EC_SAY_HELLO = 5; //< for debugging purposes

	typedef quint32 event_key;

	typedef quint32 event_key_modifiers;

	static const quint16 EB_LEFT = 1;
	static const quint16 EB_MIDDLE = 2;
	static const quint16 EB_RIGHT = 4;

	static const quint32 MODIFIER_MASK =
			0x7e000000;

	quint16 type() const
	{
		return _type;
	}

	quint16 code() const
	{
		return _code;
	}

	quint32 value() const
	{
		return _value;
	}

	bool isKeyboard() const
	{
		return _type == ET_KEY;
	}

	bool isButton() const
	{
		return _type == ET_BUTTON;
	}

	bool isPointer() const
	{
		return _type == ET_POINTER;
	}

	bool isSpecial() const
	{
		return _type == ET_SPECIAL;
	}

	bool isPress() const
	{
		return _code == EC_PRESS;
	}

	bool isRelease() const
	{
		return _code == EC_RELEASE;
	}

	quint16 pressedButton() const
	{
		assert(_type == ET_BUTTON);
		return (_value >> 16);
	}

	quint16 heldButtons() const
	{
		assert(_type == ET_BUTTON);
		return (_value & 0xffff);
	}

	quint16 xCoord() const
	{
		assert(_type == ET_POINTER);
		return (_value >> 16);
	}

	quint16 yCoord() const
	{
		assert(_type == ET_POINTER);
		return (_value & 0xffff);
	}

	static QString typeToString(quint16 type)
	{
		switch(type)
		{
		case ET_BUTTON:
			return "BUTTON";
		case ET_KEY:
			return "KEY";
		case ET_POINTER:
			return "POINTER";
		case ET_SPECIAL:
			return "SPECIAL";
		default:
			return QString::number(type, 16);
		}
	}

	static QString codeToString(quint16 code)
	{
		switch(code)
		{
		case EC_PRESS:
			return "PRESS";
		case EC_RELEASE:
			return "RELEASE";
		case EC_SYSRQ:
			return "SYSRQ";
		case EC_REBOOT:
			return "REBOOT";
		case EC_KILL_X:
			return "KILL_X";
		default:
			return QString::number(code, 16);
		}
	}

	QString toString() const
	{
		return QString("%1:%2:%3").arg(typeToString(_type)).arg(codeToString(_code)).arg(_value, 8, 16, QLatin1Char('0'));
	}

	quint32 qtKeysym() const
	{
		return _value & ~MODIFIER_MASK;
	}

	quint32 qtModifiers() const
	{
		return _value & MODIFIER_MASK;
	}

	// We want to enable InputEvent as a translation context, so we fake the tr method:
	static QString tr(const char* string)
	{
		return QCoreApplication::translate("InputEvent", string);
	}
};

struct SpecialInputEventDescription
{
	SpecialInputEventDescription(quint16 type, quint16 code, quint32 value, QString const& description_)
		: type(type), code(code), value(value), description(description_)
	{
	}

	quint16 type;
	quint16 code;
	quint32 value;
	QString description;

	InputEvent toEvent() const
	{
		return InputEvent(type, code, value);
	}

	static QList<SpecialInputEventDescription> describeSpecialEvents();
};

#endif /* INPUTEVENT_H_ */