Messages: merge macros with and without message code
[platform/upstream/libxkbcommon.git] / src / xkbcomp / vmod.c
index 3200667..f348b0f 100644 (file)
 /************************************************************
- 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.
-
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.
+ *
  ********************************************************/
 
-#define        DEBUG_VAR debugFlags
-#include <stdio.h>
-#include "xkbcomp.h"
-#include "tokens.h"
-#include "expr.h"
-#include "misc.h"
-
-#include <X11/extensions/XKB.h>
-#include <X11/extensions/XKBstrcommon.h>
+#include "config.h"
 
+#include "xkbcomp-priv.h"
+#include "text.h"
+#include "expr.h"
 #include "vmod.h"
 
-void
-InitVModInfo(VModInfo * info, XkbcDescPtr xkb)
-{
-    ClearVModInfo(info, xkb);
-    info->errorCount = 0;
-    return;
-}
-
-void
-ClearVModInfo(VModInfo * info, XkbcDescPtr xkb)
+bool
+HandleVModDef(struct xkb_context *ctx, struct xkb_mod_set *mods,
+              VModDef *stmt, enum merge_mode merge)
 {
-    register int i;
-
-    if (XkbcAllocNames(xkb, XkbVirtualModNamesMask, 0, 0) != Success)
-        return;
-    if (XkbcAllocServerMap(xkb, XkbVirtualModsMask, 0) != Success)
-        return;
-    info->xkb = xkb;
-    info->newlyDefined = info->defined = info->available = 0;
-    if (xkb && xkb->names)
-    {
-        register int bit;
-        for (i = 0, bit = 1; i < XkbNumVirtualMods; i++, bit <<= 1)
-        {
-            if (xkb->names->vmods[i] != None)
-                info->defined |= bit;
-        }
-    }
-    return;
-}
-
-/***====================================================================***/
-
-/**
- * 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, unsigned mergeMode, VModInfo * info)
-{
-    register int i, bit, nextFree;
-    ExprResult mod;
-    XkbServerMapPtr srv;
-    XkbNamesPtr names;
-    Atom stmtName;
-
-    srv = info->xkb->server;
-    names = info->xkb->names;
-    stmtName = XkbcInternAtom(XkbcAtomGetString(stmt->name), False);
-    for (i = 0, bit = 1, nextFree = -1; i < XkbNumVirtualMods; i++, bit <<= 1)
-    {
-        if (info->defined & bit)
-        {
-            if (names->vmods[i] == stmtName)
-            {                   /* already defined */
-                info->available |= bit;
-                if (stmt->value == NULL)
-                    return True;
-                else
-                {
-                    char *str1;
-                    const char *str2 = "";
-                    if (!ExprResolveModMask(stmt->value, &mod, NULL, NULL))
-                    {
-                        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;
-                }
-            }
+    xkb_mod_index_t i;
+    struct xkb_mod *mod;
+    xkb_mod_mask_t mapping;
+
+    merge = (merge == MERGE_DEFAULT ? stmt->merge : merge);
+
+    if (stmt->value) {
+        /*
+         * This is a statement such as 'virtualModifiers NumLock = Mod1';
+         * it sets the vmod-to-real-mod[s] mapping directly instead of going
+         * through modifier_map or some such.
+         */
+        if (!ExprResolveModMask(ctx, stmt->value, MOD_REAL, mods, &mapping)) {
+            log_err(ctx, XKB_LOG_MESSAGE_NO_ID,
+                    "Declaration of %s ignored\n",
+                    xkb_atom_text(ctx, stmt->name));
+            return false;
         }
-        else if (nextFree < 0)
-            nextFree = i;
     }
