1 /************************************************************
2 * Copyright (c) 1994 by Silicon Graphics Computer Systems, Inc.
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.
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.
25 ********************************************************/
30 InitVModInfo(VModInfo *info, struct xkb_keymap *keymap)
32 ClearVModInfo(info, keymap);
37 ClearVModInfo(VModInfo *info, struct xkb_keymap *keymap)
42 info->newlyDefined = info->defined = info->available = 0;
44 for (i = 0; i < XkbNumVirtualMods; i++)
45 keymap->vmods[i] = XkbNoModifierMask;
47 for (i = 0, bit = 1; i < XkbNumVirtualMods; i++, bit <<= 1)
48 if (keymap->vmod_names[i])
52 /***====================================================================***/
55 * Handle one entry in the virtualModifiers line (e.g. NumLock).
56 * If the entry is e.g. NumLock=Mod1, stmt->value is not NULL, and the
57 * XkbServerMap's vmod is set to the given modifier. Otherwise, the vmod is 0.
59 * @param stmt The statement specifying the name and (if any the value).
60 * @param mergeMode Merge strategy (e.g. MERGE_OVERRIDE)
63 HandleVModDef(VModDef *stmt, struct xkb_keymap *keymap,
64 enum merge_mode mergeMode, VModInfo *info)
72 for (i = 0, bit = 1; i < XkbNumVirtualMods; i++, bit <<= 1) {
74 const char *str2 = "";
76 if (!(info->defined & bit)) {
83 if (!keymap->vmod_names[i])
86 if (!streq(keymap->vmod_names[i],
87 xkb_atom_text(keymap->ctx, stmt->name)))
90 info->available |= bit;
95 if (!ExprResolveModMask(keymap->ctx, stmt->value, &mask)) {
96 log_err(keymap->ctx, "Declaration of %s ignored\n",
97 xkb_atom_text(keymap->ctx, stmt->name));
101 if (mask == keymap->vmods[i])
104 str1 = ModMaskText(keymap->vmods[i], true);
105 if (mergeMode == MERGE_OVERRIDE) {
107 str1 = ModMaskText(mask, true);
110 log_warn(keymap->ctx,
111 "Virtual modifier %s defined multiple times; "
112 "Using %s, ignoring %s\n",
113 xkb_atom_text(keymap->ctx, stmt->name), str1, str2);
115 if (mergeMode == MERGE_OVERRIDE)
116 keymap->vmods[i] = mask;
123 "Too many virtual modifiers defined (maximum %d)\n",
128 info->defined |= (1 << nextFree);
129 info->newlyDefined |= (1 << nextFree);
130 info->available |= (1 << nextFree);
132 keymap->vmod_names[nextFree] = xkb_atom_text(keymap->ctx, stmt->name);
137 if (!ExprResolveModMask(keymap->ctx, stmt->value, &mask)) {
138 log_err(keymap->ctx, "Declaration of %s ignored\n",
139 xkb_atom_text(keymap->ctx, stmt->name));
143 keymap->vmods[nextFree] = mask;
148 * Returns the index of the given modifier in the keymap->vmod_names array.
150 * @param keymap Pointer to the xkb data structure.
151 * @param field The Atom of the modifier's name (e.g. Atom for LAlt)
152 * @param type Must be EXPR_TYPE_INT, otherwise return false.
153 * @param val_rtrn Set to the index of the modifier that matches.
155 * @return true on success, false otherwise. If false is returned, val_rtrn is
159 LookupVModIndex(const struct xkb_keymap *keymap, xkb_atom_t field,
160 enum expr_value_type type, ExprResult * val_rtrn)
163 const char *name = xkb_atom_text(keymap->ctx, field);
165 if (type != EXPR_TYPE_INT)
168 /* For each named modifier, get the name and compare it to the one passed
169 * in. If we get a match, return the index of the modifier.
170 * The order of modifiers is the same as in the virtual_modifiers line in
171 * the xkb_types section.
173 for (i = 0; i < XkbNumVirtualMods; i++) {
174 if (keymap->vmod_names[i] && streq(keymap->vmod_names[i], name)) {
184 * Get the mask for the given (virtual or core) modifier and set
185 * val_rtrn.uval to the mask value.
187 * @param priv Pointer to xkb data structure.
188 * @param val_rtrn Member uval is set to the mask returned.
190 * @return true on success, false otherwise. If false is returned, val_rtrn is
194 LookupVModMask(struct xkb_context *ctx, const void *priv, xkb_atom_t field,
195 enum expr_value_type type, ExprResult *val_rtrn)
197 if (LookupModMask(ctx, NULL, field, type, val_rtrn)) {
200 else if (LookupVModIndex(priv, field, type, val_rtrn)) {
201 unsigned ndx = val_rtrn->uval;
202 val_rtrn->uval = (1 << (XkbNumModifiers + ndx));
209 FindKeypadVMod(struct xkb_keymap *keymap)
214 name = xkb_atom_intern(keymap->ctx, "NumLock");
215 if ((keymap) && LookupVModIndex(keymap, name, EXPR_TYPE_INT, &rtrn)) {
222 ResolveVirtualModifier(ExprDef *def, struct xkb_keymap *keymap,
223 ExprResult *val_rtrn, VModInfo *info)
227 if (def->op == EXPR_IDENT) {
230 const char *name = xkb_atom_text(keymap->ctx, def->value.str);
232 for (i = 0, bit = 1; i < XkbNumVirtualMods; i++, bit <<= 1) {
233 if ((info->available & bit) && keymap->vmod_names[i] &&
234 streq(keymap->vmod_names[i], name)) {
241 if (!ExprResolveInteger(keymap->ctx, def, &val))
244 if (val < 0 || val >= XkbNumVirtualMods) {
246 "Illegal virtual modifier %d (must be 0..%d inclusive)\n",
247 val, XkbNumVirtualMods - 1);
251 val_rtrn->uval = (unsigned int) val;