Project

General

Profile

1 8291 aaronmk
#!/bin/bash -e
2 9328 aaronmk
set -o errexit -o pipefail # errexit in case caller's #! line missing -e
3 8952 aaronmk
4 9018 aaronmk
if test ! "$_util_sh_include_guard_utils"; then
5
_util_sh_include_guard_utils=1
6
7 9798 aaronmk
isset() { declare -p "$1" &>/dev/null; }
8 9002 aaronmk
9 9074 aaronmk
realpath() { readlink -f -- "$1"; }
10 8703 aaronmk
11 9314 aaronmk
str2varname() { echo "${1//[^a-zA-Z0-9_]/_}"; }
12 8716 aaronmk
13 9312 aaronmk
include_guard_var() { str2varname "$(realpath "$1")"; }
14
15 9074 aaronmk
self_not_included() # usage: if self_not_included; then ... fi
16 8703 aaronmk
{
17 8971 aaronmk
	test $# -ge 1 || set -- "${BASH_SOURCE[1]}"
18 8703 aaronmk
	local include_guard="$(include_guard_var "$1")"
19 8793 aaronmk
	alias self_being_included=false
20 9003 aaronmk
	! isset "$include_guard" && \
21 8793 aaronmk
	{ eval "$include_guard"=1; alias self_being_included=true; }
22 8703 aaronmk
}
23
24 8793 aaronmk
# to load newly-defined aliases for use in functions in the same file:
25
## fi # load new aliases
26
## if self_being_included; then
27
# this is needed because aliases defined inside an if statement are not
28
# available inside that if statement
29
30 9018 aaronmk
fi
31 9017 aaronmk
32 9018 aaronmk
33 8704 aaronmk
if self_not_included "${BASH_SOURCE[0]}"; then
34
35 9017 aaronmk
36
#### options
37
38 8709 aaronmk
shopt -s expand_aliases
39
40 9017 aaronmk
41 9789 aaronmk
#### stubs
42
43 9794 aaronmk
__caller_indent='log_indent="$log_indent$log_indent_step"'
44
alias caller_indent="$__caller_indent"
45
alias indent="declare $__caller_indent"
46
47 9789 aaronmk
function echo_func() { :; }
48 9790 aaronmk
alias echo_func='"echo_func" "$FUNCNAME" "$@" && indent || true'
49 9789 aaronmk
50 9796 aaronmk
function echo_run() { :; }
51
alias echo_run='"echo_run" ' # last space alias-expands next word
52 9789 aaronmk
53 9797 aaronmk
function echo_vars() { :; }
54 9796 aaronmk
55 9797 aaronmk
56 9226 aaronmk
#### vars
57
58
set_var() { eval "$1"'="$2"'; }
59
60 9420 aaronmk
set_default() { if ! isset "$1"; then set_var "$@"; fi; }
61
62 9226 aaronmk
set_inv() { set_var no_"$1" "$(test "${!1}" || echo 1)"; }
63
64
# usage: local var=...; local_inv
65
alias local_inv='declare "no_$var=$(test "${!var}" || echo 1)"'
66
67 9227 aaronmk
unexport() { export -n "$@"; }
68
	# `declare +x` won't work because it defines the var if it isn't set
69
70 9236 aaronmk
alias local_export='declare -x' # combines effects of local and export
71
72 9226 aaronmk
get_prefix_vars() { : "${prefix:?}"; eval echo '${!'$prefix'*}'; }
73
74
# usage: local prefix=..._; import_vars
75
# when used inside another alias 2+ levels deep, *must* be run inside a function
76
alias import_vars="$(cat <<'EOF'
77
: "${prefix:?}"
78
declare src_var dest_var
79
for src_var in $(get_prefix_vars); do
80
	dest_var="${src_var#$prefix}"
81
	declare "$dest_var=${!src_var}"; echo_vars "$dest_var"
