2 * Copyright © 2012 Intel Corporation
4 * Permission is hereby granted, free of charge, to any person obtaining a
5 * copy of this software and associated documentation files (the "Software"),
6 * to deal in the Software without restriction, including without limitation
7 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
8 * and/or sell copies of the Software, and to permit persons to whom the
9 * Software is furnished to do so, subject to the following conditions:
11 * The above copyright notice and this permission notice (including the next
12 * paragraph) shall be included in all copies or substantial portions of the
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
18 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
21 * DEALINGS IN THE SOFTWARE.
23 * Author: Daniel Stone <daniel@fooishbar.org>
29 #include <linux/input.h>
33 /* Offset between evdev keycodes (where KEY_ESCAPE is 1), and the evdev XKB
34 * keycode set (where ESC is 9). */
35 #define EVDEV_OFFSET 8
38 print_state(struct xkb_state *state)
40 struct xkb_keymap *keymap;
41 xkb_layout_index_t group;
45 group = xkb_state_serialize_layout(state, XKB_STATE_LAYOUT_EFFECTIVE);
46 mod = xkb_state_serialize_mods(state, XKB_STATE_MODS_EFFECTIVE);
47 /* led = xkb_state_serialize_leds(state, XKB_STATE_LEDS); */
48 if (!group && !mod /* && !led */) {
49 fprintf(stderr, "\tno state\n");
53 keymap = xkb_state_get_keymap(state);
55 for (group = 0; group < xkb_keymap_num_layouts(keymap); group++) {
56 if (xkb_state_layout_index_is_active(state, group,
57 XKB_STATE_LAYOUT_EFFECTIVE |
58 XKB_STATE_LAYOUT_DEPRESSED |
59 XKB_STATE_LAYOUT_LATCHED |
60 XKB_STATE_LAYOUT_LOCKED) <= 0)
62 fprintf(stderr, "\tgroup %s (%d): %s%s%s%s\n",
63 xkb_keymap_layout_get_name(keymap, group),
65 xkb_state_layout_index_is_active(state, group, XKB_STATE_LAYOUT_EFFECTIVE) > 0 ?
67 xkb_state_layout_index_is_active(state, group, XKB_STATE_LAYOUT_DEPRESSED) > 0 ?
69 xkb_state_layout_index_is_active(state, group, XKB_STATE_LAYOUT_LATCHED) > 0 ?
71 xkb_state_layout_index_is_active(state, group, XKB_STATE_LAYOUT_LOCKED) > 0 ?
75 for (mod = 0; mod < xkb_keymap_num_mods(keymap); mod++) {
76 if (xkb_state_mod_index_is_active(state, mod,
77 XKB_STATE_MODS_EFFECTIVE |
78 XKB_STATE_MODS_DEPRESSED |
79 XKB_STATE_MODS_LATCHED |
80 XKB_STATE_MODS_LOCKED) <= 0)
82 fprintf(stderr, "\tmod %s (%d): %s%s%s%s\n",
83 xkb_keymap_mod_get_name(keymap, mod),
85 xkb_state_mod_index_is_active(state, mod, XKB_STATE_MODS_EFFECTIVE) > 0 ?
87 xkb_state_mod_index_is_active(state, mod, XKB_STATE_MODS_DEPRESSED) > 0 ?
89 xkb_state_mod_index_is_active(state, mod, XKB_STATE_MODS_LATCHED) > 0 ?
91 xkb_state_mod_index_is_active(state, mod, XKB_STATE_MODS_LOCKED) > 0 ?
95 for (led = 0; led < xkb_keymap_num_leds(keymap); led++) {
96 if (xkb_state_led_index_is_active(state, led) <= 0)
98 fprintf(stderr, "\tled %s (%d): active\n",
99 xkb_keymap_led_get_name(keymap, led),
105 test_update_key(struct xkb_keymap *keymap)
107 struct xkb_state *state = xkb_state_new(keymap);
108 const xkb_keysym_t *syms;
109 xkb_keysym_t one_sym;
115 xkb_state_update_key(state, KEY_LEFTCTRL + EVDEV_OFFSET, XKB_KEY_DOWN);
116 fprintf(stderr, "dumping state for LCtrl down:\n");
118 assert(xkb_state_mod_name_is_active(state, XKB_MOD_NAME_CTRL,
119 XKB_STATE_MODS_DEPRESSED) > 0);
121 /* LCtrl + RAlt down */
122 xkb_state_update_key(state, KEY_RIGHTALT + EVDEV_OFFSET, XKB_KEY_DOWN);
123 fprintf(stderr, "dumping state for LCtrl + RAlt down:\n");
125 assert(xkb_state_mod_name_is_active(state, XKB_MOD_NAME_CTRL,
126 XKB_STATE_MODS_DEPRESSED) > 0);
127 assert(xkb_state_mod_name_is_active(state, XKB_MOD_NAME_ALT,
128 XKB_STATE_MODS_DEPRESSED) > 0);
129 assert(xkb_state_mod_names_are_active(state, XKB_STATE_MODS_DEPRESSED,
134 assert(xkb_state_mod_indices_are_active(state, XKB_STATE_MODS_DEPRESSED,
136 xkb_keymap_mod_get_index(keymap, XKB_MOD_NAME_CTRL),
137 xkb_keymap_mod_get_index(keymap, XKB_MOD_NAME_ALT),
138 XKB_MOD_INVALID) > 0);
139 assert(xkb_state_mod_names_are_active(state, XKB_STATE_MODS_DEPRESSED,
143 assert(xkb_state_mod_names_are_active(state, XKB_STATE_MODS_DEPRESSED,
144 XKB_STATE_MATCH_ALL |
145 XKB_STATE_MATCH_NON_EXCLUSIVE,
148 assert(xkb_state_mod_names_are_active(state, XKB_STATE_MODS_DEPRESSED,
149 (XKB_STATE_MATCH_ANY |
150 XKB_STATE_MATCH_NON_EXCLUSIVE),
155 xkb_state_update_key(state, KEY_LEFTCTRL + EVDEV_OFFSET, XKB_KEY_UP);
156 fprintf(stderr, "dumping state for RAlt down:\n");
158 assert(xkb_state_mod_name_is_active(state, XKB_MOD_NAME_CTRL,
159 XKB_STATE_MODS_EFFECTIVE) == 0);
160 assert(xkb_state_mod_name_is_active(state, XKB_MOD_NAME_ALT,
161 XKB_STATE_MODS_DEPRESSED) > 0);
162 assert(xkb_state_mod_names_are_active(state, XKB_STATE_MODS_DEPRESSED,
167 assert(xkb_state_mod_names_are_active(state, XKB_STATE_MODS_LATCHED,
174 xkb_state_update_key(state, KEY_RIGHTALT + EVDEV_OFFSET, XKB_KEY_UP);
175 assert(xkb_state_mod_name_is_active(state, XKB_MOD_NAME_ALT,
176 XKB_STATE_MODS_EFFECTIVE) == 0);
179 xkb_state_update_key(state, KEY_CAPSLOCK + EVDEV_OFFSET, XKB_KEY_DOWN);
180 assert(xkb_state_mod_name_is_active(state, XKB_MOD_NAME_CAPS,
181 XKB_STATE_MODS_DEPRESSED) > 0);
182 xkb_state_update_key(state, KEY_CAPSLOCK + EVDEV_OFFSET, XKB_KEY_UP);
183 fprintf(stderr, "dumping state for Caps Lock:\n");
185 assert(xkb_state_mod_name_is_active(state, XKB_MOD_NAME_CAPS,
186 XKB_STATE_MODS_DEPRESSED) == 0);
187 assert(xkb_state_mod_name_is_active(state, XKB_MOD_NAME_CAPS,
188 XKB_STATE_MODS_LOCKED) > 0);
189 assert(xkb_state_led_name_is_active(state, XKB_LED_NAME_CAPS) > 0);
190 num_syms = xkb_state_key_get_syms(state, KEY_Q + EVDEV_OFFSET, &syms);
191 assert(num_syms == 1 && syms[0] == XKB_KEY_Q);
193 /* Num Lock locked */
194 xkb_state_update_key(state, KEY_NUMLOCK + EVDEV_OFFSET, XKB_KEY_DOWN);
195 xkb_state_update_key(state, KEY_NUMLOCK + EVDEV_OFFSET, XKB_KEY_UP);
196 fprintf(stderr, "dumping state for Caps Lock + Num Lock:\n");
198 assert(xkb_state_mod_name_is_active(state, XKB_MOD_NAME_CAPS,
199 XKB_STATE_MODS_LOCKED) > 0);
200 assert(xkb_state_mod_name_is_active(state, "Mod2",
201 XKB_STATE_MODS_LOCKED) > 0);
202 num_syms = xkb_state_key_get_syms(state, KEY_KP1 + EVDEV_OFFSET, &syms);
203 assert(num_syms == 1 && syms[0] == XKB_KEY_KP_1);
204 assert(xkb_state_led_name_is_active(state, XKB_LED_NAME_NUM) > 0);
206 /* Num Lock unlocked */
207 xkb_state_update_key(state, KEY_NUMLOCK + EVDEV_OFFSET, XKB_KEY_DOWN);
208 xkb_state_update_key(state, KEY_NUMLOCK + EVDEV_OFFSET, XKB_KEY_UP);
210 /* Switch to group 2 */
211 xkb_state_update_key(state, KEY_COMPOSE + EVDEV_OFFSET, XKB_KEY_DOWN);
212 xkb_state_update_key(state, KEY_COMPOSE + EVDEV_OFFSET, XKB_KEY_UP);
213 assert(xkb_state_led_name_is_active(state, "Group 2") > 0);
214 assert(xkb_state_led_name_is_active(state, XKB_LED_NAME_NUM) == 0);
216 /* Switch back to group 1. */
217 xkb_state_update_key(state, KEY_COMPOSE + EVDEV_OFFSET, XKB_KEY_DOWN);
218 xkb_state_update_key(state, KEY_COMPOSE + EVDEV_OFFSET, XKB_KEY_UP);
221 xkb_state_update_key(state, KEY_CAPSLOCK + EVDEV_OFFSET, XKB_KEY_DOWN);
222 xkb_state_update_key(state, KEY_CAPSLOCK + EVDEV_OFFSET, XKB_KEY_UP);
223 assert(xkb_state_mod_name_is_active(state, XKB_MOD_NAME_CAPS,
224 XKB_STATE_MODS_EFFECTIVE) == 0);
225 assert(xkb_state_led_name_is_active(state, XKB_LED_NAME_CAPS) == 0);
226 num_syms = xkb_state_key_get_syms(state, KEY_Q + EVDEV_OFFSET, &syms);
227 assert(num_syms == 1 && syms[0] == XKB_KEY_q);
229 /* Multiple symbols */
230 num_syms = xkb_state_key_get_syms(state, KEY_6 + EVDEV_OFFSET, &syms);
231 assert(num_syms == 5 &&
232 syms[0] == XKB_KEY_H && syms[1] == XKB_KEY_E &&
233 syms[2] == XKB_KEY_L && syms[3] == XKB_KEY_L &&
234 syms[4] == XKB_KEY_O);
235 one_sym = xkb_state_key_get_one_sym(state, KEY_6 + EVDEV_OFFSET);
236 assert(one_sym == XKB_KEY_NoSymbol);
237 xkb_state_update_key(state, KEY_6 + EVDEV_OFFSET, XKB_KEY_DOWN);
238 xkb_state_update_key(state, KEY_6 + EVDEV_OFFSET, XKB_KEY_UP);
240 one_sym = xkb_state_key_get_one_sym(state, KEY_5 + EVDEV_OFFSET);
241 assert(one_sym == XKB_KEY_5);
243 xkb_state_unref(state);
247 test_serialisation(struct xkb_keymap *keymap)
249 struct xkb_state *state = xkb_state_new(keymap);
250 xkb_mod_mask_t base_mods;
251 xkb_mod_mask_t latched_mods;
252 xkb_mod_mask_t locked_mods;
253 xkb_mod_mask_t effective_mods;
254 xkb_mod_index_t caps, shift, ctrl;
255 xkb_layout_index_t base_group = 0;
256 xkb_layout_index_t latched_group = 0;
257 xkb_layout_index_t locked_group = 0;
261 caps = xkb_keymap_mod_get_index(keymap, XKB_MOD_NAME_CAPS);
262 assert(caps != XKB_MOD_INVALID);
263 shift = xkb_keymap_mod_get_index(keymap, XKB_MOD_NAME_SHIFT);
264 assert(shift != XKB_MOD_INVALID);
265 ctrl = xkb_keymap_mod_get_index(keymap, XKB_MOD_NAME_CTRL);
266 assert(ctrl != XKB_MOD_INVALID);
268 xkb_state_update_key(state, KEY_CAPSLOCK + EVDEV_OFFSET, XKB_KEY_DOWN);
269 xkb_state_update_key(state, KEY_CAPSLOCK + EVDEV_OFFSET, XKB_KEY_UP);
270 base_mods = xkb_state_serialize_mods(state, XKB_STATE_MODS_DEPRESSED);
271 assert(base_mods == 0);
272 latched_mods = xkb_state_serialize_mods(state, XKB_STATE_MODS_LATCHED);
273 assert(latched_mods == 0);
274 locked_mods = xkb_state_serialize_mods(state, XKB_STATE_MODS_LOCKED);
275 assert(locked_mods == (1U << caps));
276 effective_mods = xkb_state_serialize_mods(state, XKB_STATE_MODS_EFFECTIVE);
277 assert(effective_mods == locked_mods);
279 xkb_state_update_key(state, KEY_LEFTSHIFT + EVDEV_OFFSET, XKB_KEY_DOWN);
280 base_mods = xkb_state_serialize_mods(state, XKB_STATE_MODS_DEPRESSED);
281 assert(base_mods == (1U << shift));
282 latched_mods = xkb_state_serialize_mods(state, XKB_STATE_MODS_LATCHED);
283 assert(latched_mods == 0);
284 locked_mods = xkb_state_serialize_mods(state, XKB_STATE_MODS_LOCKED);
285 assert(locked_mods == (1U << caps));
286 effective_mods = xkb_state_serialize_mods(state, XKB_STATE_MODS_EFFECTIVE);
287 assert(effective_mods == (base_mods | locked_mods));
289 base_mods |= (1U << ctrl);
290 xkb_state_update_mask(state, base_mods, latched_mods, locked_mods,
291 base_group, latched_group, locked_group);
293 assert(xkb_state_mod_index_is_active(state, ctrl, XKB_STATE_MODS_DEPRESSED) > 0);
294 assert(xkb_state_mod_index_is_active(state, ctrl, XKB_STATE_MODS_EFFECTIVE) > 0);
296 xkb_state_unref(state);
300 test_repeat(struct xkb_keymap *keymap)
302 assert(!xkb_keymap_key_repeats(keymap, KEY_LEFTSHIFT + 8));
303 assert(xkb_keymap_key_repeats(keymap, KEY_A + 8));
304 assert(xkb_keymap_key_repeats(keymap, KEY_8 + 8));
305 assert(xkb_keymap_key_repeats(keymap, KEY_DOWN + 8));
306 assert(xkb_keymap_key_repeats(keymap, KEY_KBDILLUMDOWN + 8));
310 test_consume(struct xkb_keymap *keymap)
312 struct xkb_state *state = xkb_state_new(keymap);
313 xkb_mod_index_t alt, shift;
318 alt = xkb_keymap_mod_get_index(keymap, XKB_MOD_NAME_ALT);
319 assert(alt != XKB_MOD_INVALID);
320 shift = xkb_keymap_mod_get_index(keymap, XKB_MOD_NAME_SHIFT);
321 assert(shift != XKB_MOD_INVALID);
323 xkb_state_update_key(state, KEY_LEFTALT + EVDEV_OFFSET, XKB_KEY_DOWN);
324 xkb_state_update_key(state, KEY_LEFTSHIFT + EVDEV_OFFSET, XKB_KEY_DOWN);
325 xkb_state_update_key(state, KEY_EQUAL + EVDEV_OFFSET, XKB_KEY_DOWN);
327 fprintf(stderr, "dumping state for Alt-Shift-+\n");
330 mask = xkb_state_serialize_mods(state, XKB_STATE_MODS_EFFECTIVE);
331 assert(mask == ((1U << alt) | (1U << shift)));
332 mask = xkb_state_mod_mask_remove_consumed(state, KEY_EQUAL + EVDEV_OFFSET,
334 assert(mask == (1U << alt));
336 xkb_state_unref(state);
340 key_iter(struct xkb_keymap *keymap, xkb_keycode_t key, void *data)
342 xkb_keycode_t *counter = data;
344 assert(*counter == key);
349 test_range(struct xkb_keymap *keymap)
351 xkb_keycode_t counter;
353 assert(xkb_keymap_min_keycode(keymap) == 9);
354 assert(xkb_keymap_max_keycode(keymap) == 253);
356 counter = xkb_keymap_min_keycode(keymap);
357 xkb_keymap_key_for_each(keymap, key_iter, &counter);
358 assert(counter == xkb_keymap_max_keycode(keymap) + 1);
362 test_caps_keysym_transformation(struct xkb_keymap *keymap)
364 struct xkb_state *state = xkb_state_new(keymap);
365 xkb_mod_index_t caps, shift;
368 const xkb_keysym_t *syms;
372 /* See xkb_state_key_get_one_sym() for what's this all about. */
374 caps = xkb_keymap_mod_get_index(keymap, XKB_MOD_NAME_CAPS);
375 shift = xkb_keymap_mod_get_index(keymap, XKB_MOD_NAME_SHIFT);
376 assert(caps != XKB_MOD_INVALID && shift != XKB_MOD_INVALID);
378 assert(xkb_state_key_get_layout(state, KEY_A + 8) == 0);
379 assert(xkb_state_key_get_layout(state, KEY_SEMICOLON + 8) == 0);
381 /* Without caps, no transformation. */
382 assert(xkb_state_mod_index_is_active(state, caps, XKB_STATE_MODS_EFFECTIVE) == 0);
383 assert(xkb_state_mod_index_is_active(state, shift, XKB_STATE_MODS_EFFECTIVE) == 0);
384 assert(xkb_state_key_get_level(state, KEY_A + 8, 0) == 0);
385 sym = xkb_state_key_get_one_sym(state, KEY_A + 8);
386 assert(sym == XKB_KEY_a);
387 assert(xkb_state_key_get_level(state, KEY_SEMICOLON + 8, 0) == 0);
388 sym = xkb_state_key_get_one_sym(state, KEY_SEMICOLON + 8);
389 assert(sym == XKB_KEY_eacute);
390 nsyms = xkb_state_key_get_syms(state, KEY_SEMICOLON + 8, &syms);
391 assert(nsyms == 1 && syms[0] == XKB_KEY_eacute);
393 /* With shift, no transformation (only different level). */
394 xkb_state_update_key(state, KEY_LEFTSHIFT + 8, XKB_KEY_DOWN);
395 assert(xkb_state_mod_index_is_active(state, caps, XKB_STATE_MODS_EFFECTIVE) == 0);
396 assert(xkb_state_mod_index_is_active(state, shift, XKB_STATE_MODS_EFFECTIVE) > 0);
397 assert(xkb_state_key_get_level(state, KEY_A + 8, 0) == 1);
398 sym = xkb_state_key_get_one_sym(state, KEY_A + 8);
399 assert(sym == XKB_KEY_A);
400 sym = xkb_state_key_get_one_sym(state, KEY_SEMICOLON + 8);
401 assert(sym == XKB_KEY_odiaeresis);
402 nsyms = xkb_state_key_get_syms(state, KEY_SEMICOLON + 8, &syms);
403 assert(nsyms == 1 && syms[0] == XKB_KEY_odiaeresis);
404 xkb_state_update_key(state, KEY_LEFTSHIFT + 8, XKB_KEY_UP);
405 assert(xkb_state_mod_index_is_active(state, shift, XKB_STATE_MODS_EFFECTIVE) == 0);
407 /* With caps, transform in same level, only with _get_one_sym(). */
408 xkb_state_update_key(state, KEY_CAPSLOCK + 8, XKB_KEY_DOWN);
409 xkb_state_update_key(state, KEY_CAPSLOCK + 8, XKB_KEY_UP);
410 assert(xkb_state_mod_index_is_active(state, caps, XKB_STATE_MODS_EFFECTIVE) > 0);
411 assert(xkb_state_mod_index_is_active(state, shift, XKB_STATE_MODS_EFFECTIVE) == 0);
412 assert(xkb_state_key_get_level(state, KEY_A + 8, 0) == 1);
413 sym = xkb_state_key_get_one_sym(state, KEY_A + 8);
414 assert(sym == XKB_KEY_A);
415 assert(xkb_state_key_get_level(state, KEY_SEMICOLON + 8, 0) == 0);
416 sym = xkb_state_key_get_one_sym(state, KEY_SEMICOLON + 8);
417 assert(sym == XKB_KEY_Eacute);
418 nsyms = xkb_state_key_get_syms(state, KEY_SEMICOLON + 8, &syms);
419 assert(nsyms == 1 && syms[0] == XKB_KEY_eacute);
420 xkb_state_update_key(state, KEY_LEFTSHIFT + 8, XKB_KEY_UP);
421 assert(xkb_state_mod_index_is_active(state, shift, XKB_STATE_MODS_EFFECTIVE) == 0);
422 xkb_state_update_key(state, KEY_CAPSLOCK + 8, XKB_KEY_DOWN);
423 xkb_state_update_key(state, KEY_CAPSLOCK + 8, XKB_KEY_UP);
425 xkb_state_unref(state);
431 struct xkb_context *context = test_get_context(0);
432 struct xkb_keymap *keymap;
436 /* Make sure these are allowed. */
437 xkb_context_unref(NULL);
438 xkb_keymap_unref(NULL);
439 xkb_state_unref(NULL);
441 keymap = test_compile_rules(context, "evdev", "pc104", "us,ru", NULL, "grp:menu_toggle");
444 test_update_key(keymap);
445 test_serialisation(keymap);
447 test_consume(keymap);
450 xkb_keymap_unref(keymap);
451 keymap = test_compile_rules(context, "evdev", NULL, "ch", "fr", NULL);
454 test_caps_keysym_transformation(keymap);
456 xkb_keymap_unref(keymap);
457 xkb_context_unref(context);