Skip to main content

oak_valkyrie/lsp/
mod.rs

1use crate::{kind::ValkyrieSyntaxKind, language::ValkyrieLanguage};
2use core::range::Range;
3use oak_core::{Lexer, Parser, tree::RedNode};
4use oak_hover::{Hover as ProviderHover, HoverProvider};
5use oak_lsp::{service::LanguageService, types::Hover as LspHover};
6use oak_vfs::Vfs;
7
8/// Hover provider for Valkyrie.
9pub struct ValkyrieHoverProvider;
10
11impl HoverProvider<ValkyrieLanguage> for ValkyrieHoverProvider {
12    fn hover(&self, node: &RedNode<ValkyrieLanguage>, _range: Range<usize>) -> Option<ProviderHover> {
13        let kind = node.green.kind;
14
15        let contents = match kind {
16            ValkyrieSyntaxKind::Namespace => "### Valkyrie Namespace\nDefines a scope for items.",
17            ValkyrieSyntaxKind::Micro => "### Valkyrie Function\nDefines a callable function.",
18            ValkyrieSyntaxKind::LetStatement => "### Let Statement\nDeclares a local variable.",
19            ValkyrieSyntaxKind::Identifier => "### Identifier\nA name referring to a value or item.",
20            _ => return None,
21        };
22
23        Some(ProviderHover { contents: contents.to_string(), range: Some(node.span()) })
24    }
25}
26
27/// Language service implementation for Valkyrie.
28pub struct ValkyrieLanguageService<V: Vfs> {
29    vfs: V,
30    workspace: oak_lsp::workspace::WorkspaceManager,
31    hover_provider: ValkyrieHoverProvider,
32    language: ValkyrieLanguage,
33}
34
35impl<V: Vfs> ValkyrieLanguageService<V> {
36    /// Creates a new Valkyrie language service.
37    pub fn new(vfs: V) -> Self {
38        Self { vfs, workspace: oak_lsp::workspace::WorkspaceManager::default(), hover_provider: ValkyrieHoverProvider, language: ValkyrieLanguage::default() }
39    }
40}
41
42impl<V: Vfs + Send + Sync + 'static + oak_vfs::WritableVfs> LanguageService for ValkyrieLanguageService<V> {
43    type Lang = ValkyrieLanguage;
44    type Vfs = V;
45
46    fn vfs(&self) -> &V {
47        &self.vfs
48    }
49
50    fn workspace(&self) -> &oak_lsp::workspace::WorkspaceManager {
51        &self.workspace
52    }
53
54    fn get_root(&self, uri: &str) -> impl futures::Future<Output = Option<RedNode<'_, ValkyrieLanguage>>> + Send + '_ {
55        let source = self.get_source(uri);
56        let uri = uri.to_string();
57        async move {
58            let source = source?;
59            let language = self.language;
60            let parser = crate::parser::ValkyrieParser::new(&language);
61            let lexer = crate::lexer::ValkyrieLexer::new(&language);
62
63            // 使用 Box::leak 或类似的方案来延长 cache 的生命周期是不安全的,
64            // 更好的做法是将 cache 和 green 节点一起管理,或者重新设计 RedNode。
65            // 在当前的 oak-core 设计中,RedNode 必须引用 GreenNode,而 GreenNode
66            // 通常由 ParseHeap 分配在 Arena 中。
67
68            let mut cache = Box::new(oak_core::parser::session::ParseSession::<ValkyrieLanguage>::default());
69            let cache_ptr: *mut oak_core::parser::session::ParseSession<ValkyrieLanguage> = &mut *cache;
70
71            lexer.lex(&source, &[], unsafe { &mut *cache_ptr });
72            let output = parser.parse(&source, &[], unsafe { &mut *cache_ptr });
73            let green = output.result.ok()?;
74
75            // 这里的 green 实际上是从 cache.arena 分配的。
76            // 在 LSP 中,正确的做法是将解析结果存入 WorkspaceManager。
77
78            let _leaked_cache = Box::leak(cache);
79            // 安全地获取 'static 生命周期的 green 节点,因为它现在属于 leaked_cache
80            let green_static: &'static oak_core::GreenNode<ValkyrieLanguage> = unsafe { std::mem::transmute(green) };
81
82            let root = RedNode::new(green_static, 0);
83
84            // Index symbols
85            use oak_symbols::{SymbolProvider, UniversalSymbolProvider};
86            let provider = UniversalSymbolProvider::new();
87            let symbols = provider.document_symbols(&uri, &root, &source);
88            self.workspace().symbols.update_file_symbols(uri, symbols);
89
90            Some(root)
91        }
92    }
93
94    fn hover(&self, uri: &str, range: Range<usize>) -> impl futures::Future<Output = Option<LspHover>> + Send + '_ {
95        let uri = uri.to_string();
96        async move {
97            self.with_root(&uri, |root| {
98                use oak_core::tree::RedTree;
99                let node = match root.child_at_offset(range.start) {
100                    Some(RedTree::Node(n)) => n,
101                    _ => root,
102                };
103                self.hover_provider.hover(&node, range).map(|h| LspHover { contents: h.contents, range: h.range })
104            })
105            .await
106            .flatten()
107        }
108    }
109}