oak_php/lsp/
mod.rs

1#![doc = include_str!("readme.md")]
2#[cfg(feature = "oak-highlight")]
3pub mod highlighter;
4
5use crate::{language::PhpLanguage, parser::element_type::PhpElementType};
6use core::range::Range;
7use oak_core::tree::RedNode;
8#[cfg(feature = "lsp")]
9use {
10    futures::Future,
11    oak_hover::{Hover as HoverInfo, HoverProvider},
12    oak_lsp::{service::LanguageService, types::Hover},
13    oak_vfs::{Vfs, WritableVfs},
14};
15/// Hover provider implementation for PHP.
16#[cfg(feature = "lsp")]
17pub struct PhpHoverProvider;
18#[cfg(feature = "lsp")]
19impl HoverProvider<PhpLanguage> for PhpHoverProvider {
20    fn hover(&self, node: &RedNode<'_, PhpLanguage>, _range: Range<usize>) -> Option<HoverInfo> {
21        let kind = node.green.kind;
22        let contents = match kind {
23            PhpElementType::ClassDef => "### PHP Class\nA template for objects, containing properties and methods.",
24            PhpElementType::FunctionDef => "### PHP Function\nA block of code that can be repeatedly called.",
25            PhpElementType::NamespaceDef => "### PHP Namespace\nA way of encapsulating items to avoid name collisions.",
26            _ => return None,
27        };
28        Some(HoverInfo { contents: contents.to_string(), range: Some(node.span()) })
29    }
30}
31/// PHP language service.
32///
33/// This struct provides LSP-related functionality for the PHP language.
34#[cfg(feature = "lsp")]
35pub struct PhpLanguageService<V: Vfs> {
36    vfs: V,
37    workspace: oak_lsp::workspace::WorkspaceManager,
38    hover_provider: PhpHoverProvider,
39}
40impl<V: Vfs> PhpLanguageService<V> {
41    /// Creates a new `PhpLanguageService` with the given virtual file system.
42    pub fn new(vfs: V) -> Self {
43        Self { vfs, workspace: oak_lsp::workspace::WorkspaceManager::default(), hover_provider: PhpHoverProvider }
44    }
45}
46impl<V: WritableVfs + Send + Sync + 'static> LanguageService for PhpLanguageService<V> {
47    type Lang = PhpLanguage;
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<'_, PhpLanguage>>> + Send + '_ {
56        let source = self.get_source(uri);
57        async move {
58            let _source = source?;
59            // TODO: Implement proper caching and conversion to RedNode
60            None
61        }
62    }
63    fn hover(&self, uri: &str, range: Range<usize>) -> impl Future<Output = Option<Hover>> + Send + '_ {
64        let uri = uri.to_string();
65        async move {
66            let hover = self.with_root(&uri, |root| self.hover_provider.hover(&root, range)).await.flatten()?;
67            Some(Hover { contents: hover.contents, range: hover.range })
68        }
69    }
70    fn completion(&self, _uri: &str, _offset: usize) -> impl Future<Output = Vec<oak_lsp::types::CompletionItem>> + Send + '_ {
71        async move { vec![] }
72    }
73}
oak_php/lsp/mod.rs

oak_php/lsp/
mod.rs
