4 // Copyright (C) 2005 Matthias Braun <matze@braunis.de>
6 // This program is free software; you can redistribute it and/or
7 // modify it under the terms of the GNU General Public License
8 // as published by the Free Software Foundation; either version 2
9 // of the License, or (at your option) any later version.
11 // This program is distributed in the hope that it will be useful,
12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 // GNU General Public License for more details.
16 // You should have received a copy of the GNU General Public License
17 // along with this program; if not, write to the Free Software
18 // Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
23 #include "joystickkeyboardcontroller.hpp"
25 #include "gui/menu.hpp"
26 #include "gettext.hpp"
27 #include "lisp/lisp.hpp"
28 #include "lisp/list_iterator.hpp"
29 #include "game_session.hpp"
30 #include "console.hpp"
32 class JoystickKeyboardController::JoystickMenu : public Menu
35 JoystickMenu(JoystickKeyboardController* controller);
36 virtual ~JoystickMenu();
39 std::string get_button_name(int button);
40 virtual void menu_action(MenuItem* item);
41 JoystickKeyboardController* controller;
44 class JoystickKeyboardController::KeyboardMenu : public Menu
47 KeyboardMenu(JoystickKeyboardController* controller);
51 std::string get_key_name(SDLKey key);
52 virtual void menu_action(MenuItem* item);
53 JoystickKeyboardController* controller;
56 JoystickKeyboardController::JoystickKeyboardController()
57 : wait_for_key(-1), wait_for_joybutton(-1), key_options_menu(0),
58 joystick_options_menu(0)
60 // initialize default keyboard map
61 keymap.insert(std::make_pair(SDLK_LEFT, LEFT));
62 keymap.insert(std::make_pair(SDLK_RIGHT, RIGHT));
63 keymap.insert(std::make_pair(SDLK_UP, UP));
64 keymap.insert(std::make_pair(SDLK_DOWN, DOWN));
65 keymap.insert(std::make_pair(SDLK_SPACE, JUMP));
66 keymap.insert(std::make_pair(SDLK_LCTRL, ACTION));
67 keymap.insert(std::make_pair(SDLK_LALT, ACTION));
68 keymap.insert(std::make_pair(SDLK_ESCAPE, PAUSE_MENU));
69 keymap.insert(std::make_pair(SDLK_p, PAUSE_MENU));
70 keymap.insert(std::make_pair(SDLK_PAUSE, PAUSE_MENU));
71 keymap.insert(std::make_pair(SDLK_RETURN, MENU_SELECT));
72 keymap.insert(std::make_pair(SDLK_KP_ENTER, MENU_SELECT));
74 int joystick_count = SDL_NumJoysticks();
77 for(int i = 0; i < joystick_count; ++i) {
78 SDL_Joystick* joystick = SDL_JoystickOpen(i);
80 if(SDL_JoystickNumButtons(joystick) < 2) {
81 msg_warning("Joystick " << i << " has less than 2 buttons");
84 if(SDL_JoystickNumAxes(joystick) < 2
85 && SDL_JoystickNumHats(joystick) == 0) {
86 msg_warning("Joystick " << i << " has less than 2 axes and no hat");
90 SDL_JoystickClose(joystick);
94 if(min_joybuttons < 0 || SDL_JoystickNumButtons(joystick) < min_joybuttons)
95 min_joybuttons = SDL_JoystickNumButtons(joystick);
96 if(SDL_JoystickNumButtons(joystick) > max_joybuttons) {
97 max_joybuttons = SDL_JoystickNumButtons(joystick);
100 joysticks.push_back(joystick);
109 joy_button_map.insert(std::make_pair(0, JUMP));
110 joy_button_map.insert(std::make_pair(1, ACTION));
111 // map the last 2 buttons to menu and pause
112 if(min_joybuttons > 2)
113 joy_button_map.insert(std::make_pair(min_joybuttons-1, PAUSE_MENU));
114 // map all remaining joystick buttons to MENU_SELECT
115 for(int i = 2; i < max_joybuttons; ++i) {
116 if(i != min_joybuttons-1)
117 joy_button_map.insert(std::make_pair(i, MENU_SELECT));
120 // some joysticks or SDL seem to produce some bogus events after being opened
121 Uint32 ticks = SDL_GetTicks();
122 while(SDL_GetTicks() - ticks < 200) {
124 SDL_PollEvent(&event);
128 JoystickKeyboardController::~JoystickKeyboardController()
130 for(std::vector<SDL_Joystick*>::iterator i = joysticks.begin();
131 i != joysticks.end(); ++i) {
133 SDL_JoystickClose(*i);
136 delete key_options_menu;
137 delete joystick_options_menu;
141 JoystickKeyboardController::read(const lisp::Lisp& lisp)
143 const lisp::Lisp* keymap_lisp = lisp.get_lisp("keymap");
146 lisp::ListIterator iter(keymap_lisp);
148 if(iter.item() == "map") {
151 const lisp::Lisp* map = iter.lisp();
152 map->get("key", key);
153 map->get("control", control);
154 if(key < SDLK_FIRST || key >= SDLK_LAST) {
155 msg_warning("Invalid key '" << key << "' in keymap");
160 for(i = 0; controlNames[i] != 0; ++i) {
161 if(control == controlNames[i])
164 if(controlNames[i] == 0) {
165 msg_warning("Invalid control '" << control << "' in keymap");
168 keymap.insert(std::make_pair((SDLKey) key, (Control) i));
170 msg_warning("Invalid lisp element '" << iter.item() << "' in keymap");
175 const lisp::Lisp* joystick_lisp = lisp.get_lisp("joystick");
177 joystick_lisp->get("use_hat", use_hat);
178 joystick_lisp->get("axis_x", joyaxis_x);
179 joystick_lisp->get("axis_y", joyaxis_y);
180 joystick_lisp->get("dead_zone_x", dead_zone_x);
181 joystick_lisp->get("dead_zone_y", dead_zone_y);
182 lisp::ListIterator iter(joystick_lisp);
184 if(iter.item() == "map") {
187 const lisp::Lisp* map = iter.lisp();
188 map->get("button", button);
189 map->get("control", control);
190 if(button < 0 || button >= max_joybuttons) {
191 msg_warning("Invalid button '" << button << "' in buttonmap");
196 for(i = 0; controlNames[i] != 0; ++i) {
197 if(control == controlNames[i])
200 if(controlNames[i] == 0) {
201 msg_warning("Invalid control '" << control << "' in buttonmap");
204 reset_joybutton(button, (Control) i);
211 JoystickKeyboardController::write(lisp::Writer& writer)
213 writer.start_list("keymap");
214 for(KeyMap::iterator i = keymap.begin(); i != keymap.end(); ++i) {
215 writer.start_list("map");
216 writer.write_int("key", (int) i->first);
217 writer.write_string("control", controlNames[i->second]);
218 writer.end_list("map");
220 writer.end_list("keymap");
221 writer.start_list("joystick");
222 writer.write_bool("use_hat", use_hat);
223 writer.write_int("axis_x", joyaxis_x);
224 writer.write_int("axis_y", joyaxis_y);
225 writer.write_int("dead_zone_x", dead_zone_x);
226 writer.write_int("dead_zone_y", dead_zone_y);
227 for(ButtonMap::iterator i = joy_button_map.begin(); i != joy_button_map.end();
229 writer.start_list("map");
230 writer.write_int("button", i->first);
231 writer.write_string("control", controlNames[i->second]);
232 writer.end_list("map");
234 writer.end_list("joystick");
238 JoystickKeyboardController::reset()
244 JoystickKeyboardController::process_event(const SDL_Event& event)
249 if (event.key.keysym.unicode == '\t') {
250 // console key was pressed - toggle console
251 if (event.type == SDL_KEYDOWN) {
252 if (Console::hasFocus()) {
258 } else if (Console::hasFocus()) {
259 // console is open - send key there
260 int c = event.key.keysym.unicode;
261 if (event.type == SDL_KEYDOWN) {
262 if ((c >= 32) && (c <= 126)) {
263 Console::input << (char)c;
265 if ((c == '\n') || (c == '\r')) {
266 Console::input << std::endl;
270 else if (Menu::current()) {
271 // menu mode - send key there
272 process_menu_key_event(event);
275 // normal mode - find key in keymap
276 KeyMap::iterator i = keymap.find(event.key.keysym.sym);
277 if(i == keymap.end()) {
278 msg_debug("Pressed key without mapping");
281 Control control = i->second;
282 controls[control] = event.type == SDL_KEYDOWN ? true : false;
286 case SDL_JOYAXISMOTION:
287 if(event.jaxis.axis == joyaxis_x) {
288 if(event.jaxis.value < -dead_zone_x) {
289 controls[LEFT] = true;
290 controls[RIGHT] = false;
291 } else if(event.jaxis.value > dead_zone_x) {
292 controls[LEFT] = false;
293 controls[RIGHT] = true;
295 controls[LEFT] = false;
296 controls[RIGHT] = false;
298 } else if(event.jaxis.axis == joyaxis_y) {
299 if(event.jaxis.value < -dead_zone_y) {
301 controls[DOWN] = false;
302 } else if(event.jaxis.value > dead_zone_y) {
303 controls[UP] = false;
304 controls[DOWN] = true;
306 controls[UP] = false;
307 controls[DOWN] = false;
312 case SDL_JOYHATMOTION:
316 if(event.jhat.value & SDL_HAT_UP) {
318 controls[DOWN] = false;
320 if(event.jhat.value & SDL_HAT_DOWN) {
321 controls[UP] = false;
322 controls[DOWN] = true;
324 if(event.jhat.value & SDL_HAT_LEFT) {
325 controls[LEFT] = true;
326 controls[RIGHT] = false;
328 if(event.jhat.value & SDL_HAT_RIGHT) {
329 controls[LEFT] = false;
330 controls[RIGHT] = true;
332 if(event.jhat.value == SDL_HAT_CENTERED) {
333 controls[UP] = false;
334 controls[DOWN] = false;
335 controls[LEFT] = false;
336 controls[RIGHT] = false;
340 case SDL_JOYBUTTONDOWN:
341 case SDL_JOYBUTTONUP:
343 if(wait_for_joybutton >= 0) {
344 if(event.type == SDL_JOYBUTTONUP)
347 Control c = (Control) wait_for_joybutton;
348 reset_joybutton(event.jbutton.button, c);
350 joystick_options_menu->update();
351 wait_for_joybutton = -1;
355 ButtonMap::iterator i = joy_button_map.find(event.jbutton.button);
356 if(i == joy_button_map.end()) {
357 msg_debug("Unmapped joybutton " << (int) event.jbutton.button
362 controls[i->second] =
363 event.type == SDL_JOYBUTTONDOWN ? true : false;
373 JoystickKeyboardController::process_menu_key_event(const SDL_Event& event)
375 // wait for key mode?
376 if(wait_for_key >= 0) {
377 if(event.type == SDL_KEYUP)
380 if(event.key.keysym.sym != SDLK_ESCAPE
381 && event.key.keysym.sym != SDLK_PAUSE) {
382 reset_key(event.key.keysym.sym, (Control) wait_for_key);
385 key_options_menu->update();
389 if(wait_for_joybutton >= 0) {
390 if(event.key.keysym.sym == SDLK_ESCAPE) {
392 joystick_options_menu->update();
393 wait_for_joybutton = -1;
399 /* we use default keys when the menu is open (to avoid problems when
400 * redefining keys to invalid settings
402 switch(event.key.keysym.sym) {
418 control = MENU_SELECT;
422 control = PAUSE_MENU;
429 controls[control] = event.type == SDL_KEYDOWN ? true : false;
433 JoystickKeyboardController::reset_joybutton(int button, Control control)
435 // remove all previous mappings for that control and for that key
436 for(ButtonMap::iterator i = joy_button_map.begin();
437 i != joy_button_map.end(); /* no ++i */) {
438 if(i->second == control) {
439 ButtonMap::iterator e = i;
441 joy_button_map.erase(e);
446 ButtonMap::iterator i = joy_button_map.find(button);
447 if(i != joy_button_map.end())
448 joy_button_map.erase(i);
451 joy_button_map.insert(std::make_pair(button, control));
453 // map all unused buttons to MENU_SELECT
454 for(int b = 0; b < max_joybuttons; ++b) {
455 ButtonMap::iterator i = joy_button_map.find(b);
456 if(i != joy_button_map.end())
459 joy_button_map.insert(std::make_pair(b, MENU_SELECT));
464 JoystickKeyboardController::reset_key(SDLKey key, Control control)
466 // remove all previous mappings for that control and for that key
467 for(KeyMap::iterator i = keymap.begin();
468 i != keymap.end(); /* no ++i */) {
469 if(i->second == control) {
470 KeyMap::iterator e = i;
477 KeyMap::iterator i = keymap.find(key);
478 if(i != keymap.end())
482 keymap.insert(std::make_pair(key, control));
486 JoystickKeyboardController::reversemap_key(Control c)
488 for(KeyMap::iterator i = keymap.begin(); i != keymap.end(); ++i) {
497 JoystickKeyboardController::reversemap_joybutton(Control c)
499 for(ButtonMap::iterator i = joy_button_map.begin();
500 i != joy_button_map.end(); ++i) {
509 JoystickKeyboardController::get_key_options_menu()
511 if(key_options_menu == 0) {
512 key_options_menu = new KeyboardMenu(this);
515 return key_options_menu;
519 JoystickKeyboardController::get_joystick_options_menu()
521 if(joystick_options_menu == 0) {
522 joystick_options_menu = new JoystickMenu(this);
525 return joystick_options_menu;
528 //----------------------------------------------------------------------------
530 JoystickKeyboardController::KeyboardMenu::KeyboardMenu(
531 JoystickKeyboardController* _controller)
532 : controller(_controller)
534 add_label(_("Keyboard Setup"));
536 add_controlfield(Controller::UP, _("Up"));
537 add_controlfield(Controller::DOWN, _("Down"));
538 add_controlfield(Controller::LEFT, _("Left"));
539 add_controlfield(Controller::RIGHT, _("Right"));
540 add_controlfield(Controller::JUMP, _("Jump"));
541 add_controlfield(Controller::ACTION, _("Shoot/Run"));
547 JoystickKeyboardController::KeyboardMenu::~KeyboardMenu()
551 JoystickKeyboardController::KeyboardMenu::get_key_name(SDLKey key)
557 return _("Up cursor");
559 return _("Down cursor");
561 return _("Left cursor");
563 return _("Right cursor");
569 return _("Right Shift");
571 return _("Left Shift");
573 return _("Right Control");
575 return _("Left Control");
577 return _("Right Alt");
579 return _("Left Alt");
581 return SDL_GetKeyName((SDLKey) key);
586 JoystickKeyboardController::KeyboardMenu::menu_action(MenuItem* item)
588 assert(item->id >= 0 && item->id < Controller::CONTROLCOUNT);
589 item->change_input(_("Press Key"));
590 controller->wait_for_key = item->id;
594 JoystickKeyboardController::KeyboardMenu::update()
597 get_item_by_id((int) Controller::UP).change_input(get_key_name(
598 controller->reversemap_key(Controller::UP)));
599 get_item_by_id((int) Controller::DOWN).change_input(get_key_name(
600 controller->reversemap_key(Controller::DOWN)));
601 get_item_by_id((int) Controller::LEFT).change_input(get_key_name(
602 controller->reversemap_key(Controller::LEFT)));
603 get_item_by_id((int) Controller::RIGHT).change_input(get_key_name(
604 controller->reversemap_key(Controller::RIGHT)));
605 get_item_by_id((int) Controller::JUMP).change_input(get_key_name(
606 controller->reversemap_key(Controller::JUMP)));
607 get_item_by_id((int) Controller::ACTION).change_input(get_key_name(
608 controller->reversemap_key(Controller::ACTION)));
611 //---------------------------------------------------------------------------
613 JoystickKeyboardController::JoystickMenu::JoystickMenu(
614 JoystickKeyboardController* _controller)
615 : controller(_controller)
617 add_label(_("Joystick Setup"));
619 if(controller->joysticks.size() > 0) {
620 add_controlfield(Controller::JUMP, _("Jump"));
621 add_controlfield(Controller::ACTION, _("Shoot/Run"));
622 add_controlfield(Controller::PAUSE_MENU, _("Pause/Menu"));
624 add_deactive(-1, _("No Joysticks found"));
631 JoystickKeyboardController::JoystickMenu::~JoystickMenu()
635 JoystickKeyboardController::JoystickMenu::get_button_name(int button)
640 std::ostringstream name;
641 name << "Button " << button;
646 JoystickKeyboardController::JoystickMenu::menu_action(MenuItem* item)
648 assert(item->id >= 0 && item->id < Controller::CONTROLCOUNT);
649 item->change_input(_("Press Button"));
650 controller->wait_for_joybutton = item->id;
654 JoystickKeyboardController::JoystickMenu::update()
656 if(controller->joysticks.size() == 0)
660 get_item_by_id((int) Controller::JUMP).change_input(get_button_name(
661 controller->reversemap_joybutton(Controller::JUMP)));
662 get_item_by_id((int) Controller::ACTION).change_input(get_button_name(
663 controller->reversemap_joybutton(Controller::ACTION)));
664 get_item_by_id((int) Controller::PAUSE_MENU).change_input(get_button_name(
665 controller->reversemap_joybutton(Controller::PAUSE_MENU)));