4 * i3 - an improved dynamic tiling window manager
6 * © 2009-2010 Michael Stapelberg and contributors
8 * See file LICENSE for license information.
14 #include <sys/types.h>
23 #include <X11/XKBlib.h>
24 #include <X11/extensions/XKB.h>
27 #include <xcb/xcb_atom.h>
28 #include <xcb/xcb_aux.h>
29 #include <xcb/xcb_event.h>
30 #include <xcb/xcb_property.h>
31 #include <xcb/xcb_keysyms.h>
32 #include <xcb/xcb_icccm.h>
52 #include "sighandler.h"
54 static int xkb_event_base;
56 int xkb_current_group;
58 xcb_connection_t *global_conn;
60 /* This is the path to i3, copied from argv[0] when starting up */
63 /* This is our connection to X11 for use with XKB */
66 xcb_key_symbols_t *keysyms;
68 /* The list of key bindings */
69 struct bindings_head *bindings;
71 /* The list of exec-lines */
72 struct autostarts_head autostarts = TAILQ_HEAD_INITIALIZER(autostarts);
74 /* The list of assignments */
75 struct assignments_head assignments = TAILQ_HEAD_INITIALIZER(assignments);
77 /* This is a list of Stack_Windows, global, for easier/faster access on expose events */
78 struct stack_wins_head stack_wins = SLIST_HEAD_INITIALIZER(stack_wins);
80 /* The event handlers need to be global because they are accessed by our custom event handler
81 in handle_button_press(), needed for graphical resizing */
82 xcb_event_handlers_t evenths;
83 xcb_atom_t atoms[NUM_ATOMS];
88 /* The depth of the root screen (used e.g. for creating new pixmaps later) */
91 /* We hope that XKB is supported and set this to false */
92 bool xkb_supported = true;
95 * This callback is only a dummy, see xcb_prepare_cb and xcb_check_cb.
96 * See also man libev(3): "ev_prepare" and "ev_check" - customise your event loop
99 static void xcb_got_event(EV_P_ struct ev_io *w, int revents) {
100 /* empty, because xcb_prepare_cb and xcb_check_cb are used */
104 * Flush before blocking (and waiting for new events)
107 static void xcb_prepare_cb(EV_P_ ev_prepare *w, int revents) {
108 xcb_flush(evenths.c);
112 * Instead of polling the X connection socket we leave this to
113 * xcb_poll_for_event() which knows better than we can ever know.
116 static void xcb_check_cb(EV_P_ ev_check *w, int revents) {
117 xcb_generic_event_t *event;
119 while ((event = xcb_poll_for_event(evenths.c)) != NULL) {
120 xcb_event_handle(&evenths, event);
126 * When using xmodmap to change the keyboard mapping, this event
127 * is only sent via XKB. Therefore, we need this special handler.
130 static void xkb_got_event(EV_P_ struct ev_io *w, int revents) {
131 DLOG("Handling XKB event\n");
134 /* When using xmodmap, every change (!) gets an own event.
135 * Therefore, we just read all events and only handle the
136 * mapping_notify once. */
137 bool mapping_changed = false;
138 while (XPending(xkbdpy)) {
139 XNextEvent(xkbdpy, (XEvent*)&ev);
140 /* While we should never receive a non-XKB event,
141 * better do sanity checking */
142 if (ev.type != xkb_event_base)
145 if (ev.any.xkb_type == XkbMapNotify) {
146 mapping_changed = true;
150 if (ev.any.xkb_type != XkbStateNotify) {
151 ELOG("Unknown XKB event received (type %d)\n", ev.any.xkb_type);
155 /* See The XKB Extension: Library Specification, section 14.1 */
156 /* We check if the current group (each group contains
157 * two levels) has been changed. Mode_switch activates
158 * group XkbGroup2Index */
159 if (xkb_current_group == ev.state.group)
162 xkb_current_group = ev.state.group;
164 if (ev.state.group == XkbGroup2Index) {
165 DLOG("Mode_switch enabled\n");
166 grab_all_keys(global_conn, true);
169 if (ev.state.group == XkbGroup1Index) {
170 DLOG("Mode_switch disabled\n");
171 ungrab_all_keys(global_conn);
172 grab_all_keys(global_conn, false);
176 if (!mapping_changed)
179 DLOG("Keyboard mapping changed, updating keybindings\n");
180 xcb_key_symbols_free(keysyms);
181 keysyms = xcb_key_symbols_alloc(global_conn);
183 xcb_get_numlock_mask(global_conn);
185 ungrab_all_keys(global_conn);
186 DLOG("Re-grabbing...\n");
188 grab_all_keys(global_conn, (xkb_current_group == XkbGroup2Index));
193 int main(int argc, char *argv[], char *env[]) {
195 char *override_configpath = NULL;
196 bool autostart = true;
197 bool only_check_config = false;
198 bool force_xinerama = false;
199 xcb_connection_t *conn;
200 xcb_property_handlers_t prophs;
201 xcb_intern_atom_cookie_t atom_cookies[NUM_ATOMS];
202 static struct option long_options[] = {
203 {"no-autostart", no_argument, 0, 'a'},
204 {"config", required_argument, 0, 'c'},
205 {"version", no_argument, 0, 'v'},
206 {"help", no_argument, 0, 'h'},
207 {"force-xinerama", no_argument, 0, 0},
210 int option_index = 0;
212 setlocale(LC_ALL, "");
214 /* Disable output buffering to make redirects in .xsession actually useful for debugging */
215 if (!isatty(fileno(stdout)))
216 setbuf(stdout, NULL);
220 while ((opt = getopt_long(argc, argv, "c:Cvahld:V", long_options, &option_index)) != -1) {
223 LOG("Autostart disabled using -a\n");
227 override_configpath = sstrdup(optarg);
230 LOG("Checking configuration file only (-C)\n");
231 only_check_config = true;
234 printf("i3 version " I3_VERSION " © 2009 Michael Stapelberg and contributors\n");
240 LOG("Enabling debug loglevel %s\n", optarg);
241 add_loglevel(optarg);
244 /* DEPRECATED, ignored for the next 3 versions (3.e, 3.f, 3.g) */
247 if (strcmp(long_options[option_index].name, "force-xinerama") == 0) {
248 force_xinerama = true;
249 ELOG("Using Xinerama instead of RandR. This option should be "
250 "avoided at all cost because it does not refresh the list "
251 "of screens, so you cannot configure displays at runtime. "
252 "Please check if your driver really does not support RandR "
253 "and disable this option as soon as you can.\n");
258 fprintf(stderr, "Usage: %s [-c configfile] [-d loglevel] [-a] [-v] [-V] [-C]\n", argv[0]);
259 fprintf(stderr, "\n");
260 fprintf(stderr, "-a: disable autostart\n");
261 fprintf(stderr, "-v: display version and exit\n");
262 fprintf(stderr, "-V: enable verbose mode\n");
263 fprintf(stderr, "-d <loglevel>: enable debug loglevel <loglevel>\n");
264 fprintf(stderr, "-c <configfile>: use the provided configfile instead\n");
265 fprintf(stderr, "-C: check configuration file and exit\n");
266 fprintf(stderr, "--force-xinerama: Use Xinerama instead of RandR. This "
267 "option should only be used if you are stuck with the "
268 "nvidia closed source driver which does not support RandR.\n");
273 LOG("i3 version " I3_VERSION " starting\n");
275 /* Initialize the table data structures for each workspace */
278 memset(&evenths, 0, sizeof(xcb_event_handlers_t));
279 memset(&prophs, 0, sizeof(xcb_property_handlers_t));
281 conn = global_conn = xcb_connect(NULL, &screens);
283 if (xcb_connection_has_error(conn))
284 die("Cannot open display\n");
286 load_configuration(conn, override_configpath, false);
287 if (only_check_config) {
288 LOG("Done checking configuration file. Exiting.\n");
292 /* Create the initial container on the first workspace. This used to
293 * be part of init_table, but since it possibly requires an X
294 * connection and a loaded configuration (default mode for new
295 * containers may be stacking, which requires a new window to be
296 * created), it had to be delayed. */
297 expand_table_cols(TAILQ_FIRST(workspaces));
298 expand_table_rows(TAILQ_FIRST(workspaces));
300 /* Place requests for the atoms we need as soon as possible */
301 #define REQUEST_ATOM(name) atom_cookies[name] = xcb_intern_atom(conn, 0, strlen(#name), #name);
303 REQUEST_ATOM(_NET_SUPPORTED);
304 REQUEST_ATOM(_NET_WM_STATE_FULLSCREEN);
305 REQUEST_ATOM(_NET_SUPPORTING_WM_CHECK);
306 REQUEST_ATOM(_NET_WM_NAME);
307 REQUEST_ATOM(_NET_WM_STATE);
308 REQUEST_ATOM(_NET_WM_WINDOW_TYPE);
309 REQUEST_ATOM(_NET_WM_DESKTOP);
310 REQUEST_ATOM(_NET_WM_WINDOW_TYPE_DOCK);
311 REQUEST_ATOM(_NET_WM_WINDOW_TYPE_DIALOG);
312 REQUEST_ATOM(_NET_WM_WINDOW_TYPE_UTILITY);
313 REQUEST_ATOM(_NET_WM_WINDOW_TYPE_TOOLBAR);
314 REQUEST_ATOM(_NET_WM_WINDOW_TYPE_SPLASH);
315 REQUEST_ATOM(_NET_WM_STRUT_PARTIAL);
316 REQUEST_ATOM(WM_PROTOCOLS);
317 REQUEST_ATOM(WM_DELETE_WINDOW);
318 REQUEST_ATOM(UTF8_STRING);
319 REQUEST_ATOM(WM_STATE);
320 REQUEST_ATOM(WM_CLIENT_LEADER);
321 REQUEST_ATOM(_NET_CURRENT_DESKTOP);
322 REQUEST_ATOM(_NET_ACTIVE_WINDOW);
323 REQUEST_ATOM(_NET_WORKAREA);
325 /* TODO: this has to be more beautiful somewhen */
326 int major, minor, error;
328 major = XkbMajorVersion;
329 minor = XkbMinorVersion;
333 if ((xkbdpy = XkbOpenDisplay(getenv("DISPLAY"), &xkb_event_base, &errBase, &major, &minor, &error)) == NULL) {
334 ELOG("ERROR: XkbOpenDisplay() failed, disabling XKB support\n");
335 xkb_supported = false;
339 if (fcntl(ConnectionNumber(xkbdpy), F_SETFD, FD_CLOEXEC) == -1) {
340 fprintf(stderr, "Could not set FD_CLOEXEC on xkbdpy\n");
345 if (!XkbQueryExtension(xkbdpy,&i1,&xkb_event_base,&errBase,&major,&minor)) {
346 fprintf(stderr, "XKB not supported by X-server\n");
349 /* end of ugliness */
351 if (!XkbSelectEvents(xkbdpy, XkbUseCoreKbd,
352 XkbMapNotifyMask | XkbStateNotifyMask,
353 XkbMapNotifyMask | XkbStateNotifyMask)) {
354 fprintf(stderr, "Could not set XKB event mask\n");
359 /* Initialize event loop using libev */
360 struct ev_loop *loop = ev_loop_new(0);
362 die("Could not initialize libev. Bad LIBEV_FLAGS?\n");
364 struct ev_io *xcb_watcher = scalloc(sizeof(struct ev_io));
365 struct ev_io *xkb = scalloc(sizeof(struct ev_io));
366 struct ev_check *xcb_check = scalloc(sizeof(struct ev_check));
367 struct ev_prepare *xcb_prepare = scalloc(sizeof(struct ev_prepare));
369 ev_io_init(xcb_watcher, xcb_got_event, xcb_get_file_descriptor(conn), EV_READ);
370 ev_io_start(loop, xcb_watcher);
373 ev_io_init(xkb, xkb_got_event, ConnectionNumber(xkbdpy), EV_READ);
374 ev_io_start(loop, xkb);
376 /* Flush the buffer so that libev can properly get new events */
380 ev_check_init(xcb_check, xcb_check_cb);
381 ev_check_start(loop, xcb_check);
383 ev_prepare_init(xcb_prepare, xcb_prepare_cb);
384 ev_prepare_start(loop, xcb_prepare);
386 /* Grab the server to delay any events until we enter the eventloop */
387 xcb_grab_server(conn);
389 xcb_event_handlers_init(conn, &evenths);
391 /* DEBUG: Trap all events and print them */
392 for (i = 2; i < 128; ++i)
393 xcb_event_set_handler(&evenths, i, handle_event, 0);
395 for (i = 0; i < 256; ++i)
396 xcb_event_set_error_handler(&evenths, i, (xcb_generic_error_handler_t)handle_event, 0);
398 /* Expose = an Application should redraw itself, in this case it’s our titlebars. */
399 xcb_event_set_expose_handler(&evenths, handle_expose_event, NULL);
401 /* Key presses are pretty obvious, I think */
402 xcb_event_set_key_press_handler(&evenths, handle_key_press, NULL);
404 /* Enter window = user moved his mouse over the window */
405 xcb_event_set_enter_notify_handler(&evenths, handle_enter_notify, NULL);
407 /* Button press = user pushed a mouse button over one of our windows */
408 xcb_event_set_button_press_handler(&evenths, handle_button_press, NULL);
410 /* Map notify = there is a new window */
411 xcb_event_set_map_request_handler(&evenths, handle_map_request, &prophs);
413 /* Unmap notify = window disappeared. When sent from a client, we don’t manage
414 it any longer. Usually, the client destroys the window shortly afterwards. */
415 xcb_event_set_unmap_notify_handler(&evenths, handle_unmap_notify_event, NULL);
417 /* Destroy notify is handled the same as unmap notify */
418 xcb_event_set_destroy_notify_handler(&evenths, handle_destroy_notify_event, NULL);
420 /* Configure notify = window’s configuration (geometry, stacking, …). We only need
421 it to set up ignore the following enter_notify events */
422 xcb_event_set_configure_notify_handler(&evenths, handle_configure_event, NULL);
424 /* Configure request = window tried to change size on its own */
425 xcb_event_set_configure_request_handler(&evenths, handle_configure_request, NULL);
427 /* Motion notify = user moved his cursor (over the root window and may
428 * cross virtual screen boundaries doing that) */
429 xcb_event_set_motion_notify_handler(&evenths, handle_motion_notify, NULL);
431 /* Mapping notify = keyboard mapping changed (Xmodmap), re-grab bindings */
432 xcb_event_set_mapping_notify_handler(&evenths, handle_mapping_notify, NULL);
434 /* Client message are sent to the root window. The only interesting client message
435 for us is _NET_WM_STATE, we honour _NET_WM_STATE_FULLSCREEN */
436 xcb_event_set_client_message_handler(&evenths, handle_client_message, NULL);
438 /* Initialize the property handlers */
439 xcb_property_handlers_init(&prophs, &evenths);
441 /* Watch size hints (to obey correct aspect ratio) */
442 xcb_property_set_handler(&prophs, WM_NORMAL_HINTS, UINT_MAX, handle_normal_hints, NULL);
444 /* Get the root window and set the event mask */
445 xcb_screen_t *root_screen = xcb_aux_get_screen(conn, screens);
446 root = root_screen->root;
447 root_depth = root_screen->root_depth;
449 uint32_t mask = XCB_CW_EVENT_MASK;
450 uint32_t values[] = { XCB_EVENT_MASK_SUBSTRUCTURE_REDIRECT |
451 XCB_EVENT_MASK_STRUCTURE_NOTIFY | /* when the user adds a screen (e.g. video
452 projector), the root window gets a
454 XCB_EVENT_MASK_POINTER_MOTION |
455 XCB_EVENT_MASK_PROPERTY_CHANGE |
456 XCB_EVENT_MASK_ENTER_WINDOW };
457 xcb_void_cookie_t cookie;
458 cookie = xcb_change_window_attributes_checked(conn, root, mask, values);
459 check_error(conn, cookie, "Another window manager seems to be running");
461 /* Setup NetWM atoms */
462 #define GET_ATOM(name) { \
463 xcb_intern_atom_reply_t *reply = xcb_intern_atom_reply(conn, atom_cookies[name], NULL); \
465 ELOG("Could not get atom " #name "\n"); \
468 atoms[name] = reply->atom; \
472 GET_ATOM(_NET_SUPPORTED);
473 GET_ATOM(_NET_WM_STATE_FULLSCREEN);
474 GET_ATOM(_NET_SUPPORTING_WM_CHECK);
475 GET_ATOM(_NET_WM_NAME);
476 GET_ATOM(_NET_WM_STATE);
477 GET_ATOM(_NET_WM_WINDOW_TYPE);
478 GET_ATOM(_NET_WM_DESKTOP);
479 GET_ATOM(_NET_WM_WINDOW_TYPE_DOCK);
480 GET_ATOM(_NET_WM_WINDOW_TYPE_DIALOG);
481 GET_ATOM(_NET_WM_WINDOW_TYPE_UTILITY);
482 GET_ATOM(_NET_WM_WINDOW_TYPE_TOOLBAR);
483 GET_ATOM(_NET_WM_WINDOW_TYPE_SPLASH);
484 GET_ATOM(_NET_WM_STRUT_PARTIAL);
485 GET_ATOM(WM_PROTOCOLS);
486 GET_ATOM(WM_DELETE_WINDOW);
487 GET_ATOM(UTF8_STRING);
489 GET_ATOM(WM_CLIENT_LEADER);
490 GET_ATOM(_NET_CURRENT_DESKTOP);
491 GET_ATOM(_NET_ACTIVE_WINDOW);
492 GET_ATOM(_NET_WORKAREA);
494 xcb_property_set_handler(&prophs, atoms[_NET_WM_WINDOW_TYPE], UINT_MAX, handle_window_type, NULL);
495 /* TODO: In order to comply with EWMH, we have to watch _NET_WM_STRUT_PARTIAL */
497 /* Watch _NET_WM_NAME (= title of the window in UTF-8) property */
498 xcb_property_set_handler(&prophs, atoms[_NET_WM_NAME], 128, handle_windowname_change, NULL);
500 /* Watch WM_TRANSIENT_FOR property (to which client this popup window belongs) */
501 xcb_property_set_handler(&prophs, WM_TRANSIENT_FOR, UINT_MAX, handle_transient_for, NULL);
503 /* Watch WM_NAME (= title of the window in compound text) property for legacy applications */
504 xcb_watch_wm_name(&prophs, 128, handle_windowname_change_legacy, NULL);
506 /* Watch WM_CLASS (= class of the window) */
507 xcb_property_set_handler(&prophs, WM_CLASS, 128, handle_windowclass_change, NULL);
509 /* Watch WM_CLIENT_LEADER (= logical parent window for toolbars etc.) */
510 xcb_property_set_handler(&prophs, atoms[WM_CLIENT_LEADER], UINT_MAX, handle_clientleader_change, NULL);
512 /* Watch WM_HINTS (contains the urgent property) */
513 xcb_property_set_handler(&prophs, WM_HINTS, UINT_MAX, handle_hints, NULL);
515 /* Set up the atoms we support */
516 check_error(conn, xcb_change_property_checked(conn, XCB_PROP_MODE_REPLACE, root, atoms[_NET_SUPPORTED],
517 ATOM, 32, 7, atoms), "Could not set _NET_SUPPORTED");
518 /* Set up the window manager’s name */
519 xcb_change_property(conn, XCB_PROP_MODE_REPLACE, root, atoms[_NET_SUPPORTING_WM_CHECK], WINDOW, 32, 1, &root);
520 xcb_change_property(conn, XCB_PROP_MODE_REPLACE, root, atoms[_NET_WM_NAME], atoms[UTF8_STRING], 8, strlen("i3"), "i3");
522 keysyms = xcb_key_symbols_alloc(conn);
524 xcb_get_numlock_mask(conn);
527 grab_all_keys(conn, false);
530 if (force_xinerama) {
531 initialize_xinerama(conn);
533 DLOG("Checking for XRandR...\n");
534 initialize_randr(conn, &randr_base);
536 xcb_event_set_handler(&evenths,
537 randr_base + XCB_RANDR_SCREEN_CHANGE_NOTIFY,
538 handle_screen_change,
544 /* Get pointer position to see on which screen we’re starting */
545 xcb_query_pointer_reply_t *reply;
546 if ((reply = xcb_query_pointer_reply(conn, xcb_query_pointer(conn, root), NULL)) == NULL) {
547 ELOG("Could not get pointer position\n");
551 Output *screen = get_output_containing(reply->root_x, reply->root_y);
552 if (screen == NULL) {
553 ELOG("ERROR: No screen at %d x %d, starting on the first screen\n",
554 reply->root_x, reply->root_y);
555 screen = get_first_output();
558 DLOG("Starting on %p\n", screen->current_workspace);
559 c_ws = screen->current_workspace;
561 manage_existing_windows(conn, &prophs, root);
563 /* Create the UNIX domain socket for IPC */
564 if (config.ipc_socket_path != NULL) {
565 int ipc_socket = ipc_create_socket(config.ipc_socket_path);
566 if (ipc_socket == -1) {
567 ELOG("Could not create the IPC socket, IPC disabled\n");
569 struct ev_io *ipc_io = scalloc(sizeof(struct ev_io));
570 ev_io_init(ipc_io, ipc_new_client, ipc_socket, EV_READ);
571 ev_io_start(loop, ipc_io);
575 /* Handle the events which arrived until now */
576 xcb_check_cb(NULL, NULL, 0);
578 setup_signal_handler();
580 /* Ignore SIGPIPE to survive errors when an IPC client disconnects
581 * while we are sending him a message */
582 signal(SIGPIPE, SIG_IGN);
584 /* Ungrab the server to receive events and enter libev’s eventloop */
585 xcb_ungrab_server(conn);
587 /* Autostarting exec-lines */
588 struct Autostart *exec;
590 TAILQ_FOREACH(exec, &autostarts, autostarts) {
591 LOG("auto-starting %s\n", exec->command);
592 start_application(exec->command);