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 xcb_screen_t *root_screen = xcb_setup_roots_iterator(xcb_get_setup(conn)).data;
154 DLOG("RandR extension unusable, disabling.\n");
156 Output *s = scalloc(sizeof(Output));
161 s->rect.width = root_screen->width_in_pixels;
162 s->rect.height = root_screen->height_in_pixels;
165 init_ws_for_output(s, output_get_content(s->con));
167 TAILQ_INSERT_TAIL(&outputs, s, outputs);
169 randr_disabled = true;
173 * Initializes a CT_OUTPUT Con (searches existing ones from inplace restart
174 * before) to use for the given Output.
177 void output_init_con(Output *output) {
178 Con *con = NULL, *current;
181 DLOG("init_con for output %s\n", output->name);
183 /* Search for a Con with that name directly below the root node. There
184 * might be one from a restored layout. */
185 TAILQ_FOREACH(current, &(croot->nodes_head), nodes) {
186 if (strcmp(current->name, output->name) != 0)
191 DLOG("Using existing con %p / %s\n", con, con->name);
196 con = con_new(croot);
198 con->name = sstrdup(output->name);
199 con->type = CT_OUTPUT;
200 con->layout = L_OUTPUT;
202 con->rect = output->rect;
206 asprintf(&name, "[i3 con] output %s", con->name);
207 x_set_name(con, name);
211 DLOG("Not adding workspace, this was a reused con\n");
215 DLOG("Changing layout, adding top/bottom dockarea\n");
216 Con *topdock = con_new(NULL);
217 topdock->type = CT_DOCKAREA;
218 topdock->layout = L_DOCKAREA;
219 topdock->orientation = VERT;
220 /* this container swallows dock clients */
221 Match *match = scalloc(sizeof(Match));
223 match->dock = M_DOCK_TOP;
224 match->insert_where = M_BELOW;
225 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);
239 content->type = CT_CON;
240 content->name = sstrdup("content");
242 asprintf(&name, "[i3 con] content %s", con->name);
243 x_set_name(content, name);
245 con_attach(content, con, false);
247 /* bottom dock container */
248 Con *bottomdock = con_new(NULL);
249 bottomdock->type = CT_DOCKAREA;
250 bottomdock->layout = L_DOCKAREA;
251 bottomdock->orientation = VERT;
252 /* this container swallows dock clients */
253 match = scalloc(sizeof(Match));
255 match->dock = M_DOCK_BOTTOM;
256 match->insert_where = M_BELOW;
257 TAILQ_INSERT_TAIL(&(bottomdock->swallow_head), match, matches);
259 bottomdock->name = sstrdup("bottomdock");
261 asprintf(&name, "[i3 con] bottom dockarea %s", con->name);
262 x_set_name(bottomdock, name);
265 con_attach(bottomdock, con, false);
269 * Initializes at least one workspace for this output, trying the following
270 * steps until there is at least one workspace:
272 * • Move existing workspaces, which are assigned to be on the given output, to
274 * • Create the first assigned workspace for this output.
275 * • Create the first unused workspace.
278 void init_ws_for_output(Output *output, Con *content) {
281 /* go through all assignments and move the existing workspaces to this output */
282 struct Workspace_Assignment *assignment;
283 TAILQ_FOREACH(assignment, &ws_assignments, ws_assignments) {
284 if (strcmp(assignment->output, output->name) != 0)
287 /* check if this workspace actually exists */
288 Con *workspace = NULL, *out;
289 TAILQ_FOREACH(out, &(croot->nodes_head), nodes)
290 GREP_FIRST(workspace, output_get_content(out),
291 !strcasecmp(child->name, assignment->name));
292 if (workspace == NULL)
295 /* check that this workspace is not already attached (that means the
296 * user configured this assignment twice) */
297 Con *workspace_out = con_get_output(workspace);
298 if (workspace_out == output->con) {
299 LOG("Workspace \"%s\" assigned to output \"%s\", but it is already "
300 "there. Do you have two assignment directives for the same "
301 "workspace in your configuration file?\n",
302 workspace->name, output->name);
306 /* if so, move it over */
307 LOG("Moving workspace \"%s\" from output \"%s\" to \"%s\" due to assignment\n",
308 workspace->name, workspace_out->name, output->name);
309 DLOG("Detaching workspace = %p / %s\n", workspace, workspace->name);
310 con_detach(workspace);
311 DLOG("Re-attaching current = %p / %s\n", workspace, workspace->name);
312 con_attach(workspace, content, false);
313 DLOG("Done, next\n");
316 /* if a workspace exists, we are done now */
317 if (!TAILQ_EMPTY(&(content->nodes_head))) {
318 /* ensure that one of the workspaces is actually visible (in fullscreen
319 * mode), if they were invisible before, this might not be the case. */
321 GREP_FIRST(visible, content, child->fullscreen_mode == CF_OUTPUT);
323 visible = TAILQ_FIRST(&(content->nodes_head));
325 workspace_show(visible->name);
330 /* otherwise, we create the first assigned ws for this output */
331 TAILQ_FOREACH(assignment, &ws_assignments, ws_assignments) {
332 if (strcmp(assignment->output, output->name) != 0)
335 LOG("Initializing first assigned workspace \"%s\" for output \"%s\"\n",
336 assignment->name, assignment->output);
338 workspace_show(assignment->name);
342 /* if there is still no workspace, we create the first free workspace */
343 DLOG("Now adding a workspace\n");
345 /* add a workspace to this output */
346 Con *ws = con_new(NULL);
347 ws->type = CT_WORKSPACE;
349 /* get the next unused workspace number */
350 DLOG("Getting next unused workspace\n");
354 Con *out, *current, *child;
359 asprintf(&(ws->name), "%d", c);
362 TAILQ_FOREACH(out, &(croot->nodes_head), nodes) {
363 TAILQ_FOREACH(current, &(out->nodes_head), nodes) {
364 if (current->type != CT_CON)
367 TAILQ_FOREACH(child, &(current->nodes_head), nodes) {
368 if (strcasecmp(child->name, ws->name) != 0)
377 DLOG("result for ws %s / %d: exists = %d\n", ws->name, c, exists);
380 con_attach(ws, content, false);
382 asprintf(&name, "[i3 con] workspace %s", ws->name);
383 x_set_name(ws, name);
386 ws->fullscreen_mode = CF_OUTPUT;
388 /* If default_orientation is set to NO_ORIENTATION we determine
389 * orientation depending on output resolution. */
390 if (config.default_orientation == NO_ORIENTATION) {
391 ws->orientation = (output->rect.height > output->rect.width) ? VERT : HORIZ;
392 DLOG("Auto orientation. Workspace size set to (%d,%d), setting orientation to %d.\n",
393 output->rect.width, output->rect.height, ws->orientation);
395 ws->orientation = config.default_orientation;
399 /* TODO: Set focus in main.c */
404 * This function needs to be called when changing the mode of an output when
405 * it already has some workspaces (or a bar window) assigned.
407 * It reconfigures the bar window for the new mode, copies the new rect into
408 * each workspace on this output and forces all windows on the affected
409 * workspaces to be reconfigured.
411 * It is necessary to call render_layout() afterwards.
414 static void output_change_mode(xcb_connection_t *conn, Output *output) {
415 //i3Font *font = load_font(conn, config.font);
417 DLOG("Output mode changed, updating rect\n");
418 assert(output->con != NULL);
419 output->con->rect = output->rect;
421 Con *content, *workspace, *child;
423 /* Point content to the container of the workspaces */
424 content = output_get_content(output->con);
426 /* If default_orientation is NO_ORIENTATION, we change the orientation of
427 * the workspaces and their childs depending on output resolution. This is
428 * only done for workspaces with maximum one child. */
429 if (config.default_orientation == NO_ORIENTATION) {
430 TAILQ_FOREACH(workspace, &(content->nodes_head), nodes) {
431 /* Workspaces with more than one child are left untouched because
432 * we do not want to change an existing layout. */
433 if (con_num_children(workspace) > 1)
436 workspace->orientation = (output->rect.height > output->rect.width) ? VERT : HORIZ;
437 DLOG("Setting workspace [%d,%s]'s orientation to %d.\n", workspace->num, workspace->name, workspace->orientation);
438 if ((child = TAILQ_FIRST(&(workspace->nodes_head)))) {
439 child->orientation = workspace->orientation;
440 DLOG("Setting child [%d,%s]'s orientation to %d.\n", child->num, child->name, child->orientation);
447 * Gets called by randr_query_outputs() for each output. The function adds new
448 * outputs to the list of outputs, checks if the mode of existing outputs has
449 * been changed or if an existing output has been disabled. It will then change
450 * either the "changed" or the "to_be_deleted" flag of the output, if
454 static void handle_output(xcb_connection_t *conn, xcb_randr_output_t id,
455 xcb_randr_get_output_info_reply_t *output,
456 xcb_timestamp_t cts, resources_reply *res) {
457 /* each CRT controller has a position in which we are interested in */
460 Output *new = get_output_by_id(id);
461 bool existing = (new != NULL);
463 new = scalloc(sizeof(Output));
465 new->primary = (primary && primary->output == id);
467 asprintf(&new->name, "%.*s",
468 xcb_randr_get_output_info_name_length(output),
469 xcb_randr_get_output_info_name(output));
471 DLOG("found output with name %s\n", new->name);
473 /* Even if no CRTC is used at the moment, we store the output so that
474 * we do not need to change the list ever again (we only update the
476 if (output->crtc == XCB_NONE) {
479 TAILQ_INSERT_HEAD(&outputs, new, outputs);
480 else TAILQ_INSERT_TAIL(&outputs, new, outputs);
481 } else if (new->active)
482 new->to_be_disabled = true;
486 xcb_randr_get_crtc_info_cookie_t icookie;
487 icookie = xcb_randr_get_crtc_info(conn, output->crtc, cts);
488 if ((crtc = xcb_randr_get_crtc_info_reply(conn, icookie, NULL)) == NULL) {
489 DLOG("Skipping output %s: could not get CRTC (%p)\n",
495 bool updated = update_if_necessary(&(new->rect.x), crtc->x) |
496 update_if_necessary(&(new->rect.y), crtc->y) |
497 update_if_necessary(&(new->rect.width), crtc->width) |
498 update_if_necessary(&(new->rect.height), crtc->height);
500 new->active = (new->rect.width != 0 && new->rect.height != 0);
502 DLOG("width/height 0/0, disabling output\n");
506 DLOG("mode: %dx%d+%d+%d\n", new->rect.width, new->rect.height,
507 new->rect.x, new->rect.y);
509 /* If we don’t need to change an existing output or if the output
510 * does not exist in the first place, the case is simple: we either
511 * need to insert the new output or we are done. */
512 if (!updated || !existing) {
515 TAILQ_INSERT_HEAD(&outputs, new, outputs);
516 else TAILQ_INSERT_TAIL(&outputs, new, outputs);
525 * (Re-)queries the outputs via RandR and stores them in the list of outputs.
528 void randr_query_outputs() {
529 Output *output, *other, *first;
530 xcb_randr_get_output_primary_cookie_t pcookie;
531 xcb_randr_get_screen_resources_current_cookie_t rcookie;
532 resources_reply *res;
534 /* timestamp of the configuration so that we get consistent replies to all
535 * requests (if the configuration changes between our different calls) */
538 /* an output is VGA-1, LVDS-1, etc. (usually physical video outputs) */
539 xcb_randr_output_t *randr_outputs;
544 /* Get screen resources (primary output, crtcs, outputs, modes) */
545 rcookie = xcb_randr_get_screen_resources_current(conn, root);
546 pcookie = xcb_randr_get_output_primary(conn, root);
548 if ((primary = xcb_randr_get_output_primary_reply(conn, pcookie, NULL)) == NULL)
549 ELOG("Could not get RandR primary output\n");
550 else DLOG("primary output is %08x\n", primary->output);
551 if ((res = xcb_randr_get_screen_resources_current_reply(conn, rcookie, NULL)) == NULL) {
555 cts = res->config_timestamp;
557 int len = xcb_randr_get_screen_resources_current_outputs_length(res);
558 randr_outputs = xcb_randr_get_screen_resources_current_outputs(res);
560 /* Request information for each output */
561 xcb_randr_get_output_info_cookie_t ocookie[len];
562 for (int i = 0; i < len; i++)
563 ocookie[i] = xcb_randr_get_output_info(conn, randr_outputs[i], cts);
565 /* Loop through all outputs available for this X11 screen */
566 for (int i = 0; i < len; i++) {
567 xcb_randr_get_output_info_reply_t *output;
569 if ((output = xcb_randr_get_output_info_reply(conn, ocookie[i], NULL)) == NULL)
572 handle_output(conn, randr_outputs[i], output, cts, res);
576 /* Check for clones, disable the clones and reduce the mode to the
577 * lowest common mode */
578 TAILQ_FOREACH(output, &outputs, outputs) {
579 if (!output->active || output->to_be_disabled)
581 DLOG("output %p / %s, position (%d, %d), checking for clones\n",
582 output, output->name, output->rect.x, output->rect.y);
585 other != TAILQ_END(&outputs);
586 other = TAILQ_NEXT(other, outputs)) {
587 if (other == output || !other->active || other->to_be_disabled)
590 if (other->rect.x != output->rect.x ||
591 other->rect.y != output->rect.y)
594 DLOG("output %p has the same position, his mode = %d x %d\n",
595 other, other->rect.width, other->rect.height);
596 uint32_t width = min(other->rect.width, output->rect.width);
597 uint32_t height = min(other->rect.height, output->rect.height);
599 if (update_if_necessary(&(output->rect.width), width) |
600 update_if_necessary(&(output->rect.height), height))
601 output->changed = true;
603 update_if_necessary(&(other->rect.width), width);
604 update_if_necessary(&(other->rect.height), height);
606 DLOG("disabling output %p (%s)\n", other, other->name);
607 other->to_be_disabled = true;
609 DLOG("new output mode %d x %d, other mode %d x %d\n",
610 output->rect.width, output->rect.height,
611 other->rect.width, other->rect.height);
615 /* Ensure that all outputs which are active also have a con. This is
616 * necessary because in the next step, a clone might get disabled. Example:
617 * LVDS1 active, VGA1 gets activated as a clone of LVDS1 (has no con).
618 * LVDS1 gets disabled. */
619 TAILQ_FOREACH(output, &outputs, outputs) {
620 if (output->active && output->con == NULL) {
621 DLOG("Need to initialize a Con for output %s\n", output->name);
622 output_init_con(output);
623 output->changed = false;
627 /* Handle outputs which have a new mode or are disabled now (either
628 * because the user disabled them or because they are clones) */
629 TAILQ_FOREACH(output, &outputs, outputs) {
630 if (output->to_be_disabled) {
631 output->active = false;
632 DLOG("Output %s disabled, re-assigning workspaces/docks\n", output->name);
634 if ((first = get_first_output()) == NULL)
635 die("No usable outputs available\n");
637 /* TODO: refactor the following code into a nice function. maybe
638 * use an on_destroy callback which is implement differently for
639 * different container types (CT_CONTENT vs. CT_DOCKAREA)? */
640 Con *first_content = output_get_content(first->con);
642 if (output->con != NULL) {
643 /* We need to move the workspaces from the disappearing output to the first output */
644 /* 1: Get the con to focus next, if the disappearing ws is focused */
646 if (TAILQ_FIRST(&(croot->focus_head)) == output->con) {
647 DLOG("This output (%p) was focused! Getting next\n", output->con);
648 next = con_next_focused(output->con);
649 DLOG("next = %p\n", next);
652 /* 2: iterate through workspaces and re-assign them */
654 Con *old_content = output_get_content(output->con);
655 while (!TAILQ_EMPTY(&(old_content->nodes_head))) {
656 current = TAILQ_FIRST(&(old_content->nodes_head));
657 DLOG("Detaching current = %p / %s\n", current, current->name);
659 DLOG("Re-attaching current = %p / %s\n", current, current->name);
660 con_attach(current, first_content, false);
661 DLOG("Done, next\n");
663 DLOG("re-attached all workspaces\n");
666 DLOG("now focusing next = %p\n", next);
670 /* 3: move the dock clients to the first output */
672 TAILQ_FOREACH(child, &(output->con->nodes_head), nodes) {
673 if (child->type != CT_DOCKAREA)
675 DLOG("Handling dock con %p\n", child);
677 while (!TAILQ_EMPTY(&(child->nodes_head))) {
678 dock = TAILQ_FIRST(&(child->nodes_head));
681 nc = con_for_window(first->con, dock->window, &match);
682 DLOG("Moving dock client %p to nc %p\n", dock, nc);
684 DLOG("Re-attaching\n");
685 con_attach(dock, nc, false);
690 DLOG("destroying disappearing con %p\n", output->con);
691 tree_close(output->con, DONT_KILL_WINDOW, true);
692 DLOG("Done. Should be fine now\n");
696 output->to_be_disabled = false;
697 output->changed = false;
700 if (output->changed) {
701 output_change_mode(conn, output);
702 output->changed = false;
706 if (TAILQ_EMPTY(&outputs)) {
707 ELOG("No outputs found via RandR, disabling\n");
711 ewmh_update_workarea();
713 /* Just go through each active output and assign one workspace */
714 TAILQ_FOREACH(output, &outputs, outputs) {
717 Con *content = output_get_content(output->con);
718 if (!TAILQ_EMPTY(&(content->nodes_head)))
720 DLOG("Should add ws for output %s\n", output->name);
721 init_ws_for_output(output, content);
724 /* Focus the primary screen, if possible */
725 TAILQ_FOREACH(output, &outputs, outputs) {
726 if (!output->primary || !output->con)
729 DLOG("Focusing primary output %s\n", output->name);
730 con_focus(con_descend_focused(output->con));
733 /* render_layout flushes */
741 * We have just established a connection to the X server and need the initial
742 * XRandR information to setup workspaces for each screen.
745 void randr_init(int *event_base) {
746 const xcb_query_extension_reply_t *extreply;
748 extreply = xcb_get_extension_data(conn, &xcb_randr_id);
749 if (!extreply->present)
751 else randr_query_outputs();
753 if (event_base != NULL)
754 *event_base = extreply->first_event;
756 xcb_randr_select_input(conn, root,
757 XCB_RANDR_NOTIFY_MASK_SCREEN_CHANGE |
758 XCB_RANDR_NOTIFY_MASK_OUTPUT_CHANGE |
759 XCB_RANDR_NOTIFY_MASK_CRTC_CHANGE |
760 XCB_RANDR_NOTIFY_MASK_OUTPUT_PROPERTY);