git.sur5r.net Git - i3/i3/blob - src/util.c

   1 /*
   2  * vim:ts=4:sw=4:expandtab
   3  *
   4  * i3 - an improved dynamic tiling window manager
   5  *
   6  * © 2009-2011 Michael Stapelberg and contributors
   7  *
   8  * See file LICENSE for license information.
   9  *
  10  * util.c: Utility functions, which can be useful everywhere.
  11  *
  12  */
  13 #include <sys/wait.h>
  14 #include <stdarg.h>
  15 #include <iconv.h>
  16 #if defined(__OpenBSD__)
  17 #include <sys/cdefs.h>
  18 #endif
  19 #include <fcntl.h>
  20 #include <pwd.h>
  21 #include <yajl/yajl_version.h>
  22
  23 #include "all.h"
  24
  25 static iconv_t conversion_descriptor = 0;
  26
  27 int min(int a, int b) {
  28     return (a < b ? a : b);
  29 }
  30
  31 int max(int a, int b) {
  32     return (a > b ? a : b);
  33 }
  34
  35 bool rect_contains(Rect rect, uint32_t x, uint32_t y) {
  36     return (x >= rect.x &&
  37             x <= (rect.x + rect.width) &&
  38             y >= rect.y &&
  39             y <= (rect.y + rect.height));
  40 }
  41
  42 Rect rect_add(Rect a, Rect b) {
  43     return (Rect){a.x + b.x,
  44                   a.y + b.y,
  45                   a.width + b.width,
  46                   a.height + b.height};
  47 }
  48
  49 /*
  50  * Updates *destination with new_value and returns true if it was changed or false
  51  * if it was the same
  52  *
  53  */
  54 bool update_if_necessary(uint32_t *destination, const uint32_t new_value) {
  55     uint32_t old_value = *destination;
  56
  57     return ((*destination = new_value) != old_value);
  58 }
  59
  60 /*
  61  * The s* functions (safe) are wrappers around malloc, strdup, …, which exits if one of
  62  * the called functions returns NULL, meaning that there is no more memory available
  63  *
  64  */
  65 void *smalloc(size_t size) {
  66     void *result = malloc(size);
  67     exit_if_null(result, "Error: out of memory (malloc(%zd))\n", size);
  68     return result;
  69 }
  70
  71 void *scalloc(size_t size) {
  72     void *result = calloc(size, 1);
  73     exit_if_null(result, "Error: out of memory (calloc(%zd))\n", size);
  74     return result;
  75 }
  76
  77 void *srealloc(void *ptr, size_t size) {
  78     void *result = realloc(ptr, size);
  79     exit_if_null(result, "Error: out memory (realloc(%zd))\n", size);
  80     return result;
  81 }
  82
  83 char *sstrdup(const char *str) {
  84     char *result = strdup(str);
  85     exit_if_null(result, "Error: out of memory (strdup())\n");
  86     return result;
  87 }
  88
  89 /*
  90  * Starts the given application by passing it through a shell. We use double fork
  91  * to avoid zombie processes. As the started application’s parent exits (immediately),
  92  * the application is reparented to init (process-id 1), which correctly handles
  93  * childs, so we don’t have to do it :-).
  94  *
  95  * The shell is determined by looking for the SHELL environment variable. If it
  96  * does not exist, /bin/sh is used.
  97  *
  98  */
  99 void start_application(const char *command) {
 100     LOG("executing: %s\n", command);
 101     if (fork() == 0) {
 102         /* Child process */
 103         setsid();
 104         if (fork() == 0) {
 105             /* Stores the path of the shell */
 106             static const char *shell = NULL;
 107
 108             if (shell == NULL)
 109                 if ((shell = getenv("SHELL")) == NULL)
 110                     shell = "/bin/sh";
 111
 112             /* This is the child */
 113             execl(shell, shell, "-c", command, (void*)NULL);
 114             /* not reached */
 115         }
 116         exit(0);
 117     }
 118     wait(0);
 119 }
 120
 121 /*
 122  * Checks a generic cookie for errors and quits with the given message if there
 123  * was an error.
 124  *
 125  */
 126 void check_error(xcb_connection_t *conn, xcb_void_cookie_t cookie, char *err_message) {
 127     xcb_generic_error_t *error = xcb_request_check(conn, cookie);
 128     if (error != NULL) {
 129         fprintf(stderr, "ERROR: %s (X error %d)\n", err_message , error->error_code);
 130         xcb_disconnect(conn);
 131         exit(-1);
 132     }
 133 }
 134
 135 /*
 136  * Converts the given string to UCS-2 big endian for use with
 137  * xcb_image_text_16(). The amount of real glyphs is stored in real_strlen,
 138  * a buffer containing the UCS-2 encoded string (16 bit per glyph) is
 139  * returned. It has to be freed when done.
 140  *
 141  */
 142 char *convert_utf8_to_ucs2(char *input, int *real_strlen) {
 143     size_t input_size = strlen(input) + 1;
 144     /* UCS-2 consumes exactly two bytes for each glyph */
 145     int buffer_size = input_size * 2;
 146
 147     char *buffer = smalloc(buffer_size);
 148     size_t output_size = buffer_size;
 149     /* We need to use an additional pointer, because iconv() modifies it */
 150     char *output = buffer;
 151
 152     /* We convert the input into UCS-2 big endian */
 153     if (conversion_descriptor == 0) {
 154         conversion_descriptor = iconv_open("UCS-2BE", "UTF-8");
 155         if (conversion_descriptor == 0) {
 156             fprintf(stderr, "error opening the conversion context\n");
 157             exit(1);
 158         }
 159     }
 160
 161     /* Get the conversion descriptor back to original state */
 162     iconv(conversion_descriptor, NULL, NULL, NULL, NULL);
 163
 164     /* Convert our text */
 165     int rc = iconv(conversion_descriptor, (void*)&input, &input_size, &output, &output_size);
 166     if (rc == (size_t)-1) {
 167         perror("Converting to UCS-2 failed");
 168         if (real_strlen != NULL)
 169             *real_strlen = 0;
 170         return NULL;
 171     }
 172
 173     if (real_strlen != NULL)
 174         *real_strlen = ((buffer_size - output_size) / 2) - 1;
 175
 176     return buffer;
 177 }
 178
 179 /*
 180  * This function resolves ~ in pathnames.
 181  * It may resolve wildcards in the first part of the path, but if no match
 182  * or multiple matches are found, it just returns a copy of path as given.
 183  *
 184  */
 185 char *resolve_tilde(const char *path) {
 186         static glob_t globbuf;
 187         char *head, *tail, *result;
 188
 189         tail = strchr(path, '/');
 190         head = strndup(path, tail ? tail - path : strlen(path));
 191
 192         int res = glob(head, GLOB_TILDE, NULL, &globbuf);
 193         free(head);
 194         /* no match, or many wildcard matches are bad */
 195         if (res == GLOB_NOMATCH || globbuf.gl_pathc != 1)
 196                 result = sstrdup(path);
 197         else if (res != 0) {
 198                 die("glob() failed");
 199         } else {
 200                 head = globbuf.gl_pathv[0];
 201                 result = scalloc(strlen(head) + (tail ? strlen(tail) : 0) + 1);
 202                 strncpy(result, head, strlen(head));
 203                 if (tail)
 204                     strncat(result, tail, strlen(tail));
 205         }
 206         globfree(&globbuf);
 207
 208         return result;
 209 }
 210
 211 /*
 212  * Checks if the given path exists by calling stat().
 213  *
 214  */
 215 bool path_exists(const char *path) {
 216         struct stat buf;
 217         return (stat(path, &buf) == 0);
 218 }
 219
 220 /*
 221  * Goes through the list of arguments (for exec()) and checks if the given argument
 222  * is present. If not, it copies the arguments (because we cannot realloc it) and
 223  * appends the given argument.
 224  *
 225  */
 226 static char **append_argument(char **original, char *argument) {
 227     int num_args;
 228     for (num_args = 0; original[num_args] != NULL; num_args++) {
 229         DLOG("original argument: \"%s\"\n", original[num_args]);
 230         /* If the argument is already present we return the original pointer */
 231         if (strcmp(original[num_args], argument) == 0)
 232             return original;
 233     }
 234     /* Copy the original array */
 235     char **result = smalloc((num_args+2) * sizeof(char*));
 236     memcpy(result, original, num_args * sizeof(char*));
 237     result[num_args] = argument;
 238     result[num_args+1] = NULL;
 239
 240     return result;
 241 }
 242
 243 /*
 244  * Returns the name of a temporary file with the specified prefix.
 245  *
 246  */
 247 char *get_process_filename(const char *prefix) {
 248     char *dir = getenv("XDG_RUNTIME_DIR");
 249     if (dir == NULL) {
 250         struct passwd *pw = getpwuid(getuid());
 251         const char *username = pw ? pw->pw_name : "unknown";
 252         if (asprintf(&dir, "/tmp/i3-%s", username) == -1) {
 253             perror("asprintf()");
 254             return NULL;
 255         }
 256     } else {
 257         char *tmp;
 258         if (asprintf(&tmp, "%s/i3", dir) == -1) {
 259             perror("asprintf()");
 260             return NULL;
 261         }
 262         dir = tmp;
 263     }
 264     if (!path_exists(dir)) {
 265         if (mkdir(dir, 0700) == -1) {
 266             perror("mkdir()");
 267             return NULL;
 268         }
 269     }
 270     char *filename;
 271     if (asprintf(&filename, "%s/%s.%d", dir, prefix, getpid()) == -1) {
 272         perror("asprintf()");
 273         filename = NULL;
 274     }
 275
 276     free(dir);
 277     return filename;
 278 }
 279
 280 #define y(x, ...) yajl_gen_ ## x (gen, ##__VA_ARGS__)
 281 #define ystr(str) yajl_gen_string(gen, (unsigned char*)str, strlen(str))
 282
 283 char *store_restart_layout() {
 284     setlocale(LC_NUMERIC, "C");
 285 #if YAJL_MAJOR >= 2
 286     yajl_gen gen = yajl_gen_alloc(NULL);
 287 #else
 288     yajl_gen gen = yajl_gen_alloc(NULL, NULL);
 289 #endif
 290
 291     dump_node(gen, croot, true);
 292
 293     setlocale(LC_NUMERIC, "");
 294
 295     const unsigned char *payload;
 296 #if YAJL_MAJOR >= 2
 297     size_t length;
 298 #else
 299     unsigned int length;
 300 #endif
 301     y(get_buf, &payload, &length);
 302
 303     /* create a temporary file if one hasn't been specified, or just
 304      * resolve the tildes in the specified path */
 305     char *filename;
 306     if (config.restart_state_path == NULL) {
 307         filename = get_process_filename("restart-state");
 308         if (!filename)
 309             return NULL;
 310     } else {
 311         filename = resolve_tilde(config.restart_state_path);
 312     }
 313
 314     int fd = open(filename, O_WRONLY | O_CREAT | O_TRUNC, S_IRUSR | S_IWUSR);
 315     if (fd == -1) {
 316         perror("open()");
 317         free(filename);
 318         return NULL;
 319     }
 320
 321     int written = 0;
 322     while (written < length) {
 323         int n = write(fd, payload + written, length - written);
 324         /* TODO: correct error-handling */
 325         if (n == -1) {
 326             perror("write()");
 327             free(filename);
 328             return NULL;
 329         }
 330         if (n == 0) {
 331             printf("write == 0?\n");
 332             free(filename);
 333             return NULL;
 334         }
 335         written += n;
 336 #if YAJL_MAJOR >= 2
 337         printf("written: %d of %zd\n", written, length);
 338 #else
 339         printf("written: %d of %d\n", written, length);
 340 #endif
 341     }
 342     close(fd);
 343
 344     if (length > 0) {
 345         printf("layout: %.*s\n", (int)length, payload);
 346     }
 347
 348     y(free);
 349
 350     return filename;
 351 }
 352
 353 /*
 354  * Restart i3 in-place
 355  * appends -a to argument list to disable autostart
 356  *
 357  */
 358 void i3_restart(bool forget_layout) {
 359     char *restart_filename = forget_layout ? NULL : store_restart_layout();
 360
 361     restore_geometry();
 362
 363     ipc_shutdown();
 364
 365     LOG("restarting \"%s\"...\n", start_argv[0]);
 366     /* make sure -a is in the argument list or append it */
 367     start_argv = append_argument(start_argv, "-a");
 368
 369     /* replace -r <file> so that the layout is restored */
 370     if (restart_filename != NULL) {
 371         /* create the new argv */
 372         int num_args;
 373         for (num_args = 0; start_argv[num_args] != NULL; num_args++);
 374         char **new_argv = scalloc((num_args + 3) * sizeof(char*));
 375
 376         /* copy the arguments, but skip the ones we'll replace */
 377         int write_index = 0;
 378         bool skip_next = false;
 379         for (int i = 0; i < num_args; ++i) {
 380             if (skip_next)
 381                 skip_next = false;
 382             else if (!strcmp(start_argv[i], "-r") ||
 383                      !strcmp(start_argv[i], "--restart"))
 384                 skip_next = true;
 385             else
 386                 new_argv[write_index++] = start_argv[i];
 387         }
 388
 389         /* add the arguments we'll replace */
 390         new_argv[write_index++] = "--restart";
 391         new_argv[write_index] = restart_filename;
 392
 393         /* swap the argvs */
 394         start_argv = new_argv;
 395     }
 396
 397     execvp(start_argv[0], start_argv);
 398     /* not reached */
 399 }
 400
 401 #if 0
 402
 403 #if defined(__OpenBSD__)
 404
 405 /*
 406  * Taken from FreeBSD
 407  * Find the first occurrence of the byte string s in byte string l.
 408  *
 409  */
 410 void *memmem(const void *l, size_t l_len, const void *s, size_t s_len) {
 411         register char *cur, *last;
 412         const char *cl = (const char *)l;
 413         const char *cs = (const char *)s;
 414
 415         /* we need something to compare */
 416         if (l_len == 0 || s_len == 0)
 417                 return NULL;
 418
 419         /* "s" must be smaller or equal to "l" */
 420         if (l_len < s_len)
 421                 return NULL;
 422
 423         /* special case where s_len == 1 */
 424         if (s_len == 1)
 425                 return memchr(l, (int)*cs, l_len);
 426
 427         /* the last position where its possible to find "s" in "l" */
 428         last = (char *)cl + l_len - s_len;
 429
 430         for (cur = (char *)cl; cur <= last; cur++)
 431                 if (cur[0] == cs[0] && memcmp(cur, cs, s_len) == 0)
 432                         return cur;
 433
 434         return NULL;
 435 }
 436
 437 #endif
 438 #endif