• Show log

    Commit

  • Hash : 9b0b8c68
    Author : Pierre Le Marre
    Date : 2025-04-15T19:53:28

    xkbcomp: Stricter handling of default map include
    
    Before this commit, including a *default* map, i.e. without an explicit
    section name (e.g. `include "au"` vs `include "au(basic)"`) would match
    the first section of the first matching file in the XKB include paths,
    even if this section is not an *explicit* default map (i.e. tagged with
    `default`) but an *implicit* default map (i.e. the first map of the
    file, i.e. a weak match).
    
    It makes user configuration risky: say a user wants to create a custom
    version `au(custom)` of the `au` layout:
    - `./config/xkb/symbols/au`: custom layout in section “custom”.
    - `/usr/share/X11/xkb/symbols/au`: system layout, with *default* section
      “basic”.
    
    In this setup *any* layout that imports the default map from `au` would
    in fact import the *implicit* default map `au(custom)` instead of the
    *explicit* default map `au(basic)`.
    
    This incorrect behavior may thus break setups with multiple layouts.
    This is especially true for symbols files such as: `pc`, `us` or `latin`.
    
    Fixed by trying harder to found the exact default map, defaulting to the
    old behavior (weak match) only if no *explicit* default map (exact match)
    has been found in the XKB include paths.
    

  • 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 registry 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
    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.

    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 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.