src/xkbcomp/symbols.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 <limits.h>
  28
  29 #include "xkbcomp-priv.h"
  30 #include "parseutils.h"
  31 #include "action.h"
  32 #include "vmod.h"
  33
  34 /***====================================================================***/
  35
  36 /* Needed to work with the typechecker. */
  37 typedef darray(xkb_keysym_t) darray_xkb_keysym_t;
  38 typedef darray(union xkb_action) darray_xkb_action;
  39
  40 #define RepeatYes       1
  41 #define RepeatNo        0
  42 #define RepeatUndefined ~((unsigned) 0)
  43
  44 #define _Key_Syms       (1 << 0)
  45 #define _Key_Acts       (1 << 1)
  46 #define _Key_Repeat     (1 << 2)
  47 #define _Key_Behavior   (1 << 3)
  48 #define _Key_Type_Dflt  (1 << 4)
  49 #define _Key_Types      (1 << 5)
  50 #define _Key_GroupInfo  (1 << 6)
  51 #define _Key_VModMap    (1 << 7)
  52
  53 static inline const char *
  54 longText(unsigned long val)
  55 {
  56     char buf[4];
  57
  58     LongToKeyName(val, buf);
  59     return KeyNameText(buf);
  60 }
  61
  62 typedef struct _KeyInfo {
  63     unsigned short defined;
  64     unsigned file_id;
  65     enum merge_mode merge;
  66
  67     unsigned long name; /* the 4 chars of the key name, as long */
  68     unsigned char typesDefined;
  69     unsigned char symsDefined;
  70     unsigned char actsDefined;
  71     unsigned int numLevels[XkbNumKbdGroups];
  72
  73     /* syms[group] -> Single array for all the keysyms in the group. */
  74     darray_xkb_keysym_t syms[XkbNumKbdGroups];
  75     /*
  76      * symsMapIndex[group][level] -> The index from which the syms for
  77      * the level begin in the syms[group] array. Remember each keycode
  78      * can have multiple keysyms in each level (that is, each key press
  79      * can result in multiple keysyms).
  80      */
  81     darray(int) symsMapIndex[XkbNumKbdGroups];
  82     /*
  83      * symsMapNumEntries[group][level] -> How many syms are in
  84      * syms[group][symsMapIndex[group][level]].
  85      */
  86     darray(size_t) symsMapNumEntries[XkbNumKbdGroups];
  87
  88     darray_xkb_action acts[XkbNumKbdGroups];
  89
  90     xkb_atom_t types[XkbNumKbdGroups];
  91     unsigned repeat;
  92     struct xkb_behavior behavior;
  93     unsigned short vmodmap;
  94     xkb_atom_t dfltType;
  95
  96     uint8_t out_of_range_group_action;
  97     xkb_group_index_t out_of_range_group_number;
  98 } KeyInfo;
  99
 100 /**
 101  * Init the given key info to sane values.
 102  */
 103 static void
 104 InitKeyInfo(KeyInfo *keyi, unsigned file_id)
 105 {
 106     xkb_group_index_t i;
 107     static const char dflt[4] = "*";
 108
 109     keyi->defined = 0;
 110     keyi->file_id = file_id;
 111     keyi->merge = MERGE_OVERRIDE;
 112     keyi->name = KeyNameToLong(dflt);
 113     keyi->typesDefined = keyi->symsDefined = keyi->actsDefined = 0;
 114
 115     for (i = 0; i < XkbNumKbdGroups; i++) {
 116         keyi->numLevels[i] = 0;
 117         keyi->types[i] = XKB_ATOM_NONE;
 118         darray_init(keyi->syms[i]);
 119         darray_init(keyi->symsMapIndex[i]);
 120         darray_init(keyi->symsMapNumEntries[i]);
 121         darray_init(keyi->acts[i]);
 122     }
 123
 124     keyi->dfltType = XKB_ATOM_NONE;
 125     keyi->behavior.type = XkbKB_Default;
 126     keyi->behavior.data = 0;
 127     keyi->vmodmap = 0;
 128     keyi->repeat = RepeatUndefined;
 129     keyi->out_of_range_group_action = 0;
 130     keyi->out_of_range_group_number = 0;
 131 }
 132
 133 static void
 134 FreeKeyInfo(KeyInfo *keyi)
 135 {
 136     xkb_group_index_t i;
 137
 138     for (i = 0; i < XkbNumKbdGroups; i++) {
 139         darray_free(keyi->syms[i]);
 140         darray_free(keyi->symsMapIndex[i]);
 141         darray_free(keyi->symsMapNumEntries[i]);
 142         darray_free(keyi->acts[i]);
 143     }
 144 }
 145
 146 /**
 147  * Copy old into new, optionally reset old to 0.
 148  * If old is reset, new simply re-uses old's memory. Otherwise, the memory is
 149  * newly allocated and new points to the new memory areas.
 150  */
 151 static bool
 152 CopyKeyInfo(KeyInfo * old, KeyInfo * new, bool clearOld)
 153 {
 154     xkb_group_index_t i;
 155
 156     *new = *old;
 157
 158     if (clearOld) {
 159         for (i = 0; i < XkbNumKbdGroups; i++) {
 160             old->numLevels[i] = 0;
 161             darray_init(old->symsMapIndex[i]);
 162             darray_init(old->symsMapNumEntries[i]);
 163             darray_init(old->syms[i]);
 164             darray_init(old->acts[i]);
 165         }
 166     }
 167     else {
 168         for (i = 0; i < XkbNumKbdGroups; i++) {
 169             darray_copy(new->syms[i], old->syms[i]);
 170             darray_copy(new->symsMapIndex[i], old->symsMapIndex[i]);
 171             darray_copy(new->symsMapNumEntries[i], old->symsMapNumEntries[i]);
 172             darray_copy(new->acts[i], old->acts[i]);
 173         }
 174     }
 175
 176     return true;
 177 }
 178
 179 /***====================================================================***/
 180
 181 typedef struct _ModMapEntry {
 182     struct list entry;
 183     enum merge_mode merge;
 184     bool haveSymbol;
 185     int modifier;
 186     union {
 187         unsigned long keyName;
 188         xkb_keysym_t keySym;
 189     } u;
 190 } ModMapEntry;
 191
 192 typedef struct _SymbolsInfo {
 193     char *name;         /* e.g. pc+us+inet(evdev) */
 194     int errorCount;
 195     unsigned file_id;
 196     enum merge_mode merge;
 197     xkb_group_index_t explicit_group;
 198     darray(KeyInfo) keys;
 199     KeyInfo dflt;
 200     VModInfo vmods;
 201     ActionInfo *action;
 202     xkb_atom_t groupNames[XkbNumKbdGroups];
 203
 204     struct list modMaps;
 205
 206     struct xkb_keymap *keymap;
 207 } SymbolsInfo;
 208
 209 static void
 210 InitSymbolsInfo(SymbolsInfo * info, struct xkb_keymap *keymap,
 211                 unsigned file_id)
 212 {
 213     xkb_group_index_t i;
 214
 215     info->name = NULL;
 216     info->explicit_group = 0;
 217     info->errorCount = 0;
 218     info->file_id = file_id;
 219     info->merge = MERGE_OVERRIDE;
 220     darray_init(info->keys);
 221     darray_growalloc(info->keys, 110);
 222     list_init(&info->modMaps);
 223     for (i = 0; i < XkbNumKbdGroups; i++)
 224         info->groupNames[i] = XKB_ATOM_NONE;
 225     InitKeyInfo(&info->dflt, file_id);
 226     InitVModInfo(&info->vmods, keymap);
 227     info->action = NULL;
 228     info->keymap = keymap;
 229 }
 230
 231 static void
 232 FreeSymbolsInfo(SymbolsInfo * info)
 233 {
 234     KeyInfo *keyi;
 235     ModMapEntry *mm, *next;
 236
 237     free(info->name);
 238     darray_foreach(keyi, info->keys) {
 239         FreeKeyInfo(keyi);
 240     }
 241     darray_free(info->keys);
 242     list_foreach_safe(mm, next, &info->modMaps, entry)
 243         free(mm);
 244     memset(info, 0, sizeof(SymbolsInfo));
 245 }
 246
 247 static bool
 248 ResizeKeyGroup(KeyInfo *keyi, xkb_group_index_t group, unsigned int numLevels,
 249                unsigned sizeSyms, bool forceActions)
 250 {
 251     int i;
 252
 253     if (darray_size(keyi->syms[group]) < sizeSyms)
 254         darray_resize0(keyi->syms[group], sizeSyms);
 255
 256     if (darray_empty(keyi->symsMapIndex[group]) ||
 257         keyi->numLevels[group] < numLevels) {
 258         darray_resize(keyi->symsMapIndex[group], numLevels);
 259         for (i = keyi->numLevels[group]; i < numLevels; i++)
 260             darray_item(keyi->symsMapIndex[group], i) = -1;
 261     }
 262
 263     if (darray_empty(keyi->symsMapNumEntries[group]) ||
 264         keyi->numLevels[group] < numLevels)
 265         darray_resize0(keyi->symsMapNumEntries[group], numLevels);
 266
 267     if ((forceActions && (keyi->numLevels[group] < numLevels ||
 268                           darray_empty(keyi->acts[group]))) ||
 269         (keyi->numLevels[group] < numLevels && !darray_empty(keyi->acts[group])))
 270         darray_resize0(keyi->acts[group], numLevels);
 271
 272     if (keyi->numLevels[group] < numLevels)
 273         keyi->numLevels[group] = numLevels;
 274
 275     return true;
 276 }
 277
 278 enum key_group_selector {
 279     NONE = 0,
 280     FROM = (1 << 0),
 281     TO = (1 << 1),
 282 };
 283
 284 static bool
 285 MergeKeyGroups(SymbolsInfo * info,
 286                KeyInfo * into, KeyInfo * from, xkb_group_index_t group)
 287 {
 288     darray_xkb_keysym_t resultSyms;
 289     enum key_group_selector using = NONE;
 290     darray_xkb_action resultActs;
 291     unsigned int resultWidth;
 292     unsigned int resultSize = 0;
 293     int cur_idx = 0;
 294     int i;
 295     bool report, clobber;
 296     int verbosity = xkb_get_log_verbosity(info->keymap->ctx);
 297
 298     clobber = (from->merge != MERGE_AUGMENT);
 299
 300     report = (verbosity > 9) ||
 301              (into->file_id == from->file_id && verbosity > 0);
 302
 303     darray_init(resultSyms);
 304
 305     if (into->numLevels[group] >= from->numLevels[group]) {
 306         resultActs = into->acts[group];
 307         resultWidth = into->numLevels[group];
 308     }
 309     else {
 310         resultActs = from->acts[group];
 311         resultWidth = from->numLevels[group];
 312         darray_resize(into->symsMapIndex[group],
 313                       from->numLevels[group]);
 314         darray_resize0(into->symsMapNumEntries[group],
 315                        from->numLevels[group]);
 316
 317         for (i = into->numLevels[group]; i < from->numLevels[group]; i++)
 318             darray_item(into->symsMapIndex[group], i) = -1;
 319     }
 320
 321     if (darray_empty(resultActs) && (!darray_empty(into->acts[group]) ||
 322                                      !darray_empty(from->acts[group]))) {
 323         darray_resize0(resultActs, resultWidth);
 324         for (i = 0; i < resultWidth; i++) {
 325             union xkb_action *fromAct = NULL, *toAct = NULL;
 326
 327             if (!darray_empty(from->acts[group]))
 328                 fromAct = &darray_item(from->acts[group], i);
 329
 330             if (!darray_empty(into->acts[group]))
 331                 toAct = &darray_item(into->acts[group], i);
 332
 333             if (((fromAct == NULL) || (fromAct->type == XkbSA_NoAction))
 334                 && (toAct != NULL)) {
 335                 darray_item(resultActs, i) = *toAct;
 336             }
 337             else if (((toAct == NULL) || (toAct->type == XkbSA_NoAction))
 338                      && (fromAct != NULL)) {
 339                 darray_item(resultActs, i) = *fromAct;
 340             }
 341             else {
 342                 union xkb_action *use, *ignore;
 343                 if (clobber) {
 344                     use = fromAct;
 345                     ignore = toAct;
 346                 }
 347                 else {
 348                     use = toAct;
 349                     ignore = fromAct;
 350                 }
 351                 if (report)
 352                     log_warn(info->keymap->ctx,
 353                              "Multiple actions for level %d/group %u on key %s; "
 354                              "Using %s, ignoring %s\n",
 355                              i + 1, group + 1, longText(into->name),
 356                              ActionTypeText(use->type),
 357                              ActionTypeText(ignore->type));
 358                 if (use)
 359                     darray_item(resultActs, i) = *use;
 360             }
 361         }
 362     }
 363
 364     for (i = 0; i < resultWidth; i++) {
 365         unsigned int fromSize = 0;
 366         unsigned toSize = 0;
 367
 368         if (!darray_empty(from->symsMapNumEntries[group]) &&
 369             i < from->numLevels[group])
 370             fromSize = darray_item(from->symsMapNumEntries[group], i);
 371
 372         if (!darray_empty(into->symsMapNumEntries[group]) &&
 373             i < into->numLevels[group])
 374             toSize = darray_item(into->symsMapNumEntries[group], i);
 375
 376         if (fromSize == 0) {
 377             resultSize += toSize;
 378             using |= TO;
 379         }
 380         else if (toSize == 0 || clobber) {
 381             resultSize += fromSize;
 382             using |= FROM;
 383         }
 384         else {
 385             resultSize += toSize;
 386             using |= TO;
 387         }
 388     }
 389
 390     if (resultSize == 0)
 391         goto out;
 392
 393     if (using == FROM) {
 394         resultSyms = from->syms[group];
 395         darray_free(into->symsMapNumEntries[group]);
 396         darray_free(into->symsMapIndex[group]);
 397         into->symsMapNumEntries[group] = from->symsMapNumEntries[group];
 398         into->symsMapIndex[group] = from->symsMapIndex[group];
 399         darray_init(from->symsMapNumEntries[group]);
 400         darray_init(from->symsMapIndex[group]);
 401         goto out;
 402     }
 403     else if (using == TO) {
 404         resultSyms = into->syms[group];
 405         goto out;
 406     }
 407
 408     darray_resize0(resultSyms, resultSize);
 409
 410     for (i = 0; i < resultWidth; i++) {
 411         enum key_group_selector use = NONE;
 412         unsigned int fromSize = 0;
 413         unsigned int toSize = 0;
 414
 415         if (i < from->numLevels[group])
 416             fromSize = darray_item(from->symsMapNumEntries[group], i);
 417
 418         if (i < into->numLevels[group])
 419             toSize = darray_item(into->symsMapNumEntries[group], i);
 420
 421         if (fromSize == 0 && toSize == 0) {
 422             darray_item(into->symsMapIndex[group], i) = -1;
 423             darray_item(into->symsMapNumEntries[group], i) = 0;
 424             continue;
 425         }
 426
 427         if (fromSize == 0)
 428             use = TO;
 429         else if (toSize == 0 || clobber)
 430             use = FROM;
 431         else
 432             use = TO;
 433
 434         if (toSize && fromSize && report) {
 435             log_info(info->keymap->ctx,
 436                      "Multiple symbols for group %u, level %d on key %s; "
 437                      "Using %s, ignoring %s\n",
 438                      group + 1, i + 1, longText(into->name),
 439                      (use == FROM ? "from" : "to"),
 440                      (use == FROM ? "to" : "from"));
 441         }
 442
 443         if (use == FROM) {
 444             memcpy(darray_mem(resultSyms, cur_idx),
 445                    darray_mem(from->syms[group],
 446                               darray_item(from->symsMapIndex[group], i)),
 447                    darray_item(from->symsMapNumEntries[group],
 448                                i) * sizeof(xkb_keysym_t));
 449             darray_item(into->symsMapIndex[group], i) = cur_idx;
 450             darray_item(into->symsMapNumEntries[group], i) =
 451                 darray_item(from->symsMapNumEntries[group], i);
 452         }
 453         else {
 454             memcpy(darray_mem(resultSyms, cur_idx),
 455                    darray_mem(into->syms[group],
 456                               darray_item(into->symsMapIndex[group], i)),
 457                    darray_item(into->symsMapNumEntries[group],
 458                                i) * sizeof(xkb_keysym_t));
 459             darray_item(into->symsMapIndex[group], i) = cur_idx;
 460         }
 461         cur_idx += darray_item(into->symsMapNumEntries[group], i);
 462     }
 463
 464 out:
 465     if (!darray_same(resultActs, into->acts[group]))
 466         darray_free(into->acts[group]);
 467     if (!darray_same(resultActs, from->acts[group]))
 468         darray_free(from->acts[group]);
 469     into->numLevels[group] = resultWidth;
 470     if (!darray_same(resultSyms, into->syms[group]))
 471         darray_free(into->syms[group]);
 472     into->syms[group] = resultSyms;
 473     if (!darray_same(resultSyms, from->syms[group]))
 474         darray_free(from->syms[group]);
 475     darray_init(from->syms[group]);
 476     darray_free(from->symsMapIndex[group]);
 477     darray_free(from->symsMapNumEntries[group]);
 478     into->acts[group] = resultActs;
 479     darray_init(from->acts[group]);
 480     if (!darray_empty(into->syms[group]))
 481         into->symsDefined |= (1 << group);
 482     from->symsDefined &= ~(1 << group);
 483     into->actsDefined |= (1 << group);
 484     from->actsDefined &= ~(1 << group);
 485
 486     return true;
 487 }
 488
 489 static bool
 490 UseNewKeyField(unsigned field, KeyInfo *old, KeyInfo *new, int verbosity,
 491                unsigned *collide)
 492 {
 493     if (!(old->defined & field))
 494         return true;
 495
 496     if (new->defined & field) {
 497         if ((old->file_id == new->file_id && verbosity > 0) || verbosity > 9)
 498             *collide |= field;
 499
 500         if (new->merge != MERGE_AUGMENT)
 501             return true;
 502     }
 503
 504     return false;
 505 }
 506
 507
 508 static bool
 509 MergeKeys(SymbolsInfo *info, KeyInfo *into, KeyInfo *from)
 510 {
 511     xkb_group_index_t i;
 512     unsigned collide = 0;
 513     bool report;
 514     int verbosity = xkb_get_log_verbosity(info->keymap->ctx);
 515
 516     if (from->merge == MERGE_REPLACE) {
 517         for (i = 0; i < XkbNumKbdGroups; i++) {
 518             if (into->numLevels[i] != 0) {
 519                 darray_free(into->syms[i]);
 520                 darray_free(into->acts[i]);
 521             }
 522         }
 523         *into = *from;
 524         memset(from, 0, sizeof(KeyInfo));
 525         return true;
 526     }
 527
 528     report = (verbosity > 9 ||
 529               (into->file_id == from->file_id && verbosity > 0));
 530
 531     for (i = 0; i < XkbNumKbdGroups; i++) {
 532         if (from->numLevels[i] > 0) {
 533             if (into->numLevels[i] == 0) {
 534                 into->numLevels[i] = from->numLevels[i];
 535                 into->syms[i] = from->syms[i];
 536                 into->symsMapIndex[i] = from->symsMapIndex[i];
 537                 into->symsMapNumEntries[i] = from->symsMapNumEntries[i];
 538                 into->acts[i] = from->acts[i];
 539                 into->symsDefined |= (1 << i);
 540                 darray_init(from->syms[i]);
 541                 darray_init(from->symsMapIndex[i]);
 542                 darray_init(from->symsMapNumEntries[i]);
 543                 darray_init(from->acts[i]);
 544                 from->numLevels[i] = 0;
 545                 from->symsDefined &= ~(1 << i);
 546                 if (!darray_empty(into->syms[i]))
 547                     into->defined |= _Key_Syms;
 548                 if (!darray_empty(into->acts[i]))
 549                     into->defined |= _Key_Acts;
 550             }
 551             else {
 552                 if (report) {
 553                     if (!darray_empty(into->syms[i]))
 554                         collide |= _Key_Syms;
 555                     if (!darray_empty(into->acts[i]))
 556                         collide |= _Key_Acts;
 557                 }
 558                 MergeKeyGroups(info, into, from, (unsigned) i);
 559             }
 560         }
 561         if (from->types[i] != XKB_ATOM_NONE) {
 562             if ((into->types[i] != XKB_ATOM_NONE) && report &&
 563                 (into->types[i] != from->types[i])) {
 564                 xkb_atom_t use, ignore;
 565                 collide |= _Key_Types;
 566                 if (from->merge != MERGE_AUGMENT) {
 567                     use = from->types[i];
 568                     ignore = into->types[i];
 569                 }
 570                 else {
 571                     use = into->types[i];
 572                     ignore = from->types[i];
 573                 }
 574
 575                 log_warn(info->keymap->ctx,
 576                          "Multiple definitions for group %d type of key %s; "
 577                          "Using %s, ignoring %s\n",
 578                          i, longText(into->name),
 579                          xkb_atom_text(info->keymap->ctx, use),
 580                          xkb_atom_text(info->keymap->ctx, ignore));
 581             }
 582
 583             if (from->merge != MERGE_AUGMENT ||
 584                 into->types[i] == XKB_ATOM_NONE) {
 585                 into->types[i] = from->types[i];
 586             }
 587         }
 588     }
 589
 590     if (UseNewKeyField(_Key_Behavior, into, from, verbosity, &collide)) {
 591         into->behavior = from->behavior;
 592         into->defined |= _Key_Behavior;
 593     }
 594     if (UseNewKeyField(_Key_VModMap, into, from, verbosity, &collide)) {
 595         into->vmodmap = from->vmodmap;
 596         into->defined |= _Key_VModMap;
 597     }
 598     if (UseNewKeyField(_Key_Repeat, into, from, verbosity, &collide)) {
 599         into->repeat = from->repeat;
 600         into->defined |= _Key_Repeat;
 601     }
 602     if (UseNewKeyField(_Key_Type_Dflt, into, from, verbosity, &collide)) {
 603         into->dfltType = from->dfltType;
 604         into->defined |= _Key_Type_Dflt;
 605     }
 606     if (UseNewKeyField(_Key_GroupInfo, into, from, verbosity, &collide)) {
 607         into->out_of_range_group_action = from->out_of_range_group_action;
 608         into->out_of_range_group_number = from->out_of_range_group_number;
 609         into->defined |= _Key_GroupInfo;
 610     }
 611
 612     if (collide)
 613         log_warn(info->keymap->ctx,
 614                  "Symbol map for key %s redefined; "
 615                  "Using %s definition for conflicting fields\n",
 616                  longText(into->name),
 617                  (from->merge == MERGE_AUGMENT ? "first" : "last"));
 618
 619     return true;
 620 }
 621
 622 static bool
 623 AddKeySymbols(SymbolsInfo *info, KeyInfo *keyi)
 624 {
 625     unsigned long real_name;
 626     KeyInfo *iter, *new;
 627
 628     darray_foreach(iter, info->keys)
 629         if (iter->name == keyi->name)
 630             return MergeKeys(info, iter, keyi);
 631
 632     if (FindKeyNameForAlias(info->keymap, keyi->name, &real_name))
 633         darray_foreach(iter, info->keys)
 634             if (iter->name == real_name)
 635                 return MergeKeys(info, iter, keyi);
 636
 637     darray_resize0(info->keys, darray_size(info->keys) + 1);
 638     new = &darray_item(info->keys, darray_size(info->keys) - 1);
 639     return CopyKeyInfo(keyi, new, true);
 640 }
 641
 642 static bool
 643 AddModMapEntry(SymbolsInfo * info, ModMapEntry * new)
 644 {
 645     ModMapEntry *mm;
 646     bool clobber;
 647
 648     clobber = (new->merge != MERGE_AUGMENT);
 649     list_foreach(mm, &info->modMaps, entry) {
 650         if (new->haveSymbol && mm->haveSymbol
 651             && (new->u.keySym == mm->u.keySym)) {
 652             unsigned use, ignore;
 653             if (mm->modifier != new->modifier) {
 654                 if (clobber) {
 655                     use = new->modifier;
 656                     ignore = mm->modifier;
 657                 }
 658                 else {
 659                     use = mm->modifier;
 660                     ignore = new->modifier;
 661                 }
 662                 log_err(info->keymap->ctx,
 663                         "%s added to symbol map for multiple modifiers; "
 664                         "Using %s, ignoring %s.\n",
 665                         KeysymText(new->u.keySym), ModIndexText(use),
 666                         ModIndexText(ignore));
 667                 mm->modifier = use;
 668             }
 669             return true;
 670         }
 671         if ((!new->haveSymbol) && (!mm->haveSymbol) &&
 672             (new->u.keyName == mm->u.keyName)) {
 673             unsigned use, ignore;
 674             if (mm->modifier != new->modifier) {
 675                 if (clobber) {
 676                     use = new->modifier;
 677                     ignore = mm->modifier;
 678                 }
 679                 else {
 680                     use = mm->modifier;
 681                     ignore = new->modifier;
 682                 }
 683                 log_err(info->keymap->ctx,
 684                         "Key %s added to map for multiple modifiers; "
 685                         "Using %s, ignoring %s.\n",
 686                         longText(new->u.keyName), ModIndexText(use),
 687                         ModIndexText(ignore));
 688                 mm->modifier = use;
 689             }
 690             return true;
 691         }
 692     }
 693
 694     mm = malloc(sizeof(*mm));
 695     if (!mm) {
 696         log_wsgo(info->keymap->ctx,
 697                  "Could not allocate modifier map entry; "
 698                  "Modifier map for %s will be incomplete\n",
 699                  ModIndexText(new->modifier));
 700         return false;
 701     }
 702
 703     *mm = *new;
 704     list_add(&mm->entry, &info->modMaps);
 705     return true;
 706 }
 707
 708 /***====================================================================***/
 709
 710 static void
 711 MergeIncludedSymbols(SymbolsInfo *into, SymbolsInfo *from,
 712                      enum merge_mode merge)
 713 {
 714     unsigned int i;
 715     KeyInfo *keyi;
 716     ModMapEntry *mm, *next;
 717
 718     if (from->errorCount > 0) {
 719         into->errorCount += from->errorCount;
 720         return;
 721     }
 722     if (into->name == NULL) {
 723         into->name = from->name;
 724         from->name = NULL;
 725     }
 726     for (i = 0; i < XkbNumKbdGroups; i++) {
 727         if (from->groupNames[i] != XKB_ATOM_NONE) {
 728             if ((merge != MERGE_AUGMENT) ||
 729                 (into->groupNames[i] == XKB_ATOM_NONE))
 730                 into->groupNames[i] = from->groupNames[i];
 731         }
 732     }
 733
 734     darray_foreach(keyi, from->keys) {
 735         if (merge != MERGE_DEFAULT)
 736             keyi->merge = merge;
 737
 738         if (!AddKeySymbols(into, keyi))
 739             into->errorCount++;
 740     }
 741
 742     list_foreach_safe(mm, next, &from->modMaps, entry) {
 743         if (merge != MERGE_DEFAULT)
 744             mm->merge = merge;
 745         if (!AddModMapEntry(into, mm))
 746             into->errorCount++;
 747         free(mm);
 748     }
 749     list_init(&from->modMaps);
 750 }
 751
 752 static void
 753 HandleSymbolsFile(SymbolsInfo *info, XkbFile *file, enum merge_mode merge);
 754
 755 static bool
 756 HandleIncludeSymbols(SymbolsInfo *info, IncludeStmt *stmt)
 757 {
 758     enum merge_mode merge = MERGE_DEFAULT;
 759     XkbFile *rtrn;
 760     SymbolsInfo included, next_incl;
 761
 762     InitSymbolsInfo(&included, info->keymap, info->file_id);
 763     if (stmt->stmt) {
 764         free(included.name);
 765         included.name = stmt->stmt;
 766         stmt->stmt = NULL;
 767     }
 768
 769     for (; stmt; stmt = stmt->next_incl) {
 770         if (!ProcessIncludeFile(info->keymap->ctx, stmt, FILE_TYPE_SYMBOLS,
 771                                 &rtrn, &merge)) {
 772             info->errorCount += 10;
 773             FreeSymbolsInfo(&included);
 774             return false;
 775         }
 776
 777         InitSymbolsInfo(&next_incl, info->keymap, rtrn->id);
 778         next_incl.merge = next_incl.dflt.merge = MERGE_OVERRIDE;
 779         if (stmt->modifier)
 780             next_incl.explicit_group = atoi(stmt->modifier) - 1;
 781         else
 782             next_incl.explicit_group = info->explicit_group;
 783
 784         HandleSymbolsFile(&next_incl, rtrn, MERGE_OVERRIDE);
 785
 786         MergeIncludedSymbols(&included, &next_incl, merge);
 787
 788         FreeSymbolsInfo(&next_incl);
 789         FreeXKBFile(rtrn);
 790     }
 791
 792     MergeIncludedSymbols(info, &included, merge);
 793     FreeSymbolsInfo(&included);
 794
 795     return (info->errorCount == 0);
 796 }
 797
 798 #define SYMBOLS 1
 799 #define ACTIONS 2
 800
 801 static bool
 802 GetGroupIndex(SymbolsInfo *info, KeyInfo *keyi, ExprDef *arrayNdx,
 803               unsigned what, xkb_group_index_t *ndx_rtrn)
 804 {
 805     const char *name;
 806
 807     if (what == SYMBOLS)
 808         name = "symbols";
 809     else
 810         name = "actions";
 811
 812     if (arrayNdx == NULL) {
 813         xkb_group_index_t i;
 814         unsigned defined;
 815         if (what == SYMBOLS)
 816             defined = keyi->symsDefined;
 817         else
 818             defined = keyi->actsDefined;
 819
 820         for (i = 0; i < XkbNumKbdGroups; i++) {
 821             if ((defined & (1 << i)) == 0) {
 822                 *ndx_rtrn = i;
 823                 return true;
 824             }
 825         }
 826
 827         log_err(info->keymap->ctx,
 828                 "Too many groups of %s for key %s (max %u); "
 829                 "Ignoring %s defined for extra groups\n",
 830                 name, longText(keyi->name), XkbNumKbdGroups + 1, name);
 831         return false;
 832     }
 833
 834     if (!ExprResolveGroup(info->keymap->ctx, arrayNdx, ndx_rtrn)) {
 835         log_err(info->keymap->ctx,
 836                 "Illegal group index for %s of key %s\n"
 837                 "Definition with non-integer array index ignored\n",
 838                 name, longText(keyi->name));
 839         return false;
 840     }
 841
 842     (*ndx_rtrn)--;
 843     return true;
 844 }
 845
 846 static bool
 847 AddSymbolsToKey(SymbolsInfo *info, KeyInfo *keyi, ExprDef *arrayNdx,
 848                 ExprDef *value)
 849 {
 850     xkb_group_index_t ndx;
 851     size_t nSyms, nLevels;
 852     size_t i;
 853     int j;
 854
 855     if (!GetGroupIndex(info, keyi, arrayNdx, SYMBOLS, &ndx))
 856         return false;
 857     if (value == NULL) {
 858         keyi->symsDefined |= (1 << ndx);
 859         return true;
 860     }
 861     if (value->op != EXPR_KEYSYM_LIST) {
 862         log_err(info->keymap->ctx,
 863                 "Expected a list of symbols, found %s; "
 864                 "Ignoring symbols for group %u of %s\n",
 865                 exprOpText(value->op), ndx + 1, longText(keyi->name));
 866         return false;
 867     }
 868     if (!darray_empty(keyi->syms[ndx])) {
 869         log_err(info->keymap->ctx,
 870                 "Symbols for key %s, group %u already defined; "
 871                 "Ignoring duplicate definition\n",
 872                 longText(keyi->name), ndx + 1);
 873         return false;
 874     }
 875     nSyms = darray_size(value->value.list.syms);
 876     nLevels = darray_size(value->value.list.symsMapIndex);
 877     if ((keyi->numLevels[ndx] < nSyms || darray_empty(keyi->syms[ndx])) &&
 878         (!ResizeKeyGroup(keyi, ndx, nLevels, nSyms, false))) {
 879         log_wsgo(info->keymap->ctx,
 880                  "Could not resize group %u of key %s to contain %zu levels; "
 881                  "Symbols lost\n",
 882                  ndx + 1, longText(keyi->name), nSyms);
 883         return false;
 884     }
 885     keyi->symsDefined |= (1 << ndx);
 886     for (i = 0; i < nLevels; i++) {
 887         darray_item(keyi->symsMapIndex[ndx], i) =
 888             darray_item(value->value.list.symsMapIndex, i);
 889         darray_item(keyi->symsMapNumEntries[ndx], i) =
 890             darray_item(value->value.list.symsNumEntries, i);
 891
 892         for (j = 0; j < darray_item(keyi->symsMapNumEntries[ndx], i); j++) {
 893             /* FIXME: What's abort() doing here? */
 894             if (darray_item(keyi->symsMapIndex[ndx], i) + j >= nSyms)
 895                 abort();
 896             if (!LookupKeysym(darray_item(value->value.list.syms,
 897                                           darray_item(value->value.list.symsMapIndex,
 898                                                       i) + j),
 899                               &darray_item(keyi->syms[ndx],
 900                                            darray_item(keyi->symsMapIndex[ndx],
 901                                                        i) + j))) {
 902                 log_warn(info->keymap->ctx,
 903                          "Could not resolve keysym %s for key %s, group %u (%s), level %zu\n",
 904                          darray_item(value->value.list.syms, i),
 905                          longText(keyi->name),
 906                          ndx + 1,
 907                          xkb_atom_text(info->keymap->ctx,
 908                                        info->groupNames[ndx]),
 909                          nSyms);
 910                 while (--j >= 0)
 911                     darray_item(keyi->syms[ndx],
 912                                 darray_item(keyi->symsMapIndex[ndx],
 913                                             i) + j) = XKB_KEY_NoSymbol;
 914                 darray_item(keyi->symsMapIndex[ndx], i) = -1;
 915                 darray_item(keyi->symsMapNumEntries[ndx], i) = 0;
 916                 break;
 917             }
 918             if (darray_item(keyi->symsMapNumEntries[ndx], i) == 1 &&
 919                 darray_item(keyi->syms[ndx],
 920                             darray_item(keyi->symsMapIndex[ndx],
 921                                         i) + j) == XKB_KEY_NoSymbol) {
 922                 darray_item(keyi->symsMapIndex[ndx], i) = -1;
 923                 darray_item(keyi->symsMapNumEntries[ndx], i) = 0;
 924             }
 925         }
 926     }
 927     for (j = keyi->numLevels[ndx] - 1;
 928          j >= 0 && darray_item(keyi->symsMapNumEntries[ndx], j) == 0; j--)
 929         keyi->numLevels[ndx]--;
 930     return true;
 931 }
 932
 933 static bool
 934 AddActionsToKey(SymbolsInfo *info, KeyInfo *keyi, ExprDef *arrayNdx,
 935                 ExprDef *value)
 936 {
 937     size_t i;
 938     xkb_group_index_t ndx;
 939     size_t nActs;
 940     ExprDef *act;
 941     struct xkb_any_action *toAct;
 942
 943     if (!GetGroupIndex(info, keyi, arrayNdx, ACTIONS, &ndx))
 944         return false;
 945
 946     if (value == NULL) {
 947         keyi->actsDefined |= (1 << ndx);
 948         return true;
 949     }
 950
 951     if (value->op != EXPR_ACTION_LIST) {
 952         log_wsgo(info->keymap->ctx,
 953                  "Bad expression type (%d) for action list value; "
 954                  "Ignoring actions for group %u of %s\n",
 955                  value->op, ndx, longText(keyi->name));
 956         return false;
 957     }
 958
 959     if (!darray_empty(keyi->acts[ndx])) {
 960         log_wsgo(info->keymap->ctx,
 961                  "Actions for key %s, group %u already defined\n",
 962                  longText(keyi->name), ndx);
 963         return false;
 964     }
 965
 966     for (nActs = 0, act = value->value.child; act != NULL; nActs++) {
 967         act = (ExprDef *) act->common.next;
 968     }
 969
 970     if (nActs < 1) {
 971         log_wsgo(info->keymap->ctx,
 972                  "Action list but not actions in AddActionsToKey\n");
 973         return false;
 974     }
 975
 976     if ((keyi->numLevels[ndx] < nActs || darray_empty(keyi->acts[ndx])) &&
 977         !ResizeKeyGroup(keyi, ndx, nActs, nActs, true)) {
 978         log_wsgo(info->keymap->ctx,
 979                  "Could not resize group %u of key %s; "
 980                  "Actions lost\n",
 981                  ndx, longText(keyi->name));
 982         return false;
 983     }
 984     keyi->actsDefined |= (1 << ndx);
 985
 986     toAct = (struct xkb_any_action *) darray_mem(keyi->acts[ndx], 0);
 987     act = value->value.child;
 988     for (i = 0; i < nActs; i++, toAct++) {
 989         if (!HandleActionDef(act, info->keymap, toAct, info->action)) {
 990             log_err(info->keymap->ctx,
 991                     "Illegal action definition for %s; "
 992                     "Action for group %u/level %zu ignored\n",
 993                     longText(keyi->name), ndx + 1, i + 1);
 994         }
 995         act = (ExprDef *) act->common.next;
 996     }
 997
 998     return true;
 999 }
