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 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]);
215 * Pushes the client’s width/height to X11 and resizes the child window. This
216 * function also updates the client’s position, so if you work on tiling clients
217 * only, you can use this function instead of separate calls to reposition_client
218 * and resize_client to reduce flickering.
221 void resize_client(xcb_connection_t *conn, Client *client) {
222 i3Font *font = load_font(conn, config.font);
224 LOG("frame 0x%08x needs to be pushed to %dx%d\n", client->frame, client->rect.x, client->rect.y);
225 LOG("resizing client 0x%08x to %d x %d\n", client->frame, client->rect.width, client->rect.height);
226 xcb_configure_window(conn, client->frame,
227 XCB_CONFIG_WINDOW_X |
228 XCB_CONFIG_WINDOW_Y |
229 XCB_CONFIG_WINDOW_WIDTH |
230 XCB_CONFIG_WINDOW_HEIGHT,
233 /* Adjust the position of the child inside its frame.
234 * The coordinates of the child are relative to its frame, we
235 * add a border of 2 pixel to each value */
236 uint32_t mask = XCB_CONFIG_WINDOW_X |
237 XCB_CONFIG_WINDOW_Y |
238 XCB_CONFIG_WINDOW_WIDTH |
239 XCB_CONFIG_WINDOW_HEIGHT;
240 Rect *rect = &(client->child_rect);
241 switch ((client->container != NULL ? client->container->mode : MODE_DEFAULT)) {
245 rect->width = client->rect.width - (2 + 2);
246 rect->height = client->rect.height - 2;
249 if (client->titlebar_position == TITLEBAR_OFF && client->borderless) {
252 rect->width = client->rect.width;
253 rect->height = client->rect.height;
254 } else if (client->titlebar_position == TITLEBAR_OFF && !client->borderless) {
257 rect->width = client->rect.width - 1 - 1;
258 rect->height = client->rect.height - 1 - 1;
261 rect->y = font->height + 2 + 2;
262 rect->width = client->rect.width - (2 + 2);
263 rect->height = client->rect.height - ((font->height + 2 + 2) + 2);
268 /* Obey the ratio, if any */
269 if (client->proportional_height != 0 &&
270 client->proportional_width != 0) {
271 LOG("proportional height = %d, width = %d\n", client->proportional_height, client->proportional_width);
272 double new_height = rect->height + 1;
273 int new_width = rect->width;
275 while (new_height > rect->height) {
276 new_height = ((double)client->proportional_height / client->proportional_width) * new_width;
278 if (new_height > rect->height)
281 /* Center the window */
282 rect->y += ceil(rect->height / 2) - floor(new_height / 2);
283 rect->x += ceil(rect->width / 2) - floor(new_width / 2);
285 rect->height = new_height;
286 rect->width = new_width;
287 LOG("new_height = %f, new_width = %d\n", new_height, new_width);
290 if (client->height_increment > 1) {
291 int old_height = rect->height;
292 rect->height -= (rect->height - client->base_height) % client->height_increment;
293 LOG("Lost %d pixel due to client's height_increment (%d px)\n",
294 old_height - rect->height, client->height_increment);
297 if (client->width_increment > 1) {
298 int old_width = rect->width;
299 rect->width -= (rect->width - client->base_width) % client->width_increment;
300 LOG("Lost %d pixel due to client's width_increment (%d px)\n",
301 old_width - rect->width, client->width_increment);
304 LOG("child will be at %dx%d with size %dx%d\n", rect->x, rect->y, rect->width, rect->height);
306 xcb_configure_window(conn, client->child, mask, &(rect->x));
308 /* After configuring a child window we need to fake a configure_notify_event (see ICCCM 4.2.3).
309 * This is necessary to inform the client of its position relative to the root window,
310 * not relative to its frame (as done in the configure_notify_event by the x server). */
311 fake_absolute_configure_notify(conn, client);
313 /* Force redrawing after resizing the window because any now lost
314 * pixels could contain old garbage. */
315 xcb_expose_event_t generated;
316 generated.window = client->frame;
318 handle_expose_event(NULL, conn, &generated);
322 * Renders the given container. Is called by render_layout() or individually (for example
323 * when focus changes in a stacking container)
326 void render_container(xcb_connection_t *conn, Container *container) {
328 int num_clients = 0, current_client = 0;
330 CIRCLEQ_FOREACH(client, &(container->clients), clients)
333 if (container->mode == MODE_DEFAULT) {
334 CIRCLEQ_FOREACH(client, &(container->clients), clients) {
335 /* If the client is in fullscreen mode, it does not get reconfigured */
336 if (container->workspace->fullscreen_client == client) {
341 /* Check if we changed client->x or client->y by updating it.
342 * Note the bitwise OR instead of logical OR to force evaluation of both statements */
343 if (client->force_reconfigure |
344 update_if_necessary(&(client->rect.x), container->x) |
345 update_if_necessary(&(client->rect.y), container->y +
346 (container->height / num_clients) * current_client) |
347 update_if_necessary(&(client->rect.width), container->width) |
348 update_if_necessary(&(client->rect.height), container->height / num_clients))
349 resize_client(conn, client);
351 /* TODO: vertical default layout */
353 client->force_reconfigure = false;
358 i3Font *font = load_font(conn, config.font);
359 int decoration_height = (font->height + 2 + 2);
360 struct Stack_Window *stack_win = &(container->stack_win);
362 /* Check if we need to remap our stack title window, it gets unmapped when the container
363 is empty in src/handlers.c:unmap_notify() */
364 if (stack_win->rect.height == 0 && num_clients > 0)
365 xcb_map_window(conn, stack_win->window);
367 /* Check if we need to reconfigure our stack title window */
368 if (update_if_necessary(&(stack_win->rect.x), container->x) |
369 update_if_necessary(&(stack_win->rect.y), container->y) |
370 update_if_necessary(&(stack_win->rect.width), container->width) |
371 update_if_necessary(&(stack_win->rect.height), decoration_height * num_clients)) {
373 /* Configuration can happen in two slightly different ways:
375 If there is no client in fullscreen mode, 5 parameters are passed
376 (x, y, width, height, stack mode is set to above which means top-most position).
378 If there is a fullscreen client, the fourth parameter is set to to the
379 fullscreen window as sibling and the stack mode is set to below, which means
380 that the stack_window will be placed just below the sibling, that is, under
381 the fullscreen window.
383 uint32_t values[] = { stack_win->rect.x, stack_win->rect.y,
384 stack_win->rect.width, stack_win->rect.height,
385 XCB_STACK_MODE_ABOVE, XCB_STACK_MODE_BELOW };
386 uint32_t mask = XCB_CONFIG_WINDOW_X | XCB_CONFIG_WINDOW_Y |
387 XCB_CONFIG_WINDOW_WIDTH | XCB_CONFIG_WINDOW_HEIGHT |
388 XCB_CONFIG_WINDOW_STACK_MODE;
390 /* Raise the stack window, but keep it below the first floating client
391 * and below the fullscreen client (if any) */
392 Client *first_floating = TAILQ_FIRST(&(container->workspace->floating_clients));
393 if (first_floating != TAILQ_END(&(container->workspace->floating_clients))) {
394 mask |= XCB_CONFIG_WINDOW_SIBLING;
395 values[4] = first_floating->frame;
396 } else if (container->workspace->fullscreen_client != NULL) {
397 mask |= XCB_CONFIG_WINDOW_SIBLING;
398 values[4] = container->workspace->fullscreen_client->frame;
401 xcb_configure_window(conn, stack_win->window, mask, values);
404 /* Prepare the pixmap for usage */
405 cached_pixmap_prepare(conn, &(stack_win->pixmap));
407 /* Render the decorations of all clients */
408 CIRCLEQ_FOREACH(client, &(container->clients), clients) {
409 /* If the client is in fullscreen mode, it does not get reconfigured */
410 if (container->workspace->fullscreen_client == client) {
415 /* Check if we changed client->x or client->y by updating it.
416 * Note the bitwise OR instead of logical OR to force evaluation of both statements */
417 if (client->force_reconfigure |
418 update_if_necessary(&(client->rect.x), container->x) |
419 update_if_necessary(&(client->rect.y), container->y + (decoration_height * num_clients)) |
420 update_if_necessary(&(client->rect.width), container->width) |
421 update_if_necessary(&(client->rect.height), container->height - (decoration_height * num_clients)))
422 resize_client(conn, client);
424 client->force_reconfigure = false;
426 decorate_window(conn, client, stack_win->pixmap.id, stack_win->pixmap.gc,
427 current_client++ * decoration_height);
430 xcb_copy_area(conn, stack_win->pixmap.id, stack_win->window, stack_win->pixmap.gc,
431 0, 0, 0, 0, stack_win->rect.width, stack_win->rect.height);
435 static void render_bars(xcb_connection_t *conn, Workspace *r_ws, int width, int *height) {
437 SLIST_FOREACH(client, &(r_ws->screen->dock_clients), dock_clients) {
438 LOG("client is at %d, should be at %d\n", client->rect.y, *height);
439 if (client->force_reconfigure |
440 update_if_necessary(&(client->rect.x), r_ws->rect.x) |
441 update_if_necessary(&(client->rect.y), *height))
442 reposition_client(conn, client);
444 if (client->force_reconfigure |
445 update_if_necessary(&(client->rect.width), width) |
446 update_if_necessary(&(client->rect.height), client->desired_height))
447 resize_client(conn, client);
449 client->force_reconfigure = false;
450 LOG("desired_height = %d\n", client->desired_height);
451 *height += client->desired_height;
455 static void render_internal_bar(xcb_connection_t *conn, Workspace *r_ws, int width, int height) {
456 i3Font *font = load_font(conn, config.font);
457 i3Screen *screen = r_ws->screen;
458 enum { SET_NORMAL = 0, SET_FOCUSED = 1 };
460 /* Fill the whole bar in black */
461 xcb_change_gc_single(conn, screen->bargc, XCB_GC_FOREGROUND, get_colorpixel(conn, "#000000"));
462 xcb_rectangle_t rect = {0, 0, width, height};
463 xcb_poly_fill_rectangle(conn, screen->bar, screen->bargc, 1, &rect);
466 xcb_change_gc_single(conn, screen->bargc, XCB_GC_FONT, font->id);
469 for (int c = 0; c < 10; c++) {
470 if (workspaces[c].screen != screen)
473 struct Colortriple *color = (screen->current_workspace == c ? &(config.bar.focused) :
474 &(config.bar.unfocused));
475 Workspace *ws = &workspaces[c];
477 /* Draw the outer rect */
478 xcb_draw_rect(conn, screen->bar, screen->bargc, color->border,
481 ws->text_width + 5 + 5, /* width = text width + 5 px left + 5px right */
482 height - 2 /* height = max. height - 1 px upper and 1 px bottom border */);
484 /* Draw the background of this rect */
485 xcb_draw_rect(conn, screen->bar, screen->bargc, color->background,
488 ws->text_width + 4 + 4,
491 xcb_change_gc_single(conn, screen->bargc, XCB_GC_FOREGROUND, color->text);
492 xcb_change_gc_single(conn, screen->bargc, XCB_GC_BACKGROUND, color->background);
493 xcb_image_text_16(conn, ws->name_len, screen->bar, screen->bargc, drawn + 5 /* X */,
494 font->height + 1 /* Y = baseline of font */,
495 (xcb_char2b_t*)ws->name);
496 drawn += ws->text_width + 12;
501 * Modifies the event mask of all clients on the given workspace to either ignore or to handle
502 * enter notifies. It is handy to ignore notifies because they will be sent when a window is mapped
503 * under the cursor, thus when the user didn’t enter the window actively at all.
506 void ignore_enter_notify_forall(xcb_connection_t *conn, Workspace *workspace, bool ignore_enter_notify) {
511 CIRCLEQ_FOREACH(client, &(workspace->table[cols][rows]->clients), clients) {
512 /* Change event mask for the decorations */
513 values[0] = FRAME_EVENT_MASK;
514 if (ignore_enter_notify)
515 values[0] &= ~(XCB_EVENT_MASK_ENTER_WINDOW);
516 xcb_change_window_attributes(conn, client->frame, XCB_CW_EVENT_MASK, values);
518 /* Change event mask for the child itself */
519 values[0] = CHILD_EVENT_MASK;
520 if (ignore_enter_notify)
521 values[0] &= ~(XCB_EVENT_MASK_ENTER_WINDOW);
522 xcb_change_window_attributes(conn, client->child, XCB_CW_EVENT_MASK, values);
527 * Renders the given workspace on the given screen
530 void render_workspace(xcb_connection_t *conn, i3Screen *screen, Workspace *r_ws) {
531 i3Font *font = load_font(conn, config.font);
532 int width = r_ws->rect.width;
533 int height = r_ws->rect.height;
535 /* Reserve space for dock clients */
537 SLIST_FOREACH(client, &(screen->dock_clients), dock_clients)
538 height -= client->desired_height;
540 /* Space for the internal bar */
541 height -= (font->height + 6);
543 int xoffset[r_ws->rows];
544 int yoffset[r_ws->cols];
545 /* Initialize offsets */
546 for (int cols = 0; cols < r_ws->cols; cols++)
547 yoffset[cols] = r_ws->rect.y;
548 for (int rows = 0; rows < r_ws->rows; rows++)
549 xoffset[rows] = r_ws->rect.x;
551 ignore_enter_notify_forall(conn, r_ws, true);
553 /* Go through the whole table and render what’s necessary */
555 Container *container = r_ws->table[cols][rows];
556 int single_width = -1, single_height;
557 /* Update position of the container */
558 container->row = rows;
559 container->col = cols;
560 container->x = xoffset[rows];
561 container->y = yoffset[cols];
562 container->width = 0;
564 for (int c = 0; c < container->colspan; c++) {
565 if (r_ws->width_factor[cols+c] == 0)
566 container->width += (width / r_ws->cols);
567 else container->width += get_unoccupied_x(r_ws) * r_ws->width_factor[cols+c];
569 if (single_width == -1)
570 single_width = container->width;
573 //if (container->height_factor == 0)
574 container->height = (height / r_ws->rows);
575 //else container->height = get_unoccupied_y(r_ws, cols) * container->height_factor;
576 single_height = container->height;
577 container->height *= container->rowspan;
579 /* Render the container if it is not empty */
580 render_container(conn, container);
582 xoffset[rows] += single_width;
583 yoffset[cols] += single_height;
586 ignore_enter_notify_forall(conn, r_ws, false);
588 render_bars(conn, r_ws, width, &height);
589 render_internal_bar(conn, r_ws, width, font->height + 6);
593 * Renders the whole layout, that is: Go through each screen, each workspace, each container
594 * and render each client. This also renders the bars.
596 * If you don’t need to render *everything*, you should call render_container on the container
597 * you want to refresh.
600 void render_layout(xcb_connection_t *conn) {
603 TAILQ_FOREACH(screen, virtual_screens, screens)
604 render_workspace(conn, screen, &(workspaces[screen->current_workspace]));