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 14411 aaronmk
lowercase() { tr A-Z a-z <<<"$1"; }
12
13 14412 aaronmk
str2varname() { lowercase "${1//[^a-zA-Z0-9_]/_}"; }
14
	# lowercase: on case-insensitive filesystems, paths sometimes canonicalize
15
	# to a different capitalization than the original
16 8716 aaronmk
17 9312 aaronmk
include_guard_var() { str2varname "$(realpath "$1")"; }
18
19 9074 aaronmk
self_not_included() # usage: if self_not_included; then ... fi
20 8703 aaronmk
{
21 8971 aaronmk
	test $# -ge 1 || set -- "${BASH_SOURCE[1]}"
22 8703 aaronmk
	local include_guard="$(include_guard_var "$1")"
23 8793 aaronmk
	alias self_being_included=false
24 9003 aaronmk
	! isset "$include_guard" && \
25 8793 aaronmk
	{ eval "$include_guard"=1; alias self_being_included=true; }
26 8703 aaronmk
}
27
28 8793 aaronmk
# to load newly-defined aliases for use in functions in the same file:
29
## fi # load new aliases
30
## if self_being_included; then
31
# this is needed because aliases defined inside an if statement are not
32
# available inside that if statement
33
34 9018 aaronmk
fi
35 9017 aaronmk
36 9018 aaronmk
37 8704 aaronmk
if self_not_included "${BASH_SOURCE[0]}"; then
38
39 9017 aaronmk
40
#### options
41
42 8709 aaronmk
shopt -s expand_aliases
43 12872 aaronmk
# **DON'T** do `shopt -s lastpipe` because this causes a segfault on Linux in
44
# stderr_matches(). (it also isn't supported on Mac.) use @PIPESTATUS instead.
45 8709 aaronmk
46 9017 aaronmk
47 9789 aaronmk
#### stubs
48
49 14411 aaronmk
die()
50
{ return "$?"; } # can't use `:` because that resets $?
51 14410 aaronmk
52 13201 aaronmk
alias log_local='declare PS4="$PS4" log_level="$log_level"'
53
54 13202 aaronmk
function log++() { :; }
55 14406 aaronmk
alias log++='"log++" ' # last space alias-expands next word
56
alias log--='"log--" ' # last space alias-expands next word
57
alias log!='"log!" ' # last space alias-expands next word
58 13202 aaronmk
59 13200 aaronmk
function log() { :; }
60
61 9794 aaronmk
__caller_indent='log_indent="$log_indent$log_indent_step"'
62
alias caller_indent="$__caller_indent"
63
alias indent="declare $__caller_indent"
64
65 14710 aaronmk
function canon_rel_path() { echo "$1"; }
66 14706 aaronmk
67 9789 aaronmk
function echo_func() { :; }
68 14723 aaronmk
alias echo_func='"echo_func" "$@" && indent || true'
69 9789 aaronmk
70 9796 aaronmk
function echo_run() { :; }
71
alias echo_run='"echo_run" ' # last space alias-expands next word
72 9789 aaronmk
73 10017 aaronmk
# auto-echo common external commands
74 10018 aaronmk
for cmd in env rm which; do alias "$cmd=echo_run $cmd"; done; unset cmd
75 10017 aaronmk
76 10044 aaronmk
echo_builtin() { :; }
77
78 9797 aaronmk
function echo_vars() { :; }
79 9796 aaronmk
80 9797 aaronmk
81 11856 aaronmk
#### logic
82
83
not() { ! "$@"; } # usage: wrapper_cmd not wrapped_cmd... # inverts exit status
84
85 12971 aaronmk
bool!() # usage: "$(bool! "$bool_var")"
86
{ if test ! "$1"; then echo -n 1; fi } # empty<->non-empty
87 11856 aaronmk
88 12971 aaronmk
89 9226 aaronmk
#### vars
90
91 13116 aaronmk
alias local_array='declare -a'
92
	# `local` does not support arrays in older versions of bash/on Mac
93 12203 aaronmk
94 9226 aaronmk
set_var() { eval "$1"'="$2"'; }
95
96 9420 aaronmk
set_default() { if ! isset "$1"; then set_var "$@"; fi; }
97
98 9226 aaronmk
set_inv() { set_var no_"$1" "$(test "${!1}" || echo 1)"; }
99
100
# usage: local var=...; local_inv
101 10646 aaronmk
alias local_inv=\
102
'declare "no_$var=$(test "${!var}" || echo 1)"; echo_vars no_$var'
103 9226 aaronmk
104 9227 aaronmk
unexport() { export -n "$@"; }
105
	# `declare +x` won't work because it defines the var if it isn't set
106
107 9236 aaronmk
alias local_export='declare -x' # combines effects of local and export
108
109 13116 aaronmk
alias export_array='declare -ax'
110
	# `export` does not support arrays in older versions of bash/on Mac
111 12205 aaronmk
112 11250 aaronmk
# to make export only visible locally: local var="$var"; export var
113
# within cmd: var="$var" cmd...
114
115 9226 aaronmk
get_prefix_vars() { : "${prefix:?}"; eval echo '${!'$prefix'*}'; }
116
117
# usage: local prefix=..._; import_vars
118
# when used inside another alias 2+ levels deep, *must* be run inside a function
119 13364 aaronmk
# idempotent: vars already set will *not* be overwritten
120 9226 aaronmk
alias import_vars="$(cat <<'EOF'
121
: "${prefix:?}"
122
declare src_var dest_var
123
for src_var in $(get_prefix_vars); do
124
	dest_var="${src_var#$prefix}"
125 13057 aaronmk
	# use ${...-...} to avoid overwriting an already-set var
126 11784 aaronmk
	declare "$dest_var=${!dest_var-${!src_var}}"; echo_vars "$dest_var"
127 9226 aaronmk
done
128
EOF
129
)"
130
131
132 13230 aaronmk
#### integers
133
134
let!() { let "$@" || true; } # always returns true; safe to use for setting
135
	# "If the last ARG evaluates to 0, let returns 1" (`help let`)
136
137
bool2int() { try test ! "$1"; echo "$e"; } # empty->0; non-empty->1
138
139
int2exit() { (( "$1" != 0 )); }
140
141
exit2bool() { if (( $? == 0 )); then echo 1; fi } # 0->non-empty; !=0->empty
142
143
144
#### floats
145
146
int_part() { echo "${1%%.*}"; }
147
148
dec_suffix() { echo "${1#$(int_part "$1")}"; }
149
150
round_down() { int_part "$1"; }
151
152
float+int() { echo "$(($(int_part "$1")+$2))$(dec_suffix "$1")"; }
153
154
float_set_min() { if (($(int_part $1) >= $2)); then echo $1; else echo $2; fi; }
155
156
157
#### strings
158
159
starts_with() { test "${2#$1}" != "$2"; } # usage: starts_with pattern str
160
161
ends_with() { test "${2%$1}" != "$2"; } # usage: ends_with pattern str
162
163 14720 aaronmk
matches() { test -z "${2##$1}"; } # usage: matches pattern str
164
165 13230 aaronmk
match_prefix() # usage: match_prefix pattern str
166
{ if starts_with "$1" "$2"; then echo "${2%${2#$1}}"; fi }
167
168
rm_prefix() { echo "${2#$1}"; } # usage: rm_prefix pattern str
169
170
contains_match() { starts_with "*$1" "$2"; } # usage: contains_match pattern str
171
172
repeat() # usage: str=... n=... repeat
173
{
174
	: "${str?}" "${n:?}"; local result= n="$n" # n will be modified in function
175
	for (( ; n > 0; n-- )); do result="$result$str"; done
176
	echo "$result"
177
}
178
179
# usage: outer_cmd $sed_cmd ...
180
sed_cmd="env LANG= sed -`case "$(uname)" in Darwin) echo El;; *) echo ru;;esac`"
181
	# LANG: avoid invalid UTF-8 "illegal byte sequence" errors when LANG=*.UTF-8
182
	# -l: line buffered / -u: unbuffered
183
alias sed="$sed_cmd"
184
	# can't be function because this causes segfault in redir() subshell when
185
	# used with make.sh make() filter
186
187
fi # load new aliases
188
if self_being_included; then
189
190
rtrim() { log_local; log+ 3; sed 's/[[:space:]]+$//' <<<"$1"; }
191
192
193
#### arrays
194
195
echo1() { echo "$1"; } # usage: echo1 values...
196
197
esc() # usage: array=($(log++; prep_env... (eg. cd); esc args...))
198
{ local arg; for arg in "$@"; do printf '%q ' "$arg"; done; }
199
200
# usage: split delim str; use ${parts[@]}
201 13320 aaronmk
function split() { split__with_IFS "$@"; echo_vars parts; }
202 13230 aaronmk
	# no echo_func because used by log++
