]> git.lizzy.rs Git - rust.git/blob - crates/hir/src/semantics.rs
Merge #10688
[rust.git] / crates / hir / src / semantics.rs
1 //! See `Semantics`.
2
3 mod source_to_def;
4
5 use std::{cell::RefCell, fmt};
6
7 use base_db::{FileId, FileRange};
8 use hir_def::{
9     body,
10     resolver::{self, HasResolver, Resolver, TypeNs},
11     AsMacroCall, FunctionId, TraitId, VariantId,
12 };
13 use hir_expand::{name::AsName, ExpansionInfo};
14 use hir_ty::{associated_type_shorthand_candidates, Interner};
15 use itertools::Itertools;
16 use rustc_hash::{FxHashMap, FxHashSet};
17 use smallvec::{smallvec, SmallVec};
18 use syntax::{
19     algo::skip_trivia_token,
20     ast::{self, HasAttrs, HasGenericParams, HasLoopBody},
21     match_ast, AstNode, Direction, SyntaxNode, SyntaxNodePtr, SyntaxToken, TextSize,
22 };
23
24 use crate::{
25     db::HirDatabase,
26     semantics::source_to_def::{ChildContainer, SourceToDefCache, SourceToDefCtx},
27     source_analyzer::{resolve_hir_path, resolve_hir_path_as_macro, SourceAnalyzer},
28     Access, AssocItem, Callable, ConstParam, Crate, Field, Function, HasSource, HirFileId, Impl,
29     InFile, Label, LifetimeParam, Local, MacroDef, Module, ModuleDef, Name, Path, ScopeDef, Trait,
30     Type, TypeAlias, TypeParam, VariantDef,
31 };
32
33 #[derive(Debug, Clone, PartialEq, Eq)]
34 pub enum PathResolution {
35     /// An item
36     Def(ModuleDef),
37     /// A local binding (only value namespace)
38     Local(Local),
39     /// A type parameter
40     TypeParam(TypeParam),
41     /// A const parameter
42     ConstParam(ConstParam),
43     SelfType(Impl),
44     Macro(MacroDef),
45     AssocItem(AssocItem),
46 }
47
48 impl PathResolution {
49     fn in_type_ns(&self) -> Option<TypeNs> {
50         match self {
51             PathResolution::Def(ModuleDef::Adt(adt)) => Some(TypeNs::AdtId((*adt).into())),
52             PathResolution::Def(ModuleDef::BuiltinType(builtin)) => {
53                 Some(TypeNs::BuiltinType((*builtin).into()))
54             }
55             PathResolution::Def(
56                 ModuleDef::Const(_)
57                 | ModuleDef::Variant(_)
58                 | ModuleDef::Function(_)
59                 | ModuleDef::Module(_)
60                 | ModuleDef::Static(_)
61                 | ModuleDef::Trait(_),
62             ) => None,
63             PathResolution::Def(ModuleDef::TypeAlias(alias)) => {
64                 Some(TypeNs::TypeAliasId((*alias).into()))
65             }
66             PathResolution::Local(_) | PathResolution::Macro(_) | PathResolution::ConstParam(_) => {
67                 None
68             }
69             PathResolution::TypeParam(param) => Some(TypeNs::GenericParam((*param).into())),
70             PathResolution::SelfType(impl_def) => Some(TypeNs::SelfType((*impl_def).into())),
71             PathResolution::AssocItem(AssocItem::Const(_) | AssocItem::Function(_)) => None,
72             PathResolution::AssocItem(AssocItem::TypeAlias(alias)) => {
73                 Some(TypeNs::TypeAliasId((*alias).into()))
74             }
75         }
76     }
77
78     /// Returns an iterator over associated types that may be specified after this path (using
79     /// `Ty::Assoc` syntax).
80     pub fn assoc_type_shorthand_candidates<R>(
81         &self,
82         db: &dyn HirDatabase,
83         mut cb: impl FnMut(&Name, TypeAlias) -> Option<R>,
84     ) -> Option<R> {
85         associated_type_shorthand_candidates(db, self.in_type_ns()?, |name, _, id| {
86             cb(name, id.into())
87         })
88     }
89 }
90
91 #[derive(Debug)]
92 pub struct TypeInfo {
93     /// The original type of the expression or pattern.
94     pub original: Type,
95     /// The adjusted type, if an adjustment happened.
96     pub adjusted: Option<Type>,
97 }
98
99 impl TypeInfo {
100     pub fn original(self) -> Type {
101         self.original
102     }
103
104     pub fn has_adjustment(&self) -> bool {
105         self.adjusted.is_some()
106     }
107
108     /// The adjusted type, or the original in case no adjustments occurred.
109     pub fn adjusted(self) -> Type {
110         self.adjusted.unwrap_or(self.original)
111     }
112 }
113
114 /// Primary API to get semantic information, like types, from syntax trees.
115 pub struct Semantics<'db, DB> {
116     pub db: &'db DB,
117     imp: SemanticsImpl<'db>,
118 }
119
120 pub struct SemanticsImpl<'db> {
121     pub db: &'db dyn HirDatabase,
122     s2d_cache: RefCell<SourceToDefCache>,
123     expansion_info_cache: RefCell<FxHashMap<HirFileId, Option<ExpansionInfo>>>,
124     // Rootnode to HirFileId cache
125     cache: RefCell<FxHashMap<SyntaxNode, HirFileId>>,
126     // MacroCall to its expansion's HirFileId cache
127     macro_call_cache: RefCell<FxHashMap<InFile<ast::MacroCall>, HirFileId>>,
128 }
129
130 impl<DB> fmt::Debug for Semantics<'_, DB> {
131     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
132         write!(f, "Semantics {{ ... }}")
133     }
134 }
135
136 impl<'db, DB: HirDatabase> Semantics<'db, DB> {
137     pub fn new(db: &DB) -> Semantics<DB> {
138         let impl_ = SemanticsImpl::new(db);
139         Semantics { db, imp: impl_ }
140     }
141
142     pub fn parse(&self, file_id: FileId) -> ast::SourceFile {
143         self.imp.parse(file_id)
144     }
145
146     pub fn expand(&self, macro_call: &ast::MacroCall) -> Option<SyntaxNode> {
147         self.imp.expand(macro_call)
148     }
149
150     /// If `item` has an attribute macro attached to it, expands it.
151     pub fn expand_attr_macro(&self, item: &ast::Item) -> Option<SyntaxNode> {
152         self.imp.expand_attr_macro(item)
153     }
154
155     pub fn expand_derive_macro(&self, derive: &ast::Attr) -> Option<Vec<SyntaxNode>> {
156         self.imp.expand_derive_macro(derive)
157     }
158
159     pub fn is_attr_macro_call(&self, item: &ast::Item) -> bool {
160         self.imp.is_attr_macro_call(item)
161     }
162
163     pub fn speculative_expand(
164         &self,
165         actual_macro_call: &ast::MacroCall,
166         speculative_args: &ast::TokenTree,
167         token_to_map: SyntaxToken,
168     ) -> Option<(SyntaxNode, SyntaxToken)> {
169         self.imp.speculative_expand(actual_macro_call, speculative_args, token_to_map)
170     }
171
172     pub fn speculative_expand_attr_macro(
173         &self,
174         actual_macro_call: &ast::Item,
175         speculative_args: &ast::Item,
176         token_to_map: SyntaxToken,
177     ) -> Option<(SyntaxNode, SyntaxToken)> {
178         self.imp.speculative_expand_attr(actual_macro_call, speculative_args, token_to_map)
179     }
180
181     /// Descend the token into macrocalls to its first mapped counterpart.
182     pub fn descend_into_macros_single(&self, token: SyntaxToken) -> SyntaxToken {
183         self.imp.descend_into_macros_single(token)
184     }
185
186     /// Descend the token into macrocalls to all its mapped counterparts.
187     pub fn descend_into_macros(&self, token: SyntaxToken) -> SmallVec<[SyntaxToken; 1]> {
188         self.imp.descend_into_macros(token)
189     }
190
191     /// Maps a node down by mapping its first and last token down.
192     pub fn descend_node_into_attributes<N: AstNode>(&self, node: N) -> SmallVec<[N; 1]> {
193         self.imp.descend_node_into_attributes(node)
194     }
195
196     /// Search for a definition's source and cache its syntax tree
197     pub fn source<Def: HasSource>(&self, def: Def) -> Option<InFile<Def::Ast>>
198     where
199         Def::Ast: AstNode,
200     {
201         self.imp.source(def)
202     }
203
204     pub fn hir_file_for(&self, syntax_node: &SyntaxNode) -> HirFileId {
205         self.imp.find_file(syntax_node.clone()).file_id
206     }
207
208     pub fn original_range(&self, node: &SyntaxNode) -> FileRange {
209         self.imp.original_range(node)
210     }
211
212     pub fn original_range_opt(&self, node: &SyntaxNode) -> Option<FileRange> {
213         self.imp.original_range_opt(node)
214     }
215
216     pub fn original_ast_node<N: AstNode>(&self, node: N) -> Option<N> {
217         self.imp.original_ast_node(node)
218     }
219
220     pub fn diagnostics_display_range(&self, diagnostics: InFile<SyntaxNodePtr>) -> FileRange {
221         self.imp.diagnostics_display_range(diagnostics)
222     }
223
224     pub fn token_ancestors_with_macros(
225         &self,
226         token: SyntaxToken,
227     ) -> impl Iterator<Item = SyntaxNode> + '_ {
228         token.parent().into_iter().flat_map(move |it| self.ancestors_with_macros(it))
229     }
230
231     pub fn ancestors_with_macros(&self, node: SyntaxNode) -> impl Iterator<Item = SyntaxNode> + '_ {
232         self.imp.ancestors_with_macros(node)
233     }
234
235     pub fn ancestors_at_offset_with_macros(
236         &self,
237         node: &SyntaxNode,
238         offset: TextSize,
239     ) -> impl Iterator<Item = SyntaxNode> + '_ {
240         self.imp.ancestors_at_offset_with_macros(node, offset)
241     }
242
243     /// Find an AstNode by offset inside SyntaxNode, if it is inside *Macrofile*,
244     /// search up until it is of the target AstNode type
245     pub fn find_node_at_offset_with_macros<N: AstNode>(
246         &self,
247         node: &SyntaxNode,
248         offset: TextSize,
249     ) -> Option<N> {
250         self.imp.ancestors_at_offset_with_macros(node, offset).find_map(N::cast)
251     }
252
253     /// Find an AstNode by offset inside SyntaxNode, if it is inside *MacroCall*,
254     /// descend it and find again
255     pub fn find_node_at_offset_with_descend<N: AstNode>(
256         &self,
257         node: &SyntaxNode,
258         offset: TextSize,
259     ) -> Option<N> {
260         self.imp.descend_node_at_offset(node, offset).flatten().find_map(N::cast)
261     }
262
263     /// Find an AstNode by offset inside SyntaxNode, if it is inside *MacroCall*,
264     /// descend it and find again
265     pub fn find_nodes_at_offset_with_descend<'slf, N: AstNode + 'slf>(
266         &'slf self,
267         node: &SyntaxNode,
268         offset: TextSize,
269     ) -> impl Iterator<Item = N> + 'slf {
270         self.imp.descend_node_at_offset(node, offset).filter_map(|mut it| it.find_map(N::cast))
271     }
272
273     pub fn resolve_lifetime_param(&self, lifetime: &ast::Lifetime) -> Option<LifetimeParam> {
274         self.imp.resolve_lifetime_param(lifetime)
275     }
276
277     pub fn resolve_label(&self, lifetime: &ast::Lifetime) -> Option<Label> {
278         self.imp.resolve_label(lifetime)
279     }
280
281     pub fn resolve_type(&self, ty: &ast::Type) -> Option<Type> {
282         self.imp.resolve_type(ty)
283     }
284
285     pub fn type_of_expr(&self, expr: &ast::Expr) -> Option<TypeInfo> {
286         self.imp.type_of_expr(expr)
287     }
288
289     pub fn type_of_pat(&self, pat: &ast::Pat) -> Option<TypeInfo> {
290         self.imp.type_of_pat(pat)
291     }
292
293     pub fn type_of_self(&self, param: &ast::SelfParam) -> Option<Type> {
294         self.imp.type_of_self(param)
295     }
296
297     pub fn resolve_method_call(&self, call: &ast::MethodCallExpr) -> Option<Function> {
298         self.imp.resolve_method_call(call).map(Function::from)
299     }
300
301     pub fn resolve_method_call_as_callable(&self, call: &ast::MethodCallExpr) -> Option<Callable> {
302         self.imp.resolve_method_call_as_callable(call)
303     }
304
305     pub fn resolve_field(&self, field: &ast::FieldExpr) -> Option<Field> {
306         self.imp.resolve_field(field)
307     }
308
309     pub fn resolve_record_field(
310         &self,
311         field: &ast::RecordExprField,
312     ) -> Option<(Field, Option<Local>, Type)> {
313         self.imp.resolve_record_field(field)
314     }
315
316     pub fn resolve_record_pat_field(&self, field: &ast::RecordPatField) -> Option<Field> {
317         self.imp.resolve_record_pat_field(field)
318     }
319
320     pub fn resolve_macro_call(&self, macro_call: &ast::MacroCall) -> Option<MacroDef> {
321         self.imp.resolve_macro_call(macro_call)
322     }
323
324     pub fn resolve_attr_macro_call(&self, item: &ast::Item) -> Option<MacroDef> {
325         self.imp.resolve_attr_macro_call(item)
326     }
327
328     pub fn resolve_path(&self, path: &ast::Path) -> Option<PathResolution> {
329         self.imp.resolve_path(path)
330     }
331
332     pub fn resolve_extern_crate(&self, extern_crate: &ast::ExternCrate) -> Option<Crate> {
333         self.imp.resolve_extern_crate(extern_crate)
334     }
335
336     pub fn resolve_variant(&self, record_lit: ast::RecordExpr) -> Option<VariantDef> {
337         self.imp.resolve_variant(record_lit).map(VariantDef::from)
338     }
339
340     pub fn resolve_bind_pat_to_const(&self, pat: &ast::IdentPat) -> Option<ModuleDef> {
341         self.imp.resolve_bind_pat_to_const(pat)
342     }
343
344     // FIXME: use this instead?
345     // pub fn resolve_name_ref(&self, name_ref: &ast::NameRef) -> Option<???>;
346
347     pub fn record_literal_missing_fields(&self, literal: &ast::RecordExpr) -> Vec<(Field, Type)> {
348         self.imp.record_literal_missing_fields(literal)
349     }
350
351     pub fn record_pattern_missing_fields(&self, pattern: &ast::RecordPat) -> Vec<(Field, Type)> {
352         self.imp.record_pattern_missing_fields(pattern)
353     }
354
355     pub fn to_def<T: ToDef>(&self, src: &T) -> Option<T::Def> {
356         let src = self.imp.find_file(src.syntax().clone()).with_value(src).cloned();
357         T::to_def(&self.imp, src)
358     }
359
360     pub fn to_module_def(&self, file: FileId) -> Option<Module> {
361         self.imp.to_module_def(file).next()
362     }
363
364     pub fn to_module_defs(&self, file: FileId) -> impl Iterator<Item = Module> {
365         self.imp.to_module_def(file)
366     }
367
368     pub fn scope(&self, node: &SyntaxNode) -> SemanticsScope<'db> {
369         self.imp.scope(node)
370     }
371
372     pub fn scope_at_offset(&self, token: &SyntaxToken, offset: TextSize) -> SemanticsScope<'db> {
373         self.imp.scope_at_offset(&token.parent().unwrap(), offset)
374     }
375
376     pub fn scope_for_def(&self, def: Trait) -> SemanticsScope<'db> {
377         self.imp.scope_for_def(def)
378     }
379
380     pub fn assert_contains_node(&self, node: &SyntaxNode) {
381         self.imp.assert_contains_node(node)
382     }
383
384     pub fn is_unsafe_method_call(&self, method_call_expr: &ast::MethodCallExpr) -> bool {
385         self.imp.is_unsafe_method_call(method_call_expr)
386     }
387
388     pub fn is_unsafe_ref_expr(&self, ref_expr: &ast::RefExpr) -> bool {
389         self.imp.is_unsafe_ref_expr(ref_expr)
390     }
391
392     pub fn is_unsafe_ident_pat(&self, ident_pat: &ast::IdentPat) -> bool {
393         self.imp.is_unsafe_ident_pat(ident_pat)
394     }
395 }
396
397 impl<'db> SemanticsImpl<'db> {
398     fn new(db: &'db dyn HirDatabase) -> Self {
399         SemanticsImpl {
400             db,
401             s2d_cache: Default::default(),
402             cache: Default::default(),
403             expansion_info_cache: Default::default(),
404             macro_call_cache: Default::default(),
405         }
406     }
407
408     fn parse(&self, file_id: FileId) -> ast::SourceFile {
409         let tree = self.db.parse(file_id).tree();
410         self.cache(tree.syntax().clone(), file_id.into());
411         tree
412     }
413
414     fn expand(&self, macro_call: &ast::MacroCall) -> Option<SyntaxNode> {
415         let sa = self.analyze(macro_call.syntax());
416         let file_id = sa.expand(self.db, InFile::new(sa.file_id, macro_call))?;
417         let node = self.db.parse_or_expand(file_id)?;
418         self.cache(node.clone(), file_id);
419         Some(node)
420     }
421
422     fn expand_attr_macro(&self, item: &ast::Item) -> Option<SyntaxNode> {
423         let sa = self.analyze(item.syntax());
424         let src = InFile::new(sa.file_id, item.clone());
425         let macro_call_id = self.with_ctx(|ctx| ctx.item_to_macro_call(src))?;
426         let file_id = macro_call_id.as_file();
427         let node = self.db.parse_or_expand(file_id)?;
428         self.cache(node.clone(), file_id);
429         Some(node)
430     }
431
432     fn expand_derive_macro(&self, attr: &ast::Attr) -> Option<Vec<SyntaxNode>> {
433         let item = attr.syntax().parent().and_then(ast::Item::cast)?;
434         let sa = self.analyze(item.syntax());
435         let item = InFile::new(sa.file_id, &item);
436         let src = InFile::new(sa.file_id, attr.clone());
437         self.with_ctx(|ctx| {
438             let macro_call_ids = ctx.attr_to_derive_macro_call(item, src)?;
439
440             let expansions: Vec<_> = macro_call_ids
441                 .iter()
442                 .map(|call| call.as_file())
443                 .flat_map(|file_id| {
444                     let node = self.db.parse_or_expand(file_id)?;
445                     self.cache(node.clone(), file_id);
446                     Some(node)
447                 })
448                 .collect();
449             if expansions.is_empty() {
450                 None
451             } else {
452                 Some(expansions)
453             }
454         })
455     }
456
457     fn is_attr_macro_call(&self, item: &ast::Item) -> bool {
458         let sa = self.analyze(item.syntax());
459         let src = InFile::new(sa.file_id, item.clone());
460         self.with_ctx(|ctx| ctx.item_to_macro_call(src).is_some())
461     }
462
463     fn speculative_expand(
464         &self,
465         actual_macro_call: &ast::MacroCall,
466         speculative_args: &ast::TokenTree,
467         token_to_map: SyntaxToken,
468     ) -> Option<(SyntaxNode, SyntaxToken)> {
469         let sa = self.analyze(actual_macro_call.syntax());
470         let macro_call = InFile::new(sa.file_id, actual_macro_call);
471         let krate = sa.resolver.krate()?;
472         let macro_call_id = macro_call.as_call_id(self.db.upcast(), krate, |path| {
473             sa.resolver.resolve_path_as_macro(self.db.upcast(), &path)
474         })?;
475         hir_expand::db::expand_speculative(
476             self.db.upcast(),
477             macro_call_id,
478             speculative_args.syntax(),
479             token_to_map,
480         )
481     }
482
483     fn speculative_expand_attr(
484         &self,
485         actual_macro_call: &ast::Item,
486         speculative_args: &ast::Item,
487         token_to_map: SyntaxToken,
488     ) -> Option<(SyntaxNode, SyntaxToken)> {
489         let sa = self.analyze(actual_macro_call.syntax());
490         let macro_call = InFile::new(sa.file_id, actual_macro_call.clone());
491         let macro_call_id = self.with_ctx(|ctx| ctx.item_to_macro_call(macro_call))?;
492         hir_expand::db::expand_speculative(
493             self.db.upcast(),
494             macro_call_id,
495             speculative_args.syntax(),
496             token_to_map,
497         )
498     }
499
500     // This might not be the correct way to do this, but it works for now
501     fn descend_node_into_attributes<N: AstNode>(&self, node: N) -> SmallVec<[N; 1]> {
502         let mut res = smallvec![];
503         let tokens = (|| {
504             let first = skip_trivia_token(node.syntax().first_token()?, Direction::Next)?;
505             let last = skip_trivia_token(node.syntax().last_token()?, Direction::Prev)?;
506             Some((first, last))
507         })();
508         let (first, last) = match tokens {
509             Some(it) => it,
510             None => return res,
511         };
512
513         if first == last {
514             self.descend_into_macros_impl(
515                 first,
516                 |InFile { value, .. }| {
517                     if let Some(node) = value.ancestors().find_map(N::cast) {
518                         res.push(node)
519                     }
520                 },
521                 false,
522             );
523         } else {
524             // Descend first and last token, then zip them to look for the node they belong to
525             let mut scratch: SmallVec<[_; 1]> = smallvec![];
526             self.descend_into_macros_impl(
527                 first,
528                 |token| {
529                     scratch.push(token);
530                 },
531                 false,
532             );
533
534             let mut scratch = scratch.into_iter();
535             self.descend_into_macros_impl(
536                 last,
537                 |InFile { value: last, file_id: last_fid }| {
538                     if let Some(InFile { value: first, file_id: first_fid }) = scratch.next() {
539                         if first_fid == last_fid {
540                             if let Some(p) = first.parent() {
541                                 let range = first.text_range().cover(last.text_range());
542                                 let node = find_root(&p)
543                                     .covering_element(range)
544                                     .ancestors()
545                                     .take_while(|it| it.text_range() == range)
546                                     .find_map(N::cast);
547                                 if let Some(node) = node {
548                                     res.push(node);
549                                 }
550                             }
551                         }
552                     }
553                 },
554                 false,
555             );
556         }
557         res
558     }
559
560     fn descend_into_macros(&self, token: SyntaxToken) -> SmallVec<[SyntaxToken; 1]> {
561         let mut res = smallvec![];
562         self.descend_into_macros_impl(token, |InFile { value, .. }| res.push(value), false);
563         res
564     }
565
566     fn descend_into_macros_single(&self, token: SyntaxToken) -> SyntaxToken {
567         let mut res = token.clone();
568         self.descend_into_macros_impl(token, |InFile { value, .. }| res = value, true);
569         res
570     }
571
572     fn descend_into_macros_impl(
573         &self,
574         token: SyntaxToken,
575         mut f: impl FnMut(InFile<SyntaxToken>),
576         single: bool,
577     ) {
578         let _p = profile::span("descend_into_macros");
579         let parent = match token.parent() {
580             Some(it) => it,
581             None => return,
582         };
583         let sa = self.analyze(&parent);
584         let mut stack: SmallVec<[_; 4]> = smallvec![InFile::new(sa.file_id, token)];
585         let mut cache = self.expansion_info_cache.borrow_mut();
586         let mut mcache = self.macro_call_cache.borrow_mut();
587
588         let mut process_expansion_for_token =
589             |stack: &mut SmallVec<_>, macro_file, item, token: InFile<&_>| {
590                 let expansion_info = cache
591                     .entry(macro_file)
592                     .or_insert_with(|| macro_file.expansion_info(self.db.upcast()))
593                     .as_ref()?;
594
595                 {
596                     let InFile { file_id, value } = expansion_info.expanded();
597                     self.cache(value, file_id);
598                 }
599
600                 let mut mapped_tokens =
601                     expansion_info.map_token_down(self.db.upcast(), item, token)?;
602
603                 let len = stack.len();
604                 // requeue the tokens we got from mapping our current token down
605                 if single {
606                     stack.extend(mapped_tokens.next());
607                 } else {
608                     stack.extend(mapped_tokens);
609                 }
610                 // if the length changed we have found a mapping for the token
611                 (stack.len() != len).then(|| ())
612             };
613
614         // Remap the next token in the queue into a macro call its in, if it is not being remapped
615         // either due to not being in a macro-call or because its unused push it into the result vec,
616         // otherwise push the remapped tokens back into the queue as they can potentially be remapped again.
617         while let Some(token) = stack.pop() {
618             self.db.unwind_if_cancelled();
619             let was_not_remapped = (|| {
620                 // are we inside an attribute macro call
621                 let containing_attribute_macro_call = self.with_ctx(|ctx| {
622                     token.value.ancestors().filter_map(ast::Item::cast).find_map(|item| {
623                         if item.attrs().next().is_none() {
624                             // Don't force populate the dyn cache for items that don't have an attribute anyways
625                             return None;
626                         }
627                         Some((ctx.item_to_macro_call(token.with_value(item.clone()))?, item))
628                     })
629                 });
630                 if let Some((call_id, item)) = containing_attribute_macro_call {
631                     let file_id = call_id.as_file();
632                     return process_expansion_for_token(
633                         &mut stack,
634                         file_id,
635                         Some(item),
636                         token.as_ref(),
637                     );
638                 }
639
640                 // or are we inside a function-like macro call
641                 if let Some(tt) =
642                     // FIXME replace map.while_some with take_while once stable
643                     token.value.ancestors().map(ast::TokenTree::cast).while_some().last()
644                 {
645                     let macro_call = tt.syntax().parent().and_then(ast::MacroCall::cast)?;
646                     if tt.left_delimiter_token().map_or(false, |it| it == token.value) {
647                         return None;
648                     }
649                     if tt.right_delimiter_token().map_or(false, |it| it == token.value) {
650                         return None;
651                     }
652
653                     let mcall = token.with_value(macro_call);
654                     let file_id = match mcache.get(&mcall) {
655                         Some(&it) => it,
656                         None => {
657                             let it = sa.expand(self.db, mcall.as_ref())?;
658                             mcache.insert(mcall, it);
659                             it
660                         }
661                     };
662                     return process_expansion_for_token(&mut stack, file_id, None, token.as_ref());
663                 }
664
665                 // outside of a macro invocation so this is a "final" token
666                 None
667             })()
668             .is_none();
669
670             if was_not_remapped {
671                 f(token)
672             }
673         }
674     }
675
676     // Note this return type is deliberate as [`find_nodes_at_offset_with_descend`] wants to stop
677     // traversing the inner iterator when it finds a node.
678     // The outer iterator is over the tokens descendants
679     // The inner iterator is the ancestors of a descendant
680     fn descend_node_at_offset(
681         &self,
682         node: &SyntaxNode,
683         offset: TextSize,
684     ) -> impl Iterator<Item = impl Iterator<Item = SyntaxNode> + '_> + '_ {
685         node.token_at_offset(offset)
686             .map(move |token| self.descend_into_macros(token))
687             .map(|descendants| {
688                 descendants.into_iter().map(move |it| self.token_ancestors_with_macros(it))
689             })
690             // re-order the tokens from token_at_offset by returning the ancestors with the smaller first nodes first
691             // See algo::ancestors_at_offset, which uses the same approach
692             .kmerge_by(|left, right| {
693                 left.clone()
694                     .map(|node| node.text_range().len())
695                     .lt(right.clone().map(|node| node.text_range().len()))
696             })
697     }
698
699     fn original_range(&self, node: &SyntaxNode) -> FileRange {
700         let node = self.find_file(node.clone());
701         node.as_ref().original_file_range(self.db.upcast())
702     }
703
704     fn original_range_opt(&self, node: &SyntaxNode) -> Option<FileRange> {
705         let node = self.find_file(node.clone());
706         node.as_ref().original_file_range_opt(self.db.upcast())
707     }
708
709     fn original_ast_node<N: AstNode>(&self, node: N) -> Option<N> {
710         let file = self.find_file(node.syntax().clone());
711         file.with_value(node).original_ast_node(self.db.upcast()).map(|it| it.value)
712     }
713
714     fn diagnostics_display_range(&self, src: InFile<SyntaxNodePtr>) -> FileRange {
715         let root = self.db.parse_or_expand(src.file_id).unwrap();
716         let node = src.value.to_node(&root);
717         self.cache(root, src.file_id);
718         src.with_value(&node).original_file_range(self.db.upcast())
719     }
720
721     fn token_ancestors_with_macros(
722         &self,
723         token: SyntaxToken,
724     ) -> impl Iterator<Item = SyntaxNode> + Clone + '_ {
725         token.parent().into_iter().flat_map(move |parent| self.ancestors_with_macros(parent))
726     }
727
728     fn ancestors_with_macros(
729         &self,
730         node: SyntaxNode,
731     ) -> impl Iterator<Item = SyntaxNode> + Clone + '_ {
732         let node = self.find_file(node);
733         node.ancestors_with_macros(self.db.upcast()).map(|it| it.value)
734     }
735
736     fn ancestors_at_offset_with_macros(
737         &self,
738         node: &SyntaxNode,
739         offset: TextSize,
740     ) -> impl Iterator<Item = SyntaxNode> + '_ {
741         node.token_at_offset(offset)
742             .map(|token| self.token_ancestors_with_macros(token))
743             .kmerge_by(|node1, node2| node1.text_range().len() < node2.text_range().len())
744     }
745
746     fn resolve_lifetime_param(&self, lifetime: &ast::Lifetime) -> Option<LifetimeParam> {
747         let text = lifetime.text();
748         let lifetime_param = lifetime.syntax().ancestors().find_map(|syn| {
749             let gpl = ast::AnyHasGenericParams::cast(syn)?.generic_param_list()?;
750             gpl.lifetime_params()
751                 .find(|tp| tp.lifetime().as_ref().map(|lt| lt.text()).as_ref() == Some(&text))
752         })?;
753         let src = self.find_file(lifetime_param.syntax().clone()).with_value(lifetime_param);
754         ToDef::to_def(self, src)
755     }
756
757     fn resolve_label(&self, lifetime: &ast::Lifetime) -> Option<Label> {
758         let text = lifetime.text();
759         let label = lifetime.syntax().ancestors().find_map(|syn| {
760             let label = match_ast! {
761                 match syn {
762                     ast::ForExpr(it) => it.label(),
763                     ast::WhileExpr(it) => it.label(),
764                     ast::LoopExpr(it) => it.label(),
765                     ast::BlockExpr(it) => it.label(),
766                     _ => None,
767                 }
768             };
769             label.filter(|l| {
770                 l.lifetime()
771                     .and_then(|lt| lt.lifetime_ident_token())
772                     .map_or(false, |lt| lt.text() == text)
773             })
774         })?;
775         let src = self.find_file(label.syntax().clone()).with_value(label);
776         ToDef::to_def(self, src)
777     }
778
779     fn resolve_type(&self, ty: &ast::Type) -> Option<Type> {
780         let scope = self.scope(ty.syntax());
781         let ctx = body::LowerCtx::new(self.db.upcast(), scope.file_id);
782         let ty = hir_ty::TyLoweringContext::new(self.db, &scope.resolver)
783             .lower_ty(&crate::TypeRef::from_ast(&ctx, ty.clone()));
784         Type::new_with_resolver(self.db, &scope.resolver, ty)
785     }
786
787     fn type_of_expr(&self, expr: &ast::Expr) -> Option<TypeInfo> {
788         self.analyze(expr.syntax())
789             .type_of_expr(self.db, expr)
790             .map(|(ty, coerced)| TypeInfo { original: ty, adjusted: coerced })
791     }
792
793     fn type_of_pat(&self, pat: &ast::Pat) -> Option<TypeInfo> {
794         self.analyze(pat.syntax())
795             .type_of_pat(self.db, pat)
796             .map(|(ty, coerced)| TypeInfo { original: ty, adjusted: coerced })
797     }
798
799     fn type_of_self(&self, param: &ast::SelfParam) -> Option<Type> {
800         self.analyze(param.syntax()).type_of_self(self.db, param)
801     }
802
803     fn resolve_method_call(&self, call: &ast::MethodCallExpr) -> Option<FunctionId> {
804         self.analyze(call.syntax()).resolve_method_call(self.db, call).map(|(id, _)| id)
805     }
806
807     fn resolve_method_call_as_callable(&self, call: &ast::MethodCallExpr) -> Option<Callable> {
808         let (func, subst) = self.analyze(call.syntax()).resolve_method_call(self.db, call)?;
809         let ty = self.db.value_ty(func.into()).substitute(&Interner, &subst);
810         let resolver = self.analyze(call.syntax()).resolver;
811         let ty = Type::new_with_resolver(self.db, &resolver, ty)?;
812         let mut res = ty.as_callable(self.db)?;
813         res.is_bound_method = true;
814         Some(res)
815     }
816
817     fn resolve_field(&self, field: &ast::FieldExpr) -> Option<Field> {
818         self.analyze(field.syntax()).resolve_field(self.db, field)
819     }
820
821     fn resolve_record_field(
822         &self,
823         field: &ast::RecordExprField,
824     ) -> Option<(Field, Option<Local>, Type)> {
825         self.analyze(field.syntax()).resolve_record_field(self.db, field)
826     }
827
828     fn resolve_record_pat_field(&self, field: &ast::RecordPatField) -> Option<Field> {
829         self.analyze(field.syntax()).resolve_record_pat_field(self.db, field)
830     }
831
832     fn resolve_macro_call(&self, macro_call: &ast::MacroCall) -> Option<MacroDef> {
833         let sa = self.analyze(macro_call.syntax());
834         let macro_call = self.find_file(macro_call.syntax().clone()).with_value(macro_call);
835         sa.resolve_macro_call(self.db, macro_call)
836     }
837
838     fn resolve_attr_macro_call(&self, item: &ast::Item) -> Option<MacroDef> {
839         let item_in_file = self.find_file(item.syntax().clone()).with_value(item.clone());
840         let macro_call_id = self.with_ctx(|ctx| ctx.item_to_macro_call(item_in_file))?;
841         Some(MacroDef { id: self.db.lookup_intern_macro(macro_call_id).def })
842     }
843
844     fn resolve_path(&self, path: &ast::Path) -> Option<PathResolution> {
845         self.analyze(path.syntax()).resolve_path(self.db, path)
846     }
847
848     fn resolve_extern_crate(&self, extern_crate: &ast::ExternCrate) -> Option<Crate> {
849         let krate = self.scope(extern_crate.syntax()).krate()?;
850         krate.dependencies(self.db).into_iter().find_map(|dep| {
851             if dep.name == extern_crate.name_ref()?.as_name() {
852                 Some(dep.krate)
853             } else {
854                 None
855             }
856         })
857     }
858
859     fn resolve_variant(&self, record_lit: ast::RecordExpr) -> Option<VariantId> {
860         self.analyze(record_lit.syntax()).resolve_variant(self.db, record_lit)
861     }
862
863     fn resolve_bind_pat_to_const(&self, pat: &ast::IdentPat) -> Option<ModuleDef> {
864         self.analyze(pat.syntax()).resolve_bind_pat_to_const(self.db, pat)
865     }
866
867     fn record_literal_missing_fields(&self, literal: &ast::RecordExpr) -> Vec<(Field, Type)> {
868         self.analyze(literal.syntax())
869             .record_literal_missing_fields(self.db, literal)
870             .unwrap_or_default()
871     }
872
873     fn record_pattern_missing_fields(&self, pattern: &ast::RecordPat) -> Vec<(Field, Type)> {
874         self.analyze(pattern.syntax())
875             .record_pattern_missing_fields(self.db, pattern)
876             .unwrap_or_default()
877     }
878
879     fn with_ctx<F: FnOnce(&mut SourceToDefCtx) -> T, T>(&self, f: F) -> T {
880         let mut cache = self.s2d_cache.borrow_mut();
881         let mut ctx = SourceToDefCtx { db: self.db, cache: &mut *cache };
882         f(&mut ctx)
883     }
884
885     fn to_module_def(&self, file: FileId) -> impl Iterator<Item = Module> {
886         self.with_ctx(|ctx| ctx.file_to_def(file)).into_iter().map(Module::from)
887     }
888
889     fn scope(&self, node: &SyntaxNode) -> SemanticsScope<'db> {
890         let sa = self.analyze(node);
891         SemanticsScope { db: self.db, file_id: sa.file_id, resolver: sa.resolver }
892     }
893
894     fn scope_at_offset(&self, node: &SyntaxNode, offset: TextSize) -> SemanticsScope<'db> {
895         let sa = self.analyze_with_offset(node, offset);
896         SemanticsScope { db: self.db, file_id: sa.file_id, resolver: sa.resolver }
897     }
898
899     fn scope_for_def(&self, def: Trait) -> SemanticsScope<'db> {
900         let file_id = self.db.lookup_intern_trait(def.id).id.file_id();
901         let resolver = def.id.resolver(self.db.upcast());
902         SemanticsScope { db: self.db, file_id, resolver }
903     }
904
905     fn source<Def: HasSource>(&self, def: Def) -> Option<InFile<Def::Ast>>
906     where
907         Def::Ast: AstNode,
908     {
909         let res = def.source(self.db)?;
910         self.cache(find_root(res.value.syntax()), res.file_id);
911         Some(res)
912     }
913
914     fn analyze(&self, node: &SyntaxNode) -> SourceAnalyzer {
915         self.analyze_impl(node, None)
916     }
917     fn analyze_with_offset(&self, node: &SyntaxNode, offset: TextSize) -> SourceAnalyzer {
918         self.analyze_impl(node, Some(offset))
919     }
920     fn analyze_impl(&self, node: &SyntaxNode, offset: Option<TextSize>) -> SourceAnalyzer {
921         let _p = profile::span("Semantics::analyze_impl");
922         let node = self.find_file(node.clone());
923         let node = node.as_ref();
924
925         let container = match self.with_ctx(|ctx| ctx.find_container(node)) {
926             Some(it) => it,
927             None => return SourceAnalyzer::new_for_resolver(Resolver::default(), node),
928         };
929
930         let resolver = match container {
931             ChildContainer::DefWithBodyId(def) => {
932                 return SourceAnalyzer::new_for_body(self.db, def, node, offset)
933             }
934             ChildContainer::TraitId(it) => it.resolver(self.db.upcast()),
935             ChildContainer::ImplId(it) => it.resolver(self.db.upcast()),
936             ChildContainer::ModuleId(it) => it.resolver(self.db.upcast()),
937             ChildContainer::EnumId(it) => it.resolver(self.db.upcast()),
938             ChildContainer::VariantId(it) => it.resolver(self.db.upcast()),
939             ChildContainer::TypeAliasId(it) => it.resolver(self.db.upcast()),
940             ChildContainer::GenericDefId(it) => it.resolver(self.db.upcast()),
941         };
942         SourceAnalyzer::new_for_resolver(resolver, node)
943     }
944
945     fn cache(&self, root_node: SyntaxNode, file_id: HirFileId) {
946         assert!(root_node.parent().is_none());
947         let mut cache = self.cache.borrow_mut();
948         let prev = cache.insert(root_node, file_id);
949         assert!(prev == None || prev == Some(file_id))
950     }
951
952     fn assert_contains_node(&self, node: &SyntaxNode) {
953         self.find_file(node.clone());
954     }
955
956     fn lookup(&self, root_node: &SyntaxNode) -> Option<HirFileId> {
957         let cache = self.cache.borrow();
958         cache.get(root_node).copied()
959     }
960
961     fn find_file(&self, node: SyntaxNode) -> InFile<SyntaxNode> {
962         let root_node = find_root(&node);
963         let file_id = self.lookup(&root_node).unwrap_or_else(|| {
964             panic!(
965                 "\n\nFailed to lookup {:?} in this Semantics.\n\
966                  Make sure to use only query nodes, derived from this instance of Semantics.\n\
967                  root node:   {:?}\n\
968                  known nodes: {}\n\n",
969                 node,
970                 root_node,
971                 self.cache
972                     .borrow()
973                     .keys()
974                     .map(|it| format!("{:?}", it))
975                     .collect::<Vec<_>>()
976                     .join(", ")
977             )
978         });
979         InFile::new(file_id, node)
980     }
981
982     fn is_unsafe_method_call(&self, method_call_expr: &ast::MethodCallExpr) -> bool {
983         method_call_expr
984             .receiver()
985             .and_then(|expr| {
986                 let field_expr = match expr {
987                     ast::Expr::FieldExpr(field_expr) => field_expr,
988                     _ => return None,
989                 };
990                 let ty = self.type_of_expr(&field_expr.expr()?)?.original;
991                 if !ty.is_packed(self.db) {
992                     return None;
993                 }
994
995                 let func = self.resolve_method_call(method_call_expr).map(Function::from)?;
996                 let res = match func.self_param(self.db)?.access(self.db) {
997                     Access::Shared | Access::Exclusive => true,
998                     Access::Owned => false,
999                 };
1000                 Some(res)
1001             })
1002             .unwrap_or(false)
1003     }
1004
1005     fn is_unsafe_ref_expr(&self, ref_expr: &ast::RefExpr) -> bool {
1006         ref_expr
1007             .expr()
1008             .and_then(|expr| {
1009                 let field_expr = match expr {
1010                     ast::Expr::FieldExpr(field_expr) => field_expr,
1011                     _ => return None,
1012                 };
1013                 let expr = field_expr.expr()?;
1014                 self.type_of_expr(&expr)
1015             })
1016             // Binding a reference to a packed type is possibly unsafe.
1017             .map(|ty| ty.original.is_packed(self.db))
1018             .unwrap_or(false)
1019
1020         // FIXME This needs layout computation to be correct. It will highlight
1021         // more than it should with the current implementation.
1022     }
1023
1024     fn is_unsafe_ident_pat(&self, ident_pat: &ast::IdentPat) -> bool {
1025         if ident_pat.ref_token().is_none() {
1026             return false;
1027         }
1028
1029         ident_pat
1030             .syntax()
1031             .parent()
1032             .and_then(|parent| {
1033                 // `IdentPat` can live under `RecordPat` directly under `RecordPatField` or
1034                 // `RecordPatFieldList`. `RecordPatField` also lives under `RecordPatFieldList`,
1035                 // so this tries to lookup the `IdentPat` anywhere along that structure to the
1036                 // `RecordPat` so we can get the containing type.
1037                 let record_pat = ast::RecordPatField::cast(parent.clone())
1038                     .and_then(|record_pat| record_pat.syntax().parent())
1039                     .or_else(|| Some(parent.clone()))
1040                     .and_then(|parent| {
1041                         ast::RecordPatFieldList::cast(parent)?
1042                             .syntax()
1043                             .parent()
1044                             .and_then(ast::RecordPat::cast)
1045                     });
1046
1047                 // If this doesn't match a `RecordPat`, fallback to a `LetStmt` to see if
1048                 // this is initialized from a `FieldExpr`.
1049                 if let Some(record_pat) = record_pat {
1050                     self.type_of_pat(&ast::Pat::RecordPat(record_pat))
1051                 } else if let Some(let_stmt) = ast::LetStmt::cast(parent) {
1052                     let field_expr = match let_stmt.initializer()? {
1053                         ast::Expr::FieldExpr(field_expr) => field_expr,
1054                         _ => return None,
1055                     };
1056
1057                     self.type_of_expr(&field_expr.expr()?)
1058                 } else {
1059                     None
1060                 }
1061             })
1062             // Binding a reference to a packed type is possibly unsafe.
1063             .map(|ty| ty.original.is_packed(self.db))
1064             .unwrap_or(false)
1065     }
1066 }
1067
1068 pub trait ToDef: AstNode + Clone {
1069     type Def;
1070
1071     fn to_def(sema: &SemanticsImpl, src: InFile<Self>) -> Option<Self::Def>;
1072 }
1073
1074 macro_rules! to_def_impls {
1075     ($(($def:path, $ast:path, $meth:ident)),* ,) => {$(
1076         impl ToDef for $ast {
1077             type Def = $def;
1078             fn to_def(sema: &SemanticsImpl, src: InFile<Self>) -> Option<Self::Def> {
1079                 sema.with_ctx(|ctx| ctx.$meth(src)).map(<$def>::from)
1080             }
1081         }
1082     )*}
1083 }
1084
1085 to_def_impls![
1086     (crate::Module, ast::Module, module_to_def),
1087     (crate::Module, ast::SourceFile, source_file_to_def),
1088     (crate::Struct, ast::Struct, struct_to_def),
1089     (crate::Enum, ast::Enum, enum_to_def),
1090     (crate::Union, ast::Union, union_to_def),
1091     (crate::Trait, ast::Trait, trait_to_def),
1092     (crate::Impl, ast::Impl, impl_to_def),
1093     (crate::TypeAlias, ast::TypeAlias, type_alias_to_def),
1094     (crate::Const, ast::Const, const_to_def),
1095     (crate::Static, ast::Static, static_to_def),
1096     (crate::Function, ast::Fn, fn_to_def),
1097     (crate::Field, ast::RecordField, record_field_to_def),
1098     (crate::Field, ast::TupleField, tuple_field_to_def),
1099     (crate::Variant, ast::Variant, enum_variant_to_def),
1100     (crate::TypeParam, ast::TypeParam, type_param_to_def),
1101     (crate::LifetimeParam, ast::LifetimeParam, lifetime_param_to_def),
1102     (crate::ConstParam, ast::ConstParam, const_param_to_def),
1103     (crate::MacroDef, ast::Macro, macro_to_def),
1104     (crate::Local, ast::IdentPat, bind_pat_to_def),
1105     (crate::Local, ast::SelfParam, self_param_to_def),
1106     (crate::Label, ast::Label, label_to_def),
1107     (crate::Adt, ast::Adt, adt_to_def),
1108 ];
1109
1110 fn find_root(node: &SyntaxNode) -> SyntaxNode {
1111     node.ancestors().last().unwrap()
1112 }
1113
1114 /// `SemanticScope` encapsulates the notion of a scope (the set of visible
1115 /// names) at a particular program point.
1116 ///
1117 /// It is a bit tricky, as scopes do not really exist inside the compiler.
1118 /// Rather, the compiler directly computes for each reference the definition it
1119 /// refers to. It might transiently compute the explicit scope map while doing
1120 /// so, but, generally, this is not something left after the analysis.
1121 ///
1122 /// However, we do very much need explicit scopes for IDE purposes --
1123 /// completion, at its core, lists the contents of the current scope. The notion
1124 /// of scope is also useful to answer questions like "what would be the meaning
1125 /// of this piece of code if we inserted it into this position?".
1126 ///
1127 /// So `SemanticsScope` is constructed from a specific program point (a syntax
1128 /// node or just a raw offset) and provides access to the set of visible names
1129 /// on a somewhat best-effort basis.
1130 ///
1131 /// Note that if you are wondering "what does this specific existing name mean?",
1132 /// you'd better use the `resolve_` family of methods.
1133 #[derive(Debug)]
1134 pub struct SemanticsScope<'a> {
1135     pub db: &'a dyn HirDatabase,
1136     file_id: HirFileId,
1137     resolver: Resolver,
1138 }
1139
1140 impl<'a> SemanticsScope<'a> {
1141     pub fn module(&self) -> Option<Module> {
1142         Some(Module { id: self.resolver.module()? })
1143     }
1144
1145     pub fn krate(&self) -> Option<Crate> {
1146         Some(Crate { id: self.resolver.krate()? })
1147     }
1148
1149     /// Note: `FxHashSet<TraitId>` should be treated as an opaque type, passed into `Type
1150     // FIXME: rename to visible_traits to not repeat scope?
1151     pub fn traits_in_scope(&self) -> FxHashSet<TraitId> {
1152         let resolver = &self.resolver;
1153         resolver.traits_in_scope(self.db.upcast())
1154     }
1155
1156     pub fn process_all_names(&self, f: &mut dyn FnMut(Name, ScopeDef)) {
1157         let scope = self.resolver.names_in_scope(self.db.upcast());
1158         for (name, entries) in scope {
1159             for entry in entries {
1160                 let def = match entry {
1161                     resolver::ScopeDef::ModuleDef(it) => ScopeDef::ModuleDef(it.into()),
1162                     resolver::ScopeDef::MacroDef(it) => ScopeDef::MacroDef(it.into()),
1163                     resolver::ScopeDef::Unknown => ScopeDef::Unknown,
1164                     resolver::ScopeDef::ImplSelfType(it) => ScopeDef::ImplSelfType(it.into()),
1165                     resolver::ScopeDef::AdtSelfType(it) => ScopeDef::AdtSelfType(it.into()),
1166                     resolver::ScopeDef::GenericParam(id) => ScopeDef::GenericParam(id.into()),
1167                     resolver::ScopeDef::Local(pat_id) => {
1168                         let parent = self.resolver.body_owner().unwrap();
1169                         ScopeDef::Local(Local { parent, pat_id })
1170                     }
1171                     resolver::ScopeDef::Label(label_id) => {
1172                         let parent = self.resolver.body_owner().unwrap();
1173                         ScopeDef::Label(Label { parent, label_id })
1174                     }
1175                 };
1176                 f(name.clone(), def)
1177             }
1178         }
1179     }
1180
1181     /// Resolve a path as-if it was written at the given scope. This is
1182     /// necessary a heuristic, as it doesn't take hygiene into account.
1183     pub fn speculative_resolve(&self, path: &ast::Path) -> Option<PathResolution> {
1184         let ctx = body::LowerCtx::new(self.db.upcast(), self.file_id);
1185         let path = Path::from_src(path.clone(), &ctx)?;
1186         resolve_hir_path(self.db, &self.resolver, &path)
1187     }
1188
1189     /// Resolve a path as-if it was written at the given scope. This is
1190     /// necessary a heuristic, as it doesn't take hygiene into account.
1191     // FIXME: This special casing solely exists for attributes for now
1192     // ideally we should have a path resolution infra that properly knows about overlapping namespaces
1193     pub fn speculative_resolve_as_mac(&self, path: &ast::Path) -> Option<MacroDef> {
1194         let ctx = body::LowerCtx::new(self.db.upcast(), self.file_id);
1195         let path = Path::from_src(path.clone(), &ctx)?;
1196         resolve_hir_path_as_macro(self.db, &self.resolver, &path)
1197     }
1198 }