path: root/src/xkbcomp/vmod.c

/************************************************************
 Copyright (c) 1994 by Silicon Graphics Computer Systems, Inc.

 Permission to use, copy, modify, and distribute this
 software and its documentation for any purpose and without
 fee is hereby granted, provided that the above copyright
 notice appear in all copies and that both that copyright
 notice and this permission notice appear in supporting
 documentation, and that the name of Silicon Graphics not be
 used in advertising or publicity pertaining to distribution
 of the software without specific prior written permission.
 Silicon Graphics makes no representation about the suitability
 of this software for any purpose. It is provided "as is"
 without any express or implied warranty.

 SILICON GRAPHICS DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS
 SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
 AND FITNESS FOR A PARTICULAR PURPOSE. IN NO EVENT SHALL SILICON
 GRAPHICS BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL
 DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
 DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
 OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION  WITH
 THE USE OR PERFORMANCE OF THIS SOFTWARE.

 ********************************************************/

#include "vmod.h"

void
InitVModInfo(VModInfo *info, struct xkb_keymap *keymap)
{
    ClearVModInfo(info, keymap);
    info->errorCount = 0;
}

void
ClearVModInfo(VModInfo *info, struct xkb_keymap *keymap)
{
    int i;

    info->newlyDefined = info->defined = info->available = 0;

    if (XkbcAllocNames(keymap, 0, 0) != Success)
        return;

    if (XkbcAllocServerMap(keymap, 0, 0) != Success)
        return;

    info->keymap = keymap;
    if (keymap && keymap->names)
    {
        int bit;
        for (i = 0, bit = 1; i < XkbNumVirtualMods; i++, bit <<= 1)
        {
            if (keymap->names->vmods[i] != NULL)
                info->defined |= bit;
        }
    }
}

/***====================================================================***/

/**
 * Handle one entry in the virtualModifiers line (e.g. NumLock).
 * If the entry is e.g. NumLock=Mod1, stmt->value is not NULL, and the
 * XkbServerMap's vmod is set to the given modifier. Otherwise, the vmod is 0.
 *
 * @param stmt The statement specifying the name and (if any the value).
 * @param mergeMode Merge strategy (e.g. MergeOverride)
 */
bool
HandleVModDef(VModDef *stmt, struct xkb_keymap *keymap, unsigned mergeMode,
              VModInfo *info)
{
    int i, bit, nextFree;
    ExprResult mod;
    struct xkb_server_map *srv = keymap->server;
    struct xkb_names *names = keymap->names;

    for (i = 0, bit = 1, nextFree = -1; i < XkbNumVirtualMods; i++, bit <<= 1)
    {
        if (info->defined & bit)
        {
            if (names->vmods[i] &&
                strcmp(names->vmods[i], XkbcAtomText(stmt->name)) == 0)
            {                   /* already defined */
                info->available |= bit;
                if (stmt->value == NULL)
                    return true;
                else
                {
                    const char *str1;
                    const char *str2 = "";
                    if (!ExprResolveModMask(stmt->value, &mod))
                    {
                        str1 = XkbcAtomText(stmt->name);
                        ACTION("Declaration of %s ignored\n", str1);
                        return false;
                    }
                    if (mod.uval == srv->vmods[i])
                        return true;

                    str1 = XkbcAtomText(stmt->name);
                    WARN("Virtual modifier %s multiply defined\n", str1);
                    str1 = XkbcModMaskText(srv->vmods[i], true);
                    if (mergeMode == MergeOverride)
                    {
                        str2 = str1;
                        str1 = XkbcModMaskText(mod.uval, true);
                    }
                    ACTION("Using %s, ignoring %s\n", str1, str2);
                    if (mergeMode == MergeOverride)
                        srv->vmods[i] = mod.uval;
                    return true;
                }
            }
        }
        else if (nextFree < 0)
            nextFree = i;
    }
    if (nextFree < 0)
    {
        ERROR("Too many virtual modifiers defined (maximum %d)\n",
               XkbNumVirtualMods);
        return false;
    }
    info->defined |= (1 << nextFree);
    info->newlyDefined |= (1 << nextFree);
    info->available |= (1 << nextFree);
    names->vmods[nextFree] = XkbcAtomGetString(stmt->name);
    if (stmt->value == NULL)
        return true;
    if (ExprResolveModMask(stmt->value, &mod))
    {
        srv->vmods[nextFree] = mod.uval;
        return true;
    }
    ACTION("Declaration of %s ignored\n", XkbcAtomText(stmt->name));
    return false;
}

