kc3-lang/libxkbcommon/test/state.c

• Show log

  Commit

• Hash : 2f4db8a9
  Author :
  Date : 2012-10-10T09:47:31
  

  keymap, state: don't assume led index < xkb_keymap_num_leds xkb_keymap_num_leds() returns the number of leds that have any possibility of being set. Even if a led is defined but can not be set in any way, it is not counted. In a few places currently we assume that led indexes are smaller than this number, which is wrong both for the above reason and for the fact that the xkb format actually allows explicitly setting the indicator index, which means that the indexes might be non-consecutive. We don't really have good API to iterate on leds, now, because xkb_keymap_num_leds is pretty useless. To work around that we use sizeof(xkb_led_mask_t) * 8. This makes the "Group 2" led work (try switching to a layout other than the first in test/interactive). Signed-off-by: Ran Benita <ran234@gmail.com>

Download

• test/state.c

• /*
   * Copyright © 2012 Intel Corporation
   *
   * Permission is hereby granted, free of charge, to any person obtaining a
   * copy of this software and associated documentation files (the "Software"),
   * to deal in the Software without restriction, including without limitation
   * the rights to use, copy, modify, merge, publish, distribute, sublicense,
   * and/or sell copies of the Software, and to permit persons to whom the
   * Software is furnished to do so, subject to the following conditions:
   *
   * The above copyright notice and this permission notice (including the next
   * paragraph) shall be included in all copies or substantial portions of the
   * Software.
   *
   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
   * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
   * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
   * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
   * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
   * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
   * DEALINGS IN THE SOFTWARE.
   *
   * Author: Daniel Stone <daniel@fooishbar.org>
   */
  
  #include <assert.h>
  #include <stdio.h>
  #include <stdlib.h>
  #include <linux/input.h>
  
  #include "test.h"
  
  /* Offset between evdev keycodes (where KEY_ESCAPE is 1), and the evdev XKB
   * keycode set (where ESC is 9). */
  #define EVDEV_OFFSET 8
  
  static void
  print_state(struct xkb_state *state)
  {
      struct xkb_keymap *keymap;
      xkb_layout_index_t group;
      xkb_mod_index_t mod;
      xkb_led_index_t led;
  
      group = xkb_state_serialize_layout(state, XKB_STATE_EFFECTIVE);
      mod = xkb_state_serialize_mods(state, XKB_STATE_EFFECTIVE);
      /* led = xkb_state_serialize_leds(state, XKB_STATE_EFFECTIVE); */
      if (!group && !mod /* && !led */) {
          fprintf(stderr, "\tno state\n");
          return;
      }
  
      keymap = xkb_state_get_keymap(state);
  
      for (group = 0; group < xkb_keymap_num_layouts(keymap); group++) {
          if (xkb_state_layout_index_is_active(state, group, XKB_STATE_EFFECTIVE) != 1)
              continue;
          fprintf(stderr, "\tgroup %s (%d): %s%s%s%s\n",
                  xkb_keymap_layout_get_name(keymap, group),
                  group,
                  xkb_state_layout_index_is_active(state, group, XKB_STATE_EFFECTIVE) > 0 ?
                      "effective " : "",
                  xkb_state_layout_index_is_active(state, group, XKB_STATE_DEPRESSED) > 0 ?
                      "depressed " : "",
                  xkb_state_layout_index_is_active(state, group, XKB_STATE_LATCHED) > 0 ?
                      "latched " : "",
                  xkb_state_layout_index_is_active(state, group, XKB_STATE_LOCKED) > 0 ?
                      "locked " : "");
      }
  
      for (mod = 0; mod < xkb_keymap_num_mods(keymap); mod++) {
          if (!xkb_state_mod_index_is_active(state, mod, XKB_STATE_EFFECTIVE))
              continue;
          fprintf(stderr, "\tmod %s (%d): %s%s%s\n",
                  xkb_keymap_mod_get_name(keymap, mod),
                  mod,
                  xkb_state_mod_index_is_active(state, mod, XKB_STATE_DEPRESSED) > 0 ?
                      "depressed " : "",
                  xkb_state_mod_index_is_active(state, mod, XKB_STATE_LATCHED) > 0 ?
                      "latched " : "",
                  xkb_state_mod_index_is_active(state, mod, XKB_STATE_LOCKED) > 0 ?
                      "locked " : "");
      }
  
      for (led = 0; led < sizeof(xkb_led_mask_t) * 8; led++) {
          if (xkb_state_led_index_is_active(state, led) <= 0)
              continue;
          fprintf(stderr, "\tled %s (%d): active\n",
                  xkb_keymap_led_get_name(keymap, led),
                  led);
      }
  }
  
  static void
  test_update_key(struct xkb_keymap *keymap)
  {
      struct xkb_state *state = xkb_state_new(keymap);
      const xkb_keysym_t *syms;
      xkb_keysym_t one_sym;
      int num_syms;
  
      assert(state);
  
      /* LCtrl down */
      xkb_state_update_key(state, KEY_LEFTCTRL + EVDEV_OFFSET, XKB_KEY_DOWN);
      fprintf(stderr, "dumping state for LCtrl down:\n");
      print_state(state);
      assert(xkb_state_mod_name_is_active(state, XKB_MOD_NAME_CTRL,
                                          XKB_STATE_DEPRESSED) > 0);
  
      /* LCtrl + RAlt down */
      xkb_state_update_key(state, KEY_RIGHTALT + EVDEV_OFFSET, XKB_KEY_DOWN);
      fprintf(stderr, "dumping state for LCtrl + RAlt down:\n");
      print_state(state);
      assert(xkb_state_mod_name_is_active(state, XKB_MOD_NAME_CTRL,
                                          XKB_STATE_DEPRESSED) > 0);
      assert(xkb_state_mod_name_is_active(state, XKB_MOD_NAME_ALT,
                                          XKB_STATE_DEPRESSED) > 0);
      assert(xkb_state_mod_names_are_active(state, XKB_STATE_DEPRESSED,
                                            XKB_STATE_MATCH_ALL,
                                            XKB_MOD_NAME_CTRL,
                                            XKB_MOD_NAME_ALT,
                                            NULL) > 0);
      assert(xkb_state_mod_indices_are_active(state, XKB_STATE_DEPRESSED,
                                            XKB_STATE_MATCH_ALL,
                                            xkb_keymap_mod_get_index(keymap, XKB_MOD_NAME_CTRL),
                                            xkb_keymap_mod_get_index(keymap, XKB_MOD_NAME_ALT),
                                            XKB_MOD_INVALID) > 0);
      assert(!xkb_state_mod_names_are_active(state, XKB_STATE_DEPRESSED,
                                             XKB_STATE_MATCH_ALL,
                                             XKB_MOD_NAME_ALT,
                                             NULL) > 0);
      assert(xkb_state_mod_names_are_active(state, XKB_STATE_DEPRESSED,
                                            (XKB_STATE_MATCH_ANY |
                                             XKB_STATE_MATCH_NON_EXCLUSIVE),
                                            XKB_MOD_NAME_ALT,
                                            NULL));
  
      /* RAlt down */
      xkb_state_update_key(state, KEY_LEFTCTRL + EVDEV_OFFSET, XKB_KEY_UP);
      fprintf(stderr, "dumping state for RAlt down:\n");
      print_state(state);
      assert(!xkb_state_mod_name_is_active(state, XKB_MOD_NAME_CTRL,
                                           XKB_STATE_EFFECTIVE) > 0);
      assert(xkb_state_mod_name_is_active(state, XKB_MOD_NAME_ALT,
                                          XKB_STATE_DEPRESSED) > 0);
      assert(xkb_state_mod_names_are_active(state, XKB_STATE_DEPRESSED,
                                            XKB_STATE_MATCH_ANY,
                                            XKB_MOD_NAME_CTRL,
                                            XKB_MOD_NAME_ALT,
                                            NULL) > 0);
      assert(xkb_state_mod_names_are_active(state, XKB_STATE_LATCHED,
                                            XKB_STATE_MATCH_ANY,
                                            XKB_MOD_NAME_CTRL,
                                            XKB_MOD_NAME_ALT,
                                            NULL) == 0);
  
      /* none down */
      xkb_state_update_key(state, KEY_RIGHTALT + EVDEV_OFFSET, XKB_KEY_UP);
      assert(!xkb_state_mod_name_is_active(state, XKB_MOD_NAME_ALT,
                                           XKB_STATE_EFFECTIVE));
  
      /* Caps locked */
      xkb_state_update_key(state, KEY_CAPSLOCK + EVDEV_OFFSET, XKB_KEY_DOWN);
      assert(xkb_state_mod_name_is_active(state, XKB_MOD_NAME_CAPS,
                                          XKB_STATE_DEPRESSED) > 0);
      xkb_state_update_key(state, KEY_CAPSLOCK + EVDEV_OFFSET, XKB_KEY_UP);
      fprintf(stderr, "dumping state for Caps Lock:\n");
      print_state(state);
      assert(xkb_state_mod_name_is_active(state, XKB_MOD_NAME_CAPS,
                                          XKB_STATE_DEPRESSED) == 0);
      assert(xkb_state_mod_name_is_active(state, XKB_MOD_NAME_CAPS,
                                          XKB_STATE_LOCKED) > 0);
      assert(xkb_state_led_name_is_active(state, XKB_LED_NAME_CAPS) > 0);
      num_syms = xkb_state_key_get_syms(state, KEY_Q + EVDEV_OFFSET, &syms);
      assert(num_syms == 1 && syms[0] == XKB_KEY_Q);
  
      /* Num Lock locked */
      xkb_state_update_key(state, KEY_NUMLOCK + EVDEV_OFFSET, XKB_KEY_DOWN);
      xkb_state_update_key(state, KEY_NUMLOCK + EVDEV_OFFSET, XKB_KEY_UP);
      fprintf(stderr, "dumping state for Caps Lock + Num Lock:\n");
      print_state(state);
      assert(xkb_state_mod_name_is_active(state, XKB_MOD_NAME_CAPS,
                                          XKB_STATE_LOCKED) > 0);
      assert(xkb_state_mod_name_is_active(state, "Mod2",
                                          XKB_STATE_LOCKED) > 0);
      num_syms = xkb_state_key_get_syms(state, KEY_KP1 + EVDEV_OFFSET, &syms);
      assert(num_syms == 1 && syms[0] == XKB_KEY_KP_1);
      assert(xkb_state_led_name_is_active(state, XKB_LED_NAME_NUM) > 0);
  
      /* Num Lock unlocked */
      xkb_state_update_key(state, KEY_NUMLOCK + EVDEV_OFFSET, XKB_KEY_DOWN);
      xkb_state_update_key(state, KEY_NUMLOCK + EVDEV_OFFSET, XKB_KEY_UP);
  
      /* Switch to group 2 */
      xkb_state_update_key(state, KEY_COMPOSE + EVDEV_OFFSET, XKB_KEY_DOWN);
      xkb_state_update_key(state, KEY_COMPOSE + EVDEV_OFFSET, XKB_KEY_UP);
      assert(xkb_state_led_name_is_active(state, "Group 2") > 0);
      assert(xkb_state_led_name_is_active(state, XKB_LED_NAME_NUM) <= 0);
  
      /* Switch back to group 1. */
      xkb_state_update_key(state, KEY_COMPOSE + EVDEV_OFFSET, XKB_KEY_DOWN);
      xkb_state_update_key(state, KEY_COMPOSE + EVDEV_OFFSET, XKB_KEY_UP);
  
      /* Caps unlocked */
      xkb_state_update_key(state, KEY_CAPSLOCK + EVDEV_OFFSET, XKB_KEY_DOWN);
      xkb_state_update_key(state, KEY_CAPSLOCK + EVDEV_OFFSET, XKB_KEY_UP);
      assert(!xkb_state_mod_name_is_active(state, XKB_MOD_NAME_CAPS,
                                           XKB_STATE_EFFECTIVE) > 0);
      assert(!xkb_state_led_name_is_active(state, XKB_LED_NAME_CAPS) > 0);
      num_syms = xkb_state_key_get_syms(state, KEY_Q + EVDEV_OFFSET, &syms);
      assert(num_syms == 1 && syms[0] == XKB_KEY_q);
  
      /* Multiple symbols */
      num_syms = xkb_state_key_get_syms(state, KEY_6 + EVDEV_OFFSET, &syms);
      assert(num_syms == 5 &&
             syms[0] == XKB_KEY_H && syms[1] == XKB_KEY_E &&
             syms[2] == XKB_KEY_L && syms[3] == XKB_KEY_L &&
             syms[4] == XKB_KEY_O);
      one_sym = xkb_state_key_get_one_sym(state, KEY_6 + EVDEV_OFFSET);
      assert(one_sym == XKB_KEY_NoSymbol);
      xkb_state_update_key(state, KEY_6 + EVDEV_OFFSET, XKB_KEY_DOWN);
      xkb_state_update_key(state, KEY_6 + EVDEV_OFFSET, XKB_KEY_UP);
  
      one_sym = xkb_state_key_get_one_sym(state, KEY_5 + EVDEV_OFFSET);
      assert(one_sym == XKB_KEY_5);
  
      xkb_state_unref(state);
  }
  
  static void
  test_serialisation(struct xkb_keymap *keymap)
  {
      struct xkb_state *state = xkb_state_new(keymap);
      xkb_mod_mask_t base_mods;
      xkb_mod_mask_t latched_mods;
      xkb_mod_mask_t locked_mods;
      xkb_mod_mask_t effective_mods;
      xkb_mod_index_t caps, shift, ctrl;
      xkb_layout_index_t base_group = 0;
      xkb_layout_index_t latched_group = 0;
      xkb_layout_index_t locked_group = 0;
  
      assert(state);
  
      caps = xkb_keymap_mod_get_index(keymap, XKB_MOD_NAME_CAPS);
      assert(caps != XKB_MOD_INVALID);
      shift = xkb_keymap_mod_get_index(keymap, XKB_MOD_NAME_SHIFT);
      assert(shift != XKB_MOD_INVALID);
      ctrl = xkb_keymap_mod_get_index(keymap, XKB_MOD_NAME_CTRL);
      assert(ctrl != XKB_MOD_INVALID);
  
      xkb_state_update_key(state, KEY_CAPSLOCK + EVDEV_OFFSET, XKB_KEY_DOWN);
      xkb_state_update_key(state, KEY_CAPSLOCK + EVDEV_OFFSET, XKB_KEY_UP);
      base_mods = xkb_state_serialize_mods(state, XKB_STATE_DEPRESSED);
      assert(base_mods == 0);
      latched_mods = xkb_state_serialize_mods(state, XKB_STATE_LATCHED);
      assert(latched_mods == 0);
      locked_mods = xkb_state_serialize_mods(state, XKB_STATE_LOCKED);
      assert(locked_mods == (1 << caps));
      effective_mods = xkb_state_serialize_mods(state, XKB_STATE_EFFECTIVE);
      assert(effective_mods == locked_mods);
  
      xkb_state_update_key(state, KEY_LEFTSHIFT + EVDEV_OFFSET, XKB_KEY_DOWN);
      base_mods = xkb_state_serialize_mods(state, XKB_STATE_DEPRESSED);
      assert(base_mods == (1 << shift));
      latched_mods = xkb_state_serialize_mods(state, XKB_STATE_LATCHED);
      assert(latched_mods == 0);
      locked_mods = xkb_state_serialize_mods(state, XKB_STATE_LOCKED);
      assert(locked_mods == (1 << caps));
      effective_mods = xkb_state_serialize_mods(state, XKB_STATE_EFFECTIVE);
      assert(effective_mods == (base_mods | locked_mods));
  
      base_mods |= (1 << ctrl);
      xkb_state_update_mask(state, base_mods, latched_mods, locked_mods,
                            base_group, latched_group, locked_group);
  
      assert(xkb_state_mod_index_is_active(state, ctrl, XKB_STATE_DEPRESSED));
      assert(xkb_state_mod_index_is_active(state, ctrl, XKB_STATE_EFFECTIVE));
  
      xkb_state_unref(state);
  }
  
  static void
  test_repeat(struct xkb_keymap *keymap)
  {
      assert(!xkb_keymap_key_repeats(keymap, KEY_LEFTSHIFT + 8));
      assert(xkb_keymap_key_repeats(keymap, KEY_A + 8));
      assert(xkb_keymap_key_repeats(keymap, KEY_8 + 8));
      assert(xkb_keymap_key_repeats(keymap, KEY_DOWN + 8));
      assert(xkb_keymap_key_repeats(keymap, KEY_KBDILLUMDOWN + 8));
  }
  
  static void
  test_consume(struct xkb_keymap *keymap)
  {
      struct xkb_state *state = xkb_state_new(keymap);
      xkb_mod_index_t alt, shift;
      xkb_mod_mask_t mask;
  
      assert(state);
  
      alt = xkb_keymap_mod_get_index(keymap, XKB_MOD_NAME_ALT);
      assert(alt != XKB_MOD_INVALID);
      shift = xkb_keymap_mod_get_index(keymap, XKB_MOD_NAME_SHIFT);
      assert(shift != XKB_MOD_INVALID);
  
      xkb_state_update_key(state, KEY_LEFTALT + EVDEV_OFFSET, XKB_KEY_DOWN);
      xkb_state_update_key(state, KEY_LEFTSHIFT + EVDEV_OFFSET, XKB_KEY_DOWN);
      xkb_state_update_key(state, KEY_EQUAL + EVDEV_OFFSET, XKB_KEY_DOWN);
  
      fprintf(stderr, "dumping state for Alt-Shift-+\n");
      print_state(state);
  
      mask = xkb_state_serialize_mods(state, XKB_STATE_EFFECTIVE);
      assert(mask == ((1 << alt) | (1 << shift)));
      mask = xkb_state_mod_mask_remove_consumed(state, KEY_EQUAL + EVDEV_OFFSET,
                                                mask);
      assert(mask == (1 << alt));
  
      xkb_state_unref(state);
  }
  
  int
  main(void)
  {
      struct xkb_context *context = test_get_context();
      struct xkb_keymap *keymap;
  
      assert(context);
  
      keymap = test_compile_rules(context, "evdev", "pc104", "us,ru", NULL, "grp:menu_toggle");
      assert(keymap);
  
      test_update_key(keymap);
      test_serialisation(keymap);
      test_repeat(keymap);
      test_consume(keymap);
  
      xkb_keymap_unref(keymap);
      xkb_context_unref(context);
  }
  

Download