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 "pstypes.h"
 169 #include "key.h"
 170 #include "fix.h"
 171 #include "timer.h"
 172 #include "osapi.h"
 173 #include "localize.h"
 174
 175 #define KEY_BUFFER_SIZE 16
 176
 177 //-------- Variable accessed by outside functions ---------
 178 ubyte                           keyd_buffer_type;               // 0=No buffer, 1=buffer ASCII, 2=buffer scans
 179 ubyte                           keyd_repeat;
 180 uint                            keyd_last_pressed;
 181 uint                            keyd_last_released;
 182 int                             keyd_time_when_last_pressed;
 183
 184 static bool             keyd_pressed[SDL_NUM_SCANCODES];
 185
 186 typedef struct keyboard {
 187         ushort                  keybuffer[KEY_BUFFER_SIZE];
 188         uint                            time_pressed[KEY_BUFFER_SIZE];
 189         uint                            TimeKeyWentDown[SDL_NUM_SCANCODES];
 190         uint                            TimeKeyHeldDown[SDL_NUM_SCANCODES];
 191         uint                            TimeKeyDownChecked[SDL_NUM_SCANCODES];
 192         uint                            NumDowns[SDL_NUM_SCANCODES];
 193         uint                            NumUps[SDL_NUM_SCANCODES];
 194         int                             down_check[SDL_NUM_SCANCODES];  // nonzero if has been pressed yet this mission
 195         uint                            keyhead, keytail;
 196 } keyboard;
 197
 198 keyboard key_data;
 199
 200 int key_inited = 0;
 201
 202 CRITICAL_SECTION key_lock;
 203
 204 //int Backspace_debug=1;        // global flag that will enable/disable the backspace key from stopping execution
 205                                                                 // This flag was created since the backspace key is also used to correct mistakes
 206                                                                 // when typing in your pilots callsign.  This global flag is checked before execution
 207                                                                 // is stopped.
 208
 209 // used to limit the keypresses that are accepted from the keyboard
 210 #define MAX_FILTER_KEYS 64
 211 int Num_filter_keys;
 212 int Key_filter[MAX_FILTER_KEYS];
 213
 214 static int Key_numlock_was_on = 0;      // Flag to indicate whether NumLock is on at start
 215
 216 int Cheats_enabled = 0;
 217 int Key_normal_game = 0;
 218
 219
 220 bool key_pressed(int keycode)
 221 {
 222         SDL_Scancode scancode = SDL_GetScancodeFromKey(keycode & KEY_MASK);
 223
 224         return keyd_pressed[scancode];
 225 }
 226
 227 int key_numlock_is_on()
 228 {
 229         const Uint8 *state;
 230         state = SDL_GetKeyboardState(NULL);
 231         if ( state[SDL_SCANCODE_NUMLOCKCLEAR] ) {
 232                 return 1;
 233         }
 234
 235         return 0;
 236 }
 237
 238 void key_turn_off_numlock()
 239 {
 240 }
 241
 242 void key_turn_on_numlock()
 243 {
 244 }
 245
 246 //      Convert a BIOS scancode to ASCII.
 247 //      If scancode >= 127, returns 255, meaning there is no corresponding ASCII code.
 248 //      Uses ascii_table and shifted_ascii_table to translate scancode to ASCII.
 249 int key_to_ascii(int keycode, bool force_up)
 250 {
 251         int shifted;
 252
 253         // bail on non-printable keycodes
 254         if (keycode & SDLK_SCANCODE_MASK) {
 255                 return 255;
 256         }
 257
 258         shifted = keycode & KEY_SHIFTED;
 259         keycode &= KEY_MASK;
 260
 261         // this is definitely never come back to bite me in the ass
 262         if ( ((keycode >= SDLK_SPACE) && (keycode <= SDLK_AT))
 263                         || ((keycode >= SDLK_LEFTBRACKET) && (keycode <= SDLK_z)) )
 264         {
 265                 if ( (keycode >= SDLK_a) && (shifted || force_up) ) {
 266                         return toupper(keycode);
 267                 } else {
 268                         return keycode;
 269                 }
 270         }
 271
 272         return 255;
 273 }
 274
 275 //      Flush the keyboard buffer.
 276 //      Clear the keyboard array (keyd_pressed).
 277 void key_flush()
 278 {
 279         int i;
 280         uint CurTime;
 281
 282         if ( !key_inited ) return;
 283
 284         ENTER_CRITICAL_SECTION(&key_lock);
 285
 286         key_data.keyhead = key_data.keytail = 0;
 287
 288         //Clear the keyboard buffer
 289         for (i=0; i<KEY_BUFFER_SIZE; i++ )      {
 290                 key_data.keybuffer[i] = 0;
 291                 key_data.time_pressed[i] = 0;
 292         }
 293
 294         //Clear the keyboard array
 295
 296         CurTime = timer_get_milliseconds();
 297
 298
 299         for (i=0; i<SDL_NUM_SCANCODES; i++ )    {
 300                 keyd_pressed[i] = false;
 301                 key_data.TimeKeyDownChecked[i] = CurTime;
 302                 key_data.TimeKeyWentDown[i] = CurTime;
 303                 key_data.TimeKeyHeldDown[i] = 0;
 304                 key_data.NumDowns[i]=0;
 305                 key_data.NumUps[i]=0;
 306         }
 307
 308         LEAVE_CRITICAL_SECTION(&key_lock);
 309 }
 310
 311 //      A nifty function which performs the function:
 312 //              n = (n+1) % KEY_BUFFER_SIZE
 313 //      (assuming positive values of n).
 314 int add_one( int n )
 315 {
 316         n++;
 317         if ( n >= KEY_BUFFER_SIZE ) n=0;
 318         return n;
 319 }
 320
 321 // Returns 1 if character waiting... 0 otherwise
 322 int key_checkch()
 323 {
 324         int is_one_waiting = 0;
 325
 326         if ( !key_inited ) return 0;
 327
 328         ENTER_CRITICAL_SECTION(&key_lock);
 329
 330         if (key_data.keytail != key_data.keyhead){
 331                 is_one_waiting = 1;
 332         }
 333
 334         LEAVE_CRITICAL_SECTION(&key_lock);
 335
 336         return is_one_waiting;
 337 }
 338
 339 //      Return keycode if a key has been pressed,
 340 //      else return 0.
 341 //      Reads keys out of the key buffer and updates keyhead.
 342 int key_inkey()
 343 {
 344         SDL_Scancode scancode = SDL_SCANCODE_UNKNOWN;
 345         int mod, keycode;
 346
 347         if ( !key_inited )
 348                 return 0;
 349
 350         if (key_data.keytail != key_data.keyhead) {
 351                 scancode = (SDL_Scancode)key_data.keybuffer[key_data.keyhead];
 352                 key_data.keyhead = add_one(key_data.keyhead);
 353         } else {
 354                 return 0;
 355         }
 356
 357         // need to strip key mod state for keycode lookup
 358         mod = (scancode & 0xf900);
 359         keycode = SDL_GetKeyFromScancode((SDL_Scancode)(scancode & KEY_MASK));
 360
 361         return (keycode | mod);
 362 }
 363
 364 // If not installed, uses BIOS and returns getch();
 365 //      Else returns pending key (or waits for one if none waiting).
 366 int key_getch()
 367 {
 368         int dummy=0;
 369         int in;
 370
 371         if ( !key_inited ) return 0;
 372
 373         while (!key_checkch()){
 374                 os_poll();
 375
 376                 dummy++;
 377         }
 378         in = key_inkey();
 379
 380         return in;
 381 }
 382
 383 //      Set global shift_status with modifier results (shift, ctrl, alt).
 384 uint key_get_shift_status()
 385 {
 386         unsigned int shift_status = 0;
 387
 388         if ( !key_inited )
 389                 return 0;
 390
 391         SDL_Keymod kmod = SDL_GetModState();
 392
 393         if (kmod & KMOD_SHIFT)
 394                 shift_status |= KEY_SHIFTED;
 395
 396         if (kmod & KMOD_ALT)
 397                 shift_status |= KEY_ALTED;
 398
 399         if (kmod & KMOD_CTRL)
 400                 shift_status |= KEY_CTRLED;
 401
 402 #ifndef NDEBUG
 403         if (key_pressed(KEY_DEBUG_KEY))
 404                 shift_status |= KEY_DEBUGGED;
 405 #else
 406         if (key_pressed(KEY_DEBUG_KEY)) {
 407                 mprintf(("Cheats_enabled = %i, Key_normal_game = %i\n", Cheats_enabled, Key_normal_game));
 408                 if ((Cheats_enabled) && Key_normal_game) {
 409                         mprintf(("Debug key\n"));
 410                         shift_status |= KEY_DEBUGGED1;
 411                 }
 412         }
 413 #endif
 414
 415         return shift_status;
 416 }
 417
 418 //      Returns amount of time key (specified by "keycode") has been down since last call.
 419 //      Returns float, unlike key_down_time() which returns a fix.
 420 float key_down_timef(int keycode)
 421 {
 422         uint time_down, time;
 423         uint delta_time;
 424         SDL_Scancode scancode;
 425
 426         if ( !key_inited )
 427                 return 0.0f;
 428
 429         scancode = SDL_GetScancodeFromKey(keycode & KEY_MASK);
 430
 431         if (scancode == SDL_SCANCODE_UNKNOWN)
 432                 return 0.0f;
 433
 434         ENTER_CRITICAL_SECTION(&key_lock);
 435
 436         time = timer_get_milliseconds();
 437         delta_time = time - key_data.TimeKeyDownChecked[scancode];
 438         key_data.TimeKeyDownChecked[scancode] = time;
 439
 440         if ( delta_time <= 1 ) {
 441                 key_data.TimeKeyWentDown[scancode] = time;
 442                 if (keyd_pressed[scancode])     {
 443                         LEAVE_CRITICAL_SECTION(&key_lock);
 444                         return 1.0f;
 445                 } else  {
 446                         LEAVE_CRITICAL_SECTION(&key_lock);
 447                         return 0.0f;
 448                 }
 449         }
 450
 451         if ( !keyd_pressed[scancode] )  {
 452                 time_down = key_data.TimeKeyHeldDown[scancode];
 453                 key_data.TimeKeyHeldDown[scancode] = 0;
 454         } else  {
 455                 time_down =  time - key_data.TimeKeyWentDown[scancode];
 456                 key_data.TimeKeyWentDown[scancode] = time;
 457         }
 458
 459         LEAVE_CRITICAL_SECTION(&key_lock);
 460
 461         return i2fl(time_down) / i2fl(delta_time);
 462 }
 463
 464 // Returns number of times key has went from up to down since last call.
 465 int key_down_count(int keycode)
 466 {
 467         int n;
 468         SDL_Scancode scancode;
 469
 470         if ( !key_inited )
 471                 return 0;
 472
 473         scancode = SDL_GetScancodeFromKey(keycode & KEY_MASK);
 474
 475         if (scancode == SDL_SCANCODE_UNKNOWN)
 476                 return 0;
 477
 478         ENTER_CRITICAL_SECTION(&key_lock);
 479
 480         n = key_data.NumDowns[scancode];
 481         key_data.NumDowns[scancode] = 0;
 482
 483         LEAVE_CRITICAL_SECTION(&key_lock);
 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         ENTER_CRITICAL_SECTION(&key_lock);
 504
 505         n = key_data.NumUps[scancode];
 506         key_data.NumUps[scancode] = 0;
 507
 508         LEAVE_CRITICAL_SECTION(&key_lock);
 509
 510         return n;
 511 }
 512
 513 int key_check(int keycode)
 514 {
 515         SDL_Scancode scancode = SDL_GetScancodeFromKey(keycode & KEY_MASK);
 516
 517         return key_data.down_check[scancode];
 518 }
 519
 520 //      Add a key up or down code to the key buffer.  state=1 -> down, state=0 -> up
 521 // latency => time difference in ms between when key was actually pressed and now
 522 //void key_mark( uint code, int state )
 523 void key_mark(SDL_Scancode scancode, int state, ushort kmod, uint latency )
 524 {
 525         uint breakbit, temp, event_time;
 526         ushort keycode;
 527
 528         if ( !key_inited ) return;
 529
 530         ENTER_CRITICAL_SECTION(&key_lock);
 531
 532         Assert( scancode < SDL_NUM_SCANCODES );
 533
 534         event_time = timer_get_milliseconds() - latency;
 535         // event_time = timeGetTime() - latency;
 536
 537         breakbit = !state;
 538
 539         if (breakbit)   {
 540                 // Key going up
 541                 keyd_last_released = scancode;
 542                 keyd_pressed[scancode] = false;
 543                 key_data.NumUps[scancode]++;
 544
 545                 if (event_time < key_data.TimeKeyWentDown[scancode])
 546                         key_data.TimeKeyHeldDown[scancode] = 0;
 547                 else
 548                         key_data.TimeKeyHeldDown[scancode] += event_time - key_data.TimeKeyWentDown[scancode];
 549         } else {
 550                 // Key going down
 551                 keyd_last_pressed = scancode;
 552                 keyd_time_when_last_pressed = event_time;
 553                 if (!keyd_pressed[scancode])    {
 554                         // First time down
 555                         key_data.TimeKeyWentDown[scancode] = event_time;
 556                         keyd_pressed[scancode] = true;
 557                         key_data.NumDowns[scancode]++;
 558                         key_data.down_check[scancode]++;
 559
 560 //                      mprintf(( "Scancode = %x\n", scancode ));
 561
 562 //                      if ( scancode == KEY_BREAK )
 563 //                              Int3();
 564                 }
 565
 566                 keycode = (unsigned short)scancode;
 567
 568                 if (kmod & KMOD_SHIFT)
 569                         keycode |= KEY_SHIFTED;
 570
 571                 if (kmod & KMOD_ALT)
 572                         keycode |= KEY_ALTED;
 573
 574                 if (kmod & KMOD_CTRL)
 575                         keycode |= KEY_CTRLED;
 576
 577 #ifndef NDEBUG
 578                 if ( key_pressed(KEY_DEBUG_KEY) )
 579                         keycode |= KEY_DEBUGGED;
 580
 581 //                      if ( keycode == (KEY_BACKSP + KEY_DEBUGGED) )   {
 582 //                              keycode = 0;
 583 //                              keyd_pressed[KEY_DEBUG_KEY] = 0;
 584 //                              keyd_pressed[KEY_BACKSP] = 0;
 585 //                              Int3();
 586 //                      }
 587 #else
 588                 if ( keyd_pressed(KEY_DEBUG_KEY) ) {
 589                         mprintf(("Cheats_enabled = %i, Key_normal_game = %i\n", Cheats_enabled, Key_normal_game));
 590                         if (Cheats_enabled && Key_normal_game) {
 591                                 keycode |= KEY_DEBUGGED1;
 592                         }
 593                 }
 594
 595 #endif
 596
 597                 if ( keycode )  {
 598                         temp = key_data.keytail+1;
 599                         if ( temp >= KEY_BUFFER_SIZE ) temp=0;
 600
 601                         if (temp!=key_data.keyhead)     {
 602                                 int i, accept_key = 1;
 603                                 // Num_filter_keys will only be non-zero when a key filter has
 604                                 // been explicity set up via key_set_filter()
 605                                 for ( i = 0; i < Num_filter_keys; i++ ) {
 606                                         accept_key = 0;
 607                                         if ( Key_filter[i] == keycode ) {
 608                                                 accept_key = 1;
 609                                                 break;
 610                                         }
 611                                 }
 612
 613                                 if ( accept_key ) {
 614                                         key_data.keybuffer[key_data.keytail] = keycode;
 615                                         key_data.time_pressed[key_data.keytail] = keyd_time_when_last_pressed;
 616                                         key_data.keytail = temp;
 617                                 }
 618                         }
 619                 }
 620         }
 621
 622         LEAVE_CRITICAL_SECTION(&key_lock);
 623 }
 624
 625 void key_close()
 626 {
 627         if ( !key_inited )
 628                 return;
 629
 630         if ( Key_numlock_was_on ) {
 631                 key_turn_on_numlock();
 632                 Key_numlock_was_on = 0;
 633         }
 634
 635         key_inited = 0;
 636 }
 637
 638 void key_init()
 639 {
 640         // Initialize queue
 641         if (key_inited)
 642                 return;
 643
 644         key_inited = 1;
 645
 646         keyd_time_when_last_pressed = timer_get_milliseconds();
 647         keyd_buffer_type = 1;
 648
 649         // Clear the keyboard array
 650         key_flush();
 651
 652         // Clear key filter
 653         key_clear_filter();
 654
 655         atexit(key_close);
 656 }
 657
 658 void key_level_init()
 659 {
 660         int i;
 661
 662         for (i=0; i<SDL_NUM_SCANCODES; i++)
 663                 key_data.down_check[i] = 0;
 664 }
 665
 666 void key_lost_focus()
 667 {
 668         if ( !key_inited )
 669                 return;
 670
 671         key_flush();
 672 }
 673
 674 void key_got_focus()
 675 {
 676         if ( !key_inited )
 677                 return;
 678
 679         key_flush();
 680 }
 681
 682 // Restricts the keys that are accepted from the keyboard
 683 //
 684 //      filter_array    =>              array of keys to act as a filter
 685 //      num                             =>              number of keys in filter_array
 686 //
 687 void key_set_filter(int *filter_array, int num)
 688 {
 689         int i;
 690
 691         if ( num >= MAX_FILTER_KEYS ) {
 692                 Int3();
 693                 num = MAX_FILTER_KEYS;
 694         }
 695
 696         Num_filter_keys = num;
 697
 698         for ( i = 0; i < num; i++ ) {
 699                 Key_filter[i] = filter_array[i];
 700         }
 701 }
 702
 703 // Clear the key filter, so all keypresses are accepted from keyboard
 704 //
 705 void key_clear_filter()
 706 {
 707         int i;
 708
 709         Num_filter_keys = 0;
 710         for ( i = 0; i < MAX_FILTER_KEYS; i++ ) {
 711                 Key_filter[i] = -1;
 712         }
 713 }