/*
* vim:ts=4:sw=4:expandtab
*
* i3 - an improved dynamic tiling window manager
* © 2009 Michael Stapelberg and contributors (see also: LICENSE)
*
* render.c: Renders (determines position/sizes) the layout tree, updating the
* various rects. Needs to be pushed to X11 (see x.c) to be visible.
*
*/
#include "all.h"
#include <math.h>
/* Forward declarations */
static int *precalculate_sizes(Con *con, render_params *p);
static void render_root(Con *con, Con *fullscreen);
static void render_output(Con *con);
static void render_con_split(Con *con, Con *child, render_params *p, int i);
static void render_con_stacked(Con *con, Con *child, render_params *p, int i);
static void render_con_tabbed(Con *con, Con *child, render_params *p, int i);
static void render_con_dockarea(Con *con, Con *child, render_params *p);
bool should_inset_con(Con *con, int children);
bool has_adjacent_container(Con *con, direction_t direction);
/*
* Returns the height for the decorations
*/
int render_deco_height(void) {
int deco_height = config.font.height + 4;
if (config.font.height & 0x01)
++deco_height;
return deco_height;
}
/*
* "Renders" the given container (and its children), meaning that all rects are
* updated correctly. Note that this function does not call any xcb_*
* functions, so the changes are completely done in memory only (and
* side-effect free). As soon as you call x_push_changes(), the changes will be
* updated in X11.
*
*/
void render_con(Con *con, bool already_inset) {
render_params params = {
.rect = con->rect,
.x = con->rect.x,
.y = con->rect.y,
.children = con_num_children(con)};
DLOG("Rendering node %p / %s / layout %d / children %d\n", con, con->name,
con->layout, params.children);
bool should_inset = should_inset_con(con, params.children);
if (!already_inset && should_inset) {
gaps_t gaps = calculate_effective_gaps(con);
Rect inset = (Rect){
has_adjacent_container(con, D_LEFT) ? gaps.inner : gaps.left,
has_adjacent_container(con, D_UP) ? gaps.inner : gaps.top,
has_adjacent_container(con, D_RIGHT) ? -gaps.inner : -gaps.right,
has_adjacent_container(con, D_DOWN) ? -gaps.inner : -gaps.bottom};
inset.width -= inset.x;
inset.height -= inset.y;
if (con->fullscreen_mode == CF_NONE) {
params.rect = rect_add(params.rect, inset);
con->rect = rect_add(con->rect, inset);
if (con->window) {
con->window_rect = rect_add(con->window_rect, inset);
}
}
inset.height = 0;
if (con->deco_rect.width != 0 && con->deco_rect.height != 0) {
con->deco_rect = rect_add(con->deco_rect, inset);
}
params.x = con->rect.x;
params.y = con->rect.y;
}
int i = 0;
con->mapped = true;
/* if this container contains a window, set the coordinates */
if (con->window) {
/* depending on the border style, the rect of the child window
* needs to be smaller */
Rect *inset = &(con->window_rect);
*inset = (Rect){0, 0, con->rect.width, con->rect.height};
if (con->fullscreen_mode == CF_NONE) {
*inset = rect_add(*inset, con_border_style_rect(con));
}
/* Obey x11 border */
inset->width -= (2 * con->border_width);
inset->height -= (2 * con->border_width);
*inset = rect_sanitize_dimensions(*inset);
/* NB: We used to respect resize increment size hints for tiling
* windows up until commit 0db93d9 here. However, since all terminal
* emulators cope with ignoring the size hints in a better way than we
* can (by providing their fake-transparency or background color), this
* code was removed. See also https://bugs.i3wm.org/540 */
DLOG("child will be at %dx%d with size %dx%d\n", inset->x, inset->y, inset->width, inset->height);
}
/* Check for fullscreen nodes */
Con *fullscreen = NULL;
if (con->type != CT_OUTPUT) {
fullscreen = con_get_fullscreen_con(con, (con->type == CT_ROOT ? CF_GLOBAL : CF_OUTPUT));
}
if (fullscreen) {
fullscreen->rect = params.rect;
x_raise_con(fullscreen);
render_con(fullscreen, false);
/* Fullscreen containers are either global (underneath the CT_ROOT
* container) or per-output (underneath the CT_CONTENT container). For
* global fullscreen containers, we cannot abort rendering here yet,
* because the floating windows (with popup_during_fullscreen smart)
* have not yet been rendered (see the CT_ROOT code path below). See
* also https://bugs.i3wm.org/1393 */
if (con->type != CT_ROOT) {
return;
}
}
/* find the height for the decorations */
params.deco_height = render_deco_height();
/* precalculate the sizes to be able to correct rounding errors */
params.sizes = precalculate_sizes(con, ¶ms);
if (con->layout == L_OUTPUT) {
/* Skip i3-internal outputs */
if (con_is_internal(con))
goto free_params;
render_output(con);
} else if (con->type == CT_ROOT) {
render_root(con, fullscreen);
} else {
Con *child;
TAILQ_FOREACH (child, &(con->nodes_head), nodes) {
assert(params.children > 0);
if (con->layout == L_SPLITH || con->layout == L_SPLITV) {
render_con_split(con, child, ¶ms, i);
} else if (con->layout == L_STACKED) {
render_con_stacked(con, child, ¶ms, i);
} else if (con->layout == L_TABBED) {
render_con_tabbed(con, child, ¶ms, i);
} else if (con->layout == L_DOCKAREA) {
render_con_dockarea(con, child, ¶ms);
}
child->rect = rect_sanitize_dimensions(child->rect);
DLOG("child at (%d, %d) with (%d x %d)\n",
child->rect.x, child->rect.y, child->rect.width, child->rect.height);
x_raise_con(child);
render_con(child, should_inset || already_inset);
i++;
}
/* in a stacking or tabbed container, we ensure the focused client is raised */
if (con->layout == L_STACKED || con->layout == L_TABBED) {
TAILQ_FOREACH_REVERSE (child, &(con->focus_head), focus_head, focused) {
x_raise_con(child);
}
if ((child = TAILQ_FIRST(&(con->focus_head)))) {
/* By rendering the stacked container again, we handle the case
* that we have a non-leaf-container inside the stack. In that
* case, the children of the non-leaf-container need to be
* raised as well. */
render_con(child, true);
}
if (params.children != 1)
/* Raise the stack con itself. This will put the stack
* decoration on top of every stack window. That way, when a
* new window is opened in the stack, the old window will not
* obscure part of the decoration (it’s unmapped afterwards). */
x_raise_con(con);
}
}
free_params:
FREE(params.sizes);
}
static int *precalculate_sizes(Con *con, render_params *p) {
if ((con->layout != L_SPLITH && con->layout != L_SPLITV) || p->children <= 0) {
return NULL;
}
int *sizes = smalloc(p->children * sizeof(int));
assert(!TAILQ_EMPTY(&con->nodes_head));
Con *child;
int i = 0, assigned = 0;
int total = con_rect_size_in_orientation(con);
TAILQ_FOREACH (child, &(con->nodes_head), nodes) {
double percentage = child->percent > 0.0 ? child->percent : 1.0 / p->children;
assigned += sizes[i++] = lround(percentage * total);
}
assert(assigned == total ||
(assigned > total && assigned - total <= p->children * 2) ||
(assigned < total && total - assigned <= p->children * 2));
int signal = assigned < total ? 1 : -1;
while (assigned != total) {
for (i = 0; i < p->children && assigned != total; ++i) {
sizes[i] += signal;
assigned += signal;
}
}
return sizes;
}
static void render_root(Con *con, Con *fullscreen) {
Con *output;
if (!fullscreen) {
TAILQ_FOREACH (output, &(con->nodes_head), nodes) {
render_con(output, false);
}
}
/* We need to render floating windows after rendering all outputs’
* tiling windows because they need to be on top of *every* output at
* all times. This is important when the user places floating
* windows/containers so that they overlap on another output. */
DLOG("Rendering floating windows:\n");
TAILQ_FOREACH (output, &(con->nodes_head), nodes) {
if (con_is_internal(output))
continue;
/* Get the active workspace of that output */
Con *content = output_get_content(output);
if (!content || TAILQ_EMPTY(&(content->focus_head))) {
DLOG("Skipping this output because it is currently being destroyed.\n");
continue;
}
Con *workspace = TAILQ_FIRST(&(content->focus_head));
Con *fullscreen = con_get_fullscreen_covering_ws(workspace);
Con *child;
TAILQ_FOREACH (child, &(workspace->floating_head), floating_windows) {
if (fullscreen != NULL) {
/* Don’t render floating windows when there is a fullscreen
* window on that workspace. Necessary to make floating
* fullscreen work correctly (ticket #564). Exception to the
* above rule: smart popup_during_fullscreen handling (popups
* belonging to the fullscreen app will be rendered). */
if (config.popup_during_fullscreen != PDF_SMART || fullscreen->window == NULL) {
continue;
}
Con *floating_child = con_descend_focused(child);
if (con_find_transient_for_window(floating_child, fullscreen->window->id)) {
DLOG("Rendering floating child even though in fullscreen mode: "
"floating->transient_for (0x%08x) --> fullscreen->id (0x%08x)\n",
floating_child->window->transient_for, fullscreen->window->id);
} else {
continue;
}
}
DLOG("floating child at (%d,%d) with %d x %d\n",
child->rect.x, child->rect.y, child->rect.width, child->rect.height);
x_raise_con(child);
render_con(child, true);
}
}
}
/*
* Renders a container with layout L_OUTPUT. In this layout, all CT_DOCKAREAs
* get the height of their content and the remaining CT_CON gets the rest.
*
*/
static void render_output(Con *con) {
Con *child, *dockchild;
int x = con->rect.x;
int y = con->rect.y;
int height = con->rect.height;
/* Find the content container and ensure that there is exactly one. Also
* check for any non-CT_DOCKAREA clients. */
Con *content = NULL;
TAILQ_FOREACH (child, &(con->nodes_head), nodes) {
if (child->type == CT_CON) {
if (content != NULL) {
DLOG("More than one CT_CON on output container\n");
assert(false);
}
content = child;
} else if (child->type != CT_DOCKAREA) {
DLOG("Child %p of type %d is inside the OUTPUT con\n", child, child->type);
assert(false);
}
}
if (content == NULL) {
DLOG("Skipping this output because it is currently being destroyed.\n");
return;
}
/* We need to find out if there is a fullscreen con on the current workspace
* and take the short-cut to render it directly (the user does not want to
* see the dockareas in that case) */
Con *ws = con_get_fullscreen_con(content, CF_OUTPUT);
if (!ws) {
DLOG("Skipping this output because it is currently being destroyed.\n");
return;
}
Con *fullscreen = con_get_fullscreen_con(ws, CF_OUTPUT);
if (fullscreen) {
fullscreen->rect = con->rect;
x_raise_con(fullscreen);
render_con(fullscreen, false);
return;
}
/* First pass: determine the height of all CT_DOCKAREAs (the sum of their
* children) and figure out how many pixels we have left for the rest */
TAILQ_FOREACH (child, &(con->nodes_head), nodes) {
if (child->type != CT_DOCKAREA)
continue;
child->rect.height = 0;
TAILQ_FOREACH (dockchild, &(child->nodes_head), nodes) {
child->rect.height += dockchild->geometry.height;
}
height -= child->rect.height;
}
/* Second pass: Set the widths/heights */
TAILQ_FOREACH (child, &(con->nodes_head), nodes) {
if (child->type == CT_CON) {
child->rect.x = x;
child->rect.y = y;
child->rect.width = con->rect.width;
child->rect.height = height;
}
child->rect.x = x;
child->rect.y = y;
child->rect.width = con->rect.width;
child->deco_rect.x = 0;
child->deco_rect.y = 0;
child->deco_rect.width = 0;
child->deco_rect.height = 0;
y += child->rect.height;
DLOG("child at (%d, %d) with (%d x %d)\n",
child->rect.x, child->rect.y, child->rect.width, child->rect.height);
x_raise_con(child);
render_con(child, child->type == CT_DOCKAREA);
}
}
static void render_con_split(Con *con, Con *child, render_params *p, int i) {
assert(con->layout == L_SPLITH || con->layout == L_SPLITV);
if (con->layout == L_SPLITH) {
child->rect.x = p->x;
child->rect.y = p->y;
child->rect.width = p->sizes[i];
child->rect.height = p->rect.height;
p->x += child->rect.width;
} else {
child->rect.x = p->x;
child->rect.y = p->y;
child->rect.width = p->rect.width;
child->rect.height = p->sizes[i];
p->y += child->rect.height;
}
/* first we have the decoration, if this is a leaf node */
if (con_is_leaf(child)) {
if (child->border_style == BS_NORMAL) {
/* TODO: make a function for relative coords? */
child->deco_rect.x = child->rect.x - con->rect.x;
child->deco_rect.y = child->rect.y - con->rect.y;
child->rect.y += p->deco_height;
child->rect.height -= p->deco_height;
child->deco_rect.width = child->rect.width;
child->deco_rect.height = p->deco_height;
} else {
child->deco_rect.x = 0;
child->deco_rect.y = 0;
child->deco_rect.width = 0;
child->deco_rect.height = 0;
}
}
}
static void render_con_stacked(Con *con, Con *child, render_params *p, int i) {
assert(con->layout == L_STACKED);
child->rect.x = p->x;
child->rect.y = p->y;
child->rect.width = p->rect.width;
child->rect.height = p->rect.height;
child->deco_rect.x = p->x - con->rect.x;
child->deco_rect.y = p->y - con->rect.y + (i * p->deco_height);
child->deco_rect.width = child->rect.width;
child->deco_rect.height = p->deco_height;
if (p->children > 1 || (child->border_style != BS_PIXEL && child->border_style != BS_NONE)) {
child->rect.y += (p->deco_height * p->children);
child->rect.height -= (p->deco_height * p->children);
}
}
static void render_con_tabbed(Con *con, Con *child, render_params *p, int i) {
assert(con->layout == L_TABBED);
child->rect.x = p->x;
child->rect.y = p->y;
child->rect.width = p->rect.width;
child->rect.height = p->rect.height;
child->deco_rect.width = floor((float)child->rect.width / p->children);
child->deco_rect.x = p->x - con->rect.x + i * child->deco_rect.width;
child->deco_rect.y = p->y - con->rect.y;
/* Since the tab width may be something like 31,6 px per tab, we
* let the last tab have all the extra space (0,6 * children). */
if (i == (p->children - 1)) {
child->deco_rect.width = child->rect.width - child->deco_rect.x;
}
if (p->children > 1 || (child->border_style != BS_PIXEL && child->border_style != BS_NONE)) {
child->rect.y += p->deco_height;
child->rect.height -= p->deco_height;
child->deco_rect.height = p->deco_height;
} else {
child->deco_rect.height = (child->border_style == BS_PIXEL ? 1 : 0);
}
}
static void render_con_dockarea(Con *con, Con *child, render_params *p) {
assert(con->layout == L_DOCKAREA);
child->rect.x = p->x;
child->rect.y = p->y;
child->rect.width = p->rect.width;
child->rect.height = child->geometry.height;
child->deco_rect.x = 0;
child->deco_rect.y = 0;
child->deco_rect.width = 0;
child->deco_rect.height = 0;
p->y += child->rect.height;
}
/*
* Decides whether the container should be inset.
*/
bool should_inset_con(Con *con, int children) {
/* Don't inset floating containers and workspaces. */
if (con->type == CT_FLOATING_CON || con->type == CT_WORKSPACE)
return false;
if (con_is_leaf(con))
return true;
return (con->layout == L_STACKED || con->layout == L_TABBED) && children > 0;
}
/*
* Returns whether the given container has an adjacent container in the
* specified direction. In other words, this returns true if and only if
* the container is not touching the edge of the screen in that direction.
*/
bool has_adjacent_container(Con *con, direction_t direction) {
Con *workspace = con_get_workspace(con);
Con *fullscreen = con_get_fullscreen_con(workspace, CF_GLOBAL);
if (fullscreen == NULL)
fullscreen = con_get_fullscreen_con(workspace, CF_OUTPUT);
/* If this container is fullscreen by itself, there's no adjacent container. */
if (con == fullscreen)
return false;
Con *first = con;
Con *second = NULL;
bool found_neighbor = resize_find_tiling_participants(&first, &second, direction, false);
if (!found_neighbor)
return false;
/* If we have an adjacent container and nothing is fullscreen, we consider it. */
if (fullscreen == NULL)
return true;
/* For fullscreen containers, only consider the adjacent container if it is also fullscreen. */
return con_has_parent(con, fullscreen) && con_has_parent(second, fullscreen);
}