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