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"
34 * The xkb_keycodes section
35 * ========================
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.
44 * Statements of the form:
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.
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
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
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).
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.
71 * Statements of the form:
72 * alias <MENU> = <COMP>;
74 * Allows to refer to a previously defined key (here <COMP>) by another
75 * name (here <MENU>). Conflicts are handled similarly.
77 * Indicator name statements
78 * -------------------------
79 * Statements of the form:
80 * indicator 1 = "Caps Lock";
81 * indicator 2 = "Num Lock";
82 * indicator 3 = "Scroll Lock";
84 * Assigns a name the indicator (i.e. keyboard LED) with the given index.
85 * The amount of possible indicators is predetermined (XKB_NUM_INDICATORS).
86 * The indicator may be referred by this name later in the compat section
89 * Effect on the keymap
90 * --------------------
91 * After all of the xkb_keycodes sections have been compiled, the
92 * following members of struct xkb_keymap are finalized:
93 * xkb_keycode_t min_key_code;
94 * xkb_keycode_t max_key_code;
95 * darray(struct xkb_key_alias) key_aliases;
96 * char *keycodes_section_name;
97 * The 'name' field of indicators declared in xkb_keycodes:
98 * struct xkb_indicator_map indicators[XKB_NUM_INDICATORS];
99 * Further, the array of keys:
100 * darray(struct xkb_key) keys;
101 * had been resized to its final size (i.e. all of the xkb_key objects are
102 * referable by their keycode). However the objects themselves do not
103 * contain any useful information besides the key name at this point.
107 enum merge_mode merge;
115 unsigned int file_id;
120 enum merge_mode merge;
127 char *name; /* e.g. evdev+aliases(qwerty) */
130 enum merge_mode merge;
132 xkb_keycode_t min_key_code;
133 xkb_keycode_t max_key_code;
134 darray(KeyNameInfo) key_names;
135 IndicatorNameInfo indicator_names[XKB_NUM_INDICATORS];
136 darray(AliasInfo) aliases;
138 struct xkb_context *ctx;
142 InitAliasInfo(AliasInfo *info, enum merge_mode merge, unsigned file_id,
143 xkb_atom_t alias, xkb_atom_t real)
145 memset(info, 0, sizeof(*info));
147 info->file_id = file_id;
152 static IndicatorNameInfo *
153 FindIndicatorByName(KeyNamesInfo *info, xkb_atom_t name,
154 xkb_led_index_t *idx_out)
158 for (idx = 0; idx < XKB_NUM_INDICATORS; idx++) {
159 if (info->indicator_names[idx].name == name) {
161 return &info->indicator_names[idx];
169 AddIndicatorName(KeyNamesInfo *info, enum merge_mode merge,
170 IndicatorNameInfo *new, xkb_led_index_t new_idx)
172 xkb_led_index_t old_idx;
173 IndicatorNameInfo *old;
175 int verbosity = xkb_context_get_log_verbosity(info->ctx);
177 replace = (merge == MERGE_REPLACE || merge == MERGE_OVERRIDE);
179 /* Inidicator with the same name already exists. */
180 old = FindIndicatorByName(info, new->name, &old_idx);
182 bool report = ((old->file_id == new->file_id && verbosity > 0) ||
185 if (old_idx == new_idx) {
187 "Multiple indicators named \"%s\"; "
188 "Identical definitions ignored\n",
189 xkb_atom_text(info->ctx, new->name));
194 xkb_led_index_t use = (replace ? new_idx + 1 : old_idx + 1);
195 xkb_led_index_t ignore = (replace ? old_idx + 1 : new_idx + 1);
196 log_warn(info->ctx, "Multiple indicators named %s; "
197 "Using %d, ignoring %d\n",
198 xkb_atom_text(info->ctx, new->name), use, ignore);
207 /* Inidicator with the same index already exists. */
208 old = &info->indicator_names[new_idx];
209 if (old->name != XKB_ATOM_NONE) {
210 bool report = ((old->file_id == new->file_id && verbosity > 0) ||
213 /* Same name case already handled above. */
216 xkb_atom_t use = (replace ? new->name : old->name);
217 xkb_atom_t ignore = (replace ? old->name : new->name);
218 log_warn(info->ctx, "Multiple names for indicator %d; "
219 "Using %s, ignoring %s\n", new_idx + 1,
220 xkb_atom_text(info->ctx, use),
221 xkb_atom_text(info->ctx, ignore));
230 info->indicator_names[new_idx] = *new;
235 ClearKeyNamesInfo(KeyNamesInfo *info)
238 darray_free(info->key_names);
239 darray_free(info->aliases);
243 InitKeyNamesInfo(KeyNamesInfo *info, struct xkb_context *ctx,
246 memset(info, 0, sizeof(*info));
248 info->merge = MERGE_DEFAULT;
249 info->file_id = file_id;
250 info->min_key_code = XKB_KEYCODE_MAX;
254 FindKeyByName(KeyNamesInfo * info, xkb_atom_t name)
258 for (i = info->min_key_code; i <= info->max_key_code; i++)
259 if (darray_item(info->key_names, i).name == name)
262 return XKB_KEYCODE_INVALID;
266 AddKeyName(KeyNamesInfo *info, xkb_keycode_t kc, xkb_atom_t name,
267 enum merge_mode merge, unsigned file_id, bool report)
271 int verbosity = xkb_context_get_log_verbosity(info->ctx);
273 if (kc >= darray_size(info->key_names))
274 darray_resize0(info->key_names, kc + 1);
276 info->min_key_code = MIN(info->min_key_code, kc);
277 info->max_key_code = MAX(info->max_key_code, kc);
279 namei = &darray_item(info->key_names, kc);
281 report = report && ((verbosity > 0 && file_id == namei->file_id) ||
284 if (namei->name != 0) {
285 const char *lname = KeyNameText(info->ctx, namei->name);
286 const char *kname = KeyNameText(info->ctx, name);
288 if (namei->name == name) {
291 "Multiple identical key name definitions; "
292 "Later occurences of \"%s = %d\" ignored\n",
296 else if (merge == MERGE_AUGMENT) {
299 "Multiple names for keycode %d; "
300 "Using %s, ignoring %s\n", kc, lname, kname);
306 "Multiple names for keycode %d; "
307 "Using %s, ignoring %s\n", kc, kname, lname);
313 old = FindKeyByName(info, name);
314 if (old != XKB_KEYCODE_INVALID && old != kc) {
315 const char *kname = KeyNameText(info->ctx, name);
317 if (merge == MERGE_OVERRIDE) {
318 darray_item(info->key_names, old).name = 0;
319 darray_item(info->key_names, old).file_id = 0;
322 "Key name %s assigned to multiple keys; "
323 "Using %d, ignoring %d\n", kname, kc, old);
327 log_vrb(info->ctx, 3,
328 "Key name %s assigned to multiple keys; "
329 "Using %d, ignoring %d\n", kname, old, kc);
335 namei->file_id = file_id;
339 /***====================================================================***/
342 HandleAliasDef(KeyNamesInfo *info, KeyAliasDef *def, enum merge_mode merge,
346 MergeAliases(KeyNamesInfo *into, KeyNamesInfo *from, enum merge_mode merge)
351 if (darray_empty(from->aliases))
354 if (darray_empty(into->aliases)) {
355 into->aliases = from->aliases;
356 darray_init(from->aliases);
360 memset(&def, 0, sizeof(def));
362 darray_foreach(alias, from->aliases) {
363 def.merge = (merge == MERGE_DEFAULT) ? alias->merge : merge;
364 def.alias = alias->alias;
365 def.real = alias->real;
367 if (!HandleAliasDef(into, &def, def.merge, alias->file_id))
375 MergeIncludedKeycodes(KeyNamesInfo *into, KeyNamesInfo *from,
376 enum merge_mode merge)
381 if (from->errorCount > 0) {
382 into->errorCount += from->errorCount;
386 if (into->name == NULL) {
387 into->name = from->name;
391 if (darray_size(into->key_names) < darray_size(from->key_names))
392 darray_resize0(into->key_names, darray_size(from->key_names));
394 for (i = from->min_key_code; i <= from->max_key_code; i++) {
395 xkb_atom_t name = darray_item(from->key_names, i).name;
396 if (name == XKB_ATOM_NONE)
399 if (!AddKeyName(into, i, name, merge, from->file_id, false))
403 for (idx = 0; idx < XKB_NUM_INDICATORS; idx++) {
404 IndicatorNameInfo *led = &from->indicator_names[idx];
405 if (led->name == XKB_ATOM_NONE)
408 led->merge = (merge == MERGE_DEFAULT ? led->merge : merge);
409 if (!AddIndicatorName(into, led->merge, led, idx))
413 if (!MergeAliases(into, from, merge))
418 HandleKeycodesFile(KeyNamesInfo *info, XkbFile *file, enum merge_mode merge);
421 HandleIncludeKeycodes(KeyNamesInfo *info, IncludeStmt *stmt)
423 enum merge_mode merge = MERGE_DEFAULT;
425 KeyNamesInfo included, next_incl;
427 InitKeyNamesInfo(&included, info->ctx, info->file_id);
430 included.name = stmt->stmt;
434 for (; stmt; stmt = stmt->next_incl) {
435 if (!ProcessIncludeFile(info->ctx, stmt, FILE_TYPE_KEYCODES,
437 info->errorCount += 10;
438 ClearKeyNamesInfo(&included);
442 InitKeyNamesInfo(&next_incl, info->ctx, rtrn->id);
444 HandleKeycodesFile(&next_incl, rtrn, MERGE_OVERRIDE);
446 MergeIncludedKeycodes(&included, &next_incl, merge);
448 ClearKeyNamesInfo(&next_incl);
452 MergeIncludedKeycodes(info, &included, merge);
453 ClearKeyNamesInfo(&included);
455 return (info->errorCount == 0);
459 HandleKeycodeDef(KeyNamesInfo *info, KeycodeDef *stmt, enum merge_mode merge)
461 if (stmt->merge != MERGE_DEFAULT) {
462 if (stmt->merge == MERGE_REPLACE)
463 merge = MERGE_OVERRIDE;
468 if (stmt->value < 0 || stmt->value > XKB_KEYCODE_MAX) {
470 "Illegal keycode %lld: must be between 0..%u; "
471 "Key ignored\n", stmt->value, XKB_KEYCODE_MAX);
475 return AddKeyName(info, stmt->value, stmt->name, merge,
476 info->file_id, true);
480 HandleAliasCollision(KeyNamesInfo *info, AliasInfo *old, AliasInfo *new)
482 int verbosity = xkb_context_get_log_verbosity(info->ctx);
483 bool report = ((new->file_id == old->file_id && verbosity > 0) ||
486 if (new->real == old->real) {
488 log_warn(info->ctx, "Alias of %s for %s declared more than once; "
489 "First definition ignored\n",
490 KeyNameText(info->ctx, new->alias),
491 KeyNameText(info->ctx, new->real));
494 xkb_atom_t use, ignore;
496 use = (new->merge == MERGE_AUGMENT ? old->real : new->real);
497 ignore = (new->merge == MERGE_AUGMENT ? new->real : old->real);
500 log_warn(info->ctx, "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));
509 old->file_id = new->file_id;
510 old->merge = new->merge;
514 HandleAliasDef(KeyNamesInfo *info, KeyAliasDef *def, enum merge_mode merge,
517 AliasInfo *alias, new;
519 darray_foreach(alias, info->aliases) {
520 if (alias->alias == def->alias) {
521 InitAliasInfo(&new, merge, file_id, def->alias, def->real);
522 HandleAliasCollision(info, alias, &new);
527 InitAliasInfo(&new, merge, file_id, def->alias, def->real);
528 darray_append(info->aliases, new);
533 HandleKeyNameVar(KeyNamesInfo *info, VarDef *stmt)
535 const char *elem, *field;
538 if (!ExprResolveLhs(info->ctx, stmt->name, &elem, &field, &arrayNdx))
542 log_err(info->ctx, "Unknown element %s encountered; "
543 "Default for field %s ignored\n", elem, field);
547 if (!istreq(field, "minimum") && !istreq(field, "maximum")) {
548 log_err(info->ctx, "Unknown field encountered; "
549 "Assigment to field %s ignored\n", field);
553 /* We ignore explicit min/max statements, we always use computed. */
558 HandleIndicatorNameDef(KeyNamesInfo *info, IndicatorNameDef *def,
559 enum merge_mode merge)
561 IndicatorNameInfo ii;
564 if (def->ndx < 1 || def->ndx > XKB_NUM_INDICATORS) {
567 "Name specified for illegal indicator index %d\n; Ignored\n",
572 if (!ExprResolveString(info->ctx, def->name, &name)) {
574 snprintf(buf, sizeof(buf), "%d", def->ndx);
576 return ReportBadType(info->ctx, "indicator", "name", buf,
580 ii.merge = info->merge;
581 ii.file_id = info->file_id;
583 return AddIndicatorName(info, merge, &ii, def->ndx - 1);
587 HandleKeycodesFile(KeyNamesInfo *info, XkbFile *file, enum merge_mode merge)
593 info->name = strdup_safe(file->name);
595 for (stmt = file->defs; stmt; stmt = stmt->next) {
596 switch (stmt->type) {
598 ok = HandleIncludeKeycodes(info, (IncludeStmt *) stmt);
601 ok = HandleKeycodeDef(info, (KeycodeDef *) stmt, merge);
604 ok = HandleAliasDef(info, (KeyAliasDef *) stmt, merge,
608 ok = HandleKeyNameVar(info, (VarDef *) stmt);
610 case STMT_INDICATOR_NAME:
611 ok = HandleIndicatorNameDef(info, (IndicatorNameDef *) stmt,
616 "Keycode files may define key and indicator names only; "
617 "Ignoring %s\n", stmt_type_to_string(stmt->type));
625 if (info->errorCount > 10) {
626 log_err(info->ctx, "Abandoning keycodes file \"%s\"\n",
634 ApplyAliases(KeyNamesInfo *info, struct xkb_keymap *keymap)
637 struct xkb_key_alias *a, new;
640 darray_foreach(alias, info->aliases) {
641 /* Check that ->real is a key. */
642 key = FindNamedKey(keymap, alias->real, false);
644 log_vrb(info->ctx, 5,
645 "Attempt to alias %s to non-existent key %s; Ignored\n",
646 KeyNameText(info->ctx, alias->alias),
647 KeyNameText(info->ctx, alias->real));
651 /* Check that ->alias is not a key. */
652 key = FindNamedKey(keymap, alias->alias, false);
654 log_vrb(info->ctx, 5,
655 "Attempt to create alias with the name of a real key; "
656 "Alias \"%s = %s\" ignored\n",
657 KeyNameText(info->ctx, alias->alias),
658 KeyNameText(info->ctx, alias->real));
662 /* Check that ->alias in not already an alias, and if so handle it. */
663 darray_foreach(a, keymap->key_aliases) {
666 if (a->alias != alias->alias)
669 InitAliasInfo(&old_alias, MERGE_AUGMENT, 0, a->alias, a->real);
670 HandleAliasCollision(info, &old_alias, alias);
671 a->alias = old_alias.alias;
672 a->real = old_alias.real;
675 if (alias->alias == 0)
679 new.alias = alias->alias;
680 new.real = alias->real;
681 darray_append(keymap->key_aliases, new);
684 darray_free(info->aliases);
688 CopyKeyNamesToKeymap(struct xkb_keymap *keymap, KeyNamesInfo *info)
693 keymap->min_key_code = info->min_key_code;
694 keymap->max_key_code = info->max_key_code;
696 darray_resize0(keymap->keys, keymap->max_key_code + 1);
697 for (kc = info->min_key_code; kc <= info->max_key_code; kc++) {
698 struct xkb_key *key = &darray_item(keymap->keys, kc);
700 key->name = darray_item(info->key_names, kc).name;
703 keymap->keycodes_section_name = strdup_safe(info->name);
705 for (idx = 0; idx < XKB_NUM_INDICATORS; idx++) {
706 IndicatorNameInfo *led = &info->indicator_names[idx];
707 if (led->name == XKB_ATOM_NONE)
710 keymap->indicators[idx].name = led->name;
713 ApplyAliases(info, keymap);
719 CompileKeycodes(XkbFile *file, struct xkb_keymap *keymap,
720 enum merge_mode merge)
724 InitKeyNamesInfo(&info, keymap->ctx, file->id);
726 HandleKeycodesFile(&info, file, merge);
727 if (info.errorCount != 0)
730 if (!CopyKeyNamesToKeymap(keymap, &info))
733 ClearKeyNamesInfo(&info);
737 ClearKeyNamesInfo(&info);
742 FindNamedKey(struct xkb_keymap *keymap, xkb_atom_t name, bool use_aliases)
746 xkb_foreach_key(key, keymap)
747 if (key->name == name)
752 if (FindKeyNameForAlias(keymap, name, &new_name))
753 return FindNamedKey(keymap, new_name, false);
760 FindKeyNameForAlias(struct xkb_keymap *keymap, xkb_atom_t name,
761 xkb_atom_t *real_name)
763 struct xkb_key_alias *a;
765 darray_foreach(a, keymap->key_aliases) {
766 if (name == a->alias) {
767 *real_name = a->real;