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"|"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
#### aliases
40

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

    
43

    
44
#### functions
45

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

    
48

    
49
#### exceptions
50

    
51
# usage: cmd || { save_e; ...; rethrow; }
52
alias export_e='e=$?'
53
alias save_e='declare e=$?'
54
alias rethrow='return "$e"'
55
alias rethrow_subshell='exit "$e"'
56

    
57
fi # load new aliases
58
if self_being_included; then
59

    
60
# usage: try cmd...; ignore status; if catch status; then ...; fi; end_try
61

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

    
65
catch() { test "$e" -eq "$1"; e=0; }
66

    
67
ignore() { catch "$@" || true; }
68

    
69
alias end_try='rethrow'
70
alias end_try_subshell='rethrow_subshell'
71

    
72
fi # load new aliases
73
if self_being_included; then
74

    
75

    
76
#### integers
77

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

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

    
83

    
84
#### strings
85

    
86
repeat() # usage: str=... n=... repeat
87
{
88
	: "${str?}" "${n:?}"; local n="$n" # will be modified in function
89
	for (( ; n > 0; n-- )); do printf '%q' "$str"; done
90
}
91

    
92
sed_ere_flag="$(test "$(uname)" = Darwin && echo E || echo r)"
93

    
94
sed() { self -"$sed_ere_flag" "$@";}
95

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

    
98

    
99
#### arrays
100

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

    
103
reverse() # usage: array=($(reverse args...))
104
{
105
	local i
106
	for (( i=$#; i > 0; i-- )); do printf '%q ' "${!i}"; done
107
}
108

    
109
contains() # usage: contains value in_array...
110
{
111
	local value="$1"; shift
112
	local elem
113
	for elem in "$@"; do if test "$elem" = "$value"; then return 0; fi; done
114
	return 1
115
}
116

    
117

    
118
#### paths
119

    
120
canon_rel_path()
121
{
122
	local path="$1"
123
	path="$(realpath "$path")" # canonicalize
124
	path="${path#$(pwd -P)/}" # remove any shared prefix with the current dir
125
	echo "$path"
126
}
127

    
128
# makes $1 a canon_rel_path if it's a filesystem path
129
alias cmd2rel_path="$(cat <<'EOF'
130
if test "$(type -t "$1")" = file && test -e "$1"; then # not relative to PATH
131
	declare _1="$1"; shift
132
	set -- "$(canon_rel_path "$_1")" "$@"
133
fi
134
EOF
135
)"
136

    
137

    
138
#### verbose output
139

    
140

    
141
# usage: (stdout2stderr; cmd...) || return
142
# `|| return` needed on Mac because of bug where -e doesn't apply to ()
143
stdout2stderr() { exec >&2; }
144

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

    
147

    
148
### logging
149

    
150
# set verbosity
151
if isset verbose; then : "${verbosity:=$(bool2int "$verbose")}"; fi
152
: "${verbosity=3}" # default
153
: "${verbosity:=0}" # ensure non-empty
154
declare -i verbosity # ensure integer
155
export verbosity # propagate to invoked commands
156

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

    
159
log() { if can_log; then echo "$log_indent$PS4$1" >&2; fi; }
160

    
161
# usage: symbol=... log_custom msg
162
log_custom() { local PS4="${PS4%[^ ] }$symbol "; log "$@"; }
163

    
164
log_err() { symbol=! log_custom "$@"; }
165

    
166
log_info() { symbol=? log_custom "$@"; }
167

    
168
# usage: cmd || { save_e; log_e; ...; rethrow; }
169
log_e() { log_err "command exited with error $e"; }
170

    
171
# usage: cmd || [type=...] die msg
172
die() { save_e; "log_${type:-err}" "$1"; rethrow; }
173

    
174
: "${log_level_indent=  }" "${log_indent=}"
175
export log_level_indent log_indent # propagate to invoked commands
176
alias cmd_indent='declare log_indent="$log_indent$log_level_indent"'
177

    
178
# usage: in func:      indent; ...
179
#        outside func: indent; ...; outdent
180
alias indent='declare PS4="${PS4:0:1}$PS4"'
181
alias outdent='declare PS4="${PS4#${PS4:0:1}}"'
182

    
183
# usage: in func:      inc_log_level; ...
184
#        outside func: inc_log_level; ...; dec_log_level
185
alias inc_log_level='indent;  declare verbosity="$verbosity"; let! verbosity--'
186
alias dec_log_level='outdent; declare verbosity="$verbosity"; let! verbosity++'
187

    
188
fi # load new aliases
189
if self_being_included; then
190

    
191

    
192
### command echoing
193

    
194
echo_cmd()
195
{
196
	case "$1" in command) # command implied by the log_level
197
		shift
198
		case "$1" in --) shift;; esac
