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 Daniel Stone
57 * Permission is hereby granted, free of charge, to any person obtaining a
58 * copy of this software and associated documentation files (the "Software"),
59 * to deal in the Software without restriction, including without limitation
60 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
61 * and/or sell copies of the Software, and to permit persons to whom the
62 * Software is furnished to do so, subject to the following conditions:
64 * The above copyright notice and this permission notice (including the next
65 * paragraph) shall be included in all copies or substantial portions of the
68 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
69 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
70 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
71 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
72 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
73 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
74 * DEALINGS IN THE SOFTWARE.
76 * Author: Daniel Stone <daniel@fooishbar.org>
86 #include <xkbcommon/xkbcommon-names.h>
87 #include <xkbcommon/xkbcommon-keysyms.h>
89 typedef uint32_t xkb_keycode_t;
90 typedef uint32_t xkb_keysym_t;
91 typedef uint32_t xkb_mod_index_t;
92 typedef uint32_t xkb_mod_mask_t;
93 typedef uint32_t xkb_group_index_t;
94 typedef uint32_t xkb_led_index_t;
96 #define XKB_MOD_INVALID (0xffffffff)
97 #define XKB_GROUP_INVALID (0xffffffff)
98 #define XKB_KEYCODE_INVALID (0xffffffff)
99 #define XKB_LED_INVALID (0xffffffff)
101 #define XKB_KEYCODE_MAX (0xffffffff - 1)
102 #define xkb_keycode_is_legal_ext(kc) (kc <= XKB_KEYCODE_MAX)
103 #define xkb_keycode_is_legal_x11(kc) (kc >= 8 && kc <= 255)
106 * Names to compile a keymap with, also known as RMLVO. These names together
107 * should be the primary identifier for a keymap.
109 struct xkb_rule_names {
118 * Opaque context object; may only be created, accessed, manipulated and
119 * destroyed through the xkb_context_*() API.
124 * Opaque keymap object; may only be created, accessed, manipulated and
125 * destroyed through the xkb_state_*() API.
130 * Opaque state object; may only be created, accessed, manipulated and
131 * destroyed through the xkb_state_*() API.
140 * Returns the name for a keysym as a string; will return unknown Unicode
141 * codepoints as "Ua1b2", and other unknown keysyms as "0xabcd1234".
142 * If the buffer passed is too small, the string is truncated; a size of
143 * at least 32 bytes is recommended.
146 xkb_keysym_get_name(xkb_keysym_t ks, char *buffer, size_t size);
149 * See xkb_keysym_get_name comments: this function will accept any string
150 * from that function.
153 xkb_keysym_from_name(const char *s);
156 * Return the printable representation of the keystring in Unicode/UTF-8.
157 * The buffer passed must be at least 7 bytes long. The return value
158 * is the number of bytes written to the buffer. A return value of zero
159 * means that the keysym does not have a known printable Unicode
160 * representation, and a return value of -1 means that the buffer was too
161 * small to contain the return.
164 xkb_keysym_to_utf8(xkb_keysym_t keysym, char *buffer, size_t size);
167 * Returns the Unicode/UTF-32 representation of the provided keysym, which is
168 * also compatible with UCS-4. A return value of zero means the keysym does
169 * not have a known printable Unicode representation.
172 xkb_keysym_to_utf32(xkb_keysym_t keysym);
175 * @defgroup context XKB contexts
176 * Every keymap compilation request must have an XKB context associated with
177 * it. The context keeps around state such as the include path.
182 enum xkb_context_flags {
183 /** Create this context with an empty include path. */
184 XKB_CONTEXT_NO_DEFAULT_INCLUDES = 1,
188 * Returns a new XKB context, or NULL on failure. If successful, the caller
189 * holds a reference on the context, and must free it when finished with
190 * xkb_context_unref().
193 xkb_context_new(enum xkb_context_flags flags);
196 * Appends a new entry to the include path used for keymap compilation.
197 * Returns 1 on success, or 0 if the include path could not be added or is
201 xkb_context_include_path_append(struct xkb_context *context, const char *path);
204 * Appends the default include paths to the context's current include path.
205 * Returns 1 on success, or 0 if the primary include path could not be
209 xkb_context_include_path_append_default(struct xkb_context *context);
212 * Removes all entries from the context's include path, and inserts the
213 * default paths. Returns 1 on success, or 0 if the primary include path
214 * could not be added.
217 xkb_context_include_path_reset_defaults(struct xkb_context *context);
220 * Removes all entries from the context's include path.
223 xkb_context_include_path_clear(struct xkb_context *context);
226 * Returns the number of include paths currently active in the context.
229 xkb_context_num_include_paths(struct xkb_context *context);
232 * Returns the include path at the specified index within the context.
235 xkb_context_include_path_get(struct xkb_context *context, unsigned int index);
238 * Takes a new reference on an XKB context.
241 xkb_context_ref(struct xkb_context *context);
244 * Releases a reference on an XKB context, and possibly frees it.
247 xkb_context_unref(struct xkb_context *context);
252 * @defgroup logging Logging handling
253 * These functions allow you to manipulate how logging from this library
260 /** Log critical internal errors only */
261 XKB_LOG_LEVEL_CRITICAL = 0,
262 /** Log all errors */
263 XKB_LOG_LEVEL_ERROR = 1,
264 /** Log warnings and errors */
265 XKB_LOG_LEVEL_WARNING = 2,
266 /** Log information, warnings, and errors */
267 XKB_LOG_LEVEL_INFO = 3,
268 /** Log all the things */
269 XKB_LOG_LEVEL_DEBUG = 4,
273 * Sets the function to be called for logging messages.
274 * Passing NULL restores the default function, which logs to stderr.
277 xkb_set_log_fn(struct xkb_context *context,
278 void (*log_fn)(struct xkb_context *context, int priority,
279 const char *format, va_list args));
281 * Sets the current logging priority. The value controls which messages
282 * are logged. The default priority is LOG_ERR.
284 * The environment variable XKB_LOG, if set, overrides the default value
285 * and may be specified as a priority number or name.
288 xkb_set_log_priority(struct xkb_context *context, enum xkb_log_level priority);
291 * Returns the current logging priority.
294 xkb_get_log_priority(struct xkb_context *context);
297 * Sets the current logging verbosity, a value from 0 to 10.
299 * The library can generate a number of warnings which are not helpful to
300 * ordinary users of the library. The verbosity may be increased if more
301 * information is desired (e.g. when developing a keymap). Defaults to 0.
302 * The environment variable XKB_VERBOSITY, if set, overrdies the default
305 * Note that most verbose messages are of priority XKB_LOG_LEVEL_WARNING
309 xkb_set_log_verbosity(struct xkb_context *ctx, int verbosity);
312 * Returns the current logging verbosity.
315 xkb_get_log_verbosity(struct xkb_context *ctx);
318 * Retrieves stored data pointer from the context. This might be useful
319 * to access from callbacks like a custom logging function.
321 * If context is NULL, returns NULL.
324 xkb_get_user_data(struct xkb_context *context);
327 * Store custom user data in the context.
330 xkb_set_user_data(struct xkb_context *context, void *user_data);
335 * @defgroup map Keymap management
336 * These utility functions allow you to create and deallocate XKB keymaps.
341 enum xkb_map_compile_flags {
342 /** Apparently you can't have empty enums. What a drag. */
343 XKB_MAP_COMPILE_PLACEHOLDER = 0,
347 * The primary keymap entry point: creates a new XKB keymap from a set of
348 * RMLVO (Rules + Model + Layout + Variant + Option) names.
350 * You should almost certainly be using this and nothing else to create
354 xkb_map_new_from_names(struct xkb_context *context,
355 const struct xkb_rule_names *names,
356 enum xkb_map_compile_flags flags);
358 enum xkb_keymap_format {
359 /** The current/classic XKB text format, as generated by xkbcomp -xkb. */
360 XKB_KEYMAP_FORMAT_TEXT_V1 = 1,
364 * Creates an XKB keymap from a full text XKB keymap passed into the
368 xkb_map_new_from_file(struct xkb_context *context, FILE *file,
369 enum xkb_keymap_format format,
370 enum xkb_map_compile_flags flags);
373 * Creates an XKB keymap from a full text XKB keymap serialized into one
377 xkb_map_new_from_string(struct xkb_context *context, const char *string,
378 enum xkb_keymap_format format,
379 enum xkb_map_compile_flags flags);
382 * Returns the compiled XKB map as a string which can later be fed back into
383 * xkb_map_new_from_string to return the exact same keymap.
386 xkb_map_get_as_string(struct xkb_keymap *keymap);
389 * Takes a new reference on a keymap.
392 xkb_map_ref(struct xkb_keymap *keymap);
395 * Releases a reference on a keymap.
398 xkb_map_unref(struct xkb_keymap *keymap);
403 * @defgroup components XKB state components
404 * Allows enumeration of state components such as modifiers and groups within
405 * the current keymap.
411 * Returns the number of modifiers active in the keymap.
414 xkb_map_num_mods(struct xkb_keymap *keymap);
417 * Returns the name of the modifier specified by 'idx', or NULL if invalid.
420 xkb_map_mod_get_name(struct xkb_keymap *keymap, xkb_mod_index_t idx);
423 * Returns the index of the modifier specified by 'name', or XKB_MOD_INVALID.
426 xkb_map_mod_get_index(struct xkb_keymap *keymap, const char *name);
429 * Returns the number of groups active in the keymap.
432 xkb_map_num_groups(struct xkb_keymap *keymap);
435 * Returns the name of the group specified by 'idx', or NULL if invalid.
438 xkb_map_group_get_name(struct xkb_keymap *keymap, xkb_group_index_t idx);
441 * Returns the index of the group specified by 'name', or XKB_GROUP_INVALID.
444 xkb_map_group_get_index(struct xkb_keymap *keymap, const char *name);
447 * Returns the number of groups active for the specified key.
450 xkb_key_num_groups(struct xkb_keymap *keymap, xkb_keycode_t key);
453 * Returns 1 if the key should repeat, or 0 otherwise.
456 xkb_key_repeats(struct xkb_keymap *keymap, xkb_keycode_t key);
459 * Returns the number of LEDs in the given map.
462 xkb_map_num_leds(struct xkb_keymap *keymap);
465 * Returns the name of the LED specified by 'idx', or NULL if invalid.
468 xkb_map_led_get_name(struct xkb_keymap *keymap, xkb_led_index_t idx);
471 * Returns the index of the LED specified by 'name', or XKB_LED_INVALID.
474 xkb_map_led_get_index(struct xkb_keymap *keymap, const char *name);
479 * @defgroup state XKB state objects
480 * Creation, destruction and manipulation of keyboard state objects,
481 * representing modifier and group state.
487 * Returns a new XKB state object for use with the given keymap, or NULL on
491 xkb_state_new(struct xkb_keymap *keymap);
494 * Takes a new reference on a state object.
497 xkb_state_ref(struct xkb_state *state);
500 * Unrefs and potentially deallocates a state object; the caller must not
501 * use the state object after calling this.
504 xkb_state_unref(struct xkb_state *state);
507 * Get the keymap from which the state object was created. Does not take
508 * a new reference on the map; you must explicitly reference it yourself
509 * if you plan to use it beyond the lifetime of the state.
512 xkb_state_get_map(struct xkb_state *state);
514 enum xkb_key_direction {
520 * Updates a state object to reflect the given key being pressed or released.
523 xkb_state_update_key(struct xkb_state *state, xkb_keycode_t key,
524 enum xkb_key_direction direction);
527 * Gives the symbols obtained from pressing a particular key with the given
528 * state. *syms_out will be set to point to an array of keysyms, with the
529 * return value being the number of symbols in *syms_out. If the return
530 * value is 0, *syms_out will be set to NULL, as there are no symbols produced
533 * This should be called before xkb_state_update_key.
536 xkb_key_get_syms(struct xkb_state *state, xkb_keycode_t key,
537 const xkb_keysym_t **syms_out);
540 * Modifier and group types for state objects. This enum is bitmaskable,
541 * e.g. (XKB_STATE_DEPRESSED | XKB_STATE_LATCHED) is valid to exclude
544 enum xkb_state_component {
545 /** A key holding this modifier or group is currently physically
546 * depressed; also known as 'base'. */
547 XKB_STATE_DEPRESSED = (1 << 0),
548 /** Modifier or group is latched, i.e. will be unset after the next
549 * non-modifier key press. */
550 XKB_STATE_LATCHED = (1 << 1),
551 /** Modifier or group is locked, i.e. will be unset after the key
552 * provoking the lock has been pressed again. */
553 XKB_STATE_LOCKED = (1 << 2),
554 /** Combinatination of depressed, latched, and locked. */
555 XKB_STATE_EFFECTIVE =
556 (XKB_STATE_DEPRESSED | XKB_STATE_LATCHED | XKB_STATE_LOCKED),
560 * Match flags for xkb_state_mod_indices_are_active and
561 * xkb_state_mod_names_are_active, specifying how the conditions for a
562 * successful match. XKB_STATE_MATCH_NON_EXCLUSIVE is bitmaskable with
565 enum xkb_state_match {
566 /** Returns true if any of the modifiers are active. */
567 XKB_STATE_MATCH_ANY = (1 << 0),
568 /** Returns true if all of the modifiers are active. */
569 XKB_STATE_MATCH_ALL = (1 << 1),
570 /** Makes matching non-exclusive, i.e. will not return false if a
571 * modifier not specified in the arguments is active. */
572 XKB_STATE_MATCH_NON_EXCLUSIVE = (1 << 16),
576 * Updates a state object from a set of explicit masks. This entrypoint is
577 * really only for window systems and the like, where a master process
578 * holds an xkb_state, then serializes it over a wire protocol, and clients
579 * then use the serialization to feed in to their own xkb_state.
581 * All parameters must always be passed, or the resulting state may be
584 * The serialization is lossy and will not survive round trips; it must only
585 * be used to feed slave state objects, and must not be used to update the
588 * Please do not use this unless you fit the description above.
591 xkb_state_update_mask(struct xkb_state *state, xkb_mod_mask_t base_mods,
592 xkb_mod_mask_t latched_mods, xkb_mod_mask_t locked_mods,
593 xkb_group_index_t base_group,
594 xkb_group_index_t latched_group,
595 xkb_group_index_t locked_group);
598 * The counterpart to xkb_state_update_mask, to be used on the server side
599 * of serialization. Returns a xkb_mod_mask_t representing the given
600 * component(s) of the state.
602 * This function should not be used in regular clients; please use the
603 * xkb_state_mod_*_is_active or xkb_state_foreach_active_mod API instead.
605 * Can return NULL on failure.
608 xkb_state_serialize_mods(struct xkb_state *state,
609 enum xkb_state_component component);
612 * The group equivalent of xkb_state_serialize_mods: please see its
616 xkb_state_serialize_group(struct xkb_state *state,
617 enum xkb_state_component component);
620 * Returns 1 if the modifier specified by 'name' is active in the manner
621 * specified by 'type', 0 if it is unset, or -1 if the modifier does not
625 xkb_state_mod_name_is_active(struct xkb_state *state, const char *name,
626 enum xkb_state_component type);
629 * Returns 1 if the modifiers specified by the varargs (treated as
630 * NULL-terminated pointers to strings) are active in the manner
631 * specified by 'match', 0 otherwise, or -1 if any of the modifiers
632 * do not exist in the map.
635 xkb_state_mod_names_are_active(struct xkb_state *state,
636 enum xkb_state_component type,
637 enum xkb_state_match match,
641 * Returns 1 if the modifier specified by 'idx' is active in the manner
642 * specified by 'type', 0 if it is unset, or -1 if the modifier does not
643 * exist in the current map.
646 xkb_state_mod_index_is_active(struct xkb_state *state, xkb_mod_index_t idx,
647 enum xkb_state_component type);
650 * Returns 1 if the modifier specified by 'idx' is used in the
651 * translation of the keycode 'key' to the key symbols obtained by
652 * pressing it (as in xkb_key_get_syms), given the current state.
653 * Returns 0 otherwise.
656 xkb_key_mod_index_is_consumed(struct xkb_state *state, xkb_keycode_t key,
657 xkb_mod_index_t idx);
660 * Returns 1 if the modifiers specified by the varargs (treated as
661 * xkb_mod_index_t, terminated with XKB_MOD_INVALID) are active in the manner
662 * specified by 'match' and 'type', 0 otherwise, or -1 if the modifier does not
663 * exist in the current map.
666 xkb_state_mod_indices_are_active(struct xkb_state *state,
667 enum xkb_state_component type,
668 enum xkb_state_match match,
672 * Returns 1 if the group specified by 'name' is active in the manner
673 * specified by 'type', 0 if it is unset, or -1 if the group does not
674 * exist in the current map.
677 xkb_state_group_name_is_active(struct xkb_state *state, const char *name,
678 enum xkb_state_component type);
681 * Returns 1 if the group specified by 'idx' is active in the manner
682 * specified by 'type', 0 if it is unset, or -1 if the group does not
683 * exist in the current map.
686 xkb_state_group_index_is_active(struct xkb_state *state,
687 xkb_group_index_t idx,
688 enum xkb_state_component type);
691 * Returns 1 if the LED specified by 'name' is active, 0 if it is unset, or
692 * -1 if the LED does not exist in the current map.
695 xkb_state_led_name_is_active(struct xkb_state *state, const char *name);
698 * Returns 1 if the LED specified by 'idx' is active, 0 if it is unset, or
699 * -1 if the LED does not exist in the current map.
702 xkb_state_led_index_is_active(struct xkb_state *state, xkb_led_index_t idx);
710 #endif /* _XKBCOMMON_H_ */