203 13320 aaronmk
split__with_IFS() { local IFS="$1"; parts=($2); } # limit effects of IFS
204 13230 aaronmk
alias split='declare parts; "split"'
205
206
join() { local IFS="$delim"; echo "$*"; } # usage: delim=char join elems...
207
208
reverse() # usage: array=($(reverse args...))
209
{
210
	local i
211
	for (( i=$#; i > 0; i-- )); do printf '%q ' "${!i}"; done
212
}
213
214
contains() # usage: contains value in_array...
215
{
216
	local value="$1"; shift
217
	local elem
218
	for elem in "$@"; do if test "$elem" = "$value"; then return 0; fi; done
219
	return 1
220
}
221
222
is_array() # handles unset vars (=false)
223
{
224
	isset "$1" || return 1
225
	local decl; decl="$(declare -p "$1")" || return; echo_vars decl
226
	starts_with 'declare -a' "$decl" # also matches -ax
227
}
228
229
230 14712 aaronmk
#### terminal
231
232
### formatting
233
234
has_bg()
235
{
236
	# inverse (black background)/set background (normal colors)/set background
237
	# (bright colors) (xfree86.org/current/ctlseqs.html#Character_Attributes)
238
	starts_with 7 "$1" || starts_with 4 "$1" || starts_with 10 "$1"
239
}
240
241
format() # usage: format format_expr msg
242
# format_expr: the #s in xfree86.org/current/ctlseqs.html#Character_Attributes
243
{
244
	local format="$1" msg="$2"
245
	if starts_with '[' "$msg"; then format=; fi #don't add padding if formatted
246
	if has_bg "$format"; then msg=" $msg "; fi # auto-add padding if has bg
247
	echo "${format:+[0;${format}m}$msg${format:+}"
248
}
249
250
plain() { echo "$1"; }
251
252
fade() { format 90 "$@"; } # medium gray fades on white *&* black backgrounds
253
254
255 14711 aaronmk
#### errors
256
257
err_fd=2 # stderr
258
259
# usage: local func=...; set_func_loc; use $file, $line
260
alias set_func_loc="$(cat <<'EOF'
261
: "${func:?}"
262
local func_info="$(shopt -s extdebug; declare -F "$func")" # 'func line file'
263
func_info="${func_info#$func }"
264
local line="${func_info%% *}"
265
local file="${func_info#$line }"
266
EOF
267
)"
268
269
fi # load new aliases
270
if self_being_included; then
271
272
func_loc() # gets where function declared in the format file:line
273
{
274
	local func="$1"; set_func_loc
275
	file="$(canon_rel_path "$file")" || return
276
	echo "$file:$line"
277
}
278
279 14713 aaronmk
### stack traces
280 14711 aaronmk
281 14713 aaronmk
alias init_i='declare i="${i-0}"'
282 14719 aaronmk
alias next_stack_frame='let! i++' # usage: init_i; __; next_stack_frame
283 14724 aaronmk
alias prev_stack_frame='let! i--' # usage: next_stack_frame;__; prev_stack_frame
284 14713 aaronmk
285
# makes stack_trace() skip the entry for the caller
286
alias skip_stack_frame='init_i; next_stack_frame'
287 14725 aaronmk
alias skip_stack_frame_in_caller='next_stack_frame'
288
alias unskip_stack_frame_in_caller='prev_stack_frame'
289 14713 aaronmk
290
fi # load new aliases
291
if self_being_included; then
292
293
# usage: [i=#] get_stack_frame # i: 0-based index from top of stack
294
# to get all stack frames:
295
# init_i; while get_stack_frame; do use $func $file $line; next_stack_frame;done
296
# better than `caller` builtin because returns info in separate vars
297
get_stack_frame()
298
{
299
	skip_stack_frame; init_i
300
	# the extra FUNCNAME/BASH_LINENO entries have dummy values (main/0)
301
	func="${FUNCNAME[$i]}" # the called function, which = the current function
302
	file="${BASH_SOURCE[$i+1]}" # not the *current* file, but the call's file
303
	line="${BASH_LINENO[$i]}" # the line the function was called at
304
	test "$file" # exit false if invalid index
305
}
306
alias get_stack_frame='declare func file line && "get_stack_frame"'
307
	# && instead of ; so it can be used as a while cond
308
309 14728 aaronmk
skip_stack_frames() # usage: init_i; exclude=_* [lookahead=1] skip_stack_frames
310
# lookahead: look at entry *after* current to deterine whether to skip current.
311
#  useful for skipping wrappers, by looking at the *calling* function's name.
312 14721 aaronmk
{
313 14727 aaronmk
	: "${exclude:?}"
314
	skip_stack_frame_in_caller # current function's frame
315 14728 aaronmk
	if test "$lookahead"; then skip_stack_frame_in_caller; fi
316 14727 aaronmk
317 14721 aaronmk
	while get_stack_frame && matches "$exclude" "$func"; do # matching frame
318
		next_stack_frame # skip matching frame
319
	done
320 14727 aaronmk
321 14728 aaronmk
	if test "$lookahead"; then unskip_stack_frame_in_caller; fi
322 14727 aaronmk
	unskip_stack_frame_in_caller
323 14721 aaronmk
}
324
325 14717 aaronmk
format_stack_frame() #usage: "$(func=_ file=_ line=_ format_stack_frame [args])"
326 14714 aaronmk
{
327 14722 aaronmk
	log_local; log+ 2 # hide canon_rel_path() info
328 14714 aaronmk
	file="$(canon_rel_path "$file")" || return
329
	local caller="$file:$line"
330
	local func_loc; func_loc="$(func_loc "$func")" || return
331
	func_loc="${func_loc#$file:}" # include just line # if file same
332 14717 aaronmk
	echo "$(esc "$func" "$@")   $(plain "@$caller -> $func_loc")"
333 14714 aaronmk
}
334 14713 aaronmk
335 14715 aaronmk
stack_trace() # usage: "$([i=#] stack_trace)" # or use print_stack_trace
336
{
337
	skip_stack_frame; init_i
338
	while get_stack_frame; do
339
		format_stack_frame
340
		next_stack_frame
341
	done
342
}
343 14714 aaronmk
344 14715 aaronmk
print_stack_trace() { skip_stack_frame; stack_trace >&2; }
345
# *note*: don't call from logging functions b/c will cause infinite recursion
346
347
348 14711 aaronmk
#### debugging
349
350
debug_fd="$err_fd"
351
352
ps() { echo "$@" >&"$debug_fd"; } # usage: ps str...
353
354
pv() { declare -p "$@" >&"$debug_fd"; } # usage: pv var... # debug-prints vars
355
356
pf() { declare -f "$@" >&"$debug_fd"; } # usage: pf func... # prints func decls
357
358 14716 aaronmk
pst() { print_stack_trace; } # no skip_stack_frame so know where called from
359
# *note*: don't call from logging functions b/c will cause infinite recursion
360 14711 aaronmk
361 14716 aaronmk
362 9311 aaronmk
#### caching
363
364
## shell-variable-based caching
365
366 9330 aaronmk
# usage: local cache_key=...; load_cache; \
367 9331 aaronmk
# if ! cached; then save_cache value || return; fi; echo_cached_value
368 9561 aaronmk
# cache_key for function inputs: "$(declare -p kw_param...) $*"
369 9311 aaronmk
alias load_cache='declare cache_var="$(str2varname "${FUNCNAME}___$cache_key")"'
370
alias cached='isset "$cache_var"'
371
alias save_cache='set_var "$cache_var"'
372
alias echo_cached_value='echo "${!cache_var}"'
373
374
clear_cache() # usage: func=... clear_cache
375
{ : "${func:?}"; unset $(prefix="${func}___" get_prefix_vars); }
376
377
fi # load new aliases
378
if self_being_included; then
379
380
381 13265 aaronmk
#### functions
382
383
func_exists() { declare -f "$1" >/dev/null; }
384
385
kw_params() # usage: func() { kw_params param_var...; }; ...; param_var=... cmd
386
# removes keyword-param-only vars from the environment
387
{ unexport "$@"; }
388
389 13270 aaronmk
1st_non_opt() { while starts_with - "$1"; do shift; done; echo "$1"; }
390
391 13265 aaronmk
# usage: cmd=... foreach_arg
392
function foreach_arg()
393
{
394
	echo_func; kw_params cmd; : "${cmd:?}"
395
	local a; for a in "$@"; do
396
		a="$(log++ echo_run "$cmd" "$a")" || return; args+=("$a")
397
	done
398
	echo_vars args
399
}
400
alias foreach_arg='"foreach_arg" "$@"; set -- "${args[@]}"; unset args'
401
402
alias self_name='echo "${FUNCNAME%%__*}"' # usage: "$(self_name)"
403
404
alias self='command "$(self_name)"' # usage: wrapper() { self ...; }
405
alias self_sys='sys_cmd "$(self_name)"' # wrapper() { self_sys ...; }
406
alias self_builtin='builtin "${FUNCNAME%%__*}"' #wrapper() { self_builtin ...; }
407
408
all_funcs() # usage: for func in $(all_funcs); do ...; done # all declared funcs
409
{ declare -F|while read -r line; do echo -n "${line#declare -f } "; done; }
410
411
copy_func() # usage: from=... to=... copy_func
412
# $to must not exist. to get around the no-clobber restriction, use `unset -f`.
413
{
414 14407 aaronmk
	log++ echo_func
415 13265 aaronmk
	: "${from:?}" "${to:?}"
416
	func_exists "$from" || die "function does not exist: $from"
417
	! func_exists "$to" || die "function already exists: $to"
418
	local from_def="$(declare -f "$from")"
419
	eval "$to${from_def#$from}"
420
}
421
422
func_override() # usage: func_override old_name__suffix
423 14407 aaronmk
{ log++ echo_func; from="${1%__*}" to="$1" copy_func; }
424 13265 aaronmk
425
ensure_nested_func() # usage: func__nested_func() { ensure_nested_func; ... }
426
{
427
	local nested_func="${FUNCNAME[1]}"
428
	local func="${nested_func%%__*}"
429
	contains "$func" "${FUNCNAME[@]}" || \
430
		die "$nested_func() must be used by $func()"
431
}
432
433
434 9017 aaronmk
#### aliases
435
436 13267 aaronmk
fi # load new aliases
437
if self_being_included; then
438 8889 aaronmk
439 13267 aaronmk
unalias() { self_builtin "$@" 2>&- || true; } # no error if undefined
440
441 9191 aaronmk
# usage: alias alias_='var=value run_cmd '
442
function run_cmd() { "$@"; }
443
alias run_cmd='"run_cmd" ' # last space alias-expands next word
444 9017 aaronmk
445 11413 aaronmk
alias_append() { eval "$(alias "$1")"'"$2"';} #usage: alias_append alias '; cmd'
446 9191 aaronmk
447 9688 aaronmk
448 10045 aaronmk
#### commands
449
450 13271 aaronmk
type() # handles fact that any alias would already be expanded
451
{ (unalias "$(1st_non_opt "$@")"; self_builtin "$@") || return; }
452 13269 aaronmk
453 13278 aaronmk
is_callable() { type -t -- "$1" >/dev/null; }
454 12693 aaronmk
455 13278 aaronmk
is_extern() { test "$(type -t -- "$1")" = file; }
456 13174 aaronmk
457 13179 aaronmk
is_intern() { is_callable "$1" && ! is_extern "$1"; }
458
459 13204 aaronmk
is_dot_script()
460
{ log_local;log++; echo_func; test "${BASH_LINENO[${#BASH_LINENO[@]}-1]}" != 0;}
461 11425 aaronmk
462 11432 aaronmk
require_dot_script() # usage: require_dot_script || return
463
{
464
	echo_func
465
	if ! is_dot_script; then # was run without initial "."
466
		echo "usage: . $top_script (note initial \".\")"|fold -s >&2
467
		return 2
468
	fi
469
}
470
471 10063 aaronmk
sys_cmd_path() { echo_func; echo_builtin command -p which "$1"|echo_stdout; }
472
473 10045 aaronmk
# makes command in $1 a system command
474
# allows running a system command of the same name as the script
475
alias cmd2sys="$(cat <<'EOF'
476
declare _1="$1"; shift
477 12829 aaronmk
_1="$(indent; log++ sys_cmd_path "$_1")" || return
478 10045 aaronmk
set -- "$_1" "$@"
479
EOF
480
)"
481
482
fi # load new aliases
483
if self_being_included; then
484
485
sys_cmd() { cmd2sys; command "$@"; } # usage: sys_cmd cmd... # runs system cmd
486
	# allows running a system command of the same name as the script
