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 KeyNameText(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;
296 int verbosity = xkb_get_log_verbosity(info->keymap->ctx);
298 clobber = (from->merge != MERGE_AUGMENT);
300 report = (verbosity > 9) ||
301 (into->file_id == from->file_id && verbosity > 0);
303 darray_init(resultSyms);
305 if (into->numLevels[group] >= from->numLevels[group]) {
306 resultActs = into->acts[group];
307 resultWidth = into->numLevels[group];
310 resultActs = from->acts[group];
311 resultWidth = from->numLevels[group];
312 darray_resize(into->symsMapIndex[group],
313 from->numLevels[group]);
314 darray_resize0(into->symsMapNumEntries[group],
315 from->numLevels[group]);
317 for (i = into->numLevels[group]; i < from->numLevels[group]; i++)
318 darray_item(into->symsMapIndex[group], i) = -1;
321 if (darray_empty(resultActs) && (!darray_empty(into->acts[group]) ||
322 !darray_empty(from->acts[group]))) {
323 darray_resize0(resultActs, resultWidth);
324 for (i = 0; i < resultWidth; i++) {
325 union xkb_action *fromAct = NULL, *toAct = NULL;
327 if (!darray_empty(from->acts[group]))
328 fromAct = &darray_item(from->acts[group], i);
330 if (!darray_empty(into->acts[group]))
331 toAct = &darray_item(into->acts[group], i);
333 if (((fromAct == NULL) || (fromAct->type == XkbSA_NoAction))
334 && (toAct != NULL)) {
335 darray_item(resultActs, i) = *toAct;
337 else if (((toAct == NULL) || (toAct->type == XkbSA_NoAction))
338 && (fromAct != NULL)) {
339 darray_item(resultActs, i) = *fromAct;
342 union xkb_action *use, *ignore;
352 log_warn(info->keymap->ctx,
353 "Multiple actions for level %d/group %u on key %s; "
354 "Using %s, ignoring %s\n",
355 i + 1, group + 1, longText(into->name),
356 ActionTypeText(use->type),
357 ActionTypeText(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 log_info(info->keymap->ctx,
436 "Multiple symbols for group %u, level %d on key %s; "
437 "Using %s, ignoring %s\n",
438 group + 1, i + 1, longText(into->name),
439 (use == FROM ? "from" : "to"),
440 (use == FROM ? "to" : "from"));
444 memcpy(darray_mem(resultSyms, cur_idx),
445 darray_mem(from->syms[group],
446 darray_item(from->symsMapIndex[group], i)),
447 darray_item(from->symsMapNumEntries[group],
448 i) * sizeof(xkb_keysym_t));
449 darray_item(into->symsMapIndex[group], i) = cur_idx;
450 darray_item(into->symsMapNumEntries[group], i) =
451 darray_item(from->symsMapNumEntries[group], i);
454 memcpy(darray_mem(resultSyms, cur_idx),
455 darray_mem(into->syms[group],
456 darray_item(into->symsMapIndex[group], i)),
457 darray_item(into->symsMapNumEntries[group],
458 i) * sizeof(xkb_keysym_t));
459 darray_item(into->symsMapIndex[group], i) = cur_idx;
461 cur_idx += darray_item(into->symsMapNumEntries[group], i);
465 if (!darray_same(resultActs, into->acts[group]))
466 darray_free(into->acts[group]);
467 if (!darray_same(resultActs, from->acts[group]))
468 darray_free(from->acts[group]);
469 into->numLevels[group] = resultWidth;
470 if (!darray_same(resultSyms, into->syms[group]))
471 darray_free(into->syms[group]);
472 into->syms[group] = resultSyms;
473 if (!darray_same(resultSyms, from->syms[group]))
474 darray_free(from->syms[group]);
475 darray_init(from->syms[group]);
476 darray_free(from->symsMapIndex[group]);
477 darray_free(from->symsMapNumEntries[group]);
478 into->acts[group] = resultActs;
479 darray_init(from->acts[group]);
480 if (!darray_empty(into->syms[group]))
481 into->symsDefined |= (1 << group);
482 from->symsDefined &= ~(1 << group);
483 into->actsDefined |= (1 << group);
484 from->actsDefined &= ~(1 << group);
490 UseNewKeyField(unsigned field, KeyInfo *old, KeyInfo *new, int verbosity,
493 if (!(old->defined & field))
496 if (new->defined & field) {
497 if ((old->file_id == new->file_id && verbosity > 0) || verbosity > 9)
500 if (new->merge != MERGE_AUGMENT)
509 MergeKeys(SymbolsInfo *info, KeyInfo *into, KeyInfo *from)
512 unsigned collide = 0;
514 int verbosity = xkb_get_log_verbosity(info->keymap->ctx);
516 if (from->merge == MERGE_REPLACE) {
517 for (i = 0; i < XkbNumKbdGroups; i++) {
518 if (into->numLevels[i] != 0) {
519 darray_free(into->syms[i]);
520 darray_free(into->acts[i]);
524 memset(from, 0, sizeof(KeyInfo));
528 report = (verbosity > 9 ||
529 (into->file_id == from->file_id && verbosity > 0));
531 for (i = 0; i < XkbNumKbdGroups; i++) {
532 if (from->numLevels[i] > 0) {
533 if (into->numLevels[i] == 0) {
534 into->numLevels[i] = from->numLevels[i];
535 into->syms[i] = from->syms[i];
536 into->symsMapIndex[i] = from->symsMapIndex[i];
537 into->symsMapNumEntries[i] = from->symsMapNumEntries[i];
538 into->acts[i] = from->acts[i];
539 into->symsDefined |= (1 << i);
540 darray_init(from->syms[i]);
541 darray_init(from->symsMapIndex[i]);
542 darray_init(from->symsMapNumEntries[i]);
543 darray_init(from->acts[i]);
544 from->numLevels[i] = 0;
545 from->symsDefined &= ~(1 << i);
546 if (!darray_empty(into->syms[i]))
547 into->defined |= _Key_Syms;
548 if (!darray_empty(into->acts[i]))
549 into->defined |= _Key_Acts;
553 if (!darray_empty(into->syms[i]))
554 collide |= _Key_Syms;
555 if (!darray_empty(into->acts[i]))
556 collide |= _Key_Acts;
558 MergeKeyGroups(info, into, from, (unsigned) i);
561 if (from->types[i] != XKB_ATOM_NONE) {
562 if ((into->types[i] != XKB_ATOM_NONE) && report &&
563 (into->types[i] != from->types[i])) {
564 xkb_atom_t use, ignore;
565 collide |= _Key_Types;
566 if (from->merge != MERGE_AUGMENT) {
567 use = from->types[i];
568 ignore = into->types[i];
571 use = into->types[i];
572 ignore = from->types[i];
575 log_warn(info->keymap->ctx,
576 "Multiple definitions for group %d type of key %s; "
577 "Using %s, ignoring %s\n",
578 i, longText(into->name),
579 xkb_atom_text(info->keymap->ctx, use),
580 xkb_atom_text(info->keymap->ctx, ignore));
583 if (from->merge != MERGE_AUGMENT ||
584 into->types[i] == XKB_ATOM_NONE) {
585 into->types[i] = from->types[i];
590 if (UseNewKeyField(_Key_Behavior, into, from, verbosity, &collide)) {
591 into->behavior = from->behavior;
592 into->defined |= _Key_Behavior;
594 if (UseNewKeyField(_Key_VModMap, into, from, verbosity, &collide)) {
595 into->vmodmap = from->vmodmap;
596 into->defined |= _Key_VModMap;
598 if (UseNewKeyField(_Key_Repeat, into, from, verbosity, &collide)) {
599 into->repeat = from->repeat;
600 into->defined |= _Key_Repeat;
602 if (UseNewKeyField(_Key_Type_Dflt, into, from, verbosity, &collide)) {
603 into->dfltType = from->dfltType;
604 into->defined |= _Key_Type_Dflt;
606 if (UseNewKeyField(_Key_GroupInfo, into, from, verbosity, &collide)) {
607 into->out_of_range_group_action = from->out_of_range_group_action;
608 into->out_of_range_group_number = from->out_of_range_group_number;
609 into->defined |= _Key_GroupInfo;
613 log_warn(info->keymap->ctx,
614 "Symbol map for key %s redefined; "
615 "Using %s definition for conflicting fields\n",
616 longText(into->name),
617 (from->merge == MERGE_AUGMENT ? "first" : "last"));
623 AddKeySymbols(SymbolsInfo *info, KeyInfo *keyi)
625 unsigned long real_name;
628 darray_foreach(iter, info->keys)
629 if (iter->name == keyi->name)
630 return MergeKeys(info, iter, keyi);
632 if (FindKeyNameForAlias(info->keymap, keyi->name, &real_name))
633 darray_foreach(iter, info->keys)
634 if (iter->name == real_name)
635 return MergeKeys(info, iter, keyi);
637 darray_resize0(info->keys, darray_size(info->keys) + 1);
638 new = &darray_item(info->keys, darray_size(info->keys) - 1);
639 return CopyKeyInfo(keyi, new, true);
643 AddModMapEntry(SymbolsInfo * info, ModMapEntry * new)
648 clobber = (new->merge != MERGE_AUGMENT);
649 list_foreach(mm, &info->modMaps, entry) {
650 if (new->haveSymbol && mm->haveSymbol
651 && (new->u.keySym == mm->u.keySym)) {
652 unsigned use, ignore;
653 if (mm->modifier != new->modifier) {
656 ignore = mm->modifier;
660 ignore = new->modifier;
662 log_err(info->keymap->ctx,
663 "%s added to symbol map for multiple modifiers; "
664 "Using %s, ignoring %s.\n",
665 KeysymText(new->u.keySym), ModIndexText(use),
666 ModIndexText(ignore));
671 if ((!new->haveSymbol) && (!mm->haveSymbol) &&
672 (new->u.keyName == mm->u.keyName)) {
673 unsigned use, ignore;
674 if (mm->modifier != new->modifier) {
677 ignore = mm->modifier;
681 ignore = new->modifier;
683 log_err(info->keymap->ctx,
684 "Key %s added to map for multiple modifiers; "
685 "Using %s, ignoring %s.\n",
686 longText(new->u.keyName), ModIndexText(use),
687 ModIndexText(ignore));
694 mm = malloc(sizeof(*mm));
696 log_wsgo(info->keymap->ctx,
697 "Could not allocate modifier map entry; "
698 "Modifier map for %s will be incomplete\n",
699 ModIndexText(new->modifier));
704 list_add(&mm->entry, &info->modMaps);
708 /***====================================================================***/
711 MergeIncludedSymbols(SymbolsInfo *into, SymbolsInfo *from,
712 enum merge_mode merge)
716 ModMapEntry *mm, *next;
718 if (from->errorCount > 0) {
719 into->errorCount += from->errorCount;
722 if (into->name == NULL) {
723 into->name = from->name;
726 for (i = 0; i < XkbNumKbdGroups; i++) {
727 if (from->groupNames[i] != XKB_ATOM_NONE) {
728 if ((merge != MERGE_AUGMENT) ||
729 (into->groupNames[i] == XKB_ATOM_NONE))
730 into->groupNames[i] = from->groupNames[i];
734 darray_foreach(keyi, from->keys) {
735 if (merge != MERGE_DEFAULT)
738 if (!AddKeySymbols(into, keyi))
742 list_foreach_safe(mm, next, &from->modMaps, entry) {
743 if (merge != MERGE_DEFAULT)
745 if (!AddModMapEntry(into, mm))
749 list_init(&from->modMaps);
753 HandleSymbolsFile(SymbolsInfo *info, XkbFile *file, enum merge_mode merge);
756 HandleIncludeSymbols(SymbolsInfo *info, IncludeStmt *stmt)
758 enum merge_mode merge = MERGE_DEFAULT;
760 SymbolsInfo included, next_incl;
762 InitSymbolsInfo(&included, info->keymap, info->file_id);
765 included.name = stmt->stmt;
769 for (; stmt; stmt = stmt->next_incl) {
770 if (!ProcessIncludeFile(info->keymap->ctx, stmt, FILE_TYPE_SYMBOLS,
772 info->errorCount += 10;
773 FreeSymbolsInfo(&included);
777 InitSymbolsInfo(&next_incl, info->keymap, rtrn->id);
778 next_incl.merge = next_incl.dflt.merge = MERGE_OVERRIDE;
780 next_incl.explicit_group = atoi(stmt->modifier) - 1;
782 next_incl.explicit_group = info->explicit_group;
784 HandleSymbolsFile(&next_incl, rtrn, MERGE_OVERRIDE);
786 MergeIncludedSymbols(&included, &next_incl, merge);
788 FreeSymbolsInfo(&next_incl);
792 MergeIncludedSymbols(info, &included, merge);
793 FreeSymbolsInfo(&included);
795 return (info->errorCount == 0);
802 GetGroupIndex(SymbolsInfo *info, KeyInfo *keyi, ExprDef *arrayNdx,
803 unsigned what, xkb_group_index_t *ndx_rtrn)
812 if (arrayNdx == NULL) {
816 defined = keyi->symsDefined;
818 defined = keyi->actsDefined;
820 for (i = 0; i < XkbNumKbdGroups; i++) {
821 if ((defined & (1 << i)) == 0) {
827 log_err(info->keymap->ctx,
828 "Too many groups of %s for key %s (max %u); "
829 "Ignoring %s defined for extra groups\n",
830 name, longText(keyi->name), XkbNumKbdGroups + 1, name);
834 if (!ExprResolveGroup(info->keymap->ctx, arrayNdx, ndx_rtrn)) {
835 log_err(info->keymap->ctx,
836 "Illegal group index for %s of key %s\n"
837 "Definition with non-integer array index ignored\n",
838 name, longText(keyi->name));
847 AddSymbolsToKey(SymbolsInfo *info, KeyInfo *keyi, ExprDef *arrayNdx,
850 xkb_group_index_t ndx;
851 size_t nSyms, nLevels;
855 if (!GetGroupIndex(info, keyi, arrayNdx, SYMBOLS, &ndx))
858 keyi->symsDefined |= (1 << ndx);
861 if (value->op != EXPR_KEYSYM_LIST) {
862 log_err(info->keymap->ctx,
863 "Expected a list of symbols, found %s; "
864 "Ignoring symbols for group %u of %s\n",
865 exprOpText(value->op), ndx + 1, longText(keyi->name));
868 if (!darray_empty(keyi->syms[ndx])) {
869 log_err(info->keymap->ctx,
870 "Symbols for key %s, group %u already defined; "
871 "Ignoring duplicate definition\n",
872 longText(keyi->name), ndx + 1);
875 nSyms = darray_size(value->value.list.syms);
876 nLevels = darray_size(value->value.list.symsMapIndex);
877 if ((keyi->numLevels[ndx] < nSyms || darray_empty(keyi->syms[ndx])) &&
878 (!ResizeKeyGroup(keyi, ndx, nLevels, nSyms, false))) {
879 log_wsgo(info->keymap->ctx,
880 "Could not resize group %u of key %s to contain %zu levels; "
882 ndx + 1, longText(keyi->name), nSyms);
885 keyi->symsDefined |= (1 << ndx);
886 for (i = 0; i < nLevels; i++) {
887 darray_item(keyi->symsMapIndex[ndx], i) =
888 darray_item(value->value.list.symsMapIndex, i);
889 darray_item(keyi->symsMapNumEntries[ndx], i) =
890 darray_item(value->value.list.symsNumEntries, i);
892 for (j = 0; j < darray_item(keyi->symsMapNumEntries[ndx], i); j++) {
893 /* FIXME: What's abort() doing here? */
894 if (darray_item(keyi->symsMapIndex[ndx], i) + j >= nSyms)
896 if (!LookupKeysym(darray_item(value->value.list.syms,
897 darray_item(value->value.list.symsMapIndex,
899 &darray_item(keyi->syms[ndx],
900 darray_item(keyi->symsMapIndex[ndx],
902 log_warn(info->keymap->ctx,
903 "Could not resolve keysym %s for key %s, group %u (%s), level %zu\n",
904 darray_item(value->value.list.syms, i),
905 longText(keyi->name),
907 xkb_atom_text(info->keymap->ctx,
908 info->groupNames[ndx]),
911 darray_item(keyi->syms[ndx],
912 darray_item(keyi->symsMapIndex[ndx],
913 i) + j) = XKB_KEY_NoSymbol;
914 darray_item(keyi->symsMapIndex[ndx], i) = -1;
915 darray_item(keyi->symsMapNumEntries[ndx], i) = 0;
918 if (darray_item(keyi->symsMapNumEntries[ndx], i) == 1 &&
919 darray_item(keyi->syms[ndx],
920 darray_item(keyi->symsMapIndex[ndx],
921 i) + j) == XKB_KEY_NoSymbol) {
922 darray_item(keyi->symsMapIndex[ndx], i) = -1;
923 darray_item(keyi->symsMapNumEntries[ndx], i) = 0;
927 for (j = keyi->numLevels[ndx] - 1;
928 j >= 0 && darray_item(keyi->symsMapNumEntries[ndx], j) == 0; j--)
929 keyi->numLevels[ndx]--;
934 AddActionsToKey(SymbolsInfo *info, KeyInfo *keyi, ExprDef *arrayNdx,
938 xkb_group_index_t ndx;
941 struct xkb_any_action *toAct;
943 if (!GetGroupIndex(info, keyi, arrayNdx, ACTIONS, &ndx))
947 keyi->actsDefined |= (1 << ndx);
951 if (value->op != EXPR_ACTION_LIST) {
952 log_wsgo(info->keymap->ctx,
953 "Bad expression type (%d) for action list value; "
954 "Ignoring actions for group %u of %s\n",
955 value->op, ndx, longText(keyi->name));
959 if (!darray_empty(keyi->acts[ndx])) {
960 log_wsgo(info->keymap->ctx,
961 "Actions for key %s, group %u already defined\n",
962 longText(keyi->name), ndx);
966 for (nActs = 0, act = value->value.child; act != NULL; nActs++) {
967 act = (ExprDef *) act->common.next;
971 log_wsgo(info->keymap->ctx,
972 "Action list but not actions in AddActionsToKey\n");
976 if ((keyi->numLevels[ndx] < nActs || darray_empty(keyi->acts[ndx])) &&
977 !ResizeKeyGroup(keyi, ndx, nActs, nActs, true)) {
978 log_wsgo(info->keymap->ctx,
979 "Could not resize group %u of key %s; "
981 ndx, longText(keyi->name));
984 keyi->actsDefined |= (1 << ndx);
986 toAct = (struct xkb_any_action *) darray_mem(keyi->acts[ndx], 0);
987 act = value->value.child;
988 for (i = 0; i < nActs; i++, toAct++) {
989 if (!HandleActionDef(act, info->keymap, toAct, info->action)) {
990 log_err(info->keymap->ctx,
991 "Illegal action definition for %s; "
992 "Action for group %u/level %zu ignored\n",
993 longText(keyi->name), ndx + 1, i + 1);
995 act = (ExprDef *) act->common.next;
1001 static const LookupEntry lockingEntries[] = {
1002 { "true", XkbKB_Lock },
1003 { "yes", XkbKB_Lock },
1004 { "on", XkbKB_Lock },
1005 { "false", XkbKB_Default },
1006 { "no", XkbKB_Default },
1007 { "off", XkbKB_Default },
1008 { "permanent", XkbKB_Lock | XkbKB_Permanent },
1012 static const LookupEntry repeatEntries[] = {
1013 { "true", RepeatYes },
1014 { "yes", RepeatYes },
1015 { "on", RepeatYes },
1016 { "false", RepeatNo },
1018 { "off", RepeatNo },
1019 { "default", RepeatUndefined },
1024 SetSymbolsField(SymbolsInfo *info, KeyInfo *keyi, const char *field,
1025 ExprDef *arrayNdx, ExprDef *value)
1028 struct xkb_context *ctx = info->keymap->ctx;
1030 if (istreq(field, "type")) {
1031 xkb_group_index_t ndx;
1034 if (!ExprResolveString(ctx, value, &str))
1035 log_lvl(info->keymap->ctx, 1,
1036 "The type field of a key symbol map must be a string; "
1037 "Ignoring illegal type definition\n");
1039 if (arrayNdx == NULL) {
1040 keyi->dfltType = xkb_atom_intern(ctx, str);
1041 keyi->defined |= _Key_Type_Dflt;
1043 else if (!ExprResolveGroup(ctx, arrayNdx, &ndx)) {
1044 log_err(info->keymap->ctx,
1045 "Illegal group index for type of key %s; "
1046 "Definition with non-integer array index ignored\n",
1047 longText(keyi->name));
1052 keyi->types[ndx] = xkb_atom_intern(ctx, str);
1053 keyi->typesDefined |= (1 << ndx);
1056 else if (istreq(field, "symbols"))
1057 return AddSymbolsToKey(info, keyi, arrayNdx, value);
1058 else if (istreq(field, "actions"))
1059 return AddActionsToKey(info, keyi, arrayNdx, value);
1060 else if (istreq(field, "vmods") ||
1061 istreq(field, "virtualmods") ||
1062 istreq(field, "virtualmodifiers")) {
1063 xkb_mod_mask_t mask;
1065 ok = ExprResolveVModMask(info->keymap, value, &mask);
1067 keyi->vmodmap = (mask >> 8);
1068 keyi->defined |= _Key_VModMap;
1071 log_err(info->keymap->ctx,
1072 "Expected a virtual modifier mask, found %s; "
1073 "Ignoring virtual modifiers definition for key %s\n",
1074 exprOpText(value->op), longText(keyi->name));
1077 else if (istreq(field, "locking") ||
1078 istreq(field, "lock") ||
1079 istreq(field, "locks")) {
1082 ok = ExprResolveEnum(ctx, value, &val, lockingEntries);
1084 keyi->behavior.type = val;
1085 keyi->defined |= _Key_Behavior;
1087 else if (istreq(field, "radiogroup") ||
1088 istreq(field, "permanentradiogroup") ||
1089 istreq(field, "allownone")) {
1090 log_err(info->keymap->ctx,
1091 "Radio groups not supported; "
1092 "Ignoring radio group specification for key %s\n",
1093 longText(keyi->name));
1096 else if (istreq_prefix("overlay", field) ||
1097 istreq_prefix("permanentoverlay", field)) {
1098 log_err(info->keymap->ctx,
1099 "Overlays not supported; "
1100 "Ignoring overlay specification for key %s\n",
1101 longText(keyi->name));
1103 else if (istreq(field, "repeating") ||
1104 istreq(field, "repeats") ||
1105 istreq(field, "repeat")) {
1108 ok = ExprResolveEnum(ctx, value, &val, repeatEntries);
1110 log_err(info->keymap->ctx,
1111 "Illegal repeat setting for %s; "
1112 "Non-boolean repeat setting ignored\n",
1113 longText(keyi->name));
1117 keyi->defined |= _Key_Repeat;
1119 else if (istreq(field, "groupswrap") ||
1120 istreq(field, "wrapgroups")) {
1123 if (!ExprResolveBoolean(ctx, value, &set)) {
1124 log_err(info->keymap->ctx,
1125 "Illegal groupsWrap setting for %s; "
1126 "Non-boolean value ignored\n",
1127 longText(keyi->name));
1132 keyi->out_of_range_group_action = XkbWrapIntoRange;
1134 keyi->out_of_range_group_action = XkbClampIntoRange;
1136 keyi->defined |= _Key_GroupInfo;
1138 else if (istreq(field, "groupsclamp") ||
1139 istreq(field, "clampgroups")) {
1142 if (!ExprResolveBoolean(ctx, value, &set)) {
1143 log_err(info->keymap->ctx,
1144 "Illegal groupsClamp setting for %s; "
1145 "Non-boolean value ignored\n",
1146 longText(keyi->name));
1151 keyi->out_of_range_group_action = XkbClampIntoRange;
1153 keyi->out_of_range_group_action = XkbWrapIntoRange;
1155 keyi->defined |= _Key_GroupInfo;
1157 else if (istreq(field, "groupsredirect") ||
1158 istreq(field, "redirectgroups")) {
1159 xkb_group_index_t grp;
1161 if (!ExprResolveGroup(ctx, value, &grp)) {
1162 log_err(info->keymap->ctx,
1163 "Illegal group index for redirect of key %s; "
1164 "Definition with non-integer group ignored\n",
1165 longText(keyi->name));
1169 keyi->out_of_range_group_action = XkbRedirectIntoRange;
1170 keyi->out_of_range_group_number = grp - 1;
1171 keyi->defined |= _Key_GroupInfo;
1174 log_err(info->keymap->ctx,
1175 "Unknown field %s in a symbol interpretation; "
1176 "Definition ignored\n",
1184 SetGroupName(SymbolsInfo *info, ExprDef *arrayNdx, ExprDef *value)
1186 xkb_group_index_t grp;
1190 log_lvl(info->keymap->ctx, 1,
1191 "You must specify an index when specifying a group name; "
1192 "Group name definition without array subscript ignored\n");
1196 if (!ExprResolveGroup(info->keymap->ctx, arrayNdx, &grp)) {
1197 log_err(info->keymap->ctx,
1198 "Illegal index in group name definition; "
1199 "Definition with non-integer array index ignored\n");
1203 if (!ExprResolveString(info->keymap->ctx, value, &name)) {
1204 log_err(info->keymap->ctx,
1205 "Group name must be a string; "
1206 "Illegal name for group %d ignored\n", grp);
1210 info->groupNames[grp - 1 + info->explicit_group] =
1211 xkb_atom_intern(info->keymap->ctx, name);
1217 HandleSymbolsVar(SymbolsInfo *info, VarDef *stmt)
1219 const char *elem, *field;
1223 if (ExprResolveLhs(info->keymap->ctx, stmt->name, &elem, &field,
1225 return 0; /* internal error, already reported */
1226 if (elem && istreq(elem, "key")) {
1227 ret = SetSymbolsField(info, &info->dflt, field, arrayNdx,
1230 else if (!elem && (istreq(field, "name") ||
1231 istreq(field, "groupname"))) {
1232 ret = SetGroupName(info, arrayNdx, stmt->value);
1234 else if (!elem && (istreq(field, "groupswrap") ||
1235 istreq(field, "wrapgroups"))) {
1236 log_err(info->keymap->ctx,
1237 "Global \"groupswrap\" not supported; Ignored\n");
1240 else if (!elem && (istreq(field, "groupsclamp") ||
1241 istreq(field, "clampgroups"))) {
1242 log_err(info->keymap->ctx,
1243 "Global \"groupsclamp\" not supported; Ignored\n");
1246 else if (!elem && (istreq(field, "groupsredirect") ||
1247 istreq(field, "redirectgroups"))) {
1248 log_err(info->keymap->ctx,
1249 "Global \"groupsredirect\" not supported; Ignored\n");
1252 else if (!elem && istreq(field, "allownone")) {
1253 log_err(info->keymap->ctx,
1254 "Radio groups not supported; "
1255 "Ignoring \"allownone\" specification\n");
1259 ret = SetActionField(info->keymap, elem, field, arrayNdx,
1260 stmt->value, &info->action);
1267 HandleSymbolsBody(SymbolsInfo *info, VarDef *def, KeyInfo *keyi)
1270 const char *elem, *field;
1273 for (; def; def = (VarDef *) def->common.next) {
1274 if (def->name && def->name->op == EXPR_FIELD_REF) {
1275 ok = HandleSymbolsVar(info, def);
1280 if (!def->value || def->value->op == EXPR_KEYSYM_LIST)
1287 ok = ExprResolveLhs(info->keymap->ctx, def->name, &elem, &field,
1292 ok = SetSymbolsField(info, keyi, field, arrayNdx, def->value);
1299 SetExplicitGroup(SymbolsInfo *info, KeyInfo *keyi)
1301 xkb_group_index_t group = info->explicit_group;
1306 if ((keyi->typesDefined | keyi->symsDefined | keyi->actsDefined) & ~1) {
1307 xkb_group_index_t i;
1308 log_warn(info->keymap->ctx,
1309 "For the map %s an explicit group specified\n",
1311 log_warn(info->keymap->ctx,
1312 "but key %s has more than one group defined; "
1313 "All groups except first one will be ignored\n",
1314 longText(keyi->name));
1315 for (i = 1; i < XkbNumKbdGroups; i++) {
1316 keyi->numLevels[i] = 0;
1317 darray_free(keyi->syms[i]);
1318 darray_free(keyi->acts[i]);
1322 keyi->typesDefined = keyi->symsDefined = keyi->actsDefined = 1 << group;
1324 keyi->numLevels[group] = keyi->numLevels[0];
1325 keyi->numLevels[0] = 0;
1326 keyi->syms[group] = keyi->syms[0];
1327 darray_init(keyi->syms[0]);
1328 keyi->symsMapIndex[group] = keyi->symsMapIndex[0];
1329 darray_init(keyi->symsMapIndex[0]);
1330 keyi->symsMapNumEntries[group] = keyi->symsMapNumEntries[0];
1331 darray_init(keyi->symsMapNumEntries[0]);
1332 keyi->acts[group] = keyi->acts[0];
1333 darray_init(keyi->acts[0]);
1334 keyi->types[group] = keyi->types[0];
1340 HandleSymbolsDef(SymbolsInfo *info, SymbolsDef *stmt)
1344 InitKeyInfo(&keyi, info->file_id);
1345 CopyKeyInfo(&info->dflt, &keyi, false);
1346 keyi.merge = stmt->merge;
1347 keyi.name = KeyNameToLong(stmt->keyName);
1348 if (!HandleSymbolsBody(info, (VarDef *) stmt->symbols, &keyi)) {
1353 if (!SetExplicitGroup(info, &keyi)) {
1358 if (!AddKeySymbols(info, &keyi)) {
1366 HandleModMapDef(SymbolsInfo *info, ModMapDef *def)
1370 xkb_mod_index_t ndx;
1372 struct xkb_context *ctx = info->keymap->ctx;
1374 if (!LookupModIndex(ctx, NULL, def->modifier, EXPR_TYPE_INT, &ndx)) {
1375 log_err(info->keymap->ctx,
1376 "Illegal modifier map definition; "
1377 "Ignoring map for non-modifier \"%s\"\n",
1378 xkb_atom_text(ctx, def->modifier));
1385 for (key = def->keys; key != NULL; key = (ExprDef *) key->common.next) {
1388 if (key->op == EXPR_VALUE && key->value_type == EXPR_TYPE_KEYNAME) {
1389 tmp.haveSymbol = false;
1390 tmp.u.keyName = KeyNameToLong(key->value.keyName);
1392 else if (ExprResolveKeySym(ctx, key, &sym)) {
1393 tmp.haveSymbol = true;
1397 log_err(info->keymap->ctx,
1398 "Modmap entries may contain only key names or keysyms; "
1399 "Illegal definition for %s modifier ignored\n",
1400 ModIndexText(tmp.modifier));
1404 ok = AddModMapEntry(info, &tmp) && ok;
1410 HandleSymbolsFile(SymbolsInfo *info, XkbFile *file, enum merge_mode merge)
1415 info->name = strdup_safe(file->name);
1419 switch (stmt->type) {
1421 if (!HandleIncludeSymbols(info, (IncludeStmt *) stmt))
1425 if (!HandleSymbolsDef(info, (SymbolsDef *) stmt))
1429 if (!HandleSymbolsVar(info, (VarDef *) stmt))
1433 if (!HandleVModDef((VModDef *) stmt, info->keymap, merge,
1438 log_err(info->keymap->ctx,
1439 "Interpretation files may not include other types; "
1440 "Ignoring definition of symbol interpretation\n");
1444 log_err(info->keymap->ctx,
1445 "Interpretation files may not include other types; "
1446 "Ignoring definition of key name\n");
1450 if (!HandleModMapDef(info, (ModMapDef *) stmt))
1454 log_wsgo(info->keymap->ctx,
1455 "Unexpected statement type %d in HandleSymbolsFile\n",
1460 if (info->errorCount > 10) {
1461 log_err(info->keymap->ctx, "Abandoning symbols file \"%s\"\n",
1469 * Given a keysym @sym, return a key which generates it, or NULL.
1470 * This is used for example in a modifier map definition, such as:
1471 * modifier_map Lock { Caps_Lock };
1472 * where we want to add the Lock modifier to the modmap of the key
1473 * which matches the keysym Caps_Lock.
1474 * Since there can be many keys which generates the keysym, the key
1475 * is chosen first by lowest group in which the keysym appears, than
1476 * by lowest level and than by lowest key code.
1478 static struct xkb_key *
1479 FindKeyForSymbol(struct xkb_keymap *keymap, xkb_keysym_t sym)
1481 struct xkb_key *key, *ret = NULL;
1482 xkb_group_index_t group, min_group = UINT_MAX;
1483 unsigned int level, min_level = UINT_MAX;
1485 xkb_foreach_key(key, keymap) {
1486 for (group = 0; group < key->num_groups; group++) {
1487 for (level = 0; level < XkbKeyGroupWidth(keymap, key, group);
1489 if (XkbKeyNumSyms(key, group, level) != 1 ||
1490 (XkbKeySymEntry(key, group, level))[0] != sym)
1494 * If the keysym was found in a group or level > 0, we must
1495 * keep looking since we might find a key in which the keysym
1496 * is in a lower group or level.
1498 if (group < min_group ||
1499 (group == min_group && level < min_level)) {
1501 if (group == 0 && level == 0) {
1517 * Find the given name in the keymap->map->types and return its index.
1519 * @param atom The atom to search for.
1520 * @param type_rtrn Set to the index of the name if found.
1522 * @return true if found, false otherwise.
1525 FindNamedType(struct xkb_keymap *keymap, xkb_atom_t atom, unsigned *type_rtrn)
1528 const char *name = xkb_atom_text(keymap->ctx, atom);
1529 struct xkb_key_type *type;
1532 darray_foreach(type, keymap->types) {
1533 if (streq(type->name, name)) {
1544 * Assign a type to the given sym and return the Atom for the type assigned.
1547 * - ONE_LEVEL for width 0/1
1548 * - ALPHABETIC for 2 shift levels, with lower/upercase
1549 * - KEYPAD for keypad keys.
1550 * - TWO_LEVEL for other 2 shift level keys.
1551 * and the same for four level keys.
1553 * @param width Number of sysms in syms.
1554 * @param syms The keysyms for the given key (must be size width).
1555 * @param typeNameRtrn Set to the Atom of the type name.
1557 * @returns true if a type could be found, false otherwise.
1559 * FIXME: I need to take the KeyInfo so I can look at symsMapIndex and
1560 * all that fun stuff rather than just assuming there's always one
1564 FindAutomaticType(struct xkb_keymap *keymap, int width,
1565 const xkb_keysym_t *syms, xkb_atom_t *typeNameRtrn,
1569 if ((width == 1) || (width == 0)) {
1570 *typeNameRtrn = xkb_atom_intern(keymap->ctx, "ONE_LEVEL");
1573 else if (width == 2) {
1574 if (syms && xkb_keysym_is_lower(syms[0]) &&
1575 xkb_keysym_is_upper(syms[1])) {
1576 *typeNameRtrn = xkb_atom_intern(keymap->ctx, "ALPHABETIC");
1578 else if (syms && (xkb_keysym_is_keypad(syms[0]) ||
1579 xkb_keysym_is_keypad(syms[1]))) {
1580 *typeNameRtrn = xkb_atom_intern(keymap->ctx, "KEYPAD");
1584 *typeNameRtrn = xkb_atom_intern(keymap->ctx, "TWO_LEVEL");
1588 else if (width <= 4) {
1589 if (syms && xkb_keysym_is_lower(syms[0]) &&
1590 xkb_keysym_is_upper(syms[1]))
1591 if (xkb_keysym_is_lower(syms[2]) && xkb_keysym_is_upper(syms[3]))
1593 xkb_atom_intern(keymap->ctx, "FOUR_LEVEL_ALPHABETIC");
1595 *typeNameRtrn = xkb_atom_intern(keymap->ctx,
1596 "FOUR_LEVEL_SEMIALPHABETIC");
1598 else if (syms && (xkb_keysym_is_keypad(syms[0]) ||
1599 xkb_keysym_is_keypad(syms[1])))
1600 *typeNameRtrn = xkb_atom_intern(keymap->ctx, "FOUR_LEVEL_KEYPAD");
1602 *typeNameRtrn = xkb_atom_intern(keymap->ctx, "FOUR_LEVEL");
1603 /* XXX: why not set autoType here? */
1605 return ((width >= 0) && (width <= 4));
1609 * Ensure the given KeyInfo is in a coherent state, i.e. no gaps between the
1610 * groups, and reduce to one group if all groups are identical anyway.
1613 PrepareKeyDef(KeyInfo *keyi)
1615 xkb_group_index_t i, lastGroup;
1616 int j, width, defined;
1619 defined = keyi->symsDefined | keyi->actsDefined | keyi->typesDefined;
1620 /* get highest group number */
1621 for (i = XkbNumKbdGroups - 1; i > 0; i--) {
1622 if (defined & (1 << i))
1630 /* If there are empty groups between non-empty ones fill them with data */
1631 /* from the first group. */
1632 /* We can make a wrong assumption here. But leaving gaps is worse. */
1633 for (i = lastGroup; i > 0; i--) {
1634 if (defined & (1 << i))
1636 width = keyi->numLevels[0];
1637 if (keyi->typesDefined & 1) {
1638 for (j = 0; j < width; j++) {
1639 keyi->types[i] = keyi->types[0];
1641 keyi->typesDefined |= 1 << i;
1643 if ((keyi->actsDefined & 1) && !darray_empty(keyi->acts[0])) {
1644 darray_copy(keyi->acts[i], keyi->acts[0]);
1645 keyi->actsDefined |= 1 << i;
1647 if ((keyi->symsDefined & 1) && !darray_empty(keyi->syms[0])) {
1648 darray_copy(keyi->syms[i], keyi->syms[0]);
1649 darray_copy(keyi->symsMapIndex[i], keyi->symsMapIndex[0]);
1650 darray_copy(keyi->symsMapNumEntries[i],
1651 keyi->symsMapNumEntries[0]);
1652 keyi->symsDefined |= 1 << i;
1655 keyi->numLevels[i] = keyi->numLevels[0];
1658 /* If all groups are completely identical remove them all */
1659 /* exept the first one. */
1661 for (i = lastGroup; i > 0; i--) {
1662 if ((keyi->numLevels[i] != keyi->numLevels[0]) ||
1663 (keyi->types[i] != keyi->types[0])) {
1667 if (!darray_same(keyi->syms[i], keyi->syms[0]) &&
1668 (darray_empty(keyi->syms[i]) || darray_empty(keyi->syms[0]) ||
1669 darray_size(keyi->syms[i]) != darray_size(keyi->syms[0]) ||
1670 memcmp(darray_mem(keyi->syms[i], 0),
1671 darray_mem(keyi->syms[0], 0),
1672 sizeof(xkb_keysym_t) * darray_size(keyi->syms[0])))) {
1676 if (!darray_same(keyi->symsMapIndex[i], keyi->symsMapIndex[0]) &&
1677 (darray_empty(keyi->symsMapIndex[i]) ||
1678 darray_empty(keyi->symsMapIndex[0]) ||
1679 memcmp(darray_mem(keyi->symsMapIndex[i], 0),
1680 darray_mem(keyi->symsMapIndex[0], 0),
1681 keyi->numLevels[0] * sizeof(int)))) {
1685 if (!darray_same(keyi->symsMapNumEntries[i],
1686 keyi->symsMapNumEntries[0]) &&
1687 (darray_empty(keyi->symsMapNumEntries[i]) ||
1688 darray_empty(keyi->symsMapNumEntries[0]) ||
1689 memcmp(darray_mem(keyi->symsMapNumEntries[i], 0),
1690 darray_mem(keyi->symsMapNumEntries[0], 0),
1691 keyi->numLevels[0] * sizeof(size_t)))) {
1695 if (!darray_same(keyi->acts[i], keyi->acts[0]) &&
1696 (darray_empty(keyi->acts[i]) || darray_empty(keyi->acts[0]) ||
1697 memcmp(darray_mem(keyi->acts[i], 0),
1698 darray_mem(keyi->acts[0], 0),
1699 keyi->numLevels[0] * sizeof(union xkb_action)))) {
1705 for (i = lastGroup; i > 0; i--) {
1706 keyi->numLevels[i] = 0;
1707 darray_free(keyi->syms[i]);
1708 darray_free(keyi->symsMapIndex[i]);
1709 darray_free(keyi->symsMapNumEntries[i]);
1710 darray_free(keyi->acts[i]);
1713 keyi->symsDefined &= 1;
1714 keyi->actsDefined &= 1;
1715 keyi->typesDefined &= 1;
1720 * Copy the KeyInfo into the keyboard description.
1722 * This function recurses.
1725 CopySymbolsDef(SymbolsInfo *info, KeyInfo *keyi,
1726 xkb_keycode_t start_from)
1728 struct xkb_keymap *keymap = info->keymap;
1730 struct xkb_key *key;
1731 size_t sizeSyms = 0;
1732 xkb_group_index_t i, nGroups;
1733 unsigned width, tmp;
1734 struct xkb_key_type * type;
1735 bool haveActions, autoType, useAlias;
1736 unsigned types[XkbNumKbdGroups];
1737 union xkb_action *outActs;
1738 unsigned int symIndex = 0;
1740 useAlias = (start_from == 0);
1742 key = FindNamedKey(keymap, keyi->name, useAlias,
1743 CreateKeyNames(keymap), start_from);
1745 if (start_from == 0)
1746 log_lvl(info->keymap->ctx, 5,
1747 "Key %s not found in keycodes; Symbols ignored\n",
1748 longText(keyi->name));
1751 kc = XkbKeyGetKeycode(keymap, key);
1753 haveActions = false;
1755 for (i = nGroups = 0; i < XkbNumKbdGroups; i++) {
1756 if (((i + 1) > nGroups)
1757 && (((keyi->symsDefined | keyi->actsDefined) & (1 << i))
1758 || (keyi->typesDefined) & (1 << i)))
1760 if (!darray_empty(keyi->acts[i]))
1763 /* Assign the type to the key, if it is missing. */
1764 if (keyi->types[i] == XKB_ATOM_NONE) {
1765 if (keyi->dfltType != XKB_ATOM_NONE)
1766 keyi->types[i] = keyi->dfltType;
1767 else if (FindAutomaticType(keymap, keyi->numLevels[i],
1768 darray_mem(keyi->syms[i], 0),
1769 &keyi->types[i], &autoType)) { }
1771 log_lvl(info->keymap->ctx, 5,
1772 "No automatic type for %d symbols; "
1773 "Using %s for the %s key (keycode %d)\n",
1775 xkb_atom_text(keymap->ctx, keyi->types[i]),
1776 longText(keyi->name), kc);
1778 if (FindNamedType(keymap, keyi->types[i], &types[i])) {
1779 if (!autoType || keyi->numLevels[i] > 2)
1780 key->explicit |= (1 << i);
1783 log_lvl(info->keymap->ctx, 3,
1784 "Type \"%s\" is not defined; "
1785 "Using TWO_LEVEL for the %s key (keycode %d)\n",
1786 xkb_atom_text(keymap->ctx, keyi->types[i]),
1787 longText(keyi->name), kc);
1788 types[i] = XkbTwoLevelIndex;
1791 /* if the type specifies fewer levels than the key has, shrink the key */
1792 type = &darray_item(keymap->types, types[i]);
1793 if (type->num_levels < keyi->numLevels[i]) {
1794 log_lvl(info->keymap->ctx, 1,
1795 "Type \"%s\" has %d levels, but %s has %d symbols; "
1796 "Ignoring extra symbols\n",
1797 type->name, type->num_levels,
1798 longText(keyi->name),
1799 keyi->numLevels[i]);
1800 keyi->numLevels[i] = type->num_levels;
1802 if (keyi->numLevels[i] > width)
1803 width = keyi->numLevels[i];
1804 if (type->num_levels > width)
1805 width = type->num_levels;
1806 sizeSyms += darray_size(keyi->syms[i]);
1809 darray_resize0(key->syms, sizeSyms);
1812 outActs = ResizeKeyActions(keymap, key, width * nGroups);
1813 if (outActs == NULL) {
1814 log_wsgo(info->keymap->ctx,
1815 "Could not enlarge actions for %s (key %d)\n",
1816 longText(keyi->name), kc);
1819 key->explicit |= XkbExplicitInterpretMask;
1824 key->num_groups = nGroups;
1825 if (keyi->defined & _Key_GroupInfo) {
1826 key->out_of_range_group_number = keyi->out_of_range_group_number;
1827 key->out_of_range_group_action = keyi->out_of_range_group_action;
1830 key->sym_index = calloc(nGroups * width, sizeof(*key->sym_index));
1831 key->num_syms = calloc(nGroups * width, sizeof(*key->num_syms));
1833 for (i = 0; i < nGroups; i++) {
1834 /* assign kt_index[i] to the index of the type in map->types.
1835 * kt_index[i] may have been set by a previous run (if we have two
1836 * layouts specified). Let's not overwrite it with the ONE_LEVEL
1837 * default group if we dont even have keys for this group anyway.
1839 * FIXME: There should be a better fix for this.
1841 if (keyi->numLevels[i])
1842 key->kt_index[i] = types[i];
1843 if (!darray_empty(keyi->syms[i])) {
1844 /* fill key to "width" symbols*/
1845 for (tmp = 0; tmp < width; tmp++) {
1846 if (tmp < keyi->numLevels[i] &&
1847 darray_item(keyi->symsMapNumEntries[i], tmp) != 0) {
1848 memcpy(darray_mem(key->syms, symIndex),
1849 darray_mem(keyi->syms[i],
1850 darray_item(keyi->symsMapIndex[i], tmp)),
1851 darray_item(keyi->symsMapNumEntries[i],
1852 tmp) * sizeof(xkb_keysym_t));
1853 key->sym_index[(i * width) + tmp] = symIndex;
1854 key->num_syms[(i * width) + tmp] =
1855 darray_item(keyi->symsMapNumEntries[i], tmp);
1856 symIndex += key->num_syms[(i * width) + tmp];
1859 key->sym_index[(i * width) + tmp] = -1;
1860 key->num_syms[(i * width) + tmp] = 0;
1862 if (outActs != NULL && !darray_empty(keyi->acts[i])) {
1863 if (tmp < keyi->numLevels[i])
1864 outActs[tmp] = darray_item(keyi->acts[i], tmp);
1866 outActs[tmp].type = XkbSA_NoAction;
1871 switch (keyi->behavior.type & XkbKB_OpMask) {
1876 key->behavior = keyi->behavior;
1877 key->explicit |= XkbExplicitBehaviorMask;
1880 if (keyi->defined & _Key_VModMap) {
1881 key->vmodmap = keyi->vmodmap;
1882 key->explicit |= XkbExplicitVModMapMask;
1884 if (keyi->repeat != RepeatUndefined) {
1885 key->repeats = keyi->repeat == RepeatYes;
1886 key->explicit |= XkbExplicitAutoRepeatMask;
1889 /* do the same thing for the next key */
1890 CopySymbolsDef(info, keyi, kc + 1);
1895 CopyModMapDef(SymbolsInfo *info, ModMapEntry *entry)
1897 struct xkb_key *key;
1898 struct xkb_keymap *keymap = info->keymap;
1900 if (!entry->haveSymbol) {
1901 key = FindNamedKey(keymap, entry->u.keyName, true,
1902 CreateKeyNames(keymap), 0);
1904 log_lvl(info->keymap->ctx, 5,
1905 "Key %s not found in keycodes; "
1906 "Modifier map entry for %s not updated\n",
1907 longText(entry->u.keyName),
1908 ModIndexText(entry->modifier));
1913 key = FindKeyForSymbol(keymap, entry->u.keySym);
1915 log_lvl(info->keymap->ctx, 5,
1916 "Key \"%s\" not found in symbol map; "
1917 "Modifier map entry for %s not updated\n",
1918 KeysymText(entry->u.keySym),
1919 ModIndexText(entry->modifier));
1924 key->modmap |= (1 << entry->modifier);
1929 * Handle the xkb_symbols section of an xkb file.
1931 * @param file The parsed xkb_symbols section of the xkb file.
1932 * @param keymap Handle to the keyboard description to store the symbols in.
1933 * @param merge Merge strategy (e.g. MERGE_OVERRIDE).
1936 CompileSymbols(XkbFile *file, struct xkb_keymap *keymap,
1937 enum merge_mode merge)
1939 xkb_group_index_t i;
1940 struct xkb_key *key;
1945 InitSymbolsInfo(&info, keymap, file->id);
1946 info.dflt.merge = merge;
1948 HandleSymbolsFile(&info, file, merge);
1950 if (darray_empty(info.keys))
1953 if (info.errorCount != 0)
1956 darray_resize0(keymap->acts, darray_size(keymap->acts) + 32 + 1);
1959 keymap->symbols_section_name = strdup(info.name);
1961 for (i = 0; i < XkbNumKbdGroups; i++) {
1962 if (info.groupNames[i] != XKB_ATOM_NONE) {
1963 keymap->group_names[i] = xkb_atom_text(keymap->ctx,
1964 info.groupNames[i]);
1969 darray_foreach(keyi, info.keys)
1970 PrepareKeyDef(keyi);
1973 darray_foreach(keyi, info.keys)
1974 if (!CopySymbolsDef(&info, keyi, 0))
1977 if (xkb_get_log_verbosity(keymap->ctx) > 3) {
1978 xkb_foreach_key(key, keymap) {
1979 if (key->name[0] == '\0')
1982 if (key->num_groups < 1)
1983 log_warn(info.keymap->ctx,
1984 "No symbols defined for <%.4s> (keycode %d)\n",
1985 key->name, XkbKeyGetKeycode(keymap, key));
1989 list_foreach(mm, &info.modMaps, entry)
1990 if (!CopyModMapDef(&info, mm))
1993 FreeSymbolsInfo(&info);
1997 FreeSymbolsInfo(&info);