diff options
author | Aleksey Kladov <[email protected]> | 2018-11-28 00:42:26 +0000 |
---|---|---|
committer | Aleksey Kladov <[email protected]> | 2018-11-28 00:42:26 +0000 |
commit | 0e4b710af83844f4a7c471c5335c99aaaa25a90c (patch) | |
tree | a073635942db7431b93e191aa98201a01e3fc2cd /crates/ra_hir/src | |
parent | f66e5b6e6b6f7b2b899ef4207dfe46655d77334c (diff) |
introduce hir crate
Diffstat (limited to 'crates/ra_hir/src')
-rw-r--r-- | crates/ra_hir/src/arena.rs | 66 | ||||
-rw-r--r-- | crates/ra_hir/src/db.rs | 66 | ||||
-rw-r--r-- | crates/ra_hir/src/function/mod.rs | 190 | ||||
-rw-r--r-- | crates/ra_hir/src/function/scope.rs | 450 | ||||
-rw-r--r-- | crates/ra_hir/src/lib.rs | 139 | ||||
-rw-r--r-- | crates/ra_hir/src/module/imp.rs | 194 | ||||
-rw-r--r-- | crates/ra_hir/src/module/mod.rs | 378 | ||||
-rw-r--r-- | crates/ra_hir/src/module/nameres.rs | 444 | ||||
-rw-r--r-- | crates/ra_hir/src/path.rs | 148 | ||||
-rw-r--r-- | crates/ra_hir/src/query_definitions.rs | 154 |
10 files changed, 2229 insertions, 0 deletions
diff --git a/crates/ra_hir/src/arena.rs b/crates/ra_hir/src/arena.rs new file mode 100644 index 000000000..a752ec0c1 --- /dev/null +++ b/crates/ra_hir/src/arena.rs | |||
@@ -0,0 +1,66 @@ | |||
1 | //! A simple id-based arena, similar to https://github.com/fitzgen/id-arena. | ||
2 | //! We use our own version for more compact id's and to allow inherent impls | ||
3 | //! on Ids. | ||
4 | |||
5 | use std::{ | ||
6 | fmt, | ||
7 | hash::{Hash, Hasher}, | ||
8 | marker::PhantomData, | ||
9 | }; | ||
10 | |||
11 | pub(crate) struct Id<T> { | ||
12 | idx: u32, | ||
13 | _ty: PhantomData<fn() -> T>, | ||
14 | } | ||
15 | |||
16 | impl<T> fmt::Debug for Id<T> { | ||
17 | fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { | ||
18 | f.debug_tuple("Id").field(&self.idx).finish() | ||
19 | } | ||
20 | } | ||
21 | impl<T> Copy for Id<T> {} | ||
22 | impl<T> Clone for Id<T> { | ||
23 | fn clone(&self) -> Id<T> { | ||
24 | *self | ||
25 | } | ||
26 | } | ||
27 | |||
28 | impl<T> PartialEq for Id<T> { | ||
29 | fn eq(&self, other: &Id<T>) -> bool { | ||
30 | self.idx == other.idx | ||
31 | } | ||
32 | } | ||
33 | |||
34 | impl<T> Eq for Id<T> {} | ||
35 | |||
36 | impl<T> Hash for Id<T> { | ||
37 | fn hash<H: Hasher>(&self, h: &mut H) { | ||
38 | self.idx.hash(h); | ||
39 | } | ||
40 | } | ||
41 | |||
42 | #[derive(Debug, PartialEq, Eq)] | ||
43 | pub(crate) struct ArenaBehavior<T> { | ||
44 | _ty: PhantomData<T>, | ||
45 | } | ||
46 | |||
47 | impl<T> id_arena::ArenaBehavior for ArenaBehavior<T> { | ||
48 | type Id = Id<T>; | ||
49 | fn new_arena_id() -> usize { | ||
50 | 0 | ||
51 | } | ||
52 | fn new_id(_arena_id: usize, index: usize) -> Id<T> { | ||
53 | Id { | ||
54 | idx: index as u32, | ||
55 | _ty: PhantomData, | ||
56 | } | ||
57 | } | ||
58 | fn index(id: Id<T>) -> usize { | ||
59 | id.idx as usize | ||
60 | } | ||
61 | fn arena_id(_id: Id<T>) -> usize { | ||
62 | 0 | ||
63 | } | ||
64 | } | ||
65 | |||
66 | pub(crate) type Arena<T> = id_arena::Arena<T, ArenaBehavior<T>>; | ||
diff --git a/crates/ra_hir/src/db.rs b/crates/ra_hir/src/db.rs new file mode 100644 index 000000000..dbf8785fe --- /dev/null +++ b/crates/ra_hir/src/db.rs | |||
@@ -0,0 +1,66 @@ | |||
1 | use std::sync::Arc; | ||
2 | |||
3 | use ra_syntax::{ | ||
4 | SyntaxNode, | ||
5 | ast::FnDefNode, | ||
6 | }; | ||
7 | use ra_db::{SourceRootId, LocationIntener, SyntaxDatabase, FileId, Cancelable}; | ||
8 | |||
9 | use crate::{ | ||
10 | DefLoc, DefId, FnId, | ||
11 | SourceFileItems, SourceItemId, | ||
12 | query_definitions, | ||
13 | function::{FnScopes}, | ||
14 | module::{ModuleId, ModuleTree, ModuleSource, | ||
15 | nameres::{ItemMap, InputModuleItems}}, | ||
16 | }; | ||
17 | |||
18 | salsa::query_group! { | ||
19 | |||
20 | pub(crate) trait HirDatabase: SyntaxDatabase | ||
21 | + AsRef<LocationIntener<DefLoc, DefId>> | ||
22 | + AsRef<LocationIntener<SourceItemId, FnId>> | ||
23 | { | ||
24 | fn fn_scopes(fn_id: FnId) -> Arc<FnScopes> { | ||
25 | type FnScopesQuery; | ||
26 | use fn query_definitions::fn_scopes; | ||
27 | } | ||
28 | fn fn_syntax(fn_id: FnId) -> FnDefNode { | ||
29 | type FnSyntaxQuery; | ||
30 | // Don't retain syntax trees in memory | ||
31 | storage dependencies; | ||
32 | use fn query_definitions::fn_syntax; | ||
33 | } | ||
34 | |||
35 | fn file_items(file_id: FileId) -> Arc<SourceFileItems> { | ||
36 | type SourceFileItemsQuery; | ||
37 | storage dependencies; | ||
38 | use fn query_definitions::file_items; | ||
39 | } | ||
40 | |||
41 | fn file_item(source_item_id: SourceItemId) -> SyntaxNode { | ||
42 | type FileItemQuery; | ||
43 | storage dependencies; | ||
44 | use fn query_definitions::file_item; | ||
45 | } | ||
46 | |||
47 | fn submodules(source: ModuleSource) -> Cancelable<Arc<Vec<crate::module::imp::Submodule>>> { | ||
48 | type SubmodulesQuery; | ||
49 | use fn query_definitions::submodules; | ||
50 | } | ||
51 | |||
52 | fn input_module_items(source_root_id: SourceRootId, module_id: ModuleId) -> Cancelable<Arc<InputModuleItems>> { | ||
53 | type InputModuleItemsQuery; | ||
54 | use fn query_definitions::input_module_items; | ||
55 | } | ||
56 | fn item_map(source_root_id: SourceRootId) -> Cancelable<Arc<ItemMap>> { | ||
57 | type ItemMapQuery; | ||
58 | use fn query_definitions::item_map; | ||
59 | } | ||
60 | fn module_tree(source_root_id: SourceRootId) -> Cancelable<Arc<ModuleTree>> { | ||
61 | type ModuleTreeQuery; | ||
62 | use fn crate::module::imp::module_tree; | ||
63 | } | ||
64 | } | ||
65 | |||
66 | } | ||
diff --git a/crates/ra_hir/src/function/mod.rs b/crates/ra_hir/src/function/mod.rs new file mode 100644 index 000000000..a3ed00f02 --- /dev/null +++ b/crates/ra_hir/src/function/mod.rs | |||
@@ -0,0 +1,190 @@ | |||
1 | mod scope; | ||
2 | |||
3 | use std::{ | ||
4 | cmp::{max, min}, | ||
5 | sync::Arc, | ||
6 | }; | ||
7 | |||
8 | use ra_syntax::{ | ||
9 | TextRange, TextUnit, SyntaxNodeRef, | ||
10 | ast::{self, AstNode, DocCommentsOwner, NameOwner}, | ||
11 | }; | ||
12 | use ra_db::FileId; | ||
13 | |||
14 | use crate::{ | ||
15 | FnId, HirDatabase, SourceItemId, | ||
16 | }; | ||
17 | |||
18 | pub(crate) use self::scope::FnScopes; | ||
19 | |||
20 | impl FnId { | ||
21 | pub(crate) fn get(db: &impl HirDatabase, file_id: FileId, fn_def: ast::FnDef) -> FnId { | ||
22 | let file_items = db.file_items(file_id); | ||
23 | let item_id = file_items.id_of(fn_def.syntax()); | ||
24 | let item_id = SourceItemId { file_id, item_id }; | ||
25 | FnId::from_loc(db, &item_id) | ||
26 | } | ||
27 | } | ||
28 | |||
29 | pub(crate) struct Function { | ||
30 | fn_id: FnId, | ||
31 | } | ||
32 | |||
33 | impl Function { | ||
34 | pub(crate) fn guess_from_source( | ||
35 | db: &impl HirDatabase, | ||
36 | file_id: FileId, | ||
37 | fn_def: ast::FnDef, | ||
38 | ) -> Function { | ||
39 | let fn_id = FnId::get(db, file_id, fn_def); | ||
40 | Function { fn_id } | ||
41 | } | ||
42 | |||
43 | pub(crate) fn guess_for_name_ref( | ||
44 | db: &impl HirDatabase, | ||
45 | file_id: FileId, | ||
46 | name_ref: ast::NameRef, | ||
47 | ) -> Option<Function> { | ||
48 | Function::guess_for_node(db, file_id, name_ref.syntax()) | ||
49 | } | ||
50 | |||
51 | pub(crate) fn guess_for_bind_pat( | ||
52 | db: &impl HirDatabase, | ||
53 | file_id: FileId, | ||
54 | bind_pat: ast::BindPat, | ||
55 | ) -> Option<Function> { | ||
56 | Function::guess_for_node(db, file_id, bind_pat.syntax()) | ||
57 | } | ||
58 | |||
59 | fn guess_for_node( | ||
60 | db: &impl HirDatabase, | ||
61 | file_id: FileId, | ||
62 | node: SyntaxNodeRef, | ||
63 | ) -> Option<Function> { | ||
64 | let fn_def = node.ancestors().find_map(ast::FnDef::cast)?; | ||
65 | let res = Function::guess_from_source(db, file_id, fn_def); | ||
66 | Some(res) | ||
67 | } | ||
68 | |||
69 | pub(crate) fn scope(&self, db: &impl HirDatabase) -> Arc<FnScopes> { | ||
70 | db.fn_scopes(self.fn_id) | ||
71 | } | ||
72 | |||
73 | pub(crate) fn signature_info(&self, db: &impl HirDatabase) -> Option<FnSignatureInfo> { | ||
74 | let syntax = db.fn_syntax(self.fn_id); | ||
75 | FnSignatureInfo::new(syntax.borrowed()) | ||
76 | } | ||
77 | } | ||
78 | |||
79 | #[derive(Debug, Clone)] | ||
80 | pub struct FnSignatureInfo { | ||
81 | pub name: String, | ||
82 | pub label: String, | ||
83 | pub ret_type: Option<String>, | ||
84 | pub params: Vec<String>, | ||
85 | pub doc: Option<String>, | ||
86 | } | ||
87 | |||
88 | impl FnSignatureInfo { | ||
89 | fn new(node: ast::FnDef) -> Option<Self> { | ||
90 | let name = node.name()?.text().to_string(); | ||
91 | |||
92 | let mut doc = None; | ||
93 | |||
94 | // Strip the body out for the label. | ||
95 | let mut label: String = if let Some(body) = node.body() { | ||
96 | let body_range = body.syntax().range(); | ||
97 | let label: String = node | ||
98 | .syntax() | ||
99 | .children() | ||
100 | .filter(|child| !child.range().is_subrange(&body_range)) | ||
101 | .map(|node| node.text().to_string()) | ||
102 | .collect(); | ||
103 | label | ||
104 | } else { | ||
105 | node.syntax().text().to_string() | ||
106 | }; | ||
107 | |||
108 | if let Some((comment_range, docs)) = FnSignatureInfo::extract_doc_comments(node) { | ||
109 | let comment_range = comment_range | ||
110 | .checked_sub(node.syntax().range().start()) | ||
111 | .unwrap(); | ||
112 | let start = comment_range.start().to_usize(); | ||
113 | let end = comment_range.end().to_usize(); | ||
114 | |||
115 | // Remove the comment from the label | ||
116 | label.replace_range(start..end, ""); | ||
117 | |||
118 | // Massage markdown | ||
119 | let mut processed_lines = Vec::new(); | ||
120 | let mut in_code_block = false; | ||
121 | for line in docs.lines() { | ||
122 | if line.starts_with("```") { | ||
123 | in_code_block = !in_code_block; | ||
124 | } | ||
125 | |||
126 | let line = if in_code_block && line.starts_with("```") && !line.contains("rust") { | ||
127 | "```rust".into() | ||
128 | } else { | ||
129 | line.to_string() | ||
130 | }; | ||
131 | |||
132 | processed_lines.push(line); | ||
133 | } | ||
134 | |||
135 | if !processed_lines.is_empty() { | ||
136 | doc = Some(processed_lines.join("\n")); | ||
137 | } | ||
138 | } | ||
139 | |||
140 | let params = FnSignatureInfo::param_list(node); | ||
141 | let ret_type = node.ret_type().map(|r| r.syntax().text().to_string()); | ||
142 | |||
143 | Some(FnSignatureInfo { | ||
144 | name, | ||
145 | ret_type, | ||
146 | params, | ||
147 | label: label.trim().to_owned(), | ||
148 | doc, | ||
149 | }) | ||
150 | } | ||
151 | |||
152 | fn extract_doc_comments(node: ast::FnDef) -> Option<(TextRange, String)> { | ||
153 | if node.doc_comments().count() == 0 { | ||
154 | return None; | ||
155 | } | ||
156 | |||
157 | let comment_text = node.doc_comment_text(); | ||
158 | |||
159 | let (begin, end) = node | ||
160 | .doc_comments() | ||
161 | .map(|comment| comment.syntax().range()) | ||
162 | .map(|range| (range.start().to_usize(), range.end().to_usize())) | ||
163 | .fold((std::usize::MAX, std::usize::MIN), |acc, range| { | ||
164 | (min(acc.0, range.0), max(acc.1, range.1)) | ||
165 | }); | ||
166 | |||
167 | let range = TextRange::from_to(TextUnit::from_usize(begin), TextUnit::from_usize(end)); | ||
168 | |||
169 | Some((range, comment_text)) | ||
170 | } | ||
171 | |||
172 | fn param_list(node: ast::FnDef) -> Vec<String> { | ||
173 | let mut res = vec![]; | ||
174 | if let Some(param_list) = node.param_list() { | ||
175 | if let Some(self_param) = param_list.self_param() { | ||
176 | res.push(self_param.syntax().text().to_string()) | ||
177 | } | ||
178 | |||
179 | // Maybe use param.pat here? See if we can just extract the name? | ||
180 | //res.extend(param_list.params().map(|p| p.syntax().text().to_string())); | ||
181 | res.extend( | ||
182 | param_list | ||
183 | .params() | ||
184 | .filter_map(|p| p.pat()) | ||
185 | .map(|pat| pat.syntax().text().to_string()), | ||
186 | ); | ||
187 | } | ||
188 | res | ||
189 | } | ||
190 | } | ||
diff --git a/crates/ra_hir/src/function/scope.rs b/crates/ra_hir/src/function/scope.rs new file mode 100644 index 000000000..c8b6b1934 --- /dev/null +++ b/crates/ra_hir/src/function/scope.rs | |||
@@ -0,0 +1,450 @@ | |||
1 | use rustc_hash::{FxHashMap, FxHashSet}; | ||
2 | |||
3 | use ra_syntax::{ | ||
4 | AstNode, SmolStr, SyntaxNodeRef, TextRange, | ||
5 | algo::generate, | ||
6 | ast::{self, ArgListOwner, LoopBodyOwner, NameOwner}, | ||
7 | }; | ||
8 | use ra_db::LocalSyntaxPtr; | ||
9 | |||
10 | use crate::{ | ||
11 | arena::{Arena, Id}, | ||
12 | }; | ||
13 | |||
14 | pub(crate) type ScopeId = Id<ScopeData>; | ||
15 | |||
16 | #[derive(Debug, PartialEq, Eq)] | ||
17 | pub struct FnScopes { | ||
18 | pub(crate) self_param: Option<LocalSyntaxPtr>, | ||
19 | scopes: Arena<ScopeData>, | ||
20 | scope_for: FxHashMap<LocalSyntaxPtr, ScopeId>, | ||
21 | } | ||
22 | |||
23 | #[derive(Debug, PartialEq, Eq)] | ||
24 | pub struct ScopeEntry { | ||
25 | name: SmolStr, | ||
26 | ptr: LocalSyntaxPtr, | ||
27 | } | ||
28 | |||
29 | #[derive(Debug, PartialEq, Eq)] | ||
30 | pub(crate) struct ScopeData { | ||
31 | parent: Option<ScopeId>, | ||
32 | entries: Vec<ScopeEntry>, | ||
33 | } | ||
34 | |||
35 | impl FnScopes { | ||
36 | pub(crate) fn new(fn_def: ast::FnDef) -> FnScopes { | ||
37 | let mut scopes = FnScopes { | ||
38 | self_param: fn_def | ||
39 | .param_list() | ||
40 | .and_then(|it| it.self_param()) | ||
41 | .map(|it| LocalSyntaxPtr::new(it.syntax())), | ||
42 | scopes: Arena::default(), | ||
43 | scope_for: FxHashMap::default(), | ||
44 | }; | ||
45 | let root = scopes.root_scope(); | ||
46 | scopes.add_params_bindings(root, fn_def.param_list()); | ||
47 | if let Some(body) = fn_def.body() { | ||
48 | compute_block_scopes(body, &mut scopes, root) | ||
49 | } | ||
50 | scopes | ||
51 | } | ||
52 | pub(crate) fn entries(&self, scope: ScopeId) -> &[ScopeEntry] { | ||
53 | &self.scopes[scope].entries | ||
54 | } | ||
55 | pub fn scope_chain<'a>(&'a self, node: SyntaxNodeRef) -> impl Iterator<Item = ScopeId> + 'a { | ||
56 | generate(self.scope_for(node), move |&scope| { | ||
57 | self.scopes[scope].parent | ||
58 | }) | ||
59 | } | ||
60 | pub(crate) fn resolve_local_name<'a>( | ||
61 | &'a self, | ||
62 | name_ref: ast::NameRef, | ||
63 | ) -> Option<&'a ScopeEntry> { | ||
64 | let mut shadowed = FxHashSet::default(); | ||
65 | let ret = self | ||
66 | .scope_chain(name_ref.syntax()) | ||
67 | .flat_map(|scope| self.entries(scope).iter()) | ||
68 | .filter(|entry| shadowed.insert(entry.name())) | ||
69 | .filter(|entry| entry.name() == &name_ref.text()) | ||
70 | .nth(0); | ||
71 | ret | ||
72 | } | ||
73 | |||
74 | pub fn find_all_refs(&self, pat: ast::BindPat) -> Vec<ReferenceDescriptor> { | ||
75 | let fn_def = pat.syntax().ancestors().find_map(ast::FnDef::cast).unwrap(); | ||
76 | let name_ptr = LocalSyntaxPtr::new(pat.syntax()); | ||
77 | let refs: Vec<_> = fn_def | ||
78 | .syntax() | ||
79 | .descendants() | ||
80 | .filter_map(ast::NameRef::cast) | ||
81 | .filter(|name_ref| match self.resolve_local_name(*name_ref) { | ||
82 | None => false, | ||
83 | Some(entry) => entry.ptr() == name_ptr, | ||
84 | }) | ||
85 | .map(|name_ref| ReferenceDescriptor { | ||
86 | name: name_ref.syntax().text().to_string(), | ||
87 | range: name_ref.syntax().range(), | ||
88 | }) | ||
89 | .collect(); | ||
90 | |||
91 | refs | ||
92 | } | ||
93 | |||
94 | fn root_scope(&mut self) -> ScopeId { | ||
95 | self.scopes.alloc(ScopeData { | ||
96 | parent: None, | ||
97 | entries: vec![], | ||
98 | }) | ||
99 | } | ||
100 | fn new_scope(&mut self, parent: ScopeId) -> ScopeId { | ||
101 | self.scopes.alloc(ScopeData { | ||
102 | parent: Some(parent), | ||
103 | entries: vec![], | ||
104 | }) | ||
105 | } | ||
106 | fn add_bindings(&mut self, scope: ScopeId, pat: ast::Pat) { | ||
107 | let entries = pat | ||
108 | .syntax() | ||
109 | .descendants() | ||
110 | .filter_map(ast::BindPat::cast) | ||
111 | .filter_map(ScopeEntry::new); | ||
112 | self.scopes[scope].entries.extend(entries); | ||
113 | } | ||
114 | fn add_params_bindings(&mut self, scope: ScopeId, params: Option<ast::ParamList>) { | ||
115 | params | ||
116 | .into_iter() | ||
117 | .flat_map(|it| it.params()) | ||
118 | .filter_map(|it| it.pat()) | ||
119 | .for_each(|it| self.add_bindings(scope, it)); | ||
120 | } | ||
121 | fn set_scope(&mut self, node: SyntaxNodeRef, scope: ScopeId) { | ||
122 | self.scope_for.insert(LocalSyntaxPtr::new(node), scope); | ||
123 | } | ||
124 | fn scope_for(&self, node: SyntaxNodeRef) -> Option<ScopeId> { | ||
125 | node.ancestors() | ||
126 | .map(LocalSyntaxPtr::new) | ||
127 | .filter_map(|it| self.scope_for.get(&it).map(|&scope| scope)) | ||
128 | .next() | ||
129 | } | ||
130 | } | ||
131 | |||
132 | impl ScopeEntry { | ||
133 | fn new(pat: ast::BindPat) -> Option<ScopeEntry> { | ||
134 | let name = pat.name()?; | ||
135 | let res = ScopeEntry { | ||
136 | name: name.text(), | ||
137 | ptr: LocalSyntaxPtr::new(pat.syntax()), | ||
138 | }; | ||
139 | Some(res) | ||
140 | } | ||
141 | pub(crate) fn name(&self) -> &SmolStr { | ||
142 | &self.name | ||
143 | } | ||
144 | pub(crate) fn ptr(&self) -> LocalSyntaxPtr { | ||
145 | self.ptr | ||
146 | } | ||
147 | } | ||
148 | |||
149 | fn compute_block_scopes(block: ast::Block, scopes: &mut FnScopes, mut scope: ScopeId) { | ||
150 | for stmt in block.statements() { | ||
151 | match stmt { | ||
152 | ast::Stmt::LetStmt(stmt) => { | ||
153 | if let Some(expr) = stmt.initializer() { | ||
154 | scopes.set_scope(expr.syntax(), scope); | ||
155 | compute_expr_scopes(expr, scopes, scope); | ||
156 | } | ||
157 | scope = scopes.new_scope(scope); | ||
158 | if let Some(pat) = stmt.pat() { | ||
159 | scopes.add_bindings(scope, pat); | ||
160 | } | ||
161 | } | ||
162 | ast::Stmt::ExprStmt(expr_stmt) => { | ||
163 | if let Some(expr) = expr_stmt.expr() { | ||
164 | scopes.set_scope(expr.syntax(), scope); | ||
165 | compute_expr_scopes(expr, scopes, scope); | ||
166 | } | ||
167 | } | ||
168 | } | ||
169 | } | ||
170 | if let Some(expr) = block.expr() { | ||
171 | scopes.set_scope(expr.syntax(), scope); | ||
172 | compute_expr_scopes(expr, scopes, scope); | ||
173 | } | ||
174 | } | ||
175 | |||
176 | fn compute_expr_scopes(expr: ast::Expr, scopes: &mut FnScopes, scope: ScopeId) { | ||
177 | match expr { | ||
178 | ast::Expr::IfExpr(e) => { | ||
179 | let cond_scope = e | ||
180 | .condition() | ||
181 | .and_then(|cond| compute_cond_scopes(cond, scopes, scope)); | ||
182 | if let Some(block) = e.then_branch() { | ||
183 | compute_block_scopes(block, scopes, cond_scope.unwrap_or(scope)); | ||
184 | } | ||
185 | if let Some(block) = e.else_branch() { | ||
186 | compute_block_scopes(block, scopes, scope); | ||
187 | } | ||
188 | } | ||
189 | ast::Expr::BlockExpr(e) => { | ||
190 | if let Some(block) = e.block() { | ||
191 | compute_block_scopes(block, scopes, scope); | ||
192 | } | ||
193 | } | ||
194 | ast::Expr::LoopExpr(e) => { | ||
195 | if let Some(block) = e.loop_body() { | ||
196 | compute_block_scopes(block, scopes, scope); | ||
197 | } | ||
198 | } | ||
199 | ast::Expr::WhileExpr(e) => { | ||
200 | let cond_scope = e | ||
201 | .condition() | ||
202 | .and_then(|cond| compute_cond_scopes(cond, scopes, scope)); | ||
203 | if let Some(block) = e.loop_body() { | ||
204 | compute_block_scopes(block, scopes, cond_scope.unwrap_or(scope)); | ||
205 | } | ||
206 | } | ||
207 | ast::Expr::ForExpr(e) => { | ||
208 | if let Some(expr) = e.iterable() { | ||
209 | compute_expr_scopes(expr, scopes, scope); | ||
210 | } | ||
211 | let mut scope = scope; | ||
212 | if let Some(pat) = e.pat() { | ||
213 | scope = scopes.new_scope(scope); | ||
214 | scopes.add_bindings(scope, pat); | ||
215 | } | ||
216 | if let Some(block) = e.loop_body() { | ||
217 | compute_block_scopes(block, scopes, scope); | ||
218 | } | ||
219 | } | ||
220 | ast::Expr::LambdaExpr(e) => { | ||
221 | let scope = scopes.new_scope(scope); | ||
222 | scopes.add_params_bindings(scope, e.param_list()); | ||
223 | if let Some(body) = e.body() { | ||
224 | scopes.set_scope(body.syntax(), scope); | ||
225 | compute_expr_scopes(body, scopes, scope); | ||
226 | } | ||
227 | } | ||
228 | ast::Expr::CallExpr(e) => { | ||
229 | compute_call_scopes(e.expr(), e.arg_list(), scopes, scope); | ||
230 | } | ||
231 | ast::Expr::MethodCallExpr(e) => { | ||
232 | compute_call_scopes(e.expr(), e.arg_list(), scopes, scope); | ||
233 | } | ||
234 | ast::Expr::MatchExpr(e) => { | ||
235 | if let Some(expr) = e.expr() { | ||
236 | compute_expr_scopes(expr, scopes, scope); | ||
237 | } | ||
238 | for arm in e.match_arm_list().into_iter().flat_map(|it| it.arms()) { | ||
239 | let scope = scopes.new_scope(scope); | ||
240 | for pat in arm.pats() { | ||
241 | scopes.add_bindings(scope, pat); | ||
242 | } | ||
243 | if let Some(expr) = arm.expr() { | ||
244 | compute_expr_scopes(expr, scopes, scope); | ||
245 | } | ||
246 | } | ||
247 | } | ||
248 | _ => expr | ||
249 | .syntax() | ||
250 | .children() | ||
251 | .filter_map(ast::Expr::cast) | ||
252 | .for_each(|expr| compute_expr_scopes(expr, scopes, scope)), | ||
253 | }; | ||
254 | |||
255 | fn compute_call_scopes( | ||
256 | receiver: Option<ast::Expr>, | ||
257 | arg_list: Option<ast::ArgList>, | ||
258 | scopes: &mut FnScopes, | ||
259 | scope: ScopeId, | ||
260 | ) { | ||
261 | arg_list | ||
262 | .into_iter() | ||
263 | .flat_map(|it| it.args()) | ||
264 | .chain(receiver) | ||
265 | .for_each(|expr| compute_expr_scopes(expr, scopes, scope)); | ||
266 | } | ||
267 | |||
268 | fn compute_cond_scopes( | ||
269 | cond: ast::Condition, | ||
270 | scopes: &mut FnScopes, | ||
271 | scope: ScopeId, | ||
272 | ) -> Option<ScopeId> { | ||
273 | if let Some(expr) = cond.expr() { | ||
274 | compute_expr_scopes(expr, scopes, scope); | ||
275 | } | ||
276 | if let Some(pat) = cond.pat() { | ||
277 | let s = scopes.new_scope(scope); | ||
278 | scopes.add_bindings(s, pat); | ||
279 | Some(s) | ||
280 | } else { | ||
281 | None | ||
282 | } | ||
283 | } | ||
284 | } | ||
285 | |||
286 | #[derive(Debug)] | ||
287 | pub struct ReferenceDescriptor { | ||
288 | pub range: TextRange, | ||
289 | pub name: String, | ||
290 | } | ||
291 | |||
292 | #[cfg(test)] | ||
293 | mod tests { | ||
294 | use ra_editor::find_node_at_offset; | ||
295 | use ra_syntax::SourceFileNode; | ||
296 | use test_utils::extract_offset; | ||
297 | |||
298 | use super::*; | ||
299 | |||
300 | fn do_check(code: &str, expected: &[&str]) { | ||
301 | let (off, code) = extract_offset(code); | ||
302 | let code = { | ||
303 | let mut buf = String::new(); | ||
304 | let off = u32::from(off) as usize; | ||
305 | buf.push_str(&code[..off]); | ||
306 | buf.push_str("marker"); | ||
307 | buf.push_str(&code[off..]); | ||
308 | buf | ||
309 | }; | ||
310 | let file = SourceFileNode::parse(&code); | ||
311 | let marker: ast::PathExpr = find_node_at_offset(file.syntax(), off).unwrap(); | ||
312 | let fn_def: ast::FnDef = find_node_at_offset(file.syntax(), off).unwrap(); | ||
313 | let scopes = FnScopes::new(fn_def); | ||
314 | let actual = scopes | ||
315 | .scope_chain(marker.syntax()) | ||
316 | .flat_map(|scope| scopes.entries(scope)) | ||
317 | .map(|it| it.name()) | ||
318 | .collect::<Vec<_>>(); | ||
319 | assert_eq!(actual.as_slice(), expected); | ||
320 | } | ||
321 | |||
322 | #[test] | ||
323 | fn test_lambda_scope() { | ||
324 | do_check( | ||
325 | r" | ||
326 | fn quux(foo: i32) { | ||
327 | let f = |bar, baz: i32| { | ||
328 | <|> | ||
329 | }; | ||
330 | }", | ||
331 | &["bar", "baz", "foo"], | ||
332 | ); | ||
333 | } | ||
334 | |||
335 | #[test] | ||
336 | fn test_call_scope() { | ||
337 | do_check( | ||
338 | r" | ||
339 | fn quux() { | ||
340 | f(|x| <|> ); | ||
341 | }", | ||
342 | &["x"], | ||
343 | ); | ||
344 | } | ||
345 | |||
346 | #[test] | ||
347 | fn test_metod_call_scope() { | ||
348 | do_check( | ||
349 | r" | ||
350 | fn quux() { | ||
351 | z.f(|x| <|> ); | ||
352 | }", | ||
353 | &["x"], | ||
354 | ); | ||
355 | } | ||
356 | |||
357 | #[test] | ||
358 | fn test_loop_scope() { | ||
359 | do_check( | ||
360 | r" | ||
361 | fn quux() { | ||
362 | loop { | ||
363 | let x = (); | ||
364 | <|> | ||
365 | }; | ||
366 | }", | ||
367 | &["x"], | ||
368 | ); | ||
369 | } | ||
370 | |||
371 | #[test] | ||
372 | fn test_match() { | ||
373 | do_check( | ||
374 | r" | ||
375 | fn quux() { | ||
376 | match () { | ||
377 | Some(x) => { | ||
378 | <|> | ||
379 | } | ||
380 | }; | ||
381 | }", | ||
382 | &["x"], | ||
383 | ); | ||
384 | } | ||
385 | |||
386 | #[test] | ||
387 | fn test_shadow_variable() { | ||
388 | do_check( | ||
389 | r" | ||
390 | fn foo(x: String) { | ||
391 | let x : &str = &x<|>; | ||
392 | }", | ||
393 | &["x"], | ||
394 | ); | ||
395 | } | ||
396 | |||
397 | fn do_check_local_name(code: &str, expected_offset: u32) { | ||
398 | let (off, code) = extract_offset(code); | ||
399 | let file = SourceFileNode::parse(&code); | ||
400 | let fn_def: ast::FnDef = find_node_at_offset(file.syntax(), off).unwrap(); | ||
401 | let name_ref: ast::NameRef = find_node_at_offset(file.syntax(), off).unwrap(); | ||
402 | |||
403 | let scopes = FnScopes::new(fn_def); | ||
404 | |||
405 | let local_name_entry = scopes.resolve_local_name(name_ref).unwrap(); | ||
406 | let local_name = local_name_entry.ptr().resolve(&file); | ||
407 | let expected_name = | ||
408 | find_node_at_offset::<ast::Name>(file.syntax(), expected_offset.into()).unwrap(); | ||
409 | assert_eq!(local_name.range(), expected_name.syntax().range()); | ||
410 | } | ||
411 | |||
412 | #[test] | ||
413 | fn test_resolve_local_name() { | ||
414 | do_check_local_name( | ||
415 | r#" | ||
416 | fn foo(x: i32, y: u32) { | ||
417 | { | ||
418 | let z = x * 2; | ||
419 | } | ||
420 | { | ||
421 | let t = x<|> * 3; | ||
422 | } | ||
423 | }"#, | ||
424 | 21, | ||
425 | ); | ||
426 | } | ||
427 | |||
428 | #[test] | ||
429 | fn test_resolve_local_name_declaration() { | ||
430 | do_check_local_name( | ||
431 | r#" | ||
432 | fn foo(x: String) { | ||
433 | let x : &str = &x<|>; | ||
434 | }"#, | ||
435 | 21, | ||
436 | ); | ||
437 | } | ||
438 | |||
439 | #[test] | ||
440 | fn test_resolve_local_name_shadow() { | ||
441 | do_check_local_name( | ||
442 | r" | ||
443 | fn foo(x: String) { | ||
444 | let x : &str = &x; | ||
445 | x<|> | ||
446 | }", | ||
447 | 46, | ||
448 | ); | ||
449 | } | ||
450 | } | ||
diff --git a/crates/ra_hir/src/lib.rs b/crates/ra_hir/src/lib.rs new file mode 100644 index 000000000..7bf06c7f7 --- /dev/null +++ b/crates/ra_hir/src/lib.rs | |||
@@ -0,0 +1,139 @@ | |||
1 | //! HIR (previsouly known as descriptors) provides a high-level OO acess to Rust | ||
2 | //! code. | ||
3 | //! | ||
4 | //! The principal difference between HIR and syntax trees is that HIR is bound | ||
5 | //! to a particular crate instance. That is, it has cfg flags and features | ||
6 | //! applied. So, there relation between syntax and HIR is many-to-one. | ||
7 | |||
8 | macro_rules! ctry { | ||
9 | ($expr:expr) => { | ||
10 | match $expr { | ||
11 | None => return Ok(None), | ||
12 | Some(it) => it, | ||
13 | } | ||
14 | }; | ||
15 | } | ||
16 | |||
17 | pub(crate) mod db; | ||
18 | mod query_definitions; | ||
19 | mod function; | ||
20 | mod module; | ||
21 | mod path; | ||
22 | mod arena; | ||
23 | |||
24 | use std::ops::Index; | ||
25 | |||
26 | use ra_syntax::{SyntaxNodeRef, SyntaxNode}; | ||
27 | use ra_db::{LocationIntener, SourceRootId, FileId, Cancelable}; | ||
28 | |||
29 | use crate::{ | ||
30 | db::HirDatabase, | ||
31 | arena::{Arena, Id}, | ||
32 | }; | ||
33 | |||
34 | pub(crate) use self::{ | ||
35 | path::{Path, PathKind}, | ||
36 | module::{Module, ModuleId, Problem}, | ||
37 | function::{Function, FnScopes}, | ||
38 | }; | ||
39 | |||
40 | pub use self::function::FnSignatureInfo; | ||
41 | |||
42 | #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)] | ||
43 | pub(crate) struct FnId(u32); | ||
44 | ra_db::impl_numeric_id!(FnId); | ||
45 | |||
46 | impl FnId { | ||
47 | pub(crate) fn from_loc( | ||
48 | db: &impl AsRef<LocationIntener<SourceItemId, FnId>>, | ||
49 | loc: &SourceItemId, | ||
50 | ) -> FnId { | ||
51 | db.as_ref().loc2id(loc) | ||
52 | } | ||
53 | pub(crate) fn loc(self, db: &impl AsRef<LocationIntener<SourceItemId, FnId>>) -> SourceItemId { | ||
54 | db.as_ref().id2loc(self) | ||
55 | } | ||
56 | } | ||
57 | |||
58 | #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)] | ||
59 | pub(crate) struct DefId(u32); | ||
60 | ra_db::impl_numeric_id!(DefId); | ||
61 | |||
62 | #[derive(Clone, Debug, PartialEq, Eq, Hash)] | ||
63 | pub(crate) enum DefLoc { | ||
64 | Module { | ||
65 | id: ModuleId, | ||
66 | source_root: SourceRootId, | ||
67 | }, | ||
68 | Item { | ||
69 | source_item_id: SourceItemId, | ||
70 | }, | ||
71 | } | ||
72 | |||
73 | impl DefId { | ||
74 | pub(crate) fn loc(self, db: &impl AsRef<LocationIntener<DefLoc, DefId>>) -> DefLoc { | ||
75 | db.as_ref().id2loc(self) | ||
76 | } | ||
77 | } | ||
78 | |||
79 | impl DefLoc { | ||
80 | pub(crate) fn id(&self, db: &impl AsRef<LocationIntener<DefLoc, DefId>>) -> DefId { | ||
81 | db.as_ref().loc2id(&self) | ||
82 | } | ||
83 | } | ||
84 | |||
85 | pub(crate) enum Def { | ||
86 | Module(Module), | ||
87 | Item, | ||
88 | } | ||
89 | |||
90 | impl DefId { | ||
91 | pub(crate) fn resolve(self, db: &impl HirDatabase) -> Cancelable<Def> { | ||
92 | let loc = self.loc(db); | ||
93 | let res = match loc { | ||
94 | DefLoc::Module { id, source_root } => { | ||
95 | let descr = Module::new(db, source_root, id)?; | ||
96 | Def::Module(descr) | ||
97 | } | ||
98 | DefLoc::Item { .. } => Def::Item, | ||
99 | }; | ||
100 | Ok(res) | ||
101 | } | ||
102 | } | ||
103 | |||
104 | /// Identifier of item within a specific file. This is stable over reparses, so | ||
105 | /// it's OK to use it as a salsa key/value. | ||
106 | pub(crate) type SourceFileItemId = Id<SyntaxNode>; | ||
107 | |||
108 | #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)] | ||
109 | pub(crate) struct SourceItemId { | ||
110 | file_id: FileId, | ||
111 | item_id: SourceFileItemId, | ||
112 | } | ||
113 | |||
114 | /// Maps item's `SyntaxNode`s to `SourceFileItemId` and back. | ||
115 | #[derive(Debug, PartialEq, Eq, Default)] | ||
116 | pub(crate) struct SourceFileItems { | ||
117 | arena: Arena<SyntaxNode>, | ||
118 | } | ||
119 | |||
120 | impl SourceFileItems { | ||
121 | fn alloc(&mut self, item: SyntaxNode) -> SourceFileItemId { | ||
122 | self.arena.alloc(item) | ||
123 | } | ||
124 | fn id_of(&self, item: SyntaxNodeRef) -> SourceFileItemId { | ||
125 | let (id, _item) = self | ||
126 | .arena | ||
127 | .iter() | ||
128 | .find(|(_id, i)| i.borrowed() == item) | ||
129 | .unwrap(); | ||
130 | id | ||
131 | } | ||
132 | } | ||
133 | |||
134 | impl Index<SourceFileItemId> for SourceFileItems { | ||
135 | type Output = SyntaxNode; | ||
136 | fn index(&self, idx: SourceFileItemId) -> &SyntaxNode { | ||
137 | &self.arena[idx] | ||
138 | } | ||
139 | } | ||
diff --git a/crates/ra_hir/src/module/imp.rs b/crates/ra_hir/src/module/imp.rs new file mode 100644 index 000000000..d55fa3e6b --- /dev/null +++ b/crates/ra_hir/src/module/imp.rs | |||
@@ -0,0 +1,194 @@ | |||
1 | use std::sync::Arc; | ||
2 | |||
3 | use ra_syntax::{ | ||
4 | ast::{self, NameOwner}, | ||
5 | SmolStr, | ||
6 | }; | ||
7 | use relative_path::RelativePathBuf; | ||
8 | use rustc_hash::{FxHashMap, FxHashSet}; | ||
9 | use ra_db::{SourceRoot, SourceRootId, FileResolverImp, Cancelable, FileId,}; | ||
10 | |||
11 | use crate::{ | ||
12 | HirDatabase, | ||
13 | }; | ||
14 | |||
15 | use super::{ | ||
16 | LinkData, LinkId, ModuleData, ModuleId, ModuleSource, | ||
17 | ModuleTree, Problem, | ||
18 | }; | ||
19 | |||
20 | #[derive(Clone, Hash, PartialEq, Eq, Debug)] | ||
21 | pub(crate) enum Submodule { | ||
22 | Declaration(SmolStr), | ||
23 | Definition(SmolStr, ModuleSource), | ||
24 | } | ||
25 | |||
26 | impl Submodule { | ||
27 | fn name(&self) -> &SmolStr { | ||
28 | match self { | ||
29 | Submodule::Declaration(name) => name, | ||
30 | Submodule::Definition(name, _) => name, | ||
31 | } | ||
32 | } | ||
33 | } | ||
34 | |||
35 | pub(crate) fn modules<'a>( | ||
36 | root: impl ast::ModuleItemOwner<'a>, | ||
37 | ) -> impl Iterator<Item = (SmolStr, ast::Module<'a>)> { | ||
38 | root.items() | ||
39 | .filter_map(|item| match item { | ||
40 | ast::ModuleItem::Module(m) => Some(m), | ||
41 | _ => None, | ||
42 | }) | ||
43 | .filter_map(|module| { | ||
44 | let name = module.name()?.text(); | ||
45 | Some((name, module)) | ||
46 | }) | ||
47 | } | ||
48 | |||
49 | pub(crate) fn module_tree( | ||
50 | db: &impl HirDatabase, | ||
51 | source_root: SourceRootId, | ||
52 | ) -> Cancelable<Arc<ModuleTree>> { | ||
53 | db.check_canceled()?; | ||
54 | let res = create_module_tree(db, source_root)?; | ||
55 | Ok(Arc::new(res)) | ||
56 | } | ||
57 | |||
58 | fn create_module_tree<'a>( | ||
59 | db: &impl HirDatabase, | ||
60 | source_root: SourceRootId, | ||
61 | ) -> Cancelable<ModuleTree> { | ||
62 | let mut tree = ModuleTree::default(); | ||
63 | |||
64 | let mut roots = FxHashMap::default(); | ||
65 | let mut visited = FxHashSet::default(); | ||
66 | |||
67 | let source_root = db.source_root(source_root); | ||
68 | for &file_id in source_root.files.iter() { | ||
69 | let source = ModuleSource::SourceFile(file_id); | ||
70 | if visited.contains(&source) { | ||
71 | continue; // TODO: use explicit crate_roots here | ||
72 | } | ||
73 | assert!(!roots.contains_key(&file_id)); | ||
74 | let module_id = build_subtree( | ||
75 | db, | ||
76 | &source_root, | ||
77 | &mut tree, | ||
78 | &mut visited, | ||
79 | &mut roots, | ||
80 | None, | ||
81 | source, | ||
82 | )?; | ||
83 | roots.insert(file_id, module_id); | ||
84 | } | ||
85 | Ok(tree) | ||
86 | } | ||
87 | |||
88 | fn build_subtree( | ||
89 | db: &impl HirDatabase, | ||
90 | source_root: &SourceRoot, | ||
91 | tree: &mut ModuleTree, | ||
92 | visited: &mut FxHashSet<ModuleSource>, | ||
93 | roots: &mut FxHashMap<FileId, ModuleId>, | ||
94 | parent: Option<LinkId>, | ||
95 | source: ModuleSource, | ||
96 | ) -> Cancelable<ModuleId> { | ||
97 | visited.insert(source); | ||
98 | let id = tree.push_mod(ModuleData { | ||
99 | source, | ||
100 | parent, | ||
101 | children: Vec::new(), | ||
102 | }); | ||
103 | for sub in db.submodules(source)?.iter() { | ||
104 | let link = tree.push_link(LinkData { | ||
105 | name: sub.name().clone(), | ||
106 | owner: id, | ||
107 | points_to: Vec::new(), | ||
108 | problem: None, | ||
109 | }); | ||
110 | |||
111 | let (points_to, problem) = match sub { | ||
112 | Submodule::Declaration(name) => { | ||
113 | let (points_to, problem) = | ||
114 | resolve_submodule(source, &name, &source_root.file_resolver); | ||
115 | let points_to = points_to | ||
116 | .into_iter() | ||
117 | .map(|file_id| match roots.remove(&file_id) { | ||
118 | Some(module_id) => { | ||
119 | tree.mods[module_id].parent = Some(link); | ||
120 | Ok(module_id) | ||
121 | } | ||
122 | None => build_subtree( | ||
123 | db, | ||
124 | source_root, | ||
125 | tree, | ||
126 | visited, | ||
127 | roots, | ||
128 | Some(link), | ||
129 | ModuleSource::SourceFile(file_id), | ||
130 | ), | ||
131 | }) | ||
132 | .collect::<Cancelable<Vec<_>>>()?; | ||
133 | (points_to, problem) | ||
134 | } | ||
135 | Submodule::Definition(_name, submodule_source) => { | ||
136 | let points_to = build_subtree( | ||
137 | db, | ||
138 | source_root, | ||
139 | tree, | ||
140 | visited, | ||
141 | roots, | ||
142 | Some(link), | ||
143 | *submodule_source, | ||
144 | )?; | ||
145 | (vec![points_to], None) | ||
146 | } | ||
147 | }; | ||
148 | |||
149 | tree.links[link].points_to = points_to; | ||
150 | tree.links[link].problem = problem; | ||
151 | } | ||
152 | Ok(id) | ||
153 | } | ||
154 | |||
155 | fn resolve_submodule( | ||
156 | source: ModuleSource, | ||
157 | name: &SmolStr, | ||
158 | file_resolver: &FileResolverImp, | ||
159 | ) -> (Vec<FileId>, Option<Problem>) { | ||
160 | let file_id = match source { | ||
161 | ModuleSource::SourceFile(it) => it, | ||
162 | ModuleSource::Module(..) => { | ||
163 | // TODO | ||
164 | return (Vec::new(), None); | ||
165 | } | ||
166 | }; | ||
167 | let mod_name = file_resolver.file_stem(file_id); | ||
168 | let is_dir_owner = mod_name == "mod" || mod_name == "lib" || mod_name == "main"; | ||
169 | |||
170 | let file_mod = RelativePathBuf::from(format!("../{}.rs", name)); | ||
171 | let dir_mod = RelativePathBuf::from(format!("../{}/mod.rs", name)); | ||
172 | let points_to: Vec<FileId>; | ||
173 | let problem: Option<Problem>; | ||
174 | if is_dir_owner { | ||
175 | points_to = [&file_mod, &dir_mod] | ||
176 | .iter() | ||
177 | .filter_map(|path| file_resolver.resolve(file_id, path)) | ||
178 | .collect(); | ||
179 | problem = if points_to.is_empty() { | ||
180 | Some(Problem::UnresolvedModule { | ||
181 | candidate: file_mod, | ||
182 | }) | ||
183 | } else { | ||
184 | None | ||
185 | } | ||
186 | } else { | ||
187 | points_to = Vec::new(); | ||
188 | problem = Some(Problem::NotDirOwner { | ||
189 | move_to: RelativePathBuf::from(format!("../{}/mod.rs", mod_name)), | ||
190 | candidate: file_mod, | ||
191 | }); | ||
192 | } | ||
193 | (points_to, problem) | ||
194 | } | ||
diff --git a/crates/ra_hir/src/module/mod.rs b/crates/ra_hir/src/module/mod.rs new file mode 100644 index 000000000..81b9f948d --- /dev/null +++ b/crates/ra_hir/src/module/mod.rs | |||
@@ -0,0 +1,378 @@ | |||
1 | pub(super) mod imp; | ||
2 | pub(super) mod nameres; | ||
3 | |||
4 | use std::sync::Arc; | ||
5 | |||
6 | use ra_editor::find_node_at_offset; | ||
7 | |||
8 | use ra_syntax::{ | ||
9 | algo::generate, | ||
10 | ast::{self, AstNode, NameOwner}, | ||
11 | SmolStr, SyntaxNode, | ||
12 | }; | ||
13 | use ra_db::{SourceRootId, FileId, FilePosition, Cancelable}; | ||
14 | use relative_path::RelativePathBuf; | ||
15 | |||
16 | use crate::{ | ||
17 | DefLoc, DefId, Path, PathKind, HirDatabase, SourceItemId, | ||
18 | arena::{Arena, Id}, | ||
19 | }; | ||
20 | |||
21 | pub(crate) use self::nameres::ModuleScope; | ||
22 | |||
23 | /// `Module` is API entry point to get all the information | ||
24 | /// about a particular module. | ||
25 | #[derive(Debug, Clone)] | ||
26 | pub(crate) struct Module { | ||
27 | tree: Arc<ModuleTree>, | ||
28 | source_root_id: SourceRootId, | ||
29 | module_id: ModuleId, | ||
30 | } | ||
31 | |||
32 | impl Module { | ||
33 | /// Lookup `Module` by `FileId`. Note that this is inherently | ||
34 | /// lossy transformation: in general, a single source might correspond to | ||
35 | /// several modules. | ||
36 | pub fn guess_from_file_id( | ||
37 | db: &impl HirDatabase, | ||
38 | file_id: FileId, | ||
39 | ) -> Cancelable<Option<Module>> { | ||
40 | Module::guess_from_source(db, file_id, ModuleSource::SourceFile(file_id)) | ||
41 | } | ||
42 | |||
43 | /// Lookup `Module` by position in the source code. Note that this | ||
44 | /// is inherently lossy transformation: in general, a single source might | ||
45 | /// correspond to several modules. | ||
46 | pub fn guess_from_position( | ||
47 | db: &impl HirDatabase, | ||
48 | position: FilePosition, | ||
49 | ) -> Cancelable<Option<Module>> { | ||
50 | let file = db.source_file(position.file_id); | ||
51 | let module_source = match find_node_at_offset::<ast::Module>(file.syntax(), position.offset) | ||
52 | { | ||
53 | Some(m) if !m.has_semi() => ModuleSource::new_inline(db, position.file_id, m), | ||
54 | _ => ModuleSource::SourceFile(position.file_id), | ||
55 | }; | ||
56 | Module::guess_from_source(db, position.file_id, module_source) | ||
57 | } | ||
58 | |||
59 | fn guess_from_source( | ||
60 | db: &impl HirDatabase, | ||
61 | file_id: FileId, | ||
62 | module_source: ModuleSource, | ||
63 | ) -> Cancelable<Option<Module>> { | ||
64 | let source_root_id = db.file_source_root(file_id); | ||
65 | let module_tree = db.module_tree(source_root_id)?; | ||
66 | |||
67 | let res = match module_tree.any_module_for_source(module_source) { | ||
68 | None => None, | ||
69 | Some(module_id) => Some(Module { | ||
70 | tree: module_tree, | ||
71 | source_root_id, | ||
72 | module_id, | ||
73 | }), | ||
74 | }; | ||
75 | Ok(res) | ||
76 | } | ||
77 | |||
78 | pub(super) fn new( | ||
79 | db: &impl HirDatabase, | ||
80 | source_root_id: SourceRootId, | ||
81 | module_id: ModuleId, | ||
82 | ) -> Cancelable<Module> { | ||
83 | let module_tree = db.module_tree(source_root_id)?; | ||
84 | let res = Module { | ||
85 | tree: module_tree, | ||
86 | source_root_id, | ||
87 | module_id, | ||
88 | }; | ||
89 | Ok(res) | ||
90 | } | ||
91 | |||
92 | /// Returns `mod foo;` or `mod foo {}` node whihc declared this module. | ||
93 | /// Returns `None` for the root module | ||
94 | pub fn parent_link_source(&self, db: &impl HirDatabase) -> Option<(FileId, ast::ModuleNode)> { | ||
95 | let link = self.module_id.parent_link(&self.tree)?; | ||
96 | let file_id = link.owner(&self.tree).source(&self.tree).file_id(); | ||
97 | let src = link.bind_source(&self.tree, db); | ||
98 | Some((file_id, src)) | ||
99 | } | ||
100 | |||
101 | pub fn source(&self) -> ModuleSource { | ||
102 | self.module_id.source(&self.tree) | ||
103 | } | ||
104 | |||
105 | /// Parent module. Returns `None` if this is a root module. | ||
106 | pub fn parent(&self) -> Option<Module> { | ||
107 | let parent_id = self.module_id.parent(&self.tree)?; | ||
108 | Some(Module { | ||
109 | module_id: parent_id, | ||
110 | ..self.clone() | ||
111 | }) | ||
112 | } | ||
113 | |||
114 | /// The root of the tree this module is part of | ||
115 | pub fn crate_root(&self) -> Module { | ||
116 | let root_id = self.module_id.crate_root(&self.tree); | ||
117 | Module { | ||
118 | module_id: root_id, | ||
119 | ..self.clone() | ||
120 | } | ||
121 | } | ||
122 | |||
123 | /// `name` is `None` for the crate's root module | ||
124 | #[allow(unused)] | ||
125 | pub fn name(&self) -> Option<SmolStr> { | ||
126 | let link = self.module_id.parent_link(&self.tree)?; | ||
127 | Some(link.name(&self.tree)) | ||
128 | } | ||
129 | |||
130 | pub fn def_id(&self, db: &impl HirDatabase) -> DefId { | ||
131 | let def_loc = DefLoc::Module { | ||
132 | id: self.module_id, | ||
133 | source_root: self.source_root_id, | ||
134 | }; | ||
135 | def_loc.id(db) | ||
136 | } | ||
137 | |||
138 | /// Finds a child module with the specified name. | ||
139 | pub fn child(&self, name: &str) -> Option<Module> { | ||
140 | let child_id = self.module_id.child(&self.tree, name)?; | ||
141 | Some(Module { | ||
142 | module_id: child_id, | ||
143 | ..self.clone() | ||
144 | }) | ||
145 | } | ||
146 | |||
147 | /// Returns a `ModuleScope`: a set of items, visible in this module. | ||
148 | pub(crate) fn scope(&self, db: &impl HirDatabase) -> Cancelable<ModuleScope> { | ||
149 | let item_map = db.item_map(self.source_root_id)?; | ||
150 | let res = item_map.per_module[&self.module_id].clone(); | ||
151 | Ok(res) | ||
152 | } | ||
153 | |||
154 | pub(crate) fn resolve_path( | ||
155 | &self, | ||
156 | db: &impl HirDatabase, | ||
157 | path: Path, | ||
158 | ) -> Cancelable<Option<DefId>> { | ||
159 | let mut curr = match path.kind { | ||
160 | PathKind::Crate => self.crate_root(), | ||
161 | PathKind::Self_ | PathKind::Plain => self.clone(), | ||
162 | PathKind::Super => ctry!(self.parent()), | ||
163 | } | ||
164 | .def_id(db); | ||
165 | |||
166 | let segments = path.segments; | ||
167 | for name in segments.iter() { | ||
168 | let module = match curr.loc(db) { | ||
169 | DefLoc::Module { id, source_root } => Module::new(db, source_root, id)?, | ||
170 | _ => return Ok(None), | ||
171 | }; | ||
172 | let scope = module.scope(db)?; | ||
173 | curr = ctry!(ctry!(scope.get(&name)).def_id); | ||
174 | } | ||
175 | Ok(Some(curr)) | ||
176 | } | ||
177 | |||
178 | pub fn problems(&self, db: &impl HirDatabase) -> Vec<(SyntaxNode, Problem)> { | ||
179 | self.module_id.problems(&self.tree, db) | ||
180 | } | ||
181 | } | ||
182 | |||
183 | /// Phisically, rust source is organized as a set of files, but logically it is | ||
184 | /// organized as a tree of modules. Usually, a single file corresponds to a | ||
185 | /// single module, but it is not nessary the case. | ||
186 | /// | ||
187 | /// Module encapsulate the logic of transitioning from the fuzzy world of files | ||
188 | /// (which can have multiple parents) to the precise world of modules (which | ||
189 | /// always have one parent). | ||
190 | #[derive(Default, Debug, PartialEq, Eq)] | ||
191 | pub(crate) struct ModuleTree { | ||
192 | mods: Arena<ModuleData>, | ||
193 | links: Arena<LinkData>, | ||
194 | } | ||
195 | |||
196 | impl ModuleTree { | ||
197 | pub(crate) fn modules<'a>(&'a self) -> impl Iterator<Item = ModuleId> + 'a { | ||
198 | self.mods.iter().map(|(id, _)| id) | ||
199 | } | ||
200 | |||
201 | fn modules_for_source(&self, source: ModuleSource) -> Vec<ModuleId> { | ||
202 | self.mods | ||
203 | .iter() | ||
204 | .filter(|(_idx, it)| it.source == source) | ||
205 | .map(|(idx, _)| idx) | ||
206 | .collect() | ||
207 | } | ||
208 | |||
209 | fn any_module_for_source(&self, source: ModuleSource) -> Option<ModuleId> { | ||
210 | self.modules_for_source(source).pop() | ||
211 | } | ||
212 | } | ||
213 | |||
214 | /// `ModuleSource` is the syntax tree element that produced this module: | ||
215 | /// either a file, or an inlinde module. | ||
216 | #[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)] | ||
217 | pub(crate) enum ModuleSource { | ||
218 | SourceFile(FileId), | ||
219 | Module(SourceItemId), | ||
220 | } | ||
221 | |||
222 | /// An owned syntax node for a module. Unlike `ModuleSource`, | ||
223 | /// this holds onto the AST for the whole file. | ||
224 | pub(crate) enum ModuleSourceNode { | ||
225 | SourceFile(ast::SourceFileNode), | ||
226 | Module(ast::ModuleNode), | ||
227 | } | ||
228 | |||
229 | pub(crate) type ModuleId = Id<ModuleData>; | ||
230 | type LinkId = Id<LinkData>; | ||
231 | |||
232 | #[derive(Clone, Debug, Hash, PartialEq, Eq)] | ||
233 | pub enum Problem { | ||
234 | UnresolvedModule { | ||
235 | candidate: RelativePathBuf, | ||
236 | }, | ||
237 | NotDirOwner { | ||
238 | move_to: RelativePathBuf, | ||
239 | candidate: RelativePathBuf, | ||
240 | }, | ||
241 | } | ||
242 | |||
243 | impl ModuleId { | ||
244 | pub(crate) fn source(self, tree: &ModuleTree) -> ModuleSource { | ||
245 | tree.mods[self].source | ||
246 | } | ||
247 | fn parent_link(self, tree: &ModuleTree) -> Option<LinkId> { | ||
248 | tree.mods[self].parent | ||
249 | } | ||
250 | fn parent(self, tree: &ModuleTree) -> Option<ModuleId> { | ||
251 | let link = self.parent_link(tree)?; | ||
252 | Some(tree.links[link].owner) | ||
253 | } | ||
254 | fn crate_root(self, tree: &ModuleTree) -> ModuleId { | ||
255 | generate(Some(self), move |it| it.parent(tree)) | ||
256 | .last() | ||
257 | .unwrap() | ||
258 | } | ||
259 | fn child(self, tree: &ModuleTree, name: &str) -> Option<ModuleId> { | ||
260 | let link = tree.mods[self] | ||
261 | .children | ||
262 | .iter() | ||
263 | .map(|&it| &tree.links[it]) | ||
264 | .find(|it| it.name == name)?; | ||
265 | Some(*link.points_to.first()?) | ||
266 | } | ||
267 | fn children<'a>(self, tree: &'a ModuleTree) -> impl Iterator<Item = (SmolStr, ModuleId)> + 'a { | ||
268 | tree.mods[self].children.iter().filter_map(move |&it| { | ||
269 | let link = &tree.links[it]; | ||
270 | let module = *link.points_to.first()?; | ||
271 | Some((link.name.clone(), module)) | ||
272 | }) | ||
273 | } | ||
274 | fn problems(self, tree: &ModuleTree, db: &impl HirDatabase) -> Vec<(SyntaxNode, Problem)> { | ||
275 | tree.mods[self] | ||
276 | .children | ||
277 | .iter() | ||
278 | .filter_map(|&it| { | ||
279 | let p = tree.links[it].problem.clone()?; | ||
280 | let s = it.bind_source(tree, db); | ||
281 | let s = s.borrowed().name().unwrap().syntax().owned(); | ||
282 | Some((s, p)) | ||
283 | }) | ||
284 | .collect() | ||
285 | } | ||
286 | } | ||
287 | |||
288 | impl LinkId { | ||
289 | fn owner(self, tree: &ModuleTree) -> ModuleId { | ||
290 | tree.links[self].owner | ||
291 | } | ||
292 | fn name(self, tree: &ModuleTree) -> SmolStr { | ||
293 | tree.links[self].name.clone() | ||
294 | } | ||
295 | fn bind_source<'a>(self, tree: &ModuleTree, db: &impl HirDatabase) -> ast::ModuleNode { | ||
296 | let owner = self.owner(tree); | ||
297 | match owner.source(tree).resolve(db) { | ||
298 | ModuleSourceNode::SourceFile(root) => { | ||
299 | let ast = imp::modules(root.borrowed()) | ||
300 | .find(|(name, _)| name == &tree.links[self].name) | ||
301 | .unwrap() | ||
302 | .1; | ||
303 | ast.owned() | ||
304 | } | ||
305 | ModuleSourceNode::Module(it) => it, | ||
306 | } | ||
307 | } | ||
308 | } | ||
309 | |||
310 | #[derive(Debug, PartialEq, Eq, Hash)] | ||
311 | pub(crate) struct ModuleData { | ||
312 | source: ModuleSource, | ||
313 | parent: Option<LinkId>, | ||
314 | children: Vec<LinkId>, | ||
315 | } | ||
316 | |||
317 | impl ModuleSource { | ||
318 | pub(crate) fn new_inline( | ||
319 | db: &impl HirDatabase, | ||
320 | file_id: FileId, | ||
321 | module: ast::Module, | ||
322 | ) -> ModuleSource { | ||
323 | assert!(!module.has_semi()); | ||
324 | let items = db.file_items(file_id); | ||
325 | let item_id = items.id_of(module.syntax()); | ||
326 | let id = SourceItemId { file_id, item_id }; | ||
327 | ModuleSource::Module(id) | ||
328 | } | ||
329 | |||
330 | pub(crate) fn as_file(self) -> Option<FileId> { | ||
331 | match self { | ||
332 | ModuleSource::SourceFile(f) => Some(f), | ||
333 | ModuleSource::Module(..) => None, | ||
334 | } | ||
335 | } | ||
336 | |||
337 | pub(crate) fn file_id(self) -> FileId { | ||
338 | match self { | ||
339 | ModuleSource::SourceFile(f) => f, | ||
340 | ModuleSource::Module(source_item_id) => source_item_id.file_id, | ||
341 | } | ||
342 | } | ||
343 | |||
344 | pub(crate) fn resolve(self, db: &impl HirDatabase) -> ModuleSourceNode { | ||
345 | match self { | ||
346 | ModuleSource::SourceFile(file_id) => { | ||
347 | let syntax = db.source_file(file_id); | ||
348 | ModuleSourceNode::SourceFile(syntax.ast().owned()) | ||
349 | } | ||
350 | ModuleSource::Module(item_id) => { | ||
351 | let syntax = db.file_item(item_id); | ||
352 | let syntax = syntax.borrowed(); | ||
353 | let module = ast::Module::cast(syntax).unwrap(); | ||
354 | ModuleSourceNode::Module(module.owned()) | ||
355 | } | ||
356 | } | ||
357 | } | ||
358 | } | ||
359 | |||
360 | #[derive(Hash, Debug, PartialEq, Eq)] | ||
361 | struct LinkData { | ||
362 | owner: ModuleId, | ||
363 | name: SmolStr, | ||
364 | points_to: Vec<ModuleId>, | ||
365 | problem: Option<Problem>, | ||
366 | } | ||
367 | |||
368 | impl ModuleTree { | ||
369 | fn push_mod(&mut self, data: ModuleData) -> ModuleId { | ||
370 | self.mods.alloc(data) | ||
371 | } | ||
372 | fn push_link(&mut self, data: LinkData) -> LinkId { | ||
373 | let owner = data.owner; | ||
374 | let id = self.links.alloc(data); | ||
375 | self.mods[owner].children.push(id); | ||
376 | id | ||
377 | } | ||
378 | } | ||
diff --git a/crates/ra_hir/src/module/nameres.rs b/crates/ra_hir/src/module/nameres.rs new file mode 100644 index 000000000..513a37646 --- /dev/null +++ b/crates/ra_hir/src/module/nameres.rs | |||
@@ -0,0 +1,444 @@ | |||
1 | //! Name resolution algorithm. The end result of the algorithm is `ItemMap`: a | ||
2 | //! map with maps each module to it's scope: the set of items, visible in the | ||
3 | //! module. That is, we only resolve imports here, name resolution of item | ||
4 | //! bodies will be done in a separate step. | ||
5 | //! | ||
6 | //! Like Rustc, we use an interative per-crate algorithm: we start with scopes | ||
7 | //! containing only directly defined items, and then iteratively resolve | ||
8 | //! imports. | ||
9 | //! | ||
10 | //! To make this work nicely in the IDE scenarios, we place `InputModuleItems` | ||
11 | //! in between raw syntax and name resolution. `InputModuleItems` are computed | ||
12 | //! using only the module's syntax, and it is all directly defined items plus | ||
13 | //! imports. The plain is to make `InputModuleItems` independent of local | ||
14 | //! modifications (that is, typing inside a function shold not change IMIs), | ||
15 | //! such that the results of name resolution can be preserved unless the module | ||
16 | //! structure itself is modified. | ||
17 | use std::{ | ||
18 | sync::Arc, | ||
19 | }; | ||
20 | |||
21 | use rustc_hash::FxHashMap; | ||
22 | use ra_syntax::{ | ||
23 | TextRange, | ||
24 | SmolStr, SyntaxKind::{self, *}, | ||
25 | ast::{self, AstNode} | ||
26 | }; | ||
27 | use ra_db::SourceRootId; | ||
28 | |||
29 | use crate::{ | ||
30 | Cancelable, FileId, | ||
31 | DefId, DefLoc, | ||
32 | SourceItemId, SourceFileItemId, SourceFileItems, | ||
33 | Path, PathKind, | ||
34 | HirDatabase, | ||
35 | module::{ModuleId, ModuleTree}, | ||
36 | }; | ||
37 | |||
38 | /// Item map is the result of the name resolution. Item map contains, for each | ||
39 | /// module, the set of visible items. | ||
40 | #[derive(Default, Debug, PartialEq, Eq)] | ||
41 | pub(crate) struct ItemMap { | ||
42 | pub(crate) per_module: FxHashMap<ModuleId, ModuleScope>, | ||
43 | } | ||
44 | |||
45 | #[derive(Debug, Default, PartialEq, Eq, Clone)] | ||
46 | pub(crate) struct ModuleScope { | ||
47 | items: FxHashMap<SmolStr, Resolution>, | ||
48 | } | ||
49 | |||
50 | impl ModuleScope { | ||
51 | pub(crate) fn entries<'a>(&'a self) -> impl Iterator<Item = (&'a SmolStr, &Resolution)> + 'a { | ||
52 | self.items.iter() | ||
53 | } | ||
54 | pub(crate) fn get(&self, name: &SmolStr) -> Option<&Resolution> { | ||
55 | self.items.get(name) | ||
56 | } | ||
57 | } | ||
58 | |||
59 | /// A set of items and imports declared inside a module, without relation to | ||
60 | /// other modules. | ||
61 | /// | ||
62 | /// This stands in-between raw syntax and name resolution and alow us to avoid | ||
63 | /// recomputing name res: if `InputModuleItems` are the same, we can avoid | ||
64 | /// running name resolution. | ||
65 | #[derive(Debug, Default, PartialEq, Eq)] | ||
66 | pub(crate) struct InputModuleItems { | ||
67 | items: Vec<ModuleItem>, | ||
68 | imports: Vec<Import>, | ||
69 | } | ||
70 | |||
71 | #[derive(Debug, PartialEq, Eq)] | ||
72 | struct ModuleItem { | ||
73 | id: SourceFileItemId, | ||
74 | name: SmolStr, | ||
75 | kind: SyntaxKind, | ||
76 | vis: Vis, | ||
77 | } | ||
78 | |||
79 | #[derive(Debug, PartialEq, Eq)] | ||
80 | enum Vis { | ||
81 | // Priv, | ||
82 | Other, | ||
83 | } | ||
84 | |||
85 | #[derive(Debug, Clone, PartialEq, Eq)] | ||
86 | struct Import { | ||
87 | path: Path, | ||
88 | kind: ImportKind, | ||
89 | } | ||
90 | |||
91 | #[derive(Debug, Clone, Copy, PartialEq, Eq)] | ||
92 | pub(crate) struct NamedImport { | ||
93 | file_item_id: SourceFileItemId, | ||
94 | relative_range: TextRange, | ||
95 | } | ||
96 | |||
97 | impl NamedImport { | ||
98 | pub(crate) fn range(&self, db: &impl HirDatabase, file_id: FileId) -> TextRange { | ||
99 | let source_item_id = SourceItemId { | ||
100 | file_id, | ||
101 | item_id: self.file_item_id, | ||
102 | }; | ||
103 | let syntax = db.file_item(source_item_id); | ||
104 | let offset = syntax.borrowed().range().start(); | ||
105 | self.relative_range + offset | ||
106 | } | ||
107 | } | ||
108 | |||
109 | #[derive(Debug, Clone, PartialEq, Eq)] | ||
110 | enum ImportKind { | ||
111 | Glob, | ||
112 | Named(NamedImport), | ||
113 | } | ||
114 | |||
115 | /// Resolution is basically `DefId` atm, but it should account for stuff like | ||
116 | /// multiple namespaces, ambiguity and errors. | ||
117 | #[derive(Debug, Clone, PartialEq, Eq)] | ||
118 | pub(crate) struct Resolution { | ||
119 | /// None for unresolved | ||
120 | pub(crate) def_id: Option<DefId>, | ||
121 | /// ident by whitch this is imported into local scope. | ||
122 | pub(crate) import: Option<NamedImport>, | ||
123 | } | ||
124 | |||
125 | // #[derive(Clone, Copy, Debug, PartialEq, Eq, PartialOrd, Ord, Hash)] | ||
126 | // enum Namespace { | ||
127 | // Types, | ||
128 | // Values, | ||
129 | // } | ||
130 | |||
131 | // #[derive(Debug)] | ||
132 | // struct PerNs<T> { | ||
133 | // types: Option<T>, | ||
134 | // values: Option<T>, | ||
135 | // } | ||
136 | |||
137 | impl InputModuleItems { | ||
138 | pub(crate) fn new<'a>( | ||
139 | file_items: &SourceFileItems, | ||
140 | items: impl Iterator<Item = ast::ModuleItem<'a>>, | ||
141 | ) -> InputModuleItems { | ||
142 | let mut res = InputModuleItems::default(); | ||
143 | for item in items { | ||
144 | res.add_item(file_items, item); | ||
145 | } | ||
146 | res | ||
147 | } | ||
148 | |||
149 | fn add_item(&mut self, file_items: &SourceFileItems, item: ast::ModuleItem) -> Option<()> { | ||
150 | match item { | ||
151 | ast::ModuleItem::StructDef(it) => self.items.push(ModuleItem::new(file_items, it)?), | ||
152 | ast::ModuleItem::EnumDef(it) => self.items.push(ModuleItem::new(file_items, it)?), | ||
153 | ast::ModuleItem::FnDef(it) => self.items.push(ModuleItem::new(file_items, it)?), | ||
154 | ast::ModuleItem::TraitDef(it) => self.items.push(ModuleItem::new(file_items, it)?), | ||
155 | ast::ModuleItem::TypeDef(it) => self.items.push(ModuleItem::new(file_items, it)?), | ||
156 | ast::ModuleItem::ImplItem(_) => { | ||
157 | // impls don't define items | ||
158 | } | ||
159 | ast::ModuleItem::UseItem(it) => self.add_use_item(file_items, it), | ||
160 | ast::ModuleItem::ExternCrateItem(_) => { | ||
161 | // TODO | ||
162 | } | ||
163 | ast::ModuleItem::ConstDef(it) => self.items.push(ModuleItem::new(file_items, it)?), | ||
164 | ast::ModuleItem::StaticDef(it) => self.items.push(ModuleItem::new(file_items, it)?), | ||
165 | ast::ModuleItem::Module(it) => self.items.push(ModuleItem::new(file_items, it)?), | ||
166 | } | ||
167 | Some(()) | ||
168 | } | ||
169 | |||
170 | fn add_use_item(&mut self, file_items: &SourceFileItems, item: ast::UseItem) { | ||
171 | let file_item_id = file_items.id_of(item.syntax()); | ||
172 | let start_offset = item.syntax().range().start(); | ||
173 | Path::expand_use_item(item, |path, range| { | ||
174 | let kind = match range { | ||
175 | None => ImportKind::Glob, | ||
176 | Some(range) => ImportKind::Named(NamedImport { | ||
177 | file_item_id, | ||
178 | relative_range: range - start_offset, | ||
179 | }), | ||
180 | }; | ||
181 | self.imports.push(Import { kind, path }) | ||
182 | }) | ||
183 | } | ||
184 | } | ||
185 | |||
186 | impl ModuleItem { | ||
187 | fn new<'a>(file_items: &SourceFileItems, item: impl ast::NameOwner<'a>) -> Option<ModuleItem> { | ||
188 | let name = item.name()?.text(); | ||
189 | let kind = item.syntax().kind(); | ||
190 | let vis = Vis::Other; | ||
191 | let id = file_items.id_of(item.syntax()); | ||
192 | let res = ModuleItem { | ||
193 | id, | ||
194 | name, | ||
195 | kind, | ||
196 | vis, | ||
197 | }; | ||
198 | Some(res) | ||
199 | } | ||
200 | } | ||
201 | |||
202 | pub(crate) struct Resolver<'a, DB> { | ||
203 | pub db: &'a DB, | ||
204 | pub input: &'a FxHashMap<ModuleId, Arc<InputModuleItems>>, | ||
205 | pub source_root: SourceRootId, | ||
206 | pub module_tree: Arc<ModuleTree>, | ||
207 | pub result: ItemMap, | ||
208 | } | ||
209 | |||
210 | impl<'a, DB> Resolver<'a, DB> | ||
211 | where | ||
212 | DB: HirDatabase, | ||
213 | { | ||
214 | pub(crate) fn resolve(mut self) -> Cancelable<ItemMap> { | ||
215 | for (&module_id, items) in self.input.iter() { | ||
216 | self.populate_module(module_id, items) | ||
217 | } | ||
218 | |||
219 | for &module_id in self.input.keys() { | ||
220 | self.db.check_canceled()?; | ||
221 | self.resolve_imports(module_id); | ||
222 | } | ||
223 | Ok(self.result) | ||
224 | } | ||
225 | |||
226 | fn populate_module(&mut self, module_id: ModuleId, input: &InputModuleItems) { | ||
227 | let file_id = module_id.source(&self.module_tree).file_id(); | ||
228 | |||
229 | let mut module_items = ModuleScope::default(); | ||
230 | |||
231 | for import in input.imports.iter() { | ||
232 | if let Some(name) = import.path.segments.iter().last() { | ||
233 | if let ImportKind::Named(import) = import.kind { | ||
234 | module_items.items.insert( | ||
235 | name.clone(), | ||
236 | Resolution { | ||
237 | def_id: None, | ||
238 | import: Some(import), | ||
239 | }, | ||
240 | ); | ||
241 | } | ||
242 | } | ||
243 | } | ||
244 | |||
245 | for item in input.items.iter() { | ||
246 | if item.kind == MODULE { | ||
247 | // handle submodules separatelly | ||
248 | continue; | ||
249 | } | ||
250 | let def_loc = DefLoc::Item { | ||
251 | source_item_id: SourceItemId { | ||
252 | file_id, | ||
253 | item_id: item.id, | ||
254 | }, | ||
255 | }; | ||
256 | let def_id = def_loc.id(self.db); | ||
257 | let resolution = Resolution { | ||
258 | def_id: Some(def_id), | ||
259 | import: None, | ||
260 | }; | ||
261 | module_items.items.insert(item.name.clone(), resolution); | ||
262 | } | ||
263 | |||
264 | for (name, mod_id) in module_id.children(&self.module_tree) { | ||
265 | let def_loc = DefLoc::Module { | ||
266 | id: mod_id, | ||
267 | source_root: self.source_root, | ||
268 | }; | ||
269 | let def_id = def_loc.id(self.db); | ||
270 | let resolution = Resolution { | ||
271 | def_id: Some(def_id), | ||
272 | import: None, | ||
273 | }; | ||
274 | module_items.items.insert(name, resolution); | ||
275 | } | ||
276 | |||
277 | self.result.per_module.insert(module_id, module_items); | ||
278 | } | ||
279 | |||
280 | fn resolve_imports(&mut self, module_id: ModuleId) { | ||
281 | for import in self.input[&module_id].imports.iter() { | ||
282 | self.resolve_import(module_id, import); | ||
283 | } | ||
284 | } | ||
285 | |||
286 | fn resolve_import(&mut self, module_id: ModuleId, import: &Import) { | ||
287 | let ptr = match import.kind { | ||
288 | ImportKind::Glob => return, | ||
289 | ImportKind::Named(ptr) => ptr, | ||
290 | }; | ||
291 | |||
292 | let mut curr = match import.path.kind { | ||
293 | // TODO: handle extern crates | ||
294 | PathKind::Plain => return, | ||
295 | PathKind::Self_ => module_id, | ||
296 | PathKind::Super => { | ||
297 | match module_id.parent(&self.module_tree) { | ||
298 | Some(it) => it, | ||
299 | // TODO: error | ||
300 | None => return, | ||
301 | } | ||
302 | } | ||
303 | PathKind::Crate => module_id.crate_root(&self.module_tree), | ||
304 | }; | ||
305 | |||
306 | for (i, name) in import.path.segments.iter().enumerate() { | ||
307 | let is_last = i == import.path.segments.len() - 1; | ||
308 | |||
309 | let def_id = match self.result.per_module[&curr].items.get(name) { | ||
310 | None => return, | ||
311 | Some(res) => match res.def_id { | ||
312 | Some(it) => it, | ||
313 | None => return, | ||
314 | }, | ||
315 | }; | ||
316 | |||
317 | if !is_last { | ||
318 | curr = match def_id.loc(self.db) { | ||
319 | DefLoc::Module { id, .. } => id, | ||
320 | _ => return, | ||
321 | } | ||
322 | } else { | ||
323 | self.update(module_id, |items| { | ||
324 | let res = Resolution { | ||
325 | def_id: Some(def_id), | ||
326 | import: Some(ptr), | ||
327 | }; | ||
328 | items.items.insert(name.clone(), res); | ||
329 | }) | ||
330 | } | ||
331 | } | ||
332 | } | ||
333 | |||
334 | fn update(&mut self, module_id: ModuleId, f: impl FnOnce(&mut ModuleScope)) { | ||
335 | let module_items = self.result.per_module.get_mut(&module_id).unwrap(); | ||
336 | f(module_items) | ||
337 | } | ||
338 | } | ||
339 | |||
340 | #[cfg(test)] | ||
341 | mod tests { | ||
342 | use ra_db::FilesDatabase; | ||
343 | use crate::{ | ||
344 | AnalysisChange, | ||
345 | mock_analysis::{MockAnalysis, analysis_and_position}, | ||
346 | hir::{self, HirDatabase}, | ||
347 | }; | ||
348 | use super::*; | ||
349 | |||
350 | fn item_map(fixture: &str) -> (Arc<ItemMap>, ModuleId) { | ||
351 | let (analysis, pos) = analysis_and_position(fixture); | ||
352 | let db = analysis.imp.db; | ||
353 | let source_root = db.file_source_root(pos.file_id); | ||
354 | let descr = hir::Module::guess_from_position(&*db, pos) | ||
355 | .unwrap() | ||
356 | .unwrap(); | ||
357 | let module_id = descr.module_id; | ||
358 | (db.item_map(source_root).unwrap(), module_id) | ||
359 | } | ||
360 | |||
361 | #[test] | ||
362 | fn test_item_map() { | ||
363 | let (item_map, module_id) = item_map( | ||
364 | " | ||
365 | //- /lib.rs | ||
366 | mod foo; | ||
367 | |||
368 | use crate::foo::bar::Baz; | ||
369 | <|> | ||
370 | |||
371 | //- /foo/mod.rs | ||
372 | pub mod bar; | ||
373 | |||
374 | //- /foo/bar.rs | ||
375 | pub struct Baz; | ||
376 | ", | ||
377 | ); | ||
378 | let name = SmolStr::from("Baz"); | ||
379 | let resolution = &item_map.per_module[&module_id].items[&name]; | ||
380 | assert!(resolution.def_id.is_some()); | ||
381 | } | ||
382 | |||
383 | #[test] | ||
384 | fn typing_inside_a_function_should_not_invalidate_item_map() { | ||
385 | let mock_analysis = MockAnalysis::with_files( | ||
386 | " | ||
387 | //- /lib.rs | ||
388 | mod foo; | ||
389 | |||
390 | use crate::foo::bar::Baz; | ||
391 | |||
392 | fn foo() -> i32 { | ||
393 | 1 + 1 | ||
394 | } | ||
395 | //- /foo/mod.rs | ||
396 | pub mod bar; | ||
397 | |||
398 | //- /foo/bar.rs | ||
399 | pub struct Baz; | ||
400 | ", | ||
401 | ); | ||
402 | |||
403 | let file_id = mock_analysis.id_of("/lib.rs"); | ||
404 | let mut host = mock_analysis.analysis_host(); | ||
405 | |||
406 | let source_root = host.analysis().imp.db.file_source_root(file_id); | ||
407 | |||
408 | { | ||
409 | let db = host.analysis().imp.db; | ||
410 | let events = db.log_executed(|| { | ||
411 | db.item_map(source_root).unwrap(); | ||
412 | }); | ||
413 | assert!(format!("{:?}", events).contains("item_map")) | ||
414 | } | ||
415 | |||
416 | let mut change = AnalysisChange::new(); | ||
417 | |||
418 | change.change_file( | ||
419 | file_id, | ||
420 | " | ||
421 | mod foo; | ||
422 | |||
423 | use crate::foo::bar::Baz; | ||
424 | |||
425 | fn foo() -> i32 { 92 } | ||
426 | " | ||
427 | .to_string(), | ||
428 | ); | ||
429 | |||
430 | host.apply_change(change); | ||
431 | |||
432 | { | ||
433 | let db = host.analysis().imp.db; | ||
434 | let events = db.log_executed(|| { | ||
435 | db.item_map(source_root).unwrap(); | ||
436 | }); | ||
437 | assert!( | ||
438 | !format!("{:?}", events).contains("_item_map"), | ||
439 | "{:#?}", | ||
440 | events | ||
441 | ) | ||
442 | } | ||
443 | } | ||
444 | } | ||
diff --git a/crates/ra_hir/src/path.rs b/crates/ra_hir/src/path.rs new file mode 100644 index 000000000..8279daf4b --- /dev/null +++ b/crates/ra_hir/src/path.rs | |||
@@ -0,0 +1,148 @@ | |||
1 | use ra_syntax::{SmolStr, ast, AstNode, TextRange}; | ||
2 | |||
3 | #[derive(Debug, Clone, PartialEq, Eq)] | ||
4 | pub(crate) struct Path { | ||
5 | pub(crate) kind: PathKind, | ||
6 | pub(crate) segments: Vec<SmolStr>, | ||
7 | } | ||
8 | |||
9 | #[derive(Debug, Clone, Copy, PartialEq, Eq)] | ||
10 | pub(crate) enum PathKind { | ||
11 | Plain, | ||
12 | Self_, | ||
13 | Super, | ||
14 | Crate, | ||
15 | } | ||
16 | |||
17 | impl Path { | ||
18 | /// Calls `cb` with all paths, represented by this use item. | ||
19 | pub(crate) fn expand_use_item(item: ast::UseItem, mut cb: impl FnMut(Path, Option<TextRange>)) { | ||
20 | if let Some(tree) = item.use_tree() { | ||
21 | expand_use_tree(None, tree, &mut cb); | ||
22 | } | ||
23 | } | ||
24 | |||
25 | /// Converts an `ast::Path` to `Path`. Works with use trees. | ||
26 | pub(crate) fn from_ast(mut path: ast::Path) -> Option<Path> { | ||
27 | let mut kind = PathKind::Plain; | ||
28 | let mut segments = Vec::new(); | ||
29 | loop { | ||
30 | let segment = path.segment()?; | ||
31 | match segment.kind()? { | ||
32 | ast::PathSegmentKind::Name(name) => segments.push(name.text()), | ||
33 | ast::PathSegmentKind::CrateKw => { | ||
34 | kind = PathKind::Crate; | ||
35 | break; | ||
36 | } | ||
37 | ast::PathSegmentKind::SelfKw => { | ||
38 | kind = PathKind::Self_; | ||
39 | break; | ||
40 | } | ||
41 | ast::PathSegmentKind::SuperKw => { | ||
42 | kind = PathKind::Super; | ||
43 | break; | ||
44 | } | ||
45 | } | ||
46 | path = match qualifier(path) { | ||
47 | Some(it) => it, | ||
48 | None => break, | ||
49 | }; | ||
50 | } | ||
51 | segments.reverse(); | ||
52 | return Some(Path { kind, segments }); | ||
53 | |||
54 | fn qualifier(path: ast::Path) -> Option<ast::Path> { | ||
55 | if let Some(q) = path.qualifier() { | ||
56 | return Some(q); | ||
57 | } | ||
58 | // TODO: this bottom up traversal is not too precise. | ||
59 | // Should we handle do a top-down analysiss, recording results? | ||
60 | let use_tree_list = path.syntax().ancestors().find_map(ast::UseTreeList::cast)?; | ||
61 | let use_tree = use_tree_list.parent_use_tree(); | ||
62 | use_tree.path() | ||
63 | } | ||
64 | } | ||
65 | |||
66 | /// `true` is this path is a single identifier, like `foo` | ||
67 | pub(crate) fn is_ident(&self) -> bool { | ||
68 | self.kind == PathKind::Plain && self.segments.len() == 1 | ||
69 | } | ||
70 | } | ||
71 | |||
72 | fn expand_use_tree( | ||
73 | prefix: Option<Path>, | ||
74 | tree: ast::UseTree, | ||
75 | cb: &mut impl FnMut(Path, Option<TextRange>), | ||
76 | ) { | ||
77 | if let Some(use_tree_list) = tree.use_tree_list() { | ||
78 | let prefix = match tree.path() { | ||
79 | None => prefix, | ||
80 | Some(path) => match convert_path(prefix, path) { | ||
81 | Some(it) => Some(it), | ||
82 | None => return, // TODO: report errors somewhere | ||
83 | }, | ||
84 | }; | ||
85 | for tree in use_tree_list.use_trees() { | ||
86 | expand_use_tree(prefix.clone(), tree, cb); | ||
87 | } | ||
88 | } else { | ||
89 | if let Some(ast_path) = tree.path() { | ||
90 | if let Some(path) = convert_path(prefix, ast_path) { | ||
91 | let range = if tree.has_star() { | ||
92 | None | ||
93 | } else { | ||
94 | let range = ast_path.segment().unwrap().syntax().range(); | ||
95 | Some(range) | ||
96 | }; | ||
97 | cb(path, range) | ||
98 | } | ||
99 | } | ||
100 | } | ||
101 | } | ||
102 | |||
103 | fn convert_path(prefix: Option<Path>, path: ast::Path) -> Option<Path> { | ||
104 | let prefix = if let Some(qual) = path.qualifier() { | ||
105 | Some(convert_path(prefix, qual)?) | ||
106 | } else { | ||
107 | None | ||
108 | }; | ||
109 | let segment = path.segment()?; | ||
110 | let res = match segment.kind()? { | ||
111 | ast::PathSegmentKind::Name(name) => { | ||
112 | let mut res = prefix.unwrap_or_else(|| Path { | ||
113 | kind: PathKind::Plain, | ||
114 | segments: Vec::with_capacity(1), | ||
115 | }); | ||
116 | res.segments.push(name.text()); | ||
117 | res | ||
118 | } | ||
119 | ast::PathSegmentKind::CrateKw => { | ||
120 | if prefix.is_some() { | ||
121 | return None; | ||
122 | } | ||
123 | Path { | ||
124 | kind: PathKind::Crate, | ||
125 | segments: Vec::new(), | ||
126 | } | ||
127 | } | ||
128 | ast::PathSegmentKind::SelfKw => { | ||
129 | if prefix.is_some() { | ||
130 | return None; | ||
131 | } | ||
132 | Path { | ||
133 | kind: PathKind::Self_, | ||
134 | segments: Vec::new(), | ||
135 | } | ||
136 | } | ||
137 | ast::PathSegmentKind::SuperKw => { | ||
138 | if prefix.is_some() { | ||
139 | return None; | ||
140 | } | ||
141 | Path { | ||
142 | kind: PathKind::Super, | ||
143 | segments: Vec::new(), | ||
144 | } | ||
145 | } | ||
146 | }; | ||
147 | Some(res) | ||
148 | } | ||
diff --git a/crates/ra_hir/src/query_definitions.rs b/crates/ra_hir/src/query_definitions.rs new file mode 100644 index 000000000..6f602878c --- /dev/null +++ b/crates/ra_hir/src/query_definitions.rs | |||
@@ -0,0 +1,154 @@ | |||
1 | use std::{ | ||
2 | sync::Arc, | ||
3 | time::Instant, | ||
4 | }; | ||
5 | |||
6 | use rustc_hash::FxHashMap; | ||
7 | use ra_syntax::{ | ||
8 | AstNode, SyntaxNode, SmolStr, | ||
9 | ast::{self, FnDef, FnDefNode, NameOwner, ModuleItemOwner} | ||
10 | }; | ||
11 | use ra_db::{SourceRootId, FileId, Cancelable,}; | ||
12 | |||
13 | use crate::{ | ||
14 | FnId, | ||
15 | SourceFileItems, SourceItemId, | ||
16 | db::HirDatabase, | ||
17 | function::FnScopes, | ||
18 | module::{ | ||
19 | ModuleSource, ModuleSourceNode, ModuleId, | ||
20 | imp::Submodule, | ||
21 | nameres::{InputModuleItems, ItemMap, Resolver}, | ||
22 | }, | ||
23 | }; | ||
24 | |||
25 | /// Resolve `FnId` to the corresponding `SyntaxNode` | ||
26 | pub(super) fn fn_syntax(db: &impl HirDatabase, fn_id: FnId) -> FnDefNode { | ||
27 | let item_id = fn_id.loc(db); | ||
28 | let syntax = db.file_item(item_id); | ||
29 | FnDef::cast(syntax.borrowed()).unwrap().owned() | ||
30 | } | ||
31 | |||
32 | pub(super) fn fn_scopes(db: &impl HirDatabase, fn_id: FnId) -> Arc<FnScopes> { | ||
33 | let syntax = db.fn_syntax(fn_id); | ||
34 | let res = FnScopes::new(syntax.borrowed()); | ||
35 | Arc::new(res) | ||
36 | } | ||
37 | |||
38 | pub(super) fn file_items(db: &impl HirDatabase, file_id: FileId) -> Arc<SourceFileItems> { | ||
39 | let source_file = db.source_file(file_id); | ||
40 | let source_file = source_file.borrowed(); | ||
41 | let mut res = SourceFileItems::default(); | ||
42 | source_file | ||
43 | .syntax() | ||
44 | .descendants() | ||
45 | .filter_map(ast::ModuleItem::cast) | ||
46 | .map(|it| it.syntax().owned()) | ||
47 | .for_each(|it| { | ||
48 | res.alloc(it); | ||
49 | }); | ||
50 | Arc::new(res) | ||
51 | } | ||
52 | |||
53 | pub(super) fn file_item(db: &impl HirDatabase, source_item_id: SourceItemId) -> SyntaxNode { | ||
54 | db.file_items(source_item_id.file_id)[source_item_id.item_id].clone() | ||
55 | } | ||
56 | |||
57 | pub(crate) fn submodules( | ||
58 | db: &impl HirDatabase, | ||
59 | source: ModuleSource, | ||
60 | ) -> Cancelable<Arc<Vec<Submodule>>> { | ||
61 | db.check_canceled()?; | ||
62 | let file_id = source.file_id(); | ||
63 | let submodules = match source.resolve(db) { | ||
64 | ModuleSourceNode::SourceFile(it) => collect_submodules(db, file_id, it.borrowed()), | ||
65 | ModuleSourceNode::Module(it) => it | ||
66 | .borrowed() | ||
67 | .item_list() | ||
68 | .map(|it| collect_submodules(db, file_id, it)) | ||
69 | .unwrap_or_else(Vec::new), | ||
70 | }; | ||
71 | return Ok(Arc::new(submodules)); | ||
72 | |||
73 | fn collect_submodules<'a>( | ||
74 | db: &impl HirDatabase, | ||
75 | file_id: FileId, | ||
76 | root: impl ast::ModuleItemOwner<'a>, | ||
77 | ) -> Vec<Submodule> { | ||
78 | modules(root) | ||
79 | .map(|(name, m)| { | ||
80 | if m.has_semi() { | ||
81 | Submodule::Declaration(name) | ||
82 | } else { | ||
83 | let src = ModuleSource::new_inline(db, file_id, m); | ||
84 | Submodule::Definition(name, src) | ||
85 | } | ||
86 | }) | ||
87 | .collect() | ||
88 | } | ||
89 | } | ||
90 | |||
91 | pub(crate) fn modules<'a>( | ||
92 | root: impl ast::ModuleItemOwner<'a>, | ||
93 | ) -> impl Iterator<Item = (SmolStr, ast::Module<'a>)> { | ||
94 | root.items() | ||
95 | .filter_map(|item| match item { | ||
96 | ast::ModuleItem::Module(m) => Some(m), | ||
97 | _ => None, | ||
98 | }) | ||
99 | .filter_map(|module| { | ||
100 | let name = module.name()?.text(); | ||
101 | Some((name, module)) | ||
102 | }) | ||
103 | } | ||
104 | |||
105 | pub(super) fn input_module_items( | ||
106 | db: &impl HirDatabase, | ||
107 | source_root: SourceRootId, | ||
108 | module_id: ModuleId, | ||
109 | ) -> Cancelable<Arc<InputModuleItems>> { | ||
110 | let module_tree = db.module_tree(source_root)?; | ||
111 | let source = module_id.source(&module_tree); | ||
112 | let file_items = db.file_items(source.file_id()); | ||
113 | let res = match source.resolve(db) { | ||
114 | ModuleSourceNode::SourceFile(it) => { | ||
115 | let items = it.borrowed().items(); | ||
116 | InputModuleItems::new(&file_items, items) | ||
117 | } | ||
118 | ModuleSourceNode::Module(it) => { | ||
119 | let items = it | ||
120 | .borrowed() | ||
121 | .item_list() | ||
122 | .into_iter() | ||
123 | .flat_map(|it| it.items()); | ||
124 | InputModuleItems::new(&file_items, items) | ||
125 | } | ||
126 | }; | ||
127 | Ok(Arc::new(res)) | ||
128 | } | ||
129 | |||
130 | pub(super) fn item_map( | ||
131 | db: &impl HirDatabase, | ||
132 | source_root: SourceRootId, | ||
133 | ) -> Cancelable<Arc<ItemMap>> { | ||
134 | let start = Instant::now(); | ||
135 | let module_tree = db.module_tree(source_root)?; | ||
136 | let input = module_tree | ||
137 | .modules() | ||
138 | .map(|id| { | ||
139 | let items = db.input_module_items(source_root, id)?; | ||
140 | Ok((id, items)) | ||
141 | }) | ||
142 | .collect::<Cancelable<FxHashMap<_, _>>>()?; | ||
143 | let resolver = Resolver { | ||
144 | db: db, | ||
145 | input: &input, | ||
146 | source_root, | ||
147 | module_tree, | ||
148 | result: ItemMap::default(), | ||
149 | }; | ||
150 | let res = resolver.resolve()?; | ||
151 | let elapsed = start.elapsed(); | ||
152 | log::info!("item_map: {:?}", elapsed); | ||
153 | Ok(Arc::new(res)) | ||
154 | } | ||