src/xkbcomp/keymap.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.h"
  28 #include "xkbmisc.h"
  29 #include "expr.h"
  30 #include "vmod.h"
  31 #include "action.h"
  32 #include "misc.h"
  33 #include "indicators.h"
  34 #include "xkballoc.h"
  35
  36 /**
  37  * Compile the given file and store the output in xkb.
  38  * @param file A list of XkbFiles, each denoting one type (e.g.
  39  * XkmKeyNamesIdx, etc.)
  40  */
  41 struct xkb_desc *
  42 CompileKeymap(XkbFile *file, unsigned merge)
  43 {
  44     unsigned have;
  45     Bool ok;
  46     unsigned required, legal;
  47     unsigned mainType;
  48     char *mainName;
  49     LEDInfo *unbound = NULL;
  50     struct xkb_desc *xkb = XkbcAllocKeyboard();
  51     struct {
  52         XkbFile *keycodes;
  53         XkbFile *types;
  54         XkbFile *compat;
  55         XkbFile *symbols;
  56     } sections;
  57
  58     if (!xkb)
  59         return NULL;
  60
  61     memset(&sections, 0, sizeof(sections));
  62     mainType = file->type;
  63     mainName = file->name;
  64     switch (mainType)
  65     {
  66     case XkmSemanticsFile:
  67         required = XkmSemanticsRequired;
  68         legal = XkmSemanticsLegal;
  69         break;
  70     case XkmLayoutFile:        /* standard type  if setxkbmap -print */
  71         required = XkmLayoutRequired;
  72         legal = XkmKeymapLegal;
  73         break;
  74     case XkmKeymapFile:
  75         required = XkmKeyNamesIndex | XkmTypesIndex | XkmSymbolsIndex | \
  76                    XkmCompatMapIndex | XkmVirtualModsIndex;
  77         legal = XkmKeymapLegal;
  78         break;
  79     default:
  80         ERROR("Cannot compile %s alone into an XKM file\n",
  81                XkbcConfigText(mainType));
  82         return False;
  83     }
  84     have = 0;
  85     ok = 1;
  86     /* Check for duplicate entries in the input file */
  87     for (file = (XkbFile *) file->defs; file; file = (XkbFile *) file->common.next)
  88     {
  89         if (file->topName != mainName) {
  90             free(file->topName);
  91             file->topName = strdup(mainName);
  92         }
  93
  94         if ((have & (1 << file->type)) != 0)
  95         {
  96             ERROR("More than one %s section in a %s file\n",
  97                    XkbcConfigText(file->type), XkbcConfigText(mainType));
  98             ACTION("All sections after the first ignored\n");
  99             continue;
 100         }
 101         else if ((1 << file->type) & (~legal))
 102         {
 103             ERROR("Cannot define %s in a %s file\n",
 104                    XkbcConfigText(file->type), XkbcConfigText(mainType));
 105             continue;
 106         }
 107
 108         switch (file->type)
 109         {
 110         case XkmKeyNamesIndex:
 111             sections.keycodes = file;
 112             break;
 113         case XkmTypesIndex:
 114             sections.types = file;
 115             break;
 116         case XkmSymbolsIndex:
 117             sections.symbols = file;
 118             break;
 119         case XkmCompatMapIndex:
 120             sections.compat = file;
 121             break;
 122         case XkmGeometryIndex:
 123             continue;
 124         case XkmVirtualModsIndex:
 125         case XkmIndicatorsIndex:
 126             WSGO("Found an isolated %s section\n", XkbcConfigText(file->type));
 127             ACTION("Ignored\n");
 128             continue;
 129         default:
 130             WSGO("Unknown file type %d\n", file->type);
 131             ACTION("Ignored\n");
 132             continue;
 133         case XkmSemanticsFile:
 134         case XkmLayoutFile:
 135         case XkmKeymapFile:
 136             WSGO("Illegal %s configuration in a %s file\n",
 137                   XkbcConfigText(file->type), XkbcConfigText(mainType));
 138             ACTION("Ignored\n");
 139             continue;
 140         }
 141
 142         have |= (1 << file->type);
 143     }
 144
 145     if (required & (~have))
 146     {
 147         int i, bit;
 148         unsigned missing;
 149         missing = required & (~have);
 150         for (i = 0, bit = 1; missing != 0; i++, bit <<= 1)
 151         {
 152             if (missing & bit)
 153             {
 154                 ERROR("Required section %s missing from keymap\n", XkbcConfigText(i));
 155                 missing &= ~bit;
 156             }
 157         }
 158         goto err;
 159     }
 160
 161     /* compile the sections we have in the file one-by-one, or fail. */
 162     if (sections.keycodes != NULL &&
 163         !CompileKeycodes(sections.keycodes, xkb, MergeOverride))
 164     {
 165         ERROR("Failed to compile keycodes\n");
 166         goto err;
 167     }
 168     if (sections.types != NULL &&
 169         !CompileKeyTypes(sections.types, xkb, MergeOverride))
 170     {
 171         ERROR("Failed to compile key types\n");
 172         goto err;
 173     }
 174     if (sections.compat != NULL &&
 175         !CompileCompatMap(sections.compat, xkb, MergeOverride, &unbound))
 176     {
 177         ERROR("Failed to compile compat map\n");
 178         goto err;
 179     }
 180     if (sections.symbols != NULL &&
 181         !CompileSymbols(sections.symbols, xkb, MergeOverride))
 182     {
 183         ERROR("Failed to compile symbols\n");
 184         goto err;
 185     }
 186
 187     xkb->defined = have;
 188
 189     ok = BindIndicators(xkb, True, unbound, NULL);
 190     if (!ok)
 191         goto err;
 192
 193     return xkb;
 194
 195 err:
 196     ACTION("Failed to compile keymap\n");
 197     if (xkb)
 198         xkb_free_keymap(xkb);
 199     return NULL;
 200 }