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 && client->container->mode == MODE_STACK) {
89 render_container(conn, client->container);
90 /* We clear the frame to generate exposure events, because the color used
91 in drawing may be different */
92 xcb_clear_area(conn, true, client->frame, 0, 0, client->rect.width, client->rect.height);
93 } else decorate_window(conn, client, client->frame, client->titlegc, 0);
98 * (Re-)draws window decorations for a given Client onto the given drawable/graphic context.
99 * When in stacking mode, the window decorations are drawn onto an own window.
102 void decorate_window(xcb_connection_t *conn, Client *client, xcb_drawable_t drawable, xcb_gcontext_t gc, int offset) {
103 i3Font *font = load_font(conn, config.font);
104 int decoration_height = font->height + 2 + 2;
105 struct Colortriple *color;
106 Client *last_focused;
108 /* Clients without a container (docks) won’t get decorated */
112 LOG("redecorating child %08x\n", client->child);
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)
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 xcb_change_gc_single(conn, gc, XCB_GC_FOREGROUND, color->background);
137 /* In stacking mode, we only render the rect for this specific decoration */
138 if (client->container != NULL && client->container->mode == MODE_STACK) {
139 /* We need to use the container’s width because it is the more recent value - when
140 in stacking mode, clients get reconfigured only on demand (the not active client
141 is not reconfigured), so the client’s rect.width would be wrong */
142 xcb_rectangle_t rect = {0, offset, client->container->width, offset + decoration_height };
143 xcb_poly_fill_rectangle(conn, drawable, gc, 1, &rect);
145 xcb_rectangle_t rect = {0, 0, client->rect.width, client->rect.height};
146 xcb_poly_fill_rectangle(conn, drawable, gc, 1, &rect);
148 /* Draw the inner background to have a black frame around clients (such as mplayer)
149 which cannot be resized exactly in our frames and therefore are centered */
150 xcb_change_gc_single(conn, client->titlegc, XCB_GC_FOREGROUND, get_colorpixel(conn, "#000000"));
151 xcb_rectangle_t crect = {2, decoration_height,
152 client->rect.width - (2 + 2), client->rect.height - 2 - decoration_height};
153 xcb_poly_fill_rectangle(conn, client->frame, client->titlegc, 1, &crect);
156 if (client->titlebar_position != TITLEBAR_OFF) {
158 xcb_draw_line(conn, drawable, gc, color->border, 0, offset, client->rect.width, offset);
159 if ((client->container == NULL ||
160 client->container->mode != MODE_STACK ||
161 CIRCLEQ_NEXT_OR_NULL(&(client->container->clients), client, clients) == NULL))
162 xcb_draw_line(conn, drawable, gc, color->border, 2, offset + font->height + 3,
163 client->rect.width - 3, offset + font->height + 3);
166 /* If the client has a title, we draw it */
167 if (client->name != NULL) {
169 uint32_t mask = XCB_GC_FOREGROUND | XCB_GC_BACKGROUND | XCB_GC_FONT;
170 uint32_t values[] = { color->text, color->background, font->id };
171 xcb_change_gc(conn, gc, mask, values);
173 /* name_len == -1 means this is a legacy application which does not specify _NET_WM_NAME,
174 and we don’t handle the old window name (COMPOUND_TEXT) but only _NET_WM_NAME, which
176 if (client->name_len == -1)
177 xcb_image_text_8(conn, strlen(client->name), drawable, gc, 3 /* X */,
178 offset + font->height /* Y = baseline of font */, client->name);
180 xcb_image_text_16(conn, client->name_len, drawable, gc, 3 /* X */,
181 offset + font->height /* Y = baseline of font */, (xcb_char2b_t*)client->name);
186 * Pushes the client’s x and y coordinates to X11
189 void reposition_client(xcb_connection_t *conn, Client *client) {
192 LOG("frame 0x%08x needs to be pushed to %dx%d\n", client->frame, client->rect.x, client->rect.y);
193 /* Note: We can use a pointer to client->x like an array of uint32_ts
194 because it is followed by client->y by definition */
195 xcb_configure_window(conn, client->frame, XCB_CONFIG_WINDOW_X | XCB_CONFIG_WINDOW_Y, &(client->rect.x));
197 if (!client_is_floating(client))
200 /* If the client is floating, we need to check if we moved it to a different workspace */
201 if (client->workspace->screen == (screen = get_screen_containing(client->rect.x, client->rect.y)))
204 if (screen == NULL) {
205 LOG("Boundary checking disabled, no screen found for (%d, %d)\n", client->rect.x, client->rect.y);
209 LOG("Client is on workspace %p with screen %p\n", client->workspace, client->workspace->screen);
210 LOG("but screen at %d, %d is %p\n", client->rect.x, client->rect.y, screen);
211 floating_assign_to_workspace(client, &workspaces[screen->current_workspace]);
216 * Pushes the client’s width/height to X11 and resizes the child window. This
217 * function also updates the client’s position, so if you work on tiling clients
218 * only, you can use this function instead of separate calls to reposition_client
219 * and resize_client to reduce flickering.
222 void resize_client(xcb_connection_t *conn, Client *client) {
223 i3Font *font = load_font(conn, config.font);
225 LOG("frame 0x%08x needs to be pushed to %dx%d\n", client->frame, client->rect.x, client->rect.y);
226 LOG("resizing client 0x%08x to %d x %d\n", client->frame, client->rect.width, client->rect.height);
227 xcb_configure_window(conn, client->frame,
228 XCB_CONFIG_WINDOW_X |
229 XCB_CONFIG_WINDOW_Y |
230 XCB_CONFIG_WINDOW_WIDTH |
231 XCB_CONFIG_WINDOW_HEIGHT,
234 /* Adjust the position of the child inside its frame.
235 * The coordinates of the child are relative to its frame, we
236 * add a border of 2 pixel to each value */
237 uint32_t mask = XCB_CONFIG_WINDOW_X |
238 XCB_CONFIG_WINDOW_Y |
239 XCB_CONFIG_WINDOW_WIDTH |
240 XCB_CONFIG_WINDOW_HEIGHT;
241 Rect *rect = &(client->child_rect);
242 switch ((client->container != NULL ? client->container->mode : MODE_DEFAULT)) {
246 rect->width = client->rect.width - (2 + 2);
247 rect->height = client->rect.height - 2;
250 if (client->titlebar_position == TITLEBAR_OFF && client->borderless) {
253 rect->width = client->rect.width;
254 rect->height = client->rect.height;
255 } else if (client->titlebar_position == TITLEBAR_OFF && !client->borderless) {
258 rect->width = client->rect.width - 1 - 1;
259 rect->height = client->rect.height - 1 - 1;
262 rect->y = font->height + 2 + 2;
263 rect->width = client->rect.width - (2 + 2);
264 rect->height = client->rect.height - ((font->height + 2 + 2) + 2);
269 /* Obey the ratio, if any */
270 if (client->proportional_height != 0 &&
271 client->proportional_width != 0) {
272 LOG("proportional height = %d, width = %d\n", client->proportional_height, client->proportional_width);
273 double new_height = rect->height + 1;
274 int new_width = rect->width;
276 while (new_height > rect->height) {
277 new_height = ((double)client->proportional_height / client->proportional_width) * new_width;
279 if (new_height > rect->height)
282 /* Center the window */
283 rect->y += ceil(rect->height / 2) - floor(new_height / 2);
284 rect->x += ceil(rect->width / 2) - floor(new_width / 2);
286 rect->height = new_height;
287 rect->width = new_width;
288 LOG("new_height = %f, new_width = %d\n", new_height, new_width);
291 LOG("child will be at %dx%d with size %dx%d\n", rect->x, rect->y, rect->width, rect->height);
293 xcb_configure_window(conn, client->child, mask, &(rect->x));
295 /* After configuring a child window we need to fake a configure_notify_event (see ICCCM 4.2.3).
296 * This is necessary to inform the client of its position relative to the root window,
297 * not relative to its frame (as done in the configure_notify_event by the x server). */
298 fake_absolute_configure_notify(conn, client);
302 * Renders the given container. Is called by render_layout() or individually (for example
303 * when focus changes in a stacking container)
306 void render_container(xcb_connection_t *conn, Container *container) {
308 int num_clients = 0, current_client = 0;
310 CIRCLEQ_FOREACH(client, &(container->clients), clients)
313 if (container->mode == MODE_DEFAULT) {
314 LOG("got %d clients in this default container.\n", num_clients);
315 CIRCLEQ_FOREACH(client, &(container->clients), clients) {
316 /* If the client is in fullscreen mode, it does not get reconfigured */
317 if (container->workspace->fullscreen_client == client) {
322 /* Check if we changed client->x or client->y by updating it.
323 * Note the bitwise OR instead of logical OR to force evaluation of both statements */
324 if (client->force_reconfigure |
325 update_if_necessary(&(client->rect.x), container->x) |
326 update_if_necessary(&(client->rect.y), container->y +
327 (container->height / num_clients) * current_client) |
328 update_if_necessary(&(client->rect.width), container->width) |
329 update_if_necessary(&(client->rect.height), container->height / num_clients))
330 resize_client(conn, client);
332 /* TODO: vertical default layout */
334 client->force_reconfigure = false;
339 i3Font *font = load_font(conn, config.font);
340 int decoration_height = (font->height + 2 + 2);
341 struct Stack_Window *stack_win = &(container->stack_win);
343 /* Check if we need to remap our stack title window, it gets unmapped when the container
344 is empty in src/handlers.c:unmap_notify() */
345 if (stack_win->rect.height == 0 && num_clients > 0)
346 xcb_map_window(conn, stack_win->window);
348 /* Check if we need to reconfigure our stack title window */
349 if (update_if_necessary(&(stack_win->rect.x), container->x) |
350 update_if_necessary(&(stack_win->rect.y), container->y) |
351 update_if_necessary(&(stack_win->rect.width), container->width) |
352 update_if_necessary(&(stack_win->rect.height), decoration_height * num_clients)) {
354 /* Configuration can happen in two slightly different ways:
356 If there is no client in fullscreen mode, 5 parameters are passed
357 (x, y, width, height, stack mode is set to above which means top-most position).
359 If there is a fullscreen client, the fourth parameter is set to to the
360 fullscreen window as sibling and the stack mode is set to below, which means
361 that the stack_window will be placed just below the sibling, that is, under
362 the fullscreen window.
364 uint32_t values[] = { stack_win->rect.x, stack_win->rect.y,
365 stack_win->rect.width, stack_win->rect.height,
366 XCB_STACK_MODE_ABOVE, XCB_STACK_MODE_BELOW };
367 uint32_t mask = XCB_CONFIG_WINDOW_X | XCB_CONFIG_WINDOW_Y |
368 XCB_CONFIG_WINDOW_WIDTH | XCB_CONFIG_WINDOW_HEIGHT |
369 XCB_CONFIG_WINDOW_STACK_MODE;
371 /* Raise the stack window, but keep it below the first floating client
372 * and below the fullscreen client (if any) */
373 Client *first_floating = TAILQ_FIRST(&(container->workspace->floating_clients));
374 if (first_floating != TAILQ_END(&(container->workspace->floating_clients))) {
375 mask |= XCB_CONFIG_WINDOW_SIBLING;
376 values[4] = first_floating->frame;
377 } else if (container->workspace->fullscreen_client != NULL) {
378 mask |= XCB_CONFIG_WINDOW_SIBLING;
379 values[4] = container->workspace->fullscreen_client->frame;
382 xcb_configure_window(conn, stack_win->window, mask, values);
385 /* Prepare the pixmap for usage */
386 cached_pixmap_prepare(conn, &(stack_win->pixmap));
388 /* Render the decorations of all clients */
389 CIRCLEQ_FOREACH(client, &(container->clients), clients) {
390 /* If the client is in fullscreen mode, it does not get reconfigured */
391 if (container->workspace->fullscreen_client == client) {
396 /* Check if we changed client->x or client->y by updating it.
397 * Note the bitwise OR instead of logical OR to force evaluation of both statements */
398 if (client->force_reconfigure |
399 update_if_necessary(&(client->rect.x), container->x) |
400 update_if_necessary(&(client->rect.y), container->y + (decoration_height * num_clients)) |
401 update_if_necessary(&(client->rect.width), container->width) |
402 update_if_necessary(&(client->rect.height), container->height - (decoration_height * num_clients)))
403 resize_client(conn, client);
405 client->force_reconfigure = false;
407 decorate_window(conn, client, stack_win->pixmap.id, stack_win->pixmap.gc,
408 current_client++ * decoration_height);
411 xcb_copy_area(conn, stack_win->pixmap.id, stack_win->window, stack_win->pixmap.gc,
412 0, 0, 0, 0, stack_win->rect.width, stack_win->rect.height);
416 static void render_bars(xcb_connection_t *conn, Workspace *r_ws, int width, int *height) {
418 SLIST_FOREACH(client, &(r_ws->screen->dock_clients), dock_clients) {
419 LOG("client is at %d, should be at %d\n", client->rect.y, *height);
420 if (client->force_reconfigure |
421 update_if_necessary(&(client->rect.x), r_ws->rect.x) |
422 update_if_necessary(&(client->rect.y), *height))
423 reposition_client(conn, client);
425 if (client->force_reconfigure |
426 update_if_necessary(&(client->rect.width), width) |
427 update_if_necessary(&(client->rect.height), client->desired_height))
428 resize_client(conn, client);
430 client->force_reconfigure = false;
431 LOG("desired_height = %d\n", client->desired_height);
432 *height += client->desired_height;
436 static void render_internal_bar(xcb_connection_t *conn, Workspace *r_ws, int width, int height) {
437 LOG("Rendering internal bar\n");
438 i3Font *font = load_font(conn, config.font);
439 i3Screen *screen = r_ws->screen;
440 enum { SET_NORMAL = 0, SET_FOCUSED = 1 };
442 /* Fill the whole bar in black */
443 xcb_change_gc_single(conn, screen->bargc, XCB_GC_FOREGROUND, get_colorpixel(conn, "#000000"));
444 xcb_rectangle_t rect = {0, 0, width, height};
445 xcb_poly_fill_rectangle(conn, screen->bar, screen->bargc, 1, &rect);
448 xcb_change_gc_single(conn, screen->bargc, XCB_GC_FONT, font->id);
451 for (int c = 0; c < 10; c++) {
452 if (workspaces[c].screen != screen)
455 struct Colortriple *color = (screen->current_workspace == c ? &(config.bar.focused) :
456 &(config.bar.unfocused));
457 Workspace *ws = &workspaces[c];
459 /* Draw the outer rect */
460 xcb_draw_rect(conn, screen->bar, screen->bargc, color->border,
463 ws->text_width + 5 + 5, /* width = text width + 5 px left + 5px right */
464 height - 2 /* height = max. height - 1 px upper and 1 px bottom border */);
466 /* Draw the background of this rect */
467 xcb_draw_rect(conn, screen->bar, screen->bargc, color->background,
470 ws->text_width + 4 + 4,
473 xcb_change_gc_single(conn, screen->bargc, XCB_GC_FOREGROUND, color->text);
474 xcb_change_gc_single(conn, screen->bargc, XCB_GC_BACKGROUND, color->background);
475 xcb_image_text_16(conn, ws->name_len, screen->bar, screen->bargc, drawn + 5 /* X */,
476 font->height + 1 /* Y = baseline of font */,
477 (xcb_char2b_t*)ws->name);
478 drawn += ws->text_width + 12;
481 LOG("done rendering internal\n");
485 * Modifies the event mask of all clients on the given workspace to either ignore or to handle
486 * enter notifies. It is handy to ignore notifies because they will be sent when a window is mapped
487 * under the cursor, thus when the user didn’t enter the window actively at all.
490 void ignore_enter_notify_forall(xcb_connection_t *conn, Workspace *workspace, bool ignore_enter_notify) {
494 LOG("Ignore enter_notify = %d\n", ignore_enter_notify);
497 CIRCLEQ_FOREACH(client, &(workspace->table[cols][rows]->clients), clients) {
498 /* Change event mask for the decorations */
499 values[0] = FRAME_EVENT_MASK;
500 if (ignore_enter_notify)
501 values[0] &= ~(XCB_EVENT_MASK_ENTER_WINDOW);
502 xcb_change_window_attributes(conn, client->frame, XCB_CW_EVENT_MASK, values);
504 /* Change event mask for the child itself */
505 values[0] = CHILD_EVENT_MASK;
506 if (ignore_enter_notify)
507 values[0] &= ~(XCB_EVENT_MASK_ENTER_WINDOW);
508 xcb_change_window_attributes(conn, client->child, XCB_CW_EVENT_MASK, values);
513 * Renders the given workspace on the given screen
516 void render_workspace(xcb_connection_t *conn, i3Screen *screen, Workspace *r_ws) {
517 i3Font *font = load_font(conn, config.font);
518 int width = r_ws->rect.width;
519 int height = r_ws->rect.height;
521 /* Reserve space for dock clients */
523 SLIST_FOREACH(client, &(screen->dock_clients), dock_clients)
524 height -= client->desired_height;
526 /* Space for the internal bar */
527 height -= (font->height + 6);
529 LOG("got %d rows and %d cols\n", r_ws->rows, r_ws->cols);
531 int xoffset[r_ws->rows];
532 int yoffset[r_ws->cols];
533 /* Initialize offsets */
534 for (int cols = 0; cols < r_ws->cols; cols++)
535 yoffset[cols] = r_ws->rect.y;
536 for (int rows = 0; rows < r_ws->rows; rows++)
537 xoffset[rows] = r_ws->rect.x;
539 dump_table(conn, r_ws);
541 ignore_enter_notify_forall(conn, r_ws, true);
543 /* Go through the whole table and render what’s necessary */
545 Container *container = r_ws->table[cols][rows];
546 int single_width = -1, single_height;
549 LOG("container has %d colspan, %d rowspan\n",
550 container->colspan, container->rowspan);
551 LOG("container at %d, %d\n", xoffset[rows], yoffset[cols]);
552 /* Update position of the container */
553 container->row = rows;
554 container->col = cols;
555 container->x = xoffset[rows];
556 container->y = yoffset[cols];
557 container->width = 0;
559 for (int c = 0; c < container->colspan; c++) {
560 if (r_ws->width_factor[cols+c] == 0)
561 container->width += (width / r_ws->cols);
562 else container->width += get_unoccupied_x(r_ws) * r_ws->width_factor[cols+c];
564 if (single_width == -1)
565 single_width = container->width;
568 //if (container->height_factor == 0)
569 container->height = (height / r_ws->rows);
570 //else container->height = get_unoccupied_y(r_ws, cols) * container->height_factor;
571 single_height = container->height;
572 container->height *= container->rowspan;
574 /* Render the container if it is not empty */
575 render_container(conn, container);
577 xoffset[rows] += single_width;
578 yoffset[cols] += single_height;
582 ignore_enter_notify_forall(conn, r_ws, false);
584 render_bars(conn, r_ws, width, &height);
585 render_internal_bar(conn, r_ws, width, font->height + 6);
589 * Renders the whole layout, that is: Go through each screen, each workspace, each container
590 * and render each client. This also renders the bars.
592 * If you don’t need to render *everything*, you should call render_container on the container
593 * you want to refresh.
596 void render_layout(xcb_connection_t *conn) {
599 TAILQ_FOREACH(screen, virtual_screens, screens) {
600 LOG("Rendering screen %d\n", screen->num);
601 render_workspace(conn, screen, &(workspaces[screen->current_workspace]));