Skip to main content

oak_php/
lsp.rs

1use crate::{kind::PhpSyntaxKind, language::PhpLanguage};
2use core::range::Range;
3use futures::Future;
4use oak_core::tree::RedNode;
5use oak_hover::{Hover as HoverInfo, HoverProvider};
6use oak_lsp::{service::LanguageService, types::Hover};
7use oak_vfs::{Vfs, WritableVfs};
8
9/// Hover provider implementation for PHP.
10pub struct PhpHoverProvider;
11
12impl HoverProvider<PhpLanguage> for PhpHoverProvider {
13    fn hover(&self, node: &RedNode<'_, PhpLanguage>, _range: Range<usize>) -> Option<HoverInfo> {
14        let kind = node.green.kind;
15
16        let contents = match kind {
17            PhpSyntaxKind::ClassDef => "### PHP Class\nA template for objects, containing properties and methods.",
18            PhpSyntaxKind::FunctionDef => "### PHP Function\nA block of code that can be repeatedly called.",
19            PhpSyntaxKind::NamespaceDef => "### PHP Namespace\nA way of encapsulating items to avoid name collisions.",
20            _ => return None,
21        };
22
23        Some(HoverInfo { contents: contents.to_string(), range: Some(node.span()) })
24    }
25}
26
27pub struct PhpLanguageService<V: Vfs> {
28    vfs: V,
29    workspace: oak_lsp::workspace::WorkspaceManager,
30    hover_provider: PhpHoverProvider,
31}
32
33impl<V: Vfs> PhpLanguageService<V> {
34    pub fn new(vfs: V) -> Self {
35        Self { vfs, workspace: oak_lsp::workspace::WorkspaceManager::default(), hover_provider: PhpHoverProvider }
36    }
37}
38
39impl<V: WritableVfs + Send + Sync + 'static> LanguageService for PhpLanguageService<V> {
40    type Lang = PhpLanguage;
41    type Vfs = V;
42
43    fn vfs(&self) -> &Self::Vfs {
44        &self.vfs
45    }
46
47    fn workspace(&self) -> &oak_lsp::workspace::WorkspaceManager {
48        &self.workspace
49    }
50
51    fn get_root(&self, uri: &str) -> impl Future<Output = Option<RedNode<'_, PhpLanguage>>> + Send + '_ {
52        let source = self.get_source(uri);
53        async move {
54            let _source = source?;
55            // TODO: Implement proper caching and conversion to RedNode
56            None
57        }
58    }
59
60    fn hover(&self, uri: &str, range: Range<usize>) -> impl Future<Output = Option<Hover>> + Send + '_ {
61        let uri = uri.to_string();
62        async move {
63            let hover = self.with_root(&uri, |root| self.hover_provider.hover(&root, range)).await.flatten()?;
64            Some(Hover { contents: hover.contents, range: hover.range })
65        }
66    }
67}