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