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_name='echo "${FUNCNAME%%__*}"' # usage: "$(self_name)"
160

    
161
alias self='command "$(self_name)"' # usage: wrapper() { self ...; }
162
alias self_sys='sys_cmd "$(self_name)"' # wrapper() { self_sys ...; }
163

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

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

    
169

    
170
#### exceptions
171

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

    
178
fi # load new aliases
179
if self_being_included; then
180

    
181
# usage: try cmd...; ignore_e status; if catch status; then ...; fi; end_try
182

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

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

    
188
ignore_e() { catch "$@" || true; }
189

    
190
alias end_try='rethrow'
191
alias end_try_subshell='rethrow_subshell'
192

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

    
195
### signals
196

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

    
199
ignore_sig() { ignore "$(sig_e "$1")"; }
200

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

    
205
fi # load new aliases
206
if self_being_included; then
207

    
208

    
209
#### integers
210

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

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

    
216
int2exit() { (( "$1" != 0 )); }
217

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

    
220

    
221
#### floats
222

    
223
int_part() { echo "${1%%.*}"; }
224

    
225
dec_suffix() { echo "${1#$(int_part "$1")}"; }
226

    
227
round_down() { int_part "$1"; }
228

    
229
float+int() { echo "$(($(int_part "$1")+$2))$(dec_suffix "$1")"; }
230

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

    
233

    
234
#### strings
235

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

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

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

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

    
251
fi # load new aliases
252
if self_being_included; then
253

    
254
sed() { sed_cmd "$@"; }
255

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

    
258

    
259
#### arrays
260

    
261
echo1() { echo "$1"; } # usage: echo1 values...
262

    
263
# usage: split delim str; use ${parts[@]}
264
function split() { echo_func; local IFS="$1"; parts=($2); echo_vars parts; }
265
alias split='declare parts; "split"'
266

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

    
269
reverse() # usage: array=($(reverse args...))
270
{
271
	local i
272
	for (( i=$#; i > 0; i-- )); do printf '%q ' "${!i}"; done
273
}
274

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

    
283
#### streams
284

    
285
pipe_delay() # usage: cmd1 | { pipe_delay; cmd2; }
286
{ sleep 0.1; } # s; display after leading output of cmd1
287

    
288

    
289
#### verbose output
290

    
291

    
292
err_fd=2 # stderr
293

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

    
296

    
297
### log++
298

    
299
log_fd=2 # initially stderr
300

    
301
if test "$explicit_errors_only"; then verbosity=0; fi # hide startup logging
302

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

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

    
313
# set log_level
314
: "${log_level=$(( ${#PS4}-1 ))}" # defaults to # non-space symbols in PS4
315
export log_level # propagate to invoked commands
316

    
317
verbosity_int() { round_down "$verbosity"; }
318

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

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

    
339
fi # load new aliases
340
if self_being_included; then
341

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

    
367
verbosity_min() # usage: verbosity_min {min|} # ''->verbosity=''
368
{ if test ! "$1" -o "$(verbosity_int)" -lt "$1"; then verbosity="$1"; fi; }
369
alias verbosity_min='log_local; "verbosity_min"'
370

    
371
# usage: (verbosity_compat; cmd)
372
function verbosity_compat()
373
{ echo_func; if ((verbosity == 1)); then unset verbosity; fi; }
374
alias verbosity_compat='declare verbosity; "verbosity_compat"'
375

    
376

    
377
# indent for call tree. this is *not* the log_level (below).
378
: "${log_indent_step=| }" "${log_indent=}"
379
export log_indent_step log_indent # propagate to invoked commands
380

    
381
# see indent alias in stubs
382

    
383

    
384
fi # load new aliases
385
if self_being_included; then
386

    
387
can_log() { test "$(verbosity_int)" -gt 0; }
388
	# verbosity=0 turns off all logging
389

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

    
392
log_custom() # usage: symbol=... log_custom msg
393
{ log_indent="${log_indent//[^ ]/$symbol}" PS4="${PS4//[^ ]/$symbol}" log "$@";}
394

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

    
397
log_info() { symbol=: log_custom "$@"; }
398

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

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

    
411

    
412
#### functions
413

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

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

    
426
func_override() # usage: func_override old_name__suffix
427
{ from="${1%__*}" to="$1" copy_func; }
428

    
429
ensure_nested_func() # usage: func__nested_func() { ensure_nested_func; ... }
430
{
431
	local nested_func="${FUNCNAME[1]}"
432
	local func="${nested_func%%__*}"
433
	contains "$func" "${FUNCNAME[@]}" || \
434
		die "$nested_func() must be used by $func()"
435
}
436

    
437

    
438
#### paths
439

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

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

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

    
470
canon_rel_path() # usage: [base_dir=...] canon_rel_path path
471
{
472
	kw_params base_dir; local base_dir="${base_dir-$PWD}"
473
	base_dir="$(realpath "$base_dir")" || return
474
	local path; path="$(realpath "$1")" || return
475
	rel_path
476
}
477

    
478
canon_dir_rel_path() # usage: [base_dir=...] canon_dir_rel_path path
479
# if the path is a symlink, just its parent dir will be canonicalized
480
{
481
	kw_params base_dir; local base_dir="${base_dir-$PWD}"
482
	base_dir="$(realpath "$base_dir")" || return
483
	local path; path="$(realpath "$(dirname "$1")")/$(basename "$1")" || return
484
	rel_path
485
}
486

    
487
# makes $1 a canon_rel_path if it's a filesystem path
488
alias cmd2rel_path="$(cat <<'EOF'
489
if test "$(type -t "$1")" = file && test -e "$1"; then # not relative to PATH
490
	declare _1="$1"; shift
491
	_1="$(clog++ canon_rel_path "$_1")" || return
492
	set -- "$_1" "$@"
493
fi
494
EOF
495
)"
496

    
497
# usage: path_parents path; use ${dirs[@]} # includes the path itself
498
function path_parents()
499
{
500
	echo_func; local path="$1" prev_path=; dirs=()
501
	while test "$path" != "$prev_path"; do
502
		prev_path="$path"
503
		dirs+=("$path")
504
		path="${path%/*}"
505
	done
506
}
507
alias path_parents='declare dirs; "path_parents"'
508

    
509

    
510
#### verbose output
511

    
512

    
513
### command echoing
514

    
515
alias echo_params='log "$*"'
516

    
517
fi # load new aliases
518
if self_being_included; then
519

    
520
echo_cmd() { echo_params; }
521

    
522
function echo_run() { echo_params; "$@"; }
523
# see echo_run alias after stub
524

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

    
527
echo_eval() { echo_params; builtin eval "$@"; }
528

    
529
# usage: redirs=(...); [cmd_name_log_inc=#] echo_redirs_cmd
530
function echo_redirs_cmd()
531
{
532
	local cmd_name_log_inc="${cmd_name_log_inc-0}"
533
	
534
	# print <>file redirs before cmd, because they introduce it
535
	"log+" "$cmd_name_log_inc" echo_cmd "$@" $(
536
		set -- "${redirs[@]}" # operate on ${redirs[@]}
537
		while test "$#" -gt 0 && starts_with '[<>][^&]' "$1"
538
		do log "$1 \\"; shift; done # log() will run *before* echo_cmd itself
539
		echo "$@"
540
	)
541
}
542
alias echo_redirs_cmd='"echo_redirs_cmd" "$@"'
543

    
544
## vars
545

    
546
echo_vars() # usage: echo_vars var...
547
{
548
	log+ 2
549
	if can_log; then
550
		local var
551
		for var in "${@%%=*}"; do
552
			if isset "$var"; then log "$(declare -p "$var")"; fi
553
		done
554
	fi
555
}
556

    
557
echo_export() { builtin export "$@"; echo_vars "$@"; }
558

    
559
alias export="echo_export" # automatically echo env vars when they are set
560

    
561
func_override kw_params__lang
562
kw_params() { kw_params__lang "$@"; echo_vars "$@"; } # echo all keyword params
563

    
564
## functions
565

    
566
# usage: local func=...; set_func_loc; use $file, $line
567
alias set_func_loc="$(cat <<'EOF'
568
: "${func:?}"
569
local func_info="$(shopt -s extdebug; declare -F "$func")" # 'func line file'
570
func_info="${func_info#$func }"
571
local line="${func_info%% *}"
572
local file="${func_info#$line }"
573
EOF
574
)"
575

    
576
fi # load new aliases
577
if self_being_included; then
578

    
579
func_loc() # gets where function declared in the format file:line
580
{
581
	local func="$1"; set_func_loc
582
	file="$(canon_rel_path "$file")" || return
583
	echo "$file:$line"
584
}
585

    
586
# usage: func() { [minor=1] echo_func; ... }
587
function echo_func()
588
# usage: "echo_func" "$FUNCNAME" "$@" && indent || true
589
# exit status: whether function call was echoed
590
{
591
	log++; can_log || return
592
	local func="$1"; shift
593
	local loc; loc="$(clog++ func_loc "$func")" || return
594
	echo_cmd "$loc" "$func" "$@"
595
}
596
# see echo_func alias after stub
597

    
598
fi # load new aliases
599
if self_being_included; then
600

    
601

    
602
#### streams
603

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

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

    
609
set_fds() # usage: set_fds redirect...
610
{
611
	echo_func
612
	
613
	# add #<>&- before every #<>&# reopen to fix strange bash bug
614
	local redirs=() i
615
	for i in "$@"; do
616
		local redir_prefix="$(match_prefix '*[<>]' "$i")"
617
		if test "$redir_prefix"; then redirs+=("$redir_prefix&-"); fi
618
		redirs+=("$i")
619
	done
620
	set -- "${redirs[@]}"
621
	
622
	if (($# > 0)); then echo_eval exec "$@"; fi
623
}
624

    
625
fd_set_default() # usage: fd_set_default 'dest[<>]src'
626
{
627
	echo_func
628
	local dest="${1%%[<>]*}"
629
	require_fd_not_exists "$dest" || return 0
630
	set_fds "$1"
631
}
632

    
633
function filter_fd() # usage: (fd=# filter_fd filter_cmd...; with filter...)
634
# useful e.g. to filter logging output or highlight errors
635
{
636
	echo_func; kw_params fd; : "${fd?}"
637
	set_fds "$fd>" >(pipe_delay; redirs=(">&$fd" "${redirs[@]}"); redir "$@")
638
	pipe_delay; pipe_delay # wait for >()'s pipe_delay and initial logging
639
}
640
alias filter_fd='"filter_fd" ' # last space alias-expands next word
641

    
642
# convention: use fd 40/41/42 for command-specific alternate stdin/stdout/stderr
643
# mnemonic: 4 looks like A for Alternate
644
# do NOT use 1x, which are used by eval (which is used by set_fds())
645
# do NOT use 2x, which are used as global stdin/stdout/stderr
646
# do NOT use 3x, which are used for logging
647

    
648
setup_log_fd() # view logging output at verbosity >= 5
649
{
650
	log+ 4; log-- echo_func 
651
	fd_set_default '30>&2' || true # stdlog
652
	log_fd=30 # stdlog
653
}
654
setup_log_fd
655

    
656
set_global_fds()
657
# allows commands to access global stdin/stdout/stderr using fd 20/21/22
658
# this works even when /dev/tty isn't available
659
# view logging output at verbosity >= 3
660
{
661
	log+ 2; log-- echo_func
662
	# ignore errors if a source fd isn't open
663
	fd_set_default '20<&0' || true
664
	fd_set_default '21>&1' || true
665
	fd_set_default '22>&2' || true
666
}
667
set_global_fds
668

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

    
676

    
677
echo_vars is_outermost
678

    
679

    
680
#### paths
681

    
682
top_symlink_dir="$(dirname "$0")"; echo_vars top_symlink_dir
683
top_symlink_dir_abs="$(realpath "$top_symlink_dir")"
684
	echo_vars top_symlink_dir_abs
685

    
686
top_script_abs="$(realpath "$0")"; echo_vars top_script_abs # outermost script
687
	# realpath this before doing any cd so this points to the right place
688
top_dir_abs="$(dirname "$top_script_abs")"; echo_vars top_dir_abs
689

    
690
set_paths()
691
{
692
	top_script="$(clog++ canon_rel_path "$top_script_abs")" || return
693
		echo_vars top_script
694
	top_dir="$(dirname "$top_script")" || return; echo_vars top_dir
695
}
696
set_paths
697

    
698
# usage: in_top_dir cmd...
699
function in_top_dir() { echo_func; (cd "$top_dir"; "$@"); }
700
alias in_top_dir='"in_top_dir" ' # last space alias-expands next word
701

    
702
PATH_rm() # usage: PATH_rm path... # removes components from the PATH
703
{
704
	echo_func; echo_vars PATH; : "${PATH?}"
705
	log+ 2
706
	split : "$PATH"
707
	local new_paths=()
708
	for path in "${parts[@]}"; do
709
		if ! contains "$path" "$@"; then new_paths+=("$path"); fi
710
	done
711
	PATH="$(delim=: join "${new_paths[@]}")" || return
712
	log- 2
713
	echo_vars PATH
714
}
715

    
716
no_PATH_recursion() # usage: (no_PATH_recursion; cmd...)
717
# allows running a system command of the same name as the script
718
{
719
	echo_func
720
	PATH_rm "$top_dir_abs" "$top_symlink_dir" "$top_symlink_dir_abs" "$top_dir"
721
}
722

    
723
# makes command in $1 nonrecursive
724
# allows running a system command of the same name as the script
725
alias cmd2abs_path="$(cat <<'EOF'
726
declare _1="$1"; shift
727
_1="$(indent; no_PATH_recursion; log++; which "$_1"|echo_stdout)" || return
728
set -- "$_1" "$@"
729
EOF
730
)"
731

    
732

    
733
#### verbose output
734

    
735

    
736
## internal commands
737

    
738
.()
739
{
740
	clog++ clog++ echo_func
741
	cmd2rel_path; set -- "$FUNCNAME" "$@"
742
	if (log++; echo_params; can_log); then indent; fi
743
	builtin "$@"
744
}
745

    
746
.rel() # usage: .rel file [args...] # file relative to ${BASH_SOURCE[0]} dir
747
{
748
	clog++ clog++ echo_func; local file="$1"; shift
749
	. "$(canon_rel_path "$(dirname "$(realpath "${BASH_SOURCE[1]}")")/$file")" \
750
"$@"
751
}
752

    
753
cd() # indent is permanent within subshell cd was used in
754
{
755
	log++ echo_func
756
	cmd2rel_path; echo_cmd "$FUNCNAME" "$@"
757
	if can_log; then caller_indent; fi
758
	# -P: expand symlinks so $PWD matches the output of realpath
759
	builtin "$FUNCNAME" -P "$@"
760
	
761
	func=realpath clear_cache
762
	set_paths
763
}
764

    
765
## external commands
766

    
767
disable_logging() { set_fds "$log_fd>/dev/null"; }
768

    
769
function redir() # usage: local redirs=(#<>...); redir cmd...; unset redirs
770
# to view only explicitly-displayed errors: explicit_errors_only=1 script...
771
{
772
	echo_func; kw_params redirs
773
	
774
	case "$1" in redir|command) "$@"; return;; esac # redir will be run later
775
	(
776
		log++ set_fds "${redirs[@]}"
777
		(case "$1" in command__exec) shift;; esac; echo_redirs_cmd)
778
		"$@"
779
	) || return
