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
//! Attribute parsing for the `skip` and `skip_inner` options.

use std::default::Default;

use syn::{spanned::Spanned, Meta, Path, Result};

use crate::{util::MetaListExt, DeriveWhere, Error, Trait};

/// Stores what [`Trait`]s to skip this field or variant for.
#[cfg_attr(test, derive(Debug))]
pub enum Skip {
	/// Field skipped for no [`Trait`].
	None,
	/// Field skipped for all [`Trait`]s that support it.
	All,
	/// Field skipped for the [`Trait`]s listed.
	Traits(Vec<SkipGroup>),
}

impl Default for Skip {
	fn default() -> Self {
		Skip::None
	}
}

impl Skip {
	/// Token used for the `skip` option.
	pub const SKIP: &'static str = "skip";
	/// Token used for the `skip_inner` option.
	pub const SKIP_INNER: &'static str = "skip_inner";

	/// Returns `true` if variant is [`Skip::None`].
	pub fn is_none(&self) -> bool {
		matches!(self, Skip::None)
	}

	/// Adds a [`Meta`] to this [`Skip`].
	pub fn add_attribute(
		&mut self,
		derive_wheres: &[DeriveWhere],
		skip_inner: Option<&Skip>,
		meta: &Meta,
	) -> Result<()> {
		debug_assert!(meta.path().is_ident(Self::SKIP) || meta.path().is_ident(Self::SKIP_INNER));

		match meta {
			Meta::Path(path) => {
				// Check for duplicates.
				if self.is_none() {
					// Check against parent `skip_inner`.
					match skip_inner {
						// Allow `Skip::All` on field if parent has a tighter constraint.
						Some(Skip::None) | Some(Skip::Traits(..)) | None => {
							// Don't allow to skip all traits if no trait to be implemented supports
							// skipping.
							if derive_wheres
								.iter()
								.any(|derive_where| derive_where.any_skip())
							{
								*self = Skip::All;
								Ok(())
							} else {
								Err(Error::option_skip_no_trait(path.span()))
							}
						}
						// Don't allow `Skip::All` on field if parent already covers it.
						Some(Skip::All) => Err(Error::option_skip_inner(path.span())),
					}
				} else {
					Err(Error::option_duplicate(
						path.span(),
						&meta
							.path()
							.get_ident()
							.expect("unexpected skip syntax")
							.to_string(),
					))
				}
			}
			Meta::List(list) => {
				let nested = list.parse_non_empty_nested_metas()?;

				// Get traits already set to be skipped.
				let traits = match self {
					// If no traits are set, change to empty `Skip::Traits` and return that.
					Skip::None => {
						*self = Skip::Traits(Vec::new());

						if let Skip::Traits(traits) = self {
							traits
						} else {
							unreachable!("unexpected variant")
						}
					}
					// If we are already skipping all traits, we can't skip again with constraints.
					Skip::All => return Err(Error::option_skip_all(list.span())),
					Skip::Traits(traits) => traits,
				};

				for nested_meta in &nested {
					if let Meta::Path(path) = nested_meta {
						let skip_group = SkipGroup::from_path(path)?;

						// Don't allow to skip the same trait twice.
						if traits.contains(&skip_group) {
							return Err(Error::option_skip_duplicate(
								path.span(),
								skip_group.as_str(),
							));
						} else {
							// Don't allow to skip a trait already set to be skipped in the
							// parent.
							match skip_inner {
								Some(skip_inner) if skip_inner.group_skipped(skip_group) => {
									return Err(Error::option_skip_inner(path.span()))
								}
								_ => {
									// Don't allow to skip trait that isn't being implemented.
									if derive_wheres.iter().any(|derive_where| {
										skip_group
											.traits()
											.any(|trait_| derive_where.contains(trait_))
									}) {
										traits.push(skip_group)
									} else {
										return Err(Error::option_skip_trait(path.span()));
									}
								}
							}
						}
					} else {
						return Err(Error::option_syntax(nested_meta.span()));
					}
				}

				Ok(())
			}
			_ => Err(Error::option_syntax(meta.span())),
		}
	}

