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