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
|
/* 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_KEYMAP_H
#define COMMON_KEYMAP_H
#include "common/scummsys.h"
#ifdef ENABLE_KEYMAPPER
#include "common/config-manager.h"
#include "common/func.h"
#include "common/hashmap.h"
#include "common/keyboard.h"
#include "common/list.h"
#include "backends/keymapper/action.h"
namespace Common {
struct HardwareKey;
class HardwareKeySet;
/**
* Hash function for KeyState
*/
template<> struct Hash<KeyState>
: public UnaryFunction<KeyState, uint> {
uint operator()(const KeyState &val) const {
return (uint)val.keycode | ((uint)val.flags << 24);
}
};
class Keymap {
public:
Keymap(const String& name, Keymap *parent = 0) : _name(name), _parent(parent) {}
Keymap(const Keymap& km);
~Keymap();
public:
/**
* Retrieves the Action with the given id
* @param id id of Action to retrieve
* @return Pointer to the Action or 0 if not found
*/
Action *getAction(const char *id);
/**
* Get the list of all the Actions contained in this Keymap
*/
List<Action*>& getActions() { return _actions; }
/**
* Find the Action that a key is mapped to
* @param key the key that is mapped to the required Action
* @return a pointer to the Action or 0 if no
*/
Action *getMappedAction(const KeyState& ks) const;
void setConfigDomain(ConfigManager::Domain *dom);
/**
* Load this keymap's mappings from the config manager.
* @param hwKeys the set to retrieve hardware key pointers from
*/
void loadMappings(const HardwareKeySet *hwKeys);
/**
* Save this keymap's mappings to the config manager
* @note Changes are *not* flushed to disk, to do so call ConfMan.flushToDisk()
* @note Changes are *not* flushed to disk, to do so call ConfMan.flushToDisk()
*/
void saveMappings();
void automaticMapping(HardwareKeySet *hwKeys);
/**
* Returns true if all UserAction's in Keymap are mapped, or,
* all HardwareKey's from the given set have been used up.
*/
bool isComplete(const HardwareKeySet *hwKeys);
const String& getName() { return _name; }
Keymap *getParent() { return _parent; }
private:
friend struct Action;
/**
* Adds a new Action to this Map,
* adding it at the back of the internal array
* @param action the Action to add
*/
void addAction(Action *action);
/**
* Registers a HardwareKey to the given Action
* @param action Action in this Keymap
* @param key pointer to HardwareKey to map
* @see Action::mapKey
*/
void registerMapping(Action *action, const HardwareKey *key);
/**
* Unregisters a HardwareKey from the given Action (if one is mapped)
* @param action Action in this Keymap
* @see Action::mapKey
*/
void unregisterMapping(Action *action);
Action *findAction(const char *id);
const Action *findAction(const char *id) const;
void internalMapKey(Action *action, HardwareKey *hwKey);
Action *getParentMappedAction(KeyState key);
String _name;
Keymap *_parent;
List<Action*> _actions;
HashMap<KeyState, Action*> _keymap;
ConfigManager::Domain *_configDomain;
};
} // End of namespace Common
#endif // #ifdef ENABLE_KEYMAPPER
#endif // #ifndef COMMON_KEYMAP_H
|
