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 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, ...) \
19  { \
20  if (pointer == NULL) \
21  die(__VA_ARGS__); \
22  }
23 #define STARTS_WITH(string, needle) (strncasecmp((string), (needle), strlen((needle))) == 0)
24 #define CIRCLEQ_NEXT_OR_NULL(head, elm, field) (CIRCLEQ_NEXT(elm, field) != CIRCLEQ_END(head) ? CIRCLEQ_NEXT(elm, field) : NULL)
25 #define CIRCLEQ_PREV_OR_NULL(head, elm, field) (CIRCLEQ_PREV(elm, field) != CIRCLEQ_END(head) ? CIRCLEQ_PREV(elm, field) : NULL)
26 #define FOR_TABLE(workspace) \
27  for (int cols = 0; cols < (workspace)->cols; cols++) \
28  for (int rows = 0; rows < (workspace)->rows; rows++)
29 
30 #define NODES_FOREACH(head) \
31  for (Con *child = (Con *)-1; (child == (Con *)-1) && ((child = 0), true);) \
32  TAILQ_FOREACH(child, &((head)->nodes_head), nodes)
33 
34 #define NODES_FOREACH_REVERSE(head) \
35  for (Con *child = (Con *)-1; (child == (Con *)-1) && ((child = 0), true);) \
36  TAILQ_FOREACH_REVERSE(child, &((head)->nodes_head), nodes_head, nodes)
37 
38 /* greps the ->nodes of the given head and returns the first node that matches the given condition */
39 #define GREP_FIRST(dest, head, condition) \
40  NODES_FOREACH(head) { \
41  if (!(condition)) \
42  continue; \
43  \
44  (dest) = child; \
45  break; \
46  }
47 
48 #define FREE(pointer) \
49  do { \
50  if (pointer != NULL) { \
51  free(pointer); \
52  pointer = NULL; \
53  } \
54  } while (0)
55 
56 #define CALL(obj, member, ...) obj->member(obj, ##__VA_ARGS__)
57 
58 int min(int a, int b);
59 int max(int a, int b);
60 bool rect_contains(Rect rect, uint32_t x, uint32_t y);
61 Rect rect_add(Rect a, Rect b);
62 Rect rect_sub(Rect a, Rect b);
63 
68 __attribute__((pure)) bool name_is_digits(const char *name);
69 
75 long ws_name_to_number(const char *name);
76 
82 bool update_if_necessary(uint32_t *destination, const uint32_t new_value);
83 
99 void exec_i3_utility(char *name, char *argv[]);
100 
106 void check_error(xcb_connection_t *conn, xcb_void_cookie_t cookie,
107  char *err_message);
108 
113 bool path_exists(const char *path);
114 
120 void i3_restart(bool forget_layout);
121 
122 #if defined(__OpenBSD__) || defined(__APPLE__)
123 
124 /*
125  * Taken from FreeBSD
126  * Find the first occurrence of the byte string s in byte string l.
127  *
128  */
129 void *memmem(const void *l, size_t l_len, const void *s, size_t s_len);
130 
131 #endif
132 
138 char *pango_escape_markup(char *input);
139 
148 void start_nagbar(pid_t *nagbar_pid, char *argv[]);
149 
157 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:270
Rect rect_add(Rect a, Rect b)
Definition: util.c:44
xcb_connection_t * conn
XCB connection and root screen.
Definition: main.c:43
char * pango_escape_markup(char *input)
Escapes the given string if a pango font is currently used.
Definition: util.c:340
void start_nagbar(pid_t *nagbar_pid, char *argv[])
Starts an i3-nagbar instance with the given parameters.
Definition: util.c:393
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:433
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
bool rect_contains(Rect rect, uint32_t x, uint32_t y)
Definition: util.c:37
uint32_t x
Definition: data.h:120
Stores a rectangle, for example the size of a window, the child window etc.
Definition: data.h:141
int min(int a, int b)
Definition: util.c:29
bool path_exists(const char *path)
Checks if the given path exists by calling stat().
Definition: util.c:166
uint32_t y
Definition: data.h:121
int max(int a, int b)
Definition: util.c:33
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
struct reservedpx __attribute__
long ws_name_to_number(const char *name)
Parses the workspace name as a number.
Definition: util.c:76
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