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->keymap, expr, MOD_REAL, mods_rtrn);
286 /***====================================================================***/
289 UseNewLEDField(enum led_field field, LedInfo *old, LedInfo *new,
290 bool report, enum led_field *collide)
292 if (!(old->defined & field))
295 if (new->defined & field) {
299 if (new->merge != MERGE_AUGMENT)
307 AddLedMap(CompatInfo *info, LedInfo *new, bool same_file)
310 enum led_field collide;
311 const int verbosity = xkb_context_get_log_verbosity(info->ctx);
312 const bool report = (same_file && verbosity > 0) || verbosity > 9;
314 darray_foreach(old, info->leds) {
315 if (old->led.name != new->led.name)
318 if (old->led.mods.mods == new->led.mods.mods &&
319 old->led.groups == new->led.groups &&
320 old->led.ctrls == new->led.ctrls &&
321 old->led.which_mods == new->led.which_mods &&
322 old->led.which_groups == new->led.which_groups) {
323 old->defined |= new->defined;
327 if (new->merge == MERGE_REPLACE) {
330 "Map for indicator %s redefined; "
331 "Earlier definition ignored\n",
332 xkb_atom_text(info->ctx, old->led.name));
338 if (UseNewLEDField(LED_FIELD_MODS, old, new, report, &collide)) {
339 old->led.which_mods = new->led.which_mods;
340 old->led.mods = new->led.mods;
341 old->defined |= LED_FIELD_MODS;
343 if (UseNewLEDField(LED_FIELD_GROUPS, old, new, report, &collide)) {
344 old->led.which_groups = new->led.which_groups;
345 old->led.groups = new->led.groups;
346 old->defined |= LED_FIELD_GROUPS;
348 if (UseNewLEDField(LED_FIELD_CTRLS, old, new, report, &collide)) {
349 old->led.ctrls = new->led.ctrls;
350 old->defined |= LED_FIELD_CTRLS;
355 "Map for indicator %s redefined; "
356 "Using %s definition for duplicate fields\n",
357 xkb_atom_text(info->ctx, old->led.name),
358 (new->merge == MERGE_AUGMENT ? "first" : "last"));
364 darray_append(info->leds, *new);
369 MergeIncludedCompatMaps(CompatInfo *into, CompatInfo *from,
370 enum merge_mode merge)
375 if (from->errorCount > 0) {
376 into->errorCount += from->errorCount;
380 if (into->name == NULL) {
381 into->name = from->name;
385 if (darray_empty(into->interps)) {
386 into->interps = from->interps;
387 darray_init(from->interps);
390 darray_foreach(si, from->interps) {
391 si->merge = (merge == MERGE_DEFAULT ? si->merge : merge);
392 if (!AddInterp(into, si, false))
397 if (darray_empty(into->leds)) {
398 into->leds = from->leds;
399 darray_init(from->leds);
402 darray_foreach(ledi, from->leds) {
403 ledi->merge = (merge == MERGE_DEFAULT ? ledi->merge : merge);
404 if (!AddLedMap(into, ledi, false))
411 HandleCompatMapFile(CompatInfo *info, XkbFile *file, enum merge_mode merge);
414 HandleIncludeCompatMap(CompatInfo *info, IncludeStmt *include)
418 InitCompatInfo(&included, info->keymap, info->actions);
419 included.name = include->stmt;
420 include->stmt = NULL;
422 for (IncludeStmt *stmt = include; stmt; stmt = stmt->next_incl) {
423 CompatInfo next_incl;
426 file = ProcessIncludeFile(info->ctx, stmt, FILE_TYPE_COMPAT);
428 info->errorCount += 10;
429 ClearCompatInfo(&included);
433 InitCompatInfo(&next_incl, info->keymap, info->actions);
434 next_incl.default_interp = info->default_interp;
435 next_incl.default_interp.merge = stmt->merge;
436 next_incl.default_led = info->default_led;
437 next_incl.default_led.merge = stmt->merge;
439 HandleCompatMapFile(&next_incl, file, MERGE_OVERRIDE);
441 MergeIncludedCompatMaps(&included, &next_incl, stmt->merge);
443 ClearCompatInfo(&next_incl);
447 MergeIncludedCompatMaps(info, &included, include->merge);
448 ClearCompatInfo(&included);
450 return (info->errorCount == 0);
454 SetInterpField(CompatInfo *info, SymInterpInfo *si, const char *field,
455 ExprDef *arrayNdx, ExprDef *value)
459 if (istreq(field, "action")) {
461 return ReportSINotArray(info, si, field);
463 if (!HandleActionDef(value, info->keymap, &si->interp.action,
467 si->defined |= SI_FIELD_ACTION;
469 else if (istreq(field, "virtualmodifier") ||
470 istreq(field, "virtualmod")) {
472 return ReportSINotArray(info, si, field);
474 if (!ExprResolveMod(info->keymap, value, MOD_VIRT, &ndx))
475 return ReportSIBadType(info, si, field, "virtual modifier");
477 si->interp.virtual_mod = ndx;
478 si->defined |= SI_FIELD_VIRTUAL_MOD;
480 else if (istreq(field, "repeat")) {
484 return ReportSINotArray(info, si, field);
486 if (!ExprResolveBoolean(info->ctx, value, &set))
487 return ReportSIBadType(info, si, field, "boolean");
489 si->interp.repeat = set;
491 si->defined |= SI_FIELD_AUTO_REPEAT;
493 else if (istreq(field, "locking")) {
495 "The \"locking\" field in symbol interpretation is unsupported; "
498 else if (istreq(field, "usemodmap") ||
499 istreq(field, "usemodmapmods")) {
503 return ReportSINotArray(info, si, field);
505 if (!ExprResolveEnum(info->ctx, value, &val, useModMapValueNames))
506 return ReportSIBadType(info, si, field, "level specification");
508 si->interp.level_one_only = !!val;
509 si->defined |= SI_FIELD_LEVEL_ONE_ONLY;
512 return ReportBadField(info->ctx, "symbol interpretation", field,
520 SetLedMapField(CompatInfo *info, LedInfo *ledi, const char *field,
521 ExprDef *arrayNdx, ExprDef *value)
525 if (istreq(field, "modifiers") || istreq(field, "mods")) {
527 return ReportLedNotArray(info, ledi, field);
529 if (!ExprResolveModMask(info->keymap, value, MOD_BOTH,
530 &ledi->led.mods.mods))
531 return ReportLedBadType(info, ledi, field, "modifier mask");
533 ledi->defined |= LED_FIELD_MODS;
535 else if (istreq(field, "groups")) {
539 return ReportLedNotArray(info, ledi, field);
541 if (!ExprResolveMask(info->ctx, value, &mask, groupMaskNames))
542 return ReportLedBadType(info, ledi, field, "group mask");
544 ledi->led.groups = mask;
545 ledi->defined |= LED_FIELD_GROUPS;
547 else if (istreq(field, "controls") || istreq(field, "ctrls")) {
551 return ReportLedNotArray(info, ledi, field);
553 if (!ExprResolveMask(info->ctx, value, &mask, ctrlMaskNames))
554 return ReportLedBadType(info, ledi, field, "controls mask");
556 ledi->led.ctrls = mask;
557 ledi->defined |= LED_FIELD_CTRLS;
559 else if (istreq(field, "allowexplicit")) {
561 "The \"allowExplicit\" field in indicator statements is unsupported; "
564 else if (istreq(field, "whichmodstate") ||
565 istreq(field, "whichmodifierstate")) {
569 return ReportLedNotArray(info, ledi, field);
571 if (!ExprResolveMask(info->ctx, value, &mask,
572 modComponentMaskNames))
573 return ReportLedBadType(info, ledi, field,
574 "mask of modifier state components");
576 ledi->led.which_mods = mask;
578 else if (istreq(field, "whichgroupstate")) {
582 return ReportLedNotArray(info, ledi, field);
584 if (!ExprResolveMask(info->ctx, value, &mask,
585 groupComponentMaskNames))
586 return ReportLedBadType(info, ledi, field,
587 "mask of group state components");
589 ledi->led.which_groups = mask;
591 else if (istreq(field, "driveskbd") ||
592 istreq(field, "driveskeyboard") ||
593 istreq(field, "leddriveskbd") ||
594 istreq(field, "leddriveskeyboard") ||
595 istreq(field, "indicatordriveskbd") ||
596 istreq(field, "indicatordriveskeyboard")) {
598 "The \"%s\" field in indicator statements is unsupported; "
601 else if (istreq(field, "index")) {
602 /* Users should see this, it might cause unexpected behavior. */
604 "The \"index\" field in indicator statements is unsupported; "
609 "Unknown field %s in map for %s indicator; "
610 "Definition ignored\n",
611 field, xkb_atom_text(info->ctx, ledi->led.name));
619 HandleGlobalVar(CompatInfo *info, VarDef *stmt)
621 const char *elem, *field;
625 if (!ExprResolveLhs(info->ctx, stmt->name, &elem, &field, &ndx))
627 else if (elem && istreq(elem, "interpret"))
628 ret = SetInterpField(info, &info->default_interp, field, ndx,
630 else if (elem && istreq(elem, "indicator"))
631 ret = SetLedMapField(info, &info->default_led, field, ndx,
634 ret = SetActionField(info->keymap, elem, field, ndx, stmt->value,
640 HandleInterpBody(CompatInfo *info, VarDef *def, SymInterpInfo *si)
643 const char *elem, *field;
646 for (; def; def = (VarDef *) def->common.next) {
647 if (def->name && def->name->expr.op == EXPR_FIELD_REF) {
649 "Cannot set a global default value from within an interpret statement; "
650 "Move statements to the global file scope\n");
655 ok = ExprResolveLhs(info->ctx, def->name, &elem, &field, &arrayNdx);
659 ok = SetInterpField(info, si, field, arrayNdx, def->value);
666 HandleInterpDef(CompatInfo *info, InterpDef *def, enum merge_mode merge)
668 enum xkb_match_operation pred;
672 if (!ResolveStateAndPredicate(def->match, &pred, &mods, info)) {
674 "Couldn't determine matching modifiers; "
675 "Symbol interpretation ignored\n");
679 si = info->default_interp;
680 si.merge = merge = (def->merge == MERGE_DEFAULT ? merge : def->merge);
681 si.interp.sym = def->sym;
682 si.interp.match = pred;
683 si.interp.mods = mods;
685 if (!HandleInterpBody(info, def->def, &si)) {
690 if (!AddInterp(info, &si, true)) {
699 HandleLedMapDef(CompatInfo *info, LedMapDef *def, enum merge_mode merge)
705 if (def->merge != MERGE_DEFAULT)
708 ledi = info->default_led;
710 ledi.led.name = def->name;
713 for (var = def->body; var != NULL; var = (VarDef *) var->common.next) {
714 const char *elem, *field;
716 if (!ExprResolveLhs(info->ctx, var->name, &elem, &field, &arrayNdx)) {
723 "Cannot set defaults for \"%s\" element in indicator map; "
724 "Assignment to %s.%s ignored\n", elem, elem, field);
728 ok = SetLedMapField(info, &ledi, field, arrayNdx, var->value) && ok;
733 return AddLedMap(info, &ledi, true);
739 HandleCompatMapFile(CompatInfo *info, XkbFile *file, enum merge_mode merge)
743 merge = (merge == MERGE_DEFAULT ? MERGE_AUGMENT : merge);
746 info->name = strdup_safe(file->name);
748 for (ParseCommon *stmt = file->defs; stmt; stmt = stmt->next) {
749 switch (stmt->type) {
751 ok = HandleIncludeCompatMap(info, (IncludeStmt *) stmt);
754 ok = HandleInterpDef(info, (InterpDef *) stmt, merge);
756 case STMT_GROUP_COMPAT:
758 "The \"group\" statement in compat is unsupported; "
763 ok = HandleLedMapDef(info, (LedMapDef *) stmt, merge);
766 ok = HandleGlobalVar(info, (VarDef *) stmt);
769 ok = HandleVModDef(info->keymap, (VModDef *) stmt, merge);
773 "Compat files may not include other types; "
774 "Ignoring %s\n", stmt_type_to_string(stmt->type));
782 if (info->errorCount > 10) {
784 "Abandoning compatibility map \"%s\"\n", file->topName);
790 /* Temporary struct for CopyInterps. */
792 darray(struct xkb_sym_interpret) sym_interprets;
796 CopyInterps(CompatInfo *info, bool needSymbol, enum xkb_match_operation pred,
797 struct collect *collect)
801 darray_foreach(si, info->interps)
802 if (si->interp.match == pred &&
803 (si->interp.sym != XKB_KEY_NoSymbol) == needSymbol)
804 darray_append(collect->sym_interprets, si->interp);
808 CopyLedMapDefs(CompatInfo *info)
813 struct xkb_keymap *keymap = info->keymap;
815 darray_foreach(ledi, info->leds) {
817 * Find the LED with the given name, if it was already declared
820 darray_enumerate(i, led, keymap->leds)
821 if (led->name == ledi->led.name)
824 /* Not previously declared; create it with next free index. */
825 if (i >= darray_size(keymap->leds)) {
827 "Indicator name \"%s\" was not declared in the keycodes section; "
828 "Adding new indicator\n",
829 xkb_atom_text(keymap->ctx, ledi->led.name));
831 darray_enumerate(i, led, keymap->leds)
832 if (led->name == XKB_ATOM_NONE)
835 if (i >= darray_size(keymap->leds)) {
836 /* Not place to put it; ignore. */
837 if (i >= XKB_MAX_LEDS) {
839 "Too many indicators (maximum is %d); "
840 "Indicator name \"%s\" ignored\n",
842 xkb_atom_text(keymap->ctx, ledi->led.name));
846 darray_resize(keymap->leds, i + 1);
847 led = &darray_item(keymap->leds, i);
852 if (led->groups != 0 && led->which_groups == 0)
853 led->which_groups = XKB_STATE_LAYOUT_EFFECTIVE;
854 if (led->mods.mods != 0 && led->which_mods == 0)
855 led->which_mods = XKB_STATE_MODS_EFFECTIVE;
860 CopyCompatToKeymap(struct xkb_keymap *keymap, CompatInfo *info)
862 keymap->compat_section_name = strdup_safe(info->name);
863 XkbEscapeMapName(keymap->compat_section_name);
865 if (!darray_empty(info->interps)) {
866 struct collect collect;
867 darray_init(collect.sym_interprets);
869 /* Most specific to least specific. */
870 CopyInterps(info, true, MATCH_EXACTLY, &collect);
871 CopyInterps(info, true, MATCH_ALL, &collect);
872 CopyInterps(info, true, MATCH_NONE, &collect);
873 CopyInterps(info, true, MATCH_ANY, &collect);
874 CopyInterps(info, true, MATCH_ANY_OR_NONE, &collect);
875 CopyInterps(info, false, MATCH_EXACTLY, &collect);
876 CopyInterps(info, false, MATCH_ALL, &collect);
877 CopyInterps(info, false, MATCH_NONE, &collect);
878 CopyInterps(info, false, MATCH_ANY, &collect);
879 CopyInterps(info, false, MATCH_ANY_OR_NONE, &collect);
881 keymap->num_sym_interprets = darray_size(collect.sym_interprets);
882 keymap->sym_interprets = darray_mem(collect.sym_interprets, 0);
885 CopyLedMapDefs(info);
891 CompileCompatMap(XkbFile *file, struct xkb_keymap *keymap,
892 enum merge_mode merge)
895 ActionsInfo *actions;
897 actions = NewActionsInfo();
901 InitCompatInfo(&info, keymap, actions);
902 info.default_interp.merge = merge;
903 info.default_led.merge = merge;
905 HandleCompatMapFile(&info, file, merge);
906 if (info.errorCount != 0)
909 if (!CopyCompatToKeymap(keymap, &info))
912 ClearCompatInfo(&info);
913 FreeActionsInfo(actions);
917 ClearCompatInfo(&info);
918 FreeActionsInfo(actions);