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