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