oak-perl 0.0.11

Perl scripting language parser with support for text processing, system administration, and modern Perl 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
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74

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

use crate::{PerlLanguage, parser::element_type::PerlElementType};
use core::range::Range;
use oak_core::tree::RedNode;
#[cfg(feature = "lsp")]
use {
    oak_hover::{Hover as ProviderHover, HoverProvider},
    oak_lsp::{service::LanguageService, types::Hover as LspHover},
    oak_vfs::Vfs,
};
/// Hover provider implementation for Perl.
#[cfg(feature = "lsp")]
pub struct PerlHoverProvider;
#[cfg(feature = "lsp")]
impl HoverProvider<PerlLanguage> for PerlHoverProvider {
    fn hover(&self, node: &RedNode<PerlLanguage>, _range: Range<usize>) -> Option<ProviderHover> {
        let kind = node.green.kind;
        let contents = match kind {
            PerlElementType::SubroutineDeclaration => "### Perl Subroutine\nA named block of code that can be called.",
            PerlElementType::PackageDeclaration => "### Perl Package\nDefines a namespace for the code.",
            PerlElementType::VariableDeclaration => "### Perl Variable\nA variable declared with `my`, `our`, or `local`.",
            PerlElementType::IfStatement => "### If Statement\nConditional execution block.",
            _ => return None,
        };
        Some(ProviderHover { contents: contents.to_string(), range: Some(node.span()) })
    }
}
/// Language service implementation for Perl.
///
/// This service provides LSP features like hover, completion, and diagnostics
/// for the Perl language, utilizing the VFS for file management.
#[cfg(feature = "lsp")]
pub struct PerlLanguageService<V: Vfs> {
    /// Virtual file system.
    vfs: V,
    /// Workspace manager.
    workspace: oak_lsp::workspace::WorkspaceManager,
    /// Hover provider.
    hover_provider: PerlHoverProvider,
}
impl<V: Vfs> PerlLanguageService<V> {
    /// Creates a new `PerlLanguageService` with the given VFS.
    pub fn new(vfs: V) -> Self {
        Self { vfs, workspace: oak_lsp::workspace::WorkspaceManager::default(), hover_provider: PerlHoverProvider }
    }
}
impl<V: Vfs + Send + Sync + 'static + oak_vfs::WritableVfs> LanguageService for PerlLanguageService<V> {
    type Lang = PerlLanguage;
    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 futures::Future<Output = Option<RedNode<'_, PerlLanguage>>> + Send + '_ {
        let _source = self.get_source(uri);
        async move {
            // TODO: Implement proper caching of parsed trees in LanguageService
            None
        }
    }
    fn hover(&self, uri: &str, range: Range<usize>) -> impl futures::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() }
    }
    fn completion(&self, _uri: &str, _offset: usize) -> impl futures::Future<Output = Vec<oak_lsp::types::CompletionItem>> + Send + '_ {
        async move { vec![] }
    }
}