2 * vim:ts=4:sw=4:expandtab
4 * i3 - an improved dynamic tiling window manager
6 * © 2009-2011 Michael Stapelberg and contributors
8 * See file LICENSE for license information.
10 * For more information on RandR, please see the X.org RandR specification at
11 * http://cgit.freedesktop.org/xorg/proto/randrproto/tree/randrproto.txt
12 * (take your time to read it completely, it answers all questions).
17 #include <xcb/randr.h>
21 /* While a clean namespace is usually a pretty good thing, we really need
22 * to use shorter names than the whole xcb_randr_* default names. */
23 typedef xcb_randr_get_crtc_info_reply_t crtc_info;
24 typedef xcb_randr_mode_info_t mode_info;
25 typedef xcb_randr_get_screen_resources_current_reply_t resources_reply;
27 /* Pointer to the result of the query for primary output */
28 xcb_randr_get_output_primary_reply_t *primary;
30 /* Stores all outputs available in your current session. */
31 struct outputs_head outputs = TAILQ_HEAD_INITIALIZER(outputs);
33 static bool randr_disabled = false;
36 * Get a specific output by its internal X11 id. Used by randr_query_outputs
37 * to check if the output is new (only in the first scan) or if we are
41 static Output *get_output_by_id(xcb_randr_output_t id) {
43 TAILQ_FOREACH(output, &outputs, outputs)
51 * Returns the output with the given name if it is active (!) or NULL.
54 Output *get_output_by_name(const char *name) {
56 TAILQ_FOREACH(output, &outputs, outputs)
58 strcasecmp(output->name, name) == 0)
65 * Returns the first output which is active.
68 Output *get_first_output() {
71 TAILQ_FOREACH(output, &outputs, outputs)
79 * Returns the active (!) output which contains the coordinates x, y or NULL
80 * if there is no output which contains these coordinates.
83 Output *get_output_containing(int x, int y) {
85 TAILQ_FOREACH(output, &outputs, outputs) {
88 DLOG("comparing x=%d y=%d with x=%d and y=%d width %d height %d\n",
89 x, y, output->rect.x, output->rect.y, output->rect.width, output->rect.height);
90 if (x >= output->rect.x && x < (output->rect.x + output->rect.width) &&
91 y >= output->rect.y && y < (output->rect.y + output->rect.height))
99 * Gets the output which is the last one in the given direction, for example
100 * the output on the most bottom when direction == D_DOWN, the output most
101 * right when direction == D_RIGHT and so on.
103 * This function always returns a output.
106 Output *get_output_most(direction_t direction, Output *current) {
107 Output *output, *candidate = NULL;
109 TAILQ_FOREACH(output, &outputs, outputs) {
113 /* Repeated calls of WIN determine the winner of the comparison */
114 #define WIN(variable, condition) \
115 if (variable condition) { \
116 candidate = output; \
117 position = variable; \
121 if (((direction == D_UP) || (direction == D_DOWN)) &&
122 (current->rect.x != output->rect.x))
125 if (((direction == D_LEFT) || (direction == D_RIGHT)) &&
126 (current->rect.y != output->rect.y))
131 WIN(output->rect.y, <= position);
133 WIN(output->rect.y, >= position);
135 WIN(output->rect.x, <= position);
137 WIN(output->rect.x, >= position);
141 assert(candidate != NULL);
148 * Initializes the specified output, assigning the specified workspace to it.
151 void initialize_output(xcb_connection_t *conn, Output *output, Workspace *workspace) {
152 i3Font *font = load_font(conn, config.font);
154 workspace->output = output;
155 output->current_workspace = workspace;
157 /* Copy rect for the workspace */
158 memcpy(&(workspace->rect), &(output->rect), sizeof(Rect));
160 /* Map clients on the workspace, if any */
161 workspace_map_clients(conn, workspace);
163 /* Create a bar window on each output */
164 if (!config.disable_workspace_bar) {
165 Rect bar_rect = {output->rect.x,
166 output->rect.y + output->rect.height - (font->height + 6),
167 output->rect.x + output->rect.width,
169 uint32_t mask = XCB_CW_OVERRIDE_REDIRECT | XCB_CW_EVENT_MASK;
170 uint32_t values[] = {1, XCB_EVENT_MASK_EXPOSURE | XCB_EVENT_MASK_BUTTON_PRESS};
171 output->bar = create_window(conn, bar_rect, XCB_WINDOW_CLASS_INPUT_OUTPUT, XCB_CURSOR_LEFT_PTR, true, mask, values);
172 output->bargc = xcb_generate_id(conn);
173 xcb_create_gc(conn, output->bargc, output->bar, 0, 0);
176 SLIST_INIT(&(output->dock_clients));
178 ipc_send_event("workspace", I3_IPC_EVENT_WORKSPACE, "{\"change\":\"init\"}");
179 DLOG("initialized output at (%d, %d) with %d x %d\n",
180 output->rect.x, output->rect.y, output->rect.width, output->rect.height);
182 DLOG("assigning configured workspaces to this output...\n");
184 TAILQ_FOREACH(ws, workspaces, workspaces) {
187 if (ws->preferred_output == NULL ||
188 get_output_by_name(ws->preferred_output) != output)
191 DLOG("assigning ws %d\n", ws->num + 1);
192 workspace_assign_to(ws, output, true);
198 * Disables RandR support by creating exactly one output with the size of the
202 void disable_randr(xcb_connection_t *conn) {
203 xcb_screen_t *root_screen = xcb_setup_roots_iterator(xcb_get_setup(conn)).data;
205 DLOG("RandR extension unusable, disabling.\n");
207 Output *s = scalloc(sizeof(Output));
212 s->rect.width = root_screen->width_in_pixels;
213 s->rect.height = root_screen->height_in_pixels;
217 TAILQ_INSERT_TAIL(&outputs, s, outputs);
219 randr_disabled = true;
223 * Initializes a CT_OUTPUT Con (searches existing ones from inplace restart
224 * before) to use for the given Output.
226 * XXX: for assignments, we probably need to move workspace creation from here
227 * to after the loop in randr_query_outputs().
230 void output_init_con(Output *output) {
231 Con *con = NULL, *current;
234 DLOG("init_con for output %s\n", output->name);
236 /* Search for a Con with that name directly below the root node. There
237 * might be one from a restored layout. */
238 TAILQ_FOREACH(current, &(croot->nodes_head), nodes) {
239 if (strcmp(current->name, output->name) != 0)
244 DLOG("Using existing con %p / %s\n", con, con->name);
249 con = con_new(croot);
251 con->name = sstrdup(output->name);
252 con->type = CT_OUTPUT;
253 con->layout = L_OUTPUT;
255 con->rect = output->rect;
259 asprintf(&name, "[i3 con] output %s", con->name);
260 x_set_name(con, name);
264 DLOG("Not adding workspace, this was a reused con\n");
268 DLOG("Changing layout, adding top/bottom dockarea\n");
269 Con *topdock = con_new(NULL);
270 topdock->type = CT_DOCKAREA;
271 topdock->layout = L_DOCKAREA;
272 topdock->orientation = VERT;
273 /* this container swallows dock clients */
274 Match *match = scalloc(sizeof(Match));
276 match->dock = M_DOCK_TOP;
277 match->insert_where = M_BELOW;
278 TAILQ_INSERT_TAIL(&(topdock->swallow_head), match, matches);
280 topdock->name = sstrdup("topdock");
282 asprintf(&name, "[i3 con] top dockarea %s", con->name);
283 x_set_name(topdock, name);
286 con_attach(topdock, con, false);
288 /* content container */
290 DLOG("adding main content container\n");
291 Con *content = con_new(NULL);
292 content->type = CT_CON;
293 content->name = sstrdup("content");
295 asprintf(&name, "[i3 con] content %s", con->name);
296 x_set_name(content, name);
298 con_attach(content, con, false);
300 /* bottom dock container */
301 Con *bottomdock = con_new(NULL);
302 bottomdock->type = CT_DOCKAREA;
303 bottomdock->layout = L_DOCKAREA;
304 bottomdock->orientation = VERT;
305 /* this container swallows dock clients */
306 match = scalloc(sizeof(Match));
308 match->dock = M_DOCK_BOTTOM;
309 match->insert_where = M_BELOW;
310 TAILQ_INSERT_TAIL(&(bottomdock->swallow_head), match, matches);
312 bottomdock->name = sstrdup("bottomdock");
314 asprintf(&name, "[i3 con] bottom dockarea %s", con->name);
315 x_set_name(bottomdock, name);
318 con_attach(bottomdock, con, false);
320 DLOG("Now adding a workspace\n");
322 /* add a workspace to this output */
323 Con *ws = con_new(NULL);
324 ws->type = CT_WORKSPACE;
326 /* get the next unused workspace number */
327 DLOG("Getting next unused workspace\n");
331 Con *out, *current, *child;
336 asprintf(&(ws->name), "%d", c);
339 TAILQ_FOREACH(out, &(croot->nodes_head), nodes) {
340 TAILQ_FOREACH(current, &(out->nodes_head), nodes) {
341 if (current->type != CT_CON)
344 TAILQ_FOREACH(child, &(current->nodes_head), nodes) {
345 if (strcasecmp(child->name, ws->name) != 0)
354 DLOG("result for ws %s / %d: exists = %d\n", ws->name, c, exists);
357 con_attach(ws, content, false);
359 asprintf(&name, "[i3 con] workspace %s", ws->name);
360 x_set_name(ws, name);
363 ws->fullscreen_mode = CF_OUTPUT;
365 /* If default_orientation is set to NO_ORIENTATION we determine
366 * orientation depending on output resolution. */
367 if (config.default_orientation == NO_ORIENTATION) {
368 ws->orientation = (output->rect.height > output->rect.width) ? VERT : HORIZ;
369 DLOG("Auto orientation. Workspace size set to (%d,%d), setting orientation to %d.\n",
370 output->rect.width, output->rect.height, ws->orientation);
372 ws->orientation = config.default_orientation;
376 /* TODO: Set focus in main.c */
381 * This function needs to be called when changing the mode of an output when
382 * it already has some workspaces (or a bar window) assigned.
384 * It reconfigures the bar window for the new mode, copies the new rect into
385 * each workspace on this output and forces all windows on the affected
386 * workspaces to be reconfigured.
388 * It is necessary to call render_layout() afterwards.
391 static void output_change_mode(xcb_connection_t *conn, Output *output) {
392 //i3Font *font = load_font(conn, config.font);
394 DLOG("Output mode changed, updating rect\n");
395 assert(output->con != NULL);
396 output->con->rect = output->rect;
398 Con *content, *workspace, *child;
400 /* Point content to the container of the workspaces */
401 content = output_get_content(output->con);
403 /* If default_orientation is NO_ORIENTATION, we change the orientation of
404 * the workspaces and their childs depending on output resolution. This is
405 * only done for workspaces with maximum one child. */
406 if (config.default_orientation == NO_ORIENTATION) {
407 TAILQ_FOREACH(workspace, &(content->nodes_head), nodes) {
408 /* Workspaces with more than one child are left untouched because
409 * we do not want to change an existing layout. */
410 if (con_num_children(workspace) > 1)
413 workspace->orientation = (output->rect.height > output->rect.width) ? VERT : HORIZ;
414 DLOG("Setting workspace [%d,%s]'s orientation to %d.\n", workspace->num, workspace->name, workspace->orientation);
415 if ((child = TAILQ_FIRST(&(workspace->nodes_head)))) {
416 child->orientation = workspace->orientation;
417 DLOG("Setting child [%d,%s]'s orientation to %d.\n", child->num, child->name, child->orientation);
423 Rect bar_rect = {output->rect.x,
424 output->rect.y + output->rect.height - (font->height + 6),
425 output->rect.x + output->rect.width,
428 xcb_set_window_rect(conn, output->bar, bar_rect);
430 /* go through all workspaces and set force_reconfigure */
431 TAILQ_FOREACH(ws, workspaces, workspaces) {
432 if (ws->output != output)
435 SLIST_FOREACH(client, &(ws->focus_stack), focus_clients) {
436 client->force_reconfigure = true;
437 if (!client_is_floating(client))
439 /* For floating clients we need to translate the
440 * coordinates (old workspace to new workspace) */
441 DLOG("old: (%x, %x)\n", client->rect.x, client->rect.y);
442 client->rect.x -= ws->rect.x;
443 client->rect.y -= ws->rect.y;
444 client->rect.x += ws->output->rect.x;
445 client->rect.y += ws->output->rect.y;
446 DLOG("new: (%x, %x)\n", client->rect.x, client->rect.y);
449 /* Update dimensions from output */
450 memcpy(&(ws->rect), &(ws->output->rect), sizeof(Rect));
452 /* Update the dimensions of a fullscreen client, if any */
453 if (ws->fullscreen_client != NULL) {
454 DLOG("Updating fullscreen client size\n");
455 client = ws->fullscreen_client;
457 xcb_set_window_rect(conn, client->frame, r);
461 xcb_set_window_rect(conn, client->child, r);
468 * Gets called by randr_query_outputs() for each output. The function adds new
469 * outputs to the list of outputs, checks if the mode of existing outputs has
470 * been changed or if an existing output has been disabled. It will then change
471 * either the "changed" or the "to_be_deleted" flag of the output, if
475 static void handle_output(xcb_connection_t *conn, xcb_randr_output_t id,
476 xcb_randr_get_output_info_reply_t *output,
477 xcb_timestamp_t cts, resources_reply *res) {
478 /* each CRT controller has a position in which we are interested in */
481 Output *new = get_output_by_id(id);
482 bool existing = (new != NULL);
484 new = scalloc(sizeof(Output));
486 new->primary = (primary && primary->output == id);
488 asprintf(&new->name, "%.*s",
489 xcb_randr_get_output_info_name_length(output),
490 xcb_randr_get_output_info_name(output));
492 DLOG("found output with name %s\n", new->name);
494 /* Even if no CRTC is used at the moment, we store the output so that
495 * we do not need to change the list ever again (we only update the
497 if (output->crtc == XCB_NONE) {
500 TAILQ_INSERT_HEAD(&outputs, new, outputs);
501 else TAILQ_INSERT_TAIL(&outputs, new, outputs);
502 } else if (new->active)
503 new->to_be_disabled = true;
507 xcb_randr_get_crtc_info_cookie_t icookie;
508 icookie = xcb_randr_get_crtc_info(conn, output->crtc, cts);
509 if ((crtc = xcb_randr_get_crtc_info_reply(conn, icookie, NULL)) == NULL) {
510 DLOG("Skipping output %s: could not get CRTC (%p)\n",
516 bool updated = update_if_necessary(&(new->rect.x), crtc->x) |
517 update_if_necessary(&(new->rect.y), crtc->y) |
518 update_if_necessary(&(new->rect.width), crtc->width) |
519 update_if_necessary(&(new->rect.height), crtc->height);
521 new->active = (new->rect.width != 0 && new->rect.height != 0);
523 DLOG("width/height 0/0, disabling output\n");
527 DLOG("mode: %dx%d+%d+%d\n", new->rect.width, new->rect.height,
528 new->rect.x, new->rect.y);
530 /* If we don’t need to change an existing output or if the output
531 * does not exist in the first place, the case is simple: we either
532 * need to insert the new output or we are done. */
533 if (!updated || !existing) {
536 TAILQ_INSERT_HEAD(&outputs, new, outputs);
537 else TAILQ_INSERT_TAIL(&outputs, new, outputs);
546 * (Re-)queries the outputs via RandR and stores them in the list of outputs.
549 void randr_query_outputs() {
550 Output *output, *other, *first;
551 xcb_randr_get_output_primary_cookie_t pcookie;
552 xcb_randr_get_screen_resources_current_cookie_t rcookie;
553 resources_reply *res;
555 /* timestamp of the configuration so that we get consistent replies to all
556 * requests (if the configuration changes between our different calls) */
559 /* an output is VGA-1, LVDS-1, etc. (usually physical video outputs) */
560 xcb_randr_output_t *randr_outputs;
565 /* Get screen resources (primary output, crtcs, outputs, modes) */
566 rcookie = xcb_randr_get_screen_resources_current(conn, root);
567 pcookie = xcb_randr_get_output_primary(conn, root);
569 if ((primary = xcb_randr_get_output_primary_reply(conn, pcookie, NULL)) == NULL)
570 ELOG("Could not get RandR primary output\n");
571 else DLOG("primary output is %08x\n", primary->output);
572 if ((res = xcb_randr_get_screen_resources_current_reply(conn, rcookie, NULL)) == NULL) {
576 cts = res->config_timestamp;
578 int len = xcb_randr_get_screen_resources_current_outputs_length(res);
579 randr_outputs = xcb_randr_get_screen_resources_current_outputs(res);
581 /* Request information for each output */
582 xcb_randr_get_output_info_cookie_t ocookie[len];
583 for (int i = 0; i < len; i++)
584 ocookie[i] = xcb_randr_get_output_info(conn, randr_outputs[i], cts);
586 /* Loop through all outputs available for this X11 screen */
587 for (int i = 0; i < len; i++) {
588 xcb_randr_get_output_info_reply_t *output;
590 if ((output = xcb_randr_get_output_info_reply(conn, ocookie[i], NULL)) == NULL)
593 handle_output(conn, randr_outputs[i], output, cts, res);
597 /* Check for clones, disable the clones and reduce the mode to the
598 * lowest common mode */
599 TAILQ_FOREACH(output, &outputs, outputs) {
600 if (!output->active || output->to_be_disabled)
602 DLOG("output %p / %s, position (%d, %d), checking for clones\n",
603 output, output->name, output->rect.x, output->rect.y);
606 other != TAILQ_END(&outputs);
607 other = TAILQ_NEXT(other, outputs)) {
608 if (other == output || !other->active || other->to_be_disabled)
611 if (other->rect.x != output->rect.x ||
612 other->rect.y != output->rect.y)
615 DLOG("output %p has the same position, his mode = %d x %d\n",
616 other, other->rect.width, other->rect.height);
617 uint32_t width = min(other->rect.width, output->rect.width);
618 uint32_t height = min(other->rect.height, output->rect.height);
620 if (update_if_necessary(&(output->rect.width), width) |
621 update_if_necessary(&(output->rect.height), height))
622 output->changed = true;
624 update_if_necessary(&(other->rect.width), width);
625 update_if_necessary(&(other->rect.height), height);
627 DLOG("disabling output %p (%s)\n", other, other->name);
628 other->to_be_disabled = true;
630 DLOG("new output mode %d x %d, other mode %d x %d\n",
631 output->rect.width, output->rect.height,
632 other->rect.width, other->rect.height);
636 /* Handle outputs which have a new mode or are disabled now (either
637 * because the user disabled them or because they are clones) */
638 TAILQ_FOREACH(output, &outputs, outputs) {
639 if (output->to_be_disabled) {
640 output->active = false;
641 DLOG("Output %s disabled, re-assigning workspaces/docks\n", output->name);
643 if ((first = get_first_output()) == NULL)
644 die("No usable outputs available\n");
646 /* TODO: refactor the following code into a nice function. maybe
647 * use an on_destroy callback which is implement differently for
648 * different container types (CT_CONTENT vs. CT_DOCKAREA)? */
649 Con *first_content = output_get_content(first->con);
651 if (output->con != NULL) {
652 /* We need to move the workspaces from the disappearing output to the first output */
653 /* 1: Get the con to focus next, if the disappearing ws is focused */
655 if (TAILQ_FIRST(&(croot->focus_head)) == output->con) {
656 DLOG("This output (%p) was focused! Getting next\n", output->con);
657 next = con_next_focused(output->con);
658 DLOG("next = %p\n", next);
661 /* 2: iterate through workspaces and re-assign them */
663 Con *old_content = output_get_content(output->con);
664 while (!TAILQ_EMPTY(&(old_content->nodes_head))) {
665 current = TAILQ_FIRST(&(old_content->nodes_head));
666 DLOG("Detaching current = %p / %s\n", current, current->name);
668 DLOG("Re-attaching current = %p / %s\n", current, current->name);
669 con_attach(current, first_content, false);
670 DLOG("Done, next\n");
672 DLOG("re-attached all workspaces\n");
675 DLOG("now focusing next = %p\n", next);
679 /* 3: move the dock clients to the first output */
681 TAILQ_FOREACH(child, &(output->con->nodes_head), nodes) {
682 if (child->type != CT_DOCKAREA)
684 DLOG("Handling dock con %p\n", child);
686 while (!TAILQ_EMPTY(&(child->nodes_head))) {
687 dock = TAILQ_FIRST(&(child->nodes_head));
690 nc = con_for_window(first->con, dock->window, &match);
691 DLOG("Moving dock client %p to nc %p\n", dock, nc);
693 DLOG("Re-attaching\n");
694 con_attach(dock, nc, false);
699 DLOG("destroying disappearing con %p\n", output->con);
700 tree_close(output->con, false, true);
701 DLOG("Done. Should be fine now\n");
705 output->to_be_disabled = false;
706 output->changed = false;
709 if (output->active && output->con == NULL) {
710 DLOG("Need to initialize a Con for output %s\n", output->name);
711 output_init_con(output);
712 output->changed = false;
715 if (output->changed) {
716 output_change_mode(conn, output);
717 output->changed = false;
721 if (TAILQ_EMPTY(&outputs)) {
722 ELOG("No outputs found via RandR, disabling\n");
726 ewmh_update_workarea();
729 /* Just go through each active output and associate one workspace */
730 TAILQ_FOREACH(output, &outputs, outputs) {
731 if (!output->active || output->current_workspace != NULL)
733 ws = get_first_workspace_for_output(output);
734 initialize_output(conn, output, ws);
738 /* Focus the primary screen, if possible */
739 TAILQ_FOREACH(output, &outputs, outputs) {
740 if (!output->primary || !output->con)
743 DLOG("Focusing primary output %s\n", output->name);
744 con_focus(con_descend_focused(output->con));
747 /* render_layout flushes */
755 * We have just established a connection to the X server and need the initial
756 * XRandR information to setup workspaces for each screen.
759 void randr_init(int *event_base) {
760 const xcb_query_extension_reply_t *extreply;
762 extreply = xcb_get_extension_data(conn, &xcb_randr_id);
763 if (!extreply->present)
765 else randr_query_outputs();
767 if (event_base != NULL)
768 *event_base = extreply->first_event;
770 xcb_randr_select_input(conn, root,
771 XCB_RANDR_NOTIFY_MASK_SCREEN_CHANGE |
772 XCB_RANDR_NOTIFY_MASK_OUTPUT_CHANGE |
773 XCB_RANDR_NOTIFY_MASK_CRTC_CHANGE |
774 XCB_RANDR_NOTIFY_MASK_OUTPUT_PROPERTY);