1000
1001 static const LookupEntry lockingEntries[] = {
1002     { "true", XkbKB_Lock },
1003     { "yes", XkbKB_Lock },
1004     { "on", XkbKB_Lock },
1005     { "false", XkbKB_Default },
1006     { "no", XkbKB_Default },
1007     { "off", XkbKB_Default },
1008     { "permanent", XkbKB_Lock | XkbKB_Permanent },
1009     { NULL, 0 }
1010 };
1011
1012 static const LookupEntry repeatEntries[] = {
1013     { "true", RepeatYes },
1014     { "yes", RepeatYes },
1015     { "on", RepeatYes },
1016     { "false", RepeatNo },
1017     { "no", RepeatNo },
1018     { "off", RepeatNo },
1019     { "default", RepeatUndefined },
1020     { NULL, 0 }
1021 };
1022
1023 static bool
1024 SetSymbolsField(SymbolsInfo *info, KeyInfo *keyi, const char *field,
1025                 ExprDef *arrayNdx, ExprDef *value)
1026 {
1027     bool ok = true;
1028     ExprResult tmp;
1029     struct xkb_context *ctx = info->keymap->ctx;
1030
1031     if (istreq(field, "type")) {
1032         xkb_group_index_t ndx;
1033         const char *str;
1034
1035         if (!ExprResolveString(ctx, value, &str))
1036             log_lvl(info->keymap->ctx, 1,
1037                     "The type field of a key symbol map must be a string; "
1038                     "Ignoring illegal type definition\n");
1039
1040         if (arrayNdx == NULL) {
1041             keyi->dfltType = xkb_atom_intern(ctx, str);
1042             keyi->defined |= _Key_Type_Dflt;
1043         }
1044         else if (!ExprResolveGroup(ctx, arrayNdx, &ndx)) {
1045             log_err(info->keymap->ctx,
1046                     "Illegal group index for type of key %s; "
1047                     "Definition with non-integer array index ignored\n",
1048                     longText(keyi->name));
1049             return false;
1050         }
1051         else {
1052             ndx--;
1053             keyi->types[ndx] = xkb_atom_intern(ctx, str);
1054             keyi->typesDefined |= (1 << ndx);
1055         }
1056     }
1057     else if (istreq(field, "symbols"))
1058         return AddSymbolsToKey(info, keyi, arrayNdx, value);
1059     else if (istreq(field, "actions"))
1060         return AddActionsToKey(info, keyi, arrayNdx, value);
1061     else if (istreq(field, "vmods") ||
1062              istreq(field, "virtualmods") ||
1063              istreq(field, "virtualmodifiers")) {
1064         ok = ExprResolveVModMask(info->keymap, value, &tmp);
1065         if (ok) {
1066             keyi->vmodmap = (tmp.uval >> 8);
1067             keyi->defined |= _Key_VModMap;
1068         }
1069         else {
1070             log_err(info->keymap->ctx,
1071                     "Expected a virtual modifier mask, found %s; "
1072                     "Ignoring virtual modifiers definition for key %s\n",
1073                     exprOpText(value->op), longText(keyi->name));
1074         }
1075     }
1076     else if (istreq(field, "locking") ||
1077              istreq(field, "lock") ||
1078              istreq(field, "locks")) {
1079         ok = ExprResolveEnum(ctx, value, &tmp, lockingEntries);
1080         if (ok)
1081             keyi->behavior.type = tmp.uval;
1082         keyi->defined |= _Key_Behavior;
1083     }
1084     else if (istreq(field, "radiogroup") ||
1085              istreq(field, "permanentradiogroup") ||
1086              istreq(field, "allownone")) {
1087         log_err(info->keymap->ctx,
1088                 "Radio groups not supported; "
1089                 "Ignoring radio group specification for key %s\n",
1090                 longText(keyi->name));
1091         return false;
1092     }
1093     else if (istreq_prefix("overlay", field) ||
1094              istreq_prefix("permanentoverlay", field)) {
1095         log_err(info->keymap->ctx,
1096                 "Overlays not supported; "
1097                 "Ignoring overlay specification for key %s\n",
1098                 longText(keyi->name));
1099     }
1100     else if (istreq(field, "repeating") ||
1101              istreq(field, "repeats") ||
1102              istreq(field, "repeat")) {
1103         ok = ExprResolveEnum(ctx, value, &tmp, repeatEntries);
1104         if (!ok) {
1105             log_err(info->keymap->ctx,
1106                     "Illegal repeat setting for %s; "
1107                     "Non-boolean repeat setting ignored\n",
1108                     longText(keyi->name));
1109             return false;
1110         }
1111         keyi->repeat = tmp.uval;
1112         keyi->defined |= _Key_Repeat;
1113     }
1114     else if (istreq(field, "groupswrap") ||
1115              istreq(field, "wrapgroups")) {
1116         bool set;
1117
1118         if (!ExprResolveBoolean(ctx, value, &set)) {
1119             log_err(info->keymap->ctx,
1120                     "Illegal groupsWrap setting for %s; "
1121                     "Non-boolean value ignored\n",
1122                     longText(keyi->name));
1123             return false;
1124         }
1125
1126         if (set)
1127             keyi->out_of_range_group_action = XkbWrapIntoRange;
1128         else
1129             keyi->out_of_range_group_action = XkbClampIntoRange;
1130
1131         keyi->defined |= _Key_GroupInfo;
1132     }
1133     else if (istreq(field, "groupsclamp") ||
1134              istreq(field, "clampgroups")) {
1135         bool set;
1136
1137         if (!ExprResolveBoolean(ctx, value, &set)) {
1138             log_err(info->keymap->ctx,
1139                     "Illegal groupsClamp setting for %s; "
1140                     "Non-boolean value ignored\n",
1141                     longText(keyi->name));
1142             return false;
1143         }
1144
1145         if (set)
1146             keyi->out_of_range_group_action = XkbClampIntoRange;
1147         else
1148             keyi->out_of_range_group_action = XkbWrapIntoRange;
1149
1150         keyi->defined |= _Key_GroupInfo;
1151     }
1152     else if (istreq(field, "groupsredirect") ||
1153              istreq(field, "redirectgroups")) {
1154         xkb_group_index_t grp;
1155
1156         if (!ExprResolveGroup(ctx, value, &grp)) {
1157             log_err(info->keymap->ctx,
1158                     "Illegal group index for redirect of key %s; "
1159                     "Definition with non-integer group ignored\n",
1160                     longText(keyi->name));
1161             return false;
1162         }
1163
1164         keyi->out_of_range_group_action = XkbRedirectIntoRange;
1165         keyi->out_of_range_group_number = grp - 1;
1166         keyi->defined |= _Key_GroupInfo;
1167     }
1168     else {
1169         log_err(info->keymap->ctx,
1170                 "Unknown field %s in a symbol interpretation; "
1171                 "Definition ignored\n",
1172                 field);
1173         ok = false;
1174     }
1175     return ok;
1176 }
1177
1178 static int
1179 SetGroupName(SymbolsInfo *info, ExprDef *arrayNdx, ExprDef *value)
1180 {
1181     xkb_group_index_t grp;
1182     const char *name;
1183
1184     if (!arrayNdx) {
1185         log_lvl(info->keymap->ctx, 1,
1186                 "You must specify an index when specifying a group name; "
1187                 "Group name definition without array subscript ignored\n");
1188         return false;
1189     }
1190
1191     if (!ExprResolveGroup(info->keymap->ctx, arrayNdx, &grp)) {
1192         log_err(info->keymap->ctx,
1193                 "Illegal index in group name definition; "
1194                 "Definition with non-integer array index ignored\n");
1195         return false;
1196     }
1197
1198     if (!ExprResolveString(info->keymap->ctx, value, &name)) {
1199         log_err(info->keymap->ctx,
1200                 "Group name must be a string; "
1201                 "Illegal name for group %d ignored\n", grp);
1202         return false;
1203     }
1204
1205     info->groupNames[grp - 1 + info->explicit_group] =
1206         xkb_atom_intern(info->keymap->ctx, name);
1207
1208     return true;
1209 }
1210
1211 static int
1212 HandleSymbolsVar(SymbolsInfo *info, VarDef *stmt)
1213 {
1214     const char *elem, *field;
1215     ExprDef *arrayNdx;
1216     bool ret;
1217
1218     if (ExprResolveLhs(info->keymap->ctx, stmt->name, &elem, &field,
1219                        &arrayNdx) == 0)
1220         return 0;               /* internal error, already reported */
1221     if (elem && istreq(elem, "key")) {
1222         ret = SetSymbolsField(info, &info->dflt, field, arrayNdx,
1223                               stmt->value);
1224     }
1225     else if (!elem && (istreq(field, "name") ||
1226                        istreq(field, "groupname"))) {
1227         ret = SetGroupName(info, arrayNdx, stmt->value);
1228     }
1229     else if (!elem && (istreq(field, "groupswrap") ||
1230                        istreq(field, "wrapgroups"))) {
1231         log_err(info->keymap->ctx,
1232                 "Global \"groupswrap\" not supported; Ignored\n");
1233         ret = true;
1234     }
1235     else if (!elem && (istreq(field, "groupsclamp") ||
1236                        istreq(field, "clampgroups"))) {
1237         log_err(info->keymap->ctx,
1238                 "Global \"groupsclamp\" not supported; Ignored\n");
1239         ret = true;
1240     }
1241     else if (!elem && (istreq(field, "groupsredirect") ||
1242                        istreq(field, "redirectgroups"))) {
1243         log_err(info->keymap->ctx,
1244                 "Global \"groupsredirect\" not supported; Ignored\n");
1245         ret = true;
1246     }
1247     else if (!elem && istreq(field, "allownone")) {
1248         log_err(info->keymap->ctx,
1249                 "Radio groups not supported; "
1250                 "Ignoring \"allownone\" specification\n");
1251         ret = true;
1252     }
1253     else {
1254         ret = SetActionField(info->keymap, elem, field, arrayNdx,
1255                              stmt->value, &info->action);
1256     }
1257
1258     return ret;
1259 }
1260
1261 static bool
1262 HandleSymbolsBody(SymbolsInfo *info, VarDef *def, KeyInfo *keyi)
1263 {
1264     bool ok = true;
1265     const char *elem, *field;
1266     ExprDef *arrayNdx;
1267
1268     for (; def; def = (VarDef *) def->common.next) {
1269         if (def->name && def->name->op == EXPR_FIELD_REF) {
1270             ok = HandleSymbolsVar(info, def);
1271             continue;
1272         }
1273
1274         if (!def->name) {
1275             if (!def->value || def->value->op == EXPR_KEYSYM_LIST)
1276                 field = "symbols";
1277             else
1278                 field = "actions";
1279             arrayNdx = NULL;
1280         }
1281         else {
1282             ok = ExprResolveLhs(info->keymap->ctx, def->name, &elem, &field,
1283                                 &arrayNdx);
1284         }
1285
1286         if (ok)
1287             ok = SetSymbolsField(info, keyi, field, arrayNdx, def->value);
1288     }
1289
1290     return ok;
1291 }
1292
1293 static bool
1294 SetExplicitGroup(SymbolsInfo *info, KeyInfo *keyi)
1295 {
1296     xkb_group_index_t group = info->explicit_group;
1297
1298     if (group == 0)
1299         return true;
1300
1301     if ((keyi->typesDefined | keyi->symsDefined | keyi->actsDefined) & ~1) {
1302         xkb_group_index_t i;
1303         log_warn(info->keymap->ctx,
1304                  "For the map %s an explicit group specified\n",
1305                  info->name);
1306         log_warn(info->keymap->ctx,
1307                  "but key %s has more than one group defined; "
1308                  "All groups except first one will be ignored\n",
1309                  longText(keyi->name));
1310         for (i = 1; i < XkbNumKbdGroups; i++) {
1311             keyi->numLevels[i] = 0;
1312             darray_free(keyi->syms[i]);
1313             darray_free(keyi->acts[i]);
1314             keyi->types[i] = 0;
1315         }
1316     }
1317     keyi->typesDefined = keyi->symsDefined = keyi->actsDefined = 1 << group;
1318
1319     keyi->numLevels[group] = keyi->numLevels[0];
1320     keyi->numLevels[0] = 0;
1321     keyi->syms[group] = keyi->syms[0];
1322     darray_init(keyi->syms[0]);
1323     keyi->symsMapIndex[group] = keyi->symsMapIndex[0];
1324     darray_init(keyi->symsMapIndex[0]);
1325     keyi->symsMapNumEntries[group] = keyi->symsMapNumEntries[0];
1326     darray_init(keyi->symsMapNumEntries[0]);
1327     keyi->acts[group] = keyi->acts[0];
1328     darray_init(keyi->acts[0]);
1329     keyi->types[group] = keyi->types[0];
1330     keyi->types[0] = 0;
1331     return true;
1332 }
1333
1334 static int
1335 HandleSymbolsDef(SymbolsInfo *info, SymbolsDef *stmt)
1336 {
1337     KeyInfo keyi;
1338
1339     InitKeyInfo(&keyi, info->file_id);
1340     CopyKeyInfo(&info->dflt, &keyi, false);
1341     keyi.merge = stmt->merge;
1342     keyi.name = KeyNameToLong(stmt->keyName);
1343     if (!HandleSymbolsBody(info, (VarDef *) stmt->symbols, &keyi)) {
1344         info->errorCount++;
1345         return false;
1346     }
1347
1348     if (!SetExplicitGroup(info, &keyi)) {
1349         info->errorCount++;
1350         return false;
1351     }
1352
1353     if (!AddKeySymbols(info, &keyi)) {
1354         info->errorCount++;
1355         return false;
1356     }
1357     return true;
1358 }
1359
1360 static bool
1361 HandleModMapDef(SymbolsInfo *info, ModMapDef *def)
1362 {
1363     ExprDef *key;
1364     ModMapEntry tmp;
1365     ExprResult rtrn;
1366     bool ok;
1367     struct xkb_context *ctx = info->keymap->ctx;
1368
1369     if (!LookupModIndex(ctx, NULL, def->modifier, EXPR_TYPE_INT, &rtrn)) {
1370         log_err(info->keymap->ctx,
1371                 "Illegal modifier map definition; "
1372                 "Ignoring map for non-modifier \"%s\"\n",
1373                 xkb_atom_text(ctx, def->modifier));
1374         return false;
1375     }
1376     ok = true;
1377     tmp.modifier = rtrn.uval;
1378     for (key = def->keys; key != NULL; key = (ExprDef *) key->common.next) {
1379         xkb_keysym_t sym;
1380
1381         if (key->op == EXPR_VALUE && key->value_type == EXPR_TYPE_KEYNAME) {
1382             tmp.haveSymbol = false;
1383             tmp.u.keyName = KeyNameToLong(key->value.keyName);
1384         }
1385         else if (ExprResolveKeySym(ctx, key, &sym)) {
1386             tmp.haveSymbol = true;
1387             tmp.u.keySym = sym;
1388         }
1389         else {
1390             log_err(info->keymap->ctx,
1391                     "Modmap entries may contain only key names or keysyms; "
1392                     "Illegal definition for %s modifier ignored\n",
1393                     ModIndexText(tmp.modifier));
1394             continue;
1395         }
1396
1397         ok = AddModMapEntry(info, &tmp) && ok;
1398     }
1399     return ok;
1400 }
1401
1402 static void
1403 HandleSymbolsFile(SymbolsInfo *info, XkbFile *file, enum merge_mode merge)
1404 {
1405     ParseCommon *stmt;
1406
1407     free(info->name);
1408     info->name = strdup_safe(file->name);
1409     stmt = file->defs;
1410     while (stmt)
1411     {
1412         switch (stmt->type) {
1413         case STMT_INCLUDE:
1414             if (!HandleIncludeSymbols(info, (IncludeStmt *) stmt))
1415                 info->errorCount++;
1416             break;
1417         case STMT_SYMBOLS:
1418             if (!HandleSymbolsDef(info, (SymbolsDef *) stmt))
1419                 info->errorCount++;
1420             break;
1421         case STMT_VAR:
1422             if (!HandleSymbolsVar(info, (VarDef *) stmt))
1423                 info->errorCount++;
1424             break;
1425         case STMT_VMOD:
1426             if (!HandleVModDef((VModDef *) stmt, info->keymap, merge,
1427                                &info->vmods))
1428                 info->errorCount++;
1429             break;
1430         case STMT_INTERP:
1431             log_err(info->keymap->ctx,
1432                     "Interpretation files may not include other types; "
1433                     "Ignoring definition of symbol interpretation\n");
1434             info->errorCount++;
1435             break;
1436         case STMT_KEYCODE:
1437             log_err(info->keymap->ctx,
1438                     "Interpretation files may not include other types; "
1439                     "Ignoring definition of key name\n");
1440             info->errorCount++;
1441             break;
1442         case STMT_MODMAP:
1443             if (!HandleModMapDef(info, (ModMapDef *) stmt))
1444                 info->errorCount++;
1445             break;
1446         default:
1447             log_wsgo(info->keymap->ctx,
1448                      "Unexpected statement type %d in HandleSymbolsFile\n",
1449                      stmt->type);
1450             break;
1451         }
1452         stmt = stmt->next;
1453         if (info->errorCount > 10) {
1454             log_err(info->keymap->ctx, "Abandoning symbols file \"%s\"\n",
1455                     file->topName);
1456             break;
1457         }
1458     }
1459 }
1460
1461 /**
1462  * Given a keysym @sym, return a key which generates it, or NULL.
1463  * This is used for example in a modifier map definition, such as:
1464  *      modifier_map Lock           { Caps_Lock };
1465  * where we want to add the Lock modifier to the modmap of the key
1466  * which matches the keysym Caps_Lock.
1467  * Since there can be many keys which generates the keysym, the key
1468  * is chosen first by lowest group in which the keysym appears, than
1469  * by lowest level and than by lowest key code.
1470  */
1471 static struct xkb_key *
1472 FindKeyForSymbol(struct xkb_keymap *keymap, xkb_keysym_t sym)
1473 {
1474     struct xkb_key *key, *ret = NULL;
1475     xkb_group_index_t group, min_group = UINT_MAX;
1476     unsigned int level, min_level = UINT_MAX;
1477
1478     xkb_foreach_key(key, keymap) {
1479         for (group = 0; group < key->num_groups; group++) {
1480             for (level = 0; level < XkbKeyGroupWidth(keymap, key, group);
1481                  level++) {
1482                 if (XkbKeyNumSyms(key, group, level) != 1 ||
1483                     (XkbKeySymEntry(key, group, level))[0] != sym)
1484                     continue;
1485
1486                 /*
1487                  * If the keysym was found in a group or level > 0, we must
1488                  * keep looking since we might find a key in which the keysym
1489                  * is in a lower group or level.
1490                  */
1491                 if (group < min_group ||
1492                     (group == min_group && level < min_level)) {
1493                     ret = key;
1494                     if (group == 0 && level == 0) {
1495                         return ret;
1496                     }
1497                     else {
1498                         min_group = group;
1499                         min_level = level;
1500                     }
1501                 }
1502             }
1503         }
1504     }
1505
1506     return ret;
1507 }
1508
1509 /**
1510  * Find the given name in the keymap->map->types and return its index.
1511  *
1512  * @param atom The atom to search for.
1513  * @param type_rtrn Set to the index of the name if found.
1514  *
1515  * @return true if found, false otherwise.
1516  */
1517 static bool
1518 FindNamedType(struct xkb_keymap *keymap, xkb_atom_t atom, unsigned *type_rtrn)
1519 {
1520     unsigned n = 0;
1521     const char *name = xkb_atom_text(keymap->ctx, atom);
1522     struct xkb_key_type *type;
1523
1524     if (keymap) {
1525         darray_foreach(type, keymap->types) {
1526             if (streq(type->name, name)) {
1527                 *type_rtrn = n;
1528                 return true;
1529             }
1530             n++;
1531         }
1532     }
1533     return false;
1534 }
1535
1536 /**
1537  * Assign a type to the given sym and return the Atom for the type assigned.
1538  *
1539  * Simple recipe:
1540  * - ONE_LEVEL for width 0/1
1541  * - ALPHABETIC for 2 shift levels, with lower/upercase
1542  * - KEYPAD for keypad keys.
1543  * - TWO_LEVEL for other 2 shift level keys.
1544  * and the same for four level keys.
1545  *
1546  * @param width Number of sysms in syms.
1547  * @param syms The keysyms for the given key (must be size width).
1548  * @param typeNameRtrn Set to the Atom of the type name.
1549  *
1550  * @returns true if a type could be found, false otherwise.
1551  *
1552  * FIXME: I need to take the KeyInfo so I can look at symsMapIndex and
1553  *        all that fun stuff rather than just assuming there's always one
1554  *        symbol per level.
1555  */
1556 static bool
1557 FindAutomaticType(struct xkb_keymap *keymap, int width,
1558                   const xkb_keysym_t *syms, xkb_atom_t *typeNameRtrn,
1559                   bool *autoType)
1560 {
1561     *autoType = false;
1562     if ((width == 1) || (width == 0)) {
1563         *typeNameRtrn = xkb_atom_intern(keymap->ctx, "ONE_LEVEL");
1564         *autoType = true;
1565     }
1566     else if (width == 2) {
1567         if (syms && xkb_keysym_is_lower(syms[0]) &&
1568             xkb_keysym_is_upper(syms[1])) {
1569             *typeNameRtrn = xkb_atom_intern(keymap->ctx, "ALPHABETIC");
1570         }
1571         else if (syms && (xkb_keysym_is_keypad(syms[0]) ||
1572                           xkb_keysym_is_keypad(syms[1]))) {
1573             *typeNameRtrn = xkb_atom_intern(keymap->ctx, "KEYPAD");
1574             *autoType = true;
1575         }
1576         else {
1577             *typeNameRtrn = xkb_atom_intern(keymap->ctx, "TWO_LEVEL");
1578             *autoType = true;
1579         }
1580     }
1581     else if (width <= 4) {
1582         if (syms && xkb_keysym_is_lower(syms[0]) &&
1583             xkb_keysym_is_upper(syms[1]))
1584             if (xkb_keysym_is_lower(syms[2]) && xkb_keysym_is_upper(syms[3]))
1585                 *typeNameRtrn =
1586                     xkb_atom_intern(keymap->ctx, "FOUR_LEVEL_ALPHABETIC");
1587             else
1588                 *typeNameRtrn = xkb_atom_intern(keymap->ctx,
1589                                                 "FOUR_LEVEL_SEMIALPHABETIC");
1590
1591         else if (syms && (xkb_keysym_is_keypad(syms[0]) ||
1592                           xkb_keysym_is_keypad(syms[1])))
1593             *typeNameRtrn = xkb_atom_intern(keymap->ctx, "FOUR_LEVEL_KEYPAD");
1594         else
1595             *typeNameRtrn = xkb_atom_intern(keymap->ctx, "FOUR_LEVEL");
1596         /* XXX: why not set autoType here? */
1597     }
1598     return ((width >= 0) && (width <= 4));
1599 }
1600
1601 /**
1602  * Ensure the given KeyInfo is in a coherent state, i.e. no gaps between the
1603  * groups, and reduce to one group if all groups are identical anyway.
1604  */
1605 static void
1606 PrepareKeyDef(KeyInfo *keyi)
1607 {
1608     xkb_group_index_t i, lastGroup;
1609     int j, width, defined;
1610     bool identical;
1611
1612     defined = keyi->symsDefined | keyi->actsDefined | keyi->typesDefined;
1613     /* get highest group number */
1614     for (i = XkbNumKbdGroups - 1; i > 0; i--) {
1615         if (defined & (1 << i))
1616             break;
1617     }
1618     lastGroup = i;
1619
1620     if (lastGroup == 0)
1621         return;
1622
1623     /* If there are empty groups between non-empty ones fill them with data */
1624     /* from the first group. */
1625     /* We can make a wrong assumption here. But leaving gaps is worse. */
1626     for (i = lastGroup; i > 0; i--) {
1627         if (defined & (1 << i))
1628             continue;
1629         width = keyi->numLevels[0];
1630         if (keyi->typesDefined & 1) {
1631             for (j = 0; j < width; j++) {
1632                 keyi->types[i] = keyi->types[0];
1633             }
1634             keyi->typesDefined |= 1 << i;
1635         }
1636         if ((keyi->actsDefined & 1) && !darray_empty(keyi->acts[0])) {
1637             darray_copy(keyi->acts[i], keyi->acts[0]);
1638             keyi->actsDefined |= 1 << i;
1639         }
1640         if ((keyi->symsDefined & 1) && !darray_empty(keyi->syms[0])) {
1641             darray_copy(keyi->syms[i], keyi->syms[0]);
1642             darray_copy(keyi->symsMapIndex[i], keyi->symsMapIndex[0]);
1643             darray_copy(keyi->symsMapNumEntries[i],
1644                         keyi->symsMapNumEntries[0]);
1645             keyi->symsDefined |= 1 << i;
1646         }
1647         if (defined & 1) {
1648             keyi->numLevels[i] = keyi->numLevels[0];
1649         }
1650     }
1651     /* If all groups are completely identical remove them all */
1652     /* exept the first one. */
1653     identical = true;
1654     for (i = lastGroup; i > 0; i--) {
1655         if ((keyi->numLevels[i] != keyi->numLevels[0]) ||
1656             (keyi->types[i] != keyi->types[0])) {
1657             identical = false;
1658             break;
1659         }
1660         if (!darray_same(keyi->syms[i], keyi->syms[0]) &&
1661             (darray_empty(keyi->syms[i]) || darray_empty(keyi->syms[0]) ||
1662              darray_size(keyi->syms[i]) != darray_size(keyi->syms[0]) ||
1663              memcmp(darray_mem(keyi->syms[i], 0),
1664                     darray_mem(keyi->syms[0], 0),
1665                     sizeof(xkb_keysym_t) * darray_size(keyi->syms[0])))) {
1666             identical = false;
1667             break;
1668         }
1669         if (!darray_same(keyi->symsMapIndex[i], keyi->symsMapIndex[0]) &&
1670             (darray_empty(keyi->symsMapIndex[i]) ||
1671              darray_empty(keyi->symsMapIndex[0]) ||
1672              memcmp(darray_mem(keyi->symsMapIndex[i], 0),
1673                     darray_mem(keyi->symsMapIndex[0], 0),
1674                     keyi->numLevels[0] * sizeof(int)))) {
1675             identical = false;
1676             continue;
1677         }
1678         if (!darray_same(keyi->symsMapNumEntries[i],
1679                          keyi->symsMapNumEntries[0]) &&
1680             (darray_empty(keyi->symsMapNumEntries[i]) ||
1681              darray_empty(keyi->symsMapNumEntries[0]) ||
1682              memcmp(darray_mem(keyi->symsMapNumEntries[i], 0),
1683                     darray_mem(keyi->symsMapNumEntries[0], 0),
1684                     keyi->numLevels[0] * sizeof(size_t)))) {
1685             identical = false;
1686             continue;
1687         }
1688         if (!darray_same(keyi->acts[i], keyi->acts[0]) &&
1689             (darray_empty(keyi->acts[i]) || darray_empty(keyi->acts[0]) ||
1690              memcmp(darray_mem(keyi->acts[i], 0),
1691                     darray_mem(keyi->acts[0], 0),
1692                     keyi->numLevels[0] * sizeof(union xkb_action)))) {
1693             identical = false;
1694             break;
1695         }
1696     }
1697     if (identical) {
1698         for (i = lastGroup; i > 0; i--) {
1699             keyi->numLevels[i] = 0;
1700             darray_free(keyi->syms[i]);
1701             darray_free(keyi->symsMapIndex[i]);
1702             darray_free(keyi->symsMapNumEntries[i]);
1703             darray_free(keyi->acts[i]);
1704             keyi->types[i] = 0;
1705         }
1706         keyi->symsDefined &= 1;
1707         keyi->actsDefined &= 1;
1708         keyi->typesDefined &= 1;
1709     }
1710 }
1711
1712 /**
1713  * Copy the KeyInfo into the keyboard description.
1714  *
1715  * This function recurses.
1716  */
1717 static bool
1718 CopySymbolsDef(SymbolsInfo *info, KeyInfo *keyi,
1719                xkb_keycode_t start_from)
1720 {
1721     struct xkb_keymap *keymap = info->keymap;
1722     xkb_keycode_t kc;
1723     struct xkb_key *key;
1724     size_t sizeSyms = 0;
1725     xkb_group_index_t i, nGroups;
1726     unsigned width, tmp;
1727     struct xkb_key_type * type;
1728     bool haveActions, autoType, useAlias;
1729     unsigned types[XkbNumKbdGroups];
1730     union xkb_action *outActs;
1731     unsigned int symIndex = 0;
1732
1733     useAlias = (start_from == 0);
1734
1735     key = FindNamedKey(keymap, keyi->name, useAlias,
1736                        CreateKeyNames(keymap), start_from);
1737     if (!key) {
1738         if (start_from == 0)
1739             log_lvl(info->keymap->ctx, 5,
1740                     "Key %s not found in keycodes; Symbols ignored\n",
1741                     longText(keyi->name));
1742         return false;
1743     }
1744     kc = XkbKeyGetKeycode(keymap, key);
1745
1746     haveActions = false;
1747     width = 0;
1748     for (i = nGroups = 0; i < XkbNumKbdGroups; i++) {
1749         if (((i + 1) > nGroups)
1750             && (((keyi->symsDefined | keyi->actsDefined) & (1 << i))
1751                 || (keyi->typesDefined) & (1 << i)))
1752             nGroups = i + 1;
1753         if (!darray_empty(keyi->acts[i]))
1754             haveActions = true;
1755         autoType = false;
1756         /* Assign the type to the key, if it is missing. */
1757         if (keyi->types[i] == XKB_ATOM_NONE) {
1758             if (keyi->dfltType != XKB_ATOM_NONE)
1759                 keyi->types[i] = keyi->dfltType;
1760             else if (FindAutomaticType(keymap, keyi->numLevels[i],
1761                                        darray_mem(keyi->syms[i], 0),
1762                                        &keyi->types[i], &autoType)) { }
1763             else
1764                 log_lvl(info->keymap->ctx, 5,
1765                         "No automatic type for %d symbols; "
1766                         "Using %s for the %s key (keycode %d)\n",
1767                         keyi->numLevels[i],
1768                         xkb_atom_text(keymap->ctx, keyi->types[i]),
1769                         longText(keyi->name), kc);
1770         }
1771         if (FindNamedType(keymap, keyi->types[i], &types[i])) {
1772             if (!autoType || keyi->numLevels[i] > 2)
1773                 key->explicit |= (1 << i);
1774         }
1775         else {
1776             log_lvl(info->keymap->ctx, 3,
1777                     "Type \"%s\" is not defined; "
1778                     "Using TWO_LEVEL for the %s key (keycode %d)\n",
1779                     xkb_atom_text(keymap->ctx, keyi->types[i]),
1780                     longText(keyi->name), kc);
1781             types[i] = XkbTwoLevelIndex;
1782         }
1783
1784         /* if the type specifies fewer levels than the key has, shrink the key */
1785         type = &darray_item(keymap->types, types[i]);
1786         if (type->num_levels < keyi->numLevels[i]) {
1787             log_lvl(info->keymap->ctx, 1,
1788                     "Type \"%s\" has %d levels, but %s has %d symbols; "
1789                     "Ignoring extra symbols\n",
1790                     type->name, type->num_levels,
1791                     longText(keyi->name),
1792                     keyi->numLevels[i]);
1793             keyi->numLevels[i] = type->num_levels;
1794         }
1795         if (keyi->numLevels[i] > width)
1796             width = keyi->numLevels[i];
1797         if (type->num_levels > width)
1798             width = type->num_levels;
1799         sizeSyms += darray_size(keyi->syms[i]);
1800     }
1801
1802     darray_resize0(key->syms, sizeSyms);
1803
1804     if (haveActions) {
1805         outActs = ResizeKeyActions(keymap, key, width * nGroups);
1806         if (outActs == NULL) {
1807             log_wsgo(info->keymap->ctx,
1808                      "Could not enlarge actions for %s (key %d)\n",
1809                      longText(keyi->name), kc);
1810             return false;
1811         }
1812         key->explicit |= XkbExplicitInterpretMask;
1813     }
1814     else
1815         outActs = NULL;
1816
1817     key->num_groups = nGroups;
1818     if (keyi->defined & _Key_GroupInfo) {
1819         key->out_of_range_group_number = keyi->out_of_range_group_number;
1820         key->out_of_range_group_action = keyi->out_of_range_group_action;
1821     }
1822     key->width = width;
1823     key->sym_index = calloc(nGroups * width, sizeof(*key->sym_index));
1824     key->num_syms = calloc(nGroups * width, sizeof(*key->num_syms));
1825
1826     for (i = 0; i < nGroups; i++) {
1827         /* assign kt_index[i] to the index of the type in map->types.
1828          * kt_index[i] may have been set by a previous run (if we have two
1829          * layouts specified). Let's not overwrite it with the ONE_LEVEL
1830          * default group if we dont even have keys for this group anyway.
1831          *
1832          * FIXME: There should be a better fix for this.
1833          */
1834         if (keyi->numLevels[i])
1835             key->kt_index[i] = types[i];
1836         if (!darray_empty(keyi->syms[i])) {
1837             /* fill key to "width" symbols*/
1838             for (tmp = 0; tmp < width; tmp++) {
1839                 if (tmp < keyi->numLevels[i] &&
1840                     darray_item(keyi->symsMapNumEntries[i], tmp) != 0) {
1841                     memcpy(darray_mem(key->syms, symIndex),
1842                            darray_mem(keyi->syms[i],
1843                                       darray_item(keyi->symsMapIndex[i], tmp)),
1844                            darray_item(keyi->symsMapNumEntries[i],
1845                                        tmp) * sizeof(xkb_keysym_t));
1846                     key->sym_index[(i * width) + tmp] = symIndex;
1847                     key->num_syms[(i * width) + tmp] =
1848                         darray_item(keyi->symsMapNumEntries[i], tmp);
1849                     symIndex += key->num_syms[(i * width) + tmp];
1850                 }
1851                 else {
1852                     key->sym_index[(i * width) + tmp] = -1;
1853                     key->num_syms[(i * width) + tmp] = 0;
1854                 }
1855                 if (outActs != NULL && !darray_empty(keyi->acts[i])) {
1856                     if (tmp < keyi->numLevels[i])
1857                         outActs[tmp] = darray_item(keyi->acts[i], tmp);
1858                     else
1859                         outActs[tmp].type = XkbSA_NoAction;
1860                 }
1861             }
1862         }
1863     }
1864     switch (keyi->behavior.type & XkbKB_OpMask) {
1865     case XkbKB_Default:
1866         break;
1867
1868     default:
1869         key->behavior = keyi->behavior;
1870         key->explicit |= XkbExplicitBehaviorMask;
1871         break;
1872     }
1873     if (keyi->defined & _Key_VModMap) {
1874         key->vmodmap = keyi->vmodmap;
1875         key->explicit |= XkbExplicitVModMapMask;
1876     }
1877     if (keyi->repeat != RepeatUndefined) {
1878         key->repeats = keyi->repeat == RepeatYes;
1879         key->explicit |= XkbExplicitAutoRepeatMask;
1880     }
1881
1882     /* do the same thing for the next key */
1883     CopySymbolsDef(info, keyi, kc + 1);
1884     return true;
1885 }
1886
1887 static bool
1888 CopyModMapDef(SymbolsInfo *info, ModMapEntry *entry)
1889 {
1890     struct xkb_key *key;
1891     struct xkb_keymap *keymap = info->keymap;
1892
1893     if (!entry->haveSymbol) {
1894         key = FindNamedKey(keymap, entry->u.keyName, true,
1895                            CreateKeyNames(keymap), 0);
1896         if (!key) {
1897             log_lvl(info->keymap->ctx, 5,
1898                     "Key %s not found in keycodes; "
1899                     "Modifier map entry for %s not updated\n",
1900                     longText(entry->u.keyName),
1901                     ModIndexText(entry->modifier));
1902             return false;
1903         }
1904     }
1905     else {
1906         key = FindKeyForSymbol(keymap, entry->u.keySym);
1907         if (!key) {
1908             log_lvl(info->keymap->ctx, 5,
1909                     "Key \"%s\" not found in symbol map; "
1910                     "Modifier map entry for %s not updated\n",
1911                     KeysymText(entry->u.keySym),
1912                     ModIndexText(entry->modifier));
1913             return false;
1914         }
1915     }
1916
1917     key->modmap |= (1 << entry->modifier);
1918     return true;
1919 }
1920
1921 /**
1922  * Handle the xkb_symbols section of an xkb file.
1923  *
1924  * @param file The parsed xkb_symbols section of the xkb file.
1925  * @param keymap Handle to the keyboard description to store the symbols in.
1926  * @param merge Merge strategy (e.g. MERGE_OVERRIDE).
1927  */
1928 bool
1929 CompileSymbols(XkbFile *file, struct xkb_keymap *keymap,
1930                enum merge_mode merge)
1931 {
1932     xkb_group_index_t i;
1933     struct xkb_key *key;
1934     SymbolsInfo info;
1935     KeyInfo *keyi;
1936     ModMapEntry *mm;
1937
1938     InitSymbolsInfo(&info, keymap, file->id);
1939     info.dflt.merge = merge;
1940
1941     HandleSymbolsFile(&info, file, merge);
1942
1943     if (darray_empty(info.keys))
1944         goto err_info;
1945
1946     if (info.errorCount != 0)
1947         goto err_info;
1948
1949     darray_resize0(keymap->acts, darray_size(keymap->acts) + 32 + 1);
1950
1951     if (info.name)
1952         keymap->symbols_section_name = strdup(info.name);
1953
1954     for (i = 0; i < XkbNumKbdGroups; i++) {
1955         if (info.groupNames[i] != XKB_ATOM_NONE) {
1956             keymap->group_names[i] = xkb_atom_text(keymap->ctx,
1957                                                    info.groupNames[i]);
1958         }
1959     }
1960
1961     /* sanitize keys */
1962     darray_foreach(keyi, info.keys)
1963         PrepareKeyDef(keyi);
1964
1965     /* copy! */
1966     darray_foreach(keyi, info.keys)
1967         if (!CopySymbolsDef(&info, keyi, 0))
1968             info.errorCount++;
1969
1970     if (xkb_get_log_verbosity(keymap->ctx) > 3) {
1971         xkb_foreach_key(key, keymap) {
1972             if (key->name[0] == '\0')
1973                 continue;
1974
1975             if (key->num_groups < 1)
1976                 log_warn(info.keymap->ctx,
1977                          "No symbols defined for <%.4s> (keycode %d)\n",
1978                          key->name, XkbKeyGetKeycode(keymap, key));
1979         }
1980     }
1981
1982     list_foreach(mm, &info.modMaps, entry)
1983         if (!CopyModMapDef(&info, mm))
1984             info.errorCount++;
1985
1986     FreeSymbolsInfo(&info);
1987     return true;
1988
1989 err_info:
1990     FreeSymbolsInfo(&info);
1991     return false;
1992 }