Skip to main content

oak_prolog/lsp/
mod.rs

1#![doc = include_str!("readme.md")]
2#[cfg(feature = "oak-highlight")]
3pub mod highlighter;
4
5use crate::{language::PrologLanguage, parser::element_type::PrologElementType};
6use core::range::Range;
7use oak_core::tree::RedNode;
8#[cfg(feature = "lsp")]
9use {
10    oak_hover::{Hover, HoverProvider},
11    oak_lsp::service::LanguageService,
12    oak_vfs::Vfs,
13    std::future::Future,
14};
15/// Hover provider implementation for Prolog.
16#[cfg(feature = "lsp")]
17pub struct PrologHoverProvider;
18#[cfg(feature = "lsp")]
19impl HoverProvider<PrologLanguage> for PrologHoverProvider {
20    fn hover(&self, node: &RedNode<'_, PrologLanguage>, _range: Range<usize>) -> Option<Hover> {
21        let kind = node.green.kind;
22        let contents = match kind {
23            PrologElementType::Clause => "### Prolog Clause\nA statement that is either a fact or a rule.",
24            PrologElementType::Directive => "### Prolog Directive\nA command to the Prolog system.",
25            PrologElementType::Query => "### Prolog Query\nA goal to be proven by the Prolog system.",
26            _ => return None,
27        };
28        Some(Hover { contents: contents.to_string(), range: Some(node.span()) })
29    }
30}
31/// Language service implementation for Prolog.
32#[cfg(feature = "lsp")]
33pub struct PrologLanguageService<V: Vfs> {
34    vfs: V,
35    workspace: oak_lsp::workspace::WorkspaceManager,
36    hover_provider: PrologHoverProvider,
37}
38impl<V: Vfs> PrologLanguageService<V> {
39    pub fn new(vfs: V) -> Self {
40        Self { vfs, workspace: oak_lsp::workspace::WorkspaceManager::default(), hover_provider: PrologHoverProvider }
41    }
42}
43impl<V: Vfs + Send + Sync + 'static + oak_vfs::WritableVfs> LanguageService for PrologLanguageService<V> {
44    type Lang = PrologLanguage;
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 Future<Output = Option<RedNode<'_, PrologLanguage>>> + Send + '_ {
53        async move { None }
54    }
55    fn hover(&self, uri: &str, range: Range<usize>) -> impl Future<Output = Option<oak_lsp::Hover>> + Send + '_ {
56        let uri = uri.to_string();
57        async move {
58            let hover = self.with_root(&uri, |root| self.hover_provider.hover(&root, range)).await.flatten()?;
59            Some(oak_lsp::Hover { contents: hover.contents, range: hover.range })
60        }
61    }
62}