Project

General

Profile

1
#!/bin/bash -e
2
set -o errexit # in case caller did not have -e in #! line
3

    
4
if test ! "$_util_sh_include_guard_utils"; then
5
_util_sh_include_guard_utils=1
6

    
7
isset() { test "${!1+isset}"; }
8

    
9
realpath() { readlink -f -- "$1"; }
10

    
11
include_guard_var() { realpath "$1"|builtin command sed 's/[^a-zA-Z0-9_]/_/g'; }
12

    
13
self_not_included() # usage: if self_not_included; then ... fi
14
{
15
	test $# -ge 1 || set -- "${BASH_SOURCE[1]}"
16
	local include_guard="$(include_guard_var "$1")"
17
	alias self_being_included=false
18
	! isset "$include_guard" && \
19
	{ eval "$include_guard"=1; alias self_being_included=true; }
20
}
21

    
22
# to load newly-defined aliases for use in functions in the same file:
23
## fi # load new aliases
24
## if self_being_included; then
25
# this is needed because aliases defined inside an if statement are not
26
# available inside that if statement
27

    
28
fi
29

    
30

    
31
if self_not_included "${BASH_SOURCE[0]}"; then
32

    
33

    
34
#### options
35

    
36
shopt -s expand_aliases
37

    
38

    
39
#### vars
40

    
41
set_var() { eval "$1"'="$2"'; }
42

    
43
set_inv() { set_var no_"$1" "$(test "${!1}" || echo 1)"; }
44

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

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

    
51
alias local_export='declare -x' # combines effects of local and export
52

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

    
55
# usage: local prefix=..._; import_vars
56
# when used inside another alias 2+ levels deep, *must* be run inside a function
57
alias import_vars="$(cat <<'EOF'
58
: "${prefix:?}"
59
declare src_var dest_var
60
for src_var in $(get_prefix_vars); do
61
	dest_var="${src_var#$prefix}"
62
	declare "$dest_var=${!src_var}"; echo_vars "$dest_var"