	/// Returns `true` if this item, variant or field is skipped with the given
	/// [`Trait`].
	pub fn trait_skipped(&self, trait_: Trait) -> bool {
		match self {
			Skip::None => false,
			Skip::All => SkipGroup::trait_supported(trait_),
			Skip::Traits(skip_groups) => skip_groups
				.iter()
				.any(|skip_group| skip_group.traits().any(|this_trait| this_trait == trait_)),
		}
	}

	/// Returns `true` if this item, variant or field is skipped with the given
	/// [`SkipGroup`].
	pub fn group_skipped(&self, group: SkipGroup) -> bool {
		match self {
			Skip::None => false,
			Skip::All => true,
			Skip::Traits(groups) => groups.iter().any(|this_group| *this_group == group),
		}
	}
}

/// Available groups of [`Trait`]s to skip.
#[derive(Clone, Copy, Eq, PartialEq)]
#[cfg_attr(test, derive(Debug))]
pub enum SkipGroup {
	/// [`Debug`].
	Debug,
	/// [`Eq`], [`Hash`], [`Ord`], [`PartialEq`] and [`PartialOrd`].
	EqHashOrd,
	/// [`Hash`].
	Hash,
	/// [`Zeroize`](https://docs.rs/zeroize/latest/zeroize/trait.Zeroize.html) and
	/// [`ZeroizeOnDrop`](https://docs.rs/zeroize/latest/zeroize/trait.ZeroizeOnDrop.html).
	#[cfg(feature = "zeroize")]
	Zeroize,
}

impl SkipGroup {
	/// Create [`SkipGroup`] from [`Path`].
	fn from_path(path: &Path) -> Result<Self> {
		if let Some(ident) = path.get_ident() {
			use SkipGroup::*;

			match ident.to_string().as_str() {
				"Debug" => Ok(Debug),
				"EqHashOrd" => Ok(EqHashOrd),
				"Hash" => Ok(Hash),
				#[cfg(feature = "zeroize")]
				"Zeroize" => Ok(Zeroize),
				_ => Err(Error::skip_group(path.span())),
			}
		} else {
			Err(Error::skip_group(path.span()))
		}
	}

	/// [`str`] representation of this [`Trait`].
	/// Used to compare against [`Ident`](struct@syn::Ident)s and create error
	/// messages.
	const fn as_str(self) -> &'static str {
		match self {
			Self::Debug => "Debug",
			Self::EqHashOrd => "EqHashOrd",
			Self::Hash => "Hash",
			#[cfg(feature = "zeroize")]
			Self::Zeroize => "Zeroize",
		}
	}

	/// [`Trait`]s supported by this group.
	fn traits(self) -> impl Iterator<Item = Trait> {
		match self {
			Self::Debug => [Some(Trait::Debug), None, None, None, None]
				.into_iter()
				.flatten(),
			Self::EqHashOrd => [
				Some(Trait::Eq),
				Some(Trait::Hash),
				Some(Trait::Ord),
				Some(Trait::PartialEq),
				Some(Trait::PartialOrd),
			]
			.into_iter()
			.flatten(),
			Self::Hash => [Some(Trait::Hash), None, None, None, None]
				.into_iter()
				.flatten(),
			#[cfg(feature = "zeroize")]
			Self::Zeroize => [
				Some(Trait::Zeroize),
				Some(Trait::ZeroizeOnDrop),
				None,
				None,
				None,
			]
			.into_iter()
			.flatten(),
		}
	}

	/// Returns `true` if [`Trait`] is supported by any group.
	pub fn trait_supported(trait_: Trait) -> bool {
		match trait_ {
			Trait::Clone | Trait::Copy | Trait::Default => false,
			Trait::Debug
			| Trait::Eq
			| Trait::Hash
			| Trait::Ord
			| Trait::PartialEq
			| Trait::PartialOrd => true,
			#[cfg(feature = "zeroize")]
			Trait::Zeroize | Trait::ZeroizeOnDrop => true,
		}
	}
}