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
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
# usage: cmd=... foreach_arg
124
function foreach_arg()
125
{
126
	echo_func; kw_params cmd; : "${cmd:?}"
127
	local a; for a in "$@"; do
128
		a="$(clog++ echo_run "$cmd" "$a")" || return; args+=("$a")
129
	done
130
	echo_vars args
131
}
132
alias foreach_arg='"foreach_arg" "$@"; set -- "${args[@]}"; unset args'
133

    
134
alias self='command "${FUNCNAME%%__*}"' # usage: wrapper() { self ...; }
135
alias self_sys='command -p "${FUNCNAME%%__*}"' # wrapper() { self_sys ...; }
136

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

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

    
142

    
143
#### exceptions
144

    
145
# usage: cmd || { save_e; ...; rethrow; }
146
alias export_e='e=$?'
147
alias save_e='declare e=$?'
148
alias rethrow='return "$e"'
149
alias rethrow_subshell='exit "$e"'
150

    
151
fi # load new aliases
152
if self_being_included; then
153

    
154
# usage: try cmd...; ignore_e status; if catch status; then ...; fi; end_try
155

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

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

    
161
ignore_e() { catch "$@" || true; }
162

    
163
alias end_try='rethrow'
164
alias end_try_subshell='rethrow_subshell'
165

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

    
168
### signals
169

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

    
172
ignore_sig() { ignore "$(sig_e "$1")"; }
173

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

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

    
181

    
182
#### integers
183

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

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

    
189
int2exit() { (( "$1" != 0 )); }
190

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

    
193

    
194
#### floats
195

    
196
int_part() { echo "${1%%.*}"; }
197

    
198
dec_suffix() { echo "${1#$(int_part "$1")}"; }
199

    
200
round_down() { int_part "$1"; }
201

    
202
float+int() { echo "$(($(int_part "$1")+$2))$(dec_suffix "$1")"; }
203

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

    
206

    
207
#### strings
208

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

    
211
match_prefix() # usage: match_prefix pattern str
212
{ if starts_with "$1" "$2"; then echo "${2%${2#$1}}"; fi }
213

    
214
repeat() # usage: str=... n=... repeat
215
{
216
	: "${str?}" "${n:?}"; local result= n="$n" # n will be modified in function
217
	for (( ; n > 0; n-- )); do result="$result$str"; done
218
	echo "$result"
219
}
220

    
221
sed_cmd="sed -`case "$(uname)" in Darwin) echo E;; *) echo r;; esac`"
222
alias sed="$sed_cmd"
223

    
224
fi # load new aliases
225
if self_being_included; then
226

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

    
229

    
230
#### arrays
231

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

    
234
reverse() # usage: array=($(reverse args...))
235
{
236
	local i
237
	for (( i=$#; i > 0; i-- )); do printf '%q ' "${!i}"; done
238
}
239

    
240
contains() # usage: contains value in_array...
241
{
242
	local value="$1"; shift
243
	local elem
244
	for elem in "$@"; do if test "$elem" = "$value"; then return 0; fi; done
245
	return 1
246
}
247

    
248
#### streams
249

    
250
pipe_delay() # usage: cmd1 | { pipe_delay; cmd2; }
251
{ sleep 0.1; } # s; display after leading output of cmd1
252

    
253

    
254
#### verbose output
255

    
256

    
257
err_fd=2 # stderr
258

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

    
261

    
262
### log++
263

    
264
log_fd=2 # initially stderr
265

    
266
if test "$explicit_errors_only"; then verbosity=0; fi # hide startup logging
267

    
268
# set verbosity
269
if isset verbose; then : "${verbosity:=$(bool2int "$verbose")}"; fi
270
if isset vb; then : "${verbosity:=$vb}"; fi
271
: "${verbosity=1}" # default
272
: "${verbosity:=0}" # ensure non-empty
273
export verbosity # propagate to invoked commands
274
export PS4 # follows verbosity, so also propagate this
275

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

    
278
# set log_level
279
: "${log_level=$(( ${#PS4}-1 ))}" # defaults to # non-space symbols in PS4
280
export log_level # propagate to invoked commands
281

    
282
verbosity_int() { round_down "$verbosity"; }
283

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

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

    
304
fi # load new aliases
305
if self_being_included; then
306

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

    
331
verbosity_min() # usage: verbosity_min {min|} # ''->verbosity=''
332
{ if test ! "$1" -o "$(verbosity_int)" -lt "$1"; then verbosity="$1"; fi; }
333
alias verbosity_min='log_local; "verbosity_min"'
334

    
335
# usage: (verbosity_compat; cmd)
336
function verbosity_compat()
337
{ echo_func; if ((verbosity == 1)); then unset verbosity; fi; }
338
alias verbosity_compat='declare verbosity; "verbosity_compat"'
339

    
340

    
341
# indent for call tree. this is *not* the log_level (below).
342
: "${log_indent_step=| }" "${log_indent=}"
343
export log_indent_step log_indent # propagate to invoked commands
344

    
345
# see indent alias in stubs
346

    
347

    
348
fi # load new aliases
349
if self_being_included; then
350

    
351
can_log() { test "$(verbosity_int)" -gt 0; }
352
	# verbosity=0 turns off all logging
353

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

    
356
log_custom() # usage: symbol=... log_custom msg
357
{ log_indent="${log_indent//[^ ]/$symbol}" PS4="${PS4//[^ ]/$symbol}" log "$@";}
358

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

    
361
log_info() { symbol=: log_custom "$@"; }
362

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

    
366
die_e() # usage: cmd || [benign_error=1] die_e [|| handle error]
367
{
368
	save_e; kw_params benign_error
369
	if test "$benign_error"; then log++; fi
370
	type="${benign_error:+info}" die "command exited with \
371
$(if test "$benign_error"; then echo status; else echo error; fi) $e"
372
	rethrow
373
}
374

    
375

    
376
#### functions
377

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

    
380
copy_func() # usage: from=... to=... copy_func
381
# $to must not exist. to get around the no-clobber restriction, use `unset -f`.
382
{
383
	: "${from:?}" "${to:?}"
384
	func_exists "$from" || die "function does not exist: $from"
385
	! func_exists "$to" || die "function already exists: $to"
386
	local from_def="$(declare -f "$from")"
387
	eval "$to${from_def#$from}"
388
}
389

    
390
func_override() # usage: func_override old_name__suffix
391
{ from="${1%__*}" to="$1" copy_func; }
392

    
393
ensure_nested_func() # usage: func__nested_func() { ensure_nested_func; ... }
394
{
395
	local nested_func="${FUNCNAME[1]}"
396
	local func="${nested_func%%__*}"
397
	contains "$func" "${FUNCNAME[@]}" || \
398
		die "$nested_func() must be used by $func()"
399
}
400

    
401

    
402
#### paths
403

    
404
# cache realpath
405
: "${realpath_cache=}" # default off because slower than without
406
if test "$realpath_cache"; then
407
func_override realpath__no_cache
408
realpath() # caches the last result for efficiency
409
{
410
	local cache_key="$*"; load_cache
411
	if ! cached; then save_cache "$(realpath__no_cache "$@")" || return; fi
412
	echo_cached_value
413
}
414
fi
415

    
416
rel_path() # usage: base_dir=... path=... rel_path
417
{
418
	kw_params base_dir path
419
	: "${base_dir:?}" "${path:?}"
420
	
421
	local path="$path/" # add *extra* / to match path when exactly = base_dir
422
	path="${path#$base_dir/}" # remove prefix shared with base_dir
423
	path="${path%/}" # remove any remaining extra trailing /
424
	
425
	if test ! "$path"; then path=.; fi # ensure non-empty
426
	
427
	echo_vars path
428
	echo "$path"
429
}
430

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

    
434
canon_rel_path() # usage: [base_dir=...] canon_rel_path path
435
{
436
	kw_params base_dir; local base_dir="${base_dir-$PWD}"
437
	base_dir="$(realpath "$base_dir")" || return
438
	local path; path="$(realpath "$1")" || return
439
	rel_path
440
}
441

    
442
# makes $1 a canon_rel_path if it's a filesystem path
443
alias cmd2rel_path="$(cat <<'EOF'
444
if test "$(type -t "$1")" = file && test -e "$1"; then # not relative to PATH
445
	declare _1="$1"; shift
446
	_1="$(clog++ canon_rel_path "$_1")" || return
447
	set -- "$_1" "$@"
448
fi
449
EOF
450
)"
451

    
452
# usage: path_parents path; use ${dirs[@]} # includes the path itself
453
function path_parents()
454
{
455
	echo_func; local path="$1" prev_path=; dirs=()
456
	while test "$path" != "$prev_path"; do
457
		prev_path="$path"
458
		dirs+=("$path")
459
		path="${path%/*}"
460
	done
461
}
462
alias path_parents='declare dirs; "path_parents"'
463

    
464

    
465
#### verbose output
466

    
467

    
468
### command echoing
469

    
470
alias echo_params='log "$*"'
471

    
472
fi # load new aliases
473
if self_being_included; then
474

    
475
echo_cmd() { echo_params; }
476

    
477
function echo_run() { echo_params; "$@"; }
478
# see echo_run alias after stub
479

    
480
echo_eval() { echo_params; builtin eval "$@"; }
481

    
482
# usage: redirs=(...); [cmd_name_log_inc=#] echo_redirs_cmd
483
function echo_redirs_cmd()
484
{
485
	local cmd_name_log_inc="${cmd_name_log_inc-0}"
486
	
487
	# print <>file redirs before cmd, because they introduce it
488
	"log+" "$cmd_name_log_inc" echo_cmd "$@" $(
489
		set -- "${redirs[@]}" # operate on ${redirs[@]}
490
		while test "$#" -gt 0 && starts_with '[<>][^&]' "$1"
491
		do log "$1 \\"; shift; done # log() will run *before* echo_cmd itself
492
		echo "$@"
493
	)
494
}
495
alias echo_redirs_cmd='"echo_redirs_cmd" "$@"'
496

    
497
## vars
498

    
499
echo_vars() # usage: echo_vars var...
500
{
501
	log+ 2
502
	if can_log; then
503
		local var
504
		for var in "${@%%=*}"; do
505
			if isset "$var"; then log "$(declare -p "$var")"; fi
506
		done
507
	fi
508
}
509

    
510
echo_export() { builtin export "$@"; echo_vars "$@"; }
511

    
512
alias export="echo_export" # automatically echo env vars when they are set
513

    
514
func_override kw_params__lang
515
kw_params() { kw_params__lang "$@"; echo_vars "$@"; } # echo all keyword params
516

    
517
## functions
518

    
519
# usage: local func=...; set_func_loc; use $file, $line
520
alias set_func_loc="$(cat <<'EOF'
521
: "${func:?}"
522
local func_info="$(shopt -s extdebug; declare -F "$func")" # 'func line file'
523
func_info="${func_info#$func }"
524
local line="${func_info%% *}"
525
local file="${func_info#$line }"
526
EOF
527
)"
528

    
529
fi # load new aliases
530
if self_being_included; then
531

    
532
func_loc() # gets where function declared in the format file:line
533
{
534
	local func="$1"; set_func_loc
535
	file="$(canon_rel_path "$file")" || return
536
	echo "$file:$line"
537
}
538

    
539
# usage: func() { [minor=1] echo_func; ... }
540
function echo_func()
541
# usage: "echo_func" "$FUNCNAME" "$@" && indent || true
542
# exit status: whether function call was echoed
543
{
544
	log++; can_log || return
545
	local func="$1"; shift
546
	local loc; loc="$(clog++ func_loc "$func")" || return
547
	echo_cmd "$loc" "$func" "$@"
548
}
549
# see echo_func alias after stub
550

    
551
fi # load new aliases
552
if self_being_included; then
553

    
554

    
555
#### streams
556

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

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

    
562
set_fds() # usage: set_fds redirect...
563
{
564
	echo_func
565
	
566
	# add #<>&- before every #<>&# reopen to fix strange bash bug
567
	local redirs=() i
568
	for i in "$@"; do
569
		local redir_prefix="$(match_prefix '*[<>]' "$i")"
570
		if test "$redir_prefix"; then redirs+=("$redir_prefix&-"); fi
571
		redirs+=("$i")
572
	done
573
	set -- "${redirs[@]}"
574
	
575
	if (($# > 0)); then echo_eval exec "$@"; fi
576
}
577

    
578
fd_set_default() # usage: fd_set_default 'dest[<>]src'
579
{
580
	echo_func
581
	local dest="${1%%[<>]*}"
582
	require_fd_not_exists "$dest" || return 0
583
	set_fds "$1"
584
}
585

    
586
function filter_fd() # usage: (fd=# filter_fd filter_cmd...; with filter...)
587
# useful e.g. to filter logging output or highlight errors
588
{
589
	echo_func; kw_params fd; : "${fd?}"
590
	set_fds "$fd>" >(pipe_delay; redirs=(">&$fd" "${redirs[@]}"); redir "$@")
591
	pipe_delay; pipe_delay # wait for >()'s pipe_delay and initial logging
592
}
593
alias filter_fd='"filter_fd" ' # last space alias-expands next word
594

    
595
# convention: use fd 40/41/42 for command-specific alternate stdin/stdout/stderr
596
# mnemonic: 4 looks like A for Alternate
597
# do NOT use 1x, which are used by eval (which is used by set_fds())
598
# do NOT use 2x, which are used as global stdin/stdout/stderr
599
# do NOT use 3x, which are used for logging
600

    
601
setup_log_fd() # view logging output at verbosity >= 5
602
{
603
	log+ 4; log-- echo_func 
604
	fd_set_default '30>&2' || true # stdlog
605
	log_fd=30 # stdlog
606
}
607
setup_log_fd
608

    
609
set_global_fds()
610
# allows commands to access global stdin/stdout/stderr using fd 20/21/22
611
# this works even when /dev/tty isn't available
612
# view logging output at verbosity >= 3
613
{
614
	log+ 2; log-- echo_func
615
	# ignore errors if a source fd isn't open
616
	fd_set_default '20<&0' || true
617
	fd_set_default '21>&1' || true
618
	fd_set_default '22>&2' || true
619
}
620
set_global_fds
621

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

    
629

    
630
echo_vars is_outermost
631

    
632

    
633
#### paths
634

    
635
top_symlink_dir="$(dirname "$0")"; echo_vars top_symlink_dir
636
top_symlink_dir_abs="$(realpath "$top_symlink_dir")"
637
	echo_vars top_symlink_dir_abs
638

    
639
top_script_abs="$(realpath "$0")"; echo_vars top_script_abs # outermost script
640
	# realpath this before doing any cd so this points to the right place
641
top_dir_abs="$(dirname "$top_script_abs")"; echo_vars top_dir_abs
642

    
643
set_paths()
644
{
645
	top_script="$(clog++ canon_rel_path "$top_script_abs")" || return
646
		echo_vars top_script
647
	top_dir="$(dirname "$top_script")" || return; echo_vars top_dir
648
}
649
set_paths
650

    
651
PATH_rm() # usage: PATH_rm path... # removes components from the PATH
652
{
653
	echo_func; echo_vars PATH; : "${PATH?}"
654
	PATH=":$PATH:" # add *extra* : to match at beginning and end
655
	for path in "$@"; do PATH="${PATH//:$path:/:}"; done
656
	PATH="${PATH#:}" # remove any remaining extra leading :
657
	PATH="${PATH%:}" # remove any remaining extra trailing :
658
	echo_vars PATH
659
}
660

    
661
no_PATH_recursion() # usage: (no_PATH_recursion; cmd...)
662
# allows running a system command of the same name as the script
663
{
664
	echo_func
665
	PATH_rm "$top_dir_abs" "$top_symlink_dir" "$top_symlink_dir_abs" "$top_dir"
666
}
667

    
668

    
669
#### verbose output
670

    
671

    
672
## internal commands
673

    
674
.()
675
{
676
	clog++ clog++ echo_func
677
	cmd2rel_path; set -- "$FUNCNAME" "$@"
678
	if (log++; echo_params; can_log); then indent; fi
679
	builtin "$@"
680
}
681

    
682
.rel() # usage: .rel file [args...] # file relative to ${BASH_SOURCE[0]} dir
683
{
684
	clog++ clog++ echo_func; local file="$1"; shift
685
	. "$(canon_rel_path "$(dirname "${BASH_SOURCE[1]}")/$file")" "$@"
686
}
687

    
688
cd() # indent is permanent within subshell cd was used in
689
{
690
	log++ echo_func
691
	cmd2rel_path; echo_cmd "$FUNCNAME" "$@"
692
	if can_log; then caller_indent; fi
693
	# -P: expand symlinks so $PWD matches the output of realpath
694
	builtin "$FUNCNAME" -P "$@"
695
	
696
	func=realpath clear_cache
697
	set_paths
698
}
699

    
700
## external commands
701

    
702
disable_logging() { set_fds "$log_fd>/dev/null"; }
703

    
704
function redir() # usage: local redirs=(#<>...); redir cmd...; unset redirs
705
# to view only explicitly-displayed errors: explicit_errors_only=1 script...
706
{
707
	echo_func; kw_params redirs
708
	
709
	case "$1" in redir|command) "$@"; return;; esac # redir will be run later
710
	(
711
		log++ set_fds "${redirs[@]}"
712
		(case "$1" in command__exec) shift;; esac; echo_redirs_cmd)
713
		"$@"
714
	) || return
715
}
716
alias redir='"redir" ' # last space alias-expands next word
717

    
718
alias_append save_e '; unset redirs' # don't redirect error handlers
719

    
720
command() # usage: [cmd_log_fd=|1|2|#] [verbosity_min=] command extern_cmd...
721
{
722
	echo_func; kw_params log_fd cmd_log_fd redirs verbosity_min
723
	# if no cmd_log_fd, limit log_fd in case command uses util.sh
724
	local cmd_log_fd="${cmd_log_fd-$log_fd}"
725
	local redirs=("${redirs[@]}")
726
	
727
	# determine redirections
728
	if test "$cmd_log_fd"; then
729
		if can_log; then
730
			if test "$cmd_log_fd" != "$log_fd"; then
731
				redirs+=("$cmd_log_fd>&$log_fd")
732
			fi # else no redir needed
733
		else redirs+=("$cmd_log_fd>/dev/null");
734
		fi
735
	fi
736
	
737
	cmd2rel_path
738
	redir command__exec "$@" || die_e
739
}
740
command__exec()
741
{
742
	ensure_nested_func
743
	if can_log; then indent; fi
744
	if test "$verbosity_min"; then verbosity_min "$verbosity_min"; fi
745
	verbosity_compat
746
	builtin command "$@"
747
}
748

    
749
# auto-echo common external commands
750
for cmd in env rm; do alias "$cmd=command $cmd"; done; unset cmd
751

    
752

    
753
### external command input/output
754

    
755
echo_stdin() # usage: input|echo_stdin|cmd
756
{
757
	if can_log; then
758
		pipe_delay
759
		echo ----- >&"$log_fd"
760
		tee -a /dev/fd/"$log_fd";
761
		echo ----- >&"$log_fd"
762
	else cat
763
	fi
764
}
765

    
766
echo_stdout() { echo_stdin; } # usage: cmd|echo_stdout
767

    
768

    
769
#### commands
770

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

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

    
777
function to_file() # usage: stdout=... [if_not_exists=1] [del=] to_file cmd...
778
# auto-removes a command's output file on error (like make's .DELETE_ON_ERROR)
779
{
780
	echo_func; kw_params stdout if_not_exists del
781
	: "${stdout?}"; local del="${del-1}"
782
	if test "$if_not_exists"; then require_not_exists "$stdout" || return 0; fi
783
	
784
	local redirs=("${redirs[@]}" ">$stdout")
785
	redir "$@" || { save_e; test ! "$del" || rm "$stdout"; rethrow; }
786
}
787
alias to_file='"to_file" ' # last space alias-expands next word
788

    
789
log_bg() { symbol='&' log_custom "$@"; }
790

    
791
log_last_bg() { log_bg '$!='"$!"; }
792

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

    
796
run_args_cmd() # runs the command line args command
797
{
798
	eval set -- "$(reverse "${BASH_ARGV[@]}")"
799
	test $# -ge 1 || set -- all
800
	echo_cmd "$top_script" "$@"; time "$@"
801
}
802

    
803
fwd() # usage: subdirs=(...); fwd "$FUNCNAME" "$@"
804
{
805
	echo_func
806
	: "${subdirs?}"
807
	
808
	for subdir in "${subdirs[@]}"; do "$top_dir"/"$subdir"/run "$@"; done
809
}
810

    
811

    
812
#### filesystem
813

    
814
alias mkdir='mkdir -p'
815

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

    
819
alias wildcard='shopt -s nullglob; echo' # usage: "$(wildcard glob...)"
820

    
821
fi # load new aliases
822
if self_being_included; then
823

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

    
826
# usage: (mv_glob ... dir)
827
function mv_glob() { echo_func; if (($# > 1)); then mv2dir "$@"; fi; }
828
alias mv_glob='shopt -s nullglob; "mv_glob"'
829

    
830

    
831
#### URLs
832

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

    
835
fi
(9-9/9)