chumsky_proc_macro/

lib.rs

use chumsky::{
    extra::ParserExtra, input::ValueInput, label::LabelError, util::MaybeRef, IterParser, Parser,
};
use proc_macro2::TokenTree;
use std::{fmt, vec};

pub trait LikeTokenTree {
    fn as_tok(&self) -> &TokenTree;
}

impl LikeTokenTree for TokenTree {
    fn as_tok(&self) -> &TokenTree {
        self
    }
}

impl LikeTokenTree for (TokenTree, proc_macro2::Span) {
    fn as_tok(&self) -> &TokenTree {
        &self.0
    }
}

#[derive(Clone, Debug)]
pub struct TokenTreeWrapper(pub TokenTree);

impl fmt::Display for TokenTreeWrapper {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "{}", self.0)
    }
}

impl PartialEq for TokenTreeWrapper {
    fn eq(&self, _other: &Self) -> bool {
        false
    }
}

impl Eq for TokenTreeWrapper {}

impl LikeTokenTree for TokenTreeWrapper {
    fn as_tok(&self) -> &TokenTree {
        &self.0
    }
}

#[derive(Debug)]
#[non_exhaustive]
pub enum Expected {
    StandAlonePunct(char),
    PunctSeq(String),
    Ident,
    ExactIdent(String),
}

impl<'a, T> From<Expected> for chumsky::error::RichPattern<'a, T> {
    fn from(value: Expected) -> Self {
        use chumsky::error::RichPattern;

        match value {
            Expected::StandAlonePunct(p) => RichPattern::Label(format!("'{}'", p).into()),
            Expected::PunctSeq(p) => RichPattern::Label(format!("'{}'", p).into()),
            Expected::Ident => RichPattern::Label("identifier".into()),
            Expected::ExactIdent(p) => RichPattern::Identifier(p),
        }
    }
}

/// A single punctuation character like `+`, `-` or `#`.
pub fn punct<'src, I, E>(val: char) -> impl Parser<'src, I, (), E> + Clone
where
    I: ValueInput<'src>,
    I::Token: LikeTokenTree + 'src,
    E: ParserExtra<'src, I>,
    E::Error: LabelError<'src, I, Expected>,
{
    punct_impl(val)
}

fn punct_impl<'src, I, E>(val: char) -> impl Parser<'src, I, (), E> + Clone
where
    I: ValueInput<'src>,
    I::Token: LikeTokenTree + 'src,
    E: ParserExtra<'src, I>,
    E::Error: LabelError<'src, I, Expected>,
{
    use chumsky::prelude::*;
    any().try_map(move |x: I::Token, span| {
        match &x.as_tok() {
            TokenTree::Punct(p) => {
                // disabled spacing check because proc macro sucks
                if
                /*p.spacing() == spacing &&*/
                p.as_char() == val {
                    Some(())
                } else {
                    None
                }
            }

            _ => None,
        }
        .ok_or_else(|| {
            LabelError::expected_found(
                [Expected::StandAlonePunct(val)],
                Some(MaybeRef::Val(x)),
                span,
            )
        })
    })
}

/// A sequence of punctuation character like `+=`, '--', or even `#<##>`.
pub fn punct_seq<'src, I, E, S: AsRef<str>>(seq: S) -> impl Parser<'src, I, (), E> + Clone
where
    I: ValueInput<'src>,
    I::Token: LikeTokenTree + 'src,
    E: ParserExtra<'src, I> + 'src,
    E::Error: LabelError<'src, I, Expected>,
{
    use chumsky::prelude::*;

    let seq = seq.as_ref().to_string();
    assert!(!seq.len() >= 2);

    seq.chars()
        .map(|val| punct_impl(val).boxed())
        .reduce(|a, b| a.then_ignore(b).boxed())
        .unwrap_or(empty().boxed())
        .map_err_with_state(move |_, span, _| {
            LabelError::expected_found([Expected::PunctSeq(seq.clone())], None, span)
        })
}

pub fn ident<'src, I, E>() -> impl Parser<'src, I, String, E> + Clone
where
    I: ValueInput<'src>,
    I::Token: LikeTokenTree + 'src,
    E: ParserExtra<'src, I>,
    E::Error: LabelError<'src, I, Expected>,
{
    use chumsky::prelude::*;

    any().try_map(move |x: I::Token, span| {
        match &x.as_tok() {
            TokenTree::Ident(i) => Some(i.to_string()),
            _ => None,
        }
        .ok_or_else(|| LabelError::expected_found([Expected::Ident], Some(MaybeRef::Val(x)), span))
    })
}

