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 int min(int a, int b);
  61 int max(int a, int b);
  62 bool rect_contains(Rect rect, uint32_t x, uint32_t y);
  63 Rect rect_add(Rect a, Rect b);
  64 Rect rect_sub(Rect a, Rect b);
  65
  66 /**
  67  * Returns true if the name consists of only digits.
  68  *
  69  */
  70 __attribute__((pure)) bool name_is_digits(const char *name);
  71
  72 /**
  73  * Parses the workspace name as a number. Returns -1 if the workspace should be
  74  * interpreted as a "named workspace".
  75  *
  76  */
  77 long ws_name_to_number(const char *name);
  78
  79 /**
  80  * Updates *destination with new_value and returns true if it was changed or false
  81  * if it was the same
  82  *
  83  */
  84 bool update_if_necessary(uint32_t *destination, const uint32_t new_value);
  85
  86 /**
  87  * exec()s an i3 utility, for example the config file migration script or
  88  * i3-nagbar. This function first searches $PATH for the given utility named,
  89  * then falls back to the dirname() of the i3 executable path and then falls
  90  * back to the dirname() of the target of /proc/self/exe (on linux).
  91  *
  92  * This function should be called after fork()ing.
  93  *
  94  * The first argument of the given argv vector will be overwritten with the
  95  * executable name, so pass NULL.
  96  *
  97  * If the utility cannot be found in any of these locations, it exits with
  98  * return code 2.
  99  *
 100  */
 101 void exec_i3_utility(char *name, char *argv[]);
 102
 103 /**
 104  * Checks if the given path exists by calling stat().
 105  *
 106  */
 107 bool path_exists(const char *path);
 108
 109 /**
 110  * Restart i3 in-place
 111  * appends -a to argument list to disable autostart
 112  *
 113  */
 114 void i3_restart(bool forget_layout);
 115
 116 #if defined(__OpenBSD__) || defined(__APPLE__)
 117
 118 /*
 119  * Taken from FreeBSD
 120  * Find the first occurrence of the byte string s in byte string l.
 121  *
 122  */
 123 void *memmem(const void *l, size_t l_len, const void *s, size_t s_len);
 124
 125 #endif
 126
 127 /**
 128  * Escapes the given string if a pango font is currently used.
 129  * If the string has to be escaped, the input string will be free'd.
 130  *
 131  */
 132 char *pango_escape_markup(char *input);
 133
 134 /**
 135  * Starts an i3-nagbar instance with the given parameters. Takes care of
 136  * handling SIGCHLD and killing i3-nagbar when i3 exits.
 137  *
 138  * The resulting PID will be stored in *nagbar_pid and can be used with
 139  * kill_nagbar() to kill the bar later on.
 140  *
 141  */
 142 void start_nagbar(pid_t *nagbar_pid, char *argv[]);
 143
 144 /**
 145  * Kills the i3-nagbar process, if *nagbar_pid != -1.
 146  *
 147  * If wait_for_it is set (restarting i3), this function will waitpid(),
 148  * otherwise, ev is assumed to handle it (reloading).
 149  *
 150  */
 151 void kill_nagbar(pid_t *nagbar_pid, bool wait_for_it);