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 ********************************************************/
29 #include "xkbcomp-priv.h"
30 #include "parseutils.h"
34 /***====================================================================***/
36 /* Needed to work with the typechecker. */
37 typedef darray(xkb_keysym_t) darray_xkb_keysym_t;
38 typedef darray(union xkb_action) darray_xkb_action;
42 #define RepeatUndefined ~((unsigned) 0)
44 #define _Key_Syms (1 << 0)
45 #define _Key_Acts (1 << 1)
46 #define _Key_Repeat (1 << 2)
47 #define _Key_Behavior (1 << 3)
48 #define _Key_Type_Dflt (1 << 4)
49 #define _Key_Types (1 << 5)
50 #define _Key_GroupInfo (1 << 6)
51 #define _Key_VModMap (1 << 7)
53 static inline const char *
54 longText(unsigned long val)
58 LongToKeyName(val, buf);
59 return XkbcKeyNameText(buf);
62 typedef struct _KeyInfo {
63 unsigned short defined;
65 enum merge_mode merge;
67 unsigned long name; /* the 4 chars of the key name, as long */
68 unsigned char typesDefined;
69 unsigned char symsDefined;
70 unsigned char actsDefined;
71 unsigned int numLevels[XkbNumKbdGroups];
73 /* syms[group] -> Single array for all the keysyms in the group. */
74 darray_xkb_keysym_t syms[XkbNumKbdGroups];
76 * symsMapIndex[group][level] -> The index from which the syms for
77 * the level begin in the syms[group] array. Remember each keycode
78 * can have multiple keysyms in each level (that is, each key press
79 * can result in multiple keysyms).
81 darray(int) symsMapIndex[XkbNumKbdGroups];
83 * symsMapNumEntries[group][level] -> How many syms are in
84 * syms[group][symsMapIndex[group][level]].
86 darray(size_t) symsMapNumEntries[XkbNumKbdGroups];
88 darray_xkb_action acts[XkbNumKbdGroups];
90 xkb_atom_t types[XkbNumKbdGroups];
92 struct xkb_behavior behavior;
93 unsigned short vmodmap;
96 uint8_t out_of_range_group_action;
97 xkb_group_index_t out_of_range_group_number;
101 * Init the given key info to sane values.
104 InitKeyInfo(KeyInfo *keyi, unsigned file_id)
107 static const char dflt[4] = "*";
110 keyi->file_id = file_id;
111 keyi->merge = MERGE_OVERRIDE;
112 keyi->name = KeyNameToLong(dflt);
113 keyi->typesDefined = keyi->symsDefined = keyi->actsDefined = 0;
115 for (i = 0; i < XkbNumKbdGroups; i++) {
116 keyi->numLevels[i] = 0;
117 keyi->types[i] = XKB_ATOM_NONE;
118 darray_init(keyi->syms[i]);
119 darray_init(keyi->symsMapIndex[i]);
120 darray_init(keyi->symsMapNumEntries[i]);
121 darray_init(keyi->acts[i]);
124 keyi->dfltType = XKB_ATOM_NONE;
125 keyi->behavior.type = XkbKB_Default;
126 keyi->behavior.data = 0;
128 keyi->repeat = RepeatUndefined;
129 keyi->out_of_range_group_action = 0;
130 keyi->out_of_range_group_number = 0;
134 FreeKeyInfo(KeyInfo *keyi)
138 for (i = 0; i < XkbNumKbdGroups; i++) {
139 darray_free(keyi->syms[i]);
140 darray_free(keyi->symsMapIndex[i]);
141 darray_free(keyi->symsMapNumEntries[i]);
142 darray_free(keyi->acts[i]);
147 * Copy old into new, optionally reset old to 0.
148 * If old is reset, new simply re-uses old's memory. Otherwise, the memory is
149 * newly allocated and new points to the new memory areas.
152 CopyKeyInfo(KeyInfo * old, KeyInfo * new, bool clearOld)
159 for (i = 0; i < XkbNumKbdGroups; i++) {
160 old->numLevels[i] = 0;
161 darray_init(old->symsMapIndex[i]);
162 darray_init(old->symsMapNumEntries[i]);
163 darray_init(old->syms[i]);
164 darray_init(old->acts[i]);
168 for (i = 0; i < XkbNumKbdGroups; i++) {
169 darray_copy(new->syms[i], old->syms[i]);
170 darray_copy(new->symsMapIndex[i], old->symsMapIndex[i]);
171 darray_copy(new->symsMapNumEntries[i], old->symsMapNumEntries[i]);
172 darray_copy(new->acts[i], old->acts[i]);
179 /***====================================================================***/
181 typedef struct _ModMapEntry {
183 enum merge_mode merge;
187 unsigned long keyName;
192 typedef struct _SymbolsInfo {
193 char *name; /* e.g. pc+us+inet(evdev) */
196 enum merge_mode merge;
197 xkb_group_index_t explicit_group;
198 darray(KeyInfo) keys;
202 xkb_atom_t groupNames[XkbNumKbdGroups];
208 InitSymbolsInfo(SymbolsInfo * info, struct xkb_keymap *keymap,
214 info->explicit_group = 0;
215 info->errorCount = 0;
216 info->file_id = file_id;
217 info->merge = MERGE_OVERRIDE;
218 darray_init(info->keys);
219 darray_growalloc(info->keys, 110);
220 list_init(&info->modMaps);
221 for (i = 0; i < XkbNumKbdGroups; i++)
222 info->groupNames[i] = XKB_ATOM_NONE;
223 InitKeyInfo(&info->dflt, file_id);
224 InitVModInfo(&info->vmods, keymap);
229 FreeSymbolsInfo(SymbolsInfo * info)
232 ModMapEntry *mm, *next;
235 darray_foreach(keyi, info->keys) {
238 darray_free(info->keys);
239 list_foreach_safe(mm, next, &info->modMaps, entry)
241 memset(info, 0, sizeof(SymbolsInfo));
245 ResizeKeyGroup(KeyInfo *keyi, xkb_group_index_t group, unsigned int numLevels,
246 unsigned sizeSyms, bool forceActions)
250 if (darray_size(keyi->syms[group]) < sizeSyms)
251 darray_resize0(keyi->syms[group], sizeSyms);
253 if (darray_empty(keyi->symsMapIndex[group]) ||
254 keyi->numLevels[group] < numLevels) {
255 darray_resize(keyi->symsMapIndex[group], numLevels);
256 for (i = keyi->numLevels[group]; i < numLevels; i++)
257 darray_item(keyi->symsMapIndex[group], i) = -1;
260 if (darray_empty(keyi->symsMapNumEntries[group]) ||
261 keyi->numLevels[group] < numLevels)
262 darray_resize0(keyi->symsMapNumEntries[group], numLevels);
264 if ((forceActions && (keyi->numLevels[group] < numLevels ||
265 darray_empty(keyi->acts[group]))) ||
266 (keyi->numLevels[group] < numLevels && !darray_empty(keyi->acts[group])))
267 darray_resize0(keyi->acts[group], numLevels);
269 if (keyi->numLevels[group] < numLevels)
270 keyi->numLevels[group] = numLevels;
275 enum key_group_selector {
282 MergeKeyGroups(SymbolsInfo * info,
283 KeyInfo * into, KeyInfo * from, xkb_group_index_t group)
285 darray_xkb_keysym_t resultSyms;
286 enum key_group_selector using = NONE;
287 darray_xkb_action resultActs;
288 unsigned int resultWidth;
289 unsigned int resultSize = 0;
292 bool report, clobber;
294 clobber = (from->merge != MERGE_AUGMENT);
296 report = (warningLevel > 9) ||
297 (into->file_id == from->file_id && warningLevel > 0);
299 darray_init(resultSyms);
301 if (into->numLevels[group] >= from->numLevels[group]) {
302 resultActs = into->acts[group];
303 resultWidth = into->numLevels[group];
306 resultActs = from->acts[group];
307 resultWidth = from->numLevels[group];
308 darray_resize(into->symsMapIndex[group],
309 from->numLevels[group]);
310 darray_resize0(into->symsMapNumEntries[group],
311 from->numLevels[group]);
313 for (i = into->numLevels[group]; i < from->numLevels[group]; i++)
314 darray_item(into->symsMapIndex[group], i) = -1;
317 if (darray_empty(resultActs) && (!darray_empty(into->acts[group]) ||
318 !darray_empty(from->acts[group]))) {
319 darray_resize0(resultActs, resultWidth);
320 for (i = 0; i < resultWidth; i++) {
321 union xkb_action *fromAct = NULL, *toAct = NULL;
323 if (!darray_empty(from->acts[group]))
324 fromAct = &darray_item(from->acts[group], i);
326 if (!darray_empty(into->acts[group]))
327 toAct = &darray_item(into->acts[group], i);
329 if (((fromAct == NULL) || (fromAct->type == XkbSA_NoAction))
330 && (toAct != NULL)) {
331 darray_item(resultActs, i) = *toAct;
333 else if (((toAct == NULL) || (toAct->type == XkbSA_NoAction))
334 && (fromAct != NULL)) {
335 darray_item(resultActs, i) = *fromAct;
338 union xkb_action *use, *ignore;
349 ("Multiple actions for level %d/group %u on key %s\n",
350 i + 1, group + 1, longText(into->name));
351 ACTION("Using %s, ignoring %s\n",
352 XkbcActionTypeText(use->type),
353 XkbcActionTypeText(ignore->type));
356 darray_item(resultActs, i) = *use;
361 for (i = 0; i < resultWidth; i++) {
362 unsigned int fromSize = 0;
365 if (!darray_empty(from->symsMapNumEntries[group]) &&
366 i < from->numLevels[group])
367 fromSize = darray_item(from->symsMapNumEntries[group], i);
369 if (!darray_empty(into->symsMapNumEntries[group]) &&
370 i < into->numLevels[group])
371 toSize = darray_item(into->symsMapNumEntries[group], i);
374 resultSize += toSize;
377 else if (toSize == 0 || clobber) {
378 resultSize += fromSize;
382 resultSize += toSize;
391 resultSyms = from->syms[group];
392 darray_free(into->symsMapNumEntries[group]);
393 darray_free(into->symsMapIndex[group]);
394 into->symsMapNumEntries[group] = from->symsMapNumEntries[group];
395 into->symsMapIndex[group] = from->symsMapIndex[group];
396 darray_init(from->symsMapNumEntries[group]);
397 darray_init(from->symsMapIndex[group]);
400 else if (using == TO) {
401 resultSyms = into->syms[group];
405 darray_resize0(resultSyms, resultSize);
407 for (i = 0; i < resultWidth; i++) {
408 enum key_group_selector use = NONE;
409 unsigned int fromSize = 0;
410 unsigned int toSize = 0;
412 if (i < from->numLevels[group])
413 fromSize = darray_item(from->symsMapNumEntries[group], i);
415 if (i < into->numLevels[group])
416 toSize = darray_item(into->symsMapNumEntries[group], i);
418 if (fromSize == 0 && toSize == 0) {
419 darray_item(into->symsMapIndex[group], i) = -1;
420 darray_item(into->symsMapNumEntries[group], i) = 0;
426 else if (toSize == 0 || clobber)
431 if (toSize && fromSize && report) {
432 INFO("Multiple symbols for group %u, level %d on key %s\n",
433 group + 1, i + 1, longText(into->name));
434 ACTION("Using %s, ignoring %s\n",
435 (use == FROM ? "from" : "to"),
436 (use == FROM ? "to" : "from"));
440 memcpy(darray_mem(resultSyms, cur_idx),
441 darray_mem(from->syms[group],
442 darray_item(from->symsMapIndex[group], i)),
443 darray_item(from->symsMapNumEntries[group],
444 i) * sizeof(xkb_keysym_t));
445 darray_item(into->symsMapIndex[group], i) = cur_idx;
446 darray_item(into->symsMapNumEntries[group], i) =
447 darray_item(from->symsMapNumEntries[group], i);
450 memcpy(darray_mem(resultSyms, cur_idx),
451 darray_mem(into->syms[group],
452 darray_item(into->symsMapIndex[group], i)),
453 darray_item(into->symsMapNumEntries[group],
454 i) * sizeof(xkb_keysym_t));
455 darray_item(into->symsMapIndex[group], i) = cur_idx;
457 cur_idx += darray_item(into->symsMapNumEntries[group], i);
461 if (!darray_same(resultActs, into->acts[group]))
462 darray_free(into->acts[group]);
463 if (!darray_same(resultActs, from->acts[group]))
464 darray_free(from->acts[group]);
465 into->numLevels[group] = resultWidth;
466 if (!darray_same(resultSyms, into->syms[group]))
467 darray_free(into->syms[group]);
468 into->syms[group] = resultSyms;
469 if (!darray_same(resultSyms, from->syms[group]))
470 darray_free(from->syms[group]);
471 darray_init(from->syms[group]);
472 darray_free(from->symsMapIndex[group]);
473 darray_free(from->symsMapNumEntries[group]);
474 into->acts[group] = resultActs;
475 darray_init(from->acts[group]);
476 if (!darray_empty(into->syms[group]))
477 into->symsDefined |= (1 << group);
478 from->symsDefined &= ~(1 << group);
479 into->actsDefined |= (1 << group);
480 from->actsDefined &= ~(1 << group);
486 MergeKeys(SymbolsInfo *info, struct xkb_keymap *keymap,
487 KeyInfo *into, KeyInfo *from)
490 unsigned collide = 0;
493 if (from->merge == MERGE_REPLACE) {
494 for (i = 0; i < XkbNumKbdGroups; i++) {
495 if (into->numLevels[i] != 0) {
496 darray_free(into->syms[i]);
497 darray_free(into->acts[i]);
501 memset(from, 0, sizeof(KeyInfo));
504 report = ((warningLevel > 9) ||
505 ((into->file_id == from->file_id)
506 && (warningLevel > 0)));
507 for (i = 0; i < XkbNumKbdGroups; i++) {
508 if (from->numLevels[i] > 0) {
509 if (into->numLevels[i] == 0) {
510 into->numLevels[i] = from->numLevels[i];
511 into->syms[i] = from->syms[i];
512 into->symsMapIndex[i] = from->symsMapIndex[i];
513 into->symsMapNumEntries[i] = from->symsMapNumEntries[i];
514 into->acts[i] = from->acts[i];
515 into->symsDefined |= (1 << i);
516 darray_init(from->syms[i]);
517 darray_init(from->symsMapIndex[i]);
518 darray_init(from->symsMapNumEntries[i]);
519 darray_init(from->acts[i]);
520 from->numLevels[i] = 0;
521 from->symsDefined &= ~(1 << i);
522 if (!darray_empty(into->syms[i]))
523 into->defined |= _Key_Syms;
524 if (!darray_empty(into->acts[i]))
525 into->defined |= _Key_Acts;
529 if (!darray_empty(into->syms[i]))
530 collide |= _Key_Syms;
531 if (!darray_empty(into->acts[i]))
532 collide |= _Key_Acts;
534 MergeKeyGroups(info, into, from, (unsigned) i);
537 if (from->types[i] != XKB_ATOM_NONE) {
538 if ((into->types[i] != XKB_ATOM_NONE) && report &&
539 (into->types[i] != from->types[i])) {
540 xkb_atom_t use, ignore;
541 collide |= _Key_Types;
542 if (from->merge != MERGE_AUGMENT) {
543 use = from->types[i];
544 ignore = into->types[i];
547 use = into->types[i];
548 ignore = from->types[i];
551 ("Multiple definitions for group %d type of key %s\n",
552 i, longText(into->name));
553 ACTION("Using %s, ignoring %s\n",
554 xkb_atom_text(keymap->ctx, use),
555 xkb_atom_text(keymap->ctx, ignore));
557 if (from->merge != MERGE_AUGMENT ||
558 into->types[i] == XKB_ATOM_NONE) {
559 into->types[i] = from->types[i];
563 if (use_new_field(_Key_Behavior, into->defined, into->file_id,
564 from->defined, from->file_id, from->merge, &collide)) {
565 into->behavior = from->behavior;
566 into->defined |= _Key_Behavior;
568 if (use_new_field(_Key_VModMap, into->defined, into->file_id,
569 from->defined, from->file_id, from->merge, &collide)) {
570 into->vmodmap = from->vmodmap;
571 into->defined |= _Key_VModMap;
573 if (use_new_field(_Key_Repeat, into->defined, into->file_id,
574 from->defined, from->file_id, from->merge, &collide)) {
575 into->repeat = from->repeat;
576 into->defined |= _Key_Repeat;
578 if (use_new_field(_Key_Type_Dflt, into->defined, into->file_id,
579 from->defined, from->file_id, from->merge, &collide)) {
580 into->dfltType = from->dfltType;
581 into->defined |= _Key_Type_Dflt;
583 if (use_new_field(_Key_GroupInfo, into->defined, into->file_id,
584 from->defined, from->file_id, from->merge, &collide)) {
585 into->out_of_range_group_action = from->out_of_range_group_action;
586 into->out_of_range_group_number = from->out_of_range_group_number;
587 into->defined |= _Key_GroupInfo;
590 WARN("Symbol map for key %s redefined\n",
591 longText(into->name));
592 ACTION("Using %s definition for conflicting fields\n",
593 (from->merge == MERGE_AUGMENT ? "first" : "last"));
599 AddKeySymbols(SymbolsInfo *info, KeyInfo *keyi, struct xkb_keymap *keymap)
601 unsigned long real_name;
604 darray_foreach(iter, info->keys)
605 if (iter->name == keyi->name)
606 return MergeKeys(info, keymap, iter, keyi);
608 if (FindKeyNameForAlias(keymap, keyi->name, &real_name))
609 darray_foreach(iter, info->keys)
610 if (iter->name == real_name)
611 return MergeKeys(info, keymap, iter, keyi);
613 darray_resize0(info->keys, darray_size(info->keys) + 1);
614 new = &darray_item(info->keys, darray_size(info->keys) - 1);
615 return CopyKeyInfo(keyi, new, true);
619 AddModMapEntry(SymbolsInfo * info, ModMapEntry * new)
624 clobber = (new->merge != MERGE_AUGMENT);
625 list_foreach(mm, &info->modMaps, entry) {
626 if (new->haveSymbol && mm->haveSymbol
627 && (new->u.keySym == mm->u.keySym)) {
628 unsigned use, ignore;
629 if (mm->modifier != new->modifier) {
632 ignore = mm->modifier;
636 ignore = new->modifier;
639 ("%s added to symbol map for multiple modifiers\n",
640 XkbcKeysymText(new->u.keySym));
641 ACTION("Using %s, ignoring %s.\n",
642 XkbcModIndexText(use),
643 XkbcModIndexText(ignore));
648 if ((!new->haveSymbol) && (!mm->haveSymbol) &&
649 (new->u.keyName == mm->u.keyName)) {
650 unsigned use, ignore;
651 if (mm->modifier != new->modifier) {
654 ignore = mm->modifier;
658 ignore = new->modifier;
660 ERROR("Key %s added to map for multiple modifiers\n",
661 longText(new->u.keyName));
662 ACTION("Using %s, ignoring %s.\n",
663 XkbcModIndexText(use),
664 XkbcModIndexText(ignore));
671 mm = malloc(sizeof(*mm));
673 WSGO("Could not allocate modifier map entry\n");
674 ACTION("Modifier map for %s will be incomplete\n",
675 XkbcModIndexText(new->modifier));
680 list_add(&mm->entry, &info->modMaps);
684 /***====================================================================***/
687 MergeIncludedSymbols(SymbolsInfo *into, SymbolsInfo *from,
688 enum merge_mode merge, struct xkb_keymap *keymap)
692 ModMapEntry *mm, *next;
694 if (from->errorCount > 0) {
695 into->errorCount += from->errorCount;
698 if (into->name == NULL) {
699 into->name = from->name;
702 for (i = 0; i < XkbNumKbdGroups; i++) {
703 if (from->groupNames[i] != XKB_ATOM_NONE) {
704 if ((merge != MERGE_AUGMENT) ||
705 (into->groupNames[i] == XKB_ATOM_NONE))
706 into->groupNames[i] = from->groupNames[i];
710 darray_foreach(keyi, from->keys) {
711 if (merge != MERGE_DEFAULT)
714 if (!AddKeySymbols(into, keyi, keymap))
718 list_foreach_safe(mm, next, &from->modMaps, entry) {
719 if (merge != MERGE_DEFAULT)
721 if (!AddModMapEntry(into, mm))
725 list_init(&from->modMaps);
729 HandleSymbolsFile(XkbFile *file, struct xkb_keymap *keymap,
730 enum merge_mode merge,
734 HandleIncludeSymbols(IncludeStmt *stmt, struct xkb_keymap *keymap,
737 enum merge_mode newMerge;
739 SymbolsInfo included;
741 if (!ProcessIncludeFile(keymap->ctx, stmt, FILE_TYPE_SYMBOLS, &rtrn,
743 info->errorCount += 10;
747 InitSymbolsInfo(&included, keymap, rtrn->id);
748 included.merge = included.dflt.merge = MERGE_OVERRIDE;
750 included.explicit_group = atoi(stmt->modifier) - 1;
752 included.explicit_group = info->explicit_group;
753 HandleSymbolsFile(rtrn, keymap, MERGE_OVERRIDE, &included);
756 included.name = stmt->stmt;
761 if (stmt->next && included.errorCount < 1) {
764 SymbolsInfo next_incl;
766 for (next = stmt->next; next; next = next->next) {
767 if (!ProcessIncludeFile(keymap->ctx, next, FILE_TYPE_SYMBOLS,
769 info->errorCount += 10;
770 FreeSymbolsInfo(&included);
774 InitSymbolsInfo(&next_incl, keymap, rtrn->id);
775 next_incl.merge = next_incl.dflt.merge = MERGE_OVERRIDE;
777 next_incl.explicit_group = atoi(next->modifier) - 1;
779 next_incl.explicit_group = info->explicit_group;
780 HandleSymbolsFile(rtrn, keymap, MERGE_OVERRIDE, &next_incl);
781 MergeIncludedSymbols(&included, &next_incl, op, keymap);
782 FreeSymbolsInfo(&next_incl);
786 else if (stmt->next) {
787 info->errorCount += included.errorCount;
790 MergeIncludedSymbols(info, &included, newMerge, keymap);
791 FreeSymbolsInfo(&included);
793 return (info->errorCount == 0);
800 GetGroupIndex(KeyInfo *keyi, struct xkb_keymap *keymap,
801 ExprDef *arrayNdx, unsigned what, xkb_group_index_t *ndx_rtrn)
811 if (arrayNdx == NULL) {
815 defined = keyi->symsDefined;
817 defined = keyi->actsDefined;
819 for (i = 0; i < XkbNumKbdGroups; i++) {
820 if ((defined & (1 << i)) == 0) {
825 ERROR("Too many groups of %s for key %s (max %u)\n", name,
826 longText(keyi->name), XkbNumKbdGroups + 1);
827 ACTION("Ignoring %s defined for extra groups\n", name);
830 if (!ExprResolveGroup(keymap->ctx, arrayNdx, &tmp)) {
831 ERROR("Illegal group index for %s of key %s\n", name,
832 longText(keyi->name));
833 ACTION("Definition with non-integer array index ignored\n");
836 *ndx_rtrn = tmp.uval - 1;
841 AddSymbolsToKey(KeyInfo *keyi, struct xkb_keymap *keymap,
842 ExprDef *arrayNdx, ExprDef *value, SymbolsInfo *info)
844 xkb_group_index_t ndx;
845 size_t nSyms, nLevels;
848 if (!GetGroupIndex(keyi, keymap, arrayNdx, SYMBOLS, &ndx))
851 keyi->symsDefined |= (1 << ndx);
854 if (value->op != ExprKeysymList) {
855 ERROR("Expected a list of symbols, found %s\n", exprOpText(value->op));
856 ACTION("Ignoring symbols for group %u of %s\n", ndx + 1,
857 longText(keyi->name));
860 if (!darray_empty(keyi->syms[ndx])) {
861 ERROR("Symbols for key %s, group %u already defined\n",
862 longText(keyi->name), ndx + 1);
863 ACTION("Ignoring duplicate definition\n");
866 nSyms = darray_size(value->value.list.syms);
867 nLevels = darray_size(value->value.list.symsMapIndex);
868 if ((keyi->numLevels[ndx] < nSyms || darray_empty(keyi->syms[ndx])) &&
869 (!ResizeKeyGroup(keyi, ndx, nLevels, nSyms, false))) {
870 WSGO("Could not resize group %u of key %s to contain %zu levels\n",
871 ndx + 1, longText(keyi->name), nSyms);
872 ACTION("Symbols lost\n");
875 keyi->symsDefined |= (1 << ndx);
876 for (i = 0; i < nLevels; i++) {
877 darray_item(keyi->symsMapIndex[ndx], i) =
878 darray_item(value->value.list.symsMapIndex, i);
879 darray_item(keyi->symsMapNumEntries[ndx], i) =
880 darray_item(value->value.list.symsNumEntries, i);
882 for (j = 0; j < darray_item(keyi->symsMapNumEntries[ndx], i); j++) {
883 /* FIXME: What's abort() doing here? */
884 if (darray_item(keyi->symsMapIndex[ndx], i) + j >= nSyms)
886 if (!LookupKeysym(darray_item(value->value.list.syms,
887 darray_item(value->value.list.symsMapIndex,
889 &darray_item(keyi->syms[ndx],
890 darray_item(keyi->symsMapIndex[ndx],
893 "Could not resolve keysym %s for key %s, group %u (%s), level %zu\n",
894 darray_item(value->value.list.syms, i),
895 longText(keyi->name),
897 xkb_atom_text(keymap->ctx, info->groupNames[ndx]), nSyms);
899 darray_item(keyi->syms[ndx],
900 darray_item(keyi->symsMapIndex[ndx],
901 i) + j) = XKB_KEY_NoSymbol;
902 darray_item(keyi->symsMapIndex[ndx], i) = -1;
903 darray_item(keyi->symsMapNumEntries[ndx], i) = 0;
906 if (darray_item(keyi->symsMapNumEntries[ndx], i) == 1 &&
907 darray_item(keyi->syms[ndx],
908 darray_item(keyi->symsMapIndex[ndx],
909 i) + j) == XKB_KEY_NoSymbol) {
910 darray_item(keyi->symsMapIndex[ndx], i) = -1;
911 darray_item(keyi->symsMapNumEntries[ndx], i) = 0;
915 for (j = keyi->numLevels[ndx] - 1;
916 j >= 0 && darray_item(keyi->symsMapNumEntries[ndx], j) == 0; j--)
917 keyi->numLevels[ndx]--;
922 AddActionsToKey(KeyInfo *keyi, struct xkb_keymap *keymap, ExprDef *arrayNdx,
923 ExprDef *value, SymbolsInfo *info)
926 xkb_group_index_t ndx;
929 struct xkb_any_action *toAct;
931 if (!GetGroupIndex(keyi, keymap, arrayNdx, ACTIONS, &ndx))
935 keyi->actsDefined |= (1 << ndx);
938 if (value->op != ExprActionList) {
939 WSGO("Bad expression type (%d) for action list value\n", value->op);
940 ACTION("Ignoring actions for group %u of %s\n", ndx,
941 longText(keyi->name));
944 if (!darray_empty(keyi->acts[ndx])) {
945 WSGO("Actions for key %s, group %u already defined\n",
946 longText(keyi->name), ndx);
949 for (nActs = 0, act = value->value.child; act != NULL; nActs++) {
950 act = (ExprDef *) act->common.next;
953 WSGO("Action list but not actions in AddActionsToKey\n");
956 if ((keyi->numLevels[ndx] < nActs || darray_empty(keyi->acts[ndx])) &&
957 !ResizeKeyGroup(keyi, ndx, nActs, nActs, true)) {
958 WSGO("Could not resize group %u of key %s\n", ndx,
959 longText(keyi->name));
960 ACTION("Actions lost\n");
963 keyi->actsDefined |= (1 << ndx);
965 toAct = (struct xkb_any_action *) darray_mem(keyi->acts[ndx], 0);
966 act = value->value.child;
967 for (i = 0; i < nActs; i++, toAct++) {
968 if (!HandleActionDef(act, keymap, toAct, info->action)) {
969 ERROR("Illegal action definition for %s\n",
970 longText(keyi->name));
971 ACTION("Action for group %u/level %zu ignored\n", ndx + 1, i + 1);
973 act = (ExprDef *) act->common.next;
978 static const LookupEntry lockingEntries[] = {
979 { "true", XkbKB_Lock },
980 { "yes", XkbKB_Lock },
981 { "on", XkbKB_Lock },
982 { "false", XkbKB_Default },
983 { "no", XkbKB_Default },
984 { "off", XkbKB_Default },
985 { "permanent", XkbKB_Lock | XkbKB_Permanent },
989 static const LookupEntry repeatEntries[] = {
990 { "true", RepeatYes },
991 { "yes", RepeatYes },
993 { "false", RepeatNo },
996 { "default", RepeatUndefined },
1001 SetSymbolsField(KeyInfo *keyi, struct xkb_keymap *keymap, char *field,
1002 ExprDef *arrayNdx, ExprDef *value, SymbolsInfo *info)
1007 if (strcasecmp(field, "type") == 0) {
1009 if ((!ExprResolveString(keymap->ctx, value, &tmp))
1010 && (warningLevel > 0)) {
1011 WARN("The type field of a key symbol map must be a string\n");
1012 ACTION("Ignoring illegal type definition\n");
1014 if (arrayNdx == NULL) {
1015 keyi->dfltType = xkb_atom_intern(keymap->ctx, tmp.str);
1016 keyi->defined |= _Key_Type_Dflt;
1018 else if (!ExprResolveGroup(keymap->ctx, arrayNdx, &ndx)) {
1019 ERROR("Illegal group index for type of key %s\n",
1020 longText(keyi->name));
1021 ACTION("Definition with non-integer array index ignored\n");
1026 keyi->types[ndx.uval - 1] = xkb_atom_intern(keymap->ctx, tmp.str);
1027 keyi->typesDefined |= (1 << (ndx.uval - 1));
1031 else if (strcasecmp(field, "symbols") == 0)
1032 return AddSymbolsToKey(keyi, keymap, arrayNdx, value, info);
1033 else if (strcasecmp(field, "actions") == 0)
1034 return AddActionsToKey(keyi, keymap, arrayNdx, value, info);
1035 else if ((strcasecmp(field, "vmods") == 0) ||
1036 (strcasecmp(field, "virtualmods") == 0) ||
1037 (strcasecmp(field, "virtualmodifiers") == 0)) {
1038 ok = ExprResolveVModMask(value, &tmp, keymap);
1040 keyi->vmodmap = (tmp.uval >> 8);
1041 keyi->defined |= _Key_VModMap;
1044 ERROR("Expected a virtual modifier mask, found %s\n",
1045 exprOpText(value->op));
1046 ACTION("Ignoring virtual modifiers definition for key %s\n",
1047 longText(keyi->name));
1050 else if ((strcasecmp(field, "locking") == 0) ||
1051 (strcasecmp(field, "lock") == 0) ||
1052 (strcasecmp(field, "locks") == 0)) {
1053 ok = ExprResolveEnum(keymap->ctx, value, &tmp, lockingEntries);
1055 keyi->behavior.type = tmp.uval;
1056 keyi->defined |= _Key_Behavior;
1058 else if ((strcasecmp(field, "radiogroup") == 0) ||
1059 (strcasecmp(field, "permanentradiogroup") == 0) ||
1060 (strcasecmp(field, "allownone") == 0)) {
1061 ERROR("Radio groups not supported\n");
1062 ACTION("Ignoring radio group specification for key %s\n",
1063 longText(keyi->name));
1066 else if (uStrCasePrefix("overlay", field) ||
1067 uStrCasePrefix("permanentoverlay", field)) {
1068 ERROR("Overlays not supported\n");
1069 ACTION("Ignoring overlay specification for key %s\n",
1070 longText(keyi->name));
1072 else if ((strcasecmp(field, "repeating") == 0) ||
1073 (strcasecmp(field, "repeats") == 0) ||
1074 (strcasecmp(field, "repeat") == 0)) {
1075 ok = ExprResolveEnum(keymap->ctx, value, &tmp, repeatEntries);
1077 ERROR("Illegal repeat setting for %s\n",
1078 longText(keyi->name));
1079 ACTION("Non-boolean repeat setting ignored\n");
1082 keyi->repeat = tmp.uval;
1083 keyi->defined |= _Key_Repeat;
1085 else if ((strcasecmp(field, "groupswrap") == 0) ||
1086 (strcasecmp(field, "wrapgroups") == 0)) {
1087 ok = ExprResolveBoolean(keymap->ctx, value, &tmp);
1089 ERROR("Illegal groupsWrap setting for %s\n",
1090 longText(keyi->name));
1091 ACTION("Non-boolean value ignored\n");
1095 keyi->out_of_range_group_action = XkbWrapIntoRange;
1097 keyi->out_of_range_group_action = XkbClampIntoRange;
1098 keyi->defined |= _Key_GroupInfo;
1100 else if ((strcasecmp(field, "groupsclamp") == 0) ||
1101 (strcasecmp(field, "clampgroups") == 0)) {
1102 ok = ExprResolveBoolean(keymap->ctx, value, &tmp);
1104 ERROR("Illegal groupsClamp setting for %s\n",
1105 longText(keyi->name));
1106 ACTION("Non-boolean value ignored\n");
1110 keyi->out_of_range_group_action = XkbClampIntoRange;
1112 keyi->out_of_range_group_action = XkbWrapIntoRange;
1113 keyi->defined |= _Key_GroupInfo;
1115 else if ((strcasecmp(field, "groupsredirect") == 0) ||
1116 (strcasecmp(field, "redirectgroups") == 0)) {
1117 if (!ExprResolveGroup(keymap->ctx, value, &tmp)) {
1118 ERROR("Illegal group index for redirect of key %s\n",
1119 longText(keyi->name));
1120 ACTION("Definition with non-integer group ignored\n");
1123 keyi->out_of_range_group_action = XkbRedirectIntoRange;
1124 keyi->out_of_range_group_number = tmp.uval - 1;
1125 keyi->defined |= _Key_GroupInfo;
1128 ERROR("Unknown field %s in a symbol interpretation\n", field);
1129 ACTION("Definition ignored\n");
1136 SetGroupName(SymbolsInfo *info, struct xkb_keymap *keymap, ExprDef *arrayNdx,
1139 ExprResult tmp, name;
1141 if ((arrayNdx == NULL) && (warningLevel > 0)) {
1142 WARN("You must specify an index when specifying a group name\n");
1143 ACTION("Group name definition without array subscript ignored\n");
1146 if (!ExprResolveGroup(keymap->ctx, arrayNdx, &tmp)) {
1147 ERROR("Illegal index in group name definition\n");
1148 ACTION("Definition with non-integer array index ignored\n");
1151 if (!ExprResolveString(keymap->ctx, value, &name)) {
1152 ERROR("Group name must be a string\n");
1153 ACTION("Illegal name for group %d ignored\n", tmp.uval);
1156 info->groupNames[tmp.uval - 1 + info->explicit_group] =
1157 xkb_atom_intern(keymap->ctx, name.str);
1164 HandleSymbolsVar(VarDef *stmt, struct xkb_keymap *keymap, SymbolsInfo *info)
1166 ExprResult elem, field;
1170 if (ExprResolveLhs(keymap, stmt->name, &elem, &field, &arrayNdx) == 0)
1171 return 0; /* internal error, already reported */
1172 if (elem.str && (strcasecmp(elem.str, "key") == 0)) {
1173 ret = SetSymbolsField(&info->dflt, keymap, field.str, arrayNdx,
1176 else if ((elem.str == NULL) && ((strcasecmp(field.str, "name") == 0) ||
1177 (strcasecmp(field.str, "groupname") ==
1179 ret = SetGroupName(info, keymap, arrayNdx, stmt->value);
1181 else if ((elem.str == NULL)
1182 && ((strcasecmp(field.str, "groupswrap") == 0) ||
1183 (strcasecmp(field.str, "wrapgroups") == 0))) {
1184 ERROR("Global \"groupswrap\" not supported\n");
1185 ACTION("Ignored\n");
1188 else if ((elem.str == NULL)
1189 && ((strcasecmp(field.str, "groupsclamp") == 0) ||
1190 (strcasecmp(field.str, "clampgroups") == 0))) {
1191 ERROR("Global \"groupsclamp\" not supported\n");
1192 ACTION("Ignored\n");
1195 else if ((elem.str == NULL)
1196 && ((strcasecmp(field.str, "groupsredirect") == 0) ||
1197 (strcasecmp(field.str, "redirectgroups") == 0))) {
1198 ERROR("Global \"groupsredirect\" not supported\n");
1199 ACTION("Ignored\n");
1202 else if ((elem.str == NULL) &&
1203 (strcasecmp(field.str, "allownone") == 0)) {
1204 ERROR("Radio groups not supported\n");
1205 ACTION("Ignoring \"allownone\" specification\n");
1209 ret = SetActionField(keymap, elem.str, field.str, arrayNdx,
1210 stmt->value, &info->action);
1219 HandleSymbolsBody(VarDef *def, struct xkb_keymap *keymap, KeyInfo *keyi,
1223 ExprResult tmp, field;
1226 for (; def != NULL; def = (VarDef *) def->common.next) {
1227 if ((def->name) && (def->name->type == ExprFieldRef)) {
1228 ok = HandleSymbolsVar(def, keymap, info);
1232 if (def->name == NULL) {
1233 if ((def->value == NULL)
1234 || (def->value->op == ExprKeysymList))
1235 field.str = strdup("symbols");
1237 field.str = strdup("actions");
1241 ok = ExprResolveLhs(keymap, def->name, &tmp, &field,
1245 ok = SetSymbolsField(keyi, keymap, field.str, arrayNdx,
1254 SetExplicitGroup(SymbolsInfo *info, KeyInfo *keyi)
1256 xkb_group_index_t group = info->explicit_group;
1261 if ((keyi->typesDefined | keyi->symsDefined | keyi->actsDefined) & ~1) {
1262 xkb_group_index_t i;
1263 WARN("For the map %s an explicit group specified\n", info->name);
1264 WARN("but key %s has more than one group defined\n",
1265 longText(keyi->name));
1266 ACTION("All groups except first one will be ignored\n");
1267 for (i = 1; i < XkbNumKbdGroups; i++) {
1268 keyi->numLevels[i] = 0;
1269 darray_free(keyi->syms[i]);
1270 darray_free(keyi->acts[i]);
1274 keyi->typesDefined = keyi->symsDefined = keyi->actsDefined = 1 << group;
1276 keyi->numLevels[group] = keyi->numLevels[0];
1277 keyi->numLevels[0] = 0;
1278 keyi->syms[group] = keyi->syms[0];
1279 darray_init(keyi->syms[0]);
1280 keyi->symsMapIndex[group] = keyi->symsMapIndex[0];
1281 darray_init(keyi->symsMapIndex[0]);
1282 keyi->symsMapNumEntries[group] = keyi->symsMapNumEntries[0];
1283 darray_init(keyi->symsMapNumEntries[0]);
1284 keyi->acts[group] = keyi->acts[0];
1285 darray_init(keyi->acts[0]);
1286 keyi->types[group] = keyi->types[0];
1292 HandleSymbolsDef(SymbolsDef *stmt, struct xkb_keymap *keymap,
1297 InitKeyInfo(&keyi, info->file_id);
1298 CopyKeyInfo(&info->dflt, &keyi, false);
1299 keyi.merge = stmt->merge;
1300 keyi.name = KeyNameToLong(stmt->keyName);
1301 if (!HandleSymbolsBody((VarDef *) stmt->symbols, keymap, &keyi, info)) {
1306 if (!SetExplicitGroup(info, &keyi)) {
1311 if (!AddKeySymbols(info, &keyi, keymap)) {
1319 HandleModMapDef(ModMapDef *def, struct xkb_keymap *keymap, SymbolsInfo *info)
1326 if (!LookupModIndex(keymap->ctx, NULL, def->modifier, TypeInt, &rtrn)) {
1327 ERROR("Illegal modifier map definition\n");
1328 ACTION("Ignoring map for non-modifier \"%s\"\n",
1329 xkb_atom_text(keymap->ctx, def->modifier));
1333 tmp.modifier = rtrn.uval;
1334 for (key = def->keys; key != NULL; key = (ExprDef *) key->common.next) {
1335 if ((key->op == ExprValue) && (key->type == TypeKeyName)) {
1336 tmp.haveSymbol = false;
1337 tmp.u.keyName = KeyNameToLong(key->value.keyName);
1339 else if (ExprResolveKeySym(keymap->ctx, key, &rtrn)) {
1340 tmp.haveSymbol = true;
1341 tmp.u.keySym = rtrn.uval;
1344 ERROR("Modmap entries may contain only key names or keysyms\n");
1345 ACTION("Illegal definition for %s modifier ignored\n",
1346 XkbcModIndexText(tmp.modifier));
1350 ok = AddModMapEntry(info, &tmp) && ok;
1356 HandleSymbolsFile(XkbFile *file, struct xkb_keymap *keymap,
1357 enum merge_mode merge, SymbolsInfo *info)
1362 info->name = uDupString(file->name);
1366 switch (stmt->stmtType) {
1368 if (!HandleIncludeSymbols((IncludeStmt *) stmt, keymap, info))
1371 case StmtSymbolsDef:
1372 if (!HandleSymbolsDef((SymbolsDef *) stmt, keymap, info))
1376 if (!HandleSymbolsVar((VarDef *) stmt, keymap, info))
1380 if (!HandleVModDef((VModDef *) stmt, keymap, merge, &info->vmods))
1384 ERROR("Interpretation files may not include other types\n");
1385 ACTION("Ignoring definition of symbol interpretation\n");
1388 case StmtKeycodeDef:
1389 ERROR("Interpretation files may not include other types\n");
1390 ACTION("Ignoring definition of key name\n");
1394 if (!HandleModMapDef((ModMapDef *) stmt, keymap, info))
1398 WSGO("Unexpected statement type %d in HandleSymbolsFile\n",
1403 if (info->errorCount > 10) {
1405 ERROR("Too many errors\n");
1407 ACTION("Abandoning symbols file \"%s\"\n", file->topName);
1414 * Given a keysym @sym, return a key which generates it, or NULL.
1415 * This is used for example in a modifier map definition, such as:
1416 * modifier_map Lock { Caps_Lock };
1417 * where we want to add the Lock modifier to the modmap of the key
1418 * which matches the keysym Caps_Lock.
1419 * Since there can be many keys which generates the keysym, the key
1420 * is chosen first by lowest group in which the keysym appears, than
1421 * by lowest level and than by lowest key code.
1423 static struct xkb_key *
1424 FindKeyForSymbol(struct xkb_keymap *keymap, xkb_keysym_t sym)
1426 struct xkb_key *key, *ret = NULL;
1427 xkb_group_index_t group, min_group = UINT_MAX;
1428 unsigned int level, min_level = UINT_MAX;
1430 xkb_foreach_key(key, keymap) {
1431 for (group = 0; group < key->num_groups; group++) {
1432 for (level = 0; level < XkbKeyGroupWidth(keymap, key, group);
1434 if (XkbKeyNumSyms(key, group, level) != 1 ||
1435 (XkbKeySymEntry(key, group, level))[0] != sym)
1439 * If the keysym was found in a group or level > 0, we must
1440 * keep looking since we might find a key in which the keysym
1441 * is in a lower group or level.
1443 if (group < min_group ||
1444 (group == min_group && level < min_level)) {
1446 if (group == 0 && level == 0) {
1462 * Find the given name in the keymap->map->types and return its index.
1464 * @param atom The atom to search for.
1465 * @param type_rtrn Set to the index of the name if found.
1467 * @return true if found, false otherwise.
1470 FindNamedType(struct xkb_keymap *keymap, xkb_atom_t atom, unsigned *type_rtrn)
1473 const char *name = xkb_atom_text(keymap->ctx, atom);
1474 struct xkb_key_type *type;
1477 darray_foreach(type, keymap->types) {
1478 if (strcmp(type->name, name) == 0) {
1489 * Assign a type to the given sym and return the Atom for the type assigned.
1492 * - ONE_LEVEL for width 0/1
1493 * - ALPHABETIC for 2 shift levels, with lower/upercase
1494 * - KEYPAD for keypad keys.
1495 * - TWO_LEVEL for other 2 shift level keys.
1496 * and the same for four level keys.
1498 * @param width Number of sysms in syms.
1499 * @param syms The keysyms for the given key (must be size width).
1500 * @param typeNameRtrn Set to the Atom of the type name.
1502 * @returns true if a type could be found, false otherwise.
1504 * FIXME: I need to take the KeyInfo so I can look at symsMapIndex and
1505 * all that fun stuff rather than just assuming there's always one
1509 FindAutomaticType(struct xkb_keymap *keymap, int width,
1510 const xkb_keysym_t *syms, xkb_atom_t *typeNameRtrn,
1514 if ((width == 1) || (width == 0)) {
1515 *typeNameRtrn = xkb_atom_intern(keymap->ctx, "ONE_LEVEL");
1518 else if (width == 2) {
1519 if (syms && xkb_keysym_is_lower(syms[0]) &&
1520 xkb_keysym_is_upper(syms[1])) {
1521 *typeNameRtrn = xkb_atom_intern(keymap->ctx, "ALPHABETIC");
1523 else if (syms && (xkb_keysym_is_keypad(syms[0]) ||
1524 xkb_keysym_is_keypad(syms[1]))) {
1525 *typeNameRtrn = xkb_atom_intern(keymap->ctx, "KEYPAD");
1529 *typeNameRtrn = xkb_atom_intern(keymap->ctx, "TWO_LEVEL");
1533 else if (width <= 4) {
1534 if (syms && xkb_keysym_is_lower(syms[0]) &&
1535 xkb_keysym_is_upper(syms[1]))
1536 if (xkb_keysym_is_lower(syms[2]) && xkb_keysym_is_upper(syms[3]))
1538 xkb_atom_intern(keymap->ctx, "FOUR_LEVEL_ALPHABETIC");
1540 *typeNameRtrn = xkb_atom_intern(keymap->ctx,
1541 "FOUR_LEVEL_SEMIALPHABETIC");
1543 else if (syms && (xkb_keysym_is_keypad(syms[0]) ||
1544 xkb_keysym_is_keypad(syms[1])))
1545 *typeNameRtrn = xkb_atom_intern(keymap->ctx, "FOUR_LEVEL_KEYPAD");
1547 *typeNameRtrn = xkb_atom_intern(keymap->ctx, "FOUR_LEVEL");
1548 /* XXX: why not set autoType here? */
1550 return ((width >= 0) && (width <= 4));
1554 * Ensure the given KeyInfo is in a coherent state, i.e. no gaps between the
1555 * groups, and reduce to one group if all groups are identical anyway.
1558 PrepareKeyDef(KeyInfo *keyi)
1560 xkb_group_index_t i, lastGroup;
1561 int j, width, defined;
1564 defined = keyi->symsDefined | keyi->actsDefined | keyi->typesDefined;
1565 /* get highest group number */
1566 for (i = XkbNumKbdGroups - 1; i >= 0; i--) {
1567 if (defined & (1 << i))
1575 /* If there are empty groups between non-empty ones fill them with data */
1576 /* from the first group. */
1577 /* We can make a wrong assumption here. But leaving gaps is worse. */
1578 for (i = lastGroup; i > 0; i--) {
1579 if (defined & (1 << i))
1581 width = keyi->numLevels[0];
1582 if (keyi->typesDefined & 1) {
1583 for (j = 0; j < width; j++) {
1584 keyi->types[i] = keyi->types[0];
1586 keyi->typesDefined |= 1 << i;
1588 if ((keyi->actsDefined & 1) && !darray_empty(keyi->acts[0])) {
1589 darray_copy(keyi->acts[i], keyi->acts[0]);
1590 keyi->actsDefined |= 1 << i;
1592 if ((keyi->symsDefined & 1) && !darray_empty(keyi->syms[0])) {
1593 darray_copy(keyi->syms[i], keyi->syms[0]);
1594 darray_copy(keyi->symsMapIndex[i], keyi->symsMapIndex[0]);
1595 darray_copy(keyi->symsMapNumEntries[i],
1596 keyi->symsMapNumEntries[0]);
1597 keyi->symsDefined |= 1 << i;
1600 keyi->numLevels[i] = keyi->numLevels[0];
1603 /* If all groups are completely identical remove them all */
1604 /* exept the first one. */
1606 for (i = lastGroup; i > 0; i--) {
1607 if ((keyi->numLevels[i] != keyi->numLevels[0]) ||
1608 (keyi->types[i] != keyi->types[0])) {
1612 if (!darray_same(keyi->syms[i], keyi->syms[0]) &&
1613 (darray_empty(keyi->syms[i]) || darray_empty(keyi->syms[0]) ||
1614 darray_size(keyi->syms[i]) != darray_size(keyi->syms[0]) ||
1615 memcmp(darray_mem(keyi->syms[i], 0),
1616 darray_mem(keyi->syms[0], 0),
1617 sizeof(xkb_keysym_t) * darray_size(keyi->syms[0])))) {
1621 if (!darray_same(keyi->symsMapIndex[i], keyi->symsMapIndex[0]) &&
1622 (darray_empty(keyi->symsMapIndex[i]) ||
1623 darray_empty(keyi->symsMapIndex[0]) ||
1624 memcmp(darray_mem(keyi->symsMapIndex[i], 0),
1625 darray_mem(keyi->symsMapIndex[0], 0),
1626 keyi->numLevels[0] * sizeof(int)))) {
1630 if (!darray_same(keyi->symsMapNumEntries[i],
1631 keyi->symsMapNumEntries[0]) &&
1632 (darray_empty(keyi->symsMapNumEntries[i]) ||
1633 darray_empty(keyi->symsMapNumEntries[0]) ||
1634 memcmp(darray_mem(keyi->symsMapNumEntries[i], 0),
1635 darray_mem(keyi->symsMapNumEntries[0], 0),
1636 keyi->numLevels[0] * sizeof(size_t)))) {
1640 if (!darray_same(keyi->acts[i], keyi->acts[0]) &&
1641 (darray_empty(keyi->acts[i]) || darray_empty(keyi->acts[0]) ||
1642 memcmp(darray_mem(keyi->acts[i], 0),
1643 darray_mem(keyi->acts[0], 0),
1644 keyi->numLevels[0] * sizeof(union xkb_action)))) {
1650 for (i = lastGroup; i > 0; i--) {
1651 keyi->numLevels[i] = 0;
1652 darray_free(keyi->syms[i]);
1653 darray_free(keyi->symsMapIndex[i]);
1654 darray_free(keyi->symsMapNumEntries[i]);
1655 darray_free(keyi->acts[i]);
1658 keyi->symsDefined &= 1;
1659 keyi->actsDefined &= 1;
1660 keyi->typesDefined &= 1;
1665 * Copy the KeyInfo into the keyboard description.
1667 * This function recurses.
1670 CopySymbolsDef(struct xkb_keymap *keymap, KeyInfo *keyi,
1671 xkb_keycode_t start_from)
1674 struct xkb_key *key;
1675 size_t sizeSyms = 0;
1676 xkb_group_index_t i, nGroups;
1677 unsigned width, tmp;
1678 struct xkb_key_type * type;
1679 bool haveActions, autoType, useAlias;
1680 unsigned types[XkbNumKbdGroups];
1681 union xkb_action *outActs;
1682 unsigned int symIndex = 0;
1684 useAlias = (start_from == 0);
1686 key = FindNamedKey(keymap, keyi->name, useAlias,
1687 CreateKeyNames(keymap), start_from);
1689 if (start_from == 0 && warningLevel >= 5) {
1690 WARN("Key %s not found in keycodes\n", longText(keyi->name));
1691 ACTION("Symbols ignored\n");
1695 kc = XkbKeyGetKeycode(keymap, key);
1697 haveActions = false;
1699 for (i = nGroups = 0; i < XkbNumKbdGroups; i++) {
1700 if (((i + 1) > nGroups)
1701 && (((keyi->symsDefined | keyi->actsDefined) & (1 << i))
1702 || (keyi->typesDefined) & (1 << i)))
1704 if (!darray_empty(keyi->acts[i]))
1707 /* Assign the type to the key, if it is missing. */
1708 if (keyi->types[i] == XKB_ATOM_NONE) {
1709 if (keyi->dfltType != XKB_ATOM_NONE)
1710 keyi->types[i] = keyi->dfltType;
1711 else if (FindAutomaticType(keymap, keyi->numLevels[i],
1712 darray_mem(keyi->syms[i], 0),
1713 &keyi->types[i], &autoType)) { }
1715 if (warningLevel >= 5) {
1716 WARN("No automatic type for %d symbols\n",
1717 keyi->numLevels[i]);
1718 ACTION("Using %s for the %s key (keycode %d)\n",
1719 xkb_atom_text(keymap->ctx, keyi->types[i]),
1720 longText(keyi->name), kc);
1724 if (FindNamedType(keymap, keyi->types[i], &types[i])) {
1725 if (!autoType || keyi->numLevels[i] > 2)
1726 key->explicit |= (1 << i);
1729 if (warningLevel >= 3) {
1730 WARN("Type \"%s\" is not defined\n",
1731 xkb_atom_text(keymap->ctx, keyi->types[i]));
1732 ACTION("Using TWO_LEVEL for the %s key (keycode %d)\n",
1733 longText(keyi->name), kc);
1735 types[i] = XkbTwoLevelIndex;
1737 /* if the type specifies fewer levels than the key has, shrink the key */
1738 type = &darray_item(keymap->types, types[i]);
1739 if (type->num_levels < keyi->numLevels[i]) {
1740 if (warningLevel > 0) {
1741 WARN("Type \"%s\" has %d levels, but %s has %d symbols\n",
1742 type->name, type->num_levels,
1743 xkb_atom_text(keymap->ctx, keyi->name), keyi->numLevels[i]);
1744 ACTION("Ignoring extra symbols\n");
1746 keyi->numLevels[i] = type->num_levels;
1748 if (keyi->numLevels[i] > width)
1749 width = keyi->numLevels[i];
1750 if (type->num_levels > width)
1751 width = type->num_levels;
1752 sizeSyms += darray_size(keyi->syms[i]);
1755 darray_resize0(key->syms, sizeSyms);
1758 outActs = XkbcResizeKeyActions(keymap, key, width * nGroups);
1759 if (outActs == NULL) {
1760 WSGO("Could not enlarge actions for %s (key %d)\n",
1761 longText(keyi->name), kc);
1764 key->explicit |= XkbExplicitInterpretMask;
1769 key->num_groups = nGroups;
1770 if (keyi->defined & _Key_GroupInfo) {
1771 key->out_of_range_group_number = keyi->out_of_range_group_number;
1772 key->out_of_range_group_action = keyi->out_of_range_group_action;
1775 key->sym_index = calloc(nGroups * width, sizeof(*key->sym_index));
1776 key->num_syms = calloc(nGroups * width, sizeof(*key->num_syms));
1778 for (i = 0; i < nGroups; i++) {
1779 /* assign kt_index[i] to the index of the type in map->types.
1780 * kt_index[i] may have been set by a previous run (if we have two
1781 * layouts specified). Let's not overwrite it with the ONE_LEVEL
1782 * default group if we dont even have keys for this group anyway.
1784 * FIXME: There should be a better fix for this.
1786 if (keyi->numLevels[i])
1787 key->kt_index[i] = types[i];
1788 if (!darray_empty(keyi->syms[i])) {
1789 /* fill key to "width" symbols*/
1790 for (tmp = 0; tmp < width; tmp++) {
1791 if (tmp < keyi->numLevels[i] &&
1792 darray_item(keyi->symsMapNumEntries[i], tmp) != 0) {
1793 memcpy(darray_mem(key->syms, symIndex),
1794 darray_mem(keyi->syms[i],
1795 darray_item(keyi->symsMapIndex[i], tmp)),
1796 darray_item(keyi->symsMapNumEntries[i],
1797 tmp) * sizeof(xkb_keysym_t));
1798 key->sym_index[(i * width) + tmp] = symIndex;
1799 key->num_syms[(i * width) + tmp] =
1800 darray_item(keyi->symsMapNumEntries[i], tmp);
1801 symIndex += key->num_syms[(i * width) + tmp];
1804 key->sym_index[(i * width) + tmp] = -1;
1805 key->num_syms[(i * width) + tmp] = 0;
1807 if (outActs != NULL && !darray_empty(keyi->acts[i])) {
1808 if (tmp < keyi->numLevels[i])
1809 outActs[tmp] = darray_item(keyi->acts[i], tmp);
1811 outActs[tmp].type = XkbSA_NoAction;
1816 switch (keyi->behavior.type & XkbKB_OpMask) {
1821 key->behavior = keyi->behavior;
1822 key->explicit |= XkbExplicitBehaviorMask;
1825 if (keyi->defined & _Key_VModMap) {
1826 key->vmodmap = keyi->vmodmap;
1827 key->explicit |= XkbExplicitVModMapMask;
1829 if (keyi->repeat != RepeatUndefined) {
1830 key->repeats = keyi->repeat == RepeatYes;
1831 key->explicit |= XkbExplicitAutoRepeatMask;
1834 /* do the same thing for the next key */
1835 CopySymbolsDef(keymap, keyi, kc + 1);
1840 CopyModMapDef(struct xkb_keymap *keymap, ModMapEntry *entry)
1842 struct xkb_key *key;
1844 if (!entry->haveSymbol) {
1845 key = FindNamedKey(keymap, entry->u.keyName, true,
1846 CreateKeyNames(keymap), 0);
1848 if (warningLevel >= 5) {
1849 WARN("Key %s not found in keycodes\n",
1850 longText(entry->u.keyName));
1851 ACTION("Modifier map entry for %s not updated\n",
1852 XkbcModIndexText(entry->modifier));
1858 key = FindKeyForSymbol(keymap, entry->u.keySym);
1860 if (warningLevel > 5) {
1861 WARN("Key \"%s\" not found in symbol map\n",
1862 XkbcKeysymText(entry->u.keySym));
1863 ACTION("Modifier map entry for %s not updated\n",
1864 XkbcModIndexText(entry->modifier));
1870 key->modmap |= (1 << entry->modifier);
1875 * Handle the xkb_symbols section of an xkb file.
1877 * @param file The parsed xkb_symbols section of the xkb file.
1878 * @param keymap Handle to the keyboard description to store the symbols in.
1879 * @param merge Merge strategy (e.g. MERGE_OVERRIDE).
1882 CompileSymbols(XkbFile *file, struct xkb_keymap *keymap,
1883 enum merge_mode merge)
1885 xkb_group_index_t i;
1886 struct xkb_key *key;
1891 InitSymbolsInfo(&info, keymap, file->id);
1892 info.dflt.merge = merge;
1894 HandleSymbolsFile(file, keymap, merge, &info);
1896 if (darray_empty(info.keys))
1899 if (info.errorCount != 0)
1902 darray_resize0(keymap->acts, darray_size(keymap->acts) + 32 + 1);
1905 keymap->symbols_section_name = strdup(info.name);
1907 for (i = 0; i < XkbNumKbdGroups; i++) {
1908 if (info.groupNames[i] != XKB_ATOM_NONE) {
1909 free(keymap->group_names[i]);
1910 keymap->group_names[i] = xkb_atom_strdup(keymap->ctx,
1911 info.groupNames[i]);
1916 darray_foreach(keyi, info.keys)
1917 PrepareKeyDef(keyi);
1920 darray_foreach(keyi, info.keys)
1921 if (!CopySymbolsDef(keymap, keyi, 0))
1924 if (warningLevel > 3) {
1925 xkb_foreach_key(key, keymap) {
1926 if (key->name[0] == '\0')
1929 if (key->num_groups < 1)
1930 WARN("No symbols defined for <%.4s> (keycode %d)\n",
1931 key->name, XkbKeyGetKeycode(keymap, key));
1935 list_foreach(mm, &info.modMaps, entry)
1936 if (!CopyModMapDef(keymap, mm))
1939 FreeSymbolsInfo(&info);
1943 FreeSymbolsInfo(&info);