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() { declare -p "$1" &>/dev/null; }
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
# auto-echo common external commands
54
for cmd in env rm which; do alias "$cmd=echo_run $cmd"; done; unset cmd
55

    
56
echo_builtin() { :; }
57

    
58
function echo_vars() { :; }
59

    
60

    
61
#### vars
62

    
63
set_var() { eval "$1"'="$2"'; }
64

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

    
67
set_inv() { set_var no_"$1" "$(test "${!1}" || echo 1)"; }
68

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

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

    
75
alias local_export='declare -x' # combines effects of local and export
76

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

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

    
91

    
92
#### caching
93

    
94
## shell-variable-based caching
95

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

    
104
clear_cache() # usage: func=... clear_cache
105
{ : "${func:?}"; unset $(prefix="${func}___" get_prefix_vars); }
106

    
107
fi # load new aliases
108
if self_being_included; then
109

    
110

    
111
#### aliases
112

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

    
115
# usage: alias alias_='var=value run_cmd '
116
function run_cmd() { "$@"; }
117
alias run_cmd='"run_cmd" ' # last space alias-expands next word
118

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

    
121

    
122
#### commands
123

    
124
sys_cmd_path() { echo_func; echo_builtin command -p which "$1"|echo_stdout; }
125

    
126
# makes command in $1 a system command
127
# allows running a system command of the same name as the script
128
alias cmd2sys="$(cat <<'EOF'
129
declare _1="$1"; shift
130
_1="$(indent; clog++ sys_cmd_path "$_1")" || return
131
set -- "$_1" "$@"
132
EOF
133
)"
134

    
135
fi # load new aliases
136
if self_being_included; then
137

    
138
sys_cmd() { cmd2sys; command "$@"; } # usage: sys_cmd cmd... # runs system cmd
139
	# allows running a system command of the same name as the script
