1 libxkbcommon 1.6.0 - 2023-10-08
9 - *Remove* keysyms that were intended for German T3 layout but are unused:
11 - `XKB_KEY_dead_lowline`
12 - `XKB_KEY_dead_aboveverticalline`
13 - `XKB_KEY_dead_belowverticalline`
14 - `XKB_KEY_dead_longsolidusoverlay`
16 See the upstream [`xorgproto` MR](https://gitlab.freedesktop.org/xorg/proto/xorgproto/-/merge_requests/70). See hereinafter for further changes related to keysyms.
20 - Add Compose iterator API to iterate the entries in a compose table:
22 - `xkb_compose_table_entry_sequence`
23 - `xkb_compose_table_entry_keysym`
24 - `xkb_compose_table_entry_utf8`
25 - `xkb_compose_table_iterator_new`
26 - `xkb_compose_table_iterator_free`
27 - `xkb_compose_table_iterator_next`
29 - *Structured log messages* with a message registry. There is an *ongoing* work
30 to assign unique identifiers to log messages and add a corresponding error
31 index documentation page:
33 - The log entries are preceded with an identifier in the form `XKB-NNN`, where
34 `NNN` is a decimal number.
36 - The log entries can then be parsed with third-party tools, to check for
39 - The new documentation page “**Error index**” lists all the kind of error messages
40 with their identifiers. The aim is that each entry could present detailed
41 information on the error and how to fix it.
43 - Add a new warning for numeric keysyms references in XKB files: the preferred
44 keysym reference form is its name or its Unicode value, if relevant.
46 - Add the upper bound `XKB_KEYSYM_MAX` to check valid keysyms.
48 - Add a warning when loading a keymap using RMLVO with no layout but with the
49 variant set. The variant is actually discarded and both layout and variant are
50 set to default values, but this was done previously with no warning, confusing
53 - Add support for `modifier_map None { … }`. This feature is missing compared to
54 the X11 implementation. It allows to reset the modifier map of a key.
56 - Update keysyms using latest [xorgproto] (commit: `1c8128d72df22843a2022576850bc5ab5e3a46ea`):
60 - `XKB_KEY_ordmasculine` ([xorgproto-68])
61 - `XKB_KEY_guillemetleft` ([xorgproto-68])
62 - `XKB_KEY_guillemetright` ([xorgproto-68])
63 - `XKB_KEY_dead_schwa` ([xorgproto-78])
64 - `XKB_KEY_dead_SCHWA` ([xorgproto-78])
65 - `XKB_KEY_dead_hamza` ([xorgproto-71])
66 - `XKB_KEY_XF86EmojiPicker` ([xorgproto-44])
67 - `XKB_KEY_XF86Dictate` ([xorgproto-49])
68 - `XKB_KEY_XF86CameraAccessEnable` ([xorgproto-82])
69 - `XKB_KEY_XF86CameraAccessDisable` ([xorgproto-82])
70 - `XKB_KEY_XF86CameraAccessToggle` ([xorgproto-82])
71 - `XKB_KEY_XF86NextElement` ([xorgproto-82])
72 - `XKB_KEY_XF86PreviousElement` ([xorgproto-82])
73 - `XKB_KEY_XF86AutopilotEngageToggle` ([xorgproto-82])
74 - `XKB_KEY_XF86MarkWaypoint` ([xorgproto-82])
75 - `XKB_KEY_XF86Sos` ([xorgproto-82])
76 - `XKB_KEY_XF86NavChart` ([xorgproto-82])
77 - `XKB_KEY_XF86FishingChart` ([xorgproto-82])
78 - `XKB_KEY_XF86SingleRangeRadar` ([xorgproto-82])
79 - `XKB_KEY_XF86DualRangeRadar` ([xorgproto-82])
80 - `XKB_KEY_XF86RadarOverlay` ([xorgproto-82])
81 - `XKB_KEY_XF86TraditionalSonar` ([xorgproto-82])
82 - `XKB_KEY_XF86ClearvuSonar` ([xorgproto-82])
83 - `XKB_KEY_XF86SidevuSonar` ([xorgproto-82])
84 - `XKB_KEY_XF86NavInfo` ([xorgproto-82])
88 - `XKB_KEY_masculine`: use `XKB_KEY_ordmasculine` instead ([xorgproto-68])
89 - `XKB_KEY_guillemotleft`: use `XKB_KEY_guillemetleft` instead ([xorgproto-68])
90 - `XKB_KEY_guillemotright`: use `XKB_KEY_guillemetright` instead ([xorgproto-68])
91 - `XKB_KEY_dead_small_schwa`: use `XKB_KEY_dead_schwa` instead ([xorgproto-78])
92 - `XKB_KEY_dead_capital_schwa`: use `XKB_KEY_dead_SCHWA` instead ([xorgproto-78])
94 [xorgproto]: https://gitlab.freedesktop.org/xorg/proto/xorgproto
95 [xorgproto-44]: https://gitlab.freedesktop.org/xorg/proto/xorgproto/-/merge_requests/44
96 [xorgproto-49]: https://gitlab.freedesktop.org/xorg/proto/xorgproto/-/merge_requests/49
97 [xorgproto-68]: https://gitlab.freedesktop.org/xorg/proto/xorgproto/-/merge_requests/68
98 [xorgproto-71]: https://gitlab.freedesktop.org/xorg/proto/xorgproto/-/merge_requests/71
99 [xorgproto-78]: https://gitlab.freedesktop.org/xorg/proto/xorgproto/-/merge_requests/78
100 [xorgproto-82]: https://gitlab.freedesktop.org/xorg/proto/xorgproto/-/merge_requests/82
102 - Ongoing work to improve the documentation about XKB and its V1 format.
106 - Prevent `xkb_keysym_from_name` to parse out-of-range hexadecimal keysyms.
108 - Disallow producing NULL character with escape sequences `\0` and `\x0`.
110 - Prevent overflow of octal escape sequences by making `\400..\777` invalid.
112 - Prevent interpreting and emitting invalid Unicode encoding forms: surrogates
113 are invalid in both UTF-32 and UTF-8.
115 - `xkb_keymap_new_from_buffer`: Allow for a NULL-terminated keymap string.
117 - Compose: Increase the limit of possible entries to handle huge Compose files.
124 - Add bash completions for `xkbcli` and its subcommands.
126 - `xkbcli interactive-*`: Add options `--short` to hide some fields.
128 - `xkbcli interactive-evdev`: Add `--includes` and `--include-defaults` options.
130 - Add `xkb-check-messages` *experimental* tool (not installed).
131 It checks whether given log messages identifiers are supported.
135 - `xkbcli compile-keymap`: Allow to use without arguments.
137 - `xkbcli interactive-*`: Always print keycode.
139 - `xkbcli interactive-*`: Escape control characters for Unicode output, instead of
140 printing them as-is, messing the output.
145 - Bump required meson to 0.52.0.
147 - Allow `xkbcommon` to be used as a subproject.
149 - Improve Windows compilation.
151 libxkbcommon 1.5.0 - 2023-01-02
154 - Add `xkb_context` flag `XKB_CONTEXT_NO_SECURE_GETENV` and `rxkb_context` flag
155 `RXKB_CONTEXT_NO_SECURE_GETENV`.
157 xkbcommon uses `getenv_secure()` to obtain environment variables. This flag
158 makes xkbcommon use `getenv()` instead.
160 This is useful for some clients that have relatively benign capabilities set,
161 like CAP_SYS_NICE, that also want to use e.g. the XKB configuration from the
162 environment and user configs in XDG_CONFIG_HOME.
164 Contributed by Ronan Pigott.
166 - Fix crash in `xkbcli interactive-wayland` under a compositor which supports
167 new versions of the xdg-shell protocol.
169 Contributed by Jan Alexander Steffens (heftig).
171 - Fix some MSVC build issues.
173 - Fix some issues when including xkbcommon as a meson subproject.
175 - meson>=0.51 is now required.
178 XKB_CONTEXT_NO_SECURE_GETENV
179 RXKB_CONTEXT_NO_SECURE_GETENV
181 libxkbcommon 1.4.1 - 2022-05-21
184 - Fix compose sequence overriding (common prefix) not working correctly.
187 Contributed by Weng Xuetian.
189 - Remove various bogus currency sign (particulary Euro and Korean Won) entries
190 from the keysym <-> Unicode mappings. They prevented the real
191 keysyms/codepoints for these from mapping correctly.
193 Contributed by Sam Lantinga and Simon Ser.
195 libxkbcommon 1.4.0 - 2022-02-04
198 - Add `enable-tools` option to Meson build (on by default) to allow disabling
201 Contributed by Alex Xu (Hello71).
203 - In `xkbcli list`, fix "YAML Norway problem" in output.
205 Contributed by Peter Hutterer.
207 - In libxkbregistry, variants now inherit iso639, iso3166 and brief from parent
210 Contributed by M Hickford.
212 - In libxkbregistry, don't call `xmlCleanupParser()` - it's not supposed to
213 be called by libraries.
215 Contributed by Peter Hutterer.
217 - In libxkbregistry, skip over invalid ISO-639 or ISO-3166 entries.
219 Contributed by Peter Hutterer.
221 libxkbcommon 1.3.1 - 2021-09-10
224 - In `xkbcli interactive-x11`, use the Esc keysym instead of the Esc keycode
227 Contributed by Simon Ser.
229 - In `xkbcli how-to-type`, add `--keysym` argugment for how to type a keysym
230 instead of a Unicode codepoint.
232 - Fix a crash in `xkb_x11_keymap_new_from_device` error handling given some
233 invalid keymaps. Regressed in 1.2.0.
235 Reported by Zack Weinberg. Tested by Uli Schlachter.
237 libxkbcommon 1.3.0 - 2021-05-01
240 - Change `xkbcli list` to output YAML, instead of the previous ad-hoc format.
242 This allows to more easily process the information in a programmetic way, for
245 xkbcli list | yq -r ".layouts[].layout"
247 Contributed by Peter Hutterer.
249 - Optimize a certain part of keymap compilation (atom interning).
251 - Fix segmentation fault in case-insensitive `xkb_keysym_from_name` for certain
252 values like the empty string.
254 Contributed by Isaac Freund.
256 - Support building libxkbcommon as a meson subproject.
258 Contributed by Adrian Perez de Castro.
260 - Add `ftruncate` fallback for `posix_fallocate` in `xkbcli interactive-wayland`
263 Contributed by Evgeniy Khramtsov.
265 - Properly export library symbols in MSVC.
267 Contributed by Adrian Perez de Castro.
269 libxkbcommon 1.2.1 - 2021-04-07
272 - Fix `xkb_x11_keymap_new_from_device()` failing when the keymap contains key
273 types with missing level names, like the one used by the `numpad:mac` option
274 in xkeyboard-config. Regressed in 1.2.0.
276 libxkbcommon 1.2.0 - 2021-04-03
279 - `xkb_x11_keymap_new_from_device()` is much faster. It now performs only 2
280 roundtrips to the X server, instead of dozens (in first-time calls).
282 Contributed by Uli Schlachter.
284 - Case-sensitive `xkb_keysym_from_name()` is much faster.
286 - Keysym names of the form `0x12AB` and `U12AB` are parsed more strictly.
287 Previously the hexadecimal part was parsed with `strtoul()`, now only up
288 to 8 hexadecimal digits (0-9A-Fa-f) are allowed.
290 - Compose files now have a size limit (65535 internal nodes). Further sequences
291 are discared and a warning is issued.
293 - Compose table loading (`xkb_compose_table_new_from_locale()` and similar) is
296 - Use `poll()` instead of `epoll()` for `xlbcli interactive-evdev`, making it
297 portable to FreeBSD which provides evdev but not epoll. On FreeBSD, remember
298 to install the `evdev-proto` package to get the evdev headers.
300 - The build now requires a C11 compiler (uses anonymous structs/unions).
302 libxkbcommon 1.1.0 - 2021-02-27
305 - Publish the `xkb-format-text-v1.md` file in the HTML documentation. This file
306 existed for a long time but only in the Git repository.
307 Link: https://xkbcommon.org/doc/current/md_doc_keymap_format_text_v1.html
309 - Add partial documentation for xkb_symbols to xkb-format-text-v1.md.
311 Contributed by Simon Zeni.
313 - Update keysym definitions to latest xorgproto. In particular, this adds many
314 special keysyms corresponding to Linux evdev keycodes.
316 Contributed by Peter Hutterer <@who-t.net>.
319 Too many XKB_KEY_* definitions to list here.
321 libxkbcommon 1.0.3 - 2020-11-23
324 - Fix (hopefully) a segfault in xkb_x11_keymap_new_from_device() in some
325 unclear situation (bug introduced in 1.0.2).
327 - Fix keymaps created with xkb_x11_keymap_new_from_device() don't have level
328 names (bug introduced in 0.8.0).
330 libxkbcommon 1.0.2 - 2020-11-20
333 - Fix a bug where a keysym that cannot be resolved in a keymap gets compiled to
334 a garbage keysym. Now it is set to XKB_KEY_NoSymbol instead.
336 - Improve the speed of xkb_x11_keymap_new_from_device() on repeated calls in the
340 libxkbcommon 1.0.1 - 2020-09-11
343 - Fix the tool-option-parsing test failing.
345 - Remove requirement for pytest in the tool-option-parsing test.
347 - Make the table output of `xkbcli how-to-type` aligned.
349 - Some portability and test isolation fixes.
351 libxkbcommon 1.0.0 - 2020-09-05
354 Note: this release is API and ABI compatible with previous releases -- the
355 major version bump is only an indication of stability.
357 - Add libxkbregistry as configure-time optional library. libxkbregistry is a C
358 library that lists available XKB models, layouts and variants for a given
359 ruleset. This is a separate library (libxkbregistry.so, pkgconfig file
360 xkbregistry.pc) and aimed at tools that provide a listing of available
361 keyboard layouts to the user. See the Documentation for details on the API.
363 Contributed by Peter Hutterer <@who-t.net>.
365 - Better support custom user configuration:
367 * Allow including XKB files from other paths.
369 Previously, a 'symbols/us' file in path A would shadow the same file in
370 path B. This is suboptimal, we rarely need to hide the system files - we
371 care mostly about *extending* them. By continuing to check other lookup
372 paths, we make it possible for a XDG_CONFIG_HOME/xkb/symbols/us file to
373 have sections including those from /usr/share/X11/xkb/symbols/us.
375 Note that this is not possible for rules files, which need to be manually
376 controlled to get the right bits resolved.
378 * Add /etc/xkb as extra lookup path for system data files.
380 This completes the usual triplet of configuration locations available for
382 - vendor-provided data files in /usr/share/X11/xkb
383 - system-specific data files in /etc/xkb
384 - user-specific data files in $XDG_CONFIG_HOME/xkb
386 The default lookup order user, system, vendor, just like everything else
387 that uses these conventions.
389 For include directives in rules files, the '%E' resolves to that path.
391 * Add a new section to the documentation for custom user configuration.
393 Contributed by Peter Hutterer <@who-t.net>.
395 - Add an `xkbcli` command-line utility.
397 This tool offers various subcommands for introspection and debugging.
398 Currently the available subcommands are:
401 List available rules, models, layouts, variants and options
404 Interactive debugger for XKB keymaps for Wayland
407 Interactive debugger for XKB keymaps for X11
410 Interactive debugger for XKB keymaps for evdev (Linux)
413 Compile an XKB keymap
416 See separate entry below.
418 See the manpages for usage information.
420 Contributed by Peter Hutterer <@who-t.net>.
422 - Add `xkb_utf32_to_keysym()` to translate a Unicode codepoint to a keysym.
423 When a special keysym (`XKB_KEY_` constant) for the codepoint exists, it is
424 returned, otherwise the direct encoding is used, if permissible.
426 Contributed by Jaroslaw Kubik <@froglogic.com>.
428 - Add `xkb_keymap_key_get_mods_for_level()` which retrieves sets of modifiers
429 which produce a given shift level in a given key+layout.
431 Contributed by Jaroslaw Kubik <@froglogic.com>.
433 - Add `xkbcli how-to-type` command, which, using `xkb_utf32_to_keysym()`
434 and `xkb_keymap_key_get_mods_for_level()` and other APIs, prints out all
435 the ways to produce a given keysym.
437 For example, how to type `?` (codepoint 63) in a us,de keymap?
439 $ xkbcli how-to-type --layout us,de 63 | column -ts $'\t'
440 keysym: question (0x3f)
441 KEYCODE KEY NAME LAYOUT# LAYOUT NAME LEVEL# MODIFIERS
442 20 AE11 2 German 2 [ Shift ]
443 20 AE11 2 German 2 [ Shift Lock ]
444 61 AB10 1 English (US) 2 [ Shift ]
446 - Add a new section to the documentation describing the format of the XKB
449 - Search for Compose in $XDG_CONFIG_HOME/XCompose (fallback to
450 ~/.config/XCompose) before trying $HOME/.XCompose.
452 Note that libX11 still only searches in $HOME/.XCompose.
454 Contributed by Emmanuel Gil Peyrot <@linkmauve.fr>.
456 - Bump meson requirement to >= 0.49.0.
458 - Fix build with byacc.
460 - Fix building X11 tests on PE targets.
462 Contributed by Jon Turney <@dronecode.org.uk>
464 - The tests no longer rely on bash, only Python (which is already used by
469 xkb_keymap_key_get_mods_for_level
470 XKB_KEY_XF86FullScreen
473 libxkbcommon 0.10.0 - 2020-01-18
476 - (security) Fix quadratic complexity in the XKB file parser. See commit
477 message 7c42945e04a2107827a057245298dedc0475cc88 for details.
479 - Add $XDG_CONFIG_HOME/xkb to the default search path. If $XDG_CONFIG_HOME
480 is not set, $HOME/.config/xkb is used. If $HOME is not set, the path is not
483 The XDG path is looked up before the existing default search path $HOME/.xkb.
485 Contributed by Peter Hutterer <@who-t.net>.
487 - Add support for include statements in XKB rules files.
489 This is a step towards making local XKB customizations more tenable and
490 convenient, without modifying system files.
492 You can now include other rules files like this:
496 Two directives are supported, %H to $HOME and %S for the system-installed
497 rules directory (usually /usr/share/X11/xkb/rules).
499 See commit message ca033a29d2ca910fd17b1ae287cb420205bdddc8 and
500 doc/rules-format.txt in the xkbcommon source code for more information.
502 Contributed by Peter Hutterer <@who-t.net>.
504 - Downgrade "Symbol added to modifier map for multiple modifiers" log to a
507 This error message was too annoying to be shown by default. When working on
508 keymaps, set `XKB_LOG_LEVEL=debug XKB_LOG_VERBOSITY=10` to see all possible
511 - Support building on Windows using the meson MSVC backend.
513 Contributed by Adrian Perez de Castro <@igalia.com>.
515 - Fix bug where the merge mode only applied to the first vmod in a
516 `virtual_modifiers` statement. Given
518 augment virtual_modifiers NumLock,Alt,LevelThree
520 Previously it was incorrectly treated as
522 augment virtual_modifiers NumLock;
523 virtual_modifiers Alt;
524 virtual_modifiers LevelThree;
528 augment virtual_modifiers NumLock;
529 augment virtual_modifiers Alt;
530 augment virtual_modifiers LevelThree;
532 - Reject interpret modifier predicate with more than one value. Given
534 interpret ISO_Level3_Shift+AnyOf(all,extraneous) { ... };
536 Previously, extraneous (and further) was ignored. Now it's rejected.
538 - Correctly handle capitalization of the ssharp keysym.
540 - Speed up and improve the internal `xkeyboard-config` tool. This tool
541 compiles all layout/variant combinations in the xkeyboard-config dataset
542 and reports any issues it finds.
544 Contributed by Peter Hutterer <@who-t.net>.
546 - Speed up "atoms" (string interning). This code goes back at least to X11R1
550 libxkbcommon 0.9.1 - 2019-10-19
553 - Fix context creation failing when run in privileged processes as defined by
554 `secure_getenv(3)`, e.g. GDM.
557 libxkbcommon 0.9.0 - 2019-10-19
560 - Move ~/.xkb to before XKB_CONFIG_ROOT (the system XKB path, usually
561 /usr/share/X11/xkb) in the default include path. This enables the user
562 to have full control of the keymap definitions, instead of only augmenting
565 - Remove the Autotools build system. Use the meson build system instead.
567 - Fix invalid names used for levels above 8 when dumping keymaps. Previously,
568 e.g. "Level20" was dumped, but only up to "Level8" is accepted by the
569 parser. Now "20" is dumped.
571 - Change level references to always be dumped as e.g. "5" instead of "Level5".
573 Change group references to always be dumped capitalized e.g. "Group3" instead
574 of "group3". Previously it was inconsistent.
576 These changes affect the output of xkb_keymap_get_as_string().
578 - Fix several build issues on macOS/Darwin, Solaris, NetBSD, cross compilation.
580 - Port the interactive-wayland test program to the stable version of xdg-shell.
583 libxkbcommon 0.8.4 - 2019-02-22
586 - Fix build of xkbcommon-x11 static library with meson.
588 - Fix building using meson from the tarball generated by autotools.
591 libxkbcommon 0.8.3 - 2019-02-08
594 - Fix build of static libraries with meson.
595 (Future note: xkbcommon-x11 was *not* fixed in this release.)
598 XKB_KEY_XF86MonBrightnessCycle
599 XKB_KEY_XF86RotationLockToggle
602 libxkbcommon 0.8.2 - 2018-08-05
605 - Fix various problems found with fuzzing (see commit messages for
608 - Fix a few NULL-dereferences, out-of-bounds access and undefined behavior
609 in the XKB text format parser.
612 libxkbcommon 0.8.1 - 2018-08-03
615 - Fix various problems found in the meson build (see commit messages for more
618 - Fix compilation on Darwin.
620 - Fix compilation of the x11 tests and demos when XCB is installed in a
621 non-standard location.
623 - Fix xkbcommon-x11.pc missing the Requires specification.
625 - Fix various problems found with fuzzing and Coverity (see commit messages for
628 - Fix stack overflow in the XKB text format parser when evaluating boolean
631 - Fix NULL-dereferences in the XKB text format parser when some unsupported
632 tokens appear (the tokens are still parsed for backward compatibility).
634 - Fix NULL-dereference in the XKB text format parser when parsing an
635 xkb_geometry section.
637 - Fix an infinite loop in the Compose text format parser on some inputs.
639 - Fix an invalid free() when using multiple keysyms.
641 - Replace the Unicode characters for the leftanglebracket and rightanglebracket
642 keysyms from the deprecated LEFT/RIGHT-POINTING ANGLE BRACKET to
643 MATHEMATICAL LEFT/RIGHT ANGLE BRACKET.
645 - Reject out-of-range Unicode codepoints in xkb_keysym_to_utf8 and
649 libxkbcommon 0.8.0 - 2017-12-15
652 - Added xkb_keysym_to_{upper,lower} to perform case-conversion directly on
653 keysyms. This is useful in some odd cases, but working with the Unicode
654 representations should be preferred when possible.
656 - Added Unicode conversion rules for the signifblank and permille keysyms.
658 - Fixed a bug in the parsing of XKB key type definitions where the number
659 of levels were determined by the number of level *names*. Keymaps which
660 omit level names were hence miscompiled.
662 This regressed in version 0.4.3. Keymaps from xkeyboard-config were not
663 affected since they don't omit level names.
666 xkb_keysym_to_upper()
667 xkb_keysym_to_lower()
670 libxkbcommon 0.7.2 - 2017-08-04
673 - Added a Meson build system as an alternative to existing autotools build
676 The intent is to remove the autotools build in one of the next releases.
677 Please try to convert to it and report any problems.
679 See http://mesonbuild.com/Quick-guide.html for basic usage, the
680 meson_options.txt for the project-specific configuration options,
681 and the PACKAGING file for more details.
683 There are some noteworthy differences compared to the autotools build:
685 - Feature auto-detection is not performed. By default, all features are
686 enabled (currently: docs, x11, wayland). The build fails if any of
687 the required dependencies are not available. To disable a feature,
688 pass -Denable-<feature>=false to meson.
690 - The libraries are either installed as shared or static, as specified
691 by the -Ddefault_library=shared/static option. With autotools, both
692 versions are installed by default.
694 - xorg-util-macros is not used.
696 - A parser generator (bison/byacc) is always required - there is no
697 fallback to pre-generated output bundled in the tarball, as there is
700 - Removed Android.mk support.
702 - Removed the *-uninstalled.pc pkgconfig files.
704 - Ported the interactive-wayland demo program to v6 of the xdg-shell
707 - Added new keysym definitions from xproto.
713 XKB_KEY_XF86AudioPreset
716 libxkbcommon 0.7.1 - 2017-01-18
719 - Fixed various reported problems when the current locale is tr_TR.UTF-8.
721 The function xkb_keysym_from_name() used to perform case-insensitive
722 string comparisons in a locale-dependent way, but required it to to
723 work as in the C/ASCII locale (the so called "Turkish i problem").
725 The function is now no longer affected by the current locale.
727 - Fixed compilation in NetBSD.
730 libxkbcommon 0.7.0 - 2016-11-11
733 - Added support for different "modes" of calculating consumed modifiers.
734 The existing mode, based on the XKB standard, has proven to be
735 unintuitive in various shortcut implementations.
737 A new mode, based on the calculation used by the GTK toolkit, is added.
738 This mode is less eager to declare a modifier as consumed.
740 - Added a new interactive demo program using the Wayland protocol.
741 See the PACKAGING file for the new (optional) test dependencies.
743 - Fixed a compilation error on GNU Hurd.
746 enum xkb_consumed_mode
747 XKB_CONSUMED_MODE_XKB
748 XKB_CONSUMED_MODE_GTK
749 xkb_state_key_get_consumed_mods2
750 xkb_state_mod_index_is_consumed2
753 libxkbcommon 0.6.1 - 2016-04-08
756 - Added LICENSE to distributed files in tarball releases.
758 - Minor typo fix in xkb_keymap_get_as_string() documentation.
761 libxkbcommon 0.6.0 - 2016-03-16
764 - If the XKB_CONFIG_ROOT environment variable is set, it is used as the XKB
765 configuration root instead of the path determined at build time.
767 - Tests and benchmarks now build correctly on OSX.
769 - An XKB keymap provides a name for each key it defines. Traditionally,
770 these names are limited to at most 4 characters, and are thus somewhat
771 obscure, but might still be useful (xkbcommon lifts the 4 character limit).
773 The new functions xkb_keymap_key_get_name() and xkb_keymap_key_by_name()
774 can be used to get the name of a key or find a key by name. Note that
775 a key may have aliases.
777 - Documentation improvements.
780 xkb_keymap_key_by_name()
781 xkb_keymap_key_get_name()
784 libxkbcommon 0.5.0 - 2014-10-18
787 - Added support for Compose/dead keys in a new module (included in
788 libxkbcommon). See the documentation or the
789 xkbcommon/xkbcommon-compose.h header file for more details.
791 - Improved and reordered some sections of the documentation.
793 - The doxygen HTML pages were made nicer to read.
795 - Most tests now run also on non-linux platforms.
797 - A warning is emitted by default about RMLVO values which are not used
798 during keymap compilation, which are most often a user misconfiguration.
799 For example, "terminate:ctrl_alt_backspace" instead of
800 "terminate:ctrl_alt_bksp".
802 - Added symbol versioning for libxkbcommon and libxkbcommon-x11.
803 Note: binaries compiled against this and future versions will not be
804 able to link against the previous versions of the library.
806 - Removed several compatablity symbols from the binary (the API isn't
807 affected). This affects binaries which
809 1. Were compiled against a pre-stable (<0.2.0) version of libxkbcommon, and
810 2. Are linked against the this or later version of libxkbcommon.
812 Such a scenario is likely to fail already.
814 - If Xvfb is not available, the x11comp test is now correctly skipped
817 - Benchmarks were moved to a separate bench/ directory.
819 - Build fixes from OpenBSD.
821 - Fixed a bug where key type entries such as "map[None] = Level2;" were
829 libxkbcommon 0.4.3 - 2014-08-19
832 - Fixed a bug which caused xkb_x11_keymap_new_from_device() to misrepresent
833 modifiers for some keymaps.
835 https://github.com/xkbcommon/libxkbcommon/issues/9
837 - Fixed a bug which caused xkb_x11_keymap_new_from_device() to ignore XKB
840 - Modifiers are now always fully resolved after xkb_state_update_mask().
841 Previously the given state components were used as-is, without
842 considering virtual modifier mappings.
843 Note: this only affects non-standard uses of xkb_state_update_mask().
845 - Added a test for xkbcommon-x11, "x11comp". The test uses the system's
846 Xvfb server and xkbcomp. If they do not exist or fail, the test is
849 - Fixed memory leaks after parse errors in the XKB yacc parser.
850 The fix required changes which are currently incompatible with byacc.
853 libxkbcommon 0.4.2 - 2014-05-15
856 - Fixed a bug where explicitly passing "--enable-x11" to ./configure would
857 in fact disable it (regressed in 0.4.1).
859 - Added @since version annotations to the API documentation for everything
860 introduced after the initial stable release (0.2.0).
862 - Added a section to the documentation about keysym transformations, and
863 clarified which functions perform a given transformation.
865 - XKB files which fail to compile during keymap construction can no longer
866 have any effect on the resulting keymap: changes are only applied when
867 the entire compilation succeeds.
868 Note: this was a minor correctness issue inherited from xkbcomp.
870 - Fix an out-of-bounds array access in src/x11/util.c:adopt_atoms()
872 Note: it seems impossible to trigger in the current code since the input
873 size cannot exceed the required size.
876 libxkbcommon 0.4.1 - 2014-03-27
879 - Converted README to markdown and added a Quick Guide to the
880 documentation, which breezes through the most common parts of
883 - Added two new functions, xkb_state_key_get_utf{8,32}(). They
884 combine the operations of xkb_state_key_get_syms() and
885 xkb_keysym_to_utf{8,32}(), and provide a nicer interface for it
886 (espcially for multiple-keysyms-per-level).
888 - The xkb_state_key_get_utf{8,32}() functions now apply Control
889 transformation: when the Control modifier is active, the string
890 is converted to an appropriate control character.
891 This matches the behavior of libX11's XLookupString(3), and
892 required by the XKB specification:
893 https://www.x.org/releases/current/doc/kbproto/xkbproto.html#Interpreting_the_Control_Modifier
895 https://bugs.freedesktop.org/show_bug.cgi?id=75892
897 - The consumed modifiers for a key are now calculated similarly
898 to libX11. The previous behavior caused a bug where Shift would
899 not cancel an active Caps Lock.
901 - Make xkbcommon-x11 work with the keymap reported by the XQuartz
904 https://bugs.freedesktop.org/show_bug.cgi?id=75798
906 - Reduce memory usage during keymap compilation some more.
909 xkb_state_key_get_consumed_mods()
910 xkb_state_key_get_utf8()
911 xkb_state_key_get_utf32()
914 XKB_MAP_COMPILE_PLACEHOLDER, XKB_MAP_NO_FLAGS
915 use XKB_KEYMAP_NO_FLAGS instead.
920 libxkbcommon 0.4.0 - 2014-02-02
923 - Add a new add-on library, xkbcommon-x11, to support creating keymaps
924 with the XKB X11 protocol, by querying the X server directly.
925 See the xkbcommon/xkbcommon-x11.h header file for more details.
926 This library requires libxcb-xkb >= 1.10, and is enabled by default.
927 It can be disabled with the --disable-x11 configure switch.
928 Distributions are encouraged to split the necessary files for this
929 library (libxkbcommon-x11.so, xkbcommon-x11.pc, xkbcommon/xkbcommon-x11.h)
930 to a separate package, such that the main package does not depend on
933 - Fix the keysym <-> name lookup table to not require huge amounts of
936 - Fix a bug in the keysym <-> name lookup, whereby lookup might fail in
939 - Reduce memory usage during keymap compilation.
942 New keysyms from xproto 7.0.25 (German T3 layout keysyms).
943 XKB_MOD_NAME_NUM for the usual NumLock modifier.
944 xkb_x11_* types and functions, XKB_X11_* constants.
947 libxkbcommon 0.3.2 - 2013-11-22
950 - Log messages from the library now look like "xkbcommon: ERROR" by
951 default, instead of xkbcomp-like "Error: ".
953 - Apply capitalization transformation on keysyms in
954 xkb_keysym_get_one_sym(), to match the behavior specified in the XKB
956 https://www.x.org/releases/current/doc/kbproto/xkbproto.html#Interpreting_the_Lock_Modifier
958 - Support byacc for generating the parser, in addition to Bison.
961 XKB_KEY_XF86AudioMicMute keysym from xproto 7.0.24.
964 XKB_MAP_COMPILE_NO_FLAGS
969 libxkbcommon 0.3.1 - 2013-06-03
972 - Replace the flex scanner with a hand-written one. flex is no longer
976 xkb_keymap_min_keycode()
977 xkb_keymap_max_keycode()
978 xkb_keymap_key_for_each()
981 libxkbcommon 0.3.0 - 2013-04-01
984 - Allow passing NULL to *_unref() functions; do nothing instead of
987 - The functions xkb_keymap_num_levels_for_key() and
988 xkb_keymap_get_syms_by_level() now allow out-of-range values for the
989 'layout' parameter. The functions now wrap the value around the number
990 of layouts instead of failing.
992 - The function xkb_keysym_get_name() now types unicode keysyms in
993 uppercase and 0-padding, to match the format used by XKeysymToString().
995 - Building Linux-specific tests is no longer attempted on non-Linux
998 - The function xkb_keymap_new_from_names() now accepts a NULL value for
999 the 'names' parameter, instead of failing. This is equivalent to passing
1000 a 'struct xkb_rule_names' with all fields set to NULL.
1003 xkb_keymap_new_from_buffer()