2 * vim:ts=4:sw=4:expandtab
4 * i3 - an improved dynamic tiling window manager
5 * © 2009-2012 Michael Stapelberg and contributors (see also: LICENSE)
7 * i3-config-wizard: Program to convert configs using keycodes to configs using
11 #if defined(__FreeBSD__)
12 #include <sys/param.h>
15 /* For systems without getline, fall back to fgetln */
16 #if defined(__APPLE__) || (defined(__FreeBSD__) && __FreeBSD_version < 800000) || defined(__OpenBSD__)
18 #elif defined(__FreeBSD__)
19 /* Defining this macro before including stdio.h is necessary in order to have
20 * a prototype for getline in FreeBSD. */
26 #include <sys/types.h>
42 #include <xcb/xcb_aux.h>
43 #include <xcb/xcb_event.h>
44 #include <xcb/xcb_keysyms.h>
47 #include <X11/keysym.h>
49 /* We need SYSCONFDIR for the path to the keycode config template, so raise an
50 * error if it’s not defined for whatever reason */
52 #error "SYSCONFDIR not defined"
55 #define FREE(pointer) do { \
56 if (pointer != NULL) { \
66 enum { STEP_WELCOME, STEP_GENERATE } current_step = STEP_WELCOME;
67 enum { MOD_Mod1, MOD_Mod4 } modifier = MOD_Mod4;
69 static char *config_path;
70 static uint32_t xcb_numlock_mask;
71 xcb_connection_t *conn;
72 xcb_screen_t *root_screen;
73 static xcb_get_modifier_mapping_reply_t *modmap_reply;
75 static i3Font bold_font;
76 static char *socket_path;
77 static xcb_window_t win;
78 static xcb_pixmap_t pixmap;
79 static xcb_gcontext_t pixmap_gc;
80 static xcb_key_symbols_t *symbols;
84 char *rewrite_binding(const char *bindingline);
88 * Having verboselog() and errorlog() is necessary when using libi3.
91 void verboselog(char *fmt, ...) {
95 vfprintf(stdout, fmt, args);
99 void errorlog(char *fmt, ...) {
103 vfprintf(stderr, fmt, args);
108 * This function resolves ~ in pathnames.
109 * It may resolve wildcards in the first part of the path, but if no match
110 * or multiple matches are found, it just returns a copy of path as given.
113 static char *resolve_tilde(const char *path) {
114 static glob_t globbuf;
115 char *head, *tail, *result;
117 tail = strchr(path, '/');
118 head = strndup(path, tail ? tail - path : strlen(path));
120 int res = glob(head, GLOB_TILDE, NULL, &globbuf);
122 /* no match, or many wildcard matches are bad */
123 if (res == GLOB_NOMATCH || globbuf.gl_pathc != 1)
124 result = strdup(path);
126 err(1, "glob() failed");
128 head = globbuf.gl_pathv[0];
129 result = calloc(1, strlen(head) + (tail ? strlen(tail) : 0) + 1);
130 strncpy(result, head, strlen(head));
132 strncat(result, tail, strlen(tail));
140 * Handles expose events, that is, draws the window contents.
143 static int handle_expose() {
144 /* re-draw the background */
145 xcb_rectangle_t border = {0, 0, 300, (15 * font.height) + 8};
146 xcb_change_gc(conn, pixmap_gc, XCB_GC_FOREGROUND, (uint32_t[]){ get_colorpixel("#000000") });
147 xcb_poly_fill_rectangle(conn, pixmap, pixmap_gc, 1, &border);
151 #define txt(x, row, text) \
152 draw_text_ascii(text, pixmap, pixmap_gc,\
153 x, (row - 1) * font.height + 4, 300 - x * 2)
155 if (current_step == STEP_WELCOME) {
156 /* restore font color */
157 set_font_colors(pixmap_gc, get_colorpixel("#FFFFFF"), get_colorpixel("#000000"));
159 txt(10, 2, "You have not configured i3 yet.");
160 txt(10, 3, "Do you want me to generate ~/.i3/config?");
161 txt(85, 5, "Yes, generate ~/.i3/config");
162 txt(85, 7, "No, I will use the defaults");
165 set_font_colors(pixmap_gc, get_colorpixel("#00FF00"), get_colorpixel("#000000"));
166 txt(25, 5, "<Enter>");
169 set_font_colors(pixmap_gc, get_colorpixel("#FF0000"), get_colorpixel("#000000"));
173 if (current_step == STEP_GENERATE) {
174 set_font_colors(pixmap_gc, get_colorpixel("#FFFFFF"), get_colorpixel("#000000"));
176 txt(10, 2, "Please choose either:");
177 txt(85, 4, "Win as default modifier");
178 txt(85, 5, "Alt as default modifier");
179 txt(10, 7, "Afterwards, press");
180 txt(85, 9, "to write ~/.i3/config");
181 txt(85, 10, "to abort");
183 /* the not-selected modifier */
184 if (modifier == MOD_Mod4)
186 else txt(31, 4, "<Win>");
188 /* the selected modifier */
189 set_font(&bold_font);
190 set_font_colors(pixmap_gc, get_colorpixel("#FFFFFF"), get_colorpixel("#000000"));
191 if (modifier == MOD_Mod4)
192 txt(10, 4, "-> <Win>");
193 else txt(10, 5, "-> <Alt>");
197 set_font_colors(pixmap_gc, get_colorpixel("#00FF00"), get_colorpixel("#000000"));
198 txt(25, 9, "<Enter>");
201 set_font_colors(pixmap_gc, get_colorpixel("#FF0000"), get_colorpixel("#000000"));
202 txt(31, 10, "<ESC>");
205 /* Copy the contents of the pixmap to the real window */
206 xcb_copy_area(conn, pixmap, win, pixmap_gc, 0, 0, 0, 0, /* */ 500, 500);
212 static int handle_key_press(void *ignored, xcb_connection_t *conn, xcb_key_press_event_t *event) {
213 printf("Keypress %d, state raw = %d\n", event->detail, event->state);
215 /* Remove the numlock bit, all other bits are modifiers we can bind to */
216 uint16_t state_filtered = event->state & ~(xcb_numlock_mask | XCB_MOD_MASK_LOCK);
217 /* Only use the lower 8 bits of the state (modifier masks) so that mouse
218 * button masks are filtered out */
219 state_filtered &= 0xFF;
221 xcb_keysym_t sym = xcb_key_press_lookup_keysym(symbols, event, state_filtered);
223 printf("sym = %c (%d)\n", sym, sym);
225 if (sym == XK_Return || sym == XK_KP_Enter) {
226 if (current_step == STEP_WELCOME) {
227 current_step = STEP_GENERATE;
228 /* Set window title */
229 xcb_change_property(conn,
230 XCB_PROP_MODE_REPLACE,
235 strlen("i3: generate config"),
236 "i3: generate config");
242 /* cancel any time */
243 if (sym == XK_Escape)
246 /* Check if this is Mod1 or Mod4. The modmap contains Shift, Lock, Control,
247 * Mod1, Mod2, Mod3, Mod4, Mod5 (in that order) */
248 xcb_keycode_t *modmap = xcb_get_modifier_mapping_keycodes(modmap_reply);
251 for (int i = 0; i < modmap_reply->keycodes_per_modifier; i++) {
252 xcb_keycode_t code = modmap[(mask * modmap_reply->keycodes_per_modifier) + i];
253 if (code == XCB_NONE)
255 printf("Modifier keycode for Mod1: 0x%02x\n", code);
256 if (code == event->detail) {
258 printf("This is Mod1!\n");
264 for (int i = 0; i < modmap_reply->keycodes_per_modifier; i++) {
265 xcb_keycode_t code = modmap[(mask * modmap_reply->keycodes_per_modifier) + i];
266 if (code == XCB_NONE)
268 printf("Modifier keycode for Mod4: 0x%02x\n", code);
269 if (code == event->detail) {
271 printf("This is Mod4!\n");
280 * Handle button presses to make clicking on "<win>" and "<alt>" work
283 static void handle_button_press(xcb_button_press_event_t* event) {
284 if (current_step != STEP_GENERATE)
287 if (event->event_x >= 32 && event->event_x <= 68 &&
288 event->event_y >= 45 && event->event_y <= 54) {
293 if (event->event_x >= 32 && event->event_x <= 68 &&
294 event->event_y >= 56 && event->event_y <= 70) {
303 * Creates the config file and tells i3 to reload.
306 static void finish() {
307 printf("creating \"%s\"...\n", config_path);
309 if (!(dpy = XOpenDisplay(NULL)))
310 errx(1, "Could not connect to X11");
312 FILE *kc_config = fopen(SYSCONFDIR "/i3/config.keycodes", "r");
313 if (kc_config == NULL)
314 err(1, "Could not open input file \"%s\"", SYSCONFDIR "/i3/config.keycodes");
316 FILE *ks_config = fopen(config_path, "w");
317 if (ks_config == NULL)
318 err(1, "Could not open output config file \"%s\"", config_path);
326 bool head_of_file = true;
328 /* write a header about auto-generation to the output file */
329 fputs("# This file has been auto-generated by i3-config-wizard(1).\n", ks_config);
330 fputs("# It will not be overwritten, so edit it as you like.\n", ks_config);
331 fputs("#\n", ks_config);
332 fputs("# Should you change your keyboard layout somewhen, delete\n", ks_config);
333 fputs("# this file and re-run i3-config-wizard(1).\n", ks_config);
334 fputs("#\n", ks_config);
338 while ((buf = fgetln(kc_config, &len)) != NULL) {
339 /* fgetln does not return null-terminated strings */
341 sasprintf(&line, "%.*s", len, buf);
344 while ((read = getline(&line, &linecap, kc_config)) != -1) {
347 /* skip the warning block at the beginning of the input file */
349 strncmp("# WARNING", line, strlen("# WARNING")) == 0)
352 head_of_file = false;
354 /* Skip leading whitespace */
356 while (isspace(*walk) && walk < (line + len)) {
357 /* Pre-output the skipped whitespaces to keep proper indentation */
358 fputc(*walk, ks_config);
362 /* Set the modifier the user chose */
363 if (strncmp(walk, "set $mod ", strlen("set $mod ")) == 0) {
364 if (modifier == MOD_Mod1)
365 fputs("set $mod Mod1\n", ks_config);
366 else fputs("set $mod Mod4\n", ks_config);
370 /* Check for 'bindcode'. If it’s not a bindcode line, we
371 * just copy it to the output file */
372 if (strncmp(walk, "bindcode", strlen("bindcode")) != 0) {
373 fputs(walk, ks_config);
376 char *result = rewrite_binding(walk);
377 fputs(result, ks_config);
381 /* sync to do our best in order to have the file really stored on disk */
383 fsync(fileno(ks_config));
392 /* tell i3 to reload the config file */
393 int sockfd = ipc_connect(socket_path);
394 ipc_send_message(sockfd, strlen("reload"), 0, (uint8_t*)"reload");
400 int main(int argc, char *argv[]) {
401 config_path = resolve_tilde("~/.i3/config");
402 socket_path = getenv("I3SOCK");
403 char *pattern = "-misc-fixed-medium-r-normal--13-120-75-75-C-70-iso10646-1";
404 char *patternbold = "-misc-fixed-bold-r-normal--13-120-75-75-C-70-iso10646-1";
405 int o, option_index = 0;
407 static struct option long_options[] = {
408 {"socket", required_argument, 0, 's'},
409 {"version", no_argument, 0, 'v'},
410 {"limit", required_argument, 0, 'l'},
411 {"prompt", required_argument, 0, 'P'},
412 {"prefix", required_argument, 0, 'p'},
413 {"font", required_argument, 0, 'f'},
414 {"help", no_argument, 0, 'h'},
418 char *options_string = "s:vh";
420 while ((o = getopt_long(argc, argv, options_string, long_options, &option_index)) != -1) {
424 socket_path = strdup(optarg);
427 printf("i3-config-wizard " I3_VERSION "\n");
430 printf("i3-config-wizard " I3_VERSION "\n");
431 printf("i3-config-wizard [-s <socket>] [-v]\n");
436 /* Check if the destination config file does not exist but the path is
437 * writable. If not, exit now, this program is not useful in that case. */
439 if (stat(config_path, &stbuf) == 0) {
440 printf("The config file \"%s\" already exists. Exiting.\n", config_path);
444 /* Create ~/.i3 if it does not yet exist */
445 char *config_dir = resolve_tilde("~/.i3");
446 if (stat(config_dir, &stbuf) != 0)
447 if (mkdir(config_dir, 0755) == -1)
448 err(1, "mkdir(%s) failed", config_dir);
452 if ((fd = open(config_path, O_CREAT | O_RDWR, 0644)) == -1) {
453 printf("Cannot open file \"%s\" for writing: %s. Exiting.\n", config_path, strerror(errno));
459 if (socket_path == NULL)
460 socket_path = root_atom_contents("I3_SOCKET_PATH");
462 if (socket_path == NULL)
463 socket_path = "/tmp/i3-ipc.sock";
466 if ((conn = xcb_connect(NULL, &screens)) == NULL ||
467 xcb_connection_has_error(conn))
468 errx(1, "Cannot open display\n");
470 xcb_get_modifier_mapping_cookie_t modmap_cookie;
471 modmap_cookie = xcb_get_modifier_mapping(conn);
472 symbols = xcb_key_symbols_alloc(conn);
474 /* Place requests for the atoms we need as soon as possible */
475 #define xmacro(atom) \
476 xcb_intern_atom_cookie_t atom ## _cookie = xcb_intern_atom(conn, 0, strlen(#atom), #atom);
477 #include "atoms.xmacro"
480 root_screen = xcb_aux_get_screen(conn, screens);
481 root = root_screen->root;
483 if (!(modmap_reply = xcb_get_modifier_mapping_reply(conn, modmap_cookie, NULL)))
484 errx(EXIT_FAILURE, "Could not get modifier mapping\n");
486 xcb_numlock_mask = get_mod_mask_for(XCB_NUM_LOCK, symbols, modmap_reply);
488 font = load_font(pattern, true);
489 bold_font = load_font(patternbold, true);
491 /* Open an input window */
492 win = xcb_generate_id(conn);
495 XCB_COPY_FROM_PARENT,
496 win, /* the window id */
497 root, /* parent == root */
498 490, 297, 300, 205, /* dimensions */
499 0, /* X11 border = 0, we draw our own */
500 XCB_WINDOW_CLASS_INPUT_OUTPUT,
501 XCB_WINDOW_CLASS_COPY_FROM_PARENT, /* copy visual from parent */
502 XCB_CW_BACK_PIXEL | XCB_CW_EVENT_MASK,
504 0, /* back pixel: black */
505 XCB_EVENT_MASK_EXPOSURE |
506 XCB_EVENT_MASK_BUTTON_PRESS
509 /* Map the window (make it visible) */
510 xcb_map_window(conn, win);
512 /* Setup NetWM atoms */
513 #define xmacro(name) \
515 xcb_intern_atom_reply_t *reply = xcb_intern_atom_reply(conn, name ## _cookie, NULL); \
517 errx(EXIT_FAILURE, "Could not get atom " # name "\n"); \
519 A_ ## name = reply->atom; \
522 #include "atoms.xmacro"
526 xcb_change_property(conn,
527 XCB_PROP_MODE_REPLACE,
529 A__NET_WM_WINDOW_TYPE,
533 (unsigned char*) &A__NET_WM_WINDOW_TYPE_DIALOG);
535 /* Set window title */
536 xcb_change_property(conn,
537 XCB_PROP_MODE_REPLACE,
542 strlen("i3: first configuration"),
543 "i3: first configuration");
546 pixmap = xcb_generate_id(conn);
547 pixmap_gc = xcb_generate_id(conn);
548 xcb_create_pixmap(conn, root_screen->root_depth, pixmap, win, 500, 500);
549 xcb_create_gc(conn, pixmap_gc, pixmap, 0, 0);
551 /* Grab the keyboard to get all input */
554 /* Try (repeatedly, if necessary) to grab the keyboard. We might not
555 * get the keyboard at the first attempt because of the keybinding
556 * still being active when started via a wm’s keybinding. */
557 xcb_grab_keyboard_cookie_t cookie;
558 xcb_grab_keyboard_reply_t *reply = NULL;
561 while ((reply == NULL || reply->status != XCB_GRAB_STATUS_SUCCESS) && (count++ < 500)) {
562 cookie = xcb_grab_keyboard(conn, false, win, XCB_CURRENT_TIME, XCB_GRAB_MODE_ASYNC, XCB_GRAB_MODE_ASYNC);
563 reply = xcb_grab_keyboard_reply(conn, cookie, NULL);
567 if (reply->status != XCB_GRAB_STATUS_SUCCESS) {
568 fprintf(stderr, "Could not grab keyboard, status = %d\n", reply->status);
574 xcb_generic_event_t *event;
575 while ((event = xcb_wait_for_event(conn)) != NULL) {
576 if (event->response_type == 0) {
577 fprintf(stderr, "X11 Error received! sequence %x\n", event->sequence);
581 /* Strip off the highest bit (set if the event is generated) */
582 int type = (event->response_type & 0x7F);
586 handle_key_press(NULL, conn, (xcb_key_press_event_t*)event);
589 /* TODO: handle mappingnotify */
591 case XCB_BUTTON_PRESS:
592 handle_button_press((xcb_button_press_event_t*)event);