Project

General

Profile

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

    
4
function extern () { (exec "$@") || return; }
5

    
6
isset () { test -n "${!1+isset}"; }
7

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

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

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

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

    
27

    
28
if self_not_included "${BASH_SOURCE[0]}"; then
29

    
30

    
31
#### options
32

    
33
shopt -s expand_aliases
34

    
35

    
36
#### aliases
37

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

    
40

    
41
#### exceptions
42

    
43
alias rethrow='return "$e"'
44
alias rethrow_subshell='exit "$e"'
45

    
46
fi # load new aliases
47
if self_being_included; then
48

    
49
# usage: save_e cmd... || use $e (or $?)
50
function save_e () { "$@"; e=$?; rethrow; } # rethrow because e= clears $?
51
alias save_e='declare e; save_e ' # last space alias-expands next word
52

    
53
function log_e () # usage: log_e cmd... [ || use $e (or $?) ]
54
{
55
	if ! "save_e" "$@"; then
56
		echo "! $*" >&2
57
		echo "! command exited with error $e" >&2
58
		rethrow
59
	fi
60
}
61
alias log_e='declare e; log_e ' # last space alias-expands next word
62

    
63
# usage: try cmd...; ignore status; if catch status; then ...; fi; end_try
64

    
65
function try () { "save_e" "$@" || true; }
66
alias try='declare e; try ' # last space alias-expands next word
67

    
68
catch () { test "$e" -eq "$1"; e=0; }
69

    
70
ignore () { catch "$@" || true; }
71

    
72
alias end_try='rethrow'
73
alias end_try_subshell='rethrow_subshell'
74

    
75

    
76
#### integers
77

    
78
let () { builtin let "$@" || true; }
79
	# "If the last ARG evaluates to 0, let returns 1" (`help let`)
