1#![doc = include_str!("readme.md")]
2#[cfg(feature = "oak-highlight")]
3pub mod highlighter;
4
5#[cfg(feature = "lsp")]
6use {
7 futures::Future,
8 oak_hover::{Hover, HoverProvider},
9 oak_lsp::service::LanguageService,
10 oak_vfs::Vfs,
11};
12#[cfg(feature = "oak-pretty-print")]
13pub mod formatter;
14use crate::{RubyElementType, language::RubyLanguage};
15use core::range::Range;
16use oak_core::tree::RedNode;
17#[cfg(feature = "lsp")]
19pub struct RubyHoverProvider;
20#[cfg(feature = "lsp")]
21impl HoverProvider<RubyLanguage> for RubyHoverProvider {
22 fn hover(&self, node: &RedNode<RubyLanguage>, _range: Range<usize>) -> Option<Hover> {
23 let kind = node.green.kind;
24 let contents = match kind {
26 RubyElementType::MethodDefinition => "### Ruby Method\nDefines a callable block of code.",
27 RubyElementType::ClassDefinition => "### Ruby Class\nDefines a blueprint for objects.",
28 _ => return None,
29 };
30 Some(Hover { contents: contents.to_string(), range: Some(node.span()) })
31 }
32}
33#[cfg(feature = "lsp")]
35pub struct RubyLanguageService<V: Vfs> {
36 vfs: V,
37 workspace: oak_lsp::workspace::WorkspaceManager,
38 hover_provider: RubyHoverProvider,
39}
40impl<V: Vfs> RubyLanguageService<V> {
41 pub fn new(vfs: V) -> Self {
43 Self { vfs, workspace: oak_lsp::workspace::WorkspaceManager::default(), hover_provider: RubyHoverProvider }
44 }
45}
46impl<V: Vfs + Send + Sync + 'static + oak_vfs::WritableVfs> LanguageService for RubyLanguageService<V> {
47 type Lang = RubyLanguage;
48 type Vfs = V;
49 fn vfs(&self) -> &Self::Vfs {
50 &self.vfs
51 }
52 fn workspace(&self) -> &oak_lsp::workspace::WorkspaceManager {
53 &self.workspace
54 }
55 fn get_root(&self, _uri: &str) -> impl Future<Output = Option<RedNode<'_, RubyLanguage>>> + Send + '_ {
56 async move {
57 None
59 }
60 }
61 fn hover(&self, uri: &str, range: Range<usize>) -> impl Future<Output = Option<oak_lsp::Hover>> + Send + '_ {
62 let uri = uri.to_string();
63 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() }
64 }
65}