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:
155 * The keymap defines a canonical name for each key, plus possible aliases.
156 * Historically, the XKB protocol restricts these names to at most 4 (ASCII)
157 * characters, but this library does not share this limit.
160 * xkb_keycode_t keycode_A = KEY_A + 8;
163 * @sa xkb_keycode_is_legal_ext() xkb_keycode_is_legal_x11()
165 typedef uint32_t xkb_keycode_t;
168 * A number used to represent the symbols generated from a key on a keyboard.
170 * A key, represented by a keycode, may generate different symbols according
171 * to keyboard state. For example, on a QWERTY keyboard, pressing the key
172 * labled \<A\> generates the symbol 'a'. If the Shift key is held, it
173 * generates the symbol 'A'. If a different layout is used, say Greek,
174 * it generates the symbol 'α'. And so on.
176 * Each such symbol is represented by a keysym. Note that keysyms are
177 * somewhat more general, in that they can also represent some "function",
178 * such as "Left" or "Right" for the arrow keys. For more information,
180 * http://www.x.org/releases/X11R7.7/doc/xproto/x11protocol.html#keysym_encoding
182 * Specifically named keysyms can be found in the
183 * xkbcommon/xkbcommon-keysyms.h header file. Their name does not include
184 * the XKB_KEY_ prefix.
186 * Besides those, any Unicode/ISO 10646 character in the range U0100 to
187 * U10FFFF can be represented by a keysym value in the range 0x01000100 to
188 * 0x0110FFFF. The name of Unicode keysyms is "U<codepoint>", e.g. "UA1B2".
190 * The name of other unnamed keysyms is the hexadecimal representation of
191 * their value, e.g. "0xabcd1234".
193 * Keysym names are case-sensitive.
195 typedef uint32_t xkb_keysym_t;
198 * Index of a keyboard layout.
200 * The layout index is a state component which detemines which <em>keyboard
201 * layout</em> is active. These may be different alphabets, different key
204 * Layout indices are consecutive. The first layout has index 0.
206 * Each layout is not required to have a name, and the names are not
207 * guaranteed to be unique (though they are usually provided and unique).
208 * Therefore, it is not safe to use the name as a unique identifier for a
209 * layout. Layout names are case-sensitive.
211 * Layouts are also called "groups" by XKB.
213 * @sa xkb_keymap_num_layouts() xkb_keymap_num_layouts_for_key()
215 typedef uint32_t xkb_layout_index_t;
216 /** A mask of layout indices. */
217 typedef uint32_t xkb_layout_mask_t;
220 * Index of a shift level.
222 * Any key, in any layout, can have several <em>shift levels</em>. Each
223 * shift level can assign different keysyms to the key. The shift level
224 * to use is chosen according to the current keyboard state; for example,
225 * if no keys are pressed, the first level may be used; if the Left Shift
226 * key is pressed, the second; if Num Lock is pressed, the third; and
227 * many such combinations are possible (see xkb_mod_index_t).
229 * Level indices are consecutive. The first level has index 0.
231 typedef uint32_t xkb_level_index_t;
234 * Index of a modifier.
236 * A @e modifier is a state component which changes the way keys are
237 * interpreted. A keymap defines a set of modifiers, such as Alt, Shift,
238 * Num Lock or Meta, and specifies which keys may @e activate which
239 * modifiers (in a many-to-many relationship, i.e. a key can activate
240 * several modifiers, and a modifier may be activated by several keys.
241 * Different keymaps do this differently).
243 * When retrieving the keysyms for a key, the active modifier set is
244 * consulted; this detemines the correct shift level to use within the
245 * currently active layout (see xkb_level_index_t).
247 * Modifier indices are consecutive. The first modifier has index 0.
249 * Each modifier must have a name, and the names are unique. Therefore, it
250 * is safe to use the name as a unique identifier for a modifier. The names
251 * of some common modifiers are provided in the xkbcommon/xkbcommon-names.h
252 * header file. Modifier names are case-sensitive.
254 * @sa xkb_keymap_num_mods()
256 typedef uint32_t xkb_mod_index_t;
257 /** A mask of modifier indices. */
258 typedef uint32_t xkb_mod_mask_t;
261 * Index of a keyboard LED.
263 * LEDs are logical objects which may be @e active or @e inactive. They
264 * typically correspond to the lights on the keyboard. Their state is
265 * determined by the current keyboard state.
267 * LED indices are non-consecutive. The first LED has index 0.
269 * Each LED must have a name, and the names are unique. Therefore,
270 * it is safe to use the name as a unique identifier for a LED. The names
271 * of some common LEDs are provided in the xkbcommon/xkbcommon-names.h
272 * header file. LED names are case-sensitive.
274 * @warning A given keymap may specify an exact index for a given LED.
275 * Therefore, LED indexing is not necessarily sequential, as opposed to
276 * modifiers and layouts. This means that when iterating over the LEDs
277 * in a keymap using e.g. xkb_keymap_num_leds(), some indices might be
278 * invalid. Given such an index, functions like xkb_keymap_led_get_name()
279 * will return NULL, and xkb_state_led_index_is_active() will return -1.
281 * LEDs are also called "indicators" by XKB.
283 * @sa xkb_keymap_num_leds()
285 typedef uint32_t xkb_led_index_t;
286 /** A mask of LED indices. */
287 typedef uint32_t xkb_led_mask_t;
289 #define XKB_KEYCODE_INVALID (0xffffffff)
290 #define XKB_LAYOUT_INVALID (0xffffffff)
291 #define XKB_LEVEL_INVALID (0xffffffff)
292 #define XKB_MOD_INVALID (0xffffffff)
293 #define XKB_LED_INVALID (0xffffffff)
295 #define XKB_KEYCODE_MAX (0xffffffff - 1)
298 * Test whether a value is a valid extended keycode.
301 #define xkb_keycode_is_legal_ext(key) (key <= XKB_KEYCODE_MAX)
304 * Test whether a value is a valid X11 keycode.
307 #define xkb_keycode_is_legal_x11(key) (key >= 8 && key <= 255)
310 * Names to compile a keymap with, also known as RMLVO.
312 * The names are the common configuration values by which a user picks
315 * If the entire struct is NULL, then each field is taken to be NULL.
316 * You should prefer passing NULL instead of choosing your own defaults.
318 struct xkb_rule_names {
320 * The rules file to use. The rules file describes how to interpret
321 * the values of the model, layout, variant and options fields.
323 * If NULL or the empty string "", a default value is used.
324 * If the XKB_DEFAULT_RULES environment variable is set, it is used
325 * as the default. Otherwise the system default is used.
329 * The keyboard model by which to interpret keycodes and LEDs.
331 * If NULL or the empty string "", a default value is used.
332 * If the XKB_DEFAULT_MODEL environment variable is set, it is used
333 * as the default. Otherwise the system default is used.
337 * A comma separated list of layouts (languages) to include in the
340 * If NULL or the empty string "", a default value is used.
341 * If the XKB_DEFAULT_LAYOUT environment variable is set, it is used
342 * as the default. Otherwise the system default is used.
346 * A comma separated list of variants, one per layout, which may
347 * modify or augment the respective layout in various ways.
349 * If NULL or the empty string "", and a default value is also used
350 * for the layout, a default value is used. Otherwise no variant is
352 * If the XKB_DEFAULT_VARIANT environment variable is set, it is used
353 * as the default. Otherwise the system default is used.
357 * A comma separated list of options, through which the user specifies
358 * non-layout related preferences, like which key combinations are used
359 * for switching layouts, or which key is the Compose key.
361 * If NULL, a default value is used. If the empty string "", no
363 * If the XKB_DEFAULT_OPTIONS environment variable is set, it is used
364 * as the default. Otherwise the system default is used.
370 * @defgroup keysyms Keysyms
371 * Utility functions related to keysyms.
377 * @page keysym-transformations Keysym Transformations
379 * Keysym translation is subject to several "keysym transformations",
380 * as described in the XKB specification. These are:
382 * - Capitalization transformation. If the Caps Lock modifier is
383 * active and was not consumed by the translation process, a single
384 * keysym is transformed to its upper-case form (if applicable).
385 * Similarly, the UTF-8/UTF-32 string produced is capitalized.
387 * This is described in:
388 * http://www.x.org/releases/current/doc/kbproto/xkbproto.html#Interpreting_the_Lock_Modifier
390 * - Control transformation. If the Control modifier is active and
391 * was not consumed by the translation process, the string produced
392 * is transformed to its matching ASCII control character (if
393 * applicable). Keysyms are not affected.
395 * This is described in:
396 * http://www.x.org/releases/current/doc/kbproto/xkbproto.html#Interpreting_the_Control_Modifier
398 * Each relevant function discusses which transformations it performs.
400 * These transformations are not applicable when a key produces multiple
406 * Get the name of a keysym.
408 * For a description of how keysyms are named, see @ref xkb_keysym_t.
410 * @param[in] keysym The keysym.
411 * @param[out] buffer A string buffer to write the name into.
412 * @param[in] size Size of the buffer.
414 * @warning If the buffer passed is too small, the string is truncated
415 * (though still NUL-terminated); a size of at least 64 bytes is recommended.
417 * @returns The number of bytes in the name, excluding the NUL byte. If
418 * the keysym is invalid, returns -1.
420 * You may check if truncation has occurred by comparing the return value
421 * with the length of buffer, similarly to the snprintf(3) function.
426 xkb_keysym_get_name(xkb_keysym_t keysym, char *buffer, size_t size);
428 /** Flags for xkb_keysym_from_name(). */
429 enum xkb_keysym_flags {
430 /** Do not apply any flags. */
431 XKB_KEYSYM_NO_FLAGS = 0,
432 /** Find keysym by case-insensitive search. */
433 XKB_KEYSYM_CASE_INSENSITIVE = (1 << 0)
437 * Get a keysym from its name.
439 * @param name The name of a keysym. See remarks in xkb_keysym_get_name();
440 * this function will accept any name returned by that function.
441 * @param flags A set of flags controlling how the search is done. If
442 * invalid flags are passed, this will fail with XKB_KEY_NoSymbol.
444 * If you use the XKB_KEYSYM_CASE_INSENSITIVE flag and two keysym names
445 * differ only by case, then the lower-case keysym is returned. For
446 * instance, for KEY_a and KEY_A, this function would return KEY_a for the
447 * case-insensitive search. If this functionality is needed, it is
448 * recommended to first call this function without this flag; and if that
449 * fails, only then to try with this flag, while possibly warning the user
450 * he had misspelled the name, and might get wrong results.
452 * Case folding is done according to the C locale; the current locale is not
455 * @returns The keysym. If the name is invalid, returns XKB_KEY_NoSymbol.
460 xkb_keysym_from_name(const char *name, enum xkb_keysym_flags flags);
463 * Get the Unicode/UTF-8 representation of a keysym.
465 * @param[in] keysym The keysym.
466 * @param[out] buffer A buffer to write the UTF-8 string into.
467 * @param[in] size The size of buffer. Must be at least 7.
469 * @returns The number of bytes written to the buffer (including the
470 * terminating byte). If the keysym does not have a Unicode
471 * representation, returns 0. If the buffer is too small, returns -1.
473 * This function does not perform any @ref keysym-transformations.
474 * Therefore, prefer to use xkb_state_key_get_utf8() if possible.
476 * @sa xkb_state_key_get_utf8()
479 xkb_keysym_to_utf8(xkb_keysym_t keysym, char *buffer, size_t size);
482 * Get the Unicode/UTF-32 representation of a keysym.
484 * @returns The Unicode/UTF-32 representation of keysym, which is also
485 * compatible with UCS-4. If the keysym does not have a Unicode
486 * representation, returns 0.
488 * This function does not perform any @ref keysym-transformations.
489 * Therefore, prefer to use xkb_state_key_get_utf32() if possible.
491 * @sa xkb_state_key_get_utf32()
494 xkb_keysym_to_utf32(xkb_keysym_t keysym);
497 * Convert a keysym to its uppercase form.
499 * If there is no such form, the keysym is returned unchanged.
501 * The conversion rules may be incomplete; prefer to work with the Unicode
502 * representation instead, when possible.
505 xkb_keysym_to_upper(xkb_keysym_t ks);
508 * Convert a keysym to its lowercase form.
510 * The conversion rules may be incomplete; prefer to work with the Unicode
511 * representation instead, when possible.
514 xkb_keysym_to_lower(xkb_keysym_t ks);
519 * @defgroup context Library Context
520 * Creating, destroying and using library contexts.
522 * Every keymap compilation request must have a context associated with
523 * it. The context keeps around state such as the include path.
529 * @page envvars Environment Variables
531 * The user may set some environment variables which affect the library:
533 * - `XKB_CONFIG_ROOT`, `HOME` - see @ref include-path.
534 * - `XKB_LOG_LEVEL` - see xkb_context_set_log_level().
535 * - `XKB_LOG_VERBOSITY` - see xkb_context_set_log_verbosity().
536 * - `XKB_DEFAULT_RULES`, `XKB_DEFAULT_MODEL`, `XKB_DEFAULT_LAYOUT`,
537 * `XKB_DEFAULT_VARIANT`, `XKB_DEFAULT_OPTIONS` - see xkb_rule_names.
540 /** Flags for context creation. */
541 enum xkb_context_flags {
542 /** Do not apply any context flags. */
543 XKB_CONTEXT_NO_FLAGS = 0,
544 /** Create this context with an empty include path. */
545 XKB_CONTEXT_NO_DEFAULT_INCLUDES = (1 << 0),
547 * Don't take RMLVO names from the environment.
550 XKB_CONTEXT_NO_ENVIRONMENT_NAMES = (1 << 1)
554 * Create a new context.
556 * @param flags Optional flags for the context, or 0.
558 * @returns A new context, or NULL on failure.
560 * @memberof xkb_context
563 xkb_context_new(enum xkb_context_flags flags);
566 * Take a new reference on a context.
568 * @returns The passed in context.
570 * @memberof xkb_context
573 xkb_context_ref(struct xkb_context *context);
576 * Release a reference on a context, and possibly free it.
578 * @param context The context. If it is NULL, this function does nothing.
580 * @memberof xkb_context
583 xkb_context_unref(struct xkb_context *context);
586 * Store custom user data in the context.
588 * This may be useful in conjunction with xkb_context_set_log_fn() or other
591 * @memberof xkb_context
594 xkb_context_set_user_data(struct xkb_context *context, void *user_data);
597 * Retrieves stored user data from the context.
599 * @returns The stored user data. If the user data wasn't set, or the
600 * passed in context is NULL, returns NULL.
602 * This may be useful to access private user data from callbacks like a
603 * custom logging function.
605 * @memberof xkb_context
608 xkb_context_get_user_data(struct xkb_context *context);
613 * @defgroup include-path Include Paths
614 * Manipulating the include paths in a context.
616 * The include paths are the file-system paths that are searched when an
617 * include statement is encountered during keymap compilation.
619 * The default include paths are:
620 * - The system XKB root, defined at library configuration time.
621 * If * the `XKB_CONFIG_ROOT` environment is defined, it is used instead.
622 * - The path `$HOME/.xkb`, where $HOME is the value of the environment
629 * Append a new entry to the context's include path.
631 * @returns 1 on success, or 0 if the include path could not be added or is
634 * @memberof xkb_context
637 xkb_context_include_path_append(struct xkb_context *context, const char *path);
640 * Append the default include paths to the context's include path.
642 * @returns 1 on success, or 0 if the primary include path could not be added.
644 * @memberof xkb_context
647 xkb_context_include_path_append_default(struct xkb_context *context);
650 * Reset the context's include path to the default.
652 * Removes all entries from the context's include path, and inserts the
655 * @returns 1 on success, or 0 if the primary include path could not be added.
657 * @memberof xkb_context
660 xkb_context_include_path_reset_defaults(struct xkb_context *context);
663 * Remove all entries from the context's include path.
665 * @memberof xkb_context
668 xkb_context_include_path_clear(struct xkb_context *context);
671 * Get the number of paths in the context's include path.
673 * @memberof xkb_context
676 xkb_context_num_include_paths(struct xkb_context *context);
679 * Get a specific include path from the context's include path.
681 * @returns The include path at the specified index. If the index is
682 * invalid, returns NULL.
684 * @memberof xkb_context
687 xkb_context_include_path_get(struct xkb_context *context, unsigned int index);
692 * @defgroup logging Logging Handling
693 * Manipulating how logging from this library is handled.
698 /** Specifies a logging level. */
700 XKB_LOG_LEVEL_CRITICAL = 10, /**< Log critical internal errors only. */
701 XKB_LOG_LEVEL_ERROR = 20, /**< Log all errors. */
702 XKB_LOG_LEVEL_WARNING = 30, /**< Log warnings and errors. */
703 XKB_LOG_LEVEL_INFO = 40, /**< Log information, warnings, and errors. */
704 XKB_LOG_LEVEL_DEBUG = 50 /**< Log everything. */
708 * Set the current logging level.
710 * @param context The context in which to set the logging level.
711 * @param level The logging level to use. Only messages from this level
712 * and below will be logged.
714 * The default level is XKB_LOG_LEVEL_ERROR. The environment variable
715 * XKB_LOG_LEVEL, if set in the time the context was created, overrides the
716 * default value. It may be specified as a level number or name.
718 * @memberof xkb_context
721 xkb_context_set_log_level(struct xkb_context *context,
722 enum xkb_log_level level);
725 * Get the current logging level.
727 * @memberof xkb_context
730 xkb_context_get_log_level(struct xkb_context *context);
733 * Sets the current logging verbosity.
735 * The library can generate a number of warnings which are not helpful to
736 * ordinary users of the library. The verbosity may be increased if more
737 * information is desired (e.g. when developing a new keymap).
739 * The default verbosity is 0. The environment variable XKB_LOG_VERBOSITY,
740 * if set in the time the context was created, overrides the default value.
742 * @param context The context in which to use the set verbosity.
743 * @param verbosity The verbosity to use. Currently used values are
744 * 1 to 10, higher values being more verbose. 0 would result in no verbose
745 * messages being logged.
747 * Most verbose messages are of level XKB_LOG_LEVEL_WARNING or lower.
749 * @memberof xkb_context
752 xkb_context_set_log_verbosity(struct xkb_context *context, int verbosity);
755 * Get the current logging verbosity of the context.
757 * @memberof xkb_context
760 xkb_context_get_log_verbosity(struct xkb_context *context);
763 * Set a custom function to handle logging messages.
765 * @param context The context in which to use the set logging function.
766 * @param log_fn The function that will be called for logging messages.
767 * Passing NULL restores the default function, which logs to stderr.
769 * By default, log messages from this library are printed to stderr. This
770 * function allows you to replace the default behavior with a custom
771 * handler. The handler is only called with messages which match the
772 * current logging level and verbosity settings for the context.
773 * level is the logging level of the message. @a format and @a args are
774 * the same as in the vprintf(3) function.
776 * You may use xkb_context_set_user_data() on the context, and then call
777 * xkb_context_get_user_data() from within the logging function to provide
778 * it with additional private context.
780 * @memberof xkb_context
783 xkb_context_set_log_fn(struct xkb_context *context,
784 void (*log_fn)(struct xkb_context *context,
785 enum xkb_log_level level,
786 const char *format, va_list args));
791 * @defgroup keymap Keymap Creation
792 * Creating and destroying keymaps.
797 /** Flags for keymap compilation. */
798 enum xkb_keymap_compile_flags {
799 /** Do not apply any flags. */
800 XKB_KEYMAP_COMPILE_NO_FLAGS = 0
804 * Create a keymap from RMLVO names.
806 * The primary keymap entry point: creates a new XKB keymap from a set of
807 * RMLVO (Rules + Model + Layouts + Variants + Options) names.
809 * @param context The context in which to create the keymap.
810 * @param names The RMLVO names to use. See xkb_rule_names.
811 * @param flags Optional flags for the keymap, or 0.
813 * @returns A keymap compiled according to the RMLVO names, or NULL if
814 * the compilation failed.
817 * @memberof xkb_keymap
820 xkb_keymap_new_from_names(struct xkb_context *context,
821 const struct xkb_rule_names *names,
822 enum xkb_keymap_compile_flags flags);
824 /** The possible keymap formats. */
825 enum xkb_keymap_format {
826 /** The current/classic XKB text format, as generated by xkbcomp -xkb. */
827 XKB_KEYMAP_FORMAT_TEXT_V1 = 1
831 * Create a keymap from a keymap file.
833 * @param context The context in which to create the keymap.
834 * @param file The keymap file to compile.
835 * @param format The text format of the keymap file to compile.
836 * @param flags Optional flags for the keymap, or 0.
838 * @returns A keymap compiled from the given XKB keymap file, or NULL if
839 * the compilation failed.
841 * The file must contain a complete keymap. For example, in the
842 * XKB_KEYMAP_FORMAT_TEXT_V1 format, this means the file must contain one
843 * top level '%xkb_keymap' section, which in turn contains other required
846 * @memberof xkb_keymap
849 xkb_keymap_new_from_file(struct xkb_context *context, FILE *file,
850 enum xkb_keymap_format format,
851 enum xkb_keymap_compile_flags flags);
854 * Create a keymap from a keymap string.
856 * This is just like xkb_keymap_new_from_file(), but instead of a file, gets
857 * the keymap as one enormous string.
859 * @see xkb_keymap_new_from_file()
860 * @memberof xkb_keymap
863 xkb_keymap_new_from_string(struct xkb_context *context, const char *string,
864 enum xkb_keymap_format format,
865 enum xkb_keymap_compile_flags flags);
868 * Create a keymap from a memory buffer.
870 * This is just like xkb_keymap_new_from_string(), but takes a length argument
871 * so the input string does not have to be zero-terminated.
873 * @see xkb_keymap_new_from_string()
874 * @memberof xkb_keymap
878 xkb_keymap_new_from_buffer(struct xkb_context *context, const char *buffer,
879 size_t length, enum xkb_keymap_format format,
880 enum xkb_keymap_compile_flags flags);
883 * Take a new reference on a keymap.
885 * @returns The passed in keymap.
887 * @memberof xkb_keymap
890 xkb_keymap_ref(struct xkb_keymap *keymap);
893 * Release a reference on a keymap, and possibly free it.
895 * @param keymap The keymap. If it is NULL, this function does nothing.
897 * @memberof xkb_keymap
900 xkb_keymap_unref(struct xkb_keymap *keymap);
903 * Get the keymap as a string in the format from which it was created.
904 * @sa xkb_keymap_get_as_string()
906 #define XKB_KEYMAP_USE_ORIGINAL_FORMAT ((enum xkb_keymap_format) -1)
909 * Get the compiled keymap as a string.
911 * @param keymap The keymap to get as a string.
912 * @param format The keymap format to use for the string. You can pass
913 * in the special value XKB_KEYMAP_USE_ORIGINAL_FORMAT to use the format
914 * from which the keymap was originally created.
916 * @returns The keymap as a NUL-terminated string, or NULL if unsuccessful.
918 * The returned string may be fed back into xkb_keymap_new_from_string() to get
919 * the exact same keymap (possibly in another process, etc.).
921 * The returned string is dynamically allocated and should be freed by the
924 * @memberof xkb_keymap
927 xkb_keymap_get_as_string(struct xkb_keymap *keymap,
928 enum xkb_keymap_format format);
933 * @defgroup components Keymap Components
934 * Enumeration of state components in a keymap.
940 * Get the minimum keycode in the keymap.
943 * @memberof xkb_keymap
947 xkb_keymap_min_keycode(struct xkb_keymap *keymap);
950 * Get the maximum keycode in the keymap.
953 * @memberof xkb_keymap
957 xkb_keymap_max_keycode(struct xkb_keymap *keymap);
960 * The iterator used by xkb_keymap_key_for_each().
962 * @sa xkb_keymap_key_for_each
963 * @memberof xkb_keymap
967 (*xkb_keymap_key_iter_t)(struct xkb_keymap *keymap, xkb_keycode_t key,
971 * Run a specified function for every valid keycode in the keymap. If a
972 * keymap is sparse, this function may be called fewer than
973 * (max_keycode - min_keycode + 1) times.
975 * @sa xkb_keymap_min_keycode() xkb_keymap_max_keycode() xkb_keycode_t
976 * @memberof xkb_keymap
980 xkb_keymap_key_for_each(struct xkb_keymap *keymap, xkb_keymap_key_iter_t iter,
984 * Find the name of the key with the given keycode.
986 * This function always returns the canonical name of the key (see
987 * description in xkb_keycode_t).
989 * @returns The key name. If no key with this keycode exists,
993 * @memberof xkb_keymap
997 xkb_keymap_key_get_name(struct xkb_keymap *keymap, xkb_keycode_t key);
1000 * Find the keycode of the key with the given name.
1002 * The name can be either a canonical name or an alias.
1004 * @returns The keycode. If no key with this name exists,
1005 * returns XKB_KEYCODE_INVALID.
1008 * @memberof xkb_keymap
1012 xkb_keymap_key_by_name(struct xkb_keymap *keymap, const char *name);
1015 * Get the number of modifiers in the keymap.
1017 * @sa xkb_mod_index_t
1018 * @memberof xkb_keymap
1021 xkb_keymap_num_mods(struct xkb_keymap *keymap);
1024 * Get the name of a modifier by index.
1026 * @returns The name. If the index is invalid, returns NULL.
1028 * @sa xkb_mod_index_t
1029 * @memberof xkb_keymap
1032 xkb_keymap_mod_get_name(struct xkb_keymap *keymap, xkb_mod_index_t idx);
1035 * Get the index of a modifier by name.
1037 * @returns The index. If no modifier with this name exists, returns
1040 * @sa xkb_mod_index_t
1041 * @memberof xkb_keymap
1044 xkb_keymap_mod_get_index(struct xkb_keymap *keymap, const char *name);
1047 * Get the number of layouts in the keymap.
1049 * @sa xkb_layout_index_t xkb_rule_names xkb_keymap_num_layouts_for_key()
1050 * @memberof xkb_keymap
1053 xkb_keymap_num_layouts(struct xkb_keymap *keymap);
1056 * Get the name of a layout by index.
1058 * @returns The name. If the index is invalid, or the layout does not have
1059 * a name, returns NULL.
1061 * @sa xkb_layout_index_t
1062 * @memberof xkb_keymap
1065 xkb_keymap_layout_get_name(struct xkb_keymap *keymap, xkb_layout_index_t idx);
1068 * Get the index of a layout by name.
1070 * @returns The index. If no layout exists with this name, returns
1071 * XKB_LAYOUT_INVALID. If more than one layout in the keymap has this name,
1072 * returns the lowest index among them.
1074 * @memberof xkb_keymap
1077 xkb_keymap_layout_get_index(struct xkb_keymap *keymap, const char *name);
1080 * Get the number of LEDs in the keymap.
1082 * @warning The range [ 0...xkb_keymap_num_leds() ) includes all of the LEDs
1083 * in the keymap, but may also contain inactive LEDs. When iterating over
1084 * this range, you need the handle this case when calling functions such as
1085 * xkb_keymap_led_get_name() or xkb_state_led_index_is_active().
1087 * @sa xkb_led_index_t
1088 * @memberof xkb_keymap
1091 xkb_keymap_num_leds(struct xkb_keymap *keymap);
1094 * Get the name of a LED by index.
1096 * @returns The name. If the index is invalid, returns NULL.
1098 * @memberof xkb_keymap
1101 xkb_keymap_led_get_name(struct xkb_keymap *keymap, xkb_led_index_t idx);
1104 * Get the index of a LED by name.
1106 * @returns The index. If no LED with this name exists, returns
1109 * @memberof xkb_keymap
1112 xkb_keymap_led_get_index(struct xkb_keymap *keymap, const char *name);
1115 * Get the number of layouts for a specific key.
1117 * This number can be different from xkb_keymap_num_layouts(), but is always
1118 * smaller. It is the appropriate value to use when iterating over the
1121 * @sa xkb_layout_index_t
1122 * @memberof xkb_keymap
1125 xkb_keymap_num_layouts_for_key(struct xkb_keymap *keymap, xkb_keycode_t key);
1128 * Get the number of shift levels for a specific key and layout.
1130 * If @c layout is out of range for this key (that is, larger or equal to
1131 * the value returned by xkb_keymap_num_layouts_for_key()), it is brought
1132 * back into range in a manner consistent with xkb_state_key_get_layout().
1134 * @sa xkb_level_index_t
1135 * @memberof xkb_keymap
1138 xkb_keymap_num_levels_for_key(struct xkb_keymap *keymap, xkb_keycode_t key,
1139 xkb_layout_index_t layout);
1142 * Get the keysyms obtained from pressing a key in a given layout and
1145 * This function is like xkb_state_key_get_syms(), only the layout and
1146 * shift level are not derived from the keyboard state but are instead
1147 * specified explicitly.
1149 * @param[in] keymap The keymap.
1150 * @param[in] key The keycode of the key.
1151 * @param[in] layout The layout for which to get the keysyms.
1152 * @param[in] level The shift level in the layout for which to get the
1153 * keysyms. This must be smaller than:
1154 * @code xkb_keymap_num_levels_for_key(keymap, key) @endcode
1155 * @param[out] syms_out An immutable array of keysyms corresponding to the
1156 * key in the given layout and shift level.
1158 * If @c layout is out of range for this key (that is, larger or equal to
1159 * the value returned by xkb_keymap_num_layouts_for_key()), it is brought
1160 * back into range in a manner consistent with xkb_state_key_get_layout().
1162 * @returns The number of keysyms in the syms_out array. If no keysyms
1163 * are produced by the key in the given layout and shift level, returns 0
1164 * and sets syms_out to NULL.
1166 * @sa xkb_state_key_get_syms()
1167 * @memberof xkb_keymap
1170 xkb_keymap_key_get_syms_by_level(struct xkb_keymap *keymap,
1172 xkb_layout_index_t layout,
1173 xkb_level_index_t level,
1174 const xkb_keysym_t **syms_out);
1177 * Determine whether a key should repeat or not.
1179 * A keymap may specify different repeat behaviors for different keys.
1180 * Most keys should generally exhibit repeat behavior; for example, holding
1181 * the 'a' key down in a text editor should normally insert a single 'a'
1182 * character every few milliseconds, until the key is released. However,
1183 * there are keys which should not or do not need to be repeated. For
1184 * example, repeating modifier keys such as Left/Right Shift or Caps Lock
1185 * is not generally useful or desired.
1187 * @returns 1 if the key should repeat, 0 otherwise.
1189 * @memberof xkb_keymap
1192 xkb_keymap_key_repeats(struct xkb_keymap *keymap, xkb_keycode_t key);
1197 * @defgroup state Keyboard State
1198 * Creating, destroying and manipulating keyboard state objects.
1204 * Create a new keyboard state object.
1206 * @param keymap The keymap which the state will use.
1208 * @returns A new keyboard state object, or NULL on failure.
1210 * @memberof xkb_state
1213 xkb_state_new(struct xkb_keymap *keymap);
1216 * Take a new reference on a keyboard state object.
1218 * @returns The passed in object.
1220 * @memberof xkb_state
1223 xkb_state_ref(struct xkb_state *state);
1226 * Release a reference on a keybaord state object, and possibly free it.
1228 * @param state The state. If it is NULL, this function does nothing.
1230 * @memberof xkb_state
1233 xkb_state_unref(struct xkb_state *state);
1236 * Get the keymap which a keyboard state object is using.
1238 * @returns The keymap which was passed to xkb_state_new() when creating
1239 * this state object.
1241 * This function does not take a new reference on the keymap; you must
1242 * explicitly reference it yourself if you plan to use it beyond the
1243 * lifetime of the state.
1245 * @memberof xkb_state
1248 xkb_state_get_keymap(struct xkb_state *state);
1250 /** Specifies the direction of the key (press / release). */
1251 enum xkb_key_direction {
1252 XKB_KEY_UP, /**< The key was released. */
1253 XKB_KEY_DOWN /**< The key was pressed. */
1257 * Modifier and layout types for state objects. This enum is bitmaskable,
1258 * e.g. (XKB_STATE_MODS_DEPRESSED | XKB_STATE_MODS_LATCHED) is valid to
1259 * exclude locked modifiers.
1261 * In XKB, the DEPRESSED components are also known as 'base'.
1263 enum xkb_state_component {
1264 /** Depressed modifiers, i.e. a key is physically holding them. */
1265 XKB_STATE_MODS_DEPRESSED = (1 << 0),
1266 /** Latched modifiers, i.e. will be unset after the next non-modifier
1268 XKB_STATE_MODS_LATCHED = (1 << 1),
1269 /** Locked modifiers, i.e. will be unset after the key provoking the
1270 * lock has been pressed again. */
1271 XKB_STATE_MODS_LOCKED = (1 << 2),
1272 /** Effective modifiers, i.e. currently active and affect key
1273 * processing (derived from the other state components).
1274 * Use this unless you explictly care how the state came about. */
1275 XKB_STATE_MODS_EFFECTIVE = (1 << 3),
1276 /** Depressed layout, i.e. a key is physically holding it. */
1277 XKB_STATE_LAYOUT_DEPRESSED = (1 << 4),
1278 /** Latched layout, i.e. will be unset after the next non-modifier
1280 XKB_STATE_LAYOUT_LATCHED = (1 << 5),
1281 /** Locked layout, i.e. will be unset after the key provoking the lock
1282 * has been pressed again. */
1283 XKB_STATE_LAYOUT_LOCKED = (1 << 6),
1284 /** Effective layout, i.e. currently active and affects key processing
1285 * (derived from the other state components).
1286 * Use this unless you explictly care how the state came about. */
1287 XKB_STATE_LAYOUT_EFFECTIVE = (1 << 7),
1288 /** LEDs (derived from the other state components). */
1289 XKB_STATE_LEDS = (1 << 8)
1293 * Update the keyboard state to reflect a given key being pressed or
1296 * This entry point is intended for programs which track the keyboard state
1297 * explictly (like an evdev client). If the state is serialized to you by
1298 * a master process (like a Wayland compositor) using functions like
1299 * xkb_state_serialize_mods(), you should use xkb_state_update_mask() instead.
1300 * The two functins should not generally be used together.
1302 * A series of calls to this function should be consistent; that is, a call
1303 * with XKB_KEY_DOWN for a key should be matched by an XKB_KEY_UP; if a key
1304 * is pressed twice, it should be released twice; etc. Otherwise (e.g. due
1305 * to missed input events), situations like "stuck modifiers" may occur.
1307 * This function is often used in conjunction with the function
1308 * xkb_state_key_get_syms() (or xkb_state_key_get_one_sym()), for example,
1309 * when handling a key event. In this case, you should prefer to get the
1310 * keysyms *before* updating the key, such that the keysyms reported for
1311 * the key event are not affected by the event itself. This is the
1312 * conventional behavior.
1314 * @returns A mask of state components that have changed as a result of
1315 * the update. If nothing in the state has changed, returns 0.
1317 * @memberof xkb_state
1319 * @sa xkb_state_update_mask()
1321 enum xkb_state_component
1322 xkb_state_update_key(struct xkb_state *state, xkb_keycode_t key,
1323 enum xkb_key_direction direction);
1326 * Update a keyboard state from a set of explicit masks.
1328 * This entry point is intended for window systems and the like, where a
1329 * master process holds an xkb_state, then serializes it over a wire
1330 * protocol, and clients then use the serialization to feed in to their own
1333 * All parameters must always be passed, or the resulting state may be
1336 * The serialization is lossy and will not survive round trips; it must only
1337 * be used to feed slave state objects, and must not be used to update the
1340 * If you do not fit the description above, you should use
1341 * xkb_state_update_key() instead. The two functions should not generally be
1344 * @returns A mask of state components that have changed as a result of
1345 * the update. If nothing in the state has changed, returns 0.
1347 * @memberof xkb_state
1349 * @sa xkb_state_component
1350 * @sa xkb_state_update_key
1352 enum xkb_state_component
1353 xkb_state_update_mask(struct xkb_state *state,
1354 xkb_mod_mask_t depressed_mods,
1355 xkb_mod_mask_t latched_mods,
1356 xkb_mod_mask_t locked_mods,
1357 xkb_layout_index_t depressed_layout,
1358 xkb_layout_index_t latched_layout,
1359 xkb_layout_index_t locked_layout);
1362 * Get the keysyms obtained from pressing a particular key in a given
1365 * Get the keysyms for a key according to the current active layout,
1366 * modifiers and shift level for the key, as determined by a keyboard
1369 * @param[in] state The keyboard state object.
1370 * @param[in] key The keycode of the key.
1371 * @param[out] syms_out An immutable array of keysyms corresponding the
1372 * key in the given keyboard state.
1374 * As an extension to XKB, this function can return more than one keysym.
1375 * If you do not want to handle this case, you can use
1376 * xkb_state_key_get_one_sym() for a simpler interface.
1378 * This function does not perform any @ref keysym-transformations.
1379 * (This might change).
1381 * @returns The number of keysyms in the syms_out array. If no keysyms
1382 * are produced by the key in the given keyboard state, returns 0 and sets
1385 * @memberof xkb_state
1388 xkb_state_key_get_syms(struct xkb_state *state, xkb_keycode_t key,
1389 const xkb_keysym_t **syms_out);
1392 * Get the Unicode/UTF-8 string obtained from pressing a particular key
1393 * in a given keyboard state.
1395 * @param[in] state The keyboard state object.
1396 * @param[in] key The keycode of the key.
1397 * @param[out] buffer A buffer to write the string into.
1398 * @param[in] size Size of the buffer.
1400 * @warning If the buffer passed is too small, the string is truncated
1401 * (though still NUL-terminated).
1403 * @returns The number of bytes required for the string, excluding the
1404 * NUL byte. If there is nothing to write, returns 0.
1406 * You may check if truncation has occurred by comparing the return value
1407 * with the size of @p buffer, similarly to the snprintf(3) function.
1408 * You may safely pass NULL and 0 to @p buffer and @p size to find the
1409 * required size (without the NUL-byte).
1411 * This function performs Capitalization and Control @ref
1412 * keysym-transformations.
1414 * @memberof xkb_state
1418 xkb_state_key_get_utf8(struct xkb_state *state, xkb_keycode_t key,
1419 char *buffer, size_t size);
1422 * Get the Unicode/UTF-32 codepoint obtained from pressing a particular
1423 * key in a a given keyboard state.
1425 * @returns The UTF-32 representation for the key, if it consists of only
1426 * a single codepoint. Otherwise, returns 0.
1428 * This function performs Capitalization and Control @ref
1429 * keysym-transformations.
1431 * @memberof xkb_state
1435 xkb_state_key_get_utf32(struct xkb_state *state, xkb_keycode_t key);
1438 * Get the single keysym obtained from pressing a particular key in a
1439 * given keyboard state.
1441 * This function is similar to xkb_state_key_get_syms(), but intended
1442 * for users which cannot or do not want to handle the case where
1443 * multiple keysyms are returned (in which case this function is
1446 * @returns The keysym. If the key does not have exactly one keysym,
1447 * returns XKB_KEY_NoSymbol
1449 * This function performs Capitalization @ref keysym-transformations.
1451 * @sa xkb_state_key_get_syms()
1452 * @memberof xkb_state
1455 xkb_state_key_get_one_sym(struct xkb_state *state, xkb_keycode_t key);
1458 * Get the effective layout index for a key in a given keyboard state.
1460 * @returns The layout index for the key in the given keyboard state. If
1461 * the given keycode is invalid, or if the key is not included in any
1462 * layout at all, returns XKB_LAYOUT_INVALID.
1464 * @invariant If the returned layout is valid, the following always holds:
1466 * xkb_state_key_get_layout(state, key) < xkb_keymap_num_layouts_for_key(keymap, key)
1469 * @memberof xkb_state
1472 xkb_state_key_get_layout(struct xkb_state *state, xkb_keycode_t key);
1475 * Get the effective shift level for a key in a given keyboard state and
1478 * @param state The keyboard state.
1479 * @param key The keycode of the key.
1480 * @param layout The layout for which to get the shift level. This must be
1482 * @code xkb_keymap_num_layouts_for_key(keymap, key) @endcode
1483 * usually it would be:
1484 * @code xkb_state_key_get_layout(state, key) @endcode
1486 * @return The shift level index. If the key or layout are invalid,
1487 * returns XKB_LEVEL_INVALID.
1489 * @invariant If the returned level is valid, the following always holds:
1491 * xkb_state_key_get_level(state, key, layout) < xkb_keymap_num_levels_for_key(keymap, key, layout)
1494 * @memberof xkb_state
1497 xkb_state_key_get_level(struct xkb_state *state, xkb_keycode_t key,
1498 xkb_layout_index_t layout);
1501 * Match flags for xkb_state_mod_indices_are_active() and
1502 * xkb_state_mod_names_are_active(), specifying the conditions for a
1503 * successful match. XKB_STATE_MATCH_NON_EXCLUSIVE is bitmaskable with
1506 enum xkb_state_match {
1507 /** Returns true if any of the modifiers are active. */
1508 XKB_STATE_MATCH_ANY = (1 << 0),
1509 /** Returns true if all of the modifiers are active. */
1510 XKB_STATE_MATCH_ALL = (1 << 1),
1511 /** Makes matching non-exclusive, i.e. will not return false if a
1512 * modifier not specified in the arguments is active. */
1513 XKB_STATE_MATCH_NON_EXCLUSIVE = (1 << 16)
1517 * The counterpart to xkb_state_update_mask for modifiers, to be used on
1518 * the server side of serialization.
1520 * @param state The keyboard state.
1521 * @param components A mask of the modifier state components to serialize.
1522 * State components other than XKB_STATE_MODS_* are ignored.
1523 * If XKB_STATE_MODS_EFFECTIVE is included, all other state components are
1526 * @returns A xkb_mod_mask_t representing the given components of the
1529 * This function should not be used in regular clients; please use the
1530 * xkb_state_mod_*_is_active API instead.
1532 * @memberof xkb_state
1535 xkb_state_serialize_mods(struct xkb_state *state,
1536 enum xkb_state_component components);
1539 * The counterpart to xkb_state_update_mask for layouts, to be used on
1540 * the server side of serialization.
1542 * @param state The keyboard state.
1543 * @param components A mask of the layout state components to serialize.
1544 * State components other than XKB_STATE_LAYOUT_* are ignored.
1545 * If XKB_STATE_LAYOUT_EFFECTIVE is included, all other state components are
1548 * @returns A layout index representing the given components of the
1551 * This function should not be used in regular clients; please use the
1552 * xkb_state_layout_*_is_active API instead.
1554 * @memberof xkb_state
1557 xkb_state_serialize_layout(struct xkb_state *state,
1558 enum xkb_state_component components);
1561 * Test whether a modifier is active in a given keyboard state by name.
1563 * @returns 1 if the modifier is active, 0 if it is not. If the modifier
1564 * name does not exist in the keymap, returns -1.
1566 * @memberof xkb_state
1569 xkb_state_mod_name_is_active(struct xkb_state *state, const char *name,
1570 enum xkb_state_component type);
1573 * Test whether a set of modifiers are active in a given keyboard state by
1576 * @param state The keyboard state.
1577 * @param type The component of the state against which to match the
1579 * @param match The manner by which to match the state against the
1581 * @param ... The set of of modifier names to test, terminated by a NULL
1582 * argument (sentinel).
1584 * @returns 1 if the modifiers are active, 0 if they are not. If any of
1585 * the modifier names do not exist in the keymap, returns -1.
1587 * @memberof xkb_state
1590 xkb_state_mod_names_are_active(struct xkb_state *state,
1591 enum xkb_state_component type,
1592 enum xkb_state_match match,
1596 * Test whether a modifier is active in a given keyboard state by index.
1598 * @returns 1 if the modifier is active, 0 if it is not. If the modifier
1599 * index is invalid in the keymap, returns -1.
1601 * @memberof xkb_state
1604 xkb_state_mod_index_is_active(struct xkb_state *state, xkb_mod_index_t idx,
1605 enum xkb_state_component type);
1608 * Test whether a set of modifiers are active in a given keyboard state by
1611 * @param state The keyboard state.
1612 * @param type The component of the state against which to match the
1614 * @param match The manner by which to match the state against the
1616 * @param ... The set of of modifier indices to test, terminated by a
1617 * XKB_MOD_INVALID argument (sentinel).
1619 * @returns 1 if the modifiers are active, 0 if they are not. If any of
1620 * the modifier indices are invalid in the keymap, returns -1.
1622 * @memberof xkb_state
1625 xkb_state_mod_indices_are_active(struct xkb_state *state,
1626 enum xkb_state_component type,
1627 enum xkb_state_match match,
1631 * @page consumed-modifiers Consumed Modifiers
1634 * Some functions, like xkb_state_key_get_syms(), look at the state of
1635 * the modifiers in the keymap and derive from it the correct shift level
1636 * to use for the key. For example, in a US layout, pressing the key
1637 * labeled \<A\> while the Shift modifier is active, generates the keysym
1638 * 'A'. In this case, the Shift modifier is said to be "consumed".
1639 * However, the Num Lock modifier does not affect this translation at all,
1640 * even if it is active, so it is not consumed by this translation.
1642 * It may be desirable for some application to not reuse consumed modifiers
1643 * for further processing, e.g. for hotkeys or keyboard shortcuts. To
1644 * understand why, consider some requirements from a standard shortcut
1645 * mechanism, and how they are implemented:
1647 * 1. The shortcut's modifiers must match exactly to the state. For
1648 * example, it is possible to bind separate actions to \<Alt\>\<Tab\>
1649 * and to \<Alt\>\<Shift\>\<Tab\>. Further, if only \<Alt\>\<Tab\> is
1650 * bound to an action, pressing \<Alt\>\<Shift\>\<Tab\> should not
1651 * trigger the shortcut.
1652 * Effectively, this means that the modifiers are compared using the
1653 * equality operator (==).
1655 * 2. Only relevant modifiers are considered for the matching. For example,
1656 * Caps Lock and Num Lock should not generally affect the matching, e.g.
1657 * when matching \<Alt\>\<Tab\> against the state, it does not matter
1658 * whether Num Lock is active or not. These relevant, or "significant",
1659 * modifiers usually include Alt, Control, Shift, Super and similar.
1660 * Effectively, this means that non-significant modifiers are masked out,
1661 * before doing the comparison as described above.
1663 * 3. The matching must be independent of the layout/keymap. For example,
1664 * the \<Plus\> (+) symbol is found on the first level on some layouts,
1665 * but requires holding Shift on others. If you simply bind the action
1666 * to the \<Plus\> keysym, it would work for the unshifted kind, but
1667 * not for the others, because the match against Shift would fail. If
1668 * you bind the action to \<Shift\>\<Plus\>, only the shifted kind would
1669 * work. So what is needed is to recognize that Shift is used up in the
1670 * translation of the keysym itself, and therefore should not be included
1672 * Effectively, this means that consumed modifiers (Shift in this example)
1673 * are masked out as well, before doing the comparison.
1675 * In summary, this is approximately how the matching would be performed:
1677 * (keysym == shortcut_keysym) &&
1678 * ((state_mods & ~consumed_mods & significant_mods) == shortcut_mods)
1681 * @c state_mods are the modifiers reported by
1682 * xkb_state_mod_index_is_active() and similar functions.
1683 * @c consumed_mods are the modifiers reported by
1684 * xkb_state_mod_index_is_consumed() and similar functions.
1685 * @c significant_mods are decided upon by the application/toolkit/user;
1686 * it is up to them to decide whether these are configurable or hard-coded.
1692 * Consumed modifiers mode.
1694 * There are several possible methods for deciding which modifiers are
1695 * consumed and which are not, each applicable for different systems or
1696 * situations. The mode selects the method to use.
1698 * Keep in mind that in all methods, the keymap may decide to "preserve"
1699 * a modifier, meaning it is not reported as consumed even if it would
1702 enum xkb_consumed_mode {
1704 * This is the mode defined in the XKB specification and used by libX11.
1706 * A modifier is consumed iff it *may affect* key translation.
1708 * For example, if `Control+Alt+<Backspace>` produces some assigned keysym,
1709 * then when pressing just `<Backspace>`, `Control` and `Alt` are consumed,
1710 * even though they are not active, since if they *were* active they would
1711 * have affected key translation.
1713 XKB_CONSUMED_MODE_XKB,
1715 * This is the mode used by the GTK+ toolkit.
1717 * The mode consists of the following two heuristics:
1719 * - The active set of modifiers, excluding modifiers which do not affect
1720 * the key (as described above), are considered consumed, if they result
1721 * in different keysyms being produced than when no modifiers are active.
1723 * - Additionally, a single modifier is considered consumed if, were it the
1724 * only active modifier affecting the key (as described above), it would
1725 * result in different keysyms being produced than when no modifiers are
1728 XKB_CONSUMED_MODE_GTK
1732 * Get the mask of modifiers consumed by translating a given key.
1734 * @param state The keyboard state.
1735 * @param key The keycode of the key.
1736 * @param mode The consumed modifiers mode to use; see enum description.
1738 * @returns a mask of the consumed modifiers.
1740 * @memberof xkb_state
1744 xkb_state_key_get_consumed_mods2(struct xkb_state *state, xkb_keycode_t key,
1745 enum xkb_consumed_mode mode);
1748 * Same as xkb_state_key_get_consumed_mods2() with mode XKB_CONSUMED_MODE_XKB.
1750 * @memberof xkb_state
1754 xkb_state_key_get_consumed_mods(struct xkb_state *state, xkb_keycode_t key);
1757 * Test whether a modifier is consumed by keyboard state translation for
1760 * @param state The keyboard state.
1761 * @param key The keycode of the key.
1762 * @param idx The index of the modifier to check.
1763 * @param mode The consumed modifiers mode to use; see enum description.
1765 * @returns 1 if the modifier is consumed, 0 if it is not. If the modifier
1766 * index is not valid in the keymap, returns -1.
1768 * @sa xkb_state_mod_mask_remove_consumed()
1769 * @sa xkb_state_key_get_consumed_mods()
1770 * @memberof xkb_state
1774 xkb_state_mod_index_is_consumed2(struct xkb_state *state,
1776 xkb_mod_index_t idx,
1777 enum xkb_consumed_mode mode);
1780 * Same as xkb_state_mod_index_is_consumed2() with mode XKB_CONSUMED_MOD_XKB.
1782 * @memberof xkb_state
1786 xkb_state_mod_index_is_consumed(struct xkb_state *state, xkb_keycode_t key,
1787 xkb_mod_index_t idx);
1790 * Remove consumed modifiers from a modifier mask for a key.
1792 * @deprecated Use xkb_state_key_get_consumed_mods2() instead.
1794 * Takes the given modifier mask, and removes all modifiers which are
1795 * consumed for that particular key (as in xkb_state_mod_index_is_consumed()).
1797 * @sa xkb_state_mod_index_is_consumed()
1798 * @memberof xkb_state
1801 xkb_state_mod_mask_remove_consumed(struct xkb_state *state, xkb_keycode_t key,
1802 xkb_mod_mask_t mask);
1805 * Test whether a layout is active in a given keyboard state by name.
1807 * @returns 1 if the layout is active, 0 if it is not. If no layout with
1808 * this name exists in the keymap, return -1.
1810 * If multiple layouts in the keymap have this name, the one with the lowest
1813 * @sa xkb_layout_index_t
1814 * @memberof xkb_state
1817 xkb_state_layout_name_is_active(struct xkb_state *state, const char *name,
1818 enum xkb_state_component type);
1821 * Test whether a layout is active in a given keyboard state by index.
1823 * @returns 1 if the layout is active, 0 if it is not. If the layout index
1824 * is not valid in the keymap, returns -1.
1826 * @sa xkb_layout_index_t
1827 * @memberof xkb_state
1830 xkb_state_layout_index_is_active(struct xkb_state *state,
1831 xkb_layout_index_t idx,
1832 enum xkb_state_component type);
1835 * Test whether a LED is active in a given keyboard state by name.
1837 * @returns 1 if the LED is active, 0 if it not. If no LED with this name
1838 * exists in the keymap, returns -1.
1840 * @sa xkb_led_index_t
1841 * @memberof xkb_state
1844 xkb_state_led_name_is_active(struct xkb_state *state, const char *name);
1847 * Test whether a LED is active in a given keyboard state by index.
1849 * @returns 1 if the LED is active, 0 if it not. If the LED index is not
1850 * valid in the keymap, returns -1.
1852 * @sa xkb_led_index_t
1853 * @memberof xkb_state
1856 xkb_state_led_index_is_active(struct xkb_state *state, xkb_led_index_t idx);
1860 /* Leave this include last, so it can pick up our types, etc. */
1861 #include <xkbcommon/xkbcommon-compat.h>
1867 #endif /* _XKBCOMMON_H_ */