#include <config.h>
#include <err.h>
#include "data.h"

Include dependency graph for util.h:

This graph shows which files directly or indirectly include this file:

Macros
#define	die(...) errx(EXIT_FAILURE, __VA_ARGS__);

#define	exit_if_null(pointer, ...)

#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	FOR_TABLE(workspace)

#define	NODES_FOREACH(head)

#define	NODES_FOREACH_REVERSE(head)

#define	GREP_FIRST(dest, head, condition)

#define	FREE(pointer)

#define	CALL(obj, member, ...) obj->member(obj, ##__VA_ARGS__)

Functions
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)

	__attribute__ ((pure)) bool name_is_digits(const char *name)
	Returns true if the name consists of only digits. More...

long	ws_name_to_number (const char *name)
	Parses the workspace name as a number. More...

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. More...

void	exec_i3_utility (char name, char argv[])
	exec()s an i3 utility, for example the config file migration script or i3-nagbar. More...

bool	path_exists (const char *path)
	Checks if the given path exists by calling stat(). More...

void	i3_restart (bool forget_layout)
	Restart i3 in-place appends -a to argument list to disable autostart. More...

char *	pango_escape_markup (char *input)
	Escapes the given string if a pango font is currently used. More...

void	start_nagbar (pid_t nagbar_pid, char argv[])
	Starts an i3-nagbar instance with the given parameters. More...

void	kill_nagbar (pid_t *nagbar_pid, bool wait_for_it)
	Kills the i3-nagbar process, if *nagbar_pid != -1. More...

Macro Definition Documentation

◆ CALL

#define CALL	(	obj,
		member,
		...
	)	obj->member(obj, ##__VA_ARGS__)

Definition at line 58 of file util.h.

Referenced by _con_move_to_con(), attach_to_workspace(), insert_con_into(), tree_close_internal(), and workspace_move_to_output().

◆ CIRCLEQ_NEXT_OR_NULL

#define CIRCLEQ_NEXT_OR_NULL	(	head,
		elm,
		field
	)	(CIRCLEQ_NEXT(elm, field) != CIRCLEQ_END(head) ? CIRCLEQ_NEXT(elm, field) : NULL)

Definition at line 26 of file util.h.

◆ CIRCLEQ_PREV_OR_NULL

#define CIRCLEQ_PREV_OR_NULL	(	head,
		elm,
		field
	)	(CIRCLEQ_PREV(elm, field) != CIRCLEQ_END(head) ? CIRCLEQ_PREV(elm, field) : NULL)

Definition at line 27 of file util.h.

◆ die

#define die ( ... ) errx(EXIT_FAILURE, __VA_ARGS__);

Definition at line 19 of file util.h.

Referenced by get_first_output(), main(), parse_configuration(), and parse_file().

◆ exit_if_null

#define exit_if_null	(	pointer,
		...
	)

Value:

{                              \
        if (pointer == NULL)       \
            die(__VA_ARGS__);      \
    }

Definition at line 20 of file util.h.

◆ FOR_TABLE

#define FOR_TABLE ( workspace )

Value:

for (int cols = 0; cols < (workspace)->cols; cols++) \

for (int rows = 0; rows < (workspace)->rows; rows++)

Definition at line 28 of file util.h.

◆ FREE

#define FREE ( pointer )

Value:

do {                       \
        if (pointer != NULL) { \
            free(pointer);     \
            pointer = NULL;    \
        }                      \
    } while (0)

Definition at line 50 of file util.h.

