5 use std::{cell::RefCell, fmt};
7 use base_db::{FileId, FileRange};
10 resolver::{self, HasResolver, Resolver, TypeNs},
11 AsMacroCall, FunctionId, TraitId, VariantId,
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};
19 algo::skip_trivia_token,
20 ast::{self, HasAttrs, HasGenericParams, HasLoopBody},
21 match_ast, AstNode, Direction, SyntaxNode, SyntaxNodePtr, SyntaxToken, TextSize,
26 semantics::source_to_def::{ChildContainer, SourceToDefCache, SourceToDefCtx},
27 source_analyzer::{resolve_hir_path, resolve_hir_path_as_macro, SourceAnalyzer},
28 Access, AssocItem, BuiltinAttr, Callable, ConstParam, Crate, Field, Function, HasSource,
29 HirFileId, Impl, InFile, Label, LifetimeParam, Local, MacroDef, Module, ModuleDef, Name, Path,
30 ScopeDef, ToolModule, Trait, Type, TypeAlias, TypeParam, VariantDef,
33 #[derive(Debug, Clone, PartialEq, Eq)]
34 pub enum PathResolution {
37 /// A local binding (only value namespace)
42 ConstParam(ConstParam),
46 BuiltinAttr(BuiltinAttr),
47 ToolModule(ToolModule),
51 fn in_type_ns(&self) -> Option<TypeNs> {
53 PathResolution::Def(ModuleDef::Adt(adt)) => Some(TypeNs::AdtId((*adt).into())),
54 PathResolution::Def(ModuleDef::BuiltinType(builtin)) => {
55 Some(TypeNs::BuiltinType((*builtin).into()))
59 | ModuleDef::Variant(_)
60 | ModuleDef::Function(_)
61 | ModuleDef::Module(_)
62 | ModuleDef::Static(_)
63 | ModuleDef::Trait(_),
65 PathResolution::Def(ModuleDef::TypeAlias(alias)) => {
66 Some(TypeNs::TypeAliasId((*alias).into()))
68 PathResolution::BuiltinAttr(_)
69 | PathResolution::ToolModule(_)
70 | PathResolution::Local(_)
71 | PathResolution::Macro(_)
72 | PathResolution::ConstParam(_) => None,
73 PathResolution::TypeParam(param) => Some(TypeNs::GenericParam((*param).into())),
74 PathResolution::SelfType(impl_def) => Some(TypeNs::SelfType((*impl_def).into())),
75 PathResolution::AssocItem(AssocItem::Const(_) | AssocItem::Function(_)) => None,
76 PathResolution::AssocItem(AssocItem::TypeAlias(alias)) => {
77 Some(TypeNs::TypeAliasId((*alias).into()))
82 /// Returns an iterator over associated types that may be specified after this path (using
83 /// `Ty::Assoc` syntax).
84 pub fn assoc_type_shorthand_candidates<R>(
87 mut cb: impl FnMut(&Name, TypeAlias) -> Option<R>,
89 associated_type_shorthand_candidates(db, self.in_type_ns()?, |name, _, id| {
97 /// The original type of the expression or pattern.
99 /// The adjusted type, if an adjustment happened.
100 pub adjusted: Option<Type>,
104 pub fn original(self) -> Type {
108 pub fn has_adjustment(&self) -> bool {
109 self.adjusted.is_some()
112 /// The adjusted type, or the original in case no adjustments occurred.
113 pub fn adjusted(self) -> Type {
114 self.adjusted.unwrap_or(self.original)
118 /// Primary API to get semantic information, like types, from syntax trees.
119 pub struct Semantics<'db, DB> {
121 imp: SemanticsImpl<'db>,
124 pub struct SemanticsImpl<'db> {
125 pub db: &'db dyn HirDatabase,
126 s2d_cache: RefCell<SourceToDefCache>,
127 expansion_info_cache: RefCell<FxHashMap<HirFileId, Option<ExpansionInfo>>>,
128 // Rootnode to HirFileId cache
129 cache: RefCell<FxHashMap<SyntaxNode, HirFileId>>,
130 // MacroCall to its expansion's HirFileId cache
131 macro_call_cache: RefCell<FxHashMap<InFile<ast::MacroCall>, HirFileId>>,
134 impl<DB> fmt::Debug for Semantics<'_, DB> {
135 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
136 write!(f, "Semantics {{ ... }}")
140 impl<'db, DB: HirDatabase> Semantics<'db, DB> {
141 pub fn new(db: &DB) -> Semantics<DB> {
142 let impl_ = SemanticsImpl::new(db);
143 Semantics { db, imp: impl_ }
146 pub fn parse(&self, file_id: FileId) -> ast::SourceFile {
147 self.imp.parse(file_id)
150 pub fn parse_or_expand(&self, file_id: HirFileId) -> Option<SyntaxNode> {
151 self.imp.parse_or_expand(file_id)
154 pub fn expand(&self, macro_call: &ast::MacroCall) -> Option<SyntaxNode> {
155 self.imp.expand(macro_call)
158 /// If `item` has an attribute macro attached to it, expands it.
159 pub fn expand_attr_macro(&self, item: &ast::Item) -> Option<SyntaxNode> {
160 self.imp.expand_attr_macro(item)
163 pub fn expand_derive_macro(&self, derive: &ast::Attr) -> Option<Vec<SyntaxNode>> {
164 self.imp.expand_derive_macro(derive)
167 pub fn is_attr_macro_call(&self, item: &ast::Item) -> bool {
168 self.imp.is_attr_macro_call(item)
171 pub fn speculative_expand(
173 actual_macro_call: &ast::MacroCall,
174 speculative_args: &ast::TokenTree,
175 token_to_map: SyntaxToken,
176 ) -> Option<(SyntaxNode, SyntaxToken)> {
177 self.imp.speculative_expand(actual_macro_call, speculative_args, token_to_map)
180 pub fn speculative_expand_attr_macro(
182 actual_macro_call: &ast::Item,
183 speculative_args: &ast::Item,
184 token_to_map: SyntaxToken,
185 ) -> Option<(SyntaxNode, SyntaxToken)> {
186 self.imp.speculative_expand_attr(actual_macro_call, speculative_args, token_to_map)
189 /// Descend the token into macrocalls to its first mapped counterpart.
190 pub fn descend_into_macros_single(&self, token: SyntaxToken) -> SyntaxToken {
191 self.imp.descend_into_macros_single(token)
194 /// Descend the token into macrocalls to all its mapped counterparts.
195 pub fn descend_into_macros(&self, token: SyntaxToken) -> SmallVec<[SyntaxToken; 1]> {
196 self.imp.descend_into_macros(token)
199 /// Maps a node down by mapping its first and last token down.
200 pub fn descend_node_into_attributes<N: AstNode>(&self, node: N) -> SmallVec<[N; 1]> {
201 self.imp.descend_node_into_attributes(node)
204 /// Search for a definition's source and cache its syntax tree
205 pub fn source<Def: HasSource>(&self, def: Def) -> Option<InFile<Def::Ast>>
212 pub fn hir_file_for(&self, syntax_node: &SyntaxNode) -> HirFileId {
213 self.imp.find_file(syntax_node.clone()).file_id
216 pub fn original_range(&self, node: &SyntaxNode) -> FileRange {
217 self.imp.original_range(node)
220 pub fn original_range_opt(&self, node: &SyntaxNode) -> Option<FileRange> {
221 self.imp.original_range_opt(node)
224 pub fn original_ast_node<N: AstNode>(&self, node: N) -> Option<N> {
225 self.imp.original_ast_node(node)
228 pub fn diagnostics_display_range(&self, diagnostics: InFile<SyntaxNodePtr>) -> FileRange {
229 self.imp.diagnostics_display_range(diagnostics)
232 pub fn token_ancestors_with_macros(
235 ) -> impl Iterator<Item = SyntaxNode> + '_ {
236 token.parent().into_iter().flat_map(move |it| self.ancestors_with_macros(it))
239 /// Iterates the ancestors of the given node, climbing up macro expansions while doing so.
240 pub fn ancestors_with_macros(&self, node: SyntaxNode) -> impl Iterator<Item = SyntaxNode> + '_ {
241 self.imp.ancestors_with_macros(node)
244 pub fn ancestors_at_offset_with_macros(
248 ) -> impl Iterator<Item = SyntaxNode> + '_ {
249 self.imp.ancestors_at_offset_with_macros(node, offset)
252 /// Find an AstNode by offset inside SyntaxNode, if it is inside *Macrofile*,
253 /// search up until it is of the target AstNode type
254 pub fn find_node_at_offset_with_macros<N: AstNode>(
259 self.imp.ancestors_at_offset_with_macros(node, offset).find_map(N::cast)
262 /// Find an AstNode by offset inside SyntaxNode, if it is inside *MacroCall*,
263 /// descend it and find again
264 pub fn find_node_at_offset_with_descend<N: AstNode>(
269 self.imp.descend_node_at_offset(node, offset).flatten().find_map(N::cast)
272 /// Find an AstNode by offset inside SyntaxNode, if it is inside *MacroCall*,
273 /// descend it and find again
274 pub fn find_nodes_at_offset_with_descend<'slf, N: AstNode + 'slf>(
278 ) -> impl Iterator<Item = N> + 'slf {
279 self.imp.descend_node_at_offset(node, offset).filter_map(|mut it| it.find_map(N::cast))
282 pub fn resolve_lifetime_param(&self, lifetime: &ast::Lifetime) -> Option<LifetimeParam> {
283 self.imp.resolve_lifetime_param(lifetime)
286 pub fn resolve_label(&self, lifetime: &ast::Lifetime) -> Option<Label> {
287 self.imp.resolve_label(lifetime)
290 pub fn resolve_type(&self, ty: &ast::Type) -> Option<Type> {
291 self.imp.resolve_type(ty)
294 pub fn type_of_expr(&self, expr: &ast::Expr) -> Option<TypeInfo> {
295 self.imp.type_of_expr(expr)
298 pub fn type_of_pat(&self, pat: &ast::Pat) -> Option<TypeInfo> {
299 self.imp.type_of_pat(pat)
302 pub fn type_of_self(&self, param: &ast::SelfParam) -> Option<Type> {
303 self.imp.type_of_self(param)
306 pub fn resolve_method_call(&self, call: &ast::MethodCallExpr) -> Option<Function> {
307 self.imp.resolve_method_call(call).map(Function::from)
310 pub fn resolve_method_call_as_callable(&self, call: &ast::MethodCallExpr) -> Option<Callable> {
311 self.imp.resolve_method_call_as_callable(call)
314 pub fn resolve_field(&self, field: &ast::FieldExpr) -> Option<Field> {
315 self.imp.resolve_field(field)
318 pub fn resolve_record_field(
320 field: &ast::RecordExprField,
321 ) -> Option<(Field, Option<Local>, Type)> {
322 self.imp.resolve_record_field(field)
325 pub fn resolve_record_pat_field(&self, field: &ast::RecordPatField) -> Option<Field> {
326 self.imp.resolve_record_pat_field(field)
329 pub fn resolve_macro_call(&self, macro_call: &ast::MacroCall) -> Option<MacroDef> {
330 self.imp.resolve_macro_call(macro_call)
333 pub fn resolve_attr_macro_call(&self, item: &ast::Item) -> Option<MacroDef> {
334 self.imp.resolve_attr_macro_call(item)
337 pub fn resolve_path(&self, path: &ast::Path) -> Option<PathResolution> {
338 self.imp.resolve_path(path)
341 pub fn resolve_extern_crate(&self, extern_crate: &ast::ExternCrate) -> Option<Crate> {
342 self.imp.resolve_extern_crate(extern_crate)
345 pub fn resolve_variant(&self, record_lit: ast::RecordExpr) -> Option<VariantDef> {
346 self.imp.resolve_variant(record_lit).map(VariantDef::from)
349 pub fn resolve_bind_pat_to_const(&self, pat: &ast::IdentPat) -> Option<ModuleDef> {
350 self.imp.resolve_bind_pat_to_const(pat)
353 // FIXME: use this instead?
354 // pub fn resolve_name_ref(&self, name_ref: &ast::NameRef) -> Option<???>;
356 pub fn record_literal_missing_fields(&self, literal: &ast::RecordExpr) -> Vec<(Field, Type)> {
357 self.imp.record_literal_missing_fields(literal)
360 pub fn record_pattern_missing_fields(&self, pattern: &ast::RecordPat) -> Vec<(Field, Type)> {
361 self.imp.record_pattern_missing_fields(pattern)
364 pub fn to_def<T: ToDef>(&self, src: &T) -> Option<T::Def> {
365 let src = self.imp.find_file(src.syntax().clone()).with_value(src).cloned();
366 T::to_def(&self.imp, src)
369 pub fn to_module_def(&self, file: FileId) -> Option<Module> {
370 self.imp.to_module_def(file).next()
373 pub fn to_module_defs(&self, file: FileId) -> impl Iterator<Item = Module> {
374 self.imp.to_module_def(file)
377 pub fn scope(&self, node: &SyntaxNode) -> SemanticsScope<'db> {
381 pub fn scope_at_offset(&self, token: &SyntaxToken, offset: TextSize) -> SemanticsScope<'db> {
382 self.imp.scope_at_offset(&token.parent().unwrap(), offset)
385 pub fn scope_for_def(&self, def: Trait) -> SemanticsScope<'db> {
386 self.imp.scope_for_def(def)
389 pub fn assert_contains_node(&self, node: &SyntaxNode) {
390 self.imp.assert_contains_node(node)
393 pub fn is_unsafe_method_call(&self, method_call_expr: &ast::MethodCallExpr) -> bool {
394 self.imp.is_unsafe_method_call(method_call_expr)
397 pub fn is_unsafe_ref_expr(&self, ref_expr: &ast::RefExpr) -> bool {
398 self.imp.is_unsafe_ref_expr(ref_expr)
401 pub fn is_unsafe_ident_pat(&self, ident_pat: &ast::IdentPat) -> bool {
402 self.imp.is_unsafe_ident_pat(ident_pat)
406 impl<'db> SemanticsImpl<'db> {
407 fn new(db: &'db dyn HirDatabase) -> Self {
410 s2d_cache: Default::default(),
411 cache: Default::default(),
412 expansion_info_cache: Default::default(),
413 macro_call_cache: Default::default(),
417 fn parse(&self, file_id: FileId) -> ast::SourceFile {
418 let tree = self.db.parse(file_id).tree();
419 self.cache(tree.syntax().clone(), file_id.into());
423 fn parse_or_expand(&self, file_id: HirFileId) -> Option<SyntaxNode> {
424 let node = self.db.parse_or_expand(file_id)?;
425 self.cache(node.clone(), file_id);
429 fn expand(&self, macro_call: &ast::MacroCall) -> Option<SyntaxNode> {
430 let sa = self.analyze(macro_call.syntax());
431 let file_id = sa.expand(self.db, InFile::new(sa.file_id, macro_call))?;
432 let node = self.db.parse_or_expand(file_id)?;
433 self.cache(node.clone(), file_id);
437 fn expand_attr_macro(&self, item: &ast::Item) -> Option<SyntaxNode> {
438 let sa = self.analyze(item.syntax());
439 let src = InFile::new(sa.file_id, item.clone());
440 let macro_call_id = self.with_ctx(|ctx| ctx.item_to_macro_call(src))?;
441 let file_id = macro_call_id.as_file();
442 let node = self.db.parse_or_expand(file_id)?;
443 self.cache(node.clone(), file_id);
447 fn expand_derive_macro(&self, attr: &ast::Attr) -> Option<Vec<SyntaxNode>> {
448 let item = attr.syntax().parent().and_then(ast::Item::cast)?;
449 let sa = self.analyze(item.syntax());
450 let item = InFile::new(sa.file_id, &item);
451 let src = InFile::new(sa.file_id, attr.clone());
452 self.with_ctx(|ctx| {
453 let macro_call_ids = ctx.attr_to_derive_macro_call(item, src)?;
455 let expansions: Vec<_> = macro_call_ids
457 .map(|call| call.as_file())
458 .flat_map(|file_id| {
459 let node = self.db.parse_or_expand(file_id)?;
460 self.cache(node.clone(), file_id);
464 if expansions.is_empty() {
472 fn is_attr_macro_call(&self, item: &ast::Item) -> bool {
473 let sa = self.analyze(item.syntax());
474 let src = InFile::new(sa.file_id, item.clone());
475 self.with_ctx(|ctx| ctx.item_to_macro_call(src).is_some())
478 fn speculative_expand(
480 actual_macro_call: &ast::MacroCall,
481 speculative_args: &ast::TokenTree,
482 token_to_map: SyntaxToken,
483 ) -> Option<(SyntaxNode, SyntaxToken)> {
484 let sa = self.analyze(actual_macro_call.syntax());
485 let macro_call = InFile::new(sa.file_id, actual_macro_call);
486 let krate = sa.resolver.krate()?;
487 let macro_call_id = macro_call.as_call_id(self.db.upcast(), krate, |path| {
488 sa.resolver.resolve_path_as_macro(self.db.upcast(), &path)
490 hir_expand::db::expand_speculative(
493 speculative_args.syntax(),
498 fn speculative_expand_attr(
500 actual_macro_call: &ast::Item,
501 speculative_args: &ast::Item,
502 token_to_map: SyntaxToken,
503 ) -> Option<(SyntaxNode, SyntaxToken)> {
504 let sa = self.analyze(actual_macro_call.syntax());
505 let macro_call = InFile::new(sa.file_id, actual_macro_call.clone());
506 let macro_call_id = self.with_ctx(|ctx| ctx.item_to_macro_call(macro_call))?;
507 hir_expand::db::expand_speculative(
510 speculative_args.syntax(),
515 // This might not be the correct way to do this, but it works for now
516 fn descend_node_into_attributes<N: AstNode>(&self, node: N) -> SmallVec<[N; 1]> {
517 let mut res = smallvec![];
519 let first = skip_trivia_token(node.syntax().first_token()?, Direction::Next)?;
520 let last = skip_trivia_token(node.syntax().last_token()?, Direction::Prev)?;
523 let (first, last) = match tokens {
529 self.descend_into_macros_impl(
531 &mut |InFile { value, .. }| {
532 if let Some(node) = value.ancestors().find_map(N::cast) {
539 // Descend first and last token, then zip them to look for the node they belong to
540 let mut scratch: SmallVec<[_; 1]> = smallvec![];
541 self.descend_into_macros_impl(
549 let mut scratch = scratch.into_iter();
550 self.descend_into_macros_impl(
552 &mut |InFile { value: last, file_id: last_fid }| {
553 if let Some(InFile { value: first, file_id: first_fid }) = scratch.next() {
554 if first_fid == last_fid {
555 if let Some(p) = first.parent() {
556 let range = first.text_range().cover(last.text_range());
557 let node = find_root(&p)
558 .covering_element(range)
560 .take_while(|it| it.text_range() == range)
562 if let Some(node) = node {
575 fn descend_into_macros(&self, token: SyntaxToken) -> SmallVec<[SyntaxToken; 1]> {
576 let mut res = smallvec![];
577 self.descend_into_macros_impl(token, &mut |InFile { value, .. }| res.push(value), false);
581 fn descend_into_macros_single(&self, token: SyntaxToken) -> SyntaxToken {
582 let mut res = token.clone();
583 self.descend_into_macros_impl(token, &mut |InFile { value, .. }| res = value, true);
587 fn descend_into_macros_impl(
590 f: &mut dyn FnMut(InFile<SyntaxToken>),
593 let _p = profile::span("descend_into_macros");
594 let parent = match token.parent() {
598 let sa = self.analyze_no_infer(&parent);
599 let mut stack: SmallVec<[_; 4]> = smallvec![InFile::new(sa.file_id, token)];
600 let mut cache = self.expansion_info_cache.borrow_mut();
601 let mut mcache = self.macro_call_cache.borrow_mut();
603 let mut process_expansion_for_token =
604 |stack: &mut SmallVec<_>, macro_file, item, token: InFile<&_>| {
605 let expansion_info = cache
607 .or_insert_with(|| macro_file.expansion_info(self.db.upcast()))
611 let InFile { file_id, value } = expansion_info.expanded();
612 self.cache(value, file_id);
615 let mut mapped_tokens =
616 expansion_info.map_token_down(self.db.upcast(), item, token)?;
618 let len = stack.len();
619 // requeue the tokens we got from mapping our current token down
621 stack.extend(mapped_tokens.next());
623 stack.extend(mapped_tokens);
625 // if the length changed we have found a mapping for the token
626 (stack.len() != len).then(|| ())
629 // Remap the next token in the queue into a macro call its in, if it is not being remapped
630 // either due to not being in a macro-call or because its unused push it into the result vec,
631 // otherwise push the remapped tokens back into the queue as they can potentially be remapped again.
632 while let Some(token) = stack.pop() {
633 self.db.unwind_if_cancelled();
634 let was_not_remapped = (|| {
635 // are we inside an attribute macro call
636 let containing_attribute_macro_call = self.with_ctx(|ctx| {
637 token.value.ancestors().filter_map(ast::Item::cast).find_map(|item| {
638 if item.attrs().next().is_none() {
639 // Don't force populate the dyn cache for items that don't have an attribute anyways
642 Some((ctx.item_to_macro_call(token.with_value(item.clone()))?, item))
645 if let Some((call_id, item)) = containing_attribute_macro_call {
646 let file_id = call_id.as_file();
647 return process_expansion_for_token(
655 // or are we inside a function-like macro call
657 // FIXME replace map.while_some with take_while once stable
658 token.value.ancestors().map(ast::TokenTree::cast).while_some().last()
660 let macro_call = tt.syntax().parent().and_then(ast::MacroCall::cast)?;
661 if tt.left_delimiter_token().map_or(false, |it| it == token.value) {
664 if tt.right_delimiter_token().map_or(false, |it| it == token.value) {
668 let mcall = token.with_value(macro_call);
669 let file_id = match mcache.get(&mcall) {
672 let it = sa.expand(self.db, mcall.as_ref())?;
673 mcache.insert(mcall, it);
677 return process_expansion_for_token(&mut stack, file_id, None, token.as_ref());
680 // outside of a macro invocation so this is a "final" token
685 if was_not_remapped {
691 // Note this return type is deliberate as [`find_nodes_at_offset_with_descend`] wants to stop
692 // traversing the inner iterator when it finds a node.
693 // The outer iterator is over the tokens descendants
694 // The inner iterator is the ancestors of a descendant
695 fn descend_node_at_offset(
699 ) -> impl Iterator<Item = impl Iterator<Item = SyntaxNode> + '_> + '_ {
700 node.token_at_offset(offset)
701 .map(move |token| self.descend_into_macros(token))
703 descendants.into_iter().map(move |it| self.token_ancestors_with_macros(it))
705 // re-order the tokens from token_at_offset by returning the ancestors with the smaller first nodes first
706 // See algo::ancestors_at_offset, which uses the same approach
707 .kmerge_by(|left, right| {
709 .map(|node| node.text_range().len())
710 .lt(right.clone().map(|node| node.text_range().len()))
714 fn original_range(&self, node: &SyntaxNode) -> FileRange {
715 let node = self.find_file(node.clone());
716 node.as_ref().original_file_range(self.db.upcast())
719 fn original_range_opt(&self, node: &SyntaxNode) -> Option<FileRange> {
720 let node = self.find_file(node.clone());
721 node.as_ref().original_file_range_opt(self.db.upcast())
724 fn original_ast_node<N: AstNode>(&self, node: N) -> Option<N> {
725 let file = self.find_file(node.syntax().clone());
726 file.with_value(node).original_ast_node(self.db.upcast()).map(|it| it.value)
729 fn diagnostics_display_range(&self, src: InFile<SyntaxNodePtr>) -> FileRange {
730 let root = self.db.parse_or_expand(src.file_id).unwrap();
731 let node = src.value.to_node(&root);
732 self.cache(root, src.file_id);
733 src.with_value(&node).original_file_range(self.db.upcast())
736 fn token_ancestors_with_macros(
739 ) -> impl Iterator<Item = SyntaxNode> + Clone + '_ {
740 token.parent().into_iter().flat_map(move |parent| self.ancestors_with_macros(parent))
743 fn ancestors_with_macros(
746 ) -> impl Iterator<Item = SyntaxNode> + Clone + '_ {
747 let node = self.find_file(node);
748 node.ancestors_with_macros(self.db.upcast()).map(|it| it.value)
751 fn ancestors_at_offset_with_macros(
755 ) -> impl Iterator<Item = SyntaxNode> + '_ {
756 node.token_at_offset(offset)
757 .map(|token| self.token_ancestors_with_macros(token))
758 .kmerge_by(|node1, node2| node1.text_range().len() < node2.text_range().len())
761 fn resolve_lifetime_param(&self, lifetime: &ast::Lifetime) -> Option<LifetimeParam> {
762 let text = lifetime.text();
763 let lifetime_param = lifetime.syntax().ancestors().find_map(|syn| {
764 let gpl = ast::AnyHasGenericParams::cast(syn)?.generic_param_list()?;
765 gpl.lifetime_params()
766 .find(|tp| tp.lifetime().as_ref().map(|lt| lt.text()).as_ref() == Some(&text))
768 let src = self.find_file(lifetime_param.syntax().clone()).with_value(lifetime_param);
769 ToDef::to_def(self, src)
772 fn resolve_label(&self, lifetime: &ast::Lifetime) -> Option<Label> {
773 let text = lifetime.text();
774 let label = lifetime.syntax().ancestors().find_map(|syn| {
775 let label = match_ast! {
777 ast::ForExpr(it) => it.label(),
778 ast::WhileExpr(it) => it.label(),
779 ast::LoopExpr(it) => it.label(),
780 ast::BlockExpr(it) => it.label(),
786 .and_then(|lt| lt.lifetime_ident_token())
787 .map_or(false, |lt| lt.text() == text)
790 let src = self.find_file(label.syntax().clone()).with_value(label);
791 ToDef::to_def(self, src)
794 fn resolve_type(&self, ty: &ast::Type) -> Option<Type> {
795 let scope = self.scope(ty.syntax());
796 let ctx = body::LowerCtx::new(self.db.upcast(), scope.file_id);
797 let ty = hir_ty::TyLoweringContext::new(self.db, &scope.resolver)
798 .lower_ty(&crate::TypeRef::from_ast(&ctx, ty.clone()));
799 Type::new_with_resolver(self.db, &scope.resolver, ty)
802 fn type_of_expr(&self, expr: &ast::Expr) -> Option<TypeInfo> {
803 self.analyze(expr.syntax())
804 .type_of_expr(self.db, expr)
805 .map(|(ty, coerced)| TypeInfo { original: ty, adjusted: coerced })
808 fn type_of_pat(&self, pat: &ast::Pat) -> Option<TypeInfo> {
809 self.analyze(pat.syntax())
810 .type_of_pat(self.db, pat)
811 .map(|(ty, coerced)| TypeInfo { original: ty, adjusted: coerced })
814 fn type_of_self(&self, param: &ast::SelfParam) -> Option<Type> {
815 self.analyze(param.syntax()).type_of_self(self.db, param)
818 fn resolve_method_call(&self, call: &ast::MethodCallExpr) -> Option<FunctionId> {
819 self.analyze(call.syntax()).resolve_method_call(self.db, call).map(|(id, _)| id)
822 fn resolve_method_call_as_callable(&self, call: &ast::MethodCallExpr) -> Option<Callable> {
823 let (func, subst) = self.analyze(call.syntax()).resolve_method_call(self.db, call)?;
824 let ty = self.db.value_ty(func.into()).substitute(Interner, &subst);
825 let resolver = self.analyze(call.syntax()).resolver;
826 let ty = Type::new_with_resolver(self.db, &resolver, ty)?;
827 let mut res = ty.as_callable(self.db)?;
828 res.is_bound_method = true;
832 fn resolve_field(&self, field: &ast::FieldExpr) -> Option<Field> {
833 self.analyze(field.syntax()).resolve_field(self.db, field)
836 fn resolve_record_field(
838 field: &ast::RecordExprField,
839 ) -> Option<(Field, Option<Local>, Type)> {
840 self.analyze(field.syntax()).resolve_record_field(self.db, field)
843 fn resolve_record_pat_field(&self, field: &ast::RecordPatField) -> Option<Field> {
844 self.analyze(field.syntax()).resolve_record_pat_field(self.db, field)
847 fn resolve_macro_call(&self, macro_call: &ast::MacroCall) -> Option<MacroDef> {
848 let sa = self.analyze(macro_call.syntax());
849 let macro_call = self.find_file(macro_call.syntax().clone()).with_value(macro_call);
850 sa.resolve_macro_call(self.db, macro_call)
853 fn resolve_attr_macro_call(&self, item: &ast::Item) -> Option<MacroDef> {
854 let item_in_file = self.find_file(item.syntax().clone()).with_value(item.clone());
855 let macro_call_id = self.with_ctx(|ctx| ctx.item_to_macro_call(item_in_file))?;
856 Some(MacroDef { id: self.db.lookup_intern_macro_call(macro_call_id).def })
859 fn resolve_path(&self, path: &ast::Path) -> Option<PathResolution> {
860 self.analyze(path.syntax()).resolve_path(self.db, path)
863 fn resolve_extern_crate(&self, extern_crate: &ast::ExternCrate) -> Option<Crate> {
864 let krate = self.scope(extern_crate.syntax()).krate()?;
865 krate.dependencies(self.db).into_iter().find_map(|dep| {
866 if dep.name == extern_crate.name_ref()?.as_name() {
874 fn resolve_variant(&self, record_lit: ast::RecordExpr) -> Option<VariantId> {
875 self.analyze(record_lit.syntax()).resolve_variant(self.db, record_lit)
878 fn resolve_bind_pat_to_const(&self, pat: &ast::IdentPat) -> Option<ModuleDef> {
879 self.analyze(pat.syntax()).resolve_bind_pat_to_const(self.db, pat)
882 fn record_literal_missing_fields(&self, literal: &ast::RecordExpr) -> Vec<(Field, Type)> {
883 self.analyze(literal.syntax())
884 .record_literal_missing_fields(self.db, literal)
888 fn record_pattern_missing_fields(&self, pattern: &ast::RecordPat) -> Vec<(Field, Type)> {
889 self.analyze(pattern.syntax())
890 .record_pattern_missing_fields(self.db, pattern)
894 fn with_ctx<F: FnOnce(&mut SourceToDefCtx) -> T, T>(&self, f: F) -> T {
895 let mut cache = self.s2d_cache.borrow_mut();
896 let mut ctx = SourceToDefCtx { db: self.db, cache: &mut *cache };
900 fn to_module_def(&self, file: FileId) -> impl Iterator<Item = Module> {
901 self.with_ctx(|ctx| ctx.file_to_def(file)).into_iter().map(Module::from)
904 fn scope(&self, node: &SyntaxNode) -> SemanticsScope<'db> {
905 let SourceAnalyzer { file_id, resolver, .. } = self.analyze(node);
906 SemanticsScope { db: self.db, file_id, resolver }
909 fn scope_at_offset(&self, node: &SyntaxNode, offset: TextSize) -> SemanticsScope<'db> {
910 let SourceAnalyzer { file_id, resolver, .. } = self.analyze_with_offset(node, offset);
911 SemanticsScope { db: self.db, file_id, resolver }
914 fn scope_for_def(&self, def: Trait) -> SemanticsScope<'db> {
915 let file_id = self.db.lookup_intern_trait(def.id).id.file_id();
916 let resolver = def.id.resolver(self.db.upcast());
917 SemanticsScope { db: self.db, file_id, resolver }
920 fn source<Def: HasSource>(&self, def: Def) -> Option<InFile<Def::Ast>>
924 let res = def.source(self.db)?;
925 self.cache(find_root(res.value.syntax()), res.file_id);
929 fn analyze(&self, node: &SyntaxNode) -> SourceAnalyzer {
930 self.analyze_impl(node, None, true)
933 fn analyze_with_offset(&self, node: &SyntaxNode, offset: TextSize) -> SourceAnalyzer {
934 self.analyze_impl(node, Some(offset), true)
937 fn analyze_no_infer(&self, node: &SyntaxNode) -> SourceAnalyzer {
938 self.analyze_impl(node, None, false)
944 offset: Option<TextSize>,
946 ) -> SourceAnalyzer {
947 let _p = profile::span("Semantics::analyze_impl");
948 let node = self.find_file(node.clone());
949 let node = node.as_ref();
951 let container = match self.with_ctx(|ctx| ctx.find_container(node)) {
953 None => return SourceAnalyzer::new_for_resolver(Resolver::default(), node),
956 let resolver = match container {
957 ChildContainer::DefWithBodyId(def) => {
958 return if infer_body {
959 SourceAnalyzer::new_for_body(self.db, def, node, offset)
961 SourceAnalyzer::new_for_body_no_infer(self.db, def, node, offset)
964 ChildContainer::TraitId(it) => it.resolver(self.db.upcast()),
965 ChildContainer::ImplId(it) => it.resolver(self.db.upcast()),
966 ChildContainer::ModuleId(it) => it.resolver(self.db.upcast()),
967 ChildContainer::EnumId(it) => it.resolver(self.db.upcast()),
968 ChildContainer::VariantId(it) => it.resolver(self.db.upcast()),
969 ChildContainer::TypeAliasId(it) => it.resolver(self.db.upcast()),
970 ChildContainer::GenericDefId(it) => it.resolver(self.db.upcast()),
972 SourceAnalyzer::new_for_resolver(resolver, node)
975 fn cache(&self, root_node: SyntaxNode, file_id: HirFileId) {
976 assert!(root_node.parent().is_none());
977 let mut cache = self.cache.borrow_mut();
978 let prev = cache.insert(root_node, file_id);
979 assert!(prev == None || prev == Some(file_id))
982 fn assert_contains_node(&self, node: &SyntaxNode) {
983 self.find_file(node.clone());
986 fn lookup(&self, root_node: &SyntaxNode) -> Option<HirFileId> {
987 let cache = self.cache.borrow();
988 cache.get(root_node).copied()
991 fn find_file(&self, node: SyntaxNode) -> InFile<SyntaxNode> {
992 let root_node = find_root(&node);
993 let file_id = self.lookup(&root_node).unwrap_or_else(|| {
995 "\n\nFailed to lookup {:?} in this Semantics.\n\
996 Make sure to use only query nodes, derived from this instance of Semantics.\n\
998 known nodes: {}\n\n",
1004 .map(|it| format!("{:?}", it))
1005 .collect::<Vec<_>>()
1009 InFile::new(file_id, node)
1012 fn is_unsafe_method_call(&self, method_call_expr: &ast::MethodCallExpr) -> bool {
1016 let field_expr = match expr {
1017 ast::Expr::FieldExpr(field_expr) => field_expr,
1020 let ty = self.type_of_expr(&field_expr.expr()?)?.original;
1021 if !ty.is_packed(self.db) {
1025 let func = self.resolve_method_call(method_call_expr).map(Function::from)?;
1026 let res = match func.self_param(self.db)?.access(self.db) {
1027 Access::Shared | Access::Exclusive => true,
1028 Access::Owned => false,
1035 fn is_unsafe_ref_expr(&self, ref_expr: &ast::RefExpr) -> bool {
1039 let field_expr = match expr {
1040 ast::Expr::FieldExpr(field_expr) => field_expr,
1043 let expr = field_expr.expr()?;
1044 self.type_of_expr(&expr)
1046 // Binding a reference to a packed type is possibly unsafe.
1047 .map(|ty| ty.original.is_packed(self.db))
1050 // FIXME This needs layout computation to be correct. It will highlight
1051 // more than it should with the current implementation.
1054 fn is_unsafe_ident_pat(&self, ident_pat: &ast::IdentPat) -> bool {
1055 if ident_pat.ref_token().is_none() {
1062 .and_then(|parent| {
1063 // `IdentPat` can live under `RecordPat` directly under `RecordPatField` or
1064 // `RecordPatFieldList`. `RecordPatField` also lives under `RecordPatFieldList`,
1065 // so this tries to lookup the `IdentPat` anywhere along that structure to the
1066 // `RecordPat` so we can get the containing type.
1067 let record_pat = ast::RecordPatField::cast(parent.clone())
1068 .and_then(|record_pat| record_pat.syntax().parent())
1069 .or_else(|| Some(parent.clone()))
1070 .and_then(|parent| {
1071 ast::RecordPatFieldList::cast(parent)?
1074 .and_then(ast::RecordPat::cast)
1077 // If this doesn't match a `RecordPat`, fallback to a `LetStmt` to see if
1078 // this is initialized from a `FieldExpr`.
1079 if let Some(record_pat) = record_pat {
1080 self.type_of_pat(&ast::Pat::RecordPat(record_pat))
1081 } else if let Some(let_stmt) = ast::LetStmt::cast(parent) {
1082 let field_expr = match let_stmt.initializer()? {
1083 ast::Expr::FieldExpr(field_expr) => field_expr,
1087 self.type_of_expr(&field_expr.expr()?)
1092 // Binding a reference to a packed type is possibly unsafe.
1093 .map(|ty| ty.original.is_packed(self.db))
1098 pub trait ToDef: AstNode + Clone {
1101 fn to_def(sema: &SemanticsImpl, src: InFile<Self>) -> Option<Self::Def>;
1104 macro_rules! to_def_impls {
1105 ($(($def:path, $ast:path, $meth:ident)),* ,) => {$(
1106 impl ToDef for $ast {
1108 fn to_def(sema: &SemanticsImpl, src: InFile<Self>) -> Option<Self::Def> {
1109 sema.with_ctx(|ctx| ctx.$meth(src)).map(<$def>::from)
1116 (crate::Module, ast::Module, module_to_def),
1117 (crate::Module, ast::SourceFile, source_file_to_def),
1118 (crate::Struct, ast::Struct, struct_to_def),
1119 (crate::Enum, ast::Enum, enum_to_def),
1120 (crate::Union, ast::Union, union_to_def),
1121 (crate::Trait, ast::Trait, trait_to_def),
1122 (crate::Impl, ast::Impl, impl_to_def),
1123 (crate::TypeAlias, ast::TypeAlias, type_alias_to_def),
1124 (crate::Const, ast::Const, const_to_def),
1125 (crate::Static, ast::Static, static_to_def),
1126 (crate::Function, ast::Fn, fn_to_def),
1127 (crate::Field, ast::RecordField, record_field_to_def),
1128 (crate::Field, ast::TupleField, tuple_field_to_def),
1129 (crate::Variant, ast::Variant, enum_variant_to_def),
1130 (crate::TypeParam, ast::TypeParam, type_param_to_def),
1131 (crate::LifetimeParam, ast::LifetimeParam, lifetime_param_to_def),
1132 (crate::ConstParam, ast::ConstParam, const_param_to_def),
1133 (crate::GenericParam, ast::GenericParam, generic_param_to_def),
1134 (crate::MacroDef, ast::Macro, macro_to_def),
1135 (crate::Local, ast::IdentPat, bind_pat_to_def),
1136 (crate::Local, ast::SelfParam, self_param_to_def),
1137 (crate::Label, ast::Label, label_to_def),
1138 (crate::Adt, ast::Adt, adt_to_def),
1141 fn find_root(node: &SyntaxNode) -> SyntaxNode {
1142 node.ancestors().last().unwrap()
1145 /// `SemanticScope` encapsulates the notion of a scope (the set of visible
1146 /// names) at a particular program point.
1148 /// It is a bit tricky, as scopes do not really exist inside the compiler.
1149 /// Rather, the compiler directly computes for each reference the definition it
1150 /// refers to. It might transiently compute the explicit scope map while doing
1151 /// so, but, generally, this is not something left after the analysis.
1153 /// However, we do very much need explicit scopes for IDE purposes --
1154 /// completion, at its core, lists the contents of the current scope. The notion
1155 /// of scope is also useful to answer questions like "what would be the meaning
1156 /// of this piece of code if we inserted it into this position?".
1158 /// So `SemanticsScope` is constructed from a specific program point (a syntax
1159 /// node or just a raw offset) and provides access to the set of visible names
1160 /// on a somewhat best-effort basis.
1162 /// Note that if you are wondering "what does this specific existing name mean?",
1163 /// you'd better use the `resolve_` family of methods.
1165 pub struct SemanticsScope<'a> {
1166 pub db: &'a dyn HirDatabase,
1171 impl<'a> SemanticsScope<'a> {
1172 pub fn module(&self) -> Option<Module> {
1173 Some(Module { id: self.resolver.module()? })
1176 pub fn krate(&self) -> Option<Crate> {
1177 Some(Crate { id: self.resolver.krate()? })
1180 /// Note: `FxHashSet<TraitId>` should be treated as an opaque type, passed into `Type
1181 pub fn visible_traits(&self) -> FxHashSet<TraitId> {
1182 let resolver = &self.resolver;
1183 resolver.traits_in_scope(self.db.upcast())
1186 pub fn process_all_names(&self, f: &mut dyn FnMut(Name, ScopeDef)) {
1187 let scope = self.resolver.names_in_scope(self.db.upcast());
1188 for (name, entries) in scope {
1189 for entry in entries {
1190 let def = match entry {
1191 resolver::ScopeDef::ModuleDef(it) => ScopeDef::ModuleDef(it.into()),
1192 resolver::ScopeDef::MacroDef(it) => ScopeDef::MacroDef(it.into()),
1193 resolver::ScopeDef::Unknown => ScopeDef::Unknown,
1194 resolver::ScopeDef::ImplSelfType(it) => ScopeDef::ImplSelfType(it.into()),
1195 resolver::ScopeDef::AdtSelfType(it) => ScopeDef::AdtSelfType(it.into()),
1196 resolver::ScopeDef::GenericParam(id) => ScopeDef::GenericParam(id.into()),
1197 resolver::ScopeDef::Local(pat_id) => {
1198 let parent = self.resolver.body_owner().unwrap();
1199 ScopeDef::Local(Local { parent, pat_id })
1201 resolver::ScopeDef::Label(label_id) => {
1202 let parent = self.resolver.body_owner().unwrap();
1203 ScopeDef::Label(Label { parent, label_id })
1206 f(name.clone(), def)
1211 /// Resolve a path as-if it was written at the given scope. This is
1212 /// necessary a heuristic, as it doesn't take hygiene into account.
1213 pub fn speculative_resolve(&self, path: &ast::Path) -> Option<PathResolution> {
1214 let ctx = body::LowerCtx::new(self.db.upcast(), self.file_id);
1215 let path = Path::from_src(path.clone(), &ctx)?;
1216 resolve_hir_path(self.db, &self.resolver, &path)
1219 /// Resolve a path as-if it was written at the given scope. This is
1220 /// necessary a heuristic, as it doesn't take hygiene into account.
1221 // FIXME: This special casing solely exists for attributes for now
1222 // ideally we should have a path resolution infra that properly knows about overlapping namespaces
1223 pub fn speculative_resolve_as_mac(&self, path: &ast::Path) -> Option<MacroDef> {
1224 let ctx = body::LowerCtx::new(self.db.upcast(), self.file_id);
1225 let path = Path::from_src(path.clone(), &ctx)?;
1226 resolve_hir_path_as_macro(self.db, &self.resolver, &path)