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-priv.h"
  28 #include "indicators.h"
  29
  30 /**
  31  * Compile the given file and store the output in xkb.
  32  * @param file A list of XkbFiles, each denoting one type (e.g.
  33  * FILE_TYPE_KEYCODES, etc.)
  34  */
  35 struct xkb_keymap *
  36 CompileKeymap(struct xkb_context *ctx, XkbFile *file)
  37 {
  38     unsigned have = 0;
  39     bool ok;
  40     enum xkb_file_type mainType;
  41     const char *mainName;
  42     LEDInfo *unbound = NULL, *next;
  43     struct xkb_keymap *keymap = XkbcAllocKeyboard(ctx);
  44     struct {
  45         XkbFile *keycodes;
  46         XkbFile *types;
  47         XkbFile *compat;
  48         XkbFile *symbols;
  49     } sections = { NULL };
  50
  51     if (!keymap)
  52         return NULL;
  53
  54     mainType = file->type;
  55     mainName = file->name ? file->name : "(unnamed)";
  56
  57     /*
  58      * Other aggregate file types are converted to FILE_TYPE_KEYMAP
  59      * in the parser.
  60      */
  61     if (mainType != FILE_TYPE_KEYMAP) {
  62         ERROR("Cannot compile a %s file alone into a keymap\n",
  63               XkbcFileTypeText(mainType));
  64         goto err;
  65     }
  66
  67     /* Check for duplicate entries in the input file */
  68     for (file = (XkbFile *) file->defs; file; file = (XkbFile *) file->common.next)
  69     {
  70         if (have & file->type) {
  71             ERROR("More than one %s section in a %s file\n",
  72                    XkbcFileTypeText(file->type), XkbcFileTypeText(mainType));
  73             ACTION("All sections after the first ignored\n");
  74             continue;
  75         }
  76         else if (!(file->type & LEGAL_FILE_TYPES)) {
  77             ERROR("Cannot define %s in a %s file\n",
  78                    XkbcFileTypeText(file->type), XkbcFileTypeText(mainType));
  79             continue;
  80         }
  81
  82         switch (file->type) {
  83         case FILE_TYPE_KEYCODES:
  84             sections.keycodes = file;
  85             break;
  86         case FILE_TYPE_TYPES:
  87             sections.types = file;
  88             break;
  89         case FILE_TYPE_SYMBOLS:
  90             sections.symbols = file;
  91             break;
  92         case FILE_TYPE_COMPAT:
  93             sections.compat = file;
  94             break;
  95         case FILE_TYPE_GEOMETRY:
  96             continue;
  97         default:
  98             WSGO("Unknown file type %d\n", file->type);
  99             ACTION("Ignored\n");
 100             continue;
 101         case FILE_TYPE_KEYMAP:
 102             WSGO("Illegal %s configuration in a %s file\n",
 103                   XkbcFileTypeText(file->type), XkbcFileTypeText(mainType));
 104             ACTION("Ignored\n");
 105             continue;
 106         }
 107
 108         if (!file->topName || strcmp(file->topName, mainName) != 0) {
 109             free(file->topName);
 110             file->topName = strdup(mainName);
 111         }
 112
 113         have |= file->type;
 114     }
 115
 116     if (REQUIRED_FILE_TYPES & (~have)) {
 117         enum xkb_file_type bit;
 118         enum xkb_file_type missing;
 119
 120         missing = REQUIRED_FILE_TYPES & (~have);
 121
 122         for (bit = 1; missing != 0; bit <<= 1) {
 123             if (missing & bit) {
 124                 ERROR("Required section %s missing from keymap\n",
 125                       XkbcFileTypeText(bit));
 126                 missing &= ~bit;
 127             }
 128         }
 129
 130         goto err;
 131     }
 132
 133     /* compile the sections we have in the file one-by-one, or fail. */
 134     if (sections.keycodes == NULL ||
 135         !CompileKeycodes(sections.keycodes, keymap, MergeOverride))
 136     {
 137         ERROR("Failed to compile keycodes\n");
 138         goto err;
 139     }
 140     if (sections.types == NULL ||
 141         !CompileKeyTypes(sections.types, keymap, MergeOverride))
 142     {
 143         ERROR("Failed to compile key types\n");
 144         goto err;
 145     }
 146     if (sections.compat == NULL ||
 147         !CompileCompatMap(sections.compat, keymap, MergeOverride, &unbound))
 148     {
 149         ERROR("Failed to compile compat map\n");
 150         goto err;
 151     }
 152     if (sections.symbols == NULL ||
 153         !CompileSymbols(sections.symbols, keymap, MergeOverride))
 154     {
 155         ERROR("Failed to compile symbols\n");
 156         goto err;
 157     }
 158
 159     ok = BindIndicators(keymap, true, unbound, NULL);
 160     if (!ok)
 161         goto err;
 162
 163     ok = UpdateModifiersFromCompat(keymap);
 164     if (!ok)
 165         goto err;
 166
 167     return keymap;
 168
 169 err:
 170     ACTION("Failed to compile keymap\n");
 171     xkb_map_unref(keymap);
 172     while (unbound) {
 173         next = (LEDInfo *) unbound->defs.next;
 174         free(unbound);
 175         unbound = next;
 176     }
 177     return NULL;
 178 }