776266b3c574b0985c3d672f472ef19cc03eaaa9
[supertux.git] / src / control / joystickkeyboardcontroller.cpp
1 //  $Id$
2 // 
3 //  SuperTux
4 //  Copyright (C) 2005 Matthias Braun <matze@braunis.de>
5 //
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.
10 //
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.
15 // 
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
19 //  02111-1307, USA.
20 #include <config.h>
21
22 #include <sstream>
23 #include "joystickkeyboardcontroller.hpp"
24 #include "msg.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"
31
32 class JoystickKeyboardController::JoystickMenu : public Menu
33 {
34 public:
35   JoystickMenu(JoystickKeyboardController* controller);
36   virtual ~JoystickMenu();
37
38   void update();
39   std::string get_button_name(int button);
40   virtual void menu_action(MenuItem* item);
41   JoystickKeyboardController* controller;
42 };
43
44 class JoystickKeyboardController::KeyboardMenu : public Menu
45 {
46 public:
47   KeyboardMenu(JoystickKeyboardController* controller);
48   ~KeyboardMenu();
49
50   void update();
51   std::string get_key_name(SDLKey key);
52   virtual void menu_action(MenuItem* item);
53   JoystickKeyboardController* controller;
54 };
55   
56 JoystickKeyboardController::JoystickKeyboardController()
57   : wait_for_key(-1), wait_for_joybutton(-1), key_options_menu(0),
58     joystick_options_menu(0)
59 {
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   
75   int joystick_count = SDL_NumJoysticks();
76   min_joybuttons = -1;
77   max_joybuttons = -1;
78   for(int i = 0; i < joystick_count; ++i) {
79     SDL_Joystick* joystick = SDL_JoystickOpen(i);
80     bool good = true;
81     if(SDL_JoystickNumButtons(joystick) < 2) {
82       msg_warning("Joystick " << i << " has less than 2 buttons");
83       good = false;
84     }
85     if(SDL_JoystickNumAxes(joystick) < 2
86        && SDL_JoystickNumHats(joystick) == 0) {
87       msg_warning("Joystick " << i << " has less than 2 axes and no hat");
88       good = false;
89     }
90     if(!good) {
91       SDL_JoystickClose(joystick);
92       continue;
93     }
94     
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);
99     }
100
101     joysticks.push_back(joystick);
102   }
103
104   use_hat = true;
105   joyaxis_x = 0;
106   joyaxis_y = 1;
107   dead_zone_x = 1000;
108   dead_zone_y = 1000;
109   
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));
119   }
120
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) {
124     SDL_Event event;
125     SDL_PollEvent(&event);
126   }
127 }
128
129 JoystickKeyboardController::~JoystickKeyboardController()
130 {
131   for(std::vector<SDL_Joystick*>::iterator i = joysticks.begin();
132       i != joysticks.end(); ++i) {
133     if(*i != 0)
134       SDL_JoystickClose(*i);
135   }
136
137   delete key_options_menu;
138   delete joystick_options_menu;
139 }
140
141 void
142 JoystickKeyboardController::read(const lisp::Lisp& lisp)
143 {
144   const lisp::Lisp* keymap_lisp = lisp.get_lisp("keymap");
145   if(keymap_lisp) {
146     keymap.clear();
147     lisp::ListIterator iter(keymap_lisp);
148     while(iter.next()) {
149       if(iter.item() == "map") {
150         int key = -1;
151         std::string control;
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");
157           continue;
158         }
159
160         int i = 0;
161         for(i = 0; controlNames[i] != 0; ++i) {
162           if(control == controlNames[i])
163             break;
164         }
165         if(controlNames[i] == 0) {
166           msg_warning("Invalid control '" << control << "' in keymap");
167           continue;
168         }
169         keymap.insert(std::make_pair((SDLKey) key, (Control) i));
170       } else {
171         msg_warning("Invalid lisp element '" << iter.item() << "' in keymap");
172       }
173     }
174   }
175
176   const lisp::Lisp* joystick_lisp = lisp.get_lisp("joystick");
177   if(joystick_lisp) {
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);
184     while(iter.next()) {
185       if(iter.item() == "map") {
186         int button = -1;
187         std::string control;
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");
193           continue;
194         }
195         
196         int i = 0;
197         for(i = 0; controlNames[i] != 0; ++i) {
198           if(control == controlNames[i])
199             break;
200         }                                                                           
201         if(controlNames[i] == 0) {
202           msg_warning("Invalid control '" << control << "' in buttonmap");
203           continue;
204         }
205         reset_joybutton(button, (Control) i);
206       }
207     }
208   }
209 }
210
211 void
212 JoystickKeyboardController::write(lisp::Writer& writer)
213 {
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");
220   }
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();
229       ++i) {
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");
234   }
235   writer.end_list("joystick");  
236 }
237
238 void
239 JoystickKeyboardController::reset()
240 {
241   Controller::reset();
242 }
243
244 void
245 JoystickKeyboardController::process_event(const SDL_Event& event)
246 {
247   switch(event.type) {
248     case SDL_KEYUP:
249     case SDL_KEYDOWN:
250       process_key_event(event);
251       break;
252
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;
261         } else {
262           controls[LEFT] = false;
263           controls[RIGHT] = false;
264         }
265       } else if(event.jaxis.axis == joyaxis_y) {
266         if(event.jaxis.value < -dead_zone_y) {
267           controls[UP] = true;
268           controls[DOWN] = false;
269         } else if(event.jaxis.value > dead_zone_y) {
270           controls[UP] = false;
271           controls[DOWN] = true;
272         } else {
273           controls[UP] = false;
274           controls[DOWN] = false;
275         }
276       }
277       break;
278
279     case SDL_JOYHATMOTION:
280       if(!use_hat)
281         break;
282       
283       if(event.jhat.value & SDL_HAT_UP) {
284         controls[UP] = true;
285         controls[DOWN] = false;
286       }
287       if(event.jhat.value & SDL_HAT_DOWN) {
288         controls[UP] = false;
289         controls[DOWN] = true;
290       }
291       if(event.jhat.value & SDL_HAT_LEFT) {
292         controls[LEFT] = true;
293         controls[RIGHT] = false;
294       }
295       if(event.jhat.value & SDL_HAT_RIGHT) {
296         controls[LEFT] = false;
297         controls[RIGHT] = true;
298       }
299       if(event.jhat.value == SDL_HAT_CENTERED) {
300         controls[UP] = false;
301         controls[DOWN] = false;
302         controls[LEFT] = false;
303         controls[RIGHT] = false;
304       }
305       break;
306
307     case SDL_JOYBUTTONDOWN:
308     case SDL_JOYBUTTONUP:
309     {
310       if(wait_for_joybutton >= 0) {
311         if(event.type == SDL_JOYBUTTONUP)
312           return;
313
314         Control c = (Control) wait_for_joybutton;
315         reset_joybutton(event.jbutton.button, c);
316         reset();
317         joystick_options_menu->update();
318         wait_for_joybutton = -1;
319         return;
320       }
321
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
325           << " pressed");
326         return;
327       }
328       
329       controls[i->second] =
330         event.type == SDL_JOYBUTTONDOWN ? true : false;
331       break;
332     }
333
334     default:
335       break;
336   }
337 }
338
339 void
340 JoystickKeyboardController::process_key_event(const SDL_Event& event)
341 {
342   KeyMap::iterator key_mapping = keymap.find(event.key.keysym.sym);
343
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;
347     Console::toggle();
348     return;
349   }
350
351   // if console is open: send key there
352   if (Console::hasFocus()) {
353     process_console_key_event(event);
354     return;
355   } 
356
357   // if menu mode: send key there
358   if (Menu::current()) { 
359     process_menu_key_event(event);
360     return;
361   }
362
363   // default action: update controls
364   if(key_mapping == keymap.end()) {
365     msg_debug("Key " << event.key.keysym.sym << " is unbound");
366     return;
367   }
368   Control control = key_mapping->second;
369   controls[control] = event.type == SDL_KEYDOWN ? true : false;
370 }
371
372 void
373 JoystickKeyboardController::process_console_key_event(const SDL_Event& event)
374 {
375   if (event.type != SDL_KEYDOWN) return;
376
377   switch (event.key.keysym.sym) {
378     case SDLK_RETURN:
379       Console::input << std::endl;
380       break;
381     case SDLK_BACKSPACE:
382       Console::backspace();
383       break;
384     case SDLK_TAB:
385       Console::autocomplete();
386       break;
387     case SDLK_PAGEUP:
388       Console::scroll(-1);
389       break;
390     case SDLK_PAGEDOWN:
391       Console::scroll(+1);
392       break;
393     case SDLK_END:
394       Console::scroll(+65535);
395       break;
396     default:
397       int c = event.key.keysym.unicode;
398       if ((c >= 32) && (c <= 126)) {
399         Console::input << (char)c;
400       }
401       break;
402   }
403 }
404
405 void
406 JoystickKeyboardController::process_menu_key_event(const SDL_Event& event)
407 {
408   // wait for key mode?
409   if(wait_for_key >= 0) {
410     if(event.type == SDL_KEYUP)
411       return;
412
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);
416     }
417     reset();
418     key_options_menu->update();
419     wait_for_key = -1;
420     return;
421   } 
422   if(wait_for_joybutton >= 0) {
423     if(event.key.keysym.sym == SDLK_ESCAPE) {
424       reset();
425       joystick_options_menu->update();
426       wait_for_joybutton = -1;
427     }
428     return;
429   }
430  
431   Control control;
432   /* we use default keys when the menu is open (to avoid problems when
433    * redefining keys to invalid settings
434    */
435   switch(event.key.keysym.sym) {
436     case SDLK_UP:
437       control = UP;
438       break;
439     case SDLK_DOWN:
440       control = DOWN;
441       break;
442     case SDLK_LEFT:
443       control = LEFT;
444       break;
445     case SDLK_RIGHT:
446       control = RIGHT;
447       break;
448     case SDLK_SPACE:
449     case SDLK_RETURN:
450     case SDLK_KP_ENTER:
451       control = MENU_SELECT;
452       break;
453     case SDLK_ESCAPE:
454     case SDLK_PAUSE:
455       control = PAUSE_MENU;
456       break;
457     default:
458       return;
459       break;
460   }
461
462   controls[control] = event.type == SDL_KEYDOWN ? true : false;
463 }
464
465 void
466 JoystickKeyboardController::reset_joybutton(int button, Control control)
467 {
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;
473       ++i;
474       joy_button_map.erase(e);
475     } else {
476       ++i;
477     }
478   }
479   ButtonMap::iterator i = joy_button_map.find(button);
480   if(i != joy_button_map.end())
481     joy_button_map.erase(i);
482
483   // add new mapping
484   joy_button_map.insert(std::make_pair(button, control));
485
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())
490       continue;
491
492     joy_button_map.insert(std::make_pair(b, MENU_SELECT));
493   }
494 }
495
496 void
497 JoystickKeyboardController::reset_key(SDLKey key, Control control)
498 {
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;
504       ++i;
505       keymap.erase(e);
506     } else {
507       ++i;
508     }
509   }
510   KeyMap::iterator i = keymap.find(key);
511   if(i != keymap.end())
512     keymap.erase(i);
513
514   // add new mapping
515   keymap.insert(std::make_pair(key, control));
516 }
517
518 SDLKey
519 JoystickKeyboardController::reversemap_key(Control c)
520 {
521   for(KeyMap::iterator i = keymap.begin(); i != keymap.end(); ++i) {
522     if(i->second == c)
523       return i->first;
524   }
525
526   return SDLK_UNKNOWN;
527 }
528
529 int
530 JoystickKeyboardController::reversemap_joybutton(Control c)
531 {
532   for(ButtonMap::iterator i = joy_button_map.begin();
533       i != joy_button_map.end(); ++i) {
534     if(i->second == c)
535       return i->first;
536   }
537
538   return -1;
539 }
540
541 Menu*
542 JoystickKeyboardController::get_key_options_menu()
543 {
544   if(key_options_menu == 0) {
545     key_options_menu = new KeyboardMenu(this);
546   }
547
548   return key_options_menu;
549 }
550
551 Menu*
552 JoystickKeyboardController::get_joystick_options_menu()
553 {
554   if(joystick_options_menu == 0) {
555     joystick_options_menu = new JoystickMenu(this);
556   }
557
558   return joystick_options_menu;
559 }
560
561 //----------------------------------------------------------------------------
562
563 JoystickKeyboardController::KeyboardMenu::KeyboardMenu(
564     JoystickKeyboardController* _controller)
565   : controller(_controller)
566 {
567     add_label(_("Keyboard Setup"));
568     add_hl();
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"));
575     add_hl();
576     add_back(_("Back"));
577     update();
578 }
579
580 JoystickKeyboardController::KeyboardMenu::~KeyboardMenu()
581 {}
582
583 std::string
584 JoystickKeyboardController::KeyboardMenu::get_key_name(SDLKey key)
585 {
586   switch(key) {
587     case SDLK_UNKNOWN:
588       return _("None");
589     case SDLK_UP:
590       return _("Up cursor");
591     case SDLK_DOWN:
592       return _("Down cursor");
593     case SDLK_LEFT:
594       return _("Left cursor");
595     case SDLK_RIGHT:
596       return _("Right cursor");
597     case SDLK_RETURN:
598       return _("Return");
599     case SDLK_SPACE:
600       return _("Space");
601     case SDLK_RSHIFT:
602       return _("Right Shift");
603     case SDLK_LSHIFT:
604       return _("Left Shift");
605     case SDLK_RCTRL:
606       return _("Right Control");
607     case SDLK_LCTRL:
608       return _("Left Control");
609     case SDLK_RALT:
610       return _("Right Alt");
611     case SDLK_LALT:
612       return _("Left Alt");
613     default:
614       return SDL_GetKeyName((SDLKey) key);
615   }
616 }
617
618 void
619 JoystickKeyboardController::KeyboardMenu::menu_action(MenuItem* item)
620 {
621   assert(item->id >= 0 && item->id < Controller::CONTROLCOUNT);
622   item->change_input(_("Press Key"));
623   controller->wait_for_key = item->id;
624 }
625
626 void
627 JoystickKeyboardController::KeyboardMenu::update()
628 {
629   // update menu
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)));
642 }
643
644 //---------------------------------------------------------------------------
645
646 JoystickKeyboardController::JoystickMenu::JoystickMenu(
647   JoystickKeyboardController* _controller)
648   : controller(_controller)
649 {
650   add_label(_("Joystick Setup"));
651   add_hl();
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"));
656   } else {
657     add_deactive(-1, _("No Joysticks found"));
658   }
659   add_hl();
660   add_back(_("Back"));
661   update();
662 }
663
664 JoystickKeyboardController::JoystickMenu::~JoystickMenu()
665 {}
666
667 std::string
668 JoystickKeyboardController::JoystickMenu::get_button_name(int button)
669 {
670   if(button < 0)
671     return _("None");
672     
673   std::ostringstream name;
674   name << "Button " << button;
675   return name.str();
676 }
677
678 void
679 JoystickKeyboardController::JoystickMenu::menu_action(MenuItem* item)
680 {
681   assert(item->id >= 0 && item->id < Controller::CONTROLCOUNT);
682   item->change_input(_("Press Button"));
683   controller->wait_for_joybutton = item->id;
684 }
685
686 void
687 JoystickKeyboardController::JoystickMenu::update()
688 {
689   if(controller->joysticks.size() == 0)
690     return;
691
692   // update menu
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)));
699 }
700