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 && client->container->mode == MODE_STACK) {
90 render_container(conn, client->container);
91 /* We clear the frame to generate exposure events, because the color used
92 in drawing may be different */
93 xcb_clear_area(conn, true, client->frame, 0, 0, client->rect.width, client->rect.height);
94 } else decorate_window(conn, client, client->frame, client->titlegc, 0);
99 * (Re-)draws window decorations for a given Client onto the given drawable/graphic context.
100 * When in stacking mode, the window decorations are drawn onto an own window.
103 void decorate_window(xcb_connection_t *conn, Client *client, xcb_drawable_t drawable, xcb_gcontext_t gc, int offset) {
104 i3Font *font = load_font(conn, config.font);
105 int decoration_height = font->height + 2 + 2;
106 struct Colortriple *color;
107 Client *last_focused;
109 /* Clients without a container (docks) won’t get decorated */
113 last_focused = SLIST_FIRST(&(client->workspace->focus_stack));
114 if (client_is_floating(client)) {
115 if (last_focused == client)
116 color = &(config.client.focused);
117 else color = &(config.client.unfocused);
119 if (client->container->currently_focused == client) {
120 /* Distinguish if the window is currently focused… */
121 if (last_focused == client && c_ws == client->workspace)
122 color = &(config.client.focused);
123 /* …or if it is the focused window in a not focused container */
124 else color = &(config.client.focused_inactive);
125 } else color = &(config.client.unfocused);
128 /* Our plan is the following:
129 - Draw a rect around the whole client in color->background
130 - Draw two lines in a lighter color
131 - Draw the window’s title
134 /* Draw a rectangle in background color around the window */
135 if (client->borderless)
136 xcb_change_gc_single(conn, gc, XCB_GC_FOREGROUND, get_colorpixel(conn, "#000000"));
137 else 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) {
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 = {0, offset, client->container->width, offset + decoration_height };
145 xcb_poly_fill_rectangle(conn, drawable, gc, 1, &rect);
147 xcb_rectangle_t rect = {0, 0, client->rect.width, client->rect.height};
148 xcb_poly_fill_rectangle(conn, drawable, gc, 1, &rect);
150 /* Draw the inner background to have a black frame around clients (such as mplayer)
151 which cannot be resized exactly in our frames and therefore are centered */
152 xcb_change_gc_single(conn, client->titlegc, XCB_GC_FOREGROUND, get_colorpixel(conn, "#000000"));
153 xcb_rectangle_t crect = {2, decoration_height,
154 client->rect.width - (2 + 2), client->rect.height - 2 - decoration_height};
155 xcb_poly_fill_rectangle(conn, client->frame, client->titlegc, 1, &crect);
158 if (client->titlebar_position != TITLEBAR_OFF) {
160 xcb_draw_line(conn, drawable, gc, color->border, 0, offset, client->rect.width, offset);
161 if ((client->container == NULL ||
162 client->container->mode != MODE_STACK ||
163 CIRCLEQ_NEXT_OR_NULL(&(client->container->clients), client, clients) == NULL))
164 xcb_draw_line(conn, drawable, gc, color->border, 2, offset + font->height + 3,
165 client->rect.width - 3, offset + font->height + 3);
168 /* If the client has a title, we draw it */
169 if (client->name != NULL) {
171 uint32_t mask = XCB_GC_FOREGROUND | XCB_GC_BACKGROUND | XCB_GC_FONT;
172 uint32_t values[] = { color->text, color->background, font->id };
173 xcb_change_gc(conn, gc, mask, values);
175 /* name_len == -1 means this is a legacy application which does not specify _NET_WM_NAME,
176 and we don’t handle the old window name (COMPOUND_TEXT) but only _NET_WM_NAME, which
178 if (client->name_len == -1)
179 xcb_image_text_8(conn, strlen(client->name), drawable, gc, 3 /* X */,
180 offset + font->height /* Y = baseline of font */, client->name);
182 xcb_image_text_16(conn, client->name_len, drawable, gc, 3 /* X */,
183 offset + font->height /* Y = baseline of font */, (xcb_char2b_t*)client->name);
188 * Pushes the client’s x and y coordinates to X11
191 void reposition_client(xcb_connection_t *conn, Client *client) {
194 LOG("frame 0x%08x needs to be pushed to %dx%d\n", client->frame, client->rect.x, client->rect.y);
195 /* Note: We can use a pointer to client->x like an array of uint32_ts
196 because it is followed by client->y by definition */
197 xcb_configure_window(conn, client->frame, XCB_CONFIG_WINDOW_X | XCB_CONFIG_WINDOW_Y, &(client->rect.x));
199 if (!client_is_floating(client))
202 /* If the client is floating, we need to check if we moved it to a different workspace */
203 if (client->workspace->screen == (screen = get_screen_containing(client->rect.x, client->rect.y)))
206 if (screen == NULL) {
207 LOG("Boundary checking disabled, no screen found for (%d, %d)\n", client->rect.x, client->rect.y);
211 LOG("Client is on workspace %p with screen %p\n", client->workspace, client->workspace->screen);
212 LOG("but screen at %d, %d is %p\n", client->rect.x, client->rect.y, screen);
213 floating_assign_to_workspace(client, &workspaces[screen->current_workspace]);
217 * Pushes the client’s width/height to X11 and resizes the child window. This
218 * function also updates the client’s position, so if you work on tiling clients
219 * only, you can use this function instead of separate calls to reposition_client
220 * and resize_client to reduce flickering.
223 void resize_client(xcb_connection_t *conn, Client *client) {
224 i3Font *font = load_font(conn, config.font);
226 LOG("frame 0x%08x needs to be pushed to %dx%d\n", client->frame, client->rect.x, client->rect.y);
227 LOG("resizing client 0x%08x to %d x %d\n", client->frame, client->rect.width, client->rect.height);
228 xcb_configure_window(conn, client->frame,
229 XCB_CONFIG_WINDOW_X |
230 XCB_CONFIG_WINDOW_Y |
231 XCB_CONFIG_WINDOW_WIDTH |
232 XCB_CONFIG_WINDOW_HEIGHT,
235 /* Adjust the position of the child inside its frame.
236 * The coordinates of the child are relative to its frame, we
237 * add a border of 2 pixel to each value */
238 uint32_t mask = XCB_CONFIG_WINDOW_X |
239 XCB_CONFIG_WINDOW_Y |
240 XCB_CONFIG_WINDOW_WIDTH |
241 XCB_CONFIG_WINDOW_HEIGHT;
242 Rect *rect = &(client->child_rect);
243 switch ((client->container != NULL ? client->container->mode : MODE_DEFAULT)) {
247 rect->width = client->rect.width - (2 + 2);
248 rect->height = client->rect.height - 2;
251 if (client->titlebar_position == TITLEBAR_OFF && client->borderless) {
254 rect->width = client->rect.width;
255 rect->height = client->rect.height;
256 } else if (client->titlebar_position == TITLEBAR_OFF && !client->borderless) {
259 rect->width = client->rect.width - 1 - 1;
260 rect->height = client->rect.height - 1 - 1;
263 rect->y = font->height + 2 + 2;
264 rect->width = client->rect.width - (2 + 2);
265 rect->height = client->rect.height - ((font->height + 2 + 2) + 2);
270 /* Obey the ratio, if any */
271 if (client->proportional_height != 0 &&
272 client->proportional_width != 0) {
273 LOG("proportional height = %d, width = %d\n", client->proportional_height, client->proportional_width);
274 double new_height = rect->height + 1;
275 int new_width = rect->width;
277 while (new_height > rect->height) {
278 new_height = ((double)client->proportional_height / client->proportional_width) * new_width;
280 if (new_height > rect->height)
283 /* Center the window */
284 rect->y += ceil(rect->height / 2) - floor(new_height / 2);
285 rect->x += ceil(rect->width / 2) - floor(new_width / 2);
287 rect->height = new_height;
288 rect->width = new_width;
289 LOG("new_height = %f, new_width = %d\n", new_height, new_width);
292 if (client->height_increment > 1) {
293 int old_height = rect->height;
294 rect->height -= (rect->height - client->base_height) % client->height_increment;
295 LOG("Lost %d pixel due to client's height_increment (%d px)\n",
296 old_height - rect->height, client->height_increment);
299 if (client->width_increment > 1) {
300 int old_width = rect->width;
301 rect->width -= (rect->width - client->base_width) % client->width_increment;
302 LOG("Lost %d pixel due to client's width_increment (%d px)\n",
303 old_width - rect->width, client->width_increment);
306 LOG("child will be at %dx%d with size %dx%d\n", rect->x, rect->y, rect->width, rect->height);
308 xcb_configure_window(conn, client->child, mask, &(rect->x));
310 /* After configuring a child window we need to fake a configure_notify_event (see ICCCM 4.2.3).
311 * This is necessary to inform the client of its position relative to the root window,
312 * not relative to its frame (as done in the configure_notify_event by the x server). */
313 fake_absolute_configure_notify(conn, client);
315 /* Force redrawing after resizing the window because any now lost
316 * pixels could contain old garbage. */
317 xcb_expose_event_t generated;
318 generated.window = client->frame;
320 handle_expose_event(NULL, conn, &generated);
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);
364 /* Check if we need to remap our stack title window, it gets unmapped when the container
365 is empty in src/handlers.c:unmap_notify() */
366 if (stack_win->rect.height == 0 && num_clients > 0)
367 xcb_map_window(conn, stack_win->window);
369 /* Check if we need to reconfigure our stack title window */
370 if (update_if_necessary(&(stack_win->rect.x), container->x) |
371 update_if_necessary(&(stack_win->rect.y), container->y) |
372 update_if_necessary(&(stack_win->rect.width), container->width) |
373 update_if_necessary(&(stack_win->rect.height), decoration_height * num_clients)) {
375 /* Configuration can happen in two slightly different ways:
377 If there is no client in fullscreen mode, 5 parameters are passed
378 (x, y, width, height, stack mode is set to above which means top-most position).
380 If there is a fullscreen client, the fourth parameter is set to to the
381 fullscreen window as sibling and the stack mode is set to below, which means
382 that the stack_window will be placed just below the sibling, that is, under
383 the fullscreen window.
385 uint32_t values[] = { stack_win->rect.x, stack_win->rect.y,
386 stack_win->rect.width, stack_win->rect.height,
387 XCB_STACK_MODE_ABOVE, XCB_STACK_MODE_BELOW };
388 uint32_t mask = XCB_CONFIG_WINDOW_X | XCB_CONFIG_WINDOW_Y |
389 XCB_CONFIG_WINDOW_WIDTH | XCB_CONFIG_WINDOW_HEIGHT |
390 XCB_CONFIG_WINDOW_STACK_MODE;
392 /* Raise the stack window, but keep it below the first floating client
393 * and below the fullscreen client (if any) */
394 Client *first_floating = TAILQ_FIRST(&(container->workspace->floating_clients));
395 if (first_floating != TAILQ_END(&(container->workspace->floating_clients))) {
396 mask |= XCB_CONFIG_WINDOW_SIBLING;
397 values[4] = first_floating->frame;
398 } else if (container->workspace->fullscreen_client != NULL) {
399 mask |= XCB_CONFIG_WINDOW_SIBLING;
400 values[4] = container->workspace->fullscreen_client->frame;
403 xcb_configure_window(conn, stack_win->window, mask, values);
406 /* Prepare the pixmap for usage */
407 cached_pixmap_prepare(conn, &(stack_win->pixmap));
409 /* Render the decorations of all clients */
410 CIRCLEQ_FOREACH(client, &(container->clients), clients) {
411 /* If the client is in fullscreen mode, it does not get reconfigured */
412 if (container->workspace->fullscreen_client == client) {
417 /* Check if we changed client->x or client->y by updating it.
418 * Note the bitwise OR instead of logical OR to force evaluation of both statements */
419 if (client->force_reconfigure |
420 update_if_necessary(&(client->rect.x), container->x) |
421 update_if_necessary(&(client->rect.y), container->y + (decoration_height * num_clients)) |
422 update_if_necessary(&(client->rect.width), container->width) |
423 update_if_necessary(&(client->rect.height), container->height - (decoration_height * num_clients)))
424 resize_client(conn, client);
426 client->force_reconfigure = false;
428 decorate_window(conn, client, stack_win->pixmap.id, stack_win->pixmap.gc,
429 current_client++ * decoration_height);
432 xcb_copy_area(conn, stack_win->pixmap.id, stack_win->window, stack_win->pixmap.gc,
433 0, 0, 0, 0, stack_win->rect.width, stack_win->rect.height);
437 static void render_bars(xcb_connection_t *conn, Workspace *r_ws, int width, int *height) {
439 SLIST_FOREACH(client, &(r_ws->screen->dock_clients), dock_clients) {
440 LOG("client is at %d, should be at %d\n", client->rect.y, *height);
441 if (client->force_reconfigure |
442 update_if_necessary(&(client->rect.x), r_ws->rect.x) |
443 update_if_necessary(&(client->rect.y), *height))
444 reposition_client(conn, client);
446 if (client->force_reconfigure |
447 update_if_necessary(&(client->rect.width), width) |
448 update_if_necessary(&(client->rect.height), client->desired_height))
449 resize_client(conn, client);
451 client->force_reconfigure = false;
452 LOG("desired_height = %d\n", client->desired_height);
453 *height += client->desired_height;
457 static void render_internal_bar(xcb_connection_t *conn, Workspace *r_ws, int width, int height) {
458 i3Font *font = load_font(conn, config.font);
459 i3Screen *screen = r_ws->screen;
460 enum { SET_NORMAL = 0, SET_FOCUSED = 1 };
462 /* Fill the whole bar in black */
463 xcb_change_gc_single(conn, screen->bargc, XCB_GC_FOREGROUND, get_colorpixel(conn, "#000000"));
464 xcb_rectangle_t rect = {0, 0, width, height};
465 xcb_poly_fill_rectangle(conn, screen->bar, screen->bargc, 1, &rect);
468 xcb_change_gc_single(conn, screen->bargc, XCB_GC_FONT, font->id);
471 for (int c = 0; c < 10; c++) {
472 if (workspaces[c].screen != screen)
475 struct Colortriple *color = (screen->current_workspace == c ? &(config.bar.focused) :
476 &(config.bar.unfocused));
477 Workspace *ws = &workspaces[c];
479 /* Draw the outer rect */
480 xcb_draw_rect(conn, screen->bar, screen->bargc, color->border,
483 ws->text_width + 5 + 5, /* width = text width + 5 px left + 5px right */
484 height - 2 /* height = max. height - 1 px upper and 1 px bottom border */);
486 /* Draw the background of this rect */
487 xcb_draw_rect(conn, screen->bar, screen->bargc, color->background,
490 ws->text_width + 4 + 4,
493 xcb_change_gc_single(conn, screen->bargc, XCB_GC_FOREGROUND, color->text);
494 xcb_change_gc_single(conn, screen->bargc, XCB_GC_BACKGROUND, color->background);
495 xcb_image_text_16(conn, ws->name_len, screen->bar, screen->bargc, drawn + 5 /* X */,
496 font->height + 1 /* Y = baseline of font */,
497 (xcb_char2b_t*)ws->name);
498 drawn += ws->text_width + 12;
503 * Modifies the event mask of all clients on the given workspace to either ignore or to handle
504 * enter notifies. It is handy to ignore notifies because they will be sent when a window is mapped
505 * under the cursor, thus when the user didn’t enter the window actively at all.
508 void ignore_enter_notify_forall(xcb_connection_t *conn, Workspace *workspace, bool ignore_enter_notify) {
513 CIRCLEQ_FOREACH(client, &(workspace->table[cols][rows]->clients), clients) {
514 /* Change event mask for the decorations */
515 values[0] = FRAME_EVENT_MASK;
516 if (ignore_enter_notify)
517 values[0] &= ~(XCB_EVENT_MASK_ENTER_WINDOW);
518 xcb_change_window_attributes(conn, client->frame, XCB_CW_EVENT_MASK, values);
520 /* Change event mask for the child itself */
521 values[0] = CHILD_EVENT_MASK;
522 if (ignore_enter_notify)
523 values[0] &= ~(XCB_EVENT_MASK_ENTER_WINDOW);
524 xcb_change_window_attributes(conn, client->child, XCB_CW_EVENT_MASK, values);
529 * Renders the given workspace on the given screen
532 void render_workspace(xcb_connection_t *conn, i3Screen *screen, Workspace *r_ws) {
533 i3Font *font = load_font(conn, config.font);
534 int width = r_ws->rect.width;
535 int height = r_ws->rect.height;
537 /* Reserve space for dock clients */
539 SLIST_FOREACH(client, &(screen->dock_clients), dock_clients)
540 height -= client->desired_height;
542 /* Space for the internal bar */
543 height -= (font->height + 6);
545 int xoffset[r_ws->rows];
546 int yoffset[r_ws->cols];
547 /* Initialize offsets */
548 for (int cols = 0; cols < r_ws->cols; cols++)
549 yoffset[cols] = r_ws->rect.y;
550 for (int rows = 0; rows < r_ws->rows; rows++)
551 xoffset[rows] = r_ws->rect.x;
553 ignore_enter_notify_forall(conn, r_ws, true);
555 /* Go through the whole table and render what’s necessary */
557 Container *container = r_ws->table[cols][rows];
558 int single_width = -1, single_height;
559 /* Update position of the container */
560 container->row = rows;
561 container->col = cols;
562 container->x = xoffset[rows];
563 container->y = yoffset[cols];
564 container->width = 0;
566 for (int c = 0; c < container->colspan; c++) {
567 if (r_ws->width_factor[cols+c] == 0)
568 container->width += (width / r_ws->cols);
569 else container->width += get_unoccupied_x(r_ws) * r_ws->width_factor[cols+c];
571 if (single_width == -1)
572 single_width = container->width;
575 //if (container->height_factor == 0)
576 container->height = (height / r_ws->rows);
577 //else container->height = get_unoccupied_y(r_ws, cols) * container->height_factor;
578 single_height = container->height;
579 container->height *= container->rowspan;
581 /* Render the container if it is not empty */
582 render_container(conn, container);
584 xoffset[rows] += single_width;
585 yoffset[cols] += single_height;
588 ignore_enter_notify_forall(conn, r_ws, false);
590 render_bars(conn, r_ws, width, &height);
591 render_internal_bar(conn, r_ws, width, font->height + 6);
595 * Renders the whole layout, that is: Go through each screen, each workspace, each container
596 * and render each client. This also renders the bars.
598 * If you don’t need to render *everything*, you should call render_container on the container
599 * you want to refresh.
602 void render_layout(xcb_connection_t *conn) {
605 TAILQ_FOREACH(screen, virtual_screens, screens)
606 render_workspace(conn, screen, &(workspaces[screen->current_workspace]));