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
use proc_macro2::TokenStream;
use syn::{buffer::Cursor, parse::Parse, parse2, Error as SynError, Result as SynResult};
use crate::error::unexpected_end_of_stream_message;
/// Accumulate [`proc_macro2::TokenTree`] into a [`proc_macro2::TokenStream`] while the given predicate returns `true` returning a tuple containing the resulting [`proc_macro2::TokenStream`] and a [`syn::buffer::Cursor`] positioned at the point where accumulation ended.
///
/// # Examples
/// ```
/// use core::str::FromStr;
/// use proc_macro2::TokenStream;
/// use syn::{
/// parse::{Parse, ParseStream},
/// parse2, Result as SynResult,
/// };
/// use timrs_macro_utils::parse::accumulate_while;
///
/// #[derive(Debug, PartialEq)]
/// struct Test { value: String }
///
/// impl Parse for Test {
/// fn parse(input: ParseStream) -> SynResult<Self> {
/// SynResult::Ok(Self {
/// value: input
/// .step(|cursor| accumulate_while(*cursor, |current| !current.eof()))?
/// .to_string(),
/// })
/// }
/// }
///
/// assert_eq!(
/// parse2::<Test>(
/// TokenStream::from_str("ARBITRARY_TOKEN").map_err(|error| error.to_string()).unwrap()
/// ).map_err(|error| error.to_string()).unwrap(),
/// Test { value: "ARBITRARY_TOKEN".to_owned() }
/// );
/// ```
///
/// # Errors
/// Returns the [`syn::Error`] if the cursor hits `eof` before the predicate returns `false`.
#[inline]
pub fn accumulate_while<F>(cursor: Cursor, mut predicate: F) -> SynResult<(TokenStream, Cursor)>
where
F: FnMut(Cursor) -> bool,
{
let mut current = cursor;
let mut tokens = Vec::new();
while predicate(current) {
match current.token_tree() {
Option::Some((tt, next)) => {
tokens.push(tt);
current = next;
}
Option::None => return SynResult::Err(SynError::new(current.span(), unexpected_end_of_stream_message())),
}
}
SynResult::Ok((TokenStream::from_iter(tokens), current))
}
/// Trait defining a token that can be consumed by [`syn::parse::ParseBuffer::step`].
pub trait LookaheadToken: Parse {
/// The size in number tokens for the [`Self`].
const SIZE: usize;
/// Looks ahead in the provided [`syn::buffer::Cursor`] for [`Self`] returning a tuple containing the parsed [`Self`] and a [`syn::buffer::Cursor`] positioned after the parsed token if it is found.
///
/// # Examples
/// ```
/// use core::str::FromStr;
/// use proc_macro2::TokenStream;
/// use syn::{
/// parse::{Parse, ParseStream},
/// parse2, Ident, Result as SynResult, Token,
/// };
/// use timrs_macro_utils::parse::LookaheadToken;
///
/// #[derive(Debug, PartialEq)]
/// struct TestToken;
///
/// impl Parse for TestToken {
/// fn parse(input: ParseStream) -> SynResult<Self> {
/// input.parse::<Token![<]>()?;
/// input.parse::<Token![|]>()?;
/// input.parse::<Token![>]>()?;
///
/// SynResult::Ok(Self {})
/// }
/// }
///
/// impl LookaheadToken for TestToken { const SIZE: usize = 3; }
///
/// #[derive(Debug, PartialEq)]
/// struct Test { first: String, token: TestToken, second: String }
///
/// impl Parse for Test {
/// fn parse(input: ParseStream) -> SynResult<Self> {
/// SynResult::Ok(Self {
/// first: input.parse::<Ident>()?.to_string(),
/// token: input.step(|cursor| TestToken::lookahead (*cursor))?,
/// second: input.parse::<Ident>()?.to_string(),
/// })
/// }
/// }
///
/// assert_eq!(
/// parse2::<Test>(
/// TokenStream::from_str("first <|> second").map_err(|error| error.to_string()).unwrap()
/// ).map_err(|error| error.to_string()).unwrap(),
/// Test { first: "first".to_owned(), token: TestToken, second: "second".to_owned() }
/// );
/// ```
///
/// # Errors
/// Returns the [`syn::Error`] for the attempted lookahead if the [`Self`] can't be parsed.
#[allow(clippy::arithmetic_side_effects)]
#[inline]
fn lookahead(cursor: Cursor) -> SynResult<(Self, Cursor)> {
let mut limit = 0;
let (token_stream, current) = accumulate_while(cursor, |_| {
let should_continue = limit < Self::SIZE;
if should_continue {
limit += 1;
}
should_continue
})?;
parse2::<Self>(token_stream).map(|value| (value, current))
}
}
#[cfg(test)]
mod tests {
#[test]
fn should_accumulate_into_a_token_stream_and_move_the_cursor() -> Result<(), String> {
use crate::test::{build_tokens, parse_test};
use syn::{
parse::{Parse, ParseStream},
Result as SynResult,
};
use super::accumulate_while;
#[derive(Debug, PartialEq)]
struct Test {
value: String,
}
impl Parse for Test {
fn parse(input: ParseStream) -> SynResult<Self> {
SynResult::Ok(Self {
value: input
.step(|cursor| accumulate_while(*cursor, |current| !current.eof()))?
.to_string(),
})
}
}
let value = "ARBITRARY_VALUE";
let expected = Test {
value: value.to_owned(),
};
let input = value;
let output = parse_test::<Test>(build_tokens(&input)).map_err(|error| error.to_string())?;
assert_eq!(
output, expected,
"Testing `accumulate_while` parsing and cursor updates."
);
Result::Ok(())
}
#[test]
fn should_fail_when_accumulation_ends_before_predicate_returns_false() -> Result<(), String> {
use crate::error::unexpected_end_of_stream_message;
use crate::test::{build_tokens, parse_test, pretty_print};
use syn::{
parse::{Parse, ParseStream},
Result as SynResult,
};
use super::accumulate_while;
#[derive(Debug, PartialEq)]
struct Test {
value: String,
}
impl Parse for Test {
fn parse(input: ParseStream) -> SynResult<Self> {
SynResult::Ok(Self {
value: input.step(|cursor| accumulate_while(*cursor, |_| true))?.to_string(),
})
}
}
let expected = format!("::core::compile_error!{{\"{}\"}}", unexpected_end_of_stream_message());
let input = "ARBITRARY_VALUE";
let output = parse_test::<Test>(build_tokens(&input)).unwrap_err();
assert_eq!(
pretty_print(output),
pretty_print(build_tokens(&expected)),
"Testing `accumulate_while` accumulation failures."
);
Result::Ok(())
}
#[test]
fn should_parse_valid_lookahead_token_and_move_the_cursor() -> Result<(), String> {
use crate::test::{build_tokens, parse_test};
use syn::{
parse::{Parse, ParseStream},
Ident, Result as SynResult, Token,
};
use super::LookaheadToken;
#[derive(Debug, PartialEq)]
struct TestToken;
impl Parse for TestToken {
fn parse(input: ParseStream) -> SynResult<Self> {
input.parse::<Token![<]>()?;
input.parse::<Token![|]>()?;
input.parse::<Token![>]>()?;
SynResult::Ok(Self {})
}
}
impl LookaheadToken for TestToken {
const SIZE: usize = 3;
}
#[derive(Debug, PartialEq)]
struct Test {
first: String,
token: TestToken,
second: String,
}
impl Parse for Test {
fn parse(input: ParseStream) -> SynResult<Self> {
SynResult::Ok(Self {
first: input.parse::<Ident>()?.to_string(),
token: input.step(|cursor| TestToken::lookahead(*cursor))?,
second: input.parse::<Ident>()?.to_string(),
})
}
}
let first = "first";
let second = "second";
let expected = Test {
first: first.to_owned(),
token: TestToken,
second: second.to_owned(),
};
let input = format!("{first} <|> {second}");
let output = parse_test::<Test>(build_tokens(&input)).map_err(|error| error.to_string())?;
assert_eq!(
output, expected,
"Testing `LookahedToken.lookahead` parsing and cursor updates."
);
Result::Ok(())
}
}