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 © 2009-2012 Daniel Stone
56 * Copyright © 2012 Intel Corporation
57 * Copyright © 2012 Ran Benita
59 * Permission is hereby granted, free of charge, to any person obtaining a
60 * copy of this software and associated documentation files (the "Software"),
61 * to deal in the Software without restriction, including without limitation
62 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
63 * and/or sell copies of the Software, and to permit persons to whom the
64 * Software is furnished to do so, subject to the following conditions:
66 * The above copyright notice and this permission notice (including the next
67 * paragraph) shall be included in all copies or substantial portions of the
70 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
71 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
72 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
73 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
74 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
75 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
76 * DEALINGS IN THE SOFTWARE.
78 * Author: Daniel Stone <daniel@fooishbar.org>
88 #include <xkbcommon/xkbcommon-names.h>
89 #include <xkbcommon/xkbcommon-keysyms.h>
97 * Main libxkbcommon API.
101 * @struct xkb_context
102 * Opaque top level library context object.
104 * The context contains various general library data and state, like
105 * logging level and include paths.
107 * Objects are created in a specific context, and multiple contexts may
108 * coexist simultaneously. Objects from different contexts are completely
109 * separated and do not share any memory or state.
115 * Opaque compiled keymap object.
117 * The keymap object holds all of the static keyboard information obtained
118 * from compiling XKB files.
120 * A keymap is immutable after it is created (besides reference counts, etc.);
121 * if you need to change it, you must create a new one.
127 * Opaque keyboard state object.
129 * State objects contain the active state of a keyboard (or keyboards), such
130 * as the currently effective layout and the active modifiers. It acts as a
131 * simple state machine, wherein key presses and releases are the input, and
132 * key symbols (keysyms) are the output.
137 * A number used to represent a physical key on a keyboard.
139 * A standard PC-compatible keyboard might have 102 keys. An appropriate
140 * keymap would assign each of them a keycode, by which the user should
141 * refer to the key throughout the library.
143 * Historically, the X11 protocol, and consequentially the XKB protocol,
144 * assign only 8 bits for keycodes. This limits the number of different
145 * keys that can be used simultaneously in a single keymap to 256
146 * (disregarding other limitations). This library does not share this limit;
147 * keycodes beyond 255 ('extended keycodes') are not treated specially.
148 * Keymaps and applications which are compatible with X11 should not use
151 * The values of specific keycodes are determined by the keymap and the
152 * underlying input system. For example, with an X11-compatible keymap
153 * and Linux evdev scan codes (see linux/input.h), a fixed offset is used:
156 * xkb_keycode_t keycode_A = KEY_A + 8;
159 * @sa xkb_keycode_is_legal_ext() xkb_keycode_is_legal_x11()
161 typedef uint32_t xkb_keycode_t;
164 * A number used to represent the symbols generated from a key on a keyboard.
166 * A key, represented by a keycode, may generate different symbols according
167 * to keyboard state. For example, on a QWERTY keyboard, pressing the key
168 * labled \<A\> generates the symbol 'a'. If the Shift key is held, it
169 * generates the symbol 'A'. If a different layout is used, say Greek,
170 * it generates the symbol 'α'. And so on.
172 * Each such symbol is represented by a keysym. Note that keysyms are
173 * somewhat more general, in that they can also represent some "function",
174 * such as "Left" or "Right" for the arrow keys. For more information,
176 * http://www.x.org/releases/X11R7.7/doc/xproto/x11protocol.html#keysym_encoding
178 * Specifically named keysyms can be found in the
179 * xkbcommon/xkbcommon-keysyms.h header file. Their name does not include
180 * the XKB_KEY_ prefix.
182 * Besides those, any Unicode/ISO 10646 character in the range U0100 to
183 * U10FFFF can be represented by a keysym value in the range 0x01000100 to
184 * 0x0110FFFF. The name of Unicode keysyms is "U<codepoint>", e.g. "UA1B2".
186 * The name of other unnamed keysyms is the hexadecimal representation of
187 * their value, e.g. "0xabcd1234".
189 * Keysym names are case-sensitive.
191 typedef uint32_t xkb_keysym_t;
194 * Index of a keyboard layout.
196 * The layout index is a state component which detemines which <em>keyboard
197 * layout</em> is active. These may be different alphabets, different key
200 * Layout indices are consecutive. The first layout has index 0.
202 * Each layout is not required to have a name, and the names are not
203 * guaranteed to be unique (though they are usually provided and unique).
204 * Therefore, it is not safe to use the name as a unique identifier for a
205 * layout. Layout names are case-sensitive.
207 * Layouts are also called "groups" by XKB.
209 * @sa xkb_keymap_num_layouts() xkb_keymap_num_layouts_for_key()
211 typedef uint32_t xkb_layout_index_t;
212 /** A mask of layout indices. */
213 typedef uint32_t xkb_layout_mask_t;
216 * Index of a shift level.
218 * Any key, in any layout, can have several <em>shift levels</em>. Each
219 * shift level can assign different keysyms to the key. The shift level
220 * to use is chosen according to the current keyboard state; for example,
221 * if no keys are pressed, the first level may be used; if the Left Shift
222 * key is pressed, the second; if Num Lock is pressed, the third; and
223 * many such combinations are possible (see xkb_mod_index_t).
225 * Level indices are consecutive. The first level has index 0.
227 typedef uint32_t xkb_level_index_t;
230 * Index of a modifier.
232 * A @e modifier is a state component which changes the way keys are
233 * interpreted. A keymap defines a set of modifiers, such as Alt, Shift,
234 * Num Lock or Meta, and specifies which keys may @e activate which
235 * modifiers (in a many-to-many relationship, i.e. a key can activate
236 * several modifiers, and a modifier may be activated by several keys.
237 * Different keymaps do this differently).
239 * When retrieving the keysyms for a key, the active modifier set is
240 * consulted; this detemines the correct shift level to use within the
241 * currently active layout (see xkb_level_index_t).
243 * Modifier indices are consecutive. The first modifier has index 0.
245 * Each modifier must have a name, and the names are unique. Therefore, it
246 * is safe to use the name as a unique identifier for a modifier. The names
247 * of some common modifiers are provided in the xkbcommon/xkbcommon-names.h
248 * header file. Modifier names are case-sensitive.
250 * @sa xkb_keymap_num_mods()
252 typedef uint32_t xkb_mod_index_t;
253 /** A mask of modifier indices. */
254 typedef uint32_t xkb_mod_mask_t;
257 * Index of a keyboard LED.
259 * LEDs are logical objects which may be @e active or @e inactive. They
260 * typically correspond to the lights on the keyboard. Their state is
261 * determined by the current keyboard state.
263 * LED indices are non-consecutive. The first LED has index 0.
265 * Each LED must have a name, and the names are unique. Therefore,
266 * it is safe to use the name as a unique identifier for a LED. The names
267 * of some common LEDs are provided in the xkbcommon/xkbcommon-names.h
268 * header file. LED names are case-sensitive.
270 * @warning A given keymap may specify an exact index for a given LED.
271 * Therefore, LED indexing is not necessarily sequential, as opposed to
272 * modifiers and layouts. This means that when iterating over the LEDs
273 * in a keymap using e.g. xkb_keymap_num_leds(), some indices might be
274 * invalid. Given such an index, functions like xkb_keymap_led_get_name()
275 * will return NULL, and xkb_state_led_index_is_active() will return -1.
277 * LEDs are also called "indicators" by XKB.
279 * @sa xkb_keymap_num_leds()
281 typedef uint32_t xkb_led_index_t;
282 /** A mask of LED indices. */
283 typedef uint32_t xkb_led_mask_t;
285 #define XKB_KEYCODE_INVALID (0xffffffff)
286 #define XKB_LAYOUT_INVALID (0xffffffff)
287 #define XKB_LEVEL_INVALID (0xffffffff)
288 #define XKB_MOD_INVALID (0xffffffff)
289 #define XKB_LED_INVALID (0xffffffff)
291 #define XKB_KEYCODE_MAX (0xffffffff - 1)
294 * Test whether a value is a valid extended keycode.
297 #define xkb_keycode_is_legal_ext(key) (key <= XKB_KEYCODE_MAX)
300 * Test whether a value is a valid X11 keycode.
303 #define xkb_keycode_is_legal_x11(key) (key >= 8 && key <= 255)
306 * Names to compile a keymap with, also known as RMLVO.
308 * The names are the common configuration values by which a user picks
311 * If the entire struct is NULL, then each field is taken to be NULL.
312 * You should prefer passing NULL instead of choosing your own defaults.
314 struct xkb_rule_names {
316 * The rules file to use. The rules file describes how to interpret
317 * the values of the model, layout, variant and options fields.
319 * If NULL or the empty string "", a default value is used.
320 * If the XKB_DEFAULT_RULES environment variable is set, it is used
321 * as the default. Otherwise the system default is used.
325 * The keyboard model by which to interpret keycodes and LEDs.
327 * If NULL or the empty string "", a default value is used.
328 * If the XKB_DEFAULT_MODEL environment variable is set, it is used
329 * as the default. Otherwise the system default is used.
333 * A comma separated list of layouts (languages) to include in the
336 * If NULL or the empty string "", a default value is used.
337 * If the XKB_DEFAULT_LAYOUT environment variable is set, it is used
338 * as the default. Otherwise the system default is used.
342 * A comma separated list of variants, one per layout, which may
343 * modify or augment the respective layout in various ways.
345 * If NULL or the empty string "", and a default value is also used
346 * for the layout, a default value is used. Otherwise no variant is
348 * If the XKB_DEFAULT_VARIANT environment variable is set, it is used
349 * as the default. Otherwise the system default is used.
353 * A comma separated list of options, through which the user specifies
354 * non-layout related preferences, like which key combinations are used
355 * for switching layouts, or which key is the Compose key.
357 * If NULL, a default value is used. If the empty string "", no
359 * If the XKB_DEFAULT_OPTIONS environment variable is set, it is used
360 * as the default. Otherwise the system default is used.
366 * @defgroup keysyms Keysyms
367 * Utility functions related to keysyms.
373 * @page keysym-transformations Keysym Transformations
375 * Keysym translation is subject to several "keysym transformations",
376 * as described in the XKB specification. These are:
378 * - Capitalization transformation. If the Caps Lock modifier is
379 * active and was not consumed by the translation process, a single
380 * keysym is transformed to its upper-case form (if applicable).
381 * Similarly, the UTF-8/UTF-32 string produced is capitalized.
383 * This is described in:
384 * http://www.x.org/releases/current/doc/kbproto/xkbproto.html#Interpreting_the_Lock_Modifier
386 * - Control transformation. If the Control modifier is active and
387 * was not consumed by the translation process, the string produced
388 * is transformed to its matching ASCII control character (if
389 * applicable). Keysyms are not affected.
391 * This is described in:
392 * http://www.x.org/releases/current/doc/kbproto/xkbproto.html#Interpreting_the_Control_Modifier
394 * Each relevant function discusses which transformations it performs.
396 * These transformations are not applicable when a key produces multiple
402 * Get the name of a keysym.
404 * For a description of how keysyms are named, see @ref xkb_keysym_t.
406 * @param[in] keysym The keysym.
407 * @param[out] buffer A string buffer to write the name into.
408 * @param[in] size Size of the buffer.
410 * @warning If the buffer passed is too small, the string is truncated
411 * (though still NUL-terminated); a size of at least 64 bytes is recommended.
413 * @returns The number of bytes in the name, excluding the NUL byte. If
414 * the keysym is invalid, returns -1.
416 * You may check if truncation has occurred by comparing the return value
417 * with the length of buffer, similarly to the snprintf(3) function.
422 xkb_keysym_get_name(xkb_keysym_t keysym, char *buffer, size_t size);
424 /** Flags for xkb_keysym_from_name(). */
425 enum xkb_keysym_flags {
426 /** Do not apply any flags. */
427 XKB_KEYSYM_NO_FLAGS = 0,
428 /** Find keysym by case-insensitive search. */
429 XKB_KEYSYM_CASE_INSENSITIVE = (1 << 0)
433 * Get a keysym from its name.
435 * @param name The name of a keysym. See remarks in xkb_keysym_get_name();
436 * this function will accept any name returned by that function.
437 * @param flags A set of flags controlling how the search is done. If
438 * invalid flags are passed, this will fail with XKB_KEY_NoSymbol.
440 * If you use the XKB_KEYSYM_CASE_INSENSITIVE flag and two keysym names
441 * differ only by case, then the lower-case keysym is returned. For
442 * instance, for KEY_a and KEY_A, this function would return KEY_a for the
443 * case-insensitive search. If this functionality is needed, it is
444 * recommended to first call this function without this flag; and if that
445 * fails, only then to try with this flag, while possibly warning the user
446 * he had misspelled the name, and might get wrong results.
448 * @returns The keysym. If the name is invalid, returns XKB_KEY_NoSymbol.
453 xkb_keysym_from_name(const char *name, enum xkb_keysym_flags flags);
456 * Get the Unicode/UTF-8 representation of a keysym.
458 * @param[in] keysym The keysym.
459 * @param[out] buffer A buffer to write the UTF-8 string into.
460 * @param[in] size The size of buffer. Must be at least 7.
462 * @returns The number of bytes written to the buffer (including the
463 * terminating byte). If the keysym does not have a Unicode
464 * representation, returns 0. If the buffer is too small, returns -1.
466 * This function does not perform any @ref keysym-transformations.
467 * Therefore, prefer to use xkb_state_key_get_utf8() if possible.
469 * @sa xkb_state_key_get_utf8()
472 xkb_keysym_to_utf8(xkb_keysym_t keysym, char *buffer, size_t size);
475 * Get the Unicode/UTF-32 representation of a keysym.
477 * @returns The Unicode/UTF-32 representation of keysym, which is also
478 * compatible with UCS-4. If the keysym does not have a Unicode
479 * representation, returns 0.
481 * This function does not perform any @ref keysym-transformations.
482 * Therefore, prefer to use xkb_state_key_get_utf32() if possible.
484 * @sa xkb_state_key_get_utf32()
487 xkb_keysym_to_utf32(xkb_keysym_t keysym);
492 * @defgroup context Library Context
493 * Creating, destroying and using library contexts.
495 * Every keymap compilation request must have a context associated with
496 * it. The context keeps around state such as the include path.
501 /** Flags for context creation. */
502 enum xkb_context_flags {
503 /** Do not apply any context flags. */
504 XKB_CONTEXT_NO_FLAGS = 0,
505 /** Create this context with an empty include path. */
506 XKB_CONTEXT_NO_DEFAULT_INCLUDES = (1 << 0),
508 * Don't take RMLVO names from the environment.
511 XKB_CONTEXT_NO_ENVIRONMENT_NAMES = (1 << 1)
515 * Create a new context.
517 * @param flags Optional flags for the context, or 0.
519 * @returns A new context, or NULL on failure.
521 * The user may set some environment variables to affect default values in
522 * the context. See e.g. xkb_context_set_log_level() and
523 * xkb_context_set_log_verbosity().
525 * @memberof xkb_context
528 xkb_context_new(enum xkb_context_flags flags);
531 * Take a new reference on a context.
533 * @returns The passed in context.
535 * @memberof xkb_context
538 xkb_context_ref(struct xkb_context *context);
541 * Release a reference on a context, and possibly free it.
543 * @param context The context. If it is NULL, this function does nothing.
545 * @memberof xkb_context
548 xkb_context_unref(struct xkb_context *context);
551 * Store custom user data in the context.
553 * This may be useful in conjunction with xkb_context_set_log_fn() or other
556 * @memberof xkb_context
559 xkb_context_set_user_data(struct xkb_context *context, void *user_data);
562 * Retrieves stored user data from the context.
564 * @returns The stored user data. If the user data wasn't set, or the
565 * passed in context is NULL, returns NULL.
567 * This may be useful to access private user data from callbacks like a
568 * custom logging function.
570 * @memberof xkb_context
573 xkb_context_get_user_data(struct xkb_context *context);
578 * @defgroup include-path Include Paths
579 * Manipulating the include paths in a context.
581 * The include paths are the file-system paths that are searched when an
582 * include statement is encountered during keymap compilation.
583 * In most cases, the default include paths are sufficient.
589 * Append a new entry to the context's include path.
591 * @returns 1 on success, or 0 if the include path could not be added or is
594 * @memberof xkb_context
597 xkb_context_include_path_append(struct xkb_context *context, const char *path);
600 * Append the default include paths to the context's include path.
602 * @returns 1 on success, or 0 if the primary include path could not be added.
604 * @memberof xkb_context
607 xkb_context_include_path_append_default(struct xkb_context *context);
610 * Reset the context's include path to the default.
612 * Removes all entries from the context's include path, and inserts the
615 * @returns 1 on success, or 0 if the primary include path could not be added.
617 * @memberof xkb_context
620 xkb_context_include_path_reset_defaults(struct xkb_context *context);
623 * Remove all entries from the context's include path.
625 * @memberof xkb_context
628 xkb_context_include_path_clear(struct xkb_context *context);
631 * Get the number of paths in the context's include path.
633 * @memberof xkb_context
636 xkb_context_num_include_paths(struct xkb_context *context);
639 * Get a specific include path from the context's include path.
641 * @returns The include path at the specified index. If the index is
642 * invalid, returns NULL.
644 * @memberof xkb_context
647 xkb_context_include_path_get(struct xkb_context *context, unsigned int index);
652 * @defgroup logging Logging Handling
653 * Manipulating how logging from this library is handled.
658 /** Specifies a logging level. */
660 XKB_LOG_LEVEL_CRITICAL = 10, /**< Log critical internal errors only. */
661 XKB_LOG_LEVEL_ERROR = 20, /**< Log all errors. */
662 XKB_LOG_LEVEL_WARNING = 30, /**< Log warnings and errors. */
663 XKB_LOG_LEVEL_INFO = 40, /**< Log information, warnings, and errors. */
664 XKB_LOG_LEVEL_DEBUG = 50 /**< Log everything. */
668 * Set the current logging level.
670 * @param context The context in which to set the logging level.
671 * @param level The logging level to use. Only messages from this level
672 * and below will be logged.
674 * The default level is XKB_LOG_LEVEL_ERROR. The environment variable
675 * XKB_LOG_LEVEL, if set in the time the context was created, overrides the
676 * default value. It may be specified as a level number or name.
678 * @memberof xkb_context
681 xkb_context_set_log_level(struct xkb_context *context,
682 enum xkb_log_level level);
685 * Get the current logging level.
687 * @memberof xkb_context
690 xkb_context_get_log_level(struct xkb_context *context);
693 * Sets the current logging verbosity.
695 * The library can generate a number of warnings which are not helpful to
696 * ordinary users of the library. The verbosity may be increased if more
697 * information is desired (e.g. when developing a new keymap).
699 * The default verbosity is 0. The environment variable XKB_LOG_VERBOSITY,
700 * if set in the time the context was created, overrides the default value.
702 * @param context The context in which to use the set verbosity.
703 * @param verbosity The verbosity to use. Currently used values are
704 * 1 to 10, higher values being more verbose. 0 would result in no verbose
705 * messages being logged.
707 * Most verbose messages are of level XKB_LOG_LEVEL_WARNING or lower.
709 * @memberof xkb_context
712 xkb_context_set_log_verbosity(struct xkb_context *context, int verbosity);
715 * Get the current logging verbosity of the context.
717 * @memberof xkb_context
720 xkb_context_get_log_verbosity(struct xkb_context *context);
723 * Set a custom function to handle logging messages.
725 * @param context The context in which to use the set logging function.
726 * @param log_fn The function that will be called for logging messages.
727 * Passing NULL restores the default function, which logs to stderr.
729 * By default, log messages from this library are printed to stderr. This
730 * function allows you to replace the default behavior with a custom
731 * handler. The handler is only called with messages which match the
732 * current logging level and verbosity settings for the context.
733 * level is the logging level of the message. @a format and @a args are
734 * the same as in the vprintf(3) function.
736 * You may use xkb_context_set_user_data() on the context, and then call
737 * xkb_context_get_user_data() from within the logging function to provide
738 * it with additional private context.
740 * @memberof xkb_context
743 xkb_context_set_log_fn(struct xkb_context *context,
744 void (*log_fn)(struct xkb_context *context,
745 enum xkb_log_level level,
746 const char *format, va_list args));
751 * @defgroup keymap Keymap Creation
752 * Creating and destroying keymaps.
757 /** Flags for keymap compilation. */
758 enum xkb_keymap_compile_flags {
759 /** Do not apply any flags. */
760 XKB_KEYMAP_COMPILE_NO_FLAGS = 0
764 * Create a keymap from RMLVO names.
766 * The primary keymap entry point: creates a new XKB keymap from a set of
767 * RMLVO (Rules + Model + Layouts + Variants + Options) names.
769 * @param context The context in which to create the keymap.
770 * @param names The RMLVO names to use. See xkb_rule_names.
771 * @param flags Optional flags for the keymap, or 0.
773 * @returns A keymap compiled according to the RMLVO names, or NULL if
774 * the compilation failed.
777 * @memberof xkb_keymap
780 xkb_keymap_new_from_names(struct xkb_context *context,
781 const struct xkb_rule_names *names,
782 enum xkb_keymap_compile_flags flags);
784 /** The possible keymap formats. */
785 enum xkb_keymap_format {
786 /** The current/classic XKB text format, as generated by xkbcomp -xkb. */
787 XKB_KEYMAP_FORMAT_TEXT_V1 = 1
791 * Create a keymap from a keymap file.
793 * @param context The context in which to create the keymap.
794 * @param file The keymap file to compile.
795 * @param format The text format of the keymap file to compile.
796 * @param flags Optional flags for the keymap, or 0.
798 * @returns A keymap compiled from the given XKB keymap file, or NULL if
799 * the compilation failed.
801 * The file must contain a complete keymap. For example, in the
802 * XKB_KEYMAP_FORMAT_TEXT_V1 format, this means the file must contain one
803 * top level '%xkb_keymap' section, which in turn contains other required
806 * @memberof xkb_keymap
809 xkb_keymap_new_from_file(struct xkb_context *context, FILE *file,
810 enum xkb_keymap_format format,
811 enum xkb_keymap_compile_flags flags);
814 * Create a keymap from a keymap string.
816 * This is just like xkb_keymap_new_from_file(), but instead of a file, gets
817 * the keymap as one enormous string.
819 * @see xkb_keymap_new_from_file()
820 * @memberof xkb_keymap
823 xkb_keymap_new_from_string(struct xkb_context *context, const char *string,
824 enum xkb_keymap_format format,
825 enum xkb_keymap_compile_flags flags);
828 * Create a keymap from a memory buffer.
830 * This is just like xkb_keymap_new_from_string(), but takes a length argument
831 * so the input string does not have to be zero-terminated.
833 * @see xkb_keymap_new_from_string()
834 * @memberof xkb_keymap
838 xkb_keymap_new_from_buffer(struct xkb_context *context, const char *buffer,
839 size_t length, enum xkb_keymap_format format,
840 enum xkb_keymap_compile_flags flags);
843 * Take a new reference on a keymap.
845 * @returns The passed in keymap.
847 * @memberof xkb_keymap
850 xkb_keymap_ref(struct xkb_keymap *keymap);
853 * Release a reference on a keymap, and possibly free it.
855 * @param keymap The keymap. If it is NULL, this function does nothing.
857 * @memberof xkb_keymap
860 xkb_keymap_unref(struct xkb_keymap *keymap);
863 * Get the keymap as a string in the format from which it was created.
864 * @sa xkb_keymap_get_as_string()
866 #define XKB_KEYMAP_USE_ORIGINAL_FORMAT ((enum xkb_keymap_format) -1)
869 * Get the compiled keymap as a string.
871 * @param keymap The keymap to get as a string.
872 * @param format The keymap format to use for the string. You can pass
873 * in the special value XKB_KEYMAP_USE_ORIGINAL_FORMAT to use the format
874 * from which the keymap was originally created.
876 * @returns The keymap as a NUL-terminated string, or NULL if unsuccessful.
878 * The returned string may be fed back into xkb_map_new_from_string() to get
879 * the exact same keymap (possibly in another process, etc.).
881 * The returned string is dynamically allocated and should be freed by the
884 * @memberof xkb_keymap
887 xkb_keymap_get_as_string(struct xkb_keymap *keymap,
888 enum xkb_keymap_format format);
893 * @defgroup components Keymap Components
894 * Enumeration of state components in a keymap.
900 * Get the minimum keycode in the keymap.
903 * @memberof xkb_keymap
907 xkb_keymap_min_keycode(struct xkb_keymap *keymap);
910 * Get the maximum keycode in the keymap.
913 * @memberof xkb_keymap
917 xkb_keymap_max_keycode(struct xkb_keymap *keymap);
920 * The iterator used by xkb_keymap_key_for_each().
922 * @sa xkb_keymap_key_for_each
923 * @memberof xkb_keymap
927 (*xkb_keymap_key_iter_t)(struct xkb_keymap *keymap, xkb_keycode_t key,
931 * Run a specified function for every valid keycode in the keymap. If a
932 * keymap is sparse, this function may be called fewer than
933 * (max_keycode - min_keycode + 1) times.
935 * @sa xkb_keymap_min_keycode() xkb_keymap_max_keycode() xkb_keycode_t
936 * @memberof xkb_keymap
940 xkb_keymap_key_for_each(struct xkb_keymap *keymap, xkb_keymap_key_iter_t iter,
944 * Find the name of the key with the given keycode.
946 * @returns The key name. If no key with this keycode exists,
950 * @memberof xkb_keymap
954 xkb_keymap_key_get_name(struct xkb_keymap *keymap, xkb_keycode_t key);
957 * Find the keycode of the key with the given name.
959 * @returns The keycode. If no key with this name exists,
960 * returns XKB_KEYCODE_INVALID.
963 * @memberof xkb_keymap
967 xkb_keymap_key_by_name(struct xkb_keymap *keymap, const char *name);
970 * Get the number of modifiers in the keymap.
972 * @sa xkb_mod_index_t
973 * @memberof xkb_keymap
976 xkb_keymap_num_mods(struct xkb_keymap *keymap);
979 * Get the name of a modifier by index.
981 * @returns The name. If the index is invalid, returns NULL.
983 * @sa xkb_mod_index_t
984 * @memberof xkb_keymap
987 xkb_keymap_mod_get_name(struct xkb_keymap *keymap, xkb_mod_index_t idx);
990 * Get the index of a modifier by name.
992 * @returns The index. If no modifier with this name exists, returns
995 * @sa xkb_mod_index_t
996 * @memberof xkb_keymap
999 xkb_keymap_mod_get_index(struct xkb_keymap *keymap, const char *name);
1002 * Get the number of layouts in the keymap.
1004 * @sa xkb_layout_index_t xkb_rule_names xkb_keymap_num_layouts_for_key()
1005 * @memberof xkb_keymap
1008 xkb_keymap_num_layouts(struct xkb_keymap *keymap);
1011 * Get the name of a layout by index.
1013 * @returns The name. If the index is invalid, or the layout does not have
1014 * a name, returns NULL.
1016 * @sa xkb_layout_index_t
1017 * @memberof xkb_keymap
1020 xkb_keymap_layout_get_name(struct xkb_keymap *keymap, xkb_layout_index_t idx);
1023 * Get the index of a layout by name.
1025 * @returns The index. If no layout exists with this name, returns
1026 * XKB_LAYOUT_INVALID. If more than one layout in the keymap has this name,
1027 * returns the lowest index among them.
1029 * @memberof xkb_keymap
1032 xkb_keymap_layout_get_index(struct xkb_keymap *keymap, const char *name);
1035 * Get the number of LEDs in the keymap.
1037 * @warning The range [ 0...xkb_keymap_num_leds() ) includes all of the LEDs
1038 * in the keymap, but may also contain inactive LEDs. When iterating over
1039 * this range, you need the handle this case when calling functions such as
1040 * xkb_keymap_led_get_name() or xkb_state_led_index_is_active().
1042 * @sa xkb_led_index_t
1043 * @memberof xkb_keymap
1046 xkb_keymap_num_leds(struct xkb_keymap *keymap);
1049 * Get the name of a LED by index.
1051 * @returns The name. If the index is invalid, returns NULL.
1053 * @memberof xkb_keymap
1056 xkb_keymap_led_get_name(struct xkb_keymap *keymap, xkb_led_index_t idx);
1059 * Get the index of a LED by name.
1061 * @returns The index. If no LED with this name exists, returns
1064 * @memberof xkb_keymap
1067 xkb_keymap_led_get_index(struct xkb_keymap *keymap, const char *name);
1070 * Get the number of layouts for a specific key.
1072 * This number can be different from xkb_keymap_num_layouts(), but is always
1073 * smaller. It is the appropriate value to use when iterating over the
1076 * @sa xkb_layout_index_t
1077 * @memberof xkb_keymap
1080 xkb_keymap_num_layouts_for_key(struct xkb_keymap *keymap, xkb_keycode_t key);
1083 * Get the number of shift levels for a specific key and layout.
1085 * If @c layout is out of range for this key (that is, larger or equal to
1086 * the value returned by xkb_keymap_num_layouts_for_key()), it is brought
1087 * back into range in a manner consistent with xkb_state_key_get_layout().
1089 * @sa xkb_level_index_t
1090 * @memberof xkb_keymap
1093 xkb_keymap_num_levels_for_key(struct xkb_keymap *keymap, xkb_keycode_t key,
1094 xkb_layout_index_t layout);
1097 * Get the keysyms obtained from pressing a key in a given layout and
1100 * This function is like xkb_state_key_get_syms(), only the layout and
1101 * shift level are not derived from the keyboard state but are instead
1102 * specified explicitly.
1104 * @param[in] keymap The keymap.
1105 * @param[in] key The keycode of the key.
1106 * @param[in] layout The layout for which to get the keysyms.
1107 * @param[in] level The shift level in the layout for which to get the
1108 * keysyms. This must be smaller than:
1109 * @code xkb_keymap_num_levels_for_key(keymap, key) @endcode
1110 * @param[out] syms_out An immutable array of keysyms corresponding to the
1111 * key in the given layout and shift level.
1113 * If @c layout is out of range for this key (that is, larger or equal to
1114 * the value returned by xkb_keymap_num_layouts_for_key()), it is brought
1115 * back into range in a manner consistent with xkb_state_key_get_layout().
1117 * @returns The number of keysyms in the syms_out array. If no keysyms
1118 * are produced by the key in the given layout and shift level, returns 0
1119 * and sets syms_out to NULL.
1121 * @sa xkb_state_key_get_syms()
1122 * @memberof xkb_keymap
1125 xkb_keymap_key_get_syms_by_level(struct xkb_keymap *keymap,
1127 xkb_layout_index_t layout,
1128 xkb_level_index_t level,
1129 const xkb_keysym_t **syms_out);
1132 * Determine whether a key should repeat or not.
1134 * A keymap may specify different repeat behaviors for different keys.
1135 * Most keys should generally exhibit repeat behavior; for example, holding
1136 * the 'a' key down in a text editor should normally insert a single 'a'
1137 * character every few milliseconds, until the key is released. However,
1138 * there are keys which should not or do not need to be repeated. For
1139 * example, repeating modifier keys such as Left/Right Shift or Caps Lock
1140 * is not generally useful or desired.
1142 * @returns 1 if the key should repeat, 0 otherwise.
1144 * @memberof xkb_keymap
1147 xkb_keymap_key_repeats(struct xkb_keymap *keymap, xkb_keycode_t key);
1152 * @defgroup state Keyboard State
1153 * Creating, destroying and manipulating keyboard state objects.
1159 * Create a new keyboard state object.
1161 * @param keymap The keymap which the state will use.
1163 * @returns A new keyboard state object, or NULL on failure.
1165 * @memberof xkb_state
1168 xkb_state_new(struct xkb_keymap *keymap);
1171 * Take a new reference on a keyboard state object.
1173 * @returns The passed in object.
1175 * @memberof xkb_state
1178 xkb_state_ref(struct xkb_state *state);
1181 * Release a reference on a keybaord state object, and possibly free it.
1183 * @param state The state. If it is NULL, this function does nothing.
1185 * @memberof xkb_state
1188 xkb_state_unref(struct xkb_state *state);
1191 * Get the keymap which a keyboard state object is using.
1193 * @returns The keymap which was passed to xkb_state_new() when creating
1194 * this state object.
1196 * This function does not take a new reference on the keymap; you must
1197 * explicitly reference it yourself if you plan to use it beyond the
1198 * lifetime of the state.
1200 * @memberof xkb_state
1203 xkb_state_get_keymap(struct xkb_state *state);
1205 /** Specifies the direction of the key (press / release). */
1206 enum xkb_key_direction {
1207 XKB_KEY_UP, /**< The key was released. */
1208 XKB_KEY_DOWN /**< The key was pressed. */
1212 * Modifier and layout types for state objects. This enum is bitmaskable,
1213 * e.g. (XKB_STATE_MODS_DEPRESSED | XKB_STATE_MODS_LATCHED) is valid to
1214 * exclude locked modifiers.
1216 * In XKB, the DEPRESSED components are also known as 'base'.
1218 enum xkb_state_component {
1219 /** Depressed modifiers, i.e. a key is physically holding them. */
1220 XKB_STATE_MODS_DEPRESSED = (1 << 0),
1221 /** Latched modifiers, i.e. will be unset after the next non-modifier
1223 XKB_STATE_MODS_LATCHED = (1 << 1),
1224 /** Locked modifiers, i.e. will be unset after the key provoking the
1225 * lock has been pressed again. */
1226 XKB_STATE_MODS_LOCKED = (1 << 2),
1227 /** Effective modifiers, i.e. currently active and affect key
1228 * processing (derived from the other state components).
1229 * Use this unless you explictly care how the state came about. */
1230 XKB_STATE_MODS_EFFECTIVE = (1 << 3),
1231 /** Depressed layout, i.e. a key is physically holding it. */
1232 XKB_STATE_LAYOUT_DEPRESSED = (1 << 4),
1233 /** Latched layout, i.e. will be unset after the next non-modifier
1235 XKB_STATE_LAYOUT_LATCHED = (1 << 5),
1236 /** Locked layout, i.e. will be unset after the key provoking the lock
1237 * has been pressed again. */
1238 XKB_STATE_LAYOUT_LOCKED = (1 << 6),
1239 /** Effective layout, i.e. currently active and affects key processing
1240 * (derived from the other state components).
1241 * Use this unless you explictly care how the state came about. */
1242 XKB_STATE_LAYOUT_EFFECTIVE = (1 << 7),
1243 /** LEDs (derived from the other state components). */
1244 XKB_STATE_LEDS = (1 << 8)
1248 * Update the keyboard state to reflect a given key being pressed or
1251 * This entry point is intended for programs which track the keyboard state
1252 * explictly (like an evdev client). If the state is serialized to you by
1253 * a master process (like a Wayland compositor) using functions like
1254 * xkb_state_serialize_mods(), you should use xkb_state_update_mask() instead.
1255 * The two functins should not generally be used together.
1257 * A series of calls to this function should be consistent; that is, a call
1258 * with XKB_KEY_DOWN for a key should be matched by an XKB_KEY_UP; if a key
1259 * is pressed twice, it should be released twice; etc. Otherwise (e.g. due
1260 * to missed input events), situations like "stuck modifiers" may occur.
1262 * This function is often used in conjunction with the function
1263 * xkb_state_key_get_syms() (or xkb_state_key_get_one_sym()), for example,
1264 * when handling a key event. In this case, you should prefer to get the
1265 * keysyms *before* updating the key, such that the keysyms reported for
1266 * the key event are not affected by the event itself. This is the
1267 * conventional behavior.
1269 * @returns A mask of state components that have changed as a result of
1270 * the update. If nothing in the state has changed, returns 0.
1272 * @memberof xkb_state
1274 * @sa xkb_state_update_mask()
1276 enum xkb_state_component
1277 xkb_state_update_key(struct xkb_state *state, xkb_keycode_t key,
1278 enum xkb_key_direction direction);
1281 * Update a keyboard state from a set of explicit masks.
1283 * This entry point is intended for window systems and the like, where a
1284 * master process holds an xkb_state, then serializes it over a wire
1285 * protocol, and clients then use the serialization to feed in to their own
1288 * All parameters must always be passed, or the resulting state may be
1291 * The serialization is lossy and will not survive round trips; it must only
1292 * be used to feed slave state objects, and must not be used to update the
1295 * If you do not fit the description above, you should use
1296 * xkb_state_update_key() instead. The two functions should not generally be
1299 * @returns A mask of state components that have changed as a result of
1300 * the update. If nothing in the state has changed, returns 0.
1302 * @memberof xkb_state
1304 * @sa xkb_state_component
1305 * @sa xkb_state_update_key
1307 enum xkb_state_component
1308 xkb_state_update_mask(struct xkb_state *state,
1309 xkb_mod_mask_t depressed_mods,
1310 xkb_mod_mask_t latched_mods,
1311 xkb_mod_mask_t locked_mods,
1312 xkb_layout_index_t depressed_layout,
1313 xkb_layout_index_t latched_layout,
1314 xkb_layout_index_t locked_layout);
1317 * Get the keysyms obtained from pressing a particular key in a given
1320 * Get the keysyms for a key according to the current active layout,
1321 * modifiers and shift level for the key, as determined by a keyboard
1324 * @param[in] state The keyboard state object.
1325 * @param[in] key The keycode of the key.
1326 * @param[out] syms_out An immutable array of keysyms corresponding the
1327 * key in the given keyboard state.
1329 * As an extension to XKB, this function can return more than one keysym.
1330 * If you do not want to handle this case, you can use
1331 * xkb_state_key_get_one_sym() for a simpler interface.
1333 * This function does not perform any @ref keysym-transformations.
1334 * (This might change).
1336 * @returns The number of keysyms in the syms_out array. If no keysyms
1337 * are produced by the key in the given keyboard state, returns 0 and sets
1340 * @memberof xkb_state
1343 xkb_state_key_get_syms(struct xkb_state *state, xkb_keycode_t key,
1344 const xkb_keysym_t **syms_out);
1347 * Get the Unicode/UTF-8 string obtained from pressing a particular key
1348 * in a given keyboard state.
1350 * @param[in] state The keyboard state object.
1351 * @param[in] key The keycode of the key.
1352 * @param[out] buffer A buffer to write the string into.
1353 * @param[in] size Size of the buffer.
1355 * @warning If the buffer passed is too small, the string is truncated
1356 * (though still NUL-terminated).
1358 * @returns The number of bytes required for the string, excluding the
1359 * NUL byte. If there is nothing to write, returns 0.
1361 * You may check if truncation has occurred by comparing the return value
1362 * with the size of @p buffer, similarly to the snprintf(3) function.
1363 * You may safely pass NULL and 0 to @p buffer and @p size to find the
1364 * required size (without the NUL-byte).
1366 * This function performs Capitalization and Control @ref
1367 * keysym-transformations.
1369 * @memberof xkb_state
1373 xkb_state_key_get_utf8(struct xkb_state *state, xkb_keycode_t key,
1374 char *buffer, size_t size);
1377 * Get the Unicode/UTF-32 codepoint obtained from pressing a particular
1378 * key in a a given keyboard state.
1380 * @returns The UTF-32 representation for the key, if it consists of only
1381 * a single codepoint. Otherwise, returns 0.
1383 * This function performs Capitalization and Control @ref
1384 * keysym-transformations.
1386 * @memberof xkb_state
1390 xkb_state_key_get_utf32(struct xkb_state *state, xkb_keycode_t key);
1393 * Get the single keysym obtained from pressing a particular key in a
1394 * given keyboard state.
1396 * This function is similar to xkb_state_key_get_syms(), but intended
1397 * for users which cannot or do not want to handle the case where
1398 * multiple keysyms are returned (in which case this function is
1401 * @returns The keysym. If the key does not have exactly one keysym,
1402 * returns XKB_KEY_NoSymbol
1404 * This function performs Capitalization @ref keysym-transformations.
1406 * @sa xkb_state_key_get_syms()
1407 * @memberof xkb_state
1410 xkb_state_key_get_one_sym(struct xkb_state *state, xkb_keycode_t key);
1413 * Get the effective layout index for a key in a given keyboard state.
1415 * @returns The layout index for the key in the given keyboard state. If
1416 * the given keycode is invalid, or if the key is not included in any
1417 * layout at all, returns XKB_LAYOUT_INVALID.
1419 * @invariant If the returned layout is valid, the following always holds:
1421 * xkb_state_key_get_layout(state, key) < xkb_keymap_num_layouts_for_key(keymap, key)
1424 * @memberof xkb_state
1427 xkb_state_key_get_layout(struct xkb_state *state, xkb_keycode_t key);
1430 * Get the effective shift level for a key in a given keyboard state and
1433 * @param state The keyboard state.
1434 * @param key The keycode of the key.
1435 * @param layout The layout for which to get the shift level. This must be
1437 * @code xkb_keymap_num_layouts_for_key(keymap, key) @endcode
1438 * usually it would be:
1439 * @code xkb_state_key_get_layout(state, key) @endcode
1441 * @return The shift level index. If the key or layout are invalid,
1442 * returns XKB_LEVEL_INVALID.
1444 * @invariant If the returned level is valid, the following always holds:
1446 * xkb_state_key_get_level(state, key, layout) < xkb_keymap_num_levels_for_key(keymap, key, layout)
1449 * @memberof xkb_state
1452 xkb_state_key_get_level(struct xkb_state *state, xkb_keycode_t key,
1453 xkb_layout_index_t layout);
1456 * Match flags for xkb_state_mod_indices_are_active() and
1457 * xkb_state_mod_names_are_active(), specifying the conditions for a
1458 * successful match. XKB_STATE_MATCH_NON_EXCLUSIVE is bitmaskable with
1461 enum xkb_state_match {
1462 /** Returns true if any of the modifiers are active. */
1463 XKB_STATE_MATCH_ANY = (1 << 0),
1464 /** Returns true if all of the modifiers are active. */
1465 XKB_STATE_MATCH_ALL = (1 << 1),
1466 /** Makes matching non-exclusive, i.e. will not return false if a
1467 * modifier not specified in the arguments is active. */
1468 XKB_STATE_MATCH_NON_EXCLUSIVE = (1 << 16)
1472 * The counterpart to xkb_state_update_mask for modifiers, to be used on
1473 * the server side of serialization.
1475 * @param state The keyboard state.
1476 * @param components A mask of the modifier state components to serialize.
1477 * State components other than XKB_STATE_MODS_* are ignored.
1478 * If XKB_STATE_MODS_EFFECTIVE is included, all other state components are
1481 * @returns A xkb_mod_mask_t representing the given components of the
1484 * This function should not be used in regular clients; please use the
1485 * xkb_state_mod_*_is_active API instead.
1487 * @memberof xkb_state
1490 xkb_state_serialize_mods(struct xkb_state *state,
1491 enum xkb_state_component components);
1494 * The counterpart to xkb_state_update_mask for layouts, to be used on
1495 * the server side of serialization.
1497 * @param state The keyboard state.
1498 * @param components A mask of the layout state components to serialize.
1499 * State components other than XKB_STATE_LAYOUT_* are ignored.
1500 * If XKB_STATE_LAYOUT_EFFECTIVE is included, all other state components are
1503 * @returns A layout index representing the given components of the
1506 * This function should not be used in regular clients; please use the
1507 * xkb_state_layout_*_is_active API instead.
1509 * @memberof xkb_state
1512 xkb_state_serialize_layout(struct xkb_state *state,
1513 enum xkb_state_component components);
1516 * Test whether a modifier is active in a given keyboard state by name.
1518 * @returns 1 if the modifier is active, 0 if it is not. If the modifier
1519 * name does not exist in the keymap, returns -1.
1521 * @memberof xkb_state
1524 xkb_state_mod_name_is_active(struct xkb_state *state, const char *name,
1525 enum xkb_state_component type);
1528 * Test whether a set of modifiers are active in a given keyboard state by
1531 * @param state The keyboard state.
1532 * @param type The component of the state against which to match the
1534 * @param match The manner by which to match the state against the
1536 * @param ... The set of of modifier names to test, terminated by a NULL
1537 * argument (sentinel).
1539 * @returns 1 if the modifiers are active, 0 if they are not. If any of
1540 * the modifier names do not exist in the keymap, returns -1.
1542 * @memberof xkb_state
1545 xkb_state_mod_names_are_active(struct xkb_state *state,
1546 enum xkb_state_component type,
1547 enum xkb_state_match match,
1551 * Test whether a modifier is active in a given keyboard state by index.
1553 * @returns 1 if the modifier is active, 0 if it is not. If the modifier
1554 * index is invalid in the keymap, returns -1.
1556 * @memberof xkb_state
1559 xkb_state_mod_index_is_active(struct xkb_state *state, xkb_mod_index_t idx,
1560 enum xkb_state_component type);
1563 * Test whether a set of modifiers are active in a given keyboard state by
1566 * @param state The keyboard state.
1567 * @param type The component of the state against which to match the
1569 * @param match The manner by which to match the state against the
1571 * @param ... The set of of modifier indices to test, terminated by a
1572 * XKB_MOD_INVALID argument (sentinel).
1574 * @returns 1 if the modifiers are active, 0 if they are not. If any of
1575 * the modifier indices are invalid in the keymap, returns -1.
1577 * @memberof xkb_state
1580 xkb_state_mod_indices_are_active(struct xkb_state *state,
1581 enum xkb_state_component type,
1582 enum xkb_state_match match,
1586 * @page consumed-modifiers Consumed Modifiers
1589 * Some functions, like xkb_state_key_get_syms(), look at the state of
1590 * the modifiers in the keymap and derive from it the correct shift level
1591 * to use for the key. For example, in a US layout, pressing the key
1592 * labeled \<A\> while the Shift modifier is active, generates the keysym
1593 * 'A'. In this case, the Shift modifier is said to be "consumed".
1594 * However, the Num Lock modifier does not affect this translation at all,
1595 * even if it is active, so it is not consumed by this translation.
1597 * It may be desirable for some application to not reuse consumed modifiers
1598 * for further processing, e.g. for hotkeys or keyboard shortcuts. To
1599 * understand why, consider some requirements from a standard shortcut
1600 * mechanism, and how they are implemented:
1602 * 1. The shortcut's modifiers must match exactly to the state. For
1603 * example, it is possible to bind separate actions to \<Alt\>\<Tab\>
1604 * and to \<Alt\>\<Shift\>\<Tab\>. Further, if only \<Alt\>\<Tab\> is
1605 * bound to an action, pressing \<Alt\>\<Shift\>\<Tab\> should not
1606 * trigger the shortcut.
1607 * Effectively, this means that the modifiers are compared using the
1608 * equality operator (==).
1610 * 2. Only relevant modifiers are considered for the matching. For example,
1611 * Caps Lock and Num Lock should not generally affect the matching, e.g.
1612 * when matching \<Alt\>\<Tab\> against the state, it does not matter
1613 * whether Num Lock is active or not. These relevant, or "significant",
1614 * modifiers usually include Alt, Control, Shift, Super and similar.
1615 * Effectively, this means that non-significant modifiers are masked out,
1616 * before doing the comparison as described above.
1618 * 3. The matching must be independent of the layout/keymap. For example,
1619 * the \<Plus\> (+) symbol is found on the first level on some layouts,
1620 * but requires holding Shift on others. If you simply bind the action
1621 * to the \<Plus\> keysym, it would work for the unshifted kind, but
1622 * not for the others, because the match against Shift would fail. If
1623 * you bind the action to \<Shift\>\<Plus\>, only the shifted kind would
1624 * work. So what is needed is to recognize that Shift is used up in the
1625 * translation of the keysym itself, and therefore should not be included
1627 * Effectively, this means that consumed modifiers (Shift in this example)
1628 * are masked out as well, before doing the comparison.
1630 * In summary, this is how the matching would be performed:
1632 * (keysym == shortcut_keysym) &&
1633 * ((state_mods & ~consumed_mods & significant_mods) == shortcut_mods)
1636 * @c state_mods are the modifiers reported by
1637 * xkb_state_mod_index_is_active() and similar functions.
1638 * @c consumed_mods are the modifiers reported by
1639 * xkb_state_mod_index_is_consumed() and similar functions.
1640 * @c significant_mods are decided upon by the application/toolkit/user;
1641 * it is up to them to decide whether these are configurable or hard-coded.
1647 * Test whether a modifier is consumed by keyboard state translation for
1650 * @returns 1 if the modifier is consumed, 0 if it is not. If the modifier
1651 * index is not valid in the keymap, returns -1.
1653 * @sa xkb_state_mod_mask_remove_consumed()
1654 * @sa xkb_state_key_get_consumed_mods()
1655 * @memberof xkb_state
1658 xkb_state_mod_index_is_consumed(struct xkb_state *state, xkb_keycode_t key,
1659 xkb_mod_index_t idx);
1662 * Remove consumed modifiers from a modifier mask for a key.
1664 * Takes the given modifier mask, and removes all modifiers which are
1665 * consumed for that particular key (as in xkb_state_mod_index_is_consumed()).
1667 * @sa xkb_state_mod_index_is_consumed()
1668 * @memberof xkb_state
1671 xkb_state_mod_mask_remove_consumed(struct xkb_state *state, xkb_keycode_t key,
1672 xkb_mod_mask_t mask);
1675 * Get the mask of modifiers consumed by translating a given key.
1677 * @returns a mask of the consumed modifiers.
1679 * @sa xkb_state_mod_index_is_consumed()
1680 * @memberof xkb_state
1684 xkb_state_key_get_consumed_mods(struct xkb_state *state, xkb_keycode_t key);
1687 * Test whether a layout is active in a given keyboard state by name.
1689 * @returns 1 if the layout is active, 0 if it is not. If no layout with
1690 * this name exists in the keymap, return -1.
1692 * If multiple layouts in the keymap have this name, the one with the lowest
1695 * @sa xkb_layout_index_t
1696 * @memberof xkb_state
1699 xkb_state_layout_name_is_active(struct xkb_state *state, const char *name,
1700 enum xkb_state_component type);
1703 * Test whether a layout is active in a given keyboard state by index.
1705 * @returns 1 if the layout is active, 0 if it is not. If the layout index
1706 * is not valid in the keymap, returns -1.
1708 * @sa xkb_layout_index_t
1709 * @memberof xkb_state
1712 xkb_state_layout_index_is_active(struct xkb_state *state,
1713 xkb_layout_index_t idx,
1714 enum xkb_state_component type);
1717 * Test whether a LED is active in a given keyboard state by name.
1719 * @returns 1 if the LED is active, 0 if it not. If no LED with this name
1720 * exists in the keymap, returns -1.
1722 * @sa xkb_led_index_t
1723 * @memberof xkb_state
1726 xkb_state_led_name_is_active(struct xkb_state *state, const char *name);
1729 * Test whether a LED is active in a given keyboard state by index.
1731 * @returns 1 if the LED is active, 0 if it not. If the LED index is not
1732 * valid in the keymap, returns -1.
1734 * @sa xkb_led_index_t
1735 * @memberof xkb_state
1738 xkb_state_led_index_is_active(struct xkb_state *state, xkb_led_index_t idx);
1742 /* Leave this include last, so it can pick up our types, etc. */
1743 #include <xkbcommon/xkbcommon-compat.h>
1749 #endif /* _XKBCOMMON_H_ */