hygiene 2.0

Author: Veykril

Cargo.toml

@@ -12,7 +12,7 @@ authors = ["rust-analyzer team"]
 [profile.dev]
 # Disabling debug info speeds up builds a bunch,
 # and we don't rely on it for debugging that much.
-debug = 0
+debug = 1
 
 [profile.dev.package]
 # These speed up local tests.

crates/base-db/src/span.rs

@@ -17,9 +17,18 @@ pub struct SyntaxContextId(InternId);
 crate::impl_intern_key!(SyntaxContextId);
 
 impl SyntaxContext for SyntaxContextId {
+    const DUMMY: Self = Self::ROOT;
+    // veykril(HACK): salsa doesn't allow us fetching the id of the current input to be allocated so
+    // we need a special value that behaves as the current context.
+}
+// inherent trait impls please tyvm
+impl SyntaxContextId {
+    // FIXME: This is very much UB, salsa exposes no way to create an InternId in a const context
+    // currently (which kind of makes sense but we need it here!)
+    pub const ROOT: Self = SyntaxContextId(unsafe { core::mem::transmute(1) });
     // FIXME: This is very much UB, salsa exposes no way to create an InternId in a const context
     // currently (which kind of makes sense but we need it here!)
-    const DUMMY: Self = SyntaxContextId(unsafe { core::mem::transmute(1) });
+    pub const SELF_REF: Self = SyntaxContextId(unsafe { core::mem::transmute(!0u32) });
 }
 
 #[derive(Copy, Clone, PartialEq, Eq, Hash)]

crates/hir-def/src/data.rs

