Project

General

Profile

1 8291 aaronmk
#!/bin/bash -e
2 9328 aaronmk
set -o errexit -o pipefail # errexit in case caller's #! line missing -e
3 8952 aaronmk
4 9018 aaronmk
if test ! "$_util_sh_include_guard_utils"; then
5
_util_sh_include_guard_utils=1
6
7 9074 aaronmk
isset() { test "${!1+isset}"; }
8 9002 aaronmk
9 9074 aaronmk
realpath() { readlink -f -- "$1"; }
10 8703 aaronmk
11 9314 aaronmk
str2varname() { echo "${1//[^a-zA-Z0-9_]/_}"; }
12 8716 aaronmk
13 9312 aaronmk
include_guard_var() { str2varname "$(realpath "$1")"; }
14
15 9074 aaronmk
self_not_included() # usage: if self_not_included; then ... fi
16 8703 aaronmk
{
17 8971 aaronmk
	test $# -ge 1 || set -- "${BASH_SOURCE[1]}"
18 8703 aaronmk
	local include_guard="$(include_guard_var "$1")"
19 8793 aaronmk
	alias self_being_included=false
20 9003 aaronmk
	! isset "$include_guard" && \
21 8793 aaronmk
	{ eval "$include_guard"=1; alias self_being_included=true; }
22 8703 aaronmk
}
23
24 8793 aaronmk
# to load newly-defined aliases for use in functions in the same file:
25
## fi # load new aliases
26
## if self_being_included; then
27
# this is needed because aliases defined inside an if statement are not
28
# available inside that if statement
29
30 9018 aaronmk
fi
31 9017 aaronmk
32 9018 aaronmk
33 8704 aaronmk
if self_not_included "${BASH_SOURCE[0]}"; then
34
35 9017 aaronmk
36
#### options
37
38 8709 aaronmk
shopt -s expand_aliases
39
40 9017 aaronmk
41 9226 aaronmk
#### vars
42
43
set_var() { eval "$1"'="$2"'; }
44
45 9420 aaronmk
set_default() { if ! isset "$1"; then set_var "$@"; fi; }
46
47 9226 aaronmk
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 9227 aaronmk
unexport() { export -n "$@"; }
53
	# `declare +x` won't work because it defines the var if it isn't set
54
55 9236 aaronmk
alias local_export='declare -x' # combines effects of local and export
56
57 9226 aaronmk
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 9311 aaronmk
#### caching
73
74
## shell-variable-based caching
75
76 9330 aaronmk
# usage: local cache_key=...; load_cache; \
77 9331 aaronmk
# if ! cached; then save_cache value || return; fi; echo_cached_value
78 9311 aaronmk
# 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 9017 aaronmk
#### aliases
92
93 9074 aaronmk
unalias() { builtin unalias "$@" 2>&- || true; } # no error if undefined
94 8889 aaronmk
95 9191 aaronmk
# usage: alias alias_='var=value run_cmd '
96
function run_cmd() { "$@"; }
97
alias run_cmd='"run_cmd" ' # last space alias-expands next word
98 9017 aaronmk
99 9191 aaronmk
100 9082 aaronmk
#### functions
101
102 9235 aaronmk
kw_params() # usage: func() { kw_params param_var...; }; ...; param_var=... cmd
103 9229 aaronmk
# removes keyword-param-only vars from the environment
104
{ unexport "$@"; }
105 9228 aaronmk
106 9082 aaronmk
alias self='command "$FUNCNAME"' # usage: wrapper() { self ...; }
107
108
109 8886 aaronmk
#### exceptions
110
111 9032 aaronmk
# usage: cmd || { save_e; ...; rethrow; }
112 9031 aaronmk
alias export_e='e=$?'
113 9032 aaronmk
alias save_e='declare e=$?'
114 8976 aaronmk
alias rethrow='return "$e"'
115
alias rethrow_subshell='exit "$e"'
116
117 8978 aaronmk
fi # load new aliases
118
if self_being_included; then
119
120 8886 aaronmk
# usage: try cmd...; ignore status; if catch status; then ...; fi; end_try
121
122 9074 aaronmk
function try() { e=0; "$@" || { export_e; true; }; }
123 9177 aaronmk
alias try='declare e; "try" ' # last space alias-expands next word
124 8886 aaronmk
125 9074 aaronmk
catch() { test "$e" -eq "$1"; e=0; }
126 8886 aaronmk
127 9074 aaronmk
ignore() { catch "$@" || true; }
128 8886 aaronmk
129 8977 aaronmk
alias end_try='rethrow'
130
alias end_try_subshell='rethrow_subshell'
131 8886 aaronmk
132 9020 aaronmk
fi # load new aliases
133
if self_being_included; then
134 9017 aaronmk
135 9020 aaronmk
136 8899 aaronmk
#### integers
137
138 9074 aaronmk
let!() { let "$@" || true; } # always returns true; safe to use for setting
139 8899 aaronmk
	# "If the last ARG evaluates to 0, let returns 1" (`help let`)
