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 9074 aaronmk
isset() { test "${!1+isset}"; }
8 9002 aaronmk
9 9074 aaronmk
realpath() { readlink -f -- "$1"; }
10 8703 aaronmk
11 9168 aaronmk
include_guard_var() { realpath "$1"|builtin command sed 's/[^a-zA-Z0-9_]/_/g'; }
12 8716 aaronmk
13 9074 aaronmk
self_not_included() # usage: if self_not_included; then ... fi
14 8703 aaronmk
{
15 8971 aaronmk
	test $# -ge 1 || set -- "${BASH_SOURCE[1]}"
16 8703 aaronmk
	local include_guard="$(include_guard_var "$1")"
17 8793 aaronmk
	alias self_being_included=false
18 9003 aaronmk
	! isset "$include_guard" && \
19 8793 aaronmk
	{ eval "$include_guard"=1; alias self_being_included=true; }
20 8703 aaronmk
}
21
22 8793 aaronmk
# to load newly-defined aliases for use in functions in the same file:
23
## fi # load new aliases
24
## if self_being_included; then
25
# this is needed because aliases defined inside an if statement are not
26
# available inside that if statement
27
28 9018 aaronmk
fi
29 9017 aaronmk
30 9018 aaronmk
31 8704 aaronmk
if self_not_included "${BASH_SOURCE[0]}"; then
32
33 9017 aaronmk
34
#### options
35
36 8709 aaronmk
shopt -s expand_aliases
37
38 9017 aaronmk
39 9226 aaronmk
#### vars
40
41
set_var() { eval "$1"'="$2"'; }
42
43
set_inv() { set_var no_"$1" "$(test "${!1}" || echo 1)"; }
44
45
# usage: local var=...; local_inv
46
alias local_inv='declare "no_$var=$(test "${!var}" || echo 1)"'
47
48 9227 aaronmk
unexport() { export -n "$@"; }
49
	# `declare +x` won't work because it defines the var if it isn't set
50
51 9226 aaronmk
get_prefix_vars() { : "${prefix:?}"; eval echo '${!'$prefix'*}'; }
52
53
# usage: local prefix=..._; import_vars
54
# when used inside another alias 2+ levels deep, *must* be run inside a function
55
alias import_vars="$(cat <<'EOF'
56
: "${prefix:?}"
57
declare src_var dest_var
58
for src_var in $(get_prefix_vars); do
59
	dest_var="${src_var#$prefix}"
60
	declare "$dest_var=${!src_var}"; echo_vars "$dest_var"
61
done
62
EOF
63
)"
64
65
66 9017 aaronmk
#### aliases
67
68 9074 aaronmk
unalias() { builtin unalias "$@" 2>&- || true; } # no error if undefined
69 8889 aaronmk
70 9191 aaronmk
# usage: alias alias_='var=value run_cmd '
71
function run_cmd() { "$@"; }
72
alias run_cmd='"run_cmd" ' # last space alias-expands next word
73 9017 aaronmk
74 9191 aaronmk
75 9082 aaronmk
#### functions
76
77 9228 aaronmk
params() { unexport "$@"; } # usage: func() { params param_var...; }
78
79 9082 aaronmk
alias self='command "$FUNCNAME"' # usage: wrapper() { self ...; }
80
81
82 8886 aaronmk
#### exceptions
83
84 9032 aaronmk
# usage: cmd || { save_e; ...; rethrow; }
85 9031 aaronmk
alias export_e='e=$?'
86 9032 aaronmk
alias save_e='declare e=$?'
87 8976 aaronmk
alias rethrow='return "$e"'
88
alias rethrow_subshell='exit "$e"'
89
90 8978 aaronmk
fi # load new aliases
91
if self_being_included; then
92
93 8886 aaronmk
# usage: try cmd...; ignore status; if catch status; then ...; fi; end_try
94
95 9074 aaronmk
function try() { e=0; "$@" || { export_e; true; }; }
96 9177 aaronmk
alias try='declare e; "try" ' # last space alias-expands next word
97 8886 aaronmk
98 9074 aaronmk
catch() { test "$e" -eq "$1"; e=0; }
99 8886 aaronmk
100 9074 aaronmk
ignore() { catch "$@" || true; }
101 8886 aaronmk
102 8977 aaronmk
alias end_try='rethrow'
103
alias end_try_subshell='rethrow_subshell'
104 8886 aaronmk
105 9020 aaronmk
fi # load new aliases
106
if self_being_included; then
107 9017 aaronmk
108 9020 aaronmk
109 8899 aaronmk
#### integers
110
111 9074 aaronmk
let!() { let "$@" || true; } # always returns true; safe to use for setting
112 8899 aaronmk
	# "If the last ARG evaluates to 0, let returns 1" (`help let`)
