1
|
#!/bin/bash -e
|
2
|
set -o errexit # in case caller did not have -e in #! line
|
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
|
include_guard_var() { realpath "$1"|builtin command sed 's/[^a-zA-Z0-9_]/_/g'; }
|
12
|
|
13
|
self_not_included() # usage: if self_not_included; then ... fi
|
14
|
{
|
15
|
test $# -ge 1 || set -- "${BASH_SOURCE[1]}"
|
16
|
local include_guard="$(include_guard_var "$1")"
|
17
|
alias self_being_included=false
|
18
|
! isset "$include_guard" && \
|
19
|
{ eval "$include_guard"=1; alias self_being_included=true; }
|
20
|
}
|
21
|
|
22
|
# to load newly-defined aliases for use in functions in the same file:
|
23
|
## fi # load new aliases
|
24
|
## if self_being_included; then
|
25
|
# this is needed because aliases defined inside an if statement are not
|
26
|
# available inside that if statement
|
27
|
|
28
|
fi
|
29
|
|
30
|
|
31
|
if self_not_included "${BASH_SOURCE[0]}"; then
|
32
|
|
33
|
|
34
|
#### options
|
35
|
|
36
|
shopt -s expand_aliases
|
37
|
|
38
|
|
39
|
#### aliases
|
40
|
|
41
|
unalias() { builtin unalias "$@" 2>&- || true; } # no error if undefined
|
42
|
|
43
|
# usage: alias alias_='var=value run_cmd '
|
44
|
function run_cmd() { "$@"; }
|
45
|
alias run_cmd='"run_cmd" ' # last space alias-expands next word
|
46
|
|
47
|
|
48
|
#### functions
|
49
|
|
50
|
alias self='command "$FUNCNAME"' # usage: wrapper() { self ...; }
|
51
|
|
52
|
|
53
|
#### exceptions
|
54
|
|
55
|
# usage: cmd || { save_e; ...; rethrow; }
|
56
|
alias export_e='e=$?'
|
57
|
alias save_e='declare e=$?'
|
58
|
alias rethrow='return "$e"'
|
59
|
alias rethrow_subshell='exit "$e"'
|
60
|
|
61
|
fi # load new aliases
|
62
|
if self_being_included; then
|
63
|
|
64
|
# usage: try cmd...; ignore status; if catch status; then ...; fi; end_try
|
65
|
|
66
|
function try() { e=0; "$@" || { export_e; true; }; }
|
67
|
alias try='declare e; "try" ' # last space alias-expands next word
|
68
|
|
69
|
catch() { test "$e" -eq "$1"; e=0; }
|
70
|
|
71
|
ignore() { catch "$@" || true; }
|
72
|
|
73
|
alias end_try='rethrow'
|
74
|
alias end_try_subshell='rethrow_subshell'
|
75
|
|
76
|
fi # load new aliases
|
77
|
if self_being_included; then
|
78
|
|
79
|
|
80
|
#### integers
|
81
|
|
82
|
let!() { let "$@" || true; } # always returns true; safe to use for setting
|
83
|
# "If the last ARG evaluates to 0, let returns 1" (`help let`)
|
84
|
|
85
|
bool2int() { try test ! "$1"; echo "$e"; } # empty->0; non-empty->1
|
86
|
|
87
|
|
88
|
#### strings
|
89
|
|
90
|
repeat() # usage: str=... n=... repeat
|
91
|
{
|
92
|
: "${str?}" "${n:?}"; local n="$n" # will be modified in function
|
93
|
for (( ; n > 0; n-- )); do printf '%q' "$str"; done
|
94
|
}
|
95
|
|
96
|
sed_ere_flag="$(test "$(uname)" = Darwin && echo E || echo r)"
|
97
|
|
98
|
sed() { self -"$sed_ere_flag" "$@";}
|
99
|
|
100
|
rtrim() { sed 's/[[:space:]]+$//' <<<"$1"; }
|
101
|
|
102
|
|
103
|
#### arrays
|
104
|
|
105
|
join() { local IFS="$delim"; echo "$*"; } # usage: delim=... join elems...
|
106
|
|
107
|
reverse() # usage: array=($(reverse args...))
|
108
|
{
|
109
|
local i
|
110
|
for (( i=$#; i > 0; i-- )); do printf '%q ' "${!i}"; done
|
111
|
}
|
112
|
|
113
|
contains() # usage: contains value in_array...
|
114
|
{
|
115
|
local value="$1"; shift
|
116
|
local elem
|
117
|
for elem in "$@"; do if test "$elem" = "$value"; then return 0; fi; done
|
118
|
return 1
|
119
|
}
|
120
|
|
121
|
|
122
|
#### paths
|
123
|
|
124
|
canon_rel_path()
|
125
|
{
|
126
|
local path="$1"
|
127
|
path="$(realpath "$path")" # canonicalize
|
128
|
path="${path#$(pwd -P)/}" # remove any shared prefix with the current dir
|
129
|
echo "$path"
|
130
|
}
|
131
|
|
132
|
# makes $1 a canon_rel_path if it's a filesystem path
|
133
|
alias cmd2rel_path="$(cat <<'EOF'
|
134
|
if test "$(type -t "$1")" = file && test -e "$1"; then # not relative to PATH
|
135
|
declare _1="$1"; shift
|
136
|
set -- "$(canon_rel_path "$_1")" "$@"
|
137
|
fi
|
138
|
EOF
|
139
|
)"
|
140
|
|
141
|
|
142
|
#### verbose output
|
143
|
|
144
|
|
145
|
# usage: (stdout2stderr; cmd...) || return
|
146
|
# `|| return` needed on Mac because of bug where -e doesn't apply to ()
|
147
|
stdout2stderr() { exec >&2; }
|
148
|
|
149
|
usage() { echo "Usage: $1" >&2; return 2; }
|
150
|
|
151
|
|
152
|
### logging
|
153
|
|
154
|
if test "$explicit_errors_only"; then verbosity=0; fi # hide startup logging
|
155
|
|
156
|
# set verbosity
|
157
|
if isset verbose; then : "${verbosity:=$(bool2int "$verbose")}"; fi
|
158
|
if isset vb; then : "${verbosity:=$vb}"; fi
|
159
|
: "${verbosity=3}" # default
|
160
|
: "${verbosity:=0}" # ensure non-empty
|
161
|
export verbosity # propagate to invoked commands
|
162
|
|
163
|
: "${log_level_indent= }" "${log_indent=}"
|
164
|
export log_level_indent log_indent # propagate to invoked commands
|
165
|
alias indent='declare log_indent="$log_indent$log_level_indent"'
|
166
|
|
167
|
# usage: in func: PS4++; ...
|
168
|
# outside func: PS4++; ...; PS4--
|
169
|
alias PS4++='declare PS4="${PS4:0:1}$PS4"'
|
170
|
alias PS4--='declare PS4="${PS4#${PS4:0:1}}"'
|
171
|
|
172
|
# usage: in func: log++; ...
|
173
|
# outside func: log++; ...; log--
|
174
|
alias log++='{ PS4++; declare verbosity="$verbosity"; let! verbosity--; }'
|
175
|
alias log--='{ PS4--; declare verbosity="$verbosity"; let! verbosity++; }'
|
176
|
|
177
|
fi # load new aliases
|
178
|
if self_being_included; then
|
179
|
|
180
|
can_log() { test "$verbosity" -gt 0; } # verbosity=0 turns off all logging
|
181
|
|
182
|
log() { if can_log; then echo "$log_indent$PS4$1" >&2; fi; }
|
183
|
|
184
|
# usage: symbol=... log_custom msg
|
185
|
log_custom() { local PS4="${PS4%[^ ] }$symbol "; log "$@"; }
|
186
|
|
187
|
log_err() { symbol=! verbosity=1 log_custom "$@" 2>&22; } #ensure errors visible
|
188
|
|
189
|
log_info() { symbol=? log_custom "$@"; }
|
190
|
|
191
|
# usage: cmd || { save_e; log_e; ...; rethrow; }
|
192
|
log_e() { log_err "command exited with error $e"; }
|
193
|
|
194
|
# usage: cmd || [type=...] die msg
|
195
|
die() { save_e; "log_${type:-err}" "$1"; rethrow; }
|
196
|
|
197
|
|
198
|
### command verbose output
|
199
|
|
200
|
# usage: ([stdout2stderr=1] limit_stderr; cmd...) || return
|
201
|
# `|| return` needed on Mac because of bug where -e doesn't apply to ()
|
202
|
function limit_stderr()
|
203
|
{
|
204
|
log++ # should only apply during this function for use by can_log
|
205
|
if test "$stdout2stderr"; then
|
206
|
local stderr_is_errors="${stderr_is_errors-1}"
|
207
|
if ! can_log; then exec 1>/dev/null; else stdout2stderr; fi
|
208
|
else
|
209
|
if ! can_log; then exec 2>/dev/null; fi
|
210
|
fi
|
211
|
}
|
212
|
|
213
|
|
214
|
### command echoing
|
215
|
|
216
|
alias echo_params='log "$*"'
|
217
|
|
218
|
fi # load new aliases
|
219
|
if self_being_included; then
|
220
|
|
221
|
echo_cmd()
|
222
|
{
|
223
|
case "$1" in builtin|command) shift;; esac
|
224
|
echo_params
|
225
|
}
|
226
|
|
227
|
alias echo_run_prep='{ cmd2rel_path; echo_cmd "$@"; indent; }'
|
228
|
|
229
|
fi # load new aliases
|
230
|
if self_being_included; then
|
231
|
|
232
|
## internal commands
|
233
|
|
234
|
.()
|
235
|
{
|
236
|
cmd2rel_path; set -- . "$@"; (log++; echo_params); indent
|
237
|
builtin "$@"
|
238
|
}
|
239
|
|
240
|
echo_eval() { echo_params; builtin eval "$@"; }
|
241
|
|
242
|
## external commands
|
243
|
|
244
|
function command()
|
245
|
# usage: [stdout2stderr=1] [stderr_is_errors=1] [limit_stderr=1] command \
|
246
|
# extern_cmd...
|
247
|
# to view only explicitly-displayed errors: explicit_errors_only=1 script...
|
248
|
{
|
249
|
test "$cmd_echoed" || echo_run_prep
|
250
|
(
|
251
|
if test "$limit_stderr"; then limit_stderr; fi
|
252
|
if test "$stderr_is_errors"; then exec 2>&22; fi # ensure errors visible
|
253
|
builtin command -- "$@" # -- so cmd name not treated as `command` option
|
254
|
) || return
|
255
|
}
|
256
|
|
257
|
# auto-echo common external commands
|
258
|
for cmd in env rm; do alias "$cmd=command $cmd"; done; unset cmd
|
259
|
|
260
|
## functions
|
261
|
|
262
|
# usage: func() { [minor=1] echo_func; ... }
|
263
|
function echo_func() # usage: [minor=1] "echo_func" "$@" && indent || true
|
264
|
# exit status: whether function call was echoed
|
265
|
{
|
266
|
log++; if test "$minor"; then log++; fi
|
267
|
local script="$(canon_rel_path "${BASH_SOURCE[1]}")"
|
268
|
echo_cmd "$script:${BASH_LINENO[0]}" "${FUNCNAME[1]}" "$@"
|
269
|
can_log
|
270
|
}
|
271
|
alias echo_func='"echo_func" "$@" && indent || true'
|
272
|
|
273
|
## vars
|
274
|
|
275
|
echo_vars() # usage: echo_vars var...
|
276
|
{
|
277
|
log++; log++
|
278
|
if can_log; then
|
279
|
local var
|
280
|
for var in "${@%%=*}"; do log "$(declare -p "$var")"; done
|
281
|
fi
|
282
|
}
|
283
|
|
284
|
echo_export() { builtin export "$@"; echo_vars "$@"; }
|
285
|
|
286
|
if test "$verbosity" -ge 2; then
|
287
|
alias export="echo_export" # automatically echo env vars when they are set
|
288
|
fi
|
289
|
|
290
|
|
291
|
### external command input/output
|
292
|
|
293
|
# usage: cmd1 | { pipe_delay; cmd2; }
|
294
|
alias pipe_delay='sleep 0.1' # s; display after leading output of cmd1
|
295
|
|
296
|
fi # load new aliases
|
297
|
if self_being_included; then
|
298
|
|
299
|
echo_stdin() # usage: input|echo_stdin|cmd
|
300
|
{
|
301
|
log++
|
302
|
if can_log; then
|
303
|
pipe_delay
|
304
|
echo ----- >&2
|
305
|
tee -a /dev/stderr;
|
306
|
echo ----- >&2
|
307
|
else cat
|
308
|
fi
|
309
|
}
|
310
|
|
311
|
alias echo_stdout='echo_stdin' # usage: cmd|echo_stdout
|
312
|
|
313
|
fi # load new aliases
|
314
|
if self_being_included; then
|
315
|
|
316
|
|
317
|
#### streams
|
318
|
|
319
|
fd_exists() { (: <&"$1") 2>/dev/null; }
|
320
|
|
321
|
require_fd_not_exists() # usage: require_fd_not_exists fd || return 0
|
322
|
{ ! fd_exists "$1" || type=info die "fd $1 already exists, skipping"; }
|
323
|
|
324
|
set_fd() # usage: dest=fd dir='[<>]' src=fd [noclobber=1] set_fd
|
325
|
{
|
326
|
log++; echo_func
|
327
|
: "${dest:?}" "${dir:?}" "${src:?}"
|
328
|
test ! "$noclobber" || require_fd_not_exists "$dest" || return 0
|
329
|
echo_eval exec "$dest$dir&$src"
|
330
|
}
|
331
|
|
332
|
shadow_fd() # usage: prefix=# src=fd dir='[<>]' shadow_fd
|
333
|
{
|
334
|
minor=1 echo_func
|
335
|
: "${prefix:?}" "${src:?}" "${dir:?}"
|
336
|
dest="$prefix$src" noclobber=1 set_fd
|
337
|
}
|
338
|
|
339
|
# convention: use fd 10/11/12 for command-specific alternate stdin/stdout/stderr
|
340
|
|
341
|
set_global_fds()
|
342
|
# allows commands to access global stdin/stdout/stderr using fd 20/21/22
|
343
|
# this works even when /dev/tty isn't available
|
344
|
{
|
345
|
log++; echo_func
|
346
|
local prefix=2
|
347
|
# ignore errors if a source fd isn't open
|
348
|
src=0 dir='<' shadow_fd || true
|
349
|
src=1 dir='>' shadow_fd || true
|
350
|
src=2 dir='>' shadow_fd || true
|
351
|
}
|
352
|
set_global_fds
|
353
|
|
354
|
# usage: explicit_errors_only=1 script...
|
355
|
# show only explicitly-displayed errors (which have been redirected to fd 22)
|
356
|
# most of the time this has the same effect as `verbosity=0 script...`,
|
357
|
# which displays everything that isn't explicitly hidden
|
358
|
# this option should only be used for testing the explicit error displaying
|
359
|
if test "$explicit_errors_only"; then exec 2>/dev/null; fi
|
360
|
|
361
|
|
362
|
#### vars
|
363
|
|
364
|
set_var() { eval "$1"'="$2"'; }
|
365
|
|
366
|
set_inv() { set_var no_"$1" "$(test "${!1}" || echo 1)"; }
|
367
|
|
368
|
# usage: local var=...; local_inv
|
369
|
alias local_inv='declare "no_$var=$(test "${!var}" || echo 1)"'
|
370
|
|
371
|
get_prefix_vars() { : "${prefix:?}"; eval echo '${!'$prefix'*}'; }
|
372
|
|
373
|
# usage: local prefix=..._; import_vars
|
374
|
# when used inside another alias 2+ levels deep, *must* be run inside a function
|
375
|
alias import_vars="$(cat <<'EOF'
|
376
|
: "${prefix:?}"
|
377
|
declare src_var dest_var
|
378
|
for src_var in $(get_prefix_vars); do
|
379
|
dest_var="${src_var#$prefix}"
|
380
|
declare "$dest_var=${!src_var}"; echo_vars "$dest_var"
|
381
|
done
|
382
|
EOF
|
383
|
)"
|
384
|
|
385
|
|
386
|
#### functions
|
387
|
|
388
|
func_exists() { declare -f "$1" >/dev/null; }
|
389
|
|
390
|
copy_func() # usage: from=... to=... copy_func
|
391
|
# $to must not exist. to get around the no-clobber restriction, use `unset -f`.
|
392
|
{
|
393
|
: "${from:?}" "${to:?}"
|
394
|
func_exists "$from" || die "function does not exist: $from"
|
395
|
! func_exists "$to" || die "function already exists: $to"
|
396
|
local from_def="$(declare -f "$from")"
|
397
|
eval "$to${from_def#$from}"
|
398
|
}
|
399
|
|
400
|
func_override() # usage: func_override old_name__suffix
|
401
|
{ from="${1%%__*}" to="$1" copy_func; }
|
402
|
|
403
|
ensure_nested_func() # usage: func__nested_func() { ensure_nested_func; ... }
|
404
|
{
|
405
|
local nested_func="${FUNCNAME[1]}"
|
406
|
local func="${nested_func%%__*}"
|
407
|
contains "$func" "${FUNCNAME[@]}" || \
|
408
|
die "$nested_func() must be used by $func()"
|
409
|
}
|
410
|
|
411
|
|
412
|
#### commands
|
413
|
|
414
|
top_script="$(canon_rel_path "$0")" # outermost script
|
415
|
top_dir="$(dirname "$top_script")"
|
416
|
|
417
|
require_not_exists() # usage: require_not_exists file || return 0
|
418
|
{ test ! -e "$1" || type=info die "file "$1" already exists, skipping"; }
|
419
|
|
420
|
# auto-removes a command's output file on error (like make's .DELETE_ON_ERROR)
|
421
|
function to_file() # usage: stdout=... [if_not_exists=1] to_file cmd...
|
422
|
{
|
423
|
echo_func
|
424
|
: "${stdout?}"; echo_vars stdout
|
425
|
test ! "$if_not_exists" || require_not_exists "$stdout" || return 0
|
426
|
"$@" >"$stdout" || { save_e; log_e; rm "$stdout"; rethrow; }
|
427
|
}
|
428
|
alias to_file='"to_file" ' # last space alias-expands next word
|
429
|
|
430
|
run_args_cmd() # runs the command line args command
|
431
|
{
|
432
|
test $? -eq 0 || return
|
433
|
eval set -- "$(reverse "${BASH_ARGV[@]}")"
|
434
|
test $# -ge 1 || set -- all
|
435
|
echo_cmd "$top_script" "$@"; "$@"
|
436
|
}
|
437
|
|
438
|
fwd() # usage: subdirs=(...); fwd "$FUNCNAME" "$@"
|
439
|
{
|
440
|
echo_func
|
441
|
: "${subdirs?}"
|
442
|
|
443
|
for subdir in "${subdirs[@]}"; do
|
444
|
"$(dirname "${BASH_SOURCE[1]}")"/"$subdir"/run "$@"
|
445
|
done
|
446
|
}
|
447
|
|
448
|
|
449
|
#### URLs
|
450
|
|
451
|
localize_url() { test _"$1" = _"$(hostname -f)" || echo "$1"; }
|
452
|
|
453
|
fi
|