#!/bin/bash -e

set -o errexit # in case caller did not have -e in #! line

if test ! "$_util_sh_include_guard_utils"; then

_util_sh_include_guard_utils=1

function extern () { (exec "$@") || return; }

isset () { test "${!1+isset}"; }

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

include_guard_var () { realpath "$1"|"extern" sed 's/[^a-zA-Z0-9_]/_/g'; }

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 # load new aliases

## if self_being_included; then

# this is needed because aliases defined inside an if statement are not

# available inside that if statement

fi

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

#### options

shopt -s expand_aliases

#### aliases

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

#### exceptions

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

alias export_e='e=$?'

alias save_e='declare e=$?'

alias rethrow='return "$e"'

alias rethrow_subshell='exit "$e"'

fi # load new aliases

if self_being_included; then

# usage: cmd || die msg

die () { save_e; echo "$1" >&2; rethrow; }

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

log_e () { echo "! command exited with error $e" >&2; }

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

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

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

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

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

alias end_try='rethrow'

alias end_try_subshell='rethrow_subshell'

fi # load new aliases

if self_being_included; then

#### functions

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

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

# $to must not exist. to get around the no-clobber restriction, use `unset -f`.

{

	: "${from:?}" "${to:?}"

	func_exists "$from" || die "function does not exist: $from"

	! func_exists "$to" || die "function already exists: $to"

	local from_def="$(declare -f "$from")"

	eval "$to${from_def#$from}"

}

func_override () # usage: func_override old_name__suffix

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

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

#### arrays

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

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

{

	local i

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

}

#### paths

canon_rel_path ()

{

	local path="$1"

	path="$(realpath "$path")" # canonicalize

	path="${path#$(pwd -P)/}" # remove any shared prefix with the current dir

	echo "$path"

}

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

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

if test "$(type -t "$1")" = file && test -e "$1"; then # not relative to PATH

	declare _1="$1"; shift

	set -- "$(canon_rel_path "$_1")" "$@"

fi

EOF

)"

#### verbose output

# usage: (stdout2stderr; cmd...) || return

# `|| return` needed on Mac because of bug where -e doesn't apply to ()

stdout2stderr () { exec >&2; }

# set verbosity

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

: "${verbosity=3}" # default

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

declare -i verbosity # ensure integer

export verbosity # propagate the verbosity to invoked commands

can_log () { test "$verbosity" -gt 0; } # verbosity=0 turns off all logging

: "${log_indent=  }"

# usage: in func:      inc_log_level; ...

#        outside func: inc_log_level; ...; dec_log_level

alias inc_log_level='declare verbosity="$verbosity" PS4="$log_indent$PS4"

let! verbosity--'

alias dec_log_level='declare verbosity="$verbosity" PS4="${PS4#$log_indent}"

let! verbosity++'

fi # load new aliases

if self_being_included; then

echo_cmd ()

{

	if can_log; then

		case "$1" in extern) shift;; esac # extern implied by the log_level

		echo "$PS4$*" >&2

	fi

}

echo_run () { cmd2rel_path; echo_cmd "$@"; "$@"; }

# usage: (limit_stderr; cmd...) || return

# `|| return` needed on Mac because of bug where -e doesn't apply to ()

limit_stderr () { inc_log_level; if ! can_log; then exec 2>/dev/null; fi; }

limit_stderr_cmd () # usage: [stdout2stderr=1] limit_stderr_cmd cmd...

{

	case "$1" in echo_run) shift; cmd2rel_path; echo_cmd "$@";; esac

	(limit_stderr

		if test "$stdout2stderr"; then stdout2stderr; fi

		"$@"

	) || return

}

alias limit_stderr_cmd='limit_stderr_cmd ' # last space alias-expands next word

# auto-echo common external commands

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

# echo all external commands

alias extern="echo_run extern " # last space alias-expands next word

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

# commands that are always external

for cmd in env; do alias "$cmd=extern $cmd"; done; unset cmd

function echo_func ()

{

	inc_log_level

	local script="$(canon_rel_path "${BASH_SOURCE[1]}")"

	echo_cmd "$script:${BASH_LINENO[0]}" "${FUNCNAME[1]}" "$@"

}

# usage: cmd1 | { pipe_delay; cmd2; }

alias pipe_delay='sleep 0.1' # s; display after leading output of cmd1

fi # load new aliases

if self_being_included; then

echo_stdin () # usage: input|echo_stdin|cmd

{

	inc_log_level

	if can_log; then

		pipe_delay

		echo ----- >&2

		tee -a /dev/stderr;

		echo ----- >&2

	else cat

	fi

}

alias echo_stdout='echo_stdin' # usage: cmd|echo_stdout

echo_vars () # usage: echo_vars var...

{

	inc_log_level; inc_log_level

	if can_log; then

		local var

		for var in "${@%%=*}"; do { echo -n "$PS4"; declare -p "$var";} >&2;done

	fi

}

echo_export () { builtin export "$@"; echo_vars "$@"; }

if test "$verbosity" -ge 2; then

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

fi

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

fi # load new aliases

if self_being_included; then

#### strings

sed_ere_flag="$(test "$(uname)" = Darwin && echo E || echo r)"

sed () { self -"$sed_ere_flag" "$@";}

#### vars

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

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

# usage: local var=...; local_inv

alias local_inv='declare "no_$var=$(test "${!var}" || echo 1)"'

# usage: local prefix=..._; import_vars

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

: "${prefix:?}"

local src_var dest_var

for src_var in $(eval echo '${!'$prefix'*}'); do

	dest_var="${src_var#$prefix}"

	local "$dest_var=${!src_var}"; echo_vars "$dest_var"

done

EOF

)"

#### commands

top_script="$0" # outermost script

top_dir="$(dirname "$top_script")"

# auto-removes a command's output file on error (like make's .DELETE_ON_ERROR)

function to_file () # usage: stdout=... to_file cmd...

{

	echo_func

	: "${stdout?}"; echo_vars stdout

	"$@" >"$stdout" || { save_e; log_e; rm "$stdout"; rethrow; }

}

alias to_file='to_file ' # last space alias-expands next word

run_args_cmd () # runs the command line args command

{

	test $? -eq 0 || return

	eval set -- "$(reverse "${BASH_ARGV[@]}")"

	test $# -ge 1 || set -- all

	echo_cmd "$(canon_rel_path "$0")" "$@"; "$@"

}

fwd () # usage: subdirs=(...); fwd "$FUNCNAME" "$@"

{

	echo_func

	: "${subdirs?}"

	for subdir in "${subdirs[@]}"; do

		"$(dirname "${BASH_SOURCE[1]}")"/"$subdir"/run "$@"

	done

}

#### URLs

localize_url () { test _"$1" = _"$(hostname -f)" || echo "$1"; }

fi