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;
107 /* Clients without a container (docks) won’t get decorated */
111 LOG("redecorating child %08x\n", client->child);
112 if (client_is_floating(client) || client->container->currently_focused == client) {
113 /* Distinguish if the window is currently focused… */
114 if (client_is_floating(client) || CUR_CELL->currently_focused == client)
115 color = &(config.client.focused);
116 /* …or if it is the focused window in a not focused container */
117 else color = &(config.client.focused_inactive);
118 } else color = &(config.client.unfocused);
120 /* Our plan is the following:
121 - Draw a rect around the whole client in color->background
122 - Draw two lines in a lighter color
123 - Draw the window’s title
126 /* Draw a rectangle in background color around the window */
127 xcb_change_gc_single(conn, gc, XCB_GC_FOREGROUND, color->background);
129 /* In stacking mode, we only render the rect for this specific decoration */
130 if (client->container != NULL && client->container->mode == MODE_STACK) {
131 /* We need to use the container’s width because it is the more recent value - when
132 in stacking mode, clients get reconfigured only on demand (the not active client
133 is not reconfigured), so the client’s rect.width would be wrong */
134 xcb_rectangle_t rect = {0, offset, client->container->width, offset + decoration_height };
135 xcb_poly_fill_rectangle(conn, drawable, gc, 1, &rect);
137 xcb_rectangle_t rect = {0, 0, client->rect.width, client->rect.height};
138 xcb_poly_fill_rectangle(conn, drawable, gc, 1, &rect);
140 /* Draw the inner background to have a black frame around clients (such as mplayer)
141 which cannot be resized exactly in our frames and therefore are centered */
142 xcb_change_gc_single(conn, client->titlegc, XCB_GC_FOREGROUND, get_colorpixel(conn, "#000000"));
143 xcb_rectangle_t crect = {2, decoration_height,
144 client->rect.width - (2 + 2), client->rect.height - 2 - decoration_height};
145 xcb_poly_fill_rectangle(conn, client->frame, client->titlegc, 1, &crect);
149 xcb_draw_line(conn, drawable, gc, color->border, 0, offset, client->rect.width, offset);
150 xcb_draw_line(conn, drawable, gc, color->border, 2, offset + font->height + 3,
151 client->rect.width - 3, offset + font->height + 3);
153 /* If the client has a title, we draw it */
154 if (client->name != NULL) {
156 uint32_t mask = XCB_GC_FOREGROUND | XCB_GC_BACKGROUND | XCB_GC_FONT;
157 uint32_t values[] = { color->text, color->background, font->id };
158 xcb_change_gc(conn, gc, mask, values);
160 /* name_len == -1 means this is a legacy application which does not specify _NET_WM_NAME,
161 and we don’t handle the old window name (COMPOUND_TEXT) but only _NET_WM_NAME, which
163 if (client->name_len == -1)
164 xcb_image_text_8(conn, strlen(client->name), drawable, gc, 3 /* X */,
165 offset + font->height /* Y = baseline of font */, client->name);
167 xcb_image_text_16(conn, client->name_len, drawable, gc, 3 /* X */,
168 offset + font->height /* Y = baseline of font */, (xcb_char2b_t*)client->name);
173 * Pushes the client’s x and y coordinates to X11
176 void reposition_client(xcb_connection_t *conn, Client *client) {
179 LOG("frame 0x%08x needs to be pushed to %dx%d\n", client->frame, client->rect.x, client->rect.y);
180 /* Note: We can use a pointer to client->x like an array of uint32_ts
181 because it is followed by client->y by definition */
182 xcb_configure_window(conn, client->frame, XCB_CONFIG_WINDOW_X | XCB_CONFIG_WINDOW_Y, &(client->rect.x));
184 if (!client_is_floating(client))
187 /* If the client is floating, we need to check if we moved it to a different workspace */
188 if (client->workspace->screen == (screen = get_screen_containing(client->rect.x, client->rect.y)))
191 if (screen == NULL) {
192 LOG("Boundary checking disabled, no screen found for (%d, %d)\n", client->rect.x, client->rect.y);
196 LOG("Client is on workspace %p with screen %p\n", client->workspace, client->workspace->screen);
197 LOG("but screen at %d, %d is %p\n", client->rect.x, client->rect.y, screen);
198 floating_assign_to_workspace(client, &workspaces[screen->current_workspace]);
203 * Pushes the client’s width/height to X11 and resizes the child window
206 void resize_client(xcb_connection_t *conn, Client *client) {
207 i3Font *font = load_font(conn, config.font);
209 LOG("resizing client 0x%08x to %d x %d\n", client->frame, client->rect.width, client->rect.height);
210 xcb_configure_window(conn, client->frame,
211 XCB_CONFIG_WINDOW_WIDTH | XCB_CONFIG_WINDOW_HEIGHT,
212 &(client->rect.width));
214 /* Adjust the position of the child inside its frame.
215 * The coordinates of the child are relative to its frame, we
216 * add a border of 2 pixel to each value */
217 uint32_t mask = XCB_CONFIG_WINDOW_X |
218 XCB_CONFIG_WINDOW_Y |
219 XCB_CONFIG_WINDOW_WIDTH |
220 XCB_CONFIG_WINDOW_HEIGHT;
221 Rect *rect = &(client->child_rect);
222 switch ((client->container != NULL ? client->container->mode : MODE_DEFAULT)) {
226 rect->width = client->rect.width - (2 + 2);
227 rect->height = client->rect.height - 2;
230 if (client->titlebar_position == TITLEBAR_OFF) {
233 rect->width = client->rect.width;
234 rect->height = client->rect.height;
237 rect->y = font->height + 2 + 2;
238 rect->width = client->rect.width - (2 + 2);
239 rect->height = client->rect.height - ((font->height + 2 + 2) + 2);
244 /* Obey the ratio, if any */
245 if (client->proportional_height != 0 &&
246 client->proportional_width != 0) {
247 LOG("proportional height = %d, width = %d\n", client->proportional_height, client->proportional_width);
248 double new_height = rect->height + 1;
249 int new_width = rect->width;
251 while (new_height > rect->height) {
252 new_height = ((double)client->proportional_height / client->proportional_width) * new_width;
254 if (new_height > rect->height)
257 /* Center the window */
258 rect->y += ceil(rect->height / 2) - floor(new_height / 2);
259 rect->x += ceil(rect->width / 2) - floor(new_width / 2);
261 rect->height = new_height;
262 rect->width = new_width;
263 LOG("new_height = %f, new_width = %d\n", new_height, new_width);
266 LOG("child will be at %dx%d with size %dx%d\n", rect->x, rect->y, rect->width, rect->height);
268 xcb_configure_window(conn, client->child, mask, &(rect->x));
270 /* After configuring a child window we need to fake a configure_notify_event (see ICCCM 4.2.3).
271 * This is necessary to inform the client of its position relative to the root window,
272 * not relative to its frame (as done in the configure_notify_event by the x server). */
273 fake_absolute_configure_notify(conn, client);
277 * Renders the given container. Is called by render_layout() or individually (for example
278 * when focus changes in a stacking container)
281 void render_container(xcb_connection_t *conn, Container *container) {
283 int num_clients = 0, current_client = 0;
285 if (container->currently_focused == NULL)
288 CIRCLEQ_FOREACH(client, &(container->clients), clients)
291 if (container->mode == MODE_DEFAULT) {
292 LOG("got %d clients in this default container.\n", num_clients);
293 CIRCLEQ_FOREACH(client, &(container->clients), clients) {
294 /* If the client is in fullscreen mode, it does not get reconfigured */
295 if (container->workspace->fullscreen_client == client) {
300 /* Check if we changed client->x or client->y by updating it.
301 * Note the bitwise OR instead of logical OR to force evaluation of both statements */
302 if (client->force_reconfigure |
303 update_if_necessary(&(client->rect.x), container->x) |
304 update_if_necessary(&(client->rect.y), container->y +
305 (container->height / num_clients) * current_client))
306 reposition_client(conn, client);
308 /* TODO: vertical default layout */
309 if (client->force_reconfigure |
310 update_if_necessary(&(client->rect.width), container->width) |
311 update_if_necessary(&(client->rect.height), container->height / num_clients))
312 resize_client(conn, client);
314 client->force_reconfigure = false;
319 i3Font *font = load_font(conn, config.font);
320 int decoration_height = (font->height + 2 + 2);
321 struct Stack_Window *stack_win = &(container->stack_win);
323 /* Check if we need to remap our stack title window, it gets unmapped when the container
324 is empty in src/handlers.c:unmap_notify() */
325 if (stack_win->rect.height == 0)
326 xcb_map_window(conn, stack_win->window);
328 /* Check if we need to reconfigure our stack title window */
329 if (update_if_necessary(&(stack_win->rect.x), container->x) |
330 update_if_necessary(&(stack_win->rect.y), container->y) |
331 update_if_necessary(&(stack_win->rect.width), container->width) |
332 update_if_necessary(&(stack_win->rect.height), decoration_height * num_clients)) {
334 /* Configuration can happen in two slightly different ways:
336 If there is no client in fullscreen mode, 5 parameters are passed
337 (x, y, width, height, stack mode is set to above which means top-most position).
339 If there is a fullscreen client, the fourth parameter is set to to the
340 fullscreen window as sibling and the stack mode is set to below, which means
341 that the stack_window will be placed just below the sibling, that is, under
342 the fullscreen window.
344 uint32_t values[] = { stack_win->rect.x, stack_win->rect.y,
345 stack_win->rect.width, stack_win->rect.height,
346 XCB_STACK_MODE_ABOVE, XCB_STACK_MODE_BELOW };
347 uint32_t mask = XCB_CONFIG_WINDOW_X | XCB_CONFIG_WINDOW_Y |
348 XCB_CONFIG_WINDOW_WIDTH | XCB_CONFIG_WINDOW_HEIGHT |
349 XCB_CONFIG_WINDOW_STACK_MODE;
351 /* Raise the stack window, but keep it below the first floating client
352 * and below the fullscreen client (if any) */
353 Client *first_floating = TAILQ_FIRST(&(container->workspace->floating_clients));
354 if (first_floating != TAILQ_END(&(container->workspace->floating_clients))) {
355 mask |= XCB_CONFIG_WINDOW_SIBLING;
356 values[4] = first_floating->frame;
357 } else if (container->workspace->fullscreen_client != NULL) {
358 mask |= XCB_CONFIG_WINDOW_SIBLING;
359 values[4] = container->workspace->fullscreen_client->frame;
362 xcb_configure_window(conn, stack_win->window, mask, values);
365 /* Prepare the pixmap for usage */
366 cached_pixmap_prepare(conn, &(stack_win->pixmap));
368 /* Render the decorations of all clients */
369 CIRCLEQ_FOREACH(client, &(container->clients), clients) {
370 /* If the client is in fullscreen mode, it does not get reconfigured */
371 if (container->workspace->fullscreen_client == client) {
376 /* Check if we changed client->x or client->y by updating it.
377 * Note the bitwise OR instead of logical OR to force evaluation of both statements */
378 if (client->force_reconfigure |
379 update_if_necessary(&(client->rect.x), container->x) |
380 update_if_necessary(&(client->rect.y), container->y + (decoration_height * num_clients)))
381 reposition_client(conn, client);
383 if (client->force_reconfigure |
384 update_if_necessary(&(client->rect.width), container->width) |
385 update_if_necessary(&(client->rect.height), container->height - (decoration_height * num_clients)))
386 resize_client(conn, client);
388 client->force_reconfigure = false;
390 decorate_window(conn, client, stack_win->pixmap.id, stack_win->pixmap.gc,
391 current_client++ * decoration_height);
394 xcb_copy_area(conn, stack_win->pixmap.id, stack_win->window, stack_win->pixmap.gc,
395 0, 0, 0, 0, stack_win->rect.width, stack_win->rect.height);
399 static void render_bars(xcb_connection_t *conn, Workspace *r_ws, int width, int *height) {
401 SLIST_FOREACH(client, &(r_ws->screen->dock_clients), dock_clients) {
402 LOG("client is at %d, should be at %d\n", client->rect.y, *height);
403 if (client->force_reconfigure |
404 update_if_necessary(&(client->rect.x), 0) |
405 update_if_necessary(&(client->rect.y), *height))
406 reposition_client(conn, client);
408 if (client->force_reconfigure |
409 update_if_necessary(&(client->rect.width), width) |
410 update_if_necessary(&(client->rect.height), client->desired_height))
411 resize_client(conn, client);
413 client->force_reconfigure = false;
414 LOG("desired_height = %d\n", client->desired_height);
415 *height += client->desired_height;
419 static void render_internal_bar(xcb_connection_t *conn, Workspace *r_ws, int width, int height) {
420 LOG("Rendering internal bar\n");
421 i3Font *font = load_font(conn, config.font);
422 i3Screen *screen = r_ws->screen;
423 enum { SET_NORMAL = 0, SET_FOCUSED = 1 };
426 /* Fill the whole bar in black */
427 xcb_change_gc_single(conn, screen->bargc, XCB_GC_FOREGROUND, get_colorpixel(conn, "#000000"));
428 xcb_rectangle_t rect = {0, 0, width, height};
429 xcb_poly_fill_rectangle(conn, screen->bar, screen->bargc, 1, &rect);
432 xcb_change_gc_single(conn, screen->bargc, XCB_GC_FONT, font->id);
435 for (int c = 0; c < 10; c++) {
436 if (workspaces[c].screen != screen)
439 struct Colortriple *color = (screen->current_workspace == c ? &(config.bar.focused) :
440 &(config.bar.unfocused));
442 xcb_draw_rect(conn, screen->bar, screen->bargc, color->border,
443 drawn * height, 1, height - 2, height - 2);
444 xcb_draw_rect(conn, screen->bar, screen->bargc, color->background,
445 drawn * height + 1, 2, height - 4, height - 4);
447 snprintf(label, sizeof(label), "%d", c+1);
448 xcb_change_gc_single(conn, screen->bargc, XCB_GC_FOREGROUND, color->text);
449 xcb_change_gc_single(conn, screen->bargc, XCB_GC_BACKGROUND, color->background);
450 xcb_image_text_8(conn, strlen(label), screen->bar, screen->bargc, drawn * height + 5 /* X */,
451 font->height + 1 /* Y = baseline of font */, label);
455 LOG("done rendering internal\n");
459 * Modifies the event mask of all clients on the given workspace to either ignore or to handle
460 * enter notifies. It is handy to ignore notifies because they will be sent when a window is mapped
461 * under the cursor, thus when the user didn’t enter the window actively at all.
464 void ignore_enter_notify_forall(xcb_connection_t *conn, Workspace *workspace, bool ignore_enter_notify) {
468 LOG("Ignore enter_notify = %d\n", ignore_enter_notify);
471 CIRCLEQ_FOREACH(client, &(workspace->table[cols][rows]->clients), clients) {
472 /* Change event mask for the decorations */
473 values[0] = FRAME_EVENT_MASK;
474 if (ignore_enter_notify)
475 values[0] &= ~(XCB_EVENT_MASK_ENTER_WINDOW);
476 xcb_change_window_attributes(conn, client->frame, XCB_CW_EVENT_MASK, values);
478 /* Change event mask for the child itself */
479 values[0] = CHILD_EVENT_MASK;
480 if (ignore_enter_notify)
481 values[0] &= ~(XCB_EVENT_MASK_ENTER_WINDOW);
482 xcb_change_window_attributes(conn, client->child, XCB_CW_EVENT_MASK, values);
487 * Renders the given workspace on the given screen
490 void render_workspace(xcb_connection_t *conn, i3Screen *screen, Workspace *r_ws) {
491 i3Font *font = load_font(conn, config.font);
492 int width = r_ws->rect.width;
493 int height = r_ws->rect.height;
495 /* Reserve space for dock clients */
497 SLIST_FOREACH(client, &(screen->dock_clients), dock_clients)
498 height -= client->desired_height;
500 /* Space for the internal bar */
501 height -= (font->height + 6);
503 LOG("got %d rows and %d cols\n", r_ws->rows, r_ws->cols);
505 int xoffset[r_ws->rows];
506 int yoffset[r_ws->cols];
507 /* Initialize offsets */
508 for (int cols = 0; cols < r_ws->cols; cols++)
509 yoffset[cols] = r_ws->rect.y;
510 for (int rows = 0; rows < r_ws->rows; rows++)
511 xoffset[rows] = r_ws->rect.x;
513 dump_table(conn, r_ws);
515 ignore_enter_notify_forall(conn, r_ws, true);
517 /* Go through the whole table and render what’s necessary */
519 Container *container = r_ws->table[cols][rows];
520 int single_width = -1, single_height;
523 LOG("container has %d colspan, %d rowspan\n",
524 container->colspan, container->rowspan);
525 LOG("container at %d, %d\n", xoffset[rows], yoffset[cols]);
526 /* Update position of the container */
527 container->row = rows;
528 container->col = cols;
529 container->x = xoffset[rows];
530 container->y = yoffset[cols];
531 container->width = 0;
533 for (int c = 0; c < container->colspan; c++) {
534 if (r_ws->width_factor[cols+c] == 0)
535 container->width += (width / r_ws->cols);
536 else container->width += get_unoccupied_x(r_ws) * r_ws->width_factor[cols+c];
538 if (single_width == -1)
539 single_width = container->width;
542 //if (container->height_factor == 0)
543 container->height = (height / r_ws->rows);
544 //else container->height = get_unoccupied_y(r_ws, cols) * container->height_factor;
545 single_height = container->height;
546 container->height *= container->rowspan;
548 /* Render the container if it is not empty */
549 render_container(conn, container);
551 xoffset[rows] += single_width;
552 yoffset[cols] += single_height;
556 ignore_enter_notify_forall(conn, r_ws, false);
558 render_bars(conn, r_ws, width, &height);
559 render_internal_bar(conn, r_ws, width, font->height + 6);
563 * Renders the whole layout, that is: Go through each screen, each workspace, each container
564 * and render each client. This also renders the bars.
566 * If you don’t need to render *everything*, you should call render_container on the container
567 * you want to refresh.
570 void render_layout(xcb_connection_t *conn) {
573 TAILQ_FOREACH(screen, virtual_screens, screens) {
574 LOG("Rendering screen %d\n", screen->num);
575 render_workspace(conn, screen, &(workspaces[screen->current_workspace]));