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 <config.h>
14 
15 #include <err.h>
16 
17 #include "data.h"
18 
19 #define die(...) errx(EXIT_FAILURE, __VA_ARGS__);
20 #define exit_if_null(pointer, ...) \
21  { \
22  if (pointer == NULL) \
23  die(__VA_ARGS__); \
24  }
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 
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) \
48  do { \
49  free(pointer); \
50  pointer = NULL; \
51  } while (0)
52 
53 #define CALL(obj, member, ...) obj->member(obj, ##__VA_ARGS__)
54 
55 #define SWAP(first, second, type) \
56  do { \
57  type tmp_SWAP = first; \
58  first = second; \
59  second = tmp_SWAP; \
60  } while (0)
61 
62 int min(int a, int b);
63 int max(int a, int b);
64 bool rect_contains(Rect rect, uint32_t x, uint32_t y);
65 Rect rect_add(Rect a, Rect b);
66 Rect rect_sub(Rect a, Rect b);
67 
72 __attribute__((pure)) bool name_is_digits(const char *name);
73 
80 bool layout_from_name(const char *layout_str, layout_t *out);
81 
87 long ws_name_to_number(const char *name);
88 
94 bool update_if_necessary(uint32_t *destination, const uint32_t new_value);
95 
111 void exec_i3_utility(char *name, char *argv[]);
112 
117 bool path_exists(const char *path);
118 
124 void i3_restart(bool forget_layout);
125 
126 #if defined(__OpenBSD__) || defined(__APPLE__)
127 
133 void *memmem(const void *l, size_t l_len, const void *s, size_t s_len);
134 
135 #endif
136 
142 char *pango_escape_markup(char *input);
143 
152 void start_nagbar(pid_t *nagbar_pid, char *argv[]);
153 
161 void kill_nagbar(pid_t *nagbar_pid, bool wait_for_it);
162 
168 bool parse_long(const char *str, long *out, int base);
169 
176 ssize_t slurp(const char *path, char **buf);
177 
void start_nagbar(pid_t *nagbar_pid, char *argv[])
Starts an i3-nagbar instance with the given parameters.
Definition: util.c:405
Rect rect_sub(Rect a, Rect b)
Definition: util.c:49
int max(int a, int b)
Definition: util.c:31
bool rect_contains(Rect rect, uint32_t x, uint32_t y)
Definition: util.c:35
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:121
layout_t
Container layouts.
Definition: data.h:91
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:142
ssize_t slurp(const char *path, char **buf)
Slurp reads path in its entirety into buf, returning the length of the file or -1 if the file could n...
Definition: util.c:485
Stores a rectangle, for example the size of a window, the child window etc.
Definition: data.h:157
orientation_t orientation_from_direction(direction_t direction)
Convert a direction to its corresponding orientation.
Definition: util.c:514
void kill_nagbar(pid_t *nagbar_pid, bool wait_for_it)
Kills the i3-nagbar process, if *nagbar_pid != -1.
Definition: util.c:445
void i3_restart(bool forget_layout)
Restart i3 in-place appends -a to argument list to disable autostart.
Definition: util.c:282
int min(int a, int b)
Definition: util.c:27
orientation_t
Definition: data.h:59
Rect rect_add(Rect a, Rect b)
Definition: util.c:42
char * pango_escape_markup(char *input)
Escapes the given string if a pango font is currently used.
Definition: util.c:352
direction_t
Definition: data.h:55
long ws_name_to_number(const char *name)
Parses the workspace name as a number.
Definition: util.c:102
__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:178
bool layout_from_name(const char *layout_str, layout_t *out)
Set &#39;out&#39; to the layout_t value for the given layout.
Definition: util.c:75
uint32_t y
Definition: data.h:128
bool parse_long(const char *str, long *out, int base)
Converts a string into a long using strtol().
Definition: util.c:467
uint32_t x
Definition: data.h:127