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
31 * Updates *destination with new_value and returns true if it was changed or false
35 static bool update_if_necessary(uint32_t *destination, const uint32_t new_value) {
36 uint32_t old_value = *destination;
38 return ((*destination = new_value) != old_value);
42 * Gets the unoccupied space (= space which is available for windows which were resized by the user)
43 * for the given row. This is necessary to render both, customly resized windows and never touched
44 * windows correctly, meaning that the aspect ratio will be maintained when opening new windows.
47 int get_unoccupied_x(Workspace *workspace) {
48 int unoccupied = workspace->rect.width;
49 float default_factor = ((float)workspace->rect.width / workspace->cols) / workspace->rect.width;
51 LOG("get_unoccupied_x(), starting with %d, default_factor = %f\n", unoccupied, default_factor);
53 for (int cols = 0; cols < workspace->cols; cols++) {
54 LOG("width_factor[%d] = %f\n", cols, workspace->width_factor[cols]);
56 if (workspace->width_factor[cols] == 0)
57 unoccupied -= workspace->rect.width * default_factor;
60 LOG("unoccupied space: %d\n", unoccupied);
64 /* See get_unoccupied_x() */
65 int get_unoccupied_y(Workspace *workspace, int col) {
66 int unoccupied = workspace->rect.height;
67 float default_factor = ((float)workspace->rect.height / workspace->rows) / workspace->rect.height;
69 LOG("get_unoccupied_y(), starting with %d, default_factor = %f\n", unoccupied, default_factor);
71 for (int rows = 0; rows < workspace->rows; rows++) {
72 LOG("height_factor[%d] = %f\n", rows, workspace->height_factor[rows]);
73 if (workspace->height_factor[rows] == 0)
74 unoccupied -= workspace->rect.height * default_factor;
77 LOG("unoccupied space: %d\n", unoccupied);
82 * Redecorates the given client correctly by checking if it’s in a stacking container and
83 * re-rendering the stack window or just calling decorate_window if it’s not in a stacking
87 void redecorate_window(xcb_connection_t *conn, Client *client) {
88 if (client->container != NULL &&
89 (client->container->mode == MODE_STACK ||
90 client->container->mode == MODE_TABBED)) {
91 render_container(conn, client->container);
92 /* We clear the frame to generate exposure events, because the color used
93 in drawing may be different */
94 xcb_clear_area(conn, true, client->frame, 0, 0, client->rect.width, client->rect.height);
95 } else decorate_window(conn, client, client->frame, client->titlegc, 0, 0);
100 * (Re-)draws window decorations for a given Client onto the given drawable/graphic context.
101 * When in stacking mode, the window decorations are drawn onto an own window.
104 void decorate_window(xcb_connection_t *conn, Client *client, xcb_drawable_t drawable,
105 xcb_gcontext_t gc, int offset_x, int offset_y) {
106 i3Font *font = load_font(conn, config.font);
107 int decoration_height = font->height + 2 + 2;
108 struct Colortriple *color;
109 Client *last_focused;
111 /* Clients without a container (docks) won’t get decorated */
115 last_focused = SLIST_FIRST(&(client->workspace->focus_stack));
116 if (client_is_floating(client)) {
117 if (last_focused == client)
118 color = &(config.client.focused);
119 else color = &(config.client.unfocused);
121 if (client->container->currently_focused == client) {
122 /* Distinguish if the window is currently focused… */
123 if (last_focused == client && c_ws == client->workspace)
124 color = &(config.client.focused);
125 /* …or if it is the focused window in a not focused container */
126 else color = &(config.client.focused_inactive);
127 } else color = &(config.client.unfocused);
130 /* Our plan is the following:
131 - Draw a rect around the whole client in color->background
132 - Draw two lines in a lighter color
133 - Draw the window’s title
136 /* Draw a rectangle in background color around the window */
137 xcb_change_gc_single(conn, gc, XCB_GC_FOREGROUND, color->background);
139 /* In stacking mode, we only render the rect for this specific decoration */
140 if (client->container != NULL && (client->container->mode == MODE_STACK || client->container->mode == MODE_TABBED)) {
141 /* We need to use the container’s width because it is the more recent value - when
142 in stacking mode, clients get reconfigured only on demand (the not active client
143 is not reconfigured), so the client’s rect.width would be wrong */
144 xcb_rectangle_t rect = {offset_x, offset_y,
145 offset_x + client->container->width,
146 offset_y + decoration_height };
147 xcb_poly_fill_rectangle(conn, drawable, gc, 1, &rect);
149 xcb_rectangle_t rect = {0, 0, client->rect.width, client->rect.height};
150 xcb_poly_fill_rectangle(conn, drawable, gc, 1, &rect);
152 /* Draw the inner background to have a black frame around clients (such as mplayer)
153 which cannot be resized exactly in our frames and therefore are centered */
154 xcb_change_gc_single(conn, client->titlegc, XCB_GC_FOREGROUND, get_colorpixel(conn, "#000000"));
155 xcb_rectangle_t crect = {2, decoration_height,
156 client->rect.width - (2 + 2), client->rect.height - 2 - decoration_height};
157 xcb_poly_fill_rectangle(conn, client->frame, client->titlegc, 1, &crect);
160 if (client->titlebar_position != TITLEBAR_OFF) {
162 xcb_draw_line(conn, drawable, gc, color->border, offset_x, offset_y, offset_x + client->rect.width, offset_y);
163 if ((client->container == NULL ||
164 (client->container->mode != MODE_STACK &&
165 client->container->mode != MODE_TABBED) ||
166 CIRCLEQ_NEXT_OR_NULL(&(client->container->clients), client, clients) == NULL))
167 xcb_draw_line(conn, drawable, gc, color->border,
168 offset_x + 2, /* x */
169 offset_y + font->height + 3, /* y */
170 offset_x + client->rect.width - 3, /* to_x */
171 offset_y + font->height + 3 /* to_y */);
174 /* If the client has a title, we draw it */
175 if (client->name != NULL) {
177 uint32_t mask = XCB_GC_FOREGROUND | XCB_GC_BACKGROUND | XCB_GC_FONT;
178 uint32_t values[] = { color->text, color->background, font->id };
179 xcb_change_gc(conn, gc, mask, values);
181 /* name_len == -1 means this is a legacy application which does not specify _NET_WM_NAME,
182 and we don’t handle the old window name (COMPOUND_TEXT) but only _NET_WM_NAME, which
184 if (client->name_len == -1)
185 xcb_image_text_8(conn, strlen(client->name), drawable, gc, offset_x + 3 /* X */,
186 offset_y + font->height /* Y = baseline of font */, client->name);
188 xcb_image_text_16(conn, client->name_len, drawable, gc, offset_x + 3 /* X */,
189 offset_y + font->height /* Y = baseline of font */, (xcb_char2b_t*)client->name);
194 * Pushes the client’s x and y coordinates to X11
197 void reposition_client(xcb_connection_t *conn, Client *client) {
200 LOG("frame 0x%08x needs to be pushed to %dx%d\n", client->frame, client->rect.x, client->rect.y);
201 /* Note: We can use a pointer to client->x like an array of uint32_ts
202 because it is followed by client->y by definition */
203 xcb_configure_window(conn, client->frame, XCB_CONFIG_WINDOW_X | XCB_CONFIG_WINDOW_Y, &(client->rect.x));
205 if (!client_is_floating(client))
208 /* If the client is floating, we need to check if we moved it to a different workspace */
209 if (client->workspace->screen == (screen = get_screen_containing(client->rect.x, client->rect.y)))
212 if (screen == NULL) {
213 LOG("Boundary checking disabled, no screen found for (%d, %d)\n", client->rect.x, client->rect.y);
217 LOG("Client is on workspace %p with screen %p\n", client->workspace, client->workspace->screen);
218 LOG("but screen at %d, %d is %p\n", client->rect.x, client->rect.y, screen);
219 floating_assign_to_workspace(client, &workspaces[screen->current_workspace]);
223 * Pushes the client’s width/height to X11 and resizes the child window. This
224 * function also updates the client’s position, so if you work on tiling clients
225 * only, you can use this function instead of separate calls to reposition_client
226 * and resize_client to reduce flickering.
229 void resize_client(xcb_connection_t *conn, Client *client) {
230 i3Font *font = load_font(conn, config.font);
232 LOG("frame 0x%08x needs to be pushed to %dx%d\n", client->frame, client->rect.x, client->rect.y);
233 LOG("resizing client 0x%08x to %d x %d\n", client->frame, client->rect.width, client->rect.height);
234 xcb_configure_window(conn, client->frame,
235 XCB_CONFIG_WINDOW_X |
236 XCB_CONFIG_WINDOW_Y |
237 XCB_CONFIG_WINDOW_WIDTH |
238 XCB_CONFIG_WINDOW_HEIGHT,
241 /* Adjust the position of the child inside its frame.
242 * The coordinates of the child are relative to its frame, we
243 * add a border of 2 pixel to each value */
244 uint32_t mask = XCB_CONFIG_WINDOW_X |
245 XCB_CONFIG_WINDOW_Y |
246 XCB_CONFIG_WINDOW_WIDTH |
247 XCB_CONFIG_WINDOW_HEIGHT;
248 Rect *rect = &(client->child_rect);
249 switch ((client->container != NULL ? client->container->mode : MODE_DEFAULT)) {
254 rect->width = client->rect.width - (2 + 2);
255 rect->height = client->rect.height - 2;
258 if (client->titlebar_position == TITLEBAR_OFF && client->borderless) {
261 rect->width = client->rect.width;
262 rect->height = client->rect.height;
263 } else if (client->titlebar_position == TITLEBAR_OFF && !client->borderless) {
266 rect->width = client->rect.width - 1 - 1;
267 rect->height = client->rect.height - 1 - 1;
270 rect->y = font->height + 2 + 2;
271 rect->width = client->rect.width - (2 + 2);
272 rect->height = client->rect.height - ((font->height + 2 + 2) + 2);
277 /* Obey the ratio, if any */
278 if (client->proportional_height != 0 &&
279 client->proportional_width != 0) {
280 LOG("proportional height = %d, width = %d\n", client->proportional_height, client->proportional_width);
281 double new_height = rect->height + 1;
282 int new_width = rect->width;
284 while (new_height > rect->height) {
285 new_height = ((double)client->proportional_height / client->proportional_width) * new_width;
287 if (new_height > rect->height)
290 /* Center the window */
291 rect->y += ceil(rect->height / 2) - floor(new_height / 2);
292 rect->x += ceil(rect->width / 2) - floor(new_width / 2);
294 rect->height = new_height;
295 rect->width = new_width;
296 LOG("new_height = %f, new_width = %d\n", new_height, new_width);
299 if (client->height_increment > 1) {
300 int old_height = rect->height;
301 rect->height = ((int)(rect->height / client->height_increment) * client->height_increment) + 1;
302 LOG("Lost %d pixel due to client's height_increment (%d px)\n",
303 old_height - rect->height, client->height_increment);
306 if (client->width_increment > 1) {
307 int old_width = rect->width;
308 rect->width = ((int)(rect->width / client->width_increment) * client->width_increment) + 1;
309 LOG("Lost %d pixel due to client's width_increment (%d px)\n",
310 old_width - rect->width, client->width_increment);
313 LOG("child will be at %dx%d with size %dx%d\n", rect->x, rect->y, rect->width, rect->height);
315 xcb_configure_window(conn, client->child, mask, &(rect->x));
317 /* After configuring a child window we need to fake a configure_notify_event (see ICCCM 4.2.3).
318 * This is necessary to inform the client of its position relative to the root window,
319 * not relative to its frame (as done in the configure_notify_event by the x server). */
320 fake_absolute_configure_notify(conn, client);
324 * Renders the given container. Is called by render_layout() or individually (for example
325 * when focus changes in a stacking container)
328 void render_container(xcb_connection_t *conn, Container *container) {
330 int num_clients = 0, current_client = 0;
332 CIRCLEQ_FOREACH(client, &(container->clients), clients)
335 if (container->mode == MODE_DEFAULT) {
336 CIRCLEQ_FOREACH(client, &(container->clients), clients) {
337 /* If the client is in fullscreen mode, it does not get reconfigured */
338 if (container->workspace->fullscreen_client == client) {
343 /* Check if we changed client->x or client->y by updating it.
344 * Note the bitwise OR instead of logical OR to force evaluation of both statements */
345 if (client->force_reconfigure |
346 update_if_necessary(&(client->rect.x), container->x) |
347 update_if_necessary(&(client->rect.y), container->y +
348 (container->height / num_clients) * current_client) |
349 update_if_necessary(&(client->rect.width), container->width) |
350 update_if_necessary(&(client->rect.height), container->height / num_clients))
351 resize_client(conn, client);
353 /* TODO: vertical default layout */
355 client->force_reconfigure = false;
360 i3Font *font = load_font(conn, config.font);
361 int decoration_height = (font->height + 2 + 2);
362 struct Stack_Window *stack_win = &(container->stack_win);
363 /* The size for each tab (width), necessary as a separate variable
364 * because num_clients gets fixed to 1 in tabbed mode. */
365 int size_each = (num_clients == 0 ? container->width : container->width / num_clients);
367 /* Check if we need to remap our stack title window, it gets unmapped when the container
368 is empty in src/handlers.c:unmap_notify() */
369 if (stack_win->rect.height == 0 && num_clients > 0) {
370 LOG("remapping stack win\n");
371 xcb_map_window(conn, stack_win->window);
372 } else LOG("not remapping stackwin, height = %d, num_clients = %d\n",
373 stack_win->rect.height, num_clients);
375 if (container->mode == MODE_TABBED) {
376 /* By setting num_clients to 1 we force that the stack window will be only one line
377 * high. The rest of the code is useful in both cases. */
378 LOG("tabbed mode, setting num_clients = 1\n");
383 /* Check if we need to reconfigure our stack title window */
384 if (update_if_necessary(&(stack_win->rect.x), container->x) |
385 update_if_necessary(&(stack_win->rect.y), container->y) |
386 update_if_necessary(&(stack_win->rect.width), container->width) |
387 update_if_necessary(&(stack_win->rect.height), decoration_height * num_clients)) {
389 /* Configuration can happen in two slightly different ways:
391 If there is no client in fullscreen mode, 5 parameters are passed
392 (x, y, width, height, stack mode is set to above which means top-most position).
394 If there is a fullscreen client, the fourth parameter is set to to the
395 fullscreen window as sibling and the stack mode is set to below, which means
396 that the stack_window will be placed just below the sibling, that is, under
397 the fullscreen window.
399 uint32_t values[] = { stack_win->rect.x, stack_win->rect.y,
400 stack_win->rect.width, stack_win->rect.height,
401 XCB_STACK_MODE_ABOVE, XCB_STACK_MODE_BELOW };
402 uint32_t mask = XCB_CONFIG_WINDOW_X | XCB_CONFIG_WINDOW_Y |
403 XCB_CONFIG_WINDOW_WIDTH | XCB_CONFIG_WINDOW_HEIGHT |
404 XCB_CONFIG_WINDOW_STACK_MODE;
406 /* Raise the stack window, but keep it below the first floating client
407 * and below the fullscreen client (if any) */
408 Client *first_floating = TAILQ_FIRST(&(container->workspace->floating_clients));
409 if (first_floating != TAILQ_END(&(container->workspace->floating_clients))) {
410 mask |= XCB_CONFIG_WINDOW_SIBLING;
411 values[4] = first_floating->frame;
412 } else if (container->workspace->fullscreen_client != NULL) {
413 mask |= XCB_CONFIG_WINDOW_SIBLING;
414 values[4] = container->workspace->fullscreen_client->frame;
417 xcb_configure_window(conn, stack_win->window, mask, values);
420 /* Prepare the pixmap for usage */
421 cached_pixmap_prepare(conn, &(stack_win->pixmap));
423 /* Render the decorations of all clients */
424 CIRCLEQ_FOREACH(client, &(container->clients), clients) {
425 /* If the client is in fullscreen mode, it does not get reconfigured */
426 if (container->workspace->fullscreen_client == client) {
431 /* Check if we changed client->x or client->y by updating it.
432 * Note the bitwise OR instead of logical OR to force evaluation of all statements */
433 if (client->force_reconfigure |
434 update_if_necessary(&(client->rect.x), container->x) |
435 update_if_necessary(&(client->rect.y), container->y + (decoration_height * num_clients)) |
436 update_if_necessary(&(client->rect.width), container->width) |
437 update_if_necessary(&(client->rect.height), container->height - (decoration_height * num_clients)))
438 resize_client(conn, client);
440 client->force_reconfigure = false;
444 if (container->mode == MODE_STACK)
445 offset_y = current_client++ * decoration_height;
446 else if (container->mode == MODE_TABBED)
447 offset_x = current_client++ * size_each;
448 decorate_window(conn, client, stack_win->pixmap.id, stack_win->pixmap.gc,
452 xcb_copy_area(conn, stack_win->pixmap.id, stack_win->window, stack_win->pixmap.gc,
453 0, 0, 0, 0, stack_win->rect.width, stack_win->rect.height);
457 static void render_bars(xcb_connection_t *conn, Workspace *r_ws, int width, int *height) {
459 SLIST_FOREACH(client, &(r_ws->screen->dock_clients), dock_clients) {
460 LOG("client is at %d, should be at %d\n", client->rect.y, *height);
461 if (client->force_reconfigure |
462 update_if_necessary(&(client->rect.x), r_ws->rect.x) |
463 update_if_necessary(&(client->rect.y), *height))
464 reposition_client(conn, client);
466 if (client->force_reconfigure |
467 update_if_necessary(&(client->rect.width), width) |
468 update_if_necessary(&(client->rect.height), client->desired_height))
469 resize_client(conn, client);
471 client->force_reconfigure = false;
472 LOG("desired_height = %d\n", client->desired_height);
473 *height += client->desired_height;
477 static void render_internal_bar(xcb_connection_t *conn, Workspace *r_ws, int width, int height) {
478 i3Font *font = load_font(conn, config.font);
479 i3Screen *screen = r_ws->screen;
480 enum { SET_NORMAL = 0, SET_FOCUSED = 1 };
482 /* Fill the whole bar in black */
483 xcb_change_gc_single(conn, screen->bargc, XCB_GC_FOREGROUND, get_colorpixel(conn, "#000000"));
484 xcb_rectangle_t rect = {0, 0, width, height};
485 xcb_poly_fill_rectangle(conn, screen->bar, screen->bargc, 1, &rect);
488 xcb_change_gc_single(conn, screen->bargc, XCB_GC_FONT, font->id);
491 for (int c = 0; c < 10; c++) {
492 if (workspaces[c].screen != screen)
495 struct Colortriple *color = (screen->current_workspace == c ? &(config.bar.focused) :
496 &(config.bar.unfocused));
497 Workspace *ws = &workspaces[c];
499 /* Draw the outer rect */
500 xcb_draw_rect(conn, screen->bar, screen->bargc, color->border,
503 ws->text_width + 5 + 5, /* width = text width + 5 px left + 5px right */
504 height - 2 /* height = max. height - 1 px upper and 1 px bottom border */);
506 /* Draw the background of this rect */
507 xcb_draw_rect(conn, screen->bar, screen->bargc, color->background,
510 ws->text_width + 4 + 4,
513 xcb_change_gc_single(conn, screen->bargc, XCB_GC_FOREGROUND, color->text);
514 xcb_change_gc_single(conn, screen->bargc, XCB_GC_BACKGROUND, color->background);
515 xcb_image_text_16(conn, ws->name_len, screen->bar, screen->bargc, drawn + 5 /* X */,
516 font->height + 1 /* Y = baseline of font */,
517 (xcb_char2b_t*)ws->name);
518 drawn += ws->text_width + 12;
523 * Modifies the event mask of all clients on the given workspace to either ignore or to handle
524 * enter notifies. It is handy to ignore notifies because they will be sent when a window is mapped
525 * under the cursor, thus when the user didn’t enter the window actively at all.
528 void ignore_enter_notify_forall(xcb_connection_t *conn, Workspace *workspace, bool ignore_enter_notify) {
533 CIRCLEQ_FOREACH(client, &(workspace->table[cols][rows]->clients), clients) {
534 /* Change event mask for the decorations */
535 values[0] = FRAME_EVENT_MASK;
536 if (ignore_enter_notify)
537 values[0] &= ~(XCB_EVENT_MASK_ENTER_WINDOW);
538 xcb_change_window_attributes(conn, client->frame, XCB_CW_EVENT_MASK, values);
540 /* Change event mask for the child itself */
541 values[0] = CHILD_EVENT_MASK;
542 if (ignore_enter_notify)
543 values[0] &= ~(XCB_EVENT_MASK_ENTER_WINDOW);
544 xcb_change_window_attributes(conn, client->child, XCB_CW_EVENT_MASK, values);
549 * Renders the given workspace on the given screen
552 void render_workspace(xcb_connection_t *conn, i3Screen *screen, Workspace *r_ws) {
553 i3Font *font = load_font(conn, config.font);
554 int width = r_ws->rect.width;
555 int height = r_ws->rect.height;
557 /* Reserve space for dock clients */
559 SLIST_FOREACH(client, &(screen->dock_clients), dock_clients)
560 height -= client->desired_height;
562 /* Space for the internal bar */
563 height -= (font->height + 6);
565 int xoffset[r_ws->rows];
566 int yoffset[r_ws->cols];
567 /* Initialize offsets */
568 for (int cols = 0; cols < r_ws->cols; cols++)
569 yoffset[cols] = r_ws->rect.y;
570 for (int rows = 0; rows < r_ws->rows; rows++)
571 xoffset[rows] = r_ws->rect.x;
573 ignore_enter_notify_forall(conn, r_ws, true);
575 /* Go through the whole table and render what’s necessary */
577 Container *container = r_ws->table[cols][rows];
578 int single_width = -1, single_height;
579 /* Update position of the container */
580 container->row = rows;
581 container->col = cols;
582 container->x = xoffset[rows];
583 container->y = yoffset[cols];
584 container->width = 0;
586 for (int c = 0; c < container->colspan; c++) {
587 if (r_ws->width_factor[cols+c] == 0)
588 container->width += (width / r_ws->cols);
589 else container->width += get_unoccupied_x(r_ws) * r_ws->width_factor[cols+c];
591 if (single_width == -1)
592 single_width = container->width;
595 //if (container->height_factor == 0)
596 container->height = (height / r_ws->rows);
597 //else container->height = get_unoccupied_y(r_ws, cols) * container->height_factor;
598 single_height = container->height;
599 container->height *= container->rowspan;
601 /* Render the container if it is not empty */
602 render_container(conn, container);
604 xoffset[rows] += single_width;
605 yoffset[cols] += single_height;
608 ignore_enter_notify_forall(conn, r_ws, false);
610 render_bars(conn, r_ws, width, &height);
611 render_internal_bar(conn, r_ws, width, font->height + 6);
615 * Renders the whole layout, that is: Go through each screen, each workspace, each container
616 * and render each client. This also renders the bars.
618 * If you don’t need to render *everything*, you should call render_container on the container
619 * you want to refresh.
622 void render_layout(xcb_connection_t *conn) {
625 TAILQ_FOREACH(screen, virtual_screens, screens)
626 render_workspace(conn, screen, &(workspaces[screen->current_workspace]));