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         is_derive: bool,
 170     },
 171 }
 172
 173 impl HirFileId {
 174     /// For macro-expansion files, returns the file original source file the
 175     /// expansion originated from.
 176     pub fn original_file(self, db: &dyn db::AstDatabase) -> FileId {
 177         match self.0 {
 178             HirFileIdRepr::FileId(file_id) => file_id,
 179             HirFileIdRepr::MacroFile(macro_file) => {
 180                 let loc: MacroCallLoc = db.lookup_intern_macro_call(macro_file.macro_call_id);
 181                 let file_id = match loc.eager {
 182                     Some(EagerCallInfo { included_file: Some(file), .. }) => file.into(),
 183                     _ => loc.kind.file_id(),
 184                 };
 185                 file_id.original_file(db)
 186             }
 187         }
 188     }
 189
 190     pub fn expansion_level(self, db: &dyn db::AstDatabase) -> u32 {
 191         let mut level = 0;
 192         let mut curr = self;
 193         while let HirFileIdRepr::MacroFile(macro_file) = curr.0 {
 194             let loc: MacroCallLoc = db.lookup_intern_macro_call(macro_file.macro_call_id);
 195
 196             level += 1;
 197             curr = loc.kind.file_id();
 198         }
 199         level
 200     }
 201
 202     /// If this is a macro call, returns the syntax node of the call.
 203     pub fn call_node(self, db: &dyn db::AstDatabase) -> Option<InFile<SyntaxNode>> {
 204         match self.0 {
 205             HirFileIdRepr::FileId(_) => None,
 206             HirFileIdRepr::MacroFile(macro_file) => {
 207                 let loc: MacroCallLoc = db.lookup_intern_macro_call(macro_file.macro_call_id);
 208                 Some(loc.kind.to_node(db))
 209             }
 210         }
 211     }
 212
 213     /// Return expansion information if it is a macro-expansion file
 214     pub fn expansion_info(self, db: &dyn db::AstDatabase) -> Option<ExpansionInfo> {
 215         match self.0 {
 216             HirFileIdRepr::FileId(_) => None,
 217             HirFileIdRepr::MacroFile(macro_file) => {
 218                 let loc: MacroCallLoc = db.lookup_intern_macro_call(macro_file.macro_call_id);
 219
 220                 let arg_tt = loc.kind.arg(db)?;
 221
 222                 let macro_def = db.macro_def(loc.def).ok()?;
 223                 let (parse, exp_map) = db.parse_macro_expansion(macro_file).value?;
 224                 let macro_arg = db.macro_arg(macro_file.macro_call_id)?;
 225
 226                 let def = loc.def.ast_id().left().and_then(|id| {
 227                     let def_tt = match id.to_node(db) {
 228                         ast::Macro::MacroRules(mac) => mac.token_tree()?,
 229                         ast::Macro::MacroDef(_)
 230                             if matches!(*macro_def, TokenExpander::BuiltinAttr(_)) =>
 231                         {
 232                             return None
 233                         }
 234                         ast::Macro::MacroDef(mac) => mac.body()?,
 235                     };
 236                     Some(InFile::new(id.file_id, def_tt))
 237                 });
 238                 let attr_input_or_mac_def = def.or_else(|| match loc.kind {
 239                     MacroCallKind::Attr { ast_id, invoc_attr_index, .. } => {
 240                         let tt = ast_id
 241                             .to_node(db)
 242                             .doc_comments_and_attrs()
 243                             .nth(invoc_attr_index as usize)
 244                             .and_then(Either::left)?
 245                             .token_tree()?;
 246                         Some(InFile::new(ast_id.file_id, tt))
 247                     }
 248                     _ => None,
 249                 });
 250
 251                 Some(ExpansionInfo {
 252                     expanded: InFile::new(self, parse.syntax_node()),
 253                     arg: InFile::new(loc.kind.file_id(), arg_tt),
 254                     attr_input_or_mac_def,
 255                     macro_arg_shift: mbe::Shift::new(&macro_arg.0),
 256                     macro_arg,
 257                     macro_def,
 258                     exp_map,
 259                 })
 260             }
 261         }
 262     }
 263
 264     /// Indicate it is macro file generated for builtin derive
 265     pub fn is_builtin_derive(&self, db: &dyn db::AstDatabase) -> Option<InFile<ast::Item>> {
 266         match self.0 {
 267             HirFileIdRepr::FileId(_) => None,
 268             HirFileIdRepr::MacroFile(macro_file) => {
 269                 let loc: MacroCallLoc = db.lookup_intern_macro_call(macro_file.macro_call_id);
 270                 let item = match loc.def.kind {
 271                     MacroDefKind::BuiltInDerive(..) => loc.kind.to_node(db),
 272                     _ => return None,
 273                 };
 274                 Some(item.with_value(ast::Item::cast(item.value.clone())?))
 275             }
 276         }
 277     }
 278
 279     pub fn is_custom_derive(&self, db: &dyn db::AstDatabase) -> bool {
 280         match self.0 {
 281             HirFileIdRepr::FileId(_) => false,
 282             HirFileIdRepr::MacroFile(macro_file) => {
 283                 let loc: MacroCallLoc = db.lookup_intern_macro_call(macro_file.macro_call_id);
 284                 matches!(loc.def.kind, MacroDefKind::ProcMacro(_, ProcMacroKind::CustomDerive, _))
 285             }
 286         }
 287     }
 288
 289     /// Return whether this file is an include macro
 290     pub fn is_include_macro(&self, db: &dyn db::AstDatabase) -> bool {
 291         match self.0 {
 292             HirFileIdRepr::MacroFile(macro_file) => {
 293                 let loc: MacroCallLoc = db.lookup_intern_macro_call(macro_file.macro_call_id);
 294                 matches!(loc.eager, Some(EagerCallInfo { included_file: Some(_), .. }))
 295             }
 296             _ => false,
 297         }
 298     }
 299
 300     /// Return whether this file is an attr macro
 301     pub fn is_attr_macro(&self, db: &dyn db::AstDatabase) -> bool {
 302         match self.0 {
 303             HirFileIdRepr::MacroFile(macro_file) => {
 304                 let loc: MacroCallLoc = db.lookup_intern_macro_call(macro_file.macro_call_id);
 305                 matches!(loc.kind, MacroCallKind::Attr { .. })
 306             }
 307             _ => false,
 308         }
 309     }
 310
 311     /// Return whether this file is the pseudo expansion of the derive attribute.
 312     pub fn is_derive_attr_macro(&self, db: &dyn db::AstDatabase) -> bool {
 313         match self.0 {
 314             HirFileIdRepr::MacroFile(macro_file) => {
 315                 let loc: MacroCallLoc = db.lookup_intern_macro_call(macro_file.macro_call_id);
 316                 matches!(loc.kind, MacroCallKind::Attr { is_derive: true, .. })
 317             }
 318             _ => false,
 319         }
 320     }
 321
 322     pub fn is_macro(self) -> bool {
 323         matches!(self.0, HirFileIdRepr::MacroFile(_))
 324     }
 325
 326     pub fn macro_file(self) -> Option<MacroFile> {
 327         match self.0 {
 328             HirFileIdRepr::FileId(_) => None,
 329             HirFileIdRepr::MacroFile(m) => Some(m),
 330         }
 331     }
 332 }
 333
 334 impl MacroDefId {
 335     pub fn as_lazy_macro(
 336         self,
 337         db: &dyn db::AstDatabase,
 338         krate: CrateId,
 339         kind: MacroCallKind,
 340     ) -> MacroCallId {
 341         db.intern_macro_call(MacroCallLoc { def: self, krate, eager: None, kind })
 342     }
 343
 344     pub fn ast_id(&self) -> Either<AstId<ast::Macro>, AstId<ast::Fn>> {
 345         let id = match self.kind {
 346             MacroDefKind::ProcMacro(.., id) => return Either::Right(id),
 347             MacroDefKind::Declarative(id)
 348             | MacroDefKind::BuiltIn(_, id)
 349             | MacroDefKind::BuiltInAttr(_, id)
 350             | MacroDefKind::BuiltInDerive(_, id)
 351             | MacroDefKind::BuiltInEager(_, id) => id,
 352         };
 353         Either::Left(id)
 354     }
 355
 356     pub fn is_proc_macro(&self) -> bool {
 357         matches!(self.kind, MacroDefKind::ProcMacro(..))
 358     }
 359
 360     pub fn is_attribute(&self) -> bool {
 361         matches!(
 362             self.kind,
 363             MacroDefKind::BuiltInAttr(..) | MacroDefKind::ProcMacro(_, ProcMacroKind::Attr, _)
 364         )
 365     }
 366 }
 367
 368 // FIXME: attribute indices do not account for `cfg_attr`, which means that we'll strip the whole
 369 // `cfg_attr` instead of just one of the attributes it expands to
 370
 371 impl MacroCallKind {
 372     /// Returns the file containing the macro invocation.
 373     fn file_id(&self) -> HirFileId {
 374         match *self {
 375             MacroCallKind::FnLike { ast_id: InFile { file_id, .. }, .. }
 376             | MacroCallKind::Derive { ast_id: InFile { file_id, .. }, .. }
 377             | MacroCallKind::Attr { ast_id: InFile { file_id, .. }, .. } => file_id,
 378         }
 379     }
 380
 381     pub fn to_node(&self, db: &dyn db::AstDatabase) -> InFile<SyntaxNode> {
 382         match self {
 383             MacroCallKind::FnLike { ast_id, .. } => {
 384                 ast_id.with_value(ast_id.to_node(db).syntax().clone())
 385             }
 386             MacroCallKind::Derive { ast_id, .. } => {
 387                 ast_id.with_value(ast_id.to_node(db).syntax().clone())
 388             }
 389             MacroCallKind::Attr { ast_id, .. } => {
 390                 ast_id.with_value(ast_id.to_node(db).syntax().clone())
 391             }
 392         }
 393     }
 394
 395     /// Returns the original file range that best describes the location of this macro call.
 396     ///
 397     /// Here we try to roughly match what rustc does to improve diagnostics: fn-like macros
 398     /// get the whole `ast::MacroCall`, attribute macros get the attribute's range, and derives
 399     /// get only the specific derive that is being referred to.
 400     pub fn original_call_range(self, db: &dyn db::AstDatabase) -> FileRange {
 401         let mut kind = self;
 402         let file_id = loop {
 403             match kind.file_id().0 {
 404                 HirFileIdRepr::MacroFile(file) => {
 405                     kind = db.lookup_intern_macro_call(file.macro_call_id).kind;
 406                 }
 407                 HirFileIdRepr::FileId(file_id) => break file_id,
 408             }
 409         };
 410
 411         let range = match kind {
 412             MacroCallKind::FnLike { ast_id, .. } => ast_id.to_node(db).syntax().text_range(),
 413             MacroCallKind::Derive { ast_id, derive_attr_index, .. } => {
 414                 // FIXME: should be the range of the macro name, not the whole derive
 415                 ast_id
 416                     .to_node(db)
 417                     .doc_comments_and_attrs()
 418                     .nth(derive_attr_index as usize)
 419                     .expect("missing derive")
 420                     .expect_left("derive is a doc comment?")
 421                     .syntax()
 422                     .text_range()
 423             }
 424             MacroCallKind::Attr { ast_id, invoc_attr_index, .. } => ast_id
 425                 .to_node(db)
 426                 .doc_comments_and_attrs()
 427                 .nth(invoc_attr_index as usize)
 428                 .expect("missing attribute")
 429                 .expect_left("attribute macro is a doc comment?")
 430                 .syntax()
 431                 .text_range(),
 432         };
 433
 434         FileRange { range, file_id }
 435     }
 436
 437     fn arg(&self, db: &dyn db::AstDatabase) -> Option<SyntaxNode> {
 438         match self {
 439             MacroCallKind::FnLike { ast_id, .. } => {
 440                 Some(ast_id.to_node(db).token_tree()?.syntax().clone())
 441             }
 442             MacroCallKind::Derive { ast_id, .. } => Some(ast_id.to_node(db).syntax().clone()),
 443             MacroCallKind::Attr { ast_id, .. } => Some(ast_id.to_node(db).syntax().clone()),
 444         }
 445     }
 446
 447     fn expand_to(&self) -> ExpandTo {
 448         match self {
 449             MacroCallKind::FnLike { expand_to, .. } => *expand_to,
 450             MacroCallKind::Derive { .. } => ExpandTo::Items,
 451             MacroCallKind::Attr { is_derive: true, .. } => ExpandTo::Statements,
 452             MacroCallKind::Attr { .. } => ExpandTo::Items, // is this always correct?
 453         }
 454     }
 455 }
 456
 457 impl MacroCallId {
 458     pub fn as_file(self) -> HirFileId {
 459         MacroFile { macro_call_id: self }.into()
 460     }
 461 }
 462
 463 /// ExpansionInfo mainly describes how to map text range between src and expanded macro
 464 #[derive(Debug, Clone, PartialEq, Eq)]
 465 pub struct ExpansionInfo {
 466     expanded: InFile<SyntaxNode>,
 467     /// The argument TokenTree or item for attributes
 468     arg: InFile<SyntaxNode>,
 469     /// The `macro_rules!` or attribute input.
 470     attr_input_or_mac_def: Option<InFile<ast::TokenTree>>,
 471
 472     macro_def: Arc<TokenExpander>,
 473     macro_arg: Arc<(tt::Subtree, mbe::TokenMap, fixup::SyntaxFixupUndoInfo)>,
 474     /// A shift built from `macro_arg`'s subtree, relevant for attributes as the item is the macro arg
 475     /// and as such we need to shift tokens if they are part of an attributes input instead of their item.
 476     macro_arg_shift: mbe::Shift,
 477     exp_map: Arc<mbe::TokenMap>,
 478 }
 479
 480 impl ExpansionInfo {
 481     pub fn expanded(&self) -> InFile<SyntaxNode> {
 482         self.expanded.clone()
 483     }
 484
 485     pub fn call_node(&self) -> Option<InFile<SyntaxNode>> {
 486         Some(self.arg.with_value(self.arg.value.parent()?))
 487     }
 488
 489     /// Map a token down from macro input into the macro expansion.
 490     ///
 491     /// The inner workings of this function differ slightly depending on the type of macro we are dealing with:
 492     /// - declarative:
 493     ///     For declarative macros, we need to accommodate for the macro definition site(which acts as a second unchanging input)
 494     ///     , as tokens can mapped in and out of it.
 495     ///     To do this we shift all ids in the expansion by the maximum id of the definition site giving us an easy
 496     ///     way to map all the tokens.
 497     /// - attribute:
 498     ///     Attributes have two different inputs, the input tokentree in the attribute node and the item
 499     ///     the attribute is annotating. Similarly as for declarative macros we need to do a shift here
 500     ///     as well. Currently this is done by shifting the attribute input by the maximum id of the item.
 501     /// - function-like and derives:
 502     ///     Both of these only have one simple call site input so no special handling is required here.
 503     pub fn map_token_down(
 504         &self,
 505         db: &dyn db::AstDatabase,
 506         item: Option<ast::Item>,
 507         token: InFile<&SyntaxToken>,
 508     ) -> Option<impl Iterator<Item = InFile<SyntaxToken>> + '_> {
 509         assert_eq!(token.file_id, self.arg.file_id);
 510         let token_id_in_attr_input = if let Some(item) = item {
 511             // check if we are mapping down in an attribute input
 512             // this is a special case as attributes can have two inputs
 513             let call_id = self.expanded.file_id.macro_file()?.macro_call_id;
 514             let loc = db.lookup_intern_macro_call(call_id);
 515
 516             let token_range = token.value.text_range();
 517             match &loc.kind {
 518                 MacroCallKind::Attr { attr_args, invoc_attr_index, is_derive, .. } => {
 519                     let attr = item
 520                         .doc_comments_and_attrs()
 521                         .nth(*invoc_attr_index as usize)
 522                         .and_then(Either::left)?;
 523                     match attr.token_tree() {
 524                         Some(token_tree)
 525                             if token_tree.syntax().text_range().contains_range(token_range) =>
 526                         {
 527                             let attr_input_start =
 528                                 token_tree.left_delimiter_token()?.text_range().start();
 529                             let relative_range =
 530                                 token.value.text_range().checked_sub(attr_input_start)?;
 531                             // shift by the item's tree's max id
 532                             let token_id = attr_args.1.token_by_range(relative_range)?;
 533                             let token_id = if *is_derive {
 534                                 // we do not shift for `#[derive]`, as we only need to downmap the derive attribute tokens
 535                                 token_id
 536                             } else {
 537                                 self.macro_arg_shift.shift(token_id)
 538                             };
 539                             Some(token_id)
 540                         }
 541                         _ => None,
 542                     }
 543                 }
 544                 _ => None,
 545             }
 546         } else {
 547             None
 548         };
 549
 550         let token_id = match token_id_in_attr_input {
 551             Some(token_id) => token_id,
 552             // the token is not inside an attribute's input so do the lookup in the macro_arg as ususal
 553             None => {
 554                 let relative_range =
 555                     token.value.text_range().checked_sub(self.arg.value.text_range().start())?;
 556                 let token_id = self.macro_arg.1.token_by_range(relative_range)?;
 557                 // conditionally shift the id by a declaratives macro definition
 558                 self.macro_def.map_id_down(token_id)
 559             }
 560         };
 561
 562         let tokens = self
 563             .exp_map
 564             .ranges_by_token(token_id, token.value.kind())
 565             .flat_map(move |range| self.expanded.value.covering_element(range).into_token());
 566
 567         Some(tokens.map(move |token| self.expanded.with_value(token)))
 568     }
 569
 570     /// Map a token up out of the expansion it resides in into the arguments of the macro call of the expansion.
 571     pub fn map_token_up(
 572         &self,
 573         db: &dyn db::AstDatabase,
 574         token: InFile<&SyntaxToken>,
 575     ) -> Option<(InFile<SyntaxToken>, Origin)> {
 576         // Fetch the id through its text range,
 577         let token_id = self.exp_map.token_by_range(token.value.text_range())?;
 578         // conditionally unshifting the id to accommodate for macro-rules def site
 579         let (mut token_id, origin) = self.macro_def.map_id_up(token_id);
 580
 581         let call_id = self.expanded.file_id.macro_file()?.macro_call_id;
 582         let loc = db.lookup_intern_macro_call(call_id);
 583
 584         // Attributes are a bit special for us, they have two inputs, the input tokentree and the annotated item.
 585         let (token_map, tt) = match &loc.kind {
 586             MacroCallKind::Attr { attr_args, is_derive: true, .. } => {
 587                 (&attr_args.1, self.attr_input_or_mac_def.clone()?.syntax().cloned())
 588             }
 589             MacroCallKind::Attr { attr_args, .. } => {
 590                 // try unshifting the the token id, if unshifting fails, the token resides in the non-item attribute input
 591                 // note that the `TokenExpander::map_id_up` earlier only unshifts for declarative macros, so we don't double unshift with this
 592                 match self.macro_arg_shift.unshift(token_id) {
 593                     Some(unshifted) => {
 594                         token_id = unshifted;
 595                         (&attr_args.1, self.attr_input_or_mac_def.clone()?.syntax().cloned())
 596                     }
 597                     None => (&self.macro_arg.1, self.arg.clone()),
 598                 }
 599             }
 600             _ => match origin {
 601                 mbe::Origin::Call => (&self.macro_arg.1, self.arg.clone()),
 602                 mbe::Origin::Def => match (&*self.macro_def, &self.attr_input_or_mac_def) {
 603                     (TokenExpander::DeclarativeMacro { def_site_token_map, .. }, Some(tt)) => {
 604                         (def_site_token_map, tt.syntax().cloned())
 605                     }
 606                     _ => panic!("`Origin::Def` used with non-`macro_rules!` macro"),
 607                 },
 608             },
 609         };
 610
 611         let range = token_map.first_range_by_token(token_id, token.value.kind())?;
 612         let token =
 613             tt.value.covering_element(range + tt.value.text_range().start()).into_token()?;
 614         Some((tt.with_value(token), origin))
 615     }
 616 }
 617
 618 /// `AstId` points to an AST node in any file.
 619 ///
 620 /// It is stable across reparses, and can be used as salsa key/value.
 621 pub type AstId<N> = InFile<FileAstId<N>>;
 622
 623 impl<N: AstNode> AstId<N> {
 624     pub fn to_node(&self, db: &dyn db::AstDatabase) -> N {
 625         let root = db.parse_or_expand(self.file_id).unwrap();
 626         db.ast_id_map(self.file_id).get(self.value).to_node(&root)
 627     }
 628 }
 629
 630 /// `InFile<T>` stores a value of `T` inside a particular file/syntax tree.
 631 ///
 632 /// Typical usages are:
 633 ///
 634 /// * `InFile<SyntaxNode>` -- syntax node in a file
 635 /// * `InFile<ast::FnDef>` -- ast node in a file
 636 /// * `InFile<TextSize>` -- offset in a file
 637 #[derive(Debug, PartialEq, Eq, Clone, Copy, Hash)]
 638 pub struct InFile<T> {
 639     pub file_id: HirFileId,
 640     pub value: T,
 641 }
 642
 643 impl<T> InFile<T> {
 644     pub fn new(file_id: HirFileId, value: T) -> InFile<T> {
 645         InFile { file_id, value }
 646     }
 647
 648     pub fn with_value<U>(&self, value: U) -> InFile<U> {
 649         InFile::new(self.file_id, value)
 650     }
 651
 652     pub fn map<F: FnOnce(T) -> U, U>(self, f: F) -> InFile<U> {
 653         InFile::new(self.file_id, f(self.value))
 654     }
 655     pub fn as_ref(&self) -> InFile<&T> {
 656         self.with_value(&self.value)
 657     }
 658     pub fn file_syntax(&self, db: &dyn db::AstDatabase) -> SyntaxNode {
 659         db.parse_or_expand(self.file_id).expect("source created from invalid file")
 660     }
 661 }
 662
 663 impl<T: Clone> InFile<&T> {
 664     pub fn cloned(&self) -> InFile<T> {
 665         self.with_value(self.value.clone())
 666     }
 667 }
 668
 669 impl<T> InFile<Option<T>> {
 670     pub fn transpose(self) -> Option<InFile<T>> {
 671         let value = self.value?;
 672         Some(InFile::new(self.file_id, value))
 673     }
 674 }
 675
 676 impl<'a> InFile<&'a SyntaxNode> {
 677     pub fn ancestors_with_macros(
 678         self,
 679         db: &dyn db::AstDatabase,
 680     ) -> impl Iterator<Item = InFile<SyntaxNode>> + Clone + '_ {
 681         iter::successors(Some(self.cloned()), move |node| match node.value.parent() {
 682             Some(parent) => Some(node.with_value(parent)),
 683             None => node.file_id.call_node(db),
 684         })
 685     }
 686
 687     /// Skips the attributed item that caused the macro invocation we are climbing up
 688     pub fn ancestors_with_macros_skip_attr_item(
 689         self,
 690         db: &dyn db::AstDatabase,
 691     ) -> impl Iterator<Item = InFile<SyntaxNode>> + '_ {
 692         iter::successors(Some(self.cloned()), move |node| match node.value.parent() {
 693             Some(parent) => Some(node.with_value(parent)),
 694             None => {
 695                 let parent_node = node.file_id.call_node(db)?;
 696                 if node.file_id.is_attr_macro(db) {
 697                     // macro call was an attributed item, skip it
 698                     // FIXME: does this fail if this is a direct expansion of another macro?
 699                     parent_node.map(|node| node.parent()).transpose()
 700                 } else {
 701                     Some(parent_node)
 702                 }
 703             }
 704         })
 705     }
 706
 707     /// Falls back to the macro call range if the node cannot be mapped up fully.
 708     pub fn original_file_range(self, db: &dyn db::AstDatabase) -> FileRange {
 709         if let Some(res) = self.original_file_range_opt(db) {
 710             return res;
 711         }
 712
 713         // Fall back to whole macro call.
 714         match self.file_id.0 {
 715             HirFileIdRepr::FileId(file_id) => FileRange { file_id, range: self.value.text_range() },
 716             HirFileIdRepr::MacroFile(mac_file) => {
 717                 let loc = db.lookup_intern_macro_call(mac_file.macro_call_id);
 718                 loc.kind.original_call_range(db)
 719             }
 720         }
 721     }
 722
 723     /// Attempts to map the syntax node back up its macro calls.
 724     pub fn original_file_range_opt(self, db: &dyn db::AstDatabase) -> Option<FileRange> {
 725         match ascend_node_border_tokens(db, self) {
 726             Some(InFile { file_id, value: (first, last) }) => {
 727                 let original_file = file_id.original_file(db);
 728                 let range = first.text_range().cover(last.text_range());
 729                 if file_id != original_file.into() {
 730                     tracing::error!("Failed mapping up more for {:?}", range);
 731                     return None;
 732                 }
 733                 Some(FileRange { file_id: original_file, range })
 734             }
 735             _ if !self.file_id.is_macro() => Some(FileRange {
 736                 file_id: self.file_id.original_file(db),
 737                 range: self.value.text_range(),
 738             }),
 739             _ => None,
 740         }
 741     }
 742 }
 743
 744 impl InFile<SyntaxToken> {
 745     pub fn upmap(self, db: &dyn db::AstDatabase) -> Option<InFile<SyntaxToken>> {
 746         let expansion = self.file_id.expansion_info(db)?;
 747         expansion.map_token_up(db, self.as_ref()).map(|(it, _)| it)
 748     }
 749 }
 750
 751 fn ascend_node_border_tokens(
 752     db: &dyn db::AstDatabase,
 753     InFile { file_id, value: node }: InFile<&SyntaxNode>,
 754 ) -> Option<InFile<(SyntaxToken, SyntaxToken)>> {
 755     let expansion = file_id.expansion_info(db)?;
 756
 757     let first_token = |node: &SyntaxNode| skip_trivia_token(node.first_token()?, Direction::Next);
 758     let last_token = |node: &SyntaxNode| skip_trivia_token(node.last_token()?, Direction::Prev);
 759
 760     let first = first_token(node)?;
 761     let last = last_token(node)?;
 762     let first = ascend_call_token(db, &expansion, InFile::new(file_id, first))?;
 763     let last = ascend_call_token(db, &expansion, InFile::new(file_id, last))?;
 764     (first.file_id == last.file_id).then(|| InFile::new(first.file_id, (first.value, last.value)))
 765 }
 766
 767 fn ascend_call_token(
 768     db: &dyn db::AstDatabase,
 769     expansion: &ExpansionInfo,
 770     token: InFile<SyntaxToken>,
 771 ) -> Option<InFile<SyntaxToken>> {
 772     let mut mapping = expansion.map_token_up(db, token.as_ref())?;
 773     while let (mapped, Origin::Call) = mapping {
 774         match mapped.file_id.expansion_info(db) {
 775             Some(info) => mapping = info.map_token_up(db, mapped.as_ref())?,
 776             None => return Some(mapped),
 777         }
 778     }
 779     None
 780 }
 781
 782 impl InFile<SyntaxToken> {
 783     pub fn ancestors_with_macros(
 784         self,
 785         db: &dyn db::AstDatabase,
 786     ) -> impl Iterator<Item = InFile<SyntaxNode>> + '_ {
 787         self.value.parent().into_iter().flat_map({
 788             let file_id = self.file_id;
 789             move |parent| InFile::new(file_id, &parent).ancestors_with_macros(db)
 790         })
 791     }
 792 }
 793
 794 impl<N: AstNode> InFile<N> {
 795     pub fn descendants<T: AstNode>(self) -> impl Iterator<Item = InFile<T>> {
 796         self.value.syntax().descendants().filter_map(T::cast).map(move |n| self.with_value(n))
 797     }
 798
 799     pub fn original_ast_node(self, db: &dyn db::AstDatabase) -> Option<InFile<N>> {
 800         // This kind of upmapping can only be achieved in attribute expanded files,
 801         // as we don't have node inputs otherwise and  therefor can't find an `N` node in the input
 802         if !self.file_id.is_macro() {
 803             return Some(self);
 804         } else if !self.file_id.is_attr_macro(db) {
 805             return None;
 806         }
 807
 808         if let Some(InFile { file_id, value: (first, last) }) =
 809             ascend_node_border_tokens(db, self.syntax())
 810         {
 811             if file_id.is_macro() {
 812                 let range = first.text_range().cover(last.text_range());
 813                 tracing::error!("Failed mapping out of macro file for {:?}", range);
 814                 return None;
 815             }
 816             // FIXME: This heuristic is brittle and with the right macro may select completely unrelated nodes
 817             let anc = algo::least_common_ancestor(&first.parent()?, &last.parent()?)?;
 818             let value = anc.ancestors().find_map(N::cast)?;
 819             return Some(InFile::new(file_id, value));
 820         }
 821         None
 822     }
 823
 824     pub fn syntax(&self) -> InFile<&SyntaxNode> {
 825         self.with_value(self.value.syntax())
 826     }
 827 }
 828
 829 /// In Rust, macros expand token trees to token trees. When we want to turn a
 830 /// token tree into an AST node, we need to figure out what kind of AST node we
 831 /// want: something like `foo` can be a type, an expression, or a pattern.
 832 ///
 833 /// Naively, one would think that "what this expands to" is a property of a
 834 /// particular macro: macro `m1` returns an item, while macro `m2` returns an
 835 /// expression, etc. That's not the case -- macros are polymorphic in the
 836 /// result, and can expand to any type of the AST node.
 837 ///
 838 /// What defines the actual AST node is the syntactic context of the macro
 839 /// invocation. As a contrived example, in `let T![*] = T![*];` the first `T`
 840 /// expands to a pattern, while the second one expands to an expression.
 841 ///
 842 /// `ExpandTo` captures this bit of information about a particular macro call
 843 /// site.
 844 #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
 845 pub enum ExpandTo {
 846     Statements,
 847     Items,
 848     Pattern,
 849     Type,
 850     Expr,
 851 }
 852
 853 impl ExpandTo {
 854     pub fn from_call_site(call: &ast::MacroCall) -> ExpandTo {
 855         use syntax::SyntaxKind::*;
 856
 857         let syn = call.syntax();
 858
 859         let parent = match syn.parent() {
 860             Some(it) => it,
 861             None => return ExpandTo::Statements,
 862         };
 863
 864         match parent.kind() {
 865             MACRO_ITEMS | SOURCE_FILE | ITEM_LIST => ExpandTo::Items,
 866             MACRO_STMTS | EXPR_STMT | STMT_LIST => ExpandTo::Statements,
 867             MACRO_PAT => ExpandTo::Pattern,
 868             MACRO_TYPE => ExpandTo::Type,
 869
 870             ARG_LIST | TRY_EXPR | TUPLE_EXPR | PAREN_EXPR | ARRAY_EXPR | FOR_EXPR | PATH_EXPR
 871             | CLOSURE_EXPR | BREAK_EXPR | RETURN_EXPR | MATCH_EXPR | MATCH_ARM | MATCH_GUARD
 872             | RECORD_EXPR_FIELD | CALL_EXPR | INDEX_EXPR | METHOD_CALL_EXPR | FIELD_EXPR
 873             | AWAIT_EXPR | CAST_EXPR | REF_EXPR | PREFIX_EXPR | RANGE_EXPR | BIN_EXPR
 874             | LET_EXPR => ExpandTo::Expr,
 875             LET_STMT => {
 876                 // FIXME: Handle LHS Pattern
 877                 ExpandTo::Expr
 878             }
 879
 880             _ => {
 881                 // Unknown , Just guess it is `Items`
 882                 ExpandTo::Items
 883             }
 884         }
 885     }
 886 }
 887
 888 #[derive(Debug)]
 889 pub struct UnresolvedMacro {
 890     pub path: ModPath,
 891 }