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 uint32_t background_color,
107 /* Clients without a container (docks) won’t get decorated */
111 LOG("redecorating child %08x\n", client->child);
112 if (client->floating || client->container->currently_focused == client) {
113 /* Distinguish if the window is currently focused… */
114 if (client->floating || CUR_CELL->currently_focused == client)
115 background_color = get_colorpixel(conn, config.client.focused.background);
116 /* …or if it is the focused window in a not focused container */
117 else background_color = get_colorpixel(conn, config.client.focused_inactive.background);
119 text_color = get_colorpixel(conn, config.client.focused.text);
120 border_color = get_colorpixel(conn, config.client.focused.border);
122 background_color = get_colorpixel(conn, config.client.unfocused.background);
123 text_color = get_colorpixel(conn, config.client.unfocused.text);
124 border_color = get_colorpixel(conn, config.client.unfocused.border);
127 /* Our plan is the following:
128 - Draw a rect around the whole client in background_color
129 - Draw two lines in a lighter color
130 - Draw the window’s title
133 /* Draw a rectangle in background color around the window */
134 xcb_change_gc_single(conn, gc, XCB_GC_FOREGROUND, background_color);
136 /* In stacking mode, we only render the rect for this specific decoration */
137 if (client->container != NULL && client->container->mode == MODE_STACK) {
138 /* We need to use the container’s width because it is the more recent value - when
139 in stacking mode, clients get reconfigured only on demand (the not active client
140 is not reconfigured), so the client’s rect.width would be wrong */
141 xcb_rectangle_t rect = {0, offset, client->container->width, offset + decoration_height };
142 xcb_poly_fill_rectangle(conn, drawable, gc, 1, &rect);
144 xcb_rectangle_t rect = {0, 0, client->rect.width, client->rect.height};
145 xcb_poly_fill_rectangle(conn, drawable, gc, 1, &rect);
147 /* Draw the inner background to have a black frame around clients (such as mplayer)
148 which cannot be resized exactly in our frames and therefore are centered */
149 xcb_change_gc_single(conn, client->titlegc, XCB_GC_FOREGROUND, get_colorpixel(conn, "#000000"));
150 xcb_rectangle_t crect = {2, decoration_height,
151 client->rect.width - (2 + 2), client->rect.height - 2 - decoration_height};
152 xcb_poly_fill_rectangle(conn, client->frame, client->titlegc, 1, &crect);
156 xcb_draw_line(conn, drawable, gc, border_color, 2, offset, client->rect.width, offset);
157 xcb_draw_line(conn, drawable, gc, border_color, 2, offset + font->height + 3,
158 2 + client->rect.width, offset + font->height + 3);
160 /* If the client has a title, we draw it */
161 if (client->name != NULL) {
163 uint32_t mask = XCB_GC_FOREGROUND | XCB_GC_BACKGROUND | XCB_GC_FONT;
164 uint32_t values[] = { text_color, background_color, font->id };
165 xcb_change_gc(conn, gc, mask, values);
167 /* name_len == -1 means this is a legacy application which does not specify _NET_WM_NAME,
168 and we don’t handle the old window name (COMPOUND_TEXT) but only _NET_WM_NAME, which
170 if (client->name_len == -1)
171 xcb_image_text_8(conn, strlen(client->name), drawable, gc, 3 /* X */,
172 offset + font->height /* Y = baseline of font */, client->name);
174 xcb_image_text_16(conn, client->name_len, drawable, gc, 3 /* X */,
175 offset + font->height /* Y = baseline of font */, (xcb_char2b_t*)client->name);
180 * Pushes the client’s x and y coordinates to X11
183 void reposition_client(xcb_connection_t *conn, Client *client) {
184 LOG("frame 0x%08x needs to be pushed to %dx%d\n", client->frame, client->rect.x, client->rect.y);
185 /* Note: We can use a pointer to client->x like an array of uint32_ts
186 because it is followed by client->y by definition */
187 xcb_configure_window(conn, client->frame, XCB_CONFIG_WINDOW_X | XCB_CONFIG_WINDOW_Y, &(client->rect.x));
191 * Pushes the client’s width/height to X11 and resizes the child window
194 void resize_client(xcb_connection_t *conn, Client *client) {
195 i3Font *font = load_font(conn, config.font);
197 LOG("resizing client 0x%08x to %d x %d\n", client->frame, client->rect.width, client->rect.height);
198 xcb_configure_window(conn, client->frame,
199 XCB_CONFIG_WINDOW_WIDTH | XCB_CONFIG_WINDOW_HEIGHT,
200 &(client->rect.width));
202 /* Adjust the position of the child inside its frame.
203 * The coordinates of the child are relative to its frame, we
204 * add a border of 2 pixel to each value */
205 uint32_t mask = XCB_CONFIG_WINDOW_X |
206 XCB_CONFIG_WINDOW_Y |
207 XCB_CONFIG_WINDOW_WIDTH |
208 XCB_CONFIG_WINDOW_HEIGHT;
209 Rect *rect = &(client->child_rect);
210 switch ((client->container != NULL ? client->container->mode : MODE_DEFAULT)) {
214 rect->width = client->rect.width - (2 + 2);
215 rect->height = client->rect.height - 2;
218 if (client->titlebar_position == TITLEBAR_OFF) {
221 rect->width = client->rect.width;
222 rect->height = client->rect.height;
225 rect->y = font->height + 2 + 2;
226 rect->width = client->rect.width - (2 + 2);
227 rect->height = client->rect.height - ((font->height + 2 + 2) + 2);
232 /* Obey the ratio, if any */
233 if (client->proportional_height != 0 &&
234 client->proportional_width != 0) {
235 LOG("proportional height = %d, width = %d\n", client->proportional_height, client->proportional_width);
236 double new_height = rect->height + 1;
237 int new_width = rect->width;
239 while (new_height > rect->height) {
240 new_height = ((double)client->proportional_height / client->proportional_width) * new_width;
242 if (new_height > rect->height)
245 /* Center the window */
246 rect->y += ceil(rect->height / 2) - floor(new_height / 2);
247 rect->x += ceil(rect->width / 2) - floor(new_width / 2);
249 rect->height = new_height;
250 rect->width = new_width;
251 LOG("new_height = %f, new_width = %d\n", new_height, new_width);
254 LOG("child will be at %dx%d with size %dx%d\n", rect->x, rect->y, rect->width, rect->height);
256 xcb_configure_window(conn, client->child, mask, &(rect->x));
258 /* After configuring a child window we need to fake a configure_notify_event (see ICCCM 4.2.3).
259 * This is necessary to inform the client of its position relative to the root window,
260 * not relative to its frame (as done in the configure_notify_event by the x server). */
261 fake_absolute_configure_notify(conn, client);
265 * Renders the given container. Is called by render_layout() or individually (for example
266 * when focus changes in a stacking container)
269 void render_container(xcb_connection_t *conn, Container *container) {
271 int num_clients = 0, current_client = 0;
273 if (container->currently_focused == NULL)
276 CIRCLEQ_FOREACH(client, &(container->clients), clients)
279 if (container->mode == MODE_DEFAULT) {
280 LOG("got %d clients in this default container.\n", num_clients);
281 CIRCLEQ_FOREACH(client, &(container->clients), clients) {
282 /* If the client is in fullscreen mode, it does not get reconfigured */
283 if (container->workspace->fullscreen_client == client) {
288 /* Check if we changed client->x or client->y by updating it.
289 * Note the bitwise OR instead of logical OR to force evaluation of both statements */
290 if (client->force_reconfigure |
291 update_if_necessary(&(client->rect.x), container->x) |
292 update_if_necessary(&(client->rect.y), container->y +
293 (container->height / num_clients) * current_client))
294 reposition_client(conn, client);
296 /* TODO: vertical default layout */
297 if (client->force_reconfigure |
298 update_if_necessary(&(client->rect.width), container->width) |
299 update_if_necessary(&(client->rect.height), container->height / num_clients))
300 resize_client(conn, client);
302 client->force_reconfigure = false;
307 i3Font *font = load_font(conn, config.font);
308 int decoration_height = (font->height + 2 + 2);
309 struct Stack_Window *stack_win = &(container->stack_win);
311 /* Check if we need to remap our stack title window, it gets unmapped when the container
312 is empty in src/handlers.c:unmap_notify() */
313 if (stack_win->rect.height == 0)
314 xcb_map_window(conn, stack_win->window);
316 /* Check if we need to reconfigure our stack title window */
317 if (update_if_necessary(&(stack_win->rect.x), container->x) |
318 update_if_necessary(&(stack_win->rect.y), container->y) |
319 update_if_necessary(&(stack_win->rect.width), container->width) |
320 update_if_necessary(&(stack_win->rect.height), decoration_height * num_clients)) {
322 /* Configuration can happen in two slightly different ways:
324 If there is no client in fullscreen mode, 5 parameters are passed
325 (x, y, width, height, stack mode is set to above which means top-most position).
327 If there is a fullscreen client, the fourth parameter is set to to the
328 fullscreen window as sibling and the stack mode is set to below, which means
329 that the stack_window will be placed just below the sibling, that is, under
330 the fullscreen window.
332 uint32_t values[] = { stack_win->rect.x, stack_win->rect.y,
333 stack_win->rect.width, stack_win->rect.height,
334 XCB_STACK_MODE_ABOVE, XCB_STACK_MODE_BELOW };
335 uint32_t mask = XCB_CONFIG_WINDOW_X | XCB_CONFIG_WINDOW_Y |
336 XCB_CONFIG_WINDOW_WIDTH | XCB_CONFIG_WINDOW_HEIGHT |
337 XCB_CONFIG_WINDOW_STACK_MODE;
339 /* If there is no fullscreen client, we raise the stack window */
340 if (container->workspace->fullscreen_client != NULL) {
341 mask |= XCB_CONFIG_WINDOW_SIBLING;
342 values[4] = container->workspace->fullscreen_client->frame;
345 xcb_configure_window(conn, stack_win->window, mask, values);
348 /* Reconfigure the currently focused client, if necessary. It is the only visible one */
349 client = container->currently_focused;
351 /* Render the decorations of all clients */
352 CIRCLEQ_FOREACH(client, &(container->clients), clients) {
353 /* If the client is in fullscreen mode, it does not get reconfigured */
354 if (container->workspace->fullscreen_client == client) {
359 /* Check if we changed client->x or client->y by updating it.
360 * Note the bitwise OR instead of logical OR to force evaluation of both statements */
361 if (client->force_reconfigure |
362 update_if_necessary(&(client->rect.x), container->x) |
363 update_if_necessary(&(client->rect.y), container->y + (decoration_height * num_clients)))
364 reposition_client(conn, client);
366 if (client->force_reconfigure |
367 update_if_necessary(&(client->rect.width), container->width) |
368 update_if_necessary(&(client->rect.height), container->height - (decoration_height * num_clients)))
369 resize_client(conn, client);
371 client->force_reconfigure = false;
373 decorate_window(conn, client, stack_win->window, stack_win->gc,
374 current_client++ * decoration_height);
379 static void render_bars(xcb_connection_t *conn, Workspace *r_ws, int width, int *height) {
381 SLIST_FOREACH(client, &(r_ws->screen->dock_clients), dock_clients) {
382 LOG("client is at %d, should be at %d\n", client->rect.y, *height);
383 if (client->force_reconfigure |
384 update_if_necessary(&(client->rect.x), 0) |
385 update_if_necessary(&(client->rect.y), *height))
386 reposition_client(conn, client);
388 if (client->force_reconfigure |
389 update_if_necessary(&(client->rect.width), width) |
390 update_if_necessary(&(client->rect.height), client->desired_height))
391 resize_client(conn, client);
393 client->force_reconfigure = false;
394 LOG("desired_height = %d\n", client->desired_height);
395 *height += client->desired_height;
399 static void render_internal_bar(xcb_connection_t *conn, Workspace *r_ws, int width, int height) {
400 LOG("Rendering internal bar\n");
401 i3Font *font = load_font(conn, config.font);
402 i3Screen *screen = r_ws->screen;
403 enum { SET_NORMAL = 0, SET_FOCUSED = 1 };
404 uint32_t background_color[2],
410 black = get_colorpixel(conn, "#000000");
412 background_color[SET_NORMAL] = get_colorpixel(conn, config.bar.unfocused.background);
413 text_color[SET_NORMAL] = get_colorpixel(conn, config.bar.unfocused.text);
414 border_color[SET_NORMAL] = get_colorpixel(conn, config.bar.unfocused.border);
416 background_color[SET_FOCUSED] = get_colorpixel(conn, config.bar.focused.background);
417 text_color[SET_FOCUSED] = get_colorpixel(conn, config.bar.focused.text);
418 border_color[SET_FOCUSED] = get_colorpixel(conn, config.bar.focused.border);
420 /* Fill the whole bar in black */
421 xcb_change_gc_single(conn, screen->bargc, XCB_GC_FOREGROUND, black);
422 xcb_rectangle_t rect = {0, 0, width, height};
423 xcb_poly_fill_rectangle(conn, screen->bar, screen->bargc, 1, &rect);
426 xcb_change_gc_single(conn, screen->bargc, XCB_GC_FONT, font->id);
429 for (int c = 0; c < 10; c++) {
430 if (workspaces[c].screen != screen)
433 int set = (screen->current_workspace == c ? SET_FOCUSED : SET_NORMAL);
435 xcb_draw_rect(conn, screen->bar, screen->bargc, border_color[set],
436 drawn * height, 1, height - 2, height - 2);
437 xcb_draw_rect(conn, screen->bar, screen->bargc, background_color[set],
438 drawn * height + 1, 2, height - 4, height - 4);
440 snprintf(label, sizeof(label), "%d", c+1);
441 xcb_change_gc_single(conn, screen->bargc, XCB_GC_FOREGROUND, text_color[set]);
442 xcb_change_gc_single(conn, screen->bargc, XCB_GC_BACKGROUND, background_color[set]);
443 xcb_image_text_8(conn, strlen(label), screen->bar, screen->bargc, drawn * height + 5 /* X */,
444 font->height + 1 /* Y = baseline of font */, label);
448 LOG("done rendering internal\n");
452 * Modifies the event mask of all clients on the given workspace to either ignore or to handle
453 * enter notifies. It is handy to ignore notifies because they will be sent when a window is mapped
454 * under the cursor, thus when the user didn’t enter the window actively at all.
457 void ignore_enter_notify_forall(xcb_connection_t *conn, Workspace *workspace, bool ignore_enter_notify) {
461 LOG("Ignore enter_notify = %d\n", ignore_enter_notify);
464 CIRCLEQ_FOREACH(client, &(workspace->table[cols][rows]->clients), clients) {
465 /* Change event mask for the decorations */
466 values[0] = FRAME_EVENT_MASK;
467 if (ignore_enter_notify)
468 values[0] &= ~(XCB_EVENT_MASK_ENTER_WINDOW);
469 xcb_change_window_attributes(conn, client->frame, XCB_CW_EVENT_MASK, values);
471 /* Change event mask for the child itself */
472 values[0] = CHILD_EVENT_MASK;
473 if (ignore_enter_notify)
474 values[0] &= ~(XCB_EVENT_MASK_ENTER_WINDOW);
475 xcb_change_window_attributes(conn, client->child, XCB_CW_EVENT_MASK, values);
480 * Renders the given workspace on the given screen
483 void render_workspace(xcb_connection_t *conn, i3Screen *screen, Workspace *r_ws) {
484 i3Font *font = load_font(conn, config.font);
485 int width = r_ws->rect.width;
486 int height = r_ws->rect.height;
488 /* Reserve space for dock clients */
490 SLIST_FOREACH(client, &(screen->dock_clients), dock_clients)
491 height -= client->desired_height;
493 /* Space for the internal bar */
494 height -= (font->height + 6);
496 LOG("got %d rows and %d cols\n", r_ws->rows, r_ws->cols);
498 int xoffset[r_ws->rows];
499 int yoffset[r_ws->cols];
500 /* Initialize offsets */
501 for (int cols = 0; cols < r_ws->cols; cols++)
502 yoffset[cols] = r_ws->rect.y;
503 for (int rows = 0; rows < r_ws->rows; rows++)
504 xoffset[rows] = r_ws->rect.x;
506 dump_table(conn, r_ws);
508 ignore_enter_notify_forall(conn, r_ws, true);
510 /* Go through the whole table and render what’s necessary */
512 Container *container = r_ws->table[cols][rows];
513 int single_width = -1, single_height;
516 LOG("container has %d colspan, %d rowspan\n",
517 container->colspan, container->rowspan);
518 LOG("container at %d, %d\n", xoffset[rows], yoffset[cols]);
519 /* Update position of the container */
520 container->row = rows;
521 container->col = cols;
522 container->x = xoffset[rows];
523 container->y = yoffset[cols];
524 container->width = 0;
526 for (int c = 0; c < container->colspan; c++) {
527 if (r_ws->width_factor[cols+c] == 0)
528 container->width += (width / r_ws->cols);
529 else container->width += get_unoccupied_x(r_ws) * r_ws->width_factor[cols+c];
531 if (single_width == -1)
532 single_width = container->width;
535 //if (container->height_factor == 0)
536 container->height = (height / r_ws->rows);
537 //else container->height = get_unoccupied_y(r_ws, cols) * container->height_factor;
538 single_height = container->height;
539 container->height *= container->rowspan;
541 /* Render the container if it is not empty */
542 render_container(conn, container);
544 xoffset[rows] += single_width;
545 yoffset[cols] += single_height;
549 ignore_enter_notify_forall(conn, r_ws, false);
551 render_bars(conn, r_ws, width, &height);
552 render_internal_bar(conn, r_ws, width, font->height + 6);
556 * Renders the whole layout, that is: Go through each screen, each workspace, each container
557 * and render each client. This also renders the bars.
559 * If you don’t need to render *everything*, you should call render_container on the container
560 * you want to refresh.
563 void render_layout(xcb_connection_t *conn) {
566 TAILQ_FOREACH(screen, virtual_screens, screens) {
567 LOG("Rendering screen %d\n", screen->num);
568 render_workspace(conn, screen, &(workspaces[screen->current_workspace]));