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

   1 /*
   2  * vim:ts=4:sw=4:expandtab
   3  *
   4  * i3 - an improved dynamic tiling window manager
   5  * © 2009 Michael Stapelberg and contributors (see also: LICENSE)
   6  *
   7  * util.c: Utility functions, which can be useful everywhere within i3 (see
   8  *         also libi3).
   9  *
  10  */
  11 #pragma once
  12
  13 #include <config.h>
  14
  15 #include <err.h>
  16
  17 #include "data.h"
  18
  19 #define die(...) errx(EXIT_FAILURE, __VA_ARGS__);
  20 #define exit_if_null(pointer, ...) \
  21     {                              \
  22         if (pointer == NULL)       \
  23             die(__VA_ARGS__);      \
  24     }
  25 #define STARTS_WITH(string, needle) (strncasecmp((string), (needle), strlen((needle))) == 0)
  26 #define CIRCLEQ_NEXT_OR_NULL(head, elm, field) (CIRCLEQ_NEXT(elm, field) != CIRCLEQ_END(head) ? CIRCLEQ_NEXT(elm, field) : NULL)
  27 #define CIRCLEQ_PREV_OR_NULL(head, elm, field) (CIRCLEQ_PREV(elm, field) != CIRCLEQ_END(head) ? CIRCLEQ_PREV(elm, field) : NULL)
  28 #define FOR_TABLE(workspace)                             \
  29     for (int cols = 0; cols < (workspace)->cols; cols++) \
  30         for (int rows = 0; rows < (workspace)->rows; rows++)
  31
  32 #define NODES_FOREACH(head)                                                    \
  33     for (Con *child = (Con *)-1; (child == (Con *)-1) && ((child = 0), true);) \
  34     TAILQ_FOREACH(child, &((head)->nodes_head), nodes)
  35
  36 #define NODES_FOREACH_REVERSE(head)                                            \
  37     for (Con *child = (Con *)-1; (child == (Con *)-1) && ((child = 0), true);) \
  38     TAILQ_FOREACH_REVERSE(child, &((head)->nodes_head), nodes_head, nodes)
  39
  40 /* greps the ->nodes of the given head and returns the first node that matches the given condition */
  41 #define GREP_FIRST(dest, head, condition) \
  42     NODES_FOREACH(head) {                 \
  43         if (!(condition))                 \
  44             continue;                     \
  45                                           \
  46         (dest) = child;                   \
  47         break;                            \
  48     }
  49
  50 #define FREE(pointer)          \
  51     do {                       \
  52         if (pointer != NULL) { \
  53             free(pointer);     \
  54             pointer = NULL;    \
  55         }                      \
  56     } while (0)
  57
  58 #define CALL(obj, member, ...) obj->member(obj, ##__VA_ARGS__)
  59
  60 #define SWAP(first, second, type) \
  61     do {                          \
  62         type tmp_SWAP = first;    \
  63         first = second;           \
  64         second = tmp_SWAP;        \
  65     } while (0)
  66
  67 int min(int a, int b);
  68 int max(int a, int b);
  69 bool rect_contains(Rect rect, uint32_t x, uint32_t y);
  70 Rect rect_add(Rect a, Rect b);
  71 Rect rect_sub(Rect a, Rect b);
  72
  73 /**
  74  * Returns true if the name consists of only digits.
  75  *
  76  */
  77 __attribute__((pure)) bool name_is_digits(const char *name);
  78
  79 /**
  80  * Set 'out' to the layout_t value for the given layout. The function
  81  * returns true on success or false if the passed string is not a valid
  82  * layout name.
  83  *
  84  */
  85 bool layout_from_name(const char *layout_str, layout_t *out);
  86
  87 /**
  88  * Parses the workspace name as a number. Returns -1 if the workspace should be
  89  * interpreted as a "named workspace".
  90  *
  91  */
  92 long ws_name_to_number(const char *name);
  93
  94 /**
  95  * Updates *destination with new_value and returns true if it was changed or false
  96  * if it was the same
  97  *
  98  */
  99 bool update_if_necessary(uint32_t *destination, const uint32_t new_value);
 100
 101 /**
 102  * exec()s an i3 utility, for example the config file migration script or
 103  * i3-nagbar. This function first searches $PATH for the given utility named,
 104  * then falls back to the dirname() of the i3 executable path and then falls
 105  * back to the dirname() of the target of /proc/self/exe (on linux).
 106  *
 107  * This function should be called after fork()ing.
 108  *
 109  * The first argument of the given argv vector will be overwritten with the
 110  * executable name, so pass NULL.
 111  *
 112  * If the utility cannot be found in any of these locations, it exits with
 113  * return code 2.
 114  *
 115  */
 116 void exec_i3_utility(char *name, char *argv[]);
 117
 118 /**
 119  * Checks if the given path exists by calling stat().
 120  *
 121  */
 122 bool path_exists(const char *path);
 123
 124 /**
 125  * Restart i3 in-place
 126  * appends -a to argument list to disable autostart
 127  *
 128  */
 129 void i3_restart(bool forget_layout);
 130
 131 #if defined(__OpenBSD__) || defined(__APPLE__)
 132
 133 /*
 134  * Taken from FreeBSD
 135  * Find the first occurrence of the byte string s in byte string l.
 136  *
 137  */
 138 void *memmem(const void *l, size_t l_len, const void *s, size_t s_len);
 139
 140 #endif
 141
 142 /**
 143  * Escapes the given string if a pango font is currently used.
 144  * If the string has to be escaped, the input string will be free'd.
 145  *
 146  */
 147 char *pango_escape_markup(char *input);
 148
 149 /**
 150  * Starts an i3-nagbar instance with the given parameters. Takes care of
 151  * handling SIGCHLD and killing i3-nagbar when i3 exits.
 152  *
 153  * The resulting PID will be stored in *nagbar_pid and can be used with
 154  * kill_nagbar() to kill the bar later on.
 155  *
 156  */
 157 void start_nagbar(pid_t *nagbar_pid, char *argv[]);
 158
 159 /**
 160  * Kills the i3-nagbar process, if *nagbar_pid != -1.
 161  *
 162  * If wait_for_it is set (restarting i3), this function will waitpid(),
 163  * otherwise, ev is assumed to handle it (reloading).
 164  *
 165  */
 166 void kill_nagbar(pid_t *nagbar_pid, bool wait_for_it);
 167
 168 /**
 169  * Converts a string into a long using strtol().
 170  * This is a convenience wrapper checking the parsing result. It returns true
 171  * if the number could be parsed.
 172  */
 173 bool parse_long(const char *str, long *out, int base);
 174
 175 /**
 176  * Slurp reads path in its entirety into buf, returning the length of the file
 177  * or -1 if the file could not be read. buf is set to a buffer of appropriate
 178  * size, or NULL if -1 is returned.
 179  *
 180  */
 181 ssize_t slurp(const char *path, char **buf);