git.sur5r.net Git - i3/i3/blob - i3-config-wizard/main.c

   1 /*
   2  * vim:ts=4:sw=4:expandtab
   3  *
   4  * i3 - an improved dynamic tiling window manager
   5  * © 2009-2012 Michael Stapelberg and contributors (see also: LICENSE)
   6  *
   7  * i3-config-wizard: Program to convert configs using keycodes to configs using
   8  *                   keysyms.
   9  *
  10  */
  11 #if defined(__FreeBSD__)
  12 #include <sys/param.h>
  13 #endif
  14
  15 /* For systems without getline, fall back to fgetln */
  16 #if defined(__APPLE__) || (defined(__FreeBSD__) && __FreeBSD_version < 800000)
  17 #define USE_FGETLN
  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. */
  21 #define _WITH_GETLINE
  22 #endif
  23
  24 #include <ev.h>
  25 #include <stdio.h>
  26 #include <sys/types.h>
  27 #include <stdlib.h>
  28 #include <stdbool.h>
  29 #include <unistd.h>
  30 #include <string.h>
  31 #include <ctype.h>
  32 #include <errno.h>
  33 #include <err.h>
  34 #include <stdint.h>
  35 #include <getopt.h>
  36 #include <limits.h>
  37 #include <sys/stat.h>
  38 #include <fcntl.h>
  39 #include <glob.h>
  40
  41 #include <xcb/xcb.h>
  42 #include <xcb/xcb_aux.h>
  43 #include <xcb/xcb_event.h>
  44 #include <xcb/xcb_keysyms.h>
  45
  46 #include <X11/Xlib.h>
  47 #include <X11/keysym.h>
  48
  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 */
  51 #ifndef SYSCONFDIR
  52 #error "SYSCONFDIR not defined"
  53 #endif
  54
  55 #define FREE(pointer) do { \
  56     if (pointer != NULL) { \
  57         free(pointer); \
  58         pointer = NULL; \
  59     } \
  60 } \
  61 while (0)
  62
  63 #include "xcb.h"
  64 #include "libi3.h"
  65
  66 enum { STEP_WELCOME, STEP_GENERATE } current_step = STEP_WELCOME;
  67 enum { MOD_Mod1, MOD_Mod4 } modifier = MOD_Mod4;
  68
  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;
  73 static i3Font font;
  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;
  80 xcb_window_t root;
  81 Display *dpy;
  82
  83 char *rewrite_binding(const char *bindingline);
  84 static void finish();
  85
  86 /*
  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.
  90  *
  91  */
  92 static char *resolve_tilde(const char *path) {
  93     static glob_t globbuf;
  94     char *head, *tail, *result;
  95
  96     tail = strchr(path, '/');
  97     head = strndup(path, tail ? tail - path : strlen(path));
  98
  99     int res = glob(head, GLOB_TILDE, NULL, &globbuf);
 100     free(head);
 101     /* no match, or many wildcard matches are bad */
 102     if (res == GLOB_NOMATCH || globbuf.gl_pathc != 1)
 103         result = strdup(path);
 104     else if (res != 0) {
 105         err(1, "glob() failed");
 106     } else {
 107         head = globbuf.gl_pathv[0];
 108         result = calloc(1, strlen(head) + (tail ? strlen(tail) : 0) + 1);
 109         strncpy(result, head, strlen(head));
 110         if (tail)
 111             strncat(result, tail, strlen(tail));
 112     }
 113     globfree(&globbuf);
 114
 115     return result;
 116 }
 117
 118 /*
 119  * Handles expose events, that is, draws the window contents.
 120  *
 121  */
 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);
 127
 128     set_font(&font);
 129
 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)
 133
 134     if (current_step == STEP_WELCOME) {
 135         /* restore font color */
 136         set_font_colors(pixmap_gc, get_colorpixel("#FFFFFF"), get_colorpixel("#000000"));
 137
 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");
 142
 143         /* green */
 144         set_font_colors(pixmap_gc, get_colorpixel("#00FF00"), get_colorpixel("#000000"));
 145         txt(25, 5, "<Enter>");
 146
 147         /* red */
 148         set_font_colors(pixmap_gc, get_colorpixel("#FF0000"), get_colorpixel("#000000"));
 149         txt(31, 7, "<ESC>");
 150     }
 151
 152     if (current_step == STEP_GENERATE) {
 153         set_font_colors(pixmap_gc, get_colorpixel("#FFFFFF"), get_colorpixel("#000000"));
 154
 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");
 161
 162         /* the not-selected modifier */
 163         if (modifier == MOD_Mod4)
 164             txt(31, 5, "<Alt>");
 165         else txt(31, 4, "<Win>");
 166
 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>");
 173
 174         /* green */
 175         set_font(&font);
 176         set_font_colors(pixmap_gc, get_colorpixel("#00FF00"), get_colorpixel("#000000"));
 177         txt(25, 9, "<Enter>");
 178
 179         /* red */
 180         set_font_colors(pixmap_gc, get_colorpixel("#FF0000"), get_colorpixel("#000000"));
 181         txt(31, 10, "<ESC>");
 182     }
 183
 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);
 186     xcb_flush(conn);
 187
 188     return 1;
 189 }
 190
 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);
 193
 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;
 199
 200     xcb_keysym_t sym = xcb_key_press_lookup_keysym(symbols, event, state_filtered);
 201
 202     printf("sym = %c (%d)\n", sym, sym);
 203
 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,
 210                 win,
 211                 A__NET_WM_NAME,
 212                 A_UTF8_STRING,
 213                 8,
 214                 strlen("i3: generate config"),
 215                 "i3: generate config");
 216             xcb_flush(conn);
 217         }
 218         else finish();
 219     }
 220
 221     /* cancel any time */
 222     if (sym == XK_Escape)
 223         exit(0);
 224
 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);
 228     /* Mod1? */
 229     int mask = 3;
 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)
 233             continue;
 234         printf("Modifier keycode for Mod1: 0x%02x\n", code);
 235         if (code == event->detail) {
 236             modifier = MOD_Mod1;
 237             printf("This is Mod1!\n");
 238         }
 239     }
 240
 241     /* Mod4? */
 242     mask = 6;
 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)
 246             continue;
 247         printf("Modifier keycode for Mod4: 0x%02x\n", code);
 248         if (code == event->detail) {
 249             modifier = MOD_Mod4;
 250             printf("This is Mod4!\n");
 251         }
 252     }
 253
 254     handle_expose();
 255     return 1;
 256 }
 257
 258 /*
 259  * Handle button presses to make clicking on "<win>" and "<alt>" work
 260  *
 261  */
 262 static void handle_button_press(xcb_button_press_event_t* event) {
 263     if (current_step != STEP_GENERATE)
 264         return;
 265
 266     if (event->event_x >= 32 && event->event_x <= 68 &&
 267         event->event_y >= 45 && event->event_y <= 54) {
 268         modifier = MOD_Mod4;
 269         handle_expose();
 270     }
 271
 272     if (event->event_x >= 32 && event->event_x <= 68 &&
 273         event->event_y >= 56 && event->event_y <= 70) {
 274         modifier = MOD_Mod1;
 275         handle_expose();
 276     }
 277
 278     return;
 279 }
 280
 281 /*
 282  * Creates the config file and tells i3 to reload.
 283  *
 284  */
 285 static void finish() {
 286     printf("creating \"%s\"...\n", config_path);
 287
 288     if (!(dpy = XOpenDisplay(NULL)))
 289         errx(1, "Could not connect to X11");
 290
 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");
 294
 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);
 298
 299     char *line = NULL;
 300     size_t len = 0;
 301 #ifndef USE_FGETLN
 302     ssize_t read;
 303 #endif
 304     bool head_of_file = true;
 305
 306     /* write a header about auto-generation to the output file */
 307     fputs("# This file has been auto-generated by i3-config-wizard(1).\n", ks_config);
 308     fputs("# It will not be overwritten, so edit it as you like.\n", ks_config);
 309     fputs("#\n", ks_config);
 310     fputs("# Should you change your keyboard layout somewhen, delete\n", ks_config);
 311     fputs("# this file and re-run i3-config-wizard(1).\n", ks_config);
 312     fputs("#\n", ks_config);
 313
 314 #ifdef USE_FGETLN
 315     char *buf = NULL;
 316     while ((buf = fgetln(kc_config, &len)) != NULL) {
 317         /* fgetln does not return null-terminated strings */
 318         FREE(line);
 319         sasprintf(&line, "%.*s", len, buf);
 320 #else
 321     size_t linecap = 0;
 322     while ((read = getline(&line, &linecap, kc_config)) != -1) {
 323         len = strlen(line);
 324 #endif
 325         /* skip the warning block at the beginning of the input file */
 326         if (head_of_file &&
 327             strncmp("# WARNING", line, strlen("# WARNING")) == 0)
 328             continue;
 329
 330         head_of_file = false;
 331
 332         /* Skip leading whitespace */
 333         char *walk = line;
 334         while (isspace(*walk) && walk < (line + len))
 335             walk++;
 336
 337         /* Set the modifier the user chose */
 338         if (strncmp(walk, "set $mod ", strlen("set $mod ")) == 0) {
 339             if (modifier == MOD_Mod1)
 340                 fputs("set $mod Mod1\n", ks_config);
 341             else fputs("set $mod Mod4\n", ks_config);
 342             continue;
 343         }
 344
 345         /* Check for 'bindcode'. If it’s not a bindcode line, we
 346          * just copy it to the output file */
 347         if (strncmp(walk, "bindcode", strlen("bindcode")) != 0) {
 348             fputs(line, ks_config);
 349             continue;
 350         }
 351         char *result = rewrite_binding(walk);
 352         fputs(result, ks_config);
 353         free(result);
 354     }
 355
 356     /* sync to do our best in order to have the file really stored on disk */
 357     fflush(ks_config);
 358     fsync(fileno(ks_config));
 359
 360 #ifndef USE_FGETLN
 361     free(line);
 362 #endif
 363
 364     fclose(kc_config);
 365     fclose(ks_config);
 366
 367     /* tell i3 to reload the config file */
 368     int sockfd = ipc_connect(socket_path);
 369     ipc_send_message(sockfd, strlen("reload"), 0, (uint8_t*)"reload");
 370     close(sockfd);
 371
 372     exit(0);
 373 }
 374
 375 int main(int argc, char *argv[]) {
 376     config_path = resolve_tilde("~/.i3/config");
 377     socket_path = getenv("I3SOCK");
 378     char *pattern = "-misc-fixed-medium-r-normal--13-120-75-75-C-70-iso10646-1";
 379     char *patternbold = "-misc-fixed-bold-r-normal--13-120-75-75-C-70-iso10646-1";
 380     int o, option_index = 0;
 381
 382     static struct option long_options[] = {
 383         {"socket", required_argument, 0, 's'},
 384         {"version", no_argument, 0, 'v'},
 385         {"limit", required_argument, 0, 'l'},
 386         {"prompt", required_argument, 0, 'P'},
 387         {"prefix", required_argument, 0, 'p'},
 388         {"font", required_argument, 0, 'f'},
 389         {"help", no_argument, 0, 'h'},
 390         {0, 0, 0, 0}
 391     };
 392
 393     char *options_string = "s:vh";
 394
 395     while ((o = getopt_long(argc, argv, options_string, long_options, &option_index)) != -1) {
 396         switch (o) {
 397             case 's':
 398                 FREE(socket_path);
 399                 socket_path = strdup(optarg);
 400                 break;
 401             case 'v':
 402                 printf("i3-config-wizard " I3_VERSION "\n");
 403                 return 0;
 404             case 'h':
 405                 printf("i3-config-wizard " I3_VERSION "\n");
 406                 printf("i3-config-wizard [-s <socket>] [-v]\n");
 407                 return 0;
 408         }
 409     }
 410
 411     /* Check if the destination config file does not exist but the path is
 412      * writable. If not, exit now, this program is not useful in that case. */
 413     struct stat stbuf;
 414     if (stat(config_path, &stbuf) == 0) {
 415         printf("The config file \"%s\" already exists. Exiting.\n", config_path);
 416         return 0;
 417     }
 418
 419     /* Create ~/.i3 if it does not yet exist */
 420     char *config_dir = resolve_tilde("~/.i3");
 421     if (stat(config_dir, &stbuf) != 0)
 422         if (mkdir(config_dir, 0755) == -1)
 423             err(1, "mkdir(%s) failed", config_dir);
 424     free(config_dir);
 425
 426     int fd;
 427     if ((fd = open(config_path, O_CREAT | O_RDWR, 0644)) == -1) {
 428         printf("Cannot open file \"%s\" for writing: %s. Exiting.\n", config_path, strerror(errno));
 429         return 0;
 430     }
 431     close(fd);
 432     unlink(config_path);
 433
 434     if (socket_path == NULL)
 435         socket_path = root_atom_contents("I3_SOCKET_PATH");
 436
 437     if (socket_path == NULL)
 438         socket_path = "/tmp/i3-ipc.sock";
 439
 440     int screens;
 441     if ((conn = xcb_connect(NULL, &screens)) == NULL ||
 442         xcb_connection_has_error(conn))
 443         errx(1, "Cannot open display\n");
 444
 445     xcb_get_modifier_mapping_cookie_t modmap_cookie;
 446     modmap_cookie = xcb_get_modifier_mapping(conn);
 447     symbols = xcb_key_symbols_alloc(conn);
 448
 449     /* Place requests for the atoms we need as soon as possible */
 450     #define xmacro(atom) \
 451         xcb_intern_atom_cookie_t atom ## _cookie = xcb_intern_atom(conn, 0, strlen(#atom), #atom);
 452     #include "atoms.xmacro"
 453     #undef xmacro
 454
 455     xcb_screen_t *root_screen = xcb_aux_get_screen(conn, screens);
 456     root = root_screen->root;
 457
 458     if (!(modmap_reply = xcb_get_modifier_mapping_reply(conn, modmap_cookie, NULL)))
 459         errx(EXIT_FAILURE, "Could not get modifier mapping\n");
 460
 461     xcb_numlock_mask = get_mod_mask_for(XCB_NUM_LOCK, symbols, modmap_reply);
 462
 463     font = load_font(pattern, true);
 464     bold_font = load_font(patternbold, true);
 465
 466     /* Open an input window */
 467     win = xcb_generate_id(conn);
 468     xcb_create_window(
 469         conn,
 470         XCB_COPY_FROM_PARENT,
 471         win, /* the window id */
 472         root, /* parent == root */
 473         490, 297, 300, 205, /* dimensions */
 474         0, /* X11 border = 0, we draw our own */
 475         XCB_WINDOW_CLASS_INPUT_OUTPUT,
 476         XCB_WINDOW_CLASS_COPY_FROM_PARENT, /* copy visual from parent */
 477         XCB_CW_BACK_PIXEL | XCB_CW_EVENT_MASK,
 478         (uint32_t[]){
 479             0, /* back pixel: black */
 480             XCB_EVENT_MASK_EXPOSURE |
 481             XCB_EVENT_MASK_BUTTON_PRESS
 482         });
 483
 484     /* Map the window (make it visible) */
 485     xcb_map_window(conn, win);
 486
 487     /* Setup NetWM atoms */
 488     #define xmacro(name) \
 489         do { \
 490             xcb_intern_atom_reply_t *reply = xcb_intern_atom_reply(conn, name ## _cookie, NULL); \
 491             if (!reply) \
 492                 errx(EXIT_FAILURE, "Could not get atom " # name "\n"); \
 493             \
 494             A_ ## name = reply->atom; \
 495             free(reply); \
 496         } while (0);
 497     #include "atoms.xmacro"
 498     #undef xmacro
 499
 500     /* Set dock mode */
 501     xcb_change_property(conn,
 502         XCB_PROP_MODE_REPLACE,
 503         win,
 504         A__NET_WM_WINDOW_TYPE,
 505         A_ATOM,
 506         32,
 507         1,
 508         (unsigned char*) &A__NET_WM_WINDOW_TYPE_DIALOG);
 509
 510     /* Set window title */
 511     xcb_change_property(conn,
 512         XCB_PROP_MODE_REPLACE,
 513         win,
 514         A__NET_WM_NAME,
 515         A_UTF8_STRING,
 516         8,
 517         strlen("i3: first configuration"),
 518         "i3: first configuration");
 519
 520     /* Create pixmap */
 521     pixmap = xcb_generate_id(conn);
 522     pixmap_gc = xcb_generate_id(conn);
 523     xcb_create_pixmap(conn, root_screen->root_depth, pixmap, win, 500, 500);
 524     xcb_create_gc(conn, pixmap_gc, pixmap, 0, 0);
 525
 526     /* Grab the keyboard to get all input */
 527     xcb_flush(conn);
 528
 529     /* Try (repeatedly, if necessary) to grab the keyboard. We might not
 530      * get the keyboard at the first attempt because of the keybinding
 531      * still being active when started via a wm’s keybinding. */
 532     xcb_grab_keyboard_cookie_t cookie;
 533     xcb_grab_keyboard_reply_t *reply = NULL;
 534
 535     int count = 0;
 536     while ((reply == NULL || reply->status != XCB_GRAB_STATUS_SUCCESS) && (count++ < 500)) {
 537         cookie = xcb_grab_keyboard(conn, false, win, XCB_CURRENT_TIME, XCB_GRAB_MODE_ASYNC, XCB_GRAB_MODE_ASYNC);
 538         reply = xcb_grab_keyboard_reply(conn, cookie, NULL);
 539         usleep(1000);
 540     }
 541
 542     if (reply->status != XCB_GRAB_STATUS_SUCCESS) {
 543         fprintf(stderr, "Could not grab keyboard, status = %d\n", reply->status);
 544         exit(-1);
 545     }
 546
 547     xcb_flush(conn);
 548
 549     xcb_generic_event_t *event;
 550     while ((event = xcb_wait_for_event(conn)) != NULL) {
 551         if (event->response_type == 0) {
 552             fprintf(stderr, "X11 Error received! sequence %x\n", event->sequence);
 553             continue;
 554         }
 555
 556         /* Strip off the highest bit (set if the event is generated) */
 557         int type = (event->response_type & 0x7F);
 558
 559         switch (type) {
 560             case XCB_KEY_PRESS:
 561                 handle_key_press(NULL, conn, (xcb_key_press_event_t*)event);
 562                 break;
 563
 564             /* TODO: handle mappingnotify */
 565
 566             case XCB_BUTTON_PRESS:
 567                 handle_button_press((xcb_button_press_event_t*)event);
 568                 break;
 569
 570             case XCB_EXPOSE:
 571                 handle_expose();
 572                 break;
 573         }
 574
 575         free(event);
 576     }
 577
 578     return 0;
 579 }