set -o errexit -o pipefail # errexit in case caller's #! line missing -e

if test ! "$_util_sh_include_guard_utils"; then

isset() { declare -p "$1" &>/dev/null; }

realpath() { readlink -f -- "$1"; }

str2varname() { echo "${1//[^a-zA-Z0-9_]/_}"; }

include_guard_var() { str2varname "$(realpath "$1")"; }

self_not_included() # usage: if self_not_included; then ... fi

{

	test $# -ge 1 || set -- "${BASH_SOURCE[1]}"

	local include_guard="$(include_guard_var "$1")"

	alias self_being_included=false

	! isset "$include_guard" && \

	{ eval "$include_guard"=1; alias self_being_included=true; }

}

# to load newly-defined aliases for use in functions in the same file:

fi

if self_not_included "${BASH_SOURCE[0]}"; then

shopt -s expand_aliases

# **DON'T** do `shopt -s lastpipe` because this causes a segfault on Linux in

#### stubs

alias log_local='declare PS4="$PS4" log_level="$log_level"'

function log++() { :; }

function log() { :; }

__caller_indent='log_indent="$log_indent$log_indent_step"'

function echo_func() { :; }

alias echo_func='"echo_func" "$FUNCNAME" "$@" && indent || true'

function echo_run() { :; }

# auto-echo common external commands

for cmd in env rm which; do alias "$cmd=echo_run $cmd"; done; unset cmd

echo_builtin() { :; }

function echo_vars() { :; }

#### errors

#### debugging

debug_fd="$err_fd"

ps() { echo "$@" >&"$debug_fd"; } # usage: ps str...

pv() { declare -p "$@" >&"$debug_fd"; } # usage: pv var... # debug-prints vars

pf() { declare -f "$@" >&"$debug_fd"; } # usage: pf func... # prints func decls

#### logic

bool!() # usage: "$(bool! "$bool_var")"

#### vars

alias local_array='declare -a'

set_var() { eval "$1"'="$2"'; }

set_default() { if ! isset "$1"; then set_var "$@"; fi; }

set_inv() { set_var no_"$1" "$(test "${!1}" || echo 1)"; }

alias local_inv=\

unexport() { export -n "$@"; }

alias local_export='declare -x' # combines effects of local and export

alias export_array='declare -ax'

# to make export only visible locally: local var="$var"; export var

get_prefix_vars() { : "${prefix:?}"; eval echo '${!'$prefix'*}'; }

# vars already set will *not* be overwritten

alias import_vars="$(cat <<'EOF'

	# use ${...-...} to avoid overwriting an already-set var

	declare "$dest_var=${!dest_var-${!src_var}}"; echo_vars "$dest_var"

done

#### integers

#### caching

# usage: local cache_key=...; load_cache; \

# if ! cached; then save_cache value || return; fi; echo_cached_value

# cache_key for function inputs: "$(declare -p kw_param...) $*"

alias load_cache='declare cache_var="$(str2varname "${FUNCNAME}___$cache_key")"'

#### aliases

unalias() { builtin unalias "$@" 2>&- || true; } # no error if undefined

# usage: alias alias_='var=value run_cmd '

alias_append() { eval "$(alias "$1")"'"$2"';} #usage: alias_append alias '; cmd'

#### commands

is_callable() { type -t "$1" >/dev/null; }

is_extern() { test "$(type -t "$1")" = file; }

is_intern() { is_callable "$1" && ! is_extern "$1"; }

is_dot_script()

require_dot_script() # usage: require_dot_script || return

sys_cmd_path() { echo_func; echo_builtin command -p which "$1"|echo_stdout; }

# makes command in $1 a system command

_1="$(indent; log++ sys_cmd_path "$_1")" || return

set -- "$_1" "$@"

function sudo() { echo_func; self -E "$@"; }

#### functions

func_exists() { declare -f "$1" >/dev/null; }

kw_params() # usage: func() { kw_params param_var...; }; ...; param_var=... cmd

# removes keyword-param-only vars from the environment

# usage: cmd=... foreach_arg

	echo_func; kw_params cmd; : "${cmd:?}"

		a="$(log++ echo_run "$cmd" "$a")" || return; args+=("$a")

	done

	echo_vars args

alias self_name='echo "${FUNCNAME%%__*}"' # usage: "$(self_name)"

alias self='command "$(self_name)"' # usage: wrapper() { self ...; }

alias self_builtin='builtin "${FUNCNAME%%__*}"' #wrapper() { self_builtin ...; }

