1 |
/* |
/* |
2 |
rdesktop: A Remote Desktop Protocol client. |
rdesktop: A Remote Desktop Protocol client. |
3 |
User interface services - X keyboard mapping |
User interface services - X keyboard mapping |
4 |
Copyright (C) Matthew Chapman 1999-2001 |
Copyright (C) Matthew Chapman 1999-2002 |
5 |
|
|
6 |
This program is free software; you can redistribute it and/or modify |
This program is free software; you can redistribute it and/or modify |
7 |
it under the terms of the GNU General Public License as published by |
it under the terms of the GNU General Public License as published by |
19 |
*/ |
*/ |
20 |
|
|
21 |
#include <X11/Xlib.h> |
#include <X11/Xlib.h> |
22 |
#include <X11/keysym.h> |
#define XK_MISCELLANY |
23 |
#include <stdio.h> |
#include <X11/keysymdef.h> |
|
#include <stdlib.h> |
|
|
#include <string.h> |
|
24 |
#include <ctype.h> |
#include <ctype.h> |
25 |
#include <limits.h> |
#include <limits.h> |
26 |
|
#include <time.h> |
27 |
#include "rdesktop.h" |
#include "rdesktop.h" |
28 |
#include "scancodes.h" |
#include "scancodes.h" |
29 |
|
|
30 |
#define KEYMAP_SIZE 4096 |
#define KEYMAP_SIZE 0xffff+1 |
31 |
#define KEYMAP_MASK (KEYMAP_SIZE - 1) |
#define KEYMAP_MASK 0xffff |
32 |
#define KEYMAP_MAX_LINE_LENGTH 80 |
#define KEYMAP_MAX_LINE_LENGTH 80 |
33 |
|
|
34 |
extern Display *display; |
extern Display *display; |
36 |
extern int keylayout; |
extern int keylayout; |
37 |
extern BOOL enable_compose; |
extern BOOL enable_compose; |
38 |
|
|
39 |
|
static BOOL keymap_loaded; |
40 |
static key_translation keymap[KEYMAP_SIZE]; |
static key_translation keymap[KEYMAP_SIZE]; |
41 |
static int min_keycode; |
static int min_keycode; |
42 |
static uint16 remote_modifier_state = 0; |
static uint16 remote_modifier_state = 0; |
43 |
|
|
44 |
|
static void update_modifier_state(uint8 scancode, BOOL pressed); |
45 |
|
|
46 |
static void |
static void |
47 |
add_to_keymap(char *keyname, uint8 scancode, uint16 modifiers, char *mapname) |
add_to_keymap(char *keyname, uint8 scancode, uint16 modifiers, char *mapname) |
48 |
{ |
{ |
51 |
keysym = XStringToKeysym(keyname); |
keysym = XStringToKeysym(keyname); |
52 |
if (keysym == NoSymbol) |
if (keysym == NoSymbol) |
53 |
{ |
{ |
54 |
error("Bad keysym %s in keymap %s\n", keyname, mapname); |
warning("Bad keysym %s in keymap %s\n", keyname, mapname); |
55 |
return; |
return; |
56 |
} |
} |
57 |
|
|
69 |
xkeymap_read(char *mapname) |
xkeymap_read(char *mapname) |
70 |
{ |
{ |
71 |
FILE *fp; |
FILE *fp; |
72 |
char line[KEYMAP_MAX_LINE_LENGTH], path[PATH_MAX]; |
char line[KEYMAP_MAX_LINE_LENGTH]; |
73 |
|
char path[PATH_MAX], inplace_path[PATH_MAX]; |
74 |
unsigned int line_num = 0; |
unsigned int line_num = 0; |
75 |
unsigned int line_length = 0; |
unsigned int line_length = 0; |
76 |
char *keyname, *p; |
char *keyname, *p; |
85 |
fp = fopen(path, "r"); |
fp = fopen(path, "r"); |
86 |
if (fp == NULL) |
if (fp == NULL) |
87 |
{ |
{ |
88 |
error("Failed to open keymap %s\n", path); |
/* in case we are running from the source tree */ |
89 |
return False; |
strcpy(inplace_path, "keymaps/"); |
90 |
|
strncat(inplace_path, mapname, sizeof(inplace_path) - sizeof("keymaps/")); |
91 |
|
|
92 |
|
fp = fopen(inplace_path, "r"); |
93 |
|
if (fp == NULL) |
94 |
|
{ |
95 |
|
error("Failed to open keymap %s\n", path); |
96 |
|
return False; |
97 |
|
} |
98 |
} |
} |
99 |
|
|
100 |
/* FIXME: More tolerant on white space */ |
/* FIXME: More tolerant on white space */ |
186 |
MASK_ADD_BITS(modifiers, MapLocalStateMask); |
MASK_ADD_BITS(modifiers, MapLocalStateMask); |
187 |
} |
} |
188 |
|
|
189 |
|
if (strstr(line_rest, "inhibit")) |
190 |
|
{ |
191 |
|
MASK_ADD_BITS(modifiers, MapInhibitMask); |
192 |
|
} |
193 |
|
|
194 |
add_to_keymap(keyname, scancode, modifiers, mapname); |
add_to_keymap(keyname, scancode, modifiers, mapname); |
195 |
|
|
196 |
if (strstr(line_rest, "addupper")) |
if (strstr(line_rest, "addupper")) |
211 |
|
|
212 |
/* Before connecting and creating UI */ |
/* Before connecting and creating UI */ |
213 |
void |
void |
214 |
xkeymap_init1(void) |
xkeymap_init(void) |
215 |
{ |
{ |
216 |
int i; |
unsigned int max_keycode; |
217 |
|
char *mapname_ptr; |
218 |
|
|
219 |
/* Zeroing keymap */ |
/* Make keymapname lowercase */ |
220 |
for (i = 0; i < KEYMAP_SIZE; i++) |
mapname_ptr = keymapname; |
221 |
|
while (*mapname_ptr) |
222 |
{ |
{ |
223 |
keymap[i].scancode = 0; |
*mapname_ptr = tolower(*mapname_ptr); |
224 |
keymap[i].modifiers = 0; |
mapname_ptr++; |
225 |
} |
} |
226 |
|
|
227 |
if (strcmp(keymapname, "none")) |
if (strcmp(keymapname, "none")) |
228 |
{ |
{ |
229 |
xkeymap_read(keymapname); |
if (xkeymap_read(keymapname)) |
230 |
|
keymap_loaded = True; |
231 |
} |
} |
232 |
|
|
233 |
|
XDisplayKeycodes(display, &min_keycode, (int *) &max_keycode); |
234 |
} |
} |
235 |
|
|
236 |
/* After connecting and creating UI */ |
/* Handles, for example, multi-scancode keypresses (which is not |
237 |
void |
possible via keymap-files) */ |
238 |
xkeymap_init2(void) |
BOOL |
239 |
|
handle_special_keys(uint32 keysym, unsigned int state, uint32 ev_time, BOOL pressed) |
240 |
{ |
{ |
241 |
unsigned int max_keycode; |
switch (keysym) |
242 |
XDisplayKeycodes(display, &min_keycode, (int *) &max_keycode); |
{ |
243 |
|
case XK_Return: |
244 |
|
if ((get_key_state(state, XK_Alt_L) || get_key_state(state, XK_Alt_R)) |
245 |
|
&& (get_key_state(state, XK_Control_L) |
246 |
|
|| get_key_state(state, XK_Control_R))) |
247 |
|
{ |
248 |
|
/* Ctrl-Alt-Enter: toggle full screen */ |
249 |
|
if (pressed) |
250 |
|
xwin_toggle_fullscreen(); |
251 |
|
return True; |
252 |
|
} |
253 |
|
break; |
254 |
|
|
255 |
|
case XK_Break: |
256 |
|
/* Send Break sequence E0 46 E0 C6 */ |
257 |
|
if (pressed) |
258 |
|
{ |
259 |
|
rdp_send_scancode(ev_time, RDP_KEYPRESS, |
260 |
|
(SCANCODE_EXTENDED | 0x46)); |
261 |
|
rdp_send_scancode(ev_time, RDP_KEYPRESS, |
262 |
|
(SCANCODE_EXTENDED | 0xc6)); |
263 |
|
} |
264 |
|
/* No release sequence */ |
265 |
|
return True; |
266 |
|
|
267 |
|
case XK_Pause: |
268 |
|
/* According to MS Keyboard Scan Code |
269 |
|
Specification, pressing Pause should result |
270 |
|
in E1 1D 45 E1 9D C5. I'm not exactly sure |
271 |
|
of how this is supposed to be sent via |
272 |
|
RDP. The code below seems to work, but with |
273 |
|
the side effect that Left Ctrl stays |
274 |
|
down. Therefore, we release it when Pause |
275 |
|
is released. */ |
276 |
|
if (pressed) |
277 |
|
{ |
278 |
|
rdp_send_input(ev_time, RDP_INPUT_SCANCODE, RDP_KEYPRESS, 0xe1, 0); |
279 |
|
rdp_send_input(ev_time, RDP_INPUT_SCANCODE, RDP_KEYPRESS, 0x1d, 0); |
280 |
|
rdp_send_input(ev_time, RDP_INPUT_SCANCODE, RDP_KEYPRESS, 0x45, 0); |
281 |
|
rdp_send_input(ev_time, RDP_INPUT_SCANCODE, RDP_KEYPRESS, 0xe1, 0); |
282 |
|
rdp_send_input(ev_time, RDP_INPUT_SCANCODE, RDP_KEYPRESS, 0x9d, 0); |
283 |
|
rdp_send_input(ev_time, RDP_INPUT_SCANCODE, RDP_KEYPRESS, 0xc5, 0); |
284 |
|
} |
285 |
|
else |
286 |
|
{ |
287 |
|
/* Release Left Ctrl */ |
288 |
|
rdp_send_input(ev_time, RDP_INPUT_SCANCODE, RDP_KEYRELEASE, |
289 |
|
0x1d, 0); |
290 |
|
} |
291 |
|
return True; |
292 |
|
|
293 |
|
case XK_Meta_L: /* Windows keys */ |
294 |
|
case XK_Super_L: |
295 |
|
case XK_Hyper_L: |
296 |
|
case XK_Meta_R: |
297 |
|
case XK_Super_R: |
298 |
|
case XK_Hyper_R: |
299 |
|
if (pressed) |
300 |
|
{ |
301 |
|
rdp_send_scancode(ev_time, RDP_KEYPRESS, SCANCODE_CHAR_LCTRL); |
302 |
|
rdp_send_scancode(ev_time, RDP_KEYPRESS, SCANCODE_CHAR_ESC); |
303 |
|
} |
304 |
|
else |
305 |
|
{ |
306 |
|
rdp_send_scancode(ev_time, RDP_KEYRELEASE, SCANCODE_CHAR_ESC); |
307 |
|
rdp_send_scancode(ev_time, RDP_KEYRELEASE, SCANCODE_CHAR_LCTRL); |
308 |
|
} |
309 |
|
return True; |
310 |
|
} |
311 |
|
return False; |
312 |
} |
} |
313 |
|
|
314 |
|
|
315 |
key_translation |
key_translation |
316 |
xkeymap_translate_key(KeySym keysym, unsigned int keycode, unsigned int state) |
xkeymap_translate_key(uint32 keysym, unsigned int keycode, unsigned int state) |
317 |
{ |
{ |
318 |
key_translation tr = { 0, 0 }; |
key_translation tr = { 0, 0 }; |
319 |
|
|
320 |
tr = keymap[keysym & KEYMAP_MASK]; |
tr = keymap[keysym & KEYMAP_MASK]; |
321 |
|
|
322 |
|
if (tr.modifiers & MapInhibitMask) |
323 |
|
{ |
324 |
|
DEBUG_KBD(("Inhibiting key\n")); |
325 |
|
tr.scancode = 0; |
326 |
|
return tr; |
327 |
|
} |
328 |
|
|
329 |
if (tr.modifiers & MapLocalStateMask) |
if (tr.modifiers & MapLocalStateMask) |
330 |
{ |
{ |
331 |
/* The modifiers to send for this key should be obtained |
/* The modifiers to send for this key should be obtained |
338 |
|
|
339 |
if (tr.scancode != 0) |
if (tr.scancode != 0) |
340 |
{ |
{ |
341 |
DEBUG_KBD |
DEBUG_KBD(("Found key translation, scancode=0x%x, modifiers=0x%x\n", |
342 |
(("Found key translation, scancode=0x%x, modifiers=0x%x\n", |
tr.scancode, tr.modifiers)); |
|
tr.scancode, tr.modifiers)); |
|
343 |
return tr; |
return tr; |
344 |
} |
} |
345 |
|
|
346 |
fprintf(stderr, "No translation for (keysym 0x%lx, %s)\n", keysym, get_ksname(keysym)); |
if (keymap_loaded) |
347 |
|
warning("No translation for (keysym 0x%lx, %s)\n", keysym, get_ksname(keysym)); |
348 |
|
|
349 |
/* not in keymap, try to interpret the raw scancode */ |
/* not in keymap, try to interpret the raw scancode */ |
350 |
if ((keycode >= min_keycode) && (keycode <= 0x60)) |
if ((keycode >= min_keycode) && (keycode <= 0x60)) |
351 |
{ |
{ |
352 |
tr.scancode = keycode - min_keycode; |
tr.scancode = keycode - min_keycode; |
353 |
fprintf(stderr, "Sending guessed scancode 0x%x\n", tr.scancode); |
|
354 |
|
/* The modifiers to send for this key should be |
355 |
|
obtained from the local state. Currently, only |
356 |
|
shift is implemented. */ |
357 |
|
if (state & ShiftMask) |
358 |
|
{ |
359 |
|
tr.modifiers = MapLeftShiftMask; |
360 |
|
} |
361 |
|
|
362 |
|
DEBUG_KBD(("Sending guessed scancode 0x%x\n", tr.scancode)); |
363 |
} |
} |
364 |
else |
else |
365 |
{ |
{ |
366 |
fprintf(stderr, "No good guess for keycode 0x%x found\n", keycode); |
DEBUG_KBD(("No good guess for keycode 0x%x found\n", keycode)); |
367 |
} |
} |
368 |
|
|
369 |
return tr; |
return tr; |
390 |
} |
} |
391 |
|
|
392 |
char * |
char * |
393 |
get_ksname(KeySym keysym) |
get_ksname(uint32 keysym) |
394 |
{ |
{ |
395 |
char *ksname = NULL; |
char *ksname = NULL; |
396 |
|
|
402 |
return ksname; |
return ksname; |
403 |
} |
} |
404 |
|
|
|
BOOL |
|
|
inhibit_key(KeySym keysym) |
|
|
{ |
|
|
switch (keysym) |
|
|
{ |
|
|
case XK_Caps_Lock: |
|
|
return True; |
|
|
break; |
|
|
case XK_Multi_key: |
|
|
return True; |
|
|
break; |
|
|
default: |
|
|
break; |
|
|
} |
|
|
return False; |
|
|
} |
|
405 |
|
|
406 |
void |
void |
407 |
ensure_remote_modifiers(uint32 ev_time, key_translation tr) |
ensure_remote_modifiers(uint32 ev_time, key_translation tr) |
423 |
break; |
break; |
424 |
} |
} |
425 |
|
|
426 |
/* Shift */ |
/* Shift. Left shift and right shift are treated as equal; either is fine. */ |
427 |
if (MASK_HAS_BITS(tr.modifiers, MapShiftMask) |
if (MASK_HAS_BITS(tr.modifiers, MapShiftMask) |
428 |
!= MASK_HAS_BITS(remote_modifier_state, MapShiftMask)) |
!= MASK_HAS_BITS(remote_modifier_state, MapShiftMask)) |
429 |
{ |
{ |
430 |
/* The remote modifier state is not correct */ |
/* The remote modifier state is not correct */ |
431 |
if (MASK_HAS_BITS(tr.modifiers, MapShiftMask)) |
if (MASK_HAS_BITS(tr.modifiers, MapLeftShiftMask)) |
432 |
{ |
{ |
433 |
/* Needs this modifier. Send down. */ |
/* Needs left shift. Send down. */ |
434 |
rdp_send_scancode(ev_time, RDP_KEYPRESS, SCANCODE_CHAR_LSHIFT); |
rdp_send_scancode(ev_time, RDP_KEYPRESS, SCANCODE_CHAR_LSHIFT); |
435 |
} |
} |
436 |
|
else if (MASK_HAS_BITS(tr.modifiers, MapRightShiftMask)) |
437 |
|
{ |
438 |
|
/* Needs right shift. Send down. */ |
439 |
|
rdp_send_scancode(ev_time, RDP_KEYPRESS, SCANCODE_CHAR_RSHIFT); |
440 |
|
} |
441 |
else |
else |
442 |
{ |
{ |
443 |
/* Should not use this modifier. Send up. */ |
/* Should not use this modifier. Send up for shift currently pressed. */ |
444 |
rdp_send_scancode(ev_time, RDP_KEYRELEASE, SCANCODE_CHAR_LSHIFT); |
if (MASK_HAS_BITS(remote_modifier_state, MapLeftShiftMask)) |
445 |
|
/* Left shift is down */ |
446 |
|
rdp_send_scancode(ev_time, RDP_KEYRELEASE, SCANCODE_CHAR_LSHIFT); |
447 |
|
else |
448 |
|
/* Right shift is down */ |
449 |
|
rdp_send_scancode(ev_time, RDP_KEYRELEASE, SCANCODE_CHAR_RSHIFT); |
450 |
} |
} |
451 |
} |
} |
452 |
|
|
472 |
!= MASK_HAS_BITS(remote_modifier_state, MapNumLockMask)) |
!= MASK_HAS_BITS(remote_modifier_state, MapNumLockMask)) |
473 |
{ |
{ |
474 |
/* The remote modifier state is not correct */ |
/* The remote modifier state is not correct */ |
475 |
DEBUG_KBD(("Remote NumLock state is incorrect. Toggling\n")); |
uint16 new_remote_state = 0; |
476 |
|
|
477 |
if (MASK_HAS_BITS(tr.modifiers, MapNumLockMask)) |
if (MASK_HAS_BITS(tr.modifiers, MapNumLockMask)) |
478 |
{ |
{ |
479 |
/* Needs this modifier. Toggle */ |
DEBUG_KBD(("Remote NumLock state is incorrect, activating NumLock.\n")); |
480 |
rdp_send_scancode(ev_time, RDP_KEYPRESS, SCANCODE_CHAR_NUMLOCK); |
new_remote_state |= KBD_FLAG_NUMLOCK; |
|
rdp_send_scancode(ev_time, RDP_KEYRELEASE, SCANCODE_CHAR_NUMLOCK); |
|
481 |
} |
} |
482 |
else |
else |
483 |
{ |
{ |
484 |
/* Should not use this modifier. Toggle */ |
DEBUG_KBD(("Remote NumLock state is incorrect, deactivating NumLock.\n")); |
|
rdp_send_scancode(ev_time, RDP_KEYPRESS, SCANCODE_CHAR_NUMLOCK); |
|
|
rdp_send_scancode(ev_time, RDP_KEYRELEASE, SCANCODE_CHAR_NUMLOCK); |
|
485 |
} |
} |
486 |
|
|
487 |
|
rdp_send_input(0, RDP_INPUT_SYNCHRONIZE, 0, new_remote_state, 0); |
488 |
|
update_modifier_state(SCANCODE_CHAR_NUMLOCK, True); |
489 |
} |
} |
490 |
|
} |
491 |
|
|
492 |
|
|
493 |
|
void |
494 |
|
reset_modifier_keys(unsigned int state) |
495 |
|
{ |
496 |
|
/* reset keys */ |
497 |
|
uint32 ev_time; |
498 |
|
ev_time = time(NULL); |
499 |
|
|
500 |
|
if (MASK_HAS_BITS(remote_modifier_state, MapLeftShiftMask) |
501 |
|
&& !get_key_state(state, XK_Shift_L)) |
502 |
|
rdp_send_scancode(ev_time, RDP_KEYRELEASE, SCANCODE_CHAR_LSHIFT); |
503 |
|
|
504 |
|
if (MASK_HAS_BITS(remote_modifier_state, MapRightShiftMask) |
505 |
|
&& !get_key_state(state, XK_Shift_R)) |
506 |
|
rdp_send_scancode(ev_time, RDP_KEYRELEASE, SCANCODE_CHAR_RSHIFT); |
507 |
|
|
508 |
|
if (MASK_HAS_BITS(remote_modifier_state, MapLeftCtrlMask) |
509 |
|
&& !get_key_state(state, XK_Control_L)) |
510 |
|
rdp_send_scancode(ev_time, RDP_KEYRELEASE, SCANCODE_CHAR_LCTRL); |
511 |
|
|
512 |
|
if (MASK_HAS_BITS(remote_modifier_state, MapRightCtrlMask) |
513 |
|
&& !get_key_state(state, XK_Control_R)) |
514 |
|
rdp_send_scancode(ev_time, RDP_KEYRELEASE, SCANCODE_CHAR_RCTRL); |
515 |
|
|
516 |
|
if (MASK_HAS_BITS(remote_modifier_state, MapLeftAltMask) && !get_key_state(state, XK_Alt_L)) |
517 |
|
rdp_send_scancode(ev_time, RDP_KEYRELEASE, SCANCODE_CHAR_LALT); |
518 |
|
|
519 |
|
if (MASK_HAS_BITS(remote_modifier_state, MapRightAltMask) && |
520 |
|
!get_key_state(state, XK_Alt_R) && !get_key_state(state, XK_Mode_switch)) |
521 |
|
rdp_send_scancode(ev_time, RDP_KEYRELEASE, SCANCODE_CHAR_RALT); |
522 |
} |
} |
523 |
|
|
524 |
|
|
525 |
static void |
static void |
526 |
update_modifier_state(uint16 modifiers, BOOL pressed) |
update_modifier_state(uint8 scancode, BOOL pressed) |
527 |
{ |
{ |
528 |
#ifdef WITH_DEBUG_KBD |
#ifdef WITH_DEBUG_KBD |
529 |
uint16 old_modifier_state; |
uint16 old_modifier_state; |
531 |
old_modifier_state = remote_modifier_state; |
old_modifier_state = remote_modifier_state; |
532 |
#endif |
#endif |
533 |
|
|
534 |
switch (modifiers) |
switch (scancode) |
535 |
{ |
{ |
536 |
case SCANCODE_CHAR_LSHIFT: |
case SCANCODE_CHAR_LSHIFT: |
537 |
MASK_CHANGE_BIT(remote_modifier_state, MapLeftShiftMask, pressed); |
MASK_CHANGE_BIT(remote_modifier_state, MapLeftShiftMask, pressed); |
585 |
|
|
586 |
/* Send keyboard input */ |
/* Send keyboard input */ |
587 |
void |
void |
588 |
rdp_send_scancode(uint32 time, uint16 flags, uint16 scancode) |
rdp_send_scancode(uint32 time, uint16 flags, uint8 scancode) |
589 |
{ |
{ |
590 |
update_modifier_state(scancode, !(flags & RDP_KEYRELEASE)); |
update_modifier_state(scancode, !(flags & RDP_KEYRELEASE)); |
591 |
|
|