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
get_prefix_vars() { : "${prefix:?}"; eval echo '${!'$prefix'*}'; }
52

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

    
65

    
66
#### aliases
67

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

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

    
74

    
75
#### functions
76

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

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

    
83

    
84
#### exceptions
85

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

    
92
fi # load new aliases
93
if self_being_included; then
94

    
95
# usage: try cmd...; ignore status; if catch status; then ...; fi; end_try
96

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

    
100
catch() { test "$e" -eq "$1"; e=0; }
101

    
102
ignore() { catch "$@" || true; }
103

    
104
alias end_try='rethrow'
105
alias end_try_subshell='rethrow_subshell'
106

    
107
fi # load new aliases
108
if self_being_included; then
109

    
110

    
111
#### integers
112

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

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

    
118

    
119
#### strings
120

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

    
127
sed_ere_flag="$(test "$(uname)" = Darwin && echo E || echo r)"
128

    
129
sed() { self -"$sed_ere_flag" "$@";}
130

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

    
133

    
134
#### arrays
135

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

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

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

    
152

    
153
#### paths
154

    
155
canon_rel_path()
156
{
157
	local path="$1"
158
	path="$(realpath "$path")" # canonicalize
159
	path="${path#$(pwd -P)/}" # remove any shared prefix with the current dir
160
	echo "$path"
161
}
162

    
163
# makes $1 a canon_rel_path if it's a filesystem path
164
alias cmd2rel_path="$(cat <<'EOF'
165
if test "$(type -t "$1")" = file && test -e "$1"; then # not relative to PATH
166
	declare _1="$1"; shift
167
	set -- "$(canon_rel_path "$_1")" "$@"
168
fi
169
EOF
170
)"
171

    
172

    
173
#### verbose output
174

    
175

    
176
err_fd=2 # stderr
177

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

    
180

    
181
### logging
182

    
183
log_fd=2 # stderr
184

    
185
if test "$explicit_errors_only"; then verbosity=0; fi # hide startup logging
186

    
187
# set verbosity
188
if isset verbose; then : "${verbosity:=$(bool2int "$verbose")}"; fi
189
if isset vb; then : "${verbosity:=$vb}"; fi
190
: "${verbosity=2}" # default
191
: "${verbosity:=0}" # ensure non-empty
192
export verbosity # propagate to invoked commands
193

    
194
: "${log_level_indent=| }" "${log_indent=}"
195
export log_level_indent log_indent # propagate to invoked commands
196
alias indent='declare log_indent="$log_indent$log_level_indent"'
197

    
198
# usage: in func:      PS4++; ...
199
#        outside func: PS4++; ...; PS4--
200
alias PS4++='declare PS4="${PS4:0:1}$PS4"'
201
alias PS4--='declare PS4="${PS4#${PS4:0:1}}"'
202

    
203
# usage: in func:      log++; ...
204
#        outside func: log++; ...; log--
205
alias log++='{ PS4++; declare verbosity="$verbosity"; let! verbosity--; }'
206
alias log--='{ PS4--; declare verbosity="$verbosity"; let! verbosity++; }'
207

    
208
fi # load new aliases
209
if self_being_included; then
210

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

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

    
215
# usage: symbol=... log_custom msg
216
log_custom()
217
{
218
	local log_indent="${log_indent//[^ ]/$symbol}" PS4="$symbol${PS4#?}"
219
	log "$@"
220
}
221

    
222
log_err() { symbol=* verbosity=1 log_fd="$err_fd" log_custom "$@"; }
223

    
224
log_info() { symbol='#' log_custom "$@"; }
225

    
226
# usage: cmd || { save_e; log_e; ...; rethrow; }
227
log_e() { log_err "command exited with error $e"; }
228

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

    
232

    
233
#### functions
234

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

    
237
copy_func() # usage: from=... to=... copy_func
238
# $to must not exist. to get around the no-clobber restriction, use `unset -f`.
239
{
240
	: "${from:?}" "${to:?}"
241
	func_exists "$from" || die "function does not exist: $from"
242
	! func_exists "$to" || die "function already exists: $to"
243
	local from_def="$(declare -f "$from")"
244
	eval "$to${from_def#$from}"
245
}
246

    
247
func_override() # usage: func_override old_name__suffix
248
{ from="${1%%__*}" to="$1" copy_func; }
249

    
250
ensure_nested_func() # usage: func__nested_func() { ensure_nested_func; ... }
251
{
252
	local nested_func="${FUNCNAME[1]}"
253
	local func="${nested_func%%__*}"
254
	contains "$func" "${FUNCNAME[@]}" || \
255
		die "$nested_func() must be used by $func()"
256
}
257

    
258

    
259
### command echoing
260

    
261
alias echo_params='log "$*"'
262

    
263
fi # load new aliases
264
if self_being_included; then
265

    
266
echo_cmd() { echo_params; }
267

    
268
## internal commands
269

    
270
.()
271
{
272
	cmd2rel_path; set -- . "$@"; (log++; echo_params; can_log) && indent || true
273
	builtin "$@"
274
}
275

    
276
echo_eval() { echo_params; builtin eval "$@"; }
277

    
278
## external commands
279

    
280
disable_logging() { echo_eval exec "$log_fd>/dev/null"; }
281

    
282
function command() # usage: [cmd_log_fd=|1|2|#] command extern_cmd...
283
# to view only explicitly-displayed errors: explicit_errors_only=1 script...
284
{
285
	kw_params cmd_log_fd
286
	
287
	cmd2rel_path; (echo_params; can_log) && indent || true
288
	(
289
		# the following redirections must happen in exactly this order
290
		if test "$cmd_log_fd"; then
291
			echo_eval exec "$cmd_log_fd>$(if (log++; can_log); then \
292
			echo "&$log_fd"; else echo /dev/null; fi)"
293
		fi
294
		if test "$cmd_log_fd" != 2; then # fd 2 not used for logging
295
			exec 2>&"$err_fd" # assume fd 2 used for errors
296
		fi
297
		
298
		exec -- "$@" # -- so cmd name not treated as `exec` option
299
	) || return
