1
|
#!/bin/bash -e
|
2
|
set -o errexit -o pipefail # errexit in case caller's #! line missing -e
|
3
|
|
4
|
if test ! "$_util_sh_include_guard_utils"; then
|
5
|
_util_sh_include_guard_utils=1
|
6
|
|
7
|
isset() { declare -p "$1" &>/dev/null; }
|
8
|
|
9
|
realpath() { readlink -f -- "$1"; }
|
10
|
|
11
|
lowercase() { tr A-Z a-z <<<"$1"; }
|
12
|
|
13
|
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
|
|
17
|
include_guard_var() { str2varname "$(realpath "$1")"; }
|
18
|
|
19
|
self_not_included() # usage: if self_not_included; then ... fi
|
20
|
{
|
21
|
test $# -ge 1 || set -- "${BASH_SOURCE[1]}"
|
22
|
local include_guard="$(include_guard_var "$1")"
|
23
|
alias self_being_included=false
|
24
|
! isset "$include_guard" && \
|
25
|
{ eval "$include_guard"=1; alias self_being_included=true; }
|
26
|
}
|
27
|
|
28
|
# 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
|
fi
|
35
|
|
36
|
|
37
|
if self_not_included "${BASH_SOURCE[0]}"; then
|
38
|
|
39
|
|
40
|
#### options
|
41
|
|
42
|
shopt -s expand_aliases
|
43
|
# **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
|
|
46
|
|
47
|
#### stubs
|
48
|
|
49
|
die()
|
50
|
{ return "$?"; } # can't use `:` because that resets $?
|
51
|
|
52
|
alias log_local='declare PS4="$PS4" log_level="$log_level"'
|
53
|
|
54
|
function log++() { :; }
|
55
|
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
|
|
59
|
function log() { :; }
|
60
|
|
61
|
__caller_indent='log_indent="$log_indent$log_indent_step"'
|
62
|
alias caller_indent="$__caller_indent"
|
63
|
alias indent="declare $__caller_indent"
|
64
|
|
65
|
function canon_rel_path() { echo "$1"; }
|
66
|
|
67
|
function echo_func() { :; }
|
68
|
alias echo_func='"echo_func" "$@" && indent || true'
|
69
|
|
70
|
function echo_run() { :; }
|
71
|
alias echo_run='"echo_run" ' # last space alias-expands next word
|
72
|
|
73
|
# auto-echo common external commands
|
74
|
for cmd in env rm which; do alias "$cmd=echo_run $cmd"; done; unset cmd
|
75
|
|
76
|
echo_builtin() { :; }
|
77
|
|
78
|
function echo_vars() { :; }
|
79
|
|
80
|
|
81
|
#### logic
|
82
|
|
83
|
not() { ! "$@"; } # usage: wrapper_cmd not wrapped_cmd... # inverts exit status
|
84
|
|
85
|
bool!() # usage: "$(bool! "$bool_var")"
|
86
|
{ if test ! "$1"; then echo -n 1; fi } # empty<->non-empty
|
87
|
|
88
|
|
89
|
#### vars
|
90
|
|
91
|
alias local_array='declare -a'
|
92
|
# `local` does not support arrays in older versions of bash/on Mac
|
93
|
|
94
|
set_var() { eval "$1"'="$2"'; }
|
95
|
|
96
|
set_default() { if ! isset "$1"; then set_var "$@"; fi; }
|
97
|
|
98
|
set_inv() { set_var no_"$1" "$(test "${!1}" || echo 1)"; }
|
99
|
|
100
|
# usage: local var=...; local_inv
|
101
|
alias local_inv=\
|
102
|
'declare "no_$var=$(test "${!var}" || echo 1)"; echo_vars no_$var'
|
103
|
|
104
|
unexport() { export -n "$@"; }
|
105
|
# `declare +x` won't work because it defines the var if it isn't set
|
106
|
|
107
|
alias local_export='declare -x' # combines effects of local and export
|
108
|
|
109
|
alias export_array='declare -ax'
|
110
|
# `export` does not support arrays in older versions of bash/on Mac
|
111
|
|
112
|
# to make export only visible locally: local var="$var"; export var
|
113
|
# within cmd: var="$var" cmd...
|
114
|
|
115
|
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
|
# idempotent: vars already set will *not* be overwritten
|
120
|
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
|
# use ${...-...} to avoid overwriting an already-set var
|
126
|
declare "$dest_var=${!dest_var-${!src_var}}"; echo_vars "$dest_var"
|
127
|
done
|
128
|
EOF
|
129
|
)"
|
130
|
|
131
|
|
132
|
#### 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
|
matches() { test -z "${2##$1}"; } # usage: matches pattern str
|
164
|
|
165
|
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
|
function split() { split__with_IFS "$@"; echo_vars parts; }
|
202
|
# no echo_func because used by log++
|
203
|
split__with_IFS() { local IFS="$1"; parts=($2); } # limit effects of IFS
|
204
|
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
|
#### 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:+[0m}"
|
248
|
}
|
249
|
|
250
|
plain() { echo "[0m$1"; }
|
251
|
|
252
|
fade() { format 90 "$@"; } # medium gray fades on white *&* black backgrounds
|
253
|
|
254
|
|
255
|
#### 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
|
### stack traces
|
280
|
|
281
|
alias init_i='declare i="${i-0}"'
|
282
|
alias next_stack_frame='let! i++' # usage: init_i; __; next_stack_frame
|
283
|
alias prev_stack_frame='let! i--' # usage: next_stack_frame;__; prev_stack_frame
|
284
|
|
285
|
# makes stack_trace() skip the entry for the caller
|
286
|
alias skip_stack_frame='init_i; next_stack_frame'
|
287
|
alias skip_stack_frame_in_caller='next_stack_frame'
|
288
|
alias unskip_stack_frame_in_caller='prev_stack_frame'
|
289
|
|
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
|
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
|
{
|
313
|
: "${exclude:?}"
|
314
|
skip_stack_frame_in_caller # current function's frame
|
315
|
if test "$lookahead"; then skip_stack_frame_in_caller; fi
|
316
|
|
317
|
while get_stack_frame && matches "$exclude" "$func"; do # matching frame
|
318
|
next_stack_frame # skip matching frame
|
319
|
done
|
320
|
|
321
|
if test "$lookahead"; then unskip_stack_frame_in_caller; fi
|
322
|
unskip_stack_frame_in_caller
|
323
|
}
|
324
|
|
325
|
format_stack_frame() #usage: "$(func=_ file=_ line=_ format_stack_frame [args])"
|
326
|
{
|
327
|
log_local; log+ 2 # hide canon_rel_path() info
|
328
|
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
|
echo "$(esc "$func" "$@") $(plain "@$caller -> $func_loc")"
|
333
|
}
|
334
|
|
335
|
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
|
|
344
|
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
|
#### 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
|
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
|
|
361
|
|
362
|
#### caching
|
363
|
|
364
|
## shell-variable-based caching
|
365
|
|
366
|
# usage: local cache_key=...; load_cache; \
|
367
|
# if ! cached; then save_cache value || return; fi; echo_cached_value
|
368
|
# cache_key for function inputs: "$(declare -p kw_param...) $*"
|
369
|
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
|
#### 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
|
1st_non_opt() { while starts_with - "$1"; do shift; done; echo "$1"; }
|
390
|
|
391
|
# 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
|
log++ echo_func
|
415
|
: "${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
|
{ log++ echo_func; from="${1%__*}" to="$1" copy_func; }
|
424
|
|
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
|
#### aliases
|
435
|
|
436
|
fi # load new aliases
|
437
|
if self_being_included; then
|
438
|
|
439
|
unalias() { self_builtin "$@" 2>&- || true; } # no error if undefined
|
440
|
|
441
|
# usage: alias alias_='var=value run_cmd '
|
442
|
function run_cmd() { "$@"; }
|
443
|
alias run_cmd='"run_cmd" ' # last space alias-expands next word
|
444
|
|
445
|
alias_append() { eval "$(alias "$1")"'"$2"';} #usage: alias_append alias '; cmd'
|
446
|
|
447
|
|
448
|
#### commands
|
449
|
|
450
|
type() # handles fact that any alias would already be expanded
|
451
|
{ (unalias "$(1st_non_opt "$@")"; self_builtin "$@") || return; }
|
452
|
|
453
|
is_callable() { type -t -- "$1" >/dev/null; }
|
454
|
|
455
|
is_extern() { test "$(type -t -- "$1")" = file; }
|
456
|
|
457
|
is_intern() { is_callable "$1" && ! is_extern "$1"; }
|
458
|
|
459
|
is_dot_script()
|
460
|
{ log_local;log++; echo_func; test "${BASH_LINENO[${#BASH_LINENO[@]}-1]}" != 0;}
|
461
|
|
462
|
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
|
sys_cmd_path() { echo_func; echo_builtin command -p which "$1"|echo_stdout; }
|
472
|
|
473
|
# 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
|
_1="$(indent; log++ sys_cmd_path "$_1")" || return
|
478
|
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
|
function sudo()
|
489
|
{
|
490
|
echo_func
|
491
|
if is_callable "$1"; then set -- env PATH="$PATH" "$@"; fi # preserve PATH
|
492
|
self -E "$@"
|
493
|
}
|
494
|
alias sudo='"sudo" ' # last space alias-expands next word
|
495
|
|
496
|
|
497
|
#### exceptions
|
498
|
|
499
|
fi # load new aliases
|
500
|
if self_being_included; then
|
501
|
|
502
|
exit() { self_builtin "${1:-$?}"; } # exit sometimes inxeplicably ignores $?
|
503
|
|
504
|
errexit() # usage: cmd || errexit status # works in functions *and* subshells
|
505
|
{ return "$1"; }
|
506
|
# can't use `(exit "$1")` because a bug in bash prevents subshells from
|
507
|
# triggering errexit (would need to append `|| return` for it to work)
|
508
|
|
509
|
# usage: cmd || { save_e; ...; rethrow; }
|
510
|
|
511
|
alias export_e='e=$?'
|
512
|
|
513
|
# **WARNING**: if using this after a command that might succeed (rather than
|
514
|
# only upon error), you must `unset e` before the command
|
515
|
# idempotent: also works if save_e already called
|
516
|
alias save_e='# idempotent: use $e if the caller already called save_e
|
517
|
declare e_=$?;
|
518
|
declare e="$(if test "$e_" = 0; then echo "${e:-0}"; else echo "$e_"; fi)"'
|
519
|
|
520
|
rethrow() { errexit "${e:-0}"; } # only does anything if $e != 0
|
521
|
rethrow!() { rethrow && false; } # always errexit, even if $e = 0
|
522
|
rethrow_exit() { rethrow || exit; } # exit even where errexit disabled
|
523
|
|
524
|
is_err() { ! rethrow; } # rethrow->*false* if error
|
525
|
|
526
|
fi # load new aliases
|
527
|
if self_being_included; then
|
528
|
|
529
|
# usage: try cmd...; ignore_e status; if catch status; then ...; fi; \
|
530
|
# finally...; end_try
|
531
|
|
532
|
alias prep_try='declare e=0 benign_error="$benign_error"'
|
533
|
|
534
|
# usage: ...; try cmd... # *MUST* be at beginning of statement
|
535
|
# OR prep_try; var=... "try" cmd...
|
536
|
function try() { benign_error=1 "$@" || { export_e; true; }; }
|
537
|
alias try='prep_try; "try" ' # last space alias-expands next word
|
538
|
|
539
|
catch() { test "$e" = "${1:-0}" && e=0; } # also works w/ $1=''
|
540
|
|
541
|
ignore_e() { if catch "$@"; then benign_error=1; fi; } # also works w/ $1=''
|
542
|
|
543
|
alias end_try='rethrow'
|
544
|
|
545
|
ignore() { save_e; ignore_e "$@"; rethrow; } # usage: try cmd || ignore status
|
546
|
|
547
|
### signals
|
548
|
|
549
|
sig_e() { echo $(( 128+$(kill -l "$1") )); } # usage: sig_e SIGINT, etc.
|
550
|
|
551
|
func_override catch__exceptions
|
552
|
catch() # supports SIG* as exception type
|
553
|
{
|
554
|
log_local; log++; echo_func
|
555
|
if starts_with SIG "$1"; then set -- "$(sig_e "$1")"; fi
|
556
|
catch__exceptions "$@"
|
557
|
}
|
558
|
|
559
|
# usage: piped_cmd cmd1...|cmd2... # cmd2 doesn't read all its input
|
560
|
function piped_cmd() { "$@" || ignore SIGPIPE; }
|
561
|
alias piped_cmd='"piped_cmd" ' # last space alias-expands next word
|
562
|
|
563
|
fi # load new aliases
|
564
|
if self_being_included; then
|
565
|
|
566
|
|
567
|
#### text
|
568
|
|
569
|
nl='
|
570
|
'
|
571
|
|
572
|
# usage: by itself: split_lines str; use ${lines[@]}
|
573
|
# with wrapper: declare lines; wrapper "split_lines" str; use ${lines[@]}
|
574
|
function split_lines() { split "$nl" "$1"; lines=("${parts[@]}"); }
|
575
|
# no echo_func because used by log++
|
576
|
alias split_lines='declare lines; "split_lines"'
|
577
|
|
578
|
|
579
|
#### paths
|
580
|
|
581
|
strip/() { echo "${1%/}"; } # strips trailing /s
|
582
|
|
583
|
wildcard/() # usage: array=($(log++; [cd ...;] wildcard/ unquoted_pattern...))
|
584
|
{ cmd=strip/ foreach_arg; esc "$@"; }
|
585
|
|
586
|
wildcard.() # usage: array=($(log++; [cd ...;] wildcard. unquoted_pattern...))
|
587
|
# currently only removes . .. at beginning of list
|
588
|
{
|
589
|
set -- $(wildcard/ "$@") # first strip trailing /s
|
590
|
local to_rm=(. ..)
|
591
|
local item
|
592
|
if contains "$1" "${to_rm[@]}"; then
|
593
|
shift
|
594
|
if contains "$1" "${to_rm[@]}"; then shift; fi
|
595
|
fi
|
596
|
esc "$@"
|
597
|
}
|
598
|
|
599
|
#### streams
|
600
|
|
601
|
pipe_delay() # usage: cmd1 | { pipe_delay; cmd2; }
|
602
|
{ sleep 0.1; } # s; display after leading output of cmd1
|
603
|
|
604
|
|
605
|
#### verbose output
|
606
|
|
607
|
|
608
|
usage() { echo "Usage: $1" >&2; return 2; }
|
609
|
|
610
|
|
611
|
### log++
|
612
|
|
613
|
log_fd=2 # initially stderr
|
614
|
|
615
|
if test "$explicit_errors_only"; then verbosity=0; fi # hide startup logging
|
616
|
|
617
|
# set verbosity
|
618
|
if isset verbose; then : "${verbosity:=$(bool2int "$verbose")}"; fi
|
619
|
if isset vb; then : "${verbosity:=$vb}"; fi
|
620
|
: "${verbosity=1}" # default
|
621
|
: "${verbosity:=0}" # ensure non-empty
|
622
|
export verbosity # propagate to invoked commands
|
623
|
|
624
|
is_outermost="$(! isset log_level; exit2bool)" # if util.sh env not yet set up
|
625
|
|
626
|
# set log_level
|
627
|
: "${log_level=$(( ${#PS4}-1 ))}" # defaults to # non-space symbols in PS4
|
628
|
export log_level # propagate to invoked commands
|
629
|
export PS4 # follows log_level, so also propagate this
|
630
|
|
631
|
verbosity_int() { round_down "$verbosity"; }
|
632
|
|
633
|
# verbosities (and `make` equivalents):
|
634
|
# 0: just print errors. useful for cron jobs.
|
635
|
# vs. make: equivalent to --silent, but suppresses external command output
|
636
|
# 1: also external commands run. useful for running at the command line.
|
637
|
# vs. make: not provided (but sorely needed to avoid excessive output)
|
638
|
# 2: full graphical call tree. useful for determining where error occurred.
|
639
|
# vs. make: equivalent to default verbosity, but with much-needed indents
|
640
|
# 3: also values of kw params and variables. useful for low-level debugging.
|
641
|
# vs. make: not provided; need to manually use $(error $(var))
|
642
|
# 4: also variables in util.sh commands. useful for debugging util.sh.
|
643
|
# vs. make: somewhat similar to --print-data-base
|
644
|
# 5: also variables in logging commands themselves. useful for debugging echo_*.
|
645
|
# vs. make: not provided; need to search Makefile for @ at beginning of cmd
|
646
|
# 6+: not currently used (i.e. same as 5)
|
647
|
|
648
|
# definition: the log_level is the minimum verbosity needed to display a message
|
649
|
# for messages that use can_log(), the log_level starts with *1*, not 0
|
650
|
# for unfiltered messages, the log_level is 0 (i.e. still output at verbosity=0)
|
651
|
# to view a message's log_level, count the # of + signs before it in the output
|
652
|
|
653
|
fi # load new aliases
|
654
|
if self_being_included; then
|
655
|
|
656
|
# usage: in func: log_local; log++; ...
|
657
|
# outside func: log_local; log++; ...; log--
|
658
|
# before cmd: log++ cmd OR log+ num cmd OR log++ log++... cmd
|
659
|
# with a cmd, assignments are applied just to it, so log_local is not needed
|
660
|
# without a cmd, assignments are applied to caller ("$@" expands to nothing)
|
661
|
# "${@:2}" expands to all of $@ after *1st* arg, not 2nd ($@ indexes start at 1)
|
662
|
log:() # sets explicit log_level
|
663
|
{
|
664
|
if test $# -gt 1; then log_local; fi # if cmd, only apply assignments to it
|
665
|
# no local vars because w/o cmd, assignments should be applied to caller
|
666
|
log_level="$1"
|
667
|
PS4="$(str="${PS4:0:1}" n=$((log_level-1)) repeat)${PS4: -2}"
|
668
|
"${@:2}"
|
669
|
}
|
670
|
log+() { log: $((log_level+$1)) "${@:2}"; }
|
671
|
log-() { log+ "-$1" "${@:2}"; }
|
672
|
# no log:/+/- alias needed because next word is not an alias-expandable cmd
|
673
|
function log++() { log+ 1 "$@"; }
|
674
|
function log--() { log- 1 "$@"; }
|
675
|
function log!() { log: 0 "$@"; } # force-displays next log message
|
676
|
# see aliases in stubs
|
677
|
|
678
|
verbosity_min() # usage: verbosity_min {<min>|''}
|
679
|
# WARNING: '' is a special value that causes $verbosity to be overwritten to ''
|
680
|
{ if test ! "$1" -o "$(verbosity_int)" -lt "$1"; then verbosity="$1"; fi; }
|
681
|
alias verbosity_min='declare verbosity="$verbosity"; "verbosity_min"'
|
682
|
|
683
|
# usage: (verbosity_compat; cmd)
|
684
|
# **WARNING**: don't run this until right before executing an external command,
|
685
|
# so that it doesn't mess up the logging mechanism
|
686
|
function verbosity_compat()
|
687
|
{ log_local; log++; echo_func; if ((verbosity == 1)); then unset verbosity; fi;}
|
688
|
alias verbosity_compat='declare verbosity="$verbosity"; "verbosity_compat"'
|
689
|
|
690
|
|
691
|
# indent for call tree. this is *not* the log_level (below).
|
692
|
: "${log_indent_step=| }" "${log_indent=}"
|
693
|
export log_indent_step log_indent # propagate to invoked commands
|
694
|
|
695
|
# see indent alias in stubs
|
696
|
|
697
|
|
698
|
fi # load new aliases
|
699
|
if self_being_included; then
|
700
|
|
701
|
can_log() { test "$log_level" -le "$(verbosity_int)"; }
|
702
|
# verbosity=0 turns off all logging
|
703
|
|
704
|
can_highlight_log_msg() { test "$log_level" -le 1; }
|
705
|
|
706
|
highlight_log_msg() # usage: [format=...] highlight_log_msg msg
|
707
|
# format: the # in xfree86.org/current/ctlseqs.html#Character_Attributes
|
708
|
{
|
709
|
log_local; log+ 2; echo_func; kw_params format; log- 2
|
710
|
local format="${format-1}" # bold
|
711
|
if ! can_highlight_log_msg; then format=0; fi #remove surrounding formatting
|
712
|
format "$format" "$1"
|
713
|
}
|
714
|
|
715
|
log_line!() # highlights log_level 1 messages to stand out against other output
|
716
|
{ echo "$log_indent$PS4$(highlight_log_msg "$1")" >&"$log_fd"; }
|
717
|
|
718
|
log_msg!()
|
719
|
{
|
720
|
declare lines; log+ 2 "split_lines" "$1"
|
721
|
local l; for l in "${lines[@]}"; do log_line! "$l"; done
|
722
|
}
|
723
|
|
724
|
log() { if can_log; then log_msg! "$@"; fi; }
|
725
|
|
726
|
log_custom() # usage: symbol=... log_custom msg
|
727
|
{ log_indent="${log_indent//[^ ]/$symbol}" PS4="${PS4//[^ ]/$symbol}" log "$@";}
|
728
|
|
729
|
bg_r='101;97' # red background with white text
|
730
|
|
731
|
log_err() { symbol='#' format="$bg_r" log_fd="$err_fd" log! log_custom "$@";}
|
732
|
|
733
|
log_info() { symbol=: log_custom "$@"; }
|
734
|
|
735
|
mk_hint() { format=7 highlight_log_msg "$@";}
|
736
|
|
737
|
log_err_hint!() { log_err "$(mk_hint "$@")"; }
|
738
|
|
739
|
log_err_hint() # usage: cmd || [benign_error=1] log_err_hint msg [|| handle err]
|
740
|
# msg only displayed if not benign error
|
741
|
{
|
742
|
log++ kw_params benign_error
|
743
|
if test ! "$benign_error"; then log_err_hint! "$@"; fi
|
744
|
}
|
745
|
|
746
|
die() # usage: if msg uses $(...): cmd || { save_e; [type=...] die msg; }
|
747
|
# if msg uses only vars: cmd || [type=...] die msg
|
748
|
{ save_e; "log_${type:-err}" "$1"; rethrow!; }
|
749
|
|
750
|
die_e() # usage: cmd || [benign_error=1] die_e [|| handle error]
|
751
|
{
|
752
|
save_e; log++ kw_params benign_error
|
753
|
if test "$e" = "$(sig_e SIGPIPE)"; then benign_error=1; fi
|
754
|
if test "$benign_error"; then log_local; log++; fi
|
755
|
type="${benign_error:+info}" die "command exited with \
|
756
|
$(if test "$benign_error"; then echo status; else echo error; fi) $e"
|
757
|
rethrow
|
758
|
}
|
759
|
|
760
|
die_error_hidden() # usage: cmd || verbosity_min=# die_error_hidden [|| ...]
|
761
|
{
|
762
|
save_e; log++ echo_func; log++ kw_params verbosity_min
|
763
|
: "${verbosity_min:?}"; log++ echo_vars verbosity
|
764
|
if test "$(verbosity_int)" -lt "$verbosity_min"; then
|
765
|
log_err_hint 'to see error details, prepend `vb='"$verbosity_min"'` to the command'
|
766
|
fi
|
767
|
rethrow
|
768
|
}
|
769
|
|
770
|
|
771
|
#### paths
|
772
|
|
773
|
# cache realpath
|
774
|
: "${realpath_cache=}" # default off because slower than without
|
775
|
if test "$realpath_cache"; then
|
776
|
func_override realpath__no_cache
|
777
|
realpath() # caches the last result for efficiency
|
778
|
{
|
779
|
local cache_key="$*"; load_cache
|
780
|
if ! cached; then save_cache "$(realpath__no_cache "$@")" || return; fi
|
781
|
echo_cached_value
|
782
|
}
|
783
|
fi
|
784
|
|
785
|
rel_path() # usage: base_dir=... path=... rel_path
|
786
|
{
|
787
|
log_local; log++; #kw_params base_dir path #off -> no pst infinite recursion
|
788
|
: "${base_dir:?}" "${path:?}"
|
789
|
|
790
|
local path="$path/" # add *extra* / to match path when exactly = base_dir
|
791
|
path="${path#$base_dir/}" # remove prefix shared with base_dir
|
792
|
path="${path%/}" # remove any remaining extra trailing /
|
793
|
|
794
|
if test ! "$path"; then path=.; fi # ensure non-empty
|
795
|
|
796
|
#echo_vars path # off -> no pst infinite recursion
|
797
|
echo "$path"
|
798
|
}
|
799
|
|
800
|
cd -P . # expand symlinks in $PWD so it matches the output of realpath
|
801
|
# do before setting $top_script_abs so realpath has less symlinks to resolve
|
802
|
|
803
|
canon_rel_path() # usage: [base_dir=...] canon_rel_path path
|
804
|
# falls back to original path if can't resolve
|
805
|
{
|
806
|
#kw_params base_dir # off -> no pst infinite recursion
|
807
|
local path="$1" base_dir="${base_dir-$PWD}"
|
808
|
canon_rel_path__try || echo "$path"
|
809
|
}
|
810
|
canon_rel_path__try()
|
811
|
{
|
812
|
ensure_nested_func
|
813
|
base_dir="$(realpath "$base_dir")" || return
|
814
|
path="$(realpath "$path")" || return
|
815
|
rel_path
|
816
|
}
|
817
|
|
818
|
canon_dir_rel_path() # usage: [base_dir=...] canon_dir_rel_path path
|
819
|
# if the path is a symlink, just its parent dir will be canonicalized
|
820
|
{
|
821
|
kw_params base_dir; local base_dir="${base_dir-$PWD}"
|
822
|
base_dir="$(realpath "$base_dir")" || return
|
823
|
local path; path="$(realpath "$(dirname "$1")")/$(basename "$1")" || return
|
824
|
rel_path
|
825
|
}
|
826
|
|
827
|
# makes $1 a canon_rel_path if it's a filesystem path
|
828
|
alias cmd2rel_path="$(cat <<'EOF'
|
829
|
if is_extern "$1" && test -e "$1"; then # not relative to PATH
|
830
|
declare _1="$1"; shift
|
831
|
_1="$(log++ canon_rel_path "$_1")" || return
|
832
|
set -- "$_1" "$@"
|
833
|
fi
|
834
|
EOF
|
835
|
)"
|
836
|
|
837
|
# usage: path_parents path; use ${dirs[@]} # includes the path itself
|
838
|
function path_parents()
|
839
|
{
|
840
|
echo_func; local path="$1" prev_path=; dirs=()
|
841
|
while test "$path" != "$prev_path"; do
|
842
|
prev_path="$path"
|
843
|
dirs+=("$path")
|
844
|
path="${path%/*}"
|
845
|
done
|
846
|
}
|
847
|
alias path_parents='declare dirs; "path_parents"'
|
848
|
|
849
|
|
850
|
#### verbose output
|
851
|
|
852
|
|
853
|
### command echoing
|
854
|
|
855
|
alias echo_params='log "$*"'
|
856
|
|
857
|
fi # load new aliases
|
858
|
if self_being_included; then
|
859
|
|
860
|
echo_cmd() { echo_params; }
|
861
|
|
862
|
function echo_run() { echo_params; "$@"; }
|
863
|
# see echo_run alias after stub
|
864
|
|
865
|
echo_builtin() { echo_run builtin "$@"; } # usage: echo_builtin builtin_cmd...
|
866
|
|
867
|
echo_eval() { echo_params; builtin eval "$@"; }
|
868
|
|
869
|
## vars
|
870
|
|
871
|
echo_vars() # usage: echo_vars var... # also prints unset vars
|
872
|
{
|
873
|
log_local; log++ # same log_level as echo_func
|
874
|
if can_log; then
|
875
|
local set_exprs= shared_flags=
|
876
|
local var; for var in "${@%%=*}"; do
|
877
|
if ! isset "$var"; then declare "$var"='<unset>'; fi
|
878
|
|
879
|
# merge repeated flags
|
880
|
local decl="$(declare -p "$var")"; decl="${decl#declare }"
|
881
|
local flags="${decl%% *}" def="${decl#* }"
|
882
|
if test ! "$shared_flags"; then shared_flags="$flags"; fi
|
883
|
if test "$flags" != "$shared_flags"; then
|
884
|
set_exprs="$set_exprs$flags "
|
885
|
fi
|
886
|
set_exprs="$set_exprs$def "
|
887
|
done
|
888
|
# put all vars on same line so they don't clutter up the logging output
|
889
|
log "declare $shared_flags $set_exprs"
|
890
|
fi
|
891
|
}
|
892
|
|
893
|
echo_export() { builtin export "$@"; echo_vars "$@"; }
|
894
|
|
895
|
alias export="echo_export" # automatically echo env vars when they are set
|
896
|
|
897
|
func_override kw_params__lang
|
898
|
kw_params() { kw_params__lang "$@"; echo_vars "$@"; } # echo all keyword params
|
899
|
|
900
|
## functions
|
901
|
|
902
|
# usage: func() { echo_func; ... }
|
903
|
function echo_func()
|
904
|
# usage: "echo_func" "$@" && indent || true
|
905
|
# exit status: whether function call was echoed
|
906
|
{
|
907
|
log_local; log++; can_log || return
|
908
|
log "$(
|
909
|
log+ 2 # hide internal logging commands
|
910
|
skip_stack_frame # must be inside () to limit its effects
|
911
|
init_i
|
912
|
|
913
|
exclude='log*' skip_stack_frames # remove log* prefix to echo_func
|
914
|
|
915
|
# get call context before wrapper(s), which is more useful for debugging
|
916
|
get_stack_frame
|
917
|
local func_="$func" # don\'t change function name itself, just call info
|
918
|
exclude='with_*' lookahead=1 skip_stack_frames
|
919
|
|
920
|
get_stack_frame
|
921
|
func="$func_" format_stack_frame "$@"
|
922
|
)"
|
923
|
}
|
924
|
# see echo_func alias after stub
|
925
|
|
926
|
fi # load new aliases
|
927
|
if self_being_included; then
|
928
|
|
929
|
|
930
|
#### fds
|
931
|
|
932
|
fd_exists() { (: <&"$1") 2>/dev/null; }
|
933
|
|
934
|
require_fd_not_exists() # usage: require_fd_not_exists fd || return 0
|
935
|
{ ! fd_exists "$1" || type=info die "fd $1 already exists, skipping"; }
|
936
|
|
937
|
set_fds() # usage: set_fds redirect...
|
938
|
# WARNING: does not currently support redirecting an fd to itself (due to bash
|
939
|
# bug that requires the dest fd to be closed before it can be reopened)
|
940
|
{
|
941
|
echo_func
|
942
|
|
943
|
# add #<>&- before every #<>&# reopen to fix strange bash bug
|
944
|
local redirs=() i
|
945
|
for i in "$@"; do
|
946
|
# remove empty redirects resulting from using `redirs= cmd...` to clear
|
947
|
# the redirs and then using $redirs as an array
|
948
|
if test "$i"; then
|
949
|
local redir_prefix="$(match_prefix '*[<>]' "$i")"
|
950
|
local dest="$( rm_prefix '*[<>]' "$i")"
|
951
|
if test "$dest" && ! starts_with '&' "$dest"; then # escape dest
|
952
|
i="$redir_prefix$(printf %q "$dest")"
|
953
|
fi
|
954
|
if test "$redir_prefix"; then redirs+=("$redir_prefix&-"); fi
|
955
|
redirs+=("$i")
|
956
|
fi
|
957
|
done
|
958
|
set -- "${redirs[@]}"
|
959
|
|
960
|
if (($# > 0)); then echo_eval exec "$@"; fi
|
961
|
}
|
962
|
|
963
|
fd_set_default() # usage: fd_set_default 'dest[<>]src'
|
964
|
{
|
965
|
echo_func
|
966
|
local dest="${1%%[<>]*}"
|
967
|
require_fd_not_exists "$dest" || return 0
|
968
|
set_fds "$1"
|
969
|
}
|
970
|
|
971
|
# convention: use fd 40/41/42 for command-specific alternate stdin/stdout/stderr
|
972
|
# mnemonic: 4 looks like A for Alternate
|
973
|
# do NOT use 1x, which are used by eval (which is used by set_fds())
|
974
|
# do NOT use 2x, which we use as global stdin/stdout/stderr
|
975
|
|
976
|
stdlog=3
|
977
|
|
978
|
setup_log_fd() # view logging output at verbosity >= 5
|
979
|
{
|
980
|
log_local; log+ 4; log-- echo_func
|
981
|
fd_set_default "$stdlog>&2" || true # set up stdlog
|
982
|
log_fd="$stdlog" # don't change $log_fd until stdlog is set up
|
983
|
}
|
984
|
setup_log_fd
|
985
|
|
986
|
set_global_fds()
|
987
|
# allows commands to access global stdin/stdout/stderr using fd 20/21/22
|
988
|
# this works even when /dev/tty isn't available
|
989
|
# view logging output at verbosity >= 3
|
990
|
{
|
991
|
log_local; log+ 2; log-- echo_func
|
992
|
# ignore errors if a source fd isn't open
|
993
|
fd_set_default '20<&0' || true
|
994
|
fd_set_default '21>&1' || true
|
995
|
fd_set_default '22>&2' || true
|
996
|
debug_fd=22 # debug to global stderr in case stderr filtered
|
997
|
}
|
998
|
set_global_fds
|
999
|
|
1000
|
# usage: explicit_errors_only=1 script...
|
1001
|
# show only explicitly-displayed errors (which have been redirected to fd 22)
|
1002
|
# most of the time this has the same effect as `verbosity=0 script...`,
|
1003
|
# which displays everything that isn't explicitly hidden
|
1004
|
# this option should only be used for testing the explicit error displaying
|
1005
|
if test "$explicit_errors_only"; then disable_logging; fi
|
1006
|
|
1007
|
|
1008
|
log++ echo_vars is_outermost
|
1009
|
|
1010
|
|
1011
|
#### paths
|
1012
|
|
1013
|
log++
|
1014
|
|
1015
|
top_script="${BASH_SOURCE[${#BASH_SOURCE[@]}-1]}"; echo_vars top_script
|
1016
|
# outermost script; unlike $0, also defined for .-scripts
|
1017
|
|
1018
|
top_symlink_dir="$(dirname "$top_script")"; echo_vars top_symlink_dir
|
1019
|
top_symlink_dir_abs="$(realpath "$top_symlink_dir")"
|
1020
|
echo_vars top_symlink_dir_abs
|
1021
|
|
1022
|
top_script_abs="$(realpath "$top_script")"; echo_vars top_script_abs
|
1023
|
# realpath this before doing any cd so this points to the right place
|
1024
|
top_dir_abs="$(dirname "$top_script_abs")"; echo_vars top_dir_abs
|
1025
|
|
1026
|
log--
|
1027
|
|
1028
|
set_paths()
|
1029
|
{
|
1030
|
log_local; log++
|
1031
|
top_script="$(log++ canon_rel_path "$top_script_abs")" || return
|
1032
|
echo_vars top_script
|
1033
|
top_dir="$(dirname "$top_script")" || return; echo_vars top_dir
|
1034
|
}
|
1035
|
set_paths
|
1036
|
|
1037
|
# usage: $(enter_top_dir; cmd...)
|
1038
|
function enter_top_dir() { echo_func; cd "$top_dir"; }
|
1039
|
alias enter_top_dir='log++; "enter_top_dir"'
|
1040
|
|
1041
|
# usage: in_top_dir cmd...
|
1042
|
function in_top_dir() { echo_func; (enter_top_dir; "$@"); }
|
1043
|
alias in_top_dir='"in_top_dir" ' # last space alias-expands next word
|
1044
|
|
1045
|
PATH_rm() # usage: PATH_rm path... # removes components from the PATH
|
1046
|
{
|
1047
|
echo_func; echo_vars PATH; : "${PATH?}"
|
1048
|
log_local
|
1049
|
log+ 2
|
1050
|
split : "$PATH"
|
1051
|
local new_paths=()
|
1052
|
for path in "${parts[@]}"; do
|
1053
|
if ! contains "$path" "$@"; then new_paths+=("$path"); fi
|
1054
|
done
|
1055
|
PATH="$(delim=: join "${new_paths[@]}")" || return
|
1056
|
log- 2
|
1057
|
echo_vars PATH
|
1058
|
}
|
1059
|
|
1060
|
no_PATH_recursion() # usage: (no_PATH_recursion; cmd...)
|
1061
|
# allows running a system command of the same name as the script
|
1062
|
{
|
1063
|
echo_func
|
1064
|
PATH_rm "$top_dir_abs" "$top_symlink_dir" "$top_symlink_dir_abs" "$top_dir"
|
1065
|
}
|
1066
|
|
1067
|
# makes command in $1 nonrecursive
|
1068
|
# allows running a system command of the same name as the script
|
1069
|
alias cmd2abs_path="$(cat <<'EOF'
|
1070
|
declare _1="$1"; shift
|
1071
|
_1="$(indent; no_PATH_recursion; log++; which "$_1"|echo_stdout)" || return
|
1072
|
set -- "$_1" "$@"
|
1073
|
EOF
|
1074
|
)"
|
1075
|
|
1076
|
|
1077
|
#### verbose output
|
1078
|
|
1079
|
|
1080
|
## internal commands
|
1081
|
|
1082
|
.()
|
1083
|
{
|
1084
|
log_local; log++; log++ echo_func
|
1085
|
cmd2rel_path; set -- "$FUNCNAME" "$@"
|
1086
|
if (log++; echo_params; can_log); then indent; fi
|
1087
|
builtin "$@"
|
1088
|
}
|
1089
|
|
1090
|
.rel() # usage: .rel file [args...] # file relative to ${BASH_SOURCE[0]} dir
|
1091
|
{
|
1092
|
log++ log++ echo_func; local file="$1"; shift
|
1093
|
. "$(canon_rel_path "$(dirname "$(realpath "${BASH_SOURCE[1]}")")/$file")" \
|
1094
|
"$@"
|
1095
|
}
|
1096
|
|
1097
|
cd() # usage: cd dir [path_var...] # path_vars will be rebased for the new dir
|
1098
|
# indent is permanent within subshell cd was used in
|
1099
|
{
|
1100
|
log_local; log++ echo_func
|
1101
|
local dir="$1"; shift
|
1102
|
|
1103
|
# absolutize path_vars
|
1104
|
for path_var in "$@"; do # must happen *before* cd to use correct currdir
|
1105
|
set_var "$path_var" "$(realpath "${!path_var}")"
|
1106
|
done
|
1107
|
|
1108
|
# change dir
|
1109
|
# -P: expand symlinks so $PWD matches the output of realpath
|
1110
|
echo_run self_builtin -P "$dir"
|
1111
|
if can_log; then caller_indent; fi
|
1112
|
|
1113
|
func=realpath clear_cache
|
1114
|
set_paths
|
1115
|
|
1116
|
# re-relativize path_vars
|
1117
|
for path_var in "$@"; do # must happen *after* cd to use correct currdir
|
1118
|
set_var "$path_var" "$(canon_rel_path "${!path_var}")"
|
1119
|
done
|
1120
|
}
|
1121
|
|
1122
|
## external commands
|
1123
|
|
1124
|
disable_logging() { set_fds "$log_fd>/dev/null"; }
|
1125
|
|
1126
|
# usage: redirs=(...); [cmd_name_log_inc=#] echo_redirs_cmd
|
1127
|
echo_redirs_cmd()
|
1128
|
{
|
1129
|
local cmd_name_log_inc="${cmd_name_log_inc-0}"
|
1130
|
|
1131
|
log++ echo_vars PATH
|
1132
|
log+ "$cmd_name_log_inc" echo_cmd "$@" $(
|
1133
|
# create redirs string
|
1134
|
set -- "${redirs[@]}" # operate on ${redirs[@]}
|
1135
|
while test "$#" -gt 0 && starts_with '[<>][^&]' "$1"
|
1136
|
# print <>file redirs before cmd, because they introduce it
|
1137
|
do log "$1 \\"; shift; done # log() will run *before* echo_cmd itself
|
1138
|
echo "$@"
|
1139
|
)
|
1140
|
}
|
1141
|
|
1142
|
function redir() # usage: local redirs=(#<>...); redir cmd...; unset redirs
|
1143
|
# to view only explicitly-displayed errors: explicit_errors_only=1 script...
|
1144
|
{
|
1145
|
echo_func; kw_params redirs
|
1146
|
|
1147
|
case "$1" in redir|command) "$@"; return;; esac # redir will be run later
|
1148
|
(
|
1149
|
log++ set_fds "${redirs[@]}"
|
1150
|
unset redirs # don't redirect again in invoked command
|
1151
|
(case "$1" in command__exec) shift;; esac; echo_redirs_cmd "$@")
|
1152
|
if can_log; then indent; fi
|
1153
|
"$@"
|
1154
|
) || return
|
1155
|
}
|
1156
|
alias redir='"redir" ' # last space alias-expands next word
|
1157
|
|
1158
|
alias_append save_e '; unset redirs' # don't redirect error handlers
|
1159
|
|
1160
|
fi # load new aliases
|
1161
|
if self_being_included; then
|
1162
|
|
1163
|
command() # usage: [cmd_log_fd=|1|2|#] [verbosity_min=] [nonrecursive=1] \
|
1164
|
# command extern_cmd...
|
1165
|
{
|
1166
|
echo_func; kw_params log_fd cmd_log_fd redirs verbosity_min
|
1167
|
# if no cmd_log_fd, limit log_fd in case command uses util.sh
|
1168
|
local cmd_log_fd="${cmd_log_fd-$log_fd}"
|
1169
|
local redirs=("${redirs[@]}")
|
1170
|
|
1171
|
# determine redirections
|
1172
|
if test "$cmd_log_fd"; then
|
1173
|
if can_log; then
|
1174
|
if test "$cmd_log_fd" != "$log_fd"; then
|
1175
|
redirs+=("$cmd_log_fd>&$log_fd")
|
1176
|
fi # else no redir needed
|
1177
|
else redirs+=("$cmd_log_fd>/dev/null");
|
1178
|
fi
|
1179
|
fi
|
1180
|
|
1181
|
if test "$nonrecursive"; then cmd2abs_path; else cmd2rel_path; fi
|
1182
|
redir command__exec "$@"
|
1183
|
}
|
1184
|
command__exec()
|
1185
|
{
|
1186
|
ensure_nested_func
|
1187
|
local verbosity_orig="$verbosity" # save for use in die_e
|
1188
|
if test "$verbosity_min"; then verbosity_min "$verbosity_min"; fi
|
1189
|
verbosity_compat
|
1190
|
builtin command "$@" || { verbosity="$verbosity_orig"; die_e; }
|
1191
|
}
|
1192
|
|
1193
|
|
1194
|
### external command input/output
|
1195
|
|
1196
|
echo_stdin() # usage: input|echo_stdin|cmd
|
1197
|
{
|
1198
|
if can_log; then
|
1199
|
pipe_delay
|
1200
|
echo ----- >&"$log_fd"
|
1201
|
tee -a /dev/fd/"$log_fd";
|
1202
|
echo ----- >&"$log_fd"
|
1203
|
else cat
|
1204
|
fi
|
1205
|
}
|
1206
|
|
1207
|
echo_stdout() { echo_stdin; } # usage: cmd|echo_stdout
|
1208
|
|
1209
|
stdout2fd() # usage: fd=# stdout2fd cmd...
|
1210
|
{
|
1211
|
echo_func; kw_params fd; : "${fd?}"
|
1212
|
if test "$fd" != 1; then local redirs=(">&$fd" "${redirs[@]}"); fi
|
1213
|
redir "$@"
|
1214
|
}
|
1215
|
|
1216
|
function filter_fd() # usage: (fd=# [redirs=] filter_fd filter_cmd...; \
|
1217
|
# with filter...) # be sure ${redirs[@]} is not set to an outer value
|
1218
|
# useful e.g. to filter logging output or highlight errors
|
1219
|
{
|
1220
|
echo_func; kw_params fd; : "${fd?}"
|
1221
|
set_fds "$fd>" >(pipe_delay; stdout2fd "$@")
|
1222
|
pipe_delay; pipe_delay # wait for >()'s pipe_delay and initial logging
|
1223
|
}
|
1224
|
alias filter_fd='"filter_fd" ' # last space alias-expands next word
|
1225
|
|
1226
|
stderr2stdout() # usage: { stderr2stdout cmd...|use stderr...; } 41>&1
|
1227
|
# **IMPORTANT**: fd 41 must later be redirected back to fd 1
|
1228
|
# unlike `2>&1`, keeps stderr going to stderr
|
1229
|
# redirects the command stdout to fd 41 to avoid collision with stderr
|
1230
|
{
|
1231
|
echo_func
|
1232
|
# fd 2 *must* be redirected back to fd 2, not log-filtered, in case there
|
1233
|
# are other errors in addition to the benign error
|
1234
|
piped_cmd "$@" 2> >(log++ echo_run tee /dev/fd/2) >&41 # redirects 2->{1,2}
|
1235
|
}
|
1236
|
|
1237
|
stdout_contains()
|
1238
|
# usage: { stderr2stdout cmd|stdout_contains echo_run grep ...; } 41>&1
|
1239
|
{
|
1240
|
log_local; log++; echo_func
|
1241
|
pipe_delay; pipe_delay; pipe_delay; "$@"|echo_stdout >/dev/null
|
1242
|
}
|
1243
|
|
1244
|
stderr_matches() # usage: pattern=... [ignore_e=# [benign_error=1]] \
|
1245
|
# stderr_matches cmd...
|
1246
|
{
|
1247
|
echo_func; kw_params pattern ignore_e; : "${pattern?}"
|
1248
|
|
1249
|
# not necessary to allow callers to handle the error themselves (which would
|
1250
|
# require *every* caller to wrap this function in prep_try/rethrow), because
|
1251
|
# they would just handle it by errexiting anyways
|
1252
|
prep_try
|
1253
|
|
1254
|
set +o errexit # avoid errexiting since @PIPESTATUS will be used instead
|
1255
|
{ benign_error=1 stderr2stdout "$@"\
|
1256
|
|stdout_contains echo_run grep -E "$pattern"; } 41>&1
|
1257
|
# benign_error: handle exit status logging in this func instead
|
1258
|
local PIPESTATUS_=("${PIPESTATUS[@]}") # save b/c it's reset after each cmd
|
1259
|
echo_vars PIPESTATUS_
|
1260
|
set -o errexit
|
1261
|
|
1262
|
# handle any command error
|
1263
|
e="${PIPESTATUS_[0]}"
|
1264
|
local matches="$(errexit "${PIPESTATUS_[1]}"; exit2bool)"
|
1265
|
if test "$matches"; then ignore_e "$ignore_e" #also works w/ ignore_e=''
|
1266
|
elif is_err && test ! "$benign_error"; then die_e # incorrectly suppressed
|
1267
|
fi
|
1268
|
rethrow_exit #force-exit b/c caller's test of return status disables errexit
|
1269
|
|
1270
|
# handle any filter error
|
1271
|
e="${PIPESTATUS_[1]}"
|
1272
|
ignore_e 1 # false is not an error
|
1273
|
# all other unsuccessful exit statuses are errors
|
1274
|
rethrow_exit #force-exit b/c caller's test of return status disables errexit
|
1275
|
|
1276
|
return "${PIPESTATUS_[1]}" # 2nd command's exit status -> $?
|
1277
|
}
|
1278
|
|
1279
|
fi # load new aliases
|
1280
|
if self_being_included; then
|
1281
|
|
1282
|
function ignore_err_msg() # usage: pattern=... [ignore_e=#] ignore_err_msg cmd
|
1283
|
# unlike `|| true`, this suppresses only errors caused by a particular error
|
1284
|
# *message*, rather than all error exit statuses
|
1285
|
{
|
1286
|
echo_func; kw_params pattern; : "${pattern?}"
|
1287
|
stderr_matches "$@" || true # also ignore false exit status on no match
|
1288
|
}
|
1289
|
alias ignore_err_msg='"ignore_err_msg" ' # last space alias-expands next word
|
1290
|
|
1291
|
|
1292
|
#### commands
|
1293
|
|
1294
|
already_exists_msg() # usage: cond || what=... already_exists_msg || return 0
|
1295
|
{
|
1296
|
save_e # needed because $(mk_hint) resets $?
|
1297
|
type=info die "$what already exists, skipping
|
1298
|
$(mk_hint 'to force-remake, prepend `rm=1` to the command')"
|
1299
|
}
|
1300
|
|
1301
|
require_not_exists() # usage: require_not_exists file || return 0
|
1302
|
{ test ! -e "$1" || what="file \"$1\"" already_exists_msg; }
|
1303
|
|
1304
|
function to_file() # usage: stdout=... [if_not_exists=1] [del=] to_file cmd...
|
1305
|
# auto-removes a command's output file on error (like make's .DELETE_ON_ERROR)
|
1306
|
{
|
1307
|
echo_func; kw_params stdout if_not_exists del
|
1308
|
: "${stdout?}"; local del="${del-1}"
|
1309
|
if test "$if_not_exists"; then require_not_exists "$stdout" || return 0; fi
|
1310
|
|
1311
|
local redirs=("${redirs[@]}" ">$stdout")
|
1312
|
redir "$@" || { save_e; test ! "$del" || rm "$stdout"; rethrow; }
|
1313
|
}
|
1314
|
alias to_file='"to_file" ' # last space alias-expands next word
|
1315
|
|
1316
|
log_bg() { symbol='&' log_custom "$@"; }
|
1317
|
|
1318
|
log_last_bg() { log_bg '$!='"$!"; }
|
1319
|
|
1320
|
function bg_cmd() # usage: bg_cmd cmd...
|
1321
|
{ echo_func; log_bg "$@"; "$@" & log_last_bg; }
|
1322
|
alias bg_cmd='"bg_cmd" ' # last space alias-expands next word
|
1323
|
|
1324
|
|
1325
|
#### filesystem
|
1326
|
|
1327
|
could_be_glob() { echo_func; contains_match '\*' "$1"; }
|
1328
|
|
1329
|
is_dir() { echo_func; test -d "$1"; }
|
1330
|
|
1331
|
could_be_dir() { echo_func; ends_with / "$1" || is_dir "$1"; }
|
1332
|
|
1333
|
is_file() { echo_func; test -f "$1"; }
|
1334
|
|
1335
|
could_be_file()
|
1336
|
{ echo_func; { ! could_be_dir "$1" && ! could_be_glob "$1";} || is_file "$1"; }
|
1337
|
|
1338
|
alias mkdir='mkdir -p'
|
1339
|
alias cp='cp -p'
|
1340
|
|
1341
|
alias file_size=\
|
1342
|
"stat `case "$(uname)" in Darwin) echo -f %z;; *) echo --format=%s;; esac`"
|
1343
|
|
1344
|
alias wildcard='shopt -s nullglob; echo' # usage: "$(wildcard glob...)"
|
1345
|
alias wildcard1='shopt -s nullglob; echo1' # usage: "$(wildcard1 glob...)"
|
1346
|
|
1347
|
fi # load new aliases
|
1348
|
if self_being_included; then
|
1349
|
|
1350
|
mv2dir() { echo_func; mkdir "${!#}"; mv "$@"; } # usage: mv2dir ... dir
|
1351
|
|
1352
|
# usage: (mv_glob ... dir)
|
1353
|
function mv_glob() { echo_func; if (($# > 1)); then mv2dir "$@"; fi; }
|
1354
|
alias mv_glob='shopt -s nullglob; "mv_glob"'
|
1355
|
|
1356
|
### permissions
|
1357
|
|
1358
|
has_perms() # usage: perms=... has_perms item # perms: use find's -perm format
|
1359
|
{
|
1360
|
echo_func; kw_params perms; : "${perms:?}"
|
1361
|
test "$(find "$1" -maxdepth 0 -perm "$perms")"
|
1362
|
}
|
1363
|
|
1364
|
is_world_executable() { echo_func; perms=-o=x has_perms "$1"; } # -: all bits
|
1365
|
|
1366
|
|
1367
|
#### URLs
|
1368
|
|
1369
|
localize_url() { test _"$1" = _"$(hostname -f)" || echo "$1"; }
|
1370
|
|
1371
|
fi
|