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