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 #define XkmKeymapFile 22
94 #define XkmRulesFile 24
96 #define XkmTypesIndex 0
97 #define XkmCompatMapIndex 1
98 #define XkmSymbolsIndex 2
99 #define XkmKeyNamesIndex 4
100 #define XkmGeometryIndex 5
102 #define XkmTypesMask (1<<0)
103 #define XkmCompatMapMask (1<<1)
104 #define XkmSymbolsMask (1<<2)
105 #define XkmKeyNamesMask (1<<4)
106 #define XkmGeometryMask (1<<5)
108 #define XkmKeymapRequired (XkmCompatMapMask|XkmKeyNamesMask|XkmSymbolsMask|XkmTypesMask)
109 #define XkmKeymapOptional ((XkmTypesMask|XkmGeometryMask)&(~XkmKeymapRequired))
110 #define XkmKeymapLegal (XkmKeymapRequired|XkmKeymapOptional)
113 * Legacy names for the components of an XKB keymap, also known as KcCGST.
115 struct xkb_component_names {
123 struct xkb_any_action {
128 struct xkb_mod_action {
136 struct xkb_group_action {
142 struct xkb_iso_action {
152 struct xkb_controls_action {
158 struct xkb_device_button_action {
166 struct xkb_device_valuator_action {
177 struct xkb_pointer_default_action {
184 struct xkb_switch_screen_action {
190 struct xkb_redirect_key_action {
192 xkb_keycode_t new_key;
199 struct xkb_pointer_action {
206 struct xkb_message_action {
212 struct xkb_pointer_button_action {
220 struct xkb_any_action any;
221 struct xkb_mod_action mods;
222 struct xkb_group_action group;
223 struct xkb_iso_action iso;
224 struct xkb_controls_action ctrls;
225 struct xkb_device_button_action devbtn;
226 struct xkb_device_valuator_action devval;
227 struct xkb_pointer_default_action dflt;
228 struct xkb_switch_screen_action screen;
229 struct xkb_redirect_key_action redirect; /* XXX wholly unnecessary? */
230 struct xkb_pointer_action ptr; /* XXX delete for DeviceValuator */
231 struct xkb_pointer_button_action btn; /* XXX delete for DeviceBtn */
232 struct xkb_message_action msg; /* XXX just delete */
237 uint32_t mask; /* effective mods */
242 struct xkb_kt_map_entry {
245 struct xkb_mods mods;
248 struct xkb_key_type {
249 struct xkb_mods mods;
251 unsigned char map_count;
252 struct xkb_kt_map_entry * map;
253 struct xkb_mods * preserve;
255 const char **level_names;
258 struct xkb_sym_interpret {
263 uint32_t virtual_mod;
264 union xkb_action act;
267 struct xkb_compat_map {
268 darray(struct xkb_sym_interpret) sym_interpret;
269 struct xkb_mods groups[XkbNumKbdGroups];
273 unsigned char kt_index[XkbNumKbdGroups];
274 unsigned char group_info;
276 int *sym_index; /* per level/group index into 'syms' */
277 unsigned int *num_syms; /* per level/group */
279 unsigned int size_syms; /* size of 'syms' */
282 struct xkb_client_map {
283 darray(struct xkb_key_type) types;
284 struct xkb_sym_map * key_sym_map;
285 unsigned char *modmap;
288 struct xkb_behavior {
293 struct xkb_server_map {
294 unsigned short num_acts;
295 unsigned short size_acts;
297 unsigned char * explicit;
299 union xkb_action *acts;
300 struct xkb_behavior *behaviors;
301 unsigned short *key_acts;
302 uint32_t vmods[XkbNumVirtualMods]; /* vmod -> mod mapping */
303 uint32_t *vmodmap; /* key -> vmod mapping */
307 struct xkb_indicator_map {
309 unsigned char which_groups;
310 unsigned char groups;
311 unsigned char which_mods;
312 struct xkb_mods mods;
316 struct xkb_indicator {
317 struct xkb_indicator_map maps[XkbNumIndicators];
320 struct xkb_key_name {
321 char name[XkbKeyNameLength];
324 struct xkb_key_alias {
325 char real[XkbKeyNameLength];
326 char alias[XkbKeyNameLength];
330 const char *vmods[XkbNumVirtualMods];
331 const char *indicators[XkbNumIndicators];
332 const char *groups[XkbNumKbdGroups];
333 struct xkb_key_name * keys;
334 struct xkb_key_alias * key_aliases;
336 xkb_keycode_t num_keys;
337 xkb_keycode_t num_key_aliases;
340 struct xkb_controls {
341 unsigned char num_groups;
342 unsigned char groups_wrap;
343 struct xkb_mods internal;
344 struct xkb_mods ignore_lock;
345 unsigned int enabled_ctrls;
346 unsigned short repeat_delay;
347 unsigned short repeat_interval;
348 unsigned short slow_keys_delay;
349 unsigned short debounce_delay;
350 unsigned short ax_options;
351 unsigned short ax_timeout;
352 unsigned short axt_opts_mask;
353 unsigned short axt_opts_values;
354 unsigned int axt_ctrls_mask;
355 unsigned int axt_ctrls_values;
356 unsigned char *per_key_repeat;
359 /* Common keyboard description structure */
361 struct xkb_context *ctx;
364 unsigned short flags;
365 xkb_keycode_t min_key_code;
366 xkb_keycode_t max_key_code;
368 struct xkb_controls * ctrls;
369 struct xkb_server_map * server;
370 struct xkb_client_map * map;
371 struct xkb_indicator * indicators;
372 struct xkb_names * names;
373 struct xkb_compat_map * compat;
376 #define XkbNumGroups(g) ((g)&0x0f)
377 #define XkbOutOfRangeGroupInfo(g) ((g)&0xf0)
378 #define XkbOutOfRangeGroupAction(g) ((g)&0xc0)
379 #define XkbOutOfRangeGroupNumber(g) (((g)&0x30)>>4)
380 #define XkbSetGroupInfo(g,w,n) (((w)&0xc0)|(((n)&3)<<4)|((g)&0x0f))
381 #define XkbSetNumGroups(g,n) (((g)&0xf0)|((n)&0x0f))
383 #define XkbKeyGroupInfo(d,k) ((d)->map->key_sym_map[k].group_info)
384 #define XkbKeyNumGroups(d,k) (XkbNumGroups((d)->map->key_sym_map[k].group_info))
385 #define XkbKeyGroupWidth(d,k,g) (XkbKeyType(d,k,g)->num_levels)
386 #define XkbKeyGroupsWidth(d,k) ((d)->map->key_sym_map[k].width)
387 #define XkbKeyTypeIndex(d,k,g) ((d)->map->key_sym_map[k].kt_index[g&0x3])
388 #define XkbKeyType(d,k,g) (&darray_item((d)->map->types, XkbKeyTypeIndex(d,k,g)))
389 #define XkbKeyNumSyms(d,k,g,sl) \
390 ((d)->map->key_sym_map[k].num_syms[(g*XkbKeyGroupsWidth(d,k))+sl])
391 #define XkbKeySym(d,k,n) (&(d)->map->key_sym_map[k].syms[n])
392 #define XkbKeySymOffset(d,k,g,sl) \
393 ((d)->map->key_sym_map[k].sym_index[(g*XkbKeyGroupsWidth(d,k))+sl])
394 #define XkbKeySymEntry(d,k,g,sl) \
395 (XkbKeySym(d,k,XkbKeySymOffset(d,k,g,sl)))
396 #define XkbKeyHasActions(d,k) ((d)->server->key_acts[k]!=0)
397 #define XkbKeyNumActions(d,k) \
398 (XkbKeyHasActions(d,k)?(XkbKeyGroupsWidth(d,k)*XkbKeyNumGroups(d,k)):1)
399 #define XkbKeyActionsPtr(d,k) (&(d)->server->acts[(d)->server->key_acts[k]])
400 #define XkbKeyAction(d,k,n) \
401 (XkbKeyHasActions(d,k)?&XkbKeyActionsPtr(d,k)[n]:NULL)
402 #define XkbKeyActionEntry(d,k,sl,g) \
403 (XkbKeyHasActions(d,k)?\
404 XkbKeyAction(d,k,((XkbKeyGroupsWidth(d,k)*(g))+(sl))):NULL)
406 #define XkbKeycodeInRange(d,k) (((k)>=(d)->min_key_code)&&\
407 ((k)<=(d)->max_key_code))
408 #define XkbNumKeys(d) ((d)->max_key_code-(d)->min_key_code+1)
411 xkb_group_index_t base_group; /**< depressed */
412 xkb_group_index_t latched_group;
413 xkb_group_index_t locked_group;
414 xkb_group_index_t group; /**< effective */
416 xkb_mod_mask_t base_mods; /**< depressed */
417 xkb_mod_mask_t latched_mods;
418 xkb_mod_mask_t locked_mods;
419 xkb_mod_mask_t mods; /**< effective */
426 struct xkb_keymap *keymap;
429 typedef uint32_t xkb_atom_t;
431 #define XKB_ATOM_NONE 0
434 xkb_atom_intern(struct xkb_context *ctx, const char *string);
437 xkb_atom_strdup(struct xkb_context *ctx, xkb_atom_t atom);
440 xkb_atom_text(struct xkb_context *ctx, xkb_atom_t atom);
443 xkb_key_get_group(struct xkb_state *state, xkb_keycode_t key);
446 xkb_key_get_level(struct xkb_state *state, xkb_keycode_t key,
450 xkb_key_get_syms_by_level(struct xkb_keymap *keymap, xkb_keycode_t key,
451 unsigned int group, unsigned int level,
452 const xkb_keysym_t **syms_out);
455 * Canonicalises component names by prepending the relevant component from
456 * 'old' to the one in 'names' when the latter has a leading '+' or '|', and
457 * by replacing a '%' with the relevant component, e.g.:
460 * ------------------------------------------
463 * foo+%|baz bar foo+bar|baz
465 * If a component in names needs to be modified, the existing value will be
466 * free()d, and a new one allocated with malloc().
469 xkb_canonicalise_components(struct xkb_component_names *names,
470 const struct xkb_component_names *old);
473 * Deprecated entrypoint for legacy users who need to be able to compile
474 * XKB keymaps by KcCGST (Keycodes + Compat + Geometry + Symbols + Types)
477 * You should not use this unless you are the X server. This entrypoint
478 * may well disappear in future releases. Please, please, don't use it.
480 * Geometry will be ignored since xkbcommon does not support it in any way.
483 xkb_map_new_from_kccgst(struct xkb_context *ctx,
484 const struct xkb_component_names *kccgst,
485 enum xkb_map_compile_flags flags);
488 xkb_context_take_file_id(struct xkb_context *ctx);
491 XkbcComputeEffectiveMap(struct xkb_keymap *keymap, struct xkb_key_type *type,
492 unsigned char *map_rtrn);
495 XkbcInitCanonicalKeyTypes(struct xkb_keymap *keymap, unsigned which,
499 _XkbcKSCheckCase(xkb_keysym_t sym);
501 #define _XkbKSLower (1 << 0)
502 #define _XkbKSUpper (1 << 1)
504 #define XkbcKSIsLower(k) (_XkbcKSCheckCase(k) & _XkbKSLower)
505 #define XkbcKSIsUpper(k) (_XkbcKSCheckCase(k) & _XkbKSUpper)
507 #define XkbKSIsKeypad(k) (((k) >= XKB_KEY_KP_Space) && ((k) <= XKB_KEY_KP_Equal))
509 #endif /* XKB_PRIV_H */