199
	;; esac
200
	log "$*"
201
}
202

    
203
## internal commands
204

    
205
echo_eval() { log "$*"; builtin eval "$@"; }
206

    
207
## external commands
208

    
209
function command() # usage: [stderr_is_errors=1] command extern_cmd...
210
# to view only explicitly-displayed errors: errors_only=1 script...
211
{
212
	set -- -- "$@" # prepend -- so command name not treated as `command` option
213
	set -- builtin command "$@"
214
	if test "$stderr_is_errors"; then "$@" 2>&22 # ensure errors are visible
215
	else "$@"; fi
216
}
217

    
218
alias echo_run_prep='cmd2rel_path; echo_cmd "$@"; cmd_indent'
219

    
220
fi # load new aliases
221
if self_being_included; then
222

    
223
echo_run() { echo_run_prep; "$@"; }
224

    
225
# auto-echo common external commands
226
for cmd in rm; do alias "$cmd=echo_run $cmd"; done; unset cmd
227

    
228
# echo all external commands
229
alias command='echo_run command ' # last space alias-expands next word
230

    
231
# commands that are always external
232
for cmd in env; do alias "$cmd=command $cmd"; done; unset cmd
233

    
234
## functions
235

    
236
function echo_func()
237
{
238
	inc_log_level
239
	local script="$(canon_rel_path "${BASH_SOURCE[1]}")"
240
	echo_cmd "$script:${BASH_LINENO[0]}" "${FUNCNAME[1]}" "$@"
241
}
242
alias echo_func='echo_func "$@"'
243
alias echo_minor_func='(inc_log_level; echo_func)'
244

    
245
## vars
246

    
247
echo_vars() # usage: echo_vars var...
248
{
249
	inc_log_level; inc_log_level
250
	if can_log; then
251
		local var
252
		for var in "${@%%=*}"; do log "$(declare -p "$var")"; done
253
	fi
254
}
255

    
256
echo_export() { builtin export "$@"; echo_vars "$@"; }
257

    
258
if test "$verbosity" -ge 2; then
259
	alias export="echo_export" # automatically echo env vars when they are set
260
fi
261

    
262

    
263
### external command verbose output
264

    
265
# usage: ([stdout2stderr=1] limit_stderr; cmd...) || return
266
# `|| return` needed on Mac because of bug where -e doesn't apply to ()
267
function limit_stderr()
268
{
269
	inc_log_level # should only apply during this function for use by can_log
270
	if test "$stdout2stderr"; then
271
		if ! can_log; then exec 1>/dev/null; else stdout2stderr; fi
272
	else
273
		if ! can_log; then exec 2>/dev/null; fi
274
	fi
275
}
276

    
277
limit_stderr_cmd() # usage: [stdout2stderr=1] limit_stderr_cmd cmd...
278
{
279
	case "$1" in echo_run) shift; echo_run_prep;; esac
280
	(limit_stderr; "$@") || return
