This repository has been archived by the owner on Feb 11, 2021. It is now read-only.
SDL_keyboard.c
1
2
/*
SDL - Simple DirectMedia Layer
3
Copyright (C) 1997-2006 Sam Lantinga
4
5
This library is free software; you can redistribute it and/or
6
modify it under the terms of the GNU Lesser General Public
7
License as published by the Free Software Foundation; either
8
version 2.1 of the License, or (at your option) any later version.
9
10
11
12
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13
Lesser General Public License for more details.
15
16
17
You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
18
19
Sam Lantinga
20
slouken@libsdl.org
21
*/
22
#include "SDL_config.h"
23
24
25
26
/* General keyboard handling code for SDL */
#include "SDL_timer.h"
27
#include "SDL_events.h"
28
29
30
31
#include "SDL_events_c.h"
#include "SDL_sysevents.h"
32
33
34
35
/* Global keyboard information */
static int SDL_num_keyboards;
static int SDL_current_keyboard;
static SDL_Keyboard **SDL_keyboards;
36
37
int SDL_TranslateUNICODE = 0;
38
static const char *SDL_keynames[SDLK_LAST]; /* Array of keycode names */
39
40
/* Public functions */
42
SDL_KeyboardInit(void)
44
int i;
45
46
/* Set default mode of UNICODE translation */
47
SDL_EnableUNICODE(DEFAULT_UNICODE_TRANSLATION);
49
/* Set default keyboard repeat setting */
50
SDL_EnableKeyRepeat(0, 0);
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
/* Initialize the tables */
for (i = 0; i < SDL_arraysize(SDL_keynames); ++i) {
switch (i) {
case SDLK_BACKSPACE:
SDL_keynames[i] = "backspace";
break;
case SDLK_TAB:
SDL_keynames[i] = "tab";
break;
case SDLK_CLEAR:
SDL_keynames[i] = "clear";
break;
case SDLK_RETURN:
SDL_keynames[i] = "return";
break;
case SDLK_PAUSE:
SDL_keynames[i] = "pause";
break;
case SDLK_ESCAPE:
SDL_keynames[i] = "escape";
break;
case SDLK_SPACE:
SDL_keynames[i] = "space";
break;
case SDLK_KP0:
SDL_keynames[i] = "[0]";
break;
case SDLK_KP1:
SDL_keynames[i] = "[1]";
break;
case SDLK_KP2:
SDL_keynames[i] = "[2]";
break;
case SDLK_KP3:
SDL_keynames[i] = "[3]";
break;
case SDLK_KP4:
SDL_keynames[i] = "[4]";
break;
case SDLK_KP5:
SDL_keynames[i] = "[5]";
break;
case SDLK_KP6:
SDL_keynames[i] = "[6]";
break;
case SDLK_KP7:
SDL_keynames[i] = "[7]";
break;
case SDLK_KP8:
SDL_keynames[i] = "[8]";
break;
case SDLK_KP9:
SDL_keynames[i] = "[9]";
break;
case SDLK_KP_PERIOD:
SDL_keynames[i] = "[.]";
break;
case SDLK_KP_DIVIDE:
SDL_keynames[i] = "[/]";
break;
case SDLK_KP_MULTIPLY:
SDL_keynames[i] = "[*]";
break;
case SDLK_KP_MINUS:
SDL_keynames[i] = "[-]";
break;
case SDLK_KP_PLUS:
SDL_keynames[i] = "[+]";
break;
case SDLK_KP_ENTER:
SDL_keynames[i] = "enter";
break;
case SDLK_KP_EQUALS:
SDL_keynames[i] = "equals";
break;
case SDLK_UP:
SDL_keynames[i] = "up";
break;
case SDLK_DOWN:
SDL_keynames[i] = "down";
break;
case SDLK_RIGHT:
SDL_keynames[i] = "right";
break;
case SDLK_LEFT:
SDL_keynames[i] = "left";
break;
case SDLK_DOWN:
SDL_keynames[i] = "down";
break;
case SDLK_INSERT:
SDL_keynames[i] = "insert";
break;
case SDLK_HOME:
SDL_keynames[i] = "home";
break;
case SDLK_END:
SDL_keynames[i] = "end";
break;
case SDLK_PAGEUP:
SDL_keynames[i] = "page up";
break;
case SDLK_PAGEDOWN:
SDL_keynames[i] = "page down";
break;
case SDLK_F1:
SDL_keynames[i] = "f1";
break;
case SDLK_F2:
SDL_keynames[i] = "f2";
break;
case SDLK_F3:
SDL_keynames[i] = "f3";
break;
case SDLK_F4:
SDL_keynames[i] = "f4";
break;
case SDLK_F5:
SDL_keynames[i] = "f5";
break;
case SDLK_F6:
SDL_keynames[i] = "f6";
break;
case SDLK_F7:
SDL_keynames[i] = "f7";
break;
case SDLK_F8:
SDL_keynames[i] = "f8";
break;
case SDLK_F9:
SDL_keynames[i] = "f9";
break;
case SDLK_F10:
SDL_keynames[i] = "f10";
break;
case SDLK_F11:
SDL_keynames[i] = "f11";
break;
case SDLK_F12:
SDL_keynames[i] = "f12";
break;
case SDLK_F13:
SDL_keynames[i] = "f13";
break;
case SDLK_F14:
SDL_keynames[i] = "f14";
break;
case SDLK_F15:
SDL_keynames[i] = "f15";
break;
case SDLK_NUMLOCK:
SDL_keynames[i] = "numlock";
break;
case SDLK_CAPSLOCK:
SDL_keynames[i] = "caps lock";
break;
case SDLK_SCROLLOCK:
SDL_keynames[i] = "scroll lock";
break;
case SDLK_RSHIFT:
SDL_keynames[i] = "right shift";
break;
case SDLK_LSHIFT:
SDL_keynames[i] = "left shift";
break;
case SDLK_RCTRL:
SDL_keynames[i] = "right ctrl";
break;
case SDLK_LCTRL:
SDL_keynames[i] = "left ctrl";
break;
case SDLK_RALT:
SDL_keynames[i] = "right alt";
break;
case SDLK_LALT:
SDL_keynames[i] = "left alt";
break;
case SDLK_RMETA:
SDL_keynames[i] = "right meta";
break;
case SDLK_LMETA:
SDL_keynames[i] = "left meta";
break;
case SDLK_LSUPER:
SDL_keynames[i] = "left super"; /* "Windows" keys */
break;
case SDLK_RSUPER:
SDL_keynames[i] = "right super";
break;
case SDLK_MODE:
SDL_keynames[i] = "alt gr";
break;
case SDLK_COMPOSE:
SDL_keynames[i] = "compose";
break;
case SDLK_HELP:
SDL_keynames[i] = "help";
break;
case SDLK_PRINT:
SDL_keynames[i] = "print screen";
break;
case SDLK_SYSREQ:
SDL_keynames[i] = "sys req";
break;
case SDLK_BREAK:
SDL_keynames[i] = "break";
break;
case SDLK_MENU:
SDL_keynames[i] = "menu";
break;
case SDLK_POWER:
SDL_keynames[i] = "power";
break;
case SDLK_EURO:
SDL_keynames[i] = "euro";
break;
case SDLK_UNDO:
SDL_keynames[i] = "undo";
break;
default:
SDL_keynames[i] = NULL;
break;
}
}
282
283
284
/* Done. Whew. */
return (0);
285
}
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
SDL_Keyboard *
SDL_GetKeyboard(int index)
{
if (index < 0 || index >= SDL_num_keyboards) {
return NULL;
}
return SDL_keyboards[index];
}
int
SDL_AddKeyboard(const SDL_Keyboard * keyboard, int index)
{
SDL_Keyboard **keyboards;
SDL_Cursor *cursor;
int selected_keyboard;
/* Add the keyboard to the list of keyboards */
if (index < 0 || index >= SDL_num_keyboards || SDL_keyboards[index]) {
keyboards =
(SDL_Keyboard **) SDL_realloc(SDL_keyboards,
(SDL_num_keyboards +
1) * sizeof(*keyboards));
if (!keyboards) {
SDL_OutOfMemory();
return -1;
}
SDL_keyboards = keyboards;
index = SDL_num_keyboards++;
}
SDL_keyboards[index] =
(SDL_Keyboard *) SDL_malloc(sizeof(*SDL_keyboards[index]));
if (!SDL_keyboards[index]) {
SDL_OutOfMemory();
return -1;
}
*SDL_keyboards[index] = *keyboard;
return index;
}
329
SDL_DelKeyboard(int index)
331
332
333
334
335
336
337
338
339
340
341
342
SDL_Keyboard *keyboard = SDL_GetKeyboard(index);
if (!keyboard) {
return;
}
if (keyboard->FreeKeyboard) {
keyboard->FreeKeyboard(keyboard);
}
SDL_free(keyboard);
SDL_keyboards[index] = NULL;
346
SDL_ResetKeyboard(int index)
347
{
348
SDL_Keyboard *keyboard = SDL_GetKeyboard(index);
349
350
351
SDL_keysym keysym;
SDLKey key;
352
353
354
355
if (!keyboard) {
return;
}
356
SDL_memset(&keysym, 0, (sizeof keysym));
357
for (key = SDLK_FIRST; key < SDLK_LAST; ++key) {
358
if (keyboard->keystate[key] == SDL_PRESSED) {
359
keysym.sym = key;
360
SDL_SendKeyboardKey(index, SDL_RELEASED, &keysym);
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
keyboard->keyrepeat.timestamp = 0;
}
void
SDL_KeyboardQuit(void)
{
int i;
for (i = 0; i < SDL_num_keyboards; ++i) {
SDL_DelKeyboard(i);
}
SDL_num_keyboards = 0;
SDL_current_keyboard = 0;
if (SDL_keyboards) {
SDL_free(SDL_keyboards);
SDL_keyboards = NULL;
}
}
int
SDL_GetNumKeyboards(void)
{
return SDL_num_keyboards;
}
int
SDL_SelectKeyboard(int index)
{
if (index >= 0 && index < SDL_num_keyboards) {
SDL_current_keyboard = index;
}
return SDL_current_keyboard;
396
397
}
399
SDL_EnableUNICODE(int enable)
400
{
403
404
405
406
407
old_mode = SDL_TranslateUNICODE;
if (enable >= 0) {
SDL_TranslateUNICODE = enable;
}
return (old_mode);
408
409
}
411
SDL_GetKeyState(int *numkeys)
412
{
413
414
415
if (numkeys != (int *) 0)
*numkeys = SDLK_LAST;
return (SDL_KeyState);
416
}
419
SDL_GetModState(void)
420
{
421
422
423
424
425
426
SDL_Keyboard *keyboard = SDL_GetKeyboard(index);
if (!keyboard) {
return KMOD_NONE;
}
return keyboard->modstate;
427
}
430
SDL_SetModState(SDLMod modstate)
431
{
432
433
434
435
436
437
SDL_Keyboard *keyboard = SDL_GetKeyboard(index);
if (!keyboard) {
return;
}
keyboard->modstate = modstate;
438
439
}
440
const char *
441
SDL_GetKeyName(SDLKey key)
442
{
443
444
const char *keyname;
445
keyname = keynames[key];
446
if (keyname == NULL) {
447
448
449
450
451
452
if (key < 256) {
static char temp[4];
FIXME:Convert to UTF - 8 keyname = temp;
} else {
keyname = "unknown key";
}
454
return keyname;
455
456
457
}
/* These are global for SDL_eventloop.c */
459
SDL_SendKeyboardKey(int index, Uint8 state, const SDL_keysym * keysym)
460
{
461
462
463
SDL_Event event;
int posted, repeatable;
Uint16 modstate;
465
SDL_memset(&event, 0, sizeof(event));
466
467
#if 0
468
469
printf("The '%s' key has been %s\n", SDL_GetKeyName(keysym->sym),
state == SDL_PRESSED ? "pressed" : "released");
470
#endif
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
/* Set up the keysym */
modstate = (Uint16) SDL_ModState;
repeatable = 0;
if (state == SDL_PRESSED) {
keysym->mod = (SDLMod) modstate;
switch (keysym->sym) {
case SDLK_UNKNOWN:
break;
case SDLK_NUMLOCK:
modstate ^= KMOD_NUM;
if (!(modstate & KMOD_NUM))
state = SDL_RELEASED;
keysym->mod = (SDLMod) modstate;
break;
case SDLK_CAPSLOCK:
modstate ^= KMOD_CAPS;
if (!(modstate & KMOD_CAPS))
state = SDL_RELEASED;
keysym->mod = (SDLMod) modstate;
break;
case SDLK_LCTRL:
modstate |= KMOD_LCTRL;
break;
case SDLK_RCTRL:
modstate |= KMOD_RCTRL;
break;
case SDLK_LSHIFT:
modstate |= KMOD_LSHIFT;
break;
case SDLK_RSHIFT:
modstate |= KMOD_RSHIFT;
break;
case SDLK_LALT:
modstate |= KMOD_LALT;
break;
case SDLK_RALT:
modstate |= KMOD_RALT;
break;
case SDLK_LMETA:
modstate |= KMOD_LMETA;
break;
case SDLK_RMETA:
modstate |= KMOD_RMETA;
break;
case SDLK_MODE:
modstate |= KMOD_MODE;
break;
default:
repeatable = 1;
break;
}
} else {
switch (keysym->sym) {
case SDLK_UNKNOWN:
break;
case SDLK_NUMLOCK:
case SDLK_CAPSLOCK:
/* Only send keydown events */
return (0);
case SDLK_LCTRL:
modstate &= ~KMOD_LCTRL;
break;
case SDLK_RCTRL:
modstate &= ~KMOD_RCTRL;
break;
case SDLK_LSHIFT:
modstate &= ~KMOD_LSHIFT;
break;
case SDLK_RSHIFT:
modstate &= ~KMOD_RSHIFT;
break;
case SDLK_LALT:
modstate &= ~KMOD_LALT;
break;
case SDLK_RALT:
modstate &= ~KMOD_RALT;
break;
case SDLK_LMETA:
modstate &= ~KMOD_LMETA;
break;
case SDLK_RMETA:
modstate &= ~KMOD_RMETA;
break;
case SDLK_MODE:
modstate &= ~KMOD_MODE;
break;
default:
break;
}
keysym->mod = (SDLMod) modstate;
}
/* Figure out what type of event this is */
switch (state) {
case SDL_PRESSED:
event.type = SDL_KEYDOWN;
break;
case SDL_RELEASED:
event.type = SDL_KEYUP;
/*
* jk 991215 - Added
*/
if (SDL_KeyRepeat.timestamp &&
SDL_KeyRepeat.evt.key.keysym.sym == keysym->sym) {
SDL_KeyRepeat.timestamp = 0;
}
break;
default:
/* Invalid state -- bail */
return (0);
}
if (keysym->sym != SDLK_UNKNOWN) {
/* Drop events that don't change state */
if (SDL_KeyState[keysym->sym] == state) {
589
printf("Keyboard event didn't change state - dropped!\n");
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
return (0);
}
/* Update internal keyboard state */
SDL_ModState = (SDLMod) modstate;
SDL_KeyState[keysym->sym] = state;
}
/* Post the event, if desired */
posted = 0;
if (SDL_ProcessEvents[event.type] == SDL_ENABLE) {
event.key.state = state;
event.key.keysym = *keysym;
/*
* jk 991215 - Added
*/
if (repeatable && (SDL_KeyRepeat.delay != 0)) {
SDL_KeyRepeat.evt = event;
SDL_KeyRepeat.firsttime = 1;
610
SDL_KeyRepeat.timestamp = SDL_GetTicks();
612
if ((SDL_EventOK == NULL) || SDL_EventOK(&event)) {
614
SDL_PushEvent(&event);
615
616
617
}
}
return (posted);
618
619
620
621
622
}
/*
* jk 991215 - Added
*/
624
SDL_CheckKeyRepeat(void)
625
{
626
627
628
if (SDL_KeyRepeat.timestamp) {
Uint32 now, interval;
629
now = SDL_GetTicks();
630
631
632
633
634
635
636
637
638
639
interval = (now - SDL_KeyRepeat.timestamp);
if (SDL_KeyRepeat.firsttime) {
if (interval > (Uint32) SDL_KeyRepeat.delay) {
SDL_KeyRepeat.timestamp = now;
SDL_KeyRepeat.firsttime = 0;
}
} else {
if (interval > (Uint32) SDL_KeyRepeat.interval) {
SDL_KeyRepeat.timestamp = now;
if ((SDL_EventOK == NULL)
640
641
|| SDL_EventOK(&SDL_KeyRepeat.evt)) {
SDL_PushEvent(&SDL_KeyRepeat.evt);
642
643
644
645
}
}
}
}
646
647
}
649
SDL_EnableKeyRepeat(int delay, int interval)
650
{
651
if ((delay < 0) || (interval < 0)) {
652
SDL_SetError("keyboard repeat value less than zero");
653
654
655
656
657
658
659
return (-1);
}
SDL_KeyRepeat.firsttime = 0;
SDL_KeyRepeat.delay = delay;
SDL_KeyRepeat.interval = interval;
SDL_KeyRepeat.timestamp = 0;
return (0);
660
661
}
663
SDL_GetKeyRepeat(int *delay, int *interval)
664
{
665
666
*delay = SDL_KeyRepeat.delay;
*interval = SDL_KeyRepeat.interval;
667
668
}
669
/* vi: set ts=4 sw=4 expandtab: */