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 9050 aaronmk
isset () { test "${!1+isset}"; }
10 9002 aaronmk
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 9038 aaronmk
func_override () # usage: func_override old_name__suffix
94
{ from="${1%%__*}" to="$1" copy_func; }
95 9023 aaronmk
96 9038 aaronmk
97 8899 aaronmk
#### integers
98
99 9041 aaronmk
let! () { let "$@" || true; } # always returns true; safe to use for setting
100 8899 aaronmk
	# "If the last ARG evaluates to 0, let returns 1" (`help let`)
101
102 9050 aaronmk
bool2int () { try test ! "$1"; echo "$e"; } # empty->0; non-empty->1
103 9004 aaronmk
104 9017 aaronmk
105 8854 aaronmk
#### arrays
106 8694 aaronmk
107 8833 aaronmk
join () { local IFS="$delim"; echo "$*"; } # usage: delim=... join elems...
108 8816 aaronmk
109 8691 aaronmk
reverse () # usage: array=($(reverse args...))
110
{
111
	local i
112
	for (( i=$#; i >= 1; i-- )); do printf '%q ' "${!i}"; done
113
}
114
115 9017 aaronmk
116 9040 aaronmk
#### paths
117
118
canon_rel_path ()
119
{
120
	local path="$1"
121
	path="$(realpath "$path")" # canonicalize
122
	path="${path#$(pwd -P)/}" # remove any shared prefix with the current dir
123
	echo "$path"
124
}
125
126 9051 aaronmk
# makes $1 a canon_rel_path if it's a filesystem path
127
alias cmd2rel_path="$(cat <<'EOF'
128
if test "$(type -t "$1")" = file && test -e "$1"; then # not relative to PATH
129
	declare _1="$1"; shift
130
	set -- "$(canon_rel_path "$_1")" "$@"
131
fi
132
EOF
133
)"
134 9040 aaronmk
135 9051 aaronmk
136 8854 aaronmk
#### verbose output
137
138 8973 aaronmk
# usage: (stdout2stderr; cmd...) || return
139
# `|| return` needed on Mac because of bug where -e doesn't apply to ()
140 8914 aaronmk
stdout2stderr () { exec >&2; }
141
142 9006 aaronmk
# set verbosity
143 9005 aaronmk
if isset verbose; then : "${verbosity:=$(bool2int "$verbose")}"; fi
144 9006 aaronmk
: "${verbosity=3}" # default
145
: "${verbosity:=0}" # ensure non-empty
146 9007 aaronmk
declare -i verbosity # ensure integer
147 9000 aaronmk
export verbosity # propagate the verbosity to invoked commands
148 8710 aaronmk
149 8898 aaronmk
can_log () { test "$verbosity" -gt 0; } # verbosity=0 turns off all logging
150 8895 aaronmk
151 9064 aaronmk
log () { if can_log; then echo "$PS4$1" >&2; fi; }
152
153 8920 aaronmk
: "${log_indent=  }"
154 8919 aaronmk
155 8900 aaronmk
# usage: in func:      inc_log_level; ...
156
#        outside func: inc_log_level; ...; dec_log_level
157 8919 aaronmk
alias inc_log_level='declare verbosity="$verbosity" PS4="$log_indent$PS4"
158 9041 aaronmk
let! verbosity--'
159 8919 aaronmk
alias dec_log_level='declare verbosity="$verbosity" PS4="${PS4#$log_indent}"
160 9041 aaronmk
let! verbosity++'
161 8900 aaronmk
162 8995 aaronmk
fi # load new aliases
163
if self_being_included; then
164
165 9056 aaronmk
echo_cmd ()
166
{
167
	if can_log; then
168
		case "$1" in extern) shift;; esac # extern implied by the log_level
169
		echo "$PS4$*" >&2
170
	fi
171
}
172
173
echo_run () { cmd2rel_path; echo_cmd "$@"; "$@"; }
174
175 8994 aaronmk
# usage: (limit_stderr; cmd...) || return
176 8973 aaronmk
# `|| return` needed on Mac because of bug where -e doesn't apply to ()
177 8995 aaronmk
limit_stderr () { inc_log_level; if ! can_log; then exec 2>/dev/null; fi; }
178 8904 aaronmk
179 8994 aaronmk
limit_stderr_cmd () # usage: [stdout2stderr=1] limit_stderr_cmd cmd...
180 8915 aaronmk
{
181 9057 aaronmk
	case "$1" in echo_run) shift; cmd2rel_path; echo_cmd "$@";; esac
182 8994 aaronmk
	(limit_stderr
183 9050 aaronmk
		if test "$stdout2stderr"; then stdout2stderr; fi
184 8915 aaronmk
		"$@"
185 8955 aaronmk
	) || return