140

    
141

    
142
#### functions
143

    
144
kw_params() # usage: func() { kw_params param_var...; }; ...; param_var=... cmd
145
# removes keyword-param-only vars from the environment
146
{ unexport "$@"; }
147

    
148
# usage: cmd=... foreach_arg
149
function foreach_arg()
150
{
151
	echo_func; kw_params cmd; : "${cmd:?}"
152
	local a; for a in "$@"; do
153
		a="$(clog++ echo_run "$cmd" "$a")" || return; args+=("$a")
154
	done
155
	echo_vars args
156
}
157
alias foreach_arg='"foreach_arg" "$@"; set -- "${args[@]}"; unset args'
158

    
159
alias self='command "${FUNCNAME%%__*}"' # usage: wrapper() { self ...; }
160
alias self_sys='sys_cmd "${FUNCNAME%%__*}"' # wrapper() { self_sys ...; }
161

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

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

    
167

    
168
#### exceptions
169

    
170
# usage: cmd || { save_e; ...; rethrow; }
171
alias export_e='e=$?'
172
alias save_e='declare e=$?'
173
alias rethrow='return "$e"'
174
alias rethrow_subshell='exit "$e"'
175

    
176
fi # load new aliases
177
if self_being_included; then
178

    
179
# usage: try cmd...; ignore_e status; if catch status; then ...; fi; end_try
180

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

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

    
186
ignore_e() { catch "$@" || true; }
187

    
188
alias end_try='rethrow'
189
alias end_try_subshell='rethrow_subshell'
190

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

    
193
### signals
194

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

    
197
ignore_sig() { ignore "$(sig_e "$1")"; }
198

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

    
203
fi # load new aliases
204
if self_being_included; then
205

    
206

    
207
#### integers
208

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

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

    
214
int2exit() { (( "$1" != 0 )); }
215

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

    
218

    
219
#### floats
220

    
221
int_part() { echo "${1%%.*}"; }
222

    
223
dec_suffix() { echo "${1#$(int_part "$1")}"; }
224

    
225
round_down() { int_part "$1"; }
226

    
227
float+int() { echo "$(($(int_part "$1")+$2))$(dec_suffix "$1")"; }
228

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

    
231

    
232
#### strings
233

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

    
236
match_prefix() # usage: match_prefix pattern str
237
{ if starts_with "$1" "$2"; then echo "${2%${2#$1}}"; fi }
238

    
239
repeat() # usage: str=... n=... repeat
240
{
241
	: "${str?}" "${n:?}"; local result= n="$n" # n will be modified in function
242
	for (( ; n > 0; n-- )); do result="$result$str"; done
243
	echo "$result"
244
}
245

    
246
sed_cmd="sed -`case "$(uname)" in Darwin) echo E;; *) echo r;; esac`"
247
alias sed="$sed_cmd"
248

    
249
fi # load new aliases
250
if self_being_included; then
251

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

    
254

    
255
#### arrays
256

    
257
echo1() { echo "$1"; } # usage: echo1 values...
258

    
259
# usage: split delim str; use ${parts[@]}
260
function split() { echo_func; local IFS="$1"; parts=($2); echo_vars parts; }
261
alias split='declare parts; "split"'
262

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

    
265
reverse() # usage: array=($(reverse args...))
266
{
267
	local i
268
	for (( i=$#; i > 0; i-- )); do printf '%q ' "${!i}"; done
269
}
270

    
271
contains() # usage: contains value in_array...
272
{
273
	local value="$1"; shift
274
	local elem
275
	for elem in "$@"; do if test "$elem" = "$value"; then return 0; fi; done
276
	return 1
277
}
278

    
279
#### streams
280

    
281
pipe_delay() # usage: cmd1 | { pipe_delay; cmd2; }
282
{ sleep 0.1; } # s; display after leading output of cmd1
283

    
284

    
285
#### verbose output
286

    
287

    
288
err_fd=2 # stderr
289

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

    
292

    
293
### log++
294

    
295
log_fd=2 # initially stderr
296

    
297
if test "$explicit_errors_only"; then verbosity=0; fi # hide startup logging
298

    
299
# set verbosity
300
if isset verbose; then : "${verbosity:=$(bool2int "$verbose")}"; fi
301
if isset vb; then : "${verbosity:=$vb}"; fi
302
: "${verbosity=1}" # default
303
: "${verbosity:=0}" # ensure non-empty
304
export verbosity # propagate to invoked commands
305
export PS4 # follows verbosity, so also propagate this
306

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

    
309
# set log_level
310
: "${log_level=$(( ${#PS4}-1 ))}" # defaults to # non-space symbols in PS4
311
export log_level # propagate to invoked commands
312

    
313
verbosity_int() { round_down "$verbosity"; }
314

    
315
# verbosities (and `make` equivalents):
316
# 0: just print errors. useful for cron jobs.
317
#    vs. make: equivalent to --silent, but suppresses external command output
318
# 1: also external commands run. useful for running at the command line.
319
#    vs. make: not provided (but sorely needed to avoid excessive output)
320
# 2: full graphical call tree. useful for determining where error occurred.
321
#    vs. make: equivalent to default verbosity, but with much-needed indents
322
# 3: also values of kw params and variables. useful for low-level debugging.
323
#    vs. make: not provided; need to manually use $(error $(var))
324
# 4: also variables in util.sh commands. useful for debugging util.sh.
325
#    vs. make: somewhat similar to --print-data-base
326
# 5: also variables in logging commands themselves. useful for debugging echo_*.
327
#    vs. make: not provided; need to search Makefile for @ at beginning of cmd
328
# 6+: not currently used (i.e. same as 5)
329

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

    
335
fi # load new aliases
336
if self_being_included; then
337

    
338
# usage: in func:      log++; ...         OR  log_local; "log++"; ...
339
#        outside func: log++; ...; log--
340
#        before cmd:  "log++" cmd  OR  "log+" # cmd  OR  "log++" "log++" cmd
341
# with a cmd, assignments are applied just to it, so log_local is not needed
342
# without a cmd, "$@" expands to nothing and assignments are applied to caller
343
# "${@:2}" expands to all of $@ after *1st* arg, not 2nd ($@ indexes start at 1)
344
log+()
345
{
346
	# no local vars because w/o cmd, assignments should be applied to caller
347
	PS4="$(str="${PS4:0:1}" n=$((log_level+$1-1)) repeat)${PS4: -2}"; \
348
	log_level=$((log_level+$1)) \
349
	verbosity="$(float+int "$verbosity" "-$1")" "${@:2}"
350
}
351
log++() { log+  1 "$@"; }
352
log--() { log+ -1 "$@"; }
353
alias log_local=\
354
'declare PS4="$PS4" log_level="$log_level" verbosity="$verbosity"'
355
alias log+='log_local; "log+"' # don't expand next word because it's not a cmd
356
alias log++='log_local; "log++" ' # last space alias-expands next word
357
alias log--='log_local; "log--" ' # last space alias-expands next word
358
# no clog+ alias because next word is not a cmd
359
alias clog++='"log++" ' # last space alias-expands next word
360
alias clog--='"log--" ' # last space alias-expands next word
361

    
362
verbosity_min() # usage: verbosity_min {min|} # ''->verbosity=''
363
{ if test ! "$1" -o "$(verbosity_int)" -lt "$1"; then verbosity="$1"; fi; }
364
alias verbosity_min='log_local; "verbosity_min"'
365

    
366
# usage: (verbosity_compat; cmd)
367
function verbosity_compat()
368
{ echo_func; if ((verbosity == 1)); then unset verbosity; fi; }
369
alias verbosity_compat='declare verbosity; "verbosity_compat"'
370

    
371

    
372
# indent for call tree. this is *not* the log_level (below).
373
: "${log_indent_step=| }" "${log_indent=}"
374
export log_indent_step log_indent # propagate to invoked commands
375

    
376
# see indent alias in stubs
377

    
378

    
379
fi # load new aliases
380
if self_being_included; then
381

    
382
can_log() { test "$(verbosity_int)" -gt 0; }
383
	# verbosity=0 turns off all logging
384

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

    
387
log_custom() # usage: symbol=... log_custom msg
388
{ log_indent="${log_indent//[^ ]/$symbol}" PS4="${PS4//[^ ]/$symbol}" log "$@";}
389

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

    
392
log_info() { symbol=: log_custom "$@"; }
393

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

    
397
die_e() # usage: cmd || [benign_error=1] die_e [|| handle error]
398
{
399
	save_e; kw_params benign_error
400
	if test "$benign_error"; then log++; fi
401
	type="${benign_error:+info}" die "command exited with \
402
$(if test "$benign_error"; then echo status; else echo error; fi) $e"
403
	rethrow
404
}
405

    
406

    
407
#### functions
408

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

    
411
copy_func() # usage: from=... to=... copy_func
412
# $to must not exist. to get around the no-clobber restriction, use `unset -f`.
413
{
414
	: "${from:?}" "${to:?}"
415
	func_exists "$from" || die "function does not exist: $from"
416
	! func_exists "$to" || die "function already exists: $to"
417
	local from_def="$(declare -f "$from")"
418
	eval "$to${from_def#$from}"
419
}
420

    
421
func_override() # usage: func_override old_name__suffix
422
{ from="${1%__*}" to="$1" copy_func; }
423

    
424
ensure_nested_func() # usage: func__nested_func() { ensure_nested_func; ... }
425
{
426
	local nested_func="${FUNCNAME[1]}"
427
	local func="${nested_func%%__*}"
428
	contains "$func" "${FUNCNAME[@]}" || \
429
		die "$nested_func() must be used by $func()"
430
}
431

    
432

    
433
#### paths
434

    
435
# cache realpath
436
: "${realpath_cache=}" # default off because slower than without
437
if test "$realpath_cache"; then
438
func_override realpath__no_cache
439
realpath() # caches the last result for efficiency
440
{
441
	local cache_key="$*"; load_cache
442
	if ! cached; then save_cache "$(realpath__no_cache "$@")" || return; fi
443
	echo_cached_value
444
}
445
fi
446

    
447
rel_path() # usage: base_dir=... path=... rel_path
448
{
449
	kw_params base_dir path
450
	: "${base_dir:?}" "${path:?}"
451
	
452
	local path="$path/" # add *extra* / to match path when exactly = base_dir
453
	path="${path#$base_dir/}" # remove prefix shared with base_dir
454
	path="${path%/}" # remove any remaining extra trailing /
455
	
456
	if test ! "$path"; then path=.; fi # ensure non-empty
457
	
458
	echo_vars path
459
	echo "$path"
460
}
461

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

    
465
canon_rel_path() # usage: [base_dir=...] canon_rel_path path
466
{
467
	kw_params base_dir; local base_dir="${base_dir-$PWD}"
468
	base_dir="$(realpath "$base_dir")" || return
469
	local path; path="$(realpath "$1")" || return
470
	rel_path
471
}
472

    
473
# makes $1 a canon_rel_path if it's a filesystem path
474
alias cmd2rel_path="$(cat <<'EOF'
475
if test "$(type -t "$1")" = file && test -e "$1"; then # not relative to PATH
476
	declare _1="$1"; shift
477
	_1="$(clog++ canon_rel_path "$_1")" || return
478
	set -- "$_1" "$@"
479
fi
480
EOF
481
)"
482

    
483
# usage: path_parents path; use ${dirs[@]} # includes the path itself
484
function path_parents()
485
{
486
	echo_func; local path="$1" prev_path=; dirs=()
487
	while test "$path" != "$prev_path"; do
488
		prev_path="$path"
489
		dirs+=("$path")
490
		path="${path%/*}"
491
	done
492
}
493
alias path_parents='declare dirs; "path_parents"'
494

    
495

    
496
#### verbose output
497

    
498

    
499
### command echoing
500

    
501
alias echo_params='log "$*"'
502

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

    
506
echo_cmd() { echo_params; }
507

    
508
function echo_run() { echo_params; "$@"; }
509
# see echo_run alias after stub
510

    
511
echo_builtin() { echo_run builtin "$@"; } # usage: echo_builtin builtin_cmd...
512

    
513
echo_eval() { echo_params; builtin eval "$@"; }
514

    
515
# usage: redirs=(...); [cmd_name_log_inc=#] echo_redirs_cmd
516
function echo_redirs_cmd()
517
{
518
	local cmd_name_log_inc="${cmd_name_log_inc-0}"
519
	
520
	# print <>file redirs before cmd, because they introduce it
521
	"log+" "$cmd_name_log_inc" echo_cmd "$@" $(
522
		set -- "${redirs[@]}" # operate on ${redirs[@]}
523
		while test "$#" -gt 0 && starts_with '[<>][^&]' "$1"
524
		do log "$1 \\"; shift; done # log() will run *before* echo_cmd itself
525
		echo "$@"
526
	)
527
}
528
alias echo_redirs_cmd='"echo_redirs_cmd" "$@"'
529

    
530
## vars
531

    
532
echo_vars() # usage: echo_vars var...
533
{
534
	log+ 2
535
	if can_log; then
536
		local var
537
		for var in "${@%%=*}"; do
538
			if isset "$var"; then log "$(declare -p "$var")"; fi
539
		done
540
	fi
541
}
542

    
543
echo_export() { builtin export "$@"; echo_vars "$@"; }
544

    
545
alias export="echo_export" # automatically echo env vars when they are set
546

    
547
func_override kw_params__lang
548
kw_params() { kw_params__lang "$@"; echo_vars "$@"; } # echo all keyword params
549

    
550
## functions
551

    
552
# usage: local func=...; set_func_loc; use $file, $line
553
alias set_func_loc="$(cat <<'EOF'
554
: "${func:?}"
555
local func_info="$(shopt -s extdebug; declare -F "$func")" # 'func line file'
556
func_info="${func_info#$func }"
557
local line="${func_info%% *}"
558
local file="${func_info#$line }"
559
EOF
560
)"
561

    
562
fi # load new aliases
563
if self_being_included; then
564

    
565
func_loc() # gets where function declared in the format file:line
566
{
567
	local func="$1"; set_func_loc
568
	file="$(canon_rel_path "$file")" || return
569
	echo "$file:$line"
570
}
571

    
572
# usage: func() { [minor=1] echo_func; ... }
573
function echo_func()
574
# usage: "echo_func" "$FUNCNAME" "$@" && indent || true
575
# exit status: whether function call was echoed
576
{
577
	log++; can_log || return
578
	local func="$1"; shift
579
	local loc; loc="$(clog++ func_loc "$func")" || return
580
	echo_cmd "$loc" "$func" "$@"
581
}
582
# see echo_func alias after stub
583

    
584
fi # load new aliases
585
if self_being_included; then
586

    
587

    
588
#### streams
589

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

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

    
595
set_fds() # usage: set_fds redirect...
596
{
597
	echo_func
598
	
599
	# add #<>&- before every #<>&# reopen to fix strange bash bug
600
	local redirs=() i
601
	for i in "$@"; do
602
		local redir_prefix="$(match_prefix '*[<>]' "$i")"
603
		if test "$redir_prefix"; then redirs+=("$redir_prefix&-"); fi
604
		redirs+=("$i")
605
	done
606
	set -- "${redirs[@]}"
607
	
608
	if (($# > 0)); then echo_eval exec "$@"; fi
609
}
610

    
611
fd_set_default() # usage: fd_set_default 'dest[<>]src'
612
{
613
	echo_func
614
	local dest="${1%%[<>]*}"
615
	require_fd_not_exists "$dest" || return 0
616
	set_fds "$1"
617
}
618

    
619
function filter_fd() # usage: (fd=# filter_fd filter_cmd...; with filter...)
620
# useful e.g. to filter logging output or highlight errors
621
{
622
	echo_func; kw_params fd; : "${fd?}"
623
	set_fds "$fd>" >(pipe_delay; redirs=(">&$fd" "${redirs[@]}"); redir "$@")
624
	pipe_delay; pipe_delay # wait for >()'s pipe_delay and initial logging
625
}
626
alias filter_fd='"filter_fd" ' # last space alias-expands next word
627

    
628
# convention: use fd 40/41/42 for command-specific alternate stdin/stdout/stderr
629
# mnemonic: 4 looks like A for Alternate
630
# do NOT use 1x, which are used by eval (which is used by set_fds())
631
# do NOT use 2x, which are used as global stdin/stdout/stderr
632
# do NOT use 3x, which are used for logging
633

    
634
setup_log_fd() # view logging output at verbosity >= 5
635
{
636
	log+ 4; log-- echo_func 
637
	fd_set_default '30>&2' || true # stdlog
638
	log_fd=30 # stdlog
639
}
640
setup_log_fd
641

    
642
set_global_fds()
643
# allows commands to access global stdin/stdout/stderr using fd 20/21/22
644
# this works even when /dev/tty isn't available
645
# view logging output at verbosity >= 3
646
{
647
	log+ 2; log-- echo_func
648
	# ignore errors if a source fd isn't open
649
	fd_set_default '20<&0' || true
650
	fd_set_default '21>&1' || true
651
	fd_set_default '22>&2' || true
652
}
653
set_global_fds
654

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

    
662

    
663
echo_vars is_outermost
664

    
665

    
666
#### paths
667

    
668
top_symlink_dir="$(dirname "$0")"; echo_vars top_symlink_dir
669
top_symlink_dir_abs="$(realpath "$top_symlink_dir")"
670
	echo_vars top_symlink_dir_abs
671

    
672
top_script_abs="$(realpath "$0")"; echo_vars top_script_abs # outermost script
673
	# realpath this before doing any cd so this points to the right place
674
top_dir_abs="$(dirname "$top_script_abs")"; echo_vars top_dir_abs
675

    
676
set_paths()
677
{
678
	top_script="$(clog++ canon_rel_path "$top_script_abs")" || return
679
		echo_vars top_script
680
	top_dir="$(dirname "$top_script")" || return; echo_vars top_dir
681
}
682
set_paths
683

    
684
# usage: in_top_dir cmd...
685
function in_top_dir() { echo_func; (cd "$top_dir"; "$@"); }
686
alias in_top_dir='"in_top_dir" ' # last space alias-expands next word
687

    
688
PATH_rm() # usage: PATH_rm path... # removes components from the PATH
689
{
690
	echo_func; echo_vars PATH; : "${PATH?}"
691
	log+ 2
692
	split : "$PATH"
693
	local new_paths=()
694
	for path in "${parts[@]}"; do
695
		if ! contains "$path" "$@"; then new_paths+=("$path"); fi
696
	done
697
	PATH="$(delim=: join "${new_paths[@]}")" || return
698
	log+ -2
699
	echo_vars PATH
700
}
701

    
702
no_PATH_recursion() # usage: (no_PATH_recursion; cmd...)
703
# allows running a system command of the same name as the script
704
{
705
	echo_func
706
	PATH_rm "$top_dir_abs" "$top_symlink_dir" "$top_symlink_dir_abs" "$top_dir"
707
}
708

    
709
# makes command in $1 nonrecursive
710
# allows running a system command of the same name as the script
711
alias cmd2abs_path="$(cat <<'EOF'
712
declare _1="$1"; shift
713
_1="$(indent; no_PATH_recursion; log++; which "$_1"|echo_stdout)" || return
714
set -- "$_1" "$@"
715
EOF
716
)"
717

    
718

    
719
#### verbose output
720

    
721

    
722
## internal commands
723

    
724
.()
725
{
726
	clog++ clog++ echo_func
727
	cmd2rel_path; set -- "$FUNCNAME" "$@"
728
	if (log++; echo_params; can_log); then indent; fi
729
	builtin "$@"
730
}
731

    
732
.rel() # usage: .rel file [args...] # file relative to ${BASH_SOURCE[0]} dir
733
{
734
	clog++ clog++ echo_func; local file="$1"; shift
735
	. "$(canon_rel_path "$(dirname "$(realpath "${BASH_SOURCE[1]}")")/$file")" \
736
"$@"
737
}
738

    
739
cd() # indent is permanent within subshell cd was used in
740
{
741
	log++ echo_func
742
	cmd2rel_path; echo_cmd "$FUNCNAME" "$@"
743
	if can_log; then caller_indent; fi
744
	# -P: expand symlinks so $PWD matches the output of realpath
745
	builtin "$FUNCNAME" -P "$@"
746
	
747
	func=realpath clear_cache
748
	set_paths
749
}
750

    
751
## external commands
752

    
753
disable_logging() { set_fds "$log_fd>/dev/null"; }
754

    
755
function redir() # usage: local redirs=(#<>...); redir cmd...; unset redirs
756
# to view only explicitly-displayed errors: explicit_errors_only=1 script...
757
{
758
	echo_func; kw_params redirs
759
	
760
	case "$1" in redir|command) "$@"; return;; esac # redir will be run later
761
	(
762
		log++ set_fds "${redirs[@]}"
763
		(case "$1" in command__exec) shift;; esac; echo_redirs_cmd)
764
		"$@"
765
	) || return