140
141 9074 aaronmk
bool2int() { try test ! "$1"; echo "$e"; } # empty->0; non-empty->1
142 9004 aaronmk
143 9017 aaronmk
144 9364 aaronmk
#### 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
155 9079 aaronmk
#### strings
156
157 9081 aaronmk
repeat() # usage: str=... n=... repeat
158
{
159 9304 aaronmk
	: "${str?}" "${n:?}"; local result= n="$n" # n will be modified in function
160
	for (( ; n > 0; n-- )); do result="$result$str"; done
161
	echo "$result"
162 9081 aaronmk
}
163
164 9366 aaronmk
sed_cmd="command sed -$(test "$(uname)" = Darwin && echo E || echo r)"
165
alias sed="$sed_cmd"
166 9079 aaronmk
167 9366 aaronmk
fi # load new aliases
168
if self_being_included; then
169 9079 aaronmk
170 9425 aaronmk
rtrim() { log+ 3; sed 's/[[:space:]]+$//' <<<"$1"; }
171 9079 aaronmk
172 9085 aaronmk
173 8854 aaronmk
#### arrays
174 8694 aaronmk
175 9074 aaronmk
join() { local IFS="$delim"; echo "$*"; } # usage: delim=... join elems...
176 8816 aaronmk
177 9074 aaronmk
reverse() # usage: array=($(reverse args...))
178 8691 aaronmk
{
179
	local i
180 9080 aaronmk
	for (( i=$#; i > 0; i-- )); do printf '%q ' "${!i}"; done
181 8691 aaronmk
}
182
183 9097 aaronmk
contains() # usage: contains value in_array...
184
{
185
	local value="$1"; shift
186
	local elem
187
	for elem in "$@"; do if test "$elem" = "$value"; then return 0; fi; done
188
	return 1
189
}
190 9017 aaronmk
191 9097 aaronmk
192 8854 aaronmk
#### verbose output
193
194 9110 aaronmk
195 9208 aaronmk
err_fd=2 # stderr
196
197 9111 aaronmk
usage() { echo "Usage: $1" >&2; return 2; }
198 9110 aaronmk
199
200
### logging
201
202 9361 aaronmk
log_fd=2 # initially stderr
203 9209 aaronmk
204 9142 aaronmk
if test "$explicit_errors_only"; then verbosity=0; fi # hide startup logging
205
206 9006 aaronmk
# set verbosity
207 9005 aaronmk
if isset verbose; then : "${verbosity:=$(bool2int "$verbose")}"; fi
208 9145 aaronmk
if isset vb; then : "${verbosity:=$vb}"; fi
209 9272 aaronmk
: "${verbosity=1}" # default
210 9006 aaronmk
: "${verbosity:=0}" # ensure non-empty
211 9119 aaronmk
export verbosity # propagate to invoked commands
212 9381 aaronmk
export PS4 # follows verbosity, so also propagate this
213 8710 aaronmk
214 9396 aaronmk
verbosity_int() { round_down "$verbosity"; }
215
216 9359 aaronmk
# verbosities:
217
# 0: just print errors. useful for cron jobs.
218
# 1: also external commands run. useful for running at the command line.
219
# 2: full graphical call tree. useful for determining where error occurred.
220 9360 aaronmk
# 3: also values of kw params and variables. useful for low-level debugging.
221 9359 aaronmk
# 4: also variables in util.sh commands. useful for debugging util.sh.
222
# 5: also variables in logging commands themselves. useful for debugging echo_*.
223
# 6+: not currently used (i.e. same as 5)
224
225 9287 aaronmk
# definition: the log_level is the minimum verbosity needed to display a message
226
# for messages that use can_log(), the log_level starts with *1*, not 0
227
# for unfiltered messages, the log_level is 0 (i.e. still output at verbosity=0)
228 9288 aaronmk
# to view a message's log_level, count the # of + signs before it in the output
229 9284 aaronmk
230 9305 aaronmk
fi # load new aliases
231
if self_being_included; then
232
233 9299 aaronmk
# usage: in func:      log++; ...         OR  log_local; "log++"; ...
234 9176 aaronmk
#        outside func: log++; ...; log--
235 9301 aaronmk
#        before cmd:   log++ cmd...
236 9302 aaronmk
# without a cmd, "$@" expands to nothing and assignments are applied to caller
237 9305 aaronmk
# "${@:2}" expands to all of $@ after *1st* arg, not 2nd ($@ indexes start at 1)
238 9373 aaronmk
log+()
239
{
240
	# no local vars because w/o cmd, assignments should be applied to caller
241 9378 aaronmk
	PS4="$(if test "$1" -gt 0; then echo "$(str="${PS4:0:1}" n="$1" repeat)$PS4"
242 9375 aaronmk
		else echo "${PS4: -$1}"; fi)" \
243 9377 aaronmk
	verbosity="$(float+int "$verbosity" "-$1")" "${@:2}"
244 9373 aaronmk
}
245 9374 aaronmk
log++() { log+  1 "$@"; }
246
log--() { log+ -1 "$@"; }
247 9300 aaronmk
alias log_local='declare PS4="$PS4" verbosity="$verbosity"'
248 9395 aaronmk
alias log+='log_local; "log+"' # don't expand next word because it's not a cmd
249 9301 aaronmk
alias log++='log_local; "log++" ' # last space alias-expands next word
250
alias log--='log_local; "log--" ' # last space alias-expands next word
251 9176 aaronmk
252 9397 aaronmk
verbosity_min() # usage: verbosity_min min
253
{ if test "$(verbosity_int)" -lt "$1"; then verbosity="$1"; fi; }
254
alias verbosity_min='log_local; "verbosity_min"'
255 9289 aaronmk
256 9397 aaronmk
257 9289 aaronmk
# indent for call tree. this is *not* the log_level (below).
258 9382 aaronmk
: "${log_indent_step=| }" "${log_indent=}"
259
export log_indent_step log_indent # propagate to invoked commands
260 9289 aaronmk
261 9382 aaronmk
__caller_indent='log_indent="$log_indent$log_indent_step"'
262 9289 aaronmk
alias caller_indent="$__caller_indent"
263
alias indent="declare $__caller_indent"
264
265
266 9190 aaronmk
fi # load new aliases
267
if self_being_included; then
268
269 9396 aaronmk
can_log() { test "$(verbosity_int)" -gt 0; }
270 9380 aaronmk
	# verbosity=0 turns off all logging
271 8895 aaronmk
272 9212 aaronmk
log() { if can_log; then echo "$log_indent$PS4$1" >&"$log_fd"; fi; }
273 9064 aaronmk
274 9270 aaronmk
log_custom() # usage: symbol=... log_custom msg
275 9242 aaronmk
{ log_indent="${log_indent//[^ ]/$symbol}" PS4="${PS4//[^ ]/$symbol}" log "$@";}
276 9070 aaronmk
277 9251 aaronmk
log_err() { symbol='#' verbosity=1 log_fd="$err_fd" log_custom "$@"; }
278 9070 aaronmk
279 9250 aaronmk
log_info() { symbol=: log_custom "$@"; }
280 9070 aaronmk
281 9270 aaronmk
log_e() # usage: cmd || { save_e; log_e; ...; rethrow; }
282
{ log_err "command exited with error $e"; }
283 9067 aaronmk
284 9270 aaronmk
die() # usage: cmd || [type=...] die msg
285
{ save_e; kw_params type; "log_${type:-err}" "$1"; rethrow; }
286 9069 aaronmk
287 8919 aaronmk
288 9233 aaronmk
#### functions
289
290
func_exists() { declare -f "$1" >/dev/null; }
291
292
copy_func() # usage: from=... to=... copy_func
293
# $to must not exist. to get around the no-clobber restriction, use `unset -f`.
294
{
295
	: "${from:?}" "${to:?}"
296
	func_exists "$from" || die "function does not exist: $from"
297
	! func_exists "$to" || die "function already exists: $to"
298
	local from_def="$(declare -f "$from")"
299
	eval "$to${from_def#$from}"
300
}
301
302
func_override() # usage: func_override old_name__suffix
303
{ from="${1%%__*}" to="$1" copy_func; }
304
305
ensure_nested_func() # usage: func__nested_func() { ensure_nested_func; ... }
306
{
307
	local nested_func="${FUNCNAME[1]}"
308
	local func="${nested_func%%__*}"
309
	contains "$func" "${FUNCNAME[@]}" || \
310
		die "$nested_func() must be used by $func()"
311
}
312
313
314 9240 aaronmk
#### paths
315
316 9313 aaronmk
# cache realpath
317
: "${realpath_cache=}" # default off because slower than without
318
if test "$realpath_cache"; then
319
func_override realpath__no_cache
320
realpath() # caches the last result for efficiency
321
{
322
	local cache_key="$*"; load_cache
323 9331 aaronmk
	if ! cached; then save_cache "$(realpath__no_cache "$@")" || return; fi
324 9313 aaronmk
	echo_cached_value
325
}
326
fi
327
328 9244 aaronmk
rel_path() # usage: base_dir=... path=... rel_path
329 9240 aaronmk
{
330 9244 aaronmk
	log++; kw_params base_dir path
331
	: "${base_dir:?}" "${path:?}"
332
333 9246 aaronmk
	local path="$path/" # add *extra* / to match path when exactly = base_dir
334
	path="${path#$base_dir/}" # remove prefix shared with base_dir
335
	path="${path%/}" # remove any remaining extra trailing /
336 9244 aaronmk
337 9245 aaronmk
	if test ! "$path"; then path=.; fi # ensure non-empty
338
339 9244 aaronmk
	echo_vars path
340 9240 aaronmk
	echo "$path"
341
}
342
343 9309 aaronmk
cd -P . # expand symlinks in $PWD so it matches the output of realpath
344
# do before setting $top_script_abs so realpath has less symlinks to resolve
345
346 9331 aaronmk
canon_rel_path()
347
{
348
	local path; path="$(realpath "$1")" || return
349
	base_dir="$PWD" rel_path
350
}
351 9244 aaronmk
352 9240 aaronmk
# makes $1 a canon_rel_path if it's a filesystem path
353
alias cmd2rel_path="$(cat <<'EOF'
354
if test "$(type -t "$1")" = file && test -e "$1"; then # not relative to PATH
355
	declare _1="$1"; shift
356 9331 aaronmk
	_1="$(canon_rel_path "$_1")" || return
357
	set -- "$_1" "$@"
358 9240 aaronmk
fi
359
EOF
360
)"
361
362
363
#### verbose output
364
365
366 9165 aaronmk
### command echoing
367
368
alias echo_params='log "$*"'
369
370 8995 aaronmk
fi # load new aliases
371
if self_being_included; then
372
373 9197 aaronmk
echo_cmd() { echo_params; }
374 9056 aaronmk
375 9278 aaronmk
echo_eval() { echo_params; builtin eval "$@"; }
376
377 9263 aaronmk
## vars
378
379
echo_vars() # usage: echo_vars var...
380
{
381 9320 aaronmk
	log+ 2
382 9263 aaronmk
	if can_log; then
383
		local var
384
		for var in "${@%%=*}"; do
385
			if isset "$var"; then log "$(declare -p "$var")"; fi
386
		done
387
	fi
388
}
389
390
echo_export() { builtin export "$@"; echo_vars "$@"; }
391
392 9379 aaronmk
alias export="echo_export" # automatically echo env vars when they are set
393 9263 aaronmk
394
func_override kw_params__lang
395
kw_params() { kw_params__lang "$@"; echo_vars "$@"; } # echo all keyword params
396
397 9273 aaronmk
## functions
398 9264 aaronmk
399 9315 aaronmk
# usage: local func=...; set_func_loc; use $file, $line
400
alias set_func_loc="$(cat <<'EOF'
401
: "${func:?}"
402
local func_info="$(shopt -s extdebug; declare -F "$func")" # 'func line file'
403
func_info="${func_info#$func }"
404
local line="${func_info%% *}"
405
local file="${func_info#$line }"
406
EOF
407
)"
408
409
fi # load new aliases
410
if self_being_included; then
411
412
func_loc() # gets where function declared in the format file:line
413 9331 aaronmk
{
414
	local func="$1"; set_func_loc
415
	file="$(canon_rel_path "$file")" || return
416
	echo "$file:$line"
417
}
418 9315 aaronmk
419 9273 aaronmk
# usage: func() { [minor=1] echo_func; ... }
420 9317 aaronmk
function echo_func()
421
# usage: [minor=1] "echo_func" "$FUNCNAME" "$@" && indent || true
422 9273 aaronmk
# exit status: whether function call was echoed
423
{
424
	kw_params minor
425 9317 aaronmk
	local func="$1"; shift
426 9273 aaronmk
427
	log++; if test "$minor"; then log++; fi
428 9331 aaronmk
	local loc; loc="$(func_loc "$func")" || return
429
	echo_cmd "$loc" "$func" "$@"
430 9273 aaronmk
	can_log
431
}
432 9317 aaronmk
alias echo_func='"echo_func" "$FUNCNAME" "$@" && indent || true'
433 9273 aaronmk
434 9276 aaronmk
fi # load new aliases
435
if self_being_included; then
436 9273 aaronmk
437 9276 aaronmk
438 9279 aaronmk
#### streams
439
440
fd_exists() { (: <&"$1") 2>/dev/null; }
441
442
require_fd_not_exists() # usage: require_fd_not_exists fd || return 0
443
{ ! fd_exists "$1" || type=info die "fd $1 already exists, skipping"; }
444
445
set_fds() { echo_func; echo_eval exec "$@"; } # usage: set_fds redirect...
446
447
fd_set_default() # usage: fd_set_default 'dest[<>]src'
448
{
449
	echo_func
450
	local dest="${1%%[<>]*}"
451
	require_fd_not_exists "$dest" || return 0
452
	set_fds "$1"
453
}
454
455
# convention: use fd 10/11/12 for command-specific alternate stdin/stdout/stderr
456
457 9282 aaronmk
setup_log_fd() # view logging output at verbosity >= 5
458
{
459 9319 aaronmk
	log+ 4; log-- echo_func
460 9282 aaronmk
	fd_set_default '30>&2' || true # stdlog
461
	log_fd=30 # stdlog
462
}
463
setup_log_fd
464
465 9279 aaronmk
set_global_fds()
466
# allows commands to access global stdin/stdout/stderr using fd 20/21/22
467
# this works even when /dev/tty isn't available
468 9283 aaronmk
# view logging output at verbosity >= 3
469 9279 aaronmk
{
470 9319 aaronmk
	log+ 2; log-- echo_func
471 9279 aaronmk
	# ignore errors if a source fd isn't open
472
	fd_set_default '20<&0' || true
473
	fd_set_default '21>&1' || true
474
	fd_set_default '22>&2' || true
475
}
476
set_global_fds
477
err_fd=22 # global stderr
478
479
# usage: explicit_errors_only=1 script...
480
# show only explicitly-displayed errors (which have been redirected to fd 22)
481
# most of the time this has the same effect as `verbosity=0 script...`,
482
# which displays everything that isn't explicitly hidden
483
# this option should only be used for testing the explicit error displaying
484
if test "$explicit_errors_only"; then disable_logging; fi
485
486
487 9264 aaronmk
#### paths
488
489 9269 aaronmk
top_script_abs="$(realpath "$0")"; echo_vars top_script_abs # outermost script
490
	# realpath this before doing any cd so this points to the right place
