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