crates/hir_expand/src/lib.rs

   1 //! `hir_expand` deals with macro expansion.
   2 //!
   3 //! Specifically, it implements a concept of `MacroFile` -- a file whose syntax
   4 //! tree originates not from the text of some `FileId`, but from some macro
   5 //! expansion.
   6
   7 pub mod db;
   8 pub mod ast_id_map;
   9 pub mod name;
  10 pub mod hygiene;
  11 pub mod builtin_attr_macro;
  12 pub mod builtin_derive_macro;
  13 pub mod builtin_fn_macro;
  14 pub mod proc_macro;
  15 pub mod quote;
  16 pub mod eager;
  17 pub mod mod_path;
  18 mod fixup;
  19
  20 pub use mbe::{Origin, ValueResult};
  21
  22 use std::{fmt, hash::Hash, iter, sync::Arc};
  23
  24 use base_db::{impl_intern_key, salsa, CrateId, FileId, FileRange, ProcMacroKind};
  25 use either::Either;
  26 use syntax::{
  27     algo::{self, skip_trivia_token},
  28     ast::{self, AstNode, HasDocComments},
  29     Direction, SyntaxNode, SyntaxToken,
  30 };
  31
  32 use crate::{
  33     ast_id_map::FileAstId,
  34     builtin_attr_macro::BuiltinAttrExpander,
  35     builtin_derive_macro::BuiltinDeriveExpander,
  36     builtin_fn_macro::{BuiltinFnLikeExpander, EagerExpander},
  37     db::TokenExpander,
  38     mod_path::ModPath,
  39     proc_macro::ProcMacroExpander,
  40 };
  41
  42 pub type ExpandResult<T> = ValueResult<T, ExpandError>;
  43
  44 #[derive(Debug, PartialEq, Eq, Clone)]
  45 pub enum ExpandError {
  46     UnresolvedProcMacro,
  47     Mbe(mbe::ExpandError),
  48     Other(Box<str>),
  49 }
  50
  51 impl From<mbe::ExpandError> for ExpandError {
  52     fn from(mbe: mbe::ExpandError) -> Self {
  53         Self::Mbe(mbe)
  54     }
  55 }
  56
  57 impl fmt::Display for ExpandError {
  58     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
  59         match self {
  60             ExpandError::UnresolvedProcMacro => f.write_str("unresolved proc-macro"),
  61             ExpandError::Mbe(it) => it.fmt(f),
  62             ExpandError::Other(it) => f.write_str(it),
  63         }
  64     }
  65 }
  66
  67 /// Input to the analyzer is a set of files, where each file is identified by
  68 /// `FileId` and contains source code. However, another source of source code in
  69 /// Rust are macros: each macro can be thought of as producing a "temporary
  70 /// file". To assign an id to such a file, we use the id of the macro call that
  71 /// produced the file. So, a `HirFileId` is either a `FileId` (source code
  72 /// written by user), or a `MacroCallId` (source code produced by macro).
  73 ///
  74 /// What is a `MacroCallId`? Simplifying, it's a `HirFileId` of a file
  75 /// containing the call plus the offset of the macro call in the file. Note that
  76 /// this is a recursive definition! However, the size_of of `HirFileId` is
  77 /// finite (because everything bottoms out at the real `FileId`) and small
  78 /// (`MacroCallId` uses the location interning. You can check details here:
  79 /// <https://en.wikipedia.org/wiki/String_interning>).
  80 #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
  81 pub struct HirFileId(HirFileIdRepr);
  82
  83 #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
  84 enum HirFileIdRepr {
  85     FileId(FileId),
  86     MacroFile(MacroFile),
  87 }
  88
  89 impl From<FileId> for HirFileId {
  90     fn from(id: FileId) -> Self {
  91         HirFileId(HirFileIdRepr::FileId(id))
  92     }
  93 }
  94
  95 impl From<MacroFile> for HirFileId {
  96     fn from(id: MacroFile) -> Self {
  97         HirFileId(HirFileIdRepr::MacroFile(id))
  98     }
  99 }
 100
 101 #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
 102 pub struct MacroFile {
 103     pub macro_call_id: MacroCallId,
 104 }
 105
 106 /// `MacroCallId` identifies a particular macro invocation, like
 107 /// `println!("Hello, {}", world)`.
 108 #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
 109 pub struct MacroCallId(salsa::InternId);
 110 impl_intern_key!(MacroCallId);
 111
 112 #[derive(Debug, Clone, PartialEq, Eq, Hash)]
 113 pub struct MacroCallLoc {
 114     pub def: MacroDefId,
 115     pub(crate) krate: CrateId,
 116     eager: Option<EagerCallInfo>,
 117     pub kind: MacroCallKind,
 118 }
 119
 120 #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
 121 pub struct MacroDefId {
 122     pub krate: CrateId,
 123     pub kind: MacroDefKind,
 124     pub local_inner: bool,
 125 }
 126
 127 #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
 128 pub enum MacroDefKind {
 129     Declarative(AstId<ast::Macro>),
 130     BuiltIn(BuiltinFnLikeExpander, AstId<ast::Macro>),
 131     // FIXME: maybe just Builtin and rename BuiltinFnLikeExpander to BuiltinExpander
 132     BuiltInAttr(BuiltinAttrExpander, AstId<ast::Macro>),
 133     BuiltInDerive(BuiltinDeriveExpander, AstId<ast::Macro>),
 134     BuiltInEager(EagerExpander, AstId<ast::Macro>),
 135     ProcMacro(ProcMacroExpander, ProcMacroKind, AstId<ast::Fn>),
 136 }
 137
 138 #[derive(Debug, Clone, PartialEq, Eq, Hash)]
 139 struct EagerCallInfo {
 140     /// NOTE: This can be *either* the expansion result, *or* the argument to the eager macro!
 141     arg_or_expansion: Arc<tt::Subtree>,
 142     included_file: Option<FileId>,
 143 }
 144
 145 #[derive(Debug, Clone, PartialEq, Eq, Hash)]
 146 pub enum MacroCallKind {
 147     FnLike {
 148         ast_id: AstId<ast::MacroCall>,
 149         expand_to: ExpandTo,
 150     },
 151     Derive {
 152         ast_id: AstId<ast::Adt>,
 153         /// Syntactical index of the invoking `#[derive]` attribute.
 154         ///
 155         /// Outer attributes are counted first, then inner attributes. This does not support
 156         /// out-of-line modules, which may have attributes spread across 2 files!
 157         derive_attr_index: u32,
 158         /// Index of the derive macro in the derive attribute
 159         derive_index: u32,
 160     },
 161     Attr {
 162         ast_id: AstId<ast::Item>,
 163         attr_args: Arc<(tt::Subtree, mbe::TokenMap)>,
 164         /// Syntactical index of the invoking `#[attribute]`.
 165         ///
 166         /// Outer attributes are counted first, then inner attributes. This does not support
 167         /// out-of-line modules, which may have attributes spread across 2 files!
 168         invoc_attr_index: u32,
 169     },
 170 }
 171
 172 impl HirFileId {
 173     /// For macro-expansion files, returns the file original source file the
 174     /// expansion originated from.
 175     pub fn original_file(self, db: &dyn db::AstDatabase) -> FileId {
 176         match self.0 {
 177             HirFileIdRepr::FileId(file_id) => file_id,
 178             HirFileIdRepr::MacroFile(macro_file) => {
 179                 let loc: MacroCallLoc = db.lookup_intern_macro_call(macro_file.macro_call_id);
 180                 let file_id = match loc.eager {
 181                     Some(EagerCallInfo { included_file: Some(file), .. }) => file.into(),
 182                     _ => loc.kind.file_id(),
 183                 };
 184                 file_id.original_file(db)
 185             }
 186         }
 187     }
 188
 189     pub fn expansion_level(self, db: &dyn db::AstDatabase) -> u32 {
 190         let mut level = 0;
 191         let mut curr = self;
 192         while let HirFileIdRepr::MacroFile(macro_file) = curr.0 {
 193             let loc: MacroCallLoc = db.lookup_intern_macro_call(macro_file.macro_call_id);
 194
 195             level += 1;
 196             curr = loc.kind.file_id();
 197         }
 198         level
 199     }
 200
 201     /// If this is a macro call, returns the syntax node of the call.
 202     pub fn call_node(self, db: &dyn db::AstDatabase) -> Option<InFile<SyntaxNode>> {
 203         match self.0 {
 204             HirFileIdRepr::FileId(_) => None,
 205             HirFileIdRepr::MacroFile(macro_file) => {
 206                 let loc: MacroCallLoc = db.lookup_intern_macro_call(macro_file.macro_call_id);
 207                 Some(loc.kind.to_node(db))
 208             }
 209         }
 210     }
 211
 212     /// Return expansion information if it is a macro-expansion file
 213     pub fn expansion_info(self, db: &dyn db::AstDatabase) -> Option<ExpansionInfo> {
 214         match self.0 {
 215             HirFileIdRepr::FileId(_) => None,
 216             HirFileIdRepr::MacroFile(macro_file) => {
 217                 let loc: MacroCallLoc = db.lookup_intern_macro_call(macro_file.macro_call_id);
 218
 219                 let arg_tt = loc.kind.arg(db)?;
 220
 221                 let def = loc.def.ast_id().left().and_then(|id| {
 222                     let def_tt = match id.to_node(db) {
 223                         ast::Macro::MacroRules(mac) => mac.token_tree()?,
 224                         ast::Macro::MacroDef(mac) => mac.body()?,
 225                     };
 226                     Some(InFile::new(id.file_id, def_tt))
 227                 });
 228                 let attr_input_or_mac_def = def.or_else(|| match loc.kind {
 229                     MacroCallKind::Attr { ast_id, invoc_attr_index, .. } => {
 230                         let tt = ast_id
 231                             .to_node(db)
 232                             .doc_comments_and_attrs()
 233                             .nth(invoc_attr_index as usize)
 234                             .and_then(Either::left)?
 235                             .token_tree()?;
 236                         Some(InFile::new(ast_id.file_id, tt))
 237                     }
 238                     _ => None,
 239                 });
 240
 241                 let macro_def = db.macro_def(loc.def).ok()?;
 242                 let (parse, exp_map) = db.parse_macro_expansion(macro_file).value?;
 243                 let macro_arg = db.macro_arg(macro_file.macro_call_id)?;
 244
 245                 Some(ExpansionInfo {
 246                     expanded: InFile::new(self, parse.syntax_node()),
 247                     arg: InFile::new(loc.kind.file_id(), arg_tt),
 248                     attr_input_or_mac_def,
 249                     macro_arg_shift: mbe::Shift::new(&macro_arg.0),
 250                     macro_arg,
 251                     macro_def,
 252                     exp_map,
 253                 })
 254             }
 255         }
 256     }
 257
 258     /// Indicate it is macro file generated for builtin derive
 259     pub fn is_builtin_derive(&self, db: &dyn db::AstDatabase) -> Option<InFile<ast::Item>> {
 260         match self.0 {
 261             HirFileIdRepr::FileId(_) => None,
 262             HirFileIdRepr::MacroFile(macro_file) => {
 263                 let loc: MacroCallLoc = db.lookup_intern_macro_call(macro_file.macro_call_id);
 264                 let item = match loc.def.kind {
 265                     MacroDefKind::BuiltInDerive(..) => loc.kind.to_node(db),
 266                     _ => return None,
 267                 };
 268                 Some(item.with_value(ast::Item::cast(item.value.clone())?))
 269             }
 270         }
 271     }
 272
 273     pub fn is_custom_derive(&self, db: &dyn db::AstDatabase) -> bool {
 274         match self.0 {
 275             HirFileIdRepr::FileId(_) => false,
 276             HirFileIdRepr::MacroFile(macro_file) => {
 277                 let loc: MacroCallLoc = db.lookup_intern_macro_call(macro_file.macro_call_id);
 278                 matches!(loc.def.kind, MacroDefKind::ProcMacro(_, ProcMacroKind::CustomDerive, _))
 279             }
 280         }
 281     }
 282
 283     /// Return whether this file is an include macro
 284     pub fn is_include_macro(&self, db: &dyn db::AstDatabase) -> bool {
 285         match self.0 {
 286             HirFileIdRepr::MacroFile(macro_file) => {
 287                 let loc: MacroCallLoc = db.lookup_intern_macro_call(macro_file.macro_call_id);
 288                 matches!(loc.eager, Some(EagerCallInfo { included_file: Some(_), .. }))
 289             }
 290             _ => false,
 291         }
 292     }
 293
 294     /// Return whether this file is an include macro
 295     pub fn is_attr_macro(&self, db: &dyn db::AstDatabase) -> bool {
 296         match self.0 {
 297             HirFileIdRepr::MacroFile(macro_file) => {
 298                 let loc: MacroCallLoc = db.lookup_intern_macro_call(macro_file.macro_call_id);
 299                 matches!(loc.kind, MacroCallKind::Attr { .. })
 300             }
 301             _ => false,
 302         }
 303     }
 304
 305     pub fn is_macro(self) -> bool {
 306         matches!(self.0, HirFileIdRepr::MacroFile(_))
 307     }
 308
 309     pub fn macro_file(self) -> Option<MacroFile> {
 310         match self.0 {
 311             HirFileIdRepr::FileId(_) => None,
 312             HirFileIdRepr::MacroFile(m) => Some(m),
 313         }
 314     }
 315 }
 316
 317 impl MacroDefId {
 318     pub fn as_lazy_macro(
 319         self,
 320         db: &dyn db::AstDatabase,
 321         krate: CrateId,
 322         kind: MacroCallKind,
 323     ) -> MacroCallId {
 324         db.intern_macro_call(MacroCallLoc { def: self, krate, eager: None, kind })
 325     }
 326
 327     pub fn ast_id(&self) -> Either<AstId<ast::Macro>, AstId<ast::Fn>> {
 328         let id = match self.kind {
 329             MacroDefKind::ProcMacro(.., id) => return Either::Right(id),
 330             MacroDefKind::Declarative(id)
 331             | MacroDefKind::BuiltIn(_, id)
 332             | MacroDefKind::BuiltInAttr(_, id)
 333             | MacroDefKind::BuiltInDerive(_, id)
 334             | MacroDefKind::BuiltInEager(_, id) => id,
 335         };
 336         Either::Left(id)
 337     }
 338
 339     pub fn is_proc_macro(&self) -> bool {
 340         matches!(self.kind, MacroDefKind::ProcMacro(..))
 341     }
 342
 343     pub fn is_attribute(&self) -> bool {
 344         matches!(
 345             self.kind,
 346             MacroDefKind::BuiltInAttr(..) | MacroDefKind::ProcMacro(_, ProcMacroKind::Attr, _)
 347         )
 348     }
 349 }
 350
 351 // FIXME: attribute indices do not account for `cfg_attr`, which means that we'll strip the whole
 352 // `cfg_attr` instead of just one of the attributes it expands to
 353
 354 impl MacroCallKind {
 355     /// Returns the file containing the macro invocation.
 356     fn file_id(&self) -> HirFileId {
 357         match *self {
 358             MacroCallKind::FnLike { ast_id: InFile { file_id, .. }, .. }
 359             | MacroCallKind::Derive { ast_id: InFile { file_id, .. }, .. }
 360             | MacroCallKind::Attr { ast_id: InFile { file_id, .. }, .. } => file_id,
 361         }
 362     }
 363
 364     pub fn to_node(&self, db: &dyn db::AstDatabase) -> InFile<SyntaxNode> {
 365         match self {
 366             MacroCallKind::FnLike { ast_id, .. } => {
 367                 ast_id.with_value(ast_id.to_node(db).syntax().clone())
 368             }
 369             MacroCallKind::Derive { ast_id, .. } => {
 370                 ast_id.with_value(ast_id.to_node(db).syntax().clone())
 371             }
 372             MacroCallKind::Attr { ast_id, .. } => {
 373                 ast_id.with_value(ast_id.to_node(db).syntax().clone())
 374             }
 375         }
 376     }
 377
 378     /// Returns the original file range that best describes the location of this macro call.
 379     ///
 380     /// Here we try to roughly match what rustc does to improve diagnostics: fn-like macros
 381     /// get the whole `ast::MacroCall`, attribute macros get the attribute's range, and derives
 382     /// get only the specific derive that is being referred to.
 383     pub fn original_call_range(self, db: &dyn db::AstDatabase) -> FileRange {
 384         let mut kind = self;
 385         let file_id = loop {
 386             match kind.file_id().0 {
 387                 HirFileIdRepr::MacroFile(file) => {
 388                     kind = db.lookup_intern_macro_call(file.macro_call_id).kind;
 389                 }
 390                 HirFileIdRepr::FileId(file_id) => break file_id,
 391             }
 392         };
 393
 394         let range = match kind {
 395             MacroCallKind::FnLike { ast_id, .. } => ast_id.to_node(db).syntax().text_range(),
 396             MacroCallKind::Derive { ast_id, derive_attr_index, .. } => {
 397                 // FIXME: should be the range of the macro name, not the whole derive
 398                 ast_id
 399                     .to_node(db)
 400                     .doc_comments_and_attrs()
 401                     .nth(derive_attr_index as usize)
 402                     .expect("missing derive")
 403                     .expect_left("derive is a doc comment?")
 404                     .syntax()
 405                     .text_range()
 406             }
 407             MacroCallKind::Attr { ast_id, invoc_attr_index, .. } => ast_id
 408                 .to_node(db)
 409                 .doc_comments_and_attrs()
 410                 .nth(invoc_attr_index as usize)
 411                 .expect("missing attribute")
 412                 .expect_left("attribute macro is a doc comment?")
 413                 .syntax()
 414                 .text_range(),
 415         };
 416
 417         FileRange { range, file_id }
 418     }
 419
 420     fn arg(&self, db: &dyn db::AstDatabase) -> Option<SyntaxNode> {
 421         match self {
 422             MacroCallKind::FnLike { ast_id, .. } => {
 423                 Some(ast_id.to_node(db).token_tree()?.syntax().clone())
 424             }
 425             MacroCallKind::Derive { ast_id, .. } => Some(ast_id.to_node(db).syntax().clone()),
 426             MacroCallKind::Attr { ast_id, .. } => Some(ast_id.to_node(db).syntax().clone()),
 427         }
 428     }
 429
 430     fn expand_to(&self) -> ExpandTo {
 431         match self {
 432             MacroCallKind::FnLike { expand_to, .. } => *expand_to,
 433             MacroCallKind::Derive { .. } => ExpandTo::Items,
 434             MacroCallKind::Attr { .. } => ExpandTo::Items, // is this always correct?
 435         }
 436     }
 437 }
 438
 439 impl MacroCallId {
 440     pub fn as_file(self) -> HirFileId {
 441         MacroFile { macro_call_id: self }.into()
 442     }
 443 }
 444
 445 /// ExpansionInfo mainly describes how to map text range between src and expanded macro
 446 #[derive(Debug, Clone, PartialEq, Eq)]
 447 pub struct ExpansionInfo {
 448     expanded: InFile<SyntaxNode>,
 449     /// The argument TokenTree or item for attributes
 450     arg: InFile<SyntaxNode>,
 451     /// The `macro_rules!` or attribute input.
 452     attr_input_or_mac_def: Option<InFile<ast::TokenTree>>,
 453
 454     macro_def: Arc<TokenExpander>,
 455     macro_arg: Arc<(tt::Subtree, mbe::TokenMap, fixup::SyntaxFixupUndoInfo)>,
 456     /// A shift built from `macro_arg`'s subtree, relevant for attributes as the item is the macro arg
 457     /// and as such we need to shift tokens if they are part of an attributes input instead of their item.
 458     macro_arg_shift: mbe::Shift,
 459     exp_map: Arc<mbe::TokenMap>,
 460 }
 461
 462 impl ExpansionInfo {
 463     pub fn expanded(&self) -> InFile<SyntaxNode> {
 464         self.expanded.clone()
 465     }
 466
 467     pub fn call_node(&self) -> Option<InFile<SyntaxNode>> {
 468         Some(self.arg.with_value(self.arg.value.parent()?))
 469     }
 470
 471     /// Map a token down from macro input into the macro expansion.
 472     ///
 473     /// The inner workings of this function differ slightly depending on the type of macro we are dealing with:
 474     /// - declarative:
 475     ///     For declarative macros, we need to accommodate for the macro definition site(which acts as a second unchanging input)
 476     ///     , as tokens can mapped in and out of it.
 477     ///     To do this we shift all ids in the expansion by the maximum id of the definition site giving us an easy
 478     ///     way to map all the tokens.
 479     /// - attribute:
 480     ///     Attributes have two different inputs, the input tokentree in the attribute node and the item
 481     ///     the attribute is annotating. Similarly as for declarative macros we need to do a shift here
 482     ///     as well. Currently this is done by shifting the attribute input by the maximum id of the item.
 483     /// - function-like and derives:
 484     ///     Both of these only have one simple call site input so no special handling is required here.
 485     pub fn map_token_down(
 486         &self,
 487         db: &dyn db::AstDatabase,
 488         item: Option<ast::Item>,
 489         token: InFile<&SyntaxToken>,
 490     ) -> Option<impl Iterator<Item = InFile<SyntaxToken>> + '_> {
 491         assert_eq!(token.file_id, self.arg.file_id);
 492         let token_id_in_attr_input = if let Some(item) = item {
 493             // check if we are mapping down in an attribute input
 494             // this is a special case as attributes can have two inputs
 495             let call_id = self.expanded.file_id.macro_file()?.macro_call_id;
 496             let loc = db.lookup_intern_macro_call(call_id);
 497
 498             let token_range = token.value.text_range();
 499             match &loc.kind {
 500                 MacroCallKind::Attr { attr_args, invoc_attr_index, .. } => {
 501                     let attr = item
 502                         .doc_comments_and_attrs()
 503                         .nth(*invoc_attr_index as usize)
 504                         .and_then(Either::left)?;
 505                     match attr.token_tree() {
 506                         Some(token_tree)
 507                             if token_tree.syntax().text_range().contains_range(token_range) =>
 508                         {
 509                             let attr_input_start =
 510                                 token_tree.left_delimiter_token()?.text_range().start();
 511                             let relative_range =
 512                                 token.value.text_range().checked_sub(attr_input_start)?;
 513                             // shift by the item's tree's max id
 514                             let token_id = self
 515                                 .macro_arg_shift
 516                                 .shift(attr_args.1.token_by_range(relative_range)?);
 517                             Some(token_id)
 518                         }
 519                         _ => None,
 520                     }
 521                 }
 522                 _ => None,
 523             }
 524         } else {
 525             None
 526         };
 527
 528         let token_id = match token_id_in_attr_input {
 529             Some(token_id) => token_id,
 530             // the token is not inside an attribute's input so do the lookup in the macro_arg as ususal
 531             None => {
 532                 let relative_range =
 533                     token.value.text_range().checked_sub(self.arg.value.text_range().start())?;
 534                 let token_id = self.macro_arg.1.token_by_range(relative_range)?;
 535                 // conditionally shift the id by a declaratives macro definition
 536                 self.macro_def.map_id_down(token_id)
 537             }
 538         };
 539
 540         let tokens = self
 541             .exp_map
 542             .ranges_by_token(token_id, token.value.kind())
 543             .flat_map(move |range| self.expanded.value.covering_element(range).into_token());
 544
 545         Some(tokens.map(move |token| self.expanded.with_value(token)))
 546     }
 547
 548     /// Map a token up out of the expansion it resides in into the arguments of the macro call of the expansion.
 549     pub fn map_token_up(
 550         &self,
 551         db: &dyn db::AstDatabase,
 552         token: InFile<&SyntaxToken>,
 553     ) -> Option<(InFile<SyntaxToken>, Origin)> {
 554         // Fetch the id through its text range,
 555         let token_id = self.exp_map.token_by_range(token.value.text_range())?;
 556         // conditionally unshifting the id to accommodate for macro-rules def site
 557         let (mut token_id, origin) = self.macro_def.map_id_up(token_id);
 558
 559         let call_id = self.expanded.file_id.macro_file()?.macro_call_id;
 560         let loc = db.lookup_intern_macro_call(call_id);
 561
 562         // Attributes are a bit special for us, they have two inputs, the input tokentree and the annotated item.
 563         let (token_map, tt) = match &loc.kind {
 564             MacroCallKind::Attr { attr_args, .. } => {
 565                 // try unshifting the the token id, if unshifting fails, the token resides in the non-item attribute input
 566                 // note that the `TokenExpander::map_id_up` earlier only unshifts for declarative macros, so we don't double unshift with this
 567                 match self.macro_arg_shift.unshift(token_id) {
 568                     Some(unshifted) => {
 569                         token_id = unshifted;
 570                         (&attr_args.1, self.attr_input_or_mac_def.clone()?.syntax().cloned())
 571                     }
 572                     None => (&self.macro_arg.1, self.arg.clone()),
 573                 }
 574             }
 575             _ => match origin {
 576                 mbe::Origin::Call => (&self.macro_arg.1, self.arg.clone()),
 577                 mbe::Origin::Def => match (&*self.macro_def, &self.attr_input_or_mac_def) {
 578                     (TokenExpander::DeclarativeMacro { def_site_token_map, .. }, Some(tt)) => {
 579                         (def_site_token_map, tt.syntax().cloned())
 580                     }
 581                     _ => panic!("`Origin::Def` used with non-`macro_rules!` macro"),
 582                 },
 583             },
 584         };
 585
 586         let range = token_map.first_range_by_token(token_id, token.value.kind())?;
 587         let token =
 588             tt.value.covering_element(range + tt.value.text_range().start()).into_token()?;
 589         Some((tt.with_value(token), origin))
 590     }
 591 }
 592
 593 /// `AstId` points to an AST node in any file.
 594 ///
 595 /// It is stable across reparses, and can be used as salsa key/value.
 596 pub type AstId<N> = InFile<FileAstId<N>>;
 597
 598 impl<N: AstNode> AstId<N> {
 599     pub fn to_node(&self, db: &dyn db::AstDatabase) -> N {
 600         let root = db.parse_or_expand(self.file_id).unwrap();
 601         db.ast_id_map(self.file_id).get(self.value).to_node(&root)
 602     }
 603 }
 604
 605 /// `InFile<T>` stores a value of `T` inside a particular file/syntax tree.
 606 ///
 607 /// Typical usages are:
 608 ///
 609 /// * `InFile<SyntaxNode>` -- syntax node in a file
 610 /// * `InFile<ast::FnDef>` -- ast node in a file
 611 /// * `InFile<TextSize>` -- offset in a file
 612 #[derive(Debug, PartialEq, Eq, Clone, Copy, Hash)]
 613 pub struct InFile<T> {
 614     pub file_id: HirFileId,
 615     pub value: T,
 616 }
 617
 618 impl<T> InFile<T> {
 619     pub fn new(file_id: HirFileId, value: T) -> InFile<T> {
 620         InFile { file_id, value }
 621     }
 622
 623     pub fn with_value<U>(&self, value: U) -> InFile<U> {
 624         InFile::new(self.file_id, value)
 625     }
 626
 627     pub fn map<F: FnOnce(T) -> U, U>(self, f: F) -> InFile<U> {
 628         InFile::new(self.file_id, f(self.value))
 629     }
 630     pub fn as_ref(&self) -> InFile<&T> {
 631         self.with_value(&self.value)
 632     }
 633     pub fn file_syntax(&self, db: &dyn db::AstDatabase) -> SyntaxNode {
 634         db.parse_or_expand(self.file_id).expect("source created from invalid file")
 635     }
 636 }
 637
 638 impl<T: Clone> InFile<&T> {
 639     pub fn cloned(&self) -> InFile<T> {
 640         self.with_value(self.value.clone())
 641     }
 642 }
 643
 644 impl<T> InFile<Option<T>> {
 645     pub fn transpose(self) -> Option<InFile<T>> {
 646         let value = self.value?;
 647         Some(InFile::new(self.file_id, value))
 648     }
 649 }
 650
 651 impl<'a> InFile<&'a SyntaxNode> {
 652     pub fn ancestors_with_macros(
 653         self,
 654         db: &dyn db::AstDatabase,
 655     ) -> impl Iterator<Item = InFile<SyntaxNode>> + Clone + '_ {
 656         iter::successors(Some(self.cloned()), move |node| match node.value.parent() {
 657             Some(parent) => Some(node.with_value(parent)),
 658             None => node.file_id.call_node(db),
 659         })
 660     }
 661
 662     /// Skips the attributed item that caused the macro invocation we are climbing up
 663     pub fn ancestors_with_macros_skip_attr_item(
 664         self,
 665         db: &dyn db::AstDatabase,
 666     ) -> impl Iterator<Item = InFile<SyntaxNode>> + '_ {
 667         iter::successors(Some(self.cloned()), move |node| match node.value.parent() {
 668             Some(parent) => Some(node.with_value(parent)),
 669             None => {
 670                 let parent_node = node.file_id.call_node(db)?;
 671                 if node.file_id.is_attr_macro(db) {
 672                     // macro call was an attributed item, skip it
 673                     // FIXME: does this fail if this is a direct expansion of another macro?
 674                     parent_node.map(|node| node.parent()).transpose()
 675                 } else {
 676                     Some(parent_node)
 677                 }
 678             }
 679         })
 680     }
 681
 682     /// Falls back to the macro call range if the node cannot be mapped up fully.
 683     pub fn original_file_range(self, db: &dyn db::AstDatabase) -> FileRange {
 684         if let Some(res) = self.original_file_range_opt(db) {
 685             return res;
 686         }
 687
 688         // Fall back to whole macro call.
 689         match self.file_id.0 {
 690             HirFileIdRepr::FileId(file_id) => FileRange { file_id, range: self.value.text_range() },
 691             HirFileIdRepr::MacroFile(mac_file) => {
 692                 let loc = db.lookup_intern_macro_call(mac_file.macro_call_id);
 693                 loc.kind.original_call_range(db)
 694             }
 695         }
 696     }
 697
 698     /// Attempts to map the syntax node back up its macro calls.
 699     pub fn original_file_range_opt(self, db: &dyn db::AstDatabase) -> Option<FileRange> {
 700         match ascend_node_border_tokens(db, self) {
 701             Some(InFile { file_id, value: (first, last) }) => {
 702                 let original_file = file_id.original_file(db);
 703                 let range = first.text_range().cover(last.text_range());
 704                 if file_id != original_file.into() {
 705                     tracing::error!("Failed mapping up more for {:?}", range);
 706                     return None;
 707                 }
 708                 Some(FileRange { file_id: original_file, range })
 709             }
 710             _ if !self.file_id.is_macro() => Some(FileRange {
 711                 file_id: self.file_id.original_file(db),
 712                 range: self.value.text_range(),
 713             }),
 714             _ => None,
 715         }
 716     }
 717 }
 718
 719 fn ascend_node_border_tokens(
 720     db: &dyn db::AstDatabase,
 721     InFile { file_id, value: node }: InFile<&SyntaxNode>,
 722 ) -> Option<InFile<(SyntaxToken, SyntaxToken)>> {
 723     let expansion = file_id.expansion_info(db)?;
 724
 725     let first_token = |node: &SyntaxNode| skip_trivia_token(node.first_token()?, Direction::Next);
 726     let last_token = |node: &SyntaxNode| skip_trivia_token(node.last_token()?, Direction::Prev);
 727
 728     let first = first_token(node)?;
 729     let last = last_token(node)?;
 730     let first = ascend_call_token(db, &expansion, InFile::new(file_id, first))?;
 731     let last = ascend_call_token(db, &expansion, InFile::new(file_id, last))?;
 732     (first.file_id == last.file_id).then(|| InFile::new(first.file_id, (first.value, last.value)))
 733 }
 734
 735 fn ascend_call_token(
 736     db: &dyn db::AstDatabase,
 737     expansion: &ExpansionInfo,
 738     token: InFile<SyntaxToken>,
 739 ) -> Option<InFile<SyntaxToken>> {
 740     let mut mapping = expansion.map_token_up(db, token.as_ref())?;
 741     while let (mapped, Origin::Call) = mapping {
 742         match mapped.file_id.expansion_info(db) {
 743             Some(info) => mapping = info.map_token_up(db, mapped.as_ref())?,
 744             None => return Some(mapped),
 745         }
 746     }
 747     None
 748 }
 749
 750 impl InFile<SyntaxToken> {
 751     pub fn ancestors_with_macros(
 752         self,
 753         db: &dyn db::AstDatabase,
 754     ) -> impl Iterator<Item = InFile<SyntaxNode>> + '_ {
 755         self.value.parent().into_iter().flat_map({
 756             let file_id = self.file_id;
 757             move |parent| InFile::new(file_id, &parent).ancestors_with_macros(db)
 758         })
 759     }
 760 }
 761
 762 impl<N: AstNode> InFile<N> {
 763     pub fn descendants<T: AstNode>(self) -> impl Iterator<Item = InFile<T>> {
 764         self.value.syntax().descendants().filter_map(T::cast).map(move |n| self.with_value(n))
 765     }
 766
 767     pub fn original_ast_node(self, db: &dyn db::AstDatabase) -> Option<InFile<N>> {
 768         // This kind of upmapping can only be achieved in attribute expanded files,
 769         // as we don't have node inputs otherwise and  therefor can't find an `N` node in the input
 770         if !self.file_id.is_macro() {
 771             return Some(self);
 772         } else if !self.file_id.is_attr_macro(db) {
 773             return None;
 774         }
 775
 776         if let Some(InFile { file_id, value: (first, last) }) =
 777             ascend_node_border_tokens(db, self.syntax())
 778         {
 779             if file_id.is_macro() {
 780                 let range = first.text_range().cover(last.text_range());
 781                 tracing::error!("Failed mapping out of macro file for {:?}", range);
 782                 return None;
 783             }
 784             // FIXME: This heuristic is brittle and with the right macro may select completely unrelated nodes
 785             let anc = algo::least_common_ancestor(&first.parent()?, &last.parent()?)?;
 786             let value = anc.ancestors().find_map(N::cast)?;
 787             return Some(InFile::new(file_id, value));
 788         }
 789         None
 790     }
 791
 792     pub fn syntax(&self) -> InFile<&SyntaxNode> {
 793         self.with_value(self.value.syntax())
 794     }
 795 }
 796
 797 /// In Rust, macros expand token trees to token trees. When we want to turn a
 798 /// token tree into an AST node, we need to figure out what kind of AST node we
 799 /// want: something like `foo` can be a type, an expression, or a pattern.
 800 ///
 801 /// Naively, one would think that "what this expands to" is a property of a
 802 /// particular macro: macro `m1` returns an item, while macro `m2` returns an
 803 /// expression, etc. That's not the case -- macros are polymorphic in the
 804 /// result, and can expand to any type of the AST node.
 805 ///
 806 /// What defines the actual AST node is the syntactic context of the macro
 807 /// invocation. As a contrived example, in `let T![*] = T![*];` the first `T`
 808 /// expands to a pattern, while the second one expands to an expression.
 809 ///
 810 /// `ExpandTo` captures this bit of information about a particular macro call
 811 /// site.
 812 #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
 813 pub enum ExpandTo {
 814     Statements,
 815     Items,
 816     Pattern,
 817     Type,
 818     Expr,
 819 }
 820
 821 impl ExpandTo {
 822     pub fn from_call_site(call: &ast::MacroCall) -> ExpandTo {
 823         use syntax::SyntaxKind::*;
 824
 825         let syn = call.syntax();
 826
 827         let parent = match syn.parent() {
 828             Some(it) => it,
 829             None => return ExpandTo::Statements,
 830         };
 831
 832         match parent.kind() {
 833             MACRO_ITEMS | SOURCE_FILE | ITEM_LIST => ExpandTo::Items,
 834             MACRO_STMTS | EXPR_STMT | STMT_LIST => ExpandTo::Statements,
 835             MACRO_PAT => ExpandTo::Pattern,
 836             MACRO_TYPE => ExpandTo::Type,
 837
 838             ARG_LIST | TRY_EXPR | TUPLE_EXPR | PAREN_EXPR | ARRAY_EXPR | FOR_EXPR | PATH_EXPR
 839             | CLOSURE_EXPR | BREAK_EXPR | RETURN_EXPR | MATCH_EXPR | MATCH_ARM | MATCH_GUARD
 840             | RECORD_EXPR_FIELD | CALL_EXPR | INDEX_EXPR | METHOD_CALL_EXPR | FIELD_EXPR
 841             | AWAIT_EXPR | CAST_EXPR | REF_EXPR | PREFIX_EXPR | RANGE_EXPR | BIN_EXPR
 842             | LET_EXPR => ExpandTo::Expr,
 843             LET_STMT => {
 844                 // FIXME: Handle LHS Pattern
 845                 ExpandTo::Expr
 846             }
 847
 848             _ => {
 849                 // Unknown , Just guess it is `Items`
 850                 ExpandTo::Items
 851             }
 852         }
 853     }
 854 }
 855
 856 #[derive(Debug)]
 857 pub struct UnresolvedMacro {
 858     pub path: ModPath,
 859 }