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
# set log_level
251
: "${log_level=$(( ${#PS4}-1 ))}" # defaults to # non-space symbols in PS4
252
export log_level # propagate to invoked commands
253

    
254
verbosity_int() { round_down "$verbosity"; }
255

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

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

    
276
fi # load new aliases
277
if self_being_included; then
278

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

    
300
verbosity_min() # usage: verbosity_min min
301
{ if test "$(verbosity_int)" -lt "$1"; then verbosity="$1"; fi; }
302
alias verbosity_min='log_local; "verbosity_min"'
303

    
304

    
305
# indent for call tree. this is *not* the log_level (below).
306
: "${log_indent_step=| }" "${log_indent=}"
307
export log_indent_step log_indent # propagate to invoked commands
308

    
309
__caller_indent='log_indent="$log_indent$log_indent_step"'
310
alias caller_indent="$__caller_indent"
311
alias indent="declare $__caller_indent"
312

    
313

    
314
fi # load new aliases
315
if self_being_included; then
316

    
317
can_log() { test "$(verbosity_int)" -gt 0; }
318
	# verbosity=0 turns off all logging
319

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

    
322
log_custom() # usage: symbol=... log_custom msg
323
{ log_indent="${log_indent//[^ ]/$symbol}" PS4="${PS4//[^ ]/$symbol}" log "$@";}
324

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

    
327
log_info() { symbol=: log_custom "$@"; }
328

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

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

    
341

    
342
#### functions
343

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

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

    
356
func_override() # usage: func_override old_name__suffix
357
{ from="${1%__*}" to="$1" copy_func; }
358

    
359
ensure_nested_func() # usage: func__nested_func() { ensure_nested_func; ... }
360
{
361
	local nested_func="${FUNCNAME[1]}"
362
	local func="${nested_func%%__*}"
363
	contains "$func" "${FUNCNAME[@]}" || \
364
		die "$nested_func() must be used by $func()"
365
}
366

    
367

    
368
#### paths
369

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

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

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

    
400
canon_rel_path()
401
{
402
	local path; path="$(realpath "$1")" || return
403
	base_dir="$PWD" rel_path
404
}
405

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

    
416

    
417
#### verbose output
418

    
419

    
420
### command echoing
421

    
422
alias echo_params='log "$*"'
423

    
424
fi # load new aliases
425
if self_being_included; then
426

    
427
echo_cmd() { echo_params; }
428

    
429
function echo_run() { echo_params; "$@"; }
430
alias echo_run='"echo_run" ' # last space alias-expands next word
431

    
432
echo_eval() { echo_params; builtin eval "$@"; }
433

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

    
447
## vars
448

    
449
echo_vars() # usage: echo_vars var...
450
{
451
	log+ 2
452
	if can_log; then
453
		local var
454
		for var in "${@%%=*}"; do
455
			if isset "$var"; then log "$(declare -p "$var")"; fi
456
		done
457
	fi
458
}
459

    
460
echo_export() { builtin export "$@"; echo_vars "$@"; }
461

    
462
alias export="echo_export" # automatically echo env vars when they are set
463

    
464
func_override kw_params__lang
465
kw_params() { kw_params__lang "$@"; echo_vars "$@"; } # echo all keyword params
466

    
467
## functions
468

    
469
# usage: local func=...; set_func_loc; use $file, $line
470
alias set_func_loc="$(cat <<'EOF'
471
: "${func:?}"
472
local func_info="$(shopt -s extdebug; declare -F "$func")" # 'func line file'
473
func_info="${func_info#$func }"
474
local line="${func_info%% *}"
475
local file="${func_info#$line }"
476
EOF
477
)"
478

    
479
fi # load new aliases
480
if self_being_included; then
481

    
482
func_loc() # gets where function declared in the format file:line
483
{
484
	local func="$1"; set_func_loc
485
	file="$(canon_rel_path "$file")" || return
486
	echo "$file:$line"
487
}
488

    
489
# usage: func() { [minor=1] echo_func; ... }
490
function echo_func()
491
# usage: [minor=1] "echo_func" "$FUNCNAME" "$@" && indent || true
492
# exit status: whether function call was echoed
493
{
494
	kw_params minor
495
	local func="$1"; shift
496
	
497
	log++; if test "$minor"; then log++; fi
498
	local loc; loc="$(func_loc "$func")" || return
499
	echo_cmd "$loc" "$func" "$@"
500
	can_log
501
}
502
alias echo_func='"echo_func" "$FUNCNAME" "$@" && indent || true'
503

    
504
fi # load new aliases
505
if self_being_included; then
506

    
507

    
508
#### streams
509

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

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

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

    
531
fd_set_default() # usage: fd_set_default 'dest[<>]src'
532
{
533
	echo_func
534
	local dest="${1%%[<>]*}"
535
	require_fd_not_exists "$dest" || return 0
536
	set_fds "$1"
537
}
538

    
539
function filter_fd() # usage: (fd=# filter_fd filter_cmd...; with filter...)
540
# useful e.g. to filter logging output or highlight errors
541
{
542
	echo_func; kw_params fd; : "${fd?}"
543
	set_fds "$fd>" >(pipe_delay; redirs=(">&$fd" "${redirs[@]}"); redir "$@")
544
	pipe_delay; pipe_delay # wait for >()'s pipe_delay and initial logging
545
}
546
alias filter_fd='"filter_fd" ' # last space alias-expands next word
547

    
548
# convention: use fd 40/41/42 for command-specific alternate stdin/stdout/stderr
549
# do NOT use 1x, which are used by eval (which is used by set_fds())
550
# do NOT use 2x, which are used as global stdin/stdout/stderr
551
# do NOT use 3x, which are used for logging
552

    
553
setup_log_fd() # view logging output at verbosity >= 5
554
{
555
	log+ 4; log-- echo_func 
556
	fd_set_default '30>&2' || true # stdlog
557
	log_fd=30 # stdlog
558
}
559
setup_log_fd
560

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

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

    
581

    
582
#### paths
583

    
584
top_dir_orig="$(dirname "$0")"; echo_vars top_dir_orig
585

    
586
top_script_abs="$(realpath "$0")"; echo_vars top_script_abs # outermost script
587
	# realpath this before doing any cd so this points to the right place
