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() { test "${!1+isset}"; }
|
8
|
|
9
|
realpath() { readlink -f -- "$1"; }
|
10
|
|
11
|
str2varname() { echo "${1//[^a-zA-Z0-9_]/_}"; }
|
12
|
|
13
|
include_guard_var() { str2varname "$(realpath "$1")"; }
|
14
|
|
15
|
self_not_included() # usage: if self_not_included; then ... fi
|
16
|
{
|
17
|
test $# -ge 1 || set -- "${BASH_SOURCE[1]}"
|
18
|
local include_guard="$(include_guard_var "$1")"
|
19
|
alias self_being_included=false
|
20
|
! isset "$include_guard" && \
|
21
|
{ eval "$include_guard"=1; alias self_being_included=true; }
|
22
|
}
|
23
|
|
24
|
# to load newly-defined aliases for use in functions in the same file:
|
25
|
## fi # load new aliases
|
26
|
## if self_being_included; then
|
27
|
# this is needed because aliases defined inside an if statement are not
|
28
|
# available inside that if statement
|
29
|
|
30
|
fi
|
31
|
|
32
|
|
33
|
if self_not_included "${BASH_SOURCE[0]}"; then
|
34
|
|
35
|
|
36
|
#### options
|
37
|
|
38
|
shopt -s expand_aliases
|
39
|
|
40
|
|
41
|
#### vars
|
42
|
|
43
|
set_var() { eval "$1"'="$2"'; }
|
44
|
|
45
|
set_default() { if ! isset "$1"; then set_var "$@"; fi; }
|
46
|
|
47
|
set_inv() { set_var no_"$1" "$(test "${!1}" || echo 1)"; }
|
48
|
|
49
|
# usage: local var=...; local_inv
|
50
|
alias local_inv='declare "no_$var=$(test "${!var}" || echo 1)"'
|
51
|
|
52
|
unexport() { export -n "$@"; }
|
53
|
# `declare +x` won't work because it defines the var if it isn't set
|
54
|
|
55
|
alias local_export='declare -x' # combines effects of local and export
|
56
|
|
57
|
get_prefix_vars() { : "${prefix:?}"; eval echo '${!'$prefix'*}'; }
|
58
|
|
59
|
# usage: local prefix=..._; import_vars
|
60
|
# when used inside another alias 2+ levels deep, *must* be run inside a function
|
61
|
alias import_vars="$(cat <<'EOF'
|
62
|
: "${prefix:?}"
|
63
|
declare src_var dest_var
|
64
|
for src_var in $(get_prefix_vars); do
|
65
|
dest_var="${src_var#$prefix}"
|
66
|
declare "$dest_var=${!src_var}"; echo_vars "$dest_var"
|
67
|
done
|
68
|
EOF
|
69
|
)"
|
70
|
|
71
|
|
72
|
#### caching
|
73
|
|
74
|
## shell-variable-based caching
|
75
|
|
76
|
# usage: local cache_key=...; load_cache; \
|
77
|
# if ! cached; then save_cache value || return; fi; echo_cached_value
|
78
|
# cache_key for function inputs: "$(declare -p kw_param...) $*"
|
79
|
alias load_cache='declare cache_var="$(str2varname "${FUNCNAME}___$cache_key")"'
|
80
|
alias cached='isset "$cache_var"'
|
81
|
alias save_cache='set_var "$cache_var"'
|
82
|
alias echo_cached_value='echo "${!cache_var}"'
|
83
|
|
84
|
clear_cache() # usage: func=... clear_cache
|
85
|
{ : "${func:?}"; unset $(prefix="${func}___" get_prefix_vars); }
|
86
|
|
87
|
fi # load new aliases
|
88
|
if self_being_included; then
|
89
|
|
90
|
|
91
|
#### aliases
|
92
|
|
93
|
unalias() { builtin unalias "$@" 2>&- || true; } # no error if undefined
|
94
|
|
95
|
# usage: alias alias_='var=value run_cmd '
|
96
|
function run_cmd() { "$@"; }
|
97
|
alias run_cmd='"run_cmd" ' # last space alias-expands next word
|
98
|
|
99
|
alias_append() { eval $(alias "$1")'"$2"'; } # usage: alias_append alias '; cmd'
|
100
|
|
101
|
|
102
|
#### functions
|
103
|
|
104
|
kw_params() # usage: func() { kw_params param_var...; }; ...; param_var=... cmd
|
105
|
# removes keyword-param-only vars from the environment
|
106
|
{ unexport "$@"; }
|
107
|
|
108
|
alias self='command "$FUNCNAME"' # usage: wrapper() { self ...; }
|
109
|
|
110
|
pf() { declare -f "$@"; } # usage: pf function # prints func decl for debugging
|
111
|
|
112
|
all_funcs() # usage: for func in $(all_funcs); do ...; done # all declared funcs
|
113
|
{ declare -F|while read -r line; do echo -n "${line#declare -f } "; done; }
|
114
|
|
115
|
|
116
|
#### exceptions
|
117
|
|
118
|
# usage: cmd || { save_e; ...; rethrow; }
|
119
|
alias export_e='e=$?'
|
120
|
alias save_e='declare e=$?'
|
121
|
alias rethrow='return "$e"'
|
122
|
alias rethrow_subshell='exit "$e"'
|
123
|
|
124
|
fi # load new aliases
|
125
|
if self_being_included; then
|
126
|
|
127
|
# usage: try cmd...; ignore_e status; if catch status; then ...; fi; end_try
|
128
|
|
129
|
function try() { e=0; benign_error=1 "$@" || { export_e; true; }; }
|
130
|
alias try='declare e; "try" ' # last space alias-expands next word
|
131
|
|
132
|
catch() { test "$e" -eq "$1" && e=0; }
|
133
|
|
134
|
ignore_e() { catch "$@" || true; }
|
135
|
|
136
|
alias end_try='rethrow'
|
137
|
alias end_try_subshell='rethrow_subshell'
|
138
|
|
139
|
ignore() { save_e; ignore_e "$@"; rethrow; } # usage: try cmd || ignore status
|
140
|
|
141
|
### signals
|
142
|
|
143
|
sig_e() { echo $(( 128+$(kill -l "$1") )); } # usage: sig_e SIGINT, etc.
|
144
|
|
145
|
ignore_sig() { ignore "$(sig_e "$1")"; }
|
146
|
|
147
|
# usage: piped_cmd cmd1...|cmd2... # cmd2 doesn't read all its input
|
148
|
function piped_cmd() { "$@" || ignore_sig SIGPIPE; }
|
149
|
alias piped_cmd='"piped_cmd" ' # last space alias-expands next word
|
150
|
|
151
|
fi # load new aliases
|
152
|
if self_being_included; then
|
153
|
|
154
|
|
155
|
#### integers
|
156
|
|
157
|
let!() { let "$@" || true; } # always returns true; safe to use for setting
|
158
|
# "If the last ARG evaluates to 0, let returns 1" (`help let`)
|
159
|
|
160
|
bool2int() { try test ! "$1"; echo "$e"; } # empty->0; non-empty->1
|
161
|
|
162
|
int2exit() { (( "$1" != 0 )); }
|
163
|
|
164
|
exit2bool() { if (( $? == 0 )); then echo 1; fi } # 0->non-empty; !=0->empty
|
165
|
|
166
|
|
167
|
#### floats
|
168
|
|
169
|
int_part() { echo "${1%%.*}"; }
|
170
|
|
171
|
dec_suffix() { echo "${1#$(int_part "$1")}"; }
|
172
|
|
173
|
round_down() { int_part "$1"; }
|
174
|
|
175
|
float+int() { echo "$(($(int_part "$1")+$2))$(dec_suffix "$1")"; }
|
176
|
|
177
|
float_set_min() { if (($(int_part $1) >= $2)); then echo $1; else echo $2; fi; }
|
178
|
|
179
|
|
180
|
#### strings
|
181
|
|
182
|
starts_with() { test "${2#$1}" != "$2"; } # usage: starts_with pattern str
|
183
|
|
184
|
match_prefix() # usage: match_prefix pattern str
|
185
|
{ if starts_with "$1" "$2"; then echo "${2%${2#$1}}"; fi }
|
186
|
|
187
|
repeat() # usage: str=... n=... repeat
|
188
|
{
|
189
|
: "${str?}" "${n:?}"; local result= n="$n" # n will be modified in function
|
190
|
for (( ; n > 0; n-- )); do result="$result$str"; done
|
191
|
echo "$result"
|
192
|
}
|
193
|
|
194
|
sed_cmd="sed -`case "$(uname)" in Darwin) echo E;; *) echo r;; esac`"
|
195
|
alias sed="$sed_cmd"
|
196
|
|
197
|
fi # load new aliases
|
198
|
if self_being_included; then
|
199
|
|
200
|
rtrim() { log+ 3; sed 's/[[:space:]]+$//' <<<"$1"; }
|
201
|
|
202
|
|
203
|
#### arrays
|
204
|
|
205
|
join() { local IFS="$delim"; echo "$*"; } # usage: delim=... join elems...
|
206
|
|
207
|
reverse() # usage: array=($(reverse args...))
|
208
|
{
|
209
|
local i
|
210
|
for (( i=$#; i > 0; i-- )); do printf '%q ' "${!i}"; done
|
211
|
}
|
212
|
|
213
|
contains() # usage: contains value in_array...
|
214
|
{
|
215
|
local value="$1"; shift
|
216
|
local elem
|
217
|
for elem in "$@"; do if test "$elem" = "$value"; then return 0; fi; done
|
218
|
return 1
|
219
|
}
|
220
|
|
221
|
#### streams
|
222
|
|
223
|
pipe_delay() # usage: cmd1 | { pipe_delay; cmd2; }
|
224
|
{ sleep 0.1; } # s; display after leading output of cmd1
|
225
|
|
226
|
|
227
|
#### verbose output
|
228
|
|
229
|
|
230
|
err_fd=2 # stderr
|
231
|
|
232
|
usage() { echo "Usage: $1" >&2; return 2; }
|
233
|
|
234
|
|
235
|
### log++
|
236
|
|
237
|
log_fd=2 # initially stderr
|
238
|
|
239
|
if test "$explicit_errors_only"; then verbosity=0; fi # hide startup logging
|
240
|
|
241
|
# set verbosity
|
242
|
if isset verbose; then : "${verbosity:=$(bool2int "$verbose")}"; fi
|
243
|
if isset vb; then : "${verbosity:=$vb}"; fi
|
244
|
: "${verbosity=1}" # default
|
245
|
: "${verbosity:=0}" # ensure non-empty
|
246
|
export verbosity # propagate to invoked commands
|
247
|
export PS4 # follows verbosity, so also propagate this
|
248
|
|
249
|
# set log_level
|
250
|
: "${log_level=$(( ${#PS4}-1 ))}" # defaults to # non-space symbols in PS4
|
251
|
export log_level # propagate to invoked commands
|
252
|
|
253
|
verbosity_int() { round_down "$verbosity"; }
|
254
|
|
255
|
# verbosities (and `make` equivalents):
|
256
|
# 0: just print errors. useful for cron jobs.
|
257
|
# vs. make: equivalent to --silent, but suppresses external command output
|
258
|
# 1: also external commands run. useful for running at the command line.
|
259
|
# vs. make: not provided (but sorely needed to avoid excessive output)
|
260
|
# 2: full graphical call tree. useful for determining where error occurred.
|
261
|
# vs. make: equivalent to default verbosity, but with much-needed indents
|
262
|
# 3: also values of kw params and variables. useful for low-level debugging.
|
263
|
# vs. make: not provided; need to manually use $(error $(var))
|
264
|
# 4: also variables in util.sh commands. useful for debugging util.sh.
|
265
|
# vs. make: somewhat similar to --print-data-base
|
266
|
# 5: also variables in logging commands themselves. useful for debugging echo_*.
|
267
|
# vs. make: not provided; need to search Makefile for @ at beginning of cmd
|
268
|
# 6+: not currently used (i.e. same as 5)
|
269
|
|
270
|
# definition: the log_level is the minimum verbosity needed to display a message
|
271
|
# for messages that use can_log(), the log_level starts with *1*, not 0
|
272
|
# for unfiltered messages, the log_level is 0 (i.e. still output at verbosity=0)
|
273
|
# to view a message's log_level, count the # of + signs before it in the output
|
274
|
|
275
|
fi # load new aliases
|
276
|
if self_being_included; then
|
277
|
|
278
|
# usage: in func: log++; ... OR log_local; "log++"; ...
|
279
|
# outside func: log++; ...; log--
|
280
|
# before cmd: log++ cmd... OR log+ # cmd... OR "log++" "log++" cmd...
|
281
|
# with a cmd, assignments are applied just to it, so log_local is not needed
|
282
|
# without a cmd, "$@" expands to nothing and assignments are applied to caller
|
283
|
# "${@:2}" expands to all of $@ after *1st* arg, not 2nd ($@ indexes start at 1)
|
284
|
log+()
|
285
|
{
|
286
|
# no local vars because w/o cmd, assignments should be applied to caller
|
287
|
PS4="$(str="${PS4:0:1}" n=$((log_level+$1-1)) repeat)${PS4: -2}"; \
|
288
|
log_level=$((log_level+$1)) \
|
289
|
verbosity="$(float+int "$verbosity" "-$1")" "${@:2}"
|
290
|
}
|
291
|
log++() { log+ 1 "$@"; }
|
292
|
log--() { log+ -1 "$@"; }
|
293
|
alias log_local=\
|
294
|
'declare PS4="$PS4" log_level="$log_level" verbosity="$verbosity"'
|
295
|
alias log+='log_local; "log+"' # don't expand next word because it's not a cmd
|
296
|
alias log++='log_local; "log++" ' # last space alias-expands next word
|
297
|
alias log--='log_local; "log--" ' # last space alias-expands next word
|
298
|
|
299
|
verbosity_min() # usage: verbosity_min min
|
300
|
{ if test "$(verbosity_int)" -lt "$1"; then verbosity="$1"; fi; }
|
301
|
alias verbosity_min='log_local; "verbosity_min"'
|
302
|
|
303
|
|
304
|
# indent for call tree. this is *not* the log_level (below).
|
305
|
: "${log_indent_step=| }" "${log_indent=}"
|
306
|
export log_indent_step log_indent # propagate to invoked commands
|
307
|
|
308
|
__caller_indent='log_indent="$log_indent$log_indent_step"'
|
309
|
alias caller_indent="$__caller_indent"
|
310
|
alias indent="declare $__caller_indent"
|
311
|
|
312
|
|
313
|
fi # load new aliases
|
314
|
if self_being_included; then
|
315
|
|
316
|
can_log() { test "$(verbosity_int)" -gt 0; }
|
317
|
# verbosity=0 turns off all logging
|
318
|
|
319
|
log() { if can_log; then echo "$log_indent$PS4$1" >&"$log_fd"; fi; }
|
320
|
|
321
|
log_custom() # usage: symbol=... log_custom msg
|
322
|
{ log_indent="${log_indent//[^ ]/$symbol}" PS4="${PS4//[^ ]/$symbol}" log "$@";}
|
323
|
|
324
|
log_err() { symbol='#' verbosity=1 log_fd="$err_fd" log_custom "$@"; }
|
325
|
|
326
|
log_info() { symbol=: log_custom "$@"; }
|
327
|
|
328
|
die() # usage: cmd || [type=...] die msg # msg can use $? but not $()
|
329
|
{ save_e; kw_params type; "log_${type:-err}" "$1"; rethrow; }
|
330
|
|
331
|
die_e() # usage: cmd || [benign_error=1] die_e [|| handle error]
|
332
|
{
|
333
|
save_e; kw_params benign_error
|
334
|
if test "$benign_error"; then log++; fi
|
335
|
type="${benign_error:+info}" die "command exited with \
|
336
|
$(if test "$benign_error"; then echo status; else echo error; fi) $e"
|
337
|
rethrow
|
338
|
}
|
339
|
|
340
|
|
341
|
#### functions
|
342
|
|
343
|
func_exists() { declare -f "$1" >/dev/null; }
|
344
|
|
345
|
copy_func() # usage: from=... to=... copy_func
|
346
|
# $to must not exist. to get around the no-clobber restriction, use `unset -f`.
|
347
|
{
|
348
|
: "${from:?}" "${to:?}"
|
349
|
func_exists "$from" || die "function does not exist: $from"
|
350
|
! func_exists "$to" || die "function already exists: $to"
|
351
|
local from_def="$(declare -f "$from")"
|
352
|
eval "$to${from_def#$from}"
|
353
|
}
|
354
|
|
355
|
func_override() # usage: func_override old_name__suffix
|
356
|
{ from="${1%__*}" to="$1" copy_func; }
|
357
|
|
358
|
ensure_nested_func() # usage: func__nested_func() { ensure_nested_func; ... }
|
359
|
{
|
360
|
local nested_func="${FUNCNAME[1]}"
|
361
|
local func="${nested_func%%__*}"
|
362
|
contains "$func" "${FUNCNAME[@]}" || \
|
363
|
die "$nested_func() must be used by $func()"
|
364
|
}
|
365
|
|
366
|
|
367
|
#### paths
|
368
|
|
369
|
# cache realpath
|
370
|
: "${realpath_cache=}" # default off because slower than without
|
371
|
if test "$realpath_cache"; then
|
372
|
func_override realpath__no_cache
|
373
|
realpath() # caches the last result for efficiency
|
374
|
{
|
375
|
local cache_key="$*"; load_cache
|
376
|
if ! cached; then save_cache "$(realpath__no_cache "$@")" || return; fi
|
377
|
echo_cached_value
|
378
|
}
|
379
|
fi
|
380
|
|
381
|
rel_path() # usage: base_dir=... path=... rel_path
|
382
|
{
|
383
|
log++; kw_params base_dir path
|
384
|
: "${base_dir:?}" "${path:?}"
|
385
|
|
386
|
local path="$path/" # add *extra* / to match path when exactly = base_dir
|
387
|
path="${path#$base_dir/}" # remove prefix shared with base_dir
|
388
|
path="${path%/}" # remove any remaining extra trailing /
|
389
|
|
390
|
if test ! "$path"; then path=.; fi # ensure non-empty
|
391
|
|
392
|
echo_vars path
|
393
|
echo "$path"
|
394
|
}
|
395
|
|
396
|
cd -P . # expand symlinks in $PWD so it matches the output of realpath
|
397
|
# do before setting $top_script_abs so realpath has less symlinks to resolve
|
398
|
|
399
|
canon_rel_path()
|
400
|
{
|
401
|
local path; path="$(realpath "$1")" || return
|
402
|
base_dir="$PWD" rel_path
|
403
|
}
|
404
|
|
405
|
# makes $1 a canon_rel_path if it's a filesystem path
|
406
|
alias cmd2rel_path="$(cat <<'EOF'
|
407
|
if test "$(type -t "$1")" = file && test -e "$1"; then # not relative to PATH
|
408
|
declare _1="$1"; shift
|
409
|
_1="$(canon_rel_path "$_1")" || return
|
410
|
set -- "$_1" "$@"
|
411
|
fi
|
412
|
EOF
|
413
|
)"
|
414
|
|
415
|
|
416
|
#### verbose output
|
417
|
|
418
|
|
419
|
### command echoing
|
420
|
|
421
|
alias echo_params='log "$*"'
|
422
|
|
423
|
fi # load new aliases
|
424
|
if self_being_included; then
|
425
|
|
426
|
echo_cmd() { echo_params; }
|
427
|
|
428
|
function echo_run() { echo_params; "$@"; }
|
429
|
alias echo_run='"echo_run" ' # last space alias-expands next word
|
430
|
|
431
|
echo_eval() { echo_params; builtin eval "$@"; }
|
432
|
|
433
|
# usage: redirs=(...); echo_redirs_cmd
|
434
|
function echo_redirs_cmd()
|
435
|
{
|
436
|
# print <>file redirs before cmd, because they introduce it
|
437
|
echo_cmd "$@" $(
|
438
|
set -- "${redirs[@]}" # operate on @redirs
|
439
|
while test "$#" -gt 0 && starts_with '[<>][^&]' "$1"
|
440
|
do log "$1 \\"; shift; done # log() will run *before* echo_cmd itself
|
441
|
echo "$@"
|
442
|
)
|
443
|
}
|
444
|
alias echo_redirs_cmd='"echo_redirs_cmd" "$@"'
|
445
|
|
446
|
## vars
|
447
|
|
448
|
echo_vars() # usage: echo_vars var...
|
449
|
{
|
450
|
log+ 2
|
451
|
if can_log; then
|
452
|
local var
|
453
|
for var in "${@%%=*}"; do
|
454
|
if isset "$var"; then log "$(declare -p "$var")"; fi
|
455
|
done
|
456
|
fi
|
457
|
}
|
458
|
|
459
|
echo_export() { builtin export "$@"; echo_vars "$@"; }
|
460
|
|
461
|
alias export="echo_export" # automatically echo env vars when they are set
|
462
|
|
463
|
func_override kw_params__lang
|
464
|
kw_params() { kw_params__lang "$@"; echo_vars "$@"; } # echo all keyword params
|
465
|
|
466
|
## functions
|
467
|
|
468
|
# usage: local func=...; set_func_loc; use $file, $line
|
469
|
alias set_func_loc="$(cat <<'EOF'
|
470
|
: "${func:?}"
|
471
|
local func_info="$(shopt -s extdebug; declare -F "$func")" # 'func line file'
|
472
|
func_info="${func_info#$func }"
|
473
|
local line="${func_info%% *}"
|
474
|
local file="${func_info#$line }"
|
475
|
EOF
|
476
|
)"
|
477
|
|
478
|
fi # load new aliases
|
479
|
if self_being_included; then
|
480
|
|
481
|
func_loc() # gets where function declared in the format file:line
|
482
|
{
|
483
|
local func="$1"; set_func_loc
|
484
|
file="$(canon_rel_path "$file")" || return
|
485
|
echo "$file:$line"
|
486
|
}
|
487
|
|
488
|
# usage: func() { [minor=1] echo_func; ... }
|
489
|
function echo_func()
|
490
|
# usage: [minor=1] "echo_func" "$FUNCNAME" "$@" && indent || true
|
491
|
# exit status: whether function call was echoed
|
492
|
{
|
493
|
kw_params minor
|
494
|
local func="$1"; shift
|
495
|
|
496
|
log++; if test "$minor"; then log++; fi
|
497
|
local loc; loc="$(func_loc "$func")" || return
|
498
|
echo_cmd "$loc" "$func" "$@"
|
499
|
can_log
|
500
|
}
|
501
|
alias echo_func='"echo_func" "$FUNCNAME" "$@" && indent || true'
|
502
|
|
503
|
fi # load new aliases
|
504
|
if self_being_included; then
|
505
|
|
506
|
|
507
|
#### streams
|
508
|
|
509
|
fd_exists() { (: <&"$1") 2>/dev/null; }
|
510
|
|
511
|
require_fd_not_exists() # usage: require_fd_not_exists fd || return 0
|
512
|
{ ! fd_exists "$1" || type=info die "fd $1 already exists, skipping"; }
|
513
|
|
514
|
set_fds() # usage: set_fds redirect...
|
515
|
{
|
516
|
echo_func
|
517
|
|
518
|
# add #<>&- before every #<>&# reopen to fix strange bash bug
|
519
|
local redirs=()
|
520
|
for i in "$@"; do
|
521
|
local redir_prefix="$(match_prefix '*[<>]' "$i")"
|
522
|
if test "$redir_prefix"; then redirs+=("$redir_prefix&-"); fi
|
523
|
redirs+=("$i")
|
524
|
done
|
525
|
set -- "${redirs[@]}"
|
526
|
|
527
|
echo_eval exec "$@"
|
528
|
}
|
529
|
|
530
|
fd_set_default() # usage: fd_set_default 'dest[<>]src'
|
531
|
{
|
532
|
echo_func
|
533
|
local dest="${1%%[<>]*}"
|
534
|
require_fd_not_exists "$dest" || return 0
|
535
|
set_fds "$1"
|
536
|
}
|
537
|
|
538
|
filter_fd() # usage: (fd=# filter_fd filter_cmd...; with filter...)
|
539
|
# useful e.g. to filter logging output or highlight errors
|
540
|
{
|
541
|
echo_func; kw_params fd; : "${fd?}"
|
542
|
set_fds "$fd>" >(pipe_delay; redirs=(">&$fd" "${redirs[@]}"); redir "$@")
|
543
|
pipe_delay; pipe_delay # wait for >()'s pipe_delay and initial logging
|
544
|
}
|
545
|
|
546
|
# convention: use fd 40/41/42 for command-specific alternate stdin/stdout/stderr
|
547
|
# do NOT use 1x, which are used by eval (which is used by set_fds())
|
548
|
# do NOT use 2x, which are used as global stdin/stdout/stderr
|
549
|
# do NOT use 3x, which are used for logging
|
550
|
|
551
|
setup_log_fd() # view logging output at verbosity >= 5
|
552
|
{
|
553
|
log+ 4; log-- echo_func
|
554
|
fd_set_default '30>&2' || true # stdlog
|
555
|
log_fd=30 # stdlog
|
556
|
}
|
557
|
setup_log_fd
|
558
|
|
559
|
set_global_fds()
|
560
|
# allows commands to access global stdin/stdout/stderr using fd 20/21/22
|
561
|
# this works even when /dev/tty isn't available
|
562
|
# view logging output at verbosity >= 3
|
563
|
{
|
564
|
log+ 2; log-- echo_func
|
565
|
# ignore errors if a source fd isn't open
|
566
|
fd_set_default '20<&0' || true
|
567
|
fd_set_default '21>&1' || true
|
568
|
fd_set_default '22>&2' || true
|
569
|
}
|
570
|
set_global_fds
|
571
|
|
572
|
# usage: explicit_errors_only=1 script...
|
573
|
# show only explicitly-displayed errors (which have been redirected to fd 22)
|
574
|
# most of the time this has the same effect as `verbosity=0 script...`,
|
575
|
# which displays everything that isn't explicitly hidden
|
576
|
# this option should only be used for testing the explicit error displaying
|
577
|
if test "$explicit_errors_only"; then disable_logging; fi
|
578
|
|
579
|
|
580
|
#### paths
|
581
|
|
582
|
top_script_abs="$(realpath "$0")"; echo_vars top_script_abs # outermost script
|
583
|
# realpath this before doing any cd so this points to the right place
|
584
|
|
585
|
set_paths()
|
586
|
{
|
587
|
top_script="$(canon_rel_path "$top_script_abs")" || return
|
588
|
echo_vars top_script
|
589
|
top_dir="$(dirname "$top_script")" || return; echo_vars top_dir
|
590
|
}
|
591
|
set_paths
|
592
|
|
593
|
|
594
|
#### verbose output
|
595
|
|
596
|
|
597
|
## internal commands
|
598
|
|
599
|
.()
|
600
|
{
|
601
|
cmd2rel_path; set -- "$FUNCNAME" "$@"
|
602
|
if (log++; echo_params; can_log); then indent; fi
|
603
|
builtin "$@"
|
604
|
}
|
605
|
|
606
|
cd() # indent is permanent within subshell cd was used in
|
607
|
{
|
608
|
log++ echo_func
|
609
|
cmd2rel_path; echo_cmd "$FUNCNAME" "$@"
|
610
|
if can_log; then caller_indent; fi
|
611
|
# -P: expand symlinks so $PWD matches the output of realpath
|
612
|
builtin "$FUNCNAME" -P "$@"
|
613
|
|
614
|
func=realpath clear_cache
|
615
|
set_paths
|
616
|
}
|
617
|
|
618
|
## external commands
|
619
|
|
620
|
disable_logging() { set_fds "$log_fd>/dev/null"; }
|
621
|
|
622
|
function redir() # usage: local redirs=(#<>...); redir cmd...; unset redirs
|
623
|
# to view only explicitly-displayed errors: explicit_errors_only=1 script...
|
624
|
{
|
625
|
echo_func; kw_params redirs
|
626
|
|
627
|
case "$1" in redir|command) "$@"; return;; esac # redir will be run later
|
628
|
(
|
629
|
log++ set_fds "${redirs[@]}"
|
630
|
(case "$1" in command__exec) shift;; esac; echo_redirs_cmd)
|
631
|
"$@"
|
632
|
) || return
|
633
|
}
|
634
|
alias redir='"redir" ' # last space alias-expands next word
|
635
|
|
636
|
alias_append save_e '; unset redirs' # don't redirect error handlers
|
637
|
|
638
|
command() # usage: [cmd_log_fd=|1|2|#] [verbosity_min=] command extern_cmd...
|
639
|
{
|
640
|
echo_func; kw_params cmd_log_fd redirs verbosity_min
|
641
|
# if no cmd_log_fd, limit log_fd in case command uses util.sh
|
642
|
local cmd_log_fd="${cmd_log_fd-$log_fd}"
|
643
|
local redirs=("${redirs[@]}")
|
644
|
|
645
|
# determine redirections
|
646
|
if test "$cmd_log_fd"; then
|
647
|
if can_log; then
|
648
|
if test "$cmd_log_fd" != "$log_fd"; then
|
649
|
redirs+=("$cmd_log_fd>&$log_fd")
|
650
|
fi # else no redir needed
|
651
|
else redirs+=("$cmd_log_fd>/dev/null");
|
652
|
fi
|
653
|
fi
|
654
|
|
655
|
cmd2rel_path
|
656
|
redir command__exec "$@" || die_e
|
657
|
}
|
658
|
command__exec()
|
659
|
{
|
660
|
ensure_nested_func
|
661
|
if can_log; then indent; fi
|
662
|
if test "$verbosity_min"; then verbosity_min "$verbosity_min"; fi
|
663
|
exec -- "$@" # -- so cmd name not treated as `exec` option
|
664
|
}
|
665
|
|
666
|
# auto-echo common external commands
|
667
|
for cmd in env rm; do alias "$cmd=command $cmd"; done; unset cmd
|
668
|
|
669
|
|
670
|
### external command input/output
|
671
|
|
672
|
echo_stdin() # usage: input|echo_stdin|cmd
|
673
|
{
|
674
|
if can_log; then
|
675
|
pipe_delay
|
676
|
echo ----- >&"$log_fd"
|
677
|
tee -a /dev/fd/"$log_fd";
|
678
|
echo ----- >&"$log_fd"
|
679
|
else cat
|
680
|
fi
|
681
|
}
|
682
|
|
683
|
echo_stdout() { echo_stdin; } # usage: cmd|echo_stdout
|
684
|
|
685
|
|
686
|
#### commands
|
687
|
|
688
|
already_exists_msg() # usage: cond || what=... already_exists_msg || return 0
|
689
|
{ type=info die "$what already exists, skipping"; }
|
690
|
|
691
|
require_not_exists() # usage: require_not_exists file || return 0
|
692
|
{ test ! -e "$1" || what="file \"$1\"" already_exists_msg; }
|
693
|
|
694
|
function to_file() # usage: stdout=... [if_not_exists=1] [del=] to_file cmd...
|
695
|
# auto-removes a command's output file on error (like make's .DELETE_ON_ERROR)
|
696
|
{
|
697
|
echo_func; kw_params stdout if_not_exists del
|
698
|
: "${stdout?}"; local del="${del-1}"
|
699
|
if test "$if_not_exists"; then require_not_exists "$stdout" || return 0; fi
|
700
|
|
701
|
local redirs=("${redirs[@]}" ">$stdout")
|
702
|
redir "$@" || { save_e; test ! "$del" || rm "$stdout"; rethrow; }
|
703
|
}
|
704
|
alias to_file='"to_file" ' # last space alias-expands next word
|
705
|
|
706
|
run_args_cmd() # runs the command line args command
|
707
|
{
|
708
|
eval set -- "$(reverse "${BASH_ARGV[@]}")"
|
709
|
test $# -ge 1 || set -- all
|
710
|
echo_cmd "$top_script" "$@"; "$@"
|
711
|
}
|
712
|
|
713
|
fwd() # usage: subdirs=(...); fwd "$FUNCNAME" "$@"
|
714
|
{
|
715
|
echo_func
|
716
|
: "${subdirs?}"
|
717
|
|
718
|
for subdir in "${subdirs[@]}"; do "$top_dir"/"$subdir"/run "$@"; done
|
719
|
}
|
720
|
|
721
|
|
722
|
#### filesystem
|
723
|
|
724
|
alias file_size=\
|
725
|
"stat `case "$(uname)" in Darwin) echo -f %z;; *) echo --format=%s;; esac`"
|
726
|
|
727
|
|
728
|
#### URLs
|
729
|
|
730
|
localize_url() { test _"$1" = _"$(hostname -f)" || echo "$1"; }
|
731
|
|
732
|
fi
|