test/state.c

   1 /*
   2  * Copyright © 2012 Intel Corporation
   3  *
   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:
  10  *
  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
  13  * Software.
  14  *
  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.
  22  *
  23  * Author: Daniel Stone <daniel@fooishbar.org>
  24  */
  25
  26 #include <assert.h>
  27 #include <stdio.h>
  28 #include <stdlib.h>
  29 #include <linux/input.h>
  30
  31 #include "test.h"
  32
  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
  36
  37 static void
  38 print_state(struct xkb_state *state)
  39 {
  40     struct xkb_keymap *keymap;
  41     xkb_layout_index_t group;
  42     xkb_mod_index_t mod;
  43     xkb_led_index_t led;
  44
  45     group = xkb_state_serialize_layout(state, XKB_STATE_EFFECTIVE);
  46     mod = xkb_state_serialize_mods(state, XKB_STATE_EFFECTIVE);
  47     /* led = xkb_state_serialize_leds(state, XKB_STATE_EFFECTIVE); */
  48     if (!group && !mod /* && !led */) {
  49         fprintf(stderr, "\tno state\n");
  50         return;
  51     }
  52
  53     keymap = xkb_state_get_keymap(state);
  54
  55     for (group = 0; group < xkb_keymap_num_layouts(keymap); group++) {
  56         if (xkb_state_layout_index_is_active(state, group, XKB_STATE_EFFECTIVE) != 1)
  57             continue;
  58         fprintf(stderr, "\tgroup %s (%d): %s%s%s%s\n",
  59                 xkb_keymap_layout_get_name(keymap, group),
  60                 group,
  61                 xkb_state_layout_index_is_active(state, group, XKB_STATE_EFFECTIVE) > 0 ?
  62                     "effective " : "",
  63                 xkb_state_layout_index_is_active(state, group, XKB_STATE_DEPRESSED) > 0 ?
  64                     "depressed " : "",
  65                 xkb_state_layout_index_is_active(state, group, XKB_STATE_LATCHED) > 0 ?
  66                     "latched " : "",
  67                 xkb_state_layout_index_is_active(state, group, XKB_STATE_LOCKED) > 0 ?
  68                     "locked " : "");
  69     }
  70
  71     for (mod = 0; mod < xkb_keymap_num_mods(keymap); mod++) {
  72         if (!xkb_state_mod_index_is_active(state, mod, XKB_STATE_EFFECTIVE))
  73             continue;
  74         fprintf(stderr, "\tmod %s (%d): %s%s%s\n",
  75                 xkb_keymap_mod_get_name(keymap, mod),
  76                 mod,
  77                 xkb_state_mod_index_is_active(state, mod, XKB_STATE_DEPRESSED) > 0 ?
  78                     "depressed " : "",
  79                 xkb_state_mod_index_is_active(state, mod, XKB_STATE_LATCHED) > 0 ?
  80                     "latched " : "",
  81                 xkb_state_mod_index_is_active(state, mod, XKB_STATE_LOCKED) > 0 ?
  82                     "locked " : "");
  83     }
  84
  85     for (led = 0; led < xkb_keymap_num_leds(keymap); led++) {
  86         if (!xkb_state_led_index_is_active(state, led))
  87             continue;
  88         fprintf(stderr, "\tled %s (%d): active\n",
  89                 xkb_keymap_led_get_name(keymap, led),
  90                 led);
  91     }
  92 }
  93
  94 static void
  95 test_update_key(struct xkb_keymap *keymap)
  96 {
  97     struct xkb_state *state = xkb_state_new(keymap);
  98     const xkb_keysym_t *syms;
  99     int num_syms;
 100
 101     assert(state);
 102
 103     /* LCtrl down */
 104     xkb_state_update_key(state, KEY_LEFTCTRL + EVDEV_OFFSET, XKB_KEY_DOWN);
 105     fprintf(stderr, "dumping state for LCtrl down:\n");
 106     print_state(state);
 107     assert(xkb_state_mod_name_is_active(state, XKB_MOD_NAME_CTRL,
 108                                         XKB_STATE_DEPRESSED) > 0);
 109
 110     /* LCtrl + RAlt down */
 111     xkb_state_update_key(state, KEY_RIGHTALT + EVDEV_OFFSET, XKB_KEY_DOWN);
 112     fprintf(stderr, "dumping state for LCtrl + RAlt down:\n");
 113     print_state(state);
 114     assert(xkb_state_mod_name_is_active(state, XKB_MOD_NAME_CTRL,
 115                                         XKB_STATE_DEPRESSED) > 0);
 116     assert(xkb_state_mod_name_is_active(state, XKB_MOD_NAME_ALT,
 117                                         XKB_STATE_DEPRESSED) > 0);
 118     assert(xkb_state_mod_names_are_active(state, XKB_STATE_DEPRESSED,
 119                                           XKB_STATE_MATCH_ALL,
 120                                           XKB_MOD_NAME_CTRL,
 121                                           XKB_MOD_NAME_ALT,
 122                                           NULL) > 0);
 123     assert(xkb_state_mod_indices_are_active(state, XKB_STATE_DEPRESSED,
 124                                           XKB_STATE_MATCH_ALL,
 125                                           xkb_keymap_mod_get_index(keymap, XKB_MOD_NAME_CTRL),
 126                                           xkb_keymap_mod_get_index(keymap, XKB_MOD_NAME_ALT),
 127                                           XKB_MOD_INVALID) > 0);
 128     assert(!xkb_state_mod_names_are_active(state, XKB_STATE_DEPRESSED,
 129                                            XKB_STATE_MATCH_ALL,
 130                                            XKB_MOD_NAME_ALT,
 131                                            NULL) > 0);
 132     assert(xkb_state_mod_names_are_active(state, XKB_STATE_DEPRESSED,
 133                                           (XKB_STATE_MATCH_ANY |
 134                                            XKB_STATE_MATCH_NON_EXCLUSIVE),
 135                                           XKB_MOD_NAME_ALT,
 136                                           NULL));
 137
 138     /* RAlt down */
 139     xkb_state_update_key(state, KEY_LEFTCTRL + EVDEV_OFFSET, XKB_KEY_UP);
 140     fprintf(stderr, "dumping state for RAlt down:\n");
 141     print_state(state);
 142     assert(!xkb_state_mod_name_is_active(state, XKB_MOD_NAME_CTRL,
 143                                          XKB_STATE_EFFECTIVE) > 0);
 144     assert(xkb_state_mod_name_is_active(state, XKB_MOD_NAME_ALT,
 145                                         XKB_STATE_DEPRESSED) > 0);
 146     assert(xkb_state_mod_names_are_active(state, XKB_STATE_DEPRESSED,
 147                                           XKB_STATE_MATCH_ANY,
 148                                           XKB_MOD_NAME_CTRL,
 149                                           XKB_MOD_NAME_ALT,
 150                                           NULL) > 0);
 151
 152     /* none down */
 153     xkb_state_update_key(state, KEY_RIGHTALT + EVDEV_OFFSET, XKB_KEY_UP);
 154     assert(!xkb_state_mod_name_is_active(state, XKB_MOD_NAME_ALT,
 155                                          XKB_STATE_EFFECTIVE));
 156
 157     /* Caps locked */
 158     xkb_state_update_key(state, KEY_CAPSLOCK + EVDEV_OFFSET, XKB_KEY_DOWN);
 159     xkb_state_update_key(state, KEY_CAPSLOCK + EVDEV_OFFSET, XKB_KEY_UP);
 160     fprintf(stderr, "dumping state for Caps Lock:\n");
 161     print_state(state);
 162     assert(xkb_state_mod_name_is_active(state, XKB_MOD_NAME_CAPS,
 163                                         XKB_STATE_LOCKED) > 0);
 164     assert(xkb_state_led_name_is_active(state, XKB_LED_NAME_CAPS) > 0);
 165     num_syms = xkb_state_key_get_syms(state, KEY_Q + EVDEV_OFFSET, &syms);
 166     assert(num_syms == 1 && syms[0] == XKB_KEY_Q);
 167
 168     /* Caps unlocked */
 169     xkb_state_update_key(state, KEY_CAPSLOCK + EVDEV_OFFSET, XKB_KEY_DOWN);
 170     xkb_state_update_key(state, KEY_CAPSLOCK + EVDEV_OFFSET, XKB_KEY_UP);
 171     assert(!xkb_state_mod_name_is_active(state, XKB_MOD_NAME_CAPS,
 172                                          XKB_STATE_EFFECTIVE) > 0);
 173     assert(!xkb_state_led_name_is_active(state, XKB_LED_NAME_CAPS) > 0);
 174     num_syms = xkb_state_key_get_syms(state, KEY_Q + EVDEV_OFFSET, &syms);
 175     assert(num_syms == 1 && syms[0] == XKB_KEY_q);
 176
 177     xkb_state_unref(state);
 178 }
 179
 180 static void
 181 test_serialisation(struct xkb_keymap *keymap)
 182 {
 183     struct xkb_state *state = xkb_state_new(keymap);
 184     xkb_mod_mask_t base_mods;
 185     xkb_mod_mask_t latched_mods;
 186     xkb_mod_mask_t locked_mods;
 187     xkb_mod_mask_t effective_mods;
 188     xkb_mod_index_t caps, shift, ctrl;
 189     xkb_layout_index_t base_group = 0;
 190     xkb_layout_index_t latched_group = 0;
 191     xkb_layout_index_t locked_group = 0;
 192
 193     assert(state);
 194
 195     caps = xkb_keymap_mod_get_index(keymap, XKB_MOD_NAME_CAPS);
 196     assert(caps != XKB_MOD_INVALID);
 197     shift = xkb_keymap_mod_get_index(keymap, XKB_MOD_NAME_SHIFT);
 198     assert(shift != XKB_MOD_INVALID);
 199     ctrl = xkb_keymap_mod_get_index(keymap, XKB_MOD_NAME_CTRL);
 200     assert(ctrl != XKB_MOD_INVALID);
 201
 202     xkb_state_update_key(state, KEY_CAPSLOCK + EVDEV_OFFSET, XKB_KEY_DOWN);
 203     xkb_state_update_key(state, KEY_CAPSLOCK + EVDEV_OFFSET, XKB_KEY_UP);
 204     base_mods = xkb_state_serialize_mods(state, XKB_STATE_DEPRESSED);
 205     assert(base_mods == 0);
 206     latched_mods = xkb_state_serialize_mods(state, XKB_STATE_LATCHED);
 207     assert(latched_mods == 0);
 208     locked_mods = xkb_state_serialize_mods(state, XKB_STATE_LOCKED);
 209     assert(locked_mods == (1 << caps));
 210     effective_mods = xkb_state_serialize_mods(state, XKB_STATE_EFFECTIVE);
 211     assert(effective_mods == locked_mods);
 212
 213     xkb_state_update_key(state, KEY_LEFTSHIFT + EVDEV_OFFSET, XKB_KEY_DOWN);
 214     base_mods = xkb_state_serialize_mods(state, XKB_STATE_DEPRESSED);
 215     assert(base_mods == (1 << shift));
 216     latched_mods = xkb_state_serialize_mods(state, XKB_STATE_LATCHED);
 217     assert(latched_mods == 0);
 218     locked_mods = xkb_state_serialize_mods(state, XKB_STATE_LOCKED);
 219     assert(locked_mods == (1 << caps));
 220     effective_mods = xkb_state_serialize_mods(state, XKB_STATE_EFFECTIVE);
 221     assert(effective_mods == (base_mods | locked_mods));
 222
 223     base_mods |= (1 << ctrl);
 224     xkb_state_update_mask(state, base_mods, latched_mods, locked_mods,
 225                           base_group, latched_group, locked_group);
 226
 227     assert(xkb_state_mod_index_is_active(state, ctrl, XKB_STATE_DEPRESSED));
 228     assert(xkb_state_mod_index_is_active(state, ctrl, XKB_STATE_EFFECTIVE));
 229
 230     xkb_state_unref(state);
 231 }
 232
 233 static void
 234 test_repeat(struct xkb_keymap *keymap)
 235 {
 236     assert(!xkb_keymap_key_repeats(keymap, KEY_LEFTSHIFT + 8));
 237     assert(xkb_keymap_key_repeats(keymap, KEY_A + 8));
 238     assert(xkb_keymap_key_repeats(keymap, KEY_8 + 8));
 239     assert(xkb_keymap_key_repeats(keymap, KEY_DOWN + 8));
 240     assert(xkb_keymap_key_repeats(keymap, KEY_KBDILLUMDOWN + 8));
 241 }
 242
 243 static void
 244 test_consume(struct xkb_keymap *keymap)
 245 {
 246     struct xkb_state *state = xkb_state_new(keymap);
 247     xkb_mod_index_t alt, shift;
 248     xkb_mod_mask_t mask;
 249
 250     assert(state);
 251
 252     alt = xkb_keymap_mod_get_index(keymap, XKB_MOD_NAME_ALT);
 253     assert(alt != XKB_MOD_INVALID);
 254     shift = xkb_keymap_mod_get_index(keymap, XKB_MOD_NAME_SHIFT);
 255     assert(shift != XKB_MOD_INVALID);
 256
 257     xkb_state_update_key(state, KEY_LEFTALT + EVDEV_OFFSET, XKB_KEY_DOWN);
 258     xkb_state_update_key(state, KEY_LEFTSHIFT + EVDEV_OFFSET, XKB_KEY_DOWN);
 259     xkb_state_update_key(state, KEY_EQUAL + EVDEV_OFFSET, XKB_KEY_DOWN);
 260
 261     fprintf(stderr, "dumping state for Alt-Shift-+\n");
 262     print_state(state);
 263
 264     mask = xkb_state_serialize_mods(state, XKB_STATE_EFFECTIVE);
 265     assert(mask == ((1 << alt) | (1 << shift)));
 266     mask = xkb_state_mod_mask_remove_consumed(state, KEY_EQUAL + EVDEV_OFFSET,
 267                                               mask);
 268     assert(mask == (1 << alt));
 269
 270     xkb_state_unref(state);
 271 }
 272
 273 int
 274 main(void)
 275 {
 276     struct xkb_context *context = test_get_context();
 277     struct xkb_keymap *keymap;
 278
 279     assert(context);
 280
 281     keymap = test_compile_rules(context, "evdev", "pc104", "us", NULL, NULL);
 282     assert(keymap);
 283
 284     test_update_key(keymap);
 285     test_serialisation(keymap);
 286     test_repeat(keymap);
 287     test_consume(keymap);
 288
 289     xkb_keymap_unref(keymap);
 290     xkb_context_unref(context);
 291 }