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