Edit

kc3-lang/libxkbcommon

Branch :

  • Show log

    Commit

  • Author : Pierre Le Marre
    Date : 2024-12-03 10:12:03
    Hash : 551cca2a
    Message : state: Add server API for updating latched and locked mods & layout Up to now, the “server state” `xkb_state` API only offered one entry point to update the server state – `xkb_state_update_key`, which reflects the direct keyboard keys state. But some updates come out-of-band from keyboard input events stream, for example, a GUI layout switcher. The X11 XKB protocol has a request which allows for such updates, `XkbLatchLockState`[^1], but xkbcommon does not have similar functionality. So server applications ended up using `xkb_state_update_state` for this, but that’s a function intended for client applications, not servers. Add support for updating the latched & locked state of the mods and layout. Note that the depressed states cannot be updated in this way -- XKB does not expect them to be updated out of band. [^1]: https://www.x.org/releases/X11R7.7/doc/kbproto/xkbproto.html#Querying_and_Changing_Keyboard_State Fixes: #310 Signed-off-by: Ran Benita <ran@unusedvar.com> Co-authored-by: Ran Benita <ran@unusedvar.com> Co-authored-by: Pierre Le Marre <dev@wismill.eu>

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