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