FreeRDP
Loading...
Searching...
No Matches
xf_keyboard.c
1
20#include <freerdp/config.h>
21
22#include <ctype.h>
23#include <stdio.h>
24#include <stdlib.h>
25#include <string.h>
26#include <stdint.h>
27
28#include <winpr/crt.h>
29#include <winpr/path.h>
30#include <winpr/assert.h>
31#include <winpr/cast.h>
32#include <winpr/collections.h>
33
34#include <freerdp/utils/string.h>
35
36#include <X11/Xlib.h>
37#include <X11/Xutil.h>
38#include <X11/keysym.h>
39#include <X11/XKBlib.h>
40
41#include <freerdp/locale/keyboard.h>
42#include <freerdp/locale/locale.h>
43
44#include "xf_event.h"
45
46#include "xf_keyboard.h"
47
48#include "xf_utils.h"
49#include "keyboard_x11.h"
50
51#include <freerdp/log.h>
52#define TAG CLIENT_TAG("x11")
53
54typedef struct
55{
56 BOOL Shift;
57 BOOL LeftShift;
58 BOOL RightShift;
59 BOOL Alt;
60 BOOL LeftAlt;
61 BOOL RightAlt;
62 BOOL Ctrl;
63 BOOL LeftCtrl;
64 BOOL RightCtrl;
65 BOOL Super;
66 BOOL LeftSuper;
67 BOOL RightSuper;
68} XF_MODIFIER_KEYS;
69
70struct x11_key_scancode_t
71{
72 const char* name;
73 DWORD sc;
74};
75
76static const struct x11_key_scancode_t XKB_KEY_NAME_SCANCODE_TABLE[] = {
77 { "", RDP_SCANCODE_UNKNOWN }, /* 008: [(null)] */
78 { "ESC", RDP_SCANCODE_ESCAPE }, /* 009: ESC [Escape] */
79 { "AE01", RDP_SCANCODE_KEY_1 }, /* 010: AE01 [1] */
80 { "AE02", RDP_SCANCODE_KEY_2 }, /* 011: AE02 [2] */
81 { "AE03", RDP_SCANCODE_KEY_3 }, /* 012: AE03 [3] */
82 { "AE04", RDP_SCANCODE_KEY_4 }, /* 013: AE04 [4] */
83 { "AE05", RDP_SCANCODE_KEY_5 }, /* 014: AE05 [5] */
84 { "AE06", RDP_SCANCODE_KEY_6 }, /* 015: AE06 [6] */
85 { "AE07", RDP_SCANCODE_KEY_7 }, /* 016: AE07 [7] */
86 { "AE08", RDP_SCANCODE_KEY_8 }, /* 017: AE08 [8] */
87 { "AE09", RDP_SCANCODE_KEY_9 }, /* 018: AE09 [9] */
88 { "AE10", RDP_SCANCODE_KEY_0 }, /* 019: AE10 [0] */
89 { "AE11", RDP_SCANCODE_OEM_MINUS }, /* 020: AE11 [minus] */
90 { "AE12", RDP_SCANCODE_OEM_PLUS }, /* 021: AE12 [equal] */
91 { "BKSP", RDP_SCANCODE_BACKSPACE }, /* 022: BKSP [BackSpace] */
92 { "TAB", RDP_SCANCODE_TAB }, /* 023: TAB [Tab] */
93 { "AD01", RDP_SCANCODE_KEY_Q }, /* 024: AD01 [q] */
94 { "AD02", RDP_SCANCODE_KEY_W }, /* 025: AD02 [w] */
95 { "AD03", RDP_SCANCODE_KEY_E }, /* 026: AD03 [e] */
96 { "AD04", RDP_SCANCODE_KEY_R }, /* 027: AD04 [r] */
97 { "AD05", RDP_SCANCODE_KEY_T }, /* 028: AD05 [t] */
98 { "AD06", RDP_SCANCODE_KEY_Y }, /* 029: AD06 [y] */
99 { "AD07", RDP_SCANCODE_KEY_U }, /* 030: AD07 [u] */
100 { "AD08", RDP_SCANCODE_KEY_I }, /* 031: AD08 [i] */
101 { "AD09", RDP_SCANCODE_KEY_O }, /* 032: AD09 [o] */
102 { "AD10", RDP_SCANCODE_KEY_P }, /* 033: AD10 [p] */
103 { "AD11", RDP_SCANCODE_OEM_4 }, /* 034: AD11 [bracketleft] */
104 { "AD12", RDP_SCANCODE_OEM_6 }, /* 035: AD12 [bracketright] */
105 { "RTRN", RDP_SCANCODE_RETURN }, /* 036: RTRN [Return] */
106 { "LCTL", RDP_SCANCODE_LCONTROL }, /* 037: LCTL [Control_L] */
107 { "AC01", RDP_SCANCODE_KEY_A }, /* 038: AC01 [a] */
108 { "AC02", RDP_SCANCODE_KEY_S }, /* 039: AC02 [s] */
109 { "AC03", RDP_SCANCODE_KEY_D }, /* 040: AC03 [d] */
110 { "AC04", RDP_SCANCODE_KEY_F }, /* 041: AC04 [f] */
111 { "AC05", RDP_SCANCODE_KEY_G }, /* 042: AC05 [g] */
112 { "AC06", RDP_SCANCODE_KEY_H }, /* 043: AC06 [h] */
113 { "AC07", RDP_SCANCODE_KEY_J }, /* 044: AC07 [j] */
114 { "AC08", RDP_SCANCODE_KEY_K }, /* 045: AC08 [k] */
115 { "AC09", RDP_SCANCODE_KEY_L }, /* 046: AC09 [l] */
116 { "AC10", RDP_SCANCODE_OEM_1 }, /* 047: AC10 [semicolon] */
117 { "AC11", RDP_SCANCODE_OEM_7 }, /* 048: AC11 [dead_acute] */
118 { "TLDE", RDP_SCANCODE_OEM_3 }, /* 049: TLDE [dead_grave] */
119 { "LFSH", RDP_SCANCODE_LSHIFT }, /* 050: LFSH [Shift_L] */
120 { "BKSL", RDP_SCANCODE_OEM_5 }, /* 051: BKSL [backslash] */
121 { "AB01", RDP_SCANCODE_KEY_Z }, /* 052: AB01 [z] */
122 { "AB02", RDP_SCANCODE_KEY_X }, /* 053: AB02 [x] */
123 { "AB03", RDP_SCANCODE_KEY_C }, /* 054: AB03 [c] */
124 { "AB04", RDP_SCANCODE_KEY_V }, /* 055: AB04 [v] */
125 { "AB05", RDP_SCANCODE_KEY_B }, /* 056: AB05 [b] */
126 { "AB06", RDP_SCANCODE_KEY_N }, /* 057: AB06 [n] */
127 { "AB07", RDP_SCANCODE_KEY_M }, /* 058: AB07 [m] */
128 { "AB08", RDP_SCANCODE_OEM_COMMA }, /* 059: AB08 [comma] */
129 { "AB09", RDP_SCANCODE_OEM_PERIOD }, /* 060: AB09 [period] */
130 { "AB10", RDP_SCANCODE_OEM_2 }, /* 061: AB10 [slash] */
131 { "RTSH", RDP_SCANCODE_RSHIFT }, /* 062: RTSH [Shift_R] */
132 { "KPMU", RDP_SCANCODE_MULTIPLY }, /* 063: KPMU [KP_Multiply] */
133 { "LALT", RDP_SCANCODE_LMENU }, /* 064: LALT [Alt_L] */
134 { "SPCE", RDP_SCANCODE_SPACE }, /* 065: SPCE [space] */
135 { "CAPS", RDP_SCANCODE_CAPSLOCK }, /* 066: CAPS [Caps_Lock] */
136 { "FK01", RDP_SCANCODE_F1 }, /* 067: FK01 [F1] */
137 { "FK02", RDP_SCANCODE_F2 }, /* 068: FK02 [F2] */
138 { "FK03", RDP_SCANCODE_F3 }, /* 069: FK03 [F3] */
139 { "FK04", RDP_SCANCODE_F4 }, /* 070: FK04 [F4] */
140 { "FK05", RDP_SCANCODE_F5 }, /* 071: FK05 [F5] */
141 { "FK06", RDP_SCANCODE_F6 }, /* 072: FK06 [F6] */
142 { "FK07", RDP_SCANCODE_F7 }, /* 073: FK07 [F7] */
143 { "FK08", RDP_SCANCODE_F8 }, /* 074: FK08 [F8] */
144 { "FK09", RDP_SCANCODE_F9 }, /* 075: FK09 [F9] */
145 { "FK10", RDP_SCANCODE_F10 }, /* 076: FK10 [F10] */
146 { "NMLK", RDP_SCANCODE_NUMLOCK }, /* 077: NMLK [Num_Lock] */
147 { "SCLK", RDP_SCANCODE_SCROLLLOCK }, /* 078: SCLK [Multi_key] */
148 { "KP7", RDP_SCANCODE_NUMPAD7 }, /* 079: KP7 [KP_Home] */
149 { "KP8", RDP_SCANCODE_NUMPAD8 }, /* 080: KP8 [KP_Up] */
150 { "KP9", RDP_SCANCODE_NUMPAD9 }, /* 081: KP9 [KP_Prior] */
151 { "KPSU", RDP_SCANCODE_SUBTRACT }, /* 082: KPSU [KP_Subtract] */
152 { "KP4", RDP_SCANCODE_NUMPAD4 }, /* 083: KP4 [KP_Left] */
153 { "KP5", RDP_SCANCODE_NUMPAD5 }, /* 084: KP5 [KP_Begin] */
154 { "KP6", RDP_SCANCODE_NUMPAD6 }, /* 085: KP6 [KP_Right] */
155 { "KPAD", RDP_SCANCODE_ADD }, /* 086: KPAD [KP_Add] */
156 { "KP1", RDP_SCANCODE_NUMPAD1 }, /* 087: KP1 [KP_End] */
157 { "KP2", RDP_SCANCODE_NUMPAD2 }, /* 088: KP2 [KP_Down] */
158 { "KP3", RDP_SCANCODE_NUMPAD3 }, /* 089: KP3 [KP_Next] */
159 { "KP0", RDP_SCANCODE_NUMPAD0 }, /* 090: KP0 [KP_Insert] */
160 { "KPDL", RDP_SCANCODE_DECIMAL }, /* 091: KPDL [KP_Delete] */
161 { "LVL3", RDP_SCANCODE_RMENU }, /* 092: LVL3 [ISO_Level3_Shift] */
162 { "", RDP_SCANCODE_UNKNOWN }, /* 093: [(null)] */
163 { "LSGT", RDP_SCANCODE_OEM_102 }, /* 094: LSGT [backslash] */
164 { "FK11", RDP_SCANCODE_F11 }, /* 095: FK11 [F11] */
165 { "FK12", RDP_SCANCODE_F12 }, /* 096: FK12 [F12] */
166 { "AB11", RDP_SCANCODE_ABNT_C1 }, /* 097: AB11 [(null)] */
167 { "KATA", RDP_SCANCODE_KANA_HANGUL }, /* 098: KATA [Katakana] */
168 { "HIRA", RDP_SCANCODE_HIRAGANA }, /* 099: HIRA [Hiragana] */
169 { "HENK", RDP_SCANCODE_CONVERT_JP }, /* 100: HENK [Henkan_Mode] */
170 { "HKTG", RDP_SCANCODE_HIRAGANA }, /* 101: HKTG [Hiragana_Katakana] */
171 { "MUHE", RDP_SCANCODE_NONCONVERT_JP }, /* 102: MUHE [Muhenkan] */
172 { "JPCM", RDP_SCANCODE_UNKNOWN }, /* 103: JPCM [(null)] */
173 { "KPEN", RDP_SCANCODE_RETURN_KP }, /* 104: KPEN [KP_Enter] */
174 { "RCTL", RDP_SCANCODE_RCONTROL }, /* 105: RCTL [Control_R] */
175 { "KPDV", RDP_SCANCODE_DIVIDE }, /* 106: KPDV [KP_Divide] */
176 { "PRSC", RDP_SCANCODE_PRINTSCREEN }, /* 107: PRSC [Print] */
177 { "RALT", RDP_SCANCODE_RMENU }, /* 108: RALT [ISO_Level3_Shift] */
178 { "LNFD", RDP_SCANCODE_UNKNOWN }, /* 109: LNFD [Linefeed] */
179 { "HOME", RDP_SCANCODE_HOME }, /* 110: HOME [Home] */
180 { "UP", RDP_SCANCODE_UP }, /* 111: UP [Up] */
181 { "PGUP", RDP_SCANCODE_PRIOR }, /* 112: PGUP [Prior] */
182 { "LEFT", RDP_SCANCODE_LEFT }, /* 113: LEFT [Left] */
183 { "RGHT", RDP_SCANCODE_RIGHT }, /* 114: RGHT [Right] */
184 { "END", RDP_SCANCODE_END }, /* 115: END [End] */
185 { "DOWN", RDP_SCANCODE_DOWN }, /* 116: DOWN [Down] */
186 { "PGDN", RDP_SCANCODE_NEXT }, /* 117: PGDN [Next] */
187 { "INS", RDP_SCANCODE_INSERT }, /* 118: INS [Insert] */
188 { "DELE", RDP_SCANCODE_DELETE }, /* 119: DELE [Delete] */
189 { "I120", RDP_SCANCODE_UNKNOWN }, /* 120: I120 [(null)] */
190 { "MUTE", RDP_SCANCODE_VOLUME_MUTE }, /* 121: MUTE [XF86AudioMute] */
191 { "VOL-", RDP_SCANCODE_VOLUME_DOWN }, /* 122: VOL- [XF86AudioLowerVolume] */
192 { "VOL+", RDP_SCANCODE_VOLUME_UP }, /* 123: VOL+ [XF86AudioRaiseVolume] */
193 { "POWR", RDP_SCANCODE_UNKNOWN }, /* 124: POWR [XF86PowerOff] */
194 { "KPEQ", RDP_SCANCODE_UNKNOWN }, /* 125: KPEQ [KP_Equal] */
195 { "I126", RDP_SCANCODE_UNKNOWN }, /* 126: I126 [plusminus] */
196 { "PAUS", RDP_SCANCODE_PAUSE }, /* 127: PAUS [Pause] */
197 { "I128", RDP_SCANCODE_LAUNCH_MEDIA_SELECT }, /* 128: I128 [XF86LaunchA] */
198 { "I129", RDP_SCANCODE_ABNT_C2 }, /* 129: I129 [KP_Decimal] */
199 { "HNGL", RDP_SCANCODE_HANGUL }, /* 130: HNGL [Hangul] */
200 { "HJCV", RDP_SCANCODE_HANJA }, /* 131: HJCV [Hangul_Hanja] */
201 { "AE13", RDP_SCANCODE_BACKSLASH_JP }, /* 132: AE13 [(null)] */
202 { "LWIN", RDP_SCANCODE_LWIN }, /* 133: LWIN [Super_L] */
203 { "RWIN", RDP_SCANCODE_RWIN }, /* 134: RWIN [Super_R] */
204 { "COMP", RDP_SCANCODE_APPS }, /* 135: COMP [Menu] */
205 { "STOP", RDP_SCANCODE_BROWSER_STOP }, /* 136: STOP [Cancel] */
206 { "AGAI", RDP_SCANCODE_UNKNOWN }, /* 137: AGAI [Redo] */
207 { "PROP", RDP_SCANCODE_UNKNOWN }, /* 138: PROP [SunProps] */
208 { "UNDO", RDP_SCANCODE_UNKNOWN }, /* 139: UNDO [Undo] */
209 { "FRNT", RDP_SCANCODE_UNKNOWN }, /* 140: FRNT [SunFront] */
210 { "COPY", RDP_SCANCODE_UNKNOWN }, /* 141: COPY [XF86Copy] */
211 { "OPEN", RDP_SCANCODE_UNKNOWN }, /* 142: OPEN [XF86Open] */
212 { "PAST", RDP_SCANCODE_UNKNOWN }, /* 143: PAST [XF86Paste] */
213 { "FIND", RDP_SCANCODE_UNKNOWN }, /* 144: FIND [Find] */
214 { "CUT", RDP_SCANCODE_UNKNOWN }, /* 145: CUT [XF86Cut] */
215 { "HELP", RDP_SCANCODE_HELP }, /* 146: HELP [Help] */
216 { "I147", RDP_SCANCODE_UNKNOWN }, /* 147: I147 [XF86MenuKB] */
217 { "I148", RDP_SCANCODE_UNKNOWN }, /* 148: I148 [XF86Calculator] */
218 { "I149", RDP_SCANCODE_UNKNOWN }, /* 149: I149 [(null)] */
219 { "I150", RDP_SCANCODE_SLEEP }, /* 150: I150 [XF86Sleep] */
220 { "I151", RDP_SCANCODE_UNKNOWN }, /* 151: I151 [XF86WakeUp] */
221 { "I152", RDP_SCANCODE_UNKNOWN }, /* 152: I152 [XF86Explorer] */
222 { "I153", RDP_SCANCODE_UNKNOWN }, /* 153: I153 [XF86Send] */
223 { "I154", RDP_SCANCODE_UNKNOWN }, /* 154: I154 [(null)] */
224 { "I155", RDP_SCANCODE_UNKNOWN }, /* 155: I155 [XF86Xfer] */
225 { "I156", RDP_SCANCODE_LAUNCH_APP1 }, /* 156: I156 [XF86Launch1] */
226 { "I157", RDP_SCANCODE_LAUNCH_APP2 }, /* 157: I157 [XF86Launch2] */
227 { "I158", RDP_SCANCODE_BROWSER_HOME }, /* 158: I158 [XF86WWW] */
228 { "I159", RDP_SCANCODE_UNKNOWN }, /* 159: I159 [XF86DOS] */
229 { "I160", RDP_SCANCODE_UNKNOWN }, /* 160: I160 [XF86ScreenSaver] */
230 { "I161", RDP_SCANCODE_UNKNOWN }, /* 161: I161 [XF86RotateWindows] */
231 { "I162", RDP_SCANCODE_UNKNOWN }, /* 162: I162 [XF86TaskPane] */
232 { "I163", RDP_SCANCODE_LAUNCH_MAIL }, /* 163: I163 [XF86Mail] */
233 { "I164", RDP_SCANCODE_BROWSER_FAVORITES }, /* 164: I164 [XF86Favorites] */
234 { "I165", RDP_SCANCODE_UNKNOWN }, /* 165: I165 [XF86MyComputer] */
235 { "I166", RDP_SCANCODE_BROWSER_BACK }, /* 166: I166 [XF86Back] */
236 { "I167", RDP_SCANCODE_BROWSER_FORWARD }, /* 167: I167 [XF86Forward] */
237 { "I168", RDP_SCANCODE_UNKNOWN }, /* 168: I168 [(null)] */
238 { "I169", RDP_SCANCODE_UNKNOWN }, /* 169: I169 [XF86Eject] */
239 { "I170", RDP_SCANCODE_UNKNOWN }, /* 170: I170 [XF86Eject] */
240 { "I171", RDP_SCANCODE_MEDIA_NEXT_TRACK }, /* 171: I171 [XF86AudioNext] */
241 { "I172", RDP_SCANCODE_MEDIA_PLAY_PAUSE }, /* 172: I172 [XF86AudioPlay] */
242 { "I173", RDP_SCANCODE_MEDIA_PREV_TRACK }, /* 173: I173 [XF86AudioPrev] */
243 { "I174", RDP_SCANCODE_MEDIA_STOP }, /* 174: I174 [XF86AudioStop] */
244 { "I175", RDP_SCANCODE_UNKNOWN }, /* 175: I175 [XF86AudioRecord] */
245 { "I176", RDP_SCANCODE_UNKNOWN }, /* 176: I176 [XF86AudioRewind] */
246 { "I177", RDP_SCANCODE_UNKNOWN }, /* 177: I177 [XF86Phone] */
247 { "I178", RDP_SCANCODE_UNKNOWN }, /* 178: I178 [(null)] */
248 { "I179", RDP_SCANCODE_UNKNOWN }, /* 179: I179 [XF86Tools] */
249 { "I180", RDP_SCANCODE_BROWSER_HOME }, /* 180: I180 [XF86HomePage] */
250 { "I181", RDP_SCANCODE_BROWSER_REFRESH }, /* 181: I181 [XF86Reload] */
251 { "I182", RDP_SCANCODE_UNKNOWN }, /* 182: I182 [XF86Close] */
252 { "I183", RDP_SCANCODE_UNKNOWN }, /* 183: I183 [(null)] */
253 { "I184", RDP_SCANCODE_UNKNOWN }, /* 184: I184 [(null)] */
254 { "I185", RDP_SCANCODE_UNKNOWN }, /* 185: I185 [XF86ScrollUp] */
255 { "I186", RDP_SCANCODE_UNKNOWN }, /* 186: I186 [XF86ScrollDown] */
256 { "I187", RDP_SCANCODE_UNKNOWN }, /* 187: I187 [parenleft] */
257 { "I188", RDP_SCANCODE_UNKNOWN }, /* 188: I188 [parenright] */
258 { "I189", RDP_SCANCODE_UNKNOWN }, /* 189: I189 [XF86New] */
259 { "I190", RDP_SCANCODE_UNKNOWN }, /* 190: I190 [Redo] */
260 { "FK13", RDP_SCANCODE_F13 }, /* 191: FK13 [XF86Tools] */
261 { "FK14", RDP_SCANCODE_F14 }, /* 192: FK14 [XF86Launch5] */
262 { "FK15", RDP_SCANCODE_F15 }, /* 193: FK15 [XF86Launch6] */
263 { "FK16", RDP_SCANCODE_F16 }, /* 194: FK16 [XF86Launch7] */
264 { "FK17", RDP_SCANCODE_F17 }, /* 195: FK17 [XF86Launch8] */
265 { "FK18", RDP_SCANCODE_F18 }, /* 196: FK18 [XF86Launch9] */
266 { "FK19", RDP_SCANCODE_F19 }, /* 197: FK19 [(null)] */
267 { "FK20", RDP_SCANCODE_F20 }, /* 198: FK20 [XF86AudioMicMute] */
268 { "FK21", RDP_SCANCODE_F21 }, /* 199: FK21 [XF86TouchpadToggle] */
269 { "FK22", RDP_SCANCODE_F22 }, /* 200: FK22 [XF86TouchpadOn] */
270 { "FK23", RDP_SCANCODE_F23 }, /* 201: FK23 [XF86TouchpadOff] */
271 { "FK24", RDP_SCANCODE_F24 }, /* 202: FK24 [(null)] */
272 { "LVL5", RDP_SCANCODE_UNKNOWN }, /* 203: LVL5 [ISO_Level5_Shift] */
273 { "ALT", RDP_SCANCODE_LMENU }, /* 204: ALT [(null)] */
274 { "META", RDP_SCANCODE_LMENU }, /* 205: META [(null)] */
275 { "SUPR", RDP_SCANCODE_LWIN }, /* 206: SUPR [(null)] */
276 { "HYPR", RDP_SCANCODE_LWIN }, /* 207: HYPR [(null)] */
277 { "I208", RDP_SCANCODE_MEDIA_PLAY_PAUSE }, /* 208: I208 [XF86AudioPlay] */
278 { "I209", RDP_SCANCODE_MEDIA_PLAY_PAUSE }, /* 209: I209 [XF86AudioPause] */
279 { "I210", RDP_SCANCODE_UNKNOWN }, /* 210: I210 [XF86Launch3] */
280 { "I211", RDP_SCANCODE_UNKNOWN }, /* 211: I211 [XF86Launch4] */
281 { "I212", RDP_SCANCODE_UNKNOWN }, /* 212: I212 [XF86LaunchB] */
282 { "I213", RDP_SCANCODE_UNKNOWN }, /* 213: I213 [XF86Suspend] */
283 { "I214", RDP_SCANCODE_UNKNOWN }, /* 214: I214 [XF86Close] */
284 { "I215", RDP_SCANCODE_MEDIA_PLAY_PAUSE }, /* 215: I215 [XF86AudioPlay] */
285 { "I216", RDP_SCANCODE_MEDIA_NEXT_TRACK }, /* 216: I216 [XF86AudioForward] */
286 { "I217", RDP_SCANCODE_UNKNOWN }, /* 217: I217 [(null)] */
287 { "I218", RDP_SCANCODE_UNKNOWN }, /* 218: I218 [Print] */
288 { "I219", RDP_SCANCODE_UNKNOWN }, /* 219: I219 [(null)] */
289 { "I220", RDP_SCANCODE_UNKNOWN }, /* 220: I220 [XF86WebCam] */
290 { "I221", RDP_SCANCODE_UNKNOWN }, /* 221: I221 [XF86AudioPreset] */
291 { "I222", RDP_SCANCODE_UNKNOWN }, /* 222: I222 [(null)] */
292 { "I223", RDP_SCANCODE_LAUNCH_MAIL }, /* 223: I223 [XF86Mail] */
293 { "I224", RDP_SCANCODE_UNKNOWN }, /* 224: I224 [XF86Messenger] */
294 { "I225", RDP_SCANCODE_BROWSER_SEARCH }, /* 225: I225 [XF86Search] */
295 { "I226", RDP_SCANCODE_UNKNOWN }, /* 226: I226 [XF86Go] */
296 { "I227", RDP_SCANCODE_UNKNOWN }, /* 227: I227 [XF86Finance] */
297 { "I228", RDP_SCANCODE_UNKNOWN }, /* 228: I228 [XF86Game] */
298 { "I229", RDP_SCANCODE_UNKNOWN }, /* 229: I229 [XF86Shop] */
299 { "I230", RDP_SCANCODE_UNKNOWN }, /* 230: I230 [(null)] */
300 { "I231", RDP_SCANCODE_UNKNOWN }, /* 231: I231 [Cancel] */
301 { "I232", RDP_SCANCODE_UNKNOWN }, /* 232: I232 [XF86MonBrightnessDown] */
302 { "I233", RDP_SCANCODE_UNKNOWN }, /* 233: I233 [XF86MonBrightnessUp] */
303 { "I234", RDP_SCANCODE_LAUNCH_MEDIA_SELECT }, /* 234: I234 [XF86AudioMedia] */
304 { "I235", RDP_SCANCODE_UNKNOWN }, /* 235: I235 [XF86Display] */
305 { "I236", RDP_SCANCODE_UNKNOWN }, /* 236: I236 [XF86KbdLightOnOff] */
306 { "I237", RDP_SCANCODE_UNKNOWN }, /* 237: I237 [XF86KbdBrightnessDown] */
307 { "I238", RDP_SCANCODE_UNKNOWN }, /* 238: I238 [XF86KbdBrightnessUp] */
308 { "I239", RDP_SCANCODE_UNKNOWN }, /* 239: I239 [XF86Send] */
309 { "I240", RDP_SCANCODE_UNKNOWN }, /* 240: I240 [XF86Reply] */
310 { "I241", RDP_SCANCODE_UNKNOWN }, /* 241: I241 [XF86MailForward] */
311 { "I242", RDP_SCANCODE_UNKNOWN }, /* 242: I242 [XF86Save] */
312 { "I243", RDP_SCANCODE_UNKNOWN }, /* 243: I243 [XF86Documents] */
313 { "I244", RDP_SCANCODE_UNKNOWN }, /* 244: I244 [XF86Battery] */
314 { "I245", RDP_SCANCODE_UNKNOWN }, /* 245: I245 [XF86Bluetooth] */
315 { "I246", RDP_SCANCODE_UNKNOWN }, /* 246: I246 [XF86WLAN] */
316 { "I247", RDP_SCANCODE_UNKNOWN }, /* 247: I247 [XF86UWB] */
317 { "I248", RDP_SCANCODE_UNKNOWN }, /* 248: I248 [(null)] */
318 { "I249", RDP_SCANCODE_UNKNOWN }, /* 249: I249 [XF86Next_VMode] */
319 { "I250", RDP_SCANCODE_UNKNOWN }, /* 250: I250 [XF86Prev_VMode] */
320 { "I251", RDP_SCANCODE_UNKNOWN }, /* 251: I251 [XF86MonBrightnessCycle] */
321 { "I252", RDP_SCANCODE_UNKNOWN }, /* 252: I252 [XF86BrightnessAuto] */
322 { "I253", RDP_SCANCODE_UNKNOWN }, /* 253: I253 [XF86DisplayOff] */
323 { "I254", RDP_SCANCODE_UNKNOWN }, /* 254: I254 [XF86WWAN] */
324 { "I255", RDP_SCANCODE_UNKNOWN } /* 255: I255 [XF86RFKill] */
325};
326
327static UINT32 xf_keyboard_get_toggle_keys_state(xfContext* xfc);
328static BOOL xf_keyboard_handle_special_keys(xfContext* xfc, KeySym keysym);
329static void xf_keyboard_handle_special_keys_release(xfContext* xfc, KeySym keysym);
330
331static void xf_keyboard_modifier_map_free(xfContext* xfc)
332{
333 WINPR_ASSERT(xfc);
334 if (xfc->modifierMap)
335 {
336 XFreeModifiermap(xfc->modifierMap);
337 xfc->modifierMap = NULL;
338 }
339}
340
341BOOL xf_keyboard_update_modifier_map(xfContext* xfc)
342{
343 WINPR_ASSERT(xfc);
344 xf_keyboard_modifier_map_free(xfc);
345 xfc->modifierMap = XGetModifierMapping(xfc->display);
346 return xfc->modifierMap != NULL;
347}
348
349static void xf_keyboard_send_key(xfContext* xfc, BOOL down, BOOL repeat, const XKeyEvent* ev);
350
351static BOOL xf_sync_kbd_state(xfContext* xfc)
352{
353 const UINT32 syncFlags = xf_keyboard_get_toggle_keys_state(xfc);
354
355 WINPR_ASSERT(xfc);
356 return freerdp_input_send_synchronize_event(xfc->common.context.input, syncFlags);
357}
358
359static void xf_keyboard_clear(xfContext* xfc)
360{
361 WINPR_ASSERT(xfc);
362 ZeroMemory(xfc->KeyboardState, sizeof(xfc->KeyboardState));
363}
364
365static BOOL xf_action_script_append(xfContext* xfc, const char* buffer, size_t size,
366 WINPR_ATTR_UNUSED void* user, const char* what, const char* arg)
367{
368 WINPR_ASSERT(xfc);
369 WINPR_UNUSED(what);
370 WINPR_UNUSED(arg);
371
372 if (!buffer || (size == 0))
373 return TRUE;
374 return ArrayList_Append(xfc->keyCombinations, buffer);
375}
376
377static void xf_keyboard_action_script_free(xfContext* xfc)
378{
379 xf_event_action_script_free(xfc);
380
381 if (xfc->keyCombinations)
382 {
383 ArrayList_Free(xfc->keyCombinations);
384 xfc->keyCombinations = NULL;
385 xfc->actionScriptExists = FALSE;
386 }
387}
388
389BOOL xf_keyboard_action_script_init(xfContext* xfc)
390{
391 WINPR_ASSERT(xfc);
392
393 xf_keyboard_action_script_free(xfc);
394 xfc->keyCombinations = ArrayList_New(TRUE);
395
396 if (!xfc->keyCombinations)
397 return FALSE;
398
399 wObject* obj = ArrayList_Object(xfc->keyCombinations);
400 WINPR_ASSERT(obj);
401 obj->fnObjectNew = winpr_ObjectStringClone;
402 obj->fnObjectFree = winpr_ObjectStringFree;
403
404 if (!run_action_script(xfc, "key", NULL, xf_action_script_append, NULL))
405 return FALSE;
406
407 return xf_event_action_script_init(xfc);
408}
409
410static int xkb_cmp(const void* pva, const void* pvb)
411{
412 const struct x11_key_scancode_t* a = pva;
413 const struct x11_key_scancode_t* b = pvb;
414
415 if (!a && !b)
416 return 0;
417 if (!a)
418 return 1;
419 if (!b)
420 return -1;
421 return strcmp(a->name, b->name);
422}
423
424static BOOL try_add(xfContext* xfc, size_t offset, const char* xkb_keyname)
425{
426 WINPR_ASSERT(xfc);
427
428 static BOOL initialized = FALSE;
429 static struct x11_key_scancode_t copy[ARRAYSIZE(XKB_KEY_NAME_SCANCODE_TABLE)] = { 0 };
430 if (!initialized)
431 {
432 // TODO: Here we can do some magic:
433 // depending on input keyboard type use different mapping! (e.g. IBM, Apple, ...)
434 memcpy(copy, XKB_KEY_NAME_SCANCODE_TABLE, sizeof(copy));
435 qsort(copy, ARRAYSIZE(copy), sizeof(struct x11_key_scancode_t), xkb_cmp);
436 initialized = TRUE;
437 }
438
439 struct x11_key_scancode_t key = { .name = xkb_keyname,
440 .sc = WINPR_ASSERTING_INT_CAST(uint32_t, offset) };
441
442 struct x11_key_scancode_t* found =
443 bsearch(&key, copy, ARRAYSIZE(copy), sizeof(struct x11_key_scancode_t), xkb_cmp);
444 if (found)
445 {
446 WLog_Print(xfc->log, WLOG_DEBUG,
447 "%4s: keycode: 0x%02" PRIuz " -> rdp scancode: 0x%08" PRIx32 "", xkb_keyname,
448 offset, found->sc);
449 xfc->X11_KEYCODE_TO_VIRTUAL_SCANCODE[offset] = found->sc;
450 return TRUE;
451 }
452
453 return FALSE;
454}
455
456static int load_map_from_xkbfile(xfContext* xfc)
457{
458 WINPR_ASSERT(xfc);
459 int status = -1;
460
461 if (!xfc->display)
462 return -2;
463
464 XkbDescPtr xkb = XkbGetMap(xfc->display, 0, XkbUseCoreKbd);
465 if (!xkb)
466 {
467 WLog_Print(xfc->log, WLOG_WARN, "XkbGetMap() == NULL");
468 return -3;
469 }
470
471 const int rc = XkbGetNames(xfc->display, XkbKeyNamesMask, xkb);
472 if (rc != Success)
473 {
474 char buffer[64] = { 0 };
475 WLog_Print(xfc->log, WLOG_WARN, "XkbGetNames() != Success: [%s]",
476 x11_error_to_string(xfc, rc, buffer, sizeof(buffer)));
477 }
478 else
479 {
480 char xkb_keyname[XkbKeyNameLength + 1] = { 42, 42, 42, 42,
481 0 }; /* end-of-string at index 5 */
482
483 WLog_Print(xfc->log, WLOG_TRACE, "XkbGetNames() == Success, min=%" PRIu8 ", max=%" PRIu8,
484 xkb->min_key_code, xkb->max_key_code);
485 for (size_t i = xkb->min_key_code; i < xkb->max_key_code; i++)
486 {
487 BOOL found = FALSE;
488 strncpy(xkb_keyname, xkb->names->keys[i].name, XkbKeyNameLength);
489
490 WLog_Print(xfc->log, WLOG_TRACE, "KeyCode %" PRIuz " -> %s", i, xkb_keyname);
491 if (strnlen(xkb_keyname, ARRAYSIZE(xkb_keyname)) >= 1)
492 found = try_add(xfc, i, xkb_keyname);
493
494 if (!found)
495 {
496#if defined(__APPLE__)
497 const DWORD vkcode =
498 GetVirtualKeyCodeFromKeycode((UINT32)i - 8u, WINPR_KEYCODE_TYPE_APPLE);
499 xfc->X11_KEYCODE_TO_VIRTUAL_SCANCODE[i] =
500 GetVirtualScanCodeFromVirtualKeyCode(vkcode, WINPR_KBD_TYPE_IBM_ENHANCED);
501 found = TRUE;
502#endif
503 }
504 if (!found)
505 {
506 WLog_Print(xfc->log, WLOG_WARN, "%4s: keycode: 0x%02X -> no RDP scancode found",
507 xkb_keyname, i);
508 }
509 else
510 status = 0;
511 }
512 }
513
514 XkbFreeKeyboard(xkb, 0, 1);
515
516 return status;
517}
518
519BOOL xf_keyboard_init(xfContext* xfc)
520{
521 rdpSettings* settings = NULL;
522
523 WINPR_ASSERT(xfc);
524
525 settings = xfc->common.context.settings;
526 WINPR_ASSERT(settings);
527
528 xf_keyboard_clear(xfc);
529
530 /* Layout detection algorithm:
531 *
532 * 1. If one was supplied, use that one
533 * 2. Try to determine current X11 keyboard layout
534 * 3. Try to determine default layout for current system language
535 * 4. Fall back to ENGLISH_UNITED_STATES
536 */
537 UINT32 KeyboardLayout = freerdp_settings_get_uint32(settings, FreeRDP_KeyboardLayout);
538 if (KeyboardLayout == 0)
539 {
540 xf_detect_keyboard_layout_from_xkb(&KeyboardLayout);
541 if (KeyboardLayout == 0)
542 freerdp_detect_keyboard_layout_from_system_locale(&KeyboardLayout);
543 if (KeyboardLayout == 0)
544 KeyboardLayout = ENGLISH_UNITED_STATES;
545 if (!freerdp_settings_set_uint32(settings, FreeRDP_KeyboardLayout, KeyboardLayout))
546 return FALSE;
547 }
548
549 const int rc = load_map_from_xkbfile(xfc);
550 if (rc != 0)
551 return FALSE;
552
553 return xf_keyboard_update_modifier_map(xfc);
554}
555
556void xf_keyboard_free(xfContext* xfc)
557{
558 xf_keyboard_modifier_map_free(xfc);
559 xf_keyboard_action_script_free(xfc);
560}
561
562void xf_keyboard_key_press(xfContext* xfc, const XKeyEvent* event, KeySym keysym)
563{
564 BOOL last = 0;
565
566 WINPR_ASSERT(xfc);
567 WINPR_ASSERT(event);
568 WINPR_ASSERT(event->keycode < ARRAYSIZE(xfc->KeyboardState));
569
570 last = xfc->KeyboardState[event->keycode];
571 xfc->KeyboardState[event->keycode] = TRUE;
572
573 if (xf_keyboard_handle_special_keys(xfc, keysym))
574 return;
575
576 xf_keyboard_send_key(xfc, TRUE, last, event);
577}
578
579void xf_keyboard_key_release(xfContext* xfc, const XKeyEvent* event, KeySym keysym)
580{
581 WINPR_ASSERT(xfc);
582 WINPR_ASSERT(event);
583 WINPR_ASSERT(event->keycode < ARRAYSIZE(xfc->KeyboardState));
584
585 BOOL last = xfc->KeyboardState[event->keycode];
586 xfc->KeyboardState[event->keycode] = FALSE;
587 xf_keyboard_handle_special_keys_release(xfc, keysym);
588 xf_keyboard_send_key(xfc, FALSE, last, event);
589}
590
591static DWORD get_rdp_scancode_from_x11_keycode(xfContext* xfc, DWORD keycode)
592{
593 WINPR_ASSERT(xfc);
594 if (keycode >= ARRAYSIZE(xfc->X11_KEYCODE_TO_VIRTUAL_SCANCODE))
595 {
596 WLog_ERR(TAG, "KeyCode %" PRIu32 " exceeds allowed value range [0,%" PRIuz "]", keycode,
597 ARRAYSIZE(xfc->X11_KEYCODE_TO_VIRTUAL_SCANCODE));
598 return 0;
599 }
600
601 const DWORD scancode = xfc->X11_KEYCODE_TO_VIRTUAL_SCANCODE[keycode];
602 const DWORD remapped = freerdp_keyboard_remap_key(xfc->remap_table, scancode);
603
604 if (remapped != 0)
605 return remapped;
606
607 return scancode;
608}
609
610void xf_keyboard_release_all_keypress(xfContext* xfc)
611{
612 WINPR_ASSERT(xfc);
613
614 WINPR_STATIC_ASSERT(ARRAYSIZE(xfc->KeyboardState) <= UINT32_MAX);
615 for (size_t keycode = 0; keycode < ARRAYSIZE(xfc->KeyboardState); keycode++)
616 {
617 if (xfc->KeyboardState[keycode])
618 {
619 const DWORD rdp_scancode =
620 get_rdp_scancode_from_x11_keycode(xfc, WINPR_ASSERTING_INT_CAST(UINT32, keycode));
621
622 // release tab before releasing the windows key.
623 // this stops the start menu from opening on unfocus event.
624 if (rdp_scancode == RDP_SCANCODE_LWIN)
625 freerdp_input_send_keyboard_event_ex(xfc->common.context.input, FALSE, FALSE,
626 RDP_SCANCODE_TAB);
627
628 freerdp_input_send_keyboard_event_ex(xfc->common.context.input, FALSE, FALSE,
629 rdp_scancode);
630 xfc->KeyboardState[keycode] = FALSE;
631 }
632 }
633 xf_sync_kbd_state(xfc);
634}
635
636static BOOL xf_keyboard_key_pressed(xfContext* xfc, KeySym keysym)
637{
638 KeyCode keycode = XKeysymToKeycode(xfc->display, keysym);
639 WINPR_ASSERT(keycode < ARRAYSIZE(xfc->KeyboardState));
640 return xfc->KeyboardState[keycode];
641}
642
643void xf_keyboard_send_key(xfContext* xfc, BOOL down, BOOL repeat, const XKeyEvent* event)
644{
645 WINPR_ASSERT(xfc);
646 WINPR_ASSERT(event);
647
648 rdpInput* input = xfc->common.context.input;
649 WINPR_ASSERT(input);
650
651 const DWORD rdp_scancode = get_rdp_scancode_from_x11_keycode(xfc, event->keycode);
652 if (rdp_scancode == RDP_SCANCODE_PAUSE && !xf_keyboard_key_pressed(xfc, XK_Control_L) &&
653 !xf_keyboard_key_pressed(xfc, XK_Control_R))
654 {
655 /* Pause without Ctrl has to be sent as a series of keycodes
656 * in a single input PDU. Pause only happens on "press";
657 * no code is sent on "release".
658 */
659 if (down)
660 {
661 (void)freerdp_input_send_keyboard_pause_event(input);
662 }
663 }
664 else
665 {
666 if (freerdp_settings_get_bool(xfc->common.context.settings, FreeRDP_UnicodeInput))
667 {
668 wchar_t buffer[32] = { 0 };
669 int xwc = -1;
670
671 switch (rdp_scancode)
672 {
673 case RDP_SCANCODE_RETURN:
674 break;
675 default:
676 {
677 XIM xim = XOpenIM(xfc->display, 0, 0, 0);
678 if (!xim)
679 {
680 WLog_WARN(TAG, "Failed to XOpenIM");
681 }
682 else
683 {
684 XIC xic = XCreateIC(xim, XNInputStyle, XIMPreeditNothing | XIMStatusNothing,
685 NULL);
686 if (!xic)
687 {
688 WLog_WARN(TAG, "XCreateIC failed");
689 }
690 else
691 {
692 KeySym ignore = { 0 };
693 Status return_status = 0;
694 XKeyEvent ev = *event;
695 ev.type = KeyPress;
696 xwc = XwcLookupString(xic, &ev, buffer, ARRAYSIZE(buffer), &ignore,
697 &return_status);
698 XDestroyIC(xic);
699 }
700 XCloseIM(xim);
701 }
702 }
703 break;
704 }
705
706 if (xwc < 1)
707 {
708 if (rdp_scancode == RDP_SCANCODE_UNKNOWN)
709 WLog_ERR(TAG, "Unknown key with X keycode 0x%02" PRIx8 "", event->keycode);
710 else
711 (void)freerdp_input_send_keyboard_event_ex(input, down, repeat, rdp_scancode);
712 }
713 else
714 {
715 char str[3 * ARRAYSIZE(buffer)] = { 0 };
716 // NOLINTNEXTLINE(concurrency-mt-unsafe)
717 const size_t rc = wcstombs(str, buffer, ARRAYSIZE(buffer));
718
719 WCHAR wbuffer[ARRAYSIZE(buffer)] = { 0 };
720 (void)ConvertUtf8ToWChar(str, wbuffer, rc);
721 (void)freerdp_input_send_unicode_keyboard_event(input, down ? 0 : KBD_FLAGS_RELEASE,
722 wbuffer[0]);
723 }
724 }
725 else if (rdp_scancode == RDP_SCANCODE_UNKNOWN)
726 WLog_ERR(TAG, "Unknown key with X keycode 0x%02" PRIx8 "", event->keycode);
727 else
728 (void)freerdp_input_send_keyboard_event_ex(input, down, repeat, rdp_scancode);
729 }
730}
731
732static int xf_keyboard_read_keyboard_state(xfContext* xfc)
733{
734 int dummy = 0;
735 Window wdummy = 0;
736 UINT32 state = 0;
737
738 if (!xfc->remote_app && xfc->window)
739 {
740 XQueryPointer(xfc->display, xfc->window->handle, &wdummy, &wdummy, &dummy, &dummy, &dummy,
741 &dummy, &state);
742 }
743 else
744 {
745 XQueryPointer(xfc->display, DefaultRootWindow(xfc->display), &wdummy, &wdummy, &dummy,
746 &dummy, &dummy, &dummy, &state);
747 }
748
749 return WINPR_ASSERTING_INT_CAST(int, state);
750}
751
752static int xf_keyboard_get_keymask(xfContext* xfc, KeySym keysym)
753{
754 int keysymMask = 0;
755 KeyCode keycode = XKeysymToKeycode(xfc->display, keysym);
756
757 if (keycode == NoSymbol)
758 return 0;
759
760 WINPR_ASSERT(xfc->modifierMap);
761 for (int modifierpos = 0; modifierpos < 8; modifierpos++)
762 {
763 int offset = xfc->modifierMap->max_keypermod * modifierpos;
764
765 for (int key = 0; key < xfc->modifierMap->max_keypermod; key++)
766 {
767 if (xfc->modifierMap->modifiermap[offset + key] == keycode)
768 {
769 keysymMask |= 1 << modifierpos;
770 }
771 }
772 }
773
774 return keysymMask;
775}
776
777static BOOL xf_keyboard_get_key_state(xfContext* xfc, int state, KeySym keysym)
778{
779 int keysymMask = xf_keyboard_get_keymask(xfc, keysym);
780
781 if (!keysymMask)
782 return FALSE;
783
784 return (state & keysymMask) ? TRUE : FALSE;
785}
786
787static BOOL xf_keyboard_set_key_state(xfContext* xfc, BOOL on, KeySym keysym)
788{
789 if (!xfc->xkbAvailable)
790 return FALSE;
791
792 const int keysymMask = xf_keyboard_get_keymask(xfc, keysym);
793
794 if (!keysymMask)
795 {
796 return FALSE;
797 }
798
799 return XkbLockModifiers(xfc->display, XkbUseCoreKbd,
800 WINPR_ASSERTING_INT_CAST(uint32_t, keysymMask),
801 on ? WINPR_ASSERTING_INT_CAST(uint32_t, keysymMask) : 0);
802}
803
804UINT32 xf_keyboard_get_toggle_keys_state(xfContext* xfc)
805{
806 UINT32 toggleKeysState = 0;
807 const int state = xf_keyboard_read_keyboard_state(xfc);
808
809 if (xf_keyboard_get_key_state(xfc, state, XK_Scroll_Lock))
810 toggleKeysState |= KBD_SYNC_SCROLL_LOCK;
811
812 if (xf_keyboard_get_key_state(xfc, state, XK_Num_Lock))
813 toggleKeysState |= KBD_SYNC_NUM_LOCK;
814
815 if (xf_keyboard_get_key_state(xfc, state, XK_Caps_Lock))
816 toggleKeysState |= KBD_SYNC_CAPS_LOCK;
817
818 if (xf_keyboard_get_key_state(xfc, state, XK_Kana_Lock))
819 toggleKeysState |= KBD_SYNC_KANA_LOCK;
820
821 return toggleKeysState;
822}
823
824static void xk_keyboard_update_modifier_keys(xfContext* xfc)
825{
826 const KeySym keysyms[] = { XK_Shift_L, XK_Shift_R, XK_Alt_L, XK_Alt_R,
827 XK_Control_L, XK_Control_R, XK_Super_L, XK_Super_R };
828
829 xf_keyboard_clear(xfc);
830
831 const int state = xf_keyboard_read_keyboard_state(xfc);
832
833 for (size_t i = 0; i < ARRAYSIZE(keysyms); i++)
834 {
835 if (xf_keyboard_get_key_state(xfc, state, keysyms[i]))
836 {
837 const KeyCode keycode = XKeysymToKeycode(xfc->display, keysyms[i]);
838 WINPR_ASSERT(keycode < ARRAYSIZE(xfc->KeyboardState));
839 xfc->KeyboardState[keycode] = TRUE;
840 }
841 }
842}
843
844void xf_keyboard_focus_in(xfContext* xfc)
845{
846 UINT32 state = 0;
847 Window w = None;
848 int d = 0;
849 int x = 0;
850 int y = 0;
851
852 WINPR_ASSERT(xfc);
853 if (!xfc->display || !xfc->window)
854 return;
855
856 rdpInput* input = xfc->common.context.input;
857 WINPR_ASSERT(input);
858
859 const UINT32 syncFlags = xf_keyboard_get_toggle_keys_state(xfc);
860 freerdp_input_send_focus_in_event(input, WINPR_ASSERTING_INT_CAST(UINT16, syncFlags));
861 xk_keyboard_update_modifier_keys(xfc);
862
863 /* finish with a mouse pointer position like mstsc.exe if required */
864
865 if (xfc->remote_app || !xfc->window)
866 return;
867
868 if (XQueryPointer(xfc->display, xfc->window->handle, &w, &w, &d, &d, &x, &y, &state))
869 {
870 if ((x >= 0) && (x < xfc->window->width) && (y >= 0) && (y < xfc->window->height))
871 {
872 xf_event_adjust_coordinates(xfc, &x, &y);
873 freerdp_client_send_button_event(&xfc->common, FALSE, PTR_FLAGS_MOVE, x, y);
874 }
875 }
876}
877
878static BOOL action_script_run(xfContext* xfc, const char* buffer, size_t size, void* user,
879 const char* what, const char* arg)
880{
881 WINPR_UNUSED(xfc);
882 WINPR_UNUSED(what);
883 WINPR_UNUSED(arg);
884 WINPR_ASSERT(user);
885 int* pstatus = user;
886
887 if (size == 0)
888 {
889 WLog_WARN(TAG, "ActionScript key: script did not return data");
890 return FALSE;
891 }
892
893 if (strcmp(buffer, "key-local") == 0)
894 *pstatus = 0;
895 else if (winpr_PathFileExists(buffer))
896 {
897 FILE* fp = popen(buffer, "w");
898 if (!fp)
899 {
900 WLog_ERR(TAG, "Failed to execute '%s'", buffer);
901 return FALSE;
902 }
903
904 *pstatus = pclose(fp);
905 if (*pstatus < 0)
906 {
907 WLog_ERR(TAG, "Command '%s' returned %d", buffer, *pstatus);
908 return FALSE;
909 }
910 }
911 else
912 {
913 WLog_WARN(TAG, "ActionScript key: no such file '%s'", buffer);
914 return FALSE;
915 }
916 return TRUE;
917}
918
919static int xf_keyboard_execute_action_script(xfContext* xfc, XF_MODIFIER_KEYS* mod, KeySym keysym)
920{
921 int status = 1;
922 BOOL match = FALSE;
923 char command[2048] = { 0 };
924 char combination[1024] = { 0 };
925
926 if (!xfc->actionScriptExists)
927 return 1;
928
929 if ((keysym == XK_Shift_L) || (keysym == XK_Shift_R) || (keysym == XK_Alt_L) ||
930 (keysym == XK_Alt_R) || (keysym == XK_Control_L) || (keysym == XK_Control_R))
931 {
932 return 1;
933 }
934
935 const char* keyStr = XKeysymToString(keysym);
936
937 if (keyStr == 0)
938 {
939 return 1;
940 }
941
942 if (mod->Shift)
943 winpr_str_append("Shift", combination, sizeof(combination), "+");
944
945 if (mod->Ctrl)
946 winpr_str_append("Ctrl", combination, sizeof(combination), "+");
947
948 if (mod->Alt)
949 winpr_str_append("Alt", combination, sizeof(combination), "+");
950
951 if (mod->Super)
952 winpr_str_append("Super", combination, sizeof(combination), "+");
953
954 winpr_str_append(keyStr, combination, sizeof(combination), "+");
955
956 for (size_t i = 0; i < strnlen(combination, sizeof(combination)); i++)
957 combination[i] = WINPR_ASSERTING_INT_CAST(char, tolower(combination[i]));
958
959 const size_t count = ArrayList_Count(xfc->keyCombinations);
960
961 for (size_t index = 0; index < count; index++)
962 {
963 const char* keyCombination = (const char*)ArrayList_GetItem(xfc->keyCombinations, index);
964
965 if (_stricmp(keyCombination, combination) == 0)
966 {
967 match = TRUE;
968 break;
969 }
970 }
971
972 if (!match)
973 return 1;
974
975 (void)sprintf_s(command, sizeof(command), "key %s", combination);
976 if (!run_action_script(xfc, command, NULL, action_script_run, &status))
977 return -1;
978
979 return status;
980}
981
982static int xk_keyboard_get_modifier_keys(xfContext* xfc, XF_MODIFIER_KEYS* mod)
983{
984 mod->LeftShift = xf_keyboard_key_pressed(xfc, XK_Shift_L);
985 mod->RightShift = xf_keyboard_key_pressed(xfc, XK_Shift_R);
986 mod->Shift = mod->LeftShift || mod->RightShift;
987 mod->LeftAlt = xf_keyboard_key_pressed(xfc, XK_Alt_L);
988 mod->RightAlt = xf_keyboard_key_pressed(xfc, XK_Alt_R);
989 mod->Alt = mod->LeftAlt || mod->RightAlt;
990 mod->LeftCtrl = xf_keyboard_key_pressed(xfc, XK_Control_L);
991 mod->RightCtrl = xf_keyboard_key_pressed(xfc, XK_Control_R);
992 mod->Ctrl = mod->LeftCtrl || mod->RightCtrl;
993 mod->LeftSuper = xf_keyboard_key_pressed(xfc, XK_Super_L);
994 mod->RightSuper = xf_keyboard_key_pressed(xfc, XK_Super_R);
995 mod->Super = mod->LeftSuper || mod->RightSuper;
996 return 0;
997}
998
999BOOL xf_keyboard_handle_special_keys(xfContext* xfc, KeySym keysym)
1000{
1001 XF_MODIFIER_KEYS mod = { 0 };
1002 xk_keyboard_get_modifier_keys(xfc, &mod);
1003
1004 // remember state of RightCtrl to ungrab keyboard if next action is release of RightCtrl
1005 // do not return anything such that the key could be used by client if ungrab is not the goal
1006 if (keysym == XK_Control_R)
1007 {
1008 if (mod.RightCtrl && !xfc->wasRightCtrlAlreadyPressed)
1009 {
1010 // Right Ctrl is pressed, getting ready to ungrab
1011 xfc->ungrabKeyboardWithRightCtrl = TRUE;
1012 xfc->wasRightCtrlAlreadyPressed = TRUE;
1013 }
1014 }
1015 else
1016 {
1017 // some other key has been pressed, abort ungrabbing
1018 if (xfc->ungrabKeyboardWithRightCtrl)
1019 xfc->ungrabKeyboardWithRightCtrl = FALSE;
1020 }
1021
1022 const int rc = xf_keyboard_execute_action_script(xfc, &mod, keysym);
1023 if (rc < 0)
1024 return FALSE;
1025 if (rc == 0)
1026 return TRUE;
1027
1028 if (!xfc->remote_app && xfc->fullscreen_toggle)
1029 {
1030 switch (keysym)
1031 {
1032 case XK_Return:
1033 if (mod.Ctrl && mod.Alt)
1034 {
1035 /* Ctrl-Alt-Enter: toggle full screen */
1036 WLog_INFO(TAG, "<ctrl>+<alt>+<enter> pressed, toggling fullscreen state...");
1037 xf_sync_kbd_state(xfc);
1038 xf_toggle_fullscreen(xfc);
1039 return TRUE;
1040 }
1041 break;
1042 default:
1043 break;
1044 }
1045 }
1046
1047 if (mod.Ctrl && mod.Alt)
1048 {
1049 switch (keysym)
1050 {
1051 case XK_m:
1052 case XK_M:
1053 WLog_INFO(TAG, "<ctrl>+<alt>+m pressed, minimizing RDP session...");
1054 xf_sync_kbd_state(xfc);
1055 xf_minimize(xfc);
1056 return TRUE;
1057 case XK_c:
1058 case XK_C:
1059 /* Ctrl-Alt-C: toggle control */
1060 WLog_INFO(TAG, "<ctrl>+<alt>+c pressed, toggle encomps control...");
1061 if (freerdp_client_encomsp_toggle_control(xfc->common.encomsp))
1062 return TRUE;
1063 break;
1064 case XK_d:
1065 case XK_D:
1066 /* <ctrl>+<alt>+d: disconnect session */
1067 WLog_INFO(TAG, "<ctrl>+<alt>+d pressed, terminating RDP session...");
1068 xf_sync_kbd_state(xfc);
1069 return freerdp_abort_connect_context(&xfc->common.context);
1070
1071 default:
1072 break;
1073 }
1074 }
1075
1076#if 0 /* set to 1 to enable multi touch gesture simulation via keyboard */
1077#ifdef WITH_XRENDER
1078
1079 if (!xfc->remote_app && freerdp_settings_get_bool(xfc->common.context.settings, FreeRDP_MultiTouchGestures))
1080 {
1081 rdpContext* ctx = &xfc->common.context;
1082
1083 if (mod.Ctrl && mod.Alt)
1084 {
1085 int pdx = 0;
1086 int pdy = 0;
1087 int zdx = 0;
1088 int zdy = 0;
1089
1090 switch (keysym)
1091 {
1092 case XK_0: /* Ctrl-Alt-0: Reset scaling and panning */{
1093 const UINT32 sessionWidth = freerdp_settings_get_uint32(xfc->common.context.settings, FreeRDP_DesktopWidth);
1094 const UINT32 sessionHeight = freerdp_settings_get_uint32(xfc->common.context.settings, FreeRDP_DesktopHeight);
1095
1096 xfc->scaledWidth = sessionWidth;
1097 xfc->scaledHeight = sessionHeight;
1098 xfc->offset_x = 0;
1099 xfc->offset_y = 0;
1100
1101 if (!xfc->fullscreen && (sessionWidth != xfc->window->width ||
1102 sessionHeight != xfc->window->height))
1103 {
1104 xf_ResizeDesktopWindow(xfc, xfc->window, sessionWidth, sessionHeight);
1105 }
1106
1107 xf_draw_screen(xfc, 0, 0, sessionWidth, sessionHeight);
1108 return TRUE;
1109}
1110
1111 case XK_1: /* Ctrl-Alt-1: Zoom in */
1112 zdx = zdy = 10;
1113 break;
1114
1115 case XK_2: /* Ctrl-Alt-2: Zoom out */
1116 zdx = zdy = -10;
1117 break;
1118
1119 case XK_3: /* Ctrl-Alt-3: Pan left */
1120 pdx = -10;
1121 break;
1122
1123 case XK_4: /* Ctrl-Alt-4: Pan right */
1124 pdx = 10;
1125 break;
1126
1127 case XK_5: /* Ctrl-Alt-5: Pan up */
1128 pdy = -10;
1129 break;
1130
1131 case XK_6: /* Ctrl-Alt-6: Pan up */
1132 pdy = 10;
1133 break;
1134 }
1135
1136 if (pdx != 0 || pdy != 0)
1137 {
1138 PanningChangeEventArgs e;
1139 EventArgsInit(&e, "xfreerdp");
1140 e.dx = pdx;
1141 e.dy = pdy;
1142 PubSub_OnPanningChange(ctx->pubSub, xfc, &e);
1143 return TRUE;
1144 }
1145
1146 if (zdx != 0 || zdy != 0)
1147 {
1148 ZoomingChangeEventArgs e;
1149 EventArgsInit(&e, "xfreerdp");
1150 e.dx = zdx;
1151 e.dy = zdy;
1152 PubSub_OnZoomingChange(ctx->pubSub, xfc, &e);
1153 return TRUE;
1154 }
1155 }
1156 }
1157
1158#endif /* WITH_XRENDER defined */
1159#endif /* pinch/zoom/pan simulation */
1160 return FALSE;
1161}
1162
1163void xf_keyboard_handle_special_keys_release(xfContext* xfc, KeySym keysym)
1164{
1165 if (keysym != XK_Control_R)
1166 return;
1167
1168 xfc->wasRightCtrlAlreadyPressed = FALSE;
1169
1170 if (!xfc->ungrabKeyboardWithRightCtrl)
1171 return;
1172
1173 // all requirements for ungrab are fulfilled, ungrabbing now
1174 XF_MODIFIER_KEYS mod = { 0 };
1175 xk_keyboard_get_modifier_keys(xfc, &mod);
1176
1177 if (!mod.RightCtrl)
1178 {
1179 if (!xfc->fullscreen)
1180 {
1181 xf_sync_kbd_state(xfc);
1182 freerdp_client_encomsp_toggle_control(xfc->common.encomsp);
1183 }
1184
1185 xfc->mouse_active = FALSE;
1186 xf_ungrab(xfc);
1187 }
1188
1189 // ungrabbed
1190 xfc->ungrabKeyboardWithRightCtrl = FALSE;
1191}
1192
1193BOOL xf_keyboard_set_indicators(rdpContext* context, UINT16 led_flags)
1194{
1195 xfContext* xfc = (xfContext*)context;
1196 xf_keyboard_set_key_state(xfc, led_flags & KBD_SYNC_SCROLL_LOCK, XK_Scroll_Lock);
1197 xf_keyboard_set_key_state(xfc, led_flags & KBD_SYNC_NUM_LOCK, XK_Num_Lock);
1198 xf_keyboard_set_key_state(xfc, led_flags & KBD_SYNC_CAPS_LOCK, XK_Caps_Lock);
1199 xf_keyboard_set_key_state(xfc, led_flags & KBD_SYNC_KANA_LOCK, XK_Kana_Lock);
1200 return TRUE;
1201}
1202
1203BOOL xf_keyboard_set_ime_status(rdpContext* context, UINT16 imeId, UINT32 imeState,
1204 UINT32 imeConvMode)
1205{
1206 if (!context)
1207 return FALSE;
1208
1209 WLog_WARN(TAG,
1210 "KeyboardSetImeStatus(unitId=%04" PRIx16 ", imeState=%08" PRIx32
1211 ", imeConvMode=%08" PRIx32 ") ignored",
1212 imeId, imeState, imeConvMode);
1213 return TRUE;
1214}
1215
1216BOOL xf_ungrab(xfContext* xfc)
1217{
1218 WINPR_ASSERT(xfc);
1219 XUngrabKeyboard(xfc->display, CurrentTime);
1220 XUngrabPointer(xfc->display, CurrentTime);
1221 xfc->common.mouse_grabbed = FALSE;
1222 return TRUE;
1223}
freerdp_settings_get_uint32
FREERDP_API UINT32 freerdp_settings_get_uint32(const rdpSettings *settings, FreeRDP_Settings_Keys_UInt32 id)
Returns a UINT32 settings value.
freerdp_settings_get_bool
FREERDP_API BOOL freerdp_settings_get_bool(const rdpSettings *settings, FreeRDP_Settings_Keys_Bool id)
Returns a boolean settings value.
freerdp_settings_set_uint32
FREERDP_API BOOL freerdp_settings_set_uint32(rdpSettings *settings, FreeRDP_Settings_Keys_UInt32 id, UINT32 param)
Sets a UINT32 settings value.
wObject
This struct contains function pointer to initialize/free objects.
Definition collections.h:57