Project

General

Profile

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
alias self_sys='command -p "$FUNCNAME"' # usage: wrapper() { self_sys ...; }
110

    
111
pf() { declare -f "$@"; } # usage: pf function # prints func decl for debugging
112

    
113
all_funcs() # usage: for func in $(all_funcs); do ...; done # all declared funcs
114
{ declare -F|while read -r line; do echo -n "${line#declare -f } "; done; }
115

    
116

    
117
#### exceptions
118

    
119
# usage: cmd || { save_e; ...; rethrow; }
120
alias export_e='e=$?'
121
alias save_e='declare e=$?'
122
alias rethrow='return "$e"'
123
alias rethrow_subshell='exit "$e"'
124

    
125
fi # load new aliases
126
if self_being_included; then
127

    
128
# usage: try cmd...; ignore_e status; if catch status; then ...; fi; end_try
129

    
130
function try() { e=0; benign_error=1 "$@" || { export_e; true; }; }
131
alias try='declare e; "try" ' # last space alias-expands next word
132

    
133
catch() { test "$e" -eq "$1" && e=0; }
134

    
135
ignore_e() { catch "$@" || true; }
136

    
137
alias end_try='rethrow'
138
alias end_try_subshell='rethrow_subshell'
139

    
140
ignore() { save_e; ignore_e "$@"; rethrow; } # usage: try cmd || ignore status
141

    
142
### signals
143

    
144
sig_e() { echo $(( 128+$(kill -l "$1") )); } # usage: sig_e SIGINT, etc.
145

    
146
ignore_sig() { ignore "$(sig_e "$1")"; }
147

    
148
# usage: piped_cmd cmd1...|cmd2... # cmd2 doesn't read all its input
149
function piped_cmd() { "$@" || ignore_sig SIGPIPE; }
150
alias piped_cmd='"piped_cmd" ' # last space alias-expands next word
151

    
152
fi # load new aliases
153
if self_being_included; then
154

    
155

    
156
#### integers
157

    
158
let!() { let "$@" || true; } # always returns true; safe to use for setting
159
	# "If the last ARG evaluates to 0, let returns 1" (`help let`)
