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, HasGenericParams, HasLoopBody},
21 match_ast, AstNode, Direction, SyntaxNode, SyntaxNodePtr, SyntaxToken, TextRange, TextSize,
26 semantics::source_to_def::{ChildContainer, SourceToDefCache, SourceToDefCtx},
27 source_analyzer::{resolve_hir_path, SourceAnalyzer},
28 Access, AssocItem, Callable, ConstParam, Crate, Field, Function, HirFileId, Impl, InFile,
29 Label, LifetimeParam, Local, MacroDef, Module, ModuleDef, Name, Path, ScopeDef, Trait, Type,
30 TypeAlias, TypeParam, VariantDef,
33 #[derive(Debug, Clone, PartialEq, Eq)]
34 pub enum PathResolution {
37 /// A local binding (only value namespace)
42 ConstParam(ConstParam),
49 fn in_type_ns(&self) -> Option<TypeNs> {
51 PathResolution::Def(ModuleDef::Adt(adt)) => Some(TypeNs::AdtId((*adt).into())),
52 PathResolution::Def(ModuleDef::BuiltinType(builtin)) => {
53 Some(TypeNs::BuiltinType((*builtin).into()))
57 | ModuleDef::Variant(_)
58 | ModuleDef::Function(_)
59 | ModuleDef::Module(_)
60 | ModuleDef::Static(_)
61 | ModuleDef::Trait(_),
63 PathResolution::Def(ModuleDef::TypeAlias(alias)) => {
64 Some(TypeNs::TypeAliasId((*alias).into()))
66 PathResolution::Local(_) | PathResolution::Macro(_) | PathResolution::ConstParam(_) => {
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()))
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>(
83 mut cb: impl FnMut(&Name, TypeAlias) -> Option<R>,
85 associated_type_shorthand_candidates(db, self.in_type_ns()?, |name, _, id| {
93 /// The original type of the expression or pattern.
95 /// The adjusted type, if an adjustment happened.
96 pub adjusted: Option<Type>,
100 pub fn original(self) -> Type {
104 pub fn has_adjustment(&self) -> bool {
105 self.adjusted.is_some()
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)
114 /// Primary API to get semantic information, like types, from syntax trees.
115 pub struct Semantics<'db, DB> {
117 imp: SemanticsImpl<'db>,
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>>,
127 impl<DB> fmt::Debug for Semantics<'_, DB> {
128 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
129 write!(f, "Semantics {{ ... }}")
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_ }
139 pub fn parse(&self, file_id: FileId) -> ast::SourceFile {
140 self.imp.parse(file_id)
143 pub fn expand(&self, macro_call: &ast::MacroCall) -> Option<SyntaxNode> {
144 self.imp.expand(macro_call)
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)
152 pub fn expand_derive_macro(&self, derive: &ast::Attr) -> Option<Vec<SyntaxNode>> {
153 self.imp.expand_derive_macro(derive)
156 pub fn is_attr_macro_call(&self, item: &ast::Item) -> bool {
157 self.imp.is_attr_macro_call(item)
160 pub fn speculative_expand(
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)
169 pub fn speculative_expand_attr_macro(
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)
178 // FIXME: Rename to descend_into_macros_single
179 pub fn descend_into_macros(&self, token: SyntaxToken) -> SyntaxToken {
180 self.imp.descend_into_macros(token).pop().unwrap()
183 // FIXME: Rename to descend_into_macros
184 pub fn descend_into_macros_many(&self, token: SyntaxToken) -> SmallVec<[SyntaxToken; 1]> {
185 self.imp.descend_into_macros(token)
188 /// Maps a node down by mapping its first and last token down.
189 pub fn descend_node_into_attributes<N: AstNode>(&self, node: N) -> SmallVec<[N; 1]> {
190 self.imp.descend_node_into_attributes(node)
193 pub fn hir_file_for(&self, syntax_node: &SyntaxNode) -> HirFileId {
194 self.imp.find_file(syntax_node.clone()).file_id
197 pub fn original_range(&self, node: &SyntaxNode) -> FileRange {
198 self.imp.original_range(node)
201 pub fn original_range_opt(&self, node: &SyntaxNode) -> Option<FileRange> {
202 self.imp.original_range_opt(node)
205 pub fn diagnostics_display_range(&self, diagnostics: InFile<SyntaxNodePtr>) -> FileRange {
206 self.imp.diagnostics_display_range(diagnostics)
209 pub fn token_ancestors_with_macros(
212 ) -> impl Iterator<Item = SyntaxNode> + '_ {
213 token.parent().into_iter().flat_map(move |it| self.ancestors_with_macros(it))
216 pub fn ancestors_with_macros(&self, node: SyntaxNode) -> impl Iterator<Item = SyntaxNode> + '_ {
217 self.imp.ancestors_with_macros(node)
220 pub fn ancestors_at_offset_with_macros(
224 ) -> impl Iterator<Item = SyntaxNode> + '_ {
225 self.imp.ancestors_at_offset_with_macros(node, offset)
228 /// Find an AstNode by offset inside SyntaxNode, if it is inside *Macrofile*,
229 /// search up until it is of the target AstNode type
230 pub fn find_node_at_offset_with_macros<N: AstNode>(
235 self.imp.ancestors_at_offset_with_macros(node, offset).find_map(N::cast)
238 /// Find an AstNode by offset inside SyntaxNode, if it is inside *MacroCall*,
239 /// descend it and find again
240 pub fn find_node_at_offset_with_descend<N: AstNode>(
245 self.imp.descend_node_at_offset(node, offset).flatten().find_map(N::cast)
248 /// Find an AstNode by offset inside SyntaxNode, if it is inside *MacroCall*,
249 /// descend it and find again
250 pub fn find_nodes_at_offset_with_descend<'slf, N: AstNode + 'slf>(
254 ) -> impl Iterator<Item = N> + 'slf {
255 self.imp.descend_node_at_offset(node, offset).filter_map(|mut it| it.find_map(N::cast))
258 pub fn resolve_lifetime_param(&self, lifetime: &ast::Lifetime) -> Option<LifetimeParam> {
259 self.imp.resolve_lifetime_param(lifetime)
262 pub fn resolve_label(&self, lifetime: &ast::Lifetime) -> Option<Label> {
263 self.imp.resolve_label(lifetime)
266 pub fn resolve_type(&self, ty: &ast::Type) -> Option<Type> {
267 self.imp.resolve_type(ty)
270 pub fn type_of_expr(&self, expr: &ast::Expr) -> Option<TypeInfo> {
271 self.imp.type_of_expr(expr)
274 pub fn type_of_pat(&self, pat: &ast::Pat) -> Option<TypeInfo> {
275 self.imp.type_of_pat(pat)
278 pub fn type_of_self(&self, param: &ast::SelfParam) -> Option<Type> {
279 self.imp.type_of_self(param)
282 pub fn resolve_method_call(&self, call: &ast::MethodCallExpr) -> Option<Function> {
283 self.imp.resolve_method_call(call).map(Function::from)
286 pub fn resolve_method_call_as_callable(&self, call: &ast::MethodCallExpr) -> Option<Callable> {
287 self.imp.resolve_method_call_as_callable(call)
290 pub fn resolve_field(&self, field: &ast::FieldExpr) -> Option<Field> {
291 self.imp.resolve_field(field)
294 pub fn resolve_record_field(
296 field: &ast::RecordExprField,
297 ) -> Option<(Field, Option<Local>, Type)> {
298 self.imp.resolve_record_field(field)
301 pub fn resolve_record_pat_field(&self, field: &ast::RecordPatField) -> Option<Field> {
302 self.imp.resolve_record_pat_field(field)
305 pub fn resolve_macro_call(&self, macro_call: &ast::MacroCall) -> Option<MacroDef> {
306 self.imp.resolve_macro_call(macro_call)
309 pub fn resolve_attr_macro_call(&self, item: &ast::Item) -> Option<MacroDef> {
310 self.imp.resolve_attr_macro_call(item)
313 pub fn resolve_path(&self, path: &ast::Path) -> Option<PathResolution> {
314 self.imp.resolve_path(path)
317 pub fn resolve_extern_crate(&self, extern_crate: &ast::ExternCrate) -> Option<Crate> {
318 self.imp.resolve_extern_crate(extern_crate)
321 pub fn resolve_variant(&self, record_lit: ast::RecordExpr) -> Option<VariantDef> {
322 self.imp.resolve_variant(record_lit).map(VariantDef::from)
325 pub fn resolve_bind_pat_to_const(&self, pat: &ast::IdentPat) -> Option<ModuleDef> {
326 self.imp.resolve_bind_pat_to_const(pat)
329 // FIXME: use this instead?
330 // pub fn resolve_name_ref(&self, name_ref: &ast::NameRef) -> Option<???>;
332 pub fn record_literal_missing_fields(&self, literal: &ast::RecordExpr) -> Vec<(Field, Type)> {
333 self.imp.record_literal_missing_fields(literal)
336 pub fn record_pattern_missing_fields(&self, pattern: &ast::RecordPat) -> Vec<(Field, Type)> {
337 self.imp.record_pattern_missing_fields(pattern)
340 pub fn to_def<T: ToDef>(&self, src: &T) -> Option<T::Def> {
341 let src = self.imp.find_file(src.syntax().clone()).with_value(src).cloned();
342 T::to_def(&self.imp, src)
345 pub fn to_module_def(&self, file: FileId) -> Option<Module> {
346 self.imp.to_module_def(file).next()
349 pub fn to_module_defs(&self, file: FileId) -> impl Iterator<Item = Module> {
350 self.imp.to_module_def(file)
353 pub fn scope(&self, node: &SyntaxNode) -> SemanticsScope<'db> {
357 pub fn scope_at_offset(&self, token: &SyntaxToken, offset: TextSize) -> SemanticsScope<'db> {
358 self.imp.scope_at_offset(&token.parent().unwrap(), offset)
361 pub fn scope_for_def(&self, def: Trait) -> SemanticsScope<'db> {
362 self.imp.scope_for_def(def)
365 pub fn assert_contains_node(&self, node: &SyntaxNode) {
366 self.imp.assert_contains_node(node)
369 pub fn is_unsafe_method_call(&self, method_call_expr: &ast::MethodCallExpr) -> bool {
370 self.imp.is_unsafe_method_call(method_call_expr)
373 pub fn is_unsafe_ref_expr(&self, ref_expr: &ast::RefExpr) -> bool {
374 self.imp.is_unsafe_ref_expr(ref_expr)
377 pub fn is_unsafe_ident_pat(&self, ident_pat: &ast::IdentPat) -> bool {
378 self.imp.is_unsafe_ident_pat(ident_pat)
382 impl<'db> SemanticsImpl<'db> {
383 fn new(db: &'db dyn HirDatabase) -> Self {
386 s2d_cache: Default::default(),
387 cache: Default::default(),
388 expansion_info_cache: Default::default(),
392 fn parse(&self, file_id: FileId) -> ast::SourceFile {
393 let tree = self.db.parse(file_id).tree();
394 self.cache(tree.syntax().clone(), file_id.into());
398 fn expand(&self, macro_call: &ast::MacroCall) -> Option<SyntaxNode> {
399 let sa = self.analyze(macro_call.syntax());
400 let file_id = sa.expand(self.db, InFile::new(sa.file_id, macro_call))?;
401 let node = self.db.parse_or_expand(file_id)?;
402 self.cache(node.clone(), file_id);
406 fn expand_attr_macro(&self, item: &ast::Item) -> Option<SyntaxNode> {
407 let sa = self.analyze(item.syntax());
408 let src = InFile::new(sa.file_id, item.clone());
409 let macro_call_id = self.with_ctx(|ctx| ctx.item_to_macro_call(src))?;
410 let file_id = macro_call_id.as_file();
411 let node = self.db.parse_or_expand(file_id)?;
412 self.cache(node.clone(), file_id);
416 fn expand_derive_macro(&self, attr: &ast::Attr) -> Option<Vec<SyntaxNode>> {
417 let item = attr.syntax().parent().and_then(ast::Item::cast)?;
418 let sa = self.analyze(item.syntax());
419 let item = InFile::new(sa.file_id, &item);
420 let src = InFile::new(sa.file_id, attr.clone());
421 self.with_ctx(|ctx| {
422 let macro_call_ids = ctx.attr_to_derive_macro_call(item, src)?;
424 let expansions: Vec<_> = macro_call_ids
426 .map(|call| call.as_file())
427 .flat_map(|file_id| {
428 let node = self.db.parse_or_expand(file_id)?;
429 self.cache(node.clone(), file_id);
433 if expansions.is_empty() {
441 fn is_attr_macro_call(&self, item: &ast::Item) -> bool {
442 let sa = self.analyze(item.syntax());
443 let src = InFile::new(sa.file_id, item.clone());
444 self.with_ctx(|ctx| ctx.item_to_macro_call(src).is_some())
447 fn speculative_expand(
449 actual_macro_call: &ast::MacroCall,
450 speculative_args: &ast::TokenTree,
451 token_to_map: SyntaxToken,
452 ) -> Option<(SyntaxNode, SyntaxToken)> {
453 let sa = self.analyze(actual_macro_call.syntax());
454 let macro_call = InFile::new(sa.file_id, actual_macro_call);
455 let krate = sa.resolver.krate()?;
456 let macro_call_id = macro_call.as_call_id(self.db.upcast(), krate, |path| {
457 sa.resolver.resolve_path_as_macro(self.db.upcast(), &path)
459 hir_expand::db::expand_speculative(
462 speculative_args.syntax(),
467 fn speculative_expand_attr(
469 actual_macro_call: &ast::Item,
470 speculative_args: &ast::Item,
471 token_to_map: SyntaxToken,
472 ) -> Option<(SyntaxNode, SyntaxToken)> {
473 let sa = self.analyze(actual_macro_call.syntax());
474 let macro_call = InFile::new(sa.file_id, actual_macro_call.clone());
475 let macro_call_id = self.with_ctx(|ctx| ctx.item_to_macro_call(macro_call))?;
476 hir_expand::db::expand_speculative(
479 speculative_args.syntax(),
484 // This might not be the correct way to do this, but it works for now
485 fn descend_node_into_attributes<N: AstNode>(&self, node: N) -> SmallVec<[N; 1]> {
486 let mut res = smallvec![];
488 let first = skip_trivia_token(node.syntax().first_token()?, Direction::Next)?;
489 let last = skip_trivia_token(node.syntax().last_token()?, Direction::Prev)?;
492 let (first, last) = match tokens {
498 self.descend_into_macros_impl(first, |InFile { value, .. }| {
499 if let Some(node) = value.ancestors().find_map(N::cast) {
504 // Descend first and last token, then zip them to look for the node they belong to
505 let mut scratch: SmallVec<[_; 1]> = smallvec![];
506 self.descend_into_macros_impl(first, |token| {
510 let mut scratch = scratch.into_iter();
511 self.descend_into_macros_impl(last, |InFile { value: last, file_id: last_fid }| {
512 if let Some(InFile { value: first, file_id: first_fid }) = scratch.next() {
513 if first_fid == last_fid {
514 if let Some(p) = first.parent() {
515 let range = first.text_range().cover(last.text_range());
516 let node = find_root(&p)
517 .covering_element(range)
519 .take_while(|it| it.text_range() == range)
521 if let Some(node) = node {
532 fn descend_into_macros(&self, token: SyntaxToken) -> SmallVec<[SyntaxToken; 1]> {
533 let mut res = smallvec![];
534 self.descend_into_macros_impl(token, |InFile { value, .. }| res.push(value));
538 fn descend_into_macros_impl(&self, token: SyntaxToken, mut f: impl FnMut(InFile<SyntaxToken>)) {
539 let _p = profile::span("descend_into_macros");
540 let parent = match token.parent() {
544 let sa = self.analyze(&parent);
545 let mut queue = vec![InFile::new(sa.file_id, token)];
546 let mut cache = self.expansion_info_cache.borrow_mut();
548 let mut process_expansion_for_token =
549 |queue: &mut Vec<_>, file_id, item, token: InFile<&_>| {
550 let mapped_tokens = cache
552 .or_insert_with(|| file_id.expansion_info(self.db.upcast()))
554 .map_token_down(self.db.upcast(), item, token)?;
556 let len = queue.len();
557 // requeue the tokens we got from mapping our current token down
558 queue.extend(mapped_tokens.inspect(|token| {
559 if let Some(parent) = token.value.parent() {
560 self.cache(find_root(&parent), token.file_id);
563 // if the length changed we have found a mapping for the token
564 (queue.len() != len).then(|| ())
567 // Remap the next token in the queue into a macro call its in, if it is not being remapped
568 // either due to not being in a macro-call or because its unused push it into the result vec,
569 // otherwise push the remapped tokens back into the queue as they can potentially be remapped again.
570 while let Some(token) = queue.pop() {
571 self.db.unwind_if_cancelled();
572 let was_not_remapped = (|| {
573 // are we inside an attribute macro call
574 let containing_attribute_macro_call = self.with_ctx(|ctx| {
578 .filter_map(ast::Item::cast)
580 Some((ctx.item_to_macro_call(token.with_value(item.clone()))?, item))
584 if let Some((call_id, item)) = containing_attribute_macro_call {
585 let file_id = call_id.as_file();
586 return process_expansion_for_token(
594 // or are we inside a function-like macro call
595 if let Some(macro_call) = token.value.ancestors().find_map(ast::MacroCall::cast) {
596 let tt = macro_call.token_tree()?;
597 let l_delim = match tt.left_delimiter_token() {
598 Some(it) => it.text_range().end(),
599 None => tt.syntax().text_range().start(),
601 let r_delim = match tt.right_delimiter_token() {
602 Some(it) => it.text_range().start(),
603 None => tt.syntax().text_range().end(),
605 if !TextRange::new(l_delim, r_delim).contains_range(token.value.text_range()) {
609 let file_id = sa.expand(self.db, token.with_value(¯o_call))?;
610 return process_expansion_for_token(&mut queue, file_id, None, token.as_ref());
613 // outside of a macro invocation so this is a "final" token
618 if was_not_remapped {
624 // Note this return type is deliberate as [`find_nodes_at_offset_with_descend`] wants to stop
625 // traversing the inner iterator when it finds a node.
626 // The outer iterator is over the tokens descendants
627 // The inner iterator is the ancestors of a descendant
628 fn descend_node_at_offset(
632 ) -> impl Iterator<Item = impl Iterator<Item = SyntaxNode> + '_> + '_ {
633 node.token_at_offset(offset)
634 .map(move |token| self.descend_into_macros(token))
636 descendants.into_iter().map(move |it| self.token_ancestors_with_macros(it))
638 // re-order the tokens from token_at_offset by returning the ancestors with the smaller first nodes first
639 // See algo::ancestors_at_offset, which uses the same approach
640 .kmerge_by(|left, right| {
642 .map(|node| node.text_range().len())
643 .lt(right.clone().map(|node| node.text_range().len()))
647 fn original_range(&self, node: &SyntaxNode) -> FileRange {
648 let node = self.find_file(node.clone());
649 node.as_ref().original_file_range(self.db.upcast())
652 fn original_range_opt(&self, node: &SyntaxNode) -> Option<FileRange> {
653 let node = self.find_file(node.clone());
654 node.as_ref().original_file_range_opt(self.db.upcast())
657 fn diagnostics_display_range(&self, src: InFile<SyntaxNodePtr>) -> FileRange {
658 let root = self.db.parse_or_expand(src.file_id).unwrap();
659 let node = src.value.to_node(&root);
660 self.cache(root, src.file_id);
661 src.with_value(&node).original_file_range(self.db.upcast())
664 fn token_ancestors_with_macros(
667 ) -> impl Iterator<Item = SyntaxNode> + Clone + '_ {
668 token.parent().into_iter().flat_map(move |parent| self.ancestors_with_macros(parent))
671 fn ancestors_with_macros(
674 ) -> impl Iterator<Item = SyntaxNode> + Clone + '_ {
675 let node = self.find_file(node);
676 node.ancestors_with_macros(self.db.upcast()).map(|it| it.value)
679 fn ancestors_at_offset_with_macros(
683 ) -> impl Iterator<Item = SyntaxNode> + '_ {
684 node.token_at_offset(offset)
685 .map(|token| self.token_ancestors_with_macros(token))
686 .kmerge_by(|node1, node2| node1.text_range().len() < node2.text_range().len())
689 fn resolve_lifetime_param(&self, lifetime: &ast::Lifetime) -> Option<LifetimeParam> {
690 let text = lifetime.text();
691 let lifetime_param = lifetime.syntax().ancestors().find_map(|syn| {
692 let gpl = ast::AnyHasGenericParams::cast(syn)?.generic_param_list()?;
693 gpl.lifetime_params()
694 .find(|tp| tp.lifetime().as_ref().map(|lt| lt.text()).as_ref() == Some(&text))
696 let src = self.find_file(lifetime_param.syntax().clone()).with_value(lifetime_param);
697 ToDef::to_def(self, src)
700 fn resolve_label(&self, lifetime: &ast::Lifetime) -> Option<Label> {
701 let text = lifetime.text();
702 let label = lifetime.syntax().ancestors().find_map(|syn| {
703 let label = match_ast! {
705 ast::ForExpr(it) => it.label(),
706 ast::WhileExpr(it) => it.label(),
707 ast::LoopExpr(it) => it.label(),
708 ast::BlockExpr(it) => it.label(),
714 .and_then(|lt| lt.lifetime_ident_token())
715 .map_or(false, |lt| lt.text() == text)
718 let src = self.find_file(label.syntax().clone()).with_value(label);
719 ToDef::to_def(self, src)
722 fn resolve_type(&self, ty: &ast::Type) -> Option<Type> {
723 let scope = self.scope(ty.syntax());
724 let ctx = body::LowerCtx::new(self.db.upcast(), scope.file_id);
725 let ty = hir_ty::TyLoweringContext::new(self.db, &scope.resolver)
726 .lower_ty(&crate::TypeRef::from_ast(&ctx, ty.clone()));
727 Type::new_with_resolver(self.db, &scope.resolver, ty)
730 fn type_of_expr(&self, expr: &ast::Expr) -> Option<TypeInfo> {
731 self.analyze(expr.syntax())
732 .type_of_expr(self.db, expr)
733 .map(|(ty, coerced)| TypeInfo { original: ty, adjusted: coerced })
736 fn type_of_pat(&self, pat: &ast::Pat) -> Option<TypeInfo> {
737 self.analyze(pat.syntax())
738 .type_of_pat(self.db, pat)
739 .map(|(ty, coerced)| TypeInfo { original: ty, adjusted: coerced })
742 fn type_of_self(&self, param: &ast::SelfParam) -> Option<Type> {
743 self.analyze(param.syntax()).type_of_self(self.db, param)
746 fn resolve_method_call(&self, call: &ast::MethodCallExpr) -> Option<FunctionId> {
747 self.analyze(call.syntax()).resolve_method_call(self.db, call).map(|(id, _)| id)
750 fn resolve_method_call_as_callable(&self, call: &ast::MethodCallExpr) -> Option<Callable> {
751 let (func, subst) = self.analyze(call.syntax()).resolve_method_call(self.db, call)?;
752 let ty = self.db.value_ty(func.into()).substitute(&Interner, &subst);
753 let resolver = self.analyze(call.syntax()).resolver;
754 let ty = Type::new_with_resolver(self.db, &resolver, ty)?;
755 let mut res = ty.as_callable(self.db)?;
756 res.is_bound_method = true;
760 fn resolve_field(&self, field: &ast::FieldExpr) -> Option<Field> {
761 self.analyze(field.syntax()).resolve_field(self.db, field)
764 fn resolve_record_field(
766 field: &ast::RecordExprField,
767 ) -> Option<(Field, Option<Local>, Type)> {
768 self.analyze(field.syntax()).resolve_record_field(self.db, field)
771 fn resolve_record_pat_field(&self, field: &ast::RecordPatField) -> Option<Field> {
772 self.analyze(field.syntax()).resolve_record_pat_field(self.db, field)
775 fn resolve_macro_call(&self, macro_call: &ast::MacroCall) -> Option<MacroDef> {
776 let sa = self.analyze(macro_call.syntax());
777 let macro_call = self.find_file(macro_call.syntax().clone()).with_value(macro_call);
778 sa.resolve_macro_call(self.db, macro_call)
781 fn resolve_attr_macro_call(&self, item: &ast::Item) -> Option<MacroDef> {
782 let item_in_file = self.find_file(item.syntax().clone()).with_value(item.clone());
783 let macro_call_id = self.with_ctx(|ctx| ctx.item_to_macro_call(item_in_file))?;
784 Some(MacroDef { id: self.db.lookup_intern_macro(macro_call_id).def })
787 fn resolve_path(&self, path: &ast::Path) -> Option<PathResolution> {
788 self.analyze(path.syntax()).resolve_path(self.db, path)
791 fn resolve_extern_crate(&self, extern_crate: &ast::ExternCrate) -> Option<Crate> {
792 let krate = self.scope(extern_crate.syntax()).krate()?;
793 krate.dependencies(self.db).into_iter().find_map(|dep| {
794 if dep.name == extern_crate.name_ref()?.as_name() {
802 fn resolve_variant(&self, record_lit: ast::RecordExpr) -> Option<VariantId> {
803 self.analyze(record_lit.syntax()).resolve_variant(self.db, record_lit)
806 fn resolve_bind_pat_to_const(&self, pat: &ast::IdentPat) -> Option<ModuleDef> {
807 self.analyze(pat.syntax()).resolve_bind_pat_to_const(self.db, pat)
810 fn record_literal_missing_fields(&self, literal: &ast::RecordExpr) -> Vec<(Field, Type)> {
811 self.analyze(literal.syntax())
812 .record_literal_missing_fields(self.db, literal)
816 fn record_pattern_missing_fields(&self, pattern: &ast::RecordPat) -> Vec<(Field, Type)> {
817 self.analyze(pattern.syntax())
818 .record_pattern_missing_fields(self.db, pattern)
822 fn with_ctx<F: FnOnce(&mut SourceToDefCtx) -> T, T>(&self, f: F) -> T {
823 let mut cache = self.s2d_cache.borrow_mut();
824 let mut ctx = SourceToDefCtx { db: self.db, cache: &mut *cache };
828 fn to_module_def(&self, file: FileId) -> impl Iterator<Item = Module> {
829 self.with_ctx(|ctx| ctx.file_to_def(file)).into_iter().map(Module::from)
832 fn scope(&self, node: &SyntaxNode) -> SemanticsScope<'db> {
833 let sa = self.analyze(node);
834 SemanticsScope { db: self.db, file_id: sa.file_id, resolver: sa.resolver }
837 fn scope_at_offset(&self, node: &SyntaxNode, offset: TextSize) -> SemanticsScope<'db> {
838 let sa = self.analyze_with_offset(node, offset);
839 SemanticsScope { db: self.db, file_id: sa.file_id, resolver: sa.resolver }
842 fn scope_for_def(&self, def: Trait) -> SemanticsScope<'db> {
843 let file_id = self.db.lookup_intern_trait(def.id).id.file_id();
844 let resolver = def.id.resolver(self.db.upcast());
845 SemanticsScope { db: self.db, file_id, resolver }
848 fn analyze(&self, node: &SyntaxNode) -> SourceAnalyzer {
849 self.analyze_impl(node, None)
851 fn analyze_with_offset(&self, node: &SyntaxNode, offset: TextSize) -> SourceAnalyzer {
852 self.analyze_impl(node, Some(offset))
854 fn analyze_impl(&self, node: &SyntaxNode, offset: Option<TextSize>) -> SourceAnalyzer {
855 let _p = profile::span("Semantics::analyze_impl");
856 let node = self.find_file(node.clone());
857 let node = node.as_ref();
859 let container = match self.with_ctx(|ctx| ctx.find_container(node)) {
861 None => return SourceAnalyzer::new_for_resolver(Resolver::default(), node),
864 let resolver = match container {
865 ChildContainer::DefWithBodyId(def) => {
866 return SourceAnalyzer::new_for_body(self.db, def, node, offset)
868 ChildContainer::TraitId(it) => it.resolver(self.db.upcast()),
869 ChildContainer::ImplId(it) => it.resolver(self.db.upcast()),
870 ChildContainer::ModuleId(it) => it.resolver(self.db.upcast()),
871 ChildContainer::EnumId(it) => it.resolver(self.db.upcast()),
872 ChildContainer::VariantId(it) => it.resolver(self.db.upcast()),
873 ChildContainer::TypeAliasId(it) => it.resolver(self.db.upcast()),
874 ChildContainer::GenericDefId(it) => it.resolver(self.db.upcast()),
876 SourceAnalyzer::new_for_resolver(resolver, node)
879 fn cache(&self, root_node: SyntaxNode, file_id: HirFileId) {
880 assert!(root_node.parent().is_none());
881 let mut cache = self.cache.borrow_mut();
882 let prev = cache.insert(root_node, file_id);
883 assert!(prev == None || prev == Some(file_id))
886 fn assert_contains_node(&self, node: &SyntaxNode) {
887 self.find_file(node.clone());
890 fn lookup(&self, root_node: &SyntaxNode) -> Option<HirFileId> {
891 let cache = self.cache.borrow();
892 cache.get(root_node).copied()
895 fn find_file(&self, node: SyntaxNode) -> InFile<SyntaxNode> {
896 let root_node = find_root(&node);
897 let file_id = self.lookup(&root_node).unwrap_or_else(|| {
899 "\n\nFailed to lookup {:?} in this Semantics.\n\
900 Make sure to use only query nodes, derived from this instance of Semantics.\n\
902 known nodes: {}\n\n",
908 .map(|it| format!("{:?}", it))
913 InFile::new(file_id, node)
916 fn is_unsafe_method_call(&self, method_call_expr: &ast::MethodCallExpr) -> bool {
920 let field_expr = match expr {
921 ast::Expr::FieldExpr(field_expr) => field_expr,
924 let ty = self.type_of_expr(&field_expr.expr()?)?.original;
925 if !ty.is_packed(self.db) {
929 let func = self.resolve_method_call(method_call_expr).map(Function::from)?;
930 let res = match func.self_param(self.db)?.access(self.db) {
931 Access::Shared | Access::Exclusive => true,
932 Access::Owned => false,
939 fn is_unsafe_ref_expr(&self, ref_expr: &ast::RefExpr) -> bool {
943 let field_expr = match expr {
944 ast::Expr::FieldExpr(field_expr) => field_expr,
947 let expr = field_expr.expr()?;
948 self.type_of_expr(&expr)
950 // Binding a reference to a packed type is possibly unsafe.
951 .map(|ty| ty.original.is_packed(self.db))
954 // FIXME This needs layout computation to be correct. It will highlight
955 // more than it should with the current implementation.
958 fn is_unsafe_ident_pat(&self, ident_pat: &ast::IdentPat) -> bool {
959 if ident_pat.ref_token().is_none() {
967 // `IdentPat` can live under `RecordPat` directly under `RecordPatField` or
968 // `RecordPatFieldList`. `RecordPatField` also lives under `RecordPatFieldList`,
969 // so this tries to lookup the `IdentPat` anywhere along that structure to the
970 // `RecordPat` so we can get the containing type.
971 let record_pat = ast::RecordPatField::cast(parent.clone())
972 .and_then(|record_pat| record_pat.syntax().parent())
973 .or_else(|| Some(parent.clone()))
975 ast::RecordPatFieldList::cast(parent)?
978 .and_then(ast::RecordPat::cast)
981 // If this doesn't match a `RecordPat`, fallback to a `LetStmt` to see if
982 // this is initialized from a `FieldExpr`.
983 if let Some(record_pat) = record_pat {
984 self.type_of_pat(&ast::Pat::RecordPat(record_pat))
985 } else if let Some(let_stmt) = ast::LetStmt::cast(parent) {
986 let field_expr = match let_stmt.initializer()? {
987 ast::Expr::FieldExpr(field_expr) => field_expr,
991 self.type_of_expr(&field_expr.expr()?)
996 // Binding a reference to a packed type is possibly unsafe.
997 .map(|ty| ty.original.is_packed(self.db))
1002 pub trait ToDef: AstNode + Clone {
1005 fn to_def(sema: &SemanticsImpl, src: InFile<Self>) -> Option<Self::Def>;
1008 macro_rules! to_def_impls {
1009 ($(($def:path, $ast:path, $meth:ident)),* ,) => {$(
1010 impl ToDef for $ast {
1012 fn to_def(sema: &SemanticsImpl, src: InFile<Self>) -> Option<Self::Def> {
1013 sema.with_ctx(|ctx| ctx.$meth(src)).map(<$def>::from)
1020 (crate::Module, ast::Module, module_to_def),
1021 (crate::Module, ast::SourceFile, source_file_to_def),
1022 (crate::Struct, ast::Struct, struct_to_def),
1023 (crate::Enum, ast::Enum, enum_to_def),
1024 (crate::Union, ast::Union, union_to_def),
1025 (crate::Trait, ast::Trait, trait_to_def),
1026 (crate::Impl, ast::Impl, impl_to_def),
1027 (crate::TypeAlias, ast::TypeAlias, type_alias_to_def),
1028 (crate::Const, ast::Const, const_to_def),
1029 (crate::Static, ast::Static, static_to_def),
1030 (crate::Function, ast::Fn, fn_to_def),
1031 (crate::Field, ast::RecordField, record_field_to_def),
1032 (crate::Field, ast::TupleField, tuple_field_to_def),
1033 (crate::Variant, ast::Variant, enum_variant_to_def),
1034 (crate::TypeParam, ast::TypeParam, type_param_to_def),
1035 (crate::LifetimeParam, ast::LifetimeParam, lifetime_param_to_def),
1036 (crate::ConstParam, ast::ConstParam, const_param_to_def),
1037 (crate::MacroDef, ast::Macro, macro_to_def),
1038 (crate::Local, ast::IdentPat, bind_pat_to_def),
1039 (crate::Local, ast::SelfParam, self_param_to_def),
1040 (crate::Label, ast::Label, label_to_def),
1041 (crate::Adt, ast::Adt, adt_to_def),
1044 fn find_root(node: &SyntaxNode) -> SyntaxNode {
1045 node.ancestors().last().unwrap()
1048 /// `SemanticScope` encapsulates the notion of a scope (the set of visible
1049 /// names) at a particular program point.
1051 /// It is a bit tricky, as scopes do not really exist inside the compiler.
1052 /// Rather, the compiler directly computes for each reference the definition it
1053 /// refers to. It might transiently compute the explicit scope map while doing
1054 /// so, but, generally, this is not something left after the analysis.
1056 /// However, we do very much need explicit scopes for IDE purposes --
1057 /// completion, at its core, lists the contents of the current scope. The notion
1058 /// of scope is also useful to answer questions like "what would be the meaning
1059 /// of this piece of code if we inserted it into this position?".
1061 /// So `SemanticsScope` is constructed from a specific program point (a syntax
1062 /// node or just a raw offset) and provides access to the set of visible names
1063 /// on a somewhat best-effort basis.
1065 /// Note that if you are wondering "what does this specific existing name mean?",
1066 /// you'd better use the `resolve_` family of methods.
1068 pub struct SemanticsScope<'a> {
1069 pub db: &'a dyn HirDatabase,
1074 impl<'a> SemanticsScope<'a> {
1075 pub fn module(&self) -> Option<Module> {
1076 Some(Module { id: self.resolver.module()? })
1079 pub fn krate(&self) -> Option<Crate> {
1080 Some(Crate { id: self.resolver.krate()? })
1083 /// Note: `FxHashSet<TraitId>` should be treated as an opaque type, passed into `Type
1084 // FIXME: rename to visible_traits to not repeat scope?
1085 pub fn traits_in_scope(&self) -> FxHashSet<TraitId> {
1086 let resolver = &self.resolver;
1087 resolver.traits_in_scope(self.db.upcast())
1090 pub fn process_all_names(&self, f: &mut dyn FnMut(Name, ScopeDef)) {
1091 let scope = self.resolver.names_in_scope(self.db.upcast());
1092 for (name, entries) in scope {
1093 for entry in entries {
1094 let def = match entry {
1095 resolver::ScopeDef::ModuleDef(it) => ScopeDef::ModuleDef(it.into()),
1096 resolver::ScopeDef::MacroDef(it) => ScopeDef::MacroDef(it.into()),
1097 resolver::ScopeDef::Unknown => ScopeDef::Unknown,
1098 resolver::ScopeDef::ImplSelfType(it) => ScopeDef::ImplSelfType(it.into()),
1099 resolver::ScopeDef::AdtSelfType(it) => ScopeDef::AdtSelfType(it.into()),
1100 resolver::ScopeDef::GenericParam(id) => ScopeDef::GenericParam(id.into()),
1101 resolver::ScopeDef::Local(pat_id) => {
1102 let parent = self.resolver.body_owner().unwrap();
1103 ScopeDef::Local(Local { parent, pat_id })
1105 resolver::ScopeDef::Label(label_id) => {
1106 let parent = self.resolver.body_owner().unwrap();
1107 ScopeDef::Label(Label { parent, label_id })
1110 f(name.clone(), def)
1115 /// Resolve a path as-if it was written at the given scope. This is
1116 /// necessary a heuristic, as it doesn't take hygiene into account.
1117 pub fn speculative_resolve(&self, path: &ast::Path) -> Option<PathResolution> {
1118 let ctx = body::LowerCtx::new(self.db.upcast(), self.file_id);
1119 let path = Path::from_src(path.clone(), &ctx)?;
1120 resolve_hir_path(self.db, &self.resolver, &path)