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.
31 #include <X11/extensions/XKM.h>
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 : "",
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 static XkbRF_RulesPtr loaded = NULL;
82 static char *cached_name = NULL;
83 struct xkb_component_names * names = NULL;
85 if (!cached_name || strcmp(rules, cached_name) != 0) {
87 XkbcRF_Free(loaded, True);
94 rulesFile = XkbFindFileInPath((char *)rules, XkmRulesFile, &rulesPath);
96 ERROR("could not find \"%s\" rules in XKB path\n", rules);
100 if (!(loaded = _XkbTypedCalloc(1, XkbRF_RulesRec))) {
101 ERROR("failed to allocate XKB rules\n");
105 if (!XkbcRF_LoadRules(rulesFile, loaded)) {
106 ERROR("failed to load XKB rules \"%s\"\n", rulesPath);
110 cached_name = strdup(rules);
113 if (!(names = _XkbTypedCalloc(1, struct xkb_component_names))) {
114 ERROR("failed to allocate XKB components\n");
118 if (!XkbcRF_GetComponents(loaded, defs, names)) {
120 free(names->keycodes);
123 free(names->symbols);
124 free(names->geometry);
127 ERROR("no components returned from XKB rules \"%s\"\n", rulesPath);
139 xkb_compile_keymap_from_rules(const XkbRMLVOSet *rmlvo)
141 XkbRF_VarDefsRec defs;
142 struct xkb_component_names * names;
143 struct xkb_desc * xkb;
145 if (!rmlvo || ISEMPTY(rmlvo->rules) || ISEMPTY(rmlvo->layout)) {
146 ERROR("rules and layout required to generate XKB keymap\n");
150 defs.model = rmlvo->model;
151 defs.layout = rmlvo->layout;
152 defs.variant = rmlvo->variant;
153 defs.options = rmlvo->options;
155 names = XkbComponentsFromRules(rmlvo->rules, &defs);
157 ERROR("failed to generate XKB components from rules \"%s\"\n",
162 xkb = xkb_compile_keymap_from_components(names);
165 free(names->keycodes);
168 free(names->symbols);
169 free(names->geometry);
176 XkbChooseMap(XkbFile *file, const char *name)
183 if (map->name && strcmp(map->name, name) == 0)
185 map = (XkbFile *) map->common.next;
189 ERROR("no map named \"%s\" in input file\n", name);
191 else if (file->common.next) {
192 /* look for map with XkbLC_Default flag. */
193 for (; map; map = (XkbFile *) map->common.next) {
194 if (map->flags & XkbLC_Default)
200 WARN("no map specified, but components have several\n");
201 WARN("using the first defined map, \"%s\"\n",
202 map->name ? map->name : "");
210 xkb_compile_keymap_from_components(const struct xkb_component_names * ktcsg)
212 XkbFile *file, *mapToUse;
213 struct xkb_desc * xkb;
217 if (!ktcsg || ISEMPTY(ktcsg->keycodes)) {
218 ERROR("keycodes required to generate XKB keymap\n");
222 if (!(file = XkbKeymapFileFromComponents(ktcsg))) {
223 ERROR("failed to generate parsed XKB file from components\n");
227 /* Find map to use */
228 if (!(mapToUse = XkbChooseMap(file, NULL)))
231 /* Compile the keyboard */
232 if (!(xkb = XkbcAllocKeyboard())) {
233 ERROR("could not allocate keyboard description\n");
237 if (!CompileKeymap(mapToUse, xkb, MergeReplace)) {
238 ERROR("failed to compile keymap\n");
244 XkbcFreeKeyboard(xkb, XkbAllComponentsMask, True);
246 /* XXX: here's where we would free the XkbFile */
252 xkb_compile_keymap_from_file(FILE *inputFile, const char *mapName)
254 XkbFile *file, *mapToUse;
255 struct xkb_desc * xkb;
258 ERROR("no file specified to generate XKB keymap\n");
262 setScanState("input", 1);
263 if (!XKBParseFile(inputFile, &file) || !file) {
264 ERROR("failed to parse input xkb file\n");
268 /* Find map to use */
269 if (!(mapToUse = XkbChooseMap(file, mapName)))
272 switch (mapToUse->type) {
273 case XkmSemanticsFile:
278 ERROR("file type %d not handled\n", mapToUse->type);
282 /* Compile the keyboard */
283 if (!(xkb = XkbcAllocKeyboard())) {
284 ERROR("could not allocate keyboard description\n");
288 if (!CompileKeymap(mapToUse, xkb, MergeReplace)) {
289 ERROR("failed to compile keymap\n");
295 XkbcFreeKeyboard(xkb, XkbAllComponentsMask, True);
297 /* XXX: here's where we would free the XkbFile */