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 * The xkb_compat section
36 * =====================
37 * This section is the third to be processesed, after xkb_keycodes and
40 * Interpret statements
41 * --------------------
42 * Statements of the form:
43 * interpret Num_Lock+Any { ... }
45 * The body of the statment may include statements of the following
49 * action = LockMods(modifiers=NumLock);
51 * - virtual modifier statement:
52 * virtualModifier = NumLock;
57 * - useModMapMods statement:
58 * useModMapMods = level1;
60 * Indicator map statements
61 * ------------------------
62 * Statements of the form:
63 * indicator "Shift Lock" { ... }
65 * This statement specifies the behavior and binding of the indicator
66 * with the given name ("Shift Lock" above). The name should have been
67 * declared previously in the xkb_keycodes section (see Indicator name
68 * statement), and given an index there. If it wasn't, it is created
69 * with the next free index.
70 * The body of the statement describes the conditions of the keyboard
71 * state which will cause the indicator to be lit. It may include the
72 * following statements:
74 * - modifiers statment:
75 * modifiers = ScrollLock;
77 * If the given modifiers are in the required state (see below), the
80 * - whichModifierState statment:
81 * whichModState = Latched + Locked;
83 * Can be any combination of:
84 * base, latched, locked, effective
85 * any (i.e. all of the above)
86 * none (i.e. none of the above)
87 * compat (this is legal, but unused)
88 * This will cause the respective portion of the modifer state (see
89 * struct xkb_state) to be matched against the modifiers given in the
90 * "modifiers" statement.
92 * Here's a simple example:
93 * indicator "Num Lock" {
94 * modifiers = NumLock;
95 * whichModState = Locked;
97 * Whenever the NumLock modifier is locked, the Num Lock indicator
101 * groups = All - group1;
103 * If the given groups are in the required state (see below), the led
106 * - whichGroupState statment:
107 * whichGroupState = Effective;
109 * Can be any combination of:
110 * base, latched, locked, effective
111 * any (i.e. all of the above)
112 * none (i.e. none of the above)
113 * This will cause the respective portion of the group state (see
114 * struct xkb_state) to be matched against the groups given in the
115 * "groups" statement.
117 * Note: the above conditions are disjunctive, i.e. if any of them are
118 * satisfied the led is lit.
120 * Virtual modifier statements
121 * ---------------------------
122 * Statements of the form:
123 * virtual_modifiers LControl;
125 * Can appear in the xkb_types, xkb_compat, xkb_symbols sections.
130 * After all of the xkb_compat sections have been compiled, the following
131 * members of struct xkb_keymap are finalized:
132 * darray(struct xkb_sym_interpret) sym_interpret;
133 * struct xkb_indicator_map indicators[XkbNumIndicators];
134 * char *compat_section_name;
135 * TODO: virtual modifiers.
139 SI_FIELD_VIRTUAL_MOD = (1 << 0),
140 SI_FIELD_ACTION = (1 << 1),
141 SI_FIELD_AUTO_REPEAT = (1 << 2),
142 SI_FIELD_LEVEL_ONE_ONLY = (1 << 3),
145 typedef struct _SymInterpInfo {
146 enum si_field defined;
148 enum merge_mode merge;
151 struct xkb_sym_interpret interp;
155 LED_FIELD_MODS = (1 << 0),
156 LED_FIELD_GROUPS = (1 << 1),
157 LED_FIELD_CTRLS = (1 << 2),
158 LED_FIELD_EXPLICIT = (1 << 3),
161 typedef struct _LEDInfo {
162 enum led_field defined;
164 enum merge_mode merge;
168 unsigned char which_mods;
170 unsigned char which_groups;
175 typedef struct _CompatInfo {
183 darray(LEDInfo) leds;
186 struct xkb_keymap *keymap;
190 siText(SymInterpInfo *si, CompatInfo *info)
192 static char buf[128];
194 if (si == &info->dflt)
197 snprintf(buf, sizeof(buf), "%s+%s(%s)",
198 KeysymText(si->interp.sym),
199 SIMatchText(si->interp.match),
200 ModMaskText(si->interp.mods));
205 ReportSINotArray(CompatInfo *info, SymInterpInfo *si, const char *field)
207 return ReportNotArray(info->keymap, "symbol interpretation", field,
212 ReportSIBadType(CompatInfo *info, SymInterpInfo *si, const char *field,
215 return ReportBadType(info->keymap->ctx, "symbol interpretation", field,
216 siText(si, info), wanted);
220 ReportIndicatorBadType(CompatInfo *info, LEDInfo *led,
221 const char *field, const char *wanted)
223 return ReportBadType(info->keymap->ctx, "indicator map", field,
224 xkb_atom_text(info->keymap->ctx, led->name),
229 ReportIndicatorNotArray(CompatInfo *info, LEDInfo *led,
232 return ReportNotArray(info->keymap, "indicator map", field,
233 xkb_atom_text(info->keymap->ctx, led->name));
237 ClearIndicatorMapInfo(struct xkb_context *ctx, LEDInfo *info)
239 info->name = xkb_atom_intern(ctx, "default");
241 info->which_mods = 0;
243 info->which_groups = info->groups = 0;
248 InitCompatInfo(CompatInfo *info, struct xkb_keymap *keymap, unsigned file_id)
250 info->keymap = keymap;
252 info->file_id = file_id;
253 info->errorCount = 0;
255 list_init(&info->interps);
257 info->dflt.file_id = file_id;
258 info->dflt.defined = 0;
259 info->dflt.merge = MERGE_OVERRIDE;
260 info->dflt.interp.flags = 0;
261 info->dflt.interp.virtual_mod = XkbNoModifier;
262 memset(&info->dflt.interp.act, 0, sizeof(info->dflt.interp.act));
263 info->dflt.interp.act.type = XkbSA_NoAction;
264 ClearIndicatorMapInfo(keymap->ctx, &info->ledDflt);
265 info->ledDflt.file_id = file_id;
266 info->ledDflt.defined = 0;
267 info->ledDflt.merge = MERGE_OVERRIDE;
268 darray_init(info->leds);
269 InitVModInfo(&info->vmods, keymap);
273 ClearCompatInfo(CompatInfo *info)
275 SymInterpInfo *si, *next_si;
276 struct xkb_keymap *keymap = info->keymap;
280 info->dflt.defined = 0;
281 info->dflt.merge = MERGE_AUGMENT;
282 info->dflt.interp.flags = 0;
283 info->dflt.interp.virtual_mod = XkbNoModifier;
284 memset(&info->dflt.interp.act, 0, sizeof(info->dflt.interp.act));
285 info->dflt.interp.act.type = XkbSA_NoAction;
286 ClearIndicatorMapInfo(keymap->ctx, &info->ledDflt);
288 list_foreach_safe(si, next_si, &info->interps, entry)
290 darray_free(info->leds);
291 FreeActionInfo(info->act);
294 ClearVModInfo(&info->vmods, keymap);
297 static SymInterpInfo *
298 NextInterp(CompatInfo *info)
302 si = calloc(1, sizeof(*si));
306 list_append(&si->entry, &info->interps);
312 static SymInterpInfo *
313 FindMatchingInterp(CompatInfo *info, SymInterpInfo *new)
317 list_foreach(old, &info->interps, entry)
318 if (old->interp.sym == new->interp.sym &&
319 old->interp.mods == new->interp.mods &&
320 old->interp.match == new->interp.match)
327 UseNewInterpField(enum si_field field, SymInterpInfo *old, SymInterpInfo *new,
328 int verbosity, enum si_field *collide)
330 if (!(old->defined & field))
333 if (new->defined & field) {
334 if ((old->file_id == new->file_id && verbosity > 0) || verbosity > 9)
337 if (new->merge != MERGE_AUGMENT)
345 AddInterp(CompatInfo *info, SymInterpInfo *new)
347 enum si_field collide;
350 int verbosity = xkb_get_log_verbosity(info->keymap->ctx);
353 old = FindMatchingInterp(info, new);
355 if (new->merge == MERGE_REPLACE) {
357 if ((old->file_id == new->file_id && verbosity > 0) ||
359 log_warn(info->keymap->ctx,
360 "Multiple definitions for \"%s\"; "
361 "Earlier interpretation ignored\n",
368 if (UseNewInterpField(SI_FIELD_VIRTUAL_MOD, old, new, verbosity,
370 old->interp.virtual_mod = new->interp.virtual_mod;
371 old->defined |= SI_FIELD_VIRTUAL_MOD;
373 if (UseNewInterpField(SI_FIELD_ACTION, old, new, verbosity,
375 old->interp.act = new->interp.act;
376 old->defined |= SI_FIELD_ACTION;
378 if (UseNewInterpField(SI_FIELD_AUTO_REPEAT, old, new, verbosity,
380 old->interp.flags &= ~XkbSI_AutoRepeat;
381 old->interp.flags |= (new->interp.flags & XkbSI_AutoRepeat);
382 old->defined |= SI_FIELD_AUTO_REPEAT;
384 if (UseNewInterpField(SI_FIELD_LEVEL_ONE_ONLY, old, new, verbosity,
386 old->interp.match &= ~XkbSI_LevelOneOnly;
387 old->interp.match |= (new->interp.match & XkbSI_LevelOneOnly);
388 old->defined |= SI_FIELD_LEVEL_ONE_ONLY;
392 log_warn(info->keymap->ctx,
393 "Multiple interpretations of \"%s\"; "
394 "Using %s definition for duplicate fields\n",
396 (new->merge != MERGE_AUGMENT ? "last" : "first"));
403 new = NextInterp(info);
413 /***====================================================================***/
416 ResolveStateAndPredicate(ExprDef *expr, unsigned *pred_rtrn,
417 xkb_mod_mask_t *mods_rtrn, CompatInfo *info)
420 *pred_rtrn = XkbSI_AnyOfOrNone;
425 *pred_rtrn = XkbSI_Exactly;
426 if (expr->op == EXPR_ACTION_DECL) {
427 const char *pred_txt = xkb_atom_text(info->keymap->ctx,
428 expr->value.action.name);
429 if (istreq(pred_txt, "noneof"))
430 *pred_rtrn = XkbSI_NoneOf;
431 else if (istreq(pred_txt, "anyofornone"))
432 *pred_rtrn = XkbSI_AnyOfOrNone;
433 else if (istreq(pred_txt, "anyof"))
434 *pred_rtrn = XkbSI_AnyOf;
435 else if (istreq(pred_txt, "allof"))
436 *pred_rtrn = XkbSI_AllOf;
437 else if (istreq(pred_txt, "exactly"))
438 *pred_rtrn = XkbSI_Exactly;
440 log_err(info->keymap->ctx,
441 "Illegal modifier predicate \"%s\"; Ignored\n", pred_txt);
444 expr = expr->value.action.args;
446 else if (expr->op == EXPR_IDENT) {
447 const char *pred_txt = xkb_atom_text(info->keymap->ctx,
449 if (pred_txt && istreq(pred_txt, "any")) {
450 *pred_rtrn = XkbSI_AnyOf;
456 return ExprResolveModMask(info->keymap->ctx, expr, mods_rtrn);
459 /***====================================================================***/
462 UseNewLEDField(enum led_field field, LEDInfo *old, LEDInfo *new,
463 int verbosity, enum led_field *collide)
465 if (!(old->defined & field))
468 if (new->defined & field) {
469 if ((old->file_id == new->file_id && verbosity > 0) || verbosity > 9)
472 if (new->merge != MERGE_AUGMENT)
480 AddIndicatorMap(CompatInfo *info, LEDInfo *new)
483 enum led_field collide;
484 struct xkb_context *ctx = info->keymap->ctx;
485 int verbosity = xkb_get_log_verbosity(ctx);
487 darray_foreach(old, info->leds) {
488 if (old->name != new->name)
491 if (old->mods == new->mods &&
492 old->groups == new->groups &&
493 old->ctrls == new->ctrls &&
494 old->which_mods == new->which_mods &&
495 old->which_groups == new->which_groups) {
496 old->defined |= new->defined;
500 if (new->merge == MERGE_REPLACE) {
501 if ((old->file_id == new->file_id && verbosity > 0) ||
503 log_warn(info->keymap->ctx,
504 "Map for indicator %s redefined; "
505 "Earlier definition ignored\n",
506 xkb_atom_text(ctx, old->name));
512 if (UseNewLEDField(LED_FIELD_MODS, old, new, verbosity,
514 old->which_mods = new->which_mods;
515 old->mods = new->mods;
516 old->defined |= LED_FIELD_MODS;
518 if (UseNewLEDField(LED_FIELD_GROUPS, old, new, verbosity,
520 old->which_groups = new->which_groups;
521 old->groups = new->groups;
522 old->defined |= LED_FIELD_GROUPS;
524 if (UseNewLEDField(LED_FIELD_CTRLS, old, new, verbosity,
526 old->ctrls = new->ctrls;
527 old->defined |= LED_FIELD_CTRLS;
529 if (UseNewLEDField(LED_FIELD_EXPLICIT, old, new, verbosity,
531 old->flags &= ~XkbIM_NoExplicit;
532 old->flags |= (new->flags & XkbIM_NoExplicit);
533 old->defined |= LED_FIELD_EXPLICIT;
537 log_warn(info->keymap->ctx,
538 "Map for indicator %s redefined; "
539 "Using %s definition for duplicate fields\n",
540 xkb_atom_text(ctx, old->name),
541 (new->merge == MERGE_AUGMENT ? "first" : "last"));
547 darray_append(info->leds, *new);
552 MergeIncludedCompatMaps(CompatInfo *into, CompatInfo *from,
553 enum merge_mode merge)
555 SymInterpInfo *si, *next_si;
558 if (from->errorCount > 0) {
559 into->errorCount += from->errorCount;
563 if (into->name == NULL) {
564 into->name = from->name;
568 list_foreach_safe(si, next_si, &from->interps, entry) {
569 si->merge = (merge == MERGE_DEFAULT ? si->merge : merge);
570 if (!AddInterp(into, si))
574 darray_foreach(led, from->leds) {
575 led->merge = (merge == MERGE_DEFAULT ? led->merge : merge);
576 if (!AddIndicatorMap(into, led))
582 HandleCompatMapFile(CompatInfo *info, XkbFile *file, enum merge_mode merge);
585 HandleIncludeCompatMap(CompatInfo *info, IncludeStmt *stmt)
587 enum merge_mode merge = MERGE_DEFAULT;
589 CompatInfo included, next_incl;
591 InitCompatInfo(&included, info->keymap, info->file_id);
594 included.name = stmt->stmt;
598 for (; stmt; stmt = stmt->next_incl) {
599 if (!ProcessIncludeFile(info->keymap->ctx, stmt, FILE_TYPE_COMPAT,
601 info->errorCount += 10;
602 ClearCompatInfo(&included);
606 InitCompatInfo(&next_incl, info->keymap, rtrn->id);
607 next_incl.file_id = rtrn->id;
608 next_incl.dflt = info->dflt;
609 next_incl.dflt.file_id = rtrn->id;
610 next_incl.dflt.merge = merge;
611 next_incl.ledDflt.file_id = rtrn->id;
612 next_incl.ledDflt.merge = merge;
613 next_incl.act = info->act;
615 HandleCompatMapFile(&next_incl, rtrn, MERGE_OVERRIDE);
617 MergeIncludedCompatMaps(&included, &next_incl, merge);
619 next_incl.act = NULL;
621 ClearCompatInfo(&next_incl);
625 MergeIncludedCompatMaps(info, &included, merge);
626 ClearCompatInfo(&included);
628 return (info->errorCount == 0);
631 static const LookupEntry useModMapValues[] = {
640 SetInterpField(CompatInfo *info, SymInterpInfo *si, const char *field,
641 ExprDef *arrayNdx, ExprDef *value)
643 struct xkb_keymap *keymap = info->keymap;
646 if (istreq(field, "action")) {
648 return ReportSINotArray(info, si, field);
650 if (!HandleActionDef(value, keymap, &si->interp.act, info->act))
653 si->defined |= SI_FIELD_ACTION;
655 else if (istreq(field, "virtualmodifier") ||
656 istreq(field, "virtualmod")) {
658 return ReportSINotArray(info, si, field);
660 if (!ResolveVirtualModifier(value, keymap, &ndx, &info->vmods))
661 return ReportSIBadType(info, si, field, "virtual modifier");
663 si->interp.virtual_mod = ndx;
664 si->defined |= SI_FIELD_VIRTUAL_MOD;
666 else if (istreq(field, "repeat")) {
670 return ReportSINotArray(info, si, field);
672 if (!ExprResolveBoolean(keymap->ctx, value, &set))
673 return ReportSIBadType(info, si, field, "boolean");
676 si->interp.flags |= XkbSI_AutoRepeat;
678 si->interp.flags &= ~XkbSI_AutoRepeat;
680 si->defined |= SI_FIELD_AUTO_REPEAT;
682 else if (istreq(field, "locking")) {
683 log_dbg(info->keymap->ctx,
684 "The \"locking\" field in symbol interpretation is unsupported; "
687 else if (istreq(field, "usemodmap") ||
688 istreq(field, "usemodmapmods")) {
692 return ReportSINotArray(info, si, field);
694 if (!ExprResolveEnum(keymap->ctx, value, &val, useModMapValues))
695 return ReportSIBadType(info, si, field, "level specification");
698 si->interp.match |= XkbSI_LevelOneOnly;
700 si->interp.match &= ~XkbSI_LevelOneOnly;
702 si->defined |= SI_FIELD_LEVEL_ONE_ONLY;
705 return ReportBadField(keymap, "symbol interpretation", field,
712 static const LookupEntry modComponentNames[] = {
713 {"base", XkbIM_UseBase},
714 {"latched", XkbIM_UseLatched},
715 {"locked", XkbIM_UseLocked},
716 {"effective", XkbIM_UseEffective},
717 {"compat", XkbIM_UseCompat},
718 {"any", XkbIM_UseAnyMods},
723 static const LookupEntry groupComponentNames[] = {
724 {"base", XkbIM_UseBase},
725 {"latched", XkbIM_UseLatched},
726 {"locked", XkbIM_UseLocked},
727 {"effective", XkbIM_UseEffective},
728 {"any", XkbIM_UseAnyGroup},
733 static const LookupEntry groupNames[] = {
748 SetIndicatorMapField(CompatInfo *info, LEDInfo *led,
749 const char *field, ExprDef *arrayNdx, ExprDef *value)
752 struct xkb_keymap *keymap = info->keymap;
754 if (istreq(field, "modifiers") || istreq(field, "mods")) {
756 return ReportIndicatorNotArray(info, led, field);
758 if (!ExprResolveVModMask(keymap, value, &led->mods))
759 return ReportIndicatorBadType(info, led, field, "modifier mask");
761 led->defined |= LED_FIELD_MODS;
763 else if (istreq(field, "groups")) {
767 return ReportIndicatorNotArray(info, led, field);
769 if (!ExprResolveMask(keymap->ctx, value, &mask, groupNames))
770 return ReportIndicatorBadType(info, led, field, "group mask");
773 led->defined |= LED_FIELD_GROUPS;
775 else if (istreq(field, "controls") || istreq(field, "ctrls")) {
779 return ReportIndicatorNotArray(info, led, field);
781 if (!ExprResolveMask(keymap->ctx, value, &mask, ctrlNames))
782 return ReportIndicatorBadType(info, led, field,
786 led->defined |= LED_FIELD_CTRLS;
788 else if (istreq(field, "allowexplicit")) {
792 return ReportIndicatorNotArray(info, led, field);
794 if (!ExprResolveBoolean(keymap->ctx, value, &set))
795 return ReportIndicatorBadType(info, led, field, "boolean");
798 led->flags &= ~XkbIM_NoExplicit;
800 led->flags |= XkbIM_NoExplicit;
802 led->defined |= LED_FIELD_EXPLICIT;
804 else if (istreq(field, "whichmodstate") ||
805 istreq(field, "whichmodifierstate")) {
809 return ReportIndicatorNotArray(info, led, field);
811 if (!ExprResolveMask(keymap->ctx, value, &mask, modComponentNames))
812 return ReportIndicatorBadType(info, led, field,
813 "mask of modifier state components");
815 led->which_mods = mask;
817 else if (istreq(field, "whichgroupstate")) {
821 return ReportIndicatorNotArray(info, led, field);
823 if (!ExprResolveMask(keymap->ctx, value, &mask, groupComponentNames))
824 return ReportIndicatorBadType(info, led, field,
825 "mask of group state components");
827 led->which_groups = mask;
829 else if (istreq(field, "driveskbd") ||
830 istreq(field, "driveskeyboard") ||
831 istreq(field, "leddriveskbd") ||
832 istreq(field, "leddriveskeyboard") ||
833 istreq(field, "indicatordriveskbd") ||
834 istreq(field, "indicatordriveskeyboard")) {
835 log_dbg(info->keymap->ctx,
836 "The \"%s\" field in indicator statements is unsupported; "
839 else if (istreq(field, "index")) {
840 /* Users should see this, it might cause unexpected behavior. */
841 log_err(info->keymap->ctx,
842 "The \"index\" field in indicator statements is unsupported; "
846 log_err(info->keymap->ctx,
847 "Unknown field %s in map for %s indicator; "
848 "Definition ignored\n",
849 field, xkb_atom_text(keymap->ctx, led->name));
857 HandleInterpVar(CompatInfo *info, VarDef *stmt)
859 const char *elem, *field;
863 if (!ExprResolveLhs(info->keymap->ctx, stmt->name, &elem, &field, &ndx))
865 else if (elem && istreq(elem, "interpret"))
866 ret = SetInterpField(info, &info->dflt, field, ndx, stmt->value);
867 else if (elem && istreq(elem, "indicator"))
868 ret = SetIndicatorMapField(info, &info->ledDflt, field, ndx,
871 ret = SetActionField(info->keymap, elem, field, ndx, stmt->value,
877 HandleInterpBody(CompatInfo *info, VarDef *def, SymInterpInfo *si)
880 const char *elem, *field;
883 for (; def; def = (VarDef *) def->common.next) {
884 if (def->name && def->name->op == EXPR_FIELD_REF) {
885 ok = HandleInterpVar(info, def);
889 ok = ExprResolveLhs(info->keymap->ctx, def->name, &elem, &field,
894 ok = SetInterpField(info, si, field, arrayNdx, def->value);
901 HandleInterpDef(CompatInfo *info, InterpDef *def, enum merge_mode merge)
906 if (!ResolveStateAndPredicate(def->match, &pred, &mods, info)) {
907 log_err(info->keymap->ctx,
908 "Couldn't determine matching modifiers; "
909 "Symbol interpretation ignored\n");
915 si.merge = merge = (def->merge == MERGE_DEFAULT ? merge : def->merge);
917 if (!LookupKeysym(def->sym, &si.interp.sym)) {
918 log_err(info->keymap->ctx,
919 "Could not resolve keysym %s; "
920 "Symbol interpretation ignored\n",
925 si.interp.match = pred & XkbSI_OpMask;
927 si.interp.mods = mods;
929 if (!HandleInterpBody(info, def->def, &si)) {
934 if (!AddInterp(info, &si)) {
943 HandleIndicatorMapDef(CompatInfo *info, IndicatorMapDef *def,
944 enum merge_mode merge)
950 if (def->merge != MERGE_DEFAULT)
955 led.name = def->name;
958 for (var = def->body; var != NULL; var = (VarDef *) var->common.next) {
959 const char *elem, *field;
961 if (!ExprResolveLhs(info->keymap->ctx, var->name, &elem, &field,
968 log_err(info->keymap->ctx,
969 "Cannot set defaults for \"%s\" element in indicator map; "
970 "Assignment to %s.%s ignored\n", elem, elem, field);
974 ok = SetIndicatorMapField(info, &led, field, arrayNdx,
980 return AddIndicatorMap(info, &led);
986 HandleCompatMapFile(CompatInfo *info, XkbFile *file, enum merge_mode merge)
991 merge = (merge == MERGE_DEFAULT ? MERGE_AUGMENT : merge);
994 info->name = strdup_safe(file->name);
996 for (stmt = file->defs; stmt; stmt = stmt->next) {
997 switch (stmt->type) {
999 ok = HandleIncludeCompatMap(info, (IncludeStmt *) stmt);
1002 ok = HandleInterpDef(info, (InterpDef *) stmt, merge);
1004 case STMT_GROUP_COMPAT:
1005 log_dbg(info->keymap->ctx,
1006 "The \"group\" statement in compat is unsupported; "
1010 case STMT_INDICATOR_MAP:
1011 ok = HandleIndicatorMapDef(info, (IndicatorMapDef *) stmt, merge);
1014 ok = HandleInterpVar(info, (VarDef *) stmt);
1017 ok = HandleVModDef((VModDef *) stmt, info->keymap, merge,
1021 log_err(info->keymap->ctx,
1022 "Interpretation files may not include other types; "
1023 "Ignoring %s\n", StmtTypeToString(stmt->type));
1031 if (info->errorCount > 10) {
1032 log_err(info->keymap->ctx,
1033 "Abandoning compatibility map \"%s\"\n", file->topName);
1040 CopyInterps(CompatInfo *info, bool needSymbol, unsigned pred)
1044 list_foreach(si, &info->interps, entry) {
1045 if (((si->interp.match & XkbSI_OpMask) != pred) ||
1046 (needSymbol && si->interp.sym == XKB_KEY_NoSymbol) ||
1047 (!needSymbol && si->interp.sym != XKB_KEY_NoSymbol))
1050 darray_append(info->keymap->sym_interpret, si->interp);
1055 CopyIndicatorMapDefs(CompatInfo *info)
1058 struct xkb_indicator_map *im;
1060 struct xkb_keymap *keymap = info->keymap;
1062 darray_foreach(led, info->leds) {
1063 const char *name = xkb_atom_text(keymap->ctx, led->name);
1066 * Find the indicator with the given name, if it was already
1067 * declared in keycodes.
1070 for (i = 0; i < XkbNumIndicators; i++) {
1071 if (streq_not_null(keymap->indicator_names[i], name)) {
1072 im = &keymap->indicators[i];
1077 /* Not previously declared; create it with next free index. */
1079 log_dbg(keymap->ctx,
1080 "Indicator name \"%s\" was not declared in the keycodes section; "
1081 "Adding new indicator\n", name);
1083 for (i = 0; i < XkbNumIndicators; i++) {
1084 if (keymap->indicator_names[i])
1087 keymap->indicator_names[i] = name;
1088 im = &keymap->indicators[i];
1092 /* Not place to put the it; ignore. */
1094 log_err(keymap->ctx,
1095 "Too many indicators (maximum is %d); "
1096 "Indicator name \"%s\" ignored\n",
1097 XkbNumIndicators, name);
1102 im->flags = led->flags;
1103 if (led->groups != 0 && led->which_groups == 0)
1104 im->which_groups = XkbIM_UseEffective;
1106 im->which_groups = led->which_groups;
1107 im->groups = led->groups;
1108 if (led->mods != 0 && led->which_mods == 0)
1109 im->which_mods = XkbIM_UseEffective;
1111 im->which_mods = led->which_mods;
1112 im->mods.mods = led->mods;
1113 im->ctrls = led->ctrls;
1120 CompileCompatMap(XkbFile *file, struct xkb_keymap *keymap,
1121 enum merge_mode merge)
1125 InitCompatInfo(&info, keymap, file->id);
1126 info.dflt.merge = merge;
1127 info.ledDflt.merge = merge;
1129 HandleCompatMapFile(&info, file, merge);
1131 if (info.errorCount != 0)
1135 keymap->compat_section_name = strdup(info.name);
1137 darray_init(keymap->sym_interpret);
1138 if (info.nInterps > 0) {
1139 darray_growalloc(keymap->sym_interpret, info.nInterps);
1140 CopyInterps(&info, true, XkbSI_Exactly);
1141 CopyInterps(&info, true, XkbSI_AllOf | XkbSI_NoneOf);
1142 CopyInterps(&info, true, XkbSI_AnyOf);
1143 CopyInterps(&info, true, XkbSI_AnyOfOrNone);
1144 CopyInterps(&info, false, XkbSI_Exactly);
1145 CopyInterps(&info, false, XkbSI_AllOf | XkbSI_NoneOf);
1146 CopyInterps(&info, false, XkbSI_AnyOf);
1147 CopyInterps(&info, false, XkbSI_AnyOfOrNone);
1150 if (!CopyIndicatorMapDefs(&info))
1153 ClearCompatInfo(&info);
1157 ClearCompatInfo(&info);
1162 ComputeEffectiveMask(struct xkb_keymap *keymap, struct xkb_mods *mods)
1165 xkb_mod_mask_t vmask = mods->mods >> XkbNumModifiers;
1167 /* The effective mask is only real mods for now. */
1168 mods->mask = mods->mods & 0xff;
1170 for (i = 0; i < XkbNumVirtualMods; i++) {
1171 if (!(vmask & (1 << i)))
1173 mods->mask |= keymap->vmods[i];
1178 UpdateActionMods(struct xkb_keymap *keymap, union xkb_action *act,
1179 xkb_mod_mask_t rmodmask)
1182 struct xkb_mods *mods;
1184 switch (act->type) {
1186 case XkbSA_LatchMods:
1187 case XkbSA_LockMods:
1188 flags = act->mods.flags;
1189 mods = &act->mods.mods;
1193 flags = act->iso.flags;
1194 mods = &act->iso.mods;
1201 if (flags & XkbSA_UseModMapMods) {
1202 /* XXX: what's that. */
1204 mods->mods |= rmodmask;
1206 ComputeEffectiveMask(keymap, mods);
1210 * Find an interpretation which applies to this particular level, either by
1211 * finding an exact match for the symbol and modifier combination, or a
1212 * generic XKB_KEY_NoSymbol match.
1214 static struct xkb_sym_interpret *
1215 FindInterpForKey(struct xkb_keymap *keymap, struct xkb_key *key,
1216 xkb_group_index_t group, xkb_level_index_t level)
1218 struct xkb_sym_interpret *ret = NULL;
1219 struct xkb_sym_interpret *interp;
1220 const xkb_keysym_t *syms;
1223 num_syms = xkb_key_get_syms_by_level(keymap, key, group, level, &syms);
1227 darray_foreach(interp, keymap->sym_interpret) {
1231 if ((num_syms > 1 || interp->sym != syms[0]) &&
1232 interp->sym != XKB_KEY_NoSymbol)
1235 if (level == 0 || !(interp->match & XkbSI_LevelOneOnly))
1240 switch (interp->match & XkbSI_OpMask) {
1242 found = !(interp->mods & mods);
1244 case XkbSI_AnyOfOrNone:
1245 found = (!mods || (interp->mods & mods));
1248 found = !!(interp->mods & mods);
1251 found = ((interp->mods & mods) == interp->mods);
1254 found = (interp->mods == mods);
1261 if (found && interp->sym != XKB_KEY_NoSymbol)
1263 else if (found && !ret)
1271 ApplyInterpsToKey(struct xkb_keymap *keymap, struct xkb_key *key)
1273 #define INTERP_SIZE (8 * 4)
1274 struct xkb_sym_interpret *interps[INTERP_SIZE];
1275 xkb_mod_mask_t vmodmask = 0;
1277 xkb_group_index_t group;
1278 xkb_level_index_t level;
1281 /* If we've been told not to bind interps to this key, then don't. */
1282 if (key->explicit & XkbExplicitInterpretMask)
1285 for (i = 0; i < INTERP_SIZE; i++)
1288 for (group = 0; group < key->num_groups; group++) {
1289 for (level = 0; level < XkbKeyGroupWidth(keymap, key, group);
1291 i = (group * key->width) + level;
1292 if (i >= INTERP_SIZE) /* XXX FIXME */
1294 interps[i] = FindInterpForKey(keymap, key, group, level);
1300 if (num_acts && !key->actions) {
1301 key->actions = calloc(key->num_groups * key->width,
1302 sizeof(*key->actions));
1307 for (group = 0; group < key->num_groups; group++) {
1308 for (level = 0; level < XkbKeyGroupWidth(keymap, key, group);
1310 struct xkb_sym_interpret *interp;
1312 i = (group * key->width) + level;
1313 interp = interps[i];
1315 /* Infer default key behaviours from the base level. */
1316 if (group == 0 && level == 0) {
1317 if (!(key->explicit & XkbExplicitAutoRepeatMask) &&
1318 (!interp || (interp->flags & XkbSI_AutoRepeat)))
1319 key->repeats = true;
1325 if ((group == 0 && level == 0) ||
1326 !(interp->match & XkbSI_LevelOneOnly)) {
1327 if (interp->virtual_mod != XkbNoModifier)
1328 vmodmask |= (1 << interp->virtual_mod);
1331 key->actions[i] = interp->act;
1335 if (!(key->explicit & XkbExplicitVModMapMask))
1336 key->vmodmap = vmodmask;
1343 * This collects a bunch of disparate functions which was done in the server
1344 * at various points that really should've been done within xkbcomp. Turns out
1345 * your actions and types are a lot more useful when any of your modifiers
1346 * other than Shift actually do something ...
1349 UpdateModifiersFromCompat(struct xkb_keymap *keymap)
1351 xkb_mod_index_t vmod;
1352 xkb_led_index_t led;
1354 struct xkb_key *key;
1356 /* Find all the interprets for the key and bind them to actions,
1357 * which will also update the vmodmap. */
1358 xkb_foreach_key(key, keymap)
1359 if (!ApplyInterpsToKey(keymap, key))
1362 /* Update keymap->vmods, the virtual -> real mod mapping. */
1363 for (vmod = 0; vmod < XkbNumVirtualMods; vmod++)
1364 keymap->vmods[vmod] = 0;
1366 xkb_foreach_key(key, keymap) {
1370 for (vmod = 0; vmod < XkbNumVirtualMods; vmod++) {
1371 if (!(key->vmodmap & (1 << vmod)))
1373 keymap->vmods[vmod] |= key->modmap;
1377 /* Now update the level masks for all the types to reflect the vmods. */
1378 for (i = 0; i < keymap->num_types; i++) {
1379 ComputeEffectiveMask(keymap, &keymap->types[i].mods);
1381 for (j = 0; j < keymap->types[i].num_entries; j++) {
1382 ComputeEffectiveMask(keymap, &keymap->types[i].map[j].mods);
1383 ComputeEffectiveMask(keymap, &keymap->types[i].map[j].preserve);
1387 /* Update action modifiers. */
1388 xkb_foreach_key(key, keymap) {
1392 for (i = 0; i < key->num_groups * key->width; i++)
1393 UpdateActionMods(keymap, &key->actions[i], key->modmap);
1396 /* Update vmod -> indicator maps. */
1397 for (led = 0; led < XkbNumIndicators; led++)
1398 ComputeEffectiveMask(keymap, &keymap->indicators[led].mods);
1400 /* Find maximum number of groups out of all keys in the keymap. */
1401 xkb_foreach_key(key, keymap)
1402 keymap->num_groups = MAX(keymap->num_groups, key->num_groups);