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 * For more information on RandR, please see the X.org RandR specification at
8 * http://cgit.freedesktop.org/xorg/proto/randrproto/tree/randrproto.txt
9 * (take your time to read it completely, it answers all questions).
15 #include <xcb/randr.h>
17 /* While a clean namespace is usually a pretty good thing, we really need
18 * to use shorter names than the whole xcb_randr_* default names. */
19 typedef xcb_randr_get_crtc_info_reply_t crtc_info;
20 typedef xcb_randr_get_screen_resources_current_reply_t resources_reply;
22 /* Pointer to the result of the query for primary output */
23 xcb_randr_get_output_primary_reply_t *primary;
25 /* Stores all outputs available in your current session. */
26 struct outputs_head outputs = TAILQ_HEAD_INITIALIZER(outputs);
28 static bool randr_disabled = false;
31 * Get a specific output by its internal X11 id. Used by randr_query_outputs
32 * to check if the output is new (only in the first scan) or if we are
36 static Output *get_output_by_id(xcb_randr_output_t id) {
38 TAILQ_FOREACH(output, &outputs, outputs)
46 * Returns the output with the given name if it is active (!) or NULL.
49 Output *get_output_by_name(const char *name) {
51 TAILQ_FOREACH(output, &outputs, outputs)
53 strcasecmp(output->name, name) == 0)
60 * Returns the first output which is active.
63 Output *get_first_output(void) {
66 TAILQ_FOREACH(output, &outputs, outputs)
74 * Returns the active (!) output which contains the coordinates x, y or NULL
75 * if there is no output which contains these coordinates.
78 Output *get_output_containing(int x, int y) {
80 TAILQ_FOREACH(output, &outputs, outputs) {
83 DLOG("comparing x=%d y=%d with x=%d and y=%d width %d height %d\n",
84 x, y, output->rect.x, output->rect.y, output->rect.width, output->rect.height);
85 if (x >= output->rect.x && x < (output->rect.x + output->rect.width) &&
86 y >= output->rect.y && y < (output->rect.y + output->rect.height))
94 * Gets the output which is the last one in the given direction, for example
95 * the output on the most bottom when direction == D_DOWN, the output most
96 * right when direction == D_RIGHT and so on.
98 * This function always returns a output.
101 Output *get_output_most(direction_t direction, Output *current) {
102 Output *output, *candidate = NULL;
104 TAILQ_FOREACH(output, &outputs, outputs) {
108 /* Repeated calls of WIN determine the winner of the comparison */
109 #define WIN(variable, condition) \
110 if (variable condition) { \
111 candidate = output; \
112 position = variable; \
116 if (((direction == D_UP) || (direction == D_DOWN)) &&
117 (current->rect.x != output->rect.x))
120 if (((direction == D_LEFT) || (direction == D_RIGHT)) &&
121 (current->rect.y != output->rect.y))
126 WIN(output->rect.y, <= position);
128 WIN(output->rect.y, >= position);
130 WIN(output->rect.x, <= position);
132 WIN(output->rect.x, >= position);
136 assert(candidate != NULL);
142 * Gets the output which is the next one in the given direction.
145 Output *get_output_next(direction_t direction, Output *current) {
146 Output *output, *candidate = NULL;
148 TAILQ_FOREACH(output, &outputs, outputs) {
152 if (((direction == D_UP) || (direction == D_DOWN)) &&
153 (current->rect.x != output->rect.x))
156 if (((direction == D_LEFT) || (direction == D_RIGHT)) &&
157 (current->rect.y != output->rect.y))
162 if (output->rect.y < current->rect.y &&
163 (!candidate || output->rect.y < candidate->rect.y))
167 if (output->rect.y > current->rect.y &&
168 (!candidate || output->rect.y > candidate->rect.y))
172 if (output->rect.x < current->rect.x &&
173 (!candidate || output->rect.x > candidate->rect.x))
177 if (output->rect.x > current->rect.x &&
178 (!candidate || output->rect.x < candidate->rect.x))
188 * Disables RandR support by creating exactly one output with the size of the
192 void disable_randr(xcb_connection_t *conn) {
193 DLOG("RandR extension unusable, disabling.\n");
195 Output *s = scalloc(sizeof(Output));
200 s->rect.width = root_screen->width_in_pixels;
201 s->rect.height = root_screen->height_in_pixels;
204 init_ws_for_output(s, output_get_content(s->con));
206 TAILQ_INSERT_TAIL(&outputs, s, outputs);
208 randr_disabled = true;
212 * Initializes a CT_OUTPUT Con (searches existing ones from inplace restart
213 * before) to use for the given Output.
216 void output_init_con(Output *output) {
217 Con *con = NULL, *current;
220 DLOG("init_con for output %s\n", output->name);
222 /* Search for a Con with that name directly below the root node. There
223 * might be one from a restored layout. */
224 TAILQ_FOREACH(current, &(croot->nodes_head), nodes) {
225 if (strcmp(current->name, output->name) != 0)
230 DLOG("Using existing con %p / %s\n", con, con->name);
235 con = con_new(croot, NULL);
237 con->name = sstrdup(output->name);
238 con->type = CT_OUTPUT;
239 con->layout = L_OUTPUT;
240 con_fix_percent(croot);
242 con->rect = output->rect;
246 sasprintf(&name, "[i3 con] output %s", con->name);
247 x_set_name(con, name);
251 DLOG("Not adding workspace, this was a reused con\n");
255 DLOG("Changing layout, adding top/bottom dockarea\n");
256 Con *topdock = con_new(NULL, NULL);
257 topdock->type = CT_DOCKAREA;
258 topdock->layout = L_DOCKAREA;
259 /* this container swallows dock clients */
260 Match *match = scalloc(sizeof(Match));
262 match->dock = M_DOCK_TOP;
263 match->insert_where = M_BELOW;
264 TAILQ_INSERT_TAIL(&(topdock->swallow_head), match, matches);
267 topdock->name = sstrdup("topdock");
269 sasprintf(&name, "[i3 con] top dockarea %s", con->name);
270 x_set_name(topdock, name);
273 con_attach(topdock, con, false);
275 /* content container */
277 DLOG("adding main content container\n");
278 Con *content = con_new(NULL, NULL);
279 content->type = CT_CON;
280 content->layout = L_SPLITH;
282 content->name = sstrdup("content");
284 sasprintf(&name, "[i3 con] content %s", con->name);
285 x_set_name(content, name);
287 con_attach(content, con, false);
289 /* bottom dock container */
290 Con *bottomdock = con_new(NULL, NULL);
291 bottomdock->type = CT_DOCKAREA;
292 bottomdock->layout = L_DOCKAREA;
293 /* this container swallows dock clients */
294 match = scalloc(sizeof(Match));
296 match->dock = M_DOCK_BOTTOM;
297 match->insert_where = M_BELOW;
298 TAILQ_INSERT_TAIL(&(bottomdock->swallow_head), match, matches);
300 FREE(bottomdock->name);
301 bottomdock->name = sstrdup("bottomdock");
303 sasprintf(&name, "[i3 con] bottom dockarea %s", con->name);
304 x_set_name(bottomdock, name);
307 con_attach(bottomdock, con, false);
311 * Initializes at least one workspace for this output, trying the following
312 * steps until there is at least one workspace:
314 * • Move existing workspaces, which are assigned to be on the given output, to
316 * • Create the first assigned workspace for this output.
317 * • Create the first unused workspace.
320 void init_ws_for_output(Output *output, Con *content) {
321 /* go through all assignments and move the existing workspaces to this output */
322 struct Workspace_Assignment *assignment;
323 TAILQ_FOREACH(assignment, &ws_assignments, ws_assignments) {
324 if (strcmp(assignment->output, output->name) != 0)
327 /* check if this workspace actually exists */
328 Con *workspace = NULL, *out;
329 TAILQ_FOREACH(out, &(croot->nodes_head), nodes)
330 GREP_FIRST(workspace, output_get_content(out),
331 !strcasecmp(child->name, assignment->name));
332 if (workspace == NULL)
335 /* check that this workspace is not already attached (that means the
336 * user configured this assignment twice) */
337 Con *workspace_out = con_get_output(workspace);
338 if (workspace_out == output->con) {
339 LOG("Workspace \"%s\" assigned to output \"%s\", but it is already "
340 "there. Do you have two assignment directives for the same "
341 "workspace in your configuration file?\n",
342 workspace->name, output->name);
346 /* if so, move it over */
347 LOG("Moving workspace \"%s\" from output \"%s\" to \"%s\" due to assignment\n",
348 workspace->name, workspace_out->name, output->name);
350 /* if the workspace is currently visible on that output, we need to
351 * switch to a different workspace - otherwise the output would end up
352 * with no active workspace */
353 bool visible = workspace_is_visible(workspace);
354 Con *previous = NULL;
355 if (visible && (previous = TAILQ_NEXT(workspace, focused))) {
356 LOG("Switching to previously used workspace \"%s\" on output \"%s\"\n",
357 previous->name, workspace_out->name);
358 workspace_show(previous);
361 con_detach(workspace);
362 con_attach(workspace, content, false);
364 /* In case the workspace we just moved was visible but there was no
365 * other workspace to switch to, we need to initialize the source
367 if (visible && previous == NULL) {
368 LOG("There is no workspace left on \"%s\", re-initializing\n",
369 workspace_out->name);
370 init_ws_for_output(get_output_by_name(workspace_out->name),
371 output_get_content(workspace_out));
372 DLOG("Done re-initializing, continuing with \"%s\"\n", output->name);
376 /* if a workspace exists, we are done now */
377 if (!TAILQ_EMPTY(&(content->nodes_head))) {
378 /* ensure that one of the workspaces is actually visible (in fullscreen
379 * mode), if they were invisible before, this might not be the case. */
381 GREP_FIRST(visible, content, child->fullscreen_mode == CF_OUTPUT);
383 visible = TAILQ_FIRST(&(content->nodes_head));
385 workspace_show(visible);
390 /* otherwise, we create the first assigned ws for this output */
391 TAILQ_FOREACH(assignment, &ws_assignments, ws_assignments) {
392 if (strcmp(assignment->output, output->name) != 0)
395 LOG("Initializing first assigned workspace \"%s\" for output \"%s\"\n",
396 assignment->name, assignment->output);
398 workspace_show_by_name(assignment->name);
402 /* if there is still no workspace, we create the first free workspace */
403 DLOG("Now adding a workspace\n");
404 Con *ws = create_workspace_on_output(output, content);
406 /* TODO: Set focus in main.c */
411 * This function needs to be called when changing the mode of an output when
412 * it already has some workspaces (or a bar window) assigned.
414 * It reconfigures the bar window for the new mode, copies the new rect into
415 * each workspace on this output and forces all windows on the affected
416 * workspaces to be reconfigured.
418 * It is necessary to call render_layout() afterwards.
421 static void output_change_mode(xcb_connection_t *conn, Output *output) {
422 DLOG("Output mode changed, updating rect\n");
423 assert(output->con != NULL);
424 output->con->rect = output->rect;
426 Con *content, *workspace, *child;
428 /* Point content to the container of the workspaces */
429 content = output_get_content(output->con);
431 /* Fix the position of all floating windows on this output.
432 * The 'rect' of each workspace will be updated in src/render.c. */
433 TAILQ_FOREACH(workspace, &(content->nodes_head), nodes) {
434 TAILQ_FOREACH(child, &(workspace->floating_head), floating_windows) {
435 floating_fix_coordinates(child, &(workspace->rect), &(output->con->rect));
439 /* If default_orientation is NO_ORIENTATION, we change the orientation of
440 * the workspaces and their childs depending on output resolution. This is
441 * only done for workspaces with maximum one child. */
442 if (config.default_orientation == NO_ORIENTATION) {
443 TAILQ_FOREACH(workspace, &(content->nodes_head), nodes) {
444 /* Workspaces with more than one child are left untouched because
445 * we do not want to change an existing layout. */
446 if (con_num_children(workspace) > 1)
449 workspace->layout = (output->rect.height > output->rect.width) ? L_SPLITV : L_SPLITH;
450 DLOG("Setting workspace [%d,%s]'s layout to %d.\n", workspace->num, workspace->name, workspace->layout);
451 if ((child = TAILQ_FIRST(&(workspace->nodes_head)))) {
452 child->layout = workspace->layout;
453 DLOG("Setting child [%d,%s]'s layout to %d.\n", child->num, child->name, child->layout);
460 * Gets called by randr_query_outputs() for each output. The function adds new
461 * outputs to the list of outputs, checks if the mode of existing outputs has
462 * been changed or if an existing output has been disabled. It will then change
463 * either the "changed" or the "to_be_deleted" flag of the output, if
467 static void handle_output(xcb_connection_t *conn, xcb_randr_output_t id,
468 xcb_randr_get_output_info_reply_t *output,
469 xcb_timestamp_t cts, resources_reply *res) {
470 /* each CRT controller has a position in which we are interested in */
473 Output *new = get_output_by_id(id);
474 bool existing = (new != NULL);
476 new = scalloc(sizeof(Output));
478 new->primary = (primary && primary->output == id);
480 sasprintf(&new->name, "%.*s",
481 xcb_randr_get_output_info_name_length(output),
482 xcb_randr_get_output_info_name(output));
484 DLOG("found output with name %s\n", new->name);
486 /* Even if no CRTC is used at the moment, we store the output so that
487 * we do not need to change the list ever again (we only update the
489 if (output->crtc == XCB_NONE) {
492 TAILQ_INSERT_HEAD(&outputs, new, outputs);
493 else TAILQ_INSERT_TAIL(&outputs, new, outputs);
494 } else if (new->active)
495 new->to_be_disabled = true;
499 xcb_randr_get_crtc_info_cookie_t icookie;
500 icookie = xcb_randr_get_crtc_info(conn, output->crtc, cts);
501 if ((crtc = xcb_randr_get_crtc_info_reply(conn, icookie, NULL)) == NULL) {
502 DLOG("Skipping output %s: could not get CRTC (%p)\n",
508 bool updated = update_if_necessary(&(new->rect.x), crtc->x) |
509 update_if_necessary(&(new->rect.y), crtc->y) |
510 update_if_necessary(&(new->rect.width), crtc->width) |
511 update_if_necessary(&(new->rect.height), crtc->height);
513 new->active = (new->rect.width != 0 && new->rect.height != 0);
515 DLOG("width/height 0/0, disabling output\n");
519 DLOG("mode: %dx%d+%d+%d\n", new->rect.width, new->rect.height,
520 new->rect.x, new->rect.y);
522 /* If we don’t need to change an existing output or if the output
523 * does not exist in the first place, the case is simple: we either
524 * need to insert the new output or we are done. */
525 if (!updated || !existing) {
528 TAILQ_INSERT_HEAD(&outputs, new, outputs);
529 else TAILQ_INSERT_TAIL(&outputs, new, outputs);
538 * (Re-)queries the outputs via RandR and stores them in the list of outputs.
541 void randr_query_outputs(void) {
542 Output *output, *other, *first;
543 xcb_randr_get_output_primary_cookie_t pcookie;
544 xcb_randr_get_screen_resources_current_cookie_t rcookie;
545 resources_reply *res;
547 /* timestamp of the configuration so that we get consistent replies to all
548 * requests (if the configuration changes between our different calls) */
551 /* an output is VGA-1, LVDS-1, etc. (usually physical video outputs) */
552 xcb_randr_output_t *randr_outputs;
557 /* Get screen resources (primary output, crtcs, outputs, modes) */
558 rcookie = xcb_randr_get_screen_resources_current(conn, root);
559 pcookie = xcb_randr_get_output_primary(conn, root);
561 if ((primary = xcb_randr_get_output_primary_reply(conn, pcookie, NULL)) == NULL)
562 ELOG("Could not get RandR primary output\n");
563 else DLOG("primary output is %08x\n", primary->output);
564 if ((res = xcb_randr_get_screen_resources_current_reply(conn, rcookie, NULL)) == NULL) {
568 cts = res->config_timestamp;
570 int len = xcb_randr_get_screen_resources_current_outputs_length(res);
571 randr_outputs = xcb_randr_get_screen_resources_current_outputs(res);
573 /* Request information for each output */
574 xcb_randr_get_output_info_cookie_t ocookie[len];
575 for (int i = 0; i < len; i++)
576 ocookie[i] = xcb_randr_get_output_info(conn, randr_outputs[i], cts);
578 /* Loop through all outputs available for this X11 screen */
579 for (int i = 0; i < len; i++) {
580 xcb_randr_get_output_info_reply_t *output;
582 if ((output = xcb_randr_get_output_info_reply(conn, ocookie[i], NULL)) == NULL)
585 handle_output(conn, randr_outputs[i], output, cts, res);
589 /* Check for clones, disable the clones and reduce the mode to the
590 * lowest common mode */
591 TAILQ_FOREACH(output, &outputs, outputs) {
592 if (!output->active || output->to_be_disabled)
594 DLOG("output %p / %s, position (%d, %d), checking for clones\n",
595 output, output->name, output->rect.x, output->rect.y);
598 other != TAILQ_END(&outputs);
599 other = TAILQ_NEXT(other, outputs)) {
600 if (other == output || !other->active || other->to_be_disabled)
603 if (other->rect.x != output->rect.x ||
604 other->rect.y != output->rect.y)
607 DLOG("output %p has the same position, his mode = %d x %d\n",
608 other, other->rect.width, other->rect.height);
609 uint32_t width = min(other->rect.width, output->rect.width);
610 uint32_t height = min(other->rect.height, output->rect.height);
612 if (update_if_necessary(&(output->rect.width), width) |
613 update_if_necessary(&(output->rect.height), height))
614 output->changed = true;
616 update_if_necessary(&(other->rect.width), width);
617 update_if_necessary(&(other->rect.height), height);
619 DLOG("disabling output %p (%s)\n", other, other->name);
620 other->to_be_disabled = true;
622 DLOG("new output mode %d x %d, other mode %d x %d\n",
623 output->rect.width, output->rect.height,
624 other->rect.width, other->rect.height);
628 /* Ensure that all outputs which are active also have a con. This is
629 * necessary because in the next step, a clone might get disabled. Example:
630 * LVDS1 active, VGA1 gets activated as a clone of LVDS1 (has no con).
631 * LVDS1 gets disabled. */
632 TAILQ_FOREACH(output, &outputs, outputs) {
633 if (output->active && output->con == NULL) {
634 DLOG("Need to initialize a Con for output %s\n", output->name);
635 output_init_con(output);
636 output->changed = false;
640 /* Handle outputs which have a new mode or are disabled now (either
641 * because the user disabled them or because they are clones) */
642 TAILQ_FOREACH(output, &outputs, outputs) {
643 if (output->to_be_disabled) {
644 output->active = false;
645 DLOG("Output %s disabled, re-assigning workspaces/docks\n", output->name);
647 if ((first = get_first_output()) == NULL)
648 die("No usable outputs available\n");
650 /* TODO: refactor the following code into a nice function. maybe
651 * use an on_destroy callback which is implement differently for
652 * different container types (CT_CONTENT vs. CT_DOCKAREA)? */
653 Con *first_content = output_get_content(first->con);
655 if (output->con != NULL) {
656 /* We need to move the workspaces from the disappearing output to the first output */
657 /* 1: Get the con to focus next, if the disappearing ws is focused */
659 if (TAILQ_FIRST(&(croot->focus_head)) == output->con) {
660 DLOG("This output (%p) was focused! Getting next\n", output->con);
662 DLOG("next = %p\n", next);
665 /* 2: iterate through workspaces and re-assign them, fixing the coordinates
666 * of floating containers as we go */
668 Con *old_content = output_get_content(output->con);
669 while (!TAILQ_EMPTY(&(old_content->nodes_head))) {
670 current = TAILQ_FIRST(&(old_content->nodes_head));
671 if (current != next && TAILQ_EMPTY(&(current->focus_head))) {
672 /* the workspace is empty and not focused, get rid of it */
673 DLOG("Getting rid of current = %p / %s (empty, unfocused)\n", current, current->name);
674 tree_close(current, DONT_KILL_WINDOW, false, false);
677 DLOG("Detaching current = %p / %s\n", current, current->name);
679 DLOG("Re-attaching current = %p / %s\n", current, current->name);
680 con_attach(current, first_content, false);
681 DLOG("Fixing the coordinates of floating containers\n");
683 TAILQ_FOREACH(floating_con, &(current->floating_head), floating_windows)
684 floating_fix_coordinates(floating_con, &(old_content->rect), &(first_content->rect));
685 DLOG("Done, next\n");
687 DLOG("re-attached all workspaces\n");
690 DLOG("now focusing next = %p\n", next);
692 workspace_show(con_get_workspace(next));
695 /* 3: move the dock clients to the first output */
697 TAILQ_FOREACH(child, &(output->con->nodes_head), nodes) {
698 if (child->type != CT_DOCKAREA)
700 DLOG("Handling dock con %p\n", child);
702 while (!TAILQ_EMPTY(&(child->nodes_head))) {
703 dock = TAILQ_FIRST(&(child->nodes_head));
706 nc = con_for_window(first->con, dock->window, &match);
707 DLOG("Moving dock client %p to nc %p\n", dock, nc);
709 DLOG("Re-attaching\n");
710 con_attach(dock, nc, false);
715 DLOG("destroying disappearing con %p\n", output->con);
716 tree_close(output->con, DONT_KILL_WINDOW, true, false);
717 DLOG("Done. Should be fine now\n");
721 output->to_be_disabled = false;
722 output->changed = false;
725 if (output->changed) {
726 output_change_mode(conn, output);
727 output->changed = false;
731 if (TAILQ_EMPTY(&outputs)) {
732 ELOG("No outputs found via RandR, disabling\n");
736 /* Just go through each active output and assign one workspace */
737 TAILQ_FOREACH(output, &outputs, outputs) {
740 Con *content = output_get_content(output->con);
741 if (!TAILQ_EMPTY(&(content->nodes_head)))
743 DLOG("Should add ws for output %s\n", output->name);
744 init_ws_for_output(output, content);
747 /* Focus the primary screen, if possible */
748 TAILQ_FOREACH(output, &outputs, outputs) {
749 if (!output->primary || !output->con)
752 DLOG("Focusing primary output %s\n", output->name);
753 con_focus(con_descend_focused(output->con));
756 /* render_layout flushes */
764 * We have just established a connection to the X server and need the initial
765 * XRandR information to setup workspaces for each screen.
768 void randr_init(int *event_base) {
769 const xcb_query_extension_reply_t *extreply;
771 extreply = xcb_get_extension_data(conn, &xcb_randr_id);
772 if (!extreply->present) {
775 } else randr_query_outputs();
777 if (event_base != NULL)
778 *event_base = extreply->first_event;
780 xcb_randr_select_input(conn, root,
781 XCB_RANDR_NOTIFY_MASK_SCREEN_CHANGE |
782 XCB_RANDR_NOTIFY_MASK_OUTPUT_CHANGE |
783 XCB_RANDR_NOTIFY_MASK_CRTC_CHANGE |
784 XCB_RANDR_NOTIFY_MASK_OUTPUT_PROPERTY);