82
done
83
EOF
84
)"
85
86
87 9311 aaronmk
#### caching
88
89
## shell-variable-based caching
90
91 9330 aaronmk
# usage: local cache_key=...; load_cache; \
92 9331 aaronmk
# if ! cached; then save_cache value || return; fi; echo_cached_value
93 9561 aaronmk
# cache_key for function inputs: "$(declare -p kw_param...) $*"
94 9311 aaronmk
alias load_cache='declare cache_var="$(str2varname "${FUNCNAME}___$cache_key")"'
95
alias cached='isset "$cache_var"'
96
alias save_cache='set_var "$cache_var"'
97
alias echo_cached_value='echo "${!cache_var}"'
98
99
clear_cache() # usage: func=... clear_cache
100
{ : "${func:?}"; unset $(prefix="${func}___" get_prefix_vars); }
101
102
fi # load new aliases
103
if self_being_included; then
104
105
106 9017 aaronmk
#### aliases
107
108 9074 aaronmk
unalias() { builtin unalias "$@" 2>&- || true; } # no error if undefined
109 8889 aaronmk
110 9191 aaronmk
# usage: alias alias_='var=value run_cmd '
111
function run_cmd() { "$@"; }
112
alias run_cmd='"run_cmd" ' # last space alias-expands next word
113 9017 aaronmk
114 9688 aaronmk
alias_append() { eval $(alias "$1")'"$2"'; } # usage: alias_append alias '; cmd'
115 9191 aaronmk
116 9688 aaronmk
117 9082 aaronmk
#### functions
118
119 9235 aaronmk
kw_params() # usage: func() { kw_params param_var...; }; ...; param_var=... cmd
120 9229 aaronmk
# removes keyword-param-only vars from the environment
121
{ unexport "$@"; }
122 9228 aaronmk
123 9799 aaronmk
# usage: cmd=... foreach_arg
124
function foreach_arg()
125
{
126 9808 aaronmk
	echo_func; kw_params cmd; : "${cmd:?}"
127
	local a; for a in "$@"; do
128 9806 aaronmk
		a="$(clog++ echo_run "$cmd" "$a")" || return; args+=("$a")
129
	done
130 9799 aaronmk
	echo_vars args
131
}
132
alias foreach_arg='"foreach_arg" "$@"; set -- "${args[@]}"; unset args'
133
134 9865 aaronmk
alias self='command "${FUNCNAME%%__*}"' # usage: wrapper() { self ...; }
135
alias self_sys='command -p "${FUNCNAME%%__*}"' # wrapper() { self_sys ...; }
136 9082 aaronmk
137 9678 aaronmk
pf() { declare -f "$@"; } # usage: pf function # prints func decl for debugging
138 9082 aaronmk
139 9677 aaronmk
all_funcs() # usage: for func in $(all_funcs); do ...; done # all declared funcs
140
{ declare -F|while read -r line; do echo -n "${line#declare -f } "; done; }
141 9673 aaronmk
142 9677 aaronmk
143 8886 aaronmk
#### exceptions
144
145 9032 aaronmk
# usage: cmd || { save_e; ...; rethrow; }
146 9031 aaronmk
alias export_e='e=$?'
147 9032 aaronmk
alias save_e='declare e=$?'
148 8976 aaronmk
alias rethrow='return "$e"'
149
alias rethrow_subshell='exit "$e"'
150
151 8978 aaronmk
fi # load new aliases
152
if self_being_included; then
153
154 9535 aaronmk
# usage: try cmd...; ignore_e status; if catch status; then ...; fi; end_try
155 8886 aaronmk
156 9448 aaronmk
function try() { e=0; benign_error=1 "$@" || { export_e; true; }; }
157 9177 aaronmk
alias try='declare e; "try" ' # last space alias-expands next word
158 8886 aaronmk
159 9534 aaronmk
catch() { test "$e" -eq "$1" && e=0; }
160 8886 aaronmk
161 9535 aaronmk
ignore_e() { catch "$@" || true; }
162 8886 aaronmk
163 8977 aaronmk
alias end_try='rethrow'
164
alias end_try_subshell='rethrow_subshell'
165 8886 aaronmk
166 9536 aaronmk
ignore() { save_e; ignore_e "$@"; rethrow; } # usage: try cmd || ignore status
167
168 9551 aaronmk
### signals
169
170
sig_e() { echo $(( 128+$(kill -l "$1") )); } # usage: sig_e SIGINT, etc.
171
172
ignore_sig() { ignore "$(sig_e "$1")"; }
173
174 9678 aaronmk
# usage: piped_cmd cmd1...|cmd2... # cmd2 doesn't read all its input
175 9551 aaronmk
function piped_cmd() { "$@" || ignore_sig SIGPIPE; }
176
alias piped_cmd='"piped_cmd" ' # last space alias-expands next word
177
178 9020 aaronmk
fi # load new aliases
179
if self_being_included; then
180 9017 aaronmk
181 9020 aaronmk
182 8899 aaronmk
#### integers
183
184 9074 aaronmk
let!() { let "$@" || true; } # always returns true; safe to use for setting
185 8899 aaronmk
	# "If the last ARG evaluates to 0, let returns 1" (`help let`)
