Skip to main content

oak_j/lsp/
mod.rs

1#![doc = include_str!("readme.md")]
2#[cfg(feature = "oak-highlight")]
3pub mod highlighter;
4
5#[cfg(feature = "lsp")]
6use {
7    futures::Future,
8    oak_hover::{Hover, HoverProvider},
9    oak_lsp::service::LanguageService,
10    oak_vfs::Vfs,
11};
12#[cfg(feature = "oak-pretty-print")]
13pub mod formatter;
14use crate::{JLanguage, parser::JElementType};
15use core::range::Range;
16use oak_core::tree::RedNode;
17/// Hover provider implementation for J.
18#[cfg(feature = "lsp")]
19pub struct JHoverProvider;
20#[cfg(feature = "lsp")]
21impl HoverProvider<JLanguage> for JHoverProvider {
22    fn hover(&self, node: &RedNode<JLanguage>, _range: Range<usize>) -> Option<Hover> {
23        let kind = node.green.kind;
24        // Provide context-aware hover information
25        let contents = match kind {
26            JElementType::Sentence => "### J Sentence\nA basic unit of execution in J.",
27            JElementType::Assignment => "### J Assignment\nAssigns a value to a name locally (=.) or globally (=:).",
28            JElementType::Verb => "### J Verb\nA function that operates on nouns.",
29            _ => return None,
30        };
31        Some(Hover { contents: contents.to_string(), range: Some(node.span()) })
32    }
33}
34/// Language service implementation for J.
35#[cfg(feature = "lsp")]
36pub struct JLanguageService<V: Vfs> {
37    vfs: V,
38    workspace: oak_lsp::workspace::WorkspaceManager,
39    hover_provider: JHoverProvider,
40}
41#[cfg(feature = "lsp")]
42impl<V: Vfs> JLanguageService<V> {
43    /// Creates a new `JLanguageService`.
44    pub fn new(vfs: V) -> Self {
45        Self { vfs, workspace: oak_lsp::workspace::WorkspaceManager::default(), hover_provider: JHoverProvider }
46    }
47}
48#[cfg(feature = "lsp")]
49impl<V: Vfs + Send + Sync + 'static + oak_vfs::WritableVfs> LanguageService for JLanguageService<V> {
50    type Lang = JLanguage;
51    type Vfs = V;
52    fn vfs(&self) -> &Self::Vfs {
53        &self.vfs
54    }
55    fn workspace(&self) -> &oak_lsp::workspace::WorkspaceManager {
56        &self.workspace
57    }
58    fn get_root(&self, _uri: &str) -> impl Future<Output = Option<RedNode<'_, JLanguage>>> + Send + '_ {
59        async move {
60            // TODO: Implement proper caching of parsed trees in LanguageService
61            None
62        }
63    }
64    fn hover(&self, uri: &str, range: Range<usize>) -> impl Future<Output = Option<oak_lsp::Hover>> + Send + '_ {
65        let uri = uri.to_string();
66        async move { self.with_root(&uri, |root| self.hover_provider.hover(&root, range).map(|h| oak_lsp::Hover { contents: h.contents, range: h.range })).await.flatten() }
67    }
68}