Google Git
Sign in
android / platform / external / libxkbcommon / 3f6082fd1093bef8c28db289e319d5dd520f677e
commit3f6082fd1093bef8c28db289e319d5dd520f677e[log] [tgz]
authorXin Li <delphij@google.com>Tue Aug 16 23:25:31 2022 +0000
committerAutomerger Merge Worker <android-build-automerger-merge-worker@system.gserviceaccount.com>Tue Aug 16 23:25:31 2022 +0000
tree876958239f94fd3777080157f13d15f301cf52a2
parent084b4446b93e7025e151308265526ae75e0dcf88 [diff]
parent0381da6fe61aadd73352cad8a7568501b5b97b6a [diff]
[automerger skipped] DO NOT MERGE - Merge Android 13 am: 0381da6fe6 -s ours

am skip reason: Merged-In I278a58f24712b21522e6a14a2a6a3979406b40e9 with SHA-1 a36f08b4c6 is already in history

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

Change-Id: I7833d1eda1ac1ade6bf28d740cc35cd9983bdbcc
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.