186
187 9074 aaronmk
bool2int() { try test ! "$1"; echo "$e"; } # empty->0; non-empty->1
188 9004 aaronmk
189 9696 aaronmk
int2exit() { (( "$1" != 0 )); }
190 9017 aaronmk
191 9697 aaronmk
exit2bool() { if (( $? == 0 )); then echo 1; fi } # 0->non-empty; !=0->empty
192 9538 aaronmk
193 9697 aaronmk
194 9364 aaronmk
#### floats
195
196
int_part() { echo "${1%%.*}"; }
197
198
dec_suffix() { echo "${1#$(int_part "$1")}"; }
199
200
round_down() { int_part "$1"; }
201
202
float+int() { echo "$(($(int_part "$1")+$2))$(dec_suffix "$1")"; }
203
204 9544 aaronmk
float_set_min() { if (($(int_part $1) >= $2)); then echo $1; else echo $2; fi; }
205 9364 aaronmk
206 9544 aaronmk
207 9079 aaronmk
#### strings
208
209 9653 aaronmk
starts_with() { test "${2#$1}" != "$2"; } # usage: starts_with pattern str
210
211 9711 aaronmk
match_prefix() # usage: match_prefix pattern str
212
{ if starts_with "$1" "$2"; then echo "${2%${2#$1}}"; fi }
213
214 9081 aaronmk
repeat() # usage: str=... n=... repeat
215
{
216 9304 aaronmk
	: "${str?}" "${n:?}"; local result= n="$n" # n will be modified in function
217
	for (( ; n > 0; n-- )); do result="$result$str"; done
218
	echo "$result"
219 9081 aaronmk
}
220
221 9550 aaronmk
sed_cmd="sed -`case "$(uname)" in Darwin) echo E;; *) echo r;; esac`"
222 9366 aaronmk
alias sed="$sed_cmd"
223 9079 aaronmk
224 9366 aaronmk
fi # load new aliases
225
if self_being_included; then
226 9079 aaronmk
227 9425 aaronmk
rtrim() { log+ 3; sed 's/[[:space:]]+$//' <<<"$1"; }
228 9079 aaronmk
229 9085 aaronmk
230 8854 aaronmk
#### arrays
231 8694 aaronmk
232 9938 aaronmk
echo1() { echo "$1"; } # usage: echo1 values...
233
234 9074 aaronmk
join() { local IFS="$delim"; echo "$*"; } # usage: delim=... join elems...
235 8816 aaronmk
236 9074 aaronmk
reverse() # usage: array=($(reverse args...))
237 8691 aaronmk
{
238
	local i
239 9080 aaronmk
	for (( i=$#; i > 0; i-- )); do printf '%q ' "${!i}"; done
240 8691 aaronmk
}
241
242 9097 aaronmk
contains() # usage: contains value in_array...
243
{
244
	local value="$1"; shift
245
	local elem
246
	for elem in "$@"; do if test "$elem" = "$value"; then return 0; fi; done
247
	return 1
248
}
249 9017 aaronmk
250 9715 aaronmk
#### streams
251 9097 aaronmk
252 9715 aaronmk
pipe_delay() # usage: cmd1 | { pipe_delay; cmd2; }
253
{ sleep 0.1; } # s; display after leading output of cmd1
254
255
256 8854 aaronmk
#### verbose output
257
258 9110 aaronmk
259 9208 aaronmk
err_fd=2 # stderr
260
261 9111 aaronmk
usage() { echo "Usage: $1" >&2; return 2; }
262 9110 aaronmk
263
264 9452 aaronmk
### log++
265 9110 aaronmk
266 9361 aaronmk
log_fd=2 # initially stderr
267 9209 aaronmk
268 9142 aaronmk
if test "$explicit_errors_only"; then verbosity=0; fi # hide startup logging
269
270 9006 aaronmk
# set verbosity
271 9005 aaronmk
if isset verbose; then : "${verbosity:=$(bool2int "$verbose")}"; fi
272 9145 aaronmk
if isset vb; then : "${verbosity:=$vb}"; fi
273 9272 aaronmk
: "${verbosity=1}" # default
274 9006 aaronmk
: "${verbosity:=0}" # ensure non-empty
275 9119 aaronmk
export verbosity # propagate to invoked commands
276 9381 aaronmk
export PS4 # follows verbosity, so also propagate this
277 8710 aaronmk
278 9731 aaronmk
is_outermost="$(! isset log_level; exit2bool)" # if util.sh env not yet set up
279
280 9542 aaronmk
# set log_level
281
: "${log_level=$(( ${#PS4}-1 ))}" # defaults to # non-space symbols in PS4
282
export log_level # propagate to invoked commands
283
284 9396 aaronmk
verbosity_int() { round_down "$verbosity"; }
285
286 9450 aaronmk
# verbosities (and `make` equivalents):
287 9359 aaronmk
# 0: just print errors. useful for cron jobs.
288 9451 aaronmk
#    vs. make: equivalent to --silent, but suppresses external command output
289 9359 aaronmk
# 1: also external commands run. useful for running at the command line.
290 9450 aaronmk
#    vs. make: not provided (but sorely needed to avoid excessive output)
291 9359 aaronmk
# 2: full graphical call tree. useful for determining where error occurred.
292 9450 aaronmk
#    vs. make: equivalent to default verbosity, but with much-needed indents
293 9360 aaronmk
# 3: also values of kw params and variables. useful for low-level debugging.
294 9450 aaronmk
#    vs. make: not provided; need to manually use $(error $(var))
295 9359 aaronmk
# 4: also variables in util.sh commands. useful for debugging util.sh.
296 9450 aaronmk
#    vs. make: somewhat similar to --print-data-base
297 9359 aaronmk
# 5: also variables in logging commands themselves. useful for debugging echo_*.
298 9450 aaronmk
#    vs. make: not provided; need to search Makefile for @ at beginning of cmd
299 9359 aaronmk
# 6+: not currently used (i.e. same as 5)
300
301 9287 aaronmk
# definition: the log_level is the minimum verbosity needed to display a message
302
# for messages that use can_log(), the log_level starts with *1*, not 0
303
# for unfiltered messages, the log_level is 0 (i.e. still output at verbosity=0)
304 9288 aaronmk
# to view a message's log_level, count the # of + signs before it in the output
305 9284 aaronmk
306 9305 aaronmk
fi # load new aliases
307
if self_being_included; then
308
309 9299 aaronmk
# usage: in func:      log++; ...         OR  log_local; "log++"; ...
310 9176 aaronmk
#        outside func: log++; ...; log--
311 9720 aaronmk
#        before cmd:  "log++" cmd  OR  "log+" # cmd  OR  "log++" "log++" cmd
312 9716 aaronmk
# with a cmd, assignments are applied just to it, so log_local is not needed
313 9302 aaronmk
# without a cmd, "$@" expands to nothing and assignments are applied to caller
314 9305 aaronmk
# "${@:2}" expands to all of $@ after *1st* arg, not 2nd ($@ indexes start at 1)
315 9373 aaronmk
log+()
316
{
317
	# no local vars because w/o cmd, assignments should be applied to caller
318 9545 aaronmk
	PS4="$(str="${PS4:0:1}" n=$((log_level+$1-1)) repeat)${PS4: -2}"; \
319 9543 aaronmk
	log_level=$((log_level+$1)) \
320 9377 aaronmk
	verbosity="$(float+int "$verbosity" "-$1")" "${@:2}"
321 9373 aaronmk
}
322 9374 aaronmk
log++() { log+  1 "$@"; }
323
log--() { log+ -1 "$@"; }
324 9542 aaronmk
alias log_local=\
325
'declare PS4="$PS4" log_level="$log_level" verbosity="$verbosity"'
326 9395 aaronmk
alias log+='log_local; "log+"' # don't expand next word because it's not a cmd
327 9301 aaronmk
alias log++='log_local; "log++" ' # last space alias-expands next word
328
alias log--='log_local; "log--" ' # last space alias-expands next word
329 9751 aaronmk
# no clog+ alias because next word is not a cmd
330
alias clog++='"log++" ' # last space alias-expands next word
331
alias clog--='"log--" ' # last space alias-expands next word
332 9176 aaronmk
333 9846 aaronmk
verbosity_min() # usage: verbosity_min {min|} # ''->verbosity=''
334
{ if test ! "$1" -o "$(verbosity_int)" -lt "$1"; then verbosity="$1"; fi; }
335 9397 aaronmk
alias verbosity_min='log_local; "verbosity_min"'
336 9289 aaronmk
337 9878 aaronmk
# usage: (verbosity_compat; cmd)
338 9867 aaronmk
function verbosity_compat()
339 9878 aaronmk
{ echo_func; if ((verbosity == 1)); then unset verbosity; fi; }
340 9867 aaronmk
alias verbosity_compat='declare verbosity; "verbosity_compat"'
341 9397 aaronmk
342 9867 aaronmk
343 9289 aaronmk
# indent for call tree. this is *not* the log_level (below).
344 9382 aaronmk
: "${log_indent_step=| }" "${log_indent=}"
345
export log_indent_step log_indent # propagate to invoked commands
346 9289 aaronmk
347 9794 aaronmk
# see indent alias in stubs
348 9289 aaronmk
349
350 9190 aaronmk
fi # load new aliases
351
if self_being_included; then
352
353 9396 aaronmk
can_log() { test "$(verbosity_int)" -gt 0; }
354 9380 aaronmk
	# verbosity=0 turns off all logging
355 8895 aaronmk
356 9212 aaronmk
log() { if can_log; then echo "$log_indent$PS4$1" >&"$log_fd"; fi; }
357 9064 aaronmk
358 9270 aaronmk
log_custom() # usage: symbol=... log_custom msg
359 9242 aaronmk
{ log_indent="${log_indent//[^ ]/$symbol}" PS4="${PS4//[^ ]/$symbol}" log "$@";}
360 9070 aaronmk
361 9251 aaronmk
log_err() { symbol='#' verbosity=1 log_fd="$err_fd" log_custom "$@"; }
362 9070 aaronmk
363 9250 aaronmk
log_info() { symbol=: log_custom "$@"; }
364 9070 aaronmk
365 9678 aaronmk
die() # usage: cmd || [type=...] die msg # msg can use $? but not $()
366 9270 aaronmk
{ save_e; kw_params type; "log_${type:-err}" "$1"; rethrow; }
367 9069 aaronmk
368 9447 aaronmk
die_e() # usage: cmd || [benign_error=1] die_e [|| handle error]
369
{
370
	save_e; kw_params benign_error
371 9449 aaronmk
	if test "$benign_error"; then log++; fi
372 9447 aaronmk
	type="${benign_error:+info}" die "command exited with \
373
$(if test "$benign_error"; then echo status; else echo error; fi) $e"
374
	rethrow
375
}
376 8919 aaronmk
377 9437 aaronmk
378 9233 aaronmk
#### functions
379
380
func_exists() { declare -f "$1" >/dev/null; }
381
382
copy_func() # usage: from=... to=... copy_func
383
# $to must not exist. to get around the no-clobber restriction, use `unset -f`.
384
{
385
	: "${from:?}" "${to:?}"
386
	func_exists "$from" || die "function does not exist: $from"
387
	! func_exists "$to" || die "function already exists: $to"
388
	local from_def="$(declare -f "$from")"
389
	eval "$to${from_def#$from}"
390
}
391
392
func_override() # usage: func_override old_name__suffix
393 9559 aaronmk
{ from="${1%__*}" to="$1" copy_func; }
394 9233 aaronmk
395
ensure_nested_func() # usage: func__nested_func() { ensure_nested_func; ... }
396
{
397
	local nested_func="${FUNCNAME[1]}"
398
	local func="${nested_func%%__*}"
399
	contains "$func" "${FUNCNAME[@]}" || \
400
		die "$nested_func() must be used by $func()"
401
}
402
403
404 9240 aaronmk
#### paths
405
406 9313 aaronmk
# cache realpath
407
: "${realpath_cache=}" # default off because slower than without
408
if test "$realpath_cache"; then
409
func_override realpath__no_cache
410
realpath() # caches the last result for efficiency
411
{
412
	local cache_key="$*"; load_cache
413 9331 aaronmk
	if ! cached; then save_cache "$(realpath__no_cache "$@")" || return; fi
414 9313 aaronmk
	echo_cached_value
415
}
416
fi
417
418 9244 aaronmk
rel_path() # usage: base_dir=... path=... rel_path
419 9240 aaronmk
{
420 9788 aaronmk
	kw_params base_dir path
421 9244 aaronmk
	: "${base_dir:?}" "${path:?}"
422
423 9246 aaronmk
	local path="$path/" # add *extra* / to match path when exactly = base_dir
424
	path="${path#$base_dir/}" # remove prefix shared with base_dir
425
	path="${path%/}" # remove any remaining extra trailing /
426 9244 aaronmk
427 9245 aaronmk
	if test ! "$path"; then path=.; fi # ensure non-empty
428
429 9244 aaronmk
	echo_vars path
430 9240 aaronmk
	echo "$path"
431
}
432
433 9309 aaronmk
cd -P . # expand symlinks in $PWD so it matches the output of realpath
434
# do before setting $top_script_abs so realpath has less symlinks to resolve
435
436 9791 aaronmk
canon_rel_path() # usage: [base_dir=...] canon_rel_path path
437 9331 aaronmk
{
438 9791 aaronmk
	kw_params base_dir; local base_dir="${base_dir-$PWD}"
439
	base_dir="$(realpath "$base_dir")" || return
440 9331 aaronmk
	local path; path="$(realpath "$1")" || return
441 9791 aaronmk
	rel_path
442 9331 aaronmk
}
443 9244 aaronmk
444 9240 aaronmk
# makes $1 a canon_rel_path if it's a filesystem path
445
alias cmd2rel_path="$(cat <<'EOF'
446
if test "$(type -t "$1")" = file && test -e "$1"; then # not relative to PATH
447
	declare _1="$1"; shift
448 9788 aaronmk
	_1="$(clog++ canon_rel_path "$_1")" || return
449 9331 aaronmk
	set -- "$_1" "$@"
450 9240 aaronmk
fi
451
EOF
452
)"
453
454 9810 aaronmk
# usage: path_parents path; use ${dirs[@]} # includes the path itself
455
function path_parents()
456
{
457
	echo_func; local path="$1" prev_path=; dirs=()
458
	while test "$path" != "$prev_path"; do
459
		prev_path="$path"
460
		dirs+=("$path")
461
		path="${path%/*}"
462
	done
463
}
464
alias path_parents='declare dirs; "path_parents"'
465 9240 aaronmk
466 9810 aaronmk
467 9240 aaronmk
#### verbose output
468
469
470 9165 aaronmk
### command echoing
471
472
alias echo_params='log "$*"'
473
474 8995 aaronmk
fi # load new aliases
475
if self_being_included; then
476
477 9197 aaronmk
echo_cmd() { echo_params; }
478 9056 aaronmk
479 9549 aaronmk
function echo_run() { echo_params; "$@"; }
480 9796 aaronmk
# see echo_run alias after stub
481 9539 aaronmk
482 9278 aaronmk
echo_eval() { echo_params; builtin eval "$@"; }
483
484 9730 aaronmk
# usage: redirs=(...); [cmd_name_log_inc=#] echo_redirs_cmd
485 9655 aaronmk
function echo_redirs_cmd()
486
{
487 9730 aaronmk
	local cmd_name_log_inc="${cmd_name_log_inc-0}"
488
489 9657 aaronmk
	# print <>file redirs before cmd, because they introduce it
490 9730 aaronmk
	"log+" "$cmd_name_log_inc" echo_cmd "$@" $(
491 9809 aaronmk
		set -- "${redirs[@]}" # operate on ${redirs[@]}
492 9657 aaronmk
		while test "$#" -gt 0 && starts_with '[<>][^&]' "$1"
493
		do log "$1 \\"; shift; done # log() will run *before* echo_cmd itself
494
		echo "$@"
495 9655 aaronmk
	)
496
}
497
alias echo_redirs_cmd='"echo_redirs_cmd" "$@"'
498
499 9263 aaronmk
## vars
500
501
echo_vars() # usage: echo_vars var...
502
{
503 9320 aaronmk
	log+ 2
504 9263 aaronmk
	if can_log; then
505
		local var
506
		for var in "${@%%=*}"; do
507
			if isset "$var"; then log "$(declare -p "$var")"; fi
508
		done
509
	fi
510
}
511
512
echo_export() { builtin export "$@"; echo_vars "$@"; }
513
514 9379 aaronmk
alias export="echo_export" # automatically echo env vars when they are set
515 9263 aaronmk
516
func_override kw_params__lang
517
kw_params() { kw_params__lang "$@"; echo_vars "$@"; } # echo all keyword params
518
519 9273 aaronmk
## functions
520 9264 aaronmk
521 9315 aaronmk
# usage: local func=...; set_func_loc; use $file, $line
522
alias set_func_loc="$(cat <<'EOF'
523
: "${func:?}"
524
local func_info="$(shopt -s extdebug; declare -F "$func")" # 'func line file'
525
func_info="${func_info#$func }"
526
local line="${func_info%% *}"
527
local file="${func_info#$line }"
528
EOF
529
)"
530
531
fi # load new aliases
532
if self_being_included; then
533
534
func_loc() # gets where function declared in the format file:line
535 9331 aaronmk
{
536
	local func="$1"; set_func_loc
537
	file="$(canon_rel_path "$file")" || return
538
	echo "$file:$line"
539
}
540 9315 aaronmk
541 9273 aaronmk
# usage: func() { [minor=1] echo_func; ... }
542 9317 aaronmk
function echo_func()
543 9871 aaronmk
# usage: "echo_func" "$FUNCNAME" "$@" && indent || true
544 9273 aaronmk
# exit status: whether function call was echoed
545
{
546 9872 aaronmk
	log++; can_log || return
547 9317 aaronmk
	local func="$1"; shift
548 9788 aaronmk
	local loc; loc="$(clog++ func_loc "$func")" || return
549 9331 aaronmk
	echo_cmd "$loc" "$func" "$@"
550 9273 aaronmk
}
551 9790 aaronmk
# see echo_func alias after stub
552 9273 aaronmk
553 9276 aaronmk
fi # load new aliases
554
if self_being_included; then
555 9273 aaronmk
556 9276 aaronmk
557 9279 aaronmk
#### streams
558
559
fd_exists() { (: <&"$1") 2>/dev/null; }
560
561
require_fd_not_exists() # usage: require_fd_not_exists fd || return 0
562
{ ! fd_exists "$1" || type=info die "fd $1 already exists, skipping"; }
563
564 9712 aaronmk
set_fds() # usage: set_fds redirect...
565
{
566
	echo_func
567
568
	# add #<>&- before every #<>&# reopen to fix strange bash bug
569 9804 aaronmk
	local redirs=() i
570 9712 aaronmk
	for i in "$@"; do
571 9713 aaronmk
		local redir_prefix="$(match_prefix '*[<>]' "$i")"
572 9712 aaronmk
		if test "$redir_prefix"; then redirs+=("$redir_prefix&-"); fi
573 9713 aaronmk
		redirs+=("$i")
574 9712 aaronmk
	done
575
	set -- "${redirs[@]}"
576
577 9795 aaronmk
	if (($# > 0)); then echo_eval exec "$@"; fi
578 9712 aaronmk
}
579 9279 aaronmk
580
fd_set_default() # usage: fd_set_default 'dest[<>]src'
581
{
582
	echo_func
583
	local dest="${1%%[<>]*}"
584
	require_fd_not_exists "$dest" || return 0
585
	set_fds "$1"
586
}
587
588 9728 aaronmk
function filter_fd() # usage: (fd=# filter_fd filter_cmd...; with filter...)
589 9717 aaronmk
# useful e.g. to filter logging output or highlight errors
590
{
591
	echo_func; kw_params fd; : "${fd?}"
592
	set_fds "$fd>" >(pipe_delay; redirs=(">&$fd" "${redirs[@]}"); redir "$@")
593
	pipe_delay; pipe_delay # wait for >()'s pipe_delay and initial logging
594
}
595 9728 aaronmk
alias filter_fd='"filter_fd" ' # last space alias-expands next word
596 9717 aaronmk
597 9651 aaronmk
# convention: use fd 40/41/42 for command-specific alternate stdin/stdout/stderr
598 9900 aaronmk
# mnemonic: 4 looks like A for Alternate
599 9651 aaronmk
# do NOT use 1x, which are used by eval (which is used by set_fds())
600
# do NOT use 2x, which are used as global stdin/stdout/stderr
601
# do NOT use 3x, which are used for logging
602 9279 aaronmk
603 9282 aaronmk
setup_log_fd() # view logging output at verbosity >= 5
604
{
605 9319 aaronmk
	log+ 4; log-- echo_func
606 9282 aaronmk
	fd_set_default '30>&2' || true # stdlog
607
	log_fd=30 # stdlog
608
}
609
setup_log_fd
610
611 9279 aaronmk
set_global_fds()
612
# allows commands to access global stdin/stdout/stderr using fd 20/21/22
613
# this works even when /dev/tty isn't available
614 9283 aaronmk
# view logging output at verbosity >= 3
615 9279 aaronmk
{
616 9319 aaronmk
	log+ 2; log-- echo_func
617 9279 aaronmk
	# ignore errors if a source fd isn't open
618
	fd_set_default '20<&0' || true
619
	fd_set_default '21>&1' || true
620
	fd_set_default '22>&2' || true
621
}
622
set_global_fds
623
624
# usage: explicit_errors_only=1 script...
625
# show only explicitly-displayed errors (which have been redirected to fd 22)
626
# most of the time this has the same effect as `verbosity=0 script...`,
627
# which displays everything that isn't explicitly hidden
628
# this option should only be used for testing the explicit error displaying
629
if test "$explicit_errors_only"; then disable_logging; fi
630
631
632 9731 aaronmk
echo_vars is_outermost
633
634
635 9264 aaronmk
#### paths
636
637 9735 aaronmk
top_symlink_dir="$(dirname "$0")"; echo_vars top_symlink_dir
638 9736 aaronmk
top_symlink_dir_abs="$(realpath "$top_symlink_dir")"
639
	echo_vars top_symlink_dir_abs
640 9724 aaronmk
641 9269 aaronmk
top_script_abs="$(realpath "$0")"; echo_vars top_script_abs # outermost script
642
	# realpath this before doing any cd so this points to the right place
643 9724 aaronmk
top_dir_abs="$(dirname "$top_script_abs")"; echo_vars top_dir_abs
644 9269 aaronmk
645 9265 aaronmk
set_paths()
646
{
647 9788 aaronmk
	top_script="$(clog++ canon_rel_path "$top_script_abs")" || return
648 9331 aaronmk
		echo_vars top_script
649
	top_dir="$(dirname "$top_script")" || return; echo_vars top_dir
650 9265 aaronmk
}
651
set_paths
652 9264 aaronmk
653 9725 aaronmk
PATH_rm() # usage: PATH_rm path... # removes components from the PATH
654
{
655
	echo_func; echo_vars PATH; : "${PATH?}"
656
	PATH=":$PATH:" # add *extra* : to match at beginning and end
657
	for path in "$@"; do PATH="${PATH//:$path:/:}"; done
658
	PATH="${PATH#:}" # remove any remaining extra leading :
659
	PATH="${PATH%:}" # remove any remaining extra trailing :
660
	echo_vars PATH
661
}
662 9264 aaronmk
663 9726 aaronmk
no_PATH_recursion() # usage: (no_PATH_recursion; cmd...)
664
# allows running a system command of the same name as the script
665 9737 aaronmk
{
666
	echo_func
667
	PATH_rm "$top_dir_abs" "$top_symlink_dir" "$top_symlink_dir_abs" "$top_dir"
668
}
669 9725 aaronmk
670 9726 aaronmk
671 9264 aaronmk
#### verbose output
672
673
674 9123 aaronmk
## internal commands
675
676 9166 aaronmk
.()
677
{
678 9850 aaronmk
	clog++ clog++ echo_func
679
	cmd2rel_path; set -- "$FUNCNAME" "$@"
680 9435 aaronmk
	if (log++; echo_params; can_log); then indent; fi
681 9166 aaronmk
	builtin "$@"
682
}
683 9158 aaronmk
684 9853 aaronmk
.rel() # usage: .rel file [args...] # file relative to ${BASH_SOURCE[0]} dir
685
{
686
	clog++ clog++ echo_func; local file="$1"; shift
687
	. "$(canon_rel_path "$(dirname "${BASH_SOURCE[1]}")/$file")" "$@"
688
}
689
690 9253 aaronmk
cd() # indent is permanent within subshell cd was used in
691
{
692 9393 aaronmk
	log++ echo_func
693 9306 aaronmk
	cmd2rel_path; echo_cmd "$FUNCNAME" "$@"
694 9435 aaronmk
	if can_log; then caller_indent; fi
695 9307 aaronmk
	# -P: expand symlinks so $PWD matches the output of realpath
696 9306 aaronmk
	builtin "$FUNCNAME" -P "$@"
697 9313 aaronmk
698
	func=realpath clear_cache
699 9266 aaronmk
	set_paths
700 9253 aaronmk
}
701
702 9110 aaronmk
## external commands
703
704 9262 aaronmk
disable_logging() { set_fds "$log_fd>/dev/null"; }
705 9224 aaronmk
706 9685 aaronmk
function redir() # usage: local redirs=(#<>...); redir cmd...; unset redirs
707 9138 aaronmk
# to view only explicitly-displayed errors: explicit_errors_only=1 script...
708 9134 aaronmk
{
709 9686 aaronmk
	echo_func; kw_params redirs
710 9687 aaronmk
711
	case "$1" in redir|command) "$@"; return;; esac # redir will be run later
712 9685 aaronmk
	(
713
		log++ set_fds "${redirs[@]}"
714
		(case "$1" in command__exec) shift;; esac; echo_redirs_cmd)
715
		"$@"
716
	) || return
717
}
718
alias redir='"redir" ' # last space alias-expands next word
719
720 9689 aaronmk
alias_append save_e '; unset redirs' # don't redirect error handlers
721
722 9685 aaronmk
command() # usage: [cmd_log_fd=|1|2|#] [verbosity_min=] command extern_cmd...
723
{
724 9740 aaronmk
	echo_func; kw_params log_fd cmd_log_fd redirs verbosity_min
725 9291 aaronmk
	# if no cmd_log_fd, limit log_fd in case command uses util.sh
726
	local cmd_log_fd="${cmd_log_fd-$log_fd}"
727 9473 aaronmk
	local redirs=("${redirs[@]}")
728 9231 aaronmk
729 9685 aaronmk
	# determine redirections
730 9436 aaronmk
	if test "$cmd_log_fd"; then
731
		if can_log; then
732
			if test "$cmd_log_fd" != "$log_fd"; then
733 9473 aaronmk
				redirs+=("$cmd_log_fd>&$log_fd")
734 9436 aaronmk
			fi # else no redir needed
735 9473 aaronmk
		else redirs+=("$cmd_log_fd>/dev/null");
736 9436 aaronmk
		fi
737
	fi
738 9444 aaronmk
739 9685 aaronmk
	cmd2rel_path
740
	redir command__exec "$@" || die_e
741 9134 aaronmk
}
742 9685 aaronmk
command__exec()
743
{
744
	ensure_nested_func
745
	if can_log; then indent; fi
746
	if test "$verbosity_min"; then verbosity_min "$verbosity_min"; fi
747 9868 aaronmk
	verbosity_compat
748 9723 aaronmk
	builtin command "$@"
749 9685 aaronmk
}
750 9133 aaronmk
751 9160 aaronmk
# auto-echo common external commands
752
for cmd in env rm; do alias "$cmd=command $cmd"; done; unset cmd
753 9110 aaronmk
754
755
### external command input/output
756 8907 aaronmk
757 9074 aaronmk
echo_stdin() # usage: input|echo_stdin|cmd
758 8702 aaronmk
{
759 8897 aaronmk
	if can_log; then
760 8998 aaronmk
		pipe_delay
761 9212 aaronmk
		echo ----- >&"$log_fd"
762
		tee -a /dev/fd/"$log_fd";
763
		echo ----- >&"$log_fd"
764 8897 aaronmk
	else cat
765
	fi
766 8702 aaronmk
}
767 8275 aaronmk
768 9318 aaronmk
echo_stdout() { echo_stdin; } # usage: cmd|echo_stdout
769 9044 aaronmk
770 8873 aaronmk
771 8854 aaronmk
#### commands
772
773 9622 aaronmk
already_exists_msg() # usage: cond || what=... already_exists_msg || return 0
774
{ type=info die "$what already exists, skipping"; }
775 9620 aaronmk
776 9122 aaronmk
require_not_exists() # usage: require_not_exists file || return 0
777 9622 aaronmk
{ test ! -e "$1" || what="file \"$1\"" already_exists_msg; }
778 9062 aaronmk
779 9680 aaronmk
function to_file() # usage: stdout=... [if_not_exists=1] [del=] to_file cmd...
780 8986 aaronmk
# auto-removes a command's output file on error (like make's .DELETE_ON_ERROR)
781 9048 aaronmk
{
782 9695 aaronmk
	echo_func; kw_params stdout if_not_exists del
783 9680 aaronmk
	: "${stdout?}"; local del="${del-1}"
784 9475 aaronmk
	if test "$if_not_exists"; then require_not_exists "$stdout" || return 0; fi
785 9481 aaronmk
786 9652 aaronmk
	local redirs=("${redirs[@]}" ">$stdout")
787 9690 aaronmk
	redir "$@" || { save_e; test ! "$del" || rm "$stdout"; rethrow; }
788 9048 aaronmk
}
789 9177 aaronmk
alias to_file='"to_file" ' # last space alias-expands next word
790 8986 aaronmk
791 9747 aaronmk
log_bg() { symbol='&' log_custom "$@"; }
792
793
log_last_bg() { log_bg '$!='"$!"; }
794
795
function bg_cmd() { echo_func; "$@" & log_last_bg; } # usage: bg_cmd cmd...
796
alias bg_cmd='"bg_cmd" ' # last space alias-expands next word
797
798 9074 aaronmk
run_args_cmd() # runs the command line args command
799 8272 aaronmk
{
800 8693 aaronmk
	eval set -- "$(reverse "${BASH_ARGV[@]}")"
801 8971 aaronmk
	test $# -ge 1 || set -- all
802 9844 aaronmk
	echo_cmd "$top_script" "$@"; time "$@"
803 8272 aaronmk
}
804
805 9074 aaronmk
fwd() # usage: subdirs=(...); fwd "$FUNCNAME" "$@"
806 8272 aaronmk
{
807 8881 aaronmk
	echo_func
808 8284 aaronmk
	: "${subdirs?}"
809
810 9297 aaronmk
	for subdir in "${subdirs[@]}"; do "$top_dir"/"$subdir"/run "$@"; done
811 8272 aaronmk
}
812
813 9017 aaronmk
814 9552 aaronmk
#### filesystem
815
816 9830 aaronmk
alias mkdir='mkdir -p'
817
818 9556 aaronmk
alias file_size=\
819 9558 aaronmk
"stat `case "$(uname)" in Darwin) echo -f %z;; *) echo --format=%s;; esac`"
820 9552 aaronmk
821 9829 aaronmk
alias wildcard='shopt -s nullglob; echo' # usage: "$(wildcard glob...)"
822 9939 aaronmk
alias wildcard1='shopt -s nullglob; echo1' # usage: "$(wildcard1 glob...)"
823 9552 aaronmk
824 9831 aaronmk
fi # load new aliases
825
if self_being_included; then
826 9829 aaronmk
827 9831 aaronmk
mv2dir() { echo_func; mkdir "${!#}"; mv "$@"; } # usage: mv2dir ... dir
828
829
# usage: (mv_glob ... dir)
830
function mv_glob() { echo_func; if (($# > 1)); then mv2dir "$@"; fi; }
831
alias mv_glob='shopt -s nullglob; "mv_glob"'
832
833
834 8966 aaronmk
#### URLs
835
836 9074 aaronmk
localize_url() { test _"$1" = _"$(hostname -f)" || echo "$1"; }
837 8966 aaronmk
838 8704 aaronmk
fi