Bump version to 1.0.2
[platform/upstream/libxkbcommon.git] / NEWS
1 libxkbcommon 1.0.2 - 2020-11-20
2 ==================
3
4 - Fix a bug where a keysym that cannot be resolved in a keymap gets compiled to
5   a garbage keysym. Now it is set to XKB_KEY_NoSymbol instead.
6
7 - Improve the speed of xkb_x11_keymap_new_from_device() on repeated calls in the
8   same xkb_context().
9
10
11 libxkbcommon 1.0.1 - 2020-09-11
12 ==================
13
14 - Fix the tool-option-parsing test failing.
15
16 - Remove requirement for pytest in the tool-option-parsing test.
17
18 - Make the table output of `xkbcli how-to-type` aligned.
19
20 - Some portability and test isolation fixes.
21
22 libxkbcommon 1.0.0 - 2020-09-05
23 ==================
24
25 Note: this release is API and ABI compatible with previous releases -- the
26 major version bump is only an indication of stability.
27
28 - Add libxkbregistry as configure-time optional library. libxkbregistry is a C
29   library that lists available XKB models, layouts and variants for a given
30   ruleset. This is a separate library (libxkbregistry.so, pkgconfig file
31   xkbregistry.pc) and aimed at tools that provide a listing of available
32   keyboard layouts to the user. See the Documentation for details on the API.
33
34   Contributed by Peter Hutterer <@who-t.net>.
35
36 - Better support custom user configuration:
37
38     * Allow including XKB files from other paths.
39
40       Previously, a 'symbols/us' file in path A would shadow the same file in
41       path B. This is suboptimal, we rarely need to hide the system files - we
42       care mostly about *extending* them. By continuing to check other lookup
43       paths, we make it possible for a XDG_CONFIG_HOME/xkb/symbols/us file to
44       have sections including those from /usr/share/X11/xkb/symbols/us.
45
46       Note that this is not possible for rules files, which need to be manually
47       controlled to get the right bits resolved.
48
49     * Add /etc/xkb as extra lookup path for system data files.
50
51       This completes the usual triplet of configuration locations available for
52       most processes:
53       - vendor-provided data files in /usr/share/X11/xkb
54       - system-specific data files in /etc/xkb
55       - user-specific data files in $XDG_CONFIG_HOME/xkb
56
57       The default lookup order user, system, vendor, just like everything else
58       that uses these conventions.
59
60       For include directives in rules files, the '%E' resolves to that path.
61
62     * Add a new section to the documentation for custom user configuration.
63
64   Contributed by Peter Hutterer <@who-t.net>.
65
66 - Add an `xkbcli` command-line utility.
67
68   This tool offers various subcommands for introspection and debugging.
69   Currently the available subcommands are:
70
71   list
72     List available rules, models, layouts, variants and options
73
74   interactive-wayland
75     Interactive debugger for XKB keymaps for Wayland
76
77   interactive-x11
78     Interactive debugger for XKB keymaps for X11
79
80   interactive-evdev
81     Interactive debugger for XKB keymaps for evdev (Linux)
82
83   compile-keymap
84     Compile an XKB keymap
85
86   how-to-type
87     See separate entry below.
88
89   See the manpages for usage information.
90
91   Contributed by Peter Hutterer <@who-t.net>.
92
93 - Add `xkb_utf32_to_keysym()` to translate a Unicode codepoint to a keysym.
94   When a special keysym (`XKB_KEY_` constant) for the codepoint exists, it is
95   returned, otherwise the direct encoding is used, if permissible.
96
97   Contributed by Jaroslaw Kubik <@froglogic.com>.
98
99 - Add `xkb_keymap_key_get_mods_for_level()` which retrieves sets of modifiers
100   which produce a given shift level in a given key+layout.
101
102   Contributed by Jaroslaw Kubik <@froglogic.com>.
103
104 - Add `xkbcli how-to-type` command, which, using `xkb_utf32_to_keysym()`
105   and `xkb_keymap_key_get_mods_for_level()` and other APIs, prints out all
106   the ways to produce a given keysym.
107
108   For example, how to type `?` (codepoint 63) in a us,de keymap?
109
110     $ xkbcli how-to-type --layout us,de 63 | column -ts $'\t'
111     keysym: question (0x3f)
112     KEYCODE  KEY NAME  LAYOUT#  LAYOUT NAME   LEVEL#  MODIFIERS
113     20       AE11      2        German        2       [ Shift ]
114     20       AE11      2        German        2       [ Shift Lock ]
115     61       AB10      1        English (US)  2       [ Shift ]
116
117 - Add a new section to the documentation describing the format of the XKB
118   rules file.
119
120 - Search for Compose in $XDG_CONFIG_HOME/XCompose (fallback to
121   ~/.config/XCompose) before trying $HOME/.XCompose.
122
123   Note that libX11 still only searches in $HOME/.XCompose.
124
125   Contributed by Emmanuel Gil Peyrot <@linkmauve.fr>.
126
127 - Bump meson requirement to >= 0.49.0.
128
129 - Fix build with byacc.
130
131 - Fix building X11 tests on PE targets.
132
133   Contributed by Jon Turney <@dronecode.org.uk>
134
135 - The tests no longer rely on bash, only Python (which is already used by
136   meson).
137
138 - New API:
139   xkb_utf32_to_keysym
140   xkb_keymap_key_get_mods_for_level
141   XKB_KEY_XF86FullScreen
142
143
144 libxkbcommon 0.10.0 - 2020-01-18
145 ===================
146
147 - (security) Fix quadratic complexity in the XKB file parser. See commit
148   message 7c42945e04a2107827a057245298dedc0475cc88 for details.
149
150 - Add $XDG_CONFIG_HOME/xkb to the default search path. If $XDG_CONFIG_HOME
151   is not set, $HOME/.config/xkb is used. If $HOME is not set, the path is not
152   added.
153
154   The XDG path is looked up before the existing default search path $HOME/.xkb.
155
156   Contributed by Peter Hutterer <@who-t.net>.
157
158 - Add support for include statements in XKB rules files.
159
160   This is a step towards making local XKB customizations more tenable and
161   convenient, without modifying system files.
162
163   You can now include other rules files like this:
164
165       ! include %S/evdev
166
167   Two directives are supported, %H to $HOME and %S for the system-installed
168   rules directory (usually /usr/share/X11/xkb/rules).
169
170   See commit message ca033a29d2ca910fd17b1ae287cb420205bdddc8 and
171   doc/rules-format.txt in the xkbcommon source code for more information.
172
173   Contributed by Peter Hutterer <@who-t.net>.
174
175 - Downgrade "Symbol added to modifier map for multiple modifiers" log to a
176   warning.
177
178   This error message was too annoying to be shown by default. When working on
179   keymaps, set `XKB_LOG_LEVEL=debug XKB_LOG_VERBOSITY=10` to see all possible
180   messages.
181
182 - Support building on Windows using the meson MSVC backend.
183
184   Contributed by Adrian Perez de Castro <@igalia.com>.
185
186 - Fix bug where the merge mode only applied to the first vmod in a
187   `virtual_modifiers` statement. Given
188
189       augment virtual_modifiers NumLock,Alt,LevelThree
190
191   Previously it was incorrectly treated as
192
193       augment virtual_modifiers NumLock;
194       virtual_modifiers Alt;
195       virtual_modifiers LevelThree;
196
197   Now it is treated as
198
199       augment virtual_modifiers NumLock;
200       augment virtual_modifiers Alt;
201       augment virtual_modifiers LevelThree;
202
203 - Reject interpret modifier predicate with more than one value. Given
204
205       interpret ISO_Level3_Shift+AnyOf(all,extraneous) { ... };
206
207   Previously, extraneous (and further) was ignored. Now it's rejected.
208
209 - Correctly handle capitalization of the ssharp keysym.
210
211 - Speed up and improve the internal `xkeyboard-config` tool. This tool
212   compiles all layout/variant combinations in the xkeyboard-config dataset
213   and reports any issues it finds.
214
215   Contributed by Peter Hutterer <@who-t.net>.
216
217 - Speed up "atoms" (string interning). This code goes back at least to X11R1
218   (released 1987).
219
220
221 libxkbcommon 0.9.1 - 2019-10-19
222 ==================
223
224 - Fix context creation failing when run in privileged processes as defined by
225   `secure_getenv(3)`, e.g. GDM.
226
227
228 libxkbcommon 0.9.0 - 2019-10-19
229 ==================
230
231 - Move ~/.xkb to before XKB_CONFIG_ROOT (the system XKB path, usually
232   /usr/share/X11/xkb) in the default include path. This enables the user
233   to have full control of the keymap definitions, instead of only augmenting
234   them.
235
236 - Remove the Autotools build system. Use the meson build system instead.
237
238 - Fix invalid names used for levels above 8 when dumping keymaps. Previously,
239   e.g. "Level20" was dumped, but only up to "Level8" is accepted by the
240   parser. Now "20" is dumped.
241
242 - Change level references to always be dumped as e.g. "5" instead of "Level5".
243
244   Change group references to always be dumped capitalized e.g. "Group3" instead
245   of "group3". Previously it was inconsistent.
246
247   These changes affect the output of xkb_keymap_get_as_string().
248
249 - Fix several build issues on macOS/Darwin, Solaris, NetBSD, cross compilation.
250
251 - Port the interactive-wayland test program to the stable version of xdg-shell.
252
253
254 libxkbcommon 0.8.4 - 2019-02-22
255 ==================
256
257 - Fix build of xkbcommon-x11 static library with meson.
258
259 - Fix building using meson from the tarball generated by autotools.
260
261
262 libxkbcommon 0.8.3 - 2019-02-08
263 ==================
264
265 - Fix build of static libraries with meson.
266   (Future note: xkbcommon-x11 was *not* fixed in this release.)
267
268 - New API:
269   XKB_KEY_XF86MonBrightnessCycle
270   XKB_KEY_XF86RotationLockToggle
271
272
273 libxkbcommon 0.8.2 - 2018-08-05
274 ==================
275
276 - Fix various problems found with fuzzing (see commit messages for
277   more details):
278
279     - Fix a few NULL-dereferences, out-of-bounds access and undefined behavior
280       in the XKB text format parser.
281
282
283 libxkbcommon 0.8.1 - 2018-08-03
284 ==================
285
286 - Fix various problems found in the meson build (see commit messages for more
287   details):
288
289     - Fix compilation on Darwin.
290
291     - Fix compilation of the x11 tests and demos when XCB is installed in a
292       non-standard location.
293
294     - Fix xkbcommon-x11.pc missing the Requires specification.
295
296 - Fix various problems found with fuzzing and Coverity (see commit messages for
297   more details):
298
299     - Fix stack overflow in the XKB text format parser when evaluating boolean
300       negation.
301
302     - Fix NULL-dereferences in the XKB text format parser when some unsupported
303       tokens appear (the tokens are still parsed for backward compatibility).
304
305     - Fix NULL-dereference in the XKB text format parser when parsing an
306       xkb_geometry section.
307
308     - Fix an infinite loop in the Compose text format parser on some inputs.
309
310     - Fix an invalid free() when using multiple keysyms.
311
312 - Replace the Unicode characters for the leftanglebracket and rightanglebracket
313   keysyms from the deprecated LEFT/RIGHT-POINTING ANGLE BRACKET to
314   MATHEMATICAL LEFT/RIGHT ANGLE BRACKET.
315
316 - Reject out-of-range Unicode codepoints in xkb_keysym_to_utf8 and
317   xkb_keysym_to_utf32.
318
319
320 libxkbcommon 0.8.0 - 2017-12-15
321 ==================
322
323 - Added xkb_keysym_to_{upper,lower} to perform case-conversion directly on
324   keysyms. This is useful in some odd cases, but working with the Unicode
325   representations should be preferred when possible.
326
327 - Added Unicode conversion rules for the signifblank and permille keysyms.
328
329 - Fixed a bug in the parsing of XKB key type definitions where the number
330   of levels were determined by the number of level *names*. Keymaps which
331   omit level names were hence miscompiled.
332
333   This regressed in version 0.4.3. Keymaps from xkeyboard-config were not
334   affected since they don't omit level names.
335
336 - New API:
337   xkb_keysym_to_upper()
338   xkb_keysym_to_lower()
339
340
341 libxkbcommon 0.7.2 - 2017-08-04
342 ==================
343
344 - Added a Meson build system as an alternative to existing autotools build
345   system.
346
347   The intent is to remove the autotools build in one of the next releases.
348   Please try to convert to it and report any problems.
349
350   See http://mesonbuild.com/Quick-guide.html for basic usage, the
351   meson_options.txt for the project-specific configuration options,
352   and the PACKAGING file for more details.
353
354   There are some noteworthy differences compared to the autotools build:
355
356   - Feature auto-detection is not performed. By default, all features are
357     enabled (currently: docs, x11, wayland). The build fails if any of
358     the required dependencies are not available. To disable a feature,
359     pass -Denable-<feature>=false to meson.
360
361   - The libraries are either installed as shared or static, as specified
362     by the -Ddefault_library=shared/static option. With autotools, both
363     versions are installed by default.
364
365   - xorg-util-macros is not used.
366
367   - A parser generator (bison/byacc) is always required - there is no
368     fallback to pre-generated output bundled in the tarball, as there is
369     in autotools.
370
371 - Removed Android.mk support.
372
373 - Removed the *-uninstalled.pc pkgconfig files.
374
375 - Ported the interactive-wayland demo program to v6 of the xdg-shell
376   protocol.
377
378 - Added new keysym definitions from xproto.
379
380 - New API:
381   XKB_KEY_XF86Keyboard
382   XKB_KEY_XF86WWAN
383   XKB_KEY_XF86RFKill
384   XKB_KEY_XF86AudioPreset
385
386
387 libxkbcommon 0.7.1 - 2017-01-18
388 ==================
389
390 - Fixed various reported problems when the current locale is tr_TR.UTF-8.
391
392   The function xkb_keysym_from_name() used to perform case-insensitive
393   string comparisons in a locale-dependent way, but required it to to
394   work as in the C/ASCII locale (the so called "Turkish i problem").
395
396   The function is now no longer affected by the current locale.
397
398 - Fixed compilation in NetBSD.
399
400
401 libxkbcommon 0.7.0 - 2016-11-11
402 ==================
403
404 - Added support for different "modes" of calculating consumed modifiers.
405   The existing mode, based on the XKB standard, has proven to be
406   unintuitive in various shortcut implementations.
407
408   A new mode, based on the calculation used by the GTK toolkit, is added.
409   This mode is less eager to declare a modifier as consumed.
410
411 - Added a new interactive demo program using the Wayland protocol.
412   See the PACKAGING file for the new (optional) test dependencies.
413
414 - Fixed a compilation error on GNU Hurd.
415
416 - New API:
417   enum xkb_consumed_mode
418   XKB_CONSUMED_MODE_XKB
419   XKB_CONSUMED_MODE_GTK
420   xkb_state_key_get_consumed_mods2
421   xkb_state_mod_index_is_consumed2
422
423
424 libxkbcommon 0.6.1 - 2016-04-08
425 ==================
426
427 - Added LICENSE to distributed files in tarball releases.
428
429 - Minor typo fix in xkb_keymap_get_as_string() documentation.
430
431
432 libxkbcommon 0.6.0 - 2016-03-16
433 ==================
434
435 - If the XKB_CONFIG_ROOT environment variable is set, it is used as the XKB
436   configuration root instead of the path determined at build time.
437
438 - Tests and benchmarks now build correctly on OSX.
439
440 - An XKB keymap provides a name for each key it defines.  Traditionally,
441   these names are limited to at most 4 characters, and are thus somewhat
442   obscure, but might still be useful (xkbcommon lifts the 4 character limit).
443
444   The new functions xkb_keymap_key_get_name() and xkb_keymap_key_by_name()
445   can be used to get the name of a key or find a key by name.  Note that
446   a key may have aliases.
447
448 - Documentation improvements.
449
450 - New API:
451   xkb_keymap_key_by_name()
452   xkb_keymap_key_get_name()
453
454
455 libxkbcommon 0.5.0 - 2014-10-18
456 ==================
457
458 - Added support for Compose/dead keys in a new module (included in
459   libxkbcommon). See the documentation or the
460   xkbcommon/xkbcommon-compose.h header file for more details.
461
462 - Improved and reordered some sections of the documentation.
463
464 - The doxygen HTML pages were made nicer to read.
465
466 - Most tests now run also on non-linux platforms.
467
468 - A warning is emitted by default about RMLVO values which are not used
469   during keymap compilation, which are most often a user misconfiguration.
470   For example, "terminate:ctrl_alt_backspace" instead of
471   "terminate:ctrl_alt_bksp".
472
473 - Added symbol versioning for libxkbcommon and libxkbcommon-x11.
474   Note: binaries compiled against this and future versions will not be
475   able to link against the previous versions of the library.
476
477 - Removed several compatablity symbols from the binary (the API isn't
478   affected). This affects binaries which
479
480   1. Were compiled against a pre-stable (<0.2.0) version of libxkbcommon, and
481   2. Are linked against the this or later version of libxkbcommon.
482
483   Such a scenario is likely to fail already.
484
485 - If Xvfb is not available, the x11comp test is now correctly skipped
486   instead of hanging.
487
488 - Benchmarks were moved to a separate bench/ directory.
489
490 - Build fixes from OpenBSD.
491
492 - Fixed a bug where key type entries such as "map[None] = Level2;" were
493   ignored.
494
495 - New API:
496   XKB_COMPOSE_*
497   xkb_compose_*
498
499
500 libxkbcommon 0.4.3 - 2014-08-19
501 ==================
502
503 - Fixed a bug which caused xkb_x11_keymap_new_from_device() to misrepresent
504   modifiers for some keymaps.
505
506   https://github.com/xkbcommon/libxkbcommon/issues/9
507
508 - Fixed a bug which caused xkb_x11_keymap_new_from_device() to ignore XKB
509   PrivateAction's.
510
511 - Modifiers are now always fully resolved after xkb_state_update_mask().
512   Previously the given state components were used as-is, without
513   considering virtual modifier mappings.
514   Note: this only affects non-standard uses of xkb_state_update_mask().
515
516 - Added a test for xkbcommon-x11, "x11comp". The test uses the system's
517   Xvfb server and xkbcomp. If they do not exist or fail, the test is
518   skipped.
519
520 - Fixed memory leaks after parse errors in the XKB yacc parser.
521   The fix required changes which are currently incompatible with byacc.
522
523
524 libxkbcommon 0.4.2 - 2014-05-15
525 ==================
526
527 - Fixed a bug where explicitly passing "--enable-x11" to ./configure would
528   in fact disable it (regressed in 0.4.1).
529
530 - Added @since version annotations to the API documentation for everything
531   introduced after the initial stable release (0.2.0).
532
533 - Added a section to the documentation about keysym transformations, and
534   clarified which functions perform a given transformation.
535
536 - XKB files which fail to compile during keymap construction can no longer
537   have any effect on the resulting keymap: changes are only applied when
538   the entire compilation succeeds.
539   Note: this was a minor correctness issue inherited from xkbcomp.
540
541 - Fix an out-of-bounds array access in src/x11/util.c:adopt_atoms()
542   error-handling code.
543   Note: it seems impossible to trigger in the current code since the input
544   size cannot exceed the required size.
545
546
547 libxkbcommon 0.4.1 - 2014-03-27
548 ==================
549
550 - Converted README to markdown and added a Quick Guide to the
551   documentation, which breezes through the most common parts of
552   xkbcommon.
553
554 - Added two new functions, xkb_state_key_get_utf{8,32}(). They
555   combine the operations of xkb_state_key_get_syms() and
556   xkb_keysym_to_utf{8,32}(), and provide a nicer interface for it
557   (espcially for multiple-keysyms-per-level).
558
559 - The xkb_state_key_get_utf{8,32}() functions now apply Control
560   transformation: when the Control modifier is active, the string
561   is converted to an appropriate control character.
562   This matches the behavior of libX11's XLookupString(3), and
563   required by the XKB specification:
564   https://www.x.org/releases/current/doc/kbproto/xkbproto.html#Interpreting_the_Control_Modifier
565
566   https://bugs.freedesktop.org/show_bug.cgi?id=75892
567
568 - The consumed modifiers for a key are now calculated similarly
569   to libX11. The previous behavior caused a bug where Shift would
570   not cancel an active Caps Lock.
571
572 - Make xkbcommon-x11 work with the keymap reported by the XQuartz
573   X server.
574
575   https://bugs.freedesktop.org/show_bug.cgi?id=75798
576
577 - Reduce memory usage during keymap compilation some more.
578
579 - New API:
580   xkb_state_key_get_consumed_mods()
581   xkb_state_key_get_utf8()
582   xkb_state_key_get_utf32()
583
584 - Deprecated API:
585   XKB_MAP_COMPILE_PLACEHOLDER, XKB_MAP_NO_FLAGS
586     use XKB_KEYMAP_NO_FLAGS instead.
587
588 - Bug fixes.
589
590
591 libxkbcommon 0.4.0 - 2014-02-02
592 ==================
593
594 - Add a new add-on library, xkbcommon-x11, to support creating keymaps
595   with the XKB X11 protocol, by querying the X server directly.
596   See the xkbcommon/xkbcommon-x11.h header file for more details.
597   This library requires libxcb-xkb >= 1.10, and is enabled by default.
598   It can be disabled with the --disable-x11 configure switch.
599   Distributions are encouraged to split the necessary files for this
600   library (libxkbcommon-x11.so, xkbcommon-x11.pc, xkbcommon/xkbcommon-x11.h)
601   to a separate package, such that the main package does not depend on
602   X11 libraries.
603
604 - Fix the keysym <-> name lookup table to not require huge amounts of
605   relocations.
606
607 - Fix a bug in the keysym <-> name lookup, whereby lookup might fail in
608   some rare cases.
609
610 - Reduce memory usage during keymap compilation.
611
612 - New API:
613   New keysyms from xproto 7.0.25 (German T3 layout keysyms).
614   XKB_MOD_NAME_NUM for the usual NumLock modifier.
615   xkb_x11_* types and functions, XKB_X11_* constants.
616
617
618 libxkbcommon 0.3.2 - 2013-11-22
619 ==================
620
621 - Log messages from the library now look like "xkbcommon: ERROR" by
622   default, instead of xkbcomp-like "Error:   ".
623
624 - Apply capitalization transformation on keysyms in
625   xkb_keysym_get_one_sym(), to match the behavior specified in the XKB
626   specification:
627   https://www.x.org/releases/current/doc/kbproto/xkbproto.html#Interpreting_the_Lock_Modifier
628
629 - Support byacc for generating the parser, in addition to Bison.
630
631 - New API:
632   XKB_KEY_XF86AudioMicMute keysym from xproto 7.0.24.
633   XKB_KEYSYM_NO_FLAGS
634   XKB_CONTEXT_NO_FLAGS
635   XKB_MAP_COMPILE_NO_FLAGS
636
637 - Bug fixes.
638
639
640 libxkbcommon 0.3.1 - 2013-06-03
641 ==================
642
643 - Replace the flex scanner with a hand-written one. flex is no longer
644   a build requirement.
645
646 - New API:
647   xkb_keymap_min_keycode()
648   xkb_keymap_max_keycode()
649   xkb_keymap_key_for_each()
650
651
652 libxkbcommon 0.3.0 - 2013-04-01
653 ==================
654
655 - Allow passing NULL to *_unref() functions; do nothing instead of
656   crashing.
657
658 - The functions xkb_keymap_num_levels_for_key() and
659   xkb_keymap_get_syms_by_level() now allow out-of-range values for the
660   'layout' parameter. The functions now wrap the value around the number
661   of layouts instead of failing.
662
663 - The function xkb_keysym_get_name() now types unicode keysyms in
664   uppercase and 0-padding, to match the format used by XKeysymToString().
665
666 - Building Linux-specific tests is no longer attempted on non-Linux
667   environments.
668
669 - The function xkb_keymap_new_from_names() now accepts a NULL value for
670   the 'names' parameter, instead of failing. This is equivalent to passing
671   a 'struct xkb_rule_names' with all fields set to NULL.
672
673 - New API:
674   xkb_keymap_new_from_buffer()
675
676 - Bug fixes.