src/xkbcomp/vmod.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 "vmod.h"
  28
  29 void
  30 InitVModInfo(VModInfo *info, struct xkb_keymap *keymap)
  31 {
  32     ClearVModInfo(info, keymap);
  33     info->errorCount = 0;
  34 }
  35
  36 void
  37 ClearVModInfo(VModInfo *info, struct xkb_keymap *keymap)
  38 {
  39     int i, bit;
  40
  41     info->newlyDefined = info->defined = info->available = 0;
  42
  43     for (i = 0; i < XkbNumVirtualMods; i++)
  44         keymap->vmods[i] = XkbNoModifierMask;
  45
  46     info->keymap = keymap;
  47     for (i = 0, bit = 1; i < XkbNumVirtualMods; i++, bit <<= 1)
  48         if (keymap->vmod_names[i])
  49             info->defined |= bit;
  50 }
  51
  52 /***====================================================================***/
  53
  54 /**
  55  * Handle one entry in the virtualModifiers line (e.g. NumLock).
  56  * If the entry is e.g. NumLock=Mod1, stmt->value is not NULL, and the
  57  * XkbServerMap's vmod is set to the given modifier. Otherwise, the vmod is 0.
  58  *
  59  * @param stmt The statement specifying the name and (if any the value).
  60  * @param mergeMode Merge strategy (e.g. MERGE_OVERRIDE)
  61  */
  62 bool
  63 HandleVModDef(VModDef *stmt, struct xkb_keymap *keymap,
  64               enum merge_mode mergeMode,
  65               VModInfo *info)
  66 {
  67     int i, bit, nextFree;
  68     ExprResult mod;
  69
  70     for (i = 0, bit = 1, nextFree = -1; i < XkbNumVirtualMods; i++, bit <<=
  71              1) {
  72         if (info->defined & bit) {
  73             if (keymap->vmod_names[i] &&
  74                 strcmp(keymap->vmod_names[i],
  75                        xkb_atom_text(keymap->ctx, stmt->name)) == 0) { /* already defined */
  76                 info->available |= bit;
  77                 if (stmt->value == NULL)
  78                     return true;
  79                 else {
  80                     const char *str1;
  81                     const char *str2 = "";
  82                     if (!ExprResolveModMask(keymap->ctx, stmt->value,
  83                                             &mod)) {
  84                         str1 = xkb_atom_text(keymap->ctx, stmt->name);
  85                         ACTION("Declaration of %s ignored\n", str1);
  86                         return false;
  87                     }
  88                     if (mod.uval == keymap->vmods[i])
  89                         return true;
  90
  91                     str1 = xkb_atom_text(keymap->ctx, stmt->name);
  92                     WARN("Virtual modifier %s multiply defined\n", str1);
  93                     str1 = XkbcModMaskText(keymap->vmods[i], true);
  94                     if (mergeMode == MERGE_OVERRIDE) {
  95                         str2 = str1;
  96                         str1 = XkbcModMaskText(mod.uval, true);
  97                     }
  98                     ACTION("Using %s, ignoring %s\n", str1, str2);
  99                     if (mergeMode == MERGE_OVERRIDE)
 100                         keymap->vmods[i] = mod.uval;
 101                     return true;
 102                 }
 103             }
 104         }
 105         else if (nextFree < 0)
 106             nextFree = i;
 107     }
 108     if (nextFree < 0) {
 109         ERROR("Too many virtual modifiers defined (maximum %d)\n",
 110               XkbNumVirtualMods);
 111         return false;
 112     }
 113     info->defined |= (1 << nextFree);
 114     info->newlyDefined |= (1 << nextFree);
 115     info->available |= (1 << nextFree);
 116     keymap->vmod_names[nextFree] = xkb_atom_strdup(keymap->ctx, stmt->name);
 117     if (stmt->value == NULL)
 118         return true;
 119     if (ExprResolveModMask(keymap->ctx, stmt->value, &mod)) {
 120         keymap->vmods[nextFree] = mod.uval;
 121         return true;
 122     }
 123     ACTION("Declaration of %s ignored\n",
 124            xkb_atom_text(keymap->ctx, stmt->name));
 125     return false;
 126 }
 127
 128 /**
 129  * Returns the index of the given modifier in the keymap->vmod_names array.
 130  *
 131  * @param keymap Pointer to the xkb data structure.
 132  * @param field The Atom of the modifier's name (e.g. Atom for LAlt)
 133  * @param type Must be TypeInt, otherwise return false.
 134  * @param val_rtrn Set to the index of the modifier that matches.
 135  *
 136  * @return true on success, false otherwise. If false is returned, val_rtrn is
 137  * undefined.
 138  */
 139 static int
 140 LookupVModIndex(const struct xkb_keymap *keymap, xkb_atom_t field,
 141                 unsigned type, ExprResult * val_rtrn)
 142 {
 143     int i;
 144     const char *name = xkb_atom_text(keymap->ctx, field);
 145
 146     if (type != TypeInt)
 147         return false;
 148
 149     /* For each named modifier, get the name and compare it to the one passed
 150      * in. If we get a match, return the index of the modifier.
 151      * The order of modifiers is the same as in the virtual_modifiers line in
 152      * the xkb_types section.
 153      */
 154     for (i = 0; i < XkbNumVirtualMods; i++)
 155         if (keymap->vmod_names[i] &&
 156             strcmp(keymap->vmod_names[i], name) == 0) {
 157             val_rtrn->uval = i;
 158             return true;
 159         }
 160
 161     return false;
 162 }
 163
 164 /**
 165  * Get the mask for the given (virtual or core) modifier and set
 166  * val_rtrn.uval to the mask value.
 167  *
 168  * @param priv Pointer to xkb data structure.
 169  * @param val_rtrn Member uval is set to the mask returned.
 170  *
 171  * @return true on success, false otherwise. If false is returned, val_rtrn is
 172  * undefined.
 173  */
 174 bool
 175 LookupVModMask(struct xkb_context *ctx, const void *priv, xkb_atom_t field,
 176                unsigned type, ExprResult *val_rtrn)
 177 {
 178     if (LookupModMask(ctx, NULL, field, type, val_rtrn)) {
 179         return true;
 180     }
 181     else if (LookupVModIndex(priv, field, type, val_rtrn)) {
 182         unsigned ndx = val_rtrn->uval;
 183         val_rtrn->uval = (1 << (XkbNumModifiers + ndx));
 184         return true;
 185     }
 186     return false;
 187 }
 188
 189 int
 190 FindKeypadVMod(struct xkb_keymap *keymap)
 191 {
 192     xkb_atom_t name;
 193     ExprResult rtrn;
 194
 195     name = xkb_atom_intern(keymap->ctx, "NumLock");
 196     if ((keymap) && LookupVModIndex(keymap, name, TypeInt, &rtrn)) {
 197         return rtrn.ival;
 198     }
 199     return -1;
 200 }
 201
 202 bool
 203 ResolveVirtualModifier(ExprDef *def, struct xkb_keymap *keymap,
 204                        ExprResult *val_rtrn, VModInfo *info)
 205 {
 206     if (def->op == ExprIdent) {
 207         int i, bit;
 208         const char *name = xkb_atom_text(keymap->ctx, def->value.str);
 209         for (i = 0, bit = 1; i < XkbNumVirtualMods; i++, bit <<= 1) {
 210             if ((info->available & bit) && keymap->vmod_names[i] &&
 211                 strcmp(keymap->vmod_names[i], name) == 0) {
 212                 val_rtrn->uval = i;
 213                 return true;
 214             }
 215         }
 216     }
 217     if (ExprResolveInteger(keymap->ctx, def, val_rtrn)) {
 218         if (val_rtrn->uval < XkbNumVirtualMods)
 219             return true;
 220         ERROR("Illegal virtual modifier %d (must be 0..%d inclusive)\n",
 221               val_rtrn->uval, XkbNumVirtualMods - 1);
 222     }
 223     return false;
 224 }