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-2010 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
  22 #include "all.h"
  23
  24 static iconv_t conversion_descriptor = 0;
  25
  26 int min(int a, int b) {
  27     return (a < b ? a : b);
  28 }
  29
  30 int max(int a, int b) {
  31     return (a > b ? a : b);
  32 }
  33
  34 bool rect_contains(Rect rect, uint32_t x, uint32_t y) {
  35     return (x >= rect.x &&
  36             x <= (rect.x + rect.width) &&
  37             y >= rect.y &&
  38             y <= (rect.y + rect.height));
  39 }
  40
  41 Rect rect_add(Rect a, Rect b) {
  42     return (Rect){a.x + b.x,
  43                   a.y + b.y,
  44                   a.width + b.width,
  45                   a.height + b.height};
  46 }
  47
  48 /*
  49  * Updates *destination with new_value and returns true if it was changed or false
  50  * if it was the same
  51  *
  52  */
  53 bool update_if_necessary(uint32_t *destination, const uint32_t new_value) {
  54     uint32_t old_value = *destination;
  55
  56     return ((*destination = new_value) != old_value);
  57 }
  58
  59 /*
  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
  62  *
  63  */
  64 void *smalloc(size_t size) {
  65     void *result = malloc(size);
  66     exit_if_null(result, "Error: out of memory (malloc(%zd))\n", size);
  67     return result;
  68 }
  69
  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);
  73     return result;
  74 }
  75
  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);
  79     return result;
  80 }
  81
  82 char *sstrdup(const char *str) {
  83     char *result = strdup(str);
  84     exit_if_null(result, "Error: out of memory (strdup())\n");
  85     return result;
  86 }
  87
  88 /*
  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 :-).
  93  *
  94  * The shell is determined by looking for the SHELL environment variable. If it
  95  * does not exist, /bin/sh is used.
  96  *
  97  */
  98 void start_application(const char *command) {
  99     LOG("executing: %s\n", command);
 100     if (fork() == 0) {
 101         /* Child process */
 102         setsid();
 103         if (fork() == 0) {
 104             /* Stores the path of the shell */
 105             static const char *shell = NULL;
 106
 107             if (shell == NULL)
 108                 if ((shell = getenv("SHELL")) == NULL)
 109                     shell = "/bin/sh";
 110
 111             /* This is the child */
 112             execl(shell, shell, "-c", command, (void*)NULL);
 113             /* not reached */
 114         }
 115         exit(0);
 116     }
 117     wait(0);
 118 }
 119
 120 /*
 121  * Checks a generic cookie for errors and quits with the given message if there
 122  * was an error.
 123  *
 124  */
 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);
 127     if (error != NULL) {
 128         fprintf(stderr, "ERROR: %s (X error %d)\n", err_message , error->error_code);
 129         xcb_disconnect(conn);
 130         exit(-1);
 131     }
 132 }
 133
 134 /*
 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.
 139  *
 140  */
 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;
 145
 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;
 150
 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");
 156             exit(1);
 157         }
 158     }
 159
 160     /* Get the conversion descriptor back to original state */
 161     iconv(conversion_descriptor, NULL, NULL, NULL, NULL);
 162
 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)
 168             *real_strlen = 0;
 169         return NULL;
 170     }
 171
 172     if (real_strlen != NULL)
 173         *real_strlen = ((buffer_size - output_size) / 2) - 1;
 174
 175     return buffer;
 176 }
 177
 178 /*
 179  * This function resolves ~ in pathnames.
 180  * It may resolve wildcards in the first part of the path, but if no match
 181  * or multiple matches are found, it just returns a copy of path as given.
 182  *
 183  */
 184 char *resolve_tilde(const char *path) {
 185         static glob_t globbuf;
 186         char *head, *tail, *result;
 187
 188         tail = strchr(path, '/');
 189         head = strndup(path, tail ? tail - path : strlen(path));
 190
 191         int res = glob(head, GLOB_TILDE, NULL, &globbuf);
 192         free(head);
 193         /* no match, or many wildcard matches are bad */
 194         if (res == GLOB_NOMATCH || globbuf.gl_pathc != 1)
 195                 result = sstrdup(path);
 196         else if (res != 0) {
 197                 die("glob() failed");
 198         } else {
 199                 head = globbuf.gl_pathv[0];
 200                 result = scalloc(strlen(head) + (tail ? strlen(tail) : 0) + 1);
 201                 strncpy(result, head, strlen(head));
 202                 if (tail)
 203                     strncat(result, tail, strlen(tail));
 204         }
 205         globfree(&globbuf);
 206
 207         return result;
 208 }
 209
 210 /*
 211  * Checks if the given path exists by calling stat().
 212  *
 213  */
 214 bool path_exists(const char *path) {
 215         struct stat buf;
 216         return (stat(path, &buf) == 0);
 217 }
 218
 219 /*
 220  * Goes through the list of arguments (for exec()) and checks if the given argument
 221  * is present. If not, it copies the arguments (because we cannot realloc it) and
 222  * appends the given argument.
 223  *
 224  */
 225 static char **append_argument(char **original, char *argument) {
 226     int num_args;
 227     for (num_args = 0; original[num_args] != NULL; num_args++) {
 228         DLOG("original argument: \"%s\"\n", original[num_args]);
 229         /* If the argument is already present we return the original pointer */
 230         if (strcmp(original[num_args], argument) == 0)
 231             return original;
 232     }
 233     /* Copy the original array */
 234     char **result = smalloc((num_args+2) * sizeof(char*));
 235     memcpy(result, original, num_args * sizeof(char*));
 236     result[num_args] = argument;
 237     result[num_args+1] = NULL;
 238
 239     return result;
 240 }
 241
 242 /*
 243  * Returns the name of a temporary file with the specified prefix.
 244  *
 245  */
 246 char *get_process_filename(const char *prefix)
 247 {
 248     struct passwd *pw = getpwuid(getuid());
 249     const char *username = pw ? pw->pw_name : "unknown";
 250     char *filename;
 251     int res = asprintf(&filename, "/tmp/%s-%s.%d", prefix, username, getpid());
 252     if (res == -1) {
 253         perror("asprintf()");
 254         return NULL;
 255     }
 256     else {
 257         return filename;
 258     }
 259 }
 260
 261 #define y(x, ...) yajl_gen_ ## x (gen, ##__VA_ARGS__)
 262 #define ystr(str) yajl_gen_string(gen, (unsigned char*)str, strlen(str))
 263
 264 char *store_restart_layout() {
 265     setlocale(LC_NUMERIC, "C");
 266     yajl_gen gen = yajl_gen_alloc(NULL, NULL);
 267
 268     dump_node(gen, croot, true);
 269
 270     setlocale(LC_NUMERIC, "");
 271
 272     const unsigned char *payload;
 273     unsigned int length;
 274     y(get_buf, &payload, &length);
 275
 276     /* create a temporary file if one hasn't been specified, or just
 277      * resolve the tildes in the specified path */
 278     char *filename;
 279     if (config.restart_state_path == NULL) {
 280         filename = get_process_filename("i3-restart-state");
 281         if (!filename)
 282             return NULL;
 283     } else {
 284         filename = resolve_tilde(config.restart_state_path);
 285     }
 286
 287     int fd = open(filename, O_WRONLY | O_CREAT | O_TRUNC, S_IRUSR | S_IWUSR);
 288     if (fd == -1) {
 289         perror("open()");
 290         free(filename);
 291         return NULL;
 292     }
 293
 294     int written = 0;
 295     while (written < length) {
 296         int n = write(fd, payload + written, length - written);
 297         /* TODO: correct error-handling */
 298         if (n == -1) {
 299             perror("write()");
 300             free(filename);
 301             return NULL;
 302         }
 303         if (n == 0) {
 304             printf("write == 0?\n");
 305             free(filename);
 306             return NULL;
 307         }
 308         written += n;
 309         printf("written: %d of %d\n", written, length);
 310     }
 311     close(fd);
 312
 313     printf("layout: %.*s\n", length, payload);
 314
 315     y(free);
 316
 317     return filename;
 318 }
 319
 320 /*
 321  * Restart i3 in-place
 322  * appends -a to argument list to disable autostart
 323  *
 324  */
 325 void i3_restart(bool forget_layout) {
 326     char *restart_filename = forget_layout ? NULL : store_restart_layout();
 327
 328     restore_geometry();
 329
 330     ipc_shutdown();
 331
 332     LOG("restarting \"%s\"...\n", start_argv[0]);
 333     /* make sure -a is in the argument list or append it */
 334     start_argv = append_argument(start_argv, "-a");
 335
 336     /* replace -r <file> so that the layout is restored */
 337     if (restart_filename != NULL) {
 338         /* create the new argv */
 339         int num_args;
 340         for (num_args = 0; start_argv[num_args] != NULL; num_args++);
 341         char **new_argv = scalloc((num_args + 3) * sizeof(char*));
 342
 343         /* copy the arguments, but skip the ones we'll replace */
 344         int write_index = 0;
 345         bool skip_next = false;
 346         for (int i = 0; i < num_args; ++i) {
 347             if (skip_next)
 348                 skip_next = false;
 349             else if (!strcmp(start_argv[i], "-r"))
 350                 skip_next = true;
 351             else
 352                 new_argv[write_index++] = start_argv[i];
 353         }
 354
 355         /* add the arguments we'll replace */
 356         new_argv[write_index++] = "--restart";
 357         new_argv[write_index] = restart_filename;
 358
 359         /* swap the argvs */
 360         start_argv = new_argv;
 361     }
 362
 363     execvp(start_argv[0], start_argv);
 364     /* not reached */
 365 }
 366
 367 #if 0
 368
 369 #if defined(__OpenBSD__)
 370
 371 /*
 372  * Taken from FreeBSD
 373  * Find the first occurrence of the byte string s in byte string l.
 374  *
 375  */
 376 void *memmem(const void *l, size_t l_len, const void *s, size_t s_len) {
 377         register char *cur, *last;
 378         const char *cl = (const char *)l;
 379         const char *cs = (const char *)s;
 380
 381         /* we need something to compare */
 382         if (l_len == 0 || s_len == 0)
 383                 return NULL;
 384
 385         /* "s" must be smaller or equal to "l" */
 386         if (l_len < s_len)
 387                 return NULL;
 388
 389         /* special case where s_len == 1 */
 390         if (s_len == 1)
 391                 return memchr(l, (int)*cs, l_len);
 392
 393         /* the last position where its possible to find "s" in "l" */
 394         last = (char *)cl + l_len - s_len;
 395
 396         for (cur = (char *)cl; cur <= last; cur++)
 397                 if (cur[0] == cs[0] && memcmp(cur, cs, s_len) == 0)
 398                         return cur;
 399
 400         return NULL;
 401 }
 402
 403 #endif
 404 #endif