NEWS

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