113
114 9074 aaronmk
bool2int() { try test ! "$1"; echo "$e"; } # empty->0; non-empty->1
115 9004 aaronmk
116 9017 aaronmk
117 9079 aaronmk
#### strings
118
119 9081 aaronmk
repeat() # usage: str=... n=... repeat
120
{
121
	: "${str?}" "${n:?}"; local n="$n" # will be modified in function
122
	for (( ; n > 0; n-- )); do printf '%q' "$str"; done
123
}
124
125 9079 aaronmk
sed_ere_flag="$(test "$(uname)" = Darwin && echo E || echo r)"
126
127
sed() { self -"$sed_ere_flag" "$@";}
128
129 9085 aaronmk
rtrim() { sed 's/[[:space:]]+$//' <<<"$1"; }
130 9079 aaronmk
131 9085 aaronmk
132 8854 aaronmk
#### arrays
133 8694 aaronmk
134 9074 aaronmk
join() { local IFS="$delim"; echo "$*"; } # usage: delim=... join elems...
135 8816 aaronmk
136 9074 aaronmk
reverse() # usage: array=($(reverse args...))
137 8691 aaronmk
{
138
	local i
139 9080 aaronmk
	for (( i=$#; i > 0; i-- )); do printf '%q ' "${!i}"; done
140 8691 aaronmk
}
141
142 9097 aaronmk
contains() # usage: contains value in_array...
143
{
144
	local value="$1"; shift
145
	local elem
146
	for elem in "$@"; do if test "$elem" = "$value"; then return 0; fi; done
147
	return 1
148
}
149 9017 aaronmk
150 9097 aaronmk
151 9040 aaronmk
#### paths
152
153 9074 aaronmk
canon_rel_path()
154 9040 aaronmk
{
155
	local path="$1"
156
	path="$(realpath "$path")" # canonicalize
157
	path="${path#$(pwd -P)/}" # remove any shared prefix with the current dir
158
	echo "$path"
159
}
160
161 9051 aaronmk
# makes $1 a canon_rel_path if it's a filesystem path
162
alias cmd2rel_path="$(cat <<'EOF'
163
if test "$(type -t "$1")" = file && test -e "$1"; then # not relative to PATH
164
	declare _1="$1"; shift
165
	set -- "$(canon_rel_path "$_1")" "$@"
166
fi
167
EOF
168
)"
169 9040 aaronmk
170 9051 aaronmk
171 8854 aaronmk
#### verbose output
172
173 9110 aaronmk
174 9208 aaronmk
err_fd=2 # stderr
175
176 9111 aaronmk
usage() { echo "Usage: $1" >&2; return 2; }
177 9110 aaronmk
178
179
### logging
180
181 9212 aaronmk
log_fd=2 # stderr
182 9209 aaronmk
183 9142 aaronmk
if test "$explicit_errors_only"; then verbosity=0; fi # hide startup logging
184
185 9006 aaronmk
# set verbosity
186 9005 aaronmk
if isset verbose; then : "${verbosity:=$(bool2int "$verbose")}"; fi
187 9145 aaronmk
if isset vb; then : "${verbosity:=$vb}"; fi
188 9220 aaronmk
: "${verbosity=2}" # default
189 9006 aaronmk
: "${verbosity:=0}" # ensure non-empty
190 9119 aaronmk
export verbosity # propagate to invoked commands
191 8710 aaronmk
192 9219 aaronmk
: "${log_level_indent=| }" "${log_indent=}"
193 9176 aaronmk
export log_level_indent log_indent # propagate to invoked commands
194
alias indent='declare log_indent="$log_indent$log_level_indent"'
195
196
# usage: in func:      PS4++; ...
197
#        outside func: PS4++; ...; PS4--
198
alias PS4++='declare PS4="${PS4:0:1}$PS4"'
199
alias PS4--='declare PS4="${PS4#${PS4:0:1}}"'
200
201
# usage: in func:      log++; ...
202
#        outside func: log++; ...; log--
203
alias log++='{ PS4++; declare verbosity="$verbosity"; let! verbosity--; }'
204
alias log--='{ PS4--; declare verbosity="$verbosity"; let! verbosity++; }'
205
206 9190 aaronmk
fi # load new aliases
207
if self_being_included; then
208
209 9074 aaronmk
can_log() { test "$verbosity" -gt 0; } # verbosity=0 turns off all logging
210 8895 aaronmk
211 9212 aaronmk
log() { if can_log; then echo "$log_indent$PS4$1" >&"$log_fd"; fi; }
212 9064 aaronmk
213 9070 aaronmk
# usage: symbol=... log_custom msg
214 9218 aaronmk
log_custom()
215
{
216
	local log_indent="${log_indent//[^ ]/$symbol}" PS4="$symbol${PS4#?}"
217
	log "$@"
218
}
219 9070 aaronmk
220 9221 aaronmk
log_err() { symbol=* verbosity=1 log_fd="$err_fd" log_custom "$@"; }
221 9070 aaronmk
222 9221 aaronmk
log_info() { symbol='#' log_custom "$@"; }
223 9070 aaronmk
224 9067 aaronmk
# usage: cmd || { save_e; log_e; ...; rethrow; }
225 9074 aaronmk
log_e() { log_err "command exited with error $e"; }
226 9067 aaronmk
227 9072 aaronmk
# usage: cmd || [type=...] die msg
228 9074 aaronmk
die() { save_e; "log_${type:-err}" "$1"; rethrow; }
229 9069 aaronmk
230 8919 aaronmk
231 9165 aaronmk
### command echoing
232
233
alias echo_params='log "$*"'
234
235 8995 aaronmk
fi # load new aliases
236
if self_being_included; then
237
238 9197 aaronmk
echo_cmd() { echo_params; }
239 9056 aaronmk
240 9123 aaronmk
## internal commands
241
242 9166 aaronmk
.()
243
{
244 9201 aaronmk
	cmd2rel_path; set -- . "$@"; (log++; echo_params; can_log) && indent || true
245 9166 aaronmk
	builtin "$@"
246
}
247 9158 aaronmk
248 9165 aaronmk
echo_eval() { echo_params; builtin eval "$@"; }
249 9123 aaronmk
250 9110 aaronmk
## external commands
251
252 9224 aaronmk
disable_logging() { echo_eval exec "$log_fd>/dev/null"; }
253
254 9223 aaronmk
function command() # usage: [cmd_log_fd=|1|2|#] command extern_cmd...
255 9138 aaronmk
# to view only explicitly-displayed errors: explicit_errors_only=1 script...
256 9134 aaronmk
{
257 9202 aaronmk
	cmd2rel_path; (echo_params; can_log) && indent || true
258 9192 aaronmk
	(
259 9200 aaronmk
		# the following redirections must happen in exactly this order
260 9225 aaronmk
		if test "$cmd_log_fd"; then
261
			echo_eval exec "$cmd_log_fd>$(if (log++; can_log); then \
262
			echo "&$log_fd"; else echo /dev/null; fi)"
263
		fi
264 9214 aaronmk
		if test "$cmd_log_fd" != 2; then # fd 2 not used for logging
265
			exec 2>&"$err_fd" # assume fd 2 used for errors
266
		fi
267 9200 aaronmk
268 9203 aaronmk
		exec -- "$@" # -- so cmd name not treated as `exec` option
269 9192 aaronmk
	) || return
270 9134 aaronmk
}
271 9133 aaronmk
272 9160 aaronmk
# auto-echo common external commands
273
for cmd in env rm; do alias "$cmd=command $cmd"; done; unset cmd
274 9110 aaronmk
275
## functions
276
277 9186 aaronmk
# usage: func() { [minor=1] echo_func; ... }
278
function echo_func() # usage: [minor=1] "echo_func" "$@" && indent || true
279 9183 aaronmk
# exit status: whether function call was echoed
280 9110 aaronmk
{
281 9186 aaronmk
	log++; if test "$minor"; then log++; fi
282 9110 aaronmk
	local script="$(canon_rel_path "${BASH_SOURCE[1]}")"
283
	echo_cmd "$script:${BASH_LINENO[0]}" "${FUNCNAME[1]}" "$@"
284 9183 aaronmk
	can_log
285 9110 aaronmk
}
286 9184 aaronmk
alias echo_func='"echo_func" "$@" && indent || true'
287 9110 aaronmk
288
## vars
289
290
echo_vars() # usage: echo_vars var...
291
{
292 9174 aaronmk
	log++; log++
293 9110 aaronmk
	if can_log; then
294
		local var
295 9121 aaronmk
		for var in "${@%%=*}"; do log "$(declare -p "$var")"; done
296 9110 aaronmk
	fi
297
}
298
299
echo_export() { builtin export "$@"; echo_vars "$@"; }
300
301
if test "$verbosity" -ge 2; then
302
	alias export="echo_export" # automatically echo env vars when they are set