@@ -706,7 +706,7 @@ impl<'a> AssocItemCollector<'a> {
             }
             AssocItem::MacroCall(call) => {
                 let file_id = self.expander.current_file_id();
-                let MacroCall { ast_id, expand_to, ref path } = item_tree[call];
+                let MacroCall { ast_id, expand_to, call_site, ref path } = item_tree[call];
                 let module = self.expander.module.local_id;
 
                 let resolver = |path| {
@@ -725,6 +725,7 @@ impl<'a> AssocItemCollector<'a> {
                 match macro_call_as_call_id(
                     self.db.upcast(),
                     &AstIdWithPath::new(file_id, ast_id, Clone::clone(path)),
+                    call_site,
                     expand_to,
                     self.expander.module.krate(),
                     resolver,

crates/hir-def/src/expander.rs

@@ -7,11 +7,12 @@ use base_db::{
 use cfg::CfgOptions;
 use drop_bomb::DropBomb;
 use hir_expand::{
-    attrs::RawAttrs, hygiene::Hygiene, mod_path::ModPath, ExpandError, ExpandResult, HirFileId,
-    InFile, MacroCallId, UnresolvedMacro,
+    attrs::RawAttrs, mod_path::ModPath, ExpandError, ExpandResult, HirFileId, InFile, MacroCallId,
+    SpanMap, UnresolvedMacro,
 };
 use limit::Limit;
 use syntax::{ast, Parse, SyntaxNode};
+use triomphe::Arc;
 
 use crate::{
     attr::Attrs, db::DefDatabase, lower::LowerCtx, macro_id_to_def_id, path::Path, AsMacroCall,
@@ -21,7 +22,7 @@ use crate::{
 #[derive(Debug)]
 pub struct Expander {
     cfg_options: CfgOptions,
-    hygiene: Hygiene,
+    hygiene: Arc<SpanMap>,
     krate: CrateId,
     pub(crate) current_file_id: HirFileId,
     pub(crate) module: ModuleId,
@@ -44,7 +45,7 @@ impl Expander {
             recursion_depth: 0,
             recursion_limit,
             cfg_options: db.crate_graph()[module.krate].cfg_options.clone(),
-            hygiene: Hygiene::new(db.upcast(), current_file_id),
+            hygiene: db.span_map(current_file_id),
             krate: module.krate,
         }
     }
@@ -98,7 +99,7 @@ impl Expander {
     }
 
     pub fn exit(&mut self, db: &dyn DefDatabase, mut mark: Mark) {
-        self.hygiene = Hygiene::new(db.upcast(), mark.file_id);
+        self.hygiene = db.span_map(mark.file_id);
         self.current_file_id = mark.file_id;
         if self.recursion_depth == u32::MAX {
             // Recursion limit has been reached somewhere in the macro expansion tree. Reset the
@@ -113,7 +114,7 @@ impl Expander {
     }
 
     pub fn ctx<'a>(&self, db: &'a dyn DefDatabase) -> LowerCtx<'a> {
-        LowerCtx::new(db, &self.hygiene, self.current_file_id)
+        LowerCtx::new(db, self.hygiene.clone(), self.current_file_id)
     }
 
     pub(crate) fn to_source<T>(&self, value: T) -> InFile<T> {
@@ -143,7 +144,7 @@ impl Expander {
     }
 
     pub(crate) fn parse_path(&mut self, db: &dyn DefDatabase, path: ast::Path) -> Option<Path> {
-        let ctx = LowerCtx::new(db, &self.hygiene, self.current_file_id);
+        let ctx = LowerCtx::new(db, self.hygiene.clone(), self.current_file_id);
         Path::from_src(path, &ctx)
     }
 
@@ -187,7 +188,7 @@ impl Expander {
                     let parse = value.cast::<T>()?;
 
                     self.recursion_depth += 1;
-                    self.hygiene = Hygiene::new(db.upcast(), file_id);
+                    self.hygiene = db.span_map(file_id);
                     let old_file_id = std::mem::replace(&mut self.current_file_id, file_id);
                     let mark = Mark {
                         file_id: old_file_id,

crates/hir-def/src/find_path.rs

@@ -586,7 +586,7 @@ fn find_local_import_locations(
 #[cfg(test)]
 mod tests {
     use base_db::fixture::WithFixture;
-    use hir_expand::hygiene::Hygiene;
+    use hir_expand::SpanMap;
     use syntax::ast::AstNode;
 
     use crate::test_db::TestDB;
@@ -608,7 +608,7 @@ mod tests {
         let parsed_path_file = syntax::SourceFile::parse(&format!("use {path};"));
         let ast_path =
             parsed_path_file.syntax_node().descendants().find_map(syntax::ast::Path::cast).unwrap();
-        let mod_path = ModPath::from_src(&db, ast_path, &Hygiene::new_unhygienic()).unwrap();
+        let mod_path = ModPath::from_src(&db, ast_path, &SpanMap::default()).unwrap();
 
         let def_map = module.def_map(&db);
         let resolved = def_map

crates/hir-def/src/item_tree.rs

@@ -44,14 +44,13 @@ use std::{
 
 use ast::{AstNode, HasName, StructKind};
 use base_db::{
-    span::{SpanAnchor, ROOT_ERASED_FILE_AST_ID},
+    span::{SpanAnchor, SyntaxContextId, ROOT_ERASED_FILE_AST_ID},
     CrateId,
 };
 use either::Either;
 use hir_expand::{
     ast_id_map::{AstIdNode, FileAstId},
     attrs::RawAttrs,
-    hygiene::Hygiene,
     name::{name, AsName, Name},
     ExpandTo, HirFileId, InFile,
 };
@@ -122,7 +121,7 @@ impl ItemTree {
         let mut item_tree = match_ast! {
             match syntax {
                 ast::SourceFile(file) => {
-                    top_attrs = Some(RawAttrs::new(db.upcast(), SpanAnchor { file_id, ast_id: ROOT_ERASED_FILE_AST_ID }, &file, ctx.hygiene()));
+                    top_attrs = Some(RawAttrs::new(db.upcast(), SpanAnchor { file_id, ast_id: ROOT_ERASED_FILE_AST_ID }, &file, ctx.span_map()));
                     ctx.lower_module_items(&file)
                 },
                 ast::MacroItems(items) => {
@@ -750,6 +749,7 @@ pub struct MacroCall {
     pub path: Interned<ModPath>,
     pub ast_id: FileAstId<ast::MacroCall>,
     pub expand_to: ExpandTo,
+    pub call_site: SyntaxContextId,
 }
 
 #[derive(Debug, Clone, Eq, PartialEq)]
@@ -779,7 +779,7 @@ impl Use {
         // Note: The AST unwraps are fine, since if they fail we should have never obtained `index`.
         let ast = InFile::new(file_id, self.ast_id).to_node(db.upcast());
         let ast_use_tree = ast.use_tree().expect("missing `use_tree`");
-        let hygiene = Hygiene::new(db.upcast(), file_id);
+        let hygiene = db.span_map(file_id);
         let (_, source_map) =
             lower::lower_use_tree(db, &hygiene, ast_use_tree).expect("failed to lower use tree");
         source_map[index].clone()
@@ -794,7 +794,7 @@ impl Use {
         // Note: The AST unwraps are fine, since if they fail we should have never obtained `index`.
         let ast = InFile::new(file_id, self.ast_id).to_node(db.upcast());
         let ast_use_tree = ast.use_tree().expect("missing `use_tree`");
-        let hygiene = Hygiene::new(db.upcast(), file_id);
+        let hygiene = db.span_map(file_id);
         lower::lower_use_tree(db, &hygiene, ast_use_tree).expect("failed to lower use tree").1
     }
 }

crates/hir-def/src/item_tree/lower.rs

@@ -3,7 +3,7 @@
 use std::collections::hash_map::Entry;
 
 use base_db::span::ErasedFileAstId;
-use hir_expand::{ast_id_map::AstIdMap, hygiene::Hygiene, HirFileId};
+use hir_expand::{ast_id_map::AstIdMap, HirFileId, SpanMap};
 use syntax::ast::{self, HasModuleItem, HasTypeBounds};
 
 use crate::{
@@ -37,8 +37,8 @@ impl<'a> Ctx<'a> {
         }
     }
 
-    pub(super) fn hygiene(&self) -> &Hygiene {
-        self.body_ctx.hygiene()
+    pub(super) fn span_map(&self) -> &SpanMap {
+        self.body_ctx.span_map()
     }
 
     pub(super) fn lower_module_items(mut self, item_owner: &dyn HasModuleItem) -> ItemTree {
@@ -90,7 +90,7 @@ impl<'a> Ctx<'a> {
                     ast_id: self.source_ast_id_map.ast_id(block).erase(),
                 },
                 block,
-                self.hygiene(),
+                self.span_map(),
             ),
         );
         self.tree.top_level = block
@@ -145,7 +145,7 @@ impl<'a> Ctx<'a> {
             self.db.upcast(),
             SpanAnchor { file_id: self.file, ast_id: mod_item.ast_id(&self.tree).erase() },
             item,
-            self.hygiene(),
+            self.span_map(),
         );
         self.add_attrs(mod_item.into(), attrs);
 
@@ -174,7 +174,7 @@ impl<'a> Ctx<'a> {
             self.db.upcast(),
             SpanAnchor { file_id: self.file, ast_id: item.ast_id(&self.tree).erase() },
             item_node,
-            self.hygiene(),
+            self.span_map(),
         );
         self.add_attrs(
             match item {
@@ -227,7 +227,7 @@ impl<'a> Ctx<'a> {
                         self.db.upcast(),
                         SpanAnchor { file_id: self.file, ast_id },
                         &field,
-                        self.hygiene(),
+                        self.span_map(),
                     ),
                 );
             }
@@ -260,7 +260,7 @@ impl<'a> Ctx<'a> {
                     self.db.upcast(),
                     SpanAnchor { file_id: self.file, ast_id },
                     &field,
-                    self.hygiene(),
+                    self.span_map(),
                 ),
             );
         }
@@ -314,7 +314,7 @@ impl<'a> Ctx<'a> {
                         self.db.upcast(),
                         SpanAnchor { file_id: self.file, ast_id },
                         &variant,
-                        self.hygiene(),
+                        self.span_map(),
                     ),
                 );
             }
@@ -370,7 +370,7 @@ impl<'a> Ctx<'a> {
                         self.db.upcast(),
                         SpanAnchor { file_id: self.file, ast_id: ast_id.erase() },
                         &self_param,
-                        self.hygiene(),
+                        self.span_map(),
                     ),
                 );
                 has_self_param = true;
@@ -396,7 +396,7 @@ impl<'a> Ctx<'a> {
                         self.db.upcast(),
                         SpanAnchor { file_id: self.file, ast_id: ast_id.erase() },
                         &param,
-                        self.hygiene(),
+                        self.span_map(),
                     ),
                 );
             }
@@ -585,7 +585,7 @@ impl<'a> Ctx<'a> {
     fn lower_use(&mut self, use_item: &ast::Use) -> Option<FileItemTreeId<Use>> {
         let visibility = self.lower_visibility(use_item);
         let ast_id = self.source_ast_id_map.ast_id(use_item);
-        let (use_tree, _) = lower_use_tree(self.db, self.hygiene(), use_item.use_tree()?)?;
+        let (use_tree, _) = lower_use_tree(self.db, self.span_map(), use_item.use_tree()?)?;
 
         let res = Use { visibility, ast_id, use_tree };
         Some(id(self.data().uses.alloc(res)))
@@ -607,10 +607,18 @@ impl<'a> Ctx<'a> {
     }
 
     fn lower_macro_call(&mut self, m: &ast::MacroCall) -> Option<FileItemTreeId<MacroCall>> {
-        let path = Interned::new(ModPath::from_src(self.db.upcast(), m.path()?, self.hygiene())?);
+        let span_map = self.span_map();
+        let path = Interned::new(ModPath::from_src(self.db.upcast(), m.path()?, span_map)?);
         let ast_id = self.source_ast_id_map.ast_id(m);
         let expand_to = hir_expand::ExpandTo::from_call_site(m);
-        let res = MacroCall { path, ast_id, expand_to };
+        let res = MacroCall {
+            path,
+            ast_id,
+            expand_to,
+            call_site: span_map
+                .span_for_range(m.syntax().text_range())
+                .map_or(SyntaxContextId::ROOT, |s| s.ctx),
+        };
         Some(id(self.data().macro_calls.alloc(res)))
     }
 
@@ -655,7 +663,7 @@ impl<'a> Ctx<'a> {
                             ast_id: mod_item.ast_id(&self.tree).erase(),
                         },
                         &item,
-                        self.hygiene(),
+                        self.span_map(),
                     );
                     self.add_attrs(mod_item.into(), attrs);
                     Some(mod_item)
@@ -697,7 +705,7 @@ impl<'a> Ctx<'a> {
                 self.db.upcast(),
                 SpanAnchor { file_id: self.file, ast_id: owner_ast_id },
                 &param,
-                self.body_ctx.hygiene(),
+                self.body_ctx.span_map(),
             );
             // This is identical to the body of `Ctx::add_attrs()` but we can't call that here
             // because it requires `&mut self` and the call to `generics.fill()` below also
@@ -731,7 +739,7 @@ impl<'a> Ctx<'a> {
     }
 
     fn lower_visibility(&mut self, item: &dyn ast::HasVisibility) -> RawVisibilityId {
-        let vis = RawVisibility::from_ast_with_hygiene(self.db, item.visibility(), self.hygiene());
+        let vis = RawVisibility::from_ast_with_hygiene(self.db, item.visibility(), self.span_map());
         self.data().vis.alloc(vis)
     }
 
@@ -809,7 +817,7 @@ fn lower_abi(abi: ast::Abi) -> Interned<str> {
 
 struct UseTreeLowering<'a> {
     db: &'a dyn DefDatabase,
-    hygiene: &'a Hygiene,
+    hygiene: &'a SpanMap,
     mapping: Arena<ast::UseTree>,
 }
 
@@ -877,7 +885,7 @@ impl UseTreeLowering<'_> {
 
 pub(crate) fn lower_use_tree(
     db: &dyn DefDatabase,
-    hygiene: &Hygiene,
+    hygiene: &SpanMap,
     tree: ast::UseTree,
 ) -> Option<(UseTree, Arena<ast::UseTree>)> {
     let mut lowering = UseTreeLowering { db, hygiene, mapping: Arena::new() };

crates/hir-def/src/item_tree/pretty.rs

@@ -457,7 +457,7 @@ impl Printer<'_> {
                 }
             }
             ModItem::MacroCall(it) => {
-                let MacroCall { path, ast_id: _, expand_to: _ } = &self.tree[it];
+                let MacroCall { path, ast_id: _, expand_to: _, call_site: _ } = &self.tree[it];
                 wln!(self, "{}!(...);", path.display(self.db.upcast()));
             }
             ModItem::MacroRules(it) => {