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
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
extern crate proc_macro;
use proc_macro::TokenStream;
use quote::quote;
use syn::{
fold::Fold,
parenthesized,
parse::{Parse, ParseBuffer},
parse_macro_input,
parse_quote,
Attribute,
Error,
Expr,
Ident,
ItemFn,
LitStr,
Result,
Stmt,
Token,
};
#[proc_macro_attribute]
pub fn safety(args: TokenStream, input: TokenStream) -> TokenStream {
let input = parse_macro_input!(input);
let mut args = parse_macro_input!(args as Args);
let output = args.fold_item_fn(input);
TokenStream::from(quote!(#output))
}
struct Binary(Expr, Expr);
impl Parse for Binary {
fn parse(input: &ParseBuffer<'_>) -> Result<Self> {
let lhs = input.parse()?;
input.parse::<Token![,]>()?;
let rhs = input.parse()?;
Ok(Binary(lhs, rhs))
}
}
enum Condition {
Eq(Binary),
Ne(Binary),
Assert(Expr),
}
#[allow(clippy::large_enum_variant)]
enum Args {
Literal(LitStr),
Condition(Condition, LitStr),
}
impl Condition {
fn stmt(&self, text: &LitStr) -> Stmt {
match self {
Condition::Eq(Binary(lhs, rhs)) => parse_quote!(debug_assert_eq!(#lhs, #rhs, #text);),
Condition::Ne(Binary(lhs, rhs)) => parse_quote!(debug_assert_ne!(#lhs, #rhs, #text);),
Condition::Assert(expr) => parse_quote!(debug_assert!(#expr, #text);),
}
}
}
impl Parse for Condition {
fn parse(input: &ParseBuffer<'_>) -> Result<Self> {
let ident: Ident = input.parse()?;
let parens;
parenthesized!(parens in input);
match ident {
ref i if i == "eq" => Ok(Condition::Eq(parens.parse()?)),
ref i if i == "ne" => Ok(Condition::Ne(parens.parse()?)),
ref i if i == "assert" => Ok(Condition::Assert(parens.parse()?)),
_ => {
let message = format!(
"expected string literal, `assert()`, `eq()`, or `ne()`. Found `{}`",
ident
);
Err(Error::new_spanned(ident, message))
}
}
}
}
impl Args {
fn attribute(&self) -> Attribute {
let text = match self {
Args::Literal(text) | Args::Condition(_, text) => text,
};
let text = format!("- {}", text.value());
parse_quote!(#[doc = #text])
}
fn stmt(&self) -> Option<Stmt> {
if let Args::Condition(condition, text) = self {
Some(condition.stmt(text))
} else {
None
}
}
}
impl Parse for Args {
fn parse(input: &ParseBuffer<'_>) -> Result<Self> {
if input.peek(LitStr) {
Ok(Args::Literal(input.parse()?))
} else {
let condition = input.parse()?;
input.parse::<Token![,]>()?;
let literal = input.parse()?;
Ok(Args::Condition(condition, literal))
}
}
}
impl Fold for Args {
fn fold_item_fn(&mut self, mut item: ItemFn) -> ItemFn {
let safety_attr = parse_quote!(#[doc = " # Safety"]);
let mut heading_inserted = None;
for (i, attr) in item.attrs.iter().enumerate() {
if *attr == safety_attr {
heading_inserted = Some(i + 1);
break;
}
}
if item.unsafety.is_none() {
let error = Error::new_spanned(
&item.ident,
"A function with safety attributes has to be marked as `unsafe`",
)
.to_compile_error();
item.block.stmts.insert(0, parse_quote!(#error;));
};
if let Some(i) = heading_inserted {
item.attrs.insert(i, self.attribute());
} else {
item.attrs.push(safety_attr);
item.attrs.push(self.attribute());
}
if let Some(stmt) = self.stmt() {
item.block.stmts.insert(0, parse_quote!(#stmt));
};
item
}
}