kc3-lang/libxkbcommon

Diff

  • Show log

    Commit

  • Hash : 7036e46c
    Author : Pierre Le Marre
    Date : 2025-01-13T15:20:47 

    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.

  • Properties

  • Git HTTP https://git.kmx.io/kc3-lang/libxkbcommon.git
    Git SSH git@git.kmx.io:kc3-lang/libxkbcommon.git
    Public access ? public
    Description

    keymap handling library for toolkits and window systems
    Users
    		 thodg_m kc3_lang_org thodg_w www_kmx_io thodg thodg_l
    Tags

  • README.md

  • libxkbcommon

    libxkbcommon is a keyboard keymap compiler and support library which processes a reduced subset of keymaps as defined by the XKB (X Keyboard Extension) specification. It also contains a module for handling Compose and dead keys and a separate library for listing available keyboard layouts.

    Quick Guide

    Building

    libxkbcommon is built with Meson:

    meson setup build
meson compile -C build
meson test -C build # Run the tests.

    To build for use with Wayland, you can disable X11 support while still using the X11 keyboard configuration resource files thusly:

    meson setup build \
    -Denable-x11=false \
    -Dxkb-config-root=/usr/share/X11/xkb \
    -Dx-locale-root=/usr/share/X11/locale
meson compile -C build

    API

    While libxkbcommon’s API is somewhat derived from the classic XKB API as found in X11/extensions/XKB.h and friends, it has been substantially reworked to expose fewer internal details to clients.

    See the API Documentation.

    Dataset

    libxkbcommon does not distribute a keymap dataset itself, other than for testing purposes. The most common dataset is xkeyboard-config, which is used by all current distributions for their X11 XKB data. More information on xkeyboard-config is available here:

    https://www.freedesktop.org/wiki/Software/XKeyboardConfig

    The dataset for Compose is distributed in libX11, as part of the X locale data.

    Relation to X11

    See Compatibility notes.

    Development

    An extremely rudimentary homepage can be found at

    https://xkbcommon.org

    xkbcommon is maintained in git at

    https://github.com/xkbcommon/libxkbcommon

    Patches are always welcome, and may be sent to either

    <xorg-devel@lists.x.org> or <wayland-devel@lists.freedesktop.org>

    or in a GitHub pull request.

    Bug reports (and usage questions) are also welcome, and may be filed at GitHub.

    The maintainers are

    Credits

    Many thanks are due to Dan Nicholson for his heroic work in getting xkbcommon off the ground initially.

kmx.io     mail     discord kmxgit v0.4.0