i3
util.h
Go to the documentation of this file.
1/*
2 * vim:ts=4:sw=4:expandtab
3 *
4 * i3 - an improved 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
62int min(int a, int b);
63int max(int a, int b);
64bool rect_contains(Rect rect, uint32_t x, uint32_t y);
67bool rect_equals(Rect a, Rect b);
69
74__attribute__((pure)) bool name_is_digits(const char *name);
75
82bool layout_from_name(const char *layout_str, layout_t *out);
83
89int ws_name_to_number(const char *name);
90
96bool update_if_necessary(uint32_t *destination, const uint32_t new_value);
97
113void exec_i3_utility(char *name, char *argv[]);
114
119bool path_exists(const char *path);
120
126void i3_restart(bool forget_layout);
127
133char *pango_escape_markup(char *input);
134
143void start_nagbar(pid_t *nagbar_pid, char *argv[]);
144
152void kill_nagbar(pid_t nagbar_pid, bool wait_for_it);
153
159bool parse_long(const char *str, long *out, int base);
160
167ssize_t slurp(const char *path, char **buf);
168
174
180
186
191const char *direction_to_string(direction_t direction);
192
197const char *position_to_string(position_t position);
#define y(x,...)
Definition commands.c:18
position_t
Definition data.h:63
layout_t
Container layouts.
Definition data.h:101
orientation_t
Definition data.h:60
direction_t
Definition data.h:56
orientation_t orientation_from_direction(direction_t direction)
Convert a direction to its corresponding orientation.
Definition util.c:466
position_t position_from_direction(direction_t direction)
Convert a direction to its corresponding position.
Definition util.c:474
int ws_name_to_number(const char *name)
Parses the workspace name as a number.
Definition util.c:111
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:149
bool rect_contains(Rect rect, uint32_t x, uint32_t y)
Definition util.c:32
void start_nagbar(pid_t *nagbar_pid, char *argv[])
Starts an i3-nagbar instance with the given parameters.
Definition util.c:360
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:128
void kill_nagbar(pid_t nagbar_pid, bool wait_for_it)
Kills the i3-nagbar process, if nagbar_pid != -1.
Definition util.c:394
void i3_restart(bool forget_layout)
Restart i3 in-place appends -a to argument list to disable autostart.
Definition util.c:283
Rect rect_add(Rect a, Rect b)
Definition util.c:39
char * pango_escape_markup(char *input)
Escapes the given string if a pango font is currently used.
Definition util.c:317
bool parse_long(const char *str, long *out, int base)
Converts a string into a long using strtol().
Definition util.c:419
bool path_exists(const char *path)
Checks if the given path exists by calling stat().
bool rect_equals(Rect a, Rect b)
Definition util.c:59
const char * position_to_string(position_t position)
Converts position to a string representation.
Definition util.c:512
const char * direction_to_string(direction_t direction)
Converts direction to a string representation.
Definition util.c:494
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:437
__attribute__((pure)) bool name_is_digits(const char *name)
Returns true if the name consists of only digits.
int min(int a, int b)
Definition util.c:24
bool layout_from_name(const char *layout_str, layout_t *out)
Set 'out' to the layout_t value for the given layout.
Definition util.c:84
direction_t direction_from_orientation_position(orientation_t orientation, position_t position)
Convert orientation and position to the corresponding direction.
Definition util.c:482
Rect rect_sub(Rect a, Rect b)
Definition util.c:46
Rect rect_sanitize_dimensions(Rect rect)
Definition util.c:53
int max(int a, int b)
Definition util.c:28
Stores a rectangle, for example the size of a window, the child window etc.
Definition data.h:185