766
}
767
alias redir='"redir" ' # last space alias-expands next word
768

    
769
alias_append save_e '; unset redirs' # don't redirect error handlers
770

    
771
fi # load new aliases
772
if self_being_included; then
773

    
774
command() # usage: [cmd_log_fd=|1|2|#] [verbosity_min=] [nonrecursive=1] \
775
# command extern_cmd...
776
{
777
	echo_func; kw_params log_fd cmd_log_fd redirs verbosity_min
778
	# if no cmd_log_fd, limit log_fd in case command uses util.sh
779
	local cmd_log_fd="${cmd_log_fd-$log_fd}"
780
	local redirs=("${redirs[@]}")
781
	
782
	# determine redirections
783
	if test "$cmd_log_fd"; then
784
		if can_log; then
785
			if test "$cmd_log_fd" != "$log_fd"; then
786
				redirs+=("$cmd_log_fd>&$log_fd")
787
			fi # else no redir needed
788
		else redirs+=("$cmd_log_fd>/dev/null");
789
		fi
790
	fi
791
	
792
	if test "$nonrecursive"; then cmd2abs_path; else cmd2rel_path; fi
793
	redir command__exec "$@" || die_e
794
}
795
command__exec()
796
{
797
	ensure_nested_func
798
	if can_log; then indent; fi
799
	if test "$verbosity_min"; then verbosity_min "$verbosity_min"; fi
800
	verbosity_compat
801
	builtin command "$@"
802
}
803

    
804

    
805
### external command input/output
806

    
807
echo_stdin() # usage: input|echo_stdin|cmd
808
{
809
	if can_log; then
810
		pipe_delay
811
		echo ----- >&"$log_fd"
812
		tee -a /dev/fd/"$log_fd";
813
		echo ----- >&"$log_fd"
814
	else cat
815
	fi
816
}
817

    
818
echo_stdout() { echo_stdin; } # usage: cmd|echo_stdout
819

    
820

    
821
#### commands
822

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

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

    
829
function to_file() # usage: stdout=... [if_not_exists=1] [del=] to_file cmd...
830
# auto-removes a command's output file on error (like make's .DELETE_ON_ERROR)
831
{
832
	echo_func; kw_params stdout if_not_exists del
833
	: "${stdout?}"; local del="${del-1}"
834
	if test "$if_not_exists"; then require_not_exists "$stdout" || return 0; fi
835
	
836
	local redirs=("${redirs[@]}" ">$stdout")
837
	redir "$@" || { save_e; test ! "$del" || rm "$stdout"; rethrow; }
838
}
839
alias to_file='"to_file" ' # last space alias-expands next word
840

    
841
log_bg() { symbol='&' log_custom "$@"; }
842

    
843
log_last_bg() { log_bg '$!='"$!"; }
844

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

    
848
run_args_cmd() # runs the command line args command
849
{
850
	eval set -- "$(reverse "${BASH_ARGV[@]}")"
851
	test $# -ge 1 || set -- all
852
	echo_cmd "$top_script" "$@"; time "$@"
853
}
854

    
855
fwd() # usage: subdirs=(...); fwd "$FUNCNAME" "$@"
856
{
857
	echo_func
858
	: "${subdirs?}"
859
	
860
	for subdir in "${subdirs[@]}"; do "$top_dir"/"$subdir"/run "$@"; done
861
}
862

    
863

    
864
#### filesystem
865

    
866
alias mkdir='mkdir -p'
867

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

    
871
alias wildcard='shopt -s nullglob; echo' # usage: "$(wildcard glob...)"
872
alias wildcard1='shopt -s nullglob; echo1' # usage: "$(wildcard1 glob...)"
873

    
874
fi # load new aliases
875
if self_being_included; then
876

    
877
mv2dir() { echo_func; mkdir "${!#}"; mv "$@"; } # usage: mv2dir ... dir
878

    
879
# usage: (mv_glob ... dir)
880
function mv_glob() { echo_func; if (($# > 1)); then mv2dir "$@"; fi; }
881
alias mv_glob='shopt -s nullglob; "mv_glob"'
882

    
883

    
884
#### URLs
885

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

    
888
fi
(9-9/10)