oak-coq 0.0.11

Coq theorem prover language parser with support for dependent types and formal verification.
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
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76

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

use crate::{CoqLanguage, parser::element_type::CoqElementType};
use core::range::Range;
use oak_core::tree::RedNode;
#[cfg(feature = "lsp")]
use {
    futures::Future,
    oak_hover::{Hover, HoverProvider},
    oak_lsp::service::LanguageService,
    oak_vfs::Vfs,
};
/// Hover provider implementation for Coq.
#[cfg(feature = "lsp")]
pub struct CoqHoverProvider;
#[cfg(feature = "lsp")]
impl HoverProvider<CoqLanguage> for CoqHoverProvider {
    fn hover(&self, node: &RedNode<CoqLanguage>, _range: Range<usize>) -> Option<Hover> {
        let kind = node.green.kind;
        // Provide context-aware hover information
        let contents = match kind {
            CoqElementType::Declaration => "### Coq Declaration\nDefines a new term, theorem, or inductive type.",
            CoqElementType::Statement => "### Coq Statement\nA vernacular command or tactic.",
            CoqElementType::Expression => "### Coq Expression\nA Coq term or type.",
            _ => return None,
        };
        Some(Hover { contents: contents.to_string(), range: Some(node.span()) })
    }
}
/// Language service implementation for Coq.
#[cfg(feature = "lsp")]
pub struct CoqLanguageService<V: Vfs> {
    vfs: V,
    workspace: oak_lsp::workspace::WorkspaceManager,
    hover_provider: CoqHoverProvider,
}
impl<V: Vfs> CoqLanguageService<V> {
    /// Creates a new `CoqLanguageService`.
    pub fn new(vfs: V) -> Self {
        Self { vfs, workspace: oak_lsp::workspace::WorkspaceManager::default(), hover_provider: CoqHoverProvider }
    }
}
impl<V: Vfs + Send + Sync + 'static + oak_vfs::WritableVfs> LanguageService for CoqLanguageService<V> {
    type Lang = CoqLanguage;
    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 Future<Output = Option<RedNode<'_, CoqLanguage>>> + Send + '_ {
        let source = self.vfs().get_source(uri);
        async move {
            let source = source?;
            let language = CoqLanguage::default();
            let parser = crate::parser::CoqParser::new(&language);
            let lexer = crate::lexer::CoqLexer::new(&language);
            let mut cache = Box::new(oak_core::parser::session::ParseSession::<CoqLanguage>::default());
            let cache_ptr: *mut oak_core::parser::session::ParseSession<CoqLanguage> = &mut *cache;
            let parse_out = oak_core::parser::parse(&parser, &lexer, &source, &[], unsafe { &mut *cache_ptr });
            let green = parse_out.result.ok()?;
            let _leaked_cache = Box::leak(cache);
            let green_static: &'static oak_core::GreenNode<CoqLanguage> = unsafe { std::mem::transmute(green) };
            Some(RedNode::new(green_static, 0))
        }
    }
    fn hover(&self, uri: &str, range: Range<usize>) -> impl Future<Output = Option<oak_lsp::Hover>> + Send + '_ {
        let uri = uri.to_string();
        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() }
    }
}
#[cfg(feature = "oak-pretty-print")]
pub mod formatter;