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