src/libsyntax/ext/tt/macro_parser.rs

   1 // Copyright 2012-2014 The Rust Project Developers. See the COPYRIGHT
   2 // file at the top-level directory of this distribution and at
   3 // http://rust-lang.org/COPYRIGHT.
   4 //
   5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
   6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
   7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
   8 // option. This file may not be copied, modified, or distributed
   9 // except according to those terms.
  10
  11 // Earley-like parser for macros.
  12
  13 use ast;
  14 use ast::{Matcher, MatchTok, MatchSeq, MatchNonterminal, Ident};
  15 use codemap::{BytePos, mk_sp};
  16 use codemap;
  17 use parse::lexer::*; //resolve bug?
  18 use parse::ParseSess;
  19 use parse::attr::ParserAttr;
  20 use parse::parser::{LifetimeAndTypesWithoutColons, Parser};
  21 use parse::token::{Token, EOF, Nonterminal};
  22 use parse::token;
  23
  24 use std::rc::Rc;
  25 use std::collections::HashMap;
  26
  27 /* This is an Earley-like parser, without support for in-grammar nonterminals,
  28 only by calling out to the main rust parser for named nonterminals (which it
  29 commits to fully when it hits one in a grammar). This means that there are no
  30 completer or predictor rules, and therefore no need to store one column per
  31 token: instead, there's a set of current Earley items and a set of next
  32 ones. Instead of NTs, we have a special case for Kleene star. The big-O, in
  33 pathological cases, is worse than traditional Earley parsing, but it's an
  34 easier fit for Macro-by-Example-style rules, and I think the overhead is
  35 lower. (In order to prevent the pathological case, we'd need to lazily
  36 construct the resulting `NamedMatch`es at the very end. It'd be a pain,
  37 and require more memory to keep around old items, but it would also save
  38 overhead)*/
  39
  40 /* Quick intro to how the parser works:
  41
  42 A 'position' is a dot in the middle of a matcher, usually represented as a
  43 dot. For example `· a $( a )* a b` is a position, as is `a $( · a )* a b`.
  44
  45 The parser walks through the input a character at a time, maintaining a list
  46 of items consistent with the current position in the input string: `cur_eis`.
  47
  48 As it processes them, it fills up `eof_eis` with items that would be valid if
  49 the macro invocation is now over, `bb_eis` with items that are waiting on
  50 a Rust nonterminal like `$e:expr`, and `next_eis` with items that are waiting
  51 on the a particular token. Most of the logic concerns moving the · through the
  52 repetitions indicated by Kleene stars. It only advances or calls out to the
  53 real Rust parser when no `cur_eis` items remain
  54
  55 Example: Start parsing `a a a a b` against [· a $( a )* a b].
  56
  57 Remaining input: `a a a a b`
  58 next_eis: [· a $( a )* a b]
  59
  60 - - - Advance over an `a`. - - -
  61
  62 Remaining input: `a a a b`
  63 cur: [a · $( a )* a b]
  64 Descend/Skip (first item).
  65 next: [a $( · a )* a b]  [a $( a )* · a b].
  66
  67 - - - Advance over an `a`. - - -
  68
  69 Remaining input: `a a b`
  70 cur: [a $( a · )* a b]  next: [a $( a )* a · b]
  71 Finish/Repeat (first item)
  72 next: [a $( a )* · a b]  [a $( · a )* a b]  [a $( a )* a · b]
  73
  74 - - - Advance over an `a`. - - - (this looks exactly like the last step)
  75
  76 Remaining input: `a b`
  77 cur: [a $( a · )* a b]  next: [a $( a )* a · b]
  78 Finish/Repeat (first item)
  79 next: [a $( a )* · a b]  [a $( · a )* a b]  [a $( a )* a · b]
  80
  81 - - - Advance over an `a`. - - - (this looks exactly like the last step)
  82
  83 Remaining input: `b`
  84 cur: [a $( a · )* a b]  next: [a $( a )* a · b]
  85 Finish/Repeat (first item)
  86 next: [a $( a )* · a b]  [a $( · a )* a b]
  87
  88 - - - Advance over a `b`. - - -
  89
  90 Remaining input: ``
  91 eof: [a $( a )* a b ·]
  92
  93  */
  94
  95
  96 /* to avoid costly uniqueness checks, we require that `MatchSeq` always has a
  97 nonempty body. */
  98
  99
 100 #[deriving(Clone)]
 101 pub struct MatcherPos {
 102     elts: Vec<ast::Matcher> , // maybe should be <'>? Need to understand regions.
 103     sep: Option<Token>,
 104     idx: uint,
 105     up: Option<Box<MatcherPos>>,
 106     matches: Vec<Vec<Rc<NamedMatch>>>,
 107     match_lo: uint, match_hi: uint,
 108     sp_lo: BytePos,
 109 }
 110
 111 pub fn count_names(ms: &[Matcher]) -> uint {
 112     ms.iter().fold(0, |ct, m| {
 113         ct + match m.node {
 114             MatchTok(_) => 0u,
 115             MatchSeq(ref more_ms, _, _, _, _) => {
 116                 count_names(more_ms.as_slice())
 117             }
 118             MatchNonterminal(_, _, _) => 1u
 119         }})
 120 }
 121
 122 pub fn initial_matcher_pos(ms: Vec<Matcher> , sep: Option<Token>, lo: BytePos)
 123                            -> Box<MatcherPos> {
 124     let mut match_idx_hi = 0u;
 125     for elt in ms.iter() {
 126         match elt.node {
 127             MatchTok(_) => (),
 128             MatchSeq(_,_,_,_,hi) => {
 129                 match_idx_hi = hi;       // it is monotonic...
 130             }
 131             MatchNonterminal(_,_,pos) => {
 132                 match_idx_hi = pos+1u;  // ...so latest is highest
 133             }
 134         }
 135     }
 136     let matches = Vec::from_fn(count_names(ms.as_slice()), |_i| Vec::new());
 137     box MatcherPos {
 138         elts: ms,
 139         sep: sep,
 140         idx: 0u,
 141         up: None,
 142         matches: matches,
 143         match_lo: 0u,
 144         match_hi: match_idx_hi,
 145         sp_lo: lo
 146     }
 147 }
 148
 149 // NamedMatch is a pattern-match result for a single ast::MatchNonterminal:
 150 // so it is associated with a single ident in a parse, and all
 151 // MatchedNonterminal's in the NamedMatch have the same nonterminal type
 152 // (expr, item, etc). All the leaves in a single NamedMatch correspond to a
 153 // single matcher_nonterminal in the ast::Matcher that produced it.
 154 //
 155 // It should probably be renamed, it has more or less exact correspondence to
 156 // ast::match nodes, and the in-memory structure of a particular NamedMatch
 157 // represents the match that occurred when a particular subset of an
 158 // ast::match -- those ast::Matcher nodes leading to a single
 159 // MatchNonterminal -- was applied to a particular token tree.
 160 //
 161 // The width of each MatchedSeq in the NamedMatch, and the identity of the
 162 // MatchedNonterminal's, will depend on the token tree it was applied to: each
 163 // MatchedSeq corresponds to a single MatchSeq in the originating
 164 // ast::Matcher. The depth of the NamedMatch structure will therefore depend
 165 // only on the nesting depth of ast::MatchSeq's in the originating
 166 // ast::Matcher it was derived from.
 167
 168 pub enum NamedMatch {
 169     MatchedSeq(Vec<Rc<NamedMatch>>, codemap::Span),
 170     MatchedNonterminal(Nonterminal)
 171 }
 172
 173 pub fn nameize(p_s: &ParseSess, ms: &[Matcher], res: &[Rc<NamedMatch>])
 174             -> HashMap<Ident, Rc<NamedMatch>> {
 175     fn n_rec(p_s: &ParseSess, m: &Matcher, res: &[Rc<NamedMatch>],
 176              ret_val: &mut HashMap<Ident, Rc<NamedMatch>>) {
 177         match *m {
 178           codemap::Spanned {node: MatchTok(_), .. } => (),
 179           codemap::Spanned {node: MatchSeq(ref more_ms, _, _, _, _), .. } => {
 180             for next_m in more_ms.iter() {
 181                 n_rec(p_s, next_m, res, ret_val)
 182             };
 183           }
 184           codemap::Spanned {
 185                 node: MatchNonterminal(bind_name, _, idx),
 186                 span
 187           } => {
 188             if ret_val.contains_key(&bind_name) {
 189                 let string = token::get_ident(bind_name);
 190                 p_s.span_diagnostic
 191                    .span_fatal(span,
 192                                format!("duplicated bind name: {}",
 193                                        string.get()).as_slice())
 194             }
 195             ret_val.insert(bind_name, res[idx].clone());
 196           }
 197         }
 198     }
 199     let mut ret_val = HashMap::new();
 200     for m in ms.iter() { n_rec(p_s, m, res, &mut ret_val) }
 201     ret_val
 202 }
 203
 204 pub enum ParseResult {
 205     Success(HashMap<Ident, Rc<NamedMatch>>),
 206     Failure(codemap::Span, String),
 207     Error(codemap::Span, String)
 208 }
 209
 210 pub fn parse_or_else(sess: &ParseSess,
 211                      cfg: ast::CrateConfig,
 212                      rdr: TtReader,
 213                      ms: Vec<Matcher> )
 214                      -> HashMap<Ident, Rc<NamedMatch>> {
 215     match parse(sess, cfg, rdr, ms.as_slice()) {
 216         Success(m) => m,
 217         Failure(sp, str) => {
 218             sess.span_diagnostic.span_fatal(sp, str.as_slice())
 219         }
 220         Error(sp, str) => {
 221             sess.span_diagnostic.span_fatal(sp, str.as_slice())
 222         }
 223     }
 224 }
 225
 226 // perform a token equality check, ignoring syntax context (that is, an unhygienic comparison)
 227 pub fn token_name_eq(t1 : &Token, t2 : &Token) -> bool {
 228     match (t1,t2) {
 229         (&token::IDENT(id1,_),&token::IDENT(id2,_))
 230         | (&token::LIFETIME(id1),&token::LIFETIME(id2)) =>
 231             id1.name == id2.name,
 232         _ => *t1 == *t2
 233     }
 234 }
 235
 236 pub fn parse(sess: &ParseSess,
 237              cfg: ast::CrateConfig,
 238              mut rdr: TtReader,
 239              ms: &[Matcher])
 240              -> ParseResult {
 241     let mut cur_eis = Vec::new();
 242     cur_eis.push(initial_matcher_pos(ms.iter()
 243                                        .map(|x| (*x).clone())
 244                                        .collect(),
 245                                      None,
 246                                      rdr.peek().sp.lo));
 247
 248     loop {
 249         let mut bb_eis = Vec::new(); // black-box parsed by parser.rs
 250         let mut next_eis = Vec::new(); // or proceed normally
 251         let mut eof_eis = Vec::new();
 252
 253         let TokenAndSpan {tok: tok, sp: sp} = rdr.peek();
 254
 255         /* we append new items to this while we go */
 256         loop {
 257             let ei = match cur_eis.pop() {
 258                 None => break, /* for each Earley Item */
 259                 Some(ei) => ei,
 260             };
 261
 262             let idx = ei.idx;
 263             let len = ei.elts.len();
 264
 265             /* at end of sequence */
 266             if idx >= len {
 267                 // can't move out of `match`es, so:
 268                 if ei.up.is_some() {
 269                     // hack: a matcher sequence is repeating iff it has a
 270                     // parent (the top level is just a container)
 271
 272
 273                     // disregard separator, try to go up
 274                     // (remove this condition to make trailing seps ok)
 275                     if idx == len {
 276                         // pop from the matcher position
 277
 278                         let mut new_pos = ei.up.clone().unwrap();
 279
 280                         // update matches (the MBE "parse tree") by appending
 281                         // each tree as a subtree.
 282
 283                         // I bet this is a perf problem: we're preemptively
 284                         // doing a lot of array work that will get thrown away
 285                         // most of the time.
 286
 287                         // Only touch the binders we have actually bound
 288                         for idx in range(ei.match_lo, ei.match_hi) {
 289                             let sub = (*ei.matches.get(idx)).clone();
 290                             new_pos.matches
 291                                    .get_mut(idx)
 292                                    .push(Rc::new(MatchedSeq(sub, mk_sp(ei.sp_lo,
 293                                                                        sp.hi))));
 294                         }
 295
 296                         new_pos.idx += 1;
 297                         cur_eis.push(new_pos);
 298                     }
 299
 300                     // can we go around again?
 301
 302                     // the *_t vars are workarounds for the lack of unary move
 303                     match ei.sep {
 304                       Some(ref t) if idx == len => { // we need a separator
 305                         // i'm conflicted about whether this should be hygienic....
 306                         // though in this case, if the separators are never legal
 307                         // idents, it shouldn't matter.
 308                         if token_name_eq(&tok, t) { //pass the separator
 309                             let mut ei_t = ei.clone();
 310                             ei_t.idx += 1;
 311                             next_eis.push(ei_t);
 312                         }
 313                       }
 314                       _ => { // we don't need a separator
 315                         let mut ei_t = ei;
 316                         ei_t.idx = 0;
 317                         cur_eis.push(ei_t);
 318                       }
 319                     }
 320                 } else {
 321                     eof_eis.push(ei);
 322                 }
 323             } else {
 324                 match ei.elts.get(idx).node.clone() {
 325                   /* need to descend into sequence */
 326                   MatchSeq(ref matchers, ref sep, zero_ok,
 327                            match_idx_lo, match_idx_hi) => {
 328                     if zero_ok {
 329                         let mut new_ei = ei.clone();
 330                         new_ei.idx += 1u;
 331                         //we specifically matched zero repeats.
 332                         for idx in range(match_idx_lo, match_idx_hi) {
 333                             new_ei.matches
 334                                   .get_mut(idx)
 335                                   .push(Rc::new(MatchedSeq(Vec::new(), sp)));
 336                         }
 337
 338                         cur_eis.push(new_ei);
 339                     }
 340
 341                     let matches = Vec::from_elem(ei.matches.len(), Vec::new());
 342                     let ei_t = ei;
 343                     cur_eis.push(box MatcherPos {
 344                         elts: (*matchers).clone(),
 345                         sep: (*sep).clone(),
 346                         idx: 0u,
 347                         up: Some(ei_t),
 348                         matches: matches,
 349                         match_lo: match_idx_lo, match_hi: match_idx_hi,
 350                         sp_lo: sp.lo
 351                     });
 352                   }
 353                   MatchNonterminal(_,_,_) => { bb_eis.push(ei) }
 354                   MatchTok(ref t) => {
 355                     let mut ei_t = ei.clone();
 356                     //if (token_name_eq(t,&tok)) {
 357                     if token::mtwt_token_eq(t,&tok) {
 358                         ei_t.idx += 1;
 359                         next_eis.push(ei_t);
 360                     }
 361                   }
 362                 }
 363             }
 364         }
 365
 366         /* error messages here could be improved with links to orig. rules */
 367         if token_name_eq(&tok, &EOF) {
 368             if eof_eis.len() == 1u {
 369                 let mut v = Vec::new();
 370                 for dv in eof_eis.get_mut(0).matches.mut_iter() {
 371                     v.push(dv.pop().unwrap());
 372                 }
 373                 return Success(nameize(sess, ms, v.as_slice()));
 374             } else if eof_eis.len() > 1u {
 375                 return Error(sp, "ambiguity: multiple successful parses".to_string());
 376             } else {
 377                 return Failure(sp, "unexpected end of macro invocation".to_string());
 378             }
 379         } else {
 380             if (bb_eis.len() > 0u && next_eis.len() > 0u)
 381                 || bb_eis.len() > 1u {
 382                 let nts = bb_eis.iter().map(|ei| {
 383                     match ei.elts.get(ei.idx).node {
 384                       MatchNonterminal(bind, name, _) => {
 385                         (format!("{} ('{}')",
 386                                 token::get_ident(name),
 387                                 token::get_ident(bind))).to_string()
 388                       }
 389                       _ => fail!()
 390                     } }).collect::<Vec<String>>().connect(" or ");
 391                 return Error(sp, format!(
 392                     "local ambiguity: multiple parsing options: \
 393                      built-in NTs {} or {} other options.",
 394                     nts, next_eis.len()).to_string());
 395             } else if bb_eis.len() == 0u && next_eis.len() == 0u {
 396                 return Failure(sp, format!("no rules expected the token `{}`",
 397                             token::to_str(&tok)).to_string());
 398             } else if next_eis.len() > 0u {
 399                 /* Now process the next token */
 400                 while next_eis.len() > 0u {
 401                     cur_eis.push(next_eis.pop().unwrap());
 402                 }
 403                 rdr.next_token();
 404             } else /* bb_eis.len() == 1 */ {
 405                 let mut rust_parser = Parser::new(sess, cfg.clone(), box rdr.clone());
 406
 407                 let mut ei = bb_eis.pop().unwrap();
 408                 match ei.elts.get(ei.idx).node {
 409                   MatchNonterminal(_, name, idx) => {
 410                     let name_string = token::get_ident(name);
 411                     ei.matches.get_mut(idx).push(Rc::new(MatchedNonterminal(
 412                         parse_nt(&mut rust_parser, name_string.get()))));
 413                     ei.idx += 1u;
 414                   }
 415                   _ => fail!()
 416                 }
 417                 cur_eis.push(ei);
 418
 419                 for _ in range(0, rust_parser.tokens_consumed) {
 420                     let _ = rdr.next_token();
 421                 }
 422             }
 423         }
 424
 425         assert!(cur_eis.len() > 0u);
 426     }
 427 }
 428
 429 pub fn parse_nt(p: &mut Parser, name: &str) -> Nonterminal {
 430     match name {
 431       "item" => match p.parse_item(Vec::new()) {
 432         Some(i) => token::NtItem(i),
 433         None => p.fatal("expected an item keyword")
 434       },
 435       "block" => token::NtBlock(p.parse_block()),
 436       "stmt" => token::NtStmt(p.parse_stmt(Vec::new())),
 437       "pat" => token::NtPat(p.parse_pat()),
 438       "expr" => token::NtExpr(p.parse_expr()),
 439       "ty" => token::NtTy(p.parse_ty(false /* no need to disambiguate*/)),
 440       // this could be handled like a token, since it is one
 441       "ident" => match p.token {
 442         token::IDENT(sn,b) => { p.bump(); token::NtIdent(box sn,b) }
 443         _ => {
 444             let token_str = token::to_str(&p.token);
 445             p.fatal((format!("expected ident, found {}",
 446                              token_str.as_slice())).as_slice())
 447         }
 448       },
 449       "path" => {
 450         token::NtPath(box p.parse_path(LifetimeAndTypesWithoutColons).path)
 451       }
 452       "meta" => token::NtMeta(p.parse_meta_item()),
 453       "tt" => {
 454         p.quote_depth += 1u; //but in theory, non-quoted tts might be useful
 455         let res = token::NtTT(box(GC) p.parse_token_tree());
 456         p.quote_depth -= 1u;
 457         res
 458       }
 459       "matchers" => token::NtMatchers(p.parse_matchers()),
 460       _ => {
 461           p.fatal(format!("unsupported builtin nonterminal parser: {}",
 462                           name).as_slice())
 463       }
 464     }
 465 }