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