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