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
use proc_macro2::Span;
use syn::{Attribute, Meta, Path, Token, punctuated::Punctuated, spanned::Spanned};
use crate::{
common::{
ident_bool::{meta_2_bool_allow_path, meta_name_value_2_bool},
int::meta_2_isize,
path::meta_2_path,
},
panic,
supported_traits::Trait,
};
/// The parsed settings of a field-level `PartialOrd` attribute.
pub(crate) struct FieldAttribute {
pub(crate) ignore: bool,
pub(crate) method: Option<Path>,
/// Whether the method comes from a fallback `Ord` field attribute; such a method returns `Ordering` instead of `Option<Ordering>`, so the generated `partial_cmp` has to wrap its result in `Some`.
pub(crate) method_returns_ordering: bool,
pub(crate) rank: isize,
pub(crate) rank_span: Option<Span>,
}
/// Parses field-level `PartialOrd` metas; the `enable_*` switches describe which parameters are allowed for the current shape of data.
pub(crate) struct FieldAttributeBuilder {
pub(crate) enable_ignore: bool,
pub(crate) enable_method: bool,
pub(crate) enable_rank: bool,
pub(crate) rank: isize,
}
impl FieldAttributeBuilder {
/// Parses one field-level `PartialOrd` meta into a `FieldAttribute`, rejecting parameters that are not enabled here.
pub(crate) fn build_from_partial_ord_meta(&self, meta: &Meta) -> syn::Result<FieldAttribute> {
// An `Ord` meta is also accepted here because `build_from_attributes` may fall back to the `Ord` field attribute when `Ord` is derived together.
debug_assert!(meta.path().is_ident("PartialOrd") || meta.path().is_ident("Ord"));
let mut ignore = false;
let mut method = None;
let mut rank = self.rank;
let mut rank_span = None;
let correct_usage_for_partial_eq_attribute = {
let mut usage = vec![];
if self.enable_ignore {
usage.push(stringify!(#[educe(PartialOrd = false)]));
usage.push(stringify!(#[educe(PartialOrd(ignore))]));
}
if self.enable_method {
usage.push(stringify!(#[educe(PartialOrd(method(path_to_method)))]));
}
if self.enable_rank {
usage.push(stringify!(#[educe(PartialOrd(rank = integer))]));
}
usage
};
match meta {
Meta::Path(_) => {
return Err(panic::attribute_incorrect_format(
meta.path().get_ident().unwrap(),
&correct_usage_for_partial_eq_attribute,
));
},
Meta::NameValue(name_value) => {
if self.enable_ignore {
ignore = !meta_name_value_2_bool(name_value)?;
} else {
return Err(panic::attribute_incorrect_format(
meta.path().get_ident().unwrap(),
&correct_usage_for_partial_eq_attribute,
));
}
},
Meta::List(list) => {
let result =
list.parse_args_with(Punctuated::<Meta, Token![,]>::parse_terminated)?;
let mut ignore_is_set = false;
let mut method_is_set = false;
let mut rank_is_set = false;
let mut handler = |meta: Meta| -> syn::Result<bool> {
if let Some(ident) = meta.path().get_ident() {
match ident.to_string().as_str() {
"ignore" => {
if !self.enable_ignore {
return Ok(false);
}
let v = meta_2_bool_allow_path(&meta)?;
if ignore_is_set {
return Err(panic::parameter_reset(ident));
}
ignore_is_set = true;
ignore = v;
return Ok(true);
},
"method" => {
if !self.enable_method {
return Ok(false);
}
let v = meta_2_path(&meta)?;
if method_is_set {
return Err(panic::parameter_reset(ident));
}
method_is_set = true;
method = Some(v);
return Ok(true);
},
"rank" => {
if !self.enable_rank {
return Ok(false);
}
let v = meta_2_isize(&meta)?;
if rank_is_set {
return Err(panic::parameter_reset(ident));
}
rank_is_set = true;
rank = v;
rank_span = Some(meta.span());
return Ok(true);
},
_ => (),
}
}
Ok(false)
};
for p in result {
if !handler(p)? {
return Err(panic::attribute_incorrect_format(
meta.path().get_ident().unwrap(),
&correct_usage_for_partial_eq_attribute,
));
}
}
},
}
Ok(FieldAttribute {
ignore,
method,
method_returns_ordering: false,
rank,
rank_span,
})
}
/// Scans the `#[educe(...)]` attributes of a field and parses its `PartialOrd` meta if present.
pub(crate) fn build_from_attributes(
&self,
attributes: &[Attribute],
traits: &[Trait],
) -> syn::Result<FieldAttribute> {
let mut output = None;
// When `Ord` is derived together and a field has no `PartialOrd` attribute of its own, the field's `Ord` attribute is used instead, so that `partial_cmp` stays consistent with `cmp` like in educe 0.5.x where the `Ord` handler generated both impls.
#[cfg(feature = "Ord")]
let mut fallback = None;
for attribute in attributes.iter() {
let path = attribute.path();
if path.is_ident("educe")
&& let Meta::List(list) = &attribute.meta
{
let result =
list.parse_args_with(Punctuated::<Meta, Token![,]>::parse_terminated)?;
for meta in result {
let path = meta.path();
let t = match Trait::from_path(path) {
Some(t) => t,
None => return Err(panic::unsupported_trait(meta.path())),
};
if !traits.contains(&t) {
return Err(panic::trait_not_used(path.get_ident().unwrap()));
}
if t == Trait::PartialOrd {
if output.is_some() {
return Err(panic::reuse_a_trait(path.get_ident().unwrap()));
}
output = Some(self.build_from_partial_ord_meta(&meta)?);
}
// A malformed `Ord` attribute is silently skipped here; the `Ord` handler itself reports it with the proper usage message.
#[cfg(feature = "Ord")]
if t == Trait::Ord
&& fallback.is_none()
&& let Ok(mut field_attribute) = self.build_from_partial_ord_meta(&meta)
{
// An `Ord` comparison method returns `Ordering`, so the generated `partial_cmp` has to wrap its result in `Some`.
field_attribute.method_returns_ordering = field_attribute.method.is_some();
fallback = Some(field_attribute);
}
}
}
}
#[cfg(feature = "Ord")]
let output = output.or(fallback);
Ok(output.unwrap_or(FieldAttribute {
ignore: false,
method: None,
method_returns_ordering: false,
rank: self.rank,
rank_span: None,
}))
}
}