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