Project

General

Profile

1 8291 aaronmk
#!/bin/bash -e
2 8952 aaronmk
set -o errexit # in case caller did not have -e in #! line
3
4 9018 aaronmk
if test ! "$_util_sh_include_guard_utils"; then
5
_util_sh_include_guard_utils=1
6
7 8957 aaronmk
function extern () { (exec "$@") || return; }
8 8917 aaronmk
9 9002 aaronmk
isset () { test -n "${!1+isset}"; }
10
11 8716 aaronmk
realpath () { readlink -f -- "$1"; }
12 8703 aaronmk
13 8917 aaronmk
include_guard_var () { realpath "$1"|"extern" sed 's/[^a-zA-Z0-9_]/_/g'; }
14 8716 aaronmk
15 8703 aaronmk
self_not_included () # usage: if self_not_included; then ... fi
16
{
17 8971 aaronmk
	test $# -ge 1 || set -- "${BASH_SOURCE[1]}"
18 8703 aaronmk
	local include_guard="$(include_guard_var "$1")"
19 8793 aaronmk
	alias self_being_included=false
20 9003 aaronmk
	! isset "$include_guard" && \
21 8793 aaronmk
	{ eval "$include_guard"=1; alias self_being_included=true; }
22 8703 aaronmk
}
23
24 8793 aaronmk
# to load newly-defined aliases for use in functions in the same file:
25
## fi # load new aliases
26
## if self_being_included; then
27
# this is needed because aliases defined inside an if statement are not
28
# available inside that if statement
29
30 9018 aaronmk
fi
31 9017 aaronmk
32 9018 aaronmk
33 8704 aaronmk
if self_not_included "${BASH_SOURCE[0]}"; then
34
35 9017 aaronmk
36
#### options
37
38 8709 aaronmk
shopt -s expand_aliases
39
40 9017 aaronmk
41
#### aliases
42
43 8889 aaronmk
unalias () { builtin unalias "$@" 2>&- || true; } # no error if undefined
44
45 9017 aaronmk
46 8886 aaronmk
#### exceptions
47
48 9032 aaronmk
# usage: cmd || { save_e; ...; rethrow; }
49 9031 aaronmk
alias export_e='e=$?'
50 9032 aaronmk
alias save_e='declare e=$?'
51 8976 aaronmk
alias rethrow='return "$e"'
52
alias rethrow_subshell='exit "$e"'
53
54 8978 aaronmk
fi # load new aliases
55
if self_being_included; then
56
57 9036 aaronmk
# usage: cmd || die msg
58
die () { save_e; echo "$1" >&2; rethrow; }
59
60 9035 aaronmk
# usage: cmd || { save_e; log_e; ...; rethrow; }
61
log_e () { echo "! command exited with error $e" >&2; }
62 8981 aaronmk
63 8886 aaronmk
# usage: try cmd...; ignore status; if catch status; then ...; fi; end_try
64
65 9031 aaronmk
function try () { e=0; "$@" || { export_e; true; }; }
66 8980 aaronmk
alias try='declare e; try ' # last space alias-expands next word
67 8886 aaronmk
68
catch () { test "$e" -eq "$1"; e=0; }
69
70
ignore () { catch "$@" || true; }
71
72 8977 aaronmk
alias end_try='rethrow'
73
alias end_try_subshell='rethrow_subshell'
74 8886 aaronmk
75 9020 aaronmk
fi # load new aliases
76
if self_being_included; then
77 9017 aaronmk
78 9020 aaronmk
79 9023 aaronmk
#### functions
80
81 9024 aaronmk
func_exists () { declare -f "$1" >/dev/null; }
82
83 9023 aaronmk
copy_func () # usage: from=... to=... copy_func
84 9037 aaronmk
# $to must not exist. to get around the no-clobber restriction, use `unset -f`.
85 9023 aaronmk
{
86
	: "${from:?}" "${to:?}"
87 9037 aaronmk
	func_exists "$from" || die "function does not exist: $from"
88
	! func_exists "$to" || die "function already exists: $to"
89 9023 aaronmk
	local from_def="$(declare -f "$from")"
90
	eval "$to${from_def#$from}"
91
}
92
93
94 8899 aaronmk
#### integers
95
96
let () { builtin let "$@" || true; }
97
	# "If the last ARG evaluates to 0, let returns 1" (`help let`)
