Edit

kc3-lang/libxkbcommon

Branch :

  • Show log

    Commit

  • Author : Pierre Le Marre
    Date : 2025-06-12 09:13:27
    Hash : d9d82355
    Message : keymap: Add option `lockOnRelease` for LockGroup() It enables to use e.g. the combination `Control + Shift` *alone* to switch layouts, while keeping the use of `Control + Shift + other key` (typically for keyboard shortcuts). The specification of `LockGroup()` is changed to: - On key *press*: - If `lockOnRelease` is set, then key press has no effect. - Otherwise: - if the `group` is absolute, key press sets the *locked* keyboard group to `group`; - otherwise, key press adds `group` to the *locked* keyboard group. In either case, the resulting *locked* and *effective* group is brought back into range depending on the value of the `GroupsWrap` control for the keyboard. - On key *release*: - If `lockOnRelease` is not set, then key release has no effect. - Otherwise, if any other key was *pressed* after the locking key, then key release has no effect. - Otherwise, it has the same effect than a key press *without* `lockOnRelease` set. This is really useful for people coming from other platforms, such as Windows. It fixes a [20-year old issue] inherited from the X11 ecosystem, by extending the [XKB protocol key actions]. As it is incompatible with X11, this feature is available only using the keymap text format v2. [20-year old issue]: https://gitlab.freedesktop.org/xorg/xserver/-/issues/258 [XKB protocol key actions]: https://www.x.org/releases/current/doc/kbproto/xkbproto.html#Key_Actions

  • Properties
  • Git HTTP https://git.kmx.io/kc3-lang/libxkbcommon.git
    Git SSH git@git.kmx.io:kc3-lang/libxkbcommon.git
    Public ? true
    Name
    Description

    keymap handling library for toolkits and window systems
    Users
    -
    +     		thodg git_deploy kc3_lang_org thodg_l thodg_m thodg_w www_kmx_io
    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, a separate registry library for listing available keyboard layouts and a fair set of CLI tools.

    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
    Complete list of user options @include meson_options.txt

    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.

    Tools

    Libxkbcommon has a fair set of CLI tools, grouped under the xkbcli application:

    xkbcli compile-keymap
    Compile an XKB keymap
    xkbcli compile-compose
    Compile a compose file
    xkbcli how-to-type
    Show how to type a given Unicode codepoint
    xkbcli interactive-wayland
    Interactive debugger for XKB keymaps for Wayland
    xkbcli interactive-x11
    Interactive debugger for XKB keymaps for X11
    xkbcli interactive-evdev
    Interactive debugger for XKB keymaps for evdev
    xkbcli dump-keymap-wayland
    Dump a XKB keymap from a Wayland compositor
    xkbcli dump-keymap-x11
    Dump a XKB keymap from a X server
    xkbcli list
    List available layouts and more

    It may require the installation of the package libxkbcommon-tools or similar name.

    Dataset

    libxkbcommon does not distribute a keyboard layout 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. Further information on xkeyboard-config is available at its homepage and at its repository.

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

    Relation to X11

    See Compatibility notes.

    Development

    An project’s 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:

    License

    See the LICENSE file.

    Credits

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