-    if (nextFree < 0)
-    {
-        ERROR("Too many virtual modifiers defined (maximum %d)\n",
-               XkbNumVirtualMods);
-        ACTION("Exiting\n");
-        return False;
+    else {
+        mapping = 0;
     }
-    info->defined |= (1 << nextFree);
-    info->newlyDefined |= (1 << nextFree);
-    info->available |= (1 << nextFree);
-    names->vmods[nextFree] = stmtName;
-    if (stmt->value == NULL)
-        return True;
-    if (ExprResolveModMask(stmt->value, &mod, NULL, NULL))
-    {
-        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 priv Pointer to the xkb data structure.
- * @param elem Must be None, otherwise return False.
- * @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.
- */
-int
-LookupVModIndex(char * priv,
-                Atom elem, Atom field, unsigned type, ExprResult * val_rtrn)
-{
-    register int i;
-    register char *fieldStr;
-    register char *modStr;
-    XkbcDescPtr xkb;
+    xkb_mods_enumerate(i, mod, mods) {
+        if (mod->name == stmt->name) {
+            if (mod->type != MOD_VIRT) {
+                log_err(ctx, XKB_LOG_MESSAGE_NO_ID,
+                        "Can't add a virtual modifier named \"%s\"; "
+                        "there is already a non-virtual modifier with this name! Ignored\n",
+                        xkb_atom_text(ctx, mod->name));
+                return false;
+            }
 
-    xkb = (XkbcDescPtr) priv;
-    if ((xkb == NULL) || (xkb->names == NULL) || (elem != None)
-        || (type != TypeInt))
-    {
-        return False;
-    }
-    /* get the actual name */
-    fieldStr = XkbcAtomGetString(field);
-    if (fieldStr == NULL)
-        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++)
-    {
-        modStr = XkbcAtomGetString(xkb->names->vmods[i]);
-        if ((modStr != NULL) && (uStrCaseCmp(fieldStr, modStr) == 0))
-        {
-            val_rtrn->uval = i;
-            return True;
-        }
-    }
-    return False;
-}
+            if (mod->mapping == mapping)
+                return true;
 
-/**
- * Get the mask for the given modifier and set val_rtrn.uval to the mask.
- * Note that the mask returned is always > 512.
- *
- * @param priv Pointer to xkb data structure.
- * @param val_rtrn Set to the mask returned.
- *
- * @return True on success, False otherwise. If False is returned, val_rtrn is
- * undefined.
- */
-int
-LookupVModMask(char * priv,
-               Atom elem, Atom field, unsigned type, ExprResult * val_rtrn)
-{
-    if (LookupVModIndex(priv, elem, field, type, val_rtrn))
-    {
-        register unsigned ndx = val_rtrn->uval;
-        val_rtrn->uval = (1 << (XkbNumModifiers + ndx));
-        return True;
-    }
-    return False;
-}
+            if (mod->mapping != 0) {
+                xkb_mod_mask_t use, ignore;
 
-int
-FindKeypadVMod(XkbcDescPtr xkb)
-{
-    Atom name;
-    ExprResult rtrn;
+                use = (merge == MERGE_OVERRIDE ? mapping : mod->mapping);
+                ignore = (merge == MERGE_OVERRIDE ? mod->mapping : mapping);
 
-    name = XkbcInternAtom("NumLock", False);
-    if ((xkb) && LookupVModIndex((char *) xkb, None, name, TypeInt, &rtrn))
-    {
-        return rtrn.ival;
-    }
-    return -1;
-}
+                log_warn(ctx, XKB_LOG_MESSAGE_NO_ID,
+                         "Virtual modifier %s defined multiple times; "
+                         "Using %s, ignoring %s\n",
+                         xkb_atom_text(ctx, stmt->name),
+                         ModMaskText(ctx, mods, use),
+                         ModMaskText(ctx, mods, ignore));
 
-Bool
-ResolveVirtualModifier(ExprDef * def, ExprResult * val_rtrn, VModInfo * info)
-{
-    XkbNamesPtr names;
-
-    names = info->xkb->names;
-    if (def->op == ExprIdent)
-    {
-        register int i, bit;
-        for (i = 0, bit = 1; i < XkbNumVirtualMods; i++, bit <<= 1)
-        {
-            char *str1, *str2;
-            str1 = XkbcAtomGetString(names->vmods[i]);
-            str2 = XkbcAtomGetString(def->value.str);
-            if ((info->available & bit) && (uStrCaseCmp(str1, str2) == Equal))
-            {
-                val_rtrn->uval = i;
-                return True;
+                mapping = use;
             }
+
+            mod->mapping = mapping;
+            return true;
         }
     }
-    if (ExprResolveInteger(def, val_rtrn, NULL, NULL))
-    {
-        if (val_rtrn->uval < XkbNumVirtualMods)
-            return True;
-        ERROR("Illegal virtual modifier %d (must be 0..%d inclusive)\n",
-               val_rtrn->uval, XkbNumVirtualMods - 1);
+
+    if (mods->num_mods >= XKB_MAX_MODS) {
+        log_err(ctx, XKB_LOG_MESSAGE_NO_ID,
+                "Too many modifiers defined (maximum %d)\n",
+                XKB_MAX_MODS);
+        return false;
     }
-    return False;
+
+    mods->mods[mods->num_mods].name = stmt->name;
+    mods->mods[mods->num_mods].type = MOD_VIRT;
+    mods->mods[mods->num_mods].mapping = mapping;
+    mods->num_mods++;
+    return true;
 }