From d4a22fc801f4768990c7e62241bea5fe4ff92ead Mon Sep 17 00:00:00 2001 From: Jonas Schievink Date: Wed, 3 Feb 2021 17:48:41 +0100 Subject: Update `DefMap` and `block_def_map` docs --- crates/hir_def/src/db.rs | 15 +++++++++++++++ crates/hir_def/src/nameres.rs | 11 ++++++++++- 2 files changed, 25 insertions(+), 1 deletion(-) (limited to 'crates') diff --git a/crates/hir_def/src/db.rs b/crates/hir_def/src/db.rs index 7fe6f6346..6c01f1ed0 100644 --- a/crates/hir_def/src/db.rs +++ b/crates/hir_def/src/db.rs @@ -58,6 +58,21 @@ pub trait DefDatabase: InternDatabase + AstDatabase + Upcast { #[salsa::invoke(DefMap::crate_def_map_query)] fn crate_def_map_query(&self, krate: CrateId) -> Arc; + /// Computes the block-level `DefMap`, returning `None` when `block` doesn't contain any inner + /// items directly. + /// + /// For example: + /// + /// ``` + /// fn f() { // (0) + /// { // (1) + /// fn inner() {} + /// } + /// } + /// ``` + /// + /// The `block_def_map` for block 0 would return `None`, while `block_def_map` of block 1 would + /// return a `DefMap` containing `inner`. #[salsa::invoke(DefMap::block_def_map_query)] fn block_def_map(&self, block: BlockId) -> Option>; diff --git a/crates/hir_def/src/nameres.rs b/crates/hir_def/src/nameres.rs index ece5958f4..ef54f7d08 100644 --- a/crates/hir_def/src/nameres.rs +++ b/crates/hir_def/src/nameres.rs @@ -73,7 +73,15 @@ use crate::{ AstId, BlockId, BlockLoc, LocalModuleId, ModuleDefId, ModuleId, }; -/// Contains all top-level defs from a macro-expanded crate +/// Contains the results of (early) name resolution. +/// +/// A `DefMap` stores the module tree and the definitions that are in scope in every module after +/// item-level macros have been expanded. +/// +/// Every crate has a primary `DefMap` whose root is the crate's main file (`main.rs`/`lib.rs`), +/// computed by the `crate_def_map` query. Additionally, every block expression introduces the +/// opportunity to write arbitrary item and module hierarchies, and thus gets its own `DefMap` that +/// is computed by the `block_def_map` query. #[derive(Debug, PartialEq, Eq)] pub struct DefMap { _c: Count, @@ -91,6 +99,7 @@ pub struct DefMap { diagnostics: Vec, } +/// For `DefMap`s computed for a block expression, this stores its location in the parent map. #[derive(Debug, PartialEq, Eq)] struct BlockInfo { block: BlockId, -- cgit v1.2.3