util.h

Go to the documentation of this file.

/*
 * vim:ts=4:sw=4:expandtab
 *
 * i3 - an improved dynamic tiling window manager
 * © 2009 Michael Stapelberg and contributors (see also: LICENSE)
 *
 * util.c: Utility functions, which can be useful everywhere within i3 (see
 *         also libi3).
 *
 */
#pragma once
 
#include <config.h>
 
#include <err.h>
 
#include "data.h"
 
#define die(...) errx(EXIT_FAILURE, __VA_ARGS__);
#define exit_if_null(pointer, ...) \
    {                              \
        if (pointer == NULL)       \
            die(__VA_ARGS__);      \
    }
#define STARTS_WITH(string, needle) (strncasecmp((string), (needle), strlen((needle))) == 0)
#define CIRCLEQ_NEXT_OR_NULL(head, elm, field) (CIRCLEQ_NEXT(elm, field) != CIRCLEQ_END(head) ? CIRCLEQ_NEXT(elm, field) : NULL)
#define CIRCLEQ_PREV_OR_NULL(head, elm, field) (CIRCLEQ_PREV(elm, field) != CIRCLEQ_END(head) ? CIRCLEQ_PREV(elm, field) : NULL)
 
#define NODES_FOREACH(head)                                                    \
    for (Con *child = (Con *)-1; (child == (Con *)-1) && ((child = 0), true);) \
        TAILQ_FOREACH (child, &((head)->nodes_head), nodes)
 
#define NODES_FOREACH_REVERSE(head)                                            \
    for (Con *child = (Con *)-1; (child == (Con *)-1) && ((child = 0), true);) \
        TAILQ_FOREACH_REVERSE (child, &((head)->nodes_head), nodes_head, nodes)
 
/* greps the ->nodes of the given head and returns the first node that matches the given condition */
#define GREP_FIRST(dest, head, condition) \
    NODES_FOREACH (head) {                \
        if (!(condition))                 \
            continue;                     \
                                          \
        (dest) = child;                   \
        break;                            \
    }
 
#define FREE(pointer)   \
    do {                \
        free(pointer);  \
        pointer = NULL; \
    } while (0)
 
#define CALL(obj, member, ...) obj->member(obj, ##__VA_ARGS__)
 
#define SWAP(first, second, type) \
    do {                          \
        type tmp_SWAP = first;    \
        first = second;           \
        second = tmp_SWAP;        \
    } while (0)
 
int min(int a, int b);
int max(int a, int b);
bool rect_contains(Rect rect, uint32_t x, uint32_t y);
Rect rect_add(Rect a, Rect b);
Rect rect_sub(Rect a, Rect b);
bool rect_equals(Rect a, Rect b);
Rect rect_sanitize_dimensions(Rect rect);
 
__attribute__((pure)) bool name_is_digits(const char *name);
 
bool layout_from_name(const char *layout_str, layout_t *out);
 
int ws_name_to_number(const char *name);
 
bool update_if_necessary(uint32_t *destination, const uint32_t new_value);
 
void exec_i3_utility(char *name, char *argv[]);
 
bool path_exists(const char *path);
 
void i3_restart(bool forget_layout);
 
char *pango_escape_markup(char *input);
 
void start_nagbar(pid_t *nagbar_pid, char *argv[]);
 
void kill_nagbar(pid_t nagbar_pid, bool wait_for_it);
 
bool parse_long(const char *str, long *out, int base);
 
ssize_t slurp(const char *path, char **buf);
 
orientation_t orientation_from_direction(direction_t direction);
 
position_t position_from_direction(direction_t direction);
 
direction_t direction_from_orientation_position(orientation_t orientation, position_t position);