kc3-lang/libxkbcommon/test/rulescomp.c

• Show log

  Commit

• Hash : 23598fa1
  Author :
  Date : 2025-03-25T22:52:06
  

  Enable merge mode “replace” in include statements
  
  Previously only the merge modes “override” and “augment” were available
  in include statements, using the prefix ‘+’ and ‘|’ respectively. While
  on one hand `replace` include statement can be used in keymap files, on
  the other hand *rules* files have no way to express the *replace* mode.
  
  This commit enables the merge mode “replace” using the prefix `^`. This
  prefix was chosen due to its similarity with the `XOR` bit operator,
  which convey *mutual exclusion*.
  
  Other candidates:
  - `!` conveys some kind of higher precedence, akin to CSS `!important`.
    But it conflicts with the section header `!`, which is a token in the
    current parser. It would require special handling, not worth it. It
    also convey the meaning of negation, which is confusing.
  - `&` has the advantage of not corresponding to a token in the rules
    parser. `^` seems however to stand out more and it is less likely to
    trigger erroneous comparison with `|` and `&` bit operators.
  

Download

• test/rulescomp.c

• /*
   * Copyright © 2009 Dan Nicholson
   * SPDX-License-Identifier: MIT
   */
  
  #include "config.h"
  
  #include "evdev-scancodes.h"
  #include "test.h"
  #include "utils.h"
  
  static int
  test_rmlvo_va(struct xkb_context *context, const char *rules,
                const char *model, const char *layout,
                const char *variant, const char *options, va_list ap)
  {
      struct xkb_keymap *keymap;
      int ret;
  
      keymap = test_compile_rules(context, rules, model, layout, variant,
                                  options);
      if (!keymap)
          return 0;
  
      fprintf(stderr, "Compiled '%s' '%s' '%s' '%s' '%s'\n",
              strnull(rules), strnull(model), strnull(layout),
              strnull(variant), strnull(options));
  
      ret = test_key_seq_va(keymap, ap);
  
      xkb_keymap_unref(keymap);
  
      return ret;
  }
  
  static int
  test_rmlvo(struct xkb_context *context, const char *rules,
             const char *model, const char *layout, const char *variant,
             const char *options, ...)
  {
      va_list ap;
      int ret;
  
      va_start(ap, options);
      ret = test_rmlvo_va(context, rules, model, layout, variant, options, ap);
      va_end(ap);
  
      return ret;
  }
  
  static int
  test_rmlvo_env(struct xkb_context *ctx, const char *rules, const char *model,
                 const char *layout, const char *variant, const char *options,
                 ...)
  {
      va_list ap;
      int ret;
  
      va_start (ap, options);
  
      if (!isempty(rules))
          setenv("XKB_DEFAULT_RULES", rules, 1);
      else
          unsetenv("XKB_DEFAULT_RULES");
  
      if (!isempty(model))
          setenv("XKB_DEFAULT_MODEL", model, 1);
      else
          unsetenv("XKB_DEFAULT_MODEL");
  
      if (!isempty(layout))
          setenv("XKB_DEFAULT_LAYOUT", layout, 1);
      else
          unsetenv("XKB_DEFAULT_LAYOUT");
  
      if (!isempty(variant))
          setenv("XKB_DEFAULT_VARIANT", variant, 1);
      else
          unsetenv("XKB_DEFAULT_VARIANT");
  
      if (!isempty(options))
          setenv("XKB_DEFAULT_OPTIONS", options, 1);
      else
          unsetenv("XKB_DEFAULT_OPTIONS");
  
      ret = test_rmlvo_va(ctx, NULL, NULL, NULL, NULL, NULL, ap);
  
      va_end(ap);
  
      return ret;
  }
  
  int
  main(int argc, char *argv[])
  {
      test_init();
  
      struct xkb_context *ctx = test_get_context(CONTEXT_ALLOW_ENVIRONMENT_NAMES);
  
      assert(ctx);
  
  #define KS(name) xkb_keysym_from_name(name, 0)
  
      assert(test_rmlvo(ctx, "evdev", "pc105", "us,il,ru,ca", ",,,multix", "grp:alts_toggle,ctrl:nocaps,compose:rwin",
                        KEY_Q,          BOTH, XKB_KEY_q,                    NEXT,
                        KEY_LEFTALT,    DOWN, XKB_KEY_Alt_L,                NEXT,
                        KEY_RIGHTALT,   DOWN, XKB_KEY_ISO_Next_Group,       NEXT,
                        KEY_RIGHTALT,   UP,   XKB_KEY_ISO_Level3_Shift,     NEXT,
                        KEY_LEFTALT,    UP,   XKB_KEY_Alt_L,                NEXT,
                        KEY_Q,          BOTH, XKB_KEY_slash,                NEXT,
                        KEY_LEFTSHIFT,  DOWN, XKB_KEY_Shift_L,              NEXT,
                        KEY_Q,          BOTH, XKB_KEY_Q,                    NEXT,
                        KEY_RIGHTMETA,  BOTH, XKB_KEY_Multi_key,            FINISH));
      assert(test_rmlvo(ctx, "evdev",  "pc105", "us,in", "", "grp:alts_toggle",
                        KEY_A,          BOTH, XKB_KEY_a,                    NEXT,
                        KEY_LEFTALT,    DOWN, XKB_KEY_Alt_L,                NEXT,
                        KEY_RIGHTALT,   DOWN, XKB_KEY_ISO_Next_Group,       NEXT,
                        KEY_RIGHTALT,   UP,   XKB_KEY_ISO_Level3_Shift,     NEXT,
                        KEY_LEFTALT,    UP,   XKB_KEY_Alt_L,                NEXT,
                        KEY_A,          BOTH, KS("U094b"),                  FINISH));
      assert(test_rmlvo(ctx, "evdev", "pc105", "us", "intl", "",
                        KEY_GRAVE,      BOTH,  XKB_KEY_dead_grave,          FINISH));
      assert(test_rmlvo(ctx, "evdev", "evdev", "us", "intl", "grp:alts_toggle",
                        KEY_GRAVE,      BOTH,  XKB_KEY_dead_grave,          FINISH));
  
      /* 20 is not a legal group; make sure this is handled gracefully. */
      assert(test_rmlvo(ctx, "evdev", "", "us:20", "", "",
                        KEY_A,          BOTH, XKB_KEY_a,                    FINISH));
  
      /* Don't choke on missing values in RMLVO. Should just skip them.
         Currently generates us,us,ca. */
      assert(test_rmlvo(ctx, "evdev", "", "us,,ca", "", "grp:alts_toggle",
                        KEY_A,          BOTH, XKB_KEY_a,                    NEXT,
                        KEY_LEFTALT,    DOWN, XKB_KEY_Alt_L,                NEXT,
                        KEY_RIGHTALT,   DOWN, XKB_KEY_ISO_Next_Group,       NEXT,
                        KEY_RIGHTALT,   UP,   XKB_KEY_ISO_Next_Group,       NEXT,
                        KEY_LEFTALT,    UP,   XKB_KEY_Alt_L,                NEXT,
                        KEY_LEFTALT,    DOWN, XKB_KEY_Alt_L,                NEXT,
                        KEY_RIGHTALT,   DOWN, XKB_KEY_ISO_Next_Group,       NEXT,
                        KEY_RIGHTALT,   UP,   XKB_KEY_ISO_Level3_Shift,     NEXT,
                        KEY_LEFTALT,    UP,   XKB_KEY_Alt_L,                NEXT,
                        KEY_APOSTROPHE, BOTH, XKB_KEY_dead_grave,           FINISH));
  
      assert(test_rmlvo(ctx, "", "", "", "", "",
                        KEY_A,          BOTH, XKB_KEY_a,                    FINISH));
  
      assert(!test_rmlvo(ctx, "does-not-exist", "", "", "", "",
                         KEY_A,          BOTH, XKB_KEY_a,                   FINISH));
  
      assert(test_rmlvo_env(ctx, "evdev", "", "us", "", "",
                            KEY_A,          BOTH, XKB_KEY_a,                FINISH));
      assert(test_rmlvo_env(ctx, "evdev", "", "us", "", "ctrl:nocaps",
                            KEY_CAPSLOCK,   BOTH, XKB_KEY_Control_L,        FINISH));
  
      /* Ignores multix and generates us,ca. */
      assert(test_rmlvo_env(ctx, "evdev", "", "us,ca", ",,,multix", "grp:alts_toggle",
                            KEY_A,          BOTH, XKB_KEY_a,                NEXT,
                            KEY_LEFTALT,    DOWN, XKB_KEY_Alt_L,            NEXT,
                            KEY_RIGHTALT,   DOWN, XKB_KEY_ISO_Next_Group,   NEXT,
                            KEY_RIGHTALT,   UP,   XKB_KEY_ISO_Level3_Shift, NEXT,
                            KEY_LEFTALT,    UP,   XKB_KEY_Alt_L,            NEXT,
                            KEY_GRAVE,      UP,   XKB_KEY_numbersign,       FINISH));
  
      assert(!test_rmlvo_env(ctx, "broken", "what-on-earth", "invalid", "", "",
                             KEY_A,          BOTH, XKB_KEY_a,               FINISH));
  
      /* Ensure a keymap with an empty xkb_keycodes compiles fine. */
      assert(test_rmlvo_env(ctx, "base", "empty", "empty", "", "",
                            KEY_A,          BOTH, XKB_KEY_NoSymbol,         FINISH));
  
      /* Check replace merge mode: it should replace the whole <RALT> key */
      const char* replace_options[] = {
          "replace:single,grp:menu_toggle",
          "replace:first,grp:menu_toggle",
          "replace:later,grp:menu_toggle",
      };
      for (unsigned int k = 0; k < ARRAY_SIZE(replace_options); k++) {
          const char* const options = replace_options[k];
          assert(test_rmlvo(ctx, "merge-mode-replace", "", "us,de", "", options,
                            KEY_RIGHTALT,        BOTH, XKB_KEY_Alt_R,           NEXT,
                            KEY_COMPOSE,         BOTH, XKB_KEY_ISO_Next_Group,  NEXT,
                            KEY_RIGHTALT,        BOTH, XKB_KEY_Alt_R,           FINISH));
      }
  
      /* Has an illegal escape sequence, but shouldn't fail. */
      assert(test_rmlvo_env(ctx, "evdev", "", "cz", "bksl", "",
                            KEY_A,          BOTH, XKB_KEY_a,                FINISH));
  
      xkb_context_unref(ctx);
  
      ctx = test_get_context(0);
      assert(test_rmlvo_env(ctx, "broken", "but", "ignored", "per", "ctx flags",
                            KEY_A,          BOTH, XKB_KEY_a,                FINISH));
  
      /* Test response to invalid flags. */
      {
          struct xkb_rule_names rmlvo = { NULL };
          assert(!xkb_keymap_new_from_names(ctx, &rmlvo, -1));
          assert(!xkb_keymap_new_from_names(ctx, &rmlvo, 5453));
      }
  
      xkb_context_unref(ctx);
      return 0;
  }
  

Download