63
done
64
EOF
65
)"
66

    
67

    
68
#### aliases
69

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

    
72
# usage: alias alias_='var=value run_cmd '
73
function run_cmd() { "$@"; }
74
alias run_cmd='"run_cmd" ' # last space alias-expands next word
75

    
76

    
77
#### functions
78

    
79
kw_params() # usage: func() { kw_params param_var...; }; ...; param_var=... cmd
80
# removes keyword-param-only vars from the environment
81
{ unexport "$@"; }
82

    
83
alias self='command "$FUNCNAME"' # usage: wrapper() { self ...; }
84

    
85

    
86
#### exceptions
87

    
88
# usage: cmd || { save_e; ...; rethrow; }
89
alias export_e='e=$?'
90
alias save_e='declare e=$?'
91
alias rethrow='return "$e"'
92
alias rethrow_subshell='exit "$e"'
93

    
94
fi # load new aliases
95
if self_being_included; then
96

    
97
# usage: try cmd...; ignore status; if catch status; then ...; fi; end_try
98

    
99
function try() { e=0; "$@" || { export_e; true; }; }
100
alias try='declare e; "try" ' # last space alias-expands next word
101

    
102
catch() { test "$e" -eq "$1"; e=0; }
103

    
104
ignore() { catch "$@" || true; }
105

    
106
alias end_try='rethrow'
107
alias end_try_subshell='rethrow_subshell'
108

    
109
fi # load new aliases
110
if self_being_included; then
111

    
112

    
113
#### integers
114

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

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

    
120

    
121
#### strings
122

    
123
repeat() # usage: str=... n=... repeat
124
{
125
	: "${str?}" "${n:?}"; local n="$n" # will be modified in function
126
	for (( ; n > 0; n-- )); do printf '%q' "$str"; done
127
}
128

    
129
sed_ere_flag="$(test "$(uname)" = Darwin && echo E || echo r)"
130

    
131
sed() { self -"$sed_ere_flag" "$@";}
132

    
133
rtrim() { sed 's/[[:space:]]+$//' <<<"$1"; }
134

    
135

    
136
#### arrays
137

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

    
140
reverse() # usage: array=($(reverse args...))
141
{
142
	local i
143
	for (( i=$#; i > 0; i-- )); do printf '%q ' "${!i}"; done
144
}
145

    
146
contains() # usage: contains value in_array...
147
{
148
	local value="$1"; shift
149
	local elem
150
	for elem in "$@"; do if test "$elem" = "$value"; then return 0; fi; done
151
	return 1
152
}
153

    
154

    
155
#### verbose output
156

    
157

    
158
err_fd=2 # stderr
159

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

    
162

    
163
### logging
164

    
165
log_fd=2 # stderr
166

    
167
if test "$explicit_errors_only"; then verbosity=0; fi # hide startup logging
168

    
169
# set verbosity
170
if isset verbose; then : "${verbosity:=$(bool2int "$verbose")}"; fi
171
if isset vb; then : "${verbosity:=$vb}"; fi
172
: "${verbosity=1}" # default
173
: "${verbosity:=0}" # ensure non-empty
174
export verbosity # propagate to invoked commands
175

    
176
: "${log_level_indent=| }" "${log_indent=}"
177
export log_level_indent log_indent # propagate to invoked commands
178

    
179
__caller_indent='log_indent="$log_indent$log_level_indent"'
180
alias caller_indent="$__caller_indent"
181
alias indent="declare $__caller_indent"
182

    
183
# usage: in func:      PS4++; ...
184
#        outside func: PS4++; ...; PS4--
185
alias PS4++='declare PS4="${PS4:0:1}$PS4"'
186
alias PS4--='declare PS4="${PS4#${PS4:0:1}}"'
187

    
188
# usage: in func:      log++; ...
189
#        outside func: log++; ...; log--
190
alias log++='{ PS4++; declare verbosity="$verbosity"; let! verbosity--; }'
191
alias log--='{ PS4--; declare verbosity="$verbosity"; let! verbosity++; }'
192

    
193
fi # load new aliases
194
if self_being_included; then
195

    
196
can_log() { test "$verbosity" -gt 0; } # verbosity=0 turns off all logging
197

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

    
200
log_custom() # usage: symbol=... log_custom msg
201
{ log_indent="${log_indent//[^ ]/$symbol}" PS4="${PS4//[^ ]/$symbol}" log "$@";}
202

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

    
205
log_info() { symbol=: log_custom "$@"; }
206

    
207
log_e() # usage: cmd || { save_e; log_e; ...; rethrow; }
208
{ log_err "command exited with error $e"; }
209

    
210
die() # usage: cmd || [type=...] die msg
211
{ save_e; kw_params type; "log_${type:-err}" "$1"; rethrow; }
212

    
213

    
214
#### functions
215

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

    
218
copy_func() # usage: from=... to=... copy_func
219
# $to must not exist. to get around the no-clobber restriction, use `unset -f`.
220
{
221
	: "${from:?}" "${to:?}"
222
	func_exists "$from" || die "function does not exist: $from"
223
	! func_exists "$to" || die "function already exists: $to"
224
	local from_def="$(declare -f "$from")"
225
	eval "$to${from_def#$from}"
226
}
227

    
228
func_override() # usage: func_override old_name__suffix
229
{ from="${1%%__*}" to="$1" copy_func; }
230

    
231
ensure_nested_func() # usage: func__nested_func() { ensure_nested_func; ... }
232
{
233
	local nested_func="${FUNCNAME[1]}"
234
	local func="${nested_func%%__*}"
235
	contains "$func" "${FUNCNAME[@]}" || \
236
		die "$nested_func() must be used by $func()"
237
}
238

    
239

    
240
#### paths
241

    
242
rel_path() # usage: base_dir=... path=... rel_path
243
{
244
	log++; kw_params base_dir path
245
	: "${base_dir:?}" "${path:?}"
246
	
247
	local path="$path/" # add *extra* / to match path when exactly = base_dir
248
	path="${path#$base_dir/}" # remove prefix shared with base_dir
249
	path="${path%/}" # remove any remaining extra trailing /
250
	
251
	if test ! "$path"; then path=.; fi # ensure non-empty
252
	
253
	echo_vars path
254
	echo "$path"
255
}
256

    
257
canon_rel_path() { base_dir="$(pwd -P)" path="$(realpath "$1")" rel_path; }
258

    
259
# makes $1 a canon_rel_path if it's a filesystem path
260
alias cmd2rel_path="$(cat <<'EOF'
261
if test "$(type -t "$1")" = file && test -e "$1"; then # not relative to PATH
262
	declare _1="$1"; shift
263
	set -- "$(canon_rel_path "$_1")" "$@"
264
fi
265
EOF
266
)"
267

    
268

    
269
#### verbose output
270

    
271

    
272
### command echoing
273

    
274
alias echo_params='log "$*"'
275

    
276
fi # load new aliases
277
if self_being_included; then
278

    
279
echo_cmd() { echo_params; }
280

    
281
## vars
282

    
283
echo_vars() # usage: echo_vars var...
284
{
285
	log++; log++
286
	if can_log; then
287
		local var
288
		for var in "${@%%=*}"; do
289
			if isset "$var"; then log "$(declare -p "$var")"; fi
290
		done
291
	fi
292
}
293

    
294
echo_export() { builtin export "$@"; echo_vars "$@"; }
295

    
296
if test "$verbosity" -ge 2; then
297
	alias export="echo_export" # automatically echo env vars when they are set
298
fi
299

    
300
func_override kw_params__lang
301
kw_params() { kw_params__lang "$@"; echo_vars "$@"; } # echo all keyword params
302

    
303
## functions
304

    
305
# usage: func() { [minor=1] echo_func; ... }
306
function echo_func() # usage: [minor=1] "echo_func" "$@" && indent || true
307
# exit status: whether function call was echoed
308
{
309
	kw_params minor
310
	
311
	log++; if test "$minor"; then log++; fi
312
	local script="$(canon_rel_path "${BASH_SOURCE[1]}")"
313
	echo_cmd "$script:${BASH_LINENO[0]}" "${FUNCNAME[1]}" "$@"
314
	can_log
315
}
316
alias echo_func='"echo_func" "$@" && indent || true'
317

    
318
fi # load new aliases
319
if self_being_included; then
320

    
321

    
322
#### paths
323

    
324
top_script_abs="$(realpath "$0")"; echo_vars top_script_abs # outermost script
325
	# realpath this before doing any cd so this points to the right place
326

    
327
set_paths()
328
{
329
	top_script="$(canon_rel_path "$top_script_abs")"; echo_vars top_script
330
	top_dir="$(dirname "$top_script")"; echo_vars top_dir
331
}
332
set_paths
333

    
334

    
335
#### verbose output
336

    
337

    
338
## internal commands
339

    
340
.()
341
{
342
	cmd2rel_path; set -- "$FUNCNAME" "$@"
343
	(log++; echo_params; can_log) && indent || true
344
	builtin "$@"
345
}
346

    
347
cd() # indent is permanent within subshell cd was used in
348
{
349
	cmd2rel_path; set -- "$FUNCNAME" "$@"; echo_params
350
	can_log && caller_indent || true
351
	builtin "$@"
352
	set_paths
353
}
354

    
355
echo_eval() { echo_params; builtin eval "$@"; }
356

    
357
## external commands
358

    
359
disable_logging() { set_fds "$log_fd>/dev/null"; }
360

    
361
function command() # usage: [cmd_log_fd=|1|2|#] command extern_cmd...
362
# to view only explicitly-displayed errors: explicit_errors_only=1 script...
363
{
364
	kw_params cmd_log_fd
365
	
366
	cmd2rel_path; (echo_params; can_log) && indent || true
367
	(
368
		# the following redirections must happen in exactly this order
369
		if test "$cmd_log_fd"; then
370
			set_fds "$cmd_log_fd>$(if (log++; can_log); then \
371
			echo "&$log_fd"; else echo /dev/null; fi)"
372
		fi
373
		if test "$cmd_log_fd" != 2; then # fd 2 not used for logging
374
			exec 2>&"$err_fd" # assume fd 2 used for errors
375
		fi
376
		
377
		exec -- "$@" # -- so cmd name not treated as `exec` option
378
	) || return
379
}
380

    
381
# auto-echo common external commands
382
for cmd in env rm; do alias "$cmd=command $cmd"; done; unset cmd
383

    
384

    
385
### external command input/output
386

    
387
pipe_delay () # usage: cmd1 | { pipe_delay; cmd2; }
388
{ sleep 0.1; } # s; display after leading output of cmd1
389

    
390
fi # load new aliases
391
if self_being_included; then
392

    
393
echo_stdin() # usage: input|echo_stdin|cmd
394
{
395
	log++
396
	if can_log; then
397
		pipe_delay
398
		echo ----- >&"$log_fd"
399
		tee -a /dev/fd/"$log_fd";
400
		echo ----- >&"$log_fd"
401
	else cat
402
	fi
403
}
404

    
405
echo_stdout () { echo_stdin; } # usage: cmd|echo_stdout
406

    
407

    
408
#### streams
409

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

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

    
415
set_fds() { echo_func; echo_eval exec "$@"; } # usage: set_fds redirect...
416

    
417
fd_set_default() # usage: fd_set_default 'dest[<>]src'
418
{
419
	echo_func
420
	local dest="${1%%[<>]*}"
421
	require_fd_not_exists "$dest" || return 0
422
	set_fds "$1"
423
}
424

    
425
# convention: use fd 10/11/12 for command-specific alternate stdin/stdout/stderr
426

    
427
set_global_fds()
428
# allows commands to access global stdin/stdout/stderr using fd 20/21/22
429
# this works even when /dev/tty isn't available
430
{
431
	log++; echo_func; log++
432
	# ignore errors if a source fd isn't open
433
	fd_set_default '20<&0' || true
434
	fd_set_default '21>&1' || true
435
	fd_set_default '22>&2' || true
436
}
437
set_global_fds
438
err_fd=22 # global stderr
439

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

    
447

    
448
#### commands
449

    
450
require_not_exists() # usage: require_not_exists file || return 0
451
{ test ! -e "$1" || type=info die "file "$1" already exists, skipping"; }
452

    
453
function to_file() # usage: stdout=... [if_not_exists=1] to_file cmd...
454
# auto-removes a command's output file on error (like make's .DELETE_ON_ERROR)
455
{
456
	echo_func; kw_params stdout
457
	: "${stdout?}"
458
	test ! "$if_not_exists" || require_not_exists "$stdout" || return 0
459
	"$@" >"$stdout" || { save_e; log_e; rm "$stdout"; rethrow; }
460
}
461
alias to_file='"to_file" ' # last space alias-expands next word
462

    
463
run_args_cmd() # runs the command line args command
464
{
465
	test $? -eq 0 || return
466
	eval set -- "$(reverse "${BASH_ARGV[@]}")"
467
	test $# -ge 1 || set -- all
468
	echo_cmd "$top_script" "$@"; "$@"
469
}
470

    
471
fwd() # usage: subdirs=(...); fwd "$FUNCNAME" "$@"
472
{
473
	echo_func
474
	: "${subdirs?}"
475
	
476
	for subdir in "${subdirs[@]}"; do
477
		"$(dirname "${BASH_SOURCE[1]}")"/"$subdir"/run "$@"
478
	done
479
}
480

    
481

    
482
#### URLs
483

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

    
486
fi
(5-5/5)