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 enum merge_mode merge;
40 enum merge_mode merge;
49 xkb_keycode_t min_key_code;
50 xkb_keycode_t max_key_code;
51 darray(xkb_atom_t) key_names;
52 LedNameInfo led_names[XKB_MAX_LEDS];
53 unsigned int num_led_names;
54 darray(AliasInfo) aliases;
56 struct xkb_context *ctx;
59 /***====================================================================***/
62 InitAliasInfo(AliasInfo *info, enum merge_mode merge,
63 xkb_atom_t alias, xkb_atom_t real)
65 memset(info, 0, sizeof(*info));
72 FindLedByName(KeyNamesInfo *info, xkb_atom_t name,
73 xkb_led_index_t *idx_out)
75 for (xkb_led_index_t idx = 0; idx < info->num_led_names; idx++) {
76 LedNameInfo *ledi = &info->led_names[idx];
77 if (ledi->name == name) {
87 AddLedName(KeyNamesInfo *info, enum merge_mode merge, bool same_file,
88 LedNameInfo *new, xkb_led_index_t new_idx)
90 xkb_led_index_t old_idx;
92 const int verbosity = xkb_context_get_log_verbosity(info->ctx);
93 const bool report = (same_file && verbosity > 0) || verbosity > 9;
94 const bool replace = (merge == MERGE_REPLACE || merge == MERGE_OVERRIDE);
96 /* LED with the same name already exists. */
97 old = FindLedByName(info, new->name, &old_idx);
99 if (old_idx == new_idx) {
101 "Multiple indicators named \"%s\"; "
102 "Identical definitions ignored\n",
103 xkb_atom_text(info->ctx, new->name));
108 xkb_led_index_t use = (replace ? new_idx + 1 : old_idx + 1);
109 xkb_led_index_t ignore = (replace ? old_idx + 1 : new_idx + 1);
111 "Multiple indicators named %s; Using %d, ignoring %d\n",
112 xkb_atom_text(info->ctx, new->name), use, ignore);
121 if (new_idx >= info->num_led_names)
122 info->num_led_names = new_idx + 1;
124 /* LED with the same index already exists. */
125 old = &info->led_names[new_idx];
126 if (old->name != XKB_ATOM_NONE) {
128 const xkb_atom_t use = (replace ? new->name : old->name);
129 const xkb_atom_t ignore = (replace ? old->name : new->name);
130 log_warn(info->ctx, "Multiple names for indicator %d; "
131 "Using %s, ignoring %s\n", new_idx + 1,
132 xkb_atom_text(info->ctx, use),
133 xkb_atom_text(info->ctx, ignore));
147 ClearKeyNamesInfo(KeyNamesInfo *info)
150 darray_free(info->key_names);
151 darray_free(info->aliases);
155 InitKeyNamesInfo(KeyNamesInfo *info, struct xkb_context *ctx)
157 memset(info, 0, sizeof(*info));
159 info->min_key_code = XKB_KEYCODE_INVALID;
160 #if XKB_KEYCODE_INVALID < XKB_KEYCODE_MAX
161 #error "Hey, you can't be changing stuff like that."
166 FindKeyByName(KeyNamesInfo *info, xkb_atom_t name)
170 for (i = info->min_key_code; i <= info->max_key_code; i++)
171 if (darray_item(info->key_names, i) == name)
174 return XKB_KEYCODE_INVALID;
178 AddKeyName(KeyNamesInfo *info, xkb_keycode_t kc, xkb_atom_t name,
179 enum merge_mode merge, bool same_file, bool report)
182 xkb_keycode_t old_kc;
183 const int verbosity = xkb_context_get_log_verbosity(info->ctx);
185 report = report && ((same_file && verbosity > 0) || verbosity > 7);
187 if (kc >= darray_size(info->key_names))
188 darray_resize0(info->key_names, kc + 1);
190 info->min_key_code = MIN(info->min_key_code, kc);
191 info->max_key_code = MAX(info->max_key_code, kc);
193 /* There's already a key with this keycode. */
194 old_name = darray_item(info->key_names, kc);
195 if (old_name != XKB_ATOM_NONE) {
196 const char *lname = KeyNameText(info->ctx, old_name);
197 const char *kname = KeyNameText(info->ctx, name);
199 if (old_name == name) {
202 "Multiple identical key name definitions; "
203 "Later occurrences of \"%s = %d\" ignored\n",
207 else if (merge == MERGE_AUGMENT) {
210 "Multiple names for keycode %d; "
211 "Using %s, ignoring %s\n", kc, lname, kname);
217 "Multiple names for keycode %d; "
218 "Using %s, ignoring %s\n", kc, kname, lname);
219 darray_item(info->key_names, kc) = XKB_ATOM_NONE;
223 /* There's already a key with this name. */
224 old_kc = FindKeyByName(info, name);
225 if (old_kc != XKB_KEYCODE_INVALID && old_kc != kc) {
226 const char *kname = KeyNameText(info->ctx, name);
228 if (merge == MERGE_OVERRIDE) {
229 darray_item(info->key_names, old_kc) = XKB_ATOM_NONE;
232 "Key name %s assigned to multiple keys; "
233 "Using %d, ignoring %d\n", kname, kc, old_kc);
237 log_vrb(info->ctx, 3,
238 "Key name %s assigned to multiple keys; "
239 "Using %d, ignoring %d\n", kname, old_kc, kc);
244 darray_item(info->key_names, kc) = name;
248 /***====================================================================***/
251 HandleAliasDef(KeyNamesInfo *info, KeyAliasDef *def, enum merge_mode merge);
254 MergeIncludedKeycodes(KeyNamesInfo *into, KeyNamesInfo *from,
255 enum merge_mode merge)
257 if (from->errorCount > 0) {
258 into->errorCount += from->errorCount;
262 if (into->name == NULL) {
263 into->name = from->name;
267 /* Merge key names. */
268 if (darray_empty(into->key_names)) {
269 into->key_names = from->key_names;
270 darray_init(from->key_names);
271 into->min_key_code = from->min_key_code;
272 into->max_key_code = from->max_key_code;
275 if (darray_size(into->key_names) < darray_size(from->key_names))
276 darray_resize0(into->key_names, darray_size(from->key_names));
278 for (unsigned i = from->min_key_code; i <= from->max_key_code; i++) {
279 xkb_atom_t name = darray_item(from->key_names, i);
280 if (name == XKB_ATOM_NONE)
283 if (!AddKeyName(into, i, name, merge, true, false))
288 /* Merge key aliases. */
289 if (darray_empty(into->aliases)) {
290 into->aliases = from->aliases;
291 darray_init(from->aliases);
296 darray_foreach(alias, from->aliases) {
299 def.merge = (merge == MERGE_DEFAULT ? alias->merge : merge);
300 def.alias = alias->alias;
301 def.real = alias->real;
303 if (!HandleAliasDef(into, &def, def.merge))
308 /* Merge LED names. */
309 if (into->num_led_names == 0) {
310 memcpy(into->led_names, from->led_names,
311 sizeof(*from->led_names) * from->num_led_names);
312 into->num_led_names = from->num_led_names;
313 from->num_led_names = 0;
316 for (xkb_led_index_t idx = 0; idx < from->num_led_names; idx++) {
317 LedNameInfo *ledi = &from->led_names[idx];
319 if (ledi->name == XKB_ATOM_NONE)
322 ledi->merge = (merge == MERGE_DEFAULT ? ledi->merge : merge);
323 if (!AddLedName(into, ledi->merge, false, ledi, idx))
330 HandleKeycodesFile(KeyNamesInfo *info, XkbFile *file, enum merge_mode merge);
333 HandleIncludeKeycodes(KeyNamesInfo *info, IncludeStmt *include)
335 KeyNamesInfo included;
337 InitKeyNamesInfo(&included, info->ctx);
338 included.name = include->stmt;
339 include->stmt = NULL;
341 for (IncludeStmt *stmt = include; stmt; stmt = stmt->next_incl) {
342 KeyNamesInfo next_incl;
345 file = ProcessIncludeFile(info->ctx, stmt, FILE_TYPE_KEYCODES);
347 info->errorCount += 10;
348 ClearKeyNamesInfo(&included);
352 InitKeyNamesInfo(&next_incl, info->ctx);
354 HandleKeycodesFile(&next_incl, file, MERGE_OVERRIDE);
356 MergeIncludedKeycodes(&included, &next_incl, stmt->merge);
358 ClearKeyNamesInfo(&next_incl);
362 MergeIncludedKeycodes(info, &included, include->merge);
363 ClearKeyNamesInfo(&included);
365 return (info->errorCount == 0);
369 HandleKeycodeDef(KeyNamesInfo *info, KeycodeDef *stmt, enum merge_mode merge)
371 if (stmt->merge != MERGE_DEFAULT) {
372 if (stmt->merge == MERGE_REPLACE)
373 merge = MERGE_OVERRIDE;
378 if (stmt->value < 0 || stmt->value > XKB_KEYCODE_MAX) {
380 "Illegal keycode %lld: must be between 0..%u; "
381 "Key ignored\n", (long long) stmt->value, XKB_KEYCODE_MAX);
385 return AddKeyName(info, stmt->value, stmt->name, merge, false, true);
389 HandleAliasDef(KeyNamesInfo *info, KeyAliasDef *def, enum merge_mode merge)
393 darray_foreach(old, info->aliases) {
394 if (old->alias == def->alias) {
395 if (def->real == old->real) {
396 log_vrb(info->ctx, 1,
397 "Alias of %s for %s declared more than once; "
398 "First definition ignored\n",
399 KeyNameText(info->ctx, def->alias),
400 KeyNameText(info->ctx, def->real));
403 xkb_atom_t use, ignore;
405 use = (merge == MERGE_AUGMENT ? old->real : def->real);
406 ignore = (merge == MERGE_AUGMENT ? def->real : old->real);
409 "Multiple definitions for alias %s; "
410 "Using %s, ignoring %s\n",
411 KeyNameText(info->ctx, old->alias),
412 KeyNameText(info->ctx, use),
413 KeyNameText(info->ctx, ignore));
423 InitAliasInfo(&new, merge, def->alias, def->real);
424 darray_append(info->aliases, new);
429 HandleKeyNameVar(KeyNamesInfo *info, VarDef *stmt)
431 const char *elem, *field;
434 if (!ExprResolveLhs(info->ctx, stmt->name, &elem, &field, &arrayNdx))
438 log_err(info->ctx, "Unknown element %s encountered; "
439 "Default for field %s ignored\n", elem, field);
443 if (!istreq(field, "minimum") && !istreq(field, "maximum")) {
444 log_err(info->ctx, "Unknown field encountered; "
445 "Assignment to field %s ignored\n", field);
449 /* We ignore explicit min/max statements, we always use computed. */
454 HandleLedNameDef(KeyNamesInfo *info, LedNameDef *def,
455 enum merge_mode merge)
460 if (def->ndx < 1 || def->ndx > XKB_MAX_LEDS) {
463 "Illegal indicator index (%d) specified; must be between 1 .. %d; "
464 "Ignored\n", def->ndx, XKB_MAX_LEDS);
468 if (!ExprResolveString(info->ctx, def->name, &name)) {
470 snprintf(buf, sizeof(buf), "%d", def->ndx);
472 return ReportBadType(info->ctx, "indicator", "name", buf, "string");
477 return AddLedName(info, merge, true, &ledi, def->ndx - 1);
481 HandleKeycodesFile(KeyNamesInfo *info, XkbFile *file, enum merge_mode merge)
486 info->name = strdup_safe(file->name);
488 for (ParseCommon *stmt = file->defs; stmt; stmt = stmt->next) {
489 switch (stmt->type) {
491 ok = HandleIncludeKeycodes(info, (IncludeStmt *) stmt);
494 ok = HandleKeycodeDef(info, (KeycodeDef *) stmt, merge);
497 ok = HandleAliasDef(info, (KeyAliasDef *) stmt, merge);
500 ok = HandleKeyNameVar(info, (VarDef *) stmt);
503 ok = HandleLedNameDef(info, (LedNameDef *) stmt, merge);
507 "Keycode files may define key and indicator names only; "
508 "Ignoring %s\n", stmt_type_to_string(stmt->type));
516 if (info->errorCount > 10) {
517 log_err(info->ctx, "Abandoning keycodes file \"%s\"\n",
524 /***====================================================================***/
527 CopyKeyNamesToKeymap(struct xkb_keymap *keymap, KeyNamesInfo *info)
533 keymap->keycodes_section_name = strdup_safe(info->name);
534 XkbEscapeMapName(keymap->keycodes_section_name);
536 if (info->min_key_code != XKB_KEYCODE_INVALID) {
537 keymap->min_key_code = info->min_key_code;
538 keymap->max_key_code = info->max_key_code;
542 * If the keymap has no keys, let's just use the safest pair
545 keymap->min_key_code = 8;
546 keymap->max_key_code = 255;
549 keymap->keys = calloc(keymap->max_key_code + 1, sizeof(*keymap->keys));
550 for (kc = keymap->min_key_code; kc <= keymap->max_key_code; kc++)
551 keymap->keys[kc].keycode = kc;
553 /* Copy key names. */
554 for (kc = info->min_key_code; kc <= info->max_key_code; kc++)
555 keymap->keys[kc].name = darray_item(info->key_names, kc);
558 * Do some sanity checking on the aliases. We can't do it before
559 * because keys and their aliases may be added out-of-order.
561 keymap->num_key_aliases = 0;
562 darray_foreach(alias, info->aliases) {
563 /* Check that ->real is a key. */
564 if (!XkbKeyByName(keymap, alias->real, false)) {
565 log_vrb(info->ctx, 5,
566 "Attempt to alias %s to non-existent key %s; Ignored\n",
567 KeyNameText(info->ctx, alias->alias),
568 KeyNameText(info->ctx, alias->real));
569 alias->real = XKB_ATOM_NONE;
573 /* Check that ->alias is not a key. */
574 if (XkbKeyByName(keymap, alias->alias, false)) {
575 log_vrb(info->ctx, 5,
576 "Attempt to create alias with the name of a real key; "
577 "Alias \"%s = %s\" ignored\n",
578 KeyNameText(info->ctx, alias->alias),
579 KeyNameText(info->ctx, alias->real));
580 alias->real = XKB_ATOM_NONE;
584 keymap->num_key_aliases++;
587 /* Copy key aliases. */
588 keymap->key_aliases = calloc(keymap->num_key_aliases,
589 sizeof(*keymap->key_aliases));
591 darray_foreach(alias, info->aliases) {
592 if (alias->real != XKB_ATOM_NONE) {
593 keymap->key_aliases[i].alias = alias->alias;
594 keymap->key_aliases[i].real = alias->real;
599 /* Copy LED names. */
600 keymap->num_leds = info->num_led_names;
601 for (xkb_led_index_t idx = 0; idx < info->num_led_names; idx++) {
602 LedNameInfo *ledi = &info->led_names[idx];
604 if (ledi->name == XKB_ATOM_NONE)
607 keymap->leds[idx].name = ledi->name;
613 /***====================================================================***/
616 CompileKeycodes(XkbFile *file, struct xkb_keymap *keymap,
617 enum merge_mode merge)
621 InitKeyNamesInfo(&info, keymap->ctx);
623 HandleKeycodesFile(&info, file, merge);
624 if (info.errorCount != 0)
627 if (!CopyKeyNamesToKeymap(keymap, &info))
630 ClearKeyNamesInfo(&info);
634 ClearKeyNamesInfo(&info);