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