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);
104 /* Stores the path of the shell */
105 static const char *shell = NULL;
108 if ((shell = getenv("SHELL")) == NULL)
111 /* This is the child */
112 execl(shell, shell, "-c", command, (void*)NULL);
121 * Checks a generic cookie for errors and quits with the given message if there
125 void check_error(xcb_connection_t *conn, xcb_void_cookie_t cookie, char *err_message) {
126 xcb_generic_error_t *error = xcb_request_check(conn, cookie);
128 fprintf(stderr, "ERROR: %s (X error %d)\n", err_message , error->error_code);
129 xcb_disconnect(conn);
135 * Converts the given string to UCS-2 big endian for use with
136 * xcb_image_text_16(). The amount of real glyphs is stored in real_strlen,
137 * a buffer containing the UCS-2 encoded string (16 bit per glyph) is
138 * returned. It has to be freed when done.
141 char *convert_utf8_to_ucs2(char *input, int *real_strlen) {
142 size_t input_size = strlen(input) + 1;
143 /* UCS-2 consumes exactly two bytes for each glyph */
144 int buffer_size = input_size * 2;
146 char *buffer = smalloc(buffer_size);
147 size_t output_size = buffer_size;
148 /* We need to use an additional pointer, because iconv() modifies it */
149 char *output = buffer;
151 /* We convert the input into UCS-2 big endian */
152 if (conversion_descriptor == 0) {
153 conversion_descriptor = iconv_open("UCS-2BE", "UTF-8");
154 if (conversion_descriptor == 0) {
155 fprintf(stderr, "error opening the conversion context\n");
160 /* Get the conversion descriptor back to original state */
161 iconv(conversion_descriptor, NULL, NULL, NULL, NULL);
163 /* Convert our text */
164 int rc = iconv(conversion_descriptor, (void*)&input, &input_size, &output, &output_size);
165 if (rc == (size_t)-1) {
166 perror("Converting to UCS-2 failed");
167 if (real_strlen != NULL)
172 if (real_strlen != NULL)
173 *real_strlen = ((buffer_size - output_size) / 2) - 1;
180 * Returns the client which comes next in focus stack (= was selected before) for
181 * the given container, optionally excluding the given client.
184 Client *get_last_focused_client(xcb_connection_t *conn, Container *container, Client *exclude) {
186 SLIST_FOREACH(current, &(container->workspace->focus_stack), focus_clients)
187 if ((current->container == container) && ((exclude == NULL) || (current != exclude)))
194 * Sets the given client as focused by updating the data structures correctly,
195 * updating the X input focus and finally re-decorating both windows (to signalize
196 * the user the new focus situation)
199 void set_focus(xcb_connection_t *conn, Client *client, bool set_anyways) {
200 /* The dock window cannot be focused, but enter notifies are still handled correctly */
204 /* Store the old client */
205 Client *old_client = SLIST_FIRST(&(c_ws->focus_stack));
207 /* Check if the focus needs to be changed at all */
208 if (!set_anyways && (old_client == client))
211 /* Store current_row/current_col */
212 c_ws->current_row = current_row;
213 c_ws->current_col = current_col;
214 c_ws = client->workspace;
215 ewmh_update_current_desktop();
216 /* Load current_col/current_row if we switch to a client without a container */
217 current_col = c_ws->current_col;
218 current_row = c_ws->current_row;
220 /* Update container */
221 if (client->container != NULL) {
222 client->container->currently_focused = client;
224 current_col = client->container->col;
225 current_row = client->container->row;
229 /* Set focus to the entered window, and flush xcb buffer immediately */
230 xcb_set_input_focus(conn, XCB_INPUT_FOCUS_POINTER_ROOT, client->child, XCB_CURRENT_TIME);
231 ewmh_update_active_window(client->child);
232 //xcb_warp_pointer(conn, XCB_NONE, client->child, 0, 0, 0, 0, 10, 10);
234 if (client->container != NULL) {
235 /* Get the client which was last focused in this particular container, it may be a different
236 one than old_client */
237 Client *last_focused = get_last_focused_client(conn, client->container, NULL);
239 /* In stacking containers, raise the client in respect to the one which was focused before */
240 if ((client->container->mode == MODE_STACK || client->container->mode == MODE_TABBED) &&
241 client->container->workspace->fullscreen_client == NULL) {
242 /* We need to get the client again, this time excluding the current client, because
243 * we might have just gone into stacking mode and need to raise */
244 Client *last_focused = get_last_focused_client(conn, client->container, client);
246 if (last_focused != NULL) {
247 DLOG("raising above frame %p / child %p\n", last_focused->frame, last_focused->child);
248 uint32_t values[] = { last_focused->frame, XCB_STACK_MODE_ABOVE };
249 xcb_configure_window(conn, client->frame, XCB_CONFIG_WINDOW_SIBLING | XCB_CONFIG_WINDOW_STACK_MODE, values);
253 /* If it is the same one as old_client, we save us the unnecessary redecorate */
254 if ((last_focused != NULL) && (last_focused != old_client))
255 redecorate_window(conn, last_focused);
258 /* If the last client was a floating client, we need to go to the next
259 * tiling client in stack and re-decorate it. */
260 if (old_client != NULL && client_is_floating(old_client)) {
261 DLOG("Coming from floating client, searching next tiling...\n");
263 SLIST_FOREACH(current, &(client->workspace->focus_stack), focus_clients) {
264 if (client_is_floating(current))
267 DLOG("Found window: %p / child %p\n", current->frame, current->child);
268 redecorate_window(conn, current);
273 SLIST_REMOVE(&(client->workspace->focus_stack), client, Client, focus_clients);
274 SLIST_INSERT_HEAD(&(client->workspace->focus_stack), client, focus_clients);
276 /* Clear the urgency flag if set (necessary when i3 sets the flag, for
277 * example when automatically putting windows on the workspace of their
279 client->urgent = false;
280 workspace_update_urgent_flag(client->workspace);
282 /* If we’re in stacking mode, this renders the container to update changes in the title
283 bars and to raise the focused client */
284 if ((old_client != NULL) && (old_client != client) && !old_client->dock)
285 redecorate_window(conn, old_client);
287 /* redecorate_window flushes, so we don’t need to */
288 redecorate_window(conn, client);
292 * Gets the first matching client for the given window class/window title.
293 * If the paramater specific is set to a specific client, only this one
297 Client *get_matching_client(xcb_connection_t *conn, const char *window_classtitle,
299 char *to_class, *to_title, *to_title_ucs = NULL;
300 int to_title_ucs_len = 0;
301 Client *matching = NULL;
303 to_class = sstrdup(window_classtitle);
305 /* If a title was specified, split both strings at the slash */
306 if ((to_title = strstr(to_class, "/")) != NULL) {
307 *(to_title++) = '\0';
308 /* Convert to UCS-2 */
309 to_title_ucs = convert_utf8_to_ucs2(to_title, &to_title_ucs_len);
312 /* If we were given a specific client we only check if that one matches */
313 if (specific != NULL) {
314 if (client_matches_class_name(specific, to_class, to_title, to_title_ucs, to_title_ucs_len))
319 DLOG("Getting clients for class \"%s\" / title \"%s\"\n", to_class, to_title);
321 TAILQ_FOREACH(ws, workspaces, workspaces) {
322 if (ws->output == NULL)
326 SLIST_FOREACH(client, &(ws->focus_stack), focus_clients) {
327 DLOG("Checking client with class=%s / %s, name=%s\n", client->window_class_instance,
328 client->window_class_class, client->name);
329 if (!client_matches_class_name(client, to_class, to_title, to_title_ucs, to_title_ucs_len))
345 * Goes through the list of arguments (for exec()) and checks if the given argument
346 * is present. If not, it copies the arguments (because we cannot realloc it) and
347 * appends the given argument.
350 static char **append_argument(char **original, char *argument) {
352 for (num_args = 0; original[num_args] != NULL; num_args++) {
353 DLOG("original argument: \"%s\"\n", original[num_args]);
354 /* If the argument is already present we return the original pointer */
355 if (strcmp(original[num_args], argument) == 0)
358 /* Copy the original array */
359 char **result = smalloc((num_args+2) * sizeof(char*));
360 memcpy(result, original, num_args * sizeof(char*));
361 result[num_args] = argument;
362 result[num_args+1] = NULL;
367 #define y(x, ...) yajl_gen_ ## x (gen, ##__VA_ARGS__)
368 #define ystr(str) yajl_gen_string(gen, (unsigned char*)str, strlen(str))
370 void store_restart_layout() {
371 yajl_gen gen = yajl_gen_alloc(NULL, NULL);
373 dump_node(gen, croot, true);
375 const unsigned char *payload;
377 y(get_buf, &payload, &length);
379 char *globbed = resolve_tilde(config.restart_state_path);
380 int fd = open(globbed, O_WRONLY | O_CREAT | O_TRUNC, S_IRUSR | S_IWUSR);
388 while (written < length) {
389 int n = write(fd, payload + written, length - written);
390 /* TODO: correct error-handling */
396 printf("write == 0?\n");
400 printf("written: %d of %d\n", written, length);
404 printf("layout: %.*s\n", length, payload);
410 * Restart i3 in-place
411 * appends -a to argument list to disable autostart
415 store_restart_layout();
420 LOG("restarting \"%s\"...\n", start_argv[0]);
421 /* make sure -a is in the argument list or append it */
422 start_argv = append_argument(start_argv, "-a");
424 execvp(start_argv[0], start_argv);
430 #if defined(__OpenBSD__)
434 * Find the first occurrence of the byte string s in byte string l.
437 void *memmem(const void *l, size_t l_len, const void *s, size_t s_len) {
438 register char *cur, *last;
439 const char *cl = (const char *)l;
440 const char *cs = (const char *)s;
442 /* we need something to compare */
443 if (l_len == 0 || s_len == 0)
446 /* "s" must be smaller or equal to "l" */
450 /* special case where s_len == 1 */
452 return memchr(l, (int)*cs, l_len);
454 /* the last position where its possible to find "s" in "l" */
455 last = (char *)cl + l_len - s_len;
457 for (cur = (char *)cl; cur <= last; cur++)
458 if (cur[0] == cs[0] && memcmp(cur, cs, s_len) == 0)