3 SyntaxNode, AstNode, SmolStr, TextRange, ast,
4 SyntaxKind::{self, NAME},
6 use hir::{Def, ModuleSource};
8 use crate::{FileSymbol, db::RootDatabase};
10 /// `NavigationTarget` represents and element in the editor's UI which you can
11 /// click on to navigate to a particular piece of code.
13 /// Typically, a `NavigationTarget` corresponds to some element in the source
14 /// code, like a function or a struct, but this is not strictly required.
15 #[derive(Debug, Clone)]
16 pub struct NavigationTarget {
20 full_range: TextRange,
21 focus_range: Option<TextRange>,
24 impl NavigationTarget {
25 pub fn name(&self) -> &SmolStr {
29 pub fn kind(&self) -> SyntaxKind {
33 pub fn file_id(&self) -> FileId {
37 pub fn full_range(&self) -> TextRange {
41 /// A "most interesting" range withing the `range_full`.
43 /// Typically, `range` is the whole syntax node, including doc comments, and
44 /// `focus_range` is the range of the identifier.
45 pub fn focus_range(&self) -> Option<TextRange> {
49 pub(crate) fn from_symbol(symbol: FileSymbol) -> NavigationTarget {
51 file_id: symbol.file_id,
52 name: symbol.name.clone(),
53 kind: symbol.ptr.kind(),
54 full_range: symbol.ptr.range(),
59 pub(crate) fn from_scope_entry(
61 entry: &hir::ScopeEntryWithSyntax,
62 ) -> NavigationTarget {
65 name: entry.name().to_string().into(),
66 full_range: entry.ptr().range(),
72 pub(crate) fn from_module(db: &RootDatabase, module: hir::Module) -> NavigationTarget {
73 let (file_id, source) = module.definition_source(db);
76 .map(|it| it.to_string().into())
79 ModuleSource::SourceFile(node) => {
80 NavigationTarget::from_syntax(file_id, name, None, node.syntax())
82 ModuleSource::Module(node) => {
83 NavigationTarget::from_syntax(file_id, name, None, node.syntax())
88 pub(crate) fn from_module_to_decl(db: &RootDatabase, module: hir::Module) -> NavigationTarget {
91 .map(|it| it.to_string().into())
93 if let Some((file_id, source)) = module.declaration_source(db) {
94 return NavigationTarget::from_syntax(file_id, name, None, source.syntax());
96 NavigationTarget::from_module(db, module)
99 // TODO once Def::Item is gone, this should be able to always return a NavigationTarget
100 pub(crate) fn from_def(db: &RootDatabase, def: Def) -> Option<NavigationTarget> {
101 let res = match def {
103 let (file_id, node) = s.source(db);
104 NavigationTarget::from_named(file_id.original_file(db), &*node)
107 let (file_id, node) = e.source(db);
108 NavigationTarget::from_named(file_id.original_file(db), &*node)
110 Def::EnumVariant(ev) => {
111 let (file_id, node) = ev.source(db);
112 NavigationTarget::from_named(file_id.original_file(db), &*node)
114 Def::Function(f) => {
115 let (file_id, node) = f.source(db);
116 NavigationTarget::from_named(file_id.original_file(db), &*node)
119 let (file_id, node) = f.source(db);
120 NavigationTarget::from_named(file_id.original_file(db), &*node)
123 let (file_id, node) = f.source(db);
124 NavigationTarget::from_named(file_id.original_file(db), &*node)
127 let (file_id, node) = f.source(db);
128 NavigationTarget::from_named(file_id.original_file(db), &*node)
131 let (file_id, node) = f.source(db);
132 NavigationTarget::from_named(file_id.original_file(db), &*node)
134 Def::Module(m) => NavigationTarget::from_module(db, m),
135 Def::Item => return None,
141 pub(crate) fn assert_match(&self, expected: &str) {
142 let actual = self.debug_render();
143 test_utils::assert_eq_text!(expected.trim(), actual.trim(),);
147 pub(crate) fn debug_render(&self) -> String {
148 let mut buf = format!(
155 if let Some(focus_range) = self.focus_range() {
156 buf.push_str(&format!(" {:?}", focus_range))
161 fn from_named(file_id: FileId, node: &impl ast::NameOwner) -> NavigationTarget {
162 let name = node.name().map(|it| it.text().clone()).unwrap_or_default();
163 let focus_range = node.name().map(|it| it.syntax().range());
164 NavigationTarget::from_syntax(file_id, name, focus_range, node.syntax())
170 focus_range: Option<TextRange>,
172 ) -> NavigationTarget {
177 full_range: node.range(),
179 // ptr: Some(LocalSyntaxPtr::new(node)),