3 * vim:ts=4:sw=4:expandtab
5 * i3 - an improved dynamic tiling window manager
6 * © 2009-2012 Michael Stapelberg and contributors (see also: LICENSE)
8 * For more information on RandR, please see the X.org RandR specification at
9 * http://cgit.freedesktop.org/xorg/proto/randrproto/tree/randrproto.txt
10 * (take your time to read it completely, it answers all questions).
16 #include <xcb/randr.h>
18 /* While a clean namespace is usually a pretty good thing, we really need
19 * to use shorter names than the whole xcb_randr_* default names. */
20 typedef xcb_randr_get_crtc_info_reply_t crtc_info;
21 typedef xcb_randr_get_screen_resources_current_reply_t resources_reply;
23 /* Pointer to the result of the query for primary output */
24 xcb_randr_get_output_primary_reply_t *primary;
26 /* Stores all outputs available in your current session. */
27 struct outputs_head outputs = TAILQ_HEAD_INITIALIZER(outputs);
29 static bool randr_disabled = false;
32 * Get a specific output by its internal X11 id. Used by randr_query_outputs
33 * to check if the output is new (only in the first scan) or if we are
37 static Output *get_output_by_id(xcb_randr_output_t id) {
39 TAILQ_FOREACH(output, &outputs, outputs)
47 * Returns the output with the given name if it is active (!) or NULL.
50 Output *get_output_by_name(const char *name) {
52 TAILQ_FOREACH(output, &outputs, outputs)
54 strcasecmp(output->name, name) == 0)
61 * Returns the first output which is active.
64 Output *get_first_output(void) {
67 TAILQ_FOREACH(output, &outputs, outputs)
75 * Returns the active (!) output which contains the coordinates x, y or NULL
76 * if there is no output which contains these coordinates.
79 Output *get_output_containing(int x, int y) {
81 TAILQ_FOREACH(output, &outputs, outputs) {
84 DLOG("comparing x=%d y=%d with x=%d and y=%d width %d height %d\n",
85 x, y, output->rect.x, output->rect.y, output->rect.width, output->rect.height);
86 if (x >= output->rect.x && x < (output->rect.x + output->rect.width) &&
87 y >= output->rect.y && y < (output->rect.y + output->rect.height))
95 * Gets the output which is the last one in the given direction, for example
96 * the output on the most bottom when direction == D_DOWN, the output most
97 * right when direction == D_RIGHT and so on.
99 * This function always returns a output.
102 Output *get_output_most(direction_t direction, Output *current) {
103 Output *output, *candidate = NULL;
105 TAILQ_FOREACH(output, &outputs, outputs) {
109 /* Repeated calls of WIN determine the winner of the comparison */
110 #define WIN(variable, condition) \
111 if (variable condition) { \
112 candidate = output; \
113 position = variable; \
117 if (((direction == D_UP) || (direction == D_DOWN)) &&
118 (current->rect.x != output->rect.x))
121 if (((direction == D_LEFT) || (direction == D_RIGHT)) &&
122 (current->rect.y != output->rect.y))
127 WIN(output->rect.y, <= position);
129 WIN(output->rect.y, >= position);
131 WIN(output->rect.x, <= position);
133 WIN(output->rect.x, >= position);
137 assert(candidate != NULL);
143 * Gets the output which is the next one in the given direction.
146 Output *get_output_next(direction_t direction, Output *current) {
147 Output *output, *candidate = NULL;
149 TAILQ_FOREACH(output, &outputs, outputs) {
153 if (((direction == D_UP) || (direction == D_DOWN)) &&
154 (current->rect.x != output->rect.x))
157 if (((direction == D_LEFT) || (direction == D_RIGHT)) &&
158 (current->rect.y != output->rect.y))
163 if (output->rect.y < current->rect.y &&
164 (!candidate || output->rect.y < candidate->rect.y))
168 if (output->rect.y > current->rect.y &&
169 (!candidate || output->rect.y > candidate->rect.y))
173 if (output->rect.x < current->rect.x &&
174 (!candidate || output->rect.x > candidate->rect.x))
178 if (output->rect.x > current->rect.x &&
179 (!candidate || output->rect.x < candidate->rect.x))
189 * Disables RandR support by creating exactly one output with the size of the
193 void disable_randr(xcb_connection_t *conn) {
194 DLOG("RandR extension unusable, disabling.\n");
196 Output *s = scalloc(sizeof(Output));
201 s->rect.width = root_screen->width_in_pixels;
202 s->rect.height = root_screen->height_in_pixels;
205 init_ws_for_output(s, output_get_content(s->con));
207 TAILQ_INSERT_TAIL(&outputs, s, outputs);
209 randr_disabled = true;
213 * Initializes a CT_OUTPUT Con (searches existing ones from inplace restart
214 * before) to use for the given Output.
217 void output_init_con(Output *output) {
218 Con *con = NULL, *current;
221 DLOG("init_con for output %s\n", output->name);
223 /* Search for a Con with that name directly below the root node. There
224 * might be one from a restored layout. */
225 TAILQ_FOREACH(current, &(croot->nodes_head), nodes) {
226 if (strcmp(current->name, output->name) != 0)
231 DLOG("Using existing con %p / %s\n", con, con->name);
236 con = con_new(croot, NULL);
238 con->name = sstrdup(output->name);
239 con->type = CT_OUTPUT;
240 con->layout = L_OUTPUT;
241 con_fix_percent(croot);
243 con->rect = output->rect;
247 sasprintf(&name, "[i3 con] output %s", con->name);
248 x_set_name(con, name);
252 DLOG("Not adding workspace, this was a reused con\n");
256 DLOG("Changing layout, adding top/bottom dockarea\n");
257 Con *topdock = con_new(NULL, NULL);
258 topdock->type = CT_DOCKAREA;
259 topdock->layout = L_DOCKAREA;
260 /* this container swallows dock clients */
261 Match *match = scalloc(sizeof(Match));
263 match->dock = M_DOCK_TOP;
264 match->insert_where = M_BELOW;
265 TAILQ_INSERT_TAIL(&(topdock->swallow_head), match, matches);
268 topdock->name = sstrdup("topdock");
270 sasprintf(&name, "[i3 con] top dockarea %s", con->name);
271 x_set_name(topdock, name);
274 con_attach(topdock, con, false);
276 /* content container */
278 DLOG("adding main content container\n");
279 Con *content = con_new(NULL, NULL);
280 content->type = CT_CON;
281 content->layout = L_SPLITH;
283 content->name = sstrdup("content");
285 sasprintf(&name, "[i3 con] content %s", con->name);
286 x_set_name(content, name);
288 con_attach(content, con, false);
290 /* bottom dock container */
291 Con *bottomdock = con_new(NULL, NULL);
292 bottomdock->type = CT_DOCKAREA;
293 bottomdock->layout = L_DOCKAREA;
294 /* this container swallows dock clients */
295 match = scalloc(sizeof(Match));
297 match->dock = M_DOCK_BOTTOM;
298 match->insert_where = M_BELOW;
299 TAILQ_INSERT_TAIL(&(bottomdock->swallow_head), match, matches);
301 FREE(bottomdock->name);
302 bottomdock->name = sstrdup("bottomdock");
304 sasprintf(&name, "[i3 con] bottom dockarea %s", con->name);
305 x_set_name(bottomdock, name);
308 con_attach(bottomdock, con, false);
312 * Initializes at least one workspace for this output, trying the following
313 * steps until there is at least one workspace:
315 * • Move existing workspaces, which are assigned to be on the given output, to
317 * • Create the first assigned workspace for this output.
318 * • Create the first unused workspace.
321 void init_ws_for_output(Output *output, Con *content) {
322 /* go through all assignments and move the existing workspaces to this output */
323 struct Workspace_Assignment *assignment;
324 TAILQ_FOREACH(assignment, &ws_assignments, ws_assignments) {
325 if (strcmp(assignment->output, output->name) != 0)
328 /* check if this workspace actually exists */
329 Con *workspace = NULL, *out;
330 TAILQ_FOREACH(out, &(croot->nodes_head), nodes)
331 GREP_FIRST(workspace, output_get_content(out),
332 !strcasecmp(child->name, assignment->name));
333 if (workspace == NULL)
336 /* check that this workspace is not already attached (that means the
337 * user configured this assignment twice) */
338 Con *workspace_out = con_get_output(workspace);
339 if (workspace_out == output->con) {
340 LOG("Workspace \"%s\" assigned to output \"%s\", but it is already "
341 "there. Do you have two assignment directives for the same "
342 "workspace in your configuration file?\n",
343 workspace->name, output->name);
347 /* if so, move it over */
348 LOG("Moving workspace \"%s\" from output \"%s\" to \"%s\" due to assignment\n",
349 workspace->name, workspace_out->name, output->name);
351 /* if the workspace is currently visible on that output, we need to
352 * switch to a different workspace - otherwise the output would end up
353 * with no active workspace */
354 bool visible = workspace_is_visible(workspace);
355 Con *previous = NULL;
356 if (visible && (previous = TAILQ_NEXT(workspace, focused))) {
357 LOG("Switching to previously used workspace \"%s\" on output \"%s\"\n",
358 previous->name, workspace_out->name);
359 workspace_show(previous);
362 /* Render the output on which the workspace was to get correct Rects.
363 * Then, we need to work with the "content" container, since we cannot
364 * be sure that the workspace itself was rendered at all (in case it’s
365 * invisible, it won’t be rendered). */
366 render_con(workspace_out, false);
367 Con *ws_out_content = output_get_content(workspace_out);
370 TAILQ_FOREACH(floating_con, &(workspace->floating_head), floating_windows)
371 /* NB: We use output->con here because content is not yet rendered,
372 * so it has a rect of {0, 0, 0, 0}. */
373 floating_fix_coordinates(floating_con, &(ws_out_content->rect), &(output->con->rect));
375 con_detach(workspace);
376 con_attach(workspace, content, false);
378 /* In case the workspace we just moved was visible but there was no
379 * other workspace to switch to, we need to initialize the source
381 if (visible && previous == NULL) {
382 LOG("There is no workspace left on \"%s\", re-initializing\n",
383 workspace_out->name);
384 init_ws_for_output(get_output_by_name(workspace_out->name),
385 output_get_content(workspace_out));
386 DLOG("Done re-initializing, continuing with \"%s\"\n", output->name);
390 /* if a workspace exists, we are done now */
391 if (!TAILQ_EMPTY(&(content->nodes_head))) {
392 /* ensure that one of the workspaces is actually visible (in fullscreen
393 * mode), if they were invisible before, this might not be the case. */
395 GREP_FIRST(visible, content, child->fullscreen_mode == CF_OUTPUT);
397 visible = TAILQ_FIRST(&(content->nodes_head));
399 workspace_show(visible);
404 /* otherwise, we create the first assigned ws for this output */
405 TAILQ_FOREACH(assignment, &ws_assignments, ws_assignments) {
406 if (strcmp(assignment->output, output->name) != 0)
409 LOG("Initializing first assigned workspace \"%s\" for output \"%s\"\n",
410 assignment->name, assignment->output);
412 workspace_show_by_name(assignment->name);
416 /* if there is still no workspace, we create the first free workspace */
417 DLOG("Now adding a workspace\n");
418 Con *ws = create_workspace_on_output(output, content);
420 /* TODO: Set focus in main.c */
425 * This function needs to be called when changing the mode of an output when
426 * it already has some workspaces (or a bar window) assigned.
428 * It reconfigures the bar window for the new mode, copies the new rect into
429 * each workspace on this output and forces all windows on the affected
430 * workspaces to be reconfigured.
432 * It is necessary to call render_layout() afterwards.
435 static void output_change_mode(xcb_connection_t *conn, Output *output) {
436 DLOG("Output mode changed, updating rect\n");
437 assert(output->con != NULL);
438 output->con->rect = output->rect;
440 Con *content, *workspace, *child;
442 /* Point content to the container of the workspaces */
443 content = output_get_content(output->con);
445 /* Fix the position of all floating windows on this output.
446 * The 'rect' of each workspace will be updated in src/render.c. */
447 TAILQ_FOREACH(workspace, &(content->nodes_head), nodes) {
448 TAILQ_FOREACH(child, &(workspace->floating_head), floating_windows) {
449 floating_fix_coordinates(child, &(workspace->rect), &(output->con->rect));
453 /* If default_orientation is NO_ORIENTATION, we change the orientation of
454 * the workspaces and their childs depending on output resolution. This is
455 * only done for workspaces with maximum one child. */
456 if (config.default_orientation == NO_ORIENTATION) {
457 TAILQ_FOREACH(workspace, &(content->nodes_head), nodes) {
458 /* Workspaces with more than one child are left untouched because
459 * we do not want to change an existing layout. */
460 if (con_num_children(workspace) > 1)
463 workspace->layout = (output->rect.height > output->rect.width) ? L_SPLITV : L_SPLITH;
464 DLOG("Setting workspace [%d,%s]'s layout to %d.\n", workspace->num, workspace->name, workspace->layout);
465 if ((child = TAILQ_FIRST(&(workspace->nodes_head)))) {
466 child->layout = workspace->layout;
467 DLOG("Setting child [%d,%s]'s layout to %d.\n", child->num, child->name, child->layout);
474 * Gets called by randr_query_outputs() for each output. The function adds new
475 * outputs to the list of outputs, checks if the mode of existing outputs has
476 * been changed or if an existing output has been disabled. It will then change
477 * either the "changed" or the "to_be_deleted" flag of the output, if
481 static void handle_output(xcb_connection_t *conn, xcb_randr_output_t id,
482 xcb_randr_get_output_info_reply_t *output,
483 xcb_timestamp_t cts, resources_reply *res) {
484 /* each CRT controller has a position in which we are interested in */
487 Output *new = get_output_by_id(id);
488 bool existing = (new != NULL);
490 new = scalloc(sizeof(Output));
492 new->primary = (primary && primary->output == id);
494 sasprintf(&new->name, "%.*s",
495 xcb_randr_get_output_info_name_length(output),
496 xcb_randr_get_output_info_name(output));
498 DLOG("found output with name %s\n", new->name);
500 /* Even if no CRTC is used at the moment, we store the output so that
501 * we do not need to change the list ever again (we only update the
503 if (output->crtc == XCB_NONE) {
506 TAILQ_INSERT_HEAD(&outputs, new, outputs);
507 else TAILQ_INSERT_TAIL(&outputs, new, outputs);
508 } else if (new->active)
509 new->to_be_disabled = true;
513 xcb_randr_get_crtc_info_cookie_t icookie;
514 icookie = xcb_randr_get_crtc_info(conn, output->crtc, cts);
515 if ((crtc = xcb_randr_get_crtc_info_reply(conn, icookie, NULL)) == NULL) {
516 DLOG("Skipping output %s: could not get CRTC (%p)\n",
522 bool updated = update_if_necessary(&(new->rect.x), crtc->x) |
523 update_if_necessary(&(new->rect.y), crtc->y) |
524 update_if_necessary(&(new->rect.width), crtc->width) |
525 update_if_necessary(&(new->rect.height), crtc->height);
527 new->active = (new->rect.width != 0 && new->rect.height != 0);
529 DLOG("width/height 0/0, disabling output\n");
533 DLOG("mode: %dx%d+%d+%d\n", new->rect.width, new->rect.height,
534 new->rect.x, new->rect.y);
536 /* If we don’t need to change an existing output or if the output
537 * does not exist in the first place, the case is simple: we either
538 * need to insert the new output or we are done. */
539 if (!updated || !existing) {
542 TAILQ_INSERT_HEAD(&outputs, new, outputs);
543 else TAILQ_INSERT_TAIL(&outputs, new, outputs);
552 * (Re-)queries the outputs via RandR and stores them in the list of outputs.
555 void randr_query_outputs(void) {
556 Output *output, *other, *first;
557 xcb_randr_get_output_primary_cookie_t pcookie;
558 xcb_randr_get_screen_resources_current_cookie_t rcookie;
559 resources_reply *res;
561 /* timestamp of the configuration so that we get consistent replies to all
562 * requests (if the configuration changes between our different calls) */
565 /* an output is VGA-1, LVDS-1, etc. (usually physical video outputs) */
566 xcb_randr_output_t *randr_outputs;
571 /* Get screen resources (primary output, crtcs, outputs, modes) */
572 rcookie = xcb_randr_get_screen_resources_current(conn, root);
573 pcookie = xcb_randr_get_output_primary(conn, root);
575 if ((primary = xcb_randr_get_output_primary_reply(conn, pcookie, NULL)) == NULL)
576 ELOG("Could not get RandR primary output\n");
577 else DLOG("primary output is %08x\n", primary->output);
578 if ((res = xcb_randr_get_screen_resources_current_reply(conn, rcookie, NULL)) == NULL) {
582 cts = res->config_timestamp;
584 int len = xcb_randr_get_screen_resources_current_outputs_length(res);
585 randr_outputs = xcb_randr_get_screen_resources_current_outputs(res);
587 /* Request information for each output */
588 xcb_randr_get_output_info_cookie_t ocookie[len];
589 for (int i = 0; i < len; i++)
590 ocookie[i] = xcb_randr_get_output_info(conn, randr_outputs[i], cts);
592 /* Loop through all outputs available for this X11 screen */
593 for (int i = 0; i < len; i++) {
594 xcb_randr_get_output_info_reply_t *output;
596 if ((output = xcb_randr_get_output_info_reply(conn, ocookie[i], NULL)) == NULL)
599 handle_output(conn, randr_outputs[i], output, cts, res);
603 /* Check for clones, disable the clones and reduce the mode to the
604 * lowest common mode */
605 TAILQ_FOREACH(output, &outputs, outputs) {
606 if (!output->active || output->to_be_disabled)
608 DLOG("output %p / %s, position (%d, %d), checking for clones\n",
609 output, output->name, output->rect.x, output->rect.y);
612 other != TAILQ_END(&outputs);
613 other = TAILQ_NEXT(other, outputs)) {
614 if (other == output || !other->active || other->to_be_disabled)
617 if (other->rect.x != output->rect.x ||
618 other->rect.y != output->rect.y)
621 DLOG("output %p has the same position, his mode = %d x %d\n",
622 other, other->rect.width, other->rect.height);
623 uint32_t width = min(other->rect.width, output->rect.width);
624 uint32_t height = min(other->rect.height, output->rect.height);
626 if (update_if_necessary(&(output->rect.width), width) |
627 update_if_necessary(&(output->rect.height), height))
628 output->changed = true;
630 update_if_necessary(&(other->rect.width), width);
631 update_if_necessary(&(other->rect.height), height);
633 DLOG("disabling output %p (%s)\n", other, other->name);
634 other->to_be_disabled = true;
636 DLOG("new output mode %d x %d, other mode %d x %d\n",
637 output->rect.width, output->rect.height,
638 other->rect.width, other->rect.height);
642 /* Ensure that all outputs which are active also have a con. This is
643 * necessary because in the next step, a clone might get disabled. Example:
644 * LVDS1 active, VGA1 gets activated as a clone of LVDS1 (has no con).
645 * LVDS1 gets disabled. */
646 TAILQ_FOREACH(output, &outputs, outputs) {
647 if (output->active && output->con == NULL) {
648 DLOG("Need to initialize a Con for output %s\n", output->name);
649 output_init_con(output);
650 output->changed = false;
654 /* Handle outputs which have a new mode or are disabled now (either
655 * because the user disabled them or because they are clones) */
656 TAILQ_FOREACH(output, &outputs, outputs) {
657 if (output->to_be_disabled) {
658 output->active = false;
659 DLOG("Output %s disabled, re-assigning workspaces/docks\n", output->name);
661 if ((first = get_first_output()) == NULL)
662 die("No usable outputs available\n");
664 /* TODO: refactor the following code into a nice function. maybe
665 * use an on_destroy callback which is implement differently for
666 * different container types (CT_CONTENT vs. CT_DOCKAREA)? */
667 Con *first_content = output_get_content(first->con);
669 if (output->con != NULL) {
670 /* We need to move the workspaces from the disappearing output to the first output */
671 /* 1: Get the con to focus next, if the disappearing ws is focused */
673 if (TAILQ_FIRST(&(croot->focus_head)) == output->con) {
674 DLOG("This output (%p) was focused! Getting next\n", output->con);
676 DLOG("next = %p\n", next);
679 /* 2: iterate through workspaces and re-assign them, fixing the coordinates
680 * of floating containers as we go */
682 Con *old_content = output_get_content(output->con);
683 while (!TAILQ_EMPTY(&(old_content->nodes_head))) {
684 current = TAILQ_FIRST(&(old_content->nodes_head));
685 if (current != next && TAILQ_EMPTY(&(current->focus_head))) {
686 /* the workspace is empty and not focused, get rid of it */
687 DLOG("Getting rid of current = %p / %s (empty, unfocused)\n", current, current->name);
688 tree_close(current, DONT_KILL_WINDOW, false, false);
691 DLOG("Detaching current = %p / %s\n", current, current->name);
693 DLOG("Re-attaching current = %p / %s\n", current, current->name);
694 con_attach(current, first_content, false);
695 DLOG("Fixing the coordinates of floating containers\n");
697 TAILQ_FOREACH(floating_con, &(current->floating_head), floating_windows)
698 floating_fix_coordinates(floating_con, &(output->con->rect), &(first->con->rect));
699 DLOG("Done, next\n");
701 DLOG("re-attached all workspaces\n");
704 DLOG("now focusing next = %p\n", next);
706 workspace_show(con_get_workspace(next));
709 /* 3: move the dock clients to the first output */
711 TAILQ_FOREACH(child, &(output->con->nodes_head), nodes) {
712 if (child->type != CT_DOCKAREA)
714 DLOG("Handling dock con %p\n", child);
716 while (!TAILQ_EMPTY(&(child->nodes_head))) {
717 dock = TAILQ_FIRST(&(child->nodes_head));
720 nc = con_for_window(first->con, dock->window, &match);
721 DLOG("Moving dock client %p to nc %p\n", dock, nc);
723 DLOG("Re-attaching\n");
724 con_attach(dock, nc, false);
729 DLOG("destroying disappearing con %p\n", output->con);
730 tree_close(output->con, DONT_KILL_WINDOW, true, false);
731 DLOG("Done. Should be fine now\n");
735 output->to_be_disabled = false;
736 output->changed = false;
739 if (output->changed) {
740 output_change_mode(conn, output);
741 output->changed = false;
745 if (TAILQ_EMPTY(&outputs)) {
746 ELOG("No outputs found via RandR, disabling\n");
750 /* Just go through each active output and assign one workspace */
751 TAILQ_FOREACH(output, &outputs, outputs) {
754 Con *content = output_get_content(output->con);
755 if (!TAILQ_EMPTY(&(content->nodes_head)))
757 DLOG("Should add ws for output %s\n", output->name);
758 init_ws_for_output(output, content);
761 /* Focus the primary screen, if possible */
762 TAILQ_FOREACH(output, &outputs, outputs) {
763 if (!output->primary || !output->con)
766 DLOG("Focusing primary output %s\n", output->name);
767 con_focus(con_descend_focused(output->con));
770 /* render_layout flushes */
778 * We have just established a connection to the X server and need the initial
779 * XRandR information to setup workspaces for each screen.
782 void randr_init(int *event_base) {
783 const xcb_query_extension_reply_t *extreply;
785 extreply = xcb_get_extension_data(conn, &xcb_randr_id);
786 if (!extreply->present) {
789 } else randr_query_outputs();
791 if (event_base != NULL)
792 *event_base = extreply->first_event;
794 xcb_randr_select_input(conn, root,
795 XCB_RANDR_NOTIFY_MASK_SCREEN_CHANGE |
796 XCB_RANDR_NOTIFY_MASK_OUTPUT_CHANGE |
797 XCB_RANDR_NOTIFY_MASK_CRTC_CHANGE |
798 XCB_RANDR_NOTIFY_MASK_OUTPUT_PROPERTY);