src/xkbcomp/xkbcomp.c

   1 /*
   2  * Copyright 2009  Dan Nicholson
   3  *
   4  * Permission is hereby granted, free of charge, to any person obtaining a
   5  * copy of this software and associated documentation files (the "Software"),
   6  * to deal in the Software without restriction, including without limitation
   7  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
   8  * and/or sell copies of the Software, and to permit persons to whom the
   9  * Software is furnished to do so, subject to the following conditions:
  10  *
  11  * The above copyright notice and this permission notice shall be included in
  12  * all copies or substantial portions of the Software.
  13  *
  14  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  15  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  16  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  17  * AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
  18  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  19  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  20  *
  21  * Except as contained in this notice, the names of the authors or their
  22  * institutions shall not be used in advertising or otherwise to promote the
  23  * sale, use or other dealings in this Software without prior written
  24  * authorization from the authors.
  25  */
  26
  27 #include "xkbcomp-priv.h"
  28 #include "rules.h"
  29
  30 static struct xkb_keymap *
  31 compile_keymap_file(struct xkb_context *ctx, XkbFile *file)
  32 {
  33     struct xkb_keymap *keymap;
  34
  35     keymap = xkb_map_new(ctx);
  36     if (!keymap)
  37         goto err;
  38
  39     if (file->file_type != FILE_TYPE_KEYMAP) {
  40         log_err(ctx, "Cannot compile a %s file alone into a keymap\n",
  41                 xkb_file_type_to_string(file->file_type));
  42         goto err;
  43     }
  44
  45     if (!CompileKeymap(file, keymap, MERGE_OVERRIDE)) {
  46         log_err(ctx, "Failed to compile keymap\n");
  47         goto err;
  48     }
  49
  50     return keymap;
  51
  52 err:
  53     xkb_map_unref(keymap);
  54     return NULL;
  55 }
  56
  57 XKB_EXPORT struct xkb_keymap *
  58 xkb_map_new_from_names(struct xkb_context *ctx,
  59                        const struct xkb_rule_names *rmlvo_in,
  60                        enum xkb_map_compile_flags flags)
  61 {
  62     bool ok;
  63     struct xkb_component_names kccgst;
  64     struct xkb_rule_names rmlvo = *rmlvo_in;
  65     XkbFile *file;
  66     struct xkb_keymap *keymap;
  67
  68     if (isempty(rmlvo.rules))
  69         rmlvo.rules = DEFAULT_XKB_RULES;
  70     if (isempty(rmlvo.model))
  71         rmlvo.model = DEFAULT_XKB_MODEL;
  72     if (isempty(rmlvo.layout))
  73         rmlvo.layout = DEFAULT_XKB_LAYOUT;
  74
  75     log_dbg(ctx,
  76             "Compiling from RMLVO: rules '%s', model '%s', layout '%s', "
  77             "variant '%s', options '%s'\n",
  78             rmlvo.rules, rmlvo.model, rmlvo.layout, rmlvo.variant,
  79             rmlvo.options);
  80
  81     ok = xkb_components_from_rules(ctx, &rmlvo, &kccgst);
  82     if (!ok) {
  83         log_err(ctx,
  84                 "Couldn't look up rules '%s', model '%s', layout '%s', "
  85                 "variant '%s', options '%s'\n",
  86                 rmlvo.rules, rmlvo.model, rmlvo.layout, rmlvo.variant,
  87                 rmlvo.options);
  88         return NULL;
  89     }
  90
  91     log_dbg(ctx,
  92             "Compiling from KcCGST: keycodes '%s', types '%s', "
  93             "compat '%s', symbols '%s'\n",
  94             kccgst.keycodes, kccgst.types, kccgst.compat, kccgst.symbols);
  95
  96     file = XkbFileFromComponents(ctx, &kccgst);
  97
  98     free(kccgst.keycodes);
  99     free(kccgst.types);
 100     free(kccgst.compat);
 101     free(kccgst.symbols);
 102
 103     if (!file) {
 104         log_err(ctx,
 105                 "Failed to generate parsed XKB file from components\n");
 106         return NULL;
 107     }
 108
 109     keymap = compile_keymap_file(ctx, file);
 110     FreeXkbFile(file);
 111     return keymap;
 112 }
 113
 114 XKB_EXPORT struct xkb_keymap *
 115 xkb_map_new_from_string(struct xkb_context *ctx,
 116                         const char *string,
 117                         enum xkb_keymap_format format,
 118                         enum xkb_map_compile_flags flags)
 119 {
 120     bool ok;
 121     XkbFile *file;
 122     struct xkb_keymap *keymap;
 123
 124     if (format != XKB_KEYMAP_FORMAT_TEXT_V1) {
 125         log_err(ctx, "Unsupported keymap format %d\n", format);
 126         return NULL;
 127     }
 128
 129     if (!string) {
 130         log_err(ctx, "No string specified to generate XKB keymap\n");
 131         return NULL;
 132     }
 133
 134     ok = XkbParseString(ctx, string, "input", &file);
 135     if (!ok) {
 136         log_err(ctx, "Failed to parse input xkb file\n");
 137         return NULL;
 138     }
 139
 140     keymap = compile_keymap_file(ctx, file);
 141     FreeXkbFile(file);
 142     return keymap;
 143 }
 144
 145 XKB_EXPORT struct xkb_keymap *
 146 xkb_map_new_from_file(struct xkb_context *ctx,
 147                       FILE *file,
 148                       enum xkb_keymap_format format,
 149                       enum xkb_map_compile_flags flags)
 150 {
 151     bool ok;
 152     XkbFile *xkb_file;
 153     struct xkb_keymap *keymap;
 154
 155     if (format != XKB_KEYMAP_FORMAT_TEXT_V1) {
 156         log_err(ctx, "Unsupported keymap format %d\n", format);
 157         return NULL;
 158     }
 159
 160     if (!file) {
 161         log_err(ctx, "No file specified to generate XKB keymap\n");
 162         return NULL;
 163     }
 164
 165     ok = XkbParseFile(ctx, file, "(unknown file)", &xkb_file);
 166     if (!ok) {
 167         log_err(ctx, "Failed to parse input xkb file\n");
 168         return NULL;
 169     }
 170
 171     keymap = compile_keymap_file(ctx, xkb_file);
 172     FreeXkbFile(xkb_file);
 173     return keymap;
 174 }