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 290 291 292 293 294 295 296 297 298
//! Do not use this crate directly. Instead, use [`::macro_rules_attribute`](
//! https://docs.rs/macro_rules_attribute)
use {
::core::{
ops::Not as _,
iter::FromIterator as _,
},
::proc_macro::{*,
TokenTree as TT,
},
};
// See the re-export at the frontend (`src/lib.rs`) for the documentation.
#[proc_macro_attribute] pub
fn macro_rules_attribute (
attrs: TokenStream,
input: TokenStream,
) -> TokenStream
{
let ret = macro_rules_attribute_impl(&attrs.vec(), input);
#[cfg(feature = "verbose-expansions")]
eprintln!("{}", ret);
ret
}
fn macro_rules_attribute_impl (
attrs: &'_ [TokenTree],
input: TokenStream
) -> TokenStream
{
let mut ret: TokenStream;
// check that `attrs` is indeed of the form `$macro_name:path !`
match is_path_bang_terminated(&attrs) {
| Ok(PathIsBangTerminated(trailing_bang)) => {
ret = attrs.iter().cloned().collect();
if trailing_bang {
/* OK */
} else {
// tolerate it
ret.extend([TT::Punct(Punct::new('!', Spacing::Alone))]);
}
},
| Err(()) => return parse_path_error(attrs),
}
ret.extend([TT::Group(Group::new(
Delimiter::Brace,
// FIXME: directly using `input` makes the token stream be seen
// as a single token tree by the declarative macro !??
input.into_iter().collect(),
))]);
ret
}
// See the re-export at the frontend (`src/lib.rs`) for the documentation.
#[proc_macro_attribute] pub
fn macro_rules_derive (
attrs: TokenStream,
input: TokenStream,
) -> TokenStream
{
let mut ret = TokenStream::new();
ret.extend(
attrs
.vec()
// we use `split_inclusive()` + strip approach to support trailing
// comma and yet detect empty input: `derive(Something,,ShouldFail)`
.split_inclusive(is_punct(','))
.map(|attr| match attr {
| [hd @ .., p] if is_punct(',')(p) => hd,
| _ => attr,
})
.flat_map(|attr| macro_rules_attribute_impl(attr, input.clone()))
);
ret.extend(input);
#[cfg(feature = "verbose-expansions")]
eprintln!("{}", ret);
ret
}
// See the re-export at the frontend (`src/lib.rs`) for the documentation.
#[proc_macro_attribute] pub
fn derive (
attrs: TokenStream,
input: TokenStream,
) -> TokenStream
{
let attrs = attrs.vec();
fn real_derive (
derives: TokenStream,
) -> TokenStream
{
// `#[::core::prelude::v1::derive( #derives )]`
TokenStream::from_iter([
TT::Punct(Punct::new('#', Spacing::Alone)),
TT::Group(Group::new(
Delimiter::Bracket,
{
let mut ts: TokenStream = ts!(
::core::prelude::v1::derive
);
ts.extend([TT::Group(Group::new(
Delimiter::Parenthesis,
derives,
))]);
ts
},
))
])
}
// any `path::to::Macro!` in the derive list?
if attrs.iter().any(is_punct('!')).not() {
// This is a good old derive.
let mut ret = real_derive(attrs.into_iter().collect());
ret.extend(input);
#[cfg(feature = "verbose-expansions")]
eprintln!("{}", ret);
return ret;
}
// Note: emitting the input as-is would break derives that use helper
// attributes.
//
// ```rust
// let mut ret = input;
// ret.extend(nested_derive! { #[derive(#real_derives)]})…
// ```
//
// So we have to do it otherwise: we do not emit `input` directly,
// but rather, with the real derives directly attached to it
// (no `nested_derive!` invocation at all, here).
// So it will be the job of each real derive's to strip its inert derive
// helpers, which is something only a built-in derive can do, hence dodging
// the issue :)
let each_attr = || {
attrs
// we use `split_inclusive()` + strip approach to support trailing
// comma and yet detect empty input: `derive(Something,,ShouldFail)`
.split_inclusive(is_punct(','))
.map(|attr| match attr {
| [hd @ .., p] if is_punct(',')(p) => hd,
| _ => attr,
})
};
let ref each_is_path_bang_terminated =
each_attr()
.map(is_path_bang_terminated)
.vec()
;
for (attr, parse_bang) in each_attr().zip(each_is_path_bang_terminated) {
if let Err(()) = parse_bang {
return parse_path_error(attr);
}
}
let attrs_banged = |banged| {
each_attr()
.zip(each_is_path_bang_terminated)
.filter(move |(_, parse_bang)| parse_bang.unwrap().0 == banged)
.map(|(attr, _)| attr)
};
let mut ret = TokenStream::new();
attrs_banged(true).for_each(|attr| {
ret.extend(macro_rules_attribute_impl(attr, input.clone()))
});
if attrs_banged(false).any(|_| true) {
ret.extend(real_derive(
attrs_banged(false)
.flat_map(|attr| attr.iter().cloned().chain(ts!(,)))
.collect()
,
));
}
ret.extend(input);
#[cfg(feature = "verbose-expansions")]
eprintln!("{}", ret);
ret
}
#[::core::prelude::v1::derive(Clone, Copy)]
struct PathIsBangTerminated(bool);
fn parse_path_error (
incorrect_input: &[TokenTree],
) -> TokenStream
{
let mut spans = incorrect_input.iter().map(|tt| tt.span());
let mut ts = ts!(
::core::compile_error! {
"\
expected a parameter of the form `path::to::macro_name !` \
or `path::to::macro_name`.\
"
}
).vec();
let fst_span = spans.next().unwrap_or_else(Span::call_site);
let lst_span = spans.fold(fst_span, |_, cur| cur);
ts.iter_mut().for_each(|tt| tt.set_span(fst_span));
ts.last_mut().unwrap().set_span(lst_span);
ts.into_iter().collect()
}
/// `Ok(… true)` => `some::path!`
/// `Ok(… false)` => `some::path`
/// `Err` => not a (simple) path.
fn is_path_bang_terminated (
tts: &'_ [TokenTree],
) -> Result<PathIsBangTerminated, ()>
{
let mut tts = tts.iter().peekable();
macro_rules! parse_optional_semicolons {() => (
match tts.peek() {
| Some(TT::Punct(p)) => {
drop(tts.next());
if p.as_char() == ':' && p.spacing() == Spacing::Joint {
match tts.next() {
| Some(TT::Punct(p))
if p.as_char() == ':'
&& p.spacing() == Spacing::Alone
=> {
Some(())
},
| _ => return Err(()),
}
} else {
return Err(());
}
},
| _ => None,
}
)}
macro_rules! parse_trailing_comma {() => (
if tts.peek().copied().map_or(false, is_punct(',')) {
drop(tts.next());
if tts.next().is_some() {
return Err(());
}
}
)}
parse_optional_semicolons!();
// Loop invariant: we start at the identifier part of a path segment.
loop {
match tts.next() {
| Some(TT::Ident(_)) => {},
| _ => return Err(()),
}
// After an identifier, either nothing remains
// (but for an optional trailing comma)
parse_trailing_comma!();
if tts.peek().is_none() {
return Ok(PathIsBangTerminated(false));
}
// or remains a punctuation: either a trailing `!`…
if tts.peek().copied().map_or(false, is_punct('!')) {
drop(tts.next());
// Now nothing remains (but for an optional trailing comma).
parse_trailing_comma!();
return if tts.next().is_none() {
Ok(PathIsBangTerminated(true))
} else {
Err(())
};
}
// …or the `::` separator for yet another segment.
if parse_optional_semicolons!().is_none() {
return Err(());
}
}
}
fn is_punct (c: char)
-> impl 'static + Fn(&'_ TokenTree) -> bool
{
move |tt| matches!(tt, TT::Punct(p) if p.as_char() == c)
}
macro_rules! ts {( $($tt:tt)* ) => (
::core::stringify! {
$($tt)*
}
.parse::<::proc_macro::TokenStream>()
.unwrap()
)} use ts;
trait CollectVec : IntoIterator + Sized {
fn vec (self: Self)
-> Vec<Self::Item>
{
impl<T : IntoIterator> CollectVec for T {}
self.into_iter().collect()
}
}