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, lexer::token_type::MatlabTokenType};
6use core::range::Range;
7use oak_core::tree::RedNode;
8#[cfg(feature = "lsp")]
9use {oak_hover::Hover, 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            MatlabTokenType::FunctionDef => "### MATLAB Function\nDefines a reusable function block.",
19            MatlabTokenType::ClassDef => "### MATLAB Class\nDefines a class for object-oriented programming.",
20            MatlabTokenType::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    pub fn new(vfs: V) -> Self {
35        Self { vfs, workspace: oak_lsp::workspace::WorkspaceManager::default(), hover_provider: MatlabHoverProvider }
36    }
37}
38impl<V: Vfs + Send + Sync + 'static + oak_vfs::WritableVfs> LanguageService for MatlabLanguageService<V> {
39    type Lang = MatlabLanguage;
40    type Vfs = V;
41    fn vfs(&self) -> &Self::Vfs {
42        &self.vfs
43    }
44    fn workspace(&self) -> &oak_lsp::workspace::WorkspaceManager {
45        &self.workspace
46    }
47    fn get_root(&self, uri: &str) -> impl Future<Output = Option<RedNode<'_, MatlabLanguage>>> + Send + '_ {
48        let source = self.get_source(uri);
49        async move {
50            let source = source?;
51            let language = MatlabLanguage::default();
52            let lexer = crate::lexer::MatlabLexer::new(&language);
53            let parser = crate::parser::MatlabParser::new(&language);
54            let mut cache = Box::new(oak_core::parser::ParseSession::<MatlabLanguage>::default());
55            let cache_ptr: *mut oak_core::parser::ParseSession<MatlabLanguage> = &mut *cache;
56            let output = oak_core::parser::parse(&parser, &lexer, &source, &[], unsafe { &mut *cache_ptr }).result.ok()?;
57            let _leaked_cache = Box::leak(cache);
58            let green_static: &'static oak_core::GreenNode<MatlabLanguage> = Box::leak(Box::new(output));
59            Some(RedNode::new(green_static, 0))
60        }
61    }
62    fn hover(&self, uri: &str, range: Range<usize>) -> impl Future<Output = Option<oak_lsp::types::Hover>> + Send + '_ {
63        let uri = uri.to_string();
64        async move {
65            let hover = self.with_root(&uri, |root| self.hover_provider.hover(&root, range)).await.flatten()?;
66            Some(oak_lsp::types::Hover { contents: hover.contents, range: hover.range })
67        }
68    }
69}