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) {
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)
813 if (arrayNdx == NULL) {
817 defined = keyi->symsDefined;
819 defined = keyi->actsDefined;
821 for (i = 0; i < XkbNumKbdGroups; i++) {
822 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);
833 if (!ExprResolveGroup(info->keymap->ctx, arrayNdx, &tmp)) {
834 log_err(info->keymap->ctx,
835 "Illegal group index for %s of key %s\n"
836 "Definition with non-integer array index ignored\n",
837 name, longText(keyi->name));
840 *ndx_rtrn = tmp.uval - 1;
845 AddSymbolsToKey(SymbolsInfo *info, KeyInfo *keyi, ExprDef *arrayNdx,
848 xkb_group_index_t ndx;
849 size_t nSyms, nLevels;
853 if (!GetGroupIndex(info, keyi, arrayNdx, SYMBOLS, &ndx))
856 keyi->symsDefined |= (1 << ndx);
859 if (value->op != ExprKeysymList) {
860 log_err(info->keymap->ctx,
861 "Expected a list of symbols, found %s; "
862 "Ignoring symbols for group %u of %s\n",
863 exprOpText(value->op), ndx + 1, longText(keyi->name));
866 if (!darray_empty(keyi->syms[ndx])) {
867 log_err(info->keymap->ctx,
868 "Symbols for key %s, group %u already defined; "
869 "Ignoring duplicate definition\n",
870 longText(keyi->name), ndx + 1);
873 nSyms = darray_size(value->value.list.syms);
874 nLevels = darray_size(value->value.list.symsMapIndex);
875 if ((keyi->numLevels[ndx] < nSyms || darray_empty(keyi->syms[ndx])) &&
876 (!ResizeKeyGroup(keyi, ndx, nLevels, nSyms, false))) {
877 log_wsgo(info->keymap->ctx,
878 "Could not resize group %u of key %s to contain %zu levels; "
880 ndx + 1, longText(keyi->name), nSyms);
883 keyi->symsDefined |= (1 << ndx);
884 for (i = 0; i < nLevels; i++) {
885 darray_item(keyi->symsMapIndex[ndx], i) =
886 darray_item(value->value.list.symsMapIndex, i);
887 darray_item(keyi->symsMapNumEntries[ndx], i) =
888 darray_item(value->value.list.symsNumEntries, i);
890 for (j = 0; j < darray_item(keyi->symsMapNumEntries[ndx], i); j++) {
891 /* FIXME: What's abort() doing here? */
892 if (darray_item(keyi->symsMapIndex[ndx], i) + j >= nSyms)
894 if (!LookupKeysym(darray_item(value->value.list.syms,
895 darray_item(value->value.list.symsMapIndex,
897 &darray_item(keyi->syms[ndx],
898 darray_item(keyi->symsMapIndex[ndx],
900 log_warn(info->keymap->ctx,
901 "Could not resolve keysym %s for key %s, group %u (%s), level %zu\n",
902 darray_item(value->value.list.syms, i),
903 longText(keyi->name),
905 xkb_atom_text(info->keymap->ctx,
906 info->groupNames[ndx]),
909 darray_item(keyi->syms[ndx],
910 darray_item(keyi->symsMapIndex[ndx],
911 i) + j) = XKB_KEY_NoSymbol;
912 darray_item(keyi->symsMapIndex[ndx], i) = -1;
913 darray_item(keyi->symsMapNumEntries[ndx], i) = 0;
916 if (darray_item(keyi->symsMapNumEntries[ndx], i) == 1 &&
917 darray_item(keyi->syms[ndx],
918 darray_item(keyi->symsMapIndex[ndx],
919 i) + j) == XKB_KEY_NoSymbol) {
920 darray_item(keyi->symsMapIndex[ndx], i) = -1;
921 darray_item(keyi->symsMapNumEntries[ndx], i) = 0;
925 for (j = keyi->numLevels[ndx] - 1;
926 j >= 0 && darray_item(keyi->symsMapNumEntries[ndx], j) == 0; j--)
927 keyi->numLevels[ndx]--;
932 AddActionsToKey(SymbolsInfo *info, KeyInfo *keyi, ExprDef *arrayNdx,
936 xkb_group_index_t ndx;
939 struct xkb_any_action *toAct;
941 if (!GetGroupIndex(info, keyi, arrayNdx, ACTIONS, &ndx))
945 keyi->actsDefined |= (1 << ndx);
949 if (value->op != ExprActionList) {
950 log_wsgo(info->keymap->ctx,
951 "Bad expression type (%d) for action list value; "
952 "Ignoring actions for group %u of %s\n",
953 value->op, ndx, longText(keyi->name));
957 if (!darray_empty(keyi->acts[ndx])) {
958 log_wsgo(info->keymap->ctx,
959 "Actions for key %s, group %u already defined\n",
960 longText(keyi->name), ndx);
964 for (nActs = 0, act = value->value.child; act != NULL; nActs++) {
965 act = (ExprDef *) act->common.next;
969 log_wsgo(info->keymap->ctx,
970 "Action list but not actions in AddActionsToKey\n");
974 if ((keyi->numLevels[ndx] < nActs || darray_empty(keyi->acts[ndx])) &&
975 !ResizeKeyGroup(keyi, ndx, nActs, nActs, true)) {
976 log_wsgo(info->keymap->ctx,
977 "Could not resize group %u of key %s; "
979 ndx, longText(keyi->name));
982 keyi->actsDefined |= (1 << ndx);
984 toAct = (struct xkb_any_action *) darray_mem(keyi->acts[ndx], 0);
985 act = value->value.child;
986 for (i = 0; i < nActs; i++, toAct++) {
987 if (!HandleActionDef(act, info->keymap, toAct, info->action)) {
988 log_err(info->keymap->ctx,
989 "Illegal action definition for %s; "
990 "Action for group %u/level %zu ignored\n",
991 longText(keyi->name), ndx + 1, i + 1);
993 act = (ExprDef *) act->common.next;
999 static const LookupEntry lockingEntries[] = {
1000 { "true", XkbKB_Lock },
1001 { "yes", XkbKB_Lock },
1002 { "on", XkbKB_Lock },
1003 { "false", XkbKB_Default },
1004 { "no", XkbKB_Default },
1005 { "off", XkbKB_Default },
1006 { "permanent", XkbKB_Lock | XkbKB_Permanent },
1010 static const LookupEntry repeatEntries[] = {
1011 { "true", RepeatYes },
1012 { "yes", RepeatYes },
1013 { "on", RepeatYes },
1014 { "false", RepeatNo },
1016 { "off", RepeatNo },
1017 { "default", RepeatUndefined },
1022 SetSymbolsField(SymbolsInfo *info, KeyInfo *keyi, const char *field,
1023 ExprDef *arrayNdx, ExprDef *value)
1027 struct xkb_context *ctx = info->keymap->ctx;
1029 if (strcasecmp(field, "type") == 0) {
1031 if (!ExprResolveString(ctx, value, &tmp))
1032 log_lvl(info->keymap->ctx, 1,
1033 "The type field of a key symbol map must be a string; "
1034 "Ignoring illegal type definition\n");
1035 if (arrayNdx == NULL) {
1036 keyi->dfltType = xkb_atom_intern(ctx, tmp.str);
1037 keyi->defined |= _Key_Type_Dflt;
1039 else if (!ExprResolveGroup(ctx, arrayNdx, &ndx)) {
1040 log_err(info->keymap->ctx,
1041 "Illegal group index for type of key %s; "
1042 "Definition with non-integer array index ignored\n",
1043 longText(keyi->name));
1047 keyi->types[ndx.uval - 1] = xkb_atom_intern(ctx, tmp.str);
1048 keyi->typesDefined |= (1 << (ndx.uval - 1));
1051 else if (strcasecmp(field, "symbols") == 0)
1052 return AddSymbolsToKey(info, keyi, arrayNdx, value);
1053 else if (strcasecmp(field, "actions") == 0)
1054 return AddActionsToKey(info, keyi, arrayNdx, value);
1055 else if ((strcasecmp(field, "vmods") == 0) ||
1056 (strcasecmp(field, "virtualmods") == 0) ||
1057 (strcasecmp(field, "virtualmodifiers") == 0)) {
1058 ok = ExprResolveVModMask(info->keymap, value, &tmp);
1060 keyi->vmodmap = (tmp.uval >> 8);
1061 keyi->defined |= _Key_VModMap;
1064 log_err(info->keymap->ctx,
1065 "Expected a virtual modifier mask, found %s; "
1066 "Ignoring virtual modifiers definition for key %s\n",
1067 exprOpText(value->op), longText(keyi->name));
1070 else if ((strcasecmp(field, "locking") == 0) ||
1071 (strcasecmp(field, "lock") == 0) ||
1072 (strcasecmp(field, "locks") == 0)) {
1073 ok = ExprResolveEnum(ctx, value, &tmp, lockingEntries);
1075 keyi->behavior.type = tmp.uval;
1076 keyi->defined |= _Key_Behavior;
1078 else if ((strcasecmp(field, "radiogroup") == 0) ||
1079 (strcasecmp(field, "permanentradiogroup") == 0) ||
1080 (strcasecmp(field, "allownone") == 0)) {
1081 log_err(info->keymap->ctx,
1082 "Radio groups not supported; "
1083 "Ignoring radio group specification for key %s\n",
1084 longText(keyi->name));
1087 else if (uStrCasePrefix("overlay", field) ||
1088 uStrCasePrefix("permanentoverlay", field)) {
1089 log_err(info->keymap->ctx,
1090 "Overlays not supported; "
1091 "Ignoring overlay specification for key %s\n",
1092 longText(keyi->name));
1094 else if ((strcasecmp(field, "repeating") == 0) ||
1095 (strcasecmp(field, "repeats") == 0) ||
1096 (strcasecmp(field, "repeat") == 0)) {
1097 ok = ExprResolveEnum(ctx, value, &tmp, repeatEntries);
1099 log_err(info->keymap->ctx,
1100 "Illegal repeat setting for %s; "
1101 "Non-boolean repeat setting ignored\n",
1102 longText(keyi->name));
1105 keyi->repeat = tmp.uval;
1106 keyi->defined |= _Key_Repeat;
1108 else if ((strcasecmp(field, "groupswrap") == 0) ||
1109 (strcasecmp(field, "wrapgroups") == 0)) {
1110 ok = ExprResolveBoolean(ctx, value, &tmp);
1112 log_err(info->keymap->ctx,
1113 "Illegal groupsWrap setting for %s; "
1114 "Non-boolean value ignored\n",
1115 longText(keyi->name));
1119 keyi->out_of_range_group_action = XkbWrapIntoRange;
1121 keyi->out_of_range_group_action = XkbClampIntoRange;
1122 keyi->defined |= _Key_GroupInfo;
1124 else if ((strcasecmp(field, "groupsclamp") == 0) ||
1125 (strcasecmp(field, "clampgroups") == 0)) {
1126 ok = ExprResolveBoolean(ctx, value, &tmp);
1128 log_err(info->keymap->ctx,
1129 "Illegal groupsClamp setting for %s; "
1130 "Non-boolean value ignored\n",
1131 longText(keyi->name));
1135 keyi->out_of_range_group_action = XkbClampIntoRange;
1137 keyi->out_of_range_group_action = XkbWrapIntoRange;
1138 keyi->defined |= _Key_GroupInfo;
1140 else if ((strcasecmp(field, "groupsredirect") == 0) ||
1141 (strcasecmp(field, "redirectgroups") == 0)) {
1142 if (!ExprResolveGroup(ctx, value, &tmp)) {
1143 log_err(info->keymap->ctx,
1144 "Illegal group index for redirect of key %s; "
1145 "Definition with non-integer group ignored\n",
1146 longText(keyi->name));
1149 keyi->out_of_range_group_action = XkbRedirectIntoRange;
1150 keyi->out_of_range_group_number = tmp.uval - 1;
1151 keyi->defined |= _Key_GroupInfo;
1154 log_err(info->keymap->ctx,
1155 "Unknown field %s in a symbol interpretation; "
1156 "Definition ignored\n",
1164 SetGroupName(SymbolsInfo *info, ExprDef *arrayNdx, ExprDef *value)
1166 ExprResult tmp, name;
1169 log_lvl(info->keymap->ctx, 1,
1170 "You must specify an index when specifying a group name; "
1171 "Group name definition without array subscript ignored\n");
1175 if (!ExprResolveGroup(info->keymap->ctx, arrayNdx, &tmp)) {
1176 log_err(info->keymap->ctx,
1177 "Illegal index in group name definition; "
1178 "Definition with non-integer array index ignored\n");
1182 if (!ExprResolveString(info->keymap->ctx, value, &name)) {
1183 log_err(info->keymap->ctx,
1184 "Group name must be a string; "
1185 "Illegal name for group %d ignored\n", tmp.uval);
1189 info->groupNames[tmp.uval - 1 + info->explicit_group] =
1190 xkb_atom_intern(info->keymap->ctx, name.str);
1196 HandleSymbolsVar(SymbolsInfo *info, VarDef *stmt)
1198 ExprResult elem, field;
1202 if (ExprResolveLhs(info->keymap, stmt->name, &elem, &field,
1204 return 0; /* internal error, already reported */
1205 if (elem.str && (strcasecmp(elem.str, "key") == 0)) {
1206 ret = SetSymbolsField(info, &info->dflt, field.str, arrayNdx,
1209 else if ((elem.str == NULL) && ((strcasecmp(field.str, "name") == 0) ||
1210 (strcasecmp(field.str, "groupname") ==
1212 ret = SetGroupName(info, arrayNdx, stmt->value);
1214 else if ((elem.str == NULL)
1215 && ((strcasecmp(field.str, "groupswrap") == 0) ||
1216 (strcasecmp(field.str, "wrapgroups") == 0))) {
1217 log_err(info->keymap->ctx,
1218 "Global \"groupswrap\" not supported; Ignored\n");
1221 else if ((elem.str == NULL)
1222 && ((strcasecmp(field.str, "groupsclamp") == 0) ||
1223 (strcasecmp(field.str, "clampgroups") == 0))) {
1224 log_err(info->keymap->ctx,
1225 "Global \"groupsclamp\" not supported; Ignored\n");
1228 else if ((elem.str == NULL)
1229 && ((strcasecmp(field.str, "groupsredirect") == 0) ||
1230 (strcasecmp(field.str, "redirectgroups") == 0))) {
1231 log_err(info->keymap->ctx,
1232 "Global \"groupsredirect\" not supported; Ignored\n");
1235 else if ((elem.str == NULL) &&
1236 (strcasecmp(field.str, "allownone") == 0)) {
1237 log_err(info->keymap->ctx,
1238 "Radio groups not supported; "
1239 "Ignoring \"allownone\" specification\n");
1243 ret = SetActionField(info->keymap, elem.str, field.str, arrayNdx,
1244 stmt->value, &info->action);
1251 HandleSymbolsBody(SymbolsInfo *info, VarDef *def, KeyInfo *keyi)
1254 ExprResult tmp, field;
1257 for (; def != NULL; def = (VarDef *) def->common.next) {
1258 if ((def->name) && (def->name->type == ExprFieldRef)) {
1259 ok = HandleSymbolsVar(info, def);
1264 if (!def->value || (def->value->op == ExprKeysymList))
1265 field.str = "symbols";
1267 field.str = "actions";
1271 ok = ExprResolveLhs(info->keymap, def->name, &tmp, &field,
1276 ok = SetSymbolsField(info, keyi, field.str, arrayNdx,
1284 SetExplicitGroup(SymbolsInfo *info, KeyInfo *keyi)
1286 xkb_group_index_t group = info->explicit_group;
1291 if ((keyi->typesDefined | keyi->symsDefined | keyi->actsDefined) & ~1) {
1292 xkb_group_index_t i;
1293 log_warn(info->keymap->ctx,
1294 "For the map %s an explicit group specified\n",
1296 log_warn(info->keymap->ctx,
1297 "but key %s has more than one group defined; "
1298 "All groups except first one will be ignored\n",
1299 longText(keyi->name));
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(SymbolsInfo *info, SymbolsDef *stmt)
1329 InitKeyInfo(&keyi, info->file_id);
1330 CopyKeyInfo(&info->dflt, &keyi, false);
1331 keyi.merge = stmt->merge;
1332 keyi.name = KeyNameToLong(stmt->keyName);
1333 if (!HandleSymbolsBody(info, (VarDef *) stmt->symbols, &keyi)) {
1338 if (!SetExplicitGroup(info, &keyi)) {
1343 if (!AddKeySymbols(info, &keyi)) {
1351 HandleModMapDef(SymbolsInfo *info, ModMapDef *def)
1357 struct xkb_context *ctx = info->keymap->ctx;
1359 if (!LookupModIndex(ctx, NULL, def->modifier, TypeInt, &rtrn)) {
1360 log_err(info->keymap->ctx,
1361 "Illegal modifier map definition; "
1362 "Ignoring map for non-modifier \"%s\"\n",
1363 xkb_atom_text(ctx, def->modifier));
1367 tmp.modifier = rtrn.uval;
1368 for (key = def->keys; key != NULL; key = (ExprDef *) key->common.next) {
1369 if ((key->op == ExprValue) && (key->type == TypeKeyName)) {
1370 tmp.haveSymbol = false;
1371 tmp.u.keyName = KeyNameToLong(key->value.keyName);
1373 else if (ExprResolveKeySym(ctx, key, &rtrn)) {
1374 tmp.haveSymbol = true;
1375 tmp.u.keySym = rtrn.uval;
1378 log_err(info->keymap->ctx,
1379 "Modmap entries may contain only key names or keysyms; "
1380 "Illegal definition for %s modifier ignored\n",
1381 ModIndexText(tmp.modifier));
1385 ok = AddModMapEntry(info, &tmp) && ok;
1391 HandleSymbolsFile(SymbolsInfo *info, XkbFile *file, enum merge_mode merge)
1396 info->name = uDupString(file->name);
1400 switch (stmt->stmtType) {
1402 if (!HandleIncludeSymbols(info, (IncludeStmt *) stmt))
1405 case StmtSymbolsDef:
1406 if (!HandleSymbolsDef(info, (SymbolsDef *) stmt))
1410 if (!HandleSymbolsVar(info, (VarDef *) stmt))
1414 if (!HandleVModDef((VModDef *) stmt, info->keymap, merge,
1419 log_err(info->keymap->ctx,
1420 "Interpretation files may not include other types; "
1421 "Ignoring definition of symbol interpretation\n");
1424 case StmtKeycodeDef:
1425 log_err(info->keymap->ctx,
1426 "Interpretation files may not include other types; "
1427 "Ignoring definition of key name\n");
1431 if (!HandleModMapDef(info, (ModMapDef *) stmt))
1435 log_wsgo(info->keymap->ctx,
1436 "Unexpected statement type %d in HandleSymbolsFile\n",
1441 if (info->errorCount > 10) {
1442 log_err(info->keymap->ctx, "Abandoning symbols file \"%s\"\n",
1450 * Given a keysym @sym, return a key which generates it, or NULL.
1451 * This is used for example in a modifier map definition, such as:
1452 * modifier_map Lock { Caps_Lock };
1453 * where we want to add the Lock modifier to the modmap of the key
1454 * which matches the keysym Caps_Lock.
1455 * Since there can be many keys which generates the keysym, the key
1456 * is chosen first by lowest group in which the keysym appears, than
1457 * by lowest level and than by lowest key code.
1459 static struct xkb_key *
1460 FindKeyForSymbol(struct xkb_keymap *keymap, xkb_keysym_t sym)
1462 struct xkb_key *key, *ret = NULL;
1463 xkb_group_index_t group, min_group = UINT_MAX;
1464 unsigned int level, min_level = UINT_MAX;
1466 xkb_foreach_key(key, keymap) {
1467 for (group = 0; group < key->num_groups; group++) {
1468 for (level = 0; level < XkbKeyGroupWidth(keymap, key, group);
1470 if (XkbKeyNumSyms(key, group, level) != 1 ||
1471 (XkbKeySymEntry(key, group, level))[0] != sym)
1475 * If the keysym was found in a group or level > 0, we must
1476 * keep looking since we might find a key in which the keysym
1477 * is in a lower group or level.
1479 if (group < min_group ||
1480 (group == min_group && level < min_level)) {
1482 if (group == 0 && level == 0) {
1498 * Find the given name in the keymap->map->types and return its index.
1500 * @param atom The atom to search for.
1501 * @param type_rtrn Set to the index of the name if found.
1503 * @return true if found, false otherwise.
1506 FindNamedType(struct xkb_keymap *keymap, xkb_atom_t atom, unsigned *type_rtrn)
1509 const char *name = xkb_atom_text(keymap->ctx, atom);
1510 struct xkb_key_type *type;
1513 darray_foreach(type, keymap->types) {
1514 if (strcmp(type->name, name) == 0) {
1525 * Assign a type to the given sym and return the Atom for the type assigned.
1528 * - ONE_LEVEL for width 0/1
1529 * - ALPHABETIC for 2 shift levels, with lower/upercase
1530 * - KEYPAD for keypad keys.
1531 * - TWO_LEVEL for other 2 shift level keys.
1532 * and the same for four level keys.
1534 * @param width Number of sysms in syms.
1535 * @param syms The keysyms for the given key (must be size width).
1536 * @param typeNameRtrn Set to the Atom of the type name.
1538 * @returns true if a type could be found, false otherwise.
1540 * FIXME: I need to take the KeyInfo so I can look at symsMapIndex and
1541 * all that fun stuff rather than just assuming there's always one
1545 FindAutomaticType(struct xkb_keymap *keymap, int width,
1546 const xkb_keysym_t *syms, xkb_atom_t *typeNameRtrn,
1550 if ((width == 1) || (width == 0)) {
1551 *typeNameRtrn = xkb_atom_intern(keymap->ctx, "ONE_LEVEL");
1554 else if (width == 2) {
1555 if (syms && xkb_keysym_is_lower(syms[0]) &&
1556 xkb_keysym_is_upper(syms[1])) {
1557 *typeNameRtrn = xkb_atom_intern(keymap->ctx, "ALPHABETIC");
1559 else if (syms && (xkb_keysym_is_keypad(syms[0]) ||
1560 xkb_keysym_is_keypad(syms[1]))) {
1561 *typeNameRtrn = xkb_atom_intern(keymap->ctx, "KEYPAD");
1565 *typeNameRtrn = xkb_atom_intern(keymap->ctx, "TWO_LEVEL");
1569 else if (width <= 4) {
1570 if (syms && xkb_keysym_is_lower(syms[0]) &&
1571 xkb_keysym_is_upper(syms[1]))
1572 if (xkb_keysym_is_lower(syms[2]) && xkb_keysym_is_upper(syms[3]))
1574 xkb_atom_intern(keymap->ctx, "FOUR_LEVEL_ALPHABETIC");
1576 *typeNameRtrn = xkb_atom_intern(keymap->ctx,
1577 "FOUR_LEVEL_SEMIALPHABETIC");
1579 else if (syms && (xkb_keysym_is_keypad(syms[0]) ||
1580 xkb_keysym_is_keypad(syms[1])))
1581 *typeNameRtrn = xkb_atom_intern(keymap->ctx, "FOUR_LEVEL_KEYPAD");
1583 *typeNameRtrn = xkb_atom_intern(keymap->ctx, "FOUR_LEVEL");
1584 /* XXX: why not set autoType here? */
1586 return ((width >= 0) && (width <= 4));
1590 * Ensure the given KeyInfo is in a coherent state, i.e. no gaps between the
1591 * groups, and reduce to one group if all groups are identical anyway.
1594 PrepareKeyDef(KeyInfo *keyi)
1596 xkb_group_index_t i, lastGroup;
1597 int j, width, defined;
1600 defined = keyi->symsDefined | keyi->actsDefined | keyi->typesDefined;
1601 /* get highest group number */
1602 for (i = XkbNumKbdGroups - 1; i > 0; i--) {
1603 if (defined & (1 << i))
1611 /* If there are empty groups between non-empty ones fill them with data */
1612 /* from the first group. */
1613 /* We can make a wrong assumption here. But leaving gaps is worse. */
1614 for (i = lastGroup; i > 0; i--) {
1615 if (defined & (1 << i))
1617 width = keyi->numLevels[0];
1618 if (keyi->typesDefined & 1) {
1619 for (j = 0; j < width; j++) {
1620 keyi->types[i] = keyi->types[0];
1622 keyi->typesDefined |= 1 << i;
1624 if ((keyi->actsDefined & 1) && !darray_empty(keyi->acts[0])) {
1625 darray_copy(keyi->acts[i], keyi->acts[0]);
1626 keyi->actsDefined |= 1 << i;
1628 if ((keyi->symsDefined & 1) && !darray_empty(keyi->syms[0])) {
1629 darray_copy(keyi->syms[i], keyi->syms[0]);
1630 darray_copy(keyi->symsMapIndex[i], keyi->symsMapIndex[0]);
1631 darray_copy(keyi->symsMapNumEntries[i],
1632 keyi->symsMapNumEntries[0]);
1633 keyi->symsDefined |= 1 << i;
1636 keyi->numLevels[i] = keyi->numLevels[0];
1639 /* If all groups are completely identical remove them all */
1640 /* exept the first one. */
1642 for (i = lastGroup; i > 0; i--) {
1643 if ((keyi->numLevels[i] != keyi->numLevels[0]) ||
1644 (keyi->types[i] != keyi->types[0])) {
1648 if (!darray_same(keyi->syms[i], keyi->syms[0]) &&
1649 (darray_empty(keyi->syms[i]) || darray_empty(keyi->syms[0]) ||
1650 darray_size(keyi->syms[i]) != darray_size(keyi->syms[0]) ||
1651 memcmp(darray_mem(keyi->syms[i], 0),
1652 darray_mem(keyi->syms[0], 0),
1653 sizeof(xkb_keysym_t) * darray_size(keyi->syms[0])))) {
1657 if (!darray_same(keyi->symsMapIndex[i], keyi->symsMapIndex[0]) &&
1658 (darray_empty(keyi->symsMapIndex[i]) ||
1659 darray_empty(keyi->symsMapIndex[0]) ||
1660 memcmp(darray_mem(keyi->symsMapIndex[i], 0),
1661 darray_mem(keyi->symsMapIndex[0], 0),
1662 keyi->numLevels[0] * sizeof(int)))) {
1666 if (!darray_same(keyi->symsMapNumEntries[i],
1667 keyi->symsMapNumEntries[0]) &&
1668 (darray_empty(keyi->symsMapNumEntries[i]) ||
1669 darray_empty(keyi->symsMapNumEntries[0]) ||
1670 memcmp(darray_mem(keyi->symsMapNumEntries[i], 0),
1671 darray_mem(keyi->symsMapNumEntries[0], 0),
1672 keyi->numLevels[0] * sizeof(size_t)))) {
1676 if (!darray_same(keyi->acts[i], keyi->acts[0]) &&
1677 (darray_empty(keyi->acts[i]) || darray_empty(keyi->acts[0]) ||
1678 memcmp(darray_mem(keyi->acts[i], 0),
1679 darray_mem(keyi->acts[0], 0),
1680 keyi->numLevels[0] * sizeof(union xkb_action)))) {
1686 for (i = lastGroup; i > 0; i--) {
1687 keyi->numLevels[i] = 0;
1688 darray_free(keyi->syms[i]);
1689 darray_free(keyi->symsMapIndex[i]);
1690 darray_free(keyi->symsMapNumEntries[i]);
1691 darray_free(keyi->acts[i]);
1694 keyi->symsDefined &= 1;
1695 keyi->actsDefined &= 1;
1696 keyi->typesDefined &= 1;
1701 * Copy the KeyInfo into the keyboard description.
1703 * This function recurses.
1706 CopySymbolsDef(SymbolsInfo *info, KeyInfo *keyi,
1707 xkb_keycode_t start_from)
1709 struct xkb_keymap *keymap = info->keymap;
1711 struct xkb_key *key;
1712 size_t sizeSyms = 0;
1713 xkb_group_index_t i, nGroups;
1714 unsigned width, tmp;
1715 struct xkb_key_type * type;
1716 bool haveActions, autoType, useAlias;
1717 unsigned types[XkbNumKbdGroups];
1718 union xkb_action *outActs;
1719 unsigned int symIndex = 0;
1721 useAlias = (start_from == 0);
1723 key = FindNamedKey(keymap, keyi->name, useAlias,
1724 CreateKeyNames(keymap), start_from);
1726 if (start_from == 0)
1727 log_lvl(info->keymap->ctx, 5,
1728 "Key %s not found in keycodes; Symbols ignored\n",
1729 longText(keyi->name));
1732 kc = XkbKeyGetKeycode(keymap, key);
1734 haveActions = false;
1736 for (i = nGroups = 0; i < XkbNumKbdGroups; i++) {
1737 if (((i + 1) > nGroups)
1738 && (((keyi->symsDefined | keyi->actsDefined) & (1 << i))
1739 || (keyi->typesDefined) & (1 << i)))
1741 if (!darray_empty(keyi->acts[i]))
1744 /* Assign the type to the key, if it is missing. */
1745 if (keyi->types[i] == XKB_ATOM_NONE) {
1746 if (keyi->dfltType != XKB_ATOM_NONE)
1747 keyi->types[i] = keyi->dfltType;
1748 else if (FindAutomaticType(keymap, keyi->numLevels[i],
1749 darray_mem(keyi->syms[i], 0),
1750 &keyi->types[i], &autoType)) { }
1752 log_lvl(info->keymap->ctx, 5,
1753 "No automatic type for %d symbols; "
1754 "Using %s for the %s key (keycode %d)\n",
1756 xkb_atom_text(keymap->ctx, keyi->types[i]),
1757 longText(keyi->name), kc);
1759 if (FindNamedType(keymap, keyi->types[i], &types[i])) {
1760 if (!autoType || keyi->numLevels[i] > 2)
1761 key->explicit |= (1 << i);
1764 log_lvl(info->keymap->ctx, 3,
1765 "Type \"%s\" is not defined; "
1766 "Using TWO_LEVEL for the %s key (keycode %d)\n",
1767 xkb_atom_text(keymap->ctx, keyi->types[i]),
1768 longText(keyi->name), kc);
1769 types[i] = XkbTwoLevelIndex;
1772 /* if the type specifies fewer levels than the key has, shrink the key */
1773 type = &darray_item(keymap->types, types[i]);
1774 if (type->num_levels < keyi->numLevels[i]) {
1775 log_lvl(info->keymap->ctx, 1,
1776 "Type \"%s\" has %d levels, but %s has %d symbols; "
1777 "Ignoring extra symbols\n",
1778 type->name, type->num_levels,
1779 longText(keyi->name),
1780 keyi->numLevels[i]);
1781 keyi->numLevels[i] = type->num_levels;
1783 if (keyi->numLevels[i] > width)
1784 width = keyi->numLevels[i];
1785 if (type->num_levels > width)
1786 width = type->num_levels;
1787 sizeSyms += darray_size(keyi->syms[i]);
1790 darray_resize0(key->syms, sizeSyms);
1793 outActs = ResizeKeyActions(keymap, key, width * nGroups);
1794 if (outActs == NULL) {
1795 log_wsgo(info->keymap->ctx,
1796 "Could not enlarge actions for %s (key %d)\n",
1797 longText(keyi->name), kc);
1800 key->explicit |= XkbExplicitInterpretMask;
1805 key->num_groups = nGroups;
1806 if (keyi->defined & _Key_GroupInfo) {
1807 key->out_of_range_group_number = keyi->out_of_range_group_number;
1808 key->out_of_range_group_action = keyi->out_of_range_group_action;
1811 key->sym_index = calloc(nGroups * width, sizeof(*key->sym_index));
1812 key->num_syms = calloc(nGroups * width, sizeof(*key->num_syms));
1814 for (i = 0; i < nGroups; i++) {
1815 /* assign kt_index[i] to the index of the type in map->types.
1816 * kt_index[i] may have been set by a previous run (if we have two
1817 * layouts specified). Let's not overwrite it with the ONE_LEVEL
1818 * default group if we dont even have keys for this group anyway.
1820 * FIXME: There should be a better fix for this.
1822 if (keyi->numLevels[i])
1823 key->kt_index[i] = types[i];
1824 if (!darray_empty(keyi->syms[i])) {
1825 /* fill key to "width" symbols*/
1826 for (tmp = 0; tmp < width; tmp++) {
1827 if (tmp < keyi->numLevels[i] &&
1828 darray_item(keyi->symsMapNumEntries[i], tmp) != 0) {
1829 memcpy(darray_mem(key->syms, symIndex),
1830 darray_mem(keyi->syms[i],
1831 darray_item(keyi->symsMapIndex[i], tmp)),
1832 darray_item(keyi->symsMapNumEntries[i],
1833 tmp) * sizeof(xkb_keysym_t));
1834 key->sym_index[(i * width) + tmp] = symIndex;
1835 key->num_syms[(i * width) + tmp] =
1836 darray_item(keyi->symsMapNumEntries[i], tmp);
1837 symIndex += key->num_syms[(i * width) + tmp];
1840 key->sym_index[(i * width) + tmp] = -1;
1841 key->num_syms[(i * width) + tmp] = 0;
1843 if (outActs != NULL && !darray_empty(keyi->acts[i])) {
1844 if (tmp < keyi->numLevels[i])
1845 outActs[tmp] = darray_item(keyi->acts[i], tmp);
1847 outActs[tmp].type = XkbSA_NoAction;
1852 switch (keyi->behavior.type & XkbKB_OpMask) {
1857 key->behavior = keyi->behavior;
1858 key->explicit |= XkbExplicitBehaviorMask;
1861 if (keyi->defined & _Key_VModMap) {
1862 key->vmodmap = keyi->vmodmap;
1863 key->explicit |= XkbExplicitVModMapMask;
1865 if (keyi->repeat != RepeatUndefined) {
1866 key->repeats = keyi->repeat == RepeatYes;
1867 key->explicit |= XkbExplicitAutoRepeatMask;
1870 /* do the same thing for the next key */
1871 CopySymbolsDef(info, keyi, kc + 1);
1876 CopyModMapDef(SymbolsInfo *info, ModMapEntry *entry)
1878 struct xkb_key *key;
1879 struct xkb_keymap *keymap = info->keymap;
1881 if (!entry->haveSymbol) {
1882 key = FindNamedKey(keymap, entry->u.keyName, true,
1883 CreateKeyNames(keymap), 0);
1885 log_lvl(info->keymap->ctx, 5,
1886 "Key %s not found in keycodes; "
1887 "Modifier map entry for %s not updated\n",
1888 longText(entry->u.keyName),
1889 ModIndexText(entry->modifier));
1894 key = FindKeyForSymbol(keymap, entry->u.keySym);
1896 log_lvl(info->keymap->ctx, 5,
1897 "Key \"%s\" not found in symbol map; "
1898 "Modifier map entry for %s not updated\n",
1899 KeysymText(entry->u.keySym),
1900 ModIndexText(entry->modifier));
1905 key->modmap |= (1 << entry->modifier);
1910 * Handle the xkb_symbols section of an xkb file.
1912 * @param file The parsed xkb_symbols section of the xkb file.
1913 * @param keymap Handle to the keyboard description to store the symbols in.
1914 * @param merge Merge strategy (e.g. MERGE_OVERRIDE).
1917 CompileSymbols(XkbFile *file, struct xkb_keymap *keymap,
1918 enum merge_mode merge)
1920 xkb_group_index_t i;
1921 struct xkb_key *key;
1926 InitSymbolsInfo(&info, keymap, file->id);
1927 info.dflt.merge = merge;
1929 HandleSymbolsFile(&info, file, merge);
1931 if (darray_empty(info.keys))
1934 if (info.errorCount != 0)
1937 darray_resize0(keymap->acts, darray_size(keymap->acts) + 32 + 1);
1940 keymap->symbols_section_name = strdup(info.name);
1942 for (i = 0; i < XkbNumKbdGroups; i++) {
1943 if (info.groupNames[i] != XKB_ATOM_NONE) {
1944 keymap->group_names[i] = xkb_atom_text(keymap->ctx,
1945 info.groupNames[i]);
1950 darray_foreach(keyi, info.keys)
1951 PrepareKeyDef(keyi);
1954 darray_foreach(keyi, info.keys)
1955 if (!CopySymbolsDef(&info, keyi, 0))
1958 if (xkb_get_log_verbosity(keymap->ctx) > 3) {
1959 xkb_foreach_key(key, keymap) {
1960 if (key->name[0] == '\0')
1963 if (key->num_groups < 1)
1964 log_warn(info.keymap->ctx,
1965 "No symbols defined for <%.4s> (keycode %d)\n",
1966 key->name, XkbKeyGetKeycode(keymap, key));
1970 list_foreach(mm, &info.modMaps, entry)
1971 if (!CopyModMapDef(&info, mm))
1974 FreeSymbolsInfo(&info);
1978 FreeSymbolsInfo(&info);