2 * vim:ts=4:sw=4:expandtab
4 * i3 - an improved dynamic tiling window manager
5 * © 2009-2011 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)
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 static xcb_get_modifier_mapping_reply_t *modmap_reply;
74 static i3Font bold_font;
75 static char *socket_path;
76 static xcb_window_t win;
77 static xcb_pixmap_t pixmap;
78 static xcb_gcontext_t pixmap_gc;
79 static xcb_key_symbols_t *symbols;
83 char *rewrite_binding(const char *bindingline);
87 * This function resolves ~ in pathnames.
88 * It may resolve wildcards in the first part of the path, but if no match
89 * or multiple matches are found, it just returns a copy of path as given.
92 static char *resolve_tilde(const char *path) {
93 static glob_t globbuf;
94 char *head, *tail, *result;
96 tail = strchr(path, '/');
97 head = strndup(path, tail ? tail - path : strlen(path));
99 int res = glob(head, GLOB_TILDE, NULL, &globbuf);
101 /* no match, or many wildcard matches are bad */
102 if (res == GLOB_NOMATCH || globbuf.gl_pathc != 1)
103 result = strdup(path);
105 err(1, "glob() failed");
107 head = globbuf.gl_pathv[0];
108 result = calloc(1, strlen(head) + (tail ? strlen(tail) : 0) + 1);
109 strncpy(result, head, strlen(head));
111 strncat(result, tail, strlen(tail));
119 * Handles expose events, that is, draws the window contents.
122 static int handle_expose() {
123 /* re-draw the background */
124 xcb_rectangle_t border = {0, 0, 300, (15 * font.height) + 8};
125 xcb_change_gc(conn, pixmap_gc, XCB_GC_FOREGROUND, (uint32_t[]){ get_colorpixel("#000000") });
126 xcb_poly_fill_rectangle(conn, pixmap, pixmap_gc, 1, &border);
128 xcb_change_gc(conn, pixmap_gc, XCB_GC_FONT, (uint32_t[]){ font.id });
130 #define txt(x, row, text) xcb_image_text_8(conn, strlen(text), pixmap, pixmap_gc, x, (row * font.height) + 2, text)
132 if (current_step == STEP_WELCOME) {
133 /* restore font color */
134 xcb_change_gc(conn, pixmap_gc, XCB_GC_FOREGROUND, (uint32_t[]){ get_colorpixel("#FFFFFF") });
136 txt(10, 2, "You have not configured i3 yet.");
137 txt(10, 3, "Do you want me to generate ~/.i3/config?");
138 txt(85, 5, "Yes, generate ~/.i3/config");
139 txt(85, 7, "No, I will use the defaults");
142 xcb_change_gc(conn, pixmap_gc, XCB_GC_FOREGROUND, (uint32_t[]){ get_colorpixel("#00FF00") });
143 txt(25, 5, "<Enter>");
146 xcb_change_gc(conn, pixmap_gc, XCB_GC_FOREGROUND, (uint32_t[]){ get_colorpixel("#FF0000") });
150 if (current_step == STEP_GENERATE) {
151 xcb_change_gc(conn, pixmap_gc, XCB_GC_FOREGROUND, (uint32_t[]){ get_colorpixel("#FFFFFF") });
153 txt(10, 2, "Please choose either:");
154 txt(85, 4, "Win as default modifier");
155 txt(85, 5, "Alt as default modifier");
156 txt(10, 7, "Afterwards, press");
157 txt(85, 9, "to write ~/.i3/config");
158 txt(85, 10, "to abort");
160 /* the not-selected modifier */
161 if (modifier == MOD_Mod4)
163 else txt(31, 4, "<Win>");
165 /* the selected modifier */
166 xcb_change_gc(conn, pixmap_gc, XCB_GC_FONT, (uint32_t[]){ bold_font.id });
167 if (modifier == MOD_Mod4)
169 else txt(31, 5, "<Alt>");
172 xcb_change_gc(conn, pixmap_gc, XCB_GC_FOREGROUND | XCB_GC_FONT,
173 (uint32_t[]) { get_colorpixel("#00FF00"), font.id });
175 txt(25, 9, "<Enter>");
178 xcb_change_gc(conn, pixmap_gc, XCB_GC_FOREGROUND, (uint32_t[]){ get_colorpixel("#FF0000") });
179 txt(31, 10, "<ESC>");
182 /* Copy the contents of the pixmap to the real window */
183 xcb_copy_area(conn, pixmap, win, pixmap_gc, 0, 0, 0, 0, /* */ 500, 500);
189 static int handle_key_press(void *ignored, xcb_connection_t *conn, xcb_key_press_event_t *event) {
190 printf("Keypress %d, state raw = %d\n", event->detail, event->state);
192 /* Remove the numlock bit, all other bits are modifiers we can bind to */
193 uint16_t state_filtered = event->state & ~(xcb_numlock_mask | XCB_MOD_MASK_LOCK);
194 /* Only use the lower 8 bits of the state (modifier masks) so that mouse
195 * button masks are filtered out */
196 state_filtered &= 0xFF;
198 xcb_keysym_t sym = xcb_key_press_lookup_keysym(symbols, event, state_filtered);
200 printf("sym = %c (%d)\n", sym, sym);
202 if (sym == XK_Return || sym == XK_KP_Enter) {
203 if (current_step == STEP_WELCOME) {
204 current_step = STEP_GENERATE;
205 /* Set window title */
206 xcb_change_property(conn,
207 XCB_PROP_MODE_REPLACE,
212 strlen("i3: generate config"),
213 "i3: generate config");
219 /* cancel any time */
220 if (sym == XK_Escape)
223 /* Check if this is Mod1 or Mod4. The modmap contains Shift, Lock, Control,
224 * Mod1, Mod2, Mod3, Mod4, Mod5 (in that order) */
225 xcb_keycode_t *modmap = xcb_get_modifier_mapping_keycodes(modmap_reply);
228 for (int i = 0; i < modmap_reply->keycodes_per_modifier; i++) {
229 xcb_keycode_t code = modmap[(mask * modmap_reply->keycodes_per_modifier) + i];
230 if (code == XCB_NONE)
232 printf("Modifier keycode for Mod1: 0x%02x\n", code);
233 if (code == event->detail) {
235 printf("This is Mod1!\n");
241 for (int i = 0; i < modmap_reply->keycodes_per_modifier; i++) {
242 xcb_keycode_t code = modmap[(mask * modmap_reply->keycodes_per_modifier) + i];
243 if (code == XCB_NONE)
245 printf("Modifier keycode for Mod4: 0x%02x\n", code);
246 if (code == event->detail) {
248 printf("This is Mod4!\n");
257 * Handle button presses to make clicking on "<win>" and "<alt>" work
260 static void handle_button_press(xcb_button_press_event_t* event) {
261 if (current_step != STEP_GENERATE)
264 if (event->event_x >= 32 && event->event_x <= 68 &&
265 event->event_y >= 45 && event->event_y <= 54) {
270 if (event->event_x >= 32 && event->event_x <= 68 &&
271 event->event_y >= 56 && event->event_y <= 70) {
280 * Creates the config file and tells i3 to reload.
283 static void finish() {
284 printf("creating \"%s\"...\n", config_path);
286 if (!(dpy = XOpenDisplay(NULL)))
287 errx(1, "Could not connect to X11");
289 FILE *kc_config = fopen(SYSCONFDIR "/i3/config.keycodes", "r");
290 if (kc_config == NULL)
291 err(1, "Could not open input file \"%s\"", SYSCONFDIR "/i3/config.keycodes");
293 FILE *ks_config = fopen(config_path, "w");
294 if (ks_config == NULL)
295 err(1, "Could not open output config file \"%s\"", config_path);
302 bool head_of_file = true;
304 /* write a header about auto-generation to the output file */
305 fputs("# This file has been auto-generated by i3-config-wizard(1).\n", ks_config);
306 fputs("# It will not be overwritten, so edit it as you like.\n", ks_config);
307 fputs("#\n", ks_config);
308 fputs("# Should you change your keyboard layout somewhen, delete\n", ks_config);
309 fputs("# this file and re-run i3-config-wizard(1).\n", ks_config);
310 fputs("#\n", ks_config);
314 while ((buf = fgetln(kc_config, &len)) != NULL) {
315 /* fgetln does not return null-terminated strings */
317 sasprintf(&line, "%.*s", len, buf);
320 while ((read = getline(&line, &linecap, kc_config)) != -1) {
323 /* skip the warning block at the beginning of the input file */
325 strncmp("# WARNING", line, strlen("# WARNING")) == 0)
328 head_of_file = false;
330 /* Skip leading whitespace */
332 while (isspace(*walk) && walk < (line + len))
335 /* Set the modifier the user chose */
336 if (strncmp(walk, "set $mod ", strlen("set $mod ")) == 0) {
337 if (modifier == MOD_Mod1)
338 fputs("set $mod Mod1\n", ks_config);
339 else fputs("set $mod Mod4\n", ks_config);
343 /* Check for 'bindcode'. If it’s not a bindcode line, we
344 * just copy it to the output file */
345 if (strncmp(walk, "bindcode", strlen("bindcode")) != 0) {
346 fputs(line, ks_config);
349 char *result = rewrite_binding(walk);
350 fputs(result, ks_config);
354 /* sync to do our best in order to have the file really stored on disk */
356 fsync(fileno(ks_config));
365 /* tell i3 to reload the config file */
366 int sockfd = ipc_connect(socket_path);
367 ipc_send_message(sockfd, strlen("reload"), 0, (uint8_t*)"reload");
373 int main(int argc, char *argv[]) {
374 config_path = resolve_tilde("~/.i3/config");
375 socket_path = getenv("I3SOCK");
376 char *pattern = "-misc-fixed-medium-r-normal--13-120-75-75-C-70-iso10646-1";
377 char *patternbold = "-misc-fixed-bold-r-normal--13-120-75-75-C-70-iso10646-1";
378 int o, option_index = 0;
380 static struct option long_options[] = {
381 {"socket", required_argument, 0, 's'},
382 {"version", no_argument, 0, 'v'},
383 {"limit", required_argument, 0, 'l'},
384 {"prompt", required_argument, 0, 'P'},
385 {"prefix", required_argument, 0, 'p'},
386 {"font", required_argument, 0, 'f'},
387 {"help", no_argument, 0, 'h'},
391 char *options_string = "s:vh";
393 while ((o = getopt_long(argc, argv, options_string, long_options, &option_index)) != -1) {
397 socket_path = strdup(optarg);
400 printf("i3-config-wizard " I3_VERSION "\n");
403 printf("i3-config-wizard " I3_VERSION "\n");
404 printf("i3-config-wizard [-s <socket>] [-v]\n");
409 /* Check if the destination config file does not exist but the path is
410 * writable. If not, exit now, this program is not useful in that case. */
412 if (stat(config_path, &stbuf) == 0) {
413 printf("The config file \"%s\" already exists. Exiting.\n", config_path);
417 /* Create ~/.i3 if it does not yet exist */
418 char *config_dir = resolve_tilde("~/.i3");
419 if (stat(config_dir, &stbuf) != 0)
420 if (mkdir(config_dir, 0755) == -1)
421 err(1, "mkdir(%s) failed", config_dir);
425 if ((fd = open(config_path, O_CREAT | O_RDWR, 0644)) == -1) {
426 printf("Cannot open file \"%s\" for writing: %s. Exiting.\n", config_path, strerror(errno));
432 if (socket_path == NULL)
433 socket_path = socket_path_from_x11();
435 if (socket_path == NULL)
436 socket_path = "/tmp/i3-ipc.sock";
439 if ((conn = xcb_connect(NULL, &screens)) == NULL ||
440 xcb_connection_has_error(conn))
441 errx(1, "Cannot open display\n");
443 xcb_get_modifier_mapping_cookie_t modmap_cookie;
444 modmap_cookie = xcb_get_modifier_mapping(conn);
445 symbols = xcb_key_symbols_alloc(conn);
447 /* Place requests for the atoms we need as soon as possible */
448 #define xmacro(atom) \
449 xcb_intern_atom_cookie_t atom ## _cookie = xcb_intern_atom(conn, 0, strlen(#atom), #atom);
450 #include "atoms.xmacro"
453 xcb_screen_t *root_screen = xcb_aux_get_screen(conn, screens);
454 root = root_screen->root;
456 if (!(modmap_reply = xcb_get_modifier_mapping_reply(conn, modmap_cookie, NULL)))
457 errx(EXIT_FAILURE, "Could not get modifier mapping\n");
459 xcb_numlock_mask = get_mod_mask_for(XCB_NUM_LOCK, symbols, modmap_reply);
461 font = load_font(pattern, true);
462 bold_font = load_font(patternbold, true);
464 /* Open an input window */
465 win = xcb_generate_id(conn);
468 XCB_COPY_FROM_PARENT,
469 win, /* the window id */
470 root, /* parent == root */
471 490, 297, 300, 205, /* dimensions */
472 0, /* X11 border = 0, we draw our own */
473 XCB_WINDOW_CLASS_INPUT_OUTPUT,
474 XCB_WINDOW_CLASS_COPY_FROM_PARENT, /* copy visual from parent */
475 XCB_CW_BACK_PIXEL | XCB_CW_EVENT_MASK,
477 0, /* back pixel: black */
478 XCB_EVENT_MASK_EXPOSURE |
479 XCB_EVENT_MASK_BUTTON_PRESS
482 /* Map the window (make it visible) */
483 xcb_map_window(conn, win);
485 /* Setup NetWM atoms */
486 #define xmacro(name) \
488 xcb_intern_atom_reply_t *reply = xcb_intern_atom_reply(conn, name ## _cookie, NULL); \
490 errx(EXIT_FAILURE, "Could not get atom " # name "\n"); \
492 A_ ## name = reply->atom; \
495 #include "atoms.xmacro"
499 xcb_change_property(conn,
500 XCB_PROP_MODE_REPLACE,
502 A__NET_WM_WINDOW_TYPE,
506 (unsigned char*) &A__NET_WM_WINDOW_TYPE_DIALOG);
508 /* Set window title */
509 xcb_change_property(conn,
510 XCB_PROP_MODE_REPLACE,
515 strlen("i3: first configuration"),
516 "i3: first configuration");
519 pixmap = xcb_generate_id(conn);
520 pixmap_gc = xcb_generate_id(conn);
521 xcb_create_pixmap(conn, root_screen->root_depth, pixmap, win, 500, 500);
522 xcb_create_gc(conn, pixmap_gc, pixmap, 0, 0);
524 /* Grab the keyboard to get all input */
527 /* Try (repeatedly, if necessary) to grab the keyboard. We might not
528 * get the keyboard at the first attempt because of the keybinding
529 * still being active when started via a wm’s keybinding. */
530 xcb_grab_keyboard_cookie_t cookie;
531 xcb_grab_keyboard_reply_t *reply = NULL;
534 while ((reply == NULL || reply->status != XCB_GRAB_STATUS_SUCCESS) && (count++ < 500)) {
535 cookie = xcb_grab_keyboard(conn, false, win, XCB_CURRENT_TIME, XCB_GRAB_MODE_ASYNC, XCB_GRAB_MODE_ASYNC);
536 reply = xcb_grab_keyboard_reply(conn, cookie, NULL);
540 if (reply->status != XCB_GRAB_STATUS_SUCCESS) {
541 fprintf(stderr, "Could not grab keyboard, status = %d\n", reply->status);
547 xcb_generic_event_t *event;
548 while ((event = xcb_wait_for_event(conn)) != NULL) {
549 if (event->response_type == 0) {
550 fprintf(stderr, "X11 Error received! sequence %x\n", event->sequence);
554 /* Strip off the highest bit (set if the event is generated) */
555 int type = (event->response_type & 0x7F);
559 handle_key_press(NULL, conn, (xcb_key_press_event_t*)event);
562 /* TODO: handle mappingnotify */
564 case XCB_BUTTON_PRESS:
565 handle_button_press((xcb_button_press_event_t*)event);