]> git.sur5r.net Git - i3/i3/blob - include/util.h
68009442e4b24afc1df2d685e09688cdb93ee0d4
[i3/i3] / include / util.h
1 /*
2  * vim:ts=8:expandtab
3  *
4  * i3 - an improved dynamic tiling window manager
5  *
6  * © 2009 Michael Stapelberg and contributors
7  *
8  * See file LICENSE for license information.
9  *
10  */
11 #include <err.h>
12
13 #include "data.h"
14
15 #ifndef _UTIL_H
16 #define _UTIL_H
17
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++)
28
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)
32
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)
36
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) { \
40         if (!(condition)) \
41             continue; \
42         \
43         (dest) = child; \
44         break; \
45     }
46
47 #define FREE(pointer) do { \
48         if (pointer != NULL) { \
49                 free(pointer); \
50                 pointer = NULL; \
51         } \
52 } \
53 while (0)
54
55 #define CALL(obj, member, ...) obj->member(obj, ## __VA_ARGS__)
56
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);
61
62 /**
63  * Updates *destination with new_value and returns true if it was changed or false
64  * if it was the same
65  *
66  */
67 bool update_if_necessary(uint32_t *destination, const uint32_t new_value);
68
69 /**
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).
74  *
75  * This function should be called after fork()ing.
76  *
77  * The first argument of the given argv vector will be overwritten with the
78  * executable name, so pass NULL.
79  *
80  * If the utility cannot be found in any of these locations, it exits with
81  * return code 2.
82  *
83  */
84 void exec_i3_utility(char *name, char *argv[]);
85
86 /**
87  * Checks a generic cookie for errors and quits with the given message if
88  * there was an error.
89  *
90  */
91 void check_error(xcb_connection_t *conn, xcb_void_cookie_t cookie,
92                  char *err_message);
93
94 /**
95  * Converts the given string to UCS-2 big endian for use with
96  * xcb_image_text_16(). The amount of real glyphs is stored in real_strlen, a
97  * buffer containing the UCS-2 encoded string (16 bit per glyph) is
98  * returned. It has to be freed when done.
99  *
100  */
101 char *convert_utf8_to_ucs2(char *input, int *real_strlen);
102
103 /**
104  * This function resolves ~ in pathnames.
105  * It may resolve wildcards in the first part of the path, but if no match
106  * or multiple matches are found, it just returns a copy of path as given.
107  *
108  */
109 char *resolve_tilde(const char *path);
110
111 /**
112  * Checks if the given path exists by calling stat().
113  *
114  */
115 bool path_exists(const char *path);
116
117
118 /**
119  * Returns the name of a temporary file with the specified prefix.
120  *
121  */
122 char *get_process_filename(const char *prefix);
123
124 /**
125  * Restart i3 in-place
126  * appends -a to argument list to disable autostart
127  *
128  */
129 void i3_restart(bool forget_layout);
130
131 #if defined(__OpenBSD__) || defined(__APPLE__)
132
133 /*
134  * Taken from FreeBSD
135  * Find the first occurrence of the byte string s in byte string l.
136  *
137  */
138 void *memmem(const void *l, size_t l_len, const void *s, size_t s_len);
139
140 #endif
141
142 #endif