300
}
301

    
302
# auto-echo common external commands
303
for cmd in env rm; do alias "$cmd=command $cmd"; done; unset cmd
304

    
305
## functions
306

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

    
320
## vars
321

    
322
echo_vars() # usage: echo_vars var...
323
{
324
	log++; log++
325
	if can_log; then
326
		local var
327
		for var in "${@%%=*}"; do
328
			if isset "$var"; then log "$(declare -p "$var")"; fi
329
		done
330
	fi
331
}
332

    
333
echo_export() { builtin export "$@"; echo_vars "$@"; }
334

    
335
if test "$verbosity" -ge 2; then
336
	alias export="echo_export" # automatically echo env vars when they are set
337
fi
338

    
339
func_override kw_params__lang
340
kw_params() { kw_params__lang "$@"; echo_vars "$@"; } # echo all keyword params
341

    
342

    
343
### external command input/output
344

    
345
# usage: cmd1 | { pipe_delay; cmd2; }
346
alias pipe_delay='sleep 0.1' # s; display after leading output of cmd1
347

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

    
351
echo_stdin() # usage: input|echo_stdin|cmd
352
{
353
	log++
354
	if can_log; then
355
		pipe_delay
356
		echo ----- >&"$log_fd"
357
		tee -a /dev/fd/"$log_fd";
358
		echo ----- >&"$log_fd"
359
	else cat
360
	fi
361
}
362

    
363
alias echo_stdout='echo_stdin' # usage: cmd|echo_stdout
364

    
365
fi # load new aliases
366
if self_being_included; then
367

    
368

    
369
#### streams
370

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

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

    
376
set_fd() # usage: dest=fd dir='[<>]' src=fd [noclobber=1] set_fd
377
{
378
	echo_func; kw_params dest dir src
379
	: "${dest:?}" "${dir:?}" "${src:?}"
380
	test ! "$noclobber" || require_fd_not_exists "$dest" || return 0
381
	echo_eval exec "$dest$dir&$src"
382
}
383

    
384
shadow_fd() # usage: prefix=# src=fd dir='[<>]' shadow_fd
385
{
386
	echo_func
387
	: "${prefix:?}" "${src:?}" "${dir:?}"
388
	dest="$prefix$src" noclobber=1 set_fd
389
}
390

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

    
393
set_global_fds()
394
# allows commands to access global stdin/stdout/stderr using fd 20/21/22
395
# this works even when /dev/tty isn't available
396
{
397
	log++; echo_func; log++
398
	local prefix=2
399
	# ignore errors if a source fd isn't open
400
	src=0 dir='<' shadow_fd || true
401
	src=1 dir='>' shadow_fd || true
402
	src=2 dir='>' shadow_fd || true
403
}
404
set_global_fds
405
err_fd=22 # global stderr
406

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

    
414

    
415
#### commands
416

    
417
top_script="$(canon_rel_path "$0")" # outermost script
418
top_dir="$(dirname "$top_script")"
419

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

    
423
# auto-removes a command's output file on error (like make's .DELETE_ON_ERROR)
424
function to_file() # usage: stdout=... [if_not_exists=1] to_file cmd...
425
{
426
	echo_func; kw_params stdout
427
	: "${stdout?}"
428
	test ! "$if_not_exists" || require_not_exists "$stdout" || return 0
429
	"$@" >"$stdout" || { save_e; log_e; rm "$stdout"; rethrow; }
430
}
431
alias to_file='"to_file" ' # last space alias-expands next word
432

    
433
run_args_cmd() # runs the command line args command
434
{
435
	test $? -eq 0 || return
436
	eval set -- "$(reverse "${BASH_ARGV[@]}")"
437
	test $# -ge 1 || set -- all
438
	echo_cmd "$top_script" "$@"; "$@"
439
}
440

    
441
fwd() # usage: subdirs=(...); fwd "$FUNCNAME" "$@"
442
{
443
	echo_func
444
	: "${subdirs?}"
445
	
446
	for subdir in "${subdirs[@]}"; do
447
		"$(dirname "${BASH_SOURCE[1]}")"/"$subdir"/run "$@"
448
	done
449
}
450

    
451

    
452
#### URLs
453

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

    
456
fi
(5-5/5)