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, int col) {
67 int unoccupied = workspace->rect.height;
68 float default_factor = ((float)workspace->rect.height / workspace->rows) / workspace->rect.height;
70 LOG("get_unoccupied_y(), starting with %d, default_factor = %f\n", unoccupied, default_factor);
72 for (int rows = 0; rows < workspace->rows; rows++) {
73 LOG("height_factor[%d] = %f\n", rows, workspace->height_factor[rows]);
74 if (workspace->height_factor[rows] == 0)
75 unoccupied -= workspace->rect.height * default_factor;
78 LOG("unoccupied space: %d\n", unoccupied);
83 * Redecorates the given client correctly by checking if it’s in a stacking container and
84 * re-rendering the stack window or just calling decorate_window if it’s not in a stacking
88 void redecorate_window(xcb_connection_t *conn, Client *client) {
89 if (client->container != NULL &&
90 (client->container->mode == MODE_STACK ||
91 client->container->mode == MODE_TABBED)) {
92 render_container(conn, client->container);
93 /* We clear the frame to generate exposure events, because the color used
94 in drawing may be different */
95 xcb_clear_area(conn, true, client->frame, 0, 0, client->rect.width, client->rect.height);
96 } else decorate_window(conn, client, client->frame, client->titlegc, 0, 0);
101 * (Re-)draws window decorations for a given Client onto the given drawable/graphic context.
102 * When in stacking mode, the window decorations are drawn onto an own window.
105 void decorate_window(xcb_connection_t *conn, Client *client, xcb_drawable_t drawable,
106 xcb_gcontext_t gc, int offset_x, int offset_y) {
107 i3Font *font = load_font(conn, config.font);
108 int decoration_height = font->height + 2 + 2;
109 struct Colortriple *color;
110 Client *last_focused;
112 /* Clients without a container (docks) won’t get decorated */
116 last_focused = SLIST_FIRST(&(client->workspace->focus_stack));
117 if (client_is_floating(client)) {
118 if (last_focused == client)
119 color = &(config.client.focused);
120 else color = &(config.client.unfocused);
122 if (client->container->currently_focused == client) {
123 /* Distinguish if the window is currently focused… */
124 if (last_focused == client && c_ws == client->workspace)
125 color = &(config.client.focused);
126 /* …or if it is the focused window in a not focused container */
127 else color = &(config.client.focused_inactive);
128 } else color = &(config.client.unfocused);
131 /* Our plan is the following:
132 - Draw a rect around the whole client in color->background
133 - Draw two lines in a lighter color
134 - Draw the window’s title
137 /* Draw a rectangle in background color around the window */
138 if (client->borderless)
139 xcb_change_gc_single(conn, gc, XCB_GC_FOREGROUND, get_colorpixel(conn, "#000000"));
140 else xcb_change_gc_single(conn, gc, XCB_GC_FOREGROUND, color->background);
142 /* In stacking mode, we only render the rect for this specific decoration */
143 if (client->container != NULL && (client->container->mode == MODE_STACK || client->container->mode == MODE_TABBED)) {
144 /* We need to use the container’s width because it is the more recent value - when
145 in stacking mode, clients get reconfigured only on demand (the not active client
146 is not reconfigured), so the client’s rect.width would be wrong */
147 xcb_rectangle_t rect = {offset_x, offset_y,
148 offset_x + client->container->width,
149 offset_y + decoration_height };
150 xcb_poly_fill_rectangle(conn, drawable, gc, 1, &rect);
152 xcb_rectangle_t rect = {0, 0, client->rect.width, client->rect.height};
153 xcb_poly_fill_rectangle(conn, drawable, gc, 1, &rect);
155 /* Draw the inner background to have a black frame around clients (such as mplayer)
156 which cannot be resized exactly in our frames and therefore are centered */
157 xcb_change_gc_single(conn, client->titlegc, XCB_GC_FOREGROUND, get_colorpixel(conn, "#000000"));
158 xcb_rectangle_t crect = {2, decoration_height,
159 client->rect.width - (2 + 2), client->rect.height - 2 - decoration_height};
160 xcb_poly_fill_rectangle(conn, client->frame, client->titlegc, 1, &crect);
163 if (client->titlebar_position != TITLEBAR_OFF) {
165 xcb_draw_line(conn, drawable, gc, color->border, offset_x, offset_y, offset_x + client->rect.width, offset_y);
166 if ((client->container == NULL ||
167 (client->container->mode != MODE_STACK &&
168 client->container->mode != MODE_TABBED) ||
169 CIRCLEQ_NEXT_OR_NULL(&(client->container->clients), client, clients) == NULL))
170 xcb_draw_line(conn, drawable, gc, color->border,
171 offset_x + 2, /* x */
172 offset_y + font->height + 3, /* y */
173 offset_x + client->rect.width - 3, /* to_x */
174 offset_y + font->height + 3 /* to_y */);
177 /* If the client has a title, we draw it */
178 if (client->name != NULL) {
180 uint32_t mask = XCB_GC_FOREGROUND | XCB_GC_BACKGROUND | XCB_GC_FONT;
181 uint32_t values[] = { color->text, color->background, font->id };
182 xcb_change_gc(conn, gc, mask, values);
184 /* name_len == -1 means this is a legacy application which does not specify _NET_WM_NAME,
185 and we don’t handle the old window name (COMPOUND_TEXT) but only _NET_WM_NAME, which
187 if (client->name_len == -1)
188 xcb_image_text_8(conn, strlen(client->name), drawable, gc, offset_x + 3 /* X */,
189 offset_y + font->height /* Y = baseline of font */, client->name);
191 xcb_image_text_16(conn, client->name_len, drawable, gc, offset_x + 3 /* X */,
192 offset_y + font->height /* Y = baseline of font */, (xcb_char2b_t*)client->name);
197 * Pushes the client’s x and y coordinates to X11
200 void reposition_client(xcb_connection_t *conn, Client *client) {
203 LOG("frame 0x%08x needs to be pushed to %dx%d\n", client->frame, client->rect.x, client->rect.y);
204 /* Note: We can use a pointer to client->x like an array of uint32_ts
205 because it is followed by client->y by definition */
206 xcb_configure_window(conn, client->frame, XCB_CONFIG_WINDOW_X | XCB_CONFIG_WINDOW_Y, &(client->rect.x));
208 if (!client_is_floating(client))
211 /* If the client is floating, we need to check if we moved it to a different workspace */
212 if (client->workspace->screen == (screen = get_screen_containing(client->rect.x, client->rect.y)))
215 if (screen == NULL) {
216 LOG("Boundary checking disabled, no screen found for (%d, %d)\n", client->rect.x, client->rect.y);
220 LOG("Client is on workspace %p with screen %p\n", client->workspace, client->workspace->screen);
221 LOG("but screen at %d, %d is %p\n", client->rect.x, client->rect.y, screen);
222 floating_assign_to_workspace(client, &workspaces[screen->current_workspace]);
226 * Pushes the client’s width/height to X11 and resizes the child window. This
227 * function also updates the client’s position, so if you work on tiling clients
228 * only, you can use this function instead of separate calls to reposition_client
229 * and resize_client to reduce flickering.
232 void resize_client(xcb_connection_t *conn, Client *client) {
233 i3Font *font = load_font(conn, config.font);
235 LOG("frame 0x%08x needs to be pushed to %dx%d\n", client->frame, client->rect.x, client->rect.y);
236 LOG("resizing client 0x%08x to %d x %d\n", client->frame, client->rect.width, client->rect.height);
237 xcb_configure_window(conn, client->frame,
238 XCB_CONFIG_WINDOW_X |
239 XCB_CONFIG_WINDOW_Y |
240 XCB_CONFIG_WINDOW_WIDTH |
241 XCB_CONFIG_WINDOW_HEIGHT,
244 /* Adjust the position of the child inside its frame.
245 * The coordinates of the child are relative to its frame, we
246 * add a border of 2 pixel to each value */
247 uint32_t mask = XCB_CONFIG_WINDOW_X |
248 XCB_CONFIG_WINDOW_Y |
249 XCB_CONFIG_WINDOW_WIDTH |
250 XCB_CONFIG_WINDOW_HEIGHT;
251 Rect *rect = &(client->child_rect);
252 switch ((client->container != NULL ? client->container->mode : MODE_DEFAULT)) {
257 rect->width = client->rect.width - (2 + 2);
258 rect->height = client->rect.height - 2;
261 if (client->titlebar_position == TITLEBAR_OFF && client->borderless) {
264 rect->width = client->rect.width;
265 rect->height = client->rect.height;
266 } else if (client->titlebar_position == TITLEBAR_OFF && !client->borderless) {
269 rect->width = client->rect.width - 1 - 1;
270 rect->height = client->rect.height - 1 - 1;
273 rect->y = font->height + 2 + 2;
274 rect->width = client->rect.width - (2 + 2);
275 rect->height = client->rect.height - ((font->height + 2 + 2) + 2);
280 /* Obey the ratio, if any */
281 if (client->proportional_height != 0 &&
282 client->proportional_width != 0) {
283 LOG("proportional height = %d, width = %d\n", client->proportional_height, client->proportional_width);
284 double new_height = rect->height + 1;
285 int new_width = rect->width;
287 while (new_height > rect->height) {
288 new_height = ((double)client->proportional_height / client->proportional_width) * new_width;
290 if (new_height > rect->height)
293 /* Center the window */
294 rect->y += ceil(rect->height / 2) - floor(new_height / 2);
295 rect->x += ceil(rect->width / 2) - floor(new_width / 2);
297 rect->height = new_height;
298 rect->width = new_width;
299 LOG("new_height = %f, new_width = %d\n", new_height, new_width);
302 if (client->height_increment > 1) {
303 int old_height = rect->height;
304 rect->height -= (rect->height - client->base_height) % client->height_increment;
305 LOG("Lost %d pixel due to client's height_increment (%d px)\n",
306 old_height - rect->height, client->height_increment);
309 if (client->width_increment > 1) {
310 int old_width = rect->width;
311 rect->width -= (rect->width - client->base_width) % client->width_increment;
312 LOG("Lost %d pixel due to client's width_increment (%d px)\n",
313 old_width - rect->width, client->width_increment);
316 LOG("child will be at %dx%d with size %dx%d\n", rect->x, rect->y, rect->width, rect->height);
318 xcb_configure_window(conn, client->child, mask, &(rect->x));
320 /* After configuring a child window we need to fake a configure_notify_event (see ICCCM 4.2.3).
321 * This is necessary to inform the client of its position relative to the root window,
322 * not relative to its frame (as done in the configure_notify_event by the x server). */
323 fake_absolute_configure_notify(conn, client);
325 /* Force redrawing after resizing the window because any now lost
326 * pixels could contain old garbage. */
327 xcb_expose_event_t generated;
328 generated.window = client->frame;
330 handle_expose_event(NULL, conn, &generated);
334 * Renders the given container. Is called by render_layout() or individually (for example
335 * when focus changes in a stacking container)
338 void render_container(xcb_connection_t *conn, Container *container) {
340 int num_clients = 0, current_client = 0;
342 CIRCLEQ_FOREACH(client, &(container->clients), clients)
345 if (container->mode == MODE_DEFAULT) {
346 CIRCLEQ_FOREACH(client, &(container->clients), clients) {
347 /* If the client is in fullscreen mode, it does not get reconfigured */
348 if (container->workspace->fullscreen_client == client) {
353 /* Check if we changed client->x or client->y by updating it.
354 * Note the bitwise OR instead of logical OR to force evaluation of both statements */
355 if (client->force_reconfigure |
356 update_if_necessary(&(client->rect.x), container->x) |
357 update_if_necessary(&(client->rect.y), container->y +
358 (container->height / num_clients) * current_client) |
359 update_if_necessary(&(client->rect.width), container->width) |
360 update_if_necessary(&(client->rect.height), container->height / num_clients))
361 resize_client(conn, client);
363 /* TODO: vertical default layout */
365 client->force_reconfigure = false;
370 i3Font *font = load_font(conn, config.font);
371 int decoration_height = (font->height + 2 + 2);
372 struct Stack_Window *stack_win = &(container->stack_win);
373 /* The size for each tab (width), necessary as a separate variable
374 * because num_clients gets fixed to 1 in tabbed mode. */
375 int size_each = (num_clients == 0 ? container->width : container->width / num_clients);
377 /* Check if we need to remap our stack title window, it gets unmapped when the container
378 is empty in src/handlers.c:unmap_notify() */
379 if (stack_win->rect.height == 0 && num_clients > 0) {
380 LOG("remapping stack win\n");
381 xcb_map_window(conn, stack_win->window);
382 } else LOG("not remapping stackwin, height = %d, num_clients = %d\n",
383 stack_win->rect.height, num_clients);
385 if (container->mode == MODE_TABBED) {
386 /* By setting num_clients to 1 we force that the stack window will be only one line
387 * high. The rest of the code is useful in both cases. */
388 LOG("tabbed mode, setting num_clients = 1\n");
393 /* Check if we need to reconfigure our stack title window */
394 if (update_if_necessary(&(stack_win->rect.x), container->x) |
395 update_if_necessary(&(stack_win->rect.y), container->y) |
396 update_if_necessary(&(stack_win->rect.width), container->width) |
397 update_if_necessary(&(stack_win->rect.height), decoration_height * num_clients)) {
399 /* Configuration can happen in two slightly different ways:
401 If there is no client in fullscreen mode, 5 parameters are passed
402 (x, y, width, height, stack mode is set to above which means top-most position).
404 If there is a fullscreen client, the fourth parameter is set to to the
405 fullscreen window as sibling and the stack mode is set to below, which means
406 that the stack_window will be placed just below the sibling, that is, under
407 the fullscreen window.
409 uint32_t values[] = { stack_win->rect.x, stack_win->rect.y,
410 stack_win->rect.width, stack_win->rect.height,
411 XCB_STACK_MODE_ABOVE, XCB_STACK_MODE_BELOW };
412 uint32_t mask = XCB_CONFIG_WINDOW_X | XCB_CONFIG_WINDOW_Y |
413 XCB_CONFIG_WINDOW_WIDTH | XCB_CONFIG_WINDOW_HEIGHT |
414 XCB_CONFIG_WINDOW_STACK_MODE;
416 /* Raise the stack window, but keep it below the first floating client
417 * and below the fullscreen client (if any) */
418 Client *first_floating = TAILQ_FIRST(&(container->workspace->floating_clients));
419 if (first_floating != TAILQ_END(&(container->workspace->floating_clients))) {
420 mask |= XCB_CONFIG_WINDOW_SIBLING;
421 values[4] = first_floating->frame;
422 } else if (container->workspace->fullscreen_client != NULL) {
423 mask |= XCB_CONFIG_WINDOW_SIBLING;
424 values[4] = container->workspace->fullscreen_client->frame;
427 xcb_configure_window(conn, stack_win->window, mask, values);
430 /* Prepare the pixmap for usage */
431 cached_pixmap_prepare(conn, &(stack_win->pixmap));
433 /* Render the decorations of all clients */
434 CIRCLEQ_FOREACH(client, &(container->clients), clients) {
435 /* If the client is in fullscreen mode, it does not get reconfigured */
436 if (container->workspace->fullscreen_client == client) {
441 /* Check if we changed client->x or client->y by updating it.
442 * Note the bitwise OR instead of logical OR to force evaluation of all statements */
443 if (client->force_reconfigure |
444 update_if_necessary(&(client->rect.x), container->x) |
445 update_if_necessary(&(client->rect.y), container->y + (decoration_height * num_clients)) |
446 update_if_necessary(&(client->rect.width), container->width) |
447 update_if_necessary(&(client->rect.height), container->height - (decoration_height * num_clients)))
448 resize_client(conn, client);
450 client->force_reconfigure = false;
454 if (container->mode == MODE_STACK)
455 offset_y = current_client++ * decoration_height;
456 else if (container->mode == MODE_TABBED)
457 offset_x = current_client++ * size_each;
458 decorate_window(conn, client, stack_win->pixmap.id, stack_win->pixmap.gc,
462 xcb_copy_area(conn, stack_win->pixmap.id, stack_win->window, stack_win->pixmap.gc,
463 0, 0, 0, 0, stack_win->rect.width, stack_win->rect.height);
467 static void render_bars(xcb_connection_t *conn, Workspace *r_ws, int width, int *height) {
469 SLIST_FOREACH(client, &(r_ws->screen->dock_clients), dock_clients) {
470 LOG("client is at %d, should be at %d\n", client->rect.y, *height);
471 if (client->force_reconfigure |
472 update_if_necessary(&(client->rect.x), r_ws->rect.x) |
473 update_if_necessary(&(client->rect.y), *height))
474 reposition_client(conn, client);
476 if (client->force_reconfigure |
477 update_if_necessary(&(client->rect.width), width) |
478 update_if_necessary(&(client->rect.height), client->desired_height))
479 resize_client(conn, client);
481 client->force_reconfigure = false;
482 LOG("desired_height = %d\n", client->desired_height);
483 *height += client->desired_height;
487 static void render_internal_bar(xcb_connection_t *conn, Workspace *r_ws, int width, int height) {
488 i3Font *font = load_font(conn, config.font);
489 i3Screen *screen = r_ws->screen;
490 enum { SET_NORMAL = 0, SET_FOCUSED = 1 };
492 /* Fill the whole bar in black */
493 xcb_change_gc_single(conn, screen->bargc, XCB_GC_FOREGROUND, get_colorpixel(conn, "#000000"));
494 xcb_rectangle_t rect = {0, 0, width, height};
495 xcb_poly_fill_rectangle(conn, screen->bar, screen->bargc, 1, &rect);
498 xcb_change_gc_single(conn, screen->bargc, XCB_GC_FONT, font->id);
501 for (int c = 0; c < 10; c++) {
502 if (workspaces[c].screen != screen)
505 struct Colortriple *color = (screen->current_workspace == c ? &(config.bar.focused) :
506 &(config.bar.unfocused));
507 Workspace *ws = &workspaces[c];
509 /* Draw the outer rect */
510 xcb_draw_rect(conn, screen->bar, screen->bargc, color->border,
513 ws->text_width + 5 + 5, /* width = text width + 5 px left + 5px right */
514 height - 2 /* height = max. height - 1 px upper and 1 px bottom border */);
516 /* Draw the background of this rect */
517 xcb_draw_rect(conn, screen->bar, screen->bargc, color->background,
520 ws->text_width + 4 + 4,
523 xcb_change_gc_single(conn, screen->bargc, XCB_GC_FOREGROUND, color->text);
524 xcb_change_gc_single(conn, screen->bargc, XCB_GC_BACKGROUND, color->background);
525 xcb_image_text_16(conn, ws->name_len, screen->bar, screen->bargc, drawn + 5 /* X */,
526 font->height + 1 /* Y = baseline of font */,
527 (xcb_char2b_t*)ws->name);
528 drawn += ws->text_width + 12;
533 * Modifies the event mask of all clients on the given workspace to either ignore or to handle
534 * enter notifies. It is handy to ignore notifies because they will be sent when a window is mapped
535 * under the cursor, thus when the user didn’t enter the window actively at all.
538 void ignore_enter_notify_forall(xcb_connection_t *conn, Workspace *workspace, bool ignore_enter_notify) {
543 CIRCLEQ_FOREACH(client, &(workspace->table[cols][rows]->clients), clients) {
544 /* Change event mask for the decorations */
545 values[0] = FRAME_EVENT_MASK;
546 if (ignore_enter_notify)
547 values[0] &= ~(XCB_EVENT_MASK_ENTER_WINDOW);
548 xcb_change_window_attributes(conn, client->frame, XCB_CW_EVENT_MASK, values);
550 /* Change event mask for the child itself */
551 values[0] = CHILD_EVENT_MASK;
552 if (ignore_enter_notify)
553 values[0] &= ~(XCB_EVENT_MASK_ENTER_WINDOW);
554 xcb_change_window_attributes(conn, client->child, XCB_CW_EVENT_MASK, values);
559 * Renders the given workspace on the given screen
562 void render_workspace(xcb_connection_t *conn, i3Screen *screen, Workspace *r_ws) {
563 i3Font *font = load_font(conn, config.font);
564 int width = r_ws->rect.width;
565 int height = r_ws->rect.height;
567 /* Reserve space for dock clients */
569 SLIST_FOREACH(client, &(screen->dock_clients), dock_clients)
570 height -= client->desired_height;
572 /* Space for the internal bar */
573 height -= (font->height + 6);
575 int xoffset[r_ws->rows];
576 int yoffset[r_ws->cols];
577 /* Initialize offsets */
578 for (int cols = 0; cols < r_ws->cols; cols++)
579 yoffset[cols] = r_ws->rect.y;
580 for (int rows = 0; rows < r_ws->rows; rows++)
581 xoffset[rows] = r_ws->rect.x;
583 ignore_enter_notify_forall(conn, r_ws, true);
585 /* Go through the whole table and render what’s necessary */
587 Container *container = r_ws->table[cols][rows];
588 int single_width = -1, single_height;
589 /* Update position of the container */
590 container->row = rows;
591 container->col = cols;
592 container->x = xoffset[rows];
593 container->y = yoffset[cols];
594 container->width = 0;
596 for (int c = 0; c < container->colspan; c++) {
597 if (r_ws->width_factor[cols+c] == 0)
598 container->width += (width / r_ws->cols);
599 else container->width += get_unoccupied_x(r_ws) * r_ws->width_factor[cols+c];
601 if (single_width == -1)
602 single_width = container->width;
605 //if (container->height_factor == 0)
606 container->height = (height / r_ws->rows);
607 //else container->height = get_unoccupied_y(r_ws, cols) * container->height_factor;
608 single_height = container->height;
609 container->height *= container->rowspan;
611 /* Render the container if it is not empty */
612 render_container(conn, container);
614 xoffset[rows] += single_width;
615 yoffset[cols] += single_height;
618 ignore_enter_notify_forall(conn, r_ws, false);
620 render_bars(conn, r_ws, width, &height);
621 render_internal_bar(conn, r_ws, width, font->height + 6);
625 * Renders the whole layout, that is: Go through each screen, each workspace, each container
626 * and render each client. This also renders the bars.
628 * If you don’t need to render *everything*, you should call render_container on the container
629 * you want to refresh.
632 void render_layout(xcb_connection_t *conn) {
635 TAILQ_FOREACH(screen, virtual_screens, screens)
636 render_workspace(conn, screen, &(workspaces[screen->current_workspace]));