780
}
781
alias redir='"redir" ' # last space alias-expands next word
782

    
783
alias_append save_e '; unset redirs' # don't redirect error handlers
784

    
785
fi # load new aliases
786
if self_being_included; then
787

    
788
command() # usage: [cmd_log_fd=|1|2|#] [verbosity_min=] [nonrecursive=1] \
789
# command extern_cmd...
790
{
791
	echo_func; kw_params log_fd cmd_log_fd redirs verbosity_min
792
	# if no cmd_log_fd, limit log_fd in case command uses util.sh
793
	local cmd_log_fd="${cmd_log_fd-$log_fd}"
794
	local redirs=("${redirs[@]}")
795
	
796
	# determine redirections
797
	if test "$cmd_log_fd"; then
798
		if can_log; then
799
			if test "$cmd_log_fd" != "$log_fd"; then
800
				redirs+=("$cmd_log_fd>&$log_fd")
801
			fi # else no redir needed
802
		else redirs+=("$cmd_log_fd>/dev/null");
803
		fi
804
	fi
805
	
806
	if test "$nonrecursive"; then cmd2abs_path; else cmd2rel_path; fi
807
	redir command__exec "$@" || die_e
808
}
809
command__exec()
810
{
811
	ensure_nested_func
812
	if can_log; then indent; fi
813
	if test "$verbosity_min"; then verbosity_min "$verbosity_min"; fi
814
	verbosity_compat
815
	builtin command "$@"
816
}
817

    
818

    
819
### external command input/output
820

    
821
echo_stdin() # usage: input|echo_stdin|cmd
822
{
823
	if can_log; then
824
		pipe_delay
825
		echo ----- >&"$log_fd"
826
		tee -a /dev/fd/"$log_fd";
827
		echo ----- >&"$log_fd"
828
	else cat
829
	fi
830
}
831

    
832
echo_stdout() { echo_stdin; } # usage: cmd|echo_stdout
833

    
834

    
835
#### commands
836

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

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

    
843
function to_file() # usage: stdout=... [if_not_exists=1] [del=] to_file cmd...
844
# auto-removes a command's output file on error (like make's .DELETE_ON_ERROR)
845
{
846
	echo_func; kw_params stdout if_not_exists del
847
	: "${stdout?}"; local del="${del-1}"
848
	if test "$if_not_exists"; then require_not_exists "$stdout" || return 0; fi
849
	
850
	local redirs=("${redirs[@]}" ">$stdout")
851
	redir "$@" || { save_e; test ! "$del" || rm "$stdout"; rethrow; }
852
}
853
alias to_file='"to_file" ' # last space alias-expands next word
854

    
855
log_bg() { symbol='&' log_custom "$@"; }
856

    
857
log_last_bg() { log_bg '$!='"$!"; }
858

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

    
862
run_args_cmd() # runs the command line args command
863
{
864
	eval set -- "$(reverse "${BASH_ARGV[@]}")"
865
	test $# -ge 1 || set -- all
866
	echo_cmd "$top_script" "$@"; time "$@"
867
}
868

    
869
fwd() # usage: subdirs=(...); fwd "$FUNCNAME" "$@"
870
{
871
	echo_func
872
	: "${subdirs?}"
873
	
874
	for subdir in "${subdirs[@]}"; do "$top_dir"/"$subdir"/run "$@"; done
875
}
876

    
877

    
878
#### filesystem
879

    
880
alias mkdir='mkdir -p'
881

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

    
885
alias wildcard='shopt -s nullglob; echo' # usage: "$(wildcard glob...)"
886
alias wildcard1='shopt -s nullglob; echo1' # usage: "$(wildcard1 glob...)"
887

    
888
fi # load new aliases
889
if self_being_included; then
890

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

    
893
# usage: (mv_glob ... dir)
894
function mv_glob() { echo_func; if (($# > 1)); then mv2dir "$@"; fi; }
895
alias mv_glob='shopt -s nullglob; "mv_glob"'
896

    
897

    
898
#### URLs
899

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

    
902
fi
(10-10/11)