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_NO_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     darray_resize0(keymap->mods,
 512                    NUM_REAL_MODS + msb_pos(reply->virtualMods));
 513
 514     for (unsigned i = 0; i < NUM_VMODS; i++) {
 515         if (reply->virtualMods & (1u << i)) {
 516             uint8_t wire = *iter;
 517             struct xkb_mod *mod = &darray_item(keymap->mods, NUM_REAL_MODS + i);
 518
 519             mod->type = MOD_VIRT;
 520             mod->mapping = translate_mods(wire, 0, 0);
 521
 522             iter++;
 523         }
 524     }
 525
 526     return true;
 527 }
 528
 529 static bool
 530 get_explicits(struct xkb_keymap *keymap, xcb_connection_t *conn,
 531               xcb_xkb_get_map_reply_t *reply, xcb_xkb_get_map_map_t *map)
 532 {
 533     int length = xcb_xkb_get_map_map_explicit_rtrn_length(reply, map);
 534     xcb_xkb_set_explicit_iterator_t iter =
 535         xcb_xkb_get_map_map_explicit_rtrn_iterator(reply, map);
 536
 537     for (int i = 0; i < length; i++) {
 538         xcb_xkb_set_explicit_t *wire = iter.data;
 539         struct xkb_key *key;
 540
 541         FAIL_UNLESS(wire->keycode >= keymap->min_key_code &&
 542                     wire->keycode <= keymap->max_key_code);
 543
 544         key = &keymap->keys[wire->keycode];
 545
 546         if ((wire->explicit & XCB_XKB_EXPLICIT_KEY_TYPE_1) &&
 547             key->num_groups > 0)
 548             key->groups[0].explicit_type = true;
 549         if ((wire->explicit & XCB_XKB_EXPLICIT_KEY_TYPE_2) &&
 550             key->num_groups > 1)
 551             key->groups[1].explicit_type = true;
 552         if ((wire->explicit & XCB_XKB_EXPLICIT_KEY_TYPE_3) &&
 553             key->num_groups > 2)
 554             key->groups[2].explicit_type = true;
 555         if ((wire->explicit & XCB_XKB_EXPLICIT_KEY_TYPE_4) &&
 556             key->num_groups > 3)
 557             key->groups[3].explicit_type = true;
 558         if (wire->explicit & XCB_XKB_EXPLICIT_INTERPRET)
 559             key->explicit |= EXPLICIT_INTERP;
 560         if (wire->explicit & XCB_XKB_EXPLICIT_AUTO_REPEAT)
 561             key->explicit |= EXPLICIT_REPEAT;
 562         if (wire->explicit & XCB_XKB_EXPLICIT_V_MOD_MAP)
 563             key->explicit |= EXPLICIT_VMODMAP;
 564
 565         xcb_xkb_set_explicit_next(&iter);
 566     }
 567
 568     return true;
 569
 570 fail:
 571     return false;
 572 }
 573
 574 static bool
 575 get_modmaps(struct xkb_keymap *keymap, xcb_connection_t *conn,
 576             xcb_xkb_get_map_reply_t *reply, xcb_xkb_get_map_map_t *map)
 577 {
 578     int length = xcb_xkb_get_map_map_modmap_rtrn_length(reply, map);
 579     xcb_xkb_key_mod_map_iterator_t iter =
 580         xcb_xkb_get_map_map_modmap_rtrn_iterator(reply, map);
 581
 582     for (int i = 0; i < length; i++) {
 583         xcb_xkb_key_mod_map_t *wire = iter.data;
 584         struct xkb_key *key;
 585
 586         FAIL_UNLESS(wire->keycode >= keymap->min_key_code &&
 587                     wire->keycode <= keymap->max_key_code);
 588
 589         key = &keymap->keys[wire->keycode];
 590         key->modmap = wire->mods;
 591
 592         xcb_xkb_key_mod_map_next(&iter);
 593     }
 594
 595     return true;
 596
 597 fail:
 598     return false;
 599 }
 600
 601 static bool
 602 get_vmodmaps(struct xkb_keymap *keymap, xcb_connection_t *conn,
 603              xcb_xkb_get_map_reply_t *reply, xcb_xkb_get_map_map_t *map)
 604 {
 605     int length = xcb_xkb_get_map_map_vmodmap_rtrn_length(reply, map);
 606     xcb_xkb_key_v_mod_map_iterator_t iter =
 607         xcb_xkb_get_map_map_vmodmap_rtrn_iterator(reply, map);
 608
 609     for (int i = 0; i < length; i++) {
 610         xcb_xkb_key_v_mod_map_t *wire = iter.data;
 611         struct xkb_key *key;
 612
 613         FAIL_UNLESS(wire->keycode >= keymap->min_key_code &&
 614                     wire->keycode <= keymap->max_key_code);
 615
 616         key = &keymap->keys[wire->keycode];
 617         key->vmodmap = translate_mods(0, wire->vmods, 0);
 618
 619         xcb_xkb_key_v_mod_map_next(&iter);
 620     }
 621
 622     return true;
 623
 624 fail:
 625     return false;
 626 }
 627
 628 static bool
 629 get_map(struct xkb_keymap *keymap, xcb_connection_t *conn, uint16_t device_id)
 630 {
 631     static const xcb_xkb_map_part_t required_components =
 632         (XCB_XKB_MAP_PART_KEY_TYPES |
 633          XCB_XKB_MAP_PART_KEY_SYMS |
 634          XCB_XKB_MAP_PART_MODIFIER_MAP |
 635          XCB_XKB_MAP_PART_EXPLICIT_COMPONENTS |
 636          XCB_XKB_MAP_PART_KEY_ACTIONS |
 637          XCB_XKB_MAP_PART_VIRTUAL_MODS |
 638          XCB_XKB_MAP_PART_VIRTUAL_MOD_MAP);
 639
 640     xcb_xkb_get_map_cookie_t cookie =
 641         xcb_xkb_get_map(conn, device_id, required_components,
 642                         0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0);
 643     xcb_xkb_get_map_reply_t *reply = xcb_xkb_get_map_reply(conn, cookie, NULL);
 644     xcb_xkb_get_map_map_t map;
 645
 646     FAIL_IF_BAD_REPLY(reply, "XkbGetMap");
 647
 648     if ((reply->present & required_components) != required_components)
 649         goto fail;
 650
 651     xcb_xkb_get_map_map_unpack(xcb_xkb_get_map_map(reply),
 652                                reply->nTypes,
 653                                reply->nKeySyms,
 654                                reply->nKeyActions,
 655                                reply->totalActions,
 656                                reply->totalKeyBehaviors,
 657                                reply->virtualMods,
 658                                reply->totalKeyExplicit,
 659                                reply->totalModMapKeys,
 660                                reply->totalVModMapKeys,
 661                                reply->present,
 662                                &map);
 663
 664     if (!get_types(keymap, conn, reply, &map) ||
 665         !get_sym_maps(keymap, conn, reply, &map) ||
 666         !get_actions(keymap, conn, reply, &map) ||
 667         !get_vmods(keymap, conn, reply, &map) ||
 668         !get_explicits(keymap, conn, reply, &map) ||
 669         !get_modmaps(keymap, conn, reply, &map) ||
 670         !get_vmodmaps(keymap, conn, reply, &map))
 671         goto fail;
 672
 673     free(reply);
 674     return true;
 675
 676 fail:
 677     free(reply);
 678     return false;
 679 }
 680
 681 static bool
 682 get_indicators(struct xkb_keymap *keymap, xcb_connection_t *conn,
 683                xcb_xkb_get_indicator_map_reply_t *reply)
 684 {
 685     xcb_xkb_indicator_map_iterator_t iter =
 686         xcb_xkb_get_indicator_map_maps_iterator(reply);
 687
 688     darray_resize0(keymap->leds, msb_pos(reply->which));
 689
 690     for (unsigned i = 0; i < NUM_INDICATORS; i++) {
 691         if (reply->which & (1u << i)) {
 692             xcb_xkb_indicator_map_t *wire = iter.data;
 693             struct xkb_led *led = &darray_item(keymap->leds, i);
 694
 695             if (wire->whichGroups & XCB_XKB_IM_GROUPS_WHICH_USE_BASE)
 696                 led->which_groups |= XKB_STATE_LAYOUT_DEPRESSED;
 697             if (wire->whichGroups & XCB_XKB_IM_GROUPS_WHICH_USE_LATCHED)
 698                 led->which_groups |= XKB_STATE_LAYOUT_LATCHED;
 699             if (wire->whichGroups & XCB_XKB_IM_GROUPS_WHICH_USE_LOCKED)
 700                 led->which_groups |= XKB_STATE_LAYOUT_LOCKED;
 701             if (wire->whichGroups & XCB_XKB_IM_GROUPS_WHICH_USE_EFFECTIVE)
 702                 led->which_groups |= XKB_STATE_LAYOUT_EFFECTIVE;
 703             if (wire->whichGroups & XCB_XKB_IM_GROUPS_WHICH_USE_COMPAT)
 704                 led->which_groups |= XKB_STATE_LAYOUT_EFFECTIVE;
 705
 706             led->groups = wire->groups;
 707
 708             if (wire->whichMods & XCB_XKB_IM_MODS_WHICH_USE_BASE)
 709                 led->which_mods |= XKB_STATE_MODS_DEPRESSED;
 710             if (wire->whichMods & XCB_XKB_IM_MODS_WHICH_USE_LATCHED)
 711                 led->which_mods |= XKB_STATE_MODS_LATCHED;
 712             if (wire->whichMods & XCB_XKB_IM_MODS_WHICH_USE_LOCKED)
 713                 led->which_mods |= XKB_STATE_MODS_LOCKED;
 714             if (wire->whichMods & XCB_XKB_IM_MODS_WHICH_USE_EFFECTIVE)
 715                 led->which_mods |= XKB_STATE_MODS_EFFECTIVE;
 716             if (wire->whichMods & XCB_XKB_IM_MODS_WHICH_USE_COMPAT)
 717                 led->which_mods |= XKB_STATE_MODS_EFFECTIVE;
 718
 719             led->mods.mods = translate_mods(wire->realMods, wire->vmods, 0);
 720             led->mods.mask = translate_mods(wire->mods, 0, 0);
 721
 722             led->ctrls = translate_controls_mask(wire->ctrls);
 723
 724             xcb_xkb_indicator_map_next(&iter);
 725         }
 726     }
 727
 728     return true;
 729 }
 730
 731 static bool
 732 get_indicator_map(struct xkb_keymap *keymap, xcb_connection_t *conn,
 733                   uint16_t device_id)
 734 {
 735     xcb_xkb_get_indicator_map_cookie_t cookie =
 736         xcb_xkb_get_indicator_map(conn, device_id, ALL_INDICATORS_MASK);
 737     xcb_xkb_get_indicator_map_reply_t *reply =
 738         xcb_xkb_get_indicator_map_reply(conn, cookie, NULL);
 739
 740     FAIL_IF_BAD_REPLY(reply, "XkbGetIndicatorMap");
 741
 742     if (!get_indicators(keymap, conn, reply))
 743         goto fail;
 744
 745     free(reply);
 746     return true;
 747
 748 fail:
 749     free(reply);
 750     return false;
 751 }
 752
 753 static bool
 754 get_sym_interprets(struct xkb_keymap *keymap, xcb_connection_t *conn,
 755                    xcb_xkb_get_compat_map_reply_t *reply)
 756 {
 757     int length = xcb_xkb_get_compat_map_si_rtrn_length(reply);
 758     xcb_xkb_sym_interpret_iterator_t iter =
 759         xcb_xkb_get_compat_map_si_rtrn_iterator(reply);
 760
 761     FAIL_UNLESS(reply->firstSIRtrn == 0);
 762     FAIL_UNLESS(reply->nSIRtrn == reply->nTotalSI);
 763
 764     keymap->num_sym_interprets = reply->nSIRtrn;
 765     ALLOC_OR_FAIL(keymap->sym_interprets, keymap->num_sym_interprets);
 766
 767     for (int i = 0; i < length; i++) {
 768         xcb_xkb_sym_interpret_t *wire = iter.data;
 769         struct xkb_sym_interpret *sym_interpret = &keymap->sym_interprets[i];
 770
 771         sym_interpret->sym = wire->sym;
 772
 773         switch (wire->match & XCB_XKB_SYM_INTERP_MATCH_OP_MASK) {
 774         case XCB_XKB_SYM_INTERPRET_MATCH_NONE_OF:
 775             sym_interpret->match = MATCH_NONE;
 776             break;
 777         case XCB_XKB_SYM_INTERPRET_MATCH_ANY_OF_OR_NONE:
 778             sym_interpret->match = MATCH_ANY_OR_NONE;
 779             break;
 780         case XCB_XKB_SYM_INTERPRET_MATCH_ANY_OF:
 781             sym_interpret->match = MATCH_ANY;
 782             break;
 783         case XCB_XKB_SYM_INTERPRET_MATCH_ALL_OF:
 784             sym_interpret->match = MATCH_ALL;
 785             break;
 786         case XCB_XKB_SYM_INTERPRET_MATCH_EXACTLY:
 787             sym_interpret->match = MATCH_EXACTLY;
 788             break;
 789         }
 790
 791         sym_interpret->level_one_only =
 792             !!(wire->match & XCB_XKB_SYM_INTERP_MATCH_LEVEL_ONE_ONLY);
 793         sym_interpret->mods = wire->mods;
 794
 795         if (wire->virtualMod == NO_MODIFIER)
 796             sym_interpret->virtual_mod = XKB_MOD_INVALID;
 797         else
 798             sym_interpret->virtual_mod = NUM_REAL_MODS + wire->virtualMod;
 799
 800         sym_interpret->repeat = !!(wire->flags & 0x01);
 801         translate_action(&sym_interpret->action,
 802                          (xcb_xkb_action_t *) &wire->action);
 803
 804         xcb_xkb_sym_interpret_next(&iter);
 805     }
 806
 807     return true;
 808
 809 fail:
 810     return false;
 811 }
 812
 813 static bool
 814 get_compat_map(struct xkb_keymap *keymap, xcb_connection_t *conn,
 815                uint16_t device_id)
 816 {
 817     xcb_xkb_get_compat_map_cookie_t cookie =
 818         xcb_xkb_get_compat_map(conn, device_id, 0, true, 0, 0);
 819     xcb_xkb_get_compat_map_reply_t *reply =
 820         xcb_xkb_get_compat_map_reply(conn, cookie, NULL);
 821
 822     FAIL_IF_BAD_REPLY(reply, "XkbGetCompatMap");
 823
 824     if (!get_sym_interprets(keymap, conn, reply))
 825         goto fail;
 826
 827     free(reply);
 828     return true;
 829
 830 fail:
 831     free(reply);
 832     return false;
 833 }
 834
 835 static bool
 836 get_type_names(struct xkb_keymap *keymap, xcb_connection_t *conn,
 837                xcb_xkb_get_names_reply_t *reply,
 838                xcb_xkb_get_names_value_list_t *list)
 839 {
 840     int key_type_names_length =
 841         xcb_xkb_get_names_value_list_type_names_length(reply, list);
 842     xcb_atom_t *key_type_names_iter =
 843         xcb_xkb_get_names_value_list_type_names(list);
 844     int n_levels_per_type_length =
 845         xcb_xkb_get_names_value_list_n_levels_per_type_length(reply, list);
 846     uint8_t *n_levels_per_type_iter =
 847         xcb_xkb_get_names_value_list_n_levels_per_type(list);
 848     xcb_atom_t *kt_level_names_iter =
 849         xcb_xkb_get_names_value_list_kt_level_names(list);
 850
 851     FAIL_UNLESS(reply->nTypes == keymap->num_types);
 852     FAIL_UNLESS(key_type_names_length == n_levels_per_type_length);
 853
 854     for (int i = 0; i < key_type_names_length; i++) {
 855         xcb_atom_t wire_type_name = *key_type_names_iter;
 856         uint8_t wire_num_levels = *n_levels_per_type_iter;
 857         struct xkb_key_type *type = &keymap->types[i];
 858
 859         /* Levels must have names. */
 860         FAIL_UNLESS(type->num_levels == wire_num_levels);
 861
 862         ALLOC_OR_FAIL(type->level_names, type->num_levels);
 863
 864         if (!adopt_atom(keymap->ctx, conn, wire_type_name, &type->name))
 865             goto fail;
 866
 867         if (!adopt_atoms(keymap->ctx, conn,
 868                          kt_level_names_iter, type->level_names,
 869                          wire_num_levels))
 870             goto fail;
 871
 872         kt_level_names_iter += wire_num_levels;
 873         key_type_names_iter++;
 874         n_levels_per_type_iter++;
 875     }
 876
 877     return true;
 878
 879 fail:
 880     return false;
 881 }
 882
 883 static bool
 884 get_indicator_names(struct xkb_keymap *keymap, xcb_connection_t *conn,
 885                     xcb_xkb_get_names_reply_t *reply,
 886                     xcb_xkb_get_names_value_list_t *list)
 887 {
 888     xcb_atom_t *iter = xcb_xkb_get_names_value_list_indicator_names(list);
 889
 890     FAIL_UNLESS(msb_pos(reply->indicators) <= darray_size(keymap->leds));
 891
 892     for (unsigned i = 0; i < NUM_INDICATORS; i++) {
 893         if (reply->indicators & (1u << i)) {
 894             xcb_atom_t wire = *iter;
 895             struct xkb_led *led = &darray_item(keymap->leds, i);
 896
 897             if (!adopt_atom(keymap->ctx, conn, wire, &led->name))
 898                 return false;
 899
 900             iter++;
 901         }
 902     }
 903
 904     return true;
 905
 906 fail:
 907     return false;
 908 }
 909
 910 static bool
 911 get_vmod_names(struct xkb_keymap *keymap, xcb_connection_t *conn,
 912                xcb_xkb_get_names_reply_t *reply,
 913                xcb_xkb_get_names_value_list_t *list)
 914 {
 915     xcb_atom_t *iter = xcb_xkb_get_names_value_list_virtual_mod_names(list);
 916
 917     /*
 918      * GetMap's reply->virtualMods is always 0xffff. This one really
 919      * tells us which vmods exist (a vmod must have a name), so we fix
 920      * up the size here.
 921      */
 922     darray_resize0(keymap->mods, NUM_REAL_MODS + msb_pos(reply->virtualMods));
 923
 924     for (unsigned i = 0; i < NUM_VMODS; i++) {
 925         if (reply->virtualMods & (1u << i)) {
 926             xcb_atom_t wire = *iter;
 927             struct xkb_mod *mod = &darray_item(keymap->mods, NUM_REAL_MODS + i);
 928
 929             if (!adopt_atom(keymap->ctx, conn, wire, &mod->name))
 930                 return false;
 931
 932             iter++;
 933         }
 934     }
 935
 936     return true;
 937 }
 938
 939 static bool
 940 get_group_names(struct xkb_keymap *keymap, xcb_connection_t *conn,
 941                 xcb_xkb_get_names_reply_t *reply,
 942                 xcb_xkb_get_names_value_list_t *list)
 943 {
 944     int length = xcb_xkb_get_names_value_list_groups_length(reply, list);
 945     xcb_atom_t *iter = xcb_xkb_get_names_value_list_groups(list);
 946
 947     keymap->num_group_names = msb_pos(reply->groupNames);
 948     ALLOC_OR_FAIL(keymap->group_names, keymap->num_group_names);
 949
 950     if (!adopt_atoms(keymap->ctx, conn,
 951                      iter, keymap->group_names, length))
 952         goto fail;
 953
 954     return true;
 955
 956 fail:
 957     return false;
 958 }
 959
 960 static bool
 961 get_key_names(struct xkb_keymap *keymap, xcb_connection_t *conn,
 962               xcb_xkb_get_names_reply_t *reply,
 963               xcb_xkb_get_names_value_list_t *list)
 964 {
 965     int length = xcb_xkb_get_names_value_list_key_names_length(reply, list);
 966     xcb_xkb_key_name_iterator_t iter =
 967         xcb_xkb_get_names_value_list_key_names_iterator(reply, list);
 968
 969     FAIL_UNLESS(reply->minKeyCode == keymap->min_key_code);
 970     FAIL_UNLESS(reply->maxKeyCode == keymap->max_key_code);
 971     FAIL_UNLESS(reply->firstKey == keymap->min_key_code);
 972     FAIL_UNLESS(reply->firstKey + reply->nKeys - 1U == keymap->max_key_code);
 973
 974     for (int i = 0; i < length; i++) {
 975         xcb_xkb_key_name_t *wire = iter.data;
 976         xkb_atom_t *key_name = &keymap->keys[reply->firstKey + i].name;
 977
 978         if (wire->name[0] == '\0') {
 979             *key_name = XKB_ATOM_NONE;
 980         }
 981         else {
 982             *key_name = xkb_atom_intern(keymap->ctx, wire->name,
 983                                         strnlen(wire->name,
 984                                                 XCB_XKB_CONST_KEY_NAME_LENGTH));
 985             if (!*key_name)
 986                 return false;
 987         }
 988
 989         xcb_xkb_key_name_next(&iter);
 990     }
 991
 992     return true;
 993
 994 fail:
 995     return false;
 996 }
 997
 998 static bool
 999 get_aliases(struct xkb_keymap *keymap, xcb_connection_t *conn,
1000             xcb_xkb_get_names_reply_t *reply,
1001             xcb_xkb_get_names_value_list_t *list)
1002 {
1003     int length = xcb_xkb_get_names_value_list_key_aliases_length(reply, list);
1004     xcb_xkb_key_alias_iterator_t iter =
1005         xcb_xkb_get_names_value_list_key_aliases_iterator(reply, list);
1006
1007     keymap->num_key_aliases = reply->nKeyAliases;
1008     ALLOC_OR_FAIL(keymap->key_aliases, keymap->num_key_aliases);
1009
1010     for (int i = 0; i < length; i++) {
1011         xcb_xkb_key_alias_t *wire = iter.data;
1012         struct xkb_key_alias *alias = &keymap->key_aliases[i];
1013
1014         alias->real =
1015             xkb_atom_intern(keymap->ctx, wire->real,
1016                             strnlen(wire->real, XCB_XKB_CONST_KEY_NAME_LENGTH));
1017         alias->alias =
1018             xkb_atom_intern(keymap->ctx, wire->alias,
1019                             strnlen(wire->alias, XCB_XKB_CONST_KEY_NAME_LENGTH));
1020         if (!alias->real || !alias->alias)
1021             goto fail;
1022
1023         xcb_xkb_key_alias_next(&iter);
1024     }
1025
1026     return true;
1027
1028 fail:
1029     return false;
1030 }
1031
1032 static bool
1033 get_names(struct xkb_keymap *keymap, xcb_connection_t *conn,
1034           uint16_t device_id)
1035 {
1036     static const xcb_xkb_name_detail_t required_names =
1037         (XCB_XKB_NAME_DETAIL_KEYCODES |
1038          XCB_XKB_NAME_DETAIL_SYMBOLS |
1039          XCB_XKB_NAME_DETAIL_TYPES |
1040          XCB_XKB_NAME_DETAIL_COMPAT |
1041          XCB_XKB_NAME_DETAIL_KEY_TYPE_NAMES |
1042          XCB_XKB_NAME_DETAIL_KT_LEVEL_NAMES |
1043          XCB_XKB_NAME_DETAIL_INDICATOR_NAMES |
1044          XCB_XKB_NAME_DETAIL_KEY_NAMES |
1045          XCB_XKB_NAME_DETAIL_KEY_ALIASES |
1046          XCB_XKB_NAME_DETAIL_VIRTUAL_MOD_NAMES |
1047          XCB_XKB_NAME_DETAIL_GROUP_NAMES);
1048
1049     xcb_xkb_get_names_cookie_t cookie =
1050         xcb_xkb_get_names(conn, device_id, required_names);
1051     xcb_xkb_get_names_reply_t *reply =
1052         xcb_xkb_get_names_reply(conn, cookie, NULL);
1053     xcb_xkb_get_names_value_list_t list;
1054
1055     FAIL_IF_BAD_REPLY(reply, "XkbGetNames");
1056
1057     if ((reply->which & required_names) != required_names)
1058         goto fail;
1059
1060     xcb_xkb_get_names_value_list_unpack(xcb_xkb_get_names_value_list(reply),
1061                                         reply->nTypes,
1062                                         reply->indicators,
1063                                         reply->virtualMods,
1064                                         reply->groupNames,
1065                                         reply->nKeys,
1066                                         reply->nKeyAliases,
1067                                         reply->nRadioGroups,
1068                                         reply->which,
1069                                         &list);
1070
1071     if (!get_atom_name(conn, list.keycodesName, &keymap->keycodes_section_name) ||
1072         !get_atom_name(conn, list.symbolsName, &keymap->symbols_section_name) ||
1073         !get_atom_name(conn, list.typesName, &keymap->types_section_name) ||
1074         !get_atom_name(conn, list.compatName, &keymap->compat_section_name) ||
1075         !get_type_names(keymap, conn, reply, &list) ||
1076         !get_indicator_names(keymap, conn, reply, &list) ||
1077         !get_vmod_names(keymap, conn, reply, &list) ||
1078         !get_group_names(keymap, conn, reply, &list) ||
1079         !get_key_names(keymap, conn, reply, &list) ||
1080         !get_aliases(keymap, conn, reply, &list))
1081         goto fail;
1082
1083     XkbEscapeMapName(keymap->keycodes_section_name);
1084     XkbEscapeMapName(keymap->symbols_section_name);
1085     XkbEscapeMapName(keymap->types_section_name);
1086     XkbEscapeMapName(keymap->compat_section_name);
1087
1088     free(reply);
1089     return true;
1090
1091 fail:
1092     free(reply);
1093     return false;
1094 }
1095
1096 static bool
1097 get_controls(struct xkb_keymap *keymap, xcb_connection_t *conn,
1098              uint16_t device_id)
1099 {
1100     xcb_xkb_get_controls_cookie_t cookie =
1101         xcb_xkb_get_controls(conn, device_id);
1102     xcb_xkb_get_controls_reply_t *reply =
1103         xcb_xkb_get_controls_reply(conn, cookie, NULL);
1104
1105     FAIL_IF_BAD_REPLY(reply, "XkbGetControls");
1106     FAIL_UNLESS(reply->numGroups > 0 && reply->numGroups <= 4);
1107
1108     keymap->enabled_ctrls = translate_controls_mask(reply->enabledControls);
1109     keymap->num_groups = reply->numGroups;
1110
1111     FAIL_UNLESS(keymap->max_key_code < XCB_XKB_CONST_PER_KEY_BIT_ARRAY_SIZE * 8);
1112
1113     for (xkb_keycode_t i = keymap->min_key_code; i <= keymap->max_key_code; i++)
1114         keymap->keys[i].repeats = !!(reply->perKeyRepeat[i / 8] & (1 << (i % 8)));
1115
1116     free(reply);
1117     return true;
1118
1119 fail:
1120     free(reply);
1121     return false;
1122 }
1123
1124 XKB_EXPORT struct xkb_keymap *
1125 xkb_x11_keymap_new_from_device(struct xkb_context *ctx,
1126                                xcb_connection_t *conn,
1127                                int32_t device_id,
1128                                enum xkb_keymap_compile_flags flags)
1129 {
1130     struct xkb_keymap *keymap;
1131     const enum xkb_keymap_format format = XKB_KEYMAP_FORMAT_TEXT_V1;
1132
1133     if (flags & ~(XKB_KEYMAP_COMPILE_NO_FLAGS)) {
1134         log_err_func(ctx, "unrecognized flags: %#x\n", flags);
1135         return NULL;
1136     }
1137
1138     if (device_id < 0 || device_id > 255) {
1139         log_err_func(ctx, "illegal device ID: %d\n", device_id);
1140         return NULL;
1141     }
1142
1143     keymap = xkb_keymap_new(ctx, format, flags);
1144     if (!keymap)
1145         return NULL;
1146
1147     if (!get_map(keymap, conn, device_id) ||
1148         !get_indicator_map(keymap, conn, device_id) ||
1149         !get_compat_map(keymap, conn, device_id) ||
1150         !get_names(keymap, conn, device_id) ||
1151         !get_controls(keymap, conn, device_id)) {
1152         xkb_keymap_unref(keymap);
1153         return NULL;
1154     }
1155
1156     return keymap;
1157 }