491
492 9265 aaronmk
set_paths()
493
{
494 9331 aaronmk
	top_script="$(canon_rel_path "$top_script_abs")" || return
495
		echo_vars top_script
496
	top_dir="$(dirname "$top_script")" || return; echo_vars top_dir
497 9265 aaronmk
}
498
set_paths
499 9264 aaronmk
500
501
#### verbose output
502
503
504 9123 aaronmk
## internal commands
505
506 9166 aaronmk
.()
507
{
508 9275 aaronmk
	cmd2rel_path; set -- "$FUNCNAME" "$@"
509 9274 aaronmk
	(log++; echo_params; can_log) && indent || true
510 9166 aaronmk
	builtin "$@"
511
}
512 9158 aaronmk
513 9253 aaronmk
cd() # indent is permanent within subshell cd was used in
514
{
515 9393 aaronmk
	log++ echo_func
516 9306 aaronmk
	cmd2rel_path; echo_cmd "$FUNCNAME" "$@"
517 9253 aaronmk
	can_log && caller_indent || true
518 9307 aaronmk
	# -P: expand symlinks so $PWD matches the output of realpath
519 9306 aaronmk
	builtin "$FUNCNAME" -P "$@"
520 9313 aaronmk
521
	func=realpath clear_cache
522 9266 aaronmk
	set_paths
523 9253 aaronmk
}
524
525 9110 aaronmk
## external commands
526
527 9262 aaronmk
disable_logging() { set_fds "$log_fd>/dev/null"; }
528 9224 aaronmk
529 9407 aaronmk
function command()
530
# usage: [cmd_log_fd=|1|2|#] [verbosity_min=] command extern_cmd...
531 9138 aaronmk
# to view only explicitly-displayed errors: explicit_errors_only=1 script...
532 9134 aaronmk
{
533 9407 aaronmk
	kw_params cmd_log_fd verbosity_min
534 9291 aaronmk
	# if no cmd_log_fd, limit log_fd in case command uses util.sh
535
	local cmd_log_fd="${cmd_log_fd-$log_fd}"
536 9231 aaronmk
537 9202 aaronmk
	cmd2rel_path; (echo_params; can_log) && indent || true
538 9192 aaronmk
	(
539 9200 aaronmk
		# the following redirections must happen in exactly this order
540 9292 aaronmk
		if test "$cmd_log_fd"; then command__set_fds; fi
541 9214 aaronmk
		if test "$cmd_log_fd" != 2; then # fd 2 not used for logging
542
			exec 2>&"$err_fd" # assume fd 2 used for errors
543
		fi
544 9200 aaronmk
545 9407 aaronmk
		if test "$verbosity_min"; then verbosity_min "$verbosity_min"; fi
546
547 9203 aaronmk
		exec -- "$@" # -- so cmd name not treated as `exec` option
548 9192 aaronmk
	) || return
549 9134 aaronmk
}
550 9292 aaronmk
function command__set_fds()
551
{
552
	ensure_nested_func
553 9296 aaronmk
	if can_log; then
554
		if test "$cmd_log_fd" = "$log_fd"; then return 0; fi # no redir needed
555
		local src="&$log_fd"
556
	else local src=/dev/null
557
	fi
558 9358 aaronmk
	log++ set_fds "$cmd_log_fd>$src"
559 9292 aaronmk
}
560 9133 aaronmk
561 9160 aaronmk
# auto-echo common external commands
562
for cmd in env rm; do alias "$cmd=command $cmd"; done; unset cmd
563 9110 aaronmk
564
565
### external command input/output
566 8907 aaronmk
567 9318 aaronmk
pipe_delay() # usage: cmd1 | { pipe_delay; cmd2; }
568 9270 aaronmk
{ sleep 0.1; } # s; display after leading output of cmd1
569 8997 aaronmk
570
fi # load new aliases
571
if self_being_included; then
572
573 9074 aaronmk
echo_stdin() # usage: input|echo_stdin|cmd
574 8702 aaronmk
{
575 8897 aaronmk
	if can_log; then
576 8998 aaronmk
		pipe_delay
577 9212 aaronmk
		echo ----- >&"$log_fd"
578
		tee -a /dev/fd/"$log_fd";
579
		echo ----- >&"$log_fd"
580 8897 aaronmk
	else cat
581
	fi
582 8702 aaronmk
}
583 8275 aaronmk
584 9318 aaronmk
echo_stdout() { echo_stdin; } # usage: cmd|echo_stdout
585 9044 aaronmk
586 8873 aaronmk
587 8854 aaronmk
#### commands
588
589 9122 aaronmk
require_not_exists() # usage: require_not_exists file || return 0
590 9073 aaronmk
{ test ! -e "$1" || type=info die "file "$1" already exists, skipping"; }
591 9062 aaronmk
592 9271 aaronmk
function to_file() # usage: stdout=... [if_not_exists=1] to_file cmd...
593 8986 aaronmk
# auto-removes a command's output file on error (like make's .DELETE_ON_ERROR)
594 9048 aaronmk
{
595 9235 aaronmk
	echo_func; kw_params stdout
596 9234 aaronmk
	: "${stdout?}"
597 9122 aaronmk
	test ! "$if_not_exists" || require_not_exists "$stdout" || return 0
598 9048 aaronmk
	"$@" >"$stdout" || { save_e; log_e; rm "$stdout"; rethrow; }
599
}
600 9177 aaronmk
alias to_file='"to_file" ' # last space alias-expands next word
601 8986 aaronmk
602 9074 aaronmk
run_args_cmd() # runs the command line args command
603 8272 aaronmk
{
604 8693 aaronmk
	eval set -- "$(reverse "${BASH_ARGV[@]}")"
605 8971 aaronmk
	test $# -ge 1 || set -- all
606 9189 aaronmk
	echo_cmd "$top_script" "$@"; "$@"
607 8272 aaronmk
}
608
609 9074 aaronmk
fwd() # usage: subdirs=(...); fwd "$FUNCNAME" "$@"
610 8272 aaronmk
{
611 8881 aaronmk
	echo_func
612 8284 aaronmk
	: "${subdirs?}"
613
614 9297 aaronmk
	for subdir in "${subdirs[@]}"; do "$top_dir"/"$subdir"/run "$@"; done
615 8272 aaronmk
}
616
617 9017 aaronmk
618 8966 aaronmk
#### URLs
619
620 9074 aaronmk
localize_url() { test _"$1" = _"$(hostname -f)" || echo "$1"; }
621 8966 aaronmk
622 8704 aaronmk
fi