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>
87 #include "xkbcommon/xkbcommon.h"
92 typedef uint32_t xkb_level_index_t;
93 typedef uint32_t xkb_atom_t;
95 #define XKB_ATOM_NONE 0
96 #define XKB_LEVEL_INVALID 0xffffffff
98 #define XKB_KEY_NAME_LENGTH 4
100 /* These should all be dynamic. */
101 #define XKB_NUM_GROUPS 4
102 #define XKB_NUM_INDICATORS 32
107 ATTR_PRINTF(3, 0) void (*log_fn)(struct xkb_context *ctx,
108 enum xkb_log_level level,
109 const char *fmt, va_list args);
110 enum xkb_log_level log_level;
114 darray(char *) includes;
115 darray(char *) failed_includes;
117 /* xkbcomp needs to assign sequential IDs to XkbFile's it creates. */
120 struct atom_table *atom_table;
124 * Legacy names for the components of an XKB keymap, also known as KcCGST.
126 struct xkb_component_names {
134 xkb_mod_mask_t mods; /* original real+virtual mods in definition */
135 xkb_mod_mask_t mask; /* computed effective mask */
138 struct xkb_mod_action {
141 struct xkb_mods mods;
144 struct xkb_group_action {
150 struct xkb_iso_action {
153 struct xkb_mods mods;
158 struct xkb_controls_action {
164 struct xkb_device_button_action {
172 struct xkb_device_valuator_action {
183 struct xkb_pointer_default_action {
190 struct xkb_switch_screen_action {
196 struct xkb_redirect_key_action {
198 xkb_keycode_t new_kc;
205 struct xkb_pointer_action {
212 struct xkb_message_action {
218 struct xkb_pointer_button_action {
225 /* Instead of non-sequential XkbSA_XFree86Private. */
226 #define PrivateAction (XkbSA_LastAction + 1)
228 struct xkb_private_action {
234 struct xkb_mod_action mods;
235 struct xkb_group_action group;
236 struct xkb_iso_action iso;
237 struct xkb_controls_action ctrls;
238 struct xkb_device_button_action devbtn;
239 struct xkb_device_valuator_action devval;
240 struct xkb_pointer_default_action dflt;
241 struct xkb_switch_screen_action screen;
242 struct xkb_redirect_key_action redirect; /* XXX wholly unnecessary? */
243 struct xkb_pointer_action ptr; /* XXX delete for DeviceValuator */
244 struct xkb_pointer_button_action btn; /* XXX delete for DeviceBtn */
245 struct xkb_message_action msg; /* XXX just delete */
246 struct xkb_private_action priv;
250 struct xkb_kt_map_entry {
251 xkb_level_index_t level;
252 struct xkb_mods mods;
253 struct xkb_mods preserve;
256 struct xkb_key_type {
257 struct xkb_mods mods;
258 xkb_level_index_t num_levels;
259 struct xkb_kt_map_entry *map;
260 unsigned int num_entries;
262 xkb_atom_t *level_names;
265 struct xkb_sym_interpret {
270 xkb_mod_index_t virtual_mod;
271 union xkb_action act;
274 struct xkb_indicator_map {
276 unsigned char which_groups;
278 unsigned char which_mods;
279 struct xkb_mods mods;
283 struct xkb_key_alias {
284 char real[XKB_KEY_NAME_LENGTH];
285 char alias[XKB_KEY_NAME_LENGTH];
288 struct xkb_controls {
289 unsigned char groups_wrap;
290 struct xkb_mods internal;
291 struct xkb_mods ignore_lock;
292 unsigned short repeat_delay;
293 unsigned short repeat_interval;
294 unsigned short slow_keys_delay;
295 unsigned short debounce_delay;
296 unsigned short ax_options;
297 unsigned short ax_timeout;
298 unsigned short axt_opts_mask;
299 unsigned short axt_opts_values;
300 unsigned int axt_ctrls_mask;
301 unsigned int axt_ctrls_values;
305 char name[XKB_KEY_NAME_LENGTH];
307 unsigned char explicit;
309 unsigned char modmap;
310 xkb_mod_mask_t vmodmap;
314 union xkb_action *actions;
316 unsigned kt_index[XKB_NUM_GROUPS];
318 xkb_group_index_t num_groups;
319 /* How many levels the largest group has. */
320 xkb_level_index_t width;
322 uint8_t out_of_range_group_action;
323 xkb_group_index_t out_of_range_group_number;
325 /* per level/group index into 'syms' */
327 /* per level/group */
328 unsigned int *num_syms;
329 darray(xkb_keysym_t) syms;
332 /* Common keyboard description structure */
334 struct xkb_context *ctx;
337 enum xkb_map_compile_flags flags;
339 unsigned int enabled_ctrls;
341 xkb_keycode_t min_key_code;
342 xkb_keycode_t max_key_code;
344 darray(struct xkb_key) keys;
346 /* aliases in no particular order */
347 darray(struct xkb_key_alias) key_aliases;
349 struct xkb_key_type *types;
350 unsigned int num_types;
352 darray(struct xkb_sym_interpret) sym_interpret;
354 /* vmod -> mod mapping */
355 xkb_mod_mask_t vmods[XkbNumVirtualMods];
356 xkb_atom_t vmod_names[XkbNumVirtualMods];
358 /* Number of groups in the key with the most groups. */
359 xkb_group_index_t num_groups;
360 xkb_atom_t group_names[XKB_NUM_GROUPS];
362 struct xkb_indicator_map indicators[XKB_NUM_INDICATORS];
364 char *keycodes_section_name;
365 char *symbols_section_name;
366 char *types_section_name;
367 char *compat_section_name;
370 static inline struct xkb_key *
371 XkbKey(struct xkb_keymap *keymap, xkb_keycode_t kc)
373 return &darray_item(keymap->keys, kc);
376 static inline xkb_keycode_t
377 XkbKeyGetKeycode(struct xkb_keymap *keymap, struct xkb_key *key)
379 /* Hack to avoid having to keep the keycode inside the xkb_key. */
380 return (xkb_keycode_t)(key - keymap->keys.item);
383 #define xkb_foreach_key_from(iter, keymap, from) \
384 darray_foreach_from(iter, keymap->keys, from)
386 #define xkb_foreach_key(iter, keymap) \
387 xkb_foreach_key_from(iter, keymap, keymap->min_key_code)
389 static inline struct xkb_key_type *
390 XkbKeyType(struct xkb_keymap *keymap, struct xkb_key *key,
391 xkb_group_index_t group)
393 return &keymap->types[key->kt_index[group]];
396 static inline xkb_level_index_t
397 XkbKeyGroupWidth(struct xkb_keymap *keymap, struct xkb_key *key,
398 xkb_group_index_t group)
400 return XkbKeyType(keymap, key, group)->num_levels;
403 static inline unsigned int
404 XkbKeyNumSyms(struct xkb_key *key, xkb_group_index_t group,
405 xkb_level_index_t level)
407 return key->num_syms[group * key->width + level];
410 static inline xkb_keysym_t *
411 XkbKeySymEntry(struct xkb_key *key, xkb_group_index_t group,
412 xkb_level_index_t level)
414 return &darray_item(key->syms,
415 key->sym_index[group * key->width + level]);
418 static inline union xkb_action *
419 XkbKeyActionEntry(struct xkb_key *key, xkb_group_index_t group,
420 xkb_level_index_t level)
422 return &key->actions[key->width * group + level];
426 XkbKeycodeInRange(struct xkb_keymap *keymap, xkb_keycode_t kc)
428 return kc >= keymap->min_key_code && kc <= keymap->max_key_code;
432 xkb_map_new(struct xkb_context *ctx);
435 * Returns XKB_ATOM_NONE if @string was not previously interned,
436 * otherwise returns the atom.
439 xkb_atom_lookup(struct xkb_context *ctx, const char *string);
442 xkb_atom_intern(struct xkb_context *ctx, const char *string);
445 * If @string is dynamically allocated, free'd immediately after
446 * being interned, and not used afterwards, use this function
447 * instead of xkb_atom_intern to avoid some unnecessary allocations.
448 * The caller should not use or free the passed in string afterwards.
451 xkb_atom_steal(struct xkb_context *ctx, char *string);
454 xkb_atom_strdup(struct xkb_context *ctx, xkb_atom_t atom);
457 xkb_atom_text(struct xkb_context *ctx, xkb_atom_t atom);
460 xkb_key_get_group(struct xkb_state *state, xkb_keycode_t kc);
463 xkb_key_get_level(struct xkb_state *state, xkb_keycode_t kc,
464 xkb_group_index_t group);
467 xkb_key_get_syms_by_level(struct xkb_keymap *keymap, struct xkb_key *key,
468 xkb_group_index_t group, xkb_level_index_t level,
469 const xkb_keysym_t **syms_out);
472 xkb_context_take_file_id(struct xkb_context *ctx);
475 xkb_keysym_is_lower(xkb_keysym_t keysym);
478 xkb_keysym_is_upper(xkb_keysym_t keysym);
481 xkb_keysym_is_keypad(xkb_keysym_t keysym);
483 ATTR_PRINTF(3, 4) void
484 xkb_log(struct xkb_context *ctx, enum xkb_log_level level,
485 const char *fmt, ...);
487 #define xkb_log_cond_level(ctx, level, ...) do { \
488 if (xkb_get_log_level(ctx) >= (level)) \
489 xkb_log((ctx), (level), __VA_ARGS__); \
492 #define xkb_log_cond_verbosity(ctx, level, vrb, ...) do { \
493 if (xkb_get_log_verbosity(ctx) >= (vrb)) \
494 xkb_log_cond_level((ctx), (level), __VA_ARGS__); \
498 * The format is not part of the argument list in order to avoid the
499 * "ISO C99 requires rest arguments to be used" warning when only the
500 * format is supplied without arguments. Not supplying it would still
501 * result in an error, though.
503 #define log_dbg(ctx, ...) \
504 xkb_log_cond_level((ctx), XKB_LOG_LEVEL_DEBUG, __VA_ARGS__)
505 #define log_info(ctx, ...) \
506 xkb_log_cond_level((ctx), XKB_LOG_LEVEL_INFO, __VA_ARGS__)
507 #define log_warn(ctx, ...) \
508 xkb_log_cond_level((ctx), XKB_LOG_LEVEL_WARNING, __VA_ARGS__)
509 #define log_err(ctx, ...) \
510 xkb_log_cond_level((ctx), XKB_LOG_LEVEL_ERROR, __VA_ARGS__)
511 #define log_wsgo(ctx, ...) \
512 xkb_log_cond_level((ctx), XKB_LOG_LEVEL_CRITICAL, __VA_ARGS__)
513 #define log_vrb(ctx, vrb, ...) \
514 xkb_log_cond_verbosity((ctx), XKB_LOG_LEVEL_WARNING, (vrb), __VA_ARGS__)
516 #endif /* XKB_PRIV_H */