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
#### stubs
42

    
43
__caller_indent='log_indent="$log_indent$log_indent_step"'
44
alias caller_indent="$__caller_indent"
45
alias indent="declare $__caller_indent"
46

    
47
function echo_func() { :; }
48
alias echo_func='"echo_func" "$FUNCNAME" "$@" && indent || true'
49

    
50
function echo_run() { :; }
51
alias echo_run='"echo_run" ' # last space alias-expands next word
52

    
53
function echo_vars() { :; }
54

    
55

    
56
#### vars
57

    
58
set_var() { eval "$1"'="$2"'; }
59

    
60
set_default() { if ! isset "$1"; then set_var "$@"; fi; }
61

    
62
set_inv() { set_var no_"$1" "$(test "${!1}" || echo 1)"; }
63

    
64
# usage: local var=...; local_inv
65
alias local_inv='declare "no_$var=$(test "${!var}" || echo 1)"'
66

    
67
unexport() { export -n "$@"; }
68
	# `declare +x` won't work because it defines the var if it isn't set
69

    
70
alias local_export='declare -x' # combines effects of local and export
71

    
72
get_prefix_vars() { : "${prefix:?}"; eval echo '${!'$prefix'*}'; }
73

    
74
# usage: local prefix=..._; import_vars
75
# when used inside another alias 2+ levels deep, *must* be run inside a function
76
alias import_vars="$(cat <<'EOF'
77
: "${prefix:?}"
78
declare src_var dest_var
79
for src_var in $(get_prefix_vars); do
80
	dest_var="${src_var#$prefix}"
81
	declare "$dest_var=${!src_var}"; echo_vars "$dest_var"
