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
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
use std::collections::{BTreeSet, HashMap};
use proc_macro2::TokenStream;
use quote::{format_ident, quote, ToTokens};
use syn::{
spanned::Spanned, Attribute, Error, Ident, Index, Lit, Meta, MetaNameValue, Path, Result, Type,
};
use synstructure::{decl_derive, Structure};
decl_derive!([IntoDiagnostic, attributes(file_id, message, note, primary, secondary)] => diagnostic_derive);
#[derive(PartialEq, Eq, PartialOrd, Ord, Hash)]
enum FieldName {
Named(Ident),
Numbered(u32),
}
fn diagnostic_derive(s: Structure) -> Result<TokenStream> {
let file_id_attr = syn::parse_str("file_id")?;
let message_attr = syn::parse_str("message")?;
let note_attr = syn::parse_str("note")?;
let primary_attr = syn::parse_str("primary")?;
let secondary_attr = syn::parse_str("secondary")?;
let primary_style: Path = syn::parse_str("Primary")?;
let secondary_style: Path = syn::parse_str("Secondary")?;
let struct_span = s.ast().span();
let mut file_id = None;
for attr in &s.ast().attrs {
if attr.path == file_id_attr {
if let Some((_, other_span)) = &file_id {
let mut err = Error::new(*other_span, "Duplicated #[file_id(...)] attribute");
err.combine(Error::new(attr.span(), "Second occurrence is here"));
return Err(err);
}
file_id = Some((attr.parse_args::<Type>()?, attr.span()));
} else if attr.path == message_attr
|| attr.path == note_attr
|| attr.path == primary_attr
|| attr.path == secondary_attr
{
return Err(Error::new(
attr.span(),
format!("Unexpected attribute `{}`", attr.path.to_token_stream()),
));
}
}
let file_id = file_id
.ok_or_else(|| Error::new(struct_span, "Expected `#[file_id(Type)]` attribute"))?
.0;
let mut branches = vec![];
for v in s.variants() {
let members = match &v.ast().fields {
syn::Fields::Unit => HashMap::new(),
syn::Fields::Named(f) => f
.named
.iter()
.enumerate()
.map(|(i, field)| {
(
FieldName::Named(field.ident.as_ref().unwrap().clone()),
format_ident!("__binding_{}", i),
)
})
.collect(),
syn::Fields::Unnamed(f) => f
.unnamed
.iter()
.enumerate()
.map(|(i, _)| {
(
FieldName::Numbered(i as u32),
format_ident!("__binding_{}", i),
)
})
.collect(),
};
let mut why = None;
let mut labels = vec![];
let mut notes = vec![];
for attr in v.ast().attrs.iter() {
if attr.path == message_attr {
if let Some((_, other_span)) = &why {
let mut err = Error::new(*other_span, "Duplicated #[message = ...] attribute");
err.combine(Error::new(attr.span(), "Second occurrence is here"));
return Err(err);
}
why = Some((attr_to_format(attr, &members)?, attr.span()));
} else if attr.path == note_attr {
let note = attr_to_format(attr, &members)?;
notes.push(note);
} else if attr.path == primary_attr
|| attr.path == secondary_attr
|| attr.path == file_id_attr
{
return Err(Error::new(
attr.span(),
format!("Unexpected attribute `{}`", attr.path.to_token_stream()),
));
}
}
for b in v.bindings() {
let binding = &b.binding;
for attr in &b.ast().attrs {
if attr.path == primary_attr || attr.path == secondary_attr {
let style = if attr.path == primary_attr {
&primary_style
} else {
&secondary_style
};
let label = match attr.parse_meta()? {
Meta::Path(_) => {
quote! {
::codespan_derive::IntoLabel::into_label( #binding, ::codespan_derive::LabelStyle::#style )
}
}
Meta::NameValue(MetaNameValue { .. }) => {
let message = attr_to_format(&attr, &members)?;
quote! {
::codespan_derive::IntoLabel::into_label( #binding, ::codespan_derive::LabelStyle::#style )
.with_message( #message )
}
}
_ => return Err(Error::new(attr.span(),
format!("Expected `span` attribute to be of the form: `#[span]` or `#[span = \"Message...\"]`"))),
};
labels.push(label);
} else if attr.path == message_attr
|| attr.path == note_attr
|| attr.path == file_id_attr
{
return Err(Error::new(
attr.span(),
format!("Unexpected attribute `{}`", attr.path.to_token_stream()),
));
}
}
}
let why = why
.ok_or_else(|| {
Error::new(
v.ast().ident.span(),
"Expected `#[message = \"Message...\"]` attribute",
)
})?
.0;
let pat = v.pat();
branches.push(quote! {
#pat => {
::codespan_derive::Diagnostic::< #file_id >::error()
.with_message( #why )
.with_labels(vec![ #(#labels),* ])
.with_notes(vec![ #(#notes),* ])
}
});
}
Ok(s.gen_impl(quote! {
gen impl ::codespan_derive::IntoDiagnostic for @Self {
type FileId = #file_id ;
#[allow(dead_code)]
fn into_diagnostic(&self) -> ::codespan_derive::Diagnostic::< #file_id > {
match self {
#(#branches),*
_ => { panic!("Uninhabited type cannot be turned into a Diagnostic") }
}
}
}
}))
}
fn attr_to_format(attr: &Attribute, members: &HashMap<FieldName, Ident>) -> Result<TokenStream> {
match attr.parse_meta()? {
Meta::NameValue(MetaNameValue {
lit: Lit::Str(msg), ..
}) => {
let msg_span = msg.span();
let mut msg: &str = &msg.value();
let mut idents = BTreeSet::new();
let mut out = String::new();
while !msg.is_empty() {
if let Some(i) = msg.find(&['{', '}'][..]) {
out += &msg[..i];
if msg[i..].starts_with("{{") {
out += "{{";
msg = &msg[i + 2..];
} else if msg[i..].starts_with("}}") {
out += "}}";
msg = &msg[i + 2..];
} else if msg[i..].starts_with('}') {
return Err(Error::new(msg_span, "Unterminated `}` in format string"));
} else {
msg = &msg[i + 1..];
if let Some(j) = msg.find('}') {
let (field, rest) = if let Some(k) = msg[0..j].find(":") {
(&msg[0..k], Some(&msg[k..j]))
} else {
(&msg[0..j], None)
};
msg = &msg[j + 1..];
let member = if let Ok(ident) = syn::parse_str::<Ident>(field) {
FieldName::Named(ident)
} else if let Ok(num) = syn::parse_str::<Index>(field) {
FieldName::Numbered(num.index)
} else {
return Err(Error::new(
msg_span,
format!(
"Expected either a struct member name or index, got `{}`",
field
),
));
};
out += "{";
if let Some(ident) = members.get(&member) {
out += &ident.to_string();
idents.insert(ident.clone());
} else {
return Err(Error::new(
msg_span,
format!(
"Struct member name or index `{}` is not a valid field",
field
),
));
}
if let Some(rest) = rest {
out += rest;
}
out += "}";
} else {
return Err(Error::new(msg_span, "Unterminated `{` in format string"));
}
}
} else {
out += msg;
msg = "";
}
}
Ok(quote! {
format!(#out, #(#idents = #idents),*)
})
}
_ => Err(Error::new(
attr.span(),
format!(
"Expected {name} attribute to be of the form: `#[{name} = \"FormatString\"]`",
name = attr.path.to_token_stream()
),
)),
}
}