aboutsummaryrefslogtreecommitdiff
path: root/crates/ra_hir/src/source_analyzer.rs
diff options
context:
space:
mode:
Diffstat (limited to 'crates/ra_hir/src/source_analyzer.rs')
-rw-r--r--crates/ra_hir/src/source_analyzer.rs535
1 files changed, 0 insertions, 535 deletions
diff --git a/crates/ra_hir/src/source_analyzer.rs b/crates/ra_hir/src/source_analyzer.rs
deleted file mode 100644
index d0cb62ef0..000000000
--- a/crates/ra_hir/src/source_analyzer.rs
+++ /dev/null
@@ -1,535 +0,0 @@
1//! Lookup hir elements using positions in the source code. This is a lossy
2//! transformation: in general, a single source might correspond to several
3//! modules, functions, etc, due to macros, cfgs and `#[path=]` attributes on
4//! modules.
5//!
6//! So, this modules should not be used during hir construction, it exists
7//! purely for "IDE needs".
8use std::{iter::once, sync::Arc};
9
10use hir_def::{
11 body::{
12 scope::{ExprScopes, ScopeId},
13 Body, BodySourceMap,
14 },
15 expr::{ExprId, Pat, PatId},
16 resolver::{resolver_for_scope, Resolver, TypeNs, ValueNs},
17 AsMacroCall, DefWithBodyId, FieldId, FunctionId, LocalFieldId, VariantId,
18};
19use hir_expand::{hygiene::Hygiene, name::AsName, HirFileId, InFile};
20use hir_ty::{
21 diagnostics::{record_literal_missing_fields, record_pattern_missing_fields},
22 InferenceResult, Substs, Ty,
23};
24use ra_syntax::{
25 ast::{self, AstNode},
26 SyntaxNode, TextRange, TextSize,
27};
28
29use crate::{
30 db::HirDatabase, semantics::PathResolution, Adt, Const, EnumVariant, Field, Function, Local,
31 MacroDef, ModPath, ModuleDef, Path, PathKind, Static, Struct, Trait, Type, TypeAlias,
32 TypeParam,
33};
34use ra_db::CrateId;
35
36/// `SourceAnalyzer` is a convenience wrapper which exposes HIR API in terms of
37/// original source files. It should not be used inside the HIR itself.
38#[derive(Debug)]
39pub(crate) struct SourceAnalyzer {
40 file_id: HirFileId,
41 pub(crate) resolver: Resolver,
42 body: Option<Arc<Body>>,
43 body_source_map: Option<Arc<BodySourceMap>>,
44 infer: Option<Arc<InferenceResult>>,
45 scopes: Option<Arc<ExprScopes>>,
46}
47
48impl SourceAnalyzer {
49 pub(crate) fn new_for_body(
50 db: &dyn HirDatabase,
51 def: DefWithBodyId,
52 node: InFile<&SyntaxNode>,
53 offset: Option<TextSize>,
54 ) -> SourceAnalyzer {
55 let (body, source_map) = db.body_with_source_map(def);
56 let scopes = db.expr_scopes(def);
57 let scope = match offset {
58 None => scope_for(&scopes, &source_map, node),
59 Some(offset) => scope_for_offset(db, &scopes, &source_map, node.with_value(offset)),
60 };
61 let resolver = resolver_for_scope(db.upcast(), def, scope);
62 SourceAnalyzer {
63 resolver,
64 body: Some(body),
65 body_source_map: Some(source_map),
66 infer: Some(db.infer(def)),
67 scopes: Some(scopes),
68 file_id: node.file_id,
69 }
70 }
71
72 pub(crate) fn new_for_resolver(
73 resolver: Resolver,
74 node: InFile<&SyntaxNode>,
75 ) -> SourceAnalyzer {
76 SourceAnalyzer {
77 resolver,
78 body: None,
79 body_source_map: None,
80 infer: None,
81 scopes: None,
82 file_id: node.file_id,
83 }
84 }
85
86 fn expr_id(&self, db: &dyn HirDatabase, expr: &ast::Expr) -> Option<ExprId> {
87 let src = match expr {
88 ast::Expr::MacroCall(call) => {
89 self.expand_expr(db, InFile::new(self.file_id, call.clone()))?
90 }
91 _ => InFile::new(self.file_id, expr.clone()),
92 };
93 let sm = self.body_source_map.as_ref()?;
94 sm.node_expr(src.as_ref())
95 }
96
97 fn pat_id(&self, pat: &ast::Pat) -> Option<PatId> {
98 // FIXME: macros, see `expr_id`
99 let src = InFile { file_id: self.file_id, value: pat };
100 self.body_source_map.as_ref()?.node_pat(src)
101 }
102
103 fn expand_expr(
104 &self,
105 db: &dyn HirDatabase,
106 expr: InFile<ast::MacroCall>,
107 ) -> Option<InFile<ast::Expr>> {
108 let macro_file = self.body_source_map.as_ref()?.node_macro_file(expr.as_ref())?;
109 let expanded = db.parse_or_expand(macro_file)?;
110
111 let res = match ast::MacroCall::cast(expanded.clone()) {
112 Some(call) => self.expand_expr(db, InFile::new(macro_file, call))?,
113 _ => InFile::new(macro_file, ast::Expr::cast(expanded)?),
114 };
115 Some(res)
116 }
117
118 pub(crate) fn type_of_expr(&self, db: &dyn HirDatabase, expr: &ast::Expr) -> Option<Type> {
119 let expr_id = self.expr_id(db, expr)?;
120 let ty = self.infer.as_ref()?[expr_id].clone();
121 Type::new_with_resolver(db, &self.resolver, ty)
122 }
123
124 pub(crate) fn type_of_pat(&self, db: &dyn HirDatabase, pat: &ast::Pat) -> Option<Type> {
125 let pat_id = self.pat_id(pat)?;
126 let ty = self.infer.as_ref()?[pat_id].clone();
127 Type::new_with_resolver(db, &self.resolver, ty)
128 }
129
130 pub(crate) fn type_of_self(
131 &self,
132 db: &dyn HirDatabase,
133 param: &ast::SelfParam,
134 ) -> Option<Type> {
135 let src = InFile { file_id: self.file_id, value: param };
136 let pat_id = self.body_source_map.as_ref()?.node_self_param(src)?;
137 let ty = self.infer.as_ref()?[pat_id].clone();
138 Type::new_with_resolver(db, &self.resolver, ty)
139 }
140
141 pub(crate) fn resolve_method_call(
142 &self,
143 db: &dyn HirDatabase,
144 call: &ast::MethodCallExpr,
145 ) -> Option<FunctionId> {
146 let expr_id = self.expr_id(db, &call.clone().into())?;
147 self.infer.as_ref()?.method_resolution(expr_id)
148 }
149
150 pub(crate) fn resolve_field(
151 &self,
152 db: &dyn HirDatabase,
153 field: &ast::FieldExpr,
154 ) -> Option<Field> {
155 let expr_id = self.expr_id(db, &field.clone().into())?;
156 self.infer.as_ref()?.field_resolution(expr_id).map(|it| it.into())
157 }
158
159 pub(crate) fn resolve_record_field(
160 &self,
161 db: &dyn HirDatabase,
162 field: &ast::RecordExprField,
163 ) -> Option<(Field, Option<Local>)> {
164 let expr = field.expr()?;
165 let expr_id = self.expr_id(db, &expr)?;
166 let local = if field.name_ref().is_some() {
167 None
168 } else {
169 let local_name = field.field_name()?.as_name();
170 let path = ModPath::from_segments(PathKind::Plain, once(local_name));
171 match self.resolver.resolve_path_in_value_ns_fully(db.upcast(), &path) {
172 Some(ValueNs::LocalBinding(pat_id)) => {
173 Some(Local { pat_id, parent: self.resolver.body_owner()? })
174 }
175 _ => None,
176 }
177 };
178 let struct_field = self.infer.as_ref()?.record_field_resolution(expr_id)?;
179 Some((struct_field.into(), local))
180 }
181
182 pub(crate) fn resolve_record_field_pat(
183 &self,
184 _db: &dyn HirDatabase,
185 field: &ast::RecordPatField,
186 ) -> Option<Field> {
187 let pat_id = self.pat_id(&field.pat()?)?;
188 let struct_field = self.infer.as_ref()?.record_field_pat_resolution(pat_id)?;
189 Some(struct_field.into())
190 }
191
192 pub(crate) fn resolve_macro_call(
193 &self,
194 db: &dyn HirDatabase,
195 macro_call: InFile<&ast::MacroCall>,
196 ) -> Option<MacroDef> {
197 let hygiene = Hygiene::new(db.upcast(), macro_call.file_id);
198 let path = macro_call.value.path().and_then(|ast| Path::from_src(ast, &hygiene))?;
199 self.resolver.resolve_path_as_macro(db.upcast(), path.mod_path()).map(|it| it.into())
200 }
201
202 pub(crate) fn resolve_bind_pat_to_const(
203 &self,
204 db: &dyn HirDatabase,
205 pat: &ast::IdentPat,
206 ) -> Option<ModuleDef> {
207 let pat_id = self.pat_id(&pat.clone().into())?;
208 let body = self.body.as_ref()?;
209 let path = match &body[pat_id] {
210 Pat::Path(path) => path,
211 _ => return None,
212 };
213 let res = resolve_hir_path(db, &self.resolver, &path)?;
214 match res {
215 PathResolution::Def(def) => Some(def),
216 _ => None,
217 }
218 }
219
220 pub(crate) fn resolve_path(
221 &self,
222 db: &dyn HirDatabase,
223 path: &ast::Path,
224 ) -> Option<PathResolution> {
225 if let Some(path_expr) = path.syntax().parent().and_then(ast::PathExpr::cast) {
226 let expr_id = self.expr_id(db, &path_expr.into())?;
227 if let Some(assoc) = self.infer.as_ref()?.assoc_resolutions_for_expr(expr_id) {
228 return Some(PathResolution::AssocItem(assoc.into()));
229 }
230 if let Some(VariantId::EnumVariantId(variant)) =
231 self.infer.as_ref()?.variant_resolution_for_expr(expr_id)
232 {
233 return Some(PathResolution::Def(ModuleDef::EnumVariant(variant.into())));
234 }
235 }
236
237 if let Some(path_pat) = path.syntax().parent().and_then(ast::PathPat::cast) {
238 let pat_id = self.pat_id(&path_pat.into())?;
239 if let Some(assoc) = self.infer.as_ref()?.assoc_resolutions_for_pat(pat_id) {
240 return Some(PathResolution::AssocItem(assoc.into()));
241 }
242 if let Some(VariantId::EnumVariantId(variant)) =
243 self.infer.as_ref()?.variant_resolution_for_pat(pat_id)
244 {
245 return Some(PathResolution::Def(ModuleDef::EnumVariant(variant.into())));
246 }
247 }
248
249 if let Some(rec_lit) = path.syntax().parent().and_then(ast::RecordExpr::cast) {
250 let expr_id = self.expr_id(db, &rec_lit.into())?;
251 if let Some(VariantId::EnumVariantId(variant)) =
252 self.infer.as_ref()?.variant_resolution_for_expr(expr_id)
253 {
254 return Some(PathResolution::Def(ModuleDef::EnumVariant(variant.into())));
255 }
256 }
257
258 if let Some(rec_pat) = path.syntax().parent().and_then(ast::RecordPat::cast) {
259 let pat_id = self.pat_id(&rec_pat.into())?;
260 if let Some(VariantId::EnumVariantId(variant)) =
261 self.infer.as_ref()?.variant_resolution_for_pat(pat_id)
262 {
263 return Some(PathResolution::Def(ModuleDef::EnumVariant(variant.into())));
264 }
265 }
266
267 // This must be a normal source file rather than macro file.
268 let hir_path =
269 crate::Path::from_src(path.clone(), &Hygiene::new(db.upcast(), self.file_id))?;
270
271 // Case where path is a qualifier of another path, e.g. foo::bar::Baz where we
272 // trying to resolve foo::bar.
273 if let Some(outer_path) = path.syntax().parent().and_then(ast::Path::cast) {
274 if let Some(qualifier) = outer_path.qualifier() {
275 if path == &qualifier {
276 return resolve_hir_path_qualifier(db, &self.resolver, &hir_path);
277 }
278 }
279 }
280
281 resolve_hir_path(db, &self.resolver, &hir_path)
282 }
283
284 pub(crate) fn record_literal_missing_fields(
285 &self,
286 db: &dyn HirDatabase,
287 literal: &ast::RecordExpr,
288 ) -> Option<Vec<(Field, Type)>> {
289 let krate = self.resolver.krate()?;
290 let body = self.body.as_ref()?;
291 let infer = self.infer.as_ref()?;
292
293 let expr_id = self.expr_id(db, &literal.clone().into())?;
294 let substs = match &infer.type_of_expr[expr_id] {
295 Ty::Apply(a_ty) => &a_ty.parameters,
296 _ => return None,
297 };
298
299 let (variant, missing_fields, _exhaustive) =
300 record_literal_missing_fields(db, infer, expr_id, &body[expr_id])?;
301 let res = self.missing_fields(db, krate, substs, variant, missing_fields);
302 Some(res)
303 }
304
305 pub(crate) fn record_pattern_missing_fields(
306 &self,
307 db: &dyn HirDatabase,
308 pattern: &ast::RecordPat,
309 ) -> Option<Vec<(Field, Type)>> {
310 let krate = self.resolver.krate()?;
311 let body = self.body.as_ref()?;
312 let infer = self.infer.as_ref()?;
313
314 let pat_id = self.pat_id(&pattern.clone().into())?;
315 let substs = match &infer.type_of_pat[pat_id] {
316 Ty::Apply(a_ty) => &a_ty.parameters,
317 _ => return None,
318 };
319
320 let (variant, missing_fields, _exhaustive) =
321 record_pattern_missing_fields(db, infer, pat_id, &body[pat_id])?;
322 let res = self.missing_fields(db, krate, substs, variant, missing_fields);
323 Some(res)
324 }
325
326 fn missing_fields(
327 &self,
328 db: &dyn HirDatabase,
329 krate: CrateId,
330 substs: &Substs,
331 variant: VariantId,
332 missing_fields: Vec<LocalFieldId>,
333 ) -> Vec<(Field, Type)> {
334 let field_types = db.field_types(variant);
335
336 missing_fields
337 .into_iter()
338 .map(|local_id| {
339 let field = FieldId { parent: variant, local_id };
340 let ty = field_types[local_id].clone().subst(substs);
341 (field.into(), Type::new_with_resolver_inner(db, krate, &self.resolver, ty))
342 })
343 .collect()
344 }
345
346 pub(crate) fn expand(
347 &self,
348 db: &dyn HirDatabase,
349 macro_call: InFile<&ast::MacroCall>,
350 ) -> Option<HirFileId> {
351 let krate = self.resolver.krate()?;
352 let macro_call_id = macro_call.as_call_id(db.upcast(), krate, |path| {
353 self.resolver.resolve_path_as_macro(db.upcast(), &path)
354 })?;
355 Some(macro_call_id.as_file()).filter(|it| it.expansion_level(db.upcast()) < 64)
356 }
357
358 pub(crate) fn resolve_variant(
359 &self,
360 db: &dyn HirDatabase,
361 record_lit: ast::RecordExpr,
362 ) -> Option<VariantId> {
363 let infer = self.infer.as_ref()?;
364 let expr_id = self.expr_id(db, &record_lit.into())?;
365 infer.variant_resolution_for_expr(expr_id)
366 }
367}
368
369fn scope_for(
370 scopes: &ExprScopes,
371 source_map: &BodySourceMap,
372 node: InFile<&SyntaxNode>,
373) -> Option<ScopeId> {
374 node.value
375 .ancestors()
376 .filter_map(ast::Expr::cast)
377 .filter_map(|it| source_map.node_expr(InFile::new(node.file_id, &it)))
378 .find_map(|it| scopes.scope_for(it))
379}
380
381fn scope_for_offset(
382 db: &dyn HirDatabase,
383 scopes: &ExprScopes,
384 source_map: &BodySourceMap,
385 offset: InFile<TextSize>,
386) -> Option<ScopeId> {
387 scopes
388 .scope_by_expr()
389 .iter()
390 .filter_map(|(id, scope)| {
391 let source = source_map.expr_syntax(*id).ok()?;
392 // FIXME: correctly handle macro expansion
393 if source.file_id != offset.file_id {
394 return None;
395 }
396 let root = source.file_syntax(db.upcast());
397 let node = source.value.to_node(&root);
398 Some((node.syntax().text_range(), scope))
399 })
400 // find containing scope
401 .min_by_key(|(expr_range, _scope)| {
402 (
403 !(expr_range.start() <= offset.value && offset.value <= expr_range.end()),
404 expr_range.len(),
405 )
406 })
407 .map(|(expr_range, scope)| {
408 adjust(db, scopes, source_map, expr_range, offset).unwrap_or(*scope)
409 })
410}
411
412// XXX: during completion, cursor might be outside of any particular
413// expression. Try to figure out the correct scope...
414fn adjust(
415 db: &dyn HirDatabase,
416 scopes: &ExprScopes,
417 source_map: &BodySourceMap,
418 expr_range: TextRange,
419 offset: InFile<TextSize>,
420) -> Option<ScopeId> {
421 let child_scopes = scopes
422 .scope_by_expr()
423 .iter()
424 .filter_map(|(id, scope)| {
425 let source = source_map.expr_syntax(*id).ok()?;
426 // FIXME: correctly handle macro expansion
427 if source.file_id != offset.file_id {
428 return None;
429 }
430 let root = source.file_syntax(db.upcast());
431 let node = source.value.to_node(&root);
432 Some((node.syntax().text_range(), scope))
433 })
434 .filter(|&(range, _)| {
435 range.start() <= offset.value && expr_range.contains_range(range) && range != expr_range
436 });
437
438 child_scopes
439 .max_by(|&(r1, _), &(r2, _)| {
440 if r1.contains_range(r2) {
441 std::cmp::Ordering::Greater
442 } else if r2.contains_range(r1) {
443 std::cmp::Ordering::Less
444 } else {
445 r1.start().cmp(&r2.start())
446 }
447 })
448 .map(|(_ptr, scope)| *scope)
449}
450
451pub(crate) fn resolve_hir_path(
452 db: &dyn HirDatabase,
453 resolver: &Resolver,
454 path: &crate::Path,
455) -> Option<PathResolution> {
456 let types =
457 resolver.resolve_path_in_type_ns_fully(db.upcast(), path.mod_path()).map(|ty| match ty {
458 TypeNs::SelfType(it) => PathResolution::SelfType(it.into()),
459 TypeNs::GenericParam(id) => PathResolution::TypeParam(TypeParam { id }),
460 TypeNs::AdtSelfType(it) | TypeNs::AdtId(it) => {
461 PathResolution::Def(Adt::from(it).into())
462 }
463 TypeNs::EnumVariantId(it) => PathResolution::Def(EnumVariant::from(it).into()),
464 TypeNs::TypeAliasId(it) => PathResolution::Def(TypeAlias::from(it).into()),
465 TypeNs::BuiltinType(it) => PathResolution::Def(it.into()),
466 TypeNs::TraitId(it) => PathResolution::Def(Trait::from(it).into()),
467 });
468
469 let body_owner = resolver.body_owner();
470 let values =
471 resolver.resolve_path_in_value_ns_fully(db.upcast(), path.mod_path()).and_then(|val| {
472 let res = match val {
473 ValueNs::LocalBinding(pat_id) => {
474 let var = Local { parent: body_owner?.into(), pat_id };
475 PathResolution::Local(var)
476 }
477 ValueNs::FunctionId(it) => PathResolution::Def(Function::from(it).into()),
478 ValueNs::ConstId(it) => PathResolution::Def(Const::from(it).into()),
479 ValueNs::StaticId(it) => PathResolution::Def(Static::from(it).into()),
480 ValueNs::StructId(it) => PathResolution::Def(Struct::from(it).into()),
481 ValueNs::EnumVariantId(it) => PathResolution::Def(EnumVariant::from(it).into()),
482 ValueNs::ImplSelf(impl_id) => PathResolution::SelfType(impl_id.into()),
483 };
484 Some(res)
485 });
486
487 let items = resolver
488 .resolve_module_path_in_items(db.upcast(), path.mod_path())
489 .take_types()
490 .map(|it| PathResolution::Def(it.into()));
491
492 types.or(values).or(items).or_else(|| {
493 resolver
494 .resolve_path_as_macro(db.upcast(), path.mod_path())
495 .map(|def| PathResolution::Macro(def.into()))
496 })
497}
498
499/// Resolves a path where we know it is a qualifier of another path.
500///
501/// For example, if we have:
502/// ```
503/// mod my {
504/// pub mod foo {
505/// struct Bar;
506/// }
507///
508/// pub fn foo() {}
509/// }
510/// ```
511/// then we know that `foo` in `my::foo::Bar` refers to the module, not the function.
512pub(crate) fn resolve_hir_path_qualifier(
513 db: &dyn HirDatabase,
514 resolver: &Resolver,
515 path: &crate::Path,
516) -> Option<PathResolution> {
517 let items = resolver
518 .resolve_module_path_in_items(db.upcast(), path.mod_path())
519 .take_types()
520 .map(|it| PathResolution::Def(it.into()));
521
522 if items.is_some() {
523 return items;
524 }
525
526 resolver.resolve_path_in_type_ns_fully(db.upcast(), path.mod_path()).map(|ty| match ty {
527 TypeNs::SelfType(it) => PathResolution::SelfType(it.into()),
528 TypeNs::GenericParam(id) => PathResolution::TypeParam(TypeParam { id }),
529 TypeNs::AdtSelfType(it) | TypeNs::AdtId(it) => PathResolution::Def(Adt::from(it).into()),
530 TypeNs::EnumVariantId(it) => PathResolution::Def(EnumVariant::from(it).into()),
531 TypeNs::TypeAliasId(it) => PathResolution::Def(TypeAlias::from(it).into()),
532 TypeNs::BuiltinType(it) => PathResolution::Def(it.into()),
533 TypeNs::TraitId(it) => PathResolution::Def(Trait::from(it).into()),
534 })
535}
generated by cgit v1.2.3 (git 2.25.1) at 2025-07-22 17:21:33 +0100