File: metaengine.cpp

package info (click to toggle)
scummvm 2.9.0%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 450,268 kB
  • sloc: cpp: 4,297,604; asm: 28,322; python: 12,901; sh: 11,219; java: 8,477; xml: 7,843; perl: 2,633; ansic: 2,465; yacc: 1,670; javascript: 1,020; makefile: 933; lex: 578; awk: 275; objc: 82; sed: 11; php: 1
file content (219 lines) | stat: -rw-r--r-- 8,235 bytes parent folder | download | duplicates (2)
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
/* 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 3 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, see <http://www.gnu.org/licenses/>.
 *
 */

#include "mm/mm1/metaengine.h"
#include "mm/mm1/mm1.h"
#include "common/translation.h"
#include "backends/keymapper/action.h"
#include "backends/keymapper/standard-actions.h"

namespace MM {
namespace MM1 {

struct KeybindingRecord {
	KeybindingAction _action;
	const char *_id;
	const char *_desc;
	const char *_key;
	const char *_joy;
};

static const KeybindingRecord MINIMAL_KEYS[] = {
	// I18N: ESC key
	{ KEYBIND_ESCAPE, "ESCAPE", _s("Escape"), "ESCAPE", nullptr },
	{ KEYBIND_NONE, nullptr, nullptr, nullptr, nullptr }
};

static const KeybindingRecord MENU_KEYS[] = {
	// I18N: ESC key
	{ KEYBIND_ESCAPE, "ESCAPE", _s("Escape"), "ESCAPE", nullptr },
	// I18N: Return key
	{ KEYBIND_SELECT, "SELECT", _s("Select"), "RETURN", nullptr },
	{ KEYBIND_NONE, nullptr, nullptr, nullptr, nullptr }
};

static const KeybindingRecord PARTY_KEYS[] = {
	{ KEYBIND_VIEW_PARTY1, "PARTY1", _s("View Party Member 1"), "1", nullptr },
	{ KEYBIND_VIEW_PARTY2, "PARTY2", _s("View Party Member 2"), "2", nullptr },
	{ KEYBIND_VIEW_PARTY3, "PARTY3", _s("View Party Member 3"), "3", nullptr },
	{ KEYBIND_VIEW_PARTY4, "PARTY4", _s("View Party Member 4"), "4", nullptr },
	{ KEYBIND_VIEW_PARTY5, "PARTY5", _s("View Party Member 5"), "5", nullptr },
	{ KEYBIND_VIEW_PARTY6, "PARTY6", _s("View Party Member 6"), "6", nullptr },
	{ KEYBIND_NONE, nullptr, nullptr, nullptr, nullptr }
};

static const KeybindingRecord COMBAT_KEYS[] = {
	// I18N: Combat command in Might & Magic 1
	{ KEYBIND_COMBAT_ATTACK, "COMBAT_ATTACK", _s("Attack"), "a", nullptr },
	// I18N: Combat command in Might & Magic 1
	{ KEYBIND_COMBAT_BLOCK, "COMBAT_BLOCK", _s("Block"), "b", nullptr },
	// I18N: Combat command in Might & Magic 1
	{ KEYBIND_COMBAT_CAST, "COMBAT_CAST", _s("Cast"), "c", nullptr },
	// I18N: Combat command in Might & Magic 1
	{ KEYBIND_COMBAT_EXCHANGE, "COMBAT_EXCHANGE", _s("Exchange"), "e", nullptr },
	// I18N: Combat command in Might & Magic 1
	{ KEYBIND_COMBAT_FIGHT, "COMBAT_FIGHT", _s("Fight"), "f", nullptr },
	// I18N: Combat command in Might & Magic 1
	{ KEYBIND_QUICKREF, "QUICKREF", _s("Quick Reference"), "q", nullptr },
	// I18N: Combat command in Might & Magic 1
	{ KEYBIND_COMBAT_RETREAT, "COMBAT_RETREAT", _s("Retreat"), "r", nullptr },
	// I18N: Combat command in Might & Magic 1
	{ KEYBIND_COMBAT_SHOOT, "COMBAT_SHOOT", _s("Shoot"), "s", nullptr },
	// I18N: Combat command in Might & Magic 1
	{ KEYBIND_COMBAT_USE, "COMBAT_USE", _s("Use"), "u", nullptr },

	// I18N: Combat command in Might & Magic 1
	{ KEYBIND_DELAY, "DELAY", _s("Delay"), "d", nullptr },
	// I18N: Combat command in Might & Magic 1
	{ KEYBIND_PROTECT, "PROTECT", _s("Protect"), "p", nullptr },
	{ KEYBIND_NONE, nullptr, nullptr, nullptr, nullptr }
};

static const KeybindingRecord NORMAL_KEYS[] = {
	// I18N: Select party member command in Might & Magic 1
	{ KEYBIND_SELECT, "SELECT", _s("Select"), "RETURN", nullptr },
	// I18N: Party arrangement command in Might & Magic 1
	{ KEYBIND_FORWARDS, "FORWARDS", _s("Forwards"), "UP", nullptr },
	// I18N: Party arrangement command in Might & Magic 1
	{ KEYBIND_BACKWARDS, "BACKWARDS", _s("Backwards"), "DOWN", nullptr },
	{ KEYBIND_TURN_LEFT, "TURN_LEFT", _s("Turn Left"), "LEFT", nullptr },
	{ KEYBIND_TURN_RIGHT, "TURN_RIGHT", _s("Turn Right"), "RIGHT", nullptr },
	{ KEYBIND_STRAFE_LEFT, "STRAFE_LEFT", _s("Strafe Left"), "C+LEFT", nullptr },
	{ KEYBIND_STRAFE_RIGHT, "STRAFE_RIGHT", _s("Strafe Right"), "C+RIGHT", nullptr },

	{ KEYBIND_SPELL, "CAST", _s("Cast Spell"), "c", nullptr },
	{ KEYBIND_MAP, "MAP", _s("Show Map"), "m", nullptr },
	{ KEYBIND_MINIMAP, "MINIMAP", _s("Toggle Minimap"), "=", nullptr },
	{ KEYBIND_ORDER, "ORDER", _s("Reorder Party"), "o", nullptr },
	// I18N: Action of hero party in Might & Magic 1
	{ KEYBIND_PROTECT, "PROTECT", _s("Protect"), "p", nullptr },
	// I18N: Action of hero party in Might & Magic 1
	{ KEYBIND_REST, "REST", _s("Rest"), "r", nullptr },
	// I18N: Action of hero party in Might & Magic 1
	{ KEYBIND_SEARCH, "SEARCH", _s("Search"), "s", nullptr },
	// I18N: Action of hero party in Might & Magic 1
	{ KEYBIND_BASH, "BASH", _s("Bash"), "b", nullptr },
	// I18N: Action of hero party in Might & Magic 1
	{ KEYBIND_UNLOCK, "UNLOCK", _s("Unlock"), "u", nullptr },
	{ KEYBIND_QUICKREF, "QUICKREF", _s("Quick Reference"), "q", nullptr },

	{ KEYBIND_NONE, nullptr, nullptr, nullptr, nullptr }
};

static const KeybindingRecord CHEAT_KEYS[] = {
	{ KEYBIND_CHEAT_GOTO, "CHEAT-GOTO", _s("Goto location"), "A+g", nullptr },
	{ KEYBIND_NONE, nullptr, nullptr, nullptr, nullptr }
};

struct KeysRecord {
	const char *_id;
	const char *_desc;
	const KeybindingRecord *_keys;
};

static const KeysRecord MENU_RECORDS[] = {
	{ "mm1", _s("Might and Magic 1 - Menus"), MENU_KEYS },
	{ nullptr, nullptr, nullptr }
};

static const KeysRecord MINIMAL_RECORDS[] = {
	{ "mm1_minimal", _s("Might and Magic 1 - Minimal Keys"), MINIMAL_KEYS },
	{ nullptr, nullptr, nullptr }
};

static const KeysRecord PARTY_MENU_RECORDS[] = {
	{ "mm1", _s("Might and Magic 1 - Menus"), MENU_KEYS },
	{ "mm1_party", _s("Might and Magic 1 - Party"), PARTY_KEYS },
	{ nullptr, nullptr, nullptr }
};

static const KeysRecord COMBAT_MENU_RECORDS[] = {
	{ "mm1_combat", _s("Might and Magic 1 - Combat"), COMBAT_KEYS },
	{ "mm1_party", _s("Might and Magic 1 - Party"), PARTY_KEYS },
	{ nullptr, nullptr, nullptr }
};

static const KeysRecord NORMAL_RECORDS[] = {
	{ "mm1", _s("Might and Magic 1"), NORMAL_KEYS },
	{ "mm1_party", _s("Might and Magic 1 - Party"), PARTY_KEYS },
	{ "mm1_cheats", _s("Might and Magic 1 - Cheats"), CHEAT_KEYS },
	{ nullptr, nullptr, nullptr }
};

static const KeysRecord *MODE_RECORDS[6] = {
	MENU_RECORDS,
	MINIMAL_RECORDS,
	PARTY_MENU_RECORDS,
	NORMAL_RECORDS,
	COMBAT_MENU_RECORDS,
	nullptr		// TODO: combat keybindings
};

Common::KeymapArray MetaEngine::initKeymaps(KeybindingMode mode) {
	Common::KeymapArray keymapArray;
	Common::Keymap *keyMap;
	Common::Action *act;
	const KeysRecord *recPtr = MODE_RECORDS[mode];

	for (int kCtr = 0; recPtr->_id; ++recPtr, ++kCtr) {
		// Core keymaps
		keyMap = new Common::Keymap(Common::Keymap::kKeymapTypeGame,
			recPtr->_id, recPtr->_desc);
		keymapArray.push_back(keyMap);

		for (const KeybindingRecord *r = recPtr->_keys; r->_id; ++r) {
			act = new Common::Action(r->_id, _(r->_desc));
			act->setCustomEngineActionEvent(r->_action);
			act->addDefaultInputMapping(r->_key);
			if (r->_joy)
				act->addDefaultInputMapping(r->_joy);
			if (r->_action == KEYBIND_SELECT)
				act->addDefaultInputMapping("SPACE");

			if (r->_action == KEYBIND_FORWARDS || r->_action == KEYBIND_BACKWARDS ||
					r->_action == KEYBIND_TURN_LEFT || r->_action == KEYBIND_TURN_RIGHT ||
					r->_action == KEYBIND_STRAFE_LEFT || r->_action == KEYBIND_STRAFE_RIGHT)
				// Allow movement actions to be triggered on keyboard repeats
				act->allowKbdRepeats();

			keyMap->addAction(act);
		}
	}

	return keymapArray;
}

void MetaEngine::setKeybindingMode(KeybindingMode mode) {
	Common::Keymapper *const mapper = g_engine->getEventManager()->getKeymapper();
	mapper->cleanupGameKeymaps();

	Common::KeymapArray arr = initKeymaps(mode);

	for (uint idx = 0; idx < arr.size(); ++idx)
		mapper->addGameKeymap(arr[idx]);
}

void MetaEngine::executeAction(KeybindingAction keyAction) {
	g_engine->send(ActionMessage(keyAction));
}

} // End of namespace MM1
} // End of namespace MM