i3
util.h
Go to the documentation of this file.
1 /*
2  * vim:ts=4:sw=4:expandtab
3  *
4  * i3 - an improved dynamic tiling window manager
5  * © 2009-2011 Michael Stapelberg and contributors (see also: LICENSE)
6  *
7  * util.c: Utility functions, which can be useful everywhere within i3 (see
8  * also libi3).
9  *
10  */
11 #ifndef I3_UTIL_H
12 #define I3_UTIL_H
13 
14 #include <err.h>
15 
16 #include "data.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 
67 bool update_if_necessary(uint32_t *destination, const uint32_t new_value);
68 
84 void exec_i3_utility(char *name, char *argv[]);
85 
91 void check_error(xcb_connection_t *conn, xcb_void_cookie_t cookie,
92  char *err_message);
93 
100 char *resolve_tilde(const char *path);
101 
106 bool path_exists(const char *path);
107 
113 void i3_restart(bool forget_layout);
114 
115 #if defined(__OpenBSD__) || defined(__APPLE__)
116 
117 /*
118  * Taken from FreeBSD
119  * Find the first occurrence of the byte string s in byte string l.
120  *
121  */
122 void *memmem(const void *l, size_t l_len, const void *s, size_t s_len);
123 
124 #endif
125 
134 void start_nagbar(pid_t *nagbar_pid, char *argv[]);
135 
143 void kill_nagbar(pid_t *nagbar_pid, bool wait_for_it);
144 
145 #endif
bool update_if_necessary(uint32_t *destination, const uint32_t new_value)
Updates *destination with new_value and returns true if it was changed or false if it was the same...
Definition: util.c:55
Stores a rectangle, for example the size of a window, the child window etc.
Definition: data.h:107
char * resolve_tilde(const char *path)
This function resolves ~ in pathnames.
Definition: util.c:128
xcb_connection_t * conn
Definition: main.c:42
int max(int a, int b)
Definition: util.c:32
void kill_nagbar(pid_t *nagbar_pid, bool wait_for_it)
Kills the i3-nagbar process, if *nagbar_pid != -1.
Definition: util.c:431
void exec_i3_utility(char *name, char *argv[])
exec()s an i3 utility, for example the config file migration script or i3-nagbar. ...
Definition: util.c:76
bool rect_contains(Rect rect, uint32_t x, uint32_t y)
Definition: util.c:36
Rect rect_add(Rect a, Rect b)
Definition: util.c:43
uint32_t x
Definition: data.h:30
uint32_t y
Definition: data.h:31
int min(int a, int b)
Definition: util.c:28
void start_nagbar(pid_t *nagbar_pid, char *argv[])
Starts an i3-nagbar instance with the given parameters.
Definition: util.c:391
bool path_exists(const char *path)
Checks if the given path exists by calling stat().
Definition: util.c:158
void i3_restart(bool forget_layout)
Restart i3 in-place appends -a to argument list to disable autostart.
Definition: util.c:266
void check_error(xcb_connection_t *conn, xcb_void_cookie_t cookie, char *err_message)
Checks a generic cookie for errors and quits with the given message if there was an error...
Definition: util.c:113