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() :
51 controller = new Controller;
53 // initialize default keyboard map
54 keymap[SDLK_LEFT] = Controller::LEFT;
55 keymap[SDLK_RIGHT] = Controller::RIGHT;
56 keymap[SDLK_UP] = Controller::UP;
57 keymap[SDLK_DOWN] = Controller::DOWN;
58 keymap[SDLK_SPACE] = Controller::JUMP;
59 keymap[SDLK_LCTRL] = Controller::ACTION;
60 keymap[SDLK_LALT] = Controller::ACTION;
61 keymap[SDLK_ESCAPE] = Controller::PAUSE_MENU;
62 keymap[SDLK_p] = Controller::PAUSE_MENU;
63 keymap[SDLK_PAUSE] = Controller::PAUSE_MENU;
64 keymap[SDLK_RETURN] = Controller::MENU_SELECT;
65 keymap[SDLK_KP_ENTER] = Controller::MENU_SELECT;
66 keymap[SDLK_CARET] = Controller::CONSOLE;
67 keymap[SDLK_DELETE] = Controller::PEEK_LEFT;
68 keymap[SDLK_PAGEDOWN] = Controller::PEEK_RIGHT;
69 keymap[SDLK_HOME] = Controller::PEEK_UP;
70 keymap[SDLK_END] = Controller::PEEK_DOWN;
72 jump_with_up_joy = false;
73 jump_with_up_kbd = false;
75 updateAvailableJoysticks();
79 // Default joystick button configuration
80 bind_joybutton(0, 0, Controller::JUMP);
81 bind_joybutton(0, 1, Controller::ACTION);
83 if( min_joybuttons > 5 ){
84 bind_joybutton(0, 4, Controller::PEEK_LEFT);
85 bind_joybutton(0, 5, Controller::PEEK_RIGHT);
87 if(min_joybuttons > 7)
88 bind_joybutton(0, min_joybuttons-1, Controller::PAUSE_MENU);
90 // map the last 2 buttons to menu and pause
91 if(min_joybuttons > 2)
92 bind_joybutton(0, min_joybuttons-1, Controller::PAUSE_MENU);
93 // map all remaining joystick buttons to MENU_SELECT
94 for(int i = 2; i < max_joybuttons; ++i) {
95 if(i != min_joybuttons-1)
96 bind_joybutton(0, i, Controller::MENU_SELECT);
100 // Default joystick axis configuration
101 bind_joyaxis(0, -1, Controller::LEFT);
102 bind_joyaxis(0, 1, Controller::RIGHT);
103 bind_joyaxis(0, -2, Controller::UP);
104 bind_joyaxis(0, 2, Controller::DOWN);
107 JoystickKeyboardController::~JoystickKeyboardController()
109 for(std::vector<SDL_Joystick*>::iterator i = joysticks.begin();
110 i != joysticks.end(); ++i) {
112 SDL_JoystickClose(*i);
118 JoystickKeyboardController::updateAvailableJoysticks()
120 for(std::vector<SDL_Joystick*>::iterator i = joysticks.begin();
121 i != joysticks.end(); ++i) {
123 SDL_JoystickClose(*i);
127 SDL_QuitSubSystem(SDL_INIT_JOYSTICK);
128 SDL_InitSubSystem(SDL_INIT_JOYSTICK);
130 int joystick_count = SDL_NumJoysticks();
136 if( joystick_count > 0 ){
137 for(int i = 0; i < joystick_count; ++i) {
138 SDL_Joystick* joystick = SDL_JoystickOpen(i);
140 if(SDL_JoystickNumButtons(joystick) < 2) {
141 log_info << "Joystick " << i << ": " << SDL_JoystickName(i) << " has less than 2 buttons" << std::endl;
144 if(SDL_JoystickNumAxes(joystick) < 2
145 && SDL_JoystickNumHats(joystick) == 0) {
146 log_info << "Joystick " << i << ": " << SDL_JoystickName(i) << " has less than 2 axes and no hat" << std::endl;
150 SDL_JoystickClose(joystick);
154 if(min_joybuttons < 0 || SDL_JoystickNumButtons(joystick) < min_joybuttons)
155 min_joybuttons = SDL_JoystickNumButtons(joystick);
157 if(SDL_JoystickNumButtons(joystick) > max_joybuttons)
158 max_joybuttons = SDL_JoystickNumButtons(joystick);
160 if(SDL_JoystickNumAxes(joystick) > max_joyaxis)
161 max_joyaxis = SDL_JoystickNumAxes(joystick);
163 if(SDL_JoystickNumHats(joystick) > max_joyhats)
164 max_joyhats = SDL_JoystickNumHats(joystick);
166 joysticks.push_back(joystick);
170 // some joysticks or SDL seem to produce some bogus events after being opened
171 Uint32 ticks = SDL_GetTicks();
172 while(SDL_GetTicks() - ticks < 200) {
174 SDL_PollEvent(&event);
179 JoystickKeyboardController::get_main_controller()
185 JoystickKeyboardController::read(const Reader& lisp)
187 const lisp::Lisp* keymap_lisp = lisp.get_lisp("keymap");
190 keymap_lisp->get("jump-with-up", jump_with_up_kbd);
191 lisp::ListIterator iter(keymap_lisp);
193 if(iter.item() == "map") {
196 const lisp::Lisp* map = iter.lisp();
197 map->get("key", key);
198 map->get("control", control);
199 if(key < SDLK_FIRST || key >= SDLK_LAST) {
200 log_info << "Invalid key '" << key << "' in keymap" << std::endl;
205 for(i = 0; Controller::controlNames[i] != 0; ++i) {
206 if(control == Controller::controlNames[i])
209 if(Controller::controlNames[i] == 0) {
210 log_info << "Invalid control '" << control << "' in keymap" << std::endl;
213 keymap[SDLKey(key)] = Control(i);
218 const lisp::Lisp* joystick_lisp = lisp.get_lisp("joystick");
220 joystick_lisp->get("dead-zone", dead_zone);
221 joystick_lisp->get("jump-with-up", jump_with_up_joy);
222 lisp::ListIterator iter(joystick_lisp);
224 if(iter.item() == "map") {
229 const lisp::Lisp* map = iter.lisp();
231 map->get("control", control);
233 for(i = 0; Controller::controlNames[i] != 0; ++i) {
234 if(control == Controller::controlNames[i])
237 if(Controller::controlNames[i] == 0) {
238 log_info << "Invalid control '" << control << "' in buttonmap" << std::endl;
242 if (map->get("button", button)) {
243 if(button < 0 || button >= max_joybuttons) {
244 log_info << "Invalid button '" << button << "' in buttonmap" << std::endl;
247 bind_joybutton(0, button, Control(i));
250 if (map->get("axis", axis)) {
251 if (axis == 0 || abs(axis) > max_joyaxis) {
252 log_info << "Invalid axis '" << axis << "' in axismap" << std::endl;
255 bind_joyaxis(0, axis, Control(i));
258 if (map->get("hat", hat)) {
259 if (hat != SDL_HAT_UP &&
260 hat != SDL_HAT_DOWN &&
261 hat != SDL_HAT_LEFT &&
262 hat != SDL_HAT_RIGHT) {
263 log_info << "Invalid axis '" << axis << "' in axismap" << std::endl;
266 bind_joyhat(0, hat, Control(i));
275 JoystickKeyboardController::write(Writer& writer)
277 writer.start_list("keymap");
278 writer.write("jump-with-up", jump_with_up_kbd);
279 for(KeyMap::iterator i = keymap.begin(); i != keymap.end(); ++i) {
280 writer.start_list("map");
281 writer.write("key", (int) i->first);
282 writer.write("control", Controller::controlNames[i->second]);
283 writer.end_list("map");
285 writer.end_list("keymap");
287 writer.start_list("joystick");
288 writer.write("dead-zone", dead_zone);
289 writer.write("jump-with-up", jump_with_up_joy);
291 for(ButtonMap::iterator i = joy_button_map.begin(); i != joy_button_map.end();
293 writer.start_list("map");
294 writer.write("button", i->first.second);
295 writer.write("control", Controller::controlNames[i->second]);
296 writer.end_list("map");
299 for(HatMap::iterator i = joy_hat_map.begin(); i != joy_hat_map.end(); ++i) {
300 writer.start_list("map");
301 writer.write("hat", i->first.second);
302 writer.write("control", Controller::controlNames[i->second]);
303 writer.end_list("map");
306 for(AxisMap::iterator i = joy_axis_map.begin(); i != joy_axis_map.end(); ++i) {
307 writer.start_list("map");
308 writer.write("axis", i->first.second);
309 writer.write("control", Controller::controlNames[i->second]);
310 writer.end_list("map");
313 writer.end_list("joystick");
317 JoystickKeyboardController::update()
319 controller->update();
323 JoystickKeyboardController::reset()
329 JoystickKeyboardController::set_joy_controls(Control id, bool value)
331 if (jump_with_up_joy && id == Controller::UP)
332 controller->set_control(Controller::JUMP, value);
334 controller->set_control(id, value);
338 JoystickKeyboardController::process_event(const SDL_Event& event)
343 process_key_event(event.key);
346 case SDL_JOYAXISMOTION:
347 process_axis_event(event.jaxis);
350 case SDL_JOYHATMOTION:
351 process_hat_event(event.jhat);
354 case SDL_JOYBUTTONDOWN:
355 case SDL_JOYBUTTONUP:
356 process_button_event(event.jbutton);
365 JoystickKeyboardController::process_button_event(const SDL_JoyButtonEvent& jbutton)
367 if(wait_for_joystick >= 0)
369 if(jbutton.state == SDL_PRESSED)
371 bind_joybutton(jbutton.which, jbutton.button, (Control)wait_for_joystick);
372 MenuStorage::get_joystick_options_menu()->update();
374 wait_for_joystick = -1;
379 ButtonMap::iterator i = joy_button_map.find(std::make_pair(jbutton.which, jbutton.button));
380 if(i == joy_button_map.end()) {
381 log_debug << "Unmapped joybutton " << (int)jbutton.button << " pressed" << std::endl;
383 set_joy_controls(i->second, (jbutton.state == SDL_PRESSED));
389 JoystickKeyboardController::process_axis_event(const SDL_JoyAxisEvent& jaxis)
391 if (wait_for_joystick >= 0)
393 if (abs(jaxis.value) > dead_zone) {
395 bind_joyaxis(jaxis.which, -(jaxis.axis + 1), Control(wait_for_joystick));
397 bind_joyaxis(jaxis.which, jaxis.axis + 1, Control(wait_for_joystick));
399 MenuStorage::get_joystick_options_menu()->update();
400 wait_for_joystick = -1;
405 // Split the axis into left and right, so that both can be
406 // mapped separately (needed for jump/down vs up/down)
407 int axis = jaxis.axis + 1;
409 AxisMap::iterator left = joy_axis_map.find(std::make_pair(jaxis.which, -axis));
410 AxisMap::iterator right = joy_axis_map.find(std::make_pair(jaxis.which, axis));
412 if(left == 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(left->second, true);
417 else if (jaxis.value > dead_zone)
418 set_joy_controls(left->second, false);
420 set_joy_controls(left->second, false);
423 if(right == joy_axis_map.end()) {
424 std::cout << "Unmapped joyaxis " << (int)jaxis.axis << " moved" << std::endl;
426 if (jaxis.value < -dead_zone)
427 set_joy_controls(right->second, false);
428 else if (jaxis.value > dead_zone)
429 set_joy_controls(right->second, true);
431 set_joy_controls(right->second, false);
437 JoystickKeyboardController::process_hat_event(const SDL_JoyHatEvent& jhat)
439 Uint8 changed = hat_state ^ jhat.value;
441 if (wait_for_joystick >= 0)
443 if (changed & SDL_HAT_UP && jhat.value & SDL_HAT_UP)
444 bind_joyhat(jhat.which, SDL_HAT_UP, Control(wait_for_joystick));
446 if (changed & SDL_HAT_DOWN && jhat.value & SDL_HAT_DOWN)
447 bind_joyhat(jhat.which, SDL_HAT_DOWN, Control(wait_for_joystick));
449 if (changed & SDL_HAT_LEFT && jhat.value & SDL_HAT_LEFT)
450 bind_joyhat(jhat.which, SDL_HAT_LEFT, Control(wait_for_joystick));
452 if (changed & SDL_HAT_RIGHT && jhat.value & SDL_HAT_RIGHT)
453 bind_joyhat(jhat.which, SDL_HAT_RIGHT, Control(wait_for_joystick));
455 MenuStorage::get_joystick_options_menu()->update();
456 wait_for_joystick = -1;
460 if (changed & SDL_HAT_UP)
462 HatMap::iterator it = joy_hat_map.find(std::make_pair(jhat.which, SDL_HAT_UP));
463 if (it != joy_hat_map.end())
464 set_joy_controls(it->second, jhat.value & SDL_HAT_UP);
467 if (changed & SDL_HAT_DOWN)
469 HatMap::iterator it = joy_hat_map.find(std::make_pair(jhat.which, SDL_HAT_DOWN));
470 if (it != joy_hat_map.end())
471 set_joy_controls(it->second, jhat.value & SDL_HAT_DOWN);
474 if (changed & SDL_HAT_LEFT)
476 HatMap::iterator it = joy_hat_map.find(std::make_pair(jhat.which, SDL_HAT_LEFT));
477 if (it != joy_hat_map.end())
478 set_joy_controls(it->second, jhat.value & SDL_HAT_LEFT);
481 if (changed & SDL_HAT_RIGHT)
483 HatMap::iterator it = joy_hat_map.find(std::make_pair(jhat.which, SDL_HAT_RIGHT));
484 if (it != joy_hat_map.end())
485 set_joy_controls(it->second, jhat.value & SDL_HAT_RIGHT);
489 hat_state = jhat.value;
493 JoystickKeyboardController::process_key_event(const SDL_KeyboardEvent& event)
495 KeyMap::iterator key_mapping = keymap.find(event.keysym.sym);
497 // if console key was pressed: toggle console
498 if ((key_mapping != keymap.end()) && (key_mapping->second == Controller::CONSOLE)) {
499 if (event.type == SDL_KEYDOWN)
500 Console::instance->toggle();
502 if (Console::instance->hasFocus()) {
503 // if console is open: send key there
504 process_console_key_event(event);
505 } else if (MenuManager::current()) {
506 // if menu mode: send key there
507 process_menu_key_event(event);
508 } else if(key_mapping == keymap.end()) {
509 // default action: update controls
510 //log_debug << "Key " << event.key.keysym.sym << " is unbound" << std::endl;
512 Control control = key_mapping->second;
513 bool value = (event.type == SDL_KEYDOWN);
514 controller->set_control(control, value);
515 if (jump_with_up_kbd && control == Controller::UP){
516 controller->set_control(Controller::JUMP, value);
523 JoystickKeyboardController::process_console_key_event(const SDL_KeyboardEvent& event)
525 if (event.type != SDL_KEYDOWN) return;
527 switch (event.keysym.sym) {
529 Console::instance->enter();
532 Console::instance->backspace();
535 Console::instance->autocomplete();
538 Console::instance->scroll(-1);
541 Console::instance->scroll(+1);
544 Console::instance->move_cursor(-65535);
547 Console::instance->move_cursor(+65535);
550 Console::instance->show_history(-1);
553 Console::instance->show_history(+1);
556 Console::instance->move_cursor(-1);
559 Console::instance->move_cursor(+1);
562 int c = event.keysym.unicode;
563 if ((c >= 32) && (c <= 126)) {
564 Console::instance->input((char)c);
571 JoystickKeyboardController::process_menu_key_event(const SDL_KeyboardEvent& event)
573 // wait for key mode?
574 if(wait_for_key >= 0) {
575 if(event.type == SDL_KEYUP)
578 if(event.keysym.sym != SDLK_ESCAPE
579 && event.keysym.sym != SDLK_PAUSE) {
580 bind_key(event.keysym.sym, Control(wait_for_key));
583 MenuStorage::get_key_options_menu()->update();
587 if(wait_for_joystick >= 0) {
588 if(event.keysym.sym == SDLK_ESCAPE) {
590 MenuStorage::get_joystick_options_menu()->update();
591 wait_for_joystick = -1;
597 /* we use default keys when the menu is open (to avoid problems when
598 * redefining keys to invalid settings
600 switch(event.keysym.sym) {
602 control = Controller::UP;
605 control = Controller::DOWN;
608 control = Controller::LEFT;
611 control = Controller::RIGHT;
616 control = Controller::MENU_SELECT;
620 control = Controller::PAUSE_MENU;
627 controller->set_control(control, (event.type == SDL_KEYDOWN));
631 JoystickKeyboardController::unbind_joystick_control(Control control)
633 // remove all previous mappings for that control
634 for(AxisMap::iterator i = joy_axis_map.begin(); i != joy_axis_map.end(); /* no ++i */) {
635 if(i->second == control)
636 joy_axis_map.erase(i++);
641 for(ButtonMap::iterator i = joy_button_map.begin(); i != joy_button_map.end(); /* no ++i */) {
642 if(i->second == control)
643 joy_button_map.erase(i++);
648 for(HatMap::iterator i = joy_hat_map.begin(); i != joy_hat_map.end(); /* no ++i */) {
649 if(i->second == control)
650 joy_hat_map.erase(i++);
657 JoystickKeyboardController::bind_joyaxis(JoyId joy_id, int axis, Control control)
659 // axis isn't the SDL axis number, but axisnumber + 1 with sign
660 // changed depending on if the positive or negative end is to be
661 // used (negative axis 0 becomes -1, positive axis 2 becomes +3,
664 unbind_joystick_control(control);
667 joy_axis_map[std::make_pair(joy_id, axis)] = control;
671 JoystickKeyboardController::bind_joyhat(JoyId joy_id, int dir, Control c)
673 unbind_joystick_control(c);
676 joy_hat_map[std::make_pair(joy_id, dir)] = c;
680 JoystickKeyboardController::bind_joybutton(JoyId joy_id, int button, Control control)
682 unbind_joystick_control(control);
685 joy_button_map[std::make_pair(joy_id, button)] = control;
689 JoystickKeyboardController::bind_key(SDLKey key, Control control)
691 // remove all previous mappings for that control and for that key
692 for(KeyMap::iterator i = keymap.begin();
693 i != keymap.end(); /* no ++i */) {
694 if(i->second == control) {
695 KeyMap::iterator e = i;
703 KeyMap::iterator i = keymap.find(key);
704 if(i != keymap.end())
708 keymap[key] = control;
712 JoystickKeyboardController::print_joystick_mappings()
714 std::cout << "Joystick Mappings" << std::endl;
715 std::cout << "-----------------" << std::endl;
716 for(AxisMap::iterator i = joy_axis_map.begin(); i != joy_axis_map.end(); ++i) {
717 std::cout << "Axis: " << i->first.second << " -> " << i->second << std::endl;
720 for(ButtonMap::iterator i = joy_button_map.begin(); i != joy_button_map.end(); ++i) {
721 std::cout << "Button: " << i->first.second << " -> " << i->second << std::endl;
724 for(HatMap::iterator i = joy_hat_map.begin(); i != joy_hat_map.end(); ++i) {
725 std::cout << "Hat: " << i->first.second << " -> " << i->second << std::endl;
727 std::cout << std::endl;
731 JoystickKeyboardController::reversemap_key(Control c)
733 for(KeyMap::iterator i = keymap.begin(); i != keymap.end(); ++i) {
742 JoystickKeyboardController::reversemap_joyaxis(Control c)
744 for(AxisMap::iterator i = joy_axis_map.begin(); i != joy_axis_map.end(); ++i) {
746 return i->first.second;
753 JoystickKeyboardController::reversemap_joybutton(Control c)
755 for(ButtonMap::iterator i = joy_button_map.begin(); i != joy_button_map.end(); ++i) {
757 return i->first.second;
764 JoystickKeyboardController::reversemap_joyhat(Control c)
766 for(HatMap::iterator i = joy_hat_map.begin(); i != joy_hat_map.end(); ++i) {
768 return i->first.second;