crates/ra_ide_api/src/navigation_target.rs

   1 use ra_db::FileId;
   2 use ra_syntax::{
   3     SyntaxNode, AstNode, SmolStr, TextRange, ast,
   4     SyntaxKind::{self, NAME},
   5 };
   6 use hir::{ModuleSource};
   7
   8 use crate::{FileSymbol, db::RootDatabase};
   9
  10 /// `NavigationTarget` represents and element in the editor's UI which you can
  11 /// click on to navigate to a particular piece of code.
  12 ///
  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 {
  17     file_id: FileId,
  18     name: SmolStr,
  19     kind: SyntaxKind,
  20     full_range: TextRange,
  21     focus_range: Option<TextRange>,
  22 }
  23
  24 impl NavigationTarget {
  25     pub fn name(&self) -> &SmolStr {
  26         &self.name
  27     }
  28
  29     pub fn kind(&self) -> SyntaxKind {
  30         self.kind
  31     }
  32
  33     pub fn file_id(&self) -> FileId {
  34         self.file_id
  35     }
  36
  37     pub fn full_range(&self) -> TextRange {
  38         self.full_range
  39     }
  40
  41     /// A "most interesting" range withing the `range_full`.
  42     ///
  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> {
  46         self.focus_range
  47     }
  48
  49     pub(crate) fn from_symbol(symbol: FileSymbol) -> NavigationTarget {
  50         NavigationTarget {
  51             file_id: symbol.file_id,
  52             name: symbol.name.clone(),
  53             kind: symbol.ptr.kind(),
  54             full_range: symbol.ptr.range(),
  55             focus_range: None,
  56         }
  57     }
  58
  59     pub(crate) fn from_scope_entry(
  60         file_id: FileId,
  61         entry: &hir::ScopeEntryWithSyntax,
  62     ) -> NavigationTarget {
  63         NavigationTarget {
  64             file_id,
  65             name: entry.name().to_string().into(),
  66             full_range: entry.ptr().range(),
  67             focus_range: None,
  68             kind: NAME,
  69         }
  70     }
  71
  72     pub(crate) fn from_module(db: &RootDatabase, module: hir::Module) -> NavigationTarget {
  73         let (file_id, source) = module.definition_source(db);
  74         let name = module
  75             .name(db)
  76             .map(|it| it.to_string().into())
  77             .unwrap_or_default();
  78         match source {
  79             ModuleSource::SourceFile(node) => {
  80                 NavigationTarget::from_syntax(file_id, name, None, node.syntax())
  81             }
  82             ModuleSource::Module(node) => {
  83                 NavigationTarget::from_syntax(file_id, name, None, node.syntax())
  84             }
  85         }
  86     }
  87
  88     pub(crate) fn from_module_to_decl(db: &RootDatabase, module: hir::Module) -> NavigationTarget {
  89         let name = module
  90             .name(db)
  91             .map(|it| it.to_string().into())
  92             .unwrap_or_default();
  93         if let Some((file_id, source)) = module.declaration_source(db) {
  94             return NavigationTarget::from_syntax(file_id, name, None, source.syntax());
  95         }
  96         NavigationTarget::from_module(db, module)
  97     }
  98
  99     pub(crate) fn from_function(db: &RootDatabase, func: hir::Function) -> NavigationTarget {
 100         let (file_id, fn_def) = func.source(db);
 101         NavigationTarget::from_named(file_id.original_file(db), &*fn_def)
 102     }
 103
 104     // TODO once Def::Item is gone, this should be able to always return a NavigationTarget
 105     pub(crate) fn from_def(
 106         db: &RootDatabase,
 107         module_def: hir::ModuleDef,
 108     ) -> Option<NavigationTarget> {
 109         match module_def {
 110             hir::ModuleDef::Module(module) => Some(NavigationTarget::from_module(db, module)),
 111             hir::ModuleDef::Function(func) => Some(NavigationTarget::from_function(db, func)),
 112             hir::ModuleDef::Struct(s) => {
 113                 let (file_id, node) = s.source(db);
 114                 Some(NavigationTarget::from_named(
 115                     file_id.original_file(db),
 116                     &*node,
 117                 ))
 118             }
 119             hir::ModuleDef::Const(s) => {
 120                 let (file_id, node) = s.source(db);
 121                 Some(NavigationTarget::from_named(
 122                     file_id.original_file(db),
 123                     &*node,
 124                 ))
 125             }
 126             hir::ModuleDef::Static(s) => {
 127                 let (file_id, node) = s.source(db);
 128                 Some(NavigationTarget::from_named(
 129                     file_id.original_file(db),
 130                     &*node,
 131                 ))
 132             }
 133             hir::ModuleDef::Enum(e) => {
 134                 let (file_id, node) = e.source(db);
 135                 Some(NavigationTarget::from_named(
 136                     file_id.original_file(db),
 137                     &*node,
 138                 ))
 139             }
 140             hir::ModuleDef::EnumVariant(var) => {
 141                 let (file_id, node) = var.source(db);
 142                 Some(NavigationTarget::from_named(
 143                     file_id.original_file(db),
 144                     &*node,
 145                 ))
 146             }
 147             hir::ModuleDef::Trait(e) => {
 148                 let (file_id, node) = e.source(db);
 149                 Some(NavigationTarget::from_named(
 150                     file_id.original_file(db),
 151                     &*node,
 152                 ))
 153             }
 154             hir::ModuleDef::Type(e) => {
 155                 let (file_id, node) = e.source(db);
 156                 Some(NavigationTarget::from_named(
 157                     file_id.original_file(db),
 158                     &*node,
 159                 ))
 160             }
 161         }
 162     }
 163
 164     #[cfg(test)]
 165     pub(crate) fn assert_match(&self, expected: &str) {
 166         let actual = self.debug_render();
 167         test_utils::assert_eq_text!(expected.trim(), actual.trim(),);
 168     }
 169
 170     #[cfg(test)]
 171     pub(crate) fn debug_render(&self) -> String {
 172         let mut buf = format!(
 173             "{} {:?} {:?} {:?}",
 174             self.name(),
 175             self.kind(),
 176             self.file_id(),
 177             self.full_range()
 178         );
 179         if let Some(focus_range) = self.focus_range() {
 180             buf.push_str(&format!(" {:?}", focus_range))
 181         }
 182         buf
 183     }
 184
 185     fn from_named(file_id: FileId, node: &impl ast::NameOwner) -> NavigationTarget {
 186         let name = node.name().map(|it| it.text().clone()).unwrap_or_default();
 187         let focus_range = node.name().map(|it| it.syntax().range());
 188         NavigationTarget::from_syntax(file_id, name, focus_range, node.syntax())
 189     }
 190
 191     fn from_syntax(
 192         file_id: FileId,
 193         name: SmolStr,
 194         focus_range: Option<TextRange>,
 195         node: &SyntaxNode,
 196     ) -> NavigationTarget {
 197         NavigationTarget {
 198             file_id,
 199             name,
 200             kind: node.kind(),
 201             full_range: node.range(),
 202             focus_range,
 203             // ptr: Some(LocalSyntaxPtr::new(node)),
 204         }
 205     }
 206 }