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 uint8_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 unsigned 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, unsigned int 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, unsigned 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 %d 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 %d, 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 use_new_field(unsigned field, short old_defined, unsigned old_file_id,
487 short new_defined, unsigned new_file_id, enum merge_mode new_merge,
490 if (!(old_defined & field))
493 if (new_defined & field) {
494 if ((old_file_id == new_file_id && warningLevel > 0) || warningLevel > 9)
497 if (new_merge != MERGE_AUGMENT)
505 MergeKeys(SymbolsInfo *info, struct xkb_keymap *keymap,
506 KeyInfo *into, KeyInfo *from)
509 unsigned collide = 0;
512 if (from->merge == MERGE_REPLACE) {
513 for (i = 0; i < XkbNumKbdGroups; i++) {
514 if (into->numLevels[i] != 0) {
515 darray_free(into->syms[i]);
516 darray_free(into->acts[i]);
520 memset(from, 0, sizeof(KeyInfo));
523 report = ((warningLevel > 9) ||
524 ((into->file_id == from->file_id)
525 && (warningLevel > 0)));
526 for (i = 0; i < XkbNumKbdGroups; i++) {
527 if (from->numLevels[i] > 0) {
528 if (into->numLevels[i] == 0) {
529 into->numLevels[i] = from->numLevels[i];
530 into->syms[i] = from->syms[i];
531 into->symsMapIndex[i] = from->symsMapIndex[i];
532 into->symsMapNumEntries[i] = from->symsMapNumEntries[i];
533 into->acts[i] = from->acts[i];
534 into->symsDefined |= (1 << i);
535 darray_init(from->syms[i]);
536 darray_init(from->symsMapIndex[i]);
537 darray_init(from->symsMapNumEntries[i]);
538 darray_init(from->acts[i]);
539 from->numLevels[i] = 0;
540 from->symsDefined &= ~(1 << i);
541 if (!darray_empty(into->syms[i]))
542 into->defined |= _Key_Syms;
543 if (!darray_empty(into->acts[i]))
544 into->defined |= _Key_Acts;
548 if (!darray_empty(into->syms[i]))
549 collide |= _Key_Syms;
550 if (!darray_empty(into->acts[i]))
551 collide |= _Key_Acts;
553 MergeKeyGroups(info, into, from, (unsigned) i);
556 if (from->types[i] != XKB_ATOM_NONE) {
557 if ((into->types[i] != XKB_ATOM_NONE) && report &&
558 (into->types[i] != from->types[i])) {
559 xkb_atom_t use, ignore;
560 collide |= _Key_Types;
561 if (from->merge != MERGE_AUGMENT) {
562 use = from->types[i];
563 ignore = into->types[i];
566 use = into->types[i];
567 ignore = from->types[i];
570 ("Multiple definitions for group %d type of key %s\n",
571 i, longText(into->name));
572 ACTION("Using %s, ignoring %s\n",
573 xkb_atom_text(keymap->ctx, use),
574 xkb_atom_text(keymap->ctx, ignore));
576 if (from->merge != MERGE_AUGMENT ||
577 into->types[i] == XKB_ATOM_NONE) {
578 into->types[i] = from->types[i];
582 if (use_new_field(_Key_Behavior, into->defined, into->file_id,
583 from->defined, from->file_id, from->merge, &collide)) {
584 into->behavior = from->behavior;
585 into->defined |= _Key_Behavior;
587 if (use_new_field(_Key_VModMap, into->defined, into->file_id,
588 from->defined, from->file_id, from->merge, &collide)) {
589 into->vmodmap = from->vmodmap;
590 into->defined |= _Key_VModMap;
592 if (use_new_field(_Key_Repeat, into->defined, into->file_id,
593 from->defined, from->file_id, from->merge, &collide)) {
594 into->repeat = from->repeat;
595 into->defined |= _Key_Repeat;
597 if (use_new_field(_Key_Type_Dflt, into->defined, into->file_id,
598 from->defined, from->file_id, from->merge, &collide)) {
599 into->dfltType = from->dfltType;
600 into->defined |= _Key_Type_Dflt;
602 if (use_new_field(_Key_GroupInfo, into->defined, into->file_id,
603 from->defined, from->file_id, from->merge, &collide)) {
604 into->out_of_range_group_action = from->out_of_range_group_action;
605 into->out_of_range_group_number = from->out_of_range_group_number;
606 into->defined |= _Key_GroupInfo;
609 WARN("Symbol map for key %s redefined\n",
610 longText(into->name));
611 ACTION("Using %s definition for conflicting fields\n",
612 (from->merge == MERGE_AUGMENT ? "first" : "last"));
618 AddKeySymbols(SymbolsInfo *info, KeyInfo *keyi, struct xkb_keymap *keymap)
620 unsigned long real_name;
623 darray_foreach(iter, info->keys)
624 if (iter->name == keyi->name)
625 return MergeKeys(info, keymap, iter, keyi);
627 if (FindKeyNameForAlias(keymap, keyi->name, &real_name))
628 darray_foreach(iter, info->keys)
629 if (iter->name == real_name)
630 return MergeKeys(info, keymap, iter, keyi);
632 darray_resize0(info->keys, darray_size(info->keys) + 1);
633 new = &darray_item(info->keys, darray_size(info->keys) - 1);
634 return CopyKeyInfo(keyi, new, true);
638 AddModMapEntry(SymbolsInfo * info, ModMapEntry * new)
643 clobber = (new->merge != MERGE_AUGMENT);
644 list_foreach(mm, &info->modMaps, entry) {
645 if (new->haveSymbol && mm->haveSymbol
646 && (new->u.keySym == mm->u.keySym)) {
647 unsigned use, ignore;
648 if (mm->modifier != new->modifier) {
651 ignore = mm->modifier;
655 ignore = new->modifier;
658 ("%s added to symbol map for multiple modifiers\n",
659 XkbcKeysymText(new->u.keySym));
660 ACTION("Using %s, ignoring %s.\n",
661 XkbcModIndexText(use),
662 XkbcModIndexText(ignore));
667 if ((!new->haveSymbol) && (!mm->haveSymbol) &&
668 (new->u.keyName == mm->u.keyName)) {
669 unsigned use, ignore;
670 if (mm->modifier != new->modifier) {
673 ignore = mm->modifier;
677 ignore = new->modifier;
679 ERROR("Key %s added to map for multiple modifiers\n",
680 longText(new->u.keyName));
681 ACTION("Using %s, ignoring %s.\n",
682 XkbcModIndexText(use),
683 XkbcModIndexText(ignore));
690 mm = malloc(sizeof(*mm));
692 WSGO("Could not allocate modifier map entry\n");
693 ACTION("Modifier map for %s will be incomplete\n",
694 XkbcModIndexText(new->modifier));
699 list_add(&mm->entry, &info->modMaps);
703 /***====================================================================***/
706 MergeIncludedSymbols(SymbolsInfo *into, SymbolsInfo *from,
707 enum merge_mode merge, struct xkb_keymap *keymap)
711 ModMapEntry *mm, *next;
713 if (from->errorCount > 0) {
714 into->errorCount += from->errorCount;
717 if (into->name == NULL) {
718 into->name = from->name;
721 for (i = 0; i < XkbNumKbdGroups; i++) {
722 if (from->groupNames[i] != XKB_ATOM_NONE) {
723 if ((merge != MERGE_AUGMENT) ||
724 (into->groupNames[i] == XKB_ATOM_NONE))
725 into->groupNames[i] = from->groupNames[i];
729 darray_foreach(keyi, from->keys) {
730 if (merge != MERGE_DEFAULT)
733 if (!AddKeySymbols(into, keyi, keymap))
737 list_foreach_safe(mm, next, &from->modMaps, entry) {
738 if (merge != MERGE_DEFAULT)
740 if (!AddModMapEntry(into, mm))
744 list_init(&from->modMaps);
748 HandleSymbolsFile(XkbFile *file, struct xkb_keymap *keymap,
749 enum merge_mode merge,
753 HandleIncludeSymbols(IncludeStmt *stmt, struct xkb_keymap *keymap,
756 enum merge_mode newMerge;
758 SymbolsInfo included;
762 if ((stmt->file == NULL) && (stmt->map == NULL)) {
765 memset(info, 0, sizeof(SymbolsInfo));
767 else if (ProcessIncludeFile(keymap->ctx, stmt, FILE_TYPE_SYMBOLS, &rtrn,
769 InitSymbolsInfo(&included, keymap, rtrn->id);
770 included.merge = included.dflt.merge = MERGE_OVERRIDE;
772 included.explicit_group = atoi(stmt->modifier) - 1;
774 included.explicit_group = info->explicit_group;
775 HandleSymbolsFile(rtrn, keymap, MERGE_OVERRIDE, &included);
776 if (stmt->stmt != NULL) {
778 included.name = stmt->stmt;
784 info->errorCount += 10;
787 if ((stmt->next != NULL) && (included.errorCount < 1)) {
790 SymbolsInfo next_incl;
792 for (next = stmt->next; next != NULL; next = next->next) {
793 if ((next->file == NULL) && (next->map == NULL)) {
795 MergeIncludedSymbols(&included, info, next->merge, keymap);
796 FreeSymbolsInfo(info);
798 else if (ProcessIncludeFile(keymap->ctx, next, FILE_TYPE_SYMBOLS,
800 InitSymbolsInfo(&next_incl, keymap, rtrn->id);
801 next_incl.merge = next_incl.dflt.merge = MERGE_OVERRIDE;
803 next_incl.explicit_group = atoi(next->modifier) - 1;
805 next_incl.explicit_group = info->explicit_group;
806 HandleSymbolsFile(rtrn, keymap, MERGE_OVERRIDE, &next_incl);
807 MergeIncludedSymbols(&included, &next_incl, op, keymap);
808 FreeSymbolsInfo(&next_incl);
812 info->errorCount += 10;
813 FreeSymbolsInfo(&included);
818 else if (stmt->next) {
819 info->errorCount += included.errorCount;
824 MergeIncludedSymbols(info, &included, newMerge, keymap);
825 FreeSymbolsInfo(&included);
827 return (info->errorCount == 0);
834 GetGroupIndex(KeyInfo *keyi, struct xkb_keymap *keymap,
835 ExprDef * arrayNdx, unsigned what, unsigned *ndx_rtrn)
845 if (arrayNdx == NULL) {
849 defined = keyi->symsDefined;
851 defined = keyi->actsDefined;
853 for (i = 0; i < XkbNumKbdGroups; i++) {
854 if ((defined & (1 << i)) == 0) {
859 ERROR("Too many groups of %s for key %s (max %d)\n", name,
860 longText(keyi->name), XkbNumKbdGroups + 1);
861 ACTION("Ignoring %s defined for extra groups\n", name);
864 if (!ExprResolveGroup(keymap->ctx, arrayNdx, &tmp)) {
865 ERROR("Illegal group index for %s of key %s\n", name,
866 longText(keyi->name));
867 ACTION("Definition with non-integer array index ignored\n");
870 *ndx_rtrn = tmp.uval - 1;
875 AddSymbolsToKey(KeyInfo *keyi, struct xkb_keymap *keymap,
876 ExprDef *arrayNdx, ExprDef *value, SymbolsInfo *info)
878 unsigned ndx, nSyms, nLevels;
882 if (!GetGroupIndex(keyi, keymap, arrayNdx, SYMBOLS, &ndx))
885 keyi->symsDefined |= (1 << ndx);
888 if (value->op != ExprKeysymList) {
889 ERROR("Expected a list of symbols, found %s\n", exprOpText(value->op));
890 ACTION("Ignoring symbols for group %d of %s\n", ndx + 1,
891 longText(keyi->name));
894 if (!darray_empty(keyi->syms[ndx])) {
895 ERROR("Symbols for key %s, group %d already defined\n",
896 longText(keyi->name), ndx + 1);
897 ACTION("Ignoring duplicate definition\n");
900 nSyms = darray_size(value->value.list.syms);
901 nLevels = darray_size(value->value.list.symsMapIndex);
902 if ((keyi->numLevels[ndx] < nSyms || darray_empty(keyi->syms[ndx])) &&
903 (!ResizeKeyGroup(keyi, ndx, nLevels, nSyms, false))) {
904 WSGO("Could not resize group %d of key %s to contain %d levels\n",
905 ndx + 1, longText(keyi->name), nSyms);
906 ACTION("Symbols lost\n");
909 keyi->symsDefined |= (1 << ndx);
910 for (i = 0; i < nLevels; i++) {
911 darray_item(keyi->symsMapIndex[ndx], i) =
912 darray_item(value->value.list.symsMapIndex, i);
913 darray_item(keyi->symsMapNumEntries[ndx], i) =
914 darray_item(value->value.list.symsNumEntries, i);
916 for (j = 0; j < darray_item(keyi->symsMapNumEntries[ndx], i); j++) {
917 /* FIXME: What's abort() doing here? */
918 if (darray_item(keyi->symsMapIndex[ndx], i) + j >= nSyms)
920 if (!LookupKeysym(darray_item(value->value.list.syms,
921 darray_item(value->value.list.symsMapIndex,
923 &darray_item(keyi->syms[ndx],
924 darray_item(keyi->symsMapIndex[ndx],
927 "Could not resolve keysym %s for key %s, group %d (%s), level %d\n",
928 darray_item(value->value.list.syms, i),
929 longText(keyi->name),
931 xkb_atom_text(keymap->ctx, info->groupNames[ndx]), nSyms);
933 darray_item(keyi->syms[ndx],
934 darray_item(keyi->symsMapIndex[ndx],
935 i) + j) = XKB_KEY_NoSymbol;
936 darray_item(keyi->symsMapIndex[ndx], i) = -1;
937 darray_item(keyi->symsMapNumEntries[ndx], i) = 0;
940 if (darray_item(keyi->symsMapNumEntries[ndx], i) == 1 &&
941 darray_item(keyi->syms[ndx],
942 darray_item(keyi->symsMapIndex[ndx],
943 i) + j) == XKB_KEY_NoSymbol) {
944 darray_item(keyi->symsMapIndex[ndx], i) = -1;
945 darray_item(keyi->symsMapNumEntries[ndx], i) = 0;
949 for (j = keyi->numLevels[ndx] - 1;
950 j >= 0 && darray_item(keyi->symsMapNumEntries[ndx], j) == 0; j--)
951 keyi->numLevels[ndx]--;
956 AddActionsToKey(KeyInfo *keyi, struct xkb_keymap *keymap, ExprDef *arrayNdx,
957 ExprDef *value, SymbolsInfo *info)
962 struct xkb_any_action *toAct;
964 if (!GetGroupIndex(keyi, keymap, arrayNdx, ACTIONS, &ndx))
968 keyi->actsDefined |= (1 << ndx);
971 if (value->op != ExprActionList) {
972 WSGO("Bad expression type (%d) for action list value\n", value->op);
973 ACTION("Ignoring actions for group %d of %s\n", ndx,
974 longText(keyi->name));
977 if (!darray_empty(keyi->acts[ndx])) {
978 WSGO("Actions for key %s, group %d already defined\n",
979 longText(keyi->name), ndx);
982 for (nActs = 0, act = value->value.child; act != NULL; nActs++) {
983 act = (ExprDef *) act->common.next;
986 WSGO("Action list but not actions in AddActionsToKey\n");
989 if ((keyi->numLevels[ndx] < nActs || darray_empty(keyi->acts[ndx])) &&
990 !ResizeKeyGroup(keyi, ndx, nActs, nActs, true)) {
991 WSGO("Could not resize group %d of key %s\n", ndx,
992 longText(keyi->name));
993 ACTION("Actions lost\n");
996 keyi->actsDefined |= (1 << ndx);
998 toAct = (struct xkb_any_action *) darray_mem(keyi->acts[ndx], 0);
999 act = value->value.child;
1000 for (i = 0; i < nActs; i++, toAct++) {
1001 if (!HandleActionDef(act, keymap, toAct, info->action)) {
1002 ERROR("Illegal action definition for %s\n",
1003 longText(keyi->name));
1004 ACTION("Action for group %d/level %d ignored\n", ndx + 1, i + 1);
1006 act = (ExprDef *) act->common.next;
1011 static const LookupEntry lockingEntries[] = {
1012 { "true", XkbKB_Lock },
1013 { "yes", XkbKB_Lock },
1014 { "on", XkbKB_Lock },
1015 { "false", XkbKB_Default },
1016 { "no", XkbKB_Default },
1017 { "off", XkbKB_Default },
1018 { "permanent", XkbKB_Lock | XkbKB_Permanent },
1022 static const LookupEntry repeatEntries[] = {
1023 { "true", RepeatYes },
1024 { "yes", RepeatYes },
1025 { "on", RepeatYes },
1026 { "false", RepeatNo },
1028 { "off", RepeatNo },
1029 { "default", RepeatUndefined },
1034 SetSymbolsField(KeyInfo *keyi, struct xkb_keymap *keymap, char *field,
1035 ExprDef *arrayNdx, ExprDef *value, SymbolsInfo *info)
1040 if (strcasecmp(field, "type") == 0) {
1042 if ((!ExprResolveString(keymap->ctx, value, &tmp))
1043 && (warningLevel > 0)) {
1044 WARN("The type field of a key symbol map must be a string\n");
1045 ACTION("Ignoring illegal type definition\n");
1047 if (arrayNdx == NULL) {
1048 keyi->dfltType = xkb_atom_intern(keymap->ctx, tmp.str);
1049 keyi->defined |= _Key_Type_Dflt;
1051 else if (!ExprResolveGroup(keymap->ctx, arrayNdx, &ndx)) {
1052 ERROR("Illegal group index for type of key %s\n",
1053 longText(keyi->name));
1054 ACTION("Definition with non-integer array index ignored\n");
1059 keyi->types[ndx.uval - 1] = xkb_atom_intern(keymap->ctx, tmp.str);
1060 keyi->typesDefined |= (1 << (ndx.uval - 1));
1064 else if (strcasecmp(field, "symbols") == 0)
1065 return AddSymbolsToKey(keyi, keymap, arrayNdx, value, info);
1066 else if (strcasecmp(field, "actions") == 0)
1067 return AddActionsToKey(keyi, keymap, arrayNdx, value, info);
1068 else if ((strcasecmp(field, "vmods") == 0) ||
1069 (strcasecmp(field, "virtualmods") == 0) ||
1070 (strcasecmp(field, "virtualmodifiers") == 0)) {
1071 ok = ExprResolveVModMask(value, &tmp, keymap);
1073 keyi->vmodmap = (tmp.uval >> 8);
1074 keyi->defined |= _Key_VModMap;
1077 ERROR("Expected a virtual modifier mask, found %s\n",
1078 exprOpText(value->op));
1079 ACTION("Ignoring virtual modifiers definition for key %s\n",
1080 longText(keyi->name));
1083 else if ((strcasecmp(field, "locking") == 0) ||
1084 (strcasecmp(field, "lock") == 0) ||
1085 (strcasecmp(field, "locks") == 0)) {
1086 ok = ExprResolveEnum(keymap->ctx, value, &tmp, lockingEntries);
1088 keyi->behavior.type = tmp.uval;
1089 keyi->defined |= _Key_Behavior;
1091 else if ((strcasecmp(field, "radiogroup") == 0) ||
1092 (strcasecmp(field, "permanentradiogroup") == 0) ||
1093 (strcasecmp(field, "allownone") == 0)) {
1094 ERROR("Radio groups not supported\n");
1095 ACTION("Ignoring radio group specification for key %s\n",
1096 longText(keyi->name));
1099 else if (uStrCasePrefix("overlay", field) ||
1100 uStrCasePrefix("permanentoverlay", field)) {
1101 ERROR("Overlays not supported\n");
1102 ACTION("Ignoring overlay specification for key %s\n",
1103 longText(keyi->name));
1105 else if ((strcasecmp(field, "repeating") == 0) ||
1106 (strcasecmp(field, "repeats") == 0) ||
1107 (strcasecmp(field, "repeat") == 0)) {
1108 ok = ExprResolveEnum(keymap->ctx, value, &tmp, repeatEntries);
1110 ERROR("Illegal repeat setting for %s\n",
1111 longText(keyi->name));
1112 ACTION("Non-boolean repeat setting ignored\n");
1115 keyi->repeat = tmp.uval;
1116 keyi->defined |= _Key_Repeat;
1118 else if ((strcasecmp(field, "groupswrap") == 0) ||
1119 (strcasecmp(field, "wrapgroups") == 0)) {
1120 ok = ExprResolveBoolean(keymap->ctx, value, &tmp);
1122 ERROR("Illegal groupsWrap setting for %s\n",
1123 longText(keyi->name));
1124 ACTION("Non-boolean value ignored\n");
1128 keyi->out_of_range_group_action = XkbWrapIntoRange;
1130 keyi->out_of_range_group_action = XkbClampIntoRange;
1131 keyi->defined |= _Key_GroupInfo;
1133 else if ((strcasecmp(field, "groupsclamp") == 0) ||
1134 (strcasecmp(field, "clampgroups") == 0)) {
1135 ok = ExprResolveBoolean(keymap->ctx, value, &tmp);
1137 ERROR("Illegal groupsClamp setting for %s\n",
1138 longText(keyi->name));
1139 ACTION("Non-boolean value ignored\n");
1143 keyi->out_of_range_group_action = XkbClampIntoRange;
1145 keyi->out_of_range_group_action = XkbWrapIntoRange;
1146 keyi->defined |= _Key_GroupInfo;
1148 else if ((strcasecmp(field, "groupsredirect") == 0) ||
1149 (strcasecmp(field, "redirectgroups") == 0)) {
1150 if (!ExprResolveGroup(keymap->ctx, value, &tmp)) {
1151 ERROR("Illegal group index for redirect of key %s\n",
1152 longText(keyi->name));
1153 ACTION("Definition with non-integer group ignored\n");
1156 keyi->out_of_range_group_action = XkbRedirectIntoRange;
1157 keyi->out_of_range_group_number = tmp.uval - 1;
1158 keyi->defined |= _Key_GroupInfo;
1161 ERROR("Unknown field %s in a symbol interpretation\n", field);
1162 ACTION("Definition ignored\n");
1169 SetGroupName(SymbolsInfo *info, struct xkb_keymap *keymap, ExprDef *arrayNdx,
1172 ExprResult tmp, name;
1174 if ((arrayNdx == NULL) && (warningLevel > 0)) {
1175 WARN("You must specify an index when specifying a group name\n");
1176 ACTION("Group name definition without array subscript ignored\n");
1179 if (!ExprResolveGroup(keymap->ctx, arrayNdx, &tmp)) {
1180 ERROR("Illegal index in group name definition\n");
1181 ACTION("Definition with non-integer array index ignored\n");
1184 if (!ExprResolveString(keymap->ctx, value, &name)) {
1185 ERROR("Group name must be a string\n");
1186 ACTION("Illegal name for group %d ignored\n", tmp.uval);
1189 info->groupNames[tmp.uval - 1 + info->explicit_group] =
1190 xkb_atom_intern(keymap->ctx, name.str);
1197 HandleSymbolsVar(VarDef *stmt, struct xkb_keymap *keymap, SymbolsInfo *info)
1199 ExprResult elem, field;
1203 if (ExprResolveLhs(keymap, stmt->name, &elem, &field, &arrayNdx) == 0)
1204 return 0; /* internal error, already reported */
1205 if (elem.str && (strcasecmp(elem.str, "key") == 0)) {
1206 ret = SetSymbolsField(&info->dflt, keymap, field.str, arrayNdx,
1209 else if ((elem.str == NULL) && ((strcasecmp(field.str, "name") == 0) ||
1210 (strcasecmp(field.str, "groupname") ==
1212 ret = SetGroupName(info, keymap, arrayNdx, stmt->value);
1214 else if ((elem.str == NULL)
1215 && ((strcasecmp(field.str, "groupswrap") == 0) ||
1216 (strcasecmp(field.str, "wrapgroups") == 0))) {
1217 ERROR("Global \"groupswrap\" not supported\n");
1218 ACTION("Ignored\n");
1221 else if ((elem.str == NULL)
1222 && ((strcasecmp(field.str, "groupsclamp") == 0) ||
1223 (strcasecmp(field.str, "clampgroups") == 0))) {
1224 ERROR("Global \"groupsclamp\" not supported\n");
1225 ACTION("Ignored\n");
1228 else if ((elem.str == NULL)
1229 && ((strcasecmp(field.str, "groupsredirect") == 0) ||
1230 (strcasecmp(field.str, "redirectgroups") == 0))) {
1231 ERROR("Global \"groupsredirect\" not supported\n");
1232 ACTION("Ignored\n");
1235 else if ((elem.str == NULL) &&
1236 (strcasecmp(field.str, "allownone") == 0)) {
1237 ERROR("Radio groups not supported\n");
1238 ACTION("Ignoring \"allownone\" specification\n");
1242 ret = SetActionField(keymap, elem.str, field.str, arrayNdx,
1243 stmt->value, &info->action);
1252 HandleSymbolsBody(VarDef *def, struct xkb_keymap *keymap, KeyInfo *keyi,
1256 ExprResult tmp, field;
1259 for (; def != NULL; def = (VarDef *) def->common.next) {
1260 if ((def->name) && (def->name->type == ExprFieldRef)) {
1261 ok = HandleSymbolsVar(def, keymap, info);
1265 if (def->name == NULL) {
1266 if ((def->value == NULL)
1267 || (def->value->op == ExprKeysymList))
1268 field.str = strdup("symbols");
1270 field.str = strdup("actions");
1274 ok = ExprResolveLhs(keymap, def->name, &tmp, &field,
1278 ok = SetSymbolsField(keyi, keymap, field.str, arrayNdx,
1287 SetExplicitGroup(SymbolsInfo *info, KeyInfo *keyi)
1289 unsigned group = info->explicit_group;
1294 if ((keyi->typesDefined | keyi->symsDefined | keyi->actsDefined) & ~1) {
1296 WARN("For the map %s an explicit group specified\n", info->name);
1297 WARN("but key %s has more than one group defined\n",
1298 longText(keyi->name));
1299 ACTION("All groups except first one will be ignored\n");
1300 for (i = 1; i < XkbNumKbdGroups; i++) {
1301 keyi->numLevels[i] = 0;
1302 darray_free(keyi->syms[i]);
1303 darray_free(keyi->acts[i]);
1307 keyi->typesDefined = keyi->symsDefined = keyi->actsDefined = 1 << group;
1309 keyi->numLevels[group] = keyi->numLevels[0];
1310 keyi->numLevels[0] = 0;
1311 keyi->syms[group] = keyi->syms[0];
1312 darray_init(keyi->syms[0]);
1313 keyi->symsMapIndex[group] = keyi->symsMapIndex[0];
1314 darray_init(keyi->symsMapIndex[0]);
1315 keyi->symsMapNumEntries[group] = keyi->symsMapNumEntries[0];
1316 darray_init(keyi->symsMapNumEntries[0]);
1317 keyi->acts[group] = keyi->acts[0];
1318 darray_init(keyi->acts[0]);
1319 keyi->types[group] = keyi->types[0];
1325 HandleSymbolsDef(SymbolsDef *stmt, struct xkb_keymap *keymap,
1330 InitKeyInfo(&keyi, info->file_id);
1331 CopyKeyInfo(&info->dflt, &keyi, false);
1332 keyi.merge = stmt->merge;
1333 keyi.name = KeyNameToLong(stmt->keyName);
1334 if (!HandleSymbolsBody((VarDef *) stmt->symbols, keymap, &keyi, info)) {
1339 if (!SetExplicitGroup(info, &keyi)) {
1344 if (!AddKeySymbols(info, &keyi, keymap)) {
1352 HandleModMapDef(ModMapDef *def, struct xkb_keymap *keymap, SymbolsInfo *info)
1359 if (!LookupModIndex(keymap->ctx, NULL, def->modifier, TypeInt, &rtrn)) {
1360 ERROR("Illegal modifier map definition\n");
1361 ACTION("Ignoring map for non-modifier \"%s\"\n",
1362 xkb_atom_text(keymap->ctx, def->modifier));
1366 tmp.modifier = rtrn.uval;
1367 for (key = def->keys; key != NULL; key = (ExprDef *) key->common.next) {
1368 if ((key->op == ExprValue) && (key->type == TypeKeyName)) {
1369 tmp.haveSymbol = false;
1370 tmp.u.keyName = KeyNameToLong(key->value.keyName);
1372 else if (ExprResolveKeySym(keymap->ctx, key, &rtrn)) {
1373 tmp.haveSymbol = true;
1374 tmp.u.keySym = rtrn.uval;
1377 ERROR("Modmap entries may contain only key names or keysyms\n");
1378 ACTION("Illegal definition for %s modifier ignored\n",
1379 XkbcModIndexText(tmp.modifier));
1383 ok = AddModMapEntry(info, &tmp) && ok;
1389 HandleSymbolsFile(XkbFile *file, struct xkb_keymap *keymap,
1390 enum merge_mode merge, SymbolsInfo *info)
1395 info->name = uDupString(file->name);
1399 switch (stmt->stmtType) {
1401 if (!HandleIncludeSymbols((IncludeStmt *) stmt, keymap, info))
1404 case StmtSymbolsDef:
1405 if (!HandleSymbolsDef((SymbolsDef *) stmt, keymap, info))
1409 if (!HandleSymbolsVar((VarDef *) stmt, keymap, info))
1413 if (!HandleVModDef((VModDef *) stmt, keymap, merge, &info->vmods))
1417 ERROR("Interpretation files may not include other types\n");
1418 ACTION("Ignoring definition of symbol interpretation\n");
1421 case StmtKeycodeDef:
1422 ERROR("Interpretation files may not include other types\n");
1423 ACTION("Ignoring definition of key name\n");
1427 if (!HandleModMapDef((ModMapDef *) stmt, keymap, info))
1431 WSGO("Unexpected statement type %d in HandleSymbolsFile\n",
1436 if (info->errorCount > 10) {
1438 ERROR("Too many errors\n");
1440 ACTION("Abandoning symbols file \"%s\"\n", file->topName);
1447 * Given a keysym @sym, return a key which generates it, or NULL.
1448 * This is used for example in a modifier map definition, such as:
1449 * modifier_map Lock { Caps_Lock };
1450 * where we want to add the Lock modifier to the modmap of the key
1451 * which matches the keysym Caps_Lock.
1452 * Since there can be many keys which generates the keysym, the key
1453 * is chosen first by lowest group in which the keysym appears, than
1454 * by lowest level and than by lowest key code.
1456 static struct xkb_key *
1457 FindKeyForSymbol(struct xkb_keymap *keymap, xkb_keysym_t sym)
1459 struct xkb_key *key, *ret = NULL;
1460 unsigned int group, level, min_group = UINT_MAX, min_level = UINT_MAX;
1462 xkb_foreach_key(key, keymap) {
1463 for (group = 0; group < key->num_groups; group++) {
1464 for (level = 0; level < XkbKeyGroupWidth(keymap, key, group);
1466 if (XkbKeyNumSyms(key, group, level) != 1 ||
1467 (XkbKeySymEntry(key, group, level))[0] != sym)
1471 * If the keysym was found in a group or level > 0, we must
1472 * keep looking since we might find a key in which the keysym
1473 * is in a lower group or level.
1475 if (group < min_group ||
1476 (group == min_group && level < min_level)) {
1478 if (group == 0 && level == 0) {
1494 * Find the given name in the keymap->map->types and return its index.
1496 * @param atom The atom to search for.
1497 * @param type_rtrn Set to the index of the name if found.
1499 * @return true if found, false otherwise.
1502 FindNamedType(struct xkb_keymap *keymap, xkb_atom_t atom, unsigned *type_rtrn)
1505 const char *name = xkb_atom_text(keymap->ctx, atom);
1506 struct xkb_key_type *type;
1509 darray_foreach(type, keymap->types) {
1510 if (strcmp(type->name, name) == 0) {
1521 * Assign a type to the given sym and return the Atom for the type assigned.
1524 * - ONE_LEVEL for width 0/1
1525 * - ALPHABETIC for 2 shift levels, with lower/upercase
1526 * - KEYPAD for keypad keys.
1527 * - TWO_LEVEL for other 2 shift level keys.
1528 * and the same for four level keys.
1530 * @param width Number of sysms in syms.
1531 * @param syms The keysyms for the given key (must be size width).
1532 * @param typeNameRtrn Set to the Atom of the type name.
1534 * @returns true if a type could be found, false otherwise.
1536 * FIXME: I need to take the KeyInfo so I can look at symsMapIndex and
1537 * all that fun stuff rather than just assuming there's always one
1541 FindAutomaticType(struct xkb_keymap *keymap, int width,
1542 const xkb_keysym_t *syms, xkb_atom_t *typeNameRtrn,
1546 if ((width == 1) || (width == 0)) {
1547 *typeNameRtrn = xkb_atom_intern(keymap->ctx, "ONE_LEVEL");
1550 else if (width == 2) {
1551 if (syms && xkb_keysym_is_lower(syms[0]) &&
1552 xkb_keysym_is_upper(syms[1])) {
1553 *typeNameRtrn = xkb_atom_intern(keymap->ctx, "ALPHABETIC");
1555 else if (syms && (xkb_keysym_is_keypad(syms[0]) ||
1556 xkb_keysym_is_keypad(syms[1]))) {
1557 *typeNameRtrn = xkb_atom_intern(keymap->ctx, "KEYPAD");
1561 *typeNameRtrn = xkb_atom_intern(keymap->ctx, "TWO_LEVEL");
1565 else if (width <= 4) {
1566 if (syms && xkb_keysym_is_lower(syms[0]) &&
1567 xkb_keysym_is_upper(syms[1]))
1568 if (xkb_keysym_is_lower(syms[2]) && xkb_keysym_is_upper(syms[3]))
1570 xkb_atom_intern(keymap->ctx, "FOUR_LEVEL_ALPHABETIC");
1572 *typeNameRtrn = xkb_atom_intern(keymap->ctx,
1573 "FOUR_LEVEL_SEMIALPHABETIC");
1575 else if (syms && (xkb_keysym_is_keypad(syms[0]) ||
1576 xkb_keysym_is_keypad(syms[1])))
1577 *typeNameRtrn = xkb_atom_intern(keymap->ctx, "FOUR_LEVEL_KEYPAD");
1579 *typeNameRtrn = xkb_atom_intern(keymap->ctx, "FOUR_LEVEL");
1580 /* XXX: why not set autoType here? */
1582 return ((width >= 0) && (width <= 4));
1586 * Ensure the given KeyInfo is in a coherent state, i.e. no gaps between the
1587 * groups, and reduce to one group if all groups are identical anyway.
1590 PrepareKeyDef(KeyInfo *keyi)
1592 int i, j, width, defined, lastGroup;
1595 defined = keyi->symsDefined | keyi->actsDefined | keyi->typesDefined;
1596 /* get highest group number */
1597 for (i = XkbNumKbdGroups - 1; i >= 0; i--) {
1598 if (defined & (1 << i))
1606 /* If there are empty groups between non-empty ones fill them with data */
1607 /* from the first group. */
1608 /* We can make a wrong assumption here. But leaving gaps is worse. */
1609 for (i = lastGroup; i > 0; i--) {
1610 if (defined & (1 << i))
1612 width = keyi->numLevels[0];
1613 if (keyi->typesDefined & 1) {
1614 for (j = 0; j < width; j++) {
1615 keyi->types[i] = keyi->types[0];
1617 keyi->typesDefined |= 1 << i;
1619 if ((keyi->actsDefined & 1) && !darray_empty(keyi->acts[0])) {
1620 darray_copy(keyi->acts[i], keyi->acts[0]);
1621 keyi->actsDefined |= 1 << i;
1623 if ((keyi->symsDefined & 1) && !darray_empty(keyi->syms[0])) {
1624 darray_copy(keyi->syms[i], keyi->syms[0]);
1625 darray_copy(keyi->symsMapIndex[i], keyi->symsMapIndex[0]);
1626 darray_copy(keyi->symsMapNumEntries[i],
1627 keyi->symsMapNumEntries[0]);
1628 keyi->symsDefined |= 1 << i;
1631 keyi->numLevels[i] = keyi->numLevels[0];
1634 /* If all groups are completely identical remove them all */
1635 /* exept the first one. */
1637 for (i = lastGroup; i > 0; i--) {
1638 if ((keyi->numLevels[i] != keyi->numLevels[0]) ||
1639 (keyi->types[i] != keyi->types[0])) {
1643 if (!darray_same(keyi->syms[i], keyi->syms[0]) &&
1644 (darray_empty(keyi->syms[i]) || darray_empty(keyi->syms[0]) ||
1645 darray_size(keyi->syms[i]) != darray_size(keyi->syms[0]) ||
1646 memcmp(darray_mem(keyi->syms[i], 0),
1647 darray_mem(keyi->syms[0], 0),
1648 sizeof(xkb_keysym_t) * darray_size(keyi->syms[0])))) {
1652 if (!darray_same(keyi->symsMapIndex[i], keyi->symsMapIndex[0]) &&
1653 (darray_empty(keyi->symsMapIndex[i]) ||
1654 darray_empty(keyi->symsMapIndex[0]) ||
1655 memcmp(darray_mem(keyi->symsMapIndex[i], 0),
1656 darray_mem(keyi->symsMapIndex[0], 0),
1657 keyi->numLevels[0] * sizeof(int)))) {
1661 if (!darray_same(keyi->symsMapNumEntries[i],
1662 keyi->symsMapNumEntries[0]) &&
1663 (darray_empty(keyi->symsMapNumEntries[i]) ||
1664 darray_empty(keyi->symsMapNumEntries[0]) ||
1665 memcmp(darray_mem(keyi->symsMapNumEntries[i], 0),
1666 darray_mem(keyi->symsMapNumEntries[0], 0),
1667 keyi->numLevels[0] * sizeof(size_t)))) {
1671 if (!darray_same(keyi->acts[i], keyi->acts[0]) &&
1672 (darray_empty(keyi->acts[i]) || darray_empty(keyi->acts[0]) ||
1673 memcmp(darray_mem(keyi->acts[i], 0),
1674 darray_mem(keyi->acts[0], 0),
1675 keyi->numLevels[0] * sizeof(union xkb_action)))) {
1681 for (i = lastGroup; i > 0; i--) {
1682 keyi->numLevels[i] = 0;
1683 darray_free(keyi->syms[i]);
1684 darray_free(keyi->symsMapIndex[i]);
1685 darray_free(keyi->symsMapNumEntries[i]);
1686 darray_free(keyi->acts[i]);
1689 keyi->symsDefined &= 1;
1690 keyi->actsDefined &= 1;
1691 keyi->typesDefined &= 1;
1696 * Copy the KeyInfo into the keyboard description.
1698 * This function recurses.
1701 CopySymbolsDef(struct xkb_keymap *keymap, KeyInfo *keyi, int start_from)
1705 struct xkb_key *key;
1706 unsigned int sizeSyms = 0;
1707 unsigned width, tmp, nGroups;
1708 struct xkb_key_type * type;
1709 bool haveActions, autoType, useAlias;
1710 unsigned types[XkbNumKbdGroups];
1711 union xkb_action *outActs;
1712 unsigned int symIndex = 0;
1714 useAlias = (start_from == 0);
1716 key = FindNamedKey(keymap, keyi->name, useAlias,
1717 CreateKeyNames(keymap), start_from);
1719 if (start_from == 0 && warningLevel >= 5) {
1720 WARN("Key %s not found in keycodes\n", longText(keyi->name));
1721 ACTION("Symbols ignored\n");
1725 kc = XkbKeyGetKeycode(keymap, key);
1727 haveActions = false;
1728 for (i = width = nGroups = 0; i < XkbNumKbdGroups; i++) {
1729 if (((i + 1) > nGroups)
1730 && (((keyi->symsDefined | keyi->actsDefined) & (1 << i))
1731 || (keyi->typesDefined) & (1 << i)))
1733 if (!darray_empty(keyi->acts[i]))
1736 /* Assign the type to the key, if it is missing. */
1737 if (keyi->types[i] == XKB_ATOM_NONE) {
1738 if (keyi->dfltType != XKB_ATOM_NONE)
1739 keyi->types[i] = keyi->dfltType;
1740 else if (FindAutomaticType(keymap, keyi->numLevels[i],
1741 darray_mem(keyi->syms[i], 0),
1742 &keyi->types[i], &autoType)) { }
1744 if (warningLevel >= 5) {
1745 WARN("No automatic type for %d symbols\n",
1746 (unsigned int) keyi->numLevels[i]);
1747 ACTION("Using %s for the %s key (keycode %d)\n",
1748 xkb_atom_text(keymap->ctx, keyi->types[i]),
1749 longText(keyi->name), kc);
1753 if (FindNamedType(keymap, keyi->types[i], &types[i])) {
1754 if (!autoType || keyi->numLevels[i] > 2)
1755 key->explicit |= (1 << i);
1758 if (warningLevel >= 3) {
1759 WARN("Type \"%s\" is not defined\n",
1760 xkb_atom_text(keymap->ctx, keyi->types[i]));
1761 ACTION("Using TWO_LEVEL for the %s key (keycode %d)\n",
1762 longText(keyi->name), kc);
1764 types[i] = XkbTwoLevelIndex;
1766 /* if the type specifies fewer levels than the key has, shrink the key */
1767 type = &darray_item(keymap->types, types[i]);
1768 if (type->num_levels < keyi->numLevels[i]) {
1769 if (warningLevel > 0) {
1770 WARN("Type \"%s\" has %d levels, but %s has %d symbols\n",
1771 type->name, type->num_levels,
1772 xkb_atom_text(keymap->ctx, keyi->name), keyi->numLevels[i]);
1773 ACTION("Ignoring extra symbols\n");
1775 keyi->numLevels[i] = type->num_levels;
1777 if (keyi->numLevels[i] > width)
1778 width = keyi->numLevels[i];
1779 if (type->num_levels > width)
1780 width = type->num_levels;
1781 sizeSyms += darray_size(keyi->syms[i]);
1784 darray_resize0(key->syms, sizeSyms);
1787 outActs = XkbcResizeKeyActions(keymap, key, width * nGroups);
1788 if (outActs == NULL) {
1789 WSGO("Could not enlarge actions for %s (key %d)\n",
1790 longText(keyi->name), kc);
1793 key->explicit |= XkbExplicitInterpretMask;
1798 key->num_groups = nGroups;
1799 if (keyi->defined & _Key_GroupInfo) {
1800 key->out_of_range_group_number = keyi->out_of_range_group_number;
1801 key->out_of_range_group_action = keyi->out_of_range_group_action;
1804 key->sym_index = calloc(nGroups * width, sizeof(*key->sym_index));
1805 key->num_syms = calloc(nGroups * width, sizeof(*key->num_syms));
1807 for (i = 0; i < nGroups; i++) {
1808 /* assign kt_index[i] to the index of the type in map->types.
1809 * kt_index[i] may have been set by a previous run (if we have two
1810 * layouts specified). Let's not overwrite it with the ONE_LEVEL
1811 * default group if we dont even have keys for this group anyway.
1813 * FIXME: There should be a better fix for this.
1815 if (keyi->numLevels[i])
1816 key->kt_index[i] = types[i];
1817 if (!darray_empty(keyi->syms[i])) {
1818 /* fill key to "width" symbols*/
1819 for (tmp = 0; tmp < width; tmp++) {
1820 if (tmp < keyi->numLevels[i] &&
1821 darray_item(keyi->symsMapNumEntries[i], tmp) != 0) {
1822 memcpy(darray_mem(key->syms, symIndex),
1823 darray_mem(keyi->syms[i],
1824 darray_item(keyi->symsMapIndex[i], tmp)),
1825 darray_item(keyi->symsMapNumEntries[i],
1826 tmp) * sizeof(xkb_keysym_t));
1827 key->sym_index[(i * width) + tmp] = symIndex;
1828 key->num_syms[(i * width) + tmp] =
1829 darray_item(keyi->symsMapNumEntries[i], tmp);
1830 symIndex += key->num_syms[(i * width) + tmp];
1833 key->sym_index[(i * width) + tmp] = -1;
1834 key->num_syms[(i * width) + tmp] = 0;
1836 if (outActs != NULL && !darray_empty(keyi->acts[i])) {
1837 if (tmp < keyi->numLevels[i])
1838 outActs[tmp] = darray_item(keyi->acts[i], tmp);
1840 outActs[tmp].type = XkbSA_NoAction;
1845 switch (keyi->behavior.type & XkbKB_OpMask) {
1850 key->behavior = keyi->behavior;
1851 key->explicit |= XkbExplicitBehaviorMask;
1854 if (keyi->defined & _Key_VModMap) {
1855 key->vmodmap = keyi->vmodmap;
1856 key->explicit |= XkbExplicitVModMapMask;
1858 if (keyi->repeat != RepeatUndefined) {
1859 key->repeats = keyi->repeat == RepeatYes;
1860 key->explicit |= XkbExplicitAutoRepeatMask;
1863 /* do the same thing for the next key */
1864 CopySymbolsDef(keymap, keyi, kc + 1);
1869 CopyModMapDef(struct xkb_keymap *keymap, ModMapEntry *entry)
1871 struct xkb_key *key;
1873 if (!entry->haveSymbol) {
1874 key = FindNamedKey(keymap, entry->u.keyName, true,
1875 CreateKeyNames(keymap), 0);
1877 if (warningLevel >= 5) {
1878 WARN("Key %s not found in keycodes\n",
1879 longText(entry->u.keyName));
1880 ACTION("Modifier map entry for %s not updated\n",
1881 XkbcModIndexText(entry->modifier));
1887 key = FindKeyForSymbol(keymap, entry->u.keySym);
1889 if (warningLevel > 5) {
1890 WARN("Key \"%s\" not found in symbol map\n",
1891 XkbcKeysymText(entry->u.keySym));
1892 ACTION("Modifier map entry for %s not updated\n",
1893 XkbcModIndexText(entry->modifier));
1899 key->modmap |= (1 << entry->modifier);
1904 * Handle the xkb_symbols section of an xkb file.
1906 * @param file The parsed xkb_symbols section of the xkb file.
1907 * @param keymap Handle to the keyboard description to store the symbols in.
1908 * @param merge Merge strategy (e.g. MERGE_OVERRIDE).
1911 CompileSymbols(XkbFile *file, struct xkb_keymap *keymap,
1912 enum merge_mode merge)
1915 struct xkb_key *key;
1920 InitSymbolsInfo(&info, keymap, file->id);
1921 info.dflt.merge = merge;
1923 HandleSymbolsFile(file, keymap, merge, &info);
1925 if (darray_empty(info.keys))
1928 if (info.errorCount != 0)
1931 darray_resize0(keymap->acts, darray_size(keymap->acts) + 32 + 1);
1934 keymap->symbols_section_name = strdup(info.name);
1936 for (i = 0; i < XkbNumKbdGroups; i++) {
1937 if (info.groupNames[i] != XKB_ATOM_NONE) {
1938 free(keymap->group_names[i]);
1939 keymap->group_names[i] = xkb_atom_strdup(keymap->ctx,
1940 info.groupNames[i]);
1945 darray_foreach(keyi, info.keys)
1946 PrepareKeyDef(keyi);
1949 darray_foreach(keyi, info.keys)
1950 if (!CopySymbolsDef(keymap, keyi, 0))
1953 if (warningLevel > 3) {
1954 xkb_foreach_key(key, keymap) {
1955 if (key->name[0] == '\0')
1958 if (key->num_groups < 1)
1959 WARN("No symbols defined for <%.4s> (keycode %d)\n",
1960 key->name, XkbKeyGetKeycode(keymap, key));
1964 list_foreach(mm, &info.modMaps, entry)
1965 if (!CopyModMapDef(keymap, mm))
1968 FreeSymbolsInfo(&info);
1972 FreeSymbolsInfo(&info);