git.sur5r.net Git - i3/i3/blob - include/util.h

   1 /*
   2  * vim:ts=8:expandtab
   3  *
   4  * i3 - an improved dynamic tiling window manager
   5  *
   6  * © 2009 Michael Stapelberg and contributors
   7  *
   8  * See file LICENSE for license information.
   9  *
  10  */
  11 #include <err.h>
  12
  13 #include "data.h"
  14
  15 #ifndef _UTIL_H
  16 #define _UTIL_H
  17
  18 #define die(...) errx(EXIT_FAILURE, __VA_ARGS__);
  19 #define exit_if_null(pointer, ...) { if (pointer == NULL) die(__VA_ARGS__); }
  20 #define STARTS_WITH(string, needle) (strncasecmp(string, needle, strlen(needle)) == 0)
  21 #define CIRCLEQ_NEXT_OR_NULL(head, elm, field) (CIRCLEQ_NEXT(elm, field) != CIRCLEQ_END(head) ? \
  22                                                 CIRCLEQ_NEXT(elm, field) : NULL)
  23 #define CIRCLEQ_PREV_OR_NULL(head, elm, field) (CIRCLEQ_PREV(elm, field) != CIRCLEQ_END(head) ? \
  24                                                 CIRCLEQ_PREV(elm, field) : NULL)
  25 #define FOR_TABLE(workspace) \
  26                         for (int cols = 0; cols < (workspace)->cols; cols++) \
  27                                 for (int rows = 0; rows < (workspace)->rows; rows++)
  28
  29 #define NODES_FOREACH(head) \
  30     for (Con *child = (Con*)-1; (child == (Con*)-1) && ((child = 0), true);) \
  31         TAILQ_FOREACH(child, &((head)->nodes_head), nodes)
  32
  33 #define NODES_FOREACH_REVERSE(head) \
  34     for (Con *child = (Con*)-1; (child == (Con*)-1) && ((child = 0), true);) \
  35         TAILQ_FOREACH_REVERSE(child, &((head)->nodes_head), nodes_head, nodes)
  36
  37 /* greps the ->nodes of the given head and returns the first node that matches the given condition */
  38 #define GREP_FIRST(dest, head, condition) \
  39     NODES_FOREACH(head) { \
  40         if (!(condition)) \
  41             continue; \
  42         \
  43         (dest) = child; \
  44         break; \
  45     }
  46
  47 #define FREE(pointer) do { \
  48         if (pointer != NULL) { \
  49                 free(pointer); \
  50                 pointer = NULL; \
  51         } \
  52 } \
  53 while (0)
  54
  55 #define CALL(obj, member, ...) obj->member(obj, ## __VA_ARGS__)
  56
  57 int min(int a, int b);
  58 int max(int a, int b);
  59 bool rect_contains(Rect rect, uint32_t x, uint32_t y);
  60 Rect rect_add(Rect a, Rect b);
  61
  62 /**
  63  * Updates *destination with new_value and returns true if it was changed or false
  64  * if it was the same
  65  *
  66  */
  67 bool update_if_necessary(uint32_t *destination, const uint32_t new_value);
  68
  69 /**
  70  * Safe-wrapper around malloc which exits if malloc returns NULL (meaning that
  71  * there is no more memory available)
  72  *
  73  */
  74 void *smalloc(size_t size);
  75
  76 /**
  77  * Safe-wrapper around calloc which exits if malloc returns NULL (meaning that
  78  * there is no more memory available)
  79  *
  80  */
  81 void *scalloc(size_t size);
  82
  83 /**
  84  * Safe-wrapper around realloc which exits if realloc returns NULL (meaning
  85  * that there is no more memory available).
  86  *
  87  */
  88 void *srealloc(void *ptr, size_t size);
  89
  90 /**
  91  * Safe-wrapper around strdup which exits if malloc returns NULL (meaning that
  92  * there is no more memory available)
  93  *
  94  */
  95 char *sstrdup(const char *str);
  96
  97 /**
  98  * Starts the given application by passing it through a shell. We use double
  99  * fork to avoid zombie processes. As the started application’s parent exits
 100  * (immediately), the application is reparented to init (process-id 1), which
 101  * correctly handles childs, so we don’t have to do it :-).
 102  *
 103  * The shell is determined by looking for the SHELL environment variable. If
 104  * it does not exist, /bin/sh is used.
 105  *
 106  */
 107 void start_application(const char *command);
 108
 109 /**
 110  * exec()s an i3 utility, for example the config file migration script or
 111  * i3-nagbar. This function first searches $PATH for the given utility named,
 112  * then falls back to the dirname() of the i3 executable path and then falls
 113  * back to the dirname() of the target of /proc/self/exe (on linux).
 114  *
 115  * This function should be called after fork()ing.
 116  *
 117  * The first argument of the given argv vector will be overwritten with the
 118  * executable name, so pass NULL.
 119  *
 120  * If the utility cannot be found in any of these locations, it exits with
 121  * return code 2.
 122  *
 123  */
 124 void exec_i3_utility(char *name, char *argv[]);
 125
 126 /**
 127  * Checks a generic cookie for errors and quits with the given message if
 128  * there was an error.
 129  *
 130  */
 131 void check_error(xcb_connection_t *conn, xcb_void_cookie_t cookie,
 132                  char *err_message);
 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, a
 137  * 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
 143 /**
 144  * This function resolves ~ in pathnames.
 145  * It may resolve wildcards in the first part of the path, but if no match
 146  * or multiple matches are found, it just returns a copy of path as given.
 147  *
 148  */
 149 char *resolve_tilde(const char *path);
 150
 151 /**
 152  * Checks if the given path exists by calling stat().
 153  *
 154  */
 155 bool path_exists(const char *path);
 156
 157
 158 /**
 159  * Returns the name of a temporary file with the specified prefix.
 160  *
 161  */
 162 char *get_process_filename(const char *prefix);
 163
 164 /**
 165  * Restart i3 in-place
 166  * appends -a to argument list to disable autostart
 167  *
 168  */
 169 void i3_restart(bool forget_layout);
 170
 171 #if defined(__OpenBSD__) || defined(__APPLE__)
 172
 173 /*
 174  * Taken from FreeBSD
 175  * Find the first occurrence of the byte string s in byte string l.
 176  *
 177  */
 178 void *memmem(const void *l, size_t l_len, const void *s, size_t s_len);
 179
 180 #endif
 181
 182 #if defined(__APPLE__)
 183
 184 /*
 185  * Taken from FreeBSD
 186  * Returns a pointer to a new string which is a duplicate of the
 187  * string, but only copies at most n characters.
 188  *
 189  */
 190 char *strndup(const char *str, size_t n);
 191
 192 #endif
 193
 194 #endif