487
488 14841 aaronmk
is_root="$(test "$(id -un)" = root; exit2bool)"
489
490 13245 aaronmk
function sudo()
491
{
492
	echo_func
493 14847 aaronmk
	if is_callable "$1"; then set -- -E env PATH="$PATH" "$@"; fi # preserve env
494
	self "$@"
495 13245 aaronmk
}
496 13180 aaronmk
alias sudo='"sudo" ' # last space alias-expands next word
497 10045 aaronmk
498 14842 aaronmk
# usage: func() { become_sudo; __; }
499
alias self_sudo='sudo "${FUNCNAME%%__*}" "$@"'
500
alias become_sudo='if ! test "$is_root"; then self_sudo; fi'
501 13171 aaronmk
502 14842 aaronmk
503 8886 aaronmk
#### exceptions
504
505 13228 aaronmk
fi # load new aliases
506
if self_being_included; then
507
508
exit() { self_builtin "${1:-$?}"; } # exit sometimes inxeplicably ignores $?
509
510 12972 aaronmk
errexit() # usage: cmd || errexit status # works in functions *and* subshells
511
{ return "$1"; }
512
	# can't use `(exit "$1")` because a bug in bash prevents subshells from
513
	# triggering errexit (would need to append `|| return` for it to work)
514
515 9032 aaronmk
# usage: cmd || { save_e; ...; rethrow; }
516 12720 aaronmk
517 9031 aaronmk
alias export_e='e=$?'
518 12720 aaronmk
519
# **WARNING**: if using this after a command that might succeed (rather than
520 12721 aaronmk
# only upon error), you must `unset e` before the command
521 12720 aaronmk
# idempotent: also works if save_e already called
522
alias save_e='# idempotent: use $e if the caller already called save_e
523
declare e_=$?;
524
declare e="$(if test "$e_" = 0; then echo "${e:-0}"; else echo "$e_"; fi)"'
525
526 12977 aaronmk
rethrow() { errexit "${e:-0}"; } # only does anything if $e != 0
527 12978 aaronmk
rethrow!() { rethrow && false; } # always errexit, even if $e = 0
528 13188 aaronmk
rethrow_exit() { rethrow || exit; } # exit even where errexit disabled
529 8976 aaronmk
530 13349 aaronmk
is_err() { ! rethrow; } # rethrow->*false* if error
531 13348 aaronmk
532 8978 aaronmk
fi # load new aliases
533
if self_being_included; then
534
535 13275 aaronmk
# usage: try cmd...; ignore_e status; if catch status; then ...; fi; \
536
# finally...; end_try
537 8886 aaronmk
538 13214 aaronmk
alias prep_try='declare e=0 benign_error="$benign_error"'
539 12194 aaronmk
540
# usage: ...; try cmd... # *MUST* be at beginning of statement
541 13248 aaronmk
#     OR prep_try; var=... "try" cmd...
542 12771 aaronmk
function try() { benign_error=1 "$@" || { export_e; true; }; }
543 12194 aaronmk
alias try='prep_try; "try" ' # last space alias-expands next word
544 8886 aaronmk
545 12803 aaronmk
catch() { test "$e" = "${1:-0}" && e=0; } # also works w/ $1=''
546 8886 aaronmk
547 13214 aaronmk
ignore_e() { if catch "$@"; then benign_error=1; fi; } # also works w/ $1=''
548 8886 aaronmk
549 8977 aaronmk
alias end_try='rethrow'
550 8886 aaronmk
551 9536 aaronmk
ignore() { save_e; ignore_e "$@"; rethrow; } # usage: try cmd || ignore status
552
553 9551 aaronmk
### signals
554
555
sig_e() { echo $(( 128+$(kill -l "$1") )); } # usage: sig_e SIGINT, etc.
556
557 13231 aaronmk
func_override catch__exceptions
558
catch() # supports SIG* as exception type
559
{
560 13238 aaronmk
	log_local; log++; echo_func
561 13231 aaronmk
	if starts_with SIG "$1"; then set -- "$(sig_e "$1")"; fi
562
	catch__exceptions "$@"
563
}
564
565 9678 aaronmk
# usage: piped_cmd cmd1...|cmd2... # cmd2 doesn't read all its input
566 13235 aaronmk
function piped_cmd() { "$@" || ignore SIGPIPE; }
567 9551 aaronmk
alias piped_cmd='"piped_cmd" ' # last space alias-expands next word
568
569 9020 aaronmk
fi # load new aliases
570
if self_being_included; then
571 9017 aaronmk
572 9020 aaronmk
573 12813 aaronmk
#### text
574
575
nl='
576
'
577
578 13324 aaronmk
# usage: by itself:                            split_lines  str; use ${lines[@]}
579
#        with wrapper: declare lines; wrapper "split_lines" str; use ${lines[@]}
580 12817 aaronmk
function split_lines() { split "$nl" "$1"; lines=("${parts[@]}"); }
581
	# no echo_func because used by log++
