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];
206 struct xkb_keymap *keymap;
210 InitSymbolsInfo(SymbolsInfo * info, struct xkb_keymap *keymap,
216 info->explicit_group = 0;
217 info->errorCount = 0;
218 info->file_id = file_id;
219 info->merge = MERGE_OVERRIDE;
220 darray_init(info->keys);
221 darray_growalloc(info->keys, 110);
222 list_init(&info->modMaps);
223 for (i = 0; i < XkbNumKbdGroups; i++)
224 info->groupNames[i] = XKB_ATOM_NONE;
225 InitKeyInfo(&info->dflt, file_id);
226 InitVModInfo(&info->vmods, keymap);
228 info->keymap = keymap;
232 FreeSymbolsInfo(SymbolsInfo * info)
235 ModMapEntry *mm, *next;
238 darray_foreach(keyi, info->keys) {
241 darray_free(info->keys);
242 list_foreach_safe(mm, next, &info->modMaps, entry)
244 memset(info, 0, sizeof(SymbolsInfo));
248 ResizeKeyGroup(KeyInfo *keyi, xkb_group_index_t group, unsigned int numLevels,
249 unsigned sizeSyms, bool forceActions)
253 if (darray_size(keyi->syms[group]) < sizeSyms)
254 darray_resize0(keyi->syms[group], sizeSyms);
256 if (darray_empty(keyi->symsMapIndex[group]) ||
257 keyi->numLevels[group] < numLevels) {
258 darray_resize(keyi->symsMapIndex[group], numLevels);
259 for (i = keyi->numLevels[group]; i < numLevels; i++)
260 darray_item(keyi->symsMapIndex[group], i) = -1;
263 if (darray_empty(keyi->symsMapNumEntries[group]) ||
264 keyi->numLevels[group] < numLevels)
265 darray_resize0(keyi->symsMapNumEntries[group], numLevels);
267 if ((forceActions && (keyi->numLevels[group] < numLevels ||
268 darray_empty(keyi->acts[group]))) ||
269 (keyi->numLevels[group] < numLevels && !darray_empty(keyi->acts[group])))
270 darray_resize0(keyi->acts[group], numLevels);
272 if (keyi->numLevels[group] < numLevels)
273 keyi->numLevels[group] = numLevels;
278 enum key_group_selector {
285 MergeKeyGroups(SymbolsInfo * info,
286 KeyInfo * into, KeyInfo * from, xkb_group_index_t group)
288 darray_xkb_keysym_t resultSyms;
289 enum key_group_selector using = NONE;
290 darray_xkb_action resultActs;
291 unsigned int resultWidth;
292 unsigned int resultSize = 0;
295 bool report, clobber;
297 clobber = (from->merge != MERGE_AUGMENT);
299 report = (warningLevel > 9) ||
300 (into->file_id == from->file_id && warningLevel > 0);
302 darray_init(resultSyms);
304 if (into->numLevels[group] >= from->numLevels[group]) {
305 resultActs = into->acts[group];
306 resultWidth = into->numLevels[group];
309 resultActs = from->acts[group];
310 resultWidth = from->numLevels[group];
311 darray_resize(into->symsMapIndex[group],
312 from->numLevels[group]);
313 darray_resize0(into->symsMapNumEntries[group],
314 from->numLevels[group]);
316 for (i = into->numLevels[group]; i < from->numLevels[group]; i++)
317 darray_item(into->symsMapIndex[group], i) = -1;
320 if (darray_empty(resultActs) && (!darray_empty(into->acts[group]) ||
321 !darray_empty(from->acts[group]))) {
322 darray_resize0(resultActs, resultWidth);
323 for (i = 0; i < resultWidth; i++) {
324 union xkb_action *fromAct = NULL, *toAct = NULL;
326 if (!darray_empty(from->acts[group]))
327 fromAct = &darray_item(from->acts[group], i);
329 if (!darray_empty(into->acts[group]))
330 toAct = &darray_item(into->acts[group], i);
332 if (((fromAct == NULL) || (fromAct->type == XkbSA_NoAction))
333 && (toAct != NULL)) {
334 darray_item(resultActs, i) = *toAct;
336 else if (((toAct == NULL) || (toAct->type == XkbSA_NoAction))
337 && (fromAct != NULL)) {
338 darray_item(resultActs, i) = *fromAct;
341 union xkb_action *use, *ignore;
352 ("Multiple actions for level %d/group %u on key %s\n",
353 i + 1, group + 1, longText(into->name));
354 ACTION("Using %s, ignoring %s\n",
355 XkbcActionTypeText(use->type),
356 XkbcActionTypeText(ignore->type));
359 darray_item(resultActs, i) = *use;
364 for (i = 0; i < resultWidth; i++) {
365 unsigned int fromSize = 0;
368 if (!darray_empty(from->symsMapNumEntries[group]) &&
369 i < from->numLevels[group])
370 fromSize = darray_item(from->symsMapNumEntries[group], i);
372 if (!darray_empty(into->symsMapNumEntries[group]) &&
373 i < into->numLevels[group])
374 toSize = darray_item(into->symsMapNumEntries[group], i);
377 resultSize += toSize;
380 else if (toSize == 0 || clobber) {
381 resultSize += fromSize;
385 resultSize += toSize;
394 resultSyms = from->syms[group];
395 darray_free(into->symsMapNumEntries[group]);
396 darray_free(into->symsMapIndex[group]);
397 into->symsMapNumEntries[group] = from->symsMapNumEntries[group];
398 into->symsMapIndex[group] = from->symsMapIndex[group];
399 darray_init(from->symsMapNumEntries[group]);
400 darray_init(from->symsMapIndex[group]);
403 else if (using == TO) {
404 resultSyms = into->syms[group];
408 darray_resize0(resultSyms, resultSize);
410 for (i = 0; i < resultWidth; i++) {
411 enum key_group_selector use = NONE;
412 unsigned int fromSize = 0;
413 unsigned int toSize = 0;
415 if (i < from->numLevels[group])
416 fromSize = darray_item(from->symsMapNumEntries[group], i);
418 if (i < into->numLevels[group])
419 toSize = darray_item(into->symsMapNumEntries[group], i);
421 if (fromSize == 0 && toSize == 0) {
422 darray_item(into->symsMapIndex[group], i) = -1;
423 darray_item(into->symsMapNumEntries[group], i) = 0;
429 else if (toSize == 0 || clobber)
434 if (toSize && fromSize && report) {
435 INFO("Multiple symbols for group %u, level %d on key %s\n",
436 group + 1, i + 1, longText(into->name));
437 ACTION("Using %s, ignoring %s\n",
438 (use == FROM ? "from" : "to"),
439 (use == FROM ? "to" : "from"));
443 memcpy(darray_mem(resultSyms, cur_idx),
444 darray_mem(from->syms[group],
445 darray_item(from->symsMapIndex[group], i)),
446 darray_item(from->symsMapNumEntries[group],
447 i) * sizeof(xkb_keysym_t));
448 darray_item(into->symsMapIndex[group], i) = cur_idx;
449 darray_item(into->symsMapNumEntries[group], i) =
450 darray_item(from->symsMapNumEntries[group], i);
453 memcpy(darray_mem(resultSyms, cur_idx),
454 darray_mem(into->syms[group],
455 darray_item(into->symsMapIndex[group], i)),
456 darray_item(into->symsMapNumEntries[group],
457 i) * sizeof(xkb_keysym_t));
458 darray_item(into->symsMapIndex[group], i) = cur_idx;
460 cur_idx += darray_item(into->symsMapNumEntries[group], i);
464 if (!darray_same(resultActs, into->acts[group]))
465 darray_free(into->acts[group]);
466 if (!darray_same(resultActs, from->acts[group]))
467 darray_free(from->acts[group]);
468 into->numLevels[group] = resultWidth;
469 if (!darray_same(resultSyms, into->syms[group]))
470 darray_free(into->syms[group]);
471 into->syms[group] = resultSyms;
472 if (!darray_same(resultSyms, from->syms[group]))
473 darray_free(from->syms[group]);
474 darray_init(from->syms[group]);
475 darray_free(from->symsMapIndex[group]);
476 darray_free(from->symsMapNumEntries[group]);
477 into->acts[group] = resultActs;
478 darray_init(from->acts[group]);
479 if (!darray_empty(into->syms[group]))
480 into->symsDefined |= (1 << group);
481 from->symsDefined &= ~(1 << group);
482 into->actsDefined |= (1 << group);
483 from->actsDefined &= ~(1 << group);
489 MergeKeys(SymbolsInfo *info, KeyInfo *into, KeyInfo *from)
492 unsigned collide = 0;
495 if (from->merge == MERGE_REPLACE) {
496 for (i = 0; i < XkbNumKbdGroups; i++) {
497 if (into->numLevels[i] != 0) {
498 darray_free(into->syms[i]);
499 darray_free(into->acts[i]);
503 memset(from, 0, sizeof(KeyInfo));
506 report = ((warningLevel > 9) ||
507 ((into->file_id == from->file_id)
508 && (warningLevel > 0)));
509 for (i = 0; i < XkbNumKbdGroups; i++) {
510 if (from->numLevels[i] > 0) {
511 if (into->numLevels[i] == 0) {
512 into->numLevels[i] = from->numLevels[i];
513 into->syms[i] = from->syms[i];
514 into->symsMapIndex[i] = from->symsMapIndex[i];
515 into->symsMapNumEntries[i] = from->symsMapNumEntries[i];
516 into->acts[i] = from->acts[i];
517 into->symsDefined |= (1 << i);
518 darray_init(from->syms[i]);
519 darray_init(from->symsMapIndex[i]);
520 darray_init(from->symsMapNumEntries[i]);
521 darray_init(from->acts[i]);
522 from->numLevels[i] = 0;
523 from->symsDefined &= ~(1 << i);
524 if (!darray_empty(into->syms[i]))
525 into->defined |= _Key_Syms;
526 if (!darray_empty(into->acts[i]))
527 into->defined |= _Key_Acts;
531 if (!darray_empty(into->syms[i]))
532 collide |= _Key_Syms;
533 if (!darray_empty(into->acts[i]))
534 collide |= _Key_Acts;
536 MergeKeyGroups(info, into, from, (unsigned) i);
539 if (from->types[i] != XKB_ATOM_NONE) {
540 if ((into->types[i] != XKB_ATOM_NONE) && report &&
541 (into->types[i] != from->types[i])) {
542 xkb_atom_t use, ignore;
543 collide |= _Key_Types;
544 if (from->merge != MERGE_AUGMENT) {
545 use = from->types[i];
546 ignore = into->types[i];
549 use = into->types[i];
550 ignore = from->types[i];
553 ("Multiple definitions for group %d type of key %s\n",
554 i, longText(into->name));
555 ACTION("Using %s, ignoring %s\n",
556 xkb_atom_text(info->keymap->ctx, use),
557 xkb_atom_text(info->keymap->ctx, ignore));
559 if (from->merge != MERGE_AUGMENT ||
560 into->types[i] == XKB_ATOM_NONE) {
561 into->types[i] = from->types[i];
565 if (UseNewField(_Key_Behavior, into->defined, into->file_id,
566 from->defined, from->file_id, from->merge, &collide)) {
567 into->behavior = from->behavior;
568 into->defined |= _Key_Behavior;
570 if (UseNewField(_Key_VModMap, into->defined, into->file_id,
571 from->defined, from->file_id, from->merge, &collide)) {
572 into->vmodmap = from->vmodmap;
573 into->defined |= _Key_VModMap;
575 if (UseNewField(_Key_Repeat, into->defined, into->file_id,
576 from->defined, from->file_id, from->merge, &collide)) {
577 into->repeat = from->repeat;
578 into->defined |= _Key_Repeat;
580 if (UseNewField(_Key_Type_Dflt, into->defined, into->file_id,
581 from->defined, from->file_id, from->merge, &collide)) {
582 into->dfltType = from->dfltType;
583 into->defined |= _Key_Type_Dflt;
585 if (UseNewField(_Key_GroupInfo, into->defined, into->file_id,
586 from->defined, from->file_id, from->merge, &collide)) {
587 into->out_of_range_group_action = from->out_of_range_group_action;
588 into->out_of_range_group_number = from->out_of_range_group_number;
589 into->defined |= _Key_GroupInfo;
592 WARN("Symbol map for key %s redefined\n",
593 longText(into->name));
594 ACTION("Using %s definition for conflicting fields\n",
595 (from->merge == MERGE_AUGMENT ? "first" : "last"));
601 AddKeySymbols(SymbolsInfo *info, KeyInfo *keyi)
603 unsigned long real_name;
606 darray_foreach(iter, info->keys)
607 if (iter->name == keyi->name)
608 return MergeKeys(info, iter, keyi);
610 if (FindKeyNameForAlias(info->keymap, keyi->name, &real_name))
611 darray_foreach(iter, info->keys)
612 if (iter->name == real_name)
613 return MergeKeys(info, iter, keyi);
615 darray_resize0(info->keys, darray_size(info->keys) + 1);
616 new = &darray_item(info->keys, darray_size(info->keys) - 1);
617 return CopyKeyInfo(keyi, new, true);
621 AddModMapEntry(SymbolsInfo * info, ModMapEntry * new)
626 clobber = (new->merge != MERGE_AUGMENT);
627 list_foreach(mm, &info->modMaps, entry) {
628 if (new->haveSymbol && mm->haveSymbol
629 && (new->u.keySym == mm->u.keySym)) {
630 unsigned use, ignore;
631 if (mm->modifier != new->modifier) {
634 ignore = mm->modifier;
638 ignore = new->modifier;
641 ("%s added to symbol map for multiple modifiers\n",
642 XkbcKeysymText(new->u.keySym));
643 ACTION("Using %s, ignoring %s.\n",
644 XkbcModIndexText(use),
645 XkbcModIndexText(ignore));
650 if ((!new->haveSymbol) && (!mm->haveSymbol) &&
651 (new->u.keyName == mm->u.keyName)) {
652 unsigned use, ignore;
653 if (mm->modifier != new->modifier) {
656 ignore = mm->modifier;
660 ignore = new->modifier;
662 ERROR("Key %s added to map for multiple modifiers\n",
663 longText(new->u.keyName));
664 ACTION("Using %s, ignoring %s.\n",
665 XkbcModIndexText(use),
666 XkbcModIndexText(ignore));
673 mm = malloc(sizeof(*mm));
675 WSGO("Could not allocate modifier map entry\n");
676 ACTION("Modifier map for %s will be incomplete\n",
677 XkbcModIndexText(new->modifier));
682 list_add(&mm->entry, &info->modMaps);
686 /***====================================================================***/
689 MergeIncludedSymbols(SymbolsInfo *into, SymbolsInfo *from,
690 enum merge_mode merge)
694 ModMapEntry *mm, *next;
696 if (from->errorCount > 0) {
697 into->errorCount += from->errorCount;
700 if (into->name == NULL) {
701 into->name = from->name;
704 for (i = 0; i < XkbNumKbdGroups; i++) {
705 if (from->groupNames[i] != XKB_ATOM_NONE) {
706 if ((merge != MERGE_AUGMENT) ||
707 (into->groupNames[i] == XKB_ATOM_NONE))
708 into->groupNames[i] = from->groupNames[i];
712 darray_foreach(keyi, from->keys) {
713 if (merge != MERGE_DEFAULT)
716 if (!AddKeySymbols(into, keyi))
720 list_foreach_safe(mm, next, &from->modMaps, entry) {
721 if (merge != MERGE_DEFAULT)
723 if (!AddModMapEntry(into, mm))
727 list_init(&from->modMaps);
731 HandleSymbolsFile(SymbolsInfo *info, XkbFile *file, enum merge_mode merge);
734 HandleIncludeSymbols(SymbolsInfo *info, IncludeStmt *stmt)
736 enum merge_mode merge = MERGE_DEFAULT;
738 SymbolsInfo included, next_incl;
740 InitSymbolsInfo(&included, info->keymap, info->file_id);
743 included.name = stmt->stmt;
747 for (; stmt; stmt = stmt->next) {
748 if (!ProcessIncludeFile(info->keymap->ctx, stmt, FILE_TYPE_SYMBOLS,
750 info->errorCount += 10;
751 FreeSymbolsInfo(&included);
755 InitSymbolsInfo(&next_incl, info->keymap, rtrn->id);
756 next_incl.merge = next_incl.dflt.merge = MERGE_OVERRIDE;
758 next_incl.explicit_group = atoi(stmt->modifier) - 1;
760 next_incl.explicit_group = info->explicit_group;
762 HandleSymbolsFile(&next_incl, rtrn, MERGE_OVERRIDE);
764 MergeIncludedSymbols(&included, &next_incl, merge);
766 FreeSymbolsInfo(&next_incl);
770 MergeIncludedSymbols(info, &included, merge);
771 FreeSymbolsInfo(&included);
773 return (info->errorCount == 0);
780 GetGroupIndex(SymbolsInfo *info, KeyInfo *keyi, ExprDef *arrayNdx,
781 unsigned what, xkb_group_index_t *ndx_rtrn)
791 if (arrayNdx == NULL) {
795 defined = keyi->symsDefined;
797 defined = keyi->actsDefined;
799 for (i = 0; i < XkbNumKbdGroups; i++) {
800 if ((defined & (1 << i)) == 0) {
805 ERROR("Too many groups of %s for key %s (max %u)\n", name,
806 longText(keyi->name), XkbNumKbdGroups + 1);
807 ACTION("Ignoring %s defined for extra groups\n", name);
810 if (!ExprResolveGroup(info->keymap->ctx, arrayNdx, &tmp)) {
811 ERROR("Illegal group index for %s of key %s\n", name,
812 longText(keyi->name));
813 ACTION("Definition with non-integer array index ignored\n");
816 *ndx_rtrn = tmp.uval - 1;
821 AddSymbolsToKey(SymbolsInfo *info, KeyInfo *keyi, ExprDef *arrayNdx,
824 xkb_group_index_t ndx;
825 size_t nSyms, nLevels;
829 if (!GetGroupIndex(info, keyi, arrayNdx, SYMBOLS, &ndx))
832 keyi->symsDefined |= (1 << ndx);
835 if (value->op != ExprKeysymList) {
836 ERROR("Expected a list of symbols, found %s\n", exprOpText(value->op));
837 ACTION("Ignoring symbols for group %u of %s\n", ndx + 1,
838 longText(keyi->name));
841 if (!darray_empty(keyi->syms[ndx])) {
842 ERROR("Symbols for key %s, group %u already defined\n",
843 longText(keyi->name), ndx + 1);
844 ACTION("Ignoring duplicate definition\n");
847 nSyms = darray_size(value->value.list.syms);
848 nLevels = darray_size(value->value.list.symsMapIndex);
849 if ((keyi->numLevels[ndx] < nSyms || darray_empty(keyi->syms[ndx])) &&
850 (!ResizeKeyGroup(keyi, ndx, nLevels, nSyms, false))) {
851 WSGO("Could not resize group %u of key %s to contain %zu levels\n",
852 ndx + 1, longText(keyi->name), nSyms);
853 ACTION("Symbols lost\n");
856 keyi->symsDefined |= (1 << ndx);
857 for (i = 0; i < nLevels; i++) {
858 darray_item(keyi->symsMapIndex[ndx], i) =
859 darray_item(value->value.list.symsMapIndex, i);
860 darray_item(keyi->symsMapNumEntries[ndx], i) =
861 darray_item(value->value.list.symsNumEntries, i);
863 for (j = 0; j < darray_item(keyi->symsMapNumEntries[ndx], i); j++) {
864 /* FIXME: What's abort() doing here? */
865 if (darray_item(keyi->symsMapIndex[ndx], i) + j >= nSyms)
867 if (!LookupKeysym(darray_item(value->value.list.syms,
868 darray_item(value->value.list.symsMapIndex,
870 &darray_item(keyi->syms[ndx],
871 darray_item(keyi->symsMapIndex[ndx],
874 "Could not resolve keysym %s for key %s, group %u (%s), level %zu\n",
875 darray_item(value->value.list.syms, i),
876 longText(keyi->name),
878 xkb_atom_text(info->keymap->ctx, info->groupNames[ndx]),
881 darray_item(keyi->syms[ndx],
882 darray_item(keyi->symsMapIndex[ndx],
883 i) + j) = XKB_KEY_NoSymbol;
884 darray_item(keyi->symsMapIndex[ndx], i) = -1;
885 darray_item(keyi->symsMapNumEntries[ndx], i) = 0;
888 if (darray_item(keyi->symsMapNumEntries[ndx], i) == 1 &&
889 darray_item(keyi->syms[ndx],
890 darray_item(keyi->symsMapIndex[ndx],
891 i) + j) == XKB_KEY_NoSymbol) {
892 darray_item(keyi->symsMapIndex[ndx], i) = -1;
893 darray_item(keyi->symsMapNumEntries[ndx], i) = 0;
897 for (j = keyi->numLevels[ndx] - 1;
898 j >= 0 && darray_item(keyi->symsMapNumEntries[ndx], j) == 0; j--)
899 keyi->numLevels[ndx]--;
904 AddActionsToKey(SymbolsInfo *info, KeyInfo *keyi, ExprDef *arrayNdx,
908 xkb_group_index_t ndx;
911 struct xkb_any_action *toAct;
913 if (!GetGroupIndex(info, keyi, arrayNdx, ACTIONS, &ndx))
917 keyi->actsDefined |= (1 << ndx);
920 if (value->op != ExprActionList) {
921 WSGO("Bad expression type (%d) for action list value\n", value->op);
922 ACTION("Ignoring actions for group %u of %s\n", ndx,
923 longText(keyi->name));
926 if (!darray_empty(keyi->acts[ndx])) {
927 WSGO("Actions for key %s, group %u already defined\n",
928 longText(keyi->name), ndx);
931 for (nActs = 0, act = value->value.child; act != NULL; nActs++) {
932 act = (ExprDef *) act->common.next;
935 WSGO("Action list but not actions in AddActionsToKey\n");
938 if ((keyi->numLevels[ndx] < nActs || darray_empty(keyi->acts[ndx])) &&
939 !ResizeKeyGroup(keyi, ndx, nActs, nActs, true)) {
940 WSGO("Could not resize group %u of key %s\n", ndx,
941 longText(keyi->name));
942 ACTION("Actions lost\n");
945 keyi->actsDefined |= (1 << ndx);
947 toAct = (struct xkb_any_action *) darray_mem(keyi->acts[ndx], 0);
948 act = value->value.child;
949 for (i = 0; i < nActs; i++, toAct++) {
950 if (!HandleActionDef(act, info->keymap, toAct, info->action)) {
951 ERROR("Illegal action definition for %s\n",
952 longText(keyi->name));
953 ACTION("Action for group %u/level %zu ignored\n", ndx + 1, i + 1);
955 act = (ExprDef *) act->common.next;
960 static const LookupEntry lockingEntries[] = {
961 { "true", XkbKB_Lock },
962 { "yes", XkbKB_Lock },
963 { "on", XkbKB_Lock },
964 { "false", XkbKB_Default },
965 { "no", XkbKB_Default },
966 { "off", XkbKB_Default },
967 { "permanent", XkbKB_Lock | XkbKB_Permanent },
971 static const LookupEntry repeatEntries[] = {
972 { "true", RepeatYes },
973 { "yes", RepeatYes },
975 { "false", RepeatNo },
978 { "default", RepeatUndefined },
983 SetSymbolsField(SymbolsInfo *info, KeyInfo *keyi, char *field,
984 ExprDef *arrayNdx, ExprDef *value)
988 struct xkb_context *ctx = info->keymap->ctx;
990 if (strcasecmp(field, "type") == 0) {
992 if ((!ExprResolveString(ctx, value, &tmp))
993 && (warningLevel > 0)) {
994 WARN("The type field of a key symbol map must be a string\n");
995 ACTION("Ignoring illegal type definition\n");
997 if (arrayNdx == NULL) {
998 keyi->dfltType = xkb_atom_intern(ctx, tmp.str);
999 keyi->defined |= _Key_Type_Dflt;
1001 else if (!ExprResolveGroup(ctx, arrayNdx, &ndx)) {
1002 ERROR("Illegal group index for type of key %s\n",
1003 longText(keyi->name));
1004 ACTION("Definition with non-integer array index ignored\n");
1009 keyi->types[ndx.uval - 1] = xkb_atom_intern(ctx, tmp.str);
1010 keyi->typesDefined |= (1 << (ndx.uval - 1));
1014 else if (strcasecmp(field, "symbols") == 0)
1015 return AddSymbolsToKey(info, keyi, arrayNdx, value);
1016 else if (strcasecmp(field, "actions") == 0)
1017 return AddActionsToKey(info, keyi, arrayNdx, value);
1018 else if ((strcasecmp(field, "vmods") == 0) ||
1019 (strcasecmp(field, "virtualmods") == 0) ||
1020 (strcasecmp(field, "virtualmodifiers") == 0)) {
1021 ok = ExprResolveVModMask(value, &tmp, info->keymap);
1023 keyi->vmodmap = (tmp.uval >> 8);
1024 keyi->defined |= _Key_VModMap;
1027 ERROR("Expected a virtual modifier mask, found %s\n",
1028 exprOpText(value->op));
1029 ACTION("Ignoring virtual modifiers definition for key %s\n",
1030 longText(keyi->name));
1033 else if ((strcasecmp(field, "locking") == 0) ||
1034 (strcasecmp(field, "lock") == 0) ||
1035 (strcasecmp(field, "locks") == 0)) {
1036 ok = ExprResolveEnum(ctx, value, &tmp, lockingEntries);
1038 keyi->behavior.type = tmp.uval;
1039 keyi->defined |= _Key_Behavior;
1041 else if ((strcasecmp(field, "radiogroup") == 0) ||
1042 (strcasecmp(field, "permanentradiogroup") == 0) ||
1043 (strcasecmp(field, "allownone") == 0)) {
1044 ERROR("Radio groups not supported\n");
1045 ACTION("Ignoring radio group specification for key %s\n",
1046 longText(keyi->name));
1049 else if (uStrCasePrefix("overlay", field) ||
1050 uStrCasePrefix("permanentoverlay", field)) {
1051 ERROR("Overlays not supported\n");
1052 ACTION("Ignoring overlay specification for key %s\n",
1053 longText(keyi->name));
1055 else if ((strcasecmp(field, "repeating") == 0) ||
1056 (strcasecmp(field, "repeats") == 0) ||
1057 (strcasecmp(field, "repeat") == 0)) {
1058 ok = ExprResolveEnum(ctx, value, &tmp, repeatEntries);
1060 ERROR("Illegal repeat setting for %s\n",
1061 longText(keyi->name));
1062 ACTION("Non-boolean repeat setting ignored\n");
1065 keyi->repeat = tmp.uval;
1066 keyi->defined |= _Key_Repeat;
1068 else if ((strcasecmp(field, "groupswrap") == 0) ||
1069 (strcasecmp(field, "wrapgroups") == 0)) {
1070 ok = ExprResolveBoolean(ctx, value, &tmp);
1072 ERROR("Illegal groupsWrap setting for %s\n",
1073 longText(keyi->name));
1074 ACTION("Non-boolean value ignored\n");
1078 keyi->out_of_range_group_action = XkbWrapIntoRange;
1080 keyi->out_of_range_group_action = XkbClampIntoRange;
1081 keyi->defined |= _Key_GroupInfo;
1083 else if ((strcasecmp(field, "groupsclamp") == 0) ||
1084 (strcasecmp(field, "clampgroups") == 0)) {
1085 ok = ExprResolveBoolean(ctx, value, &tmp);
1087 ERROR("Illegal groupsClamp setting for %s\n",
1088 longText(keyi->name));
1089 ACTION("Non-boolean value ignored\n");
1093 keyi->out_of_range_group_action = XkbClampIntoRange;
1095 keyi->out_of_range_group_action = XkbWrapIntoRange;
1096 keyi->defined |= _Key_GroupInfo;
1098 else if ((strcasecmp(field, "groupsredirect") == 0) ||
1099 (strcasecmp(field, "redirectgroups") == 0)) {
1100 if (!ExprResolveGroup(ctx, value, &tmp)) {
1101 ERROR("Illegal group index for redirect of key %s\n",
1102 longText(keyi->name));
1103 ACTION("Definition with non-integer group ignored\n");
1106 keyi->out_of_range_group_action = XkbRedirectIntoRange;
1107 keyi->out_of_range_group_number = tmp.uval - 1;
1108 keyi->defined |= _Key_GroupInfo;
1111 ERROR("Unknown field %s in a symbol interpretation\n", field);
1112 ACTION("Definition ignored\n");
1119 SetGroupName(SymbolsInfo *info, ExprDef *arrayNdx, ExprDef *value)
1121 ExprResult tmp, name;
1123 if ((arrayNdx == NULL) && (warningLevel > 0)) {
1124 WARN("You must specify an index when specifying a group name\n");
1125 ACTION("Group name definition without array subscript ignored\n");
1128 if (!ExprResolveGroup(info->keymap->ctx, arrayNdx, &tmp)) {
1129 ERROR("Illegal index in group name definition\n");
1130 ACTION("Definition with non-integer array index ignored\n");
1133 if (!ExprResolveString(info->keymap->ctx, value, &name)) {
1134 ERROR("Group name must be a string\n");
1135 ACTION("Illegal name for group %d ignored\n", tmp.uval);
1138 info->groupNames[tmp.uval - 1 + info->explicit_group] =
1139 xkb_atom_intern(info->keymap->ctx, name.str);
1146 HandleSymbolsVar(SymbolsInfo *info, VarDef *stmt)
1148 ExprResult elem, field;
1152 if (ExprResolveLhs(info->keymap, stmt->name, &elem, &field,
1154 return 0; /* internal error, already reported */
1155 if (elem.str && (strcasecmp(elem.str, "key") == 0)) {
1156 ret = SetSymbolsField(info, &info->dflt, field.str, arrayNdx,
1159 else if ((elem.str == NULL) && ((strcasecmp(field.str, "name") == 0) ||
1160 (strcasecmp(field.str, "groupname") ==
1162 ret = SetGroupName(info, arrayNdx, stmt->value);
1164 else if ((elem.str == NULL)
1165 && ((strcasecmp(field.str, "groupswrap") == 0) ||
1166 (strcasecmp(field.str, "wrapgroups") == 0))) {
1167 ERROR("Global \"groupswrap\" not supported\n");
1168 ACTION("Ignored\n");
1171 else if ((elem.str == NULL)
1172 && ((strcasecmp(field.str, "groupsclamp") == 0) ||
1173 (strcasecmp(field.str, "clampgroups") == 0))) {
1174 ERROR("Global \"groupsclamp\" not supported\n");
1175 ACTION("Ignored\n");
1178 else if ((elem.str == NULL)
1179 && ((strcasecmp(field.str, "groupsredirect") == 0) ||
1180 (strcasecmp(field.str, "redirectgroups") == 0))) {
1181 ERROR("Global \"groupsredirect\" not supported\n");
1182 ACTION("Ignored\n");
1185 else if ((elem.str == NULL) &&
1186 (strcasecmp(field.str, "allownone") == 0)) {
1187 ERROR("Radio groups not supported\n");
1188 ACTION("Ignoring \"allownone\" specification\n");
1192 ret = SetActionField(info->keymap, elem.str, field.str, arrayNdx,
1193 stmt->value, &info->action);
1202 HandleSymbolsBody(SymbolsInfo *info, VarDef *def, KeyInfo *keyi)
1205 ExprResult tmp, field;
1208 for (; def != NULL; def = (VarDef *) def->common.next) {
1209 if ((def->name) && (def->name->type == ExprFieldRef)) {
1210 ok = HandleSymbolsVar(info, def);
1214 if (def->name == NULL) {
1215 if ((def->value == NULL)
1216 || (def->value->op == ExprKeysymList))
1217 field.str = strdup("symbols");
1219 field.str = strdup("actions");
1223 ok = ExprResolveLhs(info->keymap, def->name, &tmp, &field,
1227 ok = SetSymbolsField(info, keyi, field.str, arrayNdx,
1236 SetExplicitGroup(SymbolsInfo *info, KeyInfo *keyi)
1238 xkb_group_index_t group = info->explicit_group;
1243 if ((keyi->typesDefined | keyi->symsDefined | keyi->actsDefined) & ~1) {
1244 xkb_group_index_t i;
1245 WARN("For the map %s an explicit group specified\n", info->name);
1246 WARN("but key %s has more than one group defined\n",
1247 longText(keyi->name));
1248 ACTION("All groups except first one will be ignored\n");
1249 for (i = 1; i < XkbNumKbdGroups; i++) {
1250 keyi->numLevels[i] = 0;
1251 darray_free(keyi->syms[i]);
1252 darray_free(keyi->acts[i]);
1256 keyi->typesDefined = keyi->symsDefined = keyi->actsDefined = 1 << group;
1258 keyi->numLevels[group] = keyi->numLevels[0];
1259 keyi->numLevels[0] = 0;
1260 keyi->syms[group] = keyi->syms[0];
1261 darray_init(keyi->syms[0]);
1262 keyi->symsMapIndex[group] = keyi->symsMapIndex[0];
1263 darray_init(keyi->symsMapIndex[0]);
1264 keyi->symsMapNumEntries[group] = keyi->symsMapNumEntries[0];
1265 darray_init(keyi->symsMapNumEntries[0]);
1266 keyi->acts[group] = keyi->acts[0];
1267 darray_init(keyi->acts[0]);
1268 keyi->types[group] = keyi->types[0];
1274 HandleSymbolsDef(SymbolsInfo *info, SymbolsDef *stmt)
1278 InitKeyInfo(&keyi, info->file_id);
1279 CopyKeyInfo(&info->dflt, &keyi, false);
1280 keyi.merge = stmt->merge;
1281 keyi.name = KeyNameToLong(stmt->keyName);
1282 if (!HandleSymbolsBody(info, (VarDef *) stmt->symbols, &keyi)) {
1287 if (!SetExplicitGroup(info, &keyi)) {
1292 if (!AddKeySymbols(info, &keyi)) {
1300 HandleModMapDef(SymbolsInfo *info, ModMapDef *def)
1306 struct xkb_context *ctx = info->keymap->ctx;
1308 if (!LookupModIndex(ctx, NULL, def->modifier, TypeInt, &rtrn)) {
1309 ERROR("Illegal modifier map definition\n");
1310 ACTION("Ignoring map for non-modifier \"%s\"\n",
1311 xkb_atom_text(ctx, def->modifier));
1315 tmp.modifier = rtrn.uval;
1316 for (key = def->keys; key != NULL; key = (ExprDef *) key->common.next) {
1317 if ((key->op == ExprValue) && (key->type == TypeKeyName)) {
1318 tmp.haveSymbol = false;
1319 tmp.u.keyName = KeyNameToLong(key->value.keyName);
1321 else if (ExprResolveKeySym(ctx, key, &rtrn)) {
1322 tmp.haveSymbol = true;
1323 tmp.u.keySym = rtrn.uval;
1326 ERROR("Modmap entries may contain only key names or keysyms\n");
1327 ACTION("Illegal definition for %s modifier ignored\n",
1328 XkbcModIndexText(tmp.modifier));
1332 ok = AddModMapEntry(info, &tmp) && ok;
1338 HandleSymbolsFile(SymbolsInfo *info, XkbFile *file, enum merge_mode merge)
1343 info->name = uDupString(file->name);
1347 switch (stmt->stmtType) {
1349 if (!HandleIncludeSymbols(info, (IncludeStmt *) stmt))
1352 case StmtSymbolsDef:
1353 if (!HandleSymbolsDef(info, (SymbolsDef *) stmt))
1357 if (!HandleSymbolsVar(info, (VarDef *) stmt))
1361 if (!HandleVModDef((VModDef *) stmt, info->keymap, merge,
1366 ERROR("Interpretation files may not include other types\n");
1367 ACTION("Ignoring definition of symbol interpretation\n");
1370 case StmtKeycodeDef:
1371 ERROR("Interpretation files may not include other types\n");
1372 ACTION("Ignoring definition of key name\n");
1376 if (!HandleModMapDef(info, (ModMapDef *) stmt))
1380 WSGO("Unexpected statement type %d in HandleSymbolsFile\n",
1385 if (info->errorCount > 10) {
1386 ACTION("Abandoning symbols file \"%s\"\n", file->topName);
1393 * Given a keysym @sym, return a key which generates it, or NULL.
1394 * This is used for example in a modifier map definition, such as:
1395 * modifier_map Lock { Caps_Lock };
1396 * where we want to add the Lock modifier to the modmap of the key
1397 * which matches the keysym Caps_Lock.
1398 * Since there can be many keys which generates the keysym, the key
1399 * is chosen first by lowest group in which the keysym appears, than
1400 * by lowest level and than by lowest key code.
1402 static struct xkb_key *
1403 FindKeyForSymbol(struct xkb_keymap *keymap, xkb_keysym_t sym)
1405 struct xkb_key *key, *ret = NULL;
1406 xkb_group_index_t group, min_group = UINT_MAX;
1407 unsigned int level, min_level = UINT_MAX;
1409 xkb_foreach_key(key, keymap) {
1410 for (group = 0; group < key->num_groups; group++) {
1411 for (level = 0; level < XkbKeyGroupWidth(keymap, key, group);
1413 if (XkbKeyNumSyms(key, group, level) != 1 ||
1414 (XkbKeySymEntry(key, group, level))[0] != sym)
1418 * If the keysym was found in a group or level > 0, we must
1419 * keep looking since we might find a key in which the keysym
1420 * is in a lower group or level.
1422 if (group < min_group ||
1423 (group == min_group && level < min_level)) {
1425 if (group == 0 && level == 0) {
1441 * Find the given name in the keymap->map->types and return its index.
1443 * @param atom The atom to search for.
1444 * @param type_rtrn Set to the index of the name if found.
1446 * @return true if found, false otherwise.
1449 FindNamedType(struct xkb_keymap *keymap, xkb_atom_t atom, unsigned *type_rtrn)
1452 const char *name = xkb_atom_text(keymap->ctx, atom);
1453 struct xkb_key_type *type;
1456 darray_foreach(type, keymap->types) {
1457 if (strcmp(type->name, name) == 0) {
1468 * Assign a type to the given sym and return the Atom for the type assigned.
1471 * - ONE_LEVEL for width 0/1
1472 * - ALPHABETIC for 2 shift levels, with lower/upercase
1473 * - KEYPAD for keypad keys.
1474 * - TWO_LEVEL for other 2 shift level keys.
1475 * and the same for four level keys.
1477 * @param width Number of sysms in syms.
1478 * @param syms The keysyms for the given key (must be size width).
1479 * @param typeNameRtrn Set to the Atom of the type name.
1481 * @returns true if a type could be found, false otherwise.
1483 * FIXME: I need to take the KeyInfo so I can look at symsMapIndex and
1484 * all that fun stuff rather than just assuming there's always one
1488 FindAutomaticType(struct xkb_keymap *keymap, int width,
1489 const xkb_keysym_t *syms, xkb_atom_t *typeNameRtrn,
1493 if ((width == 1) || (width == 0)) {
1494 *typeNameRtrn = xkb_atom_intern(keymap->ctx, "ONE_LEVEL");
1497 else if (width == 2) {
1498 if (syms && xkb_keysym_is_lower(syms[0]) &&
1499 xkb_keysym_is_upper(syms[1])) {
1500 *typeNameRtrn = xkb_atom_intern(keymap->ctx, "ALPHABETIC");
1502 else if (syms && (xkb_keysym_is_keypad(syms[0]) ||
1503 xkb_keysym_is_keypad(syms[1]))) {
1504 *typeNameRtrn = xkb_atom_intern(keymap->ctx, "KEYPAD");
1508 *typeNameRtrn = xkb_atom_intern(keymap->ctx, "TWO_LEVEL");
1512 else if (width <= 4) {
1513 if (syms && xkb_keysym_is_lower(syms[0]) &&
1514 xkb_keysym_is_upper(syms[1]))
1515 if (xkb_keysym_is_lower(syms[2]) && xkb_keysym_is_upper(syms[3]))
1517 xkb_atom_intern(keymap->ctx, "FOUR_LEVEL_ALPHABETIC");
1519 *typeNameRtrn = xkb_atom_intern(keymap->ctx,
1520 "FOUR_LEVEL_SEMIALPHABETIC");
1522 else if (syms && (xkb_keysym_is_keypad(syms[0]) ||
1523 xkb_keysym_is_keypad(syms[1])))
1524 *typeNameRtrn = xkb_atom_intern(keymap->ctx, "FOUR_LEVEL_KEYPAD");
1526 *typeNameRtrn = xkb_atom_intern(keymap->ctx, "FOUR_LEVEL");
1527 /* XXX: why not set autoType here? */
1529 return ((width >= 0) && (width <= 4));
1533 * Ensure the given KeyInfo is in a coherent state, i.e. no gaps between the
1534 * groups, and reduce to one group if all groups are identical anyway.
1537 PrepareKeyDef(KeyInfo *keyi)
1539 xkb_group_index_t i, lastGroup;
1540 int j, width, defined;
1543 defined = keyi->symsDefined | keyi->actsDefined | keyi->typesDefined;
1544 /* get highest group number */
1545 for (i = XkbNumKbdGroups - 1; i > 0; i--) {
1546 if (defined & (1 << i))
1554 /* If there are empty groups between non-empty ones fill them with data */
1555 /* from the first group. */
1556 /* We can make a wrong assumption here. But leaving gaps is worse. */
1557 for (i = lastGroup; i > 0; i--) {
1558 if (defined & (1 << i))
1560 width = keyi->numLevels[0];
1561 if (keyi->typesDefined & 1) {
1562 for (j = 0; j < width; j++) {
1563 keyi->types[i] = keyi->types[0];
1565 keyi->typesDefined |= 1 << i;
1567 if ((keyi->actsDefined & 1) && !darray_empty(keyi->acts[0])) {
1568 darray_copy(keyi->acts[i], keyi->acts[0]);
1569 keyi->actsDefined |= 1 << i;
1571 if ((keyi->symsDefined & 1) && !darray_empty(keyi->syms[0])) {
1572 darray_copy(keyi->syms[i], keyi->syms[0]);
1573 darray_copy(keyi->symsMapIndex[i], keyi->symsMapIndex[0]);
1574 darray_copy(keyi->symsMapNumEntries[i],
1575 keyi->symsMapNumEntries[0]);
1576 keyi->symsDefined |= 1 << i;
1579 keyi->numLevels[i] = keyi->numLevels[0];
1582 /* If all groups are completely identical remove them all */
1583 /* exept the first one. */
1585 for (i = lastGroup; i > 0; i--) {
1586 if ((keyi->numLevels[i] != keyi->numLevels[0]) ||
1587 (keyi->types[i] != keyi->types[0])) {
1591 if (!darray_same(keyi->syms[i], keyi->syms[0]) &&
1592 (darray_empty(keyi->syms[i]) || darray_empty(keyi->syms[0]) ||
1593 darray_size(keyi->syms[i]) != darray_size(keyi->syms[0]) ||
1594 memcmp(darray_mem(keyi->syms[i], 0),
1595 darray_mem(keyi->syms[0], 0),
1596 sizeof(xkb_keysym_t) * darray_size(keyi->syms[0])))) {
1600 if (!darray_same(keyi->symsMapIndex[i], keyi->symsMapIndex[0]) &&
1601 (darray_empty(keyi->symsMapIndex[i]) ||
1602 darray_empty(keyi->symsMapIndex[0]) ||
1603 memcmp(darray_mem(keyi->symsMapIndex[i], 0),
1604 darray_mem(keyi->symsMapIndex[0], 0),
1605 keyi->numLevels[0] * sizeof(int)))) {
1609 if (!darray_same(keyi->symsMapNumEntries[i],
1610 keyi->symsMapNumEntries[0]) &&
1611 (darray_empty(keyi->symsMapNumEntries[i]) ||
1612 darray_empty(keyi->symsMapNumEntries[0]) ||
1613 memcmp(darray_mem(keyi->symsMapNumEntries[i], 0),
1614 darray_mem(keyi->symsMapNumEntries[0], 0),
1615 keyi->numLevels[0] * sizeof(size_t)))) {
1619 if (!darray_same(keyi->acts[i], keyi->acts[0]) &&
1620 (darray_empty(keyi->acts[i]) || darray_empty(keyi->acts[0]) ||
1621 memcmp(darray_mem(keyi->acts[i], 0),
1622 darray_mem(keyi->acts[0], 0),
1623 keyi->numLevels[0] * sizeof(union xkb_action)))) {
1629 for (i = lastGroup; i > 0; i--) {
1630 keyi->numLevels[i] = 0;
1631 darray_free(keyi->syms[i]);
1632 darray_free(keyi->symsMapIndex[i]);
1633 darray_free(keyi->symsMapNumEntries[i]);
1634 darray_free(keyi->acts[i]);
1637 keyi->symsDefined &= 1;
1638 keyi->actsDefined &= 1;
1639 keyi->typesDefined &= 1;
1644 * Copy the KeyInfo into the keyboard description.
1646 * This function recurses.
1649 CopySymbolsDef(struct xkb_keymap *keymap, KeyInfo *keyi,
1650 xkb_keycode_t start_from)
1653 struct xkb_key *key;
1654 size_t sizeSyms = 0;
1655 xkb_group_index_t i, nGroups;
1656 unsigned width, tmp;
1657 struct xkb_key_type * type;
1658 bool haveActions, autoType, useAlias;
1659 unsigned types[XkbNumKbdGroups];
1660 union xkb_action *outActs;
1661 unsigned int symIndex = 0;
1663 useAlias = (start_from == 0);
1665 key = FindNamedKey(keymap, keyi->name, useAlias,
1666 CreateKeyNames(keymap), start_from);
1668 if (start_from == 0 && warningLevel >= 5) {
1669 WARN("Key %s not found in keycodes\n", longText(keyi->name));
1670 ACTION("Symbols ignored\n");
1674 kc = XkbKeyGetKeycode(keymap, key);
1676 haveActions = false;
1678 for (i = nGroups = 0; i < XkbNumKbdGroups; i++) {
1679 if (((i + 1) > nGroups)
1680 && (((keyi->symsDefined | keyi->actsDefined) & (1 << i))
1681 || (keyi->typesDefined) & (1 << i)))
1683 if (!darray_empty(keyi->acts[i]))
1686 /* Assign the type to the key, if it is missing. */
1687 if (keyi->types[i] == XKB_ATOM_NONE) {
1688 if (keyi->dfltType != XKB_ATOM_NONE)
1689 keyi->types[i] = keyi->dfltType;
1690 else if (FindAutomaticType(keymap, keyi->numLevels[i],
1691 darray_mem(keyi->syms[i], 0),
1692 &keyi->types[i], &autoType)) { }
1694 if (warningLevel >= 5) {
1695 WARN("No automatic type for %d symbols\n",
1696 keyi->numLevels[i]);
1697 ACTION("Using %s for the %s key (keycode %d)\n",
1698 xkb_atom_text(keymap->ctx, keyi->types[i]),
1699 longText(keyi->name), kc);
1703 if (FindNamedType(keymap, keyi->types[i], &types[i])) {
1704 if (!autoType || keyi->numLevels[i] > 2)
1705 key->explicit |= (1 << i);
1708 if (warningLevel >= 3) {
1709 WARN("Type \"%s\" is not defined\n",
1710 xkb_atom_text(keymap->ctx, keyi->types[i]));
1711 ACTION("Using TWO_LEVEL for the %s key (keycode %d)\n",
1712 longText(keyi->name), kc);
1714 types[i] = XkbTwoLevelIndex;
1716 /* if the type specifies fewer levels than the key has, shrink the key */
1717 type = &darray_item(keymap->types, types[i]);
1718 if (type->num_levels < keyi->numLevels[i]) {
1719 if (warningLevel > 0) {
1720 WARN("Type \"%s\" has %d levels, but %s has %d symbols\n",
1721 type->name, type->num_levels,
1722 xkb_atom_text(keymap->ctx, keyi->name), keyi->numLevels[i]);
1723 ACTION("Ignoring extra symbols\n");
1725 keyi->numLevels[i] = type->num_levels;
1727 if (keyi->numLevels[i] > width)
1728 width = keyi->numLevels[i];
1729 if (type->num_levels > width)
1730 width = type->num_levels;
1731 sizeSyms += darray_size(keyi->syms[i]);
1734 darray_resize0(key->syms, sizeSyms);
1737 outActs = XkbcResizeKeyActions(keymap, key, width * nGroups);
1738 if (outActs == NULL) {
1739 WSGO("Could not enlarge actions for %s (key %d)\n",
1740 longText(keyi->name), kc);
1743 key->explicit |= XkbExplicitInterpretMask;
1748 key->num_groups = nGroups;
1749 if (keyi->defined & _Key_GroupInfo) {
1750 key->out_of_range_group_number = keyi->out_of_range_group_number;
1751 key->out_of_range_group_action = keyi->out_of_range_group_action;
1754 key->sym_index = calloc(nGroups * width, sizeof(*key->sym_index));
1755 key->num_syms = calloc(nGroups * width, sizeof(*key->num_syms));
1757 for (i = 0; i < nGroups; i++) {
1758 /* assign kt_index[i] to the index of the type in map->types.
1759 * kt_index[i] may have been set by a previous run (if we have two
1760 * layouts specified). Let's not overwrite it with the ONE_LEVEL
1761 * default group if we dont even have keys for this group anyway.
1763 * FIXME: There should be a better fix for this.
1765 if (keyi->numLevels[i])
1766 key->kt_index[i] = types[i];
1767 if (!darray_empty(keyi->syms[i])) {
1768 /* fill key to "width" symbols*/
1769 for (tmp = 0; tmp < width; tmp++) {
1770 if (tmp < keyi->numLevels[i] &&
1771 darray_item(keyi->symsMapNumEntries[i], tmp) != 0) {
1772 memcpy(darray_mem(key->syms, symIndex),
1773 darray_mem(keyi->syms[i],
1774 darray_item(keyi->symsMapIndex[i], tmp)),
1775 darray_item(keyi->symsMapNumEntries[i],
1776 tmp) * sizeof(xkb_keysym_t));
1777 key->sym_index[(i * width) + tmp] = symIndex;
1778 key->num_syms[(i * width) + tmp] =
1779 darray_item(keyi->symsMapNumEntries[i], tmp);
1780 symIndex += key->num_syms[(i * width) + tmp];
1783 key->sym_index[(i * width) + tmp] = -1;
1784 key->num_syms[(i * width) + tmp] = 0;
1786 if (outActs != NULL && !darray_empty(keyi->acts[i])) {
1787 if (tmp < keyi->numLevels[i])
1788 outActs[tmp] = darray_item(keyi->acts[i], tmp);
1790 outActs[tmp].type = XkbSA_NoAction;
1795 switch (keyi->behavior.type & XkbKB_OpMask) {
1800 key->behavior = keyi->behavior;
1801 key->explicit |= XkbExplicitBehaviorMask;
1804 if (keyi->defined & _Key_VModMap) {
1805 key->vmodmap = keyi->vmodmap;
1806 key->explicit |= XkbExplicitVModMapMask;
1808 if (keyi->repeat != RepeatUndefined) {
1809 key->repeats = keyi->repeat == RepeatYes;
1810 key->explicit |= XkbExplicitAutoRepeatMask;
1813 /* do the same thing for the next key */
1814 CopySymbolsDef(keymap, keyi, kc + 1);
1819 CopyModMapDef(struct xkb_keymap *keymap, ModMapEntry *entry)
1821 struct xkb_key *key;
1823 if (!entry->haveSymbol) {
1824 key = FindNamedKey(keymap, entry->u.keyName, true,
1825 CreateKeyNames(keymap), 0);
1827 if (warningLevel >= 5) {
1828 WARN("Key %s not found in keycodes\n",
1829 longText(entry->u.keyName));
1830 ACTION("Modifier map entry for %s not updated\n",
1831 XkbcModIndexText(entry->modifier));
1837 key = FindKeyForSymbol(keymap, entry->u.keySym);
1839 if (warningLevel > 5) {
1840 WARN("Key \"%s\" not found in symbol map\n",
1841 XkbcKeysymText(entry->u.keySym));
1842 ACTION("Modifier map entry for %s not updated\n",
1843 XkbcModIndexText(entry->modifier));
1849 key->modmap |= (1 << entry->modifier);
1854 * Handle the xkb_symbols section of an xkb file.
1856 * @param file The parsed xkb_symbols section of the xkb file.
1857 * @param keymap Handle to the keyboard description to store the symbols in.
1858 * @param merge Merge strategy (e.g. MERGE_OVERRIDE).
1861 CompileSymbols(XkbFile *file, struct xkb_keymap *keymap,
1862 enum merge_mode merge)
1864 xkb_group_index_t i;
1865 struct xkb_key *key;
1870 InitSymbolsInfo(&info, keymap, file->id);
1871 info.dflt.merge = merge;
1873 HandleSymbolsFile(&info, file, merge);
1875 if (darray_empty(info.keys))
1878 if (info.errorCount != 0)
1881 darray_resize0(keymap->acts, darray_size(keymap->acts) + 32 + 1);
1884 keymap->symbols_section_name = strdup(info.name);
1886 for (i = 0; i < XkbNumKbdGroups; i++) {
1887 if (info.groupNames[i] != XKB_ATOM_NONE) {
1888 free(keymap->group_names[i]);
1889 keymap->group_names[i] = xkb_atom_strdup(keymap->ctx,
1890 info.groupNames[i]);
1895 darray_foreach(keyi, info.keys)
1896 PrepareKeyDef(keyi);
1899 darray_foreach(keyi, info.keys)
1900 if (!CopySymbolsDef(keymap, keyi, 0))
1903 if (warningLevel > 3) {
1904 xkb_foreach_key(key, keymap) {
1905 if (key->name[0] == '\0')
1908 if (key->num_groups < 1)
1909 WARN("No symbols defined for <%.4s> (keycode %d)\n",
1910 key->name, XkbKeyGetKeycode(keymap, key));
1914 list_foreach(mm, &info.modMaps, entry)
1915 if (!CopyModMapDef(keymap, mm))
1918 FreeSymbolsInfo(&info);
1922 FreeSymbolsInfo(&info);