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     xkb_group_index_t i;
  36
  37     memset(info, 0, sizeof(*info));
  38     for (i = 0; i < XKB_NUM_VIRTUAL_MODS; i++)
  39         if (keymap->vmod_names[i])
  40             info->defined |= (1 << i);
  41 }
  42
  43 bool
  44 HandleVModDef(VModDef *stmt, struct xkb_keymap *keymap,
  45               enum merge_mode mergeMode, VModInfo *info)
  46 {
  47     xkb_mod_index_t i;
  48     int nextFree;
  49     xkb_mod_mask_t bit;
  50
  51     if (stmt->value)
  52         log_err(keymap->ctx,
  53                 "Support for setting a value in a virtual_modifiers statement has been removed; "
  54                 "Value ignored\n");
  55
  56     nextFree = -1;
  57     for (i = 0, bit = 1; i < XKB_NUM_VIRTUAL_MODS; i++, bit <<= 1) {
  58         if (!(info->defined & bit)) {
  59             if (nextFree < 0)
  60                 nextFree = i;
  61             continue;
  62         }
  63
  64         /* Already defined. */
  65         if (!keymap->vmod_names[i])
  66             continue;
  67
  68         if (keymap->vmod_names[i] != stmt->name)
  69             continue;
  70
  71         info->available |= bit;
  72         return true;
  73     }
  74
  75     if (nextFree < 0) {
  76         log_err(keymap->ctx,
  77                 "Too many virtual modifiers defined (maximum %d)\n",
  78                 XKB_NUM_VIRTUAL_MODS);
  79         return false;
  80     }
  81
  82     info->defined |= (1 << nextFree);
  83     info->available |= (1 << nextFree);
  84
  85     keymap->vmod_names[nextFree] = stmt->name;
  86     return true;
  87 }
  88
  89 static bool
  90 LookupVModIndex(const struct xkb_keymap *keymap, xkb_atom_t field,
  91                 enum expr_value_type type, xkb_mod_index_t *val_rtrn)
  92 {
  93     xkb_mod_index_t i;
  94
  95     if (type != EXPR_TYPE_INT)
  96         return false;
  97
  98     for (i = 0; i < XKB_NUM_VIRTUAL_MODS; i++) {
  99         if (keymap->vmod_names[i] == field) {
 100             *val_rtrn = i;
 101             return true;
 102         }
 103     }
 104
 105     return false;
 106 }
 107
 108 bool
 109 LookupVModMask(struct xkb_context *ctx, const void *priv, xkb_atom_t field,
 110                enum expr_value_type type, xkb_mod_mask_t *val_rtrn)
 111 {
 112     xkb_mod_index_t ndx;
 113
 114     if (LookupModMask(ctx, NULL, field, type, val_rtrn)) {
 115         return true;
 116     }
 117     else if (LookupVModIndex(priv, field, type, &ndx)) {
 118         *val_rtrn = (1 << (XKB_NUM_CORE_MODS + ndx));
 119         return true;
 120     }
 121
 122     return false;
 123 }
 124
 125 bool
 126 ResolveVirtualModifier(ExprDef *def, struct xkb_keymap *keymap,
 127                        xkb_mod_index_t *ndx_rtrn, VModInfo *info)
 128 {
 129     xkb_mod_index_t i;
 130     xkb_atom_t name = def->value.str;
 131
 132     if (def->op != EXPR_IDENT) {
 133         log_err(keymap->ctx,
 134                 "Cannot resolve virtual modifier: "
 135                 "found %s where a virtual modifier name was expected\n",
 136                 expr_op_type_to_string(def->op));
 137         return false;
 138     }
 139
 140     for (i = 0; i < XKB_NUM_VIRTUAL_MODS; i++) {
 141         if ((info->available & (1 << i)) && keymap->vmod_names[i] == name) {
 142             *ndx_rtrn = i;
 143             return true;
 144         }
 145     }
 146
 147     log_err(keymap->ctx,
 148             "Cannot resolve virtual modifier: "
 149             "\"%s\" was not previously declared\n",
 150             xkb_atom_text(keymap->ctx, name));
 151     return false;
 152 }