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.
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, Block, Ident, NodeId, PatKind, Path};
12 use ast::{MacStmtStyle, StmtKind, ItemKind};
13 use attr::{self, HasAttrs};
14 use codemap::{ExpnInfo, MacroBang, MacroAttribute, dummy_spanned, respan};
15 use config::{is_test_or_bench, StripUnconfigured};
16 use errors::{Applicability, FatalError};
18 use ext::build::AstBuilder;
19 use ext::derive::{add_derived_markers, collect_derives};
20 use ext::hygiene::{self, Mark, SyntaxContext};
21 use ext::placeholders::{placeholder, PlaceholderExpander};
22 use feature_gate::{self, Features, GateIssue, is_builtin_attr, emit_feature_err};
25 use parse::{DirectoryOwnership, PResult, ParseSess};
26 use parse::token::{self, Token};
27 use parse::parser::Parser;
32 use syntax_pos::{Span, DUMMY_SP, FileName};
33 use syntax_pos::hygiene::ExpnFormat;
34 use tokenstream::{TokenStream, TokenTree};
35 use visit::{self, Visitor};
37 use std::collections::HashMap;
42 use std::path::PathBuf;
44 macro_rules! ast_fragments {
46 $($Kind:ident($AstTy:ty) {
48 // FIXME: HACK: this should be `$(one ...)?` and `$(many ...)?` but `?` macro
49 // repetition was removed from 2015 edition in #51587 because of ambiguities.
50 $(one fn $fold_ast:ident; fn $visit_ast:ident;)*
51 $(many fn $fold_ast_elt:ident; fn $visit_ast_elt:ident;)*
55 /// A fragment of AST that can be produced by a single macro expansion.
56 /// Can also serve as an input and intermediate result for macro expansion operations.
57 pub enum AstFragment {
58 OptExpr(Option<P<ast::Expr>>),
62 /// "Discriminant" of an AST fragment.
63 #[derive(Copy, Clone, PartialEq, Eq)]
64 pub enum AstFragmentKind {
69 impl AstFragmentKind {
70 pub fn name(self) -> &'static str {
72 AstFragmentKind::OptExpr => "expression",
73 $(AstFragmentKind::$Kind => $kind_name,)*
77 fn make_from<'a>(self, result: Box<dyn MacResult + 'a>) -> Option<AstFragment> {
79 AstFragmentKind::OptExpr =>
80 result.make_expr().map(Some).map(AstFragment::OptExpr),
81 $(AstFragmentKind::$Kind => result.$make_ast().map(AstFragment::$Kind),)*
87 pub fn make_opt_expr(self) -> Option<P<ast::Expr>> {
89 AstFragment::OptExpr(expr) => expr,
90 _ => panic!("AstFragment::make_* called on the wrong kind of fragment"),
94 $(pub fn $make_ast(self) -> $AstTy {
96 AstFragment::$Kind(ast) => ast,
97 _ => panic!("AstFragment::make_* called on the wrong kind of fragment"),
101 pub fn fold_with<F: Folder>(self, folder: &mut F) -> Self {
103 AstFragment::OptExpr(expr) =>
104 AstFragment::OptExpr(expr.and_then(|expr| folder.fold_opt_expr(expr))),
105 $($(AstFragment::$Kind(ast) =>
106 AstFragment::$Kind(folder.$fold_ast(ast)),)*)*
107 $($(AstFragment::$Kind(ast) =>
108 AstFragment::$Kind(ast.into_iter()
109 .flat_map(|ast| folder.$fold_ast_elt(ast))
114 pub fn visit_with<'a, V: Visitor<'a>>(&'a self, visitor: &mut V) {
116 AstFragment::OptExpr(Some(ref expr)) => visitor.visit_expr(expr),
117 AstFragment::OptExpr(None) => {}
118 $($(AstFragment::$Kind(ref ast) => visitor.$visit_ast(ast),)*)*
119 $($(AstFragment::$Kind(ref ast) => for ast_elt in &ast[..] {
120 visitor.$visit_ast_elt(ast_elt);
126 impl<'a, 'b> Folder for MacroExpander<'a, 'b> {
127 fn fold_opt_expr(&mut self, expr: P<ast::Expr>) -> Option<P<ast::Expr>> {
128 self.expand_fragment(AstFragment::OptExpr(Some(expr))).make_opt_expr()
130 $($(fn $fold_ast(&mut self, ast: $AstTy) -> $AstTy {
131 self.expand_fragment(AstFragment::$Kind(ast)).$make_ast()
133 $($(fn $fold_ast_elt(&mut self, ast_elt: <$AstTy as IntoIterator>::Item) -> $AstTy {
134 self.expand_fragment(AstFragment::$Kind(OneVector::one(ast_elt))).$make_ast()
138 impl<'a> MacResult for ::ext::tt::macro_rules::ParserAnyMacro<'a> {
139 $(fn $make_ast(self: Box<::ext::tt::macro_rules::ParserAnyMacro<'a>>)
141 Some(self.make(AstFragmentKind::$Kind).$make_ast())
148 Expr(P<ast::Expr>) { "expression"; one fn fold_expr; fn visit_expr; fn make_expr; }
149 Pat(P<ast::Pat>) { "pattern"; one fn fold_pat; fn visit_pat; fn make_pat; }
150 Ty(P<ast::Ty>) { "type"; one fn fold_ty; fn visit_ty; fn make_ty; }
151 Stmts(OneVector<ast::Stmt>) { "statement"; many fn fold_stmt; fn visit_stmt; fn make_stmts; }
152 Items(OneVector<P<ast::Item>>) { "item"; many fn fold_item; fn visit_item; fn make_items; }
153 TraitItems(OneVector<ast::TraitItem>) {
154 "trait item"; many fn fold_trait_item; fn visit_trait_item; fn make_trait_items;
156 ImplItems(OneVector<ast::ImplItem>) {
157 "impl item"; many fn fold_impl_item; fn visit_impl_item; fn make_impl_items;
159 ForeignItems(OneVector<ast::ForeignItem>) {
160 "foreign item"; many fn fold_foreign_item; fn visit_foreign_item; fn make_foreign_items;
164 impl AstFragmentKind {
165 fn dummy(self, span: Span) -> Option<AstFragment> {
166 self.make_from(DummyResult::any(span))
169 fn expect_from_annotatables<I: IntoIterator<Item = Annotatable>>(self, items: I)
171 let mut items = items.into_iter();
173 AstFragmentKind::Items =>
174 AstFragment::Items(items.map(Annotatable::expect_item).collect()),
175 AstFragmentKind::ImplItems =>
176 AstFragment::ImplItems(items.map(Annotatable::expect_impl_item).collect()),
177 AstFragmentKind::TraitItems =>
178 AstFragment::TraitItems(items.map(Annotatable::expect_trait_item).collect()),
179 AstFragmentKind::ForeignItems =>
180 AstFragment::ForeignItems(items.map(Annotatable::expect_foreign_item).collect()),
181 AstFragmentKind::Stmts =>
182 AstFragment::Stmts(items.map(Annotatable::expect_stmt).collect()),
183 AstFragmentKind::Expr => AstFragment::Expr(
184 items.next().expect("expected exactly one expression").expect_expr()
186 AstFragmentKind::OptExpr =>
187 AstFragment::OptExpr(items.next().map(Annotatable::expect_expr)),
188 AstFragmentKind::Pat | AstFragmentKind::Ty =>
189 panic!("patterns and types aren't annotatable"),
194 fn macro_bang_format(path: &ast::Path) -> ExpnFormat {
195 // We don't want to format a path using pretty-printing,
196 // `format!("{}", path)`, because that tries to insert
197 // line-breaks and is slow.
198 let mut path_str = String::with_capacity(64);
199 for (i, segment) in path.segments.iter().enumerate() {
201 path_str.push_str("::");
204 if segment.ident.name != keywords::CrateRoot.name() &&
205 segment.ident.name != keywords::DollarCrate.name()
207 path_str.push_str(&segment.ident.as_str())
211 MacroBang(Symbol::intern(&path_str))
214 pub struct Invocation {
215 pub kind: InvocationKind,
216 fragment_kind: AstFragmentKind,
217 pub expansion_data: ExpansionData,
220 pub enum InvocationKind {
223 ident: Option<Ident>,
227 attr: Option<ast::Attribute>,
238 pub fn span(&self) -> Span {
240 InvocationKind::Bang { span, .. } => span,
241 InvocationKind::Attr { attr: Some(ref attr), .. } => attr.span,
242 InvocationKind::Attr { attr: None, .. } => DUMMY_SP,
243 InvocationKind::Derive { ref path, .. } => path.span,
247 pub fn path(&self) -> Option<&Path> {
249 InvocationKind::Bang { ref mac, .. } => Some(&mac.node.path),
250 InvocationKind::Attr { attr: Some(ref attr), .. } => Some(&attr.path),
251 InvocationKind::Attr { attr: None, .. } => None,
252 InvocationKind::Derive { ref path, .. } => Some(path),
257 pub struct MacroExpander<'a, 'b:'a> {
258 pub cx: &'a mut ExtCtxt<'b>,
259 monotonic: bool, // c.f. `cx.monotonic_expander()`
262 impl<'a, 'b> MacroExpander<'a, 'b> {
263 pub fn new(cx: &'a mut ExtCtxt<'b>, monotonic: bool) -> Self {
264 MacroExpander { cx: cx, monotonic: monotonic }
267 pub fn expand_crate(&mut self, mut krate: ast::Crate) -> ast::Crate {
268 let mut module = ModuleData {
269 mod_path: vec![Ident::from_str(&self.cx.ecfg.crate_name)],
270 directory: match self.cx.codemap().span_to_unmapped_path(krate.span) {
271 FileName::Real(path) => path,
272 other => PathBuf::from(other.to_string()),
275 module.directory.pop();
276 self.cx.root_path = module.directory.clone();
277 self.cx.current_expansion.module = Rc::new(module);
278 self.cx.current_expansion.crate_span = Some(krate.span);
280 let orig_mod_span = krate.module.inner;
282 let krate_item = AstFragment::Items(OneVector::one(P(ast::Item {
285 node: ast::ItemKind::Mod(krate.module),
286 ident: keywords::Invalid.ident(),
287 id: ast::DUMMY_NODE_ID,
288 vis: respan(krate.span.shrink_to_lo(), ast::VisibilityKind::Public),
292 match self.expand_fragment(krate_item).make_items().pop().map(P::into_inner) {
293 Some(ast::Item { attrs, node: ast::ItemKind::Mod(module), .. }) => {
295 krate.module = module;
298 // Resolution failed so we return an empty expansion
299 krate.attrs = vec![];
300 krate.module = ast::Mod {
301 inner: orig_mod_span,
307 self.cx.trace_macros_diag();
311 // Fully expand all macro invocations in this AST fragment.
312 fn expand_fragment(&mut self, input_fragment: AstFragment) -> AstFragment {
313 let orig_expansion_data = self.cx.current_expansion.clone();
314 self.cx.current_expansion.depth = 0;
316 // Collect all macro invocations and replace them with placeholders.
317 let (fragment_with_placeholders, mut invocations)
318 = self.collect_invocations(input_fragment, &[]);
320 // Optimization: if we resolve all imports now,
321 // we'll be able to immediately resolve most of imported macros.
322 self.resolve_imports();
324 // Resolve paths in all invocations and produce ouput expanded fragments for them, but
325 // do not insert them into our input AST fragment yet, only store in `expanded_fragments`.
326 // The output fragments also go through expansion recursively until no invocations are left.
327 // Unresolved macros produce dummy outputs as a recovery measure.
328 invocations.reverse();
329 let mut expanded_fragments = Vec::new();
330 let mut derives = HashMap::new();
331 let mut undetermined_invocations = Vec::new();
332 let (mut progress, mut force) = (false, !self.monotonic);
334 let invoc = if let Some(invoc) = invocations.pop() {
337 self.resolve_imports();
338 if undetermined_invocations.is_empty() { break }
339 invocations = mem::replace(&mut undetermined_invocations, Vec::new());
340 force = !mem::replace(&mut progress, false);
345 if self.monotonic { invoc.expansion_data.mark } else { orig_expansion_data.mark };
346 let ext = match self.cx.resolver.resolve_invoc(&invoc, scope, force) {
347 Ok(ext) => Some(ext),
348 Err(Determinacy::Determined) => None,
349 Err(Determinacy::Undetermined) => {
350 undetermined_invocations.push(invoc);
356 let ExpansionData { depth, mark, .. } = invoc.expansion_data;
357 self.cx.current_expansion = invoc.expansion_data.clone();
359 self.cx.current_expansion.mark = scope;
360 // FIXME(jseyfried): Refactor out the following logic
361 let (expanded_fragment, new_invocations) = if let Some(ext) = ext {
362 if let Some(ext) = ext {
363 let dummy = invoc.fragment_kind.dummy(invoc.span()).unwrap();
364 let fragment = self.expand_invoc(invoc, &*ext).unwrap_or(dummy);
365 self.collect_invocations(fragment, &[])
366 } else if let InvocationKind::Attr { attr: None, traits, item } = invoc.kind {
367 if !item.derive_allowed() {
368 let attr = attr::find_by_name(item.attrs(), "derive")
369 .expect("`derive` attribute should exist");
370 let span = attr.span;
371 let mut err = self.cx.mut_span_err(span,
372 "`derive` may only be applied to \
373 structs, enums and unions");
374 if let ast::AttrStyle::Inner = attr.style {
375 let trait_list = traits.iter()
376 .map(|t| t.to_string()).collect::<Vec<_>>();
377 let suggestion = format!("#[derive({})]", trait_list.join(", "));
378 err.span_suggestion_with_applicability(
379 span, "try an outer attribute", suggestion,
380 // We don't 𝑘𝑛𝑜𝑤 that the following item is an ADT
381 Applicability::MaybeIncorrect
387 let item = self.fully_configure(item)
388 .map_attrs(|mut attrs| { attrs.retain(|a| a.path != "derive"); attrs });
389 let item_with_markers =
390 add_derived_markers(&mut self.cx, item.span(), &traits, item.clone());
391 let derives = derives.entry(invoc.expansion_data.mark).or_insert_with(Vec::new);
393 for path in &traits {
394 let mark = Mark::fresh(self.cx.current_expansion.mark);
396 let item = match self.cx.resolver.resolve_macro(
397 Mark::root(), path, MacroKind::Derive, false) {
398 Ok(ext) => match *ext {
399 BuiltinDerive(..) => item_with_markers.clone(),
404 invocations.push(Invocation {
405 kind: InvocationKind::Derive { path: path.clone(), item: item },
406 fragment_kind: invoc.fragment_kind,
407 expansion_data: ExpansionData {
409 ..invoc.expansion_data.clone()
413 let fragment = invoc.fragment_kind
414 .expect_from_annotatables(::std::iter::once(item_with_markers));
415 self.collect_invocations(fragment, derives)
420 self.collect_invocations(invoc.fragment_kind.dummy(invoc.span()).unwrap(), &[])
423 if expanded_fragments.len() < depth {
424 expanded_fragments.push(Vec::new());
426 expanded_fragments[depth - 1].push((mark, expanded_fragment));
427 if !self.cx.ecfg.single_step {
428 invocations.extend(new_invocations.into_iter().rev());
432 self.cx.current_expansion = orig_expansion_data;
434 // Finally incorporate all the expanded macros into the input AST fragment.
435 let mut placeholder_expander = PlaceholderExpander::new(self.cx, self.monotonic);
436 while let Some(expanded_fragments) = expanded_fragments.pop() {
437 for (mark, expanded_fragment) in expanded_fragments.into_iter().rev() {
438 let derives = derives.remove(&mark).unwrap_or_else(Vec::new);
439 placeholder_expander.add(NodeId::placeholder_from_mark(mark),
440 expanded_fragment, derives);
443 fragment_with_placeholders.fold_with(&mut placeholder_expander)
446 fn resolve_imports(&mut self) {
448 let err_count = self.cx.parse_sess.span_diagnostic.err_count();
449 self.cx.resolver.resolve_imports();
450 self.cx.resolve_err_count += self.cx.parse_sess.span_diagnostic.err_count() - err_count;
454 /// Collect all macro invocations reachable at this time in this AST fragment, and replace
455 /// them with "placeholders" - dummy macro invocations with specially crafted `NodeId`s.
456 /// Then call into resolver that builds a skeleton ("reduced graph") of the fragment and
457 /// prepares data for resolving paths of macro invocations.
458 fn collect_invocations(&mut self, fragment: AstFragment, derives: &[Mark])
459 -> (AstFragment, Vec<Invocation>) {
460 let (fragment_with_placeholders, invocations) = {
461 let mut collector = InvocationCollector {
462 cfg: StripUnconfigured {
463 should_test: self.cx.ecfg.should_test,
464 sess: self.cx.parse_sess,
465 features: self.cx.ecfg.features,
468 invocations: Vec::new(),
469 monotonic: self.monotonic,
470 tests_nameable: true,
472 (fragment.fold_with(&mut collector), collector.invocations)
476 let err_count = self.cx.parse_sess.span_diagnostic.err_count();
477 let mark = self.cx.current_expansion.mark;
478 self.cx.resolver.visit_ast_fragment_with_placeholders(mark, &fragment_with_placeholders,
480 self.cx.resolve_err_count += self.cx.parse_sess.span_diagnostic.err_count() - err_count;
483 (fragment_with_placeholders, invocations)
486 fn fully_configure(&mut self, item: Annotatable) -> Annotatable {
487 let mut cfg = StripUnconfigured {
488 should_test: self.cx.ecfg.should_test,
489 sess: self.cx.parse_sess,
490 features: self.cx.ecfg.features,
492 // Since the item itself has already been configured by the InvocationCollector,
493 // we know that fold result vector will contain exactly one element
495 Annotatable::Item(item) => {
496 Annotatable::Item(cfg.fold_item(item).pop().unwrap())
498 Annotatable::TraitItem(item) => {
499 Annotatable::TraitItem(item.map(|item| cfg.fold_trait_item(item).pop().unwrap()))
501 Annotatable::ImplItem(item) => {
502 Annotatable::ImplItem(item.map(|item| cfg.fold_impl_item(item).pop().unwrap()))
504 Annotatable::ForeignItem(item) => {
505 Annotatable::ForeignItem(
506 item.map(|item| cfg.fold_foreign_item(item).pop().unwrap())
509 Annotatable::Stmt(stmt) => {
510 Annotatable::Stmt(stmt.map(|stmt| cfg.fold_stmt(stmt).pop().unwrap()))
512 Annotatable::Expr(expr) => {
513 Annotatable::Expr(cfg.fold_expr(expr))
518 fn expand_invoc(&mut self, invoc: Invocation, ext: &SyntaxExtension) -> Option<AstFragment> {
519 if invoc.fragment_kind == AstFragmentKind::ForeignItems &&
520 !self.cx.ecfg.macros_in_extern_enabled() {
521 if let SyntaxExtension::NonMacroAttr { .. } = *ext {} else {
522 emit_feature_err(&self.cx.parse_sess, "macros_in_extern",
523 invoc.span(), GateIssue::Language,
524 "macro invocations in `extern {}` blocks are experimental");
528 let result = match invoc.kind {
529 InvocationKind::Bang { .. } => self.expand_bang_invoc(invoc, ext)?,
530 InvocationKind::Attr { .. } => self.expand_attr_invoc(invoc, ext)?,
531 InvocationKind::Derive { .. } => self.expand_derive_invoc(invoc, ext)?,
534 if self.cx.current_expansion.depth > self.cx.ecfg.recursion_limit {
535 let info = self.cx.current_expansion.mark.expn_info().unwrap();
536 let suggested_limit = self.cx.ecfg.recursion_limit * 2;
537 let mut err = self.cx.struct_span_err(info.call_site,
538 &format!("recursion limit reached while expanding the macro `{}`",
539 info.format.name()));
541 "consider adding a `#![recursion_limit=\"{}\"]` attribute to your crate",
544 self.cx.trace_macros_diag();
551 fn expand_attr_invoc(&mut self,
553 ext: &SyntaxExtension)
554 -> Option<AstFragment> {
555 let (attr, item) = match invoc.kind {
556 InvocationKind::Attr { attr, item, .. } => (attr?, item),
560 if let NonMacroAttr { mark_used: false } = *ext {} else {
561 // Macro attrs are always used when expanded,
562 // non-macro attrs are considered used when the field says so.
563 attr::mark_used(&attr);
565 invoc.expansion_data.mark.set_expn_info(ExpnInfo {
566 call_site: attr.span,
568 format: MacroAttribute(Symbol::intern(&attr.path.to_string())),
569 allow_internal_unstable: false,
570 allow_internal_unsafe: false,
571 local_inner_macros: false,
572 edition: ext.edition(),
576 NonMacroAttr { .. } => {
577 attr::mark_known(&attr);
578 let item = item.map_attrs(|mut attrs| { attrs.push(attr); attrs });
579 Some(invoc.fragment_kind.expect_from_annotatables(iter::once(item)))
581 MultiModifier(ref mac) => {
582 let meta = attr.parse_meta(self.cx.parse_sess)
583 .map_err(|mut e| { e.emit(); }).ok()?;
584 let item = mac.expand(self.cx, attr.span, &meta, item);
585 Some(invoc.fragment_kind.expect_from_annotatables(item))
587 MultiDecorator(ref mac) => {
588 let mut items = Vec::new();
589 let meta = attr.parse_meta(self.cx.parse_sess)
590 .expect("derive meta should already have been parsed");
591 mac.expand(self.cx, attr.span, &meta, &item, &mut |item| items.push(item));
593 Some(invoc.fragment_kind.expect_from_annotatables(items))
595 AttrProcMacro(ref mac, ..) => {
596 self.gate_proc_macro_attr_item(attr.span, &item);
597 let item_tok = TokenTree::Token(DUMMY_SP, Token::interpolated(match item {
598 Annotatable::Item(item) => token::NtItem(item),
599 Annotatable::TraitItem(item) => token::NtTraitItem(item.into_inner()),
600 Annotatable::ImplItem(item) => token::NtImplItem(item.into_inner()),
601 Annotatable::ForeignItem(item) => token::NtForeignItem(item.into_inner()),
602 Annotatable::Stmt(stmt) => token::NtStmt(stmt.into_inner()),
603 Annotatable::Expr(expr) => token::NtExpr(expr),
605 let input = self.extract_proc_macro_attr_input(attr.tokens, attr.span);
606 let tok_result = mac.expand(self.cx, attr.span, input, item_tok);
607 let res = self.parse_ast_fragment(tok_result, invoc.fragment_kind,
608 &attr.path, attr.span);
609 self.gate_proc_macro_expansion(attr.span, &res);
612 ProcMacroDerive(..) | BuiltinDerive(..) => {
613 self.cx.span_err(attr.span, &format!("`{}` is a derive mode", attr.path));
614 self.cx.trace_macros_diag();
615 invoc.fragment_kind.dummy(attr.span)
618 let msg = &format!("macro `{}` may not be used in attributes", attr.path);
619 self.cx.span_err(attr.span, msg);
620 self.cx.trace_macros_diag();
621 invoc.fragment_kind.dummy(attr.span)
626 fn extract_proc_macro_attr_input(&self, tokens: TokenStream, span: Span) -> TokenStream {
627 let mut trees = tokens.trees();
629 Some(TokenTree::Delimited(_, delim)) => {
630 if trees.next().is_none() {
631 return delim.tts.into()
634 Some(TokenTree::Token(..)) => {}
635 None => return TokenStream::empty(),
637 self.cx.span_err(span, "custom attribute invocations must be \
638 of the form #[foo] or #[foo(..)], the macro name must only be \
639 followed by a delimiter token");
643 fn gate_proc_macro_attr_item(&self, span: Span, item: &Annotatable) {
644 let (kind, gate) = match *item {
645 Annotatable::Item(ref item) => {
647 ItemKind::Mod(_) if self.cx.ecfg.proc_macro_mod() => return,
648 ItemKind::Mod(_) => ("modules", "proc_macro_mod"),
652 Annotatable::TraitItem(_) => return,
653 Annotatable::ImplItem(_) => return,
654 Annotatable::ForeignItem(_) => return,
655 Annotatable::Stmt(_) |
656 Annotatable::Expr(_) if self.cx.ecfg.proc_macro_expr() => return,
657 Annotatable::Stmt(_) => ("statements", "proc_macro_expr"),
658 Annotatable::Expr(_) => ("expressions", "proc_macro_expr"),
665 &format!("custom attributes cannot be applied to {}", kind),
669 fn gate_proc_macro_expansion(&self, span: Span, fragment: &Option<AstFragment>) {
670 if self.cx.ecfg.proc_macro_gen() {
673 let fragment = match fragment {
674 Some(fragment) => fragment,
678 fragment.visit_with(&mut DisallowModules {
680 parse_sess: self.cx.parse_sess,
683 struct DisallowModules<'a> {
685 parse_sess: &'a ParseSess,
688 impl<'ast, 'a> Visitor<'ast> for DisallowModules<'a> {
689 fn visit_item(&mut self, i: &'ast ast::Item) {
690 let name = match i.node {
691 ast::ItemKind::Mod(_) => Some("modules"),
692 ast::ItemKind::MacroDef(_) => Some("macro definitions"),
695 if let Some(name) = name {
701 &format!("procedural macros cannot expand to {}", name),
704 visit::walk_item(self, i);
707 fn visit_mac(&mut self, _mac: &'ast ast::Mac) {
713 /// Expand a macro invocation. Returns the resulting expanded AST fragment.
714 fn expand_bang_invoc(&mut self,
716 ext: &SyntaxExtension)
717 -> Option<AstFragment> {
718 let (mark, kind) = (invoc.expansion_data.mark, invoc.fragment_kind);
719 let (mac, ident, span) = match invoc.kind {
720 InvocationKind::Bang { mac, ident, span } => (mac, ident, span),
723 let path = &mac.node.path;
725 let ident = ident.unwrap_or_else(|| keywords::Invalid.ident());
726 let validate_and_set_expn_info = |this: &mut Self, // arg instead of capture
727 def_site_span: Option<Span>,
728 allow_internal_unstable,
729 allow_internal_unsafe,
731 // can't infer this type
732 unstable_feature: Option<(Symbol, u32)>,
735 // feature-gate the macro invocation
736 if let Some((feature, issue)) = unstable_feature {
737 let crate_span = this.cx.current_expansion.crate_span.unwrap();
738 // don't stability-check macros in the same crate
739 // (the only time this is null is for syntax extensions registered as macros)
740 if def_site_span.map_or(false, |def_span| !crate_span.contains(def_span))
741 && !span.allows_unstable() && this.cx.ecfg.features.map_or(true, |feats| {
742 // macro features will count as lib features
743 !feats.declared_lib_features.iter().any(|&(feat, _)| feat == feature)
745 let explain = format!("macro {}! is unstable", path);
746 emit_feature_err(this.cx.parse_sess, &*feature.as_str(), span,
747 GateIssue::Library(Some(issue)), &explain);
748 this.cx.trace_macros_diag();
749 return Err(kind.dummy(span));
753 if ident.name != keywords::Invalid.name() {
754 let msg = format!("macro {}! expects no ident argument, given '{}'", path, ident);
755 this.cx.span_err(path.span, &msg);
756 this.cx.trace_macros_diag();
757 return Err(kind.dummy(span));
759 mark.set_expn_info(ExpnInfo {
761 def_site: def_site_span,
762 format: macro_bang_format(path),
763 allow_internal_unstable,
764 allow_internal_unsafe,
771 let opt_expanded = match *ext {
772 DeclMacro { ref expander, def_info, edition, .. } => {
773 if let Err(dummy_span) = validate_and_set_expn_info(self, def_info.map(|(_, s)| s),
774 false, false, false, None,
778 kind.make_from(expander.expand(self.cx, span, mac.node.stream()))
785 allow_internal_unstable,
786 allow_internal_unsafe,
791 if let Err(dummy_span) = validate_and_set_expn_info(self, def_info.map(|(_, s)| s),
792 allow_internal_unstable,
793 allow_internal_unsafe,
799 kind.make_from(expander.expand(self.cx, span, mac.node.stream()))
803 IdentTT(ref expander, tt_span, allow_internal_unstable) => {
804 if ident.name == keywords::Invalid.name() {
805 self.cx.span_err(path.span,
806 &format!("macro {}! expects an ident argument", path));
807 self.cx.trace_macros_diag();
810 invoc.expansion_data.mark.set_expn_info(ExpnInfo {
813 format: macro_bang_format(path),
814 allow_internal_unstable,
815 allow_internal_unsafe: false,
816 local_inner_macros: false,
817 edition: hygiene::default_edition(),
820 let input: Vec<_> = mac.node.stream().into_trees().collect();
821 kind.make_from(expander.expand(self.cx, span, ident, input))
825 MultiDecorator(..) | MultiModifier(..) |
826 AttrProcMacro(..) | SyntaxExtension::NonMacroAttr { .. } => {
827 self.cx.span_err(path.span,
828 &format!("`{}` can only be used in attributes", path));
829 self.cx.trace_macros_diag();
833 ProcMacroDerive(..) | BuiltinDerive(..) => {
834 self.cx.span_err(path.span, &format!("`{}` is a derive mode", path));
835 self.cx.trace_macros_diag();
839 SyntaxExtension::ProcMacro { ref expander, allow_internal_unstable, edition } => {
840 if ident.name != keywords::Invalid.name() {
842 format!("macro {}! expects no ident argument, given '{}'", path, ident);
843 self.cx.span_err(path.span, &msg);
844 self.cx.trace_macros_diag();
847 self.gate_proc_macro_expansion_kind(span, kind);
848 invoc.expansion_data.mark.set_expn_info(ExpnInfo {
850 // FIXME procedural macros do not have proper span info
851 // yet, when they do, we should use it here.
853 format: macro_bang_format(path),
854 // FIXME probably want to follow macro_rules macros here.
855 allow_internal_unstable,
856 allow_internal_unsafe: false,
857 local_inner_macros: false,
861 let tok_result = expander.expand(self.cx, span, mac.node.stream());
862 let result = self.parse_ast_fragment(tok_result, kind, path, span);
863 self.gate_proc_macro_expansion(span, &result);
869 if opt_expanded.is_some() {
872 let msg = format!("non-{kind} macro in {kind} position: {name}",
873 name = path.segments[0].ident.name, kind = kind.name());
874 self.cx.span_err(path.span, &msg);
875 self.cx.trace_macros_diag();
880 fn gate_proc_macro_expansion_kind(&self, span: Span, kind: AstFragmentKind) {
881 let kind = match kind {
882 AstFragmentKind::Expr => "expressions",
883 AstFragmentKind::OptExpr => "expressions",
884 AstFragmentKind::Pat => "patterns",
885 AstFragmentKind::Ty => "types",
886 AstFragmentKind::Stmts => "statements",
887 AstFragmentKind::Items => return,
888 AstFragmentKind::TraitItems => return,
889 AstFragmentKind::ImplItems => return,
890 AstFragmentKind::ForeignItems => return,
892 if self.cx.ecfg.proc_macro_non_items() {
897 "proc_macro_non_items",
900 &format!("procedural macros cannot be expanded to {}", kind),
904 /// Expand a derive invocation. Returns the resulting expanded AST fragment.
905 fn expand_derive_invoc(&mut self,
907 ext: &SyntaxExtension)
908 -> Option<AstFragment> {
909 let (path, item) = match invoc.kind {
910 InvocationKind::Derive { path, item } => (path, item),
913 if !item.derive_allowed() {
917 let pretty_name = Symbol::intern(&format!("derive({})", path));
918 let span = path.span;
919 let attr = ast::Attribute {
921 tokens: TokenStream::empty(),
923 id: ast::AttrId(0), style: ast::AttrStyle::Outer, is_sugared_doc: false,
926 let mut expn_info = ExpnInfo {
929 format: MacroAttribute(pretty_name),
930 allow_internal_unstable: false,
931 allow_internal_unsafe: false,
932 local_inner_macros: false,
933 edition: ext.edition(),
937 ProcMacroDerive(ref ext, ..) => {
938 invoc.expansion_data.mark.set_expn_info(expn_info);
939 let span = span.with_ctxt(self.cx.backtrace());
940 let dummy = ast::MetaItem { // FIXME(jseyfried) avoid this
941 ident: Path::from_ident(keywords::Invalid.ident()),
943 node: ast::MetaItemKind::Word,
945 let items = ext.expand(self.cx, span, &dummy, item);
946 Some(invoc.fragment_kind.expect_from_annotatables(items))
948 BuiltinDerive(func) => {
949 expn_info.allow_internal_unstable = true;
950 invoc.expansion_data.mark.set_expn_info(expn_info);
951 let span = span.with_ctxt(self.cx.backtrace());
952 let mut items = Vec::new();
953 func(self.cx, span, &attr.meta()?, &item, &mut |a| items.push(a));
954 Some(invoc.fragment_kind.expect_from_annotatables(items))
957 let msg = &format!("macro `{}` may not be used for derive attributes", attr.path);
958 self.cx.span_err(span, msg);
959 self.cx.trace_macros_diag();
960 invoc.fragment_kind.dummy(span)
965 fn parse_ast_fragment(&mut self,
967 kind: AstFragmentKind,
970 -> Option<AstFragment> {
971 let mut parser = self.cx.new_parser_from_tts(&toks.into_trees().collect::<Vec<_>>());
972 match parser.parse_ast_fragment(kind, false) {
974 parser.ensure_complete_parse(path, kind.name(), span);
980 self.cx.trace_macros_diag();
987 impl<'a> Parser<'a> {
988 pub fn parse_ast_fragment(&mut self, kind: AstFragmentKind, macro_legacy_warnings: bool)
989 -> PResult<'a, AstFragment> {
991 AstFragmentKind::Items => {
992 let mut items = OneVector::new();
993 while let Some(item) = self.parse_item()? {
996 AstFragment::Items(items)
998 AstFragmentKind::TraitItems => {
999 let mut items = OneVector::new();
1000 while self.token != token::Eof {
1001 items.push(self.parse_trait_item(&mut false)?);
1003 AstFragment::TraitItems(items)
1005 AstFragmentKind::ImplItems => {
1006 let mut items = OneVector::new();
1007 while self.token != token::Eof {
1008 items.push(self.parse_impl_item(&mut false)?);
1010 AstFragment::ImplItems(items)
1012 AstFragmentKind::ForeignItems => {
1013 let mut items = OneVector::new();
1014 while self.token != token::Eof {
1015 if let Some(item) = self.parse_foreign_item()? {
1019 AstFragment::ForeignItems(items)
1021 AstFragmentKind::Stmts => {
1022 let mut stmts = OneVector::new();
1023 while self.token != token::Eof &&
1024 // won't make progress on a `}`
1025 self.token != token::CloseDelim(token::Brace) {
1026 if let Some(stmt) = self.parse_full_stmt(macro_legacy_warnings)? {
1030 AstFragment::Stmts(stmts)
1032 AstFragmentKind::Expr => AstFragment::Expr(self.parse_expr()?),
1033 AstFragmentKind::OptExpr => {
1034 if self.token != token::Eof {
1035 AstFragment::OptExpr(Some(self.parse_expr()?))
1037 AstFragment::OptExpr(None)
1040 AstFragmentKind::Ty => AstFragment::Ty(self.parse_ty()?),
1041 AstFragmentKind::Pat => AstFragment::Pat(self.parse_pat()?),
1045 pub fn ensure_complete_parse(&mut self, macro_path: &Path, kind_name: &str, span: Span) {
1046 if self.token != token::Eof {
1047 let msg = format!("macro expansion ignores token `{}` and any following",
1048 self.this_token_to_string());
1049 // Avoid emitting backtrace info twice.
1050 let def_site_span = self.span.with_ctxt(SyntaxContext::empty());
1051 let mut err = self.diagnostic().struct_span_err(def_site_span, &msg);
1052 let msg = format!("caused by the macro expansion here; the usage \
1053 of `{}!` is likely invalid in {} context",
1054 macro_path, kind_name);
1055 err.span_note(span, &msg).emit();
1060 struct InvocationCollector<'a, 'b: 'a> {
1061 cx: &'a mut ExtCtxt<'b>,
1062 cfg: StripUnconfigured<'a>,
1063 invocations: Vec<Invocation>,
1066 /// Test functions need to be nameable. Tests inside functions or in other
1067 /// unnameable locations need to be ignored. `tests_nameable` tracks whether
1068 /// any test functions found in the current context would be nameable.
1069 tests_nameable: bool,
1072 impl<'a, 'b> InvocationCollector<'a, 'b> {
1073 fn collect(&mut self, fragment_kind: AstFragmentKind, kind: InvocationKind) -> AstFragment {
1074 let mark = Mark::fresh(self.cx.current_expansion.mark);
1075 self.invocations.push(Invocation {
1078 expansion_data: ExpansionData {
1080 depth: self.cx.current_expansion.depth + 1,
1081 ..self.cx.current_expansion.clone()
1084 placeholder(fragment_kind, NodeId::placeholder_from_mark(mark))
1087 /// Folds the item allowing tests to be expanded because they are still nameable.
1088 /// This should probably only be called with module items
1089 fn fold_nameable(&mut self, item: P<ast::Item>) -> OneVector<P<ast::Item>> {
1090 fold::noop_fold_item(item, self)
1093 /// Folds the item but doesn't allow tests to occur within it
1094 fn fold_unnameable(&mut self, item: P<ast::Item>) -> OneVector<P<ast::Item>> {
1095 let was_nameable = mem::replace(&mut self.tests_nameable, false);
1096 let items = fold::noop_fold_item(item, self);
1097 self.tests_nameable = was_nameable;
1101 fn collect_bang(&mut self, mac: ast::Mac, span: Span, kind: AstFragmentKind) -> AstFragment {
1102 self.collect(kind, InvocationKind::Bang { mac: mac, ident: None, span: span })
1105 fn collect_attr(&mut self,
1106 attr: Option<ast::Attribute>,
1109 kind: AstFragmentKind)
1111 self.collect(kind, InvocationKind::Attr { attr, traits, item })
1114 /// If `item` is an attr invocation, remove and return the macro attribute and derive traits.
1115 fn classify_item<T>(&mut self, mut item: T) -> (Option<ast::Attribute>, Vec<Path>, T)
1118 let (mut attr, mut traits) = (None, Vec::new());
1120 item = item.map_attrs(|mut attrs| {
1121 if let Some(legacy_attr_invoc) = self.cx.resolver.find_legacy_attr_invoc(&mut attrs,
1123 attr = Some(legacy_attr_invoc);
1127 if self.cx.ecfg.use_extern_macros_enabled() {
1128 attr = find_attr_invoc(&mut attrs);
1130 traits = collect_derives(&mut self.cx, &mut attrs);
1134 (attr, traits, item)
1137 /// Alternative of `classify_item()` that ignores `#[derive]` so invocations fallthrough
1138 /// to the unused-attributes lint (making it an error on statements and expressions
1139 /// is a breaking change)
1140 fn classify_nonitem<T: HasAttrs>(&mut self, mut item: T) -> (Option<ast::Attribute>, T) {
1141 let mut attr = None;
1143 item = item.map_attrs(|mut attrs| {
1144 if let Some(legacy_attr_invoc) = self.cx.resolver.find_legacy_attr_invoc(&mut attrs,
1146 attr = Some(legacy_attr_invoc);
1150 if self.cx.ecfg.use_extern_macros_enabled() {
1151 attr = find_attr_invoc(&mut attrs);
1159 fn configure<T: HasAttrs>(&mut self, node: T) -> Option<T> {
1160 self.cfg.configure(node)
1163 // Detect use of feature-gated or invalid attributes on macro invocations
1164 // since they will not be detected after macro expansion.
1165 fn check_attributes(&mut self, attrs: &[ast::Attribute]) {
1166 let features = self.cx.ecfg.features.unwrap();
1167 for attr in attrs.iter() {
1168 self.check_attribute_inner(attr, features);
1170 // macros are expanded before any lint passes so this warning has to be hardcoded
1171 if attr.path == "derive" {
1172 self.cx.struct_span_warn(attr.span, "`#[derive]` does nothing on macro invocations")
1173 .note("this may become a hard error in a future release")
1179 fn check_attribute(&mut self, at: &ast::Attribute) {
1180 let features = self.cx.ecfg.features.unwrap();
1181 self.check_attribute_inner(at, features);
1184 fn check_attribute_inner(&mut self, at: &ast::Attribute, features: &Features) {
1185 feature_gate::check_attribute(at, self.cx.parse_sess, features);
1189 pub fn find_attr_invoc(attrs: &mut Vec<ast::Attribute>) -> Option<ast::Attribute> {
1191 .position(|a| !attr::is_known(a) && !is_builtin_attr(a))
1192 .map(|i| attrs.remove(i))
1195 impl<'a, 'b> Folder for InvocationCollector<'a, 'b> {
1196 fn fold_expr(&mut self, expr: P<ast::Expr>) -> P<ast::Expr> {
1197 let mut expr = self.cfg.configure_expr(expr).into_inner();
1198 expr.node = self.cfg.configure_expr_kind(expr.node);
1200 // ignore derives so they remain unused
1201 let (attr, expr) = self.classify_nonitem(expr);
1204 // collect the invoc regardless of whether or not attributes are permitted here
1205 // expansion will eat the attribute so it won't error later
1206 attr.as_ref().map(|a| self.cfg.maybe_emit_expr_attr_err(a));
1208 // AstFragmentKind::Expr requires the macro to emit an expression
1209 return self.collect_attr(attr, vec![], Annotatable::Expr(P(expr)),
1210 AstFragmentKind::Expr).make_expr();
1213 if let ast::ExprKind::Mac(mac) = expr.node {
1214 self.check_attributes(&expr.attrs);
1215 self.collect_bang(mac, expr.span, AstFragmentKind::Expr).make_expr()
1217 P(noop_fold_expr(expr, self))
1221 fn fold_opt_expr(&mut self, expr: P<ast::Expr>) -> Option<P<ast::Expr>> {
1222 let mut expr = configure!(self, expr).into_inner();
1223 expr.node = self.cfg.configure_expr_kind(expr.node);
1225 // ignore derives so they remain unused
1226 let (attr, expr) = self.classify_nonitem(expr);
1229 attr.as_ref().map(|a| self.cfg.maybe_emit_expr_attr_err(a));
1231 return self.collect_attr(attr, vec![], Annotatable::Expr(P(expr)),
1232 AstFragmentKind::OptExpr)
1236 if let ast::ExprKind::Mac(mac) = expr.node {
1237 self.check_attributes(&expr.attrs);
1238 self.collect_bang(mac, expr.span, AstFragmentKind::OptExpr).make_opt_expr()
1240 Some(P(noop_fold_expr(expr, self)))
1244 fn fold_pat(&mut self, pat: P<ast::Pat>) -> P<ast::Pat> {
1245 let pat = self.cfg.configure_pat(pat);
1247 PatKind::Mac(_) => {}
1248 _ => return noop_fold_pat(pat, self),
1251 pat.and_then(|pat| match pat.node {
1252 PatKind::Mac(mac) => self.collect_bang(mac, pat.span, AstFragmentKind::Pat).make_pat(),
1253 _ => unreachable!(),
1257 fn fold_stmt(&mut self, stmt: ast::Stmt) -> OneVector<ast::Stmt> {
1258 let mut stmt = match self.cfg.configure_stmt(stmt) {
1260 None => return OneVector::new(),
1263 // we'll expand attributes on expressions separately
1264 if !stmt.is_expr() {
1265 let (attr, derives, stmt_) = if stmt.is_item() {
1266 self.classify_item(stmt)
1268 // ignore derives on non-item statements so it falls through
1269 // to the unused-attributes lint
1270 let (attr, stmt) = self.classify_nonitem(stmt);
1271 (attr, vec![], stmt)
1274 if attr.is_some() || !derives.is_empty() {
1275 return self.collect_attr(attr, derives,
1276 Annotatable::Stmt(P(stmt_)), AstFragmentKind::Stmts)
1283 if let StmtKind::Mac(mac) = stmt.node {
1284 let (mac, style, attrs) = mac.into_inner();
1285 self.check_attributes(&attrs);
1286 let mut placeholder = self.collect_bang(mac, stmt.span, AstFragmentKind::Stmts)
1289 // If this is a macro invocation with a semicolon, then apply that
1290 // semicolon to the final statement produced by expansion.
1291 if style == MacStmtStyle::Semicolon {
1292 if let Some(stmt) = placeholder.pop() {
1293 placeholder.push(stmt.add_trailing_semicolon());
1300 // The placeholder expander gives ids to statements, so we avoid folding the id here.
1301 let ast::Stmt { id, node, span } = stmt;
1302 noop_fold_stmt_kind(node, self).into_iter().map(|node| {
1303 ast::Stmt { id, node, span }
1308 fn fold_block(&mut self, block: P<Block>) -> P<Block> {
1309 let old_directory_ownership = self.cx.current_expansion.directory_ownership;
1310 self.cx.current_expansion.directory_ownership = DirectoryOwnership::UnownedViaBlock;
1311 let result = noop_fold_block(block, self);
1312 self.cx.current_expansion.directory_ownership = old_directory_ownership;
1316 fn fold_item(&mut self, item: P<ast::Item>) -> OneVector<P<ast::Item>> {
1317 let item = configure!(self, item);
1319 let (attr, traits, mut item) = self.classify_item(item);
1320 if attr.is_some() || !traits.is_empty() {
1321 let item = Annotatable::Item(item);
1322 return self.collect_attr(attr, traits, item, AstFragmentKind::Items).make_items();
1326 ast::ItemKind::Mac(..) => {
1327 self.check_attributes(&item.attrs);
1328 item.and_then(|item| match item.node {
1329 ItemKind::Mac(mac) => {
1330 self.collect(AstFragmentKind::Items, InvocationKind::Bang {
1332 ident: Some(item.ident),
1336 _ => unreachable!(),
1339 ast::ItemKind::Mod(ast::Mod { inner, .. }) => {
1340 if item.ident == keywords::Invalid.ident() {
1341 return self.fold_nameable(item);
1344 let orig_directory_ownership = self.cx.current_expansion.directory_ownership;
1345 let mut module = (*self.cx.current_expansion.module).clone();
1346 module.mod_path.push(item.ident);
1348 // Detect if this is an inline module (`mod m { ... }` as opposed to `mod m;`).
1349 // In the non-inline case, `inner` is never the dummy span (c.f. `parse_item_mod`).
1350 // Thus, if `inner` is the dummy span, we know the module is inline.
1351 let inline_module = item.span.contains(inner) || inner.is_dummy();
1354 if let Some(path) = attr::first_attr_value_str_by_name(&item.attrs, "path") {
1355 self.cx.current_expansion.directory_ownership =
1356 DirectoryOwnership::Owned { relative: None };
1357 module.directory.push(&*path.as_str());
1359 module.directory.push(&*item.ident.as_str());
1362 let path = self.cx.parse_sess.codemap().span_to_unmapped_path(inner);
1363 let mut path = match path {
1364 FileName::Real(path) => path,
1365 other => PathBuf::from(other.to_string()),
1367 let directory_ownership = match path.file_name().unwrap().to_str() {
1368 Some("mod.rs") => DirectoryOwnership::Owned { relative: None },
1369 Some(_) => DirectoryOwnership::Owned {
1370 relative: Some(item.ident),
1372 None => DirectoryOwnership::UnownedViaMod(false),
1375 module.directory = path;
1376 self.cx.current_expansion.directory_ownership = directory_ownership;
1380 mem::replace(&mut self.cx.current_expansion.module, Rc::new(module));
1381 let result = self.fold_nameable(item);
1382 self.cx.current_expansion.module = orig_module;
1383 self.cx.current_expansion.directory_ownership = orig_directory_ownership;
1386 // Ensure that test functions are accessible from the test harness.
1387 // #[test] fn foo() {}
1389 // #[test] pub fn foo_gensym(){}
1391 // use foo_gensym as foo;
1392 ast::ItemKind::Fn(..) if self.cx.ecfg.should_test => {
1393 if self.tests_nameable && item.attrs.iter().any(|attr| is_test_or_bench(attr)) {
1394 let orig_ident = item.ident;
1395 let orig_vis = item.vis.clone();
1397 // Publicize the item under gensymed name to avoid pollution
1398 item = item.map(|mut item| {
1399 item.vis = respan(item.vis.span, ast::VisibilityKind::Public);
1400 item.ident = item.ident.gensym();
1404 // Use the gensymed name under the item's original visibility
1405 let mut use_item = self.cx.item_use_simple_(
1409 self.cx.path(item.ident.span,
1410 vec![keywords::SelfValue.ident(), item.ident]));
1412 // #[allow(unused)] because the test function probably isn't being referenced
1413 use_item = use_item.map(|mut ui| {
1415 self.cx.attribute(DUMMY_SP, attr::mk_list_item(DUMMY_SP,
1416 Ident::from_str("allow"), vec![
1417 attr::mk_nested_word_item(Ident::from_str("unused"))
1426 self.fold_unnameable(item).into_iter()
1427 .chain(self.fold_unnameable(use_item)))
1429 self.fold_unnameable(item)
1432 _ => self.fold_unnameable(item),
1436 fn fold_trait_item(&mut self, item: ast::TraitItem) -> OneVector<ast::TraitItem> {
1437 let item = configure!(self, item);
1439 let (attr, traits, item) = self.classify_item(item);
1440 if attr.is_some() || !traits.is_empty() {
1441 let item = Annotatable::TraitItem(P(item));
1442 return self.collect_attr(attr, traits, item, AstFragmentKind::TraitItems)
1447 ast::TraitItemKind::Macro(mac) => {
1448 let ast::TraitItem { attrs, span, .. } = item;
1449 self.check_attributes(&attrs);
1450 self.collect_bang(mac, span, AstFragmentKind::TraitItems).make_trait_items()
1452 _ => fold::noop_fold_trait_item(item, self),
1456 fn fold_impl_item(&mut self, item: ast::ImplItem) -> OneVector<ast::ImplItem> {
1457 let item = configure!(self, item);
1459 let (attr, traits, item) = self.classify_item(item);
1460 if attr.is_some() || !traits.is_empty() {
1461 let item = Annotatable::ImplItem(P(item));
1462 return self.collect_attr(attr, traits, item, AstFragmentKind::ImplItems)
1467 ast::ImplItemKind::Macro(mac) => {
1468 let ast::ImplItem { attrs, span, .. } = item;
1469 self.check_attributes(&attrs);
1470 self.collect_bang(mac, span, AstFragmentKind::ImplItems).make_impl_items()
1472 _ => fold::noop_fold_impl_item(item, self),
1476 fn fold_ty(&mut self, ty: P<ast::Ty>) -> P<ast::Ty> {
1477 let ty = match ty.node {
1478 ast::TyKind::Mac(_) => ty.into_inner(),
1479 _ => return fold::noop_fold_ty(ty, self),
1483 ast::TyKind::Mac(mac) => self.collect_bang(mac, ty.span, AstFragmentKind::Ty).make_ty(),
1484 _ => unreachable!(),
1488 fn fold_foreign_mod(&mut self, foreign_mod: ast::ForeignMod) -> ast::ForeignMod {
1489 noop_fold_foreign_mod(self.cfg.configure_foreign_mod(foreign_mod), self)
1492 fn fold_foreign_item(&mut self,
1493 foreign_item: ast::ForeignItem) -> OneVector<ast::ForeignItem> {
1494 let (attr, traits, foreign_item) = self.classify_item(foreign_item);
1496 if attr.is_some() || !traits.is_empty() {
1497 let item = Annotatable::ForeignItem(P(foreign_item));
1498 return self.collect_attr(attr, traits, item, AstFragmentKind::ForeignItems)
1499 .make_foreign_items();
1502 if let ast::ForeignItemKind::Macro(mac) = foreign_item.node {
1503 self.check_attributes(&foreign_item.attrs);
1504 return self.collect_bang(mac, foreign_item.span, AstFragmentKind::ForeignItems)
1505 .make_foreign_items();
1508 noop_fold_foreign_item(foreign_item, self)
1511 fn fold_item_kind(&mut self, item: ast::ItemKind) -> ast::ItemKind {
1513 ast::ItemKind::MacroDef(..) => item,
1514 _ => noop_fold_item_kind(self.cfg.configure_item_kind(item), self),
1518 fn fold_generic_param(&mut self, param: ast::GenericParam) -> ast::GenericParam {
1519 self.cfg.disallow_cfg_on_generic_param(¶m);
1520 noop_fold_generic_param(param, self)
1523 fn fold_attribute(&mut self, at: ast::Attribute) -> Option<ast::Attribute> {
1524 // turn `#[doc(include="filename")]` attributes into `#[doc(include(file="filename",
1525 // contents="file contents")]` attributes
1526 if !at.check_name("doc") {
1527 return noop_fold_attribute(at, self);
1530 if let Some(list) = at.meta_item_list() {
1531 if !list.iter().any(|it| it.check_name("include")) {
1532 return noop_fold_attribute(at, self);
1535 let mut items = vec![];
1538 if !it.check_name("include") {
1539 items.push(noop_fold_meta_list_item(it, self));
1543 if let Some(file) = it.value_str() {
1544 let err_count = self.cx.parse_sess.span_diagnostic.err_count();
1545 self.check_attribute(&at);
1546 if self.cx.parse_sess.span_diagnostic.err_count() > err_count {
1547 // avoid loading the file if they haven't enabled the feature
1548 return noop_fold_attribute(at, self);
1551 let mut buf = vec![];
1552 let filename = self.cx.root_path.join(file.to_string());
1554 match File::open(&filename).and_then(|mut f| f.read_to_end(&mut buf)) {
1557 self.cx.span_err(at.span,
1558 &format!("couldn't read {}: {}",
1564 match String::from_utf8(buf) {
1566 let src_interned = Symbol::intern(&src);
1568 // Add this input file to the code map to make it available as
1569 // dependency information
1570 self.cx.codemap().new_filemap(filename.into(), src);
1572 let include_info = vec![
1573 dummy_spanned(ast::NestedMetaItemKind::MetaItem(
1574 attr::mk_name_value_item_str(Ident::from_str("file"),
1575 dummy_spanned(file)))),
1576 dummy_spanned(ast::NestedMetaItemKind::MetaItem(
1577 attr::mk_name_value_item_str(Ident::from_str("contents"),
1578 dummy_spanned(src_interned)))),
1581 let include_ident = Ident::from_str("include");
1582 let item = attr::mk_list_item(DUMMY_SP, include_ident, include_info);
1583 items.push(dummy_spanned(ast::NestedMetaItemKind::MetaItem(item)));
1586 self.cx.span_err(at.span,
1587 &format!("{} wasn't a utf-8 file",
1588 filename.display()));
1592 items.push(noop_fold_meta_list_item(it, self));
1596 let meta = attr::mk_list_item(DUMMY_SP, Ident::from_str("doc"), items);
1598 ast::AttrStyle::Inner =>
1599 Some(attr::mk_spanned_attr_inner(at.span, at.id, meta)),
1600 ast::AttrStyle::Outer =>
1601 Some(attr::mk_spanned_attr_outer(at.span, at.id, meta)),
1604 noop_fold_attribute(at, self)
1608 fn new_id(&mut self, id: ast::NodeId) -> ast::NodeId {
1610 assert_eq!(id, ast::DUMMY_NODE_ID);
1611 self.cx.resolver.next_node_id()
1618 pub struct ExpansionConfig<'feat> {
1619 pub crate_name: String,
1620 pub features: Option<&'feat Features>,
1621 pub recursion_limit: usize,
1622 pub trace_mac: bool,
1623 pub should_test: bool, // If false, strip `#[test]` nodes
1624 pub single_step: bool,
1625 pub keep_macs: bool,
1628 macro_rules! feature_tests {
1629 ($( fn $getter:ident = $field:ident, )*) => {
1631 pub fn $getter(&self) -> bool {
1632 match self.features {
1633 Some(&Features { $field: true, .. }) => true,
1641 impl<'feat> ExpansionConfig<'feat> {
1642 pub fn default(crate_name: String) -> ExpansionConfig<'static> {
1646 recursion_limit: 1024,
1655 fn enable_quotes = quote,
1656 fn enable_asm = asm,
1657 fn enable_global_asm = global_asm,
1658 fn enable_log_syntax = log_syntax,
1659 fn enable_concat_idents = concat_idents,
1660 fn enable_trace_macros = trace_macros,
1661 fn enable_allow_internal_unstable = allow_internal_unstable,
1662 fn enable_custom_derive = custom_derive,
1663 fn enable_format_args_nl = format_args_nl,
1664 fn macros_in_extern_enabled = macros_in_extern,
1665 fn proc_macro_mod = proc_macro_mod,
1666 fn proc_macro_gen = proc_macro_gen,
1667 fn proc_macro_expr = proc_macro_expr,
1668 fn proc_macro_non_items = proc_macro_non_items,
1671 pub fn use_extern_macros_enabled(&self) -> bool {
1672 self.features.map_or(false, |features| features.use_extern_macros())
1676 // A Marker adds the given mark to the syntax context.
1678 pub struct Marker(pub Mark);
1680 impl Folder for Marker {
1681 fn new_span(&mut self, span: Span) -> Span {
1682 span.apply_mark(self.0)
1685 fn fold_mac(&mut self, mac: ast::Mac) -> ast::Mac {
1686 noop_fold_mac(mac, self)