3 * SDL keyboard input support
28 #define KEY_BUFFER_SIZE 16
30 static unsigned char Installed = 0;
32 //-------- Variable accessed by outside functions ---------
33 unsigned char keyd_buffer_type; // 0=No buffer, 1=buffer ASCII, 2=buffer scans
34 unsigned char keyd_repeat;
35 unsigned char keyd_editor_mode;
36 volatile unsigned char keyd_last_pressed;
37 volatile unsigned char keyd_last_released;
38 volatile unsigned char keyd_pressed[256];
39 volatile int keyd_time_when_last_pressed;
41 typedef struct Key_info {
42 ubyte state; // state of key 1 == down, 0 == up
43 ubyte last_state; // previous state of key
44 int counter; // incremented each time key is down in handler
45 fix timewentdown; // simple counter incremented each time in interrupt and key is down
46 fix timehelddown; // counter to tell how long key is down -- gets reset to 0 by key routines
47 ubyte downcount; // number of key counts key was down
48 ubyte upcount; // number of times key was released
51 typedef struct keyboard {
52 unsigned short keybuffer[KEY_BUFFER_SIZE];
54 fix time_pressed[KEY_BUFFER_SIZE];
55 unsigned int keyhead, keytail;
58 static keyboard key_data;
60 typedef struct key_props {
62 unsigned char ascii_value;
63 unsigned char shifted_ascii_value;
67 key_props key_properties[256] = {
69 { "ESC", 255, 255, SDLK_ESCAPE },
70 { "1", '1', '!', SDLK_1 },
71 { "2", '2', '@', SDLK_2 },
72 { "3", '3', '#', SDLK_3 },
73 { "4", '4', '$', SDLK_4 },
74 { "5", '5', '%', SDLK_5 },
75 { "6", '6', '^', SDLK_6 },
76 { "7", '7', '&', SDLK_7 },
77 { "8", '8', '*', SDLK_8 },
78 { "9", '9', '(', SDLK_9 },
79 { "0", '0', ')', SDLK_0 },
80 { "-", '-', '_', SDLK_MINUS },
81 { "=", '=', '+', SDLK_EQUALS },
82 { "BSPC", 255, 255, SDLK_BACKSPACE },
83 { "TAB", 255, 255, SDLK_TAB },
84 { "Q", 'q', 'Q', SDLK_q },
85 { "W", 'w', 'W', SDLK_w },
86 { "E", 'e', 'E', SDLK_e },
87 { "R", 'r', 'R', SDLK_r },
88 { "T", 't', 'T', SDLK_t },
89 { "Y", 'y', 'Y', SDLK_y },
90 { "U", 'u', 'U', SDLK_u },
91 { "I", 'i', 'I', SDLK_i },
92 { "O", 'o', 'O', SDLK_o },
93 { "P", 'p', 'P', SDLK_p },
94 { "[", '[', '{', SDLK_LEFTBRACKET },
95 { "]", ']', '}', SDLK_RIGHTBRACKET },
96 { "RETURN", 255, 255, SDLK_RETURN },
97 { "LCTRL", 255, 255, SDLK_LCTRL },
98 { "A", 'a', 'A', SDLK_a },
99 { "S", 's', 'S', SDLK_s },
100 { "D", 'd', 'D', SDLK_d },
101 { "F", 'f', 'F', SDLK_f },
102 { "G", 'g', 'G', SDLK_g },
103 { "H", 'h', 'H', SDLK_h },
104 { "J", 'j', 'J', SDLK_j },
105 { "K", 'k', 'K', SDLK_k },
106 { "L", 'l', 'L', SDLK_l },
107 { ";", ';', ':', SDLK_SEMICOLON },
108 { "'", '\'', '"', SDLK_QUOTE },
109 { "`", '`', '~', SDLK_BACKQUOTE },
110 { "LSHFT", 255, 255, SDLK_LSHIFT },
111 { "\\", '\\', '|', SDLK_BACKSLASH },
112 { "Z", 'z', 'Z', SDLK_z },
113 { "X", 'x', 'X', SDLK_x },
114 { "C", 'c', 'C', SDLK_c },
115 { "V", 'v', 'V', SDLK_v },
116 { "B", 'b', 'B', SDLK_b },
117 { "N", 'n', 'N', SDLK_n },
118 { "M", 'm', 'M', SDLK_m },
119 { ",", ',', '<', SDLK_COMMA },
120 { ".", '.', '>', SDLK_PERIOD },
121 { "/", '/', '?', SDLK_SLASH },
122 { "RSHFT", 255, 255, SDLK_RSHIFT },
123 { "PAD*", '*', 255, SDLK_KP_MULTIPLY },
124 { "LALT", 255, 255, SDLK_LALT },
125 { "SPC", ' ', ' ', SDLK_SPACE },
126 { "CPSLK", 255, 255, SDLK_CAPSLOCK },
127 { "F1", 255, 255, SDLK_F1 },
128 { "F2", 255, 255, SDLK_F2 },
129 { "F3", 255, 255, SDLK_F3 },
130 { "F4", 255, 255, SDLK_F4 },
131 { "F5", 255, 255, SDLK_F5 },
132 { "F6", 255, 255, SDLK_F6 },
133 { "F7", 255, 255, SDLK_F7 },
134 { "F8", 255, 255, SDLK_F8 },
135 { "F9", 255, 255, SDLK_F9 },
136 { "F10", 255, 255, SDLK_F10 },
137 { "NMLCK", 255, 255, SDLK_NUMLOCK },
138 { "SCLK", 255, 255, SDLK_SCROLLOCK },
139 { "PAD7", 255, 255, SDLK_KP7 },
140 { "PAD8", 255, 255, SDLK_KP8 },
141 { "PAD9", 255, 255, SDLK_KP9 },
142 { "PAD-", 255, 255, SDLK_KP_MINUS },
143 { "PAD4", 255, 255, SDLK_KP4 },
144 { "PAD5", 255, 255, SDLK_KP5 },
145 { "PAD6", 255, 255, SDLK_KP6 },
146 { "PAD+", 255, 255, SDLK_KP_PLUS },
147 { "PAD1", 255, 255, SDLK_KP1 },
148 { "PAD2", 255, 255, SDLK_KP2 },
149 { "PAD3", 255, 255, SDLK_KP3 },
150 { "PAD0", 255, 255, SDLK_KP0 },
151 { "PAD.", 255, 255, SDLK_KP_PERIOD },
152 { "", 255, 255, -1 },
153 { "", 255, 255, -1 },
154 { "", 255, 255, -1 },
155 { "F11", 255, 255, SDLK_F11 },
156 { "F12", 255, 255, SDLK_F12 },
157 { "F13", 255, 255, SDLK_F13 },
158 { "F14", 255, 255, SDLK_F14 },
159 { "F15", 255, 255, SDLK_F15 },
161 { "F16", 255, 255, 0x106A },
162 { "F17", 255, 255, 0x1040 },
163 { "F18", 255, 255, 0x104F },
164 { "F19", 255, 255, 0x1050 },
166 { "", 255, 255, -1 },
167 { "", 255, 255, -1 },
168 { "", 255, 255, -1 },
169 { "", 255, 255, -1 },
171 { "", 255, 255, -1 },
172 { "PAUSE", 255, 255, SDLK_PAUSE },
173 { "", 255, 255, -1 },
174 { "", 255, 255, -1 },
175 { "", 255, 255, -1 },
176 { "", 255, 255, -1 },
177 { "", 255, 255, -1 },
178 { "", 255, 255, -1 },
179 { "", 255, 255, -1 },
180 { "", 255, 255, -1 },
181 { "", 255, 255, -1 },
182 { "", 255, 255, -1 },
183 { "", 255, 255, -1 },
184 { "", 255, 255, -1 },
185 { "", 255, 255, -1 },
186 { "", 255, 255, -1 },
187 { "", 255, 255, -1 },
188 { "", 255, 255, -1 },
189 { "", 255, 255, -1 },
190 { "", 255, 255, -1 },
191 { "", 255, 255, -1 },
192 { "", 255, 255, -1 },
193 { "", 255, 255, -1 },
194 { "", 255, 255, -1 },
195 { "", 255, 255, -1 },
196 { "", 255, 255, -1 },
197 { "", 255, 255, -1 },
198 { "", 255, 255, -1 },
199 { "", 255, 255, -1 },
200 { "", 255, 255, -1 },
201 { "", 255, 255, -1 },
202 { "", 255, 255, -1 },
203 { "", 255, 255, -1 },
204 { "", 255, 255, -1 },
205 { "", 255, 255, -1 },
206 { "", 255, 255, -1 },
207 { "", 255, 255, -1 },
208 { "", 255, 255, -1 },
209 { "", 255, 255, -1 },
210 { "", 255, 255, -1 },
211 { "", 255, 255, -1 },
212 { "", 255, 255, -1 },
213 { "", 255, 255, -1 },
214 { "", 255, 255, -1 },
215 { "", 255, 255, -1 },
216 { "", 255, 255, -1 },
217 { "", 255, 255, -1 },
218 { "", 255, 255, -1 },
219 { "", 255, 255, -1 },
220 { "", 255, 255, -1 },
221 { "", 255, 255, -1 },
222 { "", 255, 255, -1 },
223 { "", 255, 255, -1 },
224 { "", 255, 255, -1 },
225 { "", 255, 255, -1 },
226 { "", 255, 255, -1 },
227 { "", 255, 255, -1 },
228 { "", 255, 255, -1 },
229 { "", 255, 255, -1 },
230 { "PAD=", 255, 255, SDLK_KP_EQUALS },
231 { "ENTER", 255, 255, SDLK_KP_ENTER },
232 { "RCTRL", 255, 255, SDLK_RCTRL },
233 { "LCMD", 255, 255, SDLK_LMETA },
234 { "RCMD", 255, 255, SDLK_RMETA },
235 { "", 255, 255, -1 },
236 { "", 255, 255, -1 },
237 { "", 255, 255, -1 },
238 { "", 255, 255, -1 },
239 { "", 255, 255, -1 },
240 { "", 255, 255, -1 },
241 { "", 255, 255, -1 },
242 { "", 255, 255, -1 },
243 { "", 255, 255, -1 },
244 { "", 255, 255, -1 },
245 { "", 255, 255, -1 },
246 { "", 255, 255, -1 },
247 { "", 255, 255, -1 },
248 { "", 255, 255, -1 },
249 { "", 255, 255, -1 },
250 { "", 255, 255, -1 },
251 { "", 255, 255, -1 },
252 { "", 255, 255, -1 },
253 { "", 255, 255, -1 },
254 { "", 255, 255, -1 },
255 { "", 255, 255, -1 },
256 { "PAD/", 255, 255, SDLK_KP_DIVIDE },
257 { "", 255, 255, -1 },
258 { "PRSCR", 255, 255, SDLK_PRINT },
259 { "RALT", 255, 255, SDLK_RALT },
260 { "", 255, 255, -1 },
261 { "", 255, 255, -1 },
262 { "", 255, 255, -1 },
263 { "", 255, 255, -1 },
264 { "", 255, 255, -1 },
265 { "", 255, 255, -1 },
266 { "", 255, 255, -1 },
267 { "", 255, 255, -1 },
268 { "", 255, 255, -1 },
269 { "", 255, 255, -1 },
270 { "", 255, 255, -1 },
271 { "", 255, 255, -1 },
272 { "", 255, 255, -1 },
273 { "", 255, 255, -1 },
274 { "HOME", 255, 255, SDLK_HOME },
275 { "UP", 255, 255, SDLK_UP },
276 { "PGUP", 255, 255, SDLK_PAGEUP },
277 { "", 255, 255, -1 },
278 { "LEFT", 255, 255, SDLK_LEFT },
279 { "", 255, 255, -1 },
280 { "RIGHT", 255, 255, SDLK_RIGHT },
281 { "", 255, 255, -1 },
282 { "END", 255, 255, SDLK_END },
283 { "DOWN", 255, 255, SDLK_DOWN },
284 { "PGDN", 255, 255, SDLK_PAGEDOWN },
285 { "INS", 255, 255, SDLK_INSERT },
286 { "DEL", 255, 255, SDLK_DELETE },
287 { "", 255, 255, -1 },
288 { "", 255, 255, -1 },
289 { "", 255, 255, -1 },
290 { "", 255, 255, -1 },
291 { "", 255, 255, -1 },
292 { "", 255, 255, -1 },
293 { "", 255, 255, -1 },
294 { "", 255, 255, -1 },
295 { "", 255, 255, -1 },
296 { "", 255, 255, -1 },
297 { "", 255, 255, -1 },
298 { "", 255, 255, -1 },
299 { "", 255, 255, -1 },
300 { "", 255, 255, -1 },
301 { "", 255, 255, -1 },
302 { "", 255, 255, -1 },
303 { "", 255, 255, -1 },
304 { "", 255, 255, -1 },
305 { "", 255, 255, -1 },
306 { "", 255, 255, -1 },
307 { "", 255, 255, -1 },
308 { "", 255, 255, -1 },
309 { "", 255, 255, -1 },
310 { "", 255, 255, -1 },
311 { "", 255, 255, -1 },
312 { "", 255, 255, -1 },
313 { "", 255, 255, -1 },
314 { "", 255, 255, -1 },
315 { "", 255, 255, -1 },
316 { "", 255, 255, -1 },
317 { "", 255, 255, -1 },
318 { "", 255, 255, -1 },
319 { "", 255, 255, -1 },
320 { "", 255, 255, -1 },
321 { "", 255, 255, -1 },
322 { "", 255, 255, -1 },
323 { "", 255, 255, -1 },
324 { "", 255, 255, -1 },
325 { "", 255, 255, -1 },
326 { "", 255, 255, -1 },
327 { "", 255, 255, -1 },
328 { "", 255, 255, -1 },
329 { "", 255, 255, -1 },
330 { "", 255, 255, -1 },
336 unsigned char key_to_ascii(int keycode )
340 shifted = keycode & KEY_SHIFTED;
344 return key_properties[keycode].shifted_ascii_value;
346 return key_properties[keycode].ascii_value;
350 /* The list of keybindings */
351 static char *key_binding_list[256];
354 /* get the action bound to a key, if any */
355 char *key_binding(ubyte keycode)
357 return key_binding_list[keycode];
361 ubyte key_find_binding(char *text)
365 for (i = 0; i < 256; i++)
366 if (key_binding_list[i] && !strncasecmp(key_binding_list[i], text, CMD_MAX_LENGTH))
373 /* Write key bindings to file */
374 void key_write_bindings(CFILE *file)
378 for (i = 0; i < 256; i++)
379 if (key_binding_list[i])
380 PHYSFSX_printf(file, "bind \"%s\" \"%s\"\n", key_text[i], key_binding_list[i]);
385 void key_cmd_bind(int argc, char **argv)
387 char buf[CMD_MAX_LENGTH] = "";
393 con_printf(CON_NORMAL, "key bindings:\n");
394 for (i = 0; i < 256; i++) {
395 if (!key_binding_list[i])
397 con_printf(CON_NORMAL, "%s: %s\n", key_text[i], key_binding_list[i]);
402 for (i = 0; i < 256; i++) {
403 if (!stricmp(argv[1], key_text[i])) {
410 con_printf(CON_CRITICAL, "bind: key %s not found\n", argv[1]);
415 if (key_binding_list[key])
416 con_printf(CON_NORMAL, "%s: %s\n", key_text[key], key_binding_list[key]);
418 con_printf(CON_NORMAL, "%s is unbound\n", key_text[key]);
422 for (i = 2; i < argc; i++) {
424 strncat(buf, " ", CMD_MAX_LENGTH);
425 strncat(buf, argv[i], CMD_MAX_LENGTH);
428 if (key_binding_list[key])
429 d_free(key_binding_list[key]);
430 key_binding_list[key] = d_strdup(buf);
435 void key_cmd_unbind(int argc, char **argv)
439 if (argc < 2 || argc > 2) {
440 cmd_insertf("help %s", argv[0]);
444 for (key = 0; key < 256; key++) {
445 if (!stricmp(argv[1], key_text[key])) {
450 if (key_binding_list[key])
451 d_free(key_binding_list[key]);
452 key_binding_list[key] = NULL;
456 void key_handle_binding(int keycode, int state)
458 if (!key_binding_list[keycode])
464 if (Function_mode != FMODE_GAME)
467 if (con_is_visible())
470 if (!state && key_binding_list[keycode][0] == '+')
471 cmd_appendf("-%s", &key_binding_list[keycode][1]);
473 cmd_append(key_binding_list[keycode]);
477 void key_handler(SDL_KeyboardEvent *event)
479 int i, event_key, key_state;
481 if (event->keysym.sym != SDLK_UNKNOWN)
482 event_key = event->keysym.sym;
484 event_key = 0x1000 | event->keysym.scancode; // hardware scancode, definitions in #ifdefs above
486 key_state = (event->state == SDL_PRESSED);
487 //=====================================================
488 //Here a translation from win keycodes to mac keycodes!
489 //=====================================================
491 for (i = 255; i >= 0; i--) {
492 if (key_properties[i].sym == event_key) {
493 vkey_handler(i, key_state);
499 void vkey_handler(int keycode, int state)
504 key = &(key_data.keys[keycode]);
508 keyd_last_pressed = keycode;
509 keyd_time_when_last_pressed = timer_get_fixed_seconds();
511 if (!keyd_pressed[keycode]) {
513 key_handle_binding(keycode, 1);
514 keyd_pressed[keycode] = 1;
515 key->downcount += state;
517 key->timewentdown = keyd_time_when_last_pressed;
522 key_handle_binding(keycode, 0);
523 keyd_pressed[keycode] = 0;
524 keyd_last_released = keycode;
525 key->upcount += key->state;
528 key->timehelddown += timer_get_fixed_seconds() - key->timewentdown;
531 if ( (state && !key->last_state) || (keyd_repeat && state && key->last_state) ) {
532 if ( keyd_pressed[KEY_LSHIFT] || keyd_pressed[KEY_RSHIFT])
533 keycode |= KEY_SHIFTED;
534 if ( keyd_pressed[KEY_LALT] || keyd_pressed[KEY_RALT])
535 keycode |= KEY_ALTED;
536 if ( keyd_pressed[KEY_LCTRL] || keyd_pressed[KEY_RCTRL])
537 keycode |= KEY_CTRLED;
538 if ( keyd_pressed[KEY_LMETA] || keyd_pressed[KEY_RMETA])
539 keycode |= KEY_METAED;
540 if ( keyd_pressed[KEY_DELETE] )
541 keycode |= KEY_DEBUGGED;
543 temp = key_data.keytail + 1;
544 if ( temp >= KEY_BUFFER_SIZE ) temp=0;
545 if (temp!=key_data.keyhead) {
546 key_data.keybuffer[key_data.keytail] = keycode;
547 key_data.time_pressed[key_data.keytail] = keyd_time_when_last_pressed;
548 key_data.keytail = temp;
551 key->last_state = state;
559 for (i = 0; i < 256; i++)
560 if (key_binding_list[i])
561 d_free(key_binding_list[i]);
563 for (i = 0; i < MOUSE_MAX_BUTTONS; i++) {
564 d_free(key_text[KEY_MB1 + i]);
574 if (Installed) return;
578 keyd_time_when_last_pressed = timer_get_fixed_seconds();
579 keyd_buffer_type = 1;
582 SDL_EnableKeyRepeat(SDL_DEFAULT_REPEAT_DELAY, SDL_DEFAULT_REPEAT_INTERVAL);
585 key_text[i] = key_properties[i].key_text;
587 for (i = 0; i < MOUSE_MAX_BUTTONS; i++) {
589 sprintf(temp, "MB%d", i + 1);
590 key_text[KEY_MB1 + i] = d_strdup(temp);
593 cmd_addcommand("bind", key_cmd_bind, "bind <key> <commands>\n" " bind <commands> to <key>\n"
594 "bind <key>\n" " show the current binding for <key>\n"
595 "bind\n" " show all key bindings\n");
596 cmd_addcommand("unbind", key_cmd_unbind, "unbind <key>\n" " remove binding from <key>\n");
598 // Clear the keyboard array
611 key_data.keyhead = key_data.keytail = 0;
613 //Clear the keyboard buffer
614 for (i=0; i<KEY_BUFFER_SIZE; i++ ) {
615 key_data.keybuffer[i] = 0;
616 key_data.time_pressed[i] = 0;
619 //use gettimeofday here:
620 curtime = timer_get_fixed_seconds();
622 for (i=0; i<256; i++) {
624 key_data.keys[i].state = 1;
625 key_data.keys[i].last_state = 0;
626 key_data.keys[i].timewentdown = curtime;
627 key_data.keys[i].downcount = 0;
628 key_data.keys[i].upcount = 0;
629 key_data.keys[i].timehelddown = 0;
630 key_data.keys[i].counter = 0;
637 if ( n >= KEY_BUFFER_SIZE ) n = 0;
644 int is_one_waiting = 0;
647 if (key_data.keytail != key_data.keyhead)
650 return is_one_waiting;
661 if (key_data.keytail!=key_data.keyhead) {
662 key = key_data.keybuffer[key_data.keyhead];
663 key_data.keyhead = add_one(key_data.keyhead);
671 int key_inkey_time(fix * time)
679 if (key_data.keytail != key_data.keyhead) {
680 key = key_data.keybuffer[key_data.keyhead];
681 *time = key_data.time_pressed[key_data.keyhead];
682 key_data.keyhead = add_one(key_data.keyhead);
693 if (key_data.keytail != key_data.keyhead)
694 key = key_data.keybuffer[key_data.keyhead];
707 while (!key_checkch())
713 unsigned int key_get_shift_status()
715 unsigned int shift_status = 0;
717 if ( keyd_pressed[KEY_LSHIFT] || keyd_pressed[KEY_RSHIFT] )
718 shift_status |= KEY_SHIFTED;
720 if ( keyd_pressed[KEY_LALT] || keyd_pressed[KEY_RALT] )
721 shift_status |= KEY_ALTED;
723 if ( keyd_pressed[KEY_LCTRL] || keyd_pressed[KEY_RCTRL] )
724 shift_status |= KEY_CTRLED;
726 if ( keyd_pressed[KEY_LMETA] || keyd_pressed[KEY_RMETA] )
727 shift_status |= KEY_METAED;
730 if (keyd_pressed[KEY_DELETE])
731 shift_status |=KEY_DEBUGGED;
737 // Returns the number of seconds this key has been down since last call.
738 fix key_down_time(int scancode)
743 if ((scancode<0) || (scancode>255)) return 0;
745 if (!keyd_pressed[scancode]) {
746 time_down = key_data.keys[scancode].timehelddown;
747 key_data.keys[scancode].timehelddown = 0;
749 time = timer_get_fixed_seconds();
750 time_down = time - key_data.keys[scancode].timewentdown;
751 key_data.keys[scancode].timewentdown = time;
757 unsigned int key_down_count(int scancode)
762 if ((scancode<0) || (scancode>255)) return 0;
764 n = key_data.keys[scancode].downcount;
765 key_data.keys[scancode].downcount = 0;
770 unsigned int key_up_count(int scancode)
775 if ((scancode<0) || (scancode>255)) return 0;
777 n = key_data.keys[scancode].upcount;
778 key_data.keys[scancode].upcount = 0;