582 12813 aaronmk
alias split_lines='declare lines; "split_lines"'
583
584
585 12706 aaronmk
#### paths
586
587
strip/() { echo "${1%/}"; } # strips trailing /s
588
589 12709 aaronmk
wildcard/() # usage: array=($(log++; [cd ...;] wildcard/ unquoted_pattern...))
590 13175 aaronmk
{ cmd=strip/ foreach_arg; esc "$@"; }
591 12706 aaronmk
592 12709 aaronmk
wildcard.() # usage: array=($(log++; [cd ...;] wildcard. unquoted_pattern...))
593 14772 aaronmk
# currently only removes . .. when at then beginning of the list
594 12707 aaronmk
{
595
	set -- $(wildcard/ "$@") # first strip trailing /s
596
	local to_rm=(. ..)
597
	local item
598
	if contains "$1" "${to_rm[@]}"; then
599
		shift
600
		if contains "$1" "${to_rm[@]}"; then shift; fi
601
	fi
602 13175 aaronmk
	esc "$@"
603 12707 aaronmk
}
604
605 9715 aaronmk
#### streams
606 9097 aaronmk
607 9715 aaronmk
pipe_delay() # usage: cmd1 | { pipe_delay; cmd2; }
608
{ sleep 0.1; } # s; display after leading output of cmd1
609
610
611 8854 aaronmk
#### verbose output
612
613 9110 aaronmk
614 9111 aaronmk
usage() { echo "Usage: $1" >&2; return 2; }
615 9110 aaronmk
616
617 9452 aaronmk
### log++
618 9110 aaronmk
619 9361 aaronmk
log_fd=2 # initially stderr
620 9209 aaronmk
621 9142 aaronmk
if test "$explicit_errors_only"; then verbosity=0; fi # hide startup logging
622
623 9006 aaronmk
# set verbosity
624 9005 aaronmk
if isset verbose; then : "${verbosity:=$(bool2int "$verbose")}"; fi
625 9145 aaronmk
if isset vb; then : "${verbosity:=$vb}"; fi
626 9272 aaronmk
: "${verbosity=1}" # default
627 9006 aaronmk
: "${verbosity:=0}" # ensure non-empty
628 9119 aaronmk
export verbosity # propagate to invoked commands
629 8710 aaronmk
630 9731 aaronmk
is_outermost="$(! isset log_level; exit2bool)" # if util.sh env not yet set up
631
632 9542 aaronmk
# set log_level
633
: "${log_level=$(( ${#PS4}-1 ))}" # defaults to # non-space symbols in PS4
634
export log_level # propagate to invoked commands
635 12821 aaronmk
export PS4 # follows log_level, so also propagate this
636 9542 aaronmk
637 9396 aaronmk
verbosity_int() { round_down "$verbosity"; }
638
639 9450 aaronmk
# verbosities (and `make` equivalents):
640 9359 aaronmk
# 0: just print errors. useful for cron jobs.
641 9451 aaronmk
#    vs. make: equivalent to --silent, but suppresses external command output
642 9359 aaronmk
# 1: also external commands run. useful for running at the command line.
643 9450 aaronmk
#    vs. make: not provided (but sorely needed to avoid excessive output)
644 9359 aaronmk
# 2: full graphical call tree. useful for determining where error occurred.
645 9450 aaronmk
#    vs. make: equivalent to default verbosity, but with much-needed indents
646 9360 aaronmk
# 3: also values of kw params and variables. useful for low-level debugging.
647 9450 aaronmk
#    vs. make: not provided; need to manually use $(error $(var))
648 9359 aaronmk
# 4: also variables in util.sh commands. useful for debugging util.sh.
649 9450 aaronmk
#    vs. make: somewhat similar to --print-data-base
650 9359 aaronmk
# 5: also variables in logging commands themselves. useful for debugging echo_*.
651 9450 aaronmk
#    vs. make: not provided; need to search Makefile for @ at beginning of cmd
652 9359 aaronmk
# 6+: not currently used (i.e. same as 5)
653
654 9287 aaronmk
# definition: the log_level is the minimum verbosity needed to display a message
655
# for messages that use can_log(), the log_level starts with *1*, not 0
656
# for unfiltered messages, the log_level is 0 (i.e. still output at verbosity=0)
657 9288 aaronmk
# to view a message's log_level, count the # of + signs before it in the output
658 9284 aaronmk
659 9305 aaronmk
fi # load new aliases
660
if self_being_included; then
661
662 12828 aaronmk
# usage: in func:      log_local; log++; ...
663
#        outside func: log_local; log++; ...; log--
664 12829 aaronmk
#        before cmd:   log++ cmd  OR  log+ num cmd  OR  log++ log++... cmd
665 9716 aaronmk
# with a cmd, assignments are applied just to it, so log_local is not needed
666 12825 aaronmk
# without a cmd, assignments are applied to caller ("$@" expands to nothing)
667 9305 aaronmk
# "${@:2}" expands to all of $@ after *1st* arg, not 2nd ($@ indexes start at 1)
668 12832 aaronmk
log:() # sets explicit log_level
669 9373 aaronmk
{
670 12824 aaronmk
	if test $# -gt 1; then log_local; fi # if cmd, only apply assignments to it
671 9373 aaronmk
	# no local vars because w/o cmd, assignments should be applied to caller
672 12832 aaronmk
	log_level="$1"
673 12831 aaronmk
	PS4="$(str="${PS4:0:1}" n=$((log_level-1)) repeat)${PS4: -2}"
674 12821 aaronmk
	"${@:2}"
675 9373 aaronmk
}
676 12832 aaronmk
log+() { log: $((log_level+$1)) "${@:2}"; }
677 10153 aaronmk
log-() { log+ "-$1" "${@:2}"; }
678 12832 aaronmk
# no log:/+/- alias needed because next word is not an alias-expandable cmd
679 12834 aaronmk
function log++() { log+ 1 "$@"; }
680
function log--() { log- 1 "$@"; }
681
function log!() { log: 0 "$@"; } # force-displays next log message
682 14406 aaronmk
# see aliases in stubs
683 9176 aaronmk
684 11914 aaronmk
verbosity_min() # usage: verbosity_min {<min>|''}
685 14734 aaronmk
# **WARNING**: '' is a special value that causes $verbosity to be overwritten to ''
686 9846 aaronmk
{ if test ! "$1" -o "$(verbosity_int)" -lt "$1"; then verbosity="$1"; fi; }
687 12826 aaronmk
alias verbosity_min='declare verbosity="$verbosity"; "verbosity_min"'
688 9289 aaronmk
689 9878 aaronmk
# usage: (verbosity_compat; cmd)
690 14733 aaronmk
# **WARNING**: don't run this until right before executing an external command,
691
#  so that it doesn't mess up the logging mechanism
692 9867 aaronmk
function verbosity_compat()
693 13210 aaronmk
{ log_local; log++; echo_func; if ((verbosity == 1)); then unset verbosity; fi;}
694 12827 aaronmk
alias verbosity_compat='declare verbosity="$verbosity"; "verbosity_compat"'
695 9397 aaronmk
696 9867 aaronmk
697 9289 aaronmk
# indent for call tree. this is *not* the log_level (below).
698 9382 aaronmk
: "${log_indent_step=| }" "${log_indent=}"
699
export log_indent_step log_indent # propagate to invoked commands
700 9289 aaronmk
701 9794 aaronmk
# see indent alias in stubs
702 9289 aaronmk
703
704 9190 aaronmk
fi # load new aliases
705
if self_being_included; then
706
707 12821 aaronmk
can_log() { test "$log_level" -le "$(verbosity_int)"; }
708 9380 aaronmk
	# verbosity=0 turns off all logging
