oak-ocaml 0.0.11

OCaml functional programming language parser with support for modern OCaml features and type system.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63

#![doc = include_str!("readme.md")]
#[cfg(feature = "oak-highlight")]
pub mod highlighter;

use crate::{OCamlLanguage, parser::element_type::OCamlElementType};
use oak_core::{Range, tree::RedNode};
#[cfg(feature = "lsp")]
use {
    futures::Future,
    oak_hover::HoverProvider,
    oak_lsp::{
        service::LanguageService,
        types::{Hover, Hover as LspHover},
    },
    oak_vfs::Vfs,
};
/// Hover provider implementation for OCaml.
#[cfg(feature = "lsp")]
pub struct OCamlHoverProvider;
#[cfg(feature = "lsp")]
impl HoverProvider<OCamlLanguage> for OCamlHoverProvider {
    fn hover(&self, node: &RedNode<OCamlLanguage>, _range: Range<usize>) -> Option<oak_hover::Hover> {
        let kind = node.green.kind;
        let contents = match kind {
            OCamlElementType::LetBinding => "### OCaml Let Binding\nDefines a value or function binding.",
            OCamlElementType::ModuleDef => "### OCaml Module\nDefines an OCaml module.",
            OCamlElementType::TypeDefinition => "### OCaml Type\nDefines a new type.",
            OCamlElementType::MatchExpr => "### OCaml Match\nPattern matching expression.",
            _ => return None,
        };
        Some(oak_hover::Hover { contents: contents.to_string(), range: Some(node.span()) })
    }
}
/// Language service implementation for OCaml.
#[cfg(feature = "lsp")]
pub struct OCamlLanguageService<V: Vfs> {
    vfs: V,
    workspace: oak_lsp::workspace::WorkspaceManager,
    hover_provider: OCamlHoverProvider,
}
impl<V: Vfs> OCamlLanguageService<V> {
    /// Creates a new OCaml language service.
    pub fn new(vfs: V) -> Self {
        Self { vfs, workspace: oak_lsp::workspace::WorkspaceManager::default(), hover_provider: OCamlHoverProvider }
    }
}
impl<V: Vfs + Send + Sync + 'static + oak_vfs::WritableVfs> LanguageService for OCamlLanguageService<V> {
    type Lang = OCamlLanguage;
    type Vfs = V;
    fn vfs(&self) -> &Self::Vfs {
        &self.vfs
    }
    fn workspace(&self) -> &oak_lsp::workspace::WorkspaceManager {
        &self.workspace
    }
    fn get_root(&self, _uri: &str) -> impl std::future::Future<Output = Option<RedNode<'_, OCamlLanguage>>> + Send + '_ {
        async move { None }
    }
    fn hover(&self, uri: &str, range: Range<usize>) -> impl std::future::Future<Output = Option<Hover>> + Send + '_ {
        let uri = uri.to_string();
        async move { self.with_root(&uri, |root| self.hover_provider.hover(&root, range).map(|h| Hover { contents: h.contents, range: h.range })).await.flatten() }
    }
}