598 lines
20 KiB
Rust
598 lines
20 KiB
Rust
//! See [`NavigationTarget`].
|
|
|
|
use std::fmt;
|
|
|
|
use either::Either;
|
|
use hir::{
|
|
symbols::FileSymbol, AssocItem, Documentation, FieldSource, HasAttrs, HasSource, HirDisplay,
|
|
InFile, ModuleSource, Semantics,
|
|
};
|
|
use ide_db::{
|
|
base_db::{FileId, FileRange},
|
|
SymbolKind,
|
|
};
|
|
use ide_db::{defs::Definition, RootDatabase};
|
|
use syntax::{
|
|
ast::{self, HasName},
|
|
match_ast, AstNode, SmolStr, SyntaxNode, TextRange,
|
|
};
|
|
|
|
/// `NavigationTarget` represents an element in the editor's UI which you can
|
|
/// click on to navigate to a particular piece of code.
|
|
///
|
|
/// Typically, a `NavigationTarget` corresponds to some element in the source
|
|
/// code, like a function or a struct, but this is not strictly required.
|
|
#[derive(Clone, PartialEq, Eq, Hash)]
|
|
pub struct NavigationTarget {
|
|
pub file_id: FileId,
|
|
/// Range which encompasses the whole element.
|
|
///
|
|
/// Should include body, doc comments, attributes, etc.
|
|
///
|
|
/// Clients should use this range to answer "is the cursor inside the
|
|
/// element?" question.
|
|
pub full_range: TextRange,
|
|
/// A "most interesting" range within the `full_range`.
|
|
///
|
|
/// Typically, `full_range` is the whole syntax node, including doc
|
|
/// comments, and `focus_range` is the range of the identifier.
|
|
///
|
|
/// Clients should place the cursor on this range when navigating to this target.
|
|
pub focus_range: Option<TextRange>,
|
|
pub name: SmolStr,
|
|
pub kind: Option<SymbolKind>,
|
|
pub container_name: Option<SmolStr>,
|
|
pub description: Option<String>,
|
|
pub docs: Option<Documentation>,
|
|
}
|
|
|
|
impl fmt::Debug for NavigationTarget {
|
|
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
|
|
let mut f = f.debug_struct("NavigationTarget");
|
|
macro_rules! opt {
|
|
($($name:ident)*) => {$(
|
|
if let Some(it) = &self.$name {
|
|
f.field(stringify!($name), it);
|
|
}
|
|
)*}
|
|
}
|
|
f.field("file_id", &self.file_id).field("full_range", &self.full_range);
|
|
opt!(focus_range);
|
|
f.field("name", &self.name);
|
|
opt!(kind container_name description docs);
|
|
f.finish()
|
|
}
|
|
}
|
|
|
|
pub(crate) trait ToNav {
|
|
fn to_nav(&self, db: &RootDatabase) -> NavigationTarget;
|
|
}
|
|
|
|
pub(crate) trait TryToNav {
|
|
fn try_to_nav(&self, db: &RootDatabase) -> Option<NavigationTarget>;
|
|
}
|
|
|
|
impl<T: TryToNav, U: TryToNav> TryToNav for Either<T, U> {
|
|
fn try_to_nav(&self, db: &RootDatabase) -> Option<NavigationTarget> {
|
|
match self {
|
|
Either::Left(it) => it.try_to_nav(db),
|
|
Either::Right(it) => it.try_to_nav(db),
|
|
}
|
|
}
|
|
}
|
|
|
|
impl NavigationTarget {
|
|
pub fn focus_or_full_range(&self) -> TextRange {
|
|
self.focus_range.unwrap_or(self.full_range)
|
|
}
|
|
|
|
pub(crate) fn from_module_to_decl(db: &RootDatabase, module: hir::Module) -> NavigationTarget {
|
|
let name = module.name(db).map(|it| it.to_smol_str()).unwrap_or_default();
|
|
if let Some(src @ InFile { value, .. }) = &module.declaration_source(db) {
|
|
let FileRange { file_id, range: full_range } = src.syntax().original_file_range(db);
|
|
let focus_range =
|
|
value.name().and_then(|it| orig_focus_range(db, src.file_id, it.syntax()));
|
|
let mut res = NavigationTarget::from_syntax(
|
|
file_id,
|
|
name,
|
|
focus_range,
|
|
full_range,
|
|
SymbolKind::Module,
|
|
);
|
|
res.docs = module.attrs(db).docs();
|
|
res.description = Some(module.display(db).to_string());
|
|
return res;
|
|
}
|
|
module.to_nav(db)
|
|
}
|
|
|
|
#[cfg(test)]
|
|
pub(crate) fn debug_render(&self) -> String {
|
|
let mut buf = format!(
|
|
"{} {:?} {:?} {:?}",
|
|
self.name,
|
|
self.kind.unwrap(),
|
|
self.file_id,
|
|
self.full_range
|
|
);
|
|
if let Some(focus_range) = self.focus_range {
|
|
buf.push_str(&format!(" {:?}", focus_range))
|
|
}
|
|
if let Some(container_name) = &self.container_name {
|
|
buf.push_str(&format!(" {}", container_name))
|
|
}
|
|
buf
|
|
}
|
|
|
|
/// Allows `NavigationTarget` to be created from a `NameOwner`
|
|
pub(crate) fn from_named(
|
|
db: &RootDatabase,
|
|
node @ InFile { file_id, value }: InFile<&dyn ast::HasName>,
|
|
kind: SymbolKind,
|
|
) -> NavigationTarget {
|
|
let name = value.name().map(|it| it.text().into()).unwrap_or_else(|| "_".into());
|
|
let focus_range = value.name().and_then(|it| orig_focus_range(db, file_id, it.syntax()));
|
|
let FileRange { file_id, range } = node.map(|it| it.syntax()).original_file_range(db);
|
|
|
|
NavigationTarget::from_syntax(file_id, name, focus_range, range, kind)
|
|
}
|
|
|
|
fn from_syntax(
|
|
file_id: FileId,
|
|
name: SmolStr,
|
|
focus_range: Option<TextRange>,
|
|
full_range: TextRange,
|
|
kind: SymbolKind,
|
|
) -> NavigationTarget {
|
|
NavigationTarget {
|
|
file_id,
|
|
name,
|
|
kind: Some(kind),
|
|
full_range,
|
|
focus_range,
|
|
container_name: None,
|
|
description: None,
|
|
docs: None,
|
|
}
|
|
}
|
|
}
|
|
|
|
impl TryToNav for FileSymbol {
|
|
fn try_to_nav(&self, db: &RootDatabase) -> Option<NavigationTarget> {
|
|
let full_range = self.loc.original_range(db)?;
|
|
let name_range = self.loc.original_name_range(db)?;
|
|
|
|
Some(NavigationTarget {
|
|
file_id: full_range.file_id,
|
|
name: self.name.clone(),
|
|
kind: Some(self.kind.into()),
|
|
full_range: full_range.range,
|
|
focus_range: Some(name_range.range),
|
|
container_name: self.container_name.clone(),
|
|
description: description_from_symbol(db, self),
|
|
docs: None,
|
|
})
|
|
}
|
|
}
|
|
|
|
impl TryToNav for Definition {
|
|
fn try_to_nav(&self, db: &RootDatabase) -> Option<NavigationTarget> {
|
|
match self {
|
|
Definition::Local(it) => Some(it.to_nav(db)),
|
|
Definition::Label(it) => Some(it.to_nav(db)),
|
|
Definition::Module(it) => Some(it.to_nav(db)),
|
|
Definition::Macro(it) => it.try_to_nav(db),
|
|
Definition::Field(it) => it.try_to_nav(db),
|
|
Definition::SelfType(it) => it.try_to_nav(db),
|
|
Definition::GenericParam(it) => it.try_to_nav(db),
|
|
Definition::Function(it) => it.try_to_nav(db),
|
|
Definition::Adt(it) => it.try_to_nav(db),
|
|
Definition::Variant(it) => it.try_to_nav(db),
|
|
Definition::Const(it) => it.try_to_nav(db),
|
|
Definition::Static(it) => it.try_to_nav(db),
|
|
Definition::Trait(it) => it.try_to_nav(db),
|
|
Definition::TypeAlias(it) => it.try_to_nav(db),
|
|
Definition::BuiltinType(_) => None,
|
|
Definition::ToolModule(_) => None,
|
|
Definition::BuiltinAttr(_) => None,
|
|
}
|
|
}
|
|
}
|
|
|
|
impl TryToNav for hir::ModuleDef {
|
|
fn try_to_nav(&self, db: &RootDatabase) -> Option<NavigationTarget> {
|
|
match self {
|
|
hir::ModuleDef::Module(it) => Some(it.to_nav(db)),
|
|
hir::ModuleDef::Function(it) => it.try_to_nav(db),
|
|
hir::ModuleDef::Adt(it) => it.try_to_nav(db),
|
|
hir::ModuleDef::Variant(it) => it.try_to_nav(db),
|
|
hir::ModuleDef::Const(it) => it.try_to_nav(db),
|
|
hir::ModuleDef::Static(it) => it.try_to_nav(db),
|
|
hir::ModuleDef::Trait(it) => it.try_to_nav(db),
|
|
hir::ModuleDef::TypeAlias(it) => it.try_to_nav(db),
|
|
hir::ModuleDef::BuiltinType(_) => None,
|
|
}
|
|
}
|
|
}
|
|
|
|
pub(crate) trait ToNavFromAst {
|
|
const KIND: SymbolKind;
|
|
}
|
|
impl ToNavFromAst for hir::Function {
|
|
const KIND: SymbolKind = SymbolKind::Function;
|
|
}
|
|
impl ToNavFromAst for hir::Const {
|
|
const KIND: SymbolKind = SymbolKind::Const;
|
|
}
|
|
impl ToNavFromAst for hir::Static {
|
|
const KIND: SymbolKind = SymbolKind::Static;
|
|
}
|
|
impl ToNavFromAst for hir::Struct {
|
|
const KIND: SymbolKind = SymbolKind::Struct;
|
|
}
|
|
impl ToNavFromAst for hir::Enum {
|
|
const KIND: SymbolKind = SymbolKind::Enum;
|
|
}
|
|
impl ToNavFromAst for hir::Variant {
|
|
const KIND: SymbolKind = SymbolKind::Variant;
|
|
}
|
|
impl ToNavFromAst for hir::Union {
|
|
const KIND: SymbolKind = SymbolKind::Union;
|
|
}
|
|
impl ToNavFromAst for hir::TypeAlias {
|
|
const KIND: SymbolKind = SymbolKind::TypeAlias;
|
|
}
|
|
impl ToNavFromAst for hir::Trait {
|
|
const KIND: SymbolKind = SymbolKind::Trait;
|
|
}
|
|
|
|
impl<D> TryToNav for D
|
|
where
|
|
D: HasSource + ToNavFromAst + Copy + HasAttrs + HirDisplay,
|
|
D::Ast: ast::HasName,
|
|
{
|
|
fn try_to_nav(&self, db: &RootDatabase) -> Option<NavigationTarget> {
|
|
let src = self.source(db)?;
|
|
let mut res = NavigationTarget::from_named(
|
|
db,
|
|
src.as_ref().map(|it| it as &dyn ast::HasName),
|
|
D::KIND,
|
|
);
|
|
res.docs = self.docs(db);
|
|
res.description = Some(self.display(db).to_string());
|
|
Some(res)
|
|
}
|
|
}
|
|
|
|
impl ToNav for hir::Module {
|
|
fn to_nav(&self, db: &RootDatabase) -> NavigationTarget {
|
|
let InFile { file_id, value } = self.definition_source(db);
|
|
|
|
let name = self.name(db).map(|it| it.to_smol_str()).unwrap_or_default();
|
|
let (syntax, focus) = match &value {
|
|
ModuleSource::SourceFile(node) => (node.syntax(), None),
|
|
ModuleSource::Module(node) => (
|
|
node.syntax(),
|
|
node.name().and_then(|it| orig_focus_range(db, file_id, it.syntax())),
|
|
),
|
|
ModuleSource::BlockExpr(node) => (node.syntax(), None),
|
|
};
|
|
let FileRange { file_id, range: full_range } =
|
|
InFile::new(file_id, syntax).original_file_range(db);
|
|
NavigationTarget::from_syntax(file_id, name, focus, full_range, SymbolKind::Module)
|
|
}
|
|
}
|
|
|
|
impl TryToNav for hir::Impl {
|
|
fn try_to_nav(&self, db: &RootDatabase) -> Option<NavigationTarget> {
|
|
let InFile { file_id, value } = self.source(db)?;
|
|
let derive_attr = self.is_builtin_derive(db);
|
|
|
|
let focus_range = if derive_attr.is_some() {
|
|
None
|
|
} else {
|
|
value.self_ty().and_then(|ty| orig_focus_range(db, file_id, ty.syntax()))
|
|
};
|
|
|
|
let FileRange { file_id, range: full_range } = match &derive_attr {
|
|
Some(attr) => attr.syntax().original_file_range(db),
|
|
None => InFile::new(file_id, value.syntax()).original_file_range(db),
|
|
};
|
|
|
|
Some(NavigationTarget::from_syntax(
|
|
file_id,
|
|
"impl".into(),
|
|
focus_range,
|
|
full_range,
|
|
SymbolKind::Impl,
|
|
))
|
|
}
|
|
}
|
|
|
|
impl TryToNav for hir::Field {
|
|
fn try_to_nav(&self, db: &RootDatabase) -> Option<NavigationTarget> {
|
|
let src = self.source(db)?;
|
|
|
|
let field_source = match &src.value {
|
|
FieldSource::Named(it) => {
|
|
let mut res =
|
|
NavigationTarget::from_named(db, src.with_value(it), SymbolKind::Field);
|
|
res.docs = self.docs(db);
|
|
res.description = Some(self.display(db).to_string());
|
|
res
|
|
}
|
|
FieldSource::Pos(it) => {
|
|
let FileRange { file_id, range } =
|
|
src.with_value(it.syntax()).original_file_range(db);
|
|
NavigationTarget::from_syntax(file_id, "".into(), None, range, SymbolKind::Field)
|
|
}
|
|
};
|
|
Some(field_source)
|
|
}
|
|
}
|
|
|
|
impl TryToNav for hir::MacroDef {
|
|
fn try_to_nav(&self, db: &RootDatabase) -> Option<NavigationTarget> {
|
|
let src = self.source(db)?;
|
|
let name_owner: &dyn ast::HasName = match &src.value {
|
|
Either::Left(it) => it,
|
|
Either::Right(it) => it,
|
|
};
|
|
tracing::debug!("nav target {:#?}", name_owner.syntax());
|
|
let mut res = NavigationTarget::from_named(
|
|
db,
|
|
src.as_ref().with_value(name_owner),
|
|
self.kind().into(),
|
|
);
|
|
res.docs = self.docs(db);
|
|
Some(res)
|
|
}
|
|
}
|
|
|
|
impl TryToNav for hir::Adt {
|
|
fn try_to_nav(&self, db: &RootDatabase) -> Option<NavigationTarget> {
|
|
match self {
|
|
hir::Adt::Struct(it) => it.try_to_nav(db),
|
|
hir::Adt::Union(it) => it.try_to_nav(db),
|
|
hir::Adt::Enum(it) => it.try_to_nav(db),
|
|
}
|
|
}
|
|
}
|
|
|
|
impl TryToNav for hir::AssocItem {
|
|
fn try_to_nav(&self, db: &RootDatabase) -> Option<NavigationTarget> {
|
|
match self {
|
|
AssocItem::Function(it) => it.try_to_nav(db),
|
|
AssocItem::Const(it) => it.try_to_nav(db),
|
|
AssocItem::TypeAlias(it) => it.try_to_nav(db),
|
|
}
|
|
}
|
|
}
|
|
|
|
impl TryToNav for hir::GenericParam {
|
|
fn try_to_nav(&self, db: &RootDatabase) -> Option<NavigationTarget> {
|
|
match self {
|
|
hir::GenericParam::TypeParam(it) => it.try_to_nav(db),
|
|
hir::GenericParam::ConstParam(it) => it.try_to_nav(db),
|
|
hir::GenericParam::LifetimeParam(it) => it.try_to_nav(db),
|
|
}
|
|
}
|
|
}
|
|
|
|
impl ToNav for hir::Local {
|
|
fn to_nav(&self, db: &RootDatabase) -> NavigationTarget {
|
|
let InFile { file_id, value } = self.source(db);
|
|
let (node, name) = match &value {
|
|
Either::Left(bind_pat) => (bind_pat.syntax(), bind_pat.name()),
|
|
Either::Right(it) => (it.syntax(), it.name()),
|
|
};
|
|
let focus_range = name.and_then(|it| orig_focus_range(db, file_id, it.syntax()));
|
|
let FileRange { file_id, range: full_range } =
|
|
InFile::new(file_id, node).original_file_range(db);
|
|
|
|
let name = self.name(db).to_smol_str();
|
|
let kind = if self.is_self(db) {
|
|
SymbolKind::SelfParam
|
|
} else if self.is_param(db) {
|
|
SymbolKind::ValueParam
|
|
} else {
|
|
SymbolKind::Local
|
|
};
|
|
NavigationTarget {
|
|
file_id,
|
|
name,
|
|
kind: Some(kind),
|
|
full_range,
|
|
focus_range,
|
|
container_name: None,
|
|
description: None,
|
|
docs: None,
|
|
}
|
|
}
|
|
}
|
|
|
|
impl ToNav for hir::Label {
|
|
fn to_nav(&self, db: &RootDatabase) -> NavigationTarget {
|
|
let InFile { file_id, value } = self.source(db);
|
|
let name = self.name(db).to_smol_str();
|
|
|
|
let range = |syntax: &_| InFile::new(file_id, syntax).original_file_range(db);
|
|
let FileRange { file_id, range: full_range } = range(value.syntax());
|
|
let focus_range = value.lifetime().map(|lt| range(lt.syntax()).range);
|
|
|
|
NavigationTarget {
|
|
file_id,
|
|
name,
|
|
kind: Some(SymbolKind::Label),
|
|
full_range,
|
|
focus_range,
|
|
container_name: None,
|
|
description: None,
|
|
docs: None,
|
|
}
|
|
}
|
|
}
|
|
|
|
impl TryToNav for hir::TypeParam {
|
|
fn try_to_nav(&self, db: &RootDatabase) -> Option<NavigationTarget> {
|
|
let InFile { file_id, value } = self.source(db)?;
|
|
let name = self.name(db).to_smol_str();
|
|
|
|
let range = |syntax: &_| InFile::new(file_id, syntax).original_file_range(db);
|
|
let focus_range = |syntax: &_| InFile::new(file_id, syntax).original_file_range_opt(db);
|
|
let FileRange { file_id, range: full_range } = match &value {
|
|
Either::Left(type_param) => range(type_param.syntax()),
|
|
Either::Right(trait_) => trait_
|
|
.name()
|
|
.and_then(|name| focus_range(name.syntax()))
|
|
.unwrap_or_else(|| range(trait_.syntax())),
|
|
};
|
|
let focus_range = value
|
|
.either(|it| it.name(), |it| it.name())
|
|
.and_then(|it| focus_range(it.syntax()))
|
|
.map(|it| it.range);
|
|
Some(NavigationTarget {
|
|
file_id,
|
|
name,
|
|
kind: Some(SymbolKind::TypeParam),
|
|
full_range,
|
|
focus_range,
|
|
container_name: None,
|
|
description: None,
|
|
docs: None,
|
|
})
|
|
}
|
|
}
|
|
|
|
impl TryToNav for hir::LifetimeParam {
|
|
fn try_to_nav(&self, db: &RootDatabase) -> Option<NavigationTarget> {
|
|
let InFile { file_id, value } = self.source(db)?;
|
|
let name = self.name(db).to_smol_str();
|
|
|
|
let FileRange { file_id, range: full_range } =
|
|
InFile::new(file_id, value.syntax()).original_file_range(db);
|
|
Some(NavigationTarget {
|
|
file_id,
|
|
name,
|
|
kind: Some(SymbolKind::LifetimeParam),
|
|
full_range,
|
|
focus_range: Some(full_range),
|
|
container_name: None,
|
|
description: None,
|
|
docs: None,
|
|
})
|
|
}
|
|
}
|
|
|
|
impl TryToNav for hir::ConstParam {
|
|
fn try_to_nav(&self, db: &RootDatabase) -> Option<NavigationTarget> {
|
|
let InFile { file_id, value } = self.source(db)?;
|
|
let name = self.name(db).to_smol_str();
|
|
|
|
let focus_range = value.name().and_then(|it| orig_focus_range(db, file_id, it.syntax()));
|
|
let FileRange { file_id, range: full_range } =
|
|
InFile::new(file_id, value.syntax()).original_file_range(db);
|
|
Some(NavigationTarget {
|
|
file_id,
|
|
name,
|
|
kind: Some(SymbolKind::ConstParam),
|
|
full_range,
|
|
focus_range,
|
|
container_name: None,
|
|
description: None,
|
|
docs: None,
|
|
})
|
|
}
|
|
}
|
|
|
|
/// Get a description of a symbol.
|
|
///
|
|
/// e.g. `struct Name`, `enum Name`, `fn Name`
|
|
pub(crate) fn description_from_symbol(db: &RootDatabase, symbol: &FileSymbol) -> Option<String> {
|
|
let sema = Semantics::new(db);
|
|
let node = symbol.loc.syntax(&sema)?;
|
|
|
|
match_ast! {
|
|
match node {
|
|
ast::Fn(it) => sema.to_def(&it).map(|it| it.display(db).to_string()),
|
|
ast::Struct(it) => sema.to_def(&it).map(|it| it.display(db).to_string()),
|
|
ast::Enum(it) => sema.to_def(&it).map(|it| it.display(db).to_string()),
|
|
ast::Trait(it) => sema.to_def(&it).map(|it| it.display(db).to_string()),
|
|
ast::Module(it) => sema.to_def(&it).map(|it| it.display(db).to_string()),
|
|
ast::TypeAlias(it) => sema.to_def(&it).map(|it| it.display(db).to_string()),
|
|
ast::Const(it) => sema.to_def(&it).map(|it| it.display(db).to_string()),
|
|
ast::Static(it) => sema.to_def(&it).map(|it| it.display(db).to_string()),
|
|
ast::RecordField(it) => sema.to_def(&it).map(|it| it.display(db).to_string()),
|
|
ast::Variant(it) => sema.to_def(&it).map(|it| it.display(db).to_string()),
|
|
ast::Union(it) => sema.to_def(&it).map(|it| it.display(db).to_string()),
|
|
_ => None,
|
|
}
|
|
}
|
|
}
|
|
|
|
fn orig_focus_range(
|
|
db: &RootDatabase,
|
|
file_id: hir::HirFileId,
|
|
syntax: &SyntaxNode,
|
|
) -> Option<TextRange> {
|
|
InFile::new(file_id, syntax).original_file_range_opt(db).map(|it| it.range)
|
|
}
|
|
|
|
#[cfg(test)]
|
|
mod tests {
|
|
use expect_test::expect;
|
|
|
|
use crate::{fixture, Query};
|
|
|
|
#[test]
|
|
fn test_nav_for_symbol() {
|
|
let (analysis, _) = fixture::file(
|
|
r#"
|
|
enum FooInner { }
|
|
fn foo() { enum FooInner { } }
|
|
"#,
|
|
);
|
|
|
|
let navs = analysis.symbol_search(Query::new("FooInner".to_string())).unwrap();
|
|
expect![[r#"
|
|
[
|
|
NavigationTarget {
|
|
file_id: FileId(
|
|
0,
|
|
),
|
|
full_range: 0..17,
|
|
focus_range: 5..13,
|
|
name: "FooInner",
|
|
kind: Enum,
|
|
description: "enum FooInner",
|
|
},
|
|
NavigationTarget {
|
|
file_id: FileId(
|
|
0,
|
|
),
|
|
full_range: 29..46,
|
|
focus_range: 34..42,
|
|
name: "FooInner",
|
|
kind: Enum,
|
|
container_name: "foo",
|
|
description: "enum FooInner",
|
|
},
|
|
]
|
|
"#]]
|
|
.assert_debug_eq(&navs);
|
|
}
|
|
|
|
#[test]
|
|
fn test_world_symbols_are_case_sensitive() {
|
|
let (analysis, _) = fixture::file(
|
|
r#"
|
|
fn foo() {}
|
|
struct Foo;
|
|
"#,
|
|
);
|
|
|
|
let navs = analysis.symbol_search(Query::new("foo".to_string())).unwrap();
|
|
assert_eq!(navs.len(), 2)
|
|
}
|
|
}
|