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);
164 if (g_haptic_manager != NULL)
165 g_haptic_manager->addJoystick (joystick);
169 // some joysticks or SDL seem to produce some bogus events after being opened
170 Uint32 ticks = SDL_GetTicks();
171 while(SDL_GetTicks() - ticks < 200) {
173 SDL_PollEvent(&event);
178 JoystickKeyboardController::read(const Reader& lisp)
180 const lisp::Lisp* keymap_lisp = lisp.get_lisp("keymap");
183 keymap_lisp->get("jump-with-up", jump_with_up_kbd);
184 lisp::ListIterator iter(keymap_lisp);
186 if(iter.item() == "map") {
189 const lisp::Lisp* map = iter.lisp();
190 map->get("key", key);
191 map->get("control", control);
192 #if SDL_VERSION_ATLEAST(1,3,0)
195 if(key < SDLK_FIRST || key >= SDLK_LAST)
198 log_info << "Invalid key '" << key << "' in keymap" << std::endl;
203 for(i = 0; controlNames[i] != 0; ++i) {
204 if(control == controlNames[i])
207 if(controlNames[i] == 0) {
208 log_info << "Invalid control '" << control << "' in keymap" << std::endl;
211 keymap[(SDLKey) key] = (Control)i;
216 const lisp::Lisp* joystick_lisp = lisp.get_lisp("joystick");
218 joystick_lisp->get("dead-zone", dead_zone);
219 joystick_lisp->get("jump-with-up", jump_with_up_joy);
220 lisp::ListIterator iter(joystick_lisp);
222 if(iter.item() == "map") {
227 const lisp::Lisp* map = iter.lisp();
229 map->get("control", control);
231 for(i = 0; controlNames[i] != 0; ++i) {
232 if(control == controlNames[i])
235 if(controlNames[i] == 0) {
236 log_info << "Invalid control '" << control << "' in buttonmap" << std::endl;
240 if (map->get("button", button)) {
241 if(button < 0 || button >= max_joybuttons) {
242 log_info << "Invalid button '" << button << "' in buttonmap" << std::endl;
245 bind_joybutton(button, (Control) i);
248 if (map->get("axis", axis)) {
249 if (axis == 0 || abs(axis) > max_joyaxis) {
250 log_info << "Invalid axis '" << axis << "' in axismap" << std::endl;
253 bind_joyaxis(axis, (Control) i);
256 if (map->get("hat", hat)) {
257 if (hat != SDL_HAT_UP &&
258 hat != SDL_HAT_DOWN &&
259 hat != SDL_HAT_LEFT &&
260 hat != SDL_HAT_RIGHT) {
261 log_info << "Invalid axis '" << axis << "' in axismap" << std::endl;
264 bind_joyhat(hat, (Control) i);
273 JoystickKeyboardController::write(Writer& writer)
275 writer.start_list("keymap");
276 writer.write("jump-with-up", jump_with_up_kbd);
277 for(KeyMap::iterator i = keymap.begin(); i != keymap.end(); ++i) {
278 writer.start_list("map");
279 writer.write("key", (int) i->first);
280 writer.write("control", controlNames[i->second]);
281 writer.end_list("map");
283 writer.end_list("keymap");
285 writer.start_list("joystick");
286 writer.write("dead-zone", dead_zone);
287 writer.write("jump-with-up", jump_with_up_joy);
289 for(ButtonMap::iterator i = joy_button_map.begin(); i != joy_button_map.end();
291 writer.start_list("map");
292 writer.write("button", i->first);
293 writer.write("control", controlNames[i->second]);
294 writer.end_list("map");
297 for(HatMap::iterator i = joy_hat_map.begin(); i != joy_hat_map.end(); ++i) {
298 writer.start_list("map");
299 writer.write("hat", i->first);
300 writer.write("control", controlNames[i->second]);
301 writer.end_list("map");
304 for(AxisMap::iterator i = joy_axis_map.begin(); i != joy_axis_map.end(); ++i) {
305 writer.start_list("map");
306 writer.write("axis", i->first);
307 writer.write("control", controlNames[i->second]);
308 writer.end_list("map");
311 writer.end_list("joystick");
315 JoystickKeyboardController::reset()
321 JoystickKeyboardController::set_joy_controls(Control id, bool value)
323 if (jump_with_up_joy && id == Controller::UP)
324 controls[Controller::JUMP] = value;
326 controls[(Control)id] = value;
330 JoystickKeyboardController::process_event(const SDL_Event& event)
335 process_key_event(event);
338 case SDL_JOYAXISMOTION:
339 process_axis_event(event.jaxis);
342 case SDL_JOYHATMOTION:
343 process_hat_event(event.jhat);
346 case SDL_JOYBUTTONDOWN:
347 case SDL_JOYBUTTONUP:
348 process_button_event(event.jbutton);
357 JoystickKeyboardController::process_button_event(const SDL_JoyButtonEvent& jbutton)
359 if(wait_for_joystick >= 0)
361 if(jbutton.state == SDL_PRESSED)
363 bind_joybutton(jbutton.button, (Control)wait_for_joystick);
364 MenuStorage::get_joystick_options_menu()->update();
366 wait_for_joystick = -1;
371 ButtonMap::iterator i = joy_button_map.find(jbutton.button);
372 if(i == joy_button_map.end()) {
373 log_debug << "Unmapped joybutton " << (int)jbutton.button << " pressed" << std::endl;
375 set_joy_controls(i->second, (jbutton.state == SDL_PRESSED));
381 JoystickKeyboardController::process_axis_event(const SDL_JoyAxisEvent& jaxis)
383 if (wait_for_joystick >= 0)
385 if (abs(jaxis.value) > dead_zone) {
387 bind_joyaxis(-(jaxis.axis + 1), Control(wait_for_joystick));
389 bind_joyaxis(jaxis.axis + 1, Control(wait_for_joystick));
391 MenuStorage::get_joystick_options_menu()->update();
392 wait_for_joystick = -1;
397 // Split the axis into left and right, so that both can be
398 // mapped separately (needed for jump/down vs up/down)
399 int axis = jaxis.axis + 1;
401 AxisMap::iterator left = joy_axis_map.find(-axis);
402 AxisMap::iterator right = joy_axis_map.find(axis);
404 if(left == joy_axis_map.end()) {
405 std::cout << "Unmapped joyaxis " << (int)jaxis.axis << " moved" << std::endl;
407 if (jaxis.value < -dead_zone)
408 set_joy_controls(left->second, true);
409 else if (jaxis.value > dead_zone)
410 set_joy_controls(left->second, false);
412 set_joy_controls(left->second, false);
415 if(right == joy_axis_map.end()) {
416 std::cout << "Unmapped joyaxis " << (int)jaxis.axis << " moved" << std::endl;
418 if (jaxis.value < -dead_zone)
419 set_joy_controls(right->second, false);
420 else if (jaxis.value > dead_zone)
421 set_joy_controls(right->second, true);
423 set_joy_controls(right->second, false);
429 JoystickKeyboardController::process_hat_event(const SDL_JoyHatEvent& jhat)
431 Uint8 changed = hat_state ^ jhat.value;
433 if (wait_for_joystick >= 0)
435 if (changed & SDL_HAT_UP && jhat.value & SDL_HAT_UP)
436 bind_joyhat(SDL_HAT_UP, (Control)wait_for_joystick);
438 if (changed & SDL_HAT_DOWN && jhat.value & SDL_HAT_DOWN)
439 bind_joyhat(SDL_HAT_DOWN, (Control)wait_for_joystick);
441 if (changed & SDL_HAT_LEFT && jhat.value & SDL_HAT_LEFT)
442 bind_joyhat(SDL_HAT_LEFT, (Control)wait_for_joystick);
444 if (changed & SDL_HAT_RIGHT && jhat.value & SDL_HAT_RIGHT)
445 bind_joyhat(SDL_HAT_RIGHT, (Control)wait_for_joystick);
447 MenuStorage::get_joystick_options_menu()->update();
448 wait_for_joystick = -1;
452 if (changed & SDL_HAT_UP)
454 HatMap::iterator it = joy_hat_map.find(SDL_HAT_UP);
455 if (it != joy_hat_map.end())
456 set_joy_controls(it->second, jhat.value & SDL_HAT_UP);
459 if (changed & SDL_HAT_DOWN)
461 HatMap::iterator it = joy_hat_map.find(SDL_HAT_DOWN);
462 if (it != joy_hat_map.end())
463 set_joy_controls(it->second, jhat.value & SDL_HAT_DOWN);
466 if (changed & SDL_HAT_LEFT)
468 HatMap::iterator it = joy_hat_map.find(SDL_HAT_LEFT);
469 if (it != joy_hat_map.end())
470 set_joy_controls(it->second, jhat.value & SDL_HAT_LEFT);
473 if (changed & SDL_HAT_RIGHT)
475 HatMap::iterator it = joy_hat_map.find(SDL_HAT_RIGHT);
476 if (it != joy_hat_map.end())
477 set_joy_controls(it->second, jhat.value & SDL_HAT_RIGHT);
481 hat_state = jhat.value;
485 JoystickKeyboardController::process_key_event(const SDL_Event& event)
487 KeyMap::iterator key_mapping = keymap.find(event.key.keysym.sym);
489 // if console key was pressed: toggle console
490 if ((key_mapping != keymap.end()) && (key_mapping->second == CONSOLE)) {
491 if (event.type == SDL_KEYDOWN)
492 Console::instance->toggle();
494 if (Console::instance->hasFocus()) {
495 // if console is open: send key there
496 process_console_key_event(event);
497 } else if (MenuManager::current()) {
498 // if menu mode: send key there
499 process_menu_key_event(event);
500 } else if(key_mapping == keymap.end()) {
501 // default action: update controls
502 //log_debug << "Key " << event.key.keysym.sym << " is unbound" << std::endl;
504 Control control = key_mapping->second;
505 controls[control] = (event.type == SDL_KEYDOWN);
506 if (jump_with_up_kbd && control == UP){
507 controls[JUMP] = (event.type == SDL_KEYDOWN);
514 JoystickKeyboardController::process_console_key_event(const SDL_Event& event)
516 if (event.type != SDL_KEYDOWN) return;
518 switch (event.key.keysym.sym) {
520 Console::instance->enter();
523 Console::instance->backspace();
526 Console::instance->autocomplete();
529 Console::instance->scroll(-1);
532 Console::instance->scroll(+1);
535 Console::instance->move_cursor(-65535);
538 Console::instance->move_cursor(+65535);
541 Console::instance->show_history(-1);
544 Console::instance->show_history(+1);
547 Console::instance->move_cursor(-1);
550 Console::instance->move_cursor(+1);
553 int c = event.key.keysym.unicode;
554 if ((c >= 32) && (c <= 126)) {
555 Console::instance->input((char)c);
562 JoystickKeyboardController::process_menu_key_event(const SDL_Event& event)
564 // wait for key mode?
565 if(wait_for_key >= 0) {
566 if(event.type == SDL_KEYUP)
569 if(event.key.keysym.sym != SDLK_ESCAPE
570 && event.key.keysym.sym != SDLK_PAUSE) {
571 bind_key(event.key.keysym.sym, (Control) wait_for_key);
574 MenuStorage::get_key_options_menu()->update();
578 if(wait_for_joystick >= 0) {
579 if(event.key.keysym.sym == SDLK_ESCAPE) {
581 MenuStorage::get_joystick_options_menu()->update();
582 wait_for_joystick = -1;
588 /* we use default keys when the menu is open (to avoid problems when
589 * redefining keys to invalid settings
591 switch(event.key.keysym.sym) {
607 control = MENU_SELECT;
611 control = PAUSE_MENU;
618 controls[control] = (event.type == SDL_KEYDOWN);
622 JoystickKeyboardController::unbind_joystick_control(Control control)
624 // remove all previous mappings for that control
625 for(AxisMap::iterator i = joy_axis_map.begin(); i != joy_axis_map.end(); /* no ++i */) {
626 if(i->second == control)
627 joy_axis_map.erase(i++);
632 for(ButtonMap::iterator i = joy_button_map.begin(); i != joy_button_map.end(); /* no ++i */) {
633 if(i->second == control)
634 joy_button_map.erase(i++);
639 for(HatMap::iterator i = joy_hat_map.begin(); i != joy_hat_map.end(); /* no ++i */) {
640 if(i->second == control)
641 joy_hat_map.erase(i++);
648 JoystickKeyboardController::bind_joyaxis(int axis, Control control)
650 // axis isn't the SDL axis number, but axisnumber + 1 with sign
651 // changed depending on if the positive or negative end is to be
652 // used (negative axis 0 becomes -1, positive axis 2 becomes +3,
655 unbind_joystick_control(control);
658 joy_axis_map[axis] = control;
662 JoystickKeyboardController::bind_joyhat(int dir, Control c)
664 unbind_joystick_control(c);
667 joy_hat_map[dir] = c;
671 JoystickKeyboardController::bind_joybutton(int button, Control control)
673 unbind_joystick_control(control);
676 joy_button_map[button] = control;
680 JoystickKeyboardController::bind_key(SDLKey key, Control control)
682 // remove all previous mappings for that control and for that key
683 for(KeyMap::iterator i = keymap.begin();
684 i != keymap.end(); /* no ++i */) {
685 if(i->second == control) {
686 KeyMap::iterator e = i;
694 KeyMap::iterator i = keymap.find(key);
695 if(i != keymap.end())
699 keymap[key]= control;
703 JoystickKeyboardController::print_joystick_mappings()
705 std::cout << "Joystick Mappings" << std::endl;
706 std::cout << "-----------------" << std::endl;
707 for(AxisMap::iterator i = joy_axis_map.begin(); i != joy_axis_map.end(); ++i) {
708 std::cout << "Axis: " << i->first << " -> " << i->second << std::endl;
711 for(ButtonMap::iterator i = joy_button_map.begin(); i != joy_button_map.end(); ++i) {
712 std::cout << "Button: " << i->first << " -> " << i->second << std::endl;
715 for(HatMap::iterator i = joy_hat_map.begin(); i != joy_hat_map.end(); ++i) {
716 std::cout << "Hat: " << i->first << " -> " << i->second << std::endl;
718 std::cout << std::endl;
722 JoystickKeyboardController::reversemap_key(Control c)
724 for(KeyMap::iterator i = keymap.begin(); i != keymap.end(); ++i) {
733 JoystickKeyboardController::reversemap_joyaxis(Control c)
735 for(AxisMap::iterator i = joy_axis_map.begin(); i != joy_axis_map.end(); ++i) {
744 JoystickKeyboardController::reversemap_joybutton(Control c)
746 for(ButtonMap::iterator i = joy_button_map.begin(); i != joy_button_map.end(); ++i) {
755 JoystickKeyboardController::reversemap_joyhat(Control c)
757 for(HatMap::iterator i = joy_hat_map.begin(); i != joy_hat_map.end(); ++i) {