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

# allow setting vars in the last command of a pipeline

shopt -s lastpipe 2>/dev/null || true # ignore errors if not supported (on Mac)

#### stubs

__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() { :; }

#### debugging

#### logic

#### vars

alias local_array='declare'

	# `local` does not support arrays in older versions of bash

	# don't need -a because that it's an array is autodetected by the ()

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 -x'

	# `export` does not support arrays in older versions of bash

	# don't need -a because that it's an array is autodetected by the ()

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

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

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

done

#### 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 "$@" >/dev/null; }

is_dot_script() { echo_func; test "${BASH_LINENO[${#BASH_LINENO[@]}-1]}" != 0; }

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; clog++ sys_cmd_path "$_1")" || return

set -- "$_1" "$@"

#### functions

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="$(clog++ echo_run "$cmd" "$a")" || return; args+=("$a")

	echo_vars args

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

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

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

pf() { declare -f "$@" >&2; } # usage: pf function # debug-prints func decl

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

#### exceptions

# 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

alias rethrow='return "$e"'

	# can't use `(exit "$e")` because a bug in bash prevents subshells from

alias rethrow_subshell='exit "$e"'

fi # load new aliases

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

alias prep_try='declare e' # last space alias-expands next word

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

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

catch() { test "$e" -eq "$1" && e=0; }

ignore_e() { catch "$@" || true; }

alias end_try='rethrow'

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

### signals

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

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

fi # load new aliases

#### integers

let!() { let "$@" || true; } # always returns true; safe to use for setting

	# "If the last ARG evaluates to 0, let returns 1" (`help let`)

bool2int() { try test ! "$1"; echo "$e"; } # empty->0; non-empty->1

int2exit() { (( "$1" != 0 )); }

exit2bool() { if (( $? == 0 )); then echo 1; fi } # 0->non-empty; !=0->empty

#### floats

float_set_min() { if (($(int_part $1) >= $2)); then echo $1; else echo $2; fi; }

#### strings

starts_with() { test "${2#$1}" != "$2"; } # usage: starts_with pattern str

match_prefix() # usage: match_prefix pattern str

rm_prefix() { echo "${2#$1}"; } # usage: rm_prefix pattern str

repeat() # usage: str=... n=... repeat

	: "${str?}" "${n:?}"; local result= n="$n" # n will be modified in function

}

# usage: outer_cmd $sed_cmd ...

sed_cmd="env LANG= sed -`case "$(uname)" in Darwin) echo El;; *) echo ru;;esac`"

	# LANG: avoid invalid UTF-8 "illegal byte sequence" errors when LANG=*.UTF-8

	# -l: line buffered / -u: unbuffered

alias sed="$sed_cmd"

fi # load new aliases

rtrim() { log+ 3; sed 's/[[:space:]]+$//' <<<"$1"; }

#### arrays

echo1() { echo "$1"; } # usage: echo1 values...

esc_args() # usage: array=($(log++; prep_env... (eg. cd); esc_args args...))

{ local arg; for arg in "$@"; do printf '%q ' "$arg"; done; }

# usage: split delim str; use ${parts[@]}

join() { local IFS="$delim"; echo "$*"; } # usage: delim=char join elems...

reverse() # usage: array=($(reverse args...))

{

	for (( i=$#; i > 0; i-- )); do printf '%q ' "${!i}"; done

}

contains() # usage: contains value in_array...

is_array() # handles unset vars (=false)

{

	isset "$1" || return 1

	local decl; decl="$(declare -p "$1")" || return; echo_vars decl

#### paths

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

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

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

# currently only removes . .. at beginning of list

#### streams

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

#### verbose output

err_fd=2 # stderr

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

export PS4 # follows verbosity, so also propagate this

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

# set log_level

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++; ...         OR  log_local; "log++"; ...

#        outside func: log++; ...; log--

#        before cmd:  "log++" cmd  OR  "log+" # cmd  OR  "log++" "log++" cmd

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

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

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

log+()

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

	log_level=$((log_level+$1)) \

	verbosity="$(float+int "$verbosity" "-$1")" "${@:2}"

}

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

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

log!() { log- "$log_level" "$@"; } # force-displays next log message

alias log_local=\

alias log+='log_local; "log+"' # don't expand next word because it's not a cmd

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

alias log!='log_local; "log!" ' # last space alias-expands next word

# no clog+ alias because next word is not a cmd

alias clog!='"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='log_local; "verbosity_min"'

# usage: (verbosity_compat; cmd)

function verbosity_compat()

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

alias verbosity_compat='declare 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 "$(verbosity_int)" -gt 0; }

	# verbosity=0 turns off all logging

log() { if can_log; then echo "$log_indent$PS4$1" >&"$log_fd"; fi; }

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

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

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

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

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

die() # usage: cmd || [type=...] die msg # msg can use $? but not $()

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

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

	if test "$benign_error"; then 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:?}"

	fi

#### functions

{ from="${1%__*}" to="$1" copy_func; }

#### paths

# cache realpath

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

	echo_cached_value

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

{

	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="$(clog++ canon_rel_path "$_1")" || return

	set -- "$_1" "$@"

fi

# usage: path_parents path; use ${dirs[@]} # includes the path itself

#### verbose output

### command echoing

fi # load new aliases

echo_cmd() { echo_params; }

function echo_run() { echo_params; "$@"; }

# see echo_run alias after stub

echo_builtin() { echo_run builtin "$@"; } # usage: echo_builtin builtin_cmd...

echo_eval() { echo_params; builtin eval "$@"; }

# usage: redirs=(...); [cmd_name_log_inc=#] echo_redirs_cmd

function echo_redirs_cmd()

	local cmd_name_log_inc="${cmd_name_log_inc-0}"

	# print <>file redirs before cmd, because they introduce it

	"log+" "$cmd_name_log_inc" echo_cmd "$@" $(

		set -- "${redirs[@]}" # operate on ${redirs[@]}

		while test "$#" -gt 0 && starts_with '[<>][^&]' "$1"

	)

## vars

echo_vars() # usage: echo_vars var... # only prints vars that are defined

{

	log+ 2

	if can_log; then

alias export="echo_export" # automatically echo env vars when they are set

## functions

# usage: local func=...; set_func_loc; use $file, $line

{

# usage: func() { [minor=1] echo_func; ... }

function echo_func()

# usage: "echo_func" "$FUNCNAME" "$@" && indent || true

# exit status: whether function call was echoed

	log++; can_log || return

	local func="$1"; shift

	local loc; loc="$(clog++ func_loc "$func")" || return

	echo_cmd "$loc" "$func" "$@"

}

# see echo_func alias after stub

fi # load new aliases