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"
35 SI_FIELD_VIRTUAL_MOD = (1 << 0),
36 SI_FIELD_ACTION = (1 << 1),
37 SI_FIELD_AUTO_REPEAT = (1 << 2),
38 SI_FIELD_LOCKING_KEY = (1 << 3),
39 SI_FIELD_LEVEL_ONE_ONLY = (1 << 4),
42 typedef struct _SymInterpInfo {
43 enum si_field defined;
45 enum merge_mode merge;
48 struct xkb_sym_interpret interp;
52 LED_FIELD_INDEX = (1 << 0),
53 LED_FIELD_MODS = (1 << 1),
54 LED_FIELD_GROUPS = (1 << 2),
55 LED_FIELD_CTRLS = (1 << 3),
56 LED_FIELD_EXPLICIT = (1 << 4),
57 LED_FIELD_AUTOMATIC = (1 << 5),
58 LED_FIELD_DRIVES_KBD = (1 << 6),
61 typedef struct _LEDInfo {
62 enum led_field defined;
64 enum merge_mode merge;
68 xkb_led_index_t indicator;
70 unsigned char which_mods;
72 unsigned char which_groups;
77 typedef struct _GroupCompatInfo {
79 enum merge_mode merge;
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));
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->ctx, "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->ctx, "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;
154 info->which_mods = 0;
156 info->which_groups = info->groups = 0;
161 InitCompatInfo(CompatInfo *info, struct xkb_keymap *keymap, unsigned file_id)
163 info->keymap = keymap;
165 info->file_id = file_id;
166 info->errorCount = 0;
168 list_init(&info->interps);
170 info->dflt.file_id = file_id;
171 info->dflt.defined = 0;
172 info->dflt.merge = MERGE_OVERRIDE;
173 info->dflt.interp.flags = 0;
174 info->dflt.interp.virtual_mod = XkbNoModifier;
175 memset(&info->dflt.interp.act, 0, sizeof(info->dflt.interp.act));
176 info->dflt.interp.act.type = XkbSA_NoAction;
177 ClearIndicatorMapInfo(keymap->ctx, &info->ledDflt);
178 info->ledDflt.file_id = file_id;
179 info->ledDflt.defined = 0;
180 info->ledDflt.merge = MERGE_OVERRIDE;
181 memset(&info->groupCompat[0], 0,
182 XkbNumKbdGroups * sizeof(GroupCompatInfo));
183 list_init(&info->leds);
184 InitVModInfo(&info->vmods, keymap);
188 ClearCompatInfo(CompatInfo *info)
190 SymInterpInfo *si, *next_si;
191 LEDInfo *led, *next_led;
192 struct xkb_keymap *keymap = info->keymap;
196 info->dflt.defined = 0;
197 info->dflt.merge = MERGE_AUGMENT;
198 info->dflt.interp.flags = 0;
199 info->dflt.interp.virtual_mod = XkbNoModifier;
200 memset(&info->dflt.interp.act, 0, sizeof(info->dflt.interp.act));
201 info->dflt.interp.act.type = XkbSA_NoAction;
202 ClearIndicatorMapInfo(keymap->ctx, &info->ledDflt);
204 list_foreach_safe(si, next_si, &info->interps, entry)
206 memset(&info->groupCompat[0], 0,
207 XkbNumKbdGroups * sizeof(GroupCompatInfo));
208 list_foreach_safe(led, next_led, &info->leds, entry)
210 FreeActionInfo(info->act);
213 ClearVModInfo(&info->vmods, keymap);
216 static SymInterpInfo *
217 NextInterp(CompatInfo * info)
221 si = calloc(1, sizeof(*si));
225 list_append(&si->entry, &info->interps);
231 static SymInterpInfo *
232 FindMatchingInterp(CompatInfo * info, SymInterpInfo * new)
236 list_foreach(old, &info->interps, entry)
237 if (old->interp.sym == new->interp.sym &&
238 old->interp.mods == new->interp.mods &&
239 old->interp.match == new->interp.match)
246 UseNewInterpField(enum si_field field, SymInterpInfo *old, SymInterpInfo *new,
247 int verbosity, enum si_field *collide)
249 if (!(old->defined & field))
252 if (new->defined & field) {
253 if ((old->file_id == new->file_id && verbosity > 0) || verbosity > 9)
256 if (new->merge != MERGE_AUGMENT)
264 AddInterp(CompatInfo * info, SymInterpInfo * new)
266 enum si_field collide;
269 int verbosity = xkb_get_log_verbosity(info->keymap->ctx);
272 old = FindMatchingInterp(info, new);
274 if (new->merge == MERGE_REPLACE) {
276 if ((old->file_id == new->file_id && verbosity > 0) ||
278 log_warn(info->keymap->ctx,
279 "Multiple definitions for \"%s\"; "
280 "Earlier interpretation ignored\n",
287 if (UseNewInterpField(SI_FIELD_VIRTUAL_MOD, old, new, verbosity,
289 old->interp.virtual_mod = new->interp.virtual_mod;
290 old->defined |= SI_FIELD_VIRTUAL_MOD;
292 if (UseNewInterpField(SI_FIELD_ACTION, old, new, verbosity,
294 old->interp.act = new->interp.act;
295 old->defined |= SI_FIELD_ACTION;
297 if (UseNewInterpField(SI_FIELD_AUTO_REPEAT, old, new, verbosity,
299 old->interp.flags &= ~XkbSI_AutoRepeat;
300 old->interp.flags |= (new->interp.flags & XkbSI_AutoRepeat);
301 old->defined |= SI_FIELD_AUTO_REPEAT;
303 if (UseNewInterpField(SI_FIELD_LOCKING_KEY, old, new, verbosity,
305 old->interp.flags &= ~XkbSI_LockingKey;
306 old->interp.flags |= (new->interp.flags & XkbSI_LockingKey);
307 old->defined |= SI_FIELD_LOCKING_KEY;
309 if (UseNewInterpField(SI_FIELD_LEVEL_ONE_ONLY, old, new, verbosity,
311 old->interp.match &= ~XkbSI_LevelOneOnly;
312 old->interp.match |= (new->interp.match & XkbSI_LevelOneOnly);
313 old->defined |= SI_FIELD_LEVEL_ONE_ONLY;
317 log_warn(info->keymap->ctx,
318 "Multiple interpretations of \"%s\"; "
319 "Using %s definition for duplicate fields\n",
321 (new->merge != MERGE_AUGMENT ? "last" : "first"));
328 if ((new = NextInterp(info)) == NULL)
337 AddGroupCompat(CompatInfo *info, xkb_group_index_t group, GroupCompatInfo *new)
340 int verbosity = xkb_get_log_verbosity(info->keymap->ctx);
342 gc = &info->groupCompat[group];
343 if (gc->mods == new->mods)
346 if ((gc->file_id == new->file_id && verbosity > 0) || verbosity > 9)
347 log_warn(info->keymap->ctx,
348 "Compat map for group %u redefined; "
349 "Using %s definition\n",
350 group + 1, (new->merge == MERGE_AUGMENT ? "old" : "new"));
352 if (new->defined && (new->merge != MERGE_AUGMENT || !gc->defined))
358 /***====================================================================***/
361 ResolveStateAndPredicate(ExprDef * expr,
363 xkb_mod_mask_t *mods_rtrn, CompatInfo * info)
366 *pred_rtrn = XkbSI_AnyOfOrNone;
371 *pred_rtrn = XkbSI_Exactly;
372 if (expr->op == EXPR_ACTION_DECL) {
373 const char *pred_txt = xkb_atom_text(info->keymap->ctx,
374 expr->value.action.name);
375 if (istreq(pred_txt, "noneof"))
376 *pred_rtrn = XkbSI_NoneOf;
377 else if (istreq(pred_txt, "anyofornone"))
378 *pred_rtrn = XkbSI_AnyOfOrNone;
379 else if (istreq(pred_txt, "anyof"))
380 *pred_rtrn = XkbSI_AnyOf;
381 else if (istreq(pred_txt, "allof"))
382 *pred_rtrn = XkbSI_AllOf;
383 else if (istreq(pred_txt, "exactly"))
384 *pred_rtrn = XkbSI_Exactly;
386 log_err(info->keymap->ctx,
387 "Illegal modifier predicate \"%s\"; Ignored\n", pred_txt);
390 expr = expr->value.action.args;
392 else if (expr->op == EXPR_IDENT) {
393 const char *pred_txt = xkb_atom_text(info->keymap->ctx,
395 if (pred_txt && istreq(pred_txt, "any")) {
396 *pred_rtrn = XkbSI_AnyOf;
402 return ExprResolveModMask(info->keymap->ctx, expr, mods_rtrn);
405 /***====================================================================***/
408 UseNewLEDField(enum led_field field, LEDInfo *old, LEDInfo *new,
409 int verbosity, enum led_field *collide)
411 if (!(old->defined & field))
414 if (new->defined & field) {
415 if ((old->file_id == new->file_id && verbosity > 0) || verbosity > 9)
418 if (new->merge != MERGE_AUGMENT)
426 AddIndicatorMap(CompatInfo *info, LEDInfo *new)
429 enum led_field collide;
430 struct xkb_context *ctx = info->keymap->ctx;
431 int verbosity = xkb_get_log_verbosity(ctx);
433 list_foreach(old, &info->leds, entry) {
434 if (old->name == new->name) {
435 if ((old->mods == new->mods) &&
436 (old->groups == new->groups) &&
437 (old->ctrls == new->ctrls) &&
438 (old->which_mods == new->which_mods) &&
439 (old->which_groups == new->which_groups)) {
440 old->defined |= new->defined;
444 if (new->merge == MERGE_REPLACE) {
445 struct list entry = old->entry;
446 if ((old->file_id == new->file_id && verbosity > 0) ||
448 log_warn(info->keymap->ctx,
449 "Map for indicator %s redefined; "
450 "Earlier definition ignored\n",
451 xkb_atom_text(ctx, old->name));
458 if (UseNewLEDField(LED_FIELD_INDEX, old, new, verbosity,
460 old->indicator = new->indicator;
461 old->defined |= LED_FIELD_INDEX;
463 if (UseNewLEDField(LED_FIELD_MODS, old, new, verbosity,
465 old->which_mods = new->which_mods;
466 old->mods = new->mods;
467 old->defined |= LED_FIELD_MODS;
469 if (UseNewLEDField(LED_FIELD_GROUPS, old, new, verbosity,
471 old->which_groups = new->which_groups;
472 old->groups = new->groups;
473 old->defined |= LED_FIELD_GROUPS;
475 if (UseNewLEDField(LED_FIELD_CTRLS, old, new, verbosity,
477 old->ctrls = new->ctrls;
478 old->defined |= LED_FIELD_CTRLS;
480 if (UseNewLEDField(LED_FIELD_EXPLICIT, old, new, verbosity,
482 old->flags &= ~XkbIM_NoExplicit;
483 old->flags |= (new->flags & XkbIM_NoExplicit);
484 old->defined |= LED_FIELD_EXPLICIT;
486 if (UseNewLEDField(LED_FIELD_AUTOMATIC, old, new, verbosity,
488 old->flags &= ~XkbIM_NoAutomatic;
489 old->flags |= (new->flags & XkbIM_NoAutomatic);
490 old->defined |= LED_FIELD_AUTOMATIC;
492 if (UseNewLEDField(LED_FIELD_DRIVES_KBD, old, new, verbosity,
494 old->flags &= ~XkbIM_LEDDrivesKB;
495 old->flags |= (new->flags & XkbIM_LEDDrivesKB);
496 old->defined |= LED_FIELD_DRIVES_KBD;
500 log_warn(info->keymap->ctx,
501 "Map for indicator %s redefined; "
502 "Using %s definition for duplicate fields\n",
503 xkb_atom_text(ctx, old->name),
504 (new->merge == MERGE_AUGMENT ? "first" : "last"));
512 old = malloc(sizeof(*old));
514 log_wsgo(info->keymap->ctx,
515 "Couldn't allocate indicator map; "
516 "Map for indicator %s not compiled\n",
517 xkb_atom_text(ctx, new->name));
522 list_append(&old->entry, &info->leds);
528 MergeIncludedCompatMaps(CompatInfo * into, CompatInfo * from,
529 enum merge_mode merge)
532 LEDInfo *led, *next_led;
533 GroupCompatInfo *gcm;
536 if (from->errorCount > 0) {
537 into->errorCount += from->errorCount;
540 if (into->name == NULL) {
541 into->name = from->name;
545 list_foreach(si, &from->interps, entry) {
546 if (merge != MERGE_DEFAULT)
548 if (!AddInterp(into, si))
552 for (i = 0, gcm = &from->groupCompat[0]; i < XkbNumKbdGroups;
554 if (merge != MERGE_DEFAULT)
556 if (!AddGroupCompat(into, i, gcm))
560 list_foreach_safe(led, next_led, &from->leds, entry) {
561 led->merge = (merge == MERGE_DEFAULT ? led->merge : merge);
562 if (!AddIndicatorMap(into, led))
568 HandleCompatMapFile(CompatInfo *info, XkbFile *file, enum merge_mode merge);
571 HandleIncludeCompatMap(CompatInfo *info, IncludeStmt *stmt)
573 enum merge_mode merge = MERGE_DEFAULT;
575 CompatInfo included, next_incl;
577 InitCompatInfo(&included, info->keymap, info->file_id);
580 included.name = stmt->stmt;
584 for (; stmt; stmt = stmt->next_incl) {
585 if (!ProcessIncludeFile(info->keymap->ctx, stmt, FILE_TYPE_COMPAT,
587 info->errorCount += 10;
588 ClearCompatInfo(&included);
592 InitCompatInfo(&next_incl, info->keymap, rtrn->id);
593 next_incl.file_id = rtrn->id;
594 next_incl.dflt = info->dflt;
595 next_incl.dflt.file_id = rtrn->id;
596 next_incl.dflt.merge = merge;
597 next_incl.ledDflt.file_id = rtrn->id;
598 next_incl.ledDflt.merge = merge;
599 next_incl.act = info->act;
601 HandleCompatMapFile(&next_incl, rtrn, MERGE_OVERRIDE);
603 MergeIncludedCompatMaps(&included, &next_incl, merge);
605 next_incl.act = NULL;
607 ClearCompatInfo(&next_incl);
611 MergeIncludedCompatMaps(info, &included, merge);
612 ClearCompatInfo(&included);
614 return (info->errorCount == 0);
617 static const LookupEntry useModMapValues[] = {
626 SetInterpField(CompatInfo *info, SymInterpInfo *si, const char *field,
627 ExprDef *arrayNdx, ExprDef *value)
629 struct xkb_keymap *keymap = info->keymap;
632 if (istreq(field, "action")) {
634 return ReportSINotArray(info, si, field);
636 if (!HandleActionDef(value, keymap, &si->interp.act, info->act))
639 si->defined |= SI_FIELD_ACTION;
641 else if (istreq(field, "virtualmodifier") ||
642 istreq(field, "virtualmod")) {
644 return ReportSINotArray(info, si, field);
646 if (!ResolveVirtualModifier(value, keymap, &ndx, &info->vmods))
647 return ReportSIBadType(info, si, field, "virtual modifier");
649 si->interp.virtual_mod = ndx;
650 si->defined |= SI_FIELD_VIRTUAL_MOD;
652 else if (istreq(field, "repeat")) {
656 return ReportSINotArray(info, si, field);
658 if (!ExprResolveBoolean(keymap->ctx, value, &set))
659 return ReportSIBadType(info, si, field, "boolean");
662 si->interp.flags |= XkbSI_AutoRepeat;
664 si->interp.flags &= ~XkbSI_AutoRepeat;
666 si->defined |= SI_FIELD_AUTO_REPEAT;
668 else if (istreq(field, "locking")) {
672 return ReportSINotArray(info, si, field);
674 if (!ExprResolveBoolean(keymap->ctx, value, &set))
675 return ReportSIBadType(info, si, field, "boolean");
678 si->interp.flags |= XkbSI_LockingKey;
680 si->interp.flags &= ~XkbSI_LockingKey;
682 si->defined |= SI_FIELD_LOCKING_KEY;
684 else if (istreq(field, "usemodmap") ||
685 istreq(field, "usemodmapmods")) {
689 return ReportSINotArray(info, si, field);
691 if (!ExprResolveEnum(keymap->ctx, value, &val, useModMapValues))
692 return ReportSIBadType(info, si, field, "level specification");
695 si->interp.match |= XkbSI_LevelOneOnly;
697 si->interp.match &= ~XkbSI_LevelOneOnly;
699 si->defined |= SI_FIELD_LEVEL_ONE_ONLY;
702 return ReportBadField(keymap, "symbol interpretation", field,
709 static const LookupEntry modComponentNames[] = {
710 {"base", XkbIM_UseBase},
711 {"latched", XkbIM_UseLatched},
712 {"locked", XkbIM_UseLocked},
713 {"effective", XkbIM_UseEffective},
714 {"compat", XkbIM_UseCompat},
715 {"any", XkbIM_UseAnyMods},
719 static const LookupEntry groupComponentNames[] = {
720 {"base", XkbIM_UseBase},
721 {"latched", XkbIM_UseLatched},
722 {"locked", XkbIM_UseLocked},
723 {"effective", XkbIM_UseEffective},
724 {"any", XkbIM_UseAnyGroup},
729 static const LookupEntry groupNames[] = {
744 SetIndicatorMapField(CompatInfo *info, LEDInfo *led,
745 const char *field, ExprDef *arrayNdx, ExprDef *value)
748 struct xkb_keymap *keymap = info->keymap;
750 if (istreq(field, "modifiers") || istreq(field, "mods")) {
752 return ReportIndicatorNotArray(info, led, field);
754 if (!ExprResolveVModMask(keymap, value, &led->mods))
755 return ReportIndicatorBadType(info, led, field, "modifier mask");
757 led->defined |= LED_FIELD_MODS;
759 else if (istreq(field, "groups")) {
763 return ReportIndicatorNotArray(info, led, field);
765 if (!ExprResolveMask(keymap->ctx, value, &mask, groupNames))
766 return ReportIndicatorBadType(info, led, field, "group mask");
769 led->defined |= LED_FIELD_GROUPS;
771 else if (istreq(field, "controls") || istreq(field, "ctrls")) {
775 return ReportIndicatorNotArray(info, led, field);
777 if (!ExprResolveMask(keymap->ctx, value, &mask, ctrlNames))
778 return ReportIndicatorBadType(info, led, field,
782 led->defined |= LED_FIELD_CTRLS;
784 else if (istreq(field, "allowexplicit")) {
788 return ReportIndicatorNotArray(info, led, field);
790 if (!ExprResolveBoolean(keymap->ctx, value, &set))
791 return ReportIndicatorBadType(info, led, field, "boolean");
794 led->flags &= ~XkbIM_NoExplicit;
796 led->flags |= XkbIM_NoExplicit;
798 led->defined |= LED_FIELD_EXPLICIT;
800 else if (istreq(field, "whichmodstate") ||
801 istreq(field, "whichmodifierstate")) {
805 return ReportIndicatorNotArray(info, led, field);
807 if (!ExprResolveMask(keymap->ctx, value, &mask, modComponentNames))
808 return ReportIndicatorBadType(info, led, field,
809 "mask of modifier state components");
811 led->which_mods = mask;
813 else if (istreq(field, "whichgroupstate")) {
817 return ReportIndicatorNotArray(info, led, field);
819 if (!ExprResolveMask(keymap->ctx, value, &mask, groupComponentNames))
820 return ReportIndicatorBadType(info, led, field,
821 "mask of group state components");
823 led->which_groups = mask;
825 else if (istreq(field, "driveskbd") ||
826 istreq(field, "driveskeyboard") ||
827 istreq(field, "leddriveskbd") ||
828 istreq(field, "leddriveskeyboard") ||
829 istreq(field, "indicatordriveskbd") ||
830 istreq(field, "indicatordriveskeyboard")) {
834 return ReportIndicatorNotArray(info, led, field);
836 if (!ExprResolveBoolean(keymap->ctx, value, &set))
837 return ReportIndicatorBadType(info, led, field, "boolean");
840 led->flags |= XkbIM_LEDDrivesKB;
842 led->flags &= ~XkbIM_LEDDrivesKB;
844 led->defined |= LED_FIELD_DRIVES_KBD;
846 else if (istreq(field, "index")) {
850 return ReportIndicatorNotArray(info, led, field);
852 if (!ExprResolveInteger(keymap->ctx, value, &ndx))
853 return ReportIndicatorBadType(info, led, field,
856 if (ndx < 1 || ndx > 32) {
857 log_err(info->keymap->ctx,
858 "Illegal indicator index %d (range 1..%d); "
859 "Index definition for %s indicator ignored\n",
860 ndx, XkbNumIndicators,
861 xkb_atom_text(keymap->ctx, led->name));
865 led->indicator = (xkb_led_index_t) ndx;
866 led->defined |= LED_FIELD_INDEX;
869 log_err(info->keymap->ctx,
870 "Unknown field %s in map for %s indicator; "
871 "Definition ignored\n",
872 field, xkb_atom_text(keymap->ctx, led->name));
880 HandleInterpVar(CompatInfo *info, VarDef *stmt)
882 const char *elem, *field;
886 if (!ExprResolveLhs(info->keymap->ctx, stmt->name, &elem, &field, &ndx))
887 ret = 0; /* internal error, already reported */
888 else if (elem && istreq(elem, "interpret"))
889 ret = SetInterpField(info, &info->dflt, field, ndx, stmt->value);
890 else if (elem && istreq(elem, "indicator"))
891 ret = SetIndicatorMapField(info, &info->ledDflt, field, ndx,
894 ret = SetActionField(info->keymap, elem, field, ndx, stmt->value,
900 HandleInterpBody(CompatInfo *info, VarDef *def, SymInterpInfo *si)
903 const char *elem, *field;
906 for (; def != NULL; def = (VarDef *) def->common.next) {
907 if (def->name && def->name->op == EXPR_FIELD_REF) {
908 ok = HandleInterpVar(info, def);
911 ok = ExprResolveLhs(info->keymap->ctx, def->name, &elem, &field,
914 ok = SetInterpField(info, si, field, arrayNdx, def->value);
921 HandleInterpDef(CompatInfo *info, InterpDef *def, enum merge_mode merge)
926 if (!ResolveStateAndPredicate(def->match, &pred, &mods, info)) {
927 log_err(info->keymap->ctx,
928 "Couldn't determine matching modifiers; "
929 "Symbol interpretation ignored\n");
932 if (def->merge != MERGE_DEFAULT)
937 if (!LookupKeysym(def->sym, &si.interp.sym)) {
938 log_err(info->keymap->ctx,
939 "Could not resolve keysym %s; "
940 "Symbol interpretation ignored\n",
944 si.interp.match = pred & XkbSI_OpMask;
945 si.interp.mods = mods;
946 if (!HandleInterpBody(info, def->def, &si)) {
951 if (!AddInterp(info, &si)) {
959 HandleGroupCompatDef(CompatInfo *info, GroupCompatDef *def,
960 enum merge_mode merge)
964 merge = (def->merge == MERGE_DEFAULT ? merge : def->merge);
966 if (def->group < 1 || def->group > XkbNumKbdGroups) {
967 log_err(info->keymap->ctx,
968 "Keyboard group must be in the range 1..%u; "
969 "Compatibility map for illegal group %u ignored\n",
970 XkbNumKbdGroups, def->group);
974 tmp.file_id = info->file_id;
977 if (!ExprResolveVModMask(info->keymap, def->def, &tmp.mods)) {
978 log_err(info->keymap->ctx,
979 "Expected a modifier mask in group compatibility definition; "
980 "Ignoring illegal compatibility map for group %u\n",
986 return AddGroupCompat(info, def->group - 1, &tmp);
990 HandleIndicatorMapDef(CompatInfo *info, IndicatorMapDef *def,
991 enum merge_mode merge)
997 if (def->merge != MERGE_DEFAULT)
1000 led = info->ledDflt;
1002 led.name = def->name;
1005 for (var = def->body; var != NULL; var = (VarDef *) var->common.next) {
1006 const char *elem, *field;
1008 if (!ExprResolveLhs(info->keymap->ctx, var->name, &elem, &field,
1015 log_err(info->keymap->ctx,
1016 "Cannot set defaults for \"%s\" element in indicator map; "
1017 "Assignment to %s.%s ignored\n", elem, elem, field);
1021 ok = SetIndicatorMapField(info, &led, field, arrayNdx,
1027 return AddIndicatorMap(info, &led);
1033 HandleCompatMapFile(CompatInfo *info, XkbFile *file, enum merge_mode merge)
1038 merge = (merge == MERGE_DEFAULT ? MERGE_AUGMENT : merge);
1041 info->name = strdup_safe(file->name);
1043 for (stmt = file->defs; stmt; stmt = stmt->next) {
1044 switch (stmt->type) {
1046 ok = HandleIncludeCompatMap(info, (IncludeStmt *) stmt);
1049 ok = HandleInterpDef(info, (InterpDef *) stmt, merge);
1051 case STMT_GROUP_COMPAT:
1052 ok = HandleGroupCompatDef(info, (GroupCompatDef *) stmt, merge);
1054 case STMT_INDICATOR_MAP:
1055 ok = HandleIndicatorMapDef(info, (IndicatorMapDef *) stmt, merge);
1058 ok = HandleInterpVar(info, (VarDef *) stmt);
1061 ok = HandleVModDef((VModDef *) stmt, info->keymap, merge,
1065 log_err(info->keymap->ctx,
1066 "Interpretation files may not include other types; "
1067 "Ignoring %s\n", StmtTypeToString(stmt->type));
1075 if (info->errorCount > 10) {
1076 log_err(info->keymap->ctx,
1077 "Abandoning compatibility map \"%s\"\n", file->topName);
1084 CopyInterps(CompatInfo *info, bool needSymbol, unsigned pred)
1088 list_foreach(si, &info->interps, entry) {
1089 if (((si->interp.match & XkbSI_OpMask) != pred) ||
1090 (needSymbol && si->interp.sym == XKB_KEY_NoSymbol) ||
1091 (!needSymbol && si->interp.sym != XKB_KEY_NoSymbol))
1094 darray_append(info->keymap->sym_interpret, si->interp);
1099 BindIndicators(CompatInfo *info, struct list *unbound_leds)
1102 LEDInfo *led, *next_led;
1103 struct xkb_indicator_map *map;
1104 struct xkb_keymap *keymap = info->keymap;
1106 list_foreach(led, unbound_leds, entry) {
1107 if (led->indicator == XKB_LED_INVALID) {
1108 for (i = 0; i < XkbNumIndicators; i++) {
1109 if (keymap->indicator_names[i] &&
1110 streq(keymap->indicator_names[i],
1111 xkb_atom_text(keymap->ctx, led->name))) {
1112 led->indicator = i + 1;
1119 list_foreach(led, unbound_leds, entry) {
1120 if (led->indicator == XKB_LED_INVALID) {
1121 for (i = 0; i < XkbNumIndicators; i++) {
1122 if (keymap->indicator_names[i] == NULL) {
1123 keymap->indicator_names[i] =
1124 xkb_atom_text(keymap->ctx, led->name);
1125 led->indicator = i + 1;
1130 if (led->indicator == XKB_LED_INVALID) {
1131 log_err(info->keymap->ctx,
1132 "No unnamed indicators found; "
1133 "Virtual indicator map \"%s\" not bound\n",
1134 xkb_atom_text(keymap->ctx, led->name));
1140 list_foreach_safe(led, next_led, unbound_leds, entry) {
1141 if (led->indicator == XKB_LED_INVALID) {
1146 if (!streq(keymap->indicator_names[led->indicator - 1],
1147 xkb_atom_text(keymap->ctx, led->name))) {
1148 const char *old = keymap->indicator_names[led->indicator - 1];
1149 log_err(info->keymap->ctx,
1150 "Multiple names bound to indicator %d; "
1151 "Using %s, ignoring %s\n",
1152 led->indicator, old,
1153 xkb_atom_text(keymap->ctx, led->name));
1158 map = &keymap->indicators[led->indicator - 1];
1159 map->flags = led->flags;
1160 map->which_groups = led->which_groups;
1161 map->groups = led->groups;
1162 map->which_mods = led->which_mods;
1163 map->mods.mods = led->mods;
1164 map->ctrls = led->ctrls;
1168 list_init(unbound_leds);
1172 CopyIndicatorMapDefs(CompatInfo *info)
1174 LEDInfo *led, *next_led;
1175 struct list unbound_leds;
1176 struct xkb_indicator_map *im;
1177 struct xkb_keymap *keymap = info->keymap;
1179 list_init(&unbound_leds);
1181 list_foreach_safe(led, next_led, &info->leds, entry) {
1182 if (led->groups != 0 && led->which_groups == 0)
1183 led->which_groups = XkbIM_UseEffective;
1185 if (led->which_mods == 0 && led->mods)
1186 led->which_mods = XkbIM_UseEffective;
1188 if (led->indicator == XKB_LED_INVALID) {
1189 list_append(&led->entry, &unbound_leds);
1193 im = &keymap->indicators[led->indicator - 1];
1194 im->flags = led->flags;
1195 im->which_groups = led->which_groups;
1196 im->groups = led->groups;
1197 im->which_mods = led->which_mods;
1198 im->mods.mods = led->mods;
1199 im->ctrls = led->ctrls;
1200 keymap->indicator_names[led->indicator - 1] =
1201 xkb_atom_text(keymap->ctx, led->name);
1204 list_init(&info->leds);
1206 BindIndicators(info, &unbound_leds);
1212 CompileCompatMap(XkbFile *file, struct xkb_keymap *keymap,
1213 enum merge_mode merge)
1215 xkb_group_index_t i;
1217 GroupCompatInfo *gcm;
1219 InitCompatInfo(&info, keymap, file->id);
1220 info.dflt.merge = merge;
1221 info.ledDflt.merge = merge;
1223 HandleCompatMapFile(&info, file, merge);
1225 if (info.errorCount != 0)
1228 darray_init(keymap->sym_interpret);
1229 darray_growalloc(keymap->sym_interpret, info.nInterps);
1232 keymap->compat_section_name = strdup(info.name);
1234 if (info.nInterps > 0) {
1235 CopyInterps(&info, true, XkbSI_Exactly);
1236 CopyInterps(&info, true, XkbSI_AllOf | XkbSI_NoneOf);
1237 CopyInterps(&info, true, XkbSI_AnyOf);
1238 CopyInterps(&info, true, XkbSI_AnyOfOrNone);
1239 CopyInterps(&info, false, XkbSI_Exactly);
1240 CopyInterps(&info, false, XkbSI_AllOf | XkbSI_NoneOf);
1241 CopyInterps(&info, false, XkbSI_AnyOf);
1242 CopyInterps(&info, false, XkbSI_AnyOfOrNone);
1245 for (i = 0, gcm = &info.groupCompat[0]; i < XkbNumKbdGroups;
1247 if (gcm->file_id != 0 || gcm->mods != 0)
1248 keymap->groups[i].mods = gcm->mods;
1251 if (!CopyIndicatorMapDefs(&info))
1254 ClearCompatInfo(&info);
1258 ClearCompatInfo(&info);
1263 ComputeEffectiveMask(struct xkb_keymap *keymap, struct xkb_mods *mods)
1266 xkb_mod_mask_t vmask = mods->mods >> XkbNumModifiers;
1268 /* The effective mask is only real mods for now. */
1269 mods->mask = mods->mods & 0xff;
1271 for (i = 0; i < XkbNumVirtualMods; i++) {
1272 if (!(vmask & (1 << i)))
1274 mods->mask |= keymap->vmods[i];
1279 UpdateActionMods(struct xkb_keymap *keymap, union xkb_action *act,
1280 xkb_mod_mask_t rmodmask)
1283 struct xkb_mods *mods;
1285 switch (act->type) {
1287 case XkbSA_LatchMods:
1288 case XkbSA_LockMods:
1289 flags = act->mods.flags;
1290 mods = &act->mods.mods;
1294 flags = act->iso.flags;
1295 mods = &act->iso.mods;
1302 if (flags & XkbSA_UseModMapMods) {
1303 /* XXX: what's that. */
1305 mods->mods |= rmodmask;
1307 ComputeEffectiveMask(keymap, mods);
1311 * Find an interpretation which applies to this particular level, either by
1312 * finding an exact match for the symbol and modifier combination, or a
1313 * generic XKB_KEY_NoSymbol match.
1315 static struct xkb_sym_interpret *
1316 FindInterpForKey(struct xkb_keymap *keymap, struct xkb_key *key,
1317 xkb_group_index_t group, xkb_level_index_t level)
1319 struct xkb_sym_interpret *ret = NULL;
1320 struct xkb_sym_interpret *interp;
1321 const xkb_keysym_t *syms;
1324 num_syms = xkb_key_get_syms_by_level(keymap, key, group, level, &syms);
1328 darray_foreach(interp, keymap->sym_interpret) {
1332 if ((num_syms > 1 || interp->sym != syms[0]) &&
1333 interp->sym != XKB_KEY_NoSymbol)
1336 if (level == 0 || !(interp->match & XkbSI_LevelOneOnly))
1341 switch (interp->match & XkbSI_OpMask) {
1343 found = !(interp->mods & mods);
1345 case XkbSI_AnyOfOrNone:
1346 found = (!mods || (interp->mods & mods));
1349 found = !!(interp->mods & mods);
1352 found = ((interp->mods & mods) == interp->mods);
1355 found = (interp->mods == mods);
1362 if (found && interp->sym != XKB_KEY_NoSymbol)
1364 else if (found && !ret)
1374 ApplyInterpsToKey(struct xkb_keymap *keymap, struct xkb_key *key)
1376 #define INTERP_SIZE (8 * 4)
1377 struct xkb_sym_interpret *interps[INTERP_SIZE];
1378 xkb_mod_mask_t vmodmask = 0;
1380 xkb_group_index_t group;
1381 xkb_level_index_t level;
1384 /* If we've been told not to bind interps to this key, then don't. */
1385 if (key->explicit & XkbExplicitInterpretMask)
1388 for (i = 0; i < INTERP_SIZE; i++)
1391 for (group = 0; group < key->num_groups; group++) {
1392 for (level = 0; level < XkbKeyGroupWidth(keymap, key, group);
1394 i = (group * key->width) + level;
1395 if (i >= INTERP_SIZE) /* XXX FIXME */
1397 interps[i] = FindInterpForKey(keymap, key, group, level);
1403 if (num_acts && !key->actions) {
1404 key->actions = calloc(key->num_groups * key->width,
1405 sizeof(*key->actions));
1410 for (group = 0; group < key->num_groups; group++) {
1411 for (level = 0; level < XkbKeyGroupWidth(keymap, key, group);
1413 struct xkb_sym_interpret *interp;
1415 i = (group * key->width) + level;
1416 interp = interps[i];
1418 /* Infer default key behaviours from the base level. */
1419 if (group == 0 && level == 0) {
1420 if (!(key->explicit & XkbExplicitAutoRepeatMask) &&
1421 (!interp || (interp->flags & XkbSI_AutoRepeat)))
1422 key->repeats = true;
1428 if ((group == 0 && level == 0) ||
1429 !(interp->match & XkbSI_LevelOneOnly)) {
1430 if (interp->virtual_mod != XkbNoModifier)
1431 vmodmask |= (1 << interp->virtual_mod);
1434 key->actions[i] = interp->act;
1438 if (!(key->explicit & XkbExplicitVModMapMask))
1439 key->vmodmap = vmodmask;
1446 * This collects a bunch of disparate functions which was done in the server
1447 * at various points that really should've been done within xkbcomp. Turns out
1448 * your actions and types are a lot more useful when any of your modifiers
1449 * other than Shift actually do something ...
1452 UpdateModifiersFromCompat(struct xkb_keymap *keymap)
1454 xkb_mod_index_t vmod;
1455 xkb_group_index_t grp;
1456 xkb_led_index_t led;
1458 struct xkb_key *key;
1460 /* Find all the interprets for the key and bind them to actions,
1461 * which will also update the vmodmap. */
1462 xkb_foreach_key(key, keymap)
1463 if (!ApplyInterpsToKey(keymap, key))
1466 /* Update keymap->vmods, the virtual -> real mod mapping. */
1467 for (vmod = 0; vmod < XkbNumVirtualMods; vmod++)
1468 keymap->vmods[vmod] = 0;
1470 xkb_foreach_key(key, keymap) {
1474 for (vmod = 0; vmod < XkbNumVirtualMods; vmod++) {
1475 if (!(key->vmodmap & (1 << vmod)))
1477 keymap->vmods[vmod] |= key->modmap;
1481 /* Now update the level masks for all the types to reflect the vmods. */
1482 for (i = 0; i < keymap->num_types; i++) {
1483 ComputeEffectiveMask(keymap, &keymap->types[i].mods);
1485 for (j = 0; j < keymap->types[i].num_entries; j++) {
1486 ComputeEffectiveMask(keymap, &keymap->types[i].map[j].mods);
1487 ComputeEffectiveMask(keymap, &keymap->types[i].map[j].preserve);
1491 /* Update action modifiers. */
1492 xkb_foreach_key(key, keymap) {
1496 for (i = 0; i < key->num_groups * key->width; i++)
1497 UpdateActionMods(keymap, &key->actions[i], key->modmap);
1500 /* Update group modifiers. */
1501 for (grp = 0; grp < XkbNumKbdGroups; grp++)
1502 ComputeEffectiveMask(keymap, &keymap->groups[grp]);
1504 /* Update vmod -> indicator maps. */
1505 for (led = 0; led < XkbNumIndicators; led++)
1506 ComputeEffectiveMask(keymap, &keymap->indicators[led].mods);