kc3-lang/libxkbcommon/test/state.c

Branch : - branch - android master - tag -

• Show log

  Commit

• Author : Ran Benita
  Date : 2012-08-30 12:13:37
  Hash : 06d7803a
  Message : state: fix mod_names_are_active This function was always returning -1. Adding a test, we see that test/state.c treat the is_active functions as returning booleans, which would treat -1 as success, so we test for > 0 instead (most users would probably get this wrong as well...). Also update the documentation for the are_active functions, and add a ATTR_NULL_SENTINEL for gcc __attribute__((sentinel)). Signed-off-by: Ran Benita <ran234@gmail.com>

• 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 "xkbcommon/xkbcommon.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_group_index_t group;
      xkb_mod_index_t mod;
      xkb_led_index_t led;
  
      group = xkb_state_serialize_group(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_map(state);
  
      for (group = 0; group < xkb_map_num_groups(keymap); group++) {
          if (xkb_state_group_index_is_active(state, group, XKB_STATE_EFFECTIVE) != 1)
              continue;
          fprintf(stderr, "\tgroup %s (%d): %s%s%s%s\n",
                  xkb_map_group_get_name(keymap, group),
                  group,
                  xkb_state_group_index_is_active(state, group, XKB_STATE_EFFECTIVE) > 0 ?
                      "effective " : "",
                  xkb_state_group_index_is_active(state, group, XKB_STATE_DEPRESSED) > 0 ?
                      "depressed " : "",
                  xkb_state_group_index_is_active(state, group, XKB_STATE_LATCHED) > 0 ?
                      "latched " : "",
                  xkb_state_group_index_is_active(state, group, XKB_STATE_LOCKED) > 0 ?
                      "locked " : "");
      }
  
      for (mod = 0; mod < xkb_map_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_map_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 < xkb_map_num_leds(keymap); led++) {
          if (!xkb_state_led_index_is_active(state, led))
              continue;
          fprintf(stderr, "\tled %s (%d): active\n",
                  xkb_map_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;
      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_map_mod_get_index(keymap, XKB_MOD_NAME_CTRL),
                                            xkb_map_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);
  
      /* 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);
      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_LOCKED) > 0);
      assert(xkb_state_led_name_is_active(state, XKB_LED_NAME_CAPS) > 0);
      num_syms = xkb_key_get_syms(state, KEY_Q + EVDEV_OFFSET, &syms);
      assert(num_syms == 1 && syms[0] == XKB_KEY_Q);
  
      /* 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_key_get_syms(state, KEY_Q + EVDEV_OFFSET, &syms);
      assert(num_syms == 1 && syms[0] == XKB_KEY_q);
  
      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_group_index_t base_group = 0;
      xkb_group_index_t latched_group = 0;
      xkb_group_index_t locked_group = 0;
  
      assert(state);
  
      caps = xkb_map_mod_get_index(keymap, XKB_MOD_NAME_CAPS);
      assert(caps != XKB_MOD_INVALID);
      shift = xkb_map_mod_get_index(keymap, XKB_MOD_NAME_SHIFT);
      assert(shift != XKB_MOD_INVALID);
      ctrl = xkb_map_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_key_repeats(keymap, KEY_LEFTSHIFT + 8));
      assert(xkb_key_repeats(keymap, KEY_A + 8));
      assert(xkb_key_repeats(keymap, KEY_8 + 8));
      assert(xkb_key_repeats(keymap, KEY_DOWN + 8));
      assert(xkb_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_map_mod_get_index(keymap, XKB_MOD_NAME_ALT);
      assert(alt != XKB_MOD_INVALID);
      shift = xkb_map_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_key_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", NULL, NULL);
      assert(keymap);
  
      test_update_key(keymap);
      test_serialisation(keymap);
      test_repeat(keymap);
      test_consume(keymap);
  
      xkb_map_unref(keymap);
      xkb_context_unref(context);
  }