xkbcomp.
This particularly affects Japanese layout jp when used with Xwayland.
(#750) xkbcomp. X11: Fixed capitalization transformation not set properly, resulting in some keys (e.g. arrows, Home, etc.) not working when Caps Lock is on.
(#740)
NoSymbol and NoAction() are now dropped. This may affect keys that
rely on an implicit key type.Example: Input:
key <> { [a, A, NoSymbol] };
Compilation with xkbcommon \< 1.9.0:
key <> {
type= "FOUR_LEVEL_SEMIALPHABETIC",
[a, A, NoSymbol, NoSymbol]
};
Compilation with xkbcommon ≥ 1.9.0:
key <> {
type= "ALPHABETIC",
[a, A]
};
Added function xkb_components_names_from_rules() to compute
<abbr title=”Keycodes, Compatibility, Geometry, Symbols, Types”>KcCGST</abbr>
keymap components from
<abbr title=”Rules, Model, Layout, Variant, Options”>RMLVO</abbr> names resolution.
This mainly for debugging purposes and to enable the --kccgst option in the tools.
(#669)
Added the following wild cards to the rules file syntax, in addition to
the current * legacy wild card:
<none>: Match empty value. <some>: Match non-empty value. <any>: Match any (optionally empty) value. Its behavior does not depend on
the context, contrary to the legacy wild card *.
All keymap components are now optional, e.g. a keymap without a xkb_types
section is now legal. The missing components will still be serialized explicitly
in order to maintain backward compatibility.
Added support for further empty compound statements:
xkb_types: type \"xxx\" {}; xkb_compat: interpret x {}; and indicator \"xxx\" {};.
Such statements are initialized using the current defaults, i.e. the
factory implicit defaults or some explicit custom defaults (e.g.
indicator.modifiers = Shift).
Added support for actions and keysyms level list of length 0 and 1: respectively
{} and {a}. Example: key <A> { [{}, {a}, {a, A}] };.
Enable using the merge mode replace in include statements using the prefix ^,
such as: include "a^b". The main motivation is to enable this new syntax in
rules, which previously could not handle this merge mode.
Added support for sequences of actions in interpret statements of the
xkb_compat component, mirroring the syntax used in xkb_symbols.
(#695)
Added support for keysym Capitalization transformation to xkb_state_key_get_syms().
(#552)
xkb_utf32_to_keysym: Allow Unicode noncharacters.
(#715)
xkb_keysym_from_name:
UNNNN: allow control characters C0 and C1 and use
xkb_utf32_to_keysym for the conversion when NNNN < 0x100, for
backward compatibility. 0xNNNN: unchanged. Contrary to the Unicode
format, it does not normalize any keysym values in order to enable roundtrip
with xkb_keysym_get_name. (#715)
Added Unicode code point escape sequences \u{NNNN}. They are replaced with
the UTF-8 encoding of their corresponding code point U+NNNN, if legal.
Supported Unicode code points are in the range 1‥0x10ffff. This is intended
mainly for writing keysyms as UTF-8 encoded strings.
Enable to write keysyms as UTF-8-encoded strings:
U+1F3BA (TRUMPET) "🎺" is converted into a
single keysym: U1F3BA. "J́" is converted to U+004A LATIN CAPITAL
LETTER J plus U+0301 COMBINING ACUTE ACCENT: {J, U0301}. "" denotes the keysym NoSymbol. Enable displaying bidirectional text in XKB files using the following Unicode code points, wherever a white space can be used:
Added support for libxml2-2.14+, which now disallows parsing trailing NULL bytes.
(#692)
Fixed included default section not resolving to an exact match in some cases. It may occur if one creates a file name in a user XKB directory that also exists in the XKB system directory.
Example: if one creates a custom variant my_variant in the file
$XDG_CONFIG_HOME/xkb/symbols/us, then before libxkbcommon 1.9.0 every
statement loading the default map of the us file, include "us", would
wrongly resolve including us(my_variant) from the user configuration
directory instead of us(basic) from the XKB system directory. Starting
from libxkbcommon 1.9.0, include "us" would correctly resolve to the system
file, unless $XDG_CONFIG_HOME/xkb/symbols/us contains an explicit default
section. (#726)
Fixed floating-point number parsing failling on locales that use a decimal
separator different than the period ..
Note that the issue is unlikely to happen even with such locales, unless parsing a keymap with a geometry component which contains floating-point numbers.
Affected API:
xkb_keymap_new_from_file(), xkb_keymap_new_from_buffer(), xkb_keymap_new_from_string(). Unaffected API:
xkb_keymap_new_from_names(): none of the components loaded use
floating-point number. libxkbcommon does not load geometry files. libxkbcommon-x11: no such parsing is involved. Fixed the handling of empty keys. Previously keys with no symbols nor actions would simply be skipped entirely. E.g. in the following:
key <A> { vmods = M };
modifier_map Shift { <A> };
the key <A> would be skipped and the virtual modifier M would not be
mapped to Shift. This is now handled properly.
Fixed characters not escaped properly in the keymap serialization, resulting in a keymap string with erroneous string literals and possible syntax errors.
Fixed octal escape sequences valid in Xorg’s xkbcomp but not in xkbcommon. Now up to 4 digits are parsed, compared to 3 previously.
Fixed the serialization of the whichGroupState indicator field.
xkbcli compile-keymap: Added --kccgst option to display the result of
<abbr title=”Rules, Model, Layout, Variant, Options”>RMLVO</abbr> names resolution to
<abbr title=”Keycodes, Compatibility, Geometry, Symbols, Types”>KcCGST</abbr> components.
This option has the same function than setxkbmap -print. This is particularly
useful for debugging issues with the rules. (#669)
Honor user locale in all tools.
Fixed segfault due to invalid arithmetic to bring negative layout indexes into range. It triggers with the following settings:
N > 0, and n = - k * N (k > 0) Note that these settings are unlikely in usual use cases.
--enable-environment-names option.
NoSymbol is now systematically dropped in multi-keysyms levels:
// Before normalization
key <> { [{NoSymbol}, {a, NoSymbol}, {NoSymbol,b}, {a, NoSymbol, b}] };
// After normalization
key <> { [NoSymbol, a, b, {a, b}] };
Added the upper case mapping ß → ẞ (ssharp → U1E9E). This enable to type
ẞ using CapsLock thanks to the internal capitalization rules.
Updated keysyms case mappings to cover full Unicode 16.0. This change provides a consistent behavior with respect to case mappings, and affects the following:
xkb_keysym_to_lower() and xkb_keysym_to_upper() give different output
for keysyms not covered previously and handle title-cased keysyms.Example of title-cased keysym: U01F2 “Dz”: xkb_keysym_to_lower(U01F2) == U01F3 “Dz” → “dz” xkb_keysym_to_upper(U01F2) == U01F1 “Dz” → “DZ” Note: There is a single exception that do not follow the Unicode mappings:
xkb_keysym_to_upper(ssharp) == U1E9E “ß” → “ẞ”
Note: As before, only simple case mappings (i.e. one-to-one) are supported.
For example, the full upper case of U+01F0 “ǰ” is “J̌” (2 characters: U+004A
and U+030C), which would require 2 keysyms, which is not supported by the
current API.
Implemented the GroupLatch action, usually activated with the keysym
ISO_Group_Latch.
(#455)
Symbols: Added support for multiple actions per levels:
interpret statements are used to find an
action corresponding to each keysym, as expected. SetMods, LatchMods, LockMods; SetGroup, LatchGroup, LockGroup. SetMods + SetGroup: ok SetMods + SetMods: error SetMods + LockMods: error SetMods + LockGroup: ok (#486)
Updated keysyms using latest xorgproto
(commit: d7ea44d5f04cc476dee83ef439a847172f7a6bd1):
Additions:
XKB_KEY_XF86RefreshRateToggle XKB_KEY_XF86Accessibility XKB_KEY_XF86DoNotDisturb Relevant upstream merge request: xorgproto-91.
Added deprecated keysym warnings:
These warnings are activated by setting the log verbosity to at least 2.
It is advised to fix these warnings, as the deprecated items may be removed in a future release.
xkbcommon-names.h: Added the following modifiers names definitions:
XKB_MOD_NAME_MOD1 XKB_MOD_NAME_MOD2 XKB_MOD_NAME_MOD3 XKB_MOD_NAME_MOD4 XKB_MOD_NAME_MOD5 XKB_VMOD_NAME_ALT XKB_VMOD_NAME_META XKB_VMOD_NAME_NUM XKB_VMOD_NAME_SUPER XKB_VMOD_NAME_HYPER XKB_VMOD_NAME_LEVEL3 XKB_VMOD_NAME_LEVEL5 XKB_VMOD_NAME_SCROLL
xkbcommon-names.h: Added XKB_LED_NAME_COMPOSE and XKB_LED_NAME_KANA
definitions to cover all LEDs defined in
USB HID.
Contributed by Martin Rys
Rules: Use XKB paths to resolve relative paths in include statements. (#501)
Rules: Added support for special layouts indexes:
layout[single] is the same as without
explicit index: layout. layout and layout[1]. layout[2] .. layout[MAX_LAYOUT], where MAX_LAYOUT is currently 4. Also added:
%i which correspond to the index of the matched layout. :all qualifier: it applies the qualified item to all layouts. See the documentation for further information.
Previously, setting explicit actions for a group in symbols files made the parser skip compatibility interpretations for all groups in the corresponding key, resulting in possibly broken groups with no explicit actions or missing key fields.
Fixed by skipping interpretations only for groups with explicit actions when parsing a keymap and setting relevant fields explicitly when serializing a keymap to a string. (#511)
xkb_keymap_new_from_names: Allow only one group per key in symbols sections.
While the original issue was fixed in xkeyboard-config
project, the previous handling in libxkbcommon of extra key groups was deemed
unintuitive.
Note: rules resolution may still produce more groups than the input layouts.
This is currently true for some legacy rules in xkeyboard-config.
(#262)
Fixed xkb_keymap_get_as_string truncating the 4 longest keysyms names,
such as Greek_upsilonaccentdieresis.
xkb_keysym_to_utf8: Require only 5 bytes for the buffer, as UTF-8 encodes
code points on up to 4 bytes + 1 byte for the NULL-terminating byte.
Previous standard RFC 2279
(1998) required up to 6 bytes per code point, but has been superseded by
RFC 3629 (2003).
(#418)
Registry: Fixed libxml2 global error handler not reset after parsing, which
could trigger a crash if the corresponding rxkb_context has been freed.
Contributed by Sebastian Keller. (#529)
Rules: Fix handling of wild card * to match the behavior of libxkbfile.
Previously * would match any value, even empty one. Now:
model and options: always match. layout and variant: match any non-empty value. (#497)
Fixed LatchGroup action with the latchToLock option disabled not applying
its latch effect multiple times.
(#577)
Fixed incorrect handling of group indicators when whichGroupState is set with
Base or Latched.
(#579)
Fixed missing explicit virtual modifier mappings when export the keymap as a string.
Fixed the lower case mapping ẞ → ß (U1E9E → ssharp). This re-enable the
detection of alphabetic key types for the pair (ß, ẞ).
Fixed modifiers not properly unset when multiple latches are used simultaneously. (#583)
The following functions now allow to query also virtual modifiers, so they work with any modifiers (real and virtual):
xkb_state_mod_index_is_active xkb_state_mod_indices_are_active xkb_state_mod_name_is_active xkb_state_mod_names_are_active xkb_state_mod_index_is_consumed xkb_state_mod_index_is_consumed2 xkb_state_mod_mask_remove_consumed Warning: they may overmatch in case there are overlappings virtual-to-real modifiers mappings.
X11: Do not drop a level when the keysym is undefined but not the action.
Added xkbcli dump-keymap-wayland and xkbcli dump-keymap-x11 debugging
tools to dump a keymap from a Wayland compositor or a X server, similar to
what xkbcomp -xkb $DISPLAY - does for X servers.
xkbcli compile-compose: the Compose file may be passed as a positional
argument and --file is now deprecated. The file can also be piped to the
standard input by setting the path to -.
xkbcli compile-keymap: Added --keymap as a more intuitive alias for
--from-xkb. Both now accept an optional keymap file argument. These flags
may be omitted; in this case the keymap file may be passed as a positional
argument.
Added --test option to compile-keymap and compile-compose, to enable
testing compilation without printing the resulting file.
xkbcli how-to-type: added new input formats and their corresponding documentation.
Unicode code points can be passed in the following formats:
0xNNNN or U+NNNN. Keysyms can to be passed in the following formats:
0xNNNN;
Fixed various tools truncating the 4 longest keysyms names, such as
Greek_upsilonaccentdieresis.
xkbcli list: Fix duplicate variants.
(#587)
-Wl,--version-script more robust.
(#481)
Updated keysyms using latest xorgproto (commit: cd33097fc779f280925c6d6bbfbd5150f93ca5bc):
For the sake of compatibility, this reintroduces some deleted keysyms and postpones the effective deprecation of others, that landed in xkbcommon 1.6.0.
Additions (reverted removal):
XKB_KEY_dead_lowline XKB_KEY_dead_aboveverticalline XKB_KEY_dead_belowverticalline XKB_KEY_dead_longsolidusoverlay
The following keysyms names remain deprecated, but are set again (i.e. as
before xkbcommon 1.6.0) as the reference names for their respective keysyms,
in order to ensure the transition to the newer names that replace them. This
affects functions such as xkb_keymap_key_get_name and xkb_keymap_get_as_string.
XKB_KEY_masculine: is deprecated in favor of XKB_KEY_ordmasculine XKB_KEY_guillemotleft: is deprecated in favor of XKB_KEY_guillemetleft XKB_KEY_guillemotright: is deprecated in favor of XKB_KEY_guillemetright XKB_KEY_dead_small_schwa: is deprecated in favor of XKB_KEY_dead_schwa XKB_KEY_dead_capital_schwa: is deprecated in favor of XKB_KEY_dead_SCHWA Relevant upstream merge requests: xorgproto-83, xorgproto-84.
Keysyms: Fixed inconsistent results in xkb_keysym_from_name when used with
the flag XKB_KEYSYM_CASE_INSENSITIVE. In some rare cases it would return a
keysym with an upper-case name instead of the expected lower-case (e.g.
XKB_KEY_dead_A instead of XKB_KEY_dead_a).
Keysyms: Fixed case mapping for 3 Latin 1 keysyms:
XKB_KEY_ydiaeresis XKB_KEY_mu XKB_KEY_ssharp
Keysyms: Fixed xkb_keysym_is_modifier to detect also the following keysyms:
XKB_KEY_ISO_Level5_Shift XKB_KEY_ISO_Level5_Latch XKB_KEY_ISO_Level5_Lock Prevent recursive includes of keymap components.
Fixed global default statements x.y = z; in wrong scope not raising an error.
Contributed by Mikhail Gusarov
Keymap: Fixed empty symbols declaration.
Contributed by Yuichiro Hanada.
Rules: Made newline required after !include line.
Contributed by Mikhail Gusarov.
Rules: Fixed a bug where variant indexes were ignored with the layout index used instead. They are practically always the same, but don’t have to be.
Contributed by @wysiwys.
Compose: Fixed a segfault with xkb_compose_table_iterator_next when used on an
empty table.
Compose: Added check to ensure to open only regular files, not e.g. directories.
Registry: Updated the DTD and always parse the “popularity” attribute.
Fixed a few memory leaks and keymap symbols parsing.
xkbcli compile-compose: added new CLI utility to test Compose files. xkbcli interactive-evdev: added --verbose option. xkbcli interactive-x11: added support for Compose. xkbcli interactive-wayland: added support for Compose.
Fix building with clang when using -Wl,--gc-sections.
Contributed by ppw0.
Fixed linking using lld 1.17.
Contributed by Baptiste Daroussin.
Fix building X11 tests on macOS.
Documentation is no longer built by default; it requires -Denable-docs=true.
Remove keysyms that were intended for German T3 layout but are unused:
XKB_KEY_dead_lowline XKB_KEY_dead_aboveverticalline XKB_KEY_dead_belowverticalline XKB_KEY_dead_longsolidusoverlay
See the upstream xorgproto MR. See hereinafter for further changes related to keysyms.
Add Compose iterator API to iterate the entries in a compose table:
xkb_compose_table_entry_sequence xkb_compose_table_entry_keysym xkb_compose_table_entry_utf8 xkb_compose_table_iterator_new xkb_compose_table_iterator_free xkb_compose_table_iterator_next Structured log messages with a message registry. There is an ongoing work to assign unique identifiers to log messages and add a corresponding error index documentation page:
The log entries are preceded with an identifier in the form XKB-NNN, where
NNN is a decimal number.
The log entries can then be parsed with third-party tools, to check for specific identifiers.
The new documentation page “Error index” lists all the kind of error messages with their identifiers. The aim is that each entry could present detailed information on the error and how to fix it.
Add a new warning for numeric keysyms references in XKB files: the preferred keysym reference form is its name or its Unicode value, if relevant.
Add the upper bound XKB_KEYSYM_MAX to check valid keysyms.
Add a warning when loading a keymap using RMLVO with no layout but with the variant set. The variant is actually discarded and both layout and variant are set to default values, but this was done previously with no warning, confusing end users.
Add support for modifier_map None { … }. This feature is missing compared to
the X11 implementation. It allows to reset the modifier map of a key.
Update keysyms using latest xorgproto (commit: 1c8128d72df22843a2022576850bc5ab5e3a46ea):
Additions:
XKB_KEY_ordmasculine (xorgproto-68) XKB_KEY_guillemetleft (xorgproto-68) XKB_KEY_guillemetright (xorgproto-68) XKB_KEY_dead_schwa (xorgproto-78) XKB_KEY_dead_SCHWA (xorgproto-78) XKB_KEY_dead_hamza (xorgproto-71) XKB_KEY_XF86EmojiPicker (xorgproto-44) XKB_KEY_XF86Dictate (xorgproto-49) XKB_KEY_XF86CameraAccessEnable (xorgproto-82) XKB_KEY_XF86CameraAccessDisable (xorgproto-82) XKB_KEY_XF86CameraAccessToggle (xorgproto-82) XKB_KEY_XF86NextElement (xorgproto-82) XKB_KEY_XF86PreviousElement (xorgproto-82) XKB_KEY_XF86AutopilotEngageToggle (xorgproto-82) XKB_KEY_XF86MarkWaypoint (xorgproto-82) XKB_KEY_XF86Sos (xorgproto-82) XKB_KEY_XF86NavChart (xorgproto-82) XKB_KEY_XF86FishingChart (xorgproto-82) XKB_KEY_XF86SingleRangeRadar (xorgproto-82) XKB_KEY_XF86DualRangeRadar (xorgproto-82) XKB_KEY_XF86RadarOverlay (xorgproto-82) XKB_KEY_XF86TraditionalSonar (xorgproto-82) XKB_KEY_XF86ClearvuSonar (xorgproto-82) XKB_KEY_XF86SidevuSonar (xorgproto-82) XKB_KEY_XF86NavInfo (xorgproto-82) Deprecations:
XKB_KEY_masculine: use XKB_KEY_ordmasculine instead (xorgproto-68) XKB_KEY_guillemotleft: use XKB_KEY_guillemetleft instead (xorgproto-68) XKB_KEY_guillemotright: use XKB_KEY_guillemetright instead (xorgproto-68) XKB_KEY_dead_small_schwa: use XKB_KEY_dead_schwa instead (xorgproto-78) XKB_KEY_dead_capital_schwa: use XKB_KEY_dead_SCHWA instead (xorgproto-78) Ongoing work to improve the documentation about XKB and its V1 format.
Prevent xkb_keysym_from_name to parse out-of-range hexadecimal keysyms.
Disallow producing NULL character with escape sequences \0 and \x0.
Prevent overflow of octal escape sequences by making \400..\777 invalid.
Prevent interpreting and emitting invalid Unicode encoding forms: surrogates are invalid in both UTF-32 and UTF-8.
xkb_keymap_new_from_buffer: Allow for a NULL-terminated keymap string.
Compose: Increase the limit of possible entries to handle huge Compose files.
Contributed by alois31.
Add bash completions for xkbcli and its subcommands.
xkbcli interactive-*: Add options --short to hide some fields.
xkbcli interactive-evdev: Add --includes and --include-defaults options.
Add xkb-check-messages experimental tool (not installed).
It checks whether given log messages identifiers are supported.
xkbcli compile-keymap: Allow to use without arguments.
xkbcli interactive-*: Always print keycode.
xkbcli interactive-*: Escape control characters for Unicode output, instead of
printing them as-is, messing the output.
Bump required meson to 0.52.0.
Allow xkbcommon to be used as a subproject.
Contributed by Simon Ser.
Improve Windows compilation.
Add xkb_context flag XKB_CONTEXT_NO_SECURE_GETENV and rxkb_context flag
RXKB_CONTEXT_NO_SECURE_GETENV.
xkbcommon uses getenv_secure() to obtain environment variables. This flag
makes xkbcommon use getenv() instead.
This is useful for some clients that have relatively benign capabilities set, like CAP_SYS_NICE, that also want to use e.g. the XKB configuration from the environment and user configs in XDG_CONFIG_HOME.
Contributed by Ronan Pigott.
Fix crash in xkbcli interactive-wayland under a compositor which supports
new versions of the xdg-shell protocol.
Contributed by Jan Alexander Steffens (heftig).
Fix some MSVC build issues.
Fix some issues when including xkbcommon as a meson subproject.
meson>=0.51 is now required.
New API: XKB_CONTEXT_NO_SECURE_GETENV RXKB_CONTEXT_NO_SECURE_GETENV
Fix compose sequence overriding (common prefix) not working correctly. Regressed in 1.2.0.
Contributed by Weng Xuetian.
Remove various bogus currency sign (particulary Euro and Korean Won) entries from the keysym <-> Unicode mappings. They prevented the real keysyms/codepoints for these from mapping correctly.
Contributed by Sam Lantinga and Simon Ser.
Add enable-tools option to Meson build (on by default) to allow disabling
the xkbcli tools.
Contributed by Alex Xu (Hello71).
In xkbcli list, fix “YAML Norway problem” in output.
Contributed by Peter Hutterer.
In libxkbregistry, variants now inherit iso639, iso3166 and brief from parent layout if omitted.
Contributed by M Hickford.
In libxkbregistry, don’t call xmlCleanupParser() - it’s not supposed to
be called by libraries.
Contributed by Peter Hutterer.
In libxkbregistry, skip over invalid ISO-639 or ISO-3166 entries.
Contributed by Peter Hutterer.
In xkbcli interactive-x11, use the Esc keysym instead of the Esc keycode
for quitting.
Contributed by Simon Ser.
In xkbcli how-to-type, add --keysym argugment for how to type a keysym
instead of a Unicode codepoint.
Fix a crash in xkb_x11_keymap_new_from_device error handling given some
invalid keymaps. Regressed in 1.2.0.
Reported by Zack Weinberg. Tested by Uli Schlachter.
Change xkbcli list to output YAML, instead of the previous ad-hoc format.
This allows to more easily process the information in a programmetic way, for example
xkbcli list | yq -r “.layouts[].layout”
Contributed by Peter Hutterer.
Optimize a certain part of keymap compilation (atom interning).
Fix segmentation fault in case-insensitive xkb_keysym_from_name for certain
values like the empty string.
Contributed by Isaac Freund.
Support building libxkbcommon as a meson subproject.
Contributed by Adrian Perez de Castro.
Add ftruncate fallback for posix_fallocate in xkbcli interactive-wayland
for FreeBSD.
Contributed by Evgeniy Khramtsov.
Properly export library symbols in MSVC.
Contributed by Adrian Perez de Castro.
xkb_x11_keymap_new_from_device() failing when the keymap contains key
types with missing level names, like the one used by the numpad:mac option
in xkeyboard-config. Regressed in 1.2.0.
xkb_x11_keymap_new_from_device() is much faster. It now performs only 2
roundtrips to the X server, instead of dozens (in first-time calls).
Contributed by Uli Schlachter.
Case-sensitive xkb_keysym_from_name() is much faster.
Keysym names of the form 0x12AB and U12AB are parsed more strictly.
Previously the hexadecimal part was parsed with strtoul(), now only up
to 8 hexadecimal digits (0-9A-Fa-f) are allowed.
Compose files now have a size limit (65535 internal nodes). Further sequences are discared and a warning is issued.
Compose table loading (xkb_compose_table_new_from_locale() and similar) is
much faster.
Use poll() instead of epoll() for xlbcli interactive-evdev, making it
portable to FreeBSD which provides evdev but not epoll. On FreeBSD, remember
to install the evdev-proto package to get the evdev headers.
The build now requires a C11 compiler (uses anonymous structs/unions).
Publish the xkb-format-text-v1.md file in the HTML documentation. This file
existed for a long time but only in the Git repository.
Link: https://xkbcommon.org/doc/current/md_doc_keymap_format_text_v1.html
Add partial documentation for xkb_symbols to xkb-format-text-v1.md.
Contributed by Simon Zeni.
Update keysym definitions to latest xorgproto. In particular, this adds many special keysyms corresponding to Linux evdev keycodes.
Contributed by Peter Hutterer <@who-t.net>.
New API: Too many XKBKEY* definitions to list here.
Fix (hopefully) a segfault in xkb_x11_keymap_new_from_device() in some unclear situation (bug introduced in 1.0.2).
Fix keymaps created with xkb_x11_keymap_new_from_device() don’t have level names (bug introduced in 0.8.0).
Fix a bug where a keysym that cannot be resolved in a keymap gets compiled to a garbage keysym. Now it is set to XKB_KEY_NoSymbol instead.
Improve the speed of xkb_x11_keymap_new_from_device() on repeated calls in the same xkb_context().
Fix the tool-option-parsing test failing.
Remove requirement for pytest in the tool-option-parsing test.
Make the table output of xkbcli how-to-type aligned.
Some portability and test isolation fixes.
Note: this release is API and ABI compatible with previous releases – the major version bump is only an indication of stability.
Add libxkbregistry as configure-time optional library. libxkbregistry is a C library that lists available XKB models, layouts and variants for a given ruleset. This is a separate library (libxkbregistry.so, pkgconfig file xkbregistry.pc) and aimed at tools that provide a listing of available keyboard layouts to the user. See the Documentation for details on the API.
Contributed by Peter Hutterer <@who-t.net>.
Better support custom user configuration:
Allow including XKB files from other paths.
Previously, a ‘symbols/us’ file in path A would shadow the same file in path B. This is suboptimal, we rarely need to hide the system files - we care mostly about extending them. By continuing to check other lookup paths, we make it possible for a XDG_CONFIG_HOME/xkb/symbols/us file to have sections including those from /usr/share/X11/xkb/symbols/us.
Note that this is not possible for rules files, which need to be manually controlled to get the right bits resolved.
Add /etc/xkb as extra lookup path for system data files.
This completes the usual triplet of configuration locations available for most processes:
The default lookup order user, system, vendor, just like everything else that uses these conventions.
For include directives in rules files, the ‘%E’ resolves to that path.
Add a new section to the documentation for custom user configuration.
Contributed by Peter Hutterer <@who-t.net>.
Add an xkbcli command-line utility.
This tool offers various subcommands for introspection and debugging. Currently the available subcommands are:
list List available rules, models, layouts, variants and options
interactive-wayland Interactive debugger for XKB keymaps for Wayland
interactive-x11 Interactive debugger for XKB keymaps for X11
interactive-evdev Interactive debugger for XKB keymaps for evdev (Linux)
compile-keymap Compile an XKB keymap
how-to-type See separate entry below.
See the manpages for usage information.
Contributed by Peter Hutterer <@who-t.net>.
Add xkb_utf32_to_keysym() to translate a Unicode codepoint to a keysym.
When a special keysym (XKB_KEY_ constant) for the codepoint exists, it is
returned, otherwise the direct encoding is used, if permissible.
Contributed by Jaroslaw Kubik <@froglogic.com>.
Add xkb_keymap_key_get_mods_for_level() which retrieves sets of modifiers
which produce a given shift level in a given key+layout.
Contributed by Jaroslaw Kubik <@froglogic.com>.
Add xkbcli how-to-type command, which, using xkb_utf32_to_keysym()
and xkb_keymap_key_get_mods_for_level() and other APIs, prints out all
the ways to produce a given keysym.
For example, how to type ? (codepoint 63) in a us,de keymap?
$ xkbcli how-to-type –layout us,de 63 | column -ts $’\t’ keysym: question (0x3f) KEYCODE KEY NAME LAYOUT# LAYOUT NAME LEVEL# MODIFIERS 20 AE11 2 German 2 [ Shift ] 20 AE11 2 German 2 [ Shift Lock ] 61 AB10 1 English (US) 2 [ Shift ]
Add a new section to the documentation describing the format of the XKB rules file.
Search for Compose in $XDG_CONFIG_HOME/XCompose (fallback to ~/.config/XCompose) before trying $HOME/.XCompose.
Note that libX11 still only searches in $HOME/.XCompose.
Contributed by Emmanuel Gil Peyrot <@linkmauve.fr>.
Bump meson requirement to >= 0.49.0.
Fix build with byacc.
Fix building X11 tests on PE targets.
Contributed by Jon Turney <@dronecode.org.uk>
The tests no longer rely on bash, only Python (which is already used by meson).
New API: xkb_utf32_to_keysym xkb_keymap_key_get_mods_for_level XKB_KEY_XF86FullScreen
(security) Fix quadratic complexity in the XKB file parser. See commit message 7c42945e04a2107827a057245298dedc0475cc88 for details.
Add $XDG_CONFIG_HOME/xkb to the default search path. If $XDG_CONFIG_HOME is not set, $HOME/.config/xkb is used. If $HOME is not set, the path is not added.
The XDG path is looked up before the existing default search path $HOME/.xkb.
Contributed by Peter Hutterer <@who-t.net>.
Add support for include statements in XKB rules files.
This is a step towards making local XKB customizations more tenable and convenient, without modifying system files.
You can now include other rules files like this:
! include %S/evdev
Two directives are supported, %H to $HOME and %S for the system-installed rules directory (usually /usr/share/X11/xkb/rules).
See commit message ca033a29d2ca910fd17b1ae287cb420205bdddc8 and doc/rules-format.txt in the xkbcommon source code for more information.
Contributed by Peter Hutterer <@who-t.net>.
Downgrade “Symbol added to modifier map for multiple modifiers” log to a warning.
This error message was too annoying to be shown by default. When working on
keymaps, set XKB_LOG_LEVEL=debug XKB_LOG_VERBOSITY=10 to see all possible
messages.
Support building on Windows using the meson MSVC backend.
Contributed by Adrian Perez de Castro <@igalia.com>.
Fix bug where the merge mode only applied to the first vmod in a
virtual_modifiers statement. Given
augment virtual_modifiers NumLock,Alt,LevelThree
Previously it was incorrectly treated as
augment virtual_modifiers NumLock;
virtual_modifiers Alt;
virtual_modifiers LevelThree;
Now it is treated as
augment virtual_modifiers NumLock;
augment virtual_modifiers Alt;
augment virtual_modifiers LevelThree;
Reject interpret modifier predicate with more than one value. Given
interpret ISO_Level3_Shift+AnyOf(all,extraneous) { ... };
Previously, extraneous (and further) was ignored. Now it’s rejected.
Correctly handle capitalization of the ssharp keysym.
Speed up and improve the internal xkeyboard-config tool. This tool
compiles all layout/variant combinations in the xkeyboard-config dataset
and reports any issues it finds.
Contributed by Peter Hutterer <@who-t.net>.
Speed up “atoms” (string interning). This code goes back at least to X11R1 (released 1987).
secure_getenv(3), e.g. GDM. Move ~/.xkb to before XKB_CONFIG_ROOT (the system XKB path, usually /usr/share/X11/xkb) in the default include path. This enables the user to have full control of the keymap definitions, instead of only augmenting them.
Remove the Autotools build system. Use the meson build system instead.
Fix invalid names used for levels above 8 when dumping keymaps. Previously, e.g. “Level20” was dumped, but only up to “Level8” is accepted by the parser. Now “20” is dumped.
Change level references to always be dumped as e.g. “5” instead of “Level5”.
Change group references to always be dumped capitalized e.g. “Group3” instead of “group3”. Previously it was inconsistent.
These changes affect the output of xkb_keymap_get_as_string().
Fix several build issues on macOS/Darwin, Solaris, NetBSD, cross compilation.
Port the interactive-wayland test program to the stable version of xdg-shell.
Fix build of xkbcommon-x11 static library with meson.
Fix building using meson from the tarball generated by autotools.
Fix build of static libraries with meson. (Future note: xkbcommon-x11 was not fixed in this release.)
New API: XKB_KEY_XF86MonBrightnessCycle XKB_KEY_XF86RotationLockToggle
Fix various problems found with fuzzing (see commit messages for more details):
Fix various problems found in the meson build (see commit messages for more details):
Fix compilation on Darwin.
Fix compilation of the x11 tests and demos when XCB is installed in a non-standard location.
Fix xkbcommon-x11.pc missing the Requires specification.
Fix various problems found with fuzzing and Coverity (see commit messages for more details):
Fix stack overflow in the XKB text format parser when evaluating boolean negation.
Fix NULL-dereferences in the XKB text format parser when some unsupported tokens appear (the tokens are still parsed for backward compatibility).
Fix NULL-dereference in the XKB text format parser when parsing an xkb_geometry section.
Fix an infinite loop in the Compose text format parser on some inputs.
Fix an invalid free() when using multiple keysyms.
Replace the Unicode characters for the leftanglebracket and rightanglebracket keysyms from the deprecated LEFT/RIGHT-POINTING ANGLE BRACKET to MATHEMATICAL LEFT/RIGHT ANGLE BRACKET.
Reject out-of-range Unicode codepoints in xkb_keysym_to_utf8 and xkb_keysym_to_utf32.
Added xkbkeysym_to{upper,lower} to perform case-conversion directly on keysyms. This is useful in some odd cases, but working with the Unicode representations should be preferred when possible.
Added Unicode conversion rules for the signifblank and permille keysyms.
Fixed a bug in the parsing of XKB key type definitions where the number of levels were determined by the number of level names. Keymaps which omit level names were hence miscompiled.
This regressed in version 0.4.3. Keymaps from xkeyboard-config were not affected since they don’t omit level names.
New API: xkb_keysym_to_upper() xkb_keysym_to_lower()
Added a Meson build system as an alternative to existing autotools build system.
The intent is to remove the autotools build in one of the next releases. Please try to convert to it and report any problems.
See http://mesonbuild.com/Quick-guide.html for basic usage, the meson_options.txt for the project-specific configuration options, and the PACKAGING file for more details.
There are some noteworthy differences compared to the autotools build:
Feature auto-detection is not performed. By default, all features are enabled (currently: docs, x11, wayland). The build fails if any of the required dependencies are not available. To disable a feature, pass -Denable-<feature>=false to meson.
The libraries are either installed as shared or static, as specified by the -Ddefault_library=shared/static option. With autotools, both versions are installed by default.
xorg-util-macros is not used.
A parser generator (bison/byacc) is always required - there is no fallback to pre-generated output bundled in the tarball, as there is in autotools.
Removed Android.mk support.
Removed the *-uninstalled.pc pkgconfig files.
Ported the interactive-wayland demo program to v6 of the xdg-shell protocol.
Added new keysym definitions from xproto.
New API: XKB_KEY_XF86Keyboard XKB_KEY_XF86WWAN XKB_KEY_XF86RFKill XKB_KEY_XF86AudioPreset
Fixed various reported problems when the current locale is tr_TR.UTF-8.
The function xkb_keysym_from_name() used to perform case-insensitive string comparisons in a locale-dependent way, but required it to to work as in the C/ASCII locale (the so called “Turkish i problem”).
The function is now no longer affected by the current locale.
Fixed compilation in NetBSD.
Added support for different “modes” of calculating consumed modifiers. The existing mode, based on the XKB standard, has proven to be unintuitive in various shortcut implementations.
A new mode, based on the calculation used by the GTK toolkit, is added. This mode is less eager to declare a modifier as consumed.
Added a new interactive demo program using the Wayland protocol. See the PACKAGING file for the new (optional) test dependencies.
Fixed a compilation error on GNU Hurd.
New API: enum xkb_consumed_mode XKB_CONSUMED_MODE_XKB XKB_CONSUMED_MODE_GTK xkb_state_key_get_consumed_mods2 xkb_state_mod_index_is_consumed2
Added LICENSE to distributed files in tarball releases.
Minor typo fix in xkb_keymap_get_as_string() documentation.
If the XKB_CONFIG_ROOT environment variable is set, it is used as the XKB configuration root instead of the path determined at build time.
Tests and benchmarks now build correctly on OSX.
An XKB keymap provides a name for each key it defines. Traditionally, these names are limited to at most 4 characters, and are thus somewhat obscure, but might still be useful (xkbcommon lifts the 4 character limit).
The new functions xkb_keymap_key_get_name() and xkb_keymap_key_by_name() can be used to get the name of a key or find a key by name. Note that a key may have aliases.
Documentation improvements.
New API: xkb_keymap_key_by_name() xkb_keymap_key_get_name()
Added support for Compose/dead keys in a new module (included in libxkbcommon). See the documentation or the xkbcommon/xkbcommon-compose.h header file for more details.
Improved and reordered some sections of the documentation.
The doxygen HTML pages were made nicer to read.
Most tests now run also on non-linux platforms.
A warning is emitted by default about RMLVO values which are not used during keymap compilation, which are most often a user misconfiguration. For example, “terminate:ctrl_alt_backspace” instead of “terminate:ctrl_alt_bksp”.
Added symbol versioning for libxkbcommon and libxkbcommon-x11. Note: binaries compiled against this and future versions will not be able to link against the previous versions of the library.
Removed several compatablity symbols from the binary (the API isn’t affected). This affects binaries which
Such a scenario is likely to fail already.
If Xvfb is not available, the x11comp test is now correctly skipped instead of hanging.
Benchmarks were moved to a separate bench/ directory.
Build fixes from OpenBSD.
Fixed a bug where key type entries such as “map[None] = Level2;” were ignored.
New API: XKBCOMPOSE xkbcompose
Fixed a bug which caused xkb_x11_keymap_new_from_device() to misrepresent modifiers for some keymaps.
Fixed a bug which caused xkb_x11_keymap_new_from_device() to ignore XKB PrivateAction’s.
Modifiers are now always fully resolved after xkb_state_update_mask(). Previously the given state components were used as-is, without considering virtual modifier mappings. Note: this only affects non-standard uses of xkb_state_update_mask().
Added a test for xkbcommon-x11, “x11comp”. The test uses the system’s Xvfb server and xkbcomp. If they do not exist or fail, the test is skipped.
Fixed memory leaks after parse errors in the XKB yacc parser. The fix required changes which are currently incompatible with byacc.
Fixed a bug where explicitly passing “–enable-x11” to ./configure would in fact disable it (regressed in 0.4.1).
Added @since version annotations to the API documentation for everything introduced after the initial stable release (0.2.0).
Added a section to the documentation about keysym transformations, and clarified which functions perform a given transformation.
XKB files which fail to compile during keymap construction can no longer have any effect on the resulting keymap: changes are only applied when the entire compilation succeeds. Note: this was a minor correctness issue inherited from xkbcomp.
Fix an out-of-bounds array access in src/x11/util.c:adopt_atoms() error-handling code. Note: it seems impossible to trigger in the current code since the input size cannot exceed the required size.
Converted README to markdown and added a Quick Guide to the documentation, which breezes through the most common parts of xkbcommon.
Added two new functions, xkb_state_key_get_utf{8,32}(). They combine the operations of xkb_state_key_get_syms() and xkb_keysym_to_utf{8,32}(), and provide a nicer interface for it (espcially for multiple-keysyms-per-level).
The xkb_state_key_get_utf{8,32}() functions now apply Control transformation: when the Control modifier is active, the string is converted to an appropriate control character. This matches the behavior of libX11’s XLookupString(3), and required by the XKB specification: https://www.x.org/releases/current/doc/kbproto/xkbproto.html#Interpreting_the_Control_Modifier
The consumed modifiers for a key are now calculated similarly to libX11. The previous behavior caused a bug where Shift would not cancel an active Caps Lock.
Make xkbcommon-x11 work with the keymap reported by the XQuartz X server.
Reduce memory usage during keymap compilation some more.
New API: xkb_state_key_get_consumed_mods() xkb_state_key_get_utf8() xkb_state_key_get_utf32()
Deprecated API: XKB_MAP_COMPILE_PLACEHOLDER, XKB_MAP_NO_FLAGS use XKB_KEYMAP_NO_FLAGS instead.
Bug fixes.
Add a new add-on library, xkbcommon-x11, to support creating keymaps with the XKB X11 protocol, by querying the X server directly. See the xkbcommon/xkbcommon-x11.h header file for more details. This library requires libxcb-xkb >= 1.10, and is enabled by default. It can be disabled with the –disable-x11 configure switch. Distributions are encouraged to split the necessary files for this library (libxkbcommon-x11.so, xkbcommon-x11.pc, xkbcommon/xkbcommon-x11.h) to a separate package, such that the main package does not depend on X11 libraries.
Fix the keysym <-> name lookup table to not require huge amounts of relocations.
Fix a bug in the keysym <-> name lookup, whereby lookup might fail in some rare cases.
Reduce memory usage during keymap compilation.
New API: New keysyms from xproto 7.0.25 (German T3 layout keysyms). XKBMOD_NAME_NUM for the usual NumLock modifier. xkb_x11 types and functions, XKBX11 constants.
Log messages from the library now look like “xkbcommon: ERROR” by default, instead of xkbcomp-like “Error: “.
Apply capitalization transformation on keysyms in xkb_keysym_get_one_sym(), to match the behavior specified in the XKB specification: https://www.x.org/releases/current/doc/kbproto/xkbproto.html#Interpreting_the_Lock_Modifier
Support byacc for generating the parser, in addition to Bison.
New API: XKB_KEY_XF86AudioMicMute keysym from xproto 7.0.24. XKB_KEYSYM_NO_FLAGS XKB_CONTEXT_NO_FLAGS XKB_MAP_COMPILE_NO_FLAGS
Bug fixes.
Replace the flex scanner with a hand-written one. flex is no longer a build requirement.
New API: xkb_keymap_min_keycode() xkb_keymap_max_keycode() xkb_keymap_key_for_each()
Allow passing NULL to *_unref() functions; do nothing instead of crashing.
The functions xkb_keymap_num_levels_for_key() and xkb_keymap_get_syms_by_level() now allow out-of-range values for the ‘layout’ parameter. The functions now wrap the value around the number of layouts instead of failing.
The function xkb_keysym_get_name() now types unicode keysyms in uppercase and 0-padding, to match the format used by XKeysymToString().
Building Linux-specific tests is no longer attempted on non-Linux environments.
The function xkb_keymap_new_from_names() now accepts a NULL value for the ‘names’ parameter, instead of failing. This is equivalent to passing a ‘struct xkb_rule_names’ with all fields set to NULL.
New API: xkb_keymap_new_from_buffer()
Bug fixes.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622
libxkbcommon [1.9.2] - 2025-05-07
=================================
[1.9.2]: https://github.com/xkbcommon/libxkbcommon/tree/xkbcommon-1.9.2
## API
### Fixes
- Fixed empty compatibility interpretation statement not parsable by X11’s `xkbcomp`.
This particularly affects Japanese layout `jp` when used with Xwayland.
([#750](https://github.com/xkbcommon/libxkbcommon/issues/750))
- Fixed empty compatibility interpretations map not parsable by X11’s `xkbcomp`.
- Fixed key type map entries with a mix of bound and unbound modifiers not being ignored.
([#758](https://github.com/xkbcommon/libxkbcommon/issues/758))
libxkbcommon [1.9.1] - 2025-05-02
=================================
[1.9.1]: https://github.com/xkbcommon/libxkbcommon/tree/xkbcommon-1.9.1
## API
### Fixes
- X11: Fixed capitalization transformation not set properly, resulting in
some keys (e.g. arrows, Home, etc.) not working when Caps Lock is on.
([#740](https://github.com/xkbcommon/libxkbcommon/issues/740))
libxkbcommon [1.9.0] - 2025-04-26
=================================
[1.9.0]: https://github.com/xkbcommon/libxkbcommon/tree/xkbcommon-1.9.0
## API
### Breaking changes
- *Merge modes* and *include mechanism* were completely refactored to fix inconsistencies.
Included files are now always processed in isolation and do not propagate the local
merge modes. This makes the reasoning about included files much easier and consistent.
- Trailing `NoSymbol` and `NoAction()` are now dropped. This may affect keys that
rely on an *implicit* key type.
Example:
- Input:
```c
key <> { [a, A, NoSymbol] };
```
- Compilation with xkbcommon \< 1.9.0:
```c
key <> {
type= "FOUR_LEVEL_SEMIALPHABETIC",
[a, A, NoSymbol, NoSymbol]
};
```
- Compilation with xkbcommon ≥ 1.9.0:
```c
key <> {
type= "ALPHABETIC",
[a, A]
};
```
### New
- Added function `xkb_components_names_from_rules()` to compute
<abbr title="Keycodes, Compatibility, Geometry, Symbols, Types">KcCGST</abbr>
keymap components from
<abbr title="Rules, Model, Layout, Variant, Options">RMLVO</abbr> names resolution.
This mainly for *debugging* purposes and to enable the `--kccgst` option in the tools.
([#669](https://github.com/xkbcommon/libxkbcommon/issues/669))
- Added the following *wild cards* to the **rules** file syntax, in addition to
the current `*` legacy wild card:
- `<none>`: Match *empty* value.
- `<some>`: Match *non-empty* value.
- `<any>`: Match *any* (optionally empty) value. Its behavior does not depend on
the context, contrary to the legacy wild card `*`.
- All keymap components are now optional, e.g. a keymap without a `xkb_types`
section is now legal. The missing components will still be serialized explicitly
in order to maintain backward compatibility.
- Added support for further empty compound statements:
- `xkb_types`: `type \"xxx\" {};`
- `xkb_compat`: `interpret x {};` and `indicator \"xxx\" {};`.
Such statements are initialized using the current defaults, i.e. the
factory implicit defaults or some explicit custom defaults (e.g.
`indicator.modifiers = Shift`).
- Added support for actions and keysyms level list of length 0 and 1: respectively
`{}` and `{a}`. Example: `key <A> { [{}, {a}, {a, A}] };`.
- Enable using the merge mode *replace* in include statements using the prefix `^`,
such as: `include "a^b"`. The main motivation is to enable this new syntax in
*rules*, which previously could not handle this merge mode.
- Added support for sequences of actions in `interpret` statements of the
`xkb_compat` component, mirroring the syntax used in `xkb_symbols`.
([#695](https://github.com/xkbcommon/libxkbcommon/issues/695))
- Added support for keysym Capitalization transformation to `xkb_state_key_get_syms()`.
([#552](https://github.com/xkbcommon/libxkbcommon/issues/552))
- `xkb_utf32_to_keysym`: Allow [Unicode noncharacters].
([#715](https://github.com/xkbcommon/libxkbcommon/issues/715))
- `xkb_keysym_from_name`:
- Unicode format `UNNNN`: allow control characters C0 and C1 and use
`xkb_utf32_to_keysym` for the conversion when `NNNN < 0x100`, for
backward compatibility.
- Numeric hexadecimal format `0xNNNN`: *unchanged*. Contrary to the Unicode
format, it does not normalize any keysym values in order to enable roundtrip
with `xkb_keysym_get_name`.
[Unicode noncharacters]: https://en.wikipedia.org/wiki/Universal_Character_Set_characters#Noncharacters
([#715](https://github.com/xkbcommon/libxkbcommon/issues/715))
- Added [Unicode code point] escape sequences `\u{NNNN}`. They are replaced with
the [UTF-8] encoding of their corresponding code point `U+NNNN`, if legal.
Supported Unicode code points are in the range `1‥0x10ffff`. This is intended
mainly for writing keysyms as [UTF-8] encoded strings.
[Unicode code point]: https://en.wikipedia.org/wiki/Unicode#Codespace_and_code_points
[UTF-8]: https://en.wikipedia.org/wiki/UTF-8
- Enable to write keysyms as UTF-8-encoded strings:
- *Single* Unicode code point `U+1F3BA` (TRUMPET) `"🎺"` is converted into a
single keysym: `U1F3BA`.
- *Multiple* Unicode code points are converted to a keysym *list* where it is
allowed (i.e. in key symbols). E.g. `"J́"` is converted to U+004A LATIN CAPITAL
LETTER J plus U+0301 COMBINING ACUTE ACCENT: `{J, U0301}`.
- An empty string `""` denotes the keysym `NoSymbol`.
- Enable displaying bidirectional text in XKB files using the following Unicode
code points, wherever a white space can be used:
- U+200E LEFT-TO-RIGHT MARK
- U+200F RIGHT-TO-LEFT MARK
### Fixes
- Added support for `libxml2-2.14+`, which now disallows parsing trailing `NULL` bytes.
([#692](https://github.com/xkbcommon/libxkbcommon/issues/692))
- Fixed included *default* section not resolving to an *exact* match in some
cases. It may occur if one creates a file name in a *user* XKB directory that
also exists in the XKB *system* directory.
Example: if one creates a custom variant `my_variant` in the file
`$XDG_CONFIG_HOME/xkb/symbols/us`, then *before* libxkbcommon 1.9.0 every
statement loading the *default* map of the `us` file, `include "us"`, would
wrongly resolve including `us(my_variant)` from the *user* configuration
directory instead of `us(basic)` from the XKB *system* directory. Starting
from libxkbcommon 1.9.0, `include "us"` would correctly resolve to the system
file, unless `$XDG_CONFIG_HOME/xkb/symbols/us` contains an *explicit default*
section. ([#726](https://github.com/xkbcommon/libxkbcommon/issues/726))
- Fixed floating-point number parsing failling on locales that use a decimal
separator different than the period `.`.
Note that the issue is unlikely to happen even with such locales, unless
*parsing* a keymap with a *geometry* component which contains floating-point
numbers.
Affected API:
- `xkb_keymap_new_from_file()`,
- `xkb_keymap_new_from_buffer()`,
- `xkb_keymap_new_from_string()`.
Unaffected API:
- `xkb_keymap_new_from_names()`: none of the components loaded use
floating-point number. libxkbcommon does not load *geometry* files.
- `libxkbcommon-x11`: no such parsing is involved.
- Fixed the handling of empty keys. Previously keys with no symbols nor actions
would simply be skipped entirely. E.g. in the following:
```c
key <A> { vmods = M };
modifier_map Shift { <A> };
```
the key `<A>` would be skipped and the virtual modifier `M` would not be
mapped to `Shift`. This is now handled properly.
- Fixed characters not escaped properly in the keymap serialization, resulting in
a keymap string with erroneous string literals and possible syntax errors.
- Fixed octal escape sequences valid in Xorg’s xkbcomp but not in xkbcommon. Now up
to *4* digits are parsed, compared to *3* previously.
- Fixed the serialization of the `whichGroupState` indicator field.
## Tools
### New
- `xkbcli compile-keymap`: Added `--kccgst` option to display the result of
<abbr title="Rules, Model, Layout, Variant, Options">RMLVO</abbr> names resolution to
<abbr title="Keycodes, Compatibility, Geometry, Symbols, Types">KcCGST</abbr> components.
This option has the same function than `setxkbmap -print`. This is particularly
useful for debugging issues with the rules. ([#669](https://github.com/xkbcommon/libxkbcommon/issues/669))
- Honor user locale in all tools.
libxkbcommon [1.8.1] - 2025-03-12
=================================
[1.8.1]: https://github.com/xkbcommon/libxkbcommon/tree/xkbcommon-1.8.1
## API
### Fixes
- Fixed segfault due to invalid arithmetic to bring *negative* layout indexes
into range. It triggers with the following settings:
- layouts count (per key or total) N: `N > 0`, and
- layout index n: `n = - k * N` (`k > 0`)
Note that these settings are unlikely in usual use cases.
## Tools
### Breaking changes
- The tools do not load the *default* RMLVO (rules, model, layout, variant, options)
values from the environment anymore. The previous behavior may be restored by using
the new `--enable-environment-names` option.
## Build system
### New
- Source files are now annotated with SPDX short license identifiers.
The LICENSE file was updated to accommodate this. ([#628](https://github.com/xkbcommon/libxkbcommon/issues/628))
libxkbcommon [1.8.0] - 2025-02-04
=================================
[1.8.0]: https://github.com/xkbcommon/libxkbcommon/tree/xkbcommon-1.8.0
## API
### Breaking changes
- `NoSymbol` is now systematically dropped in multi-keysyms levels:
```c
// Before normalization
key <> { [{NoSymbol}, {a, NoSymbol}, {NoSymbol,b}, {a, NoSymbol, b}] };
// After normalization
key <> { [NoSymbol, a, b, {a, b}] };
```
- Added the upper case mapping ß → ẞ (`ssharp` → `U1E9E`). This enable to type
ẞ using CapsLock thanks to the internal capitalization rules.
- Updated keysyms case mappings to cover full **[Unicode 16.0]**. This change
provides a *consistent behavior* with respect to case mappings, and affects
the following:
- `xkb_keysym_to_lower()` and `xkb_keysym_to_upper()` give different output
for keysyms not covered previously and handle *title*-cased keysyms.
Example of title-cased keysym: `U01F2` “Dz”:
- `xkb_keysym_to_lower(U01F2) == U01F3` “Dz” → “dz”
- `xkb_keysym_to_upper(U01F2) == U01F1` “Dz” → “DZ”
- *Implicit* alphabetic key types are better detected, because they use the
latest Unicode case mappings and now handle the *title*-cased keysyms the
same way as upper-case ones.
Note: There is a single *exception* that do not follow the Unicode mappings:
- `xkb_keysym_to_upper(ssharp) == U1E9E` “ß” → “ẞ”
Note: As before, only *simple* case mappings (i.e. one-to-one) are supported.
For example, the full upper case of `U+01F0` “ǰ” is “J̌” (2 characters: `U+004A`
and `U+030C`), which would require 2 keysyms, which is not supported by the
current API.
[Unicode 16.0]: https://www.unicode.org/versions/Unicode16.0.0/
### New
- Implemented the `GroupLatch` action, usually activated with the keysym
`ISO_Group_Latch`.
([#455](https://github.com/xkbcommon/libxkbcommon/issues/455))
- Symbols: Added support for *multiple actions per levels:*
- When no action is specified, `interpret` statements are used to find an
action corresponding to *each* keysym, as expected.
- When both keysyms and actions are specified, they may have a different count
for each level.
- For now, at most one action of each of the following categories is allowed
per level:
- modifier actions: `SetMods`, `LatchMods`, `LockMods`;
- group actions: `SetGroup`, `LatchGroup`, `LockGroup`.
Some examples:
- `SetMods` + `SetGroup`: ok
- `SetMods` + `SetMods`: error
- `SetMods` + `LockMods`: error
- `SetMods` + `LockGroup`: ok
([#486](https://github.com/xkbcommon/libxkbcommon/issues/486))
- Updated keysyms using latest [xorgproto]
(commit: `d7ea44d5f04cc476dee83ef439a847172f7a6bd1`):
Additions:
- `XKB_KEY_XF86RefreshRateToggle`
- `XKB_KEY_XF86Accessibility`
- `XKB_KEY_XF86DoNotDisturb`
Relevant upstream merge request: [xorgproto-91].
[xorgproto-91]: https://gitlab.freedesktop.org/xorg/proto/xorgproto/-/merge_requests/91
- Added deprecated keysym warnings:
- *name* deprecation (typo, historical alias), reporting the reference name;
- *keysym* deprecation (ambiguous meaning, all names deprecated).
These warnings are activated by setting the log verbosity to at least 2.
It is advised to fix these warnings, as the deprecated items may be removed in
a future release.
- `xkbcommon-names.h`: Added the following modifiers names definitions:
- `XKB_MOD_NAME_MOD1`
- `XKB_MOD_NAME_MOD2`
- `XKB_MOD_NAME_MOD3`
- `XKB_MOD_NAME_MOD4`
- `XKB_MOD_NAME_MOD5`
- `XKB_VMOD_NAME_ALT`
- `XKB_VMOD_NAME_META`
- `XKB_VMOD_NAME_NUM`
- `XKB_VMOD_NAME_SUPER`
- `XKB_VMOD_NAME_HYPER`
- `XKB_VMOD_NAME_LEVEL3`
- `XKB_VMOD_NAME_LEVEL5`
- `XKB_VMOD_NAME_SCROLL`
- `xkbcommon-names.h`: Added `XKB_LED_NAME_COMPOSE` and `XKB_LED_NAME_KANA`
definitions to cover all LEDs defined in
[USB HID](https://usb.org/sites/default/files/hid1_11.pdf).
Contributed by Martin Rys
- Rules: Use XKB paths to resolve relative paths in include statements.
([#501](https://github.com/xkbcommon/libxkbcommon/issues/501))
- Rules: Added support for special layouts indexes:
- *single*: matches a single layout; `layout[single]` is the same as without
explicit index: `layout`.
- *first*: matches the first layout/variant, no matter how many layouts are in
the RMLVO configuration. Acts as both `layout` and `layout[1]`.
- *later*: matches all but the first layout. This is an index range. Acts as
`layout[2]` .. `layout[MAX_LAYOUT]`, where `MAX_LAYOUT` is currently 4.
- *any*: matches layout at any position. This is an index range.
Also added:
- the special index `%i` which correspond to the index of the matched layout.
- the `:all` qualifier: it applies the qualified item to all layouts.
See the [documentation](https://xkbcommon.org/doc/current/rule-file-format.html)
for further information.
### Fixes
- Previously, setting *explicit actions* for a group in symbols files made the
parser skip compatibility interpretations for *all* groups in the corresponding
key, resulting in possibly broken groups with *no* explicit actions or missing
key fields.
Fixed by skipping interpretations only for groups with explicit actions when
parsing a keymap and setting relevant fields explicitly when serializing a
keymap to a string.
([#511](https://github.com/xkbcommon/libxkbcommon/issues/511))
- `xkb_keymap_new_from_names`: Allow only one group per key in symbols sections.
While the original issue was [fixed in `xkeyboard-config`][xkeyboard-config-253]
project, the previous handling in `libxkbcommon` of extra key groups was deemed
unintuitive.
[xkeyboard-config-253]: https://gitlab.freedesktop.org/xkeyboard-config/xkeyboard-config/-/merge_requests/253
Note: rules resolution may still produce more groups than the input layouts.
This is currently true for some [legacy rules in `xkeyboard-config`][xkeyboard-config-legacy-rules].
([#262](https://github.com/xkbcommon/libxkbcommon/issues/262))
[xkeyboard-config-legacy-rules]: https://gitlab.freedesktop.org/xkeyboard-config/xkeyboard-config/-/blob/6a2eb9e63bcb3c52584580570d31cd91110d1f2e/rules/0013-modellayout_symbols.part#L2
- Fixed `xkb_keymap_get_as_string` truncating the *4* longest keysyms names,
such as `Greek_upsilonaccentdieresis`.
- `xkb_keysym_to_utf8`: Require only 5 bytes for the buffer, as UTF-8 encodes
code points on up to 4 bytes + 1 byte for the NULL-terminating byte.
Previous standard [RFC 2279](https://datatracker.ietf.org/doc/html/rfc2279)
(1998) required up to 6 bytes per code point, but has been superseded by
[RFC 3629](https://datatracker.ietf.org/doc/html/rfc3629) (2003).
([#418](https://github.com/xkbcommon/libxkbcommon/issues/418))
- Registry: Fixed `libxml2` global error handler not reset after parsing, which
could trigger a crash if the corresponding `rxkb_context` has been freed.
Contributed by Sebastian Keller.
([#529](https://github.com/xkbcommon/libxkbcommon/issues/529))
- Rules: Fix handling of wild card `*` to match the behavior of `libxkbfile`.
Previously `*` would match any value, even empty one. Now:
- For `model` and `options`: *always* match.
- For `layout` and `variant`: match any *non-empty* value.
([#497](https://github.com/xkbcommon/libxkbcommon/issues/497))
- Fixed `LatchGroup` action with the `latchToLock` option disabled not applying
its latch effect multiple times.
([#577](https://github.com/xkbcommon/libxkbcommon/issues/577))
- Fixed incorrect handling of group indicators when `whichGroupState` is set with
`Base` or `Latched`.
([#579](https://github.com/xkbcommon/libxkbcommon/issues/579))
- Fixed missing explicit virtual modifier mappings when export the keymap as a string.
- Fixed the lower case mapping ẞ → ß (`U1E9E` → `ssharp`). This re-enable the
detection of alphabetic key types for the pair (ß, ẞ).
- Fixed modifiers not properly unset when multiple latches are used simultaneously.
([#583](https://github.com/xkbcommon/libxkbcommon/issues/583))
- The following functions now allow to query also *virtual* modifiers, so they work
with *any* modifiers (real *and* virtual):
- `xkb_state_mod_index_is_active`
- `xkb_state_mod_indices_are_active`
- `xkb_state_mod_name_is_active`
- `xkb_state_mod_names_are_active`
- `xkb_state_mod_index_is_consumed`
- `xkb_state_mod_index_is_consumed2`
- `xkb_state_mod_mask_remove_consumed`
Warning: they may overmatch in case there are overlappings virtual-to-real
modifiers mappings.
- X11: Do not drop a level when the keysym is undefined but not the action.
## Tools
### New
- Added `xkbcli dump-keymap-wayland` and `xkbcli dump-keymap-x11` debugging
tools to dump a keymap from a Wayland compositor or a X server, similar to
what `xkbcomp -xkb $DISPLAY -` does for X servers.
- `xkbcli compile-compose`: the Compose file may be passed as a positional
argument and `--file` is now deprecated. The file can also be piped to the
standard input by setting the path to `-`.
- `xkbcli compile-keymap`: Added `--keymap` as a more intuitive alias for
`--from-xkb`. Both now accept an optional keymap file argument. These flags
may be omitted; in this case the keymap file may be passed as a positional
argument.
- Added `--test` option to `compile-keymap` and `compile-compose`, to enable
testing compilation without printing the resulting file.
- `xkbcli how-to-type`: added new input formats and their corresponding documentation.
*Unicode code points* can be passed in the following formats:
- Literal character (requires UTF-8 character encoding of the terminal);
- Decimal number;
- Hexadecimal number: either `0xNNNN` or `U+NNNN`.
*Keysyms* can to be passed in the following formats:
- Decimal number;
- Hexadecimal number: `0xNNNN`;
- Name.
### Fixes
- Fixed various tools truncating the *4* longest keysyms names, such as
`Greek_upsilonaccentdieresis`.
- `xkbcli list`: Fix duplicate variants.
([#587](https://github.com/xkbcommon/libxkbcommon/issues/587))
## Build system
### Breaking changes
- Raised minimal meson version requirement to 0.58.
### Fixes
- Make the test of `-Wl,--version-script` more robust.
([#481](https://github.com/xkbcommon/libxkbcommon/issues/481))
libxkbcommon [1.7.0] - 2024-03-24
=================================
[1.7.0]: https://github.com/xkbcommon/libxkbcommon/tree/xkbcommon-1.7.0
API
---
### New
- Added early detection of invalid encodings and BOM for keymaps, rules & Compose.
Also added a hint that the expected encoding must be UTF-8 compatible.
### Fixes
- Updated keysyms using latest [xorgproto] (commit: `cd33097fc779f280925c6d6bbfbd5150f93ca5bc`):
For the sake of compatibility, this reintroduces some deleted keysyms and
postpones the effective deprecation of others, that landed in xkbcommon 1.6.0.
- Additions (reverted removal):
- `XKB_KEY_dead_lowline`
- `XKB_KEY_dead_aboveverticalline`
- `XKB_KEY_dead_belowverticalline`
- `XKB_KEY_dead_longsolidusoverlay`
- The following keysyms names remain deprecated, but are set again (i.e. as
before xkbcommon 1.6.0) as the reference names for their respective keysyms,
in order to ensure the transition to the newer names that replace them. This
affects functions such as `xkb_keymap_key_get_name` and `xkb_keymap_get_as_string`.
- `XKB_KEY_masculine`: is deprecated in favor of `XKB_KEY_ordmasculine`
- `XKB_KEY_guillemotleft`: is deprecated in favor of `XKB_KEY_guillemetleft`
- `XKB_KEY_guillemotright`: is deprecated in favor of `XKB_KEY_guillemetright`
- `XKB_KEY_dead_small_schwa`: is deprecated in favor of `XKB_KEY_dead_schwa`
- `XKB_KEY_dead_capital_schwa`: is deprecated in favor of `XKB_KEY_dead_SCHWA`
Relevant upstream merge requests: [xorgproto-83], [xorgproto-84].
[xorgproto-83]: https://gitlab.freedesktop.org/xorg/proto/xorgproto/-/merge_requests/83
[xorgproto-84]: https://gitlab.freedesktop.org/xorg/proto/xorgproto/-/merge_requests/84
- Keysyms: Fixed inconsistent results in `xkb_keysym_from_name` when used with
the flag `XKB_KEYSYM_CASE_INSENSITIVE`. In some rare cases it would return a
keysym with an upper-case name instead of the expected lower-case (e.g.
`XKB_KEY_dead_A` instead of `XKB_KEY_dead_a`).
- Keysyms: Fixed case mapping for 3 Latin 1 keysyms:
- `XKB_KEY_ydiaeresis`
- `XKB_KEY_mu`
- `XKB_KEY_ssharp`
- Keysyms: Fixed `xkb_keysym_is_modifier` to detect also the following keysyms:
- `XKB_KEY_ISO_Level5_Shift`
- `XKB_KEY_ISO_Level5_Latch`
- `XKB_KEY_ISO_Level5_Lock`
- Prevent recursive includes of keymap components.
- Fixed global default statements `x.y = z;` in wrong scope not raising an error.
Contributed by Mikhail Gusarov
- Keymap: Fixed empty symbols declaration.
Contributed by Yuichiro Hanada.
- Rules: Made newline required after `!include` line.
Contributed by Mikhail Gusarov.
- Rules: Fixed a bug where variant indexes were ignored with the layout index
used instead. They are practically always the same, but don't have to be.
Contributed by @wysiwys.
- Compose: Fixed a segfault with `xkb_compose_table_iterator_next` when used on an
empty table.
- Compose: Added check to ensure to open only regular files, not e.g. directories.
- Registry: Updated the DTD and always parse the “popularity” attribute.
- Fixed a few memory leaks and keymap symbols parsing.
Tools
-----
### New
- `xkbcli compile-compose`: added new CLI utility to test Compose files.
- `xkbcli interactive-evdev`: added `--verbose` option.
- `xkbcli interactive-x11`: added support for Compose.
- `xkbcli interactive-wayland`: added support for Compose.
### Fixes
- Bash completion: Fixed completion in some corner cases.
Build system
------------
- Fix building with clang when using `-Wl,--gc-sections`.
Contributed by ppw0.
- Fixed linking using `lld 1.17`.
Contributed by Baptiste Daroussin.
- Fix building X11 tests on macOS.
- Documentation is no longer built by default; it requires `-Denable-docs=true`.
libxkbcommon 1.6.0 - 2023-10-08
==================
API
---
### Breaking changes
- *Remove* keysyms that were intended for German T3 layout but are unused:
- `XKB_KEY_dead_lowline`
- `XKB_KEY_dead_aboveverticalline`
- `XKB_KEY_dead_belowverticalline`
- `XKB_KEY_dead_longsolidusoverlay`
See the upstream [`xorgproto` MR](https://gitlab.freedesktop.org/xorg/proto/xorgproto/-/merge_requests/70). See hereinafter for further changes related to keysyms.
### New
- Add Compose iterator API to iterate the entries in a compose table:
- `xkb_compose_table_entry_sequence`
- `xkb_compose_table_entry_keysym`
- `xkb_compose_table_entry_utf8`
- `xkb_compose_table_iterator_new`
- `xkb_compose_table_iterator_free`
- `xkb_compose_table_iterator_next`
- *Structured log messages* with a message registry. There is an *ongoing* work
to assign unique identifiers to log messages and add a corresponding error
index documentation page:
- The log entries are preceded with an identifier in the form `XKB-NNN`, where
`NNN` is a decimal number.
- The log entries can then be parsed with third-party tools, to check for
specific identifiers.
- The new documentation page “**Error index**” lists all the kind of error messages
with their identifiers. The aim is that each entry could present detailed
information on the error and how to fix it.
- Add a new warning for numeric keysyms references in XKB files: the preferred
keysym reference form is its name or its Unicode value, if relevant.
- Add the upper bound `XKB_KEYSYM_MAX` to check valid keysyms.
- Add a warning when loading a keymap using RMLVO with no layout but with the
variant set. The variant is actually discarded and both layout and variant are
set to default values, but this was done previously with no warning, confusing
end users.
- Add support for `modifier_map None { … }`. This feature is missing compared to
the X11 implementation. It allows to reset the modifier map of a key.
- Update keysyms using latest [xorgproto] (commit: `1c8128d72df22843a2022576850bc5ab5e3a46ea`):
- Additions:
- `XKB_KEY_ordmasculine` ([xorgproto-68])
- `XKB_KEY_guillemetleft` ([xorgproto-68])
- `XKB_KEY_guillemetright` ([xorgproto-68])
- `XKB_KEY_dead_schwa` ([xorgproto-78])
- `XKB_KEY_dead_SCHWA` ([xorgproto-78])
- `XKB_KEY_dead_hamza` ([xorgproto-71])
- `XKB_KEY_XF86EmojiPicker` ([xorgproto-44])
- `XKB_KEY_XF86Dictate` ([xorgproto-49])
- `XKB_KEY_XF86CameraAccessEnable` ([xorgproto-82])
- `XKB_KEY_XF86CameraAccessDisable` ([xorgproto-82])
- `XKB_KEY_XF86CameraAccessToggle` ([xorgproto-82])
- `XKB_KEY_XF86NextElement` ([xorgproto-82])
- `XKB_KEY_XF86PreviousElement` ([xorgproto-82])
- `XKB_KEY_XF86AutopilotEngageToggle` ([xorgproto-82])
- `XKB_KEY_XF86MarkWaypoint` ([xorgproto-82])
- `XKB_KEY_XF86Sos` ([xorgproto-82])
- `XKB_KEY_XF86NavChart` ([xorgproto-82])
- `XKB_KEY_XF86FishingChart` ([xorgproto-82])
- `XKB_KEY_XF86SingleRangeRadar` ([xorgproto-82])
- `XKB_KEY_XF86DualRangeRadar` ([xorgproto-82])
- `XKB_KEY_XF86RadarOverlay` ([xorgproto-82])
- `XKB_KEY_XF86TraditionalSonar` ([xorgproto-82])
- `XKB_KEY_XF86ClearvuSonar` ([xorgproto-82])
- `XKB_KEY_XF86SidevuSonar` ([xorgproto-82])
- `XKB_KEY_XF86NavInfo` ([xorgproto-82])
- Deprecations:
- `XKB_KEY_masculine`: use `XKB_KEY_ordmasculine` instead ([xorgproto-68])
- `XKB_KEY_guillemotleft`: use `XKB_KEY_guillemetleft` instead ([xorgproto-68])
- `XKB_KEY_guillemotright`: use `XKB_KEY_guillemetright` instead ([xorgproto-68])
- `XKB_KEY_dead_small_schwa`: use `XKB_KEY_dead_schwa` instead ([xorgproto-78])
- `XKB_KEY_dead_capital_schwa`: use `XKB_KEY_dead_SCHWA` instead ([xorgproto-78])
[xorgproto]: https://gitlab.freedesktop.org/xorg/proto/xorgproto
[xorgproto-44]: https://gitlab.freedesktop.org/xorg/proto/xorgproto/-/merge_requests/44
[xorgproto-49]: https://gitlab.freedesktop.org/xorg/proto/xorgproto/-/merge_requests/49
[xorgproto-68]: https://gitlab.freedesktop.org/xorg/proto/xorgproto/-/merge_requests/68
[xorgproto-71]: https://gitlab.freedesktop.org/xorg/proto/xorgproto/-/merge_requests/71
[xorgproto-78]: https://gitlab.freedesktop.org/xorg/proto/xorgproto/-/merge_requests/78
[xorgproto-82]: https://gitlab.freedesktop.org/xorg/proto/xorgproto/-/merge_requests/82
- Ongoing work to improve the documentation about XKB and its V1 format.
### Fixes
- Prevent `xkb_keysym_from_name` to parse out-of-range hexadecimal keysyms.
- Disallow producing NULL character with escape sequences `\0` and `\x0`.
- Prevent overflow of octal escape sequences by making `\400..\777` invalid.
- Prevent interpreting and emitting invalid Unicode encoding forms: surrogates
are invalid in both UTF-32 and UTF-8.
- `xkb_keymap_new_from_buffer`: Allow for a NULL-terminated keymap string.
- Compose: Increase the limit of possible entries to handle huge Compose files.
Contributed by alois31.
Tools
-----
### New
- Add bash completions for `xkbcli` and its subcommands.
- `xkbcli interactive-*`: Add options `--short` to hide some fields.
- `xkbcli interactive-evdev`: Add `--includes` and `--include-defaults` options.
- Add `xkb-check-messages` *experimental* tool (not installed).
It checks whether given log messages identifiers are supported.
### Fixes
- `xkbcli compile-keymap`: Allow to use without arguments.
- `xkbcli interactive-*`: Always print keycode.
- `xkbcli interactive-*`: Escape control characters for Unicode output, instead of
printing them as-is, messing the output.
Build system
------------
- Bump required meson to 0.52.0.
- Allow `xkbcommon` to be used as a subproject.
Contributed by Simon Ser.
- Improve Windows compilation.
libxkbcommon 1.5.0 - 2023-01-02
==================
- Add `xkb_context` flag `XKB_CONTEXT_NO_SECURE_GETENV` and `rxkb_context` flag
`RXKB_CONTEXT_NO_SECURE_GETENV`.
xkbcommon uses `getenv_secure()` to obtain environment variables. This flag
makes xkbcommon use `getenv()` instead.
This is useful for some clients that have relatively benign capabilities set,
like CAP_SYS_NICE, that also want to use e.g. the XKB configuration from the
environment and user configs in XDG_CONFIG_HOME.
Contributed by Ronan Pigott.
- Fix crash in `xkbcli interactive-wayland` under a compositor which supports
new versions of the xdg-shell protocol.
Contributed by Jan Alexander Steffens (heftig).
- Fix some MSVC build issues.
- Fix some issues when including xkbcommon as a meson subproject.
- meson>=0.51 is now required.
- New API:
XKB_CONTEXT_NO_SECURE_GETENV
RXKB_CONTEXT_NO_SECURE_GETENV
libxkbcommon 1.4.1 - 2022-05-21
==================
- Fix compose sequence overriding (common prefix) not working correctly.
Regressed in 1.2.0.
Contributed by Weng Xuetian.
- Remove various bogus currency sign (particulary Euro and Korean Won) entries
from the keysym <-> Unicode mappings. They prevented the real
keysyms/codepoints for these from mapping correctly.
Contributed by Sam Lantinga and Simon Ser.
libxkbcommon 1.4.0 - 2022-02-04
==================
- Add `enable-tools` option to Meson build (on by default) to allow disabling
the `xkbcli` tools.
Contributed by Alex Xu (Hello71).
- In `xkbcli list`, fix "YAML Norway problem" in output.
Contributed by Peter Hutterer.
- In libxkbregistry, variants now inherit iso639, iso3166 and brief from parent
layout if omitted.
Contributed by M Hickford.
- In libxkbregistry, don't call `xmlCleanupParser()` - it's not supposed to
be called by libraries.
Contributed by Peter Hutterer.
- In libxkbregistry, skip over invalid ISO-639 or ISO-3166 entries.
Contributed by Peter Hutterer.
libxkbcommon 1.3.1 - 2021-09-10
==================
- In `xkbcli interactive-x11`, use the Esc keysym instead of the Esc keycode
for quitting.
Contributed by Simon Ser.
- In `xkbcli how-to-type`, add `--keysym` argugment for how to type a keysym
instead of a Unicode codepoint.
- Fix a crash in `xkb_x11_keymap_new_from_device` error handling given some
invalid keymaps. Regressed in 1.2.0.
Reported by Zack Weinberg. Tested by Uli Schlachter.
libxkbcommon 1.3.0 - 2021-05-01
==================
- Change `xkbcli list` to output YAML, instead of the previous ad-hoc format.
This allows to more easily process the information in a programmetic way, for
example
xkbcli list | yq -r ".layouts[].layout"
Contributed by Peter Hutterer.
- Optimize a certain part of keymap compilation (atom interning).
- Fix segmentation fault in case-insensitive `xkb_keysym_from_name` for certain
values like the empty string.
Contributed by Isaac Freund.
- Support building libxkbcommon as a meson subproject.
Contributed by Adrian Perez de Castro.
- Add `ftruncate` fallback for `posix_fallocate` in `xkbcli interactive-wayland`
for FreeBSD.
Contributed by Evgeniy Khramtsov.
- Properly export library symbols in MSVC.
Contributed by Adrian Perez de Castro.
libxkbcommon 1.2.1 - 2021-04-07
==================
- Fix `xkb_x11_keymap_new_from_device()` failing when the keymap contains key
types with missing level names, like the one used by the `numpad:mac` option
in xkeyboard-config. Regressed in 1.2.0.
libxkbcommon 1.2.0 - 2021-04-03
==================
- `xkb_x11_keymap_new_from_device()` is much faster. It now performs only 2
roundtrips to the X server, instead of dozens (in first-time calls).
Contributed by Uli Schlachter.
- Case-sensitive `xkb_keysym_from_name()` is much faster.
- Keysym names of the form `0x12AB` and `U12AB` are parsed more strictly.
Previously the hexadecimal part was parsed with `strtoul()`, now only up
to 8 hexadecimal digits (0-9A-Fa-f) are allowed.
- Compose files now have a size limit (65535 internal nodes). Further sequences
are discared and a warning is issued.
- Compose table loading (`xkb_compose_table_new_from_locale()` and similar) is
much faster.
- Use `poll()` instead of `epoll()` for `xlbcli interactive-evdev`, making it
portable to FreeBSD which provides evdev but not epoll. On FreeBSD, remember
to install the `evdev-proto` package to get the evdev headers.
- The build now requires a C11 compiler (uses anonymous structs/unions).
libxkbcommon 1.1.0 - 2021-02-27
==================
- Publish the `xkb-format-text-v1.md` file in the HTML documentation. This file
existed for a long time but only in the Git repository.
Link: https://xkbcommon.org/doc/current/md_doc_keymap_format_text_v1.html
- Add partial documentation for xkb_symbols to xkb-format-text-v1.md.
Contributed by Simon Zeni.
- Update keysym definitions to latest xorgproto. In particular, this adds many
special keysyms corresponding to Linux evdev keycodes.
Contributed by Peter Hutterer <@who-t.net>.
- New API:
Too many XKB_KEY_* definitions to list here.
libxkbcommon 1.0.3 - 2020-11-23
==================
- Fix (hopefully) a segfault in xkb_x11_keymap_new_from_device() in some
unclear situation (bug introduced in 1.0.2).
- Fix keymaps created with xkb_x11_keymap_new_from_device() don't have level
names (bug introduced in 0.8.0).
libxkbcommon 1.0.2 - 2020-11-20
==================
- Fix a bug where a keysym that cannot be resolved in a keymap gets compiled to
a garbage keysym. Now it is set to XKB_KEY_NoSymbol instead.
- Improve the speed of xkb_x11_keymap_new_from_device() on repeated calls in the
same xkb_context().
libxkbcommon 1.0.1 - 2020-09-11
==================
- Fix the tool-option-parsing test failing.
- Remove requirement for pytest in the tool-option-parsing test.
- Make the table output of `xkbcli how-to-type` aligned.
- Some portability and test isolation fixes.
libxkbcommon 1.0.0 - 2020-09-05
==================
Note: this release is API and ABI compatible with previous releases -- the
major version bump is only an indication of stability.
- Add libxkbregistry as configure-time optional library. libxkbregistry is a C
library that lists available XKB models, layouts and variants for a given
ruleset. This is a separate library (libxkbregistry.so, pkgconfig file
xkbregistry.pc) and aimed at tools that provide a listing of available
keyboard layouts to the user. See the Documentation for details on the API.
Contributed by Peter Hutterer <@who-t.net>.
- Better support custom user configuration:
* Allow including XKB files from other paths.
Previously, a 'symbols/us' file in path A would shadow the same file in
path B. This is suboptimal, we rarely need to hide the system files - we
care mostly about *extending* them. By continuing to check other lookup
paths, we make it possible for a XDG_CONFIG_HOME/xkb/symbols/us file to
have sections including those from /usr/share/X11/xkb/symbols/us.
Note that this is not possible for rules files, which need to be manually
controlled to get the right bits resolved.
* Add /etc/xkb as extra lookup path for system data files.
This completes the usual triplet of configuration locations available for
most processes:
- vendor-provided data files in /usr/share/X11/xkb
- system-specific data files in /etc/xkb
- user-specific data files in $XDG_CONFIG_HOME/xkb
The default lookup order user, system, vendor, just like everything else
that uses these conventions.
For include directives in rules files, the '%E' resolves to that path.
* Add a new section to the documentation for custom user configuration.
Contributed by Peter Hutterer <@who-t.net>.
- Add an `xkbcli` command-line utility.
This tool offers various subcommands for introspection and debugging.
Currently the available subcommands are:
list
List available rules, models, layouts, variants and options
interactive-wayland
Interactive debugger for XKB keymaps for Wayland
interactive-x11
Interactive debugger for XKB keymaps for X11
interactive-evdev
Interactive debugger for XKB keymaps for evdev (Linux)
compile-keymap
Compile an XKB keymap
how-to-type
See separate entry below.
See the manpages for usage information.
Contributed by Peter Hutterer <@who-t.net>.
- Add `xkb_utf32_to_keysym()` to translate a Unicode codepoint to a keysym.
When a special keysym (`XKB_KEY_` constant) for the codepoint exists, it is
returned, otherwise the direct encoding is used, if permissible.
Contributed by Jaroslaw Kubik <@froglogic.com>.
- Add `xkb_keymap_key_get_mods_for_level()` which retrieves sets of modifiers
which produce a given shift level in a given key+layout.
Contributed by Jaroslaw Kubik <@froglogic.com>.
- Add `xkbcli how-to-type` command, which, using `xkb_utf32_to_keysym()`
and `xkb_keymap_key_get_mods_for_level()` and other APIs, prints out all
the ways to produce a given keysym.
For example, how to type `?` (codepoint 63) in a us,de keymap?
$ xkbcli how-to-type --layout us,de 63 | column -ts $'\t'
keysym: question (0x3f)
KEYCODE KEY NAME LAYOUT# LAYOUT NAME LEVEL# MODIFIERS
20 AE11 2 German 2 [ Shift ]
20 AE11 2 German 2 [ Shift Lock ]
61 AB10 1 English (US) 2 [ Shift ]
- Add a new section to the documentation describing the format of the XKB
rules file.
- Search for Compose in $XDG_CONFIG_HOME/XCompose (fallback to
~/.config/XCompose) before trying $HOME/.XCompose.
Note that libX11 still only searches in $HOME/.XCompose.
Contributed by Emmanuel Gil Peyrot <@linkmauve.fr>.
- Bump meson requirement to >= 0.49.0.
- Fix build with byacc.
- Fix building X11 tests on PE targets.
Contributed by Jon Turney <@dronecode.org.uk>
- The tests no longer rely on bash, only Python (which is already used by
meson).
- New API:
xkb_utf32_to_keysym
xkb_keymap_key_get_mods_for_level
XKB_KEY_XF86FullScreen
libxkbcommon 0.10.0 - 2020-01-18
===================
- (security) Fix quadratic complexity in the XKB file parser. See commit
message 7c42945e04a2107827a057245298dedc0475cc88 for details.
- Add $XDG_CONFIG_HOME/xkb to the default search path. If $XDG_CONFIG_HOME
is not set, $HOME/.config/xkb is used. If $HOME is not set, the path is not
added.
The XDG path is looked up before the existing default search path $HOME/.xkb.
Contributed by Peter Hutterer <@who-t.net>.
- Add support for include statements in XKB rules files.
This is a step towards making local XKB customizations more tenable and
convenient, without modifying system files.
You can now include other rules files like this:
! include %S/evdev
Two directives are supported, %H to $HOME and %S for the system-installed
rules directory (usually /usr/share/X11/xkb/rules).
See commit message ca033a29d2ca910fd17b1ae287cb420205bdddc8 and
doc/rules-format.txt in the xkbcommon source code for more information.
Contributed by Peter Hutterer <@who-t.net>.
- Downgrade "Symbol added to modifier map for multiple modifiers" log to a
warning.
This error message was too annoying to be shown by default. When working on
keymaps, set `XKB_LOG_LEVEL=debug XKB_LOG_VERBOSITY=10` to see all possible
messages.
- Support building on Windows using the meson MSVC backend.
Contributed by Adrian Perez de Castro <@igalia.com>.
- Fix bug where the merge mode only applied to the first vmod in a
`virtual_modifiers` statement. Given
augment virtual_modifiers NumLock,Alt,LevelThree
Previously it was incorrectly treated as
augment virtual_modifiers NumLock;
virtual_modifiers Alt;
virtual_modifiers LevelThree;
Now it is treated as
augment virtual_modifiers NumLock;
augment virtual_modifiers Alt;
augment virtual_modifiers LevelThree;
- Reject interpret modifier predicate with more than one value. Given
interpret ISO_Level3_Shift+AnyOf(all,extraneous) { ... };
Previously, extraneous (and further) was ignored. Now it's rejected.
- Correctly handle capitalization of the ssharp keysym.
- Speed up and improve the internal `xkeyboard-config` tool. This tool
compiles all layout/variant combinations in the xkeyboard-config dataset
and reports any issues it finds.
Contributed by Peter Hutterer <@who-t.net>.
- Speed up "atoms" (string interning). This code goes back at least to X11R1
(released 1987).
libxkbcommon 0.9.1 - 2019-10-19
==================
- Fix context creation failing when run in privileged processes as defined by
`secure_getenv(3)`, e.g. GDM.
libxkbcommon 0.9.0 - 2019-10-19
==================
- Move ~/.xkb to before XKB_CONFIG_ROOT (the system XKB path, usually
/usr/share/X11/xkb) in the default include path. This enables the user
to have full control of the keymap definitions, instead of only augmenting
them.
- Remove the Autotools build system. Use the meson build system instead.
- Fix invalid names used for levels above 8 when dumping keymaps. Previously,
e.g. "Level20" was dumped, but only up to "Level8" is accepted by the
parser. Now "20" is dumped.
- Change level references to always be dumped as e.g. "5" instead of "Level5".
Change group references to always be dumped capitalized e.g. "Group3" instead
of "group3". Previously it was inconsistent.
These changes affect the output of xkb_keymap_get_as_string().
- Fix several build issues on macOS/Darwin, Solaris, NetBSD, cross compilation.
- Port the interactive-wayland test program to the stable version of xdg-shell.
libxkbcommon 0.8.4 - 2019-02-22
==================
- Fix build of xkbcommon-x11 static library with meson.
- Fix building using meson from the tarball generated by autotools.
libxkbcommon 0.8.3 - 2019-02-08
==================
- Fix build of static libraries with meson.
(Future note: xkbcommon-x11 was *not* fixed in this release.)
- New API:
XKB_KEY_XF86MonBrightnessCycle
XKB_KEY_XF86RotationLockToggle
libxkbcommon 0.8.2 - 2018-08-05
==================
- Fix various problems found with fuzzing (see commit messages for
more details):
- Fix a few NULL-dereferences, out-of-bounds access and undefined behavior
in the XKB text format parser.
libxkbcommon 0.8.1 - 2018-08-03
==================
- Fix various problems found in the meson build (see commit messages for more
details):
- Fix compilation on Darwin.
- Fix compilation of the x11 tests and demos when XCB is installed in a
non-standard location.
- Fix xkbcommon-x11.pc missing the Requires specification.
- Fix various problems found with fuzzing and Coverity (see commit messages for
more details):
- Fix stack overflow in the XKB text format parser when evaluating boolean
negation.
- Fix NULL-dereferences in the XKB text format parser when some unsupported
tokens appear (the tokens are still parsed for backward compatibility).
- Fix NULL-dereference in the XKB text format parser when parsing an
xkb_geometry section.
- Fix an infinite loop in the Compose text format parser on some inputs.
- Fix an invalid free() when using multiple keysyms.
- Replace the Unicode characters for the leftanglebracket and rightanglebracket
keysyms from the deprecated LEFT/RIGHT-POINTING ANGLE BRACKET to
MATHEMATICAL LEFT/RIGHT ANGLE BRACKET.
- Reject out-of-range Unicode codepoints in xkb_keysym_to_utf8 and
xkb_keysym_to_utf32.
libxkbcommon 0.8.0 - 2017-12-15
==================
- Added xkb_keysym_to_{upper,lower} to perform case-conversion directly on
keysyms. This is useful in some odd cases, but working with the Unicode
representations should be preferred when possible.
- Added Unicode conversion rules for the signifblank and permille keysyms.
- Fixed a bug in the parsing of XKB key type definitions where the number
of levels were determined by the number of level *names*. Keymaps which
omit level names were hence miscompiled.
This regressed in version 0.4.3. Keymaps from xkeyboard-config were not
affected since they don't omit level names.
- New API:
xkb_keysym_to_upper()
xkb_keysym_to_lower()
libxkbcommon 0.7.2 - 2017-08-04
==================
- Added a Meson build system as an alternative to existing autotools build
system.
The intent is to remove the autotools build in one of the next releases.
Please try to convert to it and report any problems.
See http://mesonbuild.com/Quick-guide.html for basic usage, the
meson_options.txt for the project-specific configuration options,
and the PACKAGING file for more details.
There are some noteworthy differences compared to the autotools build:
- Feature auto-detection is not performed. By default, all features are
enabled (currently: docs, x11, wayland). The build fails if any of
the required dependencies are not available. To disable a feature,
pass -Denable-<feature>=false to meson.
- The libraries are either installed as shared or static, as specified
by the -Ddefault_library=shared/static option. With autotools, both
versions are installed by default.
- xorg-util-macros is not used.
- A parser generator (bison/byacc) is always required - there is no
fallback to pre-generated output bundled in the tarball, as there is
in autotools.
- Removed Android.mk support.
- Removed the *-uninstalled.pc pkgconfig files.
- Ported the interactive-wayland demo program to v6 of the xdg-shell
protocol.
- Added new keysym definitions from xproto.
- New API:
XKB_KEY_XF86Keyboard
XKB_KEY_XF86WWAN
XKB_KEY_XF86RFKill
XKB_KEY_XF86AudioPreset
libxkbcommon 0.7.1 - 2017-01-18
==================
- Fixed various reported problems when the current locale is tr_TR.UTF-8.
The function xkb_keysym_from_name() used to perform case-insensitive
string comparisons in a locale-dependent way, but required it to to
work as in the C/ASCII locale (the so called "Turkish i problem").
The function is now no longer affected by the current locale.
- Fixed compilation in NetBSD.
libxkbcommon 0.7.0 - 2016-11-11
==================
- Added support for different "modes" of calculating consumed modifiers.
The existing mode, based on the XKB standard, has proven to be
unintuitive in various shortcut implementations.
A new mode, based on the calculation used by the GTK toolkit, is added.
This mode is less eager to declare a modifier as consumed.
- Added a new interactive demo program using the Wayland protocol.
See the PACKAGING file for the new (optional) test dependencies.
- Fixed a compilation error on GNU Hurd.
- New API:
enum xkb_consumed_mode
XKB_CONSUMED_MODE_XKB
XKB_CONSUMED_MODE_GTK
xkb_state_key_get_consumed_mods2
xkb_state_mod_index_is_consumed2
libxkbcommon 0.6.1 - 2016-04-08
==================
- Added LICENSE to distributed files in tarball releases.
- Minor typo fix in xkb_keymap_get_as_string() documentation.
libxkbcommon 0.6.0 - 2016-03-16
==================
- If the XKB_CONFIG_ROOT environment variable is set, it is used as the XKB
configuration root instead of the path determined at build time.
- Tests and benchmarks now build correctly on OSX.
- An XKB keymap provides a name for each key it defines. Traditionally,
these names are limited to at most 4 characters, and are thus somewhat
obscure, but might still be useful (xkbcommon lifts the 4 character limit).
The new functions xkb_keymap_key_get_name() and xkb_keymap_key_by_name()
can be used to get the name of a key or find a key by name. Note that
a key may have aliases.
- Documentation improvements.
- New API:
xkb_keymap_key_by_name()
xkb_keymap_key_get_name()
libxkbcommon 0.5.0 - 2014-10-18
==================
- Added support for Compose/dead keys in a new module (included in
libxkbcommon). See the documentation or the
xkbcommon/xkbcommon-compose.h header file for more details.
- Improved and reordered some sections of the documentation.
- The doxygen HTML pages were made nicer to read.
- Most tests now run also on non-linux platforms.
- A warning is emitted by default about RMLVO values which are not used
during keymap compilation, which are most often a user misconfiguration.
For example, "terminate:ctrl_alt_backspace" instead of
"terminate:ctrl_alt_bksp".
- Added symbol versioning for libxkbcommon and libxkbcommon-x11.
Note: binaries compiled against this and future versions will not be
able to link against the previous versions of the library.
- Removed several compatablity symbols from the binary (the API isn't
affected). This affects binaries which
1. Were compiled against a pre-stable (<0.2.0) version of libxkbcommon, and
2. Are linked against the this or later version of libxkbcommon.
Such a scenario is likely to fail already.
- If Xvfb is not available, the x11comp test is now correctly skipped
instead of hanging.
- Benchmarks were moved to a separate bench/ directory.
- Build fixes from OpenBSD.
- Fixed a bug where key type entries such as "map[None] = Level2;" were
ignored.
- New API:
XKB_COMPOSE_*
xkb_compose_*
libxkbcommon 0.4.3 - 2014-08-19
==================
- Fixed a bug which caused xkb_x11_keymap_new_from_device() to misrepresent
modifiers for some keymaps.
https://github.com/xkbcommon/libxkbcommon/issues/9
- Fixed a bug which caused xkb_x11_keymap_new_from_device() to ignore XKB
PrivateAction's.
- Modifiers are now always fully resolved after xkb_state_update_mask().
Previously the given state components were used as-is, without
considering virtual modifier mappings.
Note: this only affects non-standard uses of xkb_state_update_mask().
- Added a test for xkbcommon-x11, "x11comp". The test uses the system's
Xvfb server and xkbcomp. If they do not exist or fail, the test is
skipped.
- Fixed memory leaks after parse errors in the XKB yacc parser.
The fix required changes which are currently incompatible with byacc.
libxkbcommon 0.4.2 - 2014-05-15
==================
- Fixed a bug where explicitly passing "--enable-x11" to ./configure would
in fact disable it (regressed in 0.4.1).
- Added @since version annotations to the API documentation for everything
introduced after the initial stable release (0.2.0).
- Added a section to the documentation about keysym transformations, and
clarified which functions perform a given transformation.
- XKB files which fail to compile during keymap construction can no longer
have any effect on the resulting keymap: changes are only applied when
the entire compilation succeeds.
Note: this was a minor correctness issue inherited from xkbcomp.
- Fix an out-of-bounds array access in src/x11/util.c:adopt_atoms()
error-handling code.
Note: it seems impossible to trigger in the current code since the input
size cannot exceed the required size.
libxkbcommon 0.4.1 - 2014-03-27
==================
- Converted README to markdown and added a Quick Guide to the
documentation, which breezes through the most common parts of
xkbcommon.
- Added two new functions, xkb_state_key_get_utf{8,32}(). They
combine the operations of xkb_state_key_get_syms() and
xkb_keysym_to_utf{8,32}(), and provide a nicer interface for it
(espcially for multiple-keysyms-per-level).
- The xkb_state_key_get_utf{8,32}() functions now apply Control
transformation: when the Control modifier is active, the string
is converted to an appropriate control character.
This matches the behavior of libX11's XLookupString(3), and
required by the XKB specification:
https://www.x.org/releases/current/doc/kbproto/xkbproto.html#Interpreting_the_Control_Modifier
https://bugs.freedesktop.org/show_bug.cgi?id=75892
- The consumed modifiers for a key are now calculated similarly
to libX11. The previous behavior caused a bug where Shift would
not cancel an active Caps Lock.
- Make xkbcommon-x11 work with the keymap reported by the XQuartz
X server.
https://bugs.freedesktop.org/show_bug.cgi?id=75798
- Reduce memory usage during keymap compilation some more.
- New API:
xkb_state_key_get_consumed_mods()
xkb_state_key_get_utf8()
xkb_state_key_get_utf32()
- Deprecated API:
XKB_MAP_COMPILE_PLACEHOLDER, XKB_MAP_NO_FLAGS
use XKB_KEYMAP_NO_FLAGS instead.
- Bug fixes.
libxkbcommon 0.4.0 - 2014-02-02
==================
- Add a new add-on library, xkbcommon-x11, to support creating keymaps
with the XKB X11 protocol, by querying the X server directly.
See the xkbcommon/xkbcommon-x11.h header file for more details.
This library requires libxcb-xkb >= 1.10, and is enabled by default.
It can be disabled with the --disable-x11 configure switch.
Distributions are encouraged to split the necessary files for this
library (libxkbcommon-x11.so, xkbcommon-x11.pc, xkbcommon/xkbcommon-x11.h)
to a separate package, such that the main package does not depend on
X11 libraries.
- Fix the keysym <-> name lookup table to not require huge amounts of
relocations.
- Fix a bug in the keysym <-> name lookup, whereby lookup might fail in
some rare cases.
- Reduce memory usage during keymap compilation.
- New API:
New keysyms from xproto 7.0.25 (German T3 layout keysyms).
XKB_MOD_NAME_NUM for the usual NumLock modifier.
xkb_x11_* types and functions, XKB_X11_* constants.
libxkbcommon 0.3.2 - 2013-11-22
==================
- Log messages from the library now look like "xkbcommon: ERROR" by
default, instead of xkbcomp-like "Error: ".
- Apply capitalization transformation on keysyms in
xkb_keysym_get_one_sym(), to match the behavior specified in the XKB
specification:
https://www.x.org/releases/current/doc/kbproto/xkbproto.html#Interpreting_the_Lock_Modifier
- Support byacc for generating the parser, in addition to Bison.
- New API:
XKB_KEY_XF86AudioMicMute keysym from xproto 7.0.24.
XKB_KEYSYM_NO_FLAGS
XKB_CONTEXT_NO_FLAGS
XKB_MAP_COMPILE_NO_FLAGS
- Bug fixes.
libxkbcommon 0.3.1 - 2013-06-03
==================
- Replace the flex scanner with a hand-written one. flex is no longer
a build requirement.
- New API:
xkb_keymap_min_keycode()
xkb_keymap_max_keycode()
xkb_keymap_key_for_each()
libxkbcommon 0.3.0 - 2013-04-01
==================
- Allow passing NULL to *_unref() functions; do nothing instead of
crashing.
- The functions xkb_keymap_num_levels_for_key() and
xkb_keymap_get_syms_by_level() now allow out-of-range values for the
'layout' parameter. The functions now wrap the value around the number
of layouts instead of failing.
- The function xkb_keysym_get_name() now types unicode keysyms in
uppercase and 0-padding, to match the format used by XKeysymToString().
- Building Linux-specific tests is no longer attempted on non-Linux
environments.
- The function xkb_keymap_new_from_names() now accepts a NULL value for
the 'names' parameter, instead of failing. This is equivalent to passing
a 'struct xkb_rule_names' with all fields set to NULL.
- New API:
xkb_keymap_new_from_buffer()
- Bug fixes.