709 8895 aaronmk
710 12858 aaronmk
can_highlight_log_msg() { test "$log_level" -le 1; }
711 9064 aaronmk
712 12858 aaronmk
highlight_log_msg() # usage: [format=...] highlight_log_msg msg
713 12807 aaronmk
# format: the # in xfree86.org/current/ctlseqs.html#Character_Attributes
714 12805 aaronmk
{
715 13217 aaronmk
	log_local; log+ 2; echo_func; kw_params format; log- 2
716
	local format="${format-1}" # bold
717 13327 aaronmk
	if ! can_highlight_log_msg; then format=0; fi #remove surrounding formatting
718 12856 aaronmk
	format "$format" "$1"
719 12805 aaronmk
}
720
721 12814 aaronmk
log_line!() # highlights log_level 1 messages to stand out against other output
722 12858 aaronmk
{ echo "$log_indent$PS4$(highlight_log_msg "$1")" >&"$log_fd"; }
723 12805 aaronmk
724 12814 aaronmk
log_msg!()
725 13197 aaronmk
{
726 13323 aaronmk
	declare lines; log+ 2 "split_lines" "$1"
727 13197 aaronmk
	local l; for l in "${lines[@]}"; do log_line! "$l"; done
728
}
729 12814 aaronmk
730 12812 aaronmk
log() { if can_log; then log_msg! "$@"; fi; }
731
732 9270 aaronmk
log_custom() # usage: symbol=... log_custom msg
733 9242 aaronmk
{ log_indent="${log_indent//[^ ]/$symbol}" PS4="${PS4//[^ ]/$symbol}" log "$@";}
734 9070 aaronmk
735 12818 aaronmk
bg_r='101;97' # red background with white text
736 9070 aaronmk
737 12841 aaronmk
log_err() { symbol='#' format="$bg_r" log_fd="$err_fd" log! log_custom "$@";}
738 12818 aaronmk
739 9250 aaronmk
log_info() { symbol=: log_custom "$@"; }
740 9070 aaronmk
741 12858 aaronmk
mk_hint() { format=7 highlight_log_msg "$@";}
742 12815 aaronmk
743 12845 aaronmk
log_err_hint!() { log_err "$(mk_hint "$@")"; }
744 12836 aaronmk
745 12845 aaronmk
log_err_hint() # usage: cmd || [benign_error=1] log_err_hint msg [|| handle err]
746 12727 aaronmk
# msg only displayed if not benign error
747 12845 aaronmk
{
748 13209 aaronmk
	log++ kw_params benign_error
749 12845 aaronmk
	if test ! "$benign_error"; then log_err_hint! "$@"; fi
750
}
751 12727 aaronmk
752 12981 aaronmk
die() # usage: if msg uses $(...):    cmd || { save_e; [type=...] die msg; }
753
#              if msg uses only vars: cmd || [type=...] die msg
754 14731 aaronmk
{ save_e; "log_${type:-err}" "$1"; rethrow!; }
755 9069 aaronmk
756 9447 aaronmk
die_e() # usage: cmd || [benign_error=1] die_e [|| handle error]
757
{
758 13209 aaronmk
	save_e; log++ kw_params benign_error
759 13237 aaronmk
	if test "$e" = "$(sig_e SIGPIPE)"; then benign_error=1; fi
760 12828 aaronmk
	if test "$benign_error"; then log_local; log++; fi
761 9447 aaronmk
	type="${benign_error:+info}" die "command exited with \
762
$(if test "$benign_error"; then echo status; else echo error; fi) $e"
763
	rethrow
764
}
765 8919 aaronmk
766 12731 aaronmk
die_error_hidden() # usage: cmd || verbosity_min=# die_error_hidden [|| ...]
767 12729 aaronmk
{
768 13326 aaronmk
	save_e; log++ echo_func; log++ kw_params verbosity_min
769
	: "${verbosity_min:?}"; log++ echo_vars verbosity
770 12731 aaronmk
	if test "$(verbosity_int)" -lt "$verbosity_min"; then
771 12845 aaronmk
		log_err_hint 'to see error details, prepend `vb='"$verbosity_min"'` to the command'
772 12729 aaronmk
	fi
773
	rethrow
774
}
775 9437 aaronmk
776 12729 aaronmk
777 9240 aaronmk
#### paths
778
779 9313 aaronmk
# cache realpath
780
: "${realpath_cache=}" # default off because slower than without
781
if test "$realpath_cache"; then
782
func_override realpath__no_cache
783
realpath() # caches the last result for efficiency
784
{
785
	local cache_key="$*"; load_cache
786 9331 aaronmk
	if ! cached; then save_cache "$(realpath__no_cache "$@")" || return; fi
787 9313 aaronmk
	echo_cached_value
788
}
789
fi
790
791 9244 aaronmk
rel_path() # usage: base_dir=... path=... rel_path
792 9240 aaronmk
{
793 14731 aaronmk
	log_local; log++; #kw_params base_dir path #off -> no pst infinite recursion
794 9244 aaronmk
	: "${base_dir:?}" "${path:?}"
795
796 9246 aaronmk
	local path="$path/" # add *extra* / to match path when exactly = base_dir
797
	path="${path#$base_dir/}" # remove prefix shared with base_dir
798
	path="${path%/}" # remove any remaining extra trailing /
799 9244 aaronmk
800 9245 aaronmk
	if test ! "$path"; then path=.; fi # ensure non-empty
801
802 14731 aaronmk
	#echo_vars path # off -> no pst infinite recursion
803 9240 aaronmk
	echo "$path"
804
}
805
806 9309 aaronmk
cd -P . # expand symlinks in $PWD so it matches the output of realpath
807
# do before setting $top_script_abs so realpath has less symlinks to resolve
808
809 9791 aaronmk
canon_rel_path() # usage: [base_dir=...] canon_rel_path path
810 14709 aaronmk
# falls back to original path if can't resolve
811 9331 aaronmk
{
812 14731 aaronmk
	#kw_params base_dir # off -> no pst infinite recursion
813
	local path="$1" base_dir="${base_dir-$PWD}"
814 14709 aaronmk
	canon_rel_path__try || echo "$path"
815
}
816
canon_rel_path__try()
817
{
818
	ensure_nested_func
819 9791 aaronmk
	base_dir="$(realpath "$base_dir")" || return
820 14708 aaronmk
	path="$(realpath "$path")" || return
821 9791 aaronmk
	rel_path
822 9331 aaronmk
}
823 9244 aaronmk
824 10143 aaronmk
canon_dir_rel_path() # usage: [base_dir=...] canon_dir_rel_path path
825
# if the path is a symlink, just its parent dir will be canonicalized
826
{
827
	kw_params base_dir; local base_dir="${base_dir-$PWD}"
828
	base_dir="$(realpath "$base_dir")" || return
829
	local path; path="$(realpath "$(dirname "$1")")/$(basename "$1")" || return
830
	rel_path
831
}
832
833 9240 aaronmk
# makes $1 a canon_rel_path if it's a filesystem path
834
alias cmd2rel_path="$(cat <<'EOF'
835 13277 aaronmk
if is_extern "$1" && test -e "$1"; then # not relative to PATH
836 9240 aaronmk
	declare _1="$1"; shift
837 12829 aaronmk
	_1="$(log++ canon_rel_path "$_1")" || return
838 9331 aaronmk
	set -- "$_1" "$@"