160

    
161
bool2int() { try test ! "$1"; echo "$e"; } # empty->0; non-empty->1
162

    
163
int2exit() { (( "$1" != 0 )); }
164

    
165
exit2bool() { if (( $? == 0 )); then echo 1; fi } # 0->non-empty; !=0->empty
166

    
167

    
168
#### floats
169

    
170
int_part() { echo "${1%%.*}"; }
171

    
172
dec_suffix() { echo "${1#$(int_part "$1")}"; }
173

    
174
round_down() { int_part "$1"; }
175

    
176
float+int() { echo "$(($(int_part "$1")+$2))$(dec_suffix "$1")"; }
177

    
178
float_set_min() { if (($(int_part $1) >= $2)); then echo $1; else echo $2; fi; }
179

    
180

    
181
#### strings
182

    
183
starts_with() { test "${2#$1}" != "$2"; } # usage: starts_with pattern str
184

    
185
match_prefix() # usage: match_prefix pattern str
186
{ if starts_with "$1" "$2"; then echo "${2%${2#$1}}"; fi }
187

    
188
repeat() # usage: str=... n=... repeat
189
{
190
	: "${str?}" "${n:?}"; local result= n="$n" # n will be modified in function
191
	for (( ; n > 0; n-- )); do result="$result$str"; done
192
	echo "$result"
193
}
194

    
195
sed_cmd="sed -`case "$(uname)" in Darwin) echo E;; *) echo r;; esac`"
196
alias sed="$sed_cmd"
197

    
198
fi # load new aliases
199
if self_being_included; then
200

    
201
rtrim() { log+ 3; sed 's/[[:space:]]+$//' <<<"$1"; }
202

    
203

    
204
#### arrays
205

    
206
join() { local IFS="$delim"; echo "$*"; } # usage: delim=... 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
#### streams
223

    
224
pipe_delay() # usage: cmd1 | { pipe_delay; cmd2; }
225
{ sleep 0.1; } # s; display after leading output of cmd1
226

    
227

    
228
#### verbose output
229

    
230

    
231
err_fd=2 # stderr
232

    
233
usage() { echo "Usage: $1" >&2; return 2; }
234

    
235

    
236
### log++
237

    
238
log_fd=2 # initially stderr
239

    
240
if test "$explicit_errors_only"; then verbosity=0; fi # hide startup logging
241

    
242
# set verbosity
243
if isset verbose; then : "${verbosity:=$(bool2int "$verbose")}"; fi
244
if isset vb; then : "${verbosity:=$vb}"; fi
245
: "${verbosity=1}" # default
246
: "${verbosity:=0}" # ensure non-empty
247
export verbosity # propagate to invoked commands
248
export PS4 # follows verbosity, so also propagate this
249

    
250
is_outermost="$(! isset log_level; exit2bool)" # if util.sh env not yet set up
251

    
252
# set log_level
253
: "${log_level=$(( ${#PS4}-1 ))}" # defaults to # non-space symbols in PS4
254
export log_level # propagate to invoked commands
255

    
256
verbosity_int() { round_down "$verbosity"; }
257

    
258
# verbosities (and `make` equivalents):
259
# 0: just print errors. useful for cron jobs.
260
#    vs. make: equivalent to --silent, but suppresses external command output
261
# 1: also external commands run. useful for running at the command line.
262
#    vs. make: not provided (but sorely needed to avoid excessive output)
263
# 2: full graphical call tree. useful for determining where error occurred.
264
#    vs. make: equivalent to default verbosity, but with much-needed indents
265
# 3: also values of kw params and variables. useful for low-level debugging.
266
#    vs. make: not provided; need to manually use $(error $(var))
267
# 4: also variables in util.sh commands. useful for debugging util.sh.
268
#    vs. make: somewhat similar to --print-data-base
269
# 5: also variables in logging commands themselves. useful for debugging echo_*.
270
#    vs. make: not provided; need to search Makefile for @ at beginning of cmd
271
# 6+: not currently used (i.e. same as 5)
272

    
273
# definition: the log_level is the minimum verbosity needed to display a message
274
# for messages that use can_log(), the log_level starts with *1*, not 0
275
# for unfiltered messages, the log_level is 0 (i.e. still output at verbosity=0)
276
# to view a message's log_level, count the # of + signs before it in the output
277

    
278
fi # load new aliases
279
if self_being_included; then
280

    
281
# usage: in func:      log++; ...         OR  log_local; "log++"; ...
282
#        outside func: log++; ...; log--
283
#        before cmd:  "log++" cmd  OR  "log+" # cmd  OR  "log++" "log++" cmd
284
# with a cmd, assignments are applied just to it, so log_local is not needed
285
# without a cmd, "$@" expands to nothing and assignments are applied to caller
286
# "${@:2}" expands to all of $@ after *1st* arg, not 2nd ($@ indexes start at 1)
287
log+()
288
{
289
	# no local vars because w/o cmd, assignments should be applied to caller
290
	PS4="$(str="${PS4:0:1}" n=$((log_level+$1-1)) repeat)${PS4: -2}"; \
291
	log_level=$((log_level+$1)) \
292
	verbosity="$(float+int "$verbosity" "-$1")" "${@:2}"
293
}
294
log++() { log+  1 "$@"; }
295
log--() { log+ -1 "$@"; }
296
alias log_local=\
297
'declare PS4="$PS4" log_level="$log_level" verbosity="$verbosity"'
298
alias log+='log_local; "log+"' # don't expand next word because it's not a cmd
299
alias log++='log_local; "log++" ' # last space alias-expands next word
300
alias log--='log_local; "log--" ' # last space alias-expands next word
301
# no clog+ alias because next word is not a cmd
302
alias clog++='"log++" ' # last space alias-expands next word
303
alias clog--='"log--" ' # last space alias-expands next word
304

    
305
verbosity_min() # usage: verbosity_min min
306
{ if test "$(verbosity_int)" -lt "$1"; then verbosity="$1"; fi; }
307
alias verbosity_min='log_local; "verbosity_min"'
308

    
309

    
310
# indent for call tree. this is *not* the log_level (below).
311
: "${log_indent_step=| }" "${log_indent=}"
312
export log_indent_step log_indent # propagate to invoked commands
313

    
314
__caller_indent='log_indent="$log_indent$log_indent_step"'
315
alias caller_indent="$__caller_indent"
316
alias indent="declare $__caller_indent"
317

    
318

    
319
fi # load new aliases
320
if self_being_included; then
321

    
322
can_log() { test "$(verbosity_int)" -gt 0; }
323
	# verbosity=0 turns off all logging