80

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

    
83

    
84
#### arrays
85

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

    
88
reverse () # usage: array=($(reverse args...))
89
{
90
	local i
91
	for (( i=$#; i >= 1; i-- )); do printf '%q ' "${!i}"; done
92
}
93

    
94

    
95
#### verbose output
96

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

    
101
# set verbosity
102
if isset verbose; then : "${verbosity:=$(bool2int "$verbose")}"; fi
103
: "${verbosity=3}" # default
104
: "${verbosity:=0}" # ensure non-empty
105
declare -i verbosity # ensure integer
106
export verbosity # propagate the verbosity to invoked commands
107

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

    
110
: "${log_indent=  }"
111

    
112
# usage: in func:      inc_log_level; ...
113
#        outside func: inc_log_level; ...; dec_log_level
114
alias inc_log_level='declare verbosity="$verbosity" PS4="$log_indent$PS4"
115
let verbosity--'
116
alias dec_log_level='declare verbosity="$verbosity" PS4="${PS4#$log_indent}"
117
let verbosity++'
118

    
119
fi # load new aliases
120
if self_being_included; then
121

    
122
# usage: (limit_stderr; cmd...) || return
123
# `|| return` needed on Mac because of bug where -e doesn't apply to ()
124
limit_stderr () { inc_log_level; if ! can_log; then exec 2>/dev/null; fi; }
125

    
126
limit_stderr_cmd () # usage: [stdout2stderr=1] limit_stderr_cmd cmd...
127
{
128
	case "$1" in echo_run) shift; echo_cmd "$@";; esac
129
	(limit_stderr
130
		if test -n "$stdout2stderr"; then stdout2stderr; fi
131
		"$@"
132
	) || return
133
}
134
alias limit_stderr_cmd='limit_stderr_cmd ' # last space alias-expands next word
135

    
136
echo_cmd () { if can_log; then echo "$PS4$*" >&2; fi; }
137

    
138
echo_run () { echo_cmd "$@"; "$@"; }
139

    
140
# auto-echo common external commands
141
for cmd in rm; do alias "$cmd=echo_run $cmd"; done; unset cmd
142

    
143
# echo all external commands
144
alias extern="echo_run extern " # last space alias-expands next word
145

    
146
alias self='extern "$FUNCNAME"' # usage: wrapper () { self ...; }
147

    
148
# commands that are always external
149
for cmd in env; do alias "$cmd=extern $cmd"; done; unset cmd
150

    
151
canon_rel_path ()
152
{
153
	local path="$1"
154
	path="$(realpath "$path")" # canonicalize
155
	path="${path#$(pwd -P)/}" # remove any shared prefix with the current dir
156
	echo "$path"
157
}
158

    
159
fi # load new aliases
160
if self_being_included; then
161

    
162
function echo_func ()
163
{
164
	inc_log_level
165
	local script="$(canon_rel_path "${BASH_SOURCE[1]}")"
166
	echo_cmd "$script:${BASH_LINENO[0]}" "${FUNCNAME[1]}" "$@"
167
}
168

    
169
# usage: cmd1 | { pipe_delay; cmd2; }
170
alias pipe_delay='sleep 0.1' # s; display after leading output of cmd1
171

    
172
fi # load new aliases
173
if self_being_included; then
174

    
175
echo_stdin () # usage: input|echo_stdin|cmd
176
{
177
	inc_log_level
178
	if can_log; then
179
		pipe_delay
180
		echo ----- >&2
181
		tee -a /dev/stderr;
182
		echo ----- >&2
183
	else cat
184
	fi
185
}
186

    
187
echo_vars () # usage: echo_vars var...
188
{
189
	inc_log_level; inc_log_level
190
	if can_log; then
191
		local var
192
		for var in "${@%%=*}"; do { echo -n "$PS4"; declare -p "$var";} >&2;done
193
	fi
194
}
195

    
196
echo_export ()
197
{
198
	builtin export "$@"
199
	echo_vars "$@"
200
}
201

    
202
if test "$verbosity" -ge 2; then
203
	alias export="echo_export" # automatically echo env vars when they are set
204
fi
205

    
206
usage () { echo "Usage: $1" >&2; (exit 2); }
207

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

    
211

    
212
#### strings
213

    
214
sed_ere_flag="$(test "$(uname)" = Darwin && echo E || echo r)"
215

    
216
sed () { self -"$sed_ere_flag" "$@";}
217

    
218

    
219
#### vars
220

    
221
set_var () { eval "$1"'="$2"'; }
222

    
223
set_inv () { set_var no_"$1" "$(test -n "${!1}" || echo 1)"; }
224

    
225
# usage: local var=...; local_inv
226
alias local_inv='declare "no_$var=$(test -n "${!var}" || echo 1)"'
227

    
228
# usage: local prefix=..._; import_vars
229
alias import_vars="$(cat <<'EOF'
230
: "${prefix:?}"
231
local src_var dest_var
232
for src_var in $(eval echo '${!'$prefix'*}'); do
233
	dest_var="${src_var#$prefix}"
234
	local "$dest_var=${!src_var}"; echo_vars "$dest_var"
235
done
236
EOF
237
)"
238

    
239

    
240
#### commands
241

    
242
top_script="$0" # outermost script
243
top_dir="$(dirname "$top_script")"
244

    
245
# auto-removes a command's output file on error (like make's .DELETE_ON_ERROR)
246
function to_file () # usage: stdout=... to_file cmd...
247
{ : "${stdout?}"; log_e "$@" >"$stdout" || { rm "$stdout"; rethrow; }; }
248
alias to_file='to_file ' # last space alias-expands next word
249

    
250
run_args_cmd () # runs the command line args command
251
{
252
	test $? -eq 0 || return
253
	eval set -- "$(reverse "${BASH_ARGV[@]}")"
254
	test $# -ge 1 || set -- all
255
	echo_cmd "$(canon_rel_path "$0")" "$@"; "$@"
256
}
257

    
258
fwd () # usage: subdirs=(...); fwd "$FUNCNAME" "$@"
259
{
260
	echo_func
261
	: "${subdirs?}"
262
	
263
	for subdir in "${subdirs[@]}"; do
264
		"$(dirname "${BASH_SOURCE[1]}")"/"$subdir"/run "$@"
265
	done
266
}
267

    
268

    
269
#### URLs
270

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

    
273
fi
(5-5/5)