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