324

    
325
log() { if can_log; then echo "$log_indent$PS4$1" >&"$log_fd"; fi; }
326

    
327
log_custom() # usage: symbol=... log_custom msg
328
{ log_indent="${log_indent//[^ ]/$symbol}" PS4="${PS4//[^ ]/$symbol}" log "$@";}
329

    
330
log_err() { symbol='#' verbosity=1 log_fd="$err_fd" log_custom "$@"; }
331

    
332
log_info() { symbol=: log_custom "$@"; }
333

    
334
die() # usage: cmd || [type=...] die msg # msg can use $? but not $()
335
{ save_e; kw_params type; "log_${type:-err}" "$1"; rethrow; }
336

    
337
die_e() # usage: cmd || [benign_error=1] die_e [|| handle error]
338
{
339
	save_e; kw_params benign_error
340
	if test "$benign_error"; then log++; fi
341
	type="${benign_error:+info}" die "command exited with \
342
$(if test "$benign_error"; then echo status; else echo error; fi) $e"
343
	rethrow
344
}
345

    
346

    
347
#### functions
348

    
349
func_exists() { declare -f "$1" >/dev/null; }
350

    
351
copy_func() # usage: from=... to=... copy_func
352
# $to must not exist. to get around the no-clobber restriction, use `unset -f`.
353
{
354
	: "${from:?}" "${to:?}"
355
	func_exists "$from" || die "function does not exist: $from"
356
	! func_exists "$to" || die "function already exists: $to"
357
	local from_def="$(declare -f "$from")"
358
	eval "$to${from_def#$from}"
359
}
360

    
361
func_override() # usage: func_override old_name__suffix
362
{ from="${1%__*}" to="$1" copy_func; }
363

    
364
ensure_nested_func() # usage: func__nested_func() { ensure_nested_func; ... }
365
{
366
	local nested_func="${FUNCNAME[1]}"
367
	local func="${nested_func%%__*}"
368
	contains "$func" "${FUNCNAME[@]}" || \
369
		die "$nested_func() must be used by $func()"
370
}
371

    
372

    
373
#### paths
374

    
375
# cache realpath
376
: "${realpath_cache=}" # default off because slower than without
377
if test "$realpath_cache"; then
378
func_override realpath__no_cache
379
realpath() # caches the last result for efficiency
380
{
381
	local cache_key="$*"; load_cache
382
	if ! cached; then save_cache "$(realpath__no_cache "$@")" || return; fi
383
	echo_cached_value
384
}
385
fi
386

    
387
rel_path() # usage: base_dir=... path=... rel_path
388
{
389
	log++; kw_params base_dir path
390
	: "${base_dir:?}" "${path:?}"
391
	
392
	local path="$path/" # add *extra* / to match path when exactly = base_dir
393
	path="${path#$base_dir/}" # remove prefix shared with base_dir
394
	path="${path%/}" # remove any remaining extra trailing /
395
	
396
	if test ! "$path"; then path=.; fi # ensure non-empty
397
	
398
	echo_vars path
399
	echo "$path"
400
}
401

    
402
cd -P . # expand symlinks in $PWD so it matches the output of realpath
403
# do before setting $top_script_abs so realpath has less symlinks to resolve
404

    
405
canon_rel_path()
406
{
407
	local path; path="$(realpath "$1")" || return
408
	base_dir="$PWD" rel_path
409
}
410

    
411
# makes $1 a canon_rel_path if it's a filesystem path
412
alias cmd2rel_path="$(cat <<'EOF'
413
if test "$(type -t "$1")" = file && test -e "$1"; then # not relative to PATH
414
	declare _1="$1"; shift
415
	_1="$(canon_rel_path "$_1")" || return
416
	set -- "$_1" "$@"