839 9240 aaronmk
fi
840
EOF
841
)"
842
843 9810 aaronmk
# usage: path_parents path; use ${dirs[@]} # includes the path itself
844
function path_parents()
845
{
846
	echo_func; local path="$1" prev_path=; dirs=()
847
	while test "$path" != "$prev_path"; do
848
		prev_path="$path"
849
		dirs+=("$path")
850
		path="${path%/*}"
851
	done
852
}
853
alias path_parents='declare dirs; "path_parents"'
854 9240 aaronmk
855 9810 aaronmk
856 9240 aaronmk
#### verbose output
857
858
859 9165 aaronmk
### command echoing
860
861
alias echo_params='log "$*"'
862
863 8995 aaronmk
fi # load new aliases
864
if self_being_included; then
865
866 9197 aaronmk
echo_cmd() { echo_params; }
867 9056 aaronmk
868 9549 aaronmk
function echo_run() { echo_params; "$@"; }
869 9796 aaronmk
# see echo_run alias after stub
870 9539 aaronmk
871 10044 aaronmk
echo_builtin() { echo_run builtin "$@"; } # usage: echo_builtin builtin_cmd...
872
873 9278 aaronmk
echo_eval() { echo_params; builtin eval "$@"; }
874
875 9263 aaronmk
## vars
876
877 13247 aaronmk
echo_vars() # usage: echo_vars var... # also prints unset vars
878 9263 aaronmk
{
879 13199 aaronmk
	log_local; log++ # same log_level as echo_func
880 9263 aaronmk
	if can_log; then
881 14682 aaronmk
		local set_exprs= shared_flags=
882 13246 aaronmk
		local var; for var in "${@%%=*}"; do
883 13247 aaronmk
			if ! isset "$var"; then declare "$var"='<unset>'; fi
884 14682 aaronmk
885
			# merge repeated flags
886
			local decl="$(declare -p "$var")"; decl="${decl#declare }"
887
			local flags="${decl%% *}" def="${decl#* }"
888
			if test ! "$shared_flags"; then shared_flags="$flags"; fi
889
			if test "$flags" != "$shared_flags"; then
890
				set_exprs="$set_exprs$flags "
891
			fi
892
			set_exprs="$set_exprs$def "
893 9263 aaronmk
		done
894 14680 aaronmk
		# put all vars on same line so they don't clutter up the logging output
895 14682 aaronmk
		log "declare $shared_flags $set_exprs"
896 9263 aaronmk
	fi
897
}
898
899
echo_export() { builtin export "$@"; echo_vars "$@"; }
900
901 9379 aaronmk
alias export="echo_export" # automatically echo env vars when they are set
902 9263 aaronmk
903
func_override kw_params__lang
904
kw_params() { kw_params__lang "$@"; echo_vars "$@"; } # echo all keyword params
905
906 9273 aaronmk
## functions
907 9264 aaronmk
908 12852 aaronmk
# usage: func() { echo_func; ... }
909 9317 aaronmk
function echo_func()
910 14723 aaronmk
# usage: "echo_func" "$@" && indent || true
911 9273 aaronmk
# exit status: whether function call was echoed
912
{
913 12828 aaronmk
	log_local; log++; can_log || return
914 14723 aaronmk
	log "$(
915
		log+ 2 # hide internal logging commands
916
		skip_stack_frame # must be inside () to limit its effects
917 14729 aaronmk
		init_i
918
919 14726 aaronmk
		exclude='log*' skip_stack_frames # remove log* prefix to echo_func
920 14729 aaronmk
921 14730 aaronmk
		# get call context before wrapper(s), which is more useful for debugging
922 14729 aaronmk
		get_stack_frame
923 14730 aaronmk
		local func_="$func" # don\'t change function name itself, just call info
924
		exclude='with_*' lookahead=1 skip_stack_frames
925
926
		get_stack_frame
927
		func="$func_" format_stack_frame "$@"
928 14723 aaronmk
	)"
929 9273 aaronmk
}
930 9790 aaronmk
# see echo_func alias after stub
931 9273 aaronmk
932 9276 aaronmk
fi # load new aliases
933
if self_being_included; then
934 9273 aaronmk
935 9276 aaronmk
936 13212 aaronmk
#### fds
937 9279 aaronmk
938
fd_exists() { (: <&"$1") 2>/dev/null; }
939
940
require_fd_not_exists() # usage: require_fd_not_exists fd || return 0
941
{ ! fd_exists "$1" || type=info die "fd $1 already exists, skipping"; }
942
943 9712 aaronmk
set_fds() # usage: set_fds redirect...
944 14736 aaronmk
# **WARNING**: does not currently support redirecting an fd to itself (due to
945
# bash bug that requires the dest fd to be closed before it can be reopened)
946 9712 aaronmk
{
947
	echo_func
948
949
	# add #<>&- before every #<>&# reopen to fix strange bash bug
950 9804 aaronmk
	local redirs=() i
951 9712 aaronmk
	for i in "$@"; do
952 10773 aaronmk
		# remove empty redirects resulting from using `redirs= cmd...` to clear
953
		# the redirs and then using $redirs as an array
954 10920 aaronmk
		if test "$i"; then
955
			local redir_prefix="$(match_prefix '*[<>]' "$i")"
956
			local dest="$(        rm_prefix    '*[<>]' "$i")"
957 10921 aaronmk
			if test "$dest" && ! starts_with '&' "$dest"; then # escape dest
958 10920 aaronmk
				i="$redir_prefix$(printf %q "$dest")"
959
			fi
960
			if test "$redir_prefix"; then redirs+=("$redir_prefix&-"); fi
961
			redirs+=("$i")
962
		fi
963 9712 aaronmk
	done
964
	set -- "${redirs[@]}"
965
966 9795 aaronmk
	if (($# > 0)); then echo_eval exec "$@"; fi
967 9712 aaronmk
}
968 9279 aaronmk
969
fd_set_default() # usage: fd_set_default 'dest[<>]src'
970
{
971
	echo_func
972
	local dest="${1%%[<>]*}"
973
	require_fd_not_exists "$dest" || return 0
974
	set_fds "$1"
975
}
976
977 9651 aaronmk
# convention: use fd 40/41/42 for command-specific alternate stdin/stdout/stderr
978 9900 aaronmk
# mnemonic: 4 looks like A for Alternate
979 9651 aaronmk
# do NOT use 1x, which are used by eval (which is used by set_fds())
980 11853 aaronmk
# do NOT use 2x, which we use as global stdin/stdout/stderr
981 9279 aaronmk
982 14409 aaronmk
stdlog=3
983
984 9282 aaronmk
setup_log_fd() # view logging output at verbosity >= 5
985
{
986 12828 aaronmk
	log_local; log+ 4; log-- echo_func
987 14409 aaronmk
	fd_set_default "$stdlog>&2" || true # set up stdlog
988
	log_fd="$stdlog" # don't change $log_fd until stdlog is set up
989 9282 aaronmk
}
990
setup_log_fd
991
992 9279 aaronmk
set_global_fds()
993
# allows commands to access global stdin/stdout/stderr using fd 20/21/22
994
# this works even when /dev/tty isn't available
995 9283 aaronmk
# view logging output at verbosity >= 3
996 9279 aaronmk
{
997 12828 aaronmk
	log_local; log+ 2; log-- echo_func
998 9279 aaronmk
	# ignore errors if a source fd isn't open
999
	fd_set_default '20<&0' || true
1000
	fd_set_default '21>&1' || true
1001
	fd_set_default '22>&2' || true
1002 13233 aaronmk
	debug_fd=22 # debug to global stderr in case stderr filtered
1003 9279 aaronmk
}
1004
set_global_fds
1005
1006
# usage: explicit_errors_only=1 script...
1007
# show only explicitly-displayed errors (which have been redirected to fd 22)
1008
# most of the time this has the same effect as `verbosity=0 script...`,
1009
# which displays everything that isn't explicitly hidden
1010
# this option should only be used for testing the explicit error displaying
1011
if test "$explicit_errors_only"; then disable_logging; fi
1012
1013
1014 13207 aaronmk
log++ echo_vars is_outermost
1015 9731 aaronmk
1016
1017 9264 aaronmk
#### paths
1018
1019 13207 aaronmk
log++
1020
1021 13206 aaronmk
top_script="${BASH_SOURCE[${#BASH_SOURCE[@]}-1]}"; echo_vars top_script
1022 11431 aaronmk
	# outermost script; unlike $0, also defined for .-scripts
1023
1024
top_symlink_dir="$(dirname "$top_script")"; echo_vars top_symlink_dir
1025 9736 aaronmk
top_symlink_dir_abs="$(realpath "$top_symlink_dir")"
1026
	echo_vars top_symlink_dir_abs
1027 9724 aaronmk
1028 11431 aaronmk
top_script_abs="$(realpath "$top_script")"; echo_vars top_script_abs
1029 9269 aaronmk
	# realpath this before doing any cd so this points to the right place
1030 9724 aaronmk
top_dir_abs="$(dirname "$top_script_abs")"; echo_vars top_dir_abs
1031 9269 aaronmk
1032 13207 aaronmk
log--
1033
1034 9265 aaronmk
set_paths()
1035
{
1036 13203 aaronmk
	log_local; log++
1037 12829 aaronmk
	top_script="$(log++ canon_rel_path "$top_script_abs")" || return
1038 9331 aaronmk
		echo_vars top_script
1039
	top_dir="$(dirname "$top_script")" || return; echo_vars top_dir
1040 9265 aaronmk
}
1041
set_paths
1042 9264 aaronmk
1043 12710 aaronmk
# usage: $(enter_top_dir; cmd...)
1044
function enter_top_dir() { echo_func; cd "$top_dir"; }
1045
alias enter_top_dir='log++; "enter_top_dir"'
1046
1047 9945 aaronmk
# usage: in_top_dir cmd...
1048 12710 aaronmk
function in_top_dir() { echo_func; (enter_top_dir; "$@"); }
1049 9945 aaronmk
alias in_top_dir='"in_top_dir" ' # last space alias-expands next word
1050
1051 9725 aaronmk
PATH_rm() # usage: PATH_rm path... # removes components from the PATH
1052
{
1053
	echo_func; echo_vars PATH; : "${PATH?}"
1054 12828 aaronmk
	log_local
1055 10020 aaronmk
	log+ 2
1056
	split : "$PATH"
1057
	local new_paths=()
1058
	for path in "${parts[@]}"; do
1059
		if ! contains "$path" "$@"; then new_paths+=("$path"); fi
1060
	done
1061
	PATH="$(delim=: join "${new_paths[@]}")" || return
1062 10154 aaronmk
	log- 2
1063 9725 aaronmk
	echo_vars PATH
1064
}
1065 9264 aaronmk
1066 9726 aaronmk
no_PATH_recursion() # usage: (no_PATH_recursion; cmd...)
1067
# allows running a system command of the same name as the script
1068 9737 aaronmk
{
1069
	echo_func
1070
	PATH_rm "$top_dir_abs" "$top_symlink_dir" "$top_symlink_dir_abs" "$top_dir"
1071
}
1072 9725 aaronmk
1073 10021 aaronmk
# makes command in $1 nonrecursive
1074
# allows running a system command of the same name as the script
1075
alias cmd2abs_path="$(cat <<'EOF'
1076
declare _1="$1"; shift
1077
_1="$(indent; no_PATH_recursion; log++; which "$_1"|echo_stdout)" || return
1078
set -- "$_1" "$@"
1079
EOF
1080
)"
1081 9726 aaronmk
1082 10021 aaronmk
1083 9264 aaronmk
#### verbose output
1084
1085
1086 9123 aaronmk
## internal commands
1087
1088 9166 aaronmk
.()
1089
{
1090 13205 aaronmk
	log_local; log++; log++ echo_func
1091 9850 aaronmk
	cmd2rel_path; set -- "$FUNCNAME" "$@"
1092 9435 aaronmk
	if (log++; echo_params; can_log); then indent; fi
1093 9166 aaronmk
	builtin "$@"
1094
}
1095 9158 aaronmk
1096 9853 aaronmk
.rel() # usage: .rel file [args...] # file relative to ${BASH_SOURCE[0]} dir
1097
{
1098 12829 aaronmk
	log++ log++ echo_func; local file="$1"; shift
1099 10059 aaronmk
	. "$(canon_rel_path "$(dirname "$(realpath "${BASH_SOURCE[1]}")")/$file")" \
1100
"$@"
1101 9853 aaronmk
}
1102
1103 14542 aaronmk
cd() # usage: cd dir [path_var...] # path_vars will be rebased for the new dir
1104
# indent is permanent within subshell cd was used in
1105 9253 aaronmk
{
1106 12828 aaronmk
	log_local; log++ echo_func
1107 14542 aaronmk
	local dir="$1"; shift
1108
1109
	# absolutize path_vars
1110
	for path_var in "$@"; do # must happen *before* cd to use correct currdir
1111
		set_var "$path_var" "$(realpath "${!path_var}")"
1112
	done
1113
1114
	# change dir
1115 14543 aaronmk
	# -P: expand symlinks so $PWD matches the output of realpath
1116
	echo_run self_builtin -P "$dir"
1117 9435 aaronmk
	if can_log; then caller_indent; fi
1118 9313 aaronmk
1119
	func=realpath clear_cache
1120 9266 aaronmk
	set_paths
1121 14542 aaronmk
1122
	# re-relativize path_vars
1123
	for path_var in "$@"; do # must happen *after* cd to use correct currdir
1124
		set_var "$path_var" "$(canon_rel_path "${!path_var}")"
1125
	done
1126 9253 aaronmk
}
1127
1128 9110 aaronmk
## external commands
1129
1130 9262 aaronmk
disable_logging() { set_fds "$log_fd>/dev/null"; }
1131 9224 aaronmk
1132 13239 aaronmk
# usage: redirs=(...); [cmd_name_log_inc=#] echo_redirs_cmd
1133 13244 aaronmk
echo_redirs_cmd()
1134 13239 aaronmk
{
1135
	local cmd_name_log_inc="${cmd_name_log_inc-0}"
1136
1137 13242 aaronmk
	log++ echo_vars PATH
1138 13239 aaronmk
	log+ "$cmd_name_log_inc" echo_cmd "$@" $(
1139 13241 aaronmk
		# create redirs string
1140 13239 aaronmk
		set -- "${redirs[@]}" # operate on ${redirs[@]}
1141
		while test "$#" -gt 0 && starts_with '[<>][^&]' "$1"
1142 13240 aaronmk
		# print <>file redirs before cmd, because they introduce it
1143 13239 aaronmk
		do log "$1 \\"; shift; done # log() will run *before* echo_cmd itself
1144
		echo "$@"
1145
	)
1146
}
1147
1148 9685 aaronmk
function redir() # usage: local redirs=(#<>...); redir cmd...; unset redirs
1149 9138 aaronmk
# to view only explicitly-displayed errors: explicit_errors_only=1 script...
1150 9134 aaronmk
{
1151 9686 aaronmk
	echo_func; kw_params redirs
1152 9687 aaronmk
1153
	case "$1" in redir|command) "$@"; return;; esac # redir will be run later
1154 9685 aaronmk
	(
1155
		log++ set_fds "${redirs[@]}"
1156 10769 aaronmk
		unset redirs # don't redirect again in invoked command
1157 13244 aaronmk
		(case "$1" in command__exec) shift;; esac; echo_redirs_cmd "$@")
1158 12970 aaronmk
		if can_log; then indent; fi
1159 9685 aaronmk
		"$@"
1160
	) || return
