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 ********************************************************/
27 #include "xkbcomp-priv.h"
33 InitVModInfo(VModInfo *info, struct xkb_keymap *keymap)
35 ClearVModInfo(info, keymap);
39 ClearVModInfo(VModInfo *info, struct xkb_keymap *keymap)
44 info->defined = info->available = 0;
46 for (i = 0; i < XkbNumVirtualMods; i++)
47 keymap->vmods[i] = XkbNoModifierMask;
49 for (i = 0, bit = 1; i < XkbNumVirtualMods; i++, bit <<= 1)
50 if (keymap->vmod_names[i])
54 /***====================================================================***/
57 * Handle one entry in the virtualModifiers line (e.g. NumLock).
58 * If the entry is e.g. NumLock=Mod1, stmt->value is not NULL, and the
59 * XkbServerMap's vmod is set to the given modifier. Otherwise, the vmod is 0.
61 * @param stmt The statement specifying the name and (if any the value).
62 * @param mergeMode Merge strategy (e.g. MERGE_OVERRIDE)
65 HandleVModDef(VModDef *stmt, struct xkb_keymap *keymap,
66 enum merge_mode mergeMode, VModInfo *info)
74 for (i = 0, bit = 1; i < XkbNumVirtualMods; i++, bit <<= 1) {
76 const char *str2 = "";
78 if (!(info->defined & bit)) {
85 if (!keymap->vmod_names[i])
88 if (!streq(keymap->vmod_names[i],
89 xkb_atom_text(keymap->ctx, stmt->name)))
92 info->available |= bit;
97 if (!ExprResolveModMask(keymap->ctx, stmt->value, &mask)) {
98 log_err(keymap->ctx, "Declaration of %s ignored\n",
99 xkb_atom_text(keymap->ctx, stmt->name));
103 if (mask == keymap->vmods[i])
106 str1 = ModMaskText(keymap->vmods[i]);
107 if (mergeMode == MERGE_OVERRIDE) {
109 str1 = ModMaskText(mask);
112 log_warn(keymap->ctx,
113 "Virtual modifier %s defined multiple times; "
114 "Using %s, ignoring %s\n",
115 xkb_atom_text(keymap->ctx, stmt->name), str1, str2);
117 if (mergeMode == MERGE_OVERRIDE)
118 keymap->vmods[i] = mask;
125 "Too many virtual modifiers defined (maximum %d)\n",
130 info->defined |= (1 << nextFree);
131 info->available |= (1 << nextFree);
133 keymap->vmod_names[nextFree] = xkb_atom_text(keymap->ctx, stmt->name);
138 if (!ExprResolveModMask(keymap->ctx, stmt->value, &mask)) {
139 log_err(keymap->ctx, "Declaration of %s ignored\n",
140 xkb_atom_text(keymap->ctx, stmt->name));
144 keymap->vmods[nextFree] = mask;
149 * Returns the index of the given modifier in the keymap->vmod_names array.
151 * @param keymap Pointer to the xkb data structure.
152 * @param field The Atom of the modifier's name (e.g. Atom for LAlt)
153 * @param type Must be EXPR_TYPE_INT, otherwise return false.
154 * @param val_rtrn Set to the index of the modifier that matches.
156 * @return true on success, false otherwise. If false is returned, val_rtrn is
160 LookupVModIndex(const struct xkb_keymap *keymap, xkb_atom_t field,
161 enum expr_value_type type, xkb_mod_index_t *val_rtrn)
164 const char *name = xkb_atom_text(keymap->ctx, field);
166 if (type != EXPR_TYPE_INT)
169 /* For each named modifier, get the name and compare it to the one passed
170 * in. If we get a match, return the index of the modifier.
171 * The order of modifiers is the same as in the virtual_modifiers line in
172 * the xkb_types section.
174 for (i = 0; i < XkbNumVirtualMods; i++) {
175 if (keymap->vmod_names[i] && streq(keymap->vmod_names[i], name)) {
185 * Get the mask for the given (virtual or core) modifier and set
186 * val_rtrn.uval to the mask value.
188 * @param priv Pointer to xkb data structure.
189 * @param val_rtrn Member uval is set to the mask returned.
191 * @return true on success, false otherwise. If false is returned, val_rtrn is
195 LookupVModMask(struct xkb_context *ctx, const void *priv, xkb_atom_t field,
196 enum expr_value_type type, xkb_mod_mask_t *val_rtrn)
200 if (LookupModMask(ctx, NULL, field, type, val_rtrn)) {
203 else if (LookupVModIndex(priv, field, type, &ndx)) {
204 *val_rtrn = (1 << (XkbNumModifiers + ndx));
212 ResolveVirtualModifier(ExprDef *def, struct xkb_keymap *keymap,
213 xkb_mod_index_t *ndx_rtrn, VModInfo *info)
217 if (def->op == EXPR_IDENT) {
220 const char *name = xkb_atom_text(keymap->ctx, def->value.str);
222 for (i = 0, bit = 1; i < XkbNumVirtualMods; i++, bit <<= 1) {
223 if ((info->available & bit) && keymap->vmod_names[i] &&
224 streq(keymap->vmod_names[i], name)) {
231 if (!ExprResolveInteger(keymap->ctx, def, &val))
234 if (val < 0 || val >= XkbNumVirtualMods) {
236 "Illegal virtual modifier %d (must be 0..%d inclusive)\n",
237 val, XkbNumVirtualMods - 1);
241 *ndx_rtrn = (xkb_mod_index_t) val;