i3
Macros | Functions
util.c File Reference
#include "all.h"
#include <sys/wait.h>
#include <stdarg.h>
#include <fcntl.h>
#include <pwd.h>
#include <yajl/yajl_version.h>
#include <libgen.h>
#include <ctype.h>
#include <libsn/sn-launcher.h>
Include dependency graph for util.c:

Go to the source code of this file.

Macros

#define SN_API_NOT_YET_FROZEN   1
 
#define y(x, ...)   yajl_gen_##x(gen, ##__VA_ARGS__)
 
#define ystr(str)   yajl_gen_string(gen, (unsigned char *)str, strlen(str))
 

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 layout_from_name (const char *layout_str, layout_t *out)
 Set 'out' to the layout_t value for the given layout. 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...
 
static char ** add_argument (char **original, char *opt_char, char *opt_arg, char *opt_name)
 
char * store_restart_layout (void)
 
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...
 
static void nagbar_exited (EV_P_ ev_child *watcher, int revents)
 
static void nagbar_cleanup (EV_P_ ev_cleanup *watcher, int revent)
 
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...
 
bool parse_long (const char *str, long *out, int base)
 Converts a string into a long using strtol(). More...
 
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 not be read. More...
 

Macro Definition Documentation

◆ SN_API_NOT_YET_FROZEN

#define SN_API_NOT_YET_FROZEN   1

Definition at line 24 of file util.c.

◆ y

#define y (   x,
  ... 
)    yajl_gen_##x(gen, ##__VA_ARGS__)

Definition at line 217 of file util.c.

Referenced by store_restart_layout().

◆ ystr

#define ystr (   str)    yajl_gen_string(gen, (unsigned char *)str, strlen(str))

Definition at line 218 of file util.c.

Function Documentation

◆ __attribute__()

__attribute__ ( (pure)  )

Definition at line 60 of file util.c.

◆ add_argument()

static char** add_argument ( char **  original,
char *  opt_char,
char *  opt_arg,
char *  opt_name 
)
static

Definition at line 187 of file util.c.

References scalloc().

Referenced by i3_restart().

Here is the call graph for this function:

◆ 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 142 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:

◆ i3_restart()

void i3_restart ( bool  forget_layout)

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

Definition at line 282 of file util.c.

References add_argument(), command_error_nagbar_pid, config_error_nagbar_pid, get_debug_logging(), ipc_shutdown(), kill_nagbar(), LOG, restore_geometry(), SHUTDOWN_REASON_RESTART, start_argv, and store_restart_layout().

Referenced by cmd_restart(), and sighandler_handle_key_press().

Here is the call graph for this function:

◆ kill_nagbar()

void kill_nagbar ( pid_t *  nagbar_pid,
bool  wait_for_it 
)

Kills the i3-nagbar process, if *nagbar_pid != -1.

If wait_for_it is set (restarting i3), this function will waitpid(), otherwise, ev is assumed to handle it (reloading).

Definition at line 445 of file util.c.

Referenced by cmd_reload(), and i3_restart().

◆ layout_from_name()

bool layout_from_name ( const char *  layout_str,
layout_t out 
)

Set 'out' to the layout_t value for the given layout.

The function returns true on success or false if the passed string is not a valid layout name.

Definition at line 75 of file util.c.

References L_DEFAULT, L_SPLITH, L_SPLITV, L_STACKED, and L_TABBED.

Referenced by cmd_layout(), and con_toggle_layout().

◆ max()

int max ( int  a,
int  b 
)

◆ min()

int min ( int  a,
int  b 
)

◆ nagbar_cleanup()

static void nagbar_cleanup ( EV_P_ ev_cleanup *  watcher,
int  revent 
)
static

Definition at line 389 of file util.c.

References LOG.

Referenced by start_nagbar().

◆ nagbar_exited()

static void nagbar_exited ( EV_P_ ev_child *  watcher,
int  revents 
)
static

Definition at line 367 of file util.c.

References DLOG, and ELOG.

Referenced by start_nagbar().

◆ pango_escape_markup()

char* pango_escape_markup ( char *  input)

Escapes the given string if a pango font is currently used.

If the string has to be escaped, the input string will be free'd.

Definition at line 352 of file util.c.

References font_is_pango(), and FREE.

Referenced by con_parse_title_format().

Here is the call graph for this function:

◆ parse_long()

bool parse_long ( const char *  str,
long *  out,
int  base 
)

Converts a string into a long using strtol().

This is a convenience wrapper checking the parsing result. It returns true if the number could be parsed.

Definition at line 467 of file util.c.

Referenced by bindings_get_buttons_to_grab(), cmd_swap(), configure_binding(), match_parse_property(), and translate_keysyms().

◆ path_exists()

bool path_exists ( const char *  path)

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

Definition at line 178 of file util.c.

Referenced by ipc_create_socket(), and tree_restore().

◆ rect_add()

Rect rect_add ( Rect  a,
Rect  b 
)

Definition at line 42 of file util.c.

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

Referenced by con_set_border_style(), and render_con().

◆ rect_contains()

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

Definition at line 35 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().

◆ rect_sub()

Rect rect_sub ( Rect  a,
Rect  b 
)

Definition at line 49 of file util.c.

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

Referenced by con_set_border_style().

◆ slurp()

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 not be read.

buf is set to a buffer of appropriate size, or NULL if -1 is returned.

Definition at line 485 of file util.c.

References ELOG, and scalloc().

Referenced by cmd_append_layout(), and tree_restore().

Here is the call graph for this function:

◆ start_nagbar()

void start_nagbar ( pid_t *  nagbar_pid,
char *  argv[] 
)

Starts an i3-nagbar instance with the given parameters.

Takes care of handling SIGCHLD and killing i3-nagbar when i3 exits.

The resulting PID will be stored in *nagbar_pid and can be used with kill_nagbar() to kill the bar later on.

Definition at line 405 of file util.c.

References DLOG, exec_i3_utility(), main_loop, nagbar_cleanup(), nagbar_exited(), and smalloc().

Referenced by run_binding(), and start_config_error_nagbar().

Here is the call graph for this function:

◆ store_restart_layout()

char* store_restart_layout ( void  )

Definition at line 220 of file util.c.

References config, croot, DEFAULT_DIR_MODE, DLOG, dump_node(), ELOG, get_process_filename(), mkdirp(), resolve_tilde(), Config::restart_state_path, sstrdup(), writeall(), and y.

Referenced by i3_restart().

Here is the call graph for this function:

◆ update_if_necessary()

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

Referenced by handle_output(), randr_query_outputs(), and randr_query_outputs_15().

◆ ws_name_to_number()

long ws_name_to_number ( const char *  name)

Parses the workspace name as a number.

Returns -1 if the workspace should be interpreted as a "named workspace".

Definition at line 102 of file util.c.

Referenced by cmd_move_con_to_workspace_number(), cmd_rename_workspace(), cmd_workspace_number(), create_workspace_on_output(), json_end_map(), and workspace_get().