1 use ra_db::{FileId, SourceDatabase};
3 AstNode, ast::{self, NameOwner},
4 algo::{find_node_at_offset, visit::{visitor, Visitor}},
7 use test_utils::tested_by;
10 use crate::{FilePosition, NavigationTarget, db::RootDatabase, RangeInfo};
12 pub(crate) fn goto_definition(
14 position: FilePosition,
15 ) -> Option<RangeInfo<Vec<NavigationTarget>>> {
16 let file = db.parse(position.file_id);
17 let syntax = file.syntax();
18 if let Some(name_ref) = find_node_at_offset::<ast::NameRef>(syntax, position.offset) {
19 let navs = reference_definition(db, position.file_id, name_ref).to_vec();
20 return Some(RangeInfo::new(name_ref.syntax().range(), navs.to_vec()));
22 if let Some(name) = find_node_at_offset::<ast::Name>(syntax, position.offset) {
23 let navs = name_definition(db, position.file_id, name)?;
24 return Some(RangeInfo::new(name.syntax().range(), navs));
29 pub(crate) enum ReferenceResult {
30 Exact(NavigationTarget),
31 Approximate(Vec<NavigationTarget>),
34 impl ReferenceResult {
35 fn to_vec(self) -> Vec<NavigationTarget> {
36 use self::ReferenceResult::*;
38 Exact(target) => vec![target],
39 Approximate(vec) => vec,
44 pub(crate) fn reference_definition(
47 name_ref: &ast::NameRef,
48 ) -> ReferenceResult {
49 use self::ReferenceResult::*;
50 if let Some(function) =
51 hir::source_binder::function_from_child_node(db, file_id, name_ref.syntax())
53 // Check if it is a method
54 if let Some(method_call) = name_ref.syntax().parent().and_then(ast::MethodCallExpr::cast) {
55 tested_by!(goto_definition_works_for_methods);
56 let infer_result = function.infer(db);
57 let syntax_mapping = function.body_syntax_mapping(db);
58 let expr = ast::Expr::cast(method_call.syntax()).unwrap();
60 syntax_mapping.node_expr(expr).and_then(|it| infer_result.method_resolution(it))
62 return Exact(NavigationTarget::from_function(db, func));
65 // It could also be a field access
66 if let Some(field_expr) = name_ref.syntax().parent().and_then(ast::FieldExpr::cast) {
67 tested_by!(goto_definition_works_for_fields);
68 let infer_result = function.infer(db);
69 let syntax_mapping = function.body_syntax_mapping(db);
70 let expr = ast::Expr::cast(field_expr.syntax()).unwrap();
72 syntax_mapping.node_expr(expr).and_then(|it| infer_result.field_resolution(it))
74 return Exact(NavigationTarget::from_field(db, field));
78 // Try name resolution
79 let resolver = hir::source_binder::resolver_for_node(db, file_id, name_ref.syntax());
81 name_ref.syntax().ancestors().find_map(ast::Path::cast).and_then(hir::Path::from_ast)
83 let resolved = resolver.resolve_path(db, &path);
84 match resolved.clone().take_types().or_else(|| resolved.take_values()) {
85 Some(Resolution::Def(def)) => return Exact(NavigationTarget::from_def(db, def)),
86 Some(Resolution::LocalBinding(pat)) => {
87 let body = resolver.body().expect("no body for local binding");
88 let syntax_mapping = body.syntax_mapping(db);
90 syntax_mapping.pat_syntax(pat).expect("pattern not found in syntax mapping");
92 path.as_ident().cloned().expect("local binding from a multi-segment path");
93 let nav = NavigationTarget::from_scope_entry(file_id, name, ptr);
96 Some(Resolution::GenericParam(..)) => {
97 // TODO: go to the generic param def
99 Some(Resolution::SelfType(_impl_block)) => {
100 // TODO: go to the implemented type
105 // If that fails try the index based approach.
106 let navs = crate::symbol_index::index_resolve(db, name_ref)
108 .map(NavigationTarget::from_symbol)
117 ) -> Option<Vec<NavigationTarget>> {
118 let parent = name.syntax().parent()?;
120 if let Some(module) = ast::Module::cast(&parent) {
121 if module.has_semi() {
122 if let Some(child_module) =
123 hir::source_binder::module_from_declaration(db, file_id, module)
125 let nav = NavigationTarget::from_module(db, child_module);
126 return Some(vec![nav]);
131 if let Some(nav) = named_target(file_id, &parent) {
132 return Some(vec![nav]);
138 fn named_target(file_id: FileId, node: &SyntaxNode) -> Option<NavigationTarget> {
139 fn to_nav_target<N: NameOwner>(node: &N, file_id: FileId) -> Option<NavigationTarget> {
140 Some(NavigationTarget::from_named(file_id, node))
144 .visit(|n: &ast::StructDef| to_nav_target(n, file_id))
145 .visit(|n: &ast::EnumDef| to_nav_target(n, file_id))
146 .visit(|n: &ast::EnumVariant| to_nav_target(n, file_id))
147 .visit(|n: &ast::FnDef| to_nav_target(n, file_id))
148 .visit(|n: &ast::TypeDef| to_nav_target(n, file_id))
149 .visit(|n: &ast::ConstDef| to_nav_target(n, file_id))
150 .visit(|n: &ast::StaticDef| to_nav_target(n, file_id))
151 .visit(|n: &ast::TraitDef| to_nav_target(n, file_id))
152 .visit(|n: &ast::NamedFieldDef| to_nav_target(n, file_id))
153 .visit(|n: &ast::Module| to_nav_target(n, file_id))
159 use test_utils::covers;
161 use crate::mock_analysis::analysis_and_position;
163 fn check_goto(fixture: &str, expected: &str) {
164 let (analysis, pos) = analysis_and_position(fixture);
166 let mut navs = analysis.goto_definition(pos).unwrap().unwrap().info;
167 assert_eq!(navs.len(), 1);
168 let nav = navs.pop().unwrap();
169 nav.assert_match(expected);
173 fn goto_definition_works_in_items() {
180 "Foo STRUCT_DEF FileId(1) [0; 11) [7; 10)",
185 fn goto_definition_resolves_correct_name() {
198 "Foo STRUCT_DEF FileId(2) [0; 11) [7; 10)",
203 fn goto_definition_works_for_module_declaration() {
211 "foo SOURCE_FILE FileId(2) [0; 10)",
221 "foo SOURCE_FILE FileId(2) [0; 10)",
226 fn goto_definition_works_for_methods() {
227 covers!(goto_definition_works_for_methods);
233 fn frobnicate(&self) { }
240 "frobnicate FN_DEF FileId(1) [27; 52) [30; 40)",
245 fn goto_definition_works_for_fields() {
246 covers!(goto_definition_works_for_fields);
258 "spam NAMED_FIELD_DEF FileId(1) [17; 26) [17; 21)",
263 fn goto_definition_works_when_used_on_definition_name_itself() {
267 struct Foo<|> { value: u32 }
269 "Foo STRUCT_DEF FileId(1) [0; 25) [7; 10)",
279 "field NAMED_FIELD_DEF FileId(1) [17; 30) [17; 22)",
288 "foo_test FN_DEF FileId(1) [0; 17) [3; 11)",
298 "Foo ENUM_DEF FileId(1) [0; 25) [5; 8)",
310 "Variant2 ENUM_VARIANT FileId(1) [29; 37) [29; 37)",
316 static inner<|>: &str = "";
318 "inner STATIC_DEF FileId(1) [0; 24) [7; 12)",
324 const inner<|>: &str = "";
326 "inner CONST_DEF FileId(1) [0; 23) [6; 11)",
332 type Thing<|> = Option<()>;
334 "Thing TYPE_DEF FileId(1) [0; 24) [5; 10)",
343 "Foo TRAIT_DEF FileId(1) [0; 13) [6; 9)",
352 "bar MODULE FileId(1) [0; 11) [4; 7)",