src/xkbcomp/compat.c

   1 /************************************************************
   2  * Copyright (c) 1994 by Silicon Graphics Computer Systems, Inc.
   3  *
   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.
  15  *
  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.
  24  *
  25  ********************************************************/
  26
  27 #include "xkbcomp-priv.h"
  28 #include "parseutils.h"
  29 #include "action.h"
  30 #include "vmod.h"
  31
  32 enum si_field {
  33     SI_FIELD_VIRTUAL_MOD    = (1 << 0),
  34     SI_FIELD_ACTION         = (1 << 1),
  35     SI_FIELD_AUTO_REPEAT    = (1 << 2),
  36     SI_FIELD_LOCKING_KEY    = (1 << 3),
  37     SI_FIELD_LEVEL_ONE_ONLY = (1 << 4),
  38 };
  39
  40 typedef struct _SymInterpInfo {
  41     enum si_field defined;
  42     unsigned file_id;
  43     enum merge_mode merge;
  44     struct list entry;
  45
  46     struct xkb_sym_interpret interp;
  47 } SymInterpInfo;
  48
  49 enum led_field {
  50     LED_FIELD_INDEX      = (1 << 0),
  51     LED_FIELD_MODS       = (1 << 1),
  52     LED_FIELD_GROUPS     = (1 << 2),
  53     LED_FIELD_CTRLS      = (1 << 3),
  54     LED_FIELD_EXPLICIT   = (1 << 4),
  55     LED_FIELD_AUTOMATIC  = (1 << 5),
  56     LED_FIELD_DRIVES_KBD = (1 << 6),
  57 };
  58
  59 typedef struct _LEDInfo {
  60     enum led_field defined;
  61     unsigned file_id;
  62     enum merge_mode merge;
  63     struct list entry;
  64
  65     xkb_atom_t name;
  66     xkb_led_index_t indicator;
  67     unsigned char flags;
  68     unsigned char which_mods;
  69     unsigned char real_mods;
  70     xkb_mod_mask_t vmods;
  71     unsigned char which_groups;
  72     uint32_t groups;
  73     unsigned int ctrls;
  74 } LEDInfo;
  75
  76 typedef struct _GroupCompatInfo {
  77     unsigned file_id;
  78     enum merge_mode merge;
  79     bool defined;
  80     unsigned char real_mods;
  81     xkb_atom_t vmods;
  82 } GroupCompatInfo;
  83
  84 typedef struct _CompatInfo {
  85     char *name;
  86     unsigned file_id;
  87     int errorCount;
  88     int nInterps;
  89     struct list interps;
  90     SymInterpInfo dflt;
  91     LEDInfo ledDflt;
  92     GroupCompatInfo groupCompat[XkbNumKbdGroups];
  93     struct list leds;
  94     VModInfo vmods;
  95     ActionInfo *act;
  96     struct xkb_keymap *keymap;
  97 } CompatInfo;
  98
  99 static const char *
 100 siText(SymInterpInfo * si, CompatInfo * info)
 101 {
 102     static char buf[128];
 103
 104     if (si == &info->dflt) {
 105         snprintf(buf, sizeof(buf), "default");
 106     }
 107     else {
 108         snprintf(buf, sizeof(buf), "%s+%s(%s)",
 109                  KeysymText(si->interp.sym),
 110                  SIMatchText(si->interp.match),
 111                  ModMaskText(si->interp.mods, false));
 112     }
 113     return buf;
 114 }
 115
 116 static inline bool
 117 ReportSINotArray(CompatInfo *info, SymInterpInfo *si, const char *field)
 118 {
 119     return ReportNotArray(info->keymap, "symbol interpretation", field,
 120                           siText(si, info));
 121 }
 122
 123 static inline bool
 124 ReportSIBadType(CompatInfo *info, SymInterpInfo *si, const char *field,
 125                 const char *wanted)
 126 {
 127     return ReportBadType(info->keymap, "symbol interpretation", field,
 128                          siText(si, info), wanted);
 129 }
 130
 131 static inline bool
 132 ReportIndicatorBadType(CompatInfo *info, LEDInfo *led,
 133                        const char *field, const char *wanted)
 134 {
 135     return ReportBadType(info->keymap, "indicator map", field,
 136                          xkb_atom_text(info->keymap->ctx, led->name),
 137                          wanted);
 138 }
 139
 140 static inline bool
 141 ReportIndicatorNotArray(CompatInfo *info, LEDInfo *led,
 142                         const char *field)
 143 {
 144     return ReportNotArray(info->keymap, "indicator map", field,
 145                           xkb_atom_text(info->keymap->ctx, led->name));
 146 }
 147
 148 static void
 149 ClearIndicatorMapInfo(struct xkb_context *ctx, LEDInfo * info)
 150 {
 151     info->name = xkb_atom_intern(ctx, "default");
 152     info->indicator = XKB_LED_INVALID;
 153     info->flags = info->which_mods = info->real_mods = 0;
 154     info->vmods = 0;
 155     info->which_groups = info->groups = 0;
 156     info->ctrls = 0;
 157 }
 158
 159 static void
 160 InitCompatInfo(CompatInfo *info, struct xkb_keymap *keymap, unsigned file_id)
 161 {
 162     unsigned int i;
 163
 164     info->keymap = keymap;
 165     info->name = NULL;
 166     info->file_id = file_id;
 167     info->errorCount = 0;
 168     info->nInterps = 0;
 169     list_init(&info->interps);
 170     info->act = NULL;
 171     info->dflt.file_id = file_id;
 172     info->dflt.defined = 0;
 173     info->dflt.merge = MERGE_OVERRIDE;
 174     info->dflt.interp.flags = 0;
 175     info->dflt.interp.virtual_mod = XkbNoModifier;
 176     info->dflt.interp.act.type = XkbSA_NoAction;
 177     for (i = 0; i < sizeof(info->dflt.interp.act.any.data); i++)
 178         info->dflt.interp.act.any.data[i] = 0;
 179     ClearIndicatorMapInfo(keymap->ctx, &info->ledDflt);
 180     info->ledDflt.file_id = file_id;
 181     info->ledDflt.defined = 0;
 182     info->ledDflt.merge = MERGE_OVERRIDE;
 183     memset(&info->groupCompat[0], 0,
 184            XkbNumKbdGroups * sizeof(GroupCompatInfo));
 185     list_init(&info->leds);
 186     InitVModInfo(&info->vmods, keymap);
 187 }
 188
 189 static void
 190 ClearCompatInfo(CompatInfo *info)
 191 {
 192     unsigned int i;
 193     ActionInfo *next_act;
 194     SymInterpInfo *si, *next_si;
 195     LEDInfo *led, *next_led;
 196     struct xkb_keymap *keymap = info->keymap;
 197
 198     free(info->name);
 199     info->name = NULL;
 200     info->dflt.defined = 0;
 201     info->dflt.merge = MERGE_AUGMENT;
 202     info->dflt.interp.flags = 0;
 203     info->dflt.interp.virtual_mod = XkbNoModifier;
 204     info->dflt.interp.act.type = XkbSA_NoAction;
 205     for (i = 0; i < sizeof(info->dflt.interp.act.any.data); i++)
 206         info->dflt.interp.act.any.data[i] = 0;
 207     ClearIndicatorMapInfo(keymap->ctx, &info->ledDflt);
 208     info->nInterps = 0;
 209     list_foreach_safe(si, next_si, &info->interps, entry)
 210         free(si);
 211     memset(&info->groupCompat[0], 0,
 212            XkbNumKbdGroups * sizeof(GroupCompatInfo));
 213     list_foreach_safe(led, next_led, &info->leds, entry)
 214         free(led);
 215     while (info->act) {
 216         next_act = info->act->next;
 217         free(info->act);
 218         info->act = next_act;
 219     }
 220     info->keymap = NULL;
 221     ClearVModInfo(&info->vmods, keymap);
 222 }
 223
 224 static SymInterpInfo *
 225 NextInterp(CompatInfo * info)
 226 {
 227     SymInterpInfo *si;
 228
 229     si = calloc(1, sizeof(*si));
 230     if (!si)
 231         return NULL;
 232
 233     list_append(&si->entry, &info->interps);
 234     info->nInterps++;
 235
 236     return si;
 237 }
 238
 239 static SymInterpInfo *
 240 FindMatchingInterp(CompatInfo * info, SymInterpInfo * new)
 241 {
 242     SymInterpInfo *old;
 243
 244     list_foreach(old, &info->interps, entry)
 245         if (old->interp.sym == new->interp.sym &&
 246             old->interp.mods == new->interp.mods &&
 247             old->interp.match == new->interp.match)
 248             return old;
 249
 250     return NULL;
 251 }
 252
 253 static bool
 254 UseNewInterpField(enum si_field field, SymInterpInfo *old, SymInterpInfo *new,
 255                   int verbosity, enum si_field *collide)
 256 {
 257     if (!(old->defined & field))
 258         return true;
 259
 260     if (new->defined & field) {
 261         if ((old->file_id == new->file_id && verbosity > 0) || verbosity > 9)
 262             *collide |= field;
 263
 264         if (new->merge != MERGE_AUGMENT)
 265             return true;
 266     }
 267
 268     return false;
 269 }
 270
 271 static bool
 272 AddInterp(CompatInfo * info, SymInterpInfo * new)
 273 {
 274     enum si_field collide;
 275     SymInterpInfo *old;
 276     struct list entry;
 277     int verbosity = xkb_get_log_verbosity(info->keymap->ctx);
 278
 279     collide = 0;
 280     old = FindMatchingInterp(info, new);
 281     if (old != NULL) {
 282         if (new->merge == MERGE_REPLACE) {
 283             entry = old->entry;
 284             if ((old->file_id == new->file_id && verbosity > 0) ||
 285                 verbosity > 9)
 286                 log_warn(info->keymap->ctx,
 287                          "Multiple definitions for \"%s\"; "
 288                          "Earlier interpretation ignored\n",
 289                          siText(new, info));
 290             *old = *new;
 291             old->entry = entry;
 292             return true;
 293         }
 294
 295         if (UseNewInterpField(SI_FIELD_VIRTUAL_MOD, old, new, verbosity,
 296                               &collide)) {
 297             old->interp.virtual_mod = new->interp.virtual_mod;
 298             old->defined |= SI_FIELD_VIRTUAL_MOD;
 299         }
 300         if (UseNewInterpField(SI_FIELD_ACTION, old, new, verbosity,
 301                               &collide)) {
 302             old->interp.act = new->interp.act;
 303             old->defined |= SI_FIELD_ACTION;
 304         }
 305         if (UseNewInterpField(SI_FIELD_AUTO_REPEAT, old, new, verbosity,
 306                               &collide)) {
 307             old->interp.flags &= ~XkbSI_AutoRepeat;
 308             old->interp.flags |= (new->interp.flags & XkbSI_AutoRepeat);
 309             old->defined |= SI_FIELD_AUTO_REPEAT;
 310         }
 311         if (UseNewInterpField(SI_FIELD_LOCKING_KEY, old, new, verbosity,
 312                               &collide)) {
 313             old->interp.flags &= ~XkbSI_LockingKey;
 314             old->interp.flags |= (new->interp.flags & XkbSI_LockingKey);
 315             old->defined |= SI_FIELD_LOCKING_KEY;
 316         }
 317         if (UseNewInterpField(SI_FIELD_LEVEL_ONE_ONLY, old, new, verbosity,
 318                               &collide)) {
 319             old->interp.match &= ~XkbSI_LevelOneOnly;
 320             old->interp.match |= (new->interp.match & XkbSI_LevelOneOnly);
 321             old->defined |= SI_FIELD_LEVEL_ONE_ONLY;
 322         }
 323
 324         if (collide) {
 325             log_warn(info->keymap->ctx,
 326                      "Multiple interpretations of \"%s\"; "
 327                      "Using %s definition for duplicate fields\n",
 328                      siText(new, info),
 329                      (new->merge != MERGE_AUGMENT ? "last" : "first"));
 330         }
 331
 332         return true;
 333     }
 334
 335     old = new;
 336     if ((new = NextInterp(info)) == NULL)
 337         return false;
 338     entry = new->entry;
 339     *new = *old;
 340     new->entry = entry;
 341     return true;
 342 }
 343
 344 static bool
 345 AddGroupCompat(CompatInfo *info, xkb_group_index_t group, GroupCompatInfo *new)
 346 {
 347     GroupCompatInfo *gc;
 348     int verbosity = xkb_get_log_verbosity(info->keymap->ctx);
 349
 350     gc = &info->groupCompat[group];
 351     if (gc->real_mods == new->real_mods && gc->vmods == new->vmods)
 352         return true;
 353
 354     if ((gc->file_id == new->file_id && verbosity > 0) || verbosity > 9)
 355         log_warn(info->keymap->ctx,
 356                  "Compat map for group %u redefined; "
 357                  "Using %s definition\n",
 358                  group + 1, (new->merge == MERGE_AUGMENT ? "old" : "new"));
 359
 360     if (new->defined && (new->merge != MERGE_AUGMENT || !gc->defined))
 361         *gc = *new;
 362
 363     return true;
 364 }
 365
 366 /***====================================================================***/
 367
 368 static bool
 369 ResolveStateAndPredicate(ExprDef * expr,
 370                          unsigned *pred_rtrn,
 371                          xkb_mod_mask_t *mods_rtrn, CompatInfo * info)
 372 {
 373     if (expr == NULL) {
 374         *pred_rtrn = XkbSI_AnyOfOrNone;
 375         *mods_rtrn = ~0;
 376         return true;
 377     }
 378
 379     *pred_rtrn = XkbSI_Exactly;
 380     if (expr->op == EXPR_ACTION_DECL) {
 381         const char *pred_txt = xkb_atom_text(info->keymap->ctx,
 382                                              expr->value.action.name);
 383         if (istreq(pred_txt, "noneof"))
 384             *pred_rtrn = XkbSI_NoneOf;
 385         else if (istreq(pred_txt, "anyofornone"))
 386             *pred_rtrn = XkbSI_AnyOfOrNone;
 387         else if (istreq(pred_txt, "anyof"))
 388             *pred_rtrn = XkbSI_AnyOf;
 389         else if (istreq(pred_txt, "allof"))
 390             *pred_rtrn = XkbSI_AllOf;
 391         else if (istreq(pred_txt, "exactly"))
 392             *pred_rtrn = XkbSI_Exactly;
 393         else {
 394             log_err(info->keymap->ctx,
 395                     "Illegal modifier predicate \"%s\"; Ignored\n", pred_txt);
 396             return false;
 397         }
 398         expr = expr->value.action.args;
 399     }
 400     else if (expr->op == EXPR_IDENT) {
 401         const char *pred_txt = xkb_atom_text(info->keymap->ctx,
 402                                              expr->value.str);
 403         if (pred_txt && istreq(pred_txt, "any")) {
 404             *pred_rtrn = XkbSI_AnyOf;
 405             *mods_rtrn = 0xff;
 406             return true;
 407         }
 408     }
 409
 410     return ExprResolveModMask(info->keymap->ctx, expr, mods_rtrn);
 411 }
 412
 413 /***====================================================================***/
 414
 415 static bool
 416 UseNewLEDField(enum led_field field, LEDInfo *old, LEDInfo *new,
 417                int verbosity, enum led_field *collide)
 418 {
 419     if (!(old->defined & field))
 420         return true;
 421
 422     if (new->defined & field) {
 423         if ((old->file_id == new->file_id && verbosity > 0) || verbosity > 9)
 424             *collide |= field;
 425
 426         if (new->merge != MERGE_AUGMENT)
 427             return true;
 428     }
 429
 430     return false;
 431 }
 432
 433 static bool
 434 AddIndicatorMap(CompatInfo *info, LEDInfo *new)
 435 {
 436     LEDInfo *old;
 437     enum led_field collide;
 438     struct xkb_context *ctx = info->keymap->ctx;
 439     int verbosity = xkb_get_log_verbosity(ctx);
 440
 441     list_foreach(old, &info->leds, entry) {
 442         if (old->name == new->name) {
 443             if ((old->real_mods == new->real_mods) &&
 444                 (old->vmods == new->vmods) &&
 445                 (old->groups == new->groups) &&
 446                 (old->ctrls == new->ctrls) &&
 447                 (old->which_mods == new->which_mods) &&
 448                 (old->which_groups == new->which_groups)) {
 449                 old->defined |= new->defined;
 450                 return true;
 451             }
 452
 453             if (new->merge == MERGE_REPLACE) {
 454                 struct list entry = old->entry;
 455                 if ((old->file_id == new->file_id && verbosity > 0) ||
 456                     verbosity > 9)
 457                     log_warn(info->keymap->ctx,
 458                              "Map for indicator %s redefined; "
 459                              "Earlier definition ignored\n",
 460                              xkb_atom_text(ctx, old->name));
 461                 *old = *new;
 462                 old->entry = entry;
 463                 return true;
 464             }
 465
 466             collide = 0;
 467             if (UseNewLEDField(LED_FIELD_INDEX, old, new, verbosity,
 468                                &collide)) {
 469                 old->indicator = new->indicator;
 470                 old->defined |= LED_FIELD_INDEX;
 471             }
 472             if (UseNewLEDField(LED_FIELD_MODS, old, new, verbosity,
 473                                &collide)) {
 474                 old->which_mods = new->which_mods;
 475                 old->real_mods = new->real_mods;
 476                 old->vmods = new->vmods;
 477                 old->defined |= LED_FIELD_MODS;
 478             }
 479             if (UseNewLEDField(LED_FIELD_GROUPS, old, new, verbosity,
 480                                &collide)) {
 481                 old->which_groups = new->which_groups;
 482                 old->groups = new->groups;
 483                 old->defined |= LED_FIELD_GROUPS;
 484             }
 485             if (UseNewLEDField(LED_FIELD_CTRLS, old, new, verbosity,
 486                                &collide)) {
 487                 old->ctrls = new->ctrls;
 488                 old->defined |= LED_FIELD_CTRLS;
 489             }
 490             if (UseNewLEDField(LED_FIELD_EXPLICIT, old, new, verbosity,
 491                                &collide)) {
 492                 old->flags &= ~XkbIM_NoExplicit;
 493                 old->flags |= (new->flags & XkbIM_NoExplicit);
 494                 old->defined |= LED_FIELD_EXPLICIT;
 495             }
 496             if (UseNewLEDField(LED_FIELD_AUTOMATIC, old, new, verbosity,
 497                                &collide)) {
 498                 old->flags &= ~XkbIM_NoAutomatic;
 499                 old->flags |= (new->flags & XkbIM_NoAutomatic);
 500                 old->defined |= LED_FIELD_AUTOMATIC;
 501             }
 502             if (UseNewLEDField(LED_FIELD_DRIVES_KBD, old, new, verbosity,
 503                                &collide)) {
 504                 old->flags &= ~XkbIM_LEDDrivesKB;
 505                 old->flags |= (new->flags & XkbIM_LEDDrivesKB);
 506                 old->defined |= LED_FIELD_DRIVES_KBD;
 507             }
 508
 509             if (collide) {
 510                 log_warn(info->keymap->ctx,
 511                          "Map for indicator %s redefined; "
 512                          "Using %s definition for duplicate fields\n",
 513                          xkb_atom_text(ctx, old->name),
 514                          (new->merge == MERGE_AUGMENT ? "first" : "last"));
 515             }
 516
 517             return true;
 518         }
 519     }
 520
 521     /* new definition */
 522     old = malloc(sizeof(*old));
 523     if (!old) {
 524         log_wsgo(info->keymap->ctx,
 525                  "Couldn't allocate indicator map; "
 526                  "Map for indicator %s not compiled\n",
 527                  xkb_atom_text(ctx, new->name));
 528         return false;
 529     }
 530
 531     *old = *new;
 532     list_append(&old->entry, &info->leds);
 533
 534     return true;
 535 }
 536
 537 static void
 538 MergeIncludedCompatMaps(CompatInfo * into, CompatInfo * from,
 539                         enum merge_mode merge)
 540 {
 541     SymInterpInfo *si;
 542     LEDInfo *led, *next_led;
 543     GroupCompatInfo *gcm;
 544     xkb_group_index_t i;
 545
 546     if (from->errorCount > 0) {
 547         into->errorCount += from->errorCount;
 548         return;
 549     }
 550     if (into->name == NULL) {
 551         into->name = from->name;
 552         from->name = NULL;
 553     }
 554
 555     list_foreach(si, &from->interps, entry) {
 556         if (merge != MERGE_DEFAULT)
 557             si->merge = merge;
 558         if (!AddInterp(into, si))
 559             into->errorCount++;
 560     }
 561
 562     for (i = 0, gcm = &from->groupCompat[0]; i < XkbNumKbdGroups;
 563          i++, gcm++) {
 564         if (merge != MERGE_DEFAULT)
 565             gcm->merge = merge;
 566         if (!AddGroupCompat(into, i, gcm))
 567             into->errorCount++;
 568     }
 569
 570     list_foreach_safe(led, next_led, &from->leds, entry) {
 571         led->merge = (merge == MERGE_DEFAULT ? led->merge : merge);
 572         if (!AddIndicatorMap(into, led))
 573             into->errorCount++;
 574     }
 575 }
 576
 577 static void
 578 HandleCompatMapFile(CompatInfo *info, XkbFile *file, enum merge_mode merge);
 579
 580 static bool
 581 HandleIncludeCompatMap(CompatInfo *info, IncludeStmt *stmt)
 582 {
 583     enum merge_mode merge = MERGE_DEFAULT;
 584     XkbFile *rtrn;
 585     CompatInfo included, next_incl;
 586
 587     InitCompatInfo(&included, info->keymap, info->file_id);
 588     if (stmt->stmt) {
 589         free(included.name);
 590         included.name = stmt->stmt;
 591         stmt->stmt = NULL;
 592     }
 593
 594     for (; stmt; stmt = stmt->next_incl) {
 595         if (!ProcessIncludeFile(info->keymap->ctx, stmt, FILE_TYPE_COMPAT,
 596                                 &rtrn, &merge)) {
 597             info->errorCount += 10;
 598             ClearCompatInfo(&included);
 599             return false;
 600         }
 601
 602         InitCompatInfo(&next_incl, info->keymap, rtrn->id);
 603         next_incl.file_id = rtrn->id;
 604         next_incl.dflt = info->dflt;
 605         next_incl.dflt.file_id = rtrn->id;
 606         next_incl.dflt.merge = merge;
 607         next_incl.ledDflt.file_id = rtrn->id;
 608         next_incl.ledDflt.merge = merge;
 609         next_incl.act = info->act;
 610
 611         HandleCompatMapFile(&next_incl, rtrn, MERGE_OVERRIDE);
 612
 613         MergeIncludedCompatMaps(&included, &next_incl, merge);
 614         if (info->act)
 615             next_incl.act = NULL;
 616
 617         ClearCompatInfo(&next_incl);
 618         FreeXKBFile(rtrn);
 619     }
 620
 621     MergeIncludedCompatMaps(info, &included, merge);
 622     ClearCompatInfo(&included);
 623
 624     return (info->errorCount == 0);
 625 }
 626
 627 static const LookupEntry useModMapValues[] = {
 628     { "levelone", 1 },
 629     { "level1", 1 },
 630     { "anylevel", 0 },
 631     { "any", 0 },
 632     { NULL, 0 }
 633 };
 634
 635 static int
 636 SetInterpField(CompatInfo *info, SymInterpInfo *si, const char *field,
 637                ExprDef *arrayNdx, ExprDef *value)
 638 {
 639     struct xkb_keymap *keymap = info->keymap;
 640     xkb_mod_index_t ndx;
 641
 642     if (istreq(field, "action")) {
 643         if (arrayNdx)
 644             return ReportSINotArray(info, si, field);
 645
 646         if (!HandleActionDef(value, keymap, &si->interp.act.any, info->act))
 647             return false;
 648
 649         si->defined |= SI_FIELD_ACTION;
 650     }
 651     else if (istreq(field, "virtualmodifier") ||
 652              istreq(field, "virtualmod")) {
 653         if (arrayNdx)
 654             return ReportSINotArray(info, si, field);
 655
 656         if (!ResolveVirtualModifier(value, keymap, &ndx, &info->vmods))
 657             return ReportSIBadType(info, si, field, "virtual modifier");
 658
 659         si->interp.virtual_mod = ndx;
 660         si->defined |= SI_FIELD_VIRTUAL_MOD;
 661     }
 662     else if (istreq(field, "repeat")) {
 663         bool set;
 664
 665         if (arrayNdx)
 666             return ReportSINotArray(info, si, field);
 667
 668         if (!ExprResolveBoolean(keymap->ctx, value, &set))
 669             return ReportSIBadType(info, si, field, "boolean");
 670
 671         if (set)
 672             si->interp.flags |= XkbSI_AutoRepeat;
 673         else
 674             si->interp.flags &= ~XkbSI_AutoRepeat;
 675
 676         si->defined |= SI_FIELD_AUTO_REPEAT;
 677     }
 678     else if (istreq(field, "locking")) {
 679         bool set;
 680
 681         if (arrayNdx)
 682             return ReportSINotArray(info, si, field);
 683
 684         if (!ExprResolveBoolean(keymap->ctx, value, &set))
 685             return ReportSIBadType(info, si, field, "boolean");
 686
 687         if (set)
 688             si->interp.flags |= XkbSI_LockingKey;
 689         else
 690             si->interp.flags &= ~XkbSI_LockingKey;
 691
 692         si->defined |= SI_FIELD_LOCKING_KEY;
 693     }
 694     else if (istreq(field, "usemodmap") ||
 695              istreq(field, "usemodmapmods")) {
 696         unsigned int val;
 697
 698         if (arrayNdx)
 699             return ReportSINotArray(info, si, field);
 700
 701         if (!ExprResolveEnum(keymap->ctx, value, &val, useModMapValues))
 702             return ReportSIBadType(info, si, field, "level specification");
 703
 704         if (val)
 705             si->interp.match |= XkbSI_LevelOneOnly;
 706         else
 707             si->interp.match &= ~XkbSI_LevelOneOnly;
 708
 709         si->defined |= SI_FIELD_LEVEL_ONE_ONLY;
 710     }
 711     else {
 712         return ReportBadField(keymap, "symbol interpretation", field,
 713                               siText(si, info));
 714     }
 715
 716     return true;
 717 }
 718
 719 static const LookupEntry modComponentNames[] = {
 720     {"base", XkbIM_UseBase},
 721     {"latched", XkbIM_UseLatched},
 722     {"locked", XkbIM_UseLocked},
 723     {"effective", XkbIM_UseEffective},
 724     {"compat", XkbIM_UseCompat},
 725     {"any", XkbIM_UseAnyMods},
 726     {"none", 0},
 727     {NULL, 0}
 728 };
 729 static const LookupEntry groupComponentNames[] = {
 730     {"base", XkbIM_UseBase},
 731     {"latched", XkbIM_UseLatched},
 732     {"locked", XkbIM_UseLocked},
 733     {"effective", XkbIM_UseEffective},
 734     {"any", XkbIM_UseAnyGroup},
 735     {"none", 0},
 736     {NULL, 0}
 737 };
 738
 739 static const LookupEntry groupNames[] = {
 740     {"group1", 0x01},
 741     {"group2", 0x02},
 742     {"group3", 0x04},
 743     {"group4", 0x08},
 744     {"group5", 0x10},
 745     {"group6", 0x20},
 746     {"group7", 0x40},
 747     {"group8", 0x80},
 748     {"none", 0x00},
 749     {"all", 0xff},
 750     {NULL, 0}
 751 };
 752
 753 static int
 754 SetIndicatorMapField(CompatInfo *info, LEDInfo *led,
 755                      const char *field, ExprDef *arrayNdx, ExprDef *value)
 756 {
 757     bool ok = true;
 758     struct xkb_keymap *keymap = info->keymap;
 759
 760     if (istreq(field, "modifiers") || istreq(field, "mods")) {
 761         xkb_mod_mask_t mask;
 762
 763         if (arrayNdx)
 764             return ReportIndicatorNotArray(info, led, field);
 765
 766         if (!ExprResolveVModMask(keymap, value, &mask))
 767             return ReportIndicatorBadType(info, led, field, "modifier mask");
 768
 769         led->real_mods = mask & 0xff;
 770         led->vmods = (mask >> XkbNumModifiers) & 0xffff;
 771         led->defined |= LED_FIELD_MODS;
 772     }
 773     else if (istreq(field, "groups")) {
 774         unsigned int mask;
 775
 776         if (arrayNdx)
 777             return ReportIndicatorNotArray(info, led, field);
 778
 779         if (!ExprResolveMask(keymap->ctx, value, &mask, groupNames))
 780             return ReportIndicatorBadType(info, led, field, "group mask");
 781
 782         led->groups = mask;
 783         led->defined |= LED_FIELD_GROUPS;
 784     }
 785     else if (istreq(field, "controls") || istreq(field, "ctrls")) {
 786         unsigned int mask;
 787
 788         if (arrayNdx)
 789             return ReportIndicatorNotArray(info, led, field);
 790
 791         if (!ExprResolveMask(keymap->ctx, value, &mask, ctrlNames))
 792             return ReportIndicatorBadType(info, led, field,
 793                                           "controls mask");
 794
 795         led->ctrls = mask;
 796         led->defined |= LED_FIELD_CTRLS;
 797     }
 798     else if (istreq(field, "allowexplicit")) {
 799         bool set;
 800
 801         if (arrayNdx)
 802             return ReportIndicatorNotArray(info, led, field);
 803
 804         if (!ExprResolveBoolean(keymap->ctx, value, &set))
 805             return ReportIndicatorBadType(info, led, field, "boolean");
 806
 807         if (set)
 808             led->flags &= ~XkbIM_NoExplicit;
 809         else
 810             led->flags |= XkbIM_NoExplicit;
 811
 812         led->defined |= LED_FIELD_EXPLICIT;
 813     }
 814     else if (istreq(field, "whichmodstate") ||
 815              istreq(field, "whichmodifierstate")) {
 816         unsigned int mask;
 817
 818         if (arrayNdx)
 819             return ReportIndicatorNotArray(info, led, field);
 820
 821         if (!ExprResolveMask(keymap->ctx, value, &mask, modComponentNames))
 822             return ReportIndicatorBadType(info, led, field,
 823                                           "mask of modifier state components");
 824
 825         led->which_mods = mask;
 826     }
 827     else if (istreq(field, "whichgroupstate")) {
 828         unsigned mask;
 829
 830         if (arrayNdx)
 831             return ReportIndicatorNotArray(info, led, field);
 832
 833         if (!ExprResolveMask(keymap->ctx, value, &mask, groupComponentNames))
 834             return ReportIndicatorBadType(info, led, field,
 835                                           "mask of group state components");
 836
 837         led->which_groups = mask;
 838     }
 839     else if (istreq(field, "driveskbd") ||
 840              istreq(field, "driveskeyboard") ||
 841              istreq(field, "leddriveskbd") ||
 842              istreq(field, "leddriveskeyboard") ||
 843              istreq(field, "indicatordriveskbd") ||
 844              istreq(field, "indicatordriveskeyboard")) {
 845         bool set;
 846
 847         if (arrayNdx)
 848             return ReportIndicatorNotArray(info, led, field);
 849
 850         if (!ExprResolveBoolean(keymap->ctx, value, &set))
 851             return ReportIndicatorBadType(info, led, field, "boolean");
 852
 853         if (set)
 854             led->flags |= XkbIM_LEDDrivesKB;
 855         else
 856             led->flags &= ~XkbIM_LEDDrivesKB;
 857
 858         led->defined |= LED_FIELD_DRIVES_KBD;
 859     }
 860     else if (istreq(field, "index")) {
 861         int ndx;
 862
 863         if (arrayNdx)
 864             return ReportIndicatorNotArray(info, led, field);
 865
 866         if (!ExprResolveInteger(keymap->ctx, value, &ndx))
 867             return ReportIndicatorBadType(info, led, field,
 868                                           "indicator index");
 869
 870         if (ndx < 1 || ndx > 32) {
 871             log_err(info->keymap->ctx,
 872                     "Illegal indicator index %d (range 1..%d); "
 873                     "Index definition for %s indicator ignored\n",
 874                     ndx, XkbNumIndicators,
 875                     xkb_atom_text(keymap->ctx, led->name));
 876             return false;
 877         }
 878
 879         led->indicator = (xkb_led_index_t) ndx;
 880         led->defined |= LED_FIELD_INDEX;
 881     }
 882     else {
 883         log_err(info->keymap->ctx,
 884                 "Unknown field %s in map for %s indicator; "
 885                 "Definition ignored\n",
 886                 field, xkb_atom_text(keymap->ctx, led->name));
 887         ok = false;
 888     }
 889
 890     return ok;
 891 }
 892
 893 static int
 894 HandleInterpVar(CompatInfo *info, VarDef *stmt)
 895 {
 896     const char *elem, *field;
 897     ExprDef *ndx;
 898     int ret;
 899
 900     if (!ExprResolveLhs(info->keymap->ctx, stmt->name, &elem, &field, &ndx))
 901         ret = 0;               /* internal error, already reported */
 902     else if (elem && istreq(elem, "interpret"))
 903         ret = SetInterpField(info, &info->dflt, field, ndx, stmt->value);
 904     else if (elem && istreq(elem, "indicator"))
 905         ret = SetIndicatorMapField(info, &info->ledDflt, field, ndx,
 906                                    stmt->value);
 907     else
 908         ret = SetActionField(info->keymap, elem, field, ndx, stmt->value,
 909                              &info->act);
 910     return ret;
 911 }
 912
 913 static int
 914 HandleInterpBody(CompatInfo *info, VarDef *def, SymInterpInfo *si)
 915 {
 916     int ok = 1;
 917     const char *elem, *field;
 918     ExprDef *arrayNdx;
 919
 920     for (; def != NULL; def = (VarDef *) def->common.next) {
 921         if (def->name && def->name->op == EXPR_FIELD_REF) {
 922             ok = HandleInterpVar(info, def);
 923             continue;
 924         }
 925         ok = ExprResolveLhs(info->keymap->ctx, def->name, &elem, &field,
 926                             &arrayNdx);
 927         if (ok) {
 928             ok = SetInterpField(info, si, field, arrayNdx, def->value);
 929         }
 930     }
 931     return ok;
 932 }
 933
 934 static int
 935 HandleInterpDef(CompatInfo *info, InterpDef *def, enum merge_mode merge)
 936 {
 937     unsigned pred, mods;
 938     SymInterpInfo si;
 939
 940     if (!ResolveStateAndPredicate(def->match, &pred, &mods, info)) {
 941         log_err(info->keymap->ctx,
 942                 "Couldn't determine matching modifiers; "
 943                 "Symbol interpretation ignored\n");
 944         return false;
 945     }
 946     if (def->merge != MERGE_DEFAULT)
 947         merge = def->merge;
 948
 949     si = info->dflt;
 950     si.merge = merge;
 951     if (!LookupKeysym(def->sym, &si.interp.sym)) {
 952         log_err(info->keymap->ctx,
 953                 "Could not resolve keysym %s; "
 954                 "Symbol interpretation ignored\n",
 955                 def->sym);
 956         return false;
 957     }
 958     si.interp.match = pred & XkbSI_OpMask;
 959     si.interp.mods = mods;
 960     if (!HandleInterpBody(info, def->def, &si)) {
 961         info->errorCount++;
 962         return false;
 963     }
 964
 965     if (!AddInterp(info, &si)) {
 966         info->errorCount++;
 967         return false;
 968     }
 969     return true;
 970 }
 971
 972 static int
 973 HandleGroupCompatDef(CompatInfo *info, GroupCompatDef *def,
 974                      enum merge_mode merge)
 975 {
 976     xkb_mod_mask_t mask;
 977     GroupCompatInfo tmp;
 978
 979     merge = (def->merge == MERGE_DEFAULT ? merge : def->merge);
 980
 981     if (def->group < 1 || def->group > XkbNumKbdGroups) {
 982         log_err(info->keymap->ctx,
 983                 "Keyboard group must be in the range 1..%u; "
 984                 "Compatibility map for illegal group %u ignored\n",
 985                 XkbNumKbdGroups, def->group);
 986         return false;
 987     }
 988
 989     tmp.file_id = info->file_id;
 990     tmp.merge = merge;
 991
 992     if (!ExprResolveVModMask(info->keymap, def->def, &mask)) {
 993         log_err(info->keymap->ctx,
 994                 "Expected a modifier mask in group compatibility definition; "
 995                 "Ignoring illegal compatibility map for group %u\n",
 996                 def->group);
 997         return false;
 998     }
 999
1000     tmp.real_mods = mask & 0xff;
1001     tmp.vmods = (mask >> XkbNumModifiers) & 0xffff;
1002     tmp.defined = true;
1003     return AddGroupCompat(info, def->group - 1, &tmp);
1004 }
1005
1006 static bool
1007 HandleIndicatorMapDef(CompatInfo *info, IndicatorMapDef *def,
1008                       enum merge_mode merge)
1009 {
1010     LEDInfo led;
1011     VarDef *var;
1012     bool ok;
1013
1014     if (def->merge != MERGE_DEFAULT)
1015         merge = def->merge;
1016
1017     led = info->ledDflt;
1018     led.merge = merge;
1019     led.name = def->name;
1020
1021     ok = true;
1022     for (var = def->body; var != NULL; var = (VarDef *) var->common.next) {
1023         const char *elem, *field;
1024         ExprDef *arrayNdx;
1025         if (!ExprResolveLhs(info->keymap->ctx, var->name, &elem, &field,
1026                             &arrayNdx)) {
1027             ok = false;
1028             continue;
1029         }
1030
1031         if (elem) {
1032             log_err(info->keymap->ctx,
1033                     "Cannot set defaults for \"%s\" element in indicator map; "
1034                     "Assignment to %s.%s ignored\n", elem, elem, field);
1035             ok = false;
1036         }
1037         else {
1038             ok = SetIndicatorMapField(info, &led, field, arrayNdx,
1039                                       var->value) && ok;
1040         }
1041     }
1042
1043     if (ok)
1044         return AddIndicatorMap(info, &led);
1045
1046     return false;
1047 }
1048
1049 static void
1050 HandleCompatMapFile(CompatInfo *info, XkbFile *file, enum merge_mode merge)
1051 {
1052     bool ok;
1053     ParseCommon *stmt;
1054
1055     merge = (merge == MERGE_DEFAULT ? MERGE_AUGMENT : merge);
1056
1057     free(info->name);
1058     info->name = strdup_safe(file->name);
1059
1060     for (stmt = file->defs; stmt; stmt = stmt->next) {
1061         switch (stmt->type) {
1062         case STMT_INCLUDE:
1063             ok = HandleIncludeCompatMap(info, (IncludeStmt *) stmt);
1064             break;
1065         case STMT_INTERP:
1066             ok = HandleInterpDef(info, (InterpDef *) stmt, merge);
1067             break;
1068         case STMT_GROUP_COMPAT:
1069             ok = HandleGroupCompatDef(info, (GroupCompatDef *) stmt, merge);
1070             break;
1071         case STMT_INDICATOR_MAP:
1072             ok = HandleIndicatorMapDef(info, (IndicatorMapDef *) stmt, merge);
1073             break;
1074         case STMT_VAR:
1075             ok = HandleInterpVar(info, (VarDef *) stmt);
1076             break;
1077         case STMT_VMOD:
1078             ok = HandleVModDef((VModDef *) stmt, info->keymap, merge,
1079                                &info->vmods);
1080             break;
1081         default:
1082             log_err(info->keymap->ctx,
1083                     "Interpretation files may not include other types; "
1084                     "Ignoring %s\n", StmtTypeToString(stmt->type));
1085             ok = false;
1086             break;
1087         }
1088
1089         if (!ok)
1090             info->errorCount++;
1091
1092         if (info->errorCount > 10) {
1093             log_err(info->keymap->ctx,
1094                     "Abandoning compatibility map \"%s\"\n", file->topName);
1095             break;
1096         }
1097     }
1098 }
1099
1100 static void
1101 CopyInterps(CompatInfo *info, bool needSymbol, unsigned pred)
1102 {
1103     SymInterpInfo *si;
1104
1105     list_foreach(si, &info->interps, entry) {
1106         if (((si->interp.match & XkbSI_OpMask) != pred) ||
1107             (needSymbol && si->interp.sym == XKB_KEY_NoSymbol) ||
1108             (!needSymbol && si->interp.sym != XKB_KEY_NoSymbol))
1109             continue;
1110
1111         darray_append(info->keymap->sym_interpret, si->interp);
1112     }
1113 }
1114
1115 static void
1116 BindIndicators(CompatInfo *info, struct list *unbound_leds)
1117 {
1118     xkb_led_index_t i;
1119     LEDInfo *led, *next_led;
1120     struct xkb_indicator_map *map;
1121     struct xkb_keymap *keymap = info->keymap;
1122
1123     list_foreach(led, unbound_leds, entry) {
1124         if (led->indicator == XKB_LED_INVALID) {
1125             for (i = 0; i < XkbNumIndicators; i++) {
1126                 if (keymap->indicator_names[i] &&
1127                     streq(keymap->indicator_names[i],
1128                           xkb_atom_text(keymap->ctx, led->name))) {
1129                     led->indicator = i + 1;
1130                     break;
1131                 }
1132             }
1133         }
1134     }
1135
1136     list_foreach(led, unbound_leds, entry) {
1137         if (led->indicator == XKB_LED_INVALID) {
1138             for (i = 0; i < XkbNumIndicators; i++) {
1139                 if (keymap->indicator_names[i] == NULL) {
1140                     keymap->indicator_names[i] =
1141                         xkb_atom_text(keymap->ctx, led->name);
1142                     led->indicator = i + 1;
1143                     break;
1144                 }
1145             }
1146
1147             if (led->indicator == XKB_LED_INVALID) {
1148                 log_err(info->keymap->ctx,
1149                         "No unnamed indicators found; "
1150                         "Virtual indicator map \"%s\" not bound\n",
1151                         xkb_atom_text(keymap->ctx, led->name));
1152                 continue;
1153             }
1154         }
1155     }
1156
1157     list_foreach_safe(led, next_led, unbound_leds, entry) {
1158         if (led->indicator == XKB_LED_INVALID) {
1159             free(led);
1160             continue;
1161         }
1162
1163         if (!streq(keymap->indicator_names[led->indicator - 1],
1164                    xkb_atom_text(keymap->ctx, led->name))) {
1165             const char *old = keymap->indicator_names[led->indicator - 1];
1166             log_err(info->keymap->ctx,
1167                     "Multiple names bound to indicator %d; "
1168                     "Using %s, ignoring %s\n",
1169                     led->indicator, old,
1170                     xkb_atom_text(keymap->ctx, led->name));
1171             free(led);
1172             continue;
1173         }
1174
1175         map = &keymap->indicators[led->indicator - 1];
1176         map->flags = led->flags;
1177         map->which_groups = led->which_groups;
1178         map->groups = led->groups;
1179         map->which_mods = led->which_mods;
1180         map->mods.mask = led->real_mods;
1181         map->mods.real_mods = led->real_mods;
1182         map->mods.vmods = led->vmods;
1183         map->ctrls = led->ctrls;
1184         free(led);
1185     }
1186
1187     list_init(unbound_leds);
1188 }
1189
1190 static bool
1191 CopyIndicatorMapDefs(CompatInfo *info)
1192 {
1193     LEDInfo *led, *next_led;
1194     struct list unbound_leds;
1195     struct xkb_indicator_map *im;
1196     struct xkb_keymap *keymap = info->keymap;
1197
1198     list_init(&unbound_leds);
1199
1200     list_foreach_safe(led, next_led, &info->leds, entry) {
1201         if (led->groups != 0 && led->which_groups == 0)
1202             led->which_groups = XkbIM_UseEffective;
1203
1204         if (led->which_mods == 0 && (led->real_mods || led->vmods))
1205             led->which_mods = XkbIM_UseEffective;
1206
1207         if (led->indicator == XKB_LED_INVALID) {
1208             list_append(&led->entry, &unbound_leds);
1209             continue;
1210         }
1211
1212         im = &keymap->indicators[led->indicator - 1];
1213         im->flags = led->flags;
1214         im->which_groups = led->which_groups;
1215         im->groups = led->groups;
1216         im->which_mods = led->which_mods;
1217         im->mods.mask = led->real_mods;
1218         im->mods.real_mods = led->real_mods;
1219         im->mods.vmods = led->vmods;
1220         im->ctrls = led->ctrls;
1221         keymap->indicator_names[led->indicator - 1] =
1222             xkb_atom_text(keymap->ctx, led->name);
1223         free(led);
1224     }
1225     list_init(&info->leds);
1226
1227     BindIndicators(info, &unbound_leds);
1228
1229     return true;
1230 }
1231
1232 bool
1233 CompileCompatMap(XkbFile *file, struct xkb_keymap *keymap,
1234                  enum merge_mode merge)
1235 {
1236     xkb_group_index_t i;
1237     CompatInfo info;
1238     GroupCompatInfo *gcm;
1239
1240     InitCompatInfo(&info, keymap, file->id);
1241     info.dflt.merge = merge;
1242     info.ledDflt.merge = merge;
1243
1244     HandleCompatMapFile(&info, file, merge);
1245
1246     if (info.errorCount != 0)
1247         goto err_info;
1248
1249     darray_init(keymap->sym_interpret);
1250     darray_growalloc(keymap->sym_interpret, info.nInterps);
1251
1252     if (info.name)
1253         keymap->compat_section_name = strdup(info.name);
1254
1255     if (info.nInterps > 0) {
1256         CopyInterps(&info, true, XkbSI_Exactly);
1257         CopyInterps(&info, true, XkbSI_AllOf | XkbSI_NoneOf);
1258         CopyInterps(&info, true, XkbSI_AnyOf);
1259         CopyInterps(&info, true, XkbSI_AnyOfOrNone);
1260         CopyInterps(&info, false, XkbSI_Exactly);
1261         CopyInterps(&info, false, XkbSI_AllOf | XkbSI_NoneOf);
1262         CopyInterps(&info, false, XkbSI_AnyOf);
1263         CopyInterps(&info, false, XkbSI_AnyOfOrNone);
1264     }
1265
1266     for (i = 0, gcm = &info.groupCompat[0]; i < XkbNumKbdGroups;
1267          i++, gcm++) {
1268         if (gcm->file_id != 0 || gcm->real_mods != 0 || gcm->vmods != 0) {
1269             keymap->groups[i].mask = gcm->real_mods;
1270             keymap->groups[i].real_mods = gcm->real_mods;
1271             keymap->groups[i].vmods = gcm->vmods;
1272         }
1273     }
1274
1275     if (!CopyIndicatorMapDefs(&info))
1276         info.errorCount++;
1277
1278     ClearCompatInfo(&info);
1279     return true;
1280
1281 err_info:
1282     ClearCompatInfo(&info);
1283     return false;
1284 }
1285
1286 xkb_mod_mask_t
1287 VModsToReal(struct xkb_keymap *keymap, xkb_mod_mask_t vmodmask)
1288 {
1289     xkb_mod_mask_t ret = 0;
1290     xkb_mod_index_t i;
1291
1292     if (!vmodmask)
1293         return 0;
1294
1295     for (i = 0; i < XkbNumVirtualMods; i++) {
1296         if (!(vmodmask & (1 << i)))
1297             continue;
1298         ret |= keymap->vmods[i];
1299     }
1300
1301     return ret;
1302 }
1303
1304 static void
1305 UpdateActionMods(struct xkb_keymap *keymap, union xkb_action *act,
1306                  xkb_mod_mask_t rmodmask)
1307 {
1308     switch (act->type) {
1309     case XkbSA_SetMods:
1310     case XkbSA_LatchMods:
1311     case XkbSA_LockMods:
1312         if (act->mods.flags & XkbSA_UseModMapMods)
1313             act->mods.real_mods = rmodmask;
1314         act->mods.mask = act->mods.real_mods;
1315         act->mods.mask |= VModsToReal(keymap, act->mods.vmods);
1316         break;
1317
1318     case XkbSA_ISOLock:
1319         if (act->iso.flags & XkbSA_UseModMapMods)
1320             act->iso.real_mods = rmodmask;
1321         act->iso.mask = act->iso.real_mods;
1322         act->iso.mask |= VModsToReal(keymap, act->iso.vmods);
1323         break;
1324
1325     default:
1326         break;
1327     }
1328 }
1329
1330 /**
1331  * Find an interpretation which applies to this particular level, either by
1332  * finding an exact match for the symbol and modifier combination, or a
1333  * generic XKB_KEY_NoSymbol match.
1334  */
1335 static struct xkb_sym_interpret *
1336 FindInterpForKey(struct xkb_keymap *keymap, struct xkb_key *key,
1337                  xkb_group_index_t group, xkb_level_index_t level)
1338 {
1339     struct xkb_sym_interpret *ret = NULL;
1340     struct xkb_sym_interpret *interp;
1341     const xkb_keysym_t *syms;
1342     int num_syms;
1343
1344     num_syms = xkb_key_get_syms_by_level(keymap, key, group, level, &syms);
1345     if (num_syms == 0)
1346         return NULL;
1347
1348     darray_foreach(interp, keymap->sym_interpret) {
1349         uint32_t mods;
1350         bool found;
1351
1352         if ((num_syms > 1 || interp->sym != syms[0]) &&
1353             interp->sym != XKB_KEY_NoSymbol)
1354             continue;
1355
1356         if (level == 0 || !(interp->match & XkbSI_LevelOneOnly))
1357             mods = key->modmap;
1358         else
1359             mods = 0;
1360
1361         switch (interp->match & XkbSI_OpMask) {
1362         case XkbSI_NoneOf:
1363             found = !(interp->mods & mods);
1364             break;
1365         case XkbSI_AnyOfOrNone:
1366             found = (!mods || (interp->mods & mods));
1367             break;
1368         case XkbSI_AnyOf:
1369             found = !!(interp->mods & mods);
1370             break;
1371         case XkbSI_AllOf:
1372             found = ((interp->mods & mods) == interp->mods);
1373             break;
1374         case XkbSI_Exactly:
1375             found = (interp->mods == mods);
1376             break;
1377         default:
1378             found = false;
1379             break;
1380         }
1381
1382         if (found && interp->sym != XKB_KEY_NoSymbol)
1383             return interp;
1384         else if (found && !ret)
1385             ret = interp;
1386     }
1387
1388     return ret;
1389 }
1390
1391 /**
1392  */
1393 static bool
1394 ApplyInterpsToKey(struct xkb_keymap *keymap, struct xkb_key *key)
1395 {
1396 #define INTERP_SIZE (8 * 4)
1397     struct xkb_sym_interpret *interps[INTERP_SIZE];
1398     union xkb_action *acts;
1399     xkb_mod_mask_t vmodmask = 0;
1400     int num_acts = 0;
1401     xkb_group_index_t group;
1402     xkb_level_index_t level;
1403     unsigned int i;
1404
1405     /* If we've been told not to bind interps to this key, then don't. */
1406     if (key->explicit & XkbExplicitInterpretMask)
1407         return true;
1408
1409     for (i = 0; i < INTERP_SIZE; i++)
1410         interps[i] = NULL;
1411
1412     for (group = 0; group < key->num_groups; group++) {
1413         for (level = 0; level < XkbKeyGroupWidth(keymap, key, group);
1414              level++) {
1415             i = (group * key->width) + level;
1416             if (i >= INTERP_SIZE) /* XXX FIXME */
1417                 return false;
1418             interps[i] = FindInterpForKey(keymap, key, group, level);
1419             if (interps[i])
1420                 num_acts++;
1421         }
1422     }
1423
1424     if (num_acts)
1425         num_acts = key->num_groups * key->width;
1426     acts = ResizeKeyActions(keymap, key, num_acts);
1427     if (num_acts && !acts)
1428         return false;
1429
1430     for (group = 0; group < key->num_groups; group++) {
1431         for (level = 0; level < XkbKeyGroupWidth(keymap, key, group);
1432              level++) {
1433             struct xkb_sym_interpret *interp;
1434
1435             i = (group * key->width) + level;
1436             interp = interps[i];
1437
1438             /* Infer default key behaviours from the base level. */
1439             if (group == 0 && level == 0) {
1440                 if (!(key->explicit & XkbExplicitAutoRepeatMask) &&
1441                     (!interp || (interp->flags & XkbSI_AutoRepeat)))
1442                     key->repeats = true;
1443             }
1444
1445             if (!interp)
1446                 continue;
1447
1448             if ((group == 0 && level == 0) ||
1449                 !(interp->match & XkbSI_LevelOneOnly)) {
1450                 if (interp->virtual_mod != XkbNoModifier)
1451                     vmodmask |= (1 << interp->virtual_mod);
1452             }
1453             acts[i] = interp->act;
1454         }
1455     }
1456
1457     if (!(key->explicit & XkbExplicitVModMapMask))
1458         key->vmodmap = vmodmask;
1459
1460     return true;
1461 #undef INTERP_SIZE
1462 }
1463
1464 /**
1465  * This collects a bunch of disparate functions which was done in the server
1466  * at various points that really should've been done within xkbcomp.  Turns out
1467  * your actions and types are a lot more useful when any of your modifiers
1468  * other than Shift actually do something ...
1469  */
1470 bool
1471 UpdateModifiersFromCompat(struct xkb_keymap *keymap)
1472 {
1473     xkb_mod_index_t vmod;
1474     xkb_group_index_t grp;
1475     xkb_led_index_t led;
1476     unsigned int i;
1477     struct xkb_key *key;
1478     struct xkb_key_type *type;
1479     struct xkb_kt_map_entry *entry;
1480
1481     /* Find all the interprets for the key and bind them to actions,
1482      * which will also update the vmodmap. */
1483     xkb_foreach_key(key, keymap)
1484         if (!ApplyInterpsToKey(keymap, key))
1485             return false;
1486
1487     /* Update keymap->vmods, the virtual -> real mod mapping. */
1488     for (vmod = 0; vmod < XkbNumVirtualMods; vmod++)
1489         keymap->vmods[vmod] = 0;
1490
1491     xkb_foreach_key(key, keymap) {
1492         if (!key->vmodmap)
1493             continue;
1494
1495         for (vmod = 0; vmod < XkbNumVirtualMods; vmod++) {
1496             if (!(key->vmodmap & (1 << vmod)))
1497                 continue;
1498             keymap->vmods[vmod] |= key->modmap;
1499         }
1500     }
1501
1502     /* Now update the level masks for all the types to reflect the vmods. */
1503     for (i = 0; i < keymap->num_types; i++) {
1504         xkb_mod_mask_t mask = 0;
1505         type = &keymap->types[i];
1506         type->mods.mask = type->mods.real_mods;
1507         type->mods.mask |= VModsToReal(keymap, type->mods.vmods);
1508
1509         /* FIXME: We compute the mask with doing anything with it? */
1510         for (vmod = 0; vmod < XkbNumVirtualMods; vmod++) {
1511             if (!(type->mods.vmods & (1 << vmod)))
1512                 continue;
1513             mask |= keymap->vmods[vmod];
1514         }
1515
1516         darray_foreach(entry, type->map)
1517             entry->mods.mask = entry->mods.real_mods |
1518                                VModsToReal(keymap, entry->mods.vmods);
1519     }
1520
1521     /* Update action modifiers. */
1522     xkb_foreach_key(key, keymap) {
1523         union xkb_action *acts = XkbKeyActionsPtr(keymap, key);
1524         for (i = 0; i < XkbKeyNumActions(key); i++) {
1525             if (acts[i].any.type == XkbSA_NoAction)
1526                 continue;
1527             UpdateActionMods(keymap, &acts[i], key->modmap);
1528         }
1529     }
1530
1531     /* Update group modifiers. */
1532     for (grp = 0; grp < XkbNumKbdGroups; grp++) {
1533         struct xkb_mods *group = &keymap->groups[grp];
1534         group->mask = group->real_mods | VModsToReal(keymap, group->vmods);
1535     }
1536
1537     /* Update vmod -> indicator maps. */
1538     for (led = 0; led < XkbNumIndicators; led++) {
1539         struct xkb_mods *mods = &keymap->indicators[led].mods;
1540         mods->mask = mods->real_mods | VModsToReal(keymap, mods->vmods);
1541     }
1542
1543     return true;
1544 }