forked from rust-lang/rust
-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Auto merge of rust-lang#12251 - matklad:lsp-server, r=matklad
internal: vendor lsp-server
- Loading branch information
Showing
18 changed files
with
946 additions
and
9 deletions.
There are no files selected for viewing
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| [package] | ||
| name = "lsp-server" | ||
| version = "0.6.0" | ||
| description = "Generic LSP server scaffold." | ||
| license = "MIT OR Apache-2.0" | ||
| repository = "https://github.com/rust-analyzer/rust-analyzer/tree/master/lib/lsp-server" | ||
| edition = "2021" | ||
|
|
||
| [dependencies] | ||
| log = "0.4.3" | ||
| serde_json = "1.0.34" | ||
| serde = { version = "1.0.83", features = ["derive"] } | ||
| crossbeam-channel = "0.5.4" | ||
|
|
||
| [dev-dependencies] | ||
| lsp-types = "0.93.0" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,121 @@ | ||
| //! A minimal example LSP server that can only respond to the `gotoDefinition` request. To use | ||
| //! this example, execute it and then send an `initialize` request. | ||
| //! | ||
| //! ```no_run | ||
| //! Content-Length: 85 | ||
| //! | ||
| //! {"jsonrpc": "2.0", "method": "initialize", "id": 1, "params": {"capabilities": {}}} | ||
| //! ``` | ||
| //! | ||
| //! This will respond with a server response. Then send it a `initialized` notification which will | ||
| //! have no response. | ||
| //! | ||
| //! ```no_run | ||
| //! Content-Length: 59 | ||
| //! | ||
| //! {"jsonrpc": "2.0", "method": "initialized", "params": {}} | ||
| //! ``` | ||
| //! | ||
| //! Once these two are sent, then we enter the main loop of the server. The only request this | ||
| //! example can handle is `gotoDefinition`: | ||
| //! | ||
| //! ```no_run | ||
| //! Content-Length: 159 | ||
| //! | ||
| //! {"jsonrpc": "2.0", "method": "textDocument/definition", "id": 2, "params": {"textDocument": {"uri": "file://temp"}, "position": {"line": 1, "character": 1}}} | ||
| //! ``` | ||
| //! | ||
| //! To finish up without errors, send a shutdown request: | ||
| //! | ||
| //! ```no_run | ||
| //! Content-Length: 67 | ||
| //! | ||
| //! {"jsonrpc": "2.0", "method": "shutdown", "id": 3, "params": null} | ||
| //! ``` | ||
| //! | ||
| //! The server will exit the main loop and finally we send a `shutdown` notification to stop | ||
| //! the server. | ||
| //! | ||
| //! ``` | ||
| //! Content-Length: 54 | ||
| //! | ||
| //! {"jsonrpc": "2.0", "method": "exit", "params": null} | ||
| //! ``` | ||
| use std::error::Error; | ||
|
|
||
| use lsp_types::OneOf; | ||
| use lsp_types::{ | ||
| request::GotoDefinition, GotoDefinitionResponse, InitializeParams, ServerCapabilities, | ||
| }; | ||
|
|
||
| use lsp_server::{Connection, ExtractError, Message, Request, RequestId, Response}; | ||
|
|
||
| fn main() -> Result<(), Box<dyn Error + Sync + Send>> { | ||
| // Note that we must have our logging only write out to stderr. | ||
| eprintln!("starting generic LSP server"); | ||
|
|
||
| // Create the transport. Includes the stdio (stdin and stdout) versions but this could | ||
| // also be implemented to use sockets or HTTP. | ||
| let (connection, io_threads) = Connection::stdio(); | ||
|
|
||
| // Run the server and wait for the two threads to end (typically by trigger LSP Exit event). | ||
| let server_capabilities = serde_json::to_value(&ServerCapabilities { | ||
| definition_provider: Some(OneOf::Left(true)), | ||
| ..Default::default() | ||
| }) | ||
| .unwrap(); | ||
| let initialization_params = connection.initialize(server_capabilities)?; | ||
| main_loop(connection, initialization_params)?; | ||
| io_threads.join()?; | ||
|
|
||
| // Shut down gracefully. | ||
| eprintln!("shutting down server"); | ||
| Ok(()) | ||
| } | ||
|
|
||
| fn main_loop( | ||
| connection: Connection, | ||
| params: serde_json::Value, | ||
| ) -> Result<(), Box<dyn Error + Sync + Send>> { | ||
| let _params: InitializeParams = serde_json::from_value(params).unwrap(); | ||
| eprintln!("starting example main loop"); | ||
| for msg in &connection.receiver { | ||
| eprintln!("got msg: {:?}", msg); | ||
| match msg { | ||
| Message::Request(req) => { | ||
| if connection.handle_shutdown(&req)? { | ||
| return Ok(()); | ||
| } | ||
| eprintln!("got request: {:?}", req); | ||
| match cast::<GotoDefinition>(req) { | ||
| Ok((id, params)) => { | ||
| eprintln!("got gotoDefinition request #{}: {:?}", id, params); | ||
| let result = Some(GotoDefinitionResponse::Array(Vec::new())); | ||
| let result = serde_json::to_value(&result).unwrap(); | ||
| let resp = Response { id, result: Some(result), error: None }; | ||
| connection.sender.send(Message::Response(resp))?; | ||
| continue; | ||
| } | ||
| Err(err @ ExtractError::JsonError { .. }) => panic!("{:?}", err), | ||
| Err(ExtractError::MethodMismatch(req)) => req, | ||
| }; | ||
| // ... | ||
| } | ||
| Message::Response(resp) => { | ||
| eprintln!("got response: {:?}", resp); | ||
| } | ||
| Message::Notification(not) => { | ||
| eprintln!("got notification: {:?}", not); | ||
| } | ||
| } | ||
| } | ||
| Ok(()) | ||
| } | ||
|
|
||
| fn cast<R>(req: Request) -> Result<(RequestId, R::Params), ExtractError<Request>> | ||
| where | ||
| R: lsp_types::request::Request, | ||
| R::Params: serde::de::DeserializeOwned, | ||
| { | ||
| req.extract(R::METHOD) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,50 @@ | ||
| use std::fmt; | ||
|
|
||
| use crate::{Notification, Request}; | ||
|
|
||
| #[derive(Debug, Clone)] | ||
| pub struct ProtocolError(pub(crate) String); | ||
|
|
||
| impl std::error::Error for ProtocolError {} | ||
|
|
||
| impl fmt::Display for ProtocolError { | ||
| fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { | ||
| fmt::Display::fmt(&self.0, f) | ||
| } | ||
| } | ||
|
|
||
| #[derive(Debug)] | ||
| pub enum ExtractError<T> { | ||
| /// The extracted message was of a different method than expected. | ||
| MethodMismatch(T), | ||
| /// Failed to deserialize the message. | ||
| JsonError { method: String, error: serde_json::Error }, | ||
| } | ||
|
|
||
| impl std::error::Error for ExtractError<Request> {} | ||
| impl fmt::Display for ExtractError<Request> { | ||
| fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { | ||
| match self { | ||
| ExtractError::MethodMismatch(req) => { | ||
| write!(f, "Method mismatch for request '{}'", req.method) | ||
| } | ||
| ExtractError::JsonError { method, error } => { | ||
| write!(f, "Invalid request\nMethod: {method}\n error: {error}",) | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| impl std::error::Error for ExtractError<Notification> {} | ||
| impl fmt::Display for ExtractError<Notification> { | ||
| fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { | ||
| match self { | ||
| ExtractError::MethodMismatch(req) => { | ||
| write!(f, "Method mismatch for notification '{}'", req.method) | ||
| } | ||
| ExtractError::JsonError { method, error } => { | ||
| write!(f, "Invalid notification\nMethod: {method}\n error: {error}") | ||
| } | ||
| } | ||
| } | ||
| } |
Oops, something went wrong.