src/xkbcomp/keymap.c

   1 /*
   2  * Copyright © 2009 Dan Nicholson
   3  * Copyright © 2012 Intel Corporation
   4  * Copyright © 2012 Ran Benita <ran234@gmail.com>
   5  *
   6  * Permission is hereby granted, free of charge, to any person obtaining a
   7  * copy of this software and associated documentation files (the "Software"),
   8  * to deal in the Software without restriction, including without limitation
   9  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
  10  * and/or sell copies of the Software, and to permit persons to whom the
  11  * Software is furnished to do so, subject to the following conditions:
  12  *
  13  * The above copyright notice and this permission notice (including the next
  14  * paragraph) shall be included in all copies or substantial portions of the
  15  * Software.
  16  *
  17  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  18  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  19  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  20  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  21  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  22  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  23  * DEALINGS IN THE SOFTWARE.
  24  *
  25  * Author: Dan Nicholson <dbn.lists@gmail.com>
  26  *         Daniel Stone <daniel@fooishbar.org>
  27  *         Ran Benita <ran234@gmail.com>
  28  */
  29
  30 #include "xkbcomp-priv.h"
  31
  32 static void
  33 ComputeEffectiveMask(struct xkb_keymap *keymap, struct xkb_mods *mods)
  34 {
  35     xkb_mod_index_t i;
  36     xkb_mod_mask_t vmask = mods->mods >> XKB_NUM_CORE_MODS;
  37
  38     /* The effective mask is only real mods for now. */
  39     mods->mask = mods->mods & 0xff;
  40
  41     for (i = 0; i < XKB_NUM_VIRTUAL_MODS; i++) {
  42         if (!(vmask & (1 << i)))
  43             continue;
  44         mods->mask |= keymap->vmods[i];
  45     }
  46 }
  47
  48 static void
  49 UpdateActionMods(struct xkb_keymap *keymap, union xkb_action *act,
  50                  xkb_mod_mask_t modmap)
  51 {
  52     switch (act->type) {
  53     case ACTION_TYPE_MOD_SET:
  54     case ACTION_TYPE_MOD_LATCH:
  55     case ACTION_TYPE_MOD_LOCK:
  56         if (act->mods.flags & ACTION_MODS_LOOKUP_MODMAP)
  57             act->mods.mods.mods = modmap;
  58         ComputeEffectiveMask(keymap, &act->mods.mods);
  59         break;
  60     default:
  61         break;
  62     }
  63 }
  64
  65 static const struct xkb_sym_interpret default_interpret = {
  66     .sym = XKB_KEY_NoSymbol,
  67     .repeat = true,
  68     .match = MATCH_ANY_OR_NONE,
  69     .mods = 0,
  70     .virtual_mod = XKB_MOD_INVALID,
  71     .act = { .type = ACTION_TYPE_NONE },
  72 };
  73
  74 /**
  75  * Find an interpretation which applies to this particular level, either by
  76  * finding an exact match for the symbol and modifier combination, or a
  77  * generic XKB_KEY_NoSymbol match.
  78  */
  79 static const struct xkb_sym_interpret *
  80 FindInterpForKey(struct xkb_keymap *keymap, const struct xkb_key *key,
  81                  xkb_layout_index_t group, xkb_level_index_t level)
  82 {
  83     struct xkb_sym_interpret *interp;
  84     const xkb_keysym_t *syms;
  85     int num_syms;
  86
  87     num_syms = xkb_keymap_key_get_syms_by_level(keymap, key->keycode, group,
  88                                                 level, &syms);
  89     if (num_syms == 0)
  90         return NULL;
  91
  92     /*
  93      * There may be multiple matchings interprets; we should always return
  94      * the most specific. Here we rely on compat.c to set up the
  95      * sym_interpret array from the most specific to the least specific,
  96      * such that when we find a match we return immediately.
  97      */
  98     darray_foreach(interp, keymap->sym_interpret) {
  99         xkb_mod_mask_t mods;
 100         bool found;
 101
 102         if ((num_syms > 1 || interp->sym != syms[0]) &&
 103             interp->sym != XKB_KEY_NoSymbol)
 104             continue;
 105
 106         if (level == 0 || !(interp->match & MATCH_LEVEL_ONE_ONLY))
 107             mods = key->modmap;
 108         else
 109             mods = 0;
 110
 111         switch (interp->match & MATCH_OP_MASK) {
 112         case MATCH_NONE:
 113             found = !(interp->mods & mods);
 114             break;
 115         case MATCH_ANY_OR_NONE:
 116             found = (!mods || (interp->mods & mods));
 117             break;
 118         case MATCH_ANY:
 119             found = !!(interp->mods & mods);
 120             break;
 121         case MATCH_ALL:
 122             found = ((interp->mods & mods) == interp->mods);
 123             break;
 124         case MATCH_EXACTLY:
 125             found = (interp->mods == mods);
 126             break;
 127         default:
 128             found = false;
 129             break;
 130         }
 131
 132         if (found)
 133             return interp;
 134     }
 135
 136     return &default_interpret;
 137 }
 138
 139 static bool
 140 ApplyInterpsToKey(struct xkb_keymap *keymap, struct xkb_key *key)
 141 {
 142     xkb_mod_mask_t vmodmask = 0;
 143     xkb_layout_index_t group;
 144     xkb_level_index_t level;
 145
 146     /* If we've been told not to bind interps to this key, then don't. */
 147     if (key->explicit & EXPLICIT_INTERP)
 148         return true;
 149
 150     for (group = 0; group < key->num_groups; group++) {
 151         for (level = 0; level < XkbKeyGroupWidth(key, group); level++) {
 152             const struct xkb_sym_interpret *interp;
 153
 154             interp = FindInterpForKey(keymap, key, group, level);
 155             if (!interp)
 156                 continue;
 157
 158             /* Infer default key behaviours from the base level. */
 159             if (group == 0 && level == 0)
 160                 if (!(key->explicit & EXPLICIT_REPEAT) && interp->repeat)
 161                     key->repeats = true;
 162
 163             if ((group == 0 && level == 0) ||
 164                 !(interp->match & MATCH_LEVEL_ONE_ONLY)) {
 165                 if (interp->virtual_mod != XKB_MOD_INVALID)
 166                     vmodmask |= (1 << interp->virtual_mod);
 167             }
 168
 169             if (interp->act.type != ACTION_TYPE_NONE)
 170                 key->groups[group].levels[level].action = interp->act;
 171         }
 172     }
 173
 174     if (!(key->explicit & EXPLICIT_VMODMAP))
 175         key->vmodmap = vmodmask;
 176
 177     return true;
 178 }
 179
 180 /**
 181  * This collects a bunch of disparate functions which was done in the server
 182  * at various points that really should've been done within xkbcomp.  Turns out
 183  * your actions and types are a lot more useful when any of your modifiers
 184  * other than Shift actually do something ...
 185  */
 186 static bool
 187 UpdateDerivedKeymapFields(struct xkb_keymap *keymap)
 188 {
 189     xkb_mod_index_t vmod;
 190     xkb_led_index_t led;
 191     unsigned int i, j;
 192     struct xkb_key *key;
 193
 194     /* Find all the interprets for the key and bind them to actions,
 195      * which will also update the vmodmap. */
 196     xkb_foreach_key(key, keymap)
 197         if (!ApplyInterpsToKey(keymap, key))
 198             return false;
 199
 200     /* Update keymap->vmods, the virtual -> real mod mapping. */
 201     for (vmod = 0; vmod < XKB_NUM_VIRTUAL_MODS; vmod++)
 202         keymap->vmods[vmod] = 0;
 203
 204     xkb_foreach_key(key, keymap) {
 205         if (!key->vmodmap)
 206             continue;
 207
 208         for (vmod = 0; vmod < XKB_NUM_VIRTUAL_MODS; vmod++) {
 209             if (!(key->vmodmap & (1 << vmod)))
 210                 continue;
 211             keymap->vmods[vmod] |= key->modmap;
 212         }
 213     }
 214
 215     /* Now update the level masks for all the types to reflect the vmods. */
 216     for (i = 0; i < keymap->num_types; i++) {
 217         ComputeEffectiveMask(keymap, &keymap->types[i].mods);
 218
 219         for (j = 0; j < keymap->types[i].num_entries; j++) {
 220             ComputeEffectiveMask(keymap, &keymap->types[i].map[j].mods);
 221             ComputeEffectiveMask(keymap, &keymap->types[i].map[j].preserve);
 222         }
 223     }
 224
 225     /* Update action modifiers. */
 226     xkb_foreach_key(key, keymap)
 227         for (i = 0; i < key->num_groups; i++)
 228             for (j = 0; j < XkbKeyGroupWidth(key, i); j++)
 229                 UpdateActionMods(keymap, &key->groups[i].levels[j].action,
 230                                  key->modmap);
 231
 232     /* Update vmod -> indicator maps. */
 233     for (led = 0; led < XKB_NUM_INDICATORS; led++)
 234         ComputeEffectiveMask(keymap, &keymap->indicators[led].mods);
 235
 236     /* Find maximum number of groups out of all keys in the keymap. */
 237     xkb_foreach_key(key, keymap)
 238         keymap->num_groups = MAX(keymap->num_groups, key->num_groups);
 239
 240     return true;
 241 }
 242
 243 typedef bool (*compile_file_fn)(XkbFile *file,
 244                                 struct xkb_keymap *keymap,
 245                                 enum merge_mode merge);
 246
 247 static const compile_file_fn compile_file_fns[LAST_KEYMAP_FILE_TYPE + 1] = {
 248     [FILE_TYPE_KEYCODES] = CompileKeycodes,
 249     [FILE_TYPE_TYPES] = CompileKeyTypes,
 250     [FILE_TYPE_COMPAT] = CompileCompatMap,
 251     [FILE_TYPE_SYMBOLS] = CompileSymbols,
 252 };
 253
 254 bool
 255 CompileKeymap(XkbFile *file, struct xkb_keymap *keymap, enum merge_mode merge)
 256 {
 257     bool ok;
 258     const char *main_name;
 259     XkbFile *files[LAST_KEYMAP_FILE_TYPE + 1] = { NULL };
 260     enum xkb_file_type type;
 261     struct xkb_context *ctx = keymap->ctx;
 262
 263     main_name = file->name ? file->name : "(unnamed)";
 264
 265     /* Collect section files and check for duplicates. */
 266     for (file = (XkbFile *) file->defs; file;
 267          file = (XkbFile *) file->common.next) {
 268         if (file->file_type < FIRST_KEYMAP_FILE_TYPE ||
 269             file->file_type > LAST_KEYMAP_FILE_TYPE) {
 270             log_err(ctx, "Cannot define %s in a keymap file\n",
 271                     xkb_file_type_to_string(file->file_type));
 272             continue;
 273         }
 274
 275         if (files[file->file_type]) {
 276             log_err(ctx,
 277                     "More than one %s section in keymap file; "
 278                     "All sections after the first ignored\n",
 279                     xkb_file_type_to_string(file->file_type));
 280             continue;
 281         }
 282
 283         if (!file->topName) {
 284             free(file->topName);
 285             file->topName = strdup(main_name);
 286         }
 287
 288         files[file->file_type] = file;
 289     }
 290
 291     /*
 292      * Check that all required section were provided.
 293      * Report everything before failing.
 294      */
 295     ok = true;
 296     for (type = FIRST_KEYMAP_FILE_TYPE;
 297          type <= LAST_KEYMAP_FILE_TYPE;
 298          type++) {
 299         if (files[type] == NULL) {
 300             log_err(ctx, "Required section %s missing from keymap\n",
 301                     xkb_file_type_to_string(type));
 302             ok = false;
 303         }
 304     }
 305     if (!ok)
 306         return false;
 307
 308     /* Compile sections. */
 309     for (type = FIRST_KEYMAP_FILE_TYPE;
 310          type <= LAST_KEYMAP_FILE_TYPE;
 311          type++) {
 312         log_dbg(ctx, "Compiling %s \"%s\"\n",
 313                 xkb_file_type_to_string(type), files[type]->topName);
 314
 315         ok = compile_file_fns[type](files[type], keymap, merge);
 316         if (!ok) {
 317             log_err(ctx, "Failed to compile %s\n",
 318                     xkb_file_type_to_string(type));
 319             return false;
 320         }
 321     }
 322
 323     return UpdateDerivedKeymapFields(keymap);
 324 }