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 TYPE_FIELD_MASK = (1 << 0),
35 TYPE_FIELD_MAP = (1 << 1),
36 TYPE_FIELD_PRESERVE = (1 << 2),
37 TYPE_FIELD_LEVEL_NAME = (1 << 3),
41 enum type_field defined;
42 enum merge_mode merge;
46 xkb_level_index_t num_levels;
47 darray(struct xkb_key_type_entry) entries;
48 darray(xkb_atom_t) level_names;
55 darray(KeyTypeInfo) types;
56 struct xkb_context *ctx;
57 struct xkb_keymap *keymap;
60 /***====================================================================***/
62 static inline const char *
63 MapEntryTxt(KeyTypesInfo *info, struct xkb_key_type_entry *entry)
65 return ModMaskText(info->keymap, entry->mods.mods);
68 static inline const char *
69 TypeTxt(KeyTypesInfo *info, KeyTypeInfo *type)
71 return xkb_atom_text(info->ctx, type->name);
74 static inline const char *
75 TypeMaskTxt(KeyTypesInfo *info, KeyTypeInfo *type)
77 return ModMaskText(info->keymap, type->mods);
81 ReportTypeShouldBeArray(KeyTypesInfo *info, KeyTypeInfo *type,
84 return ReportShouldBeArray(info->ctx, "key type", field,
89 ReportTypeBadType(KeyTypesInfo *info, KeyTypeInfo *type,
90 const char *field, const char *wanted)
92 return ReportBadType(info->ctx, "key type", field,
93 TypeTxt(info, type), wanted);
96 /***====================================================================***/
99 InitKeyTypesInfo(KeyTypesInfo *info, struct xkb_keymap *keymap)
101 memset(info, 0, sizeof(*info));
102 info->keymap = keymap;
103 info->ctx = keymap->ctx;
107 ClearKeyTypeInfo(KeyTypeInfo *type)
109 darray_free(type->entries);
110 darray_free(type->level_names);
114 ClearKeyTypesInfo(KeyTypesInfo *info)
117 darray_free(info->types);
121 FindMatchingKeyType(KeyTypesInfo *info, xkb_atom_t name)
125 darray_foreach(old, info->types)
126 if (old->name == name)
133 AddKeyType(KeyTypesInfo *info, KeyTypeInfo *new, bool same_file)
136 const int verbosity = xkb_context_get_log_verbosity(info->ctx);
138 old = FindMatchingKeyType(info, new->name);
140 if (new->merge == MERGE_REPLACE || new->merge == MERGE_OVERRIDE) {
141 if ((same_file && verbosity > 0) || verbosity > 9) {
143 "Multiple definitions of the %s key type; "
144 "Earlier definition ignored\n",
145 xkb_atom_text(info->ctx, new->name));
148 ClearKeyTypeInfo(old);
150 darray_init(new->entries);
151 darray_init(new->level_names);
156 log_vrb(info->ctx, 4,
157 "Multiple definitions of the %s key type; "
158 "Later definition ignored\n",
159 xkb_atom_text(info->ctx, new->name));
161 ClearKeyTypeInfo(new);
165 darray_append(info->types, *new);
169 /***====================================================================***/
172 MergeIncludedKeyTypes(KeyTypesInfo *into, KeyTypesInfo *from,
173 enum merge_mode merge)
177 if (from->errorCount > 0) {
178 into->errorCount += from->errorCount;
182 if (into->name == NULL) {
183 into->name = from->name;
187 if (darray_empty(into->types)) {
188 into->types = from->types;
189 darray_init(from->types);
192 darray_foreach(type, from->types) {
193 type->merge = (merge == MERGE_DEFAULT ? type->merge : merge);
194 if (!AddKeyType(into, type, false))
201 HandleKeyTypesFile(KeyTypesInfo *info, XkbFile *file, enum merge_mode merge);
204 HandleIncludeKeyTypes(KeyTypesInfo *info, IncludeStmt *include)
206 KeyTypesInfo included;
208 InitKeyTypesInfo(&included, info->keymap);
209 included.name = include->stmt;
210 include->stmt = NULL;
212 for (IncludeStmt *stmt = include; stmt; stmt = stmt->next_incl) {
213 KeyTypesInfo next_incl;
216 file = ProcessIncludeFile(info->ctx, stmt, FILE_TYPE_TYPES);
218 info->errorCount += 10;
219 ClearKeyTypesInfo(&included);
223 InitKeyTypesInfo(&next_incl, info->keymap);
225 HandleKeyTypesFile(&next_incl, file, stmt->merge);
227 MergeIncludedKeyTypes(&included, &next_incl, stmt->merge);
229 ClearKeyTypesInfo(&next_incl);
233 MergeIncludedKeyTypes(info, &included, include->merge);
234 ClearKeyTypesInfo(&included);
236 return (info->errorCount == 0);
239 /***====================================================================***/
242 SetModifiers(KeyTypesInfo *info, KeyTypeInfo *type, ExprDef *arrayNdx,
249 "The modifiers field of a key type is not an array; "
250 "Illegal array subscript ignored\n");
252 if (!ExprResolveModMask(info->keymap, value, MOD_BOTH, &mods)) {
254 "Key type mask field must be a modifier mask; "
255 "Key type definition ignored\n");
259 if (type->defined & TYPE_FIELD_MASK) {
261 "Multiple modifier mask definitions for key type %s; "
262 "Using %s, ignoring %s\n",
263 xkb_atom_text(info->ctx, type->name),
264 TypeMaskTxt(info, type),
265 ModMaskText(info->keymap, mods));
273 /***====================================================================***/
275 static struct xkb_key_type_entry *
276 FindMatchingMapEntry(KeyTypeInfo *type, xkb_mod_mask_t mods)
278 struct xkb_key_type_entry *entry;
280 darray_foreach(entry, type->entries)
281 if (entry->mods.mods == mods)
288 AddMapEntry(KeyTypesInfo *info, KeyTypeInfo *type,
289 struct xkb_key_type_entry *new, bool clobber, bool report)
291 struct xkb_key_type_entry *old;
293 old = FindMatchingMapEntry(type, new->mods.mods);
295 if (report && old->level != new->level) {
297 "Multiple map entries for %s in %s; "
298 "Using %d, ignoring %d\n",
299 MapEntryTxt(info, new), TypeTxt(info, type),
300 (clobber ? new->level : old->level) + 1,
301 (clobber ? old->level : new->level) + 1);
304 log_vrb(info->ctx, 10,
305 "Multiple occurrences of map[%s]= %d in %s; Ignored\n",
306 MapEntryTxt(info, new), new->level + 1,
307 TypeTxt(info, type));
312 if (new->level >= type->num_levels)
313 type->num_levels = new->level + 1;
314 old->level = new->level;
320 if (new->level >= type->num_levels)
321 type->num_levels = new->level + 1;
323 darray_append(type->entries, *new);
328 SetMapEntry(KeyTypesInfo *info, KeyTypeInfo *type, ExprDef *arrayNdx,
331 struct xkb_key_type_entry entry;
333 if (arrayNdx == NULL)
334 return ReportTypeShouldBeArray(info, type, "map entry");
336 if (!ExprResolveModMask(info->keymap, arrayNdx, MOD_BOTH, &entry.mods.mods))
337 return ReportTypeBadType(info, type, "map entry", "modifier mask");
339 if (entry.mods.mods & (~type->mods)) {
340 log_vrb(info->ctx, 1,
341 "Map entry for unused modifiers in %s; "
342 "Using %s instead of %s\n",
344 ModMaskText(info->keymap, entry.mods.mods & type->mods),
345 MapEntryTxt(info, &entry));
346 entry.mods.mods &= type->mods;
349 if (!ExprResolveLevel(info->ctx, value, &entry.level)) {
351 "Level specifications in a key type must be integer; "
352 "Ignoring malformed level specification\n");
356 entry.preserve.mods = 0;
358 return AddMapEntry(info, type, &entry, true, true);
361 /***====================================================================***/
364 AddPreserve(KeyTypesInfo *info, KeyTypeInfo *type,
365 xkb_mod_mask_t mods, xkb_mod_mask_t preserve_mods)
367 struct xkb_key_type_entry *entry;
368 struct xkb_key_type_entry new;
370 darray_foreach(entry, type->entries) {
371 if (entry->mods.mods != mods)
374 /* Map exists without previous preserve (or "None"); override. */
375 if (entry->preserve.mods == 0) {
376 entry->preserve.mods = preserve_mods;
380 /* Map exists with same preserve; do nothing. */
381 if (entry->preserve.mods == preserve_mods) {
382 log_vrb(info->ctx, 10,
383 "Identical definitions for preserve[%s] in %s; "
385 ModMaskText(info->keymap, mods),
386 TypeTxt(info, type));
390 /* Map exists with different preserve; latter wins. */
391 log_vrb(info->ctx, 1,
392 "Multiple definitions for preserve[%s] in %s; "
393 "Using %s, ignoring %s\n",
394 ModMaskText(info->keymap, mods),
396 ModMaskText(info->keymap, preserve_mods),
397 ModMaskText(info->keymap, entry->preserve.mods));
399 entry->preserve.mods = preserve_mods;
404 * Map does not exist, i.e. preserve[] came before map[].
405 * Create a map with the specified mask mapping to Level1. The level
406 * may be overridden later with an explicit map[] statement.
409 new.mods.mods = mods;
410 new.preserve.mods = preserve_mods;
411 darray_append(type->entries, new);
416 SetPreserve(KeyTypesInfo *info, KeyTypeInfo *type, ExprDef *arrayNdx,
419 xkb_mod_mask_t mods, preserve_mods;
421 if (arrayNdx == NULL)
422 return ReportTypeShouldBeArray(info, type, "preserve entry");
424 if (!ExprResolveModMask(info->keymap, arrayNdx, MOD_BOTH, &mods))
425 return ReportTypeBadType(info, type, "preserve entry",
428 if (mods & ~type->mods) {
429 const char *before, *after;
431 before = ModMaskText(info->keymap, mods);
433 after = ModMaskText(info->keymap, mods);
435 log_vrb(info->ctx, 1,
436 "Preserve for modifiers not used by the %s type; "
437 "Index %s converted to %s\n",
438 TypeTxt(info, type), before, after);
441 if (!ExprResolveModMask(info->keymap, value, MOD_BOTH, &preserve_mods)) {
443 "Preserve value in a key type is not a modifier mask; "
444 "Ignoring preserve[%s] in type %s\n",
445 ModMaskText(info->keymap, mods),
446 TypeTxt(info, type));
450 if (preserve_mods & ~mods) {
451 const char *before, *after;
453 before = ModMaskText(info->keymap, preserve_mods);
454 preserve_mods &= mods;
455 after = ModMaskText(info->keymap, preserve_mods);
457 log_vrb(info->ctx, 1,
458 "Illegal value for preserve[%s] in type %s; "
459 "Converted %s to %s\n",
460 ModMaskText(info->keymap, mods),
461 TypeTxt(info, type), before, after);
464 return AddPreserve(info, type, mods, preserve_mods);
467 /***====================================================================***/
470 AddLevelName(KeyTypesInfo *info, KeyTypeInfo *type,
471 xkb_level_index_t level, xkb_atom_t name, bool clobber)
474 if (level >= darray_size(type->level_names)) {
475 darray_resize0(type->level_names, level + 1);
479 /* Same level, same name. */
480 if (darray_item(type->level_names, level) == name) {
481 log_vrb(info->ctx, 10,
482 "Duplicate names for level %d of key type %s; Ignored\n",
483 level + 1, TypeTxt(info, type));
487 /* Same level, different name. */
488 if (darray_item(type->level_names, level) != XKB_ATOM_NONE) {
489 const char *old, *new;
490 old = xkb_atom_text(info->ctx,
491 darray_item(type->level_names, level));
492 new = xkb_atom_text(info->ctx, name);
493 log_vrb(info->ctx, 1,
494 "Multiple names for level %d of key type %s; "
495 "Using %s, ignoring %s\n",
496 level + 1, TypeTxt(info, type),
497 (clobber ? new : old), (clobber ? old : new));
503 /* XXX: What about different level, same name? */
506 darray_item(type->level_names, level) = name;
511 SetLevelName(KeyTypesInfo *info, KeyTypeInfo *type, ExprDef *arrayNdx,
514 xkb_level_index_t level;
515 xkb_atom_t level_name;
517 if (arrayNdx == NULL)
518 return ReportTypeShouldBeArray(info, type, "level name");
520 if (!ExprResolveLevel(info->ctx, arrayNdx, &level))
521 return ReportTypeBadType(info, type, "level name", "integer");
523 if (!ExprResolveString(info->ctx, value, &level_name)) {
525 "Non-string name for level %d in key type %s; "
526 "Ignoring illegal level name definition\n",
527 level + 1, xkb_atom_text(info->ctx, type->name));
531 return AddLevelName(info, type, level, level_name, true);
534 /***====================================================================***/
537 SetKeyTypeField(KeyTypesInfo *info, KeyTypeInfo *type,
538 const char *field, ExprDef *arrayNdx, ExprDef *value)
541 enum type_field type_field = 0;
543 if (istreq(field, "modifiers")) {
544 type_field = TYPE_FIELD_MASK;
545 ok = SetModifiers(info, type, arrayNdx, value);
547 else if (istreq(field, "map")) {
548 type_field = TYPE_FIELD_MAP;
549 ok = SetMapEntry(info, type, arrayNdx, value);
551 else if (istreq(field, "preserve")) {
552 type_field = TYPE_FIELD_PRESERVE;
553 ok = SetPreserve(info, type, arrayNdx, value);
555 else if (istreq(field, "levelname") || istreq(field, "level_name")) {
556 type_field = TYPE_FIELD_LEVEL_NAME;
557 ok = SetLevelName(info, type, arrayNdx, value);
560 "Unknown field %s in key type %s; Definition ignored\n",
561 field, TypeTxt(info, type));
564 type->defined |= type_field;
569 HandleKeyTypeBody(KeyTypesInfo *info, VarDef *def, KeyTypeInfo *type)
572 const char *elem, *field;
575 for (; def; def = (VarDef *) def->common.next) {
576 ok = ExprResolveLhs(info->ctx, def->name, &elem, &field,
581 if (elem && istreq(elem, "type")) {
583 "Support for changing the default type has been removed; "
584 "Statement ignored\n");
588 ok = SetKeyTypeField(info, type, field, arrayNdx, def->value);
595 HandleKeyTypeDef(KeyTypesInfo *info, KeyTypeDef *def, enum merge_mode merge)
599 .merge = (def->merge == MERGE_DEFAULT ? merge : def->merge),
603 .entries = darray_new(),
604 .level_names = darray_new(),
607 if (!HandleKeyTypeBody(info, def->body, &type)) {
612 if (!AddKeyType(info, &type, true)) {
621 HandleKeyTypesFile(KeyTypesInfo *info, XkbFile *file, enum merge_mode merge)
626 info->name = strdup_safe(file->name);
628 for (ParseCommon *stmt = file->defs; stmt; stmt = stmt->next) {
629 switch (stmt->type) {
631 ok = HandleIncludeKeyTypes(info, (IncludeStmt *) stmt);
634 ok = HandleKeyTypeDef(info, (KeyTypeDef *) stmt, merge);
638 "Support for changing the default type has been removed; "
639 "Statement ignored\n");
643 ok = HandleVModDef(info->keymap, (VModDef *) stmt, merge);
647 "Key type files may not include other declarations; "
648 "Ignoring %s\n", stmt_type_to_string(stmt->type));
656 if (info->errorCount > 10) {
658 "Abandoning keytypes file \"%s\"\n", file->topName);
664 /***====================================================================***/
667 CopyKeyTypesToKeymap(struct xkb_keymap *keymap, KeyTypesInfo *info)
669 keymap->types_section_name = strdup_safe(info->name);
670 XkbEscapeMapName(keymap->types_section_name);
672 keymap->num_types = darray_size(info->types);
673 if (keymap->num_types == 0)
674 keymap->num_types = 1;
676 keymap->types = calloc(keymap->num_types, sizeof(*keymap->types));
679 * If no types were specified, a default unnamed one-level type is
682 if (darray_empty(info->types)) {
683 struct xkb_key_type *type = &keymap->types[0];
686 type->num_levels = 1;
687 type->entries = NULL;
688 type->num_entries = 0;
689 type->name = xkb_atom_intern_literal(keymap->ctx, "default");
690 type->level_names = NULL;
695 for (unsigned i = 0; i < keymap->num_types; i++) {
696 KeyTypeInfo *def = &darray_item(info->types, i);
697 struct xkb_key_type *type = &keymap->types[i];
699 type->mods.mods = def->mods;
700 type->num_levels = def->num_levels;
701 type->entries = darray_mem(def->entries, 0);
702 type->num_entries = darray_size(def->entries);
703 darray_init(def->entries);
704 type->name = def->name;
705 type->level_names = darray_mem(def->level_names, 0);
706 darray_init(def->level_names);
712 /***====================================================================***/
715 CompileKeyTypes(XkbFile *file, struct xkb_keymap *keymap,
716 enum merge_mode merge)
720 InitKeyTypesInfo(&info, keymap);
722 HandleKeyTypesFile(&info, file, merge);
723 if (info.errorCount != 0)
726 if (!CopyKeyTypesToKeymap(keymap, &info))
729 ClearKeyTypesInfo(&info);
733 ClearKeyTypesInfo(&info);