1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
|
#!/usr/bin/env bash
#
# Run cbindgen in each appropriate crate (the ones with a ffi interface),
# and inspect the output for changes.
#
# This script will, by default, replace the headers
# if the warnings have not changed.
# You can replace the old headers _and_ the old saved warnings
# with the "--force" option.
# You can use "--check" to make any changes (to headers or warnings) a failure.
#
# Our cbindgen configurations require nightly rust—otherwise, we can't
# expand macros. If $RUSTC_NIGHTLY is set, or if $RUSTC is nightly,
# or if "rustc" is nightly, we'll use that. Otherwise, we'll try to
# ask `rustup` if there is a nightly toolchain.
# TODO: Use maint/common helpers once they are merged.
set -eou pipefail
TOPLEVEL=$(realpath "$(dirname "$0")"/..)
: "${CBINDGEN_RUSTC:=}"
: "${RUSTC:=rustc}"
replace=1
emit_all_warnings=0
fail_on_change=0
overwrite_warnings=0
function usage()
{
cat <<EOF
cbindgen: Run cbindgen in appropriate crates, and inspect outputs for changes.
Usage:
cbindgen [opts]
Options:
-h: Print this message.
-v: Do not suppress expected warnings.
-f: Overwrite files, even if there are new warnings.
-c: Give a nonzero exit status if any files have changed; do not overwrite.
EOF
}
if command -v gnu-getopt >/dev/null; then
# If gnu-getopt is present, the platform getopt is unlikely to be good.
GETOPT=gnu-getopt
else
GETOPT=getopt
fi
set +e
options=$("$GETOPT" -ohfvc --long help,force,verbose,check -- "$@")
status="$?"
set -e
if test "$status" != 0; then
usage
exit 1
fi
eval set -- "$options"
while true; do
case "$1" in
-h | --help)
usage
exit 1
;;
-f | --force)
overwrite_warnings=1
shift
;;
-v | --verbose)
emit_all_warnings=1
shift
;;
-c | --check)
fail_on_change=1
replace=0
shift
;;
--)
shift
break
;;
esac
done
# First, find a suitable rustc.
if test "$CBINDGEN_RUSTC" != ""; then
# Supposedly we have one. Use that.
:
elif $RUSTC --version |grep -q nightly; then
# Our rustc is apparently nightly. That'll do.
CBINDGEN_RUSTC="$RUSTC"
else
# Maybe rustup can help us?
#
# TODO: If we start to see differences depending on the version
# of nightly, we may want to change this to instead look at a
# particular version of nightly.
: "${CBINDGEN_TOOLCHAIN:=nightly}"
CBINDGEN_RUSTC=$(rustup "+$CBINDGEN_TOOLCHAIN" which rustc)
fi
ANY_DIFFERENCES=0
SUGGEST_FORCE=0
for cratedir in $("$TOPLEVEL/maint/list-crates" --subdir); do
crate=$(basename "$cratedir")
if ! test -e "$cratedir/cbindgen.toml"; then
# no cbindgen.toml here; we don't run in this crate.
continue
fi
echo "$crate ..."
pushd "$TOPLEVEL/$cratedir">/dev/null
set +e
RUSTC="${CBINDGEN_RUSTC}" cbindgen --lockfile ../../Cargo.lock >"$crate.h.tmp" 2>cbindgen.warnings.tmp
status="$?"
set -e
if test "$emit_all_warnings" = 1 || test "$status" != 0; then
cat cbindgen.warnings.tmp 1>&2
if "$status" != 0; then
echo "cbindgen failed with status $status: See warnings above."
exit "$status"
fi
fi
echo "/* Generated by $(cbindgen --version) */" >>"$crate.h.tmp"
changed_this_time=0
new_warnings_this_time=0
if diff -uN "$crate.h" "$crate.h.tmp"; then
echo " (No changes in the header)"
else
changed_this_time=1
ANY_DIFFERENCES=1
fi
if diff -uN "cbindgen.warnings" "cbindgen.warnings.tmp"; then
echo " (No changes in the warnings)"
else
new_warnings_this_time=1
changed_this_time=1
ANY_DIFFERENCES=1
fi
if test "$changed_this_time" = 1 && test "$replace" = 1; then
if test "$new_warnings_this_time" = 1 && test "$overwrite_warnings" = 0; then
# TODO: Possibly we should only refuse to overwrite when there
# are _new_ warnings; not when warnings have gone away or been
# re-ordered.
echo " CHANGED WARNINGS; not overwriting."
SUGGEST_FORCE=1
else
echo " Overwriting warnings and header file."
mv -f cbindgen.warnings.tmp cbindgen.warnings
mv -f "$crate.h.tmp" "$crate.h"
fi
fi
popd>/dev/null
done
if test "$ANY_DIFFERENCES" = 1; then
echo " ------------------------------ "
echo "At least one file changed; see above for diffs."
if test "$replace" = 0; then
echo "(Running in 'check' mode, so nothing was changed.)"
elif test "$SUGGEST_FORCE" = 1; then
echo "(Did not overwrite files in which the warnings changed.)"
echo "Make sure to look over the list of warnings, and then run with -f"
fi
if test "$fail_on_change" = 1; then
exit 2
fi
fi
|
