1 /************************************************************
2 * Copyright (c) 1994 by Silicon Graphics Computer Systems, Inc.
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.
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.
25 ********************************************************/
27 #include "xkbcomp-priv.h"
33 * The xkb_keycodes section
34 * ========================
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.
43 * Statements of the form:
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.
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
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
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).
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.
70 * Statements of the form:
71 * alias <MENU> = <COMP>;
73 * Allows to refer to a previously defined key (here <COMP>) by another
74 * name (here <MENU>). Conflicts are handled similarly.
77 * -------------------------
78 * Statements of the form:
79 * indicator 1 = "Caps Lock";
80 * indicator 2 = "Num Lock";
81 * indicator 3 = "Scroll Lock";
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
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.
106 enum merge_mode merge;
119 enum merge_mode merge;
128 enum merge_mode merge;
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;
137 struct xkb_context *ctx;
140 /***====================================================================***/
143 InitAliasInfo(AliasInfo *info, enum merge_mode merge,
144 xkb_atom_t alias, xkb_atom_t real)
146 memset(info, 0, sizeof(*info));
153 FindLedByName(KeyNamesInfo *info, xkb_atom_t name,
154 xkb_led_index_t *idx_out)
159 darray_enumerate(idx, ledi, info->led_names) {
160 if (ledi->name == name) {
170 AddLedName(KeyNamesInfo *info, enum merge_mode merge,
171 LedNameInfo *new, xkb_led_index_t new_idx)
173 xkb_led_index_t old_idx;
175 const int verbosity = xkb_context_get_log_verbosity(info->ctx);
176 const bool replace = (merge == MERGE_REPLACE || merge == MERGE_OVERRIDE);
178 /* Inidicator with the same name already exists. */
179 old = FindLedByName(info, new->name, &old_idx);
181 const bool report = ((old->file_id == new->file_id && verbosity > 0) ||
184 if (old_idx == new_idx) {
186 "Multiple indicators named \"%s\"; "
187 "Identical definitions ignored\n",
188 xkb_atom_text(info->ctx, new->name));
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);
196 "Multiple indicators named %s; Using %d, ignoring %d\n",
197 xkb_atom_text(info->ctx, new->name), use, ignore);
206 if (new_idx >= darray_size(info->led_names))
207 darray_resize0(info->led_names, new_idx + 1);
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) ||
215 /* Same name case already handled above. */
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));
232 darray_item(info->led_names, new_idx) = *new;
237 ClearKeyNamesInfo(KeyNamesInfo *info)
240 darray_free(info->key_names);
241 darray_free(info->aliases);
242 darray_free(info->led_names);
246 InitKeyNamesInfo(KeyNamesInfo *info, struct xkb_context *ctx,
249 memset(info, 0, sizeof(*info));
251 info->merge = MERGE_DEFAULT;
252 info->file_id = file_id;
253 info->min_key_code = XKB_KEYCODE_MAX;
257 FindKeyByName(KeyNamesInfo * info, xkb_atom_t name)
261 for (i = info->min_key_code; i <= info->max_key_code; i++)
262 if (darray_item(info->key_names, i).name == name)
265 return XKB_KEYCODE_INVALID;
269 AddKeyName(KeyNamesInfo *info, xkb_keycode_t kc, xkb_atom_t name,
270 enum merge_mode merge, unsigned file_id, bool report)
274 const int verbosity = xkb_context_get_log_verbosity(info->ctx);
276 if (kc >= darray_size(info->key_names))
277 darray_resize0(info->key_names, kc + 1);
279 info->min_key_code = MIN(info->min_key_code, kc);
280 info->max_key_code = MAX(info->max_key_code, kc);
282 namei = &darray_item(info->key_names, kc);
284 report = report && ((verbosity > 0 && file_id == namei->file_id) ||
287 if (namei->name != 0) {
288 const char *lname = KeyNameText(info->ctx, namei->name);
289 const char *kname = KeyNameText(info->ctx, name);
291 if (namei->name == name) {
294 "Multiple identical key name definitions; "
295 "Later occurrences of \"%s = %d\" ignored\n",
299 else if (merge == MERGE_AUGMENT) {
302 "Multiple names for keycode %d; "
303 "Using %s, ignoring %s\n", kc, lname, kname);
309 "Multiple names for keycode %d; "
310 "Using %s, ignoring %s\n", kc, kname, lname);
316 old = FindKeyByName(info, name);
317 if (old != XKB_KEYCODE_INVALID && old != kc) {
318 const char *kname = KeyNameText(info->ctx, name);
320 if (merge == MERGE_OVERRIDE) {
321 darray_item(info->key_names, old).name = 0;
322 darray_item(info->key_names, old).file_id = 0;
325 "Key name %s assigned to multiple keys; "
326 "Using %d, ignoring %d\n", kname, kc, old);
330 log_vrb(info->ctx, 3,
331 "Key name %s assigned to multiple keys; "
332 "Using %d, ignoring %d\n", kname, old, kc);
338 namei->file_id = file_id;
342 /***====================================================================***/
345 HandleAliasDef(KeyNamesInfo *info, KeyAliasDef *def, enum merge_mode merge);
348 MergeIncludedKeycodes(KeyNamesInfo *into, KeyNamesInfo *from,
349 enum merge_mode merge)
351 if (from->errorCount > 0) {
352 into->errorCount += from->errorCount;
356 if (into->name == NULL) {
357 into->name = from->name;
361 /* Merge key names. */
362 if (darray_empty(into->key_names)) {
363 into->key_names = from->key_names;
364 darray_init(from->key_names);
365 into->min_key_code = from->min_key_code;
366 into->max_key_code = from->max_key_code;
369 if (darray_size(into->key_names) < darray_size(from->key_names))
370 darray_resize0(into->key_names, darray_size(from->key_names));
372 for (unsigned i = from->min_key_code; i <= from->max_key_code; i++) {
373 xkb_atom_t name = darray_item(from->key_names, i).name;
374 if (name == XKB_ATOM_NONE)
377 if (!AddKeyName(into, i, name, merge, from->file_id, false))
382 /* Merge key aliases. */
383 if (darray_empty(into->aliases)) {
384 into->aliases = from->aliases;
385 darray_init(from->aliases);
390 darray_foreach(alias, from->aliases) {
393 def.merge = (merge == MERGE_DEFAULT ? alias->merge : merge);
394 def.alias = alias->alias;
395 def.real = alias->real;
397 if (!HandleAliasDef(into, &def, def.merge))
402 /* Merge LED names. */
403 if (darray_empty(into->led_names)) {
404 into->led_names = from->led_names;
405 darray_init(from->led_names);
411 darray_enumerate(idx, ledi, from->led_names) {
412 if (ledi->name == XKB_ATOM_NONE)
415 ledi->merge = (merge == MERGE_DEFAULT ? ledi->merge : merge);
416 if (!AddLedName(into, ledi->merge, ledi, idx))
423 HandleKeycodesFile(KeyNamesInfo *info, XkbFile *file, enum merge_mode merge);
426 HandleIncludeKeycodes(KeyNamesInfo *info, IncludeStmt *include)
428 KeyNamesInfo included;
430 InitKeyNamesInfo(&included, info->ctx, info->file_id);
431 included.name = include->stmt;
432 include->stmt = NULL;
434 for (IncludeStmt *stmt = include; stmt; stmt = stmt->next_incl) {
435 KeyNamesInfo next_incl;
438 file = ProcessIncludeFile(info->ctx, stmt, FILE_TYPE_KEYCODES);
440 info->errorCount += 10;
441 ClearKeyNamesInfo(&included);
445 InitKeyNamesInfo(&next_incl, info->ctx, file->id);
447 HandleKeycodesFile(&next_incl, file, MERGE_OVERRIDE);
449 MergeIncludedKeycodes(&included, &next_incl, stmt->merge);
451 ClearKeyNamesInfo(&next_incl);
455 MergeIncludedKeycodes(info, &included, include->merge);
456 ClearKeyNamesInfo(&included);
458 return (info->errorCount == 0);
462 HandleKeycodeDef(KeyNamesInfo *info, KeycodeDef *stmt, enum merge_mode merge)
464 if (stmt->merge != MERGE_DEFAULT) {
465 if (stmt->merge == MERGE_REPLACE)
466 merge = MERGE_OVERRIDE;
471 if (stmt->value < 0 || stmt->value > XKB_KEYCODE_MAX) {
473 "Illegal keycode %lld: must be between 0..%u; "
474 "Key ignored\n", (long long) stmt->value, XKB_KEYCODE_MAX);
478 return AddKeyName(info, stmt->value, stmt->name, merge,
479 info->file_id, true);
483 HandleAliasDef(KeyNamesInfo *info, KeyAliasDef *def, enum merge_mode merge)
487 darray_foreach(old, info->aliases) {
488 if (old->alias == def->alias) {
489 if (def->real == old->real) {
490 log_vrb(info->ctx, 1,
491 "Alias of %s for %s declared more than once; "
492 "First definition ignored\n",
493 KeyNameText(info->ctx, def->alias),
494 KeyNameText(info->ctx, def->real));
497 xkb_atom_t use, ignore;
499 use = (merge == MERGE_AUGMENT ? old->real : def->real);
500 ignore = (merge == MERGE_AUGMENT ? def->real : old->real);
503 "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));
517 InitAliasInfo(&new, merge, def->alias, def->real);
518 darray_append(info->aliases, new);
523 HandleKeyNameVar(KeyNamesInfo *info, VarDef *stmt)
525 const char *elem, *field;
528 if (!ExprResolveLhs(info->ctx, stmt->name, &elem, &field, &arrayNdx))
532 log_err(info->ctx, "Unknown element %s encountered; "
533 "Default for field %s ignored\n", elem, field);
537 if (!istreq(field, "minimum") && !istreq(field, "maximum")) {
538 log_err(info->ctx, "Unknown field encountered; "
539 "Assignment to field %s ignored\n", field);
543 /* We ignore explicit min/max statements, we always use computed. */
548 HandleLedNameDef(KeyNamesInfo *info, LedNameDef *def,
549 enum merge_mode merge)
554 if (def->ndx < 1 || def->ndx > XKB_MAX_LEDS) {
557 "Illegal indicator index (%d) specified; must be between 1 .. %d; "
558 "Ignored\n", def->ndx, XKB_MAX_LEDS);
562 if (!ExprResolveString(info->ctx, def->name, &name)) {
564 snprintf(buf, sizeof(buf), "%d", def->ndx);
566 return ReportBadType(info->ctx, "indicator", "name", buf, "string");
569 ledi.merge = info->merge;
570 ledi.file_id = info->file_id;
572 return AddLedName(info, merge, &ledi, def->ndx - 1);
576 HandleKeycodesFile(KeyNamesInfo *info, XkbFile *file, enum merge_mode merge)
581 info->name = strdup_safe(file->name);
583 for (ParseCommon *stmt = file->defs; stmt; stmt = stmt->next) {
584 switch (stmt->type) {
586 ok = HandleIncludeKeycodes(info, (IncludeStmt *) stmt);
589 ok = HandleKeycodeDef(info, (KeycodeDef *) stmt, merge);
592 ok = HandleAliasDef(info, (KeyAliasDef *) stmt, merge);
595 ok = HandleKeyNameVar(info, (VarDef *) stmt);
598 ok = HandleLedNameDef(info, (LedNameDef *) stmt, merge);
602 "Keycode files may define key and indicator names only; "
603 "Ignoring %s\n", stmt_type_to_string(stmt->type));
611 if (info->errorCount > 10) {
612 log_err(info->ctx, "Abandoning keycodes file \"%s\"\n",
619 /***====================================================================***/
622 CopyKeyNamesToKeymap(struct xkb_keymap *keymap, KeyNamesInfo *info)
630 keymap->keycodes_section_name = strdup_safe(info->name);
632 keymap->min_key_code = info->min_key_code;
633 keymap->max_key_code = info->max_key_code;
635 /* Copy key names. */
636 keymap->keys = calloc(info->max_key_code + 1, sizeof(*keymap->keys));
637 for (kc = info->min_key_code; kc <= info->max_key_code; kc++) {
638 keymap->keys[kc].keycode = kc;
639 keymap->keys[kc].name = darray_item(info->key_names, kc).name;
643 * Do some sanity checking on the aliases. We can't do it before
644 * because keys and their aliases may be added out-of-order.
646 keymap->num_key_aliases = 0;
647 darray_foreach(alias, info->aliases) {
648 /* Check that ->real is a key. */
649 if (!XkbKeyByName(keymap, alias->real, false)) {
650 log_vrb(info->ctx, 5,
651 "Attempt to alias %s to non-existent key %s; Ignored\n",
652 KeyNameText(info->ctx, alias->alias),
653 KeyNameText(info->ctx, alias->real));
654 alias->real = XKB_ATOM_NONE;
658 /* Check that ->alias is not a key. */
659 if (XkbKeyByName(keymap, alias->alias, false)) {
660 log_vrb(info->ctx, 5,
661 "Attempt to create alias with the name of a real key; "
662 "Alias \"%s = %s\" ignored\n",
663 KeyNameText(info->ctx, alias->alias),
664 KeyNameText(info->ctx, alias->real));
665 alias->real = XKB_ATOM_NONE;
669 keymap->num_key_aliases++;
672 /* Copy key aliases. */
673 keymap->key_aliases = calloc(keymap->num_key_aliases,
674 sizeof(*keymap->key_aliases));
676 darray_foreach(alias, info->aliases) {
677 if (alias->real != XKB_ATOM_NONE) {
678 keymap->key_aliases[i].alias = alias->alias;
679 keymap->key_aliases[i].real = alias->real;
684 /* Copy LED names. */
685 darray_resize0(keymap->leds, darray_size(info->led_names));
686 darray_enumerate(idx, ledi, info->led_names)
687 if (ledi->name != XKB_ATOM_NONE)
688 darray_item(keymap->leds, idx).name = ledi->name;
693 /***====================================================================***/
696 CompileKeycodes(XkbFile *file, struct xkb_keymap *keymap,
697 enum merge_mode merge)
701 InitKeyNamesInfo(&info, keymap->ctx, file->id);
703 HandleKeycodesFile(&info, file, merge);
704 if (info.errorCount != 0)
707 if (!CopyKeyNamesToKeymap(keymap, &info))
710 ClearKeyNamesInfo(&info);
714 ClearKeyNamesInfo(&info);