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 #include "utf8.h"
  65
  66 struct xkb_filter {
  67     union xkb_action action;
  68     const struct xkb_key *key;
  69     uint32_t priv;
  70     bool (*func)(struct xkb_state *state,
  71                  struct xkb_filter *filter,
  72                  const struct xkb_key *key,
  73                  enum xkb_key_direction direction);
  74     int refcnt;
  75 };
  76
  77 struct state_components {
  78     /* These may be negative, because of -1 group actions. */
  79     int32_t base_group; /**< depressed */
  80     int32_t latched_group;
  81     int32_t locked_group;
  82     xkb_layout_index_t group; /**< effective */
  83
  84     xkb_mod_mask_t base_mods; /**< depressed */
  85     xkb_mod_mask_t latched_mods;
  86     xkb_mod_mask_t locked_mods;
  87     xkb_mod_mask_t mods; /**< effective */
  88
  89     xkb_led_mask_t leds;
  90 };
  91
  92 struct xkb_state {
  93     /*
  94      * Before updating the state, we keep a copy of just this struct. This
  95      * allows us to report which components of the state have changed.
  96      */
  97     struct state_components components;
  98
  99     /*
 100      * At each event, we accumulate all the needed modifications to the base
 101      * modifiers, and apply them at the end. These keep track of this state.
 102      */
 103     xkb_mod_mask_t set_mods;
 104     xkb_mod_mask_t clear_mods;
 105
 106     /*
 107      * We mustn't clear a base modifier if there's another depressed key
 108      * which affects it, e.g. given this sequence
 109      * < Left Shift down, Right Shift down, Left Shift Up >
 110      * the modifier should still be set. This keeps the count.
 111      */
 112     int16_t mod_key_count[XKB_MAX_MODS];
 113
 114     int refcnt;
 115     darray(struct xkb_filter) filters;
 116     struct xkb_keymap *keymap;
 117 };
 118
 119 static const struct xkb_key_type_entry *
 120 get_entry_for_key_state(struct xkb_state *state, const struct xkb_key *key,
 121                         xkb_layout_index_t group)
 122 {
 123     const struct xkb_key_type *type = key->groups[group].type;
 124     xkb_mod_mask_t active_mods = state->components.mods & type->mods.mask;
 125
 126     for (unsigned 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 >= 0 && (xkb_layout_index_t) 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 != 0 && led->mods.mask != 0) {
 627             if (led->which_mods & XKB_STATE_MODS_EFFECTIVE)
 628                 mod_mask |= state->components.mods;
 629             if (led->which_mods & XKB_STATE_MODS_DEPRESSED)
 630                 mod_mask |= state->components.base_mods;
 631             if (led->which_mods & XKB_STATE_MODS_LATCHED)
 632                 mod_mask |= state->components.latched_mods;
 633             if (led->which_mods & XKB_STATE_MODS_LOCKED)
 634                 mod_mask |= state->components.locked_mods;
 635
 636             if (led->mods.mask & mod_mask) {
 637                 state->components.leds |= (1u << idx);
 638                 continue;
 639             }
 640         }
 641
 642         if (led->which_groups != 0 && led->groups != 0) {
 643             if (led->which_groups & XKB_STATE_LAYOUT_EFFECTIVE)
 644                 group_mask |= (1u << state->components.group);
 645             if (led->which_groups & XKB_STATE_LAYOUT_DEPRESSED)
 646                 group_mask |= (1u << state->components.base_group);
 647             if (led->which_groups & XKB_STATE_LAYOUT_LATCHED)
 648                 group_mask |= (1u << state->components.latched_group);
 649             if (led->which_groups & XKB_STATE_LAYOUT_LOCKED)
 650                 group_mask |= (1u << state->components.locked_group);
 651
 652             if (led->groups & group_mask) {
 653                 state->components.leds |= (1u << idx);
 654                 continue;
 655             }
 656         }
 657
 658         if (led->ctrls & state->keymap->enabled_ctrls) {
 659             state->components.leds |= (1u << idx);
 660             continue;
 661         }
 662     }
 663 }
 664
 665 /**
 666  * Calculates the derived state (effective mods/group and LEDs) from an
 667  * up-to-date xkb_state.
 668  */
 669 static void
 670 xkb_state_update_derived(struct xkb_state *state)
 671 {
 672     xkb_layout_index_t wrapped;
 673
 674     state->components.mods = (state->components.base_mods |
 675                               state->components.latched_mods |
 676                               state->components.locked_mods);
 677
 678     /* TODO: Use groups_wrap control instead of always RANGE_WRAP. */
 679
 680     wrapped = wrap_group_into_range(state->components.locked_group,
 681                                     state->keymap->num_groups,
 682                                     RANGE_WRAP, 0);
 683     state->components.locked_group =
 684         (wrapped == XKB_LAYOUT_INVALID ? 0 : wrapped);
 685
 686     wrapped = wrap_group_into_range(state->components.base_group +
 687                                     state->components.latched_group +
 688                                     state->components.locked_group,
 689                                     state->keymap->num_groups,
 690                                     RANGE_WRAP, 0);
 691     state->components.group =
 692         (wrapped == XKB_LAYOUT_INVALID ? 0 : wrapped);
 693
 694     xkb_state_led_update_all(state);
 695 }
 696
 697 static enum xkb_state_component
 698 get_state_component_changes(const struct state_components *a,
 699                             const struct state_components *b)
 700 {
 701     xkb_mod_mask_t mask = 0;
 702
 703     if (a->group != b->group)
 704         mask |= XKB_STATE_LAYOUT_EFFECTIVE;
 705     if (a->base_group != b->base_group)
 706         mask |= XKB_STATE_LAYOUT_DEPRESSED;
 707     if (a->latched_group != b->latched_group)
 708         mask |= XKB_STATE_LAYOUT_LATCHED;
 709     if (a->locked_group != b->locked_group)
 710         mask |= XKB_STATE_LAYOUT_LOCKED;
 711     if (a->mods != b->mods)
 712         mask |= XKB_STATE_MODS_EFFECTIVE;
 713     if (a->base_mods != b->base_mods)
 714         mask |= XKB_STATE_MODS_DEPRESSED;
 715     if (a->latched_mods != b->latched_mods)
 716         mask |= XKB_STATE_MODS_LATCHED;
 717     if (a->locked_mods != b->locked_mods)
 718         mask |= XKB_STATE_MODS_LOCKED;
 719     if (a->leds != b->leds)
 720         mask |= XKB_STATE_LEDS;
 721
 722     return mask;
 723 }
 724
 725 /**
 726  * Given a particular key event, updates the state structure to reflect the
 727  * new modifiers.
 728  */
 729 XKB_EXPORT enum xkb_state_component
 730 xkb_state_update_key(struct xkb_state *state, xkb_keycode_t kc,
 731                      enum xkb_key_direction direction)
 732 {
 733     xkb_mod_index_t i;
 734     xkb_mod_mask_t bit;
 735     struct state_components prev_components;
 736     const struct xkb_key *key = XkbKey(state->keymap, kc);
 737
 738     if (!key)
 739         return 0;
 740
 741     prev_components = state->components;
 742
 743     state->set_mods = 0;
 744     state->clear_mods = 0;
 745
 746     xkb_filter_apply_all(state, key, direction);
 747
 748     for (i = 0, bit = 1; state->set_mods; i++, bit <<= 1) {
 749         if (state->set_mods & bit) {
 750             state->mod_key_count[i]++;
 751             state->components.base_mods |= bit;
 752             state->set_mods &= ~bit;
 753         }
 754     }
 755
 756     for (i = 0, bit = 1; state->clear_mods; i++, bit <<= 1) {
 757         if (state->clear_mods & bit) {
 758             state->mod_key_count[i]--;
 759             if (state->mod_key_count[i] <= 0) {
 760                 state->components.base_mods &= ~bit;
 761                 state->mod_key_count[i] = 0;
 762             }
 763             state->clear_mods &= ~bit;
 764         }
 765     }
 766
 767     xkb_state_update_derived(state);
 768
 769     return get_state_component_changes(&prev_components, &state->components);
 770 }
 771
 772 /**
 773  * Updates the state from a set of explicit masks as gained from
 774  * xkb_state_serialize_mods and xkb_state_serialize_groups.  As noted in the
 775  * documentation for these functions in xkbcommon.h, this round-trip is
 776  * lossy, and should only be used to update a slave state mirroring the
 777  * master, e.g. in a client/server window system.
 778  */
 779 XKB_EXPORT enum xkb_state_component
 780 xkb_state_update_mask(struct xkb_state *state,
 781                       xkb_mod_mask_t base_mods,
 782                       xkb_mod_mask_t latched_mods,
 783                       xkb_mod_mask_t locked_mods,
 784                       xkb_layout_index_t base_group,
 785                       xkb_layout_index_t latched_group,
 786                       xkb_layout_index_t locked_group)
 787 {
 788     struct state_components prev_components;
 789     xkb_mod_index_t num_mods;
 790     xkb_mod_index_t idx;
 791
 792     prev_components = state->components;
 793
 794     state->components.base_mods = 0;
 795     state->components.latched_mods = 0;
 796     state->components.locked_mods = 0;
 797     num_mods = xkb_keymap_num_mods(state->keymap);
 798
 799     for (idx = 0; idx < num_mods; idx++) {
 800         xkb_mod_mask_t mod = (1u << idx);
 801         if (base_mods & mod)
 802             state->components.base_mods |= mod;
 803         if (latched_mods & mod)
 804             state->components.latched_mods |= mod;
 805         if (locked_mods & mod)
 806             state->components.locked_mods |= mod;
 807     }
 808
 809     state->components.base_group = base_group;
 810     state->components.latched_group = latched_group;
 811     state->components.locked_group = locked_group;
 812
 813     xkb_state_update_derived(state);
 814
 815     return get_state_component_changes(&prev_components, &state->components);
 816 }
 817
 818 /**
 819  * Provides the symbols to use for the given key and state.  Returns the
 820  * number of symbols pointed to in syms_out.
 821  */
 822 XKB_EXPORT int
 823 xkb_state_key_get_syms(struct xkb_state *state, xkb_keycode_t kc,
 824                        const xkb_keysym_t **syms_out)
 825 {
 826     xkb_layout_index_t layout;
 827     xkb_level_index_t level;
 828
 829     layout = xkb_state_key_get_layout(state, kc);
 830     if (layout == XKB_LAYOUT_INVALID)
 831         goto err;
 832
 833     level = xkb_state_key_get_level(state, kc, layout);
 834     if (level == XKB_LEVEL_INVALID)
 835         goto err;
 836
 837     return xkb_keymap_key_get_syms_by_level(state->keymap, kc, layout, level,
 838                                             syms_out);
 839
 840 err:
 841     *syms_out = NULL;
 842     return 0;
 843 }
 844
 845 /**
 846  * Provides either exactly one symbol, or XKB_KEY_NoSymbol.
 847  */
 848 XKB_EXPORT xkb_keysym_t
 849 xkb_state_key_get_one_sym(struct xkb_state *state, xkb_keycode_t kc)
 850 {
 851     const xkb_keysym_t *syms;
 852     xkb_keysym_t sym;
 853     int num_syms;
 854     xkb_mod_index_t caps;
 855
 856     num_syms = xkb_state_key_get_syms(state, kc, &syms);
 857     if (num_syms != 1)
 858         return XKB_KEY_NoSymbol;
 859
 860     sym = syms[0];
 861
 862     /*
 863      * Perform capitalization transformation, see:
 864      * http://www.x.org/releases/current/doc/kbproto/xkbproto.html#Interpreting_the_Lock_Modifier
 865      */
 866     caps = xkb_keymap_mod_get_index(state->keymap, XKB_MOD_NAME_CAPS);
 867     if (xkb_state_mod_index_is_active(state, caps, XKB_STATE_MODS_EFFECTIVE) > 0 &&
 868         xkb_state_mod_index_is_consumed(state, kc, caps) == 0)
 869         sym = xkb_keysym_to_upper(sym);
 870
 871     return sym;
 872 }
 873
 874 XKB_EXPORT int
 875 xkb_state_key_get_utf8(struct xkb_state *state, xkb_keycode_t kc,
 876                        char *buffer, size_t size)
 877 {
 878     xkb_keysym_t sym;
 879     const xkb_keysym_t *syms;
 880     int nsyms;
 881     int offset;
 882     char tmp[7];
 883
 884     /* Make sure the keysym transformations are applied. */
 885     sym = xkb_state_key_get_one_sym(state, kc);
 886     if (sym != XKB_KEY_NoSymbol) {
 887         nsyms = 1; syms = &sym;
 888     }
 889     else {
 890         nsyms = xkb_state_key_get_syms(state, kc, &syms);
 891     }
 892
 893     /* Make sure not to truncate in the middle of a UTF-8 sequence. */
 894     offset = 0;
 895     for (int i = 0; i < nsyms; i++) {
 896         int ret = xkb_keysym_to_utf8(syms[i], tmp, sizeof(tmp));
 897         if (ret <= 0)
 898             goto err_bad;
 899
 900         ret--;
 901         if ((size_t) (offset + ret) <= size)
 902             memcpy(buffer + offset, tmp, ret);
 903         offset += ret;
 904     }
 905
 906     if ((size_t) offset >= size)
 907         goto err_trunc;
 908     buffer[offset] = '\0';
 909
 910     if (!is_valid_utf8(buffer, offset))
 911         goto err_bad;
 912
 913     return offset;
 914
 915 err_trunc:
 916     if (size > 0)
 917         buffer[size - 1] = '\0';
 918     return offset;
 919
 920 err_bad:
 921     if (size > 0)
 922         buffer[0] = '\0';
 923     return 0;
 924 }
 925
 926 XKB_EXPORT uint32_t
 927 xkb_state_key_get_utf32(struct xkb_state *state, xkb_keycode_t kc)
 928 {
 929     xkb_keysym_t sym;
 930     uint32_t cp;
 931
 932     sym = xkb_state_key_get_one_sym(state, kc);
 933     cp = xkb_keysym_to_utf32(sym);
 934
 935     return cp;
 936 }
 937
 938 /**
 939  * Serialises the requested modifier state into an xkb_mod_mask_t, with all
 940  * the same disclaimers as in xkb_state_update_mask.
 941  */
 942 XKB_EXPORT xkb_mod_mask_t
 943 xkb_state_serialize_mods(struct xkb_state *state,
 944                          enum xkb_state_component type)
 945 {
 946     xkb_mod_mask_t ret = 0;
 947
 948     if (type & XKB_STATE_MODS_EFFECTIVE)
 949         return state->components.mods;
 950
 951     if (type & XKB_STATE_MODS_DEPRESSED)
 952         ret |= state->components.base_mods;
 953     if (type & XKB_STATE_MODS_LATCHED)
 954         ret |= state->components.latched_mods;
 955     if (type & XKB_STATE_MODS_LOCKED)
 956         ret |= state->components.locked_mods;
 957
 958     return ret;
 959 }
 960
 961 /**
 962  * Serialises the requested group state, with all the same disclaimers as
 963  * in xkb_state_update_mask.
 964  */
 965 XKB_EXPORT xkb_layout_index_t
 966 xkb_state_serialize_layout(struct xkb_state *state,
 967                            enum xkb_state_component type)
 968 {
 969     xkb_layout_index_t ret = 0;
 970
 971     if (type & XKB_STATE_LAYOUT_EFFECTIVE)
 972         return state->components.group;
 973
 974     if (type & XKB_STATE_LAYOUT_DEPRESSED)
 975         ret += state->components.base_group;
 976     if (type & XKB_STATE_LAYOUT_LATCHED)
 977         ret += state->components.latched_group;
 978     if (type & XKB_STATE_LAYOUT_LOCKED)
 979         ret += state->components.locked_group;
 980
 981     return ret;
 982 }
 983
 984 /**
 985  * Returns 1 if the given modifier is active with the specified type(s), 0 if
 986  * not, or -1 if the modifier is invalid.
 987  */
 988 XKB_EXPORT int
 989 xkb_state_mod_index_is_active(struct xkb_state *state,
 990                               xkb_mod_index_t idx,
 991                               enum xkb_state_component type)
 992 {
 993     if (idx >= xkb_keymap_num_mods(state->keymap))
 994         return -1;
 995
 996     return !!(xkb_state_serialize_mods(state, type) & (1u << idx));
 997 }
 998
 999 /**
1000  * Helper function for xkb_state_mod_indices_are_active and
1001  * xkb_state_mod_names_are_active.
1002  */
1003 static int
1004 match_mod_masks(struct xkb_state *state,
1005                 enum xkb_state_component type,
1006                 enum xkb_state_match match,
1007                 xkb_mod_mask_t wanted)
1008 {
1009     xkb_mod_mask_t active = xkb_state_serialize_mods(state, type);
1010
1011     if (!(match & XKB_STATE_MATCH_NON_EXCLUSIVE) && (active & ~wanted))
1012         return 0;
1013
1014     if (match & XKB_STATE_MATCH_ANY)
1015         return !!(active & wanted);
1016     else
1017         return (active & wanted) == wanted;
1018
1019     return 0;
1020 }
1021
1022 /**
1023  * Returns 1 if the modifiers are active with the specified type(s), 0 if
1024  * not, or -1 if any of the modifiers are invalid.
1025  */
1026 XKB_EXPORT int
1027 xkb_state_mod_indices_are_active(struct xkb_state *state,
1028                                  enum xkb_state_component type,
1029                                  enum xkb_state_match match,
1030                                  ...)
1031 {
1032     va_list ap;
1033     xkb_mod_index_t idx = 0;
1034     xkb_mod_mask_t wanted = 0;
1035     int ret = 0;
1036     xkb_mod_index_t num_mods = xkb_keymap_num_mods(state->keymap);
1037
1038     va_start(ap, match);
1039     while (1) {
1040         idx = va_arg(ap, xkb_mod_index_t);
1041         if (idx == XKB_MOD_INVALID)
1042             break;
1043         if (idx >= num_mods) {
1044             ret = -1;
1045             break;
1046         }
1047         wanted |= (1u << idx);
1048     }
1049     va_end(ap);
1050
1051     if (ret == -1)
1052         return ret;
1053
1054     return match_mod_masks(state, type, match, wanted);
1055 }
1056
1057 /**
1058  * Returns 1 if the given modifier is active with the specified type(s), 0 if
1059  * not, or -1 if the modifier is invalid.
1060  */
1061 XKB_EXPORT int
1062 xkb_state_mod_name_is_active(struct xkb_state *state, const char *name,
1063                              enum xkb_state_component type)
1064 {
1065     xkb_mod_index_t idx = xkb_keymap_mod_get_index(state->keymap, name);
1066
1067     if (idx == XKB_MOD_INVALID)
1068         return -1;
1069
1070     return xkb_state_mod_index_is_active(state, idx, type);
1071 }
1072
1073 /**
1074  * Returns 1 if the modifiers are active with the specified type(s), 0 if
1075  * not, or -1 if any of the modifiers are invalid.
1076  */
1077 XKB_EXPORT ATTR_NULL_SENTINEL int
1078 xkb_state_mod_names_are_active(struct xkb_state *state,
1079                                enum xkb_state_component type,
1080                                enum xkb_state_match match,
1081                                ...)
1082 {
1083     va_list ap;
1084     xkb_mod_index_t idx = 0;
1085     xkb_mod_mask_t wanted = 0;
1086     int ret = 0;
1087
1088     va_start(ap, match);
1089     while (1) {
1090         const char *str = va_arg(ap, const char *);
1091         if (str == NULL)
1092             break;
1093         idx = xkb_keymap_mod_get_index(state->keymap, str);
1094         if (idx == XKB_MOD_INVALID) {
1095             ret = -1;
1096             break;
1097         }
1098         wanted |= (1u << idx);
1099     }
1100     va_end(ap);
1101
1102     if (ret == -1)
1103         return ret;
1104
1105     return match_mod_masks(state, type, match, wanted);
1106 }
1107
1108 /**
1109  * Returns 1 if the given group is active with the specified type(s), 0 if
1110  * not, or -1 if the group is invalid.
1111  */
1112 XKB_EXPORT int
1113 xkb_state_layout_index_is_active(struct xkb_state *state,
1114                                 xkb_layout_index_t idx,
1115                                 enum xkb_state_component type)
1116 {
1117     int ret = 0;
1118
1119     if (idx >= state->keymap->num_groups)
1120         return -1;
1121
1122     if (type & XKB_STATE_LAYOUT_EFFECTIVE)
1123         ret |= (state->components.group == idx);
1124     if (type & XKB_STATE_LAYOUT_DEPRESSED)
1125         ret |= (state->components.base_group == (int32_t) idx);
1126     if (type & XKB_STATE_LAYOUT_LATCHED)
1127         ret |= (state->components.latched_group == (int32_t) idx);
1128     if (type & XKB_STATE_LAYOUT_LOCKED)
1129         ret |= (state->components.locked_group == (int32_t) idx);
1130
1131     return ret;
1132 }
1133
1134 /**
1135  * Returns 1 if the given modifier is active with the specified type(s), 0 if
1136  * not, or -1 if the modifier is invalid.
1137  */
1138 XKB_EXPORT int
1139 xkb_state_layout_name_is_active(struct xkb_state *state, const char *name,
1140                                 enum xkb_state_component type)
1141 {
1142     xkb_layout_index_t idx = xkb_keymap_layout_get_index(state->keymap, name);
1143
1144     if (idx == XKB_LAYOUT_INVALID)
1145         return -1;
1146
1147     return xkb_state_layout_index_is_active(state, idx, type);
1148 }
1149
1150 /**
1151  * Returns 1 if the given LED is active, 0 if not, or -1 if the LED is invalid.
1152  */
1153 XKB_EXPORT int
1154 xkb_state_led_index_is_active(struct xkb_state *state, xkb_led_index_t idx)
1155 {
1156     if (idx >= darray_size(state->keymap->leds) ||
1157         darray_item(state->keymap->leds, idx).name == XKB_ATOM_NONE)
1158         return -1;
1159
1160     return !!(state->components.leds & (1u << idx));
1161 }
1162
1163 /**
1164  * Returns 1 if the given LED is active, 0 if not, or -1 if the LED is invalid.
1165  */
1166 XKB_EXPORT int
1167 xkb_state_led_name_is_active(struct xkb_state *state, const char *name)
1168 {
1169     xkb_led_index_t idx = xkb_keymap_led_get_index(state->keymap, name);
1170
1171     if (idx == XKB_LED_INVALID)
1172         return -1;
1173
1174     return xkb_state_led_index_is_active(state, idx);
1175 }
1176
1177 static xkb_mod_mask_t
1178 key_get_consumed(struct xkb_state *state, const struct xkb_key *key)
1179 {
1180     const struct xkb_key_type_entry *entry;
1181     xkb_layout_index_t group;
1182
1183     group = xkb_state_key_get_layout(state, key->keycode);
1184     if (group == XKB_LAYOUT_INVALID)
1185         return 0;
1186
1187     entry = get_entry_for_key_state(state, key, group);
1188     if (!entry)
1189         return 0;
1190
1191     return entry->mods.mask & ~entry->preserve.mask;
1192 }
1193
1194 /**
1195  * Tests to see if a modifier is used up by our translation of a
1196  * keycode to keysyms, taking note of the current modifier state and
1197  * the appropriate key type's preserve information, if any. This allows
1198  * the user to mask out the modifier in later processing of the
1199  * modifiers, e.g. when implementing hot keys or accelerators.
1200  *
1201  * See also, for example:
1202  * - XkbTranslateKeyCode(3), mod_rtrn return value, from libX11.
1203  * - gdk_keymap_translate_keyboard_state, consumed_modifiers return value,
1204  *   from gtk+.
1205  */
1206 XKB_EXPORT int
1207 xkb_state_mod_index_is_consumed(struct xkb_state *state, xkb_keycode_t kc,
1208                                 xkb_mod_index_t idx)
1209 {
1210     const struct xkb_key *key = XkbKey(state->keymap, kc);
1211
1212     if (!key || idx >= xkb_keymap_num_mods(state->keymap))
1213         return -1;
1214
1215     return !!((1u << idx) & key_get_consumed(state, key));
1216 }
1217
1218 /**
1219  * Calculates which modifiers should be consumed during key processing,
1220  * and returns the mask with all these modifiers removed.  e.g. if
1221  * given a state of Alt and Shift active for a two-level alphabetic
1222  * key containing plus and equal on the first and second level
1223  * respectively, will return a mask of only Alt, as Shift has been
1224  * consumed by the type handling.
1225  */
1226 XKB_EXPORT xkb_mod_mask_t
1227 xkb_state_mod_mask_remove_consumed(struct xkb_state *state, xkb_keycode_t kc,
1228                                    xkb_mod_mask_t mask)
1229 {
1230     const struct xkb_key *key = XkbKey(state->keymap, kc);
1231
1232     if (!key)
1233         return 0;
1234
1235     return mask & ~key_get_consumed(state, key);
1236 }
1237
1238 XKB_EXPORT xkb_mod_mask_t
1239 xkb_state_key_get_consumed_mods(struct xkb_state *state, xkb_keycode_t kc)
1240 {
1241     const struct xkb_key *key = XkbKey(state->keymap, kc);
1242
1243     if (!key)
1244         return 0;
1245
1246     return key_get_consumed(state, key);
1247 }