NEWS

   1 libxkbcommon 0.10.0 - 2020-01-18
   2 ===================
   3
   4 - (security) Fix quadratic complexity in the XKB file parser. See commit
   5   message 7c42945e04a2107827a057245298dedc0475cc88 for details.
   6
   7 - Add $XDG_CONFIG_HOME/xkb to the default search path. If $XDG_CONFIG_HOME
   8   is not set, $HOME/.config/xkb is used. If $HOME is not set, the path is not
   9   added.
  10
  11   The XDG path is looked up before the existing default search path $HOME/.xkb.
  12
  13   Contributed by Peter Hutterer <@who-t.net>.
  14
  15 - Add support for include statements in XKB rules files.
  16
  17   This is a step towards making local XKB customizations more tenable and
  18   convenient, without modifying system files.
  19
  20   You can now include other rules files like this:
  21
  22       ! include %S/evdev
  23
  24   Two directives are supported, %H to $HOME and %S for the system-installed
  25   rules directory (usually /usr/share/X11/xkb/rules).
  26
  27   See commit message ca033a29d2ca910fd17b1ae287cb420205bdddc8 and
  28   doc/rules-format.txt in the xkbcommon source code for more information.
  29
  30   Contributed by Peter Hutterer <@who-t.net>.
  31
  32 - Downgrade "Symbol added to modifier map for multiple modifiers" log to a
  33   warning.
  34
  35   This error message was too annoying to be shown by default. When working on
  36   keymaps, set `XKB_LOG_LEVEL=debug XKB_LOG_VERBOSITY=10` to see all possible
  37   messages.
  38
  39 - Support building on Windows using the meson MSVC backend.
  40
  41   Contributed by Adrian Perez de Castro <@igalia.com>.
  42
  43 - Fix bug where the merge mode only applied to the first vmod in a
  44   `virtual_modifiers` statement. Given
  45
  46       augment virtual_modifiers NumLock,Alt,LevelThree
  47
  48   Previously it was incorrectly treated as
  49
  50       augment virtual_modifiers NumLock;
  51       virtual_modifiers Alt;
  52       virtual_modifiers LevelThree;
  53
  54   Now it is treated as
  55
  56       augment virtual_modifiers NumLock;
  57       augment virtual_modifiers Alt;
  58       augment virtual_modifiers LevelThree;
  59
  60 - Reject interpret modifier predicate with more than one value. Given
  61
  62       interpret ISO_Level3_Shift+AnyOf(all,extraneous) { ... };
  63
  64   Previously, extraneous (and further) was ignored. Now it's rejected.
  65
  66 - Correctly handle capitalization of the ssharp keysym.
  67
  68 - Speed up and improve the internal `xkeyboard-config` tool. This tool
  69   compiles all layout/variant combinations in the xkeyboard-config dataset
  70   and reports any issues it finds.
  71
  72   Contributed by Peter Hutterer <@who-t.net>.
  73
  74 - Speed up "atoms" (string interning). This code goes back at least to X11R1
  75   (released 1987).
  76
  77
  78 libxkbcommon 0.9.1 - 2019-10-19
  79 ==================
  80
  81 - Fix context creation failing when run in privileged processes as defined by
  82   `secure_getenv(3)`, e.g. GDM.
  83
  84
  85 libxkbcommon 0.9.0 - 2019-10-19
  86 ==================
  87
  88 - Move ~/.xkb to before XKB_CONFIG_ROOT (the system XKB path, usually
  89   /usr/share/X11/xkb) in the default include path. This enables the user
  90   to have full control of the keymap definitions, instead of only augmenting
  91   them.
  92
  93 - Remove the Autotools build system. Use the meson build system instead.
  94
  95 - Fix invalid names used for levels above 8 when dumping keymaps. Previously,
  96   e.g. "Level20" was dumped, but only up to "Level8" is accepted by the
  97   parser. Now "20" is dumped.
  98
  99 - Change level references to always be dumped as e.g. "5" instead of "Level5".
 100
 101   Change group references to always be dumped capitalized e.g. "Group3" instead
 102   of "group3". Previously it was inconsistent.
 103
 104   These changes affect the output of xkb_keymap_get_as_string().
 105
 106 - Fix several build issues on macOS/Darwin, Solaris, NetBSD, cross compilation.
 107
 108 - Port the interactive-wayland test program to the stable version of xdg-shell.
 109
 110
 111 libxkbcommon 0.8.4 - 2019-02-22
 112 ==================
 113
 114 - Fix build of xkbcommon-x11 static library with meson.
 115
 116 - Fix building using meson from the tarball generated by autotools.
 117
 118
 119 libxkbcommon 0.8.3 - 2019-02-08
 120 ==================
 121
 122 - Fix build of static libraries with meson.
 123   (Future note: xkbcommon-x11 was *not* fixed in this release.)
 124
 125 - New API:
 126   XKB_KEY_XF86MonBrightnessCycle
 127   XKB_KEY_XF86RotationLockToggle
 128
 129
 130 libxkbcommon 0.8.2 - 2018-08-05
 131 ==================
 132
 133 - Fix various problems found with fuzzing (see commit messages for
 134   more details):
 135
 136     - Fix a few NULL-dereferences, out-of-bounds access and undefined behavior
 137       in the XKB text format parser.
 138
 139
 140 libxkbcommon 0.8.1 - 2018-08-03
 141 ==================
 142
 143 - Fix various problems found in the meson build (see commit messages for more
 144   details):
 145
 146     - Fix compilation on Darwin.
 147
 148     - Fix compilation of the x11 tests and demos when XCB is installed in a
 149       non-standard location.
 150
 151     - Fix xkbcommon-x11.pc missing the Requires specification.
 152
 153 - Fix various problems found with fuzzing and Coverity (see commit messages for
 154   more details):
 155
 156     - Fix stack overflow in the XKB text format parser when evaluating boolean
 157       negation.
 158
 159     - Fix NULL-dereferences in the XKB text format parser when some unsupported
 160       tokens appear (the tokens are still parsed for backward compatibility).
 161
 162     - Fix NULL-dereference in the XKB text format parser when parsing an
 163       xkb_geometry section.
 164
 165     - Fix an infinite loop in the Compose text format parser on some inputs.
 166
 167     - Fix an invalid free() when using multiple keysyms.
 168
 169 - Replace the Unicode characters for the leftanglebracket and rightanglebracket
 170   keysyms from the deprecated LEFT/RIGHT-POINTING ANGLE BRACKET to
 171   MATHEMATICAL LEFT/RIGHT ANGLE BRACKET.
 172
 173 - Reject out-of-range Unicode codepoints in xkb_keysym_to_utf8 and
 174   xkb_keysym_to_utf32.
 175
 176
 177 libxkbcommon 0.8.0 - 2017-12-15
 178 ==================
 179
 180 - Added xkb_keysym_to_{upper,lower} to perform case-conversion directly on
 181   keysyms. This is useful in some odd cases, but working with the Unicode
 182   representations should be preferred when possible.
 183
 184 - Added Unicode conversion rules for the signifblank and permille keysyms.
 185
 186 - Fixed a bug in the parsing of XKB key type definitions where the number
 187   of levels were determined by the number of level *names*. Keymaps which
 188   omit level names were hence miscompiled.
 189
 190   This regressed in version 0.4.3. Keymaps from xkeyboard-config were not
 191   affected since they don't omit level names.
 192
 193 - New API:
 194   xkb_keysym_to_upper()
 195   xkb_keysym_to_lower()
 196
 197
 198 libxkbcommon 0.7.2 - 2017-08-04
 199 ==================
 200
 201 - Added a Meson build system as an alternative to existing autotools build
 202   system.
 203
 204   The intent is to remove the autotools build in one of the next releases.
 205   Please try to convert to it and report any problems.
 206
 207   See http://mesonbuild.com/Quick-guide.html for basic usage, the
 208   meson_options.txt for the project-specific configuration options,
 209   and the PACKAGING file for more details.
 210
 211   There are some noteworthy differences compared to the autotools build:
 212
 213   - Feature auto-detection is not performed. By default, all features are
 214     enabled (currently: docs, x11, wayland). The build fails if any of
 215     the required dependencies are not available. To disable a feature,
 216     pass -Denable-<feature>=false to meson.
 217
 218   - The libraries are either installed as shared or static, as specified
 219     by the -Ddefault_library=shared/static option. With autotools, both
 220     versions are installed by default.
 221
 222   - xorg-util-macros is not used.
 223
 224   - A parser generator (bison/byacc) is always required - there is no
 225     fallback to pre-generated output bundled in the tarball, as there is
 226     in autotools.
 227
 228 - Removed Android.mk support.
 229
 230 - Removed the *-uninstalled.pc pkgconfig files.
 231
 232 - Ported the interactive-wayland demo program to v6 of the xdg-shell
 233   protocol.
 234
 235 - Added new keysym definitions from xproto.
 236
 237 - New API:
 238   XKB_KEY_XF86Keyboard
 239   XKB_KEY_XF86WWAN
 240   XKB_KEY_XF86RFKill
 241   XKB_KEY_XF86AudioPreset
 242
 243
 244 libxkbcommon 0.7.1 - 2017-01-18
 245 ==================
 246
 247 - Fixed various reported problems when the current locale is tr_TR.UTF-8.
 248
 249   The function xkb_keysym_from_name() used to perform case-insensitive
 250   string comparisons in a locale-dependent way, but required it to to
 251   work as in the C/ASCII locale (the so called "Turkish i problem").
 252
 253   The function is now no longer affected by the current locale.
 254
 255 - Fixed compilation in NetBSD.
 256
 257
 258 libxkbcommon 0.7.0 - 2016-11-11
 259 ==================
 260
 261 - Added support for different "modes" of calculating consumed modifiers.
 262   The existing mode, based on the XKB standard, has proven to be
 263   unintuitive in various shortcut implementations.
 264
 265   A new mode, based on the calculation used by the GTK toolkit, is added.
 266   This mode is less eager to declare a modifier as consumed.
 267
 268 - Added a new interactive demo program using the Wayland protocol.
 269   See the PACKAGING file for the new (optional) test dependencies.
 270
 271 - Fixed a compilation error on GNU Hurd.
 272
 273 - New API:
 274   enum xkb_consumed_mode
 275   XKB_CONSUMED_MODE_XKB
 276   XKB_CONSUMED_MODE_GTK
 277   xkb_state_key_get_consumed_mods2
 278   xkb_state_mod_index_is_consumed2
 279
 280
 281 libxkbcommon 0.6.1 - 2016-04-08
 282 ==================
 283
 284 - Added LICENSE to distributed files in tarball releases.
 285
 286 - Minor typo fix in xkb_keymap_get_as_string() documentation.
 287
 288
 289 libxkbcommon 0.6.0 - 2016-03-16
 290 ==================
 291
 292 - If the XKB_CONFIG_ROOT environment variable is set, it is used as the XKB
 293   configuration root instead of the path determined at build time.
 294
 295 - Tests and benchmarks now build correctly on OSX.
 296
 297 - An XKB keymap provides a name for each key it defines.  Traditionally,
 298   these names are limited to at most 4 characters, and are thus somewhat
 299   obscure, but might still be useful (xkbcommon lifts the 4 character limit).
 300
 301   The new functions xkb_keymap_key_get_name() and xkb_keymap_key_by_name()
 302   can be used to get the name of a key or find a key by name.  Note that
 303   a key may have aliases.
 304
 305 - Documentation improvements.
 306
 307 - New API:
 308   xkb_keymap_key_by_name()
 309   xkb_keymap_key_get_name()
 310
 311
 312 libxkbcommon 0.5.0 - 2014-10-18
 313 ==================
 314
 315 - Added support for Compose/dead keys in a new module (included in
 316   libxkbcommon). See the documentation or the
 317   xkbcommon/xkbcommon-compose.h header file for more details.
 318
 319 - Improved and reordered some sections of the documentation.
 320
 321 - The doxygen HTML pages were made nicer to read.
 322
 323 - Most tests now run also on non-linux platforms.
 324
 325 - A warning is emitted by default about RMLVO values which are not used
 326   during keymap compilation, which are most often a user misconfiguration.
 327   For example, "terminate:ctrl_alt_backspace" instead of
 328   "terminate:ctrl_alt_bksp".
 329
 330 - Added symbol versioning for libxkbcommon and libxkbcommon-x11.
 331   Note: binaries compiled against this and future versions will not be
 332   able to link against the previous versions of the library.
 333
 334 - Removed several compatablity symbols from the binary (the API isn't
 335   affected). This affects binaries which
 336
 337   1. Were compiled against a pre-stable (<0.2.0) version of libxkbcommon, and
 338   2. Are linked against the this or later version of libxkbcommon.
 339
 340   Such a scenario is likely to fail already.
 341
 342 - If Xvfb is not available, the x11comp test is now correctly skipped
 343   instead of hanging.
 344
 345 - Benchmarks were moved to a separate bench/ directory.
 346
 347 - Build fixes from OpenBSD.
 348
 349 - Fixed a bug where key type entries such as "map[None] = Level2;" were
 350   ignored.
 351
 352 - New API:
 353   XKB_COMPOSE_*
 354   xkb_compose_*
 355
 356
 357 libxkbcommon 0.4.3 - 2014-08-19
 358 ==================
 359
 360 - Fixed a bug which caused xkb_x11_keymap_new_from_device() to misrepresent
 361   modifiers for some keymaps.
 362
 363   https://github.com/xkbcommon/libxkbcommon/issues/9
 364
 365 - Fixed a bug which caused xkb_x11_keymap_new_from_device() to ignore XKB
 366   PrivateAction's.
 367
 368 - Modifiers are now always fully resolved after xkb_state_update_mask().
 369   Previously the given state components were used as-is, without
 370   considering virtual modifier mappings.
 371   Note: this only affects non-standard uses of xkb_state_update_mask().
 372
 373 - Added a test for xkbcommon-x11, "x11comp". The test uses the system's
 374   Xvfb server and xkbcomp. If they do not exist or fail, the test is
 375   skipped.
 376
 377 - Fixed memory leaks after parse errors in the XKB yacc parser.
 378   The fix required changes which are currently incompatible with byacc.
 379
 380
 381 libxkbcommon 0.4.2 - 2014-05-15
 382 ==================
 383
 384 - Fixed a bug where explicitly passing "--enable-x11" to ./configure would
 385   in fact disable it (regressed in 0.4.1).
 386
 387 - Added @since version annotations to the API documentation for everything
 388   introduced after the initial stable release (0.2.0).
 389
 390 - Added a section to the documentation about keysym transformations, and
 391   clarified which functions perform a given transformation.
 392
 393 - XKB files which fail to compile during keymap construction can no longer
 394   have any effect on the resulting keymap: changes are only applied when
 395   the entire compilation succeeds.
 396   Note: this was a minor correctness issue inherited from xkbcomp.
 397
 398 - Fix an out-of-bounds array access in src/x11/util.c:adopt_atoms()
 399   error-handling code.
 400   Note: it seems impossible to trigger in the current code since the input
 401   size cannot exceed the required size.
 402
 403
 404 libxkbcommon 0.4.1 - 2014-03-27
 405 ==================
 406
 407 - Converted README to markdown and added a Quick Guide to the
 408   documentation, which breezes through the most common parts of
 409   xkbcommon.
 410
 411 - Added two new functions, xkb_state_key_get_utf{8,32}(). They
 412   combine the operations of xkb_state_key_get_syms() and
 413   xkb_keysym_to_utf{8,32}(), and provide a nicer interface for it
 414   (espcially for multiple-keysyms-per-level).
 415
 416 - The xkb_state_key_get_utf{8,32}() functions now apply Control
 417   transformation: when the Control modifier is active, the string
 418   is converted to an appropriate control character.
 419   This matches the behavior of libX11's XLookupString(3), and
 420   required by the XKB specification:
 421   https://www.x.org/releases/current/doc/kbproto/xkbproto.html#Interpreting_the_Control_Modifier
 422
 423   https://bugs.freedesktop.org/show_bug.cgi?id=75892
 424
 425 - The consumed modifiers for a key are now calculated similarly
 426   to libX11. The previous behavior caused a bug where Shift would
 427   not cancel an active Caps Lock.
 428
 429 - Make xkbcommon-x11 work with the keymap reported by the XQuartz
 430   X server.
 431
 432   https://bugs.freedesktop.org/show_bug.cgi?id=75798
 433
 434 - Reduce memory usage during keymap compilation some more.
 435
 436 - New API:
 437   xkb_state_key_get_consumed_mods()
 438   xkb_state_key_get_utf8()
 439   xkb_state_key_get_utf32()
 440
 441 - Deprecated API:
 442   XKB_MAP_COMPILE_PLACEHOLDER, XKB_MAP_NO_FLAGS
 443     use XKB_KEYMAP_NO_FLAGS instead.
 444
 445 - Bug fixes.
 446
 447
 448 libxkbcommon 0.4.0 - 2014-02-02
 449 ==================
 450
 451 - Add a new add-on library, xkbcommon-x11, to support creating keymaps
 452   with the XKB X11 protocol, by querying the X server directly.
 453   See the xkbcommon/xkbcommon-x11.h header file for more details.
 454   This library requires libxcb-xkb >= 1.10, and is enabled by default.
 455   It can be disabled with the --disable-x11 configure switch.
 456   Distributions are encouraged to split the necessary files for this
 457   library (libxkbcommon-x11.so, xkbcommon-x11.pc, xkbcommon/xkbcommon-x11.h)
 458   to a separate package, such that the main package does not depend on
 459   X11 libraries.
 460
 461 - Fix the keysym <-> name lookup table to not require huge amounts of
 462   relocations.
 463
 464 - Fix a bug in the keysym <-> name lookup, whereby lookup might fail in
 465   some rare cases.
 466
 467 - Reduce memory usage during keymap compilation.
 468
 469 - New API:
 470   New keysyms from xproto 7.0.25 (German T3 layout keysyms).
 471   XKB_MOD_NAME_NUM for the usual NumLock modifier.
 472   xkb_x11_* types and functions, XKB_X11_* constants.
 473
 474
 475 libxkbcommon 0.3.2 - 2013-11-22
 476 ==================
 477
 478 - Log messages from the library now look like "xkbcommon: ERROR" by
 479   default, instead of xkbcomp-like "Error:   ".
 480
 481 - Apply capitalization transformation on keysyms in
 482   xkb_keysym_get_one_sym(), to match the behavior specified in the XKB
 483   specification:
 484   https://www.x.org/releases/current/doc/kbproto/xkbproto.html#Interpreting_the_Lock_Modifier
 485
 486 - Support byacc for generating the parser, in addition to Bison.
 487
 488 - New API:
 489   XKB_KEY_XF86AudioMicMute keysym from xproto 7.0.24.
 490   XKB_KEYSYM_NO_FLAGS
 491   XKB_CONTEXT_NO_FLAGS
 492   XKB_MAP_COMPILE_NO_FLAGS
 493
 494 - Bug fixes.
 495
 496
 497 libxkbcommon 0.3.1 - 2013-06-03
 498 ==================
 499
 500 - Replace the flex scanner with a hand-written one. flex is no longer
 501   a build requirement.
 502
 503 - New API:
 504   xkb_keymap_min_keycode()
 505   xkb_keymap_max_keycode()
 506   xkb_keymap_key_for_each()
 507
 508
 509 libxkbcommon 0.3.0 - 2013-04-01
 510 ==================
 511
 512 - Allow passing NULL to *_unref() functions; do nothing instead of
 513   crashing.
 514
 515 - The functions xkb_keymap_num_levels_for_key() and
 516   xkb_keymap_get_syms_by_level() now allow out-of-range values for the
 517   'layout' parameter. The functions now wrap the value around the number
 518   of layouts instead of failing.
 519
 520 - The function xkb_keysym_get_name() now types unicode keysyms in
 521   uppercase and 0-padding, to match the format used by XKeysymToString().
 522
 523 - Building Linux-specific tests is no longer attempted on non-Linux
 524   environments.
 525
 526 - The function xkb_keymap_new_from_names() now accepts a NULL value for
 527   the 'names' parameter, instead of failing. This is equivalent to passing
 528   a 'struct xkb_rule_names' with all fields set to NULL.
 529
 530 - New API:
 531   xkb_keymap_new_from_buffer()
 532
 533 - Bug fixes.