NEWS

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