src/io/key.cpp

   1 /*
   2  * Copyright (C) Volition, Inc. 1999.  All rights reserved.
   3  *
   4  * All source code herein is the property of Volition, Inc. You may not sell
   5  * or otherwise commercially exploit the source or things you created based on
   6  * the source.
   7  */
   8
   9 /*
  10  * $Logfile: /Freespace2/code/Io/Key.cpp $
  11  * $Revision$
  12  * $Date$
  13  * $Author$
  14  *
  15  * <insert description of file here>
  16  *
  17  * $Log$
  18  * Revision 1.12  2004/06/11 01:14:12  tigital
  19  * OSX: switched to __APPLE__
  20  *
  21  * Revision 1.11  2003/05/18 03:57:08  taylor
  22  * do not swap German z and y keys if they are already swapped
  23  *
  24  * Revision 1.9  2003/01/30 19:55:01  relnev
  25  * add German keys (this is mostly a patch already sent in by someone else that hasn't made it into cvs yet) (Taylor Richards)
  26  *
  27  * Revision 1.8  2002/06/17 23:11:39  relnev
  28  * enable sdl key repeating.
  29  *
  30  * swap '/` keys.
  31  *
  32  * Revision 1.7  2002/06/09 04:41:21  relnev
  33  * added copyright header
  34  *
  35  * Revision 1.6  2002/06/05 04:03:32  relnev
  36  * finished cfilesystem.
  37  *
  38  * removed some old code.
  39  *
  40  * fixed mouse save off-by-one.
  41  *
  42  * sound cleanups.
  43  *
  44  * Revision 1.5  2002/05/31 03:34:02  theoddone33
  45  * Fix Keyboard
  46  * Add titlebar
  47  *
  48  * Revision 1.4  2002/05/30 23:46:29  theoddone33
  49  * some minor key changes (not necessarily fixes)
  50  *
  51  * Revision 1.3  2002/05/30 16:50:24  theoddone33
  52  * Keyboard partially fixed
  53  *
  54  * Revision 1.2  2002/05/29 23:17:50  theoddone33
  55  * Non working text code and fixed keys
  56  *
  57  * Revision 1.1.1.1  2002/05/03 03:28:09  root
  58  * Initial import.
  59  *
  60  *
  61  * 6     10/29/99 6:10p Jefff
  62  * squashed the damned y/z german issues once and for all
  63  *
  64  * 5     6/07/99 1:21p Dave
  65  * Fixed debug console scrolling problem. Thread related.
  66  *
  67  * 4     6/02/99 6:18p Dave
  68  * Fixed TNT lockup problems! Wheeeee!
  69  *
  70  * 3     11/05/98 4:18p Dave
  71  * First run nebula support. Beefed up localization a bit. Removed all
  72  * conditional compiles for foreign versions. Modified mission file
  73  * format.
  74  *
  75  * 2     10/07/98 10:53a Dave
  76  * Initial checkin.
  77  *
  78  * 1     10/07/98 10:49a Dave
  79  *
  80  * 37    6/19/98 3:50p Lawrance
  81  * change GERMAN to GR_BUILD
  82  *
  83  * 36    6/17/98 11:05a Lawrance
  84  * translate french and german keys
  85  *
  86  * 35    6/12/98 4:49p Hoffoss
  87  * Added code to remap scancodes for german and french keyboards.
  88  *
  89  * 34    5/20/98 12:10a Mike
  90  * Remove mprintfs.
  91  *
  92  * 33    5/19/98 12:19p Mike
  93  * Cheat codes!
  94  *
  95  * 32    5/19/98 12:28a Mike
  96  * Cheat stuff.
  97  *
  98  * 31    5/18/98 11:01p Mike
  99  * Adding support for cheat system.
 100  *
 101  * 30    5/11/98 12:09a Lawrance
 102  * Put in code to turn on/off NumLock key when running under 95
 103  *
 104  * 29    5/01/98 4:23p Lawrance
 105  * Remap the scancode for the UK "\" key
 106  *
 107  * 28    4/18/98 12:42p John
 108  * Added code to use DirectInput to read keyboard. Took out because it
 109  * didn't differentiate btwn Pause and Numlock and sometimes Ctrl.
 110  *
 111  * 27    4/13/98 10:16a John
 112  * Switched gettime back to timer_get_milliseconds, which is now thread
 113  * safe.
 114  *
 115  * 26    4/12/98 11:08p Lawrance
 116  * switch back to using gettime() in separate threads
 117  *
 118  * 25    4/12/98 5:31p Lawrance
 119  * use timer_get_milliseconds() instead of gettime()
 120  *
 121  * 24    3/25/98 8:08p John
 122  * Restructured software rendering into two modules; One for windowed
 123  * debug mode and one for DirectX fullscreen.
 124  *
 125  * 23    1/23/98 3:49p Mike
 126  * Fix bug in negative time-down due to latency.
 127  *
 128  * 22    1/07/98 6:41p Lawrance
 129  * Pass message latency to the keyboard lib.
 130  *
 131  * 21    11/17/97 10:42a John
 132  * On Debug+Backsp, cleared out keys so that it looks like nothing ever
 133  * happened, so they're not stuck down.
 134  *
 135  * 20    11/14/97 4:33p Mike
 136  * Change Debug key to backquote (from F11).
 137  * Balance a ton of subsystems in ships.tbl.
 138  * Change "Heavy Laser" to "Disruptor".
 139  *
 140  * 19    9/13/97 9:30a Lawrance
 141  * added ability to block certain keys from the keyboard
 142  *
 143  * 18    9/10/97 6:02p Hoffoss
 144  * Added code to check for key-pressed sexp operator in FreeSpace as part
 145  * of training mission stuff.
 146  *
 147  * 17    9/09/97 11:08a Sandeep
 148  * fixed warning level 4
 149  *
 150  * 16    7/29/97 5:30p Lawrance
 151  * move gettime() to timer module
 152  *
 153  * 15    4/22/97 10:56a John
 154  * fixed some resource leaks.
 155  *
 156  * 14    2/03/97 4:23p Allender
 157  * use F11 as debug key now
 158  *
 159  * 13    1/10/97 5:15p Mike
 160  * Moved ship-specific parameters from obj_subsystem to ship_subsys.
 161  *
 162  * Added turret code to AI system.
 163  *
 164  * $NoKeywords: $
 165  */
 166
 167 #include <ctype.h>      // for toupper
 168 #include <deque>
 169 #include "pstypes.h"
 170 #include "key.h"
 171 #include "fix.h"
 172 #include "timer.h"
 173 #include "osapi.h"
 174 #include "localize.h"
 175
 176 #define KEY_BUFFER_SIZE 16
 177
 178 //-------- Variable accessed by outside functions ---------
 179 ubyte                           keyd_buffer_type;               // 0=No buffer, 1=buffer ASCII, 2=buffer scans
 180 ubyte                           keyd_repeat;
 181 uint                            keyd_last_pressed;
 182 uint                            keyd_last_released;
 183 int                             keyd_time_when_last_pressed;
 184
 185 static bool             keyd_pressed[SDL_NUM_SCANCODES];
 186
 187 typedef struct keyboard {
 188         ushort                  keybuffer[KEY_BUFFER_SIZE];
 189         uint                            time_pressed[KEY_BUFFER_SIZE];
 190         uint                            TimeKeyWentDown[SDL_NUM_SCANCODES];
 191         uint                            TimeKeyHeldDown[SDL_NUM_SCANCODES];
 192         uint                            TimeKeyDownChecked[SDL_NUM_SCANCODES];
 193         uint                            NumDowns[SDL_NUM_SCANCODES];
 194         uint                            NumUps[SDL_NUM_SCANCODES];
 195         int                             down_check[SDL_NUM_SCANCODES];  // nonzero if has been pressed yet this mission
 196         uint                            keyhead, keytail;
 197 } keyboard;
 198
 199 keyboard key_data;
 200
 201 int key_inited = 0;
 202
 203 //int Backspace_debug=1;        // global flag that will enable/disable the backspace key from stopping execution
 204                                                                 // This flag was created since the backspace key is also used to correct mistakes
 205                                                                 // when typing in your pilots callsign.  This global flag is checked before execution
 206                                                                 // is stopped.
 207
 208 // used to limit the keypresses that are accepted from the keyboard
 209 #define MAX_FILTER_KEYS 64
 210 int Num_filter_keys;
 211 int Key_filter[MAX_FILTER_KEYS];
 212
 213 static int Key_numlock_was_on = 0;      // Flag to indicate whether NumLock is on at start
 214
 215 int Cheats_enabled = 0;
 216 int Key_normal_game = 0;
 217
 218 static std::deque<int> key_text_input;
 219
 220
 221 void key_set_text_input(int ch)
 222 {
 223         key_text_input.push_back(ch);
 224 }
 225
 226 int key_get_text_input()
 227 {
 228         if ( key_text_input.empty() ) {
 229                 return -1;
 230         }
 231
 232         int ch = key_text_input.front();
 233
 234         key_text_input.pop_front();
 235
 236         return ch;
 237 }
 238
 239 void key_clear_text_input()
 240 {
 241         key_text_input.clear();
 242 }
 243
 244 bool key_pressed(int keycode)
 245 {
 246         SDL_Scancode scancode = SDL_GetScancodeFromKey(keycode & KEY_MASK);
 247
 248         return keyd_pressed[scancode];
 249 }
 250
 251 int key_numlock_is_on()
 252 {
 253         const Uint8 *state;
 254         state = SDL_GetKeyboardState(NULL);
 255         if ( state[SDL_SCANCODE_NUMLOCKCLEAR] ) {
 256                 return 1;
 257         }
 258
 259         return 0;
 260 }
 261
 262 void key_turn_off_numlock()
 263 {
 264 }
 265
 266 void key_turn_on_numlock()
 267 {
 268 }
 269
 270 // checks if a keycode is ASCII printable or not
 271 // returns true if ASCII, false if not
 272 bool key_is_ascii(int keycode)
 273 {
 274         // bail on non-printable keycodes
 275         if (keycode & SDLK_SCANCODE_MASK) {
 276                 return false;
 277         }
 278
 279         keycode &= KEY_MASK;
 280
 281         // this is definitely never come back to bite me in the ass
 282         if ( ((keycode >= SDLK_SPACE) && (keycode <= SDLK_AT))
 283                         || ((keycode >= SDLK_LEFTBRACKET) && (keycode <= SDLK_z)) )
 284         {
 285                 return true;
 286         }
 287
 288         return false;
 289 }
 290
 291 //      Flush the keyboard buffer.
 292 //      Clear the keyboard array (keyd_pressed).
 293 void key_flush()
 294 {
 295         int i;
 296         uint CurTime;
 297
 298         if ( !key_inited ) return;
 299
 300         key_data.keyhead = key_data.keytail = 0;
 301
 302         //Clear the keyboard buffer
 303         for (i=0; i<KEY_BUFFER_SIZE; i++ )      {
 304                 key_data.keybuffer[i] = 0;
 305                 key_data.time_pressed[i] = 0;
 306         }
 307
 308         //Clear the keyboard array
 309
 310         CurTime = timer_get_milliseconds();
 311
 312
 313         for (i=0; i<SDL_NUM_SCANCODES; i++ )    {
 314                 keyd_pressed[i] = false;
 315                 key_data.TimeKeyDownChecked[i] = CurTime;
 316                 key_data.TimeKeyWentDown[i] = CurTime;
 317                 key_data.TimeKeyHeldDown[i] = 0;
 318                 key_data.NumDowns[i]=0;
 319                 key_data.NumUps[i]=0;
 320         }
 321
 322         key_text_input.clear();
 323 }
 324
 325 //      A nifty function which performs the function:
 326 //              n = (n+1) % KEY_BUFFER_SIZE
 327 //      (assuming positive values of n).
 328 int add_one( int n )
 329 {
 330         n++;
 331         if ( n >= KEY_BUFFER_SIZE ) n=0;
 332         return n;
 333 }
 334
 335 // Returns 1 if character waiting... 0 otherwise
 336 int key_checkch()
 337 {
 338         int is_one_waiting = 0;
 339
 340         if ( !key_inited ) return 0;
 341
 342         if (key_data.keytail != key_data.keyhead){
 343                 is_one_waiting = 1;
 344         }
 345
 346         return is_one_waiting;
 347 }
 348
 349 //      Return keycode if a key has been pressed,
 350 //      else return 0.
 351 //      Reads keys out of the key buffer and updates keyhead.
 352 int key_inkey()
 353 {
 354         SDL_Scancode scancode = SDL_SCANCODE_UNKNOWN;
 355         int mod, keycode;
 356
 357         if ( !key_inited )
 358                 return 0;
 359
 360         if (key_data.keytail != key_data.keyhead) {
 361                 scancode = (SDL_Scancode)key_data.keybuffer[key_data.keyhead];
 362                 key_data.keyhead = add_one(key_data.keyhead);
 363         } else {
 364                 return 0;
 365         }
 366
 367         // need to strip key mod state for keycode lookup
 368         mod = (scancode & 0xf900);
 369         keycode = SDL_GetKeyFromScancode((SDL_Scancode)(scancode & KEY_MASK));
 370
 371         return (keycode | mod);
 372 }
 373
 374 // If not installed, uses BIOS and returns getch();
 375 //      Else returns pending key (or waits for one if none waiting).
 376 int key_getch()
 377 {
 378         int dummy=0;
 379         int in;
 380
 381         if ( !key_inited ) return 0;
 382
 383         while (!key_checkch()){
 384                 os_poll();
 385
 386                 dummy++;
 387         }
 388         in = key_inkey();
 389
 390         return in;
 391 }
 392
 393 //      Set global shift_status with modifier results (shift, ctrl, alt).
 394 uint key_get_shift_status()
 395 {
 396         unsigned int shift_status = 0;
 397
 398         if ( !key_inited )
 399                 return 0;
 400
 401         SDL_Keymod kmod = SDL_GetModState();
 402
 403         if (kmod & KMOD_SHIFT)
 404                 shift_status |= KEY_SHIFTED;
 405
 406         if (kmod & KMOD_ALT)
 407                 shift_status |= KEY_ALTED;
 408
 409         if (kmod & KMOD_CTRL)
 410                 shift_status |= KEY_CTRLED;
 411
 412 #ifndef NDEBUG
 413         if (key_pressed(KEY_DEBUG_KEY))
 414                 shift_status |= KEY_DEBUGGED;
 415 #else
 416         if (key_pressed(KEY_DEBUG_KEY)) {
 417                 mprintf(("Cheats_enabled = %i, Key_normal_game = %i\n", Cheats_enabled, Key_normal_game));
 418                 if ((Cheats_enabled) && Key_normal_game) {
 419                         mprintf(("Debug key\n"));
 420                         shift_status |= KEY_DEBUGGED1;
 421                 }
 422         }
 423 #endif
 424
 425         return shift_status;
 426 }
 427
 428 //      Returns amount of time key (specified by "keycode") has been down since last call.
 429 //      Returns float, unlike key_down_time() which returns a fix.
 430 float key_down_timef(int keycode)
 431 {
 432         uint time_down, time;
 433         uint delta_time;
 434         SDL_Scancode scancode;
 435
 436         if ( !key_inited )
 437                 return 0.0f;
 438
 439         scancode = SDL_GetScancodeFromKey(keycode & KEY_MASK);
 440
 441         if (scancode == SDL_SCANCODE_UNKNOWN)
 442                 return 0.0f;
 443
 444         time = timer_get_milliseconds();
 445         delta_time = time - key_data.TimeKeyDownChecked[scancode];
 446         key_data.TimeKeyDownChecked[scancode] = time;
 447
 448         if ( delta_time <= 1 ) {
 449                 key_data.TimeKeyWentDown[scancode] = time;
 450                 if (keyd_pressed[scancode])     {
 451                         return 1.0f;
 452                 } else  {
 453                         return 0.0f;
 454                 }
 455         }
 456
 457         if ( !keyd_pressed[scancode] )  {
 458                 time_down = key_data.TimeKeyHeldDown[scancode];
 459                 key_data.TimeKeyHeldDown[scancode] = 0;
 460         } else  {
 461                 time_down =  time - key_data.TimeKeyWentDown[scancode];
 462                 key_data.TimeKeyWentDown[scancode] = time;
 463         }
 464
 465         return i2fl(time_down) / i2fl(delta_time);
 466 }
 467
 468 // Returns number of times key has went from up to down since last call.
 469 int key_down_count(int keycode)
 470 {
 471         int n;
 472         SDL_Scancode scancode;
 473
 474         if ( !key_inited )
 475                 return 0;
 476
 477         scancode = SDL_GetScancodeFromKey(keycode & KEY_MASK);
 478
 479         if (scancode == SDL_SCANCODE_UNKNOWN)
 480                 return 0;
 481
 482         n = key_data.NumDowns[scancode];
 483         key_data.NumDowns[scancode] = 0;
 484
 485         return n;
 486 }
 487
 488
 489 // Returns number of times key has went from down to up since last call.
 490 int key_up_count(int keycode)
 491 {
 492         int n;
 493         SDL_Scancode scancode;
 494
 495         if ( !key_inited )
 496                 return 0;
 497
 498         scancode = SDL_GetScancodeFromKey(keycode & KEY_MASK);
 499
 500         if (scancode == SDL_SCANCODE_UNKNOWN)
 501                 return 0;
 502
 503         n = key_data.NumUps[scancode];
 504         key_data.NumUps[scancode] = 0;
 505
 506         return n;
 507 }
 508
 509 int key_check(int keycode)
 510 {
 511         SDL_Scancode scancode = SDL_GetScancodeFromKey(keycode & KEY_MASK);
 512
 513         return key_data.down_check[scancode];
 514 }
 515
 516 //      Add a key up or down code to the key buffer.  state=1 -> down, state=0 -> up
 517 // latency => time difference in ms between when key was actually pressed and now
 518 //void key_mark( uint code, int state )
 519 void key_mark(SDL_Scancode scancode, int state, ushort kmod, uint latency )
 520 {
 521         uint breakbit, temp, event_time;
 522         ushort keycode;
 523
 524         if ( !key_inited ) return;
 525
 526         SDL_assert( scancode < SDL_NUM_SCANCODES );
 527
 528         // ignore GUI key, we use it for specials commands
 529         if ( (scancode == SDL_SCANCODE_LGUI) || (scancode == SDL_SCANCODE_RGUI) ) {
 530                 return;
 531         }
 532
 533         // for Mac keyboard, make F13 be printscreen
 534         if (scancode == SDL_SCANCODE_F13) {
 535                 scancode = SDL_SCANCODE_PRINTSCREEN;
 536         }
 537
 538         event_time = timer_get_milliseconds() - latency;
 539         // event_time = timeGetTime() - latency;
 540
 541         breakbit = !state;
 542
 543         if (breakbit)   {
 544                 // Key going up
 545                 keyd_last_released = scancode;
 546                 keyd_pressed[scancode] = false;
 547                 key_data.NumUps[scancode]++;
 548
 549                 if (event_time < key_data.TimeKeyWentDown[scancode])
 550                         key_data.TimeKeyHeldDown[scancode] = 0;
 551                 else
 552                         key_data.TimeKeyHeldDown[scancode] += event_time - key_data.TimeKeyWentDown[scancode];
 553         } else {
 554                 // Key going down
 555                 keyd_last_pressed = scancode;
 556                 keyd_time_when_last_pressed = event_time;
 557                 if (!keyd_pressed[scancode])    {
 558                         // First time down
 559                         key_data.TimeKeyWentDown[scancode] = event_time;
 560                         keyd_pressed[scancode] = true;
 561                         key_data.NumDowns[scancode]++;
 562                         key_data.down_check[scancode]++;
 563
 564 //                      mprintf(( "Scancode = %x\n", scancode ));
 565
 566 //                      if ( scancode == KEY_BREAK )
 567 //                              Int3();
 568                 }
 569
 570                 keycode = (unsigned short)scancode;
 571
 572                 if (kmod & KMOD_SHIFT)
 573                         keycode |= KEY_SHIFTED;
 574
 575                 if (kmod & KMOD_ALT)
 576                         keycode |= KEY_ALTED;
 577
 578                 if (kmod & KMOD_CTRL)
 579                         keycode |= KEY_CTRLED;
 580
 581 #ifndef NDEBUG
 582                 if ( key_pressed(KEY_DEBUG_KEY) )
 583                         keycode |= KEY_DEBUGGED;
 584
 585 //                      if ( keycode == (KEY_BACKSP + KEY_DEBUGGED) )   {
 586 //                              keycode = 0;
 587 //                              keyd_pressed[KEY_DEBUG_KEY] = 0;
 588 //                              keyd_pressed[KEY_BACKSP] = 0;
 589 //                              Int3();
 590 //                      }
 591 #else
 592                 if ( key_pressed(KEY_DEBUG_KEY) ) {
 593                         mprintf(("Cheats_enabled = %i, Key_normal_game = %i\n", Cheats_enabled, Key_normal_game));
 594                         if (Cheats_enabled && Key_normal_game) {
 595                                 keycode |= KEY_DEBUGGED1;
 596                         }
 597                 }
 598
 599 #endif
 600
 601                 if ( keycode )  {
 602                         temp = key_data.keytail+1;
 603                         if ( temp >= KEY_BUFFER_SIZE ) temp=0;
 604
 605                         if (temp!=key_data.keyhead)     {
 606                                 int i, accept_key = 1;
 607                                 // Num_filter_keys will only be non-zero when a key filter has
 608                                 // been explicity set up via key_set_filter()
 609                                 for ( i = 0; i < Num_filter_keys; i++ ) {
 610                                         accept_key = 0;
 611                                         if ( Key_filter[i] == keycode ) {
 612                                                 accept_key = 1;
 613                                                 break;
 614                                         }
 615                                 }
 616
 617                                 if ( accept_key ) {
 618                                         key_data.keybuffer[key_data.keytail] = keycode;
 619                                         key_data.time_pressed[key_data.keytail] = keyd_time_when_last_pressed;
 620                                         key_data.keytail = temp;
 621                                 }
 622                         }
 623                 }
 624         }
 625 }
 626
 627 void key_close()
 628 {
 629         if ( !key_inited )
 630                 return;
 631
 632         if ( Key_numlock_was_on ) {
 633                 key_turn_on_numlock();
 634                 Key_numlock_was_on = 0;
 635         }
 636
 637         key_inited = 0;
 638 }
 639
 640 void key_init()
 641 {
 642         // Initialize queue
 643         if (key_inited)
 644                 return;
 645
 646         key_inited = 1;
 647
 648         keyd_time_when_last_pressed = timer_get_milliseconds();
 649         keyd_buffer_type = 1;
 650
 651         // Clear the keyboard array
 652         key_flush();
 653
 654         // Clear key filter
 655         key_clear_filter();
 656
 657         atexit(key_close);
 658 }
 659
 660 void key_level_init()
 661 {
 662         int i;
 663
 664         for (i=0; i<SDL_NUM_SCANCODES; i++)
 665                 key_data.down_check[i] = 0;
 666 }
 667
 668 void key_lost_focus()
 669 {
 670         if ( !key_inited )
 671                 return;
 672
 673         key_flush();
 674 }
 675
 676 void key_got_focus()
 677 {
 678         if ( !key_inited )
 679                 return;
 680
 681         key_flush();
 682 }
 683
 684 // Restricts the keys that are accepted from the keyboard
 685 //
 686 //      filter_array    =>              array of keys to act as a filter
 687 //      num                             =>              number of keys in filter_array
 688 //
 689 void key_set_filter(int *filter_array, int num)
 690 {
 691         int i;
 692
 693         if ( num >= MAX_FILTER_KEYS ) {
 694                 Int3();
 695                 num = MAX_FILTER_KEYS;
 696         }
 697
 698         Num_filter_keys = num;
 699
 700         for ( i = 0; i < num; i++ ) {
 701                 Key_filter[i] = filter_array[i];
 702         }
 703 }
 704
 705 // Clear the key filter, so all keypresses are accepted from keyboard
 706 //
 707 void key_clear_filter()
 708 {
 709         int i;
 710
 711         Num_filter_keys = 0;
 712         for ( i = 0; i < MAX_FILTER_KEYS; i++ ) {
 713                 Key_filter[i] = -1;
 714         }
 715 }