NEWS

   1 libxkbcommon 1.4.1 - 2022-05-21
   2 ==================
   3
   4 - Fix compose sequence overriding (common prefix) not working correctly.
   5   Regressed in 1.2.0.
   6
   7   Contributed by Weng Xuetian.
   8
   9 - Remove various bogus currency sign (particulary Euro and Korean Won) entries
  10   from the keysym <-> Unicode mappings. They prevented the real
  11   keysyms/codepoints for these from mapping correctly.
  12
  13   Contributed by Sam Lantinga and Simon Ser.
  14
  15 libxkbcommon 1.4.0 - 2022-02-04
  16 ==================
  17
  18 - Add `enable-tools` option to Meson build (on by default) to allow disabling
  19   the `xkbcli` tools.
  20
  21   Contributed by Alex Xu (Hello71).
  22
  23 - In `xkbcli list`, fix "YAML Norway problem" in output.
  24
  25   Contributed by Peter Hutterer.
  26
  27 - In libxkbregistry, variants now inherit iso639, iso3166 and brief from parent
  28   layout if omitted.
  29
  30   Contributed by M Hickford.
  31
  32 - In libxkbregistry, don't call `xmlCleanupParser()` - it's not supposed to
  33   be called by libraries.
  34
  35   Contributed by Peter Hutterer.
  36
  37 - In libxkbregistry, skip over invalid ISO-639 or ISO-3166 entries.
  38
  39   Contributed by Peter Hutterer.
  40
  41 libxkbcommon 1.3.1 - 2021-09-10
  42 ==================
  43
  44 - In `xkbcli interactive-x11`, use the Esc keysym instead of the Esc keycode
  45   for quitting.
  46
  47   Contributed by Simon Ser.
  48
  49 - In `xkbcli how-to-type`, add `--keysym` argugment for how to type a keysym
  50   instead of a Unicode codepoint.
  51
  52 - Fix a crash in `xkb_x11_keymap_new_from_device` error handling given some
  53   invalid keymaps. Regressed in 1.2.0.
  54
  55   Reported by Zack Weinberg. Tested by Uli Schlachter.
  56
  57 libxkbcommon 1.3.0 - 2021-05-01
  58 ==================
  59
  60 - Change `xkbcli list` to output YAML, instead of the previous ad-hoc format.
  61
  62   This allows to more easily process the information in a programmetic way, for
  63   example
  64
  65     xkbcli list | yq -r ".layouts[].layout"
  66
  67   Contributed by Peter Hutterer.
  68
  69 - Optimize a certain part of keymap compilation (atom interning).
  70
  71 - Fix segmentation fault in case-insensitive `xkb_keysym_from_name` for certain
  72   values like the empty string.
  73
  74   Contributed by Isaac Freund.
  75
  76 - Support building libxkbcommon as a meson subproject.
  77
  78   Contributed by Adrian Perez de Castro.
  79
  80 - Add `ftruncate` fallback for `posix_fallocate` in `xkbcli interactive-wayland`
  81   for FreeBSD.
  82
  83   Contributed by Evgeniy Khramtsov.
  84
  85 - Properly export library symbols in MSVC.
  86
  87   Contributed by Adrian Perez de Castro.
  88
  89 libxkbcommon 1.2.1 - 2021-04-07
  90 ==================
  91
  92 - Fix `xkb_x11_keymap_new_from_device()` failing when the keymap contains key
  93   types with missing level names, like the one used by the `numpad:mac` option
  94   in xkeyboard-config. Regressed in 1.2.0.
  95
  96 libxkbcommon 1.2.0 - 2021-04-03
  97 ==================
  98
  99 - `xkb_x11_keymap_new_from_device()` is much faster. It now performs only 2
 100   roundtrips to the X server, instead of dozens (in first-time calls).
 101
 102   Contributed by Uli Schlachter.
 103
 104 - Case-sensitive `xkb_keysym_from_name()` is much faster.
 105
 106 - Keysym names of the form `0x12AB` and `U12AB` are parsed more strictly.
 107   Previously the hexadecimal part was parsed with `strtoul()`, now only up
 108   to 8 hexadecimal digits (0-9A-Fa-f) are allowed.
 109
 110 - Compose files now have a size limit (65535 internal nodes). Further sequences
 111   are discared and a warning is issued.
 112
 113 - Compose table loading (`xkb_compose_table_new_from_locale()` and similar) is
 114   much faster.
 115
 116 - Use `poll()` instead of `epoll()` for `xlbcli interactive-evdev`, making it
 117   portable to FreeBSD which provides evdev but not epoll. On FreeBSD, remember
 118   to install the `evdev-proto` package to get the evdev headers.
 119
 120 - The build now requires a C11 compiler (uses anonymous structs/unions).
 121
 122 libxkbcommon 1.1.0 - 2021-02-27
 123 ==================
 124
 125 - Publish the `xkb-format-text-v1.md` file in the HTML documentation. This file
 126   existed for a long time but only in the Git repository.
 127   Link: https://xkbcommon.org/doc/current/md_doc_keymap_format_text_v1.html
 128
 129 - Add partial documentation for xkb_symbols to xkb-format-text-v1.md.
 130
 131   Contributed by Simon Zeni.
 132
 133 - Update keysym definitions to latest xorgproto. In particular, this adds many
 134   special keysyms corresponding to Linux evdev keycodes.
 135
 136   Contributed by Peter Hutterer <@who-t.net>.
 137
 138 - New API:
 139   Too many XKB_KEY_* definitions to list here.
 140
 141 libxkbcommon 1.0.3 - 2020-11-23
 142 ==================
 143
 144 - Fix (hopefully) a segfault in xkb_x11_keymap_new_from_device() in some
 145   unclear situation (bug introduced in 1.0.2).
 146
 147 - Fix keymaps created with xkb_x11_keymap_new_from_device() don't have level
 148   names (bug introduced in 0.8.0).
 149
 150 libxkbcommon 1.0.2 - 2020-11-20
 151 ==================
 152
 153 - Fix a bug where a keysym that cannot be resolved in a keymap gets compiled to
 154   a garbage keysym. Now it is set to XKB_KEY_NoSymbol instead.
 155
 156 - Improve the speed of xkb_x11_keymap_new_from_device() on repeated calls in the
 157   same xkb_context().
 158
 159
 160 libxkbcommon 1.0.1 - 2020-09-11
 161 ==================
 162
 163 - Fix the tool-option-parsing test failing.
 164
 165 - Remove requirement for pytest in the tool-option-parsing test.
 166
 167 - Make the table output of `xkbcli how-to-type` aligned.
 168
 169 - Some portability and test isolation fixes.
 170
 171 libxkbcommon 1.0.0 - 2020-09-05
 172 ==================
 173
 174 Note: this release is API and ABI compatible with previous releases -- the
 175 major version bump is only an indication of stability.
 176
 177 - Add libxkbregistry as configure-time optional library. libxkbregistry is a C
 178   library that lists available XKB models, layouts and variants for a given
 179   ruleset. This is a separate library (libxkbregistry.so, pkgconfig file
 180   xkbregistry.pc) and aimed at tools that provide a listing of available
 181   keyboard layouts to the user. See the Documentation for details on the API.
 182
 183   Contributed by Peter Hutterer <@who-t.net>.
 184
 185 - Better support custom user configuration:
 186
 187     * Allow including XKB files from other paths.
 188
 189       Previously, a 'symbols/us' file in path A would shadow the same file in
 190       path B. This is suboptimal, we rarely need to hide the system files - we
 191       care mostly about *extending* them. By continuing to check other lookup
 192       paths, we make it possible for a XDG_CONFIG_HOME/xkb/symbols/us file to
 193       have sections including those from /usr/share/X11/xkb/symbols/us.
 194
 195       Note that this is not possible for rules files, which need to be manually
 196       controlled to get the right bits resolved.
 197
 198     * Add /etc/xkb as extra lookup path for system data files.
 199
 200       This completes the usual triplet of configuration locations available for
 201       most processes:
 202       - vendor-provided data files in /usr/share/X11/xkb
 203       - system-specific data files in /etc/xkb
 204       - user-specific data files in $XDG_CONFIG_HOME/xkb
 205
 206       The default lookup order user, system, vendor, just like everything else
 207       that uses these conventions.
 208
 209       For include directives in rules files, the '%E' resolves to that path.
 210
 211     * Add a new section to the documentation for custom user configuration.
 212
 213   Contributed by Peter Hutterer <@who-t.net>.
 214
 215 - Add an `xkbcli` command-line utility.
 216
 217   This tool offers various subcommands for introspection and debugging.
 218   Currently the available subcommands are:
 219
 220   list
 221     List available rules, models, layouts, variants and options
 222
 223   interactive-wayland
 224     Interactive debugger for XKB keymaps for Wayland
 225
 226   interactive-x11
 227     Interactive debugger for XKB keymaps for X11
 228
 229   interactive-evdev
 230     Interactive debugger for XKB keymaps for evdev (Linux)
 231
 232   compile-keymap
 233     Compile an XKB keymap
 234
 235   how-to-type
 236     See separate entry below.
 237
 238   See the manpages for usage information.
 239
 240   Contributed by Peter Hutterer <@who-t.net>.
 241
 242 - Add `xkb_utf32_to_keysym()` to translate a Unicode codepoint to a keysym.
 243   When a special keysym (`XKB_KEY_` constant) for the codepoint exists, it is
 244   returned, otherwise the direct encoding is used, if permissible.
 245
 246   Contributed by Jaroslaw Kubik <@froglogic.com>.
 247
 248 - Add `xkb_keymap_key_get_mods_for_level()` which retrieves sets of modifiers
 249   which produce a given shift level in a given key+layout.
 250
 251   Contributed by Jaroslaw Kubik <@froglogic.com>.
 252
 253 - Add `xkbcli how-to-type` command, which, using `xkb_utf32_to_keysym()`
 254   and `xkb_keymap_key_get_mods_for_level()` and other APIs, prints out all
 255   the ways to produce a given keysym.
 256
 257   For example, how to type `?` (codepoint 63) in a us,de keymap?
 258
 259     $ xkbcli how-to-type --layout us,de 63 | column -ts $'\t'
 260     keysym: question (0x3f)
 261     KEYCODE  KEY NAME  LAYOUT#  LAYOUT NAME   LEVEL#  MODIFIERS
 262     20       AE11      2        German        2       [ Shift ]
 263     20       AE11      2        German        2       [ Shift Lock ]
 264     61       AB10      1        English (US)  2       [ Shift ]
 265
 266 - Add a new section to the documentation describing the format of the XKB
 267   rules file.
 268
 269 - Search for Compose in $XDG_CONFIG_HOME/XCompose (fallback to
 270   ~/.config/XCompose) before trying $HOME/.XCompose.
 271
 272   Note that libX11 still only searches in $HOME/.XCompose.
 273
 274   Contributed by Emmanuel Gil Peyrot <@linkmauve.fr>.
 275
 276 - Bump meson requirement to >= 0.49.0.
 277
 278 - Fix build with byacc.
 279
 280 - Fix building X11 tests on PE targets.
 281
 282   Contributed by Jon Turney <@dronecode.org.uk>
 283
 284 - The tests no longer rely on bash, only Python (which is already used by
 285   meson).
 286
 287 - New API:
 288   xkb_utf32_to_keysym
 289   xkb_keymap_key_get_mods_for_level
 290   XKB_KEY_XF86FullScreen
 291
 292
 293 libxkbcommon 0.10.0 - 2020-01-18
 294 ===================
 295
 296 - (security) Fix quadratic complexity in the XKB file parser. See commit
 297   message 7c42945e04a2107827a057245298dedc0475cc88 for details.
 298
 299 - Add $XDG_CONFIG_HOME/xkb to the default search path. If $XDG_CONFIG_HOME
 300   is not set, $HOME/.config/xkb is used. If $HOME is not set, the path is not
 301   added.
 302
 303   The XDG path is looked up before the existing default search path $HOME/.xkb.
 304
 305   Contributed by Peter Hutterer <@who-t.net>.
 306
 307 - Add support for include statements in XKB rules files.
 308
 309   This is a step towards making local XKB customizations more tenable and
 310   convenient, without modifying system files.
 311
 312   You can now include other rules files like this:
 313
 314       ! include %S/evdev
 315
 316   Two directives are supported, %H to $HOME and %S for the system-installed
 317   rules directory (usually /usr/share/X11/xkb/rules).
 318
 319   See commit message ca033a29d2ca910fd17b1ae287cb420205bdddc8 and
 320   doc/rules-format.txt in the xkbcommon source code for more information.
 321
 322   Contributed by Peter Hutterer <@who-t.net>.
 323
 324 - Downgrade "Symbol added to modifier map for multiple modifiers" log to a
 325   warning.
 326
 327   This error message was too annoying to be shown by default. When working on
 328   keymaps, set `XKB_LOG_LEVEL=debug XKB_LOG_VERBOSITY=10` to see all possible
 329   messages.
 330
 331 - Support building on Windows using the meson MSVC backend.
 332
 333   Contributed by Adrian Perez de Castro <@igalia.com>.
 334
 335 - Fix bug where the merge mode only applied to the first vmod in a
 336   `virtual_modifiers` statement. Given
 337
 338       augment virtual_modifiers NumLock,Alt,LevelThree
 339
 340   Previously it was incorrectly treated as
 341
 342       augment virtual_modifiers NumLock;
 343       virtual_modifiers Alt;
 344       virtual_modifiers LevelThree;
 345
 346   Now it is treated as
 347
 348       augment virtual_modifiers NumLock;
 349       augment virtual_modifiers Alt;
 350       augment virtual_modifiers LevelThree;
 351
 352 - Reject interpret modifier predicate with more than one value. Given
 353
 354       interpret ISO_Level3_Shift+AnyOf(all,extraneous) { ... };
 355
 356   Previously, extraneous (and further) was ignored. Now it's rejected.
 357
 358 - Correctly handle capitalization of the ssharp keysym.
 359
 360 - Speed up and improve the internal `xkeyboard-config` tool. This tool
 361   compiles all layout/variant combinations in the xkeyboard-config dataset
 362   and reports any issues it finds.
 363
 364   Contributed by Peter Hutterer <@who-t.net>.
 365
 366 - Speed up "atoms" (string interning). This code goes back at least to X11R1
 367   (released 1987).
 368
 369
 370 libxkbcommon 0.9.1 - 2019-10-19
 371 ==================
 372
 373 - Fix context creation failing when run in privileged processes as defined by
 374   `secure_getenv(3)`, e.g. GDM.
 375
 376
 377 libxkbcommon 0.9.0 - 2019-10-19
 378 ==================
 379
 380 - Move ~/.xkb to before XKB_CONFIG_ROOT (the system XKB path, usually
 381   /usr/share/X11/xkb) in the default include path. This enables the user
 382   to have full control of the keymap definitions, instead of only augmenting
 383   them.
 384
 385 - Remove the Autotools build system. Use the meson build system instead.
 386
 387 - Fix invalid names used for levels above 8 when dumping keymaps. Previously,
 388   e.g. "Level20" was dumped, but only up to "Level8" is accepted by the
 389   parser. Now "20" is dumped.
 390
 391 - Change level references to always be dumped as e.g. "5" instead of "Level5".
 392
 393   Change group references to always be dumped capitalized e.g. "Group3" instead
 394   of "group3". Previously it was inconsistent.
 395
 396   These changes affect the output of xkb_keymap_get_as_string().
 397
 398 - Fix several build issues on macOS/Darwin, Solaris, NetBSD, cross compilation.
 399
 400 - Port the interactive-wayland test program to the stable version of xdg-shell.
 401
 402
 403 libxkbcommon 0.8.4 - 2019-02-22
 404 ==================
 405
 406 - Fix build of xkbcommon-x11 static library with meson.
 407
 408 - Fix building using meson from the tarball generated by autotools.
 409
 410
 411 libxkbcommon 0.8.3 - 2019-02-08
 412 ==================
 413
 414 - Fix build of static libraries with meson.
 415   (Future note: xkbcommon-x11 was *not* fixed in this release.)
 416
 417 - New API:
 418   XKB_KEY_XF86MonBrightnessCycle
 419   XKB_KEY_XF86RotationLockToggle
 420
 421
 422 libxkbcommon 0.8.2 - 2018-08-05
 423 ==================
 424
 425 - Fix various problems found with fuzzing (see commit messages for
 426   more details):
 427
 428     - Fix a few NULL-dereferences, out-of-bounds access and undefined behavior
 429       in the XKB text format parser.
 430
 431
 432 libxkbcommon 0.8.1 - 2018-08-03
 433 ==================
 434
 435 - Fix various problems found in the meson build (see commit messages for more
 436   details):
 437
 438     - Fix compilation on Darwin.
 439
 440     - Fix compilation of the x11 tests and demos when XCB is installed in a
 441       non-standard location.
 442
 443     - Fix xkbcommon-x11.pc missing the Requires specification.
 444
 445 - Fix various problems found with fuzzing and Coverity (see commit messages for
 446   more details):
 447
 448     - Fix stack overflow in the XKB text format parser when evaluating boolean
 449       negation.
 450
 451     - Fix NULL-dereferences in the XKB text format parser when some unsupported
 452       tokens appear (the tokens are still parsed for backward compatibility).
 453
 454     - Fix NULL-dereference in the XKB text format parser when parsing an
 455       xkb_geometry section.
 456
 457     - Fix an infinite loop in the Compose text format parser on some inputs.
 458
 459     - Fix an invalid free() when using multiple keysyms.
 460
 461 - Replace the Unicode characters for the leftanglebracket and rightanglebracket
 462   keysyms from the deprecated LEFT/RIGHT-POINTING ANGLE BRACKET to
 463   MATHEMATICAL LEFT/RIGHT ANGLE BRACKET.
 464
 465 - Reject out-of-range Unicode codepoints in xkb_keysym_to_utf8 and
 466   xkb_keysym_to_utf32.
 467
 468
 469 libxkbcommon 0.8.0 - 2017-12-15
 470 ==================
 471
 472 - Added xkb_keysym_to_{upper,lower} to perform case-conversion directly on
 473   keysyms. This is useful in some odd cases, but working with the Unicode
 474   representations should be preferred when possible.
 475
 476 - Added Unicode conversion rules for the signifblank and permille keysyms.
 477
 478 - Fixed a bug in the parsing of XKB key type definitions where the number
 479   of levels were determined by the number of level *names*. Keymaps which
 480   omit level names were hence miscompiled.
 481
 482   This regressed in version 0.4.3. Keymaps from xkeyboard-config were not
 483   affected since they don't omit level names.
 484
 485 - New API:
 486   xkb_keysym_to_upper()
 487   xkb_keysym_to_lower()
 488
 489
 490 libxkbcommon 0.7.2 - 2017-08-04
 491 ==================
 492
 493 - Added a Meson build system as an alternative to existing autotools build
 494   system.
 495
 496   The intent is to remove the autotools build in one of the next releases.
 497   Please try to convert to it and report any problems.
 498
 499   See http://mesonbuild.com/Quick-guide.html for basic usage, the
 500   meson_options.txt for the project-specific configuration options,
 501   and the PACKAGING file for more details.
 502
 503   There are some noteworthy differences compared to the autotools build:
 504
 505   - Feature auto-detection is not performed. By default, all features are
 506     enabled (currently: docs, x11, wayland). The build fails if any of
 507     the required dependencies are not available. To disable a feature,
 508     pass -Denable-<feature>=false to meson.
 509
 510   - The libraries are either installed as shared or static, as specified
 511     by the -Ddefault_library=shared/static option. With autotools, both
 512     versions are installed by default.
 513
 514   - xorg-util-macros is not used.
 515
 516   - A parser generator (bison/byacc) is always required - there is no
 517     fallback to pre-generated output bundled in the tarball, as there is
 518     in autotools.
 519
 520 - Removed Android.mk support.
 521
 522 - Removed the *-uninstalled.pc pkgconfig files.
 523
 524 - Ported the interactive-wayland demo program to v6 of the xdg-shell
 525   protocol.
 526
 527 - Added new keysym definitions from xproto.
 528
 529 - New API:
 530   XKB_KEY_XF86Keyboard
 531   XKB_KEY_XF86WWAN
 532   XKB_KEY_XF86RFKill
 533   XKB_KEY_XF86AudioPreset
 534
 535
 536 libxkbcommon 0.7.1 - 2017-01-18
 537 ==================
 538
 539 - Fixed various reported problems when the current locale is tr_TR.UTF-8.
 540
 541   The function xkb_keysym_from_name() used to perform case-insensitive
 542   string comparisons in a locale-dependent way, but required it to to
 543   work as in the C/ASCII locale (the so called "Turkish i problem").
 544
 545   The function is now no longer affected by the current locale.
 546
 547 - Fixed compilation in NetBSD.
 548
 549
 550 libxkbcommon 0.7.0 - 2016-11-11
 551 ==================
 552
 553 - Added support for different "modes" of calculating consumed modifiers.
 554   The existing mode, based on the XKB standard, has proven to be
 555   unintuitive in various shortcut implementations.
 556
 557   A new mode, based on the calculation used by the GTK toolkit, is added.
 558   This mode is less eager to declare a modifier as consumed.
 559
 560 - Added a new interactive demo program using the Wayland protocol.
 561   See the PACKAGING file for the new (optional) test dependencies.
 562
 563 - Fixed a compilation error on GNU Hurd.
 564
 565 - New API:
 566   enum xkb_consumed_mode
 567   XKB_CONSUMED_MODE_XKB
 568   XKB_CONSUMED_MODE_GTK
 569   xkb_state_key_get_consumed_mods2
 570   xkb_state_mod_index_is_consumed2
 571
 572
 573 libxkbcommon 0.6.1 - 2016-04-08
 574 ==================
 575
 576 - Added LICENSE to distributed files in tarball releases.
 577
 578 - Minor typo fix in xkb_keymap_get_as_string() documentation.
 579
 580
 581 libxkbcommon 0.6.0 - 2016-03-16
 582 ==================
 583
 584 - If the XKB_CONFIG_ROOT environment variable is set, it is used as the XKB
 585   configuration root instead of the path determined at build time.
 586
 587 - Tests and benchmarks now build correctly on OSX.
 588
 589 - An XKB keymap provides a name for each key it defines.  Traditionally,
 590   these names are limited to at most 4 characters, and are thus somewhat
 591   obscure, but might still be useful (xkbcommon lifts the 4 character limit).
 592
 593   The new functions xkb_keymap_key_get_name() and xkb_keymap_key_by_name()
 594   can be used to get the name of a key or find a key by name.  Note that
 595   a key may have aliases.
 596
 597 - Documentation improvements.
 598
 599 - New API:
 600   xkb_keymap_key_by_name()
 601   xkb_keymap_key_get_name()
 602
 603
 604 libxkbcommon 0.5.0 - 2014-10-18
 605 ==================
 606
 607 - Added support for Compose/dead keys in a new module (included in
 608   libxkbcommon). See the documentation or the
 609   xkbcommon/xkbcommon-compose.h header file for more details.
 610
 611 - Improved and reordered some sections of the documentation.
 612
 613 - The doxygen HTML pages were made nicer to read.
 614
 615 - Most tests now run also on non-linux platforms.
 616
 617 - A warning is emitted by default about RMLVO values which are not used
 618   during keymap compilation, which are most often a user misconfiguration.
 619   For example, "terminate:ctrl_alt_backspace" instead of
 620   "terminate:ctrl_alt_bksp".
 621
 622 - Added symbol versioning for libxkbcommon and libxkbcommon-x11.
 623   Note: binaries compiled against this and future versions will not be
 624   able to link against the previous versions of the library.
 625
 626 - Removed several compatablity symbols from the binary (the API isn't
 627   affected). This affects binaries which
 628
 629   1. Were compiled against a pre-stable (<0.2.0) version of libxkbcommon, and
 630   2. Are linked against the this or later version of libxkbcommon.
 631
 632   Such a scenario is likely to fail already.
 633
 634 - If Xvfb is not available, the x11comp test is now correctly skipped
 635   instead of hanging.
 636
 637 - Benchmarks were moved to a separate bench/ directory.
 638
 639 - Build fixes from OpenBSD.
 640
 641 - Fixed a bug where key type entries such as "map[None] = Level2;" were
 642   ignored.
 643
 644 - New API:
 645   XKB_COMPOSE_*
 646   xkb_compose_*
 647
 648
 649 libxkbcommon 0.4.3 - 2014-08-19
 650 ==================
 651
 652 - Fixed a bug which caused xkb_x11_keymap_new_from_device() to misrepresent
 653   modifiers for some keymaps.
 654
 655   https://github.com/xkbcommon/libxkbcommon/issues/9
 656
 657 - Fixed a bug which caused xkb_x11_keymap_new_from_device() to ignore XKB
 658   PrivateAction's.
 659
 660 - Modifiers are now always fully resolved after xkb_state_update_mask().
 661   Previously the given state components were used as-is, without
 662   considering virtual modifier mappings.
 663   Note: this only affects non-standard uses of xkb_state_update_mask().
 664
 665 - Added a test for xkbcommon-x11, "x11comp". The test uses the system's
 666   Xvfb server and xkbcomp. If they do not exist or fail, the test is
 667   skipped.
 668
 669 - Fixed memory leaks after parse errors in the XKB yacc parser.
 670   The fix required changes which are currently incompatible with byacc.
 671
 672
 673 libxkbcommon 0.4.2 - 2014-05-15
 674 ==================
 675
 676 - Fixed a bug where explicitly passing "--enable-x11" to ./configure would
 677   in fact disable it (regressed in 0.4.1).
 678
 679 - Added @since version annotations to the API documentation for everything
 680   introduced after the initial stable release (0.2.0).
 681
 682 - Added a section to the documentation about keysym transformations, and
 683   clarified which functions perform a given transformation.
 684
 685 - XKB files which fail to compile during keymap construction can no longer
 686   have any effect on the resulting keymap: changes are only applied when
 687   the entire compilation succeeds.
 688   Note: this was a minor correctness issue inherited from xkbcomp.
 689
 690 - Fix an out-of-bounds array access in src/x11/util.c:adopt_atoms()
 691   error-handling code.
 692   Note: it seems impossible to trigger in the current code since the input
 693   size cannot exceed the required size.
 694
 695
 696 libxkbcommon 0.4.1 - 2014-03-27
 697 ==================
 698
 699 - Converted README to markdown and added a Quick Guide to the
 700   documentation, which breezes through the most common parts of
 701   xkbcommon.
 702
 703 - Added two new functions, xkb_state_key_get_utf{8,32}(). They
 704   combine the operations of xkb_state_key_get_syms() and
 705   xkb_keysym_to_utf{8,32}(), and provide a nicer interface for it
 706   (espcially for multiple-keysyms-per-level).
 707
 708 - The xkb_state_key_get_utf{8,32}() functions now apply Control
 709   transformation: when the Control modifier is active, the string
 710   is converted to an appropriate control character.
 711   This matches the behavior of libX11's XLookupString(3), and
 712   required by the XKB specification:
 713   https://www.x.org/releases/current/doc/kbproto/xkbproto.html#Interpreting_the_Control_Modifier
 714
 715   https://bugs.freedesktop.org/show_bug.cgi?id=75892
 716
 717 - The consumed modifiers for a key are now calculated similarly
 718   to libX11. The previous behavior caused a bug where Shift would
 719   not cancel an active Caps Lock.
 720
 721 - Make xkbcommon-x11 work with the keymap reported by the XQuartz
 722   X server.
 723
 724   https://bugs.freedesktop.org/show_bug.cgi?id=75798
 725
 726 - Reduce memory usage during keymap compilation some more.
 727
 728 - New API:
 729   xkb_state_key_get_consumed_mods()
 730   xkb_state_key_get_utf8()
 731   xkb_state_key_get_utf32()
 732
 733 - Deprecated API:
 734   XKB_MAP_COMPILE_PLACEHOLDER, XKB_MAP_NO_FLAGS
 735     use XKB_KEYMAP_NO_FLAGS instead.
 736
 737 - Bug fixes.
 738
 739
 740 libxkbcommon 0.4.0 - 2014-02-02
 741 ==================
 742
 743 - Add a new add-on library, xkbcommon-x11, to support creating keymaps
 744   with the XKB X11 protocol, by querying the X server directly.
 745   See the xkbcommon/xkbcommon-x11.h header file for more details.
 746   This library requires libxcb-xkb >= 1.10, and is enabled by default.
 747   It can be disabled with the --disable-x11 configure switch.
 748   Distributions are encouraged to split the necessary files for this
 749   library (libxkbcommon-x11.so, xkbcommon-x11.pc, xkbcommon/xkbcommon-x11.h)
 750   to a separate package, such that the main package does not depend on
 751   X11 libraries.
 752
 753 - Fix the keysym <-> name lookup table to not require huge amounts of
 754   relocations.
 755
 756 - Fix a bug in the keysym <-> name lookup, whereby lookup might fail in
 757   some rare cases.
 758
 759 - Reduce memory usage during keymap compilation.
 760
 761 - New API:
 762   New keysyms from xproto 7.0.25 (German T3 layout keysyms).
 763   XKB_MOD_NAME_NUM for the usual NumLock modifier.
 764   xkb_x11_* types and functions, XKB_X11_* constants.
 765
 766
 767 libxkbcommon 0.3.2 - 2013-11-22
 768 ==================
 769
 770 - Log messages from the library now look like "xkbcommon: ERROR" by
 771   default, instead of xkbcomp-like "Error:   ".
 772
 773 - Apply capitalization transformation on keysyms in
 774   xkb_keysym_get_one_sym(), to match the behavior specified in the XKB
 775   specification:
 776   https://www.x.org/releases/current/doc/kbproto/xkbproto.html#Interpreting_the_Lock_Modifier
 777
 778 - Support byacc for generating the parser, in addition to Bison.
 779
 780 - New API:
 781   XKB_KEY_XF86AudioMicMute keysym from xproto 7.0.24.
 782   XKB_KEYSYM_NO_FLAGS
 783   XKB_CONTEXT_NO_FLAGS
 784   XKB_MAP_COMPILE_NO_FLAGS
 785
 786 - Bug fixes.
 787
 788
 789 libxkbcommon 0.3.1 - 2013-06-03
 790 ==================
 791
 792 - Replace the flex scanner with a hand-written one. flex is no longer
 793   a build requirement.
 794
 795 - New API:
 796   xkb_keymap_min_keycode()
 797   xkb_keymap_max_keycode()
 798   xkb_keymap_key_for_each()
 799
 800
 801 libxkbcommon 0.3.0 - 2013-04-01
 802 ==================
 803
 804 - Allow passing NULL to *_unref() functions; do nothing instead of
 805   crashing.
 806
 807 - The functions xkb_keymap_num_levels_for_key() and
 808   xkb_keymap_get_syms_by_level() now allow out-of-range values for the
 809   'layout' parameter. The functions now wrap the value around the number
 810   of layouts instead of failing.
 811
 812 - The function xkb_keysym_get_name() now types unicode keysyms in
 813   uppercase and 0-padding, to match the format used by XKeysymToString().
 814
 815 - Building Linux-specific tests is no longer attempted on non-Linux
 816   environments.
 817
 818 - The function xkb_keymap_new_from_names() now accepts a NULL value for
 819   the 'names' parameter, instead of failing. This is equivalent to passing
 820   a 'struct xkb_rule_names' with all fields set to NULL.
 821
 822 - New API:
 823   xkb_keymap_new_from_buffer()
 824
 825 - Bug fixes.