303
fi
304
305
306
### external command input/output
307 8907 aaronmk
308 8997 aaronmk
# usage: cmd1 | { pipe_delay; cmd2; }
309
alias pipe_delay='sleep 0.1' # s; display after leading output of cmd1
310
311
fi # load new aliases
312
if self_being_included; then
313
314 9074 aaronmk
echo_stdin() # usage: input|echo_stdin|cmd
315 8702 aaronmk
{
316 9174 aaronmk
	log++
317 8897 aaronmk
	if can_log; then
318 8998 aaronmk
		pipe_delay
319 9212 aaronmk
		echo ----- >&"$log_fd"
320
		tee -a /dev/fd/"$log_fd";
321
		echo ----- >&"$log_fd"
322 8897 aaronmk
	else cat
323
	fi
324 8702 aaronmk
}
325 8275 aaronmk
326 9044 aaronmk
alias echo_stdout='echo_stdin' # usage: cmd|echo_stdout
327
328 8873 aaronmk
fi # load new aliases
329
if self_being_included; then
330
331 9017 aaronmk
332 9125 aaronmk
#### streams
333
334 9129 aaronmk
fd_exists() { (: <&"$1") 2>/dev/null; }
335 9125 aaronmk
336
require_fd_not_exists() # usage: require_fd_not_exists fd || return 0
337
{ ! fd_exists "$1" || type=info die "fd $1 already exists, skipping"; }
338
339 9129 aaronmk
set_fd() # usage: dest=fd dir='[<>]' src=fd [noclobber=1] set_fd
340 9125 aaronmk
{
341 9205 aaronmk
	echo_func
342 9125 aaronmk
	: "${dest:?}" "${dir:?}" "${src:?}"
343
	test ! "$noclobber" || require_fd_not_exists "$dest" || return 0
344
	echo_eval exec "$dest$dir&$src"
345
}
346
347 9129 aaronmk
shadow_fd() # usage: prefix=# src=fd dir='[<>]' shadow_fd
348 9125 aaronmk
{
349 9207 aaronmk
	echo_func
350 9125 aaronmk
	: "${prefix:?}" "${src:?}" "${dir:?}"
351 9206 aaronmk
	dest="$prefix$src" noclobber=1 set_fd
352 9125 aaronmk
}
353
354 9126 aaronmk
# convention: use fd 10/11/12 for command-specific alternate stdin/stdout/stderr
355 9125 aaronmk
356 9129 aaronmk
set_global_fds()
357 9128 aaronmk
# allows commands to access global stdin/stdout/stderr using fd 20/21/22
358 9127 aaronmk
# this works even when /dev/tty isn't available
359 9128 aaronmk
{
360 9207 aaronmk
	log++; echo_func; log++
361 9128 aaronmk
	local prefix=2
362
	# ignore errors if a source fd isn't open
363
	src=0 dir='<' shadow_fd || true
364
	src=1 dir='>' shadow_fd || true
365
	src=2 dir='>' shadow_fd || true
366
}
367
set_global_fds
368 9208 aaronmk
err_fd=22 # global stderr
369 9126 aaronmk
370 9139 aaronmk
# usage: explicit_errors_only=1 script...
371 9135 aaronmk
# show only explicitly-displayed errors (which have been redirected to fd 22)
372 9137 aaronmk
# most of the time this has the same effect as `verbosity=0 script...`,
373
# which displays everything that isn't explicitly hidden
374 9140 aaronmk
# this option should only be used for testing the explicit error displaying
375 9209 aaronmk
if test "$explicit_errors_only"; then disable_logging; fi
376 9127 aaronmk
377 9135 aaronmk
378 9068 aaronmk
#### functions
379
380 9074 aaronmk
func_exists() { declare -f "$1" >/dev/null; }
381 9068 aaronmk
382 9074 aaronmk
copy_func() # usage: from=... to=... copy_func
383 9068 aaronmk
# $to must not exist. to get around the no-clobber restriction, use `unset -f`.
384
{
385
	: "${from:?}" "${to:?}"
386
	func_exists "$from" || die "function does not exist: $from"
387
	! func_exists "$to" || die "function already exists: $to"
388
	local from_def="$(declare -f "$from")"
389
	eval "$to${from_def#$from}"
390
}
391
392 9074 aaronmk
func_override() # usage: func_override old_name__suffix
393 9068 aaronmk
{ from="${1%%__*}" to="$1" copy_func; }
394
395 9098 aaronmk
ensure_nested_func() # usage: func__nested_func() { ensure_nested_func; ... }
396
{
397
	local nested_func="${FUNCNAME[1]}"
398
	local func="${nested_func%%__*}"
399
	contains "$func" "${FUNCNAME[@]}" || \
400
		die "$nested_func() must be used by $func()"
401
}
402 9068 aaronmk
403 9098 aaronmk
404 8854 aaronmk
#### commands
405
406 9188 aaronmk
top_script="$(canon_rel_path "$0")" # outermost script
407 8934 aaronmk
top_dir="$(dirname "$top_script")"
408 8272 aaronmk
409 9122 aaronmk
require_not_exists() # usage: require_not_exists file || return 0
410 9073 aaronmk
{ test ! -e "$1" || type=info die "file "$1" already exists, skipping"; }
411 9062 aaronmk
412 8986 aaronmk
# auto-removes a command's output file on error (like make's .DELETE_ON_ERROR)
413 9074 aaronmk
function to_file() # usage: stdout=... [if_not_exists=1] to_file cmd...
414 9048 aaronmk
{
415
	echo_func
416
	: "${stdout?}"; echo_vars stdout
417 9122 aaronmk
	test ! "$if_not_exists" || require_not_exists "$stdout" || return 0
418 9048 aaronmk
	"$@" >"$stdout" || { save_e; log_e; rm "$stdout"; rethrow; }
419
}
420 9177 aaronmk
alias to_file='"to_file" ' # last space alias-expands next word
421 8986 aaronmk
422 9074 aaronmk
run_args_cmd() # runs the command line args command
423 8272 aaronmk
{
424 8971 aaronmk
	test $? -eq 0 || return
425 8693 aaronmk
	eval set -- "$(reverse "${BASH_ARGV[@]}")"
426 8971 aaronmk
	test $# -ge 1 || set -- all
427 9189 aaronmk
	echo_cmd "$top_script" "$@"; "$@"
428 8272 aaronmk
}
429
430 9074 aaronmk
fwd() # usage: subdirs=(...); fwd "$FUNCNAME" "$@"
431 8272 aaronmk
{
432 8881 aaronmk
	echo_func
433 8284 aaronmk
	: "${subdirs?}"
434
435 8272 aaronmk
	for subdir in "${subdirs[@]}"; do
436 8280 aaronmk
		"$(dirname "${BASH_SOURCE[1]}")"/"$subdir"/run "$@"
437 8272 aaronmk
	done
438
}
439
440 9017 aaronmk
441 8966 aaronmk
#### URLs
442
443 9074 aaronmk
localize_url() { test _"$1" = _"$(hostname -f)" || echo "$1"; }
444 8966 aaronmk
445 8704 aaronmk
fi