sync-lsp 0.1.0

A synchronous LSP library for servers
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
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89

//! Implementation of the `workspace/symbol` request.
//! 
//! # Usage
//! In the language server protocol symbols are defined as any kind of symbol used in a
//! programming language. These symbols are commonly used resolve their specific
//! location in a source file. They can either be queried for a specific file or,
//! like in this case, for the whole workspace using [`Server::on_symbol`].

use crate::TypeProvider;
use crate::text_document::Location;
use crate::{Server, connection::Endpoint};
use crate::connection::Callback;
use serde::{Deserialize, Serialize};
use serde_repr::Serialize_repr;

#[derive(Default, Clone)]
pub(crate) struct SymbolOptions;

#[derive(Deserialize)]
#[serde(rename_all = "camelCase")]
struct WorkspaceSymbolParams  {
    query: String
}

/// Denotes any kind of symbol used in a programming language, for example variables, functions, classes, interfaces etc.
#[derive(Serialize, Debug)]
#[serde(rename_all = "camelCase")]
pub struct SymbolInformation {
    /// The name of this symbol as it should appear in a user interface.
    pub name: String,
    /// A variant of [`SymbolKind`]
    pub kind: SymbolKind,
    /// The location of this symbol in the source code. Optionally this location
    /// may contain more than just the symbol itself, like visibility modifiers.
    pub location: Location,
    /// A optional name of another symbol containing this one.
    /// For example the name of a class containing this symbol as a method.
    pub container_name: Option<String>
}

/// This enum contain various kinds of symbols, which are mainly used
/// in the user interface and attached to [`SymbolInformation`]
#[repr(i32)]
#[derive(Serialize_repr, Debug)]
pub enum SymbolKind {
    File = 1,
    Module = 2,
    Namespace = 3,
    Package = 4,
    Class = 5,
    Method = 6,
    Property = 7,
    Field = 8,
    Constructor = 9,
    Enum = 10,
    Interface = 11,
    Function = 12,
    Variable = 13,
    Constant = 14,
    String = 15,
    Number = 16,
    Boolean = 17,
    Array = 18,
}

impl SymbolOptions {

    pub(crate) const METHOD: &'static str = "workspace/symbol";

    pub(super) fn endpoint<T: TypeProvider>() -> Endpoint<T, SymbolOptions> {
        Endpoint::new(Callback::request(|_, _: WorkspaceSymbolParams| Vec::<SymbolInformation>::new()))
    }
}

impl<T: TypeProvider> Server<T> {

    /// Sets the callback that will be used to [resolve symbols](self) in a workspace.
    /// 
    /// # Argument
    /// * `callback` - A callback which is called with the following parameters as soon as the corresponding request is received:
    ///     * The server instance receiving the response.
    ///     * A possibly empty query string that is used to filter the symbols.
    
    pub fn on_symbol(&mut self, callback: fn(&mut Server<T>, String) -> Vec<SymbolInformation>) {
        self.workspace.symbol.set_callback(Callback::request(move |server, params: WorkspaceSymbolParams| {
            callback(server, params.query)
        }))
    }
}