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
|
/* 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_KEYMAPPER
#define COMMON_KEYMAPPER
#include "common/events.h"
#include "common/list.h"
#include "common/stack.h"
#include "backends/keymapper/hardware-key.h"
#include "backends/keymapper/keymap.h"
#include "backends/keymapper/keymap-manager.h"
namespace Common {
class Keymapper {
public:
Keymapper(EventManager *eventMan);
~Keymapper();
/**
* Registers a HardwareKeySet with the Keymapper
* @note should only be called once (during backend initialisation)
*/
void registerHardwareKeySet(HardwareKeySet *keys);
/**
* Add a general keymap to the global domain.
* If a saved key setup exists for it in the ini file it will be used.
* Else, the key setup will be automatically mapped.
*/
void addGlobalKeymap(const String& name, Keymap *keymap);
/**
* Sets the default keymap for the global domain.
*/
void setDefaultGlobalKeymap(Keymap *keymap);
/**
* Add a general keymap to the game domain.
* @see addGlobalKeyMap
* @note initGame() should be called before any game keymaps are added.
*/
void addGameKeymap(const String& name, Keymap *keymap);
/**
* Sets the default keymap for the game domain.
*/
void setDefaultGameKeymap(Keymap *keymap);
/**
* Push a new keymap to the top of the active stack, activating it for use.
* @param name name of the keymap to push
* @param inherit if true
* @return true if successful
*/
bool pushKeymap(const String& name, bool inherit = false);
/**
* Pop the active keymap off the stack.
*/
void popKeymap();
/**
* @brief Map a key press event.
* If the active keymap contains a Action mapped to the given key, then
* the Action's events are pushed into the EventManager's event queue.
* @param key key that was pressed
* @param isKeyDown true for key down, false for key up
* @return true if key was mapped
*/
bool mapKey(const KeyState& key, bool isKeyDown);
/**
* @brief Map a key down event.
* @see mapKey
*/
bool mapKeyDown(const KeyState& key);
/**
* @brief Map a key up event.
* @see mapKey
*/
bool mapKeyUp(const KeyState& key);
private:
void pushKeymap(Keymap *newMap, bool inherit);
typedef List<HardwareKey*>::iterator Iterator;
EventManager *_eventMan;
KeymapManager *_keymapMan;
struct MapRecord {
Keymap* keymap;
bool inherit;
};
Stack<MapRecord> _activeMaps;
};
} // end of namespace Common
#endif
|
