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
# makes command in $1 a system command
125
# allows running a system command of the same name as the script
126
alias cmd2sys="$(cat <<'EOF'
127
declare _1="$1"; shift
128
_1="$(indent; log++; echo_builtin command -p which "$_1"|echo_stdout)" || return
129
set -- "$_1" "$@"
130
EOF
131
)"
132

    
133
fi # load new aliases
134
if self_being_included; then
135

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

    
139

    
140
#### functions
141

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

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

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

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

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

    
165

    
166
#### exceptions
167

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

    
174
fi # load new aliases
175
if self_being_included; then
176

    
177
# usage: try cmd...; ignore_e status; if catch status; then ...; fi; end_try
178

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

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

    
184
ignore_e() { catch "$@" || true; }
185

    
186
alias end_try='rethrow'
187
alias end_try_subshell='rethrow_subshell'
188

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

    
191
### signals
192

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

    
195
ignore_sig() { ignore "$(sig_e "$1")"; }
196

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

    
201
fi # load new aliases
202
if self_being_included; then
203

    
204

    
205
#### integers
206

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

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

    
212
int2exit() { (( "$1" != 0 )); }
213

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

    
216

    
217
#### floats
218

    
219
int_part() { echo "${1%%.*}"; }
220

    
221
dec_suffix() { echo "${1#$(int_part "$1")}"; }
222

    
223
round_down() { int_part "$1"; }
224

    
225
float+int() { echo "$(($(int_part "$1")+$2))$(dec_suffix "$1")"; }
226

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

    
229

    
230
#### strings
231

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

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

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

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

    
247
fi # load new aliases
248
if self_being_included; then
249

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

    
252

    
253
#### arrays
254

    
255
echo1() { echo "$1"; } # usage: echo1 values...
256

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

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

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

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

    
277
#### streams
278

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

    
282

    
283
#### verbose output
284

    
285

    
286
err_fd=2 # stderr
287

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

    
290

    
291
### log++
292

    
293
log_fd=2 # initially stderr
294

    
295
if test "$explicit_errors_only"; then verbosity=0; fi # hide startup logging
296

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

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

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

    
311
verbosity_int() { round_down "$verbosity"; }
312

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

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

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

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

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

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

    
369

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

    
374
# see indent alias in stubs
375

    
376

    
377
fi # load new aliases
378
if self_being_included; then
379

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

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

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

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

    
390
log_info() { symbol=: log_custom "$@"; }
391

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

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

    
404

    
405
#### functions
406

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

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

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

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

    
430

    
431
#### paths
432

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

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

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

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

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

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

    
493

    
494
#### verbose output
495

    
496

    
497
### command echoing
498

    
499
alias echo_params='log "$*"'
500

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

    
504
echo_cmd() { echo_params; }
505

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

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

    
511
echo_eval() { echo_params; builtin eval "$@"; }
512

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

    
528
## vars
529

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

    
541
echo_export() { builtin export "$@"; echo_vars "$@"; }
542

    
543
alias export="echo_export" # automatically echo env vars when they are set
544

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

    
548
## functions
549

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

    
560
fi # load new aliases
561
if self_being_included; then
562

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

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

    
582
fi # load new aliases
583
if self_being_included; then
584

    
585

    
586
#### streams
587

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

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

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

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

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

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

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

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

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

    
660

    
661
echo_vars is_outermost
662

    
663

    
664
#### paths
665

    
666
top_symlink_dir="$(dirname "$0")"; echo_vars top_symlink_dir
667
top_symlink_dir_abs="$(realpath "$top_symlink_dir")"
668
	echo_vars top_symlink_dir_abs
669

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

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

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

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

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

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

    
716

    
717
#### verbose output
718

    
719

    
720
## internal commands
721

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

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

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

    
748
## external commands
749

    
750
disable_logging() { set_fds "$log_fd>/dev/null"; }
751

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

    
766
alias_append save_e '; unset redirs' # don't redirect error handlers
767

    
768
fi # load new aliases
769
if self_being_included; then
770

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

    
801

    
802
### external command input/output
803

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

    
815
echo_stdout() { echo_stdin; } # usage: cmd|echo_stdout
816

    
817

    
818
#### commands
819

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

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

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

    
838
log_bg() { symbol='&' log_custom "$@"; }
839

    
840
log_last_bg() { log_bg '$!='"$!"; }
841

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

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

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

    
860

    
861
#### filesystem
862

    
863
alias mkdir='mkdir -p'
864

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

    
868
alias wildcard='shopt -s nullglob; echo' # usage: "$(wildcard glob...)"
869
alias wildcard1='shopt -s nullglob; echo1' # usage: "$(wildcard1 glob...)"
870

    
871
fi # load new aliases
872
if self_being_included; then
873

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

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

    
880

    
881
#### URLs
882

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

    
885
fi
(9-9/10)