pub fn exact_ident<'src, I, E, S>(exact: S) -> impl Parser<'src, I, (), E> + Clone
where
    S: AsRef<str> + Clone,
    I: ValueInput<'src>,
    I::Token: LikeTokenTree + 'src,
    E: ParserExtra<'src, I>,
    E::Error: LabelError<'src, I, Expected>,
{
    use chumsky::prelude::*;

    any().try_map(move |x: I::Token, span| {
        match &x.as_tok() {
            TokenTree::Ident(i) if i.to_string().as_str() == exact.as_ref() => Some(()),
            _ => None,
        }
        .ok_or_else(|| {
            LabelError::expected_found(
                [Expected::ExactIdent(exact.as_ref().to_string())],
                Some(MaybeRef::Val(x)),
                span,
            )
        })
    })
}

pub fn namespace_with_ident<'src, I, E>() -> impl IterParser<'src, I, String, E> + Clone
where
    I: ValueInput<'src>,
    I::Token: LikeTokenTree + 'src,
    E: ParserExtra<'src, I> + 'src,
    E::Error: LabelError<'src, I, Expected>,
{
    use chumsky::prelude::*;

    ident().separated_by(punct_seq("::")).at_least(1)
}

/// A literal character (`'a'`), string (`"hello"`), number (`2.3`), etc.
pub fn literal<'src, I, E>() -> impl Parser<'src, I, String, E> + Clone
where
    I: ValueInput<'src>,
    I::Token: LikeTokenTree + 'src,
    E: ParserExtra<'src, I>,
    E::Error: LabelError<'src, I, Expected>,
{
    use chumsky::prelude::*;

    any().try_map(move |x: I::Token, span| {
        match &x.as_tok() {
            TokenTree::Literal(i) => Some(i.to_string()),
            _ => None,
        }
        .ok_or_else(|| LabelError::expected_found([Expected::Ident], Some(MaybeRef::Val(x)), span))
    })
}

pub enum GroupDelim {
    /// `( ... )`
    Parenthesis,
    /// `{ ... }`
    Brace,
    /// `[ ... ]`
    Bracket,
}

impl GroupDelim {
    fn to_procmacro(&self) -> proc_macro2::Delimiter {
        match self {
            GroupDelim::Brace => proc_macro2::Delimiter::Brace,
            GroupDelim::Bracket => proc_macro2::Delimiter::Bracket,
            GroupDelim::Parenthesis => proc_macro2::Delimiter::Parenthesis,
        }
    }
}

pub trait GroupExtension<P, PE> {
    fn grouped(self, delim: GroupDelim) -> P;
}

impl<'wholesrc, 'partsrc, 'b, WI, V, WE, PP, PE>
    GroupExtension<chumsky::Boxed<'wholesrc, 'b, WI, V, WE>, PE> for PP
