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