1#![doc = include_str!("readme.md")]
2#[cfg(feature = "oak-highlight")]
3pub mod highlighter;
4
5use crate::{HlslLanguage, parser::element_type::HlslElementType};
6use core::range::Range;
7use oak_core::tree::RedNode;
8#[cfg(feature = "lsp")]
9use {
10 futures::Future,
11 oak_hover::{Hover, HoverProvider},
12 oak_lsp::service::LanguageService,
13 oak_vfs::Vfs,
14};
15#[cfg(feature = "lsp")]
16#[cfg(feature = "lsp")]
18pub struct HlslHoverProvider;
19#[cfg(feature = "lsp")]
20impl HoverProvider<HlslLanguage> for HlslHoverProvider {
21 fn hover(&self, node: &RedNode<HlslLanguage>, _range: Range<usize>) -> Option<Hover> {
22 let kind = node.green.kind;
23 let contents = match kind {
25 HlslElementType::Struct => "### HLSL Struct\nDefines a custom data structure.",
26 HlslElementType::Cbuffer => "### HLSL Constant Buffer\nDefines a buffer for shader constants.",
27 HlslElementType::Technique => "### HLSL Technique\nDefines a rendering technique.",
28 HlslElementType::Pass => "### HLSL Pass\nDefines a rendering pass within a technique.",
29 _ => return None,
30 };
31 Some(Hover { contents: contents.to_string(), range: Some(node.span()) })
32 }
33}
34#[cfg(feature = "lsp")]
36pub struct HlslLanguageService<V: Vfs> {
37 vfs: V,
38 workspace: oak_lsp::workspace::WorkspaceManager,
39 hover_provider: HlslHoverProvider,
40}
41impl<V: Vfs> HlslLanguageService<V> {
42 pub fn new(vfs: V) -> Self {
43 Self { vfs, workspace: oak_lsp::workspace::WorkspaceManager::default(), hover_provider: HlslHoverProvider }
44 }
45}
46impl<V: Vfs + Send + Sync + 'static + oak_vfs::WritableVfs> LanguageService for HlslLanguageService<V> {
47 type Lang = HlslLanguage;
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<'_, HlslLanguage>>> + Send + '_ {
56 let _uri = uri.to_string();
57 async move {
58 None
60 }
61 }
62 fn hover(&self, uri: &str, range: Range<usize>) -> impl Future<Output = Option<oak_lsp::Hover>> + Send + '_ {
63 let uri = uri.to_string();
64 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() }
65 }
66}