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 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);
130 #define txt(x, row, text) \
131 draw_text(text, strlen(text), false, pixmap, pixmap_gc,\
132 x, (row - 1) * font.height + 4, 300 - x * 2)
134 if (current_step == STEP_WELCOME) {
135 /* restore font color */
136 set_font_colors(pixmap_gc, get_colorpixel("#FFFFFF"), get_colorpixel("#000000"));
138 txt(10, 2, "You have not configured i3 yet.");
139 txt(10, 3, "Do you want me to generate ~/.i3/config?");
140 txt(85, 5, "Yes, generate ~/.i3/config");
141 txt(85, 7, "No, I will use the defaults");
144 set_font_colors(pixmap_gc, get_colorpixel("#00FF00"), get_colorpixel("#000000"));
145 txt(25, 5, "<Enter>");
148 set_font_colors(pixmap_gc, get_colorpixel("#FF0000"), get_colorpixel("#000000"));
152 if (current_step == STEP_GENERATE) {
153 set_font_colors(pixmap_gc, get_colorpixel("#FFFFFF"), get_colorpixel("#000000"));
155 txt(10, 2, "Please choose either:");
156 txt(85, 4, "Win as default modifier");
157 txt(85, 5, "Alt as default modifier");
158 txt(10, 7, "Afterwards, press");
159 txt(85, 9, "to write ~/.i3/config");
160 txt(85, 10, "to abort");
162 /* the not-selected modifier */
163 if (modifier == MOD_Mod4)
165 else txt(31, 4, "<Win>");
167 /* the selected modifier */
168 set_font(&bold_font);
169 set_font_colors(pixmap_gc, get_colorpixel("#FFFFFF"), get_colorpixel("#000000"));
170 if (modifier == MOD_Mod4)
171 txt(10, 4, "-> <Win>");
172 else txt(10, 5, "-> <Alt>");
176 set_font_colors(pixmap_gc, get_colorpixel("#00FF00"), get_colorpixel("#000000"));
177 txt(25, 9, "<Enter>");
180 set_font_colors(pixmap_gc, get_colorpixel("#FF0000"), get_colorpixel("#000000"));
181 txt(31, 10, "<ESC>");
184 /* Copy the contents of the pixmap to the real window */
185 xcb_copy_area(conn, pixmap, win, pixmap_gc, 0, 0, 0, 0, /* */ 500, 500);
191 static int handle_key_press(void *ignored, xcb_connection_t *conn, xcb_key_press_event_t *event) {
192 printf("Keypress %d, state raw = %d\n", event->detail, event->state);
194 /* Remove the numlock bit, all other bits are modifiers we can bind to */
195 uint16_t state_filtered = event->state & ~(xcb_numlock_mask | XCB_MOD_MASK_LOCK);
196 /* Only use the lower 8 bits of the state (modifier masks) so that mouse
197 * button masks are filtered out */
198 state_filtered &= 0xFF;
200 xcb_keysym_t sym = xcb_key_press_lookup_keysym(symbols, event, state_filtered);
202 printf("sym = %c (%d)\n", sym, sym);
204 if (sym == XK_Return || sym == XK_KP_Enter) {
205 if (current_step == STEP_WELCOME) {
206 current_step = STEP_GENERATE;
207 /* Set window title */
208 xcb_change_property(conn,
209 XCB_PROP_MODE_REPLACE,
214 strlen("i3: generate config"),
215 "i3: generate config");
221 /* cancel any time */
222 if (sym == XK_Escape)
225 /* Check if this is Mod1 or Mod4. The modmap contains Shift, Lock, Control,
226 * Mod1, Mod2, Mod3, Mod4, Mod5 (in that order) */
227 xcb_keycode_t *modmap = xcb_get_modifier_mapping_keycodes(modmap_reply);
230 for (int i = 0; i < modmap_reply->keycodes_per_modifier; i++) {
231 xcb_keycode_t code = modmap[(mask * modmap_reply->keycodes_per_modifier) + i];
232 if (code == XCB_NONE)
234 printf("Modifier keycode for Mod1: 0x%02x\n", code);
235 if (code == event->detail) {
237 printf("This is Mod1!\n");
243 for (int i = 0; i < modmap_reply->keycodes_per_modifier; i++) {
244 xcb_keycode_t code = modmap[(mask * modmap_reply->keycodes_per_modifier) + i];
245 if (code == XCB_NONE)
247 printf("Modifier keycode for Mod4: 0x%02x\n", code);
248 if (code == event->detail) {
250 printf("This is Mod4!\n");
259 * Handle button presses to make clicking on "<win>" and "<alt>" work
262 static void handle_button_press(xcb_button_press_event_t* event) {
263 if (current_step != STEP_GENERATE)
266 if (event->event_x >= 32 && event->event_x <= 68 &&
267 event->event_y >= 45 && event->event_y <= 54) {
272 if (event->event_x >= 32 && event->event_x <= 68 &&
273 event->event_y >= 56 && event->event_y <= 70) {
282 * Creates the config file and tells i3 to reload.
285 static void finish() {
286 printf("creating \"%s\"...\n", config_path);
288 if (!(dpy = XOpenDisplay(NULL)))
289 errx(1, "Could not connect to X11");
291 FILE *kc_config = fopen(SYSCONFDIR "/i3/config.keycodes", "r");
292 if (kc_config == NULL)
293 err(1, "Could not open input file \"%s\"", SYSCONFDIR "/i3/config.keycodes");
295 FILE *ks_config = fopen(config_path, "w");
296 if (ks_config == NULL)
297 err(1, "Could not open output config file \"%s\"", config_path);
305 bool head_of_file = true;
307 /* write a header about auto-generation to the output file */
308 fputs("# This file has been auto-generated by i3-config-wizard(1).\n", ks_config);
309 fputs("# It will not be overwritten, so edit it as you like.\n", ks_config);
310 fputs("#\n", ks_config);
311 fputs("# Should you change your keyboard layout somewhen, delete\n", ks_config);
312 fputs("# this file and re-run i3-config-wizard(1).\n", ks_config);
313 fputs("#\n", ks_config);
317 while ((buf = fgetln(kc_config, &len)) != NULL) {
318 /* fgetln does not return null-terminated strings */
320 sasprintf(&line, "%.*s", len, buf);
323 while ((read = getline(&line, &linecap, kc_config)) != -1) {
326 /* skip the warning block at the beginning of the input file */
328 strncmp("# WARNING", line, strlen("# WARNING")) == 0)
331 head_of_file = false;
333 /* Skip leading whitespace */
335 while (isspace(*walk) && walk < (line + len)) {
336 /* Pre-output the skipped whitespaces to keep proper indentation */
337 fputc(*walk, ks_config);
341 /* Set the modifier the user chose */
342 if (strncmp(walk, "set $mod ", strlen("set $mod ")) == 0) {
343 if (modifier == MOD_Mod1)
344 fputs("set $mod Mod1\n", ks_config);
345 else fputs("set $mod Mod4\n", ks_config);
349 /* Check for 'bindcode'. If it’s not a bindcode line, we
350 * just copy it to the output file */
351 if (strncmp(walk, "bindcode", strlen("bindcode")) != 0) {
352 fputs(walk, ks_config);
355 char *result = rewrite_binding(walk);
356 fputs(result, ks_config);
360 /* sync to do our best in order to have the file really stored on disk */
362 fsync(fileno(ks_config));
371 /* tell i3 to reload the config file */
372 int sockfd = ipc_connect(socket_path);
373 ipc_send_message(sockfd, strlen("reload"), 0, (uint8_t*)"reload");
379 int main(int argc, char *argv[]) {
380 config_path = resolve_tilde("~/.i3/config");
381 socket_path = getenv("I3SOCK");
382 char *pattern = "-misc-fixed-medium-r-normal--13-120-75-75-C-70-iso10646-1";
383 char *patternbold = "-misc-fixed-bold-r-normal--13-120-75-75-C-70-iso10646-1";
384 int o, option_index = 0;
386 static struct option long_options[] = {
387 {"socket", required_argument, 0, 's'},
388 {"version", no_argument, 0, 'v'},
389 {"limit", required_argument, 0, 'l'},
390 {"prompt", required_argument, 0, 'P'},
391 {"prefix", required_argument, 0, 'p'},
392 {"font", required_argument, 0, 'f'},
393 {"help", no_argument, 0, 'h'},
397 char *options_string = "s:vh";
399 while ((o = getopt_long(argc, argv, options_string, long_options, &option_index)) != -1) {
403 socket_path = strdup(optarg);
406 printf("i3-config-wizard " I3_VERSION "\n");
409 printf("i3-config-wizard " I3_VERSION "\n");
410 printf("i3-config-wizard [-s <socket>] [-v]\n");
415 /* Check if the destination config file does not exist but the path is
416 * writable. If not, exit now, this program is not useful in that case. */
418 if (stat(config_path, &stbuf) == 0) {
419 printf("The config file \"%s\" already exists. Exiting.\n", config_path);
423 /* Create ~/.i3 if it does not yet exist */
424 char *config_dir = resolve_tilde("~/.i3");
425 if (stat(config_dir, &stbuf) != 0)
426 if (mkdir(config_dir, 0755) == -1)
427 err(1, "mkdir(%s) failed", config_dir);
431 if ((fd = open(config_path, O_CREAT | O_RDWR, 0644)) == -1) {
432 printf("Cannot open file \"%s\" for writing: %s. Exiting.\n", config_path, strerror(errno));
438 if (socket_path == NULL)
439 socket_path = root_atom_contents("I3_SOCKET_PATH");
441 if (socket_path == NULL)
442 socket_path = "/tmp/i3-ipc.sock";
445 if ((conn = xcb_connect(NULL, &screens)) == NULL ||
446 xcb_connection_has_error(conn))
447 errx(1, "Cannot open display\n");
449 xcb_get_modifier_mapping_cookie_t modmap_cookie;
450 modmap_cookie = xcb_get_modifier_mapping(conn);
451 symbols = xcb_key_symbols_alloc(conn);
453 /* Place requests for the atoms we need as soon as possible */
454 #define xmacro(atom) \
455 xcb_intern_atom_cookie_t atom ## _cookie = xcb_intern_atom(conn, 0, strlen(#atom), #atom);
456 #include "atoms.xmacro"
459 xcb_screen_t *root_screen = xcb_aux_get_screen(conn, screens);
460 root = root_screen->root;
462 if (!(modmap_reply = xcb_get_modifier_mapping_reply(conn, modmap_cookie, NULL)))
463 errx(EXIT_FAILURE, "Could not get modifier mapping\n");
465 xcb_numlock_mask = get_mod_mask_for(XCB_NUM_LOCK, symbols, modmap_reply);
467 font = load_font(pattern, true);
468 bold_font = load_font(patternbold, true);
470 /* Open an input window */
471 win = xcb_generate_id(conn);
474 XCB_COPY_FROM_PARENT,
475 win, /* the window id */
476 root, /* parent == root */
477 490, 297, 300, 205, /* dimensions */
478 0, /* X11 border = 0, we draw our own */
479 XCB_WINDOW_CLASS_INPUT_OUTPUT,
480 XCB_WINDOW_CLASS_COPY_FROM_PARENT, /* copy visual from parent */
481 XCB_CW_BACK_PIXEL | XCB_CW_EVENT_MASK,
483 0, /* back pixel: black */
484 XCB_EVENT_MASK_EXPOSURE |
485 XCB_EVENT_MASK_BUTTON_PRESS
488 /* Map the window (make it visible) */
489 xcb_map_window(conn, win);
491 /* Setup NetWM atoms */
492 #define xmacro(name) \
494 xcb_intern_atom_reply_t *reply = xcb_intern_atom_reply(conn, name ## _cookie, NULL); \
496 errx(EXIT_FAILURE, "Could not get atom " # name "\n"); \
498 A_ ## name = reply->atom; \
501 #include "atoms.xmacro"
505 xcb_change_property(conn,
506 XCB_PROP_MODE_REPLACE,
508 A__NET_WM_WINDOW_TYPE,
512 (unsigned char*) &A__NET_WM_WINDOW_TYPE_DIALOG);
514 /* Set window title */
515 xcb_change_property(conn,
516 XCB_PROP_MODE_REPLACE,
521 strlen("i3: first configuration"),
522 "i3: first configuration");
525 pixmap = xcb_generate_id(conn);
526 pixmap_gc = xcb_generate_id(conn);
527 xcb_create_pixmap(conn, root_screen->root_depth, pixmap, win, 500, 500);
528 xcb_create_gc(conn, pixmap_gc, pixmap, 0, 0);
530 /* Grab the keyboard to get all input */
533 /* Try (repeatedly, if necessary) to grab the keyboard. We might not
534 * get the keyboard at the first attempt because of the keybinding
535 * still being active when started via a wm’s keybinding. */
536 xcb_grab_keyboard_cookie_t cookie;
537 xcb_grab_keyboard_reply_t *reply = NULL;
540 while ((reply == NULL || reply->status != XCB_GRAB_STATUS_SUCCESS) && (count++ < 500)) {
541 cookie = xcb_grab_keyboard(conn, false, win, XCB_CURRENT_TIME, XCB_GRAB_MODE_ASYNC, XCB_GRAB_MODE_ASYNC);
542 reply = xcb_grab_keyboard_reply(conn, cookie, NULL);
546 if (reply->status != XCB_GRAB_STATUS_SUCCESS) {
547 fprintf(stderr, "Could not grab keyboard, status = %d\n", reply->status);
553 xcb_generic_event_t *event;
554 while ((event = xcb_wait_for_event(conn)) != NULL) {
555 if (event->response_type == 0) {
556 fprintf(stderr, "X11 Error received! sequence %x\n", event->sequence);
560 /* Strip off the highest bit (set if the event is generated) */
561 int type = (event->response_type & 0x7F);
565 handle_key_press(NULL, conn, (xcb_key_press_event_t*)event);
568 /* TODO: handle mappingnotify */
570 case XCB_BUTTON_PRESS:
571 handle_button_press((xcb_button_press_event_t*)event);