1161
}
1162
alias redir='"redir" ' # last space alias-expands next word
1163
1164 9689 aaronmk
alias_append save_e '; unset redirs' # don't redirect error handlers
1165
1166 10022 aaronmk
fi # load new aliases
1167
if self_being_included; then
1168
1169
command() # usage: [cmd_log_fd=|1|2|#] [verbosity_min=] [nonrecursive=1] \
1170
# command extern_cmd...
1171 9685 aaronmk
{
1172 9740 aaronmk
	echo_func; kw_params log_fd cmd_log_fd redirs verbosity_min
1173 9291 aaronmk
	# if no cmd_log_fd, limit log_fd in case command uses util.sh
1174
	local cmd_log_fd="${cmd_log_fd-$log_fd}"
1175 9473 aaronmk
	local redirs=("${redirs[@]}")
1176 9231 aaronmk
1177 9685 aaronmk
	# determine redirections
1178 9436 aaronmk
	if test "$cmd_log_fd"; then
1179
		if can_log; then
1180
			if test "$cmd_log_fd" != "$log_fd"; then
1181 9473 aaronmk
				redirs+=("$cmd_log_fd>&$log_fd")
1182 9436 aaronmk
			fi # else no redir needed
1183 9473 aaronmk
		else redirs+=("$cmd_log_fd>/dev/null");
1184 9436 aaronmk
		fi
1185
	fi
1186 9444 aaronmk
1187 10022 aaronmk
	if test "$nonrecursive"; then cmd2abs_path; else cmd2rel_path; fi
1188 13211 aaronmk
	redir command__exec "$@"
1189 9134 aaronmk
}
1190 9685 aaronmk
command__exec()
1191
{
1192
	ensure_nested_func
1193 14703 aaronmk
	local verbosity_orig="$verbosity" # save for use in die_e
1194 9685 aaronmk
	if test "$verbosity_min"; then verbosity_min "$verbosity_min"; fi
1195 9868 aaronmk
	verbosity_compat
1196 14703 aaronmk
	builtin command "$@" || { verbosity="$verbosity_orig"; die_e; }
1197 9685 aaronmk
}
1198 9133 aaronmk
1199 9110 aaronmk
1200
### external command input/output
1201 8907 aaronmk
1202 9074 aaronmk
echo_stdin() # usage: input|echo_stdin|cmd
1203 8702 aaronmk
{
1204 8897 aaronmk
	if can_log; then
1205 8998 aaronmk
		pipe_delay
1206 9212 aaronmk
		echo ----- >&"$log_fd"
1207
		tee -a /dev/fd/"$log_fd";
1208
		echo ----- >&"$log_fd"
1209 8897 aaronmk
	else cat
1210
	fi
1211 8702 aaronmk
}
1212 8275 aaronmk
1213 9318 aaronmk
echo_stdout() { echo_stdin; } # usage: cmd|echo_stdout
1214 9044 aaronmk
1215 13212 aaronmk
stdout2fd() # usage: fd=# stdout2fd cmd...
1216
{
1217
	echo_func; kw_params fd; : "${fd?}"
1218
	if test "$fd" != 1; then local redirs=(">&$fd" "${redirs[@]}"); fi
1219
	redir "$@"
1220
}
1221 8873 aaronmk
1222 13212 aaronmk
function filter_fd() # usage: (fd=# [redirs=] filter_fd filter_cmd...; \
1223
# with filter...) # be sure ${redirs[@]} is not set to an outer value
1224
# useful e.g. to filter logging output or highlight errors
1225
{
1226
	echo_func; kw_params fd; : "${fd?}"
1227
	set_fds "$fd>" >(pipe_delay; stdout2fd "$@")
1228
	pipe_delay; pipe_delay # wait for >()'s pipe_delay and initial logging
1229
}
1230
alias filter_fd='"filter_fd" ' # last space alias-expands next word
1231
1232
stderr2stdout() # usage: { stderr2stdout cmd...|use stderr...; } 41>&1
1233
# **IMPORTANT**: fd 41 must later be redirected back to fd 1
1234 13319 aaronmk
# unlike `2>&1`, keeps stderr going to stderr
1235 13212 aaronmk
# redirects the command stdout to fd 41 to avoid collision with stderr
1236
{
1237
	echo_func
1238 13319 aaronmk
	# fd 2 *must* be redirected back to fd 2, not log-filtered, in case there
1239
	# are other errors in addition to the benign error
1240
	piped_cmd "$@" 2> >(log++ echo_run tee /dev/fd/2) >&41 # redirects 2->{1,2}
1241 13212 aaronmk
}
1242
1243
stdout_contains()
1244
# usage: { stderr2stdout cmd|stdout_contains echo_run grep ...; } 41>&1
1245
{
1246
	log_local; log++; echo_func
1247
	pipe_delay; pipe_delay; pipe_delay; "$@"|echo_stdout >/dev/null
1248
}
1249
1250 13342 aaronmk
stderr_matches() # usage: pattern=... [ignore_e=# [benign_error=1]] \
1251
# stderr_matches cmd...
1252 13212 aaronmk
{
1253
	echo_func; kw_params pattern ignore_e; : "${pattern?}"
1254
1255
	# not necessary to allow callers to handle the error themselves (which would
1256
	# require *every* caller to wrap this function in prep_try/rethrow), because
1257
	# they would just handle it by errexiting anyways
1258
	prep_try
1259
1260
	set +o errexit # avoid errexiting since @PIPESTATUS will be used instead
1261 13352 aaronmk
	{ benign_error=1 stderr2stdout "$@"\
1262
|stdout_contains echo_run grep -E "$pattern"; } 41>&1
1263
		# benign_error: handle exit status logging in this func instead
1264 13212 aaronmk
	local PIPESTATUS_=("${PIPESTATUS[@]}") # save b/c it's reset after each cmd
1265 13222 aaronmk
	echo_vars PIPESTATUS_
1266 13212 aaronmk
	set -o errexit
1267
1268 13223 aaronmk
	# handle any command error
1269
	e="${PIPESTATUS_[0]}"
1270 13212 aaronmk
	local matches="$(errexit "${PIPESTATUS_[1]}"; exit2bool)"
1271 13350 aaronmk
	if test "$matches"; then ignore_e "$ignore_e" #also works w/ ignore_e=''
1272 13352 aaronmk
	elif is_err && test ! "$benign_error"; then die_e # incorrectly suppressed
1273 13350 aaronmk
	fi
1274 13212 aaronmk
	rethrow_exit #force-exit b/c caller's test of return status disables errexit
1275
1276 13223 aaronmk
	# handle any filter error
1277
	e="${PIPESTATUS_[1]}"
1278
	ignore_e 1 # false is not an error
1279
	# all other unsuccessful exit statuses are errors
1280
	rethrow_exit #force-exit b/c caller's test of return status disables errexit
1281
1282 13212 aaronmk
	return "${PIPESTATUS_[1]}" # 2nd command's exit status -> $?
1283
}
1284
1285
fi # load new aliases
1286
if self_being_included; then
1287
1288
function ignore_err_msg() # usage: pattern=... [ignore_e=#] ignore_err_msg cmd
1289
# unlike `|| true`, this suppresses only errors caused by a particular error
1290
# *message*, rather than all error exit statuses
1291
{
1292
	echo_func; kw_params pattern; : "${pattern?}"
1293
	stderr_matches "$@" || true # also ignore false exit status on no match
1294
}
1295
alias ignore_err_msg='"ignore_err_msg" ' # last space alias-expands next word
1296
1297
1298 8854 aaronmk
#### commands
1299
1300 14762 aaronmk
already_exists_msg()
1301
# usage: cond || { save_e; what=_ already_exists_msg; rethrow; } || return 0
1302 11605 aaronmk
{
1303 14762 aaronmk
	log_info "$what already exists, skipping
1304 12842 aaronmk
$(mk_hint 'to force-remake, prepend `rm=1` to the command')"
1305 11605 aaronmk
}
1306 9620 aaronmk
1307 9122 aaronmk
require_not_exists() # usage: require_not_exists file || return 0
1308 14762 aaronmk
{ test ! -e "$1" || { save_e; what="file \"$1\"" already_exists_msg; rethrow;} }
1309 9062 aaronmk
1310 9680 aaronmk
function to_file() # usage: stdout=... [if_not_exists=1] [del=] to_file cmd...
1311 8986 aaronmk
# auto-removes a command's output file on error (like make's .DELETE_ON_ERROR)
1312 9048 aaronmk
{
1313 9695 aaronmk
	echo_func; kw_params stdout if_not_exists del
1314 9680 aaronmk
	: "${stdout?}"; local del="${del-1}"
1315 9475 aaronmk
	if test "$if_not_exists"; then require_not_exists "$stdout" || return 0; fi
1316 9481 aaronmk
1317 9652 aaronmk
	local redirs=("${redirs[@]}" ">$stdout")
1318 9690 aaronmk
	redir "$@" || { save_e; test ! "$del" || rm "$stdout"; rethrow; }
1319 9048 aaronmk
}
1320 9177 aaronmk
alias to_file='"to_file" ' # last space alias-expands next word
1321 8986 aaronmk
1322 9747 aaronmk
log_bg() { symbol='&' log_custom "$@"; }
1323
1324
log_last_bg() { log_bg '$!='"$!"; }
1325
1326 12835 aaronmk
function bg_cmd() # usage: bg_cmd cmd...
1327
{ echo_func; log_bg "$@"; "$@" & log_last_bg; }
1328 9747 aaronmk
alias bg_cmd='"bg_cmd" ' # last space alias-expands next word
1329
1330 8272 aaronmk
1331 9552 aaronmk
#### filesystem
1332
1333 12954 aaronmk
could_be_glob() { echo_func; contains_match '\*' "$1"; }
1334
1335
is_dir() { echo_func; test -d "$1"; }
1336
1337
could_be_dir() { echo_func; ends_with / "$1" || is_dir "$1"; }
1338
1339
is_file() { echo_func; test -f "$1"; }
1340
1341
could_be_file()
1342
{ echo_func; { ! could_be_dir "$1" && ! could_be_glob "$1";} || is_file "$1"; }
1343
1344 9830 aaronmk
alias mkdir='mkdir -p'
1345 13170 aaronmk
alias cp='cp -p'
1346 9830 aaronmk
1347 9556 aaronmk
alias file_size=\
1348 9558 aaronmk
"stat `case "$(uname)" in Darwin) echo -f %z;; *) echo --format=%s;; esac`"
1349 9552 aaronmk
1350 9829 aaronmk
alias wildcard='shopt -s nullglob; echo' # usage: "$(wildcard glob...)"
1351 9939 aaronmk
alias wildcard1='shopt -s nullglob; echo1' # usage: "$(wildcard1 glob...)"
1352 9552 aaronmk
1353 9831 aaronmk
fi # load new aliases
1354
if self_being_included; then
1355 9829 aaronmk
1356 9831 aaronmk
mv2dir() { echo_func; mkdir "${!#}"; mv "$@"; } # usage: mv2dir ... dir
1357
1358
# usage: (mv_glob ... dir)
1359
function mv_glob() { echo_func; if (($# > 1)); then mv2dir "$@"; fi; }
1360
alias mv_glob='shopt -s nullglob; "mv_glob"'
1361
1362 13176 aaronmk
### permissions
1363 9831 aaronmk
1364 13176 aaronmk
has_perms() # usage: perms=... has_perms item # perms: use find's -perm format
1365
{
1366
	echo_func; kw_params perms; : "${perms:?}"
1367
	test "$(find "$1" -maxdepth 0 -perm "$perms")"
1368
}
1369
1370 13177 aaronmk
is_world_executable() { echo_func; perms=-o=x has_perms "$1"; } # -: all bits
1371 13176 aaronmk
1372 13177 aaronmk
1373 8966 aaronmk
#### URLs
1374
1375 9074 aaronmk
localize_url() { test _"$1" = _"$(hostname -f)" || echo "$1"; }
1376 8966 aaronmk
1377 8704 aaronmk
fi