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
  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)   \
  48     do {                \
  49         free(pointer);  \
  50         pointer = NULL; \
  51     } while (0)
  52
  53 #define CALL(obj, member, ...) obj->member(obj, ##__VA_ARGS__)
  54
  55 #define SWAP(first, second, type) \
  56     do {                          \
  57         type tmp_SWAP = first;    \
  58         first = second;           \
  59         second = tmp_SWAP;        \
  60     } while (0)
  61
  62 int min(int a, int b);
  63 int max(int a, int b);
  64 bool rect_contains(Rect rect, uint32_t x, uint32_t y);
  65 Rect rect_add(Rect a, Rect b);
  66 Rect rect_sub(Rect a, Rect b);
  67
  68 /**
  69  * Returns true if the name consists of only digits.
  70  *
  71  */
  72 __attribute__((pure)) bool name_is_digits(const char *name);
  73
  74 /**
  75  * Set 'out' to the layout_t value for the given layout. The function
  76  * returns true on success or false if the passed string is not a valid
  77  * layout name.
  78  *
  79  */
  80 bool layout_from_name(const char *layout_str, layout_t *out);
  81
  82 /**
  83  * Parses the workspace name as a number. Returns -1 if the workspace should be
  84  * interpreted as a "named workspace".
  85  *
  86  */
  87 long ws_name_to_number(const char *name);
  88
  89 /**
  90  * Updates *destination with new_value and returns true if it was changed or false
  91  * if it was the same
  92  *
  93  */
  94 bool update_if_necessary(uint32_t *destination, const uint32_t new_value);
  95
  96 /**
  97  * exec()s an i3 utility, for example the config file migration script or
  98  * i3-nagbar. This function first searches $PATH for the given utility named,
  99  * then falls back to the dirname() of the i3 executable path and then falls
 100  * back to the dirname() of the target of /proc/self/exe (on linux).
 101  *
 102  * This function should be called after fork()ing.
 103  *
 104  * The first argument of the given argv vector will be overwritten with the
 105  * executable name, so pass NULL.
 106  *
 107  * If the utility cannot be found in any of these locations, it exits with
 108  * return code 2.
 109  *
 110  */
 111 void exec_i3_utility(char *name, char *argv[]);
 112
 113 /**
 114  * Checks if the given path exists by calling stat().
 115  *
 116  */
 117 bool path_exists(const char *path);
 118
 119 /**
 120  * Restart i3 in-place
 121  * appends -a to argument list to disable autostart
 122  *
 123  */
 124 void i3_restart(bool forget_layout);
 125
 126 #if defined(__OpenBSD__) || defined(__APPLE__)
 127
 128 /**
 129  * Taken from FreeBSD
 130  * Find the first occurrence of the byte string s in byte string l.
 131  *
 132  */
 133 void *memmem(const void *l, size_t l_len, const void *s, size_t s_len);
 134
 135 #endif
 136
 137 /**
 138  * Escapes the given string if a pango font is currently used.
 139  * If the string has to be escaped, the input string will be free'd.
 140  *
 141  */
 142 char *pango_escape_markup(char *input);
 143
 144 /**
 145  * Starts an i3-nagbar instance with the given parameters. Takes care of
 146  * handling SIGCHLD and killing i3-nagbar when i3 exits.
 147  *
 148  * The resulting PID will be stored in *nagbar_pid and can be used with
 149  * kill_nagbar() to kill the bar later on.
 150  *
 151  */
 152 void start_nagbar(pid_t *nagbar_pid, char *argv[]);
 153
 154 /**
 155  * Kills the i3-nagbar process, if *nagbar_pid != -1.
 156  *
 157  * If wait_for_it is set (restarting i3), this function will waitpid(),
 158  * otherwise, ev is assumed to handle it (reloading).
 159  *
 160  */
 161 void kill_nagbar(pid_t *nagbar_pid, bool wait_for_it);
 162
 163 /**
 164  * Converts a string into a long using strtol().
 165  * This is a convenience wrapper checking the parsing result. It returns true
 166  * if the number could be parsed.
 167  */
 168 bool parse_long(const char *str, long *out, int base);
 169
 170 /**
 171  * Slurp reads path in its entirety into buf, returning the length of the file
 172  * or -1 if the file could not be read. buf is set to a buffer of appropriate
 173  * size, or NULL if -1 is returned.
 174  *
 175  */
 176 ssize_t slurp(const char *path, char **buf);
 177
 178 /**
 179  * Convert a direction to its corresponding orientation.
 180  *
 181  */
 182 orientation_t orientation_from_direction(direction_t direction);