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 * of up to 4 letters, by which it can be referred to later, e.g. in the
43 * Minimum/Maximum keycode
44 * -----------------------
45 * Statements of the form:
49 * The file may explicitly declare the minimum and/or maximum keycode
50 * contained therein (traditionally 8-255, inherited from old xfree86
51 * keycodes). If these are stated explicitly, they are enforced. If
52 * they are not stated, they are computed automatically.
56 * Statements of the form:
60 * The above would let 49 and 10 be valid keycodes in the keymap, and
61 * assign them the names TLDE and AE01 respectively. The format <WXYZ> is
62 * always used to refer to a key by name.
64 * [ The naming convention <AE01> just denoted the position of the key
65 * in the main alphanumric section of the keyboard, with the top left key
66 * (usually "~") acting as origin. <AE01> is the key in the first row
67 * second column (which is usually "1"). ]
69 * In the common case this just maps to the evdev scancodes from
70 * /usr/include/linux/input.h, e.g. the following definitions:
71 * #define KEY_GRAVE 41
73 * Similar definitions appear in the xf86-input-keyboard driver. Note
74 * that in all current keymaps there's a constant offset of 8 (for
75 * historical reasons).
77 * If there's a conflict, like the same name given to different keycodes,
78 * or same keycode given different names, it is resolved according to the
79 * merge mode which applies to the definitions.
81 * The reason for the 4 characters limit is that the name is sometimes
82 * converted to an unsigned long (in a direct mapping), instead of a char
83 * array (see KeyNameToLong, LongToKeyName).
87 * Statements of the form:
88 * alias <MENU> = <COMP>;
90 * Allows to refer to a previously defined key (here <COMP>) by another
91 * name (here <MENU>). Conflicts are handled similarly.
93 * Indicator name statements
94 * -------------------------
95 * Statements of the form:
96 * indicator 1 = "Caps Lock";
97 * indicator 2 = "Num Lock";
98 * indicator 3 = "Scroll Lock";
100 * Assigns a name the indicator (i.e. keyboard LED) with the given index.
101 * The amount of possible indicators is predetermined (XkbNumIndicators).
102 * The indicator may be referred by this name later in the compat section
105 * Effect on the keymap
106 * --------------------
107 * After all of the xkb_keycodes sections have been compiled, the
108 * following members of struct xkb_keymap are finalized:
109 * xkb_keycode_t min_key_code;
110 * xkb_keycode_t max_key_code;
111 * darray(struct xkb_key_alias) key_aliases;
112 * const char *indicator_names[XkbNumIndicators];
113 * char *keycodes_section_name;
114 * Further, the array of keys:
115 * darray(struct xkb_key) keys;
116 * had been resized to its final size (i.e. all of the xkb_key objects are
117 * referable by their keycode). However the objects themselves do not
118 * contain any useful information besides the key name at this point.
121 typedef struct _AliasInfo {
122 enum merge_mode merge;
129 typedef struct _IndicatorNameInfo {
130 enum merge_mode merge;
136 typedef struct _KeyNamesInfo {
137 char *name; /* e.g. evdev+aliases(qwerty) */
140 enum merge_mode merge;
142 xkb_keycode_t computedMin; /* lowest keycode stored */
143 xkb_keycode_t computedMax; /* highest keycode stored */
144 xkb_keycode_t explicitMin;
145 xkb_keycode_t explicitMax;
146 darray(unsigned long) names;
147 darray(unsigned int) files;
148 IndicatorNameInfo indicator_names[XkbNumIndicators];
149 darray(AliasInfo) aliases;
151 struct xkb_context *ctx;
155 ResizeKeyNameArrays(KeyNamesInfo *info, int newMax)
157 if (newMax < darray_size(info->names))
160 darray_resize0(info->names, newMax + 1);
161 darray_resize0(info->files, newMax + 1);
165 InitAliasInfo(AliasInfo *info, enum merge_mode merge, unsigned file_id,
166 char alias[XkbKeyNameLength], char real[XkbKeyNameLength])
168 memset(info, 0, sizeof(*info));
170 info->file_id = file_id;
171 info->alias = KeyNameToLong(alias);
172 info->real = KeyNameToLong(real);
175 static IndicatorNameInfo *
176 FindIndicatorByName(KeyNamesInfo *info, xkb_atom_t name,
177 xkb_led_index_t *idx_out)
181 for (idx = 0; idx < XkbNumIndicators; idx++) {
182 if (info->indicator_names[idx].name == name) {
184 return &info->indicator_names[idx];
192 AddIndicatorName(KeyNamesInfo *info, enum merge_mode merge,
193 IndicatorNameInfo *new, xkb_led_index_t new_idx)
195 xkb_led_index_t old_idx;
196 IndicatorNameInfo *old;
197 bool replace, report;
198 int verbosity = xkb_get_log_verbosity(info->ctx);
200 replace = (merge == MERGE_REPLACE) || (merge == MERGE_OVERRIDE);
202 old = FindIndicatorByName(info, new->name, &old_idx);
204 report = ((old->file_id == new->file_id && verbosity > 0) ||
207 if (old_idx == new_idx) {
209 log_warn(info->ctx, "Multiple indicators named %s; "
210 "Identical definitions ignored\n",
211 xkb_atom_text(info->ctx, new->name));
216 log_warn(info->ctx, "Multiple indicators named %s; "
217 "Using %d, ignoring %d\n",
218 xkb_atom_text(info->ctx, new->name),
219 (replace ? old_idx + 1 : new_idx + 1),
220 (replace ? new_idx + 1 : old_idx + 1));
223 * XXX: If in the next check we ignore new, than we will have
224 * deleted this old for nothing!
227 memset(old, 0, sizeof(*old));
230 old = &info->indicator_names[new_idx];
231 if (old->name != XKB_ATOM_NONE) {
232 report = ((old->file_id == new->file_id && verbosity > 0) ||
235 if (old->name == new->name) {
237 log_warn(info->ctx, "Multiple names for indicator %d; "
238 "Identical definitions ignored\n", new_idx + 1);
242 log_warn(info->ctx, "Multiple names for indicator %d; "
243 "Using %s, ignoring %s\n", new_idx + 1,
244 xkb_atom_text(info->ctx, new->name),
245 xkb_atom_text(info->ctx, old->name));
246 old->name = new->name;
250 log_warn(info->ctx, "Multiple names for indicator %d; "
251 "Using %s, ignoring %s\n", new_idx + 1,
252 xkb_atom_text(info->ctx, old->name),
253 xkb_atom_text(info->ctx, new->name));
259 info->indicator_names[new_idx] = *new;
264 ClearKeyNamesInfo(KeyNamesInfo * info)
268 info->merge = MERGE_DEFAULT;
269 info->computedMax = info->explicitMax = info->explicitMin = 0;
270 info->computedMin = XKB_KEYCODE_MAX;
271 darray_free(info->names);
272 darray_free(info->files);
273 memset(info->indicator_names, 0, sizeof(info->indicator_names));
274 darray_free(info->aliases);
278 InitKeyNamesInfo(KeyNamesInfo *info, struct xkb_context *ctx,
282 info->merge = MERGE_DEFAULT;
283 darray_init(info->aliases);
284 info->file_id = file_id;
285 darray_init(info->names);
286 darray_init(info->files);
287 ClearKeyNamesInfo(info);
288 info->errorCount = 0;
293 FindKeyByLong(KeyNamesInfo * info, unsigned long name)
297 for (i = info->computedMin; i <= info->computedMax; i++)
298 if (darray_item(info->names, i) == name)
305 * Store the name of the key as a long in the info struct under the given
306 * keycode. If the same keys is referred to twice, print a warning.
307 * Note that the key's name is stored as a long, the keycode is the index.
310 AddKeyName(KeyNamesInfo *info, xkb_keycode_t kc, unsigned long name,
311 enum merge_mode merge, unsigned file_id, bool reportCollisions)
314 int verbosity = xkb_get_log_verbosity(info->ctx);
316 ResizeKeyNameArrays(info, kc);
318 if (kc < info->computedMin)
319 info->computedMin = kc;
320 if (kc > info->computedMax)
321 info->computedMax = kc;
323 if (reportCollisions)
324 reportCollisions = (verbosity > 7 ||
326 file_id == darray_item(info->files, kc)));
328 if (darray_item(info->names, kc) != 0) {
329 const char *lname = LongKeyNameText(darray_item(info->names, kc));
330 const char *kname = LongKeyNameText(name);
332 if (darray_item(info->names, kc) == name && reportCollisions) {
333 log_warn(info->ctx, "Multiple identical key name definitions; "
334 "Later occurences of \"%s = %d\" ignored\n", lname, kc);
338 if (merge == MERGE_AUGMENT) {
339 if (reportCollisions)
340 log_warn(info->ctx, "Multiple names for keycode %d; "
341 "Using %s, ignoring %s\n", kc, lname, kname);
345 if (reportCollisions)
346 log_warn(info->ctx, "Multiple names for keycode %d; "
347 "Using %s, ignoring %s\n", kc, kname, lname);
348 darray_item(info->names, kc) = 0;
349 darray_item(info->files, kc) = 0;
353 old = FindKeyByLong(info, name);
354 if (old != 0 && old != kc) {
355 const char *kname = LongKeyNameText(name);
357 if (merge == MERGE_OVERRIDE) {
358 darray_item(info->names, old) = 0;
359 darray_item(info->files, old) = 0;
360 if (reportCollisions)
361 log_warn(info->ctx, "Key name %s assigned to multiple keys; "
362 "Using %d, ignoring %d\n", kname, kc, old);
365 if (reportCollisions && verbosity > 3)
366 log_warn(info->ctx, "Key name %s assigned to multiple keys; "
367 "Using %d, ignoring %d\n", kname, old, kc);
372 darray_item(info->names, kc) = name;
373 darray_item(info->files, kc) = file_id;
377 /***====================================================================***/
380 HandleAliasDef(KeyNamesInfo *info, KeyAliasDef *def, enum merge_mode merge,
384 MergeAliases(KeyNamesInfo *into, KeyNamesInfo *from, enum merge_mode merge)
389 if (darray_empty(from->aliases))
392 if (darray_empty(into->aliases)) {
393 into->aliases = from->aliases;
394 darray_init(from->aliases);
398 memset(&def, 0, sizeof(def));
400 darray_foreach(alias, from->aliases) {
401 def.merge = (merge == MERGE_DEFAULT) ? alias->merge : merge;
402 LongToKeyName(alias->alias, def.alias);
403 LongToKeyName(alias->real, def.real);
405 if (!HandleAliasDef(into, &def, def.merge, alias->file_id))
413 MergeIncludedKeycodes(KeyNamesInfo *into, KeyNamesInfo *from,
414 enum merge_mode merge)
419 if (from->errorCount > 0) {
420 into->errorCount += from->errorCount;
424 if (into->name == NULL) {
425 into->name = from->name;
429 ResizeKeyNameArrays(into, from->computedMax);
431 for (i = from->computedMin; i <= from->computedMax; i++) {
432 unsigned long name = darray_item(from->names, i);
436 if (!AddKeyName(into, i, name, merge, from->file_id, false))
440 for (idx = 0; idx < XkbNumIndicators; idx++) {
441 IndicatorNameInfo *led = &from->indicator_names[idx];
442 if (led->name == XKB_ATOM_NONE)
445 led->merge = (merge == MERGE_DEFAULT ? led->merge : merge);
446 if (!AddIndicatorName(into, led->merge, led, idx))
450 if (!MergeAliases(into, from, merge))
453 if (from->explicitMin != 0)
454 if (into->explicitMin == 0 || into->explicitMin > from->explicitMin)
455 into->explicitMin = from->explicitMin;
457 if (from->explicitMax > 0)
458 if (into->explicitMax == 0 || into->explicitMax < from->explicitMax)
459 into->explicitMax = from->explicitMax;
463 HandleKeycodesFile(KeyNamesInfo *info, XkbFile *file, enum merge_mode merge);
466 HandleIncludeKeycodes(KeyNamesInfo *info, IncludeStmt *stmt)
468 enum merge_mode merge = MERGE_DEFAULT;
470 KeyNamesInfo included, next_incl;
472 InitKeyNamesInfo(&included, info->ctx, info->file_id);
475 included.name = stmt->stmt;
479 for (; stmt; stmt = stmt->next_incl) {
480 if (!ProcessIncludeFile(info->ctx, stmt, FILE_TYPE_KEYCODES,
482 info->errorCount += 10;
483 ClearKeyNamesInfo(&included);
487 InitKeyNamesInfo(&next_incl, info->ctx, rtrn->id);
489 HandleKeycodesFile(&next_incl, rtrn, MERGE_OVERRIDE);
491 MergeIncludedKeycodes(&included, &next_incl, merge);
493 ClearKeyNamesInfo(&next_incl);
497 MergeIncludedKeycodes(info, &included, merge);
498 ClearKeyNamesInfo(&included);
500 return (info->errorCount == 0);
504 HandleKeycodeDef(KeyNamesInfo *info, KeycodeDef *stmt, enum merge_mode merge)
506 if ((info->explicitMin != 0 && stmt->value < info->explicitMin) ||
507 (info->explicitMax != 0 && stmt->value > info->explicitMax)) {
508 log_err(info->ctx, "Illegal keycode %lu for name %s; "
509 "Must be in the range %d-%d inclusive\n",
510 stmt->value, KeyNameText(stmt->name), info->explicitMin,
511 info->explicitMax ? info->explicitMax : XKB_KEYCODE_MAX);
515 if (stmt->merge != MERGE_DEFAULT) {
516 if (stmt->merge == MERGE_REPLACE)
517 merge = MERGE_OVERRIDE;
522 return AddKeyName(info, stmt->value, KeyNameToLong(stmt->name), merge,
523 info->file_id, true);
527 HandleAliasCollision(KeyNamesInfo *info, AliasInfo *old, AliasInfo *new)
529 int verbosity = xkb_get_log_verbosity(info->ctx);
530 bool report = ((new->file_id == old->file_id && verbosity > 0) ||
533 if (new->real == old->real) {
535 log_warn(info->ctx, "Alias of %s for %s declared more than once; "
536 "First definition ignored\n",
537 LongKeyNameText(new->alias), LongKeyNameText(new->real));
540 unsigned long use, ignore;
542 use = (new->merge == MERGE_AUGMENT ? old->real : new->real);
543 ignore = (new->merge == MERGE_AUGMENT ? new->real : old->real);
546 log_warn(info->ctx, "Multiple definitions for alias %s; "
547 "Using %s, ignoring %s\n",
548 LongKeyNameText(old->alias), LongKeyNameText(use),
549 LongKeyNameText(ignore));
554 old->file_id = new->file_id;
555 old->merge = new->merge;
559 HandleAliasDef(KeyNamesInfo *info, KeyAliasDef *def, enum merge_mode merge,
562 AliasInfo *alias, new;
564 darray_foreach(alias, info->aliases) {
565 if (alias->alias == KeyNameToLong(def->alias)) {
566 InitAliasInfo(&new, merge, file_id, def->alias, def->real);
567 HandleAliasCollision(info, alias, &new);
572 InitAliasInfo(&new, merge, file_id, def->alias, def->real);
573 darray_append(info->aliases, new);
577 #define MIN_KEYCODE_DEF 0
578 #define MAX_KEYCODE_DEF 1
581 HandleKeyNameVar(KeyNamesInfo *info, VarDef *stmt)
583 const char *elem, *field;
588 if (!ExprResolveLhs(info->ctx, stmt->name, &elem, &field, &arrayNdx))
592 log_err(info->ctx, "Unknown element %s encountered; "
593 "Default for field %s ignored\n", elem, field);
597 if (istreq(field, "minimum")) {
598 which = MIN_KEYCODE_DEF;
600 else if (istreq(field, "maximum")) {
601 which = MAX_KEYCODE_DEF;
604 log_err(info->ctx, "Unknown field encountered; "
605 "Assigment to field %s ignored\n", field);
609 if (arrayNdx != NULL) {
610 log_err(info->ctx, "The %s setting is not an array; "
611 "Illegal array reference ignored\n", field);
615 if (!ExprResolveKeyCode(info->ctx, stmt->value, &kc)) {
616 log_err(info->ctx, "Illegal keycode encountered; "
617 "Assignment to field %s ignored\n", field);
621 if (kc > XKB_KEYCODE_MAX) {
623 "Illegal keycode %d (must be in the range %d-%d inclusive); "
624 "Value of \"%s\" not changed\n",
625 kc, 0, XKB_KEYCODE_MAX, field);
629 if (which == MIN_KEYCODE_DEF) {
630 if (info->explicitMax > 0 && info->explicitMax < kc) {
632 "Minimum key code (%d) must be <= maximum key code (%d); "
633 "Minimum key code value not changed\n",
634 kc, info->explicitMax);
638 if (info->computedMax > 0 && info->computedMin < kc) {
640 "Minimum key code (%d) must be <= lowest defined key (%d); "
641 "Minimum key code value not changed\n",
642 kc, info->computedMin);
646 info->explicitMin = kc;
648 else if (which == MAX_KEYCODE_DEF) {
649 if (info->explicitMin > 0 && info->explicitMin > kc) {
651 "Maximum code (%d) must be >= minimum key code (%d); "
652 "Maximum code value not changed\n",
653 kc, info->explicitMin);
657 if (info->computedMax > 0 && info->computedMax > kc) {
659 "Maximum code (%d) must be >= highest defined key (%d); "
660 "Maximum code value not changed\n",
661 kc, info->computedMax);
665 info->explicitMax = kc;
672 HandleIndicatorNameDef(KeyNamesInfo *info, IndicatorNameDef *def,
673 enum merge_mode merge)
675 IndicatorNameInfo ii;
678 if (def->ndx < 1 || def->ndx > XkbNumIndicators) {
681 "Name specified for illegal indicator index %d\n; Ignored\n",
686 if (!ExprResolveString(info->ctx, def->name, &name)) {
688 snprintf(buf, sizeof(buf), "%d", def->ndx);
690 return ReportBadType(info->ctx, "indicator", "name", buf,
694 ii.merge = info->merge;
695 ii.file_id = info->file_id;
697 return AddIndicatorName(info, merge, &ii, def->ndx - 1);
701 HandleKeycodesFile(KeyNamesInfo *info, XkbFile *file, enum merge_mode merge)
707 info->name = strdup_safe(file->name);
709 for (stmt = file->defs; stmt; stmt = stmt->next) {
710 switch (stmt->type) {
712 ok = HandleIncludeKeycodes(info, (IncludeStmt *) stmt);
715 ok = HandleKeycodeDef(info, (KeycodeDef *) stmt, merge);
718 ok = HandleAliasDef(info, (KeyAliasDef *) stmt, merge,
722 ok = HandleKeyNameVar(info, (VarDef *) stmt);
724 case STMT_INDICATOR_NAME:
725 ok = HandleIndicatorNameDef(info, (IndicatorNameDef *) stmt,
730 "Keycode files may define key and indicator names only; "
731 "Ignoring %s\n", stmt_type_to_string(stmt->type));
739 if (info->errorCount > 10) {
740 log_err(info->ctx, "Abandoning keycodes file \"%s\"\n",
748 ApplyAliases(KeyNamesInfo *info, struct xkb_keymap *keymap)
751 struct xkb_key_alias *a, new;
754 darray_foreach(alias, info->aliases) {
755 /* Check that ->real is a key. */
756 key = FindNamedKey(keymap, alias->real, false, 0);
758 log_vrb(info->ctx, 5,
759 "Attempt to alias %s to non-existent key %s; Ignored\n",
760 LongKeyNameText(alias->alias),
761 LongKeyNameText(alias->real));
765 /* Check that ->alias is not a key. */
766 key = FindNamedKey(keymap, alias->alias, false, 0);
768 log_vrb(info->ctx, 5,
769 "Attempt to create alias with the name of a real key; "
770 "Alias \"%s = %s\" ignored\n",
771 LongKeyNameText(alias->alias),
772 LongKeyNameText(alias->real));
776 /* Check that ->alias in not already an alias, and if so handle it. */
777 darray_foreach(a, keymap->key_aliases) {
780 if (KeyNameToLong(a->alias) != alias->alias)
783 InitAliasInfo(&old_alias, MERGE_AUGMENT, 0, a->alias, a->real);
784 HandleAliasCollision(info, &old_alias, alias);
785 LongToKeyName(old_alias.alias, a->alias);
786 LongToKeyName(old_alias.real, a->real);
789 if (alias->alias == 0)
793 LongToKeyName(alias->alias, new.alias);
794 LongToKeyName(alias->real, new.real);
795 darray_append(keymap->key_aliases, new);
798 darray_free(info->aliases);
802 CopyKeyNamesToKeymap(struct xkb_keymap *keymap, KeyNamesInfo *info)
807 if (info->explicitMin > 0)
808 keymap->min_key_code = info->explicitMin;
810 keymap->min_key_code = info->computedMin;
812 if (info->explicitMax > 0)
813 keymap->max_key_code = info->explicitMax;
815 keymap->max_key_code = info->computedMax;
817 darray_resize0(keymap->keys, keymap->max_key_code + 1);
818 for (kc = info->computedMin; kc <= info->computedMax; kc++)
819 LongToKeyName(darray_item(info->names, kc),
820 XkbKey(keymap, kc)->name);
822 keymap->keycodes_section_name = strdup_safe(info->name);
824 for (idx = 0; idx < XkbNumIndicators; idx++) {
825 IndicatorNameInfo *led = &info->indicator_names[idx];
826 if (led->name == XKB_ATOM_NONE)
829 keymap->indicator_names[idx] =
830 xkb_atom_text(keymap->ctx, led->name);
833 ApplyAliases(info, keymap);
839 CompileKeycodes(XkbFile *file, struct xkb_keymap *keymap,
840 enum merge_mode merge)
844 InitKeyNamesInfo(&info, keymap->ctx, file->id);
846 HandleKeycodesFile(&info, file, merge);
847 if (info.errorCount != 0)
850 if (!CopyKeyNamesToKeymap(keymap, &info))
853 ClearKeyNamesInfo(&info);
857 ClearKeyNamesInfo(&info);
862 FindNamedKey(struct xkb_keymap *keymap, unsigned long name,
863 bool use_aliases, xkb_keycode_t start_from)
867 if (start_from < keymap->min_key_code)
868 start_from = keymap->min_key_code;
869 else if (start_from > keymap->max_key_code)
872 xkb_foreach_key_from(key, keymap, start_from)
873 if (KeyNameToLong(key->name) == name)
877 unsigned long new_name;
878 if (FindKeyNameForAlias(keymap, name, &new_name))
879 return FindNamedKey(keymap, new_name, false, 0);
886 FindKeyNameForAlias(struct xkb_keymap *keymap, unsigned long lname,
887 unsigned long *real_name)
889 char name[XkbKeyNameLength];
890 struct xkb_key_alias *a;
892 LongToKeyName(lname, name);
893 darray_foreach(a, keymap->key_aliases) {
894 if (strncmp(name, a->alias, XkbKeyNameLength) == 0) {
895 *real_name = KeyNameToLong(a->real);