oak_ini/lsp/
mod.rs

1#![doc = include_str!("readme.md")]
2#[cfg(feature = "oak-highlight")]
3pub mod highlighter;
4
5use crate::{language::IniLanguage, parser::element_type::IniElementType};
6use core::range::Range;
7use oak_core::tree::RedNode;
8#[cfg(feature = "lsp")]
9use {
10    futures::Future,
11    oak_hover::{Hover, HoverProvider},
12    oak_lsp::service::LanguageService,
13    oak_vfs::Vfs,
14};
15#[cfg(feature = "lsp")]
16/// INI hover provider.
17pub struct IniHoverProvider;
18
19#[cfg(feature = "lsp")]
20impl HoverProvider<IniLanguage> for IniHoverProvider {
21    fn hover(&self, node: &RedNode<IniLanguage>, _range: Range<usize>) -> Option<Hover> {
22        let kind = node.green.kind;
23        let contents = match kind {
24            IniElementType::Table => "### INI Section\nDefines a group of properties.",
25            IniElementType::KeyValue => "### INI Property\nA key-value pair.",
26            _ => return None,
27        };
28        Some(Hover { contents: contents.to_string(), range: Some(node.span()) })
29    }
30}
31/// INI language service.
32#[cfg(feature = "lsp")]
33pub struct IniLanguageService<V: Vfs> {
34    /// Virtual file system.
35    vfs: V,
36    /// Workspace manager.
37    workspace: oak_lsp::workspace::WorkspaceManager,
38    /// Hover provider.
39    hover_provider: IniHoverProvider,
40}
41impl<V: Vfs> IniLanguageService<V> {
42    /// Creates a new `IniLanguageService` with the given VFS.
43    pub fn new(vfs: V) -> Self {
44        Self { vfs, workspace: oak_lsp::workspace::WorkspaceManager::default(), hover_provider: IniHoverProvider }
45    }
46}
47impl<V: Vfs + Send + Sync + 'static + oak_vfs::WritableVfs> LanguageService for IniLanguageService<V> {
48    type Lang = IniLanguage;
49    type Vfs = V;
50    fn vfs(&self) -> &Self::Vfs {
51        &self.vfs
52    }
53    fn workspace(&self) -> &oak_lsp::workspace::WorkspaceManager {
54        &self.workspace
55    }
56    fn get_root(&self, uri: &str) -> impl Future<Output = Option<RedNode<'_, IniLanguage>>> + Send + '_ {
57        let source = self.vfs().get_source(uri);
58        async move {
59            let _source = source?;
60            None
61        }
62    }
63    fn hover(&self, uri: &str, range: Range<usize>) -> impl Future<Output = Option<oak_lsp::Hover>> + Send + '_ {
64        let uri = uri.to_string();
65        async move { self.with_root(&uri, |root| self.hover_provider.hover(&root, range).map(|h| oak_lsp::Hover { contents: h.contents, range: h.range })).await.flatten() }
66    }
67}
oak_ini/lsp/mod.rs

oak_ini/lsp/
mod.rs