all_funcs() # usage: for func in $(all_funcs); do ...; done # all declared funcs

copy_func() # usage: from=... to=... copy_func

func_override() # usage: func_override old_name__suffix

#### exceptions

fi # load new aliases

errexit() # usage: cmd || errexit status # works in functions *and* subshells

# usage: cmd || { save_e; ...; rethrow; }

alias export_e='e=$?'

# only upon error), you must `unset e` before the command

# idempotent: also works if save_e already called

rethrow() { errexit "${e:-0}"; } # only does anything if $e != 0

rethrow!() { rethrow && false; } # always errexit, even if $e = 0

rethrow_exit() { rethrow || exit; } # exit even where errexit disabled

fi # load new aliases

# usage: try cmd...; ignore_e status; if catch status; then ...; fi; end_try

alias prep_try='declare e=0 benign_error="$benign_error"'

function try() { benign_error=1 "$@" || { export_e; true; }; }

alias try='prep_try; "try" ' # last space alias-expands next word

catch() { test "$e" = "${1:-0}" && e=0; } # also works w/ $1=''

ignore_e() { if catch "$@"; then benign_error=1; fi; } # also works w/ $1=''

alias end_try='rethrow'

ignore() { save_e; ignore_e "$@"; rethrow; } # usage: try cmd || ignore status

### signals

func_override catch__exceptions

	echo_func

	if starts_with SIG "$1"; then set -- "$(sig_e "$1")"; fi

# usage: piped_cmd cmd1...|cmd2... # cmd2 doesn't read all its input

function piped_cmd() { "$@" || ignore SIGPIPE; }

alias piped_cmd='"piped_cmd" ' # last space alias-expands next word

fi # load new aliases

#### text

function split_lines() { split "$nl" "$1"; lines=("${parts[@]}"); }

alias split_lines='declare lines; "split_lines"'

#### terminal

plain() { echo "$1"; }

fade() { format 90 "$@"; } # medium gray fades on white *&* black backgrounds

#### paths

wildcard/() # usage: array=($(log++; [cd ...;] wildcard/ unquoted_pattern...))

{ cmd=strip/ foreach_arg; esc "$@"; }

wildcard.() # usage: array=($(log++; [cd ...;] wildcard. unquoted_pattern...))

# currently only removes . .. at beginning of list

	esc "$@"

}

#### streams

pipe_delay() # usage: cmd1 | { pipe_delay; cmd2; }

#### verbose output

usage() { echo "Usage: $1" >&2; return 2; }

### log++

log_fd=2 # initially stderr

if test "$explicit_errors_only"; then verbosity=0; fi # hide startup logging

# set verbosity

if isset verbose; then : "${verbosity:=$(bool2int "$verbose")}"; fi

if isset vb; then : "${verbosity:=$vb}"; fi

: "${verbosity=1}" # default

: "${verbosity:=0}" # ensure non-empty

export verbosity # propagate to invoked commands

is_outermost="$(! isset log_level; exit2bool)" # if util.sh env not yet set up

# set log_level

export PS4 # follows log_level, so also propagate this

verbosity_int() { round_down "$verbosity"; }

# verbosities (and `make` equivalents):

# 0: just print errors. useful for cron jobs.

#    vs. make: equivalent to --silent, but suppresses external command output

# 1: also external commands run. useful for running at the command line.

#    vs. make: not provided (but sorely needed to avoid excessive output)

# 2: full graphical call tree. useful for determining where error occurred.

#    vs. make: equivalent to default verbosity, but with much-needed indents

# 3: also values of kw params and variables. useful for low-level debugging.

#    vs. make: not provided; need to manually use $(error $(var))

# 4: also variables in util.sh commands. useful for debugging util.sh.

#    vs. make: somewhat similar to --print-data-base

# 5: also variables in logging commands themselves. useful for debugging echo_*.

#    vs. make: not provided; need to search Makefile for @ at beginning of cmd

# 6+: not currently used (i.e. same as 5)

# definition: the log_level is the minimum verbosity needed to display a message

# to view a message's log_level, count the # of + signs before it in the output

fi # load new aliases

# usage: in func:      log_local; log++; ...

#        before cmd:   log++ cmd  OR  log+ num cmd  OR  log++ log++... cmd

# with a cmd, assignments are applied just to it, so log_local is not needed

# without a cmd, assignments are applied to caller ("$@" expands to nothing)

# "${@:2}" expands to all of $@ after *1st* arg, not 2nd ($@ indexes start at 1)

log:() # sets explicit log_level

