Skip to main content

oak_notedown/lsp/
mod.rs

1#![doc = include_str!("readme.md")]
2#[cfg(feature = "oak-highlight")]
3pub mod highlighter;
4
5use crate::{language::NotedownLanguage, lexer::token_type::NoteTokenType, parser::element_type::NoteElementType};
6use core::range::Range;
7use oak_core::tree::RedNode;
8#[cfg(feature = "lsp")]
9use {futures::Future, oak_hover::HoverProvider, oak_lsp::service::LanguageService, oak_lsp::types::Hover as LspHover, oak_vfs::Vfs};
10/// Hover provider implementation for Notedown.
11#[cfg(feature = "lsp")]
12pub struct NoteHoverProvider;
13#[cfg(feature = "lsp")]
14impl HoverProvider<NotedownLanguage> for NoteHoverProvider {
15    fn hover(&self, node: &RedNode<NotedownLanguage>, _range: Range<usize>) -> Option<oak_hover::Hover> {
16        let kind = node.green.kind;
17        let contents = match kind {
18            NoteElementType::Token(t) if t == NoteTokenType::Heading1 => "### Heading 1\nTop-level heading.",
19            NoteElementType::Token(t) if t == NoteTokenType::Heading2 => "### Heading 2\nSecond-level heading.",
20            NoteElementType::Token(t) if t == NoteTokenType::CodeBlock => "### Code Block\nSyntax-highlighted code block.",
21            NoteElementType::Token(t) if t == NoteTokenType::Table => "### Table\nMarkdown table structure.",
22            _ => return None,
23        };
24        Some(oak_hover::Hover { contents: contents.to_string(), range: Some(node.span()) })
25    }
26}
27/// Language service implementation for Notedown.
28#[cfg(feature = "lsp")]
29pub struct NoteLanguageService<V: Vfs> {
30    vfs: V,
31    workspace: oak_lsp::workspace::WorkspaceManager,
32    hover_provider: NoteHoverProvider,
33}
34impl<V: Vfs> NoteLanguageService<V> {
35    /// Create a new language service instance
36    pub fn new(vfs: V) -> Self {
37        Self { vfs, workspace: oak_lsp::workspace::WorkspaceManager::default(), hover_provider: NoteHoverProvider }
38    }
39}
40impl<V: Vfs + Send + Sync + 'static + oak_vfs::WritableVfs> LanguageService for NoteLanguageService<V> {
41    type Lang = NotedownLanguage;
42    type Vfs = V;
43    fn vfs(&self) -> &Self::Vfs {
44        &self.vfs
45    }
46    fn workspace(&self) -> &oak_lsp::workspace::WorkspaceManager {
47        &self.workspace
48    }
49    fn get_root(&self, _uri: &str) -> impl futures::Future<Output = Option<RedNode<'_, NotedownLanguage>>> + Send + '_ {
50        async move { None }
51    }
52    fn hover(&self, uri: &str, range: Range<usize>) -> impl futures::Future<Output = Option<oak_lsp::types::Hover>> + Send + '_ {
53        let uri = uri.to_string();
54        async move { self.with_root(&uri, |root| self.hover_provider.hover(&root, range).map(|h| oak_lsp::types::Hover { contents: h.contents, range: h.range })).await.flatten() }
55    }
56}