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;
26 int min(int a, int b) {
27 return (a < b ? a : b);
30 int max(int a, int b) {
31 return (a > b ? a : b);
35 * Updates *destination with new_value and returns true if it was changed or false
39 bool update_if_necessary(uint32_t *destination, const uint32_t new_value) {
40 uint32_t old_value = *destination;
42 return ((*destination = new_value) != old_value);
46 * The s* functions (safe) are wrappers around malloc, strdup, …, which exits if one of
47 * the called functions returns NULL, meaning that there is no more memory available
50 void *smalloc(size_t size) {
51 void *result = malloc(size);
52 exit_if_null(result, "Error: out of memory (malloc(%zd))\n", size);
56 void *scalloc(size_t size) {
57 void *result = calloc(size, 1);
58 exit_if_null(result, "Error: out of memory (calloc(%zd))\n", size);
62 void *srealloc(void *ptr, size_t size) {
63 void *result = realloc(ptr, size);
64 exit_if_null(result, "Error: out memory (realloc(%zd))\n", size);
68 char *sstrdup(const char *str) {
69 char *result = strdup(str);
70 exit_if_null(result, "Error: out of memory (strdup())\n");
75 * Starts the given application by passing it through a shell. We use double fork
76 * to avoid zombie processes. As the started application’s parent exits (immediately),
77 * the application is reparented to init (process-id 1), which correctly handles
78 * childs, so we don’t have to do it :-).
80 * The shell is determined by looking for the SHELL environment variable. If it
81 * does not exist, /bin/sh is used.
84 void start_application(const char *command) {
85 LOG("executing: %s\n", command);
89 /* Stores the path of the shell */
90 static const char *shell = NULL;
93 if ((shell = getenv("SHELL")) == NULL)
96 /* This is the child */
97 execl(shell, shell, "-c", command, (void*)NULL);
106 * Checks a generic cookie for errors and quits with the given message if there
110 void check_error(xcb_connection_t *conn, xcb_void_cookie_t cookie, char *err_message) {
111 xcb_generic_error_t *error = xcb_request_check(conn, cookie);
113 fprintf(stderr, "ERROR: %s (X error %d)\n", err_message , error->error_code);
114 xcb_disconnect(conn);
120 * Converts the given string to UCS-2 big endian for use with
121 * xcb_image_text_16(). The amount of real glyphs is stored in real_strlen,
122 * a buffer containing the UCS-2 encoded string (16 bit per glyph) is
123 * returned. It has to be freed when done.
126 char *convert_utf8_to_ucs2(char *input, int *real_strlen) {
127 size_t input_size = strlen(input) + 1;
128 /* UCS-2 consumes exactly two bytes for each glyph */
129 int buffer_size = input_size * 2;
131 char *buffer = smalloc(buffer_size);
132 size_t output_size = buffer_size;
133 /* We need to use an additional pointer, because iconv() modifies it */
134 char *output = buffer;
136 /* We convert the input into UCS-2 big endian */
137 if (conversion_descriptor == 0) {
138 conversion_descriptor = iconv_open("UCS-2BE", "UTF-8");
139 if (conversion_descriptor == 0) {
140 fprintf(stderr, "error opening the conversion context\n");
145 /* Get the conversion descriptor back to original state */
146 iconv(conversion_descriptor, NULL, NULL, NULL, NULL);
148 /* Convert our text */
149 int rc = iconv(conversion_descriptor, (void*)&input, &input_size, &output, &output_size);
150 if (rc == (size_t)-1) {
151 perror("Converting to UCS-2 failed");
152 if (real_strlen != NULL)
157 if (real_strlen != NULL)
158 *real_strlen = ((buffer_size - output_size) / 2) - 1;
165 * Returns the client which comes next in focus stack (= was selected before) for
166 * the given container, optionally excluding the given client.
169 Client *get_last_focused_client(xcb_connection_t *conn, Container *container, Client *exclude) {
171 SLIST_FOREACH(current, &(container->workspace->focus_stack), focus_clients)
172 if ((current->container == container) && ((exclude == NULL) || (current != exclude)))
179 * Sets the given client as focused by updating the data structures correctly,
180 * updating the X input focus and finally re-decorating both windows (to signalize
181 * the user the new focus situation)
184 void set_focus(xcb_connection_t *conn, Client *client, bool set_anyways) {
185 /* The dock window cannot be focused, but enter notifies are still handled correctly */
189 /* Store the old client */
190 Client *old_client = SLIST_FIRST(&(c_ws->focus_stack));
192 /* Check if the focus needs to be changed at all */
193 if (!set_anyways && (old_client == client))
196 /* Store current_row/current_col */
197 c_ws->current_row = current_row;
198 c_ws->current_col = current_col;
199 c_ws = client->workspace;
200 ewmh_update_current_desktop();
201 /* Load current_col/current_row if we switch to a client without a container */
202 current_col = c_ws->current_col;
203 current_row = c_ws->current_row;
205 /* Update container */
206 if (client->container != NULL) {
207 client->container->currently_focused = client;
209 current_col = client->container->col;
210 current_row = client->container->row;
214 /* Set focus to the entered window, and flush xcb buffer immediately */
215 xcb_set_input_focus(conn, XCB_INPUT_FOCUS_POINTER_ROOT, client->child, XCB_CURRENT_TIME);
216 ewmh_update_active_window(client->child);
217 //xcb_warp_pointer(conn, XCB_NONE, client->child, 0, 0, 0, 0, 10, 10);
219 if (client->container != NULL) {
220 /* Get the client which was last focused in this particular container, it may be a different
221 one than old_client */
222 Client *last_focused = get_last_focused_client(conn, client->container, NULL);
224 /* In stacking containers, raise the client in respect to the one which was focused before */
225 if ((client->container->mode == MODE_STACK || client->container->mode == MODE_TABBED) &&
226 client->container->workspace->fullscreen_client == NULL) {
227 /* We need to get the client again, this time excluding the current client, because
228 * we might have just gone into stacking mode and need to raise */
229 Client *last_focused = get_last_focused_client(conn, client->container, client);
231 if (last_focused != NULL) {
232 DLOG("raising above frame %p / child %p\n", last_focused->frame, last_focused->child);
233 uint32_t values[] = { last_focused->frame, XCB_STACK_MODE_ABOVE };
234 xcb_configure_window(conn, client->frame, XCB_CONFIG_WINDOW_SIBLING | XCB_CONFIG_WINDOW_STACK_MODE, values);
238 /* If it is the same one as old_client, we save us the unnecessary redecorate */
239 if ((last_focused != NULL) && (last_focused != old_client))
240 redecorate_window(conn, last_focused);
243 /* If the last client was a floating client, we need to go to the next
244 * tiling client in stack and re-decorate it. */
245 if (old_client != NULL && client_is_floating(old_client)) {
246 DLOG("Coming from floating client, searching next tiling...\n");
248 SLIST_FOREACH(current, &(client->workspace->focus_stack), focus_clients) {
249 if (client_is_floating(current))
252 DLOG("Found window: %p / child %p\n", current->frame, current->child);
253 redecorate_window(conn, current);
258 SLIST_REMOVE(&(client->workspace->focus_stack), client, Client, focus_clients);
259 SLIST_INSERT_HEAD(&(client->workspace->focus_stack), client, focus_clients);
261 /* Clear the urgency flag if set (necessary when i3 sets the flag, for
262 * example when automatically putting windows on the workspace of their
264 client->urgent = false;
265 workspace_update_urgent_flag(client->workspace);
267 /* If we’re in stacking mode, this renders the container to update changes in the title
268 bars and to raise the focused client */
269 if ((old_client != NULL) && (old_client != client) && !old_client->dock)
270 redecorate_window(conn, old_client);
272 /* redecorate_window flushes, so we don’t need to */
273 redecorate_window(conn, client);
277 * Called when the user switches to another mode or when the container is
278 * destroyed and thus needs to be cleaned up.
281 void leave_stack_mode(xcb_connection_t *conn, Container *container) {
282 /* When going out of stacking mode, we need to close the window */
283 struct Stack_Window *stack_win = &(container->stack_win);
285 SLIST_REMOVE(&stack_wins, stack_win, Stack_Window, stack_windows);
287 xcb_free_gc(conn, stack_win->pixmap.gc);
288 xcb_free_pixmap(conn, stack_win->pixmap.id);
289 xcb_destroy_window(conn, stack_win->window);
291 stack_win->rect.width = -1;
292 stack_win->rect.height = -1;
296 * Switches the layout of the given container taking care of the necessary house-keeping
299 void switch_layout_mode(xcb_connection_t *conn, Container *container, int mode) {
300 if (mode == MODE_STACK || mode == MODE_TABBED) {
301 /* When we’re already in stacking mode, nothing has to be done */
302 if ((mode == MODE_STACK && container->mode == MODE_STACK) ||
303 (mode == MODE_TABBED && container->mode == MODE_TABBED))
306 if (container->mode == MODE_STACK || container->mode == MODE_TABBED)
309 /* When entering stacking mode, we need to open a window on
310 * which we can draw the title bars of the clients, it has
311 * height 1 because we don’t bother here with calculating the
312 * correct height - it will be adjusted when rendering anyways.
313 * Also, we need to use max(width, 1) because windows cannot
314 * be created with either width == 0 or height == 0. */
315 Rect rect = {container->x, container->y, max(container->width, 1), 1};
320 /* Don’t generate events for our new window, it should *not* be managed */
321 mask |= XCB_CW_OVERRIDE_REDIRECT;
324 /* We want to know when… */
325 mask |= XCB_CW_EVENT_MASK;
326 values[1] = XCB_EVENT_MASK_ENTER_WINDOW | /* …mouse is moved into our window */
327 XCB_EVENT_MASK_BUTTON_PRESS | /* …mouse is pressed */
328 XCB_EVENT_MASK_EXPOSURE; /* …our window needs to be redrawn */
330 struct Stack_Window *stack_win = &(container->stack_win);
331 stack_win->window = create_window(conn, rect, XCB_WINDOW_CLASS_INPUT_OUTPUT, XCB_CURSOR_LEFT_PTR, false, mask, values);
333 stack_win->rect.height = 0;
335 /* Initialize the entry for our cached pixmap. It will be
336 * created as soon as it’s needed (see cached_pixmap_prepare). */
337 memset(&(stack_win->pixmap), 0, sizeof(struct Cached_Pixmap));
338 stack_win->pixmap.referred_rect = &stack_win->rect;
339 stack_win->pixmap.referred_drawable = stack_win->window;
341 stack_win->container = container;
343 SLIST_INSERT_HEAD(&stack_wins, stack_win, stack_windows);
345 if (container->mode == MODE_STACK || container->mode == MODE_TABBED)
346 leave_stack_mode(conn, container);
349 container->mode = mode;
351 /* Force reconfiguration of each client */
354 CIRCLEQ_FOREACH(client, &(container->clients), clients)
355 client->force_reconfigure = true;
359 if (container->currently_focused != NULL) {
360 /* We need to make sure that this client is above *each* of the
361 * other clients in this container */
362 Client *last_focused = get_last_focused_client(conn, container, container->currently_focused);
364 CIRCLEQ_FOREACH(client, &(container->clients), clients) {
365 if (client == container->currently_focused || client == last_focused)
368 DLOG("setting %08x below %08x / %08x\n", client->frame, container->currently_focused->frame);
369 uint32_t values[] = { container->currently_focused->frame, XCB_STACK_MODE_BELOW };
370 xcb_configure_window(conn, client->frame,
371 XCB_CONFIG_WINDOW_SIBLING | XCB_CONFIG_WINDOW_STACK_MODE, values);
374 if (last_focused != NULL) {
375 DLOG("Putting last_focused directly underneath the currently focused\n");
376 uint32_t values[] = { container->currently_focused->frame, XCB_STACK_MODE_BELOW };
377 xcb_configure_window(conn, last_focused->frame,
378 XCB_CONFIG_WINDOW_SIBLING | XCB_CONFIG_WINDOW_STACK_MODE, values);
382 set_focus(conn, container->currently_focused, true);
387 * Gets the first matching client for the given window class/window title.
388 * If the paramater specific is set to a specific client, only this one
392 Client *get_matching_client(xcb_connection_t *conn, const char *window_classtitle,
394 char *to_class, *to_title, *to_title_ucs = NULL;
395 int to_title_ucs_len = 0;
396 Client *matching = NULL;
398 to_class = sstrdup(window_classtitle);
400 /* If a title was specified, split both strings at the slash */
401 if ((to_title = strstr(to_class, "/")) != NULL) {
402 *(to_title++) = '\0';
403 /* Convert to UCS-2 */
404 to_title_ucs = convert_utf8_to_ucs2(to_title, &to_title_ucs_len);
407 /* If we were given a specific client we only check if that one matches */
408 if (specific != NULL) {
409 if (client_matches_class_name(specific, to_class, to_title, to_title_ucs, to_title_ucs_len))
414 DLOG("Getting clients for class \"%s\" / title \"%s\"\n", to_class, to_title);
416 TAILQ_FOREACH(ws, workspaces, workspaces) {
417 if (ws->output == NULL)
421 SLIST_FOREACH(client, &(ws->focus_stack), focus_clients) {
422 DLOG("Checking client with class=%s / %s, name=%s\n", client->window_class_instance,
423 client->window_class_class, client->name);
424 if (!client_matches_class_name(client, to_class, to_title, to_title_ucs, to_title_ucs_len))
440 * Goes through the list of arguments (for exec()) and checks if the given argument
441 * is present. If not, it copies the arguments (because we cannot realloc it) and
442 * appends the given argument.
445 static char **append_argument(char **original, char *argument) {
447 for (num_args = 0; original[num_args] != NULL; num_args++) {
448 DLOG("original argument: \"%s\"\n", original[num_args]);
449 /* If the argument is already present we return the original pointer */
450 if (strcmp(original[num_args], argument) == 0)
453 /* Copy the original array */
454 char **result = smalloc((num_args+2) * sizeof(char*));
455 memcpy(result, original, num_args * sizeof(char*));
456 result[num_args] = argument;
457 result[num_args+1] = NULL;
462 #define y(x, ...) yajl_gen_ ## x (gen, ##__VA_ARGS__)
463 #define ystr(str) yajl_gen_string(gen, (unsigned char*)str, strlen(str))
465 void store_restart_layout() {
466 yajl_gen gen = yajl_gen_alloc(NULL, NULL);
468 dump_node(gen, croot, true);
470 const unsigned char *payload;
472 y(get_buf, &payload, &length);
474 char *globbed = glob_path("~/.i3/_restart.json");
475 int fd = open(globbed, O_WRONLY | O_CREAT | O_TRUNC, S_IRUSR | S_IWUSR);
483 while (written < length) {
484 int n = write(fd, payload + written, length - written);
485 /* TODO: correct error-handling */
491 printf("write == 0?\n");
495 printf("written: %d of %d\n", written, length);
499 printf("layout: %.*s\n", length, payload);
505 * Restart i3 in-place
506 * appends -a to argument list to disable autostart
510 store_restart_layout();
515 LOG("restarting \"%s\"...\n", start_argv[0]);
516 /* make sure -a is in the argument list or append it */
517 start_argv = append_argument(start_argv, "-a");
519 execvp(start_argv[0], start_argv);
525 #if defined(__OpenBSD__)
529 * Find the first occurrence of the byte string s in byte string l.
532 void *memmem(const void *l, size_t l_len, const void *s, size_t s_len) {
533 register char *cur, *last;
534 const char *cl = (const char *)l;
535 const char *cs = (const char *)s;
537 /* we need something to compare */
538 if (l_len == 0 || s_len == 0)
541 /* "s" must be smaller or equal to "l" */
545 /* special case where s_len == 1 */
547 return memchr(l, (int)*cs, l_len);
549 /* the last position where its possible to find "s" in "l" */
550 last = (char *)cl + l_len - s_len;
552 for (cur = (char *)cl; cur <= last; cur++)
553 if (cur[0] == cs[0] && memcmp(cur, cs, s_len) == 0)