crates/mbe/src/parser.rs

   1 //! Parser recognizes special macro syntax, `$var` and `$(repeat)*`, in token
   2 //! trees.
   3
   4 use smallvec::SmallVec;
   5 use syntax::SmolStr;
   6
   7 use crate::{tt_iter::TtIter, ExpandError, MetaTemplate};
   8
   9 #[derive(Clone, Debug, PartialEq, Eq)]
  10 pub(crate) enum Op {
  11     Var { name: SmolStr, kind: Option<SmolStr>, id: tt::TokenId },
  12     Repeat { subtree: MetaTemplate, kind: RepeatKind, separator: Option<Separator> },
  13     Leaf(tt::Leaf),
  14     Subtree(MetaTemplate),
  15 }
  16
  17 #[derive(Copy, Clone, Debug, PartialEq, Eq)]
  18 pub(crate) enum RepeatKind {
  19     ZeroOrMore,
  20     OneOrMore,
  21     ZeroOrOne,
  22 }
  23
  24 #[derive(Clone, Debug, Eq)]
  25 pub(crate) enum Separator {
  26     Literal(tt::Literal),
  27     Ident(tt::Ident),
  28     Puncts(SmallVec<[tt::Punct; 3]>),
  29 }
  30
  31 // Note that when we compare a Separator, we just care about its textual value.
  32 impl PartialEq for Separator {
  33     fn eq(&self, other: &Separator) -> bool {
  34         use Separator::*;
  35
  36         match (self, other) {
  37             (Ident(ref a), Ident(ref b)) => a.text == b.text,
  38             (Literal(ref a), Literal(ref b)) => a.text == b.text,
  39             (Puncts(ref a), Puncts(ref b)) if a.len() == b.len() => {
  40                 let a_iter = a.iter().map(|a| a.char);
  41                 let b_iter = b.iter().map(|b| b.char);
  42                 a_iter.eq(b_iter)
  43             }
  44             _ => false,
  45         }
  46     }
  47 }
  48
  49 pub(crate) fn parse_template(template: &tt::Subtree) -> Vec<Result<Op, ExpandError>> {
  50     parse_inner(&template, Mode::Template)
  51 }
  52
  53 pub(crate) fn parse_pattern(pattern: &tt::Subtree) -> Vec<Result<Op, ExpandError>> {
  54     parse_inner(&pattern, Mode::Pattern)
  55 }
  56
  57 #[derive(Clone, Copy)]
  58 enum Mode {
  59     Pattern,
  60     Template,
  61 }
  62
  63 fn parse_inner(tt: &tt::Subtree, mode: Mode) -> Vec<Result<Op, ExpandError>> {
  64     let mut src = TtIter::new(&tt);
  65     std::iter::from_fn(move || {
  66         let first = src.next()?;
  67         Some(next_op(first, &mut src, mode))
  68     })
  69     .collect()
  70 }
  71
  72 macro_rules! err {
  73     ($($tt:tt)*) => {
  74         ExpandError::UnexpectedToken
  75     };
  76 }
  77
  78 macro_rules! bail {
  79     ($($tt:tt)*) => {
  80         return Err(err!($($tt)*))
  81     };
  82 }
  83
  84 fn next_op<'a>(first: &tt::TokenTree, src: &mut TtIter<'a>, mode: Mode) -> Result<Op, ExpandError> {
  85     let res = match first {
  86         tt::TokenTree::Leaf(leaf @ tt::Leaf::Punct(tt::Punct { char: '$', .. })) => {
  87             // Note that the '$' itself is a valid token inside macro_rules.
  88             let second = match src.next() {
  89                 None => return Ok(Op::Leaf(leaf.clone())),
  90                 Some(it) => it,
  91             };
  92             match second {
  93                 tt::TokenTree::Subtree(subtree) => {
  94                     let (separator, kind) = parse_repeat(src)?;
  95                     let delimiter = subtree.delimiter;
  96                     let tokens = parse_inner(&subtree, mode);
  97                     let subtree = MetaTemplate { tokens, delimiter };
  98                     Op::Repeat { subtree, separator, kind }
  99                 }
 100                 tt::TokenTree::Leaf(leaf) => match leaf {
 101                     tt::Leaf::Punct(punct) => {
 102                         static UNDERSCORE: SmolStr = SmolStr::new_inline("_");
 103
 104                         if punct.char != '_' {
 105                             return Err(ExpandError::UnexpectedToken);
 106                         }
 107                         let name = UNDERSCORE.clone();
 108                         let kind = eat_fragment_kind(src, mode)?;
 109                         let id = punct.id;
 110                         Op::Var { name, kind, id }
 111                     }
 112                     tt::Leaf::Ident(ident) if ident.text == "crate" => {
 113                         // We simply produce identifier `$crate` here. And it will be resolved when lowering ast to Path.
 114                         Op::Leaf(tt::Leaf::from(tt::Ident { text: "$crate".into(), id: ident.id }))
 115                     }
 116                     tt::Leaf::Ident(ident) => {
 117                         let name = ident.text.clone();
 118                         let kind = eat_fragment_kind(src, mode)?;
 119                         let id = ident.id;
 120                         Op::Var { name, kind, id }
 121                     }
 122                     tt::Leaf::Literal(lit) => {
 123                         if is_boolean_literal(&lit) {
 124                             let name = lit.text.clone();
 125                             let kind = eat_fragment_kind(src, mode)?;
 126                             let id = lit.id;
 127                             Op::Var { name, kind, id }
 128                         } else {
 129                             bail!("bad var 2");
 130                         }
 131                     }
 132                 },
 133             }
 134         }
 135         tt::TokenTree::Leaf(tt) => Op::Leaf(tt.clone()),
 136         tt::TokenTree::Subtree(subtree) => {
 137             let delimiter = subtree.delimiter;
 138             let tokens = parse_inner(&subtree, mode);
 139             let subtree = MetaTemplate { tokens, delimiter };
 140             Op::Subtree(subtree)
 141         }
 142     };
 143     Ok(res)
 144 }
 145
 146 fn eat_fragment_kind<'a>(src: &mut TtIter<'a>, mode: Mode) -> Result<Option<SmolStr>, ExpandError> {
 147     if let Mode::Pattern = mode {
 148         src.expect_char(':').map_err(|()| err!("bad fragment specifier 1"))?;
 149         let ident = src.expect_ident().map_err(|()| err!("bad fragment specifier 1"))?;
 150         return Ok(Some(ident.text.clone()));
 151     };
 152     Ok(None)
 153 }
 154
 155 fn is_boolean_literal(lit: &tt::Literal) -> bool {
 156     matches!(lit.text.as_str(), "true" | "false")
 157 }
 158
 159 fn parse_repeat(src: &mut TtIter) -> Result<(Option<Separator>, RepeatKind), ExpandError> {
 160     let mut separator = Separator::Puncts(SmallVec::new());
 161     for tt in src {
 162         let tt = match tt {
 163             tt::TokenTree::Leaf(leaf) => leaf,
 164             tt::TokenTree::Subtree(_) => return Err(ExpandError::InvalidRepeat),
 165         };
 166         let has_sep = match &separator {
 167             Separator::Puncts(puncts) => !puncts.is_empty(),
 168             _ => true,
 169         };
 170         match tt {
 171             tt::Leaf::Ident(_) | tt::Leaf::Literal(_) if has_sep => {
 172                 return Err(ExpandError::InvalidRepeat)
 173             }
 174             tt::Leaf::Ident(ident) => separator = Separator::Ident(ident.clone()),
 175             tt::Leaf::Literal(lit) => separator = Separator::Literal(lit.clone()),
 176             tt::Leaf::Punct(punct) => {
 177                 let repeat_kind = match punct.char {
 178                     '*' => RepeatKind::ZeroOrMore,
 179                     '+' => RepeatKind::OneOrMore,
 180                     '?' => RepeatKind::ZeroOrOne,
 181                     _ => {
 182                         match &mut separator {
 183                             Separator::Puncts(puncts) => {
 184                                 if puncts.len() == 3 {
 185                                     return Err(ExpandError::InvalidRepeat);
 186                                 }
 187                                 puncts.push(punct.clone())
 188                             }
 189                             _ => return Err(ExpandError::InvalidRepeat),
 190                         }
 191                         continue;
 192                     }
 193                 };
 194                 let separator = if has_sep { Some(separator) } else { None };
 195                 return Ok((separator, repeat_kind));
 196             }
 197         }
 198     }
 199     Err(ExpandError::InvalidRepeat)
 200 }