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
function echo_vars() { :; }
57

    
58

    
59
#### vars
60

    
61
set_var() { eval "$1"'="$2"'; }
62

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

    
65
set_inv() { set_var no_"$1" "$(test "${!1}" || echo 1)"; }
66

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

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

    
73
alias local_export='declare -x' # combines effects of local and export
74

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

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

    
89

    
90
#### caching
91

    
92
## shell-variable-based caching
93

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

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

    
105
fi # load new aliases
106
if self_being_included; then
107

    
108

    
109
#### aliases
110

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

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

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

    
119

    
120
#### functions
121

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

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

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

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

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

    
145

    
146
#### exceptions
147

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

    
154
fi # load new aliases
155
if self_being_included; then
156

    
157
# usage: try cmd...; ignore_e status; if catch status; then ...; fi; end_try
158

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

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

    
164
ignore_e() { catch "$@" || true; }
165

    
166
alias end_try='rethrow'
167
alias end_try_subshell='rethrow_subshell'
168

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

    
171
### signals
172

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

    
175
ignore_sig() { ignore "$(sig_e "$1")"; }
176

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

    
181
fi # load new aliases
182
if self_being_included; then
183

    
184

    
185
#### integers
186

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

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

    
192
int2exit() { (( "$1" != 0 )); }
193

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

    
196

    
197
#### floats
198

    
199
int_part() { echo "${1%%.*}"; }
200

    
201
dec_suffix() { echo "${1#$(int_part "$1")}"; }
202

    
203
round_down() { int_part "$1"; }
204

    
205
float+int() { echo "$(($(int_part "$1")+$2))$(dec_suffix "$1")"; }
206

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

    
209

    
210
#### strings
211

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

    
214
match_prefix() # usage: match_prefix pattern str
215
{ if starts_with "$1" "$2"; then echo "${2%${2#$1}}"; fi }
216

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

    
224
sed_cmd="sed -`case "$(uname)" in Darwin) echo E;; *) echo r;; esac`"
225
alias sed="$sed_cmd"
226

    
227
fi # load new aliases
228
if self_being_included; then
229

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

    
232

    
233
#### arrays
234

    
235
echo1() { echo "$1"; } # usage: echo1 values...
236

    
237
# usage: split delim str; use ${parts[@]}
238
function split() { echo_func; local IFS="$1"; parts=($2); echo_vars parts; }
239
alias split='declare parts; "split"'
240

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

    
243
reverse() # usage: array=($(reverse args...))
244
{
245
	local i
246
	for (( i=$#; i > 0; i-- )); do printf '%q ' "${!i}"; done
247
}
248

    
249
contains() # usage: contains value in_array...
250
{
251
	local value="$1"; shift
252
	local elem
253
	for elem in "$@"; do if test "$elem" = "$value"; then return 0; fi; done
254
	return 1
255
}
256

    
257
#### streams
258

    
259
pipe_delay() # usage: cmd1 | { pipe_delay; cmd2; }
260
{ sleep 0.1; } # s; display after leading output of cmd1
261

    
262

    
263
#### verbose output
264

    
265

    
266
err_fd=2 # stderr
267

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

    
270

    
271
### log++
272

    
273
log_fd=2 # initially stderr
274

    
275
if test "$explicit_errors_only"; then verbosity=0; fi # hide startup logging
276

    
277
# set verbosity
278
if isset verbose; then : "${verbosity:=$(bool2int "$verbose")}"; fi
279
if isset vb; then : "${verbosity:=$vb}"; fi
280
: "${verbosity=1}" # default
281
: "${verbosity:=0}" # ensure non-empty
282
export verbosity # propagate to invoked commands
283
export PS4 # follows verbosity, so also propagate this
284

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

    
287
# set log_level
288
: "${log_level=$(( ${#PS4}-1 ))}" # defaults to # non-space symbols in PS4
289
export log_level # propagate to invoked commands
290

    
291
verbosity_int() { round_down "$verbosity"; }
292

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

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

    
313
fi # load new aliases
314
if self_being_included; then
315

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

    
340
verbosity_min() # usage: verbosity_min {min|} # ''->verbosity=''
341
{ if test ! "$1" -o "$(verbosity_int)" -lt "$1"; then verbosity="$1"; fi; }
342
alias verbosity_min='log_local; "verbosity_min"'
343

    
344
# usage: (verbosity_compat; cmd)
345
function verbosity_compat()
346
{ echo_func; if ((verbosity == 1)); then unset verbosity; fi; }
347
alias verbosity_compat='declare verbosity; "verbosity_compat"'
348

    
349

    
350
# indent for call tree. this is *not* the log_level (below).
351
: "${log_indent_step=| }" "${log_indent=}"
352
export log_indent_step log_indent # propagate to invoked commands
353

    
354
# see indent alias in stubs
355

    
356

    
357
fi # load new aliases
358
if self_being_included; then
359

    
360
can_log() { test "$(verbosity_int)" -gt 0; }
361
	# verbosity=0 turns off all logging
362

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

    
365
log_custom() # usage: symbol=... log_custom msg
366
{ log_indent="${log_indent//[^ ]/$symbol}" PS4="${PS4//[^ ]/$symbol}" log "$@";}
367

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

    
370
log_info() { symbol=: log_custom "$@"; }
371

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

    
375
die_e() # usage: cmd || [benign_error=1] die_e [|| handle error]
376
{
377
	save_e; kw_params benign_error
378
	if test "$benign_error"; then log++; fi
379
	type="${benign_error:+info}" die "command exited with \
380
$(if test "$benign_error"; then echo status; else echo error; fi) $e"
381
	rethrow
382
}
383

    
384

    
385
#### functions
386

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

    
389
copy_func() # usage: from=... to=... copy_func
390
# $to must not exist. to get around the no-clobber restriction, use `unset -f`.
391
{
392
	: "${from:?}" "${to:?}"
393
	func_exists "$from" || die "function does not exist: $from"
394
	! func_exists "$to" || die "function already exists: $to"
395
	local from_def="$(declare -f "$from")"
396
	eval "$to${from_def#$from}"
397
}
398

    
399
func_override() # usage: func_override old_name__suffix
400
{ from="${1%__*}" to="$1" copy_func; }
401

    
402
ensure_nested_func() # usage: func__nested_func() { ensure_nested_func; ... }
403
{
404
	local nested_func="${FUNCNAME[1]}"
405
	local func="${nested_func%%__*}"
406
	contains "$func" "${FUNCNAME[@]}" || \
407
		die "$nested_func() must be used by $func()"
408
}
409

    
410

    
411
#### paths
412

    
413
# cache realpath
414
: "${realpath_cache=}" # default off because slower than without
415
if test "$realpath_cache"; then
416
func_override realpath__no_cache
417
realpath() # caches the last result for efficiency
418
{
419
	local cache_key="$*"; load_cache
420
	if ! cached; then save_cache "$(realpath__no_cache "$@")" || return; fi
421
	echo_cached_value
422
}
423
fi
424

    
425
rel_path() # usage: base_dir=... path=... rel_path
426
{
427
	kw_params base_dir path
428
	: "${base_dir:?}" "${path:?}"
429
	
430
	local path="$path/" # add *extra* / to match path when exactly = base_dir
431
	path="${path#$base_dir/}" # remove prefix shared with base_dir
432
	path="${path%/}" # remove any remaining extra trailing /
433
	
434
	if test ! "$path"; then path=.; fi # ensure non-empty
435
	
436
	echo_vars path
437
	echo "$path"
438
}
439

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

    
443
canon_rel_path() # usage: [base_dir=...] canon_rel_path path
444
{
445
	kw_params base_dir; local base_dir="${base_dir-$PWD}"
446
	base_dir="$(realpath "$base_dir")" || return
447
	local path; path="$(realpath "$1")" || return
448
	rel_path
449
}
450

    
451
# makes $1 a canon_rel_path if it's a filesystem path
452
alias cmd2rel_path="$(cat <<'EOF'
453
if test "$(type -t "$1")" = file && test -e "$1"; then # not relative to PATH
454
	declare _1="$1"; shift
455
	_1="$(clog++ canon_rel_path "$_1")" || return
456
	set -- "$_1" "$@"
457
fi
458
EOF
459
)"
460

    
461
# usage: path_parents path; use ${dirs[@]} # includes the path itself
462
function path_parents()
463
{
464
	echo_func; local path="$1" prev_path=; dirs=()
465
	while test "$path" != "$prev_path"; do
466
		prev_path="$path"
467
		dirs+=("$path")
468
		path="${path%/*}"
469
	done
470
}
471
alias path_parents='declare dirs; "path_parents"'
472

    
473

    
474
#### verbose output
475

    
476

    
477
### command echoing
478

    
479
alias echo_params='log "$*"'
480

    
481
fi # load new aliases
482
if self_being_included; then
483

    
484
echo_cmd() { echo_params; }
485

    
486
function echo_run() { echo_params; "$@"; }
487
# see echo_run alias after stub
488

    
489
echo_eval() { echo_params; builtin eval "$@"; }
490

    
491
# usage: redirs=(...); [cmd_name_log_inc=#] echo_redirs_cmd
492
function echo_redirs_cmd()
493
{
494
	local cmd_name_log_inc="${cmd_name_log_inc-0}"
495
	
496
	# print <>file redirs before cmd, because they introduce it
497
	"log+" "$cmd_name_log_inc" echo_cmd "$@" $(
498
		set -- "${redirs[@]}" # operate on ${redirs[@]}
499
		while test "$#" -gt 0 && starts_with '[<>][^&]' "$1"
500
		do log "$1 \\"; shift; done # log() will run *before* echo_cmd itself
501
		echo "$@"
502
	)
503
}
504
alias echo_redirs_cmd='"echo_redirs_cmd" "$@"'
505

    
506
## vars
507

    
508
echo_vars() # usage: echo_vars var...
509
{
510
	log+ 2
511
	if can_log; then
512
		local var
513
		for var in "${@%%=*}"; do
514
			if isset "$var"; then log "$(declare -p "$var")"; fi
515
		done
516
	fi
517
}
518

    
519
echo_export() { builtin export "$@"; echo_vars "$@"; }
520

    
521
alias export="echo_export" # automatically echo env vars when they are set
522

    
523
func_override kw_params__lang
524
kw_params() { kw_params__lang "$@"; echo_vars "$@"; } # echo all keyword params
525

    
526
## functions
527

    
528
# usage: local func=...; set_func_loc; use $file, $line
529
alias set_func_loc="$(cat <<'EOF'
530
: "${func:?}"
531
local func_info="$(shopt -s extdebug; declare -F "$func")" # 'func line file'
532
func_info="${func_info#$func }"
533
local line="${func_info%% *}"
534
local file="${func_info#$line }"
535
EOF
536
)"
537

    
538
fi # load new aliases
539
if self_being_included; then
540

    
541
func_loc() # gets where function declared in the format file:line
542
{
543
	local func="$1"; set_func_loc
544
	file="$(canon_rel_path "$file")" || return
545
	echo "$file:$line"
546
}
547

    
548
# usage: func() { [minor=1] echo_func; ... }
549
function echo_func()
550
# usage: "echo_func" "$FUNCNAME" "$@" && indent || true
551
# exit status: whether function call was echoed
552
{
553
	log++; can_log || return
554
	local func="$1"; shift
555
	local loc; loc="$(clog++ func_loc "$func")" || return
556
	echo_cmd "$loc" "$func" "$@"
557
}
558
# see echo_func alias after stub
559

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

    
563

    
564
#### streams
565

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

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

    
571
set_fds() # usage: set_fds redirect...
572
{
573
	echo_func
574
	
575
	# add #<>&- before every #<>&# reopen to fix strange bash bug
576
	local redirs=() i
577
	for i in "$@"; do
578
		local redir_prefix="$(match_prefix '*[<>]' "$i")"
579
		if test "$redir_prefix"; then redirs+=("$redir_prefix&-"); fi
580
		redirs+=("$i")
581
	done
582
	set -- "${redirs[@]}"
583
	
584
	if (($# > 0)); then echo_eval exec "$@"; fi
585
}
586

    
587
fd_set_default() # usage: fd_set_default 'dest[<>]src'
588
{
589
	echo_func
590
	local dest="${1%%[<>]*}"
591
	require_fd_not_exists "$dest" || return 0
592
	set_fds "$1"
593
}
594

    
595
function filter_fd() # usage: (fd=# filter_fd filter_cmd...; with filter...)
596
# useful e.g. to filter logging output or highlight errors
597
{
598
	echo_func; kw_params fd; : "${fd?}"
599
	set_fds "$fd>" >(pipe_delay; redirs=(">&$fd" "${redirs[@]}"); redir "$@")
600
	pipe_delay; pipe_delay # wait for >()'s pipe_delay and initial logging
601
}
602
alias filter_fd='"filter_fd" ' # last space alias-expands next word
603

    
604
# convention: use fd 40/41/42 for command-specific alternate stdin/stdout/stderr
605
# mnemonic: 4 looks like A for Alternate
606
# do NOT use 1x, which are used by eval (which is used by set_fds())
607
# do NOT use 2x, which are used as global stdin/stdout/stderr
608
# do NOT use 3x, which are used for logging
609

    
610
setup_log_fd() # view logging output at verbosity >= 5
611
{
612
	log+ 4; log-- echo_func 
613
	fd_set_default '30>&2' || true # stdlog
614
	log_fd=30 # stdlog
615
}
616
setup_log_fd
617

    
618
set_global_fds()
619
# allows commands to access global stdin/stdout/stderr using fd 20/21/22
620
# this works even when /dev/tty isn't available
621
# view logging output at verbosity >= 3
622
{
623
	log+ 2; log-- echo_func
624
	# ignore errors if a source fd isn't open
625
	fd_set_default '20<&0' || true
626
	fd_set_default '21>&1' || true
627
	fd_set_default '22>&2' || true
628
}
629
set_global_fds
630

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

    
638

    
639
echo_vars is_outermost
640

    
641

    
642
#### paths
643

    
644
top_symlink_dir="$(dirname "$0")"; echo_vars top_symlink_dir
645
top_symlink_dir_abs="$(realpath "$top_symlink_dir")"
646
	echo_vars top_symlink_dir_abs
647

    
648
top_script_abs="$(realpath "$0")"; echo_vars top_script_abs # outermost script
649
	# realpath this before doing any cd so this points to the right place
650
top_dir_abs="$(dirname "$top_script_abs")"; echo_vars top_dir_abs
651

    
652
set_paths()
653
{
654
	top_script="$(clog++ canon_rel_path "$top_script_abs")" || return
655
		echo_vars top_script
656
	top_dir="$(dirname "$top_script")" || return; echo_vars top_dir
657
}
658
set_paths
659

    
660
# usage: in_top_dir cmd...
661
function in_top_dir() { echo_func; (cd "$top_dir"; "$@"); }
662
alias in_top_dir='"in_top_dir" ' # last space alias-expands next word
663

    
664
PATH_rm() # usage: PATH_rm path... # removes components from the PATH
665
{
666
	echo_func; echo_vars PATH; : "${PATH?}"
667
	PATH=":$PATH:" # add *extra* : to match at beginning and end
668
	for path in "$@"; do PATH="${PATH//:$path:/:}"; done
669
	PATH="${PATH#:}" # remove any remaining extra leading :
670
	PATH="${PATH%:}" # remove any remaining extra trailing :
671
	echo_vars PATH
672
}
673

    
674
no_PATH_recursion() # usage: (no_PATH_recursion; cmd...)
675
# allows running a system command of the same name as the script
676
{
677
	echo_func
678
	PATH_rm "$top_dir_abs" "$top_symlink_dir" "$top_symlink_dir_abs" "$top_dir"
679
}
680

    
681

    
682
#### verbose output
683

    
684

    
685
## internal commands
686

    
687
.()
688
{
689
	clog++ clog++ echo_func
690
	cmd2rel_path; set -- "$FUNCNAME" "$@"
691
	if (log++; echo_params; can_log); then indent; fi
692
	builtin "$@"
693
}
694

    
695
.rel() # usage: .rel file [args...] # file relative to ${BASH_SOURCE[0]} dir
696
{
697
	clog++ clog++ echo_func; local file="$1"; shift
698
	. "$(canon_rel_path "$(dirname "${BASH_SOURCE[1]}")/$file")" "$@"
699
}
700

    
701
cd() # indent is permanent within subshell cd was used in
702
{
703
	log++ echo_func
704
	cmd2rel_path; echo_cmd "$FUNCNAME" "$@"
705
	if can_log; then caller_indent; fi
706
	# -P: expand symlinks so $PWD matches the output of realpath
707
	builtin "$FUNCNAME" -P "$@"
708
	
709
	func=realpath clear_cache
710
	set_paths
711
}
712

    
713
## external commands
714

    
715
disable_logging() { set_fds "$log_fd>/dev/null"; }
716

    
717
function redir() # usage: local redirs=(#<>...); redir cmd...; unset redirs
718
# to view only explicitly-displayed errors: explicit_errors_only=1 script...
719
{
720
	echo_func; kw_params redirs
721
	
722
	case "$1" in redir|command) "$@"; return;; esac # redir will be run later
723
	(
724
		log++ set_fds "${redirs[@]}"
725
		(case "$1" in command__exec) shift;; esac; echo_redirs_cmd)
726
		"$@"
727
	) || return
728
}
729
alias redir='"redir" ' # last space alias-expands next word
730

    
731
alias_append save_e '; unset redirs' # don't redirect error handlers
732

    
733
command() # usage: [cmd_log_fd=|1|2|#] [verbosity_min=] command extern_cmd...
734
{
735
	echo_func; kw_params log_fd cmd_log_fd redirs verbosity_min
736
	# if no cmd_log_fd, limit log_fd in case command uses util.sh
737
	local cmd_log_fd="${cmd_log_fd-$log_fd}"
738
	local redirs=("${redirs[@]}")
739
	
740
	# determine redirections
741
	if test "$cmd_log_fd"; then
742
		if can_log; then
743
			if test "$cmd_log_fd" != "$log_fd"; then
744
				redirs+=("$cmd_log_fd>&$log_fd")
745
			fi # else no redir needed
746
		else redirs+=("$cmd_log_fd>/dev/null");
747
		fi
748
	fi
749
	
750
	cmd2rel_path
751
	redir command__exec "$@" || die_e
752
}
753
command__exec()
754
{
755
	ensure_nested_func
756
	if can_log; then indent; fi
757
	if test "$verbosity_min"; then verbosity_min "$verbosity_min"; fi
758
	verbosity_compat
759
	builtin command "$@"
760
}
761

    
762

    
763
### external command input/output
764

    
765
echo_stdin() # usage: input|echo_stdin|cmd
766
{
767
	if can_log; then
768
		pipe_delay
769
		echo ----- >&"$log_fd"
770
		tee -a /dev/fd/"$log_fd";
771
		echo ----- >&"$log_fd"
772
	else cat
773
	fi
774
}
775

    
776
echo_stdout() { echo_stdin; } # usage: cmd|echo_stdout
777

    
778

    
779
#### commands
780

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

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

    
787
function to_file() # usage: stdout=... [if_not_exists=1] [del=] to_file cmd...
788
# auto-removes a command's output file on error (like make's .DELETE_ON_ERROR)
789
{
790
	echo_func; kw_params stdout if_not_exists del
791
	: "${stdout?}"; local del="${del-1}"
792
	if test "$if_not_exists"; then require_not_exists "$stdout" || return 0; fi
793
	
794
	local redirs=("${redirs[@]}" ">$stdout")
795
	redir "$@" || { save_e; test ! "$del" || rm "$stdout"; rethrow; }
796
}
797
alias to_file='"to_file" ' # last space alias-expands next word
798

    
799
log_bg() { symbol='&' log_custom "$@"; }
800

    
801
log_last_bg() { log_bg '$!='"$!"; }
802

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

    
806
run_args_cmd() # runs the command line args command
807
{
808
	eval set -- "$(reverse "${BASH_ARGV[@]}")"
809
	test $# -ge 1 || set -- all
810
	echo_cmd "$top_script" "$@"; time "$@"
811
}
812

    
813
fwd() # usage: subdirs=(...); fwd "$FUNCNAME" "$@"
814
{
815
	echo_func
816
	: "${subdirs?}"
817
	
818
	for subdir in "${subdirs[@]}"; do "$top_dir"/"$subdir"/run "$@"; done
819
}
820

    
821

    
822
#### filesystem
823

    
824
alias mkdir='mkdir -p'
825

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

    
829
alias wildcard='shopt -s nullglob; echo' # usage: "$(wildcard glob...)"
830
alias wildcard1='shopt -s nullglob; echo1' # usage: "$(wildcard1 glob...)"
831

    
832
fi # load new aliases
833
if self_being_included; then
834

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

    
837
# usage: (mv_glob ... dir)
838
function mv_glob() { echo_func; if (($# > 1)); then mv2dir "$@"; fi; }
839
alias mv_glob='shopt -s nullglob; "mv_glob"'
840

    
841

    
842
#### URLs
843

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

    
846
fi
(9-9/10)