2 * Copyright © 2018 Red Hat, Inc.
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 (including the next
12 * paragraph) shall be included in all copies or substantial portions of the
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
18 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
21 * DEALINGS IN THE SOFTWARE.
34 #include "xkbcomp/xkbcomp-priv.h"
35 #include "xkbcomp/rules.h"
36 #include "xkbcommon/xkbcommon.h"
38 #define DEFAULT_INCLUDE_PATH_PLACEHOLDER "__defaults__"
40 static bool verbose = false;
41 static enum output_format {
45 FORMAT_KEYMAP_FROM_XKB,
46 } output_format = FORMAT_KEYMAP;
47 static darray(const char *) includes;
52 printf("Usage: %s [OPTIONS]\n"
54 "Compile the given RMLVO to a keymap and print it\n"
58 " Enable verbose debugging output\n"
60 " Print a keymap which only includes the KcCGST component names instead of the full keymap\n"
62 " Print the full RMLVO with the defaults filled in for missing elements\n"
64 " Load the XKB file from stdin, ignore RMLVO options. This option\n"
65 " must not be used with --kccgst.\n"
67 " Add the given path to the include path list. This option is\n"
68 " order-dependent, include paths given first are searched first.\n"
69 " If an include path is given, the default include path list is\n"
70 " not used. Use --include-defaults to add the default include\n"
72 " --include-defaults\n"
73 " Add the default set of include directories.\n"
74 " This option is order-dependent, include paths given first\n"
75 " are searched first.\n"
77 "XKB-specific options:\n"
79 " The XKB ruleset (default: '%s')\n"
81 " The XKB model (default: '%s')\n"
82 " --layout <layout>\n"
83 " The XKB layout (default: '%s')\n"
84 " --variant <variant>\n"
85 " The XKB layout variant (default: '%s')\n"
86 " --options <options>\n"
87 " The XKB options (default: '%s')\n"
89 argv[0], DEFAULT_XKB_RULES,
90 DEFAULT_XKB_MODEL, DEFAULT_XKB_LAYOUT,
91 DEFAULT_XKB_VARIANT ? DEFAULT_XKB_VARIANT : "<none>",
92 DEFAULT_XKB_OPTIONS ? DEFAULT_XKB_OPTIONS : "<none>");
96 parse_options(int argc, char **argv, struct xkb_rule_names *names)
104 OPT_INCLUDE_DEFAULTS,
111 static struct option opts[] = {
112 {"help", no_argument, 0, 'h'},
113 {"verbose", no_argument, 0, OPT_VERBOSE},
114 {"kccgst", no_argument, 0, OPT_KCCGST},
115 {"rmlvo", no_argument, 0, OPT_RMLVO},
116 {"from-xkb", no_argument, 0, OPT_FROM_XKB},
117 {"include", required_argument, 0, OPT_INCLUDE},
118 {"include-defaults", no_argument, 0, OPT_INCLUDE_DEFAULTS},
119 {"rules", required_argument, 0, OPT_RULES},
120 {"model", required_argument, 0, OPT_MODEL},
121 {"layout", required_argument, 0, OPT_LAYOUT},
122 {"variant", required_argument, 0, OPT_VARIANT},
123 {"options", required_argument, 0, OPT_OPTION},
129 int option_index = 0;
130 c = getopt_long(argc, argv, "h", opts, &option_index);
142 output_format = FORMAT_KCCGST;
145 output_format = FORMAT_RMLVO;
148 output_format = FORMAT_KEYMAP_FROM_XKB;
151 darray_append(includes, optarg);
153 case OPT_INCLUDE_DEFAULTS:
154 darray_append(includes, DEFAULT_INCLUDE_PATH_PLACEHOLDER);
157 names->rules = optarg;
160 names->model = optarg;
163 names->layout = optarg;
166 names->variant = optarg;
169 names->options = optarg;
182 print_rmlvo(struct xkb_context *ctx, const struct xkb_rule_names *rmlvo)
184 printf("rules: \"%s\"\nmodel: \"%s\"\nlayout: \"%s\"\nvariant: \"%s\"\noptions: \"%s\"\n",
185 rmlvo->rules, rmlvo->model, rmlvo->layout,
186 rmlvo->variant ? rmlvo->variant : "",
187 rmlvo->options ? rmlvo->options : "");
192 print_kccgst(struct xkb_context *ctx, const struct xkb_rule_names *rmlvo)
194 struct xkb_component_names kccgst;
196 if (!xkb_components_from_rules(ctx, rmlvo, &kccgst))
199 printf("xkb_keymap {\n"
200 " xkb_keycodes { include \"%s\" };\n"
201 " xkb_types { include \"%s\" };\n"
202 " xkb_compat { include \"%s\" };\n"
203 " xkb_symbols { include \"%s\" };\n"
205 kccgst.keycodes, kccgst.types, kccgst.compat, kccgst.symbols);
206 free(kccgst.keycodes);
209 free(kccgst.symbols);
215 print_keymap(struct xkb_context *ctx, const struct xkb_rule_names *rmlvo)
217 struct xkb_keymap *keymap;
219 keymap = xkb_keymap_new_from_names(ctx, rmlvo, XKB_KEYMAP_COMPILE_NO_FLAGS);
223 printf("%s\n", xkb_keymap_get_as_string(keymap,
224 XKB_KEYMAP_FORMAT_TEXT_V1));
225 xkb_keymap_unref(keymap);
230 print_keymap_from_file(struct xkb_context *ctx)
232 struct xkb_keymap *keymap = NULL;
233 char *keymap_string = NULL;
235 bool success = false;
239 fprintf(stderr, "Failed to create tmpfile\n");
247 len = fread(buf, 1, sizeof(buf), stdin);
249 fprintf(stderr, "Failed to read from stdin\n");
253 size_t wlen = fwrite(buf, 1, len, file);
255 fprintf(stderr, "Failed to write to tmpfile\n");
262 fseek(file, 0, SEEK_SET);
263 keymap = xkb_keymap_new_from_file(ctx, file,
264 XKB_KEYMAP_FORMAT_TEXT_V1, 0);
266 fprintf(stderr, "Couldn't create xkb keymap\n");
270 keymap_string = xkb_keymap_get_as_string(keymap, XKB_KEYMAP_FORMAT_TEXT_V1);
271 if (!keymap_string) {
272 fprintf(stderr, "Couldn't get the keymap string\n");
276 fputs(keymap_string, stdout);
282 xkb_keymap_unref(keymap);
289 main(int argc, char **argv)
291 struct xkb_context *ctx;
292 struct xkb_rule_names names = {
307 if (!parse_options(argc, argv, &names))
310 ctx = xkb_context_new(XKB_CONTEXT_NO_DEFAULT_INCLUDES);
314 xkb_context_set_log_level(ctx, XKB_LOG_LEVEL_DEBUG);
315 xkb_context_set_log_verbosity(ctx, 10);
318 xkb_context_sanitize_rule_names(ctx, &names);
319 if (darray_empty(includes))
320 darray_append(includes, DEFAULT_INCLUDE_PATH_PLACEHOLDER);
322 darray_foreach(path, includes) {
323 if (streq(*path, DEFAULT_INCLUDE_PATH_PLACEHOLDER))
324 xkb_context_include_path_append_default(ctx);
326 xkb_context_include_path_append(ctx, *path);
329 if (output_format == FORMAT_RMLVO) {
330 rc = print_rmlvo(ctx, &names) ? EXIT_SUCCESS : EXIT_FAILURE;
331 } else if (output_format == FORMAT_KEYMAP) {
332 rc = print_keymap(ctx, &names) ? EXIT_SUCCESS : EXIT_FAILURE;
333 } else if (output_format == FORMAT_KCCGST) {
334 rc = print_kccgst(ctx, &names) ? EXIT_SUCCESS : EXIT_FAILURE;
335 } else if (output_format == FORMAT_KEYMAP_FROM_XKB) {
336 rc = print_keymap_from_file(ctx);
339 xkb_context_unref(ctx);