aboutsummaryrefslogtreecommitdiff
path: root/backends/keymapper/hardware-key.h
blob: 7ddb4dacd1bf8114f6fdaa1300f9389f189e7429 (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
/* 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_HARDWAREKEY
#define COMMON_HARDWAREKEY

#include "backends/keymapper/action.h"

namespace Common {

/**
* Describes an available hardware key 
*/
struct HardwareKey {
	/** unique id used for saving/loading to config */
	int32 id;
	/** Human readable description */
	String description; 
	/** 
	* The KeyState that is generated by the back-end 
	* when this hardware key is pressed.
	*/
	KeyState key;

	ActionCategory preferredCategory;
	ActionType preferredType;
	int16 group;

	HardwareKey(int32 i, KeyState ks = KeyState(), String des = "",
				ActionCategory cat = kGenericActionCategory,
				ActionType ty = kGenericActionType,	int gr = 0) {
		id = i;
		key = ks;
		description = des;
		preferredCategory = cat;
		preferredType = ty;
		group = gr;
	}
};


/**
 * Simple class to encapsulate a device's set of HardwareKeys.
 * Each device should extend this and call addHardwareKey a number of times
 * in its constructor to define the device's available keys.
 */ 
class HardwareKeySet {
public:

	HardwareKeySet() {}
	virtual ~HardwareKeySet() {
		List<const HardwareKey*>::iterator it;
		for (it = _keys.begin(); it != _keys.end(); it++)
			delete *it;
	}

	void addHardwareKey(HardwareKey *key) {
		checkForKey(key);
		_keys.push_back(key);
	}

	const HardwareKey *findHardwareKey(int32 id) const {
		List<const HardwareKey*>::iterator it;
		for (it = _keys.begin(); it != _keys.end(); it++) {
			if ((*it)->id == id)
				return (*it);
		}
		return 0;
	}

	const HardwareKey *findHardwareKey(const KeyState& keystate) const {
		List<const HardwareKey*>::iterator it;
		for (it = _keys.begin(); it != _keys.end(); it++) {
			if ((*it)->key == keystate)
				return (*it);
		}
		return 0;
	}

	List<const HardwareKey*> getHardwareKeys() const {
		return _keys;
	}

	uint count() const {
		return _keys.size();
	}


private:

	void checkForKey(HardwareKey *key) {
		List<const HardwareKey*>::iterator it;
		for (it = _keys.begin(); it != _keys.end(); it++) {
			if ((*it)->id == key->id)
				error("Error adding HardwareKey '%s' - id of %d already in use!", key->description.c_str(), key->id);
			else if ((*it)->key == key->key)
				error("Error adding HardwareKey '%s' - key already in use!", key->description.c_str());
		}
	}

	List<const HardwareKey*> _keys;
};


} // end of namespace Common

#endif