2 * Copyright 2009 Dan Nicholson
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:
11 * The above copyright notice and this permission notice shall be included in
12 * all copies or substantial portions of the Software.
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.
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.
27 #include "xkbcomp-priv.h"
29 #include "parseutils.h"
31 #define ISEMPTY(str) (!(str) || (strlen(str) == 0))
34 keymap_file_from_names(struct xkb_context *ctx,
35 const struct xkb_rule_names *rmlvo)
37 struct xkb_component_names *kkctgs;
38 XkbFile *keycodes, *types, *compat, *symbols;
41 kkctgs = xkb_components_from_rules(ctx, rmlvo);
44 "couldn't look up rules '%s', model '%s', layout '%s', "
45 "variant '%s', options '%s'\n",
46 rmlvo->rules, rmlvo->model, rmlvo->layout, rmlvo->variant,
51 inc = IncludeCreate(ctx, kkctgs->keycodes, MERGE_DEFAULT);
52 keycodes = CreateXKBFile(ctx, FILE_TYPE_KEYCODES, NULL,
53 (ParseCommon *) inc, 0);
55 inc = IncludeCreate(ctx, kkctgs->types, MERGE_DEFAULT);
56 types = CreateXKBFile(ctx, FILE_TYPE_TYPES, NULL,
57 (ParseCommon *) inc, 0);
58 AppendStmt(&keycodes->common, &types->common);
60 inc = IncludeCreate(ctx, kkctgs->compat, MERGE_DEFAULT);
61 compat = CreateXKBFile(ctx, FILE_TYPE_COMPAT, NULL,
62 (ParseCommon *) inc, 0);
63 AppendStmt(&keycodes->common, &compat->common);
65 inc = IncludeCreate(ctx, kkctgs->symbols, MERGE_DEFAULT);
66 symbols = CreateXKBFile(ctx, FILE_TYPE_SYMBOLS, NULL,
67 (ParseCommon *) inc, 0);
68 AppendStmt(&keycodes->common, &symbols->common);
70 free(kkctgs->keycodes);
73 free(kkctgs->symbols);
76 return CreateXKBFile(ctx, FILE_TYPE_KEYMAP, strdup(""),
77 &keycodes->common, 0);
80 static struct xkb_keymap *
81 new_keymap(struct xkb_context *ctx)
83 struct xkb_keymap *keymap;
85 keymap = calloc(1, sizeof(*keymap));
90 keymap->ctx = xkb_context_ref(ctx);
96 * Compile the given file and store the output in keymap.
97 * @param file A list of XkbFiles, each denoting one type (e.g.
98 * FILE_TYPE_KEYCODES, etc.)
100 static struct xkb_keymap *
101 compile_keymap(struct xkb_context *ctx, XkbFile *file)
105 const char *main_name;
106 struct xkb_keymap *keymap;
107 XkbFile *keycodes = NULL;
108 XkbFile *types = NULL;
109 XkbFile *compat = NULL;
110 XkbFile *symbols = NULL;
112 keymap = new_keymap(ctx);
116 main_name = file->name ? file->name : "(unnamed)";
119 * Other aggregate file types are converted to FILE_TYPE_KEYMAP
122 if (file->file_type != FILE_TYPE_KEYMAP) {
123 log_err(ctx, "Cannot compile a %s file alone into a keymap\n",
124 FileTypeText(file->file_type));
128 /* Check for duplicate entries in the input file */
129 for (file = (XkbFile *) file->defs; file;
130 file = (XkbFile *) file->common.next) {
131 if (have & file->file_type) {
133 "More than one %s section in a keymap file; "
134 "All sections after the first ignored\n",
135 FileTypeText(file->file_type));
139 switch (file->file_type) {
140 case FILE_TYPE_KEYCODES:
144 case FILE_TYPE_TYPES:
148 case FILE_TYPE_SYMBOLS:
152 case FILE_TYPE_COMPAT:
157 log_err(ctx, "Cannot define %s in a keymap file\n",
158 FileTypeText(file->file_type));
162 if (!file->topName) {
164 file->topName = strdup(main_name);
167 have |= file->file_type;
170 if (REQUIRED_FILE_TYPES & (~have)) {
171 enum xkb_file_type bit;
172 enum xkb_file_type missing;
174 missing = REQUIRED_FILE_TYPES & (~have);
176 for (bit = 1; missing != 0; bit <<= 1) {
178 log_err(ctx, "Required section %s missing from keymap\n",
187 ok = CompileKeycodes(keycodes, keymap, MERGE_OVERRIDE);
189 log_err(ctx, "Failed to compile keycodes\n");
192 ok = CompileKeyTypes(types, keymap, MERGE_OVERRIDE);
194 log_err(ctx, "Failed to compile key types\n");
197 ok = CompileCompatMap(compat, keymap, MERGE_OVERRIDE);
199 log_err(ctx, "Failed to compile compat map\n");
202 ok = CompileSymbols(symbols, keymap, MERGE_OVERRIDE);
204 log_err(ctx, "Failed to compile symbols\n");
208 ok = UpdateModifiersFromCompat(keymap);
215 log_err(ctx, "Failed to compile keymap\n");
216 xkb_map_unref(keymap);
220 XKB_EXPORT struct xkb_keymap *
221 xkb_map_new_from_names(struct xkb_context *ctx,
222 const struct xkb_rule_names *rmlvo_in,
223 enum xkb_map_compile_flags flags)
225 struct xkb_keymap *keymap = NULL;
226 struct xkb_rule_names rmlvo = *rmlvo_in;
229 if (ISEMPTY(rmlvo.rules))
230 rmlvo.rules = DEFAULT_XKB_RULES;
231 if (ISEMPTY(rmlvo.model))
232 rmlvo.model = DEFAULT_XKB_MODEL;
233 if (ISEMPTY(rmlvo.layout))
234 rmlvo.layout = DEFAULT_XKB_LAYOUT;
236 file = keymap_file_from_names(ctx, &rmlvo);
238 log_err(ctx, "Failed to generate parsed XKB file from components\n");
242 keymap = compile_keymap(ctx, file);
248 XKB_EXPORT struct xkb_keymap *
249 xkb_map_new_from_string(struct xkb_context *ctx,
251 enum xkb_keymap_format format,
252 enum xkb_map_compile_flags flags)
256 struct xkb_keymap *keymap;
258 if (format != XKB_KEYMAP_FORMAT_TEXT_V1) {
259 log_err(ctx, "unsupported keymap format %d\n", format);
264 log_err(ctx, "No string specified to generate XKB keymap\n");
268 ok = XKBParseString(ctx, string, "input", &file);
270 log_err(ctx, "Failed to parse input xkb file\n");
274 keymap = compile_keymap(ctx, file);
279 XKB_EXPORT struct xkb_keymap *
280 xkb_map_new_from_file(struct xkb_context *ctx,
282 enum xkb_keymap_format format,
283 enum xkb_map_compile_flags flags)
287 struct xkb_keymap *keymap;
289 if (format != XKB_KEYMAP_FORMAT_TEXT_V1) {
290 log_err(ctx, "Unsupported keymap format %d\n", format);
295 log_err(ctx, "No file specified to generate XKB keymap\n");
299 ok = XKBParseFile(ctx, file, "(unknown file)", &xkb_file);
301 log_err(ctx, "Failed to parse input xkb file\n");
305 keymap = compile_keymap(ctx, xkb_file);
306 FreeXKBFile(xkb_file);
310 XKB_EXPORT struct xkb_keymap *
311 xkb_map_ref(struct xkb_keymap *keymap)
318 xkb_map_unref(struct xkb_keymap *keymap)
323 if (!keymap || --keymap->refcnt > 0)
326 for (i = 0; i < keymap->num_types; i++) {
327 free(keymap->types[i].map);
328 free(keymap->types[i].level_names);
332 darray_foreach(key, keymap->keys) {
333 free(key->sym_index);
335 darray_free(key->syms);
337 darray_free(keymap->keys);
339 darray_free(keymap->acts);
341 darray_free(keymap->sym_interpret);
343 darray_free(keymap->key_aliases);
345 free(keymap->keycodes_section_name);
346 free(keymap->symbols_section_name);
347 free(keymap->types_section_name);
348 free(keymap->compat_section_name);
350 xkb_context_unref(keymap->ctx);