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);
147 * Disables RandR support by creating exactly one output with the size of the
151 void disable_randr(xcb_connection_t *conn) {
152 DLOG("RandR extension unusable, disabling.\n");
154 Output *s = scalloc(sizeof(Output));
159 s->rect.width = root_screen->width_in_pixels;
160 s->rect.height = root_screen->height_in_pixels;
163 init_ws_for_output(s, output_get_content(s->con));
165 TAILQ_INSERT_TAIL(&outputs, s, outputs);
167 randr_disabled = true;
171 * Initializes a CT_OUTPUT Con (searches existing ones from inplace restart
172 * before) to use for the given Output.
175 void output_init_con(Output *output) {
176 Con *con = NULL, *current;
179 DLOG("init_con for output %s\n", output->name);
181 /* Search for a Con with that name directly below the root node. There
182 * might be one from a restored layout. */
183 TAILQ_FOREACH(current, &(croot->nodes_head), nodes) {
184 if (strcmp(current->name, output->name) != 0)
189 DLOG("Using existing con %p / %s\n", con, con->name);
194 con = con_new(croot, NULL);
196 con->name = sstrdup(output->name);
197 con->type = CT_OUTPUT;
198 con->layout = L_OUTPUT;
199 con_fix_percent(croot);
201 con->rect = output->rect;
205 asprintf(&name, "[i3 con] output %s", con->name);
206 x_set_name(con, name);
210 DLOG("Not adding workspace, this was a reused con\n");
214 DLOG("Changing layout, adding top/bottom dockarea\n");
215 Con *topdock = con_new(NULL, NULL);
216 topdock->type = CT_DOCKAREA;
217 topdock->layout = L_DOCKAREA;
218 topdock->orientation = VERT;
219 /* this container swallows dock clients */
220 Match *match = scalloc(sizeof(Match));
222 match->dock = M_DOCK_TOP;
223 match->insert_where = M_BELOW;
224 TAILQ_INSERT_TAIL(&(topdock->swallow_head), match, matches);
227 topdock->name = sstrdup("topdock");
229 asprintf(&name, "[i3 con] top dockarea %s", con->name);
230 x_set_name(topdock, name);
233 con_attach(topdock, con, false);
235 /* content container */
237 DLOG("adding main content container\n");
238 Con *content = con_new(NULL, NULL);
239 content->type = CT_CON;
241 content->name = sstrdup("content");
243 asprintf(&name, "[i3 con] content %s", con->name);
244 x_set_name(content, name);
246 con_attach(content, con, false);
248 /* bottom dock container */
249 Con *bottomdock = con_new(NULL, NULL);
250 bottomdock->type = CT_DOCKAREA;
251 bottomdock->layout = L_DOCKAREA;
252 bottomdock->orientation = VERT;
253 /* this container swallows dock clients */
254 match = scalloc(sizeof(Match));
256 match->dock = M_DOCK_BOTTOM;
257 match->insert_where = M_BELOW;
258 TAILQ_INSERT_TAIL(&(bottomdock->swallow_head), match, matches);
260 FREE(bottomdock->name);
261 bottomdock->name = sstrdup("bottomdock");
263 asprintf(&name, "[i3 con] bottom dockarea %s", con->name);
264 x_set_name(bottomdock, name);
267 con_attach(bottomdock, con, false);
271 * Initializes at least one workspace for this output, trying the following
272 * steps until there is at least one workspace:
274 * • Move existing workspaces, which are assigned to be on the given output, to
276 * • Create the first assigned workspace for this output.
277 * • Create the first unused workspace.
280 void init_ws_for_output(Output *output, Con *content) {
283 /* go through all assignments and move the existing workspaces to this output */
284 struct Workspace_Assignment *assignment;
285 TAILQ_FOREACH(assignment, &ws_assignments, ws_assignments) {
286 if (strcmp(assignment->output, output->name) != 0)
289 /* check if this workspace actually exists */
290 Con *workspace = NULL, *out;
291 TAILQ_FOREACH(out, &(croot->nodes_head), nodes)
292 GREP_FIRST(workspace, output_get_content(out),
293 !strcasecmp(child->name, assignment->name));
294 if (workspace == NULL)
297 /* check that this workspace is not already attached (that means the
298 * user configured this assignment twice) */
299 Con *workspace_out = con_get_output(workspace);
300 if (workspace_out == output->con) {
301 LOG("Workspace \"%s\" assigned to output \"%s\", but it is already "
302 "there. Do you have two assignment directives for the same "
303 "workspace in your configuration file?\n",
304 workspace->name, output->name);
308 /* if so, move it over */
309 LOG("Moving workspace \"%s\" from output \"%s\" to \"%s\" due to assignment\n",
310 workspace->name, workspace_out->name, output->name);
312 /* if the workspace is currently visible on that output, we need to
313 * switch to a different workspace - otherwise the output would end up
314 * with no active workspace */
315 bool visible = workspace_is_visible(workspace);
316 Con *previous = NULL;
317 if (visible && (previous = TAILQ_NEXT(workspace, focused))) {
318 LOG("Switching to previously used workspace \"%s\" on output \"%s\"\n",
319 previous->name, workspace_out->name);
320 workspace_show(previous->name);
323 con_detach(workspace);
324 con_attach(workspace, content, false);
326 /* In case the workspace we just moved was visible but there was no
327 * other workspace to switch to, we need to initialize the source
329 if (visible && previous == NULL) {
330 LOG("There is no workspace left on \"%s\", re-initializing\n",
331 workspace_out->name);
332 init_ws_for_output(get_output_by_name(workspace_out->name),
333 output_get_content(workspace_out));
334 DLOG("Done re-initializing, continuing with \"%s\"\n", output->name);
338 /* if a workspace exists, we are done now */
339 if (!TAILQ_EMPTY(&(content->nodes_head))) {
340 /* ensure that one of the workspaces is actually visible (in fullscreen
341 * mode), if they were invisible before, this might not be the case. */
343 GREP_FIRST(visible, content, child->fullscreen_mode == CF_OUTPUT);
345 visible = TAILQ_FIRST(&(content->nodes_head));
347 workspace_show(visible->name);
352 /* otherwise, we create the first assigned ws for this output */
353 TAILQ_FOREACH(assignment, &ws_assignments, ws_assignments) {
354 if (strcmp(assignment->output, output->name) != 0)
357 LOG("Initializing first assigned workspace \"%s\" for output \"%s\"\n",
358 assignment->name, assignment->output);
360 workspace_show(assignment->name);
364 /* if there is still no workspace, we create the first free workspace */
365 DLOG("Now adding a workspace\n");
367 /* add a workspace to this output */
368 Con *ws = con_new(NULL, NULL);
369 ws->type = CT_WORKSPACE;
371 /* get the next unused workspace number */
372 DLOG("Getting next unused workspace\n");
376 Con *out, *current, *child;
381 asprintf(&(ws->name), "%d", c);
384 TAILQ_FOREACH(out, &(croot->nodes_head), nodes) {
385 TAILQ_FOREACH(current, &(out->nodes_head), nodes) {
386 if (current->type != CT_CON)
389 TAILQ_FOREACH(child, &(current->nodes_head), nodes) {
390 if (strcasecmp(child->name, ws->name) != 0)
399 DLOG("result for ws %s / %d: exists = %d\n", ws->name, c, exists);
402 con_attach(ws, content, false);
404 asprintf(&name, "[i3 con] workspace %s", ws->name);
405 x_set_name(ws, name);
408 ws->fullscreen_mode = CF_OUTPUT;
410 /* If default_orientation is set to NO_ORIENTATION we determine
411 * orientation depending on output resolution. */
412 if (config.default_orientation == NO_ORIENTATION) {
413 ws->orientation = (output->rect.height > output->rect.width) ? VERT : HORIZ;
414 DLOG("Auto orientation. Workspace size set to (%d,%d), setting orientation to %d.\n",
415 output->rect.width, output->rect.height, ws->orientation);
417 ws->orientation = config.default_orientation;
421 /* TODO: Set focus in main.c */
426 * This function needs to be called when changing the mode of an output when
427 * it already has some workspaces (or a bar window) assigned.
429 * It reconfigures the bar window for the new mode, copies the new rect into
430 * each workspace on this output and forces all windows on the affected
431 * workspaces to be reconfigured.
433 * It is necessary to call render_layout() afterwards.
436 static void output_change_mode(xcb_connection_t *conn, Output *output) {
437 //i3Font *font = load_font(conn, config.font);
439 DLOG("Output mode changed, updating rect\n");
440 assert(output->con != NULL);
441 output->con->rect = output->rect;
443 Con *content, *workspace, *child;
445 /* Point content to the container of the workspaces */
446 content = output_get_content(output->con);
448 /* If default_orientation is NO_ORIENTATION, we change the orientation of
449 * the workspaces and their childs depending on output resolution. This is
450 * only done for workspaces with maximum one child. */
451 if (config.default_orientation == NO_ORIENTATION) {
452 TAILQ_FOREACH(workspace, &(content->nodes_head), nodes) {
453 /* Workspaces with more than one child are left untouched because
454 * we do not want to change an existing layout. */
455 if (con_num_children(workspace) > 1)
458 workspace->orientation = (output->rect.height > output->rect.width) ? VERT : HORIZ;
459 DLOG("Setting workspace [%d,%s]'s orientation to %d.\n", workspace->num, workspace->name, workspace->orientation);
460 if ((child = TAILQ_FIRST(&(workspace->nodes_head)))) {
461 child->orientation = workspace->orientation;
462 DLOG("Setting child [%d,%s]'s orientation to %d.\n", child->num, child->name, child->orientation);
469 * Gets called by randr_query_outputs() for each output. The function adds new
470 * outputs to the list of outputs, checks if the mode of existing outputs has
471 * been changed or if an existing output has been disabled. It will then change
472 * either the "changed" or the "to_be_deleted" flag of the output, if
476 static void handle_output(xcb_connection_t *conn, xcb_randr_output_t id,
477 xcb_randr_get_output_info_reply_t *output,
478 xcb_timestamp_t cts, resources_reply *res) {
479 /* each CRT controller has a position in which we are interested in */
482 Output *new = get_output_by_id(id);
483 bool existing = (new != NULL);
485 new = scalloc(sizeof(Output));
487 new->primary = (primary && primary->output == id);
489 asprintf(&new->name, "%.*s",
490 xcb_randr_get_output_info_name_length(output),
491 xcb_randr_get_output_info_name(output));
493 DLOG("found output with name %s\n", new->name);
495 /* Even if no CRTC is used at the moment, we store the output so that
496 * we do not need to change the list ever again (we only update the
498 if (output->crtc == XCB_NONE) {
501 TAILQ_INSERT_HEAD(&outputs, new, outputs);
502 else TAILQ_INSERT_TAIL(&outputs, new, outputs);
503 } else if (new->active)
504 new->to_be_disabled = true;
508 xcb_randr_get_crtc_info_cookie_t icookie;
509 icookie = xcb_randr_get_crtc_info(conn, output->crtc, cts);
510 if ((crtc = xcb_randr_get_crtc_info_reply(conn, icookie, NULL)) == NULL) {
511 DLOG("Skipping output %s: could not get CRTC (%p)\n",
517 bool updated = update_if_necessary(&(new->rect.x), crtc->x) |
518 update_if_necessary(&(new->rect.y), crtc->y) |
519 update_if_necessary(&(new->rect.width), crtc->width) |
520 update_if_necessary(&(new->rect.height), crtc->height);
522 new->active = (new->rect.width != 0 && new->rect.height != 0);
524 DLOG("width/height 0/0, disabling output\n");
528 DLOG("mode: %dx%d+%d+%d\n", new->rect.width, new->rect.height,
529 new->rect.x, new->rect.y);
531 /* If we don’t need to change an existing output or if the output
532 * does not exist in the first place, the case is simple: we either
533 * need to insert the new output or we are done. */
534 if (!updated || !existing) {
537 TAILQ_INSERT_HEAD(&outputs, new, outputs);
538 else TAILQ_INSERT_TAIL(&outputs, new, outputs);
547 * (Re-)queries the outputs via RandR and stores them in the list of outputs.
550 void randr_query_outputs() {
551 Output *output, *other, *first;
552 xcb_randr_get_output_primary_cookie_t pcookie;
553 xcb_randr_get_screen_resources_current_cookie_t rcookie;
554 resources_reply *res;
556 /* timestamp of the configuration so that we get consistent replies to all
557 * requests (if the configuration changes between our different calls) */
560 /* an output is VGA-1, LVDS-1, etc. (usually physical video outputs) */
561 xcb_randr_output_t *randr_outputs;
566 /* Get screen resources (primary output, crtcs, outputs, modes) */
567 rcookie = xcb_randr_get_screen_resources_current(conn, root);
568 pcookie = xcb_randr_get_output_primary(conn, root);
570 if ((primary = xcb_randr_get_output_primary_reply(conn, pcookie, NULL)) == NULL)
571 ELOG("Could not get RandR primary output\n");
572 else DLOG("primary output is %08x\n", primary->output);
573 if ((res = xcb_randr_get_screen_resources_current_reply(conn, rcookie, NULL)) == NULL) {
577 cts = res->config_timestamp;
579 int len = xcb_randr_get_screen_resources_current_outputs_length(res);
580 randr_outputs = xcb_randr_get_screen_resources_current_outputs(res);
582 /* Request information for each output */
583 xcb_randr_get_output_info_cookie_t ocookie[len];
584 for (int i = 0; i < len; i++)
585 ocookie[i] = xcb_randr_get_output_info(conn, randr_outputs[i], cts);
587 /* Loop through all outputs available for this X11 screen */
588 for (int i = 0; i < len; i++) {
589 xcb_randr_get_output_info_reply_t *output;
591 if ((output = xcb_randr_get_output_info_reply(conn, ocookie[i], NULL)) == NULL)
594 handle_output(conn, randr_outputs[i], output, cts, res);
598 /* Check for clones, disable the clones and reduce the mode to the
599 * lowest common mode */
600 TAILQ_FOREACH(output, &outputs, outputs) {
601 if (!output->active || output->to_be_disabled)
603 DLOG("output %p / %s, position (%d, %d), checking for clones\n",
604 output, output->name, output->rect.x, output->rect.y);
607 other != TAILQ_END(&outputs);
608 other = TAILQ_NEXT(other, outputs)) {
609 if (other == output || !other->active || other->to_be_disabled)
612 if (other->rect.x != output->rect.x ||
613 other->rect.y != output->rect.y)
616 DLOG("output %p has the same position, his mode = %d x %d\n",
617 other, other->rect.width, other->rect.height);
618 uint32_t width = min(other->rect.width, output->rect.width);
619 uint32_t height = min(other->rect.height, output->rect.height);
621 if (update_if_necessary(&(output->rect.width), width) |
622 update_if_necessary(&(output->rect.height), height))
623 output->changed = true;
625 update_if_necessary(&(other->rect.width), width);
626 update_if_necessary(&(other->rect.height), height);
628 DLOG("disabling output %p (%s)\n", other, other->name);
629 other->to_be_disabled = true;
631 DLOG("new output mode %d x %d, other mode %d x %d\n",
632 output->rect.width, output->rect.height,
633 other->rect.width, other->rect.height);
637 /* Ensure that all outputs which are active also have a con. This is
638 * necessary because in the next step, a clone might get disabled. Example:
639 * LVDS1 active, VGA1 gets activated as a clone of LVDS1 (has no con).
640 * LVDS1 gets disabled. */
641 TAILQ_FOREACH(output, &outputs, outputs) {
642 if (output->active && output->con == NULL) {
643 DLOG("Need to initialize a Con for output %s\n", output->name);
644 output_init_con(output);
645 output->changed = false;
649 /* Handle outputs which have a new mode or are disabled now (either
650 * because the user disabled them or because they are clones) */
651 TAILQ_FOREACH(output, &outputs, outputs) {
652 if (output->to_be_disabled) {
653 output->active = false;
654 DLOG("Output %s disabled, re-assigning workspaces/docks\n", output->name);
656 if ((first = get_first_output()) == NULL)
657 die("No usable outputs available\n");
659 /* TODO: refactor the following code into a nice function. maybe
660 * use an on_destroy callback which is implement differently for
661 * different container types (CT_CONTENT vs. CT_DOCKAREA)? */
662 Con *first_content = output_get_content(first->con);
664 if (output->con != NULL) {
665 /* We need to move the workspaces from the disappearing output to the first output */
666 /* 1: Get the con to focus next, if the disappearing ws is focused */
668 if (TAILQ_FIRST(&(croot->focus_head)) == output->con) {
669 DLOG("This output (%p) was focused! Getting next\n", output->con);
670 next = con_next_focused(output->con);
671 DLOG("next = %p\n", next);
674 /* 2: iterate through workspaces and re-assign them */
676 Con *old_content = output_get_content(output->con);
677 while (!TAILQ_EMPTY(&(old_content->nodes_head))) {
678 current = TAILQ_FIRST(&(old_content->nodes_head));
679 DLOG("Detaching current = %p / %s\n", current, current->name);
681 DLOG("Re-attaching current = %p / %s\n", current, current->name);
682 con_attach(current, first_content, false);
683 DLOG("Done, next\n");
685 DLOG("re-attached all workspaces\n");
688 DLOG("now focusing next = %p\n", next);
692 /* 3: move the dock clients to the first output */
694 TAILQ_FOREACH(child, &(output->con->nodes_head), nodes) {
695 if (child->type != CT_DOCKAREA)
697 DLOG("Handling dock con %p\n", child);
699 while (!TAILQ_EMPTY(&(child->nodes_head))) {
700 dock = TAILQ_FIRST(&(child->nodes_head));
703 nc = con_for_window(first->con, dock->window, &match);
704 DLOG("Moving dock client %p to nc %p\n", dock, nc);
706 DLOG("Re-attaching\n");
707 con_attach(dock, nc, false);
712 DLOG("destroying disappearing con %p\n", output->con);
713 tree_close(output->con, DONT_KILL_WINDOW, true);
714 DLOG("Done. Should be fine now\n");
718 output->to_be_disabled = false;
719 output->changed = false;
722 if (output->changed) {
723 output_change_mode(conn, output);
724 output->changed = false;
728 if (TAILQ_EMPTY(&outputs)) {
729 ELOG("No outputs found via RandR, disabling\n");
733 ewmh_update_workarea();
735 /* Just go through each active output and assign one workspace */
736 TAILQ_FOREACH(output, &outputs, outputs) {
739 Con *content = output_get_content(output->con);
740 if (!TAILQ_EMPTY(&(content->nodes_head)))
742 DLOG("Should add ws for output %s\n", output->name);
743 init_ws_for_output(output, content);
746 /* Focus the primary screen, if possible */
747 TAILQ_FOREACH(output, &outputs, outputs) {
748 if (!output->primary || !output->con)
751 DLOG("Focusing primary output %s\n", output->name);
752 con_focus(con_descend_focused(output->con));
755 /* render_layout flushes */
763 * We have just established a connection to the X server and need the initial
764 * XRandR information to setup workspaces for each screen.
767 void randr_init(int *event_base) {
768 const xcb_query_extension_reply_t *extreply;
770 extreply = xcb_get_extension_data(conn, &xcb_randr_id);
771 if (!extreply->present)
773 else randr_query_outputs();
775 if (event_base != NULL)
776 *event_base = extreply->first_event;
778 xcb_randr_select_input(conn, root,
779 XCB_RANDR_NOTIFY_MASK_SCREEN_CHANGE |
780 XCB_RANDR_NOTIFY_MASK_OUTPUT_CHANGE |
781 XCB_RANDR_NOTIFY_MASK_CRTC_CHANGE |
782 XCB_RANDR_NOTIFY_MASK_OUTPUT_PROPERTY);