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;
113 enum merge_mode merge;
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;
128 struct xkb_context *ctx;
131 /***====================================================================***/
134 InitAliasInfo(AliasInfo *info, enum merge_mode merge,
135 xkb_atom_t alias, xkb_atom_t real)
137 memset(info, 0, sizeof(*info));
144 FindLedByName(KeyNamesInfo *info, xkb_atom_t name,
145 xkb_led_index_t *idx_out)
150 darray_enumerate(idx, ledi, info->led_names) {
151 if (ledi->name == name) {
161 AddLedName(KeyNamesInfo *info, enum merge_mode merge, bool same_file,
162 LedNameInfo *new, xkb_led_index_t new_idx)
164 xkb_led_index_t old_idx;
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);
170 /* LED with the same name already exists. */
171 old = FindLedByName(info, new->name, &old_idx);
173 if (old_idx == new_idx) {
175 "Multiple indicators named \"%s\"; "
176 "Identical definitions ignored\n",
177 xkb_atom_text(info->ctx, new->name));
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);
185 "Multiple indicators named %s; Using %d, ignoring %d\n",
186 xkb_atom_text(info->ctx, new->name), use, ignore);
195 if (new_idx >= darray_size(info->led_names))
196 darray_resize0(info->led_names, new_idx + 1);
198 /* LED with the same index already exists. */
199 old = &darray_item(info->led_names, new_idx);
200 if (old->name != XKB_ATOM_NONE) {
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));
216 darray_item(info->led_names, new_idx) = *new;
221 ClearKeyNamesInfo(KeyNamesInfo *info)
224 darray_free(info->key_names);
225 darray_free(info->aliases);
226 darray_free(info->led_names);
230 InitKeyNamesInfo(KeyNamesInfo *info, struct xkb_context *ctx)
232 memset(info, 0, sizeof(*info));
234 info->min_key_code = XKB_KEYCODE_MAX;
238 FindKeyByName(KeyNamesInfo *info, xkb_atom_t name)
242 for (i = info->min_key_code; i <= info->max_key_code; i++)
243 if (darray_item(info->key_names, i) == name)
246 return XKB_KEYCODE_INVALID;
250 AddKeyName(KeyNamesInfo *info, xkb_keycode_t kc, xkb_atom_t name,
251 enum merge_mode merge, bool same_file, bool report)
254 xkb_keycode_t old_kc;
255 const int verbosity = xkb_context_get_log_verbosity(info->ctx);
257 report = report && ((same_file && verbosity > 0) || verbosity > 7);
259 if (kc >= darray_size(info->key_names))
260 darray_resize0(info->key_names, kc + 1);
262 info->min_key_code = MIN(info->min_key_code, kc);
263 info->max_key_code = MAX(info->max_key_code, kc);
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);
271 if (old_name == name) {
274 "Multiple identical key name definitions; "
275 "Later occurrences of \"%s = %d\" ignored\n",
279 else if (merge == MERGE_AUGMENT) {
282 "Multiple names for keycode %d; "
283 "Using %s, ignoring %s\n", kc, lname, kname);
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;
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);
300 if (merge == MERGE_OVERRIDE) {
301 darray_item(info->key_names, old_kc) = XKB_ATOM_NONE;
304 "Key name %s assigned to multiple keys; "
305 "Using %d, ignoring %d\n", kname, kc, old_kc);
309 log_vrb(info->ctx, 3,
310 "Key name %s assigned to multiple keys; "
311 "Using %d, ignoring %d\n", kname, old_kc, kc);
316 darray_item(info->key_names, kc) = name;
320 /***====================================================================***/
323 HandleAliasDef(KeyNamesInfo *info, KeyAliasDef *def, enum merge_mode merge);
326 MergeIncludedKeycodes(KeyNamesInfo *into, KeyNamesInfo *from,
327 enum merge_mode merge)
329 if (from->errorCount > 0) {
330 into->errorCount += from->errorCount;
334 if (into->name == NULL) {
335 into->name = from->name;
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;
347 if (darray_size(into->key_names) < darray_size(from->key_names))
348 darray_resize0(into->key_names, darray_size(from->key_names));
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)
355 if (!AddKeyName(into, i, name, merge, true, false))
360 /* Merge key aliases. */
361 if (darray_empty(into->aliases)) {
362 into->aliases = from->aliases;
363 darray_init(from->aliases);
368 darray_foreach(alias, from->aliases) {
371 def.merge = (merge == MERGE_DEFAULT ? alias->merge : merge);
372 def.alias = alias->alias;
373 def.real = alias->real;
375 if (!HandleAliasDef(into, &def, def.merge))
380 /* Merge LED names. */
381 if (darray_empty(into->led_names)) {
382 into->led_names = from->led_names;
383 darray_init(from->led_names);
389 darray_enumerate(idx, ledi, from->led_names) {
390 if (ledi->name == XKB_ATOM_NONE)
393 ledi->merge = (merge == MERGE_DEFAULT ? ledi->merge : merge);
394 if (!AddLedName(into, ledi->merge, false, ledi, idx))
401 HandleKeycodesFile(KeyNamesInfo *info, XkbFile *file, enum merge_mode merge);
404 HandleIncludeKeycodes(KeyNamesInfo *info, IncludeStmt *include)
406 KeyNamesInfo included;
408 InitKeyNamesInfo(&included, info->ctx);
409 included.name = include->stmt;
410 include->stmt = NULL;
412 for (IncludeStmt *stmt = include; stmt; stmt = stmt->next_incl) {
413 KeyNamesInfo next_incl;
416 file = ProcessIncludeFile(info->ctx, stmt, FILE_TYPE_KEYCODES);
418 info->errorCount += 10;
419 ClearKeyNamesInfo(&included);
423 InitKeyNamesInfo(&next_incl, info->ctx);
425 HandleKeycodesFile(&next_incl, file, MERGE_OVERRIDE);
427 MergeIncludedKeycodes(&included, &next_incl, stmt->merge);
429 ClearKeyNamesInfo(&next_incl);
433 MergeIncludedKeycodes(info, &included, include->merge);
434 ClearKeyNamesInfo(&included);
436 return (info->errorCount == 0);
440 HandleKeycodeDef(KeyNamesInfo *info, KeycodeDef *stmt, enum merge_mode merge)
442 if (stmt->merge != MERGE_DEFAULT) {
443 if (stmt->merge == MERGE_REPLACE)
444 merge = MERGE_OVERRIDE;
449 if (stmt->value < 0 || stmt->value > XKB_KEYCODE_MAX) {
451 "Illegal keycode %lld: must be between 0..%u; "
452 "Key ignored\n", (long long) stmt->value, XKB_KEYCODE_MAX);
456 return AddKeyName(info, stmt->value, stmt->name, merge, false, true);
460 HandleAliasDef(KeyNamesInfo *info, KeyAliasDef *def, enum merge_mode merge)
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));
474 xkb_atom_t use, ignore;
476 use = (merge == MERGE_AUGMENT ? old->real : def->real);
477 ignore = (merge == MERGE_AUGMENT ? def->real : old->real);
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));
494 InitAliasInfo(&new, merge, def->alias, def->real);
495 darray_append(info->aliases, new);
500 HandleKeyNameVar(KeyNamesInfo *info, VarDef *stmt)
502 const char *elem, *field;
505 if (!ExprResolveLhs(info->ctx, stmt->name, &elem, &field, &arrayNdx))
509 log_err(info->ctx, "Unknown element %s encountered; "
510 "Default for field %s ignored\n", elem, field);
514 if (!istreq(field, "minimum") && !istreq(field, "maximum")) {
515 log_err(info->ctx, "Unknown field encountered; "
516 "Assignment to field %s ignored\n", field);
520 /* We ignore explicit min/max statements, we always use computed. */
525 HandleLedNameDef(KeyNamesInfo *info, LedNameDef *def,
526 enum merge_mode merge)
531 if (def->ndx < 1 || def->ndx > XKB_MAX_LEDS) {
534 "Illegal indicator index (%d) specified; must be between 1 .. %d; "
535 "Ignored\n", def->ndx, XKB_MAX_LEDS);
539 if (!ExprResolveString(info->ctx, def->name, &name)) {
541 snprintf(buf, sizeof(buf), "%d", def->ndx);
543 return ReportBadType(info->ctx, "indicator", "name", buf, "string");
548 return AddLedName(info, merge, true, &ledi, def->ndx - 1);
552 HandleKeycodesFile(KeyNamesInfo *info, XkbFile *file, enum merge_mode merge)
557 info->name = strdup_safe(file->name);
559 for (ParseCommon *stmt = file->defs; stmt; stmt = stmt->next) {
560 switch (stmt->type) {
562 ok = HandleIncludeKeycodes(info, (IncludeStmt *) stmt);
565 ok = HandleKeycodeDef(info, (KeycodeDef *) stmt, merge);
568 ok = HandleAliasDef(info, (KeyAliasDef *) stmt, merge);
571 ok = HandleKeyNameVar(info, (VarDef *) stmt);
574 ok = HandleLedNameDef(info, (LedNameDef *) stmt, merge);
578 "Keycode files may define key and indicator names only; "
579 "Ignoring %s\n", stmt_type_to_string(stmt->type));
587 if (info->errorCount > 10) {
588 log_err(info->ctx, "Abandoning keycodes file \"%s\"\n",
595 /***====================================================================***/
598 CopyKeyNamesToKeymap(struct xkb_keymap *keymap, KeyNamesInfo *info)
606 keymap->keycodes_section_name = strdup_safe(info->name);
608 keymap->min_key_code = info->min_key_code;
609 keymap->max_key_code = info->max_key_code;
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);
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.
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;
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;
645 keymap->num_key_aliases++;
648 /* Copy key aliases. */
649 keymap->key_aliases = calloc(keymap->num_key_aliases,
650 sizeof(*keymap->key_aliases));
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;
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;
669 /***====================================================================***/
672 CompileKeycodes(XkbFile *file, struct xkb_keymap *keymap,
673 enum merge_mode merge)
677 InitKeyNamesInfo(&info, keymap->ctx);
679 HandleKeycodesFile(&info, file, merge);
680 if (info.errorCount != 0)
683 if (!CopyKeyNamesToKeymap(keymap, &info))
686 ClearKeyNamesInfo(&info);
690 ClearKeyNamesInfo(&info);