2 * vim:ts=4:sw=4:expandtab
4 * i3 - an improved dynamic tiling window manager
5 * © 2009 Michael Stapelberg and contributors (see also: LICENSE)
7 * util.c: Utility functions, which can be useful everywhere within i3 (see
19 #define die(...) errx(EXIT_FAILURE, __VA_ARGS__);
20 #define exit_if_null(pointer, ...) \
22 if (pointer == NULL) \
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++)
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)
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)
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) { \
50 #define FREE(pointer) \
56 #define CALL(obj, member, ...) obj->member(obj, ##__VA_ARGS__)
58 #define SWAP(first, second, type) \
60 type tmp_SWAP = first; \
65 int min(int a, int b);
66 int max(int a, int b);
67 bool rect_contains(Rect rect, uint32_t x, uint32_t y);
68 Rect rect_add(Rect a, Rect b);
69 Rect rect_sub(Rect a, Rect b);
72 * Returns true if the name consists of only digits.
75 __attribute__((pure)) bool name_is_digits(const char *name);
78 * Set 'out' to the layout_t value for the given layout. The function
79 * returns true on success or false if the passed string is not a valid
83 bool layout_from_name(const char *layout_str, layout_t *out);
86 * Parses the workspace name as a number. Returns -1 if the workspace should be
87 * interpreted as a "named workspace".
90 long ws_name_to_number(const char *name);
93 * Updates *destination with new_value and returns true if it was changed or false
97 bool update_if_necessary(uint32_t *destination, const uint32_t new_value);
100 * exec()s an i3 utility, for example the config file migration script or
101 * i3-nagbar. This function first searches $PATH for the given utility named,
102 * then falls back to the dirname() of the i3 executable path and then falls
103 * back to the dirname() of the target of /proc/self/exe (on linux).
105 * This function should be called after fork()ing.
107 * The first argument of the given argv vector will be overwritten with the
108 * executable name, so pass NULL.
110 * If the utility cannot be found in any of these locations, it exits with
114 void exec_i3_utility(char *name, char *argv[]);
117 * Checks if the given path exists by calling stat().
120 bool path_exists(const char *path);
123 * Restart i3 in-place
124 * appends -a to argument list to disable autostart
127 void i3_restart(bool forget_layout);
129 #if defined(__OpenBSD__) || defined(__APPLE__)
133 * Find the first occurrence of the byte string s in byte string l.
136 void *memmem(const void *l, size_t l_len, const void *s, size_t s_len);
141 * Escapes the given string if a pango font is currently used.
142 * If the string has to be escaped, the input string will be free'd.
145 char *pango_escape_markup(char *input);
148 * Starts an i3-nagbar instance with the given parameters. Takes care of
149 * handling SIGCHLD and killing i3-nagbar when i3 exits.
151 * The resulting PID will be stored in *nagbar_pid and can be used with
152 * kill_nagbar() to kill the bar later on.
155 void start_nagbar(pid_t *nagbar_pid, char *argv[]);
158 * Kills the i3-nagbar process, if *nagbar_pid != -1.
160 * If wait_for_it is set (restarting i3), this function will waitpid(),
161 * otherwise, ev is assumed to handle it (reloading).
164 void kill_nagbar(pid_t *nagbar_pid, bool wait_for_it);
167 * Converts a string into a long using strtol().
168 * This is a convenience wrapper checking the parsing result. It returns true
169 * if the number could be parsed.
171 bool parse_long(const char *str, long *out, int base);
174 * Slurp reads path in its entirety into buf, returning the length of the file
175 * or -1 if the file could not be read. buf is set to a buffer of appropriate
176 * size, or NULL if -1 is returned.
179 ssize_t slurp(const char *path, char **buf);