2 // Copyright (C) 2006 Matthias Braun <matze@braunis.de>,
3 // 2007 Ingo Ruhnke <grumbel@gmx.de>
5 // This program is free software: you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License as published by
7 // the Free Software Foundation, either version 3 of the License, or
8 // (at your option) any later version.
10 // This program is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 // GNU General Public License for more details.
15 // You should have received a copy of the GNU General Public License
16 // along with this program. If not, see <http://www.gnu.org/licenses/>.
18 #include "control/joystickkeyboardcontroller.hpp"
22 #include "lisp/list_iterator.hpp"
23 #include "gui/menu_manager.hpp"
24 #include "supertux/console.hpp"
25 #include "supertux/gameconfig.hpp"
26 #include "supertux/menu/menu_storage.hpp"
27 #include "supertux/menu/joystick_menu.hpp"
28 #include "supertux/menu/keyboard_menu.hpp"
29 #include "util/gettext.hpp"
30 #include "util/writer.hpp"
32 JoystickKeyboardController::JoystickKeyboardController() :
50 // initialize default keyboard map
51 keymap[SDLK_LEFT] = LEFT;
52 keymap[SDLK_RIGHT] = RIGHT;
54 keymap[SDLK_DOWN] = DOWN;
55 keymap[SDLK_SPACE] = JUMP;
56 keymap[SDLK_LCTRL] = ACTION;
57 keymap[SDLK_LALT] = ACTION;
58 keymap[SDLK_ESCAPE] = PAUSE_MENU;
59 keymap[SDLK_p] = PAUSE_MENU;
60 keymap[SDLK_PAUSE] = PAUSE_MENU;
61 keymap[SDLK_RETURN] = MENU_SELECT;
62 keymap[SDLK_KP_ENTER] = MENU_SELECT;
63 keymap[SDLK_CARET] = CONSOLE;
64 keymap[SDLK_DELETE] = PEEK_LEFT;
65 keymap[SDLK_PAGEDOWN] = PEEK_RIGHT;
66 keymap[SDLK_HOME] = PEEK_UP;
67 keymap[SDLK_END] = PEEK_DOWN;
69 jump_with_up_joy = false;
70 jump_with_up_kbd = false;
72 updateAvailableJoysticks();
76 // Default joystick button configuration
77 joy_button_map[0] = JUMP;
78 joy_button_map[1] = ACTION;
80 if( min_joybuttons > 5 ){
81 joy_button_map[4] = PEEK_LEFT;
82 joy_button_map[5] = PEEK_RIGHT;
84 if(min_joybuttons > 7)
85 joy_button_map[min_joybuttons-1] = PAUSE_MENU;
87 // map the last 2 buttons to menu and pause
88 if(min_joybuttons > 2)
89 joy_button_map[min_joybuttons-1] = PAUSE_MENU;
90 // map all remaining joystick buttons to MENU_SELECT
91 for(int i = 2; i < max_joybuttons; ++i) {
92 if(i != min_joybuttons-1)
93 joy_button_map[i] = MENU_SELECT;
97 // Default joystick axis configuration
98 joy_axis_map[-1] = LEFT;
99 joy_axis_map[ 1] = RIGHT;
100 joy_axis_map[-2] = UP;
101 joy_axis_map[ 2] = DOWN;
104 JoystickKeyboardController::~JoystickKeyboardController()
106 for(std::vector<SDL_Joystick*>::iterator i = joysticks.begin();
107 i != joysticks.end(); ++i) {
109 SDL_JoystickClose(*i);
114 JoystickKeyboardController::updateAvailableJoysticks()
116 for(std::vector<SDL_Joystick*>::iterator i = joysticks.begin();
117 i != joysticks.end(); ++i) {
119 SDL_JoystickClose(*i);
123 SDL_QuitSubSystem(SDL_INIT_JOYSTICK);
124 SDL_InitSubSystem(SDL_INIT_JOYSTICK);
126 int joystick_count = SDL_NumJoysticks();
132 if( joystick_count > 0 ){
133 for(int i = 0; i < joystick_count; ++i) {
134 SDL_Joystick* joystick = SDL_JoystickOpen(i);
136 if(SDL_JoystickNumButtons(joystick) < 2) {
137 log_info << "Joystick " << i << ": " << SDL_JoystickName(i) << " has less than 2 buttons" << std::endl;
140 if(SDL_JoystickNumAxes(joystick) < 2
141 && SDL_JoystickNumHats(joystick) == 0) {
142 log_info << "Joystick " << i << ": " << SDL_JoystickName(i) << " has less than 2 axes and no hat" << std::endl;
146 SDL_JoystickClose(joystick);
150 if(min_joybuttons < 0 || SDL_JoystickNumButtons(joystick) < min_joybuttons)
151 min_joybuttons = SDL_JoystickNumButtons(joystick);
153 if(SDL_JoystickNumButtons(joystick) > max_joybuttons)
154 max_joybuttons = SDL_JoystickNumButtons(joystick);
156 if(SDL_JoystickNumAxes(joystick) > max_joyaxis)
157 max_joyaxis = SDL_JoystickNumAxes(joystick);
159 if(SDL_JoystickNumHats(joystick) > max_joyhats)
160 max_joyhats = SDL_JoystickNumHats(joystick);
162 joysticks.push_back(joystick);
166 // some joysticks or SDL seem to produce some bogus events after being opened
167 Uint32 ticks = SDL_GetTicks();
168 while(SDL_GetTicks() - ticks < 200) {
170 SDL_PollEvent(&event);
175 JoystickKeyboardController::read(const Reader& lisp)
177 const lisp::Lisp* keymap_lisp = lisp.get_lisp("keymap");
180 keymap_lisp->get("jump-with-up", jump_with_up_kbd);
181 lisp::ListIterator iter(keymap_lisp);
183 if(iter.item() == "map") {
186 const lisp::Lisp* map = iter.lisp();
187 map->get("key", key);
188 map->get("control", control);
189 #if SDL_VERSION_ATLEAST(1,3,0)
192 if(key < SDLK_FIRST || key >= SDLK_LAST)
195 log_info << "Invalid key '" << key << "' in keymap" << std::endl;
200 for(i = 0; controlNames[i] != 0; ++i) {
201 if(control == controlNames[i])
204 if(controlNames[i] == 0) {
205 log_info << "Invalid control '" << control << "' in keymap" << std::endl;
208 keymap[(SDLKey) key] = (Control)i;
213 const lisp::Lisp* joystick_lisp = lisp.get_lisp("joystick");
215 joystick_lisp->get("dead-zone", dead_zone);
216 joystick_lisp->get("jump-with-up", jump_with_up_joy);
217 lisp::ListIterator iter(joystick_lisp);
219 if(iter.item() == "map") {
224 const lisp::Lisp* map = iter.lisp();
226 map->get("control", control);
228 for(i = 0; controlNames[i] != 0; ++i) {
229 if(control == controlNames[i])
232 if(controlNames[i] == 0) {
233 log_info << "Invalid control '" << control << "' in buttonmap" << std::endl;
237 if (map->get("button", button)) {
238 if(button < 0 || button >= max_joybuttons) {
239 log_info << "Invalid button '" << button << "' in buttonmap" << std::endl;
242 bind_joybutton(button, (Control) i);
245 if (map->get("axis", axis)) {
246 if (axis == 0 || abs(axis) > max_joyaxis) {
247 log_info << "Invalid axis '" << axis << "' in axismap" << std::endl;
250 bind_joyaxis(axis, (Control) i);
253 if (map->get("hat", hat)) {
254 if (hat != SDL_HAT_UP &&
255 hat != SDL_HAT_DOWN &&
256 hat != SDL_HAT_LEFT &&
257 hat != SDL_HAT_RIGHT) {
258 log_info << "Invalid axis '" << axis << "' in axismap" << std::endl;
261 bind_joyhat(hat, (Control) i);
270 JoystickKeyboardController::write(Writer& writer)
272 writer.start_list("keymap");
273 writer.write("jump-with-up", jump_with_up_kbd);
274 for(KeyMap::iterator i = keymap.begin(); i != keymap.end(); ++i) {
275 writer.start_list("map");
276 writer.write("key", (int) i->first);
277 writer.write("control", controlNames[i->second]);
278 writer.end_list("map");
280 writer.end_list("keymap");
282 writer.start_list("joystick");
283 writer.write("dead-zone", dead_zone);
284 writer.write("jump-with-up", jump_with_up_joy);
286 for(ButtonMap::iterator i = joy_button_map.begin(); i != joy_button_map.end();
288 writer.start_list("map");
289 writer.write("button", i->first);
290 writer.write("control", controlNames[i->second]);
291 writer.end_list("map");
294 for(HatMap::iterator i = joy_hat_map.begin(); i != joy_hat_map.end(); ++i) {
295 writer.start_list("map");
296 writer.write("hat", i->first);
297 writer.write("control", controlNames[i->second]);
298 writer.end_list("map");
301 for(AxisMap::iterator i = joy_axis_map.begin(); i != joy_axis_map.end(); ++i) {
302 writer.start_list("map");
303 writer.write("axis", i->first);
304 writer.write("control", controlNames[i->second]);
305 writer.end_list("map");
308 writer.end_list("joystick");
312 JoystickKeyboardController::reset()
318 JoystickKeyboardController::set_joy_controls(Control id, bool value)
320 if (jump_with_up_joy && id == Controller::UP)
321 controls[Controller::JUMP] = value;
323 controls[(Control)id] = value;
327 JoystickKeyboardController::process_event(const SDL_Event& event)
332 process_key_event(event);
335 case SDL_JOYAXISMOTION:
336 process_axis_event(event.jaxis);
339 case SDL_JOYHATMOTION:
340 process_hat_event(event.jhat);
343 case SDL_JOYBUTTONDOWN:
344 case SDL_JOYBUTTONUP:
345 process_button_event(event.jbutton);
354 JoystickKeyboardController::process_button_event(const SDL_JoyButtonEvent& jbutton)
356 if(wait_for_joystick >= 0)
358 if(jbutton.state == SDL_PRESSED)
360 bind_joybutton(jbutton.button, (Control)wait_for_joystick);
361 MenuStorage::get_joystick_options_menu()->update();
363 wait_for_joystick = -1;
368 ButtonMap::iterator i = joy_button_map.find(jbutton.button);
369 if(i == joy_button_map.end()) {
370 log_debug << "Unmapped joybutton " << (int)jbutton.button << " pressed" << std::endl;
372 set_joy_controls(i->second, (jbutton.state == SDL_PRESSED));
378 JoystickKeyboardController::process_axis_event(const SDL_JoyAxisEvent& jaxis)
380 if (wait_for_joystick >= 0)
382 if (abs(jaxis.value) > dead_zone) {
384 bind_joyaxis(-(jaxis.axis + 1), Control(wait_for_joystick));
386 bind_joyaxis(jaxis.axis + 1, Control(wait_for_joystick));
388 MenuStorage::get_joystick_options_menu()->update();
389 wait_for_joystick = -1;
394 // Split the axis into left and right, so that both can be
395 // mapped separately (needed for jump/down vs up/down)
396 int axis = jaxis.axis + 1;
398 AxisMap::iterator left = joy_axis_map.find(-axis);
399 AxisMap::iterator right = joy_axis_map.find(axis);
401 if(left == joy_axis_map.end()) {
402 std::cout << "Unmapped joyaxis " << (int)jaxis.axis << " moved" << std::endl;
404 if (jaxis.value < -dead_zone)
405 set_joy_controls(left->second, true);
406 else if (jaxis.value > dead_zone)
407 set_joy_controls(left->second, false);
409 set_joy_controls(left->second, false);
412 if(right == joy_axis_map.end()) {
413 std::cout << "Unmapped joyaxis " << (int)jaxis.axis << " moved" << std::endl;
415 if (jaxis.value < -dead_zone)
416 set_joy_controls(right->second, false);
417 else if (jaxis.value > dead_zone)
418 set_joy_controls(right->second, true);
420 set_joy_controls(right->second, false);
426 JoystickKeyboardController::process_hat_event(const SDL_JoyHatEvent& jhat)
428 Uint8 changed = hat_state ^ jhat.value;
430 if (wait_for_joystick >= 0)
432 if (changed & SDL_HAT_UP && jhat.value & SDL_HAT_UP)
433 bind_joyhat(SDL_HAT_UP, (Control)wait_for_joystick);
435 if (changed & SDL_HAT_DOWN && jhat.value & SDL_HAT_DOWN)
436 bind_joyhat(SDL_HAT_DOWN, (Control)wait_for_joystick);
438 if (changed & SDL_HAT_LEFT && jhat.value & SDL_HAT_LEFT)
439 bind_joyhat(SDL_HAT_LEFT, (Control)wait_for_joystick);
441 if (changed & SDL_HAT_RIGHT && jhat.value & SDL_HAT_RIGHT)
442 bind_joyhat(SDL_HAT_RIGHT, (Control)wait_for_joystick);
444 MenuStorage::get_joystick_options_menu()->update();
445 wait_for_joystick = -1;
449 if (changed & SDL_HAT_UP)
451 HatMap::iterator it = joy_hat_map.find(SDL_HAT_UP);
452 if (it != joy_hat_map.end())
453 set_joy_controls(it->second, jhat.value & SDL_HAT_UP);
456 if (changed & SDL_HAT_DOWN)
458 HatMap::iterator it = joy_hat_map.find(SDL_HAT_DOWN);
459 if (it != joy_hat_map.end())
460 set_joy_controls(it->second, jhat.value & SDL_HAT_DOWN);
463 if (changed & SDL_HAT_LEFT)
465 HatMap::iterator it = joy_hat_map.find(SDL_HAT_LEFT);
466 if (it != joy_hat_map.end())
467 set_joy_controls(it->second, jhat.value & SDL_HAT_LEFT);
470 if (changed & SDL_HAT_RIGHT)
472 HatMap::iterator it = joy_hat_map.find(SDL_HAT_RIGHT);
473 if (it != joy_hat_map.end())
474 set_joy_controls(it->second, jhat.value & SDL_HAT_RIGHT);
478 hat_state = jhat.value;
482 JoystickKeyboardController::process_key_event(const SDL_Event& event)
484 KeyMap::iterator key_mapping = keymap.find(event.key.keysym.sym);
486 // if console key was pressed: toggle console
487 if ((key_mapping != keymap.end()) && (key_mapping->second == CONSOLE)) {
488 if (event.type == SDL_KEYDOWN)
489 Console::instance->toggle();
491 if (Console::instance->hasFocus()) {
492 // if console is open: send key there
493 process_console_key_event(event);
494 } else if (MenuManager::current()) {
495 // if menu mode: send key there
496 process_menu_key_event(event);
497 } else if(key_mapping == keymap.end()) {
498 // default action: update controls
499 //log_debug << "Key " << event.key.keysym.sym << " is unbound" << std::endl;
501 Control control = key_mapping->second;
502 controls[control] = (event.type == SDL_KEYDOWN);
503 if (jump_with_up_kbd && control == UP){
504 controls[JUMP] = (event.type == SDL_KEYDOWN);
511 JoystickKeyboardController::process_console_key_event(const SDL_Event& event)
513 if (event.type != SDL_KEYDOWN) return;
515 switch (event.key.keysym.sym) {
517 Console::instance->enter();
520 Console::instance->backspace();
523 Console::instance->autocomplete();
526 Console::instance->scroll(-1);
529 Console::instance->scroll(+1);
532 Console::instance->move_cursor(-65535);
535 Console::instance->move_cursor(+65535);
538 Console::instance->show_history(-1);
541 Console::instance->show_history(+1);
544 Console::instance->move_cursor(-1);
547 Console::instance->move_cursor(+1);
550 int c = event.key.keysym.unicode;
551 if ((c >= 32) && (c <= 126)) {
552 Console::instance->input((char)c);
559 JoystickKeyboardController::process_menu_key_event(const SDL_Event& event)
561 // wait for key mode?
562 if(wait_for_key >= 0) {
563 if(event.type == SDL_KEYUP)
566 if(event.key.keysym.sym != SDLK_ESCAPE
567 && event.key.keysym.sym != SDLK_PAUSE) {
568 bind_key(event.key.keysym.sym, (Control) wait_for_key);
571 MenuStorage::get_key_options_menu()->update();
575 if(wait_for_joystick >= 0) {
576 if(event.key.keysym.sym == SDLK_ESCAPE) {
578 MenuStorage::get_joystick_options_menu()->update();
579 wait_for_joystick = -1;
585 /* we use default keys when the menu is open (to avoid problems when
586 * redefining keys to invalid settings
588 switch(event.key.keysym.sym) {
604 control = MENU_SELECT;
608 control = PAUSE_MENU;
615 controls[control] = (event.type == SDL_KEYDOWN);
619 JoystickKeyboardController::unbind_joystick_control(Control control)
621 // remove all previous mappings for that control
622 for(AxisMap::iterator i = joy_axis_map.begin(); i != joy_axis_map.end(); /* no ++i */) {
623 if(i->second == control)
624 joy_axis_map.erase(i++);
629 for(ButtonMap::iterator i = joy_button_map.begin(); i != joy_button_map.end(); /* no ++i */) {
630 if(i->second == control)
631 joy_button_map.erase(i++);
636 for(HatMap::iterator i = joy_hat_map.begin(); i != joy_hat_map.end(); /* no ++i */) {
637 if(i->second == control)
638 joy_hat_map.erase(i++);
645 JoystickKeyboardController::bind_joyaxis(int axis, Control control)
647 // axis isn't the SDL axis number, but axisnumber + 1 with sign
648 // changed depending on if the positive or negative end is to be
649 // used (negative axis 0 becomes -1, positive axis 2 becomes +3,
652 unbind_joystick_control(control);
655 joy_axis_map[axis] = control;
659 JoystickKeyboardController::bind_joyhat(int dir, Control c)
661 unbind_joystick_control(c);
664 joy_hat_map[dir] = c;
668 JoystickKeyboardController::bind_joybutton(int button, Control control)
670 unbind_joystick_control(control);
673 joy_button_map[button] = control;
677 JoystickKeyboardController::bind_key(SDLKey key, Control control)
679 // remove all previous mappings for that control and for that key
680 for(KeyMap::iterator i = keymap.begin();
681 i != keymap.end(); /* no ++i */) {
682 if(i->second == control) {
683 KeyMap::iterator e = i;
691 KeyMap::iterator i = keymap.find(key);
692 if(i != keymap.end())
696 keymap[key]= control;
700 JoystickKeyboardController::print_joystick_mappings()
702 std::cout << "Joystick Mappings" << std::endl;
703 std::cout << "-----------------" << std::endl;
704 for(AxisMap::iterator i = joy_axis_map.begin(); i != joy_axis_map.end(); ++i) {
705 std::cout << "Axis: " << i->first << " -> " << i->second << std::endl;
708 for(ButtonMap::iterator i = joy_button_map.begin(); i != joy_button_map.end(); ++i) {
709 std::cout << "Button: " << i->first << " -> " << i->second << std::endl;
712 for(HatMap::iterator i = joy_hat_map.begin(); i != joy_hat_map.end(); ++i) {
713 std::cout << "Hat: " << i->first << " -> " << i->second << std::endl;
715 std::cout << std::endl;
719 JoystickKeyboardController::reversemap_key(Control c)
721 for(KeyMap::iterator i = keymap.begin(); i != keymap.end(); ++i) {
730 JoystickKeyboardController::reversemap_joyaxis(Control c)
732 for(AxisMap::iterator i = joy_axis_map.begin(); i != joy_axis_map.end(); ++i) {
741 JoystickKeyboardController::reversemap_joybutton(Control c)
743 for(ButtonMap::iterator i = joy_button_map.begin(); i != joy_button_map.end(); ++i) {
752 JoystickKeyboardController::reversemap_joyhat(Control c)
754 for(HatMap::iterator i = joy_hat_map.begin(); i != joy_hat_map.end(); ++i) {