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