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