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
30 * Permission is hereby granted, free of charge, to any person obtaining a
31 * copy of this software and associated documentation files (the "Software"),
32 * to deal in the Software without restriction, including without limitation
33 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
34 * and/or sell copies of the Software, and to permit persons to whom the
35 * Software is furnished to do so, subject to the following conditions:
37 * The above copyright notice and this permission notice (including the next
38 * paragraph) shall be included in all copies or substantial portions of the
41 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
42 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
43 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
44 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
45 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
46 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
47 * DEALINGS IN THE SOFTWARE.
49 * Author: Daniel Stone <daniel@fooishbar.org>
53 * This is a bastardised version of xkbActions.c from the X server which
54 * does not support, for the moment:
55 * - AccessX sticky/debounce/etc (will come later)
56 * - pointer keys (may come later)
57 * - key redirects (unlikely)
58 * - messages (very unlikely)
67 struct xkb_state *state;
68 union xkb_action action;
71 int (*func)(struct xkb_filter *filter, xkb_keycode_t kc,
72 enum xkb_key_direction direction);
74 struct xkb_filter *next;
78 xkb_group_index_t base_group; /**< depressed */
79 xkb_group_index_t latched_group;
80 xkb_group_index_t locked_group;
81 xkb_group_index_t group; /**< effective */
83 xkb_mod_mask_t base_mods; /**< depressed */
84 xkb_mod_mask_t latched_mods;
85 xkb_mod_mask_t locked_mods;
86 xkb_mod_mask_t mods; /**< effective */
89 * At each event, we accumulate all the needed modifications to the base
90 * modifiers, and apply them at the end. These keep track of this state.
92 xkb_mod_mask_t set_mods;
93 xkb_mod_mask_t clear_mods;
95 * We mustn't clear a base modifier if there's another depressed key
96 * which affects it, e.g. given this sequence
97 * < Left Shift down, Right Shift down, Left Shift Up >
98 * the modifier should still be set. This keeps the count.
100 int16_t mod_key_count[sizeof(xkb_mod_mask_t) * 8];
105 darray(struct xkb_filter) filters;
106 struct xkb_keymap *keymap;
109 static const union xkb_action fake = { .type = XkbSA_NoAction };
111 static const union xkb_action *
112 xkb_key_get_action(struct xkb_state *state, xkb_keycode_t kc)
114 xkb_group_index_t group;
115 xkb_level_index_t level;
118 key = XkbKey(state->keymap, kc);
123 group = xkb_key_get_group(state, kc);
124 if (group == XKB_GROUP_INVALID)
127 level = xkb_key_get_level(state, kc, group);
128 if (level == XKB_LEVEL_INVALID)
131 return XkbKeyActionEntry(key, group, level);
134 static struct xkb_filter *
135 xkb_filter_new(struct xkb_state *state)
137 int old_size = darray_size(state->filters);
138 struct xkb_filter *filter = NULL, *iter;
140 darray_foreach(iter, state->filters) {
148 darray_resize0(state->filters, darray_size(state->filters) + 1);
149 filter = &darray_item(state->filters, old_size);
152 filter->state = state;
157 /***====================================================================***/
160 xkb_filter_group_set_func(struct xkb_filter *filter, xkb_keycode_t kc,
161 enum xkb_key_direction direction)
163 if (kc != filter->kc) {
164 filter->action.group.flags &= ~XkbSA_ClearLocks;
168 if (direction == XKB_KEY_DOWN) {
172 else if (--filter->refcnt > 0) {
176 if (filter->action.group.flags & XkbSA_GroupAbsolute)
177 filter->state->base_group = filter->action.group.group;
179 filter->state->base_group = -filter->action.group.group;
180 if (filter->action.group.flags & XkbSA_ClearLocks)
181 filter->state->locked_group = 0;
189 xkb_filter_group_set_new(struct xkb_state *state, xkb_keycode_t kc,
190 const union xkb_action *action)
192 struct xkb_filter *filter = xkb_filter_new(state);
194 if (!filter) /* WSGO */
197 filter->func = xkb_filter_group_set_func;
198 filter->action = *action;
200 if (action->group.flags & XkbSA_GroupAbsolute) {
201 filter->action.group.group = filter->state->base_group;
202 filter->state->base_group = action->group.group;
205 filter->state->base_group += action->group.group;
212 xkb_filter_group_lock_func(struct xkb_filter *filter, xkb_keycode_t kc,
213 enum xkb_key_direction direction)
215 if (kc != filter->kc)
218 if (direction == XKB_KEY_DOWN) {
222 if (--filter->refcnt > 0)
230 xkb_filter_group_lock_new(struct xkb_state *state, xkb_keycode_t kc,
231 const union xkb_action *action)
233 struct xkb_filter *filter = xkb_filter_new(state);
239 filter->func = xkb_filter_group_lock_func;
240 filter->action = *action;
242 if (action->group.flags & XkbSA_GroupAbsolute)
243 filter->state->locked_group = action->group.group;
245 filter->state->locked_group += action->group.group;
251 xkb_filter_mod_set_func(struct xkb_filter *filter, xkb_keycode_t kc,
252 enum xkb_key_direction direction)
254 if (kc != filter->kc) {
255 filter->action.mods.flags &= ~XkbSA_ClearLocks;
259 if (direction == XKB_KEY_DOWN) {
263 else if (--filter->refcnt > 0) {
267 filter->state->clear_mods = filter->action.mods.mods.mask;
268 if (filter->action.mods.flags & XkbSA_ClearLocks)
269 filter->state->locked_mods &= ~filter->action.mods.mods.mask;
277 xkb_filter_mod_set_new(struct xkb_state *state, xkb_keycode_t kc,
278 const union xkb_action *action)
280 struct xkb_filter *filter = xkb_filter_new(state);
282 if (!filter) /* WSGO */
285 filter->func = xkb_filter_mod_set_func;
286 filter->action = *action;
288 filter->state->set_mods = action->mods.mods.mask;
294 xkb_filter_mod_lock_func(struct xkb_filter *filter, xkb_keycode_t kc,
295 enum xkb_key_direction direction)
297 if (kc != filter->kc)
300 if (direction == XKB_KEY_DOWN) {
304 if (--filter->refcnt > 0)
307 filter->state->locked_mods &= ~filter->priv;
313 xkb_filter_mod_lock_new(struct xkb_state *state, xkb_keycode_t kc,
314 const union xkb_action *action)
316 struct xkb_filter *filter = xkb_filter_new(state);
318 if (!filter) /* WSGO */
322 filter->func = xkb_filter_mod_lock_func;
323 filter->action = *action;
324 filter->priv = state->locked_mods & action->mods.mods.mask;
325 state->locked_mods |= action->mods.mods.mask;
330 enum xkb_key_latch_state {
337 xkb_filter_mod_latch_func(struct xkb_filter *filter, xkb_keycode_t kc,
338 enum xkb_key_direction direction)
340 enum xkb_key_latch_state latch = filter->priv;
342 if (direction == XKB_KEY_DOWN && latch == LATCH_PENDING) {
343 /* If this is a new keypress and we're awaiting our single latched
344 * keypress, then either break the latch if any random key is pressed,
345 * or promote it to a lock or plain base set if it's the same
347 const union xkb_action *action = xkb_key_get_action(filter->state, kc);
348 if (action->type == XkbSA_LatchMods &&
349 action->mods.flags == filter->action.mods.flags &&
350 action->mods.mods.mask == filter->action.mods.mods.mask) {
351 filter->action = *action;
352 if (filter->action.mods.flags & XkbSA_LatchToLock) {
353 filter->action.type = XkbSA_LockMods;
354 filter->func = xkb_filter_mod_lock_func;
355 filter->state->locked_mods |= filter->action.mods.mods.mask;
358 filter->action.type = XkbSA_SetMods;
359 filter->func = xkb_filter_mod_set_func;
360 filter->state->set_mods = filter->action.mods.mods.mask;
363 filter->state->latched_mods &= ~filter->action.mods.mods.mask;
367 else if (((1 << action->type) & XkbSA_BreakLatch)) {
368 /* XXX: This may be totally broken, we might need to break the
369 * latch in the next run after this press? */
370 filter->state->latched_mods &= ~filter->action.mods.mods.mask;
375 else if (direction == XKB_KEY_UP && kc == filter->kc) {
376 /* Our key got released. If we've set it to clear locks, and we
377 * currently have the same modifiers locked, then release them and
378 * don't actually latch. Else we've actually hit the latching
379 * stage, so set PENDING and move our modifier from base to
381 if (latch == NO_LATCH ||
382 ((filter->action.mods.flags & XkbSA_ClearLocks) &&
383 (filter->state->locked_mods & filter->action.mods.mods.mask) ==
384 filter->action.mods.mods.mask)) {
385 /* XXX: We might be a bit overenthusiastic about clearing
386 * mods other filters have set here? */
387 if (latch == LATCH_PENDING)
388 filter->state->latched_mods &= ~filter->action.mods.mods.mask;
390 filter->state->clear_mods = filter->action.mods.mods.mask;
391 filter->state->locked_mods &= ~filter->action.mods.mods.mask;
395 latch = LATCH_PENDING;
396 filter->state->clear_mods = filter->action.mods.mods.mask;
397 filter->state->latched_mods |= filter->action.mods.mods.mask;
401 else if (direction == XKB_KEY_DOWN && latch == LATCH_KEY_DOWN) {
402 /* Someone's pressed another key while we've still got the latching
403 * key held down, so keep the base modifier state active (from
404 * xkb_filter_mod_latch_new), but don't trip the latch, just clear
405 * it as soon as the modifier gets released. */
409 filter->priv = latch;
415 xkb_filter_mod_latch_new(struct xkb_state *state, xkb_keycode_t kc,
416 const union xkb_action *action)
418 struct xkb_filter *filter = xkb_filter_new(state);
419 enum xkb_key_latch_state latch = LATCH_KEY_DOWN;
421 if (!filter) /* WSGO */
424 filter->priv = latch;
425 filter->func = xkb_filter_mod_latch_func;
426 filter->action = *action;
428 filter->state->set_mods = action->mods.mods.mask;
434 * Applies any relevant filters to the key, first from the list of filters
435 * that are currently active, then if no filter has claimed the key, possibly
436 * apply a new filter from the key action.
439 xkb_filter_apply_all(struct xkb_state *state, xkb_keycode_t kc,
440 enum xkb_key_direction direction)
442 struct xkb_filter *filter;
443 const union xkb_action *act = NULL;
446 /* First run through all the currently active filters and see if any of
447 * them have claimed this event. */
448 darray_foreach(filter, state->filters) {
451 send &= filter->func(filter, kc, direction);
454 if (!send || direction == XKB_KEY_UP)
457 act = xkb_key_get_action(state, kc);
460 send = xkb_filter_mod_set_new(state, kc, act);
462 case XkbSA_LatchMods:
463 send = xkb_filter_mod_latch_new(state, kc, act);
466 send = xkb_filter_mod_lock_new(state, kc, act);
469 send = xkb_filter_group_set_new(state, kc, act);
472 case XkbSA_LatchGroup:
473 send = xkb_filter_mod_latch_new(state, key, act);
476 case XkbSA_LockGroup:
477 send = xkb_filter_group_lock_new(state, kc, act);
484 XKB_EXPORT struct xkb_state *
485 xkb_state_new(struct xkb_keymap *keymap)
487 struct xkb_state *ret;
489 ret = calloc(sizeof(*ret), 1);
494 ret->keymap = xkb_map_ref(keymap);
499 XKB_EXPORT struct xkb_state *
500 xkb_state_ref(struct xkb_state *state)
507 xkb_state_unref(struct xkb_state *state)
509 if (--state->refcnt > 0)
512 xkb_map_unref(state->keymap);
513 darray_free(state->filters);
517 XKB_EXPORT struct xkb_keymap *
518 xkb_state_get_map(struct xkb_state *state)
520 return state->keymap;
524 * Update the LED state to match the rest of the xkb_state.
527 xkb_state_led_update_all(struct xkb_state *state)
533 for (led = 0; led < XKB_NUM_INDICATORS; led++) {
534 struct xkb_indicator_map *map = &state->keymap->indicators[led];
535 xkb_mod_mask_t mod_mask = 0;
536 uint32_t group_mask = 0;
538 if (map->which_mods & XkbIM_UseAnyMods) {
539 if (map->which_mods & XkbIM_UseBase)
540 mod_mask |= state->base_mods;
541 if (map->which_mods & XkbIM_UseLatched)
542 mod_mask |= state->latched_mods;
543 if (map->which_mods & XkbIM_UseLocked)
544 mod_mask |= state->locked_mods;
545 if (map->which_mods & XkbIM_UseEffective)
546 mod_mask |= state->mods;
547 if ((map->mods.mask & mod_mask))
548 state->leds |= (1 << led);
550 if (map->which_groups & XkbIM_UseAnyGroup) {
551 if (map->which_groups & XkbIM_UseBase)
552 group_mask |= (1 << state->base_group);
553 if (map->which_groups & XkbIM_UseLatched)
554 group_mask |= (1 << state->latched_group);
555 if (map->which_groups & XkbIM_UseLocked)
556 group_mask |= (1 << state->locked_group);
557 if (map->which_groups & XkbIM_UseEffective)
558 group_mask |= (1 << state->group);
559 if ((map->groups & group_mask))
560 state->leds |= (1 << led);
563 if ((map->ctrls & state->keymap->enabled_ctrls))
564 state->leds |= (1 << led);
570 * Calculates the derived state (effective mods/group and LEDs) from an
571 * up-to-date xkb_state.
574 xkb_state_update_derived(struct xkb_state *state)
577 (state->base_mods | state->latched_mods | state->locked_mods);
578 /* FIXME: Clamp/wrap locked_group */
579 state->group = state->locked_group + state->base_group +
580 state->latched_group;
581 /* FIXME: Clamp/wrap effective group */
583 xkb_state_led_update_all(state);
587 * Given a particular key event, updates the state structure to reflect the
591 xkb_state_update_key(struct xkb_state *state, xkb_keycode_t kc,
592 enum xkb_key_direction direction)
597 if (!XkbKeycodeInRange(state->keymap, kc))
601 state->clear_mods = 0;
603 xkb_filter_apply_all(state, kc, direction);
605 for (i = 0, bit = 1; state->set_mods; i++, bit <<= 1) {
606 if (state->set_mods & bit) {
607 state->mod_key_count[i]++;
608 state->base_mods |= bit;
609 state->set_mods &= ~bit;
613 for (i = 0, bit = 1; state->clear_mods; i++, bit <<= 1) {
614 if (state->clear_mods & bit) {
615 state->mod_key_count[i]--;
616 if (state->mod_key_count[i] <= 0) {
617 state->base_mods &= ~bit;
618 state->mod_key_count[i] = 0;
620 state->clear_mods &= ~bit;
624 xkb_state_update_derived(state);
628 * Updates the state from a set of explicit masks as gained from
629 * xkb_state_serialize_mods and xkb_state_serialize_groups. As noted in the
630 * documentation for these functions in xkbcommon.h, this round-trip is
631 * lossy, and should only be used to update a slave state mirroring the
632 * master, e.g. in a client/server window system.
635 xkb_state_update_mask(struct xkb_state *state,
636 xkb_mod_mask_t base_mods,
637 xkb_mod_mask_t latched_mods,
638 xkb_mod_mask_t locked_mods,
639 xkb_group_index_t base_group,
640 xkb_group_index_t latched_group,
641 xkb_group_index_t locked_group)
643 xkb_mod_index_t num_mods;
646 state->base_mods = 0;
647 state->latched_mods = 0;
648 state->locked_mods = 0;
649 num_mods = xkb_map_num_mods(state->keymap);
651 for (idx = 0; idx < num_mods; idx++) {
652 xkb_mod_mask_t mod = (1 << idx);
654 state->base_mods |= mod;
655 if (latched_mods & mod)
656 state->latched_mods |= mod;
657 if (locked_mods & mod)
658 state->locked_mods |= mod;
661 state->base_group = base_group;
662 state->latched_group = latched_group;
663 state->locked_group = locked_group;
665 xkb_state_update_derived(state);
669 * Serialises the requested modifier state into an xkb_mod_mask_t, with all
670 * the same disclaimers as in xkb_state_update_mask.
672 XKB_EXPORT xkb_mod_mask_t
673 xkb_state_serialize_mods(struct xkb_state *state,
674 enum xkb_state_component type)
676 xkb_mod_mask_t ret = 0;
678 if (type == XKB_STATE_EFFECTIVE)
681 if (type & XKB_STATE_DEPRESSED)
682 ret |= state->base_mods;
683 if (type & XKB_STATE_LATCHED)
684 ret |= state->latched_mods;
685 if (type & XKB_STATE_LOCKED)
686 ret |= state->locked_mods;
692 * Serialises the requested group state, with all the same disclaimers as
693 * in xkb_state_update_mask.
695 XKB_EXPORT xkb_group_index_t
696 xkb_state_serialize_group(struct xkb_state *state,
697 enum xkb_state_component type)
699 xkb_group_index_t ret = 0;
701 if (type == XKB_STATE_EFFECTIVE)
704 if (type & XKB_STATE_DEPRESSED)
705 ret += state->base_group;
706 if (type & XKB_STATE_LATCHED)
707 ret += state->latched_group;
708 if (type & XKB_STATE_LOCKED)
709 ret += state->locked_group;
715 * Returns 1 if the given modifier is active with the specified type(s), 0 if
716 * not, or -1 if the modifier is invalid.
719 xkb_state_mod_index_is_active(struct xkb_state *state,
721 enum xkb_state_component type)
725 if (idx >= xkb_map_num_mods(state->keymap))
728 if (type & XKB_STATE_DEPRESSED)
729 ret |= (state->base_mods & (1 << idx));
730 if (type & XKB_STATE_LATCHED)
731 ret |= (state->latched_mods & (1 << idx));
732 if (type & XKB_STATE_LOCKED)
733 ret |= (state->locked_mods & (1 << idx));
739 * Helper function for xkb_state_mod_indices_are_active and
740 * xkb_state_mod_names_are_active.
743 match_mod_masks(struct xkb_state *state, enum xkb_state_match match,
746 uint32_t active = xkb_state_serialize_mods(state, XKB_STATE_EFFECTIVE);
748 if (!(match & XKB_STATE_MATCH_NON_EXCLUSIVE) && (active & ~wanted))
751 if (match & XKB_STATE_MATCH_ANY)
752 return !!(active & wanted);
754 return (active & wanted) == wanted;
760 * Returns 1 if the modifiers are active with the specified type(s), 0 if
761 * not, or -1 if any of the modifiers are invalid.
764 xkb_state_mod_indices_are_active(struct xkb_state *state,
765 enum xkb_state_component type,
766 enum xkb_state_match match,
770 xkb_mod_index_t idx = 0;
773 xkb_mod_index_t num_mods = xkb_map_num_mods(state->keymap);
777 idx = va_arg(ap, xkb_mod_index_t);
778 if (idx == XKB_MOD_INVALID)
780 if (idx >= num_mods) {
784 wanted |= (1 << idx);
791 return match_mod_masks(state, match, wanted);
795 * Returns 1 if the given modifier is active with the specified type(s), 0 if
796 * not, or -1 if the modifier is invalid.
799 xkb_state_mod_name_is_active(struct xkb_state *state, const char *name,
800 enum xkb_state_component type)
802 xkb_mod_index_t idx = xkb_map_mod_get_index(state->keymap, name);
804 if (idx == XKB_MOD_INVALID)
807 return xkb_state_mod_index_is_active(state, idx, type);
811 * Returns 1 if the modifiers are active with the specified type(s), 0 if
812 * not, or -1 if any of the modifiers are invalid.
814 XKB_EXPORT ATTR_NULL_SENTINEL int
815 xkb_state_mod_names_are_active(struct xkb_state *state,
816 enum xkb_state_component type,
817 enum xkb_state_match match,
821 xkb_mod_index_t idx = 0;
828 str = va_arg(ap, const char *);
831 idx = xkb_map_mod_get_index(state->keymap, str);
832 if (idx == XKB_MOD_INVALID) {
836 wanted |= (1 << idx);
843 return match_mod_masks(state, match, wanted);
847 * Returns 1 if the given group is active with the specified type(s), 0 if
848 * not, or -1 if the group is invalid.
851 xkb_state_group_index_is_active(struct xkb_state *state,
852 xkb_group_index_t idx,
853 enum xkb_state_component type)
857 if (idx >= xkb_map_num_groups(state->keymap))
860 if (type & XKB_STATE_DEPRESSED)
861 ret |= (state->base_group == idx);
862 if (type & XKB_STATE_LATCHED)
863 ret |= (state->latched_group == idx);
864 if (type & XKB_STATE_LOCKED)
865 ret |= (state->locked_group == idx);
871 * Returns 1 if the given modifier is active with the specified type(s), 0 if
872 * not, or -1 if the modifier is invalid.
875 xkb_state_group_name_is_active(struct xkb_state *state, const char *name,
876 enum xkb_state_component type)
878 xkb_group_index_t idx = xkb_map_group_get_index(state->keymap, name);
880 if (idx == XKB_GROUP_INVALID)
883 return xkb_state_group_index_is_active(state, idx, type);
887 * Returns 1 if the given LED is active, 0 if not, or -1 if the LED is invalid.
890 xkb_state_led_index_is_active(struct xkb_state *state, xkb_led_index_t idx)
892 if (idx >= xkb_map_num_leds(state->keymap))
895 return !!(state->leds & (1 << idx));
899 * Returns 1 if the given LED is active, 0 if not, or -1 if the LED is invalid.
902 xkb_state_led_name_is_active(struct xkb_state *state, const char *name)
904 xkb_led_index_t idx = xkb_map_led_get_index(state->keymap, name);
906 if (idx == XKB_LED_INVALID)
909 return xkb_state_led_index_is_active(state, idx);