src/xkbcomp/keycodes.c

   1 /************************************************************
   2  * Copyright (c) 1994 by Silicon Graphics Computer Systems, Inc.
   3  *
   4  * Permission to use, copy, modify, and distribute this
   5  * software and its documentation for any purpose and without
   6  * fee is hereby granted, provided that the above copyright
   7  * notice appear in all copies and that both that copyright
   8  * notice and this permission notice appear in supporting
   9  * documentation, and that the name of Silicon Graphics not be
  10  * used in advertising or publicity pertaining to distribution
  11  * of the software without specific prior written permission.
  12  * Silicon Graphics makes no representation about the suitability
  13  * of this software for any purpose. It is provided "as is"
  14  * without any express or implied warranty.
  15  *
  16  * SILICON GRAPHICS DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS
  17  * SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
  18  * AND FITNESS FOR A PARTICULAR PURPOSE. IN NO EVENT SHALL SILICON
  19  * GRAPHICS BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL
  20  * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
  21  * DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
  22  * OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION  WITH
  23  * THE USE OR PERFORMANCE OF THIS SOFTWARE.
  24  *
  25  ********************************************************/
  26
  27 #include "xkbcomp-priv.h"
  28 #include "text.h"
  29 #include "expr.h"
  30 #include "keycodes.h"
  31 #include "include.h"
  32
  33 /*
  34  * The xkb_keycodes section
  35  * ========================
  36  *
  37  * This is the simplest section type, and is the first one to be
  38  * compiled. The purpose of this is mostly to map between the
  39  * hardware/evdev scancodes and xkb keycodes. Each key is given a name
  40  * by which it can be referred to later, e.g. in the symbols section.
  41  *
  42  * Keycode statements
  43  * ------------------
  44  * Statements of the form:
  45  *      <TLDE> = 49;
  46  *      <AE01> = 10;
  47  *
  48  * The above would let 49 and 10 be valid keycodes in the keymap, and
  49  * assign them the names TLDE and AE01 respectively. The format <WXYZ> is
  50  * always used to refer to a key by name.
  51  *
  52  * [ The naming convention <AE01> just denoted the position of the key
  53  * in the main alphanumric section of the keyboard, with the two letters
  54  * specifying the row and the two digits specifying the column, from
  55  * the bottom left.]
  56  *
  57  * In the common case this just maps to the evdev scancodes from
  58  * /usr/include/linux/input.h, e.g. the following definitions:
  59  *      #define KEY_GRAVE            41
  60  *      #define KEY_1                2
  61  * Similar definitions appear in the xf86-input-keyboard driver. Note
  62  * that in all current keymaps there's a constant offset of 8 (for
  63  * historical reasons).
  64  *
  65  * If there's a conflict, like the same name given to different keycodes,
  66  * or same keycode given different names, it is resolved according to the
  67  * merge mode which applies to the definitions.
  68  *
  69  * Alias statements
  70  * ----------------
  71  * Statements of the form:
  72  *      alias <MENU> = <COMP>;
  73  *
  74  * Allows to refer to a previously defined key (here <COMP>) by another
  75  * name (here <MENU>). Conflicts are handled similarly.
  76  *
  77  * LED name statements
  78  * -------------------------
  79  * Statements of the form:
  80  *      indicator 1 = "Caps Lock";
  81  *      indicator 2 = "Num Lock";
  82  *      indicator 3 = "Scroll Lock";
  83  *
  84  * Assigns a name to the keyboard LED (a.k.a indicator) with the given index.
  85  * The led may be referred by this name later in the compat section
  86  * and by the user.
  87  *
  88  * Effect on the keymap
  89  * --------------------
  90  * After all of the xkb_keycodes sections have been compiled, the
  91  * following members of struct xkb_keymap are finalized:
  92  *      xkb_keycode_t min_key_code;
  93  *      xkb_keycode_t max_key_code;
  94  *      darray(struct xkb_key_alias) key_aliases;
  95  *      char *keycodes_section_name;
  96  * The 'name' field of leds declared in xkb_keycodes:
  97  *      darray(struct xkb_led) leds;
  98  * Further, the array of keys:
  99  *      struct xkb_key *keys;
 100  * had been resized to its final size (i.e. all of the xkb_key objects are
 101  * referable by their keycode). However the objects themselves do not
 102  * contain any useful information besides the key name at this point.
 103  */
 104
 105 typedef struct {
 106     enum merge_mode merge;
 107
 108     xkb_atom_t alias;
 109     xkb_atom_t real;
 110 } AliasInfo;
 111
 112 typedef struct {
 113     unsigned file_id;
 114
 115     xkb_atom_t name;
 116 } KeyNameInfo;
 117
 118 typedef struct {
 119     enum merge_mode merge;
 120     unsigned file_id;
 121
 122     xkb_atom_t name;
 123 } LedNameInfo;
 124
 125 typedef struct {
 126     char *name;
 127     int errorCount;
 128     enum merge_mode merge;
 129     unsigned file_id;
 130
 131     xkb_keycode_t min_key_code;
 132     xkb_keycode_t max_key_code;
 133     darray(KeyNameInfo) key_names;
 134     darray(LedNameInfo) led_names;
 135     darray(AliasInfo) aliases;
 136
 137     struct xkb_context *ctx;
 138 } KeyNamesInfo;
 139
 140 /***====================================================================***/
 141
 142 static void
 143 InitAliasInfo(AliasInfo *info, enum merge_mode merge,
 144               xkb_atom_t alias, xkb_atom_t real)
 145 {
 146     memset(info, 0, sizeof(*info));
 147     info->merge = merge;
 148     info->alias = alias;
 149     info->real = real;
 150 }
 151
 152 static LedNameInfo *
 153 FindLedByName(KeyNamesInfo *info, xkb_atom_t name,
 154               xkb_led_index_t *idx_out)
 155 {
 156     LedNameInfo *ledi;
 157     xkb_led_index_t idx;
 158
 159     darray_enumerate(idx, ledi, info->led_names) {
 160         if (ledi->name == name) {
 161             *idx_out = idx;
 162             return ledi;
 163         }
 164     }
 165
 166     return NULL;
 167 }
 168
 169 static bool
 170 AddLedName(KeyNamesInfo *info, enum merge_mode merge,
 171            LedNameInfo *new, xkb_led_index_t new_idx)
 172 {
 173     xkb_led_index_t old_idx;
 174     LedNameInfo *old;
 175     const int verbosity = xkb_context_get_log_verbosity(info->ctx);
 176     const bool replace = (merge == MERGE_REPLACE || merge == MERGE_OVERRIDE);
 177
 178     /* Inidicator with the same name already exists. */
 179     old = FindLedByName(info, new->name, &old_idx);
 180     if (old) {
 181         const bool report = ((old->file_id == new->file_id && verbosity > 0) ||
 182                              verbosity > 9);
 183
 184         if (old_idx == new_idx) {
 185             log_warn(info->ctx,
 186                      "Multiple indicators named \"%s\"; "
 187                      "Identical definitions ignored\n",
 188                      xkb_atom_text(info->ctx, new->name));
 189             return true;
 190         }
 191
 192         if (report) {
 193             xkb_led_index_t use = (replace ? new_idx + 1 : old_idx + 1);
 194             xkb_led_index_t ignore = (replace ? old_idx + 1 : new_idx + 1);
 195             log_warn(info->ctx,
 196                      "Multiple indicators named %s; Using %d, ignoring %d\n",
 197                      xkb_atom_text(info->ctx, new->name), use, ignore);
 198         }
 199
 200         if (replace)
 201             *old = *new;
 202
 203         return true;
 204     }
 205
 206     if (new_idx >= darray_size(info->led_names))
 207         darray_resize0(info->led_names, new_idx + 1);
 208
 209     /* Inidicator with the same index already exists. */
 210     old = &darray_item(info->led_names, new_idx);
 211     if (old->name != XKB_ATOM_NONE) {
 212         const bool report = ((old->file_id == new->file_id && verbosity > 0) ||
 213                              verbosity > 9);
 214
 215         /* Same name case already handled above. */
 216
 217         if (report) {
 218             const xkb_atom_t use = (replace ? new->name : old->name);
 219             const xkb_atom_t ignore = (replace ? old->name : new->name);
 220             log_warn(info->ctx, "Multiple names for indicator %d; "
 221                      "Using %s, ignoring %s\n", new_idx + 1,
 222                      xkb_atom_text(info->ctx, use),
 223                      xkb_atom_text(info->ctx, ignore));
 224         }
 225
 226         if (replace)
 227             *old = *new;
 228
 229         return true;
 230     }
 231
 232     darray_item(info->led_names, new_idx) = *new;
 233     return true;
 234 }
 235
 236 static void
 237 ClearKeyNamesInfo(KeyNamesInfo *info)
 238 {
 239     free(info->name);
 240     darray_free(info->key_names);
 241     darray_free(info->aliases);
 242     darray_free(info->led_names);
 243 }
 244
 245 static void
 246 InitKeyNamesInfo(KeyNamesInfo *info, struct xkb_context *ctx,
 247                  unsigned file_id)
 248 {
 249     memset(info, 0, sizeof(*info));
 250     info->ctx = ctx;
 251     info->merge = MERGE_DEFAULT;
 252     info->file_id = file_id;
 253     info->min_key_code = XKB_KEYCODE_MAX;
 254 }
 255
 256 static xkb_keycode_t
 257 FindKeyByName(KeyNamesInfo * info, xkb_atom_t name)
 258 {
 259     xkb_keycode_t i;
 260
 261     for (i = info->min_key_code; i <= info->max_key_code; i++)
 262         if (darray_item(info->key_names, i).name == name)
 263             return i;
 264
 265     return XKB_KEYCODE_INVALID;
 266 }
 267
 268 static bool
 269 AddKeyName(KeyNamesInfo *info, xkb_keycode_t kc, xkb_atom_t name,
 270            enum merge_mode merge, unsigned file_id, bool report)
 271 {
 272     KeyNameInfo *namei;
 273     xkb_keycode_t old;
 274     const int verbosity = xkb_context_get_log_verbosity(info->ctx);
 275
 276     if (kc >= darray_size(info->key_names))
 277         darray_resize0(info->key_names, kc + 1);
 278
 279     info->min_key_code = MIN(info->min_key_code, kc);
 280     info->max_key_code = MAX(info->max_key_code, kc);
 281
 282     namei = &darray_item(info->key_names, kc);
 283
 284     report = report && ((verbosity > 0 && file_id == namei->file_id) ||
 285                         verbosity > 7);
 286
 287     if (namei->name != 0) {
 288         const char *lname = KeyNameText(info->ctx, namei->name);
 289         const char *kname = KeyNameText(info->ctx, name);
 290
 291         if (namei->name == name) {
 292             if (report)
 293                 log_warn(info->ctx,
 294                          "Multiple identical key name definitions; "
 295                          "Later occurrences of \"%s = %d\" ignored\n",
 296                          lname, kc);
 297             return true;
 298         }
 299         else if (merge == MERGE_AUGMENT) {
 300             if (report)
 301                 log_warn(info->ctx,
 302                          "Multiple names for keycode %d; "
 303                          "Using %s, ignoring %s\n", kc, lname, kname);
 304             return true;
 305         }
 306         else {
 307             if (report)
 308                 log_warn(info->ctx,
 309                          "Multiple names for keycode %d; "
 310                          "Using %s, ignoring %s\n", kc, kname, lname);
 311             namei->name = 0;
 312             namei->file_id = 0;
 313         }
 314     }
 315
 316     old = FindKeyByName(info, name);
 317     if (old != XKB_KEYCODE_INVALID && old != kc) {
 318         const char *kname = KeyNameText(info->ctx, name);
 319
 320         if (merge == MERGE_OVERRIDE) {
 321             darray_item(info->key_names, old).name = 0;
 322             darray_item(info->key_names, old).file_id = 0;
 323             if (report)
 324                 log_warn(info->ctx,
 325                          "Key name %s assigned to multiple keys; "
 326                          "Using %d, ignoring %d\n", kname, kc, old);
 327         }
 328         else {
 329             if (report)
 330                 log_vrb(info->ctx, 3,
 331                         "Key name %s assigned to multiple keys; "
 332                         "Using %d, ignoring %d\n", kname, old, kc);
 333             return true;
 334         }
 335     }
 336
 337     namei->name = name;
 338     namei->file_id = file_id;
 339     return true;
 340 }
 341
 342 /***====================================================================***/
 343
 344 static int
 345 HandleAliasDef(KeyNamesInfo *info, KeyAliasDef *def, enum merge_mode merge);
 346
 347 static bool
 348 MergeAliases(KeyNamesInfo *into, KeyNamesInfo *from, enum merge_mode merge)
 349 {
 350     AliasInfo *alias;
 351     KeyAliasDef def;
 352
 353     if (darray_empty(from->aliases))
 354         return true;
 355
 356     if (darray_empty(into->aliases)) {
 357         into->aliases = from->aliases;
 358         darray_init(from->aliases);
 359         return true;
 360     }
 361
 362     memset(&def, 0, sizeof(def));
 363
 364     darray_foreach(alias, from->aliases) {
 365         def.merge = (merge == MERGE_DEFAULT) ? alias->merge : merge;
 366         def.alias = alias->alias;
 367         def.real = alias->real;
 368
 369         if (!HandleAliasDef(into, &def, def.merge))
 370             return false;
 371     }
 372
 373     return true;
 374 }
 375
 376 static void
 377 MergeIncludedKeycodes(KeyNamesInfo *into, KeyNamesInfo *from,
 378                       enum merge_mode merge)
 379 {
 380     xkb_keycode_t i;
 381     xkb_led_index_t idx;
 382     LedNameInfo *ledi;
 383
 384     if (from->errorCount > 0) {
 385         into->errorCount += from->errorCount;
 386         return;
 387     }
 388
 389     if (into->name == NULL) {
 390         into->name = from->name;
 391         from->name = NULL;
 392     }
 393
 394     if (darray_size(into->key_names) < darray_size(from->key_names))
 395         darray_resize0(into->key_names, darray_size(from->key_names));
 396
 397     for (i = from->min_key_code; i <= from->max_key_code; i++) {
 398         xkb_atom_t name = darray_item(from->key_names, i).name;
 399         if (name == XKB_ATOM_NONE)
 400             continue;
 401
 402         if (!AddKeyName(into, i, name, merge, from->file_id, false))
 403             into->errorCount++;
 404     }
 405
 406     darray_enumerate(idx, ledi, from->led_names) {
 407         if (ledi->name == XKB_ATOM_NONE)
 408             continue;
 409
 410         ledi->merge = (merge == MERGE_DEFAULT ? ledi->merge : merge);
 411         if (!AddLedName(into, ledi->merge, ledi, idx))
 412             into->errorCount++;
 413     }
 414
 415     if (!MergeAliases(into, from, merge))
 416         into->errorCount++;
 417 }
 418
 419 static void
 420 HandleKeycodesFile(KeyNamesInfo *info, XkbFile *file, enum merge_mode merge);
 421
 422 static bool
 423 HandleIncludeKeycodes(KeyNamesInfo *info, IncludeStmt *include)
 424 {
 425     KeyNamesInfo included;
 426
 427     InitKeyNamesInfo(&included, info->ctx, info->file_id);
 428     included.name = include->stmt;
 429     include->stmt = NULL;
 430
 431     for (IncludeStmt *stmt = include; stmt; stmt = stmt->next_incl) {
 432         KeyNamesInfo next_incl;
 433         XkbFile *file;
 434
 435         file = ProcessIncludeFile(info->ctx, stmt, FILE_TYPE_KEYCODES);
 436         if (!file) {
 437             info->errorCount += 10;
 438             ClearKeyNamesInfo(&included);
 439             return false;
 440         }
 441
 442         InitKeyNamesInfo(&next_incl, info->ctx, file->id);
 443
 444         HandleKeycodesFile(&next_incl, file, MERGE_OVERRIDE);
 445
 446         MergeIncludedKeycodes(&included, &next_incl, stmt->merge);
 447
 448         ClearKeyNamesInfo(&next_incl);
 449         FreeXkbFile(file);
 450     }
 451
 452     MergeIncludedKeycodes(info, &included, include->merge);
 453     ClearKeyNamesInfo(&included);
 454
 455     return (info->errorCount == 0);
 456 }
 457
 458 static bool
 459 HandleKeycodeDef(KeyNamesInfo *info, KeycodeDef *stmt, enum merge_mode merge)
 460 {
 461     if (stmt->merge != MERGE_DEFAULT) {
 462         if (stmt->merge == MERGE_REPLACE)
 463             merge = MERGE_OVERRIDE;
 464         else
 465             merge = stmt->merge;
 466     }
 467
 468     if (stmt->value < 0 || stmt->value > XKB_KEYCODE_MAX) {
 469         log_err(info->ctx,
 470                 "Illegal keycode %lld: must be between 0..%u; "
 471                 "Key ignored\n", (long long) stmt->value, XKB_KEYCODE_MAX);
 472         return false;
 473     }
 474
 475     return AddKeyName(info, stmt->value, stmt->name, merge,
 476                       info->file_id, true);
 477 }
 478
 479 static int
 480 HandleAliasDef(KeyNamesInfo *info, KeyAliasDef *def, enum merge_mode merge)
 481 {
 482     AliasInfo *old, new;
 483
 484     darray_foreach(old, info->aliases) {
 485         if (old->alias == def->alias) {
 486             if (def->real == old->real) {
 487                 log_vrb(info->ctx, 1,
 488                         "Alias of %s for %s declared more than once; "
 489                         "First definition ignored\n",
 490                         KeyNameText(info->ctx, def->alias),
 491                         KeyNameText(info->ctx, def->real));
 492             }
 493             else {
 494                 xkb_atom_t use, ignore;
 495
 496                 use = (merge == MERGE_AUGMENT ? old->real : def->real);
 497                 ignore = (merge == MERGE_AUGMENT ? def->real : old->real);
 498
 499                 log_warn(info->ctx,
 500                          "Multiple definitions for alias %s; "
 501                          "Using %s, ignoring %s\n",
 502                          KeyNameText(info->ctx, old->alias),
 503                          KeyNameText(info->ctx, use),
 504                          KeyNameText(info->ctx, ignore));
 505
 506                 old->real = use;
 507             }
 508
 509             old->merge = merge;
 510             return true;
 511         }
 512     }
 513
 514     InitAliasInfo(&new, merge, def->alias, def->real);
 515     darray_append(info->aliases, new);
 516     return true;
 517 }
 518
 519 static int
 520 HandleKeyNameVar(KeyNamesInfo *info, VarDef *stmt)
 521 {
 522     const char *elem, *field;
 523     ExprDef *arrayNdx;
 524
 525     if (!ExprResolveLhs(info->ctx, stmt->name, &elem, &field, &arrayNdx))
 526         return false;
 527
 528     if (elem) {
 529         log_err(info->ctx, "Unknown element %s encountered; "
 530                 "Default for field %s ignored\n", elem, field);
 531         return false;
 532     }
 533
 534     if (!istreq(field, "minimum") && !istreq(field, "maximum")) {
 535         log_err(info->ctx, "Unknown field encountered; "
 536                 "Assignment to field %s ignored\n", field);
 537         return false;
 538     }
 539
 540     /* We ignore explicit min/max statements, we always use computed. */
 541     return true;
 542 }
 543
 544 static int
 545 HandleLedNameDef(KeyNamesInfo *info, LedNameDef *def,
 546                  enum merge_mode merge)
 547 {
 548     LedNameInfo ledi;
 549     xkb_atom_t name;
 550
 551     if (def->ndx < 1 || def->ndx > XKB_MAX_LEDS) {
 552         info->errorCount++;
 553         log_err(info->ctx,
 554                 "Illegal indicator index (%d) specified; must be between 1 .. %d; "
 555                 "Ignored\n", def->ndx, XKB_MAX_LEDS);
 556         return false;
 557     }
 558
 559     if (!ExprResolveString(info->ctx, def->name, &name)) {
 560         char buf[20];
 561         snprintf(buf, sizeof(buf), "%d", def->ndx);
 562         info->errorCount++;
 563         return ReportBadType(info->ctx, "indicator", "name", buf, "string");
 564     }
 565
 566     ledi.merge = info->merge;
 567     ledi.file_id = info->file_id;
 568     ledi.name = name;
 569     return AddLedName(info, merge, &ledi, def->ndx - 1);
 570 }
 571
 572 static void
 573 HandleKeycodesFile(KeyNamesInfo *info, XkbFile *file, enum merge_mode merge)
 574 {
 575     bool ok;
 576
 577     free(info->name);
 578     info->name = strdup_safe(file->name);
 579
 580     for (ParseCommon *stmt = file->defs; stmt; stmt = stmt->next) {
 581         switch (stmt->type) {
 582         case STMT_INCLUDE:
 583             ok = HandleIncludeKeycodes(info, (IncludeStmt *) stmt);
 584             break;
 585         case STMT_KEYCODE:
 586             ok = HandleKeycodeDef(info, (KeycodeDef *) stmt, merge);
 587             break;
 588         case STMT_ALIAS:
 589             ok = HandleAliasDef(info, (KeyAliasDef *) stmt, merge);
 590             break;
 591         case STMT_VAR:
 592             ok = HandleKeyNameVar(info, (VarDef *) stmt);
 593             break;
 594         case STMT_LED_NAME:
 595             ok = HandleLedNameDef(info, (LedNameDef *) stmt, merge);
 596             break;
 597         default:
 598             log_err(info->ctx,
 599                     "Keycode files may define key and indicator names only; "
 600                     "Ignoring %s\n", stmt_type_to_string(stmt->type));
 601             ok = false;
 602             break;
 603         }
 604
 605         if (!ok)
 606             info->errorCount++;
 607
 608         if (info->errorCount > 10) {
 609             log_err(info->ctx, "Abandoning keycodes file \"%s\"\n",
 610                     file->topName);
 611             break;
 612         }
 613     }
 614 }
 615
 616 /***====================================================================***/
 617
 618 static void
 619 CopyAliasesToKeymap(KeyNamesInfo *info, struct xkb_keymap *keymap)
 620 {
 621     AliasInfo *alias;
 622
 623     darray_foreach(alias, info->aliases) {
 624         struct xkb_key *key;
 625         struct xkb_key_alias new;
 626
 627         /* Check that ->real is a key. */
 628         key = FindNamedKey(keymap, alias->real, false);
 629         if (!key) {
 630             log_vrb(info->ctx, 5,
 631                     "Attempt to alias %s to non-existent key %s; Ignored\n",
 632                     KeyNameText(info->ctx, alias->alias),
 633                     KeyNameText(info->ctx, alias->real));
 634             continue;
 635         }
 636
 637         /* Check that ->alias is not a key. */
 638         key = FindNamedKey(keymap, alias->alias, false);
 639         if (key) {
 640             log_vrb(info->ctx, 5,
 641                     "Attempt to create alias with the name of a real key; "
 642                     "Alias \"%s = %s\" ignored\n",
 643                     KeyNameText(info->ctx, alias->alias),
 644                     KeyNameText(info->ctx, alias->real));
 645             continue;
 646         }
 647
 648         /* Add the alias. */
 649         new.alias = alias->alias;
 650         new.real = alias->real;
 651         darray_append(keymap->key_aliases, new);
 652     }
 653
 654     darray_free(info->aliases);
 655 }
 656
 657 static bool
 658 CopyKeyNamesToKeymap(struct xkb_keymap *keymap, KeyNamesInfo *info)
 659 {
 660     xkb_keycode_t kc;
 661     xkb_led_index_t idx;
 662     LedNameInfo *ledi;
 663
 664     keymap->keys = calloc(info->max_key_code + 1, sizeof(*keymap->keys));
 665     if (!keymap->keys)
 666         return false;
 667
 668     keymap->min_key_code = info->min_key_code;
 669     keymap->max_key_code = info->max_key_code;
 670
 671     for (kc = info->min_key_code; kc <= info->max_key_code; kc++) {
 672         keymap->keys[kc].keycode = kc;
 673         keymap->keys[kc].name = darray_item(info->key_names, kc).name;
 674     }
 675
 676     keymap->keycodes_section_name = strdup_safe(info->name);
 677
 678     darray_resize0(keymap->leds, darray_size(info->led_names));
 679     darray_enumerate(idx, ledi, info->led_names) {
 680         if (ledi->name == XKB_ATOM_NONE)
 681             continue;
 682
 683         darray_item(keymap->leds, idx).name = ledi->name;
 684     }
 685
 686     CopyAliasesToKeymap(info, keymap);
 687
 688     return true;
 689 }
 690
 691 /***====================================================================***/
 692
 693 bool
 694 CompileKeycodes(XkbFile *file, struct xkb_keymap *keymap,
 695                 enum merge_mode merge)
 696 {
 697     KeyNamesInfo info;
 698
 699     InitKeyNamesInfo(&info, keymap->ctx, file->id);
 700
 701     HandleKeycodesFile(&info, file, merge);
 702     if (info.errorCount != 0)
 703         goto err_info;
 704
 705     if (!CopyKeyNamesToKeymap(keymap, &info))
 706         goto err_info;
 707
 708     ClearKeyNamesInfo(&info);
 709     return true;
 710
 711 err_info:
 712     ClearKeyNamesInfo(&info);
 713     return false;
 714 }
 715
 716 /***====================================================================***/
 717
 718 struct xkb_key *
 719 FindNamedKey(struct xkb_keymap *keymap, xkb_atom_t name, bool use_aliases)
 720 {
 721     struct xkb_key *key;
 722
 723     xkb_foreach_key(key, keymap)
 724         if (key->name == name)
 725             return key;
 726
 727     if (use_aliases) {
 728         xkb_atom_t new_name;
 729         if (FindKeyNameForAlias(keymap, name, &new_name))
 730             return FindNamedKey(keymap, new_name, false);
 731     }
 732
 733     return NULL;
 734 }
 735
 736 bool
 737 FindKeyNameForAlias(struct xkb_keymap *keymap, xkb_atom_t name,
 738                     xkb_atom_t *real_name)
 739 {
 740     const struct xkb_key_alias *a;
 741
 742     darray_foreach(a, keymap->key_aliases) {
 743         if (name == a->alias) {
 744             *real_name = a->real;
 745             return true;
 746         }
 747     }
 748
 749     return false;
 750 }