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 ********************************************************/
28 * Copyright © 2012 Intel Corporation
29 * Copyright © 2012 Ran Benita <ran234@gmail.com>
31 * Permission is hereby granted, free of charge, to any person obtaining a
32 * copy of this software and associated documentation files (the "Software"),
33 * to deal in the Software without restriction, including without limitation
34 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
35 * and/or sell copies of the Software, and to permit persons to whom the
36 * Software is furnished to do so, subject to the following conditions:
38 * The above copyright notice and this permission notice (including the next
39 * paragraph) shall be included in all copies or substantial portions of the
42 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
43 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
44 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
45 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
46 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
47 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
48 * DEALINGS IN THE SOFTWARE.
50 * Author: Daniel Stone <daniel@fooishbar.org>
51 * Ran Benita <ran234@gmail.com>
54 #include "xkbcomp-priv.h"
63 KEY_REPEAT_UNDEFINED = 0,
69 GROUP_FIELD_SYMS = (1 << 0),
70 GROUP_FIELD_ACTS = (1 << 1),
71 GROUP_FIELD_TYPE = (1 << 2),
75 KEY_FIELD_REPEAT = (1 << 0),
76 KEY_FIELD_DEFAULT_TYPE = (1 << 1),
77 KEY_FIELD_GROUPINFO = (1 << 2),
78 KEY_FIELD_VMODMAP = (1 << 3),
82 enum group_field defined;
83 darray(struct xkb_level) levels;
88 enum key_field defined;
89 enum merge_mode merge;
93 darray(GroupInfo) groups;
95 enum key_repeat repeat;
96 xkb_mod_mask_t vmodmap;
97 xkb_atom_t default_type;
99 enum xkb_range_exceed_type out_of_range_group_action;
100 xkb_layout_index_t out_of_range_group_number;
104 ClearLevelInfo(struct xkb_level *leveli)
106 if (leveli->num_syms > 1)
107 free(leveli->u.syms);
111 InitGroupInfo(GroupInfo *groupi)
113 memset(groupi, 0, sizeof(*groupi));
117 ClearGroupInfo(GroupInfo *groupi)
119 struct xkb_level *leveli;
120 darray_foreach(leveli, groupi->levels)
121 ClearLevelInfo(leveli);
122 darray_free(groupi->levels);
126 CopyGroupInfo(GroupInfo *to, const GroupInfo *from)
128 to->defined = from->defined;
129 to->type = from->type;
130 darray_init(to->levels);
131 darray_copy(to->levels, from->levels);
132 for (xkb_level_index_t j = 0; j < darray_size(to->levels); j++)
133 if (darray_item(from->levels, j).num_syms > 1)
134 darray_item(to->levels, j).u.syms =
135 memdup(darray_item(from->levels, j).u.syms,
136 darray_item(from->levels, j).num_syms,
137 sizeof(xkb_keysym_t));
141 InitKeyInfo(struct xkb_context *ctx, KeyInfo *keyi)
143 memset(keyi, 0, sizeof(*keyi));
144 keyi->merge = MERGE_OVERRIDE;
145 keyi->name = xkb_atom_intern_literal(ctx, "*");
146 keyi->out_of_range_group_action = RANGE_WRAP;
150 ClearKeyInfo(KeyInfo *keyi)
153 darray_foreach(groupi, keyi->groups)
154 ClearGroupInfo(groupi);
155 darray_free(keyi->groups);
158 /***====================================================================***/
161 enum merge_mode merge;
163 xkb_mod_index_t modifier;
171 char *name; /* e.g. pc+us+inet(evdev) */
173 enum merge_mode merge;
174 xkb_layout_index_t explicit_group;
175 darray(KeyInfo) keys;
177 ActionsInfo *actions;
178 darray(xkb_atom_t) group_names;
179 darray(ModMapEntry) modmaps;
180 struct xkb_mod_set mods;
182 struct xkb_context *ctx;
183 /* Needed for AddKeySymbols. */
184 const struct xkb_keymap *keymap;
188 InitSymbolsInfo(SymbolsInfo *info, const struct xkb_keymap *keymap,
189 ActionsInfo *actions, const struct xkb_mod_set *mods)
191 memset(info, 0, sizeof(*info));
192 info->ctx = keymap->ctx;
193 info->keymap = keymap;
194 info->merge = MERGE_OVERRIDE;
195 InitKeyInfo(keymap->ctx, &info->default_key);
196 info->actions = actions;
198 info->explicit_group = XKB_LAYOUT_INVALID;
202 ClearSymbolsInfo(SymbolsInfo *info)
206 darray_foreach(keyi, info->keys)
208 darray_free(info->keys);
209 darray_free(info->group_names);
210 darray_free(info->modmaps);
211 ClearKeyInfo(&info->default_key);
215 KeyInfoText(SymbolsInfo *info, KeyInfo *keyi)
217 return KeyNameText(info->ctx, keyi->name);
221 MergeGroups(SymbolsInfo *info, GroupInfo *into, GroupInfo *from, bool clobber,
222 bool report, xkb_layout_index_t group, xkb_atom_t key_name)
224 xkb_level_index_t i, levels_in_both;
226 /* First find the type of the merged group. */
227 if (into->type != from->type) {
228 if (from->type == XKB_ATOM_NONE) {
230 else if (into->type == XKB_ATOM_NONE) {
231 into->type = from->type;
234 xkb_atom_t use = (clobber ? from->type : into->type);
235 xkb_atom_t ignore = (clobber ? into->type : from->type);
239 "Multiple definitions for group %d type of key %s; "
240 "Using %s, ignoring %s\n",
241 group + 1, KeyNameText(info->ctx, key_name),
242 xkb_atom_text(info->ctx, use),
243 xkb_atom_text(info->ctx, ignore));
248 into->defined |= (from->defined & GROUP_FIELD_TYPE);
250 /* Now look at the levels. */
252 if (darray_empty(from->levels)) {
257 if (darray_empty(into->levels)) {
258 from->type = into->type;
264 /* Merge the actions and syms. */
265 levels_in_both = MIN(darray_size(into->levels), darray_size(from->levels));
266 for (i = 0; i < levels_in_both; i++) {
267 struct xkb_level *intoLevel = &darray_item(into->levels, i);
268 struct xkb_level *fromLevel = &darray_item(from->levels, i);
270 if (fromLevel->action.type == ACTION_TYPE_NONE) {
272 else if (intoLevel->action.type == ACTION_TYPE_NONE) {
273 intoLevel->action = fromLevel->action;
276 union xkb_action *use, *ignore;
277 use = (clobber ? &fromLevel->action : &intoLevel->action);
278 ignore = (clobber ? &intoLevel->action : &fromLevel->action);
282 "Multiple actions for level %d/group %u on key %s; "
283 "Using %s, ignoring %s\n",
284 i + 1, group + 1, KeyNameText(info->ctx, key_name),
285 ActionTypeText(use->type),
286 ActionTypeText(ignore->type));
288 intoLevel->action = *use;
291 if (fromLevel->num_syms == 0) {
293 else if (intoLevel->num_syms == 0) {
294 intoLevel->num_syms = fromLevel->num_syms;
295 if (fromLevel->num_syms > 1)
296 intoLevel->u.syms = fromLevel->u.syms;
298 intoLevel->u.sym = fromLevel->u.sym;
299 fromLevel->num_syms = 0;
304 "Multiple symbols for level %d/group %u on key %s; "
305 "Using %s, ignoring %s\n",
306 i + 1, group + 1, KeyNameText(info->ctx, key_name),
307 (clobber ? "from" : "to"),
308 (clobber ? "to" : "from"));
311 ClearLevelInfo(intoLevel);
312 intoLevel->num_syms = fromLevel->num_syms;
313 if (fromLevel->num_syms > 1)
314 intoLevel->u.syms = fromLevel->u.syms;
316 intoLevel->u.sym = fromLevel->u.sym;
317 fromLevel->num_syms = 0;
321 /* If @from has extra levels, get them as well. */
322 for (i = levels_in_both; i < darray_size(from->levels); i++) {
323 darray_append(into->levels, darray_item(from->levels, i));
324 darray_item(from->levels, i).num_syms = 0;
326 into->defined |= (from->defined & GROUP_FIELD_ACTS);
327 into->defined |= (from->defined & GROUP_FIELD_SYMS);
333 UseNewKeyField(enum key_field field, enum key_field old, enum key_field new,
334 bool clobber, bool report, enum key_field *collide)
337 return (new & field);
351 MergeKeys(SymbolsInfo *info, KeyInfo *into, KeyInfo *from, bool same_file)
353 xkb_layout_index_t i;
354 xkb_layout_index_t groups_in_both;
355 enum key_field collide = 0;
356 const int verbosity = xkb_context_get_log_verbosity(info->ctx);
357 const bool clobber = (from->merge != MERGE_AUGMENT);
358 const bool report = (same_file && verbosity > 0) || verbosity > 9;
360 if (from->merge == MERGE_REPLACE) {
363 InitKeyInfo(info->ctx, from);
367 groups_in_both = MIN(darray_size(into->groups), darray_size(from->groups));
368 for (i = 0; i < groups_in_both; i++)
370 &darray_item(into->groups, i),
371 &darray_item(from->groups, i),
372 clobber, report, i, into->name);
373 /* If @from has extra groups, just move them to @into. */
374 for (i = groups_in_both; i < darray_size(from->groups); i++) {
375 darray_append(into->groups, darray_item(from->groups, i));
376 InitGroupInfo(&darray_item(from->groups, i));
379 if (UseNewKeyField(KEY_FIELD_VMODMAP, into->defined, from->defined,
380 clobber, report, &collide)) {
381 into->vmodmap = from->vmodmap;
382 into->defined |= KEY_FIELD_VMODMAP;
384 if (UseNewKeyField(KEY_FIELD_REPEAT, into->defined, from->defined,
385 clobber, report, &collide)) {
386 into->repeat = from->repeat;
387 into->defined |= KEY_FIELD_REPEAT;
389 if (UseNewKeyField(KEY_FIELD_DEFAULT_TYPE, into->defined, from->defined,
390 clobber, report, &collide)) {
391 into->default_type = from->default_type;
392 into->defined |= KEY_FIELD_DEFAULT_TYPE;
394 if (UseNewKeyField(KEY_FIELD_GROUPINFO, into->defined, from->defined,
395 clobber, report, &collide)) {
396 into->out_of_range_group_action = from->out_of_range_group_action;
397 into->out_of_range_group_number = from->out_of_range_group_number;
398 into->defined |= KEY_FIELD_GROUPINFO;
403 "Symbol map for key %s redefined; "
404 "Using %s definition for conflicting fields\n",
405 KeyNameText(info->ctx, into->name),
406 (clobber ? "first" : "last"));
409 InitKeyInfo(info->ctx, from);
413 /* TODO: Make it so this function doesn't need the entire keymap. */
415 AddKeySymbols(SymbolsInfo *info, KeyInfo *keyi, bool same_file)
417 xkb_atom_t real_name;
421 * Don't keep aliases in the keys array; this guarantees that
422 * searching for keys to merge with by straight comparison (see the
423 * following loop) is enough, and we won't get multiple KeyInfo's
424 * for the same key because of aliases.
426 real_name = XkbResolveKeyAlias(info->keymap, keyi->name);
427 if (real_name != XKB_ATOM_NONE)
428 keyi->name = real_name;
430 darray_foreach(iter, info->keys)
431 if (iter->name == keyi->name)
432 return MergeKeys(info, iter, keyi, same_file);
434 darray_append(info->keys, *keyi);
435 InitKeyInfo(info->ctx, keyi);
440 AddModMapEntry(SymbolsInfo *info, ModMapEntry *new)
443 bool clobber = (new->merge != MERGE_AUGMENT);
445 darray_foreach(old, info->modmaps) {
446 xkb_mod_index_t use, ignore;
448 if ((new->haveSymbol != old->haveSymbol) ||
449 (new->haveSymbol && new->u.keySym != old->u.keySym) ||
450 (!new->haveSymbol && new->u.keyName != old->u.keyName))
453 if (new->modifier == old->modifier)
456 use = (clobber ? new->modifier : old->modifier);
457 ignore = (clobber ? old->modifier : new->modifier);
461 "Symbol \"%s\" added to modifier map for multiple modifiers; "
462 "Using %s, ignoring %s\n",
463 KeysymText(info->ctx, new->u.keySym),
464 ModIndexText(info->ctx, &info->mods, use),
465 ModIndexText(info->ctx, &info->mods, ignore));
468 "Key \"%s\" added to modifier map for multiple modifiers; "
469 "Using %s, ignoring %s\n",
470 KeyNameText(info->ctx, new->u.keyName),
471 ModIndexText(info->ctx, &info->mods, use),
472 ModIndexText(info->ctx, &info->mods, ignore));
478 darray_append(info->modmaps, *new);
482 /***====================================================================***/
485 MergeIncludedSymbols(SymbolsInfo *into, SymbolsInfo *from,
486 enum merge_mode merge)
490 xkb_atom_t *group_name;
491 xkb_layout_index_t group_names_in_both;
493 if (from->errorCount > 0) {
494 into->errorCount += from->errorCount;
498 into->mods = from->mods;
500 if (into->name == NULL) {
501 into->name = from->name;
505 group_names_in_both = MIN(darray_size(into->group_names),
506 darray_size(from->group_names));
507 for (xkb_layout_index_t i = 0; i < group_names_in_both; i++) {
508 if (!darray_item(from->group_names, i))
511 if (merge == MERGE_AUGMENT && darray_item(into->group_names, i))
514 darray_item(into->group_names, i) = darray_item(from->group_names, i);
516 /* If @from has more, get them as well. */
517 darray_foreach_from(group_name, from->group_names, group_names_in_both)
518 darray_append(into->group_names, *group_name);
520 if (darray_empty(into->keys)) {
521 into->keys = from->keys;
522 darray_init(from->keys);
525 darray_foreach(keyi, from->keys) {
526 keyi->merge = (merge == MERGE_DEFAULT ? keyi->merge : merge);
527 if (!AddKeySymbols(into, keyi, false))
532 if (darray_empty(into->modmaps)) {
533 into->modmaps = from->modmaps;
534 darray_init(from->modmaps);
537 darray_foreach(mm, from->modmaps) {
538 mm->merge = (merge == MERGE_DEFAULT ? mm->merge : merge);
539 if (!AddModMapEntry(into, mm))
546 HandleSymbolsFile(SymbolsInfo *info, XkbFile *file, enum merge_mode merge);
549 HandleIncludeSymbols(SymbolsInfo *info, IncludeStmt *include)
551 SymbolsInfo included;
553 InitSymbolsInfo(&included, info->keymap, info->actions, &info->mods);
554 included.name = include->stmt;
555 include->stmt = NULL;
557 for (IncludeStmt *stmt = include; stmt; stmt = stmt->next_incl) {
558 SymbolsInfo next_incl;
561 file = ProcessIncludeFile(info->ctx, stmt, FILE_TYPE_SYMBOLS);
563 info->errorCount += 10;
564 ClearSymbolsInfo(&included);
568 InitSymbolsInfo(&next_incl, info->keymap, info->actions,
570 if (stmt->modifier) {
571 next_incl.explicit_group = atoi(stmt->modifier) - 1;
572 if (next_incl.explicit_group >= XKB_MAX_GROUPS) {
574 "Cannot set explicit group to %d - must be between 1..%d; "
575 "Ignoring group number\n",
576 next_incl.explicit_group + 1, XKB_MAX_GROUPS);
577 next_incl.explicit_group = info->explicit_group;
581 next_incl.explicit_group = info->explicit_group;
584 HandleSymbolsFile(&next_incl, file, MERGE_OVERRIDE);
586 MergeIncludedSymbols(&included, &next_incl, stmt->merge);
588 ClearSymbolsInfo(&next_incl);
592 MergeIncludedSymbols(info, &included, include->merge);
593 ClearSymbolsInfo(&included);
595 return (info->errorCount == 0);
602 GetGroupIndex(SymbolsInfo *info, KeyInfo *keyi, ExprDef *arrayNdx,
603 unsigned what, xkb_layout_index_t *ndx_rtrn)
605 const char *name = (what == SYMBOLS ? "symbols" : "actions");
607 if (arrayNdx == NULL) {
608 xkb_layout_index_t i;
610 enum group_field field = (what == SYMBOLS ?
611 GROUP_FIELD_SYMS : GROUP_FIELD_ACTS);
613 darray_enumerate(i, groupi, keyi->groups) {
614 if (!(groupi->defined & field)) {
620 if (i >= XKB_MAX_GROUPS) {
622 "Too many groups of %s for key %s (max %u); "
623 "Ignoring %s defined for extra groups\n",
624 name, KeyInfoText(info, keyi), XKB_MAX_GROUPS, name);
628 darray_resize0(keyi->groups, darray_size(keyi->groups) + 1);
629 *ndx_rtrn = darray_size(keyi->groups) - 1;
633 if (!ExprResolveGroup(info->ctx, arrayNdx, ndx_rtrn)) {
635 "Illegal group index for %s of key %s\n"
636 "Definition with non-integer array index ignored\n",
637 name, KeyInfoText(info, keyi));
642 if (*ndx_rtrn >= darray_size(keyi->groups))
643 darray_resize0(keyi->groups, *ndx_rtrn + 1);
649 AddSymbolsToKey(SymbolsInfo *info, KeyInfo *keyi, ExprDef *arrayNdx,
652 xkb_layout_index_t ndx;
654 xkb_level_index_t nLevels;
656 if (!GetGroupIndex(info, keyi, arrayNdx, SYMBOLS, &ndx))
659 groupi = &darray_item(keyi->groups, ndx);
662 groupi->defined |= GROUP_FIELD_SYMS;
666 if (value->expr.op != EXPR_KEYSYM_LIST) {
668 "Expected a list of symbols, found %s; "
669 "Ignoring symbols for group %u of %s\n",
670 expr_op_type_to_string(value->expr.op), ndx + 1,
671 KeyInfoText(info, keyi));
675 if (groupi->defined & GROUP_FIELD_SYMS) {
677 "Symbols for key %s, group %u already defined; "
678 "Ignoring duplicate definition\n",
679 KeyInfoText(info, keyi), ndx + 1);
683 nLevels = darray_size(value->keysym_list.symsMapIndex);
684 if (darray_size(groupi->levels) < nLevels)
685 darray_resize0(groupi->levels, nLevels);
687 groupi->defined |= GROUP_FIELD_SYMS;
689 for (xkb_level_index_t i = 0; i < nLevels; i++) {
690 unsigned int sym_index;
691 struct xkb_level *leveli = &darray_item(groupi->levels, i);
693 sym_index = darray_item(value->keysym_list.symsMapIndex, i);
694 leveli->num_syms = darray_item(value->keysym_list.symsNumEntries, i);
695 if (leveli->num_syms > 1)
696 leveli->u.syms = calloc(leveli->num_syms, sizeof(*leveli->u.syms));
698 for (unsigned j = 0; j < leveli->num_syms; j++) {
699 xkb_keysym_t keysym = darray_item(value->keysym_list.syms,
702 if (leveli->num_syms == 1) {
703 if (keysym == XKB_KEY_NoSymbol)
704 leveli->num_syms = 0;
706 leveli->u.sym = keysym;
708 else if (leveli->num_syms > 1) {
709 leveli->u.syms[j] = keysym;
718 AddActionsToKey(SymbolsInfo *info, KeyInfo *keyi, ExprDef *arrayNdx,
721 xkb_layout_index_t ndx;
726 if (!GetGroupIndex(info, keyi, arrayNdx, ACTIONS, &ndx))
729 groupi = &darray_item(keyi->groups, ndx);
732 groupi->defined |= GROUP_FIELD_ACTS;
736 if (value->expr.op != EXPR_ACTION_LIST) {
738 "Bad expression type (%d) for action list value; "
739 "Ignoring actions for group %u of %s\n",
740 value->expr.op, ndx, KeyInfoText(info, keyi));
744 if (groupi->defined & GROUP_FIELD_ACTS) {
746 "Actions for key %s, group %u already defined\n",
747 KeyInfoText(info, keyi), ndx);
752 for (act = value->unary.child; act; act = (ExprDef *) act->common.next)
755 if (darray_size(groupi->levels) < nActs)
756 darray_resize0(groupi->levels, nActs);
758 groupi->defined |= GROUP_FIELD_ACTS;
760 act = value->unary.child;
761 for (unsigned i = 0; i < nActs; i++) {
762 union xkb_action *toAct = &darray_item(groupi->levels, i).action;
764 if (!HandleActionDef(info->ctx, info->actions, &info->mods, act, toAct))
766 "Illegal action definition for %s; "
767 "Action for group %u/level %u ignored\n",
768 KeyInfoText(info, keyi), ndx + 1, i + 1);
770 act = (ExprDef *) act->common.next;
776 static const LookupEntry repeatEntries[] = {
777 { "true", KEY_REPEAT_YES },
778 { "yes", KEY_REPEAT_YES },
779 { "on", KEY_REPEAT_YES },
780 { "false", KEY_REPEAT_NO },
781 { "no", KEY_REPEAT_NO },
782 { "off", KEY_REPEAT_NO },
783 { "default", KEY_REPEAT_UNDEFINED },
788 SetSymbolsField(SymbolsInfo *info, KeyInfo *keyi, const char *field,
789 ExprDef *arrayNdx, ExprDef *value)
791 if (istreq(field, "type")) {
792 xkb_layout_index_t ndx;
795 if (!ExprResolveString(info->ctx, value, &val)) {
797 "The type field of a key symbol map must be a string; "
798 "Ignoring illegal type definition\n");
803 keyi->default_type = val;
804 keyi->defined |= KEY_FIELD_DEFAULT_TYPE;
806 else if (!ExprResolveGroup(info->ctx, arrayNdx, &ndx)) {
808 "Illegal group index for type of key %s; "
809 "Definition with non-integer array index ignored\n",
810 KeyInfoText(info, keyi));
815 if (ndx >= darray_size(keyi->groups))
816 darray_resize0(keyi->groups, ndx + 1);
817 darray_item(keyi->groups, ndx).type = val;
818 darray_item(keyi->groups, ndx).defined |= GROUP_FIELD_TYPE;
821 else if (istreq(field, "symbols")) {
822 return AddSymbolsToKey(info, keyi, arrayNdx, value);
824 else if (istreq(field, "actions")) {
825 return AddActionsToKey(info, keyi, arrayNdx, value);
827 else if (istreq(field, "vmods") ||
828 istreq(field, "virtualmods") ||
829 istreq(field, "virtualmodifiers")) {
832 if (!ExprResolveModMask(info->ctx, value, MOD_VIRT, &info->mods,
835 "Expected a virtual modifier mask, found %s; "
836 "Ignoring virtual modifiers definition for key %s\n",
837 expr_op_type_to_string(value->expr.op),
838 KeyInfoText(info, keyi));
842 keyi->vmodmap = mask;
843 keyi->defined |= KEY_FIELD_VMODMAP;
845 else if (istreq(field, "locking") ||
846 istreq(field, "lock") ||
847 istreq(field, "locks")) {
848 log_vrb(info->ctx, 1,
849 "Key behaviors not supported; "
850 "Ignoring locking specification for key %s\n",
851 KeyInfoText(info, keyi));
853 else if (istreq(field, "radiogroup") ||
854 istreq(field, "permanentradiogroup") ||
855 istreq(field, "allownone")) {
856 log_vrb(info->ctx, 1,
857 "Radio groups not supported; "
858 "Ignoring radio group specification for key %s\n",
859 KeyInfoText(info, keyi));
861 else if (istreq_prefix("overlay", field) ||
862 istreq_prefix("permanentoverlay", field)) {
863 log_vrb(info->ctx, 1,
864 "Overlays not supported; "
865 "Ignoring overlay specification for key %s\n",
866 KeyInfoText(info, keyi));
868 else if (istreq(field, "repeating") ||
869 istreq(field, "repeats") ||
870 istreq(field, "repeat")) {
873 if (!ExprResolveEnum(info->ctx, value, &val, repeatEntries)) {
875 "Illegal repeat setting for %s; "
876 "Non-boolean repeat setting ignored\n",
877 KeyInfoText(info, keyi));
882 keyi->defined |= KEY_FIELD_REPEAT;
884 else if (istreq(field, "groupswrap") ||
885 istreq(field, "wrapgroups")) {
888 if (!ExprResolveBoolean(info->ctx, value, &set)) {
890 "Illegal groupsWrap setting for %s; "
891 "Non-boolean value ignored\n",
892 KeyInfoText(info, keyi));
896 keyi->out_of_range_group_action = (set ? RANGE_WRAP : RANGE_SATURATE);
897 keyi->defined |= KEY_FIELD_GROUPINFO;
899 else if (istreq(field, "groupsclamp") ||
900 istreq(field, "clampgroups")) {
903 if (!ExprResolveBoolean(info->ctx, value, &set)) {
905 "Illegal groupsClamp setting for %s; "
906 "Non-boolean value ignored\n",
907 KeyInfoText(info, keyi));
911 keyi->out_of_range_group_action = (set ? RANGE_SATURATE : RANGE_WRAP);
912 keyi->defined |= KEY_FIELD_GROUPINFO;
914 else if (istreq(field, "groupsredirect") ||
915 istreq(field, "redirectgroups")) {
916 xkb_layout_index_t grp;
918 if (!ExprResolveGroup(info->ctx, value, &grp)) {
920 "Illegal group index for redirect of key %s; "
921 "Definition with non-integer group ignored\n",
922 KeyInfoText(info, keyi));
926 keyi->out_of_range_group_action = RANGE_REDIRECT;
927 keyi->out_of_range_group_number = grp - 1;
928 keyi->defined |= KEY_FIELD_GROUPINFO;
932 "Unknown field %s in a symbol interpretation; "
933 "Definition ignored\n",
942 SetGroupName(SymbolsInfo *info, ExprDef *arrayNdx, ExprDef *value)
944 xkb_layout_index_t group, group_to_use;
948 log_vrb(info->ctx, 1,
949 "You must specify an index when specifying a group name; "
950 "Group name definition without array subscript ignored\n");
954 if (!ExprResolveGroup(info->ctx, arrayNdx, &group)) {
956 "Illegal index in group name definition; "
957 "Definition with non-integer array index ignored\n");
961 if (!ExprResolveString(info->ctx, value, &name)) {
963 "Group name must be a string; "
964 "Illegal name for group %d ignored\n", group);
968 if (info->explicit_group == XKB_LAYOUT_INVALID) {
969 group_to_use = group - 1;
971 else if (group - 1 == 0) {
972 group_to_use = info->explicit_group;
976 "An explicit group was specified for the '%s' map, "
977 "but it provides a name for a group other than Group1 (%d); "
978 "Ignoring group name '%s'\n",
980 xkb_atom_text(info->ctx, name));
984 if (group_to_use >= darray_size(info->group_names))
985 darray_resize0(info->group_names, group_to_use + 1);
986 darray_item(info->group_names, group_to_use) = name;
992 HandleGlobalVar(SymbolsInfo *info, VarDef *stmt)
994 const char *elem, *field;
998 if (!ExprResolveLhs(info->ctx, stmt->name, &elem, &field, &arrayNdx))
1001 if (elem && istreq(elem, "key")) {
1002 ret = SetSymbolsField(info, &info->default_key, field, arrayNdx,
1005 else if (!elem && (istreq(field, "name") ||
1006 istreq(field, "groupname"))) {
1007 ret = SetGroupName(info, arrayNdx, stmt->value);
1009 else if (!elem && (istreq(field, "groupswrap") ||
1010 istreq(field, "wrapgroups"))) {
1012 "Global \"groupswrap\" not supported; Ignored\n");
1015 else if (!elem && (istreq(field, "groupsclamp") ||
1016 istreq(field, "clampgroups"))) {
1018 "Global \"groupsclamp\" not supported; Ignored\n");
1021 else if (!elem && (istreq(field, "groupsredirect") ||
1022 istreq(field, "redirectgroups"))) {
1024 "Global \"groupsredirect\" not supported; Ignored\n");
1027 else if (!elem && istreq(field, "allownone")) {
1029 "Radio groups not supported; "
1030 "Ignoring \"allownone\" specification\n");
1034 ret = SetActionField(info->ctx, info->actions, &info->mods,
1035 elem, field, arrayNdx, stmt->value);
1042 HandleSymbolsBody(SymbolsInfo *info, VarDef *def, KeyInfo *keyi)
1045 const char *elem, *field;
1048 for (; def; def = (VarDef *) def->common.next) {
1049 if (def->name && def->name->expr.op == EXPR_FIELD_REF) {
1051 "Cannot set a global default value from within a key statement; "
1052 "Move statements to the global file scope\n");
1057 if (!def->value || def->value->expr.op == EXPR_KEYSYM_LIST)
1064 ok = ExprResolveLhs(info->ctx, def->name, &elem, &field,
1069 ok = SetSymbolsField(info, keyi, field, arrayNdx, def->value);
1076 SetExplicitGroup(SymbolsInfo *info, KeyInfo *keyi)
1078 xkb_layout_index_t i;
1082 if (info->explicit_group == XKB_LAYOUT_INVALID)
1085 darray_enumerate_from(i, groupi, keyi->groups, 1) {
1086 if (groupi->defined) {
1088 ClearGroupInfo(groupi);
1089 InitGroupInfo(groupi);
1095 "For the map %s an explicit group specified, "
1096 "but key %s has more than one group defined; "
1097 "All groups except first one will be ignored\n",
1098 info->name, KeyInfoText(info, keyi));
1100 darray_resize0(keyi->groups, info->explicit_group + 1);
1101 if (info->explicit_group > 0) {
1102 darray_item(keyi->groups, info->explicit_group) =
1103 darray_item(keyi->groups, 0);
1104 InitGroupInfo(&darray_item(keyi->groups, 0));
1111 HandleSymbolsDef(SymbolsInfo *info, SymbolsDef *stmt)
1115 keyi = info->default_key;
1116 darray_init(keyi.groups);
1117 darray_copy(keyi.groups, info->default_key.groups);
1118 for (xkb_layout_index_t i = 0; i < darray_size(keyi.groups); i++)
1119 CopyGroupInfo(&darray_item(keyi.groups, i),
1120 &darray_item(info->default_key.groups, i));
1121 keyi.merge = stmt->merge;
1122 keyi.name = stmt->keyName;
1124 if (!HandleSymbolsBody(info, stmt->symbols, &keyi)) {
1129 if (!SetExplicitGroup(info, &keyi)) {
1134 if (!AddKeySymbols(info, &keyi, true)) {
1143 HandleModMapDef(SymbolsInfo *info, ModMapDef *def)
1146 xkb_mod_index_t ndx;
1148 struct xkb_context *ctx = info->ctx;
1150 ndx = XkbModNameToIndex(&info->mods, def->modifier, MOD_REAL);
1151 if (ndx == XKB_MOD_INVALID) {
1153 "Illegal modifier map definition; "
1154 "Ignoring map for non-modifier \"%s\"\n",
1155 xkb_atom_text(ctx, def->modifier));
1161 tmp.merge = def->merge;
1163 for (ExprDef *key = def->keys; key; key = (ExprDef *) key->common.next) {
1166 if (key->expr.op == EXPR_VALUE &&
1167 key->expr.value_type == EXPR_TYPE_KEYNAME) {
1168 tmp.haveSymbol = false;
1169 tmp.u.keyName = key->key_name.key_name;
1171 else if (ExprResolveKeySym(ctx, key, &sym)) {
1172 tmp.haveSymbol = true;
1177 "Modmap entries may contain only key names or keysyms; "
1178 "Illegal definition for %s modifier ignored\n",
1179 ModIndexText(info->ctx, &info->mods, tmp.modifier));
1183 ok = AddModMapEntry(info, &tmp) && ok;
1189 HandleSymbolsFile(SymbolsInfo *info, XkbFile *file, enum merge_mode merge)
1194 info->name = strdup_safe(file->name);
1196 for (ParseCommon *stmt = file->defs; stmt; stmt = stmt->next) {
1197 switch (stmt->type) {
1199 ok = HandleIncludeSymbols(info, (IncludeStmt *) stmt);
1202 ok = HandleSymbolsDef(info, (SymbolsDef *) stmt);
1205 ok = HandleGlobalVar(info, (VarDef *) stmt);
1208 ok = HandleVModDef(info->ctx, &info->mods, (VModDef *) stmt, merge);
1211 ok = HandleModMapDef(info, (ModMapDef *) stmt);
1215 "Symbols files may not include other types; "
1216 "Ignoring %s\n", stmt_type_to_string(stmt->type));
1224 if (info->errorCount > 10) {
1225 log_err(info->ctx, "Abandoning symbols file \"%s\"\n",
1233 * Given a keysym @sym, return a key which generates it, or NULL.
1234 * This is used for example in a modifier map definition, such as:
1235 * modifier_map Lock { Caps_Lock };
1236 * where we want to add the Lock modifier to the modmap of the key
1237 * which matches the keysym Caps_Lock.
1238 * Since there can be many keys which generates the keysym, the key
1239 * is chosen first by lowest group in which the keysym appears, than
1240 * by lowest level and than by lowest key code.
1242 static struct xkb_key *
1243 FindKeyForSymbol(struct xkb_keymap *keymap, xkb_keysym_t sym)
1245 struct xkb_key *key, *ret = NULL;
1246 xkb_layout_index_t group, min_group = UINT32_MAX;
1247 xkb_level_index_t level, min_level = UINT16_MAX;
1249 xkb_keys_foreach(key, keymap) {
1250 for (group = 0; group < key->num_groups; group++) {
1251 for (level = 0; level < XkbKeyGroupWidth(key, group); level++) {
1252 if (key->groups[group].levels[level].num_syms != 1 ||
1253 key->groups[group].levels[level].u.sym != sym)
1257 * If the keysym was found in a group or level > 0, we must
1258 * keep looking since we might find a key in which the keysym
1259 * is in a lower group or level.
1261 if (group < min_group ||
1262 (group == min_group && level < min_level)) {
1264 if (group == 0 && level == 0) {
1280 * Find an appropriate type for a group and return its name.
1283 * - ONE_LEVEL for width 0/1
1284 * - ALPHABETIC for 2 shift levels, with lower/upercase keysyms
1285 * - KEYPAD for keypad keys.
1286 * - TWO_LEVEL for other 2 shift level keys.
1287 * and the same for four level keys.
1289 * FIXME: Decide how to handle multiple-syms-per-level, and do it.
1292 FindAutomaticType(struct xkb_context *ctx, GroupInfo *groupi)
1294 xkb_keysym_t sym0, sym1, sym2, sym3;
1295 xkb_level_index_t width = darray_size(groupi->levels);
1297 #define GET_SYM(level) \
1298 (darray_item(groupi->levels, level).num_syms == 0 ? \
1299 XKB_KEY_NoSymbol : \
1300 darray_item(groupi->levels, level).num_syms == 1 ? \
1301 darray_item(groupi->levels, level).u.sym : \
1302 /* num_syms > 1 */ \
1303 darray_item(groupi->levels, level).u.syms[0])
1305 if (width == 1 || width <= 0)
1306 return xkb_atom_intern_literal(ctx, "ONE_LEVEL");
1312 if (xkb_keysym_is_lower(sym0) && xkb_keysym_is_upper(sym1))
1313 return xkb_atom_intern_literal(ctx, "ALPHABETIC");
1315 if (xkb_keysym_is_keypad(sym0) || xkb_keysym_is_keypad(sym1))
1316 return xkb_atom_intern_literal(ctx, "KEYPAD");
1318 return xkb_atom_intern_literal(ctx, "TWO_LEVEL");
1322 if (xkb_keysym_is_lower(sym0) && xkb_keysym_is_upper(sym1)) {
1324 sym3 = (width == 4 ? GET_SYM(3) : XKB_KEY_NoSymbol);
1326 if (xkb_keysym_is_lower(sym2) && xkb_keysym_is_upper(sym3))
1327 return xkb_atom_intern_literal(ctx, "FOUR_LEVEL_ALPHABETIC");
1329 return xkb_atom_intern_literal(ctx, "FOUR_LEVEL_SEMIALPHABETIC");
1332 if (xkb_keysym_is_keypad(sym0) || xkb_keysym_is_keypad(sym1))
1333 return xkb_atom_intern_literal(ctx, "FOUR_LEVEL_KEYPAD");
1335 return xkb_atom_intern_literal(ctx, "FOUR_LEVEL");
1338 return XKB_ATOM_NONE;
1343 static const struct xkb_key_type *
1344 FindTypeForGroup(struct xkb_keymap *keymap, KeyInfo *keyi,
1345 xkb_layout_index_t group, bool *explicit_type)
1348 GroupInfo *groupi = &darray_item(keyi->groups, group);
1349 xkb_atom_t type_name = groupi->type;
1351 *explicit_type = true;
1353 if (type_name == XKB_ATOM_NONE) {
1354 if (keyi->default_type != XKB_ATOM_NONE) {
1355 type_name = keyi->default_type;
1358 type_name = FindAutomaticType(keymap->ctx, groupi);
1359 if (type_name != XKB_ATOM_NONE)
1360 *explicit_type = false;
1364 if (type_name == XKB_ATOM_NONE) {
1365 log_warn(keymap->ctx,
1366 "Couldn't find an automatic type for key '%s' group %d with %lu levels; "
1367 "Using the default type\n",
1368 KeyNameText(keymap->ctx, keyi->name), group + 1,
1369 (unsigned long) darray_size(groupi->levels));
1373 for (i = 0; i < keymap->num_types; i++)
1374 if (keymap->types[i].name == type_name)
1377 if (i >= keymap->num_types) {
1378 log_warn(keymap->ctx,
1379 "The type \"%s\" for key '%s' group %d was not previously defined; "
1380 "Using the default type\n",
1381 xkb_atom_text(keymap->ctx, type_name),
1382 KeyNameText(keymap->ctx, keyi->name), group + 1);
1386 return &keymap->types[i];
1390 * Index 0 is guaranteed to contain something, usually
1391 * ONE_LEVEL or at least some default one-level type.
1393 return &keymap->types[0];
1397 CopySymbolsDefToKeymap(struct xkb_keymap *keymap, SymbolsInfo *info,
1400 struct xkb_key *key;
1402 const GroupInfo *group0;
1403 xkb_layout_index_t i;
1406 * The name is guaranteed to be real and not an alias (see
1407 * AddKeySymbols), so 'false' is safe here.
1409 key = XkbKeyByName(keymap, keyi->name, false);
1411 log_vrb(info->ctx, 5,
1412 "Key %s not found in keycodes; Symbols ignored\n",
1413 KeyInfoText(info, keyi));
1417 /* Find the range of groups we need. */
1418 key->num_groups = 0;
1419 darray_enumerate(i, groupi, keyi->groups)
1420 if (groupi->defined)
1421 key->num_groups = i + 1;
1423 if (key->num_groups <= 0)
1424 return false; /* WSGO */
1426 darray_resize(keyi->groups, key->num_groups);
1429 * If there are empty groups between non-empty ones, fill them with data
1430 * from the first group.
1431 * We can make a wrong assumption here. But leaving gaps is worse.
1433 group0 = &darray_item(keyi->groups, 0);
1434 darray_foreach_from(groupi, keyi->groups, 1) {
1435 if (groupi->defined)
1438 CopyGroupInfo(groupi, group0);
1441 key->groups = calloc(key->num_groups, sizeof(*key->groups));
1443 /* Find and assign the groups' types in the keymap. */
1444 darray_enumerate(i, groupi, keyi->groups) {
1445 const struct xkb_key_type *type;
1448 type = FindTypeForGroup(keymap, keyi, i, &explicit_type);
1450 /* Always have as many levels as the type specifies. */
1451 if (type->num_levels < darray_size(groupi->levels)) {
1452 struct xkb_level *leveli;
1454 log_vrb(info->ctx, 1,
1455 "Type \"%s\" has %d levels, but %s has %d levels; "
1456 "Ignoring extra symbols\n",
1457 xkb_atom_text(keymap->ctx, type->name), type->num_levels,
1458 KeyInfoText(info, keyi),
1459 (int) darray_size(groupi->levels));
1461 darray_foreach_from(leveli, groupi->levels, type->num_levels)
1462 ClearLevelInfo(leveli);
1464 darray_resize0(groupi->levels, type->num_levels);
1466 key->groups[i].explicit_type = explicit_type;
1467 key->groups[i].type = type;
1471 darray_enumerate(i, groupi, keyi->groups)
1472 darray_steal(groupi->levels, &key->groups[i].levels, NULL);
1474 key->out_of_range_group_number = keyi->out_of_range_group_number;
1475 key->out_of_range_group_action = keyi->out_of_range_group_action;
1477 if (keyi->defined & KEY_FIELD_VMODMAP) {
1478 key->vmodmap = keyi->vmodmap;
1479 key->explicit |= EXPLICIT_VMODMAP;
1482 if (keyi->repeat != KEY_REPEAT_UNDEFINED) {
1483 key->repeats = (keyi->repeat == KEY_REPEAT_YES);
1484 key->explicit |= EXPLICIT_REPEAT;
1487 darray_foreach(groupi, keyi->groups) {
1488 if (groupi->defined & GROUP_FIELD_ACTS) {
1489 key->explicit |= EXPLICIT_INTERP;
1498 CopyModMapDefToKeymap(struct xkb_keymap *keymap, SymbolsInfo *info,
1501 struct xkb_key *key;
1503 if (!entry->haveSymbol) {
1504 key = XkbKeyByName(keymap, entry->u.keyName, true);
1506 log_vrb(info->ctx, 5,
1507 "Key %s not found in keycodes; "
1508 "Modifier map entry for %s not updated\n",
1509 KeyNameText(info->ctx, entry->u.keyName),
1510 ModIndexText(info->ctx, &info->mods, entry->modifier));
1515 key = FindKeyForSymbol(keymap, entry->u.keySym);
1517 log_vrb(info->ctx, 5,
1518 "Key \"%s\" not found in symbol map; "
1519 "Modifier map entry for %s not updated\n",
1520 KeysymText(info->ctx, entry->u.keySym),
1521 ModIndexText(info->ctx, &info->mods, entry->modifier));
1526 key->modmap |= (1u << entry->modifier);
1531 CopySymbolsToKeymap(struct xkb_keymap *keymap, SymbolsInfo *info)
1536 keymap->symbols_section_name = strdup_safe(info->name);
1537 XkbEscapeMapName(keymap->symbols_section_name);
1539 keymap->mods = info->mods;
1541 darray_steal(info->group_names,
1542 &keymap->group_names, &keymap->num_group_names);
1544 darray_foreach(keyi, info->keys)
1545 if (!CopySymbolsDefToKeymap(keymap, info, keyi))
1548 if (xkb_context_get_log_verbosity(keymap->ctx) > 3) {
1549 struct xkb_key *key;
1551 xkb_keys_foreach(key, keymap) {
1552 if (key->name == XKB_ATOM_NONE)
1555 if (key->num_groups < 1)
1557 "No symbols defined for %s\n",
1558 KeyNameText(info->ctx, key->name));
1562 darray_foreach(mm, info->modmaps)
1563 if (!CopyModMapDefToKeymap(keymap, info, mm))
1566 /* XXX: If we don't ignore errorCount, things break. */
1571 CompileSymbols(XkbFile *file, struct xkb_keymap *keymap,
1572 enum merge_mode merge)
1575 ActionsInfo *actions;
1577 actions = NewActionsInfo();
1581 InitSymbolsInfo(&info, keymap, actions, &keymap->mods);
1582 info.default_key.merge = merge;
1584 HandleSymbolsFile(&info, file, merge);
1586 if (info.errorCount != 0)
1589 if (!CopySymbolsToKeymap(keymap, &info))
1592 ClearSymbolsInfo(&info);
1593 FreeActionsInfo(actions);
1597 FreeActionsInfo(actions);
1598 ClearSymbolsInfo(&info);