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
|
/* ScummVM - Graphic Adventure Engine
*
* ScummVM is the legal property of its developers, whose names
* are too numerous to list here. Please refer to the COPYRIGHT
* file distributed with this source distribution.
*
* 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, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*
* $URL$
* $Id$
*
*/
#ifndef COMMON_HARDWARE_KEY_H
#define COMMON_HARDWARE_KEY_H
#include "common/scummsys.h"
#ifdef ENABLE_KEYMAPPER
#include "backends/keymapper/types.h"
namespace Common {
#define HWKEY_ID_SIZE (30)
// Structure for describing specific key+modifier combos mapped to actions,
// to allow for modifiers to work properly without having to define the whole
// hardware key set an additional time for each possible modifier combination
struct ActionKey {
KeyCode keycode;
byte flags;
/** unique id used for saving/loading to config */
char actKeyId[HWKEY_ID_SIZE];
/** Human readable description */
String description;
};
/**
* Describes an available hardware key
*/
struct HardwareKey {
/** unique id used for saving/loading to config */
char hwKeyId[HWKEY_ID_SIZE];
/** Human readable description */
String description;
/**
* The KeyState that is generated by the back-end
* when this hardware key is pressed.
*/
KeyState key;
KeyType type;
ActionType preferredAction;
// Mask of modifiers that can possibly apply to this key.
uint32 modMask;
HardwareKey(const char *i, KeyState ky = KeyState(), String desc = "",
KeyType typ = kGenericKeyType, ActionType prefAct = kGenericActionType, uint32 mods = ~0)
: key(ky), description(desc), type(typ), preferredAction(prefAct), modMask(mods) {
assert(i);
strncpy(hwKeyId, i, HWKEY_ID_SIZE);
}
};
/**
* Describes an available hardware modifier
*/
struct HardwareMod {
/** unique id used for saving/loading to config */
char hwModId[HWKEY_ID_SIZE];
/** Human readable description */
String description;
/**
* The modifier flags that are generated by the
* back-end when this modifier key is pressed.
*/
byte modFlags;
HardwareMod(const char *i, byte mf, String desc = "")
: modFlags(mf), description(desc) {
assert(i);
strncpy(hwModId, i, HWKEY_ID_SIZE);
}
};
/**
* Simple class to encapsulate a device's set of HardwareKeys.
* Each device should instantiate this and call addHardwareKey a number of times
* in its constructor to define the device's available keys.
*/
class HardwareKeySet {
public:
virtual ~HardwareKeySet() {
List<const HardwareKey*>::const_iterator it;
for (it = _keys.begin(); it != _keys.end(); it++)
delete *it;
}
void addHardwareMod(HardwareMod *mod) {
checkForMod(mod);
_mods.push_back(mod);
}
void addHardwareKey(HardwareKey *key) {
checkForKey(key);
_keys.push_back(key);
}
const HardwareKey *findHardwareKey(const char *id) const {
List<const HardwareKey*>::const_iterator it;
for (it = _keys.begin(); it != _keys.end(); it++) {
if (strncmp((*it)->hwKeyId, id, HWKEY_ID_SIZE) == 0)
return (*it);
}
return 0;
}
const HardwareKey *findHardwareKey(const KeyState& keystate) const {
List<const HardwareKey*>::const_iterator it;
for (it = _keys.begin(); it != _keys.end(); it++) {
if ((*it)->key.keycode == keystate.keycode)
return (*it);
}
return 0;
}
const HardwareMod *findHardwareMod(const char *id) const {
List<const HardwareMod*>::const_iterator it;
for (it = _mods.begin(); it != _mods.end(); it++) {
if (strncmp((*it)->hwModId, id, HWKEY_ID_SIZE) == 0)
return (*it);
}
return 0;
}
const HardwareMod *findHardwareMod(const KeyState& keystate) const {
List<const HardwareMod*>::const_iterator it;
for (it = _mods.begin(); it != _mods.end(); it++) {
if ((*it)->modFlags == keystate.flags)
return (*it);
}
return 0;
}
const List<const HardwareKey*> &getHardwareKeys() const {
return _keys;
}
uint size() const {
return _keys.size();
}
private:
void checkForKey(HardwareKey *key) {
List<const HardwareKey*>::iterator it;
for (it = _keys.begin(); it != _keys.end(); it++) {
if (strncmp((*it)->hwKeyId, key->hwKeyId, HWKEY_ID_SIZE) == 0)
error("Error adding HardwareKey '%s' - id of %s already in use!", key->description.c_str(), key->hwKeyId);
else if ((*it)->key == key->key)
error("Error adding HardwareKey '%s' - key already in use!", key->description.c_str());
}
}
void checkForMod(HardwareMod *mod) {
List<const HardwareMod*>::iterator it;
for (it = _mods.begin(); it != _mods.end(); it++) {
if (strncmp((*it)->hwModId, mod->hwModId, HWKEY_ID_SIZE) == 0)
error("Error adding HardwareMod '%s' - id of %s already in use!", mod->description.c_str(), mod->hwModId);
else if ((*it)->modFlags == mod->modFlags)
error("Error adding HardwareMod '%s' - modFlags already in use!", mod->description.c_str());
}
}
List<const HardwareKey*> _keys;
List<const HardwareMod*> _mods;
};
} // end of namespace Common
#endif // #ifdef ENABLE_KEYMAPPER
#endif // #ifndef COMMON_HARDWARE_KEY_H
|
