1 /************************************************************
2 * Copyright (c) 1994 by Silicon Graphics Computer Systems, Inc.
4 * Permission to use, copy, modify, and distribute this
5 * software and its documentation for any purpose and without
6 * fee is hereby granted, provided that the above copyright
7 * notice appear in all copies and that both that copyright
8 * notice and this permission notice appear in supporting
9 * documentation, and that the name of Silicon Graphics not be
10 * used in advertising or publicity pertaining to distribution
11 * of the software without specific prior written permission.
12 * Silicon Graphics makes no representation about the suitability
13 * of this software for any purpose. It is provided "as is"
14 * without any express or implied warranty.
16 * SILICON GRAPHICS DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS
17 * SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
18 * AND FITNESS FOR A PARTICULAR PURPOSE. IN NO EVENT SHALL SILICON
19 * GRAPHICS BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL
20 * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
21 * DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
22 * OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH
23 * THE USE OR PERFORMANCE OF THIS SOFTWARE.
25 ********************************************************/
28 * Copyright © 2012 Ran Benita <ran234@gmail.com>
30 * Permission is hereby granted, free of charge, to any person obtaining a
31 * copy of this software and associated documentation files (the "Software"),
32 * to deal in the Software without restriction, including without limitation
33 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
34 * and/or sell copies of the Software, and to permit persons to whom the
35 * Software is furnished to do so, subject to the following conditions:
37 * The above copyright notice and this permission notice (including the next
38 * paragraph) shall be included in all copies or substantial portions of the
41 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
42 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
43 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
44 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
45 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
46 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
47 * DEALINGS IN THE SOFTWARE.
50 #include "xkbcomp-priv.h"
58 SI_FIELD_VIRTUAL_MOD = (1 << 0),
59 SI_FIELD_ACTION = (1 << 1),
60 SI_FIELD_AUTO_REPEAT = (1 << 2),
61 SI_FIELD_LEVEL_ONE_ONLY = (1 << 3),
65 enum si_field defined;
66 enum merge_mode merge;
68 struct xkb_sym_interpret interp;
72 LED_FIELD_MODS = (1 << 0),
73 LED_FIELD_GROUPS = (1 << 1),
74 LED_FIELD_CTRLS = (1 << 2),
78 enum led_field defined;
79 enum merge_mode merge;
87 SymInterpInfo default_interp;
88 darray(SymInterpInfo) interps;
93 struct xkb_context *ctx;
94 struct xkb_keymap *keymap;
98 siText(SymInterpInfo *si, CompatInfo *info)
100 char *buf = xkb_context_get_buffer(info->ctx, 128);
102 if (si == &info->default_interp)
105 snprintf(buf, 128, "%s+%s(%s)",
106 KeysymText(info->ctx, si->interp.sym),
107 SIMatchText(si->interp.match),
108 ModMaskText(info->ctx, &info->keymap->mods, si->interp.mods));
114 ReportSINotArray(CompatInfo *info, SymInterpInfo *si, const char *field)
116 return ReportNotArray(info->ctx, "symbol interpretation", field,
121 ReportSIBadType(CompatInfo *info, SymInterpInfo *si, const char *field,
124 return ReportBadType(info->ctx, "symbol interpretation", field,
125 siText(si, info), wanted);
129 ReportLedBadType(CompatInfo *info, LedInfo *ledi, const char *field,
132 return ReportBadType(info->ctx, "indicator map", field,
133 xkb_atom_text(info->ctx, ledi->led.name),
138 ReportLedNotArray(CompatInfo *info, LedInfo *ledi, const char *field)
140 return ReportNotArray(info->ctx, "indicator map", field,
141 xkb_atom_text(info->ctx, ledi->led.name));
145 InitCompatInfo(CompatInfo *info, struct xkb_keymap *keymap,
146 ActionsInfo *actions)
148 memset(info, 0, sizeof(*info));
149 info->ctx = keymap->ctx;
150 info->keymap = keymap;
151 info->actions = actions;
152 info->default_interp.merge = MERGE_OVERRIDE;
153 info->default_interp.interp.virtual_mod = XKB_MOD_INVALID;
154 info->default_led.merge = MERGE_OVERRIDE;
158 ClearCompatInfo(CompatInfo *info)
161 darray_free(info->interps);
162 darray_free(info->leds);
165 static SymInterpInfo *
166 FindMatchingInterp(CompatInfo *info, SymInterpInfo *new)
170 darray_foreach(old, info->interps)
171 if (old->interp.sym == new->interp.sym &&
172 old->interp.mods == new->interp.mods &&
173 old->interp.match == new->interp.match)
180 UseNewInterpField(enum si_field field, SymInterpInfo *old, SymInterpInfo *new,
181 bool report, enum si_field *collide)
183 if (!(old->defined & field))
186 if (new->defined & field) {
190 if (new->merge != MERGE_AUGMENT)
198 AddInterp(CompatInfo *info, SymInterpInfo *new, bool same_file)
200 SymInterpInfo *old = FindMatchingInterp(info, new);
202 const int verbosity = xkb_context_get_log_verbosity(info->ctx);
203 const bool report = (same_file && verbosity > 0) || verbosity > 9;
204 enum si_field collide = 0;
206 if (new->merge == MERGE_REPLACE) {
209 "Multiple definitions for \"%s\"; "
210 "Earlier interpretation ignored\n",
216 if (UseNewInterpField(SI_FIELD_VIRTUAL_MOD, old, new, report,
218 old->interp.virtual_mod = new->interp.virtual_mod;
219 old->defined |= SI_FIELD_VIRTUAL_MOD;
221 if (UseNewInterpField(SI_FIELD_ACTION, old, new, report,
223 old->interp.action = new->interp.action;
224 old->defined |= SI_FIELD_ACTION;
226 if (UseNewInterpField(SI_FIELD_AUTO_REPEAT, old, new, report,
228 old->interp.repeat = new->interp.repeat;
229 old->defined |= SI_FIELD_AUTO_REPEAT;
231 if (UseNewInterpField(SI_FIELD_LEVEL_ONE_ONLY, old, new, report,
233 old->interp.level_one_only = new->interp.level_one_only;
234 old->defined |= SI_FIELD_LEVEL_ONE_ONLY;
239 "Multiple interpretations of \"%s\"; "
240 "Using %s definition for duplicate fields\n",
242 (new->merge != MERGE_AUGMENT ? "last" : "first"));
248 darray_append(info->interps, *new);
252 /***====================================================================***/
255 ResolveStateAndPredicate(ExprDef *expr, enum xkb_match_operation *pred_rtrn,
256 xkb_mod_mask_t *mods_rtrn, CompatInfo *info)
259 *pred_rtrn = MATCH_ANY_OR_NONE;
260 *mods_rtrn = MOD_REAL_MASK_ALL;
264 *pred_rtrn = MATCH_EXACTLY;
265 if (expr->expr.op == EXPR_ACTION_DECL) {
266 const char *pred_txt = xkb_atom_text(info->ctx, expr->action.name);
267 if (!LookupString(symInterpretMatchMaskNames, pred_txt, pred_rtrn)) {
269 "Illegal modifier predicate \"%s\"; Ignored\n", pred_txt);
272 expr = expr->action.args;
274 else if (expr->expr.op == EXPR_IDENT) {
275 const char *pred_txt = xkb_atom_text(info->ctx, expr->ident.ident);
276 if (pred_txt && istreq(pred_txt, "any")) {
277 *pred_rtrn = MATCH_ANY;
278 *mods_rtrn = MOD_REAL_MASK_ALL;
283 return ExprResolveModMask(info->ctx, expr, MOD_REAL, &info->keymap->mods,
287 /***====================================================================***/
290 UseNewLEDField(enum led_field field, LedInfo *old, LedInfo *new,
291 bool report, enum led_field *collide)
293 if (!(old->defined & field))
296 if (new->defined & field) {
300 if (new->merge != MERGE_AUGMENT)
308 AddLedMap(CompatInfo *info, LedInfo *new, bool same_file)
311 enum led_field collide;
312 const int verbosity = xkb_context_get_log_verbosity(info->ctx);
313 const bool report = (same_file && verbosity > 0) || verbosity > 9;
315 darray_foreach(old, info->leds) {
316 if (old->led.name != new->led.name)
319 if (old->led.mods.mods == new->led.mods.mods &&
320 old->led.groups == new->led.groups &&
321 old->led.ctrls == new->led.ctrls &&
322 old->led.which_mods == new->led.which_mods &&
323 old->led.which_groups == new->led.which_groups) {
324 old->defined |= new->defined;
328 if (new->merge == MERGE_REPLACE) {
331 "Map for indicator %s redefined; "
332 "Earlier definition ignored\n",
333 xkb_atom_text(info->ctx, old->led.name));
339 if (UseNewLEDField(LED_FIELD_MODS, old, new, report, &collide)) {
340 old->led.which_mods = new->led.which_mods;
341 old->led.mods = new->led.mods;
342 old->defined |= LED_FIELD_MODS;
344 if (UseNewLEDField(LED_FIELD_GROUPS, old, new, report, &collide)) {
345 old->led.which_groups = new->led.which_groups;
346 old->led.groups = new->led.groups;
347 old->defined |= LED_FIELD_GROUPS;
349 if (UseNewLEDField(LED_FIELD_CTRLS, old, new, report, &collide)) {
350 old->led.ctrls = new->led.ctrls;
351 old->defined |= LED_FIELD_CTRLS;
356 "Map for indicator %s redefined; "
357 "Using %s definition for duplicate fields\n",
358 xkb_atom_text(info->ctx, old->led.name),
359 (new->merge == MERGE_AUGMENT ? "first" : "last"));
365 darray_append(info->leds, *new);
370 MergeIncludedCompatMaps(CompatInfo *into, CompatInfo *from,
371 enum merge_mode merge)
376 if (from->errorCount > 0) {
377 into->errorCount += from->errorCount;
381 if (into->name == NULL) {
382 into->name = from->name;
386 if (darray_empty(into->interps)) {
387 into->interps = from->interps;
388 darray_init(from->interps);
391 darray_foreach(si, from->interps) {
392 si->merge = (merge == MERGE_DEFAULT ? si->merge : merge);
393 if (!AddInterp(into, si, false))
398 if (darray_empty(into->leds)) {
399 into->leds = from->leds;
400 darray_init(from->leds);
403 darray_foreach(ledi, from->leds) {
404 ledi->merge = (merge == MERGE_DEFAULT ? ledi->merge : merge);
405 if (!AddLedMap(into, ledi, false))
412 HandleCompatMapFile(CompatInfo *info, XkbFile *file, enum merge_mode merge);
415 HandleIncludeCompatMap(CompatInfo *info, IncludeStmt *include)
419 InitCompatInfo(&included, info->keymap, info->actions);
420 included.name = include->stmt;
421 include->stmt = NULL;
423 for (IncludeStmt *stmt = include; stmt; stmt = stmt->next_incl) {
424 CompatInfo next_incl;
427 file = ProcessIncludeFile(info->ctx, stmt, FILE_TYPE_COMPAT);
429 info->errorCount += 10;
430 ClearCompatInfo(&included);
434 InitCompatInfo(&next_incl, info->keymap, info->actions);
435 next_incl.default_interp = info->default_interp;
436 next_incl.default_interp.merge = stmt->merge;
437 next_incl.default_led = info->default_led;
438 next_incl.default_led.merge = stmt->merge;
440 HandleCompatMapFile(&next_incl, file, MERGE_OVERRIDE);
442 MergeIncludedCompatMaps(&included, &next_incl, stmt->merge);
444 ClearCompatInfo(&next_incl);
448 MergeIncludedCompatMaps(info, &included, include->merge);
449 ClearCompatInfo(&included);
451 return (info->errorCount == 0);
455 SetInterpField(CompatInfo *info, SymInterpInfo *si, const char *field,
456 ExprDef *arrayNdx, ExprDef *value)
460 if (istreq(field, "action")) {
462 return ReportSINotArray(info, si, field);
464 if (!HandleActionDef(info->ctx, info->actions, &info->keymap->mods,
465 value, &si->interp.action))
468 si->defined |= SI_FIELD_ACTION;
470 else if (istreq(field, "virtualmodifier") ||
471 istreq(field, "virtualmod")) {
473 return ReportSINotArray(info, si, field);
475 if (!ExprResolveMod(info->ctx, value, MOD_VIRT, &info->keymap->mods,
477 return ReportSIBadType(info, si, field, "virtual modifier");
479 si->interp.virtual_mod = ndx;
480 si->defined |= SI_FIELD_VIRTUAL_MOD;
482 else if (istreq(field, "repeat")) {
486 return ReportSINotArray(info, si, field);
488 if (!ExprResolveBoolean(info->ctx, value, &set))
489 return ReportSIBadType(info, si, field, "boolean");
491 si->interp.repeat = set;
493 si->defined |= SI_FIELD_AUTO_REPEAT;
495 else if (istreq(field, "locking")) {
497 "The \"locking\" field in symbol interpretation is unsupported; "
500 else if (istreq(field, "usemodmap") ||
501 istreq(field, "usemodmapmods")) {
505 return ReportSINotArray(info, si, field);
507 if (!ExprResolveEnum(info->ctx, value, &val, useModMapValueNames))
508 return ReportSIBadType(info, si, field, "level specification");
510 si->interp.level_one_only = !!val;
511 si->defined |= SI_FIELD_LEVEL_ONE_ONLY;
514 return ReportBadField(info->ctx, "symbol interpretation", field,
522 SetLedMapField(CompatInfo *info, LedInfo *ledi, const char *field,
523 ExprDef *arrayNdx, ExprDef *value)
527 if (istreq(field, "modifiers") || istreq(field, "mods")) {
529 return ReportLedNotArray(info, ledi, field);
531 if (!ExprResolveModMask(info->ctx, value, MOD_BOTH,
532 &info->keymap->mods, &ledi->led.mods.mods))
533 return ReportLedBadType(info, ledi, field, "modifier mask");
535 ledi->defined |= LED_FIELD_MODS;
537 else if (istreq(field, "groups")) {
541 return ReportLedNotArray(info, ledi, field);
543 if (!ExprResolveMask(info->ctx, value, &mask, groupMaskNames))
544 return ReportLedBadType(info, ledi, field, "group mask");
546 ledi->led.groups = mask;
547 ledi->defined |= LED_FIELD_GROUPS;
549 else if (istreq(field, "controls") || istreq(field, "ctrls")) {
553 return ReportLedNotArray(info, ledi, field);
555 if (!ExprResolveMask(info->ctx, value, &mask, ctrlMaskNames))
556 return ReportLedBadType(info, ledi, field, "controls mask");
558 ledi->led.ctrls = mask;
559 ledi->defined |= LED_FIELD_CTRLS;
561 else if (istreq(field, "allowexplicit")) {
563 "The \"allowExplicit\" field in indicator statements is unsupported; "
566 else if (istreq(field, "whichmodstate") ||
567 istreq(field, "whichmodifierstate")) {
571 return ReportLedNotArray(info, ledi, field);
573 if (!ExprResolveMask(info->ctx, value, &mask,
574 modComponentMaskNames))
575 return ReportLedBadType(info, ledi, field,
576 "mask of modifier state components");
578 ledi->led.which_mods = mask;
580 else if (istreq(field, "whichgroupstate")) {
584 return ReportLedNotArray(info, ledi, field);
586 if (!ExprResolveMask(info->ctx, value, &mask,
587 groupComponentMaskNames))
588 return ReportLedBadType(info, ledi, field,
589 "mask of group state components");
591 ledi->led.which_groups = mask;
593 else if (istreq(field, "driveskbd") ||
594 istreq(field, "driveskeyboard") ||
595 istreq(field, "leddriveskbd") ||
596 istreq(field, "leddriveskeyboard") ||
597 istreq(field, "indicatordriveskbd") ||
598 istreq(field, "indicatordriveskeyboard")) {
600 "The \"%s\" field in indicator statements is unsupported; "
603 else if (istreq(field, "index")) {
604 /* Users should see this, it might cause unexpected behavior. */
606 "The \"index\" field in indicator statements is unsupported; "
611 "Unknown field %s in map for %s indicator; "
612 "Definition ignored\n",
613 field, xkb_atom_text(info->ctx, ledi->led.name));
621 HandleGlobalVar(CompatInfo *info, VarDef *stmt)
623 const char *elem, *field;
627 if (!ExprResolveLhs(info->ctx, stmt->name, &elem, &field, &ndx))
629 else if (elem && istreq(elem, "interpret"))
630 ret = SetInterpField(info, &info->default_interp, field, ndx,
632 else if (elem && istreq(elem, "indicator"))
633 ret = SetLedMapField(info, &info->default_led, field, ndx,
636 ret = SetActionField(info->ctx, info->actions, &info->keymap->mods,
637 elem, field, ndx, stmt->value);
642 HandleInterpBody(CompatInfo *info, VarDef *def, SymInterpInfo *si)
645 const char *elem, *field;
648 for (; def; def = (VarDef *) def->common.next) {
649 if (def->name && def->name->expr.op == EXPR_FIELD_REF) {
651 "Cannot set a global default value from within an interpret statement; "
652 "Move statements to the global file scope\n");
657 ok = ExprResolveLhs(info->ctx, def->name, &elem, &field, &arrayNdx);
661 ok = SetInterpField(info, si, field, arrayNdx, def->value);
668 HandleInterpDef(CompatInfo *info, InterpDef *def, enum merge_mode merge)
670 enum xkb_match_operation pred;
674 if (!ResolveStateAndPredicate(def->match, &pred, &mods, info)) {
676 "Couldn't determine matching modifiers; "
677 "Symbol interpretation ignored\n");
681 si = info->default_interp;
682 si.merge = merge = (def->merge == MERGE_DEFAULT ? merge : def->merge);
683 si.interp.sym = def->sym;
684 si.interp.match = pred;
685 si.interp.mods = mods;
687 if (!HandleInterpBody(info, def->def, &si)) {
692 if (!AddInterp(info, &si, true)) {
701 HandleLedMapDef(CompatInfo *info, LedMapDef *def, enum merge_mode merge)
707 if (def->merge != MERGE_DEFAULT)
710 ledi = info->default_led;
712 ledi.led.name = def->name;
715 for (var = def->body; var != NULL; var = (VarDef *) var->common.next) {
716 const char *elem, *field;
718 if (!ExprResolveLhs(info->ctx, var->name, &elem, &field, &arrayNdx)) {
725 "Cannot set defaults for \"%s\" element in indicator map; "
726 "Assignment to %s.%s ignored\n", elem, elem, field);
730 ok = SetLedMapField(info, &ledi, field, arrayNdx, var->value) && ok;
735 return AddLedMap(info, &ledi, true);
741 HandleCompatMapFile(CompatInfo *info, XkbFile *file, enum merge_mode merge)
745 merge = (merge == MERGE_DEFAULT ? MERGE_AUGMENT : merge);
748 info->name = strdup_safe(file->name);
750 for (ParseCommon *stmt = file->defs; stmt; stmt = stmt->next) {
751 switch (stmt->type) {
753 ok = HandleIncludeCompatMap(info, (IncludeStmt *) stmt);
756 ok = HandleInterpDef(info, (InterpDef *) stmt, merge);
758 case STMT_GROUP_COMPAT:
760 "The \"group\" statement in compat is unsupported; "
765 ok = HandleLedMapDef(info, (LedMapDef *) stmt, merge);
768 ok = HandleGlobalVar(info, (VarDef *) stmt);
771 ok = HandleVModDef(info->ctx, &info->keymap->mods,
772 (VModDef *) stmt, merge);
776 "Compat files may not include other types; "
777 "Ignoring %s\n", stmt_type_to_string(stmt->type));
785 if (info->errorCount > 10) {
787 "Abandoning compatibility map \"%s\"\n", file->topName);
793 /* Temporary struct for CopyInterps. */
795 darray(struct xkb_sym_interpret) sym_interprets;
799 CopyInterps(CompatInfo *info, bool needSymbol, enum xkb_match_operation pred,
800 struct collect *collect)
804 darray_foreach(si, info->interps)
805 if (si->interp.match == pred &&
806 (si->interp.sym != XKB_KEY_NoSymbol) == needSymbol)
807 darray_append(collect->sym_interprets, si->interp);
811 CopyLedMapDefs(CompatInfo *info)
816 struct xkb_keymap *keymap = info->keymap;
818 darray_foreach(ledi, info->leds) {
820 * Find the LED with the given name, if it was already declared
823 darray_enumerate(i, led, keymap->leds)
824 if (led->name == ledi->led.name)
827 /* Not previously declared; create it with next free index. */
828 if (i >= darray_size(keymap->leds)) {
830 "Indicator name \"%s\" was not declared in the keycodes section; "
831 "Adding new indicator\n",
832 xkb_atom_text(keymap->ctx, ledi->led.name));
834 darray_enumerate(i, led, keymap->leds)
835 if (led->name == XKB_ATOM_NONE)
838 if (i >= darray_size(keymap->leds)) {
839 /* Not place to put it; ignore. */
840 if (i >= XKB_MAX_LEDS) {
842 "Too many indicators (maximum is %d); "
843 "Indicator name \"%s\" ignored\n",
845 xkb_atom_text(keymap->ctx, ledi->led.name));
849 darray_resize(keymap->leds, i + 1);
850 led = &darray_item(keymap->leds, i);
855 if (led->groups != 0 && led->which_groups == 0)
856 led->which_groups = XKB_STATE_LAYOUT_EFFECTIVE;
857 if (led->mods.mods != 0 && led->which_mods == 0)
858 led->which_mods = XKB_STATE_MODS_EFFECTIVE;
863 CopyCompatToKeymap(struct xkb_keymap *keymap, CompatInfo *info)
865 keymap->compat_section_name = strdup_safe(info->name);
866 XkbEscapeMapName(keymap->compat_section_name);
868 if (!darray_empty(info->interps)) {
869 struct collect collect;
870 darray_init(collect.sym_interprets);
872 /* Most specific to least specific. */
873 CopyInterps(info, true, MATCH_EXACTLY, &collect);
874 CopyInterps(info, true, MATCH_ALL, &collect);
875 CopyInterps(info, true, MATCH_NONE, &collect);
876 CopyInterps(info, true, MATCH_ANY, &collect);
877 CopyInterps(info, true, MATCH_ANY_OR_NONE, &collect);
878 CopyInterps(info, false, MATCH_EXACTLY, &collect);
879 CopyInterps(info, false, MATCH_ALL, &collect);
880 CopyInterps(info, false, MATCH_NONE, &collect);
881 CopyInterps(info, false, MATCH_ANY, &collect);
882 CopyInterps(info, false, MATCH_ANY_OR_NONE, &collect);
884 keymap->num_sym_interprets = darray_size(collect.sym_interprets);
885 keymap->sym_interprets = darray_mem(collect.sym_interprets, 0);
888 CopyLedMapDefs(info);
894 CompileCompatMap(XkbFile *file, struct xkb_keymap *keymap,
895 enum merge_mode merge)
898 ActionsInfo *actions;
900 actions = NewActionsInfo();
904 InitCompatInfo(&info, keymap, actions);
905 info.default_interp.merge = merge;
906 info.default_led.merge = merge;
908 HandleCompatMapFile(&info, file, merge);
909 if (info.errorCount != 0)
912 if (!CopyCompatToKeymap(keymap, &info))
915 ClearCompatInfo(&info);
916 FreeActionsInfo(actions);
920 ClearCompatInfo(&info);
921 FreeActionsInfo(actions);