i3
Defines | Functions
include/util.h File Reference
#include <err.h>
#include "data.h"
Include dependency graph for util.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Defines

#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)
#define CIRCLEQ_PREV_OR_NULL(head, elm, field)
#define FOR_TABLE(workspace)
#define NODES_FOREACH(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)
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.
void * smalloc (size_t size)
 Safe-wrapper around malloc which exits if malloc returns NULL (meaning that there is no more memory available)
void * scalloc (size_t size)
 Safe-wrapper around calloc which exits if malloc returns NULL (meaning that there is no more memory available)
void * srealloc (void *ptr, size_t size)
 Safe-wrapper around realloc which exits if realloc returns NULL (meaning that there is no more memory available).
char * sstrdup (const char *str)
 Safe-wrapper around strdup which exits if malloc returns NULL (meaning that there is no more memory available)
void start_application (const char *command)
 Starts the given application by passing it through a shell.
void exec_i3_utility (char *name, char *argv[])
 exec()s an i3 utility, for example the config file migration script or i3-nagbar.
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.
char * convert_utf8_to_ucs2 (char *input, int *real_strlen)
 Converts the given string to UCS-2 big endian for use with xcb_image_text_16().
char * resolve_tilde (const char *path)
 This function resolves ~ in pathnames.
bool path_exists (const char *path)
 Checks if the given path exists by calling stat().
char * get_process_filename (const char *prefix)
 Returns the name of a temporary file with the specified prefix.
void i3_restart (bool forget_layout)
 Restart i3 in-place appends -a to argument list to disable autostart.

Define Documentation

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

Definition at line 51 of file util.h.

Referenced by attach_to_workspace(), con_move_to_workspace(), insert_con_into(), and tree_close().

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

Definition at line 21 of file util.h.

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

Definition at line 23 of file util.h.

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

Definition at line 18 of file util.h.

Referenced by get_config_path(), main(), parse_file(), randr_query_outputs(), and resolve_tilde().

#define exit_if_null (   pointer,
  ... 
)    { if (pointer == NULL) die(__VA_ARGS__); }

Definition at line 19 of file util.h.

Referenced by scalloc(), smalloc(), srealloc(), sstrdup(), and TAILQ_HEAD().

#define FOR_TABLE (   workspace)
Value:
for (int cols = 0; cols < (workspace)->cols; cols++) \
                                for (int rows = 0; rows < (workspace)->rows; rows++)

Definition at line 25 of file util.h.

#define FREE (   pointer)
#define GREP_FIRST (   dest,
  head,
  condition 
)
Value:
NODES_FOREACH(head) { \
        if (!(condition)) \
            continue; \
        \
        (dest) = child; \
        break; \
    }

Definition at line 34 of file util.h.

Referenced by init_ws_for_output(), and workspace_get().

#define NODES_FOREACH (   head)
Value:
for (Con *child = (Con*)-1; (child == (Con*)-1) && ((child = 0), true);) \
        TAILQ_FOREACH(child, &((head)->nodes_head), nodes)

Definition at line 29 of file util.h.

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

Definition at line 20 of file util.h.


Function Documentation

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 at line 174 of file util.c.

Referenced by main(), and TAILQ_HEAD().

char* convert_utf8_to_ucs2 ( char *  input,
int *  real_strlen 
)

Converts the given string to UCS-2 big endian for use with xcb_image_text_16().

The amount of real glyphs is stored in real_strlen, a buffer containing the UCS-2 encoded string (16 bit per glyph) is returned. It has to be freed when done.

Definition at line 190 of file util.c.

References conversion_descriptor, and smalloc().

Referenced by handle_signal(), sig_draw_window(), and window_update_name().

Here is the call graph for this function:

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 137 of file util.c.

References start_argv.

Referenced by migrate_config(), and start_configerror_nagbar().

char* get_process_filename ( const char *  prefix)

Returns the name of a temporary file with the specified prefix.

Definition at line 295 of file util.c.

References path_exists().

Referenced by init_logging(), main(), and store_restart_layout().

Here is the call graph for this function:

void i3_restart ( bool  forget_layout)

Restart i3 in-place appends -a to argument list to disable autostart.

Definition at line 406 of file util.c.

References append_argument(), ipc_shutdown(), kill_configerror_nagbar(), LOG, restore_geometry(), scalloc(), start_argv, and store_restart_layout().

Referenced by sig_handle_key_press().

Here is the call graph for this function:

int max ( int  a,
int  b 
)

Definition at line 32 of file util.c.

Referenced by con_minimum_size(), DRAGGING_CB(), and floating_enable().

int min ( int  a,
int  b 
)

Definition at line 28 of file util.c.

Referenced by con_minimum_size(), query_screens(), and randr_query_outputs().

bool path_exists ( const char *  path)

Checks if the given path exists by calling stat().

Definition at line 263 of file util.c.

Referenced by get_config_path(), get_process_filename(), ipc_create_socket(), and tree_restore().

Rect rect_add ( Rect  a,
Rect  b 
)

Definition at line 43 of file util.c.

References Rect::height, Rect::width, Rect::x, and Rect::y.

Referenced by render_con().

bool rect_contains ( Rect  rect,
uint32_t  x,
uint32_t  y 
)

Definition at line 36 of file util.c.

References Rect::height, Rect::width, Rect::x, and Rect::y.

Referenced by handle_button_press(), handle_enter_notify(), and handle_motion_notify().

char* resolve_tilde ( const char *  path)

This function resolves ~ in pathnames.

It may resolve wildcards in the first part of the path, but if no match or multiple matches are found, it just returns a copy of path as given.

Definition at line 233 of file util.c.

References die, scalloc(), and sstrdup().

Referenced by get_config_path(), ipc_create_socket(), store_restart_layout(), and tree_restore().

Here is the call graph for this function:

void* scalloc ( size_t  size)
void* smalloc ( size_t  size)

Safe-wrapper around malloc which exits if malloc returns NULL (meaning that there is no more memory available)

Definition at line 66 of file util.c.

References exit_if_null.

Referenced by append_argument(), con_get_fullscreen_con(), convert_utf8_to_ucs2(), ewmh_update_workarea(), json_start_map(), manage_existing_windows(), parse_file(), SLIST_HEAD(), start_configerror_nagbar(), and translate_keysyms().

void* srealloc ( void *  ptr,
size_t  size 
)

Safe-wrapper around realloc which exits if realloc returns NULL (meaning that there is no more memory available).

Definition at line 78 of file util.c.

References exit_if_null.

Referenced by run_assignments().

char* sstrdup ( const char *  str)

Safe-wrapper around strdup which exits if malloc returns NULL (meaning that there is no more memory available)

Definition at line 84 of file util.c.

References exit_if_null.

Referenced by get_config_path(), ipc_create_socket(), load_configuration(), main(), output_init_con(), parse_file(), resolve_tilde(), TAILQ_HEAD(), window_update_class(), window_update_name_legacy(), workspace_get(), and x_set_name().

void start_application ( const char *  command)

Starts the given application by passing it through a shell.

We use double fork to avoid zombie processes. As the started application’s parent exits (immediately), the application is reparented to init (process-id 1), which correctly handles childs, so we don’t have to do it :-).

The shell is determined by looking for the SHELL environment variable. If it does not exist, /bin/sh is used.

Definition at line 100 of file util.c.

References LOG.

Referenced by main().

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 at line 55 of file util.c.

Referenced by handle_output(), and randr_query_outputs().