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, ...) { if (pointer == NULL) die(__VA_ARGS__); }
19 #define STARTS_WITH(string, needle) (strncasecmp(string, needle, strlen(needle)) == 0)
20 #define CIRCLEQ_NEXT_OR_NULL(head, elm, field) (CIRCLEQ_NEXT(elm, field) != CIRCLEQ_END(head) ? \
21 CIRCLEQ_NEXT(elm, field) : NULL)
22 #define CIRCLEQ_PREV_OR_NULL(head, elm, field) (CIRCLEQ_PREV(elm, field) != CIRCLEQ_END(head) ? \
23 CIRCLEQ_PREV(elm, field) : NULL)
24 #define FOR_TABLE(workspace) \
25 for (int cols = 0; cols < (workspace)->cols; cols++) \
26 for (int rows = 0; rows < (workspace)->rows; rows++)
28 #define NODES_FOREACH(head) \
29 for (Con *child = (Con*)-1; (child == (Con*)-1) && ((child = 0), true);) \
30 TAILQ_FOREACH(child, &((head)->nodes_head), nodes)
32 #define NODES_FOREACH_REVERSE(head) \
33 for (Con *child = (Con*)-1; (child == (Con*)-1) && ((child = 0), true);) \
34 TAILQ_FOREACH_REVERSE(child, &((head)->nodes_head), nodes_head, nodes)
36 /* greps the ->nodes of the given head and returns the first node that matches the given condition */
37 #define GREP_FIRST(dest, head, condition) \
38 NODES_FOREACH(head) { \
46 #define FREE(pointer) do { \
47 if (pointer != NULL) { \
54 #define CALL(obj, member, ...) obj->member(obj, ## __VA_ARGS__)
56 int min(int a, int b);
57 int max(int a, int b);
58 bool rect_contains(Rect rect, uint32_t x, uint32_t y);
59 Rect rect_add(Rect a, Rect b);
62 * Updates *destination with new_value and returns true if it was changed or false
66 bool update_if_necessary(uint32_t *destination, const uint32_t new_value);
69 * exec()s an i3 utility, for example the config file migration script or
70 * i3-nagbar. This function first searches $PATH for the given utility named,
71 * then falls back to the dirname() of the i3 executable path and then falls
72 * back to the dirname() of the target of /proc/self/exe (on linux).
74 * This function should be called after fork()ing.
76 * The first argument of the given argv vector will be overwritten with the
77 * executable name, so pass NULL.
79 * If the utility cannot be found in any of these locations, it exits with
83 void exec_i3_utility(char *name, char *argv[]);
86 * Checks a generic cookie for errors and quits with the given message if
90 void check_error(xcb_connection_t *conn, xcb_void_cookie_t cookie,
94 * This function resolves ~ in pathnames.
95 * It may resolve wildcards in the first part of the path, but if no match
96 * or multiple matches are found, it just returns a copy of path as given.
99 char *resolve_tilde(const char *path);
102 * Checks if the given path exists by calling stat().
105 bool path_exists(const char *path);
108 * Restart i3 in-place
109 * appends -a to argument list to disable autostart
112 void i3_restart(bool forget_layout);
114 #if defined(__OpenBSD__) || defined(__APPLE__)
118 * Find the first occurrence of the byte string s in byte string l.
121 void *memmem(const void *l, size_t l_len, const void *s, size_t s_len);
126 * Starts an i3-nagbar instance with the given parameters. Takes care of
127 * handling SIGCHLD and killing i3-nagbar when i3 exits.
129 * The resulting PID will be stored in *nagbar_pid and can be used with
130 * kill_nagbar() to kill the bar later on.
133 void start_nagbar(pid_t *nagbar_pid, char *argv[]);
136 * Kills the i3-nagbar process, if *nagbar_pid != -1.
138 * If wait_for_it is set (restarting i3), this function will waitpid(),
139 * otherwise, ev is assumed to handle it (reloading).
142 void kill_nagbar(pid_t *nagbar_pid, bool wait_for_it);