2 * Copyright 1985, 1987, 1990, 1998 The Open Group
3 * Copyright 2008 Dan Nicholson
5 * Permission is hereby granted, free of charge, to any person obtaining a
6 * copy of this software and associated documentation files (the "Software"),
7 * to deal in the Software without restriction, including without limitation
8 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
9 * and/or sell copies of the Software, and to permit persons to whom the
10 * Software is furnished to do so, subject to the following conditions:
12 * The above copyright notice and this permission notice shall be included in
13 * all copies or substantial portions of the Software.
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 * AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
19 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
20 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
22 * Except as contained in this notice, the names of the authors or their
23 * institutions shall not be used in advertising or otherwise to promote the
24 * sale, use or other dealings in this Software without prior written
25 * authorization from the authors.
28 /************************************************************
29 * Copyright (c) 1993 by Silicon Graphics Computer Systems, Inc.
31 * Permission to use, copy, modify, and distribute this
32 * software and its documentation for any purpose and without
33 * fee is hereby granted, provided that the above copyright
34 * notice appear in all copies and that both that copyright
35 * notice and this permission notice appear in supporting
36 * documentation, and that the name of Silicon Graphics not be
37 * used in advertising or publicity pertaining to distribution
38 * of the software without specific prior written permission.
39 * Silicon Graphics makes no representation about the suitability
40 * of this software for any purpose. It is provided "as is"
41 * without any express or implied warranty.
43 * SILICON GRAPHICS DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS
44 * SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
45 * AND FITNESS FOR A PARTICULAR PURPOSE. IN NO EVENT SHALL SILICON
46 * GRAPHICS BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL
47 * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
48 * DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
49 * OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH
50 * THE USE OR PERFORMANCE OF THIS SOFTWARE.
52 ********************************************************/
55 * Copyright © 2012 Intel Corporation
57 * Permission is hereby granted, free of charge, to any person obtaining a
58 * copy of this software and associated documentation files (the "Software"),
59 * to deal in the Software without restriction, including without limitation
60 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
61 * and/or sell copies of the Software, and to permit persons to whom the
62 * Software is furnished to do so, subject to the following conditions:
64 * The above copyright notice and this permission notice (including the next
65 * paragraph) shall be included in all copies or substantial portions of the
68 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
69 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
70 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
71 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
72 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
73 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
74 * DEALINGS IN THE SOFTWARE.
76 * Author: Daniel Stone <daniel@fooishbar.org>
85 #include <X11/extensions/XKB.h>
88 #include "xkbcommon/xkbcommon.h"
93 /* The top level file which includes the other component files. */
94 FILE_TYPE_KEYMAP = (1 << 0),
96 /* Component files. */
97 FILE_TYPE_TYPES = (1 << 1),
98 FILE_TYPE_COMPAT = (1 << 2),
99 FILE_TYPE_SYMBOLS = (1 << 3),
100 FILE_TYPE_KEYCODES = (1 << 4),
101 FILE_TYPE_GEOMETRY = (1 << 5),
103 /* This one doesn't mix with the others, but useful here as well. */
104 FILE_TYPE_RULES = (1 << 6),
107 /* Files needed for a complete keymap. */
108 #define REQUIRED_FILE_TYPES (FILE_TYPE_TYPES | FILE_TYPE_COMPAT | \
109 FILE_TYPE_SYMBOLS | FILE_TYPE_KEYCODES)
110 #define LEGAL_FILE_TYPES REQUIRED_FILE_TYPES
113 * Legacy names for the components of an XKB keymap, also known as KcCGST.
115 struct xkb_component_names {
122 struct xkb_any_action {
127 struct xkb_mod_action {
135 struct xkb_group_action {
141 struct xkb_iso_action {
151 struct xkb_controls_action {
157 struct xkb_device_button_action {
165 struct xkb_device_valuator_action {
176 struct xkb_pointer_default_action {
183 struct xkb_switch_screen_action {
189 struct xkb_redirect_key_action {
191 xkb_keycode_t new_key;
198 struct xkb_pointer_action {
205 struct xkb_message_action {
211 struct xkb_pointer_button_action {
219 struct xkb_any_action any;
220 struct xkb_mod_action mods;
221 struct xkb_group_action group;
222 struct xkb_iso_action iso;
223 struct xkb_controls_action ctrls;
224 struct xkb_device_button_action devbtn;
225 struct xkb_device_valuator_action devval;
226 struct xkb_pointer_default_action dflt;
227 struct xkb_switch_screen_action screen;
228 struct xkb_redirect_key_action redirect; /* XXX wholly unnecessary? */
229 struct xkb_pointer_action ptr; /* XXX delete for DeviceValuator */
230 struct xkb_pointer_button_action btn; /* XXX delete for DeviceBtn */
231 struct xkb_message_action msg; /* XXX just delete */
236 uint32_t mask; /* effective mods */
241 struct xkb_kt_map_entry {
243 struct xkb_mods mods;
246 struct xkb_key_type {
247 struct xkb_mods mods;
249 darray(struct xkb_kt_map_entry) map;
250 struct xkb_mods * preserve;
255 struct xkb_sym_interpret {
260 uint32_t virtual_mod;
261 union xkb_action act;
265 unsigned char kt_index[XkbNumKbdGroups];
266 unsigned char group_info;
268 int *sym_index; /* per level/group index into 'syms' */
269 unsigned int *num_syms; /* per level/group */
270 darray(xkb_keysym_t) syms;
273 struct xkb_behavior {
278 struct xkb_indicator_map {
280 unsigned char which_groups;
281 unsigned char groups;
282 unsigned char which_mods;
283 struct xkb_mods mods;
287 struct xkb_key_name {
288 char name[XkbKeyNameLength];
291 struct xkb_key_alias {
292 char real[XkbKeyNameLength];
293 char alias[XkbKeyNameLength];
302 char *vmods[XkbNumVirtualMods];
303 char *indicators[XkbNumIndicators];
304 char *groups[XkbNumKbdGroups];
306 darray(struct xkb_key_name) keys;
307 darray(struct xkb_key_alias) key_aliases;
310 struct xkb_controls {
311 /* unsigned char groups_wrap; */
312 /* struct xkb_mods internal; */
313 /* struct xkb_mods ignore_lock; */
314 unsigned int enabled_ctrls;
315 /* unsigned short repeat_delay; */
316 /* unsigned short repeat_interval; */
317 /* unsigned short slow_keys_delay; */
318 /* unsigned short debounce_delay; */
319 /* unsigned short ax_options; */
320 /* unsigned short ax_timeout; */
321 /* unsigned short axt_opts_mask; */
322 /* unsigned short axt_opts_values; */
323 /* unsigned int axt_ctrls_mask; */
324 /* unsigned int axt_ctrls_values; */
325 unsigned char *per_key_repeat;
328 /* Common keyboard description structure */
330 struct xkb_context *ctx;
333 unsigned short flags;
334 xkb_keycode_t min_key_code;
335 xkb_keycode_t max_key_code;
337 struct xkb_controls * ctrls;
338 struct xkb_names * names;
340 /* key -> explicit flags mapping */
341 unsigned char *explicit;
343 darray(struct xkb_key_type) types;
345 /* key -> symbols mapping */
346 darray(struct xkb_sym_map) key_sym_map;
348 darray(struct xkb_sym_interpret) sym_interpret;
350 /* key -> mod mapping */
351 unsigned char *modmap;
352 /* vmod -> mod mapping */
353 uint32_t vmods[XkbNumVirtualMods];
354 /* key -> vmod mapping */
357 struct xkb_mods groups[XkbNumKbdGroups];
359 /* key -> actions mapping: acts[key_acts[keycode]] */
360 darray(union xkb_action) acts;
361 darray(size_t) key_acts;
363 /* key -> behavior mapping */
364 struct xkb_behavior *behaviors;
366 struct xkb_indicator_map indicators[XkbNumIndicators];
369 #define XkbNumGroups(g) ((g) & 0x0f)
370 #define XkbOutOfRangeGroupInfo(g) ((g) & 0xf0)
371 #define XkbOutOfRangeGroupAction(g) ((g) & 0xc0)
372 #define XkbOutOfRangeGroupNumber(g) (((g) & 0x30) >> 4)
373 #define XkbSetGroupInfo(g, w, \
375 0xc0) | (((n) & 3) << 4) | ((g) & 0x0f))
376 #define XkbSetNumGroups(g, n) (((g) & 0xf0) | ((n) & 0x0f))
378 #define XkbKeyGroupInfo(d, k) \
379 (darray_item((d)->key_sym_map, k).group_info)
380 #define XkbKeyNumGroups(d, k) \
381 (XkbNumGroups(darray_item((d)->key_sym_map, k).group_info))
382 #define XkbKeyGroupWidth(d, k, g) \
383 (XkbKeyType(d, k, g)->num_levels)
384 #define XkbKeyGroupsWidth(d, k) \
385 (darray_item((d)->key_sym_map, k).width)
386 #define XkbKeyTypeIndex(d, k, g) \
387 (darray_item((d)->key_sym_map, k).kt_index[g & 0x3])
388 #define XkbKeyType(d, k, g) \
389 (&darray_item((d)->types, XkbKeyTypeIndex(d, k, g)))
390 #define XkbKeyNumSyms(d, k, g, sl) \
391 (darray_item((d)->map->key_sym_map, \
392 k).num_syms[(g * XkbKeyGroupsWidth(d, k)) + sl])
393 #define XkbKeySym(d, k, n) \
394 (&darray_item(darray_item((d)->key_sym_map, k).syms, n))
395 #define XkbKeySymOffset(d, k, g, sl) \
396 (darray_item((d)->map->key_sym_map, \
397 k).sym_index[(g * XkbKeyGroupsWidth(d, k)) + sl])
398 #define XkbKeySymEntry(d, k, g, sl) \
399 (XkbKeySym(d, k, XkbKeySymOffset(d, k, g, sl)))
400 #define XkbKeyHasActions(d, k) \
401 (darray_item((d)->key_acts, k) != 0)
402 #define XkbKeyNumActions(d, k) \
403 (XkbKeyHasActions(d, k) ? \
404 (XkbKeyGroupsWidth(d, k) * XkbKeyNumGroups(d, k)) : \
406 #define XkbKeyActionsPtr(d, k) \
407 (darray_mem((d)->acts, darray_item((d)->key_acts, k)))
408 #define XkbKeyAction(d, k, n) \
409 (XkbKeyHasActions(d, k) ? &XkbKeyActionsPtr(d, k)[n] : NULL)
410 #define XkbKeyActionEntry(d, k, sl, g) \
411 (XkbKeyHasActions(d, k) ? \
412 XkbKeyAction(d, k, ((XkbKeyGroupsWidth(d, k) * (g)) + (sl))) : \
415 #define XkbKeycodeInRange(d, k) \
416 (((k) >= (d)->min_key_code) && ((k) <= (d)->max_key_code))
418 typedef uint32_t xkb_atom_t;
420 #define XKB_ATOM_NONE 0
423 xkb_atom_intern(struct xkb_context *ctx, const char *string);
426 xkb_atom_strdup(struct xkb_context *ctx, xkb_atom_t atom);
429 xkb_atom_text(struct xkb_context *ctx, xkb_atom_t atom);
432 xkb_key_get_group(struct xkb_state *state, xkb_keycode_t key);
435 xkb_key_get_level(struct xkb_state *state, xkb_keycode_t key,
439 xkb_key_get_syms_by_level(struct xkb_keymap *keymap, xkb_keycode_t key,
440 unsigned int group, unsigned int level,
441 const xkb_keysym_t **syms_out);
444 * Deprecated entrypoint for legacy users who need to be able to compile
445 * XKB keymaps by KcCGST (Keycodes + Compat + Geometry + Symbols + Types)
448 * You should not use this unless you are the X server. This entrypoint
449 * may well disappear in future releases. Please, please, don't use it.
451 * Geometry will be ignored since xkbcommon does not support it in any way.
454 xkb_map_new_from_kccgst(struct xkb_context *ctx,
455 const struct xkb_component_names *kccgst,
456 enum xkb_map_compile_flags flags);
459 xkb_context_take_file_id(struct xkb_context *ctx);
462 xkb_keysym_is_lower(xkb_keysym_t keysym);
465 xkb_keysym_is_upper(xkb_keysym_t keysym);
468 xkb_keysym_is_keypad(xkb_keysym_t keysym);
470 #endif /* XKB_PRIV_H */