compiler/rustc_expand/src/base.rs

   1 use crate::expand::{self, AstFragment, Invocation};
   2 use crate::module::DirOwnership;
   3
   4 use rustc_ast::attr::MarkedAttrs;
   5 use rustc_ast::ptr::P;
   6 use rustc_ast::token::{self, Nonterminal};
   7 use rustc_ast::tokenstream::{CanSynthesizeMissingTokens, TokenStream};
   8 use rustc_ast::visit::{AssocCtxt, Visitor};
   9 use rustc_ast::{self as ast, AstLike, Attribute, Item, NodeId, PatKind};
  10 use rustc_attr::{self as attr, Deprecation, Stability};
  11 use rustc_data_structures::fx::{FxHashMap, FxHashSet};
  12 use rustc_data_structures::sync::{self, Lrc};
  13 use rustc_errors::{Applicability, DiagnosticBuilder, ErrorGuaranteed, MultiSpan};
  14 use rustc_lint_defs::builtin::PROC_MACRO_BACK_COMPAT;
  15 use rustc_lint_defs::BuiltinLintDiagnostics;
  16 use rustc_parse::{self, nt_to_tokenstream, parser, MACRO_ARGUMENTS};
  17 use rustc_session::{parse::ParseSess, Limit, Session};
  18 use rustc_span::def_id::{CrateNum, DefId, LocalDefId};
  19 use rustc_span::edition::Edition;
  20 use rustc_span::hygiene::{AstPass, ExpnData, ExpnKind, LocalExpnId};
  21 use rustc_span::source_map::SourceMap;
  22 use rustc_span::symbol::{kw, sym, Ident, Symbol};
  23 use rustc_span::{Span, DUMMY_SP};
  24 use smallvec::{smallvec, SmallVec};
  25
  26 use std::default::Default;
  27 use std::iter;
  28 use std::path::PathBuf;
  29 use std::rc::Rc;
  30
  31 crate use rustc_span::hygiene::MacroKind;
  32
  33 // When adding new variants, make sure to
  34 // adjust the `visit_*` / `flat_map_*` calls in `InvocationCollector`
  35 // to use `assign_id!`
  36 #[derive(Debug, Clone)]
  37 pub enum Annotatable {
  38     Item(P<ast::Item>),
  39     TraitItem(P<ast::AssocItem>),
  40     ImplItem(P<ast::AssocItem>),
  41     ForeignItem(P<ast::ForeignItem>),
  42     Stmt(P<ast::Stmt>),
  43     Expr(P<ast::Expr>),
  44     Arm(ast::Arm),
  45     ExprField(ast::ExprField),
  46     PatField(ast::PatField),
  47     GenericParam(ast::GenericParam),
  48     Param(ast::Param),
  49     FieldDef(ast::FieldDef),
  50     Variant(ast::Variant),
  51     Crate(ast::Crate),
  52 }
  53
  54 impl Annotatable {
  55     pub fn span(&self) -> Span {
  56         match *self {
  57             Annotatable::Item(ref item) => item.span,
  58             Annotatable::TraitItem(ref trait_item) => trait_item.span,
  59             Annotatable::ImplItem(ref impl_item) => impl_item.span,
  60             Annotatable::ForeignItem(ref foreign_item) => foreign_item.span,
  61             Annotatable::Stmt(ref stmt) => stmt.span,
  62             Annotatable::Expr(ref expr) => expr.span,
  63             Annotatable::Arm(ref arm) => arm.span,
  64             Annotatable::ExprField(ref field) => field.span,
  65             Annotatable::PatField(ref fp) => fp.pat.span,
  66             Annotatable::GenericParam(ref gp) => gp.ident.span,
  67             Annotatable::Param(ref p) => p.span,
  68             Annotatable::FieldDef(ref sf) => sf.span,
  69             Annotatable::Variant(ref v) => v.span,
  70             Annotatable::Crate(ref c) => c.spans.inner_span,
  71         }
  72     }
  73
  74     pub fn visit_attrs(&mut self, f: impl FnOnce(&mut Vec<Attribute>)) {
  75         match self {
  76             Annotatable::Item(item) => item.visit_attrs(f),
  77             Annotatable::TraitItem(trait_item) => trait_item.visit_attrs(f),
  78             Annotatable::ImplItem(impl_item) => impl_item.visit_attrs(f),
  79             Annotatable::ForeignItem(foreign_item) => foreign_item.visit_attrs(f),
  80             Annotatable::Stmt(stmt) => stmt.visit_attrs(f),
  81             Annotatable::Expr(expr) => expr.visit_attrs(f),
  82             Annotatable::Arm(arm) => arm.visit_attrs(f),
  83             Annotatable::ExprField(field) => field.visit_attrs(f),
  84             Annotatable::PatField(fp) => fp.visit_attrs(f),
  85             Annotatable::GenericParam(gp) => gp.visit_attrs(f),
  86             Annotatable::Param(p) => p.visit_attrs(f),
  87             Annotatable::FieldDef(sf) => sf.visit_attrs(f),
  88             Annotatable::Variant(v) => v.visit_attrs(f),
  89             Annotatable::Crate(c) => c.visit_attrs(f),
  90         }
  91     }
  92
  93     pub fn visit_with<'a, V: Visitor<'a>>(&'a self, visitor: &mut V) {
  94         match self {
  95             Annotatable::Item(item) => visitor.visit_item(item),
  96             Annotatable::TraitItem(item) => visitor.visit_assoc_item(item, AssocCtxt::Trait),
  97             Annotatable::ImplItem(item) => visitor.visit_assoc_item(item, AssocCtxt::Impl),
  98             Annotatable::ForeignItem(foreign_item) => visitor.visit_foreign_item(foreign_item),
  99             Annotatable::Stmt(stmt) => visitor.visit_stmt(stmt),
 100             Annotatable::Expr(expr) => visitor.visit_expr(expr),
 101             Annotatable::Arm(arm) => visitor.visit_arm(arm),
 102             Annotatable::ExprField(field) => visitor.visit_expr_field(field),
 103             Annotatable::PatField(fp) => visitor.visit_pat_field(fp),
 104             Annotatable::GenericParam(gp) => visitor.visit_generic_param(gp),
 105             Annotatable::Param(p) => visitor.visit_param(p),
 106             Annotatable::FieldDef(sf) => visitor.visit_field_def(sf),
 107             Annotatable::Variant(v) => visitor.visit_variant(v),
 108             Annotatable::Crate(c) => visitor.visit_crate(c),
 109         }
 110     }
 111
 112     pub fn into_nonterminal(self) -> Nonterminal {
 113         match self {
 114             Annotatable::Item(item) => token::NtItem(item),
 115             Annotatable::TraitItem(item) | Annotatable::ImplItem(item) => {
 116                 token::NtItem(P(item.and_then(ast::AssocItem::into_item)))
 117             }
 118             Annotatable::ForeignItem(item) => {
 119                 token::NtItem(P(item.and_then(ast::ForeignItem::into_item)))
 120             }
 121             Annotatable::Stmt(stmt) => token::NtStmt(stmt),
 122             Annotatable::Expr(expr) => token::NtExpr(expr),
 123             Annotatable::Arm(..)
 124             | Annotatable::ExprField(..)
 125             | Annotatable::PatField(..)
 126             | Annotatable::GenericParam(..)
 127             | Annotatable::Param(..)
 128             | Annotatable::FieldDef(..)
 129             | Annotatable::Variant(..)
 130             | Annotatable::Crate(..) => panic!("unexpected annotatable"),
 131         }
 132     }
 133
 134     crate fn into_tokens(self, sess: &ParseSess) -> TokenStream {
 135         nt_to_tokenstream(&self.into_nonterminal(), sess, CanSynthesizeMissingTokens::No)
 136     }
 137
 138     pub fn expect_item(self) -> P<ast::Item> {
 139         match self {
 140             Annotatable::Item(i) => i,
 141             _ => panic!("expected Item"),
 142         }
 143     }
 144
 145     pub fn expect_trait_item(self) -> P<ast::AssocItem> {
 146         match self {
 147             Annotatable::TraitItem(i) => i,
 148             _ => panic!("expected Item"),
 149         }
 150     }
 151
 152     pub fn expect_impl_item(self) -> P<ast::AssocItem> {
 153         match self {
 154             Annotatable::ImplItem(i) => i,
 155             _ => panic!("expected Item"),
 156         }
 157     }
 158
 159     pub fn expect_foreign_item(self) -> P<ast::ForeignItem> {
 160         match self {
 161             Annotatable::ForeignItem(i) => i,
 162             _ => panic!("expected foreign item"),
 163         }
 164     }
 165
 166     pub fn expect_stmt(self) -> ast::Stmt {
 167         match self {
 168             Annotatable::Stmt(stmt) => stmt.into_inner(),
 169             _ => panic!("expected statement"),
 170         }
 171     }
 172
 173     pub fn expect_expr(self) -> P<ast::Expr> {
 174         match self {
 175             Annotatable::Expr(expr) => expr,
 176             _ => panic!("expected expression"),
 177         }
 178     }
 179
 180     pub fn expect_arm(self) -> ast::Arm {
 181         match self {
 182             Annotatable::Arm(arm) => arm,
 183             _ => panic!("expected match arm"),
 184         }
 185     }
 186
 187     pub fn expect_expr_field(self) -> ast::ExprField {
 188         match self {
 189             Annotatable::ExprField(field) => field,
 190             _ => panic!("expected field"),
 191         }
 192     }
 193
 194     pub fn expect_pat_field(self) -> ast::PatField {
 195         match self {
 196             Annotatable::PatField(fp) => fp,
 197             _ => panic!("expected field pattern"),
 198         }
 199     }
 200
 201     pub fn expect_generic_param(self) -> ast::GenericParam {
 202         match self {
 203             Annotatable::GenericParam(gp) => gp,
 204             _ => panic!("expected generic parameter"),
 205         }
 206     }
 207
 208     pub fn expect_param(self) -> ast::Param {
 209         match self {
 210             Annotatable::Param(param) => param,
 211             _ => panic!("expected parameter"),
 212         }
 213     }
 214
 215     pub fn expect_field_def(self) -> ast::FieldDef {
 216         match self {
 217             Annotatable::FieldDef(sf) => sf,
 218             _ => panic!("expected struct field"),
 219         }
 220     }
 221
 222     pub fn expect_variant(self) -> ast::Variant {
 223         match self {
 224             Annotatable::Variant(v) => v,
 225             _ => panic!("expected variant"),
 226         }
 227     }
 228
 229     pub fn expect_crate(self) -> ast::Crate {
 230         match self {
 231             Annotatable::Crate(krate) => krate,
 232             _ => panic!("expected krate"),
 233         }
 234     }
 235 }
 236
 237 /// Result of an expansion that may need to be retried.
 238 /// Consider using this for non-`MultiItemModifier` expanders as well.
 239 pub enum ExpandResult<T, U> {
 240     /// Expansion produced a result (possibly dummy).
 241     Ready(T),
 242     /// Expansion could not produce a result and needs to be retried.
 243     Retry(U),
 244 }
 245
 246 // `meta_item` is the attribute, and `item` is the item being modified.
 247 pub trait MultiItemModifier {
 248     fn expand(
 249         &self,
 250         ecx: &mut ExtCtxt<'_>,
 251         span: Span,
 252         meta_item: &ast::MetaItem,
 253         item: Annotatable,
 254     ) -> ExpandResult<Vec<Annotatable>, Annotatable>;
 255 }
 256
 257 impl<F> MultiItemModifier for F
 258 where
 259     F: Fn(&mut ExtCtxt<'_>, Span, &ast::MetaItem, Annotatable) -> Vec<Annotatable>,
 260 {
 261     fn expand(
 262         &self,
 263         ecx: &mut ExtCtxt<'_>,
 264         span: Span,
 265         meta_item: &ast::MetaItem,
 266         item: Annotatable,
 267     ) -> ExpandResult<Vec<Annotatable>, Annotatable> {
 268         ExpandResult::Ready(self(ecx, span, meta_item, item))
 269     }
 270 }
 271
 272 pub trait ProcMacro {
 273     fn expand<'cx>(
 274         &self,
 275         ecx: &'cx mut ExtCtxt<'_>,
 276         span: Span,
 277         ts: TokenStream,
 278     ) -> Result<TokenStream, ErrorGuaranteed>;
 279 }
 280
 281 impl<F> ProcMacro for F
 282 where
 283     F: Fn(TokenStream) -> TokenStream,
 284 {
 285     fn expand<'cx>(
 286         &self,
 287         _ecx: &'cx mut ExtCtxt<'_>,
 288         _span: Span,
 289         ts: TokenStream,
 290     ) -> Result<TokenStream, ErrorGuaranteed> {
 291         // FIXME setup implicit context in TLS before calling self.
 292         Ok(self(ts))
 293     }
 294 }
 295
 296 pub trait AttrProcMacro {
 297     fn expand<'cx>(
 298         &self,
 299         ecx: &'cx mut ExtCtxt<'_>,
 300         span: Span,
 301         annotation: TokenStream,
 302         annotated: TokenStream,
 303     ) -> Result<TokenStream, ErrorGuaranteed>;
 304 }
 305
 306 impl<F> AttrProcMacro for F
 307 where
 308     F: Fn(TokenStream, TokenStream) -> TokenStream,
 309 {
 310     fn expand<'cx>(
 311         &self,
 312         _ecx: &'cx mut ExtCtxt<'_>,
 313         _span: Span,
 314         annotation: TokenStream,
 315         annotated: TokenStream,
 316     ) -> Result<TokenStream, ErrorGuaranteed> {
 317         // FIXME setup implicit context in TLS before calling self.
 318         Ok(self(annotation, annotated))
 319     }
 320 }
 321
 322 /// Represents a thing that maps token trees to Macro Results
 323 pub trait TTMacroExpander {
 324     fn expand<'cx>(
 325         &self,
 326         ecx: &'cx mut ExtCtxt<'_>,
 327         span: Span,
 328         input: TokenStream,
 329     ) -> Box<dyn MacResult + 'cx>;
 330 }
 331
 332 pub type MacroExpanderFn =
 333     for<'cx> fn(&'cx mut ExtCtxt<'_>, Span, TokenStream) -> Box<dyn MacResult + 'cx>;
 334
 335 impl<F> TTMacroExpander for F
 336 where
 337     F: for<'cx> Fn(&'cx mut ExtCtxt<'_>, Span, TokenStream) -> Box<dyn MacResult + 'cx>,
 338 {
 339     fn expand<'cx>(
 340         &self,
 341         ecx: &'cx mut ExtCtxt<'_>,
 342         span: Span,
 343         input: TokenStream,
 344     ) -> Box<dyn MacResult + 'cx> {
 345         self(ecx, span, input)
 346     }
 347 }
 348
 349 // Use a macro because forwarding to a simple function has type system issues
 350 macro_rules! make_stmts_default {
 351     ($me:expr) => {
 352         $me.make_expr().map(|e| {
 353             smallvec![ast::Stmt {
 354                 id: ast::DUMMY_NODE_ID,
 355                 span: e.span,
 356                 kind: ast::StmtKind::Expr(e),
 357             }]
 358         })
 359     };
 360 }
 361
 362 /// The result of a macro expansion. The return values of the various
 363 /// methods are spliced into the AST at the callsite of the macro.
 364 pub trait MacResult {
 365     /// Creates an expression.
 366     fn make_expr(self: Box<Self>) -> Option<P<ast::Expr>> {
 367         None
 368     }
 369
 370     /// Creates zero or more items.
 371     fn make_items(self: Box<Self>) -> Option<SmallVec<[P<ast::Item>; 1]>> {
 372         None
 373     }
 374
 375     /// Creates zero or more impl items.
 376     fn make_impl_items(self: Box<Self>) -> Option<SmallVec<[P<ast::AssocItem>; 1]>> {
 377         None
 378     }
 379
 380     /// Creates zero or more trait items.
 381     fn make_trait_items(self: Box<Self>) -> Option<SmallVec<[P<ast::AssocItem>; 1]>> {
 382         None
 383     }
 384
 385     /// Creates zero or more items in an `extern {}` block
 386     fn make_foreign_items(self: Box<Self>) -> Option<SmallVec<[P<ast::ForeignItem>; 1]>> {
 387         None
 388     }
 389
 390     /// Creates a pattern.
 391     fn make_pat(self: Box<Self>) -> Option<P<ast::Pat>> {
 392         None
 393     }
 394
 395     /// Creates zero or more statements.
 396     ///
 397     /// By default this attempts to create an expression statement,
 398     /// returning None if that fails.
 399     fn make_stmts(self: Box<Self>) -> Option<SmallVec<[ast::Stmt; 1]>> {
 400         make_stmts_default!(self)
 401     }
 402
 403     fn make_ty(self: Box<Self>) -> Option<P<ast::Ty>> {
 404         None
 405     }
 406
 407     fn make_arms(self: Box<Self>) -> Option<SmallVec<[ast::Arm; 1]>> {
 408         None
 409     }
 410
 411     fn make_expr_fields(self: Box<Self>) -> Option<SmallVec<[ast::ExprField; 1]>> {
 412         None
 413     }
 414
 415     fn make_pat_fields(self: Box<Self>) -> Option<SmallVec<[ast::PatField; 1]>> {
 416         None
 417     }
 418
 419     fn make_generic_params(self: Box<Self>) -> Option<SmallVec<[ast::GenericParam; 1]>> {
 420         None
 421     }
 422
 423     fn make_params(self: Box<Self>) -> Option<SmallVec<[ast::Param; 1]>> {
 424         None
 425     }
 426
 427     fn make_field_defs(self: Box<Self>) -> Option<SmallVec<[ast::FieldDef; 1]>> {
 428         None
 429     }
 430
 431     fn make_variants(self: Box<Self>) -> Option<SmallVec<[ast::Variant; 1]>> {
 432         None
 433     }
 434
 435     fn make_crate(self: Box<Self>) -> Option<ast::Crate> {
 436         // Fn-like macros cannot produce a crate.
 437         unreachable!()
 438     }
 439 }
 440
 441 macro_rules! make_MacEager {
 442     ( $( $fld:ident: $t:ty, )* ) => {
 443         /// `MacResult` implementation for the common case where you've already
 444         /// built each form of AST that you might return.
 445         #[derive(Default)]
 446         pub struct MacEager {
 447             $(
 448                 pub $fld: Option<$t>,
 449             )*
 450         }
 451
 452         impl MacEager {
 453             $(
 454                 pub fn $fld(v: $t) -> Box<dyn MacResult> {
 455                     Box::new(MacEager {
 456                         $fld: Some(v),
 457                         ..Default::default()
 458                     })
 459                 }
 460             )*
 461         }
 462     }
 463 }
 464
 465 make_MacEager! {
 466     expr: P<ast::Expr>,
 467     pat: P<ast::Pat>,
 468     items: SmallVec<[P<ast::Item>; 1]>,
 469     impl_items: SmallVec<[P<ast::AssocItem>; 1]>,
 470     trait_items: SmallVec<[P<ast::AssocItem>; 1]>,
 471     foreign_items: SmallVec<[P<ast::ForeignItem>; 1]>,
 472     stmts: SmallVec<[ast::Stmt; 1]>,
 473     ty: P<ast::Ty>,
 474 }
 475
 476 impl MacResult for MacEager {
 477     fn make_expr(self: Box<Self>) -> Option<P<ast::Expr>> {
 478         self.expr
 479     }
 480
 481     fn make_items(self: Box<Self>) -> Option<SmallVec<[P<ast::Item>; 1]>> {
 482         self.items
 483     }
 484
 485     fn make_impl_items(self: Box<Self>) -> Option<SmallVec<[P<ast::AssocItem>; 1]>> {
 486         self.impl_items
 487     }
 488
 489     fn make_trait_items(self: Box<Self>) -> Option<SmallVec<[P<ast::AssocItem>; 1]>> {
 490         self.trait_items
 491     }
 492
 493     fn make_foreign_items(self: Box<Self>) -> Option<SmallVec<[P<ast::ForeignItem>; 1]>> {
 494         self.foreign_items
 495     }
 496
 497     fn make_stmts(self: Box<Self>) -> Option<SmallVec<[ast::Stmt; 1]>> {
 498         match self.stmts.as_ref().map_or(0, |s| s.len()) {
 499             0 => make_stmts_default!(self),
 500             _ => self.stmts,
 501         }
 502     }
 503
 504     fn make_pat(self: Box<Self>) -> Option<P<ast::Pat>> {
 505         if let Some(p) = self.pat {
 506             return Some(p);
 507         }
 508         if let Some(e) = self.expr {
 509             if let ast::ExprKind::Lit(_) = e.kind {
 510                 return Some(P(ast::Pat {
 511                     id: ast::DUMMY_NODE_ID,
 512                     span: e.span,
 513                     kind: PatKind::Lit(e),
 514                     tokens: None,
 515                 }));
 516             }
 517         }
 518         None
 519     }
 520
 521     fn make_ty(self: Box<Self>) -> Option<P<ast::Ty>> {
 522         self.ty
 523     }
 524 }
 525
 526 /// Fill-in macro expansion result, to allow compilation to continue
 527 /// after hitting errors.
 528 #[derive(Copy, Clone)]
 529 pub struct DummyResult {
 530     is_error: bool,
 531     span: Span,
 532 }
 533
 534 impl DummyResult {
 535     /// Creates a default MacResult that can be anything.
 536     ///
 537     /// Use this as a return value after hitting any errors and
 538     /// calling `span_err`.
 539     pub fn any(span: Span) -> Box<dyn MacResult + 'static> {
 540         Box::new(DummyResult { is_error: true, span })
 541     }
 542
 543     /// Same as `any`, but must be a valid fragment, not error.
 544     pub fn any_valid(span: Span) -> Box<dyn MacResult + 'static> {
 545         Box::new(DummyResult { is_error: false, span })
 546     }
 547
 548     /// A plain dummy expression.
 549     pub fn raw_expr(sp: Span, is_error: bool) -> P<ast::Expr> {
 550         P(ast::Expr {
 551             id: ast::DUMMY_NODE_ID,
 552             kind: if is_error { ast::ExprKind::Err } else { ast::ExprKind::Tup(Vec::new()) },
 553             span: sp,
 554             attrs: ast::AttrVec::new(),
 555             tokens: None,
 556         })
 557     }
 558
 559     /// A plain dummy pattern.
 560     pub fn raw_pat(sp: Span) -> ast::Pat {
 561         ast::Pat { id: ast::DUMMY_NODE_ID, kind: PatKind::Wild, span: sp, tokens: None }
 562     }
 563
 564     /// A plain dummy type.
 565     pub fn raw_ty(sp: Span, is_error: bool) -> P<ast::Ty> {
 566         P(ast::Ty {
 567             id: ast::DUMMY_NODE_ID,
 568             kind: if is_error { ast::TyKind::Err } else { ast::TyKind::Tup(Vec::new()) },
 569             span: sp,
 570             tokens: None,
 571         })
 572     }
 573 }
 574
 575 impl MacResult for DummyResult {
 576     fn make_expr(self: Box<DummyResult>) -> Option<P<ast::Expr>> {
 577         Some(DummyResult::raw_expr(self.span, self.is_error))
 578     }
 579
 580     fn make_pat(self: Box<DummyResult>) -> Option<P<ast::Pat>> {
 581         Some(P(DummyResult::raw_pat(self.span)))
 582     }
 583
 584     fn make_items(self: Box<DummyResult>) -> Option<SmallVec<[P<ast::Item>; 1]>> {
 585         Some(SmallVec::new())
 586     }
 587
 588     fn make_impl_items(self: Box<DummyResult>) -> Option<SmallVec<[P<ast::AssocItem>; 1]>> {
 589         Some(SmallVec::new())
 590     }
 591
 592     fn make_trait_items(self: Box<DummyResult>) -> Option<SmallVec<[P<ast::AssocItem>; 1]>> {
 593         Some(SmallVec::new())
 594     }
 595
 596     fn make_foreign_items(self: Box<Self>) -> Option<SmallVec<[P<ast::ForeignItem>; 1]>> {
 597         Some(SmallVec::new())
 598     }
 599
 600     fn make_stmts(self: Box<DummyResult>) -> Option<SmallVec<[ast::Stmt; 1]>> {
 601         Some(smallvec![ast::Stmt {
 602             id: ast::DUMMY_NODE_ID,
 603             kind: ast::StmtKind::Expr(DummyResult::raw_expr(self.span, self.is_error)),
 604             span: self.span,
 605         }])
 606     }
 607
 608     fn make_ty(self: Box<DummyResult>) -> Option<P<ast::Ty>> {
 609         Some(DummyResult::raw_ty(self.span, self.is_error))
 610     }
 611
 612     fn make_arms(self: Box<DummyResult>) -> Option<SmallVec<[ast::Arm; 1]>> {
 613         Some(SmallVec::new())
 614     }
 615
 616     fn make_expr_fields(self: Box<DummyResult>) -> Option<SmallVec<[ast::ExprField; 1]>> {
 617         Some(SmallVec::new())
 618     }
 619
 620     fn make_pat_fields(self: Box<DummyResult>) -> Option<SmallVec<[ast::PatField; 1]>> {
 621         Some(SmallVec::new())
 622     }
 623
 624     fn make_generic_params(self: Box<DummyResult>) -> Option<SmallVec<[ast::GenericParam; 1]>> {
 625         Some(SmallVec::new())
 626     }
 627
 628     fn make_params(self: Box<DummyResult>) -> Option<SmallVec<[ast::Param; 1]>> {
 629         Some(SmallVec::new())
 630     }
 631
 632     fn make_field_defs(self: Box<DummyResult>) -> Option<SmallVec<[ast::FieldDef; 1]>> {
 633         Some(SmallVec::new())
 634     }
 635
 636     fn make_variants(self: Box<DummyResult>) -> Option<SmallVec<[ast::Variant; 1]>> {
 637         Some(SmallVec::new())
 638     }
 639 }
 640
 641 /// A syntax extension kind.
 642 pub enum SyntaxExtensionKind {
 643     /// A token-based function-like macro.
 644     Bang(
 645         /// An expander with signature TokenStream -> TokenStream.
 646         Box<dyn ProcMacro + sync::Sync + sync::Send>,
 647     ),
 648
 649     /// An AST-based function-like macro.
 650     LegacyBang(
 651         /// An expander with signature TokenStream -> AST.
 652         Box<dyn TTMacroExpander + sync::Sync + sync::Send>,
 653     ),
 654
 655     /// A token-based attribute macro.
 656     Attr(
 657         /// An expander with signature (TokenStream, TokenStream) -> TokenStream.
 658         /// The first TokenSteam is the attribute itself, the second is the annotated item.
 659         /// The produced TokenSteam replaces the input TokenSteam.
 660         Box<dyn AttrProcMacro + sync::Sync + sync::Send>,
 661     ),
 662
 663     /// An AST-based attribute macro.
 664     LegacyAttr(
 665         /// An expander with signature (AST, AST) -> AST.
 666         /// The first AST fragment is the attribute itself, the second is the annotated item.
 667         /// The produced AST fragment replaces the input AST fragment.
 668         Box<dyn MultiItemModifier + sync::Sync + sync::Send>,
 669     ),
 670
 671     /// A trivial attribute "macro" that does nothing,
 672     /// only keeps the attribute and marks it as inert,
 673     /// thus making it ineligible for further expansion.
 674     NonMacroAttr,
 675
 676     /// A token-based derive macro.
 677     Derive(
 678         /// An expander with signature TokenStream -> TokenStream (not yet).
 679         /// The produced TokenSteam is appended to the input TokenSteam.
 680         Box<dyn MultiItemModifier + sync::Sync + sync::Send>,
 681     ),
 682
 683     /// An AST-based derive macro.
 684     LegacyDerive(
 685         /// An expander with signature AST -> AST.
 686         /// The produced AST fragment is appended to the input AST fragment.
 687         Box<dyn MultiItemModifier + sync::Sync + sync::Send>,
 688     ),
 689 }
 690
 691 /// A struct representing a macro definition in "lowered" form ready for expansion.
 692 pub struct SyntaxExtension {
 693     /// A syntax extension kind.
 694     pub kind: SyntaxExtensionKind,
 695     /// Span of the macro definition.
 696     pub span: Span,
 697     /// List of unstable features that are treated as stable inside this macro.
 698     pub allow_internal_unstable: Option<Lrc<[Symbol]>>,
 699     /// Suppresses the `unsafe_code` lint for code produced by this macro.
 700     pub allow_internal_unsafe: bool,
 701     /// Enables the macro helper hack (`ident!(...)` -> `$crate::ident!(...)`) for this macro.
 702     pub local_inner_macros: bool,
 703     /// The macro's stability info.
 704     pub stability: Option<Stability>,
 705     /// The macro's deprecation info.
 706     pub deprecation: Option<Deprecation>,
 707     /// Names of helper attributes registered by this macro.
 708     pub helper_attrs: Vec<Symbol>,
 709     /// Edition of the crate in which this macro is defined.
 710     pub edition: Edition,
 711     /// Built-in macros have a couple of special properties like availability
 712     /// in `#[no_implicit_prelude]` modules, so we have to keep this flag.
 713     pub builtin_name: Option<Symbol>,
 714 }
 715
 716 impl SyntaxExtension {
 717     /// Returns which kind of macro calls this syntax extension.
 718     pub fn macro_kind(&self) -> MacroKind {
 719         match self.kind {
 720             SyntaxExtensionKind::Bang(..) | SyntaxExtensionKind::LegacyBang(..) => MacroKind::Bang,
 721             SyntaxExtensionKind::Attr(..)
 722             | SyntaxExtensionKind::LegacyAttr(..)
 723             | SyntaxExtensionKind::NonMacroAttr => MacroKind::Attr,
 724             SyntaxExtensionKind::Derive(..) | SyntaxExtensionKind::LegacyDerive(..) => {
 725                 MacroKind::Derive
 726             }
 727         }
 728     }
 729
 730     /// Constructs a syntax extension with default properties.
 731     pub fn default(kind: SyntaxExtensionKind, edition: Edition) -> SyntaxExtension {
 732         SyntaxExtension {
 733             span: DUMMY_SP,
 734             allow_internal_unstable: None,
 735             allow_internal_unsafe: false,
 736             local_inner_macros: false,
 737             stability: None,
 738             deprecation: None,
 739             helper_attrs: Vec::new(),
 740             edition,
 741             builtin_name: None,
 742             kind,
 743         }
 744     }
 745
 746     /// Constructs a syntax extension with the given properties
 747     /// and other properties converted from attributes.
 748     pub fn new(
 749         sess: &Session,
 750         kind: SyntaxExtensionKind,
 751         span: Span,
 752         helper_attrs: Vec<Symbol>,
 753         edition: Edition,
 754         name: Symbol,
 755         attrs: &[ast::Attribute],
 756     ) -> SyntaxExtension {
 757         let allow_internal_unstable =
 758             attr::allow_internal_unstable(sess, &attrs).collect::<Vec<Symbol>>();
 759
 760         let mut local_inner_macros = false;
 761         if let Some(macro_export) = sess.find_by_name(attrs, sym::macro_export) {
 762             if let Some(l) = macro_export.meta_item_list() {
 763                 local_inner_macros = attr::list_contains_name(&l, sym::local_inner_macros);
 764             }
 765         }
 766
 767         let (builtin_name, helper_attrs) = sess
 768             .find_by_name(attrs, sym::rustc_builtin_macro)
 769             .map(|attr| {
 770                 // Override `helper_attrs` passed above if it's a built-in macro,
 771                 // marking `proc_macro_derive` macros as built-in is not a realistic use case.
 772                 parse_macro_name_and_helper_attrs(sess.diagnostic(), attr, "built-in").map_or_else(
 773                     || (Some(name), Vec::new()),
 774                     |(name, helper_attrs)| (Some(name), helper_attrs),
 775                 )
 776             })
 777             .unwrap_or_else(|| (None, helper_attrs));
 778         let (stability, const_stability) = attr::find_stability(&sess, attrs, span);
 779         if let Some((_, sp)) = const_stability {
 780             sess.parse_sess
 781                 .span_diagnostic
 782                 .struct_span_err(sp, "macros cannot have const stability attributes")
 783                 .span_label(sp, "invalid const stability attribute")
 784                 .span_label(
 785                     sess.source_map().guess_head_span(span),
 786                     "const stability attribute affects this macro",
 787                 )
 788                 .emit();
 789         }
 790
 791         SyntaxExtension {
 792             kind,
 793             span,
 794             allow_internal_unstable: (!allow_internal_unstable.is_empty())
 795                 .then(|| allow_internal_unstable.into()),
 796             allow_internal_unsafe: sess.contains_name(attrs, sym::allow_internal_unsafe),
 797             local_inner_macros,
 798             stability: stability.map(|(s, _)| s),
 799             deprecation: attr::find_deprecation(&sess, attrs).map(|(d, _)| d),
 800             helper_attrs,
 801             edition,
 802             builtin_name,
 803         }
 804     }
 805
 806     pub fn dummy_bang(edition: Edition) -> SyntaxExtension {
 807         fn expander<'cx>(
 808             _: &'cx mut ExtCtxt<'_>,
 809             span: Span,
 810             _: TokenStream,
 811         ) -> Box<dyn MacResult + 'cx> {
 812             DummyResult::any(span)
 813         }
 814         SyntaxExtension::default(SyntaxExtensionKind::LegacyBang(Box::new(expander)), edition)
 815     }
 816
 817     pub fn dummy_derive(edition: Edition) -> SyntaxExtension {
 818         fn expander(
 819             _: &mut ExtCtxt<'_>,
 820             _: Span,
 821             _: &ast::MetaItem,
 822             _: Annotatable,
 823         ) -> Vec<Annotatable> {
 824             Vec::new()
 825         }
 826         SyntaxExtension::default(SyntaxExtensionKind::Derive(Box::new(expander)), edition)
 827     }
 828
 829     pub fn non_macro_attr(edition: Edition) -> SyntaxExtension {
 830         SyntaxExtension::default(SyntaxExtensionKind::NonMacroAttr, edition)
 831     }
 832
 833     pub fn expn_data(
 834         &self,
 835         parent: LocalExpnId,
 836         call_site: Span,
 837         descr: Symbol,
 838         macro_def_id: Option<DefId>,
 839         parent_module: Option<DefId>,
 840     ) -> ExpnData {
 841         ExpnData::new(
 842             ExpnKind::Macro(self.macro_kind(), descr),
 843             parent.to_expn_id(),
 844             call_site,
 845             self.span,
 846             self.allow_internal_unstable.clone(),
 847             self.allow_internal_unsafe,
 848             self.local_inner_macros,
 849             self.edition,
 850             macro_def_id,
 851             parent_module,
 852         )
 853     }
 854 }
 855
 856 /// Error type that denotes indeterminacy.
 857 pub struct Indeterminate;
 858
 859 pub type DeriveResolutions = Vec<(ast::Path, Annotatable, Option<Lrc<SyntaxExtension>>)>;
 860
 861 pub trait ResolverExpand {
 862     fn next_node_id(&mut self) -> NodeId;
 863     fn invocation_parent(&self, id: LocalExpnId) -> LocalDefId;
 864
 865     fn resolve_dollar_crates(&mut self);
 866     fn visit_ast_fragment_with_placeholders(
 867         &mut self,
 868         expn_id: LocalExpnId,
 869         fragment: &AstFragment,
 870     );
 871     fn register_builtin_macro(&mut self, name: Symbol, ext: SyntaxExtensionKind);
 872
 873     fn expansion_for_ast_pass(
 874         &mut self,
 875         call_site: Span,
 876         pass: AstPass,
 877         features: &[Symbol],
 878         parent_module_id: Option<NodeId>,
 879     ) -> LocalExpnId;
 880
 881     fn resolve_imports(&mut self);
 882
 883     fn resolve_macro_invocation(
 884         &mut self,
 885         invoc: &Invocation,
 886         eager_expansion_root: LocalExpnId,
 887         force: bool,
 888     ) -> Result<Lrc<SyntaxExtension>, Indeterminate>;
 889
 890     fn check_unused_macros(&mut self);
 891
 892     // Resolver interfaces for specific built-in macros.
 893     /// Does `#[derive(...)]` attribute with the given `ExpnId` have built-in `Copy` inside it?
 894     fn has_derive_copy(&self, expn_id: LocalExpnId) -> bool;
 895     /// Resolve paths inside the `#[derive(...)]` attribute with the given `ExpnId`.
 896     fn resolve_derives(
 897         &mut self,
 898         expn_id: LocalExpnId,
 899         force: bool,
 900         derive_paths: &dyn Fn() -> DeriveResolutions,
 901     ) -> Result<(), Indeterminate>;
 902     /// Take resolutions for paths inside the `#[derive(...)]` attribute with the given `ExpnId`
 903     /// back from resolver.
 904     fn take_derive_resolutions(&mut self, expn_id: LocalExpnId) -> Option<DeriveResolutions>;
 905     /// Path resolution logic for `#[cfg_accessible(path)]`.
 906     fn cfg_accessible(
 907         &mut self,
 908         expn_id: LocalExpnId,
 909         path: &ast::Path,
 910     ) -> Result<bool, Indeterminate>;
 911
 912     /// Decodes the proc-macro quoted span in the specified crate, with the specified id.
 913     /// No caching is performed.
 914     fn get_proc_macro_quoted_span(&self, krate: CrateNum, id: usize) -> Span;
 915
 916     /// The order of items in the HIR is unrelated to the order of
 917     /// items in the AST. However, we generate proc macro harnesses
 918     /// based on the AST order, and later refer to these harnesses
 919     /// from the HIR. This field keeps track of the order in which
 920     /// we generated proc macros harnesses, so that we can map
 921     /// HIR proc macros items back to their harness items.
 922     fn declare_proc_macro(&mut self, id: NodeId);
 923
 924     /// Tools registered with `#![register_tool]` and used by tool attributes and lints.
 925     fn registered_tools(&self) -> &FxHashSet<Ident>;
 926 }
 927
 928 pub trait LintStoreExpand {
 929     fn pre_expansion_lint(
 930         &self,
 931         sess: &Session,
 932         registered_tools: &FxHashSet<Ident>,
 933         node_id: NodeId,
 934         attrs: &[Attribute],
 935         items: &[P<Item>],
 936         name: &str,
 937     );
 938 }
 939
 940 type LintStoreExpandDyn<'a> = Option<&'a (dyn LintStoreExpand + 'a)>;
 941
 942 #[derive(Clone, Default)]
 943 pub struct ModuleData {
 944     /// Path to the module starting from the crate name, like `my_crate::foo::bar`.
 945     pub mod_path: Vec<Ident>,
 946     /// Stack of paths to files loaded by out-of-line module items,
 947     /// used to detect and report recursive module inclusions.
 948     pub file_path_stack: Vec<PathBuf>,
 949     /// Directory to search child module files in,
 950     /// often (but not necessarily) the parent of the top file path on the `file_path_stack`.
 951     pub dir_path: PathBuf,
 952 }
 953
 954 impl ModuleData {
 955     pub fn with_dir_path(&self, dir_path: PathBuf) -> ModuleData {
 956         ModuleData {
 957             mod_path: self.mod_path.clone(),
 958             file_path_stack: self.file_path_stack.clone(),
 959             dir_path,
 960         }
 961     }
 962 }
 963
 964 #[derive(Clone)]
 965 pub struct ExpansionData {
 966     pub id: LocalExpnId,
 967     pub depth: usize,
 968     pub module: Rc<ModuleData>,
 969     pub dir_ownership: DirOwnership,
 970     pub prior_type_ascription: Option<(Span, bool)>,
 971     /// Some parent node that is close to this macro call
 972     pub lint_node_id: NodeId,
 973     pub is_trailing_mac: bool,
 974 }
 975
 976 /// One of these is made during expansion and incrementally updated as we go;
 977 /// when a macro expansion occurs, the resulting nodes have the `backtrace()
 978 /// -> expn_data` of their expansion context stored into their span.
 979 pub struct ExtCtxt<'a> {
 980     pub sess: &'a Session,
 981     pub ecfg: expand::ExpansionConfig<'a>,
 982     pub reduced_recursion_limit: Option<Limit>,
 983     pub root_path: PathBuf,
 984     pub resolver: &'a mut dyn ResolverExpand,
 985     pub current_expansion: ExpansionData,
 986     /// Error recovery mode entered when expansion is stuck
 987     /// (or during eager expansion, but that's a hack).
 988     pub force_mode: bool,
 989     pub expansions: FxHashMap<Span, Vec<String>>,
 990     /// Used for running pre-expansion lints on freshly loaded modules.
 991     pub(super) lint_store: LintStoreExpandDyn<'a>,
 992     /// When we 'expand' an inert attribute, we leave it
 993     /// in the AST, but insert it here so that we know
 994     /// not to expand it again.
 995     pub(super) expanded_inert_attrs: MarkedAttrs,
 996 }
 997
 998 impl<'a> ExtCtxt<'a> {
 999     pub fn new(
1000         sess: &'a Session,
1001         ecfg: expand::ExpansionConfig<'a>,
1002         resolver: &'a mut dyn ResolverExpand,
1003         lint_store: LintStoreExpandDyn<'a>,
1004     ) -> ExtCtxt<'a> {
1005         ExtCtxt {
1006             sess,
1007             ecfg,
1008             reduced_recursion_limit: None,
1009             resolver,
1010             lint_store,
1011             root_path: PathBuf::new(),
1012             current_expansion: ExpansionData {
1013                 id: LocalExpnId::ROOT,
1014                 depth: 0,
1015                 module: Default::default(),
1016                 dir_ownership: DirOwnership::Owned { relative: None },
1017                 prior_type_ascription: None,
1018                 lint_node_id: ast::CRATE_NODE_ID,
1019                 is_trailing_mac: false,
1020             },
1021             force_mode: false,
1022             expansions: FxHashMap::default(),
1023             expanded_inert_attrs: MarkedAttrs::new(),
1024         }
1025     }
1026
1027     /// Returns a `Folder` for deeply expanding all macros in an AST node.
1028     pub fn expander<'b>(&'b mut self) -> expand::MacroExpander<'b, 'a> {
1029         expand::MacroExpander::new(self, false)
1030     }
1031
1032     /// Returns a `Folder` that deeply expands all macros and assigns all `NodeId`s in an AST node.
1033     /// Once `NodeId`s are assigned, the node may not be expanded, removed, or otherwise modified.
1034     pub fn monotonic_expander<'b>(&'b mut self) -> expand::MacroExpander<'b, 'a> {
1035         expand::MacroExpander::new(self, true)
1036     }
1037     pub fn new_parser_from_tts(&self, stream: TokenStream) -> parser::Parser<'a> {
1038         rustc_parse::stream_to_parser(&self.sess.parse_sess, stream, MACRO_ARGUMENTS)
1039     }
1040     pub fn source_map(&self) -> &'a SourceMap {
1041         self.sess.parse_sess.source_map()
1042     }
1043     pub fn parse_sess(&self) -> &'a ParseSess {
1044         &self.sess.parse_sess
1045     }
1046     pub fn call_site(&self) -> Span {
1047         self.current_expansion.id.expn_data().call_site
1048     }
1049
1050     /// Returns the current expansion kind's description.
1051     pub(crate) fn expansion_descr(&self) -> String {
1052         let expn_data = self.current_expansion.id.expn_data();
1053         expn_data.kind.descr()
1054     }
1055
1056     /// Equivalent of `Span::def_site` from the proc macro API,
1057     /// except that the location is taken from the span passed as an argument.
1058     pub fn with_def_site_ctxt(&self, span: Span) -> Span {
1059         span.with_def_site_ctxt(self.current_expansion.id.to_expn_id())
1060     }
1061
1062     /// Equivalent of `Span::call_site` from the proc macro API,
1063     /// except that the location is taken from the span passed as an argument.
1064     pub fn with_call_site_ctxt(&self, span: Span) -> Span {
1065         span.with_call_site_ctxt(self.current_expansion.id.to_expn_id())
1066     }
1067
1068     /// Equivalent of `Span::mixed_site` from the proc macro API,
1069     /// except that the location is taken from the span passed as an argument.
1070     pub fn with_mixed_site_ctxt(&self, span: Span) -> Span {
1071         span.with_mixed_site_ctxt(self.current_expansion.id.to_expn_id())
1072     }
1073
1074     /// Returns span for the macro which originally caused the current expansion to happen.
1075     ///
1076     /// Stops backtracing at include! boundary.
1077     pub fn expansion_cause(&self) -> Option<Span> {
1078         self.current_expansion.id.expansion_cause()
1079     }
1080
1081     pub fn struct_span_err<S: Into<MultiSpan>>(
1082         &self,
1083         sp: S,
1084         msg: &str,
1085     ) -> DiagnosticBuilder<'a, ErrorGuaranteed> {
1086         self.sess.parse_sess.span_diagnostic.struct_span_err(sp, msg)
1087     }
1088
1089     /// Emit `msg` attached to `sp`, without immediately stopping
1090     /// compilation.
1091     ///
1092     /// Compilation will be stopped in the near future (at the end of
1093     /// the macro expansion phase).
1094     pub fn span_err<S: Into<MultiSpan>>(&self, sp: S, msg: &str) {
1095         self.sess.parse_sess.span_diagnostic.span_err(sp, msg);
1096     }
1097     pub fn span_warn<S: Into<MultiSpan>>(&self, sp: S, msg: &str) {
1098         self.sess.parse_sess.span_diagnostic.span_warn(sp, msg);
1099     }
1100     pub fn span_bug<S: Into<MultiSpan>>(&self, sp: S, msg: &str) -> ! {
1101         self.sess.parse_sess.span_diagnostic.span_bug(sp, msg);
1102     }
1103     pub fn trace_macros_diag(&mut self) {
1104         for (sp, notes) in self.expansions.iter() {
1105             let mut db = self.sess.parse_sess.span_diagnostic.span_note_diag(*sp, "trace_macro");
1106             for note in notes {
1107                 db.note(note);
1108             }
1109             db.emit();
1110         }
1111         // Fixme: does this result in errors?
1112         self.expansions.clear();
1113     }
1114     pub fn bug(&self, msg: &str) -> ! {
1115         self.sess.parse_sess.span_diagnostic.bug(msg);
1116     }
1117     pub fn trace_macros(&self) -> bool {
1118         self.ecfg.trace_mac
1119     }
1120     pub fn set_trace_macros(&mut self, x: bool) {
1121         self.ecfg.trace_mac = x
1122     }
1123     pub fn std_path(&self, components: &[Symbol]) -> Vec<Ident> {
1124         let def_site = self.with_def_site_ctxt(DUMMY_SP);
1125         iter::once(Ident::new(kw::DollarCrate, def_site))
1126             .chain(components.iter().map(|&s| Ident::with_dummy_span(s)))
1127             .collect()
1128     }
1129     pub fn def_site_path(&self, components: &[Symbol]) -> Vec<Ident> {
1130         let def_site = self.with_def_site_ctxt(DUMMY_SP);
1131         components.iter().map(|&s| Ident::new(s, def_site)).collect()
1132     }
1133
1134     pub fn check_unused_macros(&mut self) {
1135         self.resolver.check_unused_macros();
1136     }
1137 }
1138
1139 /// Extracts a string literal from the macro expanded version of `expr`,
1140 /// returning a diagnostic error of `err_msg` if `expr` is not a string literal.
1141 /// The returned bool indicates whether an applicable suggestion has already been
1142 /// added to the diagnostic to avoid emitting multiple suggestions. `Err(None)`
1143 /// indicates that an ast error was encountered.
1144 pub fn expr_to_spanned_string<'a>(
1145     cx: &'a mut ExtCtxt<'_>,
1146     expr: P<ast::Expr>,
1147     err_msg: &str,
1148 ) -> Result<(Symbol, ast::StrStyle, Span), Option<(DiagnosticBuilder<'a, ErrorGuaranteed>, bool)>> {
1149     // Perform eager expansion on the expression.
1150     // We want to be able to handle e.g., `concat!("foo", "bar")`.
1151     let expr = cx.expander().fully_expand_fragment(AstFragment::Expr(expr)).make_expr();
1152
1153     Err(match expr.kind {
1154         ast::ExprKind::Lit(ref l) => match l.kind {
1155             ast::LitKind::Str(s, style) => return Ok((s, style, expr.span)),
1156             ast::LitKind::ByteStr(_) => {
1157                 let mut err = cx.struct_span_err(l.span, err_msg);
1158                 err.span_suggestion(
1159                     expr.span.shrink_to_lo(),
1160                     "consider removing the leading `b`",
1161                     String::new(),
1162                     Applicability::MaybeIncorrect,
1163                 );
1164                 Some((err, true))
1165             }
1166             ast::LitKind::Err(_) => None,
1167             _ => Some((cx.struct_span_err(l.span, err_msg), false)),
1168         },
1169         ast::ExprKind::Err => None,
1170         _ => Some((cx.struct_span_err(expr.span, err_msg), false)),
1171     })
1172 }
1173
1174 /// Extracts a string literal from the macro expanded version of `expr`,
1175 /// emitting `err_msg` if `expr` is not a string literal. This does not stop
1176 /// compilation on error, merely emits a non-fatal error and returns `None`.
1177 pub fn expr_to_string(
1178     cx: &mut ExtCtxt<'_>,
1179     expr: P<ast::Expr>,
1180     err_msg: &str,
1181 ) -> Option<(Symbol, ast::StrStyle)> {
1182     expr_to_spanned_string(cx, expr, err_msg)
1183         .map_err(|err| {
1184             err.map(|(mut err, _)| {
1185                 err.emit();
1186             })
1187         })
1188         .ok()
1189         .map(|(symbol, style, _)| (symbol, style))
1190 }
1191
1192 /// Non-fatally assert that `tts` is empty. Note that this function
1193 /// returns even when `tts` is non-empty, macros that *need* to stop
1194 /// compilation should call
1195 /// `cx.parse_sess.span_diagnostic.abort_if_errors()` (this should be
1196 /// done as rarely as possible).
1197 pub fn check_zero_tts(cx: &ExtCtxt<'_>, sp: Span, tts: TokenStream, name: &str) {
1198     if !tts.is_empty() {
1199         cx.span_err(sp, &format!("{} takes no arguments", name));
1200     }
1201 }
1202
1203 /// Parse an expression. On error, emit it, advancing to `Eof`, and return `None`.
1204 pub fn parse_expr(p: &mut parser::Parser<'_>) -> Option<P<ast::Expr>> {
1205     match p.parse_expr() {
1206         Ok(e) => return Some(e),
1207         Err(mut err) => {
1208             err.emit();
1209         }
1210     }
1211     while p.token != token::Eof {
1212         p.bump();
1213     }
1214     None
1215 }
1216
1217 /// Interpreting `tts` as a comma-separated sequence of expressions,
1218 /// expect exactly one string literal, or emit an error and return `None`.
1219 pub fn get_single_str_from_tts(
1220     cx: &mut ExtCtxt<'_>,
1221     sp: Span,
1222     tts: TokenStream,
1223     name: &str,
1224 ) -> Option<Symbol> {
1225     let mut p = cx.new_parser_from_tts(tts);
1226     if p.token == token::Eof {
1227         cx.span_err(sp, &format!("{} takes 1 argument", name));
1228         return None;
1229     }
1230     let ret = parse_expr(&mut p)?;
1231     let _ = p.eat(&token::Comma);
1232
1233     if p.token != token::Eof {
1234         cx.span_err(sp, &format!("{} takes 1 argument", name));
1235     }
1236     expr_to_string(cx, ret, "argument must be a string literal").map(|(s, _)| s)
1237 }
1238
1239 /// Extracts comma-separated expressions from `tts`.
1240 /// On error, emit it, and return `None`.
1241 pub fn get_exprs_from_tts(
1242     cx: &mut ExtCtxt<'_>,
1243     sp: Span,
1244     tts: TokenStream,
1245 ) -> Option<Vec<P<ast::Expr>>> {
1246     let mut p = cx.new_parser_from_tts(tts);
1247     let mut es = Vec::new();
1248     while p.token != token::Eof {
1249         let expr = parse_expr(&mut p)?;
1250
1251         // Perform eager expansion on the expression.
1252         // We want to be able to handle e.g., `concat!("foo", "bar")`.
1253         let expr = cx.expander().fully_expand_fragment(AstFragment::Expr(expr)).make_expr();
1254
1255         es.push(expr);
1256         if p.eat(&token::Comma) {
1257             continue;
1258         }
1259         if p.token != token::Eof {
1260             cx.span_err(sp, "expected token: `,`");
1261             return None;
1262         }
1263     }
1264     Some(es)
1265 }
1266
1267 pub fn parse_macro_name_and_helper_attrs(
1268     diag: &rustc_errors::Handler,
1269     attr: &Attribute,
1270     descr: &str,
1271 ) -> Option<(Symbol, Vec<Symbol>)> {
1272     // Once we've located the `#[proc_macro_derive]` attribute, verify
1273     // that it's of the form `#[proc_macro_derive(Foo)]` or
1274     // `#[proc_macro_derive(Foo, attributes(A, ..))]`
1275     let list = attr.meta_item_list()?;
1276     if list.len() != 1 && list.len() != 2 {
1277         diag.span_err(attr.span, "attribute must have either one or two arguments");
1278         return None;
1279     }
1280     let Some(trait_attr) = list[0].meta_item() else {
1281         diag.span_err(list[0].span(), "not a meta item");
1282         return None;
1283     };
1284     let trait_ident = match trait_attr.ident() {
1285         Some(trait_ident) if trait_attr.is_word() => trait_ident,
1286         _ => {
1287             diag.span_err(trait_attr.span, "must only be one word");
1288             return None;
1289         }
1290     };
1291
1292     if !trait_ident.name.can_be_raw() {
1293         diag.span_err(
1294             trait_attr.span,
1295             &format!("`{}` cannot be a name of {} macro", trait_ident, descr),
1296         );
1297     }
1298
1299     let attributes_attr = list.get(1);
1300     let proc_attrs: Vec<_> = if let Some(attr) = attributes_attr {
1301         if !attr.has_name(sym::attributes) {
1302             diag.span_err(attr.span(), "second argument must be `attributes`");
1303         }
1304         attr.meta_item_list()
1305             .unwrap_or_else(|| {
1306                 diag.span_err(attr.span(), "attribute must be of form: `attributes(foo, bar)`");
1307                 &[]
1308             })
1309             .iter()
1310             .filter_map(|attr| {
1311                 let Some(attr) = attr.meta_item() else {
1312                     diag.span_err(attr.span(), "not a meta item");
1313                     return None;
1314                 };
1315
1316                 let ident = match attr.ident() {
1317                     Some(ident) if attr.is_word() => ident,
1318                     _ => {
1319                         diag.span_err(attr.span, "must only be one word");
1320                         return None;
1321                     }
1322                 };
1323                 if !ident.name.can_be_raw() {
1324                     diag.span_err(
1325                         attr.span,
1326                         &format!("`{}` cannot be a name of derive helper attribute", ident),
1327                     );
1328                 }
1329
1330                 Some(ident.name)
1331             })
1332             .collect()
1333     } else {
1334         Vec::new()
1335     };
1336
1337     Some((trait_ident.name, proc_attrs))
1338 }
1339
1340 /// This nonterminal looks like some specific enums from
1341 /// `proc-macro-hack` and `procedural-masquerade` crates.
1342 /// We need to maintain some special pretty-printing behavior for them due to incorrect
1343 /// asserts in old versions of those crates and their wide use in the ecosystem.
1344 /// See issue #73345 for more details.
1345 /// FIXME(#73933): Remove this eventually.
1346 pub(crate) fn pretty_printing_compatibility_hack(nt: &Nonterminal, sess: &ParseSess) -> bool {
1347     let item = match nt {
1348         Nonterminal::NtItem(item) => item,
1349         Nonterminal::NtStmt(stmt) => match &stmt.kind {
1350             ast::StmtKind::Item(item) => item,
1351             _ => return false,
1352         },
1353         _ => return false,
1354     };
1355
1356     let name = item.ident.name;
1357     if name == sym::ProceduralMasqueradeDummyType {
1358         if let ast::ItemKind::Enum(enum_def, _) = &item.kind {
1359             if let [variant] = &*enum_def.variants {
1360                 if variant.ident.name == sym::Input {
1361                     sess.buffer_lint_with_diagnostic(
1362                         &PROC_MACRO_BACK_COMPAT,
1363                         item.ident.span,
1364                         ast::CRATE_NODE_ID,
1365                         "using `procedural-masquerade` crate",
1366                         BuiltinLintDiagnostics::ProcMacroBackCompat(
1367                         "The `procedural-masquerade` crate has been unnecessary since Rust 1.30.0. \
1368                         Versions of this crate below 0.1.7 will eventually stop compiling.".to_string())
1369                     );
1370                     return true;
1371                 }
1372             }
1373         }
1374     }
1375     false
1376 }