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, MetaTemplate, ParseError};
   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) -> Result<Vec<Op>, ParseError> {
  50     parse_inner(&template, Mode::Template).into_iter().collect()
  51 }
  52
  53 pub(crate) fn parse_pattern(pattern: &tt::Subtree) -> Result<Vec<Op>, ParseError> {
  54     parse_inner(&pattern, Mode::Pattern).into_iter().collect()
  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, ParseError>> {
  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         ParseError::UnexpectedToken(($($tt)*).to_string())
  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, ParseError> {
  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                         .into_iter()
  98                         .collect::<Result<Vec<Op>, ParseError>>()?;
  99                     let subtree = MetaTemplate { tokens, delimiter };
 100                     Op::Repeat { subtree, separator, kind }
 101                 }
 102                 tt::TokenTree::Leaf(leaf) => match leaf {
 103                     tt::Leaf::Punct(punct) => {
 104                         static UNDERSCORE: SmolStr = SmolStr::new_inline("_");
 105
 106                         if punct.char != '_' {
 107                             return Err(ParseError::Expected("_".to_string()));
 108                         }
 109                         let name = UNDERSCORE.clone();
 110                         let kind = eat_fragment_kind(src, mode)?;
 111                         let id = punct.id;
 112                         Op::Var { name, kind, id }
 113                     }
 114                     tt::Leaf::Ident(ident) if ident.text == "crate" => {
 115                         // We simply produce identifier `$crate` here. And it will be resolved when lowering ast to Path.
 116                         Op::Leaf(tt::Leaf::from(tt::Ident { text: "$crate".into(), id: ident.id }))
 117                     }
 118                     tt::Leaf::Ident(ident) => {
 119                         let name = ident.text.clone();
 120                         let kind = eat_fragment_kind(src, mode)?;
 121                         let id = ident.id;
 122                         Op::Var { name, kind, id }
 123                     }
 124                     tt::Leaf::Literal(lit) => {
 125                         if is_boolean_literal(&lit) {
 126                             let name = lit.text.clone();
 127                             let kind = eat_fragment_kind(src, mode)?;
 128                             let id = lit.id;
 129                             Op::Var { name, kind, id }
 130                         } else {
 131                             bail!("bad var 2");
 132                         }
 133                     }
 134                 },
 135             }
 136         }
 137         tt::TokenTree::Leaf(tt) => Op::Leaf(tt.clone()),
 138         tt::TokenTree::Subtree(subtree) => {
 139             let delimiter = subtree.delimiter;
 140             let tokens =
 141                 parse_inner(&subtree, mode).into_iter().collect::<Result<Vec<Op>, ParseError>>()?;
 142
 143             let subtree = MetaTemplate { tokens, delimiter };
 144             Op::Subtree(subtree)
 145         }
 146     };
 147     Ok(res)
 148 }
 149
 150 fn eat_fragment_kind<'a>(src: &mut TtIter<'a>, mode: Mode) -> Result<Option<SmolStr>, ParseError> {
 151     if let Mode::Pattern = mode {
 152         src.expect_char(':').map_err(|()| err!("bad fragment specifier 1"))?;
 153         let ident = src.expect_ident().map_err(|()| err!("bad fragment specifier 1"))?;
 154         return Ok(Some(ident.text.clone()));
 155     };
 156     Ok(None)
 157 }
 158
 159 fn is_boolean_literal(lit: &tt::Literal) -> bool {
 160     matches!(lit.text.as_str(), "true" | "false")
 161 }
 162
 163 fn parse_repeat(src: &mut TtIter) -> Result<(Option<Separator>, RepeatKind), ParseError> {
 164     let mut separator = Separator::Puncts(SmallVec::new());
 165     for tt in src {
 166         let tt = match tt {
 167             tt::TokenTree::Leaf(leaf) => leaf,
 168             tt::TokenTree::Subtree(_) => return Err(ParseError::InvalidRepeat),
 169         };
 170         let has_sep = match &separator {
 171             Separator::Puncts(puncts) => !puncts.is_empty(),
 172             _ => true,
 173         };
 174         match tt {
 175             tt::Leaf::Ident(_) | tt::Leaf::Literal(_) if has_sep => {
 176                 return Err(ParseError::InvalidRepeat)
 177             }
 178             tt::Leaf::Ident(ident) => separator = Separator::Ident(ident.clone()),
 179             tt::Leaf::Literal(lit) => separator = Separator::Literal(lit.clone()),
 180             tt::Leaf::Punct(punct) => {
 181                 let repeat_kind = match punct.char {
 182                     '*' => RepeatKind::ZeroOrMore,
 183                     '+' => RepeatKind::OneOrMore,
 184                     '?' => RepeatKind::ZeroOrOne,
 185                     _ => {
 186                         match &mut separator {
 187                             Separator::Puncts(puncts) => {
 188                                 if puncts.len() == 3 {
 189                                     return Err(ParseError::InvalidRepeat);
 190                                 }
 191                                 puncts.push(punct.clone())
 192                             }
 193                             _ => return Err(ParseError::InvalidRepeat),
 194                         }
 195                         continue;
 196                     }
 197                 };
 198                 let separator = if has_sep { Some(separator) } else { None };
 199                 return Ok((separator, repeat_kind));
 200             }
 201         }
 202     }
 203     Err(ParseError::InvalidRepeat)
 204 }