NEWS

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