NEWS

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