1 //! FIXME: write short doc here
5 AssocItem, Documentation, FieldSource, HasAttrs, HasSource, HirFileId, InFile, ModuleSource,
7 use ide_db::base_db::{FileId, SourceDatabase};
8 use ide_db::{defs::Definition, RootDatabase};
10 ast::{self, NameOwner},
11 match_ast, AstNode, SmolStr,
12 SyntaxKind::{self, IDENT_PAT, LIFETIME_PARAM, TYPE_PARAM},
16 use crate::FileSymbol;
18 use super::short_label::ShortLabel;
20 /// `NavigationTarget` represents and element in the editor's UI which you can
21 /// click on to navigate to a particular piece of code.
23 /// Typically, a `NavigationTarget` corresponds to some element in the source
24 /// code, like a function or a struct, but this is not strictly required.
25 #[derive(Debug, Clone, PartialEq, Eq, Hash)]
26 pub struct NavigationTarget {
28 /// Range which encompasses the whole element.
30 /// Should include body, doc comments, attributes, etc.
32 /// Clients should use this range to answer "is the cursor inside the
33 /// element?" question.
34 pub full_range: TextRange,
35 /// A "most interesting" range withing the `full_range`.
37 /// Typically, `full_range` is the whole syntax node, including doc
38 /// comments, and `focus_range` is the range of the identifier. "Most
39 /// interesting" range within the full range, typically the range of
42 /// Clients should place the cursor on this range when navigating to this target.
43 pub focus_range: Option<TextRange>,
46 pub container_name: Option<SmolStr>,
47 pub description: Option<String>,
48 pub docs: Option<Documentation>,
51 pub(crate) trait ToNav {
52 fn to_nav(&self, db: &RootDatabase) -> NavigationTarget;
55 pub(crate) trait TryToNav {
56 fn try_to_nav(&self, db: &RootDatabase) -> Option<NavigationTarget>;
59 impl NavigationTarget {
60 pub fn focus_or_full_range(&self) -> TextRange {
61 self.focus_range.unwrap_or(self.full_range)
64 pub(crate) fn from_module_to_decl(db: &RootDatabase, module: hir::Module) -> NavigationTarget {
65 let name = module.name(db).map(|it| it.to_string().into()).unwrap_or_default();
66 if let Some(src) = module.declaration_source(db) {
67 let node = src.as_ref().map(|it| it.syntax());
68 let frange = node.original_file_range(db);
69 let mut res = NavigationTarget::from_syntax(
74 src.value.syntax().kind(),
76 res.docs = module.attrs(db).docs();
77 res.description = src.value.short_label();
84 pub(crate) fn assert_match(&self, expected: &str) {
85 let actual = self.debug_render();
86 test_utils::assert_eq_text!(expected.trim(), actual.trim(),);
90 pub(crate) fn debug_render(&self) -> String {
92 format!("{} {:?} {:?} {:?}", self.name, self.kind, self.file_id, self.full_range);
93 if let Some(focus_range) = self.focus_range {
94 buf.push_str(&format!(" {:?}", focus_range))
96 if let Some(container_name) = &self.container_name {
97 buf.push_str(&format!(" {}", container_name))
102 /// Allows `NavigationTarget` to be created from a `NameOwner`
103 pub(crate) fn from_named(
105 node: InFile<&dyn ast::NameOwner>,
106 ) -> NavigationTarget {
108 node.value.name().map(|it| it.text().clone()).unwrap_or_else(|| SmolStr::new("_"));
110 node.value.name().map(|it| node.with_value(it.syntax()).original_file_range(db).range);
111 let frange = node.map(|it| it.syntax()).original_file_range(db);
113 NavigationTarget::from_syntax(
118 node.value.syntax().kind(),
122 /// Allows `NavigationTarget` to be created from a `DocCommentsOwner` and a `NameOwner`
123 pub(crate) fn from_doc_commented(
125 named: InFile<&dyn ast::NameOwner>,
126 node: InFile<&dyn ast::DocCommentsOwner>,
127 ) -> NavigationTarget {
129 named.value.name().map(|it| it.text().clone()).unwrap_or_else(|| SmolStr::new("_"));
130 let frange = node.map(|it| it.syntax()).original_file_range(db);
132 NavigationTarget::from_syntax(
137 node.value.syntax().kind(),
144 focus_range: Option<TextRange>,
145 full_range: TextRange,
147 ) -> NavigationTarget {
154 container_name: None,
161 impl ToNav for FileSymbol {
162 fn to_nav(&self, db: &RootDatabase) -> NavigationTarget {
164 file_id: self.file_id,
165 name: self.name.clone(),
167 full_range: self.range,
168 focus_range: self.name_range,
169 container_name: self.container_name.clone(),
170 description: description_from_symbol(db, self),
171 docs: docs_from_symbol(db, self),
176 impl TryToNav for Definition {
177 fn try_to_nav(&self, db: &RootDatabase) -> Option<NavigationTarget> {
179 Definition::Macro(it) => Some(it.to_nav(db)),
180 Definition::Field(it) => Some(it.to_nav(db)),
181 Definition::ModuleDef(it) => it.try_to_nav(db),
182 Definition::SelfType(it) => Some(it.to_nav(db)),
183 Definition::Local(it) => Some(it.to_nav(db)),
184 Definition::TypeParam(it) => Some(it.to_nav(db)),
185 Definition::LifetimeParam(it) => Some(it.to_nav(db)),
190 impl TryToNav for hir::ModuleDef {
191 fn try_to_nav(&self, db: &RootDatabase) -> Option<NavigationTarget> {
192 let res = match self {
193 hir::ModuleDef::Module(it) => it.to_nav(db),
194 hir::ModuleDef::Function(it) => it.to_nav(db),
195 hir::ModuleDef::Adt(it) => it.to_nav(db),
196 hir::ModuleDef::EnumVariant(it) => it.to_nav(db),
197 hir::ModuleDef::Const(it) => it.to_nav(db),
198 hir::ModuleDef::Static(it) => it.to_nav(db),
199 hir::ModuleDef::Trait(it) => it.to_nav(db),
200 hir::ModuleDef::TypeAlias(it) => it.to_nav(db),
201 hir::ModuleDef::BuiltinType(_) => return None,
207 pub(crate) trait ToNavFromAst {}
208 impl ToNavFromAst for hir::Function {}
209 impl ToNavFromAst for hir::Const {}
210 impl ToNavFromAst for hir::Static {}
211 impl ToNavFromAst for hir::Struct {}
212 impl ToNavFromAst for hir::Enum {}
213 impl ToNavFromAst for hir::EnumVariant {}
214 impl ToNavFromAst for hir::Union {}
215 impl ToNavFromAst for hir::TypeAlias {}
216 impl ToNavFromAst for hir::Trait {}
220 D: HasSource + ToNavFromAst + Copy + HasAttrs,
221 D::Ast: ast::NameOwner + ShortLabel,
223 fn to_nav(&self, db: &RootDatabase) -> NavigationTarget {
224 let src = self.source(db);
226 NavigationTarget::from_named(db, src.as_ref().map(|it| it as &dyn ast::NameOwner));
227 res.docs = self.docs(db);
228 res.description = src.value.short_label();
233 impl ToNav for hir::Module {
234 fn to_nav(&self, db: &RootDatabase) -> NavigationTarget {
235 let src = self.definition_source(db);
236 let name = self.name(db).map(|it| it.to_string().into()).unwrap_or_default();
237 let (syntax, focus) = match &src.value {
238 ModuleSource::SourceFile(node) => (node.syntax(), None),
239 ModuleSource::Module(node) => {
240 (node.syntax(), node.name().map(|it| it.syntax().text_range()))
243 let frange = src.with_value(syntax).original_file_range(db);
244 NavigationTarget::from_syntax(frange.file_id, name, focus, frange.range, syntax.kind())
248 impl ToNav for hir::ImplDef {
249 fn to_nav(&self, db: &RootDatabase) -> NavigationTarget {
250 let src = self.source(db);
251 let derive_attr = self.is_builtin_derive(db);
252 let frange = if let Some(item) = &derive_attr {
253 item.syntax().original_file_range(db)
255 src.as_ref().map(|it| it.syntax()).original_file_range(db)
257 let focus_range = if derive_attr.is_some() {
260 src.value.self_ty().map(|ty| src.with_value(ty.syntax()).original_file_range(db).range)
263 NavigationTarget::from_syntax(
268 src.value.syntax().kind(),
273 impl ToNav for hir::Field {
274 fn to_nav(&self, db: &RootDatabase) -> NavigationTarget {
275 let src = self.source(db);
278 FieldSource::Named(it) => {
279 let mut res = NavigationTarget::from_named(db, src.with_value(it));
280 res.docs = self.docs(db);
281 res.description = it.short_label();
284 FieldSource::Pos(it) => {
285 let frange = src.with_value(it.syntax()).original_file_range(db);
286 NavigationTarget::from_syntax(
298 impl ToNav for hir::MacroDef {
299 fn to_nav(&self, db: &RootDatabase) -> NavigationTarget {
300 let src = self.source(db);
301 log::debug!("nav target {:#?}", src.value.syntax());
303 NavigationTarget::from_named(db, src.as_ref().map(|it| it as &dyn ast::NameOwner));
304 res.docs = self.docs(db);
309 impl ToNav for hir::Adt {
310 fn to_nav(&self, db: &RootDatabase) -> NavigationTarget {
312 hir::Adt::Struct(it) => it.to_nav(db),
313 hir::Adt::Union(it) => it.to_nav(db),
314 hir::Adt::Enum(it) => it.to_nav(db),
319 impl ToNav for hir::AssocItem {
320 fn to_nav(&self, db: &RootDatabase) -> NavigationTarget {
322 AssocItem::Function(it) => it.to_nav(db),
323 AssocItem::Const(it) => it.to_nav(db),
324 AssocItem::TypeAlias(it) => it.to_nav(db),
329 impl ToNav for hir::Local {
330 fn to_nav(&self, db: &RootDatabase) -> NavigationTarget {
331 let src = self.source(db);
332 let node = match &src.value {
333 Either::Left(bind_pat) => {
334 bind_pat.name().map_or_else(|| bind_pat.syntax().clone(), |it| it.syntax().clone())
336 Either::Right(it) => it.syntax().clone(),
338 let full_range = src.with_value(&node).original_file_range(db);
339 let name = match self.name(db) {
340 Some(it) => it.to_string().into(),
344 file_id: full_range.file_id,
347 full_range: full_range.range,
349 container_name: None,
356 impl ToNav for hir::TypeParam {
357 fn to_nav(&self, db: &RootDatabase) -> NavigationTarget {
358 let src = self.source(db);
359 let full_range = match &src.value {
360 Either::Left(it) => it.syntax().text_range(),
361 Either::Right(it) => it.syntax().text_range(),
363 let focus_range = match &src.value {
364 Either::Left(_) => None,
365 Either::Right(it) => it.name().map(|it| it.syntax().text_range()),
368 file_id: src.file_id.original_file(db),
369 name: self.name(db).to_string().into(),
373 container_name: None,
380 impl ToNav for hir::LifetimeParam {
381 fn to_nav(&self, db: &RootDatabase) -> NavigationTarget {
382 let src = self.source(db);
383 let full_range = src.value.syntax().text_range();
385 file_id: src.file_id.original_file(db),
386 name: self.name(db).to_string().into(),
387 kind: LIFETIME_PARAM,
389 focus_range: Some(full_range),
390 container_name: None,
397 pub(crate) fn docs_from_symbol(db: &RootDatabase, symbol: &FileSymbol) -> Option<Documentation> {
398 let parse = db.parse(symbol.file_id);
399 let node = symbol.ptr.to_node(parse.tree().syntax());
400 let file_id = HirFileId::from(symbol.file_id);
402 let it = match_ast! {
404 ast::Fn(it) => hir::Attrs::from_attrs_owner(db, InFile::new(file_id, &it)),
405 ast::Struct(it) => hir::Attrs::from_attrs_owner(db, InFile::new(file_id, &it)),
406 ast::Enum(it) => hir::Attrs::from_attrs_owner(db, InFile::new(file_id, &it)),
407 ast::Trait(it) => hir::Attrs::from_attrs_owner(db, InFile::new(file_id, &it)),
408 ast::Module(it) => hir::Attrs::from_attrs_owner(db, InFile::new(file_id, &it)),
409 ast::TypeAlias(it) => hir::Attrs::from_attrs_owner(db, InFile::new(file_id, &it)),
410 ast::Const(it) => hir::Attrs::from_attrs_owner(db, InFile::new(file_id, &it)),
411 ast::Static(it) => hir::Attrs::from_attrs_owner(db, InFile::new(file_id, &it)),
412 ast::RecordField(it) => hir::Attrs::from_attrs_owner(db, InFile::new(file_id, &it)),
413 ast::Variant(it) => hir::Attrs::from_attrs_owner(db, InFile::new(file_id, &it)),
414 ast::MacroCall(it) => hir::Attrs::from_attrs_owner(db, InFile::new(file_id, &it)),
421 /// Get a description of a symbol.
423 /// e.g. `struct Name`, `enum Name`, `fn Name`
424 pub(crate) fn description_from_symbol(db: &RootDatabase, symbol: &FileSymbol) -> Option<String> {
425 let parse = db.parse(symbol.file_id);
426 let node = symbol.ptr.to_node(parse.tree().syntax());
430 ast::Fn(it) => it.short_label(),
431 ast::Struct(it) => it.short_label(),
432 ast::Enum(it) => it.short_label(),
433 ast::Trait(it) => it.short_label(),
434 ast::Module(it) => it.short_label(),
435 ast::TypeAlias(it) => it.short_label(),
436 ast::Const(it) => it.short_label(),
437 ast::Static(it) => it.short_label(),
438 ast::RecordField(it) => it.short_label(),
439 ast::Variant(it) => it.short_label(),
447 use expect_test::expect;
449 use crate::{fixture, Query};
452 fn test_nav_for_symbol() {
453 let (analysis, _) = fixture::file(
456 fn foo() { enum FooInner { } }
460 let navs = analysis.symbol_search(Query::new("FooInner".to_string())).unwrap();
473 container_name: None,
489 container_name: Some(
499 .assert_debug_eq(&navs);
503 fn test_world_symbols_are_case_sensitive() {
504 let (analysis, _) = fixture::file(
511 let navs = analysis.symbol_search(Query::new("foo".to_string())).unwrap();
512 assert_eq!(navs.len(), 2)