Change 'indicator' to 'led' everywhere possible
[platform/upstream/libxkbcommon.git] / 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     unsigned file_id;
108
109     xkb_atom_t alias;
110     xkb_atom_t real;
111 } AliasInfo;
112
113 typedef struct {
114     unsigned int file_id;
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;     /* e.g. evdev+aliases(qwerty) */
127     int errorCount;
128     unsigned file_id;
129     enum merge_mode merge;
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 static void
141 InitAliasInfo(AliasInfo *info, enum merge_mode merge, unsigned file_id,
142               xkb_atom_t alias, xkb_atom_t real)
143 {
144     memset(info, 0, sizeof(*info));
145     info->merge = merge;
146     info->file_id = file_id;
147     info->alias = alias;
148     info->real = real;
149 }
150
151 static LedNameInfo *
152 FindLedByName(KeyNamesInfo *info, xkb_atom_t name,
153               xkb_led_index_t *idx_out)
154 {
155     LedNameInfo *ledi;
156     xkb_led_index_t idx;
157
158     darray_enumerate(idx, ledi, info->led_names) {
159         if (ledi->name == name) {
160             *idx_out = idx;
161             return ledi;
162         }
163     }
164
165     return NULL;
166 }
167
168 static bool
169 AddLedName(KeyNamesInfo *info, enum merge_mode merge,
170            LedNameInfo *new, xkb_led_index_t new_idx)
171 {
172     xkb_led_index_t old_idx;
173     LedNameInfo *old;
174     const bool replace = (merge == MERGE_REPLACE || merge == MERGE_OVERRIDE);
175     int verbosity = xkb_context_get_log_verbosity(info->ctx);
176
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, "Multiple indicators named %s; "
196                      "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         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     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 occurences 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                unsigned file_id);
347
348 static bool
349 MergeAliases(KeyNamesInfo *into, KeyNamesInfo *from, enum merge_mode merge)
350 {
351     AliasInfo *alias;
352     KeyAliasDef def;
353
354     if (darray_empty(from->aliases))
355         return true;
356
357     if (darray_empty(into->aliases)) {
358         into->aliases = from->aliases;
359         darray_init(from->aliases);
360         return true;
361     }
362
363     memset(&def, 0, sizeof(def));
364
365     darray_foreach(alias, from->aliases) {
366         def.merge = (merge == MERGE_DEFAULT) ? alias->merge : merge;
367         def.alias = alias->alias;
368         def.real = alias->real;
369
370         if (!HandleAliasDef(into, &def, def.merge, alias->file_id))
371             return false;
372     }
373
374     return true;
375 }
376
377 static void
378 MergeIncludedKeycodes(KeyNamesInfo *into, KeyNamesInfo *from,
379                       enum merge_mode merge)
380 {
381     xkb_keycode_t i;
382     xkb_led_index_t idx;
383     LedNameInfo *ledi;
384
385     if (from->errorCount > 0) {
386         into->errorCount += from->errorCount;
387         return;
388     }
389
390     if (into->name == NULL) {
391         into->name = from->name;
392         from->name = NULL;
393     }
394
395     if (darray_size(into->key_names) < darray_size(from->key_names))
396         darray_resize0(into->key_names, darray_size(from->key_names));
397
398     for (i = from->min_key_code; i <= from->max_key_code; i++) {
399         xkb_atom_t name = darray_item(from->key_names, i).name;
400         if (name == XKB_ATOM_NONE)
401             continue;
402
403         if (!AddKeyName(into, i, name, merge, from->file_id, false))
404             into->errorCount++;
405     }
406
407     darray_enumerate(idx, ledi, from->led_names) {
408         if (ledi->name == XKB_ATOM_NONE)
409             continue;
410
411         ledi->merge = (merge == MERGE_DEFAULT ? ledi->merge : merge);
412         if (!AddLedName(into, ledi->merge, ledi, idx))
413             into->errorCount++;
414     }
415
416     if (!MergeAliases(into, from, merge))
417         into->errorCount++;
418 }
419
420 static void
421 HandleKeycodesFile(KeyNamesInfo *info, XkbFile *file, enum merge_mode merge);
422
423 static bool
424 HandleIncludeKeycodes(KeyNamesInfo *info, IncludeStmt *stmt)
425 {
426     enum merge_mode merge = MERGE_DEFAULT;
427     XkbFile *rtrn;
428     KeyNamesInfo included, next_incl;
429
430     InitKeyNamesInfo(&included, info->ctx, info->file_id);
431     if (stmt->stmt) {
432         free(included.name);
433         included.name = stmt->stmt;
434         stmt->stmt = NULL;
435     }
436
437     for (; stmt; stmt = stmt->next_incl) {
438         if (!ProcessIncludeFile(info->ctx, stmt, FILE_TYPE_KEYCODES,
439                                 &rtrn, &merge)) {
440             info->errorCount += 10;
441             ClearKeyNamesInfo(&included);
442             return false;
443         }
444
445         InitKeyNamesInfo(&next_incl, info->ctx, rtrn->id);
446
447         HandleKeycodesFile(&next_incl, rtrn, MERGE_OVERRIDE);
448
449         MergeIncludedKeycodes(&included, &next_incl, merge);
450
451         ClearKeyNamesInfo(&next_incl);
452         FreeXkbFile(rtrn);
453     }
454
455     MergeIncludedKeycodes(info, &included, merge);
456     ClearKeyNamesInfo(&included);
457
458     return (info->errorCount == 0);
459 }
460
461 static bool
462 HandleKeycodeDef(KeyNamesInfo *info, KeycodeDef *stmt, enum merge_mode merge)
463 {
464     if (stmt->merge != MERGE_DEFAULT) {
465         if (stmt->merge == MERGE_REPLACE)
466             merge = MERGE_OVERRIDE;
467         else
468             merge = stmt->merge;
469     }
470
471     if (stmt->value < 0 || stmt->value > XKB_KEYCODE_MAX) {
472         log_err(info->ctx,
473                 "Illegal keycode %lld: must be between 0..%u; "
474                 "Key ignored\n", (long long) stmt->value, XKB_KEYCODE_MAX);
475         return false;
476     }
477
478     return AddKeyName(info, stmt->value, stmt->name, merge,
479                       info->file_id, true);
480 }
481
482 static void
483 HandleAliasCollision(KeyNamesInfo *info, AliasInfo *old, AliasInfo *new)
484 {
485     int verbosity = xkb_context_get_log_verbosity(info->ctx);
486     bool report = ((new->file_id == old->file_id && verbosity > 0) ||
487                    verbosity > 9);
488
489     if (new->real == old->real) {
490         if (report)
491             log_warn(info->ctx, "Alias of %s for %s declared more than once; "
492                      "First definition ignored\n",
493                      KeyNameText(info->ctx, new->alias),
494                      KeyNameText(info->ctx, new->real));
495     }
496     else {
497         xkb_atom_t use, ignore;
498
499         use = (new->merge == MERGE_AUGMENT ? old->real : new->real);
500         ignore = (new->merge == MERGE_AUGMENT ? new->real : old->real);
501
502         if (report)
503             log_warn(info->ctx, "Multiple definitions for alias %s; "
504                      "Using %s, ignoring %s\n",
505                      KeyNameText(info->ctx, old->alias),
506                      KeyNameText(info->ctx, use),
507                      KeyNameText(info->ctx, ignore));
508
509         old->real = use;
510     }
511
512     old->file_id = new->file_id;
513     old->merge = new->merge;
514 }
515
516 static int
517 HandleAliasDef(KeyNamesInfo *info, KeyAliasDef *def, enum merge_mode merge,
518                unsigned file_id)
519 {
520     AliasInfo *alias, new;
521
522     darray_foreach(alias, info->aliases) {
523         if (alias->alias == def->alias) {
524             InitAliasInfo(&new, merge, file_id, def->alias, def->real);
525             HandleAliasCollision(info, alias, &new);
526             return true;
527         }
528     }
529
530     InitAliasInfo(&new, merge, file_id, def->alias, def->real);
531     darray_append(info->aliases, new);
532     return true;
533 }
534
535 static int
536 HandleKeyNameVar(KeyNamesInfo *info, VarDef *stmt)
537 {
538     const char *elem, *field;
539     ExprDef *arrayNdx;
540
541     if (!ExprResolveLhs(info->ctx, stmt->name, &elem, &field, &arrayNdx))
542         return false;
543
544     if (elem) {
545         log_err(info->ctx, "Unknown element %s encountered; "
546                 "Default for field %s ignored\n", elem, field);
547         return false;
548     }
549
550     if (!istreq(field, "minimum") && !istreq(field, "maximum")) {
551         log_err(info->ctx, "Unknown field encountered; "
552                 "Assigment to field %s ignored\n", field);
553         return false;
554     }
555
556     /* We ignore explicit min/max statements, we always use computed. */
557     return true;
558 }
559
560 static int
561 HandleLedNameDef(KeyNamesInfo *info, LedNameDef *def,
562                  enum merge_mode merge)
563 {
564     LedNameInfo ledi;
565     xkb_atom_t name;
566
567     if (def->ndx < 1 || def->ndx > XKB_MAX_LEDS) {
568         info->errorCount++;
569         log_err(info->ctx,
570                 "Illegal indicator index (%d) specified; must be between 1 .. %d; "
571                 "Ignored\n", def->ndx, XKB_MAX_LEDS);
572         return false;
573     }
574
575     if (!ExprResolveString(info->ctx, def->name, &name)) {
576         char buf[20];
577         snprintf(buf, sizeof(buf), "%d", def->ndx);
578         info->errorCount++;
579         return ReportBadType(info->ctx, "indicator", "name", buf,
580                              "string");
581     }
582
583     ledi.merge = info->merge;
584     ledi.file_id = info->file_id;
585     ledi.name = name;
586     return AddLedName(info, merge, &ledi, def->ndx - 1);
587 }
588
589 static void
590 HandleKeycodesFile(KeyNamesInfo *info, XkbFile *file, enum merge_mode merge)
591 {
592     ParseCommon *stmt;
593     bool ok;
594
595     free(info->name);
596     info->name = strdup_safe(file->name);
597
598     for (stmt = file->defs; stmt; stmt = stmt->next) {
599         switch (stmt->type) {
600         case STMT_INCLUDE:
601             ok = HandleIncludeKeycodes(info, (IncludeStmt *) stmt);
602             break;
603         case STMT_KEYCODE:
604             ok = HandleKeycodeDef(info, (KeycodeDef *) stmt, merge);
605             break;
606         case STMT_ALIAS:
607             ok = HandleAliasDef(info, (KeyAliasDef *) stmt, merge,
608                                 info->file_id);
609             break;
610         case STMT_VAR:
611             ok = HandleKeyNameVar(info, (VarDef *) stmt);
612             break;
613         case STMT_LED_NAME:
614             ok = HandleLedNameDef(info, (LedNameDef *) stmt, merge);
615             break;
616         default:
617             log_err(info->ctx,
618                     "Keycode files may define key and indicator names only; "
619                     "Ignoring %s\n", stmt_type_to_string(stmt->type));
620             ok = false;
621             break;
622         }
623
624         if (!ok)
625             info->errorCount++;
626
627         if (info->errorCount > 10) {
628             log_err(info->ctx, "Abandoning keycodes file \"%s\"\n",
629                     file->topName);
630             break;
631         }
632     }
633 }
634
635 static void
636 ApplyAliases(KeyNamesInfo *info, struct xkb_keymap *keymap)
637 {
638     struct xkb_key *key;
639     struct xkb_key_alias *a, new;
640     AliasInfo *alias;
641
642     darray_foreach(alias, info->aliases) {
643         /* Check that ->real is a key. */
644         key = FindNamedKey(keymap, alias->real, false);
645         if (!key) {
646             log_vrb(info->ctx, 5,
647                     "Attempt to alias %s to non-existent key %s; Ignored\n",
648                     KeyNameText(info->ctx, alias->alias),
649                     KeyNameText(info->ctx, alias->real));
650             continue;
651         }
652
653         /* Check that ->alias is not a key. */
654         key = FindNamedKey(keymap, alias->alias, false);
655         if (key) {
656             log_vrb(info->ctx, 5,
657                     "Attempt to create alias with the name of a real key; "
658                     "Alias \"%s = %s\" ignored\n",
659                     KeyNameText(info->ctx, alias->alias),
660                     KeyNameText(info->ctx, alias->real));
661             continue;
662         }
663
664         /* Check that ->alias in not already an alias, and if so handle it. */
665         darray_foreach(a, keymap->key_aliases) {
666             AliasInfo old_alias;
667
668             if (a->alias != alias->alias)
669                 continue;
670
671             InitAliasInfo(&old_alias, MERGE_AUGMENT, 0, a->alias, a->real);
672             HandleAliasCollision(info, &old_alias, alias);
673             a->alias = old_alias.alias;
674             a->real = old_alias.real;
675             alias->alias = 0;
676         }
677         if (alias->alias == 0)
678             continue;
679
680         /* Add the alias. */
681         new.alias = alias->alias;
682         new.real = alias->real;
683         darray_append(keymap->key_aliases, new);
684     }
685
686     darray_free(info->aliases);
687 }
688
689 static bool
690 CopyKeyNamesToKeymap(struct xkb_keymap *keymap, KeyNamesInfo *info)
691 {
692     xkb_keycode_t kc;
693     xkb_led_index_t idx;
694     LedNameInfo *ledi;
695
696     keymap->keys = calloc(info->max_key_code + 1, sizeof(*keymap->keys));
697     if (!keymap->keys)
698         return false;
699
700     keymap->min_key_code = info->min_key_code;
701     keymap->max_key_code = info->max_key_code;
702
703     for (kc = info->min_key_code; kc <= info->max_key_code; kc++) {
704         keymap->keys[kc].keycode = kc;
705         keymap->keys[kc].name = darray_item(info->key_names, kc).name;
706     }
707
708     keymap->keycodes_section_name = strdup_safe(info->name);
709
710     darray_resize0(keymap->leds, darray_size(info->led_names));
711     darray_enumerate(idx, ledi, info->led_names) {
712         if (ledi->name == XKB_ATOM_NONE)
713             continue;
714
715         darray_item(keymap->leds, idx).name = ledi->name;
716     }
717
718     ApplyAliases(info, keymap);
719
720     return true;
721 }
722
723 bool
724 CompileKeycodes(XkbFile *file, struct xkb_keymap *keymap,
725                 enum merge_mode merge)
726 {
727     KeyNamesInfo info;
728
729     InitKeyNamesInfo(&info, keymap->ctx, file->id);
730
731     HandleKeycodesFile(&info, file, merge);
732     if (info.errorCount != 0)
733         goto err_info;
734
735     if (!CopyKeyNamesToKeymap(keymap, &info))
736         goto err_info;
737
738     ClearKeyNamesInfo(&info);
739     return true;
740
741 err_info:
742     ClearKeyNamesInfo(&info);
743     return false;
744 }
745
746 struct xkb_key *
747 FindNamedKey(struct xkb_keymap *keymap, xkb_atom_t name, bool use_aliases)
748 {
749     struct xkb_key *key;
750
751     xkb_foreach_key(key, keymap)
752         if (key->name == name)
753             return key;
754
755     if (use_aliases) {
756         xkb_atom_t new_name;
757         if (FindKeyNameForAlias(keymap, name, &new_name))
758             return FindNamedKey(keymap, new_name, false);
759     }
760
761     return NULL;
762 }
763
764 bool
765 FindKeyNameForAlias(struct xkb_keymap *keymap, xkb_atom_t name,
766                     xkb_atom_t *real_name)
767 {
768     struct xkb_key_alias *a;
769
770     darray_foreach(a, keymap->key_aliases) {
771         if (name == a->alias) {
772             *real_name = a->real;
773             return true;
774         }
775     }
776
777     return false;
778 }