libxkbcommon [1.12.0] – 2025-10-10 ================================== The highlight of this release is the performance improvements for keymap handling: - about 1.6× speedup at *serializing* with default options; - about 1.7× speedup at *parsing* keymaps serialized by libxkbcommon, otherwise at least 1.1×. [1.12.0]: https://github.com/xkbcommon/libxkbcommon/tree/xkbcommon-1.12.0 ## API ### Breaking changes - `xkb_keymap::xkb_keymap_get_as_string()` does not pretty-print the keymap anymore. Use `xkb_keymap::xkb_keymap_get_as_string2()` with `::XKB_KEYMAP_SERIALIZE_PRETTY` to get the previous behavior. ([#640](xkbcommon/libxkbcommon#640)) - `xkb_keymap::xkb_keymap_get_as_string()` does not serialize *unused* types and compatibility entries anymore. Use `xkb_keymap::xkb_keymap_get_as_string2()` with `::XKB_KEYMAP_SERIALIZE_KEEP_UNUSED` to get the previous behavior. ([#769](xkbcommon/libxkbcommon#769)) - Updated keysyms case mappings to cover full <strong>[Unicode 17.0]</strong>. [Unicode 17.0]: https://www.unicode.org/versions/Unicode17.0.0/ ### Deprecated - Deprecated keysyms from latest [xorgproto] \(commit: `81931cc0fd4761b42603f7da7d4f50fc282cecc6`, [xorproto-103]): - `XKB_KEY_XF86BrightnessAuto` (use `XKB_KEY_XF86MonBrightnessAuto` instead) [xorproto-103]: https://gitlab.freedesktop.org/xorg/proto/xorgproto/-/merge_requests/103 ### New - Added `xkb_keymap::xkb_keymap_get_as_string2()`, which enables to configure the serialization. - Added keysyms from latest [xorgproto] \(commit: `81931cc0fd4761b42603f7da7d4f50fc282cecc6`, [xorproto-103]): - `XKB_KEY_XF86Sport` - `XKB_KEY_XF86MonBrightnessAuto` (alias for `XKB_KEY_XF86BrightnessAuto`) - `XKB_KEY_XF86LinkPhone` - `XKB_KEY_XF86Fn_F1` - `XKB_KEY_XF86Fn_F2` - `XKB_KEY_XF86Fn_F3` - `XKB_KEY_XF86Fn_F4` - `XKB_KEY_XF86Fn_F5` - `XKB_KEY_XF86Fn_F6` - `XKB_KEY_XF86Fn_F7` - `XKB_KEY_XF86Fn_F8` - `XKB_KEY_XF86Fn_F9` - `XKB_KEY_XF86Fn_F10` - `XKB_KEY_XF86Fn_F11` - `XKB_KEY_XF86Fn_F12` - `XKB_KEY_XF86Fn_1` - `XKB_KEY_XF86Fn_2` - `XKB_KEY_XF86Fn_D` - `XKB_KEY_XF86Fn_E` - `XKB_KEY_XF86Fn_F` - `XKB_KEY_XF86Fn_S` - `XKB_KEY_XF86Fn_B` - `XKB_KEY_XF86PerformanceMode` - Enable to parse the full range of keycodes `0 .. 0xfffffffe`, which was previously limited to `0 .. 0xfff`. ([#849](xkbcommon/libxkbcommon#849)) - Compose: Custom locales now fallback to `en_US.UTF-8`. Custom locales requiring a dedicated Compose file are not yet supported. The workaround is to use the various ways to [specify a user Compose file]. [specify a user Compose file]: @ref xkb_compose_table::xkb_compose_table_new_from_locale() ## Tools ### New - `xkbcli {compile-keymap,dump-keymap*}`: Added `--no-pretty` to disable pretty-printing in keymap serialization. ([#640](xkbcommon/libxkbcommon#640)) - `xkbcli {compile-keymap,dump-keymap*}`: Added `--keep-unused` to not discard unused bit for keymap serialization. ([#769](xkbcommon/libxkbcommon#769)) - `xkbcli-compile-keymap`: Added `--kccgst-yaml` to output KcCGST components in YAML format. ## Build system ### Breaking changes - The *default* XKB root directory is now set from the *most recent* [xkeyboard-config](https://gitlab.freedesktop.org/xkeyboard-config/xkeyboard-config) installed package, in case [multiple versions](https://xkeyboard-config.freedesktop.org/doc/versioning/) are installed in parallel. If no such package is found, it fallbacks to the historical X11 directory, as previously. libxkbcommon [1.11.0] – 2025-08-08 ================================== The highlight of this release is the introduction of a new keymap text format, `::XKB_KEYMAP_FORMAT_TEXT_V2`, in order to fix decade-old issues inherited from the X11 ecosystem. See the API section for documentation of its use. [1.11.0]: https://github.com/xkbcommon/libxkbcommon/tree/xkbcommon-1.11.0 ## Keymap text format ### New A new keymap text format **v2** has been introduced as a superset of the legacy **v1** format. The format is not yet frozen and considered a living standard, although future iterations should be backward-compatible. See the [compatibility page] for detailed information of the features of each format. - Added the new parameter `lockOnRelease` for the key action `LockGroup()` ([#420](xkbcommon/libxkbcommon#420)). It enables to use e.g. the combination `Alt + Shift` *alone* to switch layouts, while keeping the use of `Alt + Shift + other key` (typically for keyboard shortcuts). It enables to fix a [20-year old issue][xserver-258] inherited from the X11 ecosystem, by extending the [XKB protocol key actions]. As it is incompatible with X11, this feature is available only using `::XKB_KEYMAP_FORMAT_TEXT_V2`. - Added the new parameter `unlockOnPress` for the key modifier action `SetMods()`, `LatchMods()` and `LockMods()` ([#372](xkbcommon/libxkbcommon#372) and [#780](xkbcommon/libxkbcommon#780)). It enables e.g. to deactivate `CapsLock` *on press* rather than on release, as in other platforms such as Windows. It enables to fix the following two issues inherited from the X11 ecosystem, by extending the [XKB protocol key actions]: - a [18-year old issue][xkeyboard-config-74]; - a [12-year old issue][xserver-312]. As it is incompatible with X11, this feature is available only using `::XKB_KEYMAP_FORMAT_TEXT_V2`. - Added the new parameter `latchOnPress` for the key action `LatchMods()`. Some keyboard layouts use `ISO_Level3_Latch` or `ISO_Level5_Latch` to define “built-in” dead keys. `latchOnPress` enables to behave as usual dead keys, i.e. to latch on press and to deactivate as soon as another (non-modifier) key is pressed. As it is incompatible with X11, this feature is available only using `::XKB_KEYMAP_FORMAT_TEXT_V2`. - Raised the layout count limit from 4 to 32. Requires using `::XKB_KEYMAP_FORMAT_TEXT_V2`. ([#37](xkbcommon/libxkbcommon#37)) It enables to fix a [16-year old issue][xserver-262] inherited from the X11 ecosystem. - Virtual modifiers are now mapped to their <em>[canonical encoding]</em> if they are not mapped *explicitly* (`virtual_modifiers M = …`) nor *implicitly* (using `modifier_map`/`virtualModifier`). This feature is enabled only when using `::XKB_KEYMAP_FORMAT_TEXT_V2`, as it may result in encodings not compatible with X11. - Added support for the constants `Level<INDEX>` for *any* valid level index, instead of the previous limited range `Level1`..`Level8`. - Enable to use absolute paths and `%`-expansion variables for including *keymap components*, in the same fashion than the *rules* files. [compatibility page]: https://xkbcommon.org/doc/current/xkbcommon-compatibility.html [XKB protocol key actions]: https://www.x.org/releases/current/doc/kbproto/xkbproto.html#Key_Actions [xkeyboard-config-74]: https://gitlab.freedesktop.org/xkeyboard-config/xkeyboard-config/-/issues/74 [xserver-258]: https://gitlab.freedesktop.org/xorg/xserver/-/issues/258 [xserver-262]: https://gitlab.freedesktop.org/xorg/xserver/-/issues/262 [xserver-312]: https://gitlab.freedesktop.org/xorg/xserver/-/issues/312 [canonical encoding]: https://xkbcommon.org/doc/current/keymap-text-format-v1-v2.html#canonical-and-non-canonical-modifiers ## Rules text format ### New - Added support for *layout-specific options*. It enables specifying a layout index for each option by appending `!` + 1-indexed layout, so that it applies only if the layout matches. ([#500](xkbcommon/libxkbcommon#500)) ## API ### Breaking changes - `xkb_keymap_new_from_names()` now uses the new keymap format `::XKB_KEYMAP_FORMAT_TEXT_V2`. - When using `::XKB_KEYMAP_FORMAT_TEXT_V1`, multiple actions per level are now serialized using `VoidAction()`, in order to maintain compatibility with X11. ([#793](xkbcommon/libxkbcommon#793)) ### Deprecated - `xkb_keymap_new_from_names()` is now deprecated; please use `xkb_keymap_new_from_names2()` instead with an explicit keymap format. ### New - Added the new keymap format `::XKB_KEYMAP_FORMAT_TEXT_V2`, which enables libxkbcommon’s extensions incompatible with X11. Note that *fallback* mechanisms ensure that it is possible to parse using one format and serialize using another. **Wayland compositors** may use the new format to *parse* keymaps, but they *must* use the previous format `::XKB_KEYMAP_FORMAT_TEXT_V1` whenever *serializing* for interchange. Since almost features available only in the v2 format deal with state handling which is managed in the server, clients should not be affected by a v2-to-v1 conversion. **Client applications** should use the previous `::XKB_KEYMAP_FORMAT_TEXT_V1` to parse keymaps, at least for now. They may use `::XKB_KEYMAP_FORMAT_TEXT_V2` only if used with a Wayland compositor using the same version of libxkbcommon *and* serializing to the new format. This precaution will be necessary until the new format is stabilized. - Added `xkb_keymap_new_from_names2()` as an alternative to `xkb_keymap_new_from_names()`, which is deprecated. - Added `xkb_keymap_new_from_rmlvo()` to compile a keymap using the new RMLVO builder API. - Added a API to safely build a RMLVO configuration: - `xkb_rmlvo_builder_new()` - `xkb_rmlvo_builder_append_layout()` - `xkb_rmlvo_builder_append_option()` - `xkb_rmlvo_builder_ref()` - `xkb_rmlvo_builder_unref()` - Added `xkb_keymap_mod_get_mask2()` to query the mapping of a modifier by its index rather than it name. - Update keysyms using latest [xorgproto] \(commit: `ce7786ebb90f70897f8038d02ae187ab22766ab2`). Additions ([xorgproto-93]): - `XKB_KEY_XF86MediaSelectCD` (alias for `XKB_KEY_XF86CD`) - `XKB_KEY_XF86OK` - `XKB_KEY_XF86GoTo` - `XKB_KEY_XF86VendorLogo` - `XKB_KEY_XF86MediaSelectProgramGuide` - `XKB_KEY_XF86MediaSelectHome` - `XKB_KEY_XF86MediaLanguageMenu` - `XKB_KEY_XF86MediaTitleMenu` - `XKB_KEY_XF86AudioChannelMode` - `XKB_KEY_XF86MediaSelectPC` - `XKB_KEY_XF86MediaSelectTV` - `XKB_KEY_XF86MediaSelectCable` - `XKB_KEY_XF86MediaSelectVCR` - `XKB_KEY_XF86MediaSelectVCRPlus` - `XKB_KEY_XF86MediaSelectSatellite` - `XKB_KEY_XF86MediaSelectTape` - `XKB_KEY_XF86MediaSelectRadio` - `XKB_KEY_XF86MediaSelectTuner` - `XKB_KEY_XF86MediaPlayer` - `XKB_KEY_XF86MediaSelectTeletext` - `XKB_KEY_XF86MediaSelectDVD` (alias for `XKB_KEY_XF86DVD`) - `XKB_KEY_XF86MediaSelectAuxiliary` - `XKB_KEY_XF86MediaPlaySlow` - `XKB_KEY_XF86NumberEntryMode` [xorgproto-93]: https://gitlab.freedesktop.org/xorg/proto/xorgproto/-/merge_requests/93 - Registry: added `rxkb_option_is_layout_specific()` to query if an option accepts layout index specifiers to restrict its application to the corresponding layouts. ([#500](xkbcommon/libxkbcommon#500)) ### Fixes - Fixed incorrect implementation of `latchToLock` for `LatchMods()`, which could result in unintended `CapsLock` unlock. ([#808](xkbcommon/libxkbcommon#808)) - Fixed `xkb_utf32_to_keysym()` returning deprecated keysyms for some Unicode code points. - Fixed breaking a latch not honoring `clearLocks=no`. ## Tools ### Breaking changes - The tools now use: - `::XKB_KEYMAP_FORMAT_TEXT_V2` as a default *input* format. - `::XKB_KEYMAP_USE_ORIGINAL_FORMAT` as a default *output* format. So if the input format is not specified, it will resolve to `::XKB_KEYMAP_FORMAT_TEXT_V2`. The formats can be explicitly specified using the new `--*format` options. ### New - Added `--*format` options to various tools for specifying and explicit keymap format for parsing and serializing. - Added commands that automatically select the appropriate backend: - `xkbcli interactive`: try Wayland, X11 then fallback to the evdev backend. - `xkbcli dump-keymap`: try Wayland then fallback to the X11 backend. - Improved `xkbcli interactive-*`: - Print key release events. - Print detailed state change events. - Added `--uniline` to enable uniline event output (default). - Added `--multiline` to enable multiline event output, which provides more details than the uniline mode. - Wayland and X11: Added `--local-state` to enable handling the keyboard state with a local state machine instead of the display server. ([#832](xkbcommon/libxkbcommon#832)) - Wayland and X11: Added `--keymap` to enable to use a custom keymap instead of the keymap from the display server. Implies `--local-state`. ([#833](xkbcommon/libxkbcommon#833)) - `xkbcli how-to-type`: Added `--keymap` to enable loading the keymap from a file or stdin instead of resolving RMLVO names. - `xkbcli how-to-type`: Added Compose support, enabled by default and disabled using `--disable-compose`. ([#361](xkbcommon/libxkbcommon#361)) - `xkbcli-list`: Added `layout-specific` field for options. ([#500](xkbcommon/libxkbcommon#500)) - Added `--verbose` to various tools, so that all tools have the option. ([#833](xkbcommon/libxkbcommon#833)) libxkbcommon [1.10.0] – 2025-05-21 ================================== [1.10.0]: https://github.com/xkbcommon/libxkbcommon/tree/xkbcommon-1.10.0 ## API ### Breaking changes - *Modifiers masks* handling has been refactored to properly handle virtual modifiers. Modifier masks are now always considered as an *opaque encoding* of the modifiers state: - Modifiers masks should not be interpreted by other means than the provided API. In particular, one should not assume that modifiers masks always denote the modifiers *indices* of the keymap. - It enables using virtual modifiers with arbitrary mappings. E.g. one can now reliably create virtual modifiers without relying on the legacy X11 mechanism, that requires a careful use of keys’ real and virtual modmaps. - It enables *interoperability* with further implementations of XKB. - Changed *Compose* behavior so that sequences defined later always override ones defined earlier, even if the new sequence is shorter. Contributed by Jules Bertholet ### Deprecated - Server applications using `xkb_state_update_mask()` should migrate to using `xkb_state_update_latched_locked()` instead, for proper handling of the keyboard state. ([#310](xkbcommon/libxkbcommon#310)) - The following modifiers names in `xkbcommon/xkbcommon-names.h` are now deprecated and will be removed in a future version: - `XKB_MOD_NAME_ALT`: use `XKB_VMOD_NAME_ALT` instead. - `XKB_MOD_NAME_LOGO`: use `XKB_VMOD_NAME_SUPER` instead. - `XKB_MOD_NAME_NUM`: use `XKB_VMOD_NAME_NUM` instead. ([#538](xkbcommon/libxkbcommon#538)) ### New - Added `xkb_state_update_latched_locked()` to update the keyboard state to change the latched and locked state of the modifiers and layout. This entry point is intended for *server* applications and should not be used by *client* applications. This can be use for e.g. a GUI layout switcher. ([#310](xkbcommon/libxkbcommon#310)) - Added `xkb_keymap_mod_get_mask()` to query the mapping of a modifier. - Added `VoidAction()` action to match the keysym pair `NoSymbol`/`VoidSymbol`. It enables erasing a previous action and breaks latches. This is a libxkbcommon extension. When serializing it will be converted to `LockControls(controls=none,affect=neither)` for backward compatibility. ([#622](xkbcommon/libxkbcommon#622)) - Improved syntax errors in XKB files to include the expected/got tokens. ([#644](xkbcommon/libxkbcommon#644)) ### Fixes - *Compose*: fixed sequence not fully overriden if the new sequence has no keysym or string. ## Tools ### New - `xkbcli-compile-keymap`: Added option `--modmaps` that prints modifiers mappings. This is similar to the legacy `xmodmap -pm`. ## Build system ### Breaking changes - Removed support for byacc -- use bison instead. ([#644](xkbcommon/libxkbcommon#644)) - Required bison ≥ 3.6. 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](xkbcommon/libxkbcommon#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](xkbcommon/libxkbcommon#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](xkbcommon/libxkbcommon#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 libxkbcommon \< 1.9.0: ```c key <> { type= "FOUR_LEVEL_SEMIALPHABETIC", [a, A, NoSymbol, NoSymbol] }; ``` - Compilation with libxkbcommon ≥ 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](xkbcommon/libxkbcommon#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](xkbcommon/libxkbcommon#695)) - Added support for keysym Capitalization transformation to `xkb_state_key_get_syms()`. ([#552](xkbcommon/libxkbcommon#552)) - `xkb_utf32_to_keysym`: Allow [Unicode noncharacters]. ([#715](xkbcommon/libxkbcommon#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](xkbcommon/libxkbcommon#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](xkbcommon/libxkbcommon#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](xkbcommon/libxkbcommon#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](xkbcommon/libxkbcommon#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 indices 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](xkbcommon/libxkbcommon#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` “ǲ”: - `xkb_keysym_to_lower(U01F2) == U01F3` “ǲ” → “ǳ” - `xkb_keysym_to_upper(U01F2) == U01F1` “ǲ” → “Ǳ” - *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](xkbcommon/libxkbcommon#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](xkbcommon/libxkbcommon#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](xkbcommon/libxkbcommon#501)) - Rules: Added support for special layouts indices: - *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](xkbcommon/libxkbcommon#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](xkbcommon/libxkbcommon#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](xkbcommon/libxkbcommon#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](xkbcommon/libxkbcommon#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](xkbcommon/libxkbcommon#497)) - Fixed `LatchGroup` action with the `latchToLock` option disabled not applying its latch effect multiple times. ([#577](xkbcommon/libxkbcommon#577)) - Fixed incorrect handling of group indicators when `whichGroupState` is set with `Base` or `Latched`. ([#579](xkbcommon/libxkbcommon#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](xkbcommon/libxkbcommon#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](xkbcommon/libxkbcommon#587)) ## Build system ### Breaking changes - Raised minimal meson version requirement to 0.58. ### Fixes - Make the test of `-Wl,--version-script` more robust. ([#481](xkbcommon/libxkbcommon#481))

state: LatchMods() should reset the priv field when mutating into a new action #808

Description

Metadata

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Issue actions

state: `LatchMods()` should reset the `priv` field when mutating into a new action #808