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 /* Global warning level */
32 unsigned int warningLevel = 0;
34 #define ISEMPTY(str) (!(str) || (strlen(str) == 0))
37 keymap_file_from_components(struct xkb_context *ctx,
38 const struct xkb_component_names *ktcsg)
40 XkbFile *keycodes, *types, *compat, *symbols;
43 inc = IncludeCreate(ctx, ktcsg->keycodes, MERGE_DEFAULT);
44 keycodes = CreateXKBFile(ctx, FILE_TYPE_KEYCODES, NULL,
45 (ParseCommon *) inc, 0);
47 inc = IncludeCreate(ctx, ktcsg->types, MERGE_DEFAULT);
48 types = CreateXKBFile(ctx, FILE_TYPE_TYPES, NULL,
49 (ParseCommon *) inc, 0);
50 AppendStmt(&keycodes->common, &types->common);
52 inc = IncludeCreate(ctx, ktcsg->compat, MERGE_DEFAULT);
53 compat = CreateXKBFile(ctx, FILE_TYPE_COMPAT, NULL,
54 (ParseCommon *) inc, 0);
55 AppendStmt(&keycodes->common, &compat->common);
57 inc = IncludeCreate(ctx, ktcsg->symbols, MERGE_DEFAULT);
58 symbols = CreateXKBFile(ctx, FILE_TYPE_SYMBOLS, NULL,
59 (ParseCommon *) inc, 0);
60 AppendStmt(&keycodes->common, &symbols->common);
62 return CreateXKBFile(ctx, FILE_TYPE_KEYMAP, strdup(""),
63 &keycodes->common, 0);
67 * Compile the given file and store the output in keymap.
68 * @param file A list of XkbFiles, each denoting one type (e.g.
69 * FILE_TYPE_KEYCODES, etc.)
71 static struct xkb_keymap *
72 compile_keymap(struct xkb_context *ctx, XkbFile *file)
76 const char *main_name;
77 struct xkb_keymap *keymap;
78 XkbFile *keycodes = NULL;
79 XkbFile *types = NULL;
80 XkbFile *compat = NULL;
81 XkbFile *symbols = NULL;
83 keymap = XkbcAllocKeyboard(ctx);
87 main_name = file->name ? file->name : "(unnamed)";
90 * Other aggregate file types are converted to FILE_TYPE_KEYMAP
93 if (file->type != FILE_TYPE_KEYMAP) {
94 log_err(ctx, "Cannot compile a %s file alone into a keymap\n",
95 XkbcFileTypeText(file->type));
99 /* Check for duplicate entries in the input file */
100 for (file = (XkbFile *) file->defs; file;
101 file = (XkbFile *) file->common.next) {
102 if (have & file->type) {
104 "More than one %s section in a keymap file; "
105 "All sections after the first ignored\n",
106 XkbcFileTypeText(file->type));
110 switch (file->type) {
111 case FILE_TYPE_KEYCODES:
115 case FILE_TYPE_TYPES:
119 case FILE_TYPE_SYMBOLS:
123 case FILE_TYPE_COMPAT:
128 log_err(ctx, "Cannot define %s in a keymap file\n",
129 XkbcFileTypeText(file->type));
133 if (!file->topName) {
135 file->topName = strdup(main_name);
141 if (REQUIRED_FILE_TYPES & (~have)) {
142 enum xkb_file_type bit;
143 enum xkb_file_type missing;
145 missing = REQUIRED_FILE_TYPES & (~have);
147 for (bit = 1; missing != 0; bit <<= 1) {
149 log_err(ctx, "Required section %s missing from keymap\n",
150 XkbcFileTypeText(bit));
158 ok = CompileKeycodes(keycodes, keymap, MERGE_OVERRIDE);
160 log_err(ctx, "Failed to compile keycodes\n");
163 ok = CompileKeyTypes(types, keymap, MERGE_OVERRIDE);
165 log_err(ctx, "Failed to compile key types\n");
168 ok = CompileCompatMap(compat, keymap, MERGE_OVERRIDE);
170 log_err(ctx, "Failed to compile compat map\n");
173 ok = CompileSymbols(symbols, keymap, MERGE_OVERRIDE);
175 log_err(ctx, "Failed to compile symbols\n");
179 ok = UpdateModifiersFromCompat(keymap);
186 log_err(ctx, "Failed to compile keymap\n");
187 xkb_map_unref(keymap);
192 xkb_map_new_from_kccgst(struct xkb_context *ctx,
193 const struct xkb_component_names *kccgst,
194 enum xkb_map_compile_flags flags)
197 struct xkb_keymap *keymap;
200 log_err(ctx, "No components specified\n");
204 if (ISEMPTY(kccgst->keycodes)) {
205 log_err(ctx, "Keycodes required to generate XKB keymap\n");
209 if (ISEMPTY(kccgst->compat)) {
210 log_err(ctx, "Compat map required to generate XKB keymap\n");
214 if (ISEMPTY(kccgst->types)) {
215 log_err(ctx, "Types required to generate XKB keymap\n");
219 if (ISEMPTY(kccgst->symbols)) {
220 log_err(ctx, "Symbols required to generate XKB keymap\n");
224 file = keymap_file_from_components(ctx, kccgst);
226 log_err(ctx, "Failed to generate parsed XKB file from components\n");
230 keymap = compile_keymap(ctx, file);
235 XKB_EXPORT struct xkb_keymap *
236 xkb_map_new_from_names(struct xkb_context *ctx,
237 const struct xkb_rule_names *rmlvo,
238 enum xkb_map_compile_flags flags)
240 struct xkb_component_names *kkctgs;
241 struct xkb_keymap *keymap;
243 if (!rmlvo || ISEMPTY(rmlvo->rules) || ISEMPTY(rmlvo->layout)) {
244 log_err(ctx, "rules and layout required to generate XKB keymap\n");
248 kkctgs = xkb_components_from_rules(ctx, rmlvo);
250 log_err(ctx, "failed to generate XKB components from rules \"%s\"\n",
255 keymap = xkb_map_new_from_kccgst(ctx, kkctgs, 0);
257 free(kkctgs->keycodes);
259 free(kkctgs->compat);
260 free(kkctgs->symbols);
266 XKB_EXPORT struct xkb_keymap *
267 xkb_map_new_from_string(struct xkb_context *ctx,
269 enum xkb_keymap_format format,
270 enum xkb_map_compile_flags flags)
274 struct xkb_keymap *keymap;
276 if (format != XKB_KEYMAP_FORMAT_TEXT_V1) {
277 log_err(ctx, "unsupported keymap format %d\n", format);
282 log_err(ctx, "No string specified to generate XKB keymap\n");
286 ok = XKBParseString(ctx, string, "input", &file);
288 log_err(ctx, "Failed to parse input xkb file\n");
292 keymap = compile_keymap(ctx, file);
297 XKB_EXPORT struct xkb_keymap *
298 xkb_map_new_from_file(struct xkb_context *ctx,
300 enum xkb_keymap_format format,
301 enum xkb_map_compile_flags flags)
305 struct xkb_keymap *keymap;
307 if (format != XKB_KEYMAP_FORMAT_TEXT_V1) {
308 log_err(ctx, "Unsupported keymap format %d\n", format);
313 log_err(ctx, "No file specified to generate XKB keymap\n");
317 ok = XKBParseFile(ctx, file, "(unknown file)", &xkb_file);
319 log_err(ctx, "Failed to parse input xkb file\n");
323 keymap = compile_keymap(ctx, xkb_file);
324 FreeXKBFile(xkb_file);
328 XKB_EXPORT struct xkb_keymap *
329 xkb_map_ref(struct xkb_keymap *keymap)
336 xkb_map_unref(struct xkb_keymap *keymap)
338 if (!keymap || --keymap->refcnt > 0)
341 XkbcFreeKeyboard(keymap);