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