281
}
282
alias limit_stderr_cmd='limit_stderr_cmd ' # last space alias-expands next word
283

    
284

    
285
### external command input/output
286

    
287
# usage: cmd1 | { pipe_delay; cmd2; }
288
alias pipe_delay='sleep 0.1' # s; display after leading output of cmd1
289

    
290
fi # load new aliases
291
if self_being_included; then
292

    
293
echo_stdin() # usage: input|echo_stdin|cmd
294
{
295
	inc_log_level
296
	if can_log; then
297
		pipe_delay
298
		echo ----- >&2
299
		tee -a /dev/stderr;
300
		echo ----- >&2
301
	else cat
302
	fi
303
}
304

    
305
alias echo_stdout='echo_stdin' # usage: cmd|echo_stdout
306

    
307
fi # load new aliases
308
if self_being_included; then
309

    
310

    
311
#### streams
312

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

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

    
318
set_fd() # usage: dest=fd dir='[<>]' src=fd [noclobber=1] set_fd
319
{
320
	inc_log_level; echo_func
321
	: "${dest:?}" "${dir:?}" "${src:?}"
322
	test ! "$noclobber" || require_fd_not_exists "$dest" || return 0
323
	echo_eval exec "$dest$dir&$src"
324
}
325

    
326
shadow_fd() # usage: prefix=# src=fd dir='[<>]' shadow_fd
327
{
328
	echo_minor_func
329
	: "${prefix:?}" "${src:?}" "${dir:?}"
330
	dest="$prefix$src" noclobber=1 set_fd
331
}
332

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

    
335
set_global_fds()
336
# allows commands to access global stdin/stdout/stderr using fd 20/21/22
337
# this works even when /dev/tty isn't available
338
{
339
	inc_log_level; echo_func
340
	local prefix=2
341
	# ignore errors if a source fd isn't open
342
	src=0 dir='<' shadow_fd || true
343
	src=1 dir='>' shadow_fd || true
344
	src=2 dir='>' shadow_fd || true
345
}
346
set_global_fds
347

    
348
# show only explicitly-displayed errors (which have been redirected to fd 22)
349
# most of the time this has the same effect as `verbosity=0 script...`
350
if test "$explicit_errors_only"; then exec 2>/dev/null; fi
351

    
352

    
353
#### vars
354

    
355
set_var() { eval "$1"'="$2"'; }
356

    
357
set_inv() { set_var no_"$1" "$(test "${!1}" || echo 1)"; }
358

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

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

    
364
# usage: local prefix=..._; import_vars
365
# when used inside another alias 2+ levels deep, *must* be run inside a function
366
alias import_vars="$(cat <<'EOF'
367
: "${prefix:?}"
368
declare src_var dest_var
369
for src_var in $(get_prefix_vars); do
370
	dest_var="${src_var#$prefix}"
371
	declare "$dest_var=${!src_var}"; echo_vars "$dest_var"
372
done
373
EOF
374
)"
375

    
376

    
377
#### functions
378

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

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

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

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

    
402

    
403
#### commands
404

    
405
top_script="$0" # outermost script
406
top_dir="$(dirname "$top_script")"
407

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

    
411
# auto-removes a command's output file on error (like make's .DELETE_ON_ERROR)
412
function to_file() # usage: stdout=... [if_not_exists=1] to_file cmd...
413
{
414
	echo_func
415
	: "${stdout?}"; echo_vars stdout
416
	test ! "$if_not_exists" || require_not_exists "$stdout" || return 0
417
	"$@" >"$stdout" || { save_e; log_e; rm "$stdout"; rethrow; }
418
}
419
alias to_file='to_file ' # last space alias-expands next word
420

    
421
run_args_cmd() # runs the command line args command
422
{
423
	test $? -eq 0 || return
424
	eval set -- "$(reverse "${BASH_ARGV[@]}")"
425
	test $# -ge 1 || set -- all
426
	echo_cmd "$(canon_rel_path "$0")" "$@"; "$@"
427
}
428

    
429
fwd() # usage: subdirs=(...); fwd "$FUNCNAME" "$@"
430
{
431
	echo_func
432
	: "${subdirs?}"
433
	
434
	for subdir in "${subdirs[@]}"; do
435
		"$(dirname "${BASH_SOURCE[1]}")"/"$subdir"/run "$@"
436
	done
437
}
438

    
439

    
440
#### URLs
441

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

    
444
fi
(5-5/5)