kc3-lang/libxkbcommon/test/test.h

Branch : - branch - android master - tag -

• Show log

  Commit

• Author : Pierre Le Marre
  Date : 2025-01-13 15:20:47
  Hash : 7036e46c
  Message : symbols: Add tests for key merge modes (keysyms/actions) This commit adds tests for merging various key configurations: - With/without keysyms/actions - Single/multiple keysyms/actions per level We test all the merge modes for including a map (global) as well as directly on the keys (local): - default (global: include, local: implicit) - augment - override - replace The tests data are generated with: - A Python script `scripts/update-merge-modes-tests.py` for keycodes and symbols data. Use `--debug` for extra comments to help debugging. The script can optionally generate C headers for alternative key sequence tests, that were used before implementing golden tests. The latter tests are not used anymore (duplicate with golden tests) but their generator is kept for now, as they can still be useful for debugging or writing similar tests. - The `merge-modes` test generates its own keymap files for golden tests, using: `build/test-merge-modes update`. It can also replace them with the obtained output rather than the expected one using `build/test-merge-modes update-obtained`, which is very useful for debugging.

• test/test.h

• /*
   * 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>
   */
  
  #ifndef TEST_H
  #define TEST_H
  
  #include <assert.h>
  
  /* Don't use compat names in internal code. */
  #define _XKBCOMMON_COMPAT_H
  #include "xkbcommon/xkbcommon.h"
  #include "xkbcommon/xkbcommon-compose.h"
  #include "utils.h"
  
  /* Automake test exit code to signify SKIP (à la PASS, FAIL, etc).
   * See: https://www.gnu.org/software/automake/manual/html_node/Scripts_002dbased-Testsuites.html */
  #define SKIP_TEST 77
  #define TEST_SETUP_FAILURE 99
  
  #define assert_printf(cond, ...) do {                      \
      const bool __cond = (cond);                            \
      if (!__cond) {                                         \
         fprintf(stderr, "Assertion failure: " __VA_ARGS__); \
         assert(__cond);                                     \
      }} while (0)
  
  #define assert_streq_not_null(test_name, expected, got) \
      assert_printf(streq_not_null(expected, got), \
                    test_name ". Expected \"%s\", got: \"%s\"\n", expected, got)
  
  void
  test_init(void);
  
  void
  print_detailed_state(struct xkb_state *state);
  
  /* The offset between KEY_* numbering, and keycodes in the XKB evdev
   * dataset. */
  #define EVDEV_OFFSET 8
  
  enum key_seq_state {
      DOWN,
      REPEAT,
      UP,
      BOTH,
      NEXT,
      FINISH,
  };
  
  int
  test_key_seq(struct xkb_keymap *keymap, ...);
  
  int
  test_key_seq_va(struct xkb_keymap *keymap, va_list args);
  
  char *
  test_makedir(const char *parent, const char *path);
  
  char *
  test_maketempdir(const char *template);
  
  char *
  test_get_path(const char *path_rel);
  
  char *
  test_read_file(const char *path_rel);
  
  enum test_context_flags {
      CONTEXT_NO_FLAG = 0,
      CONTEXT_ALLOW_ENVIRONMENT_NAMES = (1 << 0),
  };
  
  struct xkb_context *
  test_get_context(enum test_context_flags flags);
  
  struct xkb_keymap *
  test_compile_file(struct xkb_context *context, const char *path_rel);
  
  struct xkb_keymap *
  test_compile_string(struct xkb_context *context, const char *string);
  
  struct xkb_keymap *
  test_compile_buffer(struct xkb_context *context, const char *buf, size_t len);
  
  typedef struct xkb_keymap * (*test_compile_buffer_t)(struct xkb_context *context,
                                                       const char *buf, size_t len,
                                                       void *private);
  
  bool
  test_compile_output(struct xkb_context *ctx,
                      test_compile_buffer_t compile_buffer,
                      void *compile_buffer_private, const char *test_title,
                      const char *keymap_str, size_t keymap_len,
                      const char *rel_path, bool update_output_files);
  
  struct xkb_keymap *
  test_compile_rules(struct xkb_context *context, const char *rules,
                     const char *model, const char *layout, const char *variant,
                     const char *options);
  
  
  #ifdef _WIN32
  #define setenv(varname, value, overwrite) _putenv_s((varname), (value))
  #define unsetenv(varname) _putenv_s(varname, "")
  #endif
  
  #endif