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
29 * Updates *destination with new_value and returns true if it was changed or false
33 static bool update_if_necessary(uint32_t *destination, const uint32_t new_value) {
34 uint32_t old_value = *destination;
36 return ((*destination = new_value) != old_value);
40 * Gets the unoccupied space (= space which is available for windows which were resized by the user)
41 * for the given row. This is necessary to render both, customly resized windows and never touched
42 * windows correctly, meaning that the aspect ratio will be maintained when opening new windows.
45 int get_unoccupied_x(Workspace *workspace) {
46 int unoccupied = workspace->rect.width;
47 float default_factor = ((float)workspace->rect.width / workspace->cols) / workspace->rect.width;
49 LOG("get_unoccupied_x(), starting with %d, default_factor = %f\n", unoccupied, default_factor);
51 for (int cols = 0; cols < workspace->cols; cols++) {
52 LOG("width_factor[%d] = %f\n", cols, workspace->width_factor[cols]);
54 if (workspace->width_factor[cols] == 0)
55 unoccupied -= workspace->rect.width * default_factor;
58 LOG("unoccupied space: %d\n", unoccupied);
62 /* See get_unoccupied_x() */
63 int get_unoccupied_y(Workspace *workspace, int col) {
64 int unoccupied = workspace->rect.height;
65 float default_factor = ((float)workspace->rect.height / workspace->rows) / workspace->rect.height;
67 LOG("get_unoccupied_y(), starting with %d, default_factor = %f\n", unoccupied, default_factor);
69 for (int rows = 0; rows < workspace->rows; rows++) {
70 LOG("height_factor[%d] = %f\n", rows, workspace->height_factor[rows]);
71 if (workspace->height_factor[rows] == 0)
72 unoccupied -= workspace->rect.height * default_factor;
75 LOG("unoccupied space: %d\n", unoccupied);
80 * Redecorates the given client correctly by checking if it’s in a stacking container and
81 * re-rendering the stack window or just calling decorate_window if it’s not in a stacking
85 void redecorate_window(xcb_connection_t *conn, Client *client) {
86 if (client->container != NULL && client->container->mode == MODE_STACK) {
87 render_container(conn, client->container);
88 /* We clear the frame to generate exposure events, because the color used
89 in drawing may be different */
90 xcb_clear_area(conn, true, client->frame, 0, 0, client->rect.width, client->rect.height);
91 } else decorate_window(conn, client, client->frame, client->titlegc, 0);
96 * (Re-)draws window decorations for a given Client onto the given drawable/graphic context.
97 * When in stacking mode, the window decorations are drawn onto an own window.
100 void decorate_window(xcb_connection_t *conn, Client *client, xcb_drawable_t drawable, xcb_gcontext_t gc, int offset) {
101 i3Font *font = load_font(conn, config.font);
102 int decoration_height = font->height + 2 + 2;
103 struct Colortriple *color;
105 /* Clients without a container (docks) won’t get decorated */
109 LOG("redecorating child %08x\n", client->child);
110 if (client->floating >= FLOATING_AUTO_ON || client->container->currently_focused == client) {
111 /* Distinguish if the window is currently focused… */
112 if (client->floating >= FLOATING_AUTO_ON || CUR_CELL->currently_focused == client)
113 color = &(config.client.focused);
114 /* …or if it is the focused window in a not focused container */
115 else color = &(config.client.focused_inactive);
116 } else color = &(config.client.unfocused);
118 /* Our plan is the following:
119 - Draw a rect around the whole client in color->background
120 - Draw two lines in a lighter color
121 - Draw the window’s title
124 /* Draw a rectangle in background color around the window */
125 xcb_change_gc_single(conn, gc, XCB_GC_FOREGROUND, color->background);
127 /* In stacking mode, we only render the rect for this specific decoration */
128 if (client->container != NULL && client->container->mode == MODE_STACK) {
129 /* We need to use the container’s width because it is the more recent value - when
130 in stacking mode, clients get reconfigured only on demand (the not active client
131 is not reconfigured), so the client’s rect.width would be wrong */
132 xcb_rectangle_t rect = {0, offset, client->container->width, offset + decoration_height };
133 xcb_poly_fill_rectangle(conn, drawable, gc, 1, &rect);
135 xcb_rectangle_t rect = {0, 0, client->rect.width, client->rect.height};
136 xcb_poly_fill_rectangle(conn, drawable, gc, 1, &rect);
138 /* Draw the inner background to have a black frame around clients (such as mplayer)
139 which cannot be resized exactly in our frames and therefore are centered */
140 xcb_change_gc_single(conn, client->titlegc, XCB_GC_FOREGROUND, get_colorpixel(conn, "#000000"));
141 xcb_rectangle_t crect = {2, decoration_height,
142 client->rect.width - (2 + 2), client->rect.height - 2 - decoration_height};
143 xcb_poly_fill_rectangle(conn, client->frame, client->titlegc, 1, &crect);
147 xcb_draw_line(conn, drawable, gc, color->border, 0, offset, client->rect.width, offset);
148 xcb_draw_line(conn, drawable, gc, color->border, 2, offset + font->height + 3,
149 client->rect.width - 3, offset + font->height + 3);
151 /* If the client has a title, we draw it */
152 if (client->name != NULL) {
154 uint32_t mask = XCB_GC_FOREGROUND | XCB_GC_BACKGROUND | XCB_GC_FONT;
155 uint32_t values[] = { color->text, color->background, font->id };
156 xcb_change_gc(conn, gc, mask, values);
158 /* name_len == -1 means this is a legacy application which does not specify _NET_WM_NAME,
159 and we don’t handle the old window name (COMPOUND_TEXT) but only _NET_WM_NAME, which
161 if (client->name_len == -1)
162 xcb_image_text_8(conn, strlen(client->name), drawable, gc, 3 /* X */,
163 offset + font->height /* Y = baseline of font */, client->name);
165 xcb_image_text_16(conn, client->name_len, drawable, gc, 3 /* X */,
166 offset + font->height /* Y = baseline of font */, (xcb_char2b_t*)client->name);
171 * Pushes the client’s x and y coordinates to X11
174 void reposition_client(xcb_connection_t *conn, Client *client) {
175 LOG("frame 0x%08x needs to be pushed to %dx%d\n", client->frame, client->rect.x, client->rect.y);
176 /* Note: We can use a pointer to client->x like an array of uint32_ts
177 because it is followed by client->y by definition */
178 xcb_configure_window(conn, client->frame, XCB_CONFIG_WINDOW_X | XCB_CONFIG_WINDOW_Y, &(client->rect.x));
182 * Pushes the client’s width/height to X11 and resizes the child window
185 void resize_client(xcb_connection_t *conn, Client *client) {
186 i3Font *font = load_font(conn, config.font);
188 LOG("resizing client 0x%08x to %d x %d\n", client->frame, client->rect.width, client->rect.height);
189 xcb_configure_window(conn, client->frame,
190 XCB_CONFIG_WINDOW_WIDTH | XCB_CONFIG_WINDOW_HEIGHT,
191 &(client->rect.width));
193 /* Adjust the position of the child inside its frame.
194 * The coordinates of the child are relative to its frame, we
195 * add a border of 2 pixel to each value */
196 uint32_t mask = XCB_CONFIG_WINDOW_X |
197 XCB_CONFIG_WINDOW_Y |
198 XCB_CONFIG_WINDOW_WIDTH |
199 XCB_CONFIG_WINDOW_HEIGHT;
200 Rect *rect = &(client->child_rect);
201 switch ((client->container != NULL ? client->container->mode : MODE_DEFAULT)) {
205 rect->width = client->rect.width - (2 + 2);
206 rect->height = client->rect.height - 2;
209 if (client->titlebar_position == TITLEBAR_OFF) {
212 rect->width = client->rect.width;
213 rect->height = client->rect.height;
216 rect->y = font->height + 2 + 2;
217 rect->width = client->rect.width - (2 + 2);
218 rect->height = client->rect.height - ((font->height + 2 + 2) + 2);
223 /* Obey the ratio, if any */
224 if (client->proportional_height != 0 &&
225 client->proportional_width != 0) {
226 LOG("proportional height = %d, width = %d\n", client->proportional_height, client->proportional_width);
227 double new_height = rect->height + 1;
228 int new_width = rect->width;
230 while (new_height > rect->height) {
231 new_height = ((double)client->proportional_height / client->proportional_width) * new_width;
233 if (new_height > rect->height)
236 /* Center the window */
237 rect->y += ceil(rect->height / 2) - floor(new_height / 2);
238 rect->x += ceil(rect->width / 2) - floor(new_width / 2);
240 rect->height = new_height;
241 rect->width = new_width;
242 LOG("new_height = %f, new_width = %d\n", new_height, new_width);
245 LOG("child will be at %dx%d with size %dx%d\n", rect->x, rect->y, rect->width, rect->height);
247 xcb_configure_window(conn, client->child, mask, &(rect->x));
249 /* After configuring a child window we need to fake a configure_notify_event (see ICCCM 4.2.3).
250 * This is necessary to inform the client of its position relative to the root window,
251 * not relative to its frame (as done in the configure_notify_event by the x server). */
252 fake_absolute_configure_notify(conn, client);
256 * Renders the given container. Is called by render_layout() or individually (for example
257 * when focus changes in a stacking container)
260 void render_container(xcb_connection_t *conn, Container *container) {
262 int num_clients = 0, current_client = 0;
264 if (container->currently_focused == NULL)
267 CIRCLEQ_FOREACH(client, &(container->clients), clients)
270 if (container->mode == MODE_DEFAULT) {
271 LOG("got %d clients in this default container.\n", num_clients);
272 CIRCLEQ_FOREACH(client, &(container->clients), clients) {
273 /* If the client is in fullscreen mode, it does not get reconfigured */
274 if (container->workspace->fullscreen_client == client) {
279 /* Check if we changed client->x or client->y by updating it.
280 * Note the bitwise OR instead of logical OR to force evaluation of both statements */
281 if (client->force_reconfigure |
282 update_if_necessary(&(client->rect.x), container->x) |
283 update_if_necessary(&(client->rect.y), container->y +
284 (container->height / num_clients) * current_client))
285 reposition_client(conn, client);
287 /* TODO: vertical default layout */
288 if (client->force_reconfigure |
289 update_if_necessary(&(client->rect.width), container->width) |
290 update_if_necessary(&(client->rect.height), container->height / num_clients))
291 resize_client(conn, client);
293 client->force_reconfigure = false;
298 i3Font *font = load_font(conn, config.font);
299 int decoration_height = (font->height + 2 + 2);
300 struct Stack_Window *stack_win = &(container->stack_win);
302 /* Check if we need to remap our stack title window, it gets unmapped when the container
303 is empty in src/handlers.c:unmap_notify() */
304 if (stack_win->rect.height == 0)
305 xcb_map_window(conn, stack_win->window);
307 /* Check if we need to reconfigure our stack title window */
308 if (update_if_necessary(&(stack_win->rect.x), container->x) |
309 update_if_necessary(&(stack_win->rect.y), container->y) |
310 update_if_necessary(&(stack_win->rect.width), container->width) |
311 update_if_necessary(&(stack_win->rect.height), decoration_height * num_clients)) {
313 /* Configuration can happen in two slightly different ways:
315 If there is no client in fullscreen mode, 5 parameters are passed
316 (x, y, width, height, stack mode is set to above which means top-most position).
318 If there is a fullscreen client, the fourth parameter is set to to the
319 fullscreen window as sibling and the stack mode is set to below, which means
320 that the stack_window will be placed just below the sibling, that is, under
321 the fullscreen window.
323 uint32_t values[] = { stack_win->rect.x, stack_win->rect.y,
324 stack_win->rect.width, stack_win->rect.height,
325 XCB_STACK_MODE_ABOVE, XCB_STACK_MODE_BELOW };
326 uint32_t mask = XCB_CONFIG_WINDOW_X | XCB_CONFIG_WINDOW_Y |
327 XCB_CONFIG_WINDOW_WIDTH | XCB_CONFIG_WINDOW_HEIGHT |
328 XCB_CONFIG_WINDOW_STACK_MODE;
330 /* If there is no fullscreen client, we raise the stack window */
331 if (container->workspace->fullscreen_client != NULL) {
332 mask |= XCB_CONFIG_WINDOW_SIBLING;
333 values[4] = container->workspace->fullscreen_client->frame;
336 xcb_configure_window(conn, stack_win->window, mask, values);
339 /* Reconfigure the currently focused client, if necessary. It is the only visible one */
340 client = container->currently_focused;
342 /* Render the decorations of all clients */
343 CIRCLEQ_FOREACH(client, &(container->clients), clients) {
344 /* If the client is in fullscreen mode, it does not get reconfigured */
345 if (container->workspace->fullscreen_client == client) {
350 /* Check if we changed client->x or client->y by updating it.
351 * Note the bitwise OR instead of logical OR to force evaluation of both statements */
352 if (client->force_reconfigure |
353 update_if_necessary(&(client->rect.x), container->x) |
354 update_if_necessary(&(client->rect.y), container->y + (decoration_height * num_clients)))
355 reposition_client(conn, client);
357 if (client->force_reconfigure |
358 update_if_necessary(&(client->rect.width), container->width) |
359 update_if_necessary(&(client->rect.height), container->height - (decoration_height * num_clients)))
360 resize_client(conn, client);
362 client->force_reconfigure = false;
364 decorate_window(conn, client, stack_win->window, stack_win->gc,
365 current_client++ * decoration_height);
370 static void render_bars(xcb_connection_t *conn, Workspace *r_ws, int width, int *height) {
372 SLIST_FOREACH(client, &(r_ws->screen->dock_clients), dock_clients) {
373 LOG("client is at %d, should be at %d\n", client->rect.y, *height);
374 if (client->force_reconfigure |
375 update_if_necessary(&(client->rect.x), 0) |
376 update_if_necessary(&(client->rect.y), *height))
377 reposition_client(conn, client);
379 if (client->force_reconfigure |
380 update_if_necessary(&(client->rect.width), width) |
381 update_if_necessary(&(client->rect.height), client->desired_height))
382 resize_client(conn, client);
384 client->force_reconfigure = false;
385 LOG("desired_height = %d\n", client->desired_height);
386 *height += client->desired_height;
390 static void render_internal_bar(xcb_connection_t *conn, Workspace *r_ws, int width, int height) {
391 LOG("Rendering internal bar\n");
392 i3Font *font = load_font(conn, config.font);
393 i3Screen *screen = r_ws->screen;
394 enum { SET_NORMAL = 0, SET_FOCUSED = 1 };
397 /* Fill the whole bar in black */
398 xcb_change_gc_single(conn, screen->bargc, XCB_GC_FOREGROUND, get_colorpixel(conn, "#000000"));
399 xcb_rectangle_t rect = {0, 0, width, height};
400 xcb_poly_fill_rectangle(conn, screen->bar, screen->bargc, 1, &rect);
403 xcb_change_gc_single(conn, screen->bargc, XCB_GC_FONT, font->id);
406 for (int c = 0; c < 10; c++) {
407 if (workspaces[c].screen != screen)
410 struct Colortriple *color = (screen->current_workspace == c ? &(config.bar.focused) :
411 &(config.bar.unfocused));
413 xcb_draw_rect(conn, screen->bar, screen->bargc, color->border,
414 drawn * height, 1, height - 2, height - 2);
415 xcb_draw_rect(conn, screen->bar, screen->bargc, color->background,
416 drawn * height + 1, 2, height - 4, height - 4);
418 snprintf(label, sizeof(label), "%d", c+1);
419 xcb_change_gc_single(conn, screen->bargc, XCB_GC_FOREGROUND, color->text);
420 xcb_change_gc_single(conn, screen->bargc, XCB_GC_BACKGROUND, color->background);
421 xcb_image_text_8(conn, strlen(label), screen->bar, screen->bargc, drawn * height + 5 /* X */,
422 font->height + 1 /* Y = baseline of font */, label);
426 LOG("done rendering internal\n");
430 * Modifies the event mask of all clients on the given workspace to either ignore or to handle
431 * enter notifies. It is handy to ignore notifies because they will be sent when a window is mapped
432 * under the cursor, thus when the user didn’t enter the window actively at all.
435 void ignore_enter_notify_forall(xcb_connection_t *conn, Workspace *workspace, bool ignore_enter_notify) {
439 LOG("Ignore enter_notify = %d\n", ignore_enter_notify);
442 CIRCLEQ_FOREACH(client, &(workspace->table[cols][rows]->clients), clients) {
443 /* Change event mask for the decorations */
444 values[0] = FRAME_EVENT_MASK;
445 if (ignore_enter_notify)
446 values[0] &= ~(XCB_EVENT_MASK_ENTER_WINDOW);
447 xcb_change_window_attributes(conn, client->frame, XCB_CW_EVENT_MASK, values);
449 /* Change event mask for the child itself */
450 values[0] = CHILD_EVENT_MASK;
451 if (ignore_enter_notify)
452 values[0] &= ~(XCB_EVENT_MASK_ENTER_WINDOW);
453 xcb_change_window_attributes(conn, client->child, XCB_CW_EVENT_MASK, values);
458 * Renders the given workspace on the given screen
461 void render_workspace(xcb_connection_t *conn, i3Screen *screen, Workspace *r_ws) {
462 i3Font *font = load_font(conn, config.font);
463 int width = r_ws->rect.width;
464 int height = r_ws->rect.height;
466 /* Reserve space for dock clients */
468 SLIST_FOREACH(client, &(screen->dock_clients), dock_clients)
469 height -= client->desired_height;
471 /* Space for the internal bar */
472 height -= (font->height + 6);
474 LOG("got %d rows and %d cols\n", r_ws->rows, r_ws->cols);
476 int xoffset[r_ws->rows];
477 int yoffset[r_ws->cols];
478 /* Initialize offsets */
479 for (int cols = 0; cols < r_ws->cols; cols++)
480 yoffset[cols] = r_ws->rect.y;
481 for (int rows = 0; rows < r_ws->rows; rows++)
482 xoffset[rows] = r_ws->rect.x;
484 dump_table(conn, r_ws);
486 ignore_enter_notify_forall(conn, r_ws, true);
488 /* Go through the whole table and render what’s necessary */
490 Container *container = r_ws->table[cols][rows];
491 int single_width = -1, single_height;
494 LOG("container has %d colspan, %d rowspan\n",
495 container->colspan, container->rowspan);
496 LOG("container at %d, %d\n", xoffset[rows], yoffset[cols]);
497 /* Update position of the container */
498 container->row = rows;
499 container->col = cols;
500 container->x = xoffset[rows];
501 container->y = yoffset[cols];
502 container->width = 0;
504 for (int c = 0; c < container->colspan; c++) {
505 if (r_ws->width_factor[cols+c] == 0)
506 container->width += (width / r_ws->cols);
507 else container->width += get_unoccupied_x(r_ws) * r_ws->width_factor[cols+c];
509 if (single_width == -1)
510 single_width = container->width;
513 //if (container->height_factor == 0)
514 container->height = (height / r_ws->rows);
515 //else container->height = get_unoccupied_y(r_ws, cols) * container->height_factor;
516 single_height = container->height;
517 container->height *= container->rowspan;
519 /* Render the container if it is not empty */
520 render_container(conn, container);
522 xoffset[rows] += single_width;
523 yoffset[cols] += single_height;
527 ignore_enter_notify_forall(conn, r_ws, false);
529 render_bars(conn, r_ws, width, &height);
530 render_internal_bar(conn, r_ws, width, font->height + 6);
534 * Renders the whole layout, that is: Go through each screen, each workspace, each container
535 * and render each client. This also renders the bars.
537 * If you don’t need to render *everything*, you should call render_container on the container
538 * you want to refresh.
541 void render_layout(xcb_connection_t *conn) {
544 TAILQ_FOREACH(screen, virtual_screens, screens) {
545 LOG("Rendering screen %d\n", screen->num);
546 render_workspace(conn, screen, &(workspaces[screen->current_workspace]));