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 "xkbcomp-priv.h"
  28 #include "text.h"
  29 #include "expr.h"
  30 #include "vmod.h"
  31
  32 void
  33 InitVModInfo(VModInfo *info, struct xkb_keymap *keymap)
  34 {
  35     ClearVModInfo(info, keymap);
  36 }
  37
  38 void
  39 ClearVModInfo(VModInfo *info, struct xkb_keymap *keymap)
  40 {
  41     xkb_mod_index_t i;
  42     xkb_mod_mask_t bit;
  43
  44     info->defined = info->available = 0;
  45
  46     for (i = 0, bit = 1; i < XkbNumVirtualMods; i++, bit <<= 1)
  47         if (keymap->vmod_names[i])
  48             info->defined |= bit;
  49 }
  50
  51 /***====================================================================***/
  52
  53 /**
  54  * Handle one entry in the virtualModifiers line (e.g. NumLock).
  55  *
  56  * @param stmt The statement specifying the name
  57  * @param mergeMode Merge strategy (e.g. MERGE_OVERRIDE)
  58  */
  59 bool
  60 HandleVModDef(VModDef *stmt, struct xkb_keymap *keymap,
  61               enum merge_mode mergeMode, VModInfo *info)
  62 {
  63     xkb_mod_index_t i;
  64     int nextFree;
  65     xkb_mod_mask_t bit;
  66
  67     if (stmt->value)
  68         log_err(keymap->ctx,
  69                 "Support for setting a value in a virtual_modifiers statement has been removed; "
  70                 "Value ignored\n");
  71
  72     nextFree = -1;
  73     for (i = 0, bit = 1; i < XkbNumVirtualMods; i++, bit <<= 1) {
  74         if (!(info->defined & bit)) {
  75             if (nextFree < 0)
  76                 nextFree = i;
  77             continue;
  78         }
  79
  80         /* already defined */
  81         if (!keymap->vmod_names[i])
  82             continue;
  83
  84         if (!streq(keymap->vmod_names[i],
  85                    xkb_atom_text(keymap->ctx, stmt->name)))
  86             continue;
  87
  88         info->available |= bit;
  89         return true;
  90     }
  91
  92     if (nextFree < 0) {
  93         log_err(keymap->ctx,
  94                 "Too many virtual modifiers defined (maximum %d)\n",
  95                 XkbNumVirtualMods);
  96         return false;
  97     }
  98
  99     info->defined |= (1 << nextFree);
 100     info->available |= (1 << nextFree);
 101
 102     keymap->vmod_names[nextFree] = xkb_atom_text(keymap->ctx, stmt->name);
 103     return true;
 104 }
 105
 106 /**
 107  * Returns the index of the given modifier in the keymap->vmod_names array.
 108  *
 109  * @param keymap Pointer to the xkb data structure.
 110  * @param field The Atom of the modifier's name (e.g. Atom for LAlt)
 111  * @param type Must be EXPR_TYPE_INT, otherwise return false.
 112  * @param val_rtrn Set to the index of the modifier that matches.
 113  *
 114  * @return true on success, false otherwise. If false is returned, val_rtrn is
 115  * undefined.
 116  */
 117 static bool
 118 LookupVModIndex(const struct xkb_keymap *keymap, xkb_atom_t field,
 119                 enum expr_value_type type, xkb_mod_index_t *val_rtrn)
 120 {
 121     xkb_mod_index_t i;
 122     const char *name = xkb_atom_text(keymap->ctx, field);
 123
 124     if (type != EXPR_TYPE_INT)
 125         return false;
 126
 127     /* For each named modifier, get the name and compare it to the one passed
 128      * in. If we get a match, return the index of the modifier.
 129      * The order of modifiers is the same as in the virtual_modifiers line in
 130      * the xkb_types section.
 131      */
 132     for (i = 0; i < XkbNumVirtualMods; i++) {
 133         if (keymap->vmod_names[i] && streq(keymap->vmod_names[i], name)) {
 134             *val_rtrn = i;
 135             return true;
 136         }
 137     }
 138
 139     return false;
 140 }
 141
 142 /**
 143  * Get the mask for the given (virtual or core) modifier and set
 144  * val_rtrn.uval to the mask value.
 145  *
 146  * @param priv Pointer to xkb data structure.
 147  * @param val_rtrn Member uval is set to the mask returned.
 148  *
 149  * @return true on success, false otherwise. If false is returned, val_rtrn is
 150  * undefined.
 151  */
 152 bool
 153 LookupVModMask(struct xkb_context *ctx, const void *priv, xkb_atom_t field,
 154                enum expr_value_type type, xkb_mod_mask_t *val_rtrn)
 155 {
 156     xkb_mod_index_t ndx;
 157
 158     if (LookupModMask(ctx, NULL, field, type, val_rtrn)) {
 159         return true;
 160     }
 161     else if (LookupVModIndex(priv, field, type, &ndx)) {
 162         *val_rtrn = (1 << (XkbNumModifiers + ndx));
 163         return true;
 164     }
 165
 166     return false;
 167 }
 168
 169 bool
 170 ResolveVirtualModifier(ExprDef *def, struct xkb_keymap *keymap,
 171                        xkb_mod_index_t *ndx_rtrn, VModInfo *info)
 172 {
 173     xkb_mod_index_t i;
 174     const char *name;
 175
 176     if (def->op != EXPR_IDENT) {
 177         log_err(keymap->ctx,
 178                 "Cannot resolve virtual modifier: "
 179                 "found %s where a virtual modifier name was expected\n",
 180                 expr_op_type_to_string(def->op));
 181         return false;
 182     }
 183
 184     name = xkb_atom_text(keymap->ctx, def->value.str);
 185
 186     for (i = 0; i < XkbNumVirtualMods; i++) {
 187         if ((info->available & (1 << i)) &&
 188             streq_not_null(keymap->vmod_names[i], name)) {
 189             *ndx_rtrn = i;
 190             return true;
 191         }
 192     }
 193
 194     log_err(keymap->ctx,
 195             "Cannot resolve virtual modifier: "
 196             "\"%s\" was not previously declared\n", name);
 197     return false;
 198 }