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 <limits.h>
  28 #include "xkbcomp.h"
  29 #include "xkballoc.h"
  30 #include "xkbrules.h"
  31 #include "xkbpath.h"
  32 #include "xkbmisc.h"
  33 #include "parseutils.h"
  34 #include "utils.h"
  35
  36 /* Global debugging flags */
  37 unsigned int debugFlags = 0;
  38 unsigned int warningLevel = 0;
  39
  40 #define ISEMPTY(str) (!(str) || (strlen(str) == 0))
  41
  42 static XkbFile *
  43 XkbKeymapFileFromComponents(const struct xkb_component_names * ktcsg)
  44 {
  45     XkbFile *keycodes, *types, *compat, *symbols;
  46     IncludeStmt *inc;
  47
  48     inc = IncludeCreate(ktcsg->keycodes, MergeDefault);
  49     keycodes = CreateXKBFile(XkmKeyNamesIndex, NULL, (ParseCommon *)inc, 0);
  50
  51     inc = IncludeCreate(ktcsg->types, MergeDefault);
  52     types = CreateXKBFile(XkmTypesIndex, NULL, (ParseCommon *)inc, 0);
  53     AppendStmt(&keycodes->common, &types->common);
  54
  55     inc = IncludeCreate(ktcsg->compat, MergeDefault);
  56     compat = CreateXKBFile(XkmCompatMapIndex, NULL, (ParseCommon *)inc, 0);
  57     AppendStmt(&keycodes->common, &compat->common);
  58
  59     inc = IncludeCreate(ktcsg->symbols, MergeDefault);
  60     symbols = CreateXKBFile(XkmSymbolsIndex, NULL, (ParseCommon *)inc, 0);
  61     AppendStmt(&keycodes->common, &symbols->common);
  62
  63     return CreateXKBFile(XkmKeymapFile, ktcsg->keymap ? ktcsg->keymap : strdup(""),
  64                          &keycodes->common, 0);
  65 }
  66
  67 static struct xkb_component_names *
  68 XkbComponentsFromRules(const char *rules, const XkbRF_VarDefsPtr defs)
  69 {
  70     FILE *rulesFile = NULL;
  71     char *rulesPath = NULL;
  72     XkbRF_RulesPtr loaded = NULL;
  73     struct xkb_component_names * names = NULL;
  74
  75     rulesFile = XkbFindFileInPath(rules, XkmRulesFile, &rulesPath);
  76     if (!rulesFile) {
  77         ERROR("could not find \"%s\" rules in XKB path\n", rules);
  78         return NULL;
  79     }
  80
  81     if (!(loaded = _XkbTypedCalloc(1, XkbRF_RulesRec))) {
  82         ERROR("failed to allocate XKB rules\n");
  83         goto unwind_file;
  84     }
  85
  86     if (!XkbcRF_LoadRules(rulesFile, loaded)) {
  87         ERROR("failed to load XKB rules \"%s\"\n", rulesPath);
  88         goto unwind_file;
  89     }
  90
  91     if (!(names = _XkbTypedCalloc(1, struct xkb_component_names))) {
  92         ERROR("failed to allocate XKB components\n");
  93         goto unwind_file;
  94     }
  95
  96     if (!XkbcRF_GetComponents(loaded, defs, names)) {
  97         free(names->keymap);
  98         free(names->keycodes);
  99         free(names->types);
 100         free(names->compat);
 101         free(names->symbols);
 102         free(names);
 103         names = NULL;
 104         ERROR("no components returned from XKB rules \"%s\"\n", rulesPath);
 105     }
 106
 107 unwind_file:
 108     XkbcRF_Free(loaded);
 109     if (rulesFile)
 110         fclose(rulesFile);
 111     free(rulesPath);
 112     return names;
 113 }
 114
 115 struct xkb_desc *
 116 xkb_compile_keymap_from_rules(const struct xkb_rule_names *rmlvo)
 117 {
 118     XkbRF_VarDefsRec defs;
 119     struct xkb_component_names * names;
 120     struct xkb_desc * xkb;
 121
 122     if (!rmlvo || ISEMPTY(rmlvo->rules) || ISEMPTY(rmlvo->layout)) {
 123         ERROR("rules and layout required to generate XKB keymap\n");
 124         return NULL;
 125     }
 126
 127     defs.model = rmlvo->model;
 128     defs.layout = rmlvo->layout;
 129     defs.variant = rmlvo->variant;
 130     defs.options = rmlvo->options;
 131
 132     names = XkbComponentsFromRules(rmlvo->rules, &defs);
 133     if (!names) {
 134         ERROR("failed to generate XKB components from rules \"%s\"\n",
 135               rmlvo->rules);
 136         return NULL;
 137     }
 138
 139     xkb = xkb_compile_keymap_from_components(names);
 140
 141     free(names->keymap);
 142     free(names->keycodes);
 143     free(names->types);
 144     free(names->compat);
 145     free(names->symbols);
 146     free(names);
 147
 148     return xkb;
 149 }
 150
 151 static XkbFile *
 152 XkbChooseMap(XkbFile *file, const char *name)
 153 {
 154     XkbFile *map = file;
 155
 156     /* map specified? */
 157     if (name) {
 158         while (map) {
 159             if (map->name && strcmp(map->name, name) == 0)
 160                 break;
 161             map = (XkbFile *) map->common.next;
 162         }
 163
 164         if (!map)
 165             ERROR("no map named \"%s\" in input file\n", name);
 166     }
 167     else if (file->common.next) {
 168         /* look for map with XkbLC_Default flag. */
 169         for (; map; map = (XkbFile *) map->common.next) {
 170             if (map->flags & XkbLC_Default)
 171                 break;
 172         }
 173
 174         if (!map) {
 175             map = file;
 176             WARN("no map specified, but components have several\n");
 177             WARN("using the first defined map, \"%s\"\n",
 178                  map->name ? map->name : "");
 179         }
 180     }
 181
 182     return map;
 183 }
 184
 185 static struct xkb_desc *
 186 compile_keymap(XkbFile *file, const char *mapName)
 187 {
 188     XkbFile *mapToUse;
 189     struct xkb_desc * xkb = NULL;
 190
 191     /* Find map to use */
 192     if (!(mapToUse = XkbChooseMap(file, mapName)))
 193         goto unwind_file;
 194
 195     switch (mapToUse->type) {
 196     case XkmSemanticsFile:
 197     case XkmLayoutFile:
 198     case XkmKeymapFile:
 199         break;
 200     default:
 201         ERROR("file type %d not handled\n", mapToUse->type);
 202         goto unwind_file;
 203     }
 204
 205     /* Compile the keyboard */
 206     if (!(xkb = XkbcAllocKeyboard())) {
 207         ERROR("could not allocate keyboard description\n");
 208         goto unwind_file;
 209     }
 210
 211     if (!CompileKeymap(mapToUse, xkb, MergeReplace)) {
 212         ERROR("failed to compile keymap\n");
 213         XkbcFreeKeyboard(xkb);
 214         xkb = NULL;
 215     }
 216
 217 unwind_file:
 218     FreeXKBFile(file);
 219     free(scanFile);
 220     XkbFreeIncludePath();
 221     return xkb;
 222 }
 223
 224 struct xkb_desc *
 225 xkb_compile_keymap_from_components(const struct xkb_component_names * ktcsg)
 226 {
 227     XkbFile *file;
 228
 229     if (!ktcsg) {
 230         ERROR("no components specified\n");
 231         return NULL;
 232     }
 233
 234     if (ISEMPTY(ktcsg->keycodes)) {
 235         ERROR("keycodes required to generate XKB keymap\n");
 236         return NULL;
 237     }
 238
 239     if (ISEMPTY(ktcsg->compat)) {
 240         ERROR("compat map required to generate XKB keymap\n");
 241         return NULL;
 242     }
 243
 244     if (ISEMPTY(ktcsg->types)) {
 245         ERROR("types required to generate XKB keymap\n");
 246         return NULL;
 247     }
 248
 249     if (ISEMPTY(ktcsg->symbols)) {
 250         ERROR("symbols required to generate XKB keymap\n");
 251         return NULL;
 252     }
 253
 254     if (!(file = XkbKeymapFileFromComponents(ktcsg))) {
 255         ERROR("failed to generate parsed XKB file from components\n");
 256         return NULL;
 257     }
 258
 259     return compile_keymap(file, NULL);
 260 }
 261
 262 struct xkb_desc *
 263 xkb_compile_keymap_from_string(const char *string, const char *mapName)
 264 {
 265     XkbFile *file;
 266
 267     if (!string) {
 268         ERROR("no string specified to generate XKB keymap\n");
 269         return NULL;
 270     }
 271
 272     setScanState("input", 1);
 273     if (!XKBParseString(string, &file) || !file) {
 274         ERROR("failed to parse input xkb file\n");
 275         return NULL;
 276     }
 277
 278     return compile_keymap(file, mapName);
 279 }
 280
 281 struct xkb_desc *
 282 xkb_compile_keymap_from_file(FILE *inputFile, const char *mapName)
 283 {
 284     XkbFile *file;
 285
 286     if (!inputFile) {
 287         ERROR("no file specified to generate XKB keymap\n");
 288         return NULL;
 289     }
 290
 291     setScanState("input", 1);
 292     if (!XKBParseFile(inputFile, &file) || !file) {
 293         ERROR("failed to parse input xkb file\n");
 294         return NULL;
 295     }
 296
 297     return compile_keymap(file, mapName);
 298 }
 299
 300 void
 301 xkb_free_keymap(struct xkb_desc *xkb)
 302 {
 303     XkbcFreeKeyboard(xkb);
 304     XkbcFreeAllAtoms();
 305 }