Referenced by _create___i3(), _workspace_show(), backtrace(), binding_free(), CFGFUN(), cmd_criteria_match_windows(), cmd_rename_workspace(), cmd_title_format(), command_result_free(), con_force_split_parents_redraw(), con_parse_title_format(), con_unmark(), configure_binding(), extract_workspace_names_from_bindings(), floating_move_to_pointer(), handle_normal_hints(), handle_output(), handle_windowname_change(), handle_windowname_change_legacy(), ipc_create_socket(), ipc_receive_message(), json_end_map(), json_key(), load_configuration(), main(), manage_window(), match_free(), migrate_config(), move_to_output_directed(), output_init_con(), pango_escape_markup(), parse_configuration(), parse_file(), property_notify(), randr_query_outputs(), regex_free(), regrab_all_buttons(), render_con(), startup_sequence_delete(), startup_sequence_get(), switch_mode(), translate_keysyms(), tree_close_internal(), tree_init(), tree_move(), upsert_variable(), window_free(), window_update_class(), window_update_hints(), window_update_leader(), window_update_motif_hints(), window_update_name(), window_update_name_legacy(), window_update_role(), window_update_strut_partial(), window_update_transient_for(), workspace_defer_update_urgent_hint_cb(), workspace_get(), x_con_kill(), x_draw_decoration(), x_push_node(), x_set_name(), xcb_drag_check_cb(), xcb_remove_property_atom(), and xinerama_init().

◆ GREP_FIRST

#define GREP_FIRST	(	dest,
		head,
		condition
	)

Value:

NODES_FOREACH(head) {                 \
        if (!(condition))                 \
            continue;                     \
                                          \
        (dest) = child;                   \
        break;                            \
    }

Definition at line 41 of file util.h.

Referenced by _tree_next(), cmd_focus_output(), cmd_move_con_to_output(), cmd_move_con_to_workspace_number(), cmd_rename_workspace(), cmd_workspace_number(), con_move_to_output(), create_workspace_on_output(), init_ws_for_output(), json_end_map(), move_to_output_directed(), output_push_sticky_windows(), workspace_get(), and workspace_move_to_output().

◆ NODES_FOREACH

#define NODES_FOREACH ( head )

Value:

for (Con *child = (Con *)-1; (child == (Con *)-1) && ((child = 0), true);) \

TAILQ_FOREACH(child, &((head)->nodes_head), nodes)

TAILQ_FOREACH

#define TAILQ_FOREACH(var, head, field)

Definition: queue.h:347

Con

A 'Con' represents everything from the X11 root window down to a single X11 window.

Definition: data.h:558

Definition at line 32 of file util.h.

Referenced by workspace_next(), and workspace_next_on_output().

◆ NODES_FOREACH_REVERSE

#define NODES_FOREACH_REVERSE ( head )

Value:

for (Con *child = (Con *)-1; (child == (Con *)-1) && ((child = 0), true);) \

TAILQ_FOREACH_REVERSE(child, &((head)->nodes_head), nodes_head, nodes)

TAILQ_FOREACH_REVERSE

#define TAILQ_FOREACH_REVERSE(var, head, headname, field)

Definition: queue.h:352

Con

A 'Con' represents everything from the X11 root window down to a single X11 window.

Definition: data.h:558

Definition at line 36 of file util.h.

Referenced by workspace_prev(), and workspace_prev_on_output().

◆ STARTS_WITH

#define STARTS_WITH	(	string,
		needle
	)	(strncasecmp((string), (needle), strlen((needle))) == 0)

Definition at line 25 of file util.h.

Referenced by ewmh_update_desktop_names(), ewmh_update_desktop_viewport(), and ewmh_update_number_of_desktops().

Function Documentation

◆ attribute()

__attribute__ ( (pure) ) const

Returns true if the name consists of only digits.

◆ exec_i3_utility()

void exec_i3_utility	(	char *	name,
		char *	argv[]
	)

exec()s an i3 utility, for example the config file migration script or i3-nagbar.

This function first searches $PATH for the given utility named, then falls back to the dirname() of the i3 executable path and then falls back to the dirname() of the target of /proc/self/exe (on linux).

This function should be called after fork()ing.

The first argument of the given argv vector will be overwritten with the executable name, so pass NULL.

If the utility cannot be found in any of these locations, it exits with return code 2.

Definition at line 114 of file util.c.

References sasprintf(), sstrdup(), and start_argv.

Referenced by migrate_config(), and start_nagbar().

Here is the call graph for this function: