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 <err.h>
  14
  15 #include "data.h"
  16
  17 #define die(...) errx(EXIT_FAILURE, __VA_ARGS__);
  18 #define exit_if_null(pointer, ...) \
  19     {                              \
  20         if (pointer == NULL)       \
  21             die(__VA_ARGS__);      \
  22     }
  23 #define STARTS_WITH(string, needle) (strncasecmp(string, needle, strlen(needle)) == 0)
  24 #define CIRCLEQ_NEXT_OR_NULL(head, elm, field) (CIRCLEQ_NEXT(elm, field) != CIRCLEQ_END(head) ? CIRCLEQ_NEXT(elm, field) : NULL)
  25 #define CIRCLEQ_PREV_OR_NULL(head, elm, field) (CIRCLEQ_PREV(elm, field) != CIRCLEQ_END(head) ? CIRCLEQ_PREV(elm, field) : NULL)
  26 #define FOR_TABLE(workspace)                             \
  27     for (int cols = 0; cols < (workspace)->cols; cols++) \
  28         for (int rows = 0; rows < (workspace)->rows; rows++)
  29
  30 #define NODES_FOREACH(head)                                                    \
  31     for (Con *child = (Con *)-1; (child == (Con *)-1) && ((child = 0), true);) \
  32     TAILQ_FOREACH(child, &((head)->nodes_head), nodes)
  33
  34 #define NODES_FOREACH_REVERSE(head)                                            \
  35     for (Con *child = (Con *)-1; (child == (Con *)-1) && ((child = 0), true);) \
  36     TAILQ_FOREACH_REVERSE(child, &((head)->nodes_head), nodes_head, nodes)
  37
  38 /* greps the ->nodes of the given head and returns the first node that matches the given condition */
  39 #define GREP_FIRST(dest, head, condition) \
  40     NODES_FOREACH(head) {                 \
  41         if (!(condition))                 \
  42             continue;                     \
  43                                           \
  44         (dest) = child;                   \
  45         break;                            \
  46     }
  47
  48 #define FREE(pointer)          \
  49     do {                       \
  50         if (pointer != NULL) { \
  51             free(pointer);     \
  52             pointer = NULL;    \
  53         }                      \
  54     } while (0)
  55
  56 #define CALL(obj, member, ...) obj->member(obj, ##__VA_ARGS__)
  57
  58 int min(int a, int b);
  59 int max(int a, int b);
  60 bool rect_contains(Rect rect, uint32_t x, uint32_t y);
  61 Rect rect_add(Rect a, Rect b);
  62 Rect rect_sub(Rect a, Rect b);
  63
  64 /**
  65  * Returns true if the name consists of only digits.
  66  *
  67  */
  68 __attribute__((pure)) bool name_is_digits(const char *name);
  69
  70 /**
  71  * Parses the workspace name as a number. Returns -1 if the workspace should be
  72  * interpreted as a "named workspace".
  73  *
  74  */
  75 long ws_name_to_number(const char *name);
  76
  77 /**
  78  * Updates *destination with new_value and returns true if it was changed or false
  79  * if it was the same
  80  *
  81  */
  82 bool update_if_necessary(uint32_t *destination, const uint32_t new_value);
  83
  84 /**
  85  * exec()s an i3 utility, for example the config file migration script or
  86  * i3-nagbar. This function first searches $PATH for the given utility named,
  87  * then falls back to the dirname() of the i3 executable path and then falls
  88  * back to the dirname() of the target of /proc/self/exe (on linux).
  89  *
  90  * This function should be called after fork()ing.
  91  *
  92  * The first argument of the given argv vector will be overwritten with the
  93  * executable name, so pass NULL.
  94  *
  95  * If the utility cannot be found in any of these locations, it exits with
  96  * return code 2.
  97  *
  98  */
  99 void exec_i3_utility(char *name, char *argv[]);
 100
 101 /**
 102  * Checks a generic cookie for errors and quits with the given message if
 103  * there was an error.
 104  *
 105  */
 106 void check_error(xcb_connection_t *conn, xcb_void_cookie_t cookie,
 107                  char *err_message);
 108
 109 /**
 110  * Checks if the given path exists by calling stat().
 111  *
 112  */
 113 bool path_exists(const char *path);
 114
 115 /**
 116  * Restart i3 in-place
 117  * appends -a to argument list to disable autostart
 118  *
 119  */
 120 void i3_restart(bool forget_layout);
 121
 122 #if defined(__OpenBSD__) || defined(__APPLE__)
 123
 124 /*
 125  * Taken from FreeBSD
 126  * Find the first occurrence of the byte string s in byte string l.
 127  *
 128  */
 129 void *memmem(const void *l, size_t l_len, const void *s, size_t s_len);
 130
 131 #endif
 132
 133 /**
 134  * Starts an i3-nagbar instance with the given parameters. Takes care of
 135  * handling SIGCHLD and killing i3-nagbar when i3 exits.
 136  *
 137  * The resulting PID will be stored in *nagbar_pid and can be used with
 138  * kill_nagbar() to kill the bar later on.
 139  *
 140  */
 141 void start_nagbar(pid_t *nagbar_pid, char *argv[]);
 142
 143 /**
 144  * Kills the i3-nagbar process, if *nagbar_pid != -1.
 145  *
 146  * If wait_for_it is set (restarting i3), this function will waitpid(),
 147  * otherwise, ev is assumed to handle it (reloading).
 148  *
 149  */
 150 void kill_nagbar(pid_t *nagbar_pid, bool wait_for_it);