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.
33 #include "parseutils.h"
36 /* Global debugging flags */
37 unsigned int debugFlags = 0;
38 unsigned int warningLevel = 0;
40 #define ISEMPTY(str) (!(str) || (strlen(str) == 0))
43 XkbKeymapFileFromComponents(const struct xkb_component_names * ktcsg)
45 XkbFile *keycodes, *types, *compat, *symbols, *geometry;
49 ERROR("no components to generate keymap file from\n");
53 inc = IncludeCreate(ktcsg->keycodes, MergeDefault);
54 keycodes = CreateXKBFile(XkmKeyNamesIndex, NULL, (ParseCommon *)inc, 0);
56 inc = IncludeCreate(ktcsg->types, MergeDefault);
57 types = CreateXKBFile(XkmTypesIndex, NULL, (ParseCommon *)inc, 0);
58 AppendStmt(&keycodes->common, &types->common);
60 inc = IncludeCreate(ktcsg->compat, MergeDefault);
61 compat = CreateXKBFile(XkmCompatMapIndex, NULL, (ParseCommon *)inc, 0);
62 AppendStmt(&keycodes->common, &compat->common);
64 inc = IncludeCreate(ktcsg->symbols, MergeDefault);
65 symbols = CreateXKBFile(XkmSymbolsIndex, NULL, (ParseCommon *)inc, 0);
66 AppendStmt(&keycodes->common, &symbols->common);
68 inc = IncludeCreate(ktcsg->geometry, MergeDefault);
69 geometry = CreateXKBFile(XkmGeometryIndex, NULL, (ParseCommon *)inc, 0);
70 AppendStmt(&keycodes->common, &geometry->common);
72 return CreateXKBFile(XkmKeymapFile, ktcsg->keymap ? ktcsg->keymap : strdup(""),
73 &keycodes->common, 0);
76 static struct xkb_component_names *
77 XkbComponentsFromRules(const char *rules, const XkbRF_VarDefsPtr defs)
79 FILE *rulesFile = NULL;
80 char *rulesPath = NULL;
81 XkbRF_RulesPtr loaded = NULL;
82 struct xkb_component_names * names = NULL;
84 rulesFile = XkbFindFileInPath(rules, XkmRulesFile, &rulesPath);
86 ERROR("could not find \"%s\" rules in XKB path\n", rules);
90 if (!(loaded = _XkbTypedCalloc(1, XkbRF_RulesRec))) {
91 ERROR("failed to allocate XKB rules\n");
95 if (!XkbcRF_LoadRules(rulesFile, loaded)) {
96 ERROR("failed to load XKB rules \"%s\"\n", rulesPath);
100 if (!(names = _XkbTypedCalloc(1, struct xkb_component_names))) {
101 ERROR("failed to allocate XKB components\n");
105 if (!XkbcRF_GetComponents(loaded, defs, names)) {
107 free(names->keycodes);
110 free(names->symbols);
111 free(names->geometry);
114 ERROR("no components returned from XKB rules \"%s\"\n", rulesPath);
126 xkb_compile_keymap_from_rules(const struct xkb_rule_names *rmlvo)
128 XkbRF_VarDefsRec defs;
129 struct xkb_component_names * names;
130 struct xkb_desc * xkb;
132 if (!rmlvo || ISEMPTY(rmlvo->rules) || ISEMPTY(rmlvo->layout)) {
133 ERROR("rules and layout required to generate XKB keymap\n");
137 defs.model = rmlvo->model;
138 defs.layout = rmlvo->layout;
139 defs.variant = rmlvo->variant;
140 defs.options = rmlvo->options;
142 names = XkbComponentsFromRules(rmlvo->rules, &defs);
144 ERROR("failed to generate XKB components from rules \"%s\"\n",
149 xkb = xkb_compile_keymap_from_components(names);
152 free(names->keycodes);
155 free(names->symbols);
156 free(names->geometry);
163 XkbChooseMap(XkbFile *file, const char *name)
170 if (map->name && strcmp(map->name, name) == 0)
172 map = (XkbFile *) map->common.next;
176 ERROR("no map named \"%s\" in input file\n", name);
178 else if (file->common.next) {
179 /* look for map with XkbLC_Default flag. */
180 for (; map; map = (XkbFile *) map->common.next) {
181 if (map->flags & XkbLC_Default)
187 WARN("no map specified, but components have several\n");
188 WARN("using the first defined map, \"%s\"\n",
189 map->name ? map->name : "");
197 xkb_compile_keymap_from_components(const struct xkb_component_names * ktcsg)
199 XkbFile *file, *mapToUse;
200 struct xkb_desc * xkb = NULL;
204 if (!ktcsg || ISEMPTY(ktcsg->keycodes)) {
205 ERROR("keycodes required to generate XKB keymap\n");
209 if (!(file = XkbKeymapFileFromComponents(ktcsg))) {
210 ERROR("failed to generate parsed XKB file from components\n");
214 /* Find map to use */
215 if (!(mapToUse = XkbChooseMap(file, NULL)))
218 /* Compile the keyboard */
219 if (!(xkb = XkbcAllocKeyboard())) {
220 ERROR("could not allocate keyboard description\n");
224 if (!CompileKeymap(mapToUse, xkb, MergeReplace)) {
225 ERROR("failed to compile keymap\n");
226 XkbcFreeKeyboard(xkb);
233 XkbFreeIncludePath();
238 static struct xkb_desc *
239 compile_keymap(XkbFile *file, const char *mapName)
242 struct xkb_desc * xkb = NULL;
244 /* Find map to use */
245 if (!(mapToUse = XkbChooseMap(file, mapName)))
248 switch (mapToUse->type) {
249 case XkmSemanticsFile:
254 ERROR("file type %d not handled\n", mapToUse->type);
258 /* Compile the keyboard */
259 if (!(xkb = XkbcAllocKeyboard())) {
260 ERROR("could not allocate keyboard description\n");
264 if (!CompileKeymap(mapToUse, xkb, MergeReplace)) {
265 ERROR("failed to compile keymap\n");
266 XkbcFreeKeyboard(xkb);
273 XkbFreeIncludePath();
278 xkb_compile_keymap_from_string(const char *string, const char *mapName)
283 ERROR("no string specified to generate XKB keymap\n");
287 setScanState("input", 1);
288 if (!XKBParseString(string, &file) || !file) {
289 ERROR("failed to parse input xkb file\n");
293 return compile_keymap(file, mapName);
297 xkb_compile_keymap_from_file(FILE *inputFile, const char *mapName)
302 ERROR("no file specified to generate XKB keymap\n");
306 setScanState("input", 1);
307 if (!XKBParseFile(inputFile, &file) || !file) {
308 ERROR("failed to parse input xkb file\n");
312 return compile_keymap(file, mapName);
316 xkb_free_keymap(struct xkb_desc *xkb)
318 XkbcFreeKeyboard(xkb);