diff options
author | Seivan Heidari <[email protected]> | 2019-10-31 08:43:20 +0000 |
---|---|---|
committer | Seivan Heidari <[email protected]> | 2019-10-31 08:43:20 +0000 |
commit | 8edda0e7b164009d6c03bb3d4be603fb38ad2e2a (patch) | |
tree | 744cf81075d394e2f9c06afb07642a2601800dda /crates/ra_hir/src/ids.rs | |
parent | 49562d36b97ddde34cf7585a8c2e8f232519b657 (diff) | |
parent | d067afb064a7fa67b172abf561b7d80740cd6f18 (diff) |
Merge branch 'master' into feature/themes
Diffstat (limited to 'crates/ra_hir/src/ids.rs')
-rw-r--r-- | crates/ra_hir/src/ids.rs | 363 |
1 files changed, 13 insertions, 350 deletions
diff --git a/crates/ra_hir/src/ids.rs b/crates/ra_hir/src/ids.rs index 499dcafea..fe083c0c6 100644 --- a/crates/ra_hir/src/ids.rs +++ b/crates/ra_hir/src/ids.rs | |||
@@ -1,168 +1,17 @@ | |||
1 | //! FIXME: write short doc here | 1 | //! hir makes heavy use of ids: integer (u32) handlers to various things. You |
2 | 2 | //! can think of id as a pointer (but without a lifetime) or a file descriptor | |
3 | use std::{ | 3 | //! (but for hir objects). |
4 | hash::{Hash, Hasher}, | 4 | //! |
5 | sync::Arc, | 5 | //! This module defines a bunch of ids we are using. The most important ones are |
6 | }; | 6 | //! probably `HirFileId` and `DefId`. |
7 | 7 | ||
8 | use mbe::MacroRules; | 8 | use ra_db::salsa; |
9 | use ra_db::{salsa, FileId}; | 9 | |
10 | use ra_prof::profile; | 10 | pub use hir_def::{ |
11 | use ra_syntax::{ast, AstNode, Parse, SyntaxNode}; | 11 | AstItemDef, ConstId, EnumId, FunctionId, ItemLoc, LocationCtx, StaticId, StructId, TraitId, |
12 | 12 | TypeAliasId, | |
13 | use crate::{ | ||
14 | db::{AstDatabase, DefDatabase, InternDatabase}, | ||
15 | AstId, Crate, FileAstId, Module, Source, | ||
16 | }; | 13 | }; |
17 | 14 | pub use hir_expand::{HirFileId, MacroCallId, MacroCallLoc, MacroDefId, MacroFile, MacroFileKind}; | |
18 | /// hir makes heavy use of ids: integer (u32) handlers to various things. You | ||
19 | /// can think of id as a pointer (but without a lifetime) or a file descriptor | ||
20 | /// (but for hir objects). | ||
21 | /// | ||
22 | /// This module defines a bunch of ids we are using. The most important ones are | ||
23 | /// probably `HirFileId` and `DefId`. | ||
24 | |||
25 | /// Input to the analyzer is a set of files, where each file is identified by | ||
26 | /// `FileId` and contains source code. However, another source of source code in | ||
27 | /// Rust are macros: each macro can be thought of as producing a "temporary | ||
28 | /// file". To assign an id to such a file, we use the id of the macro call that | ||
29 | /// produced the file. So, a `HirFileId` is either a `FileId` (source code | ||
30 | /// written by user), or a `MacroCallId` (source code produced by macro). | ||
31 | /// | ||
32 | /// What is a `MacroCallId`? Simplifying, it's a `HirFileId` of a file | ||
33 | /// containing the call plus the offset of the macro call in the file. Note that | ||
34 | /// this is a recursive definition! However, the size_of of `HirFileId` is | ||
35 | /// finite (because everything bottoms out at the real `FileId`) and small | ||
36 | /// (`MacroCallId` uses the location interner). | ||
37 | #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)] | ||
38 | pub struct HirFileId(HirFileIdRepr); | ||
39 | |||
40 | impl HirFileId { | ||
41 | /// For macro-expansion files, returns the file original source file the | ||
42 | /// expansion originated from. | ||
43 | pub fn original_file(self, db: &impl InternDatabase) -> FileId { | ||
44 | match self.0 { | ||
45 | HirFileIdRepr::File(file_id) => file_id, | ||
46 | HirFileIdRepr::Macro(macro_file) => { | ||
47 | let loc = macro_file.macro_call_id.loc(db); | ||
48 | loc.ast_id.file_id().original_file(db) | ||
49 | } | ||
50 | } | ||
51 | } | ||
52 | |||
53 | /// Get the crate which the macro lives in, if it is a macro file. | ||
54 | pub(crate) fn macro_crate(self, db: &impl AstDatabase) -> Option<Crate> { | ||
55 | match self.0 { | ||
56 | HirFileIdRepr::File(_) => None, | ||
57 | HirFileIdRepr::Macro(macro_file) => { | ||
58 | let loc = macro_file.macro_call_id.loc(db); | ||
59 | Some(loc.def.krate) | ||
60 | } | ||
61 | } | ||
62 | } | ||
63 | |||
64 | pub(crate) fn parse_or_expand_query( | ||
65 | db: &impl AstDatabase, | ||
66 | file_id: HirFileId, | ||
67 | ) -> Option<SyntaxNode> { | ||
68 | match file_id.0 { | ||
69 | HirFileIdRepr::File(file_id) => Some(db.parse(file_id).tree().syntax().clone()), | ||
70 | HirFileIdRepr::Macro(macro_file) => { | ||
71 | db.parse_macro(macro_file).map(|it| it.syntax_node()) | ||
72 | } | ||
73 | } | ||
74 | } | ||
75 | |||
76 | pub(crate) fn parse_macro_query( | ||
77 | db: &impl AstDatabase, | ||
78 | macro_file: MacroFile, | ||
79 | ) -> Option<Parse<SyntaxNode>> { | ||
80 | let _p = profile("parse_macro_query"); | ||
81 | let macro_call_id = macro_file.macro_call_id; | ||
82 | let tt = db | ||
83 | .macro_expand(macro_call_id) | ||
84 | .map_err(|err| { | ||
85 | // Note: | ||
86 | // The final goal we would like to make all parse_macro success, | ||
87 | // such that the following log will not call anyway. | ||
88 | log::warn!("fail on macro_parse: (reason: {})", err,); | ||
89 | }) | ||
90 | .ok()?; | ||
91 | match macro_file.macro_file_kind { | ||
92 | MacroFileKind::Items => mbe::token_tree_to_items(&tt).ok().map(Parse::to_syntax), | ||
93 | MacroFileKind::Expr => mbe::token_tree_to_expr(&tt).ok().map(Parse::to_syntax), | ||
94 | } | ||
95 | } | ||
96 | } | ||
97 | |||
98 | #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)] | ||
99 | enum HirFileIdRepr { | ||
100 | File(FileId), | ||
101 | Macro(MacroFile), | ||
102 | } | ||
103 | |||
104 | #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)] | ||
105 | pub struct MacroFile { | ||
106 | macro_call_id: MacroCallId, | ||
107 | macro_file_kind: MacroFileKind, | ||
108 | } | ||
109 | |||
110 | #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)] | ||
111 | pub(crate) enum MacroFileKind { | ||
112 | Items, | ||
113 | Expr, | ||
114 | } | ||
115 | |||
116 | impl From<FileId> for HirFileId { | ||
117 | fn from(file_id: FileId) -> HirFileId { | ||
118 | HirFileId(HirFileIdRepr::File(file_id)) | ||
119 | } | ||
120 | } | ||
121 | |||
122 | #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)] | ||
123 | pub struct MacroDefId { | ||
124 | pub(crate) ast_id: AstId<ast::MacroCall>, | ||
125 | pub(crate) krate: Crate, | ||
126 | } | ||
127 | |||
128 | pub(crate) fn macro_def_query(db: &impl AstDatabase, id: MacroDefId) -> Option<Arc<MacroRules>> { | ||
129 | let macro_call = id.ast_id.to_node(db); | ||
130 | let arg = macro_call.token_tree()?; | ||
131 | let (tt, _) = mbe::ast_to_token_tree(&arg).or_else(|| { | ||
132 | log::warn!("fail on macro_def to token tree: {:#?}", arg); | ||
133 | None | ||
134 | })?; | ||
135 | let rules = MacroRules::parse(&tt).ok().or_else(|| { | ||
136 | log::warn!("fail on macro_def parse: {:#?}", tt); | ||
137 | None | ||
138 | })?; | ||
139 | Some(Arc::new(rules)) | ||
140 | } | ||
141 | |||
142 | pub(crate) fn macro_arg_query(db: &impl AstDatabase, id: MacroCallId) -> Option<Arc<tt::Subtree>> { | ||
143 | let loc = id.loc(db); | ||
144 | let macro_call = loc.ast_id.to_node(db); | ||
145 | let arg = macro_call.token_tree()?; | ||
146 | let (tt, _) = mbe::ast_to_token_tree(&arg)?; | ||
147 | Some(Arc::new(tt)) | ||
148 | } | ||
149 | |||
150 | pub(crate) fn macro_expand_query( | ||
151 | db: &impl AstDatabase, | ||
152 | id: MacroCallId, | ||
153 | ) -> Result<Arc<tt::Subtree>, String> { | ||
154 | let loc = id.loc(db); | ||
155 | let macro_arg = db.macro_arg(id).ok_or("Fail to args in to tt::TokenTree")?; | ||
156 | |||
157 | let macro_rules = db.macro_def(loc.def).ok_or("Fail to find macro definition")?; | ||
158 | let tt = macro_rules.expand(¯o_arg).map_err(|err| format!("{:?}", err))?; | ||
159 | // Set a hard limit for the expanded tt | ||
160 | let count = tt.count(); | ||
161 | if count > 65536 { | ||
162 | return Err(format!("Total tokens count exceed limit : count = {}", count)); | ||
163 | } | ||
164 | Ok(Arc::new(tt)) | ||
165 | } | ||
166 | 15 | ||
167 | macro_rules! impl_intern_key { | 16 | macro_rules! impl_intern_key { |
168 | ($name:ident) => { | 17 | ($name:ident) => { |
@@ -177,192 +26,6 @@ macro_rules! impl_intern_key { | |||
177 | }; | 26 | }; |
178 | } | 27 | } |
179 | 28 | ||
180 | /// `MacroCallId` identifies a particular macro invocation, like | ||
181 | /// `println!("Hello, {}", world)`. | ||
182 | #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)] | ||
183 | pub struct MacroCallId(salsa::InternId); | ||
184 | impl_intern_key!(MacroCallId); | ||
185 | |||
186 | #[derive(Debug, Clone, PartialEq, Eq, Hash)] | ||
187 | pub struct MacroCallLoc { | ||
188 | pub(crate) def: MacroDefId, | ||
189 | pub(crate) ast_id: AstId<ast::MacroCall>, | ||
190 | } | ||
191 | |||
192 | impl MacroCallId { | ||
193 | pub(crate) fn loc(self, db: &impl InternDatabase) -> MacroCallLoc { | ||
194 | db.lookup_intern_macro(self) | ||
195 | } | ||
196 | |||
197 | pub(crate) fn as_file(self, kind: MacroFileKind) -> HirFileId { | ||
198 | let macro_file = MacroFile { macro_call_id: self, macro_file_kind: kind }; | ||
199 | HirFileId(HirFileIdRepr::Macro(macro_file)) | ||
200 | } | ||
201 | } | ||
202 | |||
203 | impl MacroCallLoc { | ||
204 | pub(crate) fn id(self, db: &impl InternDatabase) -> MacroCallId { | ||
205 | db.intern_macro(self) | ||
206 | } | ||
207 | } | ||
208 | |||
209 | #[derive(Debug)] | ||
210 | pub struct ItemLoc<N: AstNode> { | ||
211 | pub(crate) module: Module, | ||
212 | ast_id: AstId<N>, | ||
213 | } | ||
214 | |||
215 | impl<N: AstNode> PartialEq for ItemLoc<N> { | ||
216 | fn eq(&self, other: &Self) -> bool { | ||
217 | self.module == other.module && self.ast_id == other.ast_id | ||
218 | } | ||
219 | } | ||
220 | impl<N: AstNode> Eq for ItemLoc<N> {} | ||
221 | impl<N: AstNode> Hash for ItemLoc<N> { | ||
222 | fn hash<H: Hasher>(&self, hasher: &mut H) { | ||
223 | self.module.hash(hasher); | ||
224 | self.ast_id.hash(hasher); | ||
225 | } | ||
226 | } | ||
227 | |||
228 | impl<N: AstNode> Clone for ItemLoc<N> { | ||
229 | fn clone(&self) -> ItemLoc<N> { | ||
230 | ItemLoc { module: self.module, ast_id: self.ast_id } | ||
231 | } | ||
232 | } | ||
233 | |||
234 | #[derive(Clone, Copy)] | ||
235 | pub(crate) struct LocationCtx<DB> { | ||
236 | db: DB, | ||
237 | module: Module, | ||
238 | file_id: HirFileId, | ||
239 | } | ||
240 | |||
241 | impl<'a, DB: DefDatabase> LocationCtx<&'a DB> { | ||
242 | pub(crate) fn new(db: &'a DB, module: Module, file_id: HirFileId) -> LocationCtx<&'a DB> { | ||
243 | LocationCtx { db, module, file_id } | ||
244 | } | ||
245 | } | ||
246 | |||
247 | impl<'a, DB: DefDatabase + AstDatabase> LocationCtx<&'a DB> { | ||
248 | pub(crate) fn to_def<N, DEF>(self, ast: &N) -> DEF | ||
249 | where | ||
250 | N: AstNode, | ||
251 | DEF: AstItemDef<N>, | ||
252 | { | ||
253 | DEF::from_ast(self, ast) | ||
254 | } | ||
255 | } | ||
256 | |||
257 | pub(crate) trait AstItemDef<N: AstNode>: salsa::InternKey + Clone { | ||
258 | fn intern(db: &impl DefDatabase, loc: ItemLoc<N>) -> Self; | ||
259 | fn lookup_intern(self, db: &impl DefDatabase) -> ItemLoc<N>; | ||
260 | |||
261 | fn from_ast(ctx: LocationCtx<&(impl AstDatabase + DefDatabase)>, ast: &N) -> Self { | ||
262 | let items = ctx.db.ast_id_map(ctx.file_id); | ||
263 | let item_id = items.ast_id(ast); | ||
264 | Self::from_ast_id(ctx, item_id) | ||
265 | } | ||
266 | fn from_ast_id(ctx: LocationCtx<&impl DefDatabase>, ast_id: FileAstId<N>) -> Self { | ||
267 | let loc = ItemLoc { module: ctx.module, ast_id: ast_id.with_file_id(ctx.file_id) }; | ||
268 | Self::intern(ctx.db, loc) | ||
269 | } | ||
270 | fn source(self, db: &(impl AstDatabase + DefDatabase)) -> Source<N> { | ||
271 | let loc = self.lookup_intern(db); | ||
272 | let ast = loc.ast_id.to_node(db); | ||
273 | Source { file_id: loc.ast_id.file_id(), ast } | ||
274 | } | ||
275 | fn module(self, db: &impl DefDatabase) -> Module { | ||
276 | let loc = self.lookup_intern(db); | ||
277 | loc.module | ||
278 | } | ||
279 | } | ||
280 | |||
281 | #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)] | ||
282 | pub struct FunctionId(salsa::InternId); | ||
283 | impl_intern_key!(FunctionId); | ||
284 | |||
285 | impl AstItemDef<ast::FnDef> for FunctionId { | ||
286 | fn intern(db: &impl DefDatabase, loc: ItemLoc<ast::FnDef>) -> Self { | ||
287 | db.intern_function(loc) | ||
288 | } | ||
289 | fn lookup_intern(self, db: &impl DefDatabase) -> ItemLoc<ast::FnDef> { | ||
290 | db.lookup_intern_function(self) | ||
291 | } | ||
292 | } | ||
293 | |||
294 | #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)] | ||
295 | pub struct StructId(salsa::InternId); | ||
296 | impl_intern_key!(StructId); | ||
297 | impl AstItemDef<ast::StructDef> for StructId { | ||
298 | fn intern(db: &impl DefDatabase, loc: ItemLoc<ast::StructDef>) -> Self { | ||
299 | db.intern_struct(loc) | ||
300 | } | ||
301 | fn lookup_intern(self, db: &impl DefDatabase) -> ItemLoc<ast::StructDef> { | ||
302 | db.lookup_intern_struct(self) | ||
303 | } | ||
304 | } | ||
305 | |||
306 | #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)] | ||
307 | pub struct EnumId(salsa::InternId); | ||
308 | impl_intern_key!(EnumId); | ||
309 | impl AstItemDef<ast::EnumDef> for EnumId { | ||
310 | fn intern(db: &impl DefDatabase, loc: ItemLoc<ast::EnumDef>) -> Self { | ||
311 | db.intern_enum(loc) | ||
312 | } | ||
313 | fn lookup_intern(self, db: &impl DefDatabase) -> ItemLoc<ast::EnumDef> { | ||
314 | db.lookup_intern_enum(self) | ||
315 | } | ||
316 | } | ||
317 | |||
318 | #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)] | ||
319 | pub struct ConstId(salsa::InternId); | ||
320 | impl_intern_key!(ConstId); | ||
321 | impl AstItemDef<ast::ConstDef> for ConstId { | ||
322 | fn intern(db: &impl DefDatabase, loc: ItemLoc<ast::ConstDef>) -> Self { | ||
323 | db.intern_const(loc) | ||
324 | } | ||
325 | fn lookup_intern(self, db: &impl DefDatabase) -> ItemLoc<ast::ConstDef> { | ||
326 | db.lookup_intern_const(self) | ||
327 | } | ||
328 | } | ||
329 | |||
330 | #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)] | ||
331 | pub struct StaticId(salsa::InternId); | ||
332 | impl_intern_key!(StaticId); | ||
333 | impl AstItemDef<ast::StaticDef> for StaticId { | ||
334 | fn intern(db: &impl DefDatabase, loc: ItemLoc<ast::StaticDef>) -> Self { | ||
335 | db.intern_static(loc) | ||
336 | } | ||
337 | fn lookup_intern(self, db: &impl DefDatabase) -> ItemLoc<ast::StaticDef> { | ||
338 | db.lookup_intern_static(self) | ||
339 | } | ||
340 | } | ||
341 | |||
342 | #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)] | ||
343 | pub struct TraitId(salsa::InternId); | ||
344 | impl_intern_key!(TraitId); | ||
345 | impl AstItemDef<ast::TraitDef> for TraitId { | ||
346 | fn intern(db: &impl DefDatabase, loc: ItemLoc<ast::TraitDef>) -> Self { | ||
347 | db.intern_trait(loc) | ||
348 | } | ||
349 | fn lookup_intern(self, db: &impl DefDatabase) -> ItemLoc<ast::TraitDef> { | ||
350 | db.lookup_intern_trait(self) | ||
351 | } | ||
352 | } | ||
353 | |||
354 | #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)] | ||
355 | pub struct TypeAliasId(salsa::InternId); | ||
356 | impl_intern_key!(TypeAliasId); | ||
357 | impl AstItemDef<ast::TypeAliasDef> for TypeAliasId { | ||
358 | fn intern(db: &impl DefDatabase, loc: ItemLoc<ast::TypeAliasDef>) -> Self { | ||
359 | db.intern_type_alias(loc) | ||
360 | } | ||
361 | fn lookup_intern(self, db: &impl DefDatabase) -> ItemLoc<ast::TypeAliasDef> { | ||
362 | db.lookup_intern_type_alias(self) | ||
363 | } | ||
364 | } | ||
365 | |||
366 | /// This exists just for Chalk, because Chalk just has a single `StructId` where | 29 | /// This exists just for Chalk, because Chalk just has a single `StructId` where |
367 | /// we have different kinds of ADTs, primitive types and special type | 30 | /// we have different kinds of ADTs, primitive types and special type |
368 | /// constructors like tuples and function pointers. | 31 | /// constructors like tuples and function pointers. |