4 * i3 - an improved dynamic tiling window manager
6 * © 2009 Michael Stapelberg and contributors
8 * See file LICENSE for license information.
10 * layout.c: Functions handling layout/drawing of window decorations
32 * Updates *destination with new_value and returns true if it was changed or false
36 static bool update_if_necessary(uint32_t *destination, const uint32_t new_value) {
37 uint32_t old_value = *destination;
39 return ((*destination = new_value) != old_value);
43 * Gets the unoccupied space (= space which is available for windows which were resized by the user)
44 * for the given row. This is necessary to render both, customly resized windows and never touched
45 * windows correctly, meaning that the aspect ratio will be maintained when opening new windows.
48 int get_unoccupied_x(Workspace *workspace) {
49 int unoccupied = workspace->rect.width;
50 float default_factor = ((float)workspace->rect.width / workspace->cols) / workspace->rect.width;
52 LOG("get_unoccupied_x(), starting with %d, default_factor = %f\n", unoccupied, default_factor);
54 for (int cols = 0; cols < workspace->cols; cols++) {
55 LOG("width_factor[%d] = %f\n", cols, workspace->width_factor[cols]);
57 if (workspace->width_factor[cols] == 0)
58 unoccupied -= workspace->rect.width * default_factor;
61 LOG("unoccupied space: %d\n", unoccupied);
65 /* See get_unoccupied_x() */
66 int get_unoccupied_y(Workspace *workspace) {
67 int height = workspace->rect.height;
68 i3Font *font = load_font(global_conn, config.font);
70 /* Reserve space for dock clients */
72 SLIST_FOREACH(client, &(workspace->screen->dock_clients), dock_clients)
73 height -= client->desired_height;
75 /* Space for the internal bar */
76 height -= (font->height + 6);
78 int unoccupied = height;
79 float default_factor = ((float)height / workspace->rows) / height;
81 LOG("get_unoccupied_y(), starting with %d, default_factor = %f\n", unoccupied, default_factor);
83 for (int rows = 0; rows < workspace->rows; rows++) {
84 LOG("height_factor[%d] = %f\n", rows, workspace->height_factor[rows]);
85 if (workspace->height_factor[rows] == 0)
86 unoccupied -= height * default_factor;
89 LOG("unoccupied space: %d\n", unoccupied);
94 * Redecorates the given client correctly by checking if it’s in a stacking container and
95 * re-rendering the stack window or just calling decorate_window if it’s not in a stacking
99 void redecorate_window(xcb_connection_t *conn, Client *client) {
100 if (client->container != NULL &&
101 (client->container->mode == MODE_STACK ||
102 client->container->mode == MODE_TABBED)) {
103 render_container(conn, client->container);
104 /* We clear the frame to generate exposure events, because the color used
105 in drawing may be different */
106 xcb_clear_area(conn, true, client->frame, 0, 0, client->rect.width, client->rect.height);
107 } else decorate_window(conn, client, client->frame, client->titlegc, 0, 0);
112 * (Re-)draws window decorations for a given Client onto the given drawable/graphic context.
113 * When in stacking mode, the window decorations are drawn onto an own window.
116 void decorate_window(xcb_connection_t *conn, Client *client, xcb_drawable_t drawable,
117 xcb_gcontext_t gc, int offset_x, int offset_y) {
118 i3Font *font = load_font(conn, config.font);
119 int decoration_height = font->height + 2 + 2;
120 struct Colortriple *color;
121 Client *last_focused;
123 /* Clients without a container (docks) won’t get decorated */
127 last_focused = SLIST_FIRST(&(client->workspace->focus_stack));
128 /* Is the window urgent? */
130 color = &(config.client.urgent);
132 if (client_is_floating(client)) {
133 if (last_focused == client)
134 color = &(config.client.focused);
135 else color = &(config.client.unfocused);
137 if (client->container->currently_focused == client) {
138 /* Distinguish if the window is currently focused… */
139 if (last_focused == client && c_ws == client->workspace)
140 color = &(config.client.focused);
141 /* …or if it is the focused window in a not focused container */
142 else color = &(config.client.focused_inactive);
143 } else color = &(config.client.unfocused);
147 /* Our plan is the following:
148 - Draw a rect around the whole client in color->background
149 - Draw two lines in a lighter color
150 - Draw the window’s title
153 /* Draw a rectangle in background color around the window */
154 if (client->borderless && (client->container == NULL ||
155 (client->container->mode != MODE_STACK &&
156 client->container->mode != MODE_TABBED)))
157 xcb_change_gc_single(conn, gc, XCB_GC_FOREGROUND, get_colorpixel(conn, "#000000"));
158 else xcb_change_gc_single(conn, gc, XCB_GC_FOREGROUND, color->background);
160 /* In stacking mode, we only render the rect for this specific decoration */
161 if (client->container != NULL && (client->container->mode == MODE_STACK || client->container->mode == MODE_TABBED)) {
162 /* We need to use the container’s width because it is the more recent value - when
163 in stacking mode, clients get reconfigured only on demand (the not active client
164 is not reconfigured), so the client’s rect.width would be wrong */
165 xcb_rectangle_t rect = {offset_x, offset_y,
166 offset_x + client->container->width,
167 offset_y + decoration_height };
168 xcb_poly_fill_rectangle(conn, drawable, gc, 1, &rect);
170 xcb_rectangle_t rect = {0, 0, client->rect.width, client->rect.height};
171 xcb_poly_fill_rectangle(conn, drawable, gc, 1, &rect);
173 /* Draw the inner background to have a black frame around clients (such as mplayer)
174 which cannot be resized exactly in our frames and therefore are centered */
175 xcb_change_gc_single(conn, client->titlegc, XCB_GC_FOREGROUND, get_colorpixel(conn, "#000000"));
176 xcb_rectangle_t crect = {2, decoration_height,
177 client->rect.width - (2 + 2), client->rect.height - 2 - decoration_height};
178 xcb_poly_fill_rectangle(conn, client->frame, client->titlegc, 1, &crect);
181 if (client->titlebar_position != TITLEBAR_OFF) {
183 xcb_draw_line(conn, drawable, gc, color->border, offset_x, offset_y, offset_x + client->rect.width, offset_y);
184 if ((client->container == NULL ||
185 (client->container->mode != MODE_STACK &&
186 client->container->mode != MODE_TABBED) ||
187 CIRCLEQ_NEXT_OR_NULL(&(client->container->clients), client, clients) == NULL))
188 xcb_draw_line(conn, drawable, gc, color->border,
189 offset_x + 2, /* x */
190 offset_y + font->height + 3, /* y */
191 offset_x + client->rect.width - 3, /* to_x */
192 offset_y + font->height + 3 /* to_y */);
195 /* If the client has a title, we draw it */
196 if (client->name != NULL) {
198 uint32_t mask = XCB_GC_FOREGROUND | XCB_GC_BACKGROUND | XCB_GC_FONT;
199 uint32_t values[] = { color->text, color->background, font->id };
200 xcb_change_gc(conn, gc, mask, values);
202 /* name_len == -1 means this is a legacy application which does not specify _NET_WM_NAME,
203 and we don’t handle the old window name (COMPOUND_TEXT) but only _NET_WM_NAME, which
205 if (client->name_len == -1)
206 xcb_image_text_8(conn, strlen(client->name), drawable, gc, offset_x + 3 /* X */,
207 offset_y + font->height /* Y = baseline of font */, client->name);
209 xcb_image_text_16(conn, client->name_len, drawable, gc, offset_x + 3 /* X */,
210 offset_y + font->height /* Y = baseline of font */, (xcb_char2b_t*)client->name);
215 * Pushes the client’s x and y coordinates to X11
218 void reposition_client(xcb_connection_t *conn, Client *client) {
221 LOG("frame 0x%08x needs to be pushed to %dx%d\n", client->frame, client->rect.x, client->rect.y);
222 /* Note: We can use a pointer to client->x like an array of uint32_ts
223 because it is followed by client->y by definition */
224 xcb_configure_window(conn, client->frame, XCB_CONFIG_WINDOW_X | XCB_CONFIG_WINDOW_Y, &(client->rect.x));
226 if (!client_is_floating(client))
229 /* If the client is floating, we need to check if we moved it to a different workspace */
230 if (client->workspace->screen == (screen = get_screen_containing(client->rect.x, client->rect.y)))
233 if (screen == NULL) {
234 LOG("Boundary checking disabled, no screen found for (%d, %d)\n", client->rect.x, client->rect.y);
238 LOG("Client is on workspace %p with screen %p\n", client->workspace, client->workspace->screen);
239 LOG("but screen at %d, %d is %p\n", client->rect.x, client->rect.y, screen);
240 floating_assign_to_workspace(client, &workspaces[screen->current_workspace]);
244 * Pushes the client’s width/height to X11 and resizes the child window. This
245 * function also updates the client’s position, so if you work on tiling clients
246 * only, you can use this function instead of separate calls to reposition_client
247 * and resize_client to reduce flickering.
250 void resize_client(xcb_connection_t *conn, Client *client) {
251 i3Font *font = load_font(conn, config.font);
253 LOG("frame 0x%08x needs to be pushed to %dx%d\n", client->frame, client->rect.x, client->rect.y);
254 LOG("resizing client 0x%08x to %d x %d\n", client->frame, client->rect.width, client->rect.height);
255 xcb_configure_window(conn, client->frame,
256 XCB_CONFIG_WINDOW_X |
257 XCB_CONFIG_WINDOW_Y |
258 XCB_CONFIG_WINDOW_WIDTH |
259 XCB_CONFIG_WINDOW_HEIGHT,
262 /* Adjust the position of the child inside its frame.
263 * The coordinates of the child are relative to its frame, we
264 * add a border of 2 pixel to each value */
265 uint32_t mask = XCB_CONFIG_WINDOW_X |
266 XCB_CONFIG_WINDOW_Y |
267 XCB_CONFIG_WINDOW_WIDTH |
268 XCB_CONFIG_WINDOW_HEIGHT;
269 Rect *rect = &(client->child_rect);
270 switch ((client->container != NULL ? client->container->mode : MODE_DEFAULT)) {
275 rect->width = client->rect.width - (2 + 2);
276 rect->height = client->rect.height - 2;
279 if (client->titlebar_position == TITLEBAR_OFF && client->borderless) {
282 rect->width = client->rect.width;
283 rect->height = client->rect.height;
284 } else if (client->titlebar_position == TITLEBAR_OFF && !client->borderless) {
287 rect->width = client->rect.width - 1 - 1;
288 rect->height = client->rect.height - 1 - 1;
291 rect->y = font->height + 2 + 2;
292 rect->width = client->rect.width - (2 + 2);
293 rect->height = client->rect.height - ((font->height + 2 + 2) + 2);
298 /* Obey the ratio, if any */
299 if (client->proportional_height != 0 &&
300 client->proportional_width != 0) {
301 LOG("proportional height = %d, width = %d\n", client->proportional_height, client->proportional_width);
302 double new_height = rect->height + 1;
303 int new_width = rect->width;
305 while (new_height > rect->height) {
306 new_height = ((double)client->proportional_height / client->proportional_width) * new_width;
308 if (new_height > rect->height)
311 /* Center the window */
312 rect->y += ceil(rect->height / 2) - floor(new_height / 2);
313 rect->x += ceil(rect->width / 2) - floor(new_width / 2);
315 rect->height = new_height;
316 rect->width = new_width;
317 LOG("new_height = %f, new_width = %d\n", new_height, new_width);
320 if (client->height_increment > 1) {
321 int old_height = rect->height;
322 rect->height -= (rect->height - client->base_height) % client->height_increment;
323 LOG("Lost %d pixel due to client's height_increment (%d px)\n",
324 old_height - rect->height, client->height_increment);
327 if (client->width_increment > 1) {
328 int old_width = rect->width;
329 rect->width -= (rect->width - client->base_width) % client->width_increment;
330 LOG("Lost %d pixel due to client's width_increment (%d px)\n",
331 old_width - rect->width, client->width_increment);
334 LOG("child will be at %dx%d with size %dx%d\n", rect->x, rect->y, rect->width, rect->height);
336 xcb_configure_window(conn, client->child, mask, &(rect->x));
338 /* After configuring a child window we need to fake a configure_notify_event (see ICCCM 4.2.3).
339 * This is necessary to inform the client of its position relative to the root window,
340 * not relative to its frame (as done in the configure_notify_event by the x server). */
341 fake_absolute_configure_notify(conn, client);
343 /* Force redrawing after resizing the window because any now lost
344 * pixels could contain old garbage. */
345 xcb_expose_event_t generated;
346 generated.window = client->frame;
348 handle_expose_event(NULL, conn, &generated);
352 * Renders the given container. Is called by render_layout() or individually (for example
353 * when focus changes in a stacking container)
356 void render_container(xcb_connection_t *conn, Container *container) {
358 int num_clients = 0, current_client = 0;
360 CIRCLEQ_FOREACH(client, &(container->clients), clients)
363 if (container->mode == MODE_DEFAULT) {
364 CIRCLEQ_FOREACH(client, &(container->clients), clients) {
365 /* If the client is in fullscreen mode, it does not get reconfigured */
366 if (container->workspace->fullscreen_client == client) {
371 /* Check if we changed client->x or client->y by updating it.
372 * Note the bitwise OR instead of logical OR to force evaluation of both statements */
373 if (client->force_reconfigure |
374 update_if_necessary(&(client->rect.x), container->x) |
375 update_if_necessary(&(client->rect.y), container->y +
376 (container->height / num_clients) * current_client) |
377 update_if_necessary(&(client->rect.width), container->width) |
378 update_if_necessary(&(client->rect.height), container->height / num_clients))
379 resize_client(conn, client);
381 /* TODO: vertical default layout */
383 client->force_reconfigure = false;
388 i3Font *font = load_font(conn, config.font);
389 int decoration_height = (font->height + 2 + 2);
390 struct Stack_Window *stack_win = &(container->stack_win);
391 /* The size for each tab (width), necessary as a separate variable
392 * because num_clients gets fixed to 1 in tabbed mode. */
393 int size_each = (num_clients == 0 ? container->width : container->width / num_clients);
395 /* Check if we need to remap our stack title window, it gets unmapped when the container
396 is empty in src/handlers.c:unmap_notify() */
397 if (stack_win->rect.height == 0 && num_clients > 0) {
398 LOG("remapping stack win\n");
399 xcb_map_window(conn, stack_win->window);
400 } else LOG("not remapping stackwin, height = %d, num_clients = %d\n",
401 stack_win->rect.height, num_clients);
403 if (container->mode == MODE_TABBED) {
404 /* By setting num_clients to 1 we force that the stack window will be only one line
405 * high. The rest of the code is useful in both cases. */
406 LOG("tabbed mode, setting num_clients = 1\n");
411 /* Check if we need to reconfigure our stack title window */
412 if (update_if_necessary(&(stack_win->rect.x), container->x) |
413 update_if_necessary(&(stack_win->rect.y), container->y) |
414 update_if_necessary(&(stack_win->rect.width), container->width) |
415 update_if_necessary(&(stack_win->rect.height), decoration_height * num_clients)) {
417 /* Configuration can happen in two slightly different ways:
419 If there is no client in fullscreen mode, 5 parameters are passed
420 (x, y, width, height, stack mode is set to above which means top-most position).
422 If there is a fullscreen client, the fourth parameter is set to to the
423 fullscreen window as sibling and the stack mode is set to below, which means
424 that the stack_window will be placed just below the sibling, that is, under
425 the fullscreen window.
427 uint32_t values[] = { stack_win->rect.x, stack_win->rect.y,
428 stack_win->rect.width, stack_win->rect.height,
429 XCB_STACK_MODE_ABOVE, XCB_STACK_MODE_BELOW };
430 uint32_t mask = XCB_CONFIG_WINDOW_X | XCB_CONFIG_WINDOW_Y |
431 XCB_CONFIG_WINDOW_WIDTH | XCB_CONFIG_WINDOW_HEIGHT |
432 XCB_CONFIG_WINDOW_STACK_MODE;
434 /* Raise the stack window, but keep it below the first floating client
435 * and below the fullscreen client (if any) */
436 Client *first_floating = TAILQ_FIRST(&(container->workspace->floating_clients));
437 if (first_floating != TAILQ_END(&(container->workspace->floating_clients))) {
438 mask |= XCB_CONFIG_WINDOW_SIBLING;
439 values[4] = first_floating->frame;
440 } else if (container->workspace->fullscreen_client != NULL) {
441 mask |= XCB_CONFIG_WINDOW_SIBLING;
442 values[4] = container->workspace->fullscreen_client->frame;
445 xcb_configure_window(conn, stack_win->window, mask, values);
448 /* Prepare the pixmap for usage */
449 cached_pixmap_prepare(conn, &(stack_win->pixmap));
451 /* Render the decorations of all clients */
452 CIRCLEQ_FOREACH(client, &(container->clients), clients) {
453 /* If the client is in fullscreen mode, it does not get reconfigured */
454 if (container->workspace->fullscreen_client == client) {
459 /* Check if we changed client->x or client->y by updating it.
460 * Note the bitwise OR instead of logical OR to force evaluation of all statements */
461 if (client->force_reconfigure |
462 update_if_necessary(&(client->rect.x), container->x) |
463 update_if_necessary(&(client->rect.y), container->y + (decoration_height * num_clients)) |
464 update_if_necessary(&(client->rect.width), container->width) |
465 update_if_necessary(&(client->rect.height), container->height - (decoration_height * num_clients)))
466 resize_client(conn, client);
468 client->force_reconfigure = false;
472 if (container->mode == MODE_STACK)
473 offset_y = current_client++ * decoration_height;
474 else if (container->mode == MODE_TABBED)
475 offset_x = current_client++ * size_each;
476 decorate_window(conn, client, stack_win->pixmap.id, stack_win->pixmap.gc,
480 xcb_copy_area(conn, stack_win->pixmap.id, stack_win->window, stack_win->pixmap.gc,
481 0, 0, 0, 0, stack_win->rect.width, stack_win->rect.height);
485 static void render_bars(xcb_connection_t *conn, Workspace *r_ws, int width, int *height) {
487 SLIST_FOREACH(client, &(r_ws->screen->dock_clients), dock_clients) {
488 LOG("client is at %d, should be at %d\n", client->rect.y, *height);
489 if (client->force_reconfigure |
490 update_if_necessary(&(client->rect.x), r_ws->rect.x) |
491 update_if_necessary(&(client->rect.y), *height))
492 reposition_client(conn, client);
494 if (client->force_reconfigure |
495 update_if_necessary(&(client->rect.width), width) |
496 update_if_necessary(&(client->rect.height), client->desired_height))
497 resize_client(conn, client);
499 client->force_reconfigure = false;
500 LOG("desired_height = %d\n", client->desired_height);
501 *height += client->desired_height;
505 static void render_internal_bar(xcb_connection_t *conn, Workspace *r_ws, int width, int height) {
506 i3Font *font = load_font(conn, config.font);
507 i3Screen *screen = r_ws->screen;
508 enum { SET_NORMAL = 0, SET_FOCUSED = 1 };
510 /* Fill the whole bar in black */
511 xcb_change_gc_single(conn, screen->bargc, XCB_GC_FOREGROUND, get_colorpixel(conn, "#000000"));
512 xcb_rectangle_t rect = {0, 0, width, height};
513 xcb_poly_fill_rectangle(conn, screen->bar, screen->bargc, 1, &rect);
516 xcb_change_gc_single(conn, screen->bargc, XCB_GC_FONT, font->id);
519 for (int c = 0; c < 10; c++) {
520 if (workspaces[c].screen != screen)
523 struct Colortriple *color;
524 Workspace *ws = &workspaces[c];
526 if (screen->current_workspace == c)
527 color = &(config.bar.focused);
529 color = &(config.bar.urgent);
530 else color = &(config.bar.unfocused);
532 /* Draw the outer rect */
533 xcb_draw_rect(conn, screen->bar, screen->bargc, color->border,
536 ws->text_width + 5 + 5, /* width = text width + 5 px left + 5px right */
537 height - 2 /* height = max. height - 1 px upper and 1 px bottom border */);
539 /* Draw the background of this rect */
540 xcb_draw_rect(conn, screen->bar, screen->bargc, color->background,
543 ws->text_width + 4 + 4,
546 xcb_change_gc_single(conn, screen->bargc, XCB_GC_FOREGROUND, color->text);
547 xcb_change_gc_single(conn, screen->bargc, XCB_GC_BACKGROUND, color->background);
548 xcb_image_text_16(conn, ws->name_len, screen->bar, screen->bargc, drawn + 5 /* X */,
549 font->height + 1 /* Y = baseline of font */,
550 (xcb_char2b_t*)ws->name);
551 drawn += ws->text_width + 12;
556 * Modifies the event mask of all clients on the given workspace to either ignore or to handle
557 * enter notifies. It is handy to ignore notifies because they will be sent when a window is mapped
558 * under the cursor, thus when the user didn’t enter the window actively at all.
561 void ignore_enter_notify_forall(xcb_connection_t *conn, Workspace *workspace, bool ignore_enter_notify) {
566 CIRCLEQ_FOREACH(client, &(workspace->table[cols][rows]->clients), clients) {
567 /* Change event mask for the decorations */
568 values[0] = FRAME_EVENT_MASK;
569 if (ignore_enter_notify)
570 values[0] &= ~(XCB_EVENT_MASK_ENTER_WINDOW);
571 xcb_change_window_attributes(conn, client->frame, XCB_CW_EVENT_MASK, values);
573 /* Change event mask for the child itself */
574 values[0] = CHILD_EVENT_MASK;
575 if (ignore_enter_notify)
576 values[0] &= ~(XCB_EVENT_MASK_ENTER_WINDOW);
577 xcb_change_window_attributes(conn, client->child, XCB_CW_EVENT_MASK, values);
582 * Renders the given workspace on the given screen
585 void render_workspace(xcb_connection_t *conn, i3Screen *screen, Workspace *r_ws) {
586 i3Font *font = load_font(conn, config.font);
587 int width = r_ws->rect.width;
588 int height = r_ws->rect.height;
590 /* Reserve space for dock clients */
592 SLIST_FOREACH(client, &(screen->dock_clients), dock_clients)
593 height -= client->desired_height;
595 /* Space for the internal bar */
596 height -= (font->height + 6);
598 int xoffset[r_ws->rows];
599 int yoffset[r_ws->cols];
600 /* Initialize offsets */
601 for (int cols = 0; cols < r_ws->cols; cols++)
602 yoffset[cols] = r_ws->rect.y;
603 for (int rows = 0; rows < r_ws->rows; rows++)
604 xoffset[rows] = r_ws->rect.x;
606 ignore_enter_notify_forall(conn, r_ws, true);
608 /* Go through the whole table and render what’s necessary */
610 Container *container = r_ws->table[cols][rows];
611 int single_width = -1, single_height = -1;
612 /* Update position of the container */
613 container->row = rows;
614 container->col = cols;
615 container->x = xoffset[rows];
616 container->y = yoffset[cols];
617 container->width = 0;
619 for (int c = 0; c < container->colspan; c++) {
620 if (r_ws->width_factor[cols+c] == 0)
621 container->width += (width / r_ws->cols);
622 else container->width += get_unoccupied_x(r_ws) * r_ws->width_factor[cols+c];
624 if (single_width == -1)
625 single_width = container->width;
628 LOG("height is %d\n", height);
630 container->height = 0;
632 for (int c = 0; c < container->rowspan; c++) {
633 if (r_ws->height_factor[rows+c] == 0)
634 container->height += (height / r_ws->rows);
635 else container->height += get_unoccupied_y(r_ws) * r_ws->height_factor[rows+c];
637 if (single_height == -1)
638 single_height = container->height;
641 /* Render the container if it is not empty */
642 render_container(conn, container);
644 xoffset[rows] += single_width;
645 yoffset[cols] += single_height;
648 ignore_enter_notify_forall(conn, r_ws, false);
650 render_bars(conn, r_ws, width, &height);
651 render_internal_bar(conn, r_ws, width, font->height + 6);
655 * Renders the whole layout, that is: Go through each screen, each workspace, each container
656 * and render each client. This also renders the bars.
658 * If you don’t need to render *everything*, you should call render_container on the container
659 * you want to refresh.
662 void render_layout(xcb_connection_t *conn) {
665 TAILQ_FOREACH(screen, virtual_screens, screens)
666 render_workspace(conn, screen, &(workspaces[screen->current_workspace]));