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);
34 bool rect_contains(Rect rect, uint32_t x, uint32_t y) {
35 return (x >= rect.x &&
36 x <= (rect.x + rect.width) &&
38 y <= (rect.y + rect.height));
41 Rect rect_add(Rect a, Rect b) {
42 return (Rect){a.x + b.x,
49 * Updates *destination with new_value and returns true if it was changed or false
53 bool update_if_necessary(uint32_t *destination, const uint32_t new_value) {
54 uint32_t old_value = *destination;
56 return ((*destination = new_value) != old_value);
60 * The s* functions (safe) are wrappers around malloc, strdup, …, which exits if one of
61 * the called functions returns NULL, meaning that there is no more memory available
64 void *smalloc(size_t size) {
65 void *result = malloc(size);
66 exit_if_null(result, "Error: out of memory (malloc(%zd))\n", size);
70 void *scalloc(size_t size) {
71 void *result = calloc(size, 1);
72 exit_if_null(result, "Error: out of memory (calloc(%zd))\n", size);
76 void *srealloc(void *ptr, size_t size) {
77 void *result = realloc(ptr, size);
78 exit_if_null(result, "Error: out memory (realloc(%zd))\n", size);
82 char *sstrdup(const char *str) {
83 char *result = strdup(str);
84 exit_if_null(result, "Error: out of memory (strdup())\n");
89 * Starts the given application by passing it through a shell. We use double fork
90 * to avoid zombie processes. As the started application’s parent exits (immediately),
91 * the application is reparented to init (process-id 1), which correctly handles
92 * childs, so we don’t have to do it :-).
94 * The shell is determined by looking for the SHELL environment variable. If it
95 * does not exist, /bin/sh is used.
98 void start_application(const char *command) {
99 LOG("executing: %s\n", command);
103 /* Stores the path of the shell */
104 static const char *shell = NULL;
107 if ((shell = getenv("SHELL")) == NULL)
110 /* This is the child */
111 execl(shell, shell, "-c", command, (void*)NULL);
120 * Checks a generic cookie for errors and quits with the given message if there
124 void check_error(xcb_connection_t *conn, xcb_void_cookie_t cookie, char *err_message) {
125 xcb_generic_error_t *error = xcb_request_check(conn, cookie);
127 fprintf(stderr, "ERROR: %s (X error %d)\n", err_message , error->error_code);
128 xcb_disconnect(conn);
134 * Converts the given string to UCS-2 big endian for use with
135 * xcb_image_text_16(). The amount of real glyphs is stored in real_strlen,
136 * a buffer containing the UCS-2 encoded string (16 bit per glyph) is
137 * returned. It has to be freed when done.
140 char *convert_utf8_to_ucs2(char *input, int *real_strlen) {
141 size_t input_size = strlen(input) + 1;
142 /* UCS-2 consumes exactly two bytes for each glyph */
143 int buffer_size = input_size * 2;
145 char *buffer = smalloc(buffer_size);
146 size_t output_size = buffer_size;
147 /* We need to use an additional pointer, because iconv() modifies it */
148 char *output = buffer;
150 /* We convert the input into UCS-2 big endian */
151 if (conversion_descriptor == 0) {
152 conversion_descriptor = iconv_open("UCS-2BE", "UTF-8");
153 if (conversion_descriptor == 0) {
154 fprintf(stderr, "error opening the conversion context\n");
159 /* Get the conversion descriptor back to original state */
160 iconv(conversion_descriptor, NULL, NULL, NULL, NULL);
162 /* Convert our text */
163 int rc = iconv(conversion_descriptor, (void*)&input, &input_size, &output, &output_size);
164 if (rc == (size_t)-1) {
165 perror("Converting to UCS-2 failed");
166 if (real_strlen != NULL)
171 if (real_strlen != NULL)
172 *real_strlen = ((buffer_size - output_size) / 2) - 1;
179 * Returns the client which comes next in focus stack (= was selected before) for
180 * the given container, optionally excluding the given client.
183 Client *get_last_focused_client(xcb_connection_t *conn, Container *container, Client *exclude) {
185 SLIST_FOREACH(current, &(container->workspace->focus_stack), focus_clients)
186 if ((current->container == container) && ((exclude == NULL) || (current != exclude)))
193 * Sets the given client as focused by updating the data structures correctly,
194 * updating the X input focus and finally re-decorating both windows (to signalize
195 * the user the new focus situation)
198 void set_focus(xcb_connection_t *conn, Client *client, bool set_anyways) {
199 /* The dock window cannot be focused, but enter notifies are still handled correctly */
203 /* Store the old client */
204 Client *old_client = SLIST_FIRST(&(c_ws->focus_stack));
206 /* Check if the focus needs to be changed at all */
207 if (!set_anyways && (old_client == client))
210 /* Store current_row/current_col */
211 c_ws->current_row = current_row;
212 c_ws->current_col = current_col;
213 c_ws = client->workspace;
214 ewmh_update_current_desktop();
215 /* Load current_col/current_row if we switch to a client without a container */
216 current_col = c_ws->current_col;
217 current_row = c_ws->current_row;
219 /* Update container */
220 if (client->container != NULL) {
221 client->container->currently_focused = client;
223 current_col = client->container->col;
224 current_row = client->container->row;
228 /* Set focus to the entered window, and flush xcb buffer immediately */
229 xcb_set_input_focus(conn, XCB_INPUT_FOCUS_POINTER_ROOT, client->child, XCB_CURRENT_TIME);
230 ewmh_update_active_window(client->child);
231 //xcb_warp_pointer(conn, XCB_NONE, client->child, 0, 0, 0, 0, 10, 10);
233 if (client->container != NULL) {
234 /* Get the client which was last focused in this particular container, it may be a different
235 one than old_client */
236 Client *last_focused = get_last_focused_client(conn, client->container, NULL);
238 /* In stacking containers, raise the client in respect to the one which was focused before */
239 if ((client->container->mode == MODE_STACK || client->container->mode == MODE_TABBED) &&
240 client->container->workspace->fullscreen_client == NULL) {
241 /* We need to get the client again, this time excluding the current client, because
242 * we might have just gone into stacking mode and need to raise */
243 Client *last_focused = get_last_focused_client(conn, client->container, client);
245 if (last_focused != NULL) {
246 DLOG("raising above frame %p / child %p\n", last_focused->frame, last_focused->child);
247 uint32_t values[] = { last_focused->frame, XCB_STACK_MODE_ABOVE };
248 xcb_configure_window(conn, client->frame, XCB_CONFIG_WINDOW_SIBLING | XCB_CONFIG_WINDOW_STACK_MODE, values);
252 /* If it is the same one as old_client, we save us the unnecessary redecorate */
253 if ((last_focused != NULL) && (last_focused != old_client))
254 redecorate_window(conn, last_focused);
257 /* If the last client was a floating client, we need to go to the next
258 * tiling client in stack and re-decorate it. */
259 if (old_client != NULL && client_is_floating(old_client)) {
260 DLOG("Coming from floating client, searching next tiling...\n");
262 SLIST_FOREACH(current, &(client->workspace->focus_stack), focus_clients) {
263 if (client_is_floating(current))
266 DLOG("Found window: %p / child %p\n", current->frame, current->child);
267 redecorate_window(conn, current);
272 SLIST_REMOVE(&(client->workspace->focus_stack), client, Client, focus_clients);
273 SLIST_INSERT_HEAD(&(client->workspace->focus_stack), client, focus_clients);
275 /* Clear the urgency flag if set (necessary when i3 sets the flag, for
276 * example when automatically putting windows on the workspace of their
278 client->urgent = false;
279 workspace_update_urgent_flag(client->workspace);
281 /* If we’re in stacking mode, this renders the container to update changes in the title
282 bars and to raise the focused client */
283 if ((old_client != NULL) && (old_client != client) && !old_client->dock)
284 redecorate_window(conn, old_client);
286 /* redecorate_window flushes, so we don’t need to */
287 redecorate_window(conn, client);
291 * Called when the user switches to another mode or when the container is
292 * destroyed and thus needs to be cleaned up.
295 void leave_stack_mode(xcb_connection_t *conn, Container *container) {
296 /* When going out of stacking mode, we need to close the window */
297 struct Stack_Window *stack_win = &(container->stack_win);
299 SLIST_REMOVE(&stack_wins, stack_win, Stack_Window, stack_windows);
301 xcb_free_gc(conn, stack_win->pixmap.gc);
302 xcb_free_pixmap(conn, stack_win->pixmap.id);
303 xcb_destroy_window(conn, stack_win->window);
305 stack_win->rect.width = -1;
306 stack_win->rect.height = -1;
310 * Switches the layout of the given container taking care of the necessary house-keeping
313 void switch_layout_mode(xcb_connection_t *conn, Container *container, int mode) {
314 if (mode == MODE_STACK || mode == MODE_TABBED) {
315 /* When we’re already in stacking mode, nothing has to be done */
316 if ((mode == MODE_STACK && container->mode == MODE_STACK) ||
317 (mode == MODE_TABBED && container->mode == MODE_TABBED))
320 if (container->mode == MODE_STACK || container->mode == MODE_TABBED)
323 /* When entering stacking mode, we need to open a window on
324 * which we can draw the title bars of the clients, it has
325 * height 1 because we don’t bother here with calculating the
326 * correct height - it will be adjusted when rendering anyways.
327 * Also, we need to use max(width, 1) because windows cannot
328 * be created with either width == 0 or height == 0. */
329 Rect rect = {container->x, container->y, max(container->width, 1), 1};
334 /* Don’t generate events for our new window, it should *not* be managed */
335 mask |= XCB_CW_OVERRIDE_REDIRECT;
338 /* We want to know when… */
339 mask |= XCB_CW_EVENT_MASK;
340 values[1] = XCB_EVENT_MASK_ENTER_WINDOW | /* …mouse is moved into our window */
341 XCB_EVENT_MASK_BUTTON_PRESS | /* …mouse is pressed */
342 XCB_EVENT_MASK_EXPOSURE; /* …our window needs to be redrawn */
344 struct Stack_Window *stack_win = &(container->stack_win);
345 stack_win->window = create_window(conn, rect, XCB_WINDOW_CLASS_INPUT_OUTPUT, XCB_CURSOR_LEFT_PTR, false, mask, values);
347 stack_win->rect.height = 0;
349 /* Initialize the entry for our cached pixmap. It will be
350 * created as soon as it’s needed (see cached_pixmap_prepare). */
351 memset(&(stack_win->pixmap), 0, sizeof(struct Cached_Pixmap));
352 stack_win->pixmap.referred_rect = &stack_win->rect;
353 stack_win->pixmap.referred_drawable = stack_win->window;
355 stack_win->container = container;
357 SLIST_INSERT_HEAD(&stack_wins, stack_win, stack_windows);
359 if (container->mode == MODE_STACK || container->mode == MODE_TABBED)
360 leave_stack_mode(conn, container);
363 container->mode = mode;
365 /* Force reconfiguration of each client */
368 CIRCLEQ_FOREACH(client, &(container->clients), clients)
369 client->force_reconfigure = true;
373 if (container->currently_focused != NULL) {
374 /* We need to make sure that this client is above *each* of the
375 * other clients in this container */
376 Client *last_focused = get_last_focused_client(conn, container, container->currently_focused);
378 CIRCLEQ_FOREACH(client, &(container->clients), clients) {
379 if (client == container->currently_focused || client == last_focused)
382 DLOG("setting %08x below %08x / %08x\n", client->frame, container->currently_focused->frame);
383 uint32_t values[] = { container->currently_focused->frame, XCB_STACK_MODE_BELOW };
384 xcb_configure_window(conn, client->frame,
385 XCB_CONFIG_WINDOW_SIBLING | XCB_CONFIG_WINDOW_STACK_MODE, values);
388 if (last_focused != NULL) {
389 DLOG("Putting last_focused directly underneath the currently focused\n");
390 uint32_t values[] = { container->currently_focused->frame, XCB_STACK_MODE_BELOW };
391 xcb_configure_window(conn, last_focused->frame,
392 XCB_CONFIG_WINDOW_SIBLING | XCB_CONFIG_WINDOW_STACK_MODE, values);
396 set_focus(conn, container->currently_focused, true);
401 * Gets the first matching client for the given window class/window title.
402 * If the paramater specific is set to a specific client, only this one
406 Client *get_matching_client(xcb_connection_t *conn, const char *window_classtitle,
408 char *to_class, *to_title, *to_title_ucs = NULL;
409 int to_title_ucs_len = 0;
410 Client *matching = NULL;
412 to_class = sstrdup(window_classtitle);
414 /* If a title was specified, split both strings at the slash */
415 if ((to_title = strstr(to_class, "/")) != NULL) {
416 *(to_title++) = '\0';
417 /* Convert to UCS-2 */
418 to_title_ucs = convert_utf8_to_ucs2(to_title, &to_title_ucs_len);
421 /* If we were given a specific client we only check if that one matches */
422 if (specific != NULL) {
423 if (client_matches_class_name(specific, to_class, to_title, to_title_ucs, to_title_ucs_len))
428 DLOG("Getting clients for class \"%s\" / title \"%s\"\n", to_class, to_title);
430 TAILQ_FOREACH(ws, workspaces, workspaces) {
431 if (ws->output == NULL)
435 SLIST_FOREACH(client, &(ws->focus_stack), focus_clients) {
436 DLOG("Checking client with class=%s / %s, name=%s\n", client->window_class_instance,
437 client->window_class_class, client->name);
438 if (!client_matches_class_name(client, to_class, to_title, to_title_ucs, to_title_ucs_len))
454 * Goes through the list of arguments (for exec()) and checks if the given argument
455 * is present. If not, it copies the arguments (because we cannot realloc it) and
456 * appends the given argument.
459 static char **append_argument(char **original, char *argument) {
461 for (num_args = 0; original[num_args] != NULL; num_args++) {
462 DLOG("original argument: \"%s\"\n", original[num_args]);
463 /* If the argument is already present we return the original pointer */
464 if (strcmp(original[num_args], argument) == 0)
467 /* Copy the original array */
468 char **result = smalloc((num_args+2) * sizeof(char*));
469 memcpy(result, original, num_args * sizeof(char*));
470 result[num_args] = argument;
471 result[num_args+1] = NULL;
476 #define y(x, ...) yajl_gen_ ## x (gen, ##__VA_ARGS__)
477 #define ystr(str) yajl_gen_string(gen, (unsigned char*)str, strlen(str))
479 void store_restart_layout() {
480 yajl_gen gen = yajl_gen_alloc(NULL, NULL);
482 dump_node(gen, croot, true);
484 const unsigned char *payload;
486 y(get_buf, &payload, &length);
488 char *globbed = glob_path("~/.i3/_restart.json");
489 int fd = open(globbed, O_WRONLY | O_CREAT | O_TRUNC, S_IRUSR | S_IWUSR);
497 while (written < length) {
498 int n = write(fd, payload + written, length - written);
499 /* TODO: correct error-handling */
505 printf("write == 0?\n");
509 printf("written: %d of %d\n", written, length);
513 printf("layout: %.*s\n", length, payload);
519 * Restart i3 in-place
520 * appends -a to argument list to disable autostart
524 store_restart_layout();
529 LOG("restarting \"%s\"...\n", start_argv[0]);
530 /* make sure -a is in the argument list or append it */
531 start_argv = append_argument(start_argv, "-a");
533 execvp(start_argv[0], start_argv);
539 #if defined(__OpenBSD__)
543 * Find the first occurrence of the byte string s in byte string l.
546 void *memmem(const void *l, size_t l_len, const void *s, size_t s_len) {
547 register char *cur, *last;
548 const char *cl = (const char *)l;
549 const char *cs = (const char *)s;
551 /* we need something to compare */
552 if (l_len == 0 || s_len == 0)
555 /* "s" must be smaller or equal to "l" */
559 /* special case where s_len == 1 */
561 return memchr(l, (int)*cs, l_len);
563 /* the last position where its possible to find "s" in "l" */
564 last = (char *)cl + l_len - s_len;
566 for (cur = (char *)cl; cur <= last; cur++)
567 if (cur[0] == cs[0] && memcmp(cur, cs, s_len) == 0)