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
18 #define die(...) errx(EXIT_FAILURE, __VA_ARGS__);
19 #define exit_if_null(pointer, ...) { if (pointer == NULL) die(__VA_ARGS__); }
20 #define STARTS_WITH(string, needle) (strncasecmp(string, needle, strlen(needle)) == 0)
21 #define CIRCLEQ_NEXT_OR_NULL(head, elm, field) (CIRCLEQ_NEXT(elm, field) != CIRCLEQ_END(head) ? \
22 CIRCLEQ_NEXT(elm, field) : NULL)
23 #define CIRCLEQ_PREV_OR_NULL(head, elm, field) (CIRCLEQ_PREV(elm, field) != CIRCLEQ_END(head) ? \
24 CIRCLEQ_PREV(elm, field) : NULL)
25 #define FOR_TABLE(workspace) \
26 for (int cols = 0; cols < (workspace)->cols; cols++) \
27 for (int rows = 0; rows < (workspace)->rows; rows++)
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)
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)
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) { \
47 #define FREE(pointer) do { \
48 if (pointer != NULL) { \
55 #define CALL(obj, member, ...) obj->member(obj, ## __VA_ARGS__)
57 int min(int a, int b);
58 int max(int a, int b);
59 bool rect_contains(Rect rect, uint32_t x, uint32_t y);
60 Rect rect_add(Rect a, Rect b);
63 * Updates *destination with new_value and returns true if it was changed or false
67 bool update_if_necessary(uint32_t *destination, const uint32_t new_value);
70 * exec()s an i3 utility, for example the config file migration script or
71 * i3-nagbar. This function first searches $PATH for the given utility named,
72 * then falls back to the dirname() of the i3 executable path and then falls
73 * back to the dirname() of the target of /proc/self/exe (on linux).
75 * This function should be called after fork()ing.
77 * The first argument of the given argv vector will be overwritten with the
78 * executable name, so pass NULL.
80 * If the utility cannot be found in any of these locations, it exits with
84 void exec_i3_utility(char *name, char *argv[]);
87 * Checks a generic cookie for errors and quits with the given message if
91 void check_error(xcb_connection_t *conn, xcb_void_cookie_t cookie,
95 * This function resolves ~ in pathnames.
96 * It may resolve wildcards in the first part of the path, but if no match
97 * or multiple matches are found, it just returns a copy of path as given.
100 char *resolve_tilde(const char *path);
103 * Checks if the given path exists by calling stat().
106 bool path_exists(const char *path);
110 * Returns the name of a temporary file with the specified prefix.
113 char *get_process_filename(const char *prefix);
116 * Restart i3 in-place
117 * appends -a to argument list to disable autostart
120 void i3_restart(bool forget_layout);
122 #if defined(__OpenBSD__) || defined(__APPLE__)
126 * Find the first occurrence of the byte string s in byte string l.
129 void *memmem(const void *l, size_t l_len, const void *s, size_t s_len);