Skip to main content

oak_matlab/lsp/
mod.rs

1#![doc = include_str!("readme.md")]
2#[cfg(feature = "oak-highlight")]
3pub mod highlighter;
4
5use crate::{MatlabLanguage, parser::element_type::MatlabElementType};
6use core::range::Range;
7use oak_core::tree::RedNode;
8#[cfg(feature = "lsp")]
9use {oak_hover::HoverProvider, oak_lsp::service::LanguageService, oak_vfs::Vfs, std::future::Future};
10/// Hover provider implementation for MATLAB.
11#[cfg(feature = "lsp")]
12pub struct MatlabHoverProvider;
13#[cfg(feature = "lsp")]
14impl HoverProvider<MatlabLanguage> for MatlabHoverProvider {
15    fn hover(&self, node: &RedNode<MatlabLanguage>, _range: Range<usize>) -> Option<oak_hover::Hover> {
16        let kind = node.green.kind;
17        let contents = match kind {
18            MatlabElementType::FunctionDef => "### MATLAB Function\nDefines a reusable function block.",
19            MatlabElementType::ClassDef => "### MATLAB Class\nDefines a class for object-oriented programming.",
20            MatlabElementType::Script => "### MATLAB Script\nA file containing a sequence of MATLAB commands.",
21            _ => return None,
22        };
23        Some(oak_hover::Hover { contents: contents.to_string(), range: Some(node.span()) })
24    }
25}
26/// Language service implementation for MATLAB.
27#[cfg(feature = "lsp")]
28pub struct MatlabLanguageService<V: Vfs> {
29    vfs: V,
30    workspace: oak_lsp::workspace::WorkspaceManager,
31    hover_provider: MatlabHoverProvider,
32}
33impl<V: Vfs> MatlabLanguageService<V> {
34    /// Creates a new `MatlabLanguageService`.
35    pub fn new(vfs: V) -> Self {
36        Self { vfs, workspace: oak_lsp::workspace::WorkspaceManager::default(), hover_provider: MatlabHoverProvider }
37    }
38}
39impl<V: Vfs + Send + Sync + 'static + oak_vfs::WritableVfs> LanguageService for MatlabLanguageService<V> {
40    type Lang = MatlabLanguage;
41    type Vfs = V;
42    fn vfs(&self) -> &Self::Vfs {
43        &self.vfs
44    }
45    fn workspace(&self) -> &oak_lsp::workspace::WorkspaceManager {
46        &self.workspace
47    }
48    fn get_root(&self, _uri: &str) -> impl Future<Output = Option<RedNode<'_, MatlabLanguage>>> + Send + '_ {
49        async move {
50            // TODO: Implement proper caching and conversion to RedNode
51            None
52        }
53    }
54    fn hover(&self, uri: &str, range: Range<usize>) -> impl Future<Output = Option<oak_lsp::types::Hover>> + Send + '_ {
55        let uri = uri.to_string();
56        async move {
57            let hover = self.with_root(&uri, |root| self.hover_provider.hover(&root, range)).await.flatten()?;
58            Some(oak_lsp::types::Hover { contents: hover.contents, range: hover.range })
59        }
60    }
61}