2 * vim:ts=4:sw=4:expandtab
4 * i3 - an improved dynamic tiling window manager
6 * © 2009-2011 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>
21 #include <yajl/yajl_version.h>
24 #define SN_API_NOT_YET_FROZEN 1
25 #include <libsn/sn-launcher.h>
29 static iconv_t conversion_descriptor = 0;
31 int min(int a, int b) {
32 return (a < b ? a : b);
35 int max(int a, int b) {
36 return (a > b ? a : b);
39 bool rect_contains(Rect rect, uint32_t x, uint32_t y) {
40 return (x >= rect.x &&
41 x <= (rect.x + rect.width) &&
43 y <= (rect.y + rect.height));
46 Rect rect_add(Rect a, Rect b) {
47 return (Rect){a.x + b.x,
54 * Updates *destination with new_value and returns true if it was changed or false
58 bool update_if_necessary(uint32_t *destination, const uint32_t new_value) {
59 uint32_t old_value = *destination;
61 return ((*destination = new_value) != old_value);
65 * Starts the given application by passing it through a shell. We use double fork
66 * to avoid zombie processes. As the started application’s parent exits (immediately),
67 * the application is reparented to init (process-id 1), which correctly handles
68 * childs, so we don’t have to do it :-).
70 * The shell is determined by looking for the SHELL environment variable. If it
71 * does not exist, /bin/sh is used.
74 void start_application(const char *command) {
75 /* Create a startup notification context to monitor the progress of this
77 SnLauncherContext *context;
78 context = sn_launcher_context_new(sndisplay, conn_screen);
79 sn_launcher_context_set_name(context, "i3");
80 sn_launcher_context_set_description(context, "exec command in i3");
81 /* Chop off everything starting from the first space (if there are any
82 * spaces in the command), since we don’t want the parameters. */
83 char *first_word = sstrdup(command);
84 char *space = strchr(first_word, ' ');
87 sn_launcher_context_initiate(context, "i3", first_word, last_timestamp);
90 LOG("startup id = %s\n", sn_launcher_context_get_startup_id(context));
92 LOG("executing: %s\n", command);
97 /* Setup the environment variable(s) */
98 sn_launcher_context_setup_child_process(context);
100 /* Stores the path of the shell */
101 static const char *shell = NULL;
104 if ((shell = getenv("SHELL")) == NULL)
107 /* This is the child */
108 execl(shell, shell, "-c", command, (void*)NULL);
117 * exec()s an i3 utility, for example the config file migration script or
118 * i3-nagbar. This function first searches $PATH for the given utility named,
119 * then falls back to the dirname() of the i3 executable path and then falls
120 * back to the dirname() of the target of /proc/self/exe (on linux).
122 * This function should be called after fork()ing.
124 * The first argument of the given argv vector will be overwritten with the
125 * executable name, so pass NULL.
127 * If the utility cannot be found in any of these locations, it exits with
131 void exec_i3_utility(char *name, char *argv[]) {
132 /* start the migration script, search PATH first */
133 char *migratepath = name;
134 argv[0] = migratepath;
135 execvp(migratepath, argv);
137 /* if the script is not in path, maybe the user installed to a strange
138 * location and runs the i3 binary with an absolute path. We use
139 * argv[0]’s dirname */
140 char *pathbuf = strdup(start_argv[0]);
141 char *dir = dirname(pathbuf);
142 asprintf(&migratepath, "%s/%s", dir, name);
143 argv[0] = migratepath;
144 execvp(migratepath, argv);
146 #if defined(__linux__)
147 /* on linux, we have one more fall-back: dirname(/proc/self/exe) */
149 if (readlink("/proc/self/exe", buffer, BUFSIZ) == -1) {
150 warn("could not read /proc/self/exe");
153 dir = dirname(buffer);
154 asprintf(&migratepath, "%s/%s", dir, name);
155 argv[0] = migratepath;
156 execvp(migratepath, argv);
159 warn("Could not start %s", name);
164 * Checks a generic cookie for errors and quits with the given message if there
168 void check_error(xcb_connection_t *conn, xcb_void_cookie_t cookie, char *err_message) {
169 xcb_generic_error_t *error = xcb_request_check(conn, cookie);
171 fprintf(stderr, "ERROR: %s (X error %d)\n", err_message , error->error_code);
172 xcb_disconnect(conn);
178 * Converts the given string to UCS-2 big endian for use with
179 * xcb_image_text_16(). The amount of real glyphs is stored in real_strlen,
180 * a buffer containing the UCS-2 encoded string (16 bit per glyph) is
181 * returned. It has to be freed when done.
184 char *convert_utf8_to_ucs2(char *input, int *real_strlen) {
185 size_t input_size = strlen(input) + 1;
186 /* UCS-2 consumes exactly two bytes for each glyph */
187 int buffer_size = input_size * 2;
189 char *buffer = smalloc(buffer_size);
190 size_t output_size = buffer_size;
191 /* We need to use an additional pointer, because iconv() modifies it */
192 char *output = buffer;
194 /* We convert the input into UCS-2 big endian */
195 if (conversion_descriptor == 0) {
196 conversion_descriptor = iconv_open("UCS-2BE", "UTF-8");
197 if (conversion_descriptor == 0) {
198 fprintf(stderr, "error opening the conversion context\n");
203 /* Get the conversion descriptor back to original state */
204 iconv(conversion_descriptor, NULL, NULL, NULL, NULL);
206 /* Convert our text */
207 int rc = iconv(conversion_descriptor, (void*)&input, &input_size, &output, &output_size);
208 if (rc == (size_t)-1) {
209 perror("Converting to UCS-2 failed");
210 if (real_strlen != NULL)
215 if (real_strlen != NULL)
216 *real_strlen = ((buffer_size - output_size) / 2) - 1;
222 * This function resolves ~ in pathnames.
223 * It may resolve wildcards in the first part of the path, but if no match
224 * or multiple matches are found, it just returns a copy of path as given.
227 char *resolve_tilde(const char *path) {
228 static glob_t globbuf;
229 char *head, *tail, *result;
231 tail = strchr(path, '/');
232 head = strndup(path, tail ? tail - path : strlen(path));
234 int res = glob(head, GLOB_TILDE, NULL, &globbuf);
236 /* no match, or many wildcard matches are bad */
237 if (res == GLOB_NOMATCH || globbuf.gl_pathc != 1)
238 result = sstrdup(path);
240 die("glob() failed");
242 head = globbuf.gl_pathv[0];
243 result = scalloc(strlen(head) + (tail ? strlen(tail) : 0) + 1);
244 strncpy(result, head, strlen(head));
246 strncat(result, tail, strlen(tail));
254 * Checks if the given path exists by calling stat().
257 bool path_exists(const char *path) {
259 return (stat(path, &buf) == 0);
263 * Goes through the list of arguments (for exec()) and checks if the given argument
264 * is present. If not, it copies the arguments (because we cannot realloc it) and
265 * appends the given argument.
268 static char **append_argument(char **original, char *argument) {
270 for (num_args = 0; original[num_args] != NULL; num_args++) {
271 DLOG("original argument: \"%s\"\n", original[num_args]);
272 /* If the argument is already present we return the original pointer */
273 if (strcmp(original[num_args], argument) == 0)
276 /* Copy the original array */
277 char **result = smalloc((num_args+2) * sizeof(char*));
278 memcpy(result, original, num_args * sizeof(char*));
279 result[num_args] = argument;
280 result[num_args+1] = NULL;
286 * Returns the name of a temporary file with the specified prefix.
289 char *get_process_filename(const char *prefix) {
290 char *dir = getenv("XDG_RUNTIME_DIR");
292 struct passwd *pw = getpwuid(getuid());
293 const char *username = pw ? pw->pw_name : "unknown";
294 if (asprintf(&dir, "/tmp/i3-%s", username) == -1) {
295 perror("asprintf()");
300 if (asprintf(&tmp, "%s/i3", dir) == -1) {
301 perror("asprintf()");
306 if (!path_exists(dir)) {
307 if (mkdir(dir, 0700) == -1) {
313 if (asprintf(&filename, "%s/%s.%d", dir, prefix, getpid()) == -1) {
314 perror("asprintf()");
322 #define y(x, ...) yajl_gen_ ## x (gen, ##__VA_ARGS__)
323 #define ystr(str) yajl_gen_string(gen, (unsigned char*)str, strlen(str))
325 char *store_restart_layout() {
326 setlocale(LC_NUMERIC, "C");
328 yajl_gen gen = yajl_gen_alloc(NULL);
330 yajl_gen gen = yajl_gen_alloc(NULL, NULL);
333 dump_node(gen, croot, true);
335 setlocale(LC_NUMERIC, "");
337 const unsigned char *payload;
343 y(get_buf, &payload, &length);
345 /* create a temporary file if one hasn't been specified, or just
346 * resolve the tildes in the specified path */
348 if (config.restart_state_path == NULL) {
349 filename = get_process_filename("restart-state");
353 filename = resolve_tilde(config.restart_state_path);
356 int fd = open(filename, O_WRONLY | O_CREAT | O_TRUNC, S_IRUSR | S_IWUSR);
364 while (written < length) {
365 int n = write(fd, payload + written, length - written);
366 /* TODO: correct error-handling */
374 printf("write == 0?\n");
381 printf("written: %d of %zd\n", written, length);
383 printf("written: %d of %d\n", written, length);
389 printf("layout: %.*s\n", (int)length, payload);
398 * Restart i3 in-place
399 * appends -a to argument list to disable autostart
402 void i3_restart(bool forget_layout) {
403 char *restart_filename = forget_layout ? NULL : store_restart_layout();
405 kill_configerror_nagbar(true);
411 LOG("restarting \"%s\"...\n", start_argv[0]);
412 /* make sure -a is in the argument list or append it */
413 start_argv = append_argument(start_argv, "-a");
415 /* replace -r <file> so that the layout is restored */
416 if (restart_filename != NULL) {
417 /* create the new argv */
419 for (num_args = 0; start_argv[num_args] != NULL; num_args++);
420 char **new_argv = scalloc((num_args + 3) * sizeof(char*));
422 /* copy the arguments, but skip the ones we'll replace */
424 bool skip_next = false;
425 for (int i = 0; i < num_args; ++i) {
428 else if (!strcmp(start_argv[i], "-r") ||
429 !strcmp(start_argv[i], "--restart"))
432 new_argv[write_index++] = start_argv[i];
435 /* add the arguments we'll replace */
436 new_argv[write_index++] = "--restart";
437 new_argv[write_index] = restart_filename;
440 start_argv = new_argv;
443 execvp(start_argv[0], start_argv);
447 #if defined(__OpenBSD__) || defined(__APPLE__)
451 * Find the first occurrence of the byte string s in byte string l.
454 void *memmem(const void *l, size_t l_len, const void *s, size_t s_len) {
455 register char *cur, *last;
456 const char *cl = (const char *)l;
457 const char *cs = (const char *)s;
459 /* we need something to compare */
460 if (l_len == 0 || s_len == 0)
463 /* "s" must be smaller or equal to "l" */
467 /* special case where s_len == 1 */
469 return memchr(l, (int)*cs, l_len);
471 /* the last position where its possible to find "s" in "l" */
472 last = (char *)cl + l_len - s_len;
474 for (cur = (char *)cl; cur <= last; cur++)
475 if (cur[0] == cs[0] && memcmp(cur, cs, s_len) == 0)
483 #if defined(__APPLE__)
487 * Returns a pointer to a new string which is a duplicate of the
488 * string, but only copies at most n characters.
491 char *strndup(const char *str, size_t n) {
495 for (len = 0; len < n && str[len]; len++)
498 if ((copy = malloc(len + 1)) == NULL)
500 memcpy(copy, str, len);