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 "control/joystick_menu.hpp"
23 #include "control/keyboard_menu.hpp"
24 #include "util/writer.hpp"
25 #include "lisp/list_iterator.hpp"
26 #include "supertux/gameconfig.hpp"
27 #include "supertux/console.hpp"
28 #include "util/gettext.hpp"
30 JoystickKeyboardController::JoystickKeyboardController() :
46 wait_for_joystick(-1),
48 joystick_options_menu(0)
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);
112 delete key_options_menu;
113 delete joystick_options_menu;
117 JoystickKeyboardController::updateAvailableJoysticks()
119 for(std::vector<SDL_Joystick*>::iterator i = joysticks.begin();
120 i != joysticks.end(); ++i) {
122 SDL_JoystickClose(*i);
126 SDL_QuitSubSystem(SDL_INIT_JOYSTICK);
127 SDL_InitSubSystem(SDL_INIT_JOYSTICK);
129 int joystick_count = SDL_NumJoysticks();
135 if( joystick_count > 0 ){
136 for(int i = 0; i < joystick_count; ++i) {
137 SDL_Joystick* joystick = SDL_JoystickOpen(i);
139 if(SDL_JoystickNumButtons(joystick) < 2) {
140 log_info << "Joystick " << i << ": " << SDL_JoystickName(i) << " has less than 2 buttons" << std::endl;
143 if(SDL_JoystickNumAxes(joystick) < 2
144 && SDL_JoystickNumHats(joystick) == 0) {
145 log_info << "Joystick " << i << ": " << SDL_JoystickName(i) << " has less than 2 axes and no hat" << std::endl;
149 SDL_JoystickClose(joystick);
153 if(min_joybuttons < 0 || SDL_JoystickNumButtons(joystick) < min_joybuttons)
154 min_joybuttons = SDL_JoystickNumButtons(joystick);
156 if(SDL_JoystickNumButtons(joystick) > max_joybuttons)
157 max_joybuttons = SDL_JoystickNumButtons(joystick);
159 if(SDL_JoystickNumAxes(joystick) > max_joyaxis)
160 max_joyaxis = SDL_JoystickNumAxes(joystick);
162 if(SDL_JoystickNumHats(joystick) > max_joyhats)
163 max_joyhats = SDL_JoystickNumHats(joystick);
165 joysticks.push_back(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(key < SDLK_FIRST || key >= SDLK_LAST) {
193 log_info << "Invalid key '" << key << "' in keymap" << std::endl;
198 for(i = 0; controlNames[i] != 0; ++i) {
199 if(control == controlNames[i])
202 if(controlNames[i] == 0) {
203 log_info << "Invalid control '" << control << "' in keymap" << std::endl;
206 keymap[(SDLKey) key] = (Control)i;
211 const lisp::Lisp* joystick_lisp = lisp.get_lisp("joystick");
213 joystick_lisp->get("dead-zone", dead_zone);
214 joystick_lisp->get("jump-with-up", jump_with_up_joy);
215 lisp::ListIterator iter(joystick_lisp);
217 if(iter.item() == "map") {
222 const lisp::Lisp* map = iter.lisp();
224 map->get("control", control);
226 for(i = 0; controlNames[i] != 0; ++i) {
227 if(control == controlNames[i])
230 if(controlNames[i] == 0) {
231 log_info << "Invalid control '" << control << "' in buttonmap" << std::endl;
235 if (map->get("button", button)) {
236 if(button < 0 || button >= max_joybuttons) {
237 log_info << "Invalid button '" << button << "' in buttonmap" << std::endl;
240 bind_joybutton(button, (Control) i);
243 if (map->get("axis", axis)) {
244 if (axis == 0 || abs(axis) > max_joyaxis) {
245 log_info << "Invalid axis '" << axis << "' in axismap" << std::endl;
248 bind_joyaxis(axis, (Control) i);
251 if (map->get("hat", hat)) {
252 if (hat != SDL_HAT_UP &&
253 hat != SDL_HAT_DOWN &&
254 hat != SDL_HAT_LEFT &&
255 hat != SDL_HAT_RIGHT) {
256 log_info << "Invalid axis '" << axis << "' in axismap" << std::endl;
259 bind_joyhat(hat, (Control) i);
268 JoystickKeyboardController::write(Writer& writer)
270 writer.start_list("keymap");
271 writer.write("jump-with-up", jump_with_up_kbd);
272 for(KeyMap::iterator i = keymap.begin(); i != keymap.end(); ++i) {
273 writer.start_list("map");
274 writer.write("key", (int) i->first);
275 writer.write("control", controlNames[i->second]);
276 writer.end_list("map");
278 writer.end_list("keymap");
280 writer.start_list("joystick");
281 writer.write("dead-zone", dead_zone);
282 writer.write("jump-with-up", jump_with_up_joy);
284 for(ButtonMap::iterator i = joy_button_map.begin(); i != joy_button_map.end();
286 writer.start_list("map");
287 writer.write("button", i->first);
288 writer.write("control", controlNames[i->second]);
289 writer.end_list("map");
292 for(HatMap::iterator i = joy_hat_map.begin(); i != joy_hat_map.end(); ++i) {
293 writer.start_list("map");
294 writer.write("hat", i->first);
295 writer.write("control", controlNames[i->second]);
296 writer.end_list("map");
299 for(AxisMap::iterator i = joy_axis_map.begin(); i != joy_axis_map.end(); ++i) {
300 writer.start_list("map");
301 writer.write("axis", i->first);
302 writer.write("control", controlNames[i->second]);
303 writer.end_list("map");
306 writer.end_list("joystick");
310 JoystickKeyboardController::reset()
316 JoystickKeyboardController::set_joy_controls(Control id, bool value)
318 if (jump_with_up_joy && id == Controller::UP)
319 controls[Controller::JUMP] = value;
321 controls[(Control)id] = value;
325 JoystickKeyboardController::process_event(const SDL_Event& event)
330 process_key_event(event);
333 case SDL_JOYAXISMOTION:
334 process_axis_event(event.jaxis);
337 case SDL_JOYHATMOTION:
338 process_hat_event(event.jhat);
341 case SDL_JOYBUTTONDOWN:
342 case SDL_JOYBUTTONUP:
343 process_button_event(event.jbutton);
352 JoystickKeyboardController::process_button_event(const SDL_JoyButtonEvent& jbutton)
354 if(wait_for_joystick >= 0)
356 if(jbutton.state == SDL_PRESSED)
358 bind_joybutton(jbutton.button, (Control)wait_for_joystick);
359 joystick_options_menu->update();
361 wait_for_joystick = -1;
366 ButtonMap::iterator i = joy_button_map.find(jbutton.button);
367 if(i == joy_button_map.end()) {
368 log_debug << "Unmapped joybutton " << (int)jbutton.button << " pressed" << std::endl;
370 set_joy_controls(i->second, (jbutton.state == SDL_PRESSED));
376 JoystickKeyboardController::process_axis_event(const SDL_JoyAxisEvent& jaxis)
378 if (wait_for_joystick >= 0)
380 if (abs(jaxis.value) > dead_zone) {
382 bind_joyaxis(-(jaxis.axis + 1), Control(wait_for_joystick));
384 bind_joyaxis(jaxis.axis + 1, Control(wait_for_joystick));
386 joystick_options_menu->update();
387 wait_for_joystick = -1;
392 // Split the axis into left and right, so that both can be
393 // mapped separately (needed for jump/down vs up/down)
394 int axis = jaxis.axis + 1;
396 AxisMap::iterator left = joy_axis_map.find(-axis);
397 AxisMap::iterator right = joy_axis_map.find(axis);
399 if(left == joy_axis_map.end()) {
400 std::cout << "Unmapped joyaxis " << (int)jaxis.axis << " moved" << std::endl;
402 if (jaxis.value < -dead_zone)
403 set_joy_controls(left->second, true);
404 else if (jaxis.value > dead_zone)
405 set_joy_controls(left->second, false);
407 set_joy_controls(left->second, false);
410 if(right == joy_axis_map.end()) {
411 std::cout << "Unmapped joyaxis " << (int)jaxis.axis << " moved" << std::endl;
413 if (jaxis.value < -dead_zone)
414 set_joy_controls(right->second, false);
415 else if (jaxis.value > dead_zone)
416 set_joy_controls(right->second, true);
418 set_joy_controls(right->second, false);
424 JoystickKeyboardController::process_hat_event(const SDL_JoyHatEvent& jhat)
426 Uint8 changed = hat_state ^ jhat.value;
428 if (wait_for_joystick >= 0)
430 if (changed & SDL_HAT_UP && jhat.value & SDL_HAT_UP)
431 bind_joyhat(SDL_HAT_UP, (Control)wait_for_joystick);
433 if (changed & SDL_HAT_DOWN && jhat.value & SDL_HAT_DOWN)
434 bind_joyhat(SDL_HAT_DOWN, (Control)wait_for_joystick);
436 if (changed & SDL_HAT_LEFT && jhat.value & SDL_HAT_LEFT)
437 bind_joyhat(SDL_HAT_LEFT, (Control)wait_for_joystick);
439 if (changed & SDL_HAT_RIGHT && jhat.value & SDL_HAT_RIGHT)
440 bind_joyhat(SDL_HAT_RIGHT, (Control)wait_for_joystick);
442 joystick_options_menu->update();
443 wait_for_joystick = -1;
447 if (changed & SDL_HAT_UP)
449 HatMap::iterator it = joy_hat_map.find(SDL_HAT_UP);
450 if (it != joy_hat_map.end())
451 set_joy_controls(it->second, jhat.value & SDL_HAT_UP);
454 if (changed & SDL_HAT_DOWN)
456 HatMap::iterator it = joy_hat_map.find(SDL_HAT_DOWN);
457 if (it != joy_hat_map.end())
458 set_joy_controls(it->second, jhat.value & SDL_HAT_DOWN);
461 if (changed & SDL_HAT_LEFT)
463 HatMap::iterator it = joy_hat_map.find(SDL_HAT_LEFT);
464 if (it != joy_hat_map.end())
465 set_joy_controls(it->second, jhat.value & SDL_HAT_LEFT);
468 if (changed & SDL_HAT_RIGHT)
470 HatMap::iterator it = joy_hat_map.find(SDL_HAT_RIGHT);
471 if (it != joy_hat_map.end())
472 set_joy_controls(it->second, jhat.value & SDL_HAT_RIGHT);
476 hat_state = jhat.value;
480 JoystickKeyboardController::process_key_event(const SDL_Event& event)
482 KeyMap::iterator key_mapping = keymap.find(event.key.keysym.sym);
484 // if console key was pressed: toggle console
485 if ((key_mapping != keymap.end()) && (key_mapping->second == CONSOLE)) {
486 if (event.type == SDL_KEYDOWN)
487 Console::instance->toggle();
489 if (Console::instance->hasFocus()) {
490 // if console is open: send key there
491 process_console_key_event(event);
492 } else if (Menu::current()) {
493 // if menu mode: send key there
494 process_menu_key_event(event);
495 } else if(key_mapping == keymap.end()) {
496 // default action: update controls
497 //log_debug << "Key " << event.key.keysym.sym << " is unbound" << std::endl;
499 Control control = key_mapping->second;
500 controls[control] = (event.type == SDL_KEYDOWN);
501 if (jump_with_up_kbd && control == UP){
502 controls[JUMP] = (event.type == SDL_KEYDOWN);
509 JoystickKeyboardController::process_console_key_event(const SDL_Event& event)
511 if (event.type != SDL_KEYDOWN) return;
513 switch (event.key.keysym.sym) {
515 Console::instance->enter();
518 Console::instance->backspace();
521 Console::instance->autocomplete();
524 Console::instance->scroll(-1);
527 Console::instance->scroll(+1);
530 Console::instance->move_cursor(-65535);
533 Console::instance->move_cursor(+65535);
536 Console::instance->show_history(-1);
539 Console::instance->show_history(+1);
542 Console::instance->move_cursor(-1);
545 Console::instance->move_cursor(+1);
548 int c = event.key.keysym.unicode;
549 if ((c >= 32) && (c <= 126)) {
550 Console::instance->input((char)c);
557 JoystickKeyboardController::process_menu_key_event(const SDL_Event& event)
559 // wait for key mode?
560 if(wait_for_key >= 0) {
561 if(event.type == SDL_KEYUP)
564 if(event.key.keysym.sym != SDLK_ESCAPE
565 && event.key.keysym.sym != SDLK_PAUSE) {
566 bind_key(event.key.keysym.sym, (Control) wait_for_key);
569 key_options_menu->update();
573 if(wait_for_joystick >= 0) {
574 if(event.key.keysym.sym == SDLK_ESCAPE) {
576 joystick_options_menu->update();
577 wait_for_joystick = -1;
583 /* we use default keys when the menu is open (to avoid problems when
584 * redefining keys to invalid settings
586 switch(event.key.keysym.sym) {
602 control = MENU_SELECT;
606 control = PAUSE_MENU;
613 controls[control] = (event.type == SDL_KEYDOWN);
617 JoystickKeyboardController::unbind_joystick_control(Control control)
619 // remove all previous mappings for that control
620 for(AxisMap::iterator i = joy_axis_map.begin(); i != joy_axis_map.end(); /* no ++i */) {
621 if(i->second == control)
622 joy_axis_map.erase(i++);
627 for(ButtonMap::iterator i = joy_button_map.begin(); i != joy_button_map.end(); /* no ++i */) {
628 if(i->second == control)
629 joy_button_map.erase(i++);
634 for(HatMap::iterator i = joy_hat_map.begin(); i != joy_hat_map.end(); /* no ++i */) {
635 if(i->second == control)
636 joy_hat_map.erase(i++);
643 JoystickKeyboardController::bind_joyaxis(int axis, Control control)
645 // axis isn't the SDL axis number, but axisnumber + 1 with sign
646 // changed depending on if the positive or negative end is to be
647 // used (negative axis 0 becomes -1, positive axis 2 becomes +3,
650 unbind_joystick_control(control);
653 joy_axis_map[axis] = control;
657 JoystickKeyboardController::bind_joyhat(int dir, Control c)
659 unbind_joystick_control(c);
662 joy_hat_map[dir] = c;
666 JoystickKeyboardController::bind_joybutton(int button, Control control)
668 unbind_joystick_control(control);
671 joy_button_map[button] = control;
675 JoystickKeyboardController::bind_key(SDLKey key, Control control)
677 // remove all previous mappings for that control and for that key
678 for(KeyMap::iterator i = keymap.begin();
679 i != keymap.end(); /* no ++i */) {
680 if(i->second == control) {
681 KeyMap::iterator e = i;
689 KeyMap::iterator i = keymap.find(key);
690 if(i != keymap.end())
694 keymap[key]= control;
698 JoystickKeyboardController::print_joystick_mappings()
700 std::cout << "Joystick Mappings" << std::endl;
701 std::cout << "-----------------" << std::endl;
702 for(AxisMap::iterator i = joy_axis_map.begin(); i != joy_axis_map.end(); ++i) {
703 std::cout << "Axis: " << i->first << " -> " << i->second << std::endl;
706 for(ButtonMap::iterator i = joy_button_map.begin(); i != joy_button_map.end(); ++i) {
707 std::cout << "Button: " << i->first << " -> " << i->second << std::endl;
710 for(HatMap::iterator i = joy_hat_map.begin(); i != joy_hat_map.end(); ++i) {
711 std::cout << "Hat: " << i->first << " -> " << i->second << std::endl;
713 std::cout << std::endl;
717 JoystickKeyboardController::reversemap_key(Control c)
719 for(KeyMap::iterator i = keymap.begin(); i != keymap.end(); ++i) {
728 JoystickKeyboardController::reversemap_joyaxis(Control c)
730 for(AxisMap::iterator i = joy_axis_map.begin(); i != joy_axis_map.end(); ++i) {
739 JoystickKeyboardController::reversemap_joybutton(Control c)
741 for(ButtonMap::iterator i = joy_button_map.begin(); i != joy_button_map.end(); ++i) {
750 JoystickKeyboardController::reversemap_joyhat(Control c)
752 for(HatMap::iterator i = joy_hat_map.begin(); i != joy_hat_map.end(); ++i) {
761 JoystickKeyboardController::get_key_options_menu()
763 if(key_options_menu == 0) {
764 key_options_menu = new KeyboardMenu(this);
767 return key_options_menu;
771 JoystickKeyboardController::get_joystick_options_menu()
773 if(joystick_options_menu == 0) {
774 joystick_options_menu = new JoystickMenu(this);
777 return joystick_options_menu;