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