82
done
83
EOF
84
)"
85

    
86

    
87
#### caching
88

    
89
## shell-variable-based caching
90

    
91
# usage: local cache_key=...; load_cache; \
92
# if ! cached; then save_cache value || return; fi; echo_cached_value
93
# cache_key for function inputs: "$(declare -p kw_param...) $*"
94
alias load_cache='declare cache_var="$(str2varname "${FUNCNAME}___$cache_key")"'
95
alias cached='isset "$cache_var"'
96
alias save_cache='set_var "$cache_var"'
97
alias echo_cached_value='echo "${!cache_var}"'
98

    
99
clear_cache() # usage: func=... clear_cache
100
{ : "${func:?}"; unset $(prefix="${func}___" get_prefix_vars); }
101

    
102
fi # load new aliases
103
if self_being_included; then
104

    
105

    
106
#### aliases
107

    
108
unalias() { builtin unalias "$@" 2>&- || true; } # no error if undefined
109

    
110
# usage: alias alias_='var=value run_cmd '
111
function run_cmd() { "$@"; }
112
alias run_cmd='"run_cmd" ' # last space alias-expands next word
113

    
114
alias_append() { eval $(alias "$1")'"$2"'; } # usage: alias_append alias '; cmd'
115

    
116

    
117
#### functions
118

    
119
kw_params() # usage: func() { kw_params param_var...; }; ...; param_var=... cmd
120
# removes keyword-param-only vars from the environment
121
{ unexport "$@"; }
122

    
123
alias self='command "$FUNCNAME"' # usage: wrapper() { self ...; }
124
alias self_sys='command -p "$FUNCNAME"' # usage: wrapper() { self_sys ...; }
125

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

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

    
131

    
132
#### exceptions
133

    
134
# usage: cmd || { save_e; ...; rethrow; }
135
alias export_e='e=$?'
136
alias save_e='declare e=$?'
137
alias rethrow='return "$e"'
138
alias rethrow_subshell='exit "$e"'
139

    
140
fi # load new aliases
141
if self_being_included; then
142

    
143
# usage: try cmd...; ignore_e status; if catch status; then ...; fi; end_try
144

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

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

    
150
ignore_e() { catch "$@" || true; }
151

    
152
alias end_try='rethrow'
153
alias end_try_subshell='rethrow_subshell'
154

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

    
157
### signals
158

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

    
161
ignore_sig() { ignore "$(sig_e "$1")"; }
162

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

    
167
fi # load new aliases
168
if self_being_included; then
169

    
170

    
171
#### integers
172

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

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

    
178
int2exit() { (( "$1" != 0 )); }
179

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

    
182

    
183
#### floats
184

    
185
int_part() { echo "${1%%.*}"; }
186

    
187
dec_suffix() { echo "${1#$(int_part "$1")}"; }
188

    
189
round_down() { int_part "$1"; }
190

    
191
float+int() { echo "$(($(int_part "$1")+$2))$(dec_suffix "$1")"; }
192

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

    
195

    
196
#### strings
197

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

    
200
match_prefix() # usage: match_prefix pattern str
201
{ if starts_with "$1" "$2"; then echo "${2%${2#$1}}"; fi }
202

    
203
repeat() # usage: str=... n=... repeat
204
{
205
	: "${str?}" "${n:?}"; local result= n="$n" # n will be modified in function
206
	for (( ; n > 0; n-- )); do result="$result$str"; done
207
	echo "$result"
208
}
209

    
210
sed_cmd="sed -`case "$(uname)" in Darwin) echo E;; *) echo r;; esac`"
211
alias sed="$sed_cmd"
212

    
213
fi # load new aliases
214
if self_being_included; then
215

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

    
218

    
219
#### arrays
220

    
221
join() { local IFS="$delim"; echo "$*"; } # usage: delim=... join elems...
222

    
223
reverse() # usage: array=($(reverse args...))
224
{
225
	local i
226
	for (( i=$#; i > 0; i-- )); do printf '%q ' "${!i}"; done
227
}
228

    
229
contains() # usage: contains value in_array...
230
{
231
	local value="$1"; shift
232
	local elem
233
	for elem in "$@"; do if test "$elem" = "$value"; then return 0; fi; done
234
	return 1
235
}
236

    
237
#### streams
238

    
239
pipe_delay() # usage: cmd1 | { pipe_delay; cmd2; }
240
{ sleep 0.1; } # s; display after leading output of cmd1
241

    
242

    
243
#### verbose output
244

    
245

    
246
err_fd=2 # stderr
247

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

    
250

    
251
### log++
252

    
253
log_fd=2 # initially stderr
254

    
255
if test "$explicit_errors_only"; then verbosity=0; fi # hide startup logging
256

    
257
# set verbosity
258
if isset verbose; then : "${verbosity:=$(bool2int "$verbose")}"; fi
259
if isset vb; then : "${verbosity:=$vb}"; fi
260
: "${verbosity=1}" # default
261
: "${verbosity:=0}" # ensure non-empty
262
export verbosity # propagate to invoked commands
263
export PS4 # follows verbosity, so also propagate this
264

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

    
267
# set log_level
268
: "${log_level=$(( ${#PS4}-1 ))}" # defaults to # non-space symbols in PS4
269
export log_level # propagate to invoked commands
270

    
271
verbosity_int() { round_down "$verbosity"; }
272

    
273
# verbosities (and `make` equivalents):
274
# 0: just print errors. useful for cron jobs.
275
#    vs. make: equivalent to --silent, but suppresses external command output
276
# 1: also external commands run. useful for running at the command line.
277
#    vs. make: not provided (but sorely needed to avoid excessive output)
278
# 2: full graphical call tree. useful for determining where error occurred.
279
#    vs. make: equivalent to default verbosity, but with much-needed indents
280
# 3: also values of kw params and variables. useful for low-level debugging.
281
#    vs. make: not provided; need to manually use $(error $(var))
282
# 4: also variables in util.sh commands. useful for debugging util.sh.
283
#    vs. make: somewhat similar to --print-data-base
284
# 5: also variables in logging commands themselves. useful for debugging echo_*.
285
#    vs. make: not provided; need to search Makefile for @ at beginning of cmd
286
# 6+: not currently used (i.e. same as 5)
287

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

    
293
fi # load new aliases
294
if self_being_included; then
295

    
296
# usage: in func:      log++; ...         OR  log_local; "log++"; ...
297
#        outside func: log++; ...; log--
298
#        before cmd:  "log++" cmd  OR  "log+" # cmd  OR  "log++" "log++" cmd
299
# with a cmd, assignments are applied just to it, so log_local is not needed
300
# without a cmd, "$@" expands to nothing and assignments are applied to caller
301
# "${@:2}" expands to all of $@ after *1st* arg, not 2nd ($@ indexes start at 1)
302
log+()
303
{
304
	# no local vars because w/o cmd, assignments should be applied to caller
305
	PS4="$(str="${PS4:0:1}" n=$((log_level+$1-1)) repeat)${PS4: -2}"; \
306
	log_level=$((log_level+$1)) \
307
	verbosity="$(float+int "$verbosity" "-$1")" "${@:2}"
308
}
309
log++() { log+  1 "$@"; }
310
log--() { log+ -1 "$@"; }
311
alias log_local=\
312
'declare PS4="$PS4" log_level="$log_level" verbosity="$verbosity"'
313
alias log+='log_local; "log+"' # don't expand next word because it's not a cmd
314
alias log++='log_local; "log++" ' # last space alias-expands next word
315
alias log--='log_local; "log--" ' # last space alias-expands next word
316
# no clog+ alias because next word is not a cmd
317
alias clog++='"log++" ' # last space alias-expands next word
318
alias clog--='"log--" ' # last space alias-expands next word
319

    
320
verbosity_min() # usage: verbosity_min min
321
{ if test "$(verbosity_int)" -lt "$1"; then verbosity="$1"; fi; }
322
alias verbosity_min='log_local; "verbosity_min"'
323

    
324

    
325
# indent for call tree. this is *not* the log_level (below).
326
: "${log_indent_step=| }" "${log_indent=}"
327
export log_indent_step log_indent # propagate to invoked commands
328

    
329
# see indent alias in stubs
330

    
331

    
332
fi # load new aliases
333
if self_being_included; then
334

    
335
can_log() { test "$(verbosity_int)" -gt 0; }
336
	# verbosity=0 turns off all logging
337

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

    
340
log_custom() # usage: symbol=... log_custom msg
341
{ log_indent="${log_indent//[^ ]/$symbol}" PS4="${PS4//[^ ]/$symbol}" log "$@";}
342

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

    
345
log_info() { symbol=: log_custom "$@"; }
346

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

    
350
die_e() # usage: cmd || [benign_error=1] die_e [|| handle error]
351
{
352
	save_e; kw_params benign_error
353
	if test "$benign_error"; then log++; fi
354
	type="${benign_error:+info}" die "command exited with \
355
$(if test "$benign_error"; then echo status; else echo error; fi) $e"
356
	rethrow
357
}
358

    
359

    
360
#### functions
361

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

    
364
copy_func() # usage: from=... to=... copy_func
365
# $to must not exist. to get around the no-clobber restriction, use `unset -f`.
366
{
367
	: "${from:?}" "${to:?}"
368
	func_exists "$from" || die "function does not exist: $from"
369
	! func_exists "$to" || die "function already exists: $to"
370
	local from_def="$(declare -f "$from")"
371
	eval "$to${from_def#$from}"
372
}
373

    
374
func_override() # usage: func_override old_name__suffix
375
{ from="${1%__*}" to="$1" copy_func; }
376

    
377
ensure_nested_func() # usage: func__nested_func() { ensure_nested_func; ... }
378
{
379
	local nested_func="${FUNCNAME[1]}"
380
	local func="${nested_func%%__*}"
381
	contains "$func" "${FUNCNAME[@]}" || \
382
		die "$nested_func() must be used by $func()"
383
}
384

    
385

    
386
#### paths
387

    
388
# cache realpath
389
: "${realpath_cache=}" # default off because slower than without
390
if test "$realpath_cache"; then
391
func_override realpath__no_cache
392
realpath() # caches the last result for efficiency
393
{
394
	local cache_key="$*"; load_cache
395
	if ! cached; then save_cache "$(realpath__no_cache "$@")" || return; fi
396
	echo_cached_value
397
}
398
fi
399

    
400
rel_path() # usage: base_dir=... path=... rel_path
401
{
402
	kw_params base_dir path
403
	: "${base_dir:?}" "${path:?}"
404
	
405
	local path="$path/" # add *extra* / to match path when exactly = base_dir
406
	path="${path#$base_dir/}" # remove prefix shared with base_dir
407
	path="${path%/}" # remove any remaining extra trailing /
408
	
409
	if test ! "$path"; then path=.; fi # ensure non-empty
410
	
411
	echo_vars path
412
	echo "$path"
413
}
414

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

    
418
canon_rel_path() # usage: [base_dir=...] canon_rel_path path
419
{
420
	kw_params base_dir; local base_dir="${base_dir-$PWD}"
421
	base_dir="$(realpath "$base_dir")" || return
422
	local path; path="$(realpath "$1")" || return
423
	rel_path
424
}
425

    
426
# makes $1 a canon_rel_path if it's a filesystem path
427
alias cmd2rel_path="$(cat <<'EOF'
428
if test "$(type -t "$1")" = file && test -e "$1"; then # not relative to PATH
429
	declare _1="$1"; shift
430
	_1="$(clog++ canon_rel_path "$_1")" || return
431
	set -- "$_1" "$@"
432
fi
433
EOF
434
)"
435

    
436

    
437
#### verbose output
438

    
439

    
440
### command echoing
441

    
442
alias echo_params='log "$*"'
443

    
444
fi # load new aliases
445
if self_being_included; then
446

    
447
echo_cmd() { echo_params; }
448

    
449
function echo_run() { echo_params; "$@"; }
450
# see echo_run alias after stub
451

    
452
echo_eval() { echo_params; builtin eval "$@"; }
453

    
454
# usage: redirs=(...); [cmd_name_log_inc=#] echo_redirs_cmd
455
function echo_redirs_cmd()
456
{
457
	local cmd_name_log_inc="${cmd_name_log_inc-0}"
458
	
459
	# print <>file redirs before cmd, because they introduce it
460
	"log+" "$cmd_name_log_inc" echo_cmd "$@" $(
461
		set -- "${redirs[@]}" # operate on @redirs
462
		while test "$#" -gt 0 && starts_with '[<>][^&]' "$1"
463
		do log "$1 \\"; shift; done # log() will run *before* echo_cmd itself
464
		echo "$@"
465
	)
466
}
467
alias echo_redirs_cmd='"echo_redirs_cmd" "$@"'
468

    
469
## vars
470

    
471
echo_vars() # usage: echo_vars var...
472
{
473
	log+ 2
474
	if can_log; then
475
		local var
476
		for var in "${@%%=*}"; do
477
			if isset "$var"; then log "$(declare -p "$var")"; fi
478
		done
479
	fi
480
}
481

    
482
echo_export() { builtin export "$@"; echo_vars "$@"; }
483

    
484
alias export="echo_export" # automatically echo env vars when they are set
485

    
486
func_override kw_params__lang
487
kw_params() { kw_params__lang "$@"; echo_vars "$@"; } # echo all keyword params
488

    
489
## functions
490

    
491
# usage: local func=...; set_func_loc; use $file, $line
492
alias set_func_loc="$(cat <<'EOF'
493
: "${func:?}"
494
local func_info="$(shopt -s extdebug; declare -F "$func")" # 'func line file'
495
func_info="${func_info#$func }"
496
local line="${func_info%% *}"
497
local file="${func_info#$line }"
498
EOF
499
)"
500

    
501
fi # load new aliases
502
if self_being_included; then
503

    
504
func_loc() # gets where function declared in the format file:line
505
{
506
	local func="$1"; set_func_loc
507
	file="$(canon_rel_path "$file")" || return
508
	echo "$file:$line"
509
}
510

    
511
# usage: func() { [minor=1] echo_func; ... }
512
function echo_func()
513
# usage: [minor=1] "echo_func" "$FUNCNAME" "$@" && indent || true
514
# exit status: whether function call was echoed
515
{
516
	kw_params minor
517
	local func="$1"; shift
518
	
519
	log++; if test "$minor"; then log++; fi
520
	local loc; loc="$(clog++ func_loc "$func")" || return
521
	echo_cmd "$loc" "$func" "$@"
522
	can_log
523
}
524
# see echo_func alias after stub
525

    
526
fi # load new aliases
527
if self_being_included; then
528

    
529

    
530
#### streams
531

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

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

    
537
set_fds() # usage: set_fds redirect...
538
{
539
	echo_func
540
	
541
	# add #<>&- before every #<>&# reopen to fix strange bash bug
542
	local redirs=()
543
	for i in "$@"; do
544
		local redir_prefix="$(match_prefix '*[<>]' "$i")"
545
		if test "$redir_prefix"; then redirs+=("$redir_prefix&-"); fi
546
		redirs+=("$i")
547
	done
548
	set -- "${redirs[@]}"
549
	
550
	if (($# > 0)); then echo_eval exec "$@"; fi
551
}
552

    
553
fd_set_default() # usage: fd_set_default 'dest[<>]src'
554
{
555
	echo_func
556
	local dest="${1%%[<>]*}"
557
	require_fd_not_exists "$dest" || return 0
558
	set_fds "$1"
559
}
560

    
561
function filter_fd() # usage: (fd=# filter_fd filter_cmd...; with filter...)
562
# useful e.g. to filter logging output or highlight errors
563
{
564
	echo_func; kw_params fd; : "${fd?}"
565
	set_fds "$fd>" >(pipe_delay; redirs=(">&$fd" "${redirs[@]}"); redir "$@")
566
	pipe_delay; pipe_delay # wait for >()'s pipe_delay and initial logging
567
}
568
alias filter_fd='"filter_fd" ' # last space alias-expands next word
569

    
570
# convention: use fd 40/41/42 for command-specific alternate stdin/stdout/stderr
571
# do NOT use 1x, which are used by eval (which is used by set_fds())
572
# do NOT use 2x, which are used as global stdin/stdout/stderr
573
# do NOT use 3x, which are used for logging
574

    
575
setup_log_fd() # view logging output at verbosity >= 5
576
{
577
	log+ 4; log-- echo_func 
578
	fd_set_default '30>&2' || true # stdlog
579
	log_fd=30 # stdlog
580
}
581
setup_log_fd
582

    
583
set_global_fds()
584
# allows commands to access global stdin/stdout/stderr using fd 20/21/22
585
# this works even when /dev/tty isn't available
586
# view logging output at verbosity >= 3
587
{
588
	log+ 2; log-- echo_func
589
	# ignore errors if a source fd isn't open
590
	fd_set_default '20<&0' || true
591
	fd_set_default '21>&1' || true
592
	fd_set_default '22>&2' || true
593
}
594
set_global_fds
595

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

    
603

    
604
echo_vars is_outermost
605

    
606

    
607
#### paths
608

    
609
top_symlink_dir="$(dirname "$0")"; echo_vars top_symlink_dir
610
top_symlink_dir_abs="$(realpath "$top_symlink_dir")"
611
	echo_vars top_symlink_dir_abs
612

    
613
top_script_abs="$(realpath "$0")"; echo_vars top_script_abs # outermost script
614
	# realpath this before doing any cd so this points to the right place
615
top_dir_abs="$(dirname "$top_script_abs")"; echo_vars top_dir_abs
616

    
617
set_paths()
618
{
619
	top_script="$(clog++ canon_rel_path "$top_script_abs")" || return
620
		echo_vars top_script
621
	top_dir="$(dirname "$top_script")" || return; echo_vars top_dir
622
}
623
set_paths
624

    
625
PATH_rm() # usage: PATH_rm path... # removes components from the PATH
626
{
627
	echo_func; echo_vars PATH; : "${PATH?}"
628
	PATH=":$PATH:" # add *extra* : to match at beginning and end
629
	for path in "$@"; do PATH="${PATH//:$path:/:}"; done
630
	PATH="${PATH#:}" # remove any remaining extra leading :
631
	PATH="${PATH%:}" # remove any remaining extra trailing :
632
	echo_vars PATH
633
}
634

    
635
no_PATH_recursion() # usage: (no_PATH_recursion; cmd...)
636
# allows running a system command of the same name as the script
637
{
638
	echo_func
639
	PATH_rm "$top_dir_abs" "$top_symlink_dir" "$top_symlink_dir_abs" "$top_dir"
640
}
641

    
642

    
643
#### verbose output
644

    
645

    
646
## internal commands
647

    
648
.()
649
{
650
	cmd2rel_path; set -- "$FUNCNAME" "$@"
651
	if (log++; echo_params; can_log); then indent; fi
652
	builtin "$@"
653
}
654

    
655
cd() # indent is permanent within subshell cd was used in
656
{
657
	log++ echo_func
658
	cmd2rel_path; echo_cmd "$FUNCNAME" "$@"
659
	if can_log; then caller_indent; fi
660
	# -P: expand symlinks so $PWD matches the output of realpath
661
	builtin "$FUNCNAME" -P "$@"
662
	
663
	func=realpath clear_cache
664
	set_paths
665
}
666

    
667
## external commands
668

    
669
disable_logging() { set_fds "$log_fd>/dev/null"; }
670

    
671
function redir() # usage: local redirs=(#<>...); redir cmd...; unset redirs
672
# to view only explicitly-displayed errors: explicit_errors_only=1 script...
673
{
674
	echo_func; kw_params redirs
675
	
676
	case "$1" in redir|command) "$@"; return;; esac # redir will be run later
677
	(
678
		log++ set_fds "${redirs[@]}"
679
		(case "$1" in command__exec) shift;; esac; echo_redirs_cmd)
680
		"$@"
681
	) || return
682
}
683
alias redir='"redir" ' # last space alias-expands next word
684

    
685
alias_append save_e '; unset redirs' # don't redirect error handlers
686

    
687
command() # usage: [cmd_log_fd=|1|2|#] [verbosity_min=] command extern_cmd...
688
{
689
	echo_func; kw_params log_fd cmd_log_fd redirs verbosity_min
690
	# if no cmd_log_fd, limit log_fd in case command uses util.sh
691
	local cmd_log_fd="${cmd_log_fd-$log_fd}"
692
	local redirs=("${redirs[@]}")
693
	
694
	# determine redirections
695
	if test "$cmd_log_fd"; then
696
		if can_log; then
697
			if test "$cmd_log_fd" != "$log_fd"; then
698
				redirs+=("$cmd_log_fd>&$log_fd")
699
			fi # else no redir needed
700
		else redirs+=("$cmd_log_fd>/dev/null");
701
		fi
702
	fi
703
	
704
	cmd2rel_path
705
	redir command__exec "$@" || die_e
706
}
707
command__exec()
708
{
709
	ensure_nested_func
710
	if can_log; then indent; fi
711
	if test "$verbosity_min"; then verbosity_min "$verbosity_min"; fi
712
	builtin command "$@"
713
}
714

    
715
# auto-echo common external commands
716
for cmd in env rm; do alias "$cmd=command $cmd"; done; unset cmd
717

    
718

    
719
### external command input/output
720

    
721
echo_stdin() # usage: input|echo_stdin|cmd
722
{
723
	if can_log; then
724
		pipe_delay
725
		echo ----- >&"$log_fd"
726
		tee -a /dev/fd/"$log_fd";
727
		echo ----- >&"$log_fd"
728
	else cat
729
	fi
730
}
731

    
732
echo_stdout() { echo_stdin; } # usage: cmd|echo_stdout
733

    
734

    
735
#### commands
736

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

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

    
743
function to_file() # usage: stdout=... [if_not_exists=1] [del=] to_file cmd...
744
# auto-removes a command's output file on error (like make's .DELETE_ON_ERROR)
745
{
746
	echo_func; kw_params stdout if_not_exists del
747
	: "${stdout?}"; local del="${del-1}"
748
	if test "$if_not_exists"; then require_not_exists "$stdout" || return 0; fi
749
	
750
	local redirs=("${redirs[@]}" ">$stdout")
751
	redir "$@" || { save_e; test ! "$del" || rm "$stdout"; rethrow; }
752
}
753
alias to_file='"to_file" ' # last space alias-expands next word
754

    
755
log_bg() { symbol='&' log_custom "$@"; }
756

    
757
log_last_bg() { log_bg '$!='"$!"; }
758

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

    
762
run_args_cmd() # runs the command line args command
763
{
764
	eval set -- "$(reverse "${BASH_ARGV[@]}")"
765
	test $# -ge 1 || set -- all
766
	echo_cmd "$top_script" "$@"; "$@"
767
}
768

    
769
fwd() # usage: subdirs=(...); fwd "$FUNCNAME" "$@"
770
{
771
	echo_func
772
	: "${subdirs?}"
773
	
774
	for subdir in "${subdirs[@]}"; do "$top_dir"/"$subdir"/run "$@"; done
775
}
776

    
777

    
778
#### filesystem
779

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

    
783

    
784
#### URLs
785

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

    
788
fi
(8-8/8)