NEWS

   1 libxkbcommon 0.6.0 - 2016-03-16
   2 ==================
   3
   4 - If the XKB_CONFIG_ROOT environment variable is set, it is used as the XKB
   5   configuration root instead of the path determined at build time.
   6
   7 - Tests and benchmarks now build correctly on OSX.
   8
   9 - An XKB keymap provides a name for each key it defines.  Traditionally,
  10   these names are limited to at most 4 characters, and are thus somewhat
  11   obscure, but might still be useful (xkbcommon lifts the 4 character limit).
  12
  13   The new functions xkb_keymap_key_get_name() and xkb_keymap_key_by_name()
  14   can be used to get the name of a key or find a key by name.  Note that
  15   a key may have aliases.
  16
  17 - Documentation improvements.
  18
  19 - New API:
  20   xkb_keymap_key_by_name()
  21   xkb_keymap_key_get_name()
  22
  23
  24 libxkbcommon 0.5.0 - 2014-10-18
  25 ==================
  26
  27 - Added support for Compose/dead keys in a new module (included in
  28   libxkbcommon). See the documentation or the
  29   xkbcommon/xkbcommon-compose.h header file for more details.
  30
  31 - Improved and reordered some sections of the documentation.
  32
  33 - The doxygen HTML pages were made nicer to read.
  34
  35 - Most tests now run also on non-linux platforms.
  36
  37 - A warning is emitted by default about RMLVO values which are not used
  38   during keymap compilation, which are most often a user misconfiguration.
  39   For example, "terminate:ctrl_alt_backspace" instead of
  40   "terminate:ctrl_alt_bksp".
  41
  42 - Added symbol versioning for libxkbcommon and libxkbcommon-x11.
  43   Note: binaries compiled against this and future versions will not be
  44   able to link against the previous versions of the library.
  45
  46 - Removed several compatablity symbols from the binary (the API isn't
  47   affected). This affects binaries which
  48
  49   1. Were compiled against a pre-stable (<0.2.0) version of libxkbcommon, and
  50   2. Are linked against the this or later version of libxkbcommon.
  51
  52   Such a scenario is likely to fail already.
  53
  54 - If Xvfb is not available, the x11comp test is now correctly skipped
  55   instead of hanging.
  56
  57 - Benchmarks were moved to a separate bench/ directory.
  58
  59 - Build fixes from OpenBSD.
  60
  61 - Fixed a bug where key type entries such as "map[None] = Level2;" were
  62   ignored.
  63
  64 - New API:
  65   XKB_COMPOSE_*
  66   xkb_compose_*
  67
  68
  69 libxkbcommon 0.4.3 - 2014-08-19
  70 ==================
  71
  72 - Fixed a bug which caused xkb_x11_keymap_new_from_device() to misrepresent
  73   modifiers for some keymaps.
  74
  75   https://github.com/xkbcommon/libxkbcommon/issues/9
  76
  77 - Fixed a bug which caused xkb_x11_keymap_new_from_device() to ignore XKB
  78   PrivateAction's.
  79
  80 - Modifiers are now always fully resolved after xkb_state_update_mask().
  81   Previously the given state components were used as-is, without
  82   considering virtual modifier mappings.
  83   Note: this only affects non-standard uses of xkb_state_update_mask().
  84
  85 - Added a test for xkbcommon-x11, "x11comp". The test uses the system's
  86   Xvfb server and xkbcomp. If they do not exist or fail, the test is
  87   skipped.
  88
  89 - Fixed memory leaks after parse errors in the XKB yacc parser.
  90   The fix required changes which are currently incompatible with byacc.
  91
  92
  93 libxkbcommon 0.4.2 - 2014-05-15
  94 ==================
  95
  96 - Fixed a bug where explicitly passing "--enable-x11" to ./configure would
  97   in fact disable it (regressed in 0.4.1).
  98
  99 - Added @since version annotations to the API documentation for everything
 100   introduced after the initial stable release (0.2.0).
 101
 102 - Added a section to the documentation about keysym transformations, and
 103   clarified which functions perform a given transformation.
 104
 105 - XKB files which fail to compile during keymap construction can no longer
 106   have any effect on the resulting keymap: changes are only applied when
 107   the entire compilation succeeds.
 108   Note: this was a minor correctness issue inherited from xkbcomp.
 109
 110 - Fix an out-of-bounds array access in src/x11/util.c:adopt_atoms()
 111   error-handling code.
 112   Note: it seems impossible to trigger in the current code since the input
 113   size cannot exceed the required size.
 114
 115
 116 libxkbcommon 0.4.1 - 2014-03-27
 117 ==================
 118
 119 - Converted README to markdown and added a Quick Guide to the
 120   documentation, which breezes through the most common parts of
 121   xkbcommon.
 122
 123 - Added two new functions, xkb_state_key_get_utf{8,32}(). They
 124   combine the operations of xkb_state_key_get_syms() and
 125   xkb_keysym_to_utf{8,32}(), and provide a nicer interface for it
 126   (espcially for multiple-keysyms-per-level).
 127
 128 - The xkb_state_key_get_utf{8,32}() functions now apply Control
 129   transformation: when the Control modifier is active, the string
 130   is converted to an appropriate control character.
 131   This matches the behavior of libX11's XLookupString(3), and
 132   required by the XKB specification:
 133   http://www.x.org/releases/current/doc/kbproto/xkbproto.html#Interpreting_the_Control_Modifier
 134
 135   https://bugs.freedesktop.org/show_bug.cgi?id=75892
 136
 137 - The consumed modifiers for a key are now calculated similarly
 138   to libX11. The previous behavior caused a bug where Shift would
 139   not cancel an active Caps Lock.
 140
 141 - Make xkbcommon-x11 work with the keymap reported by the XQuartz
 142   X server.
 143
 144   https://bugs.freedesktop.org/show_bug.cgi?id=75798
 145
 146 - Reduce memory usage during keymap compilation some more.
 147
 148 - New API:
 149   xkb_state_key_get_consumed_mods()
 150   xkb_state_key_get_utf8()
 151   xkb_state_key_get_utf32()
 152
 153 - Deprecated API:
 154   XKB_MAP_COMPILE_PLACEHOLDER, XKB_MAP_NO_FLAGS
 155     use XKB_KEYMAP_NO_FLAGS instead.
 156
 157 - Bug fixes.
 158
 159
 160 libxkbcommon 0.4.0 - 2014-02-02
 161 ==================
 162
 163 - Add a new add-on library, xkbcommon-x11, to support creating keymaps
 164   with the XKB X11 protocol, by querying the X server directly.
 165   See the xkbcommon/xkbcommon-x11.h header file for more details.
 166   This library requires libxcb-xkb >= 1.10, and is enabled by default.
 167   It can be disabled with the --disable-x11 configure switch.
 168   Distributions are encouraged to split the necessary files for this
 169   library (libxkbcommon-x11.so, xkbcommon-x11.pc, xkbcommon/xkbcommon-x11.h)
 170   to a separate package, such that the main package does not depend on
 171   X11 libraries.
 172
 173 - Fix the keysym <-> name lookup table to not require huge amounts of
 174   relocations.
 175
 176 - Fix a bug in the keysym <-> name lookup, whereby lookup might fail in
 177   some rare cases.
 178
 179 - Reduce memory usage during keymap compilation.
 180
 181 - New API:
 182   New keysyms from xproto 7.0.25 (German T3 layout keysyms).
 183   XKB_MOD_NAME_NUM for the usual NumLock modifier.
 184   xkb_x11_* types and functions, XKB_X11_* constants.
 185
 186
 187 libxkbcommon 0.3.2 - 2013-11-22
 188 ==================
 189
 190 - Log messages from the library now look like "xkbcommon: ERROR" by
 191   default, instead of xkbcomp-like "Error:   ".
 192
 193 - Apply capitalization transformation on keysyms in
 194   xkb_keysym_get_one_sym(), to match the behavior specified in the XKB
 195   specification:
 196   http://www.x.org/releases/current/doc/kbproto/xkbproto.html#Interpreting_the_Lock_Modifier
 197
 198 - Support byacc for generating the parser, in addition to Bison.
 199
 200 - New API:
 201   XKB_KEY_XF86AudioMicMute keysym from xproto 7.0.24.
 202   XKB_KEYSYM_NO_FLAGS
 203   XKB_CONTEXT_NO_FLAGS
 204   XKB_MAP_COMPILE_NO_FLAGS
 205
 206 - Bug fixes.
 207
 208
 209 libxkbcommon 0.3.1 - 2013-06-03
 210 ==================
 211
 212 - Replace the flex scanner with a hand-written one. flex is no longer
 213   a build requirement.
 214
 215 - New API:
 216   xkb_keymap_min_keycode()
 217   xkb_keymap_max_keycode()
 218   xkb_keymap_key_for_each()
 219
 220
 221 libxkbcommon 0.3.0 - 2013-04-01
 222 ==================
 223
 224 - Allow passing NULL to *_unref() functions; do nothing instead of
 225   crashing.
 226
 227 - The functions xkb_keymap_num_levels_for_key() and
 228   xkb_keymap_get_syms_by_level() now allow out-of-range values for the
 229   'layout' parameter. The functions now wrap the value around the number
 230   of layouts instead of failing.
 231
 232 - The function xkb_keysym_get_name() now types unicode keysyms in
 233   uppercase and 0-padding, to match the format used by XKeysymToString().
 234
 235 - Building Linux-specific tests is no longer attempted on non-Linux
 236   environments.
 237
 238 - The function xkb_keymap_new_from_names() now accepts a NULL value for
 239   the 'names' parameter, instead of failing. This is equivalent to passing
 240   a 'struct xkb_rule_names' with all fields set to NULL.
 241
 242 - New API:
 243   xkb_keymap_new_from_buffer()
 244
 245 - Bug fixes.