186 8915 aaronmk
}
187 9008 aaronmk
alias limit_stderr_cmd='limit_stderr_cmd ' # last space alias-expands next word
188 8911 aaronmk
189 8984 aaronmk
# auto-echo common external commands
190
for cmd in rm; do alias "$cmd=echo_run $cmd"; done; unset cmd
191
192 9011 aaronmk
# echo all external commands
193
alias extern="echo_run extern " # last space alias-expands next word
194 8907 aaronmk
195 8929 aaronmk
alias self='extern "$FUNCNAME"' # usage: wrapper () { self ...; }
196
197 8908 aaronmk
# commands that are always external
198
for cmd in env; do alias "$cmd=extern $cmd"; done; unset cmd
199 8872 aaronmk
200 8909 aaronmk
function echo_func ()
201 8463 aaronmk
{
202 8901 aaronmk
	inc_log_level
203 8647 aaronmk
	local script="$(canon_rel_path "${BASH_SOURCE[1]}")"
204
	echo_cmd "$script:${BASH_LINENO[0]}" "${FUNCNAME[1]}" "$@"
205 8463 aaronmk
}
206 8885 aaronmk
207 8997 aaronmk
# usage: cmd1 | { pipe_delay; cmd2; }
208
alias pipe_delay='sleep 0.1' # s; display after leading output of cmd1
209
210
fi # load new aliases
211
if self_being_included; then
212
213 8702 aaronmk
echo_stdin () # usage: input|echo_stdin|cmd
214
{
215 8901 aaronmk
	inc_log_level
216 8897 aaronmk
	if can_log; then
217 8998 aaronmk
		pipe_delay
218 8897 aaronmk
		echo ----- >&2
219
		tee -a /dev/stderr;
220
		echo ----- >&2
221
	else cat
222
	fi
223 8702 aaronmk
}
224 8275 aaronmk
225 9044 aaronmk
alias echo_stdout='echo_stdin' # usage: cmd|echo_stdout
226
227 8856 aaronmk
echo_vars () # usage: echo_vars var...
228 8901 aaronmk
{
229 8922 aaronmk
	inc_log_level; inc_log_level
230 8921 aaronmk
	if can_log; then
231
		local var
232
		for var in "${@%%=*}"; do { echo -n "$PS4"; declare -p "$var";} >&2;done
233
	fi
234 8901 aaronmk
}
235 8641 aaronmk
236 9019 aaronmk
echo_export () { builtin export "$@"; echo_vars "$@"; }
237 8641 aaronmk
238 8713 aaronmk
if test "$verbosity" -ge 2; then
239 8711 aaronmk
	alias export="echo_export" # automatically echo env vars when they are set
240
fi
241 8642 aaronmk
242 8272 aaronmk
usage () { echo "Usage: $1" >&2; (exit 2); }
243
244 8873 aaronmk
fi # load new aliases
245
if self_being_included; then
246
247 9017 aaronmk
248 8871 aaronmk
#### strings
249
250
sed_ere_flag="$(test "$(uname)" = Darwin && echo E || echo r)"
251
252 8930 aaronmk
sed () { self -"$sed_ere_flag" "$@";}
253 8871 aaronmk
254 9017 aaronmk
255 8854 aaronmk
#### vars
256
257
set_var () { eval "$1"'="$2"'; }
258
259 9050 aaronmk
set_inv () { set_var no_"$1" "$(test "${!1}" || echo 1)"; }
260 8857 aaronmk
261 8859 aaronmk
# usage: local var=...; local_inv
262 9050 aaronmk
alias local_inv='declare "no_$var=$(test "${!var}" || echo 1)"'
263 8859 aaronmk
264 8863 aaronmk
# usage: local prefix=..._; import_vars
265
alias import_vars="$(cat <<'EOF'
266
: "${prefix:?}"
267
local src_var dest_var
268
for src_var in $(eval echo '${!'$prefix'*}'); do
269
	dest_var="${src_var#$prefix}"
270
	local "$dest_var=${!src_var}"; echo_vars "$dest_var"
271
done
272
EOF
273
)"
274
275 9017 aaronmk
276 8854 aaronmk
#### commands
277
278 8934 aaronmk
top_script="$0" # outermost script
279
top_dir="$(dirname "$top_script")"
280 8272 aaronmk
281 9062 aaronmk
require_exists () # usage: require_exists file || return 0
282
{ test ! -e "$1" || die "? file "$1" already exists, skipping"; }
283
284 8986 aaronmk
# auto-removes a command's output file on error (like make's .DELETE_ON_ERROR)
285 9058 aaronmk
function to_file () # usage: stdout=... [if_not_exists=1] to_file cmd...
286 9048 aaronmk
{
287
	echo_func
288
	: "${stdout?}"; echo_vars stdout
289 9063 aaronmk
	test ! "$if_not_exists" || require_exists "$stdout" || return 0
290 9048 aaronmk
	"$@" >"$stdout" || { save_e; log_e; rm "$stdout"; rethrow; }
291
}
292 8986 aaronmk
alias to_file='to_file ' # last space alias-expands next word
293
294 8465 aaronmk
run_args_cmd () # runs the command line args command
295 8272 aaronmk
{
296 8971 aaronmk
	test $? -eq 0 || return
297 8693 aaronmk
	eval set -- "$(reverse "${BASH_ARGV[@]}")"
298 8971 aaronmk
	test $# -ge 1 || set -- all
299 8648 aaronmk
	echo_cmd "$(canon_rel_path "$0")" "$@"; "$@"
300 8272 aaronmk
}
301
302 8284 aaronmk
fwd () # usage: subdirs=(...); fwd "$FUNCNAME" "$@"
303 8272 aaronmk
{
304 8881 aaronmk
	echo_func
305 8284 aaronmk
	: "${subdirs?}"
306
307 8272 aaronmk
	for subdir in "${subdirs[@]}"; do
308 8280 aaronmk
		"$(dirname "${BASH_SOURCE[1]}")"/"$subdir"/run "$@"
309 8272 aaronmk
	done
310
}
311
312 9017 aaronmk
313 8966 aaronmk
#### URLs
314
315
localize_url () { test _"$1" = _"$(hostname -f)" || echo "$1"; }
316
317 8704 aaronmk
fi