2 * Copyright 1985, 1987, 1990, 1998 The Open Group
4 * Permission is hereby granted, free of charge, to any person obtaining a
5 * copy of this software and associated documentation files (the "Software"),
6 * to deal in the Software without restriction, including without limitation
7 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
8 * and/or sell copies of the Software, and to permit persons to whom the
9 * Software is furnished to do so, subject to the following conditions:
11 * The above copyright notice and this permission notice shall be included in
12 * all copies or substantial portions of the Software.
14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17 * AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
18 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
19 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
21 * Except as contained in this notice, the names of the authors or their
22 * institutions shall not be used in advertising or otherwise to promote the
23 * sale, use or other dealings in this Software without prior written
24 * authorization from the authors.
27 /************************************************************
28 * Copyright (c) 1993 by Silicon Graphics Computer Systems, Inc.
30 * Permission to use, copy, modify, and distribute this
31 * software and its documentation for any purpose and without
32 * fee is hereby granted, provided that the above copyright
33 * notice appear in all copies and that both that copyright
34 * notice and this permission notice appear in supporting
35 * documentation, and that the name of Silicon Graphics not be
36 * used in advertising or publicity pertaining to distribution
37 * of the software without specific prior written permission.
38 * Silicon Graphics makes no representation about the suitability
39 * of this software for any purpose. It is provided "as is"
40 * without any express or implied warranty.
42 * SILICON GRAPHICS DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS
43 * SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
44 * AND FITNESS FOR A PARTICULAR PURPOSE. IN NO EVENT SHALL SILICON
45 * GRAPHICS BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL
46 * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
47 * DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
48 * OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH
49 * THE USE OR PERFORMANCE OF THIS SOFTWARE.
51 ********************************************************/
54 * Copyright © 2009 Dan Nicholson
55 * Copyright © 2012 Intel Corporation
56 * Copyright © 2012 Ran Benita
58 * Permission is hereby granted, free of charge, to any person obtaining a
59 * copy of this software and associated documentation files (the "Software"),
60 * to deal in the Software without restriction, including without limitation
61 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
62 * and/or sell copies of the Software, and to permit persons to whom the
63 * Software is furnished to do so, subject to the following conditions:
65 * The above copyright notice and this permission notice (including the next
66 * paragraph) shall be included in all copies or substantial portions of the
69 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
70 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
71 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
72 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
73 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
74 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
75 * DEALINGS IN THE SOFTWARE.
77 * Author: Daniel Stone <daniel@fooishbar.org>
78 * Dan Nicholson <dbn.lists@gmail.com>
84 /* Don't use compat names in internal code. */
85 #define _XKBCOMMON_COMPAT_H
86 #include "xkbcommon/xkbcommon.h"
91 #define XKB_KEY_NAME_LENGTH 4
93 /* This limit is artificially enforced, we do not depend on it any where.
94 * The reason it's still here is that the rules file format does not
95 * support multiple groups very well, and the rules shipped with
96 * xkeyboard-config (see rules/evdev) depend on this limit extensively.
97 * So just lifting this limit would cause problems for people who will use
98 * more than 4 layouts.
99 * TODO: Fix the group index syntax in the rules format, preferably in a
100 * backwards compatible way.
101 * See e.g. https://bugs.freedesktop.org/show_bug.cgi?id=14372
102 * Note: A limit on the number of groups we *do* depend on is imposed by
103 * the size of the xkb_layout_mask_t type (32). This is more than enough
106 #define XKB_NUM_GROUPS 4
108 /* These should all be dynamic. */
109 #define XKB_NUM_INDICATORS 32
110 #define XKB_NUM_VIRTUAL_MODS 16
111 #define XKB_NUM_CORE_MODS 8
113 enum xkb_action_type {
114 ACTION_TYPE_NONE = 0,
116 ACTION_TYPE_MOD_LATCH,
117 ACTION_TYPE_MOD_LOCK,
118 ACTION_TYPE_GROUP_SET,
119 ACTION_TYPE_GROUP_LATCH,
120 ACTION_TYPE_GROUP_LOCK,
121 ACTION_TYPE_PTR_MOVE,
122 ACTION_TYPE_PTR_BUTTON,
123 ACTION_TYPE_PTR_LOCK,
124 ACTION_TYPE_PTR_DEFAULT,
125 ACTION_TYPE_TERMINATE,
126 ACTION_TYPE_SWITCH_VT,
127 ACTION_TYPE_CTRL_SET,
128 ACTION_TYPE_CTRL_LOCK,
129 ACTION_TYPE_KEY_REDIRECT,
131 _ACTION_TYPE_NUM_ENTRIES
134 enum xkb_action_flags {
135 ACTION_LOCK_CLEAR = (1 << 0),
136 ACTION_LATCH_TO_LOCK = (1 << 1),
137 ACTION_LOCK_NO_LOCK = (1 << 2),
138 ACTION_LOCK_NO_UNLOCK = (1 << 3),
139 ACTION_MODS_LOOKUP_MODMAP = (1 << 4),
140 ACTION_ABSOLUTE_SWITCH = (1 << 5),
141 ACTION_ABSOLUTE_X = (1 << 6),
142 ACTION_ABSOLUTE_Y = (1 << 7),
143 ACTION_NO_ACCEL = (1 << 8),
144 ACTION_SAME_SCREEN = (1 << 9),
147 enum xkb_action_controls {
148 CONTROL_REPEAT = (1 << 0),
149 CONTROL_SLOW = (1 << 1),
150 CONTROL_DEBOUNCE = (1 << 2),
151 CONTROL_STICKY = (1 << 3),
152 CONTROL_MOUSEKEYS = (1 << 4),
153 CONTROL_MOUSEKEYS_ACCEL = (1 << 5),
154 CONTROL_AX = (1 << 6),
155 CONTROL_AX_TIMEOUT = (1 << 7),
156 CONTROL_AX_FEEDBACK = (1 << 8),
157 CONTROL_BELL = (1 << 9),
158 CONTROL_IGNORE_GROUP_LOCK = (1 << 10),
160 (CONTROL_REPEAT | CONTROL_SLOW | CONTROL_DEBOUNCE | CONTROL_STICKY | \
161 CONTROL_MOUSEKEYS | CONTROL_MOUSEKEYS_ACCEL | CONTROL_AX | \
162 CONTROL_AX_TIMEOUT | CONTROL_AX_FEEDBACK | CONTROL_BELL | \
163 CONTROL_IGNORE_GROUP_LOCK)
166 enum xkb_match_operation {
168 MATCH_ANY_OR_NONE = 1,
173 (MATCH_NONE | MATCH_ANY_OR_NONE | MATCH_ANY | MATCH_ALL | \
175 MATCH_LEVEL_ONE_ONLY = (1 << 7),
179 xkb_mod_mask_t mods; /* original real+virtual mods in definition */
180 xkb_mod_mask_t mask; /* computed effective mask */
183 struct xkb_mod_action {
184 enum xkb_action_type type;
185 enum xkb_action_flags flags;
186 struct xkb_mods mods;
189 struct xkb_group_action {
190 enum xkb_action_type type;
191 enum xkb_action_flags flags;
195 struct xkb_controls_action {
196 enum xkb_action_type type;
197 enum xkb_action_flags flags;
198 enum xkb_action_controls ctrls;
201 struct xkb_pointer_default_action {
202 enum xkb_action_type type;
203 enum xkb_action_flags flags;
207 struct xkb_switch_screen_action {
208 enum xkb_action_type type;
209 enum xkb_action_flags flags;
213 struct xkb_redirect_key_action {
214 enum xkb_action_type type;
215 enum xkb_action_flags flags;
216 xkb_keycode_t new_kc;
223 struct xkb_pointer_action {
224 enum xkb_action_type type;
225 enum xkb_action_flags flags;
230 struct xkb_pointer_button_action {
231 enum xkb_action_type type;
232 enum xkb_action_flags flags;
237 struct xkb_private_action {
238 enum xkb_action_type type;
239 enum xkb_action_flags flags;
244 enum xkb_action_type type;
245 struct xkb_mod_action mods;
246 struct xkb_group_action group;
247 struct xkb_controls_action ctrls;
248 struct xkb_pointer_default_action dflt;
249 struct xkb_switch_screen_action screen;
250 struct xkb_redirect_key_action redirect; /* XXX wholly unnecessary? */
251 struct xkb_pointer_action ptr;
252 struct xkb_pointer_button_action btn;
253 struct xkb_private_action priv;
256 struct xkb_kt_map_entry {
257 xkb_level_index_t level;
258 struct xkb_mods mods;
259 struct xkb_mods preserve;
262 struct xkb_key_type {
263 struct xkb_mods mods;
264 xkb_level_index_t num_levels;
265 struct xkb_kt_map_entry *map;
266 unsigned int num_entries;
268 xkb_atom_t *level_names;
271 struct xkb_sym_interpret {
274 enum xkb_match_operation match;
276 xkb_mod_index_t virtual_mod;
277 union xkb_action act;
280 struct xkb_indicator_map {
282 enum xkb_state_component which_groups;
284 enum xkb_state_component which_mods;
285 struct xkb_mods mods;
286 enum xkb_action_controls ctrls;
289 struct xkb_key_alias {
290 char real[XKB_KEY_NAME_LENGTH];
291 char alias[XKB_KEY_NAME_LENGTH];
294 struct xkb_controls {
295 unsigned char groups_wrap;
296 struct xkb_mods internal;
297 struct xkb_mods ignore_lock;
298 unsigned short repeat_delay;
299 unsigned short repeat_interval;
300 unsigned short slow_keys_delay;
301 unsigned short debounce_delay;
302 unsigned short ax_options;
303 unsigned short ax_timeout;
304 unsigned short axt_opts_mask;
305 unsigned short axt_opts_values;
306 unsigned int axt_ctrls_mask;
307 unsigned int axt_ctrls_values;
310 /* Such an awkward name. Oh well. */
311 enum xkb_range_exceed_type {
317 enum xkb_explicit_components {
318 EXPLICIT_INTERP = (1 << 0),
319 EXPLICIT_VMODMAP = (1 << 1),
320 EXPLICIT_REPEAT = (1 << 2),
324 xkb_keycode_t keycode;
325 char name[XKB_KEY_NAME_LENGTH];
327 enum xkb_explicit_components explicit;
328 xkb_layout_mask_t explicit_groups;
330 unsigned char modmap;
331 xkb_mod_mask_t vmodmap;
335 union xkb_action *actions;
339 xkb_layout_index_t num_groups;
340 /* How many levels the largest group has. */
341 xkb_level_index_t width;
343 enum xkb_range_exceed_type out_of_range_group_action;
344 xkb_layout_index_t out_of_range_group_number;
346 /* per level/group index into 'syms' */
348 /* per level/group */
349 unsigned int *num_syms;
353 typedef darray(xkb_atom_t) darray_xkb_atom_t;
355 /* Common keyboard description structure */
357 struct xkb_context *ctx;
360 enum xkb_keymap_compile_flags flags;
361 enum xkb_keymap_format format;
363 enum xkb_action_controls enabled_ctrls;
365 xkb_keycode_t min_key_code;
366 xkb_keycode_t max_key_code;
368 darray(struct xkb_key) keys;
370 /* aliases in no particular order */
371 darray(struct xkb_key_alias) key_aliases;
373 struct xkb_key_type *types;
374 unsigned int num_types;
376 darray(struct xkb_sym_interpret) sym_interpret;
378 /* vmod -> mod mapping */
379 xkb_mod_mask_t vmods[XKB_NUM_VIRTUAL_MODS];
380 xkb_atom_t vmod_names[XKB_NUM_VIRTUAL_MODS];
382 /* Number of groups in the key with the most groups. */
383 xkb_layout_index_t num_groups;
384 darray_xkb_atom_t group_names;
386 struct xkb_indicator_map indicators[XKB_NUM_INDICATORS];
388 char *keycodes_section_name;
389 char *symbols_section_name;
390 char *types_section_name;
391 char *compat_section_name;
394 static inline const struct xkb_key *
395 XkbKey(struct xkb_keymap *keymap, xkb_keycode_t kc)
397 if (kc < keymap->min_key_code || kc > keymap->max_key_code)
399 return &darray_item(keymap->keys, kc);
402 #define xkb_foreach_key(iter, keymap) \
403 darray_foreach(iter, keymap->keys)
405 static inline struct xkb_key_type *
406 XkbKeyType(struct xkb_keymap *keymap, const struct xkb_key *key,
407 xkb_layout_index_t layout)
409 return &keymap->types[key->kt_index[layout]];
412 static inline xkb_level_index_t
413 XkbKeyGroupWidth(struct xkb_keymap *keymap, const struct xkb_key *key,
414 xkb_layout_index_t layout)
416 return XkbKeyType(keymap, key, layout)->num_levels;
419 static inline unsigned int
420 XkbKeyNumSyms(const struct xkb_key *key, xkb_layout_index_t layout,
421 xkb_level_index_t level)
423 return key->num_syms[layout * key->width + level];
426 static inline const xkb_keysym_t *
427 XkbKeySymEntry(const struct xkb_key *key, xkb_layout_index_t layout,
428 xkb_level_index_t level)
430 return &key->syms[key->sym_index[layout * key->width + level]];
433 static inline const union xkb_action *
434 XkbKeyActionEntry(const struct xkb_key *key, xkb_layout_index_t layout,
435 xkb_level_index_t level)
437 return &key->actions[key->width * layout + level];
441 xkb_keymap_new(struct xkb_context *ctx,
442 enum xkb_keymap_format format,
443 enum xkb_keymap_compile_flags);