1 /************************************************************
2 * Copyright (c) 1993 by Silicon Graphics Computer Systems, Inc.
4 * Permission to use, copy, modify, and distribute this
5 * software and its documentation for any purpose and without
6 * fee is hereby granted, provided that the above copyright
7 * notice appear in all copies and that both that copyright
8 * notice and this permission notice appear in supporting
9 * documentation, and that the name of Silicon Graphics not be
10 * used in advertising or publicity pertaining to distribution
11 * of the software without specific prior written permission.
12 * Silicon Graphics makes no representation about the suitability
13 * of this software for any purpose. It is provided "as is"
14 * without any express or implied warranty.
16 * SILICON GRAPHICS DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS
17 * SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
18 * AND FITNESS FOR A PARTICULAR PURPOSE. IN NO EVENT SHALL SILICON
19 * GRAPHICS BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL
20 * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
21 * DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
22 * OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH
23 * THE USE OR PERFORMANCE OF THIS SOFTWARE.
25 ********************************************************/
28 * Copyright © 2012 Intel Corporation
29 * Copyright © 2012 Ran Benita <ran234@gmail.com>
31 * Permission is hereby granted, free of charge, to any person obtaining a
32 * copy of this software and associated documentation files (the "Software"),
33 * to deal in the Software without restriction, including without limitation
34 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
35 * and/or sell copies of the Software, and to permit persons to whom the
36 * Software is furnished to do so, subject to the following conditions:
38 * The above copyright notice and this permission notice (including the next
39 * paragraph) shall be included in all copies or substantial portions of the
42 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
43 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
44 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
45 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
46 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
47 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
48 * DEALINGS IN THE SOFTWARE.
50 * Author: Daniel Stone <daniel@fooishbar.org>
54 * This is a bastardised version of xkbActions.c from the X server which
55 * does not support, for the moment:
56 * - AccessX sticky/debounce/etc (will come later)
57 * - pointer keys (may come later)
58 * - key redirects (unlikely)
59 * - messages (very unlikely)
65 union xkb_action action;
66 const struct xkb_key *key;
68 int (*func)(struct xkb_state *state,
69 struct xkb_filter *filter,
70 const struct xkb_key *key,
71 enum xkb_key_direction direction);
75 struct state_components {
76 /* These may be negative, because of -1 group actions. */
77 int32_t base_group; /**< depressed */
78 int32_t latched_group;
80 xkb_layout_index_t group; /**< effective */
82 xkb_mod_mask_t base_mods; /**< depressed */
83 xkb_mod_mask_t latched_mods;
84 xkb_mod_mask_t locked_mods;
85 xkb_mod_mask_t mods; /**< effective */
92 * Before updating the state, we keep a copy of just this struct. This
93 * allows us to report which components of the state have changed.
95 struct state_components components;
98 * At each event, we accumulate all the needed modifications to the base
99 * modifiers, and apply them at the end. These keep track of this state.
101 xkb_mod_mask_t set_mods;
102 xkb_mod_mask_t clear_mods;
105 * We mustn't clear a base modifier if there's another depressed key
106 * which affects it, e.g. given this sequence
107 * < Left Shift down, Right Shift down, Left Shift Up >
108 * the modifier should still be set. This keeps the count.
110 int16_t mod_key_count[sizeof(xkb_mod_mask_t) * 8];
113 darray(struct xkb_filter) filters;
114 struct xkb_keymap *keymap;
117 static const struct xkb_key_type_entry *
118 get_entry_for_key_state(struct xkb_state *state, const struct xkb_key *key,
119 xkb_layout_index_t group)
121 const struct xkb_key_type *type = key->groups[group].type;
122 xkb_mod_mask_t active_mods = state->components.mods & type->mods.mask;
125 for (i = 0; i < type->num_entries; i++) {
127 * If the virtual modifiers are not bound to anything, we're
128 * supposed to skip the entry (xserver does this with cached
129 * entry->active field).
131 if (!type->entries[i].mods.mask)
134 if (type->entries[i].mods.mask == active_mods)
135 return &type->entries[i];
142 * Returns the level to use for the given key and state, or
145 XKB_EXPORT xkb_level_index_t
146 xkb_state_key_get_level(struct xkb_state *state, xkb_keycode_t kc,
147 xkb_layout_index_t layout)
149 const struct xkb_key *key = XkbKey(state->keymap, kc);
150 const struct xkb_key_type_entry *entry;
152 if (!key || layout >= key->num_groups)
153 return XKB_LEVEL_INVALID;
155 /* If we don't find an explicit match the default is 0. */
156 entry = get_entry_for_key_state(state, key, layout);
164 wrap_group_into_range(int32_t group,
165 xkb_layout_index_t num_groups,
166 enum xkb_range_exceed_type out_of_range_group_action,
167 xkb_layout_index_t out_of_range_group_number)
170 return XKB_LAYOUT_INVALID;
172 if (group < num_groups)
175 switch (out_of_range_group_action) {
177 if (out_of_range_group_number >= num_groups)
179 return out_of_range_group_number;
185 return num_groups - 1;
190 * C99 says a negative dividend in a modulo operation always
191 * gives a negative result.
194 return ((int) num_groups + (group % (int) num_groups));
196 return group % num_groups;
201 * Returns the layout to use for the given key and state, taking
202 * wrapping/clamping/etc into account, or XKB_LAYOUT_INVALID.
204 XKB_EXPORT xkb_layout_index_t
205 xkb_state_key_get_layout(struct xkb_state *state, xkb_keycode_t kc)
207 const struct xkb_key *key = XkbKey(state->keymap, kc);
210 return XKB_LAYOUT_INVALID;
212 return wrap_group_into_range(state->components.group, key->num_groups,
213 key->out_of_range_group_action,
214 key->out_of_range_group_number);
217 static const union xkb_action fake = { .type = ACTION_TYPE_NONE };
219 static const union xkb_action *
220 xkb_key_get_action(struct xkb_state *state, const struct xkb_key *key)
222 xkb_layout_index_t layout;
223 xkb_level_index_t level;
225 layout = xkb_state_key_get_layout(state, key->keycode);
226 if (layout == XKB_LAYOUT_INVALID)
229 level = xkb_state_key_get_level(state, key->keycode, layout);
230 if (level == XKB_LEVEL_INVALID)
233 return &key->groups[layout].levels[level].action;
236 static struct xkb_filter *
237 xkb_filter_new(struct xkb_state *state)
239 struct xkb_filter *filter = NULL, *iter;
241 darray_foreach(iter, state->filters) {
249 darray_resize0(state->filters, darray_size(state->filters) + 1);
250 filter = &darray_item(state->filters, darray_size(state->filters) -1);
257 /***====================================================================***/
260 xkb_filter_group_set_func(struct xkb_state *state,
261 struct xkb_filter *filter,
262 const struct xkb_key *key,
263 enum xkb_key_direction direction)
265 if (key != filter->key) {
266 filter->action.group.flags &= ~ACTION_LOCK_CLEAR;
270 if (direction == XKB_KEY_DOWN) {
274 else if (--filter->refcnt > 0) {
278 state->components.base_group = filter->priv;
280 if (filter->action.group.flags & ACTION_LOCK_CLEAR)
281 state->components.locked_group = 0;
288 xkb_filter_group_set_new(struct xkb_state *state, struct xkb_filter *filter)
290 filter->priv = state->components.base_group;
291 if (filter->action.group.flags & ACTION_ABSOLUTE_SWITCH)
292 state->components.base_group = filter->action.group.group;
294 state->components.base_group += filter->action.group.group;
298 xkb_filter_group_lock_func(struct xkb_state *state,
299 struct xkb_filter *filter,
300 const struct xkb_key *key,
301 enum xkb_key_direction direction)
303 if (key != filter->key)
306 if (direction == XKB_KEY_DOWN) {
310 if (--filter->refcnt > 0)
318 xkb_filter_group_lock_new(struct xkb_state *state, struct xkb_filter *filter)
320 if (filter->action.group.flags & ACTION_ABSOLUTE_SWITCH)
321 state->components.locked_group = filter->action.group.group;
323 state->components.locked_group += filter->action.group.group;
327 xkb_filter_mod_set_func(struct xkb_state *state,
328 struct xkb_filter *filter,
329 const struct xkb_key *key,
330 enum xkb_key_direction direction)
332 if (key != filter->key) {
333 filter->action.mods.flags &= ~ACTION_LOCK_CLEAR;
337 if (direction == XKB_KEY_DOWN) {
341 else if (--filter->refcnt > 0) {
345 state->clear_mods = filter->action.mods.mods.mask;
346 if (filter->action.mods.flags & ACTION_LOCK_CLEAR)
347 state->components.locked_mods &= ~filter->action.mods.mods.mask;
354 xkb_filter_mod_set_new(struct xkb_state *state, struct xkb_filter *filter)
356 state->set_mods = filter->action.mods.mods.mask;
360 xkb_filter_mod_lock_func(struct xkb_state *state,
361 struct xkb_filter *filter,
362 const struct xkb_key *key,
363 enum xkb_key_direction direction)
365 if (key != filter->key)
368 if (direction == XKB_KEY_DOWN) {
372 if (--filter->refcnt > 0)
375 state->clear_mods |= filter->action.mods.mods.mask;
376 if (!(filter->action.mods.flags & ACTION_LOCK_NO_UNLOCK))
377 state->components.locked_mods &= ~filter->priv;
384 xkb_filter_mod_lock_new(struct xkb_state *state, struct xkb_filter *filter)
386 filter->priv = (state->components.locked_mods &
387 filter->action.mods.mods.mask);
388 state->set_mods |= filter->action.mods.mods.mask;
389 if (!(filter->action.mods.flags & ACTION_LOCK_NO_LOCK))
390 state->components.locked_mods |= filter->action.mods.mods.mask;
393 enum xkb_key_latch_state {
400 xkb_action_breaks_latch(const union xkb_action *action)
402 switch (action->type) {
403 case ACTION_TYPE_NONE:
404 case ACTION_TYPE_PTR_BUTTON:
405 case ACTION_TYPE_PTR_LOCK:
406 case ACTION_TYPE_CTRL_SET:
407 case ACTION_TYPE_CTRL_LOCK:
408 case ACTION_TYPE_KEY_REDIRECT:
409 case ACTION_TYPE_SWITCH_VT:
410 case ACTION_TYPE_TERMINATE:
418 xkb_filter_mod_latch_func(struct xkb_state *state,
419 struct xkb_filter *filter,
420 const struct xkb_key *key,
421 enum xkb_key_direction direction)
423 enum xkb_key_latch_state latch = filter->priv;
425 if (direction == XKB_KEY_DOWN && latch == LATCH_PENDING) {
426 /* If this is a new keypress and we're awaiting our single latched
427 * keypress, then either break the latch if any random key is pressed,
428 * or promote it to a lock or plain base set if it's the same
430 const union xkb_action *action = xkb_key_get_action(state, key);
431 if (action->type == ACTION_TYPE_MOD_LATCH &&
432 action->mods.flags == filter->action.mods.flags &&
433 action->mods.mods.mask == filter->action.mods.mods.mask) {
434 filter->action = *action;
435 if (filter->action.mods.flags & ACTION_LATCH_TO_LOCK) {
436 filter->action.type = ACTION_TYPE_MOD_LOCK;
437 filter->func = xkb_filter_mod_lock_func;
438 state->components.locked_mods |= filter->action.mods.mods.mask;
441 filter->action.type = ACTION_TYPE_MOD_SET;
442 filter->func = xkb_filter_mod_set_func;
443 state->set_mods = filter->action.mods.mods.mask;
446 state->components.latched_mods &= ~filter->action.mods.mods.mask;
450 else if (xkb_action_breaks_latch(action)) {
451 /* XXX: This may be totally broken, we might need to break the
452 * latch in the next run after this press? */
453 state->components.latched_mods &= ~filter->action.mods.mods.mask;
458 else if (direction == XKB_KEY_UP && key == filter->key) {
459 /* Our key got released. If we've set it to clear locks, and we
460 * currently have the same modifiers locked, then release them and
461 * don't actually latch. Else we've actually hit the latching
462 * stage, so set PENDING and move our modifier from base to
464 if (latch == NO_LATCH ||
465 ((filter->action.mods.flags & ACTION_LOCK_CLEAR) &&
466 (state->components.locked_mods & filter->action.mods.mods.mask) ==
467 filter->action.mods.mods.mask)) {
468 /* XXX: We might be a bit overenthusiastic about clearing
469 * mods other filters have set here? */
470 if (latch == LATCH_PENDING)
471 state->components.latched_mods &=
472 ~filter->action.mods.mods.mask;
474 state->clear_mods = filter->action.mods.mods.mask;
475 state->components.locked_mods &= ~filter->action.mods.mods.mask;
479 latch = LATCH_PENDING;
480 state->clear_mods = filter->action.mods.mods.mask;
481 state->components.latched_mods |= filter->action.mods.mods.mask;
485 else if (direction == XKB_KEY_DOWN && latch == LATCH_KEY_DOWN) {
486 /* Someone's pressed another key while we've still got the latching
487 * key held down, so keep the base modifier state active (from
488 * xkb_filter_mod_latch_new), but don't trip the latch, just clear
489 * it as soon as the modifier gets released. */
493 filter->priv = latch;
499 xkb_filter_mod_latch_new(struct xkb_state *state, struct xkb_filter *filter)
501 filter->priv = LATCH_KEY_DOWN;
502 state->set_mods = filter->action.mods.mods.mask;
505 static const struct {
506 void (*new)(struct xkb_state *state, struct xkb_filter *filter);
507 int (*func)(struct xkb_state *state, struct xkb_filter *filter,
508 const struct xkb_key *key, enum xkb_key_direction direction);
509 } filter_action_funcs[_ACTION_TYPE_NUM_ENTRIES] = {
510 [ACTION_TYPE_MOD_SET] = { xkb_filter_mod_set_new,
511 xkb_filter_mod_set_func },
512 [ACTION_TYPE_MOD_LATCH] = { xkb_filter_mod_latch_new,
513 xkb_filter_mod_latch_func },
514 [ACTION_TYPE_MOD_LOCK] = { xkb_filter_mod_lock_new,
515 xkb_filter_mod_lock_func },
516 [ACTION_TYPE_GROUP_SET] = { xkb_filter_group_set_new,
517 xkb_filter_group_set_func },
518 [ACTION_TYPE_GROUP_LOCK] = { xkb_filter_group_lock_new,
519 xkb_filter_group_lock_func },
523 * Applies any relevant filters to the key, first from the list of filters
524 * that are currently active, then if no filter has claimed the key, possibly
525 * apply a new filter from the key action.
528 xkb_filter_apply_all(struct xkb_state *state,
529 const struct xkb_key *key,
530 enum xkb_key_direction direction)
532 struct xkb_filter *filter;
533 const union xkb_action *action;
536 /* First run through all the currently active filters and see if any of
537 * them have claimed this event. */
538 darray_foreach(filter, state->filters) {
541 send &= filter->func(state, filter, key, direction);
544 if (!send || direction == XKB_KEY_UP)
547 action = xkb_key_get_action(state, key);
550 * It's possible for the keymap to set action->type explicitly, like so:
551 * interpret XF86_Next_VMode {
552 * action = Private(type=0x86, data="+VMode");
554 * We don't handle those.
556 if (action->type >= _ACTION_TYPE_NUM_ENTRIES)
559 if (!filter_action_funcs[action->type].new)
562 filter = xkb_filter_new(state);
567 filter->func = filter_action_funcs[action->type].func;
568 filter->action = *action;
569 filter_action_funcs[action->type].new(state, filter);
572 XKB_EXPORT struct xkb_state *
573 xkb_state_new(struct xkb_keymap *keymap)
575 struct xkb_state *ret;
577 ret = calloc(sizeof(*ret), 1);
582 ret->keymap = xkb_keymap_ref(keymap);
587 XKB_EXPORT struct xkb_state *
588 xkb_state_ref(struct xkb_state *state)
595 xkb_state_unref(struct xkb_state *state)
597 if (!state || --state->refcnt > 0)
600 xkb_keymap_unref(state->keymap);
601 darray_free(state->filters);
605 XKB_EXPORT struct xkb_keymap *
606 xkb_state_get_keymap(struct xkb_state *state)
608 return state->keymap;
612 * Update the LED state to match the rest of the xkb_state.
615 xkb_state_led_update_all(struct xkb_state *state)
618 const struct xkb_led *led;
620 state->components.leds = 0;
622 darray_enumerate(idx, led, state->keymap->leds) {
623 xkb_mod_mask_t mod_mask = 0;
624 xkb_layout_mask_t group_mask = 0;
626 if (led->which_mods & XKB_STATE_MODS_EFFECTIVE)
627 mod_mask |= state->components.mods;
628 if (led->which_mods & XKB_STATE_MODS_DEPRESSED)
629 mod_mask |= state->components.base_mods;
630 if (led->which_mods & XKB_STATE_MODS_LATCHED)
631 mod_mask |= state->components.latched_mods;
632 if (led->which_mods & XKB_STATE_MODS_LOCKED)
633 mod_mask |= state->components.locked_mods;
634 if (led->mods.mask & mod_mask)
635 state->components.leds |= (1 << idx);
637 if (led->which_groups & XKB_STATE_LAYOUT_EFFECTIVE)
638 group_mask |= (1 << state->components.group);
639 if (led->which_groups & XKB_STATE_LAYOUT_DEPRESSED)
640 group_mask |= (1 << state->components.base_group);
641 if (led->which_groups & XKB_STATE_LAYOUT_LATCHED)
642 group_mask |= (1 << state->components.latched_group);
643 if (led->which_groups & XKB_STATE_LAYOUT_LOCKED)
644 group_mask |= (1 << state->components.locked_group);
645 if (led->groups & group_mask)
646 state->components.leds |= (1 << idx);
648 if (led->ctrls & state->keymap->enabled_ctrls)
649 state->components.leds |= (1 << idx);
654 * Calculates the derived state (effective mods/group and LEDs) from an
655 * up-to-date xkb_state.
658 xkb_state_update_derived(struct xkb_state *state)
660 state->components.mods = (state->components.base_mods |
661 state->components.latched_mods |
662 state->components.locked_mods);
664 /* TODO: Use groups_wrap control instead of always RANGE_WRAP. */
666 state->components.locked_group =
667 wrap_group_into_range(state->components.locked_group,
668 state->keymap->num_groups,
671 state->components.group =
672 wrap_group_into_range(state->components.base_group +
673 state->components.latched_group +
674 state->components.locked_group,
675 state->keymap->num_groups,
678 xkb_state_led_update_all(state);
681 static enum xkb_state_component
682 get_state_component_changes(const struct state_components *a,
683 const struct state_components *b)
685 xkb_mod_mask_t mask = 0;
687 if (a->group != b->group)
688 mask |= XKB_STATE_LAYOUT_EFFECTIVE;
689 if (a->base_group != b->base_group)
690 mask |= XKB_STATE_LAYOUT_DEPRESSED;
691 if (a->latched_group != b->latched_group)
692 mask |= XKB_STATE_LAYOUT_LATCHED;
693 if (a->locked_group != b->locked_group)
694 mask |= XKB_STATE_LAYOUT_LOCKED;
695 if (a->mods != b->mods)
696 mask |= XKB_STATE_MODS_EFFECTIVE;
697 if (a->base_mods != b->base_mods)
698 mask |= XKB_STATE_MODS_DEPRESSED;
699 if (a->latched_mods != b->latched_mods)
700 mask |= XKB_STATE_MODS_LATCHED;
701 if (a->locked_mods != b->locked_mods)
702 mask |= XKB_STATE_MODS_LOCKED;
703 if (a->leds != b->leds)
704 mask |= XKB_STATE_LEDS;
710 * Given a particular key event, updates the state structure to reflect the
713 XKB_EXPORT enum xkb_state_component
714 xkb_state_update_key(struct xkb_state *state, xkb_keycode_t kc,
715 enum xkb_key_direction direction)
719 struct state_components prev_components;
720 const struct xkb_key *key = XkbKey(state->keymap, kc);
725 prev_components = state->components;
728 state->clear_mods = 0;
730 xkb_filter_apply_all(state, key, direction);
732 for (i = 0, bit = 1; state->set_mods; i++, bit <<= 1) {
733 if (state->set_mods & bit) {
734 state->mod_key_count[i]++;
735 state->components.base_mods |= bit;
736 state->set_mods &= ~bit;
740 for (i = 0, bit = 1; state->clear_mods; i++, bit <<= 1) {
741 if (state->clear_mods & bit) {
742 state->mod_key_count[i]--;
743 if (state->mod_key_count[i] <= 0) {
744 state->components.base_mods &= ~bit;
745 state->mod_key_count[i] = 0;
747 state->clear_mods &= ~bit;
751 xkb_state_update_derived(state);
753 return get_state_component_changes(&prev_components, &state->components);
757 * Updates the state from a set of explicit masks as gained from
758 * xkb_state_serialize_mods and xkb_state_serialize_groups. As noted in the
759 * documentation for these functions in xkbcommon.h, this round-trip is
760 * lossy, and should only be used to update a slave state mirroring the
761 * master, e.g. in a client/server window system.
763 XKB_EXPORT enum xkb_state_component
764 xkb_state_update_mask(struct xkb_state *state,
765 xkb_mod_mask_t base_mods,
766 xkb_mod_mask_t latched_mods,
767 xkb_mod_mask_t locked_mods,
768 xkb_layout_index_t base_group,
769 xkb_layout_index_t latched_group,
770 xkb_layout_index_t locked_group)
772 struct state_components prev_components;
773 xkb_mod_index_t num_mods;
776 prev_components = state->components;
778 state->components.base_mods = 0;
779 state->components.latched_mods = 0;
780 state->components.locked_mods = 0;
781 num_mods = xkb_keymap_num_mods(state->keymap);
783 for (idx = 0; idx < num_mods; idx++) {
784 xkb_mod_mask_t mod = (1 << idx);
786 state->components.base_mods |= mod;
787 if (latched_mods & mod)
788 state->components.latched_mods |= mod;
789 if (locked_mods & mod)
790 state->components.locked_mods |= mod;
793 state->components.base_group = base_group;
794 state->components.latched_group = latched_group;
795 state->components.locked_group = locked_group;
797 xkb_state_update_derived(state);
799 return get_state_component_changes(&prev_components, &state->components);
803 * Provides the symbols to use for the given key and state. Returns the
804 * number of symbols pointed to in syms_out.
807 xkb_state_key_get_syms(struct xkb_state *state, xkb_keycode_t kc,
808 const xkb_keysym_t **syms_out)
810 xkb_layout_index_t layout;
811 xkb_level_index_t level;
813 layout = xkb_state_key_get_layout(state, kc);
814 if (layout == XKB_LAYOUT_INVALID)
817 level = xkb_state_key_get_level(state, kc, layout);
818 if (level == XKB_LEVEL_INVALID)
821 return xkb_keymap_key_get_syms_by_level(state->keymap, kc, layout, level,
830 * Provides either exactly one symbol, or XKB_KEY_NoSymbol.
832 XKB_EXPORT xkb_keysym_t
833 xkb_state_key_get_one_sym(struct xkb_state *state, xkb_keycode_t kc)
835 const xkb_keysym_t *syms;
838 num_syms = xkb_state_key_get_syms(state, kc, &syms);
840 return XKB_KEY_NoSymbol;
846 * Serialises the requested modifier state into an xkb_mod_mask_t, with all
847 * the same disclaimers as in xkb_state_update_mask.
849 XKB_EXPORT xkb_mod_mask_t
850 xkb_state_serialize_mods(struct xkb_state *state,
851 enum xkb_state_component type)
853 xkb_mod_mask_t ret = 0;
855 if (type & XKB_STATE_MODS_EFFECTIVE)
856 return state->components.mods;
858 if (type & XKB_STATE_MODS_DEPRESSED)
859 ret |= state->components.base_mods;
860 if (type & XKB_STATE_MODS_LATCHED)
861 ret |= state->components.latched_mods;
862 if (type & XKB_STATE_MODS_LOCKED)
863 ret |= state->components.locked_mods;
869 * Serialises the requested group state, with all the same disclaimers as
870 * in xkb_state_update_mask.
872 XKB_EXPORT xkb_layout_index_t
873 xkb_state_serialize_layout(struct xkb_state *state,
874 enum xkb_state_component type)
876 xkb_layout_index_t ret = 0;
878 if (type & XKB_STATE_LAYOUT_EFFECTIVE)
879 return state->components.group;
881 if (type & XKB_STATE_LAYOUT_DEPRESSED)
882 ret += state->components.base_group;
883 if (type & XKB_STATE_LAYOUT_LATCHED)
884 ret += state->components.latched_group;
885 if (type & XKB_STATE_LAYOUT_LOCKED)
886 ret += state->components.locked_group;
892 * Returns 1 if the given modifier is active with the specified type(s), 0 if
893 * not, or -1 if the modifier is invalid.
896 xkb_state_mod_index_is_active(struct xkb_state *state,
898 enum xkb_state_component type)
900 if (idx >= xkb_keymap_num_mods(state->keymap))
903 return !!(xkb_state_serialize_mods(state, type) & (1 << idx));
907 * Helper function for xkb_state_mod_indices_are_active and
908 * xkb_state_mod_names_are_active.
911 match_mod_masks(struct xkb_state *state,
912 enum xkb_state_component type,
913 enum xkb_state_match match,
914 xkb_mod_mask_t wanted)
916 xkb_mod_mask_t active = xkb_state_serialize_mods(state, type);
918 if (!(match & XKB_STATE_MATCH_NON_EXCLUSIVE) && (active & ~wanted))
921 if (match & XKB_STATE_MATCH_ANY)
922 return !!(active & wanted);
924 return (active & wanted) == wanted;
930 * Returns 1 if the modifiers are active with the specified type(s), 0 if
931 * not, or -1 if any of the modifiers are invalid.
934 xkb_state_mod_indices_are_active(struct xkb_state *state,
935 enum xkb_state_component type,
936 enum xkb_state_match match,
940 xkb_mod_index_t idx = 0;
941 xkb_mod_mask_t wanted = 0;
943 xkb_mod_index_t num_mods = xkb_keymap_num_mods(state->keymap);
947 idx = va_arg(ap, xkb_mod_index_t);
948 if (idx == XKB_MOD_INVALID)
950 if (idx >= num_mods) {
954 wanted |= (1 << idx);
961 return match_mod_masks(state, type, match, wanted);
965 * Returns 1 if the given modifier is active with the specified type(s), 0 if
966 * not, or -1 if the modifier is invalid.
969 xkb_state_mod_name_is_active(struct xkb_state *state, const char *name,
970 enum xkb_state_component type)
972 xkb_mod_index_t idx = xkb_keymap_mod_get_index(state->keymap, name);
974 if (idx == XKB_MOD_INVALID)
977 return xkb_state_mod_index_is_active(state, idx, type);
981 * Returns 1 if the modifiers are active with the specified type(s), 0 if
982 * not, or -1 if any of the modifiers are invalid.
984 XKB_EXPORT ATTR_NULL_SENTINEL int
985 xkb_state_mod_names_are_active(struct xkb_state *state,
986 enum xkb_state_component type,
987 enum xkb_state_match match,
991 xkb_mod_index_t idx = 0;
993 xkb_mod_mask_t wanted = 0;
998 str = va_arg(ap, const char *);
1001 idx = xkb_keymap_mod_get_index(state->keymap, str);
1002 if (idx == XKB_MOD_INVALID) {
1006 wanted |= (1 << idx);
1013 return match_mod_masks(state, type, match, wanted);
1017 * Returns 1 if the given group is active with the specified type(s), 0 if
1018 * not, or -1 if the group is invalid.
1021 xkb_state_layout_index_is_active(struct xkb_state *state,
1022 xkb_layout_index_t idx,
1023 enum xkb_state_component type)
1027 if (idx >= state->keymap->num_groups)
1030 if (type & XKB_STATE_LAYOUT_EFFECTIVE)
1031 ret |= (state->components.group == idx);
1032 if (type & XKB_STATE_LAYOUT_DEPRESSED)
1033 ret |= (state->components.base_group == idx);
1034 if (type & XKB_STATE_LAYOUT_LATCHED)
1035 ret |= (state->components.latched_group == idx);
1036 if (type & XKB_STATE_LAYOUT_LOCKED)
1037 ret |= (state->components.locked_group == idx);
1043 * Returns 1 if the given modifier is active with the specified type(s), 0 if
1044 * not, or -1 if the modifier is invalid.
1047 xkb_state_layout_name_is_active(struct xkb_state *state, const char *name,
1048 enum xkb_state_component type)
1050 xkb_layout_index_t idx = xkb_keymap_layout_get_index(state->keymap, name);
1052 if (idx == XKB_LAYOUT_INVALID)
1055 return xkb_state_layout_index_is_active(state, idx, type);
1059 * Returns 1 if the given LED is active, 0 if not, or -1 if the LED is invalid.
1062 xkb_state_led_index_is_active(struct xkb_state *state, xkb_led_index_t idx)
1064 if (idx >= darray_size(state->keymap->leds) ||
1065 darray_item(state->keymap->leds, idx).name == XKB_ATOM_NONE)
1068 return !!(state->components.leds & (1 << idx));
1072 * Returns 1 if the given LED is active, 0 if not, or -1 if the LED is invalid.
1075 xkb_state_led_name_is_active(struct xkb_state *state, const char *name)
1077 xkb_led_index_t idx = xkb_keymap_led_get_index(state->keymap, name);
1079 if (idx == XKB_LED_INVALID)
1082 return xkb_state_led_index_is_active(state, idx);
1085 static xkb_mod_mask_t
1086 key_get_consumed(struct xkb_state *state, const struct xkb_key *key)
1088 const struct xkb_key_type_entry *entry;
1089 xkb_layout_index_t group;
1091 group = xkb_state_key_get_layout(state, key->keycode);
1092 if (group == XKB_LAYOUT_INVALID)
1095 entry = get_entry_for_key_state(state, key, group);
1099 return entry->mods.mask & ~entry->preserve.mask;
1103 * Tests to see if a modifier is used up by our translation of a
1104 * keycode to keysyms, taking note of the current modifier state and
1105 * the appropriate key type's preserve information, if any. This allows
1106 * the user to mask out the modifier in later processing of the
1107 * modifiers, e.g. when implementing hot keys or accelerators.
1109 * See also, for example:
1110 * - XkbTranslateKeyCode(3), mod_rtrn return value, from libX11.
1111 * - gdk_keymap_translate_keyboard_state, consumed_modifiers return value,
1115 xkb_state_mod_index_is_consumed(struct xkb_state *state, xkb_keycode_t kc,
1116 xkb_mod_index_t idx)
1118 const struct xkb_key *key = XkbKey(state->keymap, kc);
1120 if (!key || idx >= xkb_keymap_num_mods(state->keymap))
1123 return !!((1 << idx) & key_get_consumed(state, key));
1127 * Calculates which modifiers should be consumed during key processing,
1128 * and returns the mask with all these modifiers removed. e.g. if
1129 * given a state of Alt and Shift active for a two-level alphabetic
1130 * key containing plus and equal on the first and second level
1131 * respectively, will return a mask of only Alt, as Shift has been
1132 * consumed by the type handling.
1134 XKB_EXPORT xkb_mod_mask_t
1135 xkb_state_mod_mask_remove_consumed(struct xkb_state *state, xkb_keycode_t kc,
1136 xkb_mod_mask_t mask)
1138 const struct xkb_key *key = XkbKey(state->keymap, kc);
1143 return mask & ~key_get_consumed(state, key);