2 * vim:ts=4:sw=4:expandtab
4 * i3 - an improved dynamic tiling window manager
5 * © 2009-2011 Michael Stapelberg and contributors (see also: LICENSE)
7 * util.c: Utility functions, which can be useful everywhere within i3 (see
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>
27 static iconv_t conversion_descriptor = 0;
29 int min(int a, int b) {
30 return (a < b ? a : b);
33 int max(int a, int b) {
34 return (a > b ? a : b);
37 bool rect_contains(Rect rect, uint32_t x, uint32_t y) {
38 return (x >= rect.x &&
39 x <= (rect.x + rect.width) &&
41 y <= (rect.y + rect.height));
44 Rect rect_add(Rect a, Rect b) {
45 return (Rect){a.x + b.x,
52 * Updates *destination with new_value and returns true if it was changed or false
56 bool update_if_necessary(uint32_t *destination, const uint32_t new_value) {
57 uint32_t old_value = *destination;
59 return ((*destination = new_value) != old_value);
63 * exec()s an i3 utility, for example the config file migration script or
64 * i3-nagbar. This function first searches $PATH for the given utility named,
65 * then falls back to the dirname() of the i3 executable path and then falls
66 * back to the dirname() of the target of /proc/self/exe (on linux).
68 * This function should be called after fork()ing.
70 * The first argument of the given argv vector will be overwritten with the
71 * executable name, so pass NULL.
73 * If the utility cannot be found in any of these locations, it exits with
77 void exec_i3_utility(char *name, char *argv[]) {
78 /* start the migration script, search PATH first */
79 char *migratepath = name;
80 argv[0] = migratepath;
81 execvp(migratepath, argv);
83 /* if the script is not in path, maybe the user installed to a strange
84 * location and runs the i3 binary with an absolute path. We use
85 * argv[0]’s dirname */
86 char *pathbuf = strdup(start_argv[0]);
87 char *dir = dirname(pathbuf);
88 sasprintf(&migratepath, "%s/%s", dir, name);
89 argv[0] = migratepath;
90 execvp(migratepath, argv);
92 #if defined(__linux__)
93 /* on linux, we have one more fall-back: dirname(/proc/self/exe) */
95 if (readlink("/proc/self/exe", buffer, BUFSIZ) == -1) {
96 warn("could not read /proc/self/exe");
99 dir = dirname(buffer);
100 sasprintf(&migratepath, "%s/%s", dir, name);
101 argv[0] = migratepath;
102 execvp(migratepath, argv);
105 warn("Could not start %s", name);
110 * Checks a generic cookie for errors and quits with the given message if there
114 void check_error(xcb_connection_t *conn, xcb_void_cookie_t cookie, char *err_message) {
115 xcb_generic_error_t *error = xcb_request_check(conn, cookie);
117 fprintf(stderr, "ERROR: %s (X error %d)\n", err_message , error->error_code);
118 xcb_disconnect(conn);
124 * Converts the given string to UCS-2 big endian for use with
125 * xcb_image_text_16(). The amount of real glyphs is stored in real_strlen,
126 * a buffer containing the UCS-2 encoded string (16 bit per glyph) is
127 * returned. It has to be freed when done.
130 char *convert_utf8_to_ucs2(char *input, int *real_strlen) {
131 size_t input_size = strlen(input) + 1;
132 /* UCS-2 consumes exactly two bytes for each glyph */
133 int buffer_size = input_size * 2;
135 char *buffer = smalloc(buffer_size);
136 size_t output_size = buffer_size;
137 /* We need to use an additional pointer, because iconv() modifies it */
138 char *output = buffer;
140 /* We convert the input into UCS-2 big endian */
141 if (conversion_descriptor == 0) {
142 conversion_descriptor = iconv_open("UCS-2BE", "UTF-8");
143 if (conversion_descriptor == 0) {
144 fprintf(stderr, "error opening the conversion context\n");
149 /* Get the conversion descriptor back to original state */
150 iconv(conversion_descriptor, NULL, NULL, NULL, NULL);
152 /* Convert our text */
153 int rc = iconv(conversion_descriptor, (void*)&input, &input_size, &output, &output_size);
154 if (rc == (size_t)-1) {
155 perror("Converting to UCS-2 failed");
156 if (real_strlen != NULL)
161 if (real_strlen != NULL)
162 *real_strlen = ((buffer_size - output_size) / 2) - 1;
168 * This function resolves ~ in pathnames.
169 * It may resolve wildcards in the first part of the path, but if no match
170 * or multiple matches are found, it just returns a copy of path as given.
173 char *resolve_tilde(const char *path) {
174 static glob_t globbuf;
175 char *head, *tail, *result;
177 tail = strchr(path, '/');
178 head = strndup(path, tail ? tail - path : strlen(path));
180 int res = glob(head, GLOB_TILDE, NULL, &globbuf);
182 /* no match, or many wildcard matches are bad */
183 if (res == GLOB_NOMATCH || globbuf.gl_pathc != 1)
184 result = sstrdup(path);
186 die("glob() failed");
188 head = globbuf.gl_pathv[0];
189 result = scalloc(strlen(head) + (tail ? strlen(tail) : 0) + 1);
190 strncpy(result, head, strlen(head));
192 strncat(result, tail, strlen(tail));
200 * Checks if the given path exists by calling stat().
203 bool path_exists(const char *path) {
205 return (stat(path, &buf) == 0);
209 * Goes through the list of arguments (for exec()) and checks if the given argument
210 * is present. If not, it copies the arguments (because we cannot realloc it) and
211 * appends the given argument.
214 static char **append_argument(char **original, char *argument) {
216 for (num_args = 0; original[num_args] != NULL; num_args++) {
217 DLOG("original argument: \"%s\"\n", original[num_args]);
218 /* If the argument is already present we return the original pointer */
219 if (strcmp(original[num_args], argument) == 0)
222 /* Copy the original array */
223 char **result = smalloc((num_args+2) * sizeof(char*));
224 memcpy(result, original, num_args * sizeof(char*));
225 result[num_args] = argument;
226 result[num_args+1] = NULL;
232 * Returns the name of a temporary file with the specified prefix.
235 char *get_process_filename(const char *prefix) {
236 char *dir = getenv("XDG_RUNTIME_DIR");
238 struct passwd *pw = getpwuid(getuid());
239 const char *username = pw ? pw->pw_name : "unknown";
240 sasprintf(&dir, "/tmp/i3-%s", username);
243 sasprintf(&tmp, "%s/i3", dir);
246 if (!path_exists(dir)) {
247 if (mkdir(dir, 0700) == -1) {
253 sasprintf(&filename, "%s/%s.%d", dir, prefix, getpid());
258 #define y(x, ...) yajl_gen_ ## x (gen, ##__VA_ARGS__)
259 #define ystr(str) yajl_gen_string(gen, (unsigned char*)str, strlen(str))
261 char *store_restart_layout() {
262 setlocale(LC_NUMERIC, "C");
264 yajl_gen gen = yajl_gen_alloc(NULL);
266 yajl_gen gen = yajl_gen_alloc(NULL, NULL);
269 dump_node(gen, croot, true);
271 setlocale(LC_NUMERIC, "");
273 const unsigned char *payload;
279 y(get_buf, &payload, &length);
281 /* create a temporary file if one hasn't been specified, or just
282 * resolve the tildes in the specified path */
284 if (config.restart_state_path == NULL) {
285 filename = get_process_filename("restart-state");
289 filename = resolve_tilde(config.restart_state_path);
292 int fd = open(filename, O_WRONLY | O_CREAT | O_TRUNC, S_IRUSR | S_IWUSR);
300 while (written < length) {
301 int n = write(fd, payload + written, length - written);
302 /* TODO: correct error-handling */
310 printf("write == 0?\n");
317 printf("written: %d of %zd\n", written, length);
319 printf("written: %d of %d\n", written, length);
325 printf("layout: %.*s\n", (int)length, payload);
334 * Restart i3 in-place
335 * appends -a to argument list to disable autostart
338 void i3_restart(bool forget_layout) {
339 char *restart_filename = forget_layout ? NULL : store_restart_layout();
341 kill_configerror_nagbar(true);
347 LOG("restarting \"%s\"...\n", start_argv[0]);
348 /* make sure -a is in the argument list or append it */
349 start_argv = append_argument(start_argv, "-a");
351 /* replace -r <file> so that the layout is restored */
352 if (restart_filename != NULL) {
353 /* create the new argv */
355 for (num_args = 0; start_argv[num_args] != NULL; num_args++);
356 char **new_argv = scalloc((num_args + 3) * sizeof(char*));
358 /* copy the arguments, but skip the ones we'll replace */
360 bool skip_next = false;
361 for (int i = 0; i < num_args; ++i) {
364 else if (!strcmp(start_argv[i], "-r") ||
365 !strcmp(start_argv[i], "--restart"))
368 new_argv[write_index++] = start_argv[i];
371 /* add the arguments we'll replace */
372 new_argv[write_index++] = "--restart";
373 new_argv[write_index] = restart_filename;
376 start_argv = new_argv;
379 execvp(start_argv[0], start_argv);
383 #if defined(__OpenBSD__) || defined(__APPLE__)
387 * Find the first occurrence of the byte string s in byte string l.
390 void *memmem(const void *l, size_t l_len, const void *s, size_t s_len) {
391 register char *cur, *last;
392 const char *cl = (const char *)l;
393 const char *cs = (const char *)s;
395 /* we need something to compare */
396 if (l_len == 0 || s_len == 0)
399 /* "s" must be smaller or equal to "l" */
403 /* special case where s_len == 1 */
405 return memchr(l, (int)*cs, l_len);
407 /* the last position where its possible to find "s" in "l" */
408 last = (char *)cl + l_len - s_len;
410 for (cur = (char *)cl; cur <= last; cur++)
411 if (cur[0] == cs[0] && memcmp(cur, cs, s_len) == 0)
419 #if defined(__APPLE__)
423 * Returns a pointer to a new string which is a duplicate of the
424 * string, but only copies at most n characters.
427 char *strndup(const char *str, size_t n) {
431 for (len = 0; len < n && str[len]; len++)
434 if ((copy = malloc(len + 1)) == NULL)
436 memcpy(copy, str, len);