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 /* greps the ->nodes of the given head and returns the first node that matches the given condition */
  34 #define GREP_FIRST(dest, head, condition) \
  35     NODES_FOREACH(head) { \
  36         if (!(condition)) \
  37             continue; \
  38         \
  39         (dest) = child; \
  40         break; \
  41     }
  42
  43 #define FREE(pointer) do { \
  44         if (pointer != NULL) { \
  45                 free(pointer); \
  46                 pointer = NULL; \
  47         } \
  48 } \
  49 while (0)
  50
  51 #define CALL(obj, member, ...) obj->member(obj, ## __VA_ARGS__)
  52
  53 int min(int a, int b);
  54 int max(int a, int b);
  55 bool rect_contains(Rect rect, uint32_t x, uint32_t y);
  56 Rect rect_add(Rect a, Rect b);
  57
  58 /**
  59  * Updates *destination with new_value and returns true if it was changed or false
  60  * if it was the same
  61  *
  62  */
  63 bool update_if_necessary(uint32_t *destination, const uint32_t new_value);
  64
  65 /**
  66  * Safe-wrapper around malloc which exits if malloc returns NULL (meaning that
  67  * there is no more memory available)
  68  *
  69  */
  70 void *smalloc(size_t size);
  71
  72 /**
  73  * Safe-wrapper around calloc which exits if malloc returns NULL (meaning that
  74  * there is no more memory available)
  75  *
  76  */
  77 void *scalloc(size_t size);
  78
  79 /**
  80  * Safe-wrapper around realloc which exits if realloc returns NULL (meaning
  81  * that there is no more memory available).
  82  *
  83  */
  84 void *srealloc(void *ptr, size_t size);
  85
  86 /**
  87  * Safe-wrapper around strdup which exits if malloc returns NULL (meaning that
  88  * there is no more memory available)
  89  *
  90  */
  91 char *sstrdup(const char *str);
  92
  93 /**
  94  * Starts the given application by passing it through a shell. We use double
  95  * fork to avoid zombie processes. As the started application’s parent exits
  96  * (immediately), the application is reparented to init (process-id 1), which
  97  * correctly handles childs, so we don’t have to do it :-).
  98  *
  99  * The shell is determined by looking for the SHELL environment variable. If
 100  * it does not exist, /bin/sh is used.
 101  *
 102  */
 103 void start_application(const char *command);
 104
 105 /**
 106  * exec()s an i3 utility, for example the config file migration script or
 107  * i3-nagbar. This function first searches $PATH for the given utility named,
 108  * then falls back to the dirname() of the i3 executable path and then falls
 109  * back to the dirname() of the target of /proc/self/exe (on linux).
 110  *
 111  * This function should be called after fork()ing.
 112  *
 113  * The first argument of the given argv vector will be overwritten with the
 114  * executable name, so pass NULL.
 115  *
 116  * If the utility cannot be found in any of these locations, it exits with
 117  * return code 2.
 118  *
 119  */
 120 void exec_i3_utility(char *name, char *argv[]);
 121
 122 /**
 123  * Checks a generic cookie for errors and quits with the given message if
 124  * there was an error.
 125  *
 126  */
 127 void check_error(xcb_connection_t *conn, xcb_void_cookie_t cookie,
 128                  char *err_message);
 129
 130 /**
 131  * Converts the given string to UCS-2 big endian for use with
 132  * xcb_image_text_16(). The amount of real glyphs is stored in real_strlen, a
 133  * buffer containing the UCS-2 encoded string (16 bit per glyph) is
 134  * returned. It has to be freed when done.
 135  *
 136  */
 137 char *convert_utf8_to_ucs2(char *input, int *real_strlen);
 138
 139 /**
 140  * This function resolves ~ in pathnames.
 141  * It may resolve wildcards in the first part of the path, but if no match
 142  * or multiple matches are found, it just returns a copy of path as given.
 143  *
 144  */
 145 char *resolve_tilde(const char *path);
 146
 147 /**
 148  * Checks if the given path exists by calling stat().
 149  *
 150  */
 151 bool path_exists(const char *path);
 152
 153
 154 /**
 155  * Returns the name of a temporary file with the specified prefix.
 156  *
 157  */
 158 char *get_process_filename(const char *prefix);
 159
 160 /**
 161  * Restart i3 in-place
 162  * appends -a to argument list to disable autostart
 163  *
 164  */
 165 void i3_restart(bool forget_layout);
 166
 167 #if defined(__OpenBSD__) || defined(__APPLE__)
 168
 169 /*
 170  * Taken from FreeBSD
 171  * Find the first occurrence of the byte string s in byte string l.
 172  *
 173  */
 174 void *memmem(const void *l, size_t l_len, const void *s, size_t s_len);
 175
 176 #endif
 177
 178 #if defined(__APPLE__)
 179
 180 /*
 181  * Taken from FreeBSD
 182  * Returns a pointer to a new string which is a duplicate of the
 183  * string, but only copies at most n characters.
 184  *
 185  */
 186 char *strndup(const char *str, size_t n);
 187
 188 #endif
 189
 190 #endif