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"
28 #include "parseutils.h"
32 /***====================================================================***/
34 /* Needed to work with the typechecker. */
35 typedef darray(xkb_keysym_t) darray_xkb_keysym_t;
36 typedef darray(union xkb_action) darray_xkb_action;
41 KEY_REPEAT_UNDEFINED = -1
45 KEY_FIELD_SYMS = (1 << 0),
46 KEY_FIELD_ACTS = (1 << 1),
47 KEY_FIELD_REPEAT = (1 << 2),
48 KEY_FIELD_BEHAVIOR = (1 << 3),
49 KEY_FIELD_TYPE_DFLT = (1 << 4),
50 KEY_FIELD_TYPES = (1 << 5),
51 KEY_FIELD_GROUPINFO = (1 << 6),
52 KEY_FIELD_VMODMAP = (1 << 7),
55 typedef struct _KeyInfo {
56 enum key_field defined;
58 enum merge_mode merge;
60 unsigned long name; /* the 4 chars of the key name, as long */
61 unsigned char typesDefined;
62 unsigned char symsDefined;
63 unsigned char actsDefined;
64 xkb_level_index_t numLevels[XkbNumKbdGroups];
66 /* syms[group] -> Single array for all the keysyms in the group. */
67 darray_xkb_keysym_t syms[XkbNumKbdGroups];
69 * symsMapIndex[group][level] -> The index from which the syms for
70 * the level begin in the syms[group] array. Remember each keycode
71 * can have multiple keysyms in each level (that is, each key press
72 * can result in multiple keysyms).
74 darray(int) symsMapIndex[XkbNumKbdGroups];
76 * symsMapNumEntries[group][level] -> How many syms are in
77 * syms[group][symsMapIndex[group][level]].
79 darray(size_t) symsMapNumEntries[XkbNumKbdGroups];
81 darray_xkb_action acts[XkbNumKbdGroups];
83 xkb_atom_t types[XkbNumKbdGroups];
84 enum key_repeat repeat;
85 struct xkb_behavior behavior;
86 unsigned short vmodmap;
89 uint8_t out_of_range_group_action;
90 xkb_group_index_t out_of_range_group_number;
94 * Init the given key info to sane values.
97 InitKeyInfo(KeyInfo *keyi, unsigned file_id)
100 static const char dflt[4] = "*";
103 keyi->file_id = file_id;
104 keyi->merge = MERGE_OVERRIDE;
105 keyi->name = KeyNameToLong(dflt);
106 keyi->typesDefined = keyi->symsDefined = keyi->actsDefined = 0;
108 for (i = 0; i < XkbNumKbdGroups; i++) {
109 keyi->numLevels[i] = 0;
110 keyi->types[i] = XKB_ATOM_NONE;
111 darray_init(keyi->syms[i]);
112 darray_init(keyi->symsMapIndex[i]);
113 darray_init(keyi->symsMapNumEntries[i]);
114 darray_init(keyi->acts[i]);
117 keyi->dfltType = XKB_ATOM_NONE;
118 keyi->behavior.type = XkbKB_Default;
119 keyi->behavior.data = 0;
121 keyi->repeat = KEY_REPEAT_UNDEFINED;
122 keyi->out_of_range_group_action = 0;
123 keyi->out_of_range_group_number = 0;
127 FreeKeyInfo(KeyInfo *keyi)
131 for (i = 0; i < XkbNumKbdGroups; i++) {
132 darray_free(keyi->syms[i]);
133 darray_free(keyi->symsMapIndex[i]);
134 darray_free(keyi->symsMapNumEntries[i]);
135 darray_free(keyi->acts[i]);
140 * Copy old into new, optionally reset old to 0.
141 * If old is reset, new simply re-uses old's memory. Otherwise, the memory is
142 * newly allocated and new points to the new memory areas.
145 CopyKeyInfo(KeyInfo * old, KeyInfo * new, bool clearOld)
152 for (i = 0; i < XkbNumKbdGroups; i++) {
153 old->numLevels[i] = 0;
154 darray_init(old->symsMapIndex[i]);
155 darray_init(old->symsMapNumEntries[i]);
156 darray_init(old->syms[i]);
157 darray_init(old->acts[i]);
161 for (i = 0; i < XkbNumKbdGroups; i++) {
162 darray_copy(new->syms[i], old->syms[i]);
163 darray_copy(new->symsMapIndex[i], old->symsMapIndex[i]);
164 darray_copy(new->symsMapNumEntries[i], old->symsMapNumEntries[i]);
165 darray_copy(new->acts[i], old->acts[i]);
172 /***====================================================================***/
174 typedef struct _ModMapEntry {
176 enum merge_mode merge;
180 unsigned long keyName;
185 typedef struct _SymbolsInfo {
186 char *name; /* e.g. pc+us+inet(evdev) */
189 enum merge_mode merge;
190 xkb_group_index_t explicit_group;
191 darray(KeyInfo) keys;
195 xkb_atom_t groupNames[XkbNumKbdGroups];
199 struct xkb_keymap *keymap;
203 InitSymbolsInfo(SymbolsInfo * info, struct xkb_keymap *keymap,
209 info->explicit_group = 0;
210 info->errorCount = 0;
211 info->file_id = file_id;
212 info->merge = MERGE_OVERRIDE;
213 darray_init(info->keys);
214 darray_growalloc(info->keys, 110);
215 list_init(&info->modMaps);
216 for (i = 0; i < XkbNumKbdGroups; i++)
217 info->groupNames[i] = XKB_ATOM_NONE;
218 InitKeyInfo(&info->dflt, file_id);
219 InitVModInfo(&info->vmods, keymap);
221 info->keymap = keymap;
225 FreeSymbolsInfo(SymbolsInfo * info)
228 ModMapEntry *mm, *next;
231 darray_foreach(keyi, info->keys) {
234 darray_free(info->keys);
235 list_foreach_safe(mm, next, &info->modMaps, entry)
237 memset(info, 0, sizeof(SymbolsInfo));
241 ResizeKeyGroup(KeyInfo *keyi, xkb_group_index_t group,
242 xkb_level_index_t numLevels, unsigned sizeSyms,
247 if (darray_size(keyi->syms[group]) < sizeSyms)
248 darray_resize0(keyi->syms[group], sizeSyms);
250 if (darray_empty(keyi->symsMapIndex[group]) ||
251 keyi->numLevels[group] < numLevels) {
252 darray_resize(keyi->symsMapIndex[group], numLevels);
253 for (i = keyi->numLevels[group]; i < numLevels; i++)
254 darray_item(keyi->symsMapIndex[group], i) = -1;
257 if (darray_empty(keyi->symsMapNumEntries[group]) ||
258 keyi->numLevels[group] < numLevels)
259 darray_resize0(keyi->symsMapNumEntries[group], numLevels);
261 if ((forceActions && (keyi->numLevels[group] < numLevels ||
262 darray_empty(keyi->acts[group]))) ||
263 (keyi->numLevels[group] < numLevels && !darray_empty(keyi->acts[group])))
264 darray_resize0(keyi->acts[group], numLevels);
266 if (keyi->numLevels[group] < numLevels)
267 keyi->numLevels[group] = numLevels;
272 enum key_group_selector {
279 MergeKeyGroups(SymbolsInfo * info,
280 KeyInfo * into, KeyInfo * from, xkb_group_index_t group)
282 darray_xkb_keysym_t resultSyms;
283 enum key_group_selector using = NONE;
284 darray_xkb_action resultActs;
285 xkb_level_index_t resultWidth;
286 unsigned int resultSize = 0;
289 bool report, clobber;
290 int verbosity = xkb_get_log_verbosity(info->keymap->ctx);
292 clobber = (from->merge != MERGE_AUGMENT);
294 report = (verbosity > 9) ||
295 (into->file_id == from->file_id && verbosity > 0);
297 darray_init(resultSyms);
299 if (into->numLevels[group] >= from->numLevels[group]) {
300 resultActs = into->acts[group];
301 resultWidth = into->numLevels[group];
304 resultActs = from->acts[group];
305 resultWidth = from->numLevels[group];
306 darray_resize(into->symsMapIndex[group],
307 from->numLevels[group]);
308 darray_resize0(into->symsMapNumEntries[group],
309 from->numLevels[group]);
311 for (i = into->numLevels[group]; i < from->numLevels[group]; i++)
312 darray_item(into->symsMapIndex[group], i) = -1;
315 if (darray_empty(resultActs) && (!darray_empty(into->acts[group]) ||
316 !darray_empty(from->acts[group]))) {
317 darray_resize0(resultActs, resultWidth);
318 for (i = 0; i < resultWidth; i++) {
319 union xkb_action *fromAct = NULL, *toAct = NULL;
321 if (!darray_empty(from->acts[group]))
322 fromAct = &darray_item(from->acts[group], i);
324 if (!darray_empty(into->acts[group]))
325 toAct = &darray_item(into->acts[group], i);
327 if (((fromAct == NULL) || (fromAct->type == XkbSA_NoAction))
328 && (toAct != NULL)) {
329 darray_item(resultActs, i) = *toAct;
331 else if (((toAct == NULL) || (toAct->type == XkbSA_NoAction))
332 && (fromAct != NULL)) {
333 darray_item(resultActs, i) = *fromAct;
336 union xkb_action *use, *ignore;
346 log_warn(info->keymap->ctx,
347 "Multiple actions for level %d/group %u on key %s; "
348 "Using %s, ignoring %s\n",
349 i + 1, group + 1, LongKeyNameText(into->name),
350 ActionTypeText(use->type),
351 ActionTypeText(ignore->type));
353 darray_item(resultActs, i) = *use;
358 for (i = 0; i < resultWidth; i++) {
359 unsigned int fromSize = 0;
362 if (!darray_empty(from->symsMapNumEntries[group]) &&
363 i < from->numLevels[group])
364 fromSize = darray_item(from->symsMapNumEntries[group], i);
366 if (!darray_empty(into->symsMapNumEntries[group]) &&
367 i < into->numLevels[group])
368 toSize = darray_item(into->symsMapNumEntries[group], i);
371 resultSize += toSize;
374 else if (toSize == 0 || clobber) {
375 resultSize += fromSize;
379 resultSize += toSize;
388 resultSyms = from->syms[group];
389 darray_free(into->symsMapNumEntries[group]);
390 darray_free(into->symsMapIndex[group]);
391 into->symsMapNumEntries[group] = from->symsMapNumEntries[group];
392 into->symsMapIndex[group] = from->symsMapIndex[group];
393 darray_init(from->symsMapNumEntries[group]);
394 darray_init(from->symsMapIndex[group]);
397 else if (using == TO) {
398 resultSyms = into->syms[group];
402 darray_resize0(resultSyms, resultSize);
404 for (i = 0; i < resultWidth; i++) {
405 enum key_group_selector use = NONE;
406 unsigned int fromSize = 0;
407 unsigned int toSize = 0;
409 if (i < from->numLevels[group])
410 fromSize = darray_item(from->symsMapNumEntries[group], i);
412 if (i < into->numLevels[group])
413 toSize = darray_item(into->symsMapNumEntries[group], i);
415 if (fromSize == 0 && toSize == 0) {
416 darray_item(into->symsMapIndex[group], i) = -1;
417 darray_item(into->symsMapNumEntries[group], i) = 0;
423 else if (toSize == 0 || clobber)
428 if (toSize && fromSize && report) {
429 log_info(info->keymap->ctx,
430 "Multiple symbols for group %u, level %d on key %s; "
431 "Using %s, ignoring %s\n",
432 group + 1, i + 1, LongKeyNameText(into->name),
433 (use == FROM ? "from" : "to"),
434 (use == FROM ? "to" : "from"));
438 memcpy(darray_mem(resultSyms, cur_idx),
439 darray_mem(from->syms[group],
440 darray_item(from->symsMapIndex[group], i)),
441 darray_item(from->symsMapNumEntries[group],
442 i) * sizeof(xkb_keysym_t));
443 darray_item(into->symsMapIndex[group], i) = cur_idx;
444 darray_item(into->symsMapNumEntries[group], i) =
445 darray_item(from->symsMapNumEntries[group], i);
448 memcpy(darray_mem(resultSyms, cur_idx),
449 darray_mem(into->syms[group],
450 darray_item(into->symsMapIndex[group], i)),
451 darray_item(into->symsMapNumEntries[group],
452 i) * sizeof(xkb_keysym_t));
453 darray_item(into->symsMapIndex[group], i) = cur_idx;
455 cur_idx += darray_item(into->symsMapNumEntries[group], i);
459 if (!darray_same(resultActs, into->acts[group]))
460 darray_free(into->acts[group]);
461 if (!darray_same(resultActs, from->acts[group]))
462 darray_free(from->acts[group]);
463 into->numLevels[group] = resultWidth;
464 if (!darray_same(resultSyms, into->syms[group]))
465 darray_free(into->syms[group]);
466 into->syms[group] = resultSyms;
467 if (!darray_same(resultSyms, from->syms[group]))
468 darray_free(from->syms[group]);
469 darray_init(from->syms[group]);
470 darray_free(from->symsMapIndex[group]);
471 darray_free(from->symsMapNumEntries[group]);
472 into->acts[group] = resultActs;
473 darray_init(from->acts[group]);
474 if (!darray_empty(into->syms[group]))
475 into->symsDefined |= (1 << group);
476 from->symsDefined &= ~(1 << group);
477 into->actsDefined |= (1 << group);
478 from->actsDefined &= ~(1 << group);
484 UseNewKeyField(enum key_field field, KeyInfo *old, KeyInfo *new,
485 int verbosity, enum key_field *collide)
487 if (!(old->defined & field))
490 if (new->defined & field) {
491 if ((old->file_id == new->file_id && verbosity > 0) || verbosity > 9)
494 if (new->merge != MERGE_AUGMENT)
503 MergeKeys(SymbolsInfo *info, KeyInfo *into, KeyInfo *from)
506 enum key_field collide = 0;
508 int verbosity = xkb_get_log_verbosity(info->keymap->ctx);
510 if (from->merge == MERGE_REPLACE) {
511 for (i = 0; i < XkbNumKbdGroups; i++) {
512 if (into->numLevels[i] != 0) {
513 darray_free(into->syms[i]);
514 darray_free(into->acts[i]);
518 memset(from, 0, sizeof(KeyInfo));
522 report = (verbosity > 9 ||
523 (into->file_id == from->file_id && verbosity > 0));
525 for (i = 0; i < XkbNumKbdGroups; i++) {
526 if (from->numLevels[i] > 0) {
527 if (into->numLevels[i] == 0) {
528 into->numLevels[i] = from->numLevels[i];
529 into->syms[i] = from->syms[i];
530 into->symsMapIndex[i] = from->symsMapIndex[i];
531 into->symsMapNumEntries[i] = from->symsMapNumEntries[i];
532 into->acts[i] = from->acts[i];
533 into->symsDefined |= (1 << i);
534 darray_init(from->syms[i]);
535 darray_init(from->symsMapIndex[i]);
536 darray_init(from->symsMapNumEntries[i]);
537 darray_init(from->acts[i]);
538 from->numLevels[i] = 0;
539 from->symsDefined &= ~(1 << i);
540 if (!darray_empty(into->syms[i]))
541 into->defined |= KEY_FIELD_SYMS;
542 if (!darray_empty(into->acts[i]))
543 into->defined |= KEY_FIELD_ACTS;
547 if (!darray_empty(into->syms[i]))
548 collide |= KEY_FIELD_SYMS;
549 if (!darray_empty(into->acts[i]))
550 collide |= KEY_FIELD_ACTS;
552 MergeKeyGroups(info, into, from, (unsigned) i);
555 if (from->types[i] != XKB_ATOM_NONE) {
556 if ((into->types[i] != XKB_ATOM_NONE) && report &&
557 (into->types[i] != from->types[i])) {
558 xkb_atom_t use, ignore;
559 collide |= KEY_FIELD_TYPES;
560 if (from->merge != MERGE_AUGMENT) {
561 use = from->types[i];
562 ignore = into->types[i];
565 use = into->types[i];
566 ignore = from->types[i];
569 log_warn(info->keymap->ctx,
570 "Multiple definitions for group %d type of key %s; "
571 "Using %s, ignoring %s\n",
572 i, LongKeyNameText(into->name),
573 xkb_atom_text(info->keymap->ctx, use),
574 xkb_atom_text(info->keymap->ctx, ignore));
577 if (from->merge != MERGE_AUGMENT ||
578 into->types[i] == XKB_ATOM_NONE) {
579 into->types[i] = from->types[i];
584 if (UseNewKeyField(KEY_FIELD_BEHAVIOR, into, from, verbosity, &collide)) {
585 into->behavior = from->behavior;
586 into->defined |= KEY_FIELD_BEHAVIOR;
588 if (UseNewKeyField(KEY_FIELD_VMODMAP, into, from, verbosity, &collide)) {
589 into->vmodmap = from->vmodmap;
590 into->defined |= KEY_FIELD_VMODMAP;
592 if (UseNewKeyField(KEY_FIELD_REPEAT, into, from, verbosity, &collide)) {
593 into->repeat = from->repeat;
594 into->defined |= KEY_FIELD_REPEAT;
596 if (UseNewKeyField(KEY_FIELD_TYPE_DFLT, into, from, verbosity, &collide)) {
597 into->dfltType = from->dfltType;
598 into->defined |= KEY_FIELD_TYPE_DFLT;
600 if (UseNewKeyField(KEY_FIELD_GROUPINFO, into, from, verbosity, &collide)) {
601 into->out_of_range_group_action = from->out_of_range_group_action;
602 into->out_of_range_group_number = from->out_of_range_group_number;
603 into->defined |= KEY_FIELD_GROUPINFO;
607 log_warn(info->keymap->ctx,
608 "Symbol map for key %s redefined; "
609 "Using %s definition for conflicting fields\n",
610 LongKeyNameText(into->name),
611 (from->merge == MERGE_AUGMENT ? "first" : "last"));
617 AddKeySymbols(SymbolsInfo *info, KeyInfo *keyi)
619 unsigned long real_name;
622 darray_foreach(iter, info->keys)
623 if (iter->name == keyi->name)
624 return MergeKeys(info, iter, keyi);
626 if (FindKeyNameForAlias(info->keymap, keyi->name, &real_name))
627 darray_foreach(iter, info->keys)
628 if (iter->name == real_name)
629 return MergeKeys(info, iter, keyi);
631 darray_resize0(info->keys, darray_size(info->keys) + 1);
632 new = &darray_item(info->keys, darray_size(info->keys) - 1);
633 return CopyKeyInfo(keyi, new, true);
637 AddModMapEntry(SymbolsInfo * info, ModMapEntry * new)
642 clobber = (new->merge != MERGE_AUGMENT);
643 list_foreach(mm, &info->modMaps, entry) {
644 if (new->haveSymbol && mm->haveSymbol
645 && (new->u.keySym == mm->u.keySym)) {
646 unsigned use, ignore;
647 if (mm->modifier != new->modifier) {
650 ignore = mm->modifier;
654 ignore = new->modifier;
656 log_err(info->keymap->ctx,
657 "%s added to symbol map for multiple modifiers; "
658 "Using %s, ignoring %s.\n",
659 KeysymText(new->u.keySym), ModIndexText(use),
660 ModIndexText(ignore));
665 if ((!new->haveSymbol) && (!mm->haveSymbol) &&
666 (new->u.keyName == mm->u.keyName)) {
667 unsigned use, ignore;
668 if (mm->modifier != new->modifier) {
671 ignore = mm->modifier;
675 ignore = new->modifier;
677 log_err(info->keymap->ctx,
678 "Key %s added to map for multiple modifiers; "
679 "Using %s, ignoring %s.\n",
680 LongKeyNameText(new->u.keyName), ModIndexText(use),
681 ModIndexText(ignore));
688 mm = malloc(sizeof(*mm));
690 log_wsgo(info->keymap->ctx,
691 "Could not allocate modifier map entry; "
692 "Modifier map for %s will be incomplete\n",
693 ModIndexText(new->modifier));
698 list_add(&mm->entry, &info->modMaps);
702 /***====================================================================***/
705 MergeIncludedSymbols(SymbolsInfo *into, SymbolsInfo *from,
706 enum merge_mode merge)
710 ModMapEntry *mm, *next;
712 if (from->errorCount > 0) {
713 into->errorCount += from->errorCount;
716 if (into->name == NULL) {
717 into->name = from->name;
720 for (i = 0; i < XkbNumKbdGroups; i++) {
721 if (from->groupNames[i] != XKB_ATOM_NONE) {
722 if ((merge != MERGE_AUGMENT) ||
723 (into->groupNames[i] == XKB_ATOM_NONE))
724 into->groupNames[i] = from->groupNames[i];
728 darray_foreach(keyi, from->keys) {
729 if (merge != MERGE_DEFAULT)
732 if (!AddKeySymbols(into, keyi))
736 list_foreach_safe(mm, next, &from->modMaps, entry) {
737 if (merge != MERGE_DEFAULT)
739 if (!AddModMapEntry(into, mm))
743 list_init(&from->modMaps);
747 HandleSymbolsFile(SymbolsInfo *info, XkbFile *file, enum merge_mode merge);
750 HandleIncludeSymbols(SymbolsInfo *info, IncludeStmt *stmt)
752 enum merge_mode merge = MERGE_DEFAULT;
754 SymbolsInfo included, next_incl;
756 InitSymbolsInfo(&included, info->keymap, info->file_id);
759 included.name = stmt->stmt;
763 for (; stmt; stmt = stmt->next_incl) {
764 if (!ProcessIncludeFile(info->keymap->ctx, stmt, FILE_TYPE_SYMBOLS,
766 info->errorCount += 10;
767 FreeSymbolsInfo(&included);
771 InitSymbolsInfo(&next_incl, info->keymap, rtrn->id);
772 next_incl.merge = next_incl.dflt.merge = MERGE_OVERRIDE;
774 next_incl.explicit_group = atoi(stmt->modifier) - 1;
776 next_incl.explicit_group = info->explicit_group;
778 HandleSymbolsFile(&next_incl, rtrn, MERGE_OVERRIDE);
780 MergeIncludedSymbols(&included, &next_incl, merge);
782 FreeSymbolsInfo(&next_incl);
786 MergeIncludedSymbols(info, &included, merge);
787 FreeSymbolsInfo(&included);
789 return (info->errorCount == 0);
796 GetGroupIndex(SymbolsInfo *info, KeyInfo *keyi, ExprDef *arrayNdx,
797 unsigned what, xkb_group_index_t *ndx_rtrn)
806 if (arrayNdx == NULL) {
810 defined = keyi->symsDefined;
812 defined = keyi->actsDefined;
814 for (i = 0; i < XkbNumKbdGroups; i++) {
815 if ((defined & (1 << i)) == 0) {
821 log_err(info->keymap->ctx,
822 "Too many groups of %s for key %s (max %u); "
823 "Ignoring %s defined for extra groups\n",
824 name, LongKeyNameText(keyi->name), XkbNumKbdGroups + 1, name);
828 if (!ExprResolveGroup(info->keymap->ctx, arrayNdx, ndx_rtrn)) {
829 log_err(info->keymap->ctx,
830 "Illegal group index for %s of key %s\n"
831 "Definition with non-integer array index ignored\n",
832 name, LongKeyNameText(keyi->name));
841 AddSymbolsToKey(SymbolsInfo *info, KeyInfo *keyi, ExprDef *arrayNdx,
844 xkb_group_index_t ndx;
846 xkb_level_index_t nLevels;
850 if (!GetGroupIndex(info, keyi, arrayNdx, SYMBOLS, &ndx))
853 keyi->symsDefined |= (1 << ndx);
856 if (value->op != EXPR_KEYSYM_LIST) {
857 log_err(info->keymap->ctx,
858 "Expected a list of symbols, found %s; "
859 "Ignoring symbols for group %u of %s\n",
860 exprOpText(value->op), ndx + 1, LongKeyNameText(keyi->name));
863 if (!darray_empty(keyi->syms[ndx])) {
864 log_err(info->keymap->ctx,
865 "Symbols for key %s, group %u already defined; "
866 "Ignoring duplicate definition\n",
867 LongKeyNameText(keyi->name), ndx + 1);
870 nSyms = darray_size(value->value.list.syms);
871 nLevels = darray_size(value->value.list.symsMapIndex);
872 if ((keyi->numLevels[ndx] < nSyms || darray_empty(keyi->syms[ndx])) &&
873 (!ResizeKeyGroup(keyi, ndx, nLevels, nSyms, false))) {
874 log_wsgo(info->keymap->ctx,
875 "Could not resize group %u of key %s to contain %zu levels; "
877 ndx + 1, LongKeyNameText(keyi->name), nSyms);
880 keyi->symsDefined |= (1 << ndx);
881 for (i = 0; i < nLevels; i++) {
882 darray_item(keyi->symsMapIndex[ndx], i) =
883 darray_item(value->value.list.symsMapIndex, i);
884 darray_item(keyi->symsMapNumEntries[ndx], i) =
885 darray_item(value->value.list.symsNumEntries, i);
887 for (j = 0; j < darray_item(keyi->symsMapNumEntries[ndx], i); j++) {
888 /* FIXME: What's abort() doing here? */
889 if (darray_item(keyi->symsMapIndex[ndx], i) + j >= nSyms)
891 if (!LookupKeysym(darray_item(value->value.list.syms,
892 darray_item(value->value.list.symsMapIndex,
894 &darray_item(keyi->syms[ndx],
895 darray_item(keyi->symsMapIndex[ndx],
897 log_warn(info->keymap->ctx,
898 "Could not resolve keysym %s for key %s, group %u (%s), level %zu\n",
899 darray_item(value->value.list.syms, i),
900 LongKeyNameText(keyi->name),
902 xkb_atom_text(info->keymap->ctx,
903 info->groupNames[ndx]),
906 darray_item(keyi->syms[ndx],
907 darray_item(keyi->symsMapIndex[ndx],
908 i) + j) = XKB_KEY_NoSymbol;
909 darray_item(keyi->symsMapIndex[ndx], i) = -1;
910 darray_item(keyi->symsMapNumEntries[ndx], i) = 0;
913 if (darray_item(keyi->symsMapNumEntries[ndx], i) == 1 &&
914 darray_item(keyi->syms[ndx],
915 darray_item(keyi->symsMapIndex[ndx],
916 i) + j) == XKB_KEY_NoSymbol) {
917 darray_item(keyi->symsMapIndex[ndx], i) = -1;
918 darray_item(keyi->symsMapNumEntries[ndx], i) = 0;
922 for (j = keyi->numLevels[ndx] - 1;
923 j >= 0 && darray_item(keyi->symsMapNumEntries[ndx], j) == 0; j--)
924 keyi->numLevels[ndx]--;
929 AddActionsToKey(SymbolsInfo *info, KeyInfo *keyi, ExprDef *arrayNdx,
933 xkb_group_index_t ndx;
936 struct xkb_any_action *toAct;
938 if (!GetGroupIndex(info, keyi, arrayNdx, ACTIONS, &ndx))
942 keyi->actsDefined |= (1 << ndx);
946 if (value->op != EXPR_ACTION_LIST) {
947 log_wsgo(info->keymap->ctx,
948 "Bad expression type (%d) for action list value; "
949 "Ignoring actions for group %u of %s\n",
950 value->op, ndx, LongKeyNameText(keyi->name));
954 if (!darray_empty(keyi->acts[ndx])) {
955 log_wsgo(info->keymap->ctx,
956 "Actions for key %s, group %u already defined\n",
957 LongKeyNameText(keyi->name), ndx);
961 for (nActs = 0, act = value->value.child; act != NULL; nActs++) {
962 act = (ExprDef *) act->common.next;
966 log_wsgo(info->keymap->ctx,
967 "Action list but not actions in AddActionsToKey\n");
971 if ((keyi->numLevels[ndx] < nActs || darray_empty(keyi->acts[ndx])) &&
972 !ResizeKeyGroup(keyi, ndx, nActs, nActs, true)) {
973 log_wsgo(info->keymap->ctx,
974 "Could not resize group %u of key %s; "
976 ndx, LongKeyNameText(keyi->name));
979 keyi->actsDefined |= (1 << ndx);
981 toAct = (struct xkb_any_action *) darray_mem(keyi->acts[ndx], 0);
982 act = value->value.child;
983 for (i = 0; i < nActs; i++, toAct++) {
984 if (!HandleActionDef(act, info->keymap, toAct, info->action)) {
985 log_err(info->keymap->ctx,
986 "Illegal action definition for %s; "
987 "Action for group %u/level %zu ignored\n",
988 LongKeyNameText(keyi->name), ndx + 1, i + 1);
990 act = (ExprDef *) act->common.next;
996 static const LookupEntry lockingEntries[] = {
997 { "true", XkbKB_Lock },
998 { "yes", XkbKB_Lock },
999 { "on", XkbKB_Lock },
1000 { "false", XkbKB_Default },
1001 { "no", XkbKB_Default },
1002 { "off", XkbKB_Default },
1003 { "permanent", XkbKB_Lock | XkbKB_Permanent },
1007 static const LookupEntry repeatEntries[] = {
1008 { "true", KEY_REPEAT_YES },
1009 { "yes", KEY_REPEAT_YES },
1010 { "on", KEY_REPEAT_YES },
1011 { "false", KEY_REPEAT_NO },
1012 { "no", KEY_REPEAT_NO },
1013 { "off", KEY_REPEAT_NO },
1014 { "default", KEY_REPEAT_UNDEFINED },
1019 SetSymbolsField(SymbolsInfo *info, KeyInfo *keyi, const char *field,
1020 ExprDef *arrayNdx, ExprDef *value)
1023 struct xkb_context *ctx = info->keymap->ctx;
1025 if (istreq(field, "type")) {
1026 xkb_group_index_t ndx;
1029 if (!ExprResolveString(ctx, value, &str))
1030 log_lvl(info->keymap->ctx, 1,
1031 "The type field of a key symbol map must be a string; "
1032 "Ignoring illegal type definition\n");
1034 if (arrayNdx == NULL) {
1035 keyi->dfltType = xkb_atom_intern(ctx, str);
1036 keyi->defined |= KEY_FIELD_TYPE_DFLT;
1038 else if (!ExprResolveGroup(ctx, arrayNdx, &ndx)) {
1039 log_err(info->keymap->ctx,
1040 "Illegal group index for type of key %s; "
1041 "Definition with non-integer array index ignored\n",
1042 LongKeyNameText(keyi->name));
1047 keyi->types[ndx] = xkb_atom_intern(ctx, str);
1048 keyi->typesDefined |= (1 << ndx);
1051 else if (istreq(field, "symbols"))
1052 return AddSymbolsToKey(info, keyi, arrayNdx, value);
1053 else if (istreq(field, "actions"))
1054 return AddActionsToKey(info, keyi, arrayNdx, value);
1055 else if (istreq(field, "vmods") ||
1056 istreq(field, "virtualmods") ||
1057 istreq(field, "virtualmodifiers")) {
1058 xkb_mod_mask_t mask;
1060 ok = ExprResolveVModMask(info->keymap, value, &mask);
1062 keyi->vmodmap = (mask >> 8);
1063 keyi->defined |= KEY_FIELD_VMODMAP;
1066 log_err(info->keymap->ctx,
1067 "Expected a virtual modifier mask, found %s; "
1068 "Ignoring virtual modifiers definition for key %s\n",
1069 exprOpText(value->op), LongKeyNameText(keyi->name));
1072 else if (istreq(field, "locking") ||
1073 istreq(field, "lock") ||
1074 istreq(field, "locks")) {
1077 ok = ExprResolveEnum(ctx, value, &val, lockingEntries);
1079 keyi->behavior.type = val;
1080 keyi->defined |= KEY_FIELD_BEHAVIOR;
1082 else if (istreq(field, "radiogroup") ||
1083 istreq(field, "permanentradiogroup") ||
1084 istreq(field, "allownone")) {
1085 log_err(info->keymap->ctx,
1086 "Radio groups not supported; "
1087 "Ignoring radio group specification for key %s\n",
1088 LongKeyNameText(keyi->name));
1091 else if (istreq_prefix("overlay", field) ||
1092 istreq_prefix("permanentoverlay", field)) {
1093 log_err(info->keymap->ctx,
1094 "Overlays not supported; "
1095 "Ignoring overlay specification for key %s\n",
1096 LongKeyNameText(keyi->name));
1098 else if (istreq(field, "repeating") ||
1099 istreq(field, "repeats") ||
1100 istreq(field, "repeat")) {
1103 ok = ExprResolveEnum(ctx, value, &val, repeatEntries);
1105 log_err(info->keymap->ctx,
1106 "Illegal repeat setting for %s; "
1107 "Non-boolean repeat setting ignored\n",
1108 LongKeyNameText(keyi->name));
1112 keyi->defined |= KEY_FIELD_REPEAT;
1114 else if (istreq(field, "groupswrap") ||
1115 istreq(field, "wrapgroups")) {
1118 if (!ExprResolveBoolean(ctx, value, &set)) {
1119 log_err(info->keymap->ctx,
1120 "Illegal groupsWrap setting for %s; "
1121 "Non-boolean value ignored\n",
1122 LongKeyNameText(keyi->name));
1127 keyi->out_of_range_group_action = XkbWrapIntoRange;
1129 keyi->out_of_range_group_action = XkbClampIntoRange;
1131 keyi->defined |= KEY_FIELD_GROUPINFO;
1133 else if (istreq(field, "groupsclamp") ||
1134 istreq(field, "clampgroups")) {
1137 if (!ExprResolveBoolean(ctx, value, &set)) {
1138 log_err(info->keymap->ctx,
1139 "Illegal groupsClamp setting for %s; "
1140 "Non-boolean value ignored\n",
1141 LongKeyNameText(keyi->name));
1146 keyi->out_of_range_group_action = XkbClampIntoRange;
1148 keyi->out_of_range_group_action = XkbWrapIntoRange;
1150 keyi->defined |= KEY_FIELD_GROUPINFO;
1152 else if (istreq(field, "groupsredirect") ||
1153 istreq(field, "redirectgroups")) {
1154 xkb_group_index_t grp;
1156 if (!ExprResolveGroup(ctx, value, &grp)) {
1157 log_err(info->keymap->ctx,
1158 "Illegal group index for redirect of key %s; "
1159 "Definition with non-integer group ignored\n",
1160 LongKeyNameText(keyi->name));
1164 keyi->out_of_range_group_action = XkbRedirectIntoRange;
1165 keyi->out_of_range_group_number = grp - 1;
1166 keyi->defined |= KEY_FIELD_GROUPINFO;
1169 log_err(info->keymap->ctx,
1170 "Unknown field %s in a symbol interpretation; "
1171 "Definition ignored\n",
1179 SetGroupName(SymbolsInfo *info, ExprDef *arrayNdx, ExprDef *value)
1181 xkb_group_index_t grp;
1185 log_lvl(info->keymap->ctx, 1,
1186 "You must specify an index when specifying a group name; "
1187 "Group name definition without array subscript ignored\n");
1191 if (!ExprResolveGroup(info->keymap->ctx, arrayNdx, &grp)) {
1192 log_err(info->keymap->ctx,
1193 "Illegal index in group name definition; "
1194 "Definition with non-integer array index ignored\n");
1198 if (!ExprResolveString(info->keymap->ctx, value, &name)) {
1199 log_err(info->keymap->ctx,
1200 "Group name must be a string; "
1201 "Illegal name for group %d ignored\n", grp);
1205 info->groupNames[grp - 1 + info->explicit_group] =
1206 xkb_atom_intern(info->keymap->ctx, name);
1212 HandleSymbolsVar(SymbolsInfo *info, VarDef *stmt)
1214 const char *elem, *field;
1218 if (ExprResolveLhs(info->keymap->ctx, stmt->name, &elem, &field,
1220 return 0; /* internal error, already reported */
1221 if (elem && istreq(elem, "key")) {
1222 ret = SetSymbolsField(info, &info->dflt, field, arrayNdx,
1225 else if (!elem && (istreq(field, "name") ||
1226 istreq(field, "groupname"))) {
1227 ret = SetGroupName(info, arrayNdx, stmt->value);
1229 else if (!elem && (istreq(field, "groupswrap") ||
1230 istreq(field, "wrapgroups"))) {
1231 log_err(info->keymap->ctx,
1232 "Global \"groupswrap\" not supported; Ignored\n");
1235 else if (!elem && (istreq(field, "groupsclamp") ||
1236 istreq(field, "clampgroups"))) {
1237 log_err(info->keymap->ctx,
1238 "Global \"groupsclamp\" not supported; Ignored\n");
1241 else if (!elem && (istreq(field, "groupsredirect") ||
1242 istreq(field, "redirectgroups"))) {
1243 log_err(info->keymap->ctx,
1244 "Global \"groupsredirect\" not supported; Ignored\n");
1247 else if (!elem && istreq(field, "allownone")) {
1248 log_err(info->keymap->ctx,
1249 "Radio groups not supported; "
1250 "Ignoring \"allownone\" specification\n");
1254 ret = SetActionField(info->keymap, elem, field, arrayNdx,
1255 stmt->value, &info->action);
1262 HandleSymbolsBody(SymbolsInfo *info, VarDef *def, KeyInfo *keyi)
1265 const char *elem, *field;
1268 for (; def; def = (VarDef *) def->common.next) {
1269 if (def->name && def->name->op == EXPR_FIELD_REF) {
1270 ok = HandleSymbolsVar(info, def);
1275 if (!def->value || def->value->op == EXPR_KEYSYM_LIST)
1282 ok = ExprResolveLhs(info->keymap->ctx, def->name, &elem, &field,
1287 ok = SetSymbolsField(info, keyi, field, arrayNdx, def->value);
1294 SetExplicitGroup(SymbolsInfo *info, KeyInfo *keyi)
1296 xkb_group_index_t group = info->explicit_group;
1301 if ((keyi->typesDefined | keyi->symsDefined | keyi->actsDefined) & ~1) {
1302 xkb_group_index_t i;
1303 log_warn(info->keymap->ctx,
1304 "For the map %s an explicit group specified, "
1305 "but key %s has more than one group defined; "
1306 "All groups except first one will be ignored\n",
1307 info->name, LongKeyNameText(keyi->name));
1308 for (i = 1; i < XkbNumKbdGroups; i++) {
1309 keyi->numLevels[i] = 0;
1310 darray_free(keyi->syms[i]);
1311 darray_free(keyi->acts[i]);
1315 keyi->typesDefined = keyi->symsDefined = keyi->actsDefined = 1 << group;
1317 keyi->numLevels[group] = keyi->numLevels[0];
1318 keyi->numLevels[0] = 0;
1319 keyi->syms[group] = keyi->syms[0];
1320 darray_init(keyi->syms[0]);
1321 keyi->symsMapIndex[group] = keyi->symsMapIndex[0];
1322 darray_init(keyi->symsMapIndex[0]);
1323 keyi->symsMapNumEntries[group] = keyi->symsMapNumEntries[0];
1324 darray_init(keyi->symsMapNumEntries[0]);
1325 keyi->acts[group] = keyi->acts[0];
1326 darray_init(keyi->acts[0]);
1327 keyi->types[group] = keyi->types[0];
1333 HandleSymbolsDef(SymbolsInfo *info, SymbolsDef *stmt)
1337 InitKeyInfo(&keyi, info->file_id);
1338 CopyKeyInfo(&info->dflt, &keyi, false);
1339 keyi.merge = stmt->merge;
1340 keyi.name = KeyNameToLong(stmt->keyName);
1341 if (!HandleSymbolsBody(info, (VarDef *) stmt->symbols, &keyi)) {
1346 if (!SetExplicitGroup(info, &keyi)) {
1351 if (!AddKeySymbols(info, &keyi)) {
1359 HandleModMapDef(SymbolsInfo *info, ModMapDef *def)
1363 xkb_mod_index_t ndx;
1365 struct xkb_context *ctx = info->keymap->ctx;
1367 if (!LookupModIndex(ctx, NULL, def->modifier, EXPR_TYPE_INT, &ndx)) {
1368 log_err(info->keymap->ctx,
1369 "Illegal modifier map definition; "
1370 "Ignoring map for non-modifier \"%s\"\n",
1371 xkb_atom_text(ctx, def->modifier));
1378 for (key = def->keys; key != NULL; key = (ExprDef *) key->common.next) {
1381 if (key->op == EXPR_VALUE && key->value_type == EXPR_TYPE_KEYNAME) {
1382 tmp.haveSymbol = false;
1383 tmp.u.keyName = KeyNameToLong(key->value.keyName);
1385 else if (ExprResolveKeySym(ctx, key, &sym)) {
1386 tmp.haveSymbol = true;
1390 log_err(info->keymap->ctx,
1391 "Modmap entries may contain only key names or keysyms; "
1392 "Illegal definition for %s modifier ignored\n",
1393 ModIndexText(tmp.modifier));
1397 ok = AddModMapEntry(info, &tmp) && ok;
1403 HandleSymbolsFile(SymbolsInfo *info, XkbFile *file, enum merge_mode merge)
1409 info->name = strdup_safe(file->name);
1412 for (stmt = file->defs; stmt; stmt = stmt->next) {
1413 switch (stmt->type) {
1415 ok = HandleIncludeSymbols(info, (IncludeStmt *) stmt);
1418 ok = HandleSymbolsDef(info, (SymbolsDef *) stmt);
1421 ok = HandleSymbolsVar(info, (VarDef *) stmt);
1424 ok = HandleVModDef((VModDef *) stmt, info->keymap, merge,
1428 ok = HandleModMapDef(info, (ModMapDef *) stmt);
1431 log_err(info->keymap->ctx,
1432 "Interpretation files may not include other types; "
1433 "Ignoring %s\n", StmtTypeToString(stmt->type));
1441 if (info->errorCount > 10) {
1442 log_err(info->keymap->ctx, "Abandoning symbols file \"%s\"\n",
1450 * Given a keysym @sym, return a key which generates it, or NULL.
1451 * This is used for example in a modifier map definition, such as:
1452 * modifier_map Lock { Caps_Lock };
1453 * where we want to add the Lock modifier to the modmap of the key
1454 * which matches the keysym Caps_Lock.
1455 * Since there can be many keys which generates the keysym, the key
1456 * is chosen first by lowest group in which the keysym appears, than
1457 * by lowest level and than by lowest key code.
1459 static struct xkb_key *
1460 FindKeyForSymbol(struct xkb_keymap *keymap, xkb_keysym_t sym)
1462 struct xkb_key *key, *ret = NULL;
1463 xkb_group_index_t group, min_group = UINT32_MAX;
1464 xkb_level_index_t level, min_level = UINT16_MAX;
1466 xkb_foreach_key(key, keymap) {
1467 for (group = 0; group < key->num_groups; group++) {
1468 for (level = 0; level < XkbKeyGroupWidth(keymap, key, group);
1470 if (XkbKeyNumSyms(key, group, level) != 1 ||
1471 (XkbKeySymEntry(key, group, level))[0] != sym)
1475 * If the keysym was found in a group or level > 0, we must
1476 * keep looking since we might find a key in which the keysym
1477 * is in a lower group or level.
1479 if (group < min_group ||
1480 (group == min_group && level < min_level)) {
1482 if (group == 0 && level == 0) {
1498 * Find the given name in the keymap->map->types and return its index.
1500 * @param atom The atom to search for.
1501 * @param type_rtrn Set to the index of the name if found.
1503 * @return true if found, false otherwise.
1506 FindNamedType(struct xkb_keymap *keymap, xkb_atom_t atom, unsigned *type_rtrn)
1509 const char *name = xkb_atom_text(keymap->ctx, atom);
1510 struct xkb_key_type *type;
1513 darray_foreach(type, keymap->types) {
1514 if (streq(type->name, name)) {
1525 * Assign a type to the given sym and return the Atom for the type assigned.
1528 * - ONE_LEVEL for width 0/1
1529 * - ALPHABETIC for 2 shift levels, with lower/upercase
1530 * - KEYPAD for keypad keys.
1531 * - TWO_LEVEL for other 2 shift level keys.
1532 * and the same for four level keys.
1534 * @param width Number of sysms in syms.
1535 * @param syms The keysyms for the given key (must be size width).
1536 * @param typeNameRtrn Set to the Atom of the type name.
1538 * @returns true if a type could be found, false otherwise.
1540 * FIXME: I need to take the KeyInfo so I can look at symsMapIndex and
1541 * all that fun stuff rather than just assuming there's always one
1545 FindAutomaticType(struct xkb_keymap *keymap, xkb_level_index_t width,
1546 const xkb_keysym_t *syms, xkb_atom_t *typeNameRtrn,
1550 if ((width == 1) || (width == 0)) {
1551 *typeNameRtrn = xkb_atom_intern(keymap->ctx, "ONE_LEVEL");
1554 else if (width == 2) {
1555 if (syms && xkb_keysym_is_lower(syms[0]) &&
1556 xkb_keysym_is_upper(syms[1])) {
1557 *typeNameRtrn = xkb_atom_intern(keymap->ctx, "ALPHABETIC");
1559 else if (syms && (xkb_keysym_is_keypad(syms[0]) ||
1560 xkb_keysym_is_keypad(syms[1]))) {
1561 *typeNameRtrn = xkb_atom_intern(keymap->ctx, "KEYPAD");
1565 *typeNameRtrn = xkb_atom_intern(keymap->ctx, "TWO_LEVEL");
1569 else if (width <= 4) {
1570 if (syms && xkb_keysym_is_lower(syms[0]) &&
1571 xkb_keysym_is_upper(syms[1]))
1572 if (xkb_keysym_is_lower(syms[2]) && xkb_keysym_is_upper(syms[3]))
1574 xkb_atom_intern(keymap->ctx, "FOUR_LEVEL_ALPHABETIC");
1576 *typeNameRtrn = xkb_atom_intern(keymap->ctx,
1577 "FOUR_LEVEL_SEMIALPHABETIC");
1579 else if (syms && (xkb_keysym_is_keypad(syms[0]) ||
1580 xkb_keysym_is_keypad(syms[1])))
1581 *typeNameRtrn = xkb_atom_intern(keymap->ctx, "FOUR_LEVEL_KEYPAD");
1583 *typeNameRtrn = xkb_atom_intern(keymap->ctx, "FOUR_LEVEL");
1584 /* XXX: why not set autoType here? */
1586 return ((width >= 0) && (width <= 4));
1590 * Ensure the given KeyInfo is in a coherent state, i.e. no gaps between the
1591 * groups, and reduce to one group if all groups are identical anyway.
1594 PrepareKeyDef(KeyInfo *keyi)
1596 xkb_group_index_t i, lastGroup;
1597 unsigned int defined;
1598 xkb_level_index_t j, width;
1601 defined = keyi->symsDefined | keyi->actsDefined | keyi->typesDefined;
1602 /* get highest group number */
1603 for (i = XkbNumKbdGroups - 1; i > 0; i--) {
1604 if (defined & (1 << i))
1612 /* If there are empty groups between non-empty ones fill them with data */
1613 /* from the first group. */
1614 /* We can make a wrong assumption here. But leaving gaps is worse. */
1615 for (i = lastGroup; i > 0; i--) {
1616 if (defined & (1 << i))
1618 width = keyi->numLevels[0];
1619 if (keyi->typesDefined & 1) {
1620 for (j = 0; j < width; j++) {
1621 keyi->types[i] = keyi->types[0];
1623 keyi->typesDefined |= 1 << i;
1625 if ((keyi->actsDefined & 1) && !darray_empty(keyi->acts[0])) {
1626 darray_copy(keyi->acts[i], keyi->acts[0]);
1627 keyi->actsDefined |= 1 << i;
1629 if ((keyi->symsDefined & 1) && !darray_empty(keyi->syms[0])) {
1630 darray_copy(keyi->syms[i], keyi->syms[0]);
1631 darray_copy(keyi->symsMapIndex[i], keyi->symsMapIndex[0]);
1632 darray_copy(keyi->symsMapNumEntries[i],
1633 keyi->symsMapNumEntries[0]);
1634 keyi->symsDefined |= 1 << i;
1637 keyi->numLevels[i] = keyi->numLevels[0];
1640 /* If all groups are completely identical remove them all */
1641 /* exept the first one. */
1643 for (i = lastGroup; i > 0; i--) {
1644 if ((keyi->numLevels[i] != keyi->numLevels[0]) ||
1645 (keyi->types[i] != keyi->types[0])) {
1649 if (!darray_same(keyi->syms[i], keyi->syms[0]) &&
1650 (darray_empty(keyi->syms[i]) || darray_empty(keyi->syms[0]) ||
1651 darray_size(keyi->syms[i]) != darray_size(keyi->syms[0]) ||
1652 memcmp(darray_mem(keyi->syms[i], 0),
1653 darray_mem(keyi->syms[0], 0),
1654 sizeof(xkb_keysym_t) * darray_size(keyi->syms[0])))) {
1658 if (!darray_same(keyi->symsMapIndex[i], keyi->symsMapIndex[0]) &&
1659 (darray_empty(keyi->symsMapIndex[i]) ||
1660 darray_empty(keyi->symsMapIndex[0]) ||
1661 memcmp(darray_mem(keyi->symsMapIndex[i], 0),
1662 darray_mem(keyi->symsMapIndex[0], 0),
1663 keyi->numLevels[0] * sizeof(int)))) {
1667 if (!darray_same(keyi->symsMapNumEntries[i],
1668 keyi->symsMapNumEntries[0]) &&
1669 (darray_empty(keyi->symsMapNumEntries[i]) ||
1670 darray_empty(keyi->symsMapNumEntries[0]) ||
1671 memcmp(darray_mem(keyi->symsMapNumEntries[i], 0),
1672 darray_mem(keyi->symsMapNumEntries[0], 0),
1673 keyi->numLevels[0] * sizeof(size_t)))) {
1677 if (!darray_same(keyi->acts[i], keyi->acts[0]) &&
1678 (darray_empty(keyi->acts[i]) || darray_empty(keyi->acts[0]) ||
1679 memcmp(darray_mem(keyi->acts[i], 0),
1680 darray_mem(keyi->acts[0], 0),
1681 keyi->numLevels[0] * sizeof(union xkb_action)))) {
1687 for (i = lastGroup; i > 0; i--) {
1688 keyi->numLevels[i] = 0;
1689 darray_free(keyi->syms[i]);
1690 darray_free(keyi->symsMapIndex[i]);
1691 darray_free(keyi->symsMapNumEntries[i]);
1692 darray_free(keyi->acts[i]);
1695 keyi->symsDefined &= 1;
1696 keyi->actsDefined &= 1;
1697 keyi->typesDefined &= 1;
1702 * Copy the KeyInfo into the keyboard description.
1704 * This function recurses.
1707 CopySymbolsDef(SymbolsInfo *info, KeyInfo *keyi,
1708 xkb_keycode_t start_from)
1710 struct xkb_keymap *keymap = info->keymap;
1712 struct xkb_key *key;
1713 size_t sizeSyms = 0;
1714 xkb_group_index_t i, nGroups;
1715 xkb_level_index_t width, tmp;
1716 struct xkb_key_type * type;
1717 bool haveActions, autoType, useAlias;
1718 unsigned types[XkbNumKbdGroups];
1719 union xkb_action *outActs;
1720 unsigned int symIndex = 0;
1722 useAlias = (start_from == 0);
1724 key = FindNamedKey(keymap, keyi->name, useAlias,
1725 CreateKeyNames(keymap), start_from);
1727 if (start_from == 0)
1728 log_lvl(info->keymap->ctx, 5,
1729 "Key %s not found in keycodes; Symbols ignored\n",
1730 LongKeyNameText(keyi->name));
1733 kc = XkbKeyGetKeycode(keymap, key);
1735 haveActions = false;
1737 for (i = nGroups = 0; i < XkbNumKbdGroups; i++) {
1738 if (((i + 1) > nGroups)
1739 && (((keyi->symsDefined | keyi->actsDefined) & (1 << i))
1740 || (keyi->typesDefined) & (1 << i)))
1742 if (!darray_empty(keyi->acts[i]))
1745 /* Assign the type to the key, if it is missing. */
1746 if (keyi->types[i] == XKB_ATOM_NONE) {
1747 if (keyi->dfltType != XKB_ATOM_NONE)
1748 keyi->types[i] = keyi->dfltType;
1749 else if (FindAutomaticType(keymap, keyi->numLevels[i],
1750 darray_mem(keyi->syms[i], 0),
1751 &keyi->types[i], &autoType)) { }
1753 log_lvl(info->keymap->ctx, 5,
1754 "No automatic type for %d symbols; "
1755 "Using %s for the %s key (keycode %d)\n",
1757 xkb_atom_text(keymap->ctx, keyi->types[i]),
1758 LongKeyNameText(keyi->name), kc);
1760 if (FindNamedType(keymap, keyi->types[i], &types[i])) {
1761 if (!autoType || keyi->numLevels[i] > 2)
1762 key->explicit |= (1 << i);
1765 log_lvl(info->keymap->ctx, 3,
1766 "Type \"%s\" is not defined; "
1767 "Using TWO_LEVEL for the %s key (keycode %d)\n",
1768 xkb_atom_text(keymap->ctx, keyi->types[i]),
1769 LongKeyNameText(keyi->name), kc);
1770 types[i] = XkbTwoLevelIndex;
1773 /* if the type specifies fewer levels than the key has, shrink the key */
1774 type = &darray_item(keymap->types, types[i]);
1775 if (type->num_levels < keyi->numLevels[i]) {
1776 log_lvl(info->keymap->ctx, 1,
1777 "Type \"%s\" has %d levels, but %s has %d symbols; "
1778 "Ignoring extra symbols\n",
1779 type->name, type->num_levels,
1780 LongKeyNameText(keyi->name),
1781 keyi->numLevels[i]);
1782 keyi->numLevels[i] = type->num_levels;
1784 if (keyi->numLevels[i] > width)
1785 width = keyi->numLevels[i];
1786 if (type->num_levels > width)
1787 width = type->num_levels;
1788 sizeSyms += darray_size(keyi->syms[i]);
1791 darray_resize0(key->syms, sizeSyms);
1794 outActs = ResizeKeyActions(keymap, key, width * nGroups);
1795 if (outActs == NULL) {
1796 log_wsgo(info->keymap->ctx,
1797 "Could not enlarge actions for %s (key %d)\n",
1798 LongKeyNameText(keyi->name), kc);
1801 key->explicit |= XkbExplicitInterpretMask;
1806 key->num_groups = nGroups;
1807 if (keyi->defined & KEY_FIELD_GROUPINFO) {
1808 key->out_of_range_group_number = keyi->out_of_range_group_number;
1809 key->out_of_range_group_action = keyi->out_of_range_group_action;
1812 key->sym_index = calloc(nGroups * width, sizeof(*key->sym_index));
1813 key->num_syms = calloc(nGroups * width, sizeof(*key->num_syms));
1815 for (i = 0; i < nGroups; i++) {
1816 /* assign kt_index[i] to the index of the type in map->types.
1817 * kt_index[i] may have been set by a previous run (if we have two
1818 * layouts specified). Let's not overwrite it with the ONE_LEVEL
1819 * default group if we dont even have keys for this group anyway.
1821 * FIXME: There should be a better fix for this.
1823 if (keyi->numLevels[i])
1824 key->kt_index[i] = types[i];
1825 if (!darray_empty(keyi->syms[i])) {
1826 /* fill key to "width" symbols*/
1827 for (tmp = 0; tmp < width; tmp++) {
1828 if (tmp < keyi->numLevels[i] &&
1829 darray_item(keyi->symsMapNumEntries[i], tmp) != 0) {
1830 memcpy(darray_mem(key->syms, symIndex),
1831 darray_mem(keyi->syms[i],
1832 darray_item(keyi->symsMapIndex[i], tmp)),
1833 darray_item(keyi->symsMapNumEntries[i],
1834 tmp) * sizeof(xkb_keysym_t));
1835 key->sym_index[(i * width) + tmp] = symIndex;
1836 key->num_syms[(i * width) + tmp] =
1837 darray_item(keyi->symsMapNumEntries[i], tmp);
1838 symIndex += key->num_syms[(i * width) + tmp];
1841 key->sym_index[(i * width) + tmp] = -1;
1842 key->num_syms[(i * width) + tmp] = 0;
1844 if (outActs != NULL && !darray_empty(keyi->acts[i])) {
1845 if (tmp < keyi->numLevels[i])
1846 outActs[tmp] = darray_item(keyi->acts[i], tmp);
1848 outActs[tmp].type = XkbSA_NoAction;
1853 switch (keyi->behavior.type & XkbKB_OpMask) {
1858 key->behavior = keyi->behavior;
1859 key->explicit |= XkbExplicitBehaviorMask;
1862 if (keyi->defined & KEY_FIELD_VMODMAP) {
1863 key->vmodmap = keyi->vmodmap;
1864 key->explicit |= XkbExplicitVModMapMask;
1866 if (keyi->repeat != KEY_REPEAT_UNDEFINED) {
1867 key->repeats = (keyi->repeat == KEY_REPEAT_YES);
1868 key->explicit |= XkbExplicitAutoRepeatMask;
1871 /* do the same thing for the next key */
1872 CopySymbolsDef(info, keyi, kc + 1);
1877 CopyModMapDef(SymbolsInfo *info, ModMapEntry *entry)
1879 struct xkb_key *key;
1880 struct xkb_keymap *keymap = info->keymap;
1882 if (!entry->haveSymbol) {
1883 key = FindNamedKey(keymap, entry->u.keyName, true,
1884 CreateKeyNames(keymap), 0);
1886 log_lvl(info->keymap->ctx, 5,
1887 "Key %s not found in keycodes; "
1888 "Modifier map entry for %s not updated\n",
1889 LongKeyNameText(entry->u.keyName),
1890 ModIndexText(entry->modifier));
1895 key = FindKeyForSymbol(keymap, entry->u.keySym);
1897 log_lvl(info->keymap->ctx, 5,
1898 "Key \"%s\" not found in symbol map; "
1899 "Modifier map entry for %s not updated\n",
1900 KeysymText(entry->u.keySym),
1901 ModIndexText(entry->modifier));
1906 key->modmap |= (1 << entry->modifier);
1911 * Handle the xkb_symbols section of an xkb file.
1913 * @param file The parsed xkb_symbols section of the xkb file.
1914 * @param keymap Handle to the keyboard description to store the symbols in.
1915 * @param merge Merge strategy (e.g. MERGE_OVERRIDE).
1918 CompileSymbols(XkbFile *file, struct xkb_keymap *keymap,
1919 enum merge_mode merge)
1921 xkb_group_index_t i;
1922 struct xkb_key *key;
1927 InitSymbolsInfo(&info, keymap, file->id);
1928 info.dflt.merge = merge;
1930 HandleSymbolsFile(&info, file, merge);
1932 if (darray_empty(info.keys))
1935 if (info.errorCount != 0)
1938 darray_resize0(keymap->acts, darray_size(keymap->acts) + 32 + 1);
1941 keymap->symbols_section_name = strdup(info.name);
1943 for (i = 0; i < XkbNumKbdGroups; i++) {
1944 if (info.groupNames[i] != XKB_ATOM_NONE) {
1945 keymap->group_names[i] = xkb_atom_text(keymap->ctx,
1946 info.groupNames[i]);
1951 darray_foreach(keyi, info.keys)
1952 PrepareKeyDef(keyi);
1955 darray_foreach(keyi, info.keys)
1956 if (!CopySymbolsDef(&info, keyi, 0))
1959 if (xkb_get_log_verbosity(keymap->ctx) > 3) {
1960 xkb_foreach_key(key, keymap) {
1961 if (key->name[0] == '\0')
1964 if (key->num_groups < 1)
1965 log_warn(info.keymap->ctx,
1966 "No symbols defined for %s (keycode %d)\n",
1967 KeyNameText(key->name),
1968 XkbKeyGetKeycode(keymap, key));
1972 list_foreach(mm, &info.modMaps, entry)
1973 if (!CopyModMapDef(&info, mm))
1976 FreeSymbolsInfo(&info);
1980 FreeSymbolsInfo(&info);