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;
181 struct xkb_context *ctx;
182 struct xkb_keymap *keymap;
186 InitSymbolsInfo(SymbolsInfo *info, struct xkb_keymap *keymap,
187 ActionsInfo *actions)
189 memset(info, 0, sizeof(*info));
190 info->ctx = keymap->ctx;
191 info->keymap = keymap;
192 info->merge = MERGE_OVERRIDE;
193 InitKeyInfo(keymap->ctx, &info->default_key);
194 info->actions = actions;
195 info->explicit_group = XKB_LAYOUT_INVALID;
199 ClearSymbolsInfo(SymbolsInfo *info)
203 darray_foreach(keyi, info->keys)
205 darray_free(info->keys);
206 darray_free(info->group_names);
207 darray_free(info->modmaps);
208 ClearKeyInfo(&info->default_key);
212 KeyInfoText(SymbolsInfo *info, KeyInfo *keyi)
214 return KeyNameText(info->ctx, keyi->name);
218 MergeGroups(SymbolsInfo *info, GroupInfo *into, GroupInfo *from, bool clobber,
219 bool report, xkb_layout_index_t group, xkb_atom_t key_name)
221 xkb_level_index_t i, levels_in_both;
223 /* First find the type of the merged group. */
224 if (into->type != from->type) {
225 if (from->type == XKB_ATOM_NONE) {
227 else if (into->type == XKB_ATOM_NONE) {
228 into->type = from->type;
231 xkb_atom_t use = (clobber ? from->type : into->type);
232 xkb_atom_t ignore = (clobber ? into->type : from->type);
236 "Multiple definitions for group %d type of key %s; "
237 "Using %s, ignoring %s\n",
238 group + 1, KeyNameText(info->ctx, key_name),
239 xkb_atom_text(info->ctx, use),
240 xkb_atom_text(info->ctx, ignore));
245 into->defined |= (from->defined & GROUP_FIELD_TYPE);
247 /* Now look at the levels. */
249 if (darray_empty(from->levels)) {
254 if (darray_empty(into->levels)) {
255 from->type = into->type;
261 /* Merge the actions and syms. */
262 levels_in_both = MIN(darray_size(into->levels), darray_size(from->levels));
263 for (i = 0; i < levels_in_both; i++) {
264 struct xkb_level *intoLevel = &darray_item(into->levels, i);
265 struct xkb_level *fromLevel = &darray_item(from->levels, i);
267 if (fromLevel->action.type == ACTION_TYPE_NONE) {
269 else if (intoLevel->action.type == ACTION_TYPE_NONE) {
270 intoLevel->action = fromLevel->action;
273 union xkb_action *use, *ignore;
274 use = (clobber ? &fromLevel->action : &intoLevel->action);
275 ignore = (clobber ? &intoLevel->action : &fromLevel->action);
279 "Multiple actions for level %d/group %u on key %s; "
280 "Using %s, ignoring %s\n",
281 i + 1, group + 1, KeyNameText(info->ctx, key_name),
282 ActionTypeText(use->type),
283 ActionTypeText(ignore->type));
285 intoLevel->action = *use;
288 if (fromLevel->num_syms == 0) {
290 else if (intoLevel->num_syms == 0) {
291 intoLevel->num_syms = fromLevel->num_syms;
292 if (fromLevel->num_syms > 1)
293 intoLevel->u.syms = fromLevel->u.syms;
295 intoLevel->u.sym = fromLevel->u.sym;
296 fromLevel->num_syms = 0;
301 "Multiple symbols for level %d/group %u on key %s; "
302 "Using %s, ignoring %s\n",
303 i + 1, group + 1, KeyNameText(info->ctx, key_name),
304 (clobber ? "from" : "to"),
305 (clobber ? "to" : "from"));
308 ClearLevelInfo(intoLevel);
309 intoLevel->num_syms = fromLevel->num_syms;
310 if (fromLevel->num_syms > 1)
311 intoLevel->u.syms = fromLevel->u.syms;
313 intoLevel->u.sym = fromLevel->u.sym;
314 fromLevel->num_syms = 0;
318 /* If @from has extra levels, get them as well. */
319 for (i = levels_in_both; i < darray_size(from->levels); i++) {
320 darray_append(into->levels, darray_item(from->levels, i));
321 darray_item(from->levels, i).num_syms = 0;
323 into->defined |= (from->defined & GROUP_FIELD_ACTS);
324 into->defined |= (from->defined & GROUP_FIELD_SYMS);
330 UseNewKeyField(enum key_field field, enum key_field old, enum key_field new,
331 bool clobber, bool report, enum key_field *collide)
334 return (new & field);
348 MergeKeys(SymbolsInfo *info, KeyInfo *into, KeyInfo *from, bool same_file)
350 xkb_layout_index_t i;
351 xkb_layout_index_t groups_in_both;
352 enum key_field collide = 0;
353 const int verbosity = xkb_context_get_log_verbosity(info->ctx);
354 const bool clobber = (from->merge != MERGE_AUGMENT);
355 const bool report = (same_file && verbosity > 0) || verbosity > 9;
357 if (from->merge == MERGE_REPLACE) {
360 InitKeyInfo(info->ctx, from);
364 groups_in_both = MIN(darray_size(into->groups), darray_size(from->groups));
365 for (i = 0; i < groups_in_both; i++)
367 &darray_item(into->groups, i),
368 &darray_item(from->groups, i),
369 clobber, report, i, into->name);
370 /* If @from has extra groups, just move them to @into. */
371 for (i = groups_in_both; i < darray_size(from->groups); i++) {
372 darray_append(into->groups, darray_item(from->groups, i));
373 InitGroupInfo(&darray_item(from->groups, i));
376 if (UseNewKeyField(KEY_FIELD_VMODMAP, into->defined, from->defined,
377 clobber, report, &collide)) {
378 into->vmodmap = from->vmodmap;
379 into->defined |= KEY_FIELD_VMODMAP;
381 if (UseNewKeyField(KEY_FIELD_REPEAT, into->defined, from->defined,
382 clobber, report, &collide)) {
383 into->repeat = from->repeat;
384 into->defined |= KEY_FIELD_REPEAT;
386 if (UseNewKeyField(KEY_FIELD_DEFAULT_TYPE, into->defined, from->defined,
387 clobber, report, &collide)) {
388 into->default_type = from->default_type;
389 into->defined |= KEY_FIELD_DEFAULT_TYPE;
391 if (UseNewKeyField(KEY_FIELD_GROUPINFO, into->defined, from->defined,
392 clobber, report, &collide)) {
393 into->out_of_range_group_action = from->out_of_range_group_action;
394 into->out_of_range_group_number = from->out_of_range_group_number;
395 into->defined |= KEY_FIELD_GROUPINFO;
400 "Symbol map for key %s redefined; "
401 "Using %s definition for conflicting fields\n",
402 KeyNameText(info->ctx, into->name),
403 (clobber ? "first" : "last"));
406 InitKeyInfo(info->ctx, from);
411 AddKeySymbols(SymbolsInfo *info, KeyInfo *keyi, bool same_file)
413 xkb_atom_t real_name;
417 * Don't keep aliases in the keys array; this guarantees that
418 * searching for keys to merge with by straight comparison (see the
419 * following loop) is enough, and we won't get multiple KeyInfo's
420 * for the same key because of aliases.
422 real_name = XkbResolveKeyAlias(info->keymap, keyi->name);
423 if (real_name != XKB_ATOM_NONE)
424 keyi->name = real_name;
426 darray_foreach(iter, info->keys)
427 if (iter->name == keyi->name)
428 return MergeKeys(info, iter, keyi, same_file);
430 darray_append(info->keys, *keyi);
431 InitKeyInfo(info->ctx, keyi);
436 AddModMapEntry(SymbolsInfo *info, ModMapEntry *new)
439 bool clobber = (new->merge != MERGE_AUGMENT);
441 darray_foreach(old, info->modmaps) {
442 xkb_mod_index_t use, ignore;
444 if ((new->haveSymbol != old->haveSymbol) ||
445 (new->haveSymbol && new->u.keySym != old->u.keySym) ||
446 (!new->haveSymbol && new->u.keyName != old->u.keyName))
449 if (new->modifier == old->modifier)
452 use = (clobber ? new->modifier : old->modifier);
453 ignore = (clobber ? old->modifier : new->modifier);
457 "Symbol \"%s\" added to modifier map for multiple modifiers; "
458 "Using %s, ignoring %s\n",
459 KeysymText(info->ctx, new->u.keySym),
460 ModIndexText(info->ctx, &info->keymap->mods, use),
461 ModIndexText(info->ctx, &info->keymap->mods, ignore));
464 "Key \"%s\" added to modifier map for multiple modifiers; "
465 "Using %s, ignoring %s\n",
466 KeyNameText(info->ctx, new->u.keyName),
467 ModIndexText(info->ctx, &info->keymap->mods, use),
468 ModIndexText(info->ctx, &info->keymap->mods, ignore));
474 darray_append(info->modmaps, *new);
478 /***====================================================================***/
481 MergeIncludedSymbols(SymbolsInfo *into, SymbolsInfo *from,
482 enum merge_mode merge)
486 xkb_atom_t *group_name;
487 xkb_layout_index_t group_names_in_both;
489 if (from->errorCount > 0) {
490 into->errorCount += from->errorCount;
494 if (into->name == NULL) {
495 into->name = from->name;
499 group_names_in_both = MIN(darray_size(into->group_names),
500 darray_size(from->group_names));
501 for (xkb_layout_index_t i = 0; i < group_names_in_both; i++) {
502 if (!darray_item(from->group_names, i))
505 if (merge == MERGE_AUGMENT && darray_item(into->group_names, i))
508 darray_item(into->group_names, i) = darray_item(from->group_names, i);
510 /* If @from has more, get them as well. */
511 darray_foreach_from(group_name, from->group_names, group_names_in_both)
512 darray_append(into->group_names, *group_name);
514 if (darray_empty(into->keys)) {
515 into->keys = from->keys;
516 darray_init(from->keys);
519 darray_foreach(keyi, from->keys) {
520 keyi->merge = (merge == MERGE_DEFAULT ? keyi->merge : merge);
521 if (!AddKeySymbols(into, keyi, false))
526 if (darray_empty(into->modmaps)) {
527 into->modmaps = from->modmaps;
528 darray_init(from->modmaps);
531 darray_foreach(mm, from->modmaps) {
532 mm->merge = (merge == MERGE_DEFAULT ? mm->merge : merge);
533 if (!AddModMapEntry(into, mm))
540 HandleSymbolsFile(SymbolsInfo *info, XkbFile *file, enum merge_mode merge);
543 HandleIncludeSymbols(SymbolsInfo *info, IncludeStmt *include)
545 SymbolsInfo included;
547 InitSymbolsInfo(&included, info->keymap, info->actions);
548 included.name = include->stmt;
549 include->stmt = NULL;
551 for (IncludeStmt *stmt = include; stmt; stmt = stmt->next_incl) {
552 SymbolsInfo next_incl;
555 file = ProcessIncludeFile(info->ctx, stmt, FILE_TYPE_SYMBOLS);
557 info->errorCount += 10;
558 ClearSymbolsInfo(&included);
562 InitSymbolsInfo(&next_incl, info->keymap, info->actions);
563 if (stmt->modifier) {
564 next_incl.explicit_group = atoi(stmt->modifier) - 1;
565 if (next_incl.explicit_group >= XKB_MAX_GROUPS) {
567 "Cannot set explicit group to %d - must be between 1..%d; "
568 "Ignoring group number\n",
569 next_incl.explicit_group + 1, XKB_MAX_GROUPS);
570 next_incl.explicit_group = info->explicit_group;
574 next_incl.explicit_group = info->explicit_group;
577 HandleSymbolsFile(&next_incl, file, MERGE_OVERRIDE);
579 MergeIncludedSymbols(&included, &next_incl, stmt->merge);
581 ClearSymbolsInfo(&next_incl);
585 MergeIncludedSymbols(info, &included, include->merge);
586 ClearSymbolsInfo(&included);
588 return (info->errorCount == 0);
595 GetGroupIndex(SymbolsInfo *info, KeyInfo *keyi, ExprDef *arrayNdx,
596 unsigned what, xkb_layout_index_t *ndx_rtrn)
598 const char *name = (what == SYMBOLS ? "symbols" : "actions");
600 if (arrayNdx == NULL) {
601 xkb_layout_index_t i;
603 enum group_field field = (what == SYMBOLS ?
604 GROUP_FIELD_SYMS : GROUP_FIELD_ACTS);
606 darray_enumerate(i, groupi, keyi->groups) {
607 if (!(groupi->defined & field)) {
613 if (i >= XKB_MAX_GROUPS) {
615 "Too many groups of %s for key %s (max %u); "
616 "Ignoring %s defined for extra groups\n",
617 name, KeyInfoText(info, keyi), XKB_MAX_GROUPS, name);
621 darray_resize0(keyi->groups, darray_size(keyi->groups) + 1);
622 *ndx_rtrn = darray_size(keyi->groups) - 1;
626 if (!ExprResolveGroup(info->ctx, arrayNdx, ndx_rtrn)) {
628 "Illegal group index for %s of key %s\n"
629 "Definition with non-integer array index ignored\n",
630 name, KeyInfoText(info, keyi));
635 if (*ndx_rtrn >= darray_size(keyi->groups))
636 darray_resize0(keyi->groups, *ndx_rtrn + 1);
642 AddSymbolsToKey(SymbolsInfo *info, KeyInfo *keyi, ExprDef *arrayNdx,
645 xkb_layout_index_t ndx;
647 xkb_level_index_t nLevels;
649 if (!GetGroupIndex(info, keyi, arrayNdx, SYMBOLS, &ndx))
652 groupi = &darray_item(keyi->groups, ndx);
655 groupi->defined |= GROUP_FIELD_SYMS;
659 if (value->expr.op != EXPR_KEYSYM_LIST) {
661 "Expected a list of symbols, found %s; "
662 "Ignoring symbols for group %u of %s\n",
663 expr_op_type_to_string(value->expr.op), ndx + 1,
664 KeyInfoText(info, keyi));
668 if (groupi->defined & GROUP_FIELD_SYMS) {
670 "Symbols for key %s, group %u already defined; "
671 "Ignoring duplicate definition\n",
672 KeyInfoText(info, keyi), ndx + 1);
676 nLevels = darray_size(value->keysym_list.symsMapIndex);
677 if (darray_size(groupi->levels) < nLevels)
678 darray_resize0(groupi->levels, nLevels);
680 groupi->defined |= GROUP_FIELD_SYMS;
682 for (xkb_level_index_t i = 0; i < nLevels; i++) {
683 unsigned int sym_index;
684 struct xkb_level *leveli = &darray_item(groupi->levels, i);
686 sym_index = darray_item(value->keysym_list.symsMapIndex, i);
687 leveli->num_syms = darray_item(value->keysym_list.symsNumEntries, i);
688 if (leveli->num_syms > 1)
689 leveli->u.syms = calloc(leveli->num_syms, sizeof(*leveli->u.syms));
691 for (unsigned j = 0; j < leveli->num_syms; j++) {
692 xkb_keysym_t keysym = darray_item(value->keysym_list.syms,
695 if (leveli->num_syms == 1) {
696 if (keysym == XKB_KEY_NoSymbol)
697 leveli->num_syms = 0;
699 leveli->u.sym = keysym;
701 else if (leveli->num_syms > 1) {
702 leveli->u.syms[j] = keysym;
711 AddActionsToKey(SymbolsInfo *info, KeyInfo *keyi, ExprDef *arrayNdx,
714 xkb_layout_index_t ndx;
719 if (!GetGroupIndex(info, keyi, arrayNdx, ACTIONS, &ndx))
722 groupi = &darray_item(keyi->groups, ndx);
725 groupi->defined |= GROUP_FIELD_ACTS;
729 if (value->expr.op != EXPR_ACTION_LIST) {
731 "Bad expression type (%d) for action list value; "
732 "Ignoring actions for group %u of %s\n",
733 value->expr.op, ndx, KeyInfoText(info, keyi));
737 if (groupi->defined & GROUP_FIELD_ACTS) {
739 "Actions for key %s, group %u already defined\n",
740 KeyInfoText(info, keyi), ndx);
745 for (act = value->unary.child; act; act = (ExprDef *) act->common.next)
748 if (darray_size(groupi->levels) < nActs)
749 darray_resize0(groupi->levels, nActs);
751 groupi->defined |= GROUP_FIELD_ACTS;
753 act = value->unary.child;
754 for (unsigned i = 0; i < nActs; i++) {
755 union xkb_action *toAct = &darray_item(groupi->levels, i).action;
757 if (!HandleActionDef(info->ctx, info->actions, &info->keymap->mods,
760 "Illegal action definition for %s; "
761 "Action for group %u/level %u ignored\n",
762 KeyInfoText(info, keyi), ndx + 1, i + 1);
764 act = (ExprDef *) act->common.next;
770 static const LookupEntry repeatEntries[] = {
771 { "true", KEY_REPEAT_YES },
772 { "yes", KEY_REPEAT_YES },
773 { "on", KEY_REPEAT_YES },
774 { "false", KEY_REPEAT_NO },
775 { "no", KEY_REPEAT_NO },
776 { "off", KEY_REPEAT_NO },
777 { "default", KEY_REPEAT_UNDEFINED },
782 SetSymbolsField(SymbolsInfo *info, KeyInfo *keyi, const char *field,
783 ExprDef *arrayNdx, ExprDef *value)
785 if (istreq(field, "type")) {
786 xkb_layout_index_t ndx;
789 if (!ExprResolveString(info->ctx, value, &val)) {
791 "The type field of a key symbol map must be a string; "
792 "Ignoring illegal type definition\n");
797 keyi->default_type = val;
798 keyi->defined |= KEY_FIELD_DEFAULT_TYPE;
800 else if (!ExprResolveGroup(info->ctx, arrayNdx, &ndx)) {
802 "Illegal group index for type of key %s; "
803 "Definition with non-integer array index ignored\n",
804 KeyInfoText(info, keyi));
809 if (ndx >= darray_size(keyi->groups))
810 darray_resize0(keyi->groups, ndx + 1);
811 darray_item(keyi->groups, ndx).type = val;
812 darray_item(keyi->groups, ndx).defined |= GROUP_FIELD_TYPE;
815 else if (istreq(field, "symbols")) {
816 return AddSymbolsToKey(info, keyi, arrayNdx, value);
818 else if (istreq(field, "actions")) {
819 return AddActionsToKey(info, keyi, arrayNdx, value);
821 else if (istreq(field, "vmods") ||
822 istreq(field, "virtualmods") ||
823 istreq(field, "virtualmodifiers")) {
826 if (!ExprResolveModMask(info->ctx, value, MOD_VIRT,
827 &info->keymap->mods, &mask)) {
829 "Expected a virtual modifier mask, found %s; "
830 "Ignoring virtual modifiers definition for key %s\n",
831 expr_op_type_to_string(value->expr.op),
832 KeyInfoText(info, keyi));
836 keyi->vmodmap = mask;
837 keyi->defined |= KEY_FIELD_VMODMAP;
839 else if (istreq(field, "locking") ||
840 istreq(field, "lock") ||
841 istreq(field, "locks")) {
842 log_vrb(info->ctx, 1,
843 "Key behaviors not supported; "
844 "Ignoring locking specification for key %s\n",
845 KeyInfoText(info, keyi));
847 else if (istreq(field, "radiogroup") ||
848 istreq(field, "permanentradiogroup") ||
849 istreq(field, "allownone")) {
850 log_vrb(info->ctx, 1,
851 "Radio groups not supported; "
852 "Ignoring radio group specification for key %s\n",
853 KeyInfoText(info, keyi));
855 else if (istreq_prefix("overlay", field) ||
856 istreq_prefix("permanentoverlay", field)) {
857 log_vrb(info->ctx, 1,
858 "Overlays not supported; "
859 "Ignoring overlay specification for key %s\n",
860 KeyInfoText(info, keyi));
862 else if (istreq(field, "repeating") ||
863 istreq(field, "repeats") ||
864 istreq(field, "repeat")) {
867 if (!ExprResolveEnum(info->ctx, value, &val, repeatEntries)) {
869 "Illegal repeat setting for %s; "
870 "Non-boolean repeat setting ignored\n",
871 KeyInfoText(info, keyi));
876 keyi->defined |= KEY_FIELD_REPEAT;
878 else if (istreq(field, "groupswrap") ||
879 istreq(field, "wrapgroups")) {
882 if (!ExprResolveBoolean(info->ctx, value, &set)) {
884 "Illegal groupsWrap setting for %s; "
885 "Non-boolean value ignored\n",
886 KeyInfoText(info, keyi));
890 keyi->out_of_range_group_action = (set ? RANGE_WRAP : RANGE_SATURATE);
891 keyi->defined |= KEY_FIELD_GROUPINFO;
893 else if (istreq(field, "groupsclamp") ||
894 istreq(field, "clampgroups")) {
897 if (!ExprResolveBoolean(info->ctx, value, &set)) {
899 "Illegal groupsClamp setting for %s; "
900 "Non-boolean value ignored\n",
901 KeyInfoText(info, keyi));
905 keyi->out_of_range_group_action = (set ? RANGE_SATURATE : RANGE_WRAP);
906 keyi->defined |= KEY_FIELD_GROUPINFO;
908 else if (istreq(field, "groupsredirect") ||
909 istreq(field, "redirectgroups")) {
910 xkb_layout_index_t grp;
912 if (!ExprResolveGroup(info->ctx, value, &grp)) {
914 "Illegal group index for redirect of key %s; "
915 "Definition with non-integer group ignored\n",
916 KeyInfoText(info, keyi));
920 keyi->out_of_range_group_action = RANGE_REDIRECT;
921 keyi->out_of_range_group_number = grp - 1;
922 keyi->defined |= KEY_FIELD_GROUPINFO;
926 "Unknown field %s in a symbol interpretation; "
927 "Definition ignored\n",
936 SetGroupName(SymbolsInfo *info, ExprDef *arrayNdx, ExprDef *value)
938 xkb_layout_index_t group, group_to_use;
942 log_vrb(info->ctx, 1,
943 "You must specify an index when specifying a group name; "
944 "Group name definition without array subscript ignored\n");
948 if (!ExprResolveGroup(info->ctx, arrayNdx, &group)) {
950 "Illegal index in group name definition; "
951 "Definition with non-integer array index ignored\n");
955 if (!ExprResolveString(info->ctx, value, &name)) {
957 "Group name must be a string; "
958 "Illegal name for group %d ignored\n", group);
962 if (info->explicit_group == XKB_LAYOUT_INVALID) {
963 group_to_use = group - 1;
965 else if (group - 1 == 0) {
966 group_to_use = info->explicit_group;
970 "An explicit group was specified for the '%s' map, "
971 "but it provides a name for a group other than Group1 (%d); "
972 "Ignoring group name '%s'\n",
974 xkb_atom_text(info->ctx, name));
978 if (group_to_use >= darray_size(info->group_names))
979 darray_resize0(info->group_names, group_to_use + 1);
980 darray_item(info->group_names, group_to_use) = name;
986 HandleGlobalVar(SymbolsInfo *info, VarDef *stmt)
988 const char *elem, *field;
992 if (!ExprResolveLhs(info->ctx, stmt->name, &elem, &field, &arrayNdx))
995 if (elem && istreq(elem, "key")) {
996 ret = SetSymbolsField(info, &info->default_key, field, arrayNdx,
999 else if (!elem && (istreq(field, "name") ||
1000 istreq(field, "groupname"))) {
1001 ret = SetGroupName(info, arrayNdx, stmt->value);
1003 else if (!elem && (istreq(field, "groupswrap") ||
1004 istreq(field, "wrapgroups"))) {
1006 "Global \"groupswrap\" not supported; Ignored\n");
1009 else if (!elem && (istreq(field, "groupsclamp") ||
1010 istreq(field, "clampgroups"))) {
1012 "Global \"groupsclamp\" not supported; Ignored\n");
1015 else if (!elem && (istreq(field, "groupsredirect") ||
1016 istreq(field, "redirectgroups"))) {
1018 "Global \"groupsredirect\" not supported; Ignored\n");
1021 else if (!elem && istreq(field, "allownone")) {
1023 "Radio groups not supported; "
1024 "Ignoring \"allownone\" specification\n");
1028 ret = SetActionField(info->ctx, info->actions, &info->keymap->mods,
1029 elem, field, arrayNdx, stmt->value);
1036 HandleSymbolsBody(SymbolsInfo *info, VarDef *def, KeyInfo *keyi)
1039 const char *elem, *field;
1042 for (; def; def = (VarDef *) def->common.next) {
1043 if (def->name && def->name->expr.op == EXPR_FIELD_REF) {
1045 "Cannot set a global default value from within a key statement; "
1046 "Move statements to the global file scope\n");
1051 if (!def->value || def->value->expr.op == EXPR_KEYSYM_LIST)
1058 ok = ExprResolveLhs(info->ctx, def->name, &elem, &field,
1063 ok = SetSymbolsField(info, keyi, field, arrayNdx, def->value);
1070 SetExplicitGroup(SymbolsInfo *info, KeyInfo *keyi)
1072 xkb_layout_index_t i;
1076 if (info->explicit_group == XKB_LAYOUT_INVALID)
1079 darray_enumerate_from(i, groupi, keyi->groups, 1) {
1080 if (groupi->defined) {
1082 ClearGroupInfo(groupi);
1083 InitGroupInfo(groupi);
1089 "For the map %s an explicit group specified, "
1090 "but key %s has more than one group defined; "
1091 "All groups except first one will be ignored\n",
1092 info->name, KeyInfoText(info, keyi));
1094 darray_resize0(keyi->groups, info->explicit_group + 1);
1095 if (info->explicit_group > 0) {
1096 darray_item(keyi->groups, info->explicit_group) =
1097 darray_item(keyi->groups, 0);
1098 InitGroupInfo(&darray_item(keyi->groups, 0));
1105 HandleSymbolsDef(SymbolsInfo *info, SymbolsDef *stmt)
1109 keyi = info->default_key;
1110 darray_init(keyi.groups);
1111 darray_copy(keyi.groups, info->default_key.groups);
1112 for (xkb_layout_index_t i = 0; i < darray_size(keyi.groups); i++)
1113 CopyGroupInfo(&darray_item(keyi.groups, i),
1114 &darray_item(info->default_key.groups, i));
1115 keyi.merge = stmt->merge;
1116 keyi.name = stmt->keyName;
1118 if (!HandleSymbolsBody(info, stmt->symbols, &keyi)) {
1123 if (!SetExplicitGroup(info, &keyi)) {
1128 if (!AddKeySymbols(info, &keyi, true)) {
1137 HandleModMapDef(SymbolsInfo *info, ModMapDef *def)
1140 xkb_mod_index_t ndx;
1142 struct xkb_context *ctx = info->ctx;
1144 ndx = XkbModNameToIndex(&info->keymap->mods, def->modifier, MOD_REAL);
1145 if (ndx == XKB_MOD_INVALID) {
1147 "Illegal modifier map definition; "
1148 "Ignoring map for non-modifier \"%s\"\n",
1149 xkb_atom_text(ctx, def->modifier));
1155 tmp.merge = def->merge;
1157 for (ExprDef *key = def->keys; key; key = (ExprDef *) key->common.next) {
1160 if (key->expr.op == EXPR_VALUE &&
1161 key->expr.value_type == EXPR_TYPE_KEYNAME) {
1162 tmp.haveSymbol = false;
1163 tmp.u.keyName = key->key_name.key_name;
1165 else if (ExprResolveKeySym(ctx, key, &sym)) {
1166 tmp.haveSymbol = true;
1171 "Modmap entries may contain only key names or keysyms; "
1172 "Illegal definition for %s modifier ignored\n",
1173 ModIndexText(info->ctx, &info->keymap->mods, tmp.modifier));
1177 ok = AddModMapEntry(info, &tmp) && ok;
1183 HandleSymbolsFile(SymbolsInfo *info, XkbFile *file, enum merge_mode merge)
1188 info->name = strdup_safe(file->name);
1190 for (ParseCommon *stmt = file->defs; stmt; stmt = stmt->next) {
1191 switch (stmt->type) {
1193 ok = HandleIncludeSymbols(info, (IncludeStmt *) stmt);
1196 ok = HandleSymbolsDef(info, (SymbolsDef *) stmt);
1199 ok = HandleGlobalVar(info, (VarDef *) stmt);
1202 ok = HandleVModDef(info->keymap, (VModDef *) stmt, merge);
1205 ok = HandleModMapDef(info, (ModMapDef *) stmt);
1209 "Symbols files may not include other types; "
1210 "Ignoring %s\n", stmt_type_to_string(stmt->type));
1218 if (info->errorCount > 10) {
1219 log_err(info->ctx, "Abandoning symbols file \"%s\"\n",
1227 * Given a keysym @sym, return a key which generates it, or NULL.
1228 * This is used for example in a modifier map definition, such as:
1229 * modifier_map Lock { Caps_Lock };
1230 * where we want to add the Lock modifier to the modmap of the key
1231 * which matches the keysym Caps_Lock.
1232 * Since there can be many keys which generates the keysym, the key
1233 * is chosen first by lowest group in which the keysym appears, than
1234 * by lowest level and than by lowest key code.
1236 static struct xkb_key *
1237 FindKeyForSymbol(struct xkb_keymap *keymap, xkb_keysym_t sym)
1239 struct xkb_key *key, *ret = NULL;
1240 xkb_layout_index_t group, min_group = UINT32_MAX;
1241 xkb_level_index_t level, min_level = UINT16_MAX;
1243 xkb_foreach_key(key, keymap) {
1244 for (group = 0; group < key->num_groups; group++) {
1245 for (level = 0; level < XkbKeyGroupWidth(key, group); level++) {
1246 if (key->groups[group].levels[level].num_syms != 1 ||
1247 key->groups[group].levels[level].u.sym != sym)
1251 * If the keysym was found in a group or level > 0, we must
1252 * keep looking since we might find a key in which the keysym
1253 * is in a lower group or level.
1255 if (group < min_group ||
1256 (group == min_group && level < min_level)) {
1258 if (group == 0 && level == 0) {
1274 * Find an appropriate type for a group and return its name.
1277 * - ONE_LEVEL for width 0/1
1278 * - ALPHABETIC for 2 shift levels, with lower/upercase keysyms
1279 * - KEYPAD for keypad keys.
1280 * - TWO_LEVEL for other 2 shift level keys.
1281 * and the same for four level keys.
1283 * FIXME: Decide how to handle multiple-syms-per-level, and do it.
1286 FindAutomaticType(struct xkb_context *ctx, GroupInfo *groupi)
1288 xkb_keysym_t sym0, sym1, sym2, sym3;
1289 xkb_level_index_t width = darray_size(groupi->levels);
1291 #define GET_SYM(level) \
1292 (darray_item(groupi->levels, level).num_syms == 0 ? \
1293 XKB_KEY_NoSymbol : \
1294 darray_item(groupi->levels, level).num_syms == 1 ? \
1295 darray_item(groupi->levels, level).u.sym : \
1296 /* num_syms > 1 */ \
1297 darray_item(groupi->levels, level).u.syms[0])
1299 if (width == 1 || width <= 0)
1300 return xkb_atom_intern_literal(ctx, "ONE_LEVEL");
1306 if (xkb_keysym_is_lower(sym0) && xkb_keysym_is_upper(sym1))
1307 return xkb_atom_intern_literal(ctx, "ALPHABETIC");
1309 if (xkb_keysym_is_keypad(sym0) || xkb_keysym_is_keypad(sym1))
1310 return xkb_atom_intern_literal(ctx, "KEYPAD");
1312 return xkb_atom_intern_literal(ctx, "TWO_LEVEL");
1316 if (xkb_keysym_is_lower(sym0) && xkb_keysym_is_upper(sym1)) {
1318 sym3 = (width == 4 ? GET_SYM(3) : XKB_KEY_NoSymbol);
1320 if (xkb_keysym_is_lower(sym2) && xkb_keysym_is_upper(sym3))
1321 return xkb_atom_intern_literal(ctx, "FOUR_LEVEL_ALPHABETIC");
1323 return xkb_atom_intern_literal(ctx, "FOUR_LEVEL_SEMIALPHABETIC");
1326 if (xkb_keysym_is_keypad(sym0) || xkb_keysym_is_keypad(sym1))
1327 return xkb_atom_intern_literal(ctx, "FOUR_LEVEL_KEYPAD");
1329 return xkb_atom_intern_literal(ctx, "FOUR_LEVEL");
1332 return XKB_ATOM_NONE;
1337 static const struct xkb_key_type *
1338 FindTypeForGroup(struct xkb_keymap *keymap, KeyInfo *keyi,
1339 xkb_layout_index_t group, bool *explicit_type)
1342 GroupInfo *groupi = &darray_item(keyi->groups, group);
1343 xkb_atom_t type_name = groupi->type;
1345 *explicit_type = true;
1347 if (type_name == XKB_ATOM_NONE) {
1348 if (keyi->default_type != XKB_ATOM_NONE) {
1349 type_name = keyi->default_type;
1352 type_name = FindAutomaticType(keymap->ctx, groupi);
1353 if (type_name != XKB_ATOM_NONE)
1354 *explicit_type = false;
1358 if (type_name == XKB_ATOM_NONE) {
1359 log_warn(keymap->ctx,
1360 "Couldn't find an automatic type for key '%s' group %d with %lu levels; "
1361 "Using the default type\n",
1362 KeyNameText(keymap->ctx, keyi->name), group + 1,
1363 (unsigned long) darray_size(groupi->levels));
1367 for (i = 0; i < keymap->num_types; i++)
1368 if (keymap->types[i].name == type_name)
1371 if (i >= keymap->num_types) {
1372 log_warn(keymap->ctx,
1373 "The type \"%s\" for key '%s' group %d was not previously defined; "
1374 "Using the default type\n",
1375 xkb_atom_text(keymap->ctx, type_name),
1376 KeyNameText(keymap->ctx, keyi->name), group + 1);
1380 return &keymap->types[i];
1384 * Index 0 is guaranteed to contain something, usually
1385 * ONE_LEVEL or at least some default one-level type.
1387 return &keymap->types[0];
1391 CopySymbolsDef(SymbolsInfo *info, KeyInfo *keyi)
1393 struct xkb_keymap *keymap = info->keymap;
1394 struct xkb_key *key;
1396 const GroupInfo *group0;
1397 xkb_layout_index_t i;
1400 * The name is guaranteed to be real and not an alias (see
1401 * AddKeySymbols), so 'false' is safe here.
1403 key = XkbKeyByName(keymap, keyi->name, false);
1405 log_vrb(info->ctx, 5,
1406 "Key %s not found in keycodes; Symbols ignored\n",
1407 KeyInfoText(info, keyi));
1411 /* Find the range of groups we need. */
1412 key->num_groups = 0;
1413 darray_enumerate(i, groupi, keyi->groups)
1414 if (groupi->defined)
1415 key->num_groups = i + 1;
1417 if (key->num_groups <= 0)
1418 return false; /* WSGO */
1420 darray_resize(keyi->groups, key->num_groups);
1423 * If there are empty groups between non-empty ones, fill them with data
1424 * from the first group.
1425 * We can make a wrong assumption here. But leaving gaps is worse.
1427 group0 = &darray_item(keyi->groups, 0);
1428 darray_foreach_from(groupi, keyi->groups, 1) {
1429 if (groupi->defined)
1432 CopyGroupInfo(groupi, group0);
1435 key->groups = calloc(key->num_groups, sizeof(*key->groups));
1437 /* Find and assign the groups' types in the keymap. */
1438 darray_enumerate(i, groupi, keyi->groups) {
1439 const struct xkb_key_type *type;
1442 type = FindTypeForGroup(keymap, keyi, i, &explicit_type);
1444 /* Always have as many levels as the type specifies. */
1445 if (type->num_levels < darray_size(groupi->levels)) {
1446 struct xkb_level *leveli;
1448 log_vrb(info->ctx, 1,
1449 "Type \"%s\" has %d levels, but %s has %d levels; "
1450 "Ignoring extra symbols\n",
1451 xkb_atom_text(keymap->ctx, type->name), type->num_levels,
1452 KeyInfoText(info, keyi),
1453 (int) darray_size(groupi->levels));
1455 darray_foreach_from(leveli, groupi->levels, type->num_levels)
1456 ClearLevelInfo(leveli);
1458 darray_resize0(groupi->levels, type->num_levels);
1460 key->groups[i].explicit_type = explicit_type;
1461 key->groups[i].type = type;
1465 darray_enumerate(i, groupi, keyi->groups) {
1466 key->groups[i].levels = darray_mem(groupi->levels, 0);
1467 darray_init(groupi->levels);
1470 key->out_of_range_group_number = keyi->out_of_range_group_number;
1471 key->out_of_range_group_action = keyi->out_of_range_group_action;
1473 if (keyi->defined & KEY_FIELD_VMODMAP) {
1474 key->vmodmap = keyi->vmodmap;
1475 key->explicit |= EXPLICIT_VMODMAP;
1478 if (keyi->repeat != KEY_REPEAT_UNDEFINED) {
1479 key->repeats = (keyi->repeat == KEY_REPEAT_YES);
1480 key->explicit |= EXPLICIT_REPEAT;
1483 darray_foreach(groupi, keyi->groups) {
1484 if (groupi->defined & GROUP_FIELD_ACTS) {
1485 key->explicit |= EXPLICIT_INTERP;
1494 CopyModMapDef(SymbolsInfo *info, ModMapEntry *entry)
1496 struct xkb_key *key;
1497 struct xkb_keymap *keymap = info->keymap;
1499 if (!entry->haveSymbol) {
1500 key = XkbKeyByName(keymap, entry->u.keyName, true);
1502 log_vrb(info->ctx, 5,
1503 "Key %s not found in keycodes; "
1504 "Modifier map entry for %s not updated\n",
1505 KeyNameText(keymap->ctx, entry->u.keyName),
1506 ModIndexText(info->ctx, &info->keymap->mods, entry->modifier));
1511 key = FindKeyForSymbol(keymap, entry->u.keySym);
1513 log_vrb(info->ctx, 5,
1514 "Key \"%s\" not found in symbol map; "
1515 "Modifier map entry for %s not updated\n",
1516 KeysymText(info->ctx, entry->u.keySym),
1517 ModIndexText(info->ctx, &info->keymap->mods, entry->modifier));
1522 key->modmap |= (1u << entry->modifier);
1527 CopySymbolsToKeymap(struct xkb_keymap *keymap, SymbolsInfo *info)
1532 keymap->symbols_section_name = strdup_safe(info->name);
1533 XkbEscapeMapName(keymap->symbols_section_name);
1535 keymap->num_group_names = darray_size(info->group_names);
1536 keymap->group_names = darray_mem(info->group_names, 0);
1537 darray_init(info->group_names);
1539 darray_foreach(keyi, info->keys)
1540 if (!CopySymbolsDef(info, keyi))
1543 if (xkb_context_get_log_verbosity(keymap->ctx) > 3) {
1544 struct xkb_key *key;
1546 xkb_foreach_key(key, keymap) {
1547 if (key->name == XKB_ATOM_NONE)
1550 if (key->num_groups < 1)
1551 log_info(keymap->ctx,
1552 "No symbols defined for %s\n",
1553 KeyNameText(keymap->ctx, key->name));
1557 darray_foreach(mm, info->modmaps)
1558 if (!CopyModMapDef(info, mm))
1561 /* XXX: If we don't ignore errorCount, things break. */
1566 CompileSymbols(XkbFile *file, struct xkb_keymap *keymap,
1567 enum merge_mode merge)
1570 ActionsInfo *actions;
1572 actions = NewActionsInfo();
1576 InitSymbolsInfo(&info, keymap, actions);
1577 info.default_key.merge = merge;
1579 HandleSymbolsFile(&info, file, merge);
1581 if (info.errorCount != 0)
1584 if (!CopySymbolsToKeymap(keymap, &info))
1587 ClearSymbolsInfo(&info);
1588 FreeActionsInfo(actions);
1592 FreeActionsInfo(actions);
1593 ClearSymbolsInfo(&info);