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.
16 #if defined(__OpenBSD__)
17 #include <sys/cdefs.h>
24 static iconv_t conversion_descriptor = 0;
25 struct keyvalue_table_head by_parent = TAILQ_HEAD_INITIALIZER(by_parent);
26 struct keyvalue_table_head by_child = TAILQ_HEAD_INITIALIZER(by_child);
28 int min(int a, int b) {
29 return (a < b ? a : b);
32 int max(int a, int b) {
33 return (a > b ? a : b);
37 * Updates *destination with new_value and returns true if it was changed or false
41 bool update_if_necessary(uint32_t *destination, const uint32_t new_value) {
42 uint32_t old_value = *destination;
44 return ((*destination = new_value) != old_value);
48 * The s* functions (safe) are wrappers around malloc, strdup, …, which exits if one of
49 * the called functions returns NULL, meaning that there is no more memory available
52 void *smalloc(size_t size) {
53 void *result = malloc(size);
54 exit_if_null(result, "Error: out of memory (malloc(%zd))\n", size);
58 void *scalloc(size_t size) {
59 void *result = calloc(size, 1);
60 exit_if_null(result, "Error: out of memory (calloc(%zd))\n", size);
64 void *srealloc(void *ptr, size_t size) {
65 void *result = realloc(ptr, size);
66 exit_if_null(result, "Error: out memory (realloc(%zd))\n", size);
70 char *sstrdup(const char *str) {
71 char *result = strdup(str);
72 exit_if_null(result, "Error: out of memory (strdup())\n");
79 * The table_* functions emulate the behaviour of libxcb-wm, which in libxcb 0.3.4 suddenly
83 bool table_put(struct keyvalue_table_head *head, uint32_t key, void *value) {
84 struct keyvalue_element *element = scalloc(sizeof(struct keyvalue_element));
86 element->value = value;
88 TAILQ_INSERT_TAIL(head, element, elements);
92 void *table_remove(struct keyvalue_table_head *head, uint32_t key) {
93 struct keyvalue_element *element;
95 TAILQ_FOREACH(element, head, elements)
96 if (element->key == key) {
97 void *value = element->value;
98 TAILQ_REMOVE(head, element, elements);
106 void *table_get(struct keyvalue_table_head *head, uint32_t key) {
107 struct keyvalue_element *element;
109 TAILQ_FOREACH(element, head, elements)
110 if (element->key == key)
111 return element->value;
117 * Starts the given application by passing it through a shell. We use double fork
118 * to avoid zombie processes. As the started application’s parent exits (immediately),
119 * the application is reparented to init (process-id 1), which correctly handles
120 * childs, so we don’t have to do it :-).
122 * The shell is determined by looking for the SHELL environment variable. If it
123 * does not exist, /bin/sh is used.
126 void start_application(const char *command) {
127 LOG("executing: %s\n", command);
131 /* Stores the path of the shell */
132 static const char *shell = NULL;
135 if ((shell = getenv("SHELL")) == NULL)
138 /* This is the child */
139 execl(shell, shell, "-c", command, (void*)NULL);
148 * Checks a generic cookie for errors and quits with the given message if there
152 void check_error(xcb_connection_t *conn, xcb_void_cookie_t cookie, char *err_message) {
153 xcb_generic_error_t *error = xcb_request_check(conn, cookie);
155 fprintf(stderr, "ERROR: %s (X error %d)\n", err_message , error->error_code);
156 xcb_disconnect(conn);
162 * Converts the given string to UCS-2 big endian for use with
163 * xcb_image_text_16(). The amount of real glyphs is stored in real_strlen,
164 * a buffer containing the UCS-2 encoded string (16 bit per glyph) is
165 * returned. It has to be freed when done.
168 char *convert_utf8_to_ucs2(char *input, int *real_strlen) {
169 size_t input_size = strlen(input) + 1;
170 /* UCS-2 consumes exactly two bytes for each glyph */
171 int buffer_size = input_size * 2;
173 char *buffer = smalloc(buffer_size);
174 size_t output_size = buffer_size;
175 /* We need to use an additional pointer, because iconv() modifies it */
176 char *output = buffer;
178 /* We convert the input into UCS-2 big endian */
179 if (conversion_descriptor == 0) {
180 conversion_descriptor = iconv_open("UCS-2BE", "UTF-8");
181 if (conversion_descriptor == 0) {
182 fprintf(stderr, "error opening the conversion context\n");
187 /* Get the conversion descriptor back to original state */
188 iconv(conversion_descriptor, NULL, NULL, NULL, NULL);
190 /* Convert our text */
191 int rc = iconv(conversion_descriptor, (void*)&input, &input_size, &output, &output_size);
192 if (rc == (size_t)-1) {
193 perror("Converting to UCS-2 failed");
194 if (real_strlen != NULL)
199 if (real_strlen != NULL)
200 *real_strlen = ((buffer_size - output_size) / 2) - 1;
207 * Returns the client which comes next in focus stack (= was selected before) for
208 * the given container, optionally excluding the given client.
211 Client *get_last_focused_client(xcb_connection_t *conn, Container *container, Client *exclude) {
213 SLIST_FOREACH(current, &(container->workspace->focus_stack), focus_clients)
214 if ((current->container == container) && ((exclude == NULL) || (current != exclude)))
221 * Sets the given client as focused by updating the data structures correctly,
222 * updating the X input focus and finally re-decorating both windows (to signalize
223 * the user the new focus situation)
226 void set_focus(xcb_connection_t *conn, Client *client, bool set_anyways) {
227 /* The dock window cannot be focused, but enter notifies are still handled correctly */
231 /* Store the old client */
232 Client *old_client = SLIST_FIRST(&(c_ws->focus_stack));
234 /* Check if the focus needs to be changed at all */
235 if (!set_anyways && (old_client == client))
238 /* Store current_row/current_col */
239 c_ws->current_row = current_row;
240 c_ws->current_col = current_col;
241 c_ws = client->workspace;
242 ewmh_update_current_desktop();
243 /* Load current_col/current_row if we switch to a client without a container */
244 current_col = c_ws->current_col;
245 current_row = c_ws->current_row;
247 /* Update container */
248 if (client->container != NULL) {
249 client->container->currently_focused = client;
251 current_col = client->container->col;
252 current_row = client->container->row;
256 /* Set focus to the entered window, and flush xcb buffer immediately */
257 xcb_set_input_focus(conn, XCB_INPUT_FOCUS_POINTER_ROOT, client->child, XCB_CURRENT_TIME);
258 ewmh_update_active_window(client->child);
259 //xcb_warp_pointer(conn, XCB_NONE, client->child, 0, 0, 0, 0, 10, 10);
261 if (client->container != NULL) {
262 /* Get the client which was last focused in this particular container, it may be a different
263 one than old_client */
264 Client *last_focused = get_last_focused_client(conn, client->container, NULL);
266 /* In stacking containers, raise the client in respect to the one which was focused before */
267 if ((client->container->mode == MODE_STACK || client->container->mode == MODE_TABBED) &&
268 client->container->workspace->fullscreen_client == NULL) {
269 /* We need to get the client again, this time excluding the current client, because
270 * we might have just gone into stacking mode and need to raise */
271 Client *last_focused = get_last_focused_client(conn, client->container, client);
273 if (last_focused != NULL) {
274 DLOG("raising above frame %p / child %p\n", last_focused->frame, last_focused->child);
275 uint32_t values[] = { last_focused->frame, XCB_STACK_MODE_ABOVE };
276 xcb_configure_window(conn, client->frame, XCB_CONFIG_WINDOW_SIBLING | XCB_CONFIG_WINDOW_STACK_MODE, values);
280 /* If it is the same one as old_client, we save us the unnecessary redecorate */
281 if ((last_focused != NULL) && (last_focused != old_client))
282 redecorate_window(conn, last_focused);
285 /* If the last client was a floating client, we need to go to the next
286 * tiling client in stack and re-decorate it. */
287 if (old_client != NULL && client_is_floating(old_client)) {
288 DLOG("Coming from floating client, searching next tiling...\n");
290 SLIST_FOREACH(current, &(client->workspace->focus_stack), focus_clients) {
291 if (client_is_floating(current))
294 DLOG("Found window: %p / child %p\n", current->frame, current->child);
295 redecorate_window(conn, current);
300 SLIST_REMOVE(&(client->workspace->focus_stack), client, Client, focus_clients);
301 SLIST_INSERT_HEAD(&(client->workspace->focus_stack), client, focus_clients);
303 /* Clear the urgency flag if set (necessary when i3 sets the flag, for
304 * example when automatically putting windows on the workspace of their
306 client->urgent = false;
307 workspace_update_urgent_flag(client->workspace);
309 /* If we’re in stacking mode, this renders the container to update changes in the title
310 bars and to raise the focused client */
311 if ((old_client != NULL) && (old_client != client) && !old_client->dock)
312 redecorate_window(conn, old_client);
314 /* redecorate_window flushes, so we don’t need to */
315 redecorate_window(conn, client);
319 * Called when the user switches to another mode or when the container is
320 * destroyed and thus needs to be cleaned up.
323 void leave_stack_mode(xcb_connection_t *conn, Container *container) {
324 /* When going out of stacking mode, we need to close the window */
325 struct Stack_Window *stack_win = &(container->stack_win);
327 SLIST_REMOVE(&stack_wins, stack_win, Stack_Window, stack_windows);
329 xcb_free_gc(conn, stack_win->pixmap.gc);
330 xcb_free_pixmap(conn, stack_win->pixmap.id);
331 xcb_destroy_window(conn, stack_win->window);
333 stack_win->rect.width = -1;
334 stack_win->rect.height = -1;
338 * Switches the layout of the given container taking care of the necessary house-keeping
341 void switch_layout_mode(xcb_connection_t *conn, Container *container, int mode) {
342 if (mode == MODE_STACK || mode == MODE_TABBED) {
343 /* When we’re already in stacking mode, nothing has to be done */
344 if ((mode == MODE_STACK && container->mode == MODE_STACK) ||
345 (mode == MODE_TABBED && container->mode == MODE_TABBED))
348 if (container->mode == MODE_STACK || container->mode == MODE_TABBED)
351 /* When entering stacking mode, we need to open a window on
352 * which we can draw the title bars of the clients, it has
353 * height 1 because we don’t bother here with calculating the
354 * correct height - it will be adjusted when rendering anyways.
355 * Also, we need to use max(width, 1) because windows cannot
356 * be created with either width == 0 or height == 0. */
357 Rect rect = {container->x, container->y, max(container->width, 1), 1};
362 /* Don’t generate events for our new window, it should *not* be managed */
363 mask |= XCB_CW_OVERRIDE_REDIRECT;
366 /* We want to know when… */
367 mask |= XCB_CW_EVENT_MASK;
368 values[1] = XCB_EVENT_MASK_ENTER_WINDOW | /* …mouse is moved into our window */
369 XCB_EVENT_MASK_BUTTON_PRESS | /* …mouse is pressed */
370 XCB_EVENT_MASK_EXPOSURE; /* …our window needs to be redrawn */
372 struct Stack_Window *stack_win = &(container->stack_win);
373 stack_win->window = create_window(conn, rect, XCB_WINDOW_CLASS_INPUT_OUTPUT, XCB_CURSOR_LEFT_PTR, false, mask, values);
375 stack_win->rect.height = 0;
377 /* Initialize the entry for our cached pixmap. It will be
378 * created as soon as it’s needed (see cached_pixmap_prepare). */
379 memset(&(stack_win->pixmap), 0, sizeof(struct Cached_Pixmap));
380 stack_win->pixmap.referred_rect = &stack_win->rect;
381 stack_win->pixmap.referred_drawable = stack_win->window;
383 stack_win->container = container;
385 SLIST_INSERT_HEAD(&stack_wins, stack_win, stack_windows);
387 if (container->mode == MODE_STACK || container->mode == MODE_TABBED)
388 leave_stack_mode(conn, container);
391 container->mode = mode;
393 /* Force reconfiguration of each client */
396 CIRCLEQ_FOREACH(client, &(container->clients), clients)
397 client->force_reconfigure = true;
401 if (container->currently_focused != NULL) {
402 /* We need to make sure that this client is above *each* of the
403 * other clients in this container */
404 Client *last_focused = get_last_focused_client(conn, container, container->currently_focused);
406 CIRCLEQ_FOREACH(client, &(container->clients), clients) {
407 if (client == container->currently_focused || client == last_focused)
410 DLOG("setting %08x below %08x / %08x\n", client->frame, container->currently_focused->frame);
411 uint32_t values[] = { container->currently_focused->frame, XCB_STACK_MODE_BELOW };
412 xcb_configure_window(conn, client->frame,
413 XCB_CONFIG_WINDOW_SIBLING | XCB_CONFIG_WINDOW_STACK_MODE, values);
416 if (last_focused != NULL) {
417 DLOG("Putting last_focused directly underneath the currently focused\n");
418 uint32_t values[] = { container->currently_focused->frame, XCB_STACK_MODE_BELOW };
419 xcb_configure_window(conn, last_focused->frame,
420 XCB_CONFIG_WINDOW_SIBLING | XCB_CONFIG_WINDOW_STACK_MODE, values);
424 set_focus(conn, container->currently_focused, true);
429 * Gets the first matching client for the given window class/window title.
430 * If the paramater specific is set to a specific client, only this one
434 Client *get_matching_client(xcb_connection_t *conn, const char *window_classtitle,
436 char *to_class, *to_title, *to_title_ucs = NULL;
437 int to_title_ucs_len = 0;
438 Client *matching = NULL;
440 to_class = sstrdup(window_classtitle);
442 /* If a title was specified, split both strings at the slash */
443 if ((to_title = strstr(to_class, "/")) != NULL) {
444 *(to_title++) = '\0';
445 /* Convert to UCS-2 */
446 to_title_ucs = convert_utf8_to_ucs2(to_title, &to_title_ucs_len);
449 /* If we were given a specific client we only check if that one matches */
450 if (specific != NULL) {
451 if (client_matches_class_name(specific, to_class, to_title, to_title_ucs, to_title_ucs_len))
456 DLOG("Getting clients for class \"%s\" / title \"%s\"\n", to_class, to_title);
458 TAILQ_FOREACH(ws, workspaces, workspaces) {
459 if (ws->output == NULL)
463 SLIST_FOREACH(client, &(ws->focus_stack), focus_clients) {
464 DLOG("Checking client with class=%s / %s, name=%s\n", client->window_class_instance,
465 client->window_class_class, client->name);
466 if (!client_matches_class_name(client, to_class, to_title, to_title_ucs, to_title_ucs_len))
482 * Goes through the list of arguments (for exec()) and checks if the given argument
483 * is present. If not, it copies the arguments (because we cannot realloc it) and
484 * appends the given argument.
487 static char **append_argument(char **original, char *argument) {
489 for (num_args = 0; original[num_args] != NULL; num_args++) {
490 DLOG("original argument: \"%s\"\n", original[num_args]);
491 /* If the argument is already present we return the original pointer */
492 if (strcmp(original[num_args], argument) == 0)
495 /* Copy the original array */
496 char **result = smalloc((num_args+2) * sizeof(char*));
497 memcpy(result, original, num_args * sizeof(char*));
498 result[num_args] = argument;
499 result[num_args+1] = NULL;
504 #define y(x, ...) yajl_gen_ ## x (gen, ##__VA_ARGS__)
505 #define ystr(str) yajl_gen_string(gen, (unsigned char*)str, strlen(str))
507 void store_restart_layout() {
508 yajl_gen gen = yajl_gen_alloc(NULL, NULL);
510 dump_node(gen, croot, true);
512 const unsigned char *payload;
514 y(get_buf, &payload, &length);
516 char *globbed = glob_path("~/.i3/_restart.json");
517 int fd = open(globbed, O_WRONLY | O_CREAT | O_TRUNC, S_IRUSR | S_IWUSR);
525 while (written < length) {
526 int n = write(fd, payload + written, length - written);
527 /* TODO: correct error-handling */
533 printf("write == 0?\n");
537 printf("written: %d of %d\n", written, length);
541 printf("layout: %.*s\n", length, payload);
547 * Restart i3 in-place
548 * appends -a to argument list to disable autostart
552 store_restart_layout();
557 LOG("restarting \"%s\"...\n", start_argv[0]);
558 /* make sure -a is in the argument list or append it */
559 start_argv = append_argument(start_argv, "-a");
561 execvp(start_argv[0], start_argv);
567 #if defined(__OpenBSD__)
571 * Find the first occurrence of the byte string s in byte string l.
574 void *memmem(const void *l, size_t l_len, const void *s, size_t s_len) {
575 register char *cur, *last;
576 const char *cl = (const char *)l;
577 const char *cs = (const char *)s;
579 /* we need something to compare */
580 if (l_len == 0 || s_len == 0)
583 /* "s" must be smaller or equal to "l" */
587 /* special case where s_len == 1 */
589 return memchr(l, (int)*cs, l_len);
591 /* the last position where its possible to find "s" in "l" */
592 last = (char *)cl + l_len - s_len;
594 for (cur = (char *)cl; cur <= last; cur++)
595 if (cur[0] == cs[0] && memcmp(cur, cs, s_len) == 0)