oak_ocaml/lsp/
mod.rs

1#![doc = include_str!("readme.md")]
2#[cfg(feature = "oak-highlight")]
3pub mod highlighter;
4
5use crate::{OCamlLanguage, parser::element_type::OCamlElementType};
6use oak_core::{Range, tree::RedNode};
7#[cfg(feature = "lsp")]
8use {
9    futures::Future,
10    oak_hover::HoverProvider,
11    oak_lsp::{
12        service::LanguageService,
13        types::{Hover, Hover as LspHover},
14    },
15    oak_vfs::Vfs,
16};
17/// Hover provider implementation for OCaml.
18#[cfg(feature = "lsp")]
19pub struct OCamlHoverProvider;
20#[cfg(feature = "lsp")]
21impl HoverProvider<OCamlLanguage> for OCamlHoverProvider {
22    fn hover(&self, node: &RedNode<OCamlLanguage>, _range: Range<usize>) -> Option<oak_hover::Hover> {
23        let kind = node.green.kind;
24        let contents = match kind {
25            OCamlElementType::LetBinding => "### OCaml Let Binding\nDefines a value or function binding.",
26            OCamlElementType::ModuleDef => "### OCaml Module\nDefines an OCaml module.",
27            OCamlElementType::TypeDefinition => "### OCaml Type\nDefines a new type.",
28            OCamlElementType::MatchExpr => "### OCaml Match\nPattern matching expression.",
29            _ => return None,
30        };
31        Some(oak_hover::Hover { contents: contents.to_string(), range: Some(node.span()) })
32    }
33}
34/// Language service implementation for OCaml.
35#[cfg(feature = "lsp")]
36pub struct OCamlLanguageService<V: Vfs> {
37    vfs: V,
38    workspace: oak_lsp::workspace::WorkspaceManager,
39    hover_provider: OCamlHoverProvider,
40}
41impl<V: Vfs> OCamlLanguageService<V> {
42    /// Creates a new OCaml language service.
43    pub fn new(vfs: V) -> Self {
44        Self { vfs, workspace: oak_lsp::workspace::WorkspaceManager::default(), hover_provider: OCamlHoverProvider }
45    }
46}
47impl<V: Vfs + Send + Sync + 'static + oak_vfs::WritableVfs> LanguageService for OCamlLanguageService<V> {
48    type Lang = OCamlLanguage;
49    type Vfs = V;
50    fn vfs(&self) -> &Self::Vfs {
51        &self.vfs
52    }
53    fn workspace(&self) -> &oak_lsp::workspace::WorkspaceManager {
54        &self.workspace
55    }
56    fn get_root(&self, _uri: &str) -> impl std::future::Future<Output = Option<RedNode<'_, OCamlLanguage>>> + Send + '_ {
57        async move { None }
58    }
59    fn hover(&self, uri: &str, range: Range<usize>) -> impl std::future::Future<Output = Option<Hover>> + Send + '_ {
60        let uri = uri.to_string();
61        async move { self.with_root(&uri, |root| self.hover_provider.hover(&root, range).map(|h| Hover { contents: h.contents, range: h.range })).await.flatten() }
62    }
63}
oak_ocaml/lsp/mod.rs

oak_ocaml/lsp/
mod.rs