417
fi
418
EOF
419
)"
420

    
421

    
422
#### verbose output
423

    
424

    
425
### command echoing
426

    
427
alias echo_params='log "$*"'
428

    
429
fi # load new aliases
430
if self_being_included; then
431

    
432
echo_cmd() { echo_params; }
433

    
434
function echo_run() { echo_params; "$@"; }
435
alias echo_run='"echo_run" ' # last space alias-expands next word
436

    
437
echo_eval() { echo_params; builtin eval "$@"; }
438

    
439
# usage: redirs=(...); [cmd_name_log_inc=#] echo_redirs_cmd
440
function echo_redirs_cmd()
441
{
442
	local cmd_name_log_inc="${cmd_name_log_inc-0}"
443
	
444
	# print <>file redirs before cmd, because they introduce it
445
	"log+" "$cmd_name_log_inc" echo_cmd "$@" $(
446
		set -- "${redirs[@]}" # operate on @redirs
447
		while test "$#" -gt 0 && starts_with '[<>][^&]' "$1"
448
		do log "$1 \\"; shift; done # log() will run *before* echo_cmd itself
449
		echo "$@"
450
	)
451
}
452
alias echo_redirs_cmd='"echo_redirs_cmd" "$@"'
453

    
454
## vars
455

    
456
echo_vars() # usage: echo_vars var...
457
{
458
	log+ 2
459
	if can_log; then
460
		local var
461
		for var in "${@%%=*}"; do
462
			if isset "$var"; then log "$(declare -p "$var")"; fi
463
		done
464
	fi
465
}
466

    
467
echo_export() { builtin export "$@"; echo_vars "$@"; }
468

    
469
alias export="echo_export" # automatically echo env vars when they are set
470

    
471
func_override kw_params__lang
472
kw_params() { kw_params__lang "$@"; echo_vars "$@"; } # echo all keyword params
473

    
474
## functions
475

    
476
# usage: local func=...; set_func_loc; use $file, $line
477
alias set_func_loc="$(cat <<'EOF'
478
: "${func:?}"
479
local func_info="$(shopt -s extdebug; declare -F "$func")" # 'func line file'
480
func_info="${func_info#$func }"
481
local line="${func_info%% *}"
482
local file="${func_info#$line }"
483
EOF
484
)"
485

    
486
fi # load new aliases
487
if self_being_included; then
488

    
489
func_loc() # gets where function declared in the format file:line
490
{
491
	local func="$1"; set_func_loc
492
	file="$(canon_rel_path "$file")" || return
493
	echo "$file:$line"
494
}
495

    
496
# usage: func() { [minor=1] echo_func; ... }
497
function echo_func()
498
# usage: [minor=1] "echo_func" "$FUNCNAME" "$@" && indent || true
499
# exit status: whether function call was echoed
500
{
501
	kw_params minor
502
	local func="$1"; shift
503
	
504
	log++; if test "$minor"; then log++; fi
505
	local loc; loc="$(func_loc "$func")" || return
506
	echo_cmd "$loc" "$func" "$@"
507
	can_log
508
}
509
alias echo_func='"echo_func" "$FUNCNAME" "$@" && indent || true'
510

    
511
fi # load new aliases
512
if self_being_included; then
513

    
514

    
515
#### streams
516

    
517
fd_exists() { (: <&"$1") 2>/dev/null; }
518

    
519
require_fd_not_exists() # usage: require_fd_not_exists fd || return 0
520
{ ! fd_exists "$1" || type=info die "fd $1 already exists, skipping"; }
521

    
522
set_fds() # usage: set_fds redirect...
523
{
524
	echo_func
525
	
526
	# add #<>&- before every #<>&# reopen to fix strange bash bug
527
	local redirs=()
528
	for i in "$@"; do
529
		local redir_prefix="$(match_prefix '*[<>]' "$i")"
530
		if test "$redir_prefix"; then redirs+=("$redir_prefix&-"); fi
531
		redirs+=("$i")
532
	done
533
	set -- "${redirs[@]}"
534
	
535
	echo_eval exec "$@"
536
}
537

    
538
fd_set_default() # usage: fd_set_default 'dest[<>]src'
539
{
540
	echo_func
541
	local dest="${1%%[<>]*}"
542
	require_fd_not_exists "$dest" || return 0
543
	set_fds "$1"
544
}
545

    
546
function filter_fd() # usage: (fd=# filter_fd filter_cmd...; with filter...)
547
# useful e.g. to filter logging output or highlight errors
548
{
549
	echo_func; kw_params fd; : "${fd?}"
550
	set_fds "$fd>" >(pipe_delay; redirs=(">&$fd" "${redirs[@]}"); redir "$@")
551
	pipe_delay; pipe_delay # wait for >()'s pipe_delay and initial logging
552
}
553
alias filter_fd='"filter_fd" ' # last space alias-expands next word
554

    
555
# convention: use fd 40/41/42 for command-specific alternate stdin/stdout/stderr
556
# do NOT use 1x, which are used by eval (which is used by set_fds())
557
# do NOT use 2x, which are used as global stdin/stdout/stderr
558
# do NOT use 3x, which are used for logging
559

    
560
setup_log_fd() # view logging output at verbosity >= 5
561
{
562
	log+ 4; log-- echo_func 
563
	fd_set_default '30>&2' || true # stdlog
564
	log_fd=30 # stdlog
565
}
566
setup_log_fd
567

    
568
set_global_fds()
569
# allows commands to access global stdin/stdout/stderr using fd 20/21/22
570
# this works even when /dev/tty isn't available
571
# view logging output at verbosity >= 3
572
{
573
	log+ 2; log-- echo_func
574
	# ignore errors if a source fd isn't open
575
	fd_set_default '20<&0' || true
576
	fd_set_default '21>&1' || true
577
	fd_set_default '22>&2' || true
578
}
579
set_global_fds
580

    
581
# usage: explicit_errors_only=1 script...
582
# show only explicitly-displayed errors (which have been redirected to fd 22)
583
# most of the time this has the same effect as `verbosity=0 script...`,
584
# which displays everything that isn't explicitly hidden
585
# this option should only be used for testing the explicit error displaying
586
if test "$explicit_errors_only"; then disable_logging; fi
587

    
588

    
589
echo_vars is_outermost
590

    
591

    
592
#### paths
593

    
594
top_symlink_dir="$(dirname "$0")"; echo_vars top_symlink_dir
595
top_symlink_dir_abs="$(realpath "$top_symlink_dir")"
596
	echo_vars top_symlink_dir_abs
