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