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, struct xkb_desc *xkb, unsigned mergeMode,
  83               VModInfo * info)
  84 {
  85     register int i, bit, nextFree;
  86     ExprResult mod;
  87     struct xkb_server_map * srv;
  88     struct xkb_names * names;
  89
  90     srv = xkb->server;
  91     names = xkb->names;
  92     for (i = 0, bit = 1, nextFree = -1; i < XkbNumVirtualMods; i++, bit <<= 1)
  93     {
  94         if (info->defined & bit)
  95         {
  96             if (names->vmods[i] == stmt->name)
  97             {                   /* already defined */
  98                 info->available |= bit;
  99                 if (stmt->value == NULL)
 100                     return True;
 101                 else
 102                 {
 103                     const char *str1;
 104                     const char *str2 = "";
 105                     if (!ExprResolveModMask(stmt->value, &mod))
 106                     {
 107                         str1 = XkbcAtomText(stmt->name);
 108                         ACTION("Declaration of %s ignored\n", str1);
 109                         return False;
 110                     }
 111                     if (mod.uval == srv->vmods[i])
 112                         return True;
 113
 114                     str1 = XkbcAtomText(stmt->name);
 115                     WARN("Virtual modifier %s multiply defined\n", str1);
 116                     str1 = XkbcModMaskText(srv->vmods[i], True);
 117                     if (mergeMode == MergeOverride)
 118                     {
 119                         str2 = str1;
 120                         str1 = XkbcModMaskText(mod.uval, True);
 121                     }
 122                     ACTION("Using %s, ignoring %s\n", str1, str2);
 123                     if (mergeMode == MergeOverride)
 124                         srv->vmods[i] = mod.uval;
 125                     return True;
 126                 }
 127             }
 128         }
 129         else if (nextFree < 0)
 130             nextFree = i;
 131     }
 132     if (nextFree < 0)
 133     {
 134         ERROR("Too many virtual modifiers defined (maximum %d)\n",
 135                XkbNumVirtualMods);
 136         return False;
 137     }
 138     info->defined |= (1 << nextFree);
 139     info->newlyDefined |= (1 << nextFree);
 140     info->available |= (1 << nextFree);
 141     names->vmods[nextFree] = stmt->name;
 142     if (stmt->value == NULL)
 143         return True;
 144     if (ExprResolveModMask(stmt->value, &mod))
 145     {
 146         srv->vmods[nextFree] = mod.uval;
 147         return True;
 148     }
 149     ACTION("Declaration of %s ignored\n", XkbcAtomText(stmt->name));
 150     return False;
 151 }
 152
 153 /**
 154  * Returns the index of the given modifier in the xkb->names->vmods array.
 155  *
 156  * @param priv Pointer to the xkb data structure.
 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, uint32_t field, unsigned type,
 166                 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) || (type != TypeInt))
 173     {
 174         return False;
 175     }
 176     /* For each named modifier, get the name and compare it to the one passed
 177      * in. If we get a match, return the index of the modifier.
 178      * The order of modifiers is the same as in the virtual_modifiers line in
 179      * the xkb_types section.
 180      */
 181     for (i = 0; i < XkbNumVirtualMods; i++)
 182     {
 183         if (xkb->names->vmods[i] == field)
 184         {
 185             val_rtrn->uval = i;
 186             return True;
 187         }
 188     }
 189     return False;
 190 }
 191
 192 /**
 193  * Get the mask for the given modifier and set val_rtrn.uval to the mask.
 194  * Note that the mask returned is always > 512.
 195  *
 196  * @param priv Pointer to xkb data structure.
 197  * @param val_rtrn Set to the mask returned.
 198  *
 199  * @return True on success, False otherwise. If False is returned, val_rtrn is
 200  * undefined.
 201  */
 202 int
 203 LookupVModMask(char * priv, uint32_t field, unsigned type, ExprResult * val_rtrn)
 204 {
 205     if (LookupVModIndex(priv, field, type, val_rtrn))
 206     {
 207         register unsigned ndx = val_rtrn->uval;
 208         val_rtrn->uval = (1 << (XkbNumModifiers + ndx));
 209         return True;
 210     }
 211     return False;
 212 }
 213
 214 int
 215 FindKeypadVMod(struct xkb_desc * xkb)
 216 {
 217     uint32_t name;
 218     ExprResult rtrn;
 219
 220     name = xkb_intern_atom("NumLock");
 221     if ((xkb) && LookupVModIndex((char *) xkb, name, TypeInt, &rtrn))
 222     {
 223         return rtrn.ival;
 224     }
 225     return -1;
 226 }
 227
 228 Bool
 229 ResolveVirtualModifier(ExprDef * def, struct xkb_desc *xkb,
 230                        ExprResult * val_rtrn, VModInfo * info)
 231 {
 232     struct xkb_names * names;
 233
 234     names = xkb->names;
 235     if (def->op == ExprIdent)
 236     {
 237         int i, bit;
 238         for (i = 0, bit = 1; i < XkbNumVirtualMods; i++, bit <<= 1)
 239         {
 240             if ((info->available & bit) && names->vmods[i] == def->value.str)
 241             {
 242                 val_rtrn->uval = i;
 243                 return True;
 244             }
 245         }
 246     }
 247     if (ExprResolveInteger(def, val_rtrn))
 248     {
 249         if (val_rtrn->uval < XkbNumVirtualMods)
 250             return True;
 251         ERROR("Illegal virtual modifier %d (must be 0..%d inclusive)\n",
 252                val_rtrn->uval, XkbNumVirtualMods - 1);
 253     }
 254     return False;
 255 }