where
    WI: ValueInput<'wholesrc> + 'b,
    WI::Token: LikeTokenTree + 'wholesrc + 'b,
    WE: ParserExtra<'wholesrc, WI> + 'b,
    WE::Error: LabelError<'wholesrc, WI, Expected>,
    PP: Parser<'partsrc, chumsky::input::Stream<vec::IntoIter<TokenTreeWrapper>>, V, PE>
        + 'b + 'wholesrc,
    PE: ParserExtra<'partsrc, chumsky::input::Stream<vec::IntoIter<TokenTreeWrapper>>>,
    PE::Context: Default,
    PE::State: Default,
    PE::Error:
        LabelError<'partsrc, chumsky::input::Stream<vec::IntoIter<TokenTreeWrapper>>, Expected>,
    WE::Error: From<PE::Error>,
{
    fn grouped(self, delim: GroupDelim) -> chumsky::Boxed<'wholesrc, 'b, WI, V, WE> {
        use chumsky::prelude::*;
        any()
            .try_map(move |x: WI::Token, span: WI::Span| match &x.as_tok() {
                TokenTree::Group(i) if i.delimiter() == delim.to_procmacro() => self
                    .parse(chumsky::input::Stream::from_iter(
                        i.stream()
                            .into_iter()
                            .map(|x| TokenTreeWrapper(x))
                            .collect::<Vec<_>>()
                            .into_iter(),
                    ))
                    .into_result()
                    .map_err(|x| x.into_iter().reduce(|a, b| a.merge(b)).unwrap().into()),
                _ => Err(LabelError::expected_found(
                    [Expected::Ident],
                    Some(MaybeRef::Val(x)),
                    span,
                )),
            })
            .boxed()
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use chumsky::{extra::Err, input::Stream, prelude::*};
    use quote::quote;

    #[test]
    fn test_punct() {
        let toks = quote! { + }.into_iter();

        let parser = &punct::<_, Err<Simple<_>>>('+');
        let _v = parser.parse(Stream::from_iter(toks)).into_result().unwrap();
    }

    #[test]
    fn test_punct2() {
        let toks = quote! { += }.into_iter();

        let parser = &punct::<_, Err<Simple<_>>>('+');
        let _v = parser
            .parse(Stream::from_iter(toks))
            .into_result()
            .unwrap_err();
    }

    #[test]
    fn test_punct_seq() {
        let toks = quote! { --> }.into_iter();

        let parser = &punct_seq::<_, Err<Simple<_>>, _>("-->");
        let _v = parser.parse(Stream::from_iter(toks)).into_result().unwrap();
    }

    #[test]
    fn test_punct_seq2() {
        let toks = quote! { -> }.into_iter();

        let parser = &punct_seq::<_, Err<Simple<_>>, _>("-->");
        let _v = parser
            .parse(Stream::from_iter(toks))
            .into_result()
            .unwrap_err();
    }

    #[test]
    fn test_punct_seq3() {
        let toks = quote! { --># }.into_iter();

        let parser = &punct_seq::<_, Err<Simple<_>>, _>("-->");
        let _v = parser
            .parse(Stream::from_iter(toks))
            .into_result()
            .unwrap_err();
    }

    #[test]
    fn test_punct_seq4() {
        let toks = quote! { ---> }.into_iter();

        let parser = &punct_seq::<_, Err<Simple<_>>, _>("-->");
        let _v = parser
            .parse(Stream::from_iter(toks))
            .into_result()
            .unwrap_err();
    }

    #[test]
    fn test_punct_seq5() {
        let toks = quote! { -> }.into_iter();

        let parser = &punct_seq::<_, Err<Simple<_>>, _>("->");
        let _v = parser.parse(Stream::from_iter(toks)).into_result().unwrap();
    }

    #[test]
    fn test_punct_seq6() {
        let toks = quote! { ->< }.into_iter();

        let parser = &punct_seq::<_, Err<Simple<_>>, _>("->").then(punct('<'));
        let _v = parser.parse(Stream::from_iter(toks)).into_result().unwrap();
    }

    #[test]
    fn test_punct_seq7() {
        let toks = quote! { ---> }.into_iter();

        let parser = &punct_seq::<_, Err<Simple<_>>, _>("--->");
        let _v = parser.parse(Stream::from_iter(toks)).into_result().unwrap();
    }

    #[test]
    fn test_punct_seq8() {
        let toks = quote! { ++++ }.into_iter();

        let parser = &punct_seq::<_, Err<Simple<_>>, _>("++++");
        let _v = parser.parse(Stream::from_iter(toks)).into_result().unwrap();
    }

    #[test]
    fn test_ident0() {
        let toks = quote! { hello_world }.into_iter();

        let parser = &ident::<_, Err<Simple<_>>>();
        let _v = parser.parse(Stream::from_iter(toks)).into_result().unwrap();
    }

    #[test]
    fn test_ident1() {
        let toks = quote! { 1 2 3 }.into_iter();

        let parser = &ident::<_, Err<Simple<_>>>();
        let _v = parser
            .parse(Stream::from_iter(toks))
            .into_result()
            .unwrap_err();
    }

    #[test]
    fn test_exact_ident0() {
        let toks = quote! { hey }.into_iter();

        let parser = &exact_ident::<_, Err<Simple<_>>, _>("hey");
        let _v = parser.parse(Stream::from_iter(toks)).into_result().unwrap();
    }

    #[test]
    fn test_exact_ident1() {
        let toks = quote! { heey }.into_iter();

        let parser = &exact_ident::<_, Err<Simple<_>>, _>("hey");
        let _v = parser
            .parse(Stream::from_iter(toks))
            .into_result()
            .unwrap_err();
    }

    #[test]
    fn test_namespace_indent() {
        let toks = quote! { hello::world::test }.into_iter();

        let parser = &namespace_with_ident::<_, Err<Simple<_>>>().collect::<Vec<_>>();
        let _v = parser.parse(Stream::from_iter(toks)).into_result().unwrap();
    }

    #[test]
    fn test_literal() {
        let toks = quote! { "hey" }.into_iter();

        let parser = &literal::<_, Err<Simple<_>>>();
        let _v = parser.parse(Stream::from_iter(toks)).into_result().unwrap();
    }

    #[test]
    fn test_group() {
        let toks = quote! { hello (world::x) }.into_iter();

        let parser = &namespace_with_ident::<_, Err<Rich<_>>>()
            .collect::<Vec<_>>()
            .then(
                namespace_with_ident::<_, Err<Rich<_>>>()
                    .collect::<Vec<_>>()
                    .grouped(GroupDelim::Parenthesis),
            );
        let _v = parser
            .parse(Stream::from_iter(toks.map(|x| TokenTreeWrapper(x))))
            .into_result()
            .unwrap();
    }
}