588
top_dir_abs="$(dirname "$top_script_abs")"; echo_vars top_dir_abs
589

    
590
set_paths()
591
{
592
	top_script="$(canon_rel_path "$top_script_abs")" || return
593
		echo_vars top_script
594
	top_dir="$(dirname "$top_script")" || return; echo_vars top_dir
595
}
596
set_paths
597

    
598
PATH_rm() # usage: PATH_rm path... # removes components from the PATH
599
{
600
	echo_func; echo_vars PATH; : "${PATH?}"
601
	PATH=":$PATH:" # add *extra* : to match at beginning and end
602
	for path in "$@"; do PATH="${PATH//:$path:/:}"; done
603
	PATH="${PATH#:}" # remove any remaining extra leading :
604
	PATH="${PATH%:}" # remove any remaining extra trailing :
605
	echo_vars PATH
606
}
607

    
608
no_PATH_recursion() # usage: (no_PATH_recursion; cmd...)
609
# allows running a system command of the same name as the script
610
{ echo_func; PATH_rm "$top_dir_abs" "$top_dir_orig" "$top_dir"; }
611

    
612

    
613
#### verbose output
614

    
615

    
616
## internal commands
617

    
618
.()
619
{
620
	cmd2rel_path; set -- "$FUNCNAME" "$@"
621
	if (log++; echo_params; can_log); then indent; fi
622
	builtin "$@"
623
}
624

    
625
cd() # indent is permanent within subshell cd was used in
626
{
627
	log++ echo_func
628
	cmd2rel_path; echo_cmd "$FUNCNAME" "$@"
629
	if can_log; then caller_indent; fi
630
	# -P: expand symlinks so $PWD matches the output of realpath
631
	builtin "$FUNCNAME" -P "$@"
632
	
633
	func=realpath clear_cache
634
	set_paths
635
}
636

    
637
## external commands
638

    
639
disable_logging() { set_fds "$log_fd>/dev/null"; }
640

    
641
function redir() # usage: local redirs=(#<>...); redir cmd...; unset redirs
642
# to view only explicitly-displayed errors: explicit_errors_only=1 script...
643
{
644
	echo_func; kw_params redirs
645
	
646
	case "$1" in redir|command) "$@"; return;; esac # redir will be run later
