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 /*
  28  * Copyright © 2012 Ran Benita <ran234@gmail.com>
  29  *
  30  * Permission is hereby granted, free of charge, to any person obtaining a
  31  * copy of this software and associated documentation files (the "Software"),
  32  * to deal in the Software without restriction, including without limitation
  33  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
  34  * and/or sell copies of the Software, and to permit persons to whom the
  35  * Software is furnished to do so, subject to the following conditions:
  36  *
  37  * The above copyright notice and this permission notice (including the next
  38  * paragraph) shall be included in all copies or substantial portions of the
  39  * Software.
  40  *
  41  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  42  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  43  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  44  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  45  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  46  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  47  * DEALINGS IN THE SOFTWARE.
  48  */
  49
  50 #include "xkbcomp-priv.h"
  51 #include "text.h"
  52 #include "expr.h"
  53 #include "action.h"
  54 #include "vmod.h"
  55 #include "include.h"
  56
  57 /*
  58  * The xkb_compat section
  59  * =====================
  60  * This section is the third to be processed, after xkb_keycodes and
  61  * xkb_types.
  62  *
  63  * Interpret statements
  64  * --------------------
  65  * Statements of the form:
  66  *      interpret Num_Lock+Any { ... }
  67  *      interpret Shift_Lock+AnyOf(Shift+Lock) { ... }
  68  *
  69  * The xkb_symbols section (see symbols.c) allows the keymap author to do,
  70  * among other things, the following for each key:
  71  * - Bind an action, like SetMods or LockGroup, to the key. Actions, like
  72  *   symbols, are specified for each level of each group in the key
  73  *   separately.
  74  * - Add a virtual modifier to the key's virtual modifier mapping (vmodmap).
  75  * - Specify whether the key should repeat or not.
  76  *
  77  * However, doing this for each key (or level) is tedious and inflexible.
  78  * Interpret's are a mechanism to apply these settings to a bunch of
  79  * keys/levels at once.
  80  *
  81  * Each interpret specifies a condition by which it attaches to certain
  82  * levels. The condition consists of two parts:
  83  * - A keysym. If the level has a different (or more than one) keysym, the
  84  *   match failes. Leaving out the keysym is equivalent to using the
  85  *   NoSymbol keysym, which always matches successfully.
  86  * - A modifier predicate. The predicate consists of a matching operation
  87  *   and a mask of (real) modifiers. The modifers are matched against the
  88  *   key's modifier map (modmap). The matching operation can be one of the
  89  *   following:
  90  *   + AnyOfOrNone - The modmap must either be empty or include at least
  91  *     one of the specified modifiers.
  92  *   + AnyOf - The modmap must include at least one of the specified
  93  *     modifiers.
  94  *   + NoneOf - The modmap must not include any of the specified modifiers.
  95  *   + AllOf - The modmap must include all of the specified modifiers (but
  96  *     may include others as well).
  97  *   + Exactly - The modmap must be exactly the same as the specified
  98  *     modifiers.
  99  *   Leaving out the predicate is equivalent to usign AnyOfOrNone while
 100  *   specifying all modifiers. Leaving out just the matching condtition
 101  *   is equivalent to using Exactly.
 102  * An interpret may also include "useModMapMods = level1;" - see below.
 103  *
 104  * If a level fulfils the conditions of several interpret's, only the
 105  * most specific one is used:
 106  * - A specific keysym will always match before a generic NoSymbol
 107  *   condition.
 108  * - If the keysyms are the same, the interpret with the more specific
 109  *   matching operation is used. The above list is sorted from least to
 110  *   most specific.
 111  * - If both the keysyms and the matching operations are the same (but the
 112  *   modifiers are different), the first interpret is used.
 113  *
 114  * As described above, once an interpret "attaches" to a level, it can bind
 115  * an action to that level, add one virtual modifier to the key's vmodmap,
 116  * or set the key's repeat setting. You should note the following:
 117  * - The key repeat is a property of the entire key; it is not level-specific.
 118  *   In order to avoid confusion, it is only inspected for the first level of
 119  *   the first group; the interpret's repeat setting is ignored when applied
 120  *   to other levels.
 121  * - If one of the above fields was set directly for a key in xkb_symbols,
 122  *   the explicit setting takes precedence over the interpret.
 123  *
 124  * The body of the statment may include statements of the following
 125  * forms (all of which are optional):
 126  *
 127  * - useModMapMods statement:
 128  *      useModMapMods = level1;
 129  *
 130  *   When set to 'level1', the interpret will only match levels which are
 131  *   the first level of the first group of the keys. This can be useful in
 132  *   conjuction with e.g. a virtualModifier statement.
 133  *
 134  * - action statement:
 135  *      action = LockMods(modifiers=NumLock);
 136  *
 137  *   Bind this action to the matching levels.
 138  *
 139  * - virtual modifier statement:
 140  *      virtualModifier = NumLock;
 141  *
 142  *   Add this virtual modifier to the key's vmodmap. The given virtual
 143  *   modifier must be declared at the top level of the file with a
 144  *   virtual_modifiers statement, e.g.:
 145  *      virtual_modifiers NumLock;
 146  *
 147  * - repeat statement:
 148  *      repeat = True;
 149  *
 150  *   Set whether the key should repeat or not. Must be a boolean value.
 151  *
 152  * Indicator map statements
 153  * ------------------------
 154  * Statements of the form:
 155  *      indicator "Shift Lock" { ... }
 156  *
 157  *   This statement specifies the behavior and binding of the indicator
 158  *   with the given name ("Shift Lock" above). The name should have been
 159  *   declared previously in the xkb_keycodes section (see Indicator name
 160  *   statement), and given an index there. If it wasn't, it is created
 161  *   with the next free index.
 162  *   The body of the statement describes the conditions of the keyboard
 163  *   state which will cause the indicator to be lit. It may include the
 164  *   following statements:
 165  *
 166  * - modifiers statment:
 167  *      modifiers = ScrollLock;
 168  *
 169  *   If the given modifiers are in the required state (see below), the
 170  *   led is lit.
 171  *
 172  * - whichModifierState statment:
 173  *      whichModState = Latched + Locked;
 174  *
 175  *   Can be any combination of:
 176  *      base, latched, locked, effective
 177  *      any (i.e. all of the above)
 178  *      none (i.e. none of the above)
 179  *      compat (legacy value, treated as effective)
 180  *   This will cause the respective portion of the modifer state (see
 181  *   struct xkb_state) to be matched against the modifiers given in the
 182  *   "modifiers" statement.
 183  *
 184  *   Here's a simple example:
 185  *      indicator "Num Lock" {
 186  *          modifiers = NumLock;
 187  *          whichModState = Locked;
 188  *      };
 189  *   Whenever the NumLock modifier is locked, the Num Lock indicator
 190  *   will light up.
 191  *
 192  * - groups statment:
 193  *      groups = All - group1;
 194  *
 195  *   If the given groups are in the required state (see below), the led
 196  *   is lit.
 197  *
 198  * - whichGroupState statment:
 199  *      whichGroupState = Effective;
 200  *
 201  *   Can be any combination of:
 202  *      base, latched, locked, effective
 203  *      any (i.e. all of the above)
 204  *      none (i.e. none of the above)
 205  *   This will cause the respective portion of the group state (see
 206  *   struct xkb_state) to be matched against the groups given in the
 207  *   "groups" statement.
 208  *
 209  *   Note: the above conditions are disjunctive, i.e. if any of them are
 210  *   satisfied the led is lit.
 211  *
 212  * Virtual modifier statements
 213  * ---------------------------
 214  * Statements of the form:
 215  *     virtual_modifiers LControl;
 216  *
 217  * Can appear in the xkb_types, xkb_compat, xkb_symbols sections.
 218  * TODO
 219  *
 220  * Effect on keymap
 221  * ----------------
 222  * After all of the xkb_compat sections have been compiled, the following
 223  * members of struct xkb_keymap are finalized:
 224  *      darray(struct xkb_sym_interpret) sym_interprets;
 225  *      darray(struct xkb_indicator_map) indicators;
 226  *      char *compat_section_name;
 227  * TODO: virtual modifiers.
 228  */
 229
 230 enum si_field {
 231     SI_FIELD_VIRTUAL_MOD    = (1 << 0),
 232     SI_FIELD_ACTION         = (1 << 1),
 233     SI_FIELD_AUTO_REPEAT    = (1 << 2),
 234     SI_FIELD_LEVEL_ONE_ONLY = (1 << 3),
 235 };
 236
 237 typedef struct {
 238     enum si_field defined;
 239     unsigned file_id;
 240     enum merge_mode merge;
 241
 242     struct xkb_sym_interpret interp;
 243 } SymInterpInfo;
 244
 245 enum led_field {
 246     LED_FIELD_MODS       = (1 << 0),
 247     LED_FIELD_GROUPS     = (1 << 1),
 248     LED_FIELD_CTRLS      = (1 << 2),
 249 };
 250
 251 typedef struct {
 252     enum led_field defined;
 253     unsigned file_id;
 254     enum merge_mode merge;
 255
 256     struct xkb_indicator_map im;
 257 } LEDInfo;
 258
 259 typedef struct {
 260     char *name;
 261     unsigned file_id;
 262     int errorCount;
 263     SymInterpInfo dflt;
 264     darray(SymInterpInfo) interps;
 265     LEDInfo ledDflt;
 266     darray(LEDInfo) leds;
 267     ActionsInfo *actions;
 268     struct xkb_keymap *keymap;
 269 } CompatInfo;
 270
 271 static const char *
 272 siText(SymInterpInfo *si, CompatInfo *info)
 273 {
 274     static char buf[128];
 275
 276     if (si == &info->dflt)
 277         return "default";
 278
 279     snprintf(buf, sizeof(buf), "%s+%s(%s)",
 280              KeysymText(si->interp.sym),
 281              SIMatchText(si->interp.match),
 282              ModMaskText(info->keymap, si->interp.mods));
 283     return buf;
 284 }
 285
 286 static inline bool
 287 ReportSINotArray(CompatInfo *info, SymInterpInfo *si, const char *field)
 288 {
 289     return ReportNotArray(info->keymap, "symbol interpretation", field,
 290                           siText(si, info));
 291 }
 292
 293 static inline bool
 294 ReportSIBadType(CompatInfo *info, SymInterpInfo *si, const char *field,
 295                 const char *wanted)
 296 {
 297     return ReportBadType(info->keymap->ctx, "symbol interpretation", field,
 298                          siText(si, info), wanted);
 299 }
 300
 301 static inline bool
 302 ReportIndicatorBadType(CompatInfo *info, LEDInfo *led,
 303                        const char *field, const char *wanted)
 304 {
 305     return ReportBadType(info->keymap->ctx, "indicator map", field,
 306                          xkb_atom_text(info->keymap->ctx, led->im.name),
 307                          wanted);
 308 }
 309
 310 static inline bool
 311 ReportIndicatorNotArray(CompatInfo *info, LEDInfo *led,
 312                         const char *field)
 313 {
 314     return ReportNotArray(info->keymap, "indicator map", field,
 315                           xkb_atom_text(info->keymap->ctx, led->im.name));
 316 }
 317
 318 static void
 319 InitCompatInfo(CompatInfo *info, struct xkb_keymap *keymap, unsigned file_id,
 320                ActionsInfo *actions)
 321 {
 322     memset(info, 0, sizeof(*info));
 323     info->keymap = keymap;
 324     info->file_id = file_id;
 325     info->actions = actions;
 326     info->dflt.file_id = file_id;
 327     info->dflt.merge = MERGE_OVERRIDE;
 328     info->dflt.interp.virtual_mod = XKB_MOD_INVALID;
 329     info->ledDflt.file_id = file_id;
 330     info->ledDflt.merge = MERGE_OVERRIDE;
 331 }
 332
 333 static void
 334 ClearCompatInfo(CompatInfo *info)
 335 {
 336     free(info->name);
 337     darray_free(info->interps);
 338     darray_free(info->leds);
 339 }
 340
 341 static SymInterpInfo *
 342 FindMatchingInterp(CompatInfo *info, SymInterpInfo *new)
 343 {
 344     SymInterpInfo *old;
 345
 346     darray_foreach(old, info->interps)
 347         if (old->interp.sym == new->interp.sym &&
 348             old->interp.mods == new->interp.mods &&
 349             old->interp.match == new->interp.match)
 350             return old;
 351
 352     return NULL;
 353 }
 354
 355 static bool
 356 UseNewInterpField(enum si_field field, SymInterpInfo *old, SymInterpInfo *new,
 357                   bool report, enum si_field *collide)
 358 {
 359     if (!(old->defined & field))
 360         return true;
 361
 362     if (new->defined & field) {
 363         if (report)
 364             *collide |= field;
 365
 366         if (new->merge != MERGE_AUGMENT)
 367             return true;
 368     }
 369
 370     return false;
 371 }
 372
 373 static bool
 374 AddInterp(CompatInfo *info, SymInterpInfo *new)
 375 {
 376     enum si_field collide = 0;
 377     SymInterpInfo *old;
 378
 379     old = FindMatchingInterp(info, new);
 380     if (old) {
 381         int verbosity = xkb_context_get_log_verbosity(info->keymap->ctx);
 382         bool report = ((old->file_id == new->file_id && verbosity > 0) ||
 383                        verbosity > 9);
 384
 385         if (new->merge == MERGE_REPLACE) {
 386             if (report)
 387                 log_warn(info->keymap->ctx,
 388                          "Multiple definitions for \"%s\"; "
 389                          "Earlier interpretation ignored\n",
 390                          siText(new, info));
 391             *old = *new;
 392             return true;
 393         }
 394
 395         if (UseNewInterpField(SI_FIELD_VIRTUAL_MOD, old, new, report,
 396                               &collide)) {
 397             old->interp.virtual_mod = new->interp.virtual_mod;
 398             old->defined |= SI_FIELD_VIRTUAL_MOD;
 399         }
 400         if (UseNewInterpField(SI_FIELD_ACTION, old, new, report,
 401                               &collide)) {
 402             old->interp.action = new->interp.action;
 403             old->defined |= SI_FIELD_ACTION;
 404         }
 405         if (UseNewInterpField(SI_FIELD_AUTO_REPEAT, old, new, report,
 406                               &collide)) {
 407             old->interp.repeat = new->interp.repeat;
 408             old->defined |= SI_FIELD_AUTO_REPEAT;
 409         }
 410         if (UseNewInterpField(SI_FIELD_LEVEL_ONE_ONLY, old, new, report,
 411                               &collide)) {
 412             old->interp.level_one_only = new->interp.level_one_only;
 413             old->defined |= SI_FIELD_LEVEL_ONE_ONLY;
 414         }
 415
 416         if (collide) {
 417             log_warn(info->keymap->ctx,
 418                      "Multiple interpretations of \"%s\"; "
 419                      "Using %s definition for duplicate fields\n",
 420                      siText(new, info),
 421                      (new->merge != MERGE_AUGMENT ? "last" : "first"));
 422         }
 423
 424         return true;
 425     }
 426
 427     darray_append(info->interps, *new);
 428     return true;
 429 }
 430
 431
 432 /***====================================================================***/
 433
 434 static bool
 435 ResolveStateAndPredicate(ExprDef *expr, enum xkb_match_operation *pred_rtrn,
 436                          xkb_mod_mask_t *mods_rtrn, CompatInfo *info)
 437 {
 438     if (expr == NULL) {
 439         *pred_rtrn = MATCH_ANY_OR_NONE;
 440         *mods_rtrn = MOD_REAL_MASK_ALL;
 441         return true;
 442     }
 443
 444     *pred_rtrn = MATCH_EXACTLY;
 445     if (expr->op == EXPR_ACTION_DECL) {
 446         const char *pred_txt = xkb_atom_text(info->keymap->ctx,
 447                                              expr->value.action.name);
 448         if (!LookupString(symInterpretMatchMaskNames, pred_txt, pred_rtrn)) {
 449             log_err(info->keymap->ctx,
 450                     "Illegal modifier predicate \"%s\"; Ignored\n", pred_txt);
 451             return false;
 452         }
 453         expr = expr->value.action.args;
 454     }
 455     else if (expr->op == EXPR_IDENT) {
 456         const char *pred_txt = xkb_atom_text(info->keymap->ctx,
 457                                              expr->value.str);
 458         if (pred_txt && istreq(pred_txt, "any")) {
 459             *pred_rtrn = MATCH_ANY;
 460             *mods_rtrn = MOD_REAL_MASK_ALL;
 461             return true;
 462         }
 463     }
 464
 465     return ExprResolveModMask(info->keymap, expr, MOD_REAL, mods_rtrn);
 466 }
 467
 468 /***====================================================================***/
 469
 470 static bool
 471 UseNewLEDField(enum led_field field, LEDInfo *old, LEDInfo *new,
 472                bool report, enum led_field *collide)
 473 {
 474     if (!(old->defined & field))
 475         return true;
 476
 477     if (new->defined & field) {
 478         if (report)
 479             *collide |= field;
 480
 481         if (new->merge != MERGE_AUGMENT)
 482             return true;
 483     }
 484
 485     return false;
 486 }
 487
 488 static bool
 489 AddIndicatorMap(CompatInfo *info, LEDInfo *new)
 490 {
 491     LEDInfo *old;
 492     enum led_field collide;
 493     struct xkb_context *ctx = info->keymap->ctx;
 494     int verbosity = xkb_context_get_log_verbosity(ctx);
 495
 496     darray_foreach(old, info->leds) {
 497         bool report;
 498
 499         if (old->im.name != new->im.name)
 500             continue;
 501
 502         if (old->im.mods.mods == new->im.mods.mods &&
 503             old->im.groups == new->im.groups &&
 504             old->im.ctrls == new->im.ctrls &&
 505             old->im.which_mods == new->im.which_mods &&
 506             old->im.which_groups == new->im.which_groups) {
 507             old->defined |= new->defined;
 508             return true;
 509         }
 510
 511         report = ((old->file_id == new->file_id && verbosity > 0) ||
 512                   verbosity > 9);
 513
 514         if (new->merge == MERGE_REPLACE) {
 515             if (report)
 516                 log_warn(info->keymap->ctx,
 517                          "Map for indicator %s redefined; "
 518                          "Earlier definition ignored\n",
 519                          xkb_atom_text(ctx, old->im.name));
 520             *old = *new;
 521             return true;
 522         }
 523
 524         collide = 0;
 525         if (UseNewLEDField(LED_FIELD_MODS, old, new, report, &collide)) {
 526             old->im.which_mods = new->im.which_mods;
 527             old->im.mods = new->im.mods;
 528             old->defined |= LED_FIELD_MODS;
 529         }
 530         if (UseNewLEDField(LED_FIELD_GROUPS, old, new, report, &collide)) {
 531             old->im.which_groups = new->im.which_groups;
 532             old->im.groups = new->im.groups;
 533             old->defined |= LED_FIELD_GROUPS;
 534         }
 535         if (UseNewLEDField(LED_FIELD_CTRLS, old, new, report, &collide)) {
 536             old->im.ctrls = new->im.ctrls;
 537             old->defined |= LED_FIELD_CTRLS;
 538         }
 539
 540         if (collide) {
 541             log_warn(info->keymap->ctx,
 542                      "Map for indicator %s redefined; "
 543                      "Using %s definition for duplicate fields\n",
 544                      xkb_atom_text(ctx, old->im.name),
 545                      (new->merge == MERGE_AUGMENT ? "first" : "last"));
 546         }
 547
 548         return true;
 549     }
 550
 551     darray_append(info->leds, *new);
 552     return true;
 553 }
 554
 555 static void
 556 MergeIncludedCompatMaps(CompatInfo *into, CompatInfo *from,
 557                         enum merge_mode merge)
 558 {
 559     SymInterpInfo *si;
 560     LEDInfo *led;
 561
 562     if (from->errorCount > 0) {
 563         into->errorCount += from->errorCount;
 564         return;
 565     }
 566
 567     if (into->name == NULL) {
 568         into->name = from->name;
 569         from->name = NULL;
 570     }
 571
 572     darray_foreach(si, from->interps) {
 573         si->merge = (merge == MERGE_DEFAULT ? si->merge : merge);
 574         if (!AddInterp(into, si))
 575             into->errorCount++;
 576     }
 577
 578     darray_foreach(led, from->leds) {
 579         led->merge = (merge == MERGE_DEFAULT ? led->merge : merge);
 580         if (!AddIndicatorMap(into, led))
 581             into->errorCount++;
 582     }
 583 }
 584
 585 static void
 586 HandleCompatMapFile(CompatInfo *info, XkbFile *file, enum merge_mode merge);
 587
 588 static bool
 589 HandleIncludeCompatMap(CompatInfo *info, IncludeStmt *stmt)
 590 {
 591     enum merge_mode merge = MERGE_DEFAULT;
 592     XkbFile *rtrn;
 593     CompatInfo included, next_incl;
 594
 595     InitCompatInfo(&included, info->keymap, info->file_id, info->actions);
 596     if (stmt->stmt) {
 597         free(included.name);
 598         included.name = stmt->stmt;
 599         stmt->stmt = NULL;
 600     }
 601
 602     for (; stmt; stmt = stmt->next_incl) {
 603         if (!ProcessIncludeFile(info->keymap->ctx, stmt, FILE_TYPE_COMPAT,
 604                                 &rtrn, &merge)) {
 605             info->errorCount += 10;
 606             ClearCompatInfo(&included);
 607             return false;
 608         }
 609
 610         InitCompatInfo(&next_incl, info->keymap, rtrn->id, info->actions);
 611         next_incl.file_id = rtrn->id;
 612         next_incl.dflt = info->dflt;
 613         next_incl.dflt.file_id = rtrn->id;
 614         next_incl.dflt.merge = merge;
 615         next_incl.ledDflt.file_id = rtrn->id;
 616         next_incl.ledDflt.merge = merge;
 617
 618         HandleCompatMapFile(&next_incl, rtrn, MERGE_OVERRIDE);
 619
 620         MergeIncludedCompatMaps(&included, &next_incl, merge);
 621
 622         ClearCompatInfo(&next_incl);
 623         FreeXkbFile(rtrn);
 624     }
 625
 626     MergeIncludedCompatMaps(info, &included, merge);
 627     ClearCompatInfo(&included);
 628
 629     return (info->errorCount == 0);
 630 }
 631
 632 static bool
 633 SetInterpField(CompatInfo *info, SymInterpInfo *si, const char *field,
 634                ExprDef *arrayNdx, ExprDef *value)
 635 {
 636     struct xkb_keymap *keymap = info->keymap;
 637     xkb_mod_index_t ndx;
 638
 639     if (istreq(field, "action")) {
 640         if (arrayNdx)
 641             return ReportSINotArray(info, si, field);
 642
 643         if (!HandleActionDef(value, keymap, &si->interp.action, info->actions))
 644             return false;
 645
 646         si->defined |= SI_FIELD_ACTION;
 647     }
 648     else if (istreq(field, "virtualmodifier") ||
 649              istreq(field, "virtualmod")) {
 650         if (arrayNdx)
 651             return ReportSINotArray(info, si, field);
 652
 653         if (!ExprResolveMod(keymap, value, MOD_VIRT, &ndx))
 654             return ReportSIBadType(info, si, field, "virtual modifier");
 655
 656         si->interp.virtual_mod = ndx;
 657         si->defined |= SI_FIELD_VIRTUAL_MOD;
 658     }
 659     else if (istreq(field, "repeat")) {
 660         bool set;
 661
 662         if (arrayNdx)
 663             return ReportSINotArray(info, si, field);
 664
 665         if (!ExprResolveBoolean(keymap->ctx, value, &set))
 666             return ReportSIBadType(info, si, field, "boolean");
 667
 668         si->interp.repeat = set;
 669
 670         si->defined |= SI_FIELD_AUTO_REPEAT;
 671     }
 672     else if (istreq(field, "locking")) {
 673         log_dbg(info->keymap->ctx,
 674                 "The \"locking\" field in symbol interpretation is unsupported; "
 675                 "Ignored\n");
 676     }
 677     else if (istreq(field, "usemodmap") ||
 678              istreq(field, "usemodmapmods")) {
 679         unsigned int val;
 680
 681         if (arrayNdx)
 682             return ReportSINotArray(info, si, field);
 683
 684         if (!ExprResolveEnum(keymap->ctx, value, &val, useModMapValueNames))
 685             return ReportSIBadType(info, si, field, "level specification");
 686
 687         si->interp.level_one_only = !!val;
 688         si->defined |= SI_FIELD_LEVEL_ONE_ONLY;
 689     }
 690     else {
 691         return ReportBadField(keymap, "symbol interpretation", field,
 692                               siText(si, info));
 693     }
 694
 695     return true;
 696 }
 697
 698 static bool
 699 SetIndicatorMapField(CompatInfo *info, LEDInfo *led,
 700                      const char *field, ExprDef *arrayNdx, ExprDef *value)
 701 {
 702     bool ok = true;
 703     struct xkb_keymap *keymap = info->keymap;
 704
 705     if (istreq(field, "modifiers") || istreq(field, "mods")) {
 706         if (arrayNdx)
 707             return ReportIndicatorNotArray(info, led, field);
 708
 709         if (!ExprResolveModMask(keymap, value, MOD_BOTH, &led->im.mods.mods))
 710             return ReportIndicatorBadType(info, led, field, "modifier mask");
 711
 712         led->defined |= LED_FIELD_MODS;
 713     }
 714     else if (istreq(field, "groups")) {
 715         unsigned int mask;
 716
 717         if (arrayNdx)
 718             return ReportIndicatorNotArray(info, led, field);
 719
 720         if (!ExprResolveMask(keymap->ctx, value, &mask, groupMaskNames))
 721             return ReportIndicatorBadType(info, led, field, "group mask");
 722
 723         led->im.groups = mask;
 724         led->defined |= LED_FIELD_GROUPS;
 725     }
 726     else if (istreq(field, "controls") || istreq(field, "ctrls")) {
 727         unsigned int mask;
 728
 729         if (arrayNdx)
 730             return ReportIndicatorNotArray(info, led, field);
 731
 732         if (!ExprResolveMask(keymap->ctx, value, &mask, ctrlMaskNames))
 733             return ReportIndicatorBadType(info, led, field,
 734                                           "controls mask");
 735
 736         led->im.ctrls = mask;
 737         led->defined |= LED_FIELD_CTRLS;
 738     }
 739     else if (istreq(field, "allowexplicit")) {
 740         log_dbg(info->keymap->ctx,
 741                 "The \"allowExplicit\" field in indicator statements is unsupported; "
 742                 "Ignored\n");
 743     }
 744     else if (istreq(field, "whichmodstate") ||
 745              istreq(field, "whichmodifierstate")) {
 746         unsigned int mask;
 747
 748         if (arrayNdx)
 749             return ReportIndicatorNotArray(info, led, field);
 750
 751         if (!ExprResolveMask(keymap->ctx, value, &mask,
 752                              modComponentMaskNames))
 753             return ReportIndicatorBadType(info, led, field,
 754                                           "mask of modifier state components");
 755
 756         led->im.which_mods = mask;
 757     }
 758     else if (istreq(field, "whichgroupstate")) {
 759         unsigned mask;
 760
 761         if (arrayNdx)
 762             return ReportIndicatorNotArray(info, led, field);
 763
 764         if (!ExprResolveMask(keymap->ctx, value, &mask,
 765                              groupComponentMaskNames))
 766             return ReportIndicatorBadType(info, led, field,
 767                                           "mask of group state components");
 768
 769         led->im.which_groups = mask;
 770     }
 771     else if (istreq(field, "driveskbd") ||
 772              istreq(field, "driveskeyboard") ||
 773              istreq(field, "leddriveskbd") ||
 774              istreq(field, "leddriveskeyboard") ||
 775              istreq(field, "indicatordriveskbd") ||
 776              istreq(field, "indicatordriveskeyboard")) {
 777         log_dbg(info->keymap->ctx,
 778                 "The \"%s\" field in indicator statements is unsupported; "
 779                 "Ignored\n", field);
 780     }
 781     else if (istreq(field, "index")) {
 782         /* Users should see this, it might cause unexpected behavior. */
 783         log_err(info->keymap->ctx,
 784                 "The \"index\" field in indicator statements is unsupported; "
 785                 "Ignored\n");
 786     }
 787     else {
 788         log_err(info->keymap->ctx,
 789                 "Unknown field %s in map for %s indicator; "
 790                 "Definition ignored\n",
 791                 field, xkb_atom_text(keymap->ctx, led->im.name));
 792         ok = false;
 793     }
 794
 795     return ok;
 796 }
 797
 798 static bool
 799 HandleGlobalVar(CompatInfo *info, VarDef *stmt)
 800 {
 801     const char *elem, *field;
 802     ExprDef *ndx;
 803     bool ret;
 804
 805     if (!ExprResolveLhs(info->keymap->ctx, stmt->name, &elem, &field, &ndx))
 806         ret = false;
 807     else if (elem && istreq(elem, "interpret"))
 808         ret = SetInterpField(info, &info->dflt, field, ndx, stmt->value);
 809     else if (elem && istreq(elem, "indicator"))
 810         ret = SetIndicatorMapField(info, &info->ledDflt, field, ndx,
 811                                    stmt->value);
 812     else
 813         ret = SetActionField(info->keymap, elem, field, ndx, stmt->value,
 814                              info->actions);
 815     return ret;
 816 }
 817
 818 static bool
 819 HandleInterpBody(CompatInfo *info, VarDef *def, SymInterpInfo *si)
 820 {
 821     bool ok = true;
 822     const char *elem, *field;
 823     ExprDef *arrayNdx;
 824
 825     for (; def; def = (VarDef *) def->common.next) {
 826         if (def->name && def->name->op == EXPR_FIELD_REF) {
 827             log_err(info->keymap->ctx,
 828                     "Cannot set a global default value from within an interpret statement; "
 829                     "Move statements to the global file scope\n");
 830             ok = false;
 831             continue;
 832         }
 833
 834         ok = ExprResolveLhs(info->keymap->ctx, def->name, &elem, &field,
 835                             &arrayNdx);
 836         if (!ok)
 837             continue;
 838
 839         ok = SetInterpField(info, si, field, arrayNdx, def->value);
 840     }
 841
 842     return ok;
 843 }
 844
 845 static bool
 846 HandleInterpDef(CompatInfo *info, InterpDef *def, enum merge_mode merge)
 847 {
 848     enum xkb_match_operation pred;
 849     xkb_mod_mask_t mods;
 850     SymInterpInfo si;
 851
 852     if (!ResolveStateAndPredicate(def->match, &pred, &mods, info)) {
 853         log_err(info->keymap->ctx,
 854                 "Couldn't determine matching modifiers; "
 855                 "Symbol interpretation ignored\n");
 856         return false;
 857     }
 858
 859     si = info->dflt;
 860     si.merge = merge = (def->merge == MERGE_DEFAULT ? merge : def->merge);
 861
 862     if (!LookupKeysym(def->sym, &si.interp.sym)) {
 863         log_err(info->keymap->ctx,
 864                 "Could not resolve keysym %s; "
 865                 "Symbol interpretation ignored\n",
 866                 def->sym);
 867         return false;
 868     }
 869
 870     si.interp.match = pred;
 871     si.interp.mods = mods;
 872
 873     if (!HandleInterpBody(info, def->def, &si)) {
 874         info->errorCount++;
 875         return false;
 876     }
 877
 878     if (!AddInterp(info, &si)) {
 879         info->errorCount++;
 880         return false;
 881     }
 882
 883     return true;
 884 }
 885
 886 static bool
 887 HandleIndicatorMapDef(CompatInfo *info, IndicatorMapDef *def,
 888                       enum merge_mode merge)
 889 {
 890     LEDInfo led;
 891     VarDef *var;
 892     bool ok;
 893
 894     if (def->merge != MERGE_DEFAULT)
 895         merge = def->merge;
 896
 897     led = info->ledDflt;
 898     led.merge = merge;
 899     led.im.name = def->name;
 900
 901     ok = true;
 902     for (var = def->body; var != NULL; var = (VarDef *) var->common.next) {
 903         const char *elem, *field;
 904         ExprDef *arrayNdx;
 905         if (!ExprResolveLhs(info->keymap->ctx, var->name, &elem, &field,
 906                             &arrayNdx)) {
 907             ok = false;
 908             continue;
 909         }
 910
 911         if (elem) {
 912             log_err(info->keymap->ctx,
 913                     "Cannot set defaults for \"%s\" element in indicator map; "
 914                     "Assignment to %s.%s ignored\n", elem, elem, field);
 915             ok = false;
 916         }
 917         else {
 918             ok = SetIndicatorMapField(info, &led, field, arrayNdx,
 919                                       var->value) && ok;
 920         }
 921     }
 922
 923     if (ok)
 924         return AddIndicatorMap(info, &led);
 925
 926     return false;
 927 }
 928
 929 static void
 930 HandleCompatMapFile(CompatInfo *info, XkbFile *file, enum merge_mode merge)
 931 {
 932     bool ok;
 933     ParseCommon *stmt;
 934
 935     merge = (merge == MERGE_DEFAULT ? MERGE_AUGMENT : merge);
 936
 937     free(info->name);
 938     info->name = strdup_safe(file->name);
 939
 940     for (stmt = file->defs; stmt; stmt = stmt->next) {
 941         switch (stmt->type) {
 942         case STMT_INCLUDE:
 943             ok = HandleIncludeCompatMap(info, (IncludeStmt *) stmt);
 944             break;
 945         case STMT_INTERP:
 946             ok = HandleInterpDef(info, (InterpDef *) stmt, merge);
 947             break;
 948         case STMT_GROUP_COMPAT:
 949             log_dbg(info->keymap->ctx,
 950                     "The \"group\" statement in compat is unsupported; "
 951                     "Ignored\n");
 952             ok = true;
 953             break;
 954         case STMT_INDICATOR_MAP:
 955             ok = HandleIndicatorMapDef(info, (IndicatorMapDef *) stmt, merge);
 956             break;
 957         case STMT_VAR:
 958             ok = HandleGlobalVar(info, (VarDef *) stmt);
 959             break;
 960         case STMT_VMOD:
 961             ok = HandleVModDef(info->keymap, (VModDef *) stmt);
 962             break;
 963         default:
 964             log_err(info->keymap->ctx,
 965                     "Interpretation files may not include other types; "
 966                     "Ignoring %s\n", stmt_type_to_string(stmt->type));
 967             ok = false;
 968             break;
 969         }
 970
 971         if (!ok)
 972             info->errorCount++;
 973
 974         if (info->errorCount > 10) {
 975             log_err(info->keymap->ctx,
 976                     "Abandoning compatibility map \"%s\"\n", file->topName);
 977             break;
 978         }
 979     }
 980 }
 981
 982 static void
 983 CopyInterps(CompatInfo *info, bool needSymbol, enum xkb_match_operation pred)
 984 {
 985     SymInterpInfo *si;
 986
 987     darray_foreach(si, info->interps)
 988         if (si->interp.match == pred &&
 989             (si->interp.sym != XKB_KEY_NoSymbol) == needSymbol)
 990             darray_append(info->keymap->sym_interprets, si->interp);
 991 }
 992
 993 static void
 994 CopyIndicatorMapDefs(CompatInfo *info)
 995 {
 996     LEDInfo *led;
 997     xkb_led_index_t i;
 998     struct xkb_indicator_map *im;
 999     struct xkb_keymap *keymap = info->keymap;
1000
1001     darray_foreach(led, info->leds) {
1002         /*
1003          * Find the indicator with the given name, if it was already
1004          * declared in keycodes.
1005          */
1006         darray_enumerate(i, im, keymap->indicators)
1007             if (im->name == led->im.name)
1008                 break;
1009
1010         /* Not previously declared; create it with next free index. */
1011         if (i >= darray_size(keymap->indicators)) {
1012             log_dbg(keymap->ctx,
1013                     "Indicator name \"%s\" was not declared in the keycodes section; "
1014                     "Adding new indicator\n",
1015                     xkb_atom_text(keymap->ctx, led->im.name));
1016
1017             darray_enumerate(i, im, keymap->indicators)
1018                 if (im->name == XKB_ATOM_NONE)
1019                     break;
1020
1021             if (i >= darray_size(keymap->indicators)) {
1022                 /* Not place to put it; ignore. */
1023                 if (i >= XKB_MAX_LEDS) {
1024                     log_err(keymap->ctx,
1025                             "Too many indicators (maximum is %d); "
1026                             "Indicator name \"%s\" ignored\n",
1027                             XKB_MAX_LEDS,
1028                             xkb_atom_text(keymap->ctx, led->im.name));
1029                     continue;
1030                 }
1031                 /* Add a new indicator. */
1032                 darray_resize(keymap->indicators, i + 1);
1033                 im = &darray_item(keymap->indicators, i);
1034             }
1035         }
1036
1037         *im = led->im;
1038         if (im->groups != 0 && im->which_groups == 0)
1039             im->which_groups = XKB_STATE_EFFECTIVE;
1040         if (im->mods.mods != 0 && im->which_mods == 0)
1041             im->which_mods = XKB_STATE_EFFECTIVE;
1042     }
1043 }
1044
1045 static bool
1046 CopyCompatToKeymap(struct xkb_keymap *keymap, CompatInfo *info)
1047 {
1048     keymap->compat_section_name = strdup_safe(info->name);
1049
1050     if (!darray_empty(info->interps)) {
1051         /* Most specific to least specific. */
1052         CopyInterps(info, true, MATCH_EXACTLY);
1053         CopyInterps(info, true, MATCH_ALL);
1054         CopyInterps(info, true, MATCH_NONE);
1055         CopyInterps(info, true, MATCH_ANY);
1056         CopyInterps(info, true, MATCH_ANY_OR_NONE);
1057         CopyInterps(info, false, MATCH_EXACTLY);
1058         CopyInterps(info, false, MATCH_ALL);
1059         CopyInterps(info, false, MATCH_NONE);
1060         CopyInterps(info, false, MATCH_ANY);
1061         CopyInterps(info, false, MATCH_ANY_OR_NONE);
1062     }
1063
1064     CopyIndicatorMapDefs(info);
1065
1066     return true;
1067 }
1068
1069 bool
1070 CompileCompatMap(XkbFile *file, struct xkb_keymap *keymap,
1071                  enum merge_mode merge)
1072 {
1073     CompatInfo info;
1074     ActionsInfo *actions;
1075
1076     actions = NewActionsInfo();
1077     if (!actions)
1078         return false;
1079
1080     InitCompatInfo(&info, keymap, file->id, actions);
1081     info.dflt.merge = merge;
1082     info.ledDflt.merge = merge;
1083
1084     HandleCompatMapFile(&info, file, merge);
1085     if (info.errorCount != 0)
1086         goto err_info;
1087
1088     if (!CopyCompatToKeymap(keymap, &info))
1089         goto err_info;
1090
1091     ClearCompatInfo(&info);
1092     FreeActionsInfo(actions);
1093     return true;
1094
1095 err_info:
1096     ClearCompatInfo(&info);
1097     FreeActionsInfo(actions);
1098     return false;
1099 }