Skip to main content

oak_org_mode/
lsp.rs

1use crate::{OrgModeLanguage, kind::OrgModeSyntaxKind};
2use core::range::Range;
3use oak_core::tree::RedNode;
4use oak_hover::{Hover as ProviderHover, HoverProvider};
5use oak_lsp::{service::LanguageService, types::Hover as LspHover};
6use oak_vfs::Vfs;
7
8/// Hover provider implementation for Org-mode.
9pub struct OrgModeHoverProvider;
10
11impl HoverProvider<OrgModeLanguage> for OrgModeHoverProvider {
12    fn hover(&self, node: &RedNode<OrgModeLanguage>, _range: Range<usize>) -> Option<ProviderHover> {
13        let kind = node.green.kind;
14
15        let contents = match kind {
16            OrgModeSyntaxKind::Heading => "### Org Heading\nA hierarchical heading in the document.",
17            OrgModeSyntaxKind::Todo => "### TODO Keyword\nAn actionable item.",
18            OrgModeSyntaxKind::Block => "### Org Block\nA special block (e.g., code, quote).",
19            _ => return None,
20        };
21
22        Some(ProviderHover { contents: contents.to_string(), range: Some(node.span()) })
23    }
24}
25
26/// Language service implementation for Org-mode.
27pub struct OrgModeLanguageService<V: Vfs> {
28    vfs: V,
29    workspace: oak_lsp::workspace::WorkspaceManager,
30    hover_provider: OrgModeHoverProvider,
31}
32
33impl<V: Vfs> OrgModeLanguageService<V> {
34    pub fn new(vfs: V) -> Self {
35        Self { vfs, workspace: oak_lsp::workspace::WorkspaceManager::default(), hover_provider: OrgModeHoverProvider }
36    }
37}
38
39impl<V: Vfs + Send + Sync + 'static + oak_vfs::WritableVfs> LanguageService for OrgModeLanguageService<V> {
40    type Lang = OrgModeLanguage;
41    type Vfs = V;
42
43    fn vfs(&self) -> &Self::Vfs {
44        &self.vfs
45    }
46
47    fn workspace(&self) -> &oak_lsp::workspace::WorkspaceManager {
48        &self.workspace
49    }
50
51    fn get_root(&self, _uri: &str) -> impl std::future::Future<Output = Option<RedNode<'_, OrgModeLanguage>>> + Send + '_ {
52        async move { None }
53    }
54
55    fn hover(&self, uri: &str, range: Range<usize>) -> impl std::future::Future<Output = Option<LspHover>> + Send + '_ {
56        let uri = uri.to_string();
57        async move { self.with_root(&uri, |root| self.hover_provider.hover(&root, range).map(|h| LspHover { contents: h.contents, range: h.range })).await.flatten() }
58    }
59}