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-keysyms.h>
88 #define XKB_KEY_NoSymbol 0L /* special KeySym */
90 typedef uint32_t xkb_keycode_t;
91 typedef uint32_t xkb_keysym_t;
92 typedef uint32_t xkb_mod_index_t;
93 typedef uint32_t xkb_mod_mask_t;
94 typedef uint32_t xkb_group_index_t;
95 typedef uint32_t xkb_led_index_t;
97 #define XKB_MOD_INVALID (0xffffffff)
98 #define XKB_GROUP_INVALID (0xffffffff)
99 #define XKB_KEYCODE_INVALID (0xffffffff)
100 #define XKB_LED_INVALID (0xffffffff)
102 #define XKB_KEYCODE_MAX (0xffffffff - 1)
103 #define xkb_keycode_is_legal_ext(kc) (kc <= XKB_KEYCODE_MAX)
104 #define xkb_keycode_is_legal_x11(kc) (kc >= 8 && kc <= 255)
107 * Names to compile a keymap with, also known as RMLVO. These names together
108 * should be the primary identifier for a keymap.
110 struct xkb_rule_names {
119 * Legacy names for the components of an XKB keymap, also known as KcCGST.
120 * This is only used in deprecated entrypoints which might be removed or
121 * shuffled off to a support library.
123 struct xkb_component_names {
132 * Opaque context object; may only be created, accessed, manipulated and
133 * destroyed through the xkb_ctx_*() API.
138 * Opaque keymap object; may only be created, accessed, manipulated and
139 * destroyed through the xkb_state_*() API.
144 * Opaque state object; may only be created, accessed, manipulated and
145 * destroyed through the xkb_state_*() API.
154 * Canonicalises component names by prepending the relevant component from
155 * 'old' to the one in 'names' when the latter has a leading '+' or '|', and
156 * by replacing a '%' with the relevant component, e.g.:
159 * ------------------------------------------
162 * foo+%|baz bar foo+bar|baz
164 * If a component in names needs to be modified, the existing value will be
165 * free()d, and a new one allocated with malloc().
168 xkb_canonicalise_components(struct xkb_component_names *names,
169 const struct xkb_component_names *old);
172 * Returns the name for a keysym as a string; will return unknown Unicode
173 * codepoints as "Ua1b2", and other unknown keysyms as "0xabcd1234".
176 xkb_keysym_get_name(xkb_keysym_t ks, char *buffer, size_t size);
179 * See xkb_keysym_to_string comments: this function will accept any string
180 * from that function.
183 xkb_keysym_from_name(const char *s);
186 * @defgroup ctx XKB contexts
187 * Every keymap compilation request must have an XKB context associated with
188 * it. The context keeps around state such as the include path.
194 /** Create this context with an empty include path. */
195 XKB_CONTEXT_NO_DEFAULT_INCLUDES = 1,
199 * Returns a new XKB context, or NULL on failure. If successful, the caller
200 * holds a reference on the context, and must free it when finished with
204 xkb_ctx_new(enum xkb_ctx_flags flags);
207 * Appends a new entry to the include path used for keymap compilation.
208 * Returns 1 on success, or 0 if the include path could not be added or is
212 xkb_ctx_include_path_append(struct xkb_ctx *ctx, const char *path);
215 * Appends the default include paths to the context's current include path.
216 * Returns 1 on success, or 0 if the primary include path could not be
220 xkb_ctx_include_path_append_default(struct xkb_ctx *ctx);
223 * Removes all entries from the context's include path, and inserts the
224 * default paths. Returns 1 on success, or 0 if the primary include path
225 * could not be added.
228 xkb_ctx_include_path_reset_defaults(struct xkb_ctx *ctx);
231 * Removes all entries from the context's include path.
234 xkb_ctx_include_path_clear(struct xkb_ctx *ctx);
237 * Returns the number of include paths currently active in the context.
240 xkb_ctx_num_include_paths(struct xkb_ctx *ctx);
243 * Returns the include path at the specified index within the context.
246 xkb_ctx_include_path_get(struct xkb_ctx *ctx, unsigned int index);
249 * Takes a new reference on an XKB context.
252 xkb_ctx_ref(struct xkb_ctx *ctx);
255 * Releases a reference on an XKB context, and possibly frees it.
258 xkb_ctx_unref(struct xkb_ctx *ctx);
263 * @defgroup map Keymap management
264 * These utility functions allow you to create and deallocate XKB keymaps.
269 enum xkb_map_compile_flags {
270 /** Apparently you can't have empty enums. What a drag. */
271 XKB_MAP_COMPILE_PLACEHOLDER = 0,
275 * The primary keymap entry point: creates a new XKB keymap from a set of
276 * RMLVO (Rules + Model + Layout + Variant + Option) names.
278 * You should almost certainly be using this and nothing else to create
282 xkb_map_new_from_names(struct xkb_ctx *ctx,
283 const struct xkb_rule_names *names,
284 enum xkb_map_compile_flags flags);
287 * Deprecated entrypoint for legacy users who need to be able to compile
288 * XKB keymaps by KcCGST (Keycodes + Compat + Geometry + Symbols + Types)
291 * You should not use this unless you are the X server. This entrypoint
292 * may well disappear in future releases. Please, please, don't use it.
294 * Geometry will be ignored since xkbcommon does not support it in any way.
297 xkb_map_new_from_kccgst(struct xkb_ctx *ctx,
298 const struct xkb_component_names *kccgst,
299 enum xkb_map_compile_flags flags);
301 enum xkb_keymap_format {
302 /** The current/classic XKB text format, as generated by xkbcomp -xkb. */
303 XKB_KEYMAP_FORMAT_TEXT_V1 = 1,
307 * Creates an XKB keymap from a full text XKB keymap passed into the
311 xkb_map_new_from_fd(struct xkb_ctx *ctx,
312 int fd, enum xkb_keymap_format format,
313 enum xkb_map_compile_flags flags);
316 * Creates an XKB keymap from a full text XKB keymap serialised into one
320 xkb_map_new_from_string(struct xkb_ctx *ctx,
322 enum xkb_keymap_format format,
323 enum xkb_map_compile_flags flags);
326 * Takes a new reference on a keymap.
329 xkb_map_ref(struct xkb_keymap *keymap);
332 * Releases a reference on a keymap.
335 xkb_map_unref(struct xkb_keymap *keymap);
340 * @defgroup components XKB state components
341 * Allows enumeration of state components such as modifiers and groups within
342 * the current keymap.
348 * Returns the number of modifiers active in the keymap.
351 xkb_map_num_mods(struct xkb_keymap *keymap);
354 * Returns the name of the modifier specified by 'idx', or NULL if invalid.
357 xkb_map_mod_get_name(struct xkb_keymap *keymap, xkb_mod_index_t idx);
360 * Returns the index of the modifier specified by 'name', or XKB_MOD_INVALID.
363 xkb_map_mod_get_index(struct xkb_keymap *keymap, const char *name);
366 * Returns the number of groups active in the keymap.
369 xkb_map_num_groups(struct xkb_keymap *keymap);
372 * Returns the name of the group specified by 'idx', or NULL if invalid.
375 xkb_map_group_get_name(struct xkb_keymap *keymap, xkb_group_index_t idx);
378 * Returns the index of the group specified by 'name', or XKB_GROUP_INVALID.
381 xkb_map_group_get_index(struct xkb_keymap *keymap, const char *name);
384 * Returns the number of groups active for the specified key.
387 xkb_key_num_groups(struct xkb_keymap *keymap, xkb_keycode_t key);
390 * Returns the number of LEDs in the given map.
393 xkb_map_num_leds(struct xkb_keymap *keymap);
396 * Returns the name of the LED specified by 'idx', or NULL if invalid.
399 xkb_map_led_get_name(struct xkb_keymap *keymap, xkb_led_index_t idx);
402 * Returns the index of the LED specified by 'name', or XKB_LED_INVALID.
405 xkb_map_led_get_index(struct xkb_keymap *keymap, const char *name);
410 * @defgroup state XKB state objects
411 * Creation, destruction and manipulation of keyboard state objects,
412 * representing modifier and group state.
418 * Returns a new XKB state object for use with the given keymap, or NULL on
422 xkb_state_new(struct xkb_keymap *keymap);
425 * Takes a new reference on a state object.
428 xkb_state_ref(struct xkb_state *state);
431 * Unrefs and potentially deallocates a state object; the caller must not
432 * use the state object after calling this.
435 xkb_state_unref(struct xkb_state *state);
438 * Get the keymap from which the state object was created.
441 xkb_state_get_map(struct xkb_state *state);
443 enum xkb_key_direction {
449 * Updates a state object to reflect the given key being pressed or released.
452 xkb_state_update_key(struct xkb_state *state, xkb_keycode_t key,
453 enum xkb_key_direction direction);
456 * Gives the symbols obtained from pressing a particular key with the given
457 * state. *syms_out will be set to point to an array of keysyms, with the
458 * return value being the number of symbols in *syms_out. If the return
459 * value is 0, *syms_out will be set to NULL, as there are no symbols produced
462 * This should be called before xkb_state_update_key.
465 xkb_key_get_syms(struct xkb_state *state, xkb_keycode_t key,
466 const xkb_keysym_t **syms_out);
469 * Modifier and group types for state objects. This enum is bitmaskable,
470 * e.g. (XKB_STATE_DEPRESSED | XKB_STATE_LATCHED) is valid to exclude
473 enum xkb_state_component {
474 /** A key holding this modifier or group is currently physically
475 * depressed; also known as 'base'. */
476 XKB_STATE_DEPRESSED = (1 << 0),
477 /** Modifier or group is latched, i.e. will be unset after the next
478 * non-modifier key press. */
479 XKB_STATE_LATCHED = (1 << 1),
480 /** Modifier or group is locked, i.e. will be unset after the key
481 * provoking the lock has been pressed again. */
482 XKB_STATE_LOCKED = (1 << 2),
483 /** Combinatination of depressed, latched, and locked. */
484 XKB_STATE_EFFECTIVE =
485 (XKB_STATE_DEPRESSED | XKB_STATE_LATCHED | XKB_STATE_LOCKED),
489 * Match flags for xkb_state_mod_indices_are_active and
490 * xkb_state_mod_names_are_active, specifying how the conditions for a
491 * successful match. XKB_STATE_MATCH_NON_EXCLUSIVE is bitmaskable with
494 enum xkb_state_match {
495 /** Returns true if any of the modifiers are active. */
496 XKB_STATE_MATCH_ANY = (1 << 0),
497 /** Returns true if all of the modifiers are active. */
498 XKB_STATE_MATCH_ALL = (1 << 1),
499 /** Makes matching non-exclusive, i.e. will not return false if a
500 * modifier not specified in the arguments is active. */
501 XKB_STATE_MATCH_NON_EXCLUSIVE = (1 << 16),
505 * Updates a state object from a set of explicit masks. This entrypoint is
506 * really only for window systems and the like, where a master process
507 * holds an xkb_state, then serialises it over a wire protocol, and clients
508 * then use the serialisation to feed in to their own xkb_state.
510 * All parameters must always be passed, or the resulting state may be
513 * The serialisation is lossy and will not survive round trips; it must only
514 * be used to feed slave state objects, and must not be used to update the
517 * Please do not use this unless you fit the description above.
520 xkb_state_update_mask(struct xkb_state *state,
521 xkb_mod_mask_t base_mods,
522 xkb_mod_mask_t latched_mods,
523 xkb_mod_mask_t locked_mods,
524 xkb_group_index_t base_group,
525 xkb_group_index_t latched_group,
526 xkb_group_index_t locked_group);
529 * The counterpart to xkb_state_update_mask, to be used on the server side
530 * of serialisation. Returns a xkb_mod_mask_t representing the given
531 * component(s) of the state.
533 * This function should not be used in regular clients; please use the
534 * xkb_state_mod_*_is_active or xkb_state_foreach_active_mod API instead.
536 * Can return NULL on failure.
539 xkb_state_serialise_mods(struct xkb_state *state,
540 enum xkb_state_component component);
543 * The group equivalent of xkb_state_serialise_mods: please see its
547 xkb_state_serialise_group(struct xkb_state *state,
548 enum xkb_state_component component);
551 * Returns 1 if the modifier specified by 'name' is active in the manner
552 * specified by 'type', 0 if it is unset, or -1 if the modifier does not
556 xkb_state_mod_name_is_active(struct xkb_state *state, const char *name,
557 enum xkb_state_component type);
560 * Returns 1 if the modifiers specified by the varargs (treated as
561 * NULL-terminated pointers to strings) are active in the manner
562 * specified by 'match', 0 otherwise, or -1 if any of the modifiers
563 * do not exist in the map.
566 xkb_state_mod_names_are_active(struct xkb_state *state,
567 enum xkb_state_component type,
568 enum xkb_state_match match,
572 * Returns 1 if the modifier specified by 'idx' is active in the manner
573 * specified by 'type', 0 if it is unset, or -1 if the modifier does not
574 * exist in the current map.
577 xkb_state_mod_index_is_active(struct xkb_state *state, xkb_mod_index_t idx,
578 enum xkb_state_component type);
581 * Returns 1 if the modifiers specified by the varargs (treated as
582 * xkb_mod_index_t, terminated with XKB_MOD_INVALID) are active in the manner
583 * specified by 'match' and 'type', 0 otherwise, or -1 if the modifier does not
584 * exist in the current map.
587 xkb_state_mod_indices_are_active(struct xkb_state *state,
588 enum xkb_state_component type,
589 enum xkb_state_match match,
593 * Returns 1 if the group specified by 'name' is active in the manner
594 * specified by 'type', 0 if it is unset, or -1 if the group does not
595 * exist in the current map.
598 xkb_state_group_name_is_active(struct xkb_state *state, const char *name,
599 enum xkb_state_component type);
602 * Returns 1 if the group specified by 'idx' is active in the manner
603 * specified by 'type', 0 if it is unset, or -1 if the group does not
604 * exist in the current map.
607 xkb_state_group_index_is_active(struct xkb_state *state, xkb_group_index_t idx,
608 enum xkb_state_component type);
611 * Returns 1 if the LED specified by 'name' is active, 0 if it is unset, or
612 * -1 if the LED does not exist in the current map.
615 xkb_state_led_name_is_active(struct xkb_state *state, const char *name);
618 * Returns 1 if the LED specified by 'idx' is active, 0 if it is unset, or
619 * -1 if the LED does not exist in the current map.
622 xkb_state_led_index_is_active(struct xkb_state *state, xkb_led_index_t idx);
630 #endif /* _XKBCOMMON_H_ */