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(ktcsg->keycodes, MERGE_DEFAULT);
44 keycodes = CreateXKBFile(ctx, FILE_TYPE_KEYCODES, NULL,
45 (ParseCommon *) inc, 0);
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);
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);
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);
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 ERROR("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) {
103 ERROR("More than one %s section in a keymap file\n",
104 XkbcFileTypeText(file->type));
105 ACTION("All sections after the first ignored\n");
109 switch (file->type) {
110 case FILE_TYPE_KEYCODES:
114 case FILE_TYPE_TYPES:
118 case FILE_TYPE_SYMBOLS:
122 case FILE_TYPE_COMPAT:
127 ERROR("Cannot define %s in a keymap file\n",
128 XkbcFileTypeText(file->type));
132 if (!file->topName) {
134 file->topName = strdup(main_name);
140 if (REQUIRED_FILE_TYPES & (~have)) {
141 enum xkb_file_type bit;
142 enum xkb_file_type missing;
144 missing = REQUIRED_FILE_TYPES & (~have);
146 for (bit = 1; missing != 0; bit <<= 1) {
148 ERROR("Required section %s missing from keymap\n",
149 XkbcFileTypeText(bit));
157 ok = CompileKeycodes(keycodes, keymap, MERGE_OVERRIDE);
159 ERROR("Failed to compile keycodes\n");
162 ok = CompileKeyTypes(types, keymap, MERGE_OVERRIDE);
164 ERROR("Failed to compile key types\n");
167 ok = CompileCompatMap(compat, keymap, MERGE_OVERRIDE);
169 ERROR("Failed to compile compat map\n");
172 ok = CompileSymbols(symbols, keymap, MERGE_OVERRIDE);
174 ERROR("Failed to compile symbols\n");
178 ok = UpdateModifiersFromCompat(keymap);
185 ACTION("Failed to compile keymap\n");
186 xkb_map_unref(keymap);
191 xkb_map_new_from_kccgst(struct xkb_context *ctx,
192 const struct xkb_component_names *kccgst,
193 enum xkb_map_compile_flags flags)
196 struct xkb_keymap *keymap;
199 ERROR("No components specified\n");
203 if (ISEMPTY(kccgst->keycodes)) {
204 ERROR("Keycodes required to generate XKB keymap\n");
208 if (ISEMPTY(kccgst->compat)) {
209 ERROR("Compat map required to generate XKB keymap\n");
213 if (ISEMPTY(kccgst->types)) {
214 ERROR("Types required to generate XKB keymap\n");
218 if (ISEMPTY(kccgst->symbols)) {
219 ERROR("Symbols required to generate XKB keymap\n");
223 file = keymap_file_from_components(ctx, kccgst);
225 ERROR("Failed to generate parsed XKB file from components\n");
229 keymap = compile_keymap(ctx, file);
234 XKB_EXPORT struct xkb_keymap *
235 xkb_map_new_from_names(struct xkb_context *ctx,
236 const struct xkb_rule_names *rmlvo,
237 enum xkb_map_compile_flags flags)
239 struct xkb_component_names *kkctgs;
240 struct xkb_keymap *keymap;
242 if (!rmlvo || ISEMPTY(rmlvo->rules) || ISEMPTY(rmlvo->layout)) {
243 ERROR("rules and layout required to generate XKB keymap\n");
247 kkctgs = xkb_components_from_rules(ctx, rmlvo);
249 ERROR("failed to generate XKB components from rules \"%s\"\n",
254 keymap = xkb_map_new_from_kccgst(ctx, kkctgs, 0);
256 free(kkctgs->keycodes);
258 free(kkctgs->compat);
259 free(kkctgs->symbols);
265 XKB_EXPORT struct xkb_keymap *
266 xkb_map_new_from_string(struct xkb_context *ctx,
268 enum xkb_keymap_format format,
269 enum xkb_map_compile_flags flags)
273 struct xkb_keymap *keymap;
275 if (format != XKB_KEYMAP_FORMAT_TEXT_V1) {
276 ERROR("unsupported keymap format %d\n", format);
281 ERROR("No string specified to generate XKB keymap\n");
285 ok = XKBParseString(ctx, string, "input", &file);
287 ERROR("Failed to parse input xkb file\n");
291 keymap = compile_keymap(ctx, file);
296 XKB_EXPORT struct xkb_keymap *
297 xkb_map_new_from_file(struct xkb_context *ctx,
299 enum xkb_keymap_format format,
300 enum xkb_map_compile_flags flags)
304 struct xkb_keymap *keymap;
306 if (format != XKB_KEYMAP_FORMAT_TEXT_V1) {
307 ERROR("Unsupported keymap format %d\n", format);
312 ERROR("No file specified to generate XKB keymap\n");
316 ok = XKBParseFile(ctx, file, "(unknown file)", &xkb_file);
318 ERROR("Failed to parse input xkb file\n");
322 keymap = compile_keymap(ctx, xkb_file);
323 FreeXKBFile(xkb_file);
327 XKB_EXPORT struct xkb_keymap *
328 xkb_map_ref(struct xkb_keymap *keymap)
335 xkb_map_unref(struct xkb_keymap *keymap)
337 if (!keymap || --keymap->refcnt > 0)
340 XkbcFreeKeyboard(keymap);