rust/crates/ra_hir/src/source_binder.rs

463 lines
16 KiB
Rust
Raw Normal View History

/// Lookup hir elements using positions in the source code. This is a lossy
/// transformation: in general, a single source might correspond to several
/// modules, functions, etc, due to macros, cfgs and `#[path=]` attributes on
/// modules.
///
/// So, this modules should not be used during hir construction, it exists
/// purely for "IDE needs".
2019-04-10 03:15:55 -05:00
use std::sync::Arc;
2019-01-15 09:13:11 -06:00
use ra_db::{FileId, FilePosition};
use ra_syntax::{
2019-04-11 08:49:35 -05:00
algo::find_node_at_offset,
ast::{self, AstNode, NameOwner},
AstPtr,
2019-04-13 01:45:52 -05:00
SyntaxKind::*,
SyntaxNode, SyntaxNodePtr, TextRange, TextUnit,
};
use rustc_hash::{FxHashMap, FxHashSet};
use crate::{
expr,
expr::{
scope::{ExprScopes, ScopeId},
BodySourceMap,
},
2019-06-08 06:48:56 -05:00
ids::LocationCtx,
AsName, AstId, Const, Crate, DefWithBody, Either, Enum, Function, HirDatabase, HirFileId,
MacroDef, Module, Name, Path, PerNs, Resolver, Static, Struct, Trait, Ty,
};
/// Locates the module by `FileId`. Picks topmost module in the file.
2019-01-15 09:13:11 -06:00
pub fn module_from_file_id(db: &impl HirDatabase, file_id: FileId) -> Option<Module> {
2019-01-26 14:25:18 -06:00
module_from_source(db, file_id.into(), None)
}
2018-12-27 12:21:10 -06:00
/// Locates the child module by `mod child;` declaration.
pub fn module_from_declaration(
db: &impl HirDatabase,
file_id: FileId,
2019-07-19 02:43:01 -05:00
decl: ast::Module,
2019-01-15 09:13:11 -06:00
) -> Option<Module> {
let parent_module = module_from_file_id(db, file_id);
2018-12-27 12:21:10 -06:00
let child_name = decl.name();
match (parent_module, child_name) {
2019-01-16 07:39:01 -06:00
(Some(parent_module), Some(child_name)) => parent_module.child(db, &child_name.as_name()),
_ => None,
2018-12-27 12:21:10 -06:00
}
}
/// Locates the module by position in the source code.
2019-01-15 09:13:11 -06:00
pub fn module_from_position(db: &impl HirDatabase, position: FilePosition) -> Option<Module> {
let parse = db.parse(position.file_id);
2019-07-19 02:43:01 -05:00
match &find_node_at_offset::<ast::Module>(parse.tree().syntax(), position.offset) {
Some(m) if !m.has_semi() => module_from_inline(db, position.file_id, m.clone()),
2019-06-03 09:21:08 -05:00
_ => module_from_file_id(db, position.file_id),
2019-01-06 10:58:10 -06:00
}
}
fn module_from_inline(
db: &impl HirDatabase,
file_id: FileId,
2019-07-19 02:43:01 -05:00
module: ast::Module,
2019-01-15 09:13:11 -06:00
) -> Option<Module> {
2019-01-06 10:58:10 -06:00
assert!(!module.has_semi());
let file_id = file_id.into();
2019-03-26 11:00:11 -05:00
let ast_id_map = db.ast_id_map(file_id);
2019-07-19 02:43:01 -05:00
let item_id = ast_id_map.ast_id(&module).with_file_id(file_id);
2019-01-26 14:25:18 -06:00
module_from_source(db, file_id, Some(item_id))
}
/// Locates the module by child syntax element within the module
pub fn module_from_child_node(
db: &impl HirDatabase,
file_id: FileId,
2019-01-08 02:28:42 -06:00
child: &SyntaxNode,
2019-01-15 09:13:11 -06:00
) -> Option<Module> {
2019-02-08 05:49:43 -06:00
if let Some(m) = child.ancestors().filter_map(ast::Module::cast).find(|it| !it.has_semi()) {
2019-06-03 09:21:08 -05:00
module_from_inline(db, file_id, m)
} else {
2019-06-03 09:21:08 -05:00
module_from_file_id(db, file_id)
2019-01-06 10:58:10 -06:00
}
}
2019-01-26 14:25:18 -06:00
fn module_from_source(
db: &impl HirDatabase,
file_id: HirFileId,
2019-03-26 09:25:14 -05:00
decl_id: Option<AstId<ast::Module>>,
2019-01-26 14:25:18 -06:00
) -> Option<Module> {
let source_root_id = db.file_source_root(file_id.as_original_file());
2019-02-08 05:49:43 -06:00
db.source_root_crates(source_root_id).iter().map(|&crate_id| Crate { crate_id }).find_map(
|krate| {
2019-03-13 08:38:02 -05:00
let def_map = db.crate_def_map(krate);
let module_id = def_map.find_module_by_source(file_id, decl_id)?;
Some(Module { krate, module_id })
2019-02-08 05:49:43 -06:00
},
)
}
pub fn struct_from_module(
db: &impl HirDatabase,
module: Module,
struct_def: &ast::StructDef,
) -> Struct {
2019-06-11 09:47:24 -05:00
let file_id = module.definition_source(db).file_id;
let ctx = LocationCtx::new(db, module, file_id);
2019-02-08 05:49:43 -06:00
Struct { id: ctx.to_def(struct_def) }
}
pub fn enum_from_module(db: &impl HirDatabase, module: Module, enum_def: &ast::EnumDef) -> Enum {
2019-06-11 09:47:24 -05:00
let file_id = module.definition_source(db).file_id;
let ctx = LocationCtx::new(db, module, file_id);
2019-02-08 05:49:43 -06:00
Enum { id: ctx.to_def(enum_def) }
}
2019-01-31 17:34:52 -06:00
pub fn trait_from_module(
db: &impl HirDatabase,
module: Module,
trait_def: &ast::TraitDef,
) -> Trait {
2019-06-11 09:47:24 -05:00
let file_id = module.definition_source(db).file_id;
2019-01-31 17:34:52 -06:00
let ctx = LocationCtx::new(db, module, file_id);
2019-02-08 05:49:43 -06:00
Trait { id: ctx.to_def(trait_def) }
2019-01-31 17:34:52 -06:00
}
fn try_get_resolver_for_node(
db: &impl HirDatabase,
file_id: FileId,
node: &SyntaxNode,
) -> Option<Resolver> {
2019-07-19 02:43:01 -05:00
if let Some(module) = ast::Module::cast(node.clone()) {
Some(module_from_declaration(db, file_id, module)?.resolver(db))
2019-07-19 02:43:01 -05:00
} else if let Some(_) = ast::SourceFile::cast(node.clone()) {
Some(module_from_source(db, file_id.into(), None)?.resolver(db))
2019-07-19 02:43:01 -05:00
} else if let Some(s) = ast::StructDef::cast(node.clone()) {
let module = module_from_child_node(db, file_id, s.syntax())?;
2019-07-19 02:43:01 -05:00
Some(struct_from_module(db, module, &s).resolver(db))
} else if let Some(e) = ast::EnumDef::cast(node.clone()) {
let module = module_from_child_node(db, file_id, e.syntax())?;
2019-07-19 02:43:01 -05:00
Some(enum_from_module(db, module, &e).resolver(db))
2019-04-13 01:45:52 -05:00
} else if node.kind() == FN_DEF || node.kind() == CONST_DEF || node.kind() == STATIC_DEF {
Some(def_with_body_from_child_node(db, file_id, node)?.resolver(db))
} else {
2019-03-23 02:53:48 -05:00
// FIXME add missing cases
None
}
}
2019-04-10 03:15:55 -05:00
2019-04-13 01:46:39 -05:00
fn def_with_body_from_child_node(
2019-04-12 17:05:18 -05:00
db: &impl HirDatabase,
file_id: FileId,
node: &SyntaxNode,
) -> Option<DefWithBody> {
let module = module_from_child_node(db, file_id, node)?;
let ctx = LocationCtx::new(db, module, file_id.into());
node.ancestors().find_map(|node| {
2019-07-19 02:43:01 -05:00
if let Some(def) = ast::FnDef::cast(node.clone()) {
return Some(Function { id: ctx.to_def(&def) }.into());
2019-04-12 17:05:18 -05:00
}
2019-07-19 02:43:01 -05:00
if let Some(def) = ast::ConstDef::cast(node.clone()) {
return Some(Const { id: ctx.to_def(&def) }.into());
2019-04-12 17:05:18 -05:00
}
2019-07-19 02:43:01 -05:00
if let Some(def) = ast::StaticDef::cast(node.clone()) {
return Some(Static { id: ctx.to_def(&def) }.into());
2019-04-12 17:05:18 -05:00
}
None
})
}
2019-04-11 07:58:00 -05:00
/// `SourceAnalyzer` is a convenience wrapper which exposes HIR API in terms of
/// original source files. It should not be used inside the HIR itself.
2019-04-10 03:15:55 -05:00
#[derive(Debug)]
2019-04-11 07:51:02 -05:00
pub struct SourceAnalyzer {
2019-04-10 03:15:55 -05:00
resolver: Resolver,
body_source_map: Option<Arc<BodySourceMap>>,
2019-04-10 03:15:55 -05:00
infer: Option<Arc<crate::ty::InferenceResult>>,
scopes: Option<Arc<crate::expr::ExprScopes>>,
2019-04-10 03:15:55 -05:00
}
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum PathResolution {
/// An item
Def(crate::ModuleDef),
/// A local binding (only value namespace)
2019-04-11 07:58:00 -05:00
LocalBinding(Either<AstPtr<ast::Pat>, AstPtr<ast::SelfParam>>),
2019-04-10 03:15:55 -05:00
/// A generic parameter
GenericParam(u32),
SelfType(crate::ImplBlock),
2019-06-08 06:48:56 -05:00
Macro(MacroDef),
2019-04-10 03:15:55 -05:00
AssocItem(crate::ImplItem),
}
2019-04-13 03:24:09 -05:00
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct ScopeEntryWithSyntax {
pub(crate) name: Name,
pub(crate) ptr: Either<AstPtr<ast::Pat>, AstPtr<ast::SelfParam>>,
}
impl ScopeEntryWithSyntax {
pub fn name(&self) -> &Name {
&self.name
}
pub fn ptr(&self) -> Either<AstPtr<ast::Pat>, AstPtr<ast::SelfParam>> {
self.ptr
}
}
2019-04-13 03:32:58 -05:00
#[derive(Debug)]
pub struct ReferenceDescriptor {
pub range: TextRange,
pub name: String,
}
2019-04-11 07:51:02 -05:00
impl SourceAnalyzer {
pub fn new(
db: &impl HirDatabase,
file_id: FileId,
node: &SyntaxNode,
offset: Option<TextUnit>,
) -> SourceAnalyzer {
2019-04-12 17:05:18 -05:00
let def_with_body = def_with_body_from_child_node(db, file_id, node);
if let Some(def) = def_with_body {
let source_map = def.body_source_map(db);
let scopes = db.expr_scopes(def);
let scope = match offset {
None => scope_for(&scopes, &source_map, &node),
Some(offset) => scope_for_offset(&scopes, &source_map, offset),
};
let resolver = expr::resolver_for_scope(def.body(db), db, scope);
SourceAnalyzer {
resolver,
body_source_map: Some(source_map),
infer: Some(def.infer(db)),
scopes: Some(scopes),
}
} else {
SourceAnalyzer {
resolver: node
.ancestors()
2019-07-19 02:43:01 -05:00
.find_map(|node| try_get_resolver_for_node(db, file_id, &node))
.unwrap_or_default(),
body_source_map: None,
infer: None,
scopes: None,
}
2019-04-10 03:15:55 -05:00
}
}
pub fn type_of(&self, _db: &impl HirDatabase, expr: &ast::Expr) -> Option<crate::Ty> {
let expr_id = self.body_source_map.as_ref()?.node_expr(expr)?;
Some(self.infer.as_ref()?[expr_id].clone())
}
pub fn type_of_pat(&self, _db: &impl HirDatabase, pat: &ast::Pat) -> Option<crate::Ty> {
let pat_id = self.body_source_map.as_ref()?.node_pat(pat)?;
Some(self.infer.as_ref()?[pat_id].clone())
}
pub fn resolve_method_call(&self, call: &ast::MethodCallExpr) -> Option<Function> {
2019-07-19 02:43:01 -05:00
let expr_id = self.body_source_map.as_ref()?.node_expr(&call.clone().into())?;
2019-04-10 03:15:55 -05:00
self.infer.as_ref()?.method_resolution(expr_id)
}
pub fn resolve_field(&self, field: &ast::FieldExpr) -> Option<crate::StructField> {
2019-07-19 02:43:01 -05:00
let expr_id = self.body_source_map.as_ref()?.node_expr(&field.clone().into())?;
2019-04-10 03:15:55 -05:00
self.infer.as_ref()?.field_resolution(expr_id)
}
2019-07-12 11:56:18 -05:00
pub fn resolve_variant(&self, struct_lit: &ast::StructLit) -> Option<crate::VariantDef> {
2019-07-19 02:43:01 -05:00
let expr_id = self.body_source_map.as_ref()?.node_expr(&struct_lit.clone().into())?;
2019-07-12 11:56:18 -05:00
self.infer.as_ref()?.variant_resolution(expr_id)
}
2019-06-01 06:34:19 -05:00
pub fn resolve_macro_call(
&self,
db: &impl HirDatabase,
macro_call: &ast::MacroCall,
2019-06-08 06:48:56 -05:00
) -> Option<MacroDef> {
let path = macro_call.path().and_then(Path::from_ast)?;
self.resolver.resolve_path_as_macro(db, &path)
2019-04-24 15:16:50 -05:00
}
2019-04-13 03:00:15 -05:00
pub fn resolve_hir_path(
&self,
db: &impl HirDatabase,
path: &crate::Path,
) -> PerNs<crate::Resolution> {
2019-06-08 10:38:14 -05:00
self.resolver.resolve_path_without_assoc_items(db, path)
2019-04-13 03:00:15 -05:00
}
2019-04-10 03:15:55 -05:00
pub fn resolve_path(&self, db: &impl HirDatabase, path: &ast::Path) -> Option<PathResolution> {
if let Some(path_expr) = path.syntax().parent().and_then(ast::PathExpr::cast) {
2019-07-19 02:43:01 -05:00
let expr_id = self.body_source_map.as_ref()?.node_expr(&path_expr.into())?;
2019-04-10 03:15:55 -05:00
if let Some(assoc) = self.infer.as_ref()?.assoc_resolutions_for_expr(expr_id) {
return Some(PathResolution::AssocItem(assoc));
}
}
if let Some(path_pat) = path.syntax().parent().and_then(ast::PathPat::cast) {
2019-07-19 02:43:01 -05:00
let pat_id = self.body_source_map.as_ref()?.node_pat(&path_pat.into())?;
2019-04-10 03:15:55 -05:00
if let Some(assoc) = self.infer.as_ref()?.assoc_resolutions_for_pat(pat_id) {
return Some(PathResolution::AssocItem(assoc));
}
}
2019-07-19 02:43:01 -05:00
let hir_path = crate::Path::from_ast(path.clone())?;
2019-06-08 10:38:14 -05:00
let res = self.resolver.resolve_path_without_assoc_items(db, &hir_path);
2019-04-10 03:15:55 -05:00
let res = res.clone().take_types().or_else(|| res.take_values())?;
2019-04-11 07:58:00 -05:00
let res = match res {
2019-04-10 03:15:55 -05:00
crate::Resolution::Def(it) => PathResolution::Def(it),
2019-04-11 07:58:00 -05:00
crate::Resolution::LocalBinding(it) => {
PathResolution::LocalBinding(self.body_source_map.as_ref()?.pat_syntax(it)?)
}
2019-04-10 03:15:55 -05:00
crate::Resolution::GenericParam(it) => PathResolution::GenericParam(it),
crate::Resolution::SelfType(it) => PathResolution::SelfType(it),
2019-04-11 07:58:00 -05:00
};
Some(res)
2019-04-10 03:15:55 -05:00
}
2019-04-12 16:56:57 -05:00
pub fn resolve_local_name(&self, name_ref: &ast::NameRef) -> Option<ScopeEntryWithSyntax> {
let mut shadowed = FxHashSet::default();
let name = name_ref.as_name();
let source_map = self.body_source_map.as_ref()?;
let scopes = self.scopes.as_ref()?;
let scope = scope_for(scopes, source_map, name_ref.syntax());
let ret = scopes
.scope_chain(scope)
.flat_map(|scope| scopes.entries(scope).iter())
.filter(|entry| shadowed.insert(entry.name()))
.filter(|entry| entry.name() == &name)
.nth(0);
ret.and_then(|entry| {
Some(ScopeEntryWithSyntax {
name: entry.name().clone(),
ptr: source_map.pat_syntax(entry.pat())?,
})
})
2019-04-13 01:31:03 -05:00
}
2019-04-13 03:21:32 -05:00
pub fn all_names(&self, db: &impl HirDatabase) -> FxHashMap<Name, PerNs<crate::Resolution>> {
self.resolver.all_names(db)
}
pub fn find_all_refs(&self, pat: &ast::BindPat) -> Vec<ReferenceDescriptor> {
2019-04-13 03:32:58 -05:00
// FIXME: at least, this should work with any DefWithBody, but ideally
// this should be hir-based altogether
let fn_def = pat.syntax().ancestors().find_map(ast::FnDef::cast).unwrap();
2019-07-19 02:43:01 -05:00
let ptr = Either::A(AstPtr::new(&ast::Pat::from(pat.clone())));
fn_def
.syntax()
.descendants()
.filter_map(ast::NameRef::cast)
2019-07-19 02:43:01 -05:00
.filter(|name_ref| match self.resolve_local_name(&name_ref) {
None => false,
Some(entry) => entry.ptr() == ptr,
})
.map(|name_ref| ReferenceDescriptor {
2019-04-13 03:32:58 -05:00
name: name_ref.text().to_string(),
range: name_ref.syntax().range(),
})
.collect()
2019-04-13 01:31:03 -05:00
}
pub fn iterate_method_candidates<T>(
&self,
db: &impl HirDatabase,
ty: Ty,
name: Option<&Name>,
callback: impl FnMut(&Ty, Function) -> Option<T>,
) -> Option<T> {
// There should be no inference vars in types passed here
// FIXME check that?
let canonical = crate::ty::Canonical { value: ty, num_vars: 0 };
crate::ty::method_resolution::iterate_method_candidates(
&canonical,
db,
&self.resolver,
name,
callback,
)
}
pub fn autoderef<'a>(
&'a self,
db: &'a impl HirDatabase,
ty: Ty,
) -> impl Iterator<Item = Ty> + 'a {
// There should be no inference vars in types passed here
// FIXME check that?
let canonical = crate::ty::Canonical { value: ty, num_vars: 0 };
crate::ty::autoderef(db, &self.resolver, canonical).map(|canonical| canonical.value)
}
2019-04-12 16:56:57 -05:00
#[cfg(test)]
pub(crate) fn body_source_map(&self) -> Arc<BodySourceMap> {
2019-04-12 16:56:57 -05:00
self.body_source_map.clone().unwrap()
}
#[cfg(test)]
pub(crate) fn inference_result(&self) -> Arc<crate::ty::InferenceResult> {
self.infer.clone().unwrap()
}
#[cfg(test)]
pub(crate) fn scopes(&self) -> Arc<ExprScopes> {
self.scopes.clone().unwrap()
}
}
fn scope_for(
scopes: &ExprScopes,
source_map: &BodySourceMap,
node: &SyntaxNode,
) -> Option<ScopeId> {
node.ancestors()
2019-07-19 02:43:01 -05:00
.map(|it| SyntaxNodePtr::new(&it))
.filter_map(|ptr| source_map.syntax_expr(ptr))
.find_map(|it| scopes.scope_for(it))
}
fn scope_for_offset(
scopes: &ExprScopes,
source_map: &BodySourceMap,
offset: TextUnit,
) -> Option<ScopeId> {
scopes
2019-04-13 03:29:47 -05:00
.scope_by_expr()
.iter()
.filter_map(|(id, scope)| Some((source_map.expr_syntax(*id)?, scope)))
// find containing scope
.min_by_key(|(ptr, _scope)| {
(!(ptr.range().start() <= offset && offset <= ptr.range().end()), ptr.range().len())
})
.map(|(ptr, scope)| adjust(scopes, source_map, ptr, offset).unwrap_or(*scope))
}
// XXX: during completion, cursor might be outside of any particular
// expression. Try to figure out the correct scope...
fn adjust(
scopes: &ExprScopes,
source_map: &BodySourceMap,
ptr: SyntaxNodePtr,
offset: TextUnit,
) -> Option<ScopeId> {
let r = ptr.range();
let child_scopes = scopes
2019-04-13 03:29:47 -05:00
.scope_by_expr()
.iter()
.filter_map(|(id, scope)| Some((source_map.expr_syntax(*id)?, scope)))
.map(|(ptr, scope)| (ptr.range(), scope))
.filter(|(range, _)| range.start() <= offset && range.is_subrange(&r) && *range != r);
child_scopes
.max_by(|(r1, _), (r2, _)| {
if r2.is_subrange(&r1) {
std::cmp::Ordering::Greater
} else if r1.is_subrange(&r2) {
std::cmp::Ordering::Less
} else {
r1.start().cmp(&r2.start())
}
})
.map(|(_ptr, scope)| *scope)
2019-04-10 03:15:55 -05:00
}