4 // Copyright (C) 2005 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
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));
75 int joystick_count = SDL_NumJoysticks();
78 for(int i = 0; i < joystick_count; ++i) {
79 SDL_Joystick* joystick = SDL_JoystickOpen(i);
81 if(SDL_JoystickNumButtons(joystick) < 2) {
82 msg_warning("Joystick " << i << " has less than 2 buttons");
85 if(SDL_JoystickNumAxes(joystick) < 2
86 && SDL_JoystickNumHats(joystick) == 0) {
87 msg_warning("Joystick " << i << " has less than 2 axes and no hat");
91 SDL_JoystickClose(joystick);
95 if(min_joybuttons < 0 || SDL_JoystickNumButtons(joystick) < min_joybuttons)
96 min_joybuttons = SDL_JoystickNumButtons(joystick);
97 if(SDL_JoystickNumButtons(joystick) > max_joybuttons) {
98 max_joybuttons = SDL_JoystickNumButtons(joystick);
101 joysticks.push_back(joystick);
110 joy_button_map.insert(std::make_pair(0, JUMP));
111 joy_button_map.insert(std::make_pair(1, ACTION));
112 // map the last 2 buttons to menu and pause
113 if(min_joybuttons > 2)
114 joy_button_map.insert(std::make_pair(min_joybuttons-1, PAUSE_MENU));
115 // map all remaining joystick buttons to MENU_SELECT
116 for(int i = 2; i < max_joybuttons; ++i) {
117 if(i != min_joybuttons-1)
118 joy_button_map.insert(std::make_pair(i, MENU_SELECT));
121 // some joysticks or SDL seem to produce some bogus events after being opened
122 Uint32 ticks = SDL_GetTicks();
123 while(SDL_GetTicks() - ticks < 200) {
125 SDL_PollEvent(&event);
129 JoystickKeyboardController::~JoystickKeyboardController()
131 for(std::vector<SDL_Joystick*>::iterator i = joysticks.begin();
132 i != joysticks.end(); ++i) {
134 SDL_JoystickClose(*i);
137 delete key_options_menu;
138 delete joystick_options_menu;
142 JoystickKeyboardController::read(const lisp::Lisp& lisp)
144 const lisp::Lisp* keymap_lisp = lisp.get_lisp("keymap");
147 lisp::ListIterator iter(keymap_lisp);
149 if(iter.item() == "map") {
152 const lisp::Lisp* map = iter.lisp();
153 map->get("key", key);
154 map->get("control", control);
155 if(key < SDLK_FIRST || key >= SDLK_LAST) {
156 msg_warning("Invalid key '" << key << "' in keymap");
161 for(i = 0; controlNames[i] != 0; ++i) {
162 if(control == controlNames[i])
165 if(controlNames[i] == 0) {
166 msg_warning("Invalid control '" << control << "' in keymap");
169 keymap.insert(std::make_pair((SDLKey) key, (Control) i));
171 msg_warning("Invalid lisp element '" << iter.item() << "' in keymap");
176 const lisp::Lisp* joystick_lisp = lisp.get_lisp("joystick");
178 joystick_lisp->get("use_hat", use_hat);
179 joystick_lisp->get("axis_x", joyaxis_x);
180 joystick_lisp->get("axis_y", joyaxis_y);
181 joystick_lisp->get("dead_zone_x", dead_zone_x);
182 joystick_lisp->get("dead_zone_y", dead_zone_y);
183 lisp::ListIterator iter(joystick_lisp);
185 if(iter.item() == "map") {
188 const lisp::Lisp* map = iter.lisp();
189 map->get("button", button);
190 map->get("control", control);
191 if(button < 0 || button >= max_joybuttons) {
192 msg_warning("Invalid button '" << button << "' in buttonmap");
197 for(i = 0; controlNames[i] != 0; ++i) {
198 if(control == controlNames[i])
201 if(controlNames[i] == 0) {
202 msg_warning("Invalid control '" << control << "' in buttonmap");
205 reset_joybutton(button, (Control) i);
212 JoystickKeyboardController::write(lisp::Writer& writer)
214 writer.start_list("keymap");
215 for(KeyMap::iterator i = keymap.begin(); i != keymap.end(); ++i) {
216 writer.start_list("map");
217 writer.write_int("key", (int) i->first);
218 writer.write_string("control", controlNames[i->second]);
219 writer.end_list("map");
221 writer.end_list("keymap");
222 writer.start_list("joystick");
223 writer.write_bool("use_hat", use_hat);
224 writer.write_int("axis_x", joyaxis_x);
225 writer.write_int("axis_y", joyaxis_y);
226 writer.write_int("dead_zone_x", dead_zone_x);
227 writer.write_int("dead_zone_y", dead_zone_y);
228 for(ButtonMap::iterator i = joy_button_map.begin(); i != joy_button_map.end();
230 writer.start_list("map");
231 writer.write_int("button", i->first);
232 writer.write_string("control", controlNames[i->second]);
233 writer.end_list("map");
235 writer.end_list("joystick");
239 JoystickKeyboardController::reset()
245 JoystickKeyboardController::process_event(const SDL_Event& event)
250 process_key_event(event);
253 case SDL_JOYAXISMOTION:
254 if(event.jaxis.axis == joyaxis_x) {
255 if(event.jaxis.value < -dead_zone_x) {
256 controls[LEFT] = true;
257 controls[RIGHT] = false;
258 } else if(event.jaxis.value > dead_zone_x) {
259 controls[LEFT] = false;
260 controls[RIGHT] = true;
262 controls[LEFT] = false;
263 controls[RIGHT] = false;
265 } else if(event.jaxis.axis == joyaxis_y) {
266 if(event.jaxis.value < -dead_zone_y) {
268 controls[DOWN] = false;
269 } else if(event.jaxis.value > dead_zone_y) {
270 controls[UP] = false;
271 controls[DOWN] = true;
273 controls[UP] = false;
274 controls[DOWN] = false;
279 case SDL_JOYHATMOTION:
283 if(event.jhat.value & SDL_HAT_UP) {
285 controls[DOWN] = false;
287 if(event.jhat.value & SDL_HAT_DOWN) {
288 controls[UP] = false;
289 controls[DOWN] = true;
291 if(event.jhat.value & SDL_HAT_LEFT) {
292 controls[LEFT] = true;
293 controls[RIGHT] = false;
295 if(event.jhat.value & SDL_HAT_RIGHT) {
296 controls[LEFT] = false;
297 controls[RIGHT] = true;
299 if(event.jhat.value == SDL_HAT_CENTERED) {
300 controls[UP] = false;
301 controls[DOWN] = false;
302 controls[LEFT] = false;
303 controls[RIGHT] = false;
307 case SDL_JOYBUTTONDOWN:
308 case SDL_JOYBUTTONUP:
310 if(wait_for_joybutton >= 0) {
311 if(event.type == SDL_JOYBUTTONUP)
314 Control c = (Control) wait_for_joybutton;
315 reset_joybutton(event.jbutton.button, c);
317 joystick_options_menu->update();
318 wait_for_joybutton = -1;
322 ButtonMap::iterator i = joy_button_map.find(event.jbutton.button);
323 if(i == joy_button_map.end()) {
324 msg_debug("Unmapped joybutton " << (int) event.jbutton.button
329 controls[i->second] =
330 event.type == SDL_JOYBUTTONDOWN ? true : false;
340 JoystickKeyboardController::process_key_event(const SDL_Event& event)
342 KeyMap::iterator key_mapping = keymap.find(event.key.keysym.sym);
344 // if console key was pressed: toggle console
345 if ((key_mapping != keymap.end()) && (key_mapping->second == CONSOLE)) {
346 if (event.type != SDL_KEYDOWN) return;
351 // if console is open: send key there
352 if (Console::hasFocus()) {
353 process_console_key_event(event);
357 // if menu mode: send key there
358 if (Menu::current()) {
359 process_menu_key_event(event);
363 // default action: update controls
364 if(key_mapping == keymap.end()) {
365 msg_debug("Key " << event.key.keysym.sym << " is unbound");
368 Control control = key_mapping->second;
369 controls[control] = event.type == SDL_KEYDOWN ? true : false;
373 JoystickKeyboardController::process_console_key_event(const SDL_Event& event)
375 if (event.type != SDL_KEYDOWN) return;
377 switch (event.key.keysym.sym) {
379 Console::input << std::endl;
382 Console::backspace();
385 Console::autocomplete();
394 Console::scroll(+65535);
397 int c = event.key.keysym.unicode;
398 if ((c >= 32) && (c <= 126)) {
399 Console::input << (char)c;
406 JoystickKeyboardController::process_menu_key_event(const SDL_Event& event)
408 // wait for key mode?
409 if(wait_for_key >= 0) {
410 if(event.type == SDL_KEYUP)
413 if(event.key.keysym.sym != SDLK_ESCAPE
414 && event.key.keysym.sym != SDLK_PAUSE) {
415 reset_key(event.key.keysym.sym, (Control) wait_for_key);
418 key_options_menu->update();
422 if(wait_for_joybutton >= 0) {
423 if(event.key.keysym.sym == SDLK_ESCAPE) {
425 joystick_options_menu->update();
426 wait_for_joybutton = -1;
432 /* we use default keys when the menu is open (to avoid problems when
433 * redefining keys to invalid settings
435 switch(event.key.keysym.sym) {
451 control = MENU_SELECT;
455 control = PAUSE_MENU;
462 controls[control] = event.type == SDL_KEYDOWN ? true : false;
466 JoystickKeyboardController::reset_joybutton(int button, Control control)
468 // remove all previous mappings for that control and for that key
469 for(ButtonMap::iterator i = joy_button_map.begin();
470 i != joy_button_map.end(); /* no ++i */) {
471 if(i->second == control) {
472 ButtonMap::iterator e = i;
474 joy_button_map.erase(e);
479 ButtonMap::iterator i = joy_button_map.find(button);
480 if(i != joy_button_map.end())
481 joy_button_map.erase(i);
484 joy_button_map.insert(std::make_pair(button, control));
486 // map all unused buttons to MENU_SELECT
487 for(int b = 0; b < max_joybuttons; ++b) {
488 ButtonMap::iterator i = joy_button_map.find(b);
489 if(i != joy_button_map.end())
492 joy_button_map.insert(std::make_pair(b, MENU_SELECT));
497 JoystickKeyboardController::reset_key(SDLKey key, Control control)
499 // remove all previous mappings for that control and for that key
500 for(KeyMap::iterator i = keymap.begin();
501 i != keymap.end(); /* no ++i */) {
502 if(i->second == control) {
503 KeyMap::iterator e = i;
510 KeyMap::iterator i = keymap.find(key);
511 if(i != keymap.end())
515 keymap.insert(std::make_pair(key, control));
519 JoystickKeyboardController::reversemap_key(Control c)
521 for(KeyMap::iterator i = keymap.begin(); i != keymap.end(); ++i) {
530 JoystickKeyboardController::reversemap_joybutton(Control c)
532 for(ButtonMap::iterator i = joy_button_map.begin();
533 i != joy_button_map.end(); ++i) {
542 JoystickKeyboardController::get_key_options_menu()
544 if(key_options_menu == 0) {
545 key_options_menu = new KeyboardMenu(this);
548 return key_options_menu;
552 JoystickKeyboardController::get_joystick_options_menu()
554 if(joystick_options_menu == 0) {
555 joystick_options_menu = new JoystickMenu(this);
558 return joystick_options_menu;
561 //----------------------------------------------------------------------------
563 JoystickKeyboardController::KeyboardMenu::KeyboardMenu(
564 JoystickKeyboardController* _controller)
565 : controller(_controller)
567 add_label(_("Keyboard Setup"));
569 add_controlfield(Controller::UP, _("Up"));
570 add_controlfield(Controller::DOWN, _("Down"));
571 add_controlfield(Controller::LEFT, _("Left"));
572 add_controlfield(Controller::RIGHT, _("Right"));
573 add_controlfield(Controller::JUMP, _("Jump"));
574 add_controlfield(Controller::ACTION, _("Shoot/Run"));
580 JoystickKeyboardController::KeyboardMenu::~KeyboardMenu()
584 JoystickKeyboardController::KeyboardMenu::get_key_name(SDLKey key)
590 return _("Up cursor");
592 return _("Down cursor");
594 return _("Left cursor");
596 return _("Right cursor");
602 return _("Right Shift");
604 return _("Left Shift");
606 return _("Right Control");
608 return _("Left Control");
610 return _("Right Alt");
612 return _("Left Alt");
614 return SDL_GetKeyName((SDLKey) key);
619 JoystickKeyboardController::KeyboardMenu::menu_action(MenuItem* item)
621 assert(item->id >= 0 && item->id < Controller::CONTROLCOUNT);
622 item->change_input(_("Press Key"));
623 controller->wait_for_key = item->id;
627 JoystickKeyboardController::KeyboardMenu::update()
630 get_item_by_id((int) Controller::UP).change_input(get_key_name(
631 controller->reversemap_key(Controller::UP)));
632 get_item_by_id((int) Controller::DOWN).change_input(get_key_name(
633 controller->reversemap_key(Controller::DOWN)));
634 get_item_by_id((int) Controller::LEFT).change_input(get_key_name(
635 controller->reversemap_key(Controller::LEFT)));
636 get_item_by_id((int) Controller::RIGHT).change_input(get_key_name(
637 controller->reversemap_key(Controller::RIGHT)));
638 get_item_by_id((int) Controller::JUMP).change_input(get_key_name(
639 controller->reversemap_key(Controller::JUMP)));
640 get_item_by_id((int) Controller::ACTION).change_input(get_key_name(
641 controller->reversemap_key(Controller::ACTION)));
644 //---------------------------------------------------------------------------
646 JoystickKeyboardController::JoystickMenu::JoystickMenu(
647 JoystickKeyboardController* _controller)
648 : controller(_controller)
650 add_label(_("Joystick Setup"));
652 if(controller->joysticks.size() > 0) {
653 add_controlfield(Controller::JUMP, _("Jump"));
654 add_controlfield(Controller::ACTION, _("Shoot/Run"));
655 add_controlfield(Controller::PAUSE_MENU, _("Pause/Menu"));
657 add_deactive(-1, _("No Joysticks found"));
664 JoystickKeyboardController::JoystickMenu::~JoystickMenu()
668 JoystickKeyboardController::JoystickMenu::get_button_name(int button)
673 std::ostringstream name;
674 name << "Button " << button;
679 JoystickKeyboardController::JoystickMenu::menu_action(MenuItem* item)
681 assert(item->id >= 0 && item->id < Controller::CONTROLCOUNT);
682 item->change_input(_("Press Button"));
683 controller->wait_for_joybutton = item->id;
687 JoystickKeyboardController::JoystickMenu::update()
689 if(controller->joysticks.size() == 0)
693 get_item_by_id((int) Controller::JUMP).change_input(get_button_name(
694 controller->reversemap_joybutton(Controller::JUMP)));
695 get_item_by_id((int) Controller::ACTION).change_input(get_button_name(
696 controller->reversemap_joybutton(Controller::ACTION)));
697 get_item_by_id((int) Controller::PAUSE_MENU).change_input(get_button_name(
698 controller->reversemap_joybutton(Controller::PAUSE_MENU)));