php-lsp 0.5.0

A PHP Language Server Protocol implementation
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42

use tower_lsp::lsp_types::{Position, Url};

use crate::ast::ParsedDoc;

/// Strip the `$0` cursor marker from a PHP source string and return
/// the cleaned source together with the `Position` of that marker.
///
/// Useful in tests to avoid computing line/character offsets by hand:
///
/// ```rust
/// let (src, pos) = cursor("<?php\nfunction foo$0() {}");
/// // src == "<?php\nfunction foo() {}"
/// // pos == Position { line: 1, character: 12 }
/// ```
///
/// Panics if there is no `$0` in `src`.
pub fn cursor(src: &str) -> (String, Position) {
    const MARKER: &str = "$0";
    let marker_byte = src.find(MARKER).expect("no `$0` cursor marker in source");
    let before = &src[..marker_byte];
    let line = before.chars().filter(|&c| c == '\n').count() as u32;
    let last_nl_end = before.rfind('\n').map(|i| i + 1).unwrap_or(0);
    // LSP positions are UTF-16 code units
    let character = before[last_nl_end..].encode_utf16().count() as u32;
    let cleaned = format!("{}{}", before, &src[marker_byte + MARKER.len()..]);
    (cleaned, Position { line, character })
}

/// Create a `file://` URL from a path.
pub fn file_url(path: &str) -> Url {
    Url::parse(&format!("file://{path}")).unwrap()
}

/// Parse PHP source into a `ParsedDoc`.
pub fn parse_doc(src: &str) -> ParsedDoc {
    ParsedDoc::parse(src.to_string())
}

/// Create an LSP `Position` from line and character offsets.
pub fn position(line: u32, character: u32) -> Position {
    Position { line, character }
}