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