src/x11/keymap.c

   1 /*
   2  * Copyright © 2013 Ran Benita
   3  *
   4  * Permission is hereby granted, free of charge, to any person obtaining a
   5  * copy of this software and associated documentation files (the "Software"),
   6  * to deal in the Software without restriction, including without limitation
   7  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
   8  * and/or sell copies of the Software, and to permit persons to whom the
   9  * Software is furnished to do so, subject to the following conditions:
  10  *
  11  * The above copyright notice and this permission notice (including the next
  12  * paragraph) shall be included in all copies or substantial portions of the
  13  * Software.
  14  *
  15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  18  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  19  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  20  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  21  * DEALINGS IN THE SOFTWARE.
  22  */
  23
  24 #include "x11-priv.h"
  25
  26 /*
  27  * References for the lonesome traveler:
  28  * Xkb protocol specification:
  29  *      http://www.x.org/releases/current/doc/kbproto/xkbproto.html
  30  * The XCB xkb XML protocol file:
  31  *      /user/share/xcb/xkb.xml
  32  * The XCB xkb header file:
  33  *      /usr/include/xcb/xkb.h
  34  * The old kbproto header files:
  35  *      /usr/include/X11/extensions/XKB{,proto,str}.h
  36  * Xlib XKB source code:
  37  *      <libX11>/src/xkb/XKBGetMap.c (and friends)
  38  * X server XKB protocol handling:
  39  *      <xserver>/xkb/xkb.c
  40  * Man pages:
  41  *      XkbGetMap(3), XkbGetCompatMap(3), etc.
  42  */
  43
  44 /* Constants from /usr/include/X11/extensions/XKB.h */
  45 /* XkbNumModifiers. */
  46 #define NUM_REAL_MODS 8u
  47 /* XkbNumVirtualMods. */
  48 #define NUM_VMODS 16u
  49 /* XkbNoModifier. */
  50 #define NO_MODIFIER 0xff
  51 /* XkbNumIndicators. */
  52 #define NUM_INDICATORS 32u
  53 /* XkbAllIndicatorsMask. */
  54 #define ALL_INDICATORS_MASK 0xffffffff
  55
  56 /* Some macros. Not very nice but it'd be worse without them. */
  57
  58 /*
  59  * We try not to trust the server too much and be paranoid. If we get
  60  * something which we definitely shouldn't, we fail.
  61  */
  62 #define STRINGIFY(expr) #expr
  63 #define FAIL_UNLESS(expr) do {                                          \
  64     if (!(expr)) {                                                      \
  65         log_err(keymap->ctx,                                            \
  66                 "x11: failed to get keymap from X server: unmet condition in %s(): %s\n", \
  67                 __func__, STRINGIFY(expr));                             \
  68         goto fail;                                                      \
  69     }                                                                   \
  70 } while (0)
  71
  72 #define FAIL_IF_BAD_REPLY(reply, request_name) do {                     \
  73     if (!reply) {                                                       \
  74         log_err(keymap->ctx,                                            \
  75                 "x11: failed to get keymap from X server: %s request failed\n", \
  76                 (request_name));                                        \
  77         goto fail;                                                      \
  78     }                                                                   \
  79 } while (0)
  80
  81 #define ALLOC_OR_FAIL(arr, nmemb) do {                                  \
  82     if ((nmemb) > 0) {                                                  \
  83         (arr) = calloc((nmemb), sizeof(*(arr)));                        \
  84         if (!(arr))                                                     \
  85             goto fail;                                                  \
  86     }                                                                   \
  87 } while (0)
  88
  89
  90 static xkb_mod_mask_t
  91 translate_mods(uint8_t rmods, uint16_t vmods_low, uint16_t vmods_high)
  92 {
  93     /* We represent mod masks in a single uint32_t value, with real mods
  94      * first and vmods after (though we don't make these distinctions). */
  95     return
  96         ((xkb_mod_mask_t) rmods) |
  97         ((xkb_mod_mask_t) vmods_low << 8) |
  98         ((xkb_mod_mask_t) vmods_high << 16);
  99 }
 100
 101 static enum xkb_action_controls
 102 translate_controls_mask(uint32_t wire)
 103 {
 104     enum xkb_action_controls ret = 0;
 105     if (wire & XCB_XKB_BOOL_CTRL_REPEAT_KEYS)
 106         ret |= CONTROL_REPEAT;
 107     if (wire & XCB_XKB_BOOL_CTRL_SLOW_KEYS)
 108         ret |= CONTROL_SLOW;
 109     if (wire & XCB_XKB_BOOL_CTRL_BOUNCE_KEYS)
 110         ret |= CONTROL_DEBOUNCE;
 111     if (wire & XCB_XKB_BOOL_CTRL_STICKY_KEYS)
 112         ret |= CONTROL_STICKY;
 113     if (wire & XCB_XKB_BOOL_CTRL_MOUSE_KEYS)
 114         ret |= CONTROL_MOUSEKEYS;
 115     if (wire & XCB_XKB_BOOL_CTRL_MOUSE_KEYS_ACCEL)
 116         ret |= CONTROL_MOUSEKEYS_ACCEL;
 117     if (wire & XCB_XKB_BOOL_CTRL_ACCESS_X_KEYS)
 118         ret |= CONTROL_AX;
 119     if (wire & XCB_XKB_BOOL_CTRL_ACCESS_X_TIMEOUT_MASK)
 120         ret |= CONTROL_AX_TIMEOUT;
 121     if (wire & XCB_XKB_BOOL_CTRL_ACCESS_X_FEEDBACK_MASK)
 122         ret |= CONTROL_AX_FEEDBACK;
 123     if (wire & XCB_XKB_BOOL_CTRL_AUDIBLE_BELL_MASK)
 124         ret |= CONTROL_BELL;
 125     if (wire & XCB_XKB_BOOL_CTRL_IGNORE_GROUP_LOCK_MASK)
 126         ret |= CONTROL_IGNORE_GROUP_LOCK;
 127     /* Some controls are not supported and don't appear here. */
 128     return ret;
 129 }
 130
 131 static void
 132 translate_action(union xkb_action *action, const xcb_xkb_action_t *wire)
 133 {
 134     switch (wire->type) {
 135     case XCB_XKB_SA_TYPE_SET_MODS:
 136         action->type = ACTION_TYPE_MOD_SET;
 137
 138         action->mods.mods.mods = translate_mods(wire->setmods.realMods,
 139                                                 wire->setmods.vmodsLow,
 140                                                 wire->setmods.vmodsHigh);
 141         action->mods.mods.mask = translate_mods(wire->setmods.mask, 0, 0);
 142
 143         if (wire->setmods.flags & XCB_XKB_SA_CLEAR_LOCKS)
 144             action->mods.flags |= ACTION_LOCK_CLEAR;
 145         if (wire->setmods.flags & XCB_XKB_SA_LATCH_TO_LOCK)
 146             action->mods.flags |= ACTION_LATCH_TO_LOCK;
 147         if (wire->setmods.flags & XCB_XKB_SA_USE_MOD_MAP_MODS)
 148             action->mods.flags |= ACTION_MODS_LOOKUP_MODMAP;
 149
 150         break;
 151     case XCB_XKB_SA_TYPE_LATCH_MODS:
 152         action->type = ACTION_TYPE_MOD_LATCH;
 153
 154         action->mods.mods.mods = translate_mods(wire->latchmods.realMods,
 155                                                 wire->latchmods.vmodsLow,
 156                                                 wire->latchmods.vmodsHigh);
 157         action->mods.mods.mask = translate_mods(wire->latchmods.mask, 0, 0);
 158
 159         if (wire->latchmods.flags & XCB_XKB_SA_CLEAR_LOCKS)
 160             action->mods.flags |= ACTION_LOCK_CLEAR;
 161         if (wire->latchmods.flags & XCB_XKB_SA_LATCH_TO_LOCK)
 162             action->mods.flags |= ACTION_LATCH_TO_LOCK;
 163         if (wire->latchmods.flags & XCB_XKB_SA_USE_MOD_MAP_MODS)
 164             action->mods.flags |= ACTION_MODS_LOOKUP_MODMAP;
 165
 166         break;
 167     case XCB_XKB_SA_TYPE_LOCK_MODS:
 168         action->type = ACTION_TYPE_MOD_LOCK;
 169
 170         action->mods.mods.mods = translate_mods(wire->lockmods.realMods,
 171                                                 wire->lockmods.vmodsLow,
 172                                                 wire->lockmods.vmodsHigh);
 173         action->mods.mods.mask = translate_mods(wire->lockmods.mask, 0, 0);
 174
 175         if (wire->lockmods.flags & XCB_XKB_SA_ISO_LOCK_FLAG_NO_LOCK)
 176             action->mods.flags |= ACTION_LOCK_NO_LOCK;
 177         if (wire->lockmods.flags & XCB_XKB_SA_ISO_LOCK_FLAG_NO_UNLOCK)
 178             action->mods.flags |= ACTION_LOCK_NO_UNLOCK;
 179         if (wire->lockmods.flags & XCB_XKB_SA_USE_MOD_MAP_MODS)
 180             action->mods.flags |= ACTION_MODS_LOOKUP_MODMAP;
 181
 182         break;
 183     case XCB_XKB_SA_TYPE_SET_GROUP:
 184         action->type = ACTION_TYPE_GROUP_SET;
 185
 186         action->group.group = wire->setgroup.group;
 187
 188         if (wire->setmods.flags & XCB_XKB_SA_CLEAR_LOCKS)
 189             action->group.flags |= ACTION_LOCK_CLEAR;
 190         if (wire->setmods.flags & XCB_XKB_SA_LATCH_TO_LOCK)
 191             action->group.flags |= ACTION_LATCH_TO_LOCK;
 192         if (wire->setmods.flags & XCB_XKB_SA_ISO_LOCK_FLAG_GROUP_ABSOLUTE)
 193             action->group.flags |= ACTION_ABSOLUTE_SWITCH;
 194
 195         break;
 196     case XCB_XKB_SA_TYPE_LATCH_GROUP:
 197         action->type = ACTION_TYPE_GROUP_LATCH;
 198
 199         action->group.group = wire->latchgroup.group;
 200
 201         if (wire->latchmods.flags & XCB_XKB_SA_CLEAR_LOCKS)
 202             action->group.flags |= ACTION_LOCK_CLEAR;
 203         if (wire->latchmods.flags & XCB_XKB_SA_LATCH_TO_LOCK)
 204             action->group.flags |= ACTION_LATCH_TO_LOCK;
 205         if (wire->latchmods.flags & XCB_XKB_SA_ISO_LOCK_FLAG_GROUP_ABSOLUTE)
 206             action->group.flags |= ACTION_ABSOLUTE_SWITCH;
 207
 208         break;
 209     case XCB_XKB_SA_TYPE_LOCK_GROUP:
 210         action->type = ACTION_TYPE_GROUP_LOCK;
 211
 212         action->group.group = wire->lockgroup.group;
 213
 214         if (wire->lockgroup.flags & XCB_XKB_SA_ISO_LOCK_FLAG_GROUP_ABSOLUTE)
 215             action->group.flags |= ACTION_ABSOLUTE_SWITCH;
 216
 217         break;
 218     case XCB_XKB_SA_TYPE_MOVE_PTR:
 219         action->type = ACTION_TYPE_PTR_MOVE;
 220
 221         action->ptr.x = (wire->moveptr.xLow | (wire->moveptr.xHigh << 8));
 222         action->ptr.y = (wire->moveptr.yLow | (wire->moveptr.yHigh << 8));
 223
 224         if (!(wire->moveptr.flags & XCB_XKB_SA_MOVE_PTR_FLAG_NO_ACCELERATION))
 225             action->ptr.flags |= ACTION_ACCEL;
 226         if (wire->moveptr.flags & XCB_XKB_SA_MOVE_PTR_FLAG_MOVE_ABSOLUTE_X)
 227             action->ptr.flags |= ACTION_ABSOLUTE_X;
 228         if (wire->moveptr.flags & XCB_XKB_SA_MOVE_PTR_FLAG_MOVE_ABSOLUTE_Y)
 229             action->ptr.flags |= ACTION_ABSOLUTE_Y;
 230
 231         break;
 232     case XCB_XKB_SA_TYPE_PTR_BTN:
 233         action->type = ACTION_TYPE_PTR_BUTTON;
 234
 235         action->btn.count = wire->ptrbtn.count;
 236         action->btn.button = wire->ptrbtn.button;
 237         action->btn.flags = 0;
 238
 239         break;
 240     case XCB_XKB_SA_TYPE_LOCK_PTR_BTN:
 241         action->type = ACTION_TYPE_PTR_LOCK;
 242
 243         action->btn.button = wire->lockptrbtn.button;
 244
 245         if (wire->lockptrbtn.flags & XCB_XKB_SA_ISO_LOCK_FLAG_NO_LOCK)
 246             action->btn.flags |= ACTION_LOCK_NO_LOCK;
 247         if (wire->lockptrbtn.flags & XCB_XKB_SA_ISO_LOCK_FLAG_NO_UNLOCK)
 248             action->btn.flags |= ACTION_LOCK_NO_UNLOCK;
 249
 250         break;
 251     case XCB_XKB_SA_TYPE_SET_PTR_DFLT:
 252         action->type = ACTION_TYPE_PTR_DEFAULT;
 253
 254         action->dflt.value = wire->setptrdflt.value;
 255
 256         if (wire->setptrdflt.flags & XCB_XKB_SA_SET_PTR_DFLT_FLAG_DFLT_BTN_ABSOLUTE)
 257             action->dflt.flags |= ACTION_ABSOLUTE_SWITCH;
 258
 259         break;
 260     case XCB_XKB_SA_TYPE_TERMINATE:
 261         action->type = ACTION_TYPE_TERMINATE;
 262
 263         break;
 264     case XCB_XKB_SA_TYPE_SWITCH_SCREEN:
 265         action->type = ACTION_TYPE_SWITCH_VT;
 266
 267         action->screen.screen = wire->switchscreen.newScreen;
 268
 269         if (!(wire->switchscreen.flags & XCB_XKB_SWITCH_SCREEN_FLAG_APPLICATION))
 270             action->screen.flags |= ACTION_SAME_SCREEN;
 271         if (wire->switchscreen.flags & XCB_XKB_SWITCH_SCREEN_FLAG_ABSOLUTE)
 272             action->screen.flags |= ACTION_ABSOLUTE_SWITCH;
 273
 274         break;
 275     case XCB_XKB_SA_TYPE_SET_CONTROLS:
 276         action->type = ACTION_TYPE_CTRL_SET;
 277         {
 278             const uint16_t mask = (wire->setcontrols.boolCtrlsLow |
 279                                    (wire->setcontrols.boolCtrlsHigh << 8));
 280             action->ctrls.ctrls = translate_controls_mask(mask);
 281         }
 282         break;
 283     case XCB_XKB_SA_TYPE_LOCK_CONTROLS:
 284         action->type = ACTION_TYPE_CTRL_LOCK;
 285         {
 286             const uint16_t mask = (wire->lockcontrols.boolCtrlsLow |
 287                                    (wire->lockcontrols.boolCtrlsHigh << 8));
 288             action->ctrls.ctrls = translate_controls_mask(mask);
 289         }
 290         break;
 291
 292     case XCB_XKB_SA_TYPE_NO_ACTION:
 293     /* We don't support these. */
 294     case XCB_XKB_SA_TYPE_ISO_LOCK:
 295     case XCB_XKB_SA_TYPE_REDIRECT_KEY:
 296     case XCB_XKB_SA_TYPE_ACTION_MESSAGE:
 297     case XCB_XKB_SA_TYPE_DEVICE_BTN:
 298     case XCB_XKB_SA_TYPE_LOCK_DEVICE_BTN:
 299     case XCB_XKB_SA_TYPE_DEVICE_VALUATOR:
 300         action->type = ACTION_TYPE_NONE;
 301         break;
 302     }
 303 }
 304
 305 static bool
 306 get_types(struct xkb_keymap *keymap, xcb_connection_t *conn,
 307           xcb_xkb_get_map_reply_t *reply, xcb_xkb_get_map_map_t *map)
 308 {
 309     int types_length = xcb_xkb_get_map_map_types_rtrn_length(reply, map);
 310     xcb_xkb_key_type_iterator_t types_iter =
 311         xcb_xkb_get_map_map_types_rtrn_iterator(reply, map);
 312
 313     FAIL_UNLESS(reply->firstType == 0);
 314
 315     keymap->num_types = reply->nTypes;
 316     ALLOC_OR_FAIL(keymap->types, keymap->num_types);
 317
 318     for (int i = 0; i < types_length; i++) {
 319         xcb_xkb_key_type_t *wire_type = types_iter.data;
 320         struct xkb_key_type *type = &keymap->types[i];
 321
 322         FAIL_UNLESS(wire_type->numLevels > 0);
 323
 324         type->mods.mods = translate_mods(wire_type->mods_mods,
 325                                          wire_type->mods_vmods, 0);
 326         type->mods.mask = translate_mods(wire_type->mods_mask, 0, 0);
 327         type->num_levels = wire_type->numLevels;
 328
 329         {
 330             int entries_length = xcb_xkb_key_type_map_length(wire_type);
 331             xcb_xkb_kt_map_entry_iterator_t entries_iter =
 332                 xcb_xkb_key_type_map_iterator(wire_type);
 333
 334             type->num_entries = wire_type->nMapEntries;
 335             ALLOC_OR_FAIL(type->entries, type->num_entries);
 336
 337             for (int j = 0; j < entries_length; j++) {
 338                 xcb_xkb_kt_map_entry_t *wire_entry = entries_iter.data;
 339                 struct xkb_key_type_entry *entry = &type->entries[j];
 340
 341                 FAIL_UNLESS(wire_entry->level < type->num_levels);
 342
 343                 entry->level = wire_entry->level;
 344                 entry->mods.mods = translate_mods(wire_entry->mods_mods,
 345                                                   wire_entry->mods_vmods, 0);
 346                 entry->mods.mask = translate_mods(wire_entry->mods_mask, 0, 0);
 347
 348                 xcb_xkb_kt_map_entry_next(&entries_iter);
 349             }
 350         }
 351
 352         {
 353             int preserves_length = xcb_xkb_key_type_preserve_length(wire_type);
 354             xcb_xkb_mod_def_iterator_t preserves_iter =
 355                 xcb_xkb_key_type_preserve_iterator(wire_type);
 356
 357             FAIL_UNLESS((unsigned) preserves_length <= type->num_entries);
 358
 359             for (int j = 0; j < preserves_length; j++) {
 360                 xcb_xkb_mod_def_t *wire_preserve = preserves_iter.data;
 361                 struct xkb_key_type_entry *entry = &type->entries[j];
 362
 363                 entry->preserve.mods = translate_mods(wire_preserve->realMods,
 364                                                       wire_preserve->vmods, 0);
 365                 entry->preserve.mask = translate_mods(wire_preserve->mask, 0, 0);
 366
 367                 xcb_xkb_mod_def_next(&preserves_iter);
 368             }
 369         }
 370
 371         xcb_xkb_key_type_next(&types_iter);
 372     }
 373
 374     return true;
 375
 376 fail:
 377     return false;
 378 }
 379
 380 static bool
 381 get_sym_maps(struct xkb_keymap *keymap, xcb_connection_t *conn,
 382              xcb_xkb_get_map_reply_t *reply, xcb_xkb_get_map_map_t *map)
 383 {
 384     int sym_maps_length = xcb_xkb_get_map_map_syms_rtrn_length(reply, map);
 385     xcb_xkb_key_sym_map_iterator_t sym_maps_iter =
 386         xcb_xkb_get_map_map_syms_rtrn_iterator(reply, map);
 387
 388     FAIL_UNLESS(reply->minKeyCode <= reply->maxKeyCode);
 389     FAIL_UNLESS(reply->firstKeySym >= reply->minKeyCode);
 390     FAIL_UNLESS(reply->firstKeySym + reply->nKeySyms <= reply->maxKeyCode + 1);
 391
 392     keymap->min_key_code = reply->minKeyCode;
 393     keymap->max_key_code = reply->maxKeyCode;
 394
 395     ALLOC_OR_FAIL(keymap->keys, keymap->max_key_code + 1);
 396
 397     for (xkb_keycode_t kc = keymap->min_key_code; kc <= keymap->max_key_code; kc++)
 398         keymap->keys[kc].keycode = kc;
 399
 400     for (int i = 0; i < sym_maps_length; i++) {
 401         xcb_xkb_key_sym_map_t *wire_sym_map = sym_maps_iter.data;
 402         struct xkb_key *key = &keymap->keys[reply->firstKeySym + i];
 403
 404         key->num_groups = wire_sym_map->groupInfo & 0x0f;
 405         FAIL_UNLESS(key->num_groups <= ARRAY_SIZE(wire_sym_map->kt_index));
 406         ALLOC_OR_FAIL(key->groups, key->num_groups);
 407
 408         for (unsigned j = 0; j < key->num_groups; j++) {
 409             FAIL_UNLESS(wire_sym_map->kt_index[j] < keymap->num_types);
 410             key->groups[j].type = &keymap->types[wire_sym_map->kt_index[j]];
 411
 412             ALLOC_OR_FAIL(key->groups[j].levels, key->groups[j].type->num_levels);
 413         }
 414
 415         key->out_of_range_group_number = (wire_sym_map->groupInfo & 0x30) >> 4;
 416
 417         FAIL_UNLESS(key->out_of_range_group_number <= key->num_groups);
 418
 419         if (wire_sym_map->groupInfo & XCB_XKB_GROUPS_WRAP_CLAMP_INTO_RANGE)
 420             key->out_of_range_group_action = RANGE_SATURATE;
 421         else if (wire_sym_map->groupInfo & XCB_XKB_GROUPS_WRAP_REDIRECT_INTO_RANGE)
 422             key->out_of_range_group_action = RANGE_REDIRECT;
 423         else
 424             key->out_of_range_group_action = RANGE_WRAP;
 425
 426         {
 427             int syms_length = xcb_xkb_key_sym_map_syms_length(wire_sym_map);
 428             xcb_keysym_t *syms_iter = xcb_xkb_key_sym_map_syms(wire_sym_map);
 429
 430             FAIL_UNLESS((unsigned) syms_length == wire_sym_map->width * key->num_groups);
 431
 432             for (int j = 0; j < syms_length; j++) {
 433                 xcb_keysym_t wire_keysym = *syms_iter;
 434                 const xkb_layout_index_t group = j / wire_sym_map->width;
 435                 const xkb_level_index_t level = j % wire_sym_map->width;
 436
 437                 if (level < key->groups[group].type->num_levels &&
 438                     wire_keysym != XKB_KEY_NoSymbol) {
 439                     key->groups[group].levels[level].num_syms = 1;
 440                     key->groups[group].levels[level].u.sym = wire_keysym;
 441                 }
 442
 443                 syms_iter++;
 444             }
 445         }
 446
 447         xcb_xkb_key_sym_map_next(&sym_maps_iter);
 448     }
 449
 450     return true;
 451
 452 fail:
 453     return false;
 454 }
 455
 456 static bool
 457 get_actions(struct xkb_keymap *keymap, xcb_connection_t *conn,
 458             xcb_xkb_get_map_reply_t *reply, xcb_xkb_get_map_map_t *map)
 459 {
 460     int acts_count_length =
 461         xcb_xkb_get_map_map_acts_rtrn_count_length(reply, map);
 462     uint8_t *acts_count_iter = xcb_xkb_get_map_map_acts_rtrn_count(map);
 463     xcb_xkb_action_iterator_t acts_iter =
 464         xcb_xkb_get_map_map_acts_rtrn_acts_iterator(reply, map);
 465     xcb_xkb_key_sym_map_iterator_t sym_maps_iter =
 466         xcb_xkb_get_map_map_syms_rtrn_iterator(reply, map);
 467
 468     FAIL_UNLESS(reply->firstKeyAction == keymap->min_key_code);
 469     FAIL_UNLESS(reply->firstKeyAction + reply->nKeyActions ==
 470                 keymap->max_key_code + 1);
 471
 472     for (int i = 0; i < acts_count_length; i++) {
 473         xcb_xkb_key_sym_map_t *wire_sym_map = sym_maps_iter.data;
 474         int syms_length = xcb_xkb_key_sym_map_syms_length(wire_sym_map);
 475         uint8_t wire_count = *acts_count_iter;
 476         struct xkb_key *key = &keymap->keys[reply->firstKeyAction + i];
 477
 478         FAIL_UNLESS(wire_count == 0 || wire_count == syms_length);
 479
 480         for (int j = 0; j < wire_count; j++) {
 481             xcb_xkb_action_t *wire_action = acts_iter.data;
 482             const xkb_layout_index_t group = j / wire_sym_map->width;
 483             const xkb_level_index_t level = j % wire_sym_map->width;
 484
 485             if (level < key->groups[group].type->num_levels) {
 486                 union xkb_action *action =
 487                     &key->groups[group].levels[level].action;
 488
 489                 translate_action(action, wire_action);
 490             }
 491
 492             xcb_xkb_action_next(&acts_iter);
 493         }
 494
 495         acts_count_iter++;
 496         xcb_xkb_key_sym_map_next(&sym_maps_iter);
 497     }
 498
 499     return true;
 500
 501 fail:
 502     return false;
 503 }
 504
 505 static bool
 506 get_vmods(struct xkb_keymap *keymap, xcb_connection_t *conn,
 507           xcb_xkb_get_map_reply_t *reply, xcb_xkb_get_map_map_t *map)
 508 {
 509     uint8_t *iter = xcb_xkb_get_map_map_vmods_rtrn(map);
 510
 511     keymap->mods.num_mods = NUM_REAL_MODS + msb_pos(reply->virtualMods);
 512
 513     for (unsigned i = 0; i < NUM_VMODS; i++) {
 514         if (reply->virtualMods & (1u << i)) {
 515             uint8_t wire = *iter;
 516             struct xkb_mod *mod = &keymap->mods.mods[NUM_REAL_MODS + i];
 517
 518             mod->type = MOD_VIRT;
 519             mod->mapping = translate_mods(wire, 0, 0);
 520
 521             iter++;
 522         }
 523     }
 524
 525     return true;
 526 }
 527
 528 static bool
 529 get_explicits(struct xkb_keymap *keymap, xcb_connection_t *conn,
 530               xcb_xkb_get_map_reply_t *reply, xcb_xkb_get_map_map_t *map)
 531 {
 532     int length = xcb_xkb_get_map_map_explicit_rtrn_length(reply, map);
 533     xcb_xkb_set_explicit_iterator_t iter =
 534         xcb_xkb_get_map_map_explicit_rtrn_iterator(reply, map);
 535
 536     for (int i = 0; i < length; i++) {
 537         xcb_xkb_set_explicit_t *wire = iter.data;
 538         struct xkb_key *key;
 539
 540         FAIL_UNLESS(wire->keycode >= keymap->min_key_code &&
 541                     wire->keycode <= keymap->max_key_code);
 542
 543         key = &keymap->keys[wire->keycode];
 544
 545         if ((wire->explicit & XCB_XKB_EXPLICIT_KEY_TYPE_1) &&
 546             key->num_groups > 0)
 547             key->groups[0].explicit_type = true;
 548         if ((wire->explicit & XCB_XKB_EXPLICIT_KEY_TYPE_2) &&
 549             key->num_groups > 1)
 550             key->groups[1].explicit_type = true;
 551         if ((wire->explicit & XCB_XKB_EXPLICIT_KEY_TYPE_3) &&
 552             key->num_groups > 2)
 553             key->groups[2].explicit_type = true;
 554         if ((wire->explicit & XCB_XKB_EXPLICIT_KEY_TYPE_4) &&
 555             key->num_groups > 3)
 556             key->groups[3].explicit_type = true;
 557         if (wire->explicit & XCB_XKB_EXPLICIT_INTERPRET)
 558             key->explicit |= EXPLICIT_INTERP;
 559         if (wire->explicit & XCB_XKB_EXPLICIT_AUTO_REPEAT)
 560             key->explicit |= EXPLICIT_REPEAT;
 561         if (wire->explicit & XCB_XKB_EXPLICIT_V_MOD_MAP)
 562             key->explicit |= EXPLICIT_VMODMAP;
 563
 564         xcb_xkb_set_explicit_next(&iter);
 565     }
 566
 567     return true;
 568
 569 fail:
 570     return false;
 571 }
 572
 573 static bool
 574 get_modmaps(struct xkb_keymap *keymap, xcb_connection_t *conn,
 575             xcb_xkb_get_map_reply_t *reply, xcb_xkb_get_map_map_t *map)
 576 {
 577     int length = xcb_xkb_get_map_map_modmap_rtrn_length(reply, map);
 578     xcb_xkb_key_mod_map_iterator_t iter =
 579         xcb_xkb_get_map_map_modmap_rtrn_iterator(reply, map);
 580
 581     for (int i = 0; i < length; i++) {
 582         xcb_xkb_key_mod_map_t *wire = iter.data;
 583         struct xkb_key *key;
 584
 585         FAIL_UNLESS(wire->keycode >= keymap->min_key_code &&
 586                     wire->keycode <= keymap->max_key_code);
 587
 588         key = &keymap->keys[wire->keycode];
 589         key->modmap = wire->mods;
 590
 591         xcb_xkb_key_mod_map_next(&iter);
 592     }
 593
 594     return true;
 595
 596 fail:
 597     return false;
 598 }
 599
 600 static bool
 601 get_vmodmaps(struct xkb_keymap *keymap, xcb_connection_t *conn,
 602              xcb_xkb_get_map_reply_t *reply, xcb_xkb_get_map_map_t *map)
 603 {
 604     int length = xcb_xkb_get_map_map_vmodmap_rtrn_length(reply, map);
 605     xcb_xkb_key_v_mod_map_iterator_t iter =
 606         xcb_xkb_get_map_map_vmodmap_rtrn_iterator(reply, map);
 607
 608     for (int i = 0; i < length; i++) {
 609         xcb_xkb_key_v_mod_map_t *wire = iter.data;
 610         struct xkb_key *key;
 611
 612         FAIL_UNLESS(wire->keycode >= keymap->min_key_code &&
 613                     wire->keycode <= keymap->max_key_code);
 614
 615         key = &keymap->keys[wire->keycode];
 616         key->vmodmap = translate_mods(0, wire->vmods, 0);
 617
 618         xcb_xkb_key_v_mod_map_next(&iter);
 619     }
 620
 621     return true;
 622
 623 fail:
 624     return false;
 625 }
 626
 627 static bool
 628 get_map(struct xkb_keymap *keymap, xcb_connection_t *conn, uint16_t device_id)
 629 {
 630     static const xcb_xkb_map_part_t required_components =
 631         (XCB_XKB_MAP_PART_KEY_TYPES |
 632          XCB_XKB_MAP_PART_KEY_SYMS |
 633          XCB_XKB_MAP_PART_MODIFIER_MAP |
 634          XCB_XKB_MAP_PART_EXPLICIT_COMPONENTS |
 635          XCB_XKB_MAP_PART_KEY_ACTIONS |
 636          XCB_XKB_MAP_PART_VIRTUAL_MODS |
 637          XCB_XKB_MAP_PART_VIRTUAL_MOD_MAP);
 638
 639     xcb_xkb_get_map_cookie_t cookie =
 640         xcb_xkb_get_map(conn, device_id, required_components,
 641                         0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0);
 642     xcb_xkb_get_map_reply_t *reply = xcb_xkb_get_map_reply(conn, cookie, NULL);
 643     xcb_xkb_get_map_map_t map;
 644
 645     FAIL_IF_BAD_REPLY(reply, "XkbGetMap");
 646
 647     if ((reply->present & required_components) != required_components)
 648         goto fail;
 649
 650     xcb_xkb_get_map_map_unpack(xcb_xkb_get_map_map(reply),
 651                                reply->nTypes,
 652                                reply->nKeySyms,
 653                                reply->nKeyActions,
 654                                reply->totalActions,
 655                                reply->totalKeyBehaviors,
 656                                reply->virtualMods,
 657                                reply->totalKeyExplicit,
 658                                reply->totalModMapKeys,
 659                                reply->totalVModMapKeys,
 660                                reply->present,
 661                                &map);
 662
 663     if (!get_types(keymap, conn, reply, &map) ||
 664         !get_sym_maps(keymap, conn, reply, &map) ||
 665         !get_actions(keymap, conn, reply, &map) ||
 666         !get_vmods(keymap, conn, reply, &map) ||
 667         !get_explicits(keymap, conn, reply, &map) ||
 668         !get_modmaps(keymap, conn, reply, &map) ||
 669         !get_vmodmaps(keymap, conn, reply, &map))
 670         goto fail;
 671
 672     free(reply);
 673     return true;
 674
 675 fail:
 676     free(reply);
 677     return false;
 678 }
 679
 680 static bool
 681 get_indicators(struct xkb_keymap *keymap, xcb_connection_t *conn,
 682                xcb_xkb_get_indicator_map_reply_t *reply)
 683 {
 684     xcb_xkb_indicator_map_iterator_t iter =
 685         xcb_xkb_get_indicator_map_maps_iterator(reply);
 686
 687     keymap->num_leds = msb_pos(reply->which);
 688
 689     for (unsigned i = 0; i < NUM_INDICATORS; i++) {
 690         if (reply->which & (1u << i)) {
 691             xcb_xkb_indicator_map_t *wire = iter.data;
 692             struct xkb_led *led = &keymap->leds[i];
 693
 694             if (wire->whichGroups & XCB_XKB_IM_GROUPS_WHICH_USE_BASE)
 695                 led->which_groups |= XKB_STATE_LAYOUT_DEPRESSED;
 696             if (wire->whichGroups & XCB_XKB_IM_GROUPS_WHICH_USE_LATCHED)
 697                 led->which_groups |= XKB_STATE_LAYOUT_LATCHED;
 698             if (wire->whichGroups & XCB_XKB_IM_GROUPS_WHICH_USE_LOCKED)
 699                 led->which_groups |= XKB_STATE_LAYOUT_LOCKED;
 700             if (wire->whichGroups & XCB_XKB_IM_GROUPS_WHICH_USE_EFFECTIVE)
 701                 led->which_groups |= XKB_STATE_LAYOUT_EFFECTIVE;
 702             if (wire->whichGroups & XCB_XKB_IM_GROUPS_WHICH_USE_COMPAT)
 703                 led->which_groups |= XKB_STATE_LAYOUT_EFFECTIVE;
 704
 705             led->groups = wire->groups;
 706
 707             if (wire->whichMods & XCB_XKB_IM_MODS_WHICH_USE_BASE)
 708                 led->which_mods |= XKB_STATE_MODS_DEPRESSED;
 709             if (wire->whichMods & XCB_XKB_IM_MODS_WHICH_USE_LATCHED)
 710                 led->which_mods |= XKB_STATE_MODS_LATCHED;
 711             if (wire->whichMods & XCB_XKB_IM_MODS_WHICH_USE_LOCKED)
 712                 led->which_mods |= XKB_STATE_MODS_LOCKED;
 713             if (wire->whichMods & XCB_XKB_IM_MODS_WHICH_USE_EFFECTIVE)
 714                 led->which_mods |= XKB_STATE_MODS_EFFECTIVE;
 715             if (wire->whichMods & XCB_XKB_IM_MODS_WHICH_USE_COMPAT)
 716                 led->which_mods |= XKB_STATE_MODS_EFFECTIVE;
 717
 718             led->mods.mods = translate_mods(wire->realMods, wire->vmods, 0);
 719             led->mods.mask = translate_mods(wire->mods, 0, 0);
 720
 721             led->ctrls = translate_controls_mask(wire->ctrls);
 722
 723             xcb_xkb_indicator_map_next(&iter);
 724         }
 725     }
 726
 727     return true;
 728 }
 729
 730 static bool
 731 get_indicator_map(struct xkb_keymap *keymap, xcb_connection_t *conn,
 732                   uint16_t device_id)
 733 {
 734     xcb_xkb_get_indicator_map_cookie_t cookie =
 735         xcb_xkb_get_indicator_map(conn, device_id, ALL_INDICATORS_MASK);
 736     xcb_xkb_get_indicator_map_reply_t *reply =
 737         xcb_xkb_get_indicator_map_reply(conn, cookie, NULL);
 738
 739     FAIL_IF_BAD_REPLY(reply, "XkbGetIndicatorMap");
 740
 741     if (!get_indicators(keymap, conn, reply))
 742         goto fail;
 743
 744     free(reply);
 745     return true;
 746
 747 fail:
 748     free(reply);
 749     return false;
 750 }
 751
 752 static bool
 753 get_sym_interprets(struct xkb_keymap *keymap, xcb_connection_t *conn,
 754                    xcb_xkb_get_compat_map_reply_t *reply)
 755 {
 756     int length = xcb_xkb_get_compat_map_si_rtrn_length(reply);
 757     xcb_xkb_sym_interpret_iterator_t iter =
 758         xcb_xkb_get_compat_map_si_rtrn_iterator(reply);
 759
 760     FAIL_UNLESS(reply->firstSIRtrn == 0);
 761     FAIL_UNLESS(reply->nSIRtrn == reply->nTotalSI);
 762
 763     keymap->num_sym_interprets = reply->nSIRtrn;
 764     ALLOC_OR_FAIL(keymap->sym_interprets, keymap->num_sym_interprets);
 765
 766     for (int i = 0; i < length; i++) {
 767         xcb_xkb_sym_interpret_t *wire = iter.data;
 768         struct xkb_sym_interpret *sym_interpret = &keymap->sym_interprets[i];
 769
 770         sym_interpret->sym = wire->sym;
 771
 772         switch (wire->match & XCB_XKB_SYM_INTERP_MATCH_OP_MASK) {
 773         case XCB_XKB_SYM_INTERPRET_MATCH_NONE_OF:
 774             sym_interpret->match = MATCH_NONE;
 775             break;
 776         case XCB_XKB_SYM_INTERPRET_MATCH_ANY_OF_OR_NONE:
 777             sym_interpret->match = MATCH_ANY_OR_NONE;
 778             break;
 779         case XCB_XKB_SYM_INTERPRET_MATCH_ANY_OF:
 780             sym_interpret->match = MATCH_ANY;
 781             break;
 782         case XCB_XKB_SYM_INTERPRET_MATCH_ALL_OF:
 783             sym_interpret->match = MATCH_ALL;
 784             break;
 785         case XCB_XKB_SYM_INTERPRET_MATCH_EXACTLY:
 786             sym_interpret->match = MATCH_EXACTLY;
 787             break;
 788         }
 789
 790         sym_interpret->level_one_only =
 791             (wire->match & XCB_XKB_SYM_INTERP_MATCH_LEVEL_ONE_ONLY);
 792         sym_interpret->mods = wire->mods;
 793
 794         if (wire->virtualMod == NO_MODIFIER)
 795             sym_interpret->virtual_mod = XKB_MOD_INVALID;
 796         else
 797             sym_interpret->virtual_mod = NUM_REAL_MODS + wire->virtualMod;
 798
 799         sym_interpret->repeat = (wire->flags & 0x01);
 800         translate_action(&sym_interpret->action,
 801                          (xcb_xkb_action_t *) &wire->action);
 802
 803         xcb_xkb_sym_interpret_next(&iter);
 804     }
 805
 806     return true;
 807
 808 fail:
 809     return false;
 810 }
 811
 812 static bool
 813 get_compat_map(struct xkb_keymap *keymap, xcb_connection_t *conn,
 814                uint16_t device_id)
 815 {
 816     xcb_xkb_get_compat_map_cookie_t cookie =
 817         xcb_xkb_get_compat_map(conn, device_id, 0, true, 0, 0);
 818     xcb_xkb_get_compat_map_reply_t *reply =
 819         xcb_xkb_get_compat_map_reply(conn, cookie, NULL);
 820
 821     FAIL_IF_BAD_REPLY(reply, "XkbGetCompatMap");
 822
 823     if (!get_sym_interprets(keymap, conn, reply))
 824         goto fail;
 825
 826     free(reply);
 827     return true;
 828
 829 fail:
 830     free(reply);
 831     return false;
 832 }
 833
 834 static bool
 835 get_type_names(struct xkb_keymap *keymap, xcb_connection_t *conn,
 836                xcb_xkb_get_names_reply_t *reply,
 837                xcb_xkb_get_names_value_list_t *list)
 838 {
 839     int key_type_names_length =
 840         xcb_xkb_get_names_value_list_type_names_length(reply, list);
 841     xcb_atom_t *key_type_names_iter =
 842         xcb_xkb_get_names_value_list_type_names(list);
 843     int n_levels_per_type_length =
 844         xcb_xkb_get_names_value_list_n_levels_per_type_length(reply, list);
 845     uint8_t *n_levels_per_type_iter =
 846         xcb_xkb_get_names_value_list_n_levels_per_type(list);
 847     xcb_atom_t *kt_level_names_iter =
 848         xcb_xkb_get_names_value_list_kt_level_names(list);
 849
 850     FAIL_UNLESS(reply->nTypes == keymap->num_types);
 851     FAIL_UNLESS(key_type_names_length == n_levels_per_type_length);
 852
 853     for (int i = 0; i < key_type_names_length; i++) {
 854         xcb_atom_t wire_type_name = *key_type_names_iter;
 855         uint8_t wire_num_levels = *n_levels_per_type_iter;
 856         struct xkb_key_type *type = &keymap->types[i];
 857
 858         /* Levels must have names. */
 859         FAIL_UNLESS(type->num_levels == wire_num_levels);
 860
 861         ALLOC_OR_FAIL(type->level_names, type->num_levels);
 862
 863         if (!adopt_atom(keymap->ctx, conn, wire_type_name, &type->name))
 864             goto fail;
 865
 866         if (!adopt_atoms(keymap->ctx, conn,
 867                          kt_level_names_iter, type->level_names,
 868                          wire_num_levels))
 869             goto fail;
 870
 871         kt_level_names_iter += wire_num_levels;
 872         key_type_names_iter++;
 873         n_levels_per_type_iter++;
 874     }
 875
 876     return true;
 877
 878 fail:
 879     return false;
 880 }
 881
 882 static bool
 883 get_indicator_names(struct xkb_keymap *keymap, xcb_connection_t *conn,
 884                     xcb_xkb_get_names_reply_t *reply,
 885                     xcb_xkb_get_names_value_list_t *list)
 886 {
 887     xcb_atom_t *iter = xcb_xkb_get_names_value_list_indicator_names(list);
 888
 889     FAIL_UNLESS(msb_pos(reply->indicators) <= keymap->num_leds);
 890
 891     for (unsigned i = 0; i < NUM_INDICATORS; i++) {
 892         if (reply->indicators & (1u << i)) {
 893             xcb_atom_t wire = *iter;
 894             struct xkb_led *led = &keymap->leds[i];
 895
 896             if (!adopt_atom(keymap->ctx, conn, wire, &led->name))
 897                 return false;
 898
 899             iter++;
 900         }
 901     }
 902
 903     return true;
 904
 905 fail:
 906     return false;
 907 }
 908
 909 static bool
 910 get_vmod_names(struct xkb_keymap *keymap, xcb_connection_t *conn,
 911                xcb_xkb_get_names_reply_t *reply,
 912                xcb_xkb_get_names_value_list_t *list)
 913 {
 914     xcb_atom_t *iter = xcb_xkb_get_names_value_list_virtual_mod_names(list);
 915
 916     /*
 917      * GetMap's reply->virtualMods is always 0xffff. This one really
 918      * tells us which vmods exist (a vmod must have a name), so we fix
 919      * up the size here.
 920      */
 921     keymap->mods.num_mods = NUM_REAL_MODS + msb_pos(reply->virtualMods);
 922
 923     for (unsigned i = 0; i < NUM_VMODS; i++) {
 924         if (reply->virtualMods & (1u << i)) {
 925             xcb_atom_t wire = *iter;
 926             struct xkb_mod *mod = &keymap->mods.mods[NUM_REAL_MODS + i];
 927
 928             if (!adopt_atom(keymap->ctx, conn, wire, &mod->name))
 929                 return false;
 930
 931             iter++;
 932         }
 933     }
 934
 935     return true;
 936 }
 937
 938 static bool
 939 get_group_names(struct xkb_keymap *keymap, xcb_connection_t *conn,
 940                 xcb_xkb_get_names_reply_t *reply,
 941                 xcb_xkb_get_names_value_list_t *list)
 942 {
 943     int length = xcb_xkb_get_names_value_list_groups_length(reply, list);
 944     xcb_atom_t *iter = xcb_xkb_get_names_value_list_groups(list);
 945
 946     keymap->num_group_names = msb_pos(reply->groupNames);
 947     ALLOC_OR_FAIL(keymap->group_names, keymap->num_group_names);
 948
 949     if (!adopt_atoms(keymap->ctx, conn,
 950                      iter, keymap->group_names, length))
 951         goto fail;
 952
 953     return true;
 954
 955 fail:
 956     return false;
 957 }
 958
 959 static bool
 960 get_key_names(struct xkb_keymap *keymap, xcb_connection_t *conn,
 961               xcb_xkb_get_names_reply_t *reply,
 962               xcb_xkb_get_names_value_list_t *list)
 963 {
 964     int length = xcb_xkb_get_names_value_list_key_names_length(reply, list);
 965     xcb_xkb_key_name_iterator_t iter =
 966         xcb_xkb_get_names_value_list_key_names_iterator(reply, list);
 967
 968     FAIL_UNLESS(reply->minKeyCode == keymap->min_key_code);
 969     FAIL_UNLESS(reply->maxKeyCode == keymap->max_key_code);
 970     FAIL_UNLESS(reply->firstKey == keymap->min_key_code);
 971     FAIL_UNLESS(reply->firstKey + reply->nKeys - 1U == keymap->max_key_code);
 972
 973     for (int i = 0; i < length; i++) {
 974         xcb_xkb_key_name_t *wire = iter.data;
 975         xkb_atom_t *key_name = &keymap->keys[reply->firstKey + i].name;
 976
 977         if (wire->name[0] == '\0') {
 978             *key_name = XKB_ATOM_NONE;
 979         }
 980         else {
 981             *key_name = xkb_atom_intern(keymap->ctx, wire->name,
 982                                         strnlen(wire->name,
 983                                                 XCB_XKB_CONST_KEY_NAME_LENGTH));
 984             if (!*key_name)
 985                 return false;
 986         }
 987
 988         xcb_xkb_key_name_next(&iter);
 989     }
 990
 991     return true;
 992
 993 fail:
 994     return false;
 995 }
 996
 997 static bool
 998 get_aliases(struct xkb_keymap *keymap, xcb_connection_t *conn,
 999             xcb_xkb_get_names_reply_t *reply,
1000             xcb_xkb_get_names_value_list_t *list)
1001 {
1002     int length = xcb_xkb_get_names_value_list_key_aliases_length(reply, list);
1003     xcb_xkb_key_alias_iterator_t iter =
1004         xcb_xkb_get_names_value_list_key_aliases_iterator(reply, list);
1005
1006     keymap->num_key_aliases = reply->nKeyAliases;
1007     ALLOC_OR_FAIL(keymap->key_aliases, keymap->num_key_aliases);
1008
1009     for (int i = 0; i < length; i++) {
1010         xcb_xkb_key_alias_t *wire = iter.data;
1011         struct xkb_key_alias *alias = &keymap->key_aliases[i];
1012
1013         alias->real =
1014             xkb_atom_intern(keymap->ctx, wire->real,
1015                             strnlen(wire->real, XCB_XKB_CONST_KEY_NAME_LENGTH));
1016         alias->alias =
1017             xkb_atom_intern(keymap->ctx, wire->alias,
1018                             strnlen(wire->alias, XCB_XKB_CONST_KEY_NAME_LENGTH));
1019         if (!alias->real || !alias->alias)
1020             goto fail;
1021
1022         xcb_xkb_key_alias_next(&iter);
1023     }
1024
1025     return true;
1026
1027 fail:
1028     return false;
1029 }
1030
1031 static bool
1032 get_names(struct xkb_keymap *keymap, xcb_connection_t *conn,
1033           uint16_t device_id)
1034 {
1035     static const xcb_xkb_name_detail_t wanted =
1036         (XCB_XKB_NAME_DETAIL_KEYCODES |
1037          XCB_XKB_NAME_DETAIL_SYMBOLS |
1038          XCB_XKB_NAME_DETAIL_TYPES |
1039          XCB_XKB_NAME_DETAIL_COMPAT |
1040          XCB_XKB_NAME_DETAIL_KEY_TYPE_NAMES |
1041          XCB_XKB_NAME_DETAIL_KT_LEVEL_NAMES |
1042          XCB_XKB_NAME_DETAIL_INDICATOR_NAMES |
1043          XCB_XKB_NAME_DETAIL_KEY_NAMES |
1044          XCB_XKB_NAME_DETAIL_KEY_ALIASES |
1045          XCB_XKB_NAME_DETAIL_VIRTUAL_MOD_NAMES |
1046          XCB_XKB_NAME_DETAIL_GROUP_NAMES);
1047     static const xcb_xkb_name_detail_t required =
1048         (XCB_XKB_NAME_DETAIL_KEY_TYPE_NAMES |
1049          XCB_XKB_NAME_DETAIL_KT_LEVEL_NAMES |
1050          XCB_XKB_NAME_DETAIL_KEY_NAMES |
1051          XCB_XKB_NAME_DETAIL_VIRTUAL_MOD_NAMES);
1052
1053     xcb_xkb_get_names_cookie_t cookie =
1054         xcb_xkb_get_names(conn, device_id, wanted);
1055     xcb_xkb_get_names_reply_t *reply =
1056         xcb_xkb_get_names_reply(conn, cookie, NULL);
1057     xcb_xkb_get_names_value_list_t list;
1058
1059     FAIL_IF_BAD_REPLY(reply, "XkbGetNames");
1060
1061     FAIL_UNLESS((reply->which & required) == required);
1062
1063     xcb_xkb_get_names_value_list_unpack(xcb_xkb_get_names_value_list(reply),
1064                                         reply->nTypes,
1065                                         reply->indicators,
1066                                         reply->virtualMods,
1067                                         reply->groupNames,
1068                                         reply->nKeys,
1069                                         reply->nKeyAliases,
1070                                         reply->nRadioGroups,
1071                                         reply->which,
1072                                         &list);
1073
1074     if (!get_atom_name(conn, list.keycodesName, &keymap->keycodes_section_name) ||
1075         !get_atom_name(conn, list.symbolsName, &keymap->symbols_section_name) ||
1076         !get_atom_name(conn, list.typesName, &keymap->types_section_name) ||
1077         !get_atom_name(conn, list.compatName, &keymap->compat_section_name) ||
1078         !get_type_names(keymap, conn, reply, &list) ||
1079         !get_indicator_names(keymap, conn, reply, &list) ||
1080         !get_vmod_names(keymap, conn, reply, &list) ||
1081         !get_group_names(keymap, conn, reply, &list) ||
1082         !get_key_names(keymap, conn, reply, &list) ||
1083         !get_aliases(keymap, conn, reply, &list))
1084         goto fail;
1085
1086     XkbEscapeMapName(keymap->keycodes_section_name);
1087     XkbEscapeMapName(keymap->symbols_section_name);
1088     XkbEscapeMapName(keymap->types_section_name);
1089     XkbEscapeMapName(keymap->compat_section_name);
1090
1091     free(reply);
1092     return true;
1093
1094 fail:
1095     free(reply);
1096     return false;
1097 }
1098
1099 static bool
1100 get_controls(struct xkb_keymap *keymap, xcb_connection_t *conn,
1101              uint16_t device_id)
1102 {
1103     xcb_xkb_get_controls_cookie_t cookie =
1104         xcb_xkb_get_controls(conn, device_id);
1105     xcb_xkb_get_controls_reply_t *reply =
1106         xcb_xkb_get_controls_reply(conn, cookie, NULL);
1107
1108     FAIL_IF_BAD_REPLY(reply, "XkbGetControls");
1109     FAIL_UNLESS(reply->numGroups > 0 && reply->numGroups <= 4);
1110
1111     keymap->enabled_ctrls = translate_controls_mask(reply->enabledControls);
1112     keymap->num_groups = reply->numGroups;
1113
1114     FAIL_UNLESS(keymap->max_key_code < XCB_XKB_CONST_PER_KEY_BIT_ARRAY_SIZE * 8);
1115
1116     for (xkb_keycode_t i = keymap->min_key_code; i <= keymap->max_key_code; i++)
1117         keymap->keys[i].repeats = (reply->perKeyRepeat[i / 8] & (1 << (i % 8)));
1118
1119     free(reply);
1120     return true;
1121
1122 fail:
1123     free(reply);
1124     return false;
1125 }
1126
1127 XKB_EXPORT struct xkb_keymap *
1128 xkb_x11_keymap_new_from_device(struct xkb_context *ctx,
1129                                xcb_connection_t *conn,
1130                                int32_t device_id,
1131                                enum xkb_keymap_compile_flags flags)
1132 {
1133     struct xkb_keymap *keymap;
1134     const enum xkb_keymap_format format = XKB_KEYMAP_FORMAT_TEXT_V1;
1135
1136     if (flags & ~(XKB_KEYMAP_COMPILE_NO_FLAGS)) {
1137         log_err_func(ctx, "unrecognized flags: %#x\n", flags);
1138         return NULL;
1139     }
1140
1141     if (device_id < 0 || device_id > 255) {
1142         log_err_func(ctx, "illegal device ID: %d\n", device_id);
1143         return NULL;
1144     }
1145
1146     keymap = xkb_keymap_new(ctx, format, flags);
1147     if (!keymap)
1148         return NULL;
1149
1150     if (!get_map(keymap, conn, device_id) ||
1151         !get_indicator_map(keymap, conn, device_id) ||
1152         !get_compat_map(keymap, conn, device_id) ||
1153         !get_names(keymap, conn, device_id) ||
1154         !get_controls(keymap, conn, device_id)) {
1155         xkb_keymap_unref(keymap);
1156         return NULL;
1157     }
1158
1159     return keymap;
1160 }