crates/hir/src/semantics/source_to_def.rs

   1 //! Maps *syntax* of various definitions to their semantic ids.
   2 //!
   3 //! This is a very interesting module, and, in some sense, can be considered the
   4 //! heart of the IDE parts of rust-analyzer.
   5 //!
   6 //! This module solves the following problem:
   7 //!
   8 //!     Given a piece of syntax, find the corresponding semantic definition (def).
   9 //!
  10 //! This problem is a part of more-or-less every IDE feature implemented. Every
  11 //! IDE functionality (like goto to definition), conceptually starts with a
  12 //! specific cursor position in a file. Starting with this text offset, we first
  13 //! figure out what syntactic construct are we at: is this a pattern, an
  14 //! expression, an item definition.
  15 //!
  16 //! Knowing only the syntax gives us relatively little info. For example,
  17 //! looking at the syntax of the function we can realise that it is a part of an
  18 //! `impl` block, but we won't be able to tell what trait function the current
  19 //! function overrides, and whether it does that correctly. For that, we need to
  20 //! go from [`ast::Fn`] to [`crate::Function`], and that's exactly what this
  21 //! module does.
  22 //!
  23 //! As syntax trees are values and don't know their place of origin/identity,
  24 //! this module also requires [`InFile`] wrappers to understand which specific
  25 //! real or macro-expanded file the tree comes from.
  26 //!
  27 //! The actual algorithm to resolve syntax to def is curious in two aspects:
  28 //!
  29 //!     * It is recursive
  30 //!     * It uses the inverse algorithm (what is the syntax for this def?)
  31 //!
  32 //! Specifically, the algorithm goes like this:
  33 //!
  34 //!     1. Find the syntactic container for the syntax. For example, field's
  35 //!        container is the struct, and structs container is a module.
  36 //!     2. Recursively get the def corresponding to container.
  37 //!     3. Ask the container def for all child defs. These child defs contain
  38 //!        the answer and answer's siblings.
  39 //!     4. For each child def, ask for it's source.
  40 //!     5. The child def whose source is the syntax node we've started with
  41 //!        is the answer.
  42 //!
  43 //! It's interesting that both Roslyn and Kotlin contain very similar code
  44 //! shape.
  45 //!
  46 //! Let's take a look at Roslyn:
  47 //!
  48 //!   <https://github.com/dotnet/roslyn/blob/36a0c338d6621cc5fe34b79d414074a95a6a489c/src/Compilers/CSharp/Portable/Compilation/SyntaxTreeSemanticModel.cs#L1403-L1429>
  49 //!   <https://sourceroslyn.io/#Microsoft.CodeAnalysis.CSharp/Compilation/SyntaxTreeSemanticModel.cs,1403>
  50 //!
  51 //! The `GetDeclaredType` takes `Syntax` as input, and returns `Symbol` as
  52 //! output. First, it retrieves a `Symbol` for parent `Syntax`:
  53 //!
  54 //! * <https://sourceroslyn.io/#Microsoft.CodeAnalysis.CSharp/Compilation/SyntaxTreeSemanticModel.cs,1423>
  55 //!
  56 //! Then, it iterates parent symbol's children, looking for one which has the
  57 //! same text span as the original node:
  58 //!
  59 //!   <https://sourceroslyn.io/#Microsoft.CodeAnalysis.CSharp/Compilation/SyntaxTreeSemanticModel.cs,1786>
  60 //!
  61 //! Now, let's look at Kotlin:
  62 //!
  63 //!   <https://github.com/JetBrains/kotlin/blob/a288b8b00e4754a1872b164999c6d3f3b8c8994a/idea/idea-frontend-fir/idea-fir-low-level-api/src/org/jetbrains/kotlin/idea/fir/low/level/api/FirModuleResolveStateImpl.kt#L93-L125>
  64 //!
  65 //! This function starts with a syntax node (`KtExpression` is syntax, like all
  66 //! `Kt` nodes), and returns a def. It uses
  67 //! `getNonLocalContainingOrThisDeclaration` to get syntactic container for a
  68 //! current node. Then, `findSourceNonLocalFirDeclaration` gets `Fir` for this
  69 //! parent. Finally, `findElementIn` function traverses `Fir` children to find
  70 //! one with the same source we originally started with.
  71 //!
  72 //! One question is left though -- where does the recursion stops? This happens
  73 //! when we get to the file syntax node, which doesn't have a syntactic parent.
  74 //! In that case, we loop through all the crates that might contain this file
  75 //! and look for a module whose source is the given file.
  76 //!
  77 //! Note that the logic in this module is somewhat fundamentally imprecise --
  78 //! due to conditional compilation and `#[path]` attributes, there's no
  79 //! injective mapping from syntax nodes to defs. This is not an edge case --
  80 //! more or less every item in a `lib.rs` is a part of two distinct crates: a
  81 //! library with `--cfg test` and a library without.
  82 //!
  83 //! At the moment, we don't really handle this well and return the first answer
  84 //! that works. Ideally, we should first let the caller to pick a specific
  85 //! active crate for a given position, and then provide an API to resolve all
  86 //! syntax nodes against this specific crate.
  87
  88 use base_db::FileId;
  89 use hir_def::{
  90     child_by_source::ChildBySource,
  91     dyn_map::DynMap,
  92     expr::{LabelId, PatId},
  93     keys::{self, Key},
  94     AdtId, ConstId, ConstParamId, DefWithBodyId, EnumId, EnumVariantId, FieldId, FunctionId,
  95     GenericDefId, ImplId, LifetimeParamId, ModuleId, StaticId, StructId, TraitId, TypeAliasId,
  96     TypeParamId, UnionId, VariantId,
  97 };
  98 use hir_expand::{name::AsName, AstId, HirFileId, MacroCallId, MacroDefId, MacroDefKind};
  99 use rustc_hash::FxHashMap;
 100 use smallvec::SmallVec;
 101 use stdx::impl_from;
 102 use syntax::{
 103     ast::{self, NameOwner},
 104     match_ast, AstNode, SyntaxNode,
 105 };
 106
 107 use crate::{db::HirDatabase, InFile};
 108
 109 pub(super) type SourceToDefCache = FxHashMap<(ChildContainer, HirFileId), DynMap>;
 110
 111 pub(super) struct SourceToDefCtx<'a, 'b> {
 112     pub(super) db: &'b dyn HirDatabase,
 113     pub(super) cache: &'a mut SourceToDefCache,
 114 }
 115
 116 impl SourceToDefCtx<'_, '_> {
 117     pub(super) fn file_to_def(&mut self, file: FileId) -> SmallVec<[ModuleId; 1]> {
 118         let _p = profile::span("SourceBinder::to_module_def");
 119         let mut mods = SmallVec::new();
 120         for &crate_id in self.db.relevant_crates(file).iter() {
 121             // FIXME: inner items
 122             let crate_def_map = self.db.crate_def_map(crate_id);
 123             mods.extend(
 124                 crate_def_map
 125                     .modules_for_file(file)
 126                     .map(|local_id| crate_def_map.module_id(local_id)),
 127             )
 128         }
 129         mods
 130     }
 131
 132     pub(super) fn module_to_def(&mut self, src: InFile<ast::Module>) -> Option<ModuleId> {
 133         let _p = profile::span("module_to_def");
 134         let parent_declaration =
 135             src.syntax().cloned().ancestors_with_macros(self.db.upcast()).skip(1).find_map(|it| {
 136                 let m = ast::Module::cast(it.value.clone())?;
 137                 Some(it.with_value(m))
 138             });
 139
 140         let parent_module = match parent_declaration {
 141             Some(parent_declaration) => self.module_to_def(parent_declaration),
 142             None => {
 143                 let file_id = src.file_id.original_file(self.db.upcast());
 144                 self.file_to_def(file_id).get(0).copied()
 145             }
 146         }?;
 147
 148         let child_name = src.value.name()?.as_name();
 149         let def_map = parent_module.def_map(self.db.upcast());
 150         let child_id = *def_map[parent_module.local_id].children.get(&child_name)?;
 151         Some(def_map.module_id(child_id))
 152     }
 153
 154     pub(super) fn source_file_to_def(&mut self, src: InFile<ast::SourceFile>) -> Option<ModuleId> {
 155         let _p = profile::span("source_file_to_def");
 156         let file_id = src.file_id.original_file(self.db.upcast());
 157         self.file_to_def(file_id).get(0).copied()
 158     }
 159
 160     pub(super) fn trait_to_def(&mut self, src: InFile<ast::Trait>) -> Option<TraitId> {
 161         self.to_def(src, keys::TRAIT)
 162     }
 163     pub(super) fn impl_to_def(&mut self, src: InFile<ast::Impl>) -> Option<ImplId> {
 164         self.to_def(src, keys::IMPL)
 165     }
 166     pub(super) fn fn_to_def(&mut self, src: InFile<ast::Fn>) -> Option<FunctionId> {
 167         self.to_def(src, keys::FUNCTION)
 168     }
 169     pub(super) fn struct_to_def(&mut self, src: InFile<ast::Struct>) -> Option<StructId> {
 170         self.to_def(src, keys::STRUCT)
 171     }
 172     pub(super) fn enum_to_def(&mut self, src: InFile<ast::Enum>) -> Option<EnumId> {
 173         self.to_def(src, keys::ENUM)
 174     }
 175     pub(super) fn union_to_def(&mut self, src: InFile<ast::Union>) -> Option<UnionId> {
 176         self.to_def(src, keys::UNION)
 177     }
 178     pub(super) fn static_to_def(&mut self, src: InFile<ast::Static>) -> Option<StaticId> {
 179         self.to_def(src, keys::STATIC)
 180     }
 181     pub(super) fn const_to_def(&mut self, src: InFile<ast::Const>) -> Option<ConstId> {
 182         self.to_def(src, keys::CONST)
 183     }
 184     pub(super) fn type_alias_to_def(&mut self, src: InFile<ast::TypeAlias>) -> Option<TypeAliasId> {
 185         self.to_def(src, keys::TYPE_ALIAS)
 186     }
 187     pub(super) fn record_field_to_def(&mut self, src: InFile<ast::RecordField>) -> Option<FieldId> {
 188         self.to_def(src, keys::RECORD_FIELD)
 189     }
 190     pub(super) fn tuple_field_to_def(&mut self, src: InFile<ast::TupleField>) -> Option<FieldId> {
 191         self.to_def(src, keys::TUPLE_FIELD)
 192     }
 193     pub(super) fn enum_variant_to_def(
 194         &mut self,
 195         src: InFile<ast::Variant>,
 196     ) -> Option<EnumVariantId> {
 197         self.to_def(src, keys::VARIANT)
 198     }
 199     pub(super) fn adt_to_def(
 200         &mut self,
 201         InFile { file_id, value }: InFile<ast::Adt>,
 202     ) -> Option<AdtId> {
 203         match value {
 204             ast::Adt::Enum(it) => self.enum_to_def(InFile::new(file_id, it)).map(AdtId::EnumId),
 205             ast::Adt::Struct(it) => {
 206                 self.struct_to_def(InFile::new(file_id, it)).map(AdtId::StructId)
 207             }
 208             ast::Adt::Union(it) => self.union_to_def(InFile::new(file_id, it)).map(AdtId::UnionId),
 209         }
 210     }
 211     pub(super) fn bind_pat_to_def(
 212         &mut self,
 213         src: InFile<ast::IdentPat>,
 214     ) -> Option<(DefWithBodyId, PatId)> {
 215         let container = self.find_pat_or_label_container(src.syntax())?;
 216         let (_body, source_map) = self.db.body_with_source_map(container);
 217         let src = src.map(ast::Pat::from);
 218         let pat_id = source_map.node_pat(src.as_ref())?;
 219         Some((container, pat_id))
 220     }
 221     pub(super) fn self_param_to_def(
 222         &mut self,
 223         src: InFile<ast::SelfParam>,
 224     ) -> Option<(DefWithBodyId, PatId)> {
 225         let container = self.find_pat_or_label_container(src.syntax())?;
 226         let (_body, source_map) = self.db.body_with_source_map(container);
 227         let pat_id = source_map.node_self_param(src.as_ref())?;
 228         Some((container, pat_id))
 229     }
 230     pub(super) fn label_to_def(
 231         &mut self,
 232         src: InFile<ast::Label>,
 233     ) -> Option<(DefWithBodyId, LabelId)> {
 234         let container = self.find_pat_or_label_container(src.syntax())?;
 235         let (_body, source_map) = self.db.body_with_source_map(container);
 236         let label_id = source_map.node_label(src.as_ref())?;
 237         Some((container, label_id))
 238     }
 239
 240     pub(super) fn item_to_macro_call(&mut self, src: InFile<ast::Item>) -> Option<MacroCallId> {
 241         let map = self.dyn_map(src.as_ref())?;
 242         map[keys::ATTR_MACRO].get(&src).copied()
 243     }
 244
 245     pub(super) fn attr_to_derive_macro_call(
 246         &mut self,
 247         item: InFile<&ast::Item>,
 248         src: InFile<ast::Attr>,
 249     ) -> Option<MacroCallId> {
 250         let map = self.dyn_map(item)?;
 251         map[keys::DERIVE_MACRO].get(&src).copied()
 252     }
 253
 254     fn to_def<Ast: AstNode + 'static, ID: Copy + 'static>(
 255         &mut self,
 256         src: InFile<Ast>,
 257         key: Key<Ast, ID>,
 258     ) -> Option<ID> {
 259         self.dyn_map(src.as_ref())?[key].get(&src).copied()
 260     }
 261
 262     fn dyn_map<Ast: AstNode + 'static>(&mut self, src: InFile<&Ast>) -> Option<&DynMap> {
 263         let container = self.find_container(src.map(|it| it.syntax()))?;
 264         Some(self.cache_for(container, src.file_id))
 265     }
 266
 267     fn cache_for(&mut self, container: ChildContainer, file_id: HirFileId) -> &DynMap {
 268         let db = self.db;
 269         self.cache
 270             .entry((container, file_id))
 271             .or_insert_with(|| container.child_by_source(db, file_id))
 272     }
 273
 274     pub(super) fn type_param_to_def(&mut self, src: InFile<ast::TypeParam>) -> Option<TypeParamId> {
 275         let container: ChildContainer = self.find_generic_param_container(src.syntax())?.into();
 276         let dyn_map = self.cache_for(container, src.file_id);
 277         dyn_map[keys::TYPE_PARAM].get(&src).copied()
 278     }
 279
 280     pub(super) fn lifetime_param_to_def(
 281         &mut self,
 282         src: InFile<ast::LifetimeParam>,
 283     ) -> Option<LifetimeParamId> {
 284         let container: ChildContainer = self.find_generic_param_container(src.syntax())?.into();
 285         let dyn_map = self.cache_for(container, src.file_id);
 286         dyn_map[keys::LIFETIME_PARAM].get(&src).copied()
 287     }
 288
 289     pub(super) fn const_param_to_def(
 290         &mut self,
 291         src: InFile<ast::ConstParam>,
 292     ) -> Option<ConstParamId> {
 293         let container: ChildContainer = self.find_generic_param_container(src.syntax())?.into();
 294         let dyn_map = self.cache_for(container, src.file_id);
 295         dyn_map[keys::CONST_PARAM].get(&src).copied()
 296     }
 297
 298     // FIXME: use DynMap as well?
 299     pub(super) fn macro_to_def(&mut self, src: InFile<ast::Macro>) -> Option<MacroDefId> {
 300         let file_ast_id = self.db.ast_id_map(src.file_id).ast_id(&src.value);
 301         let ast_id = AstId::new(src.file_id, file_ast_id.upcast());
 302         let kind = MacroDefKind::Declarative(ast_id);
 303         let file_id = src.file_id.original_file(self.db.upcast());
 304         let krate = self.file_to_def(file_id).get(0).copied()?.krate();
 305         Some(MacroDefId { krate, kind, local_inner: false })
 306     }
 307
 308     pub(super) fn find_container(&mut self, src: InFile<&SyntaxNode>) -> Option<ChildContainer> {
 309         for container in src.cloned().ancestors_with_macros(self.db.upcast()).skip(1) {
 310             if let Some(res) = self.container_to_def(container) {
 311                 return Some(res);
 312             }
 313         }
 314
 315         let def = self.file_to_def(src.file_id.original_file(self.db.upcast())).get(0).copied()?;
 316         Some(def.into())
 317     }
 318
 319     fn container_to_def(&mut self, container: InFile<SyntaxNode>) -> Option<ChildContainer> {
 320         let cont = match_ast! {
 321             match (container.value) {
 322                 ast::Module(it) => {
 323                     let def = self.module_to_def(container.with_value(it))?;
 324                     def.into()
 325                 },
 326                 ast::Trait(it) => {
 327                     let def = self.trait_to_def(container.with_value(it))?;
 328                     def.into()
 329                 },
 330                 ast::Impl(it) => {
 331                     let def = self.impl_to_def(container.with_value(it))?;
 332                     def.into()
 333                 },
 334                 ast::Fn(it) => {
 335                     let def = self.fn_to_def(container.with_value(it))?;
 336                     DefWithBodyId::from(def).into()
 337                 },
 338                 ast::Struct(it) => {
 339                     let def = self.struct_to_def(container.with_value(it))?;
 340                     VariantId::from(def).into()
 341                 },
 342                 ast::Enum(it) => {
 343                     let def = self.enum_to_def(container.with_value(it))?;
 344                     def.into()
 345                 },
 346                 ast::Union(it) => {
 347                     let def = self.union_to_def(container.with_value(it))?;
 348                     VariantId::from(def).into()
 349                 },
 350                 ast::Static(it) => {
 351                     let def = self.static_to_def(container.with_value(it))?;
 352                     DefWithBodyId::from(def).into()
 353                 },
 354                 ast::Const(it) => {
 355                     let def = self.const_to_def(container.with_value(it))?;
 356                     DefWithBodyId::from(def).into()
 357                 },
 358                 ast::TypeAlias(it) => {
 359                     let def = self.type_alias_to_def(container.with_value(it))?;
 360                     def.into()
 361                 },
 362                 ast::Variant(it) => {
 363                     let def = self.enum_variant_to_def(container.with_value(it))?;
 364                     VariantId::from(def).into()
 365                 },
 366                 _ => return None,
 367             }
 368         };
 369         Some(cont)
 370     }
 371
 372     fn find_generic_param_container(&mut self, src: InFile<&SyntaxNode>) -> Option<GenericDefId> {
 373         for container in src.cloned().ancestors_with_macros(self.db.upcast()).skip(1) {
 374             let res: GenericDefId = match_ast! {
 375                 match (container.value) {
 376                     ast::Fn(it) => self.fn_to_def(container.with_value(it))?.into(),
 377                     ast::Struct(it) => self.struct_to_def(container.with_value(it))?.into(),
 378                     ast::Enum(it) => self.enum_to_def(container.with_value(it))?.into(),
 379                     ast::Trait(it) => self.trait_to_def(container.with_value(it))?.into(),
 380                     ast::TypeAlias(it) => self.type_alias_to_def(container.with_value(it))?.into(),
 381                     ast::Impl(it) => self.impl_to_def(container.with_value(it))?.into(),
 382                     _ => continue,
 383                 }
 384             };
 385             return Some(res);
 386         }
 387         None
 388     }
 389
 390     fn find_pat_or_label_container(&mut self, src: InFile<&SyntaxNode>) -> Option<DefWithBodyId> {
 391         for container in src.cloned().ancestors_with_macros(self.db.upcast()).skip(1) {
 392             let res: DefWithBodyId = match_ast! {
 393                 match (container.value) {
 394                     ast::Const(it) => self.const_to_def(container.with_value(it))?.into(),
 395                     ast::Static(it) => self.static_to_def(container.with_value(it))?.into(),
 396                     ast::Fn(it) => self.fn_to_def(container.with_value(it))?.into(),
 397                     _ => continue,
 398                 }
 399             };
 400             return Some(res);
 401         }
 402         None
 403     }
 404 }
 405
 406 #[derive(Clone, Copy, PartialEq, Eq, Hash, Debug)]
 407 pub(crate) enum ChildContainer {
 408     DefWithBodyId(DefWithBodyId),
 409     ModuleId(ModuleId),
 410     TraitId(TraitId),
 411     ImplId(ImplId),
 412     EnumId(EnumId),
 413     VariantId(VariantId),
 414     TypeAliasId(TypeAliasId),
 415     /// XXX: this might be the same def as, for example an `EnumId`. However,
 416     /// here the children are generic parameters, and not, eg enum variants.
 417     GenericDefId(GenericDefId),
 418 }
 419 impl_from! {
 420     DefWithBodyId,
 421     ModuleId,
 422     TraitId,
 423     ImplId,
 424     EnumId,
 425     VariantId,
 426     TypeAliasId,
 427     GenericDefId
 428     for ChildContainer
 429 }
 430
 431 impl ChildContainer {
 432     fn child_by_source(self, db: &dyn HirDatabase, file_id: HirFileId) -> DynMap {
 433         let db = db.upcast();
 434         match self {
 435             ChildContainer::DefWithBodyId(it) => it.child_by_source(db, file_id),
 436             ChildContainer::ModuleId(it) => it.child_by_source(db, file_id),
 437             ChildContainer::TraitId(it) => it.child_by_source(db, file_id),
 438             ChildContainer::ImplId(it) => it.child_by_source(db, file_id),
 439             ChildContainer::EnumId(it) => it.child_by_source(db, file_id),
 440             ChildContainer::VariantId(it) => it.child_by_source(db, file_id),
 441             ChildContainer::TypeAliasId(_) => DynMap::default(),
 442             ChildContainer::GenericDefId(it) => it.child_by_source(db, file_id),
 443         }
 444     }
 445 }