aboutsummaryrefslogtreecommitdiff
path: root/backends/keymapper/keymapper.cpp
blob: dcb021f2d87666dc736513d1161bb8de71f75196 (plain)
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
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
/* 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.
*
*/

#include "backends/keymapper/keymapper.h"

#ifdef ENABLE_KEYMAPPER

#include "common/config-manager.h"
#include "common/system.h"

namespace Common {

// These magic numbers are provided by fuzzie and WebOS
static const uint32 kDelayKeyboardEventMillis = 250;
static const uint32 kDelayMouseEventMillis = 50;

void Keymapper::Domain::addKeymap(Keymap *map) {
	iterator it = find(map->getName());

	if (it != end())
		delete it->_value;

	setVal(map->getName(), map);
}

void Keymapper::Domain::deleteAllKeyMaps() {
	for (iterator it = begin(); it != end(); ++it)
		delete it->_value;

	clear();
}

Keymap *Keymapper::Domain::getKeymap(const String& name) {
	iterator it = find(name);

	if (it != end())
		return it->_value;
	else
		return 0;
}

Keymapper::Keymapper(EventManager *evtMgr)
	: _eventMan(evtMgr), _enabled(true), _remapping(false), _hardwareInputs(0), _actionToRemap(0) {
	ConfigManager::Domain *confDom = ConfMan.getDomain(ConfigManager::kKeymapperDomain);

	_globalDomain.setConfigDomain(confDom);
}

Keymapper::~Keymapper() {
	delete _hardwareInputs;
}

void Keymapper::registerHardwareInputSet(HardwareInputSet *inputs) {
	if (_hardwareInputs)
		error("Hardware input set already registered");

	if (!inputs) {
		warning("No hardware input were defined, using defaults");
		inputs = new HardwareInputSet(true);
	}

	_hardwareInputs = inputs;
}

void Keymapper::addGlobalKeymap(Keymap *keymap) {
	initKeymap(_globalDomain, keymap);
}

void Keymapper::addGameKeymap(Keymap *keymap) {
	if (ConfMan.getActiveDomain() == 0)
		error("Call to Keymapper::addGameKeymap when no game loaded");

	// Detect whether the active game changed since last call.
	// If so, flush the game key configuration.
	if (_gameDomain.getConfigDomain() != ConfMan.getActiveDomain()) {
		cleanupGameKeymaps();
		_gameDomain.setConfigDomain(ConfMan.getActiveDomain());
	}

	initKeymap(_gameDomain, keymap);
}

void Keymapper::initKeymap(Domain &domain, Keymap *map) {
	if (!_hardwareInputs) {
		warning("No hardware inputs were registered yet (%s)", map->getName().c_str());
		return;
	}

	map->setConfigDomain(domain.getConfigDomain());
	map->loadMappings(_hardwareInputs);

	if (map->isComplete(_hardwareInputs) == false) {
		map->saveMappings();
		ConfMan.flushToDisk();
	}

	domain.addKeymap(map);
}

void Keymapper::cleanupGameKeymaps() {
	// Flush all game specific keymaps
	_gameDomain.deleteAllKeyMaps();

	// Now restore the stack of active maps. Re-add all global keymaps, drop
	// the game specific (=deleted) ones.
	Stack<MapRecord> newStack;

	for (Stack<MapRecord>::size_type i = 0; i < _activeMaps.size(); i++) {
		if (_activeMaps[i].global)
			newStack.push(_activeMaps[i]);
	}

	_activeMaps = newStack;
}

Keymap *Keymapper::getKeymap(const String& name, bool *globalReturn) {
	Keymap *keymap = _gameDomain.getKeymap(name);
	bool global = false;

	if (!keymap) {
		keymap = _globalDomain.getKeymap(name);
		global = true;
	}

	if (globalReturn)
		*globalReturn = global;

	return keymap;
}

bool Keymapper::pushKeymap(const String& name, bool transparent) {
	bool global;

	assert(!name.empty());
	Keymap *newMap = getKeymap(name, &global);

	if (!newMap) {
		warning("Keymap '%s' not registered", name.c_str());
		return false;
	}

	pushKeymap(newMap, transparent, global);

	return true;
}

void Keymapper::pushKeymap(Keymap *newMap, bool transparent, bool global) {
	MapRecord mr = {newMap, transparent, global};

	_activeMaps.push(mr);
}

void Keymapper::popKeymap(const char *name) {
	if (!_activeMaps.empty()) {
		if (name) {
			String topKeymapName = _activeMaps.top().keymap->getName();
			if (topKeymapName.equals(name))
				_activeMaps.pop();
			else
				warning("An attempt to pop wrong keymap was blocked (expected %s but was %s)", name, topKeymapName.c_str());
		} else {
			_activeMaps.pop();
		}
	}

}

List<Event> Keymapper::mapEvent(const Event &ev, EventSource *source) {
	if (source && !source->allowMapping()) {
		return DefaultEventMapper::mapEvent(ev, source);
	}
	List<Event> mappedEvents;

	if (_remapping)
		mappedEvents = remap(ev);
	else if (ev.type == Common::EVENT_KEYDOWN)
		mappedEvents = mapKeyDown(ev.kbd);
	else if (ev.type == Common::EVENT_KEYUP)
		mappedEvents = mapKeyUp(ev.kbd);
	else if (ev.type == Common::EVENT_CUSTOM_BACKEND_HARDWARE)
		mappedEvents = mapNonKey(ev.customType);

	if (!mappedEvents.empty())
		return mappedEvents;
	else
		return DefaultEventMapper::mapEvent(ev, source);
}

void Keymapper::startRemappingMode(Action *actionToRemap) {
	assert(!_remapping);

	_remapping = true;
	_actionToRemap = actionToRemap;
}

List<Event> Keymapper::mapKeyDown(const KeyState& key) {
	return mapKey(key, true);
}

List<Event> Keymapper::mapKeyUp(const KeyState& key) {
	return mapKey(key, false);
}

List<Event> Keymapper::mapKey(const KeyState& key, bool keyDown) {
	if (!_enabled || _activeMaps.empty())
		return List<Event>();

	Action *action = 0;

	if (keyDown) {
		// Search for key in active keymap stack
		for (int i = _activeMaps.size() - 1; i >= 0; --i) {
			MapRecord mr = _activeMaps[i];
			debug(5, "Keymapper::mapKey keymap: %s", mr.keymap->getName().c_str());
			action = mr.keymap->getMappedAction(key);

			if (action || !mr.transparent)
				break;
		}

		if (action)
			_keysDown[key] = action;
	} else {
		HashMap<KeyState, Action *>::iterator it = _keysDown.find(key);

		if (it != _keysDown.end()) {
			action = it->_value;
			_keysDown.erase(key);
		}
	}

	if (!action)
		return List<Event>();

	return executeAction(action, keyDown ? kIncomingKeyDown : kIncomingKeyUp);
}


List<Event> Keymapper::mapNonKey(const HardwareInputCode code) {
	if (!_enabled || _activeMaps.empty())
		return List<Event>();

	Action *action = 0;

	// Search for nonkey in active keymap stack
	for (int i = _activeMaps.size() - 1; i >= 0; --i) {
		MapRecord mr = _activeMaps[i];
		debug(5, "Keymapper::mapKey keymap: %s", mr.keymap->getName().c_str());
		action = mr.keymap->getMappedAction(code);

		if (action || !mr.transparent)
			break;
	}

	if (!action)
		return List<Event>();

	return executeAction(action);
}

Action *Keymapper::getAction(const KeyState& key) {
	Action *action = 0;

	return action;
}

List<Event> Keymapper::executeAction(const Action *action, IncomingEventType incomingType) {
	List<Event> mappedEvents;
	List<Event>::const_iterator it;
	Event evt;
	for (it = action->events.begin(); it != action->events.end(); ++it) {
		evt = Event(*it);
		EventType convertedType = convertDownToUp(evt.type);

		// hardware keys need to send up instead when they are up
		if (incomingType == kIncomingKeyUp) {
			if (convertedType == EVENT_INVALID)
				continue; // don't send any non-down-converted events on up they were already sent on down
			evt.type = convertedType;
		}

		evt.mouse = _eventMan->getMousePos();

		// Check if the event is coming from a non-key hardware event
		// that is mapped to a key event
		if (incomingType == kIncomingNonKey && convertedType != EVENT_INVALID)
			// WORKAROUND: Delay the down events coming from non-key hardware events
			// with a zero delay. This is to prevent DOWN1 DOWN2 UP1 UP2.
			addDelayedEvent(0, evt);
		else
			mappedEvents.push_back(evt);

		// non-keys need to send up as well
		if (incomingType == kIncomingNonKey && convertedType != EVENT_INVALID) {
			// WORKAROUND: Delay the up events coming from non-key hardware events
			// This is for engines that run scripts that check on key being down
			evt.type = convertedType;
			const uint32 delay = (convertedType == EVENT_KEYUP ? kDelayKeyboardEventMillis : kDelayMouseEventMillis);
			addDelayedEvent(delay, evt);
		}
	}
	return mappedEvents;
}

EventType Keymapper::convertDownToUp(EventType type) {
	EventType result = EVENT_INVALID;
	switch (type) {
	case EVENT_KEYDOWN:
		result = EVENT_KEYUP;
		break;
	case EVENT_LBUTTONDOWN:
		result = EVENT_LBUTTONUP;
		break;
	case EVENT_RBUTTONDOWN:
		result = EVENT_RBUTTONUP;
		break;
	case EVENT_MBUTTONDOWN:
		result = EVENT_MBUTTONUP;
		break;
	default:
		break;
	}
	return result;
}

const HardwareInput *Keymapper::findHardwareInput(const KeyState& key) {
	return (_hardwareInputs) ? _hardwareInputs->findHardwareInput(key) : 0;
}

const HardwareInput *Keymapper::findHardwareInput(const HardwareInputCode code) {
	return (_hardwareInputs) ? _hardwareInputs->findHardwareInput(code) : 0;
}

List<Event> Keymapper::remap(const Event &ev) {
	assert(_remapping);
	assert(_actionToRemap);

	List<Event> list;

	const HardwareInput *hwInput = 0;
	Event mappedEvent;

	switch (ev.type) {
	case EVENT_KEYDOWN:
		// eat the event by returning an event invalid
		mappedEvent.type = EVENT_INVALID;
		list.push_back(mappedEvent);
		break;
	case EVENT_KEYUP:
		hwInput = findHardwareInput(ev.kbd);
		break;
	case EVENT_CUSTOM_BACKEND_HARDWARE:
		hwInput = findHardwareInput(ev.customType);
		break;
	default:
		break;
	}
	if (hwInput) {
		_actionToRemap->mapInput(hwInput);
		_actionToRemap->getParent()->saveMappings();
		_remapping = false;
		_actionToRemap = 0;
		mappedEvent.type = EVENT_GUI_REMAP_COMPLETE_ACTION;
		list.push_back(mappedEvent);
	}
	return list;
}

} // End of namespace Common

#endif // #ifdef ENABLE_KEYMAPPER