1/****************************************************************************
2**
3** Copyright (C) 2019 The Qt Company Ltd.
4** Contact: https://www.qt.io/licensing/
5**
6** This file is part of the QtGui module of the Qt Toolkit.
7**
8** $QT_BEGIN_LICENSE:LGPL$
9** Commercial License Usage
10** Licensees holding valid commercial Qt licenses may use this file in
11** accordance with the commercial license agreement provided with the
12** Software or, alternatively, in accordance with the terms contained in
13** a written agreement between you and The Qt Company. For licensing terms
14** and conditions see https://www.qt.io/terms-conditions. For further
15** information use the contact form at https://www.qt.io/contact-us.
16**
17** GNU Lesser General Public License Usage
18** Alternatively, this file may be used under the terms of the GNU Lesser
19** General Public License version 3 as published by the Free Software
20** Foundation and appearing in the file LICENSE.LGPL3 included in the
21** packaging of this file. Please review the following information to
22** ensure the GNU Lesser General Public License version 3 requirements
23** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
24**
25** GNU General Public License Usage
26** Alternatively, this file may be used under the terms of the GNU
27** General Public License version 2.0 or (at your option) the GNU General
28** Public license version 3 or any later version approved by the KDE Free
29** Qt Foundation. The licenses are as published by the Free Software
30** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
31** included in the packaging of this file. Please review the following
32** information to ensure the GNU General Public License requirements will
33** be met: https://www.gnu.org/licenses/gpl-2.0.html and
34** https://www.gnu.org/licenses/gpl-3.0.html.
35**
36** $QT_END_LICENSE$
37**
38****************************************************************************/
39
40#include "qxkbcommon_p.h"
41
42#include <private/qmakearray_p.h>
43
44#include <QtCore/private/qstringiterator_p.h>
45#include <QtCore/QMetaMethod>
46
47#include <QtGui/QKeyEvent>
48#include <QtGui/private/qguiapplication_p.h>
49
50#include <qpa/qplatforminputcontext.h>
51#include <qpa/qplatformintegration.h>
52
53QT_BEGIN_NAMESPACE
54
55Q_LOGGING_CATEGORY(lcXkbcommon, "qt.xkbcommon")
56
57static int keysymToQtKey_internal(xkb_keysym_t keysym, Qt::KeyboardModifiers modifiers,
58 xkb_state *state, xkb_keycode_t code,
59 bool superAsMeta, bool hyperAsMeta);
60
61typedef struct xkb2qt
62{
63 unsigned int xkb;
64 unsigned int qt;
65
66 constexpr bool operator <=(const xkb2qt &that) const noexcept
67 {
68 return xkb <= that.xkb;
69 }
70
71 constexpr bool operator <(const xkb2qt &that) const noexcept
72 {
73 return xkb < that.xkb;
74 }
75} xkb2qt_t;
76
77template<std::size_t Xkb, std::size_t Qt>
78struct Xkb2Qt
79{
80 using Type = xkb2qt_t;
81 static constexpr Type data() noexcept { return Type{.xkb: Xkb, .qt: Qt}; }
82};
83
84static constexpr const auto KeyTbl = qMakeArray(
85 QSortedData<
86 // misc keys
87
88 Xkb2Qt<XKB_KEY_Escape, Qt::Key_Escape>,
89 Xkb2Qt<XKB_KEY_Tab, Qt::Key_Tab>,
90 Xkb2Qt<XKB_KEY_ISO_Left_Tab, Qt::Key_Backtab>,
91 Xkb2Qt<XKB_KEY_BackSpace, Qt::Key_Backspace>,
92 Xkb2Qt<XKB_KEY_Return, Qt::Key_Return>,
93 Xkb2Qt<XKB_KEY_Insert, Qt::Key_Insert>,
94 Xkb2Qt<XKB_KEY_Delete, Qt::Key_Delete>,
95 Xkb2Qt<XKB_KEY_Clear, Qt::Key_Delete>,
96 Xkb2Qt<XKB_KEY_Pause, Qt::Key_Pause>,
97 Xkb2Qt<XKB_KEY_Print, Qt::Key_Print>,
98 Xkb2Qt<0x1005FF60, Qt::Key_SysReq>, // hardcoded Sun SysReq
99 Xkb2Qt<0x1007ff00, Qt::Key_SysReq>, // hardcoded X386 SysReq
100
101 // cursor movement
102
103 Xkb2Qt<XKB_KEY_Home, Qt::Key_Home>,
104 Xkb2Qt<XKB_KEY_End, Qt::Key_End>,
105 Xkb2Qt<XKB_KEY_Left, Qt::Key_Left>,
106 Xkb2Qt<XKB_KEY_Up, Qt::Key_Up>,
107 Xkb2Qt<XKB_KEY_Right, Qt::Key_Right>,
108 Xkb2Qt<XKB_KEY_Down, Qt::Key_Down>,
109 Xkb2Qt<XKB_KEY_Prior, Qt::Key_PageUp>,
110 Xkb2Qt<XKB_KEY_Next, Qt::Key_PageDown>,
111
112 // modifiers
113
114 Xkb2Qt<XKB_KEY_Shift_L, Qt::Key_Shift>,
115 Xkb2Qt<XKB_KEY_Shift_R, Qt::Key_Shift>,
116 Xkb2Qt<XKB_KEY_Shift_Lock, Qt::Key_Shift>,
117 Xkb2Qt<XKB_KEY_Control_L, Qt::Key_Control>,
118 Xkb2Qt<XKB_KEY_Control_R, Qt::Key_Control>,
119 Xkb2Qt<XKB_KEY_Meta_L, Qt::Key_Meta>,
120 Xkb2Qt<XKB_KEY_Meta_R, Qt::Key_Meta>,
121 Xkb2Qt<XKB_KEY_Alt_L, Qt::Key_Alt>,
122 Xkb2Qt<XKB_KEY_Alt_R, Qt::Key_Alt>,
123 Xkb2Qt<XKB_KEY_Caps_Lock, Qt::Key_CapsLock>,
124 Xkb2Qt<XKB_KEY_Num_Lock, Qt::Key_NumLock>,
125 Xkb2Qt<XKB_KEY_Scroll_Lock, Qt::Key_ScrollLock>,
126 Xkb2Qt<XKB_KEY_Super_L, Qt::Key_Super_L>,
127 Xkb2Qt<XKB_KEY_Super_R, Qt::Key_Super_R>,
128 Xkb2Qt<XKB_KEY_Menu, Qt::Key_Menu>,
129 Xkb2Qt<XKB_KEY_Hyper_L, Qt::Key_Hyper_L>,
130 Xkb2Qt<XKB_KEY_Hyper_R, Qt::Key_Hyper_R>,
131 Xkb2Qt<XKB_KEY_Help, Qt::Key_Help>,
132 Xkb2Qt<0x1000FF74, Qt::Key_Backtab>, // hardcoded HP backtab
133 Xkb2Qt<0x1005FF10, Qt::Key_F11>, // hardcoded Sun F36 (labeled F11)
134 Xkb2Qt<0x1005FF11, Qt::Key_F12>, // hardcoded Sun F37 (labeled F12)
135
136 // numeric and function keypad keys
137
138 Xkb2Qt<XKB_KEY_KP_Space, Qt::Key_Space>,
139 Xkb2Qt<XKB_KEY_KP_Tab, Qt::Key_Tab>,
140 Xkb2Qt<XKB_KEY_KP_Enter, Qt::Key_Enter>,
141 Xkb2Qt<XKB_KEY_KP_Home, Qt::Key_Home>,
142 Xkb2Qt<XKB_KEY_KP_Left, Qt::Key_Left>,
143 Xkb2Qt<XKB_KEY_KP_Up, Qt::Key_Up>,
144 Xkb2Qt<XKB_KEY_KP_Right, Qt::Key_Right>,
145 Xkb2Qt<XKB_KEY_KP_Down, Qt::Key_Down>,
146 Xkb2Qt<XKB_KEY_KP_Prior, Qt::Key_PageUp>,
147 Xkb2Qt<XKB_KEY_KP_Next, Qt::Key_PageDown>,
148 Xkb2Qt<XKB_KEY_KP_End, Qt::Key_End>,
149 Xkb2Qt<XKB_KEY_KP_Begin, Qt::Key_Clear>,
150 Xkb2Qt<XKB_KEY_KP_Insert, Qt::Key_Insert>,
151 Xkb2Qt<XKB_KEY_KP_Delete, Qt::Key_Delete>,
152 Xkb2Qt<XKB_KEY_KP_Equal, Qt::Key_Equal>,
153 Xkb2Qt<XKB_KEY_KP_Multiply, Qt::Key_Asterisk>,
154 Xkb2Qt<XKB_KEY_KP_Add, Qt::Key_Plus>,
155 Xkb2Qt<XKB_KEY_KP_Separator, Qt::Key_Comma>,
156 Xkb2Qt<XKB_KEY_KP_Subtract, Qt::Key_Minus>,
157 Xkb2Qt<XKB_KEY_KP_Decimal, Qt::Key_Period>,
158 Xkb2Qt<XKB_KEY_KP_Divide, Qt::Key_Slash>,
159
160 // special non-XF86 function keys
161
162 Xkb2Qt<XKB_KEY_Undo, Qt::Key_Undo>,
163 Xkb2Qt<XKB_KEY_Redo, Qt::Key_Redo>,
164 Xkb2Qt<XKB_KEY_Find, Qt::Key_Find>,
165 Xkb2Qt<XKB_KEY_Cancel, Qt::Key_Cancel>,
166
167 // International input method support keys
168
169 // International & multi-key character composition
170 Xkb2Qt<XKB_KEY_ISO_Level3_Shift, Qt::Key_AltGr>,
171 Xkb2Qt<XKB_KEY_Multi_key, Qt::Key_Multi_key>,
172 Xkb2Qt<XKB_KEY_Codeinput, Qt::Key_Codeinput>,
173 Xkb2Qt<XKB_KEY_SingleCandidate, Qt::Key_SingleCandidate>,
174 Xkb2Qt<XKB_KEY_MultipleCandidate, Qt::Key_MultipleCandidate>,
175 Xkb2Qt<XKB_KEY_PreviousCandidate, Qt::Key_PreviousCandidate>,
176
177 // Misc Functions
178 Xkb2Qt<XKB_KEY_Mode_switch, Qt::Key_Mode_switch>,
179 Xkb2Qt<XKB_KEY_script_switch, Qt::Key_Mode_switch>,
180
181 // Japanese keyboard support
182 Xkb2Qt<XKB_KEY_Kanji, Qt::Key_Kanji>,
183 Xkb2Qt<XKB_KEY_Muhenkan, Qt::Key_Muhenkan>,
184 //Xkb2Qt<XKB_KEY_Henkan_Mode, Qt::Key_Henkan_Mode>,
185 Xkb2Qt<XKB_KEY_Henkan_Mode, Qt::Key_Henkan>,
186 Xkb2Qt<XKB_KEY_Henkan, Qt::Key_Henkan>,
187 Xkb2Qt<XKB_KEY_Romaji, Qt::Key_Romaji>,
188 Xkb2Qt<XKB_KEY_Hiragana, Qt::Key_Hiragana>,
189 Xkb2Qt<XKB_KEY_Katakana, Qt::Key_Katakana>,
190 Xkb2Qt<XKB_KEY_Hiragana_Katakana, Qt::Key_Hiragana_Katakana>,
191 Xkb2Qt<XKB_KEY_Zenkaku, Qt::Key_Zenkaku>,
192 Xkb2Qt<XKB_KEY_Hankaku, Qt::Key_Hankaku>,
193 Xkb2Qt<XKB_KEY_Zenkaku_Hankaku, Qt::Key_Zenkaku_Hankaku>,
194 Xkb2Qt<XKB_KEY_Touroku, Qt::Key_Touroku>,
195 Xkb2Qt<XKB_KEY_Massyo, Qt::Key_Massyo>,
196 Xkb2Qt<XKB_KEY_Kana_Lock, Qt::Key_Kana_Lock>,
197 Xkb2Qt<XKB_KEY_Kana_Shift, Qt::Key_Kana_Shift>,
198 Xkb2Qt<XKB_KEY_Eisu_Shift, Qt::Key_Eisu_Shift>,
199 Xkb2Qt<XKB_KEY_Eisu_toggle, Qt::Key_Eisu_toggle>,
200 //Xkb2Qt<XKB_KEY_Kanji_Bangou, Qt::Key_Kanji_Bangou>,
201 //Xkb2Qt<XKB_KEY_Zen_Koho, Qt::Key_Zen_Koho>,
202 //Xkb2Qt<XKB_KEY_Mae_Koho, Qt::Key_Mae_Koho>,
203 Xkb2Qt<XKB_KEY_Kanji_Bangou, Qt::Key_Codeinput>,
204 Xkb2Qt<XKB_KEY_Zen_Koho, Qt::Key_MultipleCandidate>,
205 Xkb2Qt<XKB_KEY_Mae_Koho, Qt::Key_PreviousCandidate>,
206
207 // Korean keyboard support
208 Xkb2Qt<XKB_KEY_Hangul, Qt::Key_Hangul>,
209 Xkb2Qt<XKB_KEY_Hangul_Start, Qt::Key_Hangul_Start>,
210 Xkb2Qt<XKB_KEY_Hangul_End, Qt::Key_Hangul_End>,
211 Xkb2Qt<XKB_KEY_Hangul_Hanja, Qt::Key_Hangul_Hanja>,
212 Xkb2Qt<XKB_KEY_Hangul_Jamo, Qt::Key_Hangul_Jamo>,
213 Xkb2Qt<XKB_KEY_Hangul_Romaja, Qt::Key_Hangul_Romaja>,
214 //Xkb2Qt<XKB_KEY_Hangul_Codeinput, Qt::Key_Hangul_Codeinput>,
215 Xkb2Qt<XKB_KEY_Hangul_Codeinput, Qt::Key_Codeinput>,
216 Xkb2Qt<XKB_KEY_Hangul_Jeonja, Qt::Key_Hangul_Jeonja>,
217 Xkb2Qt<XKB_KEY_Hangul_Banja, Qt::Key_Hangul_Banja>,
218 Xkb2Qt<XKB_KEY_Hangul_PreHanja, Qt::Key_Hangul_PreHanja>,
219 Xkb2Qt<XKB_KEY_Hangul_PostHanja, Qt::Key_Hangul_PostHanja>,
220 //Xkb2Qt<XKB_KEY_Hangul_SingleCandidate,Qt::Key_Hangul_SingleCandidate>,
221 //Xkb2Qt<XKB_KEY_Hangul_MultipleCandidate,Qt::Key_Hangul_MultipleCandidate>,
222 //Xkb2Qt<XKB_KEY_Hangul_PreviousCandidate,Qt::Key_Hangul_PreviousCandidate>,
223 Xkb2Qt<XKB_KEY_Hangul_SingleCandidate, Qt::Key_SingleCandidate>,
224 Xkb2Qt<XKB_KEY_Hangul_MultipleCandidate,Qt::Key_MultipleCandidate>,
225 Xkb2Qt<XKB_KEY_Hangul_PreviousCandidate,Qt::Key_PreviousCandidate>,
226 Xkb2Qt<XKB_KEY_Hangul_Special, Qt::Key_Hangul_Special>,
227 //Xkb2Qt<XKB_KEY_Hangul_switch, Qt::Key_Hangul_switch>,
228 Xkb2Qt<XKB_KEY_Hangul_switch, Qt::Key_Mode_switch>,
229
230 // dead keys
231 Xkb2Qt<XKB_KEY_dead_grave, Qt::Key_Dead_Grave>,
232 Xkb2Qt<XKB_KEY_dead_acute, Qt::Key_Dead_Acute>,
233 Xkb2Qt<XKB_KEY_dead_circumflex, Qt::Key_Dead_Circumflex>,
234 Xkb2Qt<XKB_KEY_dead_tilde, Qt::Key_Dead_Tilde>,
235 Xkb2Qt<XKB_KEY_dead_macron, Qt::Key_Dead_Macron>,
236 Xkb2Qt<XKB_KEY_dead_breve, Qt::Key_Dead_Breve>,
237 Xkb2Qt<XKB_KEY_dead_abovedot, Qt::Key_Dead_Abovedot>,
238 Xkb2Qt<XKB_KEY_dead_diaeresis, Qt::Key_Dead_Diaeresis>,
239 Xkb2Qt<XKB_KEY_dead_abovering, Qt::Key_Dead_Abovering>,
240 Xkb2Qt<XKB_KEY_dead_doubleacute, Qt::Key_Dead_Doubleacute>,
241 Xkb2Qt<XKB_KEY_dead_caron, Qt::Key_Dead_Caron>,
242 Xkb2Qt<XKB_KEY_dead_cedilla, Qt::Key_Dead_Cedilla>,
243 Xkb2Qt<XKB_KEY_dead_ogonek, Qt::Key_Dead_Ogonek>,
244 Xkb2Qt<XKB_KEY_dead_iota, Qt::Key_Dead_Iota>,
245 Xkb2Qt<XKB_KEY_dead_voiced_sound, Qt::Key_Dead_Voiced_Sound>,
246 Xkb2Qt<XKB_KEY_dead_semivoiced_sound, Qt::Key_Dead_Semivoiced_Sound>,
247 Xkb2Qt<XKB_KEY_dead_belowdot, Qt::Key_Dead_Belowdot>,
248 Xkb2Qt<XKB_KEY_dead_hook, Qt::Key_Dead_Hook>,
249 Xkb2Qt<XKB_KEY_dead_horn, Qt::Key_Dead_Horn>,
250 Xkb2Qt<XKB_KEY_dead_stroke, Qt::Key_Dead_Stroke>,
251 Xkb2Qt<XKB_KEY_dead_abovecomma, Qt::Key_Dead_Abovecomma>,
252 Xkb2Qt<XKB_KEY_dead_abovereversedcomma, Qt::Key_Dead_Abovereversedcomma>,
253 Xkb2Qt<XKB_KEY_dead_doublegrave, Qt::Key_Dead_Doublegrave>,
254 Xkb2Qt<XKB_KEY_dead_belowring, Qt::Key_Dead_Belowring>,
255 Xkb2Qt<XKB_KEY_dead_belowmacron, Qt::Key_Dead_Belowmacron>,
256 Xkb2Qt<XKB_KEY_dead_belowcircumflex, Qt::Key_Dead_Belowcircumflex>,
257 Xkb2Qt<XKB_KEY_dead_belowtilde, Qt::Key_Dead_Belowtilde>,
258 Xkb2Qt<XKB_KEY_dead_belowbreve, Qt::Key_Dead_Belowbreve>,
259 Xkb2Qt<XKB_KEY_dead_belowdiaeresis, Qt::Key_Dead_Belowdiaeresis>,
260 Xkb2Qt<XKB_KEY_dead_invertedbreve, Qt::Key_Dead_Invertedbreve>,
261 Xkb2Qt<XKB_KEY_dead_belowcomma, Qt::Key_Dead_Belowcomma>,
262 Xkb2Qt<XKB_KEY_dead_currency, Qt::Key_Dead_Currency>,
263 Xkb2Qt<XKB_KEY_dead_a, Qt::Key_Dead_a>,
264 Xkb2Qt<XKB_KEY_dead_A, Qt::Key_Dead_A>,
265 Xkb2Qt<XKB_KEY_dead_e, Qt::Key_Dead_e>,
266 Xkb2Qt<XKB_KEY_dead_E, Qt::Key_Dead_E>,
267 Xkb2Qt<XKB_KEY_dead_i, Qt::Key_Dead_i>,
268 Xkb2Qt<XKB_KEY_dead_I, Qt::Key_Dead_I>,
269 Xkb2Qt<XKB_KEY_dead_o, Qt::Key_Dead_o>,
270 Xkb2Qt<XKB_KEY_dead_O, Qt::Key_Dead_O>,
271 Xkb2Qt<XKB_KEY_dead_u, Qt::Key_Dead_u>,
272 Xkb2Qt<XKB_KEY_dead_U, Qt::Key_Dead_U>,
273 Xkb2Qt<XKB_KEY_dead_small_schwa, Qt::Key_Dead_Small_Schwa>,
274 Xkb2Qt<XKB_KEY_dead_capital_schwa, Qt::Key_Dead_Capital_Schwa>,
275 Xkb2Qt<XKB_KEY_dead_greek, Qt::Key_Dead_Greek>,
276 Xkb2Qt<XKB_KEY_dead_lowline, Qt::Key_Dead_Lowline>,
277 Xkb2Qt<XKB_KEY_dead_aboveverticalline, Qt::Key_Dead_Aboveverticalline>,
278 Xkb2Qt<XKB_KEY_dead_belowverticalline, Qt::Key_Dead_Belowverticalline>,
279 Xkb2Qt<XKB_KEY_dead_longsolidusoverlay, Qt::Key_Dead_Longsolidusoverlay>,
280
281 // Special keys from X.org - This include multimedia keys,
282 // wireless/bluetooth/uwb keys, special launcher keys, etc.
283 Xkb2Qt<XKB_KEY_XF86Back, Qt::Key_Back>,
284 Xkb2Qt<XKB_KEY_XF86Forward, Qt::Key_Forward>,
285 Xkb2Qt<XKB_KEY_XF86Stop, Qt::Key_Stop>,
286 Xkb2Qt<XKB_KEY_XF86Refresh, Qt::Key_Refresh>,
287 Xkb2Qt<XKB_KEY_XF86Favorites, Qt::Key_Favorites>,
288 Xkb2Qt<XKB_KEY_XF86AudioMedia, Qt::Key_LaunchMedia>,
289 Xkb2Qt<XKB_KEY_XF86OpenURL, Qt::Key_OpenUrl>,
290 Xkb2Qt<XKB_KEY_XF86HomePage, Qt::Key_HomePage>,
291 Xkb2Qt<XKB_KEY_XF86Search, Qt::Key_Search>,
292 Xkb2Qt<XKB_KEY_XF86AudioLowerVolume, Qt::Key_VolumeDown>,
293 Xkb2Qt<XKB_KEY_XF86AudioMute, Qt::Key_VolumeMute>,
294 Xkb2Qt<XKB_KEY_XF86AudioRaiseVolume, Qt::Key_VolumeUp>,
295 Xkb2Qt<XKB_KEY_XF86AudioPlay, Qt::Key_MediaPlay>,
296 Xkb2Qt<XKB_KEY_XF86AudioStop, Qt::Key_MediaStop>,
297 Xkb2Qt<XKB_KEY_XF86AudioPrev, Qt::Key_MediaPrevious>,
298 Xkb2Qt<XKB_KEY_XF86AudioNext, Qt::Key_MediaNext>,
299 Xkb2Qt<XKB_KEY_XF86AudioRecord, Qt::Key_MediaRecord>,
300 Xkb2Qt<XKB_KEY_XF86AudioPause, Qt::Key_MediaPause>,
301 Xkb2Qt<XKB_KEY_XF86Mail, Qt::Key_LaunchMail>,
302 Xkb2Qt<XKB_KEY_XF86MyComputer, Qt::Key_Launch0>, // ### Qt 6: remap properly
303 Xkb2Qt<XKB_KEY_XF86Calculator, Qt::Key_Launch1>,
304 Xkb2Qt<XKB_KEY_XF86Memo, Qt::Key_Memo>,
305 Xkb2Qt<XKB_KEY_XF86ToDoList, Qt::Key_ToDoList>,
306 Xkb2Qt<XKB_KEY_XF86Calendar, Qt::Key_Calendar>,
307 Xkb2Qt<XKB_KEY_XF86PowerDown, Qt::Key_PowerDown>,
308 Xkb2Qt<XKB_KEY_XF86ContrastAdjust, Qt::Key_ContrastAdjust>,
309 Xkb2Qt<XKB_KEY_XF86Standby, Qt::Key_Standby>,
310 Xkb2Qt<XKB_KEY_XF86MonBrightnessUp, Qt::Key_MonBrightnessUp>,
311 Xkb2Qt<XKB_KEY_XF86MonBrightnessDown, Qt::Key_MonBrightnessDown>,
312 Xkb2Qt<XKB_KEY_XF86KbdLightOnOff, Qt::Key_KeyboardLightOnOff>,
313 Xkb2Qt<XKB_KEY_XF86KbdBrightnessUp, Qt::Key_KeyboardBrightnessUp>,
314 Xkb2Qt<XKB_KEY_XF86KbdBrightnessDown, Qt::Key_KeyboardBrightnessDown>,
315 Xkb2Qt<XKB_KEY_XF86PowerOff, Qt::Key_PowerOff>,
316 Xkb2Qt<XKB_KEY_XF86WakeUp, Qt::Key_WakeUp>,
317 Xkb2Qt<XKB_KEY_XF86Eject, Qt::Key_Eject>,
318 Xkb2Qt<XKB_KEY_XF86ScreenSaver, Qt::Key_ScreenSaver>,
319 Xkb2Qt<XKB_KEY_XF86WWW, Qt::Key_WWW>,
320 Xkb2Qt<XKB_KEY_XF86Sleep, Qt::Key_Sleep>,
321 Xkb2Qt<XKB_KEY_XF86LightBulb, Qt::Key_LightBulb>,
322 Xkb2Qt<XKB_KEY_XF86Shop, Qt::Key_Shop>,
323 Xkb2Qt<XKB_KEY_XF86History, Qt::Key_History>,
324 Xkb2Qt<XKB_KEY_XF86AddFavorite, Qt::Key_AddFavorite>,
325 Xkb2Qt<XKB_KEY_XF86HotLinks, Qt::Key_HotLinks>,
326 Xkb2Qt<XKB_KEY_XF86BrightnessAdjust, Qt::Key_BrightnessAdjust>,
327 Xkb2Qt<XKB_KEY_XF86Finance, Qt::Key_Finance>,
328 Xkb2Qt<XKB_KEY_XF86Community, Qt::Key_Community>,
329 Xkb2Qt<XKB_KEY_XF86AudioRewind, Qt::Key_AudioRewind>,
330 Xkb2Qt<XKB_KEY_XF86BackForward, Qt::Key_BackForward>,
331 Xkb2Qt<XKB_KEY_XF86ApplicationLeft, Qt::Key_ApplicationLeft>,
332 Xkb2Qt<XKB_KEY_XF86ApplicationRight, Qt::Key_ApplicationRight>,
333 Xkb2Qt<XKB_KEY_XF86Book, Qt::Key_Book>,
334 Xkb2Qt<XKB_KEY_XF86CD, Qt::Key_CD>,
335 Xkb2Qt<XKB_KEY_XF86Calculater, Qt::Key_Calculator>,
336 Xkb2Qt<XKB_KEY_XF86Clear, Qt::Key_Clear>,
337 Xkb2Qt<XKB_KEY_XF86ClearGrab, Qt::Key_ClearGrab>,
338 Xkb2Qt<XKB_KEY_XF86Close, Qt::Key_Close>,
339 Xkb2Qt<XKB_KEY_XF86Copy, Qt::Key_Copy>,
340 Xkb2Qt<XKB_KEY_XF86Cut, Qt::Key_Cut>,
341 Xkb2Qt<XKB_KEY_XF86Display, Qt::Key_Display>,
342 Xkb2Qt<XKB_KEY_XF86DOS, Qt::Key_DOS>,
343 Xkb2Qt<XKB_KEY_XF86Documents, Qt::Key_Documents>,
344 Xkb2Qt<XKB_KEY_XF86Excel, Qt::Key_Excel>,
345 Xkb2Qt<XKB_KEY_XF86Explorer, Qt::Key_Explorer>,
346 Xkb2Qt<XKB_KEY_XF86Game, Qt::Key_Game>,
347 Xkb2Qt<XKB_KEY_XF86Go, Qt::Key_Go>,
348 Xkb2Qt<XKB_KEY_XF86iTouch, Qt::Key_iTouch>,
349 Xkb2Qt<XKB_KEY_XF86LogOff, Qt::Key_LogOff>,
350 Xkb2Qt<XKB_KEY_XF86Market, Qt::Key_Market>,
351 Xkb2Qt<XKB_KEY_XF86Meeting, Qt::Key_Meeting>,
352 Xkb2Qt<XKB_KEY_XF86MenuKB, Qt::Key_MenuKB>,
353 Xkb2Qt<XKB_KEY_XF86MenuPB, Qt::Key_MenuPB>,
354 Xkb2Qt<XKB_KEY_XF86MySites, Qt::Key_MySites>,
355 Xkb2Qt<XKB_KEY_XF86New, Qt::Key_New>,
356 Xkb2Qt<XKB_KEY_XF86News, Qt::Key_News>,
357 Xkb2Qt<XKB_KEY_XF86OfficeHome, Qt::Key_OfficeHome>,
358 Xkb2Qt<XKB_KEY_XF86Open, Qt::Key_Open>,
359 Xkb2Qt<XKB_KEY_XF86Option, Qt::Key_Option>,
360 Xkb2Qt<XKB_KEY_XF86Paste, Qt::Key_Paste>,
361 Xkb2Qt<XKB_KEY_XF86Phone, Qt::Key_Phone>,
362 Xkb2Qt<XKB_KEY_XF86Reply, Qt::Key_Reply>,
363 Xkb2Qt<XKB_KEY_XF86Reload, Qt::Key_Reload>,
364 Xkb2Qt<XKB_KEY_XF86RotateWindows, Qt::Key_RotateWindows>,
365 Xkb2Qt<XKB_KEY_XF86RotationPB, Qt::Key_RotationPB>,
366 Xkb2Qt<XKB_KEY_XF86RotationKB, Qt::Key_RotationKB>,
367 Xkb2Qt<XKB_KEY_XF86Save, Qt::Key_Save>,
368 Xkb2Qt<XKB_KEY_XF86Send, Qt::Key_Send>,
369 Xkb2Qt<XKB_KEY_XF86Spell, Qt::Key_Spell>,
370 Xkb2Qt<XKB_KEY_XF86SplitScreen, Qt::Key_SplitScreen>,
371 Xkb2Qt<XKB_KEY_XF86Support, Qt::Key_Support>,
372 Xkb2Qt<XKB_KEY_XF86TaskPane, Qt::Key_TaskPane>,
373 Xkb2Qt<XKB_KEY_XF86Terminal, Qt::Key_Terminal>,
374 Xkb2Qt<XKB_KEY_XF86Tools, Qt::Key_Tools>,
375 Xkb2Qt<XKB_KEY_XF86Travel, Qt::Key_Travel>,
376 Xkb2Qt<XKB_KEY_XF86Video, Qt::Key_Video>,
377 Xkb2Qt<XKB_KEY_XF86Word, Qt::Key_Word>,
378 Xkb2Qt<XKB_KEY_XF86Xfer, Qt::Key_Xfer>,
379 Xkb2Qt<XKB_KEY_XF86ZoomIn, Qt::Key_ZoomIn>,
380 Xkb2Qt<XKB_KEY_XF86ZoomOut, Qt::Key_ZoomOut>,
381 Xkb2Qt<XKB_KEY_XF86Away, Qt::Key_Away>,
382 Xkb2Qt<XKB_KEY_XF86Messenger, Qt::Key_Messenger>,
383 Xkb2Qt<XKB_KEY_XF86WebCam, Qt::Key_WebCam>,
384 Xkb2Qt<XKB_KEY_XF86MailForward, Qt::Key_MailForward>,
385 Xkb2Qt<XKB_KEY_XF86Pictures, Qt::Key_Pictures>,
386 Xkb2Qt<XKB_KEY_XF86Music, Qt::Key_Music>,
387 Xkb2Qt<XKB_KEY_XF86Battery, Qt::Key_Battery>,
388 Xkb2Qt<XKB_KEY_XF86Bluetooth, Qt::Key_Bluetooth>,
389 Xkb2Qt<XKB_KEY_XF86WLAN, Qt::Key_WLAN>,
390 Xkb2Qt<XKB_KEY_XF86UWB, Qt::Key_UWB>,
391 Xkb2Qt<XKB_KEY_XF86AudioForward, Qt::Key_AudioForward>,
392 Xkb2Qt<XKB_KEY_XF86AudioRepeat, Qt::Key_AudioRepeat>,
393 Xkb2Qt<XKB_KEY_XF86AudioRandomPlay, Qt::Key_AudioRandomPlay>,
394 Xkb2Qt<XKB_KEY_XF86Subtitle, Qt::Key_Subtitle>,
395 Xkb2Qt<XKB_KEY_XF86AudioCycleTrack, Qt::Key_AudioCycleTrack>,
396 Xkb2Qt<XKB_KEY_XF86Time, Qt::Key_Time>,
397 Xkb2Qt<XKB_KEY_XF86Select, Qt::Key_Select>,
398 Xkb2Qt<XKB_KEY_XF86View, Qt::Key_View>,
399 Xkb2Qt<XKB_KEY_XF86TopMenu, Qt::Key_TopMenu>,
400 Xkb2Qt<XKB_KEY_XF86Red, Qt::Key_Red>,
401 Xkb2Qt<XKB_KEY_XF86Green, Qt::Key_Green>,
402 Xkb2Qt<XKB_KEY_XF86Yellow, Qt::Key_Yellow>,
403 Xkb2Qt<XKB_KEY_XF86Blue, Qt::Key_Blue>,
404 Xkb2Qt<XKB_KEY_XF86Bluetooth, Qt::Key_Bluetooth>,
405 Xkb2Qt<XKB_KEY_XF86Suspend, Qt::Key_Suspend>,
406 Xkb2Qt<XKB_KEY_XF86Hibernate, Qt::Key_Hibernate>,
407 Xkb2Qt<XKB_KEY_XF86TouchpadToggle, Qt::Key_TouchpadToggle>,
408 Xkb2Qt<XKB_KEY_XF86TouchpadOn, Qt::Key_TouchpadOn>,
409 Xkb2Qt<XKB_KEY_XF86TouchpadOff, Qt::Key_TouchpadOff>,
410 Xkb2Qt<XKB_KEY_XF86AudioMicMute, Qt::Key_MicMute>,
411 Xkb2Qt<XKB_KEY_XF86Launch0, Qt::Key_Launch2>, // ### Qt 6: remap properly
412 Xkb2Qt<XKB_KEY_XF86Launch1, Qt::Key_Launch3>,
413 Xkb2Qt<XKB_KEY_XF86Launch2, Qt::Key_Launch4>,
414 Xkb2Qt<XKB_KEY_XF86Launch3, Qt::Key_Launch5>,
415 Xkb2Qt<XKB_KEY_XF86Launch4, Qt::Key_Launch6>,
416 Xkb2Qt<XKB_KEY_XF86Launch5, Qt::Key_Launch7>,
417 Xkb2Qt<XKB_KEY_XF86Launch6, Qt::Key_Launch8>,
418 Xkb2Qt<XKB_KEY_XF86Launch7, Qt::Key_Launch9>,
419 Xkb2Qt<XKB_KEY_XF86Launch8, Qt::Key_LaunchA>,
420 Xkb2Qt<XKB_KEY_XF86Launch9, Qt::Key_LaunchB>,
421 Xkb2Qt<XKB_KEY_XF86LaunchA, Qt::Key_LaunchC>,
422 Xkb2Qt<XKB_KEY_XF86LaunchB, Qt::Key_LaunchD>,
423 Xkb2Qt<XKB_KEY_XF86LaunchC, Qt::Key_LaunchE>,
424 Xkb2Qt<XKB_KEY_XF86LaunchD, Qt::Key_LaunchF>,
425 Xkb2Qt<XKB_KEY_XF86LaunchE, Qt::Key_LaunchG>,
426 Xkb2Qt<XKB_KEY_XF86LaunchF, Qt::Key_LaunchH>
427 >::Data{}
428);
429
430xkb_keysym_t QXkbCommon::qxkbcommon_xkb_keysym_to_upper(xkb_keysym_t ks)
431{
432 xkb_keysym_t lower, upper;
433
434 xkbcommon_XConvertCase(sym: ks, lower: &lower, upper: &upper);
435
436 return upper;
437}
438
439QString QXkbCommon::lookupString(struct xkb_state *state, xkb_keycode_t code)
440{
441 QVarLengthArray<char, 32> chars(32);
442 const int size = xkb_state_key_get_utf8(state, key: code, buffer: chars.data(), size: chars.size());
443 if (Q_UNLIKELY(size + 1 > chars.size())) { // +1 for NUL
444 chars.resize(asize: size + 1);
445 xkb_state_key_get_utf8(state, key: code, buffer: chars.data(), size: chars.size());
446 }
447 return QString::fromUtf8(str: chars.constData(), size);
448}
449
450QString QXkbCommon::lookupStringNoKeysymTransformations(xkb_keysym_t keysym)
451{
452 QVarLengthArray<char, 32> chars(32);
453 const int size = xkb_keysym_to_utf8(keysym, buffer: chars.data(), size: chars.size());
454 if (size == 0)
455 return QString(); // the keysym does not have a Unicode representation
456
457 if (Q_UNLIKELY(size > chars.size())) {
458 chars.resize(asize: size);
459 xkb_keysym_to_utf8(keysym, buffer: chars.data(), size: chars.size());
460 }
461 return QString::fromUtf8(str: chars.constData(), size: size - 1);
462}
463
464QVector<xkb_keysym_t> QXkbCommon::toKeysym(QKeyEvent *event)
465{
466 QVector<xkb_keysym_t> keysyms;
467 int qtKey = event->key();
468
469 if (qtKey >= Qt::Key_F1 && qtKey <= Qt::Key_F35) {
470 keysyms.append(XKB_KEY_F1 + (qtKey - Qt::Key_F1));
471 } else if (event->modifiers() & Qt::KeypadModifier) {
472 if (qtKey >= Qt::Key_0 && qtKey <= Qt::Key_9)
473 keysyms.append(XKB_KEY_KP_0 + (qtKey - Qt::Key_0));
474 } else if (isLatin(sym: qtKey) && event->text().isUpper()) {
475 keysyms.append(t: qtKey);
476 }
477
478 if (!keysyms.isEmpty())
479 return keysyms;
480
481 // check if we have a direct mapping
482 auto it = std::find_if(first: KeyTbl.cbegin(), last: KeyTbl.cend(), pred: [&qtKey](xkb2qt_t elem) {
483 return elem.qt == static_cast<uint>(qtKey);
484 });
485 if (it != KeyTbl.end()) {
486 keysyms.append(t: it->xkb);
487 return keysyms;
488 }
489
490 QVector<uint> ucs4;
491 if (event->text().isEmpty())
492 ucs4.append(t: qtKey);
493 else
494 ucs4 = event->text().toUcs4();
495
496 // From libxkbcommon keysym-utf.c:
497 // "We allow to represent any UCS character in the range U-00000000 to
498 // U-00FFFFFF by a keysym value in the range 0x01000000 to 0x01ffffff."
499 for (uint utf32 : qAsConst(t&: ucs4))
500 keysyms.append(t: utf32 | 0x01000000);
501
502 return keysyms;
503}
504
505int QXkbCommon::keysymToQtKey(xkb_keysym_t keysym, Qt::KeyboardModifiers modifiers)
506{
507 return keysymToQtKey(keysym, modifiers, state: nullptr, code: 0);
508}
509
510int QXkbCommon::keysymToQtKey(xkb_keysym_t keysym, Qt::KeyboardModifiers modifiers,
511 xkb_state *state, xkb_keycode_t code,
512 bool superAsMeta, bool hyperAsMeta)
513{
514 // Note 1: All standard key sequences on linux (as defined in platform theme)
515 // that use a latin character also contain a control modifier, which is why
516 // checking for Qt::ControlModifier is sufficient here. It is possible to
517 // override QPlatformTheme::keyBindings() and provide custom sequences for
518 // QKeySequence::StandardKey. Custom sequences probably should respect this
519 // convention (alternatively, we could test against other modifiers here).
520 // Note 2: The possibleKeys() shorcut mechanism is not affected by this value
521 // adjustment and does its own thing.
522 if (modifiers & Qt::ControlModifier) {
523 // With standard shortcuts we should prefer a latin character, this is
524 // for checks like "some qkeyevent == QKeySequence::Copy" to work even
525 // when using for example 'russian' keyboard layout.
526 if (!QXkbCommon::isLatin(sym: keysym)) {
527 xkb_keysym_t latinKeysym = QXkbCommon::lookupLatinKeysym(state, keycode: code);
528 if (latinKeysym != XKB_KEY_NoSymbol)
529 keysym = latinKeysym;
530 }
531 }
532
533 return keysymToQtKey_internal(keysym, modifiers, state, code, superAsMeta, hyperAsMeta);
534}
535
536static int keysymToQtKey_internal(xkb_keysym_t keysym, Qt::KeyboardModifiers modifiers,
537 xkb_state *state, xkb_keycode_t code,
538 bool superAsMeta, bool hyperAsMeta)
539{
540 int qtKey = 0;
541
542 // lookup from direct mapping
543 if (keysym >= XKB_KEY_F1 && keysym <= XKB_KEY_F35) {
544 // function keys
545 qtKey = Qt::Key_F1 + (keysym - XKB_KEY_F1);
546 } else if (keysym >= XKB_KEY_KP_0 && keysym <= XKB_KEY_KP_9) {
547 // numeric keypad keys
548 qtKey = Qt::Key_0 + (keysym - XKB_KEY_KP_0);
549 } else if (QXkbCommon::isLatin(sym: keysym)) {
550 qtKey = QXkbCommon::qxkbcommon_xkb_keysym_to_upper(ks: keysym);
551 } else {
552 // check if we have a direct mapping
553 xkb2qt_t searchKey{.xkb: keysym, .qt: 0};
554 auto it = std::lower_bound(first: KeyTbl.cbegin(), last: KeyTbl.cend(), val: searchKey);
555 if (it != KeyTbl.end() && !(searchKey < *it))
556 qtKey = it->qt;
557 }
558
559 if (qtKey)
560 return qtKey;
561
562 // lookup from unicode
563 QString text;
564 if (!state || modifiers & Qt::ControlModifier) {
565 // Control modifier changes the text to ASCII control character, therefore we
566 // can't use this text to map keysym to a qt key. We can use the same keysym
567 // (it is not affectd by transformation) to obtain untransformed text. For details
568 // see "Appendix A. Default Symbol Transformations" in the XKB specification.
569 text = QXkbCommon::lookupStringNoKeysymTransformations(keysym);
570 } else {
571 text = QXkbCommon::lookupString(state, code);
572 }
573 if (!text.isEmpty()) {
574 if (text.unicode()->isDigit()) {
575 // Ensures that also non-latin digits are mapped to corresponding qt keys,
576 // e.g CTRL + Û² (arabic two), is mapped to CTRL + Qt::Key_2.
577 qtKey = Qt::Key_0 + text.unicode()->digitValue();
578 } else {
579 text = text.toUpper();
580 QStringIterator i(text);
581 qtKey = i.next(invalidAs: 0);
582 }
583 }
584
585 // translate Super/Hyper keys to Meta if we're using them as the MetaModifier
586 if (superAsMeta && (qtKey == Qt::Key_Super_L || qtKey == Qt::Key_Super_R))
587 qtKey = Qt::Key_Meta;
588 if (hyperAsMeta && (qtKey == Qt::Key_Hyper_L || qtKey == Qt::Key_Hyper_R))
589 qtKey = Qt::Key_Meta;
590
591 return qtKey;
592}
593
594Qt::KeyboardModifiers QXkbCommon::modifiers(struct xkb_state *state)
595{
596 Qt::KeyboardModifiers modifiers = Qt::NoModifier;
597
598 if (xkb_state_mod_name_is_active(state, XKB_MOD_NAME_CTRL, type: XKB_STATE_MODS_EFFECTIVE) > 0)
599 modifiers |= Qt::ControlModifier;
600 if (xkb_state_mod_name_is_active(state, XKB_MOD_NAME_ALT, type: XKB_STATE_MODS_EFFECTIVE) > 0)
601 modifiers |= Qt::AltModifier;
602 if (xkb_state_mod_name_is_active(state, XKB_MOD_NAME_SHIFT, type: XKB_STATE_MODS_EFFECTIVE) > 0)
603 modifiers |= Qt::ShiftModifier;
604 if (xkb_state_mod_name_is_active(state, XKB_MOD_NAME_LOGO, type: XKB_STATE_MODS_EFFECTIVE) > 0)
605 modifiers |= Qt::MetaModifier;
606
607 return modifiers;
608}
609
610// Possible modifier states.
611static const Qt::KeyboardModifiers ModsTbl[] = {
612 Qt::NoModifier, // 0
613 Qt::ShiftModifier, // 1
614 Qt::ControlModifier, // 2
615 Qt::ControlModifier | Qt::ShiftModifier, // 3
616 Qt::AltModifier, // 4
617 Qt::AltModifier | Qt::ShiftModifier, // 5
618 Qt::AltModifier | Qt::ControlModifier, // 6
619 Qt::AltModifier | Qt::ShiftModifier | Qt::ControlModifier, // 7
620 Qt::NoModifier // Fall-back to raw Key_*, for non-latin1 kb layouts
621};
622
623QList<int> QXkbCommon::possibleKeys(xkb_state *state, const QKeyEvent *event,
624 bool superAsMeta, bool hyperAsMeta)
625{
626 QList<int> result;
627 quint32 keycode = event->nativeScanCode();
628 Qt::KeyboardModifiers modifiers = event->modifiers();
629 xkb_keymap *keymap = xkb_state_get_keymap(state);
630 // turn off the modifier bits which doesn't participate in shortcuts
631 Qt::KeyboardModifiers notNeeded = Qt::KeypadModifier | Qt::GroupSwitchModifier;
632 modifiers &= ~notNeeded;
633 // create a fresh kb state and test against the relevant modifier combinations
634 ScopedXKBState scopedXkbQueryState(xkb_state_new(keymap));
635 xkb_state *queryState = scopedXkbQueryState.get();
636 if (!queryState) {
637 qCWarning(lcXkbcommon) << Q_FUNC_INFO << "failed to compile xkb keymap";
638 return result;
639 }
640 // get kb state from the master state and update the temporary state
641 xkb_layout_index_t lockedLayout = xkb_state_serialize_layout(state, components: XKB_STATE_LAYOUT_LOCKED);
642 xkb_mod_mask_t latchedMods = xkb_state_serialize_mods(state, components: XKB_STATE_MODS_LATCHED);
643 xkb_mod_mask_t lockedMods = xkb_state_serialize_mods(state, components: XKB_STATE_MODS_LOCKED);
644 xkb_mod_mask_t depressedMods = xkb_state_serialize_mods(state, components: XKB_STATE_MODS_DEPRESSED);
645 xkb_state_update_mask(state: queryState, depressed_mods: depressedMods, latched_mods: latchedMods, locked_mods: lockedMods, depressed_layout: 0, latched_layout: 0, locked_layout: lockedLayout);
646 // handle shortcuts for level three and above
647 xkb_layout_index_t layoutIndex = xkb_state_key_get_layout(state: queryState, key: keycode);
648 xkb_level_index_t levelIndex = 0;
649 if (layoutIndex != XKB_LAYOUT_INVALID) {
650 levelIndex = xkb_state_key_get_level(state: queryState, key: keycode, layout: layoutIndex);
651 if (levelIndex == XKB_LEVEL_INVALID)
652 levelIndex = 0;
653 }
654 if (levelIndex <= 1)
655 xkb_state_update_mask(state: queryState, depressed_mods: 0, latched_mods: latchedMods, locked_mods: lockedMods, depressed_layout: 0, latched_layout: 0, locked_layout: lockedLayout);
656
657 xkb_keysym_t sym = xkb_state_key_get_one_sym(state: queryState, key: keycode);
658 if (sym == XKB_KEY_NoSymbol)
659 return result;
660
661 int baseQtKey = keysymToQtKey_internal(keysym: sym, modifiers, state: queryState, code: keycode, superAsMeta, hyperAsMeta);
662 if (baseQtKey)
663 result += (baseQtKey + modifiers);
664
665 xkb_mod_index_t shiftMod = xkb_keymap_mod_get_index(keymap, name: "Shift");
666 xkb_mod_index_t altMod = xkb_keymap_mod_get_index(keymap, name: "Alt");
667 xkb_mod_index_t controlMod = xkb_keymap_mod_get_index(keymap, name: "Control");
668 xkb_mod_index_t metaMod = xkb_keymap_mod_get_index(keymap, name: "Meta");
669
670 Q_ASSERT(shiftMod < 32);
671 Q_ASSERT(altMod < 32);
672 Q_ASSERT(controlMod < 32);
673
674 xkb_mod_mask_t depressed;
675 int qtKey = 0;
676 // obtain a list of possible shortcuts for the given key event
677 for (uint i = 1; i < sizeof(ModsTbl) / sizeof(*ModsTbl) ; ++i) {
678 Qt::KeyboardModifiers neededMods = ModsTbl[i];
679 if ((modifiers & neededMods) == neededMods) {
680 if (i == 8) {
681 if (isLatin(sym: baseQtKey))
682 continue;
683 // add a latin key as a fall back key
684 sym = lookupLatinKeysym(state, keycode);
685 } else {
686 depressed = 0;
687 if (neededMods & Qt::AltModifier)
688 depressed |= (1 << altMod);
689 if (neededMods & Qt::ShiftModifier)
690 depressed |= (1 << shiftMod);
691 if (neededMods & Qt::ControlModifier)
692 depressed |= (1 << controlMod);
693 if (metaMod < 32 && neededMods & Qt::MetaModifier)
694 depressed |= (1 << metaMod);
695 xkb_state_update_mask(state: queryState, depressed_mods: depressed, latched_mods: latchedMods, locked_mods: lockedMods, depressed_layout: 0, latched_layout: 0, locked_layout: lockedLayout);
696 sym = xkb_state_key_get_one_sym(state: queryState, key: keycode);
697 }
698 if (sym == XKB_KEY_NoSymbol)
699 continue;
700
701 Qt::KeyboardModifiers mods = modifiers & ~neededMods;
702 qtKey = keysymToQtKey_internal(keysym: sym, modifiers: mods, state: queryState, code: keycode, superAsMeta, hyperAsMeta);
703 if (!qtKey || qtKey == baseQtKey)
704 continue;
705
706 // catch only more specific shortcuts, i.e. Ctrl+Shift+= also generates Ctrl++ and +,
707 // but Ctrl++ is more specific than +, so we should skip the last one
708 bool ambiguous = false;
709 for (int shortcut : qAsConst(t&: result)) {
710 if (int(shortcut & ~Qt::KeyboardModifierMask) == qtKey && (shortcut & mods) == mods) {
711 ambiguous = true;
712 break;
713 }
714 }
715 if (ambiguous)
716 continue;
717
718 result += (qtKey + mods);
719 }
720 }
721
722 return result;
723}
724
725void QXkbCommon::verifyHasLatinLayout(xkb_keymap *keymap)
726{
727 const xkb_layout_index_t layoutCount = xkb_keymap_num_layouts(keymap);
728 const xkb_keycode_t minKeycode = xkb_keymap_min_keycode(keymap);
729 const xkb_keycode_t maxKeycode = xkb_keymap_max_keycode(keymap);
730
731 const xkb_keysym_t *keysyms = nullptr;
732 int nrLatinKeys = 0;
733 for (xkb_layout_index_t layout = 0; layout < layoutCount; ++layout) {
734 for (xkb_keycode_t code = minKeycode; code < maxKeycode; ++code) {
735 xkb_keymap_key_get_syms_by_level(keymap, key: code, layout, level: 0, syms_out: &keysyms);
736 if (keysyms && isLatin(sym: keysyms[0]))
737 nrLatinKeys++;
738 if (nrLatinKeys > 10) // arbitrarily chosen threshold
739 return;
740 }
741 }
742 // This means that lookupLatinKeysym() will not find anything and latin
743 // key shortcuts might not work. This is a bug in the affected desktop
744 // environment. Usually can be solved via system settings by adding e.g. 'us'
745 // layout to the list of seleced layouts, or by using command line, "setxkbmap
746 // -layout rus,en". The position of latin key based layout in the list of the
747 // selected layouts is irrelevant. Properly functioning desktop environments
748 // handle this behind the scenes, even if no latin key based layout has been
749 // explicitly listed in the selected layouts.
750 qCDebug(lcXkbcommon, "no keyboard layouts with latin keys present");
751}
752
753xkb_keysym_t QXkbCommon::lookupLatinKeysym(xkb_state *state, xkb_keycode_t keycode)
754{
755 xkb_layout_index_t layout;
756 xkb_keysym_t sym = XKB_KEY_NoSymbol;
757 xkb_keymap *keymap = xkb_state_get_keymap(state);
758 const xkb_layout_index_t layoutCount = xkb_keymap_num_layouts_for_key(keymap, key: keycode);
759 const xkb_layout_index_t currentLayout = xkb_state_key_get_layout(state, key: keycode);
760 // Look at user layouts in the order in which they are defined in system
761 // settings to find a latin keysym.
762 for (layout = 0; layout < layoutCount; ++layout) {
763 if (layout == currentLayout)
764 continue;
765 const xkb_keysym_t *syms = nullptr;
766 xkb_level_index_t level = xkb_state_key_get_level(state, key: keycode, layout);
767 if (xkb_keymap_key_get_syms_by_level(keymap, key: keycode, layout, level, syms_out: &syms) != 1)
768 continue;
769 if (isLatin(sym: syms[0])) {
770 sym = syms[0];
771 break;
772 }
773 }
774
775 if (sym == XKB_KEY_NoSymbol)
776 return sym;
777
778 xkb_mod_mask_t latchedMods = xkb_state_serialize_mods(state, components: XKB_STATE_MODS_LATCHED);
779 xkb_mod_mask_t lockedMods = xkb_state_serialize_mods(state, components: XKB_STATE_MODS_LOCKED);
780
781 // Check for uniqueness, consider the following setup:
782 // setxkbmap -layout us,ru,us -variant dvorak,, -option 'grp:ctrl_alt_toggle' (set 'ru' as active).
783 // In this setup, the user would expect to trigger a ctrl+q shortcut by pressing ctrl+<physical x key>,
784 // because "US dvorak" is higher up in the layout settings list. This check verifies that an obtained
785 // 'sym' can not be acquired by any other layout higher up in the user's layout list. If it can be acquired
786 // then the obtained key is not unique. This prevents ctrl+<physical q key> from generating a ctrl+q
787 // shortcut in the above described setup. We don't want ctrl+<physical x key> and ctrl+<physical q key> to
788 // generate the same shortcut event in this case.
789 const xkb_keycode_t minKeycode = xkb_keymap_min_keycode(keymap);
790 const xkb_keycode_t maxKeycode = xkb_keymap_max_keycode(keymap);
791 ScopedXKBState queryState(xkb_state_new(keymap));
792 for (xkb_layout_index_t prevLayout = 0; prevLayout < layout; ++prevLayout) {
793 xkb_state_update_mask(state: queryState.get(), depressed_mods: 0, latched_mods: latchedMods, locked_mods: lockedMods, depressed_layout: 0, latched_layout: 0, locked_layout: prevLayout);
794 for (xkb_keycode_t code = minKeycode; code < maxKeycode; ++code) {
795 xkb_keysym_t prevSym = xkb_state_key_get_one_sym(state: queryState.get(), key: code);
796 if (prevSym == sym) {
797 sym = XKB_KEY_NoSymbol;
798 break;
799 }
800 }
801 }
802
803 return sym;
804}
805
806void QXkbCommon::setXkbContext(QPlatformInputContext *inputContext, struct xkb_context *context)
807{
808 if (!inputContext || !context)
809 return;
810
811 const char *const inputContextClassName = "QComposeInputContext";
812 const char *const normalizedSignature = "setXkbContext(xkb_context*)";
813
814 if (inputContext->objectName() != QLatin1String(inputContextClassName))
815 return;
816
817 static const QMetaMethod setXkbContext = [&]() {
818 int methodIndex = inputContext->metaObject()->indexOfMethod(method: normalizedSignature);
819 QMetaMethod method = inputContext->metaObject()->method(index: methodIndex);
820 Q_ASSERT(method.isValid());
821 if (!method.isValid())
822 qCWarning(lcXkbcommon) << normalizedSignature << "not found on" << inputContextClassName;
823 return method;
824 }();
825
826 if (!setXkbContext.isValid())
827 return;
828
829 setXkbContext.invoke(object: inputContext, connectionType: Qt::DirectConnection, Q_ARG(struct xkb_context*, context));
830}
831
832QT_END_NAMESPACE
833

source code of qtbase/src/platformsupport/input/xkbcommon/qxkbcommon.cpp