2 * vim:ts=4:sw=4:expandtab
4 * i3 - an improved dynamic tiling window manager
5 * © 2009-2011 Michael Stapelberg and contributors (see also: LICENSE)
7 * util.c: Utility functions, which can be useful everywhere within i3 (see
17 #define die(...) errx(EXIT_FAILURE, __VA_ARGS__);
18 #define exit_if_null(pointer, ...) \
20 if (pointer == NULL) \
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++)
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)
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)
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) { \
48 #define FREE(pointer) \
50 if (pointer != NULL) { \
56 #define CALL(obj, member, ...) obj->member(obj, ##__VA_ARGS__)
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);
65 * Returns true if the name consists of only digits.
68 __attribute__((pure)) bool name_is_digits(const char *name);
71 * Parses the workspace name as a number. Returns -1 if the workspace should be
72 * interpreted as a "named workspace".
75 long ws_name_to_number(const char *name);
78 * Updates *destination with new_value and returns true if it was changed or false
82 bool update_if_necessary(uint32_t *destination, const uint32_t new_value);
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).
90 * This function should be called after fork()ing.
92 * The first argument of the given argv vector will be overwritten with the
93 * executable name, so pass NULL.
95 * If the utility cannot be found in any of these locations, it exits with
99 void exec_i3_utility(char *name, char *argv[]);
102 * Checks a generic cookie for errors and quits with the given message if
103 * there was an error.
106 void check_error(xcb_connection_t *conn, xcb_void_cookie_t cookie,
110 * This function resolves ~ in pathnames.
111 * It may resolve wildcards in the first part of the path, but if no match
112 * or multiple matches are found, it just returns a copy of path as given.
115 char *resolve_tilde(const char *path);
118 * Checks if the given path exists by calling stat().
121 bool path_exists(const char *path);
124 * Restart i3 in-place
125 * appends -a to argument list to disable autostart
128 void i3_restart(bool forget_layout);
130 #if defined(__OpenBSD__) || defined(__APPLE__)
134 * Find the first occurrence of the byte string s in byte string l.
137 void *memmem(const void *l, size_t l_len, const void *s, size_t s_len);
142 * Starts an i3-nagbar instance with the given parameters. Takes care of
143 * handling SIGCHLD and killing i3-nagbar when i3 exits.
145 * The resulting PID will be stored in *nagbar_pid and can be used with
146 * kill_nagbar() to kill the bar later on.
149 void start_nagbar(pid_t *nagbar_pid, char *argv[]);
152 * Kills the i3-nagbar process, if *nagbar_pid != -1.
154 * If wait_for_it is set (restarting i3), this function will waitpid(),
155 * otherwise, ev is assumed to handle it (reloading).
158 void kill_nagbar(pid_t *nagbar_pid, bool wait_for_it);