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;
150 struct xkb_sym_interpret interp;
154 LED_FIELD_MODS = (1 << 0),
155 LED_FIELD_GROUPS = (1 << 1),
156 LED_FIELD_CTRLS = (1 << 2),
159 typedef struct _LEDInfo {
160 enum led_field defined;
162 enum merge_mode merge;
165 unsigned char which_mods;
167 unsigned char which_groups;
172 typedef struct _CompatInfo {
177 darray(SymInterpInfo) interps;
179 darray(LEDInfo) leds;
182 struct xkb_keymap *keymap;
186 siText(SymInterpInfo *si, CompatInfo *info)
188 static char buf[128];
190 if (si == &info->dflt)
193 snprintf(buf, sizeof(buf), "%s+%s(%s)",
194 KeysymText(si->interp.sym),
195 SIMatchText(si->interp.match),
196 ModMaskText(si->interp.mods));
201 ReportSINotArray(CompatInfo *info, SymInterpInfo *si, const char *field)
203 return ReportNotArray(info->keymap, "symbol interpretation", field,
208 ReportSIBadType(CompatInfo *info, SymInterpInfo *si, const char *field,
211 return ReportBadType(info->keymap->ctx, "symbol interpretation", field,
212 siText(si, info), wanted);
216 ReportIndicatorBadType(CompatInfo *info, LEDInfo *led,
217 const char *field, const char *wanted)
219 return ReportBadType(info->keymap->ctx, "indicator map", field,
220 xkb_atom_text(info->keymap->ctx, led->name),
225 ReportIndicatorNotArray(CompatInfo *info, LEDInfo *led,
228 return ReportNotArray(info->keymap, "indicator map", field,
229 xkb_atom_text(info->keymap->ctx, led->name));
233 ClearIndicatorMapInfo(struct xkb_context *ctx, LEDInfo *info)
235 info->name = xkb_atom_intern(ctx, "default");
236 info->which_mods = 0;
238 info->which_groups = info->groups = 0;
243 InitCompatInfo(CompatInfo *info, struct xkb_keymap *keymap, unsigned file_id)
245 info->keymap = keymap;
247 info->file_id = file_id;
248 info->errorCount = 0;
249 darray_init(info->interps);
251 info->dflt.file_id = file_id;
252 info->dflt.defined = 0;
253 info->dflt.merge = MERGE_OVERRIDE;
254 info->dflt.interp.flags = 0;
255 info->dflt.interp.virtual_mod = XkbNoModifier;
256 memset(&info->dflt.interp.act, 0, sizeof(info->dflt.interp.act));
257 info->dflt.interp.act.type = XkbSA_NoAction;
258 ClearIndicatorMapInfo(keymap->ctx, &info->ledDflt);
259 info->ledDflt.file_id = file_id;
260 info->ledDflt.defined = 0;
261 info->ledDflt.merge = MERGE_OVERRIDE;
262 darray_init(info->leds);
263 InitVModInfo(&info->vmods, keymap);
267 ClearCompatInfo(CompatInfo *info)
269 struct xkb_keymap *keymap = info->keymap;
273 info->dflt.defined = 0;
274 info->dflt.merge = MERGE_AUGMENT;
275 info->dflt.interp.flags = 0;
276 info->dflt.interp.virtual_mod = XkbNoModifier;
277 memset(&info->dflt.interp.act, 0, sizeof(info->dflt.interp.act));
278 info->dflt.interp.act.type = XkbSA_NoAction;
279 ClearIndicatorMapInfo(keymap->ctx, &info->ledDflt);
280 darray_free(info->interps);
281 darray_free(info->leds);
282 FreeActionInfo(info->act);
285 ClearVModInfo(&info->vmods, keymap);
288 static SymInterpInfo *
289 FindMatchingInterp(CompatInfo *info, SymInterpInfo *new)
293 darray_foreach(old, info->interps)
294 if (old->interp.sym == new->interp.sym &&
295 old->interp.mods == new->interp.mods &&
296 old->interp.match == new->interp.match)
303 UseNewInterpField(enum si_field field, SymInterpInfo *old, SymInterpInfo *new,
304 bool report, enum si_field *collide)
306 if (!(old->defined & field))
309 if (new->defined & field) {
313 if (new->merge != MERGE_AUGMENT)
321 AddInterp(CompatInfo *info, SymInterpInfo *new)
323 enum si_field collide = 0;
326 old = FindMatchingInterp(info, new);
328 int verbosity = xkb_get_log_verbosity(info->keymap->ctx);
329 bool report = ((old->file_id == new->file_id && verbosity > 0) ||
332 if (new->merge == MERGE_REPLACE) {
334 log_warn(info->keymap->ctx,
335 "Multiple definitions for \"%s\"; "
336 "Earlier interpretation ignored\n",
342 if (UseNewInterpField(SI_FIELD_VIRTUAL_MOD, old, new, report,
344 old->interp.virtual_mod = new->interp.virtual_mod;
345 old->defined |= SI_FIELD_VIRTUAL_MOD;
347 if (UseNewInterpField(SI_FIELD_ACTION, old, new, report,
349 old->interp.act = new->interp.act;
350 old->defined |= SI_FIELD_ACTION;
352 if (UseNewInterpField(SI_FIELD_AUTO_REPEAT, old, new, report,
354 old->interp.flags &= ~XkbSI_AutoRepeat;
355 old->interp.flags |= (new->interp.flags & XkbSI_AutoRepeat);
356 old->defined |= SI_FIELD_AUTO_REPEAT;
358 if (UseNewInterpField(SI_FIELD_LEVEL_ONE_ONLY, old, new, report,
360 old->interp.match &= ~XkbSI_LevelOneOnly;
361 old->interp.match |= (new->interp.match & XkbSI_LevelOneOnly);
362 old->defined |= SI_FIELD_LEVEL_ONE_ONLY;
366 log_warn(info->keymap->ctx,
367 "Multiple interpretations of \"%s\"; "
368 "Using %s definition for duplicate fields\n",
370 (new->merge != MERGE_AUGMENT ? "last" : "first"));
376 darray_append(info->interps, *new);
381 /***====================================================================***/
384 ResolveStateAndPredicate(ExprDef *expr, unsigned *pred_rtrn,
385 xkb_mod_mask_t *mods_rtrn, CompatInfo *info)
388 *pred_rtrn = XkbSI_AnyOfOrNone;
393 *pred_rtrn = XkbSI_Exactly;
394 if (expr->op == EXPR_ACTION_DECL) {
395 const char *pred_txt = xkb_atom_text(info->keymap->ctx,
396 expr->value.action.name);
397 if (istreq(pred_txt, "noneof"))
398 *pred_rtrn = XkbSI_NoneOf;
399 else if (istreq(pred_txt, "anyofornone"))
400 *pred_rtrn = XkbSI_AnyOfOrNone;
401 else if (istreq(pred_txt, "anyof"))
402 *pred_rtrn = XkbSI_AnyOf;
403 else if (istreq(pred_txt, "allof"))
404 *pred_rtrn = XkbSI_AllOf;
405 else if (istreq(pred_txt, "exactly"))
406 *pred_rtrn = XkbSI_Exactly;
408 log_err(info->keymap->ctx,
409 "Illegal modifier predicate \"%s\"; Ignored\n", pred_txt);
412 expr = expr->value.action.args;
414 else if (expr->op == EXPR_IDENT) {
415 const char *pred_txt = xkb_atom_text(info->keymap->ctx,
417 if (pred_txt && istreq(pred_txt, "any")) {
418 *pred_rtrn = XkbSI_AnyOf;
424 return ExprResolveModMask(info->keymap->ctx, expr, mods_rtrn);
427 /***====================================================================***/
430 UseNewLEDField(enum led_field field, LEDInfo *old, LEDInfo *new,
431 bool report, enum led_field *collide)
433 if (!(old->defined & field))
436 if (new->defined & field) {
440 if (new->merge != MERGE_AUGMENT)
448 AddIndicatorMap(CompatInfo *info, LEDInfo *new)
451 enum led_field collide;
452 struct xkb_context *ctx = info->keymap->ctx;
453 int verbosity = xkb_get_log_verbosity(ctx);
455 darray_foreach(old, info->leds) {
458 if (old->name != new->name)
461 if (old->mods == new->mods &&
462 old->groups == new->groups &&
463 old->ctrls == new->ctrls &&
464 old->which_mods == new->which_mods &&
465 old->which_groups == new->which_groups) {
466 old->defined |= new->defined;
470 report = ((old->file_id == new->file_id && verbosity > 0) ||
473 if (new->merge == MERGE_REPLACE) {
475 log_warn(info->keymap->ctx,
476 "Map for indicator %s redefined; "
477 "Earlier definition ignored\n",
478 xkb_atom_text(ctx, old->name));
484 if (UseNewLEDField(LED_FIELD_MODS, old, new, report, &collide)) {
485 old->which_mods = new->which_mods;
486 old->mods = new->mods;
487 old->defined |= LED_FIELD_MODS;
489 if (UseNewLEDField(LED_FIELD_GROUPS, old, new, report, &collide)) {
490 old->which_groups = new->which_groups;
491 old->groups = new->groups;
492 old->defined |= LED_FIELD_GROUPS;
494 if (UseNewLEDField(LED_FIELD_CTRLS, old, new, report, &collide)) {
495 old->ctrls = new->ctrls;
496 old->defined |= LED_FIELD_CTRLS;
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"));
510 darray_append(info->leds, *new);
515 MergeIncludedCompatMaps(CompatInfo *into, CompatInfo *from,
516 enum merge_mode merge)
521 if (from->errorCount > 0) {
522 into->errorCount += from->errorCount;
526 if (into->name == NULL) {
527 into->name = from->name;
531 darray_foreach(si, from->interps) {
532 si->merge = (merge == MERGE_DEFAULT ? si->merge : merge);
533 if (!AddInterp(into, si))
537 darray_foreach(led, from->leds) {
538 led->merge = (merge == MERGE_DEFAULT ? led->merge : merge);
539 if (!AddIndicatorMap(into, led))
545 HandleCompatMapFile(CompatInfo *info, XkbFile *file, enum merge_mode merge);
548 HandleIncludeCompatMap(CompatInfo *info, IncludeStmt *stmt)
550 enum merge_mode merge = MERGE_DEFAULT;
552 CompatInfo included, next_incl;
554 InitCompatInfo(&included, info->keymap, info->file_id);
557 included.name = stmt->stmt;
561 for (; stmt; stmt = stmt->next_incl) {
562 if (!ProcessIncludeFile(info->keymap->ctx, stmt, FILE_TYPE_COMPAT,
564 info->errorCount += 10;
565 ClearCompatInfo(&included);
569 InitCompatInfo(&next_incl, info->keymap, rtrn->id);
570 next_incl.file_id = rtrn->id;
571 next_incl.dflt = info->dflt;
572 next_incl.dflt.file_id = rtrn->id;
573 next_incl.dflt.merge = merge;
574 next_incl.ledDflt.file_id = rtrn->id;
575 next_incl.ledDflt.merge = merge;
576 next_incl.act = info->act;
578 HandleCompatMapFile(&next_incl, rtrn, MERGE_OVERRIDE);
580 MergeIncludedCompatMaps(&included, &next_incl, merge);
582 next_incl.act = NULL;
584 ClearCompatInfo(&next_incl);
588 MergeIncludedCompatMaps(info, &included, merge);
589 ClearCompatInfo(&included);
591 return (info->errorCount == 0);
594 static const LookupEntry useModMapValues[] = {
603 SetInterpField(CompatInfo *info, SymInterpInfo *si, const char *field,
604 ExprDef *arrayNdx, ExprDef *value)
606 struct xkb_keymap *keymap = info->keymap;
609 if (istreq(field, "action")) {
611 return ReportSINotArray(info, si, field);
613 if (!HandleActionDef(value, keymap, &si->interp.act, info->act))
616 si->defined |= SI_FIELD_ACTION;
618 else if (istreq(field, "virtualmodifier") ||
619 istreq(field, "virtualmod")) {
621 return ReportSINotArray(info, si, field);
623 if (!ResolveVirtualModifier(value, keymap, &ndx, &info->vmods))
624 return ReportSIBadType(info, si, field, "virtual modifier");
626 si->interp.virtual_mod = ndx;
627 si->defined |= SI_FIELD_VIRTUAL_MOD;
629 else if (istreq(field, "repeat")) {
633 return ReportSINotArray(info, si, field);
635 if (!ExprResolveBoolean(keymap->ctx, value, &set))
636 return ReportSIBadType(info, si, field, "boolean");
639 si->interp.flags |= XkbSI_AutoRepeat;
641 si->interp.flags &= ~XkbSI_AutoRepeat;
643 si->defined |= SI_FIELD_AUTO_REPEAT;
645 else if (istreq(field, "locking")) {
646 log_dbg(info->keymap->ctx,
647 "The \"locking\" field in symbol interpretation is unsupported; "
650 else if (istreq(field, "usemodmap") ||
651 istreq(field, "usemodmapmods")) {
655 return ReportSINotArray(info, si, field);
657 if (!ExprResolveEnum(keymap->ctx, value, &val, useModMapValues))
658 return ReportSIBadType(info, si, field, "level specification");
661 si->interp.match |= XkbSI_LevelOneOnly;
663 si->interp.match &= ~XkbSI_LevelOneOnly;
665 si->defined |= SI_FIELD_LEVEL_ONE_ONLY;
668 return ReportBadField(keymap, "symbol interpretation", field,
675 static const LookupEntry modComponentNames[] = {
676 {"base", XkbIM_UseBase},
677 {"latched", XkbIM_UseLatched},
678 {"locked", XkbIM_UseLocked},
679 {"effective", XkbIM_UseEffective},
680 {"compat", XkbIM_UseCompat},
681 {"any", XkbIM_UseAnyMods},
686 static const LookupEntry groupComponentNames[] = {
687 {"base", XkbIM_UseBase},
688 {"latched", XkbIM_UseLatched},
689 {"locked", XkbIM_UseLocked},
690 {"effective", XkbIM_UseEffective},
691 {"any", XkbIM_UseAnyGroup},
696 static const LookupEntry groupNames[] = {
711 SetIndicatorMapField(CompatInfo *info, LEDInfo *led,
712 const char *field, ExprDef *arrayNdx, ExprDef *value)
715 struct xkb_keymap *keymap = info->keymap;
717 if (istreq(field, "modifiers") || istreq(field, "mods")) {
719 return ReportIndicatorNotArray(info, led, field);
721 if (!ExprResolveVModMask(keymap, value, &led->mods))
722 return ReportIndicatorBadType(info, led, field, "modifier mask");
724 led->defined |= LED_FIELD_MODS;
726 else if (istreq(field, "groups")) {
730 return ReportIndicatorNotArray(info, led, field);
732 if (!ExprResolveMask(keymap->ctx, value, &mask, groupNames))
733 return ReportIndicatorBadType(info, led, field, "group mask");
736 led->defined |= LED_FIELD_GROUPS;
738 else if (istreq(field, "controls") || istreq(field, "ctrls")) {
742 return ReportIndicatorNotArray(info, led, field);
744 if (!ExprResolveMask(keymap->ctx, value, &mask, ctrlNames))
745 return ReportIndicatorBadType(info, led, field,
749 led->defined |= LED_FIELD_CTRLS;
751 else if (istreq(field, "allowexplicit")) {
752 log_dbg(info->keymap->ctx,
753 "The \"allowExplicit\" field in indicator statements is unsupported; "
756 else if (istreq(field, "whichmodstate") ||
757 istreq(field, "whichmodifierstate")) {
761 return ReportIndicatorNotArray(info, led, field);
763 if (!ExprResolveMask(keymap->ctx, value, &mask, modComponentNames))
764 return ReportIndicatorBadType(info, led, field,
765 "mask of modifier state components");
767 led->which_mods = mask;
769 else if (istreq(field, "whichgroupstate")) {
773 return ReportIndicatorNotArray(info, led, field);
775 if (!ExprResolveMask(keymap->ctx, value, &mask, groupComponentNames))
776 return ReportIndicatorBadType(info, led, field,
777 "mask of group state components");
779 led->which_groups = mask;
781 else if (istreq(field, "driveskbd") ||
782 istreq(field, "driveskeyboard") ||
783 istreq(field, "leddriveskbd") ||
784 istreq(field, "leddriveskeyboard") ||
785 istreq(field, "indicatordriveskbd") ||
786 istreq(field, "indicatordriveskeyboard")) {
787 log_dbg(info->keymap->ctx,
788 "The \"%s\" field in indicator statements is unsupported; "
791 else if (istreq(field, "index")) {
792 /* Users should see this, it might cause unexpected behavior. */
793 log_err(info->keymap->ctx,
794 "The \"index\" field in indicator statements is unsupported; "
798 log_err(info->keymap->ctx,
799 "Unknown field %s in map for %s indicator; "
800 "Definition ignored\n",
801 field, xkb_atom_text(keymap->ctx, led->name));
809 HandleGlobalVar(CompatInfo *info, VarDef *stmt)
811 const char *elem, *field;
815 if (!ExprResolveLhs(info->keymap->ctx, stmt->name, &elem, &field, &ndx))
817 else if (elem && istreq(elem, "interpret"))
818 ret = SetInterpField(info, &info->dflt, field, ndx, stmt->value);
819 else if (elem && istreq(elem, "indicator"))
820 ret = SetIndicatorMapField(info, &info->ledDflt, field, ndx,
823 ret = SetActionField(info->keymap, elem, field, ndx, stmt->value,
829 HandleInterpBody(CompatInfo *info, VarDef *def, SymInterpInfo *si)
832 const char *elem, *field;
835 for (; def; def = (VarDef *) def->common.next) {
836 if (def->name && def->name->op == EXPR_FIELD_REF) {
837 log_err(info->keymap->ctx,
838 "Cannot set a global default value from within an interpret statement; "
839 "Move statements to the global file scope\n");
844 ok = ExprResolveLhs(info->keymap->ctx, def->name, &elem, &field,
849 ok = SetInterpField(info, si, field, arrayNdx, def->value);
856 HandleInterpDef(CompatInfo *info, InterpDef *def, enum merge_mode merge)
861 if (!ResolveStateAndPredicate(def->match, &pred, &mods, info)) {
862 log_err(info->keymap->ctx,
863 "Couldn't determine matching modifiers; "
864 "Symbol interpretation ignored\n");
870 si.merge = merge = (def->merge == MERGE_DEFAULT ? merge : def->merge);
872 if (!LookupKeysym(def->sym, &si.interp.sym)) {
873 log_err(info->keymap->ctx,
874 "Could not resolve keysym %s; "
875 "Symbol interpretation ignored\n",
880 si.interp.match = pred & XkbSI_OpMask;
882 si.interp.mods = mods;
884 if (!HandleInterpBody(info, def->def, &si)) {
889 if (!AddInterp(info, &si)) {
898 HandleIndicatorMapDef(CompatInfo *info, IndicatorMapDef *def,
899 enum merge_mode merge)
905 if (def->merge != MERGE_DEFAULT)
910 led.name = def->name;
913 for (var = def->body; var != NULL; var = (VarDef *) var->common.next) {
914 const char *elem, *field;
916 if (!ExprResolveLhs(info->keymap->ctx, var->name, &elem, &field,
923 log_err(info->keymap->ctx,
924 "Cannot set defaults for \"%s\" element in indicator map; "
925 "Assignment to %s.%s ignored\n", elem, elem, field);
929 ok = SetIndicatorMapField(info, &led, field, arrayNdx,
935 return AddIndicatorMap(info, &led);
941 HandleCompatMapFile(CompatInfo *info, XkbFile *file, enum merge_mode merge)
946 merge = (merge == MERGE_DEFAULT ? MERGE_AUGMENT : merge);
949 info->name = strdup_safe(file->name);
951 for (stmt = file->defs; stmt; stmt = stmt->next) {
952 switch (stmt->type) {
954 ok = HandleIncludeCompatMap(info, (IncludeStmt *) stmt);
957 ok = HandleInterpDef(info, (InterpDef *) stmt, merge);
959 case STMT_GROUP_COMPAT:
960 log_dbg(info->keymap->ctx,
961 "The \"group\" statement in compat is unsupported; "
965 case STMT_INDICATOR_MAP:
966 ok = HandleIndicatorMapDef(info, (IndicatorMapDef *) stmt, merge);
969 ok = HandleGlobalVar(info, (VarDef *) stmt);
972 ok = HandleVModDef((VModDef *) stmt, info->keymap, merge,
976 log_err(info->keymap->ctx,
977 "Interpretation files may not include other types; "
978 "Ignoring %s\n", StmtTypeToString(stmt->type));
986 if (info->errorCount > 10) {
987 log_err(info->keymap->ctx,
988 "Abandoning compatibility map \"%s\"\n", file->topName);
995 CopyInterps(CompatInfo *info, bool needSymbol, unsigned pred)
999 darray_foreach(si, info->interps) {
1000 if (((si->interp.match & XkbSI_OpMask) != pred) ||
1001 (needSymbol && si->interp.sym == XKB_KEY_NoSymbol) ||
1002 (!needSymbol && si->interp.sym != XKB_KEY_NoSymbol))
1005 darray_append(info->keymap->sym_interpret, si->interp);
1010 CopyIndicatorMapDefs(CompatInfo *info)
1013 struct xkb_indicator_map *im;
1015 struct xkb_keymap *keymap = info->keymap;
1017 darray_foreach(led, info->leds) {
1018 const char *name = xkb_atom_text(keymap->ctx, led->name);
1021 * Find the indicator with the given name, if it was already
1022 * declared in keycodes.
1025 for (i = 0; i < XkbNumIndicators; i++) {
1026 if (streq_not_null(keymap->indicator_names[i], name)) {
1027 im = &keymap->indicators[i];
1032 /* Not previously declared; create it with next free index. */
1034 log_dbg(keymap->ctx,
1035 "Indicator name \"%s\" was not declared in the keycodes section; "
1036 "Adding new indicator\n", name);
1038 for (i = 0; i < XkbNumIndicators; i++) {
1039 if (keymap->indicator_names[i])
1042 keymap->indicator_names[i] = name;
1043 im = &keymap->indicators[i];
1047 /* Not place to put the it; ignore. */
1049 log_err(keymap->ctx,
1050 "Too many indicators (maximum is %d); "
1051 "Indicator name \"%s\" ignored\n",
1052 XkbNumIndicators, name);
1057 if (led->groups != 0 && led->which_groups == 0)
1058 im->which_groups = XkbIM_UseEffective;
1060 im->which_groups = led->which_groups;
1061 im->groups = led->groups;
1062 if (led->mods != 0 && led->which_mods == 0)
1063 im->which_mods = XkbIM_UseEffective;
1065 im->which_mods = led->which_mods;
1066 im->mods.mods = led->mods;
1067 im->ctrls = led->ctrls;
1074 CompileCompatMap(XkbFile *file, struct xkb_keymap *keymap,
1075 enum merge_mode merge)
1079 InitCompatInfo(&info, keymap, file->id);
1080 info.dflt.merge = merge;
1081 info.ledDflt.merge = merge;
1083 HandleCompatMapFile(&info, file, merge);
1085 if (info.errorCount != 0)
1089 keymap->compat_section_name = strdup(info.name);
1091 if (!darray_empty(info.interps)) {
1092 CopyInterps(&info, true, XkbSI_Exactly);
1093 CopyInterps(&info, true, XkbSI_AllOf | XkbSI_NoneOf);
1094 CopyInterps(&info, true, XkbSI_AnyOf);
1095 CopyInterps(&info, true, XkbSI_AnyOfOrNone);
1096 CopyInterps(&info, false, XkbSI_Exactly);
1097 CopyInterps(&info, false, XkbSI_AllOf | XkbSI_NoneOf);
1098 CopyInterps(&info, false, XkbSI_AnyOf);
1099 CopyInterps(&info, false, XkbSI_AnyOfOrNone);
1102 if (!CopyIndicatorMapDefs(&info))
1105 ClearCompatInfo(&info);
1109 ClearCompatInfo(&info);
1114 ComputeEffectiveMask(struct xkb_keymap *keymap, struct xkb_mods *mods)
1117 xkb_mod_mask_t vmask = mods->mods >> XkbNumModifiers;
1119 /* The effective mask is only real mods for now. */
1120 mods->mask = mods->mods & 0xff;
1122 for (i = 0; i < XkbNumVirtualMods; i++) {
1123 if (!(vmask & (1 << i)))
1125 mods->mask |= keymap->vmods[i];
1130 UpdateActionMods(struct xkb_keymap *keymap, union xkb_action *act,
1131 xkb_mod_mask_t rmodmask)
1134 struct xkb_mods *mods;
1136 switch (act->type) {
1138 case XkbSA_LatchMods:
1139 case XkbSA_LockMods:
1140 flags = act->mods.flags;
1141 mods = &act->mods.mods;
1145 flags = act->iso.flags;
1146 mods = &act->iso.mods;
1153 if (flags & XkbSA_UseModMapMods) {
1154 /* XXX: what's that. */
1156 mods->mods |= rmodmask;
1158 ComputeEffectiveMask(keymap, mods);
1162 * Find an interpretation which applies to this particular level, either by
1163 * finding an exact match for the symbol and modifier combination, or a
1164 * generic XKB_KEY_NoSymbol match.
1166 static struct xkb_sym_interpret *
1167 FindInterpForKey(struct xkb_keymap *keymap, struct xkb_key *key,
1168 xkb_group_index_t group, xkb_level_index_t level)
1170 struct xkb_sym_interpret *ret = NULL;
1171 struct xkb_sym_interpret *interp;
1172 const xkb_keysym_t *syms;
1175 num_syms = xkb_key_get_syms_by_level(keymap, key, group, level, &syms);
1179 darray_foreach(interp, keymap->sym_interpret) {
1183 if ((num_syms > 1 || interp->sym != syms[0]) &&
1184 interp->sym != XKB_KEY_NoSymbol)
1187 if (level == 0 || !(interp->match & XkbSI_LevelOneOnly))
1192 switch (interp->match & XkbSI_OpMask) {
1194 found = !(interp->mods & mods);
1196 case XkbSI_AnyOfOrNone:
1197 found = (!mods || (interp->mods & mods));
1200 found = !!(interp->mods & mods);
1203 found = ((interp->mods & mods) == interp->mods);
1206 found = (interp->mods == mods);
1213 if (found && interp->sym != XKB_KEY_NoSymbol)
1215 else if (found && !ret)
1223 ApplyInterpsToKey(struct xkb_keymap *keymap, struct xkb_key *key)
1225 #define INTERP_SIZE (8 * 4)
1226 struct xkb_sym_interpret *interps[INTERP_SIZE];
1227 xkb_mod_mask_t vmodmask = 0;
1229 xkb_group_index_t group;
1230 xkb_level_index_t level;
1233 /* If we've been told not to bind interps to this key, then don't. */
1234 if (key->explicit & XkbExplicitInterpretMask)
1237 for (i = 0; i < INTERP_SIZE; i++)
1240 for (group = 0; group < key->num_groups; group++) {
1241 for (level = 0; level < XkbKeyGroupWidth(keymap, key, group);
1243 i = (group * key->width) + level;
1244 if (i >= INTERP_SIZE) /* XXX FIXME */
1246 interps[i] = FindInterpForKey(keymap, key, group, level);
1252 if (num_acts && !key->actions) {
1253 key->actions = calloc(key->num_groups * key->width,
1254 sizeof(*key->actions));
1259 for (group = 0; group < key->num_groups; group++) {
1260 for (level = 0; level < XkbKeyGroupWidth(keymap, key, group);
1262 struct xkb_sym_interpret *interp;
1264 i = (group * key->width) + level;
1265 interp = interps[i];
1267 /* Infer default key behaviours from the base level. */
1268 if (group == 0 && level == 0) {
1269 if (!(key->explicit & XkbExplicitAutoRepeatMask) &&
1270 (!interp || (interp->flags & XkbSI_AutoRepeat)))
1271 key->repeats = true;
1277 if ((group == 0 && level == 0) ||
1278 !(interp->match & XkbSI_LevelOneOnly)) {
1279 if (interp->virtual_mod != XkbNoModifier)
1280 vmodmask |= (1 << interp->virtual_mod);
1283 key->actions[i] = interp->act;
1287 if (!(key->explicit & XkbExplicitVModMapMask))
1288 key->vmodmap = vmodmask;
1295 * This collects a bunch of disparate functions which was done in the server
1296 * at various points that really should've been done within xkbcomp. Turns out
1297 * your actions and types are a lot more useful when any of your modifiers
1298 * other than Shift actually do something ...
1301 UpdateModifiersFromCompat(struct xkb_keymap *keymap)
1303 xkb_mod_index_t vmod;
1304 xkb_led_index_t led;
1306 struct xkb_key *key;
1308 /* Find all the interprets for the key and bind them to actions,
1309 * which will also update the vmodmap. */
1310 xkb_foreach_key(key, keymap)
1311 if (!ApplyInterpsToKey(keymap, key))
1314 /* Update keymap->vmods, the virtual -> real mod mapping. */
1315 for (vmod = 0; vmod < XkbNumVirtualMods; vmod++)
1316 keymap->vmods[vmod] = 0;
1318 xkb_foreach_key(key, keymap) {
1322 for (vmod = 0; vmod < XkbNumVirtualMods; vmod++) {
1323 if (!(key->vmodmap & (1 << vmod)))
1325 keymap->vmods[vmod] |= key->modmap;
1329 /* Now update the level masks for all the types to reflect the vmods. */
1330 for (i = 0; i < keymap->num_types; i++) {
1331 ComputeEffectiveMask(keymap, &keymap->types[i].mods);
1333 for (j = 0; j < keymap->types[i].num_entries; j++) {
1334 ComputeEffectiveMask(keymap, &keymap->types[i].map[j].mods);
1335 ComputeEffectiveMask(keymap, &keymap->types[i].map[j].preserve);
1339 /* Update action modifiers. */
1340 xkb_foreach_key(key, keymap) {
1344 for (i = 0; i < key->num_groups * key->width; i++)
1345 UpdateActionMods(keymap, &key->actions[i], key->modmap);
1348 /* Update vmod -> indicator maps. */
1349 for (led = 0; led < XkbNumIndicators; led++)
1350 ComputeEffectiveMask(keymap, &keymap->indicators[led].mods);
1352 /* Find maximum number of groups out of all keys in the keymap. */
1353 xkb_foreach_key(key, keymap)
1354 keymap->num_groups = MAX(keymap->num_groups, key->num_groups);