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  *
   6  * © 2011 Michael Stapelberg and contributors
   7  *
   8  * See file LICENSE for license information.
   9  *
  10  * i3-config-wizard: Program to convert configs using keycodes to configs using
  11  * keysyms.
  12  *
  13  */
  14 #include <ev.h>
  15 #include <stdio.h>
  16 #include <sys/types.h>
  17 #include <stdlib.h>
  18 #include <stdbool.h>
  19 #include <unistd.h>
  20 #include <string.h>
  21 #include <ctype.h>
  22 #include <errno.h>
  23 #include <err.h>
  24 #include <stdint.h>
  25 #include <getopt.h>
  26 #include <limits.h>
  27 #include <sys/stat.h>
  28 #include <fcntl.h>
  29 #include <glob.h>
  30
  31 #include <xcb/xcb.h>
  32 #include <xcb/xcb_aux.h>
  33 #include <xcb/xcb_event.h>
  34 #include <xcb/xcb_keysyms.h>
  35
  36 #include <X11/Xlib.h>
  37 #include <X11/keysym.h>
  38
  39 /* We need SYSCONFDIR for the path to the keycode config template, so raise an
  40  * error if it’s not defined for whatever reason */
  41 #ifndef SYSCONFDIR
  42 #error "SYSCONFDIR not defined"
  43 #endif
  44
  45 #define FREE(pointer) do { \
  46     if (pointer != NULL) { \
  47         free(pointer); \
  48         pointer = NULL; \
  49     } \
  50 } \
  51 while (0)
  52
  53 #include "xcb.h"
  54 #include "ipc.h"
  55
  56 enum { STEP_WELCOME, STEP_GENERATE } current_step = STEP_WELCOME;
  57 enum { MOD_ALT, MOD_SUPER } modifier = MOD_SUPER;
  58
  59 static char *config_path;
  60 static xcb_connection_t *conn;
  61 static uint32_t font_id;
  62 static uint32_t font_bold_id;
  63 static char *socket_path;
  64 static int font_height;
  65 static int font_bold_height;
  66 static xcb_window_t win;
  67 static xcb_pixmap_t pixmap;
  68 static xcb_gcontext_t pixmap_gc;
  69 static xcb_key_symbols_t *symbols;
  70 xcb_window_t root;
  71 Display *dpy;
  72
  73 char *rewrite_binding(const char *bindingline);
  74 static void finish();
  75
  76 #if defined(__APPLE__)
  77
  78 /*
  79  * Taken from FreeBSD
  80  * Returns a pointer to a new string which is a duplicate of the
  81  * string, but only copies at most n characters.
  82  *
  83  */
  84 char *strndup(const char *str, size_t n) {
  85     size_t len;
  86     char *copy;
  87
  88     for (len = 0; len < n && str[len]; len++)
  89         continue;
  90
  91     if ((copy = malloc(len + 1)) == NULL)
  92         return (NULL);
  93     memcpy(copy, str, len);
  94     copy[len] = '\0';
  95     return (copy);
  96 }
  97
  98 #endif
  99
 100 /*
 101  * This function resolves ~ in pathnames.
 102  * It may resolve wildcards in the first part of the path, but if no match
 103  * or multiple matches are found, it just returns a copy of path as given.
 104  *
 105  */
 106 static char *resolve_tilde(const char *path) {
 107     static glob_t globbuf;
 108     char *head, *tail, *result;
 109
 110     tail = strchr(path, '/');
 111     head = strndup(path, tail ? tail - path : strlen(path));
 112
 113     int res = glob(head, GLOB_TILDE, NULL, &globbuf);
 114     free(head);
 115     /* no match, or many wildcard matches are bad */
 116     if (res == GLOB_NOMATCH || globbuf.gl_pathc != 1)
 117         result = strdup(path);
 118     else if (res != 0) {
 119         err(1, "glob() failed");
 120     } else {
 121         head = globbuf.gl_pathv[0];
 122         result = calloc(1, strlen(head) + (tail ? strlen(tail) : 0) + 1);
 123         strncpy(result, head, strlen(head));
 124         if (tail)
 125             strncat(result, tail, strlen(tail));
 126     }
 127     globfree(&globbuf);
 128
 129     return result;
 130 }
 131
 132 /*
 133  * Try to get the socket path from X11 and return NULL if it doesn’t work.
 134  * As i3-msg is a short-running tool, we don’t bother with cleaning up the
 135  * connection and leave it up to the operating system on exit.
 136  *
 137  */
 138 static char *socket_path_from_x11() {
 139     xcb_connection_t *conn;
 140     int screen;
 141     if ((conn = xcb_connect(NULL, &screen)) == NULL ||
 142         xcb_connection_has_error(conn))
 143         return NULL;
 144     xcb_screen_t *root_screen = xcb_aux_get_screen(conn, screen);
 145     xcb_window_t root = root_screen->root;
 146
 147     xcb_intern_atom_cookie_t atom_cookie;
 148     xcb_intern_atom_reply_t *atom_reply;
 149
 150     atom_cookie = xcb_intern_atom(conn, 0, strlen("I3_SOCKET_PATH"), "I3_SOCKET_PATH");
 151     atom_reply = xcb_intern_atom_reply(conn, atom_cookie, NULL);
 152     if (atom_reply == NULL)
 153         return NULL;
 154
 155     xcb_get_property_cookie_t prop_cookie;
 156     xcb_get_property_reply_t *prop_reply;
 157     prop_cookie = xcb_get_property_unchecked(conn, false, root, atom_reply->atom,
 158                                              XCB_GET_PROPERTY_TYPE_ANY, 0, PATH_MAX);
 159     prop_reply = xcb_get_property_reply(conn, prop_cookie, NULL);
 160     if (prop_reply == NULL || xcb_get_property_value_length(prop_reply) == 0)
 161         return NULL;
 162     if (asprintf(&socket_path, "%.*s", xcb_get_property_value_length(prop_reply),
 163                  (char*)xcb_get_property_value(prop_reply)) == -1)
 164         return NULL;
 165     return socket_path;
 166 }
 167
 168 /*
 169  * Handles expose events, that is, draws the window contents.
 170  *
 171  */
 172 static int handle_expose() {
 173     /* re-draw the background */
 174     xcb_rectangle_t border = {0, 0, 300, (15*font_height) + 8};
 175     xcb_change_gc_single(conn, pixmap_gc, XCB_GC_FOREGROUND, get_colorpixel(conn, "#000000"));
 176     xcb_poly_fill_rectangle(conn, pixmap, pixmap_gc, 1, &border);
 177
 178     xcb_change_gc_single(conn, pixmap_gc, XCB_GC_FONT, font_id);
 179
 180 #define txt(x, row, text) xcb_image_text_8(conn, strlen(text), pixmap, pixmap_gc, x, (row * font_height) + 2, text)
 181
 182     if (current_step == STEP_WELCOME) {
 183         /* restore font color */
 184         xcb_change_gc_single(conn, pixmap_gc, XCB_GC_FOREGROUND, get_colorpixel(conn, "#FFFFFF"));
 185
 186         txt(10, 2, "You have not configured i3 yet.");
 187         txt(10, 3, "Do you want me to generate ~/.i3/config?");
 188         txt(85, 5, "Yes, generate ~/.i3/config");
 189         txt(85, 7, "No, I will use the defaults");
 190
 191         /* green */
 192         xcb_change_gc_single(conn, pixmap_gc, XCB_GC_FOREGROUND, get_colorpixel(conn, "#00FF00"));
 193         txt(25, 5, "<Enter>");
 194
 195         /* red */
 196         xcb_change_gc_single(conn, pixmap_gc, XCB_GC_FOREGROUND, get_colorpixel(conn, "#FF0000"));
 197         txt(31, 7, "<ESC>");
 198     }
 199
 200     if (current_step == STEP_GENERATE) {
 201         xcb_change_gc_single(conn, pixmap_gc, XCB_GC_FOREGROUND, get_colorpixel(conn, "#FFFFFF"));
 202
 203         txt(10, 2, "Please choose either:");
 204         txt(85, 4, "Win as default modifier");
 205         txt(85, 5, "Alt as default modifier");
 206         txt(10, 7, "Afterwards, press");
 207         txt(85, 9, "to write ~/.i3/config");
 208         txt(85, 10, "to abort");
 209
 210         /* the not-selected modifier */
 211         if (modifier == MOD_SUPER)
 212             txt(31, 5, "<Alt>");
 213         else txt(31, 4, "<Win>");
 214
 215         /* the selected modifier */
 216         xcb_change_gc_single(conn, pixmap_gc, XCB_GC_FONT, font_bold_id);
 217         if (modifier == MOD_SUPER)
 218             txt(31, 4, "<Win>");
 219         else txt(31, 5, "<Alt>");
 220
 221         /* green */
 222         uint32_t mask = XCB_GC_FOREGROUND | XCB_GC_FONT;
 223         uint32_t values[] = { get_colorpixel(conn, "#00FF00"), font_id };
 224         xcb_change_gc(conn, pixmap_gc, mask, values);
 225
 226         txt(25, 9, "<Enter>");
 227
 228         /* red */
 229         xcb_change_gc_single(conn, pixmap_gc, XCB_GC_FOREGROUND, get_colorpixel(conn, "#FF0000"));
 230         txt(31, 10, "<ESC>");
 231     }
 232
 233     /* Copy the contents of the pixmap to the real window */
 234     xcb_copy_area(conn, pixmap, win, pixmap_gc, 0, 0, 0, 0, /* */ 500, 500);
 235     xcb_flush(conn);
 236
 237     return 1;
 238 }
 239
 240 static int handle_key_press(void *ignored, xcb_connection_t *conn, xcb_key_press_event_t *event) {
 241     printf("Keypress %d, state raw = %d\n", event->detail, event->state);
 242
 243     /* Remove the numlock bit, all other bits are modifiers we can bind to */
 244     uint16_t state_filtered = event->state & ~(xcb_numlock_mask | XCB_MOD_MASK_LOCK);
 245     /* Only use the lower 8 bits of the state (modifier masks) so that mouse
 246      * button masks are filtered out */
 247     state_filtered &= 0xFF;
 248
 249     xcb_keysym_t sym = xcb_key_press_lookup_keysym(symbols, event, state_filtered);
 250
 251     printf("sym = %c (%d)\n", sym, sym);
 252
 253     if (sym == XK_Return || sym == XK_KP_Enter) {
 254         if (current_step == STEP_WELCOME) {
 255             current_step = STEP_GENERATE;
 256             /* Set window title */
 257             xcb_change_property(conn,
 258                 XCB_PROP_MODE_REPLACE,
 259                 win,
 260                 A__NET_WM_NAME,
 261                 A_UTF8_STRING,
 262                 8,
 263                 strlen("i3: generate config"),
 264                 "i3: generate config");
 265             xcb_flush(conn);
 266         }
 267         else finish();
 268     }
 269
 270     /* cancel any time */
 271     if (sym == XK_Escape)
 272         exit(0);
 273
 274     if (sym == XK_Alt_L)
 275         modifier = MOD_ALT;
 276
 277     if (sym == XK_Super_L)
 278         modifier = MOD_SUPER;
 279
 280     handle_expose();
 281     return 1;
 282 }
 283
 284 /*
 285  * Handle button presses to make clicking on "<win>" and "<alt>" work
 286  *
 287  */
 288 static void handle_button_press(xcb_button_press_event_t* event) {
 289     if (current_step != STEP_GENERATE)
 290         return;
 291
 292     if (event->event_x >= 32 && event->event_x <= 68 &&
 293         event->event_y >= 45 && event->event_y <= 54) {
 294         modifier = MOD_SUPER;
 295         handle_expose();
 296     }
 297
 298     if (event->event_x >= 32 && event->event_x <= 68 &&
 299         event->event_y >= 56 && event->event_y <= 70) {
 300         modifier = MOD_ALT;
 301         handle_expose();
 302     }
 303
 304     return;
 305 }
 306
 307 /*
 308  * Creates the config file and tells i3 to reload.
 309  *
 310  */
 311 static void finish() {
 312     printf("creating \"%s\"...\n", config_path);
 313
 314     if (!(dpy = XOpenDisplay(NULL)))
 315         errx(1, "Could not connect to X11");
 316
 317     FILE *kc_config = fopen(SYSCONFDIR "/i3/config.keycodes", "r");
 318     if (kc_config == NULL)
 319         err(1, "Could not open input file \"%s\"", SYSCONFDIR "/i3/config.keycodes");
 320
 321     FILE *ks_config = fopen(config_path, "w");
 322     if (ks_config == NULL)
 323         err(1, "Could not open output config file \"%s\"", config_path);
 324
 325     char *line = NULL;
 326     size_t len = 0;
 327 #if !defined(__APPLE__)
 328     ssize_t read;
 329 #endif
 330     bool head_of_file = true;
 331
 332     /* write a header about auto-generation to the output file */
 333     fputs("# This file has been auto-generated by i3-config-wizard(1).\n", ks_config);
 334     fputs("# It will not be overwritten, so edit it as you like.\n", ks_config);
 335     fputs("#\n", ks_config);
 336     fputs("# Should you change your keyboard layout somewhen, delete\n", ks_config);
 337     fputs("# this file and re-run i3-config-wizard(1).\n", ks_config);
 338     fputs("#\n", ks_config);
 339
 340 #if defined(__APPLE__)
 341     while ((line = fgetln(kc_config, &len)) != NULL) {
 342 #else
 343     while ((read = getline(&line, &len, kc_config)) != -1) {
 344 #endif
 345         /* skip the warning block at the beginning of the input file */
 346         if (head_of_file &&
 347             strncmp("# WARNING", line, strlen("# WARNING")) == 0)
 348             continue;
 349
 350         head_of_file = false;
 351
 352         /* Skip leading whitespace */
 353         char *walk = line;
 354         while (isspace(*walk) && walk < (line + len))
 355             walk++;
 356
 357         /* Set the modifier the user chose */
 358         if (strncmp(walk, "set $mod ", strlen("set $mod ")) == 0) {
 359             if (modifier == MOD_ALT)
 360                 fputs("set $mod Mod1\n", ks_config);
 361             else fputs("set $mod Mod4\n", ks_config);
 362             continue;
 363         }
 364
 365         /* Check for 'bindcode'. If it’s not a bindcode line, we
 366          * just copy it to the output file */
 367         if (strncmp(walk, "bindcode", strlen("bindcode")) != 0) {
 368             fputs(line, ks_config);
 369             continue;
 370         }
 371         char *result = rewrite_binding(walk);
 372         fputs(result, ks_config);
 373         free(result);
 374     }
 375
 376     /* sync to do our best in order to have the file really stored on disk */
 377     fflush(ks_config);
 378     fsync(fileno(ks_config));
 379
 380     free(line);
 381     fclose(kc_config);
 382     fclose(ks_config);
 383
 384     /* tell i3 to reload the config file */
 385     int sockfd = connect_ipc(socket_path);
 386     ipc_send_message(sockfd, strlen("reload"), 0, (uint8_t*)"reload");
 387     close(sockfd);
 388
 389     exit(0);
 390 }
 391
 392 int main(int argc, char *argv[]) {
 393     config_path = resolve_tilde("~/.i3/config");
 394     socket_path = getenv("I3SOCK");
 395     char *pattern = "-misc-fixed-medium-r-normal--13-120-75-75-C-70-iso10646-1";
 396     char *patternbold = "-misc-fixed-bold-r-normal--13-120-75-75-C-70-iso10646-1";
 397     int o, option_index = 0;
 398
 399     static struct option long_options[] = {
 400         {"socket", required_argument, 0, 's'},
 401         {"version", no_argument, 0, 'v'},
 402         {"limit", required_argument, 0, 'l'},
 403         {"prompt", required_argument, 0, 'P'},
 404         {"prefix", required_argument, 0, 'p'},
 405         {"font", required_argument, 0, 'f'},
 406         {"help", no_argument, 0, 'h'},
 407         {0, 0, 0, 0}
 408     };
 409
 410     char *options_string = "s:vh";
 411
 412     while ((o = getopt_long(argc, argv, options_string, long_options, &option_index)) != -1) {
 413         switch (o) {
 414             case 's':
 415                 FREE(socket_path);
 416                 socket_path = strdup(optarg);
 417                 break;
 418             case 'v':
 419                 printf("i3-config-wizard " I3_VERSION "\n");
 420                 return 0;
 421             case 'h':
 422                 printf("i3-config-wizard " I3_VERSION "\n");
 423                 printf("i3-config-wizard [-s <socket>] [-v]\n");
 424                 return 0;
 425         }
 426     }
 427
 428     /* Check if the destination config file does not exist but the path is
 429      * writable. If not, exit now, this program is not useful in that case. */
 430     struct stat stbuf;
 431     if (stat(config_path, &stbuf) == 0) {
 432         printf("The config file \"%s\" already exists. Exiting.\n", config_path);
 433         return 0;
 434     }
 435
 436     /* Create ~/.i3 if it does not yet exist */
 437     char *config_dir = resolve_tilde("~/.i3");
 438     if (stat(config_dir, &stbuf) != 0)
 439         if (mkdir(config_dir, 0755) == -1)
 440             err(1, "mkdir(%s) failed", config_dir);
 441     free(config_dir);
 442
 443     int fd;
 444     if ((fd = open(config_path, O_CREAT | O_RDWR, 0644)) == -1) {
 445         printf("Cannot open file \"%s\" for writing: %s. Exiting.\n", config_path, strerror(errno));
 446         return 0;
 447     }
 448     close(fd);
 449     unlink(config_path);
 450
 451     if (socket_path == NULL)
 452         socket_path = socket_path_from_x11();
 453
 454     if (socket_path == NULL)
 455         socket_path = "/tmp/i3-ipc.sock";
 456
 457     int screens;
 458     if ((conn = xcb_connect(NULL, &screens)) == NULL ||
 459         xcb_connection_has_error(conn))
 460         errx(1, "Cannot open display\n");
 461
 462     /* Place requests for the atoms we need as soon as possible */
 463     #define xmacro(atom) \
 464         xcb_intern_atom_cookie_t atom ## _cookie = xcb_intern_atom(conn, 0, strlen(#atom), #atom);
 465     #include "atoms.xmacro"
 466     #undef xmacro
 467
 468     xcb_screen_t *root_screen = xcb_aux_get_screen(conn, screens);
 469     root = root_screen->root;
 470
 471     xcb_get_numlock_mask(conn);
 472
 473     symbols = xcb_key_symbols_alloc(conn);
 474
 475     font_id = get_font_id(conn, pattern, &font_height);
 476     font_bold_id = get_font_id(conn, patternbold, &font_bold_height);
 477
 478     /* Open an input window */
 479     win = open_input_window(conn, 300, 205);
 480
 481     /* Setup NetWM atoms */
 482     #define xmacro(name) \
 483         do { \
 484             xcb_intern_atom_reply_t *reply = xcb_intern_atom_reply(conn, name ## _cookie, NULL); \
 485             if (!reply) \
 486                 errx(EXIT_FAILURE, "Could not get atom " # name "\n"); \
 487             \
 488             A_ ## name = reply->atom; \
 489             free(reply); \
 490         } while (0);
 491     #include "atoms.xmacro"
 492     #undef xmacro
 493
 494     /* Set dock mode */
 495     xcb_change_property(conn,
 496         XCB_PROP_MODE_REPLACE,
 497         win,
 498         A__NET_WM_WINDOW_TYPE,
 499         A_ATOM,
 500         32,
 501         1,
 502         (unsigned char*) &A__NET_WM_WINDOW_TYPE_DIALOG);
 503
 504     /* Set window title */
 505     xcb_change_property(conn,
 506         XCB_PROP_MODE_REPLACE,
 507         win,
 508         A__NET_WM_NAME,
 509         A_UTF8_STRING,
 510         8,
 511         strlen("i3: first configuration"),
 512         "i3: first configuration");
 513
 514     /* Create pixmap */
 515     pixmap = xcb_generate_id(conn);
 516     pixmap_gc = xcb_generate_id(conn);
 517     xcb_create_pixmap(conn, root_screen->root_depth, pixmap, win, 500, 500);
 518     xcb_create_gc(conn, pixmap_gc, pixmap, 0, 0);
 519
 520     /* Grab the keyboard to get all input */
 521     xcb_flush(conn);
 522
 523     /* Try (repeatedly, if necessary) to grab the keyboard. We might not
 524      * get the keyboard at the first attempt because of the keybinding
 525      * still being active when started via a wm’s keybinding. */
 526     xcb_grab_keyboard_cookie_t cookie;
 527     xcb_grab_keyboard_reply_t *reply = NULL;
 528
 529     int count = 0;
 530     while ((reply == NULL || reply->status != XCB_GRAB_STATUS_SUCCESS) && (count++ < 500)) {
 531         cookie = xcb_grab_keyboard(conn, false, win, XCB_CURRENT_TIME, XCB_GRAB_MODE_ASYNC, XCB_GRAB_MODE_ASYNC);
 532         reply = xcb_grab_keyboard_reply(conn, cookie, NULL);
 533         usleep(1000);
 534     }
 535
 536     if (reply->status != XCB_GRAB_STATUS_SUCCESS) {
 537         fprintf(stderr, "Could not grab keyboard, status = %d\n", reply->status);
 538         exit(-1);
 539     }
 540
 541     xcb_flush(conn);
 542
 543     xcb_generic_event_t *event;
 544     while ((event = xcb_wait_for_event(conn)) != NULL) {
 545         if (event->response_type == 0) {
 546             fprintf(stderr, "X11 Error received! sequence %x\n", event->sequence);
 547             continue;
 548         }
 549
 550         /* Strip off the highest bit (set if the event is generated) */
 551         int type = (event->response_type & 0x7F);
 552
 553         switch (type) {
 554             case XCB_KEY_PRESS:
 555                 handle_key_press(NULL, conn, (xcb_key_press_event_t*)event);
 556                 break;
 557
 558             /* TODO: handle mappingnotify */
 559
 560             case XCB_BUTTON_PRESS:
 561                 handle_button_press((xcb_button_press_event_t*)event);
 562                 break;
 563
 564             case XCB_EXPOSE:
 565                 handle_expose();
 566                 break;
 567         }
 568
 569         free(event);
 570     }
 571
 572     return 0;
 573 }