oak-org-mode 0.0.11

Org-mode parser with support for Emacs org-mode syntax and features.
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

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

use crate::{OrgModeElementType, OrgModeLanguage};
use core::range::Range;
use oak_core::tree::RedNode;
#[cfg(feature = "lsp")]
use oak_hover::{Hover as ProviderHover, HoverProvider};
#[cfg(feature = "lsp")]
use oak_lsp::{service::LanguageService, types::Hover as LspHover};
#[cfg(feature = "lsp")]
use oak_vfs::Vfs;
/// Hover provider implementation for Org-mode.
#[cfg(feature = "lsp")]
pub struct OrgModeHoverProvider;
#[cfg(feature = "lsp")]
impl HoverProvider<OrgModeLanguage> for OrgModeHoverProvider {
    fn hover(&self, node: &RedNode<OrgModeLanguage>, _range: Range<usize>) -> Option<ProviderHover> {
        let kind = node.green.kind;
        let contents = match kind {
            OrgModeElementType::Heading => "### Org Heading\nA hierarchical heading in the document.",
            OrgModeElementType::TodoKeyword => "### TODO Keyword\nAn actionable item.",
            OrgModeElementType::Block => "### Org Block\nA special block (e.g., code, quote).",
            _ => return None,
        };
        Some(ProviderHover { contents: contents.to_string(), range: Some(node.span()) })
    }
}
/// Language service implementation for Org-mode.
#[cfg(feature = "lsp")]
pub struct OrgModeLanguageService<V: Vfs> {
    vfs: V,
    workspace: oak_lsp::workspace::WorkspaceManager,
    hover_provider: OrgModeHoverProvider,
}
impl<V: Vfs> OrgModeLanguageService<V> {
    /// Creates a new `OrgModeLanguageService`.
    pub fn new(vfs: V) -> Self {
        Self { vfs, workspace: oak_lsp::workspace::WorkspaceManager::default(), hover_provider: OrgModeHoverProvider }
    }
}
impl<V: Vfs + Send + Sync + 'static + oak_vfs::WritableVfs> LanguageService for OrgModeLanguageService<V> {
    type Lang = OrgModeLanguage;
    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<'_, OrgModeLanguage>>> + Send + '_ {
        async move { None }
    }
    fn hover(&self, uri: &str, range: Range<usize>) -> impl std::future::Future<Output = Option<LspHover>> + Send + '_ {
        let uri = uri.to_string();
        async move { self.with_root(&uri, |root| self.hover_provider.hover(&root, range).map(|h| LspHover { contents: h.contents, range: h.range })).await.flatten() }
    }
}