1 // Copyright 2015 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.
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.
11 use ast::{self, Arg, Arm, Block, Expr, Item, Pat, Stmt, Ty};
14 use ext::base::ExtCtxt;
16 use ext::build::AstBuilder;
17 use parse::parser::{Parser, PathStyle};
20 use tokenstream::{TokenStream, TokenTree};
22 /// Quasiquoting works via token trees.
24 /// This is registered as a set of expression syntax extension called quote!
25 /// that lifts its argument token-tree to an AST representing the
26 /// construction of the same token tree, with `token::SubstNt` interpreted
27 /// as antiquotes (splices).
32 use ext::base::ExtCtxt;
33 use parse::{self, classify};
34 use parse::token::{self, Token};
38 use tokenstream::{self, TokenTree, TokenStream};
40 pub use parse::new_parser_from_tts;
41 pub use syntax_pos::{BytePos, Span, DUMMY_SP, FileName};
42 pub use codemap::{dummy_spanned};
45 fn to_tokens(&self, _cx: &ExtCtxt) -> Vec<TokenTree>;
48 impl ToTokens for TokenTree {
49 fn to_tokens(&self, _cx: &ExtCtxt) -> Vec<TokenTree> {
54 impl<T: ToTokens> ToTokens for Vec<T> {
55 fn to_tokens(&self, cx: &ExtCtxt) -> Vec<TokenTree> {
56 self.iter().flat_map(|t| t.to_tokens(cx)).collect()
60 impl<T: ToTokens> ToTokens for Spanned<T> {
61 fn to_tokens(&self, cx: &ExtCtxt) -> Vec<TokenTree> {
62 // FIXME: use the span?
63 self.node.to_tokens(cx)
67 impl<T: ToTokens> ToTokens for Option<T> {
68 fn to_tokens(&self, cx: &ExtCtxt) -> Vec<TokenTree> {
70 Some(ref t) => t.to_tokens(cx),
76 impl ToTokens for ast::Ident {
77 fn to_tokens(&self, _cx: &ExtCtxt) -> Vec<TokenTree> {
78 vec![TokenTree::Token(self.span, Token::from_ast_ident(*self))]
82 impl ToTokens for ast::Path {
83 fn to_tokens(&self, _cx: &ExtCtxt) -> Vec<TokenTree> {
84 let nt = token::NtPath(self.clone());
85 vec![TokenTree::Token(DUMMY_SP, Token::interpolated(nt))]
89 impl ToTokens for ast::Ty {
90 fn to_tokens(&self, _cx: &ExtCtxt) -> Vec<TokenTree> {
91 let nt = token::NtTy(P(self.clone()));
92 vec![TokenTree::Token(self.span, Token::interpolated(nt))]
96 impl ToTokens for ast::Block {
97 fn to_tokens(&self, _cx: &ExtCtxt) -> Vec<TokenTree> {
98 let nt = token::NtBlock(P(self.clone()));
99 vec![TokenTree::Token(self.span, Token::interpolated(nt))]
103 impl ToTokens for ast::Generics {
104 fn to_tokens(&self, _cx: &ExtCtxt) -> Vec<TokenTree> {
105 let nt = token::NtGenerics(self.clone());
106 vec![TokenTree::Token(DUMMY_SP, Token::interpolated(nt))]
110 impl ToTokens for ast::WhereClause {
111 fn to_tokens(&self, _cx: &ExtCtxt) -> Vec<TokenTree> {
112 let nt = token::NtWhereClause(self.clone());
113 vec![TokenTree::Token(DUMMY_SP, Token::interpolated(nt))]
117 impl ToTokens for P<ast::Item> {
118 fn to_tokens(&self, _cx: &ExtCtxt) -> Vec<TokenTree> {
119 let nt = token::NtItem(self.clone());
120 vec![TokenTree::Token(self.span, Token::interpolated(nt))]
124 impl ToTokens for ast::ImplItem {
125 fn to_tokens(&self, _cx: &ExtCtxt) -> Vec<TokenTree> {
126 let nt = token::NtImplItem(self.clone());
127 vec![TokenTree::Token(self.span, Token::interpolated(nt))]
131 impl ToTokens for P<ast::ImplItem> {
132 fn to_tokens(&self, _cx: &ExtCtxt) -> Vec<TokenTree> {
133 let nt = token::NtImplItem((**self).clone());
134 vec![TokenTree::Token(self.span, Token::interpolated(nt))]
138 impl ToTokens for ast::TraitItem {
139 fn to_tokens(&self, _cx: &ExtCtxt) -> Vec<TokenTree> {
140 let nt = token::NtTraitItem(self.clone());
141 vec![TokenTree::Token(self.span, Token::interpolated(nt))]
145 impl ToTokens for ast::Stmt {
146 fn to_tokens(&self, _cx: &ExtCtxt) -> Vec<TokenTree> {
147 let nt = token::NtStmt(self.clone());
148 let mut tts = vec![TokenTree::Token(self.span, Token::interpolated(nt))];
150 // Some statements require a trailing semicolon.
151 if classify::stmt_ends_with_semi(&self.node) {
152 tts.push(TokenTree::Token(self.span, token::Semi));
159 impl ToTokens for P<ast::Expr> {
160 fn to_tokens(&self, _cx: &ExtCtxt) -> Vec<TokenTree> {
161 let nt = token::NtExpr(self.clone());
162 vec![TokenTree::Token(self.span, Token::interpolated(nt))]
166 impl ToTokens for P<ast::Pat> {
167 fn to_tokens(&self, _cx: &ExtCtxt) -> Vec<TokenTree> {
168 let nt = token::NtPat(self.clone());
169 vec![TokenTree::Token(self.span, Token::interpolated(nt))]
173 impl ToTokens for ast::Arm {
174 fn to_tokens(&self, _cx: &ExtCtxt) -> Vec<TokenTree> {
175 let nt = token::NtArm(self.clone());
176 vec![TokenTree::Token(DUMMY_SP, Token::interpolated(nt))]
180 impl ToTokens for ast::Arg {
181 fn to_tokens(&self, _cx: &ExtCtxt) -> Vec<TokenTree> {
182 let nt = token::NtArg(self.clone());
183 vec![TokenTree::Token(DUMMY_SP, Token::interpolated(nt))]
187 impl ToTokens for P<ast::Block> {
188 fn to_tokens(&self, _cx: &ExtCtxt) -> Vec<TokenTree> {
189 let nt = token::NtBlock(self.clone());
190 vec![TokenTree::Token(DUMMY_SP, Token::interpolated(nt))]
194 impl ToTokens for ast::Lifetime {
195 fn to_tokens(&self, _cx: &ExtCtxt) -> Vec<TokenTree> {
196 vec![TokenTree::Token(self.ident.span, token::Lifetime(self.ident))]
200 macro_rules! impl_to_tokens_slice {
201 ($t: ty, $sep: expr) => {
202 impl ToTokens for [$t] {
203 fn to_tokens(&self, cx: &ExtCtxt) -> Vec<TokenTree> {
205 for (i, x) in self.iter().enumerate() {
207 v.extend_from_slice(&$sep);
209 v.extend(x.to_tokens(cx));
217 impl_to_tokens_slice! { ast::Ty, [TokenTree::Token(DUMMY_SP, token::Comma)] }
218 impl_to_tokens_slice! { P<ast::Item>, [] }
219 impl_to_tokens_slice! { ast::Arg, [TokenTree::Token(DUMMY_SP, token::Comma)] }
221 impl ToTokens for ast::MetaItem {
222 fn to_tokens(&self, _cx: &ExtCtxt) -> Vec<TokenTree> {
223 let nt = token::NtMeta(self.clone());
224 vec![TokenTree::Token(DUMMY_SP, Token::interpolated(nt))]
228 impl ToTokens for ast::Attribute {
229 fn to_tokens(&self, _cx: &ExtCtxt) -> Vec<TokenTree> {
231 // FIXME: The spans could be better
232 r.push(TokenTree::Token(self.span, token::Pound));
233 if self.style == ast::AttrStyle::Inner {
234 r.push(TokenTree::Token(self.span, token::Not));
236 let mut inner = Vec::new();
237 for (i, segment) in self.path.segments.iter().enumerate() {
239 inner.push(TokenTree::Token(self.span, token::Colon).into());
241 inner.push(TokenTree::Token(
242 self.span, token::Token::from_ast_ident(segment.ident)
245 inner.push(self.tokens.clone());
247 r.push(TokenTree::Delimited(self.span, tokenstream::Delimited {
248 delim: token::Bracket, tts: TokenStream::concat(inner).into()
254 impl ToTokens for str {
255 fn to_tokens(&self, cx: &ExtCtxt) -> Vec<TokenTree> {
256 let lit = ast::LitKind::Str(Symbol::intern(self), ast::StrStyle::Cooked);
257 dummy_spanned(lit).to_tokens(cx)
261 impl ToTokens for () {
262 fn to_tokens(&self, _cx: &ExtCtxt) -> Vec<TokenTree> {
263 vec![TokenTree::Delimited(DUMMY_SP, tokenstream::Delimited {
265 tts: TokenStream::empty().into(),
270 impl ToTokens for ast::Lit {
271 fn to_tokens(&self, cx: &ExtCtxt) -> Vec<TokenTree> {
272 // FIXME: This is wrong
274 id: ast::DUMMY_NODE_ID,
275 node: ast::ExprKind::Lit(P(self.clone())),
277 attrs: ast::ThinVec::new(),
282 impl ToTokens for bool {
283 fn to_tokens(&self, cx: &ExtCtxt) -> Vec<TokenTree> {
284 dummy_spanned(ast::LitKind::Bool(*self)).to_tokens(cx)
288 impl ToTokens for char {
289 fn to_tokens(&self, cx: &ExtCtxt) -> Vec<TokenTree> {
290 dummy_spanned(ast::LitKind::Char(*self)).to_tokens(cx)
294 macro_rules! impl_to_tokens_int {
295 (signed, $t:ty, $tag:expr) => (
296 impl ToTokens for $t {
297 fn to_tokens(&self, cx: &ExtCtxt) -> Vec<TokenTree> {
298 let val = if *self < 0 {
303 let lit = ast::LitKind::Int(val as u128, ast::LitIntType::Signed($tag));
304 let lit = P(ast::Expr {
305 id: ast::DUMMY_NODE_ID,
306 node: ast::ExprKind::Lit(P(dummy_spanned(lit))),
308 attrs: ast::ThinVec::new(),
311 return lit.to_tokens(cx);
314 id: ast::DUMMY_NODE_ID,
315 node: ast::ExprKind::Unary(ast::UnOp::Neg, lit),
317 attrs: ast::ThinVec::new(),
322 (unsigned, $t:ty, $tag:expr) => (
323 impl ToTokens for $t {
324 fn to_tokens(&self, cx: &ExtCtxt) -> Vec<TokenTree> {
325 let lit = ast::LitKind::Int(*self as u128, ast::LitIntType::Unsigned($tag));
326 dummy_spanned(lit).to_tokens(cx)
332 impl_to_tokens_int! { signed, isize, ast::IntTy::Isize }
333 impl_to_tokens_int! { signed, i8, ast::IntTy::I8 }
334 impl_to_tokens_int! { signed, i16, ast::IntTy::I16 }
335 impl_to_tokens_int! { signed, i32, ast::IntTy::I32 }
336 impl_to_tokens_int! { signed, i64, ast::IntTy::I64 }
338 impl_to_tokens_int! { unsigned, usize, ast::UintTy::Usize }
339 impl_to_tokens_int! { unsigned, u8, ast::UintTy::U8 }
340 impl_to_tokens_int! { unsigned, u16, ast::UintTy::U16 }
341 impl_to_tokens_int! { unsigned, u32, ast::UintTy::U32 }
342 impl_to_tokens_int! { unsigned, u64, ast::UintTy::U64 }
344 pub trait ExtParseUtils {
345 fn parse_item(&self, s: String) -> P<ast::Item>;
346 fn parse_expr(&self, s: String) -> P<ast::Expr>;
347 fn parse_stmt(&self, s: String) -> ast::Stmt;
348 fn parse_tts(&self, s: String) -> Vec<TokenTree>;
351 impl<'a> ExtParseUtils for ExtCtxt<'a> {
352 fn parse_item(&self, s: String) -> P<ast::Item> {
353 panictry!(parse::parse_item_from_source_str(
354 FileName::QuoteExpansion,
356 self.parse_sess())).expect("parse error")
359 fn parse_stmt(&self, s: String) -> ast::Stmt {
360 panictry!(parse::parse_stmt_from_source_str(
361 FileName::QuoteExpansion,
363 self.parse_sess())).expect("parse error")
366 fn parse_expr(&self, s: String) -> P<ast::Expr> {
367 panictry!(parse::parse_expr_from_source_str(
368 FileName::QuoteExpansion,
373 fn parse_tts(&self, s: String) -> Vec<TokenTree> {
374 let source_name = FileName::QuoteExpansion;
375 parse::parse_stream_from_source_str(source_name, s, self.parse_sess(), None)
376 .into_trees().collect()
381 // Replaces `Token::OpenDelim .. Token::CloseDelim` with `TokenTree::Delimited(..)`.
382 pub fn unflatten(tts: Vec<TokenTree>) -> Vec<TokenTree> {
383 use tokenstream::Delimited;
385 let mut results = Vec::new();
386 let mut result = Vec::new();
389 TokenTree::Token(_, token::OpenDelim(..)) => {
390 results.push(::std::mem::replace(&mut result, Vec::new()));
392 TokenTree::Token(span, token::CloseDelim(delim)) => {
393 let tree = TokenTree::Delimited(span, Delimited {
395 tts: result.into_iter().map(TokenStream::from).collect::<TokenStream>().into(),
397 result = results.pop().unwrap();
400 tree => result.push(tree),
406 // These panicking parsing functions are used by the quote_*!() syntax extensions,
407 // but shouldn't be used otherwise.
408 pub fn parse_expr_panic(parser: &mut Parser) -> P<Expr> {
409 panictry!(parser.parse_expr())
412 pub fn parse_item_panic(parser: &mut Parser) -> Option<P<Item>> {
413 panictry!(parser.parse_item())
416 pub fn parse_pat_panic(parser: &mut Parser) -> P<Pat> {
417 panictry!(parser.parse_pat())
420 pub fn parse_arm_panic(parser: &mut Parser) -> Arm {
421 panictry!(parser.parse_arm())
424 pub fn parse_ty_panic(parser: &mut Parser) -> P<Ty> {
425 panictry!(parser.parse_ty())
428 pub fn parse_stmt_panic(parser: &mut Parser) -> Option<Stmt> {
429 panictry!(parser.parse_stmt())
432 pub fn parse_attribute_panic(parser: &mut Parser, permit_inner: bool) -> ast::Attribute {
433 panictry!(parser.parse_attribute(permit_inner))
436 pub fn parse_arg_panic(parser: &mut Parser) -> Arg {
437 panictry!(parser.parse_arg())
440 pub fn parse_block_panic(parser: &mut Parser) -> P<Block> {
441 panictry!(parser.parse_block())
444 pub fn parse_meta_item_panic(parser: &mut Parser) -> ast::MetaItem {
445 panictry!(parser.parse_meta_item())
448 pub fn parse_path_panic(parser: &mut Parser, mode: PathStyle) -> ast::Path {
449 panictry!(parser.parse_path(mode))
452 pub fn expand_quote_tokens<'cx>(cx: &'cx mut ExtCtxt,
455 -> Box<base::MacResult+'cx> {
456 let (cx_expr, expr) = expand_tts(cx, sp, tts);
457 let expanded = expand_wrapper(cx, sp, cx_expr, expr, &[&["syntax", "ext", "quote", "rt"]]);
458 base::MacEager::expr(expanded)
461 pub fn expand_quote_expr<'cx>(cx: &'cx mut ExtCtxt,
464 -> Box<base::MacResult+'cx> {
465 let expanded = expand_parse_call(cx, sp, "parse_expr_panic", vec![], tts);
466 base::MacEager::expr(expanded)
469 pub fn expand_quote_item<'cx>(cx: &'cx mut ExtCtxt,
472 -> Box<base::MacResult+'cx> {
473 let expanded = expand_parse_call(cx, sp, "parse_item_panic", vec![], tts);
474 base::MacEager::expr(expanded)
477 pub fn expand_quote_pat<'cx>(cx: &'cx mut ExtCtxt,
480 -> Box<base::MacResult+'cx> {
481 let expanded = expand_parse_call(cx, sp, "parse_pat_panic", vec![], tts);
482 base::MacEager::expr(expanded)
485 pub fn expand_quote_arm(cx: &mut ExtCtxt,
488 -> Box<base::MacResult+'static> {
489 let expanded = expand_parse_call(cx, sp, "parse_arm_panic", vec![], tts);
490 base::MacEager::expr(expanded)
493 pub fn expand_quote_ty(cx: &mut ExtCtxt,
496 -> Box<base::MacResult+'static> {
497 let expanded = expand_parse_call(cx, sp, "parse_ty_panic", vec![], tts);
498 base::MacEager::expr(expanded)
501 pub fn expand_quote_stmt(cx: &mut ExtCtxt,
504 -> Box<base::MacResult+'static> {
505 let expanded = expand_parse_call(cx, sp, "parse_stmt_panic", vec![], tts);
506 base::MacEager::expr(expanded)
509 pub fn expand_quote_attr(cx: &mut ExtCtxt,
512 -> Box<base::MacResult+'static> {
513 let expanded = expand_parse_call(cx, sp, "parse_attribute_panic",
514 vec![cx.expr_bool(sp, true)], tts);
516 base::MacEager::expr(expanded)
519 pub fn expand_quote_arg(cx: &mut ExtCtxt,
522 -> Box<base::MacResult+'static> {
523 let expanded = expand_parse_call(cx, sp, "parse_arg_panic", vec![], tts);
524 base::MacEager::expr(expanded)
527 pub fn expand_quote_block(cx: &mut ExtCtxt,
530 -> Box<base::MacResult+'static> {
531 let expanded = expand_parse_call(cx, sp, "parse_block_panic", vec![], tts);
532 base::MacEager::expr(expanded)
535 pub fn expand_quote_meta_item(cx: &mut ExtCtxt,
538 -> Box<base::MacResult+'static> {
539 let expanded = expand_parse_call(cx, sp, "parse_meta_item_panic", vec![], tts);
540 base::MacEager::expr(expanded)
543 pub fn expand_quote_path(cx: &mut ExtCtxt,
546 -> Box<base::MacResult+'static> {
547 let mode = mk_parser_path(cx, sp, &["PathStyle", "Type"]);
548 let expanded = expand_parse_call(cx, sp, "parse_path_panic", vec![mode], tts);
549 base::MacEager::expr(expanded)
552 fn ids_ext(strs: Vec<String>) -> Vec<ast::Ident> {
553 strs.iter().map(|s| ast::Ident::from_str(s)).collect()
556 fn id_ext(s: &str) -> ast::Ident {
557 ast::Ident::from_str(s)
560 // Lift an ident to the expr that evaluates to that ident.
561 fn mk_ident(cx: &ExtCtxt, sp: Span, ident: ast::Ident) -> P<ast::Expr> {
562 let e_str = cx.expr_str(sp, ident.name);
563 cx.expr_method_call(sp,
564 cx.expr_ident(sp, id_ext("ext_cx")),
569 // Lift a name to the expr that evaluates to that name
570 fn mk_name(cx: &ExtCtxt, sp: Span, ident: ast::Ident) -> P<ast::Expr> {
571 let e_str = cx.expr_str(sp, ident.name);
572 cx.expr_method_call(sp,
573 cx.expr_ident(sp, id_ext("ext_cx")),
578 fn mk_tt_path(cx: &ExtCtxt, sp: Span, name: &str) -> P<ast::Expr> {
579 let idents = vec![id_ext("syntax"), id_ext("tokenstream"), id_ext("TokenTree"), id_ext(name)];
580 cx.expr_path(cx.path_global(sp, idents))
583 fn mk_token_path(cx: &ExtCtxt, sp: Span, name: &str) -> P<ast::Expr> {
584 let idents = vec![id_ext("syntax"), id_ext("parse"), id_ext("token"), id_ext(name)];
585 cx.expr_path(cx.path_global(sp, idents))
588 fn mk_parser_path(cx: &ExtCtxt, sp: Span, names: &[&str]) -> P<ast::Expr> {
589 let mut idents = vec![id_ext("syntax"), id_ext("parse"), id_ext("parser")];
590 idents.extend(names.iter().cloned().map(id_ext));
591 cx.expr_path(cx.path_global(sp, idents))
594 fn mk_binop(cx: &ExtCtxt, sp: Span, bop: token::BinOpToken) -> P<ast::Expr> {
595 let name = match bop {
596 token::Plus => "Plus",
597 token::Minus => "Minus",
598 token::Star => "Star",
599 token::Slash => "Slash",
600 token::Percent => "Percent",
601 token::Caret => "Caret",
607 mk_token_path(cx, sp, name)
610 fn mk_delim(cx: &ExtCtxt, sp: Span, delim: token::DelimToken) -> P<ast::Expr> {
611 let name = match delim {
612 token::Paren => "Paren",
613 token::Bracket => "Bracket",
614 token::Brace => "Brace",
615 token::NoDelim => "NoDelim",
617 mk_token_path(cx, sp, name)
620 #[allow(non_upper_case_globals)]
621 fn expr_mk_token(cx: &ExtCtxt, sp: Span, tok: &token::Token) -> P<ast::Expr> {
622 macro_rules! mk_lit {
623 ($name: expr, $suffix: expr, $content: expr $(, $count: expr)*) => {{
624 let name = mk_name(cx, sp, ast::Ident::with_empty_ctxt($content));
625 let inner = cx.expr_call(sp, mk_token_path(cx, sp, $name), vec![
626 name $(, cx.expr_u16(sp, $count))*
628 let suffix = match $suffix {
629 Some(name) => cx.expr_some(sp, mk_name(cx, sp, ast::Ident::with_empty_ctxt(name))),
630 None => cx.expr_none(sp)
632 cx.expr_call(sp, mk_token_path(cx, sp, "Literal"), vec![inner, suffix])
636 let name = match *tok {
637 token::BinOp(binop) => {
638 return cx.expr_call(sp, mk_token_path(cx, sp, "BinOp"), vec![mk_binop(cx, sp, binop)]);
640 token::BinOpEq(binop) => {
641 return cx.expr_call(sp, mk_token_path(cx, sp, "BinOpEq"),
642 vec![mk_binop(cx, sp, binop)]);
645 token::OpenDelim(delim) => {
646 return cx.expr_call(sp, mk_token_path(cx, sp, "OpenDelim"),
647 vec![mk_delim(cx, sp, delim)]);
649 token::CloseDelim(delim) => {
650 return cx.expr_call(sp, mk_token_path(cx, sp, "CloseDelim"),
651 vec![mk_delim(cx, sp, delim)]);
654 token::Literal(token::Byte(i), suf) => return mk_lit!("Byte", suf, i),
655 token::Literal(token::Char(i), suf) => return mk_lit!("Char", suf, i),
656 token::Literal(token::Integer(i), suf) => return mk_lit!("Integer", suf, i),
657 token::Literal(token::Float(i), suf) => return mk_lit!("Float", suf, i),
658 token::Literal(token::Str_(i), suf) => return mk_lit!("Str_", suf, i),
659 token::Literal(token::StrRaw(i, n), suf) => return mk_lit!("StrRaw", suf, i, n),
660 token::Literal(token::ByteStr(i), suf) => return mk_lit!("ByteStr", suf, i),
661 token::Literal(token::ByteStrRaw(i, n), suf) => return mk_lit!("ByteStrRaw", suf, i, n),
663 token::Ident(ident, is_raw) => {
664 return cx.expr_call(sp,
665 mk_token_path(cx, sp, "Ident"),
666 vec![mk_ident(cx, sp, ident), cx.expr_bool(sp, is_raw)]);
669 token::Lifetime(ident) => {
670 return cx.expr_call(sp,
671 mk_token_path(cx, sp, "Lifetime"),
672 vec![mk_ident(cx, sp, ident)]);
675 token::DocComment(ident) => {
676 return cx.expr_call(sp,
677 mk_token_path(cx, sp, "DocComment"),
678 vec![mk_name(cx, sp, ast::Ident::with_empty_ctxt(ident))]);
681 token::Interpolated(_) => {
682 cx.span_err(sp, "quote! with interpolated token");
690 token::EqEq => "EqEq",
694 token::AndAnd => "AndAnd",
695 token::OrOr => "OrOr",
697 token::Tilde => "Tilde",
700 token::DotDot => "DotDot",
701 token::DotEq => "DotEq",
702 token::DotDotDot => "DotDotDot",
703 token::DotDotEq => "DotDotEq",
704 token::Comma => "Comma",
705 token::Semi => "Semi",
706 token::Colon => "Colon",
707 token::ModSep => "ModSep",
708 token::RArrow => "RArrow",
709 token::LArrow => "LArrow",
710 token::FatArrow => "FatArrow",
711 token::Pound => "Pound",
712 token::Dollar => "Dollar",
713 token::Question => "Question",
714 token::SingleQuote => "SingleQuote",
717 token::Whitespace | token::Comment | token::Shebang(_) => {
718 panic!("unhandled token in quote!");
721 mk_token_path(cx, sp, name)
724 fn statements_mk_tt(cx: &ExtCtxt, tt: &TokenTree, quoted: bool) -> Vec<ast::Stmt> {
726 TokenTree::Token(sp, token::Ident(ident, _)) if quoted => {
727 // tt.extend($ident.to_tokens(ext_cx))
730 cx.expr_method_call(sp,
731 cx.expr_ident(sp, ident),
733 vec![cx.expr_ident(sp, id_ext("ext_cx"))]);
735 cx.expr_method_call(sp, e_to_toks, id_ext("into_iter"), vec![]);
738 cx.expr_method_call(sp,
739 cx.expr_ident(sp, id_ext("tt")),
743 vec![cx.stmt_expr(e_push)]
745 TokenTree::Token(sp, ref tok) => {
746 let e_sp = cx.expr_ident(sp, id_ext("_sp"));
747 let e_tok = cx.expr_call(sp,
748 mk_tt_path(cx, sp, "Token"),
749 vec![e_sp, expr_mk_token(cx, sp, tok)]);
751 cx.expr_method_call(sp,
752 cx.expr_ident(sp, id_ext("tt")),
755 vec![cx.stmt_expr(e_push)]
757 TokenTree::Delimited(span, ref delimed) => {
758 let mut stmts = statements_mk_tt(cx, &delimed.open_tt(span), false);
759 stmts.extend(statements_mk_tts(cx, delimed.stream()));
760 stmts.extend(statements_mk_tt(cx, &delimed.close_tt(span), false));
766 fn parse_arguments_to_quote(cx: &ExtCtxt, tts: &[TokenTree])
767 -> (P<ast::Expr>, Vec<TokenTree>) {
768 let mut p = cx.new_parser_from_tts(tts);
770 let cx_expr = panictry!(p.parse_expr());
771 if !p.eat(&token::Comma) {
772 let _ = p.diagnostic().fatal("expected token `,`");
775 let tts = panictry!(p.parse_all_token_trees());
781 fn mk_stmts_let(cx: &ExtCtxt, sp: Span) -> Vec<ast::Stmt> {
782 // We also bind a single value, sp, to ext_cx.call_site()
784 // This causes every span in a token-tree quote to be attributed to the
785 // call site of the extension using the quote. We can't really do much
786 // better since the source of the quote may well be in a library that
787 // was not even parsed by this compilation run, that the user has no
788 // source code for (eg. in libsyntax, which they're just _using_).
790 // The old quasiquoter had an elaborate mechanism for denoting input
791 // file locations from which quotes originated; unfortunately this
792 // relied on feeding the source string of the quote back into the
793 // compiler (which we don't really want to do) and, in any case, only
794 // pushed the problem a very small step further back: an error
795 // resulting from a parse of the resulting quote is still attributed to
796 // the site the string literal occurred, which was in a source file
797 // _other_ than the one the user has control over. For example, an
798 // error in a quote from the protocol compiler, invoked in user code
799 // using macro_rules! for example, will be attributed to the macro_rules.rs
800 // file in libsyntax, which the user might not even have source to (unless
801 // they happen to have a compiler on hand). Over all, the phase distinction
802 // just makes quotes "hard to attribute". Possibly this could be fixed
803 // by recreating some of the original qq machinery in the tt regime
804 // (pushing fake FileMaps onto the parser to account for original sites
805 // of quotes, for example) but at this point it seems not likely to be
808 let e_sp = cx.expr_method_call(sp,
809 cx.expr_ident(sp, id_ext("ext_cx")),
813 let stmt_let_sp = cx.stmt_let(sp, false,
817 let stmt_let_tt = cx.stmt_let(sp, true, id_ext("tt"), cx.expr_vec_ng(sp));
819 vec![stmt_let_sp, stmt_let_tt]
822 fn statements_mk_tts(cx: &ExtCtxt, tts: TokenStream) -> Vec<ast::Stmt> {
823 let mut ss = Vec::new();
824 let mut quoted = false;
825 for tt in tts.into_trees() {
827 TokenTree::Token(_, token::Dollar) if !quoted => true,
829 ss.extend(statements_mk_tt(cx, &tt, quoted));
837 fn expand_tts(cx: &ExtCtxt, sp: Span, tts: &[TokenTree]) -> (P<ast::Expr>, P<ast::Expr>) {
838 let (cx_expr, tts) = parse_arguments_to_quote(cx, tts);
840 let mut vector = mk_stmts_let(cx, sp);
841 vector.extend(statements_mk_tts(cx, tts.iter().cloned().collect()));
842 vector.push(cx.stmt_expr(cx.expr_ident(sp, id_ext("tt"))));
843 let block = cx.expr_block(cx.block(sp, vector));
844 let unflatten = vec![id_ext("syntax"), id_ext("ext"), id_ext("quote"), id_ext("unflatten")];
846 (cx_expr, cx.expr_call_global(sp, unflatten, vec![block]))
849 fn expand_wrapper(cx: &ExtCtxt,
851 cx_expr: P<ast::Expr>,
853 imports: &[&[&str]]) -> P<ast::Expr> {
854 // Explicitly borrow to avoid moving from the invoker (#16992)
855 let cx_expr_borrow = cx.expr_addr_of(sp, cx.expr_deref(sp, cx_expr));
856 let stmt_let_ext_cx = cx.stmt_let(sp, false, id_ext("ext_cx"), cx_expr_borrow);
858 let mut stmts = imports.iter().map(|path| {
859 // make item: `use ...;`
860 let path = path.iter().map(|s| s.to_string()).collect();
861 let use_item = cx.item_use_glob(
863 respan(sp.shrink_to_lo(), ast::VisibilityKind::Inherited),
866 cx.stmt_item(sp, use_item)
867 }).chain(Some(stmt_let_ext_cx)).collect::<Vec<_>>();
868 stmts.push(cx.stmt_expr(expr));
870 cx.expr_block(cx.block(sp, stmts))
873 fn expand_parse_call(cx: &ExtCtxt,
876 arg_exprs: Vec<P<ast::Expr>> ,
877 tts: &[TokenTree]) -> P<ast::Expr> {
878 let (cx_expr, tts_expr) = expand_tts(cx, sp, tts);
880 let parse_sess_call = || cx.expr_method_call(
881 sp, cx.expr_ident(sp, id_ext("ext_cx")),
882 id_ext("parse_sess"), Vec::new());
884 let new_parser_call =
886 cx.expr_ident(sp, id_ext("new_parser_from_tts")),
887 vec![parse_sess_call(), tts_expr]);
889 let path = vec![id_ext("syntax"), id_ext("ext"), id_ext("quote"), id_ext(parse_method)];
890 let mut args = vec![cx.expr_mut_addr_of(sp, new_parser_call)];
891 args.extend(arg_exprs);
892 let expr = cx.expr_call_global(sp, path, args);
894 if parse_method == "parse_attribute" {
895 expand_wrapper(cx, sp, cx_expr, expr, &[&["syntax", "ext", "quote", "rt"],
896 &["syntax", "parse", "attr"]])
898 expand_wrapper(cx, sp, cx_expr, expr, &[&["syntax", "ext", "quote", "rt"]])