src/xkbcomp/include.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 <errno.h>
  28 #include <limits.h>
  29 #include <stdio.h>
  30
  31 #include "xkbcomp-priv.h"
  32 #include "text.h"
  33 #include "include.h"
  34
  35 /**
  36  * Extract the first token from an include statement.
  37  * @param str_inout Input statement, modified in-place. Can be passed in
  38  * repeatedly. If str_inout is NULL, the parsing has completed.
  39  * @param file_rtrn Set to the include file to be used.
  40  * @param map_rtrn Set to whatever comes after ), if any.
  41  * @param nextop_rtrn Set to the next operation in the complete statement.
  42  * @param extra_data Set to the string between ( and ), if any.
  43  *
  44  * @return true if parsing was succcessful, false for an illegal string.
  45  *
  46  * Example: "evdev+aliases(qwerty)"
  47  *      str_inout = aliases(qwerty)
  48  *      nextop_retrn = +
  49  *      extra_data = NULL
  50  *      file_rtrn = evdev
  51  *      map_rtrn = NULL
  52  *
  53  * 2nd run with "aliases(qwerty)"
  54  *      str_inout = NULL
  55  *      file_rtrn = aliases
  56  *      map_rtrn = qwerty
  57  *      extra_data = NULL
  58  *      nextop_retrn = ""
  59  *
  60  */
  61 bool
  62 ParseIncludeMap(char **str_inout, char **file_rtrn, char **map_rtrn,
  63                 char *nextop_rtrn, char **extra_data)
  64 {
  65     char *tmp, *str, *next;
  66
  67     str = *str_inout;
  68
  69     /* search for tokens inside the string */
  70     next = strpbrk(str, "|+");
  71     if (next) {
  72         /* set nextop_rtrn to \0, next to next character */
  73         *nextop_rtrn = *next;
  74         *next++ = '\0';
  75     }
  76     else {
  77         *nextop_rtrn = '\0';
  78         next = NULL;
  79     }
  80
  81     /* search for :, store result in extra_data */
  82     tmp = strchr(str, ':');
  83     if (tmp != NULL) {
  84         *tmp++ = '\0';
  85         *extra_data = strdup(tmp);
  86     }
  87     else {
  88         *extra_data = NULL;
  89     }
  90
  91     tmp = strchr(str, '(');
  92     if (tmp == NULL) {
  93         *file_rtrn = strdup(str);
  94         *map_rtrn = NULL;
  95     }
  96     else if (str[0] == '(') {
  97         free(*extra_data);
  98         return false;
  99     }
 100     else {
 101         *tmp++ = '\0';
 102         *file_rtrn = strdup(str);
 103         str = tmp;
 104         tmp = strchr(str, ')');
 105         if ((tmp == NULL) || (tmp[1] != '\0')) {
 106             free(*file_rtrn);
 107             free(*extra_data);
 108             return false;
 109         }
 110         *tmp++ = '\0';
 111         *map_rtrn = strdup(str);
 112     }
 113
 114     if (*nextop_rtrn == '\0')
 115         *str_inout = NULL;
 116     else if ((*nextop_rtrn == '|') || (*nextop_rtrn == '+'))
 117         *str_inout = next;
 118     else
 119         return false;
 120
 121     return true;
 122 }
 123
 124 /***====================================================================***/
 125
 126 static const char *xkb_file_type_include_dirs[_FILE_TYPE_NUM_ENTRIES] = {
 127     [FILE_TYPE_KEYCODES] = "keycodes",
 128     [FILE_TYPE_TYPES] = "types",
 129     [FILE_TYPE_COMPAT] = "compat",
 130     [FILE_TYPE_SYMBOLS] = "symbols",
 131     [FILE_TYPE_GEOMETRY] = "geometry",
 132     [FILE_TYPE_KEYMAP] = "keymap",
 133     [FILE_TYPE_RULES] = "rules",
 134 };
 135
 136 /**
 137  * Return the xkb directory based on the type.
 138  */
 139 static const char *
 140 DirectoryForInclude(enum xkb_file_type type)
 141 {
 142     if (type >= _FILE_TYPE_NUM_ENTRIES)
 143         return "";
 144     return xkb_file_type_include_dirs[type];
 145 }
 146
 147 /***====================================================================***/
 148
 149 /**
 150  * Search for the given file name in the include directories.
 151  *
 152  * @param ctx the XKB ctx containing the include paths
 153  * @param type one of FILE_TYPE_TYPES, FILE_TYPE_COMPAT, ..., or
 154  *             FILE_TYPE_KEYMAP or FILE_TYPE_RULES
 155  * @param pathRtrn is set to the full path of the file if found.
 156  *
 157  * @return an FD to the file or NULL. If NULL is returned, the value of
 158  * pathRtrn is undefined.
 159  */
 160 FILE *
 161 FindFileInXkbPath(struct xkb_context *ctx, const char *name,
 162                   enum xkb_file_type type, char **pathRtrn)
 163 {
 164     size_t i;
 165     int ret;
 166     FILE *file = NULL;
 167     char buf[PATH_MAX];
 168     const char *typeDir;
 169
 170     typeDir = DirectoryForInclude(type);
 171     for (i = 0; i < xkb_context_num_include_paths(ctx); i++) {
 172         ret = snprintf(buf, sizeof(buf), "%s/%s/%s",
 173                        xkb_context_include_path_get(ctx, i), typeDir, name);
 174         if (ret >= (ssize_t) sizeof(buf)) {
 175             log_err(ctx, "File name (%s/%s/%s) too long\n",
 176                     xkb_context_include_path_get(ctx, i), typeDir, name);
 177             continue;
 178         }
 179         file = fopen(buf, "r");
 180         if (file == NULL) {
 181             log_err(ctx, "Couldn't open file (%s/%s/%s): %s\n",
 182                     xkb_context_include_path_get(ctx, i), typeDir, name,
 183                     strerror(errno));
 184             continue;
 185         }
 186         break;
 187     }
 188
 189     if ((file != NULL) && (pathRtrn != NULL))
 190         *pathRtrn = strdup(buf);
 191     return file;
 192 }
 193
 194 /**
 195  * Open the file given in the include statement and parse it's content.
 196  * If the statement defines a specific map to use, this map is returned in
 197  * file_rtrn. Otherwise, the default map is returned.
 198  *
 199  * @param ctx The ctx containing include paths
 200  * @param stmt The include statement, specifying the file name to look for.
 201  * @param file_type Type of file (FILE_TYPE_KEYCODES, etc.)
 202  * @param file_rtrn Returns the key map to be used.
 203  * @param merge_rtrn Always returns stmt->merge.
 204  *
 205  * @return true on success or false otherwise.
 206  */
 207 bool
 208 ProcessIncludeFile(struct xkb_context *ctx,
 209                    IncludeStmt * stmt,
 210                    enum xkb_file_type file_type,
 211                    XkbFile ** file_rtrn, enum merge_mode *merge_rtrn)
 212 {
 213     FILE *file;
 214     XkbFile *rtrn, *mapToUse, *next;
 215
 216     file = FindFileInXkbPath(ctx, stmt->file, file_type, NULL);
 217     if (file == NULL) {
 218         log_err(ctx, "Can't find file \"%s\" for %s include\n", stmt->file,
 219                 DirectoryForInclude(file_type));
 220         return false;
 221     }
 222
 223     if (!XkbParseFile(ctx, file, stmt->file, &rtrn)) {
 224         log_err(ctx, "Error interpreting include file \"%s\"\n", stmt->file);
 225         fclose(file);
 226         return false;
 227     }
 228     fclose(file);
 229
 230     mapToUse = rtrn;
 231     if (stmt->map != NULL) {
 232         while (mapToUse)
 233         {
 234             next = (XkbFile *) mapToUse->common.next;
 235             mapToUse->common.next = NULL;
 236             if (streq(mapToUse->name, stmt->map) &&
 237                 mapToUse->file_type == file_type) {
 238                 FreeXkbFile(next);
 239                 break;
 240             }
 241             else {
 242                 FreeXkbFile(mapToUse);
 243             }
 244             mapToUse = next;
 245         }
 246         if (!mapToUse) {
 247             log_err(ctx, "No %s named \"%s\" in the include file \"%s\"\n",
 248                     FileTypeText(file_type), stmt->map, stmt->file);
 249             return false;
 250         }
 251     }
 252     else if (rtrn->common.next) {
 253         log_lvl(ctx, 5,
 254                 "No map in include statement, but \"%s\" contains several; "
 255                 "Using first defined map, \"%s\"\n",
 256                 stmt->file, rtrn->name);
 257     }
 258     if (mapToUse->file_type != file_type) {
 259         log_err(ctx,
 260                 "Include file wrong type (expected %s, got %s); "
 261                 "Include file \"%s\" ignored\n",
 262                 FileTypeText(file_type), FileTypeText(mapToUse->file_type),
 263                 stmt->file);
 264         return false;
 265     }
 266     /* FIXME: we have to check recursive includes here (or somewhere) */
 267
 268     *file_rtrn = mapToUse;
 269     *merge_rtrn = stmt->merge;
 270     return true;
 271 }