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