Update NEWS
[platform/upstream/libxkbcommon.git] / NEWS
1 libxkbcommon 0.4.2 - 2014-05-15
2 ==================
3
4 - Fixed a bug where explicitly passing "--enable-x11" to ./configure would
5   in fact disable it (regressed in 0.4.1).
6
7 - Added @since version annotations to the API documentation for everything
8   introduced after the initial stable release (0.2.0).
9
10 - Added a section to the documentation about keysym transformations, and
11   clarified which functions perform a given transformation.
12
13 - XKB files which fail to compile during keymap construction can no longer
14   have any effect on the resulting keymap: changes are only applied when
15   the entire compilation succeeds.
16   Note: this was a minor correctness issue inherited from xkbcomp.
17
18 - Fix an out-of-bounds array access in src/x11/util.c:adopt_atoms()
19   error-handling code.
20   Note: it seems impossible to trigger in the current code since the input
21   size cannot exceed the required size.
22
23 libxkbcommon 0.4.1 - 2014-03-27
24 ==================
25
26 - Converted README to markdown and added a Quick Guide to the
27   documentation, which breezes through the most common parts of
28   xkbcommon.
29
30 - Added two new functions, xkb_state_key_get_utf{8,32}(). They
31   combine the operations of xkb_state_key_get_syms() and
32   xkb_keysym_to_utf{8,32}(), and provide a nicer interface for it
33   (espcially for multiple-keysyms-per-level).
34
35 - The xkb_state_key_get_utf{8,32}() functions now apply Control
36   transformation: when the Control modifier is active, the string
37   is converted to an appropriate control character.
38   This matches the behavior of libX11's XLookupString(3), and
39   required by the XKB specification:
40   http://www.x.org/releases/current/doc/kbproto/xkbproto.html#Interpreting_the_Control_Modifier
41
42   https://bugs.freedesktop.org/show_bug.cgi?id=75892
43
44 - The consumed modifiers for a key are now calculated similarly
45   to libX11. The previous behavior caused a bug where Shift would
46   not cancel an active Caps Lock.
47
48 - Make xkbcommon-x11 work with the keymap reported by the XQuartz
49   X server.
50
51   https://bugs.freedesktop.org/show_bug.cgi?id=75798
52
53 - Reduce memory usage during keymap compilation some more.
54
55 - New API:
56   xkb_state_key_get_consumed_mods()
57   xkb_state_key_get_utf8()
58   xkb_state_key_get_utf32()
59
60 - Deprecated API:
61   XKB_MAP_COMPILE_PLACEHOLDER, XKB_MAP_NO_FLAGS
62     use XKB_KEYMAP_NO_FLAGS instead.
63
64 - Bug fixes.
65
66 libxkbcommon 0.4.0 - 2014-02-02
67 ==================
68
69 - Add a new add-on library, xkbcommon-x11, to support creating keymaps
70   with the XKB X11 protocol, by querying the X server directly.
71   See the xkbcommon/xkbcommon-x11.h header file for more details.
72   This library requires libxcb-xkb >= 1.10, and is enabled by default.
73   It can be disabled with the --disable-x11 configure switch.
74   Distributions are encouraged to split the necessary files for this
75   library (libxkbcommon-x11.so, xkbcommon-x11.pc, xkbcommon/xkbcommon-x11.h)
76   to a separate package, such that the main package does not depend on
77   X11 libraries.
78
79 - Fix the keysym <-> name lookup table to not require huge amounts of
80   relocations.
81
82 - Fix a bug in the keysym <-> name lookup, whereby lookup might fail in
83   some rare cases.
84
85 - Reduce memory usage during keymap compilation.
86
87 - New API:
88   New keysyms from xproto 7.0.25 (German T3 layout keysyms).
89   XKB_MOD_NAME_NUM for the usual NumLock modifier.
90   xkb_x11_* types and functions, XKB_X11_* constants.
91
92
93 libxkbcommon 0.3.2 - 2013-11-22
94 ==================
95
96 - Log messages from the library now look like "xkbcommon: ERROR" by
97   default, instead of xkbcomp-like "Error:   ".
98
99 - Apply capitalization transformation on keysyms in
100   xkb_keysym_get_one_sym(), to match the behavior specified in the XKB
101   specification:
102   http://www.x.org/releases/current/doc/kbproto/xkbproto.html#Interpreting_the_Lock_Modifier
103
104 - Support byacc for generating the parser, in addition to Bison.
105
106 - New API:
107   XKB_KEY_XF86AudioMicMute keysym from xproto 7.0.24.
108   XKB_KEYSYM_NO_FLAGS
109   XKB_CONTEXT_NO_FLAGS
110   XKB_MAP_COMPILE_NO_FLAGS
111
112 - Bug fixes.
113
114
115 libxkbcommon 0.3.1 - 2013-06-03
116 ==================
117
118 - Replace the flex scanner with a hand-written one. flex is no longer
119   a build requirement.
120
121 - New API:
122   xkb_keymap_min_keycode()
123   xkb_keymap_max_keycode()
124   xkb_keymap_key_for_each()
125
126
127 libxkbcommon 0.3.0 - 2013-04-01
128 ==================
129
130 - Allow passing NULL to *_unref() functions; do nothing instead of
131   crashing.
132
133 - The functions xkb_keymap_num_levels_for_key() and
134   xkb_keymap_get_syms_by_level() now allow out-of-range values for the
135   'layout' parameter. The functions now wrap the value around the number
136   of layouts instead of failing.
137
138 - The function xkb_keysym_get_name() now types unicode keysyms in
139   uppercase and 0-padding, to match the format used by XKeysymToString().
140
141 - Building Linux-specific tests is no longer attempted on non-Linux
142   environments.
143
144 - The function xkb_keymap_new_from_names() now accepts a NULL value for
145   the 'names' parameter, instead of failing. This is equivalent to passing
146   a 'struct xkb_rule_names' with all fields set to NULL.
147
148 - New API:
149   xkb_keymap_new_from_buffer()
150
151 - Bug fixes.