src/events/SDL_keyboard.c
/* [<][>][^][v][top][bottom][index][help] */
FUNCTIONS
This source file includes following functions.
- SDL_KeyboardInit
- SDL_ResetKeyboard
- SDL_EnableUNICODE
- SDL_GetKeyState
- SDL_GetModState
- SDL_SetModState
- SDL_GetKeyName
- SDL_PrivateKeyboard
- SDL_CheckKeyRepeat
- SDL_EnableKeyRepeat
1 /*
2 SDL - Simple DirectMedia Layer
3 Copyright (C) 1997, 1998, 1999, 2000, 2001 Sam Lantinga
4
5 This library is free software; you can redistribute it and/or
6 modify it under the terms of the GNU Library General Public
7 License as published by the Free Software Foundation; either
8 version 2 of the License, or (at your option) any later version.
9
10 This library is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 Library General Public License for more details.
14
15 You should have received a copy of the GNU Library General Public
16 License along with this library; if not, write to the Free
17 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18
19 Sam Lantinga
20 slouken@devolution.com
21 */
22
23 #ifdef SAVE_RCSID
24 static char rcsid =
25 "@(#) $Id: SDL_keyboard.c,v 1.6.2.14 2001/02/10 07:20:04 hercules Exp $";
26 #endif
27
28 /* General keyboard handling code for SDL */
29
30 #include <stdio.h>
31 #include <ctype.h>
32 #include <stdlib.h>
33 #include <string.h>
34
35 #include "SDL_error.h"
36 #include "SDL_events.h"
37 #include "SDL_timer.h"
38 #include "SDL_events_c.h"
39 #include "SDL_sysevents.h"
40
41
42 /* Global keystate information */
43 static Uint8 SDL_KeyState[SDLK_LAST];
44 static SDLMod SDL_ModState;
45 int SDL_TranslateUNICODE = 0;
46
47 static char *keynames[SDLK_LAST]; /* Array of keycode names */
48
49 /*
50 * jk 991215 - added
51 */
52 #define MINIMUM_REPEAT_INTERVAL 30 /* Minimum repeat interval (30 ms) */
53 struct {
54 int firsttime; /* if we check against the delay or repeat value */
55 int delay; /* the delay before we start repeating */
56 int interval; /* the delay between key repeat events */
57 Uint32 timestamp; /* the time the first keydown event occurred */
58
59 SDL_Event evt; /* the event we are supposed to repeat */
60 } SDL_KeyRepeat;
61
62 /* Public functions */
63 int SDL_KeyboardInit(void)
/* [<][>][^][v][top][bottom][index][help] */
64 {
65 SDL_VideoDevice *video = current_video;
66 SDL_VideoDevice *this = current_video;
67 Uint16 i;
68
69 /* Set default mode of UNICODE translation */
70 SDL_EnableUNICODE(DEFAULT_UNICODE_TRANSLATION);
71
72 /* Initialize the tables */
73 SDL_ModState = KMOD_NONE;
74 for ( i=0; i<SDL_TABLESIZE(keynames); ++i )
75 keynames[i] = NULL;
76 for ( i=0; i<SDL_TABLESIZE(SDL_KeyState); ++i )
77 SDL_KeyState[i] = SDL_RELEASED;
78 video->InitOSKeymap(this);
79
80 SDL_EnableKeyRepeat(0, 0);
81
82 /* Fill in the blanks in keynames */
83 keynames[SDLK_BACKSPACE] = "backspace";
84 keynames[SDLK_TAB] = "tab";
85 keynames[SDLK_CLEAR] = "clear";
86 keynames[SDLK_RETURN] = "return";
87 keynames[SDLK_PAUSE] = "pause";
88 keynames[SDLK_ESCAPE] = "escape";
89 keynames[SDLK_SPACE] = "space";
90 keynames[SDLK_EXCLAIM] = "!";
91 keynames[SDLK_QUOTEDBL] = "\"";
92 keynames[SDLK_HASH] = "#";
93 keynames[SDLK_DOLLAR] = "$";
94 keynames[SDLK_AMPERSAND] = "&";
95 keynames[SDLK_QUOTE] = "'";
96 keynames[SDLK_LEFTPAREN] = "(";
97 keynames[SDLK_RIGHTPAREN] = ")";
98 keynames[SDLK_ASTERISK] = "*";
99 keynames[SDLK_PLUS] = "+";
100 keynames[SDLK_COMMA] = ",";
101 keynames[SDLK_MINUS] = "-";
102 keynames[SDLK_PERIOD] = ".";
103 keynames[SDLK_SLASH] = "/";
104 keynames[SDLK_0] = "0";
105 keynames[SDLK_1] = "1";
106 keynames[SDLK_2] = "2";
107 keynames[SDLK_3] = "3";
108 keynames[SDLK_4] = "4";
109 keynames[SDLK_5] = "5";
110 keynames[SDLK_6] = "6";
111 keynames[SDLK_7] = "7";
112 keynames[SDLK_8] = "8";
113 keynames[SDLK_9] = "9";
114 keynames[SDLK_COLON] = ":";
115 keynames[SDLK_SEMICOLON] = ";";
116 keynames[SDLK_LESS] = "<";
117 keynames[SDLK_EQUALS] = "=";
118 keynames[SDLK_GREATER] = ">";
119 keynames[SDLK_QUESTION] = "?";
120 keynames[SDLK_AT] = "@";
121 keynames[SDLK_LEFTBRACKET] = "[";
122 keynames[SDLK_BACKSLASH] = "\\";
123 keynames[SDLK_RIGHTBRACKET] = "]";
124 keynames[SDLK_CARET] = "^";
125 keynames[SDLK_UNDERSCORE] = "_";
126 keynames[SDLK_BACKQUOTE] = "`";
127 keynames[SDLK_a] = "a";
128 keynames[SDLK_b] = "b";
129 keynames[SDLK_c] = "c";
130 keynames[SDLK_d] = "d";
131 keynames[SDLK_e] = "e";
132 keynames[SDLK_f] = "f";
133 keynames[SDLK_g] = "g";
134 keynames[SDLK_h] = "h";
135 keynames[SDLK_i] = "i";
136 keynames[SDLK_j] = "j";
137 keynames[SDLK_k] = "k";
138 keynames[SDLK_l] = "l";
139 keynames[SDLK_m] = "m";
140 keynames[SDLK_n] = "n";
141 keynames[SDLK_o] = "o";
142 keynames[SDLK_p] = "p";
143 keynames[SDLK_q] = "q";
144 keynames[SDLK_r] = "r";
145 keynames[SDLK_s] = "s";
146 keynames[SDLK_t] = "t";
147 keynames[SDLK_u] = "u";
148 keynames[SDLK_v] = "v";
149 keynames[SDLK_w] = "w";
150 keynames[SDLK_x] = "x";
151 keynames[SDLK_y] = "y";
152 keynames[SDLK_z] = "z";
153 keynames[SDLK_DELETE] = "delete";
154
155 keynames[SDLK_WORLD_0] = "world 0";
156 keynames[SDLK_WORLD_1] = "world 1";
157 keynames[SDLK_WORLD_2] = "world 2";
158 keynames[SDLK_WORLD_3] = "world 3";
159 keynames[SDLK_WORLD_4] = "world 4";
160 keynames[SDLK_WORLD_5] = "world 5";
161 keynames[SDLK_WORLD_6] = "world 6";
162 keynames[SDLK_WORLD_7] = "world 7";
163 keynames[SDLK_WORLD_8] = "world 8";
164 keynames[SDLK_WORLD_9] = "world 9";
165 keynames[SDLK_WORLD_10] = "world 10";
166 keynames[SDLK_WORLD_11] = "world 11";
167 keynames[SDLK_WORLD_12] = "world 12";
168 keynames[SDLK_WORLD_13] = "world 13";
169 keynames[SDLK_WORLD_14] = "world 14";
170 keynames[SDLK_WORLD_15] = "world 15";
171 keynames[SDLK_WORLD_16] = "world 16";
172 keynames[SDLK_WORLD_17] = "world 17";
173 keynames[SDLK_WORLD_18] = "world 18";
174 keynames[SDLK_WORLD_19] = "world 19";
175 keynames[SDLK_WORLD_20] = "world 20";
176 keynames[SDLK_WORLD_21] = "world 21";
177 keynames[SDLK_WORLD_22] = "world 22";
178 keynames[SDLK_WORLD_23] = "world 23";
179 keynames[SDLK_WORLD_24] = "world 24";
180 keynames[SDLK_WORLD_25] = "world 25";
181 keynames[SDLK_WORLD_26] = "world 26";
182 keynames[SDLK_WORLD_27] = "world 27";
183 keynames[SDLK_WORLD_28] = "world 28";
184 keynames[SDLK_WORLD_29] = "world 29";
185 keynames[SDLK_WORLD_30] = "world 30";
186 keynames[SDLK_WORLD_31] = "world 31";
187 keynames[SDLK_WORLD_32] = "world 32";
188 keynames[SDLK_WORLD_33] = "world 33";
189 keynames[SDLK_WORLD_34] = "world 34";
190 keynames[SDLK_WORLD_35] = "world 35";
191 keynames[SDLK_WORLD_36] = "world 36";
192 keynames[SDLK_WORLD_37] = "world 37";
193 keynames[SDLK_WORLD_38] = "world 38";
194 keynames[SDLK_WORLD_39] = "world 39";
195 keynames[SDLK_WORLD_40] = "world 40";
196 keynames[SDLK_WORLD_41] = "world 41";
197 keynames[SDLK_WORLD_42] = "world 42";
198 keynames[SDLK_WORLD_43] = "world 43";
199 keynames[SDLK_WORLD_44] = "world 44";
200 keynames[SDLK_WORLD_45] = "world 45";
201 keynames[SDLK_WORLD_46] = "world 46";
202 keynames[SDLK_WORLD_47] = "world 47";
203 keynames[SDLK_WORLD_48] = "world 48";
204 keynames[SDLK_WORLD_49] = "world 49";
205 keynames[SDLK_WORLD_50] = "world 50";
206 keynames[SDLK_WORLD_51] = "world 51";
207 keynames[SDLK_WORLD_52] = "world 52";
208 keynames[SDLK_WORLD_53] = "world 53";
209 keynames[SDLK_WORLD_54] = "world 54";
210 keynames[SDLK_WORLD_55] = "world 55";
211 keynames[SDLK_WORLD_56] = "world 56";
212 keynames[SDLK_WORLD_57] = "world 57";
213 keynames[SDLK_WORLD_58] = "world 58";
214 keynames[SDLK_WORLD_59] = "world 59";
215 keynames[SDLK_WORLD_60] = "world 60";
216 keynames[SDLK_WORLD_61] = "world 61";
217 keynames[SDLK_WORLD_62] = "world 62";
218 keynames[SDLK_WORLD_63] = "world 63";
219 keynames[SDLK_WORLD_64] = "world 64";
220 keynames[SDLK_WORLD_65] = "world 65";
221 keynames[SDLK_WORLD_66] = "world 66";
222 keynames[SDLK_WORLD_67] = "world 67";
223 keynames[SDLK_WORLD_68] = "world 68";
224 keynames[SDLK_WORLD_69] = "world 69";
225 keynames[SDLK_WORLD_70] = "world 70";
226 keynames[SDLK_WORLD_71] = "world 71";
227 keynames[SDLK_WORLD_72] = "world 72";
228 keynames[SDLK_WORLD_73] = "world 73";
229 keynames[SDLK_WORLD_74] = "world 74";
230 keynames[SDLK_WORLD_75] = "world 75";
231 keynames[SDLK_WORLD_76] = "world 76";
232 keynames[SDLK_WORLD_77] = "world 77";
233 keynames[SDLK_WORLD_78] = "world 78";
234 keynames[SDLK_WORLD_79] = "world 79";
235 keynames[SDLK_WORLD_80] = "world 80";
236 keynames[SDLK_WORLD_81] = "world 81";
237 keynames[SDLK_WORLD_82] = "world 82";
238 keynames[SDLK_WORLD_83] = "world 83";
239 keynames[SDLK_WORLD_84] = "world 84";
240 keynames[SDLK_WORLD_85] = "world 85";
241 keynames[SDLK_WORLD_86] = "world 86";
242 keynames[SDLK_WORLD_87] = "world 87";
243 keynames[SDLK_WORLD_88] = "world 88";
244 keynames[SDLK_WORLD_89] = "world 89";
245 keynames[SDLK_WORLD_90] = "world 90";
246 keynames[SDLK_WORLD_91] = "world 91";
247 keynames[SDLK_WORLD_92] = "world 92";
248 keynames[SDLK_WORLD_93] = "world 93";
249 keynames[SDLK_WORLD_94] = "world 94";
250 keynames[SDLK_WORLD_95] = "world 95";
251
252 keynames[SDLK_KP0] = "[0]";
253 keynames[SDLK_KP1] = "[1]";
254 keynames[SDLK_KP2] = "[2]";
255 keynames[SDLK_KP3] = "[3]";
256 keynames[SDLK_KP4] = "[4]";
257 keynames[SDLK_KP5] = "[5]";
258 keynames[SDLK_KP6] = "[6]";
259 keynames[SDLK_KP7] = "[7]";
260 keynames[SDLK_KP8] = "[8]";
261 keynames[SDLK_KP9] = "[9]";
262 keynames[SDLK_KP_PERIOD] = "[.]";
263 keynames[SDLK_KP_DIVIDE] = "[/]";
264 keynames[SDLK_KP_MULTIPLY] = "[*]";
265 keynames[SDLK_KP_MINUS] = "[-]";
266 keynames[SDLK_KP_PLUS] = "[+]";
267 keynames[SDLK_KP_ENTER] = "enter";
268 keynames[SDLK_KP_EQUALS] = "equals";
269
270 keynames[SDLK_UP] = "up";
271 keynames[SDLK_DOWN] = "down";
272 keynames[SDLK_RIGHT] = "right";
273 keynames[SDLK_LEFT] = "left";
274 keynames[SDLK_DOWN] = "down";
275 keynames[SDLK_INSERT] = "insert";
276 keynames[SDLK_HOME] = "home";
277 keynames[SDLK_END] = "end";
278 keynames[SDLK_PAGEUP] = "page up";
279 keynames[SDLK_PAGEDOWN] = "page down";
280
281 keynames[SDLK_F1] = "f1";
282 keynames[SDLK_F2] = "f2";
283 keynames[SDLK_F3] = "f3";
284 keynames[SDLK_F4] = "f4";
285 keynames[SDLK_F5] = "f5";
286 keynames[SDLK_F6] = "f6";
287 keynames[SDLK_F7] = "f7";
288 keynames[SDLK_F8] = "f8";
289 keynames[SDLK_F9] = "f9";
290 keynames[SDLK_F10] = "f10";
291 keynames[SDLK_F11] = "f11";
292 keynames[SDLK_F12] = "f12";
293 keynames[SDLK_F13] = "f13";
294 keynames[SDLK_F14] = "f14";
295 keynames[SDLK_F15] = "f15";
296
297 keynames[SDLK_NUMLOCK] = "numlock";
298 keynames[SDLK_CAPSLOCK] = "caps lock";
299 keynames[SDLK_SCROLLOCK] = "scroll lock";
300 keynames[SDLK_RSHIFT] = "right shift";
301 keynames[SDLK_LSHIFT] = "left shift";
302 keynames[SDLK_RCTRL] = "right ctrl";
303 keynames[SDLK_LCTRL] = "left ctrl";
304 keynames[SDLK_RALT] = "right alt";
305 keynames[SDLK_LALT] = "left alt";
306 keynames[SDLK_RMETA] = "right meta";
307 keynames[SDLK_LMETA] = "left meta";
308 keynames[SDLK_LSUPER] = "left super"; /* "Windows" keys */
309 keynames[SDLK_RSUPER] = "right super";
310 keynames[SDLK_MODE] = "alt gr";
311 keynames[SDLK_COMPOSE] = "compose";
312
313 keynames[SDLK_HELP] = "help";
314 keynames[SDLK_PRINT] = "print screen";
315 keynames[SDLK_SYSREQ] = "sys req";
316 keynames[SDLK_BREAK] = "break";
317 keynames[SDLK_MENU] = "menu";
318 keynames[SDLK_POWER] = "power";
319 keynames[SDLK_EURO] = "euro";
320
321 /* Done. Whew. */
322 return(0);
323 }
324
325 /* We lost the keyboard, so post key up messages for all pressed keys */
326 void SDL_ResetKeyboard(void)
/* [<][>][^][v][top][bottom][index][help] */
327 {
328 SDL_keysym keysym;
329 SDLKey key;
330
331 memset(&keysym, 0, (sizeof keysym));
332 for ( key=SDLK_FIRST; key<SDLK_LAST; ++key ) {
333 if ( SDL_KeyState[key] == SDL_PRESSED ) {
334 keysym.sym = key;
335 SDL_PrivateKeyboard(SDL_RELEASED, &keysym);
336 }
337 }
338 }
339
340 int SDL_EnableUNICODE(int enable)
/* [<][>][^][v][top][bottom][index][help] */
341 {
342 int old_mode;
343
344 old_mode = SDL_TranslateUNICODE;
345 if ( enable >= 0 ) {
346 SDL_TranslateUNICODE = enable;
347 }
348 return(old_mode);
349 }
350
351 Uint8 * SDL_GetKeyState (int *numkeys)
/* [<][>][^][v][top][bottom][index][help] */
352 {
353 if ( numkeys != (int *)0 )
354 *numkeys = SDLK_LAST;
355 return(SDL_KeyState);
356 }
357 SDLMod SDL_GetModState (void)
/* [<][>][^][v][top][bottom][index][help] */
358 {
359 return(SDL_ModState);
360 }
361 void SDL_SetModState (SDLMod modstate)
/* [<][>][^][v][top][bottom][index][help] */
362 {
363 SDL_ModState = modstate;
364 }
365
366 char *SDL_GetKeyName(SDLKey key)
/* [<][>][^][v][top][bottom][index][help] */
367 {
368 char *keyname;
369
370 keyname = NULL;
371 if ( key < SDLK_LAST ) {
372 keyname = keynames[key];
373 }
374 if ( keyname == NULL ) {
375 keyname = "unknown key";
376 }
377 return(keyname);
378 }
379
380 /* These are global for SDL_eventloop.c */
381 int SDL_PrivateKeyboard(Uint8 state, SDL_keysym *keysym)
/* [<][>][^][v][top][bottom][index][help] */
382 {
383 SDL_Event event;
384 int posted, repeatable;
385 Uint16 modstate;
386
387 memset(&event, 0, sizeof(event));
388
389 #if 0
390 printf("The '%s' key has been %s\n", SDL_GetKeyName(keysym->sym),
391 state == SDL_PRESSED ? "pressed" : "released");
392 #endif
393 /* Set up the keysym */
394 modstate = (Uint16)SDL_ModState;
395
396 repeatable = 0;
397
398 if ( state == SDL_PRESSED ) {
399 keysym->mod = (SDLMod)modstate;
400 switch (keysym->sym) {
401 case SDLK_NUMLOCK:
402 modstate ^= KMOD_NUM;
403 if ( ! (modstate&KMOD_NUM) )
404 state = SDL_RELEASED;
405 keysym->mod = (SDLMod)modstate;
406 break;
407 case SDLK_CAPSLOCK:
408 modstate ^= KMOD_CAPS;
409 if ( ! (modstate&KMOD_CAPS) )
410 state = SDL_RELEASED;
411 keysym->mod = (SDLMod)modstate;
412 break;
413 case SDLK_LCTRL:
414 modstate |= KMOD_LCTRL;
415 break;
416 case SDLK_RCTRL:
417 modstate |= KMOD_RCTRL;
418 break;
419 case SDLK_LSHIFT:
420 modstate |= KMOD_LSHIFT;
421 break;
422 case SDLK_RSHIFT:
423 modstate |= KMOD_RSHIFT;
424 break;
425 case SDLK_LALT:
426 modstate |= KMOD_LALT;
427 break;
428 case SDLK_RALT:
429 modstate |= KMOD_RALT;
430 break;
431 case SDLK_LMETA:
432 modstate |= KMOD_LMETA;
433 break;
434 case SDLK_RMETA:
435 modstate |= KMOD_RMETA;
436 break;
437 case SDLK_MODE:
438 modstate |= KMOD_MODE;
439 break;
440 default:
441 repeatable = 1;
442 break;
443 }
444 } else {
445 switch (keysym->sym) {
446 case SDLK_NUMLOCK:
447 case SDLK_CAPSLOCK:
448 /* Only send keydown events */
449 return(0);
450 case SDLK_LCTRL:
451 modstate &= ~KMOD_LCTRL;
452 break;
453 case SDLK_RCTRL:
454 modstate &= ~KMOD_RCTRL;
455 break;
456 case SDLK_LSHIFT:
457 modstate &= ~KMOD_LSHIFT;
458 break;
459 case SDLK_RSHIFT:
460 modstate &= ~KMOD_RSHIFT;
461 break;
462 case SDLK_LALT:
463 modstate &= ~KMOD_LALT;
464 break;
465 case SDLK_RALT:
466 modstate &= ~KMOD_RALT;
467 break;
468 case SDLK_LMETA:
469 modstate &= ~KMOD_LMETA;
470 break;
471 case SDLK_RMETA:
472 modstate &= ~KMOD_RMETA;
473 break;
474 case SDLK_MODE:
475 modstate &= ~KMOD_MODE;
476 break;
477 default:
478 break;
479 }
480 keysym->mod = (SDLMod)modstate;
481 }
482
483 /* Figure out what type of event this is */
484 switch (state) {
485 case SDL_PRESSED:
486 event.type = SDL_KEYDOWN;
487 break;
488 case SDL_RELEASED:
489 event.type = SDL_KEYUP;
490 /*
491 * jk 991215 - Added
492 */
493 if ( SDL_KeyRepeat.timestamp ) {
494 SDL_KeyRepeat.timestamp = 0;
495 }
496 break;
497 default:
498 /* Invalid state -- bail */
499 return(0);
500 }
501
502 /* Drop events that don't change state */
503 if ( SDL_KeyState[keysym->sym] == state ) {
504 return(0);
505 }
506
507 /* Update internal keyboard state */
508 SDL_ModState = (SDLMod)modstate;
509 SDL_KeyState[keysym->sym] = state;
510
511 /* Post the event, if desired */
512 posted = 0;
513 if ( SDL_ProcessEvents[event.type] == SDL_ENABLE ) {
514 event.key.state = state;
515 event.key.keysym = *keysym;
516 if ( (SDL_EventOK == NULL) || SDL_EventOK(&event) ) {
517 posted = 1;
518 /*
519 * jk 991215 - Added
520 */
521 if (repeatable && (SDL_KeyRepeat.delay != 0)) {
522 SDL_KeyRepeat.evt = event;
523 SDL_KeyRepeat.firsttime = 1;
524 SDL_KeyRepeat.timestamp=SDL_GetTicks();
525 }
526 SDL_PushEvent(&event);
527 }
528 }
529 return(posted);
530 }
531
532 /*
533 * jk 991215 - Added
534 */
535 void SDL_CheckKeyRepeat(void)
/* [<][>][^][v][top][bottom][index][help] */
536 {
537 if ( SDL_KeyRepeat.timestamp ) {
538 Uint32 now, interval;
539
540 now = SDL_GetTicks();
541 interval = (now - SDL_KeyRepeat.timestamp);
542 if ( SDL_KeyRepeat.firsttime ) {
543 if ( interval > (Uint32)SDL_KeyRepeat.delay ) {
544 SDL_KeyRepeat.timestamp = now;
545 SDL_KeyRepeat.firsttime = 0;
546 }
547 } else {
548 if ( interval > (Uint32)SDL_KeyRepeat.interval ) {
549 SDL_KeyRepeat.timestamp = now;
550 SDL_PushEvent(&SDL_KeyRepeat.evt);
551 }
552 }
553 }
554 }
555
556 int SDL_EnableKeyRepeat(int delay, int interval)
/* [<][>][^][v][top][bottom][index][help] */
557 {
558 if ( delay < 0 ) {
559 SDL_SetError("keyboard repeat delay less than zero");
560 return(-1);
561 }
562 SDL_KeyRepeat.firsttime = 0;
563 SDL_KeyRepeat.delay = delay;
564 if ( interval < MINIMUM_REPEAT_INTERVAL ) {
565 SDL_KeyRepeat.interval = MINIMUM_REPEAT_INTERVAL;
566 } else {
567 SDL_KeyRepeat.interval = interval;
568 }
569 SDL_KeyRepeat.timestamp = 0;
570 return(0);
571 }
572