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

#### stubs

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

function echo_func() { :; }

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

function echo_run() { :; }

function echo_vars() { :; }

#### vars

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

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

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

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

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

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

#### 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='command "${FUNCNAME%%__*}"' # usage: wrapper() { self ...; }

pf() { declare -f "$@"; } # usage: pf function # prints func decl for debugging

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

#### exceptions

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

alias export_e='e=$?'

alias save_e='declare e=$?'

alias rethrow='return "$e"'

fi # load new aliases

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

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

alias try='declare e; "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

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

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

}

sed_cmd="sed -`case "$(uname)" in Darwin) echo E;; *) echo r;; esac`"

alias sed="$sed_cmd"

fi # load new aliases

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

#### arrays

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

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

{

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

}

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

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

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

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

verbosity_min() # usage: verbosity_min {min|} # ''->verbosity=''

alias verbosity_min='log_local; "verbosity_min"'

# usage: (verbosity_compat; cmd) # cmd doesn't support verbosity=''

# 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='#' verbosity=1 log_fd="$err_fd" log_custom "$@"; }

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

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 \

#### 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

}

# 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_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

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

# exit status: whether function call was echoed

	local func="$1"; shift

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

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

	can_log

# see echo_func alias after stub

fi # load new aliases

#### streams

set_fds() # usage: set_fds redirect...

	local redirs=() i

	for i in "$@"; do

		local redir_prefix="$(match_prefix '*[<>]' "$i")"

		if test "$redir_prefix"; then redirs+=("$redir_prefix&-"); fi

		redirs+=("$i")

	done

	if (($# > 0)); then echo_eval exec "$@"; fi

}

function filter_fd() # usage: (fd=# filter_fd filter_cmd...; with filter...)

# useful e.g. to filter logging output or highlight errors

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

# convention: use fd 40/41/42 for command-specific alternate stdin/stdout/stderr

setup_log_fd() # view logging output at verbosity >= 5

	log+ 4; log-- echo_func

	fd_set_default '30>&2' || true # stdlog

set_global_fds()

# view logging output at verbosity >= 3

{

	log+ 2; log-- echo_func

	# ignore errors if a source fd isn't open

echo_vars is_outermost

#### paths

top_symlink_dir="$(dirname "$0")"; echo_vars top_symlink_dir

top_symlink_dir_abs="$(realpath "$top_symlink_dir")"

top_script_abs="$(realpath "$0")"; echo_vars top_script_abs # outermost script

top_dir_abs="$(dirname "$top_script_abs")"; echo_vars top_dir_abs

set_paths()

	top_script="$(clog++ canon_rel_path "$top_script_abs")" || return

		echo_vars top_script

}

PATH_rm() # usage: PATH_rm path... # removes components from the PATH

no_PATH_recursion() # usage: (no_PATH_recursion; cmd...)

{

#### verbose output

## internal commands

.()

	clog++ clog++ echo_func

	if (log++; echo_params; can_log); then indent; fi

	builtin "$@"

.rel() # usage: .rel file [args...] # file relative to ${BASH_SOURCE[0]} dir

cd() # indent is permanent within subshell cd was used in

	log++ echo_func

	cmd2rel_path; echo_cmd "$FUNCNAME" "$@"

	if can_log; then caller_indent; fi

	# -P: expand symlinks so $PWD matches the output of realpath

	builtin "$FUNCNAME" -P "$@"

	set_paths

}

## external commands

disable_logging() { set_fds "$log_fd>/dev/null"; }

function redir() # usage: local redirs=(#<>...); redir cmd...; unset redirs

# to view only explicitly-displayed errors: explicit_errors_only=1 script...

{

	echo_func; kw_params redirs