597

    
598
top_script_abs="$(realpath "$0")"; echo_vars top_script_abs # outermost script
599
	# realpath this before doing any cd so this points to the right place
600
top_dir_abs="$(dirname "$top_script_abs")"; echo_vars top_dir_abs
601

    
602
set_paths()
603
{
604
	top_script="$(canon_rel_path "$top_script_abs")" || return
605
		echo_vars top_script
606
	top_dir="$(dirname "$top_script")" || return; echo_vars top_dir
607
}
608
set_paths
609

    
610
PATH_rm() # usage: PATH_rm path... # removes components from the PATH
611
{
612
	echo_func; echo_vars PATH; : "${PATH?}"
613
	PATH=":$PATH:" # add *extra* : to match at beginning and end
614
	for path in "$@"; do PATH="${PATH//:$path:/:}"; done
615
	PATH="${PATH#:}" # remove any remaining extra leading :
616
	PATH="${PATH%:}" # remove any remaining extra trailing :
617
	echo_vars PATH
618
}
619

    
620
no_PATH_recursion() # usage: (no_PATH_recursion; cmd...)
621
# allows running a system command of the same name as the script
622
{
623
	echo_func
624
	PATH_rm "$top_dir_abs" "$top_symlink_dir" "$top_symlink_dir_abs" "$top_dir"
625
}
626

    
627

    
628
#### verbose output
629

    
630

    
631
## internal commands
632

    
633
.()
634
{
635
	cmd2rel_path; set -- "$FUNCNAME" "$@"
636
	if (log++; echo_params; can_log); then indent; fi
637
	builtin "$@"
638
}
639

    
640
cd() # indent is permanent within subshell cd was used in
641
{
642
	log++ echo_func
643
	cmd2rel_path; echo_cmd "$FUNCNAME" "$@"
644
	if can_log; then caller_indent; fi
645
	# -P: expand symlinks so $PWD matches the output of realpath
646
	builtin "$FUNCNAME" -P "$@"
647
	
648
	func=realpath clear_cache
649
	set_paths
650
}
651

    
652
## external commands
653

    
654
disable_logging() { set_fds "$log_fd>/dev/null"; }
655

    
656
function redir() # usage: local redirs=(#<>...); redir cmd...; unset redirs
657
# to view only explicitly-displayed errors: explicit_errors_only=1 script...
658
{
659
	echo_func; kw_params redirs
660
	
661
	case "$1" in redir|command) "$@"; return;; esac # redir will be run later
