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 if (client_is_floating(client)) {
129 if (last_focused == client)
130 color = &(config.client.focused);
131 else color = &(config.client.unfocused);
133 if (client->container->currently_focused == client) {
134 /* Distinguish if the window is currently focused… */
135 if (last_focused == client && c_ws == client->workspace)
136 color = &(config.client.focused);
137 /* …or if it is the focused window in a not focused container */
138 else color = &(config.client.focused_inactive);
139 } else color = &(config.client.unfocused);
142 /* Our plan is the following:
143 - Draw a rect around the whole client in color->background
144 - Draw two lines in a lighter color
145 - Draw the window’s title
148 /* Draw a rectangle in background color around the window */
149 if (client->borderless && (client->container == NULL ||
150 (client->container->mode != MODE_STACK &&
151 client->container->mode != MODE_TABBED)))
152 xcb_change_gc_single(conn, gc, XCB_GC_FOREGROUND, get_colorpixel(conn, "#000000"));
153 else xcb_change_gc_single(conn, gc, XCB_GC_FOREGROUND, color->background);
155 /* In stacking mode, we only render the rect for this specific decoration */
156 if (client->container != NULL && (client->container->mode == MODE_STACK || client->container->mode == MODE_TABBED)) {
157 /* We need to use the container’s width because it is the more recent value - when
158 in stacking mode, clients get reconfigured only on demand (the not active client
159 is not reconfigured), so the client’s rect.width would be wrong */
160 xcb_rectangle_t rect = {offset_x, offset_y,
161 offset_x + client->container->width,
162 offset_y + decoration_height };
163 xcb_poly_fill_rectangle(conn, drawable, gc, 1, &rect);
165 xcb_rectangle_t rect = {0, 0, client->rect.width, client->rect.height};
166 xcb_poly_fill_rectangle(conn, drawable, gc, 1, &rect);
168 /* Draw the inner background to have a black frame around clients (such as mplayer)
169 which cannot be resized exactly in our frames and therefore are centered */
170 xcb_change_gc_single(conn, client->titlegc, XCB_GC_FOREGROUND, get_colorpixel(conn, "#000000"));
171 xcb_rectangle_t crect = {2, decoration_height,
172 client->rect.width - (2 + 2), client->rect.height - 2 - decoration_height};
173 xcb_poly_fill_rectangle(conn, client->frame, client->titlegc, 1, &crect);
176 if (client->titlebar_position != TITLEBAR_OFF) {
178 xcb_draw_line(conn, drawable, gc, color->border, offset_x, offset_y, offset_x + client->rect.width, offset_y);
179 if ((client->container == NULL ||
180 (client->container->mode != MODE_STACK &&
181 client->container->mode != MODE_TABBED) ||
182 CIRCLEQ_NEXT_OR_NULL(&(client->container->clients), client, clients) == NULL))
183 xcb_draw_line(conn, drawable, gc, color->border,
184 offset_x + 2, /* x */
185 offset_y + font->height + 3, /* y */
186 offset_x + client->rect.width - 3, /* to_x */
187 offset_y + font->height + 3 /* to_y */);
190 /* If the client has a title, we draw it */
191 if (client->name != NULL) {
193 uint32_t mask = XCB_GC_FOREGROUND | XCB_GC_BACKGROUND | XCB_GC_FONT;
194 uint32_t values[] = { color->text, color->background, font->id };
195 xcb_change_gc(conn, gc, mask, values);
197 /* name_len == -1 means this is a legacy application which does not specify _NET_WM_NAME,
198 and we don’t handle the old window name (COMPOUND_TEXT) but only _NET_WM_NAME, which
200 if (client->name_len == -1)
201 xcb_image_text_8(conn, strlen(client->name), drawable, gc, offset_x + 3 /* X */,
202 offset_y + font->height /* Y = baseline of font */, client->name);
204 xcb_image_text_16(conn, client->name_len, drawable, gc, offset_x + 3 /* X */,
205 offset_y + font->height /* Y = baseline of font */, (xcb_char2b_t*)client->name);
210 * Pushes the client’s x and y coordinates to X11
213 void reposition_client(xcb_connection_t *conn, Client *client) {
216 LOG("frame 0x%08x needs to be pushed to %dx%d\n", client->frame, client->rect.x, client->rect.y);
217 /* Note: We can use a pointer to client->x like an array of uint32_ts
218 because it is followed by client->y by definition */
219 xcb_configure_window(conn, client->frame, XCB_CONFIG_WINDOW_X | XCB_CONFIG_WINDOW_Y, &(client->rect.x));
221 if (!client_is_floating(client))
224 /* If the client is floating, we need to check if we moved it to a different workspace */
225 if (client->workspace->screen == (screen = get_screen_containing(client->rect.x, client->rect.y)))
228 if (screen == NULL) {
229 LOG("Boundary checking disabled, no screen found for (%d, %d)\n", client->rect.x, client->rect.y);
233 LOG("Client is on workspace %p with screen %p\n", client->workspace, client->workspace->screen);
234 LOG("but screen at %d, %d is %p\n", client->rect.x, client->rect.y, screen);
235 floating_assign_to_workspace(client, &workspaces[screen->current_workspace]);
239 * Pushes the client’s width/height to X11 and resizes the child window. This
240 * function also updates the client’s position, so if you work on tiling clients
241 * only, you can use this function instead of separate calls to reposition_client
242 * and resize_client to reduce flickering.
245 void resize_client(xcb_connection_t *conn, Client *client) {
246 i3Font *font = load_font(conn, config.font);
248 LOG("frame 0x%08x needs to be pushed to %dx%d\n", client->frame, client->rect.x, client->rect.y);
249 LOG("resizing client 0x%08x to %d x %d\n", client->frame, client->rect.width, client->rect.height);
250 xcb_configure_window(conn, client->frame,
251 XCB_CONFIG_WINDOW_X |
252 XCB_CONFIG_WINDOW_Y |
253 XCB_CONFIG_WINDOW_WIDTH |
254 XCB_CONFIG_WINDOW_HEIGHT,
257 /* Adjust the position of the child inside its frame.
258 * The coordinates of the child are relative to its frame, we
259 * add a border of 2 pixel to each value */
260 uint32_t mask = XCB_CONFIG_WINDOW_X |
261 XCB_CONFIG_WINDOW_Y |
262 XCB_CONFIG_WINDOW_WIDTH |
263 XCB_CONFIG_WINDOW_HEIGHT;
264 Rect *rect = &(client->child_rect);
265 switch ((client->container != NULL ? client->container->mode : MODE_DEFAULT)) {
270 rect->width = client->rect.width - (2 + 2);
271 rect->height = client->rect.height - 2;
274 if (client->titlebar_position == TITLEBAR_OFF && client->borderless) {
277 rect->width = client->rect.width;
278 rect->height = client->rect.height;
279 } else if (client->titlebar_position == TITLEBAR_OFF && !client->borderless) {
282 rect->width = client->rect.width - 1 - 1;
283 rect->height = client->rect.height - 1 - 1;
286 rect->y = font->height + 2 + 2;
287 rect->width = client->rect.width - (2 + 2);
288 rect->height = client->rect.height - ((font->height + 2 + 2) + 2);
293 /* Obey the ratio, if any */
294 if (client->proportional_height != 0 &&
295 client->proportional_width != 0) {
296 LOG("proportional height = %d, width = %d\n", client->proportional_height, client->proportional_width);
297 double new_height = rect->height + 1;
298 int new_width = rect->width;
300 while (new_height > rect->height) {
301 new_height = ((double)client->proportional_height / client->proportional_width) * new_width;
303 if (new_height > rect->height)
306 /* Center the window */
307 rect->y += ceil(rect->height / 2) - floor(new_height / 2);
308 rect->x += ceil(rect->width / 2) - floor(new_width / 2);
310 rect->height = new_height;
311 rect->width = new_width;
312 LOG("new_height = %f, new_width = %d\n", new_height, new_width);
315 if (client->height_increment > 1) {
316 int old_height = rect->height;
317 rect->height -= (rect->height - client->base_height) % client->height_increment;
318 LOG("Lost %d pixel due to client's height_increment (%d px)\n",
319 old_height - rect->height, client->height_increment);
322 if (client->width_increment > 1) {
323 int old_width = rect->width;
324 rect->width -= (rect->width - client->base_width) % client->width_increment;
325 LOG("Lost %d pixel due to client's width_increment (%d px)\n",
326 old_width - rect->width, client->width_increment);
329 LOG("child will be at %dx%d with size %dx%d\n", rect->x, rect->y, rect->width, rect->height);
331 xcb_configure_window(conn, client->child, mask, &(rect->x));
333 /* After configuring a child window we need to fake a configure_notify_event (see ICCCM 4.2.3).
334 * This is necessary to inform the client of its position relative to the root window,
335 * not relative to its frame (as done in the configure_notify_event by the x server). */
336 fake_absolute_configure_notify(conn, client);
338 /* Force redrawing after resizing the window because any now lost
339 * pixels could contain old garbage. */
340 xcb_expose_event_t generated;
341 generated.window = client->frame;
343 handle_expose_event(NULL, conn, &generated);
347 * Renders the given container. Is called by render_layout() or individually (for example
348 * when focus changes in a stacking container)
351 void render_container(xcb_connection_t *conn, Container *container) {
353 int num_clients = 0, current_client = 0;
355 CIRCLEQ_FOREACH(client, &(container->clients), clients)
358 if (container->mode == MODE_DEFAULT) {
359 CIRCLEQ_FOREACH(client, &(container->clients), clients) {
360 /* If the client is in fullscreen mode, it does not get reconfigured */
361 if (container->workspace->fullscreen_client == client) {
366 /* Check if we changed client->x or client->y by updating it.
367 * Note the bitwise OR instead of logical OR to force evaluation of both statements */
368 if (client->force_reconfigure |
369 update_if_necessary(&(client->rect.x), container->x) |
370 update_if_necessary(&(client->rect.y), container->y +
371 (container->height / num_clients) * current_client) |
372 update_if_necessary(&(client->rect.width), container->width) |
373 update_if_necessary(&(client->rect.height), container->height / num_clients))
374 resize_client(conn, client);
376 /* TODO: vertical default layout */
378 client->force_reconfigure = false;
383 i3Font *font = load_font(conn, config.font);
384 int decoration_height = (font->height + 2 + 2);
385 struct Stack_Window *stack_win = &(container->stack_win);
386 /* The size for each tab (width), necessary as a separate variable
387 * because num_clients gets fixed to 1 in tabbed mode. */
388 int size_each = (num_clients == 0 ? container->width : container->width / num_clients);
390 /* Check if we need to remap our stack title window, it gets unmapped when the container
391 is empty in src/handlers.c:unmap_notify() */
392 if (stack_win->rect.height == 0 && num_clients > 0) {
393 LOG("remapping stack win\n");
394 xcb_map_window(conn, stack_win->window);
395 } else LOG("not remapping stackwin, height = %d, num_clients = %d\n",
396 stack_win->rect.height, num_clients);
398 if (container->mode == MODE_TABBED) {
399 /* By setting num_clients to 1 we force that the stack window will be only one line
400 * high. The rest of the code is useful in both cases. */
401 LOG("tabbed mode, setting num_clients = 1\n");
406 /* Check if we need to reconfigure our stack title window */
407 if (update_if_necessary(&(stack_win->rect.x), container->x) |
408 update_if_necessary(&(stack_win->rect.y), container->y) |
409 update_if_necessary(&(stack_win->rect.width), container->width) |
410 update_if_necessary(&(stack_win->rect.height), decoration_height * num_clients)) {
412 /* Configuration can happen in two slightly different ways:
414 If there is no client in fullscreen mode, 5 parameters are passed
415 (x, y, width, height, stack mode is set to above which means top-most position).
417 If there is a fullscreen client, the fourth parameter is set to to the
418 fullscreen window as sibling and the stack mode is set to below, which means
419 that the stack_window will be placed just below the sibling, that is, under
420 the fullscreen window.
422 uint32_t values[] = { stack_win->rect.x, stack_win->rect.y,
423 stack_win->rect.width, stack_win->rect.height,
424 XCB_STACK_MODE_ABOVE, XCB_STACK_MODE_BELOW };
425 uint32_t mask = XCB_CONFIG_WINDOW_X | XCB_CONFIG_WINDOW_Y |
426 XCB_CONFIG_WINDOW_WIDTH | XCB_CONFIG_WINDOW_HEIGHT |
427 XCB_CONFIG_WINDOW_STACK_MODE;
429 /* Raise the stack window, but keep it below the first floating client
430 * and below the fullscreen client (if any) */
431 Client *first_floating = TAILQ_FIRST(&(container->workspace->floating_clients));
432 if (first_floating != TAILQ_END(&(container->workspace->floating_clients))) {
433 mask |= XCB_CONFIG_WINDOW_SIBLING;
434 values[4] = first_floating->frame;
435 } else if (container->workspace->fullscreen_client != NULL) {
436 mask |= XCB_CONFIG_WINDOW_SIBLING;
437 values[4] = container->workspace->fullscreen_client->frame;
440 xcb_configure_window(conn, stack_win->window, mask, values);
443 /* Prepare the pixmap for usage */
444 cached_pixmap_prepare(conn, &(stack_win->pixmap));
446 /* Render the decorations of all clients */
447 CIRCLEQ_FOREACH(client, &(container->clients), clients) {
448 /* If the client is in fullscreen mode, it does not get reconfigured */
449 if (container->workspace->fullscreen_client == client) {
454 /* Check if we changed client->x or client->y by updating it.
455 * Note the bitwise OR instead of logical OR to force evaluation of all statements */
456 if (client->force_reconfigure |
457 update_if_necessary(&(client->rect.x), container->x) |
458 update_if_necessary(&(client->rect.y), container->y + (decoration_height * num_clients)) |
459 update_if_necessary(&(client->rect.width), container->width) |
460 update_if_necessary(&(client->rect.height), container->height - (decoration_height * num_clients)))
461 resize_client(conn, client);
463 client->force_reconfigure = false;
467 if (container->mode == MODE_STACK)
468 offset_y = current_client++ * decoration_height;
469 else if (container->mode == MODE_TABBED)
470 offset_x = current_client++ * size_each;
471 decorate_window(conn, client, stack_win->pixmap.id, stack_win->pixmap.gc,
475 xcb_copy_area(conn, stack_win->pixmap.id, stack_win->window, stack_win->pixmap.gc,
476 0, 0, 0, 0, stack_win->rect.width, stack_win->rect.height);
480 static void render_bars(xcb_connection_t *conn, Workspace *r_ws, int width, int *height) {
482 SLIST_FOREACH(client, &(r_ws->screen->dock_clients), dock_clients) {
483 LOG("client is at %d, should be at %d\n", client->rect.y, *height);
484 if (client->force_reconfigure |
485 update_if_necessary(&(client->rect.x), r_ws->rect.x) |
486 update_if_necessary(&(client->rect.y), *height))
487 reposition_client(conn, client);
489 if (client->force_reconfigure |
490 update_if_necessary(&(client->rect.width), width) |
491 update_if_necessary(&(client->rect.height), client->desired_height))
492 resize_client(conn, client);
494 client->force_reconfigure = false;
495 LOG("desired_height = %d\n", client->desired_height);
496 *height += client->desired_height;
500 static void render_internal_bar(xcb_connection_t *conn, Workspace *r_ws, int width, int height) {
501 i3Font *font = load_font(conn, config.font);
502 i3Screen *screen = r_ws->screen;
503 enum { SET_NORMAL = 0, SET_FOCUSED = 1 };
505 /* Fill the whole bar in black */
506 xcb_change_gc_single(conn, screen->bargc, XCB_GC_FOREGROUND, get_colorpixel(conn, "#000000"));
507 xcb_rectangle_t rect = {0, 0, width, height};
508 xcb_poly_fill_rectangle(conn, screen->bar, screen->bargc, 1, &rect);
511 xcb_change_gc_single(conn, screen->bargc, XCB_GC_FONT, font->id);
514 for (int c = 0; c < 10; c++) {
515 if (workspaces[c].screen != screen)
518 struct Colortriple *color = (screen->current_workspace == c ? &(config.bar.focused) :
519 &(config.bar.unfocused));
520 Workspace *ws = &workspaces[c];
522 /* Draw the outer rect */
523 xcb_draw_rect(conn, screen->bar, screen->bargc, color->border,
526 ws->text_width + 5 + 5, /* width = text width + 5 px left + 5px right */
527 height - 2 /* height = max. height - 1 px upper and 1 px bottom border */);
529 /* Draw the background of this rect */
530 xcb_draw_rect(conn, screen->bar, screen->bargc, color->background,
533 ws->text_width + 4 + 4,
536 xcb_change_gc_single(conn, screen->bargc, XCB_GC_FOREGROUND, color->text);
537 xcb_change_gc_single(conn, screen->bargc, XCB_GC_BACKGROUND, color->background);
538 xcb_image_text_16(conn, ws->name_len, screen->bar, screen->bargc, drawn + 5 /* X */,
539 font->height + 1 /* Y = baseline of font */,
540 (xcb_char2b_t*)ws->name);
541 drawn += ws->text_width + 12;
546 * Modifies the event mask of all clients on the given workspace to either ignore or to handle
547 * enter notifies. It is handy to ignore notifies because they will be sent when a window is mapped
548 * under the cursor, thus when the user didn’t enter the window actively at all.
551 void ignore_enter_notify_forall(xcb_connection_t *conn, Workspace *workspace, bool ignore_enter_notify) {
556 CIRCLEQ_FOREACH(client, &(workspace->table[cols][rows]->clients), clients) {
557 /* Change event mask for the decorations */
558 values[0] = FRAME_EVENT_MASK;
559 if (ignore_enter_notify)
560 values[0] &= ~(XCB_EVENT_MASK_ENTER_WINDOW);
561 xcb_change_window_attributes(conn, client->frame, XCB_CW_EVENT_MASK, values);
563 /* Change event mask for the child itself */
564 values[0] = CHILD_EVENT_MASK;
565 if (ignore_enter_notify)
566 values[0] &= ~(XCB_EVENT_MASK_ENTER_WINDOW);
567 xcb_change_window_attributes(conn, client->child, XCB_CW_EVENT_MASK, values);
572 * Renders the given workspace on the given screen
575 void render_workspace(xcb_connection_t *conn, i3Screen *screen, Workspace *r_ws) {
576 i3Font *font = load_font(conn, config.font);
577 int width = r_ws->rect.width;
578 int height = r_ws->rect.height;
580 /* Reserve space for dock clients */
582 SLIST_FOREACH(client, &(screen->dock_clients), dock_clients)
583 height -= client->desired_height;
585 /* Space for the internal bar */
586 height -= (font->height + 6);
588 int xoffset[r_ws->rows];
589 int yoffset[r_ws->cols];
590 /* Initialize offsets */
591 for (int cols = 0; cols < r_ws->cols; cols++)
592 yoffset[cols] = r_ws->rect.y;
593 for (int rows = 0; rows < r_ws->rows; rows++)
594 xoffset[rows] = r_ws->rect.x;
596 ignore_enter_notify_forall(conn, r_ws, true);
598 /* Go through the whole table and render what’s necessary */
600 Container *container = r_ws->table[cols][rows];
601 int single_width = -1, single_height = -1;
602 /* Update position of the container */
603 container->row = rows;
604 container->col = cols;
605 container->x = xoffset[rows];
606 container->y = yoffset[cols];
607 container->width = 0;
609 for (int c = 0; c < container->colspan; c++) {
610 if (r_ws->width_factor[cols+c] == 0)
611 container->width += (width / r_ws->cols);
612 else container->width += get_unoccupied_x(r_ws) * r_ws->width_factor[cols+c];
614 if (single_width == -1)
615 single_width = container->width;
618 LOG("height is %d\n", height);
620 container->height = 0;
622 for (int c = 0; c < container->rowspan; c++) {
623 if (r_ws->height_factor[rows+c] == 0)
624 container->height += (height / r_ws->rows);
625 else container->height += get_unoccupied_y(r_ws) * r_ws->height_factor[rows+c];
627 if (single_height == -1)
628 single_height = container->height;
632 //if (container->height_factor == 0)
633 //container->height = (height / r_ws->rows);
634 //else container->height = get_unoccupied_y(r_ws, cols) * container->height_factor;
635 //single_height = container->height;
636 //container->height *= container->rowspan;
638 /* Render the container if it is not empty */
639 render_container(conn, container);
641 xoffset[rows] += single_width;
642 yoffset[cols] += single_height;
645 ignore_enter_notify_forall(conn, r_ws, false);
647 render_bars(conn, r_ws, width, &height);
648 render_internal_bar(conn, r_ws, width, font->height + 6);
652 * Renders the whole layout, that is: Go through each screen, each workspace, each container
653 * and render each client. This also renders the bars.
655 * If you don’t need to render *everything*, you should call render_container on the container
656 * you want to refresh.
659 void render_layout(xcb_connection_t *conn) {
662 TAILQ_FOREACH(screen, virtual_screens, screens)
663 render_workspace(conn, screen, &(workspaces[screen->current_workspace]));