DEADSOFTWARE

GIT / REPO / FRED-BOY
Projects / d2df-sdl.git / blob
summary | shortlog | log | commit | commitdiff | tree
history | raw | HEAD
Reserved key range for virtual keyboard + alternative virtkbd layout
[d2df-sdl.git] / 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
22 SysUtils,
23 e_log,
24 SDL2;
25
26 const
27 e_MaxKbdKeys = SDL_NUM_SCANCODES;
28 e_MaxJoys = 4;
29 e_MaxJoyBtns = 32;
30 e_MaxJoyAxes = 8;
31 e_MaxJoyHats = 8;
32 e_MaxVirtKeys = 32;
33
34 e_MaxJoyKeys = e_MaxJoyBtns + e_MaxJoyAxes*2 + e_MaxJoyHats*4;
35
36 e_MaxInputKeys = e_MaxKbdKeys + e_MaxJoys*e_MaxJoyKeys + e_MaxVirtKeys - 1;
37 // $$$..$$$ - 321 Keyboard buttons/keys
38 // $$$..$$$ - 4*32 Joystick buttons
39 // $$$..$$$ - 8*2 Joystick axes (- and +)
40 // $$$..$$$ - 4*4 Joystick hats (L U R D)
41 // $$$..$$$ - 32 Virtual buttons/keys
42
43 // these are apparently used in g_gui and g_game and elsewhere
44 IK_INVALID = 65535;
45 IK_ESCAPE = SDL_SCANCODE_ESCAPE;
46 IK_RETURN = SDL_SCANCODE_RETURN;
47 IK_KPRETURN= SDL_SCANCODE_KP_ENTER;
48 IK_ENTER = SDL_SCANCODE_RETURN;
49 IK_UP = SDL_SCANCODE_UP;
50 IK_KPUP = SDL_SCANCODE_KP_8;
51 IK_DOWN = SDL_SCANCODE_DOWN;
52 IK_KPDOWN = SDL_SCANCODE_KP_2;
53 IK_LEFT = SDL_SCANCODE_LEFT;
54 IK_KPLEFT = SDL_SCANCODE_KP_4;
55 IK_RIGHT = SDL_SCANCODE_RIGHT;
56 IK_KPRIGHT = SDL_SCANCODE_KP_6;
57 IK_DELETE = SDL_SCANCODE_DELETE;
58 IK_HOME = SDL_SCANCODE_HOME;
59 IK_KPHOME = SDL_SCANCODE_KP_7;
60 IK_INSERT = SDL_SCANCODE_INSERT;
61 IK_SPACE = SDL_SCANCODE_SPACE;
62 IK_CONTROL = SDL_SCANCODE_LCTRL;
63 IK_SHIFT = SDL_SCANCODE_LSHIFT;
64 IK_TAB = SDL_SCANCODE_TAB;
65 IK_PAGEUP = SDL_SCANCODE_PAGEUP;
66 IK_KPPAGEUP= SDL_SCANCODE_KP_9;
67 IK_PAGEDN = SDL_SCANCODE_PAGEDOWN;
68 IK_KPPAGEDN= SDL_SCANCODE_KP_3;
69 IK_F2 = SDL_SCANCODE_F2;
70 IK_F3 = SDL_SCANCODE_F3;
71 IK_F4 = SDL_SCANCODE_F4;
72 IK_F5 = SDL_SCANCODE_F5;
73 IK_F6 = SDL_SCANCODE_F6;
74 IK_F7 = SDL_SCANCODE_F7;
75 IK_F8 = SDL_SCANCODE_F8;
76 IK_F9 = SDL_SCANCODE_F9;
77 IK_F10 = SDL_SCANCODE_F10;
78 IK_END = SDL_SCANCODE_END;
79 IK_KPEND = SDL_SCANCODE_KP_1;
80 IK_BACKSPACE = SDL_SCANCODE_BACKSPACE;
81 IK_BACKQUOTE = SDL_SCANCODE_GRAVE;
82 IK_GRAVE = SDL_SCANCODE_GRAVE;
83 IK_PAUSE = SDL_SCANCODE_PAUSE;
84 IK_Y = SDL_SCANCODE_Y;
85 IK_N = SDL_SCANCODE_N;
86 // TODO: think of something better than this shit
87 IK_LASTKEY = SDL_NUM_SCANCODES-1;
88
89 VK_FIRSTKEY = e_MaxKbdKeys + e_MaxJoys*e_MaxJoyKeys;
90 VK_LEFT = VK_FIRSTKEY + 0;
91 VK_RIGHT = VK_FIRSTKEY + 1;
92 VK_UP = VK_FIRSTKEY + 2;
93 VK_DOWN = VK_FIRSTKEY + 3;
94 VK_FIRE = VK_FIRSTKEY + 4;
95 VK_OPEN = VK_FIRSTKEY + 5;
96 VK_JUMP = VK_FIRSTKEY + 6;
97 VK_CHAT = VK_FIRSTKEY + 7;
98 VK_ESCAPE = VK_FIRSTKEY + 8;
99 VK_0 = VK_FIRSTKEY + 9;
100 VK_1 = VK_FIRSTKEY + 10;
101 VK_2 = VK_FIRSTKEY + 11;
102 VK_3 = VK_FIRSTKEY + 12;
103 VK_4 = VK_FIRSTKEY + 13;
104 VK_5 = VK_FIRSTKEY + 14;
105 VK_6 = VK_FIRSTKEY + 15;
106 VK_7 = VK_FIRSTKEY + 16;
107 VK_8 = VK_FIRSTKEY + 17;
108 VK_9 = VK_FIRSTKEY + 18;
109 VK_A = VK_FIRSTKEY + 19;
110 VK_B = VK_FIRSTKEY + 20;
111 VK_C = VK_FIRSTKEY + 21;
112 VK_D = VK_FIRSTKEY + 22;
113 VK_E = VK_FIRSTKEY + 23;
114 VK_F = VK_FIRSTKEY + 24;
115 VK_CONSOLE = VK_FIRSTKEY + 25;
116 VK_STATUS = VK_FIRSTKEY + 26;
117 VK_TEAM = VK_FIRSTKEY + 27;
118 VK_PREV = VK_FIRSTKEY + 28;
119 VK_NEXT = VK_FIRSTKEY + 29;
120 VK_STRAFE = VK_FIRSTKEY + 30;
121 VK_LASTKEY = e_MaxKbdKeys + e_MaxJoys*e_MaxJoyKeys + e_MaxVirtKeys - 1;
122
123 AX_MINUS = 0;
124 AX_PLUS = 1;
125 HAT_LEFT = 0;
126 HAT_UP = 1;
127 HAT_RIGHT = 2;
128 HAT_DOWN = 3;
129
130 function e_InitInput(): Boolean;
131 procedure e_ReleaseInput();
132 procedure e_ClearInputBuffer();
133 //function e_PollInput(): Boolean;
134 procedure e_PollJoysticks(); // call this from message loop to update joysticks
135 function e_KeyPressed(Key: Word): Boolean;
136 function e_AnyKeyPressed(): Boolean;
137 function e_GetFirstKeyPressed(): Word;
138 function e_JoystickStateToString(mode: Integer): String;
139 function e_JoyByHandle(handle: Word): Integer;
140 function e_JoyButtonToKey(id: Word; btn: Byte): Word;
141 function e_JoyAxisToKey(id: Word; ax: Byte; dir: Byte): Word;
142 function e_JoyHatToKey(id: Word; hat: Byte; dir: Byte): Word;
143 procedure e_SetKeyState(key: Word; state: Integer);
144
145 procedure e_UnpressAllKeys ();
146 procedure e_KeyUpDown (key: Word; down: Boolean);
147
148 var
149 {e_MouseInfo: TMouseInfo;}
150 e_EnableInput: Boolean = False;
151 e_JoysticksAvailable: Byte = 0;
152 e_JoystickDeadzones: array [0..e_MaxJoys-1] of Integer = (8192, 8192, 8192, 8192);
153 e_KeyNames: array [0..e_MaxInputKeys] of String;
154
155 implementation
156
157 uses Math;
158
159 const
160 KBRD_END = e_MaxKbdKeys;
161 JOYK_BEG = KBRD_END;
162 JOYK_END = JOYK_BEG + e_MaxJoyBtns*e_MaxJoys;
163 JOYA_BEG = JOYK_END;
164 JOYA_END = JOYA_BEG + e_MaxJoyAxes*2*e_MaxJoys;
165 JOYH_BEG = JOYA_END;
166 JOYH_END = JOYH_BEG + e_MaxJoyHats*4*e_MaxJoys;
167 VIRT_BEG = JOYH_END;
168 VIRT_END = VIRT_BEG + e_MaxVirtKeys;
169
170 type
171 TJoystick = record
172 ID: Byte;
173 Handle: PSDL_Joystick;
174 Axes: Byte;
175 Buttons: Byte;
176 Hats: Byte;
177 ButtBuf: array [0..e_MaxJoyBtns] of Boolean;
178 AxisBuf: array [0..e_MaxJoyAxes] of Integer;
179 AxisZero: array [0..e_MaxJoyAxes] of Integer;
180 HatBuf: array [0..e_MaxJoyHats] of array [HAT_LEFT..HAT_DOWN] of Boolean;
181 end;
182
183 var
184 KeyBuffer: array [0..e_MaxKbdKeys] of Boolean;
185 VirtBuffer: array [0..e_MaxVirtKeys] of Boolean;
186 Joysticks: array of TJoystick = nil;
187
188 function OpenJoysticks(): Byte;
189 var
190 i, j, k, c: Integer;
191 joy: PSDL_Joystick;
192 begin
193 Result := 0;
194 k := Min(e_MaxJoys, SDL_NumJoysticks());
195 if k = 0 then Exit;
196 c := 0;
197 for i := 0 to k do
198 begin
199 joy := SDL_JoystickOpen(i);
200 if joy <> nil then
201 begin
202 Inc(c);
203 e_WriteLog('Input: Opened SDL joystick ' + IntToStr(i) + ' (' + SDL_JoystickName(joy) +
204 ') as joystick ' + IntToStr(c) + ':', TMsgType.Notify);
205 SetLength(Joysticks, c);
206 with Joysticks[c-1] do
207 begin
208 ID := i;
209 Handle := joy;
210 Axes := Min(e_MaxJoyAxes, SDL_JoystickNumAxes(joy));
211 Buttons := Min(e_MaxJoyBtns, SDL_JoystickNumButtons(joy));
212 Hats := Min(e_MaxJoyHats, SDL_JoystickNumHats(joy));
213 // TODO: find proper solution for this xbox trigger shit
214 for j := 0 to Axes do AxisZero[j] := SDL_JoystickGetAxis(joy, j);
215 e_WriteLog(' ' + IntToStr(Axes) + ' axes, ' + IntToStr(Buttons) + ' buttons, ' +
216 IntToStr(Hats) + ' hats.', TMsgType.Notify);
217 end;
218 end;
219 end;
220 Result := c;
221 end;
222
223 procedure ReleaseJoysticks();
224 var
225 i: Integer;
226 begin
227 if (Joysticks = nil) or (e_JoysticksAvailable = 0) then Exit;
228 for i := Low(Joysticks) to High(Joysticks) do
229 with Joysticks[i] do
230 SDL_JoystickClose(Handle);
231 SetLength(Joysticks, 0);
232 end;
233
234
235 procedure e_UnpressAllKeys ();
236 var
237 i: Integer;
238 begin
239 for i := 0 to High(KeyBuffer) do KeyBuffer[i] := False;
240 for i := 0 to High(VirtBuffer) do VirtBuffer[i] := False;
241 end;
242
243
244 procedure e_KeyUpDown (key: Word; down: Boolean);
245 begin
246 if (key > 0) and (key < Length(KeyBuffer)) then KeyBuffer[key] := down
247 else if (key >= VIRT_BEG) and (key < VIRT_END) then VirtBuffer[key - VIRT_BEG] := down
248 end;
249
250
251 function PollKeyboard(): Boolean;
252 {
253 var
254 Keys: PByte;
255 NKeys: Integer;
256 i: NativeUInt;
257 }
258 begin
259 Result := False;
260 {
261 Keys := SDL_GetKeyboardState(@NKeys);
262 if (Keys = nil) or (NKeys < 1) then Exit;
263 for i := 0 to NKeys do
264 begin
265 if ((PByte(NativeUInt(Keys) + i)^) <> 0) then KeyBuffer[i] := false;
266 end;
267 for i := NKeys to High(KeyBuffer) do KeyBuffer[i] := False;
268 }
269 end;
270
271 procedure e_PollJoysticks();
272 var
273 i, j: Word;
274 hat: Byte;
275 begin
276 //Result := False;
277 if (Joysticks = nil) or (e_JoysticksAvailable = 0) then Exit;
278 SDL_JoystickUpdate();
279 for j := Low(Joysticks) to High(Joysticks) do
280 begin
281 with Joysticks[j] do
282 begin
283 for i := 0 to Buttons do ButtBuf[i] := SDL_JoystickGetButton(Handle, i) <> 0;
284 for i := 0 to Axes do AxisBuf[i] := SDL_JoystickGetAxis(Handle, i);
285 for i := 0 to Hats do
286 begin
287 hat := SDL_JoystickGetHat(Handle, i);
288 HatBuf[i, HAT_UP] := LongBool(hat and SDL_HAT_UP);
289 HatBuf[i, HAT_DOWN] := LongBool(hat and SDL_HAT_DOWN);
290 HatBuf[i, HAT_LEFT] := LongBool(hat and SDL_HAT_LEFT);
291 HatBuf[i, HAT_RIGHT] := LongBool(hat and SDL_HAT_RIGHT);
292 end;
293 end;
294 end;
295 end;
296
297 procedure GenerateKeyNames();
298 var
299 i, j, k: LongWord;
300 begin
301 // keyboard key names
302 for i := 0 to IK_LASTKEY do
303 e_KeyNames[i] := SDL_GetScancodeName(i);
304
305 // joysticks
306 for j := 0 to e_MaxJoys-1 do
307 begin
308 k := JOYK_BEG + j * e_MaxJoyBtns;
309 // buttons
310 for i := 0 to e_MaxJoyBtns-1 do
311 e_KeyNames[k + i] := Format('JOY%d B%d', [j, i]);
312 k := JOYA_BEG + j * e_MaxJoyAxes * 2;
313 // axes
314 for i := 0 to e_MaxJoyAxes-1 do
315 begin
316 e_KeyNames[k + i*2 ] := Format('JOY%d A%d+', [j, i]);
317 e_KeyNames[k + i*2 + 1] := Format('JOY%d A%d-', [j, i]);
318 end;
319 k := JOYH_BEG + j * e_MaxJoyHats * 4;
320 // hats
321 for i := 0 to e_MaxJoyHats-1 do
322 begin
323 e_KeyNames[k + i*4 ] := Format('JOY%d D%dL', [j, i]);
324 e_KeyNames[k + i*4 + 1] := Format('JOY%d D%dU', [j, i]);
325 e_KeyNames[k + i*4 + 2] := Format('JOY%d D%dR', [j, i]);
326 e_KeyNames[k + i*4 + 3] := Format('JOY%d D%dD', [j, i]);
327 end;
328 end;
329
330 // vitrual keys
331 for i := 0 to e_MaxVirtKeys-1 do
332 e_KeyNames[VIRT_BEG + i] := 'VIRTUAL ' + IntToStr(i);
333 end;
334
335 function e_InitInput(): Boolean;
336 begin
337 Result := False;
338
339 e_JoysticksAvailable := OpenJoysticks();
340 e_EnableInput := True;
341 GenerateKeyNames();
342
343 Result := True;
344 end;
345
346 procedure e_ReleaseInput();
347 begin
348 ReleaseJoysticks();
349 e_JoysticksAvailable := 0;
350 end;
351
352 procedure e_ClearInputBuffer();
353 var
354 i, j, d: Integer;
355 begin
356 for i := Low(KeyBuffer) to High(KeyBuffer) do
357 KeyBuffer[i] := False;
358 if (Joysticks = nil) or (e_JoysticksAvailable = 0) then
359 for i := Low(Joysticks) to High(Joysticks) do
360 begin
361 for j := Low(Joysticks[i].ButtBuf) to High(Joysticks[i].ButtBuf) do
362 Joysticks[i].ButtBuf[j] := False;
363 for j := Low(Joysticks[i].AxisBuf) to High(Joysticks[i].AxisBuf) do
364 Joysticks[i].AxisBuf[j] := 0;
365 for j := Low(Joysticks[i].HatBuf) to High(Joysticks[i].HatBuf) do
366 for d := Low(Joysticks[i].HatBuf[j]) to High(Joysticks[i].HatBuf[j]) do
367 Joysticks[i].HatBuf[j, d] := False;
368 end;
369 for i := Low(VirtBuffer) to High(VirtBuffer) do
370 VirtBuffer[i] := False;
371 end;
372
373 {
374 function e_PollInput(): Boolean;
375 var
376 kb, js: Boolean;
377 begin
378 kb := PollKeyboard();
379 js := e_PollJoysticks();
380
381 Result := kb or js;
382 end;
383 }
384
385 function e_KeyPressed(Key: Word): Boolean;
386 var
387 joyi, dir: Integer;
388 begin
389 Result := False;
390 if (Key = IK_INVALID) or (Key = 0) then Exit;
391
392 if (Key < KBRD_END) then
393 begin // Keyboard buttons/keys
394 Result := KeyBuffer[Key];
395 end
396
397 else if (Key >= JOYK_BEG) and (Key < JOYK_END) then
398 begin // Joystick buttons
399 JoyI := (Key - JOYK_BEG) div e_MaxJoyBtns;
400 if JoyI >= e_JoysticksAvailable then
401 Result := False
402 else
403 begin
404 Key := (Key - JOYK_BEG) mod e_MaxJoyBtns;
405 Result := Joysticks[JoyI].ButtBuf[Key];
406 end;
407 end
408
409 else if (Key >= JOYA_BEG) and (Key < JOYA_END) then
410 begin // Joystick axes
411 JoyI := (Key - JOYA_BEG) div (e_MaxJoyAxes*2);
412 if JoyI >= e_JoysticksAvailable then
413 Result := False
414 else
415 begin
416 Key := (Key - JOYA_BEG) mod (e_MaxJoyAxes*2);
417 dir := Key mod 2;
418 if dir = AX_MINUS then
419 Result := Joysticks[JoyI].AxisBuf[Key div 2] <
420 Joysticks[JoyI].AxisZero[Key div 2] - e_JoystickDeadzones[JoyI]
421 else
422 Result := Joysticks[JoyI].AxisBuf[Key div 2] >
423 Joysticks[JoyI].AxisZero[Key div 2] + e_JoystickDeadzones[JoyI]
424 end;
425 end
426
427 else if (Key >= JOYH_BEG) and (Key < JOYH_END) then
428 begin // Joystick hats
429 JoyI := (Key - JOYH_BEG) div (e_MaxJoyHats*4);
430 if JoyI >= e_JoysticksAvailable then
431 Result := False
432 else
433 begin
434 Key := (Key - JOYH_BEG) mod (e_MaxJoyHats*4);
435 dir := Key mod 4;
436 Result := Joysticks[JoyI].HatBuf[Key div 4, dir];
437 end;
438 end
439
440 else if (Key >= VIRT_BEG) and (Key < VIRT_END) then
441 Result := VirtBuffer[Key - VIRT_BEG]
442 end;
443
444 procedure e_SetKeyState(key: Word; state: Integer);
445 var
446 JoyI, dir: Integer;
447 begin
448 if (Key = IK_INVALID) or (Key = 0) then Exit;
449
450 if (Key < KBRD_END) then
451 begin // Keyboard buttons/keys
452 keyBuffer[key] := (state <> 0);
453 end
454
455 else if (Key >= JOYK_BEG) and (Key < JOYK_END) then
456 begin // Joystick buttons
457 JoyI := (Key - JOYK_BEG) div e_MaxJoyBtns;
458 if JoyI >= e_JoysticksAvailable then
459 Exit
460 else
461 begin
462 Key := (Key - JOYK_BEG) mod e_MaxJoyBtns;
463 Joysticks[JoyI].ButtBuf[Key] := (state <> 0);
464 end;
465 end
466
467 else if (Key >= JOYA_BEG) and (Key < JOYA_END) then
468 begin // Joystick axes
469 JoyI := (Key - JOYA_BEG) div (e_MaxJoyAxes*2);
470 if JoyI >= e_JoysticksAvailable then
471 Exit
472 else
473 begin
474 Key := (Key - JOYA_BEG) mod (e_MaxJoyAxes*2);
475 Joysticks[JoyI].AxisBuf[Key div 2] := state;
476 end;
477 end
478
479 else if (Key >= JOYH_BEG) and (Key < JOYH_END) then
480 begin // Joystick hats
481 JoyI := (Key - JOYH_BEG) div (e_MaxJoyHats*4);
482 if JoyI >= e_JoysticksAvailable then
483 Exit
484 else
485 begin
486 Key := (Key - JOYH_BEG) mod (e_MaxJoyHats*4);
487 dir := Key mod 4;
488 Joysticks[JoyI].HatBuf[Key div 4, dir] := (state <> 0);
489 end;
490 end
491
492 else if (Key >= VIRT_BEG) and (Key < VIRT_END) then
493 VirtBuffer[Key - VIRT_BEG] := (state <> 0)
494 end;
495
496 function e_AnyKeyPressed(): Boolean;
497 var
498 k: Word;
499 begin
500 Result := False;
501
502 for k := 1 to e_MaxInputKeys do
503 if e_KeyPressed(k) then
504 begin
505 Result := True;
506 Break;
507 end;
508 end;
509
510 function e_GetFirstKeyPressed(): Word;
511 var
512 k: Word;
513 begin
514 Result := IK_INVALID;
515
516 for k := 1 to e_MaxInputKeys do
517 if e_KeyPressed(k) then
518 begin
519 Result := k;
520 Break;
521 end;
522 end;
523
524 ////////////////////////////////////////////////////////////////////////////////
525
526 function e_JoystickStateToString(mode: Integer): String;
527 begin
528 Result := '';
529 end;
530
531 function e_JoyByHandle(handle: Word): Integer;
532 var
533 i: Integer;
534 begin
535 Result := -1;
536 if Joysticks = nil then Exit;
537 for i := Low(Joysticks) to High(Joysticks) do
538 if Joysticks[i].ID = handle then
539 begin
540 Result := i;
541 Exit;
542 end;
543 end;
544
545 function e_JoyButtonToKey(id: Word; btn: Byte): Word;
546 begin
547 Result := 0;
548 if id >= Length(Joysticks) then Exit;
549 Result := JOYK_BEG + id*e_MaxJoyBtns + btn;
550 end;
551
552 function e_JoyAxisToKey(id: Word; ax: Byte; dir: Byte): Word;
553 begin
554 Result := 0;
555 if id >= Length(Joysticks) then Exit;
556 Result := JOYA_BEG + id*e_MaxJoyAxes*2 + ax*2 + dir;
557 end;
558
559 function e_JoyHatToKey(id: Word; hat: Byte; dir: Byte): Word;
560 begin
561 Result := 0;
562 if id >= Length(Joysticks) then Exit;
563 Result := JOYH_BEG + id*e_MaxJoyHats*4 + hat*4 + dir;
564 end;
565
566 end.
[MIRROR] a port of Doom 2D Forever to FPC/SDL
[25/02/2024 19:55:35]
DEADSOFTWARE 2012-2024