662
	(
663
		log++ set_fds "${redirs[@]}"
664
		(case "$1" in command__exec) shift;; esac; echo_redirs_cmd)
665
		"$@"
666
	) || return
667
}
668
alias redir='"redir" ' # last space alias-expands next word
669

    
670
alias_append save_e '; unset redirs' # don't redirect error handlers
671

    
672
command() # usage: [cmd_log_fd=|1|2|#] [verbosity_min=] command extern_cmd...
673
{
674
	echo_func; kw_params log_fd cmd_log_fd redirs verbosity_min
675
	# if no cmd_log_fd, limit log_fd in case command uses util.sh
676
	local cmd_log_fd="${cmd_log_fd-$log_fd}"
677
	local redirs=("${redirs[@]}")
678
	
679
	# determine redirections
680
	if test "$cmd_log_fd"; then
681
		if can_log; then
682
			if test "$cmd_log_fd" != "$log_fd"; then
683
				redirs+=("$cmd_log_fd>&$log_fd")
684
			fi # else no redir needed
685
		else redirs+=("$cmd_log_fd>/dev/null");
686
		fi
687
	fi
688
	
689
	cmd2rel_path
690
	redir command__exec "$@" || die_e
691
}
692
command__exec()
693
{
694
	ensure_nested_func
695
	if can_log; then indent; fi
696
	if test "$verbosity_min"; then verbosity_min "$verbosity_min"; fi
697
	builtin command "$@"
698
}
699

    
700
# auto-echo common external commands
701
for cmd in env rm; do alias "$cmd=command $cmd"; done; unset cmd
702

    
703

    
704
### external command input/output
705

    
706
echo_stdin() # usage: input|echo_stdin|cmd
707
{
708
	if can_log; then
709
		pipe_delay
710
		echo ----- >&"$log_fd"
711
		tee -a /dev/fd/"$log_fd";
712
		echo ----- >&"$log_fd"
713
	else cat
714
	fi
715
}
716

    
717
echo_stdout() { echo_stdin; } # usage: cmd|echo_stdout
718

    
719

    
720
#### commands
721

    
722
already_exists_msg() # usage: cond || what=... already_exists_msg || return 0
723
{ type=info die "$what already exists, skipping"; }
724

    
725
require_not_exists() # usage: require_not_exists file || return 0
726
{ test ! -e "$1" || what="file \"$1\"" already_exists_msg; }
727

    
728
function to_file() # usage: stdout=... [if_not_exists=1] [del=] to_file cmd...
729
# auto-removes a command's output file on error (like make's .DELETE_ON_ERROR)
730
{
731
	echo_func; kw_params stdout if_not_exists del
732
	: "${stdout?}"; local del="${del-1}"
733
	if test "$if_not_exists"; then require_not_exists "$stdout" || return 0; fi
734
	
735
	local redirs=("${redirs[@]}" ">$stdout")
736
	redir "$@" || { save_e; test ! "$del" || rm "$stdout"; rethrow; }
737
}
738
alias to_file='"to_file" ' # last space alias-expands next word
739

    
740
log_bg() { symbol='&' log_custom "$@"; }
741

    
742
log_last_bg() { log_bg '$!='"$!"; }
743

    
744
function bg_cmd() { echo_func; "$@" & log_last_bg; } # usage: bg_cmd cmd...
745
alias bg_cmd='"bg_cmd" ' # last space alias-expands next word
746

    
747
run_args_cmd() # runs the command line args command
748
{
749
	eval set -- "$(reverse "${BASH_ARGV[@]}")"
750
	test $# -ge 1 || set -- all
751
	echo_cmd "$top_script" "$@"; "$@"
752
}
753

    
754
fwd() # usage: subdirs=(...); fwd "$FUNCNAME" "$@"
755
{
756
	echo_func
757
	: "${subdirs?}"
758
	
759
	for subdir in "${subdirs[@]}"; do "$top_dir"/"$subdir"/run "$@"; done
760
}
761

    
762

    
763
#### filesystem
764

    
765
alias file_size=\
766
"stat `case "$(uname)" in Darwin) echo -f %z;; *) echo --format=%s;; esac`"
767

    
768

    
769
#### URLs
770

    
771
localize_url() { test _"$1" = _"$(hostname -f)" || echo "$1"; }
772

    
773
fi
(8-8/8)