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 #include "parseutils.h"
  30
  31 /* Global warning level */
  32 unsigned int warningLevel = 0;
  33
  34 #define ISEMPTY(str) (!(str) || (strlen(str) == 0))
  35
  36 static XkbFile *
  37 XkbKeymapFileFromComponents(struct xkb_context *ctx,
  38                             const struct xkb_component_names *ktcsg)
  39 {
  40     XkbFile *keycodes, *types, *compat, *symbols;
  41     IncludeStmt *inc;
  42
  43     inc = IncludeCreate(ktcsg->keycodes, MERGE_DEFAULT);
  44     keycodes = CreateXKBFile(ctx, FILE_TYPE_KEYCODES, NULL,
  45                              (ParseCommon *)inc, 0);
  46
  47     inc = IncludeCreate(ktcsg->types, MERGE_DEFAULT);
  48     types = CreateXKBFile(ctx, FILE_TYPE_TYPES, NULL,
  49                           (ParseCommon *)inc, 0);
  50     AppendStmt(&keycodes->common, &types->common);
  51
  52     inc = IncludeCreate(ktcsg->compat, MERGE_DEFAULT);
  53     compat = CreateXKBFile(ctx, FILE_TYPE_COMPAT, NULL,
  54                            (ParseCommon *)inc, 0);
  55     AppendStmt(&keycodes->common, &compat->common);
  56
  57     inc = IncludeCreate(ktcsg->symbols, MERGE_DEFAULT);
  58     symbols = CreateXKBFile(ctx, FILE_TYPE_SYMBOLS, NULL,
  59                             (ParseCommon *)inc, 0);
  60     AppendStmt(&keycodes->common, &symbols->common);
  61
  62     return CreateXKBFile(ctx, FILE_TYPE_KEYMAP,
  63                          ktcsg->keymap ? ktcsg->keymap : strdup(""),
  64                          &keycodes->common, 0);
  65 }
  66
  67 _X_EXPORT struct xkb_keymap *
  68 xkb_map_new_from_names(struct xkb_context *ctx,
  69                        const struct xkb_rule_names *rmlvo,
  70                        enum xkb_map_compile_flags flags)
  71 {
  72     struct xkb_component_names *kkctgs;
  73     struct xkb_keymap *keymap;
  74
  75     if (!rmlvo || ISEMPTY(rmlvo->rules) || ISEMPTY(rmlvo->layout)) {
  76         ERROR("rules and layout required to generate XKB keymap\n");
  77         return NULL;
  78     }
  79
  80     kkctgs = xkb_components_from_rules(ctx, rmlvo);
  81     if (!kkctgs) {
  82         ERROR("failed to generate XKB components from rules \"%s\"\n",
  83               rmlvo->rules);
  84         return NULL;
  85     }
  86
  87     keymap = xkb_map_new_from_kccgst(ctx, kkctgs, 0);
  88
  89     free(kkctgs->keymap);
  90     free(kkctgs->keycodes);
  91     free(kkctgs->types);
  92     free(kkctgs->compat);
  93     free(kkctgs->symbols);
  94     free(kkctgs);
  95
  96     return keymap;
  97 }
  98
  99 static struct xkb_keymap *
 100 compile_keymap(struct xkb_context *ctx, XkbFile *file)
 101 {
 102     struct xkb_keymap *keymap;
 103
 104     keymap = CompileKeymap(ctx, file);
 105
 106     FreeXKBFile(file);
 107     return keymap;
 108 }
 109
 110 _X_EXPORT struct xkb_keymap *
 111 xkb_map_new_from_kccgst(struct xkb_context *ctx,
 112                         const struct xkb_component_names *kccgst,
 113                         enum xkb_map_compile_flags flags)
 114 {
 115     XkbFile *file;
 116
 117     if (!kccgst) {
 118         ERROR("no components specified\n");
 119         return NULL;
 120     }
 121
 122     if (ISEMPTY(kccgst->keycodes)) {
 123         ERROR("keycodes required to generate XKB keymap\n");
 124         return NULL;
 125     }
 126
 127     if (ISEMPTY(kccgst->compat)) {
 128         ERROR("compat map required to generate XKB keymap\n");
 129         return NULL;
 130     }
 131
 132     if (ISEMPTY(kccgst->types)) {
 133         ERROR("types required to generate XKB keymap\n");
 134         return NULL;
 135     }
 136
 137     if (ISEMPTY(kccgst->symbols)) {
 138         ERROR("symbols required to generate XKB keymap\n");
 139         return NULL;
 140     }
 141
 142     if (!(file = XkbKeymapFileFromComponents(ctx, kccgst))) {
 143         ERROR("failed to generate parsed XKB file from components\n");
 144         return NULL;
 145     }
 146
 147     return compile_keymap(ctx, file);
 148 }
 149
 150 _X_EXPORT struct xkb_keymap *
 151 xkb_map_new_from_string(struct xkb_context *ctx,
 152                         const char *string,
 153                         enum xkb_keymap_format format,
 154                         enum xkb_map_compile_flags flags)
 155 {
 156     XkbFile *file;
 157
 158     if (format != XKB_KEYMAP_FORMAT_TEXT_V1) {
 159         ERROR("unsupported keymap format %d\n", format);
 160         return NULL;
 161     }
 162
 163     if (!string) {
 164         ERROR("no string specified to generate XKB keymap\n");
 165         return NULL;
 166     }
 167
 168     if (!XKBParseString(ctx, string, "input", &file)) {
 169         ERROR("failed to parse input xkb file\n");
 170         return NULL;
 171     }
 172
 173     return compile_keymap(ctx, file);
 174 }
 175
 176 _X_EXPORT struct xkb_keymap *
 177 xkb_map_new_from_file(struct xkb_context *ctx,
 178                       FILE *file,
 179                       enum xkb_keymap_format format,
 180                       enum xkb_map_compile_flags flags)
 181 {
 182     XkbFile *xkb_file;
 183
 184     if (format != XKB_KEYMAP_FORMAT_TEXT_V1) {
 185         ERROR("unsupported keymap format %d\n", format);
 186         return NULL;
 187     }
 188
 189     if (!file) {
 190         ERROR("no file specified to generate XKB keymap\n");
 191         return NULL;
 192     }
 193
 194     if (!XKBParseFile(ctx, file, "(unknown file)", &xkb_file)) {
 195         ERROR("failed to parse input xkb file\n");
 196         return NULL;
 197     }
 198
 199     return compile_keymap(ctx, xkb_file);
 200 }
 201
 202 _X_EXPORT struct xkb_keymap *
 203 xkb_map_ref(struct xkb_keymap *keymap)
 204 {
 205     keymap->refcnt++;
 206     return keymap;
 207 }
 208
 209 _X_EXPORT void
 210 xkb_map_unref(struct xkb_keymap *keymap)
 211 {
 212     if (--keymap->refcnt > 0)
 213         return;
 214
 215     XkbcFreeKeyboard(keymap);
 216 }