/**
 * Returns the index of the given modifier in the xkb->names->vmods array.
 *
 * @param keymap Pointer to the xkb data structure.
 * @param field The Atom of the modifier's name (e.g. Atom for LAlt)
 * @param type Must be TypeInt, otherwise return false.
 * @param val_rtrn Set to the index of the modifier that matches.
 *
 * @return true on success, false otherwise. If false is returned, val_rtrn is
 * undefined.
 */
static int
LookupVModIndex(const struct xkb_keymap *keymap, xkb_atom_t field,
                unsigned type, ExprResult * val_rtrn)
{
    int i;
    const char *name = XkbcAtomText(field);

    if ((keymap == NULL) || (keymap->names == NULL) || (type != TypeInt))
    {
        return false;
    }
    /* For each named modifier, get the name and compare it to the one passed
     * in. If we get a match, return the index of the modifier.
     * The order of modifiers is the same as in the virtual_modifiers line in
     * the xkb_types section.
     */
    for (i = 0; i < XkbNumVirtualMods; i++)
    {
        if (keymap->names->vmods[i] &&
            strcmp(keymap->names->vmods[i], name) == 0)
        {
            val_rtrn->uval = i;
            return true;
        }
    }
    return false;
}

/**
 * Get the mask for the given (virtual or core) modifier and set
 * val_rtrn.uval to the mask value.
 *
 * @param priv Pointer to xkb data structure.
 * @param val_rtrn Member uval is set to the mask returned.
 *
 * @return true on success, false otherwise. If false is returned, val_rtrn is
 * undefined.
 */
bool
LookupVModMask(const void * priv, xkb_atom_t field, unsigned type,
               ExprResult * val_rtrn)
{
    if (LookupModMask(NULL, field, type, val_rtrn))
    {
        return true;
    }
    else if (LookupVModIndex(priv, field, type, val_rtrn))
    {
        unsigned ndx = val_rtrn->uval;
        val_rtrn->uval = (1 << (XkbNumModifiers + ndx));
        return true;
    }
    return false;
}

int
FindKeypadVMod(struct xkb_keymap *keymap)
{
    xkb_atom_t name;
    ExprResult rtrn;

    name = xkb_intern_atom("NumLock");
    if (keymap && LookupVModIndex(keymap, name, TypeInt, &rtrn))
    {
        return rtrn.ival;
    }
    return -1;
}

bool
ResolveVirtualModifier(ExprDef *def, struct xkb_keymap *keymap,
                       ExprResult *val_rtrn, VModInfo *info)
{
    struct xkb_names *names = keymap->names;

    if (def->op == ExprIdent)
    {
        int i, bit;
        const char *name = XkbcAtomText(def->value.str);
        for (i = 0, bit = 1; i < XkbNumVirtualMods; i++, bit <<= 1)
        {
            if ((info->available & bit) && names->vmods[i] &&
                strcmp(names->vmods[i], name) == 0)
            {
                val_rtrn->uval = i;
                return true;
            }
        }
    }
    if (ExprResolveInteger(def, val_rtrn))
    {
        if (val_rtrn->uval < XkbNumVirtualMods)
            return true;
        ERROR("Illegal virtual modifier %d (must be 0..%d inclusive)\n",
               val_rtrn->uval, XkbNumVirtualMods - 1);
    }
    return false;
}