Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / libxkbcommon / refs/heads/int/13/fp4
commit1edee3451aba6b841f02b8074a10c4c98121a02a[log] [tgz]
authorYuichiro Hanada <yhanada@google.com>Mon May 02 17:54:19 2022 +0000
committerAutomerger Merge Worker <android-build-automerger-merge-worker@system.gserviceaccount.com>Mon May 02 17:54:19 2022 +0000
tree876958239f94fd3777080157f13d15f301cf52a2
parentbc21806ac470c29d74d6532d7f9731704a3c62ae [diff]
parent28c13cad562a8072bba5fbcb80d2ad77b12be205 [diff]
Uprev libxkbcommon to 1.4.0. am: a36f08b4c6 am: 28c13cad56

Original change: https://googleplex-android-review.googlesource.com/c/platform/external/libxkbcommon/+/17987629

Change-Id: I6477642658db9873089bb079a77c28876459be3f
Signed-off-by: Automerger Merge Worker <android-build-automerger-merge-worker@system.gserviceaccount.com>
tree: 876958239f94fd3777080157f13d15f301cf52a2
  1. .github/
  2. bench/
  3. config/
  4. doc/
  5. fuzz/
  6. include/
  7. scripts/
  8. src/
  9. test/
  10. tools/
  11. .editorconfig
  12. .uncrustify.cfg
  13. Android.bp
  14. LICENSE
  15. meson.build
  16. meson_options.txt
  17. METADATA
  18. MODULE_LICENSE_MIT
  19. NEWS
  20. OWNERS
  21. PACKAGING
  22. README.md
  23. xkbcommon-x11.map
  24. xkbcommon.map
  25. xkbregistry.map
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

See Quick Guide.

Building

libxkbcommon is built with Meson:

meson setup build
ninja -C build
ninja -C build test  # 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
ninja -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.