src/state.c

   1 /************************************************************
   2  * Copyright (c) 1993 by Silicon Graphics Computer Systems, Inc.
   3  *
   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.
  15  *
  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.
  24  *
  25  ********************************************************/
  26
  27 /*
  28  * Copyright © 2012 Intel Corporation
  29  * Copyright © 2012 Ran Benita <ran234@gmail.com>
  30  *
  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:
  37  *
  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
  40  * Software.
  41  *
  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.
  49  *
  50  * Author: Daniel Stone <daniel@fooishbar.org>
  51  */
  52
  53 /*
  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)
  60  */
  61
  62 #include "keymap.h"
  63 #include "keysym.h"
  64
  65 struct xkb_filter {
  66     union xkb_action action;
  67     const struct xkb_key *key;
  68     uint32_t priv;
  69     bool (*func)(struct xkb_state *state,
  70                  struct xkb_filter *filter,
  71                  const struct xkb_key *key,
  72                  enum xkb_key_direction direction);
  73     int refcnt;
  74 };
  75
  76 struct state_components {
  77     /* These may be negative, because of -1 group actions. */
  78     int32_t base_group; /**< depressed */
  79     int32_t latched_group;
  80     int32_t locked_group;
  81     xkb_layout_index_t group; /**< effective */
  82
  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 */
  87
  88     xkb_led_mask_t leds;
  89 };
  90
  91 struct xkb_state {
  92     /*
  93      * Before updating the state, we keep a copy of just this struct. This
  94      * allows us to report which components of the state have changed.
  95      */
  96     struct state_components components;
  97
  98     /*
  99      * At each event, we accumulate all the needed modifications to the base
 100      * modifiers, and apply them at the end. These keep track of this state.
 101      */
 102     xkb_mod_mask_t set_mods;
 103     xkb_mod_mask_t clear_mods;
 104
 105     /*
 106      * We mustn't clear a base modifier if there's another depressed key
 107      * which affects it, e.g. given this sequence
 108      * < Left Shift down, Right Shift down, Left Shift Up >
 109      * the modifier should still be set. This keeps the count.
 110      */
 111     int16_t mod_key_count[sizeof(xkb_mod_mask_t) * 8];
 112
 113     int refcnt;
 114     darray(struct xkb_filter) filters;
 115     struct xkb_keymap *keymap;
 116 };
 117
 118 static const struct xkb_key_type_entry *
 119 get_entry_for_key_state(struct xkb_state *state, const struct xkb_key *key,
 120                         xkb_layout_index_t group)
 121 {
 122     const struct xkb_key_type *type = key->groups[group].type;
 123     xkb_mod_mask_t active_mods = state->components.mods & type->mods.mask;
 124     unsigned int i;
 125
 126     for (i = 0; i < type->num_entries; i++) {
 127         /*
 128          * If the virtual modifiers are not bound to anything, we're
 129          * supposed to skip the entry (xserver does this with cached
 130          * entry->active field).
 131          */
 132         if (!type->entries[i].mods.mask)
 133             continue;
 134
 135         if (type->entries[i].mods.mask == active_mods)
 136             return &type->entries[i];
 137     }
 138
 139     return NULL;
 140 }
 141
 142 /**
 143  * Returns the level to use for the given key and state, or
 144  * XKB_LEVEL_INVALID.
 145  */
 146 XKB_EXPORT xkb_level_index_t
 147 xkb_state_key_get_level(struct xkb_state *state, xkb_keycode_t kc,
 148                         xkb_layout_index_t layout)
 149 {
 150     const struct xkb_key *key = XkbKey(state->keymap, kc);
 151     const struct xkb_key_type_entry *entry;
 152
 153     if (!key || layout >= key->num_groups)
 154         return XKB_LEVEL_INVALID;
 155
 156     /* If we don't find an explicit match the default is 0. */
 157     entry = get_entry_for_key_state(state, key, layout);
 158     if (!entry)
 159         return 0;
 160
 161     return entry->level;
 162 }
 163
 164 xkb_layout_index_t
 165 wrap_group_into_range(int32_t group,
 166                       xkb_layout_index_t num_groups,
 167                       enum xkb_range_exceed_type out_of_range_group_action,
 168                       xkb_layout_index_t out_of_range_group_number)
 169 {
 170     if (num_groups == 0)
 171         return XKB_LAYOUT_INVALID;
 172
 173     if (group < num_groups)
 174         return group;
 175
 176     switch (out_of_range_group_action) {
 177     case RANGE_REDIRECT:
 178         if (out_of_range_group_number >= num_groups)
 179             return 0;
 180         return out_of_range_group_number;
 181
 182     case RANGE_SATURATE:
 183         if (group < 0)
 184             return 0;
 185         else
 186             return num_groups - 1;
 187
 188     case RANGE_WRAP:
 189     default:
 190         /*
 191          * C99 says a negative dividend in a modulo operation always
 192          * gives a negative result.
 193          */
 194         if (group < 0)
 195             return ((int) num_groups + (group % (int) num_groups));
 196         else
 197             return group % num_groups;
 198     }
 199 }
 200
 201 /**
 202  * Returns the layout to use for the given key and state, taking
 203  * wrapping/clamping/etc into account, or XKB_LAYOUT_INVALID.
 204  */
 205 XKB_EXPORT xkb_layout_index_t
 206 xkb_state_key_get_layout(struct xkb_state *state, xkb_keycode_t kc)
 207 {
 208     const struct xkb_key *key = XkbKey(state->keymap, kc);
 209
 210     if (!key)
 211         return XKB_LAYOUT_INVALID;
 212
 213     return wrap_group_into_range(state->components.group, key->num_groups,
 214                                  key->out_of_range_group_action,
 215                                  key->out_of_range_group_number);
 216 }
 217
 218 static const union xkb_action fake = { .type = ACTION_TYPE_NONE };
 219
 220 static const union xkb_action *
 221 xkb_key_get_action(struct xkb_state *state, const struct xkb_key *key)
 222 {
 223     xkb_layout_index_t layout;
 224     xkb_level_index_t level;
 225
 226     layout = xkb_state_key_get_layout(state, key->keycode);
 227     if (layout == XKB_LAYOUT_INVALID)
 228         return &fake;
 229
 230     level = xkb_state_key_get_level(state, key->keycode, layout);
 231     if (level == XKB_LEVEL_INVALID)
 232         return &fake;
 233
 234     return &key->groups[layout].levels[level].action;
 235 }
 236
 237 static struct xkb_filter *
 238 xkb_filter_new(struct xkb_state *state)
 239 {
 240     struct xkb_filter *filter = NULL, *iter;
 241
 242     darray_foreach(iter, state->filters) {
 243         if (iter->func)
 244             continue;
 245         filter = iter;
 246         break;
 247     }
 248
 249     if (!filter) {
 250         darray_resize0(state->filters, darray_size(state->filters) + 1);
 251         filter = &darray_item(state->filters, darray_size(state->filters) -1);
 252     }
 253
 254     filter->refcnt = 1;
 255     return filter;
 256 }
 257
 258 /***====================================================================***/
 259
 260 static bool
 261 xkb_filter_group_set_func(struct xkb_state *state,
 262                           struct xkb_filter *filter,
 263                           const struct xkb_key *key,
 264                           enum xkb_key_direction direction)
 265 {
 266     if (key != filter->key) {
 267         filter->action.group.flags &= ~ACTION_LOCK_CLEAR;
 268         return true;
 269     }
 270
 271     if (direction == XKB_KEY_DOWN) {
 272         filter->refcnt++;
 273         return false;
 274     }
 275     else if (--filter->refcnt > 0) {
 276         return false;
 277     }
 278
 279     state->components.base_group = filter->priv;
 280
 281     if (filter->action.group.flags & ACTION_LOCK_CLEAR)
 282         state->components.locked_group = 0;
 283
 284     filter->func = NULL;
 285     return true;
 286 }
 287
 288 static void
 289 xkb_filter_group_set_new(struct xkb_state *state, struct xkb_filter *filter)
 290 {
 291     filter->priv = state->components.base_group;
 292     if (filter->action.group.flags & ACTION_ABSOLUTE_SWITCH)
 293         state->components.base_group = filter->action.group.group;
 294     else
 295         state->components.base_group += filter->action.group.group;
 296 }
 297
 298 static bool
 299 xkb_filter_group_lock_func(struct xkb_state *state,
 300                            struct xkb_filter *filter,
 301                            const struct xkb_key *key,
 302                            enum xkb_key_direction direction)
 303 {
 304     if (key != filter->key)
 305         return true;
 306
 307     if (direction == XKB_KEY_DOWN) {
 308         filter->refcnt++;
 309         return false;
 310     }
 311     if (--filter->refcnt > 0)
 312         return false;
 313
 314     filter->func = NULL;
 315     return true;
 316 }
 317
 318 static void
 319 xkb_filter_group_lock_new(struct xkb_state *state, struct xkb_filter *filter)
 320 {
 321     if (filter->action.group.flags & ACTION_ABSOLUTE_SWITCH)
 322         state->components.locked_group = filter->action.group.group;
 323     else
 324         state->components.locked_group += filter->action.group.group;
 325 }
 326
 327 static bool
 328 xkb_filter_mod_set_func(struct xkb_state *state,
 329                         struct xkb_filter *filter,
 330                         const struct xkb_key *key,
 331                         enum xkb_key_direction direction)
 332 {
 333     if (key != filter->key) {
 334         filter->action.mods.flags &= ~ACTION_LOCK_CLEAR;
 335         return true;
 336     }
 337
 338     if (direction == XKB_KEY_DOWN) {
 339         filter->refcnt++;
 340         return false;
 341     }
 342     else if (--filter->refcnt > 0) {
 343         return false;
 344     }
 345
 346     state->clear_mods = filter->action.mods.mods.mask;
 347     if (filter->action.mods.flags & ACTION_LOCK_CLEAR)
 348         state->components.locked_mods &= ~filter->action.mods.mods.mask;
 349
 350     filter->func = NULL;
 351     return true;
 352 }
 353
 354 static void
 355 xkb_filter_mod_set_new(struct xkb_state *state, struct xkb_filter *filter)
 356 {
 357     state->set_mods = filter->action.mods.mods.mask;
 358 }
 359
 360 static bool
 361 xkb_filter_mod_lock_func(struct xkb_state *state,
 362                          struct xkb_filter *filter,
 363                          const struct xkb_key *key,
 364                          enum xkb_key_direction direction)
 365 {
 366     if (key != filter->key)
 367         return true;
 368
 369     if (direction == XKB_KEY_DOWN) {
 370         filter->refcnt++;
 371         return false;
 372     }
 373     if (--filter->refcnt > 0)
 374         return false;
 375
 376     state->clear_mods |= filter->action.mods.mods.mask;
 377     if (!(filter->action.mods.flags & ACTION_LOCK_NO_UNLOCK))
 378         state->components.locked_mods &= ~filter->priv;
 379
 380     filter->func = NULL;
 381     return true;
 382 }
 383
 384 static void
 385 xkb_filter_mod_lock_new(struct xkb_state *state, struct xkb_filter *filter)
 386 {
 387     filter->priv = (state->components.locked_mods &
 388                     filter->action.mods.mods.mask);
 389     state->set_mods |= filter->action.mods.mods.mask;
 390     if (!(filter->action.mods.flags & ACTION_LOCK_NO_LOCK))
 391         state->components.locked_mods |= filter->action.mods.mods.mask;
 392 }
 393
 394 enum xkb_key_latch_state {
 395     NO_LATCH,
 396     LATCH_KEY_DOWN,
 397     LATCH_PENDING,
 398 };
 399
 400 static bool
 401 xkb_action_breaks_latch(const union xkb_action *action)
 402 {
 403     switch (action->type) {
 404     case ACTION_TYPE_NONE:
 405     case ACTION_TYPE_PTR_BUTTON:
 406     case ACTION_TYPE_PTR_LOCK:
 407     case ACTION_TYPE_CTRL_SET:
 408     case ACTION_TYPE_CTRL_LOCK:
 409     case ACTION_TYPE_SWITCH_VT:
 410     case ACTION_TYPE_TERMINATE:
 411         return true;
 412     default:
 413         return false;
 414     }
 415 }
 416
 417 static bool
 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)
 422 {
 423     enum xkb_key_latch_state latch = filter->priv;
 424
 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
 429          * modifier. */
 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;
 439             }
 440             else {
 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;
 444             }
 445             filter->key = key;
 446             state->components.latched_mods &= ~filter->action.mods.mods.mask;
 447             /* XXX beep beep! */
 448             return false;
 449         }
 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;
 454             filter->func = NULL;
 455             return true;
 456         }
 457     }
 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
 463          * latched. */
 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;
 473             else
 474                 state->clear_mods = filter->action.mods.mods.mask;
 475             state->components.locked_mods &= ~filter->action.mods.mods.mask;
 476             filter->func = NULL;
 477         }
 478         else {
 479             latch = LATCH_PENDING;
 480             state->clear_mods = filter->action.mods.mods.mask;
 481             state->components.latched_mods |= filter->action.mods.mods.mask;
 482             /* XXX beep beep! */
 483         }
 484     }
 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. */
 490         latch = NO_LATCH;
 491     }
 492
 493     filter->priv = latch;
 494
 495     return true;
 496 }
 497
 498 static void
 499 xkb_filter_mod_latch_new(struct xkb_state *state, struct xkb_filter *filter)
 500 {
 501     filter->priv = LATCH_KEY_DOWN;
 502     state->set_mods = filter->action.mods.mods.mask;
 503 }
 504
 505 static const struct {
 506     void (*new)(struct xkb_state *state, struct xkb_filter *filter);
 507     bool (*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 },
 520 };
 521
 522 /**
 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.
 526  */
 527 static void
 528 xkb_filter_apply_all(struct xkb_state *state,
 529                      const struct xkb_key *key,
 530                      enum xkb_key_direction direction)
 531 {
 532     struct xkb_filter *filter;
 533     const union xkb_action *action;
 534     bool send = true;
 535
 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) {
 539         if (!filter->func)
 540             continue;
 541         send = filter->func(state, filter, key, direction) && send;
 542     }
 543
 544     if (!send || direction == XKB_KEY_UP)
 545         return;
 546
 547     action = xkb_key_get_action(state, key);
 548
 549     /*
 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");
 553      *     };
 554      * We don't handle those.
 555      */
 556     if (action->type >= _ACTION_TYPE_NUM_ENTRIES)
 557         return;
 558
 559     if (!filter_action_funcs[action->type].new)
 560         return;
 561
 562     filter = xkb_filter_new(state);
 563     if (!filter)
 564         return; /* WSGO */
 565
 566     filter->key = key;
 567     filter->func = filter_action_funcs[action->type].func;
 568     filter->action = *action;
 569     filter_action_funcs[action->type].new(state, filter);
 570 }
 571
 572 XKB_EXPORT struct xkb_state *
 573 xkb_state_new(struct xkb_keymap *keymap)
 574 {
 575     struct xkb_state *ret;
 576
 577     ret = calloc(sizeof(*ret), 1);
 578     if (!ret)
 579         return NULL;
 580
 581     ret->refcnt = 1;
 582     ret->keymap = xkb_keymap_ref(keymap);
 583
 584     return ret;
 585 }
 586
 587 XKB_EXPORT struct xkb_state *
 588 xkb_state_ref(struct xkb_state *state)
 589 {
 590     state->refcnt++;
 591     return state;
 592 }
 593
 594 XKB_EXPORT void
 595 xkb_state_unref(struct xkb_state *state)
 596 {
 597     if (!state || --state->refcnt > 0)
 598         return;
 599
 600     xkb_keymap_unref(state->keymap);
 601     darray_free(state->filters);
 602     free(state);
 603 }
 604
 605 XKB_EXPORT struct xkb_keymap *
 606 xkb_state_get_keymap(struct xkb_state *state)
 607 {
 608     return state->keymap;
 609 }
 610
 611 /**
 612  * Update the LED state to match the rest of the xkb_state.
 613  */
 614 static void
 615 xkb_state_led_update_all(struct xkb_state *state)
 616 {
 617     xkb_led_index_t idx;
 618     const struct xkb_led *led;
 619
 620     state->components.leds = 0;
 621
 622     darray_enumerate(idx, led, state->keymap->leds) {
 623         xkb_mod_mask_t mod_mask = 0;
 624         xkb_layout_mask_t group_mask = 0;
 625
 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);
 636
 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);
 647
 648         if (led->ctrls & state->keymap->enabled_ctrls)
 649             state->components.leds |= (1 << idx);
 650     }
 651 }
 652
 653 /**
 654  * Calculates the derived state (effective mods/group and LEDs) from an
 655  * up-to-date xkb_state.
 656  */
 657 static void
 658 xkb_state_update_derived(struct xkb_state *state)
 659 {
 660     state->components.mods = (state->components.base_mods |
 661                               state->components.latched_mods |
 662                               state->components.locked_mods);
 663
 664     /* TODO: Use groups_wrap control instead of always RANGE_WRAP. */
 665
 666     state->components.locked_group =
 667         wrap_group_into_range(state->components.locked_group,
 668                               state->keymap->num_groups,
 669                               RANGE_WRAP, 0);
 670
 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,
 676                               RANGE_WRAP, 0);
 677
 678     xkb_state_led_update_all(state);
 679 }
 680
 681 static enum xkb_state_component
 682 get_state_component_changes(const struct state_components *a,
 683                             const struct state_components *b)
 684 {
 685     xkb_mod_mask_t mask = 0;
 686
 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;
 705
 706     return mask;
 707 }
 708
 709 /**
 710  * Given a particular key event, updates the state structure to reflect the
 711  * new modifiers.
 712  */
 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)
 716 {
 717     xkb_mod_index_t i;
 718     xkb_mod_mask_t bit;
 719     struct state_components prev_components;
 720     const struct xkb_key *key = XkbKey(state->keymap, kc);
 721
 722     if (!key)
 723         return 0;
 724
 725     prev_components = state->components;
 726
 727     state->set_mods = 0;
 728     state->clear_mods = 0;
 729
 730     xkb_filter_apply_all(state, key, direction);
 731
 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;
 737         }
 738     }
 739
 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;
 746             }
 747             state->clear_mods &= ~bit;
 748         }
 749     }
 750
 751     xkb_state_update_derived(state);
 752
 753     return get_state_component_changes(&prev_components, &state->components);
 754 }
 755
 756 /**
 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.
 762  */
 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)
 771 {
 772     struct state_components prev_components;
 773     xkb_mod_index_t num_mods;
 774     xkb_mod_index_t idx;
 775
 776     prev_components = state->components;
 777
 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);
 782
 783     for (idx = 0; idx < num_mods; idx++) {
 784         xkb_mod_mask_t mod = (1 << idx);
 785         if (base_mods & mod)
 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;
 791     }
 792
 793     state->components.base_group = base_group;
 794     state->components.latched_group = latched_group;
 795     state->components.locked_group = locked_group;
 796
 797     xkb_state_update_derived(state);
 798
 799     return get_state_component_changes(&prev_components, &state->components);
 800 }
 801
 802 /**
 803  * Provides the symbols to use for the given key and state.  Returns the
 804  * number of symbols pointed to in syms_out.
 805  */
 806 XKB_EXPORT int
 807 xkb_state_key_get_syms(struct xkb_state *state, xkb_keycode_t kc,
 808                        const xkb_keysym_t **syms_out)
 809 {
 810     xkb_layout_index_t layout;
 811     xkb_level_index_t level;
 812
 813     layout = xkb_state_key_get_layout(state, kc);
 814     if (layout == XKB_LAYOUT_INVALID)
 815         goto err;
 816
 817     level = xkb_state_key_get_level(state, kc, layout);
 818     if (level == XKB_LEVEL_INVALID)
 819         goto err;
 820
 821     return xkb_keymap_key_get_syms_by_level(state->keymap, kc, layout, level,
 822                                             syms_out);
 823
 824 err:
 825     *syms_out = NULL;
 826     return 0;
 827 }
 828
 829 /**
 830  * Provides either exactly one symbol, or XKB_KEY_NoSymbol.
 831  */
 832 XKB_EXPORT xkb_keysym_t
 833 xkb_state_key_get_one_sym(struct xkb_state *state, xkb_keycode_t kc)
 834 {
 835     const xkb_keysym_t *syms;
 836     xkb_keysym_t sym;
 837     int num_syms;
 838     xkb_mod_index_t caps;
 839
 840     num_syms = xkb_state_key_get_syms(state, kc, &syms);
 841     if (num_syms != 1)
 842         return XKB_KEY_NoSymbol;
 843
 844     sym = syms[0];
 845
 846     /*
 847      * Perform capitalization transformation, see:
 848      * http://www.x.org/releases/current/doc/kbproto/xkbproto.html#Interpreting_the_Lock_Modifier
 849      */
 850     caps = xkb_keymap_mod_get_index(state->keymap, XKB_MOD_NAME_CAPS);
 851     if (xkb_state_mod_index_is_active(state, caps, XKB_STATE_MODS_EFFECTIVE) > 0 &&
 852         xkb_state_mod_index_is_consumed(state, kc, caps) == 0)
 853         sym = xkb_keysym_to_upper(sym);
 854
 855     return sym;
 856 }
 857
 858 /**
 859  * Serialises the requested modifier state into an xkb_mod_mask_t, with all
 860  * the same disclaimers as in xkb_state_update_mask.
 861  */
 862 XKB_EXPORT xkb_mod_mask_t
 863 xkb_state_serialize_mods(struct xkb_state *state,
 864                          enum xkb_state_component type)
 865 {
 866     xkb_mod_mask_t ret = 0;
 867
 868     if (type & XKB_STATE_MODS_EFFECTIVE)
 869         return state->components.mods;
 870
 871     if (type & XKB_STATE_MODS_DEPRESSED)
 872         ret |= state->components.base_mods;
 873     if (type & XKB_STATE_MODS_LATCHED)
 874         ret |= state->components.latched_mods;
 875     if (type & XKB_STATE_MODS_LOCKED)
 876         ret |= state->components.locked_mods;
 877
 878     return ret;
 879 }
 880
 881 /**
 882  * Serialises the requested group state, with all the same disclaimers as
 883  * in xkb_state_update_mask.
 884  */
 885 XKB_EXPORT xkb_layout_index_t
 886 xkb_state_serialize_layout(struct xkb_state *state,
 887                            enum xkb_state_component type)
 888 {
 889     xkb_layout_index_t ret = 0;
 890
 891     if (type & XKB_STATE_LAYOUT_EFFECTIVE)
 892         return state->components.group;
 893
 894     if (type & XKB_STATE_LAYOUT_DEPRESSED)
 895         ret += state->components.base_group;
 896     if (type & XKB_STATE_LAYOUT_LATCHED)
 897         ret += state->components.latched_group;
 898     if (type & XKB_STATE_LAYOUT_LOCKED)
 899         ret += state->components.locked_group;
 900
 901     return ret;
 902 }
 903
 904 /**
 905  * Returns 1 if the given modifier is active with the specified type(s), 0 if
 906  * not, or -1 if the modifier is invalid.
 907  */
 908 XKB_EXPORT int
 909 xkb_state_mod_index_is_active(struct xkb_state *state,
 910                               xkb_mod_index_t idx,
 911                               enum xkb_state_component type)
 912 {
 913     if (idx >= xkb_keymap_num_mods(state->keymap))
 914         return -1;
 915
 916     return !!(xkb_state_serialize_mods(state, type) & (1 << idx));
 917 }
 918
 919 /**
 920  * Helper function for xkb_state_mod_indices_are_active and
 921  * xkb_state_mod_names_are_active.
 922  */
 923 static int
 924 match_mod_masks(struct xkb_state *state,
 925                 enum xkb_state_component type,
 926                 enum xkb_state_match match,
 927                 xkb_mod_mask_t wanted)
 928 {
 929     xkb_mod_mask_t active = xkb_state_serialize_mods(state, type);
 930
 931     if (!(match & XKB_STATE_MATCH_NON_EXCLUSIVE) && (active & ~wanted))
 932         return 0;
 933
 934     if (match & XKB_STATE_MATCH_ANY)
 935         return !!(active & wanted);
 936     else
 937         return (active & wanted) == wanted;
 938
 939     return 0;
 940 }
 941
 942 /**
 943  * Returns 1 if the modifiers are active with the specified type(s), 0 if
 944  * not, or -1 if any of the modifiers are invalid.
 945  */
 946 XKB_EXPORT int
 947 xkb_state_mod_indices_are_active(struct xkb_state *state,
 948                                  enum xkb_state_component type,
 949                                  enum xkb_state_match match,
 950                                  ...)
 951 {
 952     va_list ap;
 953     xkb_mod_index_t idx = 0;
 954     xkb_mod_mask_t wanted = 0;
 955     int ret = 0;
 956     xkb_mod_index_t num_mods = xkb_keymap_num_mods(state->keymap);
 957
 958     va_start(ap, match);
 959     while (1) {
 960         idx = va_arg(ap, xkb_mod_index_t);
 961         if (idx == XKB_MOD_INVALID)
 962             break;
 963         if (idx >= num_mods) {
 964             ret = -1;
 965             break;
 966         }
 967         wanted |= (1 << idx);
 968     }
 969     va_end(ap);
 970
 971     if (ret == -1)
 972         return ret;
 973
 974     return match_mod_masks(state, type, match, wanted);
 975 }
 976
 977 /**
 978  * Returns 1 if the given modifier is active with the specified type(s), 0 if
 979  * not, or -1 if the modifier is invalid.
 980  */
 981 XKB_EXPORT int
 982 xkb_state_mod_name_is_active(struct xkb_state *state, const char *name,
 983                              enum xkb_state_component type)
 984 {
 985     xkb_mod_index_t idx = xkb_keymap_mod_get_index(state->keymap, name);
 986
 987     if (idx == XKB_MOD_INVALID)
 988         return -1;
 989
 990     return xkb_state_mod_index_is_active(state, idx, type);
 991 }
 992
 993 /**
 994  * Returns 1 if the modifiers are active with the specified type(s), 0 if
 995  * not, or -1 if any of the modifiers are invalid.
 996  */
 997 XKB_EXPORT ATTR_NULL_SENTINEL int
 998 xkb_state_mod_names_are_active(struct xkb_state *state,
 999                                enum xkb_state_component type,
1000                                enum xkb_state_match match,
1001                                ...)
1002 {
1003     va_list ap;
1004     xkb_mod_index_t idx = 0;
1005     xkb_mod_mask_t wanted = 0;
1006     int ret = 0;
1007
1008     va_start(ap, match);
1009     while (1) {
1010         const char *str = va_arg(ap, const char *);
1011         if (str == NULL)
1012             break;
1013         idx = xkb_keymap_mod_get_index(state->keymap, str);
1014         if (idx == XKB_MOD_INVALID) {
1015             ret = -1;
1016             break;
1017         }
1018         wanted |= (1 << idx);
1019     }
1020     va_end(ap);
1021
1022     if (ret == -1)
1023         return ret;
1024
1025     return match_mod_masks(state, type, match, wanted);
1026 }
1027
1028 /**
1029  * Returns 1 if the given group is active with the specified type(s), 0 if
1030  * not, or -1 if the group is invalid.
1031  */
1032 XKB_EXPORT int
1033 xkb_state_layout_index_is_active(struct xkb_state *state,
1034                                 xkb_layout_index_t idx,
1035                                 enum xkb_state_component type)
1036 {
1037     int ret = 0;
1038
1039     if (idx >= state->keymap->num_groups)
1040         return -1;
1041
1042     if (type & XKB_STATE_LAYOUT_EFFECTIVE)
1043         ret |= (state->components.group == idx);
1044     if (type & XKB_STATE_LAYOUT_DEPRESSED)
1045         ret |= (state->components.base_group == idx);
1046     if (type & XKB_STATE_LAYOUT_LATCHED)
1047         ret |= (state->components.latched_group == idx);
1048     if (type & XKB_STATE_LAYOUT_LOCKED)
1049         ret |= (state->components.locked_group == idx);
1050
1051     return ret;
1052 }
1053
1054 /**
1055  * Returns 1 if the given modifier is active with the specified type(s), 0 if
1056  * not, or -1 if the modifier is invalid.
1057  */
1058 XKB_EXPORT int
1059 xkb_state_layout_name_is_active(struct xkb_state *state, const char *name,
1060                                 enum xkb_state_component type)
1061 {
1062     xkb_layout_index_t idx = xkb_keymap_layout_get_index(state->keymap, name);
1063
1064     if (idx == XKB_LAYOUT_INVALID)
1065         return -1;
1066
1067     return xkb_state_layout_index_is_active(state, idx, type);
1068 }
1069
1070 /**
1071  * Returns 1 if the given LED is active, 0 if not, or -1 if the LED is invalid.
1072  */
1073 XKB_EXPORT int
1074 xkb_state_led_index_is_active(struct xkb_state *state, xkb_led_index_t idx)
1075 {
1076     if (idx >= darray_size(state->keymap->leds) ||
1077         darray_item(state->keymap->leds, idx).name == XKB_ATOM_NONE)
1078         return -1;
1079
1080     return !!(state->components.leds & (1 << idx));
1081 }
1082
1083 /**
1084  * Returns 1 if the given LED is active, 0 if not, or -1 if the LED is invalid.
1085  */
1086 XKB_EXPORT int
1087 xkb_state_led_name_is_active(struct xkb_state *state, const char *name)
1088 {
1089     xkb_led_index_t idx = xkb_keymap_led_get_index(state->keymap, name);
1090
1091     if (idx == XKB_LED_INVALID)
1092         return -1;
1093
1094     return xkb_state_led_index_is_active(state, idx);
1095 }
1096
1097 static xkb_mod_mask_t
1098 key_get_consumed(struct xkb_state *state, const struct xkb_key *key)
1099 {
1100     const struct xkb_key_type_entry *entry;
1101     xkb_layout_index_t group;
1102
1103     group = xkb_state_key_get_layout(state, key->keycode);
1104     if (group == XKB_LAYOUT_INVALID)
1105         return 0;
1106
1107     entry = get_entry_for_key_state(state, key, group);
1108     if (!entry)
1109         return 0;
1110
1111     return entry->mods.mask & ~entry->preserve.mask;
1112 }
1113
1114 /**
1115  * Tests to see if a modifier is used up by our translation of a
1116  * keycode to keysyms, taking note of the current modifier state and
1117  * the appropriate key type's preserve information, if any. This allows
1118  * the user to mask out the modifier in later processing of the
1119  * modifiers, e.g. when implementing hot keys or accelerators.
1120  *
1121  * See also, for example:
1122  * - XkbTranslateKeyCode(3), mod_rtrn return value, from libX11.
1123  * - gdk_keymap_translate_keyboard_state, consumed_modifiers return value,
1124  *   from gtk+.
1125  */
1126 XKB_EXPORT int
1127 xkb_state_mod_index_is_consumed(struct xkb_state *state, xkb_keycode_t kc,
1128                                 xkb_mod_index_t idx)
1129 {
1130     const struct xkb_key *key = XkbKey(state->keymap, kc);
1131
1132     if (!key || idx >= xkb_keymap_num_mods(state->keymap))
1133         return -1;
1134
1135     return !!((1 << idx) & key_get_consumed(state, key));
1136 }
1137
1138 /**
1139  * Calculates which modifiers should be consumed during key processing,
1140  * and returns the mask with all these modifiers removed.  e.g. if
1141  * given a state of Alt and Shift active for a two-level alphabetic
1142  * key containing plus and equal on the first and second level
1143  * respectively, will return a mask of only Alt, as Shift has been
1144  * consumed by the type handling.
1145  */
1146 XKB_EXPORT xkb_mod_mask_t
1147 xkb_state_mod_mask_remove_consumed(struct xkb_state *state, xkb_keycode_t kc,
1148                                    xkb_mod_mask_t mask)
1149 {
1150     const struct xkb_key *key = XkbKey(state->keymap, kc);
1151
1152     if (!key)
1153         return 0;
1154
1155     return mask & ~key_get_consumed(state, key);
1156 }