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;
  12 pub mod builtin_derive;
  13 pub mod builtin_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, AttrsOwner},
  29     Direction, SyntaxNode, SyntaxToken, TextRange, TextSize,
  30 };
  31
  32 use crate::{
  33     ast_id_map::FileAstId,
  34     builtin_attr::BuiltinAttrExpander,
  35     builtin_derive::BuiltinDeriveExpander,
  36     builtin_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)?;
 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     /// Return whether this file is an include macro
 179     pub fn is_include_macro(&self, db: &dyn db::AstDatabase) -> bool {
 180         match self.0 {
 181             HirFileIdRepr::MacroFile(macro_file) => {
 182                 let loc: MacroCallLoc = db.lookup_intern_macro(macro_file.macro_call_id);
 183                 matches!(loc.eager, Some(EagerCallInfo { included_file: Some(_), .. }))
 184             }
 185             _ => false,
 186         }
 187     }
 188
 189     pub fn is_macro(self) -> bool {
 190         matches!(self.0, HirFileIdRepr::MacroFile(_))
 191     }
 192 }
 193
 194 #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
 195 pub struct MacroFile {
 196     macro_call_id: MacroCallId,
 197 }
 198
 199 /// `MacroCallId` identifies a particular macro invocation, like
 200 /// `println!("Hello, {}", world)`.
 201 #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
 202 pub struct MacroCallId(salsa::InternId);
 203 impl_intern_key!(MacroCallId);
 204
 205 #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
 206 pub struct MacroDefId {
 207     pub krate: CrateId,
 208     pub kind: MacroDefKind,
 209
 210     pub local_inner: bool,
 211 }
 212
 213 impl MacroDefId {
 214     pub fn as_lazy_macro(
 215         self,
 216         db: &dyn db::AstDatabase,
 217         krate: CrateId,
 218         kind: MacroCallKind,
 219     ) -> MacroCallId {
 220         db.intern_macro(MacroCallLoc { def: self, krate, eager: None, kind })
 221     }
 222
 223     pub fn ast_id(&self) -> Either<AstId<ast::Macro>, AstId<ast::Fn>> {
 224         let id = match &self.kind {
 225             MacroDefKind::ProcMacro(.., id) => return Either::Right(*id),
 226             MacroDefKind::Declarative(id)
 227             | MacroDefKind::BuiltIn(_, id)
 228             | MacroDefKind::BuiltInAttr(_, id)
 229             | MacroDefKind::BuiltInDerive(_, id)
 230             | MacroDefKind::BuiltInEager(_, id) => id,
 231         };
 232         Either::Left(*id)
 233     }
 234
 235     pub fn is_proc_macro(&self) -> bool {
 236         matches!(self.kind, MacroDefKind::ProcMacro(..))
 237     }
 238 }
 239
 240 #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
 241 pub enum MacroDefKind {
 242     Declarative(AstId<ast::Macro>),
 243     BuiltIn(BuiltinFnLikeExpander, AstId<ast::Macro>),
 244     // FIXME: maybe just Builtin and rename BuiltinFnLikeExpander to BuiltinExpander
 245     BuiltInAttr(BuiltinAttrExpander, AstId<ast::Macro>),
 246     BuiltInDerive(BuiltinDeriveExpander, AstId<ast::Macro>),
 247     BuiltInEager(EagerExpander, AstId<ast::Macro>),
 248     ProcMacro(ProcMacroExpander, ProcMacroKind, AstId<ast::Fn>),
 249 }
 250
 251 #[derive(Debug, Clone, PartialEq, Eq, Hash)]
 252 struct EagerCallInfo {
 253     /// NOTE: This can be *either* the expansion result, *or* the argument to the eager macro!
 254     arg_or_expansion: Arc<tt::Subtree>,
 255     included_file: Option<FileId>,
 256 }
 257
 258 #[derive(Debug, Clone, PartialEq, Eq, Hash)]
 259 pub struct MacroCallLoc {
 260     pub def: MacroDefId,
 261     pub(crate) krate: CrateId,
 262     eager: Option<EagerCallInfo>,
 263     pub kind: MacroCallKind,
 264 }
 265
 266 #[derive(Debug, Clone, PartialEq, Eq, Hash)]
 267 pub enum MacroCallKind {
 268     FnLike {
 269         ast_id: AstId<ast::MacroCall>,
 270         expand_to: ExpandTo,
 271     },
 272     Derive {
 273         ast_id: AstId<ast::Item>,
 274         derive_name: String,
 275         /// Syntactical index of the invoking `#[derive]` attribute.
 276         ///
 277         /// Outer attributes are counted first, then inner attributes. This does not support
 278         /// out-of-line modules, which may have attributes spread across 2 files!
 279         derive_attr_index: u32,
 280     },
 281     Attr {
 282         ast_id: AstId<ast::Item>,
 283         attr_name: String,
 284         attr_args: (tt::Subtree, mbe::TokenMap),
 285         /// Syntactical index of the invoking `#[attribute]`.
 286         ///
 287         /// Outer attributes are counted first, then inner attributes. This does not support
 288         /// out-of-line modules, which may have attributes spread across 2 files!
 289         invoc_attr_index: u32,
 290     },
 291 }
 292
 293 // FIXME: attribute indices do not account for `cfg_attr`, which means that we'll strip the whole
 294 // `cfg_attr` instead of just one of the attributes it expands to
 295
 296 impl MacroCallKind {
 297     /// Returns the file containing the macro invocation.
 298     fn file_id(&self) -> HirFileId {
 299         match self {
 300             MacroCallKind::FnLike { ast_id, .. } => ast_id.file_id,
 301             MacroCallKind::Derive { ast_id, .. } | MacroCallKind::Attr { ast_id, .. } => {
 302                 ast_id.file_id
 303             }
 304         }
 305     }
 306
 307     pub fn to_node(&self, db: &dyn db::AstDatabase) -> InFile<SyntaxNode> {
 308         match self {
 309             MacroCallKind::FnLike { ast_id, .. } => {
 310                 ast_id.with_value(ast_id.to_node(db).syntax().clone())
 311             }
 312             MacroCallKind::Derive { ast_id, .. } | MacroCallKind::Attr { ast_id, .. } => {
 313                 ast_id.with_value(ast_id.to_node(db).syntax().clone())
 314             }
 315         }
 316     }
 317
 318     fn arg(&self, db: &dyn db::AstDatabase) -> Option<SyntaxNode> {
 319         match self {
 320             MacroCallKind::FnLike { ast_id, .. } => {
 321                 Some(ast_id.to_node(db).token_tree()?.syntax().clone())
 322             }
 323             MacroCallKind::Derive { ast_id, .. } | MacroCallKind::Attr { ast_id, .. } => {
 324                 Some(ast_id.to_node(db).syntax().clone())
 325             }
 326         }
 327     }
 328
 329     fn expand_to(&self) -> ExpandTo {
 330         match self {
 331             MacroCallKind::FnLike { expand_to, .. } => *expand_to,
 332             MacroCallKind::Derive { .. } => ExpandTo::Items,
 333             MacroCallKind::Attr { .. } => ExpandTo::Items, // is this always correct?
 334         }
 335     }
 336 }
 337
 338 impl MacroCallId {
 339     pub fn as_file(self) -> HirFileId {
 340         MacroFile { macro_call_id: self }.into()
 341     }
 342 }
 343
 344 /// ExpansionInfo mainly describes how to map text range between src and expanded macro
 345 #[derive(Debug, Clone, PartialEq, Eq)]
 346 pub struct ExpansionInfo {
 347     expanded: InFile<SyntaxNode>,
 348     arg: InFile<SyntaxNode>,
 349     /// The `macro_rules!` arguments or attribute input.
 350     attr_input_or_mac_def: Option<InFile<ast::TokenTree>>,
 351
 352     macro_def: Arc<TokenExpander>,
 353     macro_arg: Arc<(tt::Subtree, mbe::TokenMap)>,
 354     macro_arg_shift: mbe::Shift,
 355     exp_map: Arc<mbe::TokenMap>,
 356 }
 357
 358 pub use mbe::Origin;
 359
 360 impl ExpansionInfo {
 361     pub fn call_node(&self) -> Option<InFile<SyntaxNode>> {
 362         Some(self.arg.with_value(self.arg.value.parent()?))
 363     }
 364
 365     pub fn map_token_down(
 366         &self,
 367         db: &dyn db::AstDatabase,
 368         item: Option<ast::Item>,
 369         token: InFile<&SyntaxToken>,
 370     ) -> Option<impl Iterator<Item = InFile<SyntaxToken>> + '_> {
 371         assert_eq!(token.file_id, self.arg.file_id);
 372         let token_id = if let Some(item) = item {
 373             let call_id = match self.expanded.file_id.0 {
 374                 HirFileIdRepr::FileId(_) => return None,
 375                 HirFileIdRepr::MacroFile(macro_file) => macro_file.macro_call_id,
 376             };
 377             let loc = db.lookup_intern_macro(call_id);
 378
 379             let token_range = token.value.text_range();
 380             match &loc.kind {
 381                 MacroCallKind::Attr { attr_args, invoc_attr_index, .. } => {
 382                     let attr = item.attrs().nth(*invoc_attr_index as usize)?;
 383                     match attr.token_tree() {
 384                         Some(token_tree)
 385                             if token_tree.syntax().text_range().contains_range(token_range) =>
 386                         {
 387                             let attr_input_start =
 388                                 token_tree.left_delimiter_token()?.text_range().start();
 389                             let range = token.value.text_range().checked_sub(attr_input_start)?;
 390                             let token_id =
 391                                 self.macro_arg_shift.shift(attr_args.1.token_by_range(range)?);
 392                             Some(token_id)
 393                         }
 394                         _ => None,
 395                     }
 396                 }
 397                 _ => None,
 398             }
 399         } else {
 400             None
 401         };
 402
 403         let token_id = match token_id {
 404             Some(token_id) => token_id,
 405             None => {
 406                 let range =
 407                     token.value.text_range().checked_sub(self.arg.value.text_range().start())?;
 408                 let token_id = self.macro_arg.1.token_by_range(range)?;
 409                 self.macro_def.map_id_down(token_id)
 410             }
 411         };
 412
 413         let tokens = self
 414             .exp_map
 415             .ranges_by_token(token_id, token.value.kind())
 416             .flat_map(move |range| self.expanded.value.covering_element(range).into_token());
 417
 418         Some(tokens.map(move |token| self.expanded.with_value(token)))
 419     }
 420
 421     pub fn map_token_up(
 422         &self,
 423         db: &dyn db::AstDatabase,
 424         token: InFile<&SyntaxToken>,
 425     ) -> Option<(InFile<SyntaxToken>, Origin)> {
 426         let token_id = self.exp_map.token_by_range(token.value.text_range())?;
 427         let (mut token_id, origin) = self.macro_def.map_id_up(token_id);
 428
 429         let call_id = match self.expanded.file_id.0 {
 430             HirFileIdRepr::FileId(_) => return None,
 431             HirFileIdRepr::MacroFile(macro_file) => macro_file.macro_call_id,
 432         };
 433         let loc = db.lookup_intern_macro(call_id);
 434
 435         let (token_map, tt) = match &loc.kind {
 436             MacroCallKind::Attr { attr_args, .. } => match self.macro_arg_shift.unshift(token_id) {
 437                 Some(unshifted) => {
 438                     token_id = unshifted;
 439                     (&attr_args.1, self.attr_input_or_mac_def.clone()?.syntax().cloned())
 440                 }
 441                 None => (&self.macro_arg.1, self.arg.clone()),
 442             },
 443             _ => match origin {
 444                 mbe::Origin::Call => (&self.macro_arg.1, self.arg.clone()),
 445                 mbe::Origin::Def => match (&*self.macro_def, &self.attr_input_or_mac_def) {
 446                     (
 447                         TokenExpander::MacroRules { def_site_token_map, .. }
 448                         | TokenExpander::MacroDef { def_site_token_map, .. },
 449                         Some(tt),
 450                     ) => (def_site_token_map, tt.syntax().cloned()),
 451                     _ => panic!("`Origin::Def` used with non-`macro_rules!` macro"),
 452                 },
 453             },
 454         };
 455
 456         let range = token_map.first_range_by_token(token_id, token.value.kind())?;
 457         let token =
 458             tt.value.covering_element(range + tt.value.text_range().start()).into_token()?;
 459         Some((tt.with_value(token), origin))
 460     }
 461 }
 462
 463 /// `AstId` points to an AST node in any file.
 464 ///
 465 /// It is stable across reparses, and can be used as salsa key/value.
 466 // FIXME: isn't this just a `Source<FileAstId<N>>` ?
 467 pub type AstId<N> = InFile<FileAstId<N>>;
 468
 469 impl<N: AstNode> AstId<N> {
 470     pub fn to_node(&self, db: &dyn db::AstDatabase) -> N {
 471         let root = db.parse_or_expand(self.file_id).unwrap();
 472         db.ast_id_map(self.file_id).get(self.value).to_node(&root)
 473     }
 474 }
 475
 476 /// `InFile<T>` stores a value of `T` inside a particular file/syntax tree.
 477 ///
 478 /// Typical usages are:
 479 ///
 480 /// * `InFile<SyntaxNode>` -- syntax node in a file
 481 /// * `InFile<ast::FnDef>` -- ast node in a file
 482 /// * `InFile<TextSize>` -- offset in a file
 483 #[derive(Debug, PartialEq, Eq, Clone, Copy, Hash)]
 484 pub struct InFile<T> {
 485     pub file_id: HirFileId,
 486     pub value: T,
 487 }
 488
 489 impl<T> InFile<T> {
 490     pub fn new(file_id: HirFileId, value: T) -> InFile<T> {
 491         InFile { file_id, value }
 492     }
 493
 494     // Similarly, naming here is stupid...
 495     pub fn with_value<U>(&self, value: U) -> InFile<U> {
 496         InFile::new(self.file_id, value)
 497     }
 498
 499     pub fn map<F: FnOnce(T) -> U, U>(self, f: F) -> InFile<U> {
 500         InFile::new(self.file_id, f(self.value))
 501     }
 502     pub fn as_ref(&self) -> InFile<&T> {
 503         self.with_value(&self.value)
 504     }
 505     pub fn file_syntax(&self, db: &dyn db::AstDatabase) -> SyntaxNode {
 506         db.parse_or_expand(self.file_id).expect("source created from invalid file")
 507     }
 508 }
 509
 510 impl<T: Clone> InFile<&T> {
 511     pub fn cloned(&self) -> InFile<T> {
 512         self.with_value(self.value.clone())
 513     }
 514 }
 515
 516 impl<T> InFile<Option<T>> {
 517     pub fn transpose(self) -> Option<InFile<T>> {
 518         let value = self.value?;
 519         Some(InFile::new(self.file_id, value))
 520     }
 521 }
 522
 523 impl InFile<SyntaxNode> {
 524     pub fn ancestors_with_macros(
 525         self,
 526         db: &dyn db::AstDatabase,
 527     ) -> impl Iterator<Item = InFile<SyntaxNode>> + '_ {
 528         iter::successors(Some(self), move |node| match node.value.parent() {
 529             Some(parent) => Some(node.with_value(parent)),
 530             None => {
 531                 let parent_node = node.file_id.call_node(db)?;
 532                 Some(parent_node)
 533             }
 534         })
 535     }
 536 }
 537
 538 impl<'a> InFile<&'a SyntaxNode> {
 539     /// Falls back to the macro call range if the node cannot be mapped up fully.
 540     pub fn original_file_range(self, db: &dyn db::AstDatabase) -> FileRange {
 541         if let Some(res) = self.original_file_range_opt(db) {
 542             return res;
 543         }
 544
 545         // Fall back to whole macro call.
 546         let mut node = self.cloned();
 547         while let Some(call_node) = node.file_id.call_node(db) {
 548             node = call_node;
 549         }
 550
 551         let orig_file = node.file_id.original_file(db);
 552         assert_eq!(node.file_id, orig_file.into());
 553
 554         FileRange { file_id: orig_file, range: node.value.text_range() }
 555     }
 556
 557     /// Attempts to map the syntax node back up its macro calls.
 558     pub fn original_file_range_opt(self, db: &dyn db::AstDatabase) -> Option<FileRange> {
 559         match original_range_opt(db, self) {
 560             Some(range) => {
 561                 let original_file = range.file_id.original_file(db);
 562                 if range.file_id != original_file.into() {
 563                     tracing::error!("Failed mapping up more for {:?}", range);
 564                 }
 565                 Some(FileRange { file_id: original_file, range: range.value })
 566             }
 567             _ if !self.file_id.is_macro() => Some(FileRange {
 568                 file_id: self.file_id.original_file(db),
 569                 range: self.value.text_range(),
 570             }),
 571             _ => None,
 572         }
 573     }
 574 }
 575
 576 fn original_range_opt(
 577     db: &dyn db::AstDatabase,
 578     node: InFile<&SyntaxNode>,
 579 ) -> Option<InFile<TextRange>> {
 580     let expansion = node.file_id.expansion_info(db)?;
 581
 582     // the input node has only one token ?
 583     let single = skip_trivia_token(node.value.first_token()?, Direction::Next)?
 584         == skip_trivia_token(node.value.last_token()?, Direction::Prev)?;
 585
 586     node.value.descendants().find_map(|it| {
 587         let first = skip_trivia_token(it.first_token()?, Direction::Next)?;
 588         let first = ascend_call_token(db, &expansion, node.with_value(first))?;
 589
 590         let last = skip_trivia_token(it.last_token()?, Direction::Prev)?;
 591         let last = ascend_call_token(db, &expansion, node.with_value(last))?;
 592
 593         if (!single && first == last) || (first.file_id != last.file_id) {
 594             return None;
 595         }
 596
 597         Some(first.with_value(first.value.text_range().cover(last.value.text_range())))
 598     })
 599 }
 600
 601 fn ascend_call_token(
 602     db: &dyn db::AstDatabase,
 603     expansion: &ExpansionInfo,
 604     token: InFile<SyntaxToken>,
 605 ) -> Option<InFile<SyntaxToken>> {
 606     let (mapped, origin) = expansion.map_token_up(db, token.as_ref())?;
 607     if origin != Origin::Call {
 608         return None;
 609     }
 610     if let Some(info) = mapped.file_id.expansion_info(db) {
 611         return ascend_call_token(db, &info, mapped);
 612     }
 613     Some(mapped)
 614 }
 615
 616 impl InFile<SyntaxToken> {
 617     pub fn ancestors_with_macros(
 618         self,
 619         db: &dyn db::AstDatabase,
 620     ) -> impl Iterator<Item = InFile<SyntaxNode>> + '_ {
 621         self.value.parent().into_iter().flat_map({
 622             let file_id = self.file_id;
 623             move |parent| InFile::new(file_id, parent).ancestors_with_macros(db)
 624         })
 625     }
 626 }
 627
 628 impl<N: AstNode> InFile<N> {
 629     pub fn descendants<T: AstNode>(self) -> impl Iterator<Item = InFile<T>> {
 630         self.value.syntax().descendants().filter_map(T::cast).map(move |n| self.with_value(n))
 631     }
 632
 633     pub fn syntax(&self) -> InFile<&SyntaxNode> {
 634         self.with_value(self.value.syntax())
 635     }
 636
 637     pub fn nodes_with_attributes<'db>(
 638         self,
 639         db: &'db dyn db::AstDatabase,
 640     ) -> impl Iterator<Item = InFile<N>> + 'db
 641     where
 642         N: 'db,
 643     {
 644         iter::successors(Some(self), move |node| {
 645             let InFile { file_id, value } = node.file_id.call_node(db)?;
 646             N::cast(value).map(|n| InFile::new(file_id, n))
 647         })
 648     }
 649
 650     pub fn node_with_attributes(self, db: &dyn db::AstDatabase) -> InFile<N> {
 651         self.nodes_with_attributes(db).last().unwrap()
 652     }
 653 }
 654
 655 /// In Rust, macros expand token trees to token trees. When we want to turn a
 656 /// token tree into an AST node, we need to figure out what kind of AST node we
 657 /// want: something like `foo` can be a type, an expression, or a pattern.
 658 ///
 659 /// Naively, one would think that "what this expands to" is a property of a
 660 /// particular macro: macro `m1` returns an item, while macro `m2` returns an
 661 /// expression, etc. That's not the case -- macros are polymorphic in the
 662 /// result, and can expand to any type of the AST node.
 663 ///
 664 /// What defines the actual AST node is the syntactic context of the macro
 665 /// invocation. As a contrived example, in `let T![*] = T![*];` the first `T`
 666 /// expands to a pattern, while the second one expands to an expression.
 667 ///
 668 /// `ExpandTo` captures this bit of information about a particular macro call
 669 /// site.
 670 #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
 671 pub enum ExpandTo {
 672     Statements,
 673     Items,
 674     Pattern,
 675     Type,
 676     Expr,
 677 }
 678
 679 impl ExpandTo {
 680     pub fn from_call_site(call: &ast::MacroCall) -> ExpandTo {
 681         use syntax::SyntaxKind::*;
 682
 683         let syn = call.syntax();
 684
 685         let parent = match syn.parent() {
 686             Some(it) => it,
 687             None => return ExpandTo::Statements,
 688         };
 689
 690         match parent.kind() {
 691             MACRO_ITEMS | SOURCE_FILE | ITEM_LIST => ExpandTo::Items,
 692             MACRO_STMTS | EXPR_STMT | BLOCK_EXPR => ExpandTo::Statements,
 693             MACRO_PAT => ExpandTo::Pattern,
 694             MACRO_TYPE => ExpandTo::Type,
 695
 696             ARG_LIST | TRY_EXPR | TUPLE_EXPR | PAREN_EXPR | ARRAY_EXPR | FOR_EXPR | PATH_EXPR
 697             | CLOSURE_EXPR | CONDITION | BREAK_EXPR | RETURN_EXPR | MATCH_EXPR | MATCH_ARM
 698             | MATCH_GUARD | RECORD_EXPR_FIELD | CALL_EXPR | INDEX_EXPR | METHOD_CALL_EXPR
 699             | FIELD_EXPR | AWAIT_EXPR | CAST_EXPR | REF_EXPR | PREFIX_EXPR | RANGE_EXPR
 700             | BIN_EXPR => ExpandTo::Expr,
 701             LET_STMT => {
 702                 // FIXME: Handle LHS Pattern
 703                 ExpandTo::Expr
 704             }
 705
 706             _ => {
 707                 // Unknown , Just guess it is `Items`
 708                 ExpandTo::Items
 709             }
 710         }
 711     }
 712 }