src/engine/e_input.pas

   1 (* Copyright (C)  Doom 2D: Forever Developers
   2  *
   3  * This program is free software: you can redistribute it and/or modify
   4  * it under the terms of the GNU General Public License as published by
   5  * the Free Software Foundation, either version 3 of the License, or
   6  * (at your option) any later version.
   7  *
   8  * This program is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11  * GNU General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License
  14  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  15  *)
  16 {$INCLUDE ../shared/a_modes.inc}
  17 unit e_input;
  18
  19 interface
  20
  21 uses SysUtils, SDL2;
  22
  23 const
  24   e_MaxKbdKeys  = SDL_NUM_SCANCODES;
  25   e_MaxJoys     = 4;
  26   e_MaxJoyBtns  = 32;
  27   e_MaxJoyAxes  = 8;
  28   e_MaxJoyHats  = 8;
  29   e_MaxVirtKeys = 48;
  30
  31   e_MaxJoyKeys = e_MaxJoyBtns + e_MaxJoyAxes*2 + e_MaxJoyHats*4;
  32
  33   e_MaxInputKeys = e_MaxKbdKeys + e_MaxJoys*e_MaxJoyKeys + e_MaxVirtKeys - 1;
  34   // $$$..$$$ -  321 Keyboard buttons/keys
  35   // $$$..$$$ - 4*32 Joystick buttons
  36   // $$$..$$$ -  8*2 Joystick axes (- and +)
  37   // $$$..$$$ -  4*4 Joystick hats (L U R D)
  38   // $$$..$$$ -   48 Virtual buttons/keys
  39
  40   // these are apparently used in g_gui and g_game and elsewhere
  41   IK_INVALID = 0;
  42   IK_ESCAPE  = SDL_SCANCODE_ESCAPE;
  43   IK_RETURN  = SDL_SCANCODE_RETURN;
  44   IK_KPRETURN= SDL_SCANCODE_KP_ENTER;
  45   IK_ENTER   = SDL_SCANCODE_RETURN;
  46   IK_KPINSERT = SDL_SCANCODE_KP_0;
  47   IK_UP      = SDL_SCANCODE_UP;
  48   IK_KPUP    = SDL_SCANCODE_KP_8;
  49   IK_DOWN    = SDL_SCANCODE_DOWN;
  50   IK_KPDOWN  = SDL_SCANCODE_KP_2;
  51   IK_LEFT    = SDL_SCANCODE_LEFT;
  52   IK_KPLEFT  = SDL_SCANCODE_KP_4;
  53   IK_RIGHT   = SDL_SCANCODE_RIGHT;
  54   IK_KPRIGHT = SDL_SCANCODE_KP_6;
  55   IK_DELETE  = SDL_SCANCODE_DELETE;
  56   IK_HOME    = SDL_SCANCODE_HOME;
  57   IK_KPHOME  = SDL_SCANCODE_KP_7;
  58   IK_INSERT  = SDL_SCANCODE_INSERT;
  59   IK_SPACE   = SDL_SCANCODE_SPACE;
  60   IK_CONTROL = SDL_SCANCODE_LCTRL;
  61   IK_SHIFT   = SDL_SCANCODE_LSHIFT;
  62   IK_ALT     = SDL_SCANCODE_LALT;
  63   IK_TAB     = SDL_SCANCODE_TAB;
  64   IK_PAGEUP  = SDL_SCANCODE_PAGEUP;
  65   IK_KPPAGEUP= SDL_SCANCODE_KP_9;
  66   IK_PAGEDN  = SDL_SCANCODE_PAGEDOWN;
  67   IK_KPPAGEDN= SDL_SCANCODE_KP_3;
  68   IK_KP5     = SDL_SCANCODE_KP_5;
  69   IK_NUMLOCK = SDL_SCANCODE_NUMLOCKCLEAR;
  70   IK_KPDIVIDE= SDL_SCANCODE_KP_DIVIDE;
  71   IK_KPMULTIPLE= SDL_SCANCODE_KP_MULTIPLY;
  72   IK_KPMINUS = SDL_SCANCODE_KP_MINUS;
  73   IK_KPPLUS  = SDL_SCANCODE_KP_PLUS;
  74   IK_KPENTER = SDL_SCANCODE_KP_ENTER;
  75   IK_KPDOT   = SDL_SCANCODE_KP_PERIOD;
  76   IK_CAPSLOCK= SDL_SCANCODE_CAPSLOCK;
  77   IK_RSHIFT  = SDL_SCANCODE_RSHIFT;
  78   IK_CTRL    = SDL_SCANCODE_LCTRL;
  79   IK_RCTRL   = SDL_SCANCODE_RCTRL;
  80   IK_RALT    = SDL_SCANCODE_RALT;
  81   IK_WIN     = SDL_SCANCODE_LGUI;
  82   IK_RWIN    = SDL_SCANCODE_RGUI;
  83   IK_MENU    = SDL_SCANCODE_MENU;
  84   IK_PRINTSCR= SDL_SCANCODE_PRINTSCREEN;
  85   IK_SCROLLLOCK= SDL_SCANCODE_SCROLLLOCK;
  86   IK_LBRACKET= SDL_SCANCODE_LEFTBRACKET;
  87   IK_RBRACKET= SDL_SCANCODE_RIGHTBRACKET;
  88   IK_SEMICOLON= SDL_SCANCODE_SEMICOLON;
  89   IK_QUOTE   = SDL_SCANCODE_APOSTROPHE;
  90   IK_BACKSLASH= SDL_SCANCODE_BACKSLASH;
  91   IK_SLASH   = SDL_SCANCODE_SLASH;
  92   IK_COMMA   = SDL_SCANCODE_COMMA;
  93   IK_DOT     = SDL_SCANCODE_PERIOD;
  94   IK_EQUALS  = SDL_SCANCODE_EQUALS;
  95   IK_0      = SDL_SCANCODE_0;
  96   IK_1      = SDL_SCANCODE_1;
  97   IK_2      = SDL_SCANCODE_2;
  98   IK_3      = SDL_SCANCODE_3;
  99   IK_4      = SDL_SCANCODE_4;
 100   IK_5      = SDL_SCANCODE_5;
 101   IK_6      = SDL_SCANCODE_6;
 102   IK_7      = SDL_SCANCODE_7;
 103   IK_8      = SDL_SCANCODE_8;
 104   IK_9      = SDL_SCANCODE_9;
 105   IK_F1      = SDL_SCANCODE_F1;
 106   IK_F2      = SDL_SCANCODE_F2;
 107   IK_F3      = SDL_SCANCODE_F3;
 108   IK_F4      = SDL_SCANCODE_F4;
 109   IK_F5      = SDL_SCANCODE_F5;
 110   IK_F6      = SDL_SCANCODE_F6;
 111   IK_F7      = SDL_SCANCODE_F7;
 112   IK_F8      = SDL_SCANCODE_F8;
 113   IK_F9      = SDL_SCANCODE_F9;
 114   IK_F10     = SDL_SCANCODE_F10;
 115   IK_F11     = SDL_SCANCODE_F11;
 116   IK_F12     = SDL_SCANCODE_F12;
 117   IK_END     = SDL_SCANCODE_END;
 118   IK_KPEND   = SDL_SCANCODE_KP_1;
 119   IK_BACKSPACE = SDL_SCANCODE_BACKSPACE;
 120   IK_BACKQUOTE = SDL_SCANCODE_GRAVE;
 121   IK_GRAVE     = SDL_SCANCODE_GRAVE;
 122   IK_PAUSE   = SDL_SCANCODE_PAUSE;
 123   IK_Y       = SDL_SCANCODE_Y;
 124   IK_N       = SDL_SCANCODE_N;
 125   IK_W       = SDL_SCANCODE_W;
 126   IK_A       = SDL_SCANCODE_A;
 127   IK_S       = SDL_SCANCODE_S;
 128   IK_D       = SDL_SCANCODE_D;
 129   IK_Q       = SDL_SCANCODE_Q;
 130   IK_E       = SDL_SCANCODE_E;
 131   IK_H       = SDL_SCANCODE_H;
 132   IK_J       = SDL_SCANCODE_J;
 133   IK_T       = SDL_SCANCODE_T;
 134   IK_Z       = SDL_SCANCODE_Z;
 135   IK_MINUS   = SDL_SCANCODE_MINUS;
 136   // TODO: think of something better than this shit
 137   IK_LASTKEY = SDL_NUM_SCANCODES-1;
 138
 139   VK_FIRSTKEY = e_MaxKbdKeys + e_MaxJoys*e_MaxJoyKeys;
 140   VK_LEFT     = VK_FIRSTKEY + 0;
 141   VK_RIGHT    = VK_FIRSTKEY + 1;
 142   VK_UP       = VK_FIRSTKEY + 2;
 143   VK_DOWN     = VK_FIRSTKEY + 3;
 144   VK_FIRE     = VK_FIRSTKEY + 4;
 145   VK_OPEN     = VK_FIRSTKEY + 5;
 146   VK_JUMP     = VK_FIRSTKEY + 6;
 147   VK_CHAT     = VK_FIRSTKEY + 7;
 148   VK_ESCAPE   = VK_FIRSTKEY + 8;
 149   VK_0        = VK_FIRSTKEY + 9;
 150   VK_1        = VK_FIRSTKEY + 10;
 151   VK_2        = VK_FIRSTKEY + 11;
 152   VK_3        = VK_FIRSTKEY + 12;
 153   VK_4        = VK_FIRSTKEY + 13;
 154   VK_5        = VK_FIRSTKEY + 14;
 155   VK_6        = VK_FIRSTKEY + 15;
 156   VK_7        = VK_FIRSTKEY + 16;
 157   VK_8        = VK_FIRSTKEY + 17;
 158   VK_9        = VK_FIRSTKEY + 18;
 159   VK_A        = VK_FIRSTKEY + 19;
 160   VK_B        = VK_FIRSTKEY + 20;
 161   VK_C        = VK_FIRSTKEY + 21;
 162   VK_D        = VK_FIRSTKEY + 22;
 163   VK_E        = VK_FIRSTKEY + 23;
 164   VK_F        = VK_FIRSTKEY + 24;
 165   VK_CONSOLE  = VK_FIRSTKEY + 25;
 166   VK_STATUS   = VK_FIRSTKEY + 26;
 167   VK_TEAM     = VK_FIRSTKEY + 27;
 168   VK_PREV     = VK_FIRSTKEY + 28;
 169   VK_NEXT     = VK_FIRSTKEY + 29;
 170   VK_STRAFE   = VK_FIRSTKEY + 30;
 171   VK_LSTRAFE  = VK_FIRSTKEY + 31;
 172   VK_RSTRAFE  = VK_FIRSTKEY + 32;
 173   VK_PRINTSCR = VK_FIRSTKEY + 33;
 174   VK_SHOWKBD  = VK_FIRSTKEY + 34;
 175   VK_HIDEKBD  = VK_FIRSTKEY + 35;
 176   VK_LASTKEY  = e_MaxKbdKeys + e_MaxJoys*e_MaxJoyKeys + e_MaxVirtKeys - 1;
 177
 178   AX_MINUS  = 0;
 179   AX_PLUS   = 1;
 180   HAT_LEFT  = 0;
 181   HAT_UP    = 1;
 182   HAT_RIGHT = 2;
 183   HAT_DOWN  = 3;
 184
 185 function  e_InitInput: Boolean;
 186 procedure e_ReleaseInput;
 187 procedure e_UnpressAllKeys;
 188 procedure e_KeyUpDown (key: Integer; down: Boolean);
 189
 190 function  e_KeyPressed (key: Integer): Boolean;
 191 function  e_AnyKeyPressed: Boolean;
 192 function  e_GetFirstKeyPressed: Integer;
 193 function  e_HasJoysticks: Boolean;
 194
 195 function  e_JoyButtonToKey (id, btn: Integer): Integer;
 196 function  e_JoyAxisToKey (id, ax, dir: Integer): Integer;
 197 function  e_JoyHatToKey (id, hat, dir: Integer): Integer;
 198
 199 var
 200   e_JoystickAvailable: array [0..e_MaxJoys - 1] of Boolean;
 201   e_JoystickDeadzones: array [0..e_MaxJoys - 1] of Integer = (8192, 8192, 8192, 8192);
 202   e_KeyNames: array [0..e_MaxInputKeys] of String;
 203
 204 implementation
 205
 206 const
 207   KBRD_END = e_MaxKbdKeys;
 208   JOYK_BEG = KBRD_END;
 209   JOYK_END = JOYK_BEG + e_MaxJoyBtns*e_MaxJoys;
 210   JOYA_BEG = JOYK_END;
 211   JOYA_END = JOYA_BEG + e_MaxJoyAxes*2*e_MaxJoys;
 212   JOYH_BEG = JOYA_END;
 213   JOYH_END = JOYH_BEG + e_MaxJoyHats*4*e_MaxJoys;
 214   VIRT_BEG = JOYH_END;
 215   VIRT_END = VIRT_BEG + e_MaxVirtKeys;
 216
 217 var
 218   InputBuffer: array [0..e_MaxInputKeys - 1] of Boolean;
 219
 220 procedure e_UnpressAllKeys;
 221   var i: Integer;
 222 begin
 223   for i := 0 to High(InputBuffer) do
 224     InputBuffer[i] := False
 225 end;
 226
 227 procedure e_KeyUpDown (key: Integer; down: Boolean);
 228 begin
 229   ASSERT(key >= 0);
 230   ASSERT(key < e_MaxInputKeys);
 231   if key > 0 then
 232     InputBuffer[key] := down
 233 end;
 234
 235 procedure GenerateKeyNames;
 236   var i, j, k: Integer;
 237 begin
 238   // keyboard key names
 239   e_KeyNames[IK_0] := '0';
 240   e_KeyNames[IK_1] := '1';
 241   e_KeyNames[IK_2] := '2';
 242   e_KeyNames[IK_3] := '3';
 243   e_KeyNames[IK_4] := '4';
 244   e_KeyNames[IK_5] := '5';
 245   e_KeyNames[IK_6] := '6';
 246   e_KeyNames[IK_7] := '7';
 247   e_KeyNames[IK_8] := '8';
 248   e_KeyNames[IK_9] := '9';
 249
 250   for i := IK_A to IK_Z do
 251     e_KeyNames[i] := '' + chr(ord('a') + (i - IK_a));
 252
 253   e_KeyNames[IK_ESCAPE] := 'ESCAPE';
 254   e_KeyNames[IK_ENTER] := 'ENTER';
 255   e_KeyNames[IK_TAB] := 'TAB';
 256   e_KeyNames[IK_BACKSPACE] := 'BACKSPACE';
 257   e_KeyNames[IK_SPACE] := 'SPACE';
 258   e_KeyNames[IK_UP] := 'UP';
 259   e_KeyNames[IK_LEFT] := 'LEFT';
 260   e_KeyNames[IK_RIGHT] := 'RIGHT';
 261   e_KeyNames[IK_DOWN] := 'DOWN';
 262   e_KeyNames[IK_INSERT] := 'INSERT';
 263   e_KeyNames[IK_DELETE] := 'DELETE';
 264   e_KeyNames[IK_HOME] := 'HOME';
 265   e_KeyNames[IK_END] := 'END';
 266   e_KeyNames[IK_PAGEUP] := 'PGUP';
 267   e_KeyNames[IK_PAGEDN] := 'PGDOWN';
 268   e_KeyNames[IK_KPINSERT] := 'PAD0';
 269   e_KeyNames[IK_KPEND] := 'PAD1';
 270   e_KeyNames[IK_KPDOWN] := 'PAD2';
 271   e_KeyNames[IK_KPPAGEDN] := 'PAD3';
 272   e_KeyNames[IK_KPLEFT] := 'PAD4';
 273   e_KeyNames[IK_KP5] := 'PAD5';
 274   e_KeyNames[IK_KPRIGHT] := 'PAD6';
 275   e_KeyNames[IK_KPHOME] := 'PAD7';
 276   e_KeyNames[IK_KPUP] := 'PAD8';
 277   e_KeyNames[IK_KPPAGEUP] := 'PAD9';
 278   e_KeyNames[IK_NUMLOCK] := 'NUM';
 279   e_KeyNames[IK_KPDIVIDE] := 'PAD/';
 280   e_KeyNames[IK_KPMULTIPLE] := 'PAD*';
 281   e_KeyNames[IK_KPMINUS] := 'PAD-';
 282   e_KeyNames[IK_KPPLUS] := 'PAD+';
 283   e_KeyNames[IK_KPENTER] := 'PADENTER';
 284   e_KeyNames[IK_KPDOT] := 'PAD.';
 285   e_KeyNames[IK_CAPSLOCK] := 'CAPS';
 286   e_KeyNames[IK_BACKQUOTE] := 'BACKQUOTE';
 287   e_KeyNames[IK_F1] := 'F1';
 288   e_KeyNames[IK_F2] := 'F2';
 289   e_KeyNames[IK_F3] := 'F3';
 290   e_KeyNames[IK_F4] := 'F4';
 291   e_KeyNames[IK_F5] := 'F5';
 292   e_KeyNames[IK_F6] := 'F6';
 293   e_KeyNames[IK_F7] := 'F7';
 294   e_KeyNames[IK_F8] := 'F8';
 295   e_KeyNames[IK_F9] := 'F9';
 296   e_KeyNames[IK_F10] := 'F10';
 297   e_KeyNames[IK_F11] := 'F11';
 298   e_KeyNames[IK_F12] := 'F12';
 299   e_KeyNames[IK_SHIFT] := 'LSHIFT';
 300   e_KeyNames[IK_RSHIFT] := 'RSHIFT';
 301   e_KeyNames[IK_CTRL] := 'LCTRL';
 302   e_KeyNames[IK_RCTRL] := 'RCTRL';
 303   e_KeyNames[IK_ALT] := 'LALT';
 304   e_KeyNames[IK_RALT] := 'RALT';
 305   e_KeyNames[IK_WIN] := 'LWIN';
 306   e_KeyNames[IK_RWIN] := 'RWIN';
 307   e_KeyNames[IK_MENU] := 'MENU';
 308   e_KeyNames[IK_PRINTSCR] := 'PSCRN';
 309   e_KeyNames[IK_SCROLLLOCK] := 'SCROLL';
 310   e_KeyNames[IK_PAUSE] := 'PAUSE';
 311   e_KeyNames[IK_LBRACKET] := '[';
 312   e_KeyNames[IK_RBRACKET] := ']';
 313   e_KeyNames[IK_SEMICOLON] := ';';
 314   e_KeyNames[IK_QUOTE] := '''';
 315   e_KeyNames[IK_BACKSLASH] := '\';
 316   e_KeyNames[IK_SLASH] := '/';
 317   e_KeyNames[IK_COMMA] := ',';
 318   e_KeyNames[IK_DOT] := '.';
 319   e_KeyNames[IK_MINUS] := '-';
 320   e_KeyNames[IK_EQUALS] := '=';
 321
 322   // joysticks
 323   for j := 0 to e_MaxJoys-1 do
 324   begin
 325     k := JOYK_BEG + j * e_MaxJoyBtns;
 326     // buttons
 327     for i := 0 to e_MaxJoyBtns-1 do
 328       e_KeyNames[k + i] := Format('JOY%dB%d', [j, i]);
 329     k := JOYA_BEG + j * e_MaxJoyAxes * 2;
 330     // axes
 331     for i := 0 to e_MaxJoyAxes-1 do
 332     begin
 333       e_KeyNames[k + i*2    ] := Format('JOY%dA%d+', [j, i]);
 334       e_KeyNames[k + i*2 + 1] := Format('JOY%dA%d-', [j, i]);
 335     end;
 336     k := JOYH_BEG + j * e_MaxJoyHats * 4;
 337     // hats
 338     for i := 0 to e_MaxJoyHats-1 do
 339     begin
 340       e_KeyNames[k + i*4    ] := Format('JOY%dD%dL', [j, i]);
 341       e_KeyNames[k + i*4 + 1] := Format('JOY%dD%dU', [j, i]);
 342       e_KeyNames[k + i*4 + 2] := Format('JOY%dD%dR', [j, i]);
 343       e_KeyNames[k + i*4 + 3] := Format('JOY%dD%dD', [j, i]);
 344     end;
 345   end;
 346
 347   // vitrual keys
 348   for i := 0 to e_MaxVirtKeys-1 do
 349     e_KeyNames[VIRT_BEG + i] := 'VIRTUAL' + IntToStr(i);
 350 end;
 351
 352 function e_HasJoysticks: Boolean;
 353   var i: Integer;
 354 begin
 355   i := 0;
 356   while (i < e_MaxJoys) and (e_JoystickAvailable[i] = False) do inc(i);
 357   result := i < e_MaxJoys
 358 end;
 359
 360 function e_InitInput: Boolean;
 361   var i: Integer;
 362 begin
 363   for i := 0 to e_MaxJoys - 1 do
 364     e_JoystickAvailable[i] := False;
 365   GenerateKeyNames;
 366   result := True
 367 end;
 368
 369 procedure e_ReleaseInput;
 370   var i: Integer;
 371 begin
 372   for i := 0 to e_MaxJoys - 1 do
 373     e_JoystickAvailable[i] := False
 374 end;
 375
 376 function e_KeyPressed (key: Integer): Boolean;
 377 begin
 378   ASSERT(key >= 0);
 379   ASSERT(key < e_MaxInputKeys);
 380   result := InputBuffer[key]
 381 end;
 382
 383 function e_AnyKeyPressed: Boolean;
 384 begin
 385   result := e_GetFirstKeyPressed <> IK_INVALID;
 386 end;
 387
 388 function e_GetFirstKeyPressed: Integer;
 389   var i: Integer;
 390 begin
 391   i := 1;
 392   while (i < e_MaxInputKeys) and (InputBuffer[i] = False) do inc(i);
 393   if i < e_MaxInputKeys then
 394     result := i
 395   else
 396     result := IK_INVALID
 397 end;
 398
 399 function e_JoyButtonToKey (id, btn: Integer): Integer;
 400 begin
 401   ASSERT(id >= 0);
 402   ASSERT(id < e_MaxJoys);
 403   ASSERT(btn >= 0);
 404   ASSERT(btn < e_MaxJoyBtns);
 405   result := JOYK_BEG + id*e_MaxJoyBtns + btn
 406 end;
 407
 408 function e_JoyAxisToKey (id, ax, dir: Integer): Integer;
 409 begin
 410   ASSERT(id >= 0);
 411   ASSERT(id < e_MaxJoys);
 412   ASSERT(ax >= 0);
 413   ASSERT(ax < e_MaxJoyAxes);
 414   ASSERT(dir in [AX_MINUS, AX_PLUS]);
 415   result := JOYA_BEG + id*e_MaxJoyAxes*2 + ax*2 + dir
 416 end;
 417
 418 function e_JoyHatToKey (id, hat, dir: Integer): Integer;
 419 begin
 420   ASSERT(id >= 0);
 421   ASSERT(id < e_MaxJoys);
 422   ASSERT(hat >= 0);
 423   ASSERT(hat < e_MaxJoyHats);
 424   ASSERT(dir in [HAT_LEFT, HAT_UP, HAT_RIGHT, HAT_DOWN]);
 425   result := JOYH_BEG + id*e_MaxJoyHats*4 + hat*4 + dir
 426 end;
 427
 428 end.