4 * i3 - an improved dynamic tiling window manager
6 * © 2009 Michael Stapelberg and contributors
8 * See file LICENSE for license information.
10 * util.c: Utility functions, which can be useful everywhere.
22 #include <xcb/xcb_icccm.h>
32 static iconv_t conversion_descriptor = 0;
33 struct keyvalue_table_head by_parent = TAILQ_HEAD_INITIALIZER(by_parent);
34 struct keyvalue_table_head by_child = TAILQ_HEAD_INITIALIZER(by_child);
36 int min(int a, int b) {
37 return (a < b ? a : b);
40 int max(int a, int b) {
41 return (a > b ? a : b);
45 * Logs the given message to stdout while prefixing the current time to it.
46 * This is to be called by LOG() which includes filename/linenumber
49 void slog(char *fmt, ...) {
54 /* Get current time */
55 time_t t = time(NULL);
56 /* Convert time to local time (determined by the locale) */
57 struct tm *tmp = localtime(&t);
58 /* Generate time prefix */
59 strftime(timebuf, sizeof(timebuf), "%x %X - ", tmp);
60 printf("%s", timebuf);
66 * Prints the message (see printf()) to stderr, then exits the program.
69 void die(char *fmt, ...) {
73 vfprintf(stderr, fmt, args);
80 * The s* functions (safe) are wrappers around malloc, strdup, …, which exits if one of
81 * the called functions returns NULL, meaning that there is no more memory available
84 void *smalloc(size_t size) {
85 void *result = malloc(size);
86 exit_if_null(result, "Too less memory for malloc(%d)\n", size);
90 void *scalloc(size_t size) {
91 void *result = calloc(size, 1);
92 exit_if_null(result, "Too less memory for calloc(%d)\n", size);
96 char *sstrdup(const char *str) {
97 char *result = strdup(str);
98 exit_if_null(result, "Too less memory for strdup()\n");
103 * The table_* functions emulate the behaviour of libxcb-wm, which in libxcb 0.3.4 suddenly
107 bool table_put(struct keyvalue_table_head *head, uint32_t key, void *value) {
108 struct keyvalue_element *element = scalloc(sizeof(struct keyvalue_element));
110 element->value = value;
112 TAILQ_INSERT_TAIL(head, element, elements);
116 void *table_remove(struct keyvalue_table_head *head, uint32_t key) {
117 struct keyvalue_element *element;
119 TAILQ_FOREACH(element, head, elements)
120 if (element->key == key) {
121 void *value = element->value;
122 TAILQ_REMOVE(head, element, elements);
130 void *table_get(struct keyvalue_table_head *head, uint32_t key) {
131 struct keyvalue_element *element;
133 TAILQ_FOREACH(element, head, elements)
134 if (element->key == key)
135 return element->value;
141 * Starts the given application by passing it through a shell. We use double fork
142 * to avoid zombie processes. As the started application’s parent exits (immediately),
143 * the application is reparented to init (process-id 1), which correctly handles
144 * childs, so we don’t have to do it :-).
146 * The shell is determined by looking for the SHELL environment variable. If it
147 * does not exist, /bin/sh is used.
150 void start_application(const char *command) {
154 /* Stores the path of the shell */
155 static const char *shell = NULL;
158 if ((shell = getenv("SHELL")) == NULL)
161 /* This is the child */
162 execl(shell, shell, "-c", command, NULL);
171 * Checks a generic cookie for errors and quits with the given message if there
175 void check_error(xcb_connection_t *conn, xcb_void_cookie_t cookie, char *err_message) {
176 xcb_generic_error_t *error = xcb_request_check(conn, cookie);
178 fprintf(stderr, "ERROR: %s : %d\n", err_message , error->error_code);
179 xcb_disconnect(conn);
185 * Converts the given string to UCS-2 big endian for use with
186 * xcb_image_text_16(). The amount of real glyphs is stored in real_strlen,
187 * a buffer containing the UCS-2 encoded string (16 bit per glyph) is
188 * returned. It has to be freed when done.
191 char *convert_utf8_to_ucs2(char *input, int *real_strlen) {
192 size_t input_size = strlen(input) + 1;
193 /* UCS-2 consumes exactly two bytes for each glyph */
194 int buffer_size = input_size * 2;
196 char *buffer = smalloc(buffer_size);
197 size_t output_size = buffer_size;
198 /* We need to use an additional pointer, because iconv() modifies it */
199 char *output = buffer;
201 /* We convert the input into UCS-2 big endian */
202 if (conversion_descriptor == 0) {
203 conversion_descriptor = iconv_open("UCS-2BE", "UTF-8");
204 if (conversion_descriptor == 0) {
205 fprintf(stderr, "error opening the conversion context\n");
210 /* Get the conversion descriptor back to original state */
211 iconv(conversion_descriptor, NULL, NULL, NULL, NULL);
213 /* Convert our text */
214 int rc = iconv(conversion_descriptor, (void*)&input, &input_size, &output, &output_size);
215 if (rc == (size_t)-1) {
216 perror("Converting to UCS-2 failed");
217 if (real_strlen != NULL)
222 if (real_strlen != NULL)
223 *real_strlen = ((buffer_size - output_size) / 2) - 1;
229 * Returns the client which comes next in focus stack (= was selected before) for
230 * the given container, optionally excluding the given client.
233 Client *get_last_focused_client(xcb_connection_t *conn, Container *container, Client *exclude) {
235 SLIST_FOREACH(current, &(container->workspace->focus_stack), focus_clients)
236 if ((current->container == container) && ((exclude == NULL) || (current != exclude)))
242 * Unmaps all clients (and stack windows) of the given workspace.
244 * This needs to be called separately when temporarily rendering
245 * a workspace which is not the active workspace to force
246 * reconfiguration of all clients, like in src/xinerama.c when
247 * re-assigning a workspace to another screen.
250 void unmap_workspace(xcb_connection_t *conn, Workspace *u_ws) {
252 struct Stack_Window *stack_win;
254 /* Ignore notify events because they would cause focus to be changed */
255 ignore_enter_notify_forall(conn, u_ws, true);
257 /* Unmap all clients of the given workspace */
258 int unmapped_clients = 0;
260 CIRCLEQ_FOREACH(client, &(u_ws->table[cols][rows]->clients), clients) {
261 xcb_unmap_window(conn, client->frame);
265 /* To find floating clients, we traverse the focus stack */
266 SLIST_FOREACH(client, &(u_ws->focus_stack), focus_clients) {
267 if (!client_is_floating(client))
270 xcb_unmap_window(conn, client->frame);
274 /* If we did not unmap any clients, the workspace is empty and we can destroy it, at least
275 * if it is not the current workspace. */
276 if (unmapped_clients == 0 && u_ws != c_ws) {
277 /* Re-assign the workspace of all dock clients which use this workspace */
279 LOG("workspace %p is empty\n", u_ws);
280 SLIST_FOREACH(dock, &(u_ws->screen->dock_clients), dock_clients) {
281 if (dock->workspace != u_ws)
284 LOG("Re-assigning dock client to c_ws (%p)\n", c_ws);
285 dock->workspace = c_ws;
290 /* Unmap the stack windows on the given workspace, if any */
291 SLIST_FOREACH(stack_win, &stack_wins, stack_windows)
292 if (stack_win->container->workspace == u_ws)
293 xcb_unmap_window(conn, stack_win->window);
295 ignore_enter_notify_forall(conn, u_ws, false);
299 * Sets the given client as focused by updating the data structures correctly,
300 * updating the X input focus and finally re-decorating both windows (to signalize
301 * the user the new focus situation)
304 void set_focus(xcb_connection_t *conn, Client *client, bool set_anyways) {
305 /* The dock window cannot be focused, but enter notifies are still handled correctly */
309 /* Store the old client */
310 Client *old_client = SLIST_FIRST(&(c_ws->focus_stack));
312 /* Check if the focus needs to be changed at all */
313 if (!set_anyways && (old_client == client)) {
314 LOG("old_client == client, not changing focus\n");
318 /* Store current_row/current_col */
319 c_ws->current_row = current_row;
320 c_ws->current_col = current_col;
321 c_ws = client->workspace;
323 /* Update container */
324 if (client->container != NULL) {
325 client->container->currently_focused = client;
327 current_col = client->container->col;
328 current_row = client->container->row;
331 LOG("set_focus(frame %08x, child %08x, name %s)\n", client->frame, client->child, client->name);
332 /* Set focus to the entered window, and flush xcb buffer immediately */
333 xcb_set_input_focus(conn, XCB_INPUT_FOCUS_POINTER_ROOT, client->child, XCB_CURRENT_TIME);
334 //xcb_warp_pointer(conn, XCB_NONE, client->child, 0, 0, 0, 0, 10, 10);
336 if (client->container != NULL) {
337 /* Get the client which was last focused in this particular container, it may be a different
338 one than old_client */
339 Client *last_focused = get_last_focused_client(conn, client->container, NULL);
341 /* In stacking containers, raise the client in respect to the one which was focused before */
342 if (client->container->mode == MODE_STACK && client->container->workspace->fullscreen_client == NULL) {
343 /* We need to get the client again, this time excluding the current client, because
344 * we might have just gone into stacking mode and need to raise */
345 Client *last_focused = get_last_focused_client(conn, client->container, client);
347 if (last_focused != NULL) {
348 LOG("raising above frame %p / child %p\n", last_focused->frame, last_focused->child);
349 uint32_t values[] = { last_focused->frame, XCB_STACK_MODE_ABOVE };
350 xcb_configure_window(conn, client->frame, XCB_CONFIG_WINDOW_SIBLING | XCB_CONFIG_WINDOW_STACK_MODE, values);
354 /* If it is the same one as old_client, we save us the unnecessary redecorate */
355 if ((last_focused != NULL) && (last_focused != old_client))
356 redecorate_window(conn, last_focused);
359 /* If we’re in stacking mode, this renders the container to update changes in the title
360 bars and to raise the focused client */
361 if ((old_client != NULL) && (old_client != client) && !old_client->dock)
362 redecorate_window(conn, old_client);
364 SLIST_REMOVE(&(client->workspace->focus_stack), client, Client, focus_clients);
365 SLIST_INSERT_HEAD(&(client->workspace->focus_stack), client, focus_clients);
367 /* redecorate_window flushes, so we don’t need to */
368 redecorate_window(conn, client);
372 * Called when the user switches to another mode or when the container is
373 * destroyed and thus needs to be cleaned up.
376 void leave_stack_mode(xcb_connection_t *conn, Container *container) {
377 /* When going out of stacking mode, we need to close the window */
378 struct Stack_Window *stack_win = &(container->stack_win);
380 SLIST_REMOVE(&stack_wins, stack_win, Stack_Window, stack_windows);
382 xcb_free_gc(conn, stack_win->gc);
383 xcb_destroy_window(conn, stack_win->window);
385 stack_win->rect.width = -1;
386 stack_win->rect.height = -1;
390 * Switches the layout of the given container taking care of the necessary house-keeping
393 void switch_layout_mode(xcb_connection_t *conn, Container *container, int mode) {
394 if (mode == MODE_STACK) {
395 /* When we’re already in stacking mode, nothing has to be done */
396 if (container->mode == MODE_STACK)
399 /* When entering stacking mode, we need to open a window on which we can draw the
400 title bars of the clients, it has height 1 because we don’t bother here with
401 calculating the correct height - it will be adjusted when rendering anyways. */
402 Rect rect = {container->x, container->y, container->width, 1};
407 /* Don’t generate events for our new window, it should *not* be managed */
408 mask |= XCB_CW_OVERRIDE_REDIRECT;
411 /* We want to know when… */
412 mask |= XCB_CW_EVENT_MASK;
413 values[1] = XCB_EVENT_MASK_ENTER_WINDOW | /* …mouse is moved into our window */
414 XCB_EVENT_MASK_BUTTON_PRESS | /* …mouse is pressed */
415 XCB_EVENT_MASK_EXPOSURE; /* …our window needs to be redrawn */
417 struct Stack_Window *stack_win = &(container->stack_win);
418 stack_win->window = create_window(conn, rect, XCB_WINDOW_CLASS_INPUT_OUTPUT, XCB_CURSOR_LEFT_PTR, mask, values);
420 /* Generate a graphics context for the titlebar */
421 stack_win->gc = xcb_generate_id(conn);
422 xcb_create_gc(conn, stack_win->gc, stack_win->window, 0, 0);
424 stack_win->container = container;
426 SLIST_INSERT_HEAD(&stack_wins, stack_win, stack_windows);
428 if (container->mode == MODE_STACK)
429 leave_stack_mode(conn, container);
431 container->mode = mode;
433 /* Force reconfiguration of each client */
436 CIRCLEQ_FOREACH(client, &(container->clients), clients)
437 client->force_reconfigure = true;
441 if (container->currently_focused != NULL) {
442 /* We need to make sure that this client is above *each* of the
443 * other clients in this container */
444 Client *last_focused = get_last_focused_client(conn, container, container->currently_focused);
446 CIRCLEQ_FOREACH(client, &(container->clients), clients) {
447 if (client == container->currently_focused || client == last_focused)
450 LOG("setting %08x below %08x / %08x\n", client->frame, container->currently_focused->frame);
451 uint32_t values[] = { container->currently_focused->frame, XCB_STACK_MODE_BELOW };
452 xcb_configure_window(conn, client->frame,
453 XCB_CONFIG_WINDOW_SIBLING | XCB_CONFIG_WINDOW_STACK_MODE, values);
456 if (last_focused != NULL) {
457 LOG("Putting last_focused directly underneath the currently focused\n");
458 uint32_t values[] = { container->currently_focused->frame, XCB_STACK_MODE_BELOW };
459 xcb_configure_window(conn, last_focused->frame,
460 XCB_CONFIG_WINDOW_SIBLING | XCB_CONFIG_WINDOW_STACK_MODE, values);
464 set_focus(conn, container->currently_focused, true);
469 * Gets the first matching client for the given window class/window title.
470 * If the paramater specific is set to a specific client, only this one
474 Client *get_matching_client(xcb_connection_t *conn, const char *window_classtitle,
476 char *to_class, *to_title, *to_title_ucs = NULL;
477 int to_title_ucs_len = 0;
478 Client *matching = NULL;
480 to_class = sstrdup(window_classtitle);
482 /* If a title was specified, split both strings at the slash */
483 if ((to_title = strstr(to_class, "/")) != NULL) {
484 *(to_title++) = '\0';
485 /* Convert to UCS-2 */
486 to_title_ucs = convert_utf8_to_ucs2(to_title, &to_title_ucs_len);
489 /* If we were given a specific client we only check if that one matches */
490 if (specific != NULL) {
491 if (client_matches_class_name(specific, to_class, to_title, to_title_ucs, to_title_ucs_len))
496 LOG("Getting clients for class \"%s\" / title \"%s\"\n", to_class, to_title);
497 for (int workspace = 0; workspace < 10; workspace++) {
498 if (workspaces[workspace].screen == NULL)
502 SLIST_FOREACH(client, &(workspaces[workspace].focus_stack), focus_clients) {
503 LOG("Checking client with class=%s, name=%s\n", client->window_class, client->name);
504 if (!client_matches_class_name(client, to_class, to_title, to_title_ucs, to_title_ucs_len))