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 #pragma once
12 
13 #include <err.h>
14 
15 #include "data.h"
16 
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++)
27 
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)
31 
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)
35 
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) { \
39  if (!(condition)) \
40  continue; \
41  \
42  (dest) = child; \
43  break; \
44  }
45 
46 #define FREE(pointer) do { \
47  if (pointer != NULL) { \
48  free(pointer); \
49  pointer = NULL; \
50  } \
51 } \
52 while (0)
53 
54 #define CALL(obj, member, ...) obj->member(obj, ## __VA_ARGS__)
55 
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);
60 Rect rect_sub(Rect a, Rect b);
61 
66 __attribute__((pure)) bool name_is_digits(const char *name);
67 
73 long ws_name_to_number(const char *name);
74 
80 bool update_if_necessary(uint32_t *destination, const uint32_t new_value);
81 
97 void exec_i3_utility(char *name, char *argv[]);
98 
104 void check_error(xcb_connection_t *conn, xcb_void_cookie_t cookie,
105  char *err_message);
106 
113 char *resolve_tilde(const char *path);
114 
119 bool path_exists(const char *path);
120 
126 void i3_restart(bool forget_layout);
127 
128 #if defined(__OpenBSD__) || defined(__APPLE__)
129 
130 /*
131  * Taken from FreeBSD
132  * Find the first occurrence of the byte string s in byte string l.
133  *
134  */
135 void *memmem(const void *l, size_t l_len, const void *s, size_t s_len);
136 
137 #endif
138 
147 void start_nagbar(pid_t *nagbar_pid, char *argv[]);
148 
156 void kill_nagbar(pid_t *nagbar_pid, bool wait_for_it);
void i3_restart(bool forget_layout)
Restart i3 in-place appends -a to argument list to disable autostart.
Definition: util.c:294
xcb_connection_t * conn
Definition: main.c:47
Stores a rectangle, for example the size of a window, the child window etc.
Definition: data.h:122
__attribute__((pure)) bool name_is_digits(const char *name)
Returns true if the name consists of only digits.
bool path_exists(const char *path)
Checks if the given path exists by calling stat().
Definition: util.c:198
bool rect_contains(Rect rect, uint32_t x, uint32_t y)
Definition: util.c:37
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:116
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:95
int max(int a, int b)
Definition: util.c:33
Rect rect_add(Rect a, Rect b)
Definition: util.c:44
Rect rect_sub(Rect a, Rect b)
Definition: util.c:51
void kill_nagbar(pid_t *nagbar_pid, bool wait_for_it)
Kills the i3-nagbar process, if *nagbar_pid != -1.
Definition: util.c:460
uint32_t y
Definition: data.h:31
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:153
char * resolve_tilde(const char *path)
This function resolves ~ in pathnames.
Definition: util.c:168
void start_nagbar(pid_t *nagbar_pid, char *argv[])
Starts an i3-nagbar instance with the given parameters.
Definition: util.c:420
uint32_t x
Definition: data.h:30
long ws_name_to_number(const char *name)
Parses the workspace name as a number.
Definition: util.c:76
int min(int a, int b)
Definition: util.c:29