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