98
99 9028 aaronmk
bool2int () { try test -z "$1"; echo "$e"; } # empty->0; non-empty->1
100 9004 aaronmk
101 9017 aaronmk
102 8854 aaronmk
#### arrays
103 8694 aaronmk
104 8833 aaronmk
join () { local IFS="$delim"; echo "$*"; } # usage: delim=... join elems...
105 8816 aaronmk
106 8691 aaronmk
reverse () # usage: array=($(reverse args...))
107
{
108
	local i
109
	for (( i=$#; i >= 1; i-- )); do printf '%q ' "${!i}"; done
110
}
111
112 9017 aaronmk
113 8854 aaronmk
#### verbose output
114
115 8973 aaronmk
# usage: (stdout2stderr; cmd...) || return
116
# `|| return` needed on Mac because of bug where -e doesn't apply to ()
117 8914 aaronmk
stdout2stderr () { exec >&2; }
118
119 9006 aaronmk
# set verbosity
120 9005 aaronmk
if isset verbose; then : "${verbosity:=$(bool2int "$verbose")}"; fi
121 9006 aaronmk
: "${verbosity=3}" # default
122
: "${verbosity:=0}" # ensure non-empty
123 9007 aaronmk
declare -i verbosity # ensure integer
124 9000 aaronmk
export verbosity # propagate the verbosity to invoked commands
125 8710 aaronmk
126 8898 aaronmk
can_log () { test "$verbosity" -gt 0; } # verbosity=0 turns off all logging
127 8895 aaronmk
128 8920 aaronmk
: "${log_indent=  }"
129 8919 aaronmk
130 8900 aaronmk
# usage: in func:      inc_log_level; ...
131
#        outside func: inc_log_level; ...; dec_log_level
132 8919 aaronmk
alias inc_log_level='declare verbosity="$verbosity" PS4="$log_indent$PS4"
133
let verbosity--'
134
alias dec_log_level='declare verbosity="$verbosity" PS4="${PS4#$log_indent}"
135
let verbosity++'
136 8900 aaronmk
137 8995 aaronmk
fi # load new aliases
138
if self_being_included; then
139
140 8994 aaronmk
# usage: (limit_stderr; cmd...) || return
141 8973 aaronmk
# `|| return` needed on Mac because of bug where -e doesn't apply to ()
142 8995 aaronmk
limit_stderr () { inc_log_level; if ! can_log; then exec 2>/dev/null; fi; }
143 8904 aaronmk
144 8994 aaronmk
limit_stderr_cmd () # usage: [stdout2stderr=1] limit_stderr_cmd cmd...
145 8915 aaronmk
{
146 9010 aaronmk
	case "$1" in echo_run) shift; echo_cmd "$@";; esac
147 8994 aaronmk
	(limit_stderr
148 8915 aaronmk
		if test -n "$stdout2stderr"; then stdout2stderr; fi
149
		"$@"
150 8955 aaronmk
	) || return
151 8915 aaronmk
}
152 9008 aaronmk
alias limit_stderr_cmd='limit_stderr_cmd ' # last space alias-expands next word
153 8911 aaronmk
154 8897 aaronmk
echo_cmd () { if can_log; then echo "$PS4$*" >&2; fi; }
155 8272 aaronmk
156 8278 aaronmk
echo_run () { echo_cmd "$@"; "$@"; }
157
158 8984 aaronmk
# auto-echo common external commands
159
for cmd in rm; do alias "$cmd=echo_run $cmd"; done; unset cmd
160
161 9011 aaronmk
# echo all external commands
162
alias extern="echo_run extern " # last space alias-expands next word
163 8907 aaronmk
164 8929 aaronmk
alias self='extern "$FUNCNAME"' # usage: wrapper () { self ...; }
165
166 8908 aaronmk
# commands that are always external
167
for cmd in env; do alias "$cmd=extern $cmd"; done; unset cmd
168 8872 aaronmk
169 8646 aaronmk
canon_rel_path ()
170
{
171
	local path="$1"
172 8716 aaronmk
	path="$(realpath "$path")" # canonicalize
173 8773 aaronmk
	path="${path#$(pwd -P)/}" # remove any shared prefix with the current dir
174 8646 aaronmk
	echo "$path"
175
}
176
177 8909 aaronmk
function echo_func ()
178 8463 aaronmk
{
179 8901 aaronmk
	inc_log_level
180 8647 aaronmk
	local script="$(canon_rel_path "${BASH_SOURCE[1]}")"
181
	echo_cmd "$script:${BASH_LINENO[0]}" "${FUNCNAME[1]}" "$@"
182 8463 aaronmk
}
183 8885 aaronmk
184 8997 aaronmk
# usage: cmd1 | { pipe_delay; cmd2; }
185
alias pipe_delay='sleep 0.1' # s; display after leading output of cmd1
186
187
fi # load new aliases
188
if self_being_included; then
189
190 8702 aaronmk
echo_stdin () # usage: input|echo_stdin|cmd
191
{
192 8901 aaronmk
	inc_log_level
193 8897 aaronmk
	if can_log; then
194 8998 aaronmk
		pipe_delay
195 8897 aaronmk
		echo ----- >&2
196
		tee -a /dev/stderr;
197
		echo ----- >&2
198
	else cat
199
	fi
200 8702 aaronmk
}
201 8275 aaronmk
202 8856 aaronmk
echo_vars () # usage: echo_vars var...
203 8901 aaronmk
{
204 8922 aaronmk
	inc_log_level; inc_log_level
205 8921 aaronmk
	if can_log; then
206
		local var
207
		for var in "${@%%=*}"; do { echo -n "$PS4"; declare -p "$var";} >&2;done
208
	fi
209 8901 aaronmk
}
210 8641 aaronmk
211 9019 aaronmk
echo_export () { builtin export "$@"; echo_vars "$@"; }
212 8641 aaronmk
213 8713 aaronmk
if test "$verbosity" -ge 2; then
214 8711 aaronmk
	alias export="echo_export" # automatically echo env vars when they are set
215
fi
216 8642 aaronmk
217 8272 aaronmk
usage () { echo "Usage: $1" >&2; (exit 2); }
218
219 8873 aaronmk
fi # load new aliases
220
if self_being_included; then
221
222 9017 aaronmk
223 8871 aaronmk
#### strings
224
225
sed_ere_flag="$(test "$(uname)" = Darwin && echo E || echo r)"
226
227 8930 aaronmk
sed () { self -"$sed_ere_flag" "$@";}
228 8871 aaronmk
229 9017 aaronmk
230 8854 aaronmk
#### vars
231
232
set_var () { eval "$1"'="$2"'; }
233
234 8857 aaronmk
set_inv () { set_var no_"$1" "$(test -n "${!1}" || echo 1)"; }
235
236 8859 aaronmk
# usage: local var=...; local_inv
237 8888 aaronmk
alias local_inv='declare "no_$var=$(test -n "${!var}" || echo 1)"'
238 8859 aaronmk
239 8863 aaronmk
# usage: local prefix=..._; import_vars
240
alias import_vars="$(cat <<'EOF'
241
: "${prefix:?}"
242
local src_var dest_var
243
for src_var in $(eval echo '${!'$prefix'*}'); do
244
	dest_var="${src_var#$prefix}"
245
	local "$dest_var=${!src_var}"; echo_vars "$dest_var"
246
done
247
EOF
248
)"
249
250 9017 aaronmk
251 8854 aaronmk
#### commands
252
253 8934 aaronmk
top_script="$0" # outermost script
254
top_dir="$(dirname "$top_script")"
255 8272 aaronmk
256 8986 aaronmk
# auto-removes a command's output file on error (like make's .DELETE_ON_ERROR)
257
function to_file () # usage: stdout=... to_file cmd...
258 9035 aaronmk
{ : "${stdout?}"; "$@" >"$stdout" || { save_e; log_e; rm "$stdout"; rethrow;}; }
259 8986 aaronmk
alias to_file='to_file ' # last space alias-expands next word
260
261 8465 aaronmk
run_args_cmd () # runs the command line args command
262 8272 aaronmk
{
263 8971 aaronmk
	test $? -eq 0 || return
264 8693 aaronmk
	eval set -- "$(reverse "${BASH_ARGV[@]}")"
265 8971 aaronmk
	test $# -ge 1 || set -- all
266 8648 aaronmk
	echo_cmd "$(canon_rel_path "$0")" "$@"; "$@"
267 8272 aaronmk
}
268
269 8284 aaronmk
fwd () # usage: subdirs=(...); fwd "$FUNCNAME" "$@"
270 8272 aaronmk
{
271 8881 aaronmk
	echo_func
272 8284 aaronmk
	: "${subdirs?}"
273
274 8272 aaronmk
	for subdir in "${subdirs[@]}"; do
275 8280 aaronmk
		"$(dirname "${BASH_SOURCE[1]}")"/"$subdir"/run "$@"
276 8272 aaronmk
	done
277
}
278
279 9017 aaronmk
280 8966 aaronmk
#### URLs
281
282
localize_url () { test _"$1" = _"$(hostname -f)" || echo "$1"; }
283
284 8704 aaronmk
fi