oak_org_mode/lsp/
mod.rs

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

oak_org_mode/lsp/
mod.rs
