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 ********************************************************/
27 #include "xkbcomp-priv.h"
28 #include "parseutils.h"
33 SI_FIELD_VIRTUAL_MOD = (1 << 0),
34 SI_FIELD_ACTION = (1 << 1),
35 SI_FIELD_AUTO_REPEAT = (1 << 2),
36 SI_FIELD_LOCKING_KEY = (1 << 3),
37 SI_FIELD_LEVEL_ONE_ONLY = (1 << 4),
40 typedef struct _SymInterpInfo {
41 enum si_field defined;
43 enum merge_mode merge;
46 struct xkb_sym_interpret interp;
50 LED_FIELD_INDEX = (1 << 0),
51 LED_FIELD_MODS = (1 << 1),
52 LED_FIELD_GROUPS = (1 << 2),
53 LED_FIELD_CTRLS = (1 << 3),
54 LED_FIELD_EXPLICIT = (1 << 4),
55 LED_FIELD_AUTOMATIC = (1 << 5),
56 LED_FIELD_DRIVES_KBD = (1 << 6),
59 typedef struct _LEDInfo {
60 enum led_field defined;
62 enum merge_mode merge;
66 xkb_led_index_t indicator;
68 unsigned char which_mods;
69 unsigned char real_mods;
71 unsigned char which_groups;
76 typedef struct _GroupCompatInfo {
78 enum merge_mode merge;
80 unsigned char real_mods;
84 typedef struct _CompatInfo {
92 GroupCompatInfo groupCompat[XkbNumKbdGroups];
96 struct xkb_keymap *keymap;
100 siText(SymInterpInfo * si, CompatInfo * info)
102 static char buf[128];
104 if (si == &info->dflt) {
105 snprintf(buf, sizeof(buf), "default");
108 snprintf(buf, sizeof(buf), "%s+%s(%s)",
109 KeysymText(si->interp.sym),
110 SIMatchText(si->interp.match),
111 ModMaskText(si->interp.mods, false));
117 ReportSINotArray(CompatInfo *info, SymInterpInfo *si, const char *field)
119 return ReportNotArray(info->keymap, "symbol interpretation", field,
124 ReportSIBadType(CompatInfo *info, SymInterpInfo *si, const char *field,
127 return ReportBadType(info->keymap, "symbol interpretation", field,
128 siText(si, info), wanted);
132 ReportIndicatorBadType(CompatInfo *info, LEDInfo *led,
133 const char *field, const char *wanted)
135 return ReportBadType(info->keymap, "indicator map", field,
136 xkb_atom_text(info->keymap->ctx, led->name),
141 ReportIndicatorNotArray(CompatInfo *info, LEDInfo *led,
144 return ReportNotArray(info->keymap, "indicator map", field,
145 xkb_atom_text(info->keymap->ctx, led->name));
149 ClearIndicatorMapInfo(struct xkb_context *ctx, LEDInfo * info)
151 info->name = xkb_atom_intern(ctx, "default");
152 info->indicator = XKB_LED_INVALID;
153 info->flags = info->which_mods = info->real_mods = 0;
155 info->which_groups = info->groups = 0;
160 InitCompatInfo(CompatInfo *info, struct xkb_keymap *keymap, unsigned file_id)
164 info->keymap = keymap;
166 info->file_id = file_id;
167 info->errorCount = 0;
169 list_init(&info->interps);
171 info->dflt.file_id = file_id;
172 info->dflt.defined = 0;
173 info->dflt.merge = MERGE_OVERRIDE;
174 info->dflt.interp.flags = 0;
175 info->dflt.interp.virtual_mod = XkbNoModifier;
176 info->dflt.interp.act.type = XkbSA_NoAction;
177 for (i = 0; i < sizeof(info->dflt.interp.act.any.data); i++)
178 info->dflt.interp.act.any.data[i] = 0;
179 ClearIndicatorMapInfo(keymap->ctx, &info->ledDflt);
180 info->ledDflt.file_id = file_id;
181 info->ledDflt.defined = 0;
182 info->ledDflt.merge = MERGE_OVERRIDE;
183 memset(&info->groupCompat[0], 0,
184 XkbNumKbdGroups * sizeof(GroupCompatInfo));
185 list_init(&info->leds);
186 InitVModInfo(&info->vmods, keymap);
190 ClearCompatInfo(CompatInfo *info)
193 ActionInfo *next_act;
194 SymInterpInfo *si, *next_si;
195 LEDInfo *led, *next_led;
196 struct xkb_keymap *keymap = info->keymap;
200 info->dflt.defined = 0;
201 info->dflt.merge = MERGE_AUGMENT;
202 info->dflt.interp.flags = 0;
203 info->dflt.interp.virtual_mod = XkbNoModifier;
204 info->dflt.interp.act.type = XkbSA_NoAction;
205 for (i = 0; i < sizeof(info->dflt.interp.act.any.data); i++)
206 info->dflt.interp.act.any.data[i] = 0;
207 ClearIndicatorMapInfo(keymap->ctx, &info->ledDflt);
209 list_foreach_safe(si, next_si, &info->interps, entry)
211 memset(&info->groupCompat[0], 0,
212 XkbNumKbdGroups * sizeof(GroupCompatInfo));
213 list_foreach_safe(led, next_led, &info->leds, entry)
216 next_act = info->act->next;
218 info->act = next_act;
221 ClearVModInfo(&info->vmods, keymap);
224 static SymInterpInfo *
225 NextInterp(CompatInfo * info)
229 si = calloc(1, sizeof(*si));
233 list_append(&si->entry, &info->interps);
239 static SymInterpInfo *
240 FindMatchingInterp(CompatInfo * info, SymInterpInfo * new)
244 list_foreach(old, &info->interps, entry)
245 if (old->interp.sym == new->interp.sym &&
246 old->interp.mods == new->interp.mods &&
247 old->interp.match == new->interp.match)
254 UseNewInterpField(enum si_field field, SymInterpInfo *old, SymInterpInfo *new,
255 int verbosity, enum si_field *collide)
257 if (!(old->defined & field))
260 if (new->defined & field) {
261 if ((old->file_id == new->file_id && verbosity > 0) || verbosity > 9)
264 if (new->merge != MERGE_AUGMENT)
272 AddInterp(CompatInfo * info, SymInterpInfo * new)
274 enum si_field collide;
277 int verbosity = xkb_get_log_verbosity(info->keymap->ctx);
280 old = FindMatchingInterp(info, new);
282 if (new->merge == MERGE_REPLACE) {
284 if ((old->file_id == new->file_id && verbosity > 0) ||
286 log_warn(info->keymap->ctx,
287 "Multiple definitions for \"%s\"; "
288 "Earlier interpretation ignored\n",
295 if (UseNewInterpField(SI_FIELD_VIRTUAL_MOD, old, new, verbosity,
297 old->interp.virtual_mod = new->interp.virtual_mod;
298 old->defined |= SI_FIELD_VIRTUAL_MOD;
300 if (UseNewInterpField(SI_FIELD_ACTION, old, new, verbosity,
302 old->interp.act = new->interp.act;
303 old->defined |= SI_FIELD_ACTION;
305 if (UseNewInterpField(SI_FIELD_AUTO_REPEAT, old, new, verbosity,
307 old->interp.flags &= ~XkbSI_AutoRepeat;
308 old->interp.flags |= (new->interp.flags & XkbSI_AutoRepeat);
309 old->defined |= SI_FIELD_AUTO_REPEAT;
311 if (UseNewInterpField(SI_FIELD_LOCKING_KEY, old, new, verbosity,
313 old->interp.flags &= ~XkbSI_LockingKey;
314 old->interp.flags |= (new->interp.flags & XkbSI_LockingKey);
315 old->defined |= SI_FIELD_LOCKING_KEY;
317 if (UseNewInterpField(SI_FIELD_LEVEL_ONE_ONLY, old, new, verbosity,
319 old->interp.match &= ~XkbSI_LevelOneOnly;
320 old->interp.match |= (new->interp.match & XkbSI_LevelOneOnly);
321 old->defined |= SI_FIELD_LEVEL_ONE_ONLY;
325 log_warn(info->keymap->ctx,
326 "Multiple interpretations of \"%s\"; "
327 "Using %s definition for duplicate fields\n",
329 (new->merge != MERGE_AUGMENT ? "last" : "first"));
336 if ((new = NextInterp(info)) == NULL)
345 AddGroupCompat(CompatInfo *info, xkb_group_index_t group, GroupCompatInfo *new)
348 int verbosity = xkb_get_log_verbosity(info->keymap->ctx);
350 gc = &info->groupCompat[group];
351 if (gc->real_mods == new->real_mods && gc->vmods == new->vmods)
354 if ((gc->file_id == new->file_id && verbosity > 0) || verbosity > 9)
355 log_warn(info->keymap->ctx,
356 "Compat map for group %u redefined; "
357 "Using %s definition\n",
358 group + 1, (new->merge == MERGE_AUGMENT ? "old" : "new"));
360 if (new->defined && (new->merge != MERGE_AUGMENT || !gc->defined))
366 /***====================================================================***/
369 ResolveStateAndPredicate(ExprDef * expr,
371 xkb_mod_mask_t *mods_rtrn, CompatInfo * info)
374 *pred_rtrn = XkbSI_AnyOfOrNone;
379 *pred_rtrn = XkbSI_Exactly;
380 if (expr->op == EXPR_ACTION_DECL) {
381 const char *pred_txt = xkb_atom_text(info->keymap->ctx,
382 expr->value.action.name);
383 if (istreq(pred_txt, "noneof"))
384 *pred_rtrn = XkbSI_NoneOf;
385 else if (istreq(pred_txt, "anyofornone"))
386 *pred_rtrn = XkbSI_AnyOfOrNone;
387 else if (istreq(pred_txt, "anyof"))
388 *pred_rtrn = XkbSI_AnyOf;
389 else if (istreq(pred_txt, "allof"))
390 *pred_rtrn = XkbSI_AllOf;
391 else if (istreq(pred_txt, "exactly"))
392 *pred_rtrn = XkbSI_Exactly;
394 log_err(info->keymap->ctx,
395 "Illegal modifier predicate \"%s\"; Ignored\n", pred_txt);
398 expr = expr->value.action.args;
400 else if (expr->op == EXPR_IDENT) {
401 const char *pred_txt = xkb_atom_text(info->keymap->ctx,
403 if (pred_txt && istreq(pred_txt, "any")) {
404 *pred_rtrn = XkbSI_AnyOf;
410 return ExprResolveModMask(info->keymap->ctx, expr, mods_rtrn);
413 /***====================================================================***/
416 UseNewLEDField(enum led_field field, LEDInfo *old, LEDInfo *new,
417 int verbosity, enum led_field *collide)
419 if (!(old->defined & field))
422 if (new->defined & field) {
423 if ((old->file_id == new->file_id && verbosity > 0) || verbosity > 9)
426 if (new->merge != MERGE_AUGMENT)
434 AddIndicatorMap(CompatInfo *info, LEDInfo *new)
437 enum led_field collide;
438 struct xkb_context *ctx = info->keymap->ctx;
439 int verbosity = xkb_get_log_verbosity(ctx);
441 list_foreach(old, &info->leds, entry) {
442 if (old->name == new->name) {
443 if ((old->real_mods == new->real_mods) &&
444 (old->vmods == new->vmods) &&
445 (old->groups == new->groups) &&
446 (old->ctrls == new->ctrls) &&
447 (old->which_mods == new->which_mods) &&
448 (old->which_groups == new->which_groups)) {
449 old->defined |= new->defined;
453 if (new->merge == MERGE_REPLACE) {
454 struct list entry = old->entry;
455 if ((old->file_id == new->file_id && verbosity > 0) ||
457 log_warn(info->keymap->ctx,
458 "Map for indicator %s redefined; "
459 "Earlier definition ignored\n",
460 xkb_atom_text(ctx, old->name));
467 if (UseNewLEDField(LED_FIELD_INDEX, old, new, verbosity,
469 old->indicator = new->indicator;
470 old->defined |= LED_FIELD_INDEX;
472 if (UseNewLEDField(LED_FIELD_MODS, old, new, verbosity,
474 old->which_mods = new->which_mods;
475 old->real_mods = new->real_mods;
476 old->vmods = new->vmods;
477 old->defined |= LED_FIELD_MODS;
479 if (UseNewLEDField(LED_FIELD_GROUPS, old, new, verbosity,
481 old->which_groups = new->which_groups;
482 old->groups = new->groups;
483 old->defined |= LED_FIELD_GROUPS;
485 if (UseNewLEDField(LED_FIELD_CTRLS, old, new, verbosity,
487 old->ctrls = new->ctrls;
488 old->defined |= LED_FIELD_CTRLS;
490 if (UseNewLEDField(LED_FIELD_EXPLICIT, old, new, verbosity,
492 old->flags &= ~XkbIM_NoExplicit;
493 old->flags |= (new->flags & XkbIM_NoExplicit);
494 old->defined |= LED_FIELD_EXPLICIT;
496 if (UseNewLEDField(LED_FIELD_AUTOMATIC, old, new, verbosity,
498 old->flags &= ~XkbIM_NoAutomatic;
499 old->flags |= (new->flags & XkbIM_NoAutomatic);
500 old->defined |= LED_FIELD_AUTOMATIC;
502 if (UseNewLEDField(LED_FIELD_DRIVES_KBD, old, new, verbosity,
504 old->flags &= ~XkbIM_LEDDrivesKB;
505 old->flags |= (new->flags & XkbIM_LEDDrivesKB);
506 old->defined |= LED_FIELD_DRIVES_KBD;
510 log_warn(info->keymap->ctx,
511 "Map for indicator %s redefined; "
512 "Using %s definition for duplicate fields\n",
513 xkb_atom_text(ctx, old->name),
514 (new->merge == MERGE_AUGMENT ? "first" : "last"));
522 old = malloc(sizeof(*old));
524 log_wsgo(info->keymap->ctx,
525 "Couldn't allocate indicator map; "
526 "Map for indicator %s not compiled\n",
527 xkb_atom_text(ctx, new->name));
532 list_append(&old->entry, &info->leds);
538 MergeIncludedCompatMaps(CompatInfo * into, CompatInfo * from,
539 enum merge_mode merge)
542 LEDInfo *led, *next_led;
543 GroupCompatInfo *gcm;
546 if (from->errorCount > 0) {
547 into->errorCount += from->errorCount;
550 if (into->name == NULL) {
551 into->name = from->name;
555 list_foreach(si, &from->interps, entry) {
556 if (merge != MERGE_DEFAULT)
558 if (!AddInterp(into, si))
562 for (i = 0, gcm = &from->groupCompat[0]; i < XkbNumKbdGroups;
564 if (merge != MERGE_DEFAULT)
566 if (!AddGroupCompat(into, i, gcm))
570 list_foreach_safe(led, next_led, &from->leds, entry) {
571 led->merge = (merge == MERGE_DEFAULT ? led->merge : merge);
572 if (!AddIndicatorMap(into, led))
578 HandleCompatMapFile(CompatInfo *info, XkbFile *file, enum merge_mode merge);
581 HandleIncludeCompatMap(CompatInfo *info, IncludeStmt *stmt)
583 enum merge_mode merge = MERGE_DEFAULT;
585 CompatInfo included, next_incl;
587 InitCompatInfo(&included, info->keymap, info->file_id);
590 included.name = stmt->stmt;
594 for (; stmt; stmt = stmt->next_incl) {
595 if (!ProcessIncludeFile(info->keymap->ctx, stmt, FILE_TYPE_COMPAT,
597 info->errorCount += 10;
598 ClearCompatInfo(&included);
602 InitCompatInfo(&next_incl, info->keymap, rtrn->id);
603 next_incl.file_id = rtrn->id;
604 next_incl.dflt = info->dflt;
605 next_incl.dflt.file_id = rtrn->id;
606 next_incl.dflt.merge = merge;
607 next_incl.ledDflt.file_id = rtrn->id;
608 next_incl.ledDflt.merge = merge;
609 next_incl.act = info->act;
611 HandleCompatMapFile(&next_incl, rtrn, MERGE_OVERRIDE);
613 MergeIncludedCompatMaps(&included, &next_incl, merge);
615 next_incl.act = NULL;
617 ClearCompatInfo(&next_incl);
621 MergeIncludedCompatMaps(info, &included, merge);
622 ClearCompatInfo(&included);
624 return (info->errorCount == 0);
627 static const LookupEntry useModMapValues[] = {
636 SetInterpField(CompatInfo *info, SymInterpInfo *si, const char *field,
637 ExprDef *arrayNdx, ExprDef *value)
639 struct xkb_keymap *keymap = info->keymap;
642 if (istreq(field, "action")) {
644 return ReportSINotArray(info, si, field);
646 if (!HandleActionDef(value, keymap, &si->interp.act.any, info->act))
649 si->defined |= SI_FIELD_ACTION;
651 else if (istreq(field, "virtualmodifier") ||
652 istreq(field, "virtualmod")) {
654 return ReportSINotArray(info, si, field);
656 if (!ResolveVirtualModifier(value, keymap, &ndx, &info->vmods))
657 return ReportSIBadType(info, si, field, "virtual modifier");
659 si->interp.virtual_mod = ndx;
660 si->defined |= SI_FIELD_VIRTUAL_MOD;
662 else if (istreq(field, "repeat")) {
666 return ReportSINotArray(info, si, field);
668 if (!ExprResolveBoolean(keymap->ctx, value, &set))
669 return ReportSIBadType(info, si, field, "boolean");
672 si->interp.flags |= XkbSI_AutoRepeat;
674 si->interp.flags &= ~XkbSI_AutoRepeat;
676 si->defined |= SI_FIELD_AUTO_REPEAT;
678 else if (istreq(field, "locking")) {
682 return ReportSINotArray(info, si, field);
684 if (!ExprResolveBoolean(keymap->ctx, value, &set))
685 return ReportSIBadType(info, si, field, "boolean");
688 si->interp.flags |= XkbSI_LockingKey;
690 si->interp.flags &= ~XkbSI_LockingKey;
692 si->defined |= SI_FIELD_LOCKING_KEY;
694 else if (istreq(field, "usemodmap") ||
695 istreq(field, "usemodmapmods")) {
699 return ReportSINotArray(info, si, field);
701 if (!ExprResolveEnum(keymap->ctx, value, &val, useModMapValues))
702 return ReportSIBadType(info, si, field, "level specification");
705 si->interp.match |= XkbSI_LevelOneOnly;
707 si->interp.match &= ~XkbSI_LevelOneOnly;
709 si->defined |= SI_FIELD_LEVEL_ONE_ONLY;
712 return ReportBadField(keymap, "symbol interpretation", field,
719 static const LookupEntry modComponentNames[] = {
720 {"base", XkbIM_UseBase},
721 {"latched", XkbIM_UseLatched},
722 {"locked", XkbIM_UseLocked},
723 {"effective", XkbIM_UseEffective},
724 {"compat", XkbIM_UseCompat},
725 {"any", XkbIM_UseAnyMods},
729 static const LookupEntry groupComponentNames[] = {
730 {"base", XkbIM_UseBase},
731 {"latched", XkbIM_UseLatched},
732 {"locked", XkbIM_UseLocked},
733 {"effective", XkbIM_UseEffective},
734 {"any", XkbIM_UseAnyGroup},
739 static const LookupEntry groupNames[] = {
754 SetIndicatorMapField(CompatInfo *info, LEDInfo *led,
755 const char *field, ExprDef *arrayNdx, ExprDef *value)
758 struct xkb_keymap *keymap = info->keymap;
760 if (istreq(field, "modifiers") || istreq(field, "mods")) {
764 return ReportIndicatorNotArray(info, led, field);
766 if (!ExprResolveVModMask(keymap, value, &mask))
767 return ReportIndicatorBadType(info, led, field, "modifier mask");
769 led->real_mods = mask & 0xff;
770 led->vmods = (mask >> XkbNumModifiers) & 0xffff;
771 led->defined |= LED_FIELD_MODS;
773 else if (istreq(field, "groups")) {
777 return ReportIndicatorNotArray(info, led, field);
779 if (!ExprResolveMask(keymap->ctx, value, &mask, groupNames))
780 return ReportIndicatorBadType(info, led, field, "group mask");
783 led->defined |= LED_FIELD_GROUPS;
785 else if (istreq(field, "controls") || istreq(field, "ctrls")) {
789 return ReportIndicatorNotArray(info, led, field);
791 if (!ExprResolveMask(keymap->ctx, value, &mask, ctrlNames))
792 return ReportIndicatorBadType(info, led, field,
796 led->defined |= LED_FIELD_CTRLS;
798 else if (istreq(field, "allowexplicit")) {
802 return ReportIndicatorNotArray(info, led, field);
804 if (!ExprResolveBoolean(keymap->ctx, value, &set))
805 return ReportIndicatorBadType(info, led, field, "boolean");
808 led->flags &= ~XkbIM_NoExplicit;
810 led->flags |= XkbIM_NoExplicit;
812 led->defined |= LED_FIELD_EXPLICIT;
814 else if (istreq(field, "whichmodstate") ||
815 istreq(field, "whichmodifierstate")) {
819 return ReportIndicatorNotArray(info, led, field);
821 if (!ExprResolveMask(keymap->ctx, value, &mask, modComponentNames))
822 return ReportIndicatorBadType(info, led, field,
823 "mask of modifier state components");
825 led->which_mods = mask;
827 else if (istreq(field, "whichgroupstate")) {
831 return ReportIndicatorNotArray(info, led, field);
833 if (!ExprResolveMask(keymap->ctx, value, &mask, groupComponentNames))
834 return ReportIndicatorBadType(info, led, field,
835 "mask of group state components");
837 led->which_groups = mask;
839 else if (istreq(field, "driveskbd") ||
840 istreq(field, "driveskeyboard") ||
841 istreq(field, "leddriveskbd") ||
842 istreq(field, "leddriveskeyboard") ||
843 istreq(field, "indicatordriveskbd") ||
844 istreq(field, "indicatordriveskeyboard")) {
848 return ReportIndicatorNotArray(info, led, field);
850 if (!ExprResolveBoolean(keymap->ctx, value, &set))
851 return ReportIndicatorBadType(info, led, field, "boolean");
854 led->flags |= XkbIM_LEDDrivesKB;
856 led->flags &= ~XkbIM_LEDDrivesKB;
858 led->defined |= LED_FIELD_DRIVES_KBD;
860 else if (istreq(field, "index")) {
864 return ReportIndicatorNotArray(info, led, field);
866 if (!ExprResolveInteger(keymap->ctx, value, &ndx))
867 return ReportIndicatorBadType(info, led, field,
870 if (ndx < 1 || ndx > 32) {
871 log_err(info->keymap->ctx,
872 "Illegal indicator index %d (range 1..%d); "
873 "Index definition for %s indicator ignored\n",
874 ndx, XkbNumIndicators,
875 xkb_atom_text(keymap->ctx, led->name));
879 led->indicator = (xkb_led_index_t) ndx;
880 led->defined |= LED_FIELD_INDEX;
883 log_err(info->keymap->ctx,
884 "Unknown field %s in map for %s indicator; "
885 "Definition ignored\n",
886 field, xkb_atom_text(keymap->ctx, led->name));
894 HandleInterpVar(CompatInfo *info, VarDef *stmt)
896 const char *elem, *field;
900 if (!ExprResolveLhs(info->keymap->ctx, stmt->name, &elem, &field, &ndx))
901 ret = 0; /* internal error, already reported */
902 else if (elem && istreq(elem, "interpret"))
903 ret = SetInterpField(info, &info->dflt, field, ndx, stmt->value);
904 else if (elem && istreq(elem, "indicator"))
905 ret = SetIndicatorMapField(info, &info->ledDflt, field, ndx,
908 ret = SetActionField(info->keymap, elem, field, ndx, stmt->value,
914 HandleInterpBody(CompatInfo *info, VarDef *def, SymInterpInfo *si)
917 const char *elem, *field;
920 for (; def != NULL; def = (VarDef *) def->common.next) {
921 if (def->name && def->name->op == EXPR_FIELD_REF) {
922 ok = HandleInterpVar(info, def);
925 ok = ExprResolveLhs(info->keymap->ctx, def->name, &elem, &field,
928 ok = SetInterpField(info, si, field, arrayNdx, def->value);
935 HandleInterpDef(CompatInfo *info, InterpDef *def, enum merge_mode merge)
940 if (!ResolveStateAndPredicate(def->match, &pred, &mods, info)) {
941 log_err(info->keymap->ctx,
942 "Couldn't determine matching modifiers; "
943 "Symbol interpretation ignored\n");
946 if (def->merge != MERGE_DEFAULT)
951 if (!LookupKeysym(def->sym, &si.interp.sym)) {
952 log_err(info->keymap->ctx,
953 "Could not resolve keysym %s; "
954 "Symbol interpretation ignored\n",
958 si.interp.match = pred & XkbSI_OpMask;
959 si.interp.mods = mods;
960 if (!HandleInterpBody(info, def->def, &si)) {
965 if (!AddInterp(info, &si)) {
973 HandleGroupCompatDef(CompatInfo *info, GroupCompatDef *def,
974 enum merge_mode merge)
979 merge = (def->merge == MERGE_DEFAULT ? merge : def->merge);
981 if (def->group < 1 || def->group > XkbNumKbdGroups) {
982 log_err(info->keymap->ctx,
983 "Keyboard group must be in the range 1..%u; "
984 "Compatibility map for illegal group %u ignored\n",
985 XkbNumKbdGroups, def->group);
989 tmp.file_id = info->file_id;
992 if (!ExprResolveVModMask(info->keymap, def->def, &mask)) {
993 log_err(info->keymap->ctx,
994 "Expected a modifier mask in group compatibility definition; "
995 "Ignoring illegal compatibility map for group %u\n",
1000 tmp.real_mods = mask & 0xff;
1001 tmp.vmods = (mask >> XkbNumModifiers) & 0xffff;
1003 return AddGroupCompat(info, def->group - 1, &tmp);
1007 HandleIndicatorMapDef(CompatInfo *info, IndicatorMapDef *def,
1008 enum merge_mode merge)
1014 if (def->merge != MERGE_DEFAULT)
1017 led = info->ledDflt;
1019 led.name = def->name;
1022 for (var = def->body; var != NULL; var = (VarDef *) var->common.next) {
1023 const char *elem, *field;
1025 if (!ExprResolveLhs(info->keymap->ctx, var->name, &elem, &field,
1032 log_err(info->keymap->ctx,
1033 "Cannot set defaults for \"%s\" element in indicator map; "
1034 "Assignment to %s.%s ignored\n", elem, elem, field);
1038 ok = SetIndicatorMapField(info, &led, field, arrayNdx,
1044 return AddIndicatorMap(info, &led);
1050 HandleCompatMapFile(CompatInfo *info, XkbFile *file, enum merge_mode merge)
1055 merge = (merge == MERGE_DEFAULT ? MERGE_AUGMENT : merge);
1058 info->name = strdup_safe(file->name);
1060 for (stmt = file->defs; stmt; stmt = stmt->next) {
1061 switch (stmt->type) {
1063 ok = HandleIncludeCompatMap(info, (IncludeStmt *) stmt);
1066 ok = HandleInterpDef(info, (InterpDef *) stmt, merge);
1068 case STMT_GROUP_COMPAT:
1069 ok = HandleGroupCompatDef(info, (GroupCompatDef *) stmt, merge);
1071 case STMT_INDICATOR_MAP:
1072 ok = HandleIndicatorMapDef(info, (IndicatorMapDef *) stmt, merge);
1075 ok = HandleInterpVar(info, (VarDef *) stmt);
1078 ok = HandleVModDef((VModDef *) stmt, info->keymap, merge,
1082 log_err(info->keymap->ctx,
1083 "Interpretation files may not include other types; "
1084 "Ignoring %s\n", StmtTypeToString(stmt->type));
1092 if (info->errorCount > 10) {
1093 log_err(info->keymap->ctx,
1094 "Abandoning compatibility map \"%s\"\n", file->topName);
1101 CopyInterps(CompatInfo *info, bool needSymbol, unsigned pred)
1105 list_foreach(si, &info->interps, entry) {
1106 if (((si->interp.match & XkbSI_OpMask) != pred) ||
1107 (needSymbol && si->interp.sym == XKB_KEY_NoSymbol) ||
1108 (!needSymbol && si->interp.sym != XKB_KEY_NoSymbol))
1111 darray_append(info->keymap->sym_interpret, si->interp);
1116 BindIndicators(CompatInfo *info, struct list *unbound_leds)
1119 LEDInfo *led, *next_led;
1120 struct xkb_indicator_map *map;
1121 struct xkb_keymap *keymap = info->keymap;
1123 list_foreach(led, unbound_leds, entry) {
1124 if (led->indicator == XKB_LED_INVALID) {
1125 for (i = 0; i < XkbNumIndicators; i++) {
1126 if (keymap->indicator_names[i] &&
1127 streq(keymap->indicator_names[i],
1128 xkb_atom_text(keymap->ctx, led->name))) {
1129 led->indicator = i + 1;
1136 list_foreach(led, unbound_leds, entry) {
1137 if (led->indicator == XKB_LED_INVALID) {
1138 for (i = 0; i < XkbNumIndicators; i++) {
1139 if (keymap->indicator_names[i] == NULL) {
1140 keymap->indicator_names[i] =
1141 xkb_atom_text(keymap->ctx, led->name);
1142 led->indicator = i + 1;
1147 if (led->indicator == XKB_LED_INVALID) {
1148 log_err(info->keymap->ctx,
1149 "No unnamed indicators found; "
1150 "Virtual indicator map \"%s\" not bound\n",
1151 xkb_atom_text(keymap->ctx, led->name));
1157 list_foreach_safe(led, next_led, unbound_leds, entry) {
1158 if (led->indicator == XKB_LED_INVALID) {
1163 if (!streq(keymap->indicator_names[led->indicator - 1],
1164 xkb_atom_text(keymap->ctx, led->name))) {
1165 const char *old = keymap->indicator_names[led->indicator - 1];
1166 log_err(info->keymap->ctx,
1167 "Multiple names bound to indicator %d; "
1168 "Using %s, ignoring %s\n",
1169 led->indicator, old,
1170 xkb_atom_text(keymap->ctx, led->name));
1175 map = &keymap->indicators[led->indicator - 1];
1176 map->flags = led->flags;
1177 map->which_groups = led->which_groups;
1178 map->groups = led->groups;
1179 map->which_mods = led->which_mods;
1180 map->mods.mask = led->real_mods;
1181 map->mods.real_mods = led->real_mods;
1182 map->mods.vmods = led->vmods;
1183 map->ctrls = led->ctrls;
1187 list_init(unbound_leds);
1191 CopyIndicatorMapDefs(CompatInfo *info)
1193 LEDInfo *led, *next_led;
1194 struct list unbound_leds;
1195 struct xkb_indicator_map *im;
1196 struct xkb_keymap *keymap = info->keymap;
1198 list_init(&unbound_leds);
1200 list_foreach_safe(led, next_led, &info->leds, entry) {
1201 if (led->groups != 0 && led->which_groups == 0)
1202 led->which_groups = XkbIM_UseEffective;
1204 if (led->which_mods == 0 && (led->real_mods || led->vmods))
1205 led->which_mods = XkbIM_UseEffective;
1207 if (led->indicator == XKB_LED_INVALID) {
1208 list_append(&led->entry, &unbound_leds);
1212 im = &keymap->indicators[led->indicator - 1];
1213 im->flags = led->flags;
1214 im->which_groups = led->which_groups;
1215 im->groups = led->groups;
1216 im->which_mods = led->which_mods;
1217 im->mods.mask = led->real_mods;
1218 im->mods.real_mods = led->real_mods;
1219 im->mods.vmods = led->vmods;
1220 im->ctrls = led->ctrls;
1221 keymap->indicator_names[led->indicator - 1] =
1222 xkb_atom_text(keymap->ctx, led->name);
1225 list_init(&info->leds);
1227 BindIndicators(info, &unbound_leds);
1233 CompileCompatMap(XkbFile *file, struct xkb_keymap *keymap,
1234 enum merge_mode merge)
1236 xkb_group_index_t i;
1238 GroupCompatInfo *gcm;
1240 InitCompatInfo(&info, keymap, file->id);
1241 info.dflt.merge = merge;
1242 info.ledDflt.merge = merge;
1244 HandleCompatMapFile(&info, file, merge);
1246 if (info.errorCount != 0)
1249 darray_init(keymap->sym_interpret);
1250 darray_growalloc(keymap->sym_interpret, info.nInterps);
1253 keymap->compat_section_name = strdup(info.name);
1255 if (info.nInterps > 0) {
1256 CopyInterps(&info, true, XkbSI_Exactly);
1257 CopyInterps(&info, true, XkbSI_AllOf | XkbSI_NoneOf);
1258 CopyInterps(&info, true, XkbSI_AnyOf);
1259 CopyInterps(&info, true, XkbSI_AnyOfOrNone);
1260 CopyInterps(&info, false, XkbSI_Exactly);
1261 CopyInterps(&info, false, XkbSI_AllOf | XkbSI_NoneOf);
1262 CopyInterps(&info, false, XkbSI_AnyOf);
1263 CopyInterps(&info, false, XkbSI_AnyOfOrNone);
1266 for (i = 0, gcm = &info.groupCompat[0]; i < XkbNumKbdGroups;
1268 if (gcm->file_id != 0 || gcm->real_mods != 0 || gcm->vmods != 0) {
1269 keymap->groups[i].mask = gcm->real_mods;
1270 keymap->groups[i].real_mods = gcm->real_mods;
1271 keymap->groups[i].vmods = gcm->vmods;
1275 if (!CopyIndicatorMapDefs(&info))
1278 ClearCompatInfo(&info);
1282 ClearCompatInfo(&info);
1287 VModsToReal(struct xkb_keymap *keymap, xkb_mod_mask_t vmodmask)
1289 xkb_mod_mask_t ret = 0;
1295 for (i = 0; i < XkbNumVirtualMods; i++) {
1296 if (!(vmodmask & (1 << i)))
1298 ret |= keymap->vmods[i];
1305 UpdateActionMods(struct xkb_keymap *keymap, union xkb_action *act,
1306 xkb_mod_mask_t rmodmask)
1308 switch (act->type) {
1310 case XkbSA_LatchMods:
1311 case XkbSA_LockMods:
1312 if (act->mods.flags & XkbSA_UseModMapMods)
1313 act->mods.real_mods = rmodmask;
1314 act->mods.mask = act->mods.real_mods;
1315 act->mods.mask |= VModsToReal(keymap, act->mods.vmods);
1319 if (act->iso.flags & XkbSA_UseModMapMods)
1320 act->iso.real_mods = rmodmask;
1321 act->iso.mask = act->iso.real_mods;
1322 act->iso.mask |= VModsToReal(keymap, act->iso.vmods);
1331 * Find an interpretation which applies to this particular level, either by
1332 * finding an exact match for the symbol and modifier combination, or a
1333 * generic XKB_KEY_NoSymbol match.
1335 static struct xkb_sym_interpret *
1336 FindInterpForKey(struct xkb_keymap *keymap, struct xkb_key *key,
1337 xkb_group_index_t group, xkb_level_index_t level)
1339 struct xkb_sym_interpret *ret = NULL;
1340 struct xkb_sym_interpret *interp;
1341 const xkb_keysym_t *syms;
1344 num_syms = xkb_key_get_syms_by_level(keymap, key, group, level, &syms);
1348 darray_foreach(interp, keymap->sym_interpret) {
1352 if ((num_syms > 1 || interp->sym != syms[0]) &&
1353 interp->sym != XKB_KEY_NoSymbol)
1356 if (level == 0 || !(interp->match & XkbSI_LevelOneOnly))
1361 switch (interp->match & XkbSI_OpMask) {
1363 found = !(interp->mods & mods);
1365 case XkbSI_AnyOfOrNone:
1366 found = (!mods || (interp->mods & mods));
1369 found = !!(interp->mods & mods);
1372 found = ((interp->mods & mods) == interp->mods);
1375 found = (interp->mods == mods);
1382 if (found && interp->sym != XKB_KEY_NoSymbol)
1384 else if (found && !ret)
1394 ApplyInterpsToKey(struct xkb_keymap *keymap, struct xkb_key *key)
1396 #define INTERP_SIZE (8 * 4)
1397 struct xkb_sym_interpret *interps[INTERP_SIZE];
1398 union xkb_action *acts;
1399 xkb_mod_mask_t vmodmask = 0;
1401 xkb_group_index_t group;
1402 xkb_level_index_t level;
1405 /* If we've been told not to bind interps to this key, then don't. */
1406 if (key->explicit & XkbExplicitInterpretMask)
1409 for (i = 0; i < INTERP_SIZE; i++)
1412 for (group = 0; group < key->num_groups; group++) {
1413 for (level = 0; level < XkbKeyGroupWidth(keymap, key, group);
1415 i = (group * key->width) + level;
1416 if (i >= INTERP_SIZE) /* XXX FIXME */
1418 interps[i] = FindInterpForKey(keymap, key, group, level);
1425 num_acts = key->num_groups * key->width;
1426 acts = ResizeKeyActions(keymap, key, num_acts);
1427 if (num_acts && !acts)
1430 for (group = 0; group < key->num_groups; group++) {
1431 for (level = 0; level < XkbKeyGroupWidth(keymap, key, group);
1433 struct xkb_sym_interpret *interp;
1435 i = (group * key->width) + level;
1436 interp = interps[i];
1438 /* Infer default key behaviours from the base level. */
1439 if (group == 0 && level == 0) {
1440 if (!(key->explicit & XkbExplicitAutoRepeatMask) &&
1441 (!interp || (interp->flags & XkbSI_AutoRepeat)))
1442 key->repeats = true;
1448 if ((group == 0 && level == 0) ||
1449 !(interp->match & XkbSI_LevelOneOnly)) {
1450 if (interp->virtual_mod != XkbNoModifier)
1451 vmodmask |= (1 << interp->virtual_mod);
1453 acts[i] = interp->act;
1457 if (!(key->explicit & XkbExplicitVModMapMask))
1458 key->vmodmap = vmodmask;
1465 * This collects a bunch of disparate functions which was done in the server
1466 * at various points that really should've been done within xkbcomp. Turns out
1467 * your actions and types are a lot more useful when any of your modifiers
1468 * other than Shift actually do something ...
1471 UpdateModifiersFromCompat(struct xkb_keymap *keymap)
1473 xkb_mod_index_t vmod;
1474 xkb_group_index_t grp;
1475 xkb_led_index_t led;
1477 struct xkb_key *key;
1478 struct xkb_key_type *type;
1480 /* Find all the interprets for the key and bind them to actions,
1481 * which will also update the vmodmap. */
1482 xkb_foreach_key(key, keymap)
1483 if (!ApplyInterpsToKey(keymap, key))
1486 /* Update keymap->vmods, the virtual -> real mod mapping. */
1487 for (vmod = 0; vmod < XkbNumVirtualMods; vmod++)
1488 keymap->vmods[vmod] = 0;
1490 xkb_foreach_key(key, keymap) {
1494 for (vmod = 0; vmod < XkbNumVirtualMods; vmod++) {
1495 if (!(key->vmodmap & (1 << vmod)))
1497 keymap->vmods[vmod] |= key->modmap;
1501 /* Now update the level masks for all the types to reflect the vmods. */
1502 for (i = 0; i < keymap->num_types; i++) {
1503 type = &keymap->types[i];
1504 type->mods.mask = type->mods.real_mods;
1505 type->mods.mask |= VModsToReal(keymap, type->mods.vmods);
1507 for (j = 0; j < type->num_entries; j++) {
1508 struct xkb_kt_map_entry *entry = &type->map[j];
1510 entry->mods.mask = entry->mods.real_mods;
1511 entry->mods.mask |= VModsToReal(keymap, entry->mods.vmods);
1513 entry->preserve.mask = entry->preserve.real_mods;
1514 entry->preserve.mask |= VModsToReal(keymap, entry->preserve.vmods);
1518 /* Update action modifiers. */
1519 xkb_foreach_key(key, keymap) {
1520 union xkb_action *acts = XkbKeyActionsPtr(keymap, key);
1521 for (i = 0; i < XkbKeyNumActions(key); i++) {
1522 if (acts[i].any.type == XkbSA_NoAction)
1524 UpdateActionMods(keymap, &acts[i], key->modmap);
1528 /* Update group modifiers. */
1529 for (grp = 0; grp < XkbNumKbdGroups; grp++) {
1530 struct xkb_mods *group = &keymap->groups[grp];
1531 group->mask = group->real_mods | VModsToReal(keymap, group->vmods);
1534 /* Update vmod -> indicator maps. */
1535 for (led = 0; led < XkbNumIndicators; led++) {
1536 struct xkb_mods *mods = &keymap->indicators[led].mods;
1537 mods->mask = mods->real_mods | VModsToReal(keymap, mods->vmods);