647
	(
648
		log++ set_fds "${redirs[@]}"
649
		(case "$1" in command__exec) shift;; esac; echo_redirs_cmd)
650
		"$@"
651
	) || return
652
}
653
alias redir='"redir" ' # last space alias-expands next word
654

    
655
alias_append save_e '; unset redirs' # don't redirect error handlers
656

    
657
command() # usage: [cmd_log_fd=|1|2|#] [verbosity_min=] command extern_cmd...
658
{
659
	echo_func; kw_params cmd_log_fd redirs verbosity_min
660
	# if no cmd_log_fd, limit log_fd in case command uses util.sh
661
	local cmd_log_fd="${cmd_log_fd-$log_fd}"
662
	local redirs=("${redirs[@]}")
663
	
664
	# determine redirections
665
	if test "$cmd_log_fd"; then
666
		if can_log; then
667
			if test "$cmd_log_fd" != "$log_fd"; then
668
				redirs+=("$cmd_log_fd>&$log_fd")
669
			fi # else no redir needed
670
		else redirs+=("$cmd_log_fd>/dev/null");
671
		fi
672
	fi
673
	
674
	cmd2rel_path
675
	redir command__exec "$@" || die_e
676
}
677
command__exec()
678
{
679
	ensure_nested_func
680
	if can_log; then indent; fi
681
	if test "$verbosity_min"; then verbosity_min "$verbosity_min"; fi
682
	builtin command "$@"
683
}
684

    
685
# auto-echo common external commands
686
for cmd in env rm; do alias "$cmd=command $cmd"; done; unset cmd
687

    
688

    
689
### external command input/output
690

    
691
echo_stdin() # usage: input|echo_stdin|cmd
692
{
693
	if can_log; then
694
		pipe_delay
695
		echo ----- >&"$log_fd"
696
		tee -a /dev/fd/"$log_fd";
697
		echo ----- >&"$log_fd"
698
	else cat
699
	fi
700
}
701

    
702
echo_stdout() { echo_stdin; } # usage: cmd|echo_stdout
703

    
704

    
705
#### commands
706

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

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

    
713
function to_file() # usage: stdout=... [if_not_exists=1] [del=] to_file cmd...
714
# auto-removes a command's output file on error (like make's .DELETE_ON_ERROR)
715
{
716
	echo_func; kw_params stdout if_not_exists del
717
	: "${stdout?}"; local del="${del-1}"
718
	if test "$if_not_exists"; then require_not_exists "$stdout" || return 0; fi
719
	
720
	local redirs=("${redirs[@]}" ">$stdout")
721
	redir "$@" || { save_e; test ! "$del" || rm "$stdout"; rethrow; }
722
}
723
alias to_file='"to_file" ' # last space alias-expands next word
724

    
725
run_args_cmd() # runs the command line args command
726
{
727
	eval set -- "$(reverse "${BASH_ARGV[@]}")"
728
	test $# -ge 1 || set -- all
729
	echo_cmd "$top_script" "$@"; "$@"
730
}
731

    
732
fwd() # usage: subdirs=(...); fwd "$FUNCNAME" "$@"
733
{
734
	echo_func
735
	: "${subdirs?}"
736
	
737
	for subdir in "${subdirs[@]}"; do "$top_dir"/"$subdir"/run "$@"; done
738
}
739

    
740

    
741
#### filesystem
742

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

    
746

    
747
#### URLs
748

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

    
751
fi
(8-8/8)