4 // Copyright (C) 2006 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 02111-1307, USA.
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));
73 keymap.insert(std::make_pair(SDLK_CARET, CONSOLE));
74 keymap.insert(std::make_pair(SDLK_DELETE, PEEK_LEFT));
75 keymap.insert(std::make_pair(SDLK_END, PEEK_RIGHT));
77 int joystick_count = SDL_NumJoysticks();
80 for(int i = 0; i < joystick_count; ++i) {
81 SDL_Joystick* joystick = SDL_JoystickOpen(i);
83 if(SDL_JoystickNumButtons(joystick) < 2) {
84 log_warning << "Joystick " << i << " has less than 2 buttons" << std::endl;
87 if(SDL_JoystickNumAxes(joystick) < 2
88 && SDL_JoystickNumHats(joystick) == 0) {
89 log_warning << "Joystick " << i << " has less than 2 axes and no hat" << std::endl;
93 SDL_JoystickClose(joystick);
97 if(min_joybuttons < 0 || SDL_JoystickNumButtons(joystick) < min_joybuttons)
98 min_joybuttons = SDL_JoystickNumButtons(joystick);
99 if(SDL_JoystickNumButtons(joystick) > max_joybuttons) {
100 max_joybuttons = SDL_JoystickNumButtons(joystick);
103 joysticks.push_back(joystick);
112 joy_button_map.insert(std::make_pair(0, JUMP));
113 joy_button_map.insert(std::make_pair(1, ACTION));
115 if( min_joybuttons > 5 ){
116 joy_button_map.insert(std::make_pair( 5, PEEK_LEFT));
117 joy_button_map.insert(std::make_pair( 6, PEEK_RIGHT));
119 if(min_joybuttons > 7)
120 joy_button_map.insert(std::make_pair(min_joybuttons-1, PAUSE_MENU));
121 // map all remaining joystick buttons to MENU_SELECT
122 for(int i = 2; i < max_joybuttons; ++i) {
123 if( i != min_joybuttons-1 && i !=5 && i!= 6 )
124 joy_button_map.insert(std::make_pair(i, MENU_SELECT));
128 // map the last 2 buttons to menu and pause
129 if(min_joybuttons > 2)
130 joy_button_map.insert(std::make_pair(min_joybuttons-1, PAUSE_MENU));
131 // map all remaining joystick buttons to MENU_SELECT
132 for(int i = 2; i < max_joybuttons; ++i) {
133 if(i != min_joybuttons-1)
134 joy_button_map.insert(std::make_pair(i, MENU_SELECT));
138 // some joysticks or SDL seem to produce some bogus events after being opened
139 Uint32 ticks = SDL_GetTicks();
140 while(SDL_GetTicks() - ticks < 200) {
142 SDL_PollEvent(&event);
146 JoystickKeyboardController::~JoystickKeyboardController()
148 for(std::vector<SDL_Joystick*>::iterator i = joysticks.begin();
149 i != joysticks.end(); ++i) {
151 SDL_JoystickClose(*i);
154 delete key_options_menu;
155 delete joystick_options_menu;
159 JoystickKeyboardController::read(const lisp::Lisp& lisp)
161 const lisp::Lisp* keymap_lisp = lisp.get_lisp("keymap");
164 lisp::ListIterator iter(keymap_lisp);
166 if(iter.item() == "map") {
169 const lisp::Lisp* map = iter.lisp();
170 map->get("key", key);
171 map->get("control", control);
172 if(key < SDLK_FIRST || key >= SDLK_LAST) {
173 log_warning << "Invalid key '" << key << "' in keymap" << std::endl;
178 for(i = 0; controlNames[i] != 0; ++i) {
179 if(control == controlNames[i])
182 if(controlNames[i] == 0) {
183 log_warning << "Invalid control '" << control << "' in keymap" << std::endl;
186 keymap.insert(std::make_pair((SDLKey) key, (Control) i));
188 log_warning << "Invalid lisp element '" << iter.item() << "' in keymap" << std::endl;
193 const lisp::Lisp* joystick_lisp = lisp.get_lisp("joystick");
195 joystick_lisp->get("use_hat", use_hat);
196 joystick_lisp->get("axis_x", joyaxis_x);
197 joystick_lisp->get("axis_y", joyaxis_y);
198 joystick_lisp->get("dead_zone_x", dead_zone_x);
199 joystick_lisp->get("dead_zone_y", dead_zone_y);
200 lisp::ListIterator iter(joystick_lisp);
202 if(iter.item() == "map") {
205 const lisp::Lisp* map = iter.lisp();
206 map->get("button", button);
207 map->get("control", control);
208 if(button < 0 || button >= max_joybuttons) {
209 log_warning << "Invalid button '" << button << "' in buttonmap" << std::endl;
214 for(i = 0; controlNames[i] != 0; ++i) {
215 if(control == controlNames[i])
218 if(controlNames[i] == 0) {
219 log_warning << "Invalid control '" << control << "' in buttonmap" << std::endl;
222 reset_joybutton(button, (Control) i);
229 JoystickKeyboardController::write(lisp::Writer& writer)
231 writer.start_list("keymap");
232 for(KeyMap::iterator i = keymap.begin(); i != keymap.end(); ++i) {
233 writer.start_list("map");
234 writer.write_int("key", (int) i->first);
235 writer.write_string("control", controlNames[i->second]);
236 writer.end_list("map");
238 writer.end_list("keymap");
239 writer.start_list("joystick");
240 writer.write_bool("use_hat", use_hat);
241 writer.write_int("axis_x", joyaxis_x);
242 writer.write_int("axis_y", joyaxis_y);
243 writer.write_int("dead_zone_x", dead_zone_x);
244 writer.write_int("dead_zone_y", dead_zone_y);
245 for(ButtonMap::iterator i = joy_button_map.begin(); i != joy_button_map.end();
247 writer.start_list("map");
248 writer.write_int("button", i->first);
249 writer.write_string("control", controlNames[i->second]);
250 writer.end_list("map");
252 writer.end_list("joystick");
256 JoystickKeyboardController::reset()
262 JoystickKeyboardController::process_event(const SDL_Event& event)
267 process_key_event(event);
270 case SDL_JOYAXISMOTION:
271 if(event.jaxis.axis == joyaxis_x) {
272 if(event.jaxis.value < -dead_zone_x) {
273 controls[LEFT] = true;
274 controls[RIGHT] = false;
275 } else if(event.jaxis.value > dead_zone_x) {
276 controls[LEFT] = false;
277 controls[RIGHT] = true;
279 controls[LEFT] = false;
280 controls[RIGHT] = false;
282 } else if(event.jaxis.axis == joyaxis_y) {
283 if(event.jaxis.value < -dead_zone_y) {
285 controls[DOWN] = false;
286 } else if(event.jaxis.value > dead_zone_y) {
287 controls[UP] = false;
288 controls[DOWN] = true;
290 controls[UP] = false;
291 controls[DOWN] = false;
296 case SDL_JOYHATMOTION:
300 if(event.jhat.value & SDL_HAT_UP) {
302 controls[DOWN] = false;
304 if(event.jhat.value & SDL_HAT_DOWN) {
305 controls[UP] = false;
306 controls[DOWN] = true;
308 if(event.jhat.value & SDL_HAT_LEFT) {
309 controls[LEFT] = true;
310 controls[RIGHT] = false;
312 if(event.jhat.value & SDL_HAT_RIGHT) {
313 controls[LEFT] = false;
314 controls[RIGHT] = true;
316 if(event.jhat.value == SDL_HAT_CENTERED) {
317 controls[UP] = false;
318 controls[DOWN] = false;
319 controls[LEFT] = false;
320 controls[RIGHT] = false;
324 case SDL_JOYBUTTONDOWN:
325 case SDL_JOYBUTTONUP:
327 if(wait_for_joybutton >= 0) {
328 if(event.type == SDL_JOYBUTTONUP)
331 Control c = (Control) wait_for_joybutton;
332 reset_joybutton(event.jbutton.button, c);
334 joystick_options_menu->update();
335 wait_for_joybutton = -1;
339 ButtonMap::iterator i = joy_button_map.find(event.jbutton.button);
340 if(i == joy_button_map.end()) {
341 log_debug << "Unmapped joybutton " << (int)event.jbutton.button << " pressed" << std::endl;
345 controls[i->second] =
346 event.type == SDL_JOYBUTTONDOWN ? true : false;
356 JoystickKeyboardController::process_key_event(const SDL_Event& event)
358 KeyMap::iterator key_mapping = keymap.find(event.key.keysym.sym);
360 // if console key was pressed: toggle console
361 if ((key_mapping != keymap.end()) && (key_mapping->second == CONSOLE)) {
362 if (event.type != SDL_KEYDOWN) return;
363 Console::instance->toggle();
367 // if console is open: send key there
368 if (Console::instance->hasFocus()) {
369 process_console_key_event(event);
373 // if menu mode: send key there
374 if (Menu::current()) {
375 process_menu_key_event(event);
379 // default action: update controls
380 if(key_mapping == keymap.end()) {
381 log_debug << "Key " << event.key.keysym.sym << " is unbound" << std::endl;
384 Control control = key_mapping->second;
385 controls[control] = event.type == SDL_KEYDOWN ? true : false;
389 JoystickKeyboardController::process_console_key_event(const SDL_Event& event)
391 if (event.type != SDL_KEYDOWN) return;
393 switch (event.key.keysym.sym) {
395 Console::instance->input << std::endl;
398 Console::instance->backspace();
401 Console::instance->autocomplete();
404 Console::instance->scroll(-1);
407 Console::instance->scroll(+1);
410 Console::instance->scroll(+65535);
413 Console::instance->show_history(-1);
416 Console::instance->show_history(+1);
419 int c = event.key.keysym.unicode;
420 if ((c >= 32) && (c <= 126)) {
421 Console::instance->input << (char)c;
428 JoystickKeyboardController::process_menu_key_event(const SDL_Event& event)
430 // wait for key mode?
431 if(wait_for_key >= 0) {
432 if(event.type == SDL_KEYUP)
435 if(event.key.keysym.sym != SDLK_ESCAPE
436 && event.key.keysym.sym != SDLK_PAUSE) {
437 reset_key(event.key.keysym.sym, (Control) wait_for_key);
440 key_options_menu->update();
444 if(wait_for_joybutton >= 0) {
445 if(event.key.keysym.sym == SDLK_ESCAPE) {
447 joystick_options_menu->update();
448 wait_for_joybutton = -1;
454 /* we use default keys when the menu is open (to avoid problems when
455 * redefining keys to invalid settings
457 switch(event.key.keysym.sym) {
473 control = MENU_SELECT;
477 control = PAUSE_MENU;
484 controls[control] = event.type == SDL_KEYDOWN ? true : false;
488 JoystickKeyboardController::reset_joybutton(int button, Control control)
490 // remove all previous mappings for that control and for that key
491 for(ButtonMap::iterator i = joy_button_map.begin();
492 i != joy_button_map.end(); /* no ++i */) {
493 if(i->second == control) {
494 ButtonMap::iterator e = i;
496 joy_button_map.erase(e);
501 ButtonMap::iterator i = joy_button_map.find(button);
502 if(i != joy_button_map.end())
503 joy_button_map.erase(i);
506 joy_button_map.insert(std::make_pair(button, control));
508 // map all unused buttons to MENU_SELECT
509 for(int b = 0; b < max_joybuttons; ++b) {
510 ButtonMap::iterator i = joy_button_map.find(b);
511 if(i != joy_button_map.end())
514 joy_button_map.insert(std::make_pair(b, MENU_SELECT));
519 JoystickKeyboardController::reset_key(SDLKey key, Control control)
521 // remove all previous mappings for that control and for that key
522 for(KeyMap::iterator i = keymap.begin();
523 i != keymap.end(); /* no ++i */) {
524 if(i->second == control) {
525 KeyMap::iterator e = i;
532 KeyMap::iterator i = keymap.find(key);
533 if(i != keymap.end())
537 keymap.insert(std::make_pair(key, control));
541 JoystickKeyboardController::reversemap_key(Control c)
543 for(KeyMap::iterator i = keymap.begin(); i != keymap.end(); ++i) {
552 JoystickKeyboardController::reversemap_joybutton(Control c)
554 for(ButtonMap::iterator i = joy_button_map.begin();
555 i != joy_button_map.end(); ++i) {
564 JoystickKeyboardController::get_key_options_menu()
566 if(key_options_menu == 0) {
567 key_options_menu = new KeyboardMenu(this);
570 return key_options_menu;
574 JoystickKeyboardController::get_joystick_options_menu()
576 if(joystick_options_menu == 0) {
577 joystick_options_menu = new JoystickMenu(this);
580 return joystick_options_menu;
583 //----------------------------------------------------------------------------
585 JoystickKeyboardController::KeyboardMenu::KeyboardMenu(
586 JoystickKeyboardController* _controller)
587 : controller(_controller)
589 add_label(_("Setup Keyboard"));
591 add_controlfield(Controller::UP, _("Up"));
592 add_controlfield(Controller::DOWN, _("Down"));
593 add_controlfield(Controller::LEFT, _("Left"));
594 add_controlfield(Controller::RIGHT, _("Right"));
595 add_controlfield(Controller::JUMP, _("Jump"));
596 add_controlfield(Controller::ACTION, _("Action"));
597 add_controlfield(Controller::PEEK_LEFT, _("Peek Left"));
598 add_controlfield(Controller::PEEK_RIGHT, _("Peek Right"));
604 JoystickKeyboardController::KeyboardMenu::~KeyboardMenu()
608 JoystickKeyboardController::KeyboardMenu::get_key_name(SDLKey key)
614 return _("Up cursor");
616 return _("Down cursor");
618 return _("Left cursor");
620 return _("Right cursor");
626 return _("Right Shift");
628 return _("Left Shift");
630 return _("Right Control");
632 return _("Left Control");
634 return _("Right Alt");
636 return _("Left Alt");
638 return SDL_GetKeyName((SDLKey) key);
643 JoystickKeyboardController::KeyboardMenu::menu_action(MenuItem* item)
645 assert(item->id >= 0 && item->id < Controller::CONTROLCOUNT);
646 item->change_input(_("Press Key"));
647 controller->wait_for_key = item->id;
651 JoystickKeyboardController::KeyboardMenu::update()
654 get_item_by_id((int) Controller::UP).change_input(get_key_name(
655 controller->reversemap_key(Controller::UP)));
656 get_item_by_id((int) Controller::DOWN).change_input(get_key_name(
657 controller->reversemap_key(Controller::DOWN)));
658 get_item_by_id((int) Controller::LEFT).change_input(get_key_name(
659 controller->reversemap_key(Controller::LEFT)));
660 get_item_by_id((int) Controller::RIGHT).change_input(get_key_name(
661 controller->reversemap_key(Controller::RIGHT)));
662 get_item_by_id((int) Controller::JUMP).change_input(get_key_name(
663 controller->reversemap_key(Controller::JUMP)));
664 get_item_by_id((int) Controller::ACTION).change_input(get_key_name(
665 controller->reversemap_key(Controller::ACTION)));
666 get_item_by_id((int) Controller::PEEK_LEFT).change_input(get_key_name(
667 controller->reversemap_key(Controller::PEEK_LEFT)));
668 get_item_by_id((int) Controller::PEEK_RIGHT).change_input(get_key_name(
669 controller->reversemap_key(Controller::PEEK_RIGHT)));
672 //---------------------------------------------------------------------------
674 JoystickKeyboardController::JoystickMenu::JoystickMenu(
675 JoystickKeyboardController* _controller)
676 : controller(_controller)
678 add_label(_("Setup Joystick"));
680 if(controller->joysticks.size() > 0) {
681 add_controlfield(Controller::JUMP, _("Jump"));
682 add_controlfield(Controller::ACTION, _("Action"));
683 add_controlfield(Controller::PAUSE_MENU, _("Pause/Menu"));
684 add_controlfield(Controller::PEEK_LEFT, _("Peek Left"));
685 add_controlfield(Controller::PEEK_RIGHT, _("Peek Right"));
687 add_deactive(-1, _("No Joysticks found"));
694 JoystickKeyboardController::JoystickMenu::~JoystickMenu()
698 JoystickKeyboardController::JoystickMenu::get_button_name(int button)
703 std::ostringstream name;
704 name << "Button " << button;
709 JoystickKeyboardController::JoystickMenu::menu_action(MenuItem* item)
711 assert(item->id >= 0 && item->id < Controller::CONTROLCOUNT);
712 item->change_input(_("Press Button"));
713 controller->wait_for_joybutton = item->id;
717 JoystickKeyboardController::JoystickMenu::update()
719 if(controller->joysticks.size() == 0)
723 get_item_by_id((int) Controller::JUMP).change_input(get_button_name(
724 controller->reversemap_joybutton(Controller::JUMP)));
725 get_item_by_id((int) Controller::ACTION).change_input(get_button_name(
726 controller->reversemap_joybutton(Controller::ACTION)));
727 get_item_by_id((int) Controller::PAUSE_MENU).change_input(get_button_name(
728 controller->reversemap_joybutton(Controller::PAUSE_MENU)));
729 get_item_by_id((int) Controller::PEEK_LEFT).change_input(get_button_name(
730 controller->reversemap_joybutton(Controller::PEEK_LEFT)));
731 get_item_by_id((int) Controller::PEEK_RIGHT).change_input(get_button_name(
732 controller->reversemap_joybutton(Controller::PEEK_RIGHT)));