compiler/rustc_expand/src/expand.rs

   1 use crate::base::*;
   2 use crate::config::StripUnconfigured;
   3 use crate::hygiene::SyntaxContext;
   4 use crate::mbe::macro_rules::annotate_err_with_kind;
   5 use crate::module::{mod_dir_path, parse_external_mod, DirOwnership, ParsedExternalMod};
   6 use crate::placeholders::{placeholder, PlaceholderExpander};
   7
   8 use rustc_ast as ast;
   9 use rustc_ast::mut_visit::*;
  10 use rustc_ast::ptr::P;
  11 use rustc_ast::token;
  12 use rustc_ast::tokenstream::TokenStream;
  13 use rustc_ast::visit::{self, AssocCtxt, Visitor};
  14 use rustc_ast::{AssocItemKind, AstLike, AstLikeWrapper, AttrStyle, ExprKind, ForeignItemKind};
  15 use rustc_ast::{Inline, ItemKind, MacArgs, MacStmtStyle, MetaItemKind, ModKind, NestedMetaItem};
  16 use rustc_ast::{NodeId, PatKind, StmtKind, TyKind};
  17 use rustc_ast_pretty::pprust;
  18 use rustc_data_structures::map_in_place::MapInPlace;
  19 use rustc_data_structures::sync::Lrc;
  20 use rustc_errors::{Applicability, PResult};
  21 use rustc_feature::Features;
  22 use rustc_parse::parser::{
  23     AttemptLocalParseRecovery, ForceCollect, Parser, RecoverColon, RecoverComma,
  24 };
  25 use rustc_parse::validate_attr;
  26 use rustc_session::lint::builtin::{UNUSED_ATTRIBUTES, UNUSED_DOC_COMMENTS};
  27 use rustc_session::lint::BuiltinLintDiagnostics;
  28 use rustc_session::parse::{feature_err, ParseSess};
  29 use rustc_session::Limit;
  30 use rustc_span::symbol::{sym, Ident};
  31 use rustc_span::{FileName, LocalExpnId, Span};
  32
  33 use smallvec::SmallVec;
  34 use std::ops::Deref;
  35 use std::path::PathBuf;
  36 use std::rc::Rc;
  37 use std::{iter, mem};
  38
  39 macro_rules! ast_fragments {
  40     (
  41         $($Kind:ident($AstTy:ty) {
  42             $kind_name:expr;
  43             $(one fn $mut_visit_ast:ident; fn $visit_ast:ident;)?
  44             $(many fn $flat_map_ast_elt:ident; fn $visit_ast_elt:ident($($args:tt)*);)?
  45             fn $make_ast:ident;
  46         })*
  47     ) => {
  48         /// A fragment of AST that can be produced by a single macro expansion.
  49         /// Can also serve as an input and intermediate result for macro expansion operations.
  50         pub enum AstFragment {
  51             OptExpr(Option<P<ast::Expr>>),
  52             $($Kind($AstTy),)*
  53         }
  54
  55         /// "Discriminant" of an AST fragment.
  56         #[derive(Copy, Clone, PartialEq, Eq)]
  57         pub enum AstFragmentKind {
  58             OptExpr,
  59             $($Kind,)*
  60         }
  61
  62         impl AstFragmentKind {
  63             pub fn name(self) -> &'static str {
  64                 match self {
  65                     AstFragmentKind::OptExpr => "expression",
  66                     $(AstFragmentKind::$Kind => $kind_name,)*
  67                 }
  68             }
  69
  70             fn make_from<'a>(self, result: Box<dyn MacResult + 'a>) -> Option<AstFragment> {
  71                 match self {
  72                     AstFragmentKind::OptExpr =>
  73                         result.make_expr().map(Some).map(AstFragment::OptExpr),
  74                     $(AstFragmentKind::$Kind => result.$make_ast().map(AstFragment::$Kind),)*
  75                 }
  76             }
  77         }
  78
  79         impl AstFragment {
  80             pub fn add_placeholders(&mut self, placeholders: &[NodeId]) {
  81                 if placeholders.is_empty() {
  82                     return;
  83                 }
  84                 match self {
  85                     $($(AstFragment::$Kind(ast) => ast.extend(placeholders.iter().flat_map(|id| {
  86                         // We are repeating through arguments with `many`, to do that we have to
  87                         // mention some macro variable from those arguments even if it's not used.
  88                         macro _repeating($flat_map_ast_elt) {}
  89                         placeholder(AstFragmentKind::$Kind, *id, None).$make_ast()
  90                     })),)?)*
  91                     _ => panic!("unexpected AST fragment kind")
  92                 }
  93             }
  94
  95             pub fn make_opt_expr(self) -> Option<P<ast::Expr>> {
  96                 match self {
  97                     AstFragment::OptExpr(expr) => expr,
  98                     _ => panic!("AstFragment::make_* called on the wrong kind of fragment"),
  99                 }
 100             }
 101
 102             $(pub fn $make_ast(self) -> $AstTy {
 103                 match self {
 104                     AstFragment::$Kind(ast) => ast,
 105                     _ => panic!("AstFragment::make_* called on the wrong kind of fragment"),
 106                 }
 107             })*
 108
 109             fn make_ast<T: InvocationCollectorNode>(self) -> T::OutputTy {
 110                 T::fragment_to_output(self)
 111             }
 112
 113             pub fn mut_visit_with<F: MutVisitor>(&mut self, vis: &mut F) {
 114                 match self {
 115                     AstFragment::OptExpr(opt_expr) => {
 116                         visit_clobber(opt_expr, |opt_expr| {
 117                             if let Some(expr) = opt_expr {
 118                                 vis.filter_map_expr(expr)
 119                             } else {
 120                                 None
 121                             }
 122                         });
 123                     }
 124                     $($(AstFragment::$Kind(ast) => vis.$mut_visit_ast(ast),)?)*
 125                     $($(AstFragment::$Kind(ast) =>
 126                         ast.flat_map_in_place(|ast| vis.$flat_map_ast_elt(ast)),)?)*
 127                 }
 128             }
 129
 130             pub fn visit_with<'a, V: Visitor<'a>>(&'a self, visitor: &mut V) {
 131                 match *self {
 132                     AstFragment::OptExpr(Some(ref expr)) => visitor.visit_expr(expr),
 133                     AstFragment::OptExpr(None) => {}
 134                     $($(AstFragment::$Kind(ref ast) => visitor.$visit_ast(ast),)?)*
 135                     $($(AstFragment::$Kind(ref ast) => for ast_elt in &ast[..] {
 136                         visitor.$visit_ast_elt(ast_elt, $($args)*);
 137                     })?)*
 138                 }
 139             }
 140         }
 141
 142         impl<'a> MacResult for crate::mbe::macro_rules::ParserAnyMacro<'a> {
 143             $(fn $make_ast(self: Box<crate::mbe::macro_rules::ParserAnyMacro<'a>>)
 144                            -> Option<$AstTy> {
 145                 Some(self.make(AstFragmentKind::$Kind).$make_ast())
 146             })*
 147         }
 148     }
 149 }
 150
 151 ast_fragments! {
 152     Expr(P<ast::Expr>) { "expression"; one fn visit_expr; fn visit_expr; fn make_expr; }
 153     Pat(P<ast::Pat>) { "pattern"; one fn visit_pat; fn visit_pat; fn make_pat; }
 154     Ty(P<ast::Ty>) { "type"; one fn visit_ty; fn visit_ty; fn make_ty; }
 155     Stmts(SmallVec<[ast::Stmt; 1]>) {
 156         "statement"; many fn flat_map_stmt; fn visit_stmt(); fn make_stmts;
 157     }
 158     Items(SmallVec<[P<ast::Item>; 1]>) {
 159         "item"; many fn flat_map_item; fn visit_item(); fn make_items;
 160     }
 161     TraitItems(SmallVec<[P<ast::AssocItem>; 1]>) {
 162         "trait item";
 163         many fn flat_map_trait_item;
 164         fn visit_assoc_item(AssocCtxt::Trait);
 165         fn make_trait_items;
 166     }
 167     ImplItems(SmallVec<[P<ast::AssocItem>; 1]>) {
 168         "impl item";
 169         many fn flat_map_impl_item;
 170         fn visit_assoc_item(AssocCtxt::Impl);
 171         fn make_impl_items;
 172     }
 173     ForeignItems(SmallVec<[P<ast::ForeignItem>; 1]>) {
 174         "foreign item";
 175         many fn flat_map_foreign_item;
 176         fn visit_foreign_item();
 177         fn make_foreign_items;
 178     }
 179     Arms(SmallVec<[ast::Arm; 1]>) {
 180         "match arm"; many fn flat_map_arm; fn visit_arm(); fn make_arms;
 181     }
 182     ExprFields(SmallVec<[ast::ExprField; 1]>) {
 183         "field expression"; many fn flat_map_expr_field; fn visit_expr_field(); fn make_expr_fields;
 184     }
 185     PatFields(SmallVec<[ast::PatField; 1]>) {
 186         "field pattern";
 187         many fn flat_map_pat_field;
 188         fn visit_pat_field();
 189         fn make_pat_fields;
 190     }
 191     GenericParams(SmallVec<[ast::GenericParam; 1]>) {
 192         "generic parameter";
 193         many fn flat_map_generic_param;
 194         fn visit_generic_param();
 195         fn make_generic_params;
 196     }
 197     Params(SmallVec<[ast::Param; 1]>) {
 198         "function parameter"; many fn flat_map_param; fn visit_param(); fn make_params;
 199     }
 200     FieldDefs(SmallVec<[ast::FieldDef; 1]>) {
 201         "field";
 202         many fn flat_map_field_def;
 203         fn visit_field_def();
 204         fn make_field_defs;
 205     }
 206     Variants(SmallVec<[ast::Variant; 1]>) {
 207         "variant"; many fn flat_map_variant; fn visit_variant(); fn make_variants;
 208     }
 209     Crate(ast::Crate) { "crate"; one fn visit_crate; fn visit_crate; fn make_crate; }
 210 }
 211
 212 pub enum SupportsMacroExpansion {
 213     No,
 214     Yes { supports_inner_attrs: bool },
 215 }
 216
 217 impl AstFragmentKind {
 218     crate fn dummy(self, span: Span) -> AstFragment {
 219         self.make_from(DummyResult::any(span)).expect("couldn't create a dummy AST fragment")
 220     }
 221
 222     pub fn supports_macro_expansion(self) -> SupportsMacroExpansion {
 223         match self {
 224             AstFragmentKind::OptExpr
 225             | AstFragmentKind::Expr
 226             | AstFragmentKind::Stmts
 227             | AstFragmentKind::Ty
 228             | AstFragmentKind::Pat => SupportsMacroExpansion::Yes { supports_inner_attrs: false },
 229             AstFragmentKind::Items
 230             | AstFragmentKind::TraitItems
 231             | AstFragmentKind::ImplItems
 232             | AstFragmentKind::ForeignItems
 233             | AstFragmentKind::Crate => SupportsMacroExpansion::Yes { supports_inner_attrs: true },
 234             AstFragmentKind::Arms
 235             | AstFragmentKind::ExprFields
 236             | AstFragmentKind::PatFields
 237             | AstFragmentKind::GenericParams
 238             | AstFragmentKind::Params
 239             | AstFragmentKind::FieldDefs
 240             | AstFragmentKind::Variants => SupportsMacroExpansion::No,
 241         }
 242     }
 243
 244     fn expect_from_annotatables<I: IntoIterator<Item = Annotatable>>(
 245         self,
 246         items: I,
 247     ) -> AstFragment {
 248         let mut items = items.into_iter();
 249         match self {
 250             AstFragmentKind::Arms => {
 251                 AstFragment::Arms(items.map(Annotatable::expect_arm).collect())
 252             }
 253             AstFragmentKind::ExprFields => {
 254                 AstFragment::ExprFields(items.map(Annotatable::expect_expr_field).collect())
 255             }
 256             AstFragmentKind::PatFields => {
 257                 AstFragment::PatFields(items.map(Annotatable::expect_pat_field).collect())
 258             }
 259             AstFragmentKind::GenericParams => {
 260                 AstFragment::GenericParams(items.map(Annotatable::expect_generic_param).collect())
 261             }
 262             AstFragmentKind::Params => {
 263                 AstFragment::Params(items.map(Annotatable::expect_param).collect())
 264             }
 265             AstFragmentKind::FieldDefs => {
 266                 AstFragment::FieldDefs(items.map(Annotatable::expect_field_def).collect())
 267             }
 268             AstFragmentKind::Variants => {
 269                 AstFragment::Variants(items.map(Annotatable::expect_variant).collect())
 270             }
 271             AstFragmentKind::Items => {
 272                 AstFragment::Items(items.map(Annotatable::expect_item).collect())
 273             }
 274             AstFragmentKind::ImplItems => {
 275                 AstFragment::ImplItems(items.map(Annotatable::expect_impl_item).collect())
 276             }
 277             AstFragmentKind::TraitItems => {
 278                 AstFragment::TraitItems(items.map(Annotatable::expect_trait_item).collect())
 279             }
 280             AstFragmentKind::ForeignItems => {
 281                 AstFragment::ForeignItems(items.map(Annotatable::expect_foreign_item).collect())
 282             }
 283             AstFragmentKind::Stmts => {
 284                 AstFragment::Stmts(items.map(Annotatable::expect_stmt).collect())
 285             }
 286             AstFragmentKind::Expr => AstFragment::Expr(
 287                 items.next().expect("expected exactly one expression").expect_expr(),
 288             ),
 289             AstFragmentKind::OptExpr => {
 290                 AstFragment::OptExpr(items.next().map(Annotatable::expect_expr))
 291             }
 292             AstFragmentKind::Crate => {
 293                 AstFragment::Crate(items.next().expect("expected exactly one crate").expect_crate())
 294             }
 295             AstFragmentKind::Pat | AstFragmentKind::Ty => {
 296                 panic!("patterns and types aren't annotatable")
 297             }
 298         }
 299     }
 300 }
 301
 302 pub struct Invocation {
 303     pub kind: InvocationKind,
 304     pub fragment_kind: AstFragmentKind,
 305     pub expansion_data: ExpansionData,
 306 }
 307
 308 pub enum InvocationKind {
 309     Bang {
 310         mac: ast::MacCall,
 311         span: Span,
 312     },
 313     Attr {
 314         attr: ast::Attribute,
 315         // Re-insertion position for inert attributes.
 316         pos: usize,
 317         item: Annotatable,
 318         // Required for resolving derive helper attributes.
 319         derives: Vec<ast::Path>,
 320     },
 321     Derive {
 322         path: ast::Path,
 323         item: Annotatable,
 324     },
 325 }
 326
 327 impl InvocationKind {
 328     fn placeholder_visibility(&self) -> Option<ast::Visibility> {
 329         // HACK: For unnamed fields placeholders should have the same visibility as the actual
 330         // fields because for tuple structs/variants resolve determines visibilities of their
 331         // constructor using these field visibilities before attributes on them are are expanded.
 332         // The assumption is that the attribute expansion cannot change field visibilities,
 333         // and it holds because only inert attributes are supported in this position.
 334         match self {
 335             InvocationKind::Attr { item: Annotatable::FieldDef(field), .. }
 336             | InvocationKind::Derive { item: Annotatable::FieldDef(field), .. }
 337                 if field.ident.is_none() =>
 338             {
 339                 Some(field.vis.clone())
 340             }
 341             _ => None,
 342         }
 343     }
 344 }
 345
 346 impl Invocation {
 347     pub fn span(&self) -> Span {
 348         match &self.kind {
 349             InvocationKind::Bang { span, .. } => *span,
 350             InvocationKind::Attr { attr, .. } => attr.span,
 351             InvocationKind::Derive { path, .. } => path.span,
 352         }
 353     }
 354 }
 355
 356 pub struct MacroExpander<'a, 'b> {
 357     pub cx: &'a mut ExtCtxt<'b>,
 358     monotonic: bool, // cf. `cx.monotonic_expander()`
 359 }
 360
 361 impl<'a, 'b> MacroExpander<'a, 'b> {
 362     pub fn new(cx: &'a mut ExtCtxt<'b>, monotonic: bool) -> Self {
 363         MacroExpander { cx, monotonic }
 364     }
 365
 366     pub fn expand_crate(&mut self, krate: ast::Crate) -> ast::Crate {
 367         let file_path = match self.cx.source_map().span_to_filename(krate.span) {
 368             FileName::Real(name) => name
 369                 .into_local_path()
 370                 .expect("attempting to resolve a file path in an external file"),
 371             other => PathBuf::from(other.prefer_local().to_string()),
 372         };
 373         let dir_path = file_path.parent().unwrap_or(&file_path).to_owned();
 374         self.cx.root_path = dir_path.clone();
 375         self.cx.current_expansion.module = Rc::new(ModuleData {
 376             mod_path: vec![Ident::from_str(&self.cx.ecfg.crate_name)],
 377             file_path_stack: vec![file_path],
 378             dir_path,
 379         });
 380         let krate = self.fully_expand_fragment(AstFragment::Crate(krate)).make_crate();
 381         assert_eq!(krate.id, ast::CRATE_NODE_ID);
 382         self.cx.trace_macros_diag();
 383         krate
 384     }
 385
 386     // Recursively expand all macro invocations in this AST fragment.
 387     pub fn fully_expand_fragment(&mut self, input_fragment: AstFragment) -> AstFragment {
 388         let orig_expansion_data = self.cx.current_expansion.clone();
 389         let orig_force_mode = self.cx.force_mode;
 390
 391         // Collect all macro invocations and replace them with placeholders.
 392         let (mut fragment_with_placeholders, mut invocations) =
 393             self.collect_invocations(input_fragment, &[]);
 394
 395         // Optimization: if we resolve all imports now,
 396         // we'll be able to immediately resolve most of imported macros.
 397         self.resolve_imports();
 398
 399         // Resolve paths in all invocations and produce output expanded fragments for them, but
 400         // do not insert them into our input AST fragment yet, only store in `expanded_fragments`.
 401         // The output fragments also go through expansion recursively until no invocations are left.
 402         // Unresolved macros produce dummy outputs as a recovery measure.
 403         invocations.reverse();
 404         let mut expanded_fragments = Vec::new();
 405         let mut undetermined_invocations = Vec::new();
 406         let (mut progress, mut force) = (false, !self.monotonic);
 407         loop {
 408             let Some((invoc, ext)) = invocations.pop() else {
 409                 self.resolve_imports();
 410                 if undetermined_invocations.is_empty() {
 411                     break;
 412                 }
 413                 invocations = mem::take(&mut undetermined_invocations);
 414                 force = !mem::replace(&mut progress, false);
 415                 if force && self.monotonic {
 416                     self.cx.sess.delay_span_bug(
 417                         invocations.last().unwrap().0.span(),
 418                         "expansion entered force mode without producing any errors",
 419                     );
 420                 }
 421                 continue;
 422             };
 423
 424             let ext = match ext {
 425                 Some(ext) => ext,
 426                 None => {
 427                     let eager_expansion_root = if self.monotonic {
 428                         invoc.expansion_data.id
 429                     } else {
 430                         orig_expansion_data.id
 431                     };
 432                     match self.cx.resolver.resolve_macro_invocation(
 433                         &invoc,
 434                         eager_expansion_root,
 435                         force,
 436                     ) {
 437                         Ok(ext) => ext,
 438                         Err(Indeterminate) => {
 439                             // Cannot resolve, will retry this invocation later.
 440                             undetermined_invocations.push((invoc, None));
 441                             continue;
 442                         }
 443                     }
 444                 }
 445             };
 446
 447             let ExpansionData { depth, id: expn_id, .. } = invoc.expansion_data;
 448             let depth = depth - orig_expansion_data.depth;
 449             self.cx.current_expansion = invoc.expansion_data.clone();
 450             self.cx.force_mode = force;
 451
 452             let fragment_kind = invoc.fragment_kind;
 453             let (expanded_fragment, new_invocations) = match self.expand_invoc(invoc, &ext.kind) {
 454                 ExpandResult::Ready(fragment) => {
 455                     let mut derive_invocations = Vec::new();
 456                     let derive_placeholders = self
 457                         .cx
 458                         .resolver
 459                         .take_derive_resolutions(expn_id)
 460                         .map(|derives| {
 461                             derive_invocations.reserve(derives.len());
 462                             derives
 463                                 .into_iter()
 464                                 .map(|(path, item, _exts)| {
 465                                     // FIXME: Consider using the derive resolutions (`_exts`)
 466                                     // instead of enqueuing the derives to be resolved again later.
 467                                     let expn_id = LocalExpnId::fresh_empty();
 468                                     derive_invocations.push((
 469                                         Invocation {
 470                                             kind: InvocationKind::Derive { path, item },
 471                                             fragment_kind,
 472                                             expansion_data: ExpansionData {
 473                                                 id: expn_id,
 474                                                 ..self.cx.current_expansion.clone()
 475                                             },
 476                                         },
 477                                         None,
 478                                     ));
 479                                     NodeId::placeholder_from_expn_id(expn_id)
 480                                 })
 481                                 .collect::<Vec<_>>()
 482                         })
 483                         .unwrap_or_default();
 484
 485                     let (fragment, collected_invocations) =
 486                         self.collect_invocations(fragment, &derive_placeholders);
 487                     // We choose to expand any derive invocations associated with this macro invocation
 488                     // *before* any macro invocations collected from the output fragment
 489                     derive_invocations.extend(collected_invocations);
 490                     (fragment, derive_invocations)
 491                 }
 492                 ExpandResult::Retry(invoc) => {
 493                     if force {
 494                         self.cx.span_bug(
 495                             invoc.span(),
 496                             "expansion entered force mode but is still stuck",
 497                         );
 498                     } else {
 499                         // Cannot expand, will retry this invocation later.
 500                         undetermined_invocations.push((invoc, Some(ext)));
 501                         continue;
 502                     }
 503                 }
 504             };
 505
 506             progress = true;
 507             if expanded_fragments.len() < depth {
 508                 expanded_fragments.push(Vec::new());
 509             }
 510             expanded_fragments[depth - 1].push((expn_id, expanded_fragment));
 511             invocations.extend(new_invocations.into_iter().rev());
 512         }
 513
 514         self.cx.current_expansion = orig_expansion_data;
 515         self.cx.force_mode = orig_force_mode;
 516
 517         // Finally incorporate all the expanded macros into the input AST fragment.
 518         let mut placeholder_expander = PlaceholderExpander::default();
 519         while let Some(expanded_fragments) = expanded_fragments.pop() {
 520             for (expn_id, expanded_fragment) in expanded_fragments.into_iter().rev() {
 521                 placeholder_expander
 522                     .add(NodeId::placeholder_from_expn_id(expn_id), expanded_fragment);
 523             }
 524         }
 525         fragment_with_placeholders.mut_visit_with(&mut placeholder_expander);
 526         fragment_with_placeholders
 527     }
 528
 529     fn resolve_imports(&mut self) {
 530         if self.monotonic {
 531             self.cx.resolver.resolve_imports();
 532         }
 533     }
 534
 535     /// Collects all macro invocations reachable at this time in this AST fragment, and replace
 536     /// them with "placeholders" - dummy macro invocations with specially crafted `NodeId`s.
 537     /// Then call into resolver that builds a skeleton ("reduced graph") of the fragment and
 538     /// prepares data for resolving paths of macro invocations.
 539     fn collect_invocations(
 540         &mut self,
 541         mut fragment: AstFragment,
 542         extra_placeholders: &[NodeId],
 543     ) -> (AstFragment, Vec<(Invocation, Option<Lrc<SyntaxExtension>>)>) {
 544         // Resolve `$crate`s in the fragment for pretty-printing.
 545         self.cx.resolver.resolve_dollar_crates();
 546
 547         let mut invocations = {
 548             let mut collector = InvocationCollector {
 549                 // Non-derive macro invocations cannot see the results of cfg expansion - they
 550                 // will either be removed along with the item, or invoked before the cfg/cfg_attr
 551                 // attribute is expanded. Therefore, we don't need to configure the tokens
 552                 // Derive macros *can* see the results of cfg-expansion - they are handled
 553                 // specially in `fully_expand_fragment`
 554                 cfg: StripUnconfigured {
 555                     sess: &self.cx.sess,
 556                     features: self.cx.ecfg.features,
 557                     config_tokens: false,
 558                 },
 559                 cx: self.cx,
 560                 invocations: Vec::new(),
 561                 monotonic: self.monotonic,
 562             };
 563             fragment.mut_visit_with(&mut collector);
 564             fragment.add_placeholders(extra_placeholders);
 565             collector.invocations
 566         };
 567
 568         if self.monotonic {
 569             self.cx
 570                 .resolver
 571                 .visit_ast_fragment_with_placeholders(self.cx.current_expansion.id, &fragment);
 572
 573             if self.cx.sess.opts.debugging_opts.incremental_relative_spans {
 574                 for (invoc, _) in invocations.iter_mut() {
 575                     let expn_id = invoc.expansion_data.id;
 576                     let parent_def = self.cx.resolver.invocation_parent(expn_id);
 577                     let span = match &mut invoc.kind {
 578                         InvocationKind::Bang { ref mut span, .. } => span,
 579                         InvocationKind::Attr { attr, .. } => &mut attr.span,
 580                         InvocationKind::Derive { path, .. } => &mut path.span,
 581                     };
 582                     *span = span.with_parent(Some(parent_def));
 583                 }
 584             }
 585         }
 586
 587         (fragment, invocations)
 588     }
 589
 590     fn error_recursion_limit_reached(&mut self) {
 591         let expn_data = self.cx.current_expansion.id.expn_data();
 592         let suggested_limit = match self.cx.ecfg.recursion_limit {
 593             Limit(0) => Limit(2),
 594             limit => limit * 2,
 595         };
 596         self.cx
 597             .struct_span_err(
 598                 expn_data.call_site,
 599                 &format!("recursion limit reached while expanding `{}`", expn_data.kind.descr()),
 600             )
 601             .help(&format!(
 602                 "consider increasing the recursion limit by adding a \
 603                  `#![recursion_limit = \"{}\"]` attribute to your crate (`{}`)",
 604                 suggested_limit, self.cx.ecfg.crate_name,
 605             ))
 606             .emit();
 607         self.cx.trace_macros_diag();
 608     }
 609
 610     /// A macro's expansion does not fit in this fragment kind.
 611     /// For example, a non-type macro in a type position.
 612     fn error_wrong_fragment_kind(&mut self, kind: AstFragmentKind, mac: &ast::MacCall, span: Span) {
 613         let msg = format!(
 614             "non-{kind} macro in {kind} position: {path}",
 615             kind = kind.name(),
 616             path = pprust::path_to_string(&mac.path),
 617         );
 618         self.cx.span_err(span, &msg);
 619         self.cx.trace_macros_diag();
 620     }
 621
 622     fn expand_invoc(
 623         &mut self,
 624         invoc: Invocation,
 625         ext: &SyntaxExtensionKind,
 626     ) -> ExpandResult<AstFragment, Invocation> {
 627         let recursion_limit =
 628             self.cx.reduced_recursion_limit.unwrap_or(self.cx.ecfg.recursion_limit);
 629         if !recursion_limit.value_within_limit(self.cx.current_expansion.depth) {
 630             if self.cx.reduced_recursion_limit.is_none() {
 631                 self.error_recursion_limit_reached();
 632             }
 633
 634             // Reduce the recursion limit by half each time it triggers.
 635             self.cx.reduced_recursion_limit = Some(recursion_limit / 2);
 636
 637             return ExpandResult::Ready(invoc.fragment_kind.dummy(invoc.span()));
 638         }
 639
 640         let (fragment_kind, span) = (invoc.fragment_kind, invoc.span());
 641         ExpandResult::Ready(match invoc.kind {
 642             InvocationKind::Bang { mac, .. } => match ext {
 643                 SyntaxExtensionKind::Bang(expander) => {
 644                     let tok_result = match expander.expand(self.cx, span, mac.args.inner_tokens()) {
 645                         Err(_) => return ExpandResult::Ready(fragment_kind.dummy(span)),
 646                         Ok(ts) => ts,
 647                     };
 648                     self.parse_ast_fragment(tok_result, fragment_kind, &mac.path, span)
 649                 }
 650                 SyntaxExtensionKind::LegacyBang(expander) => {
 651                     let prev = self.cx.current_expansion.prior_type_ascription;
 652                     self.cx.current_expansion.prior_type_ascription = mac.prior_type_ascription;
 653                     let tok_result = expander.expand(self.cx, span, mac.args.inner_tokens());
 654                     let result = if let Some(result) = fragment_kind.make_from(tok_result) {
 655                         result
 656                     } else {
 657                         self.error_wrong_fragment_kind(fragment_kind, &mac, span);
 658                         fragment_kind.dummy(span)
 659                     };
 660                     self.cx.current_expansion.prior_type_ascription = prev;
 661                     result
 662                 }
 663                 _ => unreachable!(),
 664             },
 665             InvocationKind::Attr { attr, pos, mut item, derives } => match ext {
 666                 SyntaxExtensionKind::Attr(expander) => {
 667                     self.gate_proc_macro_input(&item);
 668                     self.gate_proc_macro_attr_item(span, &item);
 669                     let tokens = match &item {
 670                         // FIXME: Collect tokens and use them instead of generating
 671                         // fake ones. These are unstable, so it needs to be
 672                         // fixed prior to stabilization
 673                         // Fake tokens when we are invoking an inner attribute, and
 674                         // we are invoking it on an out-of-line module or crate.
 675                         Annotatable::Crate(krate) => rustc_parse::fake_token_stream_for_crate(
 676                             &self.cx.sess.parse_sess,
 677                             krate,
 678                         ),
 679                         Annotatable::Item(item_inner)
 680                             if matches!(attr.style, AttrStyle::Inner)
 681                                 && matches!(
 682                                     item_inner.kind,
 683                                     ItemKind::Mod(
 684                                         _,
 685                                         ModKind::Unloaded | ModKind::Loaded(_, Inline::No, _),
 686                                     )
 687                                 ) =>
 688                         {
 689                             rustc_parse::fake_token_stream(
 690                                 &self.cx.sess.parse_sess,
 691                                 &item.into_nonterminal(),
 692                             )
 693                         }
 694                         _ => item.into_tokens(&self.cx.sess.parse_sess),
 695                     };
 696                     let attr_item = attr.unwrap_normal_item();
 697                     if let MacArgs::Eq(..) = attr_item.args {
 698                         self.cx.span_err(span, "key-value macro attributes are not supported");
 699                     }
 700                     let inner_tokens = attr_item.args.inner_tokens();
 701                     let tok_result = match expander.expand(self.cx, span, inner_tokens, tokens) {
 702                         Err(_) => return ExpandResult::Ready(fragment_kind.dummy(span)),
 703                         Ok(ts) => ts,
 704                     };
 705                     self.parse_ast_fragment(tok_result, fragment_kind, &attr_item.path, span)
 706                 }
 707                 SyntaxExtensionKind::LegacyAttr(expander) => {
 708                     match validate_attr::parse_meta(&self.cx.sess.parse_sess, &attr) {
 709                         Ok(meta) => {
 710                             let items = match expander.expand(self.cx, span, &meta, item) {
 711                                 ExpandResult::Ready(items) => items,
 712                                 ExpandResult::Retry(item) => {
 713                                     // Reassemble the original invocation for retrying.
 714                                     return ExpandResult::Retry(Invocation {
 715                                         kind: InvocationKind::Attr { attr, pos, item, derives },
 716                                         ..invoc
 717                                     });
 718                                 }
 719                             };
 720                             if fragment_kind == AstFragmentKind::Expr && items.is_empty() {
 721                                 let msg =
 722                                     "removing an expression is not supported in this position";
 723                                 self.cx.span_err(span, msg);
 724                                 fragment_kind.dummy(span)
 725                             } else {
 726                                 fragment_kind.expect_from_annotatables(items)
 727                             }
 728                         }
 729                         Err(mut err) => {
 730                             err.emit();
 731                             fragment_kind.dummy(span)
 732                         }
 733                     }
 734                 }
 735                 SyntaxExtensionKind::NonMacroAttr => {
 736                     self.cx.expanded_inert_attrs.mark(&attr);
 737                     item.visit_attrs(|attrs| attrs.insert(pos, attr));
 738                     fragment_kind.expect_from_annotatables(iter::once(item))
 739                 }
 740                 _ => unreachable!(),
 741             },
 742             InvocationKind::Derive { path, item } => match ext {
 743                 SyntaxExtensionKind::Derive(expander)
 744                 | SyntaxExtensionKind::LegacyDerive(expander) => {
 745                     if let SyntaxExtensionKind::Derive(..) = ext {
 746                         self.gate_proc_macro_input(&item);
 747                     }
 748                     let meta = ast::MetaItem { kind: MetaItemKind::Word, span, path };
 749                     let items = match expander.expand(self.cx, span, &meta, item) {
 750                         ExpandResult::Ready(items) => items,
 751                         ExpandResult::Retry(item) => {
 752                             // Reassemble the original invocation for retrying.
 753                             return ExpandResult::Retry(Invocation {
 754                                 kind: InvocationKind::Derive { path: meta.path, item },
 755                                 ..invoc
 756                             });
 757                         }
 758                     };
 759                     fragment_kind.expect_from_annotatables(items)
 760                 }
 761                 _ => unreachable!(),
 762             },
 763         })
 764     }
 765
 766     fn gate_proc_macro_attr_item(&self, span: Span, item: &Annotatable) {
 767         let kind = match item {
 768             Annotatable::Item(_)
 769             | Annotatable::TraitItem(_)
 770             | Annotatable::ImplItem(_)
 771             | Annotatable::ForeignItem(_)
 772             | Annotatable::Crate(..) => return,
 773             Annotatable::Stmt(stmt) => {
 774                 // Attributes are stable on item statements,
 775                 // but unstable on all other kinds of statements
 776                 if stmt.is_item() {
 777                     return;
 778                 }
 779                 "statements"
 780             }
 781             Annotatable::Expr(_) => "expressions",
 782             Annotatable::Arm(..)
 783             | Annotatable::ExprField(..)
 784             | Annotatable::PatField(..)
 785             | Annotatable::GenericParam(..)
 786             | Annotatable::Param(..)
 787             | Annotatable::FieldDef(..)
 788             | Annotatable::Variant(..) => panic!("unexpected annotatable"),
 789         };
 790         if self.cx.ecfg.proc_macro_hygiene() {
 791             return;
 792         }
 793         feature_err(
 794             &self.cx.sess.parse_sess,
 795             sym::proc_macro_hygiene,
 796             span,
 797             &format!("custom attributes cannot be applied to {}", kind),
 798         )
 799         .emit();
 800     }
 801
 802     fn gate_proc_macro_input(&self, annotatable: &Annotatable) {
 803         struct GateProcMacroInput<'a> {
 804             parse_sess: &'a ParseSess,
 805         }
 806
 807         impl<'ast, 'a> Visitor<'ast> for GateProcMacroInput<'a> {
 808             fn visit_item(&mut self, item: &'ast ast::Item) {
 809                 match &item.kind {
 810                     ItemKind::Mod(_, mod_kind)
 811                         if !matches!(mod_kind, ModKind::Loaded(_, Inline::Yes, _)) =>
 812                     {
 813                         feature_err(
 814                             self.parse_sess,
 815                             sym::proc_macro_hygiene,
 816                             item.span,
 817                             "non-inline modules in proc macro input are unstable",
 818                         )
 819                         .emit();
 820                     }
 821                     _ => {}
 822                 }
 823
 824                 visit::walk_item(self, item);
 825             }
 826         }
 827
 828         if !self.cx.ecfg.proc_macro_hygiene() {
 829             annotatable
 830                 .visit_with(&mut GateProcMacroInput { parse_sess: &self.cx.sess.parse_sess });
 831         }
 832     }
 833
 834     fn parse_ast_fragment(
 835         &mut self,
 836         toks: TokenStream,
 837         kind: AstFragmentKind,
 838         path: &ast::Path,
 839         span: Span,
 840     ) -> AstFragment {
 841         let mut parser = self.cx.new_parser_from_tts(toks);
 842         match parse_ast_fragment(&mut parser, kind) {
 843             Ok(fragment) => {
 844                 ensure_complete_parse(&mut parser, path, kind.name(), span);
 845                 fragment
 846             }
 847             Err(mut err) => {
 848                 if err.span.is_dummy() {
 849                     err.set_span(span);
 850                 }
 851                 annotate_err_with_kind(&mut err, kind, span);
 852                 err.emit();
 853                 self.cx.trace_macros_diag();
 854                 kind.dummy(span)
 855             }
 856         }
 857     }
 858 }
 859
 860 pub fn parse_ast_fragment<'a>(
 861     this: &mut Parser<'a>,
 862     kind: AstFragmentKind,
 863 ) -> PResult<'a, AstFragment> {
 864     Ok(match kind {
 865         AstFragmentKind::Items => {
 866             let mut items = SmallVec::new();
 867             while let Some(item) = this.parse_item(ForceCollect::No)? {
 868                 items.push(item);
 869             }
 870             AstFragment::Items(items)
 871         }
 872         AstFragmentKind::TraitItems => {
 873             let mut items = SmallVec::new();
 874             while let Some(item) = this.parse_trait_item(ForceCollect::No)? {
 875                 items.extend(item);
 876             }
 877             AstFragment::TraitItems(items)
 878         }
 879         AstFragmentKind::ImplItems => {
 880             let mut items = SmallVec::new();
 881             while let Some(item) = this.parse_impl_item(ForceCollect::No)? {
 882                 items.extend(item);
 883             }
 884             AstFragment::ImplItems(items)
 885         }
 886         AstFragmentKind::ForeignItems => {
 887             let mut items = SmallVec::new();
 888             while let Some(item) = this.parse_foreign_item(ForceCollect::No)? {
 889                 items.extend(item);
 890             }
 891             AstFragment::ForeignItems(items)
 892         }
 893         AstFragmentKind::Stmts => {
 894             let mut stmts = SmallVec::new();
 895             // Won't make progress on a `}`.
 896             while this.token != token::Eof && this.token != token::CloseDelim(token::Brace) {
 897                 if let Some(stmt) = this.parse_full_stmt(AttemptLocalParseRecovery::Yes)? {
 898                     stmts.push(stmt);
 899                 }
 900             }
 901             AstFragment::Stmts(stmts)
 902         }
 903         AstFragmentKind::Expr => AstFragment::Expr(this.parse_expr()?),
 904         AstFragmentKind::OptExpr => {
 905             if this.token != token::Eof {
 906                 AstFragment::OptExpr(Some(this.parse_expr()?))
 907             } else {
 908                 AstFragment::OptExpr(None)
 909             }
 910         }
 911         AstFragmentKind::Ty => AstFragment::Ty(this.parse_ty()?),
 912         AstFragmentKind::Pat => AstFragment::Pat(this.parse_pat_allow_top_alt(
 913             None,
 914             RecoverComma::No,
 915             RecoverColon::Yes,
 916         )?),
 917         AstFragmentKind::Crate => AstFragment::Crate(this.parse_crate_mod()?),
 918         AstFragmentKind::Arms
 919         | AstFragmentKind::ExprFields
 920         | AstFragmentKind::PatFields
 921         | AstFragmentKind::GenericParams
 922         | AstFragmentKind::Params
 923         | AstFragmentKind::FieldDefs
 924         | AstFragmentKind::Variants => panic!("unexpected AST fragment kind"),
 925     })
 926 }
 927
 928 pub fn ensure_complete_parse<'a>(
 929     this: &mut Parser<'a>,
 930     macro_path: &ast::Path,
 931     kind_name: &str,
 932     span: Span,
 933 ) {
 934     if this.token != token::Eof {
 935         let token = pprust::token_to_string(&this.token);
 936         let msg = format!("macro expansion ignores token `{}` and any following", token);
 937         // Avoid emitting backtrace info twice.
 938         let def_site_span = this.token.span.with_ctxt(SyntaxContext::root());
 939         let mut err = this.struct_span_err(def_site_span, &msg);
 940         err.span_label(span, "caused by the macro expansion here");
 941         let msg = format!(
 942             "the usage of `{}!` is likely invalid in {} context",
 943             pprust::path_to_string(macro_path),
 944             kind_name,
 945         );
 946         err.note(&msg);
 947         let semi_span = this.sess.source_map().next_point(span);
 948
 949         let semi_full_span = semi_span.to(this.sess.source_map().next_point(semi_span));
 950         match this.sess.source_map().span_to_snippet(semi_full_span) {
 951             Ok(ref snippet) if &snippet[..] != ";" && kind_name == "expression" => {
 952                 err.span_suggestion(
 953                     semi_span,
 954                     "you might be missing a semicolon here",
 955                     ";".to_owned(),
 956                     Applicability::MaybeIncorrect,
 957                 );
 958             }
 959             _ => {}
 960         }
 961         err.emit();
 962     }
 963 }
 964
 965 /// Wraps a call to `noop_visit_*` / `noop_flat_map_*`
 966 /// for an AST node that supports attributes
 967 /// (see the `Annotatable` enum)
 968 /// This method assigns a `NodeId`, and sets that `NodeId`
 969 /// as our current 'lint node id'. If a macro call is found
 970 /// inside this AST node, we will use this AST node's `NodeId`
 971 /// to emit lints associated with that macro (allowing
 972 /// `#[allow]` / `#[deny]` to be applied close to
 973 /// the macro invocation).
 974 ///
 975 /// Do *not* call this for a macro AST node
 976 /// (e.g. `ExprKind::MacCall`) - we cannot emit lints
 977 /// at these AST nodes, since they are removed and
 978 /// replaced with the result of macro expansion.
 979 ///
 980 /// All other `NodeId`s are assigned by `visit_id`.
 981 /// * `self` is the 'self' parameter for the current method,
 982 /// * `id` is a mutable reference to the `NodeId` field
 983 ///    of the current AST node.
 984 /// * `closure` is a closure that executes the
 985 ///   `noop_visit_*` / `noop_flat_map_*` method
 986 ///   for the current AST node.
 987 macro_rules! assign_id {
 988     ($self:ident, $id:expr, $closure:expr) => {{
 989         let old_id = $self.cx.current_expansion.lint_node_id;
 990         if $self.monotonic {
 991             debug_assert_eq!(*$id, ast::DUMMY_NODE_ID);
 992             let new_id = $self.cx.resolver.next_node_id();
 993             *$id = new_id;
 994             $self.cx.current_expansion.lint_node_id = new_id;
 995         }
 996         let ret = ($closure)();
 997         $self.cx.current_expansion.lint_node_id = old_id;
 998         ret
 999     }};
1000 }
1001
1002 enum AddSemicolon {
1003     Yes,
1004     No,
1005 }
1006
1007 /// A trait implemented for all `AstFragment` nodes and providing all pieces
1008 /// of functionality used by `InvocationCollector`.
1009 trait InvocationCollectorNode: AstLike {
1010     type OutputTy = SmallVec<[Self; 1]>;
1011     type AttrsTy: Deref<Target = [ast::Attribute]> = Vec<ast::Attribute>;
1012     const KIND: AstFragmentKind;
1013     fn to_annotatable(self) -> Annotatable;
1014     fn fragment_to_output(fragment: AstFragment) -> Self::OutputTy;
1015     fn id(&mut self) -> &mut NodeId;
1016     fn descr() -> &'static str {
1017         unreachable!()
1018     }
1019     fn noop_flat_map<V: MutVisitor>(self, _visitor: &mut V) -> Self::OutputTy {
1020         unreachable!()
1021     }
1022     fn noop_visit<V: MutVisitor>(&mut self, _visitor: &mut V) {
1023         unreachable!()
1024     }
1025     fn is_mac_call(&self) -> bool {
1026         false
1027     }
1028     fn take_mac_call(self) -> (ast::MacCall, Self::AttrsTy, AddSemicolon) {
1029         unreachable!()
1030     }
1031     fn pre_flat_map_node_collect_attr(_cfg: &StripUnconfigured<'_>, _attr: &ast::Attribute) {}
1032     fn post_flat_map_node_collect_bang(_output: &mut Self::OutputTy, _add_semicolon: AddSemicolon) {
1033     }
1034     fn wrap_flat_map_node_noop_flat_map(
1035         node: Self,
1036         collector: &mut InvocationCollector<'_, '_>,
1037         noop_flat_map: impl FnOnce(Self, &mut InvocationCollector<'_, '_>) -> Self::OutputTy,
1038     ) -> Result<Self::OutputTy, Self> {
1039         Ok(noop_flat_map(node, collector))
1040     }
1041 }
1042
1043 impl InvocationCollectorNode for P<ast::Item> {
1044     const KIND: AstFragmentKind = AstFragmentKind::Items;
1045     fn to_annotatable(self) -> Annotatable {
1046         Annotatable::Item(self)
1047     }
1048     fn fragment_to_output(fragment: AstFragment) -> Self::OutputTy {
1049         fragment.make_items()
1050     }
1051     fn id(&mut self) -> &mut NodeId {
1052         &mut self.id
1053     }
1054     fn noop_flat_map<V: MutVisitor>(self, visitor: &mut V) -> Self::OutputTy {
1055         noop_flat_map_item(self, visitor)
1056     }
1057     fn is_mac_call(&self) -> bool {
1058         matches!(self.kind, ItemKind::MacCall(..))
1059     }
1060     fn take_mac_call(self) -> (ast::MacCall, Self::AttrsTy, AddSemicolon) {
1061         let node = self.into_inner();
1062         match node.kind {
1063             ItemKind::MacCall(mac) => (mac, node.attrs, AddSemicolon::No),
1064             _ => unreachable!(),
1065         }
1066     }
1067     fn wrap_flat_map_node_noop_flat_map(
1068         mut node: Self,
1069         collector: &mut InvocationCollector<'_, '_>,
1070         noop_flat_map: impl FnOnce(Self, &mut InvocationCollector<'_, '_>) -> Self::OutputTy,
1071     ) -> Result<Self::OutputTy, Self> {
1072         if !matches!(node.kind, ItemKind::Mod(..)) {
1073             return Ok(noop_flat_map(node, collector));
1074         }
1075
1076         // Work around borrow checker not seeing through `P`'s deref.
1077         let (ident, span, mut attrs) = (node.ident, node.span, mem::take(&mut node.attrs));
1078         let ItemKind::Mod(_, mod_kind) = &mut node.kind else {
1079             unreachable!()
1080         };
1081
1082         let ecx = &mut collector.cx;
1083         let (file_path, dir_path, dir_ownership) = match mod_kind {
1084             ModKind::Loaded(_, inline, _) => {
1085                 // Inline `mod foo { ... }`, but we still need to push directories.
1086                 let (dir_path, dir_ownership) = mod_dir_path(
1087                     &ecx.sess,
1088                     ident,
1089                     &attrs,
1090                     &ecx.current_expansion.module,
1091                     ecx.current_expansion.dir_ownership,
1092                     *inline,
1093                 );
1094                 node.attrs = attrs;
1095                 (None, dir_path, dir_ownership)
1096             }
1097             ModKind::Unloaded => {
1098                 // We have an outline `mod foo;` so we need to parse the file.
1099                 let old_attrs_len = attrs.len();
1100                 let ParsedExternalMod { items, inner_span, file_path, dir_path, dir_ownership } =
1101                     parse_external_mod(
1102                         &ecx.sess,
1103                         ident,
1104                         span,
1105                         &ecx.current_expansion.module,
1106                         ecx.current_expansion.dir_ownership,
1107                         &mut attrs,
1108                     );
1109
1110                 if let Some(lint_store) = ecx.lint_store {
1111                     lint_store.pre_expansion_lint(
1112                         ecx.sess,
1113                         ecx.resolver.registered_tools(),
1114                         ecx.current_expansion.lint_node_id,
1115                         &attrs,
1116                         &items,
1117                         ident.name.as_str(),
1118                     );
1119                 }
1120
1121                 *mod_kind = ModKind::Loaded(items, Inline::No, inner_span);
1122                 node.attrs = attrs;
1123                 if node.attrs.len() > old_attrs_len {
1124                     // If we loaded an out-of-line module and added some inner attributes,
1125                     // then we need to re-configure it and re-collect attributes for
1126                     // resolution and expansion.
1127                     return Err(node);
1128                 }
1129                 (Some(file_path), dir_path, dir_ownership)
1130             }
1131         };
1132
1133         // Set the module info before we flat map.
1134         let mut module = ecx.current_expansion.module.with_dir_path(dir_path);
1135         module.mod_path.push(ident);
1136         if let Some(file_path) = file_path {
1137             module.file_path_stack.push(file_path);
1138         }
1139
1140         let orig_module = mem::replace(&mut ecx.current_expansion.module, Rc::new(module));
1141         let orig_dir_ownership =
1142             mem::replace(&mut ecx.current_expansion.dir_ownership, dir_ownership);
1143
1144         let res = Ok(noop_flat_map(node, collector));
1145
1146         collector.cx.current_expansion.dir_ownership = orig_dir_ownership;
1147         collector.cx.current_expansion.module = orig_module;
1148         res
1149     }
1150 }
1151
1152 struct TraitItemTag;
1153 impl InvocationCollectorNode for AstLikeWrapper<P<ast::AssocItem>, TraitItemTag> {
1154     type OutputTy = SmallVec<[P<ast::AssocItem>; 1]>;
1155     const KIND: AstFragmentKind = AstFragmentKind::TraitItems;
1156     fn to_annotatable(self) -> Annotatable {
1157         Annotatable::TraitItem(self.wrapped)
1158     }
1159     fn fragment_to_output(fragment: AstFragment) -> Self::OutputTy {
1160         fragment.make_trait_items()
1161     }
1162     fn id(&mut self) -> &mut NodeId {
1163         &mut self.wrapped.id
1164     }
1165     fn noop_flat_map<V: MutVisitor>(self, visitor: &mut V) -> Self::OutputTy {
1166         noop_flat_map_assoc_item(self.wrapped, visitor)
1167     }
1168     fn is_mac_call(&self) -> bool {
1169         matches!(self.wrapped.kind, AssocItemKind::MacCall(..))
1170     }
1171     fn take_mac_call(self) -> (ast::MacCall, Self::AttrsTy, AddSemicolon) {
1172         let item = self.wrapped.into_inner();
1173         match item.kind {
1174             AssocItemKind::MacCall(mac) => (mac, item.attrs, AddSemicolon::No),
1175             _ => unreachable!(),
1176         }
1177     }
1178 }
1179
1180 struct ImplItemTag;
1181 impl InvocationCollectorNode for AstLikeWrapper<P<ast::AssocItem>, ImplItemTag> {
1182     type OutputTy = SmallVec<[P<ast::AssocItem>; 1]>;
1183     const KIND: AstFragmentKind = AstFragmentKind::ImplItems;
1184     fn to_annotatable(self) -> Annotatable {
1185         Annotatable::ImplItem(self.wrapped)
1186     }
1187     fn fragment_to_output(fragment: AstFragment) -> Self::OutputTy {
1188         fragment.make_impl_items()
1189     }
1190     fn id(&mut self) -> &mut NodeId {
1191         &mut self.wrapped.id
1192     }
1193     fn noop_flat_map<V: MutVisitor>(self, visitor: &mut V) -> Self::OutputTy {
1194         noop_flat_map_assoc_item(self.wrapped, visitor)
1195     }
1196     fn is_mac_call(&self) -> bool {
1197         matches!(self.wrapped.kind, AssocItemKind::MacCall(..))
1198     }
1199     fn take_mac_call(self) -> (ast::MacCall, Self::AttrsTy, AddSemicolon) {
1200         let item = self.wrapped.into_inner();
1201         match item.kind {
1202             AssocItemKind::MacCall(mac) => (mac, item.attrs, AddSemicolon::No),
1203             _ => unreachable!(),
1204         }
1205     }
1206 }
1207
1208 impl InvocationCollectorNode for P<ast::ForeignItem> {
1209     const KIND: AstFragmentKind = AstFragmentKind::ForeignItems;
1210     fn to_annotatable(self) -> Annotatable {
1211         Annotatable::ForeignItem(self)
1212     }
1213     fn fragment_to_output(fragment: AstFragment) -> Self::OutputTy {
1214         fragment.make_foreign_items()
1215     }
1216     fn id(&mut self) -> &mut NodeId {
1217         &mut self.id
1218     }
1219     fn noop_flat_map<V: MutVisitor>(self, visitor: &mut V) -> Self::OutputTy {
1220         noop_flat_map_foreign_item(self, visitor)
1221     }
1222     fn is_mac_call(&self) -> bool {
1223         matches!(self.kind, ForeignItemKind::MacCall(..))
1224     }
1225     fn take_mac_call(self) -> (ast::MacCall, Self::AttrsTy, AddSemicolon) {
1226         let node = self.into_inner();
1227         match node.kind {
1228             ForeignItemKind::MacCall(mac) => (mac, node.attrs, AddSemicolon::No),
1229             _ => unreachable!(),
1230         }
1231     }
1232 }
1233
1234 impl InvocationCollectorNode for ast::Variant {
1235     const KIND: AstFragmentKind = AstFragmentKind::Variants;
1236     fn to_annotatable(self) -> Annotatable {
1237         Annotatable::Variant(self)
1238     }
1239     fn fragment_to_output(fragment: AstFragment) -> Self::OutputTy {
1240         fragment.make_variants()
1241     }
1242     fn id(&mut self) -> &mut NodeId {
1243         &mut self.id
1244     }
1245     fn noop_flat_map<V: MutVisitor>(self, visitor: &mut V) -> Self::OutputTy {
1246         noop_flat_map_variant(self, visitor)
1247     }
1248 }
1249
1250 impl InvocationCollectorNode for ast::FieldDef {
1251     const KIND: AstFragmentKind = AstFragmentKind::FieldDefs;
1252     fn to_annotatable(self) -> Annotatable {
1253         Annotatable::FieldDef(self)
1254     }
1255     fn fragment_to_output(fragment: AstFragment) -> Self::OutputTy {
1256         fragment.make_field_defs()
1257     }
1258     fn id(&mut self) -> &mut NodeId {
1259         &mut self.id
1260     }
1261     fn noop_flat_map<V: MutVisitor>(self, visitor: &mut V) -> Self::OutputTy {
1262         noop_flat_map_field_def(self, visitor)
1263     }
1264 }
1265
1266 impl InvocationCollectorNode for ast::PatField {
1267     const KIND: AstFragmentKind = AstFragmentKind::PatFields;
1268     fn to_annotatable(self) -> Annotatable {
1269         Annotatable::PatField(self)
1270     }
1271     fn fragment_to_output(fragment: AstFragment) -> Self::OutputTy {
1272         fragment.make_pat_fields()
1273     }
1274     fn id(&mut self) -> &mut NodeId {
1275         &mut self.id
1276     }
1277     fn noop_flat_map<V: MutVisitor>(self, visitor: &mut V) -> Self::OutputTy {
1278         noop_flat_map_pat_field(self, visitor)
1279     }
1280 }
1281
1282 impl InvocationCollectorNode for ast::ExprField {
1283     const KIND: AstFragmentKind = AstFragmentKind::ExprFields;
1284     fn to_annotatable(self) -> Annotatable {
1285         Annotatable::ExprField(self)
1286     }
1287     fn fragment_to_output(fragment: AstFragment) -> Self::OutputTy {
1288         fragment.make_expr_fields()
1289     }
1290     fn id(&mut self) -> &mut NodeId {
1291         &mut self.id
1292     }
1293     fn noop_flat_map<V: MutVisitor>(self, visitor: &mut V) -> Self::OutputTy {
1294         noop_flat_map_expr_field(self, visitor)
1295     }
1296 }
1297
1298 impl InvocationCollectorNode for ast::Param {
1299     const KIND: AstFragmentKind = AstFragmentKind::Params;
1300     fn to_annotatable(self) -> Annotatable {
1301         Annotatable::Param(self)
1302     }
1303     fn fragment_to_output(fragment: AstFragment) -> Self::OutputTy {
1304         fragment.make_params()
1305     }
1306     fn id(&mut self) -> &mut NodeId {
1307         &mut self.id
1308     }
1309     fn noop_flat_map<V: MutVisitor>(self, visitor: &mut V) -> Self::OutputTy {
1310         noop_flat_map_param(self, visitor)
1311     }
1312 }
1313
1314 impl InvocationCollectorNode for ast::GenericParam {
1315     const KIND: AstFragmentKind = AstFragmentKind::GenericParams;
1316     fn to_annotatable(self) -> Annotatable {
1317         Annotatable::GenericParam(self)
1318     }
1319     fn fragment_to_output(fragment: AstFragment) -> Self::OutputTy {
1320         fragment.make_generic_params()
1321     }
1322     fn id(&mut self) -> &mut NodeId {
1323         &mut self.id
1324     }
1325     fn noop_flat_map<V: MutVisitor>(self, visitor: &mut V) -> Self::OutputTy {
1326         noop_flat_map_generic_param(self, visitor)
1327     }
1328 }
1329
1330 impl InvocationCollectorNode for ast::Arm {
1331     const KIND: AstFragmentKind = AstFragmentKind::Arms;
1332     fn to_annotatable(self) -> Annotatable {
1333         Annotatable::Arm(self)
1334     }
1335     fn fragment_to_output(fragment: AstFragment) -> Self::OutputTy {
1336         fragment.make_arms()
1337     }
1338     fn id(&mut self) -> &mut NodeId {
1339         &mut self.id
1340     }
1341     fn noop_flat_map<V: MutVisitor>(self, visitor: &mut V) -> Self::OutputTy {
1342         noop_flat_map_arm(self, visitor)
1343     }
1344 }
1345
1346 impl InvocationCollectorNode for ast::Stmt {
1347     type AttrsTy = ast::AttrVec;
1348     const KIND: AstFragmentKind = AstFragmentKind::Stmts;
1349     fn to_annotatable(self) -> Annotatable {
1350         Annotatable::Stmt(P(self))
1351     }
1352     fn fragment_to_output(fragment: AstFragment) -> Self::OutputTy {
1353         fragment.make_stmts()
1354     }
1355     fn id(&mut self) -> &mut NodeId {
1356         &mut self.id
1357     }
1358     fn noop_flat_map<V: MutVisitor>(self, visitor: &mut V) -> Self::OutputTy {
1359         noop_flat_map_stmt(self, visitor)
1360     }
1361     fn is_mac_call(&self) -> bool {
1362         match &self.kind {
1363             StmtKind::MacCall(..) => true,
1364             StmtKind::Item(item) => matches!(item.kind, ItemKind::MacCall(..)),
1365             StmtKind::Semi(expr) => matches!(expr.kind, ExprKind::MacCall(..)),
1366             StmtKind::Expr(..) => unreachable!(),
1367             StmtKind::Local(..) | StmtKind::Empty => false,
1368         }
1369     }
1370     fn take_mac_call(self) -> (ast::MacCall, Self::AttrsTy, AddSemicolon) {
1371         // We pull macro invocations (both attributes and fn-like macro calls) out of their
1372         // `StmtKind`s and treat them as statement macro invocations, not as items or expressions.
1373         let (add_semicolon, mac, attrs) = match self.kind {
1374             StmtKind::MacCall(mac) => {
1375                 let ast::MacCallStmt { mac, style, attrs, .. } = mac.into_inner();
1376                 (style == MacStmtStyle::Semicolon, mac, attrs)
1377             }
1378             StmtKind::Item(item) => match item.into_inner() {
1379                 ast::Item { kind: ItemKind::MacCall(mac), attrs, .. } => {
1380                     (mac.args.need_semicolon(), mac, attrs.into())
1381                 }
1382                 _ => unreachable!(),
1383             },
1384             StmtKind::Semi(expr) => match expr.into_inner() {
1385                 ast::Expr { kind: ExprKind::MacCall(mac), attrs, .. } => {
1386                     (mac.args.need_semicolon(), mac, attrs)
1387                 }
1388                 _ => unreachable!(),
1389             },
1390             _ => unreachable!(),
1391         };
1392         (mac, attrs, if add_semicolon { AddSemicolon::Yes } else { AddSemicolon::No })
1393     }
1394     fn post_flat_map_node_collect_bang(stmts: &mut Self::OutputTy, add_semicolon: AddSemicolon) {
1395         // If this is a macro invocation with a semicolon, then apply that
1396         // semicolon to the final statement produced by expansion.
1397         if matches!(add_semicolon, AddSemicolon::Yes) {
1398             if let Some(stmt) = stmts.pop() {
1399                 stmts.push(stmt.add_trailing_semicolon());
1400             }
1401         }
1402     }
1403 }
1404
1405 impl InvocationCollectorNode for ast::Crate {
1406     type OutputTy = ast::Crate;
1407     const KIND: AstFragmentKind = AstFragmentKind::Crate;
1408     fn to_annotatable(self) -> Annotatable {
1409         Annotatable::Crate(self)
1410     }
1411     fn fragment_to_output(fragment: AstFragment) -> Self::OutputTy {
1412         fragment.make_crate()
1413     }
1414     fn id(&mut self) -> &mut NodeId {
1415         &mut self.id
1416     }
1417     fn noop_visit<V: MutVisitor>(&mut self, visitor: &mut V) {
1418         noop_visit_crate(self, visitor)
1419     }
1420 }
1421
1422 impl InvocationCollectorNode for P<ast::Ty> {
1423     type OutputTy = P<ast::Ty>;
1424     const KIND: AstFragmentKind = AstFragmentKind::Ty;
1425     fn to_annotatable(self) -> Annotatable {
1426         unreachable!()
1427     }
1428     fn fragment_to_output(fragment: AstFragment) -> Self::OutputTy {
1429         fragment.make_ty()
1430     }
1431     fn id(&mut self) -> &mut NodeId {
1432         &mut self.id
1433     }
1434     fn noop_visit<V: MutVisitor>(&mut self, visitor: &mut V) {
1435         noop_visit_ty(self, visitor)
1436     }
1437     fn is_mac_call(&self) -> bool {
1438         matches!(self.kind, ast::TyKind::MacCall(..))
1439     }
1440     fn take_mac_call(self) -> (ast::MacCall, Self::AttrsTy, AddSemicolon) {
1441         let node = self.into_inner();
1442         match node.kind {
1443             TyKind::MacCall(mac) => (mac, Vec::new(), AddSemicolon::No),
1444             _ => unreachable!(),
1445         }
1446     }
1447 }
1448
1449 impl InvocationCollectorNode for P<ast::Pat> {
1450     type OutputTy = P<ast::Pat>;
1451     const KIND: AstFragmentKind = AstFragmentKind::Pat;
1452     fn to_annotatable(self) -> Annotatable {
1453         unreachable!()
1454     }
1455     fn fragment_to_output(fragment: AstFragment) -> Self::OutputTy {
1456         fragment.make_pat()
1457     }
1458     fn id(&mut self) -> &mut NodeId {
1459         &mut self.id
1460     }
1461     fn noop_visit<V: MutVisitor>(&mut self, visitor: &mut V) {
1462         noop_visit_pat(self, visitor)
1463     }
1464     fn is_mac_call(&self) -> bool {
1465         matches!(self.kind, PatKind::MacCall(..))
1466     }
1467     fn take_mac_call(self) -> (ast::MacCall, Self::AttrsTy, AddSemicolon) {
1468         let node = self.into_inner();
1469         match node.kind {
1470             PatKind::MacCall(mac) => (mac, Vec::new(), AddSemicolon::No),
1471             _ => unreachable!(),
1472         }
1473     }
1474 }
1475
1476 impl InvocationCollectorNode for P<ast::Expr> {
1477     type OutputTy = P<ast::Expr>;
1478     type AttrsTy = ast::AttrVec;
1479     const KIND: AstFragmentKind = AstFragmentKind::Expr;
1480     fn to_annotatable(self) -> Annotatable {
1481         Annotatable::Expr(self)
1482     }
1483     fn fragment_to_output(fragment: AstFragment) -> Self::OutputTy {
1484         fragment.make_expr()
1485     }
1486     fn id(&mut self) -> &mut NodeId {
1487         &mut self.id
1488     }
1489     fn descr() -> &'static str {
1490         "an expression"
1491     }
1492     fn noop_visit<V: MutVisitor>(&mut self, visitor: &mut V) {
1493         noop_visit_expr(self, visitor)
1494     }
1495     fn is_mac_call(&self) -> bool {
1496         matches!(self.kind, ExprKind::MacCall(..))
1497     }
1498     fn take_mac_call(self) -> (ast::MacCall, Self::AttrsTy, AddSemicolon) {
1499         let node = self.into_inner();
1500         match node.kind {
1501             ExprKind::MacCall(mac) => (mac, node.attrs, AddSemicolon::No),
1502             _ => unreachable!(),
1503         }
1504     }
1505 }
1506
1507 struct OptExprTag;
1508 impl InvocationCollectorNode for AstLikeWrapper<P<ast::Expr>, OptExprTag> {
1509     type OutputTy = Option<P<ast::Expr>>;
1510     type AttrsTy = ast::AttrVec;
1511     const KIND: AstFragmentKind = AstFragmentKind::OptExpr;
1512     fn to_annotatable(self) -> Annotatable {
1513         Annotatable::Expr(self.wrapped)
1514     }
1515     fn fragment_to_output(fragment: AstFragment) -> Self::OutputTy {
1516         fragment.make_opt_expr()
1517     }
1518     fn id(&mut self) -> &mut NodeId {
1519         &mut self.wrapped.id
1520     }
1521     fn noop_flat_map<V: MutVisitor>(mut self, visitor: &mut V) -> Self::OutputTy {
1522         noop_visit_expr(&mut self.wrapped, visitor);
1523         Some(self.wrapped)
1524     }
1525     fn is_mac_call(&self) -> bool {
1526         matches!(self.wrapped.kind, ast::ExprKind::MacCall(..))
1527     }
1528     fn take_mac_call(self) -> (ast::MacCall, Self::AttrsTy, AddSemicolon) {
1529         let node = self.wrapped.into_inner();
1530         match node.kind {
1531             ExprKind::MacCall(mac) => (mac, node.attrs, AddSemicolon::No),
1532             _ => unreachable!(),
1533         }
1534     }
1535     fn pre_flat_map_node_collect_attr(cfg: &StripUnconfigured<'_>, attr: &ast::Attribute) {
1536         cfg.maybe_emit_expr_attr_err(&attr);
1537     }
1538 }
1539
1540 struct InvocationCollector<'a, 'b> {
1541     cx: &'a mut ExtCtxt<'b>,
1542     cfg: StripUnconfigured<'a>,
1543     invocations: Vec<(Invocation, Option<Lrc<SyntaxExtension>>)>,
1544     monotonic: bool,
1545 }
1546
1547 impl<'a, 'b> InvocationCollector<'a, 'b> {
1548     fn collect(&mut self, fragment_kind: AstFragmentKind, kind: InvocationKind) -> AstFragment {
1549         let expn_id = LocalExpnId::fresh_empty();
1550         let vis = kind.placeholder_visibility();
1551         self.invocations.push((
1552             Invocation {
1553                 kind,
1554                 fragment_kind,
1555                 expansion_data: ExpansionData {
1556                     id: expn_id,
1557                     depth: self.cx.current_expansion.depth + 1,
1558                     ..self.cx.current_expansion.clone()
1559                 },
1560             },
1561             None,
1562         ));
1563         placeholder(fragment_kind, NodeId::placeholder_from_expn_id(expn_id), vis)
1564     }
1565
1566     fn collect_bang(&mut self, mac: ast::MacCall, kind: AstFragmentKind) -> AstFragment {
1567         // cache the macro call span so that it can be
1568         // easily adjusted for incremental compilation
1569         let span = mac.span();
1570         self.collect(kind, InvocationKind::Bang { mac, span })
1571     }
1572
1573     fn collect_attr(
1574         &mut self,
1575         (attr, pos, derives): (ast::Attribute, usize, Vec<ast::Path>),
1576         item: Annotatable,
1577         kind: AstFragmentKind,
1578     ) -> AstFragment {
1579         self.collect(kind, InvocationKind::Attr { attr, pos, item, derives })
1580     }
1581
1582     /// If `item` is an attribute invocation, remove the attribute and return it together with
1583     /// its position and derives following it. We have to collect the derives in order to resolve
1584     /// legacy derive helpers (helpers written before derives that introduce them).
1585     fn take_first_attr(
1586         &self,
1587         item: &mut impl AstLike,
1588     ) -> Option<(ast::Attribute, usize, Vec<ast::Path>)> {
1589         let mut attr = None;
1590
1591         let mut cfg_pos = None;
1592         let mut attr_pos = None;
1593         for (pos, attr) in item.attrs().iter().enumerate() {
1594             if !attr.is_doc_comment() && !self.cx.expanded_inert_attrs.is_marked(attr) {
1595                 let name = attr.ident().map(|ident| ident.name);
1596                 if name == Some(sym::cfg) || name == Some(sym::cfg_attr) {
1597                     cfg_pos = Some(pos); // a cfg attr found, no need to search anymore
1598                     break;
1599                 } else if attr_pos.is_none()
1600                     && !name.map_or(false, rustc_feature::is_builtin_attr_name)
1601                 {
1602                     attr_pos = Some(pos); // a non-cfg attr found, still may find a cfg attr
1603                 }
1604             }
1605         }
1606
1607         item.visit_attrs(|attrs| {
1608             attr = Some(match (cfg_pos, attr_pos) {
1609                 (Some(pos), _) => (attrs.remove(pos), pos, Vec::new()),
1610                 (_, Some(pos)) => {
1611                     let attr = attrs.remove(pos);
1612                     let following_derives = attrs[pos..]
1613                         .iter()
1614                         .filter(|a| a.has_name(sym::derive))
1615                         .flat_map(|a| a.meta_item_list().unwrap_or_default())
1616                         .filter_map(|nested_meta| match nested_meta {
1617                             NestedMetaItem::MetaItem(ast::MetaItem {
1618                                 kind: MetaItemKind::Word,
1619                                 path,
1620                                 ..
1621                             }) => Some(path),
1622                             _ => None,
1623                         })
1624                         .collect();
1625
1626                     (attr, pos, following_derives)
1627                 }
1628                 _ => return,
1629             });
1630         });
1631
1632         attr
1633     }
1634
1635     // Detect use of feature-gated or invalid attributes on macro invocations
1636     // since they will not be detected after macro expansion.
1637     fn check_attributes(&self, attrs: &[ast::Attribute], call: &ast::MacCall) {
1638         let features = self.cx.ecfg.features.unwrap();
1639         let mut attrs = attrs.iter().peekable();
1640         let mut span: Option<Span> = None;
1641         while let Some(attr) = attrs.next() {
1642             rustc_ast_passes::feature_gate::check_attribute(attr, self.cx.sess, features);
1643             validate_attr::check_meta(&self.cx.sess.parse_sess, attr);
1644
1645             let current_span = if let Some(sp) = span { sp.to(attr.span) } else { attr.span };
1646             span = Some(current_span);
1647
1648             if attrs.peek().map_or(false, |next_attr| next_attr.doc_str().is_some()) {
1649                 continue;
1650             }
1651
1652             if attr.is_doc_comment() {
1653                 self.cx.sess.parse_sess.buffer_lint_with_diagnostic(
1654                     &UNUSED_DOC_COMMENTS,
1655                     current_span,
1656                     self.cx.current_expansion.lint_node_id,
1657                     "unused doc comment",
1658                     BuiltinLintDiagnostics::UnusedDocComment(attr.span),
1659                 );
1660             } else if rustc_attr::is_builtin_attr(attr) {
1661                 let attr_name = attr.ident().unwrap().name;
1662                 // `#[cfg]` and `#[cfg_attr]` are special - they are
1663                 // eagerly evaluated.
1664                 if attr_name != sym::cfg && attr_name != sym::cfg_attr {
1665                     self.cx.sess.parse_sess.buffer_lint_with_diagnostic(
1666                         &UNUSED_ATTRIBUTES,
1667                         attr.span,
1668                         self.cx.current_expansion.lint_node_id,
1669                         &format!("unused attribute `{}`", attr_name),
1670                         BuiltinLintDiagnostics::UnusedBuiltinAttribute {
1671                             attr_name,
1672                             macro_name: pprust::path_to_string(&call.path),
1673                             invoc_span: call.path.span,
1674                         },
1675                     );
1676                 }
1677             }
1678         }
1679     }
1680
1681     fn expand_cfg_true(
1682         &mut self,
1683         node: &mut impl AstLike,
1684         attr: ast::Attribute,
1685         pos: usize,
1686     ) -> bool {
1687         let res = self.cfg.cfg_true(&attr);
1688         if res {
1689             // FIXME: `cfg(TRUE)` attributes do not currently remove themselves during expansion,
1690             // and some tools like rustdoc and clippy rely on that. Find a way to remove them
1691             // while keeping the tools working.
1692             self.cx.expanded_inert_attrs.mark(&attr);
1693             node.visit_attrs(|attrs| attrs.insert(pos, attr));
1694         }
1695         res
1696     }
1697
1698     fn expand_cfg_attr(&self, node: &mut impl AstLike, attr: ast::Attribute, pos: usize) {
1699         node.visit_attrs(|attrs| {
1700             attrs.splice(pos..pos, self.cfg.expand_cfg_attr(attr, false));
1701         });
1702     }
1703
1704     fn flat_map_node<Node: InvocationCollectorNode<OutputTy: Default>>(
1705         &mut self,
1706         mut node: Node,
1707     ) -> Node::OutputTy {
1708         loop {
1709             return match self.take_first_attr(&mut node) {
1710                 Some((attr, pos, derives)) => match attr.name_or_empty() {
1711                     sym::cfg => {
1712                         if self.expand_cfg_true(&mut node, attr, pos) {
1713                             continue;
1714                         }
1715                         Default::default()
1716                     }
1717                     sym::cfg_attr => {
1718                         self.expand_cfg_attr(&mut node, attr, pos);
1719                         continue;
1720                     }
1721                     _ => {
1722                         Node::pre_flat_map_node_collect_attr(&self.cfg, &attr);
1723                         self.collect_attr((attr, pos, derives), node.to_annotatable(), Node::KIND)
1724                             .make_ast::<Node>()
1725                     }
1726                 },
1727                 None if node.is_mac_call() => {
1728                     let (mac, attrs, add_semicolon) = node.take_mac_call();
1729                     self.check_attributes(&attrs, &mac);
1730                     let mut res = self.collect_bang(mac, Node::KIND).make_ast::<Node>();
1731                     Node::post_flat_map_node_collect_bang(&mut res, add_semicolon);
1732                     res
1733                 }
1734                 None => {
1735                     match Node::wrap_flat_map_node_noop_flat_map(node, self, |mut node, this| {
1736                         assign_id!(this, node.id(), || node.noop_flat_map(this))
1737                     }) {
1738                         Ok(output) => output,
1739                         Err(returned_node) => {
1740                             node = returned_node;
1741                             continue;
1742                         }
1743                     }
1744                 }
1745             };
1746         }
1747     }
1748
1749     fn visit_node<Node: InvocationCollectorNode<OutputTy = Node> + DummyAstNode>(
1750         &mut self,
1751         node: &mut Node,
1752     ) {
1753         loop {
1754             return match self.take_first_attr(node) {
1755                 Some((attr, pos, derives)) => match attr.name_or_empty() {
1756                     sym::cfg => {
1757                         let span = attr.span;
1758                         if self.expand_cfg_true(node, attr, pos) {
1759                             continue;
1760                         }
1761                         let msg =
1762                             format!("removing {} is not supported in this position", Node::descr());
1763                         self.cx.span_err(span, &msg);
1764                         continue;
1765                     }
1766                     sym::cfg_attr => {
1767                         self.expand_cfg_attr(node, attr, pos);
1768                         continue;
1769                     }
1770                     _ => visit_clobber(node, |node| {
1771                         self.collect_attr((attr, pos, derives), node.to_annotatable(), Node::KIND)
1772                             .make_ast::<Node>()
1773                     }),
1774                 },
1775                 None if node.is_mac_call() => {
1776                     visit_clobber(node, |node| {
1777                         // Do not clobber unless it's actually a macro (uncommon case).
1778                         let (mac, attrs, _) = node.take_mac_call();
1779                         self.check_attributes(&attrs, &mac);
1780                         self.collect_bang(mac, Node::KIND).make_ast::<Node>()
1781                     })
1782                 }
1783                 None => {
1784                     assign_id!(self, node.id(), || node.noop_visit(self))
1785                 }
1786             };
1787         }
1788     }
1789 }
1790
1791 impl<'a, 'b> MutVisitor for InvocationCollector<'a, 'b> {
1792     fn flat_map_item(&mut self, node: P<ast::Item>) -> SmallVec<[P<ast::Item>; 1]> {
1793         self.flat_map_node(node)
1794     }
1795
1796     fn flat_map_trait_item(&mut self, node: P<ast::AssocItem>) -> SmallVec<[P<ast::AssocItem>; 1]> {
1797         self.flat_map_node(AstLikeWrapper::new(node, TraitItemTag))
1798     }
1799
1800     fn flat_map_impl_item(&mut self, node: P<ast::AssocItem>) -> SmallVec<[P<ast::AssocItem>; 1]> {
1801         self.flat_map_node(AstLikeWrapper::new(node, ImplItemTag))
1802     }
1803
1804     fn flat_map_foreign_item(
1805         &mut self,
1806         node: P<ast::ForeignItem>,
1807     ) -> SmallVec<[P<ast::ForeignItem>; 1]> {
1808         self.flat_map_node(node)
1809     }
1810
1811     fn flat_map_variant(&mut self, node: ast::Variant) -> SmallVec<[ast::Variant; 1]> {
1812         self.flat_map_node(node)
1813     }
1814
1815     fn flat_map_field_def(&mut self, node: ast::FieldDef) -> SmallVec<[ast::FieldDef; 1]> {
1816         self.flat_map_node(node)
1817     }
1818
1819     fn flat_map_pat_field(&mut self, node: ast::PatField) -> SmallVec<[ast::PatField; 1]> {
1820         self.flat_map_node(node)
1821     }
1822
1823     fn flat_map_expr_field(&mut self, node: ast::ExprField) -> SmallVec<[ast::ExprField; 1]> {
1824         self.flat_map_node(node)
1825     }
1826
1827     fn flat_map_param(&mut self, node: ast::Param) -> SmallVec<[ast::Param; 1]> {
1828         self.flat_map_node(node)
1829     }
1830
1831     fn flat_map_generic_param(
1832         &mut self,
1833         node: ast::GenericParam,
1834     ) -> SmallVec<[ast::GenericParam; 1]> {
1835         self.flat_map_node(node)
1836     }
1837
1838     fn flat_map_arm(&mut self, node: ast::Arm) -> SmallVec<[ast::Arm; 1]> {
1839         self.flat_map_node(node)
1840     }
1841
1842     fn flat_map_stmt(&mut self, mut node: ast::Stmt) -> SmallVec<[ast::Stmt; 1]> {
1843         // FIXME: invocations in semicolon-less expressions positions are expanded as expressions,
1844         // changing that requires some compatibility measures.
1845         if node.is_expr() {
1846             // The only way that we can end up with a `MacCall` expression statement,
1847             // (as opposed to a `StmtKind::MacCall`) is if we have a macro as the
1848             // traiing expression in a block (e.g. `fn foo() { my_macro!() }`).
1849             // Record this information, so that we can report a more specific
1850             // `SEMICOLON_IN_EXPRESSIONS_FROM_MACROS` lint if needed.
1851             // See #78991 for an investigation of treating macros in this position
1852             // as statements, rather than expressions, during parsing.
1853             return match &node.kind {
1854                 StmtKind::Expr(expr)
1855                     if matches!(**expr, ast::Expr { kind: ExprKind::MacCall(..), .. }) =>
1856                 {
1857                     self.cx.current_expansion.is_trailing_mac = true;
1858                     // Don't use `assign_id` for this statement - it may get removed
1859                     // entirely due to a `#[cfg]` on the contained expression
1860                     let res = noop_flat_map_stmt(node, self);
1861                     self.cx.current_expansion.is_trailing_mac = false;
1862                     res
1863                 }
1864                 _ => assign_id!(self, &mut node.id, || noop_flat_map_stmt(node, self)),
1865             };
1866         }
1867
1868         self.flat_map_node(node)
1869     }
1870
1871     fn visit_crate(&mut self, node: &mut ast::Crate) {
1872         self.visit_node(node)
1873     }
1874
1875     fn visit_ty(&mut self, node: &mut P<ast::Ty>) {
1876         self.visit_node(node)
1877     }
1878
1879     fn visit_pat(&mut self, node: &mut P<ast::Pat>) {
1880         self.visit_node(node)
1881     }
1882
1883     fn visit_expr(&mut self, node: &mut P<ast::Expr>) {
1884         // FIXME: Feature gating is performed inconsistently between `Expr` and `OptExpr`.
1885         if let Some(attr) = node.attrs.first() {
1886             self.cfg.maybe_emit_expr_attr_err(attr);
1887         }
1888         self.visit_node(node)
1889     }
1890
1891     fn filter_map_expr(&mut self, node: P<ast::Expr>) -> Option<P<ast::Expr>> {
1892         self.flat_map_node(AstLikeWrapper::new(node, OptExprTag))
1893     }
1894
1895     fn visit_block(&mut self, node: &mut P<ast::Block>) {
1896         let orig_dir_ownership = mem::replace(
1897             &mut self.cx.current_expansion.dir_ownership,
1898             DirOwnership::UnownedViaBlock,
1899         );
1900         noop_visit_block(node, self);
1901         self.cx.current_expansion.dir_ownership = orig_dir_ownership;
1902     }
1903
1904     fn visit_id(&mut self, id: &mut NodeId) {
1905         // We may have already assigned a `NodeId`
1906         // by calling `assign_id`
1907         if self.monotonic && *id == ast::DUMMY_NODE_ID {
1908             *id = self.cx.resolver.next_node_id();
1909         }
1910     }
1911 }
1912
1913 pub struct ExpansionConfig<'feat> {
1914     pub crate_name: String,
1915     pub features: Option<&'feat Features>,
1916     pub recursion_limit: Limit,
1917     pub trace_mac: bool,
1918     pub should_test: bool,          // If false, strip `#[test]` nodes
1919     pub span_debug: bool,           // If true, use verbose debugging for `proc_macro::Span`
1920     pub proc_macro_backtrace: bool, // If true, show backtraces for proc-macro panics
1921 }
1922
1923 impl<'feat> ExpansionConfig<'feat> {
1924     pub fn default(crate_name: String) -> ExpansionConfig<'static> {
1925         ExpansionConfig {
1926             crate_name,
1927             features: None,
1928             recursion_limit: Limit::new(1024),
1929             trace_mac: false,
1930             should_test: false,
1931             span_debug: false,
1932             proc_macro_backtrace: false,
1933         }
1934     }
1935
1936     fn proc_macro_hygiene(&self) -> bool {
1937         self.features.map_or(false, |features| features.proc_macro_hygiene)
1938     }
1939 }