oak_navigation/
lib.rs

1#![feature(new_range_api)]
2#![warn(missing_docs)]
3#![doc = include_str!("readme.md")]
4use core::range::Range;
5use oak_core::{Language, TokenType, language::UniversalTokenRole, tree::RedNode, visitor::Visitor};
6
7/// Represents a location in a source file.
8#[derive(Debug, Clone, PartialEq, Eq, Hash)]
9#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
10pub struct Location {
11    /// The URI of the resource.
12    #[cfg_attr(feature = "serde", serde(with = "oak_core::serde_arc_str"))]
13    pub uri: oak_core::Arc<str>,
14    /// The byte range within the resource.
15    #[cfg_attr(feature = "serde", serde(with = "oak_core::serde_range"))]
16    pub range: Range<usize>,
17}
18
19/// Trait for languages that support jumping to definition.
20pub trait DefinitionProvider<L: Language> {
21    /// Returns the definition(s) of the symbol at the given offset.
22    fn definition(&self, root: &RedNode<L>, offset: usize) -> Vec<Location>;
23}
24
25/// Trait for languages that support finding references.
26pub trait ReferencesProvider<L: Language> {
27    /// Returns the references to the symbol at the given offset.
28    fn references(&self, root: &RedNode<L>, offset: usize, include_declaration: bool) -> Vec<Location>;
29}
30
31/// A helper to find all references of a name in a tree.
32pub struct SimpleReferenceFinder<'a, L: Language> {
33    /// The name of the symbol to find references for.
34    name: &'a str,
35    /// The full source text.
36    source: &'a str,
37    /// The URI of the source file.
38    uri: oak_core::Arc<str>,
39    /// The list of locations where the name was found.
40    references: Vec<Location>,
41    /// Phantom data for the language type.
42    _phantom: std::marker::PhantomData<L>,
43}
44
45impl<'a, L: Language> SimpleReferenceFinder<'a, L> {
46    /// Finds all references of the given name in the tree.
47    ///
48    /// # Arguments
49    /// * `root` - The root node of the syntax tree.
50    /// * `name` - The name of the symbol to find.
51    /// * `source` - The source text.
52    /// * `uri` - The URI of the source file.
53    pub fn find(root: &RedNode<'a, L>, name: &'a str, source: &'a str, uri: impl Into<oak_core::Arc<str>>) -> Vec<Location> {
54        let mut finder = Self { name, source, uri: uri.into(), references: Vec::new(), _phantom: std::marker::PhantomData };
55        finder.visit_node(*root);
56        finder.references
57    }
58}
59
60impl<'a, L: Language> Visitor<'a, L> for SimpleReferenceFinder<'a, L> {
61    fn visit_node(&mut self, node: RedNode<'a, L>) {
62        self.walk_node(node);
63    }
64
65    fn visit_token(&mut self, token: oak_core::tree::RedLeaf<L>) {
66        if token.kind.is_universal(UniversalTokenRole::Name) {
67            let text = &self.source[token.span.clone()];
68            if text == self.name {
69                self.references.push(Location { uri: self.uri.clone(), range: token.span });
70            }
71        }
72    }
73}
oak_navigation/lib.rs

oak_navigation/
lib.rs