{

	if test $# -gt 1; then log_local; fi # if cmd, only apply assignments to it

	# no local vars because w/o cmd, assignments should be applied to caller

	log_level="$1"

	PS4="$(str="${PS4:0:1}" n=$((log_level-1)) repeat)${PS4: -2}"

	"${@:2}"

}

log+() { log: $((log_level+$1)) "${@:2}"; }

log-() { log+ "-$1" "${@:2}"; }

# no log:/+/- alias needed because next word is not an alias-expandable cmd

function log++() { log+ 1 "$@"; }

alias log++='"log++" ' # last space alias-expands next word

verbosity_min() # usage: verbosity_min {<min>|''}

{ if test ! "$1" -o "$(verbosity_int)" -lt "$1"; then verbosity="$1"; fi; }

alias verbosity_min='declare verbosity="$verbosity"; "verbosity_min"'

# usage: (verbosity_compat; cmd)

function verbosity_compat()

{ log_local; log++; echo_func; if ((verbosity == 1)); then unset verbosity; fi;}

alias verbosity_compat='declare verbosity="$verbosity"; "verbosity_compat"'

# indent for call tree. this is *not* the log_level (below).

: "${log_indent_step=| }" "${log_indent=}"

# see indent alias in stubs

fi # load new aliases

can_log() { test "$log_level" -le "$(verbosity_int)"; }

	# verbosity=0 turns off all logging

can_highlight_log_msg() { test "$log_level" -le 1; }

highlight_log_msg() # usage: [format=...] highlight_log_msg msg

# format: the # in xfree86.org/current/ctlseqs.html#Character_Attributes

{

	log_local; log+ 2; echo_func; kw_params format; log- 2

	if ! can_highlight_log_msg; then format=; fi

	format "$format" "$1"

}

log_line!() # highlights log_level 1 messages to stand out against other output

{ echo "$log_indent$PS4$(highlight_log_msg "$1")" >&"$log_fd"; }

log_msg!()

{

log() { if can_log; then log_msg! "$@"; fi; }

log_custom() # usage: symbol=... log_custom msg

{ log_indent="${log_indent//[^ ]/$symbol}" PS4="${PS4//[^ ]/$symbol}" log "$@";}

bg_r='101;97' # red background with white text

log_err() { symbol='#' format="$bg_r" log_fd="$err_fd" log! log_custom "$@";}

log_info() { symbol=: log_custom "$@"; }

mk_hint() { format=7 highlight_log_msg "$@";}

log_err_hint!() { log_err "$(mk_hint "$@")"; }

log_err_hint() # usage: cmd || [benign_error=1] log_err_hint msg [|| handle err]

# msg only displayed if not benign error

{

	log++ kw_params benign_error

	if test ! "$benign_error"; then log_err_hint! "$@"; fi

die() # usage: if msg uses $(...):    cmd || { save_e; [type=...] die msg; }

{ save_e; log++ kw_params type; "log_${type:-err}" "$1"; rethrow!; }

die_e() # usage: cmd || [benign_error=1] die_e [|| handle error]

	save_e; log++ kw_params benign_error

	if test "$benign_error"; then log_local; log++; fi

	type="${benign_error:+info}" die "command exited with \

die_error_hidden() # usage: cmd || verbosity_min=# die_error_hidden [|| ...]

{

	save_e; kw_params verbosity_min; : "${verbosity_min:?}"

		log_err_hint 'to see error details, prepend `vb='"$verbosity_min"'` to the command'

	fi

#### paths

# cache realpath

	if ! cached; then save_cache "$(realpath__no_cache "$@")" || return; fi

	echo_cached_value

rel_path() # usage: base_dir=... path=... rel_path

{

	log_local; log++; kw_params base_dir path

	: "${base_dir:?}" "${path:?}"

	local path="$path/" # add *extra* / to match path when exactly = base_dir

	if test ! "$path"; then path=.; fi # ensure non-empty

	echo_vars path

	echo "$path"

cd -P . # expand symlinks in $PWD so it matches the output of realpath

canon_rel_path() # usage: [base_dir=...] canon_rel_path path

{

	kw_params base_dir; local base_dir="${base_dir-$PWD}"

	local path; path="$(realpath "$1")" || return

	rel_path

}

canon_dir_rel_path() # usage: [base_dir=...] canon_dir_rel_path path

# makes $1 a canon_rel_path if it's a filesystem path

	_1="$(log++ canon